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 * Get the tunnel handler for the tunnel specified by id from the given handle
383 * @param h Mesh handle
384 * @param tid ID of the wanted tunnel
385 * @return handle to the required tunnel or NULL if not found
387 static struct GNUNET_MESH_Tunnel *
388 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
390 struct GNUNET_MESH_Tunnel *t;
404 * Create a new tunnel and insert it in the tunnel list of the mesh handle
405 * @param h Mesh handle
406 * @param tid desired tid of the tunnel, 0 to assign one automatically
407 * @return handle to the created tunnel
409 static struct GNUNET_MESH_Tunnel *
410 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
412 struct GNUNET_MESH_Tunnel *t;
414 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
415 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
419 t->tid = h->next_tid;
420 while (NULL != retrieve_tunnel (h, h->next_tid))
423 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
424 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
436 * Destroy the specified tunnel.
437 * - Destroys all peers, calling the disconnect callback on each if needed
438 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
439 * - Calls cleaner if tunnel was inbound
440 * - Frees all memory used
442 * @param t Pointer to the tunnel.
443 * @param call_cleaner Whether to call the cleaner handler.
445 * @return Handle to the required tunnel or NULL if not found.
448 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
450 struct GNUNET_MESH_Handle *h;
451 struct GNUNET_PeerIdentity pi;
452 struct GNUNET_MESH_TransmitHandle *th;
453 struct GNUNET_MESH_TransmitHandle *next;
456 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
465 /* disconnect all peers */
466 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
467 for (i = 0; i < t->npeers; i++)
469 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
471 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
472 t->disconnect_handler (t->cls, &pi);
474 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
475 GNUNET_free (t->peers[i]);
478 /* signal tunnel destruction */
479 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
480 h->cleaner (h->cls, t, t->ctx);
482 /* check that clients did not leave messages behind in the queue */
483 for (th = h->th_head; NULL != th; th = next)
488 /* Clients should have aborted their requests already.
489 * Management traffic should be ok, as clients can't cancel that */
490 GNUNET_break (GNUNET_NO == th_is_payload(th));
491 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
493 /* clean up request */
494 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
495 GNUNET_SCHEDULER_cancel (th->timeout_task);
499 /* if there are no more pending requests with mesh service, cancel active request */
500 /* Note: this should be unnecessary... */
501 if ( (NULL == h->th_head) && (NULL != h->th))
503 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
509 GNUNET_free (t->peers);
511 GNUNET_PEER_change_rc (t->owner, -1);
512 if (0 != t->napps && t->apps)
513 GNUNET_free (t->apps);
520 * Get the peer descriptor for the peer with id from the given tunnel
521 * @param t Tunnel handle
522 * @param id Short form ID of the wanted peer
523 * @return handle to the requested peer or NULL if not found
525 static struct GNUNET_MESH_Peer *
526 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
530 for (i = 0; i < t->npeers; i++)
531 if (t->peers[i]->id == id)
538 * Add a peer into a tunnel
539 * @param t Tunnel handle
540 * @param pi Full ID of the new peer
541 * @return handle to the newly created peer
543 static struct GNUNET_MESH_Peer *
544 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
545 const struct GNUNET_PeerIdentity *pi)
547 struct GNUNET_MESH_Peer *p;
555 id = GNUNET_PEER_intern (pi);
557 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
560 GNUNET_array_append (t->peers, t->npeers, p);
566 * Remove a peer from a tunnel
567 * @param p Peer handle
570 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
574 for (i = 0; i < p->t->npeers; i++)
576 if (p->t->peers[i] == p)
579 if (i == p->t->npeers)
584 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
585 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
590 * Notify client that the transmission has timed out
592 * @param tc task context
595 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
597 struct GNUNET_MESH_TransmitHandle *th = cls;
598 struct GNUNET_MESH_Handle *mesh;
600 mesh = th->tunnel->mesh;
601 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
602 if (GNUNET_YES == th_is_payload (th))
603 th->notify (th->notify_cls, 0, NULL);
605 if ((NULL == mesh->th_head) && (NULL != mesh->th))
607 /* queue empty, no point in asking for transmission */
608 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
615 * Add a transmit handle to the transmission queue by priority and set the
618 * @param h mesh handle with the queue head and tail
619 * @param th handle to the packet to be transmitted
622 add_to_queue (struct GNUNET_MESH_Handle *h,
623 struct GNUNET_MESH_TransmitHandle *th)
625 struct GNUNET_MESH_TransmitHandle *p;
634 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
635 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
638 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
639 (th->timeout), &timeout_transmission, th);
644 * Auxiliary function to send an already constructed packet to the service.
645 * Takes care of creating a new queue element, copying the message and
646 * calling the tmt_rdy function if necessary.
648 * @param h mesh handle
649 * @param msg message to transmit
650 * @param tunnel tunnel this send is related to (NULL if N/A)
653 send_packet (struct GNUNET_MESH_Handle *h,
654 const struct GNUNET_MessageHeader *msg,
655 struct GNUNET_MESH_Tunnel *tunnel);
659 * Reconnect callback: tries to reconnect again after a failer previous
661 * @param cls closure (mesh handle)
662 * @param tc task context
665 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
669 * Send a connect packet to the service with the applications and types
670 * requested by the user.
672 * @param h The mesh handle.
676 send_connect (struct GNUNET_MESH_Handle *h)
680 size = sizeof (struct GNUNET_MESH_ClientConnect);
681 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
682 size += h->n_handlers * sizeof (uint16_t);
684 char buf[size] GNUNET_ALIGN;
685 struct GNUNET_MESH_ClientConnect *msg;
686 GNUNET_MESH_ApplicationType *apps;
691 /* build connection packet */
692 msg = (struct GNUNET_MESH_ClientConnect *) buf;
693 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
694 msg->header.size = htons (size);
695 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
696 for (napps = 0; napps < h->n_applications; napps++)
698 apps[napps] = htonl (h->applications[napps]);
699 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
701 types = (uint16_t *) & apps[napps];
702 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
703 types[ntypes] = htons (h->message_handlers[ntypes].type);
704 msg->applications = htons (napps);
705 msg->types = htons (ntypes);
706 LOG (GNUNET_ERROR_TYPE_DEBUG,
707 "Sending %lu bytes long message %d types and %d apps\n",
708 ntohs (msg->header.size), ntypes, napps);
709 send_packet (h, &msg->header, NULL);
715 * Reconnect to the service, retransmit all infomation to try to restore the
718 * @param h handle to the mesh
720 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
723 do_reconnect (struct GNUNET_MESH_Handle *h)
725 struct GNUNET_MESH_Tunnel *t;
728 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
729 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
730 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
732 h->in_receive = GNUNET_NO;
736 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
739 if (NULL != h->client)
741 GNUNET_CLIENT_disconnect (h->client);
745 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
746 if (h->client == NULL)
748 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
751 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
752 GNUNET_TIME_relative_multiply
753 (h->reconnect_time, 2));
754 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
755 GNUNET_TIME_relative_to_string (h->reconnect_time));
761 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
764 /* Rebuild all tunnels */
765 for (t = h->tunnels_head; NULL != t; t = t->next)
767 struct GNUNET_MESH_TunnelMessage tmsg;
768 struct GNUNET_MESH_PeerControl pmsg;
770 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
772 /* Tunnel was created by service (incoming tunnel) */
773 /* TODO: Notify service of missing tunnel, to request
774 * creator to recreate path (find a path to him via DHT?)
778 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
779 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
780 tmsg.tunnel_id = htonl (t->tid);
781 send_packet (h, &tmsg.header, t);
783 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
784 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
785 pmsg.tunnel_id = htonl (t->tid);
787 /* Reconnect all peers */
788 /* If the tunnel was "by type", dont connect individual peers */
789 for (i = 0; i < t->npeers && 0 == t->napps; i++)
791 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
792 if (NULL != t->disconnect_handler && t->peers[i]->connected)
793 t->disconnect_handler (t->cls, &pmsg.peer);
794 send_packet (t->mesh, &pmsg.header, t);
796 /* Reconnect all types, if any */
797 for (i = 0; i < t->napps; i++)
799 struct GNUNET_MESH_ConnectPeerByType msg;
801 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
802 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
803 msg.tunnel_id = htonl (t->tid);
804 msg.type = htonl (t->apps[i]);
805 send_packet (t->mesh, &msg.header, t);
807 if (GNUNET_NO == t->buffering)
808 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
809 if (GNUNET_YES == t->speed_min)
810 GNUNET_MESH_tunnel_speed_min (t);
816 * Reconnect callback: tries to reconnect again after a failer previous
818 * @param cls closure (mesh handle)
819 * @param tc task context
822 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
824 struct GNUNET_MESH_Handle *h = cls;
826 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
827 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
834 * Reconnect to the service, retransmit all infomation to try to restore the
837 * @param h handle to the mesh
839 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
842 reconnect (struct GNUNET_MESH_Handle *h)
844 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
845 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
846 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
851 /******************************************************************************/
852 /*********************** RECEIVE HANDLERS ****************************/
853 /******************************************************************************/
856 * Process the new tunnel notification and add it to the tunnels in the handle
858 * @param h The mesh handle
859 * @param msg A message with the details of the new incoming tunnel
862 process_tunnel_created (struct GNUNET_MESH_Handle *h,
863 const struct GNUNET_MESH_TunnelNotification *msg)
865 struct GNUNET_MESH_Tunnel *t;
866 MESH_TunnelNumber tid;
868 tid = ntohl (msg->tunnel_id);
869 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
874 if (NULL != h->new_tunnel)
876 struct GNUNET_ATS_Information atsi;
878 t = create_tunnel (h, tid);
879 t->owner = GNUNET_PEER_intern (&msg->peer);
881 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
882 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
884 t->peers[0]->connected = 1;
885 t->peers[0]->id = t->owner;
886 GNUNET_PEER_change_rc (t->owner, 1);
891 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
892 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
896 struct GNUNET_MESH_TunnelMessage d_msg;
898 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
900 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
901 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
902 d_msg.tunnel_id = msg->tunnel_id;
904 send_packet (h, &d_msg.header, NULL);
911 * Process the tunnel destroy notification and free associated resources
913 * @param h The mesh handle
914 * @param msg A message with the details of the tunnel being destroyed
917 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
918 const struct GNUNET_MESH_TunnelMessage *msg)
920 struct GNUNET_MESH_Tunnel *t;
921 MESH_TunnelNumber tid;
923 tid = ntohl (msg->tunnel_id);
924 t = retrieve_tunnel (h, tid);
934 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
935 destroy_tunnel (t, GNUNET_YES);
941 * Process the new peer event and notify the upper level of it
943 * @param h The mesh handle
944 * @param msg A message with the details of the peer event
947 process_peer_event (struct GNUNET_MESH_Handle *h,
948 const struct GNUNET_MESH_PeerControl *msg)
950 struct GNUNET_MESH_Tunnel *t;
951 struct GNUNET_MESH_Peer *p;
952 struct GNUNET_ATS_Information atsi;
956 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
957 size = ntohs (msg->header.size);
958 if (size != sizeof (struct GNUNET_MESH_PeerControl))
963 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
969 id = GNUNET_PEER_search (&msg->peer);
970 if ((p = retrieve_peer (t, id)) == NULL)
971 p = add_peer_to_tunnel (t, &msg->peer);
972 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
974 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
975 if (NULL != t->connect_handler)
979 t->connect_handler (t->cls, &msg->peer, &atsi);
985 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
986 if (NULL != t->disconnect_handler && p->connected)
988 t->disconnect_handler (t->cls, &msg->peer);
990 remove_peer_from_tunnel (p);
993 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
998 * Process the incoming data packets
1000 * @param h The mesh handle
1001 * @param message A message encapsulating the data
1003 * @return GNUNET_YES if everything went fine
1004 * GNUNET_NO if client closed connection (h no longer valid)
1007 process_incoming_data (struct GNUNET_MESH_Handle *h,
1008 const struct GNUNET_MessageHeader *message)
1010 const struct GNUNET_MessageHeader *payload;
1011 const struct GNUNET_MESH_MessageHandler *handler;
1012 const struct GNUNET_PeerIdentity *peer;
1013 struct GNUNET_MESH_Unicast *ucast;
1014 struct GNUNET_MESH_Multicast *mcast;
1015 struct GNUNET_MESH_ToOrigin *to_orig;
1016 struct GNUNET_MESH_Tunnel *t;
1020 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1021 type = ntohs (message->type);
1024 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1025 ucast = (struct GNUNET_MESH_Unicast *) message;
1027 t = retrieve_tunnel (h, ntohl (ucast->tid));
1028 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1030 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1031 GNUNET_i2s (peer), ntohl (ucast->tid));
1033 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1034 mcast = (struct GNUNET_MESH_Multicast *) message;
1035 t = retrieve_tunnel (h, ntohl (mcast->tid));
1036 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1038 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1039 GNUNET_i2s (peer), ntohl (mcast->tid));
1041 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1042 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1043 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1044 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1045 peer = &to_orig->sender;
1046 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1047 GNUNET_i2s (peer), ntohl (to_orig->tid));
1055 /* Tunnel was ignored, probably service didn't get it yet */
1058 type = ntohs (payload->type);
1059 for (i = 0; i < h->n_handlers; i++)
1061 handler = &h->message_handlers[i];
1062 if (handler->type == type)
1064 struct GNUNET_ATS_Information atsi;
1069 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1071 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1072 GNUNET_MESH_disconnect (h);
1077 LOG (GNUNET_ERROR_TYPE_DEBUG,
1078 "callback completed successfully\n");
1087 * Process a local ACK message, enabling the client to send
1088 * more data to the service.
1090 * @param h Mesh handle.
1091 * @param message Message itself.
1094 process_ack (struct GNUNET_MESH_Handle *h,
1095 const struct GNUNET_MessageHeader *message)
1097 struct GNUNET_MESH_LocalAck *msg;
1098 struct GNUNET_MESH_Tunnel *t;
1101 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1102 msg = (struct GNUNET_MESH_LocalAck *) message;
1104 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1108 LOG (GNUNET_ERROR_TYPE_WARNING,
1109 "ACK on unknown tunnel %X\n",
1110 ntohl (msg->tunnel_id));
1113 ack = ntohl (msg->max_pid);
1114 if (ack > t->max_pid || PID_OVERFLOW (t->max_pid, ack))
1116 if (NULL == h->th && 0 < t->packet_size)
1118 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1119 GNUNET_TIME_UNIT_FOREVER_REL,
1120 GNUNET_YES, &send_callback, h);
1125 * Function to process all messages received from the service
1127 * @param cls closure
1128 * @param msg message received, NULL on timeout or fatal error
1131 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1133 struct GNUNET_MESH_Handle *h = cls;
1137 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL msg\n");
1141 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %hu from MESH\n",
1143 switch (ntohs (msg->type))
1145 /* Notify of a new incoming tunnel */
1146 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1147 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1149 /* Notify of a tunnel disconnection */
1150 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1151 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1153 /* Notify of a new peer or a peer disconnect in the tunnel */
1154 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1155 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1156 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1158 /* Notify of a new data packet in the tunnel */
1159 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1160 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1161 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1162 if (GNUNET_NO == process_incoming_data (h, msg))
1165 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1166 process_ack (h, msg);
1169 /* We shouldn't get any other packages, log and ignore */
1170 LOG (GNUNET_ERROR_TYPE_WARNING,
1171 "unsolicited message form service (type %d)\n",
1174 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1175 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1176 GNUNET_TIME_UNIT_FOREVER_REL);
1180 /******************************************************************************/
1181 /************************ SEND FUNCTIONS ****************************/
1182 /******************************************************************************/
1185 * Function called to send a message to the service.
1186 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1189 * @param cls closure, the mesh handle
1190 * @param size number of bytes available in buf
1191 * @param buf where the callee should write the connect message
1192 * @return number of bytes written to buf
1195 send_callback (void *cls, size_t size, void *buf)
1197 struct GNUNET_MESH_Handle *h = cls;
1198 struct GNUNET_MESH_TransmitHandle *th;
1199 struct GNUNET_MESH_TransmitHandle *next;
1200 struct GNUNET_MESH_Tunnel *t;
1205 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1206 if ((0 == size) || (NULL == buf))
1208 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback\n");
1215 while ((NULL != (th = next)) && (size >= th->size))
1218 if (GNUNET_YES == th_is_payload (th))
1220 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1221 if (t->max_pid < t->pid && ! PID_OVERFLOW (t->pid, t->max_pid)) {
1222 /* This tunnel is not ready to transmit yet, try next message */
1227 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1229 /* traffic to origin */
1230 struct GNUNET_MESH_ToOrigin to;
1231 struct GNUNET_MessageHeader *mh;
1233 GNUNET_assert (size >= th->size);
1234 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1235 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1236 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %u\n",
1240 psize += sizeof (to);
1241 GNUNET_assert (size >= psize);
1242 to.header.size = htons (psize);
1243 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1244 to.tid = htonl (t->tid);
1246 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1247 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1248 memcpy (cbuf, &to, sizeof (to));
1251 else if (th->target == 0)
1254 struct GNUNET_MESH_Multicast mc;
1255 struct GNUNET_MessageHeader *mh;
1257 GNUNET_assert (size >= th->size);
1258 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1259 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1260 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %u\n",
1264 psize += sizeof (mc);
1265 GNUNET_assert (size >= psize);
1266 mc.header.size = htons (psize);
1267 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1268 mc.tid = htonl (t->tid);
1269 mc.pid = htonl (t->pid);
1271 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1272 memcpy (cbuf, &mc, sizeof (mc));
1278 struct GNUNET_MESH_Unicast uc;
1279 struct GNUNET_MessageHeader *mh;
1281 GNUNET_assert (size >= th->size);
1282 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1283 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1284 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %u\n",
1288 psize += sizeof (uc);
1289 GNUNET_assert (size >= psize);
1290 uc.header.size = htons (psize);
1291 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1292 uc.tid = htonl (t->tid);
1293 uc.pid = htonl (t->pid);
1294 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1295 GNUNET_PEER_resolve (th->target, &uc.destination);
1296 memcpy (cbuf, &uc, sizeof (uc));
1303 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1305 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %u\n",
1307 memcpy (cbuf, &th[1], th->size);
1310 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1311 GNUNET_SCHEDULER_cancel (th->timeout_task);
1312 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1319 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1321 if (NULL != h->th_head)
1323 int request = GNUNET_NO;
1325 LOG (GNUNET_ERROR_TYPE_DEBUG, " head not empty\n");
1326 for (th = h->th_head; NULL != th; th = th->next)
1328 struct GNUNET_MESH_Tunnel *t = th->tunnel;
1330 LOG (GNUNET_ERROR_TYPE_DEBUG, " [%p] notify: %p, size %u\n",
1331 th, th->notify, th->size);
1332 GNUNET_assert (NULL != t);
1333 LOG (GNUNET_ERROR_TYPE_DEBUG, " pid %u, max %u\n", t->pid, t->max_pid);
1335 if (GNUNET_NO == th_is_payload (th) ||
1336 (t->max_pid >= t->pid || PID_OVERFLOW (t->pid, t->max_pid)))
1338 request = GNUNET_YES;
1343 if (GNUNET_YES == request)
1345 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", th->size);
1347 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1348 GNUNET_TIME_UNIT_FOREVER_REL,
1349 GNUNET_YES, &send_callback, h);
1353 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1356 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1357 if (GNUNET_NO == h->in_receive)
1359 h->in_receive = GNUNET_YES;
1360 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1361 GNUNET_TIME_UNIT_FOREVER_REL);
1368 * Auxiliary function to send an already constructed packet to the service.
1369 * Takes care of creating a new queue element, copying the message and
1370 * calling the tmt_rdy function if necessary.
1372 * @param h mesh handle
1373 * @param msg message to transmit
1374 * @param tunnel tunnel this send is related to (NULL if N/A)
1377 send_packet (struct GNUNET_MESH_Handle *h,
1378 const struct GNUNET_MessageHeader *msg,
1379 struct GNUNET_MESH_Tunnel *tunnel)
1381 struct GNUNET_MESH_TransmitHandle *th;
1384 msize = ntohs (msg->size);
1385 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1386 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1388 th->tunnel = tunnel;
1389 memcpy (&th[1], msg, msize);
1390 add_to_queue (h, th);
1394 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1395 GNUNET_TIME_UNIT_FOREVER_REL,
1396 GNUNET_YES, &send_callback, h);
1400 /******************************************************************************/
1401 /********************** API CALL DEFINITIONS *************************/
1402 /******************************************************************************/
1405 * Connect to the mesh service.
1407 * @param cfg configuration to use
1408 * @param cls closure for the various callbacks that follow
1409 * (including handlers in the handlers array)
1410 * @param new_tunnel function called when an *inbound* tunnel is created
1411 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1412 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1413 * is called on the tunnel
1414 * @param handlers callbacks for messages we care about, NULL-terminated
1415 * note that the mesh is allowed to drop notifications about
1416 * inbound messages if the client does not process them fast
1417 * enough (for this notification type, a bounded queue is used)
1418 * @param stypes list of the applications that this client claims to provide
1419 * @return handle to the mesh service NULL on error
1420 * (in this case, init is never called)
1422 struct GNUNET_MESH_Handle *
1423 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1424 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1425 GNUNET_MESH_TunnelEndHandler cleaner,
1426 const struct GNUNET_MESH_MessageHandler *handlers,
1427 const GNUNET_MESH_ApplicationType *stypes)
1429 struct GNUNET_MESH_Handle *h;
1431 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1432 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1434 h->new_tunnel = new_tunnel;
1435 h->cleaner = cleaner;
1436 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1437 if (h->client == NULL)
1445 h->applications = stypes;
1446 h->message_handlers = handlers;
1447 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1448 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1449 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1451 /* count handlers and apps, calculate size */
1452 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1453 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1455 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1461 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1462 * disconnect callbacks will be called on any still connected peers, notifying
1463 * about their disconnection. The registered inbound tunnel cleaner will be
1464 * called should any inbound tunnels still exist.
1466 * @param handle connection to mesh to disconnect
1469 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1471 struct GNUNET_MESH_Tunnel *t;
1472 struct GNUNET_MESH_Tunnel *aux;
1473 struct GNUNET_MESH_TransmitHandle *th;
1475 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1477 t = handle->tunnels_head;
1481 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1484 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1486 destroy_tunnel (t, GNUNET_YES);
1489 while ( (th = handle->th_head) != NULL)
1491 struct GNUNET_MessageHeader *msg;
1493 /* Make sure it is an allowed packet (everything else should have been
1494 * already canceled).
1496 GNUNET_break (GNUNET_NO == th_is_payload (th));
1497 msg = (struct GNUNET_MessageHeader *) &th[1];
1498 switch (ntohs(msg->type))
1500 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1501 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1505 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1509 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1513 if (NULL != handle->th)
1515 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1518 if (NULL != handle->client)
1520 GNUNET_CLIENT_disconnect (handle->client);
1521 handle->client = NULL;
1523 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1525 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1526 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1528 GNUNET_free (handle);
1533 * Announce to ther peer the availability of services described by the regex,
1534 * in order to be reachable to other peers via connect_by_string.
1536 * Note that the first 8 characters are considered to be part of a prefix,
1537 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1538 * all matching strings will be stored in the DHT.
1540 * @param h handle to mesh.
1541 * @param regex string with the regular expression describing local services.
1544 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1547 struct GNUNET_MessageHeader *msg;
1551 len = strlen (regex);
1552 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1553 GNUNET_assert (UINT16_MAX > msgsize);
1556 char buffer[msgsize];
1558 msg = (struct GNUNET_MessageHeader *) buffer;
1559 msg->size = htons (msgsize);
1560 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1561 memcpy (&msg[1], regex, len);
1563 send_packet(h, msg, NULL);
1568 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1569 * and to broadcast).
1571 * @param h mesh handle
1572 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1573 * @param connect_handler function to call when peers are actually connected
1574 * @param disconnect_handler function to call when peers are disconnected
1575 * @param handler_cls closure for connect/disconnect handlers
1577 struct GNUNET_MESH_Tunnel *
1578 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1579 GNUNET_MESH_PeerConnectHandler connect_handler,
1580 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1583 struct GNUNET_MESH_Tunnel *t;
1584 struct GNUNET_MESH_TunnelMessage msg;
1586 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1587 t = create_tunnel (h, 0);
1588 t->connect_handler = connect_handler;
1589 t->disconnect_handler = disconnect_handler;
1590 t->cls = handler_cls;
1591 t->ctx = tunnel_ctx;
1592 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1593 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1594 msg.tunnel_id = htonl (t->tid);
1595 send_packet (h, &msg.header, t);
1601 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1604 * @param tunnel tunnel handle
1607 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1609 struct GNUNET_MESH_Handle *h;
1610 struct GNUNET_MESH_TunnelMessage msg;
1611 struct GNUNET_MESH_TransmitHandle *th;
1613 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1616 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1617 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1618 msg.tunnel_id = htonl (tunnel->tid);
1622 struct GNUNET_MESH_TransmitHandle *aux;
1623 if (th->tunnel == tunnel)
1626 /* FIXME call the handler? */
1627 if (GNUNET_YES == th_is_payload (th))
1628 th->notify (th->notify_cls, 0, NULL);
1629 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1637 destroy_tunnel (tunnel, GNUNET_NO);
1638 send_packet (h, &msg.header, NULL);
1642 * Request that the tunnel data rate is limited to the speed of the slowest
1645 * @param tunnel Tunnel affected.
1648 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1650 struct GNUNET_MESH_TunnelMessage msg;
1651 struct GNUNET_MESH_Handle *h;
1654 tunnel->speed_min = GNUNET_YES;
1656 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1657 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1658 msg.tunnel_id = htonl (tunnel->tid);
1660 send_packet (h, &msg.header, NULL);
1665 * Request that the tunnel data rate is limited to the speed of the fastest
1666 * receiver. This is the default behavior.
1668 * @param tunnel Tunnel affected.
1671 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1673 struct GNUNET_MESH_TunnelMessage msg;
1674 struct GNUNET_MESH_Handle *h;
1677 tunnel->speed_min = GNUNET_NO;
1679 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1680 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1681 msg.tunnel_id = htonl (tunnel->tid);
1683 send_packet (h, &msg.header, NULL);
1687 * Turn on/off the buffering status of the tunnel.
1689 * @param tunnel Tunnel affected.
1690 * @param buffer GNUNET_YES to turn buffering on (default),
1691 * GNUNET_NO otherwise.
1694 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1696 struct GNUNET_MESH_TunnelMessage msg;
1697 struct GNUNET_MESH_Handle *h;
1700 tunnel->buffering = buffer;
1702 if (GNUNET_YES == buffer)
1703 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1705 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1706 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1707 msg.tunnel_id = htonl (tunnel->tid);
1709 send_packet (h, &msg.header, NULL);
1713 * Request that a peer should be added to the tunnel. The existing
1714 * connect handler will be called ONCE with either success or failure.
1715 * This function should NOT be called again with the same peer before the
1716 * connect handler is called.
1718 * @param tunnel handle to existing tunnel
1719 * @param peer peer to add
1722 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1723 const struct GNUNET_PeerIdentity *peer)
1725 struct GNUNET_MESH_PeerControl msg;
1726 GNUNET_PEER_Id peer_id;
1729 peer_id = GNUNET_PEER_intern (peer);
1730 for (i = 0; i < tunnel->npeers; i++)
1732 if (tunnel->peers[i]->id == peer_id)
1734 /* Peer already exists in tunnel */
1735 GNUNET_PEER_change_rc (peer_id, -1);
1740 if (NULL == add_peer_to_tunnel (tunnel, peer))
1743 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1744 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1745 msg.tunnel_id = htonl (tunnel->tid);
1747 send_packet (tunnel->mesh, &msg.header, tunnel);
1754 * Request that a peer should be removed from the tunnel. The existing
1755 * disconnect handler will be called ONCE if we were connected.
1757 * @param tunnel handle to existing tunnel
1758 * @param peer peer to remove
1761 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1762 const struct GNUNET_PeerIdentity *peer)
1764 struct GNUNET_MESH_PeerControl msg;
1765 GNUNET_PEER_Id peer_id;
1768 peer_id = GNUNET_PEER_search (peer);
1774 for (i = 0; i < tunnel->npeers; i++)
1775 if (tunnel->peers[i]->id == peer_id)
1777 if (i == tunnel->npeers)
1782 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1783 tunnel->disconnect_handler (tunnel->cls, peer);
1784 GNUNET_PEER_change_rc (peer_id, -1);
1785 GNUNET_free (tunnel->peers[i]);
1786 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1787 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1789 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1790 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1791 msg.tunnel_id = htonl (tunnel->tid);
1792 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1793 send_packet (tunnel->mesh, &msg.header, tunnel);
1798 * Request that the mesh should try to connect to a peer supporting the given
1801 * @param tunnel handle to existing tunnel
1802 * @param app_type application type that must be supported by the peer (MESH
1803 * should discover peer in proximity handling this type)
1806 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1807 GNUNET_MESH_ApplicationType app_type)
1809 struct GNUNET_MESH_ConnectPeerByType msg;
1811 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1813 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1814 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1815 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1816 msg.tunnel_id = htonl (tunnel->tid);
1817 msg.type = htonl (app_type);
1818 send_packet (tunnel->mesh, &msg.header, tunnel);
1823 * Request that the mesh should try to connect to a peer matching the
1824 * description given in the service string.
1826 * FIXME: allow multiple? how to deal with reconnect?
1828 * @param tunnel handle to existing tunnel
1829 * @param description string describing the destination node requirements
1832 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1833 const char *description)
1835 struct GNUNET_MESH_ConnectPeerByString *m;
1839 len = strlen (description);
1840 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1841 GNUNET_assert (UINT16_MAX > msgsize);
1843 char buffer[msgsize];
1845 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1846 m->header.size = htons (msgsize);
1847 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1848 m->tunnel_id = htonl (tunnel->tid);
1849 memcpy(&m[1], description, len);
1851 send_packet (tunnel->mesh, &m->header, tunnel);
1857 * Request that the given peer isn't added to this tunnel in calls to
1858 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1860 * @param tunnel handle to existing tunnel.
1861 * @param peer peer identity of the peer which should be blacklisted
1865 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1866 const struct GNUNET_PeerIdentity *peer)
1868 struct GNUNET_MESH_PeerControl msg;
1870 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1871 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1872 msg.tunnel_id = htonl (tunnel->tid);
1874 send_packet (tunnel->mesh, &msg.header, tunnel);
1881 * Request that the given peer isn't blacklisted anymore from this tunnel,
1882 * and therefore can be added in future calls to connect_by_*.
1883 * The peer must have been previously blacklisted for this tunnel.
1885 * @param tunnel handle to existing tunnel.
1886 * @param peer peer identity of the peer which shouldn't be blacklisted
1887 * for the tunnel anymore.
1890 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1891 const struct GNUNET_PeerIdentity *peer)
1893 struct GNUNET_MESH_PeerControl msg;
1895 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1896 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1897 msg.tunnel_id = htonl (tunnel->tid);
1899 send_packet (tunnel->mesh, &msg.header, tunnel);
1906 * Ask the mesh to call "notify" once it is ready to transmit the
1907 * given number of bytes to the specified tunnel or target.
1908 * Only one call can be active at any time, to issue another request,
1909 * wait for the callback or cancel the current request.
1911 * @param tunnel tunnel to use for transmission
1912 * @param cork is corking allowed for this transmission?
1913 * @param maxdelay how long can the message wait?
1914 * @param target destination for the message
1915 * NULL for multicast to all tunnel targets
1916 * @param notify_size how many bytes of buffer space does notify want?
1917 * @param notify function to call when buffer space is available;
1918 * will be called with NULL on timeout or if the overall queue
1919 * for this peer is larger than queue_size and this is currently
1920 * the message with the lowest priority
1921 * @param notify_cls closure for notify
1922 * @return non-NULL if the notify callback was queued,
1923 * NULL if we can not even queue the request (insufficient
1924 * memory); if NULL is returned, "notify" will NOT be called.
1926 struct GNUNET_MESH_TransmitHandle *
1927 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1928 struct GNUNET_TIME_Relative maxdelay,
1929 const struct GNUNET_PeerIdentity *target,
1931 GNUNET_CONNECTION_TransmitReadyNotify notify,
1934 struct GNUNET_MESH_TransmitHandle *th;
1937 GNUNET_assert (NULL != tunnel);
1938 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1940 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1942 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1943 GNUNET_assert (NULL != notify);
1944 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1945 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1946 th->tunnel = tunnel;
1947 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1948 th->target = GNUNET_PEER_intern (target);
1949 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1950 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1951 else if (NULL == target)
1952 overhead = sizeof (struct GNUNET_MESH_Multicast);
1954 overhead = sizeof (struct GNUNET_MESH_Unicast);
1955 tunnel->packet_size = th->size = notify_size + overhead;
1956 th->notify = notify;
1957 th->notify_cls = notify_cls;
1958 add_to_queue (tunnel->mesh, th);
1959 if (NULL != tunnel->mesh->th)
1962 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1963 GNUNET_TIME_UNIT_FOREVER_REL,
1964 GNUNET_YES, &send_callback,
1971 * Cancel the specified transmission-ready notification.
1973 * @param th handle that was returned by "notify_transmit_ready".
1976 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1978 struct GNUNET_MESH_Handle *mesh;
1980 mesh = th->tunnel->mesh;
1981 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1982 GNUNET_SCHEDULER_cancel (th->timeout_task);
1983 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1985 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1987 /* queue empty, no point in asking for transmission */
1988 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1995 * Transition API for tunnel ctx management
1998 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2004 * Transition API for tunnel ctx management
2007 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)