From 9895b548037cb63de561594d517520c738b31943 Mon Sep 17 00:00:00 2001
From: Ian Moffett <ian@osmora.org>
Date: Thu, 25 Sep 2025 22:47:48 -0400
Subject: link: Introduce squeaking (peer discovery)

A machine may decide to squeak at another machine, those who are
listening shall squeak back to announce their presence on the wire.

Signed-off-by: Ian Moffett <ian@osmora.org>
---
 src/include/dgram.h | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

(limited to 'src/include/dgram.h')

diff --git a/src/include/dgram.h b/src/include/dgram.h
index 31f7c03..779c7ef 100644
--- a/src/include/dgram.h
+++ b/src/include/dgram.h
@@ -42,6 +42,7 @@ typedef tx_len_t rx_len_t;
  *
  * @length: Packet length in bytes
  * @reserved: Reserved for future use
+ * @type: Describes the type of packet (see OTYPE_*)
  * @reserved1: Reserved for future use
  * @port: Datagram port number to send on
  * @crc32: CRC32 checksum of data + header
@@ -49,11 +50,30 @@ typedef tx_len_t rx_len_t;
 struct onet_dgram {
     uint16_t length;
     uint16_t reserved;
-    uint16_t reserved1;
+    uint8_t type : 3;
+    uint16_t reserved1 : 13;
     uint8_t port;
     uint32_t crc32;
 } __attribute__((packed));
 
+/*
+ * ONET packet types
+ *
+ * @OTYPE_DATA: Regular data to be sent
+ * @OTYPE_SQUEAK: For peer discovery
+ *
+ * [ALL OTHER VALUES ARE RESERVED]
+ *
+ *  -- Squeaks --
+ *
+ *  A machine may squeak at the wire and those whom the squeak is
+ *  intended for shall squeak back. One thing to be aware of is that
+ *  this may allow squeak storms / attacks where a machine continuously
+ *  squeaks at a wire.
+ */
+#define OTYPE_DATA      0x0
+#define OTYPE_SQUEAK    0x1
+
 /*
  * Get the total length of a datagram including
  * the length of the ethernet header and the header
@@ -81,12 +101,16 @@ struct onet_dgram {
  *
  * @length: Length of a packet to send
  * @port: Port number to send on
+ * @type: Packet type (OTYPE_*)
  * @res: Result is written here
  *
  * Returns zero on success, otherwise a less than zero
  * value on failure.
  */
-int dgram_load(uint16_t length, uint8_t port, struct onet_dgram *res);
+int dgram_load(
+    uint16_t length, uint8_t port,
+    uint8_t type, struct onet_dgram *res
+);
 
 /*
  * Send a datagram through ONET
@@ -104,6 +128,17 @@ tx_len_t dgram_send(
     void *buf, uint16_t len
 );
 
+/*
+ * Send a squeak through a wire
+ *
+ * @link: Link to squeak through
+ * @dst: Destination address to squeak at
+ *
+ * Returns the length of the squeak on success, otherwise
+ * a less than zero value on failure.
+ */
+tx_len_t dgram_squeak(struct onet_link *link, mac_addr_t dst);
+
 /*
  * Get data from an ONET link
  *
-- 
cgit v1.2.3