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
24 * - callbacks to client missing on certain events
25 * - processing messages from service is incomplete
26 * - Use separate message types for tunnel creation s -> c (+pi) and c -> s
31 * - AUXILIARY FUNCTIONS
34 * - API CALL DEFINITIONS
39 #if 0 /* keep Emacsens' auto-indent happy */
45 #include "gnunet_common.h"
46 #include "gnunet_client_lib.h"
47 #include "gnunet_util_lib.h"
48 #include "gnunet_peer_lib.h"
49 #include "gnunet_mesh_service_new.h"
51 #include "mesh_protocol.h"
53 #define DEBUG GNUNET_YES
55 /******************************************************************************/
56 /************************ DATA STRUCTURES ****************************/
57 /******************************************************************************/
60 * Transmission queue to the service
62 struct GNUNET_MESH_TransmitHandle
68 struct GNUNET_MESH_TransmitHandle *next;
73 struct GNUNET_MESH_TransmitHandle *prev;
76 * Tunnel this message is sent over (may be NULL for control messages).
78 struct GNUNET_MESH_Tunnel *tunnel;
81 * Callback to obtain the message to transmit, or NULL if we
82 * got the message in 'data'. Notice that messages built
83 * by 'notify' need to be encapsulated with information about
86 GNUNET_CONNECTION_TransmitReadyNotify notify;
89 * Closure for 'notify'
94 * How long is this message valid. Once the timeout has been
95 * reached, the message must no longer be sent. If this
96 * is a message with a 'notify' callback set, the 'notify'
97 * function should be called with 'buf' NULL and size 0.
99 struct GNUNET_TIME_Absolute timeout;
102 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
104 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
107 * Priority of the message. The queue is sorted by priority,
108 * control messages have the maximum priority (UINT32_MAX).
113 * Target of the message, 0 for broadcast. This field
114 * is only valid if 'notify' is non-NULL.
116 GNUNET_PEER_Id target;
119 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
126 * Opaque handle to the service.
128 struct GNUNET_MESH_Handle
132 * Handle to the server connection, to send messages later
134 struct GNUNET_CLIENT_Connection *client;
137 * Set of handlers used for processing incoming messages in the tunnels
139 const struct GNUNET_MESH_MessageHandler *message_handlers;
142 * Set of applications that should be claimed to be offered at this node.
143 * Note that this is just informative, the appropiate handlers must be
144 * registered independently and the mapping is up to the developer of the
145 * client application.
147 const GNUNET_MESH_ApplicationType *applications;
150 * Double linked list of the tunnels this client is connected to.
152 struct GNUNET_MESH_Tunnel *tunnels_head;
153 struct GNUNET_MESH_Tunnel *tunnels_tail;
156 * Callback for inbound tunnel creation
158 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
161 * Callback for inbound tunnel disconnection
163 GNUNET_MESH_TunnelEndHandler *cleaner;
166 * Handle to cancel pending transmissions in case of disconnection
168 struct GNUNET_CLIENT_TransmitHandle *th;
171 * Closure for all the handlers given by the client
176 * Messages to send to the service
178 struct GNUNET_MESH_TransmitHandle *th_head;
179 struct GNUNET_MESH_TransmitHandle *th_tail;
182 * tid of the next tunnel to create (to avoid reusing IDs often)
184 MESH_TunnelNumber next_tid;
185 unsigned int n_handlers;
186 unsigned int n_applications;
187 unsigned int max_queue_size;
190 * Have we started the task to receive messages from the service
191 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
196 * Number of packets queued
198 unsigned int npackets;
201 * Configuration given by the client, in case of reconnection
203 const struct GNUNET_CONFIGURATION_Handle *cfg;
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 send_packet (struct GNUNET_MESH_Handle *h,
561 const struct GNUNET_MessageHeader *msg);
565 * Reconnect to the service, retransmit all infomation to try to restore the
568 * @param h handle to the mesh
570 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
573 reconnect (struct GNUNET_MESH_Handle *h)
575 struct GNUNET_MESH_Tunnel *t;
578 h->in_receive = GNUNET_NO;
582 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
584 if (NULL != h->client)
586 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
590 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
591 if (h->client == NULL)
593 /* FIXME: panic? exponential backoff retry? */
597 /* Rebuild all tunnels */
598 for (t = h->tunnels_head; NULL != t; t = t->next)
600 struct GNUNET_MESH_TunnelMessage tmsg;
601 struct GNUNET_MESH_PeerControl pmsg;
603 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
604 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
605 tmsg.tunnel_id = htonl (t->tid);
606 send_packet (h, &tmsg.header);
608 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
609 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
610 pmsg.tunnel_id = htonl (t->tid);
612 /* Reconnect all peers */
613 for (i = 0; i < t->npeers; i++)
615 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
616 if (NULL != t->disconnect_handler && t->peers[i]->connected)
617 t->disconnect_handler (t->cls, &pmsg.peer);
618 /* If the tunnel was "by type", dont connect individual peers */
620 send_packet (t->mesh, &pmsg.header);
622 /* Reconnect all types, if any */
623 for (i = 0; i < t->napps; i++)
625 struct GNUNET_MESH_ConnectPeerByType msg;
627 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
628 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
629 msg.tunnel_id = htonl (t->tid);
630 msg.type = htonl (t->apps[i]);
631 send_packet (t->mesh, &msg.header);
638 /******************************************************************************/
639 /*********************** RECEIVE HANDLERS ****************************/
640 /******************************************************************************/
643 * Process the new tunnel notification and add it to the tunnels in the handle
645 * @param h The mesh handle
646 * @param msg A message with the details of the new incoming tunnel
649 process_tunnel_create (struct GNUNET_MESH_Handle *h,
650 const struct GNUNET_MESH_TunnelMessage *msg)
652 struct GNUNET_MESH_Tunnel *t;
653 struct GNUNET_TRANSPORT_ATS_Information atsi;
654 MESH_TunnelNumber tid;
656 tid = ntohl (msg->tunnel_id);
657 if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
662 t = create_tunnel (h, tid);
663 t->owner = GNUNET_PEER_intern (&msg->peer);
665 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
666 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
668 t->peers[0]->connected = 1;
669 t->peers[0]->id = t->owner;
672 if (NULL != h->new_tunnel)
676 t->ctx = h->new_tunnel(h->cls, t, &msg->peer, &atsi);
678 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
684 * Process the tunnel destroy notification and free associated resources
686 * @param h The mesh handle
687 * @param msg A message with the details of the tunnel being destroyed
690 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
691 const struct GNUNET_MESH_TunnelMessage *msg)
693 struct GNUNET_MESH_Tunnel *t;
694 MESH_TunnelNumber tid;
696 tid = ntohl (msg->tunnel_id);
697 t = retrieve_tunnel (h, tid);
715 * Process the new peer event and notify the upper level of it
717 * @param h The mesh handle
718 * @param msg A message with the details of the peer event
721 process_peer_event (struct GNUNET_MESH_Handle *h,
722 const struct GNUNET_MESH_PeerControl *msg)
724 struct GNUNET_MESH_Tunnel *t;
725 struct GNUNET_MESH_Peer *p;
726 struct GNUNET_TRANSPORT_ATS_Information atsi;
730 size = ntohs (msg->header.size);
731 if (size != sizeof (struct GNUNET_MESH_PeerControl))
736 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
742 id = GNUNET_PEER_search (&msg->peer);
743 if ((p = retrieve_peer (t, id)) == NULL)
744 p = add_peer_to_tunnel (t, &msg->peer);
745 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == msg->header.type)
747 if (NULL != t->connect_handler)
751 t->connect_handler (t->cls, &msg->peer, &atsi);
757 if (NULL != t->disconnect_handler && p->connected)
759 t->disconnect_handler (t->cls, &msg->peer);
761 remove_peer_from_tunnel (p);
768 * Process the incoming data packets
770 * @param h The mesh handle
771 * @param msh A message encapsulating the data
774 process_incoming_data (struct GNUNET_MESH_Handle *h,
775 const struct GNUNET_MessageHeader *message)
777 const struct GNUNET_MessageHeader *payload;
778 const struct GNUNET_MESH_MessageHandler *handler;
779 const struct GNUNET_PeerIdentity *peer;
780 struct GNUNET_MESH_Unicast *ucast;
781 struct GNUNET_MESH_Multicast *mcast;
782 struct GNUNET_MESH_ToOrigin *to_orig;
783 struct GNUNET_MESH_Tunnel *t;
787 type = ntohs (message->type);
790 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
791 ucast = (struct GNUNET_MESH_Unicast *) message;
792 t = retrieve_tunnel (h, ntohl (ucast->tid));
793 payload = (struct GNUNET_MessageHeader *) &ucast[1];
796 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
797 mcast = (struct GNUNET_MESH_Multicast *) message;
798 t = retrieve_tunnel (h, ntohl (mcast->tid));
799 payload = (struct GNUNET_MessageHeader *) &mcast[1];
802 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
803 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
804 t = retrieve_tunnel (h, ntohl (to_orig->tid));
805 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
806 peer = &to_orig->sender;
817 for (i = 0; i < h->n_handlers; i++)
819 handler = &h->message_handlers[i];
820 if (handler->type == type)
822 struct GNUNET_TRANSPORT_ATS_Information atsi;
827 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
829 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
830 "MESH: callback completed successfully\n");
834 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
835 "MESH: callback caused disconnection\n");
836 GNUNET_MESH_disconnect (h);
844 * Function to process all messages received from the service
847 * @param msg message received, NULL on timeout or fatal error
850 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
852 struct GNUNET_MESH_Handle *h = cls;
854 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message from MESH\n");
860 switch (ntohs (msg->type))
862 /* Notify of a new incoming tunnel */
863 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
864 process_tunnel_create (h, (struct GNUNET_MESH_TunnelMessage *) msg);
866 /* Notify of a tunnel disconnection */
867 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
868 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
870 /* Notify of a new peer or a peer disconnect in the tunnel */
871 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
872 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
873 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
875 /* Notify of a new data packet in the tunnel */
876 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
877 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
878 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
879 process_incoming_data (h, msg);
881 /* We shouldn't get any other packages, log and ignore */
883 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
884 "MESH: unsolicited message form service (type %d)\n",
887 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
888 GNUNET_CLIENT_receive (h->client, &msg_received, h,
889 GNUNET_TIME_UNIT_FOREVER_REL);
893 /******************************************************************************/
894 /************************ SEND FUNCTIONS ****************************/
895 /******************************************************************************/
898 * Function called to send a message to the service.
899 * "buf" will be NULL and "size" zero if the socket was closed for writing in
902 * @param cls closure, the mesh handle
903 * @param size number of bytes available in buf
904 * @param buf where the callee should write the connect message
905 * @return number of bytes written to buf
908 send_callback (void *cls, size_t size, void *buf)
910 struct GNUNET_MESH_Handle *h = cls;
911 struct GNUNET_MESH_TransmitHandle *th;
916 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
918 if ((0 == size) || (NULL == buf))
924 while ((NULL != (th = h->th_head)) && (size >= th->size))
927 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: type: %u\n",
928 ntohs (((struct GNUNET_MessageHeader *)&th[1])->type));
929 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: size: %u\n",
930 ntohs (((struct GNUNET_MessageHeader *)&th[1])->size));
932 if (NULL != th->notify)
937 struct GNUNET_MESH_Multicast mc;
939 GNUNET_assert (size >= sizeof (mc) + th->size);
941 th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
944 mc.header.size = htons (sizeof (mc) + th->size);
945 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
946 mc.tid = htonl (th->tunnel->tid);
947 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
948 memcpy (cbuf, &mc, sizeof (mc));
949 psize = th->size + sizeof (mc);
955 struct GNUNET_MESH_Unicast uc;
957 GNUNET_assert (size >= sizeof (uc) + th->size);
959 th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
962 uc.header.size = htons (sizeof (uc) + th->size);
963 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
964 uc.tid = htonl (th->tunnel->tid);
965 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
966 GNUNET_PEER_resolve (th->target, &uc.destination);
967 memcpy (cbuf, &uc, sizeof (uc));
968 psize = th->size + sizeof (uc);
974 memcpy (cbuf, &th[1], th->size);
977 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
978 GNUNET_SCHEDULER_cancel (th->timeout_task);
979 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
985 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
986 if (NULL != (th = h->th_head))
988 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
990 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
991 GNUNET_TIME_UNIT_FOREVER_REL,
992 GNUNET_YES, &send_callback, h);
994 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
995 if (GNUNET_NO == h->in_receive)
997 h->in_receive = GNUNET_YES;
998 GNUNET_CLIENT_receive (h->client, &msg_received, h,
999 GNUNET_TIME_UNIT_FOREVER_REL);
1006 * Auxiliary function to send an already constructed packet to the service.
1007 * Takes care of creating a new queue element, copying the message and
1008 * calling the tmt_rdy function if necessary.
1009 * @param h mesh handle
1010 * @param msg message to transmit
1013 send_packet (struct GNUNET_MESH_Handle *h,
1014 const struct GNUNET_MessageHeader *msg)
1016 struct GNUNET_MESH_TransmitHandle *th;
1019 msize = ntohs (msg->size);
1020 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1021 th->priority = UINT32_MAX;
1022 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1024 memcpy (&th[1], msg, msize);
1025 add_to_queue (h, th);
1029 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1030 GNUNET_TIME_UNIT_FOREVER_REL,
1031 GNUNET_YES, &send_callback, h);
1035 /******************************************************************************/
1036 /********************** API CALL DEFINITIONS *************************/
1037 /******************************************************************************/
1040 * Connect to the mesh service.
1042 * @param cfg configuration to use
1043 * @param queue_size size of the data message queue, shared among all tunnels
1044 * (each tunnel is guaranteed to accept at least one message,
1045 * no matter what is the status of other tunnels)
1046 * @param cls closure for the various callbacks that follow
1047 * (including handlers in the handlers array)
1048 * @param new_tunnel function called when an *inbound* tunnel is created
1049 * @param cleaner function called when an *inbound* tunnel is destroyed
1050 * @param handlers callbacks for messages we care about, NULL-terminated
1051 * note that the mesh is allowed to drop notifications about
1052 * inbound messages if the client does not process them fast
1053 * enough (for this notification type, a bounded queue is used)
1054 * @param stypes list of the applications that this client claims to provide
1055 * @return handle to the mesh service NULL on error
1056 * (in this case, init is never called)
1058 struct GNUNET_MESH_Handle *
1059 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1060 unsigned int queue_size, void *cls,
1061 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1062 GNUNET_MESH_TunnelEndHandler cleaner,
1063 const struct GNUNET_MESH_MessageHandler *handlers,
1064 const GNUNET_MESH_ApplicationType *stypes)
1066 struct GNUNET_MESH_Handle *h;
1067 struct GNUNET_MESH_ClientConnect *msg;
1068 GNUNET_MESH_ApplicationType *apps;
1074 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1075 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1077 h->max_queue_size = queue_size;
1078 h->new_tunnel = new_tunnel;
1079 h->cleaner = cleaner;
1080 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1081 if (h->client == NULL)
1088 h->message_handlers = handlers;
1089 h->applications = stypes;
1090 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1092 /* count handlers and apps, calculate size */
1093 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1094 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1095 size = sizeof (struct GNUNET_MESH_ClientConnect);
1096 size += h->n_handlers * sizeof (uint16_t);
1097 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
1102 /* build connection packet */
1103 msg = (struct GNUNET_MESH_ClientConnect *) buf;
1104 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
1105 msg->header.size = htons (size);
1106 types = (uint16_t *) & msg[1];
1107 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
1108 types[ntypes] = h->message_handlers[ntypes].type;
1109 apps = (GNUNET_MESH_ApplicationType *) &types[ntypes];
1110 for (napps = 0; napps < h->n_applications; napps++)
1111 apps[napps] = h->applications[napps];
1112 msg->applications = htons (napps);
1113 msg->types = htons (ntypes);
1114 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1115 "mesh: Sending %lu bytes long message %d types and %d apps\n",
1116 ntohs (msg->header.size), ntypes, napps);
1117 send_packet (h, &msg->header);
1119 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1125 * Disconnect from the mesh service.
1127 * @param handle connection to mesh to disconnect
1130 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1132 struct GNUNET_MESH_Tunnel *t;
1134 for (t = handle->tunnels_head; NULL != t; t = t->next)
1138 if (NULL != handle->th)
1140 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1142 if (NULL != handle->client)
1144 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1146 GNUNET_free (handle);
1151 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1152 * and to broadcast).
1154 * @param h mesh handle
1155 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1156 * @param connect_handler function to call when peers are actually connected
1157 * @param disconnect_handler function to call when peers are disconnected
1158 * @param handler_cls closure for connect/disconnect handlers
1160 struct GNUNET_MESH_Tunnel *
1161 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1162 GNUNET_MESH_TunnelConnectHandler connect_handler,
1163 GNUNET_MESH_TunnelDisconnectHandler
1164 disconnect_handler, void *handler_cls)
1166 struct GNUNET_MESH_Tunnel *t;
1167 struct GNUNET_MESH_TunnelMessage msg;
1169 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1170 t = create_tunnel (h, 0);
1171 t->connect_handler = connect_handler;
1172 t->disconnect_handler = disconnect_handler;
1173 t->cls = handler_cls;
1174 t->ctx = tunnel_ctx;
1175 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1176 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1177 msg.tunnel_id = htonl (t->tid);
1178 send_packet (h, &msg.header);
1184 * Destroy an existing tunnel.
1186 * @param tun tunnel handle
1189 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *t)
1191 struct GNUNET_MESH_Handle *h;
1192 struct GNUNET_MESH_TunnelMessage msg;
1194 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1198 GNUNET_PEER_change_rc (t->owner, -1);
1200 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1201 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1202 msg.tunnel_id = htonl (t->tid);
1204 send_packet (h, &msg.header);
1209 * Request that a peer should be added to the tunnel. The existing
1210 * connect handler will be called ONCE with either success or failure.
1211 * This function should NOT be called again with the same peer before the
1212 * connect handler is called.
1214 * @param tunnel handle to existing tunnel
1215 * @param timeout how long to try to establish a connection
1216 * @param peer peer to add
1219 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1220 const struct GNUNET_PeerIdentity *peer)
1222 struct GNUNET_MESH_PeerControl msg;
1223 GNUNET_PEER_Id peer_id;
1226 peer_id = GNUNET_PEER_intern (peer);
1227 for (i = 0; i < tunnel->npeers; i++)
1229 if (tunnel->peers[i]->id == peer_id)
1231 GNUNET_PEER_change_rc (peer_id, -1);
1236 if (NULL == add_peer_to_tunnel (tunnel, peer))
1239 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1240 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1241 msg.tunnel_id = htonl (tunnel->tid);
1243 send_packet (tunnel->mesh, &msg.header);
1250 * Request that a peer should be removed from the tunnel. The existing
1251 * disconnect handler will be called ONCE if we were connected.
1253 * @param tunnel handle to existing tunnel
1254 * @param peer peer to remove
1257 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1258 const struct GNUNET_PeerIdentity *peer)
1260 struct GNUNET_MESH_PeerControl msg;
1261 GNUNET_PEER_Id peer_id;
1264 peer_id = GNUNET_PEER_search (peer);
1270 for (i = 0; i < tunnel->npeers; i++)
1271 if (tunnel->peers[i]->id == peer_id)
1273 if (i == tunnel->npeers)
1278 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1279 tunnel->disconnect_handler (tunnel->cls, peer);
1280 GNUNET_PEER_change_rc (peer_id, -1);
1281 GNUNET_free (tunnel->peers[i]);
1282 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1283 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1285 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1286 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1287 msg.tunnel_id = htonl (tunnel->tid);
1288 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1289 send_packet (tunnel->mesh, &msg.header);
1294 * Request that the mesh should try to connect to a peer supporting the given
1297 * @param tunnel handle to existing tunnel
1298 * @param app_type application type that must be supported by the peer (MESH
1299 * should discover peer in proximity handling this type)
1302 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1303 GNUNET_MESH_ApplicationType app_type)
1305 struct GNUNET_MESH_ConnectPeerByType msg;
1307 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1309 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1310 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1311 msg.tunnel_id = htonl (tunnel->tid);
1312 msg.type = htonl (app_type);
1313 send_packet (tunnel->mesh, &msg.header);
1318 * Ask the mesh to call "notify" once it is ready to transmit the
1319 * given number of bytes to the specified "target". If we are not yet
1320 * connected to the specified peer, a call to this function will cause
1321 * us to try to establish a connection.
1323 * @param tunnel tunnel to use for transmission
1324 * @param cork is corking allowed for this transmission?
1325 * @param priority how important is the message?
1326 * @param maxdelay how long can the message wait?
1327 * @param target destination for the message,
1328 * NULL for multicast to all tunnel targets
1329 * @param notify_size how many bytes of buffer space does notify want?
1330 * @param notify function to call when buffer space is available;
1331 * will be called with NULL on timeout or if the overall queue
1332 * for this peer is larger than queue_size and this is currently
1333 * the message with the lowest priority
1334 * @param notify_cls closure for notify
1335 * @return non-NULL if the notify callback was queued,
1336 * NULL if we can not even queue the request (insufficient
1337 * memory); if NULL is returned, "notify" will NOT be called.
1339 struct GNUNET_MESH_TransmitHandle *
1340 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1342 struct GNUNET_TIME_Relative maxdelay,
1343 const struct GNUNET_PeerIdentity *target,
1345 GNUNET_CONNECTION_TransmitReadyNotify notify,
1348 struct GNUNET_MESH_TransmitHandle *th;
1349 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1350 uint32_t least_priority;
1353 GNUNET_assert(NULL != notify);
1354 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1355 tunnel->npackets > 0)
1360 th = tunnel->mesh->th_tail;
1361 least_priority = priority;
1362 least_priority_th = NULL;
1365 if (th->priority < least_priority && th->tunnel->npackets > 1)
1367 least_priority_th = th;
1368 least_priority = th->priority;
1372 if (NULL == least_priority_th)
1374 GNUNET_assert(NULL != least_priority_th->notify); /* Cant be a cntrl msg */
1375 least_priority_th->notify(notify_cls, 0, NULL);
1376 least_priority_th->tunnel->npackets--;
1377 tunnel->mesh->npackets--;
1378 GNUNET_CONTAINER_DLL_remove(tunnel->mesh->th_head,
1379 tunnel->mesh->th_tail,
1381 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1382 GNUNET_SCHEDULER_cancel(least_priority_th->timeout_task);
1383 GNUNET_free(least_priority_th);
1386 tunnel->mesh->npackets++;
1387 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1388 th->tunnel = tunnel;
1389 th->priority = priority;
1390 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1391 th->target = GNUNET_PEER_intern (target);
1394 target) ? sizeof (struct GNUNET_MESH_Multicast) : sizeof (struct
1395 GNUNET_MESH_Unicast);
1396 th->size = notify_size + overhead;
1397 th->notify = notify;
1398 th->notify_cls = notify_cls;
1399 add_to_queue (tunnel->mesh, th);
1405 * Cancel the specified transmission-ready notification.
1407 * @param th handle that was returned by "notify_transmit_ready".
1410 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1412 struct GNUNET_MESH_Handle *mesh;
1414 mesh = th->tunnel->mesh;
1415 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1416 GNUNET_SCHEDULER_cancel (th->timeout_task);
1417 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1419 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1421 /* queue empty, no point in asking for transmission */
1422 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1428 #if 0 /* keep Emacsens' auto-indent happy */