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 * Check if transmission is a payload packet.
369 * @param th Transmission handle.
371 * @return GNUNET_YES if it is a payload packet,
372 * GNUNET_NO if it is a mesh management packet.
375 th_is_payload (struct GNUNET_MESH_TransmitHandle *th)
377 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
382 * Check whether there is any message ready in the queue and find the size.
384 * @param h Mesh handle.
386 * @return The size of the first ready message in the queue,
387 * 0 if there is none.
390 message_ready_size (struct GNUNET_MESH_Handle *h)
392 struct GNUNET_MESH_TransmitHandle *th;
393 struct GNUNET_MESH_Tunnel *t;
395 for (th = h->th_head; NULL != th; th = th->next)
398 if (GNUNET_NO == th_is_payload (th) ||
399 (t->max_pid > t->pid || PID_OVERFLOW (t->pid, t->max_pid)))
407 * Get the tunnel handler for the tunnel specified by id from the given handle
408 * @param h Mesh handle
409 * @param tid ID of the wanted tunnel
410 * @return handle to the required tunnel or NULL if not found
412 static struct GNUNET_MESH_Tunnel *
413 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
415 struct GNUNET_MESH_Tunnel *t;
429 * Create a new tunnel and insert it in the tunnel list of the mesh handle
430 * @param h Mesh handle
431 * @param tid desired tid of the tunnel, 0 to assign one automatically
432 * @return handle to the created tunnel
434 static struct GNUNET_MESH_Tunnel *
435 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
437 struct GNUNET_MESH_Tunnel *t;
439 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
440 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
444 t->tid = h->next_tid;
445 while (NULL != retrieve_tunnel (h, h->next_tid))
448 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
449 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
461 * Destroy the specified tunnel.
462 * - Destroys all peers, calling the disconnect callback on each if needed
463 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
464 * - Calls cleaner if tunnel was inbound
465 * - Frees all memory used
467 * @param t Pointer to the tunnel.
468 * @param call_cleaner Whether to call the cleaner handler.
470 * @return Handle to the required tunnel or NULL if not found.
473 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
475 struct GNUNET_MESH_Handle *h;
476 struct GNUNET_PeerIdentity pi;
477 struct GNUNET_MESH_TransmitHandle *th;
478 struct GNUNET_MESH_TransmitHandle *next;
481 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
490 /* disconnect all peers */
491 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
492 for (i = 0; i < t->npeers; i++)
494 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
496 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
497 t->disconnect_handler (t->cls, &pi);
499 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
500 GNUNET_free (t->peers[i]);
503 /* signal tunnel destruction */
504 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
505 h->cleaner (h->cls, t, t->ctx);
507 /* check that clients did not leave messages behind in the queue */
508 for (th = h->th_head; NULL != th; th = next)
513 /* Clients should have aborted their requests already.
514 * Management traffic should be ok, as clients can't cancel that */
515 GNUNET_break (GNUNET_NO == th_is_payload(th));
516 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
518 /* clean up request */
519 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
520 GNUNET_SCHEDULER_cancel (th->timeout_task);
524 /* if there are no more pending requests with mesh service, cancel active request */
525 /* Note: this should be unnecessary... */
526 if ((0 == message_ready_size (h)) && (NULL != h->th))
528 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
534 GNUNET_free (t->peers);
536 GNUNET_PEER_change_rc (t->owner, -1);
537 if (0 != t->napps && t->apps)
538 GNUNET_free (t->apps);
545 * Get the peer descriptor for the peer with id from the given tunnel
546 * @param t Tunnel handle
547 * @param id Short form ID of the wanted peer
548 * @return handle to the requested peer or NULL if not found
550 static struct GNUNET_MESH_Peer *
551 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
555 for (i = 0; i < t->npeers; i++)
556 if (t->peers[i]->id == id)
563 * Add a peer into a tunnel
564 * @param t Tunnel handle
565 * @param pi Full ID of the new peer
566 * @return handle to the newly created peer
568 static struct GNUNET_MESH_Peer *
569 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
570 const struct GNUNET_PeerIdentity *pi)
572 struct GNUNET_MESH_Peer *p;
580 id = GNUNET_PEER_intern (pi);
582 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
585 GNUNET_array_append (t->peers, t->npeers, p);
591 * Remove a peer from a tunnel
592 * @param p Peer handle
595 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
599 for (i = 0; i < p->t->npeers; i++)
601 if (p->t->peers[i] == p)
604 if (i == p->t->npeers)
609 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
610 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
615 * Notify client that the transmission has timed out
618 * @param tc task context
621 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
623 struct GNUNET_MESH_TransmitHandle *th = cls;
624 struct GNUNET_MESH_Handle *mesh;
626 mesh = th->tunnel->mesh;
627 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
628 th->tunnel->packet_size = 0;
629 if (GNUNET_YES == th_is_payload (th))
630 th->notify (th->notify_cls, 0, NULL);
632 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
634 /* nothing ready to transmit, no point in asking for transmission */
635 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
642 * Add a transmit handle to the transmission queue by priority and set the
645 * @param h mesh handle with the queue head and tail
646 * @param th handle to the packet to be transmitted
649 add_to_queue (struct GNUNET_MESH_Handle *h,
650 struct GNUNET_MESH_TransmitHandle *th)
652 struct GNUNET_MESH_TransmitHandle *p;
661 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
662 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
665 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
666 (th->timeout), &timeout_transmission, th);
671 * Auxiliary function to send an already constructed packet to the service.
672 * Takes care of creating a new queue element, copying the message and
673 * calling the tmt_rdy function if necessary.
675 * @param h mesh handle
676 * @param msg message to transmit
677 * @param tunnel tunnel this send is related to (NULL if N/A)
680 send_packet (struct GNUNET_MESH_Handle *h,
681 const struct GNUNET_MessageHeader *msg,
682 struct GNUNET_MESH_Tunnel *tunnel);
686 * Send an ack on the tunnel to confirm the processing of a message.
688 * @param h Mesh handle.
689 * @param t Tunnel on which to send the ACK.
692 send_ack (struct GNUNET_MESH_Handle *h, struct GNUNET_MESH_Tunnel *t)
694 struct GNUNET_MESH_LocalAck msg;
696 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
697 msg.header.size = htons (sizeof (msg));
698 msg.tunnel_id = htonl (t->tid);
699 msg.max_pid = t->pid + 1;
701 send_packet (h, &msg.header, t);
708 * Reconnect callback: tries to reconnect again after a failer previous
710 * @param cls closure (mesh handle)
711 * @param tc task context
714 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
718 * Send a connect packet to the service with the applications and types
719 * requested by the user.
721 * @param h The mesh handle.
725 send_connect (struct GNUNET_MESH_Handle *h)
729 size = sizeof (struct GNUNET_MESH_ClientConnect);
730 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
731 size += h->n_handlers * sizeof (uint16_t);
733 char buf[size] GNUNET_ALIGN;
734 struct GNUNET_MESH_ClientConnect *msg;
735 GNUNET_MESH_ApplicationType *apps;
740 /* build connection packet */
741 msg = (struct GNUNET_MESH_ClientConnect *) buf;
742 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
743 msg->header.size = htons (size);
744 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
745 for (napps = 0; napps < h->n_applications; napps++)
747 apps[napps] = htonl (h->applications[napps]);
748 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
750 types = (uint16_t *) & apps[napps];
751 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
752 types[ntypes] = htons (h->message_handlers[ntypes].type);
753 msg->applications = htons (napps);
754 msg->types = htons (ntypes);
755 LOG (GNUNET_ERROR_TYPE_DEBUG,
756 "Sending %lu bytes long message %d types and %d apps\n",
757 ntohs (msg->header.size), ntypes, napps);
758 send_packet (h, &msg->header, NULL);
764 * Reconnect to the service, retransmit all infomation to try to restore the
767 * @param h handle to the mesh
769 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
772 do_reconnect (struct GNUNET_MESH_Handle *h)
774 struct GNUNET_MESH_Tunnel *t;
777 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
778 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
779 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
780 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
781 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
786 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
789 if (NULL != h->client)
791 GNUNET_CLIENT_disconnect (h->client);
795 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
796 if (h->client == NULL)
798 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
801 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
802 GNUNET_TIME_relative_multiply
803 (h->reconnect_time, 2));
804 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
805 GNUNET_TIME_relative_to_string (h->reconnect_time));
811 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
814 /* Rebuild all tunnels */
815 for (t = h->tunnels_head; NULL != t; t = t->next)
817 struct GNUNET_MESH_TunnelMessage tmsg;
818 struct GNUNET_MESH_PeerControl pmsg;
820 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
822 /* Tunnel was created by service (incoming tunnel) */
823 /* TODO: Notify service of missing tunnel, to request
824 * creator to recreate path (find a path to him via DHT?)
828 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
829 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
830 tmsg.tunnel_id = htonl (t->tid);
831 send_packet (h, &tmsg.header, t);
833 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
834 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
835 pmsg.tunnel_id = htonl (t->tid);
837 /* Reconnect all peers */
838 /* If the tunnel was "by type", dont connect individual peers */
839 for (i = 0; i < t->npeers && 0 == t->napps; i++)
841 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
842 if (NULL != t->disconnect_handler && t->peers[i]->connected)
843 t->disconnect_handler (t->cls, &pmsg.peer);
844 send_packet (t->mesh, &pmsg.header, t);
846 /* Reconnect all types, if any */
847 for (i = 0; i < t->napps; i++)
849 struct GNUNET_MESH_ConnectPeerByType msg;
851 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
852 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
853 msg.tunnel_id = htonl (t->tid);
854 msg.type = htonl (t->apps[i]);
855 send_packet (t->mesh, &msg.header, t);
857 if (GNUNET_NO == t->buffering)
858 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
859 if (GNUNET_YES == t->speed_min)
860 GNUNET_MESH_tunnel_speed_min (t);
866 * Reconnect callback: tries to reconnect again after a failer previous
868 * @param cls closure (mesh handle)
869 * @param tc task context
872 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
874 struct GNUNET_MESH_Handle *h = cls;
876 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
877 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
884 * Reconnect to the service, retransmit all infomation to try to restore the
887 * @param h handle to the mesh
889 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
892 reconnect (struct GNUNET_MESH_Handle *h)
894 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
895 h->in_receive = GNUNET_NO;
896 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
897 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
902 /******************************************************************************/
903 /*********************** RECEIVE HANDLERS ****************************/
904 /******************************************************************************/
907 * Process the new tunnel notification and add it to the tunnels in the handle
909 * @param h The mesh handle
910 * @param msg A message with the details of the new incoming tunnel
913 process_tunnel_created (struct GNUNET_MESH_Handle *h,
914 const struct GNUNET_MESH_TunnelNotification *msg)
916 struct GNUNET_MESH_Tunnel *t;
917 MESH_TunnelNumber tid;
919 tid = ntohl (msg->tunnel_id);
920 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
925 if (NULL != h->new_tunnel)
927 struct GNUNET_ATS_Information atsi;
929 t = create_tunnel (h, tid);
930 t->owner = GNUNET_PEER_intern (&msg->peer);
932 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
933 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
935 t->peers[0]->connected = 1;
936 t->peers[0]->id = t->owner;
937 GNUNET_PEER_change_rc (t->owner, 1);
942 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
943 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
947 struct GNUNET_MESH_TunnelMessage d_msg;
949 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
951 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
952 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
953 d_msg.tunnel_id = msg->tunnel_id;
955 send_packet (h, &d_msg.header, NULL);
962 * Process the tunnel destroy notification and free associated resources
964 * @param h The mesh handle
965 * @param msg A message with the details of the tunnel being destroyed
968 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
969 const struct GNUNET_MESH_TunnelMessage *msg)
971 struct GNUNET_MESH_Tunnel *t;
972 MESH_TunnelNumber tid;
974 tid = ntohl (msg->tunnel_id);
975 t = retrieve_tunnel (h, tid);
985 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
986 destroy_tunnel (t, GNUNET_YES);
992 * Process the new peer event and notify the upper level of it
994 * @param h The mesh handle
995 * @param msg A message with the details of the peer event
998 process_peer_event (struct GNUNET_MESH_Handle *h,
999 const struct GNUNET_MESH_PeerControl *msg)
1001 struct GNUNET_MESH_Tunnel *t;
1002 struct GNUNET_MESH_Peer *p;
1003 struct GNUNET_ATS_Information atsi;
1007 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
1008 size = ntohs (msg->header.size);
1009 if (size != sizeof (struct GNUNET_MESH_PeerControl))
1014 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1020 id = GNUNET_PEER_search (&msg->peer);
1021 if ((p = retrieve_peer (t, id)) == NULL)
1022 p = add_peer_to_tunnel (t, &msg->peer);
1023 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
1025 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
1026 if (NULL != t->connect_handler)
1030 t->connect_handler (t->cls, &msg->peer, &atsi);
1036 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
1037 if (NULL != t->disconnect_handler && p->connected)
1039 t->disconnect_handler (t->cls, &msg->peer);
1041 remove_peer_from_tunnel (p);
1044 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
1049 * Process the incoming data packets
1051 * @param h The mesh handle
1052 * @param message A message encapsulating the data
1054 * @return GNUNET_YES if everything went fine
1055 * GNUNET_NO if client closed connection (h no longer valid)
1058 process_incoming_data (struct GNUNET_MESH_Handle *h,
1059 const struct GNUNET_MessageHeader *message)
1061 const struct GNUNET_MessageHeader *payload;
1062 const struct GNUNET_MESH_MessageHandler *handler;
1063 const struct GNUNET_PeerIdentity *peer;
1064 struct GNUNET_MESH_Unicast *ucast;
1065 struct GNUNET_MESH_Multicast *mcast;
1066 struct GNUNET_MESH_ToOrigin *to_orig;
1067 struct GNUNET_MESH_Tunnel *t;
1071 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1072 type = ntohs (message->type);
1075 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1076 ucast = (struct GNUNET_MESH_Unicast *) message;
1078 t = retrieve_tunnel (h, ntohl (ucast->tid));
1079 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1081 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1082 GNUNET_i2s (peer), ntohl (ucast->tid));
1084 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1085 mcast = (struct GNUNET_MESH_Multicast *) message;
1086 t = retrieve_tunnel (h, ntohl (mcast->tid));
1087 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1089 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1090 GNUNET_i2s (peer), ntohl (mcast->tid));
1092 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1093 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1094 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1095 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1096 peer = &to_orig->sender;
1097 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1098 GNUNET_i2s (peer), ntohl (to_orig->tid));
1106 /* Tunnel was ignored, probably service didn't get it yet */
1109 type = ntohs (payload->type);
1110 for (i = 0; i < h->n_handlers; i++)
1112 handler = &h->message_handlers[i];
1113 if (handler->type == type)
1115 struct GNUNET_ATS_Information atsi;
1120 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1122 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1123 GNUNET_MESH_disconnect (h);
1128 LOG (GNUNET_ERROR_TYPE_DEBUG,
1129 "callback completed successfully\n");
1139 * Process a local ACK message, enabling the client to send
1140 * more data to the service.
1142 * @param h Mesh handle.
1143 * @param message Message itself.
1146 process_ack (struct GNUNET_MESH_Handle *h,
1147 const struct GNUNET_MessageHeader *message)
1149 struct GNUNET_MESH_LocalAck *msg;
1150 struct GNUNET_MESH_Tunnel *t;
1153 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1154 msg = (struct GNUNET_MESH_LocalAck *) message;
1156 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1160 LOG (GNUNET_ERROR_TYPE_WARNING,
1161 "ACK on unknown tunnel %X\n",
1162 ntohl (msg->tunnel_id));
1165 ack = ntohl (msg->max_pid);
1166 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X, ack %u!\n", t->tid, ack);
1167 if (ack > t->max_pid || PID_OVERFLOW (t->max_pid, ack))
1171 if (NULL == h->th && 0 < t->packet_size)
1173 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n", t->tid, ack);
1175 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1176 GNUNET_TIME_UNIT_FOREVER_REL,
1177 GNUNET_YES, &send_callback, h);
1183 * Function to process all messages received from the service
1185 * @param cls closure
1186 * @param msg message received, NULL on timeout or fatal error
1189 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1191 struct GNUNET_MESH_Handle *h = cls;
1195 LOG (GNUNET_ERROR_TYPE_WARNING, "Received NULL msg on %p\n", h);
1199 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %hu from MESH\n",
1201 switch (ntohs (msg->type))
1203 /* Notify of a new incoming tunnel */
1204 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1205 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1207 /* Notify of a tunnel disconnection */
1208 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1209 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1211 /* Notify of a new peer or a peer disconnect in the tunnel */
1212 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1213 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1214 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1216 /* Notify of a new data packet in the tunnel */
1217 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1218 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1219 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1220 if (GNUNET_NO == process_incoming_data (h, msg))
1223 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1224 process_ack (h, msg);
1227 /* We shouldn't get any other packages, log and ignore */
1228 LOG (GNUNET_ERROR_TYPE_WARNING,
1229 "unsolicited message form service (type %d)\n",
1232 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1233 if (GNUNET_YES == h->in_receive)
1235 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1236 GNUNET_TIME_UNIT_FOREVER_REL);
1240 LOG (GNUNET_ERROR_TYPE_DEBUG,
1241 "in receive off, not calling CLIENT_receive\n");
1246 /******************************************************************************/
1247 /************************ SEND FUNCTIONS ****************************/
1248 /******************************************************************************/
1251 * Function called to send a message to the service.
1252 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1255 * @param cls closure, the mesh handle
1256 * @param size number of bytes available in buf
1257 * @param buf where the callee should write the connect message
1258 * @return number of bytes written to buf
1261 send_callback (void *cls, size_t size, void *buf)
1263 struct GNUNET_MESH_Handle *h = cls;
1264 struct GNUNET_MESH_TransmitHandle *th;
1265 struct GNUNET_MESH_TransmitHandle *next;
1266 struct GNUNET_MESH_Tunnel *t;
1271 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1272 if ((0 == size) || (NULL == buf))
1274 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback on %p\n", h);
1281 while ((NULL != (th = next)) && (size >= th->size))
1284 if (GNUNET_YES == th_is_payload (th))
1286 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1287 if (t->max_pid < t->pid && ! PID_OVERFLOW (t->pid, t->max_pid)) {
1288 /* This tunnel is not ready to transmit yet, try next message */
1293 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1295 /* traffic to origin */
1296 struct GNUNET_MESH_ToOrigin to;
1297 struct GNUNET_MessageHeader *mh;
1299 GNUNET_assert (size >= th->size);
1300 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1301 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1302 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %u\n",
1306 psize += sizeof (to);
1307 GNUNET_assert (size >= psize);
1308 to.header.size = htons (psize);
1309 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1310 to.tid = htonl (t->tid);
1312 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1313 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1314 memcpy (cbuf, &to, sizeof (to));
1317 else if (th->target == 0)
1320 struct GNUNET_MESH_Multicast mc;
1321 struct GNUNET_MessageHeader *mh;
1323 GNUNET_assert (size >= th->size);
1324 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1325 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1326 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %u\n",
1330 psize += sizeof (mc);
1331 GNUNET_assert (size >= psize);
1332 mc.header.size = htons (psize);
1333 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1334 mc.tid = htonl (t->tid);
1335 mc.pid = htonl (t->pid);
1337 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1338 memcpy (cbuf, &mc, sizeof (mc));
1344 struct GNUNET_MESH_Unicast uc;
1345 struct GNUNET_MessageHeader *mh;
1347 GNUNET_assert (size >= th->size);
1348 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1349 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1350 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %u\n",
1354 psize += sizeof (uc);
1355 GNUNET_assert (size >= psize);
1356 uc.header.size = htons (psize);
1357 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1358 uc.tid = htonl (t->tid);
1359 uc.pid = htonl (t->pid);
1360 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1361 GNUNET_PEER_resolve (th->target, &uc.destination);
1362 memcpy (cbuf, &uc, sizeof (uc));
1369 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1371 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %u\n",
1373 memcpy (cbuf, &th[1], th->size);
1376 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1377 GNUNET_SCHEDULER_cancel (th->timeout_task);
1378 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1385 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1387 size = message_ready_size (h);
1390 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", size);
1392 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1393 GNUNET_TIME_UNIT_FOREVER_REL,
1394 GNUNET_YES, &send_callback, h);
1398 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1400 if (GNUNET_NO == h->in_receive)
1402 LOG (GNUNET_ERROR_TYPE_DEBUG, " start receiving from service\n");
1403 h->in_receive = GNUNET_YES;
1404 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1405 GNUNET_TIME_UNIT_FOREVER_REL);
1407 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1413 * Auxiliary function to send an already constructed packet to the service.
1414 * Takes care of creating a new queue element, copying the message and
1415 * calling the tmt_rdy function if necessary.
1417 * @param h mesh handle
1418 * @param msg message to transmit
1419 * @param tunnel tunnel this send is related to (NULL if N/A)
1422 send_packet (struct GNUNET_MESH_Handle *h,
1423 const struct GNUNET_MessageHeader *msg,
1424 struct GNUNET_MESH_Tunnel *tunnel)
1426 struct GNUNET_MESH_TransmitHandle *th;
1429 msize = ntohs (msg->size);
1430 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1431 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1433 th->tunnel = tunnel;
1434 memcpy (&th[1], msg, msize);
1435 add_to_queue (h, th);
1439 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1440 GNUNET_TIME_UNIT_FOREVER_REL,
1441 GNUNET_YES, &send_callback, h);
1445 /******************************************************************************/
1446 /********************** API CALL DEFINITIONS *************************/
1447 /******************************************************************************/
1450 * Connect to the mesh service.
1452 * @param cfg configuration to use
1453 * @param cls closure for the various callbacks that follow
1454 * (including handlers in the handlers array)
1455 * @param new_tunnel function called when an *inbound* tunnel is created
1456 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1457 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1458 * is called on the tunnel
1459 * @param handlers callbacks for messages we care about, NULL-terminated
1460 * note that the mesh is allowed to drop notifications about
1461 * inbound messages if the client does not process them fast
1462 * enough (for this notification type, a bounded queue is used)
1463 * @param stypes list of the applications that this client claims to provide
1464 * @return handle to the mesh service NULL on error
1465 * (in this case, init is never called)
1467 struct GNUNET_MESH_Handle *
1468 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1469 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1470 GNUNET_MESH_TunnelEndHandler cleaner,
1471 const struct GNUNET_MESH_MessageHandler *handlers,
1472 const GNUNET_MESH_ApplicationType *stypes)
1474 struct GNUNET_MESH_Handle *h;
1476 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1477 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1478 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1480 h->new_tunnel = new_tunnel;
1481 h->cleaner = cleaner;
1482 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1483 if (h->client == NULL)
1491 h->applications = stypes;
1492 h->message_handlers = handlers;
1493 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1494 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1495 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1497 /* count handlers and apps, calculate size */
1498 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1499 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1501 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1507 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1508 * disconnect callbacks will be called on any still connected peers, notifying
1509 * about their disconnection. The registered inbound tunnel cleaner will be
1510 * called should any inbound tunnels still exist.
1512 * @param handle connection to mesh to disconnect
1515 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1517 struct GNUNET_MESH_Tunnel *t;
1518 struct GNUNET_MESH_Tunnel *aux;
1519 struct GNUNET_MESH_TransmitHandle *th;
1521 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1523 t = handle->tunnels_head;
1527 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1530 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1532 destroy_tunnel (t, GNUNET_YES);
1535 while ( (th = handle->th_head) != NULL)
1537 struct GNUNET_MessageHeader *msg;
1539 /* Make sure it is an allowed packet (everything else should have been
1540 * already canceled).
1542 GNUNET_break (GNUNET_NO == th_is_payload (th));
1543 msg = (struct GNUNET_MessageHeader *) &th[1];
1544 switch (ntohs(msg->type))
1546 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1547 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1551 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1555 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1559 if (NULL != handle->th)
1561 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1564 if (NULL != handle->client)
1566 GNUNET_CLIENT_disconnect (handle->client);
1567 handle->client = NULL;
1569 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1571 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1572 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1574 GNUNET_free (handle);
1579 * Announce to ther peer the availability of services described by the regex,
1580 * in order to be reachable to other peers via connect_by_string.
1582 * Note that the first 8 characters are considered to be part of a prefix,
1583 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1584 * all matching strings will be stored in the DHT.
1586 * @param h handle to mesh.
1587 * @param regex string with the regular expression describing local services.
1590 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1593 struct GNUNET_MessageHeader *msg;
1597 len = strlen (regex);
1598 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1599 GNUNET_assert (UINT16_MAX > msgsize);
1602 char buffer[msgsize];
1604 msg = (struct GNUNET_MessageHeader *) buffer;
1605 msg->size = htons (msgsize);
1606 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1607 memcpy (&msg[1], regex, len);
1609 send_packet(h, msg, NULL);
1614 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1615 * and to broadcast).
1617 * @param h mesh handle
1618 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1619 * @param connect_handler function to call when peers are actually connected
1620 * @param disconnect_handler function to call when peers are disconnected
1621 * @param handler_cls closure for connect/disconnect handlers
1623 struct GNUNET_MESH_Tunnel *
1624 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1625 GNUNET_MESH_PeerConnectHandler connect_handler,
1626 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1629 struct GNUNET_MESH_Tunnel *t;
1630 struct GNUNET_MESH_TunnelMessage msg;
1632 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1633 t = create_tunnel (h, 0);
1634 t->connect_handler = connect_handler;
1635 t->disconnect_handler = disconnect_handler;
1636 t->cls = handler_cls;
1637 t->ctx = tunnel_ctx;
1638 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1639 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1640 msg.tunnel_id = htonl (t->tid);
1641 send_packet (h, &msg.header, t);
1647 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1650 * @param tunnel tunnel handle
1653 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1655 struct GNUNET_MESH_Handle *h;
1656 struct GNUNET_MESH_TunnelMessage msg;
1657 struct GNUNET_MESH_TransmitHandle *th;
1659 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1662 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1663 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1664 msg.tunnel_id = htonl (tunnel->tid);
1668 struct GNUNET_MESH_TransmitHandle *aux;
1669 if (th->tunnel == tunnel)
1672 /* FIXME call the handler? */
1673 if (GNUNET_YES == th_is_payload (th))
1674 th->notify (th->notify_cls, 0, NULL);
1675 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1683 destroy_tunnel (tunnel, GNUNET_NO);
1684 send_packet (h, &msg.header, NULL);
1688 * Request that the tunnel data rate is limited to the speed of the slowest
1691 * @param tunnel Tunnel affected.
1694 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1696 struct GNUNET_MESH_TunnelMessage msg;
1697 struct GNUNET_MESH_Handle *h;
1700 tunnel->speed_min = GNUNET_YES;
1702 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1703 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1704 msg.tunnel_id = htonl (tunnel->tid);
1706 send_packet (h, &msg.header, NULL);
1711 * Request that the tunnel data rate is limited to the speed of the fastest
1712 * receiver. This is the default behavior.
1714 * @param tunnel Tunnel affected.
1717 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1719 struct GNUNET_MESH_TunnelMessage msg;
1720 struct GNUNET_MESH_Handle *h;
1723 tunnel->speed_min = GNUNET_NO;
1725 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1726 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1727 msg.tunnel_id = htonl (tunnel->tid);
1729 send_packet (h, &msg.header, NULL);
1733 * Turn on/off the buffering status of the tunnel.
1735 * @param tunnel Tunnel affected.
1736 * @param buffer GNUNET_YES to turn buffering on (default),
1737 * GNUNET_NO otherwise.
1740 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1742 struct GNUNET_MESH_TunnelMessage msg;
1743 struct GNUNET_MESH_Handle *h;
1746 tunnel->buffering = buffer;
1748 if (GNUNET_YES == buffer)
1749 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1751 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1752 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1753 msg.tunnel_id = htonl (tunnel->tid);
1755 send_packet (h, &msg.header, NULL);
1759 * Request that a peer should be added to the tunnel. The existing
1760 * connect handler will be called ONCE with either success or failure.
1761 * This function should NOT be called again with the same peer before the
1762 * connect handler is called.
1764 * @param tunnel handle to existing tunnel
1765 * @param peer peer to add
1768 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1769 const struct GNUNET_PeerIdentity *peer)
1771 struct GNUNET_MESH_PeerControl msg;
1772 GNUNET_PEER_Id peer_id;
1775 peer_id = GNUNET_PEER_intern (peer);
1776 for (i = 0; i < tunnel->npeers; i++)
1778 if (tunnel->peers[i]->id == peer_id)
1780 /* Peer already exists in tunnel */
1781 GNUNET_PEER_change_rc (peer_id, -1);
1786 if (NULL == add_peer_to_tunnel (tunnel, peer))
1789 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1790 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1791 msg.tunnel_id = htonl (tunnel->tid);
1793 send_packet (tunnel->mesh, &msg.header, tunnel);
1800 * Request that a peer should be removed from the tunnel. The existing
1801 * disconnect handler will be called ONCE if we were connected.
1803 * @param tunnel handle to existing tunnel
1804 * @param peer peer to remove
1807 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1808 const struct GNUNET_PeerIdentity *peer)
1810 struct GNUNET_MESH_PeerControl msg;
1811 GNUNET_PEER_Id peer_id;
1814 peer_id = GNUNET_PEER_search (peer);
1820 for (i = 0; i < tunnel->npeers; i++)
1821 if (tunnel->peers[i]->id == peer_id)
1823 if (i == tunnel->npeers)
1828 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1829 tunnel->disconnect_handler (tunnel->cls, peer);
1830 GNUNET_PEER_change_rc (peer_id, -1);
1831 GNUNET_free (tunnel->peers[i]);
1832 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1833 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1835 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1836 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1837 msg.tunnel_id = htonl (tunnel->tid);
1838 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1839 send_packet (tunnel->mesh, &msg.header, tunnel);
1844 * Request that the mesh should try to connect to a peer supporting the given
1847 * @param tunnel handle to existing tunnel
1848 * @param app_type application type that must be supported by the peer (MESH
1849 * should discover peer in proximity handling this type)
1852 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1853 GNUNET_MESH_ApplicationType app_type)
1855 struct GNUNET_MESH_ConnectPeerByType msg;
1857 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1859 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1860 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1861 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1862 msg.tunnel_id = htonl (tunnel->tid);
1863 msg.type = htonl (app_type);
1864 send_packet (tunnel->mesh, &msg.header, tunnel);
1869 * Request that the mesh should try to connect to a peer matching the
1870 * description given in the service string.
1872 * FIXME: allow multiple? how to deal with reconnect?
1874 * @param tunnel handle to existing tunnel
1875 * @param description string describing the destination node requirements
1878 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1879 const char *description)
1881 struct GNUNET_MESH_ConnectPeerByString *m;
1885 len = strlen (description);
1886 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1887 GNUNET_assert (UINT16_MAX > msgsize);
1889 char buffer[msgsize];
1891 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1892 m->header.size = htons (msgsize);
1893 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1894 m->tunnel_id = htonl (tunnel->tid);
1895 memcpy(&m[1], description, len);
1897 send_packet (tunnel->mesh, &m->header, tunnel);
1903 * Request that the given peer isn't added to this tunnel in calls to
1904 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1906 * @param tunnel handle to existing tunnel.
1907 * @param peer peer identity of the peer which should be blacklisted
1911 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1912 const struct GNUNET_PeerIdentity *peer)
1914 struct GNUNET_MESH_PeerControl msg;
1916 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1917 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1918 msg.tunnel_id = htonl (tunnel->tid);
1920 send_packet (tunnel->mesh, &msg.header, tunnel);
1927 * Request that the given peer isn't blacklisted anymore from this tunnel,
1928 * and therefore can be added in future calls to connect_by_*.
1929 * The peer must have been previously blacklisted for this tunnel.
1931 * @param tunnel handle to existing tunnel.
1932 * @param peer peer identity of the peer which shouldn't be blacklisted
1933 * for the tunnel anymore.
1936 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1937 const struct GNUNET_PeerIdentity *peer)
1939 struct GNUNET_MESH_PeerControl msg;
1941 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1942 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1943 msg.tunnel_id = htonl (tunnel->tid);
1945 send_packet (tunnel->mesh, &msg.header, tunnel);
1952 * Ask the mesh to call "notify" once it is ready to transmit the
1953 * given number of bytes to the specified tunnel or target.
1954 * Only one call can be active at any time, to issue another request,
1955 * wait for the callback or cancel the current request.
1957 * @param tunnel tunnel to use for transmission
1958 * @param cork is corking allowed for this transmission?
1959 * @param maxdelay how long can the message wait?
1960 * @param target destination for the message
1961 * NULL for multicast to all tunnel targets
1962 * @param notify_size how many bytes of buffer space does notify want?
1963 * @param notify function to call when buffer space is available;
1964 * will be called with NULL on timeout or if the overall queue
1965 * for this peer is larger than queue_size and this is currently
1966 * the message with the lowest priority
1967 * @param notify_cls closure for notify
1968 * @return non-NULL if the notify callback was queued,
1969 * NULL if we can not even queue the request (insufficient
1970 * memory); if NULL is returned, "notify" will NOT be called.
1972 struct GNUNET_MESH_TransmitHandle *
1973 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1974 struct GNUNET_TIME_Relative maxdelay,
1975 const struct GNUNET_PeerIdentity *target,
1977 GNUNET_CONNECTION_TransmitReadyNotify notify,
1980 struct GNUNET_MESH_TransmitHandle *th;
1983 GNUNET_assert (NULL != tunnel);
1984 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1986 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1988 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1989 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
1990 GNUNET_assert (NULL != notify);
1991 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1992 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1993 th->tunnel = tunnel;
1994 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1995 th->target = GNUNET_PEER_intern (target);
1996 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1997 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1998 else if (NULL == target)
1999 overhead = sizeof (struct GNUNET_MESH_Multicast);
2001 overhead = sizeof (struct GNUNET_MESH_Unicast);
2002 tunnel->packet_size = th->size = notify_size + overhead;
2003 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
2004 th->notify = notify;
2005 th->notify_cls = notify_cls;
2006 add_to_queue (tunnel->mesh, th);
2007 if (NULL != tunnel->mesh->th)
2009 LOG (GNUNET_ERROR_TYPE_DEBUG, " call notify tmt rdy\n");
2011 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
2012 GNUNET_TIME_UNIT_FOREVER_REL,
2013 GNUNET_YES, &send_callback,
2020 * Cancel the specified transmission-ready notification.
2022 * @param th handle that was returned by "notify_transmit_ready".
2025 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
2027 struct GNUNET_MESH_Handle *mesh;
2029 mesh = th->tunnel->mesh;
2030 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
2031 GNUNET_SCHEDULER_cancel (th->timeout_task);
2032 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
2034 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
2036 /* queue empty, no point in asking for transmission */
2037 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
2044 * Transition API for tunnel ctx management
2047 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2053 * Transition API for tunnel ctx management
2056 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)