/**
* @author Bartlomiej Polot
* @file mesh/mesh.h
- *
- * TODO:
- * - API messages!
*/
#ifndef MESH_H_
#define MESH_H_
#include <stdint.h>
+
+#define MESH_DEBUG GNUNET_YES
+
+#define INITIAL_WINDOW_SIZE 8
+#define ACK_THRESHOLD INITIAL_WINDOW_SIZE / 2
+
+#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>
/******************************************************************************/
-/******************** MESH NETWORK MESSAGES **************************/
+/******************** MESH LOCAL MESSAGES *************************/
/******************************************************************************/
-/* API CALL MESSAGE USED
- * -------- ------------
- * connect GNUNET_MESH_Connect / Server_connect? FIXME
- * disconnect GNUNET_MESH_Disconnect / Server_disconnect? FIXME
- *
- * peer_request_connect_any GNUNET_MESH_ConnectPeer
- * peer_request_connect_all GNUNET_MESH_ConnectPeer
- * peer_request_connect_add GNUNET_MESH_ConnectPeer
- * peer_request_connect_del GNUNET_MESH_ConnectPeer
- * peer_request_connect_by_type GNUNET_MESH_ConnectPeerByType
- * peer_request_connect_cancel GNUNET_MESH_Control
- *
- * notify_tranmit_ready GNUNET_MESH_Control? FIXME
- * notify_tranmit_ready_cancel GNUNET_MESH_Control? FIXME
+/* Any API call should be documented in the folowing table under API CALL.
+ * Also, any message type should be documented in the following table, with the
+ * associated event.
+ *
+ * API CALL (GNUNET_MESH_*) MESSAGE USED
+ * ------------------------ ------------
+ * connect GNUNET_MESH_ClientConnect
+ * disconnect None (network level disconnect)
+ *
+ * tunnel_create GNUNET_MESH_TunnelMessage
+ * tunnel_destroy 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_cancel None (clear of internal data structures)
+ *
+ *
+ *
+ * EVENT MESSAGE USED
+ * ----- ------------
+ * data GNUNET_MESH_Data OR
+ * GNUNET_MESH_DataBroadcast
+ * new incoming tunnel GNUNET_MESH_PeerControl
+ * peer connects to a tunnel GNUNET_MESH_PeerControl
+ * peer disconnects from a tunnel GNUNET_MESH_PeerControl
*/
-// struct GNUNET_MESH_Connect {
-// /**
-// * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
-// *
-// * Size: sizeof(struct GNUNET_MESH_Connect) + messages_subscribed * sizeof (message_type)
-// */
-// struct GNUNET_MessageHeader header;
-//
-// /* uint16_t messages_subscribed[] */
-// };
-//
-// struct GNUNET_MESH_Disconnect {
-// /**
-// * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DISCONNECT
-// */
-// struct GNUNET_MessageHeader header;
-//
-// };
-
-struct GNUNET_MESH_ConnectPeer {
- /**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ANY|ALL|ADD|DEL]
- *
- * Size: sizeof(struct GNUNET_MESH_ConnectPeer) + npeers * sizeof (struct GNUNET_PeerIdentity)
+/******************************************************************************/
+/************************** CONSTANTS ******************************/
+/******************************************************************************/
+
+#define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI 0x80000000
+#define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV 0xB0000000
+
+#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
+ */
+struct GNUNET_MESH_ClientConnect
+{
+ /**
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
+ *
+ * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
+ * sizeof(MESH_ApplicationType) * applications +
+ * 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] */
+};
+
+
+/**
+ * Type for tunnel numbering.
+ * - 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;
+
+/**
+ * Message for a client to create and destroy tunnels.
+ */
+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)
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
- /* struct GNUNET_PeerIdentity peers[] */
+ /**
+ * ID of a tunnel controlled by this client.
+ */
+ MESH_TunnelNumber tunnel_id GNUNET_PACKED;
};
-struct GNUNET_MESH_ConnectPeerByType {
+
+/**
+ * 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
+ */
+ 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)
+ */
+ struct GNUNET_MessageHeader header;
+
+ /**
+ * ID of a tunnel controlled by this client.
+ */
+ MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
+ /**
+ * Peer to connect/disconnect.
+ */
+ struct GNUNET_PeerIdentity peer;
+};
+
+
+/**
+ * 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
+ * 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;
+ struct GNUNET_MessageHeader header;
- /* FIXME Type specification */
- uint32_t type;
+ /**
+ * ID of a tunnel controlled by this client.
+ */
+ MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
+ /**
+ * Type specification
+ */
+ GNUNET_MESH_ApplicationType type GNUNET_PACKED;
};
-struct GNUNET_MESH_Control {
+
+/**
+ * Message for connecting to peers offering a service, by service string.
+ */
+struct GNUNET_MESH_ConnectPeerByString
+{
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_CANCEL
- * more? transmit_ready?
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING
+ *
+ * Size: sizeof(struct GNUNET_MESH_ConnectPeerByString) + strlen (string)
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
- uint32_t tunnel_id GNUNET_PACKED;
- uint32_t variable GNUNET_PACKED; /* Size of data to transmit? */
+ /**
+ * ID of a tunnel controlled by this client.
+ */
+ MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
+ /* String describing the service */
};
-struct GNUNET_MESH_TunnelEvent {
+
+/**
+ * Message to allow the client send more data to the service
+ * (always service -> client).
+ */
+struct GNUNET_MESH_LocalAck
+{
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATED\DESTROYED]
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
- uint32_t tunnel_id GNUNET_PACKED;
- uint32_t reason GNUNET_PACKED; /* incoming, connect, timeout, disconnect */
+ /**
+ * 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;
};
-struct GNUNET_MESH_Data {
+
+GNUNET_NETWORK_STRUCT_END
+
+/******************************************************************************/
+/************************ ENUMERATIONS ****************************/
+/******************************************************************************/
+
+/**
+ * All the states a peer participating in a tunnel can be in.
+ */
+enum MeshPeerState
+{
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
- *
- * Size: sizeof(struct GNUNET_MESH_Data) + sizeof (data)
+ * 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
*/
- struct GNUNET_MessageHeader header;
+ MESH_PEER_RELAY,
- uint32_t tunnel_id GNUNET_PACKED;
+ /**
+ * Path to the peer not known yet
+ */
+ MESH_PEER_SEARCHING,
- /* FIXME: Broadcast? New Type / NULL destination ? */
- /* FIXME: Reverese order for alignment? 1st ID, 2nd t_id? */
- struct GNUNET_PeerIdentity destination GNUNET_PACKED;
+ /**
+ * Request sent, not yet answered.
+ */
+ MESH_PEER_WAITING,
+
+ /**
+ * Peer connected and ready to accept data
+ */
+ MESH_PEER_READY,
- /* uint8_t data[] */
+ /**
+ * Peer connected previosly but not responding
+ */
+ MESH_PEER_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);
+
#endif
projects / oweals / gnunet.git / blobdiff