/**
* @author Bartlomiej Polot
* @file mesh/mesh.h
- *
- * TODO:
- * - soft stateing (keep-alive (CHANGE?) / timeout / disconnect) -- not a message issue
- * - error reporting (CREATE/CHANGE/ADD/DEL?) -- new message!
- * - partial disconnect reporting -- same as error reporting?
- * - add vs create? change vs. keep-alive? same msg or different ones? -- thinking...
- * - speed requirement specification (change?) in mesh API -- API call
- *
- * - API messages!
*/
-
#ifndef MESH_H_
#define MESH_H_
+
+#ifdef __cplusplus
+extern "C"
+{
+#if 0 /* keep Emacsens' auto-indent happy */
+}
+#endif
+#endif
+
#include <stdint.h>
-#include "gnunet_common.h"
+
+#define MESH_DEBUG GNUNET_YES
+
+#include "platform.h"
+#include "gnunet_util_lib.h"
+#include "gnunet_core_service.h"
+#include "gnunet_protocols.h"
+#include <gnunet_mesh_service.h>
+
+/******************************************************************************/
+/******************** MESH LOCAL MESSAGES *************************/
+/******************************************************************************/
+/* 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
+ * tunnel_buffer GNUNET_MESH_TunnelMessage
+ *
+ * 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_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 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 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 mesh path management
+ * Message for a client to register to the service
*/
-struct GNUNET_MESH_ManipulatePath
+struct GNUNET_MESH_ClientConnect
{
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD|DEL]
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
*
- * Size: sizeof(struct GNUNET_MESH_ManipulatePath) + path_length * sizeof (struct GNUNET_PeerIdentity)
+ * Size: sizeof(struct GNUNET_MESH_ClientConnect) +
+ * sizeof(MESH_ApplicationType) * applications +
+ * sizeof(uint16_t) * types
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
+ /* uint32_t list_ports[] */
+};
- /**
- * Id of the tunnel this path belongs to, unique in conjunction with the origin.
- */
- uint32_t tid GNUNET_PACKED;
- /**
- * Information about speed requirements. If the tunnel cannot sustain the
- * minimum bandwidth, packets are to be dropped.
- */
- uint32_t speed_min GNUNET_PACKED;
+/**
+ * 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;
- /**
- * path_length structs defining the *whole* path from the origin [0] to the
- * final destination [path_length-1].
- */
- // struct GNUNET_PeerIdentity peers[path_length];
-};
/**
- * Message for mesh data traffic to all tunnel targets.
+ * Message for a client to create and destroy tunnels.
*/
-struct GNUNET_MESH_OriginMulticast
+struct GNUNET_MESH_TunnelMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DATA_MULTICAST
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
+ *
+ * Size: sizeof(struct GNUNET_MESH_TunnelMessage)
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
/**
- * TID of the tunnel
+ * ID of a tunnel controlled by this client.
*/
- uint32_t tid GNUNET_PACKED;
+ MESH_TunnelNumber tunnel_id GNUNET_PACKED;
/**
- * OID of the tunnel
+ * Tunnel's peer
*/
- struct GNUNET_PeerIdentity oid;
+ struct GNUNET_PeerIdentity peer;
/**
- * FIXME: Some form of authentication
+ * Port of the tunnel.
*/
- // uint32_t token;
+ uint32_t port GNUNET_PACKED;
/**
- * Payload follows
+ * Options.
*/
+ uint32_t opt GNUNET_PACKED;
};
/**
- * Message for mesh data traffic to a particular destination from origin.
+ * Message for mesh data traffic.
*/
-struct GNUNET_MESH_DataMessageFromOrigin
+struct GNUNET_MESH_LocalData
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_FROM_ORIGIN
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
/**
* TID of the tunnel
*/
- uint32_t tid GNUNET_PACKED;
+ uint32_t tid GNUNET_PACKED;
/**
- * OID of the tunnel
+ * Payload follows
*/
- struct GNUNET_PeerIdentity oid;
+};
- /**
- * Destination.
- */
- struct GNUNET_PeerIdentity destination;
+/**
+ * Message to allow the client send more data to the service
+ * (always service -> client).
+ */
+struct GNUNET_MESH_LocalAck
+{
/**
- * FIXME: Some form of authentication
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
*/
- // uint32_t token;
+ struct GNUNET_MessageHeader header;
/**
- * Payload follows
+ * ID of the tunnel allowed to send more data.
*/
+ MESH_TunnelNumber tunnel_id GNUNET_PACKED;
+
};
/**
- * Message for mesh data traffic from a tunnel participant to origin.
+ * Message to inform the client about tunnels in the service.
*/
-struct GNUNET_MESH_DataMessageToOrigin
+struct GNUNET_MESH_LocalMonitor
{
- /**
- * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_TO_ORIGIN
- */
- struct GNUNET_MessageHeader header;
+ /**
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
+ */
+ struct GNUNET_MessageHeader header;
+
+ /**
+ * ID of the tunnel allowed to send more data.
+ */
+ MESH_TunnelNumber tunnel_id 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;
+};
+
+
+GNUNET_NETWORK_STRUCT_END
+/******************************************************************************/
+/************************ ENUMERATIONS ****************************/
+/******************************************************************************/
+
+/**
+ * All the states a tunnel can be in.
+ */
+enum MeshTunnelState
+{
/**
- * TID of the tunnel
+ * Uninitialized status, should never appear in operation.
*/
- uint32_t tid GNUNET_PACKED;
+ MESH_TUNNEL_NEW,
/**
- * OID of the tunnel
+ * Path to the peer not known yet
*/
- struct GNUNET_PeerIdentity oid;
+ MESH_TUNNEL_SEARCHING,
/**
- * Sender of the message.
+ * Request sent, not yet answered.
*/
- struct GNUNET_PeerIdentity sender;
+ MESH_TUNNEL_WAITING,
/**
- * FIXME: Some form of authentication
+ * Peer connected and ready to accept data
*/
- // uint32_t token;
+ MESH_TUNNEL_READY,
/**
- * Payload follows
+ * Peer connected previosly but not responding
*/
+ MESH_TUNNEL_RECONNECTING
};
+
/**
- * Message for mesh flow control
+ * 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 GNUNET_MESH_SpeedNotify
-{
- /**
- * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
- */
- struct GNUNET_MessageHeader header;
+int
+GMC_is_pid_bigger (uint32_t bigger, uint32_t smaller);
- /**
- * TID of the tunnel
- */
- uint32_t tid GNUNET_PACKED;
- /**
- * OID of the tunnel
- */
- struct GNUNET_PeerIdentity oid;
+/**
+ * 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);
- /**
- * Slowest link down the path (above minimum speed requirement).
- */
- uint32_t speed_min;
-};
+/**
+ * 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