* @file mesh/mesh.h
*/
-
#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_peer_lib.h"
+#include "gnunet_core_service.h"
+#include "gnunet_protocols.h"
+#include <gnunet_mesh_service.h>
+
+/******************************************************************************/
+/************************** CONSTANTS ******************************/
+/******************************************************************************/
+
+#define GNUNET_MESH_LOCAL_CHANNEL_ID_CLI 0x80000000
+#define GNUNET_MESH_LOCAL_CHANNEL_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;
+ /* uint32_t list_ports[] */
+};
+
/**
- * Message for mesh path management
+ * Type for channel numbering.
+ * - Local channel numbers given by the service (incoming) are >= 0xB0000000
+ * - Local channel numbers given by the client (created) are >= 0x80000000
+ * - Global channel numbers are < 0x80000000
*/
-struct GNUNET_MESH_ManipulatePath
+typedef uint32_t MESH_ChannelNumber;
+
+
+/**
+ * Message for a client to create and destroy channels.
+ */
+struct GNUNET_MESH_ChannelMessage
{
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD]
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
+ *
+ * Size: sizeof(struct GNUNET_MESH_ChannelMessage)
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
/**
- * Id of the tunnel this path belongs to
+ * ID of a channel controlled by this client.
*/
- uint32_t tid;
+ MESH_ChannelNumber channel_id GNUNET_PACKED;
/**
- * Information about speed requirements
+ * Channel's peer
*/
- uint32_t speed_min;
- uint32_t speed_max;
+ struct GNUNET_PeerIdentity peer;
/**
- * Number of hops in the path given below
+ * Port of the channel.
*/
- uint16_t path_length;
+ uint32_t port GNUNET_PACKED;
/**
- * path_length structs defining the *whole* path
+ * Options.
*/
- struct GNUNET_PeerIdentity peers[];
+ uint32_t opt GNUNET_PACKED;
};
+
/**
- * Message for mesh data traffic
+ * Message for mesh data traffic.
*/
-struct GNUNET_MESH_Data
+struct GNUNET_MESH_LocalData
{
/**
- * Type: GNUNET_MESSAGE_TYPE_DATA_[GO|BACK]
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
*/
- struct GNUNET_MessageHeader header;
+ struct GNUNET_MessageHeader header;
/**
- * OID of the tunnel
+ * ID of the channel
*/
- struct GNUNET_PeerIdentity oid;
+ uint32_t id GNUNET_PACKED;
/**
- * TID of the tunnel
+ * Payload follows
*/
- uint32_t tid;
+};
- /**
- * FIXME Some form of authentication
- */
- uint32_t token;
+/**
+ * Message to allow the client send more data to the service
+ * (always service -> client).
+ */
+struct GNUNET_MESH_LocalAck
+{
/**
- * Size of payload
- * FIXME uint16 enough?
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK
*/
- uint16_t size;
+ struct GNUNET_MessageHeader header;
/**
- * Payload
+ * ID of the channel allowed to send more data.
*/
- uint8_t data[];
+ MESH_ChannelNumber channel_id GNUNET_PACKED;
+
};
+
/**
- * Message for mesh flow control
+ * Message to inform the client about channels in the service.
*/
-struct GNUNET_MESH_SpeedNotify
+struct GNUNET_MESH_LocalMonitor
{
- /**
- * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
- */
- struct GNUNET_MessageHeader header;
+ /**
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_MONITOR[_TUNNEL]
+ */
+ struct GNUNET_MessageHeader header;
- /**
- * OID of the tunnel
- */
- struct GNUNET_PeerIdentity oid;
+ /**
+ * ID of the channel allowed to send more data.
+ */
+ MESH_ChannelNumber channel_id GNUNET_PACKED;
- /**
- * TID of the tunnel
- */
- uint32_t tid;
+ /**
+ * Alignment.
+ */
+ uint32_t reserved GNUNET_PACKED;
- /**
- * Slowest link down the path
- */
- uint32_t speed_min;
+ /**
+ * ID of the owner of the channel (can be local peer).
+ */
+ struct GNUNET_PeerIdentity owner;
- /**
- * Fastest link down the path
- */
- uint32_t speed_max;
+ /**
+ * ID of the destination of the channel (can be local peer).
+ */
+ struct GNUNET_PeerIdentity destination;
};
-#endif
\ No newline at end of file
+
+GNUNET_NETWORK_STRUCT_END
+
+
+
+/**
+ * @brief Translate a fwd variable into a string representation, for logging.
+ *
+ * @param fwd Is FWD? (#GNUNET_YES or #GNUNET_NO)
+ *
+ * @return String representing FWD or BCK.
+ */
+char *
+GM_f2s (int fwd);
+
+
+/**
+ * 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
+GM_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
+GM_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
+GM_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 *
+GM_m2s (uint16_t m);
+
+#if 0 /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+#endif
projects / oweals / gnunet.git / blobdiff