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 * Priority of the message. The queue is sorted by priority,
98 * control messages have the maximum priority (UINT32_MAX).
103 * Target of the message, 0 for multicast. This field
104 * is only valid if 'notify' is non-NULL.
106 GNUNET_PEER_Id target;
109 * Size of 'data' -- or the desired size of 'notify' if 'data' is NULL.
116 * Opaque handle to the service.
118 struct GNUNET_MESH_Handle
122 * Handle to the server connection, to send messages later
124 struct GNUNET_CLIENT_Connection *client;
127 * Set of handlers used for processing incoming messages in the tunnels
129 const struct GNUNET_MESH_MessageHandler *message_handlers;
132 * Set of applications that should be claimed to be offered at this node.
133 * Note that this is just informative, the appropiate handlers must be
134 * registered independently and the mapping is up to the developer of the
135 * client application.
137 const GNUNET_MESH_ApplicationType *applications;
140 * Double linked list of the tunnels this client is connected to.
142 struct GNUNET_MESH_Tunnel *tunnels_head;
143 struct GNUNET_MESH_Tunnel *tunnels_tail;
146 * Callback for inbound tunnel creation
148 GNUNET_MESH_InboundTunnelNotificationHandler *new_tunnel;
151 * Callback for inbound tunnel disconnection
153 GNUNET_MESH_TunnelEndHandler *cleaner;
156 * Handle to cancel pending transmissions in case of disconnection
158 struct GNUNET_CLIENT_TransmitHandle *th;
161 * Closure for all the handlers given by the client
166 * Messages to send to the service
168 struct GNUNET_MESH_TransmitHandle *th_head;
169 struct GNUNET_MESH_TransmitHandle *th_tail;
172 * tid of the next tunnel to create (to avoid reusing IDs often)
174 MESH_TunnelNumber next_tid;
175 unsigned int n_handlers;
176 unsigned int n_applications;
177 unsigned int max_queue_size;
180 * Have we started the task to receive messages from the service
181 * yet? We do this after we send the 'MESH_LOCAL_CONNECT' message.
186 * Number of packets queued
188 unsigned int npackets;
191 * Configuration given by the client, in case of reconnection
193 const struct GNUNET_CONFIGURATION_Handle *cfg;
196 * Time to the next reconnect in case one reconnect fails
198 struct GNUNET_TIME_Relative reconnect_time;
201 * Task for trying to reconnect.
203 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
208 * Description of a peer
210 struct GNUNET_MESH_Peer
213 * ID of the peer in short form
218 * Tunnel this peer belongs to
220 struct GNUNET_MESH_Tunnel *t;
223 * Flag indicating whether service has informed about its connection
231 * Opaque handle to a tunnel.
233 struct GNUNET_MESH_Tunnel
239 struct GNUNET_MESH_Tunnel *next;
240 struct GNUNET_MESH_Tunnel *prev;
243 * Callback to execute when peers connect to the tunnel
245 GNUNET_MESH_PeerConnectHandler connect_handler;
248 * Callback to execute when peers disconnect from the tunnel
250 GNUNET_MESH_PeerDisconnectHandler disconnect_handler;
253 * Closure for the connect/disconnect handlers
258 * Handle to the mesh this tunnel belongs to
260 struct GNUNET_MESH_Handle *mesh;
263 * Local ID of the tunnel
265 MESH_TunnelNumber tid;
268 * Owner of the tunnel. 0 if the tunnel is the local client.
270 GNUNET_PEER_Id owner;
273 * All peers added to the tunnel
275 struct GNUNET_MESH_Peer **peers;
278 * List of application types that have been requested for this tunnel
280 GNUNET_MESH_ApplicationType *apps;
283 * Any data the caller wants to put in here
288 * Number of peers added to the tunnel
293 * Number of packets queued in this tunnel
295 unsigned int npackets;
298 * Number of applications requested this tunnel
305 /******************************************************************************/
306 /*********************** AUXILIARY FUNCTIONS *************************/
307 /******************************************************************************/
310 * Get the tunnel handler for the tunnel specified by id from the given handle
311 * @param h Mesh handle
312 * @param tid ID of the wanted tunnel
313 * @return handle to the required tunnel or NULL if not found
315 static struct GNUNET_MESH_Tunnel *
316 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
318 struct GNUNET_MESH_Tunnel *t;
332 * Create a new tunnel and insert it in the tunnel list of the mesh handle
333 * @param h Mesh handle
334 * @param tid desired tid of the tunnel, 0 to assign one automatically
335 * @return handle to the created tunnel
337 static struct GNUNET_MESH_Tunnel *
338 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
340 struct GNUNET_MESH_Tunnel *t;
342 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
343 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
347 t->tid = h->next_tid;
348 while (NULL != retrieve_tunnel (h, h->next_tid))
351 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
352 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
364 * Destroy the specified tunnel.
365 * - Destroys all peers, calling the disconnect callback on each if needed
366 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
367 * - Calls cleaner if tunnel was inbound
368 * - Frees all memory used
370 * @param t Pointer to the tunnel.
371 * @param call_cleaner Whether to call the cleaner handler.
373 * @return Handle to the required tunnel or NULL if not found.
376 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
378 struct GNUNET_MESH_Handle *h;
379 struct GNUNET_PeerIdentity pi;
380 struct GNUNET_MESH_TransmitHandle *th;
381 struct GNUNET_MESH_TransmitHandle *next;
384 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
393 /* disconnect all peers */
394 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
395 for (i = 0; i < t->npeers; i++)
397 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
399 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
400 t->disconnect_handler (t->cls, &pi);
402 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
403 GNUNET_free (t->peers[i]);
406 /* signal tunnel destruction */
407 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
408 h->cleaner (h->cls, t, t->ctx);
410 /* check that clients did not leave messages behind in the queue */
411 for (th = h->th_head; NULL != th; th = next)
416 /* Clients should have aborted their requests already.
417 * Management traffic should be ok, as clients can't cancel that */
418 GNUNET_break (NULL == th->notify);
419 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
421 /* clean up request */
422 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
423 GNUNET_SCHEDULER_cancel (th->timeout_task);
427 /* if there are no more pending requests with mesh service, cancel active request */
428 /* Note: this should be unnecessary... */
429 if ( (NULL == h->th_head) && (NULL != h->th))
431 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
437 GNUNET_free (t->peers);
439 GNUNET_PEER_change_rc (t->owner, -1);
440 if (0 != t->napps && t->apps)
441 GNUNET_free (t->apps);
448 * Get the peer descriptor for the peer with id from the given tunnel
449 * @param t Tunnel handle
450 * @param id Short form ID of the wanted peer
451 * @return handle to the requested peer or NULL if not found
453 static struct GNUNET_MESH_Peer *
454 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
458 for (i = 0; i < t->npeers; i++)
459 if (t->peers[i]->id == id)
466 * Add a peer into a tunnel
467 * @param t Tunnel handle
468 * @param pi Full ID of the new peer
469 * @return handle to the newly created peer
471 static struct GNUNET_MESH_Peer *
472 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
473 const struct GNUNET_PeerIdentity *pi)
475 struct GNUNET_MESH_Peer *p;
483 id = GNUNET_PEER_intern (pi);
485 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
488 GNUNET_array_append (t->peers, t->npeers, p);
494 * Remove a peer from a tunnel
495 * @param p Peer handle
498 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
502 for (i = 0; i < p->t->npeers; i++)
504 if (p->t->peers[i] == p)
507 if (i == p->t->npeers)
512 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
513 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
518 * Notify client that the transmission has timed out
520 * @param tc task context
523 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
525 struct GNUNET_MESH_TransmitHandle *th = cls;
526 struct GNUNET_MESH_Handle *mesh;
528 mesh = th->tunnel->mesh;
529 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
530 if (th->notify != NULL)
531 th->notify (th->notify_cls, 0, NULL);
533 if ((NULL == mesh->th_head) && (NULL != mesh->th))
535 /* queue empty, no point in asking for transmission */
536 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
543 * Add a transmit handle to the transmission queue by priority and set the
546 * @param h mesh handle with the queue head and tail
547 * @param th handle to the packet to be transmitted
550 add_to_queue (struct GNUNET_MESH_Handle *h,
551 struct GNUNET_MESH_TransmitHandle *th)
553 struct GNUNET_MESH_TransmitHandle *p;
556 while ((NULL != p) && (th->priority <= p->priority))
562 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
563 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
566 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
567 (th->timeout), &timeout_transmission, th);
572 * Auxiliary function to send an already constructed packet to the service.
573 * Takes care of creating a new queue element, copying the message and
574 * calling the tmt_rdy function if necessary.
576 * @param h mesh handle
577 * @param msg message to transmit
578 * @param tunnel tunnel this send is related to (NULL if N/A)
581 send_packet (struct GNUNET_MESH_Handle *h,
582 const struct GNUNET_MessageHeader *msg,
583 struct GNUNET_MESH_Tunnel *tunnel);
587 * Reconnect callback: tries to reconnect again after a failer previous
589 * @param cls closure (mesh handle)
590 * @param tc task context
593 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
597 * Send a connect packet to the service with the applications and types
598 * requested by the user.
600 * @param h The mesh handle.
604 send_connect (struct GNUNET_MESH_Handle *h)
608 size = sizeof (struct GNUNET_MESH_ClientConnect);
609 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
610 size += h->n_handlers * sizeof (uint16_t);
612 char buf[size] GNUNET_ALIGN;
613 struct GNUNET_MESH_ClientConnect *msg;
614 GNUNET_MESH_ApplicationType *apps;
619 /* build connection packet */
620 msg = (struct GNUNET_MESH_ClientConnect *) buf;
621 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
622 msg->header.size = htons (size);
623 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
624 for (napps = 0; napps < h->n_applications; napps++)
626 apps[napps] = htonl (h->applications[napps]);
627 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
629 types = (uint16_t *) & apps[napps];
630 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
631 types[ntypes] = htons (h->message_handlers[ntypes].type);
632 msg->applications = htons (napps);
633 msg->types = htons (ntypes);
634 LOG (GNUNET_ERROR_TYPE_DEBUG,
635 "Sending %lu bytes long message %d types and %d apps\n",
636 ntohs (msg->header.size), ntypes, napps);
637 send_packet (h, &msg->header, NULL);
643 * Reconnect to the service, retransmit all infomation to try to restore the
646 * @param h handle to the mesh
648 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
651 do_reconnect (struct GNUNET_MESH_Handle *h)
653 struct GNUNET_MESH_Tunnel *t;
656 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
657 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
658 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
660 h->in_receive = GNUNET_NO;
664 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
667 if (NULL != h->client)
669 GNUNET_CLIENT_disconnect (h->client);
673 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
674 if (h->client == NULL)
676 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
679 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
680 GNUNET_TIME_relative_multiply
681 (h->reconnect_time, 2));
682 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
683 GNUNET_TIME_relative_to_string (h->reconnect_time));
689 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
692 /* Rebuild all tunnels */
693 for (t = h->tunnels_head; NULL != t; t = t->next)
695 struct GNUNET_MESH_TunnelMessage tmsg;
696 struct GNUNET_MESH_PeerControl pmsg;
698 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
700 /* Tunnel was created by service (incoming tunnel) */
701 /* TODO: Notify service of missing tunnel, to request
702 * creator to recreate path (find a path to him via DHT?)
706 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
707 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
708 tmsg.tunnel_id = htonl (t->tid);
709 send_packet (h, &tmsg.header, t);
711 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
712 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
713 pmsg.tunnel_id = htonl (t->tid);
715 /* Reconnect all peers */
716 for (i = 0; i < t->npeers; i++)
718 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
719 if (NULL != t->disconnect_handler && t->peers[i]->connected)
720 t->disconnect_handler (t->cls, &pmsg.peer);
721 /* If the tunnel was "by type", dont connect individual peers */
723 send_packet (t->mesh, &pmsg.header, t);
725 /* Reconnect all types, if any */
726 for (i = 0; i < t->napps; i++)
728 struct GNUNET_MESH_ConnectPeerByType msg;
730 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
731 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
732 msg.tunnel_id = htonl (t->tid);
733 msg.type = htonl (t->apps[i]);
734 send_packet (t->mesh, &msg.header, t);
741 * Reconnect callback: tries to reconnect again after a failer previous
743 * @param cls closure (mesh handle)
744 * @param tc task context
747 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
749 struct GNUNET_MESH_Handle *h = cls;
751 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
752 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
759 * Reconnect to the service, retransmit all infomation to try to restore the
762 * @param h handle to the mesh
764 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
767 reconnect (struct GNUNET_MESH_Handle *h)
769 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
770 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
771 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
776 /******************************************************************************/
777 /*********************** RECEIVE HANDLERS ****************************/
778 /******************************************************************************/
781 * Process the new tunnel notification and add it to the tunnels in the handle
783 * @param h The mesh handle
784 * @param msg A message with the details of the new incoming tunnel
787 process_tunnel_created (struct GNUNET_MESH_Handle *h,
788 const struct GNUNET_MESH_TunnelNotification *msg)
790 struct GNUNET_MESH_Tunnel *t;
791 MESH_TunnelNumber tid;
793 tid = ntohl (msg->tunnel_id);
794 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
799 if (NULL != h->new_tunnel)
801 struct GNUNET_ATS_Information atsi;
803 t = create_tunnel (h, tid);
804 t->owner = GNUNET_PEER_intern (&msg->peer);
806 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
807 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
809 t->peers[0]->connected = 1;
810 t->peers[0]->id = t->owner;
811 GNUNET_PEER_change_rc (t->owner, 1);
816 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
817 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
821 struct GNUNET_MESH_TunnelMessage d_msg;
823 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
825 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
826 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
827 d_msg.tunnel_id = msg->tunnel_id;
829 send_packet (h, &d_msg.header, NULL);
836 * Process the tunnel destroy notification and free associated resources
838 * @param h The mesh handle
839 * @param msg A message with the details of the tunnel being destroyed
842 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
843 const struct GNUNET_MESH_TunnelMessage *msg)
845 struct GNUNET_MESH_Tunnel *t;
846 MESH_TunnelNumber tid;
848 tid = ntohl (msg->tunnel_id);
849 t = retrieve_tunnel (h, tid);
859 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
860 destroy_tunnel (t, GNUNET_YES);
866 * Process the new peer event and notify the upper level of it
868 * @param h The mesh handle
869 * @param msg A message with the details of the peer event
872 process_peer_event (struct GNUNET_MESH_Handle *h,
873 const struct GNUNET_MESH_PeerControl *msg)
875 struct GNUNET_MESH_Tunnel *t;
876 struct GNUNET_MESH_Peer *p;
877 struct GNUNET_ATS_Information atsi;
881 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
882 size = ntohs (msg->header.size);
883 if (size != sizeof (struct GNUNET_MESH_PeerControl))
888 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
894 id = GNUNET_PEER_search (&msg->peer);
895 if ((p = retrieve_peer (t, id)) == NULL)
896 p = add_peer_to_tunnel (t, &msg->peer);
897 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
899 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
900 if (NULL != t->connect_handler)
904 t->connect_handler (t->cls, &msg->peer, &atsi);
910 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
911 if (NULL != t->disconnect_handler && p->connected)
913 t->disconnect_handler (t->cls, &msg->peer);
915 remove_peer_from_tunnel (p);
918 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
923 * Process the incoming data packets
925 * @param h The mesh handle
926 * @param message A message encapsulating the data
928 * @return GNUNET_YES if everything went fine
929 * GNUNET_NO if client closed connection (h no longer valid)
932 process_incoming_data (struct GNUNET_MESH_Handle *h,
933 const struct GNUNET_MessageHeader *message)
935 const struct GNUNET_MessageHeader *payload;
936 const struct GNUNET_MESH_MessageHandler *handler;
937 const struct GNUNET_PeerIdentity *peer;
938 struct GNUNET_MESH_Unicast *ucast;
939 struct GNUNET_MESH_Multicast *mcast;
940 struct GNUNET_MESH_ToOrigin *to_orig;
941 struct GNUNET_MESH_Tunnel *t;
945 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
946 type = ntohs (message->type);
949 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
950 ucast = (struct GNUNET_MESH_Unicast *) message;
952 t = retrieve_tunnel (h, ntohl (ucast->tid));
953 payload = (struct GNUNET_MessageHeader *) &ucast[1];
955 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
956 GNUNET_i2s (peer), ntohl (ucast->tid));
958 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
959 mcast = (struct GNUNET_MESH_Multicast *) message;
960 t = retrieve_tunnel (h, ntohl (mcast->tid));
961 payload = (struct GNUNET_MessageHeader *) &mcast[1];
963 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
964 GNUNET_i2s (peer), ntohl (mcast->tid));
966 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
967 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
968 t = retrieve_tunnel (h, ntohl (to_orig->tid));
969 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
970 peer = &to_orig->sender;
971 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
972 GNUNET_i2s (peer), ntohl (to_orig->tid));
980 /* Tunnel was ignored, probably service didn't get it yet */
983 type = ntohs (payload->type);
984 for (i = 0; i < h->n_handlers; i++)
986 handler = &h->message_handlers[i];
987 if (handler->type == type)
989 struct GNUNET_ATS_Information atsi;
994 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
996 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
997 GNUNET_MESH_disconnect (h);
1002 LOG (GNUNET_ERROR_TYPE_DEBUG,
1003 "MESH: callback completed successfully\n");
1013 * Function to process all messages received from the service
1015 * @param cls closure
1016 * @param msg message received, NULL on timeout or fatal error
1019 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1021 struct GNUNET_MESH_Handle *h = cls;
1025 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL msg\n");
1029 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %hu from MESH\n",
1031 switch (ntohs (msg->type))
1033 /* Notify of a new incoming tunnel */
1034 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1035 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1037 /* Notify of a tunnel disconnection */
1038 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1039 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1041 /* Notify of a new peer or a peer disconnect in the tunnel */
1042 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1043 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1044 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1046 /* Notify of a new data packet in the tunnel */
1047 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1048 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1049 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1050 if (GNUNET_NO == process_incoming_data (h, msg))
1053 /* We shouldn't get any other packages, log and ignore */
1055 LOG (GNUNET_ERROR_TYPE_WARNING,
1056 "MESH: unsolicited message form service (type %d)\n",
1059 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1060 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1061 GNUNET_TIME_UNIT_FOREVER_REL);
1065 /******************************************************************************/
1066 /************************ SEND FUNCTIONS ****************************/
1067 /******************************************************************************/
1070 * Function called to send a message to the service.
1071 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1074 * @param cls closure, the mesh handle
1075 * @param size number of bytes available in buf
1076 * @param buf where the callee should write the connect message
1077 * @return number of bytes written to buf
1080 send_callback (void *cls, size_t size, void *buf)
1082 struct GNUNET_MESH_Handle *h = cls;
1083 struct GNUNET_MESH_TransmitHandle *th;
1088 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1090 if ((0 == size) || (NULL == buf))
1092 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL callback\n");
1097 while ((NULL != (th = h->th_head)) && (size >= th->size))
1099 if (NULL != th->notify)
1101 if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1103 /* traffic to origin */
1104 struct GNUNET_MESH_ToOrigin to;
1105 struct GNUNET_MessageHeader *mh;
1107 GNUNET_assert (size >= th->size);
1108 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1109 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1110 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %u\n",
1114 psize += sizeof (to);
1115 GNUNET_assert (size >= psize);
1116 to.header.size = htons (psize);
1117 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1118 to.tid = htonl (th->tunnel->tid);
1119 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1120 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1121 memcpy (cbuf, &to, sizeof (to));
1124 else if (th->target == 0)
1127 struct GNUNET_MESH_Multicast mc;
1128 struct GNUNET_MessageHeader *mh;
1130 GNUNET_assert (size >= th->size);
1131 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1132 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1133 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %u\n",
1137 psize += sizeof (mc);
1138 GNUNET_assert (size >= psize);
1139 mc.header.size = htons (psize);
1140 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1141 mc.tid = htonl (th->tunnel->tid);
1144 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1145 memcpy (cbuf, &mc, sizeof (mc));
1151 struct GNUNET_MESH_Unicast uc;
1152 struct GNUNET_MessageHeader *mh;
1154 GNUNET_assert (size >= th->size);
1155 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1156 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1157 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %u\n",
1161 psize += sizeof (uc);
1162 GNUNET_assert (size >= psize);
1163 uc.header.size = htons (psize);
1164 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1165 uc.tid = htonl (th->tunnel->tid);
1166 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1167 GNUNET_PEER_resolve (th->target, &uc.destination);
1168 memcpy (cbuf, &uc, sizeof (uc));
1174 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1175 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %u\n",
1177 memcpy (cbuf, &th[1], th->size);
1180 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1181 GNUNET_SCHEDULER_cancel (th->timeout_task);
1182 if (NULL != th->notify)
1184 th->tunnel->mesh->npackets--;
1185 th->tunnel->npackets--;
1187 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1193 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1194 if (NULL != (th = h->th_head))
1196 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", th->size);
1199 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1200 GNUNET_TIME_UNIT_FOREVER_REL,
1201 GNUNET_YES, &send_callback, h);
1203 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1204 if (GNUNET_NO == h->in_receive)
1206 h->in_receive = GNUNET_YES;
1207 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1208 GNUNET_TIME_UNIT_FOREVER_REL);
1215 * Auxiliary function to send an already constructed packet to the service.
1216 * Takes care of creating a new queue element, copying the message and
1217 * calling the tmt_rdy function if necessary.
1219 * @param h mesh handle
1220 * @param msg message to transmit
1221 * @param tunnel tunnel this send is related to (NULL if N/A)
1224 send_packet (struct GNUNET_MESH_Handle *h,
1225 const struct GNUNET_MessageHeader *msg,
1226 struct GNUNET_MESH_Tunnel *tunnel)
1228 struct GNUNET_MESH_TransmitHandle *th;
1231 msize = ntohs (msg->size);
1232 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1233 th->priority = UINT32_MAX;
1234 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1236 th->tunnel = tunnel;
1237 memcpy (&th[1], msg, msize);
1238 add_to_queue (h, th);
1242 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1243 GNUNET_TIME_UNIT_FOREVER_REL,
1244 GNUNET_YES, &send_callback, h);
1248 /******************************************************************************/
1249 /********************** API CALL DEFINITIONS *************************/
1250 /******************************************************************************/
1253 * Connect to the mesh service.
1255 * @param cfg configuration to use
1256 * @param queue_size size of the data message queue, shared among all tunnels
1257 * (each tunnel is guaranteed to accept at least one message,
1258 * no matter what is the status of other tunnels)
1259 * @param cls closure for the various callbacks that follow
1260 * (including handlers in the handlers array)
1261 * @param new_tunnel function called when an *inbound* tunnel is created
1262 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1263 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1264 * is called on the tunnel
1265 * @param handlers callbacks for messages we care about, NULL-terminated
1266 * note that the mesh is allowed to drop notifications about
1267 * inbound messages if the client does not process them fast
1268 * enough (for this notification type, a bounded queue is used)
1269 * @param stypes list of the applications that this client claims to provide
1270 * @return handle to the mesh service NULL on error
1271 * (in this case, init is never called)
1273 struct GNUNET_MESH_Handle *
1274 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1275 unsigned int queue_size, void *cls,
1276 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1277 GNUNET_MESH_TunnelEndHandler cleaner,
1278 const struct GNUNET_MESH_MessageHandler *handlers,
1279 const GNUNET_MESH_ApplicationType *stypes)
1281 struct GNUNET_MESH_Handle *h;
1283 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1284 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1286 h->max_queue_size = queue_size;
1287 h->new_tunnel = new_tunnel;
1288 h->cleaner = cleaner;
1289 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1290 if (h->client == NULL)
1298 h->applications = stypes;
1299 h->message_handlers = handlers;
1300 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1301 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1302 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1304 /* count handlers and apps, calculate size */
1305 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1306 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1308 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1314 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1315 * disconnect callbacks will be called on any still connected peers, notifying
1316 * about their disconnection. The registered inbound tunnel cleaner will be
1317 * called should any inbound tunnels still exist.
1319 * @param handle connection to mesh to disconnect
1322 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1324 struct GNUNET_MESH_Tunnel *t;
1325 struct GNUNET_MESH_Tunnel *aux;
1326 struct GNUNET_MESH_TransmitHandle *th;
1328 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1330 t = handle->tunnels_head;
1334 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1337 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1339 destroy_tunnel (t, GNUNET_YES);
1342 while ( (th = handle->th_head) != NULL)
1344 struct GNUNET_MessageHeader *msg;
1346 /* Make sure it is an allowed packet (everything else should have been
1347 * already canceled).
1349 GNUNET_break (UINT32_MAX == th->priority);
1350 GNUNET_break (NULL == th->notify);
1351 msg = (struct GNUNET_MessageHeader *) &th[1];
1352 switch (ntohs(msg->type))
1354 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1355 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1359 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1363 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1367 if (NULL != handle->th)
1369 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1372 if (NULL != handle->client)
1374 GNUNET_CLIENT_disconnect (handle->client);
1375 handle->client = NULL;
1377 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1379 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1380 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1382 GNUNET_free (handle);
1387 * Announce to ther peer the availability of services described by the regex,
1388 * in order to be reachable to other peers via connect_by_string.
1390 * @param h handle to mesh.
1391 * @param regex string with the regular expression describing local services.
1394 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1397 struct GNUNET_MessageHeader *msg;
1401 len = strlen (regex);
1402 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1403 GNUNET_assert (UINT16_MAX > msgsize);
1405 msg = GNUNET_malloc (msgsize);
1406 msg->size = htons (msgsize);
1407 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1408 memcpy (&msg[1], regex, len);
1410 send_packet(h, msg, NULL);
1414 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1415 * and to broadcast).
1417 * @param h mesh handle
1418 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1419 * @param connect_handler function to call when peers are actually connected
1420 * @param disconnect_handler function to call when peers are disconnected
1421 * @param handler_cls closure for connect/disconnect handlers
1423 struct GNUNET_MESH_Tunnel *
1424 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1425 GNUNET_MESH_PeerConnectHandler connect_handler,
1426 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1429 struct GNUNET_MESH_Tunnel *t;
1430 struct GNUNET_MESH_TunnelMessage msg;
1432 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1433 t = create_tunnel (h, 0);
1434 t->connect_handler = connect_handler;
1435 t->disconnect_handler = disconnect_handler;
1436 t->cls = handler_cls;
1437 t->ctx = tunnel_ctx;
1438 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1439 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1440 msg.tunnel_id = htonl (t->tid);
1441 send_packet (h, &msg.header, t);
1447 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1450 * @param tunnel tunnel handle
1453 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1455 struct GNUNET_MESH_Handle *h;
1456 struct GNUNET_MESH_TunnelMessage msg;
1457 struct GNUNET_MESH_TransmitHandle *th;
1459 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1462 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1463 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1464 msg.tunnel_id = htonl (tunnel->tid);
1468 struct GNUNET_MESH_TransmitHandle *aux;
1469 if (th->tunnel == tunnel)
1472 /* FIXME call the handler? */
1473 if (NULL != th->notify)
1474 th->notify (th->notify_cls, 0, NULL);
1475 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1483 destroy_tunnel (tunnel, GNUNET_NO);
1484 send_packet (h, &msg.header, NULL);
1489 * Request that a peer should be added to the tunnel. The existing
1490 * connect handler will be called ONCE with either success or failure.
1491 * This function should NOT be called again with the same peer before the
1492 * connect handler is called.
1494 * @param tunnel handle to existing tunnel
1495 * @param peer peer to add
1498 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1499 const struct GNUNET_PeerIdentity *peer)
1501 struct GNUNET_MESH_PeerControl msg;
1502 GNUNET_PEER_Id peer_id;
1505 peer_id = GNUNET_PEER_intern (peer);
1506 for (i = 0; i < tunnel->npeers; i++)
1508 if (tunnel->peers[i]->id == peer_id)
1510 /* Peer already exists in tunnel */
1511 GNUNET_PEER_change_rc (peer_id, -1);
1516 if (NULL == add_peer_to_tunnel (tunnel, peer))
1519 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1520 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1521 msg.tunnel_id = htonl (tunnel->tid);
1523 send_packet (tunnel->mesh, &msg.header, tunnel);
1530 * Request that a peer should be removed from the tunnel. The existing
1531 * disconnect handler will be called ONCE if we were connected.
1533 * @param tunnel handle to existing tunnel
1534 * @param peer peer to remove
1537 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1538 const struct GNUNET_PeerIdentity *peer)
1540 struct GNUNET_MESH_PeerControl msg;
1541 GNUNET_PEER_Id peer_id;
1544 peer_id = GNUNET_PEER_search (peer);
1550 for (i = 0; i < tunnel->npeers; i++)
1551 if (tunnel->peers[i]->id == peer_id)
1553 if (i == tunnel->npeers)
1558 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1559 tunnel->disconnect_handler (tunnel->cls, peer);
1560 GNUNET_PEER_change_rc (peer_id, -1);
1561 GNUNET_free (tunnel->peers[i]);
1562 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1563 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1565 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1566 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1567 msg.tunnel_id = htonl (tunnel->tid);
1568 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1569 send_packet (tunnel->mesh, &msg.header, tunnel);
1574 * Request that the mesh should try to connect to a peer supporting the given
1577 * @param tunnel handle to existing tunnel
1578 * @param app_type application type that must be supported by the peer (MESH
1579 * should discover peer in proximity handling this type)
1582 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1583 GNUNET_MESH_ApplicationType app_type)
1585 struct GNUNET_MESH_ConnectPeerByType msg;
1587 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1589 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1590 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1591 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1592 msg.tunnel_id = htonl (tunnel->tid);
1593 msg.type = htonl (app_type);
1594 send_packet (tunnel->mesh, &msg.header, tunnel);
1599 * Request that the mesh should try to connect to a peer matching the
1600 * description given in the service string.
1602 * @param tunnel handle to existing tunnel
1603 * @param description string describing the destination node requirements
1606 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1607 const char *description)
1609 struct GNUNET_MESH_ConnectPeerByString *msg;
1613 len = strlen(description);
1614 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1615 GNUNET_assert (UINT16_MAX > msgsize);
1616 msg = GNUNET_malloc (msgsize);
1617 msg->header.size = htons (msgsize);
1618 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1619 msg->tunnel_id = htonl (tunnel->tid);
1620 memcpy(&msg[1], description, len);
1622 send_packet (tunnel->mesh, &msg->header, tunnel);
1627 * Request that the given peer isn't added to this tunnel in calls to
1628 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1630 * @param tunnel handle to existing tunnel.
1631 * @param peer peer identity of the peer which should be blacklisted
1635 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1636 const struct GNUNET_PeerIdentity *peer)
1638 struct GNUNET_MESH_PeerControl msg;
1640 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1641 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1642 msg.tunnel_id = htonl (tunnel->tid);
1644 send_packet (tunnel->mesh, &msg.header, tunnel);
1651 * Request that the given peer isn't blacklisted anymore from this tunnel,
1652 * and therefore can be added in future calls to connect_by_*.
1653 * The peer must have been previously blacklisted for this tunnel.
1655 * @param tunnel handle to existing tunnel.
1656 * @param peer peer identity of the peer which shouldn't be blacklisted
1657 * for the tunnel anymore.
1660 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1661 const struct GNUNET_PeerIdentity *peer)
1663 struct GNUNET_MESH_PeerControl msg;
1665 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1666 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1667 msg.tunnel_id = htonl (tunnel->tid);
1669 send_packet (tunnel->mesh, &msg.header, tunnel);
1676 * Ask the mesh to call "notify" once it is ready to transmit the
1677 * given number of bytes to the specified "target". If we are not yet
1678 * connected to the specified peer, a call to this function will cause
1679 * us to try to establish a connection.
1681 * @param tunnel tunnel to use for transmission
1682 * @param cork is corking allowed for this transmission?
1683 * @param priority how important is the message?
1684 * @param maxdelay how long can the message wait?
1685 * @param target destination for the message,
1686 * NULL for multicast to all tunnel targets
1687 * @param notify_size how many bytes of buffer space does notify want?
1688 * @param notify function to call when buffer space is available;
1689 * will be called with NULL on timeout or if the overall queue
1690 * for this peer is larger than queue_size and this is currently
1691 * the message with the lowest priority
1692 * @param notify_cls closure for notify
1693 * @return non-NULL if the notify callback was queued,
1694 * NULL if we can not even queue the request (insufficient
1695 * memory); if NULL is returned, "notify" will NOT be called.
1697 struct GNUNET_MESH_TransmitHandle *
1698 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1700 struct GNUNET_TIME_Relative maxdelay,
1701 const struct GNUNET_PeerIdentity *target,
1703 GNUNET_CONNECTION_TransmitReadyNotify notify,
1706 struct GNUNET_MESH_TransmitHandle *th;
1707 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1708 uint32_t least_priority;
1711 GNUNET_assert (NULL != tunnel);
1712 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1714 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1716 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1717 GNUNET_assert (NULL != notify);
1718 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1719 tunnel->npackets > 0)
1724 th = tunnel->mesh->th_tail;
1725 least_priority = priority;
1726 least_priority_th = NULL;
1729 if (th->priority < least_priority && th->tunnel->npackets > 1)
1731 least_priority_th = th;
1732 least_priority = th->priority;
1736 if (NULL == least_priority_th)
1738 /* Can't be a control message */
1739 GNUNET_assert (NULL != least_priority_th->notify);
1740 least_priority_th->notify (notify_cls, 0, NULL);
1741 least_priority_th->tunnel->npackets--;
1742 tunnel->mesh->npackets--;
1743 GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1745 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1746 GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1747 GNUNET_free (least_priority_th);
1750 tunnel->mesh->npackets++;
1751 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1752 th->tunnel = tunnel;
1753 th->priority = priority;
1754 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1755 th->target = GNUNET_PEER_intern (target);
1756 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1757 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1758 else if (NULL == target)
1759 overhead = sizeof (struct GNUNET_MESH_Multicast);
1761 overhead = sizeof (struct GNUNET_MESH_Unicast);
1762 th->size = notify_size + overhead;
1763 th->notify = notify;
1764 th->notify_cls = notify_cls;
1765 add_to_queue (tunnel->mesh, th);
1766 if (NULL != tunnel->mesh->th)
1769 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1770 GNUNET_TIME_UNIT_FOREVER_REL,
1771 GNUNET_YES, &send_callback,
1778 * Cancel the specified transmission-ready notification.
1780 * @param th handle that was returned by "notify_transmit_ready".
1783 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1785 struct GNUNET_MESH_Handle *mesh;
1787 mesh = th->tunnel->mesh;
1788 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1789 GNUNET_SCHEDULER_cancel (th->timeout_task);
1790 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1792 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1794 /* queue empty, no point in asking for transmission */
1795 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1802 * Transition API for tunnel ctx management
1805 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1811 * Transition API for tunnel ctx management
1814 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)