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);
436 * Get the peer descriptor for the peer with id from the given tunnel
437 * @param t Tunnel handle
438 * @param id Short form ID of the wanted peer
439 * @return handle to the requested peer or NULL if not found
441 static struct GNUNET_MESH_Peer *
442 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
446 for (i = 0; i < t->npeers; i++)
447 if (t->peers[i]->id == id)
454 * Add a peer into a tunnel
455 * @param t Tunnel handle
456 * @param pi Full ID of the new peer
457 * @return handle to the newly created peer
459 static struct GNUNET_MESH_Peer *
460 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
461 const struct GNUNET_PeerIdentity *pi)
463 struct GNUNET_MESH_Peer *p;
471 id = GNUNET_PEER_intern (pi);
473 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
476 GNUNET_array_append (t->peers, t->npeers, p);
482 * Remove a peer from a tunnel
483 * @param t Tunnel handle
484 * @param p Peer handle
487 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
491 for (i = 0; i < p->t->npeers; i++)
493 if (p->t->peers[i] == p)
496 if (i == p->t->npeers)
501 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
502 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
507 * Notify client that the transmission has timed out
509 * @param tc task context
512 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
514 struct GNUNET_MESH_TransmitHandle *th = cls;
515 struct GNUNET_MESH_Handle *mesh;
517 mesh = th->tunnel->mesh;
518 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
519 if (th->notify != NULL)
520 th->notify (th->notify_cls, 0, NULL);
522 if ((NULL == mesh->th_head) && (NULL != mesh->th))
524 /* queue empty, no point in asking for transmission */
525 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
532 * Add a transmit handle to the transmission queue by priority and set the
535 * @param h mesh handle with the queue head and tail
536 * @param q handle to the packet to be transmitted
539 add_to_queue (struct GNUNET_MESH_Handle *h,
540 struct GNUNET_MESH_TransmitHandle *th)
542 struct GNUNET_MESH_TransmitHandle *p;
545 while ((NULL != p) && (th->priority <= p->priority))
551 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
552 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
555 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
556 (th->timeout), &timeout_transmission, th);
561 * Auxiliary function to send an already constructed packet to the service.
562 * Takes care of creating a new queue element, copying the message and
563 * calling the tmt_rdy function if necessary.
564 * @param h mesh handle
565 * @param msg message to transmit
568 send_packet (struct GNUNET_MESH_Handle *h,
569 const struct GNUNET_MessageHeader *msg);
573 * Reconnect callback: tries to reconnect again after a failer previous
575 * @param cls closure (mesh handle)
576 * @param tc task context
579 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
583 * Reconnect to the service, retransmit all infomation to try to restore the
586 * @param h handle to the mesh
588 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
591 reconnect (struct GNUNET_MESH_Handle *h)
593 struct GNUNET_MESH_Tunnel *t;
596 h->in_receive = GNUNET_NO;
600 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
602 if (NULL != h->client)
604 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
608 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
609 if (h->client == NULL)
611 GNUNET_SCHEDULER_add_delayed(h->reconnect_time, &reconnect_cbk, h);
612 h->reconnect_time = GNUNET_TIME_relative_min(GNUNET_TIME_UNIT_HOURS,
613 GNUNET_TIME_relative_multiply(h->reconnect_time, 2));
619 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
621 /* Rebuild all tunnels */
622 for (t = h->tunnels_head; NULL != t; t = t->next)
624 struct GNUNET_MESH_TunnelMessage tmsg;
625 struct GNUNET_MESH_PeerControl pmsg;
627 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
628 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
629 tmsg.tunnel_id = htonl (t->tid);
630 send_packet (h, &tmsg.header);
632 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
633 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
634 pmsg.tunnel_id = htonl (t->tid);
636 /* Reconnect all peers */
637 for (i = 0; i < t->npeers; i++)
639 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
640 if (NULL != t->disconnect_handler && t->peers[i]->connected)
641 t->disconnect_handler (t->cls, &pmsg.peer);
642 /* If the tunnel was "by type", dont connect individual peers */
644 send_packet (t->mesh, &pmsg.header);
646 /* Reconnect all types, if any */
647 for (i = 0; i < t->napps; i++)
649 struct GNUNET_MESH_ConnectPeerByType msg;
651 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
652 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
653 msg.tunnel_id = htonl (t->tid);
654 msg.type = htonl (t->apps[i]);
655 send_packet (t->mesh, &msg.header);
662 * Reconnect callback: tries to reconnect again after a failer previous
664 * @param cls closure (mesh handle)
665 * @param tc task context
668 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
670 struct GNUNET_MESH_Handle *h = cls;
671 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
677 /******************************************************************************/
678 /*********************** RECEIVE HANDLERS ****************************/
679 /******************************************************************************/
682 * Process the new tunnel notification and add it to the tunnels in the handle
684 * @param h The mesh handle
685 * @param msg A message with the details of the new incoming tunnel
688 process_tunnel_created (struct GNUNET_MESH_Handle *h,
689 const struct GNUNET_MESH_TunnelNotification *msg)
691 struct GNUNET_MESH_Tunnel *t;
692 struct GNUNET_TRANSPORT_ATS_Information atsi;
693 MESH_TunnelNumber tid;
695 tid = ntohl (msg->tunnel_id);
696 if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
701 t = create_tunnel (h, tid);
702 t->owner = GNUNET_PEER_intern (&msg->peer);
704 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
705 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
707 t->peers[0]->connected = 1;
708 t->peers[0]->id = t->owner;
711 if (NULL != h->new_tunnel)
715 t->ctx = h->new_tunnel(h->cls, t, &msg->peer, &atsi);
717 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
723 * Process the tunnel destroy notification and free associated resources
725 * @param h The mesh handle
726 * @param msg A message with the details of the tunnel being destroyed
729 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
730 const struct GNUNET_MESH_TunnelMessage *msg)
732 struct GNUNET_MESH_Tunnel *t;
733 MESH_TunnelNumber tid;
735 tid = ntohl (msg->tunnel_id);
736 t = retrieve_tunnel (h, tid);
754 * Process the new peer event and notify the upper level of it
756 * @param h The mesh handle
757 * @param msg A message with the details of the peer event
760 process_peer_event (struct GNUNET_MESH_Handle *h,
761 const struct GNUNET_MESH_PeerControl *msg)
763 struct GNUNET_MESH_Tunnel *t;
764 struct GNUNET_MESH_Peer *p;
765 struct GNUNET_TRANSPORT_ATS_Information atsi;
769 size = ntohs (msg->header.size);
770 if (size != sizeof (struct GNUNET_MESH_PeerControl))
775 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
781 id = GNUNET_PEER_search (&msg->peer);
782 if ((p = retrieve_peer (t, id)) == NULL)
783 p = add_peer_to_tunnel (t, &msg->peer);
784 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == msg->header.type)
786 if (NULL != t->connect_handler)
790 t->connect_handler (t->cls, &msg->peer, &atsi);
796 if (NULL != t->disconnect_handler && p->connected)
798 t->disconnect_handler (t->cls, &msg->peer);
800 remove_peer_from_tunnel (p);
807 * Process the incoming data packets
809 * @param h The mesh handle
810 * @param msh A message encapsulating the data
813 process_incoming_data (struct GNUNET_MESH_Handle *h,
814 const struct GNUNET_MessageHeader *message)
816 const struct GNUNET_MessageHeader *payload;
817 const struct GNUNET_MESH_MessageHandler *handler;
818 const struct GNUNET_PeerIdentity *peer;
819 struct GNUNET_MESH_Unicast *ucast;
820 struct GNUNET_MESH_Multicast *mcast;
821 struct GNUNET_MESH_ToOrigin *to_orig;
822 struct GNUNET_MESH_Tunnel *t;
827 type = ntohs (message->type);
830 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
831 ucast = (struct GNUNET_MESH_Unicast *) message;
832 t = retrieve_tunnel (h, ntohl (ucast->tid));
833 payload = (struct GNUNET_MessageHeader *) &ucast[1];
836 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
837 mcast = (struct GNUNET_MESH_Multicast *) message;
838 t = retrieve_tunnel (h, ntohl (mcast->tid));
839 payload = (struct GNUNET_MessageHeader *) &mcast[1];
842 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
843 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
844 t = retrieve_tunnel (h, ntohl (to_orig->tid));
845 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
846 peer = &to_orig->sender;
857 type = ntohs(payload->type);
858 for (i = 0; i < h->n_handlers; i++)
860 handler = &h->message_handlers[i];
861 if (handler->type == type)
863 struct GNUNET_TRANSPORT_ATS_Information atsi;
868 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
870 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
871 "MESH: callback caused disconnection\n");
872 GNUNET_MESH_disconnect (h);
877 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
878 "MESH: callback completed successfully\n");
888 * Function to process all messages received from the service
891 * @param msg message received, NULL on timeout or fatal error
894 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
896 struct GNUNET_MESH_Handle *h = cls;
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message from MESH\n");
904 switch (ntohs (msg->type))
906 /* Notify of a new incoming tunnel */
907 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
908 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
910 /* Notify of a tunnel disconnection */
911 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
912 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
914 /* Notify of a new peer or a peer disconnect in the tunnel */
915 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
916 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
917 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
919 /* Notify of a new data packet in the tunnel */
920 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
921 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
922 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
923 process_incoming_data (h, msg);
925 /* We shouldn't get any other packages, log and ignore */
927 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
928 "MESH: unsolicited message form service (type %d)\n",
931 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
932 GNUNET_CLIENT_receive (h->client, &msg_received, h,
933 GNUNET_TIME_UNIT_FOREVER_REL);
937 /******************************************************************************/
938 /************************ SEND FUNCTIONS ****************************/
939 /******************************************************************************/
942 * Function called to send a message to the service.
943 * "buf" will be NULL and "size" zero if the socket was closed for writing in
946 * @param cls closure, the mesh handle
947 * @param size number of bytes available in buf
948 * @param buf where the callee should write the connect message
949 * @return number of bytes written to buf
952 send_callback (void *cls, size_t size, void *buf)
954 struct GNUNET_MESH_Handle *h = cls;
955 struct GNUNET_MESH_TransmitHandle *th;
960 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
962 if ((0 == size) || (NULL == buf))
968 while ((NULL != (th = h->th_head)) && (size >= th->size))
971 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: type: %u\n",
972 ntohs (((struct GNUNET_MessageHeader *)&th[1])->type));
973 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: size: %u\n",
974 ntohs (((struct GNUNET_MessageHeader *)&th[1])->size));
976 if (NULL != th->notify)
981 struct GNUNET_MESH_Multicast mc;
983 GNUNET_assert (size >= sizeof (mc) + th->size);
985 th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
988 mc.header.size = htons (sizeof (mc) + th->size);
989 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
990 mc.tid = htonl (th->tunnel->tid);
991 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
992 memcpy (cbuf, &mc, sizeof (mc));
993 psize = th->size + sizeof (mc);
999 struct GNUNET_MESH_Unicast uc;
1001 GNUNET_assert (size >= sizeof (uc) + th->size);
1003 th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
1006 uc.header.size = htons (sizeof (uc) + th->size);
1007 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1008 uc.tid = htonl (th->tunnel->tid);
1009 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
1010 GNUNET_PEER_resolve (th->target, &uc.destination);
1011 memcpy (cbuf, &uc, sizeof (uc));
1012 psize = th->size + sizeof (uc);
1018 memcpy (cbuf, &th[1], th->size);
1021 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1022 GNUNET_SCHEDULER_cancel (th->timeout_task);
1023 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1029 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
1030 if (NULL != (th = h->th_head))
1032 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
1034 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1035 GNUNET_TIME_UNIT_FOREVER_REL,
1036 GNUNET_YES, &send_callback, h);
1038 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1039 if (GNUNET_NO == h->in_receive)
1041 h->in_receive = GNUNET_YES;
1042 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1043 GNUNET_TIME_UNIT_FOREVER_REL);
1050 * Auxiliary function to send an already constructed packet to the service.
1051 * Takes care of creating a new queue element, copying the message and
1052 * calling the tmt_rdy function if necessary.
1053 * @param h mesh handle
1054 * @param msg message to transmit
1057 send_packet (struct GNUNET_MESH_Handle *h,
1058 const struct GNUNET_MessageHeader *msg)
1060 struct GNUNET_MESH_TransmitHandle *th;
1063 msize = ntohs (msg->size);
1064 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1065 th->priority = UINT32_MAX;
1066 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1068 memcpy (&th[1], msg, msize);
1069 add_to_queue (h, th);
1073 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1074 GNUNET_TIME_UNIT_FOREVER_REL,
1075 GNUNET_YES, &send_callback, h);
1079 /******************************************************************************/
1080 /********************** API CALL DEFINITIONS *************************/
1081 /******************************************************************************/
1084 * Connect to the mesh service.
1086 * @param cfg configuration to use
1087 * @param queue_size size of the data message queue, shared among all tunnels
1088 * (each tunnel is guaranteed to accept at least one message,
1089 * no matter what is the status of other tunnels)
1090 * @param cls closure for the various callbacks that follow
1091 * (including handlers in the handlers array)
1092 * @param new_tunnel function called when an *inbound* tunnel is created
1093 * @param cleaner function called when an *inbound* tunnel is destroyed
1094 * @param handlers callbacks for messages we care about, NULL-terminated
1095 * note that the mesh is allowed to drop notifications about
1096 * inbound messages if the client does not process them fast
1097 * enough (for this notification type, a bounded queue is used)
1098 * @param stypes list of the applications that this client claims to provide
1099 * @return handle to the mesh service NULL on error
1100 * (in this case, init is never called)
1102 struct GNUNET_MESH_Handle *
1103 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1104 unsigned int queue_size, void *cls,
1105 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1106 GNUNET_MESH_TunnelEndHandler cleaner,
1107 const struct GNUNET_MESH_MessageHandler *handlers,
1108 const GNUNET_MESH_ApplicationType *stypes)
1110 struct GNUNET_MESH_Handle *h;
1111 struct GNUNET_MESH_ClientConnect *msg;
1112 GNUNET_MESH_ApplicationType *apps;
1118 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1119 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1121 h->max_queue_size = queue_size;
1122 h->new_tunnel = new_tunnel;
1123 h->cleaner = cleaner;
1124 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1125 if (h->client == NULL)
1132 h->message_handlers = handlers;
1133 h->applications = stypes;
1134 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1135 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1137 /* count handlers and apps, calculate size */
1138 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1139 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1140 size = sizeof (struct GNUNET_MESH_ClientConnect);
1141 size += h->n_handlers * sizeof (uint16_t);
1142 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
1147 /* build connection packet */
1148 msg = (struct GNUNET_MESH_ClientConnect *) buf;
1149 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
1150 msg->header.size = htons (size);
1151 types = (uint16_t *) & msg[1];
1152 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
1153 types[ntypes] = h->message_handlers[ntypes].type;
1154 apps = (GNUNET_MESH_ApplicationType *) &types[ntypes];
1155 for (napps = 0; napps < h->n_applications; napps++)
1156 apps[napps] = h->applications[napps];
1157 msg->applications = htons (napps);
1158 msg->types = htons (ntypes);
1160 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1161 "mesh: Sending %lu bytes long message %d types and %d apps\n",
1162 ntohs (msg->header.size), ntypes, napps);
1164 send_packet (h, &msg->header);
1166 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1172 * Disconnect from the mesh service.
1174 * @param handle connection to mesh to disconnect
1177 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1179 struct GNUNET_MESH_Tunnel *t;
1180 struct GNUNET_MESH_Tunnel *aux;
1182 t = handle->tunnels_head;
1189 if (NULL != handle->th)
1191 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1193 if (NULL != handle->client)
1195 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1197 GNUNET_free (handle);
1202 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1203 * and to broadcast).
1205 * @param h mesh handle
1206 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1207 * @param connect_handler function to call when peers are actually connected
1208 * @param disconnect_handler function to call when peers are disconnected
1209 * @param handler_cls closure for connect/disconnect handlers
1211 struct GNUNET_MESH_Tunnel *
1212 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1213 GNUNET_MESH_TunnelConnectHandler connect_handler,
1214 GNUNET_MESH_TunnelDisconnectHandler
1215 disconnect_handler, void *handler_cls)
1217 struct GNUNET_MESH_Tunnel *t;
1218 struct GNUNET_MESH_TunnelMessage msg;
1220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1221 t = create_tunnel (h, 0);
1222 t->connect_handler = connect_handler;
1223 t->disconnect_handler = disconnect_handler;
1224 t->cls = handler_cls;
1225 t->ctx = tunnel_ctx;
1226 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1227 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1228 msg.tunnel_id = htonl (t->tid);
1229 send_packet (h, &msg.header);
1235 * Destroy an existing tunnel.
1237 * @param tun tunnel handle
1240 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *t)
1242 struct GNUNET_MESH_Handle *h;
1243 struct GNUNET_MESH_TunnelMessage msg;
1245 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1249 GNUNET_PEER_change_rc (t->owner, -1);
1251 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1252 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1253 msg.tunnel_id = htonl (t->tid);
1255 send_packet (h, &msg.header);
1260 * Request that a peer should be added to the tunnel. The existing
1261 * connect handler will be called ONCE with either success or failure.
1262 * This function should NOT be called again with the same peer before the
1263 * connect handler is called.
1265 * @param tunnel handle to existing tunnel
1266 * @param timeout how long to try to establish a connection
1267 * @param peer peer to add
1270 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1271 const struct GNUNET_PeerIdentity *peer)
1273 struct GNUNET_MESH_PeerControl msg;
1274 GNUNET_PEER_Id peer_id;
1277 peer_id = GNUNET_PEER_intern (peer);
1278 for (i = 0; i < tunnel->npeers; i++)
1280 if (tunnel->peers[i]->id == peer_id)
1282 GNUNET_PEER_change_rc (peer_id, -1);
1287 if (NULL == add_peer_to_tunnel (tunnel, peer))
1290 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1291 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1292 msg.tunnel_id = htonl (tunnel->tid);
1294 send_packet (tunnel->mesh, &msg.header);
1301 * Request that a peer should be removed from the tunnel. The existing
1302 * disconnect handler will be called ONCE if we were connected.
1304 * @param tunnel handle to existing tunnel
1305 * @param peer peer to remove
1308 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1309 const struct GNUNET_PeerIdentity *peer)
1311 struct GNUNET_MESH_PeerControl msg;
1312 GNUNET_PEER_Id peer_id;
1315 peer_id = GNUNET_PEER_search (peer);
1321 for (i = 0; i < tunnel->npeers; i++)
1322 if (tunnel->peers[i]->id == peer_id)
1324 if (i == tunnel->npeers)
1329 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1330 tunnel->disconnect_handler (tunnel->cls, peer);
1331 GNUNET_PEER_change_rc (peer_id, -1);
1332 GNUNET_free (tunnel->peers[i]);
1333 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1334 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1336 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1337 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1338 msg.tunnel_id = htonl (tunnel->tid);
1339 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1340 send_packet (tunnel->mesh, &msg.header);
1345 * Request that the mesh should try to connect to a peer supporting the given
1348 * @param tunnel handle to existing tunnel
1349 * @param app_type application type that must be supported by the peer (MESH
1350 * should discover peer in proximity handling this type)
1353 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1354 GNUNET_MESH_ApplicationType app_type)
1356 struct GNUNET_MESH_ConnectPeerByType msg;
1358 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1360 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1361 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1362 msg.tunnel_id = htonl (tunnel->tid);
1363 msg.type = htonl (app_type);
1364 send_packet (tunnel->mesh, &msg.header);
1369 * Ask the mesh to call "notify" once it is ready to transmit the
1370 * given number of bytes to the specified "target". If we are not yet
1371 * connected to the specified peer, a call to this function will cause
1372 * us to try to establish a connection.
1374 * @param tunnel tunnel to use for transmission
1375 * @param cork is corking allowed for this transmission?
1376 * @param priority how important is the message?
1377 * @param maxdelay how long can the message wait?
1378 * @param target destination for the message,
1379 * NULL for multicast to all tunnel targets
1380 * @param notify_size how many bytes of buffer space does notify want?
1381 * @param notify function to call when buffer space is available;
1382 * will be called with NULL on timeout or if the overall queue
1383 * for this peer is larger than queue_size and this is currently
1384 * the message with the lowest priority
1385 * @param notify_cls closure for notify
1386 * @return non-NULL if the notify callback was queued,
1387 * NULL if we can not even queue the request (insufficient
1388 * memory); if NULL is returned, "notify" will NOT be called.
1390 struct GNUNET_MESH_TransmitHandle *
1391 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1393 struct GNUNET_TIME_Relative maxdelay,
1394 const struct GNUNET_PeerIdentity *target,
1396 GNUNET_CONNECTION_TransmitReadyNotify notify,
1399 struct GNUNET_MESH_TransmitHandle *th;
1400 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1401 uint32_t least_priority;
1404 GNUNET_assert(NULL != notify);
1405 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1406 tunnel->npackets > 0)
1411 th = tunnel->mesh->th_tail;
1412 least_priority = priority;
1413 least_priority_th = NULL;
1416 if (th->priority < least_priority && th->tunnel->npackets > 1)
1418 least_priority_th = th;
1419 least_priority = th->priority;
1423 if (NULL == least_priority_th)
1425 GNUNET_assert(NULL != least_priority_th->notify); /* Cant be a cntrl msg */
1426 least_priority_th->notify(notify_cls, 0, NULL);
1427 least_priority_th->tunnel->npackets--;
1428 tunnel->mesh->npackets--;
1429 GNUNET_CONTAINER_DLL_remove(tunnel->mesh->th_head,
1430 tunnel->mesh->th_tail,
1432 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1433 GNUNET_SCHEDULER_cancel(least_priority_th->timeout_task);
1434 GNUNET_free(least_priority_th);
1437 tunnel->mesh->npackets++;
1438 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1439 th->tunnel = tunnel;
1440 th->priority = priority;
1441 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1442 th->target = GNUNET_PEER_intern (target);
1445 target) ? sizeof (struct GNUNET_MESH_Multicast) : sizeof (struct
1446 GNUNET_MESH_Unicast);
1447 th->size = notify_size + overhead;
1448 th->notify = notify;
1449 th->notify_cls = notify_cls;
1450 add_to_queue (tunnel->mesh, th);
1456 * Cancel the specified transmission-ready notification.
1458 * @param th handle that was returned by "notify_transmit_ready".
1461 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1463 struct GNUNET_MESH_Handle *mesh;
1465 mesh = th->tunnel->mesh;
1466 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1467 GNUNET_SCHEDULER_cancel (th->timeout_task);
1468 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1470 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1472 /* queue empty, no point in asking for transmission */
1473 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1479 #if 0 /* keep Emacsens' auto-indent happy */