- use window size client<->server, x4 faster
[oweals/gnunet.git] / src / mesh / mesh.h
index 2a7133a5503670af8a2b25f0cd4a82af61d98007..ca4a1822fcae7f1daf72ba75e84a2f8c5bffa150 100644 (file)
@@ -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"
@@ -36,7 +38,7 @@
 #include "gnunet_peer_lib.h"
 #include "gnunet_core_service.h"
 #include "gnunet_protocols.h"
-#include <gnunet_mesh_service_new.h>
+#include <gnunet_mesh_service.h>
 
 /******************************************************************************/
 /********************        MESH LOCAL MESSAGES      *************************/
 /**************************       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         10
-#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      ******************************/
 /******************************************************************************/
 
+GNUNET_NETWORK_STRUCT_BEGIN
+
 /**
  * Message for a client to register to the service
  */
@@ -107,7 +113,8 @@ struct GNUNET_MESH_ClientConnect
 
 /**
  * Type for tunnel numbering.
- * - Local tunnel numbers are >= 0x80000000
+ * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000
+ * - Local tunnel numbers given by the client (created) are >= 0x80000000
  * - Global tunnel numbers are < 0x80000000
  */
 typedef uint32_t MESH_TunnelNumber;
@@ -119,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)
      */
@@ -165,467 +173,192 @@ struct GNUNET_MESH_TunnelNotification
 struct GNUNET_MESH_PeerControl
 {
 
-  /**
-   * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL]
-   *       (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;
 };
 
 
 /**
- * Message for connecting to peers offering a certain service.
+ * Message for connecting to peers offering a service, by service number.
  */
 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;
 };
 
 
-/******************************************************************************/
-/************************        ENUMERATIONS      ****************************/
-/******************************************************************************/
-
 /**
- * All the states a peer participating in a tunnel can be in.
+ * Message for connecting to peers offering a service, by service string.
  */
-enum MeshPeerState
+struct GNUNET_MESH_ConnectPeerByString
 {
     /**
-     * Peer only retransmits traffic, is not a final destination
+     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING
+     * 
+     * Size: sizeof(struct GNUNET_MESH_ConnectPeerByString) + strlen (string)
      */
-  MESH_PEER_RELAY,
-
-    /**
-     * Path to the peer not known yet
-     */
-  MESH_PEER_SEARCHING,
-
-    /**
-     * Request sent, not yet answered.
-     */
-  MESH_PEER_WAITING,
+  struct GNUNET_MessageHeader header;
 
     /**
-     * Peer connected and ready to accept data
+     * ID of a tunnel controlled by this client.
      */
-  MESH_PEER_READY,
+  MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 
-    /**
-     * Peer connected previosly but not responding
-     */
-  MESH_PEER_RECONNECTING
+  /* String describing the service */
 };
 
 
-/******************************************************************************/
-/************************      DATA STRUCTURES     ****************************/
-/******************************************************************************/
-
 /**
- * Information regarding a possible path to reach a single peer
+ * Message to allow the client send more data to the service
+ * (always service -> client).
  */
-struct MeshPeerPath
+struct GNUNET_MESH_LocalAck
 {
-
-    /**
-     * Linked list
-     */
-  struct MeshPeerPath *next;
-  struct MeshPeerPath *prev;
-
     /**
-     * List of all the peers that form the path from origin to target.
+     * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
      */
-  GNUNET_PEER_Id *peers;
+  struct GNUNET_MessageHeader header;
 
     /**
-     * Number of peers (hops) in the path
+     * ID of the tunnel allowed to send more data.
      */
-  unsigned int length;
-
-};
-
-
-/**
- * Node of path tree for a tunnel
- */
-struct MeshTunnelPathNode
-{
-  /**
-   * Tunnel this node belongs to (and therefore tree)
-   */
-  struct MeshTunnel *t;
-
-  /**
-   * Peer this node describes
-   */
-  GNUNET_PEER_Id peer;
-
-  /**
-   * Parent node in the tree
-   */
-  struct MeshTunnelPathNode *parent;
-
-  /**
-   * Array of children
-   */
-  struct MeshTunnelPathNode *children;
-
-  /**
-   * Number of children
-   */
-  unsigned int nchildren;
+  MESH_TunnelNumber tunnel_id GNUNET_PACKED;
 
     /**
-     * Status of the peer in the tunnel
+     * ID of the last packet allowed.
      */
-  enum MeshPeerState status;
-};
-
-
-/**
- * Tree to reach all peers in the tunnel
- */
-struct MeshTunnelPath
-{
-  /**
-   * How often to refresh the path
-   */
-  struct GNUNET_TIME_Relative refresh;
-
-  /**
-   * Tunnel this path belongs to
-   */
-  struct MeshTunnel *t;
-
-  /**
-   * Root node of peer tree
-   */
-  struct MeshTunnelPathNode *root;
-
-  /**
-   * Node that represents our position in the tree (for non local tunnels)
-   */
-  struct MeshTunnelPathNode *me;
-
-  /**
-   * Cache of all peers and the first hop to them.
-   * Indexed by Peer_Identity, contains a pointer to the PeerIdentity
-   * of 1st hop.
-   */
-  struct GNUNET_CONTAINER_MultiHashMap *first_hops;
-
+  uint32_t max_pid GNUNET_PACKED;
 };
 
 
