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
26 * - AUXILIARY FUNCTIONS
29 * - API CALL DEFINITIONS
31 * TODO: add regex to reconnect
34 #include "gnunet_common.h"
35 #include "gnunet_client_lib.h"
36 #include "gnunet_util_lib.h"
37 #include "gnunet_peer_lib.h"
38 #include "gnunet_mesh_service.h"
40 #include "mesh_protocol.h"
42 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
45 /******************************************************************************/
46 /************************ DATA STRUCTURES ****************************/
47 /******************************************************************************/
50 * Transmission queue to the service
52 struct GNUNET_MESH_TransmitHandle
58 struct GNUNET_MESH_TransmitHandle *next;
63 struct GNUNET_MESH_TransmitHandle *prev;
66 * Tunnel this message is sent on / for (may be NULL for control messages).
68 struct GNUNET_MESH_Tunnel *tunnel;
71 * Callback to obtain the message to transmit, or NULL if we
72 * got the message in 'data'. Notice that messages built
73 * by 'notify' need to be encapsulated with information about
76 GNUNET_CONNECTION_TransmitReadyNotify notify;
79 * Closure for 'notify'
84 * How long is this message valid. Once the timeout has been
85 * reached, the message must no longer be sent. If this
86 * is a message with a 'notify' callback set, the 'notify'
87 * function should be called with 'buf' NULL and size 0.
89 struct GNUNET_TIME_Absolute timeout;
92 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
94 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
97 * Target of the message, 0 for multicast. This field
98 * is only valid if 'notify' is non-NULL.
100 GNUNET_PEER_Id target;
103 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
110 * Opaque handle to the service.
112 struct GNUNET_MESH_Handle
116 * Handle to the server connection, to send messages later
118 struct GNUNET_CLIENT_Connection *client;
121 * Set of handlers used for processing incoming messages in the tunnels
123 const struct GNUNET_MESH_MessageHandler *message_handlers;
126 * Set of applications that should be claimed to be offered at this node.
127 * Note that this is just informative, the appropiate handlers must be
128 * registered independently and the mapping is up to the developer of the
129 * client application.
131 const GNUNET_MESH_ApplicationType *applications;
134 * Double linked list of the tunnels this client is connected to, head.
136 struct GNUNET_MESH_Tunnel *tunnels_head;
139 * Double linked list of the tunnels this client is connected to, tail.
141 struct GNUNET_MESH_Tunnel *tunnels_tail;
144 * Callback for inbound tunnel creation
146 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
149 * Callback for inbound tunnel disconnection
151 GNUNET_MESH_TunnelEndHandler *cleaner;
154 * Handle to cancel pending transmissions in case of disconnection
156 struct GNUNET_CLIENT_TransmitHandle *th;
159 * Closure for all the handlers given by the client
164 * Messages to send to the service, head.
166 struct GNUNET_MESH_TransmitHandle *th_head;
169 * Messages to send to the service, tail.
171 struct GNUNET_MESH_TransmitHandle *th_tail;
174 * tid of the next tunnel to create (to avoid reusing IDs often)
176 MESH_TunnelNumber next_tid;
179 * Number of handlers in the handlers array.
181 unsigned int n_handlers;
184 * Number of applications in the applications array.
186 unsigned int n_applications;
189 * Have we started the task to receive messages from the service
190 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
195 * Configuration given by the client, in case of reconnection
197 const struct GNUNET_CONFIGURATION_Handle *cfg;
200 * Time to the next reconnect in case one reconnect fails
202 struct GNUNET_TIME_Relative reconnect_time;
205 * Task for trying to reconnect.
207 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
212 * Description of a peer
214 struct GNUNET_MESH_Peer
217 * ID of the peer in short form
222 * Tunnel this peer belongs to
224 struct GNUNET_MESH_Tunnel *t;
227 * Flag indicating whether service has informed about its connection
235 * Opaque handle to a tunnel.
237 struct GNUNET_MESH_Tunnel
243 struct GNUNET_MESH_Tunnel *next;
248 struct GNUNET_MESH_Tunnel *prev;
251 * Callback to execute when peers connect to the tunnel
253 GNUNET_MESH_PeerConnectHandler connect_handler;
256 * Callback to execute when peers disconnect from the tunnel
258 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
261 * Closure for the connect/disconnect handlers
266 * Handle to the mesh this tunnel belongs to
268 struct GNUNET_MESH_Handle *mesh;
271 * Local ID of the tunnel
273 MESH_TunnelNumber tid;
276 * Owner of the tunnel. 0 if the tunnel is the local client.
278 GNUNET_PEER_Id owner;
281 * All peers added to the tunnel
283 struct GNUNET_MESH_Peer **peers;
286 * List of application types that have been requested for this tunnel
288 GNUNET_MESH_ApplicationType *apps;
291 * Any data the caller wants to put in here
296 * Number of peers added to the tunnel
301 * Size of packet queued in this tunnel
303 unsigned int packet_size;
306 * Number of applications requested this tunnel
311 * Is the tunnel throttled to the slowest peer?
316 * Is the tunnel allowed to buffer?
321 * Next packet ID to send.
323 uint32_t next_send_pid;
326 * Maximum allowed PID to send (ACK recevied).
328 uint32_t max_send_pid;
331 * Last pid received from the service.
333 uint32_t last_recv_pid;
337 /******************************************************************************/
338 /*********************** DECLARATIONS *************************/
339 /******************************************************************************/
342 * Function called to send a message to the service.
343 * "buf" will be NULL and "size" zero if the socket was closed for writing in
346 * @param cls closure, the mesh handle
347 * @param size number of bytes available in buf
348 * @param buf where the callee should write the connect message
349 * @return number of bytes written to buf
352 send_callback (void *cls, size_t size, void *buf);
355 /******************************************************************************/
356 /*********************** AUXILIARY FUNCTIONS *************************/
357 /******************************************************************************/
360 * Check if transmission is a payload packet.
362 * @param th Transmission handle.
364 * @return GNUNET_YES if it is a payload packet,
365 * GNUNET_NO if it is a mesh management packet.
368 th_is_payload (struct GNUNET_MESH_TransmitHandle *th)
370 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
375 * Check whether there is any message ready in the queue and find the size.
377 * @param h Mesh handle.
379 * @return The size of the first ready message in the queue,
380 * 0 if there is none.
383 message_ready_size (struct GNUNET_MESH_Handle *h)
385 struct GNUNET_MESH_TransmitHandle *th;
386 struct GNUNET_MESH_Tunnel *t;
388 for (th = h->th_head; NULL != th; th = th->next)
391 if (GNUNET_NO == th_is_payload (th))
393 LOG (GNUNET_ERROR_TYPE_DEBUG, " message internal\n");
396 if (GNUNET_NO == GMC_is_pid_bigger(t->next_send_pid, t->max_send_pid))
398 LOG (GNUNET_ERROR_TYPE_DEBUG, " message payload ok (%u <= %u)\n",
399 t->next_send_pid, t->max_send_pid);
408 * Get the tunnel handler for the tunnel specified by id from the given handle
409 * @param h Mesh handle
410 * @param tid ID of the wanted tunnel
411 * @return handle to the required tunnel or NULL if not found
413 static struct GNUNET_MESH_Tunnel *
414 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
416 struct GNUNET_MESH_Tunnel *t;
430 * Create a new tunnel and insert it in the tunnel list of the mesh handle
431 * @param h Mesh handle
432 * @param tid desired tid of the tunnel, 0 to assign one automatically
433 * @return handle to the created tunnel
435 static struct GNUNET_MESH_Tunnel *
436 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
438 struct GNUNET_MESH_Tunnel *t;
440 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
441 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
445 t->tid = h->next_tid;
446 while (NULL != retrieve_tunnel (h, h->next_tid))
449 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
450 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
463 * Destroy the specified tunnel.
464 * - Destroys all peers, calling the disconnect callback on each if needed
465 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
466 * - Calls cleaner if tunnel was inbound
467 * - Frees all memory used
469 * @param t Pointer to the tunnel.
470 * @param call_cleaner Whether to call the cleaner handler.
472 * @return Handle to the required tunnel or NULL if not found.
475 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
477 struct GNUNET_MESH_Handle *h;
478 struct GNUNET_PeerIdentity pi;
479 struct GNUNET_MESH_TransmitHandle *th;
480 struct GNUNET_MESH_TransmitHandle *next;
483 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
492 /* disconnect all peers */
493 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
494 for (i = 0; i < t->npeers; i++)
496 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
498 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
499 t->disconnect_handler (t->cls, &pi);
501 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
502 GNUNET_free (t->peers[i]);
505 /* signal tunnel destruction */
506 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
507 h->cleaner (h->cls, t, t->ctx);
509 /* check that clients did not leave messages behind in the queue */
510 for (th = h->th_head; NULL != th; th = next)
515 /* Clients should have aborted their requests already.
516 * Management traffic should be ok, as clients can't cancel that */
517 GNUNET_break (GNUNET_NO == th_is_payload(th));
518 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
520 /* clean up request */
521 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
522 GNUNET_SCHEDULER_cancel (th->timeout_task);
526 /* if there are no more pending requests with mesh service, cancel active request */
527 /* Note: this should be unnecessary... */
528 if ((0 == message_ready_size (h)) && (NULL != h->th))
530 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
536 GNUNET_free (t->peers);
538 GNUNET_PEER_change_rc (t->owner, -1);
539 if (0 != t->napps && t->apps)
540 GNUNET_free (t->apps);
547 * Get the peer descriptor for the peer with id from the given tunnel
548 * @param t Tunnel handle
549 * @param id Short form ID of the wanted peer
550 * @return handle to the requested peer or NULL if not found
552 static struct GNUNET_MESH_Peer *
553 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
557 for (i = 0; i < t->npeers; i++)
558 if (t->peers[i]->id == id)
565 * Add a peer into a tunnel
566 * @param t Tunnel handle
567 * @param pi Full ID of the new peer
568 * @return handle to the newly created peer
570 static struct GNUNET_MESH_Peer *
571 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
572 const struct GNUNET_PeerIdentity *pi)
574 struct GNUNET_MESH_Peer *p;
582 id = GNUNET_PEER_intern (pi);
584 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
587 GNUNET_array_append (t->peers, t->npeers, p);
593 * Remove a peer from a tunnel
594 * @param p Peer handle
597 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
601 for (i = 0; i < p->t->npeers; i++)
603 if (p->t->peers[i] == p)
606 if (i == p->t->npeers)
611 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
612 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
617 * Notify client that the transmission has timed out
620 * @param tc task context
623 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
625 struct GNUNET_MESH_TransmitHandle *th = cls;
626 struct GNUNET_MESH_Handle *mesh;
628 mesh = th->tunnel->mesh;
629 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
630 th->tunnel->packet_size = 0;
631 if (GNUNET_YES == th_is_payload (th))
632 th->notify (th->notify_cls, 0, NULL);
634 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
636 /* nothing ready to transmit, no point in asking for transmission */
637 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
644 * Add a transmit handle to the transmission queue by priority and set the
647 * @param h mesh handle with the queue head and tail
648 * @param th handle to the packet to be transmitted
651 add_to_queue (struct GNUNET_MESH_Handle *h,
652 struct GNUNET_MESH_TransmitHandle *th)
654 struct GNUNET_MESH_TransmitHandle *p;
663 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
664 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
667 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
668 (th->timeout), &timeout_transmission, th);
673 * Auxiliary function to send an already constructed packet to the service.
674 * Takes care of creating a new queue element, copying the message and
675 * calling the tmt_rdy function if necessary.
677 * @param h mesh handle
678 * @param msg message to transmit
679 * @param tunnel tunnel this send is related to (NULL if N/A)
682 send_packet (struct GNUNET_MESH_Handle *h,
683 const struct GNUNET_MessageHeader *msg,
684 struct GNUNET_MESH_Tunnel *tunnel);
688 * Send an ack on the tunnel to confirm the processing of a message.
690 * @param h Mesh handle.
691 * @param t Tunnel on which to send the ACK.
694 send_ack (struct GNUNET_MESH_Handle *h, struct GNUNET_MESH_Tunnel *t)
696 struct GNUNET_MESH_LocalAck msg;
698 LOG (GNUNET_ERROR_TYPE_DEBUG,
699 "Sending ACK on tunnel %X: %u\n",
700 t->tid, t->last_recv_pid + 1);
701 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
702 msg.header.size = htons (sizeof (msg));
703 msg.tunnel_id = htonl (t->tid);
704 msg.max_pid = t->last_recv_pid + 1;
706 send_packet (h, &msg.header, t);
713 * Reconnect callback: tries to reconnect again after a failer previous
715 * @param cls closure (mesh handle)
716 * @param tc task context
719 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
723 * Send a connect packet to the service with the applications and types
724 * requested by the user.
726 * @param h The mesh handle.
730 send_connect (struct GNUNET_MESH_Handle *h)
734 size = sizeof (struct GNUNET_MESH_ClientConnect);
735 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
736 size += h->n_handlers * sizeof (uint16_t);
738 char buf[size] GNUNET_ALIGN;
739 struct GNUNET_MESH_ClientConnect *msg;
740 GNUNET_MESH_ApplicationType *apps;
745 /* build connection packet */
746 msg = (struct GNUNET_MESH_ClientConnect *) buf;
747 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
748 msg->header.size = htons (size);
749 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
750 for (napps = 0; napps < h->n_applications; napps++)
752 apps[napps] = htonl (h->applications[napps]);
753 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n",
754 h->applications[napps]);
756 types = (uint16_t *) & apps[napps];
757 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
759 types[ntypes] = htons (h->message_handlers[ntypes].type);
760 LOG (GNUNET_ERROR_TYPE_DEBUG, " type %u\n",
761 h->message_handlers[ntypes].type);
763 msg->applications = htons (napps);
764 msg->types = htons (ntypes);
765 LOG (GNUNET_ERROR_TYPE_DEBUG,
766 "Sending %lu bytes long message %d types and %d apps\n",
767 ntohs (msg->header.size), ntypes, napps);
768 send_packet (h, &msg->header, NULL);
774 * Reconnect to the service, retransmit all infomation to try to restore the
777 * @param h handle to the mesh
779 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
782 do_reconnect (struct GNUNET_MESH_Handle *h)
784 struct GNUNET_MESH_Tunnel *t;
787 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
788 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
789 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
790 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
791 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
796 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
799 if (NULL != h->client)
801 GNUNET_CLIENT_disconnect (h->client);
805 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
806 if (h->client == NULL)
808 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
811 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
812 GNUNET_TIME_relative_multiply
813 (h->reconnect_time, 2));
814 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
815 GNUNET_TIME_relative_to_string (h->reconnect_time));
821 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
824 /* Rebuild all tunnels */
825 for (t = h->tunnels_head; NULL != t; t = t->next)
827 struct GNUNET_MESH_TunnelMessage tmsg;
828 struct GNUNET_MESH_PeerControl pmsg;
830 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
832 /* Tunnel was created by service (incoming tunnel) */
833 /* TODO: Notify service of missing tunnel, to request
834 * creator to recreate path (find a path to him via DHT?)
838 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
839 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
840 tmsg.tunnel_id = htonl (t->tid);
841 send_packet (h, &tmsg.header, t);
843 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
844 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
845 pmsg.tunnel_id = htonl (t->tid);
847 /* Reconnect all peers */
848 /* If the tunnel was "by type", dont connect individual peers */
849 for (i = 0; i < t->npeers && 0 == t->napps; i++)
851 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
852 if (NULL != t->disconnect_handler && t->peers[i]->connected)
853 t->disconnect_handler (t->cls, &pmsg.peer);
854 send_packet (t->mesh, &pmsg.header, t);
856 /* Reconnect all types, if any */
857 for (i = 0; i < t->napps; i++)
859 struct GNUNET_MESH_ConnectPeerByType msg;
861 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
862 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
863 msg.tunnel_id = htonl (t->tid);
864 msg.type = htonl (t->apps[i]);
865 send_packet (t->mesh, &msg.header, t);
867 if (GNUNET_NO == t->buffering)
868 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
869 if (GNUNET_YES == t->speed_min)
870 GNUNET_MESH_tunnel_speed_min (t);
876 * Reconnect callback: tries to reconnect again after a failer previous
878 * @param cls closure (mesh handle)
879 * @param tc task context
882 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
884 struct GNUNET_MESH_Handle *h = cls;
886 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
887 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
894 * Reconnect to the service, retransmit all infomation to try to restore the
897 * @param h handle to the mesh
899 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
902 reconnect (struct GNUNET_MESH_Handle *h)
904 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
905 h->in_receive = GNUNET_NO;
906 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
907 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
912 /******************************************************************************/
913 /*********************** RECEIVE HANDLERS ****************************/
914 /******************************************************************************/
917 * Process the new tunnel notification and add it to the tunnels in the handle
919 * @param h The mesh handle
920 * @param msg A message with the details of the new incoming tunnel
923 process_tunnel_created (struct GNUNET_MESH_Handle *h,
924 const struct GNUNET_MESH_TunnelNotification *msg)
926 struct GNUNET_MESH_Tunnel *t;
927 MESH_TunnelNumber tid;
929 tid = ntohl (msg->tunnel_id);
930 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming tunnel %X\n", tid);
931 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
936 if (NULL != h->new_tunnel)
938 struct GNUNET_ATS_Information atsi;
940 t = create_tunnel (h, tid);
941 t->owner = GNUNET_PEER_intern (&msg->peer);
943 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
944 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
946 t->peers[0]->connected = 1;
947 t->peers[0]->id = t->owner;
948 GNUNET_PEER_change_rc (t->owner, 1);
953 LOG (GNUNET_ERROR_TYPE_DEBUG, " created tunnel %p\n", t);
954 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
955 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
959 struct GNUNET_MESH_TunnelMessage d_msg;
961 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
963 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
964 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
965 d_msg.tunnel_id = msg->tunnel_id;
967 send_packet (h, &d_msg.header, NULL);
974 * Process the tunnel destroy notification and free associated resources
976 * @param h The mesh handle
977 * @param msg A message with the details of the tunnel being destroyed
980 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
981 const struct GNUNET_MESH_TunnelMessage *msg)
983 struct GNUNET_MESH_Tunnel *t;
984 MESH_TunnelNumber tid;
986 tid = ntohl (msg->tunnel_id);
987 t = retrieve_tunnel (h, tid);
997 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
998 destroy_tunnel (t, GNUNET_YES);
1004 * Process the new peer event and notify the upper level of it
1006 * @param h The mesh handle
1007 * @param msg A message with the details of the peer event
1010 process_peer_event (struct GNUNET_MESH_Handle *h,
1011 const struct GNUNET_MESH_PeerControl *msg)
1013 struct GNUNET_MESH_Tunnel *t;
1014 struct GNUNET_MESH_Peer *p;
1015 struct GNUNET_ATS_Information atsi;
1019 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
1020 size = ntohs (msg->header.size);
1021 if (size != sizeof (struct GNUNET_MESH_PeerControl))
1026 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1032 id = GNUNET_PEER_search (&msg->peer);
1033 if ((p = retrieve_peer (t, id)) == NULL)
1034 p = add_peer_to_tunnel (t, &msg->peer);
1035 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
1037 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
1038 if (NULL != t->connect_handler)
1042 t->connect_handler (t->cls, &msg->peer, &atsi);
1048 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
1049 if (NULL != t->disconnect_handler && p->connected)
1051 t->disconnect_handler (t->cls, &msg->peer);
1053 remove_peer_from_tunnel (p);
1056 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
1061 * Process the incoming data packets
1063 * @param h The mesh handle
1064 * @param message A message encapsulating the data
1066 * @return GNUNET_YES if everything went fine
1067 * GNUNET_NO if client closed connection (h no longer valid)
1070 process_incoming_data (struct GNUNET_MESH_Handle *h,
1071 const struct GNUNET_MessageHeader *message)
1073 const struct GNUNET_MessageHeader *payload;
1074 const struct GNUNET_MESH_MessageHandler *handler;
1075 const struct GNUNET_PeerIdentity *peer;
1076 struct GNUNET_MESH_Unicast *ucast;
1077 struct GNUNET_MESH_Multicast *mcast;
1078 struct GNUNET_MESH_ToOrigin *to_orig;
1079 struct GNUNET_MESH_Tunnel *t;
1084 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1085 type = ntohs (message->type);
1088 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1089 ucast = (struct GNUNET_MESH_Unicast *) message;
1091 t = retrieve_tunnel (h, ntohl (ucast->tid));
1092 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1094 pid = ntohl (ucast->pid);
1095 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1096 GNUNET_i2s (peer), ntohl (ucast->tid));
1098 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1099 mcast = (struct GNUNET_MESH_Multicast *) message;
1100 t = retrieve_tunnel (h, ntohl (mcast->tid));
1101 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1103 pid = ntohl (mcast->pid);
1104 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1105 GNUNET_i2s (peer), ntohl (mcast->tid));
1107 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1108 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1109 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1110 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1111 peer = &to_orig->sender;
1112 pid = ntohl (to_orig->pid);
1113 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1114 GNUNET_i2s (peer), ntohl (to_orig->tid));
1120 LOG (GNUNET_ERROR_TYPE_DEBUG, " pid %u\n", pid);
1123 /* Tunnel was ignored, probably service didn't get it yet */
1124 LOG (GNUNET_ERROR_TYPE_DEBUG, " ignored!\n");
1127 if (GMC_is_pid_bigger(pid, t->last_recv_pid + 1))
1130 LOG (GNUNET_ERROR_TYPE_WARNING, " unauthorized message!\n");
1131 // FIXME fc what now? accept? reject?
1134 t->last_recv_pid = pid;
1135 type = ntohs (payload->type);
1136 for (i = 0; i < h->n_handlers; i++)
1138 handler = &h->message_handlers[i];
1139 if (handler->type == type)
1141 struct GNUNET_ATS_Information atsi;
1146 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1148 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1149 GNUNET_MESH_disconnect (h);
1154 LOG (GNUNET_ERROR_TYPE_DEBUG,
1155 "callback completed successfully\n");
1165 * Process a local ACK message, enabling the client to send
1166 * more data to the service.
1168 * @param h Mesh handle.
1169 * @param message Message itself.
1172 process_ack (struct GNUNET_MESH_Handle *h,
1173 const struct GNUNET_MessageHeader *message)
1175 struct GNUNET_MESH_LocalAck *msg;
1176 struct GNUNET_MESH_Tunnel *t;
1179 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1180 msg = (struct GNUNET_MESH_LocalAck *) message;
1182 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1186 LOG (GNUNET_ERROR_TYPE_WARNING,
1187 "ACK on unknown tunnel %X\n",
1188 ntohl (msg->tunnel_id));
1191 ack = ntohl (msg->max_pid);
1192 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X, ack %u!\n", t->tid, ack);
1193 if (ack > t->max_send_pid || PID_OVERFLOW (t->max_send_pid, ack))
1194 t->max_send_pid = ack;
1197 if (NULL == h->th && 0 < t->packet_size)
1199 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n", t->tid, ack);
1201 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1202 GNUNET_TIME_UNIT_FOREVER_REL,
1203 GNUNET_YES, &send_callback, h);
1209 * Function to process all messages received from the service
1211 * @param cls closure
1212 * @param msg message received, NULL on timeout or fatal error
1215 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1217 struct GNUNET_MESH_Handle *h = cls;
1221 LOG (GNUNET_ERROR_TYPE_WARNING, "Received NULL msg on %p\n", h);
1225 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n",
1226 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1227 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1228 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1229 switch (ntohs (msg->type))
1231 /* Notify of a new incoming tunnel */
1232 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1233 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1235 /* Notify of a tunnel disconnection */
1236 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1237 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1239 /* Notify of a new peer or a peer disconnect in the tunnel */
1240 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1241 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1242 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1244 /* Notify of a new data packet in the tunnel */
1245 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1246 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1247 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1248 if (GNUNET_NO == process_incoming_data (h, msg))
1251 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1252 process_ack (h, msg);
1255 /* We shouldn't get any other packages, log and ignore */
1256 LOG (GNUNET_ERROR_TYPE_WARNING,
1257 "unsolicited message form service (type %hu)\n",
1260 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1261 if (GNUNET_YES == h->in_receive)
1263 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1264 GNUNET_TIME_UNIT_FOREVER_REL);
1268 LOG (GNUNET_ERROR_TYPE_DEBUG,
1269 "in receive off, not calling CLIENT_receive\n");
1274 /******************************************************************************/
1275 /************************ SEND FUNCTIONS ****************************/
1276 /******************************************************************************/
1279 * Function called to send a message to the service.
1280 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1283 * @param cls closure, the mesh handle
1284 * @param size number of bytes available in buf
1285 * @param buf where the callee should write the connect message
1286 * @return number of bytes written to buf
1289 send_callback (void *cls, size_t size, void *buf)
1291 struct GNUNET_MESH_Handle *h = cls;
1292 struct GNUNET_MESH_TransmitHandle *th;
1293 struct GNUNET_MESH_TransmitHandle *next;
1294 struct GNUNET_MESH_Tunnel *t;
1300 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1301 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1302 if ((0 == size) || (NULL == buf))
1304 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback on %p\n", h);
1311 nsize = message_ready_size (h);
1312 while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1315 if (GNUNET_YES == th_is_payload (th))
1317 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1318 if (GNUNET_YES == GMC_is_pid_bigger(t->next_send_pid, t->max_send_pid))
1320 /* This tunnel is not ready to transmit yet, try next message */
1325 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1327 /* traffic to origin */
1328 struct GNUNET_MESH_ToOrigin to;
1329 struct GNUNET_MessageHeader *mh;
1331 GNUNET_assert (size >= th->size);
1332 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1333 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1334 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %s\n",
1335 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1338 psize += sizeof (to);
1339 GNUNET_assert (size >= psize);
1340 to.header.size = htons (psize);
1341 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1342 to.tid = htonl (t->tid);
1343 to.pid = htonl (t->next_send_pid);
1344 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1345 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1346 memcpy (cbuf, &to, sizeof (to));
1349 else if (th->target == 0)
1352 struct GNUNET_MESH_Multicast mc;
1353 struct GNUNET_MessageHeader *mh;
1355 GNUNET_assert (size >= th->size);
1356 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1357 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1358 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %s\n",
1359 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1362 psize += sizeof (mc);
1363 GNUNET_assert (size >= psize);
1364 mc.header.size = htons (psize);
1365 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1366 mc.tid = htonl (t->tid);
1367 mc.pid = htonl (t->next_send_pid);
1369 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1370 memcpy (cbuf, &mc, sizeof (mc));
1376 struct GNUNET_MESH_Unicast uc;
1377 struct GNUNET_MessageHeader *mh;
1379 GNUNET_assert (size >= th->size);
1380 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1381 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1382 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %s\n",
1383 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1386 psize += sizeof (uc);
1387 GNUNET_assert (size >= psize);
1388 uc.header.size = htons (psize);
1389 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1390 uc.tid = htonl (t->tid);
1391 uc.pid = htonl (t->next_send_pid);
1392 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1393 GNUNET_PEER_resolve (th->target, &uc.destination);
1394 memcpy (cbuf, &uc, sizeof (uc));
1401 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1403 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %s\n",
1404 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1405 memcpy (cbuf, &th[1], th->size);
1408 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1409 GNUNET_SCHEDULER_cancel (th->timeout_task);
1410 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1413 nsize = message_ready_size (h);
1418 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1420 size = message_ready_size (h);
1423 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", size);
1425 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1426 GNUNET_TIME_UNIT_FOREVER_REL,
1427 GNUNET_YES, &send_callback, h);
1431 if (NULL != h->th_head)
1432 LOG (GNUNET_ERROR_TYPE_DEBUG, " can't transmit any more\n");
1434 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1436 if (GNUNET_NO == h->in_receive)
1438 LOG (GNUNET_ERROR_TYPE_DEBUG, " start receiving from service\n");
1439 h->in_receive = GNUNET_YES;
1440 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1441 GNUNET_TIME_UNIT_FOREVER_REL);
1443 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1449 * Auxiliary function to send an already constructed packet to the service.
1450 * Takes care of creating a new queue element, copying the message and
1451 * calling the tmt_rdy function if necessary.
1453 * @param h mesh handle
1454 * @param msg message to transmit
1455 * @param tunnel tunnel this send is related to (NULL if N/A)
1458 send_packet (struct GNUNET_MESH_Handle *h,
1459 const struct GNUNET_MessageHeader *msg,
1460 struct GNUNET_MESH_Tunnel *tunnel)
1462 struct GNUNET_MESH_TransmitHandle *th;
1465 LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1466 GNUNET_MESH_DEBUG_M2S(ntohs(msg->type)));
1467 msize = ntohs (msg->size);
1468 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1469 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1471 th->tunnel = tunnel;
1472 memcpy (&th[1], msg, msize);
1473 add_to_queue (h, th);
1474 LOG (GNUNET_ERROR_TYPE_DEBUG, " queued\n");
1477 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling ntfy tmt rdy for %u bytes\n", msize);
1479 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1480 GNUNET_TIME_UNIT_FOREVER_REL,
1481 GNUNET_YES, &send_callback, h);
1485 /******************************************************************************/
1486 /********************** API CALL DEFINITIONS *************************/
1487 /******************************************************************************/
1490 * Connect to the mesh service.
1492 * @param cfg configuration to use
1493 * @param cls closure for the various callbacks that follow
1494 * (including handlers in the handlers array)
1495 * @param new_tunnel function called when an *inbound* tunnel is created
1496 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1497 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1498 * is called on the tunnel
1499 * @param handlers callbacks for messages we care about, NULL-terminated
1500 * note that the mesh is allowed to drop notifications about
1501 * inbound messages if the client does not process them fast
1502 * enough (for this notification type, a bounded queue is used)
1503 * @param stypes list of the applications that this client claims to provide
1504 * @return handle to the mesh service NULL on error
1505 * (in this case, init is never called)
1507 struct GNUNET_MESH_Handle *
1508 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1509 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1510 GNUNET_MESH_TunnelEndHandler cleaner,
1511 const struct GNUNET_MESH_MessageHandler *handlers,
1512 const GNUNET_MESH_ApplicationType *stypes)
1514 struct GNUNET_MESH_Handle *h;
1516 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1517 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1518 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1520 h->new_tunnel = new_tunnel;
1521 h->cleaner = cleaner;
1522 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1523 if (h->client == NULL)
1531 h->applications = stypes;
1532 h->message_handlers = handlers;
1533 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1534 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1535 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1537 /* count handlers and apps, calculate size */
1538 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1539 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1541 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1547 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1548 * disconnect callbacks will be called on any still connected peers, notifying
1549 * about their disconnection. The registered inbound tunnel cleaner will be
1550 * called should any inbound tunnels still exist.
1552 * @param handle connection to mesh to disconnect
1555 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1557 struct GNUNET_MESH_Tunnel *t;
1558 struct GNUNET_MESH_Tunnel *aux;
1559 struct GNUNET_MESH_TransmitHandle *th;
1561 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1563 t = handle->tunnels_head;
1567 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1570 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1572 destroy_tunnel (t, GNUNET_YES);
1575 while ( (th = handle->th_head) != NULL)
1577 struct GNUNET_MessageHeader *msg;
1579 /* Make sure it is an allowed packet (everything else should have been
1580 * already canceled).
1582 GNUNET_break (GNUNET_NO == th_is_payload (th));
1583 msg = (struct GNUNET_MessageHeader *) &th[1];
1584 switch (ntohs(msg->type))
1586 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1587 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1591 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1595 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1599 if (NULL != handle->th)
1601 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1604 if (NULL != handle->client)
1606 GNUNET_CLIENT_disconnect (handle->client);
1607 handle->client = NULL;
1609 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1611 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1612 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1614 GNUNET_free (handle);
1619 * Announce to ther peer the availability of services described by the regex,
1620 * in order to be reachable to other peers via connect_by_string.
1622 * Note that the first 8 characters are considered to be part of a prefix,
1623 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1624 * all matching strings will be stored in the DHT.
1626 * @param h handle to mesh.
1627 * @param regex string with the regular expression describing local services.
1630 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1633 struct GNUNET_MessageHeader *msg;
1637 len = strlen (regex);
1638 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1639 GNUNET_assert (UINT16_MAX > msgsize);
1642 char buffer[msgsize];
1644 msg = (struct GNUNET_MessageHeader *) buffer;
1645 msg->size = htons (msgsize);
1646 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1647 memcpy (&msg[1], regex, len);
1649 send_packet(h, msg, NULL);
1654 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1655 * and to broadcast).
1657 * @param h mesh handle
1658 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1659 * @param connect_handler function to call when peers are actually connected
1660 * @param disconnect_handler function to call when peers are disconnected
1661 * @param handler_cls closure for connect/disconnect handlers
1663 struct GNUNET_MESH_Tunnel *
1664 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1665 GNUNET_MESH_PeerConnectHandler connect_handler,
1666 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1669 struct GNUNET_MESH_Tunnel *t;
1670 struct GNUNET_MESH_TunnelMessage msg;
1672 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1673 t = create_tunnel (h, 0);
1674 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", t);
1675 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n", t->tid);
1676 t->connect_handler = connect_handler;
1677 t->disconnect_handler = disconnect_handler;
1678 t->cls = handler_cls;
1679 t->ctx = tunnel_ctx;
1680 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1681 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1682 msg.tunnel_id = htonl (t->tid);
1683 send_packet (h, &msg.header, t);
1689 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1692 * @param tunnel tunnel handle
1695 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1697 struct GNUNET_MESH_Handle *h;
1698 struct GNUNET_MESH_TunnelMessage msg;
1699 struct GNUNET_MESH_TransmitHandle *th;
1701 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1704 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1705 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1706 msg.tunnel_id = htonl (tunnel->tid);
1710 struct GNUNET_MESH_TransmitHandle *aux;
1711 if (th->tunnel == tunnel)
1714 /* FIXME call the handler? */
1715 if (GNUNET_YES == th_is_payload (th))
1716 th->notify (th->notify_cls, 0, NULL);
1717 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1725 destroy_tunnel (tunnel, GNUNET_NO);
1726 send_packet (h, &msg.header, NULL);
1730 * Request that the tunnel data rate is limited to the speed of the slowest
1733 * @param tunnel Tunnel affected.
1736 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1738 struct GNUNET_MESH_TunnelMessage msg;
1739 struct GNUNET_MESH_Handle *h;
1742 tunnel->speed_min = GNUNET_YES;
1744 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1745 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1746 msg.tunnel_id = htonl (tunnel->tid);
1748 send_packet (h, &msg.header, NULL);
1753 * Request that the tunnel data rate is limited to the speed of the fastest
1754 * receiver. This is the default behavior.
1756 * @param tunnel Tunnel affected.
1759 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1761 struct GNUNET_MESH_TunnelMessage msg;
1762 struct GNUNET_MESH_Handle *h;
1765 tunnel->speed_min = GNUNET_NO;
1767 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1768 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1769 msg.tunnel_id = htonl (tunnel->tid);
1771 send_packet (h, &msg.header, NULL);
1775 * Turn on/off the buffering status of the tunnel.
1777 * @param tunnel Tunnel affected.
1778 * @param buffer GNUNET_YES to turn buffering on (default),
1779 * GNUNET_NO otherwise.
1782 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1784 struct GNUNET_MESH_TunnelMessage msg;
1785 struct GNUNET_MESH_Handle *h;
1788 tunnel->buffering = buffer;
1790 if (GNUNET_YES == buffer)
1791 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1793 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1794 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1795 msg.tunnel_id = htonl (tunnel->tid);
1797 send_packet (h, &msg.header, NULL);
1801 * Request that a peer should be added to the tunnel. The existing
1802 * connect handler will be called ONCE with either success or failure.
1803 * This function should NOT be called again with the same peer before the
1804 * connect handler is called.
1806 * @param tunnel handle to existing tunnel
1807 * @param peer peer to add
1810 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1811 const struct GNUNET_PeerIdentity *peer)
1813 struct GNUNET_MESH_PeerControl msg;
1814 GNUNET_PEER_Id peer_id;
1817 peer_id = GNUNET_PEER_intern (peer);
1818 for (i = 0; i < tunnel->npeers; i++)
1820 if (tunnel->peers[i]->id == peer_id)
1822 /* Peer already exists in tunnel */
1823 GNUNET_PEER_change_rc (peer_id, -1);
1828 if (NULL == add_peer_to_tunnel (tunnel, peer))
1831 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1832 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1833 msg.tunnel_id = htonl (tunnel->tid);
1835 send_packet (tunnel->mesh, &msg.header, tunnel);
1842 * Request that a peer should be removed from the tunnel. The existing
1843 * disconnect handler will be called ONCE if we were connected.
1845 * @param tunnel handle to existing tunnel
1846 * @param peer peer to remove
1849 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1850 const struct GNUNET_PeerIdentity *peer)
1852 struct GNUNET_MESH_PeerControl msg;
1853 GNUNET_PEER_Id peer_id;
1856 peer_id = GNUNET_PEER_search (peer);
1862 for (i = 0; i < tunnel->npeers; i++)
1863 if (tunnel->peers[i]->id == peer_id)
1865 if (i == tunnel->npeers)
1870 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1871 tunnel->disconnect_handler (tunnel->cls, peer);
1872 GNUNET_PEER_change_rc (peer_id, -1);
1873 GNUNET_free (tunnel->peers[i]);
1874 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1875 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1877 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1878 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1879 msg.tunnel_id = htonl (tunnel->tid);
1880 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1881 send_packet (tunnel->mesh, &msg.header, tunnel);
1886 * Request that the mesh should try to connect to a peer supporting the given
1889 * @param tunnel handle to existing tunnel
1890 * @param app_type application type that must be supported by the peer (MESH
1891 * should discover peer in proximity handling this type)
1894 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1895 GNUNET_MESH_ApplicationType app_type)
1897 struct GNUNET_MESH_ConnectPeerByType msg;
1899 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1901 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1902 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1903 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1904 msg.tunnel_id = htonl (tunnel->tid);
1905 msg.type = htonl (app_type);
1906 send_packet (tunnel->mesh, &msg.header, tunnel);
1911 * Request that the mesh should try to connect to a peer matching the
1912 * description given in the service string.
1914 * FIXME: allow multiple? how to deal with reconnect?
1916 * @param tunnel handle to existing tunnel
1917 * @param description string describing the destination node requirements
1920 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1921 const char *description)
1923 struct GNUNET_MESH_ConnectPeerByString *m;
1927 len = strlen (description);
1928 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1929 GNUNET_assert (UINT16_MAX > msgsize);
1931 char buffer[msgsize];
1933 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1934 m->header.size = htons (msgsize);
1935 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1936 m->tunnel_id = htonl (tunnel->tid);
1937 memcpy(&m[1], description, len);
1939 send_packet (tunnel->mesh, &m->header, tunnel);
1945 * Request that the given peer isn't added to this tunnel in calls to
1946 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1948 * @param tunnel handle to existing tunnel.
1949 * @param peer peer identity of the peer which should be blacklisted
1953 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1954 const struct GNUNET_PeerIdentity *peer)
1956 struct GNUNET_MESH_PeerControl msg;
1958 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1959 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1960 msg.tunnel_id = htonl (tunnel->tid);
1962 send_packet (tunnel->mesh, &msg.header, tunnel);
1969 * Request that the given peer isn't blacklisted anymore from this tunnel,
1970 * and therefore can be added in future calls to connect_by_*.
1971 * The peer must have been previously blacklisted for this tunnel.
1973 * @param tunnel handle to existing tunnel.
1974 * @param peer peer identity of the peer which shouldn't be blacklisted
1975 * for the tunnel anymore.
1978 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1979 const struct GNUNET_PeerIdentity *peer)
1981 struct GNUNET_MESH_PeerControl msg;
1983 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1984 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1985 msg.tunnel_id = htonl (tunnel->tid);
1987 send_packet (tunnel->mesh, &msg.header, tunnel);
1994 * Ask the mesh to call "notify" once it is ready to transmit the
1995 * given number of bytes to the specified tunnel or target.
1996 * Only one call can be active at any time, to issue another request,
1997 * wait for the callback or cancel the current request.
1999 * @param tunnel tunnel to use for transmission
2000 * @param cork is corking allowed for this transmission?
2001 * @param maxdelay how long can the message wait?
2002 * @param target destination for the message
2003 * NULL for multicast to all tunnel targets
2004 * @param notify_size how many bytes of buffer space does notify want?
2005 * @param notify function to call when buffer space is available;
2006 * will be called with NULL on timeout or if the overall queue
2007 * for this peer is larger than queue_size and this is currently
2008 * the message with the lowest priority
2009 * @param notify_cls closure for notify
2010 * @return non-NULL if the notify callback was queued,
2011 * NULL if we can not even queue the request (insufficient
2012 * memory); if NULL is returned, "notify" will NOT be called.
2014 struct GNUNET_MESH_TransmitHandle *
2015 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
2016 struct GNUNET_TIME_Relative maxdelay,
2017 const struct GNUNET_PeerIdentity *target,
2019 GNUNET_CONNECTION_TransmitReadyNotify notify,
2022 struct GNUNET_MESH_TransmitHandle *th;
2025 GNUNET_assert (NULL != tunnel);
2026 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY\n");
2027 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X\n", tunnel->tid);
2028 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2029 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
2030 else if (NULL != target)
2031 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
2033 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
2034 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
2035 GNUNET_assert (NULL != notify);
2036 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
2037 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
2038 th->tunnel = tunnel;
2039 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
2040 th->target = GNUNET_PEER_intern (target);
2041 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2042 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
2043 else if (NULL == target)
2044 overhead = sizeof (struct GNUNET_MESH_Multicast);
2046 overhead = sizeof (struct GNUNET_MESH_Unicast);
2047 tunnel->packet_size = th->size = notify_size + overhead;
2048 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
2049 th->notify = notify;
2050 th->notify_cls = notify_cls;
2051 add_to_queue (tunnel->mesh, th);
2052 if (NULL != tunnel->mesh->th)
2054 if (GNUNET_NO == PID_OVERFLOW(tunnel->next_send_pid, tunnel->max_send_pid) &&
2055 tunnel->max_send_pid <= tunnel->next_send_pid)
2057 LOG (GNUNET_ERROR_TYPE_DEBUG, " call notify tmt rdy\n");
2059 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
2060 GNUNET_TIME_UNIT_FOREVER_REL,
2061 GNUNET_YES, &send_callback,
2063 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY END\n");
2069 * Cancel the specified transmission-ready notification.
2071 * @param th handle that was returned by "notify_transmit_ready".
2074 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
2076 struct GNUNET_MESH_Handle *mesh;
2078 th->tunnel->packet_size = 0;
2079 mesh = th->tunnel->mesh;
2080 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
2081 GNUNET_SCHEDULER_cancel (th->timeout_task);
2082 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
2084 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
2086 /* queue empty, no point in asking for transmission */
2087 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
2094 * Transition API for tunnel ctx management
2097 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2103 * Transition API for tunnel ctx management
2106 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)