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_PeerConnectHandler connect_handler;
248 * Callback to execute when peers disconnect from the tunnel
250 GNUNET_MESH_PeerDisconnectHandler 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 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 th handle to the packet to be transmitted
538 add_to_queue (struct GNUNET_MESH_Handle *h,
539 struct GNUNET_MESH_TransmitHandle *th)
541 struct GNUNET_MESH_TransmitHandle *p;
544 while ((NULL != p) && (th->priority <= p->priority))
550 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
551 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
554 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
555 (th->timeout), &timeout_transmission, th);
560 * Auxiliary function to send an already constructed packet to the service.
561 * Takes care of creating a new queue element, copying the message and
562 * calling the tmt_rdy function if necessary.
563 * @param h mesh handle
564 * @param msg message to transmit
567 send_packet (struct GNUNET_MESH_Handle *h,
568 const struct GNUNET_MessageHeader *msg);
572 * Reconnect callback: tries to reconnect again after a failer previous
574 * @param cls closure (mesh handle)
575 * @param tc task context
578 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
582 * Reconnect to the service, retransmit all infomation to try to restore the
585 * @param h handle to the mesh
587 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
590 reconnect (struct GNUNET_MESH_Handle *h)
592 struct GNUNET_MESH_Tunnel *t;
596 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
597 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: ******* RECONNECT *******\n");
598 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: *****************************\n");
600 h->in_receive = GNUNET_NO;
604 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
606 if (NULL != h->client)
608 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
612 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
613 if (h->client == NULL)
615 GNUNET_SCHEDULER_add_delayed (h->reconnect_time, &reconnect_cbk, h);
617 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_HOURS,
618 GNUNET_TIME_relative_multiply
619 (h->reconnect_time, 2));
625 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
627 /* Rebuild all tunnels */
628 for (t = h->tunnels_head; NULL != t; t = t->next)
630 struct GNUNET_MESH_TunnelMessage tmsg;
631 struct GNUNET_MESH_PeerControl pmsg;
633 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
634 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
635 tmsg.tunnel_id = htonl (t->tid);
636 send_packet (h, &tmsg.header);
638 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
639 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
640 pmsg.tunnel_id = htonl (t->tid);
642 /* Reconnect all peers */
643 for (i = 0; i < t->npeers; i++)
645 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
646 if (NULL != t->disconnect_handler && t->peers[i]->connected)
647 t->disconnect_handler (t->cls, &pmsg.peer);
648 /* If the tunnel was "by type", dont connect individual peers */
650 send_packet (t->mesh, &pmsg.header);
652 /* Reconnect all types, if any */
653 for (i = 0; i < t->napps; i++)
655 struct GNUNET_MESH_ConnectPeerByType msg;
657 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
658 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
659 msg.tunnel_id = htonl (t->tid);
660 msg.type = htonl (t->apps[i]);
661 send_packet (t->mesh, &msg.header);
668 * Reconnect callback: tries to reconnect again after a failer previous
670 * @param cls closure (mesh handle)
671 * @param tc task context
674 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
676 struct GNUNET_MESH_Handle *h = cls;
678 if (tc->reason == GNUNET_SCHEDULER_REASON_SHUTDOWN)
684 /******************************************************************************/
685 /*********************** RECEIVE HANDLERS ****************************/
686 /******************************************************************************/
689 * Process the new tunnel notification and add it to the tunnels in the handle
691 * @param h The mesh handle
692 * @param msg A message with the details of the new incoming tunnel
695 process_tunnel_created (struct GNUNET_MESH_Handle *h,
696 const struct GNUNET_MESH_TunnelNotification *msg)
698 struct GNUNET_MESH_Tunnel *t;
699 struct GNUNET_TRANSPORT_ATS_Information atsi;
700 MESH_TunnelNumber tid;
702 tid = ntohl (msg->tunnel_id);
703 if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
708 t = create_tunnel (h, tid);
709 t->owner = GNUNET_PEER_intern (&msg->peer);
711 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
712 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
714 t->peers[0]->connected = 1;
715 t->peers[0]->id = t->owner;
718 if (NULL != h->new_tunnel)
722 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
724 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
730 * Process the tunnel destroy notification and free associated resources
732 * @param h The mesh handle
733 * @param msg A message with the details of the tunnel being destroyed
736 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
737 const struct GNUNET_MESH_TunnelMessage *msg)
739 struct GNUNET_MESH_Tunnel *t;
740 MESH_TunnelNumber tid;
742 tid = ntohl (msg->tunnel_id);
743 t = retrieve_tunnel (h, tid);
761 * Process the new peer event and notify the upper level of it
763 * @param h The mesh handle
764 * @param msg A message with the details of the peer event
767 process_peer_event (struct GNUNET_MESH_Handle *h,
768 const struct GNUNET_MESH_PeerControl *msg)
770 struct GNUNET_MESH_Tunnel *t;
771 struct GNUNET_MESH_Peer *p;
772 struct GNUNET_TRANSPORT_ATS_Information atsi;
776 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: processig peer event\n");
777 size = ntohs (msg->header.size);
778 if (size != sizeof (struct GNUNET_MESH_PeerControl))
783 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
789 id = GNUNET_PEER_search (&msg->peer);
790 if ((p = retrieve_peer (t, id)) == NULL)
791 p = add_peer_to_tunnel (t, &msg->peer);
792 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
794 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: adding peer\n");
795 if (NULL != t->connect_handler)
799 t->connect_handler (t->cls, &msg->peer, &atsi);
805 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: removing peer\n");
806 if (NULL != t->disconnect_handler && p->connected)
808 t->disconnect_handler (t->cls, &msg->peer);
810 remove_peer_from_tunnel (p);
813 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: processing peer event END\n");
818 * Process the incoming data packets
820 * @param h The mesh handle
821 * @param message A message encapsulating the data
824 process_incoming_data (struct GNUNET_MESH_Handle *h,
825 const struct GNUNET_MessageHeader *message)
827 const struct GNUNET_MessageHeader *payload;
828 const struct GNUNET_MESH_MessageHandler *handler;
829 const struct GNUNET_PeerIdentity *peer;
830 struct GNUNET_MESH_Unicast *ucast;
831 struct GNUNET_MESH_Multicast *mcast;
832 struct GNUNET_MESH_ToOrigin *to_orig;
833 struct GNUNET_MESH_Tunnel *t;
838 type = ntohs (message->type);
841 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
842 ucast = (struct GNUNET_MESH_Unicast *) message;
843 t = retrieve_tunnel (h, ntohl (ucast->tid));
844 payload = (struct GNUNET_MessageHeader *) &ucast[1];
847 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
848 mcast = (struct GNUNET_MESH_Multicast *) message;
849 t = retrieve_tunnel (h, ntohl (mcast->tid));
850 payload = (struct GNUNET_MessageHeader *) &mcast[1];
853 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
854 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
855 t = retrieve_tunnel (h, ntohl (to_orig->tid));
856 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
857 peer = &to_orig->sender;
868 type = ntohs (payload->type);
869 for (i = 0; i < h->n_handlers; i++)
871 handler = &h->message_handlers[i];
872 if (handler->type == type)
874 struct GNUNET_TRANSPORT_ATS_Information atsi;
879 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
881 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
882 "MESH: callback caused disconnection\n");
883 GNUNET_MESH_disconnect (h);
888 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
889 "MESH: callback completed successfully\n");
899 * Function to process all messages received from the service
902 * @param msg message received, NULL on timeout or fatal error
905 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
907 struct GNUNET_MESH_Handle *h = cls;
909 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
910 "mesh: received a message type %hu from MESH\n",
917 switch (ntohs (msg->type))
919 /* Notify of a new incoming tunnel */
920 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
921 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
923 /* Notify of a tunnel disconnection */
924 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
925 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
927 /* Notify of a new peer or a peer disconnect in the tunnel */
928 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
929 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
930 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
932 /* Notify of a new data packet in the tunnel */
933 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
934 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
935 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
936 process_incoming_data (h, msg);
938 /* We shouldn't get any other packages, log and ignore */
940 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
941 "MESH: unsolicited message form service (type %d)\n",
944 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
945 GNUNET_CLIENT_receive (h->client, &msg_received, h,
946 GNUNET_TIME_UNIT_FOREVER_REL);
950 /******************************************************************************/
951 /************************ SEND FUNCTIONS ****************************/
952 /******************************************************************************/
955 * Function called to send a message to the service.
956 * "buf" will be NULL and "size" zero if the socket was closed for writing in
959 * @param cls closure, the mesh handle
960 * @param size number of bytes available in buf
961 * @param buf where the callee should write the connect message
962 * @return number of bytes written to buf
965 send_callback (void *cls, size_t size, void *buf)
967 struct GNUNET_MESH_Handle *h = cls;
968 struct GNUNET_MESH_TransmitHandle *th;
973 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
975 if ((0 == size) || (NULL == buf))
981 while ((NULL != (th = h->th_head)) && (size >= th->size))
984 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: type: %u\n",
985 ntohs (((struct GNUNET_MessageHeader *) &th[1])->type));
986 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: size: %u\n",
987 ntohs (((struct GNUNET_MessageHeader *) &th[1])->size));
989 if (NULL != th->notify)
994 struct GNUNET_MESH_Multicast mc;
996 GNUNET_assert (size >= sizeof (mc) + th->size);
998 th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
1001 mc.header.size = htons (sizeof (mc) + th->size);
1002 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1003 mc.tid = htonl (th->tunnel->tid);
1004 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1005 memcpy (cbuf, &mc, sizeof (mc));
1006 psize = th->size + sizeof (mc);
1012 struct GNUNET_MESH_Unicast uc;
1014 GNUNET_assert (size >= sizeof (uc) + th->size);
1016 th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
1019 uc.header.size = htons (sizeof (uc) + th->size);
1020 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1021 uc.tid = htonl (th->tunnel->tid);
1022 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1023 GNUNET_PEER_resolve (th->target, &uc.destination);
1024 memcpy (cbuf, &uc, sizeof (uc));
1025 psize = th->size + sizeof (uc);
1031 memcpy (cbuf, &th[1], th->size);
1034 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1035 GNUNET_SCHEDULER_cancel (th->timeout_task);
1036 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1042 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
1043 if (NULL != (th = h->th_head))
1045 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
1047 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1048 GNUNET_TIME_UNIT_FOREVER_REL,
1049 GNUNET_YES, &send_callback, h);
1051 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
1052 if (GNUNET_NO == h->in_receive)
1054 h->in_receive = GNUNET_YES;
1055 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1056 GNUNET_TIME_UNIT_FOREVER_REL);
1063 * Auxiliary function to send an already constructed packet to the service.
1064 * Takes care of creating a new queue element, copying the message and
1065 * calling the tmt_rdy function if necessary.
1066 * @param h mesh handle
1067 * @param msg message to transmit
1070 send_packet (struct GNUNET_MESH_Handle *h,
1071 const struct GNUNET_MessageHeader *msg)
1073 struct GNUNET_MESH_TransmitHandle *th;
1076 msize = ntohs (msg->size);
1077 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1078 th->priority = UINT32_MAX;
1079 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1081 memcpy (&th[1], msg, msize);
1082 add_to_queue (h, th);
1086 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1087 GNUNET_TIME_UNIT_FOREVER_REL,
1088 GNUNET_YES, &send_callback, h);
1092 /******************************************************************************/
1093 /********************** API CALL DEFINITIONS *************************/
1094 /******************************************************************************/
1097 * Connect to the mesh service.
1099 * @param cfg configuration to use
1100 * @param queue_size size of the data message queue, shared among all tunnels
1101 * (each tunnel is guaranteed to accept at least one message,
1102 * no matter what is the status of other tunnels)
1103 * @param cls closure for the various callbacks that follow
1104 * (including handlers in the handlers array)
1105 * @param new_tunnel function called when an *inbound* tunnel is created
1106 * @param cleaner function called when an *inbound* tunnel is destroyed
1107 * @param handlers callbacks for messages we care about, NULL-terminated
1108 * note that the mesh is allowed to drop notifications about
1109 * inbound messages if the client does not process them fast
1110 * enough (for this notification type, a bounded queue is used)
1111 * @param stypes list of the applications that this client claims to provide
1112 * @return handle to the mesh service NULL on error
1113 * (in this case, init is never called)
1115 struct GNUNET_MESH_Handle *
1116 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1117 unsigned int queue_size, void *cls,
1118 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1119 GNUNET_MESH_TunnelEndHandler cleaner,
1120 const struct GNUNET_MESH_MessageHandler *handlers,
1121 const GNUNET_MESH_ApplicationType *stypes)
1123 struct GNUNET_MESH_Handle *h;
1124 struct GNUNET_MESH_ClientConnect *msg;
1125 GNUNET_MESH_ApplicationType *apps;
1131 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1132 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1134 h->max_queue_size = queue_size;
1135 h->new_tunnel = new_tunnel;
1136 h->cleaner = cleaner;
1137 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1138 if (h->client == NULL)
1146 h->applications = stypes;
1147 h->message_handlers = handlers;
1148 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1149 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1151 /* count handlers and apps, calculate size */
1152 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1153 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1154 size = sizeof (struct GNUNET_MESH_ClientConnect);
1155 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
1156 size += h->n_handlers * sizeof (uint16_t);
1161 /* build connection packet */
1162 msg = (struct GNUNET_MESH_ClientConnect *) buf;
1163 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
1164 msg->header.size = htons (size);
1165 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
1166 for (napps = 0; napps < h->n_applications; napps++)
1168 apps[napps] = htonl (h->applications[napps]);
1169 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: app %u\n",
1170 h->applications[napps]);
1172 types = (uint16_t *) & apps[napps];
1173 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
1174 types[ntypes] = htons (h->message_handlers[ntypes].type);
1175 msg->applications = htons (napps);
1176 msg->types = htons (ntypes);
1178 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1179 "mesh: Sending %lu bytes long message %d types and %d apps\n",
1180 ntohs (msg->header.size), ntypes, napps);
1182 send_packet (h, &msg->header);
1184 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1190 * Disconnect from the mesh service.
1192 * @param handle connection to mesh to disconnect
1195 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1197 struct GNUNET_MESH_Tunnel *t;
1198 struct GNUNET_MESH_Tunnel *aux;
1200 t = handle->tunnels_head;
1207 if (NULL != handle->th)
1209 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1211 if (NULL != handle->client)
1213 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1215 GNUNET_free (handle);
1220 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1221 * and to broadcast).
1223 * @param h mesh handle
1224 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1225 * @param connect_handler function to call when peers are actually connected
1226 * @param disconnect_handler function to call when peers are disconnected
1227 * @param handler_cls closure for connect/disconnect handlers
1229 struct GNUNET_MESH_Tunnel *
1230 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1231 GNUNET_MESH_PeerConnectHandler connect_handler,
1232 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1235 struct GNUNET_MESH_Tunnel *t;
1236 struct GNUNET_MESH_TunnelMessage msg;
1238 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1239 t = create_tunnel (h, 0);
1240 t->connect_handler = connect_handler;
1241 t->disconnect_handler = disconnect_handler;
1242 t->cls = handler_cls;
1243 t->ctx = tunnel_ctx;
1244 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1245 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1246 msg.tunnel_id = htonl (t->tid);
1247 send_packet (h, &msg.header);
1253 * Destroy an existing tunnel.
1255 * @param tun tunnel handle
1258 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1260 struct GNUNET_MESH_Handle *h;
1261 struct GNUNET_MESH_TunnelMessage msg;
1263 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1266 if (0 != tunnel->owner)
1267 GNUNET_PEER_change_rc (tunnel->owner, -1);
1269 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1270 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1271 msg.tunnel_id = htonl (tunnel->tid);
1272 destroy_tunnel (tunnel);
1273 send_packet (h, &msg.header);
1278 * Request that a peer should be added to the tunnel. The existing
1279 * connect handler will be called ONCE with either success or failure.
1280 * This function should NOT be called again with the same peer before the
1281 * connect handler is called.
1283 * @param tunnel handle to existing tunnel
1284 * @param peer peer to add
1287 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1288 const struct GNUNET_PeerIdentity *peer)
1290 struct GNUNET_MESH_PeerControl msg;
1291 GNUNET_PEER_Id peer_id;
1294 peer_id = GNUNET_PEER_intern (peer);
1295 for (i = 0; i < tunnel->npeers; i++)
1297 if (tunnel->peers[i]->id == peer_id)
1299 GNUNET_PEER_change_rc (peer_id, -1);
1304 if (NULL == add_peer_to_tunnel (tunnel, peer))
1307 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1308 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1309 msg.tunnel_id = htonl (tunnel->tid);
1311 send_packet (tunnel->mesh, &msg.header);
1318 * Request that a peer should be removed from the tunnel. The existing
1319 * disconnect handler will be called ONCE if we were connected.
1321 * @param tunnel handle to existing tunnel
1322 * @param peer peer to remove
1325 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1326 const struct GNUNET_PeerIdentity *peer)
1328 struct GNUNET_MESH_PeerControl msg;
1329 GNUNET_PEER_Id peer_id;
1332 peer_id = GNUNET_PEER_search (peer);
1338 for (i = 0; i < tunnel->npeers; i++)
1339 if (tunnel->peers[i]->id == peer_id)
1341 if (i == tunnel->npeers)
1346 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1347 tunnel->disconnect_handler (tunnel->cls, peer);
1348 GNUNET_PEER_change_rc (peer_id, -1);
1349 GNUNET_free (tunnel->peers[i]);
1350 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1351 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1353 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1354 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1355 msg.tunnel_id = htonl (tunnel->tid);
1356 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1357 send_packet (tunnel->mesh, &msg.header);
1362 * Request that the mesh should try to connect to a peer supporting the given
1365 * @param tunnel handle to existing tunnel
1366 * @param app_type application type that must be supported by the peer (MESH
1367 * should discover peer in proximity handling this type)
1370 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1371 GNUNET_MESH_ApplicationType app_type)
1373 struct GNUNET_MESH_ConnectPeerByType msg;
1375 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1377 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1378 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1379 msg.tunnel_id = htonl (tunnel->tid);
1380 msg.type = htonl (app_type);
1381 send_packet (tunnel->mesh, &msg.header);
1386 * Ask the mesh to call "notify" once it is ready to transmit the
1387 * given number of bytes to the specified "target". If we are not yet
1388 * connected to the specified peer, a call to this function will cause
1389 * us to try to establish a connection.
1391 * @param tunnel tunnel to use for transmission
1392 * @param cork is corking allowed for this transmission?
1393 * @param priority how important is the message?
1394 * @param maxdelay how long can the message wait?
1395 * @param target destination for the message,
1396 * NULL for multicast to all tunnel targets
1397 * @param notify_size how many bytes of buffer space does notify want?
1398 * @param notify function to call when buffer space is available;
1399 * will be called with NULL on timeout or if the overall queue
1400 * for this peer is larger than queue_size and this is currently
1401 * the message with the lowest priority
1402 * @param notify_cls closure for notify
1403 * @return non-NULL if the notify callback was queued,
1404 * NULL if we can not even queue the request (insufficient
1405 * memory); if NULL is returned, "notify" will NOT be called.
1407 struct GNUNET_MESH_TransmitHandle *
1408 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1410 struct GNUNET_TIME_Relative maxdelay,
1411 const struct GNUNET_PeerIdentity *target,
1413 GNUNET_CONNECTION_TransmitReadyNotify notify,
1416 struct GNUNET_MESH_TransmitHandle *th;
1417 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1418 uint32_t least_priority;
1421 GNUNET_assert (NULL != notify);
1422 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1423 tunnel->npackets > 0)
1428 th = tunnel->mesh->th_tail;
1429 least_priority = priority;
1430 least_priority_th = NULL;
1433 if (th->priority < least_priority && th->tunnel->npackets > 1)
1435 least_priority_th = th;
1436 least_priority = th->priority;
1440 if (NULL == least_priority_th)
1442 /* Can't be a control message */
1443 GNUNET_assert (NULL != least_priority_th->notify);
1444 least_priority_th->notify (notify_cls, 0, NULL);
1445 least_priority_th->tunnel->npackets--;
1446 tunnel->mesh->npackets--;
1447 GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1449 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1450 GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1451 GNUNET_free (least_priority_th);
1454 tunnel->mesh->npackets++;
1455 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1456 th->tunnel = tunnel;
1457 th->priority = priority;
1458 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1459 th->target = GNUNET_PEER_intern (target);
1461 overhead = sizeof (struct GNUNET_MESH_Multicast);
1463 overhead = sizeof (struct GNUNET_MESH_Unicast);
1464 th->size = notify_size + overhead;
1465 th->notify = notify;
1466 th->notify_cls = notify_cls;
1467 add_to_queue (tunnel->mesh, th);
1473 * Cancel the specified transmission-ready notification.
1475 * @param th handle that was returned by "notify_transmit_ready".
1478 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1480 struct GNUNET_MESH_Handle *mesh;
1482 mesh = th->tunnel->mesh;
1483 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1484 GNUNET_SCHEDULER_cancel (th->timeout_task);
1485 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1487 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1489 /* queue empty, no point in asking for transmission */
1490 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1496 #if 0 /* keep Emacsens' auto-indent happy */