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
303 * Is the tunnel throttled to the slowest peer?
308 * Is the tunnel allowed to buffer?
315 /******************************************************************************/
316 /*********************** AUXILIARY FUNCTIONS *************************/
317 /******************************************************************************/
320 * Get the tunnel handler for the tunnel specified by id from the given handle
321 * @param h Mesh handle
322 * @param tid ID of the wanted tunnel
323 * @return handle to the required tunnel or NULL if not found
325 static struct GNUNET_MESH_Tunnel *
326 retrieve_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
328 struct GNUNET_MESH_Tunnel *t;
342 * Create a new tunnel and insert it in the tunnel list of the mesh handle
343 * @param h Mesh handle
344 * @param tid desired tid of the tunnel, 0 to assign one automatically
345 * @return handle to the created tunnel
347 static struct GNUNET_MESH_Tunnel *
348 create_tunnel (struct GNUNET_MESH_Handle *h, MESH_TunnelNumber tid)
350 struct GNUNET_MESH_Tunnel *t;
352 t = GNUNET_malloc (sizeof (struct GNUNET_MESH_Tunnel));
353 GNUNET_CONTAINER_DLL_insert (h->tunnels_head, h->tunnels_tail, t);
357 t->tid = h->next_tid;
358 while (NULL != retrieve_tunnel (h, h->next_tid))
361 h->next_tid &= ~GNUNET_MESH_LOCAL_TUNNEL_ID_SERV;
362 h->next_tid |= GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
374 * Destroy the specified tunnel.
375 * - Destroys all peers, calling the disconnect callback on each if needed
376 * - Cancels all outgoing traffic for that tunnel, calling respective notifys
377 * - Calls cleaner if tunnel was inbound
378 * - Frees all memory used
380 * @param t Pointer to the tunnel.
381 * @param call_cleaner Whether to call the cleaner handler.
383 * @return Handle to the required tunnel or NULL if not found.
386 destroy_tunnel (struct GNUNET_MESH_Tunnel *t, int call_cleaner)
388 struct GNUNET_MESH_Handle *h;
389 struct GNUNET_PeerIdentity pi;
390 struct GNUNET_MESH_TransmitHandle *th;
391 struct GNUNET_MESH_TransmitHandle *next;
394 LOG (GNUNET_ERROR_TYPE_DEBUG, "destroy_tunnel %X\n", t->tid);
403 /* disconnect all peers */
404 GNUNET_CONTAINER_DLL_remove (h->tunnels_head, h->tunnels_tail, t);
405 for (i = 0; i < t->npeers; i++)
407 if ( (NULL != t->disconnect_handler) && t->peers[i]->connected)
409 GNUNET_PEER_resolve (t->peers[i]->id, &pi);
410 t->disconnect_handler (t->cls, &pi);
412 GNUNET_PEER_change_rc (t->peers[i]->id, -1);
413 GNUNET_free (t->peers[i]);
416 /* signal tunnel destruction */
417 if ( (NULL != h->cleaner) && (0 != t->owner) && (GNUNET_YES == call_cleaner) )
418 h->cleaner (h->cls, t, t->ctx);
420 /* check that clients did not leave messages behind in the queue */
421 for (th = h->th_head; NULL != th; th = next)
426 /* Clients should have aborted their requests already.
427 * Management traffic should be ok, as clients can't cancel that */
428 GNUNET_break (NULL == th->notify);
429 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
431 /* clean up request */
432 if (GNUNET_SCHEDULER_NO_TASK != th->timeout_task)
433 GNUNET_SCHEDULER_cancel (th->timeout_task);
437 /* if there are no more pending requests with mesh service, cancel active request */
438 /* Note: this should be unnecessary... */
439 if ( (NULL == h->th_head) && (NULL != h->th))
441 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
447 GNUNET_free (t->peers);
449 GNUNET_PEER_change_rc (t->owner, -1);
450 if (0 != t->napps && t->apps)
451 GNUNET_free (t->apps);
458 * Get the peer descriptor for the peer with id from the given tunnel
459 * @param t Tunnel handle
460 * @param id Short form ID of the wanted peer
461 * @return handle to the requested peer or NULL if not found
463 static struct GNUNET_MESH_Peer *
464 retrieve_peer (struct GNUNET_MESH_Tunnel *t, GNUNET_PEER_Id id)
468 for (i = 0; i < t->npeers; i++)
469 if (t->peers[i]->id == id)
476 * Add a peer into a tunnel
477 * @param t Tunnel handle
478 * @param pi Full ID of the new peer
479 * @return handle to the newly created peer
481 static struct GNUNET_MESH_Peer *
482 add_peer_to_tunnel (struct GNUNET_MESH_Tunnel *t,
483 const struct GNUNET_PeerIdentity *pi)
485 struct GNUNET_MESH_Peer *p;
493 id = GNUNET_PEER_intern (pi);
495 p = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
498 GNUNET_array_append (t->peers, t->npeers, p);
504 * Remove a peer from a tunnel
505 * @param p Peer handle
508 remove_peer_from_tunnel (struct GNUNET_MESH_Peer *p)
512 for (i = 0; i < p->t->npeers; i++)
514 if (p->t->peers[i] == p)
517 if (i == p->t->npeers)
522 p->t->peers[i] = p->t->peers[p->t->npeers - 1];
523 GNUNET_array_grow (p->t->peers, p->t->npeers, p->t->npeers - 1);
528 * Notify client that the transmission has timed out
530 * @param tc task context
533 timeout_transmission (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
535 struct GNUNET_MESH_TransmitHandle *th = cls;
536 struct GNUNET_MESH_Handle *mesh;
538 mesh = th->tunnel->mesh;
539 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
540 if (th->notify != NULL)
541 th->notify (th->notify_cls, 0, NULL);
543 if ((NULL == mesh->th_head) && (NULL != mesh->th))
545 /* queue empty, no point in asking for transmission */
546 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
553 * Add a transmit handle to the transmission queue by priority and set the
556 * @param h mesh handle with the queue head and tail
557 * @param th handle to the packet to be transmitted
560 add_to_queue (struct GNUNET_MESH_Handle *h,
561 struct GNUNET_MESH_TransmitHandle *th)
563 struct GNUNET_MESH_TransmitHandle *p;
566 while ((NULL != p) && (th->priority <= p->priority))
572 GNUNET_CONTAINER_DLL_insert_after (h->th_head, h->th_tail, p, th);
573 if (GNUNET_TIME_UNIT_FOREVER_ABS.abs_value == th->timeout.abs_value)
576 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
577 (th->timeout), &timeout_transmission, th);
582 * Auxiliary function to send an already constructed packet to the service.
583 * Takes care of creating a new queue element, copying the message and
584 * calling the tmt_rdy function if necessary.
586 * @param h mesh handle
587 * @param msg message to transmit
588 * @param tunnel tunnel this send is related to (NULL if N/A)
591 send_packet (struct GNUNET_MESH_Handle *h,
592 const struct GNUNET_MessageHeader *msg,
593 struct GNUNET_MESH_Tunnel *tunnel);
597 * Reconnect callback: tries to reconnect again after a failer previous
599 * @param cls closure (mesh handle)
600 * @param tc task context
603 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
607 * Send a connect packet to the service with the applications and types
608 * requested by the user.
610 * @param h The mesh handle.
614 send_connect (struct GNUNET_MESH_Handle *h)
618 size = sizeof (struct GNUNET_MESH_ClientConnect);
619 size += h->n_applications * sizeof (GNUNET_MESH_ApplicationType);
620 size += h->n_handlers * sizeof (uint16_t);
622 char buf[size] GNUNET_ALIGN;
623 struct GNUNET_MESH_ClientConnect *msg;
624 GNUNET_MESH_ApplicationType *apps;
629 /* build connection packet */
630 msg = (struct GNUNET_MESH_ClientConnect *) buf;
631 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT);
632 msg->header.size = htons (size);
633 apps = (GNUNET_MESH_ApplicationType *) &msg[1];
634 for (napps = 0; napps < h->n_applications; napps++)
636 apps[napps] = htonl (h->applications[napps]);
637 LOG (GNUNET_ERROR_TYPE_DEBUG, " app %u\n", h->applications[napps]);
639 types = (uint16_t *) & apps[napps];
640 for (ntypes = 0; ntypes < h->n_handlers; ntypes++)
641 types[ntypes] = htons (h->message_handlers[ntypes].type);
642 msg->applications = htons (napps);
643 msg->types = htons (ntypes);
644 LOG (GNUNET_ERROR_TYPE_DEBUG,
645 "Sending %lu bytes long message %d types and %d apps\n",
646 ntohs (msg->header.size), ntypes, napps);
647 send_packet (h, &msg->header, NULL);
653 * Reconnect to the service, retransmit all infomation to try to restore the
656 * @param h handle to the mesh
658 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
661 do_reconnect (struct GNUNET_MESH_Handle *h)
663 struct GNUNET_MESH_Tunnel *t;
666 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
667 LOG (GNUNET_ERROR_TYPE_DEBUG, "******* RECONNECT *******\n");
668 LOG (GNUNET_ERROR_TYPE_DEBUG, "*****************************\n");
670 h->in_receive = GNUNET_NO;
674 GNUNET_CLIENT_notify_transmit_ready_cancel (h->th);
677 if (NULL != h->client)
679 GNUNET_CLIENT_disconnect (h->client);
683 h->client = GNUNET_CLIENT_connect ("mesh", h->cfg);
684 if (h->client == NULL)
686 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
689 GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
690 GNUNET_TIME_relative_multiply
691 (h->reconnect_time, 2));
692 LOG (GNUNET_ERROR_TYPE_DEBUG, " Next retry in %sms\n",
693 GNUNET_TIME_relative_to_string (h->reconnect_time));
699 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
702 /* Rebuild all tunnels */
703 for (t = h->tunnels_head; NULL != t; t = t->next)
705 struct GNUNET_MESH_TunnelMessage tmsg;
706 struct GNUNET_MESH_PeerControl pmsg;
708 if (t->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
710 /* Tunnel was created by service (incoming tunnel) */
711 /* TODO: Notify service of missing tunnel, to request
712 * creator to recreate path (find a path to him via DHT?)
716 tmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
717 tmsg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
718 tmsg.tunnel_id = htonl (t->tid);
719 send_packet (h, &tmsg.header, t);
721 pmsg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
722 pmsg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
723 pmsg.tunnel_id = htonl (t->tid);
725 /* Reconnect all peers */
726 /* If the tunnel was "by type", dont connect individual peers */
727 for (i = 0; i < t->npeers && 0 == t->napps; i++)
729 GNUNET_PEER_resolve (t->peers[i]->id, &pmsg.peer);
730 if (NULL != t->disconnect_handler && t->peers[i]->connected)
731 t->disconnect_handler (t->cls, &pmsg.peer);
732 send_packet (t->mesh, &pmsg.header, t);
734 /* Reconnect all types, if any */
735 for (i = 0; i < t->napps; i++)
737 struct GNUNET_MESH_ConnectPeerByType msg;
739 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
740 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
741 msg.tunnel_id = htonl (t->tid);
742 msg.type = htonl (t->apps[i]);
743 send_packet (t->mesh, &msg.header, t);
745 if (GNUNET_NO == t->buffering)
746 GNUNET_MESH_tunnel_buffer (t, GNUNET_NO);
747 if (GNUNET_YES == t->speed_min)
748 GNUNET_MESH_tunnel_speed_min (t);
754 * Reconnect callback: tries to reconnect again after a failer previous
756 * @param cls closure (mesh handle)
757 * @param tc task context
760 reconnect_cbk (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
762 struct GNUNET_MESH_Handle *h = cls;
764 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
765 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
772 * Reconnect to the service, retransmit all infomation to try to restore the
775 * @param h handle to the mesh
777 * @return GNUNET_YES in case of sucess, GNUNET_NO otherwise (service down...)
780 reconnect (struct GNUNET_MESH_Handle *h)
782 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requested RECONNECT\n");
783 if (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task)
784 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->reconnect_time,
789 /******************************************************************************/
790 /*********************** RECEIVE HANDLERS ****************************/
791 /******************************************************************************/
794 * Process the new tunnel notification and add it to the tunnels in the handle
796 * @param h The mesh handle
797 * @param msg A message with the details of the new incoming tunnel
800 process_tunnel_created (struct GNUNET_MESH_Handle *h,
801 const struct GNUNET_MESH_TunnelNotification *msg)
803 struct GNUNET_MESH_Tunnel *t;
804 MESH_TunnelNumber tid;
806 tid = ntohl (msg->tunnel_id);
807 if (tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
812 if (NULL != h->new_tunnel)
814 struct GNUNET_ATS_Information atsi;
816 t = create_tunnel (h, tid);
817 t->owner = GNUNET_PEER_intern (&msg->peer);
819 t->peers = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer *));
820 t->peers[0] = GNUNET_malloc (sizeof (struct GNUNET_MESH_Peer));
822 t->peers[0]->connected = 1;
823 t->peers[0]->id = t->owner;
824 GNUNET_PEER_change_rc (t->owner, 1);
829 t->ctx = h->new_tunnel (h->cls, t, &msg->peer, &atsi);
830 LOG (GNUNET_ERROR_TYPE_DEBUG, "new incoming tunnel %X\n", t->tid);
834 struct GNUNET_MESH_TunnelMessage d_msg;
836 LOG (GNUNET_ERROR_TYPE_DEBUG, "No handler for incoming tunnels\n");
838 d_msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
839 d_msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
840 d_msg.tunnel_id = msg->tunnel_id;
842 send_packet (h, &d_msg.header, NULL);
849 * Process the tunnel destroy notification and free associated resources
851 * @param h The mesh handle
852 * @param msg A message with the details of the tunnel being destroyed
855 process_tunnel_destroy (struct GNUNET_MESH_Handle *h,
856 const struct GNUNET_MESH_TunnelMessage *msg)
858 struct GNUNET_MESH_Tunnel *t;
859 MESH_TunnelNumber tid;
861 tid = ntohl (msg->tunnel_id);
862 t = retrieve_tunnel (h, tid);
872 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X destroyed\n", t->tid);
873 destroy_tunnel (t, GNUNET_YES);
879 * Process the new peer event and notify the upper level of it
881 * @param h The mesh handle
882 * @param msg A message with the details of the peer event
885 process_peer_event (struct GNUNET_MESH_Handle *h,
886 const struct GNUNET_MESH_PeerControl *msg)
888 struct GNUNET_MESH_Tunnel *t;
889 struct GNUNET_MESH_Peer *p;
890 struct GNUNET_ATS_Information atsi;
894 LOG (GNUNET_ERROR_TYPE_DEBUG, "processig peer event\n");
895 size = ntohs (msg->header.size);
896 if (size != sizeof (struct GNUNET_MESH_PeerControl))
901 t = retrieve_tunnel (h, ntohl (msg->tunnel_id));
907 id = GNUNET_PEER_search (&msg->peer);
908 if ((p = retrieve_peer (t, id)) == NULL)
909 p = add_peer_to_tunnel (t, &msg->peer);
910 if (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD == ntohs (msg->header.type))
912 LOG (GNUNET_ERROR_TYPE_DEBUG, "adding peer\n");
913 if (NULL != t->connect_handler)
917 t->connect_handler (t->cls, &msg->peer, &atsi);
923 LOG (GNUNET_ERROR_TYPE_DEBUG, "removing peer\n");
924 if (NULL != t->disconnect_handler && p->connected)
926 t->disconnect_handler (t->cls, &msg->peer);
928 remove_peer_from_tunnel (p);
931 LOG (GNUNET_ERROR_TYPE_DEBUG, "processing peer event END\n");
936 * Process the incoming data packets
938 * @param h The mesh handle
939 * @param message A message encapsulating the data
941 * @return GNUNET_YES if everything went fine
942 * GNUNET_NO if client closed connection (h no longer valid)
945 process_incoming_data (struct GNUNET_MESH_Handle *h,
946 const struct GNUNET_MessageHeader *message)
948 const struct GNUNET_MessageHeader *payload;
949 const struct GNUNET_MESH_MessageHandler *handler;
950 const struct GNUNET_PeerIdentity *peer;
951 struct GNUNET_MESH_Unicast *ucast;
952 struct GNUNET_MESH_Multicast *mcast;
953 struct GNUNET_MESH_ToOrigin *to_orig;
954 struct GNUNET_MESH_Tunnel *t;
958 LOG (GNUNET_ERROR_TYPE_DEBUG, "Got a data message!\n");
959 type = ntohs (message->type);
962 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
963 ucast = (struct GNUNET_MESH_Unicast *) message;
965 t = retrieve_tunnel (h, ntohl (ucast->tid));
966 payload = (struct GNUNET_MessageHeader *) &ucast[1];
968 LOG (GNUNET_ERROR_TYPE_DEBUG, " ucast on tunnel %s [%X]\n",
969 GNUNET_i2s (peer), ntohl (ucast->tid));
971 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
972 mcast = (struct GNUNET_MESH_Multicast *) message;
973 t = retrieve_tunnel (h, ntohl (mcast->tid));
974 payload = (struct GNUNET_MessageHeader *) &mcast[1];
976 LOG (GNUNET_ERROR_TYPE_DEBUG, " mcast on tunnel %s [%X]\n",
977 GNUNET_i2s (peer), ntohl (mcast->tid));
979 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
980 to_orig = (struct GNUNET_MESH_ToOrigin *) message;
981 t = retrieve_tunnel (h, ntohl (to_orig->tid));
982 payload = (struct GNUNET_MessageHeader *) &to_orig[1];
983 peer = &to_orig->sender;
984 LOG (GNUNET_ERROR_TYPE_DEBUG, " torig on tunnel %s [%X]\n",
985 GNUNET_i2s (peer), ntohl (to_orig->tid));
993 /* Tunnel was ignored, probably service didn't get it yet */
996 type = ntohs (payload->type);
997 for (i = 0; i < h->n_handlers; i++)
999 handler = &h->message_handlers[i];
1000 if (handler->type == type)
1002 struct GNUNET_ATS_Information atsi;
1007 handler->callback (h->cls, t, &t->ctx, peer, payload, &atsi))
1009 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH: callback caused disconnection\n");
1010 GNUNET_MESH_disconnect (h);
1015 LOG (GNUNET_ERROR_TYPE_DEBUG,
1016 "MESH: callback completed successfully\n");
1026 * Function to process all messages received from the service
1028 * @param cls closure
1029 * @param msg message received, NULL on timeout or fatal error
1032 msg_received (void *cls, const struct GNUNET_MessageHeader *msg)
1034 struct GNUNET_MESH_Handle *h = cls;
1038 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL msg\n");
1042 LOG (GNUNET_ERROR_TYPE_DEBUG, "received a message type %hu from MESH\n",
1044 switch (ntohs (msg->type))
1046 /* Notify of a new incoming tunnel */
1047 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE:
1048 process_tunnel_created (h, (struct GNUNET_MESH_TunnelNotification *) msg);
1050 /* Notify of a tunnel disconnection */
1051 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1052 process_tunnel_destroy (h, (struct GNUNET_MESH_TunnelMessage *) msg);
1054 /* Notify of a new peer or a peer disconnect in the tunnel */
1055 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD:
1056 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL:
1057 process_peer_event (h, (struct GNUNET_MESH_PeerControl *) msg);
1059 /* Notify of a new data packet in the tunnel */
1060 case GNUNET_MESSAGE_TYPE_MESH_UNICAST:
1061 case GNUNET_MESSAGE_TYPE_MESH_MULTICAST:
1062 case GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN:
1063 if (GNUNET_NO == process_incoming_data (h, msg))
1066 /* We shouldn't get any other packages, log and ignore */
1068 LOG (GNUNET_ERROR_TYPE_WARNING,
1069 "MESH: unsolicited message form service (type %d)\n",
1072 LOG (GNUNET_ERROR_TYPE_DEBUG, "message processed\n");
1073 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1074 GNUNET_TIME_UNIT_FOREVER_REL);
1078 /******************************************************************************/
1079 /************************ SEND FUNCTIONS ****************************/
1080 /******************************************************************************/
1083 * Function called to send a message to the service.
1084 * "buf" will be NULL and "size" zero if the socket was closed for writing in
1087 * @param cls closure, the mesh handle
1088 * @param size number of bytes available in buf
1089 * @param buf where the callee should write the connect message
1090 * @return number of bytes written to buf
1093 send_callback (void *cls, size_t size, void *buf)
1095 struct GNUNET_MESH_Handle *h = cls;
1096 struct GNUNET_MESH_TransmitHandle *th;
1101 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() Buffer %u\n", size);
1103 if ((0 == size) || (NULL == buf))
1105 LOG (GNUNET_ERROR_TYPE_DEBUG, "Received NULL callback\n");
1110 while ((NULL != (th = h->th_head)) && (size >= th->size))
1112 if (NULL != th->notify)
1114 if (th->tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1116 /* traffic to origin */
1117 struct GNUNET_MESH_ToOrigin to;
1118 struct GNUNET_MessageHeader *mh;
1120 GNUNET_assert (size >= th->size);
1121 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (to)];
1122 psize = th->notify (th->notify_cls, size - sizeof (to), mh);
1123 LOG (GNUNET_ERROR_TYPE_DEBUG, " to origin, type %u\n",
1127 psize += sizeof (to);
1128 GNUNET_assert (size >= psize);
1129 to.header.size = htons (psize);
1130 to.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_TO_ORIGIN);
1131 to.tid = htonl (th->tunnel->tid);
1132 memset (&to.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1133 memset (&to.sender, 0, sizeof (struct GNUNET_PeerIdentity));
1134 memcpy (cbuf, &to, sizeof (to));
1137 else if (th->target == 0)
1140 struct GNUNET_MESH_Multicast mc;
1141 struct GNUNET_MessageHeader *mh;
1143 GNUNET_assert (size >= th->size);
1144 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (mc)];
1145 psize = th->notify (th->notify_cls, size - sizeof (mc), mh);
1146 LOG (GNUNET_ERROR_TYPE_DEBUG, " multicast, type %u\n",
1150 psize += sizeof (mc);
1151 GNUNET_assert (size >= psize);
1152 mc.header.size = htons (psize);
1153 mc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_MULTICAST);
1154 mc.tid = htonl (th->tunnel->tid);
1157 memset (&mc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1158 memcpy (cbuf, &mc, sizeof (mc));
1164 struct GNUNET_MESH_Unicast uc;
1165 struct GNUNET_MessageHeader *mh;
1167 GNUNET_assert (size >= th->size);
1168 mh = (struct GNUNET_MessageHeader *) &cbuf[sizeof (uc)];
1169 psize = th->notify (th->notify_cls, size - sizeof (uc), mh);
1170 LOG (GNUNET_ERROR_TYPE_DEBUG, " unicast, type %u\n",
1174 psize += sizeof (uc);
1175 GNUNET_assert (size >= psize);
1176 uc.header.size = htons (psize);
1177 uc.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_UNICAST);
1178 uc.tid = htonl (th->tunnel->tid);
1179 memset (&uc.oid, 0, sizeof (struct GNUNET_PeerIdentity));
1180 GNUNET_PEER_resolve (th->target, &uc.destination);
1181 memcpy (cbuf, &uc, sizeof (uc));
1187 struct GNUNET_MessageHeader *mh = (struct GNUNET_MessageHeader *) &th[1];
1188 LOG (GNUNET_ERROR_TYPE_DEBUG, " mesh traffic, type %u\n",
1190 memcpy (cbuf, &th[1], th->size);
1193 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1194 GNUNET_SCHEDULER_cancel (th->timeout_task);
1195 if (NULL != th->notify)
1197 th->tunnel->mesh->npackets--;
1198 th->tunnel->npackets--;
1200 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1206 LOG (GNUNET_ERROR_TYPE_DEBUG, " total size: %u\n", tsize);
1207 if (NULL != (th = h->th_head))
1209 LOG (GNUNET_ERROR_TYPE_DEBUG, " next size: %u\n", th->size);
1212 GNUNET_CLIENT_notify_transmit_ready (h->client, th->size,
1213 GNUNET_TIME_UNIT_FOREVER_REL,
1214 GNUNET_YES, &send_callback, h);
1216 LOG (GNUNET_ERROR_TYPE_DEBUG, "Send packet() END\n");
1217 if (GNUNET_NO == h->in_receive)
1219 h->in_receive = GNUNET_YES;
1220 GNUNET_CLIENT_receive (h->client, &msg_received, h,
1221 GNUNET_TIME_UNIT_FOREVER_REL);
1228 * Auxiliary function to send an already constructed packet to the service.
1229 * Takes care of creating a new queue element, copying the message and
1230 * calling the tmt_rdy function if necessary.
1232 * @param h mesh handle
1233 * @param msg message to transmit
1234 * @param tunnel tunnel this send is related to (NULL if N/A)
1237 send_packet (struct GNUNET_MESH_Handle *h,
1238 const struct GNUNET_MessageHeader *msg,
1239 struct GNUNET_MESH_Tunnel *tunnel)
1241 struct GNUNET_MESH_TransmitHandle *th;
1244 msize = ntohs (msg->size);
1245 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle) + msize);
1246 th->priority = UINT32_MAX;
1247 th->timeout = GNUNET_TIME_UNIT_FOREVER_ABS;
1249 th->tunnel = tunnel;
1250 memcpy (&th[1], msg, msize);
1251 add_to_queue (h, th);
1255 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
1256 GNUNET_TIME_UNIT_FOREVER_REL,
1257 GNUNET_YES, &send_callback, h);
1261 /******************************************************************************/
1262 /********************** API CALL DEFINITIONS *************************/
1263 /******************************************************************************/
1266 * Connect to the mesh service.
1268 * @param cfg configuration to use
1269 * @param queue_size size of the data message queue, shared among all tunnels
1270 * (each tunnel is guaranteed to accept at least one message,
1271 * no matter what is the status of other tunnels)
1272 * @param cls closure for the various callbacks that follow
1273 * (including handlers in the handlers array)
1274 * @param new_tunnel function called when an *inbound* tunnel is created
1275 * @param cleaner function called when an *inbound* tunnel is destroyed by the
1276 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
1277 * is called on the tunnel
1278 * @param handlers callbacks for messages we care about, NULL-terminated
1279 * note that the mesh is allowed to drop notifications about
1280 * inbound messages if the client does not process them fast
1281 * enough (for this notification type, a bounded queue is used)
1282 * @param stypes list of the applications that this client claims to provide
1283 * @return handle to the mesh service NULL on error
1284 * (in this case, init is never called)
1286 struct GNUNET_MESH_Handle *
1287 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1288 unsigned int queue_size, void *cls,
1289 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
1290 GNUNET_MESH_TunnelEndHandler cleaner,
1291 const struct GNUNET_MESH_MessageHandler *handlers,
1292 const GNUNET_MESH_ApplicationType *stypes)
1294 struct GNUNET_MESH_Handle *h;
1296 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect()\n");
1297 h = GNUNET_malloc (sizeof (struct GNUNET_MESH_Handle));
1299 h->max_queue_size = queue_size;
1300 h->new_tunnel = new_tunnel;
1301 h->cleaner = cleaner;
1302 h->client = GNUNET_CLIENT_connect ("mesh", cfg);
1303 if (h->client == NULL)
1311 h->applications = stypes;
1312 h->message_handlers = handlers;
1313 h->next_tid = GNUNET_MESH_LOCAL_TUNNEL_ID_CLI;
1314 h->reconnect_time = GNUNET_TIME_UNIT_MILLISECONDS;
1315 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1317 /* count handlers and apps, calculate size */
1318 for (h->n_applications = 0; stypes[h->n_applications]; h->n_applications++) ;
1319 for (h->n_handlers = 0; handlers[h->n_handlers].type; h->n_handlers++) ;
1321 LOG (GNUNET_ERROR_TYPE_DEBUG, "GNUNET_MESH_connect() END\n");
1327 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
1328 * disconnect callbacks will be called on any still connected peers, notifying
1329 * about their disconnection. The registered inbound tunnel cleaner will be
1330 * called should any inbound tunnels still exist.
1332 * @param handle connection to mesh to disconnect
1335 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle)
1337 struct GNUNET_MESH_Tunnel *t;
1338 struct GNUNET_MESH_Tunnel *aux;
1339 struct GNUNET_MESH_TransmitHandle *th;
1341 LOG (GNUNET_ERROR_TYPE_DEBUG, "MESH DISCONNECT\n");
1343 t = handle->tunnels_head;
1347 if (t->tid < GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1350 LOG (GNUNET_ERROR_TYPE_DEBUG, "tunnel %X not destroyed\n", t->tid);
1352 destroy_tunnel (t, GNUNET_YES);
1355 while ( (th = handle->th_head) != NULL)
1357 struct GNUNET_MessageHeader *msg;
1359 /* Make sure it is an allowed packet (everything else should have been
1360 * already canceled).
1362 GNUNET_break (UINT32_MAX == th->priority);
1363 GNUNET_break (NULL == th->notify);
1364 msg = (struct GNUNET_MessageHeader *) &th[1];
1365 switch (ntohs(msg->type))
1367 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT:
1368 case GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY:
1372 LOG (GNUNET_ERROR_TYPE_DEBUG, "unexpected msg %u\n",
1376 GNUNET_CONTAINER_DLL_remove (handle->th_head, handle->th_tail, th);
1380 if (NULL != handle->th)
1382 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->th);
1385 if (NULL != handle->client)
1387 GNUNET_CLIENT_disconnect (handle->client);
1388 handle->client = NULL;
1390 if (GNUNET_SCHEDULER_NO_TASK != handle->reconnect_task)
1392 GNUNET_SCHEDULER_cancel(handle->reconnect_task);
1393 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1395 GNUNET_free (handle);
1400 * Announce to ther peer the availability of services described by the regex,
1401 * in order to be reachable to other peers via connect_by_string.
1403 * Note that the first 8 characters are considered to be part of a prefix,
1404 * (for instance 'gnunet://'). If you put a variable part in there (*, +. ()),
1405 * all matching strings will be stored in the DHT.
1407 * @param h handle to mesh.
1408 * @param regex string with the regular expression describing local services.
1411 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
1414 struct GNUNET_MessageHeader *msg;
1418 len = strlen (regex);
1419 msgsize = sizeof(struct GNUNET_MessageHeader) + len;
1420 GNUNET_assert (UINT16_MAX > msgsize);
1422 msg = GNUNET_malloc (msgsize);
1423 msg->size = htons (msgsize);
1424 msg->type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_ANNOUNCE_REGEX);
1425 memcpy (&msg[1], regex, len);
1427 send_packet(h, msg, NULL);
1431 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
1432 * and to broadcast).
1434 * @param h mesh handle
1435 * @param tunnel_ctx client's tunnel context to associate with the tunnel
1436 * @param connect_handler function to call when peers are actually connected
1437 * @param disconnect_handler function to call when peers are disconnected
1438 * @param handler_cls closure for connect/disconnect handlers
1440 struct GNUNET_MESH_Tunnel *
1441 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
1442 GNUNET_MESH_PeerConnectHandler connect_handler,
1443 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
1446 struct GNUNET_MESH_Tunnel *t;
1447 struct GNUNET_MESH_TunnelMessage msg;
1449 LOG (GNUNET_ERROR_TYPE_DEBUG, "Creating new tunnel\n");
1450 t = create_tunnel (h, 0);
1451 t->connect_handler = connect_handler;
1452 t->disconnect_handler = disconnect_handler;
1453 t->cls = handler_cls;
1454 t->ctx = tunnel_ctx;
1455 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE);
1456 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1457 msg.tunnel_id = htonl (t->tid);
1458 send_packet (h, &msg.header, t);
1464 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
1467 * @param tunnel tunnel handle
1470 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel)
1472 struct GNUNET_MESH_Handle *h;
1473 struct GNUNET_MESH_TunnelMessage msg;
1474 struct GNUNET_MESH_TransmitHandle *th;
1476 LOG (GNUNET_ERROR_TYPE_DEBUG, "Destroying tunnel\n");
1479 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_DESTROY);
1480 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1481 msg.tunnel_id = htonl (tunnel->tid);
1485 struct GNUNET_MESH_TransmitHandle *aux;
1486 if (th->tunnel == tunnel)
1489 /* FIXME call the handler? */
1490 if (NULL != th->notify)
1491 th->notify (th->notify_cls, 0, NULL);
1492 GNUNET_CONTAINER_DLL_remove (h->th_head, h->th_tail, th);
1500 destroy_tunnel (tunnel, GNUNET_NO);
1501 send_packet (h, &msg.header, NULL);
1505 * Request that the tunnel data rate is limited to the speed of the slowest
1508 * @param tunnel Tunnel affected.
1511 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel)
1513 struct GNUNET_MESH_TunnelMessage msg;
1514 struct GNUNET_MESH_Handle *h;
1517 tunnel->speed_min = GNUNET_YES;
1519 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MIN);
1520 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1521 msg.tunnel_id = htonl (tunnel->tid);
1523 send_packet (h, &msg.header, NULL);
1528 * Request that the tunnel data rate is limited to the speed of the fastest
1529 * receiver. This is the default behavior.
1531 * @param tunnel Tunnel affected.
1534 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel)
1536 struct GNUNET_MESH_TunnelMessage msg;
1537 struct GNUNET_MESH_Handle *h;
1540 tunnel->speed_min = GNUNET_NO;
1542 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_MAX);
1543 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1544 msg.tunnel_id = htonl (tunnel->tid);
1546 send_packet (h, &msg.header, NULL);
1550 * Turn on/off the buffering status of the tunnel.
1552 * @param tunnel Tunnel affected.
1553 * @param buffer GNUNET_YES to turn buffering on (default),
1554 * GNUNET_NO otherwise.
1557 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer)
1559 struct GNUNET_MESH_TunnelMessage msg;
1560 struct GNUNET_MESH_Handle *h;
1563 tunnel->buffering = buffer;
1565 if (GNUNET_YES == buffer)
1566 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_BUFFER);
1568 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOBUFFER);
1569 msg.header.size = htons (sizeof (struct GNUNET_MESH_TunnelMessage));
1570 msg.tunnel_id = htonl (tunnel->tid);
1572 send_packet (h, &msg.header, NULL);
1576 * Request that a peer should be added to the tunnel. The existing
1577 * connect handler will be called ONCE with either success or failure.
1578 * This function should NOT be called again with the same peer before the
1579 * connect handler is called.
1581 * @param tunnel handle to existing tunnel
1582 * @param peer peer to add
1585 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
1586 const struct GNUNET_PeerIdentity *peer)
1588 struct GNUNET_MESH_PeerControl msg;
1589 GNUNET_PEER_Id peer_id;
1592 peer_id = GNUNET_PEER_intern (peer);
1593 for (i = 0; i < tunnel->npeers; i++)
1595 if (tunnel->peers[i]->id == peer_id)
1597 /* Peer already exists in tunnel */
1598 GNUNET_PEER_change_rc (peer_id, -1);
1603 if (NULL == add_peer_to_tunnel (tunnel, peer))
1606 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1607 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD);
1608 msg.tunnel_id = htonl (tunnel->tid);
1610 send_packet (tunnel->mesh, &msg.header, tunnel);
1617 * Request that a peer should be removed from the tunnel. The existing
1618 * disconnect handler will be called ONCE if we were connected.
1620 * @param tunnel handle to existing tunnel
1621 * @param peer peer to remove
1624 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
1625 const struct GNUNET_PeerIdentity *peer)
1627 struct GNUNET_MESH_PeerControl msg;
1628 GNUNET_PEER_Id peer_id;
1631 peer_id = GNUNET_PEER_search (peer);
1637 for (i = 0; i < tunnel->npeers; i++)
1638 if (tunnel->peers[i]->id == peer_id)
1640 if (i == tunnel->npeers)
1645 if (NULL != tunnel->disconnect_handler && tunnel->peers[i]->connected == 1)
1646 tunnel->disconnect_handler (tunnel->cls, peer);
1647 GNUNET_PEER_change_rc (peer_id, -1);
1648 GNUNET_free (tunnel->peers[i]);
1649 tunnel->peers[i] = tunnel->peers[tunnel->npeers - 1];
1650 GNUNET_array_grow (tunnel->peers, tunnel->npeers, tunnel->npeers - 1);
1652 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1653 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_DEL);
1654 msg.tunnel_id = htonl (tunnel->tid);
1655 memcpy (&msg.peer, peer, sizeof (struct GNUNET_PeerIdentity));
1656 send_packet (tunnel->mesh, &msg.header, tunnel);
1661 * Request that the mesh should try to connect to a peer supporting the given
1664 * @param tunnel handle to existing tunnel
1665 * @param app_type application type that must be supported by the peer (MESH
1666 * should discover peer in proximity handling this type)
1669 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
1670 GNUNET_MESH_ApplicationType app_type)
1672 struct GNUNET_MESH_ConnectPeerByType msg;
1674 GNUNET_array_append (tunnel->apps, tunnel->napps, app_type);
1676 LOG (GNUNET_ERROR_TYPE_DEBUG, "* CONNECT BY TYPE *\n");
1677 msg.header.size = htons (sizeof (struct GNUNET_MESH_ConnectPeerByType));
1678 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_TYPE);
1679 msg.tunnel_id = htonl (tunnel->tid);
1680 msg.type = htonl (app_type);
1681 send_packet (tunnel->mesh, &msg.header, tunnel);
1686 * Request that the mesh should try to connect to a peer matching the
1687 * description given in the service string.
1689 * FIXME: allow multiple? how to deal with reconnect?
1691 * @param tunnel handle to existing tunnel
1692 * @param description string describing the destination node requirements
1695 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
1696 const char *description)
1698 struct GNUNET_MESH_ConnectPeerByString *msg;
1702 len = strlen(description);
1703 msgsize = sizeof(struct GNUNET_MESH_ConnectPeerByString) + len;
1704 GNUNET_assert (UINT16_MAX > msgsize);
1705 msg = GNUNET_malloc (msgsize);
1706 msg->header.size = htons (msgsize);
1707 msg->header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_ADD_BY_STRING);
1708 msg->tunnel_id = htonl (tunnel->tid);
1709 memcpy(&msg[1], description, len);
1711 send_packet (tunnel->mesh, &msg->header, tunnel);
1716 * Request that the given peer isn't added to this tunnel in calls to
1717 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
1719 * @param tunnel handle to existing tunnel.
1720 * @param peer peer identity of the peer which should be blacklisted
1724 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
1725 const struct GNUNET_PeerIdentity *peer)
1727 struct GNUNET_MESH_PeerControl msg;
1729 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1730 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_BLACKLIST);
1731 msg.tunnel_id = htonl (tunnel->tid);
1733 send_packet (tunnel->mesh, &msg.header, tunnel);
1740 * Request that the given peer isn't blacklisted anymore from this tunnel,
1741 * and therefore can be added in future calls to connect_by_*.
1742 * The peer must have been previously blacklisted for this tunnel.
1744 * @param tunnel handle to existing tunnel.
1745 * @param peer peer identity of the peer which shouldn't be blacklisted
1746 * for the tunnel anymore.
1749 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
1750 const struct GNUNET_PeerIdentity *peer)
1752 struct GNUNET_MESH_PeerControl msg;
1754 msg.header.size = htons (sizeof (struct GNUNET_MESH_PeerControl));
1755 msg.header.type = htons (GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_UNBLACKLIST);
1756 msg.tunnel_id = htonl (tunnel->tid);
1758 send_packet (tunnel->mesh, &msg.header, tunnel);
1765 * Ask the mesh to call "notify" once it is ready to transmit the
1766 * given number of bytes to the specified "target". If we are not yet
1767 * connected to the specified peer, a call to this function will cause
1768 * us to try to establish a connection.
1770 * @param tunnel tunnel to use for transmission
1771 * @param cork is corking allowed for this transmission?
1772 * @param priority how important is the message?
1773 * @param maxdelay how long can the message wait?
1774 * @param target destination for the message,
1775 * NULL for multicast to all tunnel targets
1776 * @param notify_size how many bytes of buffer space does notify want?
1777 * @param notify function to call when buffer space is available;
1778 * will be called with NULL on timeout or if the overall queue
1779 * for this peer is larger than queue_size and this is currently
1780 * the message with the lowest priority
1781 * @param notify_cls closure for notify
1782 * @return non-NULL if the notify callback was queued,
1783 * NULL if we can not even queue the request (insufficient
1784 * memory); if NULL is returned, "notify" will NOT be called.
1786 struct GNUNET_MESH_TransmitHandle *
1787 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
1789 struct GNUNET_TIME_Relative maxdelay,
1790 const struct GNUNET_PeerIdentity *target,
1792 GNUNET_CONNECTION_TransmitReadyNotify notify,
1795 struct GNUNET_MESH_TransmitHandle *th;
1796 struct GNUNET_MESH_TransmitHandle *least_priority_th;
1797 uint32_t least_priority;
1800 GNUNET_assert (NULL != tunnel);
1801 LOG (GNUNET_ERROR_TYPE_DEBUG, "mesh notify transmit ready called\n");
1803 LOG (GNUNET_ERROR_TYPE_DEBUG, " target %s\n", GNUNET_i2s (target));
1805 LOG (GNUNET_ERROR_TYPE_DEBUG, " target multicast\n");
1806 GNUNET_assert (NULL != notify);
1807 if (tunnel->mesh->npackets >= tunnel->mesh->max_queue_size &&
1808 tunnel->npackets > 0)
1813 th = tunnel->mesh->th_tail;
1814 least_priority = priority;
1815 least_priority_th = NULL;
1818 if (th->priority < least_priority && th->tunnel->npackets > 1)
1820 least_priority_th = th;
1821 least_priority = th->priority;
1825 if (NULL == least_priority_th)
1827 /* Can't be a control message */
1828 GNUNET_assert (NULL != least_priority_th->notify);
1829 least_priority_th->notify (notify_cls, 0, NULL);
1830 least_priority_th->tunnel->npackets--;
1831 tunnel->mesh->npackets--;
1832 GNUNET_CONTAINER_DLL_remove (tunnel->mesh->th_head, tunnel->mesh->th_tail,
1834 if (GNUNET_SCHEDULER_NO_TASK != least_priority_th->timeout_task)
1835 GNUNET_SCHEDULER_cancel (least_priority_th->timeout_task);
1836 GNUNET_free (least_priority_th);
1839 tunnel->mesh->npackets++;
1840 th = GNUNET_malloc (sizeof (struct GNUNET_MESH_TransmitHandle));
1841 th->tunnel = tunnel;
1842 th->priority = priority;
1843 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1844 th->target = GNUNET_PEER_intern (target);
1845 if (tunnel->tid >= GNUNET_MESH_LOCAL_TUNNEL_ID_SERV)
1846 overhead = sizeof (struct GNUNET_MESH_ToOrigin);
1847 else if (NULL == target)
1848 overhead = sizeof (struct GNUNET_MESH_Multicast);
1850 overhead = sizeof (struct GNUNET_MESH_Unicast);
1851 th->size = notify_size + overhead;
1852 th->notify = notify;
1853 th->notify_cls = notify_cls;
1854 add_to_queue (tunnel->mesh, th);
1855 if (NULL != tunnel->mesh->th)
1858 GNUNET_CLIENT_notify_transmit_ready (tunnel->mesh->client, th->size,
1859 GNUNET_TIME_UNIT_FOREVER_REL,
1860 GNUNET_YES, &send_callback,
1867 * Cancel the specified transmission-ready notification.
1869 * @param th handle that was returned by "notify_transmit_ready".
1872 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th)
1874 struct GNUNET_MESH_Handle *mesh;
1876 mesh = th->tunnel->mesh;
1877 if (th->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1878 GNUNET_SCHEDULER_cancel (th->timeout_task);
1879 GNUNET_CONTAINER_DLL_remove (mesh->th_head, mesh->th_tail, th);
1881 if ((NULL == mesh->th_head) && (NULL != mesh->th))
1883 /* queue empty, no point in asking for transmission */
1884 GNUNET_CLIENT_notify_transmit_ready_cancel (mesh->th);
1891 * Transition API for tunnel ctx management
1894 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data)
1900 * Transition API for tunnel ctx management
1903 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel)