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
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.
374 * @return Handle to the required tunnel or NULL if not found.
377 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
379 struct GNUNET_MESH_Handle *h;
380 struct GNUNET_PeerIdentity pi;
381 struct GNUNET_MESH_TransmitHandle *th;
382 struct GNUNET_MESH_TransmitHandle *aux;
397 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
398 if (NULL == h->th_head && NULL != h->th)
400 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
403 if (NULL != th->notify)
404 th->notify (th->notify_cls, 0, NULL);
405 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
406 GNUNET_SCHEDULER_cancel (th->timeout_task);
415 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
416 for (i = 0; i < t->npeers; i++)
418 if (NULL != t->disconnect_handler && t->peers[i]->connected)
420 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
421 t->disconnect_handler (t->cls, &pi);
423 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
424 GNUNET_free (t->peers[i]);
427 GNUNET_free (t->peers);
428 if (NULL != h->cleaner && 0 != t->owner)
429 h->cleaner (h->cls, t, t->ctx);
431 GNUNET_PEER_change_rc (t->owner, -1);
432 if (0 != t->napps && t->apps)
433 GNUNET_free (t->apps);
440 * Get the peer descriptor for the peer with id from the given tunnel
441 * @param t Tunnel handle
442 * @param id Short form ID of the wanted peer
443 * @return handle to the requested peer or NULL if not found
445 static struct GNUNET_MESH_Peer *
446 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
450 for (i = 0; i < t->npeers; i++)
451 if (t->peers[i]->id == id)
458 * Add a peer into a tunnel
459 * @param t Tunnel handle
460 * @param pi Full ID of the new peer
461 * @return handle to the newly created peer
463 static struct GNUNET_MESH_Peer *
464 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
465 const struct GNUNET_PeerIdentity *pi)
467 struct GNUNET_MESH_Peer *p;
475 id = GNUNET_PEER_intern (pi);
477 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
480 GNUNET_array_append (t->peers, t->npeers, p);
486 * Remove a peer from a tunnel
487 * @param p Peer handle
490 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
494 for (i = 0; i < p->t->npeers; i++)
496 if (p->t->peers[i] == p)
499 if (i == p->t->npeers)
504 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
505 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
510 * Notify client that the transmission has timed out
512 * @param tc task context
515 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
517 struct GNUNET_MESH_TransmitHandle *th = cls;
518 struct GNUNET_MESH_Handle *mesh;
520 mesh = th->tunnel->mesh;
521 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
522 if (th->notify != NULL)
523 th->notify (th->notify_cls, 0, NULL);
525 if ((NULL == mesh->th_head) && (NULL != mesh->th))
527 /* queue empty, no point in asking for transmission */
528 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
535 * Add a transmit handle to the transmission queue by priority and set the
538 * @param h mesh handle with the queue head and tail
539 * @param th handle to the packet to be transmitted
542 add_to_queue (struct GNUNET_MESH_Handle *h,
543 struct GNUNET_MESH_TransmitHandle *th)
545 struct GNUNET_MESH_TransmitHandle *p;
548 while ((NULL != p) && (th->priority <= p->priority))
554 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
555 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
558 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
559 (th->timeout), &timeout_transmission, th);
564 * Auxiliary function to send an already constructed packet to the service.
565 * Takes care of creating a new queue element, copying the message and
566 * calling the tmt_rdy function if necessary.
567 * @param h mesh handle
568 * @param msg message to transmit
571 send_packet (struct GNUNET_MESH_Handle *h,
572 const struct GNUNET_MessageHeader *msg);
576 * Reconnect callback: tries to reconnect again after a failer previous
578 * @param cls closure (mesh handle)
579 * @param tc task context
582 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
586 * Send a connect packet to the service with the applications and types
587 * requested by the user.
589 * @param h The mesh handle.
593 send_connect (struct GNUNET_MESH_Handle *h)
597 size = sizeof (struct GNUNET_MESH_ClientConnect);
598 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
599 size += h->n_handlers * sizeof (uint16_t);
602 struct GNUNET_MESH_ClientConnect *msg;
603 GNUNET_MESH_ApplicationType *apps;
608 /* build connection packet */
609 msg = (struct GNUNET_MESH_ClientConnect *) buf;
610 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
611 msg->header.size = htons (size);
612 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
613 for (napps = 0; napps < h->n_applications; napps++)
615 apps[napps] = htonl (h->applications[napps]);
616 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: app %u\n", h->applications[napps]);
618 types = (uint16_t *) & apps[napps];
619 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
620 types[ntypes] = htons (h->message_handlers[ntypes].type);
621 msg->applications = htons (napps);
622 msg->types = htons (ntypes);
624 LOG (GNUNET_ERROR_TYPE_DEBUG,
625 "mesh: Sending %lu bytes long message %d types and %d apps\n",
626 ntohs (msg->header.size), ntypes, napps);
628 send_packet (h, &msg->header);
634 * Reconnect to the service, retransmit all infomation to try to restore the
637 * @param h handle to the mesh
639 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
642 reconnect (struct GNUNET_MESH_Handle *h)
644 struct GNUNET_MESH_Tunnel *t;
648 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
649 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: ******* RECONNECT *******\n");
650 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
652 h->in_receive = GNUNET_NO;
656 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
658 if (NULL != h->client)
660 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
664 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
665 if (h->client == NULL)
667 GNUNET_SCHEDULER_add_delayed (h->reconnect_time, &reconnect_cbk, h);
669 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_HOURS,
670 GNUNET_TIME_relative_multiply
671 (h->reconnect_time, 2));
672 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Next retry in %sms\n",
673 GNUNET_TIME_relative_to_string (h->reconnect_time));
679 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
682 /* Rebuild all tunnels */
683 for (t = h->tunnels_head; NULL != t; t = t->next)
685 struct GNUNET_MESH_TunnelMessage tmsg;
686 struct GNUNET_MESH_PeerControl pmsg;
688 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
690 /* Tunnel was created by service (incoming tunnel) */
691 /* TODO: Notify service of missing tunnel, to request
692 * creator to recreate path (find a path to him via DHT?)
696 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
697 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
698 tmsg.tunnel_id = htonl (t->tid);
699 send_packet (h, &tmsg.header);
701 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
702 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
703 pmsg.tunnel_id = htonl (t->tid);
705 /* Reconnect all peers */
706 for (i = 0; i < t->npeers; i++)
708 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
709 if (NULL != t->disconnect_handler && t->peers[i]->connected)
710 t->disconnect_handler (t->cls, &pmsg.peer);
711 /* If the tunnel was "by type", dont connect individual peers */
713 send_packet (t->mesh, &pmsg.header);
715 /* Reconnect all types, if any */
716 for (i = 0; i < t->napps; i++)
718 struct GNUNET_MESH_ConnectPeerByType msg;
720 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
721 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
722 msg.tunnel_id = htonl (t->tid);
723 msg.type = htonl (t->apps[i]);
724 send_packet (t->mesh, &msg.header);
731 * Reconnect callback: tries to reconnect again after a failer previous
733 * @param cls closure (mesh handle)
734 * @param tc task context
737 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
739 struct GNUNET_MESH_Handle *h = cls;
741 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
747 /******************************************************************************/
748 /*********************** RECEIVE HANDLERS ****************************/
749 /******************************************************************************/
752 * Process the new tunnel notification and add it to the tunnels in the handle
754 * @param h The mesh handle
755 * @param msg A message with the details of the new incoming tunnel
758 process_tunnel_created (struct GNUNET_MESH_Handle *h,
759 const struct GNUNET_MESH_TunnelNotification *msg)
761 struct GNUNET_MESH_Tunnel *t;
762 struct GNUNET_ATS_Information atsi;
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;
781 if (NULL != h->new_tunnel)
785 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
792 * Process the tunnel destroy notification and free associated resources
794 * @param h The mesh handle
795 * @param msg A message with the details of the tunnel being destroyed
798 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
799 const struct GNUNET_MESH_TunnelMessage *msg)
801 struct GNUNET_MESH_Tunnel *t;
802 MESH_TunnelNumber tid;
804 tid = ntohl (msg->tunnel_id);
805 t = retrieve_tunnel (h, tid);
822 * Process the new peer event and notify the upper level of it
824 * @param h The mesh handle
825 * @param msg A message with the details of the peer event
828 process_peer_event (struct GNUNET_MESH_Handle *h,
829 const struct GNUNET_MESH_PeerControl *msg)
831 struct GNUNET_MESH_Tunnel *t;
832 struct GNUNET_MESH_Peer *p;
833 struct GNUNET_ATS_Information atsi;
837 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
838 size = ntohs (msg->header.size);
839 if (size != sizeof (struct GNUNET_MESH_PeerControl))
844 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
850 id = GNUNET_PEER_search (&msg->peer);
851 if ((p = retrieve_peer (t, id)) == NULL)
852 p = add_peer_to_tunnel (t, &msg->peer);
853 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
855 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
856 if (NULL != t->connect_handler)
860 t->connect_handler (t->cls, &msg->peer, &atsi);
866 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
867 if (NULL != t->disconnect_handler && p->connected)
869 t->disconnect_handler (t->cls, &msg->peer);
871 remove_peer_from_tunnel (p);
874 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
879 * Process the incoming data packets
881 * @param h The mesh handle
882 * @param message A message encapsulating the data
885 process_incoming_data (struct GNUNET_MESH_Handle *h,
886 const struct GNUNET_MessageHeader *message)
888 const struct GNUNET_MessageHeader *payload;
889 const struct GNUNET_MESH_MessageHandler *handler;
890 const struct GNUNET_PeerIdentity *peer;
891 struct GNUNET_MESH_Unicast *ucast;
892 struct GNUNET_MESH_Multicast *mcast;
893 struct GNUNET_MESH_ToOrigin *to_orig;
894 struct GNUNET_MESH_Tunnel *t;
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Got a data message!\n");
899 type = ntohs (message->type);
902 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
903 ucast = (struct GNUNET_MESH_Unicast *) message;
905 t = retrieve_tunnel (h, ntohl (ucast->tid));
906 payload = (struct GNUNET_MessageHeader *) &ucast[1];
908 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: on tunnel %s [%x]\n",
909 GNUNET_i2s (peer), ntohl (ucast->tid));
911 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
912 mcast = (struct GNUNET_MESH_Multicast *) message;
913 t = retrieve_tunnel (h, ntohl (mcast->tid));
914 payload = (struct GNUNET_MessageHeader *) &mcast[1];
917 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
918 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
919 t = retrieve_tunnel (h, ntohl (to_orig->tid));
920 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
921 peer = &to_orig->sender;
932 type = ntohs (payload->type);
933 for (i = 0; i < h->n_handlers; i++)
935 handler = &h->message_handlers[i];
936 if (handler->type == type)
938 struct GNUNET_ATS_Information atsi;
943 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
945 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
946 GNUNET_MESH_disconnect (h);
952 LOG (GNUNET_ERROR_TYPE_DEBUG,
953 "MESH: callback completed successfully\n");
963 * Function to process all messages received from the service
966 * @param msg message received, NULL on timeout or fatal error
969 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
971 struct GNUNET_MESH_Handle *h = cls;
978 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message type %hu from MESH\n",
980 switch (ntohs (msg->type))
982 /* Notify of a new incoming tunnel */
983 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
984 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
986 /* Notify of a tunnel disconnection */
987 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
988 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
990 /* Notify of a new peer or a peer disconnect in the tunnel */
991 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
992 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
993 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
995 /* Notify of a new data packet in the tunnel */
996 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
997 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
998 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
999 process_incoming_data (h, msg);
1001 /* We shouldn't get any other packages, log and ignore */
1003 LOG (GNUNET_ERROR_TYPE_WARNING,
1004 "MESH: unsolicited message form service (type %d)\n",
1007 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
1008 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1009 GNUNET_TIME_UNIT_FOREVER_REL);
1013 /******************************************************************************/
1014 /************************ SEND FUNCTIONS ****************************/
1015 /******************************************************************************/
1018 * Function called to send a message to the service.
1019 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1022 * @param cls closure, the mesh handle
1023 * @param size number of bytes available in buf
1024 * @param buf where the callee should write the connect message
1025 * @return number of bytes written to buf
1028 send_callback (void *cls, size_t size, void *buf)
1030 struct GNUNET_MESH_Handle *h = cls;
1031 struct GNUNET_MESH_TransmitHandle *th;
1036 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
1038 if ((0 == size) || (NULL == buf))
1044 while ((NULL != (th = h->th_head)) && (size >= th->size))
1046 if (NULL != th->notify)
1048 if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1050 /* traffic to origin */
1051 struct GNUNET_MESH_ToOrigin to;
1052 struct GNUNET_MessageHeader *mh;
1054 GNUNET_assert (size >= th->size);
1055 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1056 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1057 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: to origin, type %u\n",
1061 psize += sizeof (to);
1062 GNUNET_assert (size >= psize);
1063 to.header.size = htons (psize);
1064 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1065 to.tid = htonl (th->tunnel->tid);
1066 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1067 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1068 memcpy (cbuf, &to, sizeof (to));
1071 else if (th->target == 0)
1074 struct GNUNET_MESH_Multicast mc;
1075 struct GNUNET_MessageHeader *mh;
1077 GNUNET_assert (size >= th->size);
1078 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1079 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1080 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: multicast, type %u\n",
1084 psize += sizeof (mc);
1085 GNUNET_assert (size >= psize);
1086 mc.header.size = htons (psize);
1087 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1088 mc.tid = htonl (th->tunnel->tid);
1091 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1092 memcpy (cbuf, &mc, sizeof (mc));
1098 struct GNUNET_MESH_Unicast uc;
1099 struct GNUNET_MessageHeader *mh;
1101 GNUNET_assert (size >= th->size);
1102 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1103 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1104 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: unicast, type %u\n",
1108 psize += sizeof (uc);
1109 GNUNET_assert (size >= psize);
1110 uc.header.size = htons (psize);
1111 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1112 uc.tid = htonl (th->tunnel->tid);
1113 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1114 GNUNET_PEER_resolve (th->target, &uc.destination);
1115 memcpy (cbuf, &uc, sizeof (uc));
1121 memcpy (cbuf, &th[1], th->size);
1124 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1125 GNUNET_SCHEDULER_cancel (th->timeout_task);
1126 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1132 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
1133 if (NULL != (th = h->th_head))
1135 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
1137 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1138 GNUNET_TIME_UNIT_FOREVER_REL,
1139 GNUNET_YES, &send_callback, h);
1141 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1142 if (GNUNET_NO == h->in_receive)
1144 h->in_receive = GNUNET_YES;
1145 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1146 GNUNET_TIME_UNIT_FOREVER_REL);
1153 * Auxiliary function to send an already constructed packet to the service.
1154 * Takes care of creating a new queue element, copying the message and
1155 * calling the tmt_rdy function if necessary.
1156 * @param h mesh handle
1157 * @param msg message to transmit
1160 send_packet (struct GNUNET_MESH_Handle *h,
1161 const struct GNUNET_MessageHeader *msg)
1163 struct GNUNET_MESH_TransmitHandle *th;
1166 msize = ntohs (msg->size);
1167 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1168 th->priority = UINT32_MAX;
1169 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1171 memcpy (&th[1], msg, msize);
1172 add_to_queue (h, th);
1176 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1177 GNUNET_TIME_UNIT_FOREVER_REL,
1178 GNUNET_YES, &send_callback, h);
1182 /******************************************************************************/
1183 /********************** API CALL DEFINITIONS *************************/
1184 /******************************************************************************/
1187 * Connect to the mesh service.
1189 * @param cfg configuration to use
1190 * @param queue_size size of the data message queue, shared among all tunnels
1191 * (each tunnel is guaranteed to accept at least one message,
1192 * no matter what is the status of other tunnels)
1193 * @param cls closure for the various callbacks that follow
1194 * (including handlers in the handlers array)
1195 * @param new_tunnel function called when an *inbound* tunnel is created
1196 * @param cleaner function called when an *inbound* tunnel is destroyed
1197 * @param handlers callbacks for messages we care about, NULL-terminated
1198 * note that the mesh is allowed to drop notifications about
1199 * inbound messages if the client does not process them fast
1200 * enough (for this notification type, a bounded queue is used)
1201 * @param stypes list of the applications that this client claims to provide
1202 * @return handle to the mesh service NULL on error
1203 * (in this case, init is never called)
1205 struct GNUNET_MESH_Handle *
1206 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1207 unsigned int queue_size, void *cls,
1208 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1209 GNUNET_MESH_TunnelEndHandler cleaner,
1210 const struct GNUNET_MESH_MessageHandler *handlers,
1211 const GNUNET_MESH_ApplicationType *stypes)
1213 struct GNUNET_MESH_Handle *h;
1215 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1216 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1218 h->max_queue_size = queue_size;
1219 h->new_tunnel = new_tunnel;
1220 h->cleaner = cleaner;
1221 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1222 if (h->client == NULL)
1230 h->applications = stypes;
1231 h->message_handlers = handlers;
1232 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1233 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1235 /* count handlers and apps, calculate size */
1236 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1237 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1239 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1245 * Disconnect from the mesh service.
1247 * @param handle connection to mesh to disconnect
1250 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1252 struct GNUNET_MESH_Tunnel *t;
1253 struct GNUNET_MESH_Tunnel *aux;
1255 t = handle->tunnels_head;
1262 if (NULL != handle->th)
1264 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1266 if (NULL != handle->client)
1268 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1270 GNUNET_free (handle);
1275 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1276 * and to broadcast).
1278 * @param h mesh handle
1279 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1280 * @param connect_handler function to call when peers are actually connected
1281 * @param disconnect_handler function to call when peers are disconnected
1282 * @param handler_cls closure for connect/disconnect handlers
1284 struct GNUNET_MESH_Tunnel *
1285 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1286 GNUNET_MESH_PeerConnectHandler connect_handler,
1287 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1290 struct GNUNET_MESH_Tunnel *t;
1291 struct GNUNET_MESH_TunnelMessage msg;
1293 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1294 t = create_tunnel (h, 0);
1295 t->connect_handler = connect_handler;
1296 t->disconnect_handler = disconnect_handler;
1297 t->cls = handler_cls;
1298 t->ctx = tunnel_ctx;
1299 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1300 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1301 msg.tunnel_id = htonl (t->tid);
1302 send_packet (h, &msg.header);
1308 * Destroy an existing tunnel.
1310 * @param tunnel tunnel handle
1313 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1315 struct GNUNET_MESH_Handle *h;
1316 struct GNUNET_MESH_TunnelMessage msg;
1318 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1321 if (0 != tunnel->owner)
1322 GNUNET_PEER_change_rc (tunnel->owner, -1);
1324 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1325 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1326 msg.tunnel_id = htonl (tunnel->tid);
1327 destroy_tunnel (tunnel);
1328 send_packet (h, &msg.header);
1333 * Request that a peer should be added to the tunnel. The existing
1334 * connect handler will be called ONCE with either success or failure.
1335 * This function should NOT be called again with the same peer before the
1336 * connect handler is called.
1338 * @param tunnel handle to existing tunnel
1339 * @param peer peer to add
1342 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1343 const struct GNUNET_PeerIdentity *peer)
1345 struct GNUNET_MESH_PeerControl msg;
1346 GNUNET_PEER_Id peer_id;
1349 peer_id = GNUNET_PEER_intern (peer);
1350 for (i = 0; i < tunnel->npeers; i++)
1352 if (tunnel->peers[i]->id == peer_id)
1354 /* Peer already exists in tunnel */
1355 GNUNET_PEER_change_rc (peer_id, -1);
1360 if (NULL == add_peer_to_tunnel (tunnel, peer))
1363 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1364 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1365 msg.tunnel_id = htonl (tunnel->tid);
1367 send_packet (tunnel->mesh, &msg.header);
1374 * Request that a peer should be removed from the tunnel. The existing
1375 * disconnect handler will be called ONCE if we were connected.
1377 * @param tunnel handle to existing tunnel
1378 * @param peer peer to remove
1381 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1382 const struct GNUNET_PeerIdentity *peer)
1384 struct GNUNET_MESH_PeerControl msg;
1385 GNUNET_PEER_Id peer_id;
1388 peer_id = GNUNET_PEER_search (peer);
1394 for (i = 0; i < tunnel->npeers; i++)
1395 if (tunnel->peers[i]->id == peer_id)
1397 if (i == tunnel->npeers)
1402 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1403 tunnel->disconnect_handler (tunnel->cls, peer);
1404 GNUNET_PEER_change_rc (peer_id, -1);
1405 GNUNET_free (tunnel->peers[i]);
1406 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1407 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1409 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1410 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1411 msg.tunnel_id = htonl (tunnel->tid);
1412 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1413 send_packet (tunnel->mesh, &msg.header);
1418 * Request that the mesh should try to connect to a peer supporting the given
1421 * @param tunnel handle to existing tunnel
1422 * @param app_type application type that must be supported by the peer (MESH
1423 * should discover peer in proximity handling this type)
1426 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1427 GNUNET_MESH_ApplicationType app_type)
1429 struct GNUNET_MESH_ConnectPeerByType msg;
1431 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1433 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1434 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1435 msg.tunnel_id = htonl (tunnel->tid);
1436 msg.type = htonl (app_type);
1437 send_packet (tunnel->mesh, &msg.header);
1442 * Ask the mesh to call "notify" once it is ready to transmit the
1443 * given number of bytes to the specified "target". If we are not yet
1444 * connected to the specified peer, a call to this function will cause
1445 * us to try to establish a connection.
1447 * @param tunnel tunnel to use for transmission
1448 * @param cork is corking allowed for this transmission?
1449 * @param priority how important is the message?
1450 * @param maxdelay how long can the message wait?
1451 * @param target destination for the message,
1452 * NULL for multicast to all tunnel targets
1453 * @param notify_size how many bytes of buffer space does notify want?
1454 * @param notify function to call when buffer space is available;
1455 * will be called with NULL on timeout or if the overall queue
1456 * for this peer is larger than queue_size and this is currently
1457 * the message with the lowest priority
1458 * @param notify_cls closure for notify
1459 * @return non-NULL if the notify callback was queued,
1460 * NULL if we can not even queue the request (insufficient
1461 * memory); if NULL is returned, "notify" will NOT be called.
1463 struct GNUNET_MESH_TransmitHandle *
1464 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1466 struct GNUNET_TIME_Relative maxdelay,
1467 const struct GNUNET_PeerIdentity *target,
1469 GNUNET_CONNECTION_TransmitReadyNotify notify,
1472 struct GNUNET_MESH_TransmitHandle *th;
1473 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1474 uint32_t least_priority;
1478 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1479 "mesh: mesh notify transmit ready called\n");
1481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: target %s\n",
1482 GNUNET_i2s (target));
1484 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: target multicast\n");
1486 GNUNET_assert (NULL != notify);
1487 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1488 tunnel->npackets > 0)
1493 th = tunnel->mesh->th_tail;
1494 least_priority = priority;
1495 least_priority_th = NULL;
1498 if (th->priority < least_priority && th->tunnel->npackets > 1)
1500 least_priority_th = th;
1501 least_priority = th->priority;
1505 if (NULL == least_priority_th)
1507 /* Can't be a control message */
1508 GNUNET_assert (NULL != least_priority_th->notify);
1509 least_priority_th->notify (notify_cls, 0, NULL);
1510 least_priority_th->tunnel->npackets--;
1511 tunnel->mesh->npackets--;
1512 GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1514 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1515 GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1516 GNUNET_free (least_priority_th);
1519 tunnel->mesh->npackets++;
1520 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1521 th->tunnel = tunnel;
1522 th->priority = priority;
1523 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1524 th->target = GNUNET_PEER_intern (target);
1525 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1526 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1527 else if (NULL == target)
1528 overhead = sizeof (struct GNUNET_MESH_Multicast);
1530 overhead = sizeof (struct GNUNET_MESH_Unicast);
1531 th->size = notify_size + overhead;
1532 th->notify = notify;
1533 th->notify_cls = notify_cls;
1534 add_to_queue (tunnel->mesh, th);
1535 if (NULL != tunnel->mesh->th)
1538 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1539 GNUNET_TIME_UNIT_FOREVER_REL,
1540 GNUNET_YES, &send_callback,
1547 * Cancel the specified transmission-ready notification.
1549 * @param th handle that was returned by "notify_transmit_ready".
1552 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1554 struct GNUNET_MESH_Handle *mesh;
1556 mesh = th->tunnel->mesh;
1557 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1558 GNUNET_SCHEDULER_cancel (th->timeout_task);
1559 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1561 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1563 /* queue empty, no point in asking for transmission */
1564 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1571 * Transition API for tunnel ctx management
1574 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1580 * Transition API for tunnel ctx management
1583 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)
1589 #if 0 /* keep Emacsens' auto-indent happy */