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 * - Check priorities to cancel traffic data
27 * - Use separate message types for tunnel creation s -> c (+pi) and c -> s
32 * - AUXILIARY FUNCTIONS
35 * - API CALL DEFINITIONS
40 #if 0 /* keep Emacsens' auto-indent happy */
46 #include "gnunet_common.h"
47 #include "gnunet_client_lib.h"
48 #include "gnunet_util_lib.h"
49 #include "gnunet_peer_lib.h"
50 #include "gnunet_mesh_service_new.h"
52 #include "mesh_protocol.h"
54 #define DEBUG GNUNET_YES
56 /******************************************************************************/
57 /************************ DATA STRUCTURES ****************************/
58 /******************************************************************************/
61 * Transmission queue to the service
63 struct GNUNET_MESH_TransmitHandle
69 struct GNUNET_MESH_TransmitHandle *next;
74 struct GNUNET_MESH_TransmitHandle *prev;
77 * Tunnel this message is sent over (may be NULL for control messages).
79 struct GNUNET_MESH_Tunnel *tunnel;
82 * Callback to obtain the message to transmit, or NULL if we
83 * got the message in 'data'. Notice that messages built
84 * by 'notify' need to be encapsulated with information about
87 GNUNET_CONNECTION_TransmitReadyNotify notify;
90 * Closure for 'notify'
95 * How long is this message valid. Once the timeout has been
96 * reached, the message must no longer be sent. If this
97 * is a message with a 'notify' callback set, the 'notify'
98 * function should be called with 'buf' NULL and size 0.
100 struct GNUNET_TIME_Absolute timeout;
103 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
105 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
108 * Priority of the message. The queue is sorted by priority,
109 * control messages have the maximum priority (UINT32_MAX).
114 * Target of the message, 0 for broadcast. This field
115 * is only valid if 'notify' is non-NULL.
117 GNUNET_PEER_Id target;
120 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
127 * Opaque handle to the service.
129 struct GNUNET_MESH_Handle
133 * Handle to the server connection, to send messages later
135 struct GNUNET_CLIENT_Connection *client;
138 * Set of handlers used for processing incoming messages in the tunnels
140 const struct GNUNET_MESH_MessageHandler *message_handlers;
143 * Set of applications that should be claimed to be offered at this node.
144 * Note that this is just informative, the appropiate handlers must be
145 * registered independently and the mapping is up to the developer of the
146 * client application.
148 const GNUNET_MESH_ApplicationType *applications;
151 * Double linked list of the tunnels this client is connected to.
153 struct GNUNET_MESH_Tunnel *tunnels_head;
154 struct GNUNET_MESH_Tunnel *tunnels_tail;
157 * Callback for inbound tunnel creation
159 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
162 * Callback for inbound tunnel disconnection
164 GNUNET_MESH_TunnelEndHandler *cleaner;
167 * Handle to cancel pending transmissions in case of disconnection
169 struct GNUNET_CLIENT_TransmitHandle *th;
172 * Closure for all the handlers given by the client
177 * Messages to send to the service
179 struct GNUNET_MESH_TransmitHandle *th_head;
180 struct GNUNET_MESH_TransmitHandle *th_tail;
183 * tid of the next tunnel to create (to avoid reusing IDs often)
185 MESH_TunnelNumber next_tid;
186 unsigned int n_handlers;
187 unsigned int n_applications;
188 unsigned int max_queue_size;
191 * Have we started the task to receive messages from the service
192 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
197 * Number of packets queued
199 unsigned int npackets;
202 * Configuration given by the client, in case of reconnection
204 const struct GNUNET_CONFIGURATION_Handle *cfg;
209 * Description of a peer
211 struct GNUNET_MESH_Peer
214 * ID of the peer in short form
219 * Tunnel this peer belongs to
221 struct GNUNET_MESH_Tunnel *t;
224 * Flag indicating whether service has informed about its connection
232 * Opaque handle to a tunnel.
234 struct GNUNET_MESH_Tunnel
240 struct GNUNET_MESH_Tunnel *next;
241 struct GNUNET_MESH_Tunnel *prev;
244 * Callback to execute when peers connect to the tunnel
246 GNUNET_MESH_TunnelConnectHandler connect_handler;
249 * Callback to execute when peers disconnect from the tunnel
251 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler;
254 * Closure for the connect/disconnect handlers
259 * Handle to the mesh this tunnel belongs to
261 struct GNUNET_MESH_Handle *mesh;
264 * Local ID of the tunnel
266 MESH_TunnelNumber tid;
269 * Owner of the tunnel
271 GNUNET_PEER_Id owner;
274 * All peers added to the tunnel
276 struct GNUNET_MESH_Peer **peers;
279 * List of application types that have been requested for this tunnel
281 GNUNET_MESH_ApplicationType *apps;
284 * Any data the caller wants to put in here
289 * Number of peers added to the tunnel
294 * Number of packets queued in this tunnel
296 unsigned int npackets;
299 * Number of applications requested this tunnel
306 /******************************************************************************/
307 /*********************** AUXILIARY FUNCTIONS *************************/
308 /******************************************************************************/
311 * Get the tunnel handler for the tunnel specified by id from the given handle
312 * @param h Mesh handle
313 * @param tid ID of the wanted tunnel
314 * @return handle to the required tunnel or NULL if not found
316 static struct GNUNET_MESH_Tunnel *
317 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
319 struct GNUNET_MESH_Tunnel *t;
333 * Create a new tunnel and insert it in the tunnel list of the mesh handle
334 * @param h Mesh handle
335 * @param tid desired tid of the tunnel, 0 to assign one automatically
336 * @return handle to the created tunnel
338 static struct GNUNET_MESH_Tunnel *
339 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
341 struct GNUNET_MESH_Tunnel *t;
343 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
344 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
348 t->tid = h->next_tid;
349 while (NULL != retrieve_tunnel (h, h->next_tid))
352 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
353 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
365 * Destroy the specified tunnel.
366 * - Destroys all peers, calling the disconnect callback on each if needed
367 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
368 * - Calls cleaner if tunnel was inbound
369 * - Frees all memory used
370 * @param tid ID of the wanted tunnel
371 * @return handle to the required tunnel or NULL if not found
374 destroy_tunnel (struct GNUNET_MESH_Tunnel *t)
376 struct GNUNET_MESH_Handle *h;
377 struct GNUNET_PeerIdentity pi;
378 struct GNUNET_MESH_TransmitHandle *th;
379 struct GNUNET_MESH_TransmitHandle *aux;
394 GNUNET_CONTAINER_DLL_remove(h->th_head, h->th_tail, th);
395 if (NULL == h->th_head && NULL != h->th)
397 GNUNET_CLIENT_notify_transmit_ready_cancel(h->th);
400 if (NULL != th->notify)
401 th->notify(th->notify_cls, 0, NULL);
402 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
403 GNUNET_SCHEDULER_cancel(th->timeout_task);
412 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
413 for (i = 0; i < t->npeers; i++)
415 if (NULL != t->disconnect_handler && t->peers[i]->connected)
417 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
418 t->disconnect_handler (t->cls, &pi);
420 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
421 GNUNET_free (t->peers[i]);
424 GNUNET_free (t->peers);
425 if (NULL != h->cleaner && 0 != t->owner)
426 h->cleaner (h->cls, t, t->ctx);
428 GNUNET_PEER_change_rc (t->owner, -1);
429 if (0 != t->napps && t->apps)
430 GNUNET_free (t->apps);
436 * Get the peer descriptor for the peer with id from the given tunnel
437 * @param t Tunnel handle
438 * @param id Short form ID of the wanted peer
439 * @return handle to the requested peer or NULL if not found
441 static struct GNUNET_MESH_Peer *
442 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
446 for (i = 0; i < t->npeers; i++)
447 if (t->peers[i]->id == id)
454 * Add a peer into a tunnel
455 * @param t Tunnel handle
456 * @param pi Full ID of the new peer
457 * @return handle to the newly created peer
459 static struct GNUNET_MESH_Peer *
460 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
461 const struct GNUNET_PeerIdentity *pi)
463 struct GNUNET_MESH_Peer *p;
471 id = GNUNET_PEER_intern (pi);
473 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
476 GNUNET_array_append (t->peers, t->npeers, p);
482 * Remove a peer from a tunnel
483 * @param t Tunnel handle
484 * @param p Peer handle
487 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
491 for (i = 0; i < p->t->npeers; i++)
493 if (p->t->peers[i] == p)
496 if (i == p->t->npeers)
501 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
502 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
507 * Notify client that the transmission has timed out
509 * @param tc task context
512 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
514 struct GNUNET_MESH_TransmitHandle *th = cls;
515 struct GNUNET_MESH_Handle *mesh;
517 mesh = th->tunnel->mesh;
518 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
519 if (th->notify != NULL)
520 th->notify (th->notify_cls, 0, NULL);
522 if ((NULL == mesh->th_head) && (NULL != mesh->th))
524 /* queue empty, no point in asking for transmission */
525 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
532 * Add a transmit handle to the transmission queue by priority and set the
535 * @param h mesh handle with the queue head and tail
536 * @param q handle to the packet to be transmitted
539 add_to_queue (struct GNUNET_MESH_Handle *h,
540 struct GNUNET_MESH_TransmitHandle *th)
542 struct GNUNET_MESH_TransmitHandle *p;
545 while ((NULL != p) && (th->priority <= p->priority))
551 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
552 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
555 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
556 (th->timeout), &timeout_transmission, th);
561 send_packet (struct GNUNET_MESH_Handle *h,
562 const struct GNUNET_MessageHeader *msg);
566 * Reconnect to the service, retransmit all infomation to try to restore the
569 * @param h handle to the mesh
571 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
574 reconnect (struct GNUNET_MESH_Handle *h)
576 struct GNUNET_MESH_Tunnel *t;
579 h->in_receive = GNUNET_NO;
583 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
585 if (NULL != h->client)
587 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
591 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
592 if (h->client == NULL)
594 /* FIXME: panic? exponential backoff retry? */
598 /* Rebuild all tunnels */
599 for (t = h->tunnels_head; NULL != t; t = t->next)
601 struct GNUNET_MESH_TunnelMessage tmsg;
602 struct GNUNET_MESH_PeerControl pmsg;
604 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
605 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
606 tmsg.tunnel_id = htonl (t->tid);
607 send_packet (h, &tmsg.header);
609 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
610 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
611 pmsg.tunnel_id = htonl (t->tid);
613 /* Reconnect all peers */
614 for (i = 0; i < t->npeers; i++)
616 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
617 if (NULL != t->disconnect_handler && t->peers[i]->connected)
618 t->disconnect_handler (t->cls, &pmsg.peer);
619 /* If the tunnel was "by type", dont connect individual peers */
621 send_packet (t->mesh, &pmsg.header);
623 /* Reconnect all types, if any */
624 for (i = 0; i < t->napps; i++)
626 struct GNUNET_MESH_ConnectPeerByType msg;
628 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
629 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
630 msg.tunnel_id = htonl (t->tid);
631 msg.type = htonl (t->apps[i]);
632 send_packet (t->mesh, &msg.header);
639 /******************************************************************************/
640 /*********************** RECEIVE HANDLERS ****************************/
641 /******************************************************************************/
644 * Process the new tunnel notification and add it to the tunnels in the handle
646 * @param h The mesh handle
647 * @param msg A message with the details of the new incoming tunnel
650 process_tunnel_create (struct GNUNET_MESH_Handle *h,
651 const struct GNUNET_MESH_TunnelMessage *msg)
653 struct GNUNET_MESH_Tunnel *t;
654 struct GNUNET_TRANSPORT_ATS_Information atsi;
655 MESH_TunnelNumber tid;
657 tid = ntohl (msg->tunnel_id);
658 if (tid <= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI)
663 t = create_tunnel (h, tid);
664 t->owner = GNUNET_PEER_intern (&msg->peer);
666 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
667 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
669 t->peers[0]->connected = 1;
670 t->peers[0]->id = t->owner;
673 if (NULL != h->new_tunnel)
677 t->ctx = h->new_tunnel(h->cls, t, &msg->peer, &atsi);
679 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
685 * Process the tunnel destroy notification and free associated resources
687 * @param h The mesh handle
688 * @param msg A message with the details of the tunnel being destroyed
691 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
692 const struct GNUNET_MESH_TunnelMessage *msg)
694 struct GNUNET_MESH_Tunnel *t;
695 MESH_TunnelNumber tid;
697 tid = ntohl (msg->tunnel_id);
698 t = retrieve_tunnel (h, tid);
716 * Process the new peer event and notify the upper level of it
718 * @param h The mesh handle
719 * @param msg A message with the details of the peer event
722 process_peer_event (struct GNUNET_MESH_Handle *h,
723 const struct GNUNET_MESH_PeerControl *msg)
725 struct GNUNET_MESH_Tunnel *t;
726 struct GNUNET_MESH_Peer *p;
727 struct GNUNET_TRANSPORT_ATS_Information atsi;
731 size = ntohs (msg->header.size);
732 if (size != sizeof (struct GNUNET_MESH_PeerControl))
737 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
743 id = GNUNET_PEER_search (&msg->peer);
744 if ((p = retrieve_peer (t, id)) == NULL)
745 p = add_peer_to_tunnel (t, &msg->peer);
746 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == msg->header.type)
748 if (NULL != t->connect_handler)
752 t->connect_handler (t->cls, &msg->peer, &atsi);
758 if (NULL != t->disconnect_handler && p->connected)
760 t->disconnect_handler (t->cls, &msg->peer);
762 remove_peer_from_tunnel (p);
769 * Process the incoming data packets
771 * @param h The mesh handle
772 * @param msh A message encapsulating the data
775 process_incoming_data (struct GNUNET_MESH_Handle *h,
776 const struct GNUNET_MessageHeader *message)
778 const struct GNUNET_MessageHeader *payload;
779 const struct GNUNET_MESH_MessageHandler *handler;
780 const struct GNUNET_PeerIdentity *peer;
781 struct GNUNET_MESH_Unicast *ucast;
782 struct GNUNET_MESH_Multicast *mcast;
783 struct GNUNET_MESH_ToOrigin *to_orig;
784 struct GNUNET_MESH_Tunnel *t;
788 type = ntohs (message->type);
791 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
792 ucast = (struct GNUNET_MESH_Unicast *) message;
793 t = retrieve_tunnel (h, ntohl (ucast->tid));
794 payload = (struct GNUNET_MessageHeader *) &ucast[1];
797 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
798 mcast = (struct GNUNET_MESH_Multicast *) message;
799 t = retrieve_tunnel (h, ntohl (mcast->tid));
800 payload = (struct GNUNET_MessageHeader *) &mcast[1];
803 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
804 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
805 t = retrieve_tunnel (h, ntohl (to_orig->tid));
806 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
807 peer = &to_orig->sender;
818 for (i = 0; i < h->n_handlers; i++)
820 handler = &h->message_handlers[i];
821 if (handler->type == type)
823 struct GNUNET_TRANSPORT_ATS_Information atsi;
828 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
830 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
831 "MESH: callback completed successfully\n");
835 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
836 "MESH: callback caused disconnection\n");
837 GNUNET_MESH_disconnect (h);
845 * Function to process all messages received from the service
848 * @param msg message received, NULL on timeout or fatal error
851 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
853 struct GNUNET_MESH_Handle *h = cls;
855 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: received a message from MESH\n");
861 switch (ntohs (msg->type))
863 /* Notify of a new incoming tunnel */
864 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
865 process_tunnel_create (h, (struct GNUNET_MESH_TunnelMessage *) msg);
867 /* Notify of a tunnel disconnection */
868 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
869 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
871 /* Notify of a new peer or a peer disconnect in the tunnel */
872 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
873 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
874 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
876 /* Notify of a new data packet in the tunnel */
877 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
878 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
879 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
880 process_incoming_data (h, msg);
882 /* We shouldn't get any other packages, log and ignore */
884 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
885 "MESH: unsolicited message form service (type %d)\n",
888 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: message processed\n");
889 GNUNET_CLIENT_receive (h->client, &msg_received, h,
890 GNUNET_TIME_UNIT_FOREVER_REL);
894 /******************************************************************************/
895 /************************ SEND FUNCTIONS ****************************/
896 /******************************************************************************/
899 * Function called to send a message to the service.
900 * "buf" will be NULL and "size" zero if the socket was closed for writing in
903 * @param cls closure, the mesh handle
904 * @param size number of bytes available in buf
905 * @param buf where the callee should write the connect message
906 * @return number of bytes written to buf
909 send_callback (void *cls, size_t size, void *buf)
911 struct GNUNET_MESH_Handle *h = cls;
912 struct GNUNET_MESH_TransmitHandle *th;
917 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() Buffer %u\n", size);
919 if ((0 == size) || (NULL == buf))
925 while ((NULL != (th = h->th_head)) && (size >= th->size))
928 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: type: %u\n",
929 ntohs (((struct GNUNET_MessageHeader *)&th[1])->type));
930 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: size: %u\n",
931 ntohs (((struct GNUNET_MessageHeader *)&th[1])->size));
933 if (NULL != th->notify)
938 struct GNUNET_MESH_Multicast mc;
940 GNUNET_assert (size >= sizeof (mc) + th->size);
942 th->notify (th->notify_cls, size - sizeof (mc), &cbuf[sizeof (mc)]);
945 mc.header.size = htons (sizeof (mc) + th->size);
946 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
947 mc.tid = htonl (th->tunnel->tid);
948 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
949 memcpy (cbuf, &mc, sizeof (mc));
950 psize = th->size + sizeof (mc);
956 struct GNUNET_MESH_Unicast uc;
958 GNUNET_assert (size >= sizeof (uc) + th->size);
960 th->notify (th->notify_cls, size - sizeof (uc), &cbuf[sizeof (uc)]);
963 uc.header.size = htons (sizeof (uc) + th->size);
964 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
965 uc.tid = htonl (th->tunnel->tid);
966 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity)); /* myself */
967 GNUNET_PEER_resolve (th->target, &uc.destination);
968 memcpy (cbuf, &uc, sizeof (uc));
969 psize = th->size + sizeof (uc);
975 memcpy (cbuf, &th[1], th->size);
978 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
979 GNUNET_SCHEDULER_cancel (th->timeout_task);
980 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
986 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: total size: %u\n", tsize);
987 if (NULL != (th = h->th_head))
989 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: next size: %u\n", th->size);
991 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
992 GNUNET_TIME_UNIT_FOREVER_REL,
993 GNUNET_YES, &send_callback, h);
995 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Send packet() END\n");
996 if (GNUNET_NO == h->in_receive)
998 h->in_receive = GNUNET_YES;
999 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1000 GNUNET_TIME_UNIT_FOREVER_REL);
1007 * Auxiliary function to send an already constructed packet to the service.
1008 * Takes care of creating a new queue element, copying the message and
1009 * calling the tmt_rdy function if necessary.
1010 * @param h mesh handle
1011 * @param msg message to transmit
1014 send_packet (struct GNUNET_MESH_Handle *h,
1015 const struct GNUNET_MessageHeader *msg)
1017 struct GNUNET_MESH_TransmitHandle *th;
1020 msize = ntohs (msg->size);
1021 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1022 th->priority = UINT32_MAX;
1023 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1025 memcpy (&th[1], msg, msize);
1026 add_to_queue (h, th);
1030 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1031 GNUNET_TIME_UNIT_FOREVER_REL,
1032 GNUNET_YES, &send_callback, h);
1036 /******************************************************************************/
1037 /********************** API CALL DEFINITIONS *************************/
1038 /******************************************************************************/
1041 * Connect to the mesh service.
1043 * @param cfg configuration to use
1044 * @param queue_size size of the data message queue, shared among all tunnels
1045 * (each tunnel is guaranteed to accept at least one message,
1046 * no matter what is the status of other tunnels)
1047 * @param cls closure for the various callbacks that follow
1048 * (including handlers in the handlers array)
1049 * @param new_tunnel function called when an *inbound* tunnel is created
1050 * @param cleaner function called when an *inbound* tunnel is destroyed
1051 * @param handlers callbacks for messages we care about, NULL-terminated
1052 * note that the mesh is allowed to drop notifications about
1053 * inbound messages if the client does not process them fast
1054 * enough (for this notification type, a bounded queue is used)
1055 * @param stypes list of the applications that this client claims to provide
1056 * @return handle to the mesh service NULL on error
1057 * (in this case, init is never called)
1059 struct GNUNET_MESH_Handle *
1060 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1061 unsigned int queue_size, void *cls,
1062 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1063 GNUNET_MESH_TunnelEndHandler cleaner,
1064 const struct GNUNET_MESH_MessageHandler *handlers,
1065 const GNUNET_MESH_ApplicationType *stypes)
1067 struct GNUNET_MESH_Handle *h;
1068 struct GNUNET_MESH_ClientConnect *msg;
1069 GNUNET_MESH_ApplicationType *apps;
1075 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect()\n");
1076 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1078 h->max_queue_size = queue_size;
1079 h->new_tunnel = new_tunnel;
1080 h->cleaner = cleaner;
1081 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1082 if (h->client == NULL)
1089 h->message_handlers = handlers;
1090 h->applications = stypes;
1091 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1093 /* count handlers and apps, calculate size */
1094 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1095 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1096 size = sizeof (struct GNUNET_MESH_ClientConnect);
1097 size += h->n_handlers * sizeof (uint16_t);
1098 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
1103 /* build connection packet */
1104 msg = (struct GNUNET_MESH_ClientConnect *) buf;
1105 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
1106 msg->header.size = htons (size);
1107 types = (uint16_t *) & msg[1];
1108 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
1109 types[ntypes] = h->message_handlers[ntypes].type;
1110 apps = (GNUNET_MESH_ApplicationType *) &types[ntypes];
1111 for (napps = 0; napps < h->n_applications; napps++)
1112 apps[napps] = h->applications[napps];
1113 msg->applications = htons (napps);
1114 msg->types = htons (ntypes);
1115 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1116 "mesh: Sending %lu bytes long message %d types and %d apps\n",
1117 ntohs (msg->header.size), ntypes, napps);
1118 send_packet (h, &msg->header);
1120 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: GNUNET_MESH_connect() END\n");
1126 * Disconnect from the mesh service.
1128 * @param handle connection to mesh to disconnect
1131 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1133 struct GNUNET_MESH_Tunnel *t;
1135 for (t = handle->tunnels_head; NULL != t; t = t->next)
1139 if (NULL != handle->th)
1141 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1143 if (NULL != handle->client)
1145 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1147 GNUNET_free (handle);
1152 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1153 * and to broadcast).
1155 * @param h mesh handle
1156 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1157 * @param connect_handler function to call when peers are actually connected
1158 * @param disconnect_handler function to call when peers are disconnected
1159 * @param handler_cls closure for connect/disconnect handlers
1161 struct GNUNET_MESH_Tunnel *
1162 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1163 GNUNET_MESH_TunnelConnectHandler connect_handler,
1164 GNUNET_MESH_TunnelDisconnectHandler
1165 disconnect_handler, void *handler_cls)
1167 struct GNUNET_MESH_Tunnel *t;
1168 struct GNUNET_MESH_TunnelMessage msg;
1170 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Creating new tunnel\n");
1171 t = create_tunnel (h, 0);
1172 t->connect_handler = connect_handler;
1173 t->disconnect_handler = disconnect_handler;
1174 t->cls = handler_cls;
1175 t->ctx = tunnel_ctx;
1176 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1177 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1178 msg.tunnel_id = htonl (t->tid);
1179 send_packet (h, &msg.header);
1185 * Destroy an existing tunnel.
1187 * @param tun tunnel handle
1190 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *t)
1192 struct GNUNET_MESH_Handle *h;
1193 struct GNUNET_MESH_TunnelMessage msg;
1195 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "mesh: Destroying tunnel\n");
1199 GNUNET_PEER_change_rc (t->owner, -1);
1201 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1202 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1203 msg.tunnel_id = htonl (t->tid);
1205 send_packet (h, &msg.header);
1210 * Request that a peer should be added to the tunnel. The existing
1211 * connect handler will be called ONCE with either success or failure.
1212 * This function should NOT be called again with the same peer before the
1213 * connect handler is called.
1215 * @param tunnel handle to existing tunnel
1216 * @param timeout how long to try to establish a connection
1217 * @param peer peer to add
1220 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1221 const struct GNUNET_PeerIdentity *peer)
1223 struct GNUNET_MESH_PeerControl msg;
1224 GNUNET_PEER_Id peer_id;
1227 peer_id = GNUNET_PEER_intern (peer);
1228 for (i = 0; i < tunnel->npeers; i++)
1230 if (tunnel->peers[i]->id == peer_id)
1232 GNUNET_PEER_change_rc (peer_id, -1);
1237 if (NULL == add_peer_to_tunnel (tunnel, peer))
1240 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1241 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1242 msg.tunnel_id = htonl (tunnel->tid);
1244 send_packet (tunnel->mesh, &msg.header);
1251 * Request that a peer should be removed from the tunnel. The existing
1252 * disconnect handler will be called ONCE if we were connected.
1254 * @param tunnel handle to existing tunnel
1255 * @param peer peer to remove
1258 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1259 const struct GNUNET_PeerIdentity *peer)
1261 struct GNUNET_MESH_PeerControl msg;
1262 GNUNET_PEER_Id peer_id;
1265 peer_id = GNUNET_PEER_search (peer);
1271 for (i = 0; i < tunnel->npeers; i++)
1272 if (tunnel->peers[i]->id == peer_id)
1274 if (i == tunnel->npeers)
1279 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1280 tunnel->disconnect_handler (tunnel->cls, peer);
1281 GNUNET_PEER_change_rc (peer_id, -1);
1282 GNUNET_free (tunnel->peers[i]);
1283 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1284 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1286 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1287 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1288 msg.tunnel_id = htonl (tunnel->tid);
1289 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1290 send_packet (tunnel->mesh, &msg.header);
1295 * Request that the mesh should try to connect to a peer supporting the given
1298 * @param tunnel handle to existing tunnel
1299 * @param app_type application type that must be supported by the peer (MESH
1300 * should discover peer in proximity handling this type)
1303 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1304 GNUNET_MESH_ApplicationType app_type)
1306 struct GNUNET_MESH_ConnectPeerByType msg;
1308 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1310 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1311 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1312 msg.tunnel_id = htonl (tunnel->tid);
1313 msg.type = htonl (app_type);
1314 send_packet (tunnel->mesh, &msg.header);
1319 * Ask the mesh to call "notify" once it is ready to transmit the
1320 * given number of bytes to the specified "target". If we are not yet
1321 * connected to the specified peer, a call to this function will cause
1322 * us to try to establish a connection.
1324 * @param tunnel tunnel to use for transmission
1325 * @param cork is corking allowed for this transmission?
1326 * @param priority how important is the message?
1327 * @param maxdelay how long can the message wait?
1328 * @param target destination for the message,
1329 * NULL for multicast to all tunnel targets
1330 * @param notify_size how many bytes of buffer space does notify want?
1331 * @param notify function to call when buffer space is available;
1332 * will be called with NULL on timeout or if the overall queue
1333 * for this peer is larger than queue_size and this is currently
1334 * the message with the lowest priority
1335 * @param notify_cls closure for notify
1336 * @return non-NULL if the notify callback was queued,
1337 * NULL if we can not even queue the request (insufficient
1338 * memory); if NULL is returned, "notify" will NOT be called.
1340 struct GNUNET_MESH_TransmitHandle *
1341 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1343 struct GNUNET_TIME_Relative maxdelay,
1344 const struct GNUNET_PeerIdentity *target,
1346 GNUNET_CONNECTION_TransmitReadyNotify notify,
1349 struct GNUNET_MESH_TransmitHandle *th;
1352 GNUNET_assert(NULL != notify);
1353 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1354 tunnel->npackets > 0)
1355 return NULL; /* queue full */
1357 tunnel->mesh->npackets++;
1358 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1359 th->tunnel = tunnel;
1360 th->priority = priority;
1361 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1362 th->target = GNUNET_PEER_intern (target);
1365 target) ? sizeof (struct GNUNET_MESH_Multicast) : sizeof (struct
1366 GNUNET_MESH_Unicast);
1367 th->size = notify_size + overhead;
1368 th->notify = notify;
1369 th->notify_cls = notify_cls;
1370 add_to_queue (tunnel->mesh, th);
1376 * Cancel the specified transmission-ready notification.
1378 * @param th handle that was returned by "notify_transmit_ready".
1381 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1383 struct GNUNET_MESH_Handle *mesh;
1385 mesh = th->tunnel->mesh;
1386 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1387 GNUNET_SCHEDULER_cancel (th->timeout_task);
1388 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1390 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1392 /* queue empty, no point in asking for transmission */
1393 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1399 #if 0 /* keep Emacsens' auto-indent happy */