#ifndef MESH_H_
#define MESH_H_
+
+#ifdef __cplusplus
+extern "C"
+{
+#if 0 /* keep Emacsens' auto-indent happy */
+}
+#endif
+#endif
+
#include <stdint.h>
#define MESH_DEBUG GNUNET_YES
-
#include "platform.h"
-#include "gnunet_common.h"
#include "gnunet_util_lib.h"
-#include "gnunet_peer_lib.h"
#include "gnunet_core_service.h"
#include "gnunet_protocols.h"
#include <gnunet_mesh_service.h>
*
* tunnel_create GNUNET_MESH_TunnelMessage
* tunnel_destroy GNUNET_MESH_TunnelMessage
+ * tunnel_buffer GNUNET_MESH_TunnelMessage
*
- * peer_request_connect_add GNUNET_MESH_PeerControl
- * peer_request_connect_del GNUNET_MESH_PeerControl
- * peer_request_connect_by_type GNUNET_MESH_ConnectPeerByType
- *
- * notify_transmit_ready *GNUNET_MESH_TransmitReady?*
+ * notify_transmit_ready None (queue / GNUNET_CLIENT_ntf_tmt_rdy)
* notify_transmit_ready_cancel None (clear of internal data structures)
*
*
- *
* EVENT MESSAGE USED
* ----- ------------
- * data GNUNET_MESH_Data OR
- * GNUNET_MESH_DataBroadcast
+ * data GNUNET_MESH_Unicast OR
+ * GNUNET_MESH_Multicast OR
+ * GNUNET_MESH_ToOrigin
+ * data ack GNUNET_MESH_LocalAck
+ *
* new incoming tunnel GNUNET_MESH_PeerControl
- * peer connects to a tunnel GNUNET_MESH_PeerControl
- * peer disconnects from a tunnel GNUNET_MESH_PeerControl
+ * peer connects to a tunnel FIXME
+ * peer disconnects from a tunnel FIXME
*/
/******************************************************************************/
/************************** 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 ******************************/
* sizeof(uint16_t) * types
*/
struct GNUNET_MessageHeader header;
- uint16_t applications GNUNET_PACKED;
- uint16_t types GNUNET_PACKED;
- /* uint16_t list_apps[applications] */
- /* uint16_t list_types[types] */
+ /* uint32_t list_ports[] */
};
*/
typedef uint32_t MESH_TunnelNumber;
+
/**
* Message for a client to create and destroy tunnels.
*/
{
/**
* Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
- * GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[MAX|MIN]
*
* Size: sizeof(struct GNUNET_MESH_TunnelMessage)
*/
* ID of a tunnel controlled by this client.
*/
MESH_TunnelNumber tunnel_id GNUNET_PACKED;
-};
-
-
-/**
- * Message for the service to let a client know about created tunnels.
- */
-struct GNUNET_MESH_TunnelNotification
-{
- /**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE
- *
- * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
- */
- struct GNUNET_MessageHeader header;
/**
- * ID of a tunnel controlled by this client.
- */
- MESH_TunnelNumber tunnel_id GNUNET_PACKED;
-
- /**
- * Peer at the other end, if any
+ * Tunnel's peer
*/
struct GNUNET_PeerIdentity peer;
-};
-
-/**
- * Message for:
- * - request adding and deleting peers from a tunnel
- * - notify the client that peers have connected:
- * -- requested
- * -- unrequested (new incoming tunnels)
- * - notify the client that peers have disconnected
- */
-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)
+ * Port of the tunnel.
*/
- struct GNUNET_MessageHeader header;
+ uint32_t port GNUNET_PACKED;
/**
- * ID of a tunnel controlled by this client.
+ * Options.
*/
- MESH_TunnelNumber tunnel_id GNUNET_PACKED;
-
- /**
- * Peer to connect/disconnect.
- */
- struct GNUNET_PeerIdentity peer;
+ uint32_t opt GNUNET_PACKED;
};
/**
- * Message for connecting to peers offering a service, by service number.
+ * Message for mesh data traffic.
*/
-struct GNUNET_MESH_ConnectPeerByType
+struct GNUNET_MESH_LocalData
{
/**
- * 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)
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
*/
struct GNUNET_MessageHeader header;
/**
- * ID of a tunnel controlled by this client.
+ * TID of the tunnel
*/
- MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+ uint32_t tid GNUNET_PACKED;
/**
- * Type specification
+ * Payload follows
*/
- GNUNET_MESH_ApplicationType type GNUNET_PACKED;
};
/**
- * Message for connecting to peers offering a service, by service string.
+ * Message to allow the client send more data to the service
+ * (always service -> client).
*/
-struct GNUNET_MESH_ConnectPeerByString
+struct GNUNET_MESH_LocalAck
{
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING
- *
- * Size: sizeof(struct GNUNET_MESH_ConnectPeerByString) + strlen (string)
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
*/
struct GNUNET_MessageHeader header;
/**
- * ID of a tunnel controlled by this client.
+ * ID of the tunnel allowed to send more data.
*/
MESH_TunnelNumber tunnel_id GNUNET_PACKED;
- /* String describing the service */
};
/**
- * Message to allow the client send more data to the service
- * (always service -> client).
+ * Message to inform the client about tunnels in the service.
*/
-struct GNUNET_MESH_LocalAck
+struct GNUNET_MESH_LocalMonitor
{
- /**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
- */
+ /**
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
+ */
struct GNUNET_MessageHeader header;
- /**
- * ID of the tunnel allowed to send more data.
- */
+ /**
+ * 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;
+ /**
+ * Alignment.
+ */
+ uint32_t reserved GNUNET_PACKED;
+
+ /**
+ * ID of the owner of the tunnel (can be local peer).
+ */
+ struct GNUNET_PeerIdentity owner;
+
+ /**
+ * ID of the destination of the tunnel (can be local peer).
+ */
+ struct GNUNET_PeerIdentity destination;
};
/******************************************************************************/
/**
- * All the states a peer participating in a tunnel can be in.
+ * All the states a tunnel can be in.
*/
-enum MeshPeerState
+enum MeshTunnelState
{
/**
* Uninitialized status, should never appear in operation.
*/
- MESH_PEER_INVALID,
-
- /**
- * Peer is the root and owner of the tree
- */
- MESH_PEER_ROOT,
-
- /**
- * Peer only retransmits traffic, is not a final destination
- */
- MESH_PEER_RELAY,
+ MESH_TUNNEL_NEW,
/**
* Path to the peer not known yet
*/
- MESH_PEER_SEARCHING,
+ MESH_TUNNEL_SEARCHING,
/**
* Request sent, not yet answered.
*/
- MESH_PEER_WAITING,
+ MESH_TUNNEL_WAITING,
/**
* Peer connected and ready to accept data
*/
- MESH_PEER_READY,
+ MESH_TUNNEL_READY,
/**
* Peer connected previosly but not responding
*/
- MESH_PEER_RECONNECTING
+ MESH_TUNNEL_RECONNECTING
};
+/**
+ * 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);
+
+#if 0 /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
#endif