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 * - implement atsi parsing and passing
31 #include "gnunet_constants.h"
32 #include "gnunet_core_service.h"
37 * Information we track for each peer.
43 * We generally do NOT keep peer records in a DLL; this
44 * DLL is only used IF this peer's 'pending_head' message
45 * is ready for transmission.
47 struct PeerRecord *prev;
50 * We generally do NOT keep peer records in a DLL; this
51 * DLL is only used IF this peer's 'pending_head' message
52 * is ready for transmission.
54 struct PeerRecord *next;
57 * Peer the record is about.
59 struct GNUNET_PeerIdentity peer;
62 * Corresponding core handle.
64 struct GNUNET_CORE_Handle *ch;
67 * Head of doubly-linked list of pending requests.
68 * Requests are sorted by deadline *except* for HEAD,
69 * which is only modified upon transmission to core.
71 struct GNUNET_CORE_TransmitHandle *pending_head;
74 * Tail of doubly-linked list of pending requests.
76 struct GNUNET_CORE_TransmitHandle *pending_tail;
79 * Pending callback waiting for peer information, or NULL for none.
81 GNUNET_CORE_PeerConfigurationInfoCallback pcic;
89 * Request information ID for the given pcic (needed in case a
90 * request is cancelled after being submitted to core and a new
91 * one is generated; in this case, we need to avoid matching the
92 * reply to the first (cancelled) request to the second request).
97 * ID of timeout task for the 'pending_head' handle
98 * which is the one with the smallest timeout.
100 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
103 * Current size of the queue of pending requests.
105 unsigned int queue_size;
108 * SendMessageRequest ID generator for this peer.
116 * Entry in a doubly-linked list of control messages to be transmitted
117 * to the core service. Control messages include traffic allocation,
118 * connection requests and of course our initial 'init' request.
120 * The actual message is allocated at the end of this struct.
122 struct ControlMessage
125 * This is a doubly-linked list.
127 struct ControlMessage *next;
130 * This is a doubly-linked list.
132 struct ControlMessage *prev;
135 * Function to run after successful transmission (or call with
136 * reason 'TIMEOUT' on error); called with scheduler context 'NULL'
139 GNUNET_SCHEDULER_Task cont;
142 * Closure for 'cont'.
151 * Context for the core service connection.
153 struct GNUNET_CORE_Handle
157 * Configuration we're using.
159 const struct GNUNET_CONFIGURATION_Handle *cfg;
162 * Closure for the various callbacks.
167 * Function to call once we've handshaked with the core service.
169 GNUNET_CORE_StartupCallback init;
172 * Function to call whenever we're notified about a peer connecting.
174 GNUNET_CORE_ConnectEventHandler connects;
177 * Function to call whenever we're notified about a peer disconnecting.
179 GNUNET_CORE_DisconnectEventHandler disconnects;
182 * Function to call whenever we're notified about a peer changing status.
184 GNUNET_CORE_PeerStatusEventHandler status_events;
187 * Function to call whenever we receive an inbound message.
189 GNUNET_CORE_MessageCallback inbound_notify;
192 * Function to call whenever we receive an outbound message.
194 GNUNET_CORE_MessageCallback outbound_notify;
197 * Function handlers for messages of particular type.
199 const struct GNUNET_CORE_MessageHandler *handlers;
202 * Our connection to the service.
204 struct GNUNET_CLIENT_Connection *client;
207 * Handle for our current transmission request.
209 struct GNUNET_CLIENT_TransmitHandle *cth;
212 * Head of doubly-linked list of pending requests.
214 struct ControlMessage *pending_head;
217 * Tail of doubly-linked list of pending requests.
219 struct ControlMessage *pending_tail;
222 * Head of doubly-linked list of peers that are core-approved
223 * to send their next message.
225 struct PeerRecord *ready_peer_head;
228 * Tail of doubly-linked list of peers that are core-approved
229 * to send their next message.
231 struct PeerRecord *ready_peer_tail;
234 * Hash map listing all of the peers that we are currently
237 struct GNUNET_CONTAINER_MultiHashMap *peers;
240 * ID of reconnect task (if any).
242 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
245 * Current delay we use for re-trying to connect to core.
247 struct GNUNET_TIME_Relative retry_backoff;
250 * Request information ID generator.
255 * Number of messages we are allowed to queue per target.
257 unsigned int queue_size;
260 * Number of entries in the handlers array.
265 * For inbound notifications without a specific handler, do
266 * we expect to only receive headers?
268 int inbound_hdr_only;
271 * For outbound notifications without a specific handler, do
272 * we expect to only receive headers?
274 int outbound_hdr_only;
277 * Are we currently disconnected and hence unable to forward
286 * Handle for a transmission request.
288 struct GNUNET_CORE_TransmitHandle
292 * We keep active transmit handles in a doubly-linked list.
294 struct GNUNET_CORE_TransmitHandle *next;
297 * We keep active transmit handles in a doubly-linked list.
299 struct GNUNET_CORE_TransmitHandle *prev;
302 * Corresponding peer record.
304 struct PeerRecord *peer;
307 * Corresponding SEND_REQUEST message. Only non-NULL
308 * while SEND_REQUEST message is pending.
310 struct ControlMessage *cm;
313 * Function that will be called to get the actual request
314 * (once we are ready to transmit this request to the core).
315 * The function will be called with a NULL buffer to signal
318 GNUNET_CONNECTION_TransmitReadyNotify get_message;
321 * Closure for get_message.
323 void *get_message_cls;
326 * Timeout for this handle.
328 struct GNUNET_TIME_Absolute timeout;
331 * How important is this message?
336 * Size of this request.
341 * Send message request ID for this request.
349 * Our current client connection went down. Clean it up
350 * and try to reconnect!
352 * @param h our handle to the core service
355 reconnect (struct GNUNET_CORE_Handle *h);
359 * Task schedule to try to re-connect to core.
361 * @param cls the 'struct GNUNET_CORE_Handle'
362 * @param tc task context
365 reconnect_task (void *cls,
366 const struct GNUNET_SCHEDULER_TaskContext *tc)
368 struct GNUNET_CORE_Handle *h = cls;
370 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
372 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
373 "Connecting to CORE service after delay\n");
380 * Notify clients about disconnect and free
381 * the entry for connected peer.
383 * @param cls the 'struct GNUNET_CORE_Handle*'
384 * @param key the peer identity (not used)
385 * @param value the 'struct PeerRecord' to free.
386 * @return GNUNET_YES (continue)
389 disconnect_and_free_peer_entry (void *cls,
390 const GNUNET_HashCode *key,
393 static struct GNUNET_BANDWIDTH_Value32NBO zero;
394 struct GNUNET_CORE_Handle *h = cls;
395 struct GNUNET_CORE_TransmitHandle *th;
396 struct PeerRecord *pr = value;
397 GNUNET_CORE_PeerConfigurationInfoCallback pcic;
399 while (NULL != (th = pr->pending_head))
401 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
406 th->get_message (th->get_message_cls,
410 if (NULL != (pcic = pr->pcic))
418 if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
420 GNUNET_SCHEDULER_cancel (pr->timeout_task);
421 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
423 GNUNET_assert (pr->queue_size == 0);
424 if ( (pr->prev != NULL) ||
425 (pr->next != NULL) ||
426 (h->ready_peer_head == pr) )
427 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
430 if (h->disconnects != NULL)
431 h->disconnects (h->cls,
433 GNUNET_assert (GNUNET_YES ==
434 GNUNET_CONTAINER_multihashmap_remove (h->peers,
437 GNUNET_assert (pr->pending_head == NULL);
438 GNUNET_assert (pr->pending_tail == NULL);
439 GNUNET_assert (pr->ch = h);
440 GNUNET_assert (pr->queue_size == 0);
441 GNUNET_assert (pr->timeout_task == GNUNET_SCHEDULER_NO_TASK);
448 * Close down any existing connection to the CORE service and
449 * try re-establishing it later.
451 * @param h our handle
454 reconnect_later (struct GNUNET_CORE_Handle *h)
456 struct ControlMessage *cm;
458 if (h->client != NULL)
460 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
462 GNUNET_CONTAINER_multihashmap_iterate (h->peers,
463 &disconnect_and_free_peer_entry,
466 h->currently_down = GNUNET_YES;
467 while (NULL != (cm = h->pending_head))
469 GNUNET_CONTAINER_DLL_remove (h->pending_head,
472 cm->cont (cm->cont_cls, NULL);
475 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
476 h->retry_backoff = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
478 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
481 h->retry_backoff = GNUNET_TIME_relative_multiply (h->retry_backoff, 2);
486 * Check the list of pending requests, send the next
489 * @param h core handle
490 * @param ignore_currently_down transmit message even if not initialized?
493 trigger_next_request (struct GNUNET_CORE_Handle *h,
494 int ignore_currently_down);
498 * The given request hit its timeout. Remove from the
499 * doubly-linked list and call the respective continuation.
501 * @param cls the transmit handle of the request that timed out
502 * @param tc context, can be NULL (!)
505 transmission_timeout (void *cls,
506 const struct GNUNET_SCHEDULER_TaskContext *tc);
510 * Control message was sent, mark it as such.
512 * @param cls the 'struct GNUNET_CORE_TransmitHandle*'
513 * @param tc scheduler context
516 mark_control_message_sent (void *cls,
517 const struct GNUNET_SCHEDULER_TaskContext *tc)
519 struct GNUNET_CORE_TransmitHandle *th = cls;
526 * Send a control message to the peer asking for transmission
527 * of the message in the given peer record.
529 * @param pr peer to request transmission to
532 request_next_transmission (struct PeerRecord *pr)
534 struct GNUNET_CORE_Handle *h = pr->ch;
535 struct ControlMessage *cm;
536 struct SendMessageRequest *smr;
537 struct GNUNET_CORE_TransmitHandle *th;
539 if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
541 GNUNET_SCHEDULER_cancel (pr->timeout_task);
542 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
544 if (NULL == (th = pr->pending_head))
546 trigger_next_request (h, GNUNET_NO);
549 GNUNET_assert (pr->prev == NULL);
550 GNUNET_assert (pr->next == NULL);
551 pr->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (th->timeout),
552 &transmission_timeout,
554 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
555 sizeof (struct SendMessageRequest));
556 cm->cont = &mark_control_message_sent;
559 smr = (struct SendMessageRequest*) &cm[1];
560 smr->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST);
561 smr->header.size = htons (sizeof (struct SendMessageRequest));
562 smr->priority = htonl (th->priority);
563 smr->deadline = GNUNET_TIME_absolute_hton (th->timeout);
564 smr->peer = pr->peer;
565 smr->queue_size = htonl (pr->queue_size);
566 smr->size = htons (th->msize);
567 smr->smr_id = htons (th->smr_id = pr->smr_id_gen++);
568 GNUNET_CONTAINER_DLL_insert_after (h->pending_head,
572 trigger_next_request (h, GNUNET_NO);
577 * The given request hit its timeout. Remove from the
578 * doubly-linked list and call the respective continuation.
580 * @param cls the transmit handle of the request that timed out
581 * @param tc context, can be NULL (!)
584 transmission_timeout (void *cls,
585 const struct GNUNET_SCHEDULER_TaskContext *tc)
587 struct PeerRecord *pr = cls;
588 struct GNUNET_CORE_TransmitHandle *th;
590 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
591 th = pr->pending_head;
592 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
597 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
598 "Signalling timeout of request for transmission to CORE service\n");
600 GNUNET_assert (0 == th->get_message (th->get_message_cls, 0, NULL));
601 request_next_transmission (pr);
606 * Transmit the next message to the core service.
609 transmit_message (void *cls,
613 struct GNUNET_CORE_Handle *h = cls;
614 struct ControlMessage *cm;
615 struct GNUNET_CORE_TransmitHandle *th;
616 struct PeerRecord *pr;
617 struct SendMessage *sm;
618 const struct GNUNET_MessageHeader *hdr;
626 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
627 "Transmission failed, initiating reconnect\n");
632 /* first check for control messages */
633 if (NULL != (cm = h->pending_head))
635 hdr = (const struct GNUNET_MessageHeader*) &cm[1];
636 msize = ntohs (hdr->size);
639 trigger_next_request (h, GNUNET_NO);
643 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
644 "Transmitting control message with %u bytes of type %u to core.\n",
645 (unsigned int) msize,
646 (unsigned int) ntohs (hdr->type));
648 memcpy (buf, hdr, msize);
649 GNUNET_CONTAINER_DLL_remove (h->pending_head,
652 if (NULL != cm->cont)
653 GNUNET_SCHEDULER_add_continuation (cm->cont,
655 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
657 trigger_next_request (h, GNUNET_NO);
660 /* now check for 'ready' P2P messages */
661 if (NULL != (pr = h->ready_peer_head))
663 th = pr->pending_head;
664 if (size < th->msize + sizeof (struct SendMessage))
666 trigger_next_request (h, GNUNET_NO);
669 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
672 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
676 if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
678 GNUNET_SCHEDULER_cancel (pr->timeout_task);
679 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
682 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
683 "Transmitting SEND request to `%s' with %u bytes.\n",
684 GNUNET_i2s (&pr->peer),
685 (unsigned int) th->msize);
687 sm = (struct SendMessage *) buf;
688 sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
689 sm->priority = htonl (th->priority);
690 sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
692 ret = th->get_message (th->get_message_cls,
693 size - sizeof (struct SendMessage),
699 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
700 "Size of clients message to peer %s is 0!\n",
701 GNUNET_i2s(&pr->peer));
703 /* client decided to send nothing! */
704 request_next_transmission (pr);
708 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
709 "Produced SEND message to core with %u bytes payload\n",
712 GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
713 if (ret + sizeof (struct SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
716 request_next_transmission (pr);
719 ret += sizeof (struct SendMessage);
720 sm->header.size = htons (ret);
721 GNUNET_assert (ret <= size);
723 request_next_transmission (pr);
731 * Check the list of pending requests, send the next
734 * @param h core handle
735 * @param ignore_currently_down transmit message even if not initialized?
738 trigger_next_request (struct GNUNET_CORE_Handle *h,
739 int ignore_currently_down)
743 if ( (GNUNET_YES == h->currently_down) &&
744 (ignore_currently_down == GNUNET_NO) )
748 if (h->pending_head != NULL)
749 msize = ntohs (((struct GNUNET_MessageHeader*) &h->pending_head[1])->size);
750 else if (h->ready_peer_head != NULL)
751 msize = h->ready_peer_head->pending_head->msize + sizeof (struct SendMessage);
753 return; /* no pending message */
754 h->cth = GNUNET_CLIENT_notify_transmit_ready (h->client,
756 GNUNET_TIME_UNIT_FOREVER_REL,
758 &transmit_message, h);
763 * Handler for notification messages received from the core.
765 * @param cls our "struct GNUNET_CORE_Handle"
766 * @param msg the message received from the core service
769 main_notify_handler (void *cls,
770 const struct GNUNET_MessageHeader *msg)
772 struct GNUNET_CORE_Handle *h = cls;
773 const struct InitReplyMessage *m;
774 const struct ConnectNotifyMessage *cnm;
775 const struct DisconnectNotifyMessage *dnm;
776 const struct NotifyTrafficMessage *ntm;
777 const struct GNUNET_MessageHeader *em;
778 const struct ConfigurationInfoMessage *cim;
779 const struct PeerStatusNotifyMessage *psnm;
780 const struct SendMessageReady *smr;
781 const struct GNUNET_CORE_MessageHandler *mh;
782 GNUNET_CORE_StartupCallback init;
783 GNUNET_CORE_PeerConfigurationInfoCallback pcic;
784 struct GNUNET_PeerIdentity my_identity;
785 struct PeerRecord *pr;
786 struct GNUNET_CORE_TransmitHandle *th;
794 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
796 ("Client was disconnected from core service, trying to reconnect.\n"));
800 msize = ntohs (msg->size);
802 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
803 "Processing message of type %u and size %u from core service\n",
804 ntohs (msg->type), msize);
806 switch (ntohs (msg->type))
808 case GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY:
809 if (ntohs (msg->size) != sizeof (struct InitReplyMessage))
815 m = (const struct InitReplyMessage *) msg;
816 GNUNET_break (0 == ntohl (m->reserved));
817 /* start our message processing loop */
819 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
820 "Successfully connected to core service, starting processing loop.\n");
822 if (GNUNET_YES == h->currently_down)
824 h->currently_down = GNUNET_NO;
825 trigger_next_request (h, GNUNET_NO);
827 h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
828 if (NULL != (init = h->init))
830 /* mark so we don't call init on reconnect */
832 GNUNET_CRYPTO_hash (&m->publicKey,
834 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
835 &my_identity.hashPubKey);
836 init (h->cls, h, &my_identity, &m->publicKey);
839 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
840 if (msize != sizeof (struct ConnectNotifyMessage))
846 cnm = (const struct ConnectNotifyMessage *) msg;
848 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
849 "Received notification about connection from `%s'.\n",
850 GNUNET_i2s (&cnm->peer));
852 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
853 &cnm->peer.hashPubKey);
860 pr = GNUNET_malloc (sizeof (struct PeerRecord));
861 pr->peer = cnm->peer;
863 GNUNET_assert (GNUNET_YES ==
864 GNUNET_CONTAINER_multihashmap_put (h->peers,
865 &cnm->peer.hashPubKey,
867 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
868 if (NULL != h->connects)
871 NULL /* FIXME: atsi! */);
873 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
874 if (msize != sizeof (struct DisconnectNotifyMessage))
880 dnm = (const struct DisconnectNotifyMessage *) msg;
882 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
883 "Received notification about disconnect from `%s'.\n",
884 GNUNET_i2s (&dnm->peer));
886 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
887 &dnm->peer.hashPubKey);
894 trigger = ( (pr->prev != NULL) ||
895 (pr->next != NULL) ||
896 (h->ready_peer_head == pr) );
897 disconnect_and_free_peer_entry (h, &dnm->peer.hashPubKey, pr);
899 trigger_next_request (h, GNUNET_NO);
901 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_STATUS_CHANGE:
902 if (NULL == h->status_events)
907 if (msize != sizeof (struct PeerStatusNotifyMessage))
913 psnm = (const struct PeerStatusNotifyMessage *) msg;
915 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
916 "Received notification about status change by `%s'.\n",
917 GNUNET_i2s (&psnm->peer));
919 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
920 &psnm->peer.hashPubKey);
927 h->status_events (h->cls,
931 GNUNET_TIME_absolute_ntoh (psnm->timeout),
932 NULL /* FIXME: atsi */);
934 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
936 sizeof (struct NotifyTrafficMessage) +
937 sizeof (struct GNUNET_MessageHeader))
943 ntm = (const struct NotifyTrafficMessage *) msg;
944 em = (const struct GNUNET_MessageHeader *) &ntm[1];
946 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
947 "Received message of type %u and size %u from peer `%4s'\n",
950 GNUNET_i2s (&ntm->peer));
952 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
953 &ntm->peer.hashPubKey);
960 if ((GNUNET_NO == h->inbound_hdr_only) &&
961 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
967 et = ntohs (em->type);
968 for (hpos = 0; hpos < h->hcnt; hpos++)
970 mh = &h->handlers[hpos];
973 if ((mh->expected_size != ntohs (em->size)) &&
974 (mh->expected_size != 0))
980 h->handlers[hpos].callback (h->cls, &ntm->peer, em,
981 NULL /* FIXME: atsi */))
983 /* error in processing, do not process other messages! */
987 if (NULL != h->inbound_notify)
988 h->inbound_notify (h->cls, &ntm->peer, em,
989 NULL /* FIXME: atsi */);
991 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
993 sizeof (struct NotifyTrafficMessage) +
994 sizeof (struct GNUNET_MessageHeader))
1000 ntm = (const struct NotifyTrafficMessage *) msg;
1001 em = (const struct GNUNET_MessageHeader *) &ntm[1];
1002 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1003 &ntm->peer.hashPubKey);
1007 reconnect_later (h);
1011 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1012 "Received notification about transmission to `%s'.\n",
1013 GNUNET_i2s (&ntm->peer));
1015 if ((GNUNET_NO == h->outbound_hdr_only) &&
1016 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
1019 reconnect_later (h);
1022 if (NULL == h->outbound_notify)
1027 h->outbound_notify (h->cls, &ntm->peer, em,
1028 NULL /* FIXME: atsi? */);
1030 case GNUNET_MESSAGE_TYPE_CORE_SEND_READY:
1031 if (msize != sizeof (struct SendMessageReady))
1034 reconnect_later (h);
1037 smr = (const struct SendMessageReady *) msg;
1038 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1039 &smr->peer.hashPubKey);
1043 reconnect_later (h);
1047 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1048 "Received notification about transmission readiness to `%s'.\n",
1049 GNUNET_i2s (&smr->peer));
1051 th = pr->pending_head;
1052 if (ntohs (smr->smr_id) != th->smr_id)
1054 /* READY message is for expired or cancelled message,
1055 ignore! (we should have already sent another request) */
1058 if ( (pr->prev != NULL) ||
1059 (pr->next != NULL) ||
1060 (h->ready_peer_head == pr) )
1062 /* we should not already be on the ready list... */
1064 reconnect_later (h);
1067 GNUNET_CONTAINER_DLL_insert (h->ready_peer_head,
1070 trigger_next_request (h, GNUNET_NO);
1072 case GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO:
1073 if (ntohs (msg->size) != sizeof (struct ConfigurationInfoMessage))
1076 reconnect_later (h);
1079 cim = (const struct ConfigurationInfoMessage*) msg;
1081 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1082 "Received notification about configuration update for `%s'.\n",
1083 GNUNET_i2s (&cim->peer));
1085 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1086 &cim->peer.hashPubKey);
1090 reconnect_later (h);
1093 if (pr->rim_id != ntohl (cim->rim_id))
1101 ntohl (cim->reserved_amount),
1102 GNUNET_ntohll (cim->preference));
1105 reconnect_later (h);
1108 GNUNET_CLIENT_receive (h->client,
1109 &main_notify_handler, h,
1110 GNUNET_TIME_UNIT_FOREVER_REL);
1115 * Task executed once we are done transmitting the INIT message.
1116 * Starts our 'receive' loop.
1118 * @param cls the 'struct GNUNET_CORE_Handle'
1119 * @param tc task context
1122 init_done_task (void *cls,
1123 const struct GNUNET_SCHEDULER_TaskContext *tc)
1125 struct GNUNET_CORE_Handle *h = cls;
1129 if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
1132 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1133 "Failed to exchange INIT with core, retrying\n");
1135 reconnect_later (h);
1138 GNUNET_CLIENT_receive (h->client,
1139 &main_notify_handler,
1141 GNUNET_TIME_UNIT_FOREVER_REL);
1146 * Our current client connection went down. Clean it up
1147 * and try to reconnect!
1149 * @param h our handle to the core service
1152 reconnect (struct GNUNET_CORE_Handle *h)
1154 struct ControlMessage *cm;
1155 struct InitMessage *init;
1162 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1163 "Reconnecting to CORE service\n");
1165 GNUNET_assert (h->client == NULL);
1166 GNUNET_assert (h->currently_down == GNUNET_YES);
1167 h->client = GNUNET_CLIENT_connect ("core", h->cfg);
1168 if (h->client == NULL)
1170 reconnect_later (h);
1173 msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
1174 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1176 cm->cont = &init_done_task;
1178 init = (struct InitMessage*) &cm[1];
1179 init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
1180 init->header.size = htons (msize);
1181 opt = GNUNET_CORE_OPTION_SEND_CONNECT | GNUNET_CORE_OPTION_SEND_DISCONNECT;
1182 if (h->status_events != NULL)
1183 opt |= GNUNET_CORE_OPTION_SEND_STATUS_CHANGE;
1184 if (h->inbound_notify != NULL)
1186 if (h->inbound_hdr_only)
1187 opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
1189 opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
1191 if (h->outbound_notify != NULL)
1193 if (h->outbound_hdr_only)
1194 opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
1196 opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
1198 init->options = htonl (opt);
1199 ts = (uint16_t *) &init[1];
1200 for (hpos = 0; hpos < h->hcnt; hpos++)
1201 ts[hpos] = htons (h->handlers[hpos].type);
1202 GNUNET_CONTAINER_DLL_insert (h->pending_head,
1205 trigger_next_request (h, GNUNET_YES);
1211 * Connect to the core service. Note that the connection may
1212 * complete (or fail) asynchronously.
1214 * @param cfg configuration to use
1215 * @param queue_size size of the per-peer message queue
1216 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
1217 * @param init callback to call on timeout or once we have successfully
1218 * connected to the core service; note that timeout is only meaningful if init is not NULL
1219 * @param connects function to call on peer connect, can be NULL
1220 * @param disconnects function to call on peer disconnect / timeout, can be NULL
1221 * @param status_events function to call on changes to peer connection status, can be NULL
1222 * @param inbound_notify function to call for all inbound messages, can be NULL
1223 * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
1224 * GNUNET_MessageHeader and hence we do not need to give it the full message;
1225 * can be used to improve efficiency, ignored if inbound_notify is NULLL
1226 * @param outbound_notify function to call for all outbound messages, can be NULL
1227 * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
1228 * GNUNET_MessageHeader and hence we do not need to give it the full message
1229 * can be used to improve efficiency, ignored if outbound_notify is NULLL
1230 * @param handlers callbacks for messages we care about, NULL-terminated
1231 * @return handle to the core service (only useful for disconnect until 'init' is called);
1232 * NULL on error (in this case, init is never called)
1234 struct GNUNET_CORE_Handle *
1235 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1236 unsigned int queue_size,
1238 GNUNET_CORE_StartupCallback init,
1239 GNUNET_CORE_ConnectEventHandler connects,
1240 GNUNET_CORE_DisconnectEventHandler disconnects,
1241 GNUNET_CORE_PeerStatusEventHandler status_events,
1242 GNUNET_CORE_MessageCallback inbound_notify,
1243 int inbound_hdr_only,
1244 GNUNET_CORE_MessageCallback outbound_notify,
1245 int outbound_hdr_only,
1246 const struct GNUNET_CORE_MessageHandler *handlers)
1248 struct GNUNET_CORE_Handle *h;
1250 h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
1252 h->queue_size = queue_size;
1255 h->connects = connects;
1256 h->disconnects = disconnects;
1257 h->status_events = status_events;
1258 h->inbound_notify = inbound_notify;
1259 h->outbound_notify = outbound_notify;
1260 h->inbound_hdr_only = inbound_hdr_only;
1261 h->outbound_hdr_only = outbound_hdr_only;
1262 h->handlers = handlers;
1264 h->currently_down = GNUNET_YES;
1265 h->peers = GNUNET_CONTAINER_multihashmap_create (128);
1266 h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
1267 while (handlers[h->hcnt].callback != NULL)
1269 GNUNET_assert (h->hcnt <
1270 (GNUNET_SERVER_MAX_MESSAGE_SIZE -
1271 sizeof (struct InitMessage)) / sizeof (uint16_t));
1273 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1274 "Connecting to CORE service\n");
1282 * Disconnect from the core service. This function can only
1283 * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready'
1284 * requests have been explicitly cancelled.
1286 * @param handle connection to core to disconnect
1289 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
1291 struct ControlMessage *cm;
1294 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1295 "Disconnecting from CORE service\n");
1297 if (handle->cth != NULL)
1299 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->cth);
1302 if (handle->client != NULL)
1304 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1305 handle->client = NULL;
1307 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1309 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1310 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1312 while (NULL != (cm = handle->pending_head))
1314 GNUNET_CONTAINER_DLL_remove (handle->pending_head,
1315 handle->pending_tail,
1317 cm->cont (cm->cont_cls, NULL);
1320 GNUNET_CONTAINER_multihashmap_iterate (handle->peers,
1321 &disconnect_and_free_peer_entry,
1323 GNUNET_CONTAINER_multihashmap_destroy (handle->peers);
1324 GNUNET_break (handle->ready_peer_head == NULL);
1325 GNUNET_free (handle);
1330 * Ask the core to call "notify" once it is ready to transmit the
1331 * given number of bytes to the specified "target". If we are not yet
1332 * connected to the specified peer, a call to this function will cause
1333 * us to try to establish a connection.
1335 * @param handle connection to core service
1336 * @param priority how important is the message?
1337 * @param maxdelay how long can the message wait?
1338 * @param target who should receive the message,
1339 * use NULL for this peer (loopback)
1340 * @param notify_size how many bytes of buffer space does notify want?
1341 * @param notify function to call when buffer space is available
1342 * @param notify_cls closure for notify
1343 * @return non-NULL if the notify callback was queued,
1344 * NULL if we can not even queue the request (insufficient
1345 * memory); if NULL is returned, "notify" will NOT be called.
1347 struct GNUNET_CORE_TransmitHandle *
1348 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
1350 struct GNUNET_TIME_Relative maxdelay,
1351 const struct GNUNET_PeerIdentity *target,
1353 GNUNET_CONNECTION_TransmitReadyNotify notify,
1356 struct PeerRecord *pr;
1357 struct GNUNET_CORE_TransmitHandle *th;
1358 struct GNUNET_CORE_TransmitHandle *pos;
1359 struct GNUNET_CORE_TransmitHandle *prev;
1360 struct GNUNET_CORE_TransmitHandle *minp;
1362 pr = GNUNET_CONTAINER_multihashmap_get (handle->peers,
1363 &target->hashPubKey);
1366 /* attempt to send to peer that is not connected */
1370 GNUNET_assert (notify_size + sizeof (struct SendMessage) <
1371 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1372 th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
1374 th->get_message = notify;
1375 th->get_message_cls = notify_cls;
1376 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1377 th->priority = priority;
1378 th->msize = notify_size;
1379 /* bound queue size */
1380 if (pr->queue_size == handle->queue_size)
1382 /* find lowest-priority entry */
1383 minp = pr->pending_head;
1385 while (prev != NULL)
1387 if (prev->priority < minp->priority)
1393 GNUNET_break (handle->queue_size != 0);
1394 GNUNET_break (pr->queue_size == 0);
1397 if (priority <= minp->priority)
1398 return NULL; /* priority too low */
1399 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1404 minp->get_message (minp->get_message_cls,
1409 /* Order entries by deadline, but SKIP 'HEAD' if
1410 we're in the 'ready_peer_*' DLL */
1411 pos = pr->pending_head;
1412 if ( (pr->prev != NULL) ||
1413 (pr->next != NULL) ||
1414 (pr == handle->ready_peer_head) )
1416 GNUNET_assert (pos != NULL);
1417 pos = pos->next; /* skip head */
1420 /* insertion sort */
1422 while ( (pos != NULL) &&
1423 (pos->timeout.abs_value < th->timeout.abs_value) )
1428 GNUNET_CONTAINER_DLL_insert_after (pr->pending_head,
1433 /* was the request queue previously empty? */
1434 if (pr->pending_head == th)
1435 request_next_transmission (pr);
1441 * Cancel the specified transmission-ready notification.
1443 * @param th handle that was returned by "notify_transmit_ready".
1446 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
1449 struct PeerRecord *pr = th->peer;
1450 struct GNUNET_CORE_Handle *h = pr->ch;
1453 was_head = (pr->pending_head == th);
1454 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1459 /* we're currently in the control queue, remove */
1460 GNUNET_CONTAINER_DLL_remove (h->pending_head,
1463 GNUNET_free (th->cm);
1468 if ( (pr->prev != NULL) ||
1469 (pr->next != NULL) ||
1470 (pr == h->ready_peer_head) )
1472 /* the request that was 'approved' by core was
1473 cancelled before it could be transmitted; remove
1474 us from the 'ready' list */
1475 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
1479 request_next_transmission (pr);
1484 /* ****************** GNUNET_CORE_peer_request_connect ******************** */
1487 * Handle for a request to the core to connect to
1488 * a particular peer. Can be used to cancel the request
1489 * (before the 'cont'inuation is called).
1491 struct GNUNET_CORE_PeerRequestHandle
1495 * Link to control message.
1497 struct ControlMessage *cm;
1502 struct GNUNET_CORE_Handle *h;
1505 * Continuation to run when done.
1507 GNUNET_SCHEDULER_Task cont;
1510 * Closure for 'cont'.
1518 * Continuation called when the control message was transmitted.
1519 * Calls the original continuation and frees the remaining
1522 * @param cls the 'struct GNUNET_CORE_PeerRequestHandle'
1523 * @param tc scheduler context
1526 peer_request_connect_cont (void *cls,
1527 const struct GNUNET_SCHEDULER_TaskContext *tc)
1529 struct GNUNET_CORE_PeerRequestHandle *ret = cls;
1531 if (ret->cont != NULL)
1534 GNUNET_SCHEDULER_add_now (ret->cont,
1537 ret->cont (ret->cont_cls, tc);
1544 * Request that the core should try to connect to a particular peer.
1545 * Once the request has been transmitted to the core, the continuation
1546 * function will be called. Note that this does NOT mean that a
1547 * connection was successfully established -- it only means that the
1548 * core will now try. Successful establishment of the connection
1549 * will be signalled to the 'connects' callback argument of
1550 * 'GNUNET_CORE_connect' only. If the core service does not respond
1551 * to our connection attempt within the given time frame, 'cont' will
1552 * be called with the TIMEOUT reason code.
1554 * @param h core handle
1555 * @param timeout how long to try to talk to core
1556 * @param peer who should we connect to
1557 * @param cont function to call once the request has been completed (or timed out)
1558 * @param cont_cls closure for cont
1559 * @return NULL on error (cont will not be called), otherwise handle for cancellation
1561 struct GNUNET_CORE_PeerRequestHandle *
1562 GNUNET_CORE_peer_request_connect (struct GNUNET_CORE_Handle *h,
1563 struct GNUNET_TIME_Relative timeout,
1564 const struct GNUNET_PeerIdentity * peer,
1565 GNUNET_SCHEDULER_Task cont,
1568 struct GNUNET_CORE_PeerRequestHandle *ret;
1569 struct ControlMessage *cm;
1570 struct ConnectMessage *msg;
1572 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1573 sizeof (struct ConnectMessage));
1574 msg = (struct ConnectMessage*) &cm[1];
1575 msg->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT);
1576 msg->header.size = htons (sizeof (struct ConnectMessage));
1577 msg->reserved = htonl (0);
1578 msg->timeout = GNUNET_TIME_relative_hton (timeout);
1580 GNUNET_CONTAINER_DLL_insert (h->pending_head,
1583 ret = GNUNET_malloc (sizeof (struct GNUNET_CORE_PeerRequestHandle));
1587 ret->cont_cls = cont_cls;
1588 cm->cont = &peer_request_connect_cont;
1590 if (h->pending_head == cm)
1591 trigger_next_request (h, GNUNET_NO);
1597 * Cancel a pending request to connect to a particular peer. Must not
1598 * be called after the 'cont' function was invoked.
1600 * @param req request handle that was returned for the original request
1603 GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *req)
1605 struct GNUNET_CORE_Handle *h = req->h;
1606 struct ControlMessage *cm = req->cm;
1608 GNUNET_CONTAINER_DLL_remove (h->pending_head,
1616 /* ****************** GNUNET_CORE_peer_change_preference ******************** */
1619 struct GNUNET_CORE_InformationRequestContext
1623 * Our connection to the service.
1625 struct GNUNET_CORE_Handle *h;
1628 * Function to call with the information.
1630 GNUNET_CORE_PeerConfigurationInfoCallback info;
1638 * Link to control message, NULL if CM was sent.
1640 struct ControlMessage *cm;
1643 * Link to peer record.
1645 struct PeerRecord *pr;
1650 * CM was sent, remove link so we don't double-free.
1652 * @param cls the 'struct GNUNET_CORE_InformationRequestContext'
1653 * @param tc scheduler context
1656 change_preference_send_continuation (void *cls,
1657 const struct GNUNET_SCHEDULER_TaskContext *tc)
1659 struct GNUNET_CORE_InformationRequestContext *irc = cls;
1666 * Obtain statistics and/or change preferences for the given peer.
1668 * @param h core handle
1669 * @param peer identifies the peer
1670 * @param timeout after how long should we give up (and call "info" with NULL
1671 * for "peer" to signal an error)?
1672 * @param bw_out set to the current bandwidth limit (sending) for this peer,
1673 * caller should set "bw_out" to "-1" to avoid changing
1674 * the current value; otherwise "bw_out" will be lowered to
1675 * the specified value; passing a pointer to "0" can be used to force
1676 * us to disconnect from the peer; "bw_out" might not increase
1677 * as specified since the upper bound is generally
1678 * determined by the other peer!
1679 * @param amount reserve N bytes for receiving, negative
1680 * amounts can be used to undo a (recent) reservation;
1681 * @param preference increase incoming traffic share preference by this amount;
1682 * in the absence of "amount" reservations, we use this
1683 * preference value to assign proportional bandwidth shares
1684 * to all connected peers
1685 * @param info function to call with the resulting configuration information
1686 * @param info_cls closure for info
1687 * @return NULL on error
1689 struct GNUNET_CORE_InformationRequestContext *
1690 GNUNET_CORE_peer_change_preference (struct GNUNET_CORE_Handle *h,
1691 const struct GNUNET_PeerIdentity *peer,
1692 struct GNUNET_TIME_Relative timeout,
1693 struct GNUNET_BANDWIDTH_Value32NBO bw_out,
1695 uint64_t preference,
1696 GNUNET_CORE_PeerConfigurationInfoCallback info,
1699 struct GNUNET_CORE_InformationRequestContext *irc;
1700 struct PeerRecord *pr;
1701 struct RequestInfoMessage *rim;
1702 struct ControlMessage *cm;
1704 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1708 /* attempt to change preference on peer that is not connected */
1712 if (pr->pcic != NULL)
1714 /* second change before first one is done */
1718 irc = GNUNET_malloc (sizeof (struct GNUNET_CORE_InformationRequestContext));
1721 irc->info_cls = info_cls;
1722 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1723 sizeof (struct RequestInfoMessage));
1724 cm->cont = &change_preference_send_continuation;
1727 rim = (struct RequestInfoMessage*) &cm[1];
1728 rim->header.size = htons (sizeof (struct RequestInfoMessage));
1729 rim->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_INFO);
1730 rim->rim_id = htonl (pr->rim_id = h->rim_id_gen++);
1731 rim->limit_outbound = bw_out;
1732 rim->reserve_inbound = htonl (amount);
1733 rim->preference_change = GNUNET_htonll(preference);
1735 GNUNET_CONTAINER_DLL_insert (h->pending_head,
1739 pr->pcic_cls = info_cls;
1745 * Cancel request for getting information about a peer.
1746 * Note that an eventual change in preference, trust or bandwidth
1747 * assignment MAY have already been committed at the time,
1748 * so cancelling a request is NOT sure to undo the original
1749 * request. The original request may or may not still commit.
1750 * The only thing cancellation ensures is that the callback
1751 * from the original request will no longer be called.
1753 * @param irc context returned by the original GNUNET_CORE_peer_get_info call
1756 GNUNET_CORE_peer_change_preference_cancel (struct GNUNET_CORE_InformationRequestContext *irc)
1758 struct GNUNET_CORE_Handle *h = irc->h;
1759 struct PeerRecord *pr = irc->pr;
1761 if (irc->cm != NULL)
1763 GNUNET_CONTAINER_DLL_remove (h->pending_head,
1766 GNUNET_free (irc->cm);
1769 pr->pcic_cls = NULL;
1774 /* ********************* GNUNET_CORE_iterate_peers *********************** */
1777 * Context for 'iterate_peers' helper function.
1779 struct IterationContext
1784 GNUNET_CORE_ConnectEventHandler peer_cb;
1787 * Closure for 'peer_cb'.
1794 * Call callback for each peer.
1796 * @param cls the 'struct IterationContext'
1797 * @param hc peer identity, not used
1798 * @param value the 'struct PeerRecord'
1799 * @return GNUNET_YES (continue iteration)
1802 iterate_peers (void *cls,
1803 const GNUNET_HashCode *hc,
1806 struct IterationContext *ic = cls;
1807 struct PeerRecord *pr = value;
1809 ic->peer_cb (ic->cb_cls,
1811 NULL /* FIXME: pass atsi? */);
1817 * Obtain statistics and/or change preferences for the given peer.
1819 * @param h handle to core
1820 * @param peer_cb function to call with the peer information
1821 * @param cb_cls closure for peer_cb
1822 * @return GNUNET_OK if iterating, GNUNET_SYSERR on error
1825 GNUNET_CORE_iterate_peers (struct GNUNET_CORE_Handle *h,
1826 GNUNET_CORE_ConnectEventHandler peer_cb,
1829 struct IterationContext ic;
1831 ic.peer_cb = peer_cb;
1833 GNUNET_CONTAINER_multihashmap_iterate (h->peers,
1840 /* end of core_api.c */