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;
451 * Destroy the specified tunnel.
452 * - Destroys all peers, calling the disconnect callback on each if needed
453 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
454 * - Calls cleaner if tunnel was inbound
455 * - Frees all memory used
457 * @param t Pointer to the tunnel.
458 * @param call_cleaner Whether to call the cleaner handler.
460 * @return Handle to the required tunnel or NULL if not found.
463 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
465 struct GNUNET_MESH_Handle *h;
466 struct GNUNET_PeerIdentity pi;
467 struct GNUNET_MESH_TransmitHandle *th;
468 struct GNUNET_MESH_TransmitHandle *next;
471 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
480 /* disconnect all peers */
481 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
482 for (i = 0; i < t->npeers; i++)
484 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
486 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
487 t->disconnect_handler (t->cls, &pi);
489 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
490 GNUNET_free (t->peers[i]);
493 /* signal tunnel destruction */
494 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
495 h->cleaner (h->cls, t, t->ctx);
497 /* check that clients did not leave messages behind in the queue */
498 for (th = h->th_head; NULL != th; th = next)
503 /* Clients should have aborted their requests already.
504 * Management traffic should be ok, as clients can't cancel that */
505 GNUNET_break (GNUNET_NO == th_is_payload(th));
506 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
508 /* clean up request */
509 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
510 GNUNET_SCHEDULER_cancel (th->timeout_task);
514 /* if there are no more pending requests with mesh service, cancel active request */
515 /* Note: this should be unnecessary... */
516 if ((0 == message_ready_size (h)) && (NULL != h->th))
518 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
524 GNUNET_free (t->peers);
526 GNUNET_PEER_change_rc (t->owner, -1);
527 if (0 != t->napps && t->apps)
528 GNUNET_free (t->apps);
535 * Get the peer descriptor for the peer with id from the given tunnel
536 * @param t Tunnel handle
537 * @param id Short form ID of the wanted peer
538 * @return handle to the requested peer or NULL if not found
540 static struct GNUNET_MESH_Peer *
541 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
545 for (i = 0; i < t->npeers; i++)
546 if (t->peers[i]->id == id)
553 * Add a peer into a tunnel
554 * @param t Tunnel handle
555 * @param pi Full ID of the new peer
556 * @return handle to the newly created peer
558 static struct GNUNET_MESH_Peer *
559 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
560 const struct GNUNET_PeerIdentity *pi)
562 struct GNUNET_MESH_Peer *p;
570 id = GNUNET_PEER_intern (pi);
572 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
575 GNUNET_array_append (t->peers, t->npeers, p);
581 * Remove a peer from a tunnel
582 * @param p Peer handle
585 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
589 for (i = 0; i < p->t->npeers; i++)
591 if (p->t->peers[i] == p)
594 if (i == p->t->npeers)
599 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
600 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
605 * Notify client that the transmission has timed out
608 * @param tc task context
611 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
613 struct GNUNET_MESH_TransmitHandle *th = cls;
614 struct GNUNET_MESH_Handle *mesh;
616 mesh = th->tunnel->mesh;
617 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
618 th->tunnel->packet_size = 0;
619 if (GNUNET_YES == th_is_payload (th))
620 th->notify (th->notify_cls, 0, NULL);
622 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
624 /* nothing ready to transmit, no point in asking for transmission */
625 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
632 * Add a transmit handle to the transmission queue by priority and set the
635 * @param h mesh handle with the queue head and tail
636 * @param th handle to the packet to be transmitted
639 add_to_queue (struct GNUNET_MESH_Handle *h,
640 struct GNUNET_MESH_TransmitHandle *th)
642 struct GNUNET_MESH_TransmitHandle *p;
651 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
652 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
655 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
656 (th->timeout), &timeout_transmission, th);
661 * Auxiliary function to send an already constructed packet to the service.
662 * Takes care of creating a new queue element, copying the message and
663 * calling the tmt_rdy function if necessary.
665 * @param h mesh handle
666 * @param msg message to transmit
667 * @param tunnel tunnel this send is related to (NULL if N/A)
670 send_packet (struct GNUNET_MESH_Handle *h,
671 const struct GNUNET_MessageHeader *msg,
672 struct GNUNET_MESH_Tunnel *tunnel);
676 * Send an ack on the tunnel to confirm the processing of a message.
678 * @param h Mesh handle.
679 * @param t Tunnel on which to send the ACK.
682 send_ack (struct GNUNET_MESH_Handle *h, struct GNUNET_MESH_Tunnel *t)
684 struct GNUNET_MESH_LocalAck msg;
686 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
687 msg.header.size = htons (sizeof (msg));
688 msg.tunnel_id = htonl (t->tid);
689 msg.max_pid = t->pid + 1;
691 send_packet (h, &msg.header, t);
698 * Reconnect callback: tries to reconnect again after a failer previous
700 * @param cls closure (mesh handle)
701 * @param tc task context
704 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
708 * Send a connect packet to the service with the applications and types
709 * requested by the user.
711 * @param h The mesh handle.
715 send_connect (struct GNUNET_MESH_Handle *h)
719 size = sizeof (struct GNUNET_MESH_ClientConnect);
720 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
721 size += h->n_handlers * sizeof (uint16_t);
723 char buf[size] GNUNET_ALIGN;
724 struct GNUNET_MESH_ClientConnect *msg;
725 GNUNET_MESH_ApplicationType *apps;
730 /* build connection packet */
731 msg = (struct GNUNET_MESH_ClientConnect *) buf;
732 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
733 msg->header.size = htons (size);
734 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
735 for (napps = 0; napps < h->n_applications; napps++)
737 apps[napps] = htonl (h->applications[napps]);
738 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
740 types = (uint16_t *) & apps[napps];
741 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
742 types[ntypes] = htons (h->message_handlers[ntypes].type);
743 msg->applications = htons (napps);
744 msg->types = htons (ntypes);
745 LOG (GNUNET_ERROR_TYPE_DEBUG,
746 "Sending %lu bytes long message %d types and %d apps\n",
747 ntohs (msg->header.size), ntypes, napps);
748 send_packet (h, &msg->header, NULL);
754 * Reconnect to the service, retransmit all infomation to try to restore the
757 * @param h handle to the mesh
759 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
762 do_reconnect (struct GNUNET_MESH_Handle *h)
764 struct GNUNET_MESH_Tunnel *t;
767 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
768 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
769 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
770 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
771 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
776 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
779 if (NULL != h->client)
781 GNUNET_CLIENT_disconnect (h->client);
785 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
786 if (h->client == NULL)
788 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
791 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
792 GNUNET_TIME_relative_multiply
793 (h->reconnect_time, 2));
794 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
795 GNUNET_TIME_relative_to_string (h->reconnect_time));
801 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
804 /* Rebuild all tunnels */
805 for (t = h->tunnels_head; NULL != t; t = t->next)
807 struct GNUNET_MESH_TunnelMessage tmsg;
808 struct GNUNET_MESH_PeerControl pmsg;
810 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
812 /* Tunnel was created by service (incoming tunnel) */
813 /* TODO: Notify service of missing tunnel, to request
814 * creator to recreate path (find a path to him via DHT?)
818 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
819 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
820 tmsg.tunnel_id = htonl (t->tid);
821 send_packet (h, &tmsg.header, t);
823 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
824 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
825 pmsg.tunnel_id = htonl (t->tid);
827 /* Reconnect all peers */
828 /* If the tunnel was "by type", dont connect individual peers */
829 for (i = 0; i < t->npeers && 0 == t->napps; i++)
831 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
832 if (NULL != t->disconnect_handler && t->peers[i]->connected)
833 t->disconnect_handler (t->cls, &pmsg.peer);
834 send_packet (t->mesh, &pmsg.header, t);
836 /* Reconnect all types, if any */
837 for (i = 0; i < t->napps; i++)
839 struct GNUNET_MESH_ConnectPeerByType msg;
841 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
842 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
843 msg.tunnel_id = htonl (t->tid);
844 msg.type = htonl (t->apps[i]);
845 send_packet (t->mesh, &msg.header, t);
847 if (GNUNET_NO == t->buffering)
848 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
849 if (GNUNET_YES == t->speed_min)
850 GNUNET_MESH_tunnel_speed_min (t);
856 * Reconnect callback: tries to reconnect again after a failer previous
858 * @param cls closure (mesh handle)
859 * @param tc task context
862 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
864 struct GNUNET_MESH_Handle *h = cls;
866 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
867 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
874 * Reconnect to the service, retransmit all infomation to try to restore the
877 * @param h handle to the mesh
879 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
882 reconnect (struct GNUNET_MESH_Handle *h)
884 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
885 h->in_receive = GNUNET_NO;
886 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
887 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
892 /******************************************************************************/
893 /*********************** RECEIVE HANDLERS ****************************/
894 /******************************************************************************/
897 * Process the new tunnel notification and add it to the tunnels in the handle
899 * @param h The mesh handle
900 * @param msg A message with the details of the new incoming tunnel
903 process_tunnel_created (struct GNUNET_MESH_Handle *h,
904 const struct GNUNET_MESH_TunnelNotification *msg)
906 struct GNUNET_MESH_Tunnel *t;
907 MESH_TunnelNumber tid;
909 tid = ntohl (msg->tunnel_id);
910 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
915 if (NULL != h->new_tunnel)
917 struct GNUNET_ATS_Information atsi;
919 t = create_tunnel (h, tid);
920 t->owner = GNUNET_PEER_intern (&msg->peer);
922 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
923 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
925 t->peers[0]->connected = 1;
926 t->peers[0]->id = t->owner;
927 GNUNET_PEER_change_rc (t->owner, 1);
932 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
933 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
937 struct GNUNET_MESH_TunnelMessage d_msg;
939 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
941 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
942 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
943 d_msg.tunnel_id = msg->tunnel_id;
945 send_packet (h, &d_msg.header, NULL);
952 * Process the tunnel destroy notification and free associated resources
954 * @param h The mesh handle
955 * @param msg A message with the details of the tunnel being destroyed
958 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
959 const struct GNUNET_MESH_TunnelMessage *msg)
961 struct GNUNET_MESH_Tunnel *t;
962 MESH_TunnelNumber tid;
964 tid = ntohl (msg->tunnel_id);
965 t = retrieve_tunnel (h, tid);
975 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
976 destroy_tunnel (t, GNUNET_YES);
982 * Process the new peer event and notify the upper level of it
984 * @param h The mesh handle
985 * @param msg A message with the details of the peer event
988 process_peer_event (struct GNUNET_MESH_Handle *h,
989 const struct GNUNET_MESH_PeerControl *msg)
991 struct GNUNET_MESH_Tunnel *t;
992 struct GNUNET_MESH_Peer *p;
993 struct GNUNET_ATS_Information atsi;
997 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
998 size = ntohs (msg->header.size);
999 if (size != sizeof (struct GNUNET_MESH_PeerControl))
1004 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1010 id = GNUNET_PEER_search (&msg->peer);
1011 if ((p = retrieve_peer (t, id)) == NULL)
1012 p = add_peer_to_tunnel (t, &msg->peer);
1013 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
1015 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
1016 if (NULL != t->connect_handler)
1020 t->connect_handler (t->cls, &msg->peer, &atsi);
1026 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
1027 if (NULL != t->disconnect_handler && p->connected)
1029 t->disconnect_handler (t->cls, &msg->peer);
1031 remove_peer_from_tunnel (p);
1034 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
1039 * Process the incoming data packets
1041 * @param h The mesh handle
1042 * @param message A message encapsulating the data
1044 * @return GNUNET_YES if everything went fine
1045 * GNUNET_NO if client closed connection (h no longer valid)
1048 process_incoming_data (struct GNUNET_MESH_Handle *h,
1049 const struct GNUNET_MessageHeader *message)
1051 const struct GNUNET_MessageHeader *payload;
1052 const struct GNUNET_MESH_MessageHandler *handler;
1053 const struct GNUNET_PeerIdentity *peer;
1054 struct GNUNET_MESH_Unicast *ucast;
1055 struct GNUNET_MESH_Multicast *mcast;
1056 struct GNUNET_MESH_ToOrigin *to_orig;
1057 struct GNUNET_MESH_Tunnel *t;
1061 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1062 type = ntohs (message->type);
1065 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1066 ucast = (struct GNUNET_MESH_Unicast *) message;
1068 t = retrieve_tunnel (h, ntohl (ucast->tid));
1069 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1071 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1072 GNUNET_i2s (peer), ntohl (ucast->tid));
1074 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1075 mcast = (struct GNUNET_MESH_Multicast *) message;
1076 t = retrieve_tunnel (h, ntohl (mcast->tid));
1077 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1079 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1080 GNUNET_i2s (peer), ntohl (mcast->tid));
1082 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1083 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1084 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1085 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1086 peer = &to_orig->sender;
1087 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1088 GNUNET_i2s (peer), ntohl (to_orig->tid));
1096 /* Tunnel was ignored, probably service didn't get it yet */
1099 type = ntohs (payload->type);
1100 for (i = 0; i < h->n_handlers; i++)
1102 handler = &h->message_handlers[i];
1103 if (handler->type == type)
1105 struct GNUNET_ATS_Information atsi;
1110 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1112 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1113 GNUNET_MESH_disconnect (h);
1118 LOG (GNUNET_ERROR_TYPE_DEBUG,
1119 "callback completed successfully\n");
1129 * Process a local ACK message, enabling the client to send
1130 * more data to the service.
1132 * @param h Mesh handle.
1133 * @param message Message itself.
1136 process_ack (struct GNUNET_MESH_Handle *h,
1137 const struct GNUNET_MessageHeader *message)
1139 struct GNUNET_MESH_LocalAck *msg;
1140 struct GNUNET_MESH_Tunnel *t;
1143 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1144 msg = (struct GNUNET_MESH_LocalAck *) message;
1146 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1150 LOG (GNUNET_ERROR_TYPE_WARNING,
1151 "ACK on unknown tunnel %X\n",
1152 ntohl (msg->tunnel_id));
1155 ack = ntohl (msg->max_pid);
1156 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X, ack %u!\n", t->tid, ack);
1157 if (ack > t->max_pid || PID_OVERFLOW (t->max_pid, ack))
1161 if (NULL == h->th && 0 < t->packet_size)
1163 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n", t->tid, ack);
1165 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1166 GNUNET_TIME_UNIT_FOREVER_REL,
1167 GNUNET_YES, &send_callback, h);
1173 * Function to process all messages received from the service
1175 * @param cls closure
1176 * @param msg message received, NULL on timeout or fatal error
1179 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1181 struct GNUNET_MESH_Handle *h = cls;
1185 LOG (GNUNET_ERROR_TYPE_WARNING, "Received NULL msg on %p\n", h);
1189 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %hu from MESH\n",
1191 switch (ntohs (msg->type))
1193 /* Notify of a new incoming tunnel */
1194 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1195 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1197 /* Notify of a tunnel disconnection */
1198 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1199 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1201 /* Notify of a new peer or a peer disconnect in the tunnel */
1202 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1203 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1204 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1206 /* Notify of a new data packet in the tunnel */
1207 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1208 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1209 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1210 if (GNUNET_NO == process_incoming_data (h, msg))
1213 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1214 process_ack (h, msg);
1217 /* We shouldn't get any other packages, log and ignore */
1218 LOG (GNUNET_ERROR_TYPE_WARNING,
1219 "unsolicited message form service (type %d)\n",
1222 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1223 if (GNUNET_YES == h->in_receive)
1225 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1226 GNUNET_TIME_UNIT_FOREVER_REL);
1230 LOG (GNUNET_ERROR_TYPE_DEBUG,
1231 "in receive off, not calling CLIENT_receive\n");
1236 /******************************************************************************/
1237 /************************ SEND FUNCTIONS ****************************/
1238 /******************************************************************************/
1241 * Function called to send a message to the service.
1242 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1245 * @param cls closure, the mesh handle
1246 * @param size number of bytes available in buf
1247 * @param buf where the callee should write the connect message
1248 * @return number of bytes written to buf
1251 send_callback (void *cls, size_t size, void *buf)
1253 struct GNUNET_MESH_Handle *h = cls;
1254 struct GNUNET_MESH_TransmitHandle *th;
1255 struct GNUNET_MESH_TransmitHandle *next;
1256 struct GNUNET_MESH_Tunnel *t;
1261 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1262 if ((0 == size) || (NULL == buf))
1264 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback on %p\n", h);
1271 while ((NULL != (th = next)) && (size >= th->size))
1274 if (GNUNET_YES == th_is_payload (th))
1276 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1277 if (t->max_pid < t->pid && ! PID_OVERFLOW (t->pid, t->max_pid)) {
1278 /* This tunnel is not ready to transmit yet, try next message */
1283 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1285 /* traffic to origin */
1286 struct GNUNET_MESH_ToOrigin to;
1287 struct GNUNET_MessageHeader *mh;
1289 GNUNET_assert (size >= th->size);
1290 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1291 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1292 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %u\n",
1296 psize += sizeof (to);
1297 GNUNET_assert (size >= psize);
1298 to.header.size = htons (psize);
1299 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1300 to.tid = htonl (t->tid);
1302 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1303 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1304 memcpy (cbuf, &to, sizeof (to));
1307 else if (th->target == 0)
1310 struct GNUNET_MESH_Multicast mc;
1311 struct GNUNET_MessageHeader *mh;
1313 GNUNET_assert (size >= th->size);
1314 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1315 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1316 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %u\n",
1320 psize += sizeof (mc);
1321 GNUNET_assert (size >= psize);
1322 mc.header.size = htons (psize);
1323 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1324 mc.tid = htonl (t->tid);
1325 mc.pid = htonl (t->pid);
1327 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1328 memcpy (cbuf, &mc, sizeof (mc));
1334 struct GNUNET_MESH_Unicast uc;
1335 struct GNUNET_MessageHeader *mh;
1337 GNUNET_assert (size >= th->size);
1338 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1339 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1340 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %u\n",
1344 psize += sizeof (uc);
1345 GNUNET_assert (size >= psize);
1346 uc.header.size = htons (psize);
1347 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1348 uc.tid = htonl (t->tid);
1349 uc.pid = htonl (t->pid);
1350 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1351 GNUNET_PEER_resolve (th->target, &uc.destination);
1352 memcpy (cbuf, &uc, sizeof (uc));
1359 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1361 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %u\n",
1363 memcpy (cbuf, &th[1], th->size);
1366 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1367 GNUNET_SCHEDULER_cancel (th->timeout_task);
1368 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1375 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1377 size = message_ready_size (h);
1380 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", size);
1382 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1383 GNUNET_TIME_UNIT_FOREVER_REL,
1384 GNUNET_YES, &send_callback, h);
1388 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1390 if (GNUNET_NO == h->in_receive)
1392 LOG (GNUNET_ERROR_TYPE_DEBUG, " start receiving from service\n");
1393 h->in_receive = GNUNET_YES;
1394 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1395 GNUNET_TIME_UNIT_FOREVER_REL);
1397 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1403 * Auxiliary function to send an already constructed packet to the service.
1404 * Takes care of creating a new queue element, copying the message and
1405 * calling the tmt_rdy function if necessary.
1407 * @param h mesh handle
1408 * @param msg message to transmit
1409 * @param tunnel tunnel this send is related to (NULL if N/A)
1412 send_packet (struct GNUNET_MESH_Handle *h,
1413 const struct GNUNET_MessageHeader *msg,
1414 struct GNUNET_MESH_Tunnel *tunnel)
1416 struct GNUNET_MESH_TransmitHandle *th;
1419 msize = ntohs (msg->size);
1420 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1421 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1423 th->tunnel = tunnel;
1424 memcpy (&th[1], msg, msize);
1425 add_to_queue (h, th);
1429 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1430 GNUNET_TIME_UNIT_FOREVER_REL,
1431 GNUNET_YES, &send_callback, h);
1435 /******************************************************************************/
1436 /********************** API CALL DEFINITIONS *************************/
1437 /******************************************************************************/
1440 * Connect to the mesh service.
1442 * @param cfg configuration to use
1443 * @param cls closure for the various callbacks that follow
1444 * (including handlers in the handlers array)
1445 * @param new_tunnel function called when an *inbound* tunnel is created
1446 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1447 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1448 * is called on the tunnel
1449 * @param handlers callbacks for messages we care about, NULL-terminated
1450 * note that the mesh is allowed to drop notifications about
1451 * inbound messages if the client does not process them fast
1452 * enough (for this notification type, a bounded queue is used)
1453 * @param stypes list of the applications that this client claims to provide
1454 * @return handle to the mesh service NULL on error
1455 * (in this case, init is never called)
1457 struct GNUNET_MESH_Handle *
1458 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1459 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1460 GNUNET_MESH_TunnelEndHandler cleaner,
1461 const struct GNUNET_MESH_MessageHandler *handlers,
1462 const GNUNET_MESH_ApplicationType *stypes)
1464 struct GNUNET_MESH_Handle *h;
1466 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1467 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1468 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1470 h->new_tunnel = new_tunnel;
1471 h->cleaner = cleaner;
1472 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1473 if (h->client == NULL)
1481 h->applications = stypes;
1482 h->message_handlers = handlers;
1483 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1484 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1485 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1487 /* count handlers and apps, calculate size */
1488 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1489 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1491 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1497 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1498 * disconnect callbacks will be called on any still connected peers, notifying
1499 * about their disconnection. The registered inbound tunnel cleaner will be
1500 * called should any inbound tunnels still exist.
1502 * @param handle connection to mesh to disconnect
1505 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1507 struct GNUNET_MESH_Tunnel *t;
1508 struct GNUNET_MESH_Tunnel *aux;
1509 struct GNUNET_MESH_TransmitHandle *th;
1511 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1513 t = handle->tunnels_head;
1517 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1520 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1522 destroy_tunnel (t, GNUNET_YES);
1525 while ( (th = handle->th_head) != NULL)
1527 struct GNUNET_MessageHeader *msg;
1529 /* Make sure it is an allowed packet (everything else should have been
1530 * already canceled).
1532 GNUNET_break (GNUNET_NO == th_is_payload (th));
1533 msg = (struct GNUNET_MessageHeader *) &th[1];
1534 switch (ntohs(msg->type))
1536 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1537 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1541 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1545 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1549 if (NULL != handle->th)
1551 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1554 if (NULL != handle->client)
1556 GNUNET_CLIENT_disconnect (handle->client);
1557 handle->client = NULL;
1559 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1561 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1562 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1564 GNUNET_free (handle);
1569 * Announce to ther peer the availability of services described by the regex,
1570 * in order to be reachable to other peers via connect_by_string.
1572 * Note that the first 8 characters are considered to be part of a prefix,
1573 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1574 * all matching strings will be stored in the DHT.
1576 * @param h handle to mesh.
1577 * @param regex string with the regular expression describing local services.
1580 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1583 struct GNUNET_MessageHeader *msg;
1587 len = strlen (regex);
1588 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1589 GNUNET_assert (UINT16_MAX > msgsize);
1592 char buffer[msgsize];
1594 msg = (struct GNUNET_MessageHeader *) buffer;
1595 msg->size = htons (msgsize);
1596 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1597 memcpy (&msg[1], regex, len);
1599 send_packet(h, msg, NULL);
1604 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1605 * and to broadcast).
1607 * @param h mesh handle
1608 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1609 * @param connect_handler function to call when peers are actually connected
1610 * @param disconnect_handler function to call when peers are disconnected
1611 * @param handler_cls closure for connect/disconnect handlers
1613 struct GNUNET_MESH_Tunnel *
1614 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1615 GNUNET_MESH_PeerConnectHandler connect_handler,
1616 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1619 struct GNUNET_MESH_Tunnel *t;
1620 struct GNUNET_MESH_TunnelMessage msg;
1622 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1623 t = create_tunnel (h, 0);
1624 t->connect_handler = connect_handler;
1625 t->disconnect_handler = disconnect_handler;
1626 t->cls = handler_cls;
1627 t->ctx = tunnel_ctx;
1628 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1629 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1630 msg.tunnel_id = htonl (t->tid);
1631 send_packet (h, &msg.header, t);
1637 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1640 * @param tunnel tunnel handle
1643 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1645 struct GNUNET_MESH_Handle *h;
1646 struct GNUNET_MESH_TunnelMessage msg;
1647 struct GNUNET_MESH_TransmitHandle *th;
1649 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1652 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1653 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1654 msg.tunnel_id = htonl (tunnel->tid);
1658 struct GNUNET_MESH_TransmitHandle *aux;
1659 if (th->tunnel == tunnel)
1662 /* FIXME call the handler? */
1663 if (GNUNET_YES == th_is_payload (th))
1664 th->notify (th->notify_cls, 0, NULL);
1665 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1673 destroy_tunnel (tunnel, GNUNET_NO);
1674 send_packet (h, &msg.header, NULL);
1678 * Request that the tunnel data rate is limited to the speed of the slowest
1681 * @param tunnel Tunnel affected.
1684 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1686 struct GNUNET_MESH_TunnelMessage msg;
1687 struct GNUNET_MESH_Handle *h;
1690 tunnel->speed_min = GNUNET_YES;
1692 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1693 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1694 msg.tunnel_id = htonl (tunnel->tid);
1696 send_packet (h, &msg.header, NULL);
1701 * Request that the tunnel data rate is limited to the speed of the fastest
1702 * receiver. This is the default behavior.
1704 * @param tunnel Tunnel affected.
1707 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1709 struct GNUNET_MESH_TunnelMessage msg;
1710 struct GNUNET_MESH_Handle *h;
1713 tunnel->speed_min = GNUNET_NO;
1715 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1716 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1717 msg.tunnel_id = htonl (tunnel->tid);
1719 send_packet (h, &msg.header, NULL);
1723 * Turn on/off the buffering status of the tunnel.
1725 * @param tunnel Tunnel affected.
1726 * @param buffer GNUNET_YES to turn buffering on (default),
1727 * GNUNET_NO otherwise.
1730 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1732 struct GNUNET_MESH_TunnelMessage msg;
1733 struct GNUNET_MESH_Handle *h;
1736 tunnel->buffering = buffer;
1738 if (GNUNET_YES == buffer)
1739 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1741 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1742 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1743 msg.tunnel_id = htonl (tunnel->tid);
1745 send_packet (h, &msg.header, NULL);
1749 * Request that a peer should be added to the tunnel. The existing
1750 * connect handler will be called ONCE with either success or failure.
1751 * This function should NOT be called again with the same peer before the
1752 * connect handler is called.
1754 * @param tunnel handle to existing tunnel
1755 * @param peer peer to add
1758 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1759 const struct GNUNET_PeerIdentity *peer)
1761 struct GNUNET_MESH_PeerControl msg;
1762 GNUNET_PEER_Id peer_id;
1765 peer_id = GNUNET_PEER_intern (peer);
1766 for (i = 0; i < tunnel->npeers; i++)
1768 if (tunnel->peers[i]->id == peer_id)
1770 /* Peer already exists in tunnel */
1771 GNUNET_PEER_change_rc (peer_id, -1);
1776 if (NULL == add_peer_to_tunnel (tunnel, peer))
1779 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1780 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1781 msg.tunnel_id = htonl (tunnel->tid);
1783 send_packet (tunnel->mesh, &msg.header, tunnel);
1790 * Request that a peer should be removed from the tunnel. The existing
1791 * disconnect handler will be called ONCE if we were connected.
1793 * @param tunnel handle to existing tunnel
1794 * @param peer peer to remove
1797 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1798 const struct GNUNET_PeerIdentity *peer)
1800 struct GNUNET_MESH_PeerControl msg;
1801 GNUNET_PEER_Id peer_id;
1804 peer_id = GNUNET_PEER_search (peer);
1810 for (i = 0; i < tunnel->npeers; i++)
1811 if (tunnel->peers[i]->id == peer_id)
1813 if (i == tunnel->npeers)
1818 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1819 tunnel->disconnect_handler (tunnel->cls, peer);
1820 GNUNET_PEER_change_rc (peer_id, -1);
1821 GNUNET_free (tunnel->peers[i]);
1822 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1823 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1825 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1826 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1827 msg.tunnel_id = htonl (tunnel->tid);
1828 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1829 send_packet (tunnel->mesh, &msg.header, tunnel);
1834 * Request that the mesh should try to connect to a peer supporting the given
1837 * @param tunnel handle to existing tunnel
1838 * @param app_type application type that must be supported by the peer (MESH
1839 * should discover peer in proximity handling this type)
1842 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1843 GNUNET_MESH_ApplicationType app_type)
1845 struct GNUNET_MESH_ConnectPeerByType msg;
1847 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1849 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1850 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1851 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1852 msg.tunnel_id = htonl (tunnel->tid);
1853 msg.type = htonl (app_type);
1854 send_packet (tunnel->mesh, &msg.header, tunnel);
1859 * Request that the mesh should try to connect to a peer matching the
1860 * description given in the service string.
1862 * FIXME: allow multiple? how to deal with reconnect?
1864 * @param tunnel handle to existing tunnel
1865 * @param description string describing the destination node requirements
1868 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1869 const char *description)
1871 struct GNUNET_MESH_ConnectPeerByString *m;
1875 len = strlen (description);
1876 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1877 GNUNET_assert (UINT16_MAX > msgsize);
1879 char buffer[msgsize];
1881 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1882 m->header.size = htons (msgsize);
1883 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1884 m->tunnel_id = htonl (tunnel->tid);
1885 memcpy(&m[1], description, len);
1887 send_packet (tunnel->mesh, &m->header, tunnel);
1893 * Request that the given peer isn't added to this tunnel in calls to
1894 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1896 * @param tunnel handle to existing tunnel.
1897 * @param peer peer identity of the peer which should be blacklisted
1901 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1902 const struct GNUNET_PeerIdentity *peer)
1904 struct GNUNET_MESH_PeerControl msg;
1906 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1907 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1908 msg.tunnel_id = htonl (tunnel->tid);
1910 send_packet (tunnel->mesh, &msg.header, tunnel);
1917 * Request that the given peer isn't blacklisted anymore from this tunnel,
1918 * and therefore can be added in future calls to connect_by_*.
1919 * The peer must have been previously blacklisted for this tunnel.
1921 * @param tunnel handle to existing tunnel.
1922 * @param peer peer identity of the peer which shouldn't be blacklisted
1923 * for the tunnel anymore.
1926 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1927 const struct GNUNET_PeerIdentity *peer)
1929 struct GNUNET_MESH_PeerControl msg;
1931 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1932 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1933 msg.tunnel_id = htonl (tunnel->tid);
1935 send_packet (tunnel->mesh, &msg.header, tunnel);
1942 * Ask the mesh to call "notify" once it is ready to transmit the
1943 * given number of bytes to the specified tunnel or target.
1944 * Only one call can be active at any time, to issue another request,
1945 * wait for the callback or cancel the current request.
1947 * @param tunnel tunnel to use for transmission
1948 * @param cork is corking allowed for this transmission?
1949 * @param maxdelay how long can the message wait?
1950 * @param target destination for the message
1951 * NULL for multicast to all tunnel targets
1952 * @param notify_size how many bytes of buffer space does notify want?
1953 * @param notify function to call when buffer space is available;
1954 * will be called with NULL on timeout or if the overall queue
1955 * for this peer is larger than queue_size and this is currently
1956 * the message with the lowest priority
1957 * @param notify_cls closure for notify
1958 * @return non-NULL if the notify callback was queued,
1959 * NULL if we can not even queue the request (insufficient
1960 * memory); if NULL is returned, "notify" will NOT be called.
1962 struct GNUNET_MESH_TransmitHandle *
1963 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1964 struct GNUNET_TIME_Relative maxdelay,
1965 const struct GNUNET_PeerIdentity *target,
1967 GNUNET_CONNECTION_TransmitReadyNotify notify,
1970 struct GNUNET_MESH_TransmitHandle *th;
1973 GNUNET_assert (NULL != tunnel);
1974 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1976 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1978 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1979 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
1980 GNUNET_assert (NULL != notify);
1981 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
1982 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1983 th->tunnel = tunnel;
1984 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1985 th->target = GNUNET_PEER_intern (target);
1986 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1987 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1988 else if (NULL == target)
1989 overhead = sizeof (struct GNUNET_MESH_Multicast);
1991 overhead = sizeof (struct GNUNET_MESH_Unicast);
1992 tunnel->packet_size = th->size = notify_size + overhead;
1993 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
1994 th->notify = notify;
1995 th->notify_cls = notify_cls;
1996 add_to_queue (tunnel->mesh, th);
1997 if (NULL != tunnel->mesh->th)
1999 LOG (GNUNET_ERROR_TYPE_DEBUG, " call notify tmt rdy\n");
2001 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
2002 GNUNET_TIME_UNIT_FOREVER_REL,
2003 GNUNET_YES, &send_callback,
2010 * Cancel the specified transmission-ready notification.
2012 * @param th handle that was returned by "notify_transmit_ready".
2015 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
2017 struct GNUNET_MESH_Handle *mesh;
2019 mesh = th->tunnel->mesh;
2020 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
2021 GNUNET_SCHEDULER_cancel (th->timeout_task);
2022 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
2024 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
2026 /* queue empty, no point in asking for transmission */
2027 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
2034 * Transition API for tunnel ctx management
2037 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2043 * Transition API for tunnel ctx management
2046 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)