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.c
20 * @brief mesh api: client implementation of mesh service
21 * @author Bartlomiej Polot
27 * - AUXILIARY FUNCTIONS
30 * - API CALL DEFINITIONS
32 * TODO: add regex to reconnect
35 #include "gnunet_common.h"
36 #include "gnunet_client_lib.h"
37 #include "gnunet_util_lib.h"
38 #include "gnunet_peer_lib.h"
39 #include "gnunet_mesh_service.h"
41 #include "mesh_protocol.h"
43 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
46 /******************************************************************************/
47 /************************ CONSTANTS ****************************/
48 /******************************************************************************/
50 #define HIGH_PID 0xFFFF0000
51 #define LOW_PID 0x0000FFFF
53 #define PID_OVERFLOW(pid, max) (pid > HIGH_PID && max < LOW_PID)
55 /******************************************************************************/
56 /************************ DATA STRUCTURES ****************************/
57 /******************************************************************************/
60 * Transmission queue to the service
62 struct GNUNET_MESH_TransmitHandle
68 struct GNUNET_MESH_TransmitHandle *next;
73 struct GNUNET_MESH_TransmitHandle *prev;
76 * Tunnel this message is sent on / for (may be NULL for control messages).
78 struct GNUNET_MESH_Tunnel *tunnel;
81 * Callback to obtain the message to transmit, or NULL if we
82 * got the message in 'data'. Notice that messages built
83 * by 'notify' need to be encapsulated with information about
86 GNUNET_CONNECTION_TransmitReadyNotify notify;
89 * Closure for 'notify'
94 * How long is this message valid. Once the timeout has been
95 * reached, the message must no longer be sent. If this
96 * is a message with a 'notify' callback set, the 'notify'
97 * function should be called with 'buf' NULL and size 0.
99 struct GNUNET_TIME_Absolute timeout;
102 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
104 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
107 * Target of the message, 0 for multicast. This field
108 * is only valid if 'notify' is non-NULL.
110 GNUNET_PEER_Id target;
113 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
120 * Opaque handle to the service.
122 struct GNUNET_MESH_Handle
126 * Handle to the server connection, to send messages later
128 struct GNUNET_CLIENT_Connection *client;
131 * Set of handlers used for processing incoming messages in the tunnels
133 const struct GNUNET_MESH_MessageHandler *message_handlers;
136 * Set of applications that should be claimed to be offered at this node.
137 * Note that this is just informative, the appropiate handlers must be
138 * registered independently and the mapping is up to the developer of the
139 * client application.
141 const GNUNET_MESH_ApplicationType *applications;
144 * Double linked list of the tunnels this client is connected to, head.
146 struct GNUNET_MESH_Tunnel *tunnels_head;
149 * Double linked list of the tunnels this client is connected to, tail.
151 struct GNUNET_MESH_Tunnel *tunnels_tail;
154 * Callback for inbound tunnel creation
156 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
159 * Callback for inbound tunnel disconnection
161 GNUNET_MESH_TunnelEndHandler *cleaner;
164 * Handle to cancel pending transmissions in case of disconnection
166 struct GNUNET_CLIENT_TransmitHandle *th;
169 * Closure for all the handlers given by the client
174 * Messages to send to the service, head.
176 struct GNUNET_MESH_TransmitHandle *th_head;
179 * Messages to send to the service, tail.
181 struct GNUNET_MESH_TransmitHandle *th_tail;
184 * tid of the next tunnel to create (to avoid reusing IDs often)
186 MESH_TunnelNumber next_tid;
189 * Number of handlers in the handlers array.
191 unsigned int n_handlers;
194 * Number of applications in the applications array.
196 unsigned int n_applications;
199 * Have we started the task to receive messages from the service
200 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
205 * Configuration given by the client, in case of reconnection
207 const struct GNUNET_CONFIGURATION_Handle *cfg;
210 * Time to the next reconnect in case one reconnect fails
212 struct GNUNET_TIME_Relative reconnect_time;
215 * Task for trying to reconnect.
217 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
222 * Description of a peer
224 struct GNUNET_MESH_Peer
227 * ID of the peer in short form
232 * Tunnel this peer belongs to
234 struct GNUNET_MESH_Tunnel *t;
237 * Flag indicating whether service has informed about its connection
245 * Opaque handle to a tunnel.
247 struct GNUNET_MESH_Tunnel
253 struct GNUNET_MESH_Tunnel *next;
258 struct GNUNET_MESH_Tunnel *prev;
261 * Callback to execute when peers connect to the tunnel
263 GNUNET_MESH_PeerConnectHandler connect_handler;
266 * Callback to execute when peers disconnect from the tunnel
268 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
271 * Closure for the connect/disconnect handlers
276 * Handle to the mesh this tunnel belongs to
278 struct GNUNET_MESH_Handle *mesh;
281 * Local ID of the tunnel
283 MESH_TunnelNumber tid;
286 * Owner of the tunnel. 0 if the tunnel is the local client.
288 GNUNET_PEER_Id owner;
291 * All peers added to the tunnel
293 struct GNUNET_MESH_Peer **peers;
296 * List of application types that have been requested for this tunnel
298 GNUNET_MESH_ApplicationType *apps;
301 * Any data the caller wants to put in here
306 * Number of peers added to the tunnel
311 * Size of packet queued in this tunnel
313 unsigned int packet_size;
316 * Number of applications requested this tunnel
321 * Is the tunnel throttled to the slowest peer?
326 * Is the tunnel allowed to buffer?
336 * Maximum allowed PID.
344 /******************************************************************************/
345 /*********************** DECLARATIONS *************************/
346 /******************************************************************************/
349 * Function called to send a message to the service.
350 * "buf" will be NULL and "size" zero if the socket was closed for writing in
353 * @param cls closure, the mesh handle
354 * @param size number of bytes available in buf
355 * @param buf where the callee should write the connect message
356 * @return number of bytes written to buf
359 send_callback (void *cls, size_t size, void *buf);
362 /******************************************************************************/
363 /*********************** AUXILIARY FUNCTIONS *************************/
364 /******************************************************************************/
367 * Get the tunnel handler for the tunnel specified by id from the given handle
368 * @param h Mesh handle
369 * @param tid ID of the wanted tunnel
370 * @return handle to the required tunnel or NULL if not found
372 static struct GNUNET_MESH_Tunnel *
373 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
375 struct GNUNET_MESH_Tunnel *t;
389 * Create a new tunnel and insert it in the tunnel list of the mesh handle
390 * @param h Mesh handle
391 * @param tid desired tid of the tunnel, 0 to assign one automatically
392 * @return handle to the created tunnel
394 static struct GNUNET_MESH_Tunnel *
395 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
397 struct GNUNET_MESH_Tunnel *t;
399 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
400 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
404 t->tid = h->next_tid;
405 while (NULL != retrieve_tunnel (h, h->next_tid))
408 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
409 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
421 * Destroy the specified tunnel.
422 * - Destroys all peers, calling the disconnect callback on each if needed
423 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
424 * - Calls cleaner if tunnel was inbound
425 * - Frees all memory used
427 * @param t Pointer to the tunnel.
428 * @param call_cleaner Whether to call the cleaner handler.
430 * @return Handle to the required tunnel or NULL if not found.
433 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
435 struct GNUNET_MESH_Handle *h;
436 struct GNUNET_PeerIdentity pi;
437 struct GNUNET_MESH_TransmitHandle *th;
438 struct GNUNET_MESH_TransmitHandle *next;
441 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
450 /* disconnect all peers */
451 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
452 for (i = 0; i < t->npeers; i++)
454 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
456 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
457 t->disconnect_handler (t->cls, &pi);
459 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
460 GNUNET_free (t->peers[i]);
463 /* signal tunnel destruction */
464 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
465 h->cleaner (h->cls, t, t->ctx);
467 /* check that clients did not leave messages behind in the queue */
468 for (th = h->th_head; NULL != th; th = next)
473 /* Clients should have aborted their requests already.
474 * Management traffic should be ok, as clients can't cancel that */
475 GNUNET_break (NULL == th->notify);
476 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
478 /* clean up request */
479 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
480 GNUNET_SCHEDULER_cancel (th->timeout_task);
484 /* if there are no more pending requests with mesh service, cancel active request */
485 /* Note: this should be unnecessary... */
486 if ( (NULL == h->th_head) && (NULL != h->th))
488 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
494 GNUNET_free (t->peers);
496 GNUNET_PEER_change_rc (t->owner, -1);
497 if (0 != t->napps && t->apps)
498 GNUNET_free (t->apps);
505 * Get the peer descriptor for the peer with id from the given tunnel
506 * @param t Tunnel handle
507 * @param id Short form ID of the wanted peer
508 * @return handle to the requested peer or NULL if not found
510 static struct GNUNET_MESH_Peer *
511 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
515 for (i = 0; i < t->npeers; i++)
516 if (t->peers[i]->id == id)
523 * Add a peer into a tunnel
524 * @param t Tunnel handle
525 * @param pi Full ID of the new peer
526 * @return handle to the newly created peer
528 static struct GNUNET_MESH_Peer *
529 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
530 const struct GNUNET_PeerIdentity *pi)
532 struct GNUNET_MESH_Peer *p;
540 id = GNUNET_PEER_intern (pi);
542 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
545 GNUNET_array_append (t->peers, t->npeers, p);
551 * Remove a peer from a tunnel
552 * @param p Peer handle
555 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
559 for (i = 0; i < p->t->npeers; i++)
561 if (p->t->peers[i] == p)
564 if (i == p->t->npeers)
569 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
570 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
575 * Notify client that the transmission has timed out
577 * @param tc task context
580 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
582 struct GNUNET_MESH_TransmitHandle *th = cls;
583 struct GNUNET_MESH_Handle *mesh;
585 mesh = th->tunnel->mesh;
586 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
587 if (th->notify != NULL)
588 th->notify (th->notify_cls, 0, NULL);
590 if ((NULL == mesh->th_head) && (NULL != mesh->th))
592 /* queue empty, no point in asking for transmission */
593 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
600 * Add a transmit handle to the transmission queue by priority and set the
603 * @param h mesh handle with the queue head and tail
604 * @param th handle to the packet to be transmitted
607 add_to_queue (struct GNUNET_MESH_Handle *h,
608 struct GNUNET_MESH_TransmitHandle *th)
610 struct GNUNET_MESH_TransmitHandle *p;
619 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
620 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
623 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
624 (th->timeout), &timeout_transmission, th);
629 * Auxiliary function to send an already constructed packet to the service.
630 * Takes care of creating a new queue element, copying the message and
631 * calling the tmt_rdy function if necessary.
633 * @param h mesh handle
634 * @param msg message to transmit
635 * @param tunnel tunnel this send is related to (NULL if N/A)
638 send_packet (struct GNUNET_MESH_Handle *h,
639 const struct GNUNET_MessageHeader *msg,
640 struct GNUNET_MESH_Tunnel *tunnel);
644 * Reconnect callback: tries to reconnect again after a failer previous
646 * @param cls closure (mesh handle)
647 * @param tc task context
650 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
654 * Send a connect packet to the service with the applications and types
655 * requested by the user.
657 * @param h The mesh handle.
661 send_connect (struct GNUNET_MESH_Handle *h)
665 size = sizeof (struct GNUNET_MESH_ClientConnect);
666 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
667 size += h->n_handlers * sizeof (uint16_t);
669 char buf[size] GNUNET_ALIGN;
670 struct GNUNET_MESH_ClientConnect *msg;
671 GNUNET_MESH_ApplicationType *apps;
676 /* build connection packet */
677 msg = (struct GNUNET_MESH_ClientConnect *) buf;
678 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
679 msg->header.size = htons (size);
680 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
681 for (napps = 0; napps < h->n_applications; napps++)
683 apps[napps] = htonl (h->applications[napps]);
684 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
686 types = (uint16_t *) & apps[napps];
687 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
688 types[ntypes] = htons (h->message_handlers[ntypes].type);
689 msg->applications = htons (napps);
690 msg->types = htons (ntypes);
691 LOG (GNUNET_ERROR_TYPE_DEBUG,
692 "Sending %lu bytes long message %d types and %d apps\n",
693 ntohs (msg->header.size), ntypes, napps);
694 send_packet (h, &msg->header, NULL);
700 * Reconnect to the service, retransmit all infomation to try to restore the
703 * @param h handle to the mesh
705 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
708 do_reconnect (struct GNUNET_MESH_Handle *h)
710 struct GNUNET_MESH_Tunnel *t;
713 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
714 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
715 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
717 h->in_receive = GNUNET_NO;
721 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
724 if (NULL != h->client)
726 GNUNET_CLIENT_disconnect (h->client);
730 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
731 if (h->client == NULL)
733 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
736 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
737 GNUNET_TIME_relative_multiply
738 (h->reconnect_time, 2));
739 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
740 GNUNET_TIME_relative_to_string (h->reconnect_time));
746 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
749 /* Rebuild all tunnels */
750 for (t = h->tunnels_head; NULL != t; t = t->next)
752 struct GNUNET_MESH_TunnelMessage tmsg;
753 struct GNUNET_MESH_PeerControl pmsg;
755 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
757 /* Tunnel was created by service (incoming tunnel) */
758 /* TODO: Notify service of missing tunnel, to request
759 * creator to recreate path (find a path to him via DHT?)
763 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
764 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
765 tmsg.tunnel_id = htonl (t->tid);
766 send_packet (h, &tmsg.header, t);
768 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
769 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
770 pmsg.tunnel_id = htonl (t->tid);
772 /* Reconnect all peers */
773 /* If the tunnel was "by type", dont connect individual peers */
774 for (i = 0; i < t->npeers && 0 == t->napps; i++)
776 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
777 if (NULL != t->disconnect_handler && t->peers[i]->connected)
778 t->disconnect_handler (t->cls, &pmsg.peer);
779 send_packet (t->mesh, &pmsg.header, t);
781 /* Reconnect all types, if any */
782 for (i = 0; i < t->napps; i++)
784 struct GNUNET_MESH_ConnectPeerByType msg;
786 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
787 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
788 msg.tunnel_id = htonl (t->tid);
789 msg.type = htonl (t->apps[i]);
790 send_packet (t->mesh, &msg.header, t);
792 if (GNUNET_NO == t->buffering)
793 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
794 if (GNUNET_YES == t->speed_min)
795 GNUNET_MESH_tunnel_speed_min (t);
801 * Reconnect callback: tries to reconnect again after a failer previous
803 * @param cls closure (mesh handle)
804 * @param tc task context
807 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
809 struct GNUNET_MESH_Handle *h = cls;
811 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
812 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
819 * Reconnect to the service, retransmit all infomation to try to restore the
822 * @param h handle to the mesh
824 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
827 reconnect (struct GNUNET_MESH_Handle *h)
829 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
830 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
831 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
836 /******************************************************************************/
837 /*********************** RECEIVE HANDLERS ****************************/
838 /******************************************************************************/
841 * Process the new tunnel notification and add it to the tunnels in the handle
843 * @param h The mesh handle
844 * @param msg A message with the details of the new incoming tunnel
847 process_tunnel_created (struct GNUNET_MESH_Handle *h,
848 const struct GNUNET_MESH_TunnelNotification *msg)
850 struct GNUNET_MESH_Tunnel *t;
851 MESH_TunnelNumber tid;
853 tid = ntohl (msg->tunnel_id);
854 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
859 if (NULL != h->new_tunnel)
861 struct GNUNET_ATS_Information atsi;
863 t = create_tunnel (h, tid);
864 t->owner = GNUNET_PEER_intern (&msg->peer);
866 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
867 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
869 t->peers[0]->connected = 1;
870 t->peers[0]->id = t->owner;
871 GNUNET_PEER_change_rc (t->owner, 1);
876 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
877 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
881 struct GNUNET_MESH_TunnelMessage d_msg;
883 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
885 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
886 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
887 d_msg.tunnel_id = msg->tunnel_id;
889 send_packet (h, &d_msg.header, NULL);
896 * Process the tunnel destroy notification and free associated resources
898 * @param h The mesh handle
899 * @param msg A message with the details of the tunnel being destroyed
902 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
903 const struct GNUNET_MESH_TunnelMessage *msg)
905 struct GNUNET_MESH_Tunnel *t;
906 MESH_TunnelNumber tid;
908 tid = ntohl (msg->tunnel_id);
909 t = retrieve_tunnel (h, tid);
919 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
920 destroy_tunnel (t, GNUNET_YES);
926 * Process the new peer event and notify the upper level of it
928 * @param h The mesh handle
929 * @param msg A message with the details of the peer event
932 process_peer_event (struct GNUNET_MESH_Handle *h,
933 const struct GNUNET_MESH_PeerControl *msg)
935 struct GNUNET_MESH_Tunnel *t;
936 struct GNUNET_MESH_Peer *p;
937 struct GNUNET_ATS_Information atsi;
941 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
942 size = ntohs (msg->header.size);
943 if (size != sizeof (struct GNUNET_MESH_PeerControl))
948 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
954 id = GNUNET_PEER_search (&msg->peer);
955 if ((p = retrieve_peer (t, id)) == NULL)
956 p = add_peer_to_tunnel (t, &msg->peer);
957 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
959 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
960 if (NULL != t->connect_handler)
964 t->connect_handler (t->cls, &msg->peer, &atsi);
970 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
971 if (NULL != t->disconnect_handler && p->connected)
973 t->disconnect_handler (t->cls, &msg->peer);
975 remove_peer_from_tunnel (p);
978 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
983 * Process the incoming data packets
985 * @param h The mesh handle
986 * @param message A message encapsulating the data
988 * @return GNUNET_YES if everything went fine
989 * GNUNET_NO if client closed connection (h no longer valid)
992 process_incoming_data (struct GNUNET_MESH_Handle *h,
993 const struct GNUNET_MessageHeader *message)
995 const struct GNUNET_MessageHeader *payload;
996 const struct GNUNET_MESH_MessageHandler *handler;
997 const struct GNUNET_PeerIdentity *peer;
998 struct GNUNET_MESH_Unicast *ucast;
999 struct GNUNET_MESH_Multicast *mcast;
1000 struct GNUNET_MESH_ToOrigin *to_orig;
1001 struct GNUNET_MESH_Tunnel *t;
1005 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1006 type = ntohs (message->type);
1009 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1010 ucast = (struct GNUNET_MESH_Unicast *) message;
1012 t = retrieve_tunnel (h, ntohl (ucast->tid));
1013 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1015 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1016 GNUNET_i2s (peer), ntohl (ucast->tid));
1018 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1019 mcast = (struct GNUNET_MESH_Multicast *) message;
1020 t = retrieve_tunnel (h, ntohl (mcast->tid));
1021 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1023 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1024 GNUNET_i2s (peer), ntohl (mcast->tid));
1026 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1027 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1028 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1029 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1030 peer = &to_orig->sender;
1031 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1032 GNUNET_i2s (peer), ntohl (to_orig->tid));
1040 /* Tunnel was ignored, probably service didn't get it yet */
1043 type = ntohs (payload->type);
1044 for (i = 0; i < h->n_handlers; i++)
1046 handler = &h->message_handlers[i];
1047 if (handler->type == type)
1049 struct GNUNET_ATS_Information atsi;
1054 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1056 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1057 GNUNET_MESH_disconnect (h);
1062 LOG (GNUNET_ERROR_TYPE_DEBUG,
1063 "callback completed successfully\n");
1072 * Process a local ACK message, enabling the client to send
1073 * more data to the service.
1075 * @param h Mesh handle.
1076 * @param message Message itself.
1079 process_ack (struct GNUNET_MESH_Handle *h,
1080 const struct GNUNET_MessageHeader *message)
1082 struct GNUNET_MESH_LocalAck *msg;
1083 struct GNUNET_MESH_Tunnel *t;
1086 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1087 msg = (struct GNUNET_MESH_LocalAck *) message;
1089 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1093 LOG (GNUNET_ERROR_TYPE_WARNING,
1094 "ACK on unknown tunnel %X\n",
1095 ntohl (msg->tunnel_id));
1098 ack = ntohl (msg->max_pid);
1099 if (ack > t->max_pid || PID_OVERFLOW (t->max_pid, ack))
1101 if (NULL == h->th && 0 < t->packet_size)
1103 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1104 GNUNET_TIME_UNIT_FOREVER_REL,
1105 GNUNET_YES, &send_callback, h);
1110 * Function to process all messages received from the service
1112 * @param cls closure
1113 * @param msg message received, NULL on timeout or fatal error
1116 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1118 struct GNUNET_MESH_Handle *h = cls;
1122 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL msg\n");
1126 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %hu from MESH\n",
1128 switch (ntohs (msg->type))
1130 /* Notify of a new incoming tunnel */
1131 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1132 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1134 /* Notify of a tunnel disconnection */
1135 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1136 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1138 /* Notify of a new peer or a peer disconnect in the tunnel */
1139 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1140 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1141 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1143 /* Notify of a new data packet in the tunnel */
1144 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1145 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1146 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1147 if (GNUNET_NO == process_incoming_data (h, msg))
1150 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1151 process_ack (h, msg);
1154 /* We shouldn't get any other packages, log and ignore */
1155 LOG (GNUNET_ERROR_TYPE_WARNING,
1156 "unsolicited message form service (type %d)\n",
1159 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1160 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1161 GNUNET_TIME_UNIT_FOREVER_REL);
1165 /******************************************************************************/
1166 /************************ SEND FUNCTIONS ****************************/
1167 /******************************************************************************/
1170 * Function called to send a message to the service.
1171 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1174 * @param cls closure, the mesh handle
1175 * @param size number of bytes available in buf
1176 * @param buf where the callee should write the connect message
1177 * @return number of bytes written to buf
1180 send_callback (void *cls, size_t size, void *buf)
1182 struct GNUNET_MESH_Handle *h = cls;
1183 struct GNUNET_MESH_TransmitHandle *th;
1184 struct GNUNET_MESH_TransmitHandle *next;
1185 struct GNUNET_MESH_Tunnel *t;
1190 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1192 if ((0 == size) || (NULL == buf))
1194 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL callback\n");
1200 while ((NULL != (th = next)) && (size >= th->size))
1203 if (NULL != th->notify)
1205 if (t->max_pid < t->pid && ! PID_OVERFLOW (t->pid, t->max_pid)) {
1206 /* This tunnel is not ready to transmit yet, try next message */
1211 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1213 /* traffic to origin */
1214 struct GNUNET_MESH_ToOrigin to;
1215 struct GNUNET_MessageHeader *mh;
1217 GNUNET_assert (size >= th->size);
1218 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1219 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1220 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %u\n",
1224 psize += sizeof (to);
1225 GNUNET_assert (size >= psize);
1226 to.header.size = htons (psize);
1227 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1228 to.tid = htonl (t->tid);
1230 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1231 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1232 memcpy (cbuf, &to, sizeof (to));
1235 else if (th->target == 0)
1238 struct GNUNET_MESH_Multicast mc;
1239 struct GNUNET_MessageHeader *mh;
1241 GNUNET_assert (size >= th->size);
1242 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1243 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1244 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %u\n",
1248 psize += sizeof (mc);
1249 GNUNET_assert (size >= psize);
1250 mc.header.size = htons (psize);
1251 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1252 mc.tid = htonl (t->tid);
1253 mc.pid = htonl (t->pid);
1255 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1256 memcpy (cbuf, &mc, sizeof (mc));
1262 struct GNUNET_MESH_Unicast uc;
1263 struct GNUNET_MessageHeader *mh;
1265 GNUNET_assert (size >= th->size);
1266 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1267 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1268 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %u\n",
1272 psize += sizeof (uc);
1273 GNUNET_assert (size >= psize);
1274 uc.header.size = htons (psize);
1275 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1276 uc.tid = htonl (t->tid);
1277 uc.pid = htonl (t->pid);
1278 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1279 GNUNET_PEER_resolve (th->target, &uc.destination);
1280 memcpy (cbuf, &uc, sizeof (uc));
1287 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1288 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %u\n",
1290 memcpy (cbuf, &th[1], th->size);
1293 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1294 GNUNET_SCHEDULER_cancel (th->timeout_task);
1295 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1302 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1303 if (NULL != h->th_head)
1305 int request = GNUNET_NO;
1307 for (th = h->th_head; NULL != th; th = th->next)
1309 struct GNUNET_MESH_Tunnel *t = th->tunnel;
1311 if (NULL != th->notify ||
1312 (t->max_pid >= t->pid || PID_OVERFLOW (t->pid, t->max_pid)))
1314 request = GNUNET_YES;
1319 if (GNUNET_YES == request)
1321 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", th->size);
1323 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1324 GNUNET_TIME_UNIT_FOREVER_REL,
1325 GNUNET_YES, &send_callback, h);
1329 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1332 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1333 if (GNUNET_NO == h->in_receive)
1335 h->in_receive = GNUNET_YES;
1336 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1337 GNUNET_TIME_UNIT_FOREVER_REL);
1344 * Auxiliary function to send an already constructed packet to the service.
1345 * Takes care of creating a new queue element, copying the message and
1346 * calling the tmt_rdy function if necessary.
1348 * @param h mesh handle
1349 * @param msg message to transmit
1350 * @param tunnel tunnel this send is related to (NULL if N/A)
1353 send_packet (struct GNUNET_MESH_Handle *h,
1354 const struct GNUNET_MessageHeader *msg,
1355 struct GNUNET_MESH_Tunnel *tunnel)
1357 struct GNUNET_MESH_TransmitHandle *th;
1360 msize = ntohs (msg->size);
1361 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1362 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1364 th->tunnel = tunnel;
1365 memcpy (&th[1], msg, msize);
1366 add_to_queue (h, th);
1370 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1371 GNUNET_TIME_UNIT_FOREVER_REL,
1372 GNUNET_YES, &send_callback, h);
1376 /******************************************************************************/
1377 /********************** API CALL DEFINITIONS *************************/
1378 /******************************************************************************/
1381 * Connect to the mesh service.
1383 * @param cfg configuration to use
1384 * @param cls closure for the various callbacks that follow
1385 * (including handlers in the handlers array)
1386 * @param new_tunnel function called when an *inbound* tunnel is created
1387 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1388 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1389 * is called on the tunnel
1390 * @param handlers callbacks for messages we care about, NULL-terminated
1391 * note that the mesh is allowed to drop notifications about
1392 * inbound messages if the client does not process them fast
1393 * enough (for this notification type, a bounded queue is used)
1394 * @param stypes list of the applications that this client claims to provide
1395 * @return handle to the mesh service NULL on error
1396 * (in this case, init is never called)
1398 struct GNUNET_MESH_Handle *
1399 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1400 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1401 GNUNET_MESH_TunnelEndHandler cleaner,
1402 const struct GNUNET_MESH_MessageHandler *handlers,
1403 const GNUNET_MESH_ApplicationType *stypes)
1405 struct GNUNET_MESH_Handle *h;
1407 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1408 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1410 h->new_tunnel = new_tunnel;
1411 h->cleaner = cleaner;
1412 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1413 if (h->client == NULL)
1421 h->applications = stypes;
1422 h->message_handlers = handlers;
1423 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1424 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1425 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1427 /* count handlers and apps, calculate size */
1428 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1429 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1431 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1437 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1438 * disconnect callbacks will be called on any still connected peers, notifying
1439 * about their disconnection. The registered inbound tunnel cleaner will be
1440 * called should any inbound tunnels still exist.
1442 * @param handle connection to mesh to disconnect
1445 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1447 struct GNUNET_MESH_Tunnel *t;
1448 struct GNUNET_MESH_Tunnel *aux;
1449 struct GNUNET_MESH_TransmitHandle *th;
1451 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1453 t = handle->tunnels_head;
1457 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1460 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1462 destroy_tunnel (t, GNUNET_YES);
1465 while ( (th = handle->th_head) != NULL)
1467 struct GNUNET_MessageHeader *msg;
1469 /* Make sure it is an allowed packet (everything else should have been
1470 * already canceled).
1472 GNUNET_break (NULL == th->notify);
1473 msg = (struct GNUNET_MessageHeader *) &th[1];
1474 switch (ntohs(msg->type))
1476 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1477 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1481 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1485 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1489 if (NULL != handle->th)
1491 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1494 if (NULL != handle->client)
1496 GNUNET_CLIENT_disconnect (handle->client);
1497 handle->client = NULL;
1499 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1501 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1502 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1504 GNUNET_free (handle);
1509 * Announce to ther peer the availability of services described by the regex,
1510 * in order to be reachable to other peers via connect_by_string.
1512 * Note that the first 8 characters are considered to be part of a prefix,
1513 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1514 * all matching strings will be stored in the DHT.
1516 * @param h handle to mesh.
1517 * @param regex string with the regular expression describing local services.
1520 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1523 struct GNUNET_MessageHeader *msg;
1527 len = strlen (regex);
1528 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1529 GNUNET_assert (UINT16_MAX > msgsize);
1532 char buffer[msgsize];
1534 msg = (struct GNUNET_MessageHeader *) buffer;
1535 msg->size = htons (msgsize);
1536 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1537 memcpy (&msg[1], regex, len);
1539 send_packet(h, msg, NULL);
1544 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1545 * and to broadcast).
1547 * @param h mesh handle
1548 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1549 * @param connect_handler function to call when peers are actually connected
1550 * @param disconnect_handler function to call when peers are disconnected
1551 * @param handler_cls closure for connect/disconnect handlers
1553 struct GNUNET_MESH_Tunnel *
1554 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1555 GNUNET_MESH_PeerConnectHandler connect_handler,
1556 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1559 struct GNUNET_MESH_Tunnel *t;
1560 struct GNUNET_MESH_TunnelMessage msg;
1562 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1563 t = create_tunnel (h, 0);
1564 t->connect_handler = connect_handler;
1565 t->disconnect_handler = disconnect_handler;
1566 t->cls = handler_cls;
1567 t->ctx = tunnel_ctx;
1568 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1569 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1570 msg.tunnel_id = htonl (t->tid);
1571 send_packet (h, &msg.header, t);
1577 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1580 * @param tunnel tunnel handle
1583 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1585 struct GNUNET_MESH_Handle *h;
1586 struct GNUNET_MESH_TunnelMessage msg;
1587 struct GNUNET_MESH_TransmitHandle *th;
1589 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1592 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1593 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1594 msg.tunnel_id = htonl (tunnel->tid);
1598 struct GNUNET_MESH_TransmitHandle *aux;
1599 if (th->tunnel == tunnel)
1602 /* FIXME call the handler? */
1603 if (NULL != th->notify)
1604 th->notify (th->notify_cls, 0, NULL);
1605 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1613 destroy_tunnel (tunnel, GNUNET_NO);
1614 send_packet (h, &msg.header, NULL);
1618 * Request that the tunnel data rate is limited to the speed of the slowest
1621 * @param tunnel Tunnel affected.
1624 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1626 struct GNUNET_MESH_TunnelMessage msg;
1627 struct GNUNET_MESH_Handle *h;
1630 tunnel->speed_min = GNUNET_YES;
1632 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1633 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1634 msg.tunnel_id = htonl (tunnel->tid);
1636 send_packet (h, &msg.header, NULL);
1641 * Request that the tunnel data rate is limited to the speed of the fastest
1642 * receiver. This is the default behavior.
1644 * @param tunnel Tunnel affected.
1647 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1649 struct GNUNET_MESH_TunnelMessage msg;
1650 struct GNUNET_MESH_Handle *h;
1653 tunnel->speed_min = GNUNET_NO;
1655 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1656 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1657 msg.tunnel_id = htonl (tunnel->tid);
1659 send_packet (h, &msg.header, NULL);
1663 * Turn on/off the buffering status of the tunnel.
1665 * @param tunnel Tunnel affected.
1666 * @param buffer GNUNET_YES to turn buffering on (default),
1667 * GNUNET_NO otherwise.
1670 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1672 struct GNUNET_MESH_TunnelMessage msg;
1673 struct GNUNET_MESH_Handle *h;
1676 tunnel->buffering = buffer;
1678 if (GNUNET_YES == buffer)
1679 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1681 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1682 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1683 msg.tunnel_id = htonl (tunnel->tid);
1685 send_packet (h, &msg.header, NULL);
1689 * Request that a peer should be added to the tunnel. The existing
1690 * connect handler will be called ONCE with either success or failure.
1691 * This function should NOT be called again with the same peer before the
1692 * connect handler is called.
1694 * @param tunnel handle to existing tunnel
1695 * @param peer peer to add
1698 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1699 const struct GNUNET_PeerIdentity *peer)
1701 struct GNUNET_MESH_PeerControl msg;
1702 GNUNET_PEER_Id peer_id;
1705 peer_id = GNUNET_PEER_intern (peer);
1706 for (i = 0; i < tunnel->npeers; i++)
1708 if (tunnel->peers[i]->id == peer_id)
1710 /* Peer already exists in tunnel */
1711 GNUNET_PEER_change_rc (peer_id, -1);
1716 if (NULL == add_peer_to_tunnel (tunnel, peer))
1719 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1720 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1721 msg.tunnel_id = htonl (tunnel->tid);
1723 send_packet (tunnel->mesh, &msg.header, tunnel);
1730 * Request that a peer should be removed from the tunnel. The existing
1731 * disconnect handler will be called ONCE if we were connected.
1733 * @param tunnel handle to existing tunnel
1734 * @param peer peer to remove
1737 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1738 const struct GNUNET_PeerIdentity *peer)
1740 struct GNUNET_MESH_PeerControl msg;
1741 GNUNET_PEER_Id peer_id;
1744 peer_id = GNUNET_PEER_search (peer);
1750 for (i = 0; i < tunnel->npeers; i++)
1751 if (tunnel->peers[i]->id == peer_id)
1753 if (i == tunnel->npeers)
1758 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1759 tunnel->disconnect_handler (tunnel->cls, peer);
1760 GNUNET_PEER_change_rc (peer_id, -1);
1761 GNUNET_free (tunnel->peers[i]);
1762 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1763 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1765 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1766 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1767 msg.tunnel_id = htonl (tunnel->tid);
1768 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1769 send_packet (tunnel->mesh, &msg.header, tunnel);
1774 * Request that the mesh should try to connect to a peer supporting the given
1777 * @param tunnel handle to existing tunnel
1778 * @param app_type application type that must be supported by the peer (MESH
1779 * should discover peer in proximity handling this type)
1782 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1783 GNUNET_MESH_ApplicationType app_type)
1785 struct GNUNET_MESH_ConnectPeerByType msg;
1787 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1789 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1790 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1791 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1792 msg.tunnel_id = htonl (tunnel->tid);
1793 msg.type = htonl (app_type);
1794 send_packet (tunnel->mesh, &msg.header, tunnel);
1799 * Request that the mesh should try to connect to a peer matching the
1800 * description given in the service string.
1802 * FIXME: allow multiple? how to deal with reconnect?
1804 * @param tunnel handle to existing tunnel
1805 * @param description string describing the destination node requirements
1808 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1809 const char *description)
1811 struct GNUNET_MESH_ConnectPeerByString *m;
1815 len = strlen (description);
1816 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1817 GNUNET_assert (UINT16_MAX > msgsize);
1819 char buffer[msgsize];
1821 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1822 m->header.size = htons (msgsize);
1823 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1824 m->tunnel_id = htonl (tunnel->tid);
1825 memcpy(&m[1], description, len);
1827 send_packet (tunnel->mesh, &m->header, tunnel);
1833 * Request that the given peer isn't added to this tunnel in calls to
1834 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1836 * @param tunnel handle to existing tunnel.
1837 * @param peer peer identity of the peer which should be blacklisted
1841 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1842 const struct GNUNET_PeerIdentity *peer)
1844 struct GNUNET_MESH_PeerControl msg;
1846 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1847 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1848 msg.tunnel_id = htonl (tunnel->tid);
1850 send_packet (tunnel->mesh, &msg.header, tunnel);
1857 * Request that the given peer isn't blacklisted anymore from this tunnel,
1858 * and therefore can be added in future calls to connect_by_*.
1859 * The peer must have been previously blacklisted for this tunnel.
1861 * @param tunnel handle to existing tunnel.
1862 * @param peer peer identity of the peer which shouldn't be blacklisted
1863 * for the tunnel anymore.
1866 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1867 const struct GNUNET_PeerIdentity *peer)
1869 struct GNUNET_MESH_PeerControl msg;
1871 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1872 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1873 msg.tunnel_id = htonl (tunnel->tid);
1875 send_packet (tunnel->mesh, &msg.header, tunnel);
1882 * Ask the mesh to call "notify" once it is ready to transmit the
1883 * given number of bytes to the specified tunnel or target.
1884 * Only one call can be active at any time, to issue another request,
1885 * wait for the callback or cancel the current request.
1887 * @param tunnel tunnel to use for transmission
1888 * @param cork is corking allowed for this transmission?
1889 * @param maxdelay how long can the message wait?
1890 * @param target destination for the message
1891 * NULL for multicast to all tunnel targets
1892 * @param notify_size how many bytes of buffer space does notify want?
1893 * @param notify function to call when buffer space is available;
1894 * will be called with NULL on timeout or if the overall queue
1895 * for this peer is larger than queue_size and this is currently
1896 * the message with the lowest priority
1897 * @param notify_cls closure for notify
1898 * @return non-NULL if the notify callback was queued,
1899 * NULL if we can not even queue the request (insufficient
1900 * memory); if NULL is returned, "notify" will NOT be called.
1902 struct GNUNET_MESH_TransmitHandle *
1903 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1904 struct GNUNET_TIME_Relative maxdelay,
1905 const struct GNUNET_PeerIdentity *target,
1907 GNUNET_CONNECTION_TransmitReadyNotify notify,
1910 struct GNUNET_MESH_TransmitHandle *th;
1913 GNUNET_assert (NULL != tunnel);
1914 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1916 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1918 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1919 GNUNET_assert (NULL != notify);
1920 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1921 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1922 th->tunnel = tunnel;
1923 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1924 th->target = GNUNET_PEER_intern (target);
1925 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1926 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1927 else if (NULL == target)
1928 overhead = sizeof (struct GNUNET_MESH_Multicast);
1930 overhead = sizeof (struct GNUNET_MESH_Unicast);
1931 tunnel->packet_size = th->size = notify_size + overhead;
1932 th->notify = notify;
1933 th->notify_cls = notify_cls;
1934 add_to_queue (tunnel->mesh, th);
1935 if (NULL != tunnel->mesh->th)
1938 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1939 GNUNET_TIME_UNIT_FOREVER_REL,
1940 GNUNET_YES, &send_callback,
1947 * Cancel the specified transmission-ready notification.
1949 * @param th handle that was returned by "notify_transmit_ready".
1952 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1954 struct GNUNET_MESH_Handle *mesh;
1956 mesh = th->tunnel->mesh;
1957 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1958 GNUNET_SCHEDULER_cancel (th->timeout_task);
1959 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1961 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1963 /* queue empty, no point in asking for transmission */
1964 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1971 * Transition API for tunnel ctx management
1974 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1980 * Transition API for tunnel ctx management
1983 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)