-/** FWD declaration */
-struct MeshPeerInfo;
-
-/**
- * Struct containing all info possibly needed to build a package when called
- * back by core.
- */
-struct MeshDataDescriptor
-{
-    /** ID of the tunnel this packet travels in */
-  struct MESH_TunnelID *origin;
-
-    /** Ultimate destination of the packet */
-  GNUNET_PEER_Id destination;
-
-    /** Number of identical messages sent to different hops (multicast) */
-  unsigned int copies;
-
-    /** Size of the data */
-  size_t size;
-
-    /** Client that asked for the transmission, if any */
-  struct GNUNET_SERVER_Client *client;
-
-    /** Who was is message being sent to */
-  struct MeshPeerInfo *peer;
-
-    /** Which handler was used to request the transmission */
-  unsigned int handler_n;
-
-  /* Data at the end */
-};
+GNUNET_NETWORK_STRUCT_END
 
+/******************************************************************************/
+/************************        ENUMERATIONS      ****************************/
+/******************************************************************************/
 
 /**
- * Struct containing all information regarding a given peer
+ * All the states a peer participating in a tunnel can be in.
  */
-struct MeshPeerInfo
+enum MeshPeerState
 {
     /**
-     * ID of the peer
+     * Uninitialized status, should never appear in operation.
      */
-  GNUNET_PEER_Id id;
+  MESH_PEER_INVALID,
 
     /**
-     * Last time we heard from this peer
+     * Peer is the root and owner of the tree
      */
-  struct GNUNET_TIME_Absolute last_contact;
+  MESH_PEER_ROOT,
 
     /**
-     * Number of attempts to reconnect so far
-     */
-  int n_reconnect_attempts;
-
-    /**
-     * Paths to reach the peer, ordered by ascending hop count
-     */
-  struct MeshPeerPath *path_head;
-
-    /**
-     * Paths to reach the peer, ordered by ascending hop count
-     */
-  struct MeshPeerPath *path_tail;
-
-    /**
-     * Handle to stop the DHT search for a path to this peer
+     * Peer only retransmits traffic, is not a final destination
      */
-  struct GNUNET_DHT_GetHandle *dhtget;
+  MESH_PEER_RELAY,
 
     /**
-     * Handles to stop queued transmissions for this peer
+     * Path to the peer not known yet
      */
-  struct GNUNET_CORE_TransmitHandle *core_transmit[CORE_QUEUE_SIZE];
+  MESH_PEER_SEARCHING,
 
     /**
-     * Pointer to info stuctures used as cls for queued transmissions
+     * Request sent, not yet answered.
      */
-  struct MeshDataDescriptor *infos[CORE_QUEUE_SIZE];
+  MESH_PEER_WAITING,
 
     /**
-     * Array of tunnels this peer participates in
-     * (most probably a small amount, therefore not a hashmap)
-     * When the path to the peer changes, notify these tunnels to let them
-     * re-adjust their path trees.
+     * Peer connected and ready to accept data
      */
-  struct MeshTunnel **tunnels;
+  MESH_PEER_READY,
 
     /**
-     * Number of tunnels above
+     * Peer connected previosly but not responding
      */
-  unsigned int ntunnels;
+  MESH_PEER_RECONNECTING
 };
 
 
 /**
- * Data scheduled to transmit (to local client or remote peer)
- */
-struct MeshQueue
-{
-    /**
-     * Double linked list
-     */
-  struct MeshQueue *next;
-  struct MeshQueue *prev;
-
-    /**
-     * Target of the data (NULL if target is client)
-     */
-  struct MeshPeerInfo *peer;
-
-    /**
-     * Client to send the data to (NULL if target is peer)
-     */
-  struct MeshClient *client;
-
-    /**
-     * Size of the message to transmit
-     */
-  unsigned int size;
-
-    /**
-     * How old is the data?
-     */
-  struct GNUNET_TIME_Absolute timestamp;
-
-    /**
-     * Data itself
-     */
-  struct GNUNET_MessageHeader *data;
-};
-
-/**
- * Globally unique tunnel identification (owner + number)
- * DO NOT USE OVER THE NETWORK
+ * 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).
  */
