X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fmesh%2Fmesh.h;h=7011bd51ac6ebf495b58ef6603c064d527e22c64;hb=e43078b68951ad8a3daa3a193473e9c321549e1d;hp=dda3e2fccbf54c35dee2f288e402224b9192e659;hpb=6d324c54d68defac2c1727ab40e4d0258361b50b;p=oweals%2Fgnunet.git diff --git a/src/mesh/mesh.h b/src/mesh/mesh.h index dda3e2fcc..7011bd51a 100644 --- a/src/mesh/mesh.h +++ b/src/mesh/mesh.h @@ -21,111 +21,283 @@ /** * @author Bartlomiej Polot * @file mesh/mesh.h - * - * TODO: - * - API messages! */ #ifndef MESH_H_ #define MESH_H_ + +#ifdef __cplusplus +extern "C" +{ +#if 0 /* keep Emacsens' auto-indent happy */ +} +#endif +#endif + #include -#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 /******************************************************************************/ -/******************** MESH NETWORK MESSAGES **************************/ +/************************** CONSTANTS ******************************/ /******************************************************************************/ -/* 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 - */ -// 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 { +#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_PEER_[ANY|ALL|ADD|DEL] - * - * Size: sizeof(struct GNUNET_MESH_ConnectPeer) + npeers * sizeof (struct GNUNET_PeerIdentity) + * 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; - - /* struct GNUNET_PeerIdentity peers[] */ + struct GNUNET_MessageHeader header; + /* uint32_t list_ports[] */ }; -struct GNUNET_MESH_ConnectPeerByType { + +/** + * 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 + */ +typedef uint32_t MESH_ChannelNumber; + + +/** + * Message for a client to create and destroy channels. + */ +struct GNUNET_MESH_ChannelMessage +{ + /** + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY] + * + * Size: sizeof(struct GNUNET_MESH_ChannelMessage) + */ + struct GNUNET_MessageHeader header; + /** - * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE + * ID of a channel controlled by this client. */ - struct GNUNET_MessageHeader header; + MESH_ChannelNumber channel_id GNUNET_PACKED; - /* FIXME Type specification */ - uint32_t type; -}; + /** + * Channel's peer + */ + struct GNUNET_PeerIdentity peer; -struct GNUNET_MESH_Control { /** - * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_CANCEL - * more? transmit_ready? + * Port of the channel. */ - struct GNUNET_MessageHeader header; + uint32_t port GNUNET_PACKED; - uint32_t tunnel_id GNUNET_PACKED; - uint32_t variable GNUNET_PACKED; /* Size of data to transmit? */ + /** + * Options. + */ + uint32_t opt GNUNET_PACKED; }; -struct GNUNET_MESH_TunnelEvent { + +/** + * Message for mesh data traffic. + */ +struct GNUNET_MESH_LocalData +{ + /** + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA + */ + struct GNUNET_MessageHeader header; + /** - * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATED\DESTROYED] + * ID of the channel */ - struct GNUNET_MessageHeader header; + uint32_t id GNUNET_PACKED; - uint32_t tunnel_id GNUNET_PACKED; - uint32_t reason GNUNET_PACKED; /* incoming, connect, timeout, disconnect */ + /** + * Payload follows + */ }; -struct GNUNET_MESH_Data { + +/** + * Message to allow the client send more data to the service + * (always service -> client). + */ +struct GNUNET_MESH_LocalAck +{ /** - * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA - * - * Size: sizeof(struct GNUNET_MESH_Data) + sizeof (data) + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK + */ + struct GNUNET_MessageHeader header; + + /** + * ID of the channel allowed to send more data. */ - struct GNUNET_MessageHeader header; + MESH_ChannelNumber channel_id GNUNET_PACKED; - uint32_t tunnel_id GNUNET_PACKED; +}; + + +/** + * Message to inform the client about channels in the service. + */ +struct GNUNET_MESH_LocalInfo +{ + /** + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO[_TUNNEL] + */ + struct GNUNET_MessageHeader header; + + /** + * ID of the channel allowed to send more data. + */ + MESH_ChannelNumber channel_id GNUNET_PACKED; + + /** + * ID of the owner of the channel (can be local peer). + */ +// struct GNUNET_PeerIdentity owner; + + /** + * ID of the destination of the channel (can be local peer). + */ + struct GNUNET_PeerIdentity peer; +}; + +/** + * Message to inform the client about one of the tunnels in the service. + */ +struct GNUNET_MESH_LocalInfoTunnel +{ + /** + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_INFO_TUNNEL[S] + */ + struct GNUNET_MessageHeader header; + + /** + * Number of channels. + */ + uint32_t channels GNUNET_PACKED; - /* FIXME: Broadcast? New Type / NULL destination ? */ - /* FIXME: Reverese order for alignment? 1st ID, 2nd t_id? */ - struct GNUNET_PeerIdentity destination GNUNET_PACKED; + /** + * ID of the destination of the tunnel (can be local peer). + */ + struct GNUNET_PeerIdentity destination; - /* uint8_t data[] */ + /** + * Number of connections. + */ + uint32_t connections GNUNET_PACKED; + + /** + * Encryption state. + */ + uint16_t estate GNUNET_PACKED; + + /** + * Connection state. + */ + uint16_t cstate GNUNET_PACKED; + + /* If TUNNEL (no 'S'): GNUNET_PeerIdentity connection_ids[connections] */ + /* If TUNNEL (no 'S'): uint32_t channel_ids[channels] */ }; + +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