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?
326 * Maximum allowed PID.
334 /******************************************************************************/
335 /*********************** DECLARATIONS *************************/
336 /******************************************************************************/
339 * Function called to send a message to the service.
340 * "buf" will be NULL and "size" zero if the socket was closed for writing in
343 * @param cls closure, the mesh handle
344 * @param size number of bytes available in buf
345 * @param buf where the callee should write the connect message
346 * @return number of bytes written to buf
349 send_callback (void *cls, size_t size, void *buf);
352 /******************************************************************************/
353 /*********************** AUXILIARY FUNCTIONS *************************/
354 /******************************************************************************/
357 * Check if transmission is a payload packet.
359 * @param th Transmission handle.
361 * @return GNUNET_YES if it is a payload packet,
362 * GNUNET_NO if it is a mesh management packet.
365 th_is_payload (struct GNUNET_MESH_TransmitHandle *th)
367 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
372 * Check whether there is any message ready in the queue and find the size.
374 * @param h Mesh handle.
376 * @return The size of the first ready message in the queue,
377 * 0 if there is none.
380 message_ready_size (struct GNUNET_MESH_Handle *h)
382 struct GNUNET_MESH_TransmitHandle *th;
383 struct GNUNET_MESH_Tunnel *t;
385 for (th = h->th_head; NULL != th; th = th->next)
388 if (GNUNET_NO == th_is_payload (th) ||
389 (t->max_pid > t->pid || PID_OVERFLOW (t->pid, t->max_pid)))
397 * Get the tunnel handler for the tunnel specified by id from the given handle
398 * @param h Mesh handle
399 * @param tid ID of the wanted tunnel
400 * @return handle to the required tunnel or NULL if not found
402 static struct GNUNET_MESH_Tunnel *
403 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
405 struct GNUNET_MESH_Tunnel *t;
419 * Create a new tunnel and insert it in the tunnel list of the mesh handle
420 * @param h Mesh handle
421 * @param tid desired tid of the tunnel, 0 to assign one automatically
422 * @return handle to the created tunnel
424 static struct GNUNET_MESH_Tunnel *
425 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
427 struct GNUNET_MESH_Tunnel *t;
429 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
430 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
434 t->tid = h->next_tid;
435 while (NULL != retrieve_tunnel (h, h->next_tid))
438 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
439 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
452 * Destroy the specified tunnel.
453 * - Destroys all peers, calling the disconnect callback on each if needed
454 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
455 * - Calls cleaner if tunnel was inbound
456 * - Frees all memory used
458 * @param t Pointer to the tunnel.
459 * @param call_cleaner Whether to call the cleaner handler.
461 * @return Handle to the required tunnel or NULL if not found.
464 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
466 struct GNUNET_MESH_Handle *h;
467 struct GNUNET_PeerIdentity pi;
468 struct GNUNET_MESH_TransmitHandle *th;
469 struct GNUNET_MESH_TransmitHandle *next;
472 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
481 /* disconnect all peers */
482 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
483 for (i = 0; i < t->npeers; i++)
485 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
487 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
488 t->disconnect_handler (t->cls, &pi);
490 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
491 GNUNET_free (t->peers[i]);
494 /* signal tunnel destruction */
495 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
496 h->cleaner (h->cls, t, t->ctx);
498 /* check that clients did not leave messages behind in the queue */
499 for (th = h->th_head; NULL != th; th = next)
504 /* Clients should have aborted their requests already.
505 * Management traffic should be ok, as clients can't cancel that */
506 GNUNET_break (GNUNET_NO == th_is_payload(th));
507 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
509 /* clean up request */
510 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
511 GNUNET_SCHEDULER_cancel (th->timeout_task);
515 /* if there are no more pending requests with mesh service, cancel active request */
516 /* Note: this should be unnecessary... */
517 if ((0 == message_ready_size (h)) && (NULL != h->th))
519 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
525 GNUNET_free (t->peers);
527 GNUNET_PEER_change_rc (t->owner, -1);
528 if (0 != t->napps && t->apps)
529 GNUNET_free (t->apps);
536 * Get the peer descriptor for the peer with id from the given tunnel
537 * @param t Tunnel handle
538 * @param id Short form ID of the wanted peer
539 * @return handle to the requested peer or NULL if not found
541 static struct GNUNET_MESH_Peer *
542 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
546 for (i = 0; i < t->npeers; i++)
547 if (t->peers[i]->id == id)
554 * Add a peer into a tunnel
555 * @param t Tunnel handle
556 * @param pi Full ID of the new peer
557 * @return handle to the newly created peer
559 static struct GNUNET_MESH_Peer *
560 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
561 const struct GNUNET_PeerIdentity *pi)
563 struct GNUNET_MESH_Peer *p;
571 id = GNUNET_PEER_intern (pi);
573 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
576 GNUNET_array_append (t->peers, t->npeers, p);
582 * Remove a peer from a tunnel
583 * @param p Peer handle
586 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
590 for (i = 0; i < p->t->npeers; i++)
592 if (p->t->peers[i] == p)
595 if (i == p->t->npeers)
600 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
601 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
606 * Notify client that the transmission has timed out
609 * @param tc task context
612 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
614 struct GNUNET_MESH_TransmitHandle *th = cls;
615 struct GNUNET_MESH_Handle *mesh;
617 mesh = th->tunnel->mesh;
618 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
619 th->tunnel->packet_size = 0;
620 if (GNUNET_YES == th_is_payload (th))
621 th->notify (th->notify_cls, 0, NULL);
623 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
625 /* nothing ready to transmit, no point in asking for transmission */
626 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
633 * Add a transmit handle to the transmission queue by priority and set the
636 * @param h mesh handle with the queue head and tail
637 * @param th handle to the packet to be transmitted
640 add_to_queue (struct GNUNET_MESH_Handle *h,
641 struct GNUNET_MESH_TransmitHandle *th)
643 struct GNUNET_MESH_TransmitHandle *p;
652 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
653 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
656 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
657 (th->timeout), &timeout_transmission, th);
662 * Auxiliary function to send an already constructed packet to the service.
663 * Takes care of creating a new queue element, copying the message and
664 * calling the tmt_rdy function if necessary.
666 * @param h mesh handle
667 * @param msg message to transmit
668 * @param tunnel tunnel this send is related to (NULL if N/A)
671 send_packet (struct GNUNET_MESH_Handle *h,
672 const struct GNUNET_MessageHeader *msg,
673 struct GNUNET_MESH_Tunnel *tunnel);
677 * Send an ack on the tunnel to confirm the processing of a message.
679 * @param h Mesh handle.
680 * @param t Tunnel on which to send the ACK.
683 send_ack (struct GNUNET_MESH_Handle *h, struct GNUNET_MESH_Tunnel *t)
685 struct GNUNET_MESH_LocalAck msg;
687 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
688 msg.header.size = htons (sizeof (msg));
689 msg.tunnel_id = htonl (t->tid);
690 msg.max_pid = t->pid + 1;
692 send_packet (h, &msg.header, t);
699 * Reconnect callback: tries to reconnect again after a failer previous
701 * @param cls closure (mesh handle)
702 * @param tc task context
705 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
709 * Send a connect packet to the service with the applications and types
710 * requested by the user.
712 * @param h The mesh handle.
716 send_connect (struct GNUNET_MESH_Handle *h)
720 size = sizeof (struct GNUNET_MESH_ClientConnect);
721 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
722 size += h->n_handlers * sizeof (uint16_t);
724 char buf[size] GNUNET_ALIGN;
725 struct GNUNET_MESH_ClientConnect *msg;
726 GNUNET_MESH_ApplicationType *apps;
731 /* build connection packet */
732 msg = (struct GNUNET_MESH_ClientConnect *) buf;
733 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
734 msg->header.size = htons (size);
735 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
736 for (napps = 0; napps < h->n_applications; napps++)
738 apps[napps] = htonl (h->applications[napps]);
739 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
741 types = (uint16_t *) & apps[napps];
742 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
743 types[ntypes] = htons (h->message_handlers[ntypes].type);
744 msg->applications = htons (napps);
745 msg->types = htons (ntypes);
746 LOG (GNUNET_ERROR_TYPE_DEBUG,
747 "Sending %lu bytes long message %d types and %d apps\n",
748 ntohs (msg->header.size), ntypes, napps);
749 send_packet (h, &msg->header, NULL);
755 * Reconnect to the service, retransmit all infomation to try to restore the
758 * @param h handle to the mesh
760 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
763 do_reconnect (struct GNUNET_MESH_Handle *h)
765 struct GNUNET_MESH_Tunnel *t;
768 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
769 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
770 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
771 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
772 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
777 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
780 if (NULL != h->client)
782 GNUNET_CLIENT_disconnect (h->client);
786 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
787 if (h->client == NULL)
789 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
792 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
793 GNUNET_TIME_relative_multiply
794 (h->reconnect_time, 2));
795 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
796 GNUNET_TIME_relative_to_string (h->reconnect_time));
802 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
805 /* Rebuild all tunnels */
806 for (t = h->tunnels_head; NULL != t; t = t->next)
808 struct GNUNET_MESH_TunnelMessage tmsg;
809 struct GNUNET_MESH_PeerControl pmsg;
811 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
813 /* Tunnel was created by service (incoming tunnel) */
814 /* TODO: Notify service of missing tunnel, to request
815 * creator to recreate path (find a path to him via DHT?)
819 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
820 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
821 tmsg.tunnel_id = htonl (t->tid);
822 send_packet (h, &tmsg.header, t);
824 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
825 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
826 pmsg.tunnel_id = htonl (t->tid);
828 /* Reconnect all peers */
829 /* If the tunnel was "by type", dont connect individual peers */
830 for (i = 0; i < t->npeers && 0 == t->napps; i++)
832 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
833 if (NULL != t->disconnect_handler && t->peers[i]->connected)
834 t->disconnect_handler (t->cls, &pmsg.peer);
835 send_packet (t->mesh, &pmsg.header, t);
837 /* Reconnect all types, if any */
838 for (i = 0; i < t->napps; i++)
840 struct GNUNET_MESH_ConnectPeerByType msg;
842 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
843 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
844 msg.tunnel_id = htonl (t->tid);
845 msg.type = htonl (t->apps[i]);
846 send_packet (t->mesh, &msg.header, t);
848 if (GNUNET_NO == t->buffering)
849 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
850 if (GNUNET_YES == t->speed_min)
851 GNUNET_MESH_tunnel_speed_min (t);
857 * Reconnect callback: tries to reconnect again after a failer previous
859 * @param cls closure (mesh handle)
860 * @param tc task context
863 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
865 struct GNUNET_MESH_Handle *h = cls;
867 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
868 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
875 * Reconnect to the service, retransmit all infomation to try to restore the
878 * @param h handle to the mesh
880 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
883 reconnect (struct GNUNET_MESH_Handle *h)
885 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
886 h->in_receive = GNUNET_NO;
887 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
888 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
893 /******************************************************************************/
894 /*********************** RECEIVE HANDLERS ****************************/
895 /******************************************************************************/
898 * Process the new tunnel notification and add it to the tunnels in the handle
900 * @param h The mesh handle
901 * @param msg A message with the details of the new incoming tunnel
904 process_tunnel_created (struct GNUNET_MESH_Handle *h,
905 const struct GNUNET_MESH_TunnelNotification *msg)
907 struct GNUNET_MESH_Tunnel *t;
908 MESH_TunnelNumber tid;
910 tid = ntohl (msg->tunnel_id);
911 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
916 if (NULL != h->new_tunnel)
918 struct GNUNET_ATS_Information atsi;
920 t = create_tunnel (h, tid);
921 t->owner = GNUNET_PEER_intern (&msg->peer);
923 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
924 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
926 t->peers[0]->connected = 1;
927 t->peers[0]->id = t->owner;
928 GNUNET_PEER_change_rc (t->owner, 1);
933 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
934 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
938 struct GNUNET_MESH_TunnelMessage d_msg;
940 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
942 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
943 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
944 d_msg.tunnel_id = msg->tunnel_id;
946 send_packet (h, &d_msg.header, NULL);
953 * Process the tunnel destroy notification and free associated resources
955 * @param h The mesh handle
956 * @param msg A message with the details of the tunnel being destroyed
959 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
960 const struct GNUNET_MESH_TunnelMessage *msg)
962 struct GNUNET_MESH_Tunnel *t;
963 MESH_TunnelNumber tid;
965 tid = ntohl (msg->tunnel_id);
966 t = retrieve_tunnel (h, tid);
976 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
977 destroy_tunnel (t, GNUNET_YES);
983 * Process the new peer event and notify the upper level of it
985 * @param h The mesh handle
986 * @param msg A message with the details of the peer event
989 process_peer_event (struct GNUNET_MESH_Handle *h,
990 const struct GNUNET_MESH_PeerControl *msg)
992 struct GNUNET_MESH_Tunnel *t;
993 struct GNUNET_MESH_Peer *p;
994 struct GNUNET_ATS_Information atsi;
998 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
999 size = ntohs (msg->header.size);
1000 if (size != sizeof (struct GNUNET_MESH_PeerControl))
1005 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1011 id = GNUNET_PEER_search (&msg->peer);
1012 if ((p = retrieve_peer (t, id)) == NULL)
1013 p = add_peer_to_tunnel (t, &msg->peer);
1014 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
1016 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
1017 if (NULL != t->connect_handler)
1021 t->connect_handler (t->cls, &msg->peer, &atsi);
1027 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
1028 if (NULL != t->disconnect_handler && p->connected)
1030 t->disconnect_handler (t->cls, &msg->peer);
1032 remove_peer_from_tunnel (p);
1035 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
1040 * Process the incoming data packets
1042 * @param h The mesh handle
1043 * @param message A message encapsulating the data
1045 * @return GNUNET_YES if everything went fine
1046 * GNUNET_NO if client closed connection (h no longer valid)
1049 process_incoming_data (struct GNUNET_MESH_Handle *h,
1050 const struct GNUNET_MessageHeader *message)
1052 const struct GNUNET_MessageHeader *payload;
1053 const struct GNUNET_MESH_MessageHandler *handler;
1054 const struct GNUNET_PeerIdentity *peer;
1055 struct GNUNET_MESH_Unicast *ucast;
1056 struct GNUNET_MESH_Multicast *mcast;
1057 struct GNUNET_MESH_ToOrigin *to_orig;
1058 struct GNUNET_MESH_Tunnel *t;
1062 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1063 type = ntohs (message->type);
1066 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1067 ucast = (struct GNUNET_MESH_Unicast *) message;
1069 t = retrieve_tunnel (h, ntohl (ucast->tid));
1070 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1072 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1073 GNUNET_i2s (peer), ntohl (ucast->tid));
1075 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1076 mcast = (struct GNUNET_MESH_Multicast *) message;
1077 t = retrieve_tunnel (h, ntohl (mcast->tid));
1078 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1080 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1081 GNUNET_i2s (peer), ntohl (mcast->tid));
1083 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1084 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1085 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1086 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1087 peer = &to_orig->sender;
1088 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1089 GNUNET_i2s (peer), ntohl (to_orig->tid));
1097 /* Tunnel was ignored, probably service didn't get it yet */
1100 type = ntohs (payload->type);
1101 for (i = 0; i < h->n_handlers; i++)
1103 handler = &h->message_handlers[i];
1104 if (handler->type == type)
1106 struct GNUNET_ATS_Information atsi;
1111 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1113 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1114 GNUNET_MESH_disconnect (h);
1119 LOG (GNUNET_ERROR_TYPE_DEBUG,
1120 "callback completed successfully\n");
1130 * Process a local ACK message, enabling the client to send
1131 * more data to the service.
1133 * @param h Mesh handle.
1134 * @param message Message itself.
1137 process_ack (struct GNUNET_MESH_Handle *h,
1138 const struct GNUNET_MessageHeader *message)
1140 struct GNUNET_MESH_LocalAck *msg;
1141 struct GNUNET_MESH_Tunnel *t;
1144 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1145 msg = (struct GNUNET_MESH_LocalAck *) message;
1147 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1151 LOG (GNUNET_ERROR_TYPE_WARNING,
1152 "ACK on unknown tunnel %X\n",
1153 ntohl (msg->tunnel_id));
1156 ack = ntohl (msg->max_pid);
1157 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X, ack %u!\n", t->tid, ack);
1158 if (ack > t->max_pid || PID_OVERFLOW (t->max_pid, ack))
1162 if (NULL == h->th && 0 < t->packet_size)
1164 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n", t->tid, ack);
1166 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1167 GNUNET_TIME_UNIT_FOREVER_REL,
1168 GNUNET_YES, &send_callback, h);
1174 * Function to process all messages received from the service
1176 * @param cls closure
1177 * @param msg message received, NULL on timeout or fatal error
1180 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1182 struct GNUNET_MESH_Handle *h = cls;
1186 LOG (GNUNET_ERROR_TYPE_WARNING, "Received NULL msg on %p\n", h);
1190 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %s from MESH\n",
1191 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1192 switch (ntohs (msg->type))
1194 /* Notify of a new incoming tunnel */
1195 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1196 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1198 /* Notify of a tunnel disconnection */
1199 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1200 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1202 /* Notify of a new peer or a peer disconnect in the tunnel */
1203 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1204 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1205 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1207 /* Notify of a new data packet in the tunnel */
1208 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1209 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1210 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1211 if (GNUNET_NO == process_incoming_data (h, msg))
1214 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1215 process_ack (h, msg);
1218 /* We shouldn't get any other packages, log and ignore */
1219 LOG (GNUNET_ERROR_TYPE_WARNING,
1220 "unsolicited message form service (type %hu)\n",
1223 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1224 if (GNUNET_YES == h->in_receive)
1226 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1227 GNUNET_TIME_UNIT_FOREVER_REL);
1231 LOG (GNUNET_ERROR_TYPE_DEBUG,
1232 "in receive off, not calling CLIENT_receive\n");
1237 /******************************************************************************/
1238 /************************ SEND FUNCTIONS ****************************/
1239 /******************************************************************************/
1242 * Function called to send a message to the service.
1243 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1246 * @param cls closure, the mesh handle
1247 * @param size number of bytes available in buf
1248 * @param buf where the callee should write the connect message
1249 * @return number of bytes written to buf
1252 send_callback (void *cls, size_t size, void *buf)
1254 struct GNUNET_MESH_Handle *h = cls;
1255 struct GNUNET_MESH_TransmitHandle *th;
1256 struct GNUNET_MESH_TransmitHandle *next;
1257 struct GNUNET_MESH_Tunnel *t;
1262 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1263 if ((0 == size) || (NULL == buf))
1265 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback on %p\n", h);
1272 while ((NULL != (th = next)) && (size >= th->size))
1275 if (GNUNET_YES == th_is_payload (th))
1277 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1278 if (t->max_pid < t->pid && GNUNET_NO == PID_OVERFLOW (t->pid, t->max_pid))
1280 /* This tunnel is not ready to transmit yet, try next message */
1285 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1287 /* traffic to origin */
1288 struct GNUNET_MESH_ToOrigin to;
1289 struct GNUNET_MessageHeader *mh;
1291 GNUNET_assert (size >= th->size);
1292 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1293 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1294 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %s\n",
1295 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1298 psize += sizeof (to);
1299 GNUNET_assert (size >= psize);
1300 to.header.size = htons (psize);
1301 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1302 to.tid = htonl (t->tid);
1304 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1305 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1306 memcpy (cbuf, &to, sizeof (to));
1309 else if (th->target == 0)
1312 struct GNUNET_MESH_Multicast mc;
1313 struct GNUNET_MessageHeader *mh;
1315 GNUNET_assert (size >= th->size);
1316 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1317 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1318 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %s\n",
1319 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1322 psize += sizeof (mc);
1323 GNUNET_assert (size >= psize);
1324 mc.header.size = htons (psize);
1325 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1326 mc.tid = htonl (t->tid);
1327 mc.pid = htonl (t->pid);
1329 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1330 memcpy (cbuf, &mc, sizeof (mc));
1336 struct GNUNET_MESH_Unicast uc;
1337 struct GNUNET_MessageHeader *mh;
1339 GNUNET_assert (size >= th->size);
1340 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1341 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1342 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %s\n",
1343 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1346 psize += sizeof (uc);
1347 GNUNET_assert (size >= psize);
1348 uc.header.size = htons (psize);
1349 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1350 uc.tid = htonl (t->tid);
1351 uc.pid = htonl (t->pid);
1352 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1353 GNUNET_PEER_resolve (th->target, &uc.destination);
1354 memcpy (cbuf, &uc, sizeof (uc));
1361 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1363 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %s\n",
1364 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1365 memcpy (cbuf, &th[1], th->size);
1368 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1369 GNUNET_SCHEDULER_cancel (th->timeout_task);
1370 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1377 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1379 size = message_ready_size (h);
1382 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", size);
1384 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1385 GNUNET_TIME_UNIT_FOREVER_REL,
1386 GNUNET_YES, &send_callback, h);
1390 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1392 if (GNUNET_NO == h->in_receive)
1394 LOG (GNUNET_ERROR_TYPE_DEBUG, " start receiving from service\n");
1395 h->in_receive = GNUNET_YES;
1396 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1397 GNUNET_TIME_UNIT_FOREVER_REL);
1399 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1405 * Auxiliary function to send an already constructed packet to the service.
1406 * Takes care of creating a new queue element, copying the message and
1407 * calling the tmt_rdy function if necessary.
1409 * @param h mesh handle
1410 * @param msg message to transmit
1411 * @param tunnel tunnel this send is related to (NULL if N/A)
1414 send_packet (struct GNUNET_MESH_Handle *h,
1415 const struct GNUNET_MessageHeader *msg,
1416 struct GNUNET_MESH_Tunnel *tunnel)
1418 struct GNUNET_MESH_TransmitHandle *th;
1421 msize = ntohs (msg->size);
1422 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1423 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1425 th->tunnel = tunnel;
1426 memcpy (&th[1], msg, msize);
1427 add_to_queue (h, th);
1431 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1432 GNUNET_TIME_UNIT_FOREVER_REL,
1433 GNUNET_YES, &send_callback, h);
1437 /******************************************************************************/
1438 /********************** API CALL DEFINITIONS *************************/
1439 /******************************************************************************/
1442 * Connect to the mesh service.
1444 * @param cfg configuration to use
1445 * @param cls closure for the various callbacks that follow
1446 * (including handlers in the handlers array)
1447 * @param new_tunnel function called when an *inbound* tunnel is created
1448 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1449 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1450 * is called on the tunnel
1451 * @param handlers callbacks for messages we care about, NULL-terminated
1452 * note that the mesh is allowed to drop notifications about
1453 * inbound messages if the client does not process them fast
1454 * enough (for this notification type, a bounded queue is used)
1455 * @param stypes list of the applications that this client claims to provide
1456 * @return handle to the mesh service NULL on error
1457 * (in this case, init is never called)
1459 struct GNUNET_MESH_Handle *
1460 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1461 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1462 GNUNET_MESH_TunnelEndHandler cleaner,
1463 const struct GNUNET_MESH_MessageHandler *handlers,
1464 const GNUNET_MESH_ApplicationType *stypes)
1466 struct GNUNET_MESH_Handle *h;
1468 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1469 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1470 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1472 h->new_tunnel = new_tunnel;
1473 h->cleaner = cleaner;
1474 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1475 if (h->client == NULL)
1483 h->applications = stypes;
1484 h->message_handlers = handlers;
1485 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1486 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1487 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1489 /* count handlers and apps, calculate size */
1490 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1491 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1493 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1499 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1500 * disconnect callbacks will be called on any still connected peers, notifying
1501 * about their disconnection. The registered inbound tunnel cleaner will be
1502 * called should any inbound tunnels still exist.
1504 * @param handle connection to mesh to disconnect
1507 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1509 struct GNUNET_MESH_Tunnel *t;
1510 struct GNUNET_MESH_Tunnel *aux;
1511 struct GNUNET_MESH_TransmitHandle *th;
1513 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1515 t = handle->tunnels_head;
1519 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1522 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1524 destroy_tunnel (t, GNUNET_YES);
1527 while ( (th = handle->th_head) != NULL)
1529 struct GNUNET_MessageHeader *msg;
1531 /* Make sure it is an allowed packet (everything else should have been
1532 * already canceled).
1534 GNUNET_break (GNUNET_NO == th_is_payload (th));
1535 msg = (struct GNUNET_MessageHeader *) &th[1];
1536 switch (ntohs(msg->type))
1538 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1539 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1543 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1547 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1551 if (NULL != handle->th)
1553 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1556 if (NULL != handle->client)
1558 GNUNET_CLIENT_disconnect (handle->client);
1559 handle->client = NULL;
1561 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1563 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1564 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1566 GNUNET_free (handle);
1571 * Announce to ther peer the availability of services described by the regex,
1572 * in order to be reachable to other peers via connect_by_string.
1574 * Note that the first 8 characters are considered to be part of a prefix,
1575 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1576 * all matching strings will be stored in the DHT.
1578 * @param h handle to mesh.
1579 * @param regex string with the regular expression describing local services.
1582 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1585 struct GNUNET_MessageHeader *msg;
1589 len = strlen (regex);
1590 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1591 GNUNET_assert (UINT16_MAX > msgsize);
1594 char buffer[msgsize];
1596 msg = (struct GNUNET_MessageHeader *) buffer;
1597 msg->size = htons (msgsize);
1598 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1599 memcpy (&msg[1], regex, len);
1601 send_packet(h, msg, NULL);
1606 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1607 * and to broadcast).
1609 * @param h mesh handle
1610 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1611 * @param connect_handler function to call when peers are actually connected
1612 * @param disconnect_handler function to call when peers are disconnected
1613 * @param handler_cls closure for connect/disconnect handlers
1615 struct GNUNET_MESH_Tunnel *
1616 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1617 GNUNET_MESH_PeerConnectHandler connect_handler,
1618 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1621 struct GNUNET_MESH_Tunnel *t;
1622 struct GNUNET_MESH_TunnelMessage msg;
1624 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1625 t = create_tunnel (h, 0);
1626 t->connect_handler = connect_handler;
1627 t->disconnect_handler = disconnect_handler;
1628 t->cls = handler_cls;
1629 t->ctx = tunnel_ctx;
1630 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1631 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1632 msg.tunnel_id = htonl (t->tid);
1633 send_packet (h, &msg.header, t);
1639 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1642 * @param tunnel tunnel handle
1645 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1647 struct GNUNET_MESH_Handle *h;
1648 struct GNUNET_MESH_TunnelMessage msg;
1649 struct GNUNET_MESH_TransmitHandle *th;
1651 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1654 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1655 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1656 msg.tunnel_id = htonl (tunnel->tid);
1660 struct GNUNET_MESH_TransmitHandle *aux;
1661 if (th->tunnel == tunnel)
1664 /* FIXME call the handler? */
1665 if (GNUNET_YES == th_is_payload (th))
1666 th->notify (th->notify_cls, 0, NULL);
1667 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1675 destroy_tunnel (tunnel, GNUNET_NO);
1676 send_packet (h, &msg.header, NULL);
1680 * Request that the tunnel data rate is limited to the speed of the slowest
1683 * @param tunnel Tunnel affected.
1686 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1688 struct GNUNET_MESH_TunnelMessage msg;
1689 struct GNUNET_MESH_Handle *h;
1692 tunnel->speed_min = GNUNET_YES;
1694 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1695 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1696 msg.tunnel_id = htonl (tunnel->tid);
1698 send_packet (h, &msg.header, NULL);
1703 * Request that the tunnel data rate is limited to the speed of the fastest
1704 * receiver. This is the default behavior.
1706 * @param tunnel Tunnel affected.
1709 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1711 struct GNUNET_MESH_TunnelMessage msg;
1712 struct GNUNET_MESH_Handle *h;
1715 tunnel->speed_min = GNUNET_NO;
1717 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1718 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1719 msg.tunnel_id = htonl (tunnel->tid);
1721 send_packet (h, &msg.header, NULL);
1725 * Turn on/off the buffering status of the tunnel.
1727 * @param tunnel Tunnel affected.
1728 * @param buffer GNUNET_YES to turn buffering on (default),
1729 * GNUNET_NO otherwise.
1732 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1734 struct GNUNET_MESH_TunnelMessage msg;
1735 struct GNUNET_MESH_Handle *h;
1738 tunnel->buffering = buffer;
1740 if (GNUNET_YES == buffer)
1741 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1743 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1744 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1745 msg.tunnel_id = htonl (tunnel->tid);
1747 send_packet (h, &msg.header, NULL);
1751 * Request that a peer should be added to the tunnel. The existing
1752 * connect handler will be called ONCE with either success or failure.
1753 * This function should NOT be called again with the same peer before the
1754 * connect handler is called.
1756 * @param tunnel handle to existing tunnel
1757 * @param peer peer to add
1760 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1761 const struct GNUNET_PeerIdentity *peer)
1763 struct GNUNET_MESH_PeerControl msg;
1764 GNUNET_PEER_Id peer_id;
1767 peer_id = GNUNET_PEER_intern (peer);
1768 for (i = 0; i < tunnel->npeers; i++)
1770 if (tunnel->peers[i]->id == peer_id)
1772 /* Peer already exists in tunnel */
1773 GNUNET_PEER_change_rc (peer_id, -1);
1778 if (NULL == add_peer_to_tunnel (tunnel, peer))
1781 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1782 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1783 msg.tunnel_id = htonl (tunnel->tid);
1785 send_packet (tunnel->mesh, &msg.header, tunnel);
1792 * Request that a peer should be removed from the tunnel. The existing
1793 * disconnect handler will be called ONCE if we were connected.
1795 * @param tunnel handle to existing tunnel
1796 * @param peer peer to remove
1799 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1800 const struct GNUNET_PeerIdentity *peer)
1802 struct GNUNET_MESH_PeerControl msg;
1803 GNUNET_PEER_Id peer_id;
1806 peer_id = GNUNET_PEER_search (peer);
1812 for (i = 0; i < tunnel->npeers; i++)
1813 if (tunnel->peers[i]->id == peer_id)
1815 if (i == tunnel->npeers)
1820 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1821 tunnel->disconnect_handler (tunnel->cls, peer);
1822 GNUNET_PEER_change_rc (peer_id, -1);
1823 GNUNET_free (tunnel->peers[i]);
1824 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1825 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1827 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1828 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1829 msg.tunnel_id = htonl (tunnel->tid);
1830 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1831 send_packet (tunnel->mesh, &msg.header, tunnel);
1836 * Request that the mesh should try to connect to a peer supporting the given
1839 * @param tunnel handle to existing tunnel
1840 * @param app_type application type that must be supported by the peer (MESH
1841 * should discover peer in proximity handling this type)
1844 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1845 GNUNET_MESH_ApplicationType app_type)
1847 struct GNUNET_MESH_ConnectPeerByType msg;
1849 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1851 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1852 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1853 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1854 msg.tunnel_id = htonl (tunnel->tid);
1855 msg.type = htonl (app_type);
1856 send_packet (tunnel->mesh, &msg.header, tunnel);
1861 * Request that the mesh should try to connect to a peer matching the
1862 * description given in the service string.
1864 * FIXME: allow multiple? how to deal with reconnect?
1866 * @param tunnel handle to existing tunnel
1867 * @param description string describing the destination node requirements
1870 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1871 const char *description)
1873 struct GNUNET_MESH_ConnectPeerByString *m;
1877 len = strlen (description);
1878 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1879 GNUNET_assert (UINT16_MAX > msgsize);
1881 char buffer[msgsize];
1883 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1884 m->header.size = htons (msgsize);
1885 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1886 m->tunnel_id = htonl (tunnel->tid);
1887 memcpy(&m[1], description, len);
1889 send_packet (tunnel->mesh, &m->header, tunnel);
1895 * Request that the given peer isn't added to this tunnel in calls to
1896 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1898 * @param tunnel handle to existing tunnel.
1899 * @param peer peer identity of the peer which should be blacklisted
1903 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1904 const struct GNUNET_PeerIdentity *peer)
1906 struct GNUNET_MESH_PeerControl msg;
1908 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1909 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1910 msg.tunnel_id = htonl (tunnel->tid);
1912 send_packet (tunnel->mesh, &msg.header, tunnel);
1919 * Request that the given peer isn't blacklisted anymore from this tunnel,
1920 * and therefore can be added in future calls to connect_by_*.
1921 * The peer must have been previously blacklisted for this tunnel.
1923 * @param tunnel handle to existing tunnel.
1924 * @param peer peer identity of the peer which shouldn't be blacklisted
1925 * for the tunnel anymore.
1928 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1929 const struct GNUNET_PeerIdentity *peer)
1931 struct GNUNET_MESH_PeerControl msg;
1933 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1934 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1935 msg.tunnel_id = htonl (tunnel->tid);
1937 send_packet (tunnel->mesh, &msg.header, tunnel);
1944 * Ask the mesh to call "notify" once it is ready to transmit the
1945 * given number of bytes to the specified tunnel or target.
1946 * Only one call can be active at any time, to issue another request,
1947 * wait for the callback or cancel the current request.
1949 * @param tunnel tunnel to use for transmission
1950 * @param cork is corking allowed for this transmission?
1951 * @param maxdelay how long can the message wait?
1952 * @param target destination for the message
1953 * NULL for multicast to all tunnel targets
1954 * @param notify_size how many bytes of buffer space does notify want?
1955 * @param notify function to call when buffer space is available;
1956 * will be called with NULL on timeout or if the overall queue
1957 * for this peer is larger than queue_size and this is currently
1958 * the message with the lowest priority
1959 * @param notify_cls closure for notify
1960 * @return non-NULL if the notify callback was queued,
1961 * NULL if we can not even queue the request (insufficient
1962 * memory); if NULL is returned, "notify" will NOT be called.
1964 struct GNUNET_MESH_TransmitHandle *
1965 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1966 struct GNUNET_TIME_Relative maxdelay,
1967 const struct GNUNET_PeerIdentity *target,
1969 GNUNET_CONNECTION_TransmitReadyNotify notify,
1972 struct GNUNET_MESH_TransmitHandle *th;
1975 GNUNET_assert (NULL != tunnel);
1976 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1978 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1980 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1981 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
1982 GNUNET_assert (NULL != notify);
1983 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1984 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1985 th->tunnel = tunnel;
1986 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1987 th->target = GNUNET_PEER_intern (target);
1988 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1989 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1990 else if (NULL == target)
1991 overhead = sizeof (struct GNUNET_MESH_Multicast);
1993 overhead = sizeof (struct GNUNET_MESH_Unicast);
1994 tunnel->packet_size = th->size = notify_size + overhead;
1995 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
1996 th->notify = notify;
1997 th->notify_cls = notify_cls;
1998 add_to_queue (tunnel->mesh, th);
1999 if (NULL != tunnel->mesh->th)
2001 if (GNUNET_NO == PID_OVERFLOW(tunnel->pid, tunnel->max_pid) &&
2002 tunnel->max_pid <= tunnel->pid)
2004 LOG (GNUNET_ERROR_TYPE_DEBUG, " call notify tmt rdy\n");
2006 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
2007 GNUNET_TIME_UNIT_FOREVER_REL,
2008 GNUNET_YES, &send_callback,
2015 * Cancel the specified transmission-ready notification.
2017 * @param th handle that was returned by "notify_transmit_ready".
2020 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
2022 struct GNUNET_MESH_Handle *mesh;
2024 th->tunnel->packet_size = 0;
2025 mesh = th->tunnel->mesh;
2026 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
2027 GNUNET_SCHEDULER_cancel (th->timeout_task);
2028 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
2030 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
2032 /* queue empty, no point in asking for transmission */
2033 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
2040 * Transition API for tunnel ctx management
2043 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2049 * Transition API for tunnel ctx management
2052 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)