-struct MESH_TunnelID
-{
-    /**
-     * Node that owns the tunnel
-     */
-  GNUNET_PEER_Id oid;
+int
+GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
 
-    /**
-     * Tunnel number to differentiate all the tunnels owned by the node oid
-     * ( tid < GNUNET_MESH_LOCAL_TUNNEL_ID_CLI )
-     */
-  MESH_TunnelNumber tid;
-};
-
-
-struct MeshClient;              /* FWD declaration */
 
 /**
- * Struct containing all information regarding a tunnel
- * For an intermediate node the improtant info used will be:
- * - id        Tunnel unique identification
- * - paths[0]  To know where to send it next
- * - metainfo: ready, speeds, accounting
+ * 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.
  */
-struct MeshTunnel
-{
-    /**
-     * Tunnel ID
-     */
-  struct MESH_TunnelID id;
-
-    /**
-     * Local tunnel number ( >= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI or 0 )
-     */
-  MESH_TunnelNumber local_tid;
-
-    /**
-     * Last time the tunnel was used
-     */
-  struct GNUNET_TIME_Absolute timestamp;
-
-    /**
-     * Peers in the tunnel, indexed by PeerIdentity -> (MeshPeerInfo)
-     */
-  struct GNUNET_CONTAINER_MultiHashMap *peers;
-
-    /**
-     * Number of peers that are connected and potentially ready to receive data
-     */
-  unsigned int peers_ready;
-
-    /**
-     * Number of peers that have been added to the tunnel
-     */
-  unsigned int peers_total;
-
-    /**
-     * Client owner of the tunnel, if any
-     */
-  struct MeshClient *client;
-
-    /**
-     * Messages ready to transmit
-     */
-  struct MeshQueue *queue_head;
-  struct MeshQueue *queue_tail;
-
-  /**
-   * Tunnel paths
-   */
-  struct MeshTunnelPath *tree;
-
-  /**
-   * Task to keep the used paths alive
-   */
-  GNUNET_SCHEDULER_TaskIdentifier path_refresh_task;
-};
+uint32_t
+GMC_max_pid (uint32_t a, uint32_t b);
 
 
 /**
- * Info needed to work with tunnel paths and peers
+ * 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.
  */
-struct MeshPathInfo
-{
-  /**
-   * Tunnel
-   */
-  struct MeshTunnel *t;
-
-  /**
-   * Destination peer
-   */
-  struct MeshPeerInfo *peer;
-
-  /**
-   * Path itself
-   */
-  struct MeshPeerPath *path;
-};
+uint32_t
+GMC_min_pid (uint32_t a, uint32_t b);
 
 
 /**
- * Struct containing information about a client of the service
+ * 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.
  */
-struct MeshClient
-{
-    /**
-     * Linked list
-     */
-  struct MeshClient *next;
-  struct MeshClient *prev;
-
-    /**
-     * Tunnels that belong to this client, indexed by local id
-     */
-  struct GNUNET_CONTAINER_MultiHashMap *tunnels;
-
-    /**
-     * Handle to communicate with the client
-     */
-  struct GNUNET_SERVER_Client *handle;
-
-    /**
-     * Applications that this client has claimed to provide
-     */
-  struct GNUNET_CONTAINER_MultiHashMap *apps;
-
-    /**
-     * Messages that this client has declared interest in
-     */
-  struct GNUNET_CONTAINER_MultiHashMap *types;
-
-    /**
-     * Used to search peers offering a service
-     */
-  struct GNUNET_DHT_GetHandle *dht_get_type;
-
-#if MESH_DEBUG
-    /**
-     * ID of the client, for debug messages
-     */
-  unsigned int id;
-#endif
-
-};
+const char *
+GNUNET_MESH_DEBUG_M2S (uint16_t m);
 
 #endif