- leaks

[oweals/gnunet.git] / src / mesh / mesh.h

diff --git a/src/mesh/mesh.h b/src/mesh/mesh.h
index fd9de27d8aef1b7e111d256d0eedee2c739466ff..ca4a1822fcae7f1daf72ba75e84a2f8c5bffa150 100644 (file)
--- a/src/mesh/mesh.h
+++ b/src/mesh/mesh.h
@@ -29,6 +29,8 @@
 
 #define MESH_DEBUG              GNUNET_YES
 
+#define INITIAL_WINDOW_SIZE     8
+#define ACK_THRESHOLD           INITIAL_WINDOW_SIZE / 2
 
 #include "platform.h"
 #include "gnunet_common.h"
@@ -75,11 +77,13 @@
 /**************************       CONSTANTS      ******************************/
 /******************************************************************************/
 
-#define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI 0x80000000
-#define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV 0xB0000000
+#define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI         0x80000000
+#define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV        0xB0000000
 
-#define CORE_QUEUE_SIZE         1
-#define LOCAL_QUEUE_SIZE        100
+#define HIGH_PID                                0xFFFF0000
+#define LOW_PID                                 0x0000FFFF
+
+#define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
 
 /******************************************************************************/
 /**************************        MESSAGES      ******************************/
@@ -122,6 +126,7 @@ struct GNUNET_MESH_TunnelMessage
 {
     /**
      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
+     *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[MAX|MIN]
      *
      * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
      */
@@ -168,24 +173,24 @@ struct GNUNET_MESH_TunnelNotification
 struct GNUNET_MESH_PeerControl
 {
 
-  /**
-   * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL|[UN]BLACKLIST]
-   *       (client to service, client created tunnel)
-   *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
-   *       (service to client)
-   *
-   * Size: sizeof(struct GNUNET_MESH_PeerControl)
-   */
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL|[UN]BLACKLIST]
+     *       (client to service, client created tunnel)
+     *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED]
+     *       (service to client)
+     *
+     * Size: sizeof(struct GNUNET_MESH_PeerControl)
+     */
   struct GNUNET_MessageHeader header;
 
-  /**
-   * ID of a tunnel controlled by this client.
-   */
+    /**
+     * ID of a tunnel controlled by this client.
+     */
   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 
-  /**
-   * Peer to connect/disconnect.
-   */
+    /**
+     * Peer to connect/disconnect.
+     */
   struct GNUNET_PeerIdentity peer;
 };
 
@@ -198,17 +203,19 @@ struct GNUNET_MESH_ConnectPeerByType
     /**
      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE |
      *       GNUNET_MESSAGE_TYPE_MESH_LOCAL_DISCONNECT_PEER_BY_TYPE
+     * 
+     * Size: sizeof(struct GNUNET_MESH_ConnectPeerByType)
      */
   struct GNUNET_MessageHeader header;
 
-  /**
-   * ID of a tunnel controlled by this client.
-   */
+    /**
+     * ID of a tunnel controlled by this client.
+     */
   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 
-  /**
-   * Type specification
-   */
+    /**
+     * Type specification
+     */
   GNUNET_MESH_ApplicationType type GNUNET_PACKED;
 };
 
@@ -220,16 +227,43 @@ struct GNUNET_MESH_ConnectPeerByString
 {
     /**
      * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING
+     * 
+     * Size: sizeof(struct GNUNET_MESH_ConnectPeerByString) + strlen (string)
      */
   struct GNUNET_MessageHeader header;
 
-  /**
-   * ID of a tunnel controlled by this client.
-   */
+    /**
+     * ID of a tunnel controlled by this client.
+     */
   MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 
   /* String describing the service */
 };
+
+
+/**
+ * Message to allow the client send more data to the service
+ * (always service -> client).
+ */
+struct GNUNET_MESH_LocalAck
+{
+    /**
+     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
+     */
+  struct GNUNET_MessageHeader header;
+
+    /**
+     * ID of the tunnel allowed to send more data.
+     */
+  MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
+    /**
+     * ID of the last packet allowed.
+     */
+  uint32_t max_pid GNUNET_PACKED;
+};
+
+
 GNUNET_NETWORK_STRUCT_END
 
 /******************************************************************************/
@@ -278,5 +312,53 @@ enum MeshPeerState
 };
 
 
+/**
+ * Check if one pid is bigger than other, accounting for overflow.
+ *
+ * @param bigger Argument that should be bigger.
+ * @param smaller Argument that should be smaller.
+ *
+ * @return True if bigger (arg1) has a higher value than smaller (arg 2).
+ */
+int
+GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
+
+
+/**
+ * Get the higher ACK value out of two values, taking in account overflow.
+ *
+ * @param a First ACK value.
+ * @param b Second ACK value.
+ *
+ * @return Highest ACK value from the two.
+ */
+uint32_t
+GMC_max_pid (uint32_t a, uint32_t b);
+
+
+/**
+ * Get the lower ACK value out of two values, taking in account overflow.
+ *
+ * @param a First ACK value.
+ * @param b Second ACK value.
+ *
+ * @return Lowest ACK value from the two.
+ */
+uint32_t
+GMC_min_pid (uint32_t a, uint32_t b);
+
+
+/**
+ * Convert a message type into a string to help debug
+ * Generated with:
+ * FIND:        "#define ([^ ]+)[ ]*([0-9]+)"
+ * REPLACE:     "    case \2: return "\1"; break;"
+ * 
+ * @param m Message type.
+ * 
+ * @return Human readable string description.
+ */
+const char *
+GNUNET_MESH_DEBUG_M2S (uint16_t m);
 
 #endif