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_new.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_new.h"
46 #include "mesh_protocol.h"
48 #define DEBUG GNUNET_YES
50 /******************************************************************************/
51 /************************ DATA STRUCTURES ****************************/
52 /******************************************************************************/
55 * Transmission queue to the service
57 struct GNUNET_MESH_TransmitHandle
63 struct GNUNET_MESH_TransmitHandle *next;
68 struct GNUNET_MESH_TransmitHandle *prev;
71 * Tunnel this message is sent over (may be NULL for control messages).
73 struct GNUNET_MESH_Tunnel *tunnel;
76 * Callback to obtain the message to transmit, or NULL if we
77 * got the message in 'data'. Notice that messages built
78 * by 'notify' need to be encapsulated with information about
81 GNUNET_CONNECTION_TransmitReadyNotify notify;
84 * Closure for 'notify'
89 * How long is this message valid. Once the timeout has been
90 * reached, the message must no longer be sent. If this
91 * is a message with a 'notify' callback set, the 'notify'
92 * function should be called with 'buf' NULL and size 0.
94 struct GNUNET_TIME_Absolute timeout;
97 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
99 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
102 * Priority of the message. The queue is sorted by priority,
103 * control messages have the maximum priority (UINT32_MAX).
108 * Target of the message, 0 for broadcast. This field
109 * is only valid if 'notify' is non-NULL.
111 GNUNET_PEER_Id target;
114 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
121 * Opaque handle to the service.
123 struct GNUNET_MESH_Handle
127 * Handle to the server connection, to send messages later
129 struct GNUNET_CLIENT_Connection *client;
132 * Set of handlers used for processing incoming messages in the tunnels
134 const struct GNUNET_MESH_MessageHandler *message_handlers;
137 * Set of applications that should be claimed to be offered at this node.
138 * Note that this is just informative, the appropiate handlers must be
139 * registered independently and the mapping is up to the developer of the
140 * client application.
142 const GNUNET_MESH_ApplicationType *applications;
145 * Double linked list of the tunnels this client is connected to.
147 struct GNUNET_MESH_Tunnel *tunnels_head;
148 struct GNUNET_MESH_Tunnel *tunnels_tail;
151 * Callback for inbound tunnel creation
153 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
156 * Callback for inbound tunnel disconnection
158 GNUNET_MESH_TunnelEndHandler *cleaner;
161 * Handle to cancel pending transmissions in case of disconnection
163 struct GNUNET_CLIENT_TransmitHandle *th;
166 * Closure for all the handlers given by the client
171 * Messages to send to the service
173 struct GNUNET_MESH_TransmitHandle *th_head;
174 struct GNUNET_MESH_TransmitHandle *th_tail;
177 * tid of the next tunnel to create (to avoid reusing IDs often)
179 MESH_TunnelNumber next_tid;
180 unsigned int n_handlers;
181 unsigned int n_applications;
182 unsigned int max_queue_size;
185 * Have we started the task to receive messages from the service
186 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
191 * Number of packets queued
193 unsigned int npackets;
196 * Configuration given by the client, in case of reconnection
198 const struct GNUNET_CONFIGURATION_Handle *cfg;
201 * Time to the next reconnect in case one reconnect fails
203 struct GNUNET_TIME_Relative reconnect_time;
208 * Description of a peer
210 struct GNUNET_MESH_Peer
213 * ID of the peer in short form
218 * Tunnel this peer belongs to
220 struct GNUNET_MESH_Tunnel *t;
223 * Flag indicating whether service has informed about its connection
231 * Opaque handle to a tunnel.
233 struct GNUNET_MESH_Tunnel
239 struct GNUNET_MESH_Tunnel *next;
240 struct GNUNET_MESH_Tunnel *prev;
243 * Callback to execute when peers connect to the tunnel
245 GNUNET_MESH_TunnelConnectHandler connect_handler;
248 * Callback to execute when peers disconnect from the tunnel
250 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler;
253 * Closure for the connect/disconnect handlers
258 * Handle to the mesh this tunnel belongs to
260 struct GNUNET_MESH_Handle *mesh;
263 * Local ID of the tunnel
265 MESH_TunnelNumber tid;
268 * Owner of the tunnel
270 GNUNET_PEER_Id owner;
273 * All peers added to the tunnel
275 struct GNUNET_MESH_Peer **peers;
278 * List of application types that have been requested for this tunnel
280 GNUNET_MESH_ApplicationType *apps;
283 * Any data the caller wants to put in here
288 * Number of peers added to the tunnel
293 * Number of packets queued in this tunnel
295 unsigned int npackets;
298 * Number of applications requested this tunnel
305 /******************************************************************************/
306 /*********************** AUXILIARY FUNCTIONS *************************/
307 /******************************************************************************/
310 * Get the tunnel handler for the tunnel specified by id from the given handle
311 * @param h Mesh handle
312 * @param tid ID of the wanted tunnel
313 * @return handle to the required tunnel or NULL if not found
315 static struct GNUNET_MESH_Tunnel *
316 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
318 struct GNUNET_MESH_Tunnel *t;
332 * Create a new tunnel and insert it in the tunnel list of the mesh handle
333 * @param h Mesh handle
334 * @param tid desired tid of the tunnel, 0 to assign one automatically
335 * @return handle to the created tunnel
337 static struct GNUNET_MESH_Tunnel *
338 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
340 struct GNUNET_MESH_Tunnel *t;
342 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
343 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
347 t->tid = h->next_tid;
348 while (NULL != retrieve_tunnel (h, h->next_tid))
351 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
352 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
364 * Destroy the specified tunnel.
365 * - Destroys all peers, calling the disconnect callback on each if needed
366 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
367 * - Calls cleaner if tunnel was inbound
368 * - Frees all memory used
369 * @param tid ID of the wanted tunnel
370 * @return handle to the required tunnel or NULL if not found
373 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
375 struct GNUNET_MESH_Handle *h;
376 struct GNUNET_PeerIdentity pi;
377 struct GNUNET_MESH_TransmitHandle *th;
378 struct GNUNET_MESH_TransmitHandle *aux;
393 GNUNET_CONTAINER_DLL_remove(h->th_head, h->th_tail, th);
394 if (NULL == h->th_head && NULL != h->th)
396 GNUNET_CLIENT_notify_transmit_ready_cancel(h->th);
399 if (NULL != th->notify)
400 th->notify(th->notify_cls, 0, NULL);
401 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
402 GNUNET_SCHEDULER_cancel(th->timeout_task);
411 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
412 for (i = 0; i < t->npeers; i++)
414 if (NULL != t->disconnect_handler && t->peers[i]->connected)
416 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
417 t->disconnect_handler (t->cls, &pi);
419 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
420 GNUNET_free (t->peers[i]);
423 GNUNET_free (t->peers);
424 if (NULL != h->cleaner && 0 != t->owner)
425 h->cleaner (h->cls, t, t->ctx);
427 GNUNET_PEER_change_rc (t->owner, -1);
428 if (0 != t->napps && t->apps)
429 GNUNET_free (t->apps);
435 * Get the peer descriptor for the peer with id from the given tunnel
436 * @param t Tunnel handle
437 * @param id Short form ID of the wanted peer
438 * @return handle to the requested peer or NULL if not found
440 static struct GNUNET_MESH_Peer *
441 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
445 for (i = 0; i < t->npeers; i++)
446 if (t->peers[i]->id == id)
453 * Add a peer into a tunnel
454 * @param t Tunnel handle
455 * @param pi Full ID of the new peer
456 * @return handle to the newly created peer
458 static struct GNUNET_MESH_Peer *
459 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
460 const struct GNUNET_PeerIdentity *pi)
462 struct GNUNET_MESH_Peer *p;
470 id = GNUNET_PEER_intern (pi);
472 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
475 GNUNET_array_append (t->peers, t->npeers, p);
481 * Remove a peer from a tunnel
482 * @param t Tunnel handle
483 * @param p Peer handle
486 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
490 for (i = 0; i < p->t->npeers; i++)
492 if (p->t->peers[i] == p)
495 if (i == p->t->npeers)
500 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
501 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
506 * Notify client that the transmission has timed out
508 * @param tc task context
511 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
513 struct GNUNET_MESH_TransmitHandle *th = cls;
514 struct GNUNET_MESH_Handle *mesh;
516 mesh = th->tunnel->mesh;
517 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
518 if (th->notify != NULL)
519 th->notify (th->notify_cls, 0, NULL);
521 if ((NULL == mesh->th_head) && (NULL != mesh->th))
523 /* queue empty, no point in asking for transmission */
524 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
531 * Add a transmit handle to the transmission queue by priority and set the
534 * @param h mesh handle with the queue head and tail
535 * @param q handle to the packet to be transmitted
538 add_to_queue (struct GNUNET_MESH_Handle *h,
539 struct GNUNET_MESH_TransmitHandle *th)
541 struct GNUNET_MESH_TransmitHandle *p;
544 while ((NULL != p) && (th->priority <= p->priority))
550 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
551 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
554 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
555 (th->timeout), &timeout_transmission, th);
560 * Auxiliary function to send an already constructed packet to the service.
561 * Takes care of creating a new queue element, copying the message and
562 * calling the tmt_rdy function if necessary.
563 * @param h mesh handle
564 * @param msg message to transmit
567 send_packet (struct GNUNET_MESH_Handle *h,
568 const struct GNUNET_MessageHeader *msg);
572 * Reconnect callback: tries to reconnect again after a failer previous
574 * @param cls closure (mesh handle)
575 * @param tc task context
578 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
582 * Reconnect to the service, retransmit all infomation to try to restore the
585 * @param h handle to the mesh
587 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
590 reconnect (struct GNUNET_MESH_Handle *h)
592 struct GNUNET_MESH_Tunnel *t;
595 h->in_receive = GNUNET_NO;
599 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
601 if (NULL != h->client)
603 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
607 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
608 if (h->client == NULL)
610 GNUNET_SCHEDULER_add_delayed(h->reconnect_time, &reconnect_cbk, h);
611 h->reconnect_time = GNUNET_TIME_relative_min(GNUNET_TIME_UNIT_HOURS,
612 GNUNET_TIME_relative_multiply(h->reconnect_time, 2));
618 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
620 /* Rebuild all tunnels */
621 for (t = h->tunnels_head; NULL != t; t = t->next)
623 struct GNUNET_MESH_TunnelMessage tmsg;
624 struct GNUNET_MESH_PeerControl pmsg;
626 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
627 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
628 tmsg.tunnel_id = htonl (t->tid);
629 send_packet (h, &tmsg.header);
631 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
632 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
633 pmsg.tunnel_id = htonl (t->tid);
635 /* Reconnect all peers */
636 for (i = 0; i < t->npeers; i++)
638 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
639 if (NULL != t->disconnect_handler && t->peers[i]->connected)
640 t->disconnect_handler (t->cls, &pmsg.peer);
641 /* If the tunnel was "by type", dont connect individual peers */
643 send_packet (t->mesh, &pmsg.header);
645 /* Reconnect all types, if any */
646 for (i = 0; i < t->napps; i++)
648 struct GNUNET_MESH_ConnectPeerByType msg;
650 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
651 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
652 msg.tunnel_id = htonl (t->tid);
653 msg.type = htonl (t->apps[i]);
654 send_packet (t->mesh, &msg.header);
661 * Reconnect callback: tries to reconnect again after a failer previous
663 * @param cls closure (mesh handle)
664 * @param tc task context
667 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
669 struct GNUNET_MESH_Handle *h = cls;
670 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
676 /******************************************************************************/
677 /*********************** RECEIVE HANDLERS ****************************/
678 /******************************************************************************/
681 * Process the new tunnel notification and add it to the tunnels in the handle
683 * @param h The mesh handle
684 * @param msg A message with the details of the new incoming tunnel
687 process_tunnel_created (struct GNUNET_MESH_Handle *h,
688 const struct GNUNET_MESH_TunnelNotification *msg)
690 struct GNUNET_MESH_Tunnel *t;
691 struct GNUNET_TRANSPORT_ATS_Information atsi;
692 MESH_TunnelNumber tid;
694 tid = ntohl (msg->tunnel_id);
695 if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
700 t = create_tunnel (h, tid);
701 t->owner = GNUNET_PEER_intern (&msg->peer);
703 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
704 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
706 t->peers[0]->connected = 1;
707 t->peers[0]->id = t->owner;
710 if (NULL != h->new_tunnel)
714 t->ctx = h->new_tunnel(h->cls, t, &msg->peer, &atsi);
716 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
722 * Process the tunnel destroy notification and free associated resources
724 * @param h The mesh handle
725 * @param msg A message with the details of the tunnel being destroyed
728 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
729 const struct GNUNET_MESH_TunnelMessage *msg)
731 struct GNUNET_MESH_Tunnel *t;
732 MESH_TunnelNumber tid;
734 tid = ntohl (msg->tunnel_id);
735 t = retrieve_tunnel (h, tid);
753 * Process the new peer event and notify the upper level of it
755 * @param h The mesh handle
756 * @param msg A message with the details of the peer event
759 process_peer_event (struct GNUNET_MESH_Handle *h,
760 const struct GNUNET_MESH_PeerControl *msg)
762 struct GNUNET_MESH_Tunnel *t;
763 struct GNUNET_MESH_Peer *p;
764 struct GNUNET_TRANSPORT_ATS_Information atsi;
768 size = ntohs (msg->header.size);
769 if (size != sizeof (struct GNUNET_MESH_PeerControl))
774 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
780 id = GNUNET_PEER_search (&msg->peer);
781 if ((p = retrieve_peer (t, id)) == NULL)
782 p = add_peer_to_tunnel (t, &msg->peer);
783 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == msg->header.type)
785 if (NULL != t->connect_handler)
789 t->connect_handler (t->cls, &msg->peer, &atsi);
795 if (NULL != t->disconnect_handler && p->connected)
797 t->disconnect_handler (t->cls, &msg->peer);
799 remove_peer_from_tunnel (p);
806 * Process the incoming data packets
808 * @param h The mesh handle
809 * @param msh A message encapsulating the data
812 process_incoming_data (struct GNUNET_MESH_Handle *h,
813 const struct GNUNET_MessageHeader *message)
815 const struct GNUNET_MessageHeader *payload;
816 const struct GNUNET_MESH_MessageHandler *handler;
817 const struct GNUNET_PeerIdentity *peer;
818 struct GNUNET_MESH_Unicast *ucast;
819 struct GNUNET_MESH_Multicast *mcast;
820 struct GNUNET_MESH_ToOrigin *to_orig;
821 struct GNUNET_MESH_Tunnel *t;
826 type = ntohs (message->type);
829 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
830 ucast = (struct GNUNET_MESH_Unicast *) message;
831 t = retrieve_tunnel (h, ntohl (ucast->tid));
832 payload = (struct GNUNET_MessageHeader *) &ucast[1];
835 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
836 mcast = (struct GNUNET_MESH_Multicast *) message;
837 t = retrieve_tunnel (h, ntohl (mcast->tid));
838 payload = (struct GNUNET_MessageHeader *) &mcast[1];
841 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
842 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
843 t = retrieve_tunnel (h, ntohl (to_orig->tid));
844 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
845 peer = &to_orig->sender;
856 type = ntohs(payload->type);
857 for (i = 0; i < h->n_handlers; i++)
859 handler = &h->message_handlers[i];
860 if (handler->type == type)
862 struct GNUNET_TRANSPORT_ATS_Information atsi;
867 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
869 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
870 "MESH: callback caused disconnection\n");
871 GNUNET_MESH_disconnect (h);
876 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
877 "MESH: callback completed successfully\n");
887 * Function to process all messages received from the service
890 * @param msg message received, NULL on timeout or fatal error
893 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
895 struct GNUNET_MESH_Handle *h = cls;
897 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message from MESH\n");
903 switch (ntohs (msg->type))
905 /* Notify of a new incoming tunnel */
906 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
907 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
909 /* Notify of a tunnel disconnection */
910 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
911 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
913 /* Notify of a new peer or a peer disconnect in the tunnel */
914 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
915 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
916 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
918 /* Notify of a new data packet in the tunnel */
919 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
920 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
921 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
922 process_incoming_data (h, msg);
924 /* We shouldn't get any other packages, log and ignore */
926 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
927 "MESH: unsolicited message form service (type %d)\n",
930 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
931 GNUNET_CLIENT_receive (h->client, &msg_received, h,
932 GNUNET_TIME_UNIT_FOREVER_REL);
936 /******************************************************************************/
937 /************************ SEND FUNCTIONS ****************************/
938 /******************************************************************************/
941 * Function called to send a message to the service.
942 * "buf" will be NULL and "size" zero if the socket was closed for writing in
945 * @param cls closure, the mesh handle
946 * @param size number of bytes available in buf
947 * @param buf where the callee should write the connect message
948 * @return number of bytes written to buf
951 send_callback (void *cls, size_t size, void *buf)
953 struct GNUNET_MESH_Handle *h = cls;
954 struct GNUNET_MESH_TransmitHandle *th;
959 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
961 if ((0 == size) || (NULL == buf))
967 while ((NULL != (th = h->th_head)) && (size >= th->size))
970 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: type: %u\n",
971 ntohs (((struct GNUNET_MessageHeader *)&th[1])->type));
972 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: size: %u\n",
973 ntohs (((struct GNUNET_MessageHeader *)&th[1])->size));
975 if (NULL != th->notify)
980 struct GNUNET_MESH_Multicast mc;
982 GNUNET_assert (size >= sizeof (mc) + th->size);
984 th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
987 mc.header.size = htons (sizeof (mc) + th->size);
988 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
989 mc.tid = htonl (th->tunnel->tid);
990 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
991 memcpy (cbuf, &mc, sizeof (mc));
992 psize = th->size + sizeof (mc);
998 struct GNUNET_MESH_Unicast uc;
1000 GNUNET_assert (size >= sizeof (uc) + th->size);
1002 th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
1005 uc.header.size = htons (sizeof (uc) + th->size);
1006 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1007 uc.tid = htonl (th->tunnel->tid);
1008 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
1009 GNUNET_PEER_resolve (th->target, &uc.destination);
1010 memcpy (cbuf, &uc, sizeof (uc));
1011 psize = th->size + sizeof (uc);
1017 memcpy (cbuf, &th[1], th->size);
1020 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1021 GNUNET_SCHEDULER_cancel (th->timeout_task);
1022 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1028 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
1029 if (NULL != (th = h->th_head))
1031 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
1033 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1034 GNUNET_TIME_UNIT_FOREVER_REL,
1035 GNUNET_YES, &send_callback, h);
1037 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1038 if (GNUNET_NO == h->in_receive)
1040 h->in_receive = GNUNET_YES;
1041 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1042 GNUNET_TIME_UNIT_FOREVER_REL);
1049 * Auxiliary function to send an already constructed packet to the service.
1050 * Takes care of creating a new queue element, copying the message and
1051 * calling the tmt_rdy function if necessary.
1052 * @param h mesh handle
1053 * @param msg message to transmit
1056 send_packet (struct GNUNET_MESH_Handle *h,
1057 const struct GNUNET_MessageHeader *msg)
1059 struct GNUNET_MESH_TransmitHandle *th;
1062 msize = ntohs (msg->size);
1063 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1064 th->priority = UINT32_MAX;
1065 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1067 memcpy (&th[1], msg, msize);
1068 add_to_queue (h, th);
1072 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1073 GNUNET_TIME_UNIT_FOREVER_REL,
1074 GNUNET_YES, &send_callback, h);
1078 /******************************************************************************/
1079 /********************** API CALL DEFINITIONS *************************/
1080 /******************************************************************************/
1083 * Connect to the mesh service.
1085 * @param cfg configuration to use
1086 * @param queue_size size of the data message queue, shared among all tunnels
1087 * (each tunnel is guaranteed to accept at least one message,
1088 * no matter what is the status of other tunnels)
1089 * @param cls closure for the various callbacks that follow
1090 * (including handlers in the handlers array)
1091 * @param new_tunnel function called when an *inbound* tunnel is created
1092 * @param cleaner function called when an *inbound* tunnel is destroyed
1093 * @param handlers callbacks for messages we care about, NULL-terminated
1094 * note that the mesh is allowed to drop notifications about
1095 * inbound messages if the client does not process them fast
1096 * enough (for this notification type, a bounded queue is used)
1097 * @param stypes list of the applications that this client claims to provide
1098 * @return handle to the mesh service NULL on error
1099 * (in this case, init is never called)
1101 struct GNUNET_MESH_Handle *
1102 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1103 unsigned int queue_size, void *cls,
1104 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1105 GNUNET_MESH_TunnelEndHandler cleaner,
1106 const struct GNUNET_MESH_MessageHandler *handlers,
1107 const GNUNET_MESH_ApplicationType *stypes)
1109 struct GNUNET_MESH_Handle *h;
1110 struct GNUNET_MESH_ClientConnect *msg;
1111 GNUNET_MESH_ApplicationType *apps;
1117 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1118 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1120 h->max_queue_size = queue_size;
1121 h->new_tunnel = new_tunnel;
1122 h->cleaner = cleaner;
1123 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1124 if (h->client == NULL)
1131 h->message_handlers = handlers;
1132 h->applications = stypes;
1133 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1134 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1136 /* count handlers and apps, calculate size */
1137 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1138 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1139 size = sizeof (struct GNUNET_MESH_ClientConnect);
1140 size += h->n_handlers * sizeof (uint16_t);
1141 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
1146 /* build connection packet */
1147 msg = (struct GNUNET_MESH_ClientConnect *) buf;
1148 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
1149 msg->header.size = htons (size);
1150 types = (uint16_t *) & msg[1];
1151 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
1152 types[ntypes] = h->message_handlers[ntypes].type;
1153 apps = (GNUNET_MESH_ApplicationType *) &types[ntypes];
1154 for (napps = 0; napps < h->n_applications; napps++)
1155 apps[napps] = h->applications[napps];
1156 msg->applications = htons (napps);
1157 msg->types = htons (ntypes);
1159 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1160 "mesh: Sending %lu bytes long message %d types and %d apps\n",
1161 ntohs (msg->header.size), ntypes, napps);
1163 send_packet (h, &msg->header);
1165 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1171 * Disconnect from the mesh service.
1173 * @param handle connection to mesh to disconnect
1176 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1178 struct GNUNET_MESH_Tunnel *t;
1180 for (t = handle->tunnels_head; NULL != t; t = t->next)
1184 if (NULL != handle->th)
1186 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1188 if (NULL != handle->client)
1190 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1192 GNUNET_free (handle);
1197 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1198 * and to broadcast).
1200 * @param h mesh handle
1201 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1202 * @param connect_handler function to call when peers are actually connected
1203 * @param disconnect_handler function to call when peers are disconnected
1204 * @param handler_cls closure for connect/disconnect handlers
1206 struct GNUNET_MESH_Tunnel *
1207 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1208 GNUNET_MESH_TunnelConnectHandler connect_handler,
1209 GNUNET_MESH_TunnelDisconnectHandler
1210 disconnect_handler, void *handler_cls)
1212 struct GNUNET_MESH_Tunnel *t;
1213 struct GNUNET_MESH_TunnelMessage msg;
1215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1216 t = create_tunnel (h, 0);
1217 t->connect_handler = connect_handler;
1218 t->disconnect_handler = disconnect_handler;
1219 t->cls = handler_cls;
1220 t->ctx = tunnel_ctx;
1221 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1222 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1223 msg.tunnel_id = htonl (t->tid);
1224 send_packet (h, &msg.header);
1230 * Destroy an existing tunnel.
1232 * @param tun tunnel handle
1235 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *t)
1237 struct GNUNET_MESH_Handle *h;
1238 struct GNUNET_MESH_TunnelMessage msg;
1240 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1244 GNUNET_PEER_change_rc (t->owner, -1);
1246 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1247 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1248 msg.tunnel_id = htonl (t->tid);
1250 send_packet (h, &msg.header);
1255 * Request that a peer should be added to the tunnel. The existing
1256 * connect handler will be called ONCE with either success or failure.
1257 * This function should NOT be called again with the same peer before the
1258 * connect handler is called.
1260 * @param tunnel handle to existing tunnel
1261 * @param timeout how long to try to establish a connection
1262 * @param peer peer to add
1265 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1266 const struct GNUNET_PeerIdentity *peer)
1268 struct GNUNET_MESH_PeerControl msg;
1269 GNUNET_PEER_Id peer_id;
1272 peer_id = GNUNET_PEER_intern (peer);
1273 for (i = 0; i < tunnel->npeers; i++)
1275 if (tunnel->peers[i]->id == peer_id)
1277 GNUNET_PEER_change_rc (peer_id, -1);
1282 if (NULL == add_peer_to_tunnel (tunnel, peer))
1285 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1286 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1287 msg.tunnel_id = htonl (tunnel->tid);
1289 send_packet (tunnel->mesh, &msg.header);
1296 * Request that a peer should be removed from the tunnel. The existing
1297 * disconnect handler will be called ONCE if we were connected.
1299 * @param tunnel handle to existing tunnel
1300 * @param peer peer to remove
1303 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1304 const struct GNUNET_PeerIdentity *peer)
1306 struct GNUNET_MESH_PeerControl msg;
1307 GNUNET_PEER_Id peer_id;
1310 peer_id = GNUNET_PEER_search (peer);
1316 for (i = 0; i < tunnel->npeers; i++)
1317 if (tunnel->peers[i]->id == peer_id)
1319 if (i == tunnel->npeers)
1324 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1325 tunnel->disconnect_handler (tunnel->cls, peer);
1326 GNUNET_PEER_change_rc (peer_id, -1);
1327 GNUNET_free (tunnel->peers[i]);
1328 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1329 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1331 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1332 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1333 msg.tunnel_id = htonl (tunnel->tid);
1334 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1335 send_packet (tunnel->mesh, &msg.header);
1340 * Request that the mesh should try to connect to a peer supporting the given
1343 * @param tunnel handle to existing tunnel
1344 * @param app_type application type that must be supported by the peer (MESH
1345 * should discover peer in proximity handling this type)
1348 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1349 GNUNET_MESH_ApplicationType app_type)
1351 struct GNUNET_MESH_ConnectPeerByType msg;
1353 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1355 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1356 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1357 msg.tunnel_id = htonl (tunnel->tid);
1358 msg.type = htonl (app_type);
1359 send_packet (tunnel->mesh, &msg.header);
1364 * Ask the mesh to call "notify" once it is ready to transmit the
1365 * given number of bytes to the specified "target". If we are not yet
1366 * connected to the specified peer, a call to this function will cause
1367 * us to try to establish a connection.
1369 * @param tunnel tunnel to use for transmission
1370 * @param cork is corking allowed for this transmission?
1371 * @param priority how important is the message?
1372 * @param maxdelay how long can the message wait?
1373 * @param target destination for the message,
1374 * NULL for multicast to all tunnel targets
1375 * @param notify_size how many bytes of buffer space does notify want?
1376 * @param notify function to call when buffer space is available;
1377 * will be called with NULL on timeout or if the overall queue
1378 * for this peer is larger than queue_size and this is currently
1379 * the message with the lowest priority
1380 * @param notify_cls closure for notify
1381 * @return non-NULL if the notify callback was queued,
1382 * NULL if we can not even queue the request (insufficient
1383 * memory); if NULL is returned, "notify" will NOT be called.
1385 struct GNUNET_MESH_TransmitHandle *
1386 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1388 struct GNUNET_TIME_Relative maxdelay,
1389 const struct GNUNET_PeerIdentity *target,
1391 GNUNET_CONNECTION_TransmitReadyNotify notify,
1394 struct GNUNET_MESH_TransmitHandle *th;
1395 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1396 uint32_t least_priority;
1399 GNUNET_assert(NULL != notify);
1400 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1401 tunnel->npackets > 0)
1406 th = tunnel->mesh->th_tail;
1407 least_priority = priority;
1408 least_priority_th = NULL;
1411 if (th->priority < least_priority && th->tunnel->npackets > 1)
1413 least_priority_th = th;
1414 least_priority = th->priority;
1418 if (NULL == least_priority_th)
1420 GNUNET_assert(NULL != least_priority_th->notify); /* Cant be a cntrl msg */
1421 least_priority_th->notify(notify_cls, 0, NULL);
1422 least_priority_th->tunnel->npackets--;
1423 tunnel->mesh->npackets--;
1424 GNUNET_CONTAINER_DLL_remove(tunnel->mesh->th_head,
1425 tunnel->mesh->th_tail,
1427 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1428 GNUNET_SCHEDULER_cancel(least_priority_th->timeout_task);
1429 GNUNET_free(least_priority_th);
1432 tunnel->mesh->npackets++;
1433 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1434 th->tunnel = tunnel;
1435 th->priority = priority;
1436 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1437 th->target = GNUNET_PEER_intern (target);
1440 target) ? sizeof (struct GNUNET_MESH_Multicast) : sizeof (struct
1441 GNUNET_MESH_Unicast);
1442 th->size = notify_size + overhead;
1443 th->notify = notify;
1444 th->notify_cls = notify_cls;
1445 add_to_queue (tunnel->mesh, th);
1451 * Cancel the specified transmission-ready notification.
1453 * @param th handle that was returned by "notify_transmit_ready".
1456 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1458 struct GNUNET_MESH_Handle *mesh;
1460 mesh = th->tunnel->mesh;
1461 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1462 GNUNET_SCHEDULER_cancel (th->timeout_task);
1463 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1465 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1467 /* queue empty, no point in asking for transmission */
1468 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1474 #if 0 /* keep Emacsens' auto-indent happy */