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 MESH_API_DEBUG GNUNET_YES
50 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
52 /******************************************************************************/
53 /************************ DATA STRUCTURES ****************************/
54 /******************************************************************************/
57 * Transmission queue to the service
59 struct GNUNET_MESH_TransmitHandle
65 struct GNUNET_MESH_TransmitHandle *next;
70 struct GNUNET_MESH_TransmitHandle *prev;
73 * Tunnel this message is sent over (may be NULL for control messages).
75 struct GNUNET_MESH_Tunnel *tunnel;
78 * Callback to obtain the message to transmit, or NULL if we
79 * got the message in 'data'. Notice that messages built
80 * by 'notify' need to be encapsulated with information about
83 GNUNET_CONNECTION_TransmitReadyNotify notify;
86 * Closure for 'notify'
91 * How long is this message valid. Once the timeout has been
92 * reached, the message must no longer be sent. If this
93 * is a message with a 'notify' callback set, the 'notify'
94 * function should be called with 'buf' NULL and size 0.
96 struct GNUNET_TIME_Absolute timeout;
99 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
101 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
104 * Priority of the message. The queue is sorted by priority,
105 * control messages have the maximum priority (UINT32_MAX).
110 * Target of the message, 0 for multicast. This field
111 * is only valid if 'notify' is non-NULL.
113 GNUNET_PEER_Id target;
116 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
123 * Opaque handle to the service.
125 struct GNUNET_MESH_Handle
129 * Handle to the server connection, to send messages later
131 struct GNUNET_CLIENT_Connection *client;
134 * Set of handlers used for processing incoming messages in the tunnels
136 const struct GNUNET_MESH_MessageHandler *message_handlers;
139 * Set of applications that should be claimed to be offered at this node.
140 * Note that this is just informative, the appropiate handlers must be
141 * registered independently and the mapping is up to the developer of the
142 * client application.
144 const GNUNET_MESH_ApplicationType *applications;
147 * Double linked list of the tunnels this client is connected to.
149 struct GNUNET_MESH_Tunnel *tunnels_head;
150 struct GNUNET_MESH_Tunnel *tunnels_tail;
153 * Callback for inbound tunnel creation
155 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
158 * Callback for inbound tunnel disconnection
160 GNUNET_MESH_TunnelEndHandler *cleaner;
163 * Handle to cancel pending transmissions in case of disconnection
165 struct GNUNET_CLIENT_TransmitHandle *th;
168 * Closure for all the handlers given by the client
173 * Messages to send to the service
175 struct GNUNET_MESH_TransmitHandle *th_head;
176 struct GNUNET_MESH_TransmitHandle *th_tail;
179 * tid of the next tunnel to create (to avoid reusing IDs often)
181 MESH_TunnelNumber next_tid;
182 unsigned int n_handlers;
183 unsigned int n_applications;
184 unsigned int max_queue_size;
187 * Have we started the task to receive messages from the service
188 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
193 * Number of packets queued
195 unsigned int npackets;
198 * Configuration given by the client, in case of reconnection
200 const struct GNUNET_CONFIGURATION_Handle *cfg;
203 * Time to the next reconnect in case one reconnect fails
205 struct GNUNET_TIME_Relative reconnect_time;
210 * Description of a peer
212 struct GNUNET_MESH_Peer
215 * ID of the peer in short form
220 * Tunnel this peer belongs to
222 struct GNUNET_MESH_Tunnel *t;
225 * Flag indicating whether service has informed about its connection
233 * Opaque handle to a tunnel.
235 struct GNUNET_MESH_Tunnel
241 struct GNUNET_MESH_Tunnel *next;
242 struct GNUNET_MESH_Tunnel *prev;
245 * Callback to execute when peers connect to the tunnel
247 GNUNET_MESH_PeerConnectHandler connect_handler;
250 * Callback to execute when peers disconnect from the tunnel
252 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
255 * Closure for the connect/disconnect handlers
260 * Handle to the mesh this tunnel belongs to
262 struct GNUNET_MESH_Handle *mesh;
265 * Local ID of the tunnel
267 MESH_TunnelNumber tid;
270 * Owner of the tunnel
272 GNUNET_PEER_Id owner;
275 * All peers added to the tunnel
277 struct GNUNET_MESH_Peer **peers;
280 * List of application types that have been requested for this tunnel
282 GNUNET_MESH_ApplicationType *apps;
285 * Any data the caller wants to put in here
290 * Number of peers added to the tunnel
295 * Number of packets queued in this tunnel
297 unsigned int npackets;
300 * Number of applications requested this tunnel
307 /******************************************************************************/
308 /*********************** AUXILIARY FUNCTIONS *************************/
309 /******************************************************************************/
312 * Get the tunnel handler for the tunnel specified by id from the given handle
313 * @param h Mesh handle
314 * @param tid ID of the wanted tunnel
315 * @return handle to the required tunnel or NULL if not found
317 static struct GNUNET_MESH_Tunnel *
318 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
320 struct GNUNET_MESH_Tunnel *t;
334 * Create a new tunnel and insert it in the tunnel list of the mesh handle
335 * @param h Mesh handle
336 * @param tid desired tid of the tunnel, 0 to assign one automatically
337 * @return handle to the created tunnel
339 static struct GNUNET_MESH_Tunnel *
340 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
342 struct GNUNET_MESH_Tunnel *t;
344 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
345 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
349 t->tid = h->next_tid;
350 while (NULL != retrieve_tunnel (h, h->next_tid))
353 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
354 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
366 * Destroy the specified tunnel.
367 * - Destroys all peers, calling the disconnect callback on each if needed
368 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
369 * - Calls cleaner if tunnel was inbound
370 * - Frees all memory used
371 * @param tid ID of the wanted tunnel
372 * @return handle to the required tunnel or NULL if not found
375 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
377 struct GNUNET_MESH_Handle *h;
378 struct GNUNET_PeerIdentity pi;
379 struct GNUNET_MESH_TransmitHandle *th;
380 struct GNUNET_MESH_TransmitHandle *aux;
395 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
396 if (NULL == h->th_head && NULL != h->th)
398 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
401 if (NULL != th->notify)
402 th->notify (th->notify_cls, 0, NULL);
403 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
404 GNUNET_SCHEDULER_cancel (th->timeout_task);
413 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
414 for (i = 0; i < t->npeers; i++)
416 if (NULL != t->disconnect_handler && t->peers[i]->connected)
418 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
419 t->disconnect_handler (t->cls, &pi);
421 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
422 GNUNET_free (t->peers[i]);
425 GNUNET_free (t->peers);
426 if (NULL != h->cleaner && 0 != t->owner)
427 h->cleaner (h->cls, t, t->ctx);
429 GNUNET_PEER_change_rc (t->owner, -1);
430 if (0 != t->napps && t->apps)
431 GNUNET_free (t->apps);
438 * Get the peer descriptor for the peer with id from the given tunnel
439 * @param t Tunnel handle
440 * @param id Short form ID of the wanted peer
441 * @return handle to the requested peer or NULL if not found
443 static struct GNUNET_MESH_Peer *
444 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
448 for (i = 0; i < t->npeers; i++)
449 if (t->peers[i]->id == id)
456 * Add a peer into a tunnel
457 * @param t Tunnel handle
458 * @param pi Full ID of the new peer
459 * @return handle to the newly created peer
461 static struct GNUNET_MESH_Peer *
462 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
463 const struct GNUNET_PeerIdentity *pi)
465 struct GNUNET_MESH_Peer *p;
473 id = GNUNET_PEER_intern (pi);
475 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
478 GNUNET_array_append (t->peers, t->npeers, p);
484 * Remove a peer from a tunnel
485 * @param p Peer handle
488 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
492 for (i = 0; i < p->t->npeers; i++)
494 if (p->t->peers[i] == p)
497 if (i == p->t->npeers)
502 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
503 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
508 * Notify client that the transmission has timed out
510 * @param tc task context
513 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
515 struct GNUNET_MESH_TransmitHandle *th = cls;
516 struct GNUNET_MESH_Handle *mesh;
518 mesh = th->tunnel->mesh;
519 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
520 if (th->notify != NULL)
521 th->notify (th->notify_cls, 0, NULL);
523 if ((NULL == mesh->th_head) && (NULL != mesh->th))
525 /* queue empty, no point in asking for transmission */
526 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
533 * Add a transmit handle to the transmission queue by priority and set the
536 * @param h mesh handle with the queue head and tail
537 * @param th handle to the packet to be transmitted
540 add_to_queue (struct GNUNET_MESH_Handle *h,
541 struct GNUNET_MESH_TransmitHandle *th)
543 struct GNUNET_MESH_TransmitHandle *p;
546 while ((NULL != p) && (th->priority <= p->priority))
552 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
553 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
556 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
557 (th->timeout), &timeout_transmission, th);
562 * Auxiliary function to send an already constructed packet to the service.
563 * Takes care of creating a new queue element, copying the message and
564 * calling the tmt_rdy function if necessary.
565 * @param h mesh handle
566 * @param msg message to transmit
569 send_packet (struct GNUNET_MESH_Handle *h,
570 const struct GNUNET_MessageHeader *msg);
574 * Reconnect callback: tries to reconnect again after a failer previous
576 * @param cls closure (mesh handle)
577 * @param tc task context
580 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
584 * Send a connect packet to the service with the applications and types
585 * requested by the user.
587 * @param h The mesh handle.
591 send_connect (struct GNUNET_MESH_Handle *h)
595 size = sizeof (struct GNUNET_MESH_ClientConnect);
596 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
597 size += h->n_handlers * sizeof (uint16_t);
600 struct GNUNET_MESH_ClientConnect *msg;
601 GNUNET_MESH_ApplicationType *apps;
606 /* build connection packet */
607 msg = (struct GNUNET_MESH_ClientConnect *) buf;
608 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
609 msg->header.size = htons (size);
610 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
611 for (napps = 0; napps < h->n_applications; napps++)
613 apps[napps] = htonl (h->applications[napps]);
614 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: app %u\n", h->applications[napps]);
616 types = (uint16_t *) & apps[napps];
617 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
618 types[ntypes] = htons (h->message_handlers[ntypes].type);
619 msg->applications = htons (napps);
620 msg->types = htons (ntypes);
622 LOG (GNUNET_ERROR_TYPE_DEBUG,
623 "mesh: Sending %lu bytes long message %d types and %d apps\n",
624 ntohs (msg->header.size), ntypes, napps);
626 send_packet (h, &msg->header);
632 * Reconnect to the service, retransmit all infomation to try to restore the
635 * @param h handle to the mesh
637 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
640 reconnect (struct GNUNET_MESH_Handle *h)
642 struct GNUNET_MESH_Tunnel *t;
646 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
647 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: ******* RECONNECT *******\n");
648 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
650 h->in_receive = GNUNET_NO;
654 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
656 if (NULL != h->client)
658 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
662 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
663 if (h->client == NULL)
665 GNUNET_SCHEDULER_add_delayed (h->reconnect_time, &reconnect_cbk, h);
667 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_HOURS,
668 GNUNET_TIME_relative_multiply
669 (h->reconnect_time, 2));
670 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Next retry in %sms\n",
671 GNUNET_TIME_relative_to_string (h->reconnect_time));
677 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
680 /* Rebuild all tunnels */
681 for (t = h->tunnels_head; NULL != t; t = t->next)
683 struct GNUNET_MESH_TunnelMessage tmsg;
684 struct GNUNET_MESH_PeerControl pmsg;
686 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
687 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
688 tmsg.tunnel_id = htonl (t->tid);
689 send_packet (h, &tmsg.header);
691 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
692 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
693 pmsg.tunnel_id = htonl (t->tid);
695 /* Reconnect all peers */
696 for (i = 0; i < t->npeers; i++)
698 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
699 if (NULL != t->disconnect_handler && t->peers[i]->connected)
700 t->disconnect_handler (t->cls, &pmsg.peer);
701 /* If the tunnel was "by type", dont connect individual peers */
703 send_packet (t->mesh, &pmsg.header);
705 /* Reconnect all types, if any */
706 for (i = 0; i < t->napps; i++)
708 struct GNUNET_MESH_ConnectPeerByType msg;
710 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
711 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
712 msg.tunnel_id = htonl (t->tid);
713 msg.type = htonl (t->apps[i]);
714 send_packet (t->mesh, &msg.header);
721 * Reconnect callback: tries to reconnect again after a failer previous
723 * @param cls closure (mesh handle)
724 * @param tc task context
727 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
729 struct GNUNET_MESH_Handle *h = cls;
731 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
737 /******************************************************************************/
738 /*********************** RECEIVE HANDLERS ****************************/
739 /******************************************************************************/
742 * Process the new tunnel notification and add it to the tunnels in the handle
744 * @param h The mesh handle
745 * @param msg A message with the details of the new incoming tunnel
748 process_tunnel_created (struct GNUNET_MESH_Handle *h,
749 const struct GNUNET_MESH_TunnelNotification *msg)
751 struct GNUNET_MESH_Tunnel *t;
752 struct GNUNET_ATS_Information atsi;
753 MESH_TunnelNumber tid;
755 tid = ntohl (msg->tunnel_id);
756 if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
761 t = create_tunnel (h, tid);
762 t->owner = GNUNET_PEER_intern (&msg->peer);
764 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
765 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
767 t->peers[0]->connected = 1;
768 t->peers[0]->id = t->owner;
771 if (NULL != h->new_tunnel)
775 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
782 * Process the tunnel destroy notification and free associated resources
784 * @param h The mesh handle
785 * @param msg A message with the details of the tunnel being destroyed
788 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
789 const struct GNUNET_MESH_TunnelMessage *msg)
791 struct GNUNET_MESH_Tunnel *t;
792 MESH_TunnelNumber tid;
794 tid = ntohl (msg->tunnel_id);
795 t = retrieve_tunnel (h, tid);
812 * Process the new peer event and notify the upper level of it
814 * @param h The mesh handle
815 * @param msg A message with the details of the peer event
818 process_peer_event (struct GNUNET_MESH_Handle *h,
819 const struct GNUNET_MESH_PeerControl *msg)
821 struct GNUNET_MESH_Tunnel *t;
822 struct GNUNET_MESH_Peer *p;
823 struct GNUNET_ATS_Information atsi;
827 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
828 size = ntohs (msg->header.size);
829 if (size != sizeof (struct GNUNET_MESH_PeerControl))
834 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
840 id = GNUNET_PEER_search (&msg->peer);
841 if ((p = retrieve_peer (t, id)) == NULL)
842 p = add_peer_to_tunnel (t, &msg->peer);
843 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
845 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
846 if (NULL != t->connect_handler)
850 t->connect_handler (t->cls, &msg->peer, &atsi);
856 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
857 if (NULL != t->disconnect_handler && p->connected)
859 t->disconnect_handler (t->cls, &msg->peer);
861 remove_peer_from_tunnel (p);
864 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
869 * Process the incoming data packets
871 * @param h The mesh handle
872 * @param message A message encapsulating the data
875 process_incoming_data (struct GNUNET_MESH_Handle *h,
876 const struct GNUNET_MessageHeader *message)
878 const struct GNUNET_MessageHeader *payload;
879 const struct GNUNET_MESH_MessageHandler *handler;
880 const struct GNUNET_PeerIdentity *peer;
881 struct GNUNET_MESH_Unicast *ucast;
882 struct GNUNET_MESH_Multicast *mcast;
883 struct GNUNET_MESH_ToOrigin *to_orig;
884 struct GNUNET_MESH_Tunnel *t;
888 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Got a data message!\n");
889 type = ntohs (message->type);
892 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
893 ucast = (struct GNUNET_MESH_Unicast *) message;
895 t = retrieve_tunnel (h, ntohl (ucast->tid));
896 payload = (struct GNUNET_MessageHeader *) &ucast[1];
898 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
899 "mesh: on tunnel %s [%x]\n",
903 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
904 mcast = (struct GNUNET_MESH_Multicast *) message;
905 t = retrieve_tunnel (h, ntohl (mcast->tid));
906 payload = (struct GNUNET_MessageHeader *) &mcast[1];
909 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
910 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
911 t = retrieve_tunnel (h, ntohl (to_orig->tid));
912 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
913 peer = &to_orig->sender;
924 type = ntohs (payload->type);
925 for (i = 0; i < h->n_handlers; i++)
927 handler = &h->message_handlers[i];
928 if (handler->type == type)
930 struct GNUNET_ATS_Information atsi;
935 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
937 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
938 GNUNET_MESH_disconnect (h);
944 LOG (GNUNET_ERROR_TYPE_DEBUG,
945 "MESH: callback completed successfully\n");
955 * Function to process all messages received from the service
958 * @param msg message received, NULL on timeout or fatal error
961 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
963 struct GNUNET_MESH_Handle *h = cls;
970 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message type %hu from MESH\n",
972 switch (ntohs (msg->type))
974 /* Notify of a new incoming tunnel */
975 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
976 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
978 /* Notify of a tunnel disconnection */
979 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
980 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
982 /* Notify of a new peer or a peer disconnect in the tunnel */
983 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
984 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
985 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
987 /* Notify of a new data packet in the tunnel */
988 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
989 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
990 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
991 process_incoming_data (h, msg);
993 /* We shouldn't get any other packages, log and ignore */
995 LOG (GNUNET_ERROR_TYPE_WARNING,
996 "MESH: unsolicited message form service (type %d)\n",
999 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
1000 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1001 GNUNET_TIME_UNIT_FOREVER_REL);
1005 /******************************************************************************/
1006 /************************ SEND FUNCTIONS ****************************/
1007 /******************************************************************************/
1010 * Function called to send a message to the service.
1011 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1014 * @param cls closure, the mesh handle
1015 * @param size number of bytes available in buf
1016 * @param buf where the callee should write the connect message
1017 * @return number of bytes written to buf
1020 send_callback (void *cls, size_t size, void *buf)
1022 struct GNUNET_MESH_Handle *h = cls;
1023 struct GNUNET_MESH_TransmitHandle *th;
1028 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
1030 if ((0 == size) || (NULL == buf))
1036 while ((NULL != (th = h->th_head)) && (size >= th->size))
1038 if (NULL != th->notify)
1040 if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1042 /* traffic to origin */
1043 struct GNUNET_MESH_ToOrigin to;
1044 struct GNUNET_MessageHeader *mh;
1046 GNUNET_assert (size >= th->size);
1047 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1049 th->notify (th->notify_cls, size - sizeof (to), mh);
1050 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1051 "mesh: to origin, type %u\n",
1055 psize += sizeof (to);
1056 GNUNET_assert (size >= psize);
1057 to.header.size = htons (psize);
1058 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1059 to.tid = htonl (th->tunnel->tid);
1060 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1061 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1062 memcpy (cbuf, &to, sizeof (to));
1065 else if (th->target == 0)
1068 struct GNUNET_MESH_Multicast mc;
1069 struct GNUNET_MessageHeader *mh;
1071 GNUNET_assert (size >= th->size);
1072 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1074 th->notify (th->notify_cls, size - sizeof (mc), mh);
1075 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1076 "mesh: multicast, type %u\n",
1080 psize += sizeof (mc);
1081 GNUNET_assert (size >= psize);
1082 mc.header.size = htons (psize);
1083 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1084 mc.tid = htonl (th->tunnel->tid);
1085 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1086 memcpy (cbuf, &mc, sizeof (mc));
1092 struct GNUNET_MESH_Unicast uc;
1093 struct GNUNET_MessageHeader *mh;
1095 GNUNET_assert (size >= th->size);
1096 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1098 th->notify (th->notify_cls, size - sizeof (uc), mh);
1099 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1100 "mesh: unicast, type %u\n",
1104 psize += sizeof (uc);
1105 GNUNET_assert (size >= psize);
1106 uc.header.size = htons (psize);
1107 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1108 uc.tid = htonl (th->tunnel->tid);
1109 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1110 GNUNET_PEER_resolve (th->target, &uc.destination);
1111 memcpy (cbuf, &uc, sizeof (uc));
1117 memcpy (cbuf, &th[1], th->size);
1120 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1121 GNUNET_SCHEDULER_cancel (th->timeout_task);
1122 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1128 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
1129 if (NULL != (th = h->th_head))
1131 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
1133 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1134 GNUNET_TIME_UNIT_FOREVER_REL,
1135 GNUNET_YES, &send_callback, h);
1137 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1138 if (GNUNET_NO == h->in_receive)
1140 h->in_receive = GNUNET_YES;
1141 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1142 GNUNET_TIME_UNIT_FOREVER_REL);
1149 * Auxiliary function to send an already constructed packet to the service.
1150 * Takes care of creating a new queue element, copying the message and
1151 * calling the tmt_rdy function if necessary.
1152 * @param h mesh handle
1153 * @param msg message to transmit
1156 send_packet (struct GNUNET_MESH_Handle *h,
1157 const struct GNUNET_MessageHeader *msg)
1159 struct GNUNET_MESH_TransmitHandle *th;
1162 msize = ntohs (msg->size);
1163 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1164 th->priority = UINT32_MAX;
1165 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1167 memcpy (&th[1], msg, msize);
1168 add_to_queue (h, th);
1172 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1173 GNUNET_TIME_UNIT_FOREVER_REL,
1174 GNUNET_YES, &send_callback, h);
1178 /******************************************************************************/
1179 /********************** API CALL DEFINITIONS *************************/
1180 /******************************************************************************/
1183 * Connect to the mesh service.
1185 * @param cfg configuration to use
1186 * @param queue_size size of the data message queue, shared among all tunnels
1187 * (each tunnel is guaranteed to accept at least one message,
1188 * no matter what is the status of other tunnels)
1189 * @param cls closure for the various callbacks that follow
1190 * (including handlers in the handlers array)
1191 * @param new_tunnel function called when an *inbound* tunnel is created
1192 * @param cleaner function called when an *inbound* tunnel is destroyed
1193 * @param handlers callbacks for messages we care about, NULL-terminated
1194 * note that the mesh is allowed to drop notifications about
1195 * inbound messages if the client does not process them fast
1196 * enough (for this notification type, a bounded queue is used)
1197 * @param stypes list of the applications that this client claims to provide
1198 * @return handle to the mesh service NULL on error
1199 * (in this case, init is never called)
1201 struct GNUNET_MESH_Handle *
1202 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1203 unsigned int queue_size, void *cls,
1204 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1205 GNUNET_MESH_TunnelEndHandler cleaner,
1206 const struct GNUNET_MESH_MessageHandler *handlers,
1207 const GNUNET_MESH_ApplicationType *stypes)
1209 struct GNUNET_MESH_Handle *h;
1211 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1212 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1214 h->max_queue_size = queue_size;
1215 h->new_tunnel = new_tunnel;
1216 h->cleaner = cleaner;
1217 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1218 if (h->client == NULL)
1226 h->applications = stypes;
1227 h->message_handlers = handlers;
1228 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1229 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1231 /* count handlers and apps, calculate size */
1232 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1233 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1235 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1241 * Disconnect from the mesh service.
1243 * @param handle connection to mesh to disconnect
1246 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1248 struct GNUNET_MESH_Tunnel *t;
1249 struct GNUNET_MESH_Tunnel *aux;
1251 t = handle->tunnels_head;
1258 if (NULL != handle->th)
1260 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1262 if (NULL != handle->client)
1264 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1266 GNUNET_free (handle);
1271 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1272 * and to broadcast).
1274 * @param h mesh handle
1275 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1276 * @param connect_handler function to call when peers are actually connected
1277 * @param disconnect_handler function to call when peers are disconnected
1278 * @param handler_cls closure for connect/disconnect handlers
1280 struct GNUNET_MESH_Tunnel *
1281 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1282 GNUNET_MESH_PeerConnectHandler connect_handler,
1283 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1286 struct GNUNET_MESH_Tunnel *t;
1287 struct GNUNET_MESH_TunnelMessage msg;
1289 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1290 t = create_tunnel (h, 0);
1291 t->connect_handler = connect_handler;
1292 t->disconnect_handler = disconnect_handler;
1293 t->cls = handler_cls;
1294 t->ctx = tunnel_ctx;
1295 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1296 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1297 msg.tunnel_id = htonl (t->tid);
1298 send_packet (h, &msg.header);
1304 * Destroy an existing tunnel.
1306 * @param tun tunnel handle
1309 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1311 struct GNUNET_MESH_Handle *h;
1312 struct GNUNET_MESH_TunnelMessage msg;
1314 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1317 if (0 != tunnel->owner)
1318 GNUNET_PEER_change_rc (tunnel->owner, -1);
1320 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1321 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1322 msg.tunnel_id = htonl (tunnel->tid);
1323 destroy_tunnel (tunnel);
1324 send_packet (h, &msg.header);
1329 * Request that a peer should be added to the tunnel. The existing
1330 * connect handler will be called ONCE with either success or failure.
1331 * This function should NOT be called again with the same peer before the
1332 * connect handler is called.
1334 * @param tunnel handle to existing tunnel
1335 * @param peer peer to add
1338 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1339 const struct GNUNET_PeerIdentity *peer)
1341 struct GNUNET_MESH_PeerControl msg;
1342 GNUNET_PEER_Id peer_id;
1345 peer_id = GNUNET_PEER_intern (peer);
1346 for (i = 0; i < tunnel->npeers; i++)
1348 if (tunnel->peers[i]->id == peer_id)
1350 /* Peer already exists in tunnel */
1351 GNUNET_PEER_change_rc (peer_id, -1);
1356 if (NULL == add_peer_to_tunnel (tunnel, peer))
1359 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1360 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1361 msg.tunnel_id = htonl (tunnel->tid);
1363 send_packet (tunnel->mesh, &msg.header);
1370 * Request that a peer should be removed from the tunnel. The existing
1371 * disconnect handler will be called ONCE if we were connected.
1373 * @param tunnel handle to existing tunnel
1374 * @param peer peer to remove
1377 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1378 const struct GNUNET_PeerIdentity *peer)
1380 struct GNUNET_MESH_PeerControl msg;
1381 GNUNET_PEER_Id peer_id;
1384 peer_id = GNUNET_PEER_search (peer);
1390 for (i = 0; i < tunnel->npeers; i++)
1391 if (tunnel->peers[i]->id == peer_id)
1393 if (i == tunnel->npeers)
1398 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1399 tunnel->disconnect_handler (tunnel->cls, peer);
1400 GNUNET_PEER_change_rc (peer_id, -1);
1401 GNUNET_free (tunnel->peers[i]);
1402 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1403 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1405 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1406 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1407 msg.tunnel_id = htonl (tunnel->tid);
1408 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1409 send_packet (tunnel->mesh, &msg.header);
1414 * Request that the mesh should try to connect to a peer supporting the given
1417 * @param tunnel handle to existing tunnel
1418 * @param app_type application type that must be supported by the peer (MESH
1419 * should discover peer in proximity handling this type)
1422 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1423 GNUNET_MESH_ApplicationType app_type)
1425 struct GNUNET_MESH_ConnectPeerByType msg;
1427 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1429 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1430 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1431 msg.tunnel_id = htonl (tunnel->tid);
1432 msg.type = htonl (app_type);
1433 send_packet (tunnel->mesh, &msg.header);
1438 * Ask the mesh to call "notify" once it is ready to transmit the
1439 * given number of bytes to the specified "target". If we are not yet
1440 * connected to the specified peer, a call to this function will cause
1441 * us to try to establish a connection.
1443 * @param tunnel tunnel to use for transmission
1444 * @param cork is corking allowed for this transmission?
1445 * @param priority how important is the message?
1446 * @param maxdelay how long can the message wait?
1447 * @param target destination for the message,
1448 * NULL for multicast to all tunnel targets
1449 * @param notify_size how many bytes of buffer space does notify want?
1450 * @param notify function to call when buffer space is available;
1451 * will be called with NULL on timeout or if the overall queue
1452 * for this peer is larger than queue_size and this is currently
1453 * the message with the lowest priority
1454 * @param notify_cls closure for notify
1455 * @return non-NULL if the notify callback was queued,
1456 * NULL if we can not even queue the request (insufficient
1457 * memory); if NULL is returned, "notify" will NOT be called.
1459 struct GNUNET_MESH_TransmitHandle *
1460 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1462 struct GNUNET_TIME_Relative maxdelay,
1463 const struct GNUNET_PeerIdentity *target,
1465 GNUNET_CONNECTION_TransmitReadyNotify notify,
1468 struct GNUNET_MESH_TransmitHandle *th;
1469 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1470 uint32_t least_priority;
1474 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1475 "mesh: mesh notify transmit ready called\n");
1477 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1478 "mesh: target %s\n",
1479 GNUNET_i2s (target));
1481 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1482 "mesh: target multicast\n");
1484 GNUNET_assert (NULL != notify);
1485 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1486 tunnel->npackets > 0)
1491 th = tunnel->mesh->th_tail;
1492 least_priority = priority;
1493 least_priority_th = NULL;
1496 if (th->priority < least_priority && th->tunnel->npackets > 1)
1498 least_priority_th = th;
1499 least_priority = th->priority;
1503 if (NULL == least_priority_th)
1505 /* Can't be a control message */
1506 GNUNET_assert (NULL != least_priority_th->notify);
1507 least_priority_th->notify (notify_cls, 0, NULL);
1508 least_priority_th->tunnel->npackets--;
1509 tunnel->mesh->npackets--;
1510 GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1512 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1513 GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1514 GNUNET_free (least_priority_th);
1517 tunnel->mesh->npackets++;
1518 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1519 th->tunnel = tunnel;
1520 th->priority = priority;
1521 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1522 th->target = GNUNET_PEER_intern (target);
1523 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1524 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1525 else if (NULL == target)
1526 overhead = sizeof (struct GNUNET_MESH_Multicast);
1528 overhead = sizeof (struct GNUNET_MESH_Unicast);
1529 th->size = notify_size + overhead;
1530 th->notify = notify;
1531 th->notify_cls = notify_cls;
1532 add_to_queue (tunnel->mesh, th);
1533 if (NULL != tunnel->mesh->th)
1536 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client,
1538 GNUNET_TIME_UNIT_FOREVER_REL,
1547 * Cancel the specified transmission-ready notification.
1549 * @param th handle that was returned by "notify_transmit_ready".
1552 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1554 struct GNUNET_MESH_Handle *mesh;
1556 mesh = th->tunnel->mesh;
1557 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1558 GNUNET_SCHEDULER_cancel (th->timeout_task);
1559 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1561 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1563 /* queue empty, no point in asking for transmission */
1564 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1570 #if 0 /* keep Emacsens' auto-indent happy */