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"
51 /******************************************************************************/
52 /******************** MESH NETWORK MESSAGES **************************/
53 /******************************************************************************/
56 * Message for mesh path management
58 struct GNUNET_MESH_ManipulatePath
61 * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD|DEL]
63 * Size: sizeof(struct GNUNET_MESH_ManipulatePath) +
64 * path_length * sizeof (struct GNUNET_PeerIdentity)
66 struct GNUNET_MessageHeader header;
69 * Global id of the tunnel this path belongs to,
70 * unique in conjunction with the origin.
72 uint32_t tid GNUNET_PACKED;
75 * Information about speed requirements. If the tunnel cannot sustain the
76 * minimum bandwidth, packets are to be dropped.
78 uint32_t speed_min GNUNET_PACKED;
83 uint32_t reserved GNUNET_PACKED;
86 * path_length structs defining the *whole* path from the origin [0] to the
87 * final destination [path_length-1].
89 /* struct GNUNET_PeerIdentity peers[path_length]; */
93 * Message for mesh data traffic to all tunnel targets.
95 struct GNUNET_MESH_OriginMulticast
98 * Type: GNUNET_MESSAGE_TYPE_DATA_MULTICAST
100 struct GNUNET_MessageHeader header;
105 uint32_t tid GNUNET_PACKED;
110 struct GNUNET_PeerIdentity oid;
119 * Message for mesh data traffic to a particular destination from origin.
121 struct GNUNET_MESH_DataMessageFromOrigin
124 * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_FROM_ORIGIN
126 struct GNUNET_MessageHeader header;
131 uint32_t tid GNUNET_PACKED;
136 struct GNUNET_PeerIdentity oid;
141 struct GNUNET_PeerIdentity destination;
150 * Message for mesh data traffic from a tunnel participant to origin.
152 struct GNUNET_MESH_DataMessageToOrigin
155 * Type: GNUNET_MESSAGE_TYPE_DATA_MESSAGE_TO_ORIGIN
157 struct GNUNET_MessageHeader header;
162 uint32_t tid GNUNET_PACKED;
167 struct GNUNET_PeerIdentity oid;
170 * Sender of the message.
172 struct GNUNET_PeerIdentity sender;
180 * Message for mesh flow control
182 struct GNUNET_MESH_SpeedNotify
185 * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY
187 struct GNUNET_MessageHeader header;
192 uint32_t tid GNUNET_PACKED;
197 struct GNUNET_PeerIdentity oid;
200 * Slowest link down the path (above minimum speed requirement).
206 /******************************************************************************/
207 /************************ DATA STRUCTURES ****************************/
208 /******************************************************************************/
211 * All the states a peer participating in a tunnel can be in.
216 * Request sent, not yet answered.
221 * Peer connected and ready to accept data
226 * Peer connected previosly but not responding
228 MESH_PEER_RECONNECTING,
233 * Struct containing all information regarding a given peer
243 * Is the peer reachable? Is the peer even connected?
245 enum PeerState state;
248 * Who to send the data to --- what about multiple (alternate) paths?
250 GNUNET_PEER_Id first_hop;
253 * Max data rate to this peer
259 typedef uint32_t MESH_PathID;
261 * Information regarding a path
266 * Id of the path, in case it's needed
271 * Whether the path is serving traffic in a tunnel or is a backup
276 * List of all the peers that form the path from origin to target
278 GNUNET_PEER_Id *peers;
282 struct Client; /* FWD declaration */
284 * Struct containing all information regarding a tunnel
285 * For an intermediate node the improtant info used will be:
286 * - OID \ To identify
288 * - paths[0] | To know where to send it next
289 * - metainfo: ready, speeds, accounting
290 * For an end node more fields will be needed (client-handling)
298 struct MESH_tunnel *next;
299 struct MESH_tunnel *prev;
302 * Origin ID: Node that created the tunnel
307 * Tunnel number (unique for a given oid)
312 * Whether the tunnel is in a state to transmit data
317 * Minimal speed for this tunnel in kb/s
322 * Maximal speed for this tunnel in kb/s
327 * Last time the tunnel was used
329 struct GNUNET_TIME_Absolute timestamp;
332 * Peers in the tunnel, for future optimizations
334 struct PeerInfo *peers;
337 * Paths (used and backup)
342 * If this tunnel was created by a local client, what's its handle?
344 struct Client *client;
347 * Messages ready to transmit??? -- FIXME real queues needed
349 struct GNUNET_MessageHeader *msg_out;
352 * Messages received and not processed??? -- FIXME real queues needed
354 struct GNUNET_MessageHeader *msg_in;
359 * So, I'm an endpoint. Why am I receiveing traffic?
360 * Who is interested in this? How to communicate with them?
371 * Tunnels that belong to this client
373 struct MESH_tunnel *my_tunnels_head;
374 struct MESH_tunnel *my_tunnels_tail;
377 * If this tunnel was created by a local client, what's its handle?
379 struct GNUNET_SERVER_Client *handle;
382 * Messages that this client has declared interest in
384 uint16_t *messages_subscribed;
385 unsigned int messages_subscribed_counter;
389 /******************************************************************************/
390 /*********************** GLOBAL VARIABLES ****************************/
391 /******************************************************************************/
396 //static struct Client clients_head;
397 //static struct Client clients_tail;
402 // static struct MESH_tunnel *tunnel_participation_head;
403 // static struct MESH_tunnel *tunnel_participation_tail;
406 /******************************************************************************/
407 /******************** MESH NETWORK HANDLERS **************************/
408 /******************************************************************************/
411 * Core handler for path creation
412 * struct GNUNET_CORE_MessageHandler
415 * @param message message
416 * @param peer peer identity this notification is about
417 * @param atsi performance data
418 * @return GNUNET_OK to keep the connection open,
419 * GNUNET_SYSERR to close it (signal serious error)
423 handle_mesh_path_create (void *cls,
424 const struct GNUNET_PeerIdentity *peer,
425 const struct GNUNET_MessageHeader *message,
426 const struct GNUNET_TRANSPORT_ATS_Information
430 * EXAMPLE OF USING THE API
431 * NOT ACTUAL CODE!!!!!
437 GNUNET_CONTAINER_DLL_insert (c->my_tunnels_head,
441 while (NULL != (t = c->my_tunnels_head))
443 GNUNET_CONTAINER_DLL_remove (c->my_tunnels_head,
452 /* Find origin & self */
453 /* Search for origin in local tunnels */
454 /* Create tunnel / add path */
455 /* Retransmit to next link in chain, if any (core_notify + callback) */
460 * Core handler for mesh network traffic
463 * @param message message
464 * @param peer peer identity this notification is about
465 * @param atsi performance data
466 * @return GNUNET_OK to keep the connection open,
467 * GNUNET_SYSERR to close it (signal serious error)
470 handle_mesh_network_traffic (void *cls,
471 const struct GNUNET_PeerIdentity *peer,
472 const struct GNUNET_MessageHeader *message,
473 const struct GNUNET_TRANSPORT_ATS_Information
476 if(GNUNET_MESSAGE_TYPE_MESH_DATA_GO == ntohs(message->type)) {
477 /* Retransmit to next in path of tunnel identified by message */
479 } else { /* GNUNET_MESSAGE_TYPE_MESH_DATA_BACK */
480 /* Retransmit to previous in path of tunnel identified by message */
486 * Functions to handle messages from core
488 static struct GNUNET_CORE_MessageHandler core_handlers[] = {
489 {&handle_mesh_path_create, GNUNET_MESSAGE_TYPE_MESH_PATH_CREATE, 0},
490 {&handle_mesh_network_traffic, GNUNET_MESSAGE_TYPE_MESH_DATA_GO, 0},
491 {&handle_mesh_network_traffic, GNUNET_MESSAGE_TYPE_MESH_DATA_BACK, 0},
497 /******************************************************************************/
498 /********************* MESH LOCAL HANDLES **************************/
499 /******************************************************************************/
502 * Handler for client disconnection
505 * @param client identification of the client; NULL
506 * for the last call when the server is destroyed
509 handle_client_disconnect (void *cls, struct GNUNET_SERVER_Client *client)
511 /* Remove client from list, delete all timers and queues associated */
516 * Handler for new clients
519 * @param client identification of the client
520 * @param message the actual message, which includes messages the client wants
523 handle_local_new_client (void *cls,
524 struct GNUNET_SERVER_Client *client,
525 const struct GNUNET_MessageHeader *message)
528 c = GNUNET_malloc(sizeof(struct Client));
530 //c->messages_subscribed = message->;
536 GNUNET_CONTAINER_DLL_insert (c->my_tunnels_head,
544 * Handler for connection requests
547 * @param client identification of the client
548 * @param message the actual message
551 handle_local_connect (void *cls,
552 struct GNUNET_SERVER_Client *client,
553 const struct GNUNET_MessageHeader *message)
559 * Handler for client traffic
562 * @param client identification of the client
563 * @param message the actual message
566 handle_local_network_traffic (void *cls,
567 struct GNUNET_SERVER_Client *client,
568 const struct GNUNET_MessageHeader *message)
574 * Functions to handle messages from clients
576 static struct GNUNET_SERVER_MessageHandler plugin_handlers[] = {
577 {&handle_local_new_client, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT, 0},
578 {&handle_local_connect, NULL,
579 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_ADD, 0},
580 {&handle_local_connect, NULL,
581 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_DEL, 0},
582 {&handle_local_connect, NULL,
583 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE,
584 sizeof(struct GNUNET_MESH_ConnectPeerByType)},
585 {&handle_local_connect, NULL,
586 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_CANCEL, 0},
587 {&handle_local_network_traffic, NULL,
588 GNUNET_MESSAGE_TYPE_MESH_LOCAL_TRANSMIT_READY, 0},
589 {&handle_local_network_traffic, NULL,
590 GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA, 0}, /* FIXME needed? */
591 {&handle_local_network_traffic, NULL,
592 GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST, 0}, /* FIXME needed? */
598 * To be called on core init/fail.
600 * @param cls service closure
601 * @param server handle to the server for this service
602 * @param identity the public identity of this peer
603 * @param publicKey the public key of this peer
606 core_init (void *cls,
607 struct GNUNET_CORE_Handle *server,
608 const struct GNUNET_PeerIdentity *identity,
609 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
615 * Method called whenever a given peer connects.
618 * @param peer peer identity this notification is about
619 * @param atsi performance data for the connection
622 core_connect (void *cls,
623 const struct GNUNET_PeerIdentity *peer,
624 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
630 * Method called whenever a peer disconnects.
633 * @param peer peer identity this notification is about
636 core_disconnect (void *cls,
638 GNUNET_PeerIdentity *peer)
643 /******************************************************************************/
644 /************************ MAIN FUNCTIONS ****************************/
645 /******************************************************************************/
648 * Process mesh requests. FIXME NON FUNCTIONAL, SKELETON
651 * @param server the initialized server
652 * @param c configuration to use
656 struct GNUNET_SERVER_Handle *server,
657 const struct GNUNET_CONFIGURATION_Handle *c)
659 struct GNUNET_CORE_Handle *core;
661 GNUNET_SERVER_add_handlers (server, plugin_handlers);
662 GNUNET_SERVER_disconnect_notify (server, &handle_client_disconnect, NULL);
663 core = GNUNET_CORE_connect (c, /* Main configuration */
665 NULL, /* Closure passed to MESH functions */
666 &core_init, /* Call core_init once connected */
667 &core_connect, /* Handle connects */
668 &core_disconnect, /* remove peers on disconnects */
669 NULL, /* Do we care about "status" updates? */
670 NULL, /* Don't notify about all incoming messages */
671 GNUNET_NO, /* For header only in notification */
672 NULL, /* Don't notify about all outbound messages */
673 GNUNET_NO, /* For header-only out notification */
674 core_handlers); /* Register these handlers */
681 * The main function for the mesh service.
683 * @param argc number of arguments from the command line
684 * @param argv command line arguments
685 * @return 0 ok, 1 on error
688 main (int argc, char *const *argv)
693 GNUNET_SERVICE_run (argc,
696 GNUNET_SERVICE_OPTION_NONE,
697 &run, NULL)) ? 0 : 1;