2 This file is part of GNUnet.
3 (C) 2009--2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief library to access the DV service
24 * @author Christian Grothoff
25 * @author Nathan Evans
28 #include "gnunet_util_lib.h"
29 #include "gnunet_dv_service.h"
30 #include "gnunet_protocols.h"
32 #include "gnunet_transport_plugin.h"
34 #define LOG(kind,...) GNUNET_log_from (kind, "dv-api",__VA_ARGS__)
38 * Information we track for each peer.
44 * Handle for a send operation.
46 struct GNUNET_DV_TransmitHandle
51 struct GNUNET_DV_TransmitHandle *next;
56 struct GNUNET_DV_TransmitHandle *prev;
59 * Handle to the service.
61 struct GNUNET_DV_ServiceHandle *sh;
64 * Function to call upon completion.
66 GNUNET_DV_MessageSentCallback cb;
74 * The actual message (allocated at the end of this struct).
76 const struct GNUNET_MessageHeader *msg;
79 * Destination for the message.
81 struct ConnectedPeer *target;
84 * UID of our message, if any.
92 * Information we track for each peer.
98 * Identity of the peer.
100 struct GNUNET_PeerIdentity pid;
103 * Head of DLL of transmission handles where we need
104 * to invoke a continuation when we are informed about
105 * successful transmission. The respective request
106 * has already been sent to the DV service.
108 struct GNUNET_DV_TransmitHandle *head;
111 * Tail of DLL of transmission handles where we need
112 * to invoke a continuation when we are informed about
113 * successful transmission. The respective request
114 * has already been sent to the DV service.
116 struct GNUNET_DV_TransmitHandle *tail;
122 * Handle to the DV service.
124 struct GNUNET_DV_ServiceHandle
128 * Connection to DV service.
130 struct GNUNET_CLIENT_Connection *client;
133 * Active request for transmission to DV service.
135 struct GNUNET_CLIENT_TransmitHandle *th;
140 const struct GNUNET_CONFIGURATION_Handle *cfg;
143 * Closure for the callbacks.
148 * Function to call on connect events.
150 GNUNET_DV_ConnectCallback connect_cb;
153 * Function to call on distance change events.
155 GNUNET_DV_DistanceChangedCallback distance_cb;
158 * Function to call on disconnect events.
160 GNUNET_DV_DisconnectCallback disconnect_cb;
163 * Function to call on receiving messages events.
165 GNUNET_DV_MessageReceivedCallback message_cb;
168 * Head of messages to transmit.
170 struct GNUNET_DV_TransmitHandle *th_head;
173 * Tail of messages to transmit.
175 struct GNUNET_DV_TransmitHandle *th_tail;
178 * Information tracked per connected peer. Maps peer
179 * identities to `struct ConnectedPeer` entries.
181 struct GNUNET_CONTAINER_MultiPeerMap *peers;
192 * Disconnect and then reconnect to the DV service.
194 * @param sh service handle
197 reconnect (struct GNUNET_DV_ServiceHandle *sh);
201 * Gives a message from our queue to the DV service.
203 * @param cls handle to the dv service (struct GNUNET_DV_ServiceHandle)
204 * @param size how many bytes can we send
205 * @param buf where to copy the message to send
206 * @return how many bytes we copied to @a buf
209 transmit_pending (void *cls, size_t size, void *buf)
211 struct GNUNET_DV_ServiceHandle *sh = cls;
213 struct GNUNET_DV_TransmitHandle *th;
224 while ( (NULL != (th = sh->th_head)) &&
225 (size - ret >= (tsize = ntohs (th->msg->size)) ))
227 GNUNET_CONTAINER_DLL_remove (sh->th_head,
230 memcpy (&cbuf[ret], th->msg, tsize);
235 GNUNET_CONTAINER_DLL_insert (th->target->head,
249 * Start sending messages from our queue to the service.
251 * @param sh service handle
254 start_transmit (struct GNUNET_DV_ServiceHandle *sh)
258 if (NULL == sh->th_head)
261 GNUNET_CLIENT_notify_transmit_ready (sh->client,
262 ntohs (sh->th_head->msg->size),
263 GNUNET_TIME_UNIT_FOREVER_REL,
265 &transmit_pending, sh);
270 * We got disconnected from the service and thus all of the
271 * pending send callbacks will never be confirmed. Clean up.
273 * @param cls the 'struct GNUNET_DV_ServiceHandle'
274 * @param key a peer identity
275 * @param value a `struct ConnectedPeer` to clean up
276 * @return #GNUNET_OK (continue to iterate)
279 cleanup_send_cb (void *cls,
280 const struct GNUNET_PeerIdentity *key,
283 struct GNUNET_DV_ServiceHandle *sh = cls;
284 struct ConnectedPeer *peer = value;
285 struct GNUNET_DV_TransmitHandle *th;
287 GNUNET_assert (GNUNET_YES ==
288 GNUNET_CONTAINER_multipeermap_remove (sh->peers,
291 sh->disconnect_cb (sh->cls,
293 while (NULL != (th = peer->head))
295 GNUNET_CONTAINER_DLL_remove (peer->head, peer->tail, th);
296 th->cb (th->cb_cls, GNUNET_SYSERR);
305 * Handles a message sent from the DV service to us.
306 * Parse it out and give it to the plugin.
308 * @param cls the handle to the DV API
309 * @param msg the message that was received
312 handle_message_receipt (void *cls,
313 const struct GNUNET_MessageHeader *msg)
315 struct GNUNET_DV_ServiceHandle *sh = cls;
316 const struct GNUNET_DV_ConnectMessage *cm;
317 const struct GNUNET_DV_DistanceUpdateMessage *dum;
318 const struct GNUNET_DV_DisconnectMessage *dm;
319 const struct GNUNET_DV_ReceivedMessage *rm;
320 const struct GNUNET_MessageHeader *payload;
321 const struct GNUNET_DV_AckMessage *ack;
322 struct GNUNET_DV_TransmitHandle *th;
323 struct GNUNET_DV_TransmitHandle *tn;
324 struct ConnectedPeer *peer;
328 /* Connection closed */
332 LOG (GNUNET_ERROR_TYPE_DEBUG,
333 "Received message of type %u with %u bytes from DV service\n",
334 (unsigned int) ntohs (msg->type),
335 (unsigned int) ntohs (msg->size));
336 switch (ntohs (msg->type))
338 case GNUNET_MESSAGE_TYPE_DV_CONNECT:
339 if (ntohs (msg->size) != sizeof (struct GNUNET_DV_ConnectMessage))
345 cm = (const struct GNUNET_DV_ConnectMessage *) msg;
346 peer = GNUNET_CONTAINER_multipeermap_get (sh->peers,
354 peer = GNUNET_new (struct ConnectedPeer);
355 peer->pid = cm->peer;
356 GNUNET_assert (GNUNET_OK ==
357 GNUNET_CONTAINER_multipeermap_put (sh->peers,
360 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
361 sh->connect_cb (sh->cls,
363 ntohl (cm->distance),
364 (enum GNUNET_ATS_Network_Type) ntohl (cm->network));
366 case GNUNET_MESSAGE_TYPE_DV_DISTANCE_CHANGED:
367 if (ntohs (msg->size) != sizeof (struct GNUNET_DV_DistanceUpdateMessage))
373 dum = (const struct GNUNET_DV_DistanceUpdateMessage *) msg;
374 sh->distance_cb (sh->cls,
376 ntohl (dum->distance),
377 (enum GNUNET_ATS_Network_Type) ntohl (dum->network));
379 case GNUNET_MESSAGE_TYPE_DV_DISCONNECT:
380 if (ntohs (msg->size) != sizeof (struct GNUNET_DV_DisconnectMessage))
386 dm = (const struct GNUNET_DV_DisconnectMessage *) msg;
387 peer = GNUNET_CONTAINER_multipeermap_get (sh->peers,
396 while (NULL != (th = tn))
399 if (peer == th->target)
401 GNUNET_CONTAINER_DLL_remove (sh->th_head,
404 th->cb (th->cb_cls, GNUNET_SYSERR);
408 cleanup_send_cb (sh, &dm->peer, peer);
410 case GNUNET_MESSAGE_TYPE_DV_RECV:
411 if (ntohs (msg->size) < sizeof (struct GNUNET_DV_ReceivedMessage) + sizeof (struct GNUNET_MessageHeader))
417 rm = (const struct GNUNET_DV_ReceivedMessage *) msg;
418 payload = (const struct GNUNET_MessageHeader *) &rm[1];
419 if (ntohs (msg->size) != sizeof (struct GNUNET_DV_ReceivedMessage) + ntohs (payload->size))
425 sh->message_cb (sh->cls,
427 ntohl (rm->distance),
430 case GNUNET_MESSAGE_TYPE_DV_SEND_ACK:
431 case GNUNET_MESSAGE_TYPE_DV_SEND_NACK:
432 if (ntohs (msg->size) != sizeof (struct GNUNET_DV_AckMessage))
438 ack = (const struct GNUNET_DV_AckMessage *) msg;
439 peer = GNUNET_CONTAINER_multipeermap_get (sh->peers,
442 return; /* this happens, just ignore */
443 for (th = peer->head; NULL != th; th = th->next)
445 if (th->uid != ntohl (ack->uid))
447 LOG (GNUNET_ERROR_TYPE_DEBUG,
448 "Matched ACK for message to peer %s\n",
449 GNUNET_i2s (&ack->target));
450 GNUNET_CONTAINER_DLL_remove (peer->head,
454 (ntohs (ack->header.type) == GNUNET_MESSAGE_TYPE_DV_SEND_ACK)
465 GNUNET_CLIENT_receive (sh->client,
466 &handle_message_receipt, sh,
467 GNUNET_TIME_UNIT_FOREVER_REL);
472 * Transmit the start message to the DV service.
474 * @param cls the `struct GNUNET_DV_ServiceHandle *`
475 * @param size number of bytes available in buf
476 * @param buf where to copy the message
477 * @return number of bytes written to buf
480 transmit_start (void *cls,
484 struct GNUNET_DV_ServiceHandle *sh = cls;
485 struct GNUNET_MessageHeader start_message;
494 GNUNET_assert (size >= sizeof (start_message));
495 start_message.size = htons (sizeof (struct GNUNET_MessageHeader));
496 start_message.type = htons (GNUNET_MESSAGE_TYPE_DV_START);
497 memcpy (buf, &start_message, sizeof (start_message));
498 GNUNET_CLIENT_receive (sh->client,
499 &handle_message_receipt, sh,
500 GNUNET_TIME_UNIT_FOREVER_REL);
502 return sizeof (start_message);
507 * Disconnect and then reconnect to the DV service.
509 * @param sh service handle
512 reconnect (struct GNUNET_DV_ServiceHandle *sh)
516 GNUNET_CLIENT_notify_transmit_ready_cancel (sh->th);
519 if (NULL != sh->client)
521 GNUNET_CLIENT_disconnect (sh->client);
524 GNUNET_CONTAINER_multipeermap_iterate (sh->peers,
527 LOG (GNUNET_ERROR_TYPE_DEBUG,
528 "Connecting to DV service\n");
529 sh->client = GNUNET_CLIENT_connect ("dv", sh->cfg);
530 if (NULL == sh->client)
535 sh->th = GNUNET_CLIENT_notify_transmit_ready (sh->client,
536 sizeof (struct GNUNET_MessageHeader),
537 GNUNET_TIME_UNIT_FOREVER_REL,
545 * Connect to the DV service.
547 * @param cfg configuration
548 * @param cls closure for callbacks
549 * @param connect_cb function to call on connects
550 * @param distance_cb function to call if distances change
551 * @param disconnect_cb function to call on disconnects
552 * @param message_cb function to call if we receive messages
553 * @return handle to access the service
555 struct GNUNET_DV_ServiceHandle *
556 GNUNET_DV_service_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
558 GNUNET_DV_ConnectCallback connect_cb,
559 GNUNET_DV_DistanceChangedCallback distance_cb,
560 GNUNET_DV_DisconnectCallback disconnect_cb,
561 GNUNET_DV_MessageReceivedCallback message_cb)
563 struct GNUNET_DV_ServiceHandle *sh;
565 sh = GNUNET_new (struct GNUNET_DV_ServiceHandle);
568 sh->connect_cb = connect_cb;
569 sh->distance_cb = distance_cb;
570 sh->disconnect_cb = disconnect_cb;
571 sh->message_cb = message_cb;
572 sh->peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
579 * Disconnect from DV service.
581 * @param sh service handle
584 GNUNET_DV_service_disconnect (struct GNUNET_DV_ServiceHandle *sh)
586 struct GNUNET_DV_TransmitHandle *pos;
592 GNUNET_CLIENT_notify_transmit_ready_cancel (sh->th);
595 while (NULL != (pos = sh->th_head))
597 GNUNET_CONTAINER_DLL_remove (sh->th_head,
602 if (NULL != sh->client)
604 GNUNET_CLIENT_disconnect (sh->client);
607 GNUNET_CONTAINER_multipeermap_iterate (sh->peers,
610 GNUNET_CONTAINER_multipeermap_destroy (sh->peers);
616 * Send a message via DV service.
618 * @param sh service handle
619 * @param target intended recpient
620 * @param msg message payload
621 * @param cb function to invoke when done
622 * @param cb_cls closure for @a cb
623 * @return handle to cancel the operation
625 struct GNUNET_DV_TransmitHandle *
626 GNUNET_DV_send (struct GNUNET_DV_ServiceHandle *sh,
627 const struct GNUNET_PeerIdentity *target,
628 const struct GNUNET_MessageHeader *msg,
629 GNUNET_DV_MessageSentCallback cb,
632 struct GNUNET_DV_TransmitHandle *th;
633 struct GNUNET_DV_SendMessage *sm;
634 struct ConnectedPeer *peer;
636 if (ntohs (msg->size) + sizeof (struct GNUNET_DV_SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
641 LOG (GNUNET_ERROR_TYPE_DEBUG,
642 "Asked to send %u bytes of type %u to %s\n",
643 (unsigned int) ntohs (msg->size),
644 (unsigned int) ntohs (msg->type),
645 GNUNET_i2s (target));
646 peer = GNUNET_CONTAINER_multipeermap_get (sh->peers,
653 th = GNUNET_malloc (sizeof (struct GNUNET_DV_TransmitHandle) +
654 sizeof (struct GNUNET_DV_SendMessage) +
660 th->msg = (const struct GNUNET_MessageHeader *) &th[1];
661 sm = (struct GNUNET_DV_SendMessage *) &th[1];
662 sm->header.type = htons (GNUNET_MESSAGE_TYPE_DV_SEND);
663 sm->header.size = htons (sizeof (struct GNUNET_DV_SendMessage) +
665 if (0 == sh->uid_gen)
667 th->uid = sh->uid_gen;
668 sm->uid = htonl (sh->uid_gen++);
669 /* use memcpy here as 'target' may not be sufficiently aligned */
670 memcpy (&sm->target, target, sizeof (struct GNUNET_PeerIdentity));
671 memcpy (&sm[1], msg, ntohs (msg->size));
672 GNUNET_CONTAINER_DLL_insert (sh->th_head,
681 * Abort send operation (naturally, the message may have
682 * already been transmitted; this only stops the 'cb'
683 * from being called again).
685 * @param th send operation to cancel
688 GNUNET_DV_send_cancel (struct GNUNET_DV_TransmitHandle *th)
690 struct GNUNET_DV_ServiceHandle *sh = th->sh;
693 GNUNET_CONTAINER_DLL_remove (th->target->head,
697 GNUNET_CONTAINER_DLL_remove (sh->th_head,
704 /* end of dv_api.c */