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__)
44 #define DEBUG_ACK GNUNET_YES
46 /******************************************************************************/
47 /************************ DATA STRUCTURES ****************************/
48 /******************************************************************************/
51 * Transmission queue to the service
53 struct GNUNET_MESH_TransmitHandle
59 struct GNUNET_MESH_TransmitHandle *next;
64 struct GNUNET_MESH_TransmitHandle *prev;
67 * Tunnel this message is sent on / for (may be NULL for control messages).
69 struct GNUNET_MESH_Tunnel *tunnel;
72 * Callback to obtain the message to transmit, or NULL if we
73 * got the message in 'data'. Notice that messages built
74 * by 'notify' need to be encapsulated with information about
77 GNUNET_CONNECTION_TransmitReadyNotify notify;
80 * Closure for 'notify'
85 * How long is this message valid. Once the timeout has been
86 * reached, the message must no longer be sent. If this
87 * is a message with a 'notify' callback set, the 'notify'
88 * function should be called with 'buf' NULL and size 0.
90 struct GNUNET_TIME_Absolute timeout;
93 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
95 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
98 * Target of the message, 0 for multicast. This field
99 * is only valid if 'notify' is non-NULL.
101 GNUNET_PEER_Id target;
104 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
111 * Opaque handle to the service.
113 struct GNUNET_MESH_Handle
117 * Handle to the server connection, to send messages later
119 struct GNUNET_CLIENT_Connection *client;
122 * Set of handlers used for processing incoming messages in the tunnels
124 const struct GNUNET_MESH_MessageHandler *message_handlers;
127 * Set of applications that should be claimed to be offered at this node.
128 * Note that this is just informative, the appropiate handlers must be
129 * registered independently and the mapping is up to the developer of the
130 * client application.
132 const GNUNET_MESH_ApplicationType *applications;
135 * Double linked list of the tunnels this client is connected to, head.
137 struct GNUNET_MESH_Tunnel *tunnels_head;
140 * Double linked list of the tunnels this client is connected to, tail.
142 struct GNUNET_MESH_Tunnel *tunnels_tail;
145 * Callback for inbound tunnel creation
147 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
150 * Callback for inbound tunnel disconnection
152 GNUNET_MESH_TunnelEndHandler *cleaner;
155 * Handle to cancel pending transmissions in case of disconnection
157 struct GNUNET_CLIENT_TransmitHandle *th;
160 * Closure for all the handlers given by the client
165 * Messages to send to the service, head.
167 struct GNUNET_MESH_TransmitHandle *th_head;
170 * Messages to send to the service, tail.
172 struct GNUNET_MESH_TransmitHandle *th_tail;
175 * tid of the next tunnel to create (to avoid reusing IDs often)
177 MESH_TunnelNumber next_tid;
180 * Number of handlers in the handlers array.
182 unsigned int n_handlers;
185 * Number of applications in the applications array.
187 unsigned int n_applications;
190 * Have we started the task to receive messages from the service
191 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
196 * Configuration given by the client, in case of reconnection
198 const struct GNUNET_CONFIGURATION_Handle *cfg;
201 * Time to the next reconnect in case one reconnect fails
203 struct GNUNET_TIME_Relative reconnect_time;
206 * Task for trying to reconnect.
208 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
211 unsigned int acks_sent;
212 unsigned int acks_recv;
218 * Description of a peer
220 struct GNUNET_MESH_Peer
223 * ID of the peer in short form
228 * Tunnel this peer belongs to
230 struct GNUNET_MESH_Tunnel *t;
233 * Flag indicating whether service has informed about its connection
241 * Opaque handle to a tunnel.
243 struct GNUNET_MESH_Tunnel
249 struct GNUNET_MESH_Tunnel *next;
254 struct GNUNET_MESH_Tunnel *prev;
257 * Callback to execute when peers connect to the tunnel
259 GNUNET_MESH_PeerConnectHandler connect_handler;
262 * Callback to execute when peers disconnect from the tunnel
264 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
267 * Closure for the connect/disconnect handlers
272 * Handle to the mesh this tunnel belongs to
274 struct GNUNET_MESH_Handle *mesh;
277 * Local ID of the tunnel
279 MESH_TunnelNumber tid;
282 * Owner of the tunnel. 0 if the tunnel is the local client.
284 GNUNET_PEER_Id owner;
287 * All peers added to the tunnel
289 struct GNUNET_MESH_Peer **peers;
292 * List of application types that have been requested for this tunnel
294 GNUNET_MESH_ApplicationType *apps;
297 * Any data the caller wants to put in here
302 * Number of peers added to the tunnel
307 * Size of packet queued in this tunnel
309 unsigned int packet_size;
312 * Number of applications requested this tunnel
317 * Is the tunnel throttled to the slowest peer?
322 * Is the tunnel allowed to buffer?
327 * Next packet ID to send.
329 uint32_t next_send_pid;
332 * Maximum allowed PID to send (ACK recevied).
334 uint32_t max_send_pid;
337 * Last pid received from the service.
339 uint32_t last_recv_pid;
342 * Which ACK value have we last sent to the service?
344 uint32_t max_recv_pid;
348 /******************************************************************************/
349 /*********************** DECLARATIONS *************************/
350 /******************************************************************************/
353 * Function called to send a message to the service.
354 * "buf" will be NULL and "size" zero if the socket was closed for writing in
357 * @param cls closure, the mesh handle
358 * @param size number of bytes available in buf
359 * @param buf where the callee should write the connect message
360 * @return number of bytes written to buf
363 send_callback (void *cls, size_t size, void *buf);
366 /******************************************************************************/
367 /*********************** AUXILIARY FUNCTIONS *************************/
368 /******************************************************************************/
371 * Check if transmission is a payload packet.
373 * @param th Transmission handle.
375 * @return GNUNET_YES if it is a payload packet,
376 * GNUNET_NO if it is a mesh management packet.
379 th_is_payload (struct GNUNET_MESH_TransmitHandle *th)
381 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
386 * Check whether there is any message ready in the queue and find the size.
388 * @param h Mesh handle.
390 * @return The size of the first ready message in the queue,
391 * 0 if there is none.
394 message_ready_size (struct GNUNET_MESH_Handle *h)
396 struct GNUNET_MESH_TransmitHandle *th;
397 struct GNUNET_MESH_Tunnel *t;
399 for (th = h->th_head; NULL != th; th = th->next)
402 if (GNUNET_NO == th_is_payload (th))
404 LOG (GNUNET_ERROR_TYPE_DEBUG, " message internal\n");
407 if (GNUNET_NO == GMC_is_pid_bigger(t->next_send_pid, t->max_send_pid))
409 LOG (GNUNET_ERROR_TYPE_DEBUG, " message payload ok (%u <= %u)\n",
410 t->next_send_pid, t->max_send_pid);
419 * Get the tunnel handler for the tunnel specified by id from the given handle
420 * @param h Mesh handle
421 * @param tid ID of the wanted tunnel
422 * @return handle to the required tunnel or NULL if not found
424 static struct GNUNET_MESH_Tunnel *
425 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
427 struct GNUNET_MESH_Tunnel *t;
441 * Create a new tunnel and insert it in the tunnel list of the mesh handle
442 * @param h Mesh handle
443 * @param tid desired tid of the tunnel, 0 to assign one automatically
444 * @return handle to the created tunnel
446 static struct GNUNET_MESH_Tunnel *
447 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
449 struct GNUNET_MESH_Tunnel *t;
451 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
452 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
456 t->tid = h->next_tid;
457 while (NULL != retrieve_tunnel (h, h->next_tid))
460 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
461 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
468 t->max_send_pid = INITIAL_WINDOW_SIZE - 1;
469 t->last_recv_pid = (uint32_t) -1;
470 t->buffering = GNUNET_YES;
476 * Destroy the specified tunnel.
477 * - Destroys all peers, calling the disconnect callback on each if needed
478 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
479 * - Calls cleaner if tunnel was inbound
480 * - Frees all memory used
482 * @param t Pointer to the tunnel.
483 * @param call_cleaner Whether to call the cleaner handler.
485 * @return Handle to the required tunnel or NULL if not found.
488 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
490 struct GNUNET_MESH_Handle *h;
491 struct GNUNET_PeerIdentity pi;
492 struct GNUNET_MESH_TransmitHandle *th;
493 struct GNUNET_MESH_TransmitHandle *next;
496 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
505 /* disconnect all peers */
506 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
507 for (i = 0; i < t->npeers; i++)
509 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
511 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
512 t->disconnect_handler (t->cls, &pi);
514 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
515 GNUNET_free (t->peers[i]);
518 /* signal tunnel destruction */
519 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
520 h->cleaner (h->cls, t, t->ctx);
522 /* check that clients did not leave messages behind in the queue */
523 for (th = h->th_head; NULL != th; th = next)
528 /* Clients should have aborted their requests already.
529 * Management traffic should be ok, as clients can't cancel that */
530 GNUNET_break (GNUNET_NO == th_is_payload(th));
531 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
533 /* clean up request */
534 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
535 GNUNET_SCHEDULER_cancel (th->timeout_task);
539 /* if there are no more pending requests with mesh service, cancel active request */
540 /* Note: this should be unnecessary... */
541 if ((0 == message_ready_size (h)) && (NULL != h->th))
543 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
549 GNUNET_free (t->peers);
551 GNUNET_PEER_change_rc (t->owner, -1);
552 if (0 != t->napps && t->apps)
553 GNUNET_free (t->apps);
560 * Get the peer descriptor for the peer with id from the given tunnel
561 * @param t Tunnel handle
562 * @param id Short form ID of the wanted peer
563 * @return handle to the requested peer or NULL if not found
565 static struct GNUNET_MESH_Peer *
566 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
570 for (i = 0; i < t->npeers; i++)
571 if (t->peers[i]->id == id)
578 * Add a peer into a tunnel
579 * @param t Tunnel handle
580 * @param pi Full ID of the new peer
581 * @return handle to the newly created peer
583 static struct GNUNET_MESH_Peer *
584 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
585 const struct GNUNET_PeerIdentity *pi)
587 struct GNUNET_MESH_Peer *p;
595 id = GNUNET_PEER_intern (pi);
597 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
600 GNUNET_array_append (t->peers, t->npeers, p);
606 * Remove a peer from a tunnel
607 * @param p Peer handle
610 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
614 for (i = 0; i < p->t->npeers; i++)
616 if (p->t->peers[i] == p)
619 if (i == p->t->npeers)
624 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
625 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
630 * Notify client that the transmission has timed out
633 * @param tc task context
636 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
638 struct GNUNET_MESH_TransmitHandle *th = cls;
639 struct GNUNET_MESH_Handle *mesh;
641 mesh = th->tunnel->mesh;
642 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
643 th->tunnel->packet_size = 0;
644 if (GNUNET_YES == th_is_payload (th))
645 th->notify (th->notify_cls, 0, NULL);
647 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
649 /* nothing ready to transmit, no point in asking for transmission */
650 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
657 * Add a transmit handle to the transmission queue and set the
660 * @param h mesh handle with the queue head and tail
661 * @param th handle to the packet to be transmitted
664 add_to_queue (struct GNUNET_MESH_Handle *h,
665 struct GNUNET_MESH_TransmitHandle *th)
667 GNUNET_CONTAINER_DLL_insert_tail (h->th_head, h->th_tail, th);
668 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
671 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
672 (th->timeout), &timeout_transmission, th);
677 * Auxiliary function to send an already constructed packet to the service.
678 * Takes care of creating a new queue element, copying the message and
679 * calling the tmt_rdy function if necessary.
681 * @param h mesh handle
682 * @param msg message to transmit
683 * @param tunnel tunnel this send is related to (NULL if N/A)
686 send_packet (struct GNUNET_MESH_Handle *h,
687 const struct GNUNET_MessageHeader *msg,
688 struct GNUNET_MESH_Tunnel *tunnel);
692 * Send an ack on the tunnel to confirm the processing of a message.
694 * @param h Mesh handle.
695 * @param t Tunnel on which to send the ACK.
698 send_ack (struct GNUNET_MESH_Handle *h, struct GNUNET_MESH_Tunnel *t)
700 struct GNUNET_MESH_LocalAck msg;
703 delta = t->max_recv_pid - t->last_recv_pid;
704 if (delta > ACK_THRESHOLD)
706 LOG (GNUNET_ERROR_TYPE_DEBUG,
707 "Not sending ACK on tunnel %X: ACK: %u, PID: %u, buffer %u\n",
708 t->tid, t->max_recv_pid, t->last_recv_pid, delta);
711 if (GNUNET_YES == t->buffering)
712 t->max_recv_pid = t->last_recv_pid + INITIAL_WINDOW_SIZE;
714 t->max_recv_pid = t->last_recv_pid + 1;
715 LOG (GNUNET_ERROR_TYPE_DEBUG,
716 "Sending ACK on tunnel %X: %u\n",
717 t->tid, t->max_recv_pid);
718 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
719 msg.header.size = htons (sizeof (msg));
720 msg.tunnel_id = htonl (t->tid);
721 msg.max_pid = htonl (t->max_recv_pid);
724 t->mesh->acks_sent++;
727 send_packet (h, &msg.header, t);
734 * Reconnect callback: tries to reconnect again after a failer previous
736 * @param cls closure (mesh handle)
737 * @param tc task context
740 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
744 * Send a connect packet to the service with the applications and types
745 * requested by the user.
747 * @param h The mesh handle.
751 send_connect (struct GNUNET_MESH_Handle *h)
755 size = sizeof (struct GNUNET_MESH_ClientConnect);
756 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
757 size += h->n_handlers * sizeof (uint16_t);
759 char buf[size] GNUNET_ALIGN;
760 struct GNUNET_MESH_ClientConnect *msg;
761 GNUNET_MESH_ApplicationType *apps;
766 /* build connection packet */
767 msg = (struct GNUNET_MESH_ClientConnect *) buf;
768 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
769 msg->header.size = htons (size);
770 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
771 for (napps = 0; napps < h->n_applications; napps++)
773 apps[napps] = htonl (h->applications[napps]);
774 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n",
775 h->applications[napps]);
777 types = (uint16_t *) & apps[napps];
778 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
780 types[ntypes] = htons (h->message_handlers[ntypes].type);
781 LOG (GNUNET_ERROR_TYPE_DEBUG, " type %u\n",
782 h->message_handlers[ntypes].type);
784 msg->applications = htons (napps);
785 msg->types = htons (ntypes);
786 LOG (GNUNET_ERROR_TYPE_DEBUG,
787 "Sending %lu bytes long message %d types and %d apps\n",
788 ntohs (msg->header.size), ntypes, napps);
789 send_packet (h, &msg->header, NULL);
795 * Reconnect to the service, retransmit all infomation to try to restore the
798 * @param h handle to the mesh
800 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
803 do_reconnect (struct GNUNET_MESH_Handle *h)
805 struct GNUNET_MESH_Tunnel *t;
808 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
809 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
810 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
811 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
812 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
817 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
820 if (NULL != h->client)
822 GNUNET_CLIENT_disconnect (h->client);
826 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
827 if (h->client == NULL)
829 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
832 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
833 GNUNET_TIME_relative_multiply
834 (h->reconnect_time, 2));
835 LOG (GNUNET_ERROR_TYPE_DEBUG,
836 "Next retry in %s\n",
837 GNUNET_STRINGS_relative_time_to_string (h->reconnect_time,
844 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
847 /* Rebuild all tunnels */
848 for (t = h->tunnels_head; NULL != t; t = t->next)
850 struct GNUNET_MESH_TunnelMessage tmsg;
851 struct GNUNET_MESH_PeerControl pmsg;
853 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
855 /* Tunnel was created by service (incoming tunnel) */
856 /* TODO: Notify service of missing tunnel, to request
857 * creator to recreate path (find a path to him via DHT?)
861 t->next_send_pid = 0;
862 t->max_send_pid = INITIAL_WINDOW_SIZE - 1;
863 t->last_recv_pid = (uint32_t) -1;
864 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
865 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
866 tmsg.tunnel_id = htonl (t->tid);
867 send_packet (h, &tmsg.header, t);
869 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
870 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
871 pmsg.tunnel_id = htonl (t->tid);
873 /* Reconnect all peers */
874 /* If the tunnel was "by type", dont connect individual peers */
875 for (i = 0; i < t->npeers && 0 == t->napps; i++)
877 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
878 if (NULL != t->disconnect_handler && t->peers[i]->connected)
879 t->disconnect_handler (t->cls, &pmsg.peer);
880 send_packet (t->mesh, &pmsg.header, t);
882 /* Reconnect all types, if any */
883 for (i = 0; i < t->napps; i++)
885 struct GNUNET_MESH_ConnectPeerByType msg;
887 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
888 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
889 msg.tunnel_id = htonl (t->tid);
890 msg.type = htonl (t->apps[i]);
891 send_packet (t->mesh, &msg.header, t);
893 if (GNUNET_NO == t->buffering)
894 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
895 if (GNUNET_YES == t->speed_min)
896 GNUNET_MESH_tunnel_speed_min (t);
902 * Reconnect callback: tries to reconnect again after a failer previous
904 * @param cls closure (mesh handle)
905 * @param tc task context
908 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
910 struct GNUNET_MESH_Handle *h = cls;
912 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
913 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
920 * Reconnect to the service, retransmit all infomation to try to restore the
923 * @param h handle to the mesh
925 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
928 reconnect (struct GNUNET_MESH_Handle *h)
930 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
931 h->in_receive = GNUNET_NO;
932 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
933 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
938 /******************************************************************************/
939 /*********************** RECEIVE HANDLERS ****************************/
940 /******************************************************************************/
943 * Process the new tunnel notification and add it to the tunnels in the handle
945 * @param h The mesh handle
946 * @param msg A message with the details of the new incoming tunnel
949 process_tunnel_created (struct GNUNET_MESH_Handle *h,
950 const struct GNUNET_MESH_TunnelNotification *msg)
952 struct GNUNET_MESH_Tunnel *t;
953 MESH_TunnelNumber tid;
955 tid = ntohl (msg->tunnel_id);
956 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming tunnel %X\n", tid);
957 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
962 if (NULL != h->new_tunnel)
964 struct GNUNET_ATS_Information atsi;
966 t = create_tunnel (h, tid);
967 t->owner = GNUNET_PEER_intern (&msg->peer);
969 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
970 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
972 t->peers[0]->connected = 1;
973 t->peers[0]->id = t->owner;
974 GNUNET_PEER_change_rc (t->owner, 1);
977 if ((msg->opt & MESH_TUNNEL_OPT_NOBUFFER) != 0)
978 t->buffering = GNUNET_NO;
980 t->buffering = GNUNET_YES;
981 if ((msg->opt & MESH_TUNNEL_OPT_SPEED_MIN) != 0)
982 t->speed_min = GNUNET_YES;
985 LOG (GNUNET_ERROR_TYPE_DEBUG, " created tunnel %p\n", t);
986 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
987 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
991 struct GNUNET_MESH_TunnelMessage d_msg;
993 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
995 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
996 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
997 d_msg.tunnel_id = msg->tunnel_id;
999 send_packet (h, &d_msg.header, NULL);
1006 * Process the tunnel destroy notification and free associated resources
1008 * @param h The mesh handle
1009 * @param msg A message with the details of the tunnel being destroyed
1012 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
1013 const struct GNUNET_MESH_TunnelMessage *msg)
1015 struct GNUNET_MESH_Tunnel *t;
1016 MESH_TunnelNumber tid;
1018 tid = ntohl (msg->tunnel_id);
1019 t = retrieve_tunnel (h, tid);
1029 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
1030 destroy_tunnel (t, GNUNET_YES);
1036 * Process the new peer event and notify the upper level of it
1038 * @param h The mesh handle
1039 * @param msg A message with the details of the peer event
1042 process_peer_event (struct GNUNET_MESH_Handle *h,
1043 const struct GNUNET_MESH_PeerControl *msg)
1045 struct GNUNET_MESH_Tunnel *t;
1046 struct GNUNET_MESH_Peer *p;
1047 struct GNUNET_ATS_Information atsi;
1051 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
1052 size = ntohs (msg->header.size);
1053 if (size != sizeof (struct GNUNET_MESH_PeerControl))
1058 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1064 id = GNUNET_PEER_search (&msg->peer);
1065 if ((p = retrieve_peer (t, id)) == NULL)
1066 p = add_peer_to_tunnel (t, &msg->peer);
1067 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
1069 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
1070 if (NULL != t->connect_handler)
1074 t->connect_handler (t->cls, &msg->peer, &atsi);
1080 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
1081 if (NULL != t->disconnect_handler && p->connected)
1083 t->disconnect_handler (t->cls, &msg->peer);
1085 remove_peer_from_tunnel (p);
1088 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
1093 * Process the incoming data packets
1095 * @param h The mesh handle
1096 * @param message A message encapsulating the data
1098 * @return GNUNET_YES if everything went fine
1099 * GNUNET_NO if client closed connection (h no longer valid)
1102 process_incoming_data (struct GNUNET_MESH_Handle *h,
1103 const struct GNUNET_MessageHeader *message)
1105 const struct GNUNET_MessageHeader *payload;
1106 const struct GNUNET_MESH_MessageHandler *handler;
1107 const struct GNUNET_PeerIdentity *peer;
1108 struct GNUNET_MESH_Unicast *ucast;
1109 struct GNUNET_MESH_Multicast *mcast;
1110 struct GNUNET_MESH_ToOrigin *to_orig;
1111 struct GNUNET_MESH_Tunnel *t;
1116 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1117 type = ntohs (message->type);
1120 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1121 ucast = (struct GNUNET_MESH_Unicast *) message;
1123 t = retrieve_tunnel (h, ntohl (ucast->tid));
1124 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1126 pid = ntohl (ucast->pid);
1127 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1128 GNUNET_i2s (peer), ntohl (ucast->tid));
1130 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1131 mcast = (struct GNUNET_MESH_Multicast *) message;
1132 t = retrieve_tunnel (h, ntohl (mcast->tid));
1133 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1135 pid = ntohl (mcast->pid);
1136 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1137 GNUNET_i2s (peer), ntohl (mcast->tid));
1139 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1140 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1141 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1142 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1143 peer = &to_orig->sender;
1144 pid = ntohl (to_orig->pid);
1145 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1146 GNUNET_i2s (peer), ntohl (to_orig->tid));
1152 LOG (GNUNET_ERROR_TYPE_DEBUG, " pid %u\n", pid);
1155 /* Tunnel was ignored/destroyed, probably service didn't get it yet */
1156 LOG (GNUNET_ERROR_TYPE_DEBUG, " ignored!\n");
1160 GMC_is_pid_bigger(pid, t->max_recv_pid))
1163 LOG (GNUNET_ERROR_TYPE_WARNING,
1164 " unauthorized message! (%u, max %u)\n",
1165 pid, t->max_recv_pid);
1166 // FIXME fc what now? accept? reject?
1169 t->last_recv_pid = pid;
1170 type = ntohs (payload->type);
1172 for (i = 0; i < h->n_handlers; i++)
1174 handler = &h->message_handlers[i];
1175 if (handler->type == type)
1177 struct GNUNET_ATS_Information atsi;
1182 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1184 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1185 GNUNET_MESH_disconnect (h);
1190 LOG (GNUNET_ERROR_TYPE_DEBUG,
1191 "callback completed successfully\n");
1200 * Process a local ACK message, enabling the client to send
1201 * more data to the service.
1203 * @param h Mesh handle.
1204 * @param message Message itself.
1207 process_ack (struct GNUNET_MESH_Handle *h,
1208 const struct GNUNET_MessageHeader *message)
1210 struct GNUNET_MESH_LocalAck *msg;
1211 struct GNUNET_MESH_Tunnel *t;
1214 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1216 msg = (struct GNUNET_MESH_LocalAck *) message;
1218 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1222 LOG (GNUNET_ERROR_TYPE_WARNING,
1223 "ACK on unknown tunnel %X\n",
1224 ntohl (msg->tunnel_id));
1227 ack = ntohl (msg->max_pid);
1228 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X, ack %u!\n", t->tid, ack);
1229 if (GNUNET_YES == GMC_is_pid_bigger(ack, t->max_send_pid))
1230 t->max_send_pid = ack;
1233 if (NULL == h->th && 0 < t->packet_size)
1235 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n", t->tid, ack);
1237 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1238 GNUNET_TIME_UNIT_FOREVER_REL,
1239 GNUNET_YES, &send_callback, h);
1245 * Function to process all messages received from the service
1247 * @param cls closure
1248 * @param msg message received, NULL on timeout or fatal error
1251 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1253 struct GNUNET_MESH_Handle *h = cls;
1257 LOG (GNUNET_ERROR_TYPE_WARNING, "Received NULL msg on %p\n", h);
1261 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n",
1262 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1263 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1264 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1265 switch (ntohs (msg->type))
1267 /* Notify of a new incoming tunnel */
1268 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1269 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1271 /* Notify of a tunnel disconnection */
1272 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1273 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1275 /* Notify of a new peer or a peer disconnect in the tunnel */
1276 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1277 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1278 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1280 /* Notify of a new data packet in the tunnel */
1281 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1282 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1283 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1284 if (GNUNET_NO == process_incoming_data (h, msg))
1287 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1288 process_ack (h, msg);
1291 /* We shouldn't get any other packages, log and ignore */
1292 LOG (GNUNET_ERROR_TYPE_WARNING,
1293 "unsolicited message form service (type %hu)\n",
1296 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1297 if (GNUNET_YES == h->in_receive)
1299 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1300 GNUNET_TIME_UNIT_FOREVER_REL);
1304 LOG (GNUNET_ERROR_TYPE_DEBUG,
1305 "in receive off, not calling CLIENT_receive\n");
1310 /******************************************************************************/
1311 /************************ SEND FUNCTIONS ****************************/
1312 /******************************************************************************/
1315 * Function called to send a message to the service.
1316 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1319 * @param cls closure, the mesh handle
1320 * @param size number of bytes available in buf
1321 * @param buf where the callee should write the connect message
1322 * @return number of bytes written to buf
1325 send_callback (void *cls, size_t size, void *buf)
1327 struct GNUNET_MESH_Handle *h = cls;
1328 struct GNUNET_MESH_TransmitHandle *th;
1329 struct GNUNET_MESH_TransmitHandle *next;
1330 struct GNUNET_MESH_Tunnel *t;
1336 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1337 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1338 if ((0 == size) || (NULL == buf))
1340 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback on %p\n", h);
1347 nsize = message_ready_size (h);
1348 while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1351 if (GNUNET_YES == th_is_payload (th))
1353 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1354 if (GNUNET_YES == GMC_is_pid_bigger(t->next_send_pid, t->max_send_pid))
1356 /* This tunnel is not ready to transmit yet, try next message */
1361 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1363 /* traffic to origin */
1364 struct GNUNET_MESH_ToOrigin to;
1365 struct GNUNET_MessageHeader *mh;
1367 GNUNET_assert (size >= th->size);
1368 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1369 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1370 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %s\n",
1371 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1374 psize += sizeof (to);
1375 GNUNET_assert (size >= psize);
1376 to.header.size = htons (psize);
1377 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1378 to.tid = htonl (t->tid);
1379 to.pid = htonl (t->next_send_pid);
1381 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1382 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1383 memcpy (cbuf, &to, sizeof (to));
1386 else if (th->target == 0)
1389 struct GNUNET_MESH_Multicast mc;
1390 struct GNUNET_MessageHeader *mh;
1392 GNUNET_assert (size >= th->size);
1393 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1394 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1395 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %s\n",
1396 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1399 psize += sizeof (mc);
1400 GNUNET_assert (size >= psize);
1401 mc.header.size = htons (psize);
1402 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1403 mc.tid = htonl (t->tid);
1404 mc.pid = htonl (t->next_send_pid);
1406 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1407 memcpy (cbuf, &mc, sizeof (mc));
1413 struct GNUNET_MESH_Unicast uc;
1414 struct GNUNET_MessageHeader *mh;
1416 GNUNET_assert (size >= th->size);
1417 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1418 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1419 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %s\n",
1420 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1423 psize += sizeof (uc);
1424 GNUNET_assert (size >= psize);
1425 uc.header.size = htons (psize);
1426 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1427 uc.tid = htonl (t->tid);
1428 uc.pid = htonl (t->next_send_pid);
1430 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1431 GNUNET_PEER_resolve (th->target, &uc.destination);
1432 memcpy (cbuf, &uc, sizeof (uc));
1439 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1441 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %s\n",
1442 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1443 memcpy (cbuf, &th[1], th->size);
1446 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1447 GNUNET_SCHEDULER_cancel (th->timeout_task);
1448 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1451 nsize = message_ready_size (h);
1456 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1458 size = message_ready_size (h);
1461 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", size);
1463 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1464 GNUNET_TIME_UNIT_FOREVER_REL,
1465 GNUNET_YES, &send_callback, h);
1469 if (NULL != h->th_head)
1470 LOG (GNUNET_ERROR_TYPE_DEBUG, " can't transmit any more\n");
1472 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1474 if (GNUNET_NO == h->in_receive)
1476 LOG (GNUNET_ERROR_TYPE_DEBUG, " start receiving from service\n");
1477 h->in_receive = GNUNET_YES;
1478 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1479 GNUNET_TIME_UNIT_FOREVER_REL);
1481 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1487 * Auxiliary function to send an already constructed packet to the service.
1488 * Takes care of creating a new queue element, copying the message and
1489 * calling the tmt_rdy function if necessary.
1491 * @param h mesh handle
1492 * @param msg message to transmit
1493 * @param tunnel tunnel this send is related to (NULL if N/A)
1496 send_packet (struct GNUNET_MESH_Handle *h,
1497 const struct GNUNET_MessageHeader *msg,
1498 struct GNUNET_MESH_Tunnel *tunnel)
1500 struct GNUNET_MESH_TransmitHandle *th;
1503 LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1504 GNUNET_MESH_DEBUG_M2S(ntohs(msg->type)));
1505 msize = ntohs (msg->size);
1506 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1507 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1509 th->tunnel = tunnel;
1510 memcpy (&th[1], msg, msize);
1511 add_to_queue (h, th);
1512 LOG (GNUNET_ERROR_TYPE_DEBUG, " queued\n");
1515 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling ntfy tmt rdy for %u bytes\n", msize);
1517 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1518 GNUNET_TIME_UNIT_FOREVER_REL,
1519 GNUNET_YES, &send_callback, h);
1523 /******************************************************************************/
1524 /********************** API CALL DEFINITIONS *************************/
1525 /******************************************************************************/
1528 * Connect to the mesh service.
1530 * @param cfg configuration to use
1531 * @param cls closure for the various callbacks that follow
1532 * (including handlers in the handlers array)
1533 * @param new_tunnel function called when an *inbound* tunnel is created
1534 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1535 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1536 * is called on the tunnel
1537 * @param handlers callbacks for messages we care about, NULL-terminated
1538 * note that the mesh is allowed to drop notifications about
1539 * inbound messages if the client does not process them fast
1540 * enough (for this notification type, a bounded queue is used)
1541 * @param stypes list of the applications that this client claims to provide
1542 * @return handle to the mesh service NULL on error
1543 * (in this case, init is never called)
1545 struct GNUNET_MESH_Handle *
1546 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1547 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1548 GNUNET_MESH_TunnelEndHandler cleaner,
1549 const struct GNUNET_MESH_MessageHandler *handlers,
1550 const GNUNET_MESH_ApplicationType *stypes)
1552 struct GNUNET_MESH_Handle *h;
1554 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1555 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1556 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1558 h->new_tunnel = new_tunnel;
1559 h->cleaner = cleaner;
1560 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1561 if (h->client == NULL)
1569 h->applications = stypes;
1570 h->message_handlers = handlers;
1571 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1572 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1573 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1575 /* count handlers and apps, calculate size */
1576 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1577 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1579 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1585 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1586 * disconnect callbacks will be called on any still connected peers, notifying
1587 * about their disconnection. The registered inbound tunnel cleaner will be
1588 * called should any inbound tunnels still exist.
1590 * @param handle connection to mesh to disconnect
1593 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1595 struct GNUNET_MESH_Tunnel *t;
1596 struct GNUNET_MESH_Tunnel *aux;
1597 struct GNUNET_MESH_TransmitHandle *th;
1599 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1602 LOG (GNUNET_ERROR_TYPE_INFO, "Sent %d ACKs\n", handle->acks_sent);
1603 LOG (GNUNET_ERROR_TYPE_INFO, "Recv %d ACKs\n\n", handle->acks_recv);
1606 t = handle->tunnels_head;
1610 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1613 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1615 destroy_tunnel (t, GNUNET_YES);
1618 while ( (th = handle->th_head) != NULL)
1620 struct GNUNET_MessageHeader *msg;
1622 /* Make sure it is an allowed packet (everything else should have been
1623 * already canceled).
1625 GNUNET_break (GNUNET_NO == th_is_payload (th));
1626 msg = (struct GNUNET_MessageHeader *) &th[1];
1627 switch (ntohs(msg->type))
1629 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1630 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1634 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1638 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1642 if (NULL != handle->th)
1644 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1647 if (NULL != handle->client)
1649 GNUNET_CLIENT_disconnect (handle->client);
1650 handle->client = NULL;
1652 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1654 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1655 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1657 GNUNET_free (handle);
1662 * Announce to ther peer the availability of services described by the regex,
1663 * in order to be reachable to other peers via connect_by_string.
1665 * Note that the first 8 characters are considered to be part of a prefix,
1666 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1667 * all matching strings will be stored in the DHT.
1669 * @param h Handle to mesh.
1670 * @param regex String with the regular expression describing local services.
1671 * @param compression_characters How many characters can be assigned to one
1672 * edge of the graph. The bigger the variability
1673 * of the data, the smaller this parameter should
1675 * For maximum compression, use strlen (regex)
1676 * or 0 (special value). Use with care!
1679 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1681 unsigned int compression_characters)
1683 struct GNUNET_MESH_RegexAnnounce *msg;
1687 len = strlen (regex);
1688 msgsize = sizeof(struct GNUNET_MESH_RegexAnnounce) + len;
1689 GNUNET_assert (UINT16_MAX > msgsize);
1692 char buffer[msgsize];
1694 msg = (struct GNUNET_MESH_RegexAnnounce *) buffer;
1695 msg->header.size = htons (msgsize);
1696 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1697 msg->compression_characters = htons (compression_characters);
1698 memcpy (&msg[1], regex, len);
1700 send_packet(h, &msg->header, NULL);
1705 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1706 * and to broadcast).
1708 * @param h mesh handle
1709 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1710 * @param connect_handler function to call when peers are actually connected
1711 * @param disconnect_handler function to call when peers are disconnected
1712 * @param handler_cls closure for connect/disconnect handlers
1714 struct GNUNET_MESH_Tunnel *
1715 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1716 GNUNET_MESH_PeerConnectHandler connect_handler,
1717 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1720 struct GNUNET_MESH_Tunnel *t;
1721 struct GNUNET_MESH_TunnelMessage msg;
1723 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1724 t = create_tunnel (h, 0);
1725 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", t);
1726 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n", t->tid);
1727 t->connect_handler = connect_handler;
1728 t->disconnect_handler = disconnect_handler;
1729 t->cls = handler_cls;
1730 t->ctx = tunnel_ctx;
1731 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1732 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1733 msg.tunnel_id = htonl (t->tid);
1734 send_packet (h, &msg.header, t);
1740 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1743 * @param tunnel tunnel handle
1746 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1748 struct GNUNET_MESH_Handle *h;
1749 struct GNUNET_MESH_TunnelMessage msg;
1750 struct GNUNET_MESH_TransmitHandle *th;
1752 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1755 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1756 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1757 msg.tunnel_id = htonl (tunnel->tid);
1761 struct GNUNET_MESH_TransmitHandle *aux;
1762 if (th->tunnel == tunnel)
1765 /* FIXME call the handler? */
1766 if (GNUNET_YES == th_is_payload (th))
1767 th->notify (th->notify_cls, 0, NULL);
1768 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1776 destroy_tunnel (tunnel, GNUNET_NO);
1777 send_packet (h, &msg.header, NULL);
1781 * Request that the tunnel data rate is limited to the speed of the slowest
1784 * @param tunnel Tunnel affected.
1787 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1789 struct GNUNET_MESH_TunnelMessage msg;
1790 struct GNUNET_MESH_Handle *h;
1793 tunnel->speed_min = GNUNET_YES;
1795 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1796 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1797 msg.tunnel_id = htonl (tunnel->tid);
1799 send_packet (h, &msg.header, NULL);
1804 * Request that the tunnel data rate is limited to the speed of the fastest
1805 * receiver. This is the default behavior.
1807 * @param tunnel Tunnel affected.
1810 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1812 struct GNUNET_MESH_TunnelMessage msg;
1813 struct GNUNET_MESH_Handle *h;
1816 tunnel->speed_min = GNUNET_NO;
1818 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1819 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1820 msg.tunnel_id = htonl (tunnel->tid);
1822 send_packet (h, &msg.header, NULL);
1826 * Turn on/off the buffering status of the tunnel.
1828 * @param tunnel Tunnel affected.
1829 * @param buffer GNUNET_YES to turn buffering on (default),
1830 * GNUNET_NO otherwise.
1833 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1835 struct GNUNET_MESH_TunnelMessage msg;
1836 struct GNUNET_MESH_Handle *h;
1839 tunnel->buffering = buffer;
1840 tunnel->max_send_pid = tunnel->next_send_pid;
1842 if (GNUNET_YES == buffer)
1843 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1845 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1846 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1847 msg.tunnel_id = htonl (tunnel->tid);
1849 send_packet (h, &msg.header, NULL);
1853 * Request that a peer should be added to the tunnel. The existing
1854 * connect handler will be called ONCE with either success or failure.
1855 * This function should NOT be called again with the same peer before the
1856 * connect handler is called.
1858 * @param tunnel handle to existing tunnel
1859 * @param peer peer to add
1862 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1863 const struct GNUNET_PeerIdentity *peer)
1865 struct GNUNET_MESH_PeerControl msg;
1866 GNUNET_PEER_Id peer_id;
1869 peer_id = GNUNET_PEER_intern (peer);
1870 for (i = 0; i < tunnel->npeers; i++)
1872 if (tunnel->peers[i]->id == peer_id)
1874 /* Peer already exists in tunnel */
1875 GNUNET_PEER_change_rc (peer_id, -1);
1880 if (NULL == add_peer_to_tunnel (tunnel, peer))
1883 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1884 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1885 msg.tunnel_id = htonl (tunnel->tid);
1887 send_packet (tunnel->mesh, &msg.header, tunnel);
1894 * Request that a peer should be removed from the tunnel. The existing
1895 * disconnect handler will be called ONCE if we were connected.
1897 * @param tunnel handle to existing tunnel
1898 * @param peer peer to remove
1901 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1902 const struct GNUNET_PeerIdentity *peer)
1904 struct GNUNET_MESH_PeerControl msg;
1905 GNUNET_PEER_Id peer_id;
1908 peer_id = GNUNET_PEER_search (peer);
1914 for (i = 0; i < tunnel->npeers; i++)
1915 if (tunnel->peers[i]->id == peer_id)
1917 if (i == tunnel->npeers)
1922 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1923 tunnel->disconnect_handler (tunnel->cls, peer);
1924 GNUNET_PEER_change_rc (peer_id, -1);
1925 GNUNET_free (tunnel->peers[i]);
1926 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1927 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1929 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1930 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1931 msg.tunnel_id = htonl (tunnel->tid);
1932 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1933 send_packet (tunnel->mesh, &msg.header, tunnel);
1938 * Request that the mesh should try to connect to a peer supporting the given
1941 * @param tunnel handle to existing tunnel
1942 * @param app_type application type that must be supported by the peer (MESH
1943 * should discover peer in proximity handling this type)
1946 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1947 GNUNET_MESH_ApplicationType app_type)
1949 struct GNUNET_MESH_ConnectPeerByType msg;
1951 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1953 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1954 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1955 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1956 msg.tunnel_id = htonl (tunnel->tid);
1957 msg.type = htonl (app_type);
1958 send_packet (tunnel->mesh, &msg.header, tunnel);
1963 * Request that the mesh should try to connect to a peer matching the
1964 * description given in the service string.
1966 * FIXME: allow multiple? how to deal with reconnect?
1968 * @param tunnel handle to existing tunnel
1969 * @param description string describing the destination node requirements
1972 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1973 const char *description)
1975 struct GNUNET_MESH_ConnectPeerByString *m;
1979 len = strlen (description);
1980 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1981 GNUNET_assert (UINT16_MAX > msgsize);
1983 char buffer[msgsize];
1985 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1986 m->header.size = htons (msgsize);
1987 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1988 m->tunnel_id = htonl (tunnel->tid);
1989 memcpy(&m[1], description, len);
1991 send_packet (tunnel->mesh, &m->header, tunnel);
1997 * Request that the given peer isn't added to this tunnel in calls to
1998 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
2000 * @param tunnel handle to existing tunnel.
2001 * @param peer peer identity of the peer which should be blacklisted
2005 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
2006 const struct GNUNET_PeerIdentity *peer)
2008 struct GNUNET_MESH_PeerControl msg;
2010 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
2011 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
2012 msg.tunnel_id = htonl (tunnel->tid);
2014 send_packet (tunnel->mesh, &msg.header, tunnel);
2021 * Request that the given peer isn't blacklisted anymore from this tunnel,
2022 * and therefore can be added in future calls to connect_by_*.
2023 * The peer must have been previously blacklisted for this tunnel.
2025 * @param tunnel handle to existing tunnel.
2026 * @param peer peer identity of the peer which shouldn't be blacklisted
2027 * for the tunnel anymore.
2030 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
2031 const struct GNUNET_PeerIdentity *peer)
2033 struct GNUNET_MESH_PeerControl msg;
2035 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
2036 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
2037 msg.tunnel_id = htonl (tunnel->tid);
2039 send_packet (tunnel->mesh, &msg.header, tunnel);
2046 * Ask the mesh to call "notify" once it is ready to transmit the
2047 * given number of bytes to the specified tunnel or target.
2048 * Only one call can be active at any time, to issue another request,
2049 * wait for the callback or cancel the current request.
2051 * @param tunnel tunnel to use for transmission
2052 * @param cork is corking allowed for this transmission?
2053 * @param maxdelay how long can the message wait?
2054 * @param target destination for the message
2055 * NULL for multicast to all tunnel targets
2056 * @param notify_size how many bytes of buffer space does notify want?
2057 * @param notify function to call when buffer space is available;
2058 * will be called with NULL on timeout or if the overall queue
2059 * for this peer is larger than queue_size and this is currently
2060 * the message with the lowest priority
2061 * @param notify_cls closure for notify
2062 * @return non-NULL if the notify callback was queued,
2063 * NULL if we can not even queue the request (insufficient
2064 * memory); if NULL is returned, "notify" will NOT be called.
2066 struct GNUNET_MESH_TransmitHandle *
2067 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
2068 struct GNUNET_TIME_Relative maxdelay,
2069 const struct GNUNET_PeerIdentity *target,
2071 GNUNET_CONNECTION_TransmitReadyNotify notify,
2074 struct GNUNET_MESH_TransmitHandle *th;
2077 GNUNET_assert (NULL != tunnel);
2078 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY\n");
2079 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X\n", tunnel->tid);
2080 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2081 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
2082 else if (NULL != target)
2083 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
2085 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
2086 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
2087 GNUNET_assert (NULL != notify);
2088 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
2089 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
2090 th->tunnel = tunnel;
2091 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
2092 th->target = GNUNET_PEER_intern (target);
2093 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2094 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
2095 else if (NULL == target)
2096 overhead = sizeof (struct GNUNET_MESH_Multicast);
2098 overhead = sizeof (struct GNUNET_MESH_Unicast);
2099 tunnel->packet_size = th->size = notify_size + overhead;
2100 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
2101 th->notify = notify;
2102 th->notify_cls = notify_cls;
2103 add_to_queue (tunnel->mesh, th);
2104 if (NULL != tunnel->mesh->th)
2106 if (GMC_is_pid_bigger(tunnel->next_send_pid, tunnel->max_send_pid))
2108 LOG (GNUNET_ERROR_TYPE_DEBUG, " call notify tmt rdy\n");
2110 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
2111 GNUNET_TIME_UNIT_FOREVER_REL,
2112 GNUNET_YES, &send_callback,
2114 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY END\n");
2120 * Cancel the specified transmission-ready notification.
2122 * @param th handle that was returned by "notify_transmit_ready".
2125 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
2127 struct GNUNET_MESH_Handle *mesh;
2129 th->tunnel->packet_size = 0;
2130 mesh = th->tunnel->mesh;
2131 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
2132 GNUNET_SCHEDULER_cancel (th->timeout_task);
2133 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
2135 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
2137 /* queue empty, no point in asking for transmission */
2138 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
2145 * Transition API for tunnel ctx management
2148 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2154 * Transition API for tunnel ctx management
2157 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)