2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
4 GNUnet is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published
6 by the Free Software Foundation; either version 3, or (at your
7 option) any later version.
8 GNUnet is distributed in the hope that it will be useful, but
9 WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 General Public License for more details.
12 You should have received a copy of the GNU General Public License
13 along with GNUnet; see the file COPYING. If not, write to the
14 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
15 Boston, MA 02111-1307, USA.
19 * @file mesh/mesh_api.c
20 * @brief mesh api: client implementation of mesh service
21 * @author Bartlomiej Polot
26 * - AUXILIARY FUNCTIONS
29 * - API CALL DEFINITIONS
31 * TODO: add regex to reconnect
34 #include "gnunet_common.h"
35 #include "gnunet_client_lib.h"
36 #include "gnunet_util_lib.h"
37 #include "gnunet_peer_lib.h"
38 #include "gnunet_mesh_service.h"
40 #include "mesh_protocol.h"
42 #define LOG(kind,...) GNUNET_log_from (kind, "mesh-api",__VA_ARGS__)
45 /******************************************************************************/
46 /************************ DATA STRUCTURES ****************************/
47 /******************************************************************************/
50 * Transmission queue to the service
52 struct GNUNET_MESH_TransmitHandle
58 struct GNUNET_MESH_TransmitHandle *next;
63 struct GNUNET_MESH_TransmitHandle *prev;
66 * Tunnel this message is sent on / for (may be NULL for control messages).
68 struct GNUNET_MESH_Tunnel *tunnel;
71 * Callback to obtain the message to transmit, or NULL if we
72 * got the message in 'data'. Notice that messages built
73 * by 'notify' need to be encapsulated with information about
76 GNUNET_CONNECTION_TransmitReadyNotify notify;
79 * Closure for 'notify'
84 * How long is this message valid. Once the timeout has been
85 * reached, the message must no longer be sent. If this
86 * is a message with a 'notify' callback set, the 'notify'
87 * function should be called with 'buf' NULL and size 0.
89 struct GNUNET_TIME_Absolute timeout;
92 * Task triggering a timeout, can be NO_TASK if the timeout is FOREVER.
94 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
97 * Target of the message, 0 for multicast. This field
98 * is only valid if 'notify' is non-NULL.
100 GNUNET_PEER_Id target;
103 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
110 * Opaque handle to the service.
112 struct GNUNET_MESH_Handle
116 * Handle to the server connection, to send messages later
118 struct GNUNET_CLIENT_Connection *client;
121 * Set of handlers used for processing incoming messages in the tunnels
123 const struct GNUNET_MESH_MessageHandler *message_handlers;
126 * Set of applications that should be claimed to be offered at this node.
127 * Note that this is just informative, the appropiate handlers must be
128 * registered independently and the mapping is up to the developer of the
129 * client application.
131 const GNUNET_MESH_ApplicationType *applications;
134 * Double linked list of the tunnels this client is connected to, head.
136 struct GNUNET_MESH_Tunnel *tunnels_head;
139 * Double linked list of the tunnels this client is connected to, tail.
141 struct GNUNET_MESH_Tunnel *tunnels_tail;
144 * Callback for inbound tunnel creation
146 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
149 * Callback for inbound tunnel disconnection
151 GNUNET_MESH_TunnelEndHandler *cleaner;
154 * Handle to cancel pending transmissions in case of disconnection
156 struct GNUNET_CLIENT_TransmitHandle *th;
159 * Closure for all the handlers given by the client
164 * Messages to send to the service, head.
166 struct GNUNET_MESH_TransmitHandle *th_head;
169 * Messages to send to the service, tail.
171 struct GNUNET_MESH_TransmitHandle *th_tail;
174 * tid of the next tunnel to create (to avoid reusing IDs often)
176 MESH_TunnelNumber next_tid;
179 * Number of handlers in the handlers array.
181 unsigned int n_handlers;
184 * Number of applications in the applications array.
186 unsigned int n_applications;
189 * Have we started the task to receive messages from the service
190 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
195 * Configuration given by the client, in case of reconnection
197 const struct GNUNET_CONFIGURATION_Handle *cfg;
200 * Time to the next reconnect in case one reconnect fails
202 struct GNUNET_TIME_Relative reconnect_time;
205 * Task for trying to reconnect.
207 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
212 * Description of a peer
214 struct GNUNET_MESH_Peer
217 * ID of the peer in short form
222 * Tunnel this peer belongs to
224 struct GNUNET_MESH_Tunnel *t;
227 * Flag indicating whether service has informed about its connection
235 * Opaque handle to a tunnel.
237 struct GNUNET_MESH_Tunnel
243 struct GNUNET_MESH_Tunnel *next;
248 struct GNUNET_MESH_Tunnel *prev;
251 * Callback to execute when peers connect to the tunnel
253 GNUNET_MESH_PeerConnectHandler connect_handler;
256 * Callback to execute when peers disconnect from the tunnel
258 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
261 * Closure for the connect/disconnect handlers
266 * Handle to the mesh this tunnel belongs to
268 struct GNUNET_MESH_Handle *mesh;
271 * Local ID of the tunnel
273 MESH_TunnelNumber tid;
276 * Owner of the tunnel. 0 if the tunnel is the local client.
278 GNUNET_PEER_Id owner;
281 * All peers added to the tunnel
283 struct GNUNET_MESH_Peer **peers;
286 * List of application types that have been requested for this tunnel
288 GNUNET_MESH_ApplicationType *apps;
291 * Any data the caller wants to put in here
296 * Number of peers added to the tunnel
301 * Size of packet queued in this tunnel
303 unsigned int packet_size;
306 * Number of applications requested this tunnel
311 * Is the tunnel throttled to the slowest peer?
316 * Is the tunnel allowed to buffer?
321 * Next packet ID to send.
323 uint32_t next_send_pid;
326 * Maximum allowed PID to send (ACK recevied).
328 uint32_t max_send_pid;
331 * Last pid received from the service.
333 uint32_t last_recv_pid;
337 /******************************************************************************/
338 /*********************** DECLARATIONS *************************/
339 /******************************************************************************/
342 * Function called to send a message to the service.
343 * "buf" will be NULL and "size" zero if the socket was closed for writing in
346 * @param cls closure, the mesh handle
347 * @param size number of bytes available in buf
348 * @param buf where the callee should write the connect message
349 * @return number of bytes written to buf
352 send_callback (void *cls, size_t size, void *buf);
355 /******************************************************************************/
356 /*********************** AUXILIARY FUNCTIONS *************************/
357 /******************************************************************************/
360 * Check if transmission is a payload packet.
362 * @param th Transmission handle.
364 * @return GNUNET_YES if it is a payload packet,
365 * GNUNET_NO if it is a mesh management packet.
368 th_is_payload (struct GNUNET_MESH_TransmitHandle *th)
370 return (th->notify != NULL) ? GNUNET_YES : GNUNET_NO;
375 * Check whether there is any message ready in the queue and find the size.
377 * @param h Mesh handle.
379 * @return The size of the first ready message in the queue,
380 * 0 if there is none.
383 message_ready_size (struct GNUNET_MESH_Handle *h)
385 struct GNUNET_MESH_TransmitHandle *th;
386 struct GNUNET_MESH_Tunnel *t;
388 for (th = h->th_head; NULL != th; th = th->next)
391 if (GNUNET_NO == th_is_payload (th))
393 LOG (GNUNET_ERROR_TYPE_DEBUG, " message internal\n");
396 if (GNUNET_NO == GMC_is_pid_bigger(t->next_send_pid, t->max_send_pid))
398 LOG (GNUNET_ERROR_TYPE_DEBUG, " message payload ok (%u <= %u)\n",
399 t->next_send_pid, t->max_send_pid);
408 * Get the tunnel handler for the tunnel specified by id from the given handle
409 * @param h Mesh handle
410 * @param tid ID of the wanted tunnel
411 * @return handle to the required tunnel or NULL if not found
413 static struct GNUNET_MESH_Tunnel *
414 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
416 struct GNUNET_MESH_Tunnel *t;
430 * Create a new tunnel and insert it in the tunnel list of the mesh handle
431 * @param h Mesh handle
432 * @param tid desired tid of the tunnel, 0 to assign one automatically
433 * @return handle to the created tunnel
435 static struct GNUNET_MESH_Tunnel *
436 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
438 struct GNUNET_MESH_Tunnel *t;
440 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
441 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
445 t->tid = h->next_tid;
446 while (NULL != retrieve_tunnel (h, h->next_tid))
449 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
450 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
458 t->last_recv_pid = (uint32_t) -1;
464 * Destroy the specified tunnel.
465 * - Destroys all peers, calling the disconnect callback on each if needed
466 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
467 * - Calls cleaner if tunnel was inbound
468 * - Frees all memory used
470 * @param t Pointer to the tunnel.
471 * @param call_cleaner Whether to call the cleaner handler.
473 * @return Handle to the required tunnel or NULL if not found.
476 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
478 struct GNUNET_MESH_Handle *h;
479 struct GNUNET_PeerIdentity pi;
480 struct GNUNET_MESH_TransmitHandle *th;
481 struct GNUNET_MESH_TransmitHandle *next;
484 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
493 /* disconnect all peers */
494 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
495 for (i = 0; i < t->npeers; i++)
497 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
499 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
500 t->disconnect_handler (t->cls, &pi);
502 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
503 GNUNET_free (t->peers[i]);
506 /* signal tunnel destruction */
507 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
508 h->cleaner (h->cls, t, t->ctx);
510 /* check that clients did not leave messages behind in the queue */
511 for (th = h->th_head; NULL != th; th = next)
516 /* Clients should have aborted their requests already.
517 * Management traffic should be ok, as clients can't cancel that */
518 GNUNET_break (GNUNET_NO == th_is_payload(th));
519 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
521 /* clean up request */
522 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
523 GNUNET_SCHEDULER_cancel (th->timeout_task);
527 /* if there are no more pending requests with mesh service, cancel active request */
528 /* Note: this should be unnecessary... */
529 if ((0 == message_ready_size (h)) && (NULL != h->th))
531 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
537 GNUNET_free (t->peers);
539 GNUNET_PEER_change_rc (t->owner, -1);
540 if (0 != t->napps && t->apps)
541 GNUNET_free (t->apps);
548 * Get the peer descriptor for the peer with id from the given tunnel
549 * @param t Tunnel handle
550 * @param id Short form ID of the wanted peer
551 * @return handle to the requested peer or NULL if not found
553 static struct GNUNET_MESH_Peer *
554 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
558 for (i = 0; i < t->npeers; i++)
559 if (t->peers[i]->id == id)
566 * Add a peer into a tunnel
567 * @param t Tunnel handle
568 * @param pi Full ID of the new peer
569 * @return handle to the newly created peer
571 static struct GNUNET_MESH_Peer *
572 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
573 const struct GNUNET_PeerIdentity *pi)
575 struct GNUNET_MESH_Peer *p;
583 id = GNUNET_PEER_intern (pi);
585 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
588 GNUNET_array_append (t->peers, t->npeers, p);
594 * Remove a peer from a tunnel
595 * @param p Peer handle
598 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
602 for (i = 0; i < p->t->npeers; i++)
604 if (p->t->peers[i] == p)
607 if (i == p->t->npeers)
612 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
613 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
618 * Notify client that the transmission has timed out
621 * @param tc task context
624 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
626 struct GNUNET_MESH_TransmitHandle *th = cls;
627 struct GNUNET_MESH_Handle *mesh;
629 mesh = th->tunnel->mesh;
630 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
631 th->tunnel->packet_size = 0;
632 if (GNUNET_YES == th_is_payload (th))
633 th->notify (th->notify_cls, 0, NULL);
635 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
637 /* nothing ready to transmit, no point in asking for transmission */
638 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
645 * Add a transmit handle to the transmission queue by priority and set the
648 * @param h mesh handle with the queue head and tail
649 * @param th handle to the packet to be transmitted
652 add_to_queue (struct GNUNET_MESH_Handle *h,
653 struct GNUNET_MESH_TransmitHandle *th)
655 struct GNUNET_MESH_TransmitHandle *p;
664 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
665 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
668 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
669 (th->timeout), &timeout_transmission, th);
674 * Auxiliary function to send an already constructed packet to the service.
675 * Takes care of creating a new queue element, copying the message and
676 * calling the tmt_rdy function if necessary.
678 * @param h mesh handle
679 * @param msg message to transmit
680 * @param tunnel tunnel this send is related to (NULL if N/A)
683 send_packet (struct GNUNET_MESH_Handle *h,
684 const struct GNUNET_MessageHeader *msg,
685 struct GNUNET_MESH_Tunnel *tunnel);
689 * Send an ack on the tunnel to confirm the processing of a message.
691 * @param h Mesh handle.
692 * @param t Tunnel on which to send the ACK.
695 send_ack (struct GNUNET_MESH_Handle *h, struct GNUNET_MESH_Tunnel *t)
697 struct GNUNET_MESH_LocalAck msg;
699 LOG (GNUNET_ERROR_TYPE_DEBUG,
700 "Sending ACK on tunnel %X: %u\n",
701 t->tid, t->last_recv_pid + 1);
702 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK);
703 msg.header.size = htons (sizeof (msg));
704 msg.tunnel_id = htonl (t->tid);
705 msg.max_pid = t->last_recv_pid + 1;
707 send_packet (h, &msg.header, t);
714 * Reconnect callback: tries to reconnect again after a failer previous
716 * @param cls closure (mesh handle)
717 * @param tc task context
720 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
724 * Send a connect packet to the service with the applications and types
725 * requested by the user.
727 * @param h The mesh handle.
731 send_connect (struct GNUNET_MESH_Handle *h)
735 size = sizeof (struct GNUNET_MESH_ClientConnect);
736 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
737 size += h->n_handlers * sizeof (uint16_t);
739 char buf[size] GNUNET_ALIGN;
740 struct GNUNET_MESH_ClientConnect *msg;
741 GNUNET_MESH_ApplicationType *apps;
746 /* build connection packet */
747 msg = (struct GNUNET_MESH_ClientConnect *) buf;
748 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
749 msg->header.size = htons (size);
750 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
751 for (napps = 0; napps < h->n_applications; napps++)
753 apps[napps] = htonl (h->applications[napps]);
754 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n",
755 h->applications[napps]);
757 types = (uint16_t *) & apps[napps];
758 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
760 types[ntypes] = htons (h->message_handlers[ntypes].type);
761 LOG (GNUNET_ERROR_TYPE_DEBUG, " type %u\n",
762 h->message_handlers[ntypes].type);
764 msg->applications = htons (napps);
765 msg->types = htons (ntypes);
766 LOG (GNUNET_ERROR_TYPE_DEBUG,
767 "Sending %lu bytes long message %d types and %d apps\n",
768 ntohs (msg->header.size), ntypes, napps);
769 send_packet (h, &msg->header, NULL);
775 * Reconnect to the service, retransmit all infomation to try to restore the
778 * @param h handle to the mesh
780 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
783 do_reconnect (struct GNUNET_MESH_Handle *h)
785 struct GNUNET_MESH_Tunnel *t;
788 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
789 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
790 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
791 LOG (GNUNET_ERROR_TYPE_DEBUG, "******** on %p *******\n", h);
792 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
797 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
800 if (NULL != h->client)
802 GNUNET_CLIENT_disconnect (h->client);
806 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
807 if (h->client == NULL)
809 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
812 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
813 GNUNET_TIME_relative_multiply
814 (h->reconnect_time, 2));
815 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
816 GNUNET_TIME_relative_to_string (h->reconnect_time));
822 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
825 /* Rebuild all tunnels */
826 for (t = h->tunnels_head; NULL != t; t = t->next)
828 struct GNUNET_MESH_TunnelMessage tmsg;
829 struct GNUNET_MESH_PeerControl pmsg;
831 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
833 /* Tunnel was created by service (incoming tunnel) */
834 /* TODO: Notify service of missing tunnel, to request
835 * creator to recreate path (find a path to him via DHT?)
839 t->next_send_pid = 0;
841 t->last_recv_pid = (uint32_t) -1;
842 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
843 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
844 tmsg.tunnel_id = htonl (t->tid);
845 send_packet (h, &tmsg.header, t);
847 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
848 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
849 pmsg.tunnel_id = htonl (t->tid);
851 /* Reconnect all peers */
852 /* If the tunnel was "by type", dont connect individual peers */
853 for (i = 0; i < t->npeers && 0 == t->napps; i++)
855 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
856 if (NULL != t->disconnect_handler && t->peers[i]->connected)
857 t->disconnect_handler (t->cls, &pmsg.peer);
858 send_packet (t->mesh, &pmsg.header, t);
860 /* Reconnect all types, if any */
861 for (i = 0; i < t->napps; i++)
863 struct GNUNET_MESH_ConnectPeerByType msg;
865 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
866 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
867 msg.tunnel_id = htonl (t->tid);
868 msg.type = htonl (t->apps[i]);
869 send_packet (t->mesh, &msg.header, t);
871 if (GNUNET_NO == t->buffering)
872 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
873 if (GNUNET_YES == t->speed_min)
874 GNUNET_MESH_tunnel_speed_min (t);
880 * Reconnect callback: tries to reconnect again after a failer previous
882 * @param cls closure (mesh handle)
883 * @param tc task context
886 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
888 struct GNUNET_MESH_Handle *h = cls;
890 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
891 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
898 * Reconnect to the service, retransmit all infomation to try to restore the
901 * @param h handle to the mesh
903 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
906 reconnect (struct GNUNET_MESH_Handle *h)
908 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
909 h->in_receive = GNUNET_NO;
910 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
911 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
916 /******************************************************************************/
917 /*********************** RECEIVE HANDLERS ****************************/
918 /******************************************************************************/
921 * Process the new tunnel notification and add it to the tunnels in the handle
923 * @param h The mesh handle
924 * @param msg A message with the details of the new incoming tunnel
927 process_tunnel_created (struct GNUNET_MESH_Handle *h,
928 const struct GNUNET_MESH_TunnelNotification *msg)
930 struct GNUNET_MESH_Tunnel *t;
931 MESH_TunnelNumber tid;
933 tid = ntohl (msg->tunnel_id);
934 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating incoming tunnel %X\n", tid);
935 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
940 if (NULL != h->new_tunnel)
942 struct GNUNET_ATS_Information atsi;
944 t = create_tunnel (h, tid);
945 t->owner = GNUNET_PEER_intern (&msg->peer);
947 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
948 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
950 t->peers[0]->connected = 1;
951 t->peers[0]->id = t->owner;
952 GNUNET_PEER_change_rc (t->owner, 1);
957 LOG (GNUNET_ERROR_TYPE_DEBUG, " created tunnel %p\n", t);
958 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
959 LOG (GNUNET_ERROR_TYPE_DEBUG, "User notified\n");
963 struct GNUNET_MESH_TunnelMessage d_msg;
965 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
967 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
968 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
969 d_msg.tunnel_id = msg->tunnel_id;
971 send_packet (h, &d_msg.header, NULL);
978 * Process the tunnel destroy notification and free associated resources
980 * @param h The mesh handle
981 * @param msg A message with the details of the tunnel being destroyed
984 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
985 const struct GNUNET_MESH_TunnelMessage *msg)
987 struct GNUNET_MESH_Tunnel *t;
988 MESH_TunnelNumber tid;
990 tid = ntohl (msg->tunnel_id);
991 t = retrieve_tunnel (h, tid);
1001 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
1002 destroy_tunnel (t, GNUNET_YES);
1008 * Process the new peer event and notify the upper level of it
1010 * @param h The mesh handle
1011 * @param msg A message with the details of the peer event
1014 process_peer_event (struct GNUNET_MESH_Handle *h,
1015 const struct GNUNET_MESH_PeerControl *msg)
1017 struct GNUNET_MESH_Tunnel *t;
1018 struct GNUNET_MESH_Peer *p;
1019 struct GNUNET_ATS_Information atsi;
1023 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
1024 size = ntohs (msg->header.size);
1025 if (size != sizeof (struct GNUNET_MESH_PeerControl))
1030 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1036 id = GNUNET_PEER_search (&msg->peer);
1037 if ((p = retrieve_peer (t, id)) == NULL)
1038 p = add_peer_to_tunnel (t, &msg->peer);
1039 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
1041 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
1042 if (NULL != t->connect_handler)
1046 t->connect_handler (t->cls, &msg->peer, &atsi);
1052 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
1053 if (NULL != t->disconnect_handler && p->connected)
1055 t->disconnect_handler (t->cls, &msg->peer);
1057 remove_peer_from_tunnel (p);
1060 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
1065 * Process the incoming data packets
1067 * @param h The mesh handle
1068 * @param message A message encapsulating the data
1070 * @return GNUNET_YES if everything went fine
1071 * GNUNET_NO if client closed connection (h no longer valid)
1074 process_incoming_data (struct GNUNET_MESH_Handle *h,
1075 const struct GNUNET_MessageHeader *message)
1077 const struct GNUNET_MessageHeader *payload;
1078 const struct GNUNET_MESH_MessageHandler *handler;
1079 const struct GNUNET_PeerIdentity *peer;
1080 struct GNUNET_MESH_Unicast *ucast;
1081 struct GNUNET_MESH_Multicast *mcast;
1082 struct GNUNET_MESH_ToOrigin *to_orig;
1083 struct GNUNET_MESH_Tunnel *t;
1088 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
1089 type = ntohs (message->type);
1092 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1093 ucast = (struct GNUNET_MESH_Unicast *) message;
1095 t = retrieve_tunnel (h, ntohl (ucast->tid));
1096 payload = (struct GNUNET_MessageHeader *) &ucast[1];
1098 pid = ntohl (ucast->pid);
1099 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
1100 GNUNET_i2s (peer), ntohl (ucast->tid));
1102 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1103 mcast = (struct GNUNET_MESH_Multicast *) message;
1104 t = retrieve_tunnel (h, ntohl (mcast->tid));
1105 payload = (struct GNUNET_MessageHeader *) &mcast[1];
1107 pid = ntohl (mcast->pid);
1108 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
1109 GNUNET_i2s (peer), ntohl (mcast->tid));
1111 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1112 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
1113 t = retrieve_tunnel (h, ntohl (to_orig->tid));
1114 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
1115 peer = &to_orig->sender;
1116 pid = ntohl (to_orig->pid);
1117 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
1118 GNUNET_i2s (peer), ntohl (to_orig->tid));
1124 LOG (GNUNET_ERROR_TYPE_DEBUG, " pid %u\n", pid);
1127 /* Tunnel was ignored, probably service didn't get it yet */
1128 LOG (GNUNET_ERROR_TYPE_DEBUG, " ignored!\n");
1131 if (GMC_is_pid_bigger(pid, t->last_recv_pid + 1))
1134 LOG (GNUNET_ERROR_TYPE_WARNING, " unauthorized message!\n");
1135 // FIXME fc what now? accept? reject?
1138 t->last_recv_pid = pid;
1139 type = ntohs (payload->type);
1140 for (i = 0; i < h->n_handlers; i++)
1142 handler = &h->message_handlers[i];
1143 if (handler->type == type)
1145 struct GNUNET_ATS_Information atsi;
1150 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1152 LOG (GNUNET_ERROR_TYPE_DEBUG, "callback caused disconnection\n");
1153 GNUNET_MESH_disconnect (h);
1158 LOG (GNUNET_ERROR_TYPE_DEBUG,
1159 "callback completed successfully\n");
1169 * Process a local ACK message, enabling the client to send
1170 * more data to the service.
1172 * @param h Mesh handle.
1173 * @param message Message itself.
1176 process_ack (struct GNUNET_MESH_Handle *h,
1177 const struct GNUNET_MessageHeader *message)
1179 struct GNUNET_MESH_LocalAck *msg;
1180 struct GNUNET_MESH_Tunnel *t;
1183 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got an ACK!\n");
1184 msg = (struct GNUNET_MESH_LocalAck *) message;
1186 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
1190 LOG (GNUNET_ERROR_TYPE_WARNING,
1191 "ACK on unknown tunnel %X\n",
1192 ntohl (msg->tunnel_id));
1195 ack = ntohl (msg->max_pid);
1196 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X, ack %u!\n", t->tid, ack);
1197 if (ack > t->max_send_pid || PID_OVERFLOW (t->max_send_pid, ack))
1198 t->max_send_pid = ack;
1201 if (NULL == h->th && 0 < t->packet_size)
1203 LOG (GNUNET_ERROR_TYPE_DEBUG, " tmt rdy was NULL, requesting!\n", t->tid, ack);
1205 GNUNET_CLIENT_notify_transmit_ready (h->client, t->packet_size,
1206 GNUNET_TIME_UNIT_FOREVER_REL,
1207 GNUNET_YES, &send_callback, h);
1213 * Function to process all messages received from the service
1215 * @param cls closure
1216 * @param msg message received, NULL on timeout or fatal error
1219 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1221 struct GNUNET_MESH_Handle *h = cls;
1225 LOG (GNUNET_ERROR_TYPE_WARNING, "Received NULL msg on %p\n", h);
1229 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n",
1230 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1231 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received a message: %s\n",
1232 GNUNET_MESH_DEBUG_M2S (ntohs (msg->type)));
1233 switch (ntohs (msg->type))
1235 /* Notify of a new incoming tunnel */
1236 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1237 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1239 /* Notify of a tunnel disconnection */
1240 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1241 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1243 /* Notify of a new peer or a peer disconnect in the tunnel */
1244 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1245 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1246 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1248 /* Notify of a new data packet in the tunnel */
1249 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1250 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1251 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1252 if (GNUNET_NO == process_incoming_data (h, msg))
1255 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_ACK:
1256 process_ack (h, msg);
1259 /* We shouldn't get any other packages, log and ignore */
1260 LOG (GNUNET_ERROR_TYPE_WARNING,
1261 "unsolicited message form service (type %hu)\n",
1264 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1265 if (GNUNET_YES == h->in_receive)
1267 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1268 GNUNET_TIME_UNIT_FOREVER_REL);
1272 LOG (GNUNET_ERROR_TYPE_DEBUG,
1273 "in receive off, not calling CLIENT_receive\n");
1278 /******************************************************************************/
1279 /************************ SEND FUNCTIONS ****************************/
1280 /******************************************************************************/
1283 * Function called to send a message to the service.
1284 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1287 * @param cls closure, the mesh handle
1288 * @param size number of bytes available in buf
1289 * @param buf where the callee should write the connect message
1290 * @return number of bytes written to buf
1293 send_callback (void *cls, size_t size, void *buf)
1295 struct GNUNET_MESH_Handle *h = cls;
1296 struct GNUNET_MESH_TransmitHandle *th;
1297 struct GNUNET_MESH_TransmitHandle *next;
1298 struct GNUNET_MESH_Tunnel *t;
1304 LOG (GNUNET_ERROR_TYPE_DEBUG, "\n");
1305 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1306 if ((0 == size) || (NULL == buf))
1308 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL send callback on %p\n", h);
1315 nsize = message_ready_size (h);
1316 while ((NULL != (th = next)) && (0 < nsize) && (size >= nsize))
1319 if (GNUNET_YES == th_is_payload (th))
1321 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload\n");
1322 if (GNUNET_YES == GMC_is_pid_bigger(t->next_send_pid, t->max_send_pid))
1324 /* This tunnel is not ready to transmit yet, try next message */
1329 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1331 /* traffic to origin */
1332 struct GNUNET_MESH_ToOrigin to;
1333 struct GNUNET_MessageHeader *mh;
1335 GNUNET_assert (size >= th->size);
1336 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1337 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1338 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %s\n",
1339 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1342 psize += sizeof (to);
1343 GNUNET_assert (size >= psize);
1344 to.header.size = htons (psize);
1345 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1346 to.tid = htonl (t->tid);
1347 to.pid = htonl (t->next_send_pid);
1348 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1349 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1350 memcpy (cbuf, &to, sizeof (to));
1353 else if (th->target == 0)
1356 struct GNUNET_MESH_Multicast mc;
1357 struct GNUNET_MessageHeader *mh;
1359 GNUNET_assert (size >= th->size);
1360 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1361 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1362 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %s\n",
1363 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1366 psize += sizeof (mc);
1367 GNUNET_assert (size >= psize);
1368 mc.header.size = htons (psize);
1369 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1370 mc.tid = htonl (t->tid);
1371 mc.pid = htonl (t->next_send_pid);
1373 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1374 memcpy (cbuf, &mc, sizeof (mc));
1380 struct GNUNET_MESH_Unicast uc;
1381 struct GNUNET_MessageHeader *mh;
1383 GNUNET_assert (size >= th->size);
1384 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1385 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1386 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %s\n",
1387 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1390 psize += sizeof (uc);
1391 GNUNET_assert (size >= psize);
1392 uc.header.size = htons (psize);
1393 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1394 uc.tid = htonl (t->tid);
1395 uc.pid = htonl (t->next_send_pid);
1396 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1397 GNUNET_PEER_resolve (th->target, &uc.destination);
1398 memcpy (cbuf, &uc, sizeof (uc));
1405 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1407 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %s\n",
1408 GNUNET_MESH_DEBUG_M2S (ntohs (mh->type)));
1409 memcpy (cbuf, &th[1], th->size);
1412 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1413 GNUNET_SCHEDULER_cancel (th->timeout_task);
1414 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1417 nsize = message_ready_size (h);
1422 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1424 size = message_ready_size (h);
1427 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", size);
1429 GNUNET_CLIENT_notify_transmit_ready (h->client, size,
1430 GNUNET_TIME_UNIT_FOREVER_REL,
1431 GNUNET_YES, &send_callback, h);
1435 if (NULL != h->th_head)
1436 LOG (GNUNET_ERROR_TYPE_DEBUG, " can't transmit any more\n");
1438 LOG (GNUNET_ERROR_TYPE_DEBUG, " nothing left to transmit\n");
1440 if (GNUNET_NO == h->in_receive)
1442 LOG (GNUNET_ERROR_TYPE_DEBUG, " start receiving from service\n");
1443 h->in_receive = GNUNET_YES;
1444 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1445 GNUNET_TIME_UNIT_FOREVER_REL);
1447 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1453 * Auxiliary function to send an already constructed packet to the service.
1454 * Takes care of creating a new queue element, copying the message and
1455 * calling the tmt_rdy function if necessary.
1457 * @param h mesh handle
1458 * @param msg message to transmit
1459 * @param tunnel tunnel this send is related to (NULL if N/A)
1462 send_packet (struct GNUNET_MESH_Handle *h,
1463 const struct GNUNET_MessageHeader *msg,
1464 struct GNUNET_MESH_Tunnel *tunnel)
1466 struct GNUNET_MESH_TransmitHandle *th;
1469 LOG (GNUNET_ERROR_TYPE_DEBUG, " Sending message to service: %s\n",
1470 GNUNET_MESH_DEBUG_M2S(ntohs(msg->type)));
1471 msize = ntohs (msg->size);
1472 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1473 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1475 th->tunnel = tunnel;
1476 memcpy (&th[1], msg, msize);
1477 add_to_queue (h, th);
1478 LOG (GNUNET_ERROR_TYPE_DEBUG, " queued\n");
1481 LOG (GNUNET_ERROR_TYPE_DEBUG, " calling ntfy tmt rdy for %u bytes\n", msize);
1483 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1484 GNUNET_TIME_UNIT_FOREVER_REL,
1485 GNUNET_YES, &send_callback, h);
1489 /******************************************************************************/
1490 /********************** API CALL DEFINITIONS *************************/
1491 /******************************************************************************/
1494 * Connect to the mesh service.
1496 * @param cfg configuration to use
1497 * @param cls closure for the various callbacks that follow
1498 * (including handlers in the handlers array)
1499 * @param new_tunnel function called when an *inbound* tunnel is created
1500 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1501 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1502 * is called on the tunnel
1503 * @param handlers callbacks for messages we care about, NULL-terminated
1504 * note that the mesh is allowed to drop notifications about
1505 * inbound messages if the client does not process them fast
1506 * enough (for this notification type, a bounded queue is used)
1507 * @param stypes list of the applications that this client claims to provide
1508 * @return handle to the mesh service NULL on error
1509 * (in this case, init is never called)
1511 struct GNUNET_MESH_Handle *
1512 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
1513 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1514 GNUNET_MESH_TunnelEndHandler cleaner,
1515 const struct GNUNET_MESH_MessageHandler *handlers,
1516 const GNUNET_MESH_ApplicationType *stypes)
1518 struct GNUNET_MESH_Handle *h;
1520 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1521 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1522 LOG (GNUNET_ERROR_TYPE_DEBUG, " addr %p\n", h);
1524 h->new_tunnel = new_tunnel;
1525 h->cleaner = cleaner;
1526 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1527 if (h->client == NULL)
1535 h->applications = stypes;
1536 h->message_handlers = handlers;
1537 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1538 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1539 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1541 /* count handlers and apps, calculate size */
1542 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1543 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1545 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1551 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1552 * disconnect callbacks will be called on any still connected peers, notifying
1553 * about their disconnection. The registered inbound tunnel cleaner will be
1554 * called should any inbound tunnels still exist.
1556 * @param handle connection to mesh to disconnect
1559 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1561 struct GNUNET_MESH_Tunnel *t;
1562 struct GNUNET_MESH_Tunnel *aux;
1563 struct GNUNET_MESH_TransmitHandle *th;
1565 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1567 t = handle->tunnels_head;
1571 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1574 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1576 destroy_tunnel (t, GNUNET_YES);
1579 while ( (th = handle->th_head) != NULL)
1581 struct GNUNET_MessageHeader *msg;
1583 /* Make sure it is an allowed packet (everything else should have been
1584 * already canceled).
1586 GNUNET_break (GNUNET_NO == th_is_payload (th));
1587 msg = (struct GNUNET_MessageHeader *) &th[1];
1588 switch (ntohs(msg->type))
1590 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1591 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1595 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1599 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1603 if (NULL != handle->th)
1605 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1608 if (NULL != handle->client)
1610 GNUNET_CLIENT_disconnect (handle->client);
1611 handle->client = NULL;
1613 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1615 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1616 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1618 GNUNET_free (handle);
1623 * Announce to ther peer the availability of services described by the regex,
1624 * in order to be reachable to other peers via connect_by_string.
1626 * Note that the first 8 characters are considered to be part of a prefix,
1627 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1628 * all matching strings will be stored in the DHT.
1630 * @param h handle to mesh.
1631 * @param regex string with the regular expression describing local services.
1634 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1637 struct GNUNET_MessageHeader *msg;
1641 len = strlen (regex);
1642 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1643 GNUNET_assert (UINT16_MAX > msgsize);
1646 char buffer[msgsize];
1648 msg = (struct GNUNET_MessageHeader *) buffer;
1649 msg->size = htons (msgsize);
1650 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1651 memcpy (&msg[1], regex, len);
1653 send_packet(h, msg, NULL);
1658 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1659 * and to broadcast).
1661 * @param h mesh handle
1662 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1663 * @param connect_handler function to call when peers are actually connected
1664 * @param disconnect_handler function to call when peers are disconnected
1665 * @param handler_cls closure for connect/disconnect handlers
1667 struct GNUNET_MESH_Tunnel *
1668 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1669 GNUNET_MESH_PeerConnectHandler connect_handler,
1670 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1673 struct GNUNET_MESH_Tunnel *t;
1674 struct GNUNET_MESH_TunnelMessage msg;
1676 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1677 t = create_tunnel (h, 0);
1678 LOG (GNUNET_ERROR_TYPE_DEBUG, " at %p\n", t);
1679 LOG (GNUNET_ERROR_TYPE_DEBUG, " number %X\n", t->tid);
1680 t->connect_handler = connect_handler;
1681 t->disconnect_handler = disconnect_handler;
1682 t->cls = handler_cls;
1683 t->ctx = tunnel_ctx;
1684 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1685 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1686 msg.tunnel_id = htonl (t->tid);
1687 send_packet (h, &msg.header, t);
1693 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1696 * @param tunnel tunnel handle
1699 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1701 struct GNUNET_MESH_Handle *h;
1702 struct GNUNET_MESH_TunnelMessage msg;
1703 struct GNUNET_MESH_TransmitHandle *th;
1705 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1708 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1709 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1710 msg.tunnel_id = htonl (tunnel->tid);
1714 struct GNUNET_MESH_TransmitHandle *aux;
1715 if (th->tunnel == tunnel)
1718 /* FIXME call the handler? */
1719 if (GNUNET_YES == th_is_payload (th))
1720 th->notify (th->notify_cls, 0, NULL);
1721 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1729 destroy_tunnel (tunnel, GNUNET_NO);
1730 send_packet (h, &msg.header, NULL);
1734 * Request that the tunnel data rate is limited to the speed of the slowest
1737 * @param tunnel Tunnel affected.
1740 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1742 struct GNUNET_MESH_TunnelMessage msg;
1743 struct GNUNET_MESH_Handle *h;
1746 tunnel->speed_min = GNUNET_YES;
1748 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1749 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1750 msg.tunnel_id = htonl (tunnel->tid);
1752 send_packet (h, &msg.header, NULL);
1757 * Request that the tunnel data rate is limited to the speed of the fastest
1758 * receiver. This is the default behavior.
1760 * @param tunnel Tunnel affected.
1763 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1765 struct GNUNET_MESH_TunnelMessage msg;
1766 struct GNUNET_MESH_Handle *h;
1769 tunnel->speed_min = GNUNET_NO;
1771 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1772 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1773 msg.tunnel_id = htonl (tunnel->tid);
1775 send_packet (h, &msg.header, NULL);
1779 * Turn on/off the buffering status of the tunnel.
1781 * @param tunnel Tunnel affected.
1782 * @param buffer GNUNET_YES to turn buffering on (default),
1783 * GNUNET_NO otherwise.
1786 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1788 struct GNUNET_MESH_TunnelMessage msg;
1789 struct GNUNET_MESH_Handle *h;
1792 tunnel->buffering = buffer;
1794 if (GNUNET_YES == buffer)
1795 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1797 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1798 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1799 msg.tunnel_id = htonl (tunnel->tid);
1801 send_packet (h, &msg.header, NULL);
1805 * Request that a peer should be added to the tunnel. The existing
1806 * connect handler will be called ONCE with either success or failure.
1807 * This function should NOT be called again with the same peer before the
1808 * connect handler is called.
1810 * @param tunnel handle to existing tunnel
1811 * @param peer peer to add
1814 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1815 const struct GNUNET_PeerIdentity *peer)
1817 struct GNUNET_MESH_PeerControl msg;
1818 GNUNET_PEER_Id peer_id;
1821 peer_id = GNUNET_PEER_intern (peer);
1822 for (i = 0; i < tunnel->npeers; i++)
1824 if (tunnel->peers[i]->id == peer_id)
1826 /* Peer already exists in tunnel */
1827 GNUNET_PEER_change_rc (peer_id, -1);
1832 if (NULL == add_peer_to_tunnel (tunnel, peer))
1835 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1836 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1837 msg.tunnel_id = htonl (tunnel->tid);
1839 send_packet (tunnel->mesh, &msg.header, tunnel);
1846 * Request that a peer should be removed from the tunnel. The existing
1847 * disconnect handler will be called ONCE if we were connected.
1849 * @param tunnel handle to existing tunnel
1850 * @param peer peer to remove
1853 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1854 const struct GNUNET_PeerIdentity *peer)
1856 struct GNUNET_MESH_PeerControl msg;
1857 GNUNET_PEER_Id peer_id;
1860 peer_id = GNUNET_PEER_search (peer);
1866 for (i = 0; i < tunnel->npeers; i++)
1867 if (tunnel->peers[i]->id == peer_id)
1869 if (i == tunnel->npeers)
1874 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1875 tunnel->disconnect_handler (tunnel->cls, peer);
1876 GNUNET_PEER_change_rc (peer_id, -1);
1877 GNUNET_free (tunnel->peers[i]);
1878 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1879 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1881 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1882 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1883 msg.tunnel_id = htonl (tunnel->tid);
1884 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1885 send_packet (tunnel->mesh, &msg.header, tunnel);
1890 * Request that the mesh should try to connect to a peer supporting the given
1893 * @param tunnel handle to existing tunnel
1894 * @param app_type application type that must be supported by the peer (MESH
1895 * should discover peer in proximity handling this type)
1898 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1899 GNUNET_MESH_ApplicationType app_type)
1901 struct GNUNET_MESH_ConnectPeerByType msg;
1903 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1905 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1906 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1907 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1908 msg.tunnel_id = htonl (tunnel->tid);
1909 msg.type = htonl (app_type);
1910 send_packet (tunnel->mesh, &msg.header, tunnel);
1915 * Request that the mesh should try to connect to a peer matching the
1916 * description given in the service string.
1918 * FIXME: allow multiple? how to deal with reconnect?
1920 * @param tunnel handle to existing tunnel
1921 * @param description string describing the destination node requirements
1924 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1925 const char *description)
1927 struct GNUNET_MESH_ConnectPeerByString *m;
1931 len = strlen (description);
1932 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1933 GNUNET_assert (UINT16_MAX > msgsize);
1935 char buffer[msgsize];
1937 m = (struct GNUNET_MESH_ConnectPeerByString *) buffer;
1938 m->header.size = htons (msgsize);
1939 m->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1940 m->tunnel_id = htonl (tunnel->tid);
1941 memcpy(&m[1], description, len);
1943 send_packet (tunnel->mesh, &m->header, tunnel);
1949 * Request that the given peer isn't added to this tunnel in calls to
1950 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1952 * @param tunnel handle to existing tunnel.
1953 * @param peer peer identity of the peer which should be blacklisted
1957 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1958 const struct GNUNET_PeerIdentity *peer)
1960 struct GNUNET_MESH_PeerControl msg;
1962 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1963 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1964 msg.tunnel_id = htonl (tunnel->tid);
1966 send_packet (tunnel->mesh, &msg.header, tunnel);
1973 * Request that the given peer isn't blacklisted anymore from this tunnel,
1974 * and therefore can be added in future calls to connect_by_*.
1975 * The peer must have been previously blacklisted for this tunnel.
1977 * @param tunnel handle to existing tunnel.
1978 * @param peer peer identity of the peer which shouldn't be blacklisted
1979 * for the tunnel anymore.
1982 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1983 const struct GNUNET_PeerIdentity *peer)
1985 struct GNUNET_MESH_PeerControl msg;
1987 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1988 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1989 msg.tunnel_id = htonl (tunnel->tid);
1991 send_packet (tunnel->mesh, &msg.header, tunnel);
1998 * Ask the mesh to call "notify" once it is ready to transmit the
1999 * given number of bytes to the specified tunnel or target.
2000 * Only one call can be active at any time, to issue another request,
2001 * wait for the callback or cancel the current request.
2003 * @param tunnel tunnel to use for transmission
2004 * @param cork is corking allowed for this transmission?
2005 * @param maxdelay how long can the message wait?
2006 * @param target destination for the message
2007 * NULL for multicast to all tunnel targets
2008 * @param notify_size how many bytes of buffer space does notify want?
2009 * @param notify function to call when buffer space is available;
2010 * will be called with NULL on timeout or if the overall queue
2011 * for this peer is larger than queue_size and this is currently
2012 * the message with the lowest priority
2013 * @param notify_cls closure for notify
2014 * @return non-NULL if the notify callback was queued,
2015 * NULL if we can not even queue the request (insufficient
2016 * memory); if NULL is returned, "notify" will NOT be called.
2018 struct GNUNET_MESH_TransmitHandle *
2019 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
2020 struct GNUNET_TIME_Relative maxdelay,
2021 const struct GNUNET_PeerIdentity *target,
2023 GNUNET_CONNECTION_TransmitReadyNotify notify,
2026 struct GNUNET_MESH_TransmitHandle *th;
2029 GNUNET_assert (NULL != tunnel);
2030 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY\n");
2031 LOG (GNUNET_ERROR_TYPE_DEBUG, " on tunnel %X\n", tunnel->tid);
2032 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2033 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin\n");
2034 else if (NULL != target)
2035 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
2037 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
2038 LOG (GNUNET_ERROR_TYPE_DEBUG, " payload size %u\n", notify_size);
2039 GNUNET_assert (NULL != notify);
2040 GNUNET_assert (0 == tunnel->packet_size); // Only one data packet allowed
2041 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
2042 th->tunnel = tunnel;
2043 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
2044 th->target = GNUNET_PEER_intern (target);
2045 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
2046 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
2047 else if (NULL == target)
2048 overhead = sizeof (struct GNUNET_MESH_Multicast);
2050 overhead = sizeof (struct GNUNET_MESH_Unicast);
2051 tunnel->packet_size = th->size = notify_size + overhead;
2052 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size %u\n", th->size);
2053 th->notify = notify;
2054 th->notify_cls = notify_cls;
2055 add_to_queue (tunnel->mesh, th);
2056 if (NULL != tunnel->mesh->th)
2058 if (GMC_is_pid_bigger(tunnel->next_send_pid, tunnel->max_send_pid))
2060 LOG (GNUNET_ERROR_TYPE_DEBUG, " call notify tmt rdy\n");
2062 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
2063 GNUNET_TIME_UNIT_FOREVER_REL,
2064 GNUNET_YES, &send_callback,
2066 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH NOTIFY TRANSMIT READY END\n");
2072 * Cancel the specified transmission-ready notification.
2074 * @param th handle that was returned by "notify_transmit_ready".
2077 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
2079 struct GNUNET_MESH_Handle *mesh;
2081 th->tunnel->packet_size = 0;
2082 mesh = th->tunnel->mesh;
2083 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
2084 GNUNET_SCHEDULER_cancel (th->timeout_task);
2085 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
2087 if ((0 == message_ready_size (mesh)) && (NULL != mesh->th))
2089 /* queue empty, no point in asking for transmission */
2090 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
2097 * Transition API for tunnel ctx management
2100 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
2106 * Transition API for tunnel ctx management
2109 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)