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
371 * @param tid ID of the wanted tunnel
372 * @return handle to the required tunnel or NULL if not found
375 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
377 struct GNUNET_MESH_Handle *h;
378 struct GNUNET_PeerIdentity pi;
379 struct GNUNET_MESH_TransmitHandle *th;
380 struct GNUNET_MESH_TransmitHandle *aux;
395 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
396 if (NULL == h->th_head && NULL != h->th)
398 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
401 if (NULL != th->notify)
402 th->notify (th->notify_cls, 0, NULL);
403 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
404 GNUNET_SCHEDULER_cancel (th->timeout_task);
413 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
414 for (i = 0; i < t->npeers; i++)
416 if (NULL != t->disconnect_handler && t->peers[i]->connected)
418 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
419 t->disconnect_handler (t->cls, &pi);
421 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
422 GNUNET_free (t->peers[i]);
425 GNUNET_free (t->peers);
426 if (NULL != h->cleaner && 0 != t->owner)
427 h->cleaner (h->cls, t, t->ctx);
429 GNUNET_PEER_change_rc (t->owner, -1);
430 if (0 != t->napps && t->apps)
431 GNUNET_free (t->apps);
438 * Get the peer descriptor for the peer with id from the given tunnel
439 * @param t Tunnel handle
440 * @param id Short form ID of the wanted peer
441 * @return handle to the requested peer or NULL if not found
443 static struct GNUNET_MESH_Peer *
444 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
448 for (i = 0; i < t->npeers; i++)
449 if (t->peers[i]->id == id)
456 * Add a peer into a tunnel
457 * @param t Tunnel handle
458 * @param pi Full ID of the new peer
459 * @return handle to the newly created peer
461 static struct GNUNET_MESH_Peer *
462 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
463 const struct GNUNET_PeerIdentity *pi)
465 struct GNUNET_MESH_Peer *p;
473 id = GNUNET_PEER_intern (pi);
475 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
478 GNUNET_array_append (t->peers, t->npeers, p);
484 * Remove a peer from a tunnel
485 * @param p Peer handle
488 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
492 for (i = 0; i < p->t->npeers; i++)
494 if (p->t->peers[i] == p)
497 if (i == p->t->npeers)
502 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
503 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
508 * Notify client that the transmission has timed out
510 * @param tc task context
513 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
515 struct GNUNET_MESH_TransmitHandle *th = cls;
516 struct GNUNET_MESH_Handle *mesh;
518 mesh = th->tunnel->mesh;
519 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
520 if (th->notify != NULL)
521 th->notify (th->notify_cls, 0, NULL);
523 if ((NULL == mesh->th_head) && (NULL != mesh->th))
525 /* queue empty, no point in asking for transmission */
526 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
533 * Add a transmit handle to the transmission queue by priority and set the
536 * @param h mesh handle with the queue head and tail
537 * @param th handle to the packet to be transmitted
540 add_to_queue (struct GNUNET_MESH_Handle *h,
541 struct GNUNET_MESH_TransmitHandle *th)
543 struct GNUNET_MESH_TransmitHandle *p;
546 while ((NULL != p) && (th->priority <= p->priority))
552 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
553 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
556 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
557 (th->timeout), &timeout_transmission, th);
562 * Auxiliary function to send an already constructed packet to the service.
563 * Takes care of creating a new queue element, copying the message and
564 * calling the tmt_rdy function if necessary.
565 * @param h mesh handle
566 * @param msg message to transmit
569 send_packet (struct GNUNET_MESH_Handle *h,
570 const struct GNUNET_MessageHeader *msg);
574 * Reconnect callback: tries to reconnect again after a failer previous
576 * @param cls closure (mesh handle)
577 * @param tc task context
580 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
584 * Send a connect packet to the service with the applications and types
585 * requested by the user.
587 * @param h The mesh handle.
591 send_connect (struct GNUNET_MESH_Handle *h)
595 size = sizeof (struct GNUNET_MESH_ClientConnect);
596 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
597 size += h->n_handlers * sizeof (uint16_t);
600 struct GNUNET_MESH_ClientConnect *msg;
601 GNUNET_MESH_ApplicationType *apps;
606 /* build connection packet */
607 msg = (struct GNUNET_MESH_ClientConnect *) buf;
608 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
609 msg->header.size = htons (size);
610 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
611 for (napps = 0; napps < h->n_applications; napps++)
613 apps[napps] = htonl (h->applications[napps]);
614 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: app %u\n", h->applications[napps]);
616 types = (uint16_t *) & apps[napps];
617 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
618 types[ntypes] = htons (h->message_handlers[ntypes].type);
619 msg->applications = htons (napps);
620 msg->types = htons (ntypes);
622 LOG (GNUNET_ERROR_TYPE_DEBUG,
623 "mesh: Sending %lu bytes long message %d types and %d apps\n",
624 ntohs (msg->header.size), ntypes, napps);
626 send_packet (h, &msg->header);
632 * Reconnect to the service, retransmit all infomation to try to restore the
635 * @param h handle to the mesh
637 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
640 reconnect (struct GNUNET_MESH_Handle *h)
642 struct GNUNET_MESH_Tunnel *t;
646 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
647 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: ******* RECONNECT *******\n");
648 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
650 h->in_receive = GNUNET_NO;
654 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
656 if (NULL != h->client)
658 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
662 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
663 if (h->client == NULL)
665 GNUNET_SCHEDULER_add_delayed (h->reconnect_time, &reconnect_cbk, h);
667 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_HOURS,
668 GNUNET_TIME_relative_multiply
669 (h->reconnect_time, 2));
670 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Next retry in %sms\n",
671 GNUNET_TIME_relative_to_string (h->reconnect_time));
677 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
680 /* Rebuild all tunnels */
681 for (t = h->tunnels_head; NULL != t; t = t->next)
683 struct GNUNET_MESH_TunnelMessage tmsg;
684 struct GNUNET_MESH_PeerControl pmsg;
686 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
688 /* Tunnel was created by service (incoming tunnel) */
689 /* TODO: Notify service of missing tunnel, to request
690 * creator to recreate path (find a path to him via DHT?)
694 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
695 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
696 tmsg.tunnel_id = htonl (t->tid);
697 send_packet (h, &tmsg.header);
699 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
700 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
701 pmsg.tunnel_id = htonl (t->tid);
703 /* Reconnect all peers */
704 for (i = 0; i < t->npeers; i++)
706 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
707 if (NULL != t->disconnect_handler && t->peers[i]->connected)
708 t->disconnect_handler (t->cls, &pmsg.peer);
709 /* If the tunnel was "by type", dont connect individual peers */
711 send_packet (t->mesh, &pmsg.header);
713 /* Reconnect all types, if any */
714 for (i = 0; i < t->napps; i++)
716 struct GNUNET_MESH_ConnectPeerByType msg;
718 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
719 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
720 msg.tunnel_id = htonl (t->tid);
721 msg.type = htonl (t->apps[i]);
722 send_packet (t->mesh, &msg.header);
729 * Reconnect callback: tries to reconnect again after a failer previous
731 * @param cls closure (mesh handle)
732 * @param tc task context
735 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
737 struct GNUNET_MESH_Handle *h = cls;
739 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
745 /******************************************************************************/
746 /*********************** RECEIVE HANDLERS ****************************/
747 /******************************************************************************/
750 * Process the new tunnel notification and add it to the tunnels in the handle
752 * @param h The mesh handle
753 * @param msg A message with the details of the new incoming tunnel
756 process_tunnel_created (struct GNUNET_MESH_Handle *h,
757 const struct GNUNET_MESH_TunnelNotification *msg)
759 struct GNUNET_MESH_Tunnel *t;
760 struct GNUNET_ATS_Information atsi;
761 MESH_TunnelNumber tid;
763 tid = ntohl (msg->tunnel_id);
764 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
769 t = create_tunnel (h, tid);
770 t->owner = GNUNET_PEER_intern (&msg->peer);
772 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
773 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
775 t->peers[0]->connected = 1;
776 t->peers[0]->id = t->owner;
779 if (NULL != h->new_tunnel)
783 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
790 * Process the tunnel destroy notification and free associated resources
792 * @param h The mesh handle
793 * @param msg A message with the details of the tunnel being destroyed
796 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
797 const struct GNUNET_MESH_TunnelMessage *msg)
799 struct GNUNET_MESH_Tunnel *t;
800 MESH_TunnelNumber tid;
802 tid = ntohl (msg->tunnel_id);
803 t = retrieve_tunnel (h, tid);
820 * Process the new peer event and notify the upper level of it
822 * @param h The mesh handle
823 * @param msg A message with the details of the peer event
826 process_peer_event (struct GNUNET_MESH_Handle *h,
827 const struct GNUNET_MESH_PeerControl *msg)
829 struct GNUNET_MESH_Tunnel *t;
830 struct GNUNET_MESH_Peer *p;
831 struct GNUNET_ATS_Information atsi;
835 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
836 size = ntohs (msg->header.size);
837 if (size != sizeof (struct GNUNET_MESH_PeerControl))
842 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
848 id = GNUNET_PEER_search (&msg->peer);
849 if ((p = retrieve_peer (t, id)) == NULL)
850 p = add_peer_to_tunnel (t, &msg->peer);
851 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
853 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
854 if (NULL != t->connect_handler)
858 t->connect_handler (t->cls, &msg->peer, &atsi);
864 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
865 if (NULL != t->disconnect_handler && p->connected)
867 t->disconnect_handler (t->cls, &msg->peer);
869 remove_peer_from_tunnel (p);
872 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
877 * Process the incoming data packets
879 * @param h The mesh handle
880 * @param message A message encapsulating the data
883 process_incoming_data (struct GNUNET_MESH_Handle *h,
884 const struct GNUNET_MessageHeader *message)
886 const struct GNUNET_MessageHeader *payload;
887 const struct GNUNET_MESH_MessageHandler *handler;
888 const struct GNUNET_PeerIdentity *peer;
889 struct GNUNET_MESH_Unicast *ucast;
890 struct GNUNET_MESH_Multicast *mcast;
891 struct GNUNET_MESH_ToOrigin *to_orig;
892 struct GNUNET_MESH_Tunnel *t;
896 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Got a data message!\n");
897 type = ntohs (message->type);
900 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
901 ucast = (struct GNUNET_MESH_Unicast *) message;
903 t = retrieve_tunnel (h, ntohl (ucast->tid));
904 payload = (struct GNUNET_MessageHeader *) &ucast[1];
906 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: on tunnel %s [%x]\n",
907 GNUNET_i2s (peer), ntohl (ucast->tid));
909 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
910 mcast = (struct GNUNET_MESH_Multicast *) message;
911 t = retrieve_tunnel (h, ntohl (mcast->tid));
912 payload = (struct GNUNET_MessageHeader *) &mcast[1];
915 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
916 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
917 t = retrieve_tunnel (h, ntohl (to_orig->tid));
918 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
919 peer = &to_orig->sender;
930 type = ntohs (payload->type);
931 for (i = 0; i < h->n_handlers; i++)
933 handler = &h->message_handlers[i];
934 if (handler->type == type)
936 struct GNUNET_ATS_Information atsi;
941 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
943 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
944 GNUNET_MESH_disconnect (h);
950 LOG (GNUNET_ERROR_TYPE_DEBUG,
951 "MESH: callback completed successfully\n");
961 * Function to process all messages received from the service
964 * @param msg message received, NULL on timeout or fatal error
967 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
969 struct GNUNET_MESH_Handle *h = cls;
976 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message type %hu from MESH\n",
978 switch (ntohs (msg->type))
980 /* Notify of a new incoming tunnel */
981 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
982 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
984 /* Notify of a tunnel disconnection */
985 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
986 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
988 /* Notify of a new peer or a peer disconnect in the tunnel */
989 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
990 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
991 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
993 /* Notify of a new data packet in the tunnel */
994 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
995 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
996 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
997 process_incoming_data (h, msg);
999 /* We shouldn't get any other packages, log and ignore */
1001 LOG (GNUNET_ERROR_TYPE_WARNING,
1002 "MESH: unsolicited message form service (type %d)\n",
1005 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
1006 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1007 GNUNET_TIME_UNIT_FOREVER_REL);
1011 /******************************************************************************/
1012 /************************ SEND FUNCTIONS ****************************/
1013 /******************************************************************************/
1016 * Function called to send a message to the service.
1017 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1020 * @param cls closure, the mesh handle
1021 * @param size number of bytes available in buf
1022 * @param buf where the callee should write the connect message
1023 * @return number of bytes written to buf
1026 send_callback (void *cls, size_t size, void *buf)
1028 struct GNUNET_MESH_Handle *h = cls;
1029 struct GNUNET_MESH_TransmitHandle *th;
1034 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
1036 if ((0 == size) || (NULL == buf))
1042 while ((NULL != (th = h->th_head)) && (size >= th->size))
1044 if (NULL != th->notify)
1046 if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1048 /* traffic to origin */
1049 struct GNUNET_MESH_ToOrigin to;
1050 struct GNUNET_MessageHeader *mh;
1052 GNUNET_assert (size >= th->size);
1053 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1054 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1055 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: to origin, type %u\n",
1059 psize += sizeof (to);
1060 GNUNET_assert (size >= psize);
1061 to.header.size = htons (psize);
1062 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1063 to.tid = htonl (th->tunnel->tid);
1064 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1065 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1066 memcpy (cbuf, &to, sizeof (to));
1069 else if (th->target == 0)
1072 struct GNUNET_MESH_Multicast mc;
1073 struct GNUNET_MessageHeader *mh;
1075 GNUNET_assert (size >= th->size);
1076 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1077 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1078 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: multicast, type %u\n",
1082 psize += sizeof (mc);
1083 GNUNET_assert (size >= psize);
1084 mc.header.size = htons (psize);
1085 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1086 mc.tid = htonl (th->tunnel->tid);
1088 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1089 memcpy (cbuf, &mc, sizeof (mc));
1095 struct GNUNET_MESH_Unicast uc;
1096 struct GNUNET_MessageHeader *mh;
1098 GNUNET_assert (size >= th->size);
1099 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1100 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1101 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: unicast, type %u\n",
1105 psize += sizeof (uc);
1106 GNUNET_assert (size >= psize);
1107 uc.header.size = htons (psize);
1108 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1109 uc.tid = htonl (th->tunnel->tid);
1110 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1111 GNUNET_PEER_resolve (th->target, &uc.destination);
1112 memcpy (cbuf, &uc, sizeof (uc));
1118 memcpy (cbuf, &th[1], th->size);
1121 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1122 GNUNET_SCHEDULER_cancel (th->timeout_task);
1123 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1129 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
1130 if (NULL != (th = h->th_head))
1132 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
1134 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1135 GNUNET_TIME_UNIT_FOREVER_REL,
1136 GNUNET_YES, &send_callback, h);
1138 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1139 if (GNUNET_NO == h->in_receive)
1141 h->in_receive = GNUNET_YES;
1142 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1143 GNUNET_TIME_UNIT_FOREVER_REL);
1150 * Auxiliary function to send an already constructed packet to the service.
1151 * Takes care of creating a new queue element, copying the message and
1152 * calling the tmt_rdy function if necessary.
1153 * @param h mesh handle
1154 * @param msg message to transmit
1157 send_packet (struct GNUNET_MESH_Handle *h,
1158 const struct GNUNET_MessageHeader *msg)
1160 struct GNUNET_MESH_TransmitHandle *th;
1163 msize = ntohs (msg->size);
1164 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1165 th->priority = UINT32_MAX;
1166 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1168 memcpy (&th[1], msg, msize);
1169 add_to_queue (h, th);
1173 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1174 GNUNET_TIME_UNIT_FOREVER_REL,
1175 GNUNET_YES, &send_callback, h);
1179 /******************************************************************************/
1180 /********************** API CALL DEFINITIONS *************************/
1181 /******************************************************************************/
1184 * Connect to the mesh service.
1186 * @param cfg configuration to use
1187 * @param queue_size size of the data message queue, shared among all tunnels
1188 * (each tunnel is guaranteed to accept at least one message,
1189 * no matter what is the status of other tunnels)
1190 * @param cls closure for the various callbacks that follow
1191 * (including handlers in the handlers array)
1192 * @param new_tunnel function called when an *inbound* tunnel is created
1193 * @param cleaner function called when an *inbound* tunnel is destroyed
1194 * @param handlers callbacks for messages we care about, NULL-terminated
1195 * note that the mesh is allowed to drop notifications about
1196 * inbound messages if the client does not process them fast
1197 * enough (for this notification type, a bounded queue is used)
1198 * @param stypes list of the applications that this client claims to provide
1199 * @return handle to the mesh service NULL on error
1200 * (in this case, init is never called)
1202 struct GNUNET_MESH_Handle *
1203 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1204 unsigned int queue_size, void *cls,
1205 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1206 GNUNET_MESH_TunnelEndHandler cleaner,
1207 const struct GNUNET_MESH_MessageHandler *handlers,
1208 const GNUNET_MESH_ApplicationType *stypes)
1210 struct GNUNET_MESH_Handle *h;
1212 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1213 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1215 h->max_queue_size = queue_size;
1216 h->new_tunnel = new_tunnel;
1217 h->cleaner = cleaner;
1218 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1219 if (h->client == NULL)
1227 h->applications = stypes;
1228 h->message_handlers = handlers;
1229 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1230 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1232 /* count handlers and apps, calculate size */
1233 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1234 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1236 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1242 * Disconnect from the mesh service.
1244 * @param handle connection to mesh to disconnect
1247 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1249 struct GNUNET_MESH_Tunnel *t;
1250 struct GNUNET_MESH_Tunnel *aux;
1252 t = handle->tunnels_head;
1259 if (NULL != handle->th)
1261 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1263 if (NULL != handle->client)
1265 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1267 GNUNET_free (handle);
1272 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1273 * and to broadcast).
1275 * @param h mesh handle
1276 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1277 * @param connect_handler function to call when peers are actually connected
1278 * @param disconnect_handler function to call when peers are disconnected
1279 * @param handler_cls closure for connect/disconnect handlers
1281 struct GNUNET_MESH_Tunnel *
1282 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1283 GNUNET_MESH_PeerConnectHandler connect_handler,
1284 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1287 struct GNUNET_MESH_Tunnel *t;
1288 struct GNUNET_MESH_TunnelMessage msg;
1290 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1291 t = create_tunnel (h, 0);
1292 t->connect_handler = connect_handler;
1293 t->disconnect_handler = disconnect_handler;
1294 t->cls = handler_cls;
1295 t->ctx = tunnel_ctx;
1296 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1297 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1298 msg.tunnel_id = htonl (t->tid);
1299 send_packet (h, &msg.header);
1305 * Destroy an existing tunnel.
1307 * @param tun tunnel handle
1310 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1312 struct GNUNET_MESH_Handle *h;
1313 struct GNUNET_MESH_TunnelMessage msg;
1315 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1318 if (0 != tunnel->owner)
1319 GNUNET_PEER_change_rc (tunnel->owner, -1);
1321 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1322 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1323 msg.tunnel_id = htonl (tunnel->tid);
1324 destroy_tunnel (tunnel);
1325 send_packet (h, &msg.header);
1330 * Request that a peer should be added to the tunnel. The existing
1331 * connect handler will be called ONCE with either success or failure.
1332 * This function should NOT be called again with the same peer before the
1333 * connect handler is called.
1335 * @param tunnel handle to existing tunnel
1336 * @param peer peer to add
1339 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1340 const struct GNUNET_PeerIdentity *peer)
1342 struct GNUNET_MESH_PeerControl msg;
1343 GNUNET_PEER_Id peer_id;
1346 peer_id = GNUNET_PEER_intern (peer);
1347 for (i = 0; i < tunnel->npeers; i++)
1349 if (tunnel->peers[i]->id == peer_id)
1351 /* Peer already exists in tunnel */
1352 GNUNET_PEER_change_rc (peer_id, -1);
1357 if (NULL == add_peer_to_tunnel (tunnel, peer))
1360 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1361 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1362 msg.tunnel_id = htonl (tunnel->tid);
1364 send_packet (tunnel->mesh, &msg.header);
1371 * Request that a peer should be removed from the tunnel. The existing
1372 * disconnect handler will be called ONCE if we were connected.
1374 * @param tunnel handle to existing tunnel
1375 * @param peer peer to remove
1378 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1379 const struct GNUNET_PeerIdentity *peer)
1381 struct GNUNET_MESH_PeerControl msg;
1382 GNUNET_PEER_Id peer_id;
1385 peer_id = GNUNET_PEER_search (peer);
1391 for (i = 0; i < tunnel->npeers; i++)
1392 if (tunnel->peers[i]->id == peer_id)
1394 if (i == tunnel->npeers)
1399 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1400 tunnel->disconnect_handler (tunnel->cls, peer);
1401 GNUNET_PEER_change_rc (peer_id, -1);
1402 GNUNET_free (tunnel->peers[i]);
1403 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1404 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1406 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1407 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1408 msg.tunnel_id = htonl (tunnel->tid);
1409 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1410 send_packet (tunnel->mesh, &msg.header);
1415 * Request that the mesh should try to connect to a peer supporting the given
1418 * @param tunnel handle to existing tunnel
1419 * @param app_type application type that must be supported by the peer (MESH
1420 * should discover peer in proximity handling this type)
1423 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1424 GNUNET_MESH_ApplicationType app_type)
1426 struct GNUNET_MESH_ConnectPeerByType msg;
1428 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1430 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1431 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1432 msg.tunnel_id = htonl (tunnel->tid);
1433 msg.type = htonl (app_type);
1434 send_packet (tunnel->mesh, &msg.header);
1439 * Ask the mesh to call "notify" once it is ready to transmit the
1440 * given number of bytes to the specified "target". If we are not yet
1441 * connected to the specified peer, a call to this function will cause
1442 * us to try to establish a connection.
1444 * @param tunnel tunnel to use for transmission
1445 * @param cork is corking allowed for this transmission?
1446 * @param priority how important is the message?
1447 * @param maxdelay how long can the message wait?
1448 * @param target destination for the message,
1449 * NULL for multicast to all tunnel targets
1450 * @param notify_size how many bytes of buffer space does notify want?
1451 * @param notify function to call when buffer space is available;
1452 * will be called with NULL on timeout or if the overall queue
1453 * for this peer is larger than queue_size and this is currently
1454 * the message with the lowest priority
1455 * @param notify_cls closure for notify
1456 * @return non-NULL if the notify callback was queued,
1457 * NULL if we can not even queue the request (insufficient
1458 * memory); if NULL is returned, "notify" will NOT be called.
1460 struct GNUNET_MESH_TransmitHandle *
1461 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1463 struct GNUNET_TIME_Relative maxdelay,
1464 const struct GNUNET_PeerIdentity *target,
1466 GNUNET_CONNECTION_TransmitReadyNotify notify,
1469 struct GNUNET_MESH_TransmitHandle *th;
1470 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1471 uint32_t least_priority;
1475 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1476 "mesh: mesh notify transmit ready called\n");
1478 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: target %s\n",
1479 GNUNET_i2s (target));
1481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: target multicast\n");
1483 GNUNET_assert (NULL != notify);
1484 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1485 tunnel->npackets > 0)
1490 th = tunnel->mesh->th_tail;
1491 least_priority = priority;
1492 least_priority_th = NULL;
1495 if (th->priority < least_priority && th->tunnel->npackets > 1)
1497 least_priority_th = th;
1498 least_priority = th->priority;
1502 if (NULL == least_priority_th)
1504 /* Can't be a control message */
1505 GNUNET_assert (NULL != least_priority_th->notify);
1506 least_priority_th->notify (notify_cls, 0, NULL);
1507 least_priority_th->tunnel->npackets--;
1508 tunnel->mesh->npackets--;
1509 GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1511 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1512 GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1513 GNUNET_free (least_priority_th);
1516 tunnel->mesh->npackets++;
1517 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1518 th->tunnel = tunnel;
1519 th->priority = priority;
1520 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1521 th->target = GNUNET_PEER_intern (target);
1522 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1523 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1524 else if (NULL == target)
1525 overhead = sizeof (struct GNUNET_MESH_Multicast);
1527 overhead = sizeof (struct GNUNET_MESH_Unicast);
1528 th->size = notify_size + overhead;
1529 th->notify = notify;
1530 th->notify_cls = notify_cls;
1531 add_to_queue (tunnel->mesh, th);
1532 if (NULL != tunnel->mesh->th)
1535 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1536 GNUNET_TIME_UNIT_FOREVER_REL,
1537 GNUNET_YES, &send_callback,
1544 * Cancel the specified transmission-ready notification.
1546 * @param th handle that was returned by "notify_transmit_ready".
1549 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1551 struct GNUNET_MESH_Handle *mesh;
1553 mesh = th->tunnel->mesh;
1554 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1555 GNUNET_SCHEDULER_cancel (th->timeout_task);
1556 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1558 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1560 /* queue empty, no point in asking for transmission */
1561 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1568 * Transition API for tunnel ctx management
1571 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1577 * Transition API for tunnel ctx management
1580 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)
1586 #if 0 /* keep Emacsens' auto-indent happy */