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) ||
392 GNUNET_NO == GMC_is_pid_bigger(t->next_send_pid, t->max_send_pid))
400 * Get the tunnel handler for the tunnel specified by id from the given handle
401 * @param h Mesh handle
402 * @param tid ID of the wanted tunnel
403 * @return handle to the required tunnel or NULL if not found
405 static struct GNUNET_MESH_Tunnel *
406 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
408 struct GNUNET_MESH_Tunnel *t;
422 * Create a new tunnel and insert it in the tunnel list of the mesh handle
423 * @param h Mesh handle
424 * @param tid desired tid of the tunnel, 0 to assign one automatically
425 * @return handle to the created tunnel
427 static struct GNUNET_MESH_Tunnel *
428 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
430 struct GNUNET_MESH_Tunnel *t;
432 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
433 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
437 t->tid = h->next_tid;
438 while (NULL != retrieve_tunnel (h, h->next_tid))
441 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
442 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
455 * Destroy the specified tunnel.
456 * - Destroys all peers, calling the disconnect callback on each if needed
457 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
458 * - Calls cleaner if tunnel was inbound
459 * - Frees all memory used
461 * @param t Pointer to the tunnel.
462 * @param call_cleaner Whether to call the cleaner handler.
464 * @return Handle to the required tunnel or NULL if not found.
467 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
469 struct GNUNET_MESH_Handle *h;
470 struct GNUNET_PeerIdentity pi;
471 struct GNUNET_MESH_TransmitHandle *th;
472 struct GNUNET_MESH_TransmitHandle *next;
475 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
484 /* disconnect all peers */
485 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
486 for (i = 0; i < t->npeers; i++)
488 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
490 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
491 t->disconnect_handler (t->cls, &pi);
493 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
494 GNUNET_free (t->peers[i]);
497 /* signal tunnel destruction */
498 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
499 h->cleaner (h->cls, t, t->ctx);
501 /* check that clients did not leave messages behind in the queue */
502 for (th = h->th_head; NULL != th; th = next)
507 /* Clients should have aborted their requests already.
508 * Management traffic should be ok, as clients can't cancel that */
509 GNUNET_break (GNUNET_NO == th_is_payload(th));
510 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
512 /* clean up request */
513 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
514 GNUNET_SCHEDULER_cancel (th->timeout_task);
518 /* if there are no more pending requests with mesh service, cancel active request */
519 /* Note: this should be unnecessary... */
520 if ((0 == message_ready_size (h)) && (NULL != h->th))
522 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
528 GNUNET_free (t->peers);
530 GNUNET_PEER_change_rc (t->owner, -1);
531 if (0 != t->napps && t->apps)
532 GNUNET_free (t->apps);
539 * Get the peer descriptor for the peer with id from the given tunnel
540 * @param t Tunnel handle
541 * @param id Short form ID of the wanted peer
542 * @return handle to the requested peer or NULL if not found
544 static struct GNUNET_MESH_Peer *
545 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
549 for (i = 0; i < t->npeers; i++)
550 if (t->peers[i]->id == id)
557 * Add a peer into a tunnel
558 * @param t Tunnel handle
559 * @param pi Full ID of the new peer
560 * @return handle to the newly created peer
562 static struct GNUNET_MESH_Peer *
563 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
564 const struct GNUNET_PeerIdentity *pi)
566 struct GNUNET_MESH_Peer *p;
574 id = GNUNET_PEER_intern (pi);
576 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
579 GNUNET_array_append (t->peers, t->npeers, p);
585 * Remove a peer from a tunnel
586 * @param p Peer handle
589 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
593 for (i = 0; i < p->t->npeers; i++)
595 if (p->t->peers[i] == p)
598 if (i == p->t->npeers)
603 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
604 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
609 * Notify client that the transmission has timed out
612 * @param tc task context
615 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
617 struct GNUNET_MESH_TransmitHandle *th = cls;
618 struct GNUNET_MESH_Handle *mesh;
620 mesh = th->tunnel->mesh;
621 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
622 th->tunnel->packet_size = 0;
623 if (GNUNET_YES == th_is_payload (th))
624 th->notify (th->notify_cls, 0, NULL);
626 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
628 /* nothing ready to transmit, no point in asking for transmission */
629 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
636 * Add a transmit handle to the transmission queue by priority and set the
639 * @param h mesh handle with the queue head and tail
640 * @param th handle to the packet to be transmitted
643 add_to_queue (struct GNUNET_MESH_Handle *h,
644 struct GNUNET_MESH_TransmitHandle *th)
646 struct GNUNET_MESH_TransmitHandle *p;
655 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
656 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
659 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
660 (th->timeout), &timeout_transmission, th);
665 * Auxiliary function to send an already constructed packet to the service.
666 * Takes care of creating a new queue element, copying the message and
667 * calling the tmt_rdy function if necessary.
669 * @param h mesh handle
670 * @param msg message to transmit
671 * @param tunnel tunnel this send is related to (NULL if N/A)
674 send_packet (struct GNUNET_MESH_Handle *h,
675 const struct GNUNET_MessageHeader *msg,
676 struct GNUNET_MESH_Tunnel *tunnel);
680 * Send an ack on the tunnel to confirm the processing of a message.
682 * @param h Mesh handle.
683 * @param t Tunnel on which to send the ACK.
686 send_ack (struct GNUNET_MESH_Handle *h, struct GNUNET_MESH_Tunnel *t)
688 struct GNUNET_MESH_LocalAck msg;
690 LOG (GNUNET_ERROR_TYPE_DEBUG,
691 "Sending ACK on tunnel %X: %u\n",
692 t->tid, t->last_recv_pid + 1);
693 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
694 msg.header.size = htons (sizeof (msg));
695 msg.tunnel_id = htonl (t->tid);
696 msg.max_pid = t->last_recv_pid + 1;
698 send_packet (h, &msg.header, t);
705 * Reconnect callback: tries to reconnect again after a failer previous
707 * @param cls closure (mesh handle)
708 * @param tc task context
711 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
715 * Send a connect packet to the service with the applications and types
716 * requested by the user.
718 * @param h The mesh handle.
722 send_connect (struct GNUNET_MESH_Handle *h)
726 size = sizeof (struct GNUNET_MESH_ClientConnect);
727 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
728 size += h->n_handlers * sizeof (uint16_t);
730 char buf[size] GNUNET_ALIGN;
731 struct GNUNET_MESH_ClientConnect *msg;
732 GNUNET_MESH_ApplicationType *apps;
737 /* build connection packet */
738 msg = (struct GNUNET_MESH_ClientConnect *) buf;
739 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
740 msg->header.size = htons (size);
741 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
742 for (napps = 0; napps < h->n_applications; napps++)
744 apps[napps] = htonl (h->applications[napps]);
745 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
747 types = (uint16_t *) & apps[napps];
748 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
749 types[ntypes] = htons (h->message_handlers[ntypes].type);
750 msg->applications = htons (napps);
751 msg->types = htons (ntypes);
752 LOG (GNUNET_ERROR_TYPE_DEBUG,
753 "Sending %lu bytes long message %d types and %d apps\n",
754 ntohs (msg->header.size), ntypes, napps);
755 send_packet (h, &msg->header, NULL);
761 * Reconnect to the service, retransmit all infomation to try to restore the
764 * @param h handle to the mesh
766 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
769 do_reconnect (struct GNUNET_MESH_Handle *h)
771 struct GNUNET_MESH_Tunnel *t;
774 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
775 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
776 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
777 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
778 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
783 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
786 if (NULL != h->client)
788 GNUNET_CLIENT_disconnect (h->client);
792 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
793 if (h->client == NULL)
795 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
798 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
799 GNUNET_TIME_relative_multiply
800 (h->reconnect_time, 2));
801 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
802 GNUNET_TIME_relative_to_string (h->reconnect_time));
808 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
811 /* Rebuild all tunnels */
812 for (t = h->tunnels_head; NULL != t; t = t->next)
814 struct GNUNET_MESH_TunnelMessage tmsg;
815 struct GNUNET_MESH_PeerControl pmsg;
817 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
819 /* Tunnel was created by service (incoming tunnel) */
820 /* TODO: Notify service of missing tunnel, to request
821 * creator to recreate path (find a path to him via DHT?)
825 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
826 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
827 tmsg.tunnel_id = htonl (t->tid);
828 send_packet (h, &tmsg.header, t);
830 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
831 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
832 pmsg.tunnel_id = htonl (t->tid);
834 /* Reconnect all peers */
835 /* If the tunnel was "by type", dont connect individual peers */
836 for (i = 0; i < t->npeers && 0 == t->napps; i++)
838 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
839 if (NULL != t->disconnect_handler && t->peers[i]->connected)
840 t->disconnect_handler (t->cls, &pmsg.peer);
841 send_packet (t->mesh, &pmsg.header, t);
843 /* Reconnect all types, if any */
844 for (i = 0; i < t->napps; i++)
846 struct GNUNET_MESH_ConnectPeerByType msg;
848 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
849 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
850 msg.tunnel_id = htonl (t->tid);
851 msg.type = htonl (t->apps[i]);
852 send_packet (t->mesh, &msg.header, t);
854 if (GNUNET_NO == t->buffering)
855 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
856 if (GNUNET_YES == t->speed_min)
857 GNUNET_MESH_tunnel_speed_min (t);
863 * Reconnect callback: tries to reconnect again after a failer previous
865 * @param cls closure (mesh handle)
866 * @param tc task context
869 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
871 struct GNUNET_MESH_Handle *h = cls;
873 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
874 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
881 * Reconnect to the service, retransmit all infomation to try to restore the
884 * @param h handle to the mesh
886 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
889 reconnect (struct GNUNET_MESH_Handle *h)
891 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
892 h->in_receive = GNUNET_NO;
893 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
894 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
899 /******************************************************************************/
900 /*********************** RECEIVE HANDLERS ****************************/
901 /******************************************************************************/
904 * Process the new tunnel notification and add it to the tunnels in the handle
906 * @param h The mesh handle
907 * @param msg A message with the details of the new incoming tunnel
910 process_tunnel_created (struct GNUNET_MESH_Handle *h,
911 const struct GNUNET_MESH_TunnelNotification *msg)
913 struct GNUNET_MESH_Tunnel *t;
914 MESH_TunnelNumber tid;
916 tid = ntohl (msg->tunnel_id);
917 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming tunnel %X\n", tid);
918 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
923 if (NULL != h->new_tunnel)
925 struct GNUNET_ATS_Information atsi;
927 t = create_tunnel (h, tid);
928 t->owner = GNUNET_PEER_intern (&msg->peer);
930 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
931 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
933 t->peers[0]->connected = 1;
934 t->peers[0]->id = t->owner;
935 GNUNET_PEER_change_rc (t->owner, 1);
940 LOG (GNUNET_ERROR_TYPE_DEBUG, " created tunnel %p\n", t);
941 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
942 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
946 struct GNUNET_MESH_TunnelMessage d_msg;
948 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
950 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
951 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
952 d_msg.tunnel_id = msg->tunnel_id;
954 send_packet (h, &d_msg.header, NULL);
961 * Process the tunnel destroy notification and free associated resources
963 * @param h The mesh handle
964 * @param msg A message with the details of the tunnel being destroyed
967 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
968 const struct GNUNET_MESH_TunnelMessage *msg)
970 struct GNUNET_MESH_Tunnel *t;
971 MESH_TunnelNumber tid;
973 tid = ntohl (msg->tunnel_id);
974 t = retrieve_tunnel (h, tid);
984 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
985 destroy_tunnel (t, GNUNET_YES);
991 * Process the new peer event and notify the upper level of it
993 * @param h The mesh handle
994 * @param msg A message with the details of the peer event
997 process_peer_event (struct GNUNET_MESH_Handle *h,
998 const struct GNUNET_MESH_PeerControl *msg)
1000 struct GNUNET_MESH_Tunnel *t;
1001 struct GNUNET_MESH_Peer *p;
1002 struct GNUNET_ATS_Information atsi;
1006 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
1007 size = ntohs (msg->header.size);
1008 if (size != sizeof (struct GNUNET_MESH_PeerControl))
1013 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1019 id = GNUNET_PEER_search (&msg->peer);
1020 if ((p = retrieve_peer (t, id)) == NULL)
1021 p = add_peer_to_tunnel (t, &msg->peer);
1022 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
1024 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
1025 if (NULL != t->connect_handler)
1029 t->connect_handler (t->cls, &msg->peer, &atsi);
1035 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
1036 if (NULL != t->disconnect_handler && p->connected)
1038 t->disconnect_handler (t->cls, &msg->peer);
1040 remove_peer_from_tunnel (p);
1043 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
1048 * Process the incoming data packets
1050 * @param h The mesh handle
1051 * @param message A message encapsulating the data
1053 * @return GNUNET_YES if everything went fine
1054 * GNUNET_NO if client closed connection (h no longer valid)
1057 process_incoming_data (struct GNUNET_MESH_Handle *h,
1058 const struct GNUNET_MessageHeader *message)
1060 const struct GNUNET_MessageHeader *payload;
1061 const struct GNUNET_MESH_MessageHandler *handler;
1062 const struct GNUNET_PeerIdentity *peer;
1063 struct GNUNET_MESH_Unicast *ucast;
1064 struct GNUNET_MESH_Multicast *mcast;
1065 struct GNUNET_MESH_ToOrigin *to_orig;
1066 struct GNUNET_MESH_Tunnel *t;
1071 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1072 type = ntohs (message->type);
1075 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1076 ucast = (struct GNUNET_MESH_Unicast *) message;
1078 t = retrieve_tunnel (h, ntohl (ucast->tid));
1079 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1081 pid = ntohl (ucast->pid);
1082 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1083 GNUNET_i2s (peer), ntohl (ucast->tid));
1085 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1086 mcast = (struct GNUNET_MESH_Multicast *) message;
1087 t = retrieve_tunnel (h, ntohl (mcast->tid));
1088 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1090 pid = ntohl (mcast->pid);
1091 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1092 GNUNET_i2s (peer), ntohl (mcast->tid));
1094 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1095 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1096 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1097 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1098 peer = &to_orig->sender;
1099 pid = ntohl (to_orig->pid);
1100 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1101 GNUNET_i2s (peer), ntohl (to_orig->tid));
1107 LOG (GNUNET_ERROR_TYPE_DEBUG, " pid %u\n", pid);
1110 /* Tunnel was ignored, probably service didn't get it yet */
1111 LOG (GNUNET_ERROR_TYPE_DEBUG, " ignored!\n");
1114 if (GMC_is_pid_bigger(pid, t->last_recv_pid + 1))
1117 LOG (GNUNET_ERROR_TYPE_WARNING, " unauthorized message!\n");
1118 // FIXME fc what now? accept? reject?
1121 t->last_recv_pid = pid;
1122 type = ntohs (payload->type);
1123 for (i = 0; i < h->n_handlers; i++)
1125 handler = &h->message_handlers[i];
1126 if (handler->type == type)
1128 struct GNUNET_ATS_Information atsi;
1133 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1135 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1136 GNUNET_MESH_disconnect (h);
1141 LOG (GNUNET_ERROR_TYPE_DEBUG,
1142 "callback completed successfully\n");
1152 * Process a local ACK message, enabling the client to send
1153 * more data to the service.
1155 * @param h Mesh handle.
1156 * @param message Message itself.
1159 process_ack (struct GNUNET_MESH_Handle *h,
1160 const struct GNUNET_MessageHeader *message)
1162 struct GNUNET_MESH_LocalAck *msg;
1163 struct GNUNET_MESH_Tunnel *t;
1166 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1167 msg = (struct GNUNET_MESH_LocalAck *) message;
1169 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1173 LOG (GNUNET_ERROR_TYPE_WARNING,
1174 "ACK on unknown tunnel %X\n",
1175 ntohl (msg->tunnel_id));
1178 ack = ntohl (msg->max_pid);
1179 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X, ack %u!\n", t->tid, ack);
1180 if (ack > t->max_send_pid || PID_OVERFLOW (t->max_send_pid, ack))
1181 t->max_send_pid = ack;
1184 if (NULL == h->th && 0 < t->packet_size)
1186 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n", t->tid, ack);
1188 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1189 GNUNET_TIME_UNIT_FOREVER_REL,
1190 GNUNET_YES, &send_callback, h);
1196 * Function to process all messages received from the service
1198 * @param cls closure
1199 * @param msg message received, NULL on timeout or fatal error
1202 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1204 struct GNUNET_MESH_Handle *h = cls;
1208 LOG (GNUNET_ERROR_TYPE_WARNING, "Received NULL msg on %p\n", h);
1212 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n",
1213 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1214 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1215 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1216 switch (ntohs (msg->type))
1218 /* Notify of a new incoming tunnel */
1219 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1220 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1222 /* Notify of a tunnel disconnection */
1223 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1224 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1226 /* Notify of a new peer or a peer disconnect in the tunnel */
1227 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1228 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1229 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1231 /* Notify of a new data packet in the tunnel */
1232 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1233 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1234 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1235 if (GNUNET_NO == process_incoming_data (h, msg))
1238 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1239 process_ack (h, msg);
1242 /* We shouldn't get any other packages, log and ignore */
1243 LOG (GNUNET_ERROR_TYPE_WARNING,
1244 "unsolicited message form service (type %hu)\n",
1247 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1248 if (GNUNET_YES == h->in_receive)
1250 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1251 GNUNET_TIME_UNIT_FOREVER_REL);
1255 LOG (GNUNET_ERROR_TYPE_DEBUG,
1256 "in receive off, not calling CLIENT_receive\n");
1261 /******************************************************************************/
1262 /************************ SEND FUNCTIONS ****************************/
1263 /******************************************************************************/
1266 * Function called to send a message to the service.
1267 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1270 * @param cls closure, the mesh handle
1271 * @param size number of bytes available in buf
1272 * @param buf where the callee should write the connect message
1273 * @return number of bytes written to buf
1276 send_callback (void *cls, size_t size, void *buf)
1278 struct GNUNET_MESH_Handle *h = cls;
1279 struct GNUNET_MESH_TransmitHandle *th;
1280 struct GNUNET_MESH_TransmitHandle *next;
1281 struct GNUNET_MESH_Tunnel *t;
1286 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1287 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1288 if ((0 == size) || (NULL == buf))
1290 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback on %p\n", h);
1297 while ((NULL != (th = next)) && (size >= th->size))
1300 if (GNUNET_YES == th_is_payload (th))
1302 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1303 if (t->max_send_pid < t->next_send_pid && GNUNET_NO == PID_OVERFLOW (t->next_send_pid, t->max_send_pid))
1305 /* This tunnel is not ready to transmit yet, try next message */
1310 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1312 /* traffic to origin */
1313 struct GNUNET_MESH_ToOrigin to;
1314 struct GNUNET_MessageHeader *mh;
1316 GNUNET_assert (size >= th->size);
1317 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1318 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1319 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %s\n",
1320 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1323 psize += sizeof (to);
1324 GNUNET_assert (size >= psize);
1325 to.header.size = htons (psize);
1326 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1327 to.tid = htonl (t->tid);
1328 to.pid = htonl (t->next_send_pid);
1329 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1330 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1331 memcpy (cbuf, &to, sizeof (to));
1334 else if (th->target == 0)
1337 struct GNUNET_MESH_Multicast mc;
1338 struct GNUNET_MessageHeader *mh;
1340 GNUNET_assert (size >= th->size);
1341 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1342 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1343 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %s\n",
1344 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1347 psize += sizeof (mc);
1348 GNUNET_assert (size >= psize);
1349 mc.header.size = htons (psize);
1350 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1351 mc.tid = htonl (t->tid);
1352 mc.pid = htonl (t->next_send_pid);
1354 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1355 memcpy (cbuf, &mc, sizeof (mc));
1361 struct GNUNET_MESH_Unicast uc;
1362 struct GNUNET_MessageHeader *mh;
1364 GNUNET_assert (size >= th->size);
1365 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1366 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1367 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %s\n",
1368 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1371 psize += sizeof (uc);
1372 GNUNET_assert (size >= psize);
1373 uc.header.size = htons (psize);
1374 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1375 uc.tid = htonl (t->tid);
1376 uc.pid = htonl (t->next_send_pid);
1377 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1378 GNUNET_PEER_resolve (th->target, &uc.destination);
1379 memcpy (cbuf, &uc, sizeof (uc));
1386 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1388 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %s\n",
1389 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1390 memcpy (cbuf, &th[1], th->size);
1393 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1394 GNUNET_SCHEDULER_cancel (th->timeout_task);
1395 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1402 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1404 size = message_ready_size (h);
1407 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", size);
1409 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1410 GNUNET_TIME_UNIT_FOREVER_REL,
1411 GNUNET_YES, &send_callback, h);
1415 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1417 if (GNUNET_NO == h->in_receive)
1419 LOG (GNUNET_ERROR_TYPE_DEBUG, " start receiving from service\n");
1420 h->in_receive = GNUNET_YES;
1421 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1422 GNUNET_TIME_UNIT_FOREVER_REL);
1424 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1430 * Auxiliary function to send an already constructed packet to the service.
1431 * Takes care of creating a new queue element, copying the message and
1432 * calling the tmt_rdy function if necessary.
1434 * @param h mesh handle
1435 * @param msg message to transmit
1436 * @param tunnel tunnel this send is related to (NULL if N/A)
1439 send_packet (struct GNUNET_MESH_Handle *h,
1440 const struct GNUNET_MessageHeader *msg,
1441 struct GNUNET_MESH_Tunnel *tunnel)
1443 struct GNUNET_MESH_TransmitHandle *th;
1446 msize = ntohs (msg->size);
1447 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1448 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1450 th->tunnel = tunnel;
1451 memcpy (&th[1], msg, msize);
1452 add_to_queue (h, th);
1456 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1457 GNUNET_TIME_UNIT_FOREVER_REL,
1458 GNUNET_YES, &send_callback, h);
1462 /******************************************************************************/
1463 /********************** API CALL DEFINITIONS *************************/
1464 /******************************************************************************/
1467 * Connect to the mesh service.
1469 * @param cfg configuration to use
1470 * @param cls closure for the various callbacks that follow
1471 * (including handlers in the handlers array)
1472 * @param new_tunnel function called when an *inbound* tunnel is created
1473 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1474 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1475 * is called on the tunnel
1476 * @param handlers callbacks for messages we care about, NULL-terminated
1477 * note that the mesh is allowed to drop notifications about
1478 * inbound messages if the client does not process them fast
1479 * enough (for this notification type, a bounded queue is used)
1480 * @param stypes list of the applications that this client claims to provide
1481 * @return handle to the mesh service NULL on error
1482 * (in this case, init is never called)
1484 struct GNUNET_MESH_Handle *
1485 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1486 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1487 GNUNET_MESH_TunnelEndHandler cleaner,
1488 const struct GNUNET_MESH_MessageHandler *handlers,
1489 const GNUNET_MESH_ApplicationType *stypes)
1491 struct GNUNET_MESH_Handle *h;
1493 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1494 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1495 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1497 h->new_tunnel = new_tunnel;
1498 h->cleaner = cleaner;
1499 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1500 if (h->client == NULL)
1508 h->applications = stypes;
1509 h->message_handlers = handlers;
1510 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1511 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1512 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1514 /* count handlers and apps, calculate size */
1515 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1516 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1518 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1524 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1525 * disconnect callbacks will be called on any still connected peers, notifying
1526 * about their disconnection. The registered inbound tunnel cleaner will be
1527 * called should any inbound tunnels still exist.
1529 * @param handle connection to mesh to disconnect
1532 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1534 struct GNUNET_MESH_Tunnel *t;
1535 struct GNUNET_MESH_Tunnel *aux;
1536 struct GNUNET_MESH_TransmitHandle *th;
1538 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1540 t = handle->tunnels_head;
1544 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1547 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1549 destroy_tunnel (t, GNUNET_YES);
1552 while ( (th = handle->th_head) != NULL)
1554 struct GNUNET_MessageHeader *msg;
1556 /* Make sure it is an allowed packet (everything else should have been
1557 * already canceled).
1559 GNUNET_break (GNUNET_NO == th_is_payload (th));
1560 msg = (struct GNUNET_MessageHeader *) &th[1];
1561 switch (ntohs(msg->type))
1563 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1564 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1568 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1572 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1576 if (NULL != handle->th)
1578 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1581 if (NULL != handle->client)
1583 GNUNET_CLIENT_disconnect (handle->client);
1584 handle->client = NULL;
1586 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1588 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1589 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1591 GNUNET_free (handle);
1596 * Announce to ther peer the availability of services described by the regex,
1597 * in order to be reachable to other peers via connect_by_string.
1599 * Note that the first 8 characters are considered to be part of a prefix,
1600 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1601 * all matching strings will be stored in the DHT.
1603 * @param h handle to mesh.
1604 * @param regex string with the regular expression describing local services.
1607 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1610 struct GNUNET_MessageHeader *msg;
1614 len = strlen (regex);
1615 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1616 GNUNET_assert (UINT16_MAX > msgsize);
1619 char buffer[msgsize];
1621 msg = (struct GNUNET_MessageHeader *) buffer;
1622 msg->size = htons (msgsize);
1623 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1624 memcpy (&msg[1], regex, len);
1626 send_packet(h, msg, NULL);
1631 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1632 * and to broadcast).
1634 * @param h mesh handle
1635 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1636 * @param connect_handler function to call when peers are actually connected
1637 * @param disconnect_handler function to call when peers are disconnected
1638 * @param handler_cls closure for connect/disconnect handlers
1640 struct GNUNET_MESH_Tunnel *
1641 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1642 GNUNET_MESH_PeerConnectHandler connect_handler,
1643 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1646 struct GNUNET_MESH_Tunnel *t;
1647 struct GNUNET_MESH_TunnelMessage msg;
1649 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1650 t = create_tunnel (h, 0);
1651 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", t);
1652 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n", t->tid);
1653 t->connect_handler = connect_handler;
1654 t->disconnect_handler = disconnect_handler;
1655 t->cls = handler_cls;
1656 t->ctx = tunnel_ctx;
1657 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1658 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1659 msg.tunnel_id = htonl (t->tid);
1660 send_packet (h, &msg.header, t);
1666 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1669 * @param tunnel tunnel handle
1672 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1674 struct GNUNET_MESH_Handle *h;
1675 struct GNUNET_MESH_TunnelMessage msg;
1676 struct GNUNET_MESH_TransmitHandle *th;
1678 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1681 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1682 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1683 msg.tunnel_id = htonl (tunnel->tid);
1687 struct GNUNET_MESH_TransmitHandle *aux;
1688 if (th->tunnel == tunnel)
1691 /* FIXME call the handler? */
1692 if (GNUNET_YES == th_is_payload (th))
1693 th->notify (th->notify_cls, 0, NULL);
1694 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1702 destroy_tunnel (tunnel, GNUNET_NO);
1703 send_packet (h, &msg.header, NULL);
1707 * Request that the tunnel data rate is limited to the speed of the slowest
1710 * @param tunnel Tunnel affected.
1713 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1715 struct GNUNET_MESH_TunnelMessage msg;
1716 struct GNUNET_MESH_Handle *h;
1719 tunnel->speed_min = GNUNET_YES;
1721 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1722 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1723 msg.tunnel_id = htonl (tunnel->tid);
1725 send_packet (h, &msg.header, NULL);
1730 * Request that the tunnel data rate is limited to the speed of the fastest
1731 * receiver. This is the default behavior.
1733 * @param tunnel Tunnel affected.
1736 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1738 struct GNUNET_MESH_TunnelMessage msg;
1739 struct GNUNET_MESH_Handle *h;
1742 tunnel->speed_min = GNUNET_NO;
1744 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1745 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1746 msg.tunnel_id = htonl (tunnel->tid);
1748 send_packet (h, &msg.header, NULL);
1752 * Turn on/off the buffering status of the tunnel.
1754 * @param tunnel Tunnel affected.
1755 * @param buffer GNUNET_YES to turn buffering on (default),
1756 * GNUNET_NO otherwise.
1759 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1761 struct GNUNET_MESH_TunnelMessage msg;
1762 struct GNUNET_MESH_Handle *h;
1765 tunnel->buffering = buffer;
1767 if (GNUNET_YES == buffer)
1768 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1770 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1771 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1772 msg.tunnel_id = htonl (tunnel->tid);
1774 send_packet (h, &msg.header, NULL);
1778 * Request that a peer should be added to the tunnel. The existing
1779 * connect handler will be called ONCE with either success or failure.
1780 * This function should NOT be called again with the same peer before the
1781 * connect handler is called.
1783 * @param tunnel handle to existing tunnel
1784 * @param peer peer to add
1787 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1788 const struct GNUNET_PeerIdentity *peer)
1790 struct GNUNET_MESH_PeerControl msg;
1791 GNUNET_PEER_Id peer_id;
1794 peer_id = GNUNET_PEER_intern (peer);
1795 for (i = 0; i < tunnel->npeers; i++)
1797 if (tunnel->peers[i]->id == peer_id)
1799 /* Peer already exists in tunnel */
1800 GNUNET_PEER_change_rc (peer_id, -1);
1805 if (NULL == add_peer_to_tunnel (tunnel, peer))
1808 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1809 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1810 msg.tunnel_id = htonl (tunnel->tid);
1812 send_packet (tunnel->mesh, &msg.header, tunnel);
1819 * Request that a peer should be removed from the tunnel. The existing
1820 * disconnect handler will be called ONCE if we were connected.
1822 * @param tunnel handle to existing tunnel
1823 * @param peer peer to remove
1826 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1827 const struct GNUNET_PeerIdentity *peer)
1829 struct GNUNET_MESH_PeerControl msg;
1830 GNUNET_PEER_Id peer_id;
1833 peer_id = GNUNET_PEER_search (peer);
1839 for (i = 0; i < tunnel->npeers; i++)
1840 if (tunnel->peers[i]->id == peer_id)
1842 if (i == tunnel->npeers)
1847 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1848 tunnel->disconnect_handler (tunnel->cls, peer);
1849 GNUNET_PEER_change_rc (peer_id, -1);
1850 GNUNET_free (tunnel->peers[i]);
1851 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1852 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1854 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1855 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1856 msg.tunnel_id = htonl (tunnel->tid);
1857 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1858 send_packet (tunnel->mesh, &msg.header, tunnel);
1863 * Request that the mesh should try to connect to a peer supporting the given
1866 * @param tunnel handle to existing tunnel
1867 * @param app_type application type that must be supported by the peer (MESH
1868 * should discover peer in proximity handling this type)
1871 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1872 GNUNET_MESH_ApplicationType app_type)
1874 struct GNUNET_MESH_ConnectPeerByType msg;
1876 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1878 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1879 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1880 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1881 msg.tunnel_id = htonl (tunnel->tid);
1882 msg.type = htonl (app_type);
1883 send_packet (tunnel->mesh, &msg.header, tunnel);
1888 * Request that the mesh should try to connect to a peer matching the
1889 * description given in the service string.
1891 * FIXME: allow multiple? how to deal with reconnect?
1893 * @param tunnel handle to existing tunnel
1894 * @param description string describing the destination node requirements
1897 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1898 const char *description)
1900 struct GNUNET_MESH_ConnectPeerByString *m;
1904 len = strlen (description);
1905 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1906 GNUNET_assert (UINT16_MAX > msgsize);
1908 char buffer[msgsize];
1910 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1911 m->header.size = htons (msgsize);
1912 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1913 m->tunnel_id = htonl (tunnel->tid);
1914 memcpy(&m[1], description, len);
1916 send_packet (tunnel->mesh, &m->header, tunnel);
1922 * Request that the given peer isn't added to this tunnel in calls to
1923 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1925 * @param tunnel handle to existing tunnel.
1926 * @param peer peer identity of the peer which should be blacklisted
1930 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1931 const struct GNUNET_PeerIdentity *peer)
1933 struct GNUNET_MESH_PeerControl msg;
1935 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1936 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1937 msg.tunnel_id = htonl (tunnel->tid);
1939 send_packet (tunnel->mesh, &msg.header, tunnel);
1946 * Request that the given peer isn't blacklisted anymore from this tunnel,
1947 * and therefore can be added in future calls to connect_by_*.
1948 * The peer must have been previously blacklisted for this tunnel.
1950 * @param tunnel handle to existing tunnel.
1951 * @param peer peer identity of the peer which shouldn't be blacklisted
1952 * for the tunnel anymore.
1955 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1956 const struct GNUNET_PeerIdentity *peer)
1958 struct GNUNET_MESH_PeerControl msg;
1960 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1961 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1962 msg.tunnel_id = htonl (tunnel->tid);
1964 send_packet (tunnel->mesh, &msg.header, tunnel);
1971 * Ask the mesh to call "notify" once it is ready to transmit the
1972 * given number of bytes to the specified tunnel or target.
1973 * Only one call can be active at any time, to issue another request,
1974 * wait for the callback or cancel the current request.
1976 * @param tunnel tunnel to use for transmission
1977 * @param cork is corking allowed for this transmission?
1978 * @param maxdelay how long can the message wait?
1979 * @param target destination for the message
1980 * NULL for multicast to all tunnel targets
1981 * @param notify_size how many bytes of buffer space does notify want?
1982 * @param notify function to call when buffer space is available;
1983 * will be called with NULL on timeout or if the overall queue
1984 * for this peer is larger than queue_size and this is currently
1985 * the message with the lowest priority
1986 * @param notify_cls closure for notify
1987 * @return non-NULL if the notify callback was queued,
1988 * NULL if we can not even queue the request (insufficient
1989 * memory); if NULL is returned, "notify" will NOT be called.
1991 struct GNUNET_MESH_TransmitHandle *
1992 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1993 struct GNUNET_TIME_Relative maxdelay,
1994 const struct GNUNET_PeerIdentity *target,
1996 GNUNET_CONNECTION_TransmitReadyNotify notify,
1999 struct GNUNET_MESH_TransmitHandle *th;
2002 GNUNET_assert (NULL != tunnel);
2003 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY\n");
2004 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X\n", tunnel->tid);
2005 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2006 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
2007 else if (NULL != target)
2008 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
2010 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
2011 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
2012 GNUNET_assert (NULL != notify);
2013 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
2014 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
2015 th->tunnel = tunnel;
2016 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
2017 th->target = GNUNET_PEER_intern (target);
2018 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2019 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
2020 else if (NULL == target)
2021 overhead = sizeof (struct GNUNET_MESH_Multicast);
2023 overhead = sizeof (struct GNUNET_MESH_Unicast);
2024 tunnel->packet_size = th->size = notify_size + overhead;
2025 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
2026 th->notify = notify;
2027 th->notify_cls = notify_cls;
2028 add_to_queue (tunnel->mesh, th);
2029 if (NULL != tunnel->mesh->th)
2031 if (GNUNET_NO == PID_OVERFLOW(tunnel->next_send_pid, tunnel->max_send_pid) &&
2032 tunnel->max_send_pid <= tunnel->next_send_pid)
2034 LOG (GNUNET_ERROR_TYPE_DEBUG, " call notify tmt rdy\n");
2036 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
2037 GNUNET_TIME_UNIT_FOREVER_REL,
2038 GNUNET_YES, &send_callback,
2040 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY END\n");
2046 * Cancel the specified transmission-ready notification.
2048 * @param th handle that was returned by "notify_transmit_ready".
2051 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
2053 struct GNUNET_MESH_Handle *mesh;
2055 th->tunnel->packet_size = 0;
2056 mesh = th->tunnel->mesh;
2057 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
2058 GNUNET_SCHEDULER_cancel (th->timeout_task);
2059 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
2061 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
2063 /* queue empty, no point in asking for transmission */
2064 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
2071 * Transition API for tunnel ctx management
2074 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2080 * Transition API for tunnel ctx management
2083 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)