2 This file is part of GNUnet.
3 (C) 2001 - 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file mesh/gnunet-service-mesh.c
23 * @brief GNUnet MESH service
24 * @author Bartlomiej Polot
27 * - MESH NETWORK MESSAGES
30 * - MESH NETWORK HANDLES
31 * - MESH LOCAL HANDLES
32 * - MAIN FUNCTIONS (main & run)
35 * - soft stateing (keep-alive (CHANGE?) / timeout / disconnect) -- not a message issue
36 * - error reporting (CREATE/CHANGE/ADD/DEL?) -- new message!
37 * - partial disconnect reporting -- same as error reporting?
38 * - add vs create? change vs. keep-alive? same msg or different ones? -- thinking...
39 * - speed requirement specification (change?) in mesh API -- API call
43 #include "gnunet_common.h"
44 #include "gnunet_util_lib.h"
45 #include "gnunet_peer_lib.h"
46 #include "gnunet_core_service.h"
47 #include "gnunet_protocols.h"
50 #include "gnunet_dht_service.h"
52 /******************************************************************************/
53 /******************** MESH NETWORK MESSAGES **************************/
54 /******************************************************************************/
57 * Message for mesh path management
59 struct GNUNET_MESH_ManipulatePath
62 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD|DEL]
64 * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
65 * path_length * sizeof (struct GNUNET_PeerIdentity)
67 struct GNUNET_MessageHeader header;
70 * Global id of the tunnel this path belongs to,
71 * unique in conjunction with the origin.
73 uint32_t tid GNUNET_PACKED;
76 * Information about speed requirements. If the tunnel cannot sustain the
77 * minimum bandwidth, packets are to be dropped.
79 uint32_t speed_min GNUNET_PACKED;
84 uint32_t reserved GNUNET_PACKED;
87 * path_length structs defining the *whole* path from the origin [0] to the
88 * final destination [path_length-1].
90 /* struct GNUNET_PeerIdentity peers[path_length]; */
94 * Message for mesh data traffic to all tunnel targets.
96 struct GNUNET_MESH_OriginMulticast
99 * Type: GNUNET_MESSAGE_TYPE_DATA_MULTICAST
101 struct GNUNET_MessageHeader header;
106 uint32_t tid GNUNET_PACKED;
111 struct GNUNET_PeerIdentity oid;
120 * Message for mesh data traffic to a particular destination from origin.
122 struct GNUNET_MESH_DataMessageFromOrigin
125 * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_FROM_ORIGIN
127 struct GNUNET_MessageHeader header;
132 uint32_t tid GNUNET_PACKED;
137 struct GNUNET_PeerIdentity oid;
142 struct GNUNET_PeerIdentity destination;
151 * Message for mesh data traffic from a tunnel participant to origin.
153 struct GNUNET_MESH_DataMessageToOrigin
156 * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_TO_ORIGIN
158 struct GNUNET_MessageHeader header;
163 uint32_t tid GNUNET_PACKED;
168 struct GNUNET_PeerIdentity oid;
171 * Sender of the message.
173 struct GNUNET_PeerIdentity sender;
181 * Message for mesh flow control
183 struct GNUNET_MESH_SpeedNotify
186 * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
188 struct GNUNET_MessageHeader header;
193 uint32_t tid GNUNET_PACKED;
198 struct GNUNET_PeerIdentity oid;
201 * Slowest link down the path (above minimum speed requirement).
207 /******************************************************************************/
208 /************************ DATA STRUCTURES ****************************/
209 /******************************************************************************/
212 * All the states a peer participating in a tunnel can be in.
217 * Request sent, not yet answered.
222 * Peer connected and ready to accept data
227 * Peer connected previosly but not responding
229 MESH_PEER_RECONNECTING,
234 * Struct containing all information regarding a given peer
241 struct PeerInfo *next;
242 struct PeerInfo *prev;
250 * Is the peer reachable? Is the peer even connected?
252 enum PeerState state;
255 * When to try to establish contact again?
257 struct GNUNET_TIME_Absolute next_reconnect_attempt;
260 * Who to send the data to --- FIXME what about multiple (alternate) paths?
262 GNUNET_PEER_Id first_hop;
265 * Max data rate to this peer
271 typedef uint32_t MESH_PathID;
273 * Information regarding a path
284 * Id of the path, in case it's needed
289 * Whether the path is serving traffic in a tunnel or is a backup
294 * List of all the peers that form the path from origin to target
296 GNUNET_PEER_Id *peers;
304 struct MESH_queue *next;
305 struct MESH_queue *prev;
308 * Size of the message to transmit
313 * How old is the data?
315 struct GNUNET_TIME_Absolute timestamp;
320 struct GNUNET_MessageHeader *data;
324 struct Client; /* FWD declaration */
326 * Struct containing all information regarding a tunnel
327 * For an intermediate node the improtant info used will be:
328 * - OID \ To identify
330 * - paths[0] | To know where to send it next
331 * - metainfo: ready, speeds, accounting
332 * For an end node more fields will be needed (client-handling)
340 struct MESH_tunnel *next;
341 struct MESH_tunnel *prev;
344 * Origin ID: Node that created the tunnel
349 * Tunnel number (unique for a given oid)
354 * Minimal speed for this tunnel in kb/s
359 * Maximal speed for this tunnel in kb/s
364 * Last time the tunnel was used
366 struct GNUNET_TIME_Absolute timestamp;
369 * Peers in the tunnel, for future optimizations
371 struct PeerInfo *peers_head;
372 struct PeerInfo *peers_tail;
375 * Number of peers that are connected and potentially ready to receive data
377 unsigned int peers_ready;
380 * Number of peers that have been added to the tunnel
382 unsigned int peers_total;
385 * Paths (used and backup)
387 struct Path *paths_head;
388 struct Path *paths_tail;
391 * If this tunnel was created by a local client, what's its handle?
393 struct Client *client;
396 * Messages ready to transmit
398 struct MESH_queue *out_head;
399 struct MESH_queue *out_tail;
402 * Messages received and not processed
404 struct MESH_queue *in_head;
405 struct MESH_queue *in_tail;
410 * Struct containing information about a client of the service
421 * Tunnels that belong to this client, for convenience on disconnect
423 struct MESH_tunnel *tunnels_head;
424 struct MESH_tunnel *tunnels_tail;
427 * Handle to communicate with the client
429 struct GNUNET_SERVER_Client *handle;
432 * Messages that this client has declared interest in
434 GNUNET_MESH_ApplicationType *messages_subscribed;
435 unsigned int subscription_counter;
439 /******************************************************************************/
440 /*********************** GLOBAL VARIABLES ****************************/
441 /******************************************************************************/
446 static struct Client *clients_head;
447 static struct Client *clients_tail;
452 static struct MESH_tunnel *tunnels_head;
453 static struct MESH_tunnel *tunnels_tail;
456 * All the paths (for future path optimization)
458 // static struct Path *paths_head;
459 // static struct Path *paths_tail;
462 * Handle to communicate with core
464 static struct GNUNET_CORE_Handle *core_handle;
469 static struct GNUNET_DHT_Handle *dht_handle;
472 * Local peer own ID (memory efficient handle)
474 static GNUNET_PEER_Id myid;
476 /******************************************************************************/
477 /******************** MESH NETWORK HANDLERS **************************/
478 /******************************************************************************/
481 * Core handler for path creation
482 * struct GNUNET_CORE_MessageHandler
485 * @param message message
486 * @param peer peer identity this notification is about
487 * @param atsi performance data
488 * @return GNUNET_OK to keep the connection open,
489 * GNUNET_SYSERR to close it (signal serious error)
493 handle_mesh_path_create (void *cls,
494 const struct GNUNET_PeerIdentity *peer,
495 const struct GNUNET_MessageHeader *message,
496 const struct GNUNET_TRANSPORT_ATS_Information
500 /* Find origin & self */
501 /* Search for origin in local tunnels */
502 /* Create tunnel / add path */
503 /* Retransmit to next link in chain, if any (core_notify + callback) */
508 * Core handler for mesh network traffic
511 * @param message message
512 * @param peer peer identity this notification is about
513 * @param atsi performance data
514 * @return GNUNET_OK to keep the connection open,
515 * GNUNET_SYSERR to close it (signal serious error)
518 handle_mesh_network_traffic (void *cls,
519 const struct GNUNET_PeerIdentity *peer,
520 const struct GNUNET_MessageHeader *message,
521 const struct GNUNET_TRANSPORT_ATS_Information
524 if(GNUNET_MESSAGE_TYPE_MESH_DATA_GO == ntohs(message->type)) {
525 /* Retransmit to next in path of tunnel identified by message */
527 } else { /* GNUNET_MESSAGE_TYPE_MESH_DATA_BACK */
528 /* Retransmit to previous in path of tunnel identified by message */
534 * Functions to handle messages from core
536 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
537 {&handle_mesh_path_create, GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE, 0},
538 {&handle_mesh_network_traffic, GNUNET_MESSAGE_TYPE_MESH_DATA_GO, 0},
539 {&handle_mesh_network_traffic, GNUNET_MESSAGE_TYPE_MESH_DATA_BACK, 0},
545 /******************************************************************************/
546 /********************* MESH LOCAL HANDLES **************************/
547 /******************************************************************************/
550 * Check if client has registered with the service and has not disconnected
551 * @param client the client to check
552 * @return non-NULL if client exists in the global DLL
555 client_retrieve (struct GNUNET_SERVER_Client *client) {
557 for (c = clients_head; c != clients_head; c = c->next) {
558 if(c->handle == client) return c;
564 * Handler for client disconnection
567 * @param client identification of the client; NULL
568 * for the last call when the server is destroyed
571 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
573 struct Client *c, *next;
574 struct MESH_tunnel *t;
576 /* If there are no clients registered, something is wrong... or is it?
577 * FIXME: what happens if a client connects, doesn't send a MESH_Connect
578 * and disconnects? Does the service get a disconnect notification anyway?
580 GNUNET_assert(NULL != clients_head);
581 for (c = clients_head; c != clients_head; c = next) {
582 if (c->handle == client) {
583 GNUNET_CONTAINER_DLL_remove (clients_head, clients_tail, c);
584 while (NULL != (t = c->tunnels_head)) {
585 GNUNET_CONTAINER_DLL_remove (c->tunnels_head, c->tunnels_tail, t);
586 GNUNET_CONTAINER_DLL_remove (tunnels_head, tunnels_tail, t);
587 /* TODO free paths and other tunnel dynamic structures */
590 GNUNET_free (c->messages_subscribed);
602 * Handler for new clients
605 * @param client identification of the client
606 * @param message the actual message, which includes messages the client wants
609 handle_local_new_client (void *cls,
610 struct GNUNET_SERVER_Client *client,
611 const struct GNUNET_MessageHeader *message)
614 unsigned int payload_size;
616 /* Check data sanity */
617 payload_size = message->size - sizeof(struct GNUNET_MessageHeader);
618 if (0 != payload_size % sizeof(GNUNET_MESH_ApplicationType)) {
620 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
624 /* Create new client structure */
625 c = GNUNET_malloc(sizeof(struct Client));
627 c->tunnels_head = NULL;
628 c->tunnels_tail = NULL;
629 if(payload_size != 0) {
630 c->messages_subscribed = GNUNET_malloc(payload_size);
631 memcpy(c->messages_subscribed, &message[1], payload_size);
633 c->messages_subscribed = NULL;
635 c->subscription_counter = payload_size/sizeof(GNUNET_MESH_ApplicationType);
637 /* Insert new client in DLL */
638 GNUNET_CONTAINER_DLL_insert (clients_head, clients_tail, c);
640 GNUNET_SERVER_receive_done(client, GNUNET_OK);
644 * Handler for requests of new tunnels
647 * @param client identification of the client
648 * @param message the actual message
651 handle_local_tunnel_create (void *cls,
652 struct GNUNET_SERVER_Client *client,
653 const struct GNUNET_MessageHeader *message)
655 struct GNUNET_MESH_TunnelMessage *tunnel_msg;
656 struct MESH_tunnel *t;
659 /* Sanity check for client registration */
660 if(NULL == (c = client_retrieve(client))) {
662 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
666 /* Message sanity check */
667 if(sizeof(struct GNUNET_MESH_TunnelMessage) != ntohs(message->size)) {
669 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
673 tunnel_msg = (struct GNUNET_MESH_TunnelMessage *) message;
674 /* Sanity check for tunnel numbering */
675 if(0 == (ntohl(tunnel_msg->tunnel_id) & 0x80000000)) {
677 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
680 /* Sanity check for duplicate tunnel IDs */
681 for (t = tunnels_head; t != tunnels_head; t = t->next) {
682 if(t->tid == ntohl(tunnel_msg->tunnel_id)) {
684 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
688 /* FIXME: calloc? Is NULL != 0 on any platform? */
689 t = GNUNET_malloc(sizeof(struct MESH_tunnel));
690 t->tid = ntohl(tunnel_msg->tunnel_id);
694 t->peers_head = NULL;
695 t->peers_tail = NULL;
696 t->paths_head = NULL;
697 t->paths_tail = NULL;
704 GNUNET_CONTAINER_DLL_insert(tunnels_head, tunnels_tail, t);
705 GNUNET_CONTAINER_DLL_insert(c->tunnels_head, c->tunnels_tail, t);
707 GNUNET_SERVER_receive_done(client, GNUNET_OK);
712 * Handler for requests of deleting tunnels
715 * @param client identification of the client
716 * @param message the actual message
719 handle_local_tunnel_destroy (void *cls,
720 struct GNUNET_SERVER_Client *client,
721 const struct GNUNET_MessageHeader *message)
723 struct GNUNET_MESH_TunnelMessage *tunnel_msg;
725 struct MESH_tunnel *t;
729 /* Sanity check for client registration */
730 if(NULL == (c = client_retrieve(client))) {
732 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
735 /* Message sanity check */
736 if(sizeof(struct GNUNET_MESH_TunnelMessage) != ntohs(message->size)) {
738 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
743 tunnel_msg = (struct GNUNET_MESH_TunnelMessage *) message;
744 tid = ntohl(tunnel_msg->tunnel_id);
745 for (t = tunnels_head; t != tunnels_head; t = t->next) {
752 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
756 GNUNET_CONTAINER_DLL_remove(tunnels_head, tunnels_tail, t);
757 GNUNET_CONTAINER_DLL_remove(c->tunnels_head, c->tunnels_tail, t);
759 for(pi = t->peers_head; pi != t->peers_tail; pi = t->peers_head) {
760 GNUNET_PEER_change_rc(pi->id, -1);
761 GNUNET_CONTAINER_DLL_remove(t->peers_head, t->peers_tail, pi);
766 GNUNET_SERVER_receive_done(client, GNUNET_OK);
771 * Handler for connection requests to new peers
774 * @param client identification of the client
775 * @param message the actual message (PeerControl)
778 handle_local_connect_add (void *cls,
779 struct GNUNET_SERVER_Client *client,
780 const struct GNUNET_MessageHeader *message)
782 struct GNUNET_MESH_PeerControl *peer_msg;
784 struct MESH_tunnel *t;
786 struct PeerInfo *peer_info;
789 /* Sanity check for client registration */
790 if(NULL == (c = client_retrieve(client))) {
792 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
796 peer_msg = (struct GNUNET_MESH_PeerControl *)message;
797 /* Sanity check for message size */
798 if(sizeof(struct GNUNET_MESH_PeerControl) != ntohs(peer_msg->header.size)) {
800 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
804 /* Does tunnel exist? */
805 tid = ntohl(peer_msg->tunnel_id);
806 for(t = c->tunnels_head; t != c->tunnels_head; t = t->next) {
813 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
818 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
823 /* Does client own tunnel? */
824 if(t->client->handle != client) {
826 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
830 /* Ok, add peer to tunnel */
831 peer_info = (struct PeerInfo *) GNUNET_malloc(sizeof(struct PeerInfo));
832 peer_info->id = GNUNET_PEER_intern(&peer_msg->peer);
833 peer_info->state = MESH_PEER_WAITING;
835 GNUNET_CONTAINER_DLL_insert(t->peers_head, t->peers_tail, peer_info);
836 /* TODO MESH SEARCH FOR PEER */
838 GNUNET_SERVER_receive_done(client, GNUNET_OK);
844 * Handler for disconnection requests of peers in a tunnel
847 * @param client identification of the client
848 * @param message the actual message (PeerControl)
851 handle_local_connect_del (void *cls,
852 struct GNUNET_SERVER_Client *client,
853 const struct GNUNET_MessageHeader *message)
855 /* Sanity check for client registration */
856 if(NULL == client_retrieve(client)) {
858 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
861 GNUNET_SERVER_receive_done(client, GNUNET_OK);
867 * Handler for connection requests to new peers by type
870 * @param client identification of the client
871 * @param message the actual message (ConnectPeerByType)
874 handle_local_connect_by_type (void *cls,
875 struct GNUNET_SERVER_Client *client,
876 const struct GNUNET_MessageHeader *message)
878 /* Sanity check for client registration */
879 if(NULL == client_retrieve(client)) {
881 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
884 GNUNET_SERVER_receive_done(client, GNUNET_OK);
890 * Handler for client traffic directed to one peer
893 * @param client identification of the client
894 * @param message the actual message
897 handle_local_network_traffic (void *cls,
898 struct GNUNET_SERVER_Client *client,
899 const struct GNUNET_MessageHeader *message)
901 /* Sanity check for client registration */
902 if(NULL == client_retrieve(client)) {
904 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
907 GNUNET_SERVER_receive_done(client, GNUNET_OK);
912 * Handler for client traffic directed to all peers in a tunnel
915 * @param client identification of the client
916 * @param message the actual message
919 handle_local_network_traffic_bcast (void *cls,
920 struct GNUNET_SERVER_Client *client,
921 const struct GNUNET_MessageHeader *message)
923 /* Sanity check for client registration */
924 if(NULL == client_retrieve(client)) {
926 GNUNET_SERVER_receive_done(client, GNUNET_SYSERR);
929 GNUNET_SERVER_receive_done(client, GNUNET_OK);
934 * Functions to handle messages from clients
936 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
937 {&handle_local_new_client, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT, 0},
938 {&handle_local_tunnel_create, NULL,
939 GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE, 0},
940 {&handle_local_tunnel_destroy, NULL,
941 GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY, 0},
942 {&handle_local_connect_add, NULL,
943 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_ADD, 0},
944 {&handle_local_connect_del, NULL,
945 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_DEL, 0},
946 {&handle_local_connect_by_type, NULL,
947 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE,
948 sizeof(struct GNUNET_MESH_ConnectPeerByType)},
949 {&handle_local_network_traffic, NULL,
950 GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA, 0},
951 {&handle_local_network_traffic_bcast, NULL,
952 GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST, 0},
958 * To be called on core init/fail.
960 * @param cls service closure
961 * @param server handle to the server for this service
962 * @param identity the public identity of this peer
963 * @param publicKey the public key of this peer
966 core_init (void *cls,
967 struct GNUNET_CORE_Handle *server,
968 const struct GNUNET_PeerIdentity *identity,
969 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
971 core_handle = server;
972 myid = GNUNET_PEER_intern(identity);
977 * Method called whenever a given peer connects.
980 * @param peer peer identity this notification is about
981 * @param atsi performance data for the connection
984 core_connect (void *cls,
985 const struct GNUNET_PeerIdentity *peer,
986 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
992 * Method called whenever a peer disconnects.
995 * @param peer peer identity this notification is about
998 core_disconnect (void *cls,
1000 GNUNET_PeerIdentity *peer)
1005 /******************************************************************************/
1006 /************************ MAIN FUNCTIONS ****************************/
1007 /******************************************************************************/
1010 * Process mesh requests. FIXME NON FUNCTIONAL, SKELETON
1012 * @param cls closure
1013 * @param server the initialized server
1014 * @param c configuration to use
1018 struct GNUNET_SERVER_Handle *server,
1019 const struct GNUNET_CONFIGURATION_Handle *c)
1022 GNUNET_SERVER_add_handlers (server, plugin_handlers);
1023 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
1024 core_handle = GNUNET_CORE_connect (c, /* Main configuration */
1025 32, /* queue size */
1026 NULL, /* Closure passed to MESH functions */
1027 &core_init, /* Call core_init once connected */
1028 &core_connect, /* Handle connects */
1029 &core_disconnect, /* remove peers on disconnects */
1030 NULL, /* Do we care about "status" updates? */
1031 NULL, /* Don't notify about all incoming messages */
1032 GNUNET_NO, /* For header only in notification */
1033 NULL, /* Don't notify about all outbound messages */
1034 GNUNET_NO, /* For header-only out notification */
1035 core_handlers); /* Register these handlers */
1037 if (core_handle == NULL) {
1041 dht_handle = GNUNET_DHT_connect(c, 100); /* FIXME ht len correct size? */
1042 if (dht_handle == NULL) {
1048 * The main function for the mesh service.
1050 * @param argc number of arguments from the command line
1051 * @param argv command line arguments
1052 * @return 0 ok, 1 on error
1055 main (int argc, char *const *argv)
1060 GNUNET_SERVICE_run (argc,
1063 GNUNET_SERVICE_OPTION_NONE,
1064 &run, NULL)) ? 0 : 1;