2 This file is part of GNUnet.
3 (C) 2009, 2010 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.
22 * @file core/core_api.c
23 * @brief core service; this is the main API for encrypted P2P
25 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_core_service.h"
33 #define LOG(kind,...) GNUNET_log_from (kind, "core-api",__VA_ARGS__)
37 * Handle for a transmission request.
39 struct GNUNET_CORE_TransmitHandle
43 * Corresponding peer record.
45 struct PeerRecord *peer;
48 * Corresponding SEND_REQUEST message. Only non-NULL
49 * while SEND_REQUEST message is pending.
51 struct ControlMessage *cm;
54 * Function that will be called to get the actual request
55 * (once we are ready to transmit this request to the core).
56 * The function will be called with a NULL buffer to signal
59 GNUNET_CONNECTION_TransmitReadyNotify get_message;
62 * Closure for get_message.
64 void *get_message_cls;
67 * Timeout for this handle.
69 struct GNUNET_TIME_Absolute timeout;
72 * How important is this message?
77 * Size of this request.
82 * Send message request ID for this request.
95 * Information we track for each peer.
101 * We generally do NOT keep peer records in a DLL; this
102 * DLL is only used IF this peer's 'pending_head' message
103 * is ready for transmission.
105 struct PeerRecord *prev;
108 * We generally do NOT keep peer records in a DLL; this
109 * DLL is only used IF this peer's 'pending_head' message
110 * is ready for transmission.
112 struct PeerRecord *next;
115 * Peer the record is about.
117 struct GNUNET_PeerIdentity peer;
120 * Corresponding core handle.
122 struct GNUNET_CORE_Handle *ch;
125 * Pending request, if any. 'th->peer' is set to NULL if the
126 * request is not active.
128 struct GNUNET_CORE_TransmitHandle th;
131 * ID of timeout task for the 'pending_head' handle
132 * which is the one with the smallest timeout.
134 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
137 * ID of task to run 'next_request_transmission'.
139 GNUNET_SCHEDULER_TaskIdentifier ntr_task;
142 * SendMessageRequest ID generator for this peer.
150 struct GNUNET_PeerIdentity target;
151 struct GNUNET_CORE_Handle *core;
152 struct GNUNET_CORE_TransmitHandle *th;
157 * Type of function called upon completion.
160 * @param success GNUNET_OK on success (which for request_connect
161 * ONLY means that we transmitted the connect request to CORE,
162 * it does not mean that we are actually now connected!);
163 * GNUNET_NO on timeout,
164 * GNUNET_SYSERR if core was shut down
166 typedef void (*GNUNET_CORE_ControlContinuation) (void *cls, int success);
170 * Entry in a doubly-linked list of control messages to be transmitted
171 * to the core service. Control messages include traffic allocation,
172 * connection requests and of course our initial 'init' request.
174 * The actual message is allocated at the end of this struct.
176 struct ControlMessage
179 * This is a doubly-linked list.
181 struct ControlMessage *next;
184 * This is a doubly-linked list.
186 struct ControlMessage *prev;
189 * Function to run after transmission failed/succeeded.
191 GNUNET_CORE_ControlContinuation cont;
194 * Closure for 'cont'.
199 * Transmit handle (if one is associated with this ControlMessage), or NULL.
201 struct GNUNET_CORE_TransmitHandle *th;
207 * Context for the core service connection.
209 struct GNUNET_CORE_Handle
213 * Configuration we're using.
215 const struct GNUNET_CONFIGURATION_Handle *cfg;
218 * Closure for the various callbacks.
223 * Function to call once we've handshaked with the core service.
225 GNUNET_CORE_StartupCallback init;
228 * Function to call whenever we're notified about a peer connecting.
230 GNUNET_CORE_ConnectEventHandler connects;
233 * Function to call whenever we're notified about a peer disconnecting.
235 GNUNET_CORE_DisconnectEventHandler disconnects;
238 * Function to call whenever we receive an inbound message.
240 GNUNET_CORE_MessageCallback inbound_notify;
243 * Function to call whenever we receive an outbound message.
245 GNUNET_CORE_MessageCallback outbound_notify;
248 * Function handlers for messages of particular type.
250 const struct GNUNET_CORE_MessageHandler *handlers;
253 * Our connection to the service.
255 struct GNUNET_CLIENT_Connection *client;
258 * Handle for our current transmission request.
260 struct GNUNET_CLIENT_TransmitHandle *cth;
263 * Head of doubly-linked list of pending requests.
265 struct ControlMessage *control_pending_head;
268 * Tail of doubly-linked list of pending requests.
270 struct ControlMessage *control_pending_tail;
273 * Head of doubly-linked list of peers that are core-approved
274 * to send their next message.
276 struct PeerRecord *ready_peer_head;
279 * Tail of doubly-linked list of peers that are core-approved
280 * to send their next message.
282 struct PeerRecord *ready_peer_tail;
285 * Hash map listing all of the peers that we are currently
288 struct GNUNET_CONTAINER_MultiPeerMap *peers;
291 * Identity of this peer.
293 struct GNUNET_PeerIdentity me;
296 * ID of reconnect task (if any).
298 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
301 * Current delay we use for re-trying to connect to core.
303 struct GNUNET_TIME_Relative retry_backoff;
306 * Number of entries in the handlers array.
311 * For inbound notifications without a specific handler, do
312 * we expect to only receive headers?
314 int inbound_hdr_only;
317 * For outbound notifications without a specific handler, do
318 * we expect to only receive headers?
320 int outbound_hdr_only;
323 * Are we currently disconnected and hence unable to forward
332 * Our current client connection went down. Clean it up
333 * and try to reconnect!
335 * @param h our handle to the core service
338 reconnect (struct GNUNET_CORE_Handle *h);
342 * Task schedule to try to re-connect to core.
344 * @param cls the `struct GNUNET_CORE_Handle`
345 * @param tc task context
348 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
350 struct GNUNET_CORE_Handle *h = cls;
352 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
353 LOG (GNUNET_ERROR_TYPE_DEBUG,
354 "Connecting to CORE service after delay\n");
360 * Notify clients about disconnect and free
361 * the entry for connected peer.
363 * @param cls the `struct GNUNET_CORE_Handle *`
364 * @param key the peer identity (not used)
365 * @param value the `struct PeerRecord` to free.
366 * @return #GNUNET_YES (continue)
369 disconnect_and_free_peer_entry (void *cls,
370 const struct GNUNET_PeerIdentity *key,
373 struct GNUNET_CORE_Handle *h = cls;
374 struct GNUNET_CORE_TransmitHandle *th;
375 struct PeerRecord *pr = value;
377 if (GNUNET_SCHEDULER_NO_TASK != pr->timeout_task)
379 GNUNET_SCHEDULER_cancel (pr->timeout_task);
380 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
382 if (GNUNET_SCHEDULER_NO_TASK != pr->ntr_task)
384 GNUNET_SCHEDULER_cancel (pr->ntr_task);
385 pr->ntr_task = GNUNET_SCHEDULER_NO_TASK;
387 if ((NULL != pr->prev) || (NULL != pr->next) || (h->ready_peer_head == pr))
388 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head, h->ready_peer_tail, pr);
389 if (NULL != h->disconnects)
390 h->disconnects (h->cls, &pr->peer);
391 /* all requests should have been cancelled, clean up anyway, just in case */
393 if (NULL != th->peer)
400 /* done with 'voluntary' cleanups, now on to normal freeing */
401 GNUNET_assert (GNUNET_YES ==
402 GNUNET_CONTAINER_multipeermap_remove (h->peers, key, pr));
403 GNUNET_assert (pr->ch == h);
404 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pr->timeout_task);
405 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pr->ntr_task);
412 * Close down any existing connection to the CORE service and
413 * try re-establishing it later.
415 * @param h our handle
418 reconnect_later (struct GNUNET_CORE_Handle *h)
420 struct ControlMessage *cm;
421 struct PeerRecord *pr;
423 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task);
426 GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
429 if (NULL != h->client)
431 GNUNET_CLIENT_disconnect (h->client);
434 h->currently_down = GNUNET_YES;
435 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
437 GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
439 while (NULL != (cm = h->control_pending_head))
441 GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
442 h->control_pending_tail, cm);
445 if (NULL != cm->cont)
446 cm->cont (cm->cont_cls, GNUNET_NO);
449 GNUNET_CONTAINER_multipeermap_iterate (h->peers,
450 &disconnect_and_free_peer_entry, h);
451 while (NULL != (pr = h->ready_peer_head))
452 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head, h->ready_peer_tail, pr);
453 GNUNET_assert (h->control_pending_head == NULL);
454 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
459 * Check the list of pending requests, send the next
462 * @param h core handle
463 * @param ignore_currently_down transmit message even if not initialized?
466 trigger_next_request (struct GNUNET_CORE_Handle *h, int ignore_currently_down);
470 * The given request hit its timeout. Remove from the
471 * doubly-linked list and call the respective continuation.
473 * @param cls the transmit handle of the request that timed out
474 * @param tc context, can be NULL (!)
477 transmission_timeout (void *cls,
478 const struct GNUNET_SCHEDULER_TaskContext *tc);
482 * Send a control message to the peer asking for transmission
483 * of the message in the given peer record.
485 * @param pr peer to request transmission to
488 request_next_transmission (struct PeerRecord *pr)
490 struct GNUNET_CORE_Handle *h = pr->ch;
491 struct ControlMessage *cm;
492 struct SendMessageRequest *smr;
493 struct GNUNET_CORE_TransmitHandle *th;
495 if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
497 GNUNET_SCHEDULER_cancel (pr->timeout_task);
498 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
501 if (NULL == th->peer)
503 trigger_next_request (h, GNUNET_NO);
507 return; /* already done */
508 GNUNET_assert (pr->prev == NULL);
509 GNUNET_assert (pr->next == NULL);
511 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
512 (th->timeout), &transmission_timeout, pr);
513 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
514 sizeof (struct SendMessageRequest));
517 smr = (struct SendMessageRequest *) &cm[1];
518 smr->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST);
519 smr->header.size = htons (sizeof (struct SendMessageRequest));
520 smr->priority = htonl (th->priority);
521 smr->deadline = GNUNET_TIME_absolute_hton (th->timeout);
522 smr->peer = pr->peer;
523 smr->reserved = htonl (0);
524 smr->size = htons (th->msize);
525 smr->smr_id = htons (th->smr_id = pr->smr_id_gen++);
526 GNUNET_CONTAINER_DLL_insert_tail (h->control_pending_head,
527 h->control_pending_tail, cm);
528 LOG (GNUNET_ERROR_TYPE_DEBUG,
529 "Adding SEND REQUEST for peer `%s' to message queue\n",
530 GNUNET_i2s (&pr->peer));
531 trigger_next_request (h, GNUNET_NO);
536 * The given request hit its timeout. Remove from the
537 * doubly-linked list and call the respective continuation.
539 * @param cls the transmit handle of the request that timed out
540 * @param tc context, can be NULL (!)
543 transmission_timeout (void *cls,
544 const struct GNUNET_SCHEDULER_TaskContext *tc)
546 struct PeerRecord *pr = cls;
547 struct GNUNET_CORE_Handle *h = pr->ch;
548 struct GNUNET_CORE_TransmitHandle *th;
550 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
551 if (GNUNET_SCHEDULER_NO_TASK != pr->ntr_task)
553 GNUNET_SCHEDULER_cancel (pr->ntr_task);
554 pr->ntr_task = GNUNET_SCHEDULER_NO_TASK;
558 if ((NULL != pr->prev) || (NULL != pr->next) || (pr == h->ready_peer_head))
560 /* the request that was 'approved' by core was
561 * canceled before it could be transmitted; remove
562 * us from the 'ready' list */
563 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head, h->ready_peer_tail, pr);
567 /* we're currently in the control queue, remove */
568 GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
569 h->control_pending_tail, th->cm);
570 GNUNET_free (th->cm);
572 LOG (GNUNET_ERROR_TYPE_DEBUG,
573 "Signalling timeout of request for transmission to peer `%s' via CORE\n",
574 GNUNET_i2s (&pr->peer));
575 trigger_next_request (h, GNUNET_NO);
577 GNUNET_assert (0 == th->get_message (th->get_message_cls, 0, NULL));
582 * Transmit the next message to the core service.
584 * @param cls closure with the `struct GNUNET_CORE_Handle`
585 * @param size number of bytes available in @a buf
586 * @param buf where the callee should write the message
587 * @return number of bytes written to @a buf
590 transmit_message (void *cls, size_t size, void *buf)
592 struct GNUNET_CORE_Handle *h = cls;
593 struct ControlMessage *cm;
594 struct GNUNET_CORE_TransmitHandle *th;
595 struct PeerRecord *pr;
596 struct SendMessage *sm;
597 const struct GNUNET_MessageHeader *hdr;
601 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
605 LOG (GNUNET_ERROR_TYPE_DEBUG,
606 "Transmission failed, initiating reconnect\n");
610 /* first check for control messages */
611 if (NULL != (cm = h->control_pending_head))
613 hdr = (const struct GNUNET_MessageHeader *) &cm[1];
614 msize = ntohs (hdr->size);
617 trigger_next_request (h, GNUNET_NO);
620 LOG (GNUNET_ERROR_TYPE_DEBUG,
621 "Transmitting control message with %u bytes of type %u to core.\n",
622 (unsigned int) msize, (unsigned int) ntohs (hdr->type));
623 memcpy (buf, hdr, msize);
624 GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
625 h->control_pending_tail, cm);
628 if (NULL != cm->cont)
629 cm->cont (cm->cont_cls, GNUNET_OK);
631 trigger_next_request (h, GNUNET_NO);
634 /* now check for 'ready' P2P messages */
635 if (NULL == (pr = h->ready_peer_head))
637 GNUNET_assert (NULL != pr->th.peer);
639 if (size < th->msize + sizeof (struct SendMessage))
641 trigger_next_request (h, GNUNET_NO);
644 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head, h->ready_peer_tail, pr);
646 if (GNUNET_SCHEDULER_NO_TASK != pr->timeout_task)
648 GNUNET_SCHEDULER_cancel (pr->timeout_task);
649 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
651 LOG (GNUNET_ERROR_TYPE_DEBUG,
652 "Transmitting SEND request to `%s' with %u bytes.\n",
653 GNUNET_i2s (&pr->peer), (unsigned int) th->msize);
654 sm = (struct SendMessage *) buf;
655 sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
656 sm->priority = htonl (th->priority);
657 sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
659 sm->cork = htonl ((uint32_t) th->cork);
660 sm->reserved = htonl (0);
662 th->get_message (th->get_message_cls,
663 size - sizeof (struct SendMessage), &sm[1]);
665 LOG (GNUNET_ERROR_TYPE_DEBUG,
666 "Transmitting SEND request to `%s' yielded %u bytes.\n",
667 GNUNET_i2s (&pr->peer), ret);
670 LOG (GNUNET_ERROR_TYPE_DEBUG,
671 "Size of clients message to peer %s is 0!\n",
672 GNUNET_i2s (&pr->peer));
673 /* client decided to send nothing! */
674 request_next_transmission (pr);
677 LOG (GNUNET_ERROR_TYPE_DEBUG,
678 "Produced SEND message to core with %u bytes payload\n",
680 GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
681 if (ret + sizeof (struct SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
684 request_next_transmission (pr);
687 ret += sizeof (struct SendMessage);
688 sm->header.size = htons (ret);
689 GNUNET_assert (ret <= size);
690 request_next_transmission (pr);
696 * Check the list of pending requests, send the next
699 * @param h core handle
700 * @param ignore_currently_down transmit message even if not initialized?
703 trigger_next_request (struct GNUNET_CORE_Handle *h, int ignore_currently_down)
707 if ((GNUNET_YES == h->currently_down) && (ignore_currently_down == GNUNET_NO))
709 LOG (GNUNET_ERROR_TYPE_DEBUG,
710 "Core connection down, not processing queue\n");
715 LOG (GNUNET_ERROR_TYPE_DEBUG, "Request pending, not processing queue\n");
718 if (NULL != h->control_pending_head)
720 ntohs (((struct GNUNET_MessageHeader *) &h->
721 control_pending_head[1])->size);
722 else if (h->ready_peer_head != NULL)
724 h->ready_peer_head->th.msize + sizeof (struct SendMessage);
727 LOG (GNUNET_ERROR_TYPE_DEBUG,
728 "Request queue empty, not processing queue\n");
729 return; /* no pending message */
732 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
733 GNUNET_TIME_UNIT_FOREVER_REL,
734 GNUNET_NO, &transmit_message, h);
739 * Handler for notification messages received from the core.
741 * @param cls our `struct GNUNET_CORE_Handle`
742 * @param msg the message received from the core service
745 main_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
747 struct GNUNET_CORE_Handle *h = cls;
748 const struct InitReplyMessage *m;
749 const struct ConnectNotifyMessage *cnm;
750 const struct DisconnectNotifyMessage *dnm;
751 const struct NotifyTrafficMessage *ntm;
752 const struct GNUNET_MessageHeader *em;
753 const struct SendMessageReady *smr;
754 const struct GNUNET_CORE_MessageHandler *mh;
755 GNUNET_CORE_StartupCallback init;
756 struct PeerRecord *pr;
757 struct GNUNET_CORE_TransmitHandle *th;
764 LOG (GNUNET_ERROR_TYPE_INFO,
765 _("Client was disconnected from core service, trying to reconnect.\n"));
769 msize = ntohs (msg->size);
770 LOG (GNUNET_ERROR_TYPE_DEBUG,
771 "Processing message of type %u and size %u from core service\n",
772 ntohs (msg->type), msize);
773 switch (ntohs (msg->type))
775 case GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY:
776 if (ntohs (msg->size) != sizeof (struct InitReplyMessage))
782 m = (const struct InitReplyMessage *) msg;
783 GNUNET_break (0 == ntohl (m->reserved));
784 /* start our message processing loop */
785 if (GNUNET_YES == h->currently_down)
787 h->currently_down = GNUNET_NO;
788 trigger_next_request (h, GNUNET_NO);
790 h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
791 h->me = m->my_identity;
792 if (NULL != (init = h->init))
794 /* mark so we don't call init on reconnect */
796 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connected to core service of peer `%s'.\n",
797 GNUNET_i2s (&h->me));
798 init (h->cls, &h->me);
802 LOG (GNUNET_ERROR_TYPE_DEBUG,
803 "Successfully reconnected to core service.\n");
805 /* fake 'connect to self' */
806 pr = GNUNET_CONTAINER_multipeermap_get (h->peers, &h->me);
807 GNUNET_assert (NULL == pr);
808 pr = GNUNET_new (struct PeerRecord);
811 GNUNET_assert (GNUNET_YES ==
812 GNUNET_CONTAINER_multipeermap_put (h->peers,
814 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
815 if (NULL != h->connects)
816 h->connects (h->cls, &h->me);
818 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
819 if (msize < sizeof (struct ConnectNotifyMessage))
825 cnm = (const struct ConnectNotifyMessage *) msg;
827 sizeof (struct ConnectNotifyMessage))
833 LOG (GNUNET_ERROR_TYPE_DEBUG,
834 "Received notification about connection from `%s'.\n",
835 GNUNET_i2s (&cnm->peer));
836 if (0 == memcmp (&h->me, &cnm->peer, sizeof (struct GNUNET_PeerIdentity)))
838 /* connect to self!? */
842 pr = GNUNET_CONTAINER_multipeermap_get (h->peers, &cnm->peer);
849 pr = GNUNET_new (struct PeerRecord);
850 pr->peer = cnm->peer;
852 GNUNET_assert (GNUNET_YES ==
853 GNUNET_CONTAINER_multipeermap_put (h->peers,
855 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
856 if (NULL != h->connects)
857 h->connects (h->cls, &cnm->peer);
859 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
860 if (msize != sizeof (struct DisconnectNotifyMessage))
866 dnm = (const struct DisconnectNotifyMessage *) msg;
867 if (0 == memcmp (&h->me, &dnm->peer, sizeof (struct GNUNET_PeerIdentity)))
869 /* connection to self!? */
873 GNUNET_break (0 == ntohl (dnm->reserved));
874 LOG (GNUNET_ERROR_TYPE_DEBUG,
875 "Received notification about disconnect from `%s'.\n",
876 GNUNET_i2s (&dnm->peer));
877 pr = GNUNET_CONTAINER_multipeermap_get (h->peers, &dnm->peer);
884 trigger = ((pr->prev != NULL) || (pr->next != NULL) ||
885 (h->ready_peer_head == pr));
886 disconnect_and_free_peer_entry (h, &dnm->peer, pr);
888 trigger_next_request (h, GNUNET_NO);
890 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
891 if (msize < sizeof (struct NotifyTrafficMessage))
897 ntm = (const struct NotifyTrafficMessage *) msg;
899 sizeof (struct NotifyTrafficMessage) +
900 sizeof (struct GNUNET_MessageHeader)) )
906 em = (const struct GNUNET_MessageHeader *) &ntm[1];
907 LOG (GNUNET_ERROR_TYPE_DEBUG,
908 "Received message of type %u and size %u from peer `%4s'\n",
909 ntohs (em->type), ntohs (em->size), GNUNET_i2s (&ntm->peer));
910 if ((GNUNET_NO == h->inbound_hdr_only) &&
912 ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
918 et = ntohs (em->type);
919 for (hpos = 0; hpos < h->hcnt; hpos++)
921 mh = &h->handlers[hpos];
924 if ((mh->expected_size != ntohs (em->size)) && (mh->expected_size != 0))
926 LOG (GNUNET_ERROR_TYPE_ERROR,
927 "Unexpected message size %u for message of type %u from peer `%4s'\n",
928 htons (em->size), mh->type, GNUNET_i2s (&ntm->peer));
932 pr = GNUNET_CONTAINER_multipeermap_get (h->peers, &ntm->peer);
940 h->handlers[hpos].callback (h->cls, &ntm->peer, em))
942 /* error in processing, do not process other messages! */
946 if (NULL != h->inbound_notify)
947 h->inbound_notify (h->cls, &ntm->peer, em);
949 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
950 if (msize < sizeof (struct NotifyTrafficMessage))
956 ntm = (const struct NotifyTrafficMessage *) msg;
958 sizeof (struct NotifyTrafficMessage) +
959 sizeof (struct GNUNET_MessageHeader)) )
965 em = (const struct GNUNET_MessageHeader *) &ntm[1];
966 LOG (GNUNET_ERROR_TYPE_DEBUG,
967 "Received notification about transmission to `%s'.\n",
968 GNUNET_i2s (&ntm->peer));
969 if ((GNUNET_NO == h->outbound_hdr_only) &&
971 ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
977 if (NULL == h->outbound_notify)
982 h->outbound_notify (h->cls, &ntm->peer, em);
984 case GNUNET_MESSAGE_TYPE_CORE_SEND_READY:
985 if (msize != sizeof (struct SendMessageReady))
991 smr = (const struct SendMessageReady *) msg;
992 pr = GNUNET_CONTAINER_multipeermap_get (h->peers, &smr->peer);
999 LOG (GNUNET_ERROR_TYPE_DEBUG,
1000 "Received notification about transmission readiness to `%s'.\n",
1001 GNUNET_i2s (&smr->peer));
1002 if (NULL == pr->th.peer)
1004 /* request must have been cancelled between the original request
1005 * and the response from core, ignore core's readiness */
1010 if (ntohs (smr->smr_id) != th->smr_id)
1012 /* READY message is for expired or cancelled message,
1013 * ignore! (we should have already sent another request) */
1016 if ((NULL != pr->prev) || (NULL != pr->next) || (h->ready_peer_head == pr))
1018 /* we should not already be on the ready list... */
1020 reconnect_later (h);
1023 GNUNET_CONTAINER_DLL_insert (h->ready_peer_head, h->ready_peer_tail, pr);
1024 trigger_next_request (h, GNUNET_NO);
1027 reconnect_later (h);
1030 GNUNET_CLIENT_receive (h->client, &main_notify_handler, h,
1031 GNUNET_TIME_UNIT_FOREVER_REL);
1036 * Task executed once we are done transmitting the INIT message.
1037 * Starts our 'receive' loop.
1039 * @param cls the 'struct GNUNET_CORE_Handle'
1040 * @param success were we successful
1043 init_done_task (void *cls, int success)
1045 struct GNUNET_CORE_Handle *h = cls;
1047 if (GNUNET_SYSERR == success)
1048 return; /* shutdown */
1049 if (GNUNET_NO == success)
1051 LOG (GNUNET_ERROR_TYPE_DEBUG,
1052 "Failed to exchange INIT with core, retrying\n");
1053 if (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK)
1054 reconnect_later (h);
1057 GNUNET_CLIENT_receive (h->client, &main_notify_handler, h,
1058 GNUNET_TIME_UNIT_FOREVER_REL);
1063 * Our current client connection went down. Clean it up
1064 * and try to reconnect!
1066 * @param h our handle to the core service
1069 reconnect (struct GNUNET_CORE_Handle *h)
1071 struct ControlMessage *cm;
1072 struct InitMessage *init;
1078 GNUNET_assert (NULL == h->client);
1079 GNUNET_assert (GNUNET_YES == h->currently_down);
1080 GNUNET_assert (NULL != h->cfg);
1081 h->client = GNUNET_CLIENT_connect ("core", h->cfg);
1082 if (NULL == h->client)
1084 reconnect_later (h);
1087 msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
1088 cm = GNUNET_malloc (sizeof (struct ControlMessage) + msize);
1089 cm->cont = &init_done_task;
1091 init = (struct InitMessage *) &cm[1];
1092 init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
1093 init->header.size = htons (msize);
1095 if (h->inbound_notify != NULL)
1097 if (h->inbound_hdr_only)
1098 opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
1100 opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
1102 if (h->outbound_notify != NULL)
1104 if (h->outbound_hdr_only)
1105 opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
1107 opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
1109 LOG (GNUNET_ERROR_TYPE_INFO,
1110 "(Re)connecting to CORE service, monitoring messages of type %u\n",
1113 init->options = htonl (opt);
1114 ts = (uint16_t *) & init[1];
1115 for (hpos = 0; hpos < h->hcnt; hpos++)
1116 ts[hpos] = htons (h->handlers[hpos].type);
1117 GNUNET_CONTAINER_DLL_insert (h->control_pending_head, h->control_pending_tail,
1119 trigger_next_request (h, GNUNET_YES);
1125 * Connect to the core service. Note that the connection may
1126 * complete (or fail) asynchronously.
1128 * @param cfg configuration to use
1129 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
1130 * @param init callback to call once we have successfully
1131 * connected to the core service
1132 * @param connects function to call on peer connect, can be NULL
1133 * @param disconnects function to call on peer disconnect / timeout, can be NULL
1134 * @param inbound_notify function to call for all inbound messages, can be NULL
1135 * @param inbound_hdr_only set to #GNUNET_YES if inbound_notify will only read the
1136 * GNUNET_MessageHeader and hence we do not need to give it the full message;
1137 * can be used to improve efficiency, ignored if @a inbound_notify is NULLL
1138 * @param outbound_notify function to call for all outbound messages, can be NULL
1139 * @param outbound_hdr_only set to #GNUNET_YES if outbound_notify will only read the
1140 * GNUNET_MessageHeader and hence we do not need to give it the full message
1141 * can be used to improve efficiency, ignored if @a outbound_notify is NULLL
1142 * @param handlers callbacks for messages we care about, NULL-terminated
1143 * @return handle to the core service (only useful for disconnect until 'init' is called);
1144 * NULL on error (in this case, init is never called)
1146 struct GNUNET_CORE_Handle *
1147 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1149 GNUNET_CORE_StartupCallback init,
1150 GNUNET_CORE_ConnectEventHandler connects,
1151 GNUNET_CORE_DisconnectEventHandler disconnects,
1152 GNUNET_CORE_MessageCallback inbound_notify,
1153 int inbound_hdr_only,
1154 GNUNET_CORE_MessageCallback outbound_notify,
1155 int outbound_hdr_only,
1156 const struct GNUNET_CORE_MessageHandler *handlers)
1158 struct GNUNET_CORE_Handle *h;
1160 GNUNET_assert (NULL != cfg);
1161 h = GNUNET_new (struct GNUNET_CORE_Handle);
1165 h->connects = connects;
1166 h->disconnects = disconnects;
1167 h->inbound_notify = inbound_notify;
1168 h->outbound_notify = outbound_notify;
1169 h->inbound_hdr_only = inbound_hdr_only;
1170 h->outbound_hdr_only = outbound_hdr_only;
1171 h->handlers = handlers;
1173 h->currently_down = GNUNET_YES;
1174 h->peers = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
1175 if (NULL != handlers)
1176 while (handlers[h->hcnt].callback != NULL)
1178 GNUNET_assert (h->hcnt <
1179 (GNUNET_SERVER_MAX_MESSAGE_SIZE -
1180 sizeof (struct InitMessage)) / sizeof (uint16_t));
1181 LOG (GNUNET_ERROR_TYPE_DEBUG,
1182 "Connecting to CORE service\n");
1189 * Disconnect from the core service. This function can only
1190 * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready'
1191 * requests have been explicitly canceled.
1193 * @param handle connection to core to disconnect
1196 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
1198 struct ControlMessage *cm;
1200 GNUNET_assert (NULL != handle);
1202 LOG (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from CORE service\n");
1203 if (NULL != handle->cth)
1205 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->cth);
1208 while (NULL != (cm = handle->control_pending_head))
1210 GNUNET_CONTAINER_DLL_remove (handle->control_pending_head,
1211 handle->control_pending_tail, cm);
1214 if (NULL != cm->cont)
1215 cm->cont (cm->cont_cls, GNUNET_SYSERR);
1218 if (NULL != handle->client)
1220 GNUNET_CLIENT_disconnect (handle->client);
1221 handle->client = NULL;
1223 GNUNET_CONTAINER_multipeermap_iterate (handle->peers,
1224 &disconnect_and_free_peer_entry,
1226 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1228 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1229 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1231 GNUNET_CONTAINER_multipeermap_destroy (handle->peers);
1232 handle->peers = NULL;
1233 GNUNET_break (handle->ready_peer_head == NULL);
1234 GNUNET_free (handle);
1239 * Task that calls 'request_next_transmission'.
1241 * @param cls the 'struct PeerRecord *'
1242 * @param tc scheduler context
1245 run_request_next_transmission (void *cls,
1246 const struct GNUNET_SCHEDULER_TaskContext *tc)
1248 struct PeerRecord *pr = cls;
1250 pr->ntr_task = GNUNET_SCHEDULER_NO_TASK;
1251 request_next_transmission (pr);
1256 * Ask the core to call @a notify once it is ready to transmit the
1257 * given number of bytes to the specified @a target. Must only be
1258 * called after a connection to the respective peer has been
1259 * established (and the client has been informed about this). You may
1260 * have one request of this type pending for each connected peer at
1261 * any time. If a peer disconnects, the application MUST call
1262 * #GNUNET_CORE_notify_transmit_ready_cancel on the respective
1263 * transmission request, if one such request is pending.
1265 * @param handle connection to core service
1266 * @param cork is corking allowed for this transmission?
1267 * @param priority how important is the message?
1268 * @param maxdelay how long can the message wait?
1269 * @param target who should receive the message, never NULL (can be this peer's identity for loopback)
1270 * @param notify_size how many bytes of buffer space does @a notify want?
1271 * @param notify function to call when buffer space is available;
1272 * will be called with NULL on timeout; clients MUST cancel
1273 * all pending transmission requests DURING the disconnect
1275 * @param notify_cls closure for notify
1276 * @return non-NULL if the notify callback was queued,
1277 * NULL if we can not even queue the request (request already pending);
1278 * if NULL is returned, @a notify will NOT be called.
1280 struct GNUNET_CORE_TransmitHandle *
1281 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle, int cork,
1283 struct GNUNET_TIME_Relative maxdelay,
1284 const struct GNUNET_PeerIdentity *target,
1286 GNUNET_CONNECTION_TransmitReadyNotify notify,
1289 struct PeerRecord *pr;
1290 struct GNUNET_CORE_TransmitHandle *th;
1292 GNUNET_assert (NULL != handle);
1293 GNUNET_assert (NULL != target);
1295 if (notify_size > GNUNET_CONSTANTS_MAX_ENCRYPTED_MESSAGE_SIZE)
1300 GNUNET_assert (NULL != notify);
1301 LOG (GNUNET_ERROR_TYPE_DEBUG,
1302 "Asking core for transmission of %u bytes to `%s'\n",
1303 (unsigned int) notify_size,
1304 GNUNET_i2s (target));
1305 pr = GNUNET_CONTAINER_multipeermap_get (handle->peers, target);
1308 /* attempt to send to peer that is not connected */
1312 if (NULL != pr->th.peer)
1314 /* attempting to queue a second request for the same destination */
1318 GNUNET_assert (notify_size + sizeof (struct SendMessage) <
1319 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1321 memset (th, 0, sizeof (struct GNUNET_CORE_TransmitHandle));
1323 th->get_message = notify;
1324 th->get_message_cls = notify_cls;
1325 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1326 th->priority = priority;
1327 th->msize = notify_size;
1329 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == pr->ntr_task);
1331 GNUNET_SCHEDULER_add_now (&run_request_next_transmission, pr);
1332 LOG (GNUNET_ERROR_TYPE_DEBUG, "Transmission request added to queue\n");
1338 * Cancel the specified transmission-ready notification.
1340 * @param th handle that was returned by "notify_transmit_ready".
1343 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle *th)
1345 struct PeerRecord *pr = th->peer;
1346 struct GNUNET_CORE_Handle *h;
1348 GNUNET_assert (NULL != th);
1349 GNUNET_assert (NULL != pr);
1350 LOG (GNUNET_ERROR_TYPE_DEBUG,
1351 "Aborting transmission request to core for %u bytes to `%s'\n",
1352 (unsigned int) th->msize,
1353 GNUNET_i2s (&pr->peer));
1358 /* we're currently in the control queue, remove */
1359 GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
1360 h->control_pending_tail, th->cm);
1361 GNUNET_free (th->cm);
1364 if ((NULL != pr->prev) || (NULL != pr->next) || (pr == h->ready_peer_head))
1366 /* the request that was 'approved' by core was
1367 * canceled before it could be transmitted; remove
1368 * us from the 'ready' list */
1369 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head, h->ready_peer_tail, pr);
1371 if (GNUNET_SCHEDULER_NO_TASK != pr->ntr_task)
1373 GNUNET_SCHEDULER_cancel (pr->ntr_task);
1374 pr->ntr_task = GNUNET_SCHEDULER_NO_TASK;
1380 * Check if the given peer is currently connected. This function is for special
1381 * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are
1382 * expected to track which peers are connected based on the connect/disconnect
1383 * callbacks from GNUNET_CORE_connect. This function is NOT part of the
1384 * 'versioned', 'official' API. The difference between this function and the
1385 * function GNUNET_CORE_is_peer_connected() is that this one returns
1386 * synchronously after looking in the CORE API cache. The function
1387 * GNUNET_CORE_is_peer_connected() sends a message to the CORE service and hence
1388 * its response is given asynchronously.
1390 * @param h the core handle
1391 * @param pid the identity of the peer to check if it has been connected to us
1392 * @return GNUNET_YES if the peer is connected to us; GNUNET_NO if not
1395 GNUNET_CORE_is_peer_connected_sync (const struct GNUNET_CORE_Handle *h,
1396 const struct GNUNET_PeerIdentity *pid)
1398 GNUNET_assert (NULL != h);
1399 GNUNET_assert (NULL != pid);
1400 return GNUNET_CONTAINER_multipeermap_contains (h->peers, pid);
1405 * Function called to notify a client about the connection
1406 * begin ready to queue more data. "buf" will be
1407 * NULL and "size" zero if the connection was closed for
1408 * writing in the meantime.
1410 * @param cls closure
1411 * @param size number of bytes available in buf
1412 * @param buf where the callee should write the message
1413 * @return number of bytes written to buf
1416 core_mq_ntr (void *cls, size_t size,
1419 struct GNUNET_MQ_Handle *mq = cls;
1420 struct CoreMQState *mqs = GNUNET_MQ_impl_state (mq);
1421 const struct GNUNET_MessageHeader *mh = GNUNET_MQ_impl_current (mq);
1422 size_t msg_size = ntohs (mh->size);
1423 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "core-mq", "ntr called (size %u, type %u)\n",
1424 msg_size, ntohs (mh->type));
1428 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "core-mq", "send error\n");
1429 GNUNET_MQ_inject_error (mq, GNUNET_MQ_ERROR_WRITE);
1432 memcpy (buf, mh, msg_size);
1433 GNUNET_MQ_impl_send_continue (mq);
1439 * Signature of functions implementing the
1440 * sending functionality of a message queue.
1442 * @param mq the message queue
1443 * @param msg the message to send
1444 * @param impl_state state of the implementation
1447 core_mq_send (struct GNUNET_MQ_Handle *mq,
1448 const struct GNUNET_MessageHeader *msg,
1451 struct CoreMQState *mqs = impl_state;
1452 GNUNET_assert (NULL == mqs->th);
1453 GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "core-mq", "Sending queued message (size %u)\n",
1455 mqs->th = GNUNET_CORE_notify_transmit_ready (mqs->core, GNUNET_YES, 0,
1456 GNUNET_TIME_UNIT_FOREVER_REL,
1458 ntohs (msg->size), core_mq_ntr, mq);
1463 * Signature of functions implementing the
1464 * destruction of a message queue.
1465 * Implementations must not free @a mq, but should
1466 * take care of @a impl_state.
1468 * @param mq the message queue to destroy
1469 * @param impl_state state of the implementation
1472 core_mq_destroy (struct GNUNET_MQ_Handle *mq, void *impl_state)
1474 struct CoreMQState *mqs = impl_state;
1475 if (NULL != mqs->th)
1477 GNUNET_CORE_notify_transmit_ready_cancel (mqs->th);
1485 * Implementation function that cancels the currently sent message.
1487 * @param mq message queue
1488 * @param impl_state state specific to the implementation
1491 core_mq_cancel (struct GNUNET_MQ_Handle *mq, void *impl_state)
1493 struct CoreMQState *mqs = impl_state;
1494 GNUNET_assert (NULL != mqs->th);
1495 GNUNET_CORE_notify_transmit_ready_cancel (mqs->th);
1500 * Create a message queue for sending messages to a peer with CORE.
1501 * Messages may only be queued with #GNUNET_MQ_send once the init callback has
1502 * been called for the given handle.
1503 * There must only be one queue per peer for each core handle.
1504 * The message queue can only be used to transmit messages,
1505 * not to receive them.
1507 * @param h the core handle
1508 * @param target the target peer for this queue, may not be NULL
1509 * @return a message queue for sending messages over the core handle
1510 * to the target peer
1512 struct GNUNET_MQ_Handle *
1513 GNUNET_CORE_mq_create (struct GNUNET_CORE_Handle *h,
1514 const struct GNUNET_PeerIdentity *target)
1516 struct CoreMQState *mqs = GNUNET_new (struct CoreMQState);
1518 mqs->target = *target;
1519 return GNUNET_MQ_queue_for_callbacks (core_mq_send, core_mq_destroy,
1520 core_mq_cancel, mqs,
1524 /* end of core_api.c */