2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
4 GNUnet is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published
6 by the Free Software Foundation; either version 3, or (at your
7 option) any later version.
8 GNUnet is distributed in the hope that it will be useful, but
9 WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 General Public License for more details.
12 You should have received a copy of the GNU General Public License
13 along with GNUnet; see the file COPYING. If not, write to the
14 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
15 Boston, MA 02111-1307, USA.
19 * @file mesh/mesh_api.c
20 * @brief mesh api: client implementation of mesh service
21 * @author Bartlomiej Polot
26 * - AUXILIARY FUNCTIONS
29 * - API CALL DEFINITIONS
34 #if 0 /* keep Emacsens' auto-indent happy */
40 #include "gnunet_common.h"
41 #include "gnunet_client_lib.h"
42 #include "gnunet_util_lib.h"
43 #include "gnunet_peer_lib.h"
44 #include "gnunet_mesh_service.h"
46 #include "mesh_protocol.h"
48 #define MESH_API_DEBUG GNUNET_YES
50 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
52 /******************************************************************************/
53 /************************ DATA STRUCTURES ****************************/
54 /******************************************************************************/
57 * Transmission queue to the service
59 struct GNUNET_MESH_TransmitHandle
65 struct GNUNET_MESH_TransmitHandle *next;
70 struct GNUNET_MESH_TransmitHandle *prev;
73 * Tunnel this message is sent over (may be NULL for control messages).
75 struct GNUNET_MESH_Tunnel *tunnel;
78 * Callback to obtain the message to transmit, or NULL if we
79 * got the message in 'data'. Notice that messages built
80 * by 'notify' need to be encapsulated with information about
83 GNUNET_CONNECTION_TransmitReadyNotify notify;
86 * Closure for 'notify'
91 * How long is this message valid. Once the timeout has been
92 * reached, the message must no longer be sent. If this
93 * is a message with a 'notify' callback set, the 'notify'
94 * function should be called with 'buf' NULL and size 0.
96 struct GNUNET_TIME_Absolute timeout;
99 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
101 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
104 * Priority of the message. The queue is sorted by priority,
105 * control messages have the maximum priority (UINT32_MAX).
110 * Target of the message, 0 for multicast. This field
111 * is only valid if 'notify' is non-NULL.
113 GNUNET_PEER_Id target;
116 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
123 * Opaque handle to the service.
125 struct GNUNET_MESH_Handle
129 * Handle to the server connection, to send messages later
131 struct GNUNET_CLIENT_Connection *client;
134 * Set of handlers used for processing incoming messages in the tunnels
136 const struct GNUNET_MESH_MessageHandler *message_handlers;
139 * Set of applications that should be claimed to be offered at this node.
140 * Note that this is just informative, the appropiate handlers must be
141 * registered independently and the mapping is up to the developer of the
142 * client application.
144 const GNUNET_MESH_ApplicationType *applications;
147 * Double linked list of the tunnels this client is connected to.
149 struct GNUNET_MESH_Tunnel *tunnels_head;
150 struct GNUNET_MESH_Tunnel *tunnels_tail;
153 * Callback for inbound tunnel creation
155 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
158 * Callback for inbound tunnel disconnection
160 GNUNET_MESH_TunnelEndHandler *cleaner;
163 * Handle to cancel pending transmissions in case of disconnection
165 struct GNUNET_CLIENT_TransmitHandle *th;
168 * Closure for all the handlers given by the client
173 * Messages to send to the service
175 struct GNUNET_MESH_TransmitHandle *th_head;
176 struct GNUNET_MESH_TransmitHandle *th_tail;
179 * tid of the next tunnel to create (to avoid reusing IDs often)
181 MESH_TunnelNumber next_tid;
182 unsigned int n_handlers;
183 unsigned int n_applications;
184 unsigned int max_queue_size;
187 * Have we started the task to receive messages from the service
188 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
193 * Number of packets queued
195 unsigned int npackets;
198 * Configuration given by the client, in case of reconnection
200 const struct GNUNET_CONFIGURATION_Handle *cfg;
203 * Time to the next reconnect in case one reconnect fails
205 struct GNUNET_TIME_Relative reconnect_time;
210 * Description of a peer
212 struct GNUNET_MESH_Peer
215 * ID of the peer in short form
220 * Tunnel this peer belongs to
222 struct GNUNET_MESH_Tunnel *t;
225 * Flag indicating whether service has informed about its connection
233 * Opaque handle to a tunnel.
235 struct GNUNET_MESH_Tunnel
241 struct GNUNET_MESH_Tunnel *next;
242 struct GNUNET_MESH_Tunnel *prev;
245 * Callback to execute when peers connect to the tunnel
247 GNUNET_MESH_PeerConnectHandler connect_handler;
250 * Callback to execute when peers disconnect from the tunnel
252 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
255 * Closure for the connect/disconnect handlers
260 * Handle to the mesh this tunnel belongs to
262 struct GNUNET_MESH_Handle *mesh;
265 * Local ID of the tunnel
267 MESH_TunnelNumber tid;
270 * Owner of the tunnel. 0 if the tunnel is the local client.
272 GNUNET_PEER_Id owner;
275 * All peers added to the tunnel
277 struct GNUNET_MESH_Peer **peers;
280 * List of application types that have been requested for this tunnel
282 GNUNET_MESH_ApplicationType *apps;
285 * Any data the caller wants to put in here
290 * Number of peers added to the tunnel
295 * Number of packets queued in this tunnel
297 unsigned int npackets;
300 * Number of applications requested this tunnel
307 /******************************************************************************/
308 /*********************** AUXILIARY FUNCTIONS *************************/
309 /******************************************************************************/
312 * Get the tunnel handler for the tunnel specified by id from the given handle
313 * @param h Mesh handle
314 * @param tid ID of the wanted tunnel
315 * @return handle to the required tunnel or NULL if not found
317 static struct GNUNET_MESH_Tunnel *
318 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
320 struct GNUNET_MESH_Tunnel *t;
334 * Create a new tunnel and insert it in the tunnel list of the mesh handle
335 * @param h Mesh handle
336 * @param tid desired tid of the tunnel, 0 to assign one automatically
337 * @return handle to the created tunnel
339 static struct GNUNET_MESH_Tunnel *
340 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
342 struct GNUNET_MESH_Tunnel *t;
344 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
345 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
349 t->tid = h->next_tid;
350 while (NULL != retrieve_tunnel (h, h->next_tid))
353 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
354 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
366 * Destroy the specified tunnel.
367 * - Destroys all peers, calling the disconnect callback on each if needed
368 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
369 * - Calls cleaner if tunnel was inbound
370 * - Frees all memory used
372 * @param t Pointer to the tunnel.
373 * @param call_handler Whether to call the cleaner handler.
375 * @return Handle to the required tunnel or NULL if not found.
378 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
380 struct GNUNET_MESH_Handle *h;
381 struct GNUNET_PeerIdentity pi;
382 struct GNUNET_MESH_TransmitHandle *th;
383 struct GNUNET_MESH_TransmitHandle *aux;
398 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
399 if (NULL == h->th_head && NULL != h->th)
401 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
404 if (NULL != th->notify)
405 th->notify (th->notify_cls, 0, NULL);
406 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
407 GNUNET_SCHEDULER_cancel (th->timeout_task);
416 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
417 for (i = 0; i < t->npeers; i++)
419 if (NULL != t->disconnect_handler && t->peers[i]->connected)
421 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
422 t->disconnect_handler (t->cls, &pi);
424 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
425 GNUNET_free (t->peers[i]);
428 GNUNET_free (t->peers);
429 if (NULL != h->cleaner && 0 != t->owner && GNUNET_YES == call_cleaner)
430 h->cleaner (h->cls, t, t->ctx);
432 GNUNET_PEER_change_rc (t->owner, -1);
433 if (0 != t->napps && t->apps)
434 GNUNET_free (t->apps);
441 * Get the peer descriptor for the peer with id from the given tunnel
442 * @param t Tunnel handle
443 * @param id Short form ID of the wanted peer
444 * @return handle to the requested peer or NULL if not found
446 static struct GNUNET_MESH_Peer *
447 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
451 for (i = 0; i < t->npeers; i++)
452 if (t->peers[i]->id == id)
459 * Add a peer into a tunnel
460 * @param t Tunnel handle
461 * @param pi Full ID of the new peer
462 * @return handle to the newly created peer
464 static struct GNUNET_MESH_Peer *
465 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
466 const struct GNUNET_PeerIdentity *pi)
468 struct GNUNET_MESH_Peer *p;
476 id = GNUNET_PEER_intern (pi);
478 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
481 GNUNET_array_append (t->peers, t->npeers, p);
487 * Remove a peer from a tunnel
488 * @param p Peer handle
491 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
495 for (i = 0; i < p->t->npeers; i++)
497 if (p->t->peers[i] == p)
500 if (i == p->t->npeers)
505 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
506 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
511 * Notify client that the transmission has timed out
513 * @param tc task context
516 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
518 struct GNUNET_MESH_TransmitHandle *th = cls;
519 struct GNUNET_MESH_Handle *mesh;
521 mesh = th->tunnel->mesh;
522 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
523 if (th->notify != NULL)
524 th->notify (th->notify_cls, 0, NULL);
526 if ((NULL == mesh->th_head) && (NULL != mesh->th))
528 /* queue empty, no point in asking for transmission */
529 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
536 * Add a transmit handle to the transmission queue by priority and set the
539 * @param h mesh handle with the queue head and tail
540 * @param th handle to the packet to be transmitted
543 add_to_queue (struct GNUNET_MESH_Handle *h,
544 struct GNUNET_MESH_TransmitHandle *th)
546 struct GNUNET_MESH_TransmitHandle *p;
549 while ((NULL != p) && (th->priority <= p->priority))
555 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
556 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
559 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
560 (th->timeout), &timeout_transmission, th);
565 * Auxiliary function to send an already constructed packet to the service.
566 * Takes care of creating a new queue element, copying the message and
567 * calling the tmt_rdy function if necessary.
568 * @param h mesh handle
569 * @param msg message to transmit
572 send_packet (struct GNUNET_MESH_Handle *h,
573 const struct GNUNET_MessageHeader *msg);
577 * Reconnect callback: tries to reconnect again after a failer previous
579 * @param cls closure (mesh handle)
580 * @param tc task context
583 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
587 * Send a connect packet to the service with the applications and types
588 * requested by the user.
590 * @param h The mesh handle.
594 send_connect (struct GNUNET_MESH_Handle *h)
598 size = sizeof (struct GNUNET_MESH_ClientConnect);
599 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
600 size += h->n_handlers * sizeof (uint16_t);
603 struct GNUNET_MESH_ClientConnect *msg;
604 GNUNET_MESH_ApplicationType *apps;
609 /* build connection packet */
610 msg = (struct GNUNET_MESH_ClientConnect *) buf;
611 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
612 msg->header.size = htons (size);
613 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
614 for (napps = 0; napps < h->n_applications; napps++)
616 apps[napps] = htonl (h->applications[napps]);
617 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: app %u\n", h->applications[napps]);
619 types = (uint16_t *) & apps[napps];
620 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
621 types[ntypes] = htons (h->message_handlers[ntypes].type);
622 msg->applications = htons (napps);
623 msg->types = htons (ntypes);
625 LOG (GNUNET_ERROR_TYPE_DEBUG,
626 "mesh: Sending %lu bytes long message %d types and %d apps\n",
627 ntohs (msg->header.size), ntypes, napps);
629 send_packet (h, &msg->header);
635 * Reconnect to the service, retransmit all infomation to try to restore the
638 * @param h handle to the mesh
640 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
643 reconnect (struct GNUNET_MESH_Handle *h)
645 struct GNUNET_MESH_Tunnel *t;
649 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
650 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: ******* RECONNECT *******\n");
651 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
653 h->in_receive = GNUNET_NO;
657 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
659 if (NULL != h->client)
661 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
665 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
666 if (h->client == NULL)
668 GNUNET_SCHEDULER_add_delayed (h->reconnect_time, &reconnect_cbk, h);
670 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
671 GNUNET_TIME_relative_multiply
672 (h->reconnect_time, 2));
673 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Next retry in %sms\n",
674 GNUNET_TIME_relative_to_string (h->reconnect_time));
680 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
683 /* Rebuild all tunnels */
684 for (t = h->tunnels_head; NULL != t; t = t->next)
686 struct GNUNET_MESH_TunnelMessage tmsg;
687 struct GNUNET_MESH_PeerControl pmsg;
689 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
691 /* Tunnel was created by service (incoming tunnel) */
692 /* TODO: Notify service of missing tunnel, to request
693 * creator to recreate path (find a path to him via DHT?)
697 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
698 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
699 tmsg.tunnel_id = htonl (t->tid);
700 send_packet (h, &tmsg.header);
702 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
703 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
704 pmsg.tunnel_id = htonl (t->tid);
706 /* Reconnect all peers */
707 for (i = 0; i < t->npeers; i++)
709 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
710 if (NULL != t->disconnect_handler && t->peers[i]->connected)
711 t->disconnect_handler (t->cls, &pmsg.peer);
712 /* If the tunnel was "by type", dont connect individual peers */
714 send_packet (t->mesh, &pmsg.header);
716 /* Reconnect all types, if any */
717 for (i = 0; i < t->napps; i++)
719 struct GNUNET_MESH_ConnectPeerByType msg;
721 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
722 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
723 msg.tunnel_id = htonl (t->tid);
724 msg.type = htonl (t->apps[i]);
725 send_packet (t->mesh, &msg.header);
732 * Reconnect callback: tries to reconnect again after a failer previous
734 * @param cls closure (mesh handle)
735 * @param tc task context
738 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
740 struct GNUNET_MESH_Handle *h = cls;
742 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
748 /******************************************************************************/
749 /*********************** RECEIVE HANDLERS ****************************/
750 /******************************************************************************/
753 * Process the new tunnel notification and add it to the tunnels in the handle
755 * @param h The mesh handle
756 * @param msg A message with the details of the new incoming tunnel
759 process_tunnel_created (struct GNUNET_MESH_Handle *h,
760 const struct GNUNET_MESH_TunnelNotification *msg)
762 struct GNUNET_MESH_Tunnel *t;
763 MESH_TunnelNumber tid;
765 tid = ntohl (msg->tunnel_id);
766 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
771 t = create_tunnel (h, tid);
772 t->owner = GNUNET_PEER_intern (&msg->peer);
774 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
775 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
777 t->peers[0]->connected = 1;
778 t->peers[0]->id = t->owner;
779 GNUNET_PEER_change_rc (t->owner, 1);
782 if (NULL != h->new_tunnel)
784 struct GNUNET_ATS_Information atsi;
788 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
791 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: new incoming tunnel %X\n",
799 * Process the tunnel destroy notification and free associated resources
801 * @param h The mesh handle
802 * @param msg A message with the details of the tunnel being destroyed
805 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
806 const struct GNUNET_MESH_TunnelMessage *msg)
808 struct GNUNET_MESH_Tunnel *t;
809 MESH_TunnelNumber tid;
811 tid = ntohl (msg->tunnel_id);
812 t = retrieve_tunnel (h, tid);
823 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: tunnel %u destroyed\n", t->tid);
825 destroy_tunnel (t, GNUNET_YES);
831 * Process the new peer event and notify the upper level of it
833 * @param h The mesh handle
834 * @param msg A message with the details of the peer event
837 process_peer_event (struct GNUNET_MESH_Handle *h,
838 const struct GNUNET_MESH_PeerControl *msg)
840 struct GNUNET_MESH_Tunnel *t;
841 struct GNUNET_MESH_Peer *p;
842 struct GNUNET_ATS_Information atsi;
846 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
847 size = ntohs (msg->header.size);
848 if (size != sizeof (struct GNUNET_MESH_PeerControl))
853 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
859 id = GNUNET_PEER_search (&msg->peer);
860 if ((p = retrieve_peer (t, id)) == NULL)
861 p = add_peer_to_tunnel (t, &msg->peer);
862 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
864 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
865 if (NULL != t->connect_handler)
869 t->connect_handler (t->cls, &msg->peer, &atsi);
875 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
876 if (NULL != t->disconnect_handler && p->connected)
878 t->disconnect_handler (t->cls, &msg->peer);
880 remove_peer_from_tunnel (p);
883 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
888 * Process the incoming data packets
890 * @param h The mesh handle
891 * @param message A message encapsulating the data
894 process_incoming_data (struct GNUNET_MESH_Handle *h,
895 const struct GNUNET_MessageHeader *message)
897 const struct GNUNET_MessageHeader *payload;
898 const struct GNUNET_MESH_MessageHandler *handler;
899 const struct GNUNET_PeerIdentity *peer;
900 struct GNUNET_MESH_Unicast *ucast;
901 struct GNUNET_MESH_Multicast *mcast;
902 struct GNUNET_MESH_ToOrigin *to_orig;
903 struct GNUNET_MESH_Tunnel *t;
907 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Got a data message!\n");
908 type = ntohs (message->type);
911 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
912 ucast = (struct GNUNET_MESH_Unicast *) message;
914 t = retrieve_tunnel (h, ntohl (ucast->tid));
915 payload = (struct GNUNET_MessageHeader *) &ucast[1];
917 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: ucast on tunnel %s [%x]\n",
918 GNUNET_i2s (peer), ntohl (ucast->tid));
920 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
921 mcast = (struct GNUNET_MESH_Multicast *) message;
922 t = retrieve_tunnel (h, ntohl (mcast->tid));
923 payload = (struct GNUNET_MessageHeader *) &mcast[1];
925 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: mcast on tunnel %s [%x]\n",
926 GNUNET_i2s (peer), ntohl (mcast->tid));
928 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
929 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
930 t = retrieve_tunnel (h, ntohl (to_orig->tid));
931 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
932 peer = &to_orig->sender;
933 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: torig on tunnel %s [%x]\n",
934 GNUNET_i2s (peer), ntohl (to_orig->tid));
945 type = ntohs (payload->type);
946 for (i = 0; i < h->n_handlers; i++)
948 handler = &h->message_handlers[i];
949 if (handler->type == type)
951 struct GNUNET_ATS_Information atsi;
956 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
958 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
959 GNUNET_MESH_disconnect (h);
965 LOG (GNUNET_ERROR_TYPE_DEBUG,
966 "MESH: callback completed successfully\n");
976 * Function to process all messages received from the service
979 * @param msg message received, NULL on timeout or fatal error
982 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
984 struct GNUNET_MESH_Handle *h = cls;
991 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message type %hu from MESH\n",
993 switch (ntohs (msg->type))
995 /* Notify of a new incoming tunnel */
996 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
997 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
999 /* Notify of a tunnel disconnection */
1000 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1001 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1003 /* Notify of a new peer or a peer disconnect in the tunnel */
1004 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1005 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1006 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1008 /* Notify of a new data packet in the tunnel */
1009 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1010 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1011 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1012 process_incoming_data (h, msg);
1014 /* We shouldn't get any other packages, log and ignore */
1016 LOG (GNUNET_ERROR_TYPE_WARNING,
1017 "MESH: unsolicited message form service (type %d)\n",
1020 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
1021 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1022 GNUNET_TIME_UNIT_FOREVER_REL);
1026 /******************************************************************************/
1027 /************************ SEND FUNCTIONS ****************************/
1028 /******************************************************************************/
1031 * Function called to send a message to the service.
1032 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1035 * @param cls closure, the mesh handle
1036 * @param size number of bytes available in buf
1037 * @param buf where the callee should write the connect message
1038 * @return number of bytes written to buf
1041 send_callback (void *cls, size_t size, void *buf)
1043 struct GNUNET_MESH_Handle *h = cls;
1044 struct GNUNET_MESH_TransmitHandle *th;
1049 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
1051 if ((0 == size) || (NULL == buf))
1057 while ((NULL != (th = h->th_head)) && (size >= th->size))
1059 if (NULL != th->notify)
1061 if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1063 /* traffic to origin */
1064 struct GNUNET_MESH_ToOrigin to;
1065 struct GNUNET_MessageHeader *mh;
1067 GNUNET_assert (size >= th->size);
1068 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1069 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1070 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: to origin, type %u\n",
1074 psize += sizeof (to);
1075 GNUNET_assert (size >= psize);
1076 to.header.size = htons (psize);
1077 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1078 to.tid = htonl (th->tunnel->tid);
1079 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1080 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1081 memcpy (cbuf, &to, sizeof (to));
1084 else if (th->target == 0)
1087 struct GNUNET_MESH_Multicast mc;
1088 struct GNUNET_MessageHeader *mh;
1090 GNUNET_assert (size >= th->size);
1091 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1092 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1093 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: multicast, type %u\n",
1097 psize += sizeof (mc);
1098 GNUNET_assert (size >= psize);
1099 mc.header.size = htons (psize);
1100 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1101 mc.tid = htonl (th->tunnel->tid);
1104 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1105 memcpy (cbuf, &mc, sizeof (mc));
1111 struct GNUNET_MESH_Unicast uc;
1112 struct GNUNET_MessageHeader *mh;
1114 GNUNET_assert (size >= th->size);
1115 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1116 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1117 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: unicast, type %u\n",
1121 psize += sizeof (uc);
1122 GNUNET_assert (size >= psize);
1123 uc.header.size = htons (psize);
1124 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1125 uc.tid = htonl (th->tunnel->tid);
1126 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1127 GNUNET_PEER_resolve (th->target, &uc.destination);
1128 memcpy (cbuf, &uc, sizeof (uc));
1134 memcpy (cbuf, &th[1], th->size);
1137 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1138 GNUNET_SCHEDULER_cancel (th->timeout_task);
1139 if (NULL != th->tunnel)
1141 th->tunnel->mesh->npackets--;
1142 th->tunnel->npackets--;
1144 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1150 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
1151 if (NULL != (th = h->th_head))
1153 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
1155 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1156 GNUNET_TIME_UNIT_FOREVER_REL,
1157 GNUNET_YES, &send_callback, h);
1159 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1160 if (GNUNET_NO == h->in_receive)
1162 h->in_receive = GNUNET_YES;
1163 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1164 GNUNET_TIME_UNIT_FOREVER_REL);
1171 * Auxiliary function to send an already constructed packet to the service.
1172 * Takes care of creating a new queue element, copying the message and
1173 * calling the tmt_rdy function if necessary.
1174 * @param h mesh handle
1175 * @param msg message to transmit
1178 send_packet (struct GNUNET_MESH_Handle *h,
1179 const struct GNUNET_MessageHeader *msg)
1181 struct GNUNET_MESH_TransmitHandle *th;
1184 msize = ntohs (msg->size);
1185 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1186 th->priority = UINT32_MAX;
1187 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1189 memcpy (&th[1], msg, msize);
1190 add_to_queue (h, th);
1194 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1195 GNUNET_TIME_UNIT_FOREVER_REL,
1196 GNUNET_YES, &send_callback, h);
1200 /******************************************************************************/
1201 /********************** API CALL DEFINITIONS *************************/
1202 /******************************************************************************/
1205 * Connect to the mesh service.
1207 * @param cfg configuration to use
1208 * @param queue_size size of the data message queue, shared among all tunnels
1209 * (each tunnel is guaranteed to accept at least one message,
1210 * no matter what is the status of other tunnels)
1211 * @param cls closure for the various callbacks that follow
1212 * (including handlers in the handlers array)
1213 * @param new_tunnel function called when an *inbound* tunnel is created
1214 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1215 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1216 * is called on the tunnel
1217 * @param handlers callbacks for messages we care about, NULL-terminated
1218 * note that the mesh is allowed to drop notifications about
1219 * inbound messages if the client does not process them fast
1220 * enough (for this notification type, a bounded queue is used)
1221 * @param stypes list of the applications that this client claims to provide
1222 * @return handle to the mesh service NULL on error
1223 * (in this case, init is never called)
1225 struct GNUNET_MESH_Handle *
1226 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1227 unsigned int queue_size, void *cls,
1228 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1229 GNUNET_MESH_TunnelEndHandler cleaner,
1230 const struct GNUNET_MESH_MessageHandler *handlers,
1231 const GNUNET_MESH_ApplicationType *stypes)
1233 struct GNUNET_MESH_Handle *h;
1235 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1236 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1238 h->max_queue_size = queue_size;
1239 h->new_tunnel = new_tunnel;
1240 h->cleaner = cleaner;
1241 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1242 if (h->client == NULL)
1250 h->applications = stypes;
1251 h->message_handlers = handlers;
1252 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1253 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1255 /* count handlers and apps, calculate size */
1256 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1257 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1259 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1265 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1266 * disconnect callbacks will be called on any still connected peers, notifying
1267 * about their disconnection. The registered inbound tunnel cleaner will be
1268 * called should any inbound tunnels still exist.
1270 * @param handle connection to mesh to disconnect
1273 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1275 struct GNUNET_MESH_Tunnel *t;
1276 struct GNUNET_MESH_Tunnel *aux;
1277 struct GNUNET_MESH_TransmitHandle *th;
1279 t = handle->tunnels_head;
1283 destroy_tunnel (t, GNUNET_YES);
1286 while ( (th = handle->th_head) != NULL)
1288 struct GNUNET_MessageHeader *msg;
1290 /* Make sure it is a connect packet (everything else should have been
1291 * already canceled).
1293 GNUNET_break (UINT32_MAX == th->priority);
1294 GNUNET_break (NULL == th->notify);
1295 msg = (struct GNUNET_MessageHeader *) &th[1];
1296 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT != ntohs(msg->type))
1300 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: expected %u, got %u\n",
1301 GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT, ntohs(msg->type));
1305 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1309 if (NULL != handle->th)
1311 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1313 if (NULL != handle->client)
1315 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1317 GNUNET_free (handle);
1322 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1323 * and to broadcast).
1325 * @param h mesh handle
1326 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1327 * @param connect_handler function to call when peers are actually connected
1328 * @param disconnect_handler function to call when peers are disconnected
1329 * @param handler_cls closure for connect/disconnect handlers
1331 struct GNUNET_MESH_Tunnel *
1332 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1333 GNUNET_MESH_PeerConnectHandler connect_handler,
1334 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1337 struct GNUNET_MESH_Tunnel *t;
1338 struct GNUNET_MESH_TunnelMessage msg;
1340 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1341 t = create_tunnel (h, 0);
1342 t->connect_handler = connect_handler;
1343 t->disconnect_handler = disconnect_handler;
1344 t->cls = handler_cls;
1345 t->ctx = tunnel_ctx;
1346 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1347 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1348 msg.tunnel_id = htonl (t->tid);
1349 send_packet (h, &msg.header);
1355 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1358 * @param tunnel tunnel handle
1361 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1363 struct GNUNET_MESH_Handle *h;
1364 struct GNUNET_MESH_TunnelMessage msg;
1366 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1369 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1370 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1371 msg.tunnel_id = htonl (tunnel->tid);
1372 destroy_tunnel (tunnel, GNUNET_NO);
1373 send_packet (h, &msg.header);
1378 * Request that a peer should be added to the tunnel. The existing
1379 * connect handler will be called ONCE with either success or failure.
1380 * This function should NOT be called again with the same peer before the
1381 * connect handler is called.
1383 * @param tunnel handle to existing tunnel
1384 * @param peer peer to add
1387 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1388 const struct GNUNET_PeerIdentity *peer)
1390 struct GNUNET_MESH_PeerControl msg;
1391 GNUNET_PEER_Id peer_id;
1394 peer_id = GNUNET_PEER_intern (peer);
1395 for (i = 0; i < tunnel->npeers; i++)
1397 if (tunnel->peers[i]->id == peer_id)
1399 /* Peer already exists in tunnel */
1400 GNUNET_PEER_change_rc (peer_id, -1);
1405 if (NULL == add_peer_to_tunnel (tunnel, peer))
1408 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1409 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1410 msg.tunnel_id = htonl (tunnel->tid);
1412 send_packet (tunnel->mesh, &msg.header);
1419 * Request that a peer should be removed from the tunnel. The existing
1420 * disconnect handler will be called ONCE if we were connected.
1422 * @param tunnel handle to existing tunnel
1423 * @param peer peer to remove
1426 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1427 const struct GNUNET_PeerIdentity *peer)
1429 struct GNUNET_MESH_PeerControl msg;
1430 GNUNET_PEER_Id peer_id;
1433 peer_id = GNUNET_PEER_search (peer);
1439 for (i = 0; i < tunnel->npeers; i++)
1440 if (tunnel->peers[i]->id == peer_id)
1442 if (i == tunnel->npeers)
1447 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1448 tunnel->disconnect_handler (tunnel->cls, peer);
1449 GNUNET_PEER_change_rc (peer_id, -1);
1450 GNUNET_free (tunnel->peers[i]);
1451 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1452 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1454 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1455 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1456 msg.tunnel_id = htonl (tunnel->tid);
1457 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1458 send_packet (tunnel->mesh, &msg.header);
1463 * Request that the mesh should try to connect to a peer supporting the given
1466 * @param tunnel handle to existing tunnel
1467 * @param app_type application type that must be supported by the peer (MESH
1468 * should discover peer in proximity handling this type)
1471 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1472 GNUNET_MESH_ApplicationType app_type)
1474 struct GNUNET_MESH_ConnectPeerByType msg;
1476 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1478 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1479 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1480 msg.tunnel_id = htonl (tunnel->tid);
1481 msg.type = htonl (app_type);
1482 send_packet (tunnel->mesh, &msg.header);
1487 * Ask the mesh to call "notify" once it is ready to transmit the
1488 * given number of bytes to the specified "target". If we are not yet
1489 * connected to the specified peer, a call to this function will cause
1490 * us to try to establish a connection.
1492 * @param tunnel tunnel to use for transmission
1493 * @param cork is corking allowed for this transmission?
1494 * @param priority how important is the message?
1495 * @param maxdelay how long can the message wait?
1496 * @param target destination for the message,
1497 * NULL for multicast to all tunnel targets
1498 * @param notify_size how many bytes of buffer space does notify want?
1499 * @param notify function to call when buffer space is available;
1500 * will be called with NULL on timeout or if the overall queue
1501 * for this peer is larger than queue_size and this is currently
1502 * the message with the lowest priority
1503 * @param notify_cls closure for notify
1504 * @return non-NULL if the notify callback was queued,
1505 * NULL if we can not even queue the request (insufficient
1506 * memory); if NULL is returned, "notify" will NOT be called.
1508 struct GNUNET_MESH_TransmitHandle *
1509 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1511 struct GNUNET_TIME_Relative maxdelay,
1512 const struct GNUNET_PeerIdentity *target,
1514 GNUNET_CONNECTION_TransmitReadyNotify notify,
1517 struct GNUNET_MESH_TransmitHandle *th;
1518 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1519 uint32_t least_priority;
1522 GNUNET_assert (NULL != tunnel);
1524 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1525 "mesh: mesh notify transmit ready called\n");
1527 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: target %s\n",
1528 GNUNET_i2s (target));
1530 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: target multicast\n");
1532 GNUNET_assert (NULL != notify);
1533 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1534 tunnel->npackets > 0)
1539 th = tunnel->mesh->th_tail;
1540 least_priority = priority;
1541 least_priority_th = NULL;
1544 if (th->priority < least_priority && th->tunnel->npackets > 1)
1546 least_priority_th = th;
1547 least_priority = th->priority;
1551 if (NULL == least_priority_th)
1553 /* Can't be a control message */
1554 GNUNET_assert (NULL != least_priority_th->notify);
1555 least_priority_th->notify (notify_cls, 0, NULL);
1556 least_priority_th->tunnel->npackets--;
1557 tunnel->mesh->npackets--;
1558 GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1560 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1561 GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1562 GNUNET_free (least_priority_th);
1565 tunnel->mesh->npackets++;
1566 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1567 th->tunnel = tunnel;
1568 th->priority = priority;
1569 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1570 th->target = GNUNET_PEER_intern (target);
1571 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1572 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1573 else if (NULL == target)
1574 overhead = sizeof (struct GNUNET_MESH_Multicast);
1576 overhead = sizeof (struct GNUNET_MESH_Unicast);
1577 th->size = notify_size + overhead;
1578 th->notify = notify;
1579 th->notify_cls = notify_cls;
1580 add_to_queue (tunnel->mesh, th);
1581 if (NULL != tunnel->mesh->th)
1584 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1585 GNUNET_TIME_UNIT_FOREVER_REL,
1586 GNUNET_YES, &send_callback,
1593 * Cancel the specified transmission-ready notification.
1595 * @param th handle that was returned by "notify_transmit_ready".
1598 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1600 struct GNUNET_MESH_Handle *mesh;
1602 mesh = th->tunnel->mesh;
1603 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1604 GNUNET_SCHEDULER_cancel (th->timeout_task);
1605 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1607 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1609 /* queue empty, no point in asking for transmission */
1610 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1617 * Transition API for tunnel ctx management
1620 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1626 * Transition API for tunnel ctx management
1629 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)
1635 #if 0 /* keep Emacsens' auto-indent happy */