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).
138 GNUNET_SCHEDULER_Task cont;
141 * Closure for 'cont'.
150 * Context for the core service connection.
152 struct GNUNET_CORE_Handle
156 * Configuration we're using.
158 const struct GNUNET_CONFIGURATION_Handle *cfg;
161 * Closure for the various callbacks.
166 * Function to call once we've handshaked with the core service.
168 GNUNET_CORE_StartupCallback init;
171 * Function to call whenever we're notified about a peer connecting.
173 GNUNET_CORE_ConnectEventHandler connects;
176 * Function to call whenever we're notified about a peer disconnecting.
178 GNUNET_CORE_DisconnectEventHandler disconnects;
181 * Function to call whenever we're notified about a peer changing status.
183 GNUNET_CORE_PeerStatusEventHandler status_events;
186 * Function to call whenever we receive an inbound message.
188 GNUNET_CORE_MessageCallback inbound_notify;
191 * Function to call whenever we receive an outbound message.
193 GNUNET_CORE_MessageCallback outbound_notify;
196 * Function handlers for messages of particular type.
198 const struct GNUNET_CORE_MessageHandler *handlers;
201 * Our connection to the service.
203 struct GNUNET_CLIENT_Connection *client;
206 * Handle for our current transmission request.
208 struct GNUNET_CLIENT_TransmitHandle *cth;
211 * Head of doubly-linked list of pending requests.
213 struct ControlMessage *pending_head;
216 * Tail of doubly-linked list of pending requests.
218 struct ControlMessage *pending_tail;
221 * Head of doubly-linked list of peers that are core-approved
222 * to send their next message.
224 struct PeerRecord *ready_peer_head;
227 * Tail of doubly-linked list of peers that are core-approved
228 * to send their next message.
230 struct PeerRecord *ready_peer_tail;
233 * Hash map listing all of the peers that we are currently
236 struct GNUNET_CONTAINER_MultiHashMap *peers;
239 * ID of reconnect task (if any).
241 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
244 * Current delay we use for re-trying to connect to core.
246 struct GNUNET_TIME_Relative retry_backoff;
249 * Request information ID generator.
254 * Number of messages we are allowed to queue per target.
256 unsigned int queue_size;
259 * Number of entries in the handlers array.
264 * For inbound notifications without a specific handler, do
265 * we expect to only receive headers?
267 int inbound_hdr_only;
270 * For outbound notifications without a specific handler, do
271 * we expect to only receive headers?
273 int outbound_hdr_only;
276 * Are we currently disconnected and hence unable to forward
285 * Handle for a transmission request.
287 struct GNUNET_CORE_TransmitHandle
291 * We keep active transmit handles in a doubly-linked list.
293 struct GNUNET_CORE_TransmitHandle *next;
296 * We keep active transmit handles in a doubly-linked list.
298 struct GNUNET_CORE_TransmitHandle *prev;
301 * Corresponding peer record.
303 struct PeerRecord *peer;
306 * Corresponding SEND_REQUEST message. Only non-NULL
307 * while SEND_REQUEST message is pending.
309 struct ControlMessage *cm;
312 * Function that will be called to get the actual request
313 * (once we are ready to transmit this request to the core).
314 * The function will be called with a NULL buffer to signal
317 GNUNET_CONNECTION_TransmitReadyNotify get_message;
320 * Closure for get_message.
322 void *get_message_cls;
325 * Timeout for this handle.
327 struct GNUNET_TIME_Absolute timeout;
330 * How important is this message?
335 * Size of this request.
340 * Send message request ID for this request.
348 * Our current client connection went down. Clean it up
349 * and try to reconnect!
351 * @param h our handle to the core service
354 reconnect (struct GNUNET_CORE_Handle *h);
358 * Task schedule to try to re-connect to core.
360 * @param cls the 'struct GNUNET_CORE_Handle'
361 * @param tc task context
364 reconnect_task (void *cls,
365 const struct GNUNET_SCHEDULER_TaskContext *tc)
367 struct GNUNET_CORE_Handle *h = cls;
369 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
371 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
372 "Connecting to CORE service after delay\n");
379 * Notify clients about disconnect and free
380 * the entry for connected peer.
382 * @param cls the 'struct GNUNET_CORE_Handle*'
383 * @param key the peer identity (not used)
384 * @param value the 'struct PeerRecord' to free.
385 * @return GNUNET_YES (continue)
388 disconnect_and_free_peer_entry (void *cls,
389 const GNUNET_HashCode *key,
392 static struct GNUNET_BANDWIDTH_Value32NBO zero;
393 struct GNUNET_CORE_Handle *h = cls;
394 struct GNUNET_CORE_TransmitHandle *th;
395 struct PeerRecord *pr = value;
396 GNUNET_CORE_PeerConfigurationInfoCallback pcic;
398 while (NULL != (th = pr->pending_head))
400 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
405 th->get_message (th->get_message_cls,
409 if (NULL != (pcic = pr->pcic))
417 if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
419 GNUNET_SCHEDULER_cancel (pr->timeout_task);
420 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
422 GNUNET_assert (pr->queue_size == 0);
423 if ( (pr->prev != NULL) ||
424 (pr->next != NULL) ||
425 (h->ready_peer_head == pr) )
426 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
429 if (h->disconnects != NULL)
430 h->disconnects (h->cls,
432 GNUNET_assert (GNUNET_YES ==
433 GNUNET_CONTAINER_multihashmap_remove (h->peers,
436 GNUNET_assert (pr->pending_head == NULL);
437 GNUNET_assert (pr->pending_tail == NULL);
438 GNUNET_assert (pr->ch = h);
439 GNUNET_assert (pr->queue_size == 0);
440 GNUNET_assert (pr->timeout_task == GNUNET_SCHEDULER_NO_TASK);
447 * Close down any existing connection to the CORE service and
448 * try re-establishing it later.
450 * @param h our handle
453 reconnect_later (struct GNUNET_CORE_Handle *h)
455 if (h->client != NULL)
457 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
459 GNUNET_CONTAINER_multihashmap_iterate (h->peers,
460 &disconnect_and_free_peer_entry,
463 h->currently_down = GNUNET_YES;
464 GNUNET_assert (h->reconnect_task == GNUNET_SCHEDULER_NO_TASK);
465 h->retry_backoff = GNUNET_TIME_relative_min (GNUNET_TIME_UNIT_SECONDS,
467 h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
470 h->retry_backoff = GNUNET_TIME_relative_multiply (h->retry_backoff, 2);
475 * Check the list of pending requests, send the next
478 * @param h core handle
479 * @param ignore_currently_down transmit message even if not initialized?
482 trigger_next_request (struct GNUNET_CORE_Handle *h,
483 int ignore_currently_down);
487 * The given request hit its timeout. Remove from the
488 * doubly-linked list and call the respective continuation.
490 * @param cls the transmit handle of the request that timed out
491 * @param tc context, can be NULL (!)
494 transmission_timeout (void *cls,
495 const struct GNUNET_SCHEDULER_TaskContext *tc);
499 * Control message was sent, mark it as such.
501 * @param cls the 'struct GNUNET_CORE_TransmitHandle*'
502 * @param tc scheduler context
505 mark_control_message_sent (void *cls,
506 const struct GNUNET_SCHEDULER_TaskContext *tc)
508 struct GNUNET_CORE_TransmitHandle *th = cls;
515 * Send a control message to the peer asking for transmission
516 * of the message in the given peer record.
518 * @param pr peer to request transmission to
521 request_next_transmission (struct PeerRecord *pr)
523 struct GNUNET_CORE_Handle *h = pr->ch;
524 struct ControlMessage *cm;
525 struct SendMessageRequest *smr;
526 struct GNUNET_CORE_TransmitHandle *th;
528 if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
530 GNUNET_SCHEDULER_cancel (pr->timeout_task);
531 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
533 if (NULL == (th = pr->pending_head))
535 trigger_next_request (h, GNUNET_NO);
538 GNUNET_assert (pr->prev == NULL);
539 GNUNET_assert (pr->next == NULL);
540 pr->timeout_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining (th->timeout),
541 &transmission_timeout,
543 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
544 sizeof (struct SendMessageRequest));
545 cm->cont = &mark_control_message_sent;
548 smr = (struct SendMessageRequest*) &cm[1];
549 smr->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST);
550 smr->header.size = htons (sizeof (struct SendMessageRequest));
551 smr->priority = htonl (th->priority);
552 smr->deadline = GNUNET_TIME_absolute_hton (th->timeout);
553 smr->peer = pr->peer;
554 smr->queue_size = htonl (pr->queue_size);
555 smr->size = htons (th->msize);
556 smr->smr_id = htons (th->smr_id = pr->smr_id_gen++);
557 GNUNET_CONTAINER_DLL_insert_after (h->pending_head,
561 trigger_next_request (h, GNUNET_NO);
566 * The given request hit its timeout. Remove from the
567 * doubly-linked list and call the respective continuation.
569 * @param cls the transmit handle of the request that timed out
570 * @param tc context, can be NULL (!)
573 transmission_timeout (void *cls,
574 const struct GNUNET_SCHEDULER_TaskContext *tc)
576 struct PeerRecord *pr = cls;
577 struct GNUNET_CORE_TransmitHandle *th;
579 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
580 th = pr->pending_head;
581 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
586 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
587 "Signalling timeout of request for transmission to CORE service\n");
589 GNUNET_assert (0 == th->get_message (th->get_message_cls, 0, NULL));
590 request_next_transmission (pr);
595 * Transmit the next message to the core service.
598 transmit_message (void *cls,
602 struct GNUNET_CORE_Handle *h = cls;
603 struct ControlMessage *cm;
604 struct GNUNET_CORE_TransmitHandle *th;
605 struct PeerRecord *pr;
606 struct SendMessage *sm;
607 const struct GNUNET_MessageHeader *hdr;
615 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
616 "Transmission failed, initiating reconnect\n");
621 /* first check for control messages */
622 if (NULL != (cm = h->pending_head))
624 hdr = (const struct GNUNET_MessageHeader*) &cm[1];
625 msize = ntohs (hdr->size);
628 trigger_next_request (h, GNUNET_NO);
632 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
633 "Transmitting control message with %u bytes of type %u to core.\n",
634 (unsigned int) msize,
635 (unsigned int) ntohs (hdr->type));
637 memcpy (buf, hdr, msize);
638 GNUNET_CONTAINER_DLL_remove (h->pending_head,
641 if (NULL != cm->cont)
642 GNUNET_SCHEDULER_add_continuation (cm->cont,
644 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
646 trigger_next_request (h, GNUNET_NO);
649 /* now check for 'ready' P2P messages */
650 if (NULL != (pr = h->ready_peer_head))
652 th = pr->pending_head;
653 if (size < th->msize + sizeof (struct SendMessage))
655 trigger_next_request (h, GNUNET_NO);
658 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
661 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
665 if (pr->timeout_task != GNUNET_SCHEDULER_NO_TASK)
667 GNUNET_SCHEDULER_cancel (pr->timeout_task);
668 pr->timeout_task = GNUNET_SCHEDULER_NO_TASK;
671 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
672 "Transmitting SEND request to `%s' with %u bytes.\n",
673 GNUNET_i2s (&pr->peer),
674 (unsigned int) th->msize);
676 sm = (struct SendMessage *) buf;
677 sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
678 sm->priority = htonl (th->priority);
679 sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
681 ret = th->get_message (th->get_message_cls,
682 size - sizeof (struct SendMessage),
688 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
689 "Size of clients message to peer %s is 0!\n",
690 GNUNET_i2s(&pr->peer));
692 /* client decided to send nothing! */
693 request_next_transmission (pr);
697 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
698 "Produced SEND message to core with %u bytes payload\n",
701 GNUNET_assert (ret >= sizeof (struct GNUNET_MessageHeader));
702 if (ret + sizeof (struct SendMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
705 request_next_transmission (pr);
708 ret += sizeof (struct SendMessage);
709 sm->header.size = htons (ret);
710 GNUNET_assert (ret <= size);
712 request_next_transmission (pr);
720 * Check the list of pending requests, send the next
723 * @param h core handle
724 * @param ignore_currently_down transmit message even if not initialized?
727 trigger_next_request (struct GNUNET_CORE_Handle *h,
728 int ignore_currently_down)
732 if ( (GNUNET_YES == h->currently_down) &&
733 (ignore_currently_down == GNUNET_NO) )
737 if (h->pending_head != NULL)
738 msize = ntohs (((struct GNUNET_MessageHeader*) &h->pending_head[1])->size);
739 else if (h->ready_peer_head != NULL)
740 msize = h->ready_peer_head->pending_head->msize + sizeof (struct SendMessage);
742 return; /* no pending message */
743 h->cth = GNUNET_CLIENT_notify_transmit_ready (h->client,
745 GNUNET_TIME_UNIT_FOREVER_REL,
747 &transmit_message, h);
752 * Handler for notification messages received from the core.
754 * @param cls our "struct GNUNET_CORE_Handle"
755 * @param msg the message received from the core service
758 main_notify_handler (void *cls,
759 const struct GNUNET_MessageHeader *msg)
761 struct GNUNET_CORE_Handle *h = cls;
762 const struct InitReplyMessage *m;
763 const struct ConnectNotifyMessage *cnm;
764 const struct DisconnectNotifyMessage *dnm;
765 const struct NotifyTrafficMessage *ntm;
766 const struct GNUNET_MessageHeader *em;
767 const struct ConfigurationInfoMessage *cim;
768 const struct PeerStatusNotifyMessage *psnm;
769 const struct SendMessageReady *smr;
770 const struct GNUNET_CORE_MessageHandler *mh;
771 GNUNET_CORE_StartupCallback init;
772 GNUNET_CORE_PeerConfigurationInfoCallback pcic;
773 struct GNUNET_PeerIdentity my_identity;
774 struct PeerRecord *pr;
775 struct GNUNET_CORE_TransmitHandle *th;
783 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
785 ("Client was disconnected from core service, trying to reconnect.\n"));
789 msize = ntohs (msg->size);
791 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
792 "Processing message of type %u and size %u from core service\n",
793 ntohs (msg->type), msize);
795 switch (ntohs (msg->type))
797 case GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY:
798 if (ntohs (msg->size) != sizeof (struct InitReplyMessage))
804 m = (const struct InitReplyMessage *) msg;
805 GNUNET_break (0 == ntohl (m->reserved));
806 /* start our message processing loop */
808 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
809 "Successfully connected to core service, starting processing loop.\n");
811 if (GNUNET_YES == h->currently_down)
813 h->currently_down = GNUNET_NO;
814 trigger_next_request (h, GNUNET_NO);
816 h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
817 if (NULL != (init = h->init))
819 /* mark so we don't call init on reconnect */
821 GNUNET_CRYPTO_hash (&m->publicKey,
823 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
824 &my_identity.hashPubKey);
825 init (h->cls, h, &my_identity, &m->publicKey);
828 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
829 if (msize != sizeof (struct ConnectNotifyMessage))
834 cnm = (const struct ConnectNotifyMessage *) msg;
836 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
837 "Received notification about connection from `%s'.\n",
838 GNUNET_i2s (&cnm->peer));
840 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
841 &cnm->peer.hashPubKey);
848 pr = GNUNET_malloc (sizeof (struct PeerRecord));
849 pr->peer = cnm->peer;
851 GNUNET_assert (GNUNET_YES ==
852 GNUNET_CONTAINER_multihashmap_put (h->peers,
853 &cnm->peer.hashPubKey,
855 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
856 if (NULL != h->connects)
859 NULL /* FIXME: atsi! */);
861 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
862 if (msize != sizeof (struct DisconnectNotifyMessage))
867 dnm = (const struct DisconnectNotifyMessage *) msg;
869 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
870 "Received notification about disconnect from `%s'.\n",
871 GNUNET_i2s (&dnm->peer));
873 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
874 &dnm->peer.hashPubKey);
881 trigger = ( (pr->prev != NULL) ||
882 (pr->next != NULL) ||
883 (h->ready_peer_head == pr) );
884 disconnect_and_free_peer_entry (h, &dnm->peer.hashPubKey, pr);
886 trigger_next_request (h, GNUNET_NO);
888 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_STATUS_CHANGE:
889 if (NULL == h->status_events)
894 if (msize != sizeof (struct PeerStatusNotifyMessage))
899 psnm = (const struct PeerStatusNotifyMessage *) msg;
901 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
902 "Received notification about status change by `%s'.\n",
903 GNUNET_i2s (&psnm->peer));
905 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
906 &psnm->peer.hashPubKey);
913 h->status_events (h->cls,
917 GNUNET_TIME_absolute_ntoh (psnm->timeout),
918 NULL /* FIXME: atsi */);
920 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
922 sizeof (struct NotifyTrafficMessage) +
923 sizeof (struct GNUNET_MessageHeader))
928 ntm = (const struct NotifyTrafficMessage *) msg;
929 em = (const struct GNUNET_MessageHeader *) &ntm[1];
931 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
932 "Received message of type %u and size %u from peer `%4s'\n",
935 GNUNET_i2s (&ntm->peer));
937 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
938 &ntm->peer.hashPubKey);
945 if ((GNUNET_NO == h->inbound_hdr_only) &&
946 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
951 et = ntohs (em->type);
952 for (hpos = 0; hpos < h->hcnt; hpos++)
954 mh = &h->handlers[hpos];
957 if ((mh->expected_size != ntohs (em->size)) &&
958 (mh->expected_size != 0))
964 h->handlers[hpos].callback (h->cls, &ntm->peer, em,
965 NULL /* FIXME: atsi */))
967 /* error in processing, do not process other messages! */
971 if (NULL != h->inbound_notify)
972 h->inbound_notify (h->cls, &ntm->peer, em,
973 NULL /* FIXME: atsi */);
975 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
977 sizeof (struct NotifyTrafficMessage) +
978 sizeof (struct GNUNET_MessageHeader))
983 ntm = (const struct NotifyTrafficMessage *) msg;
984 em = (const struct GNUNET_MessageHeader *) &ntm[1];
985 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
986 &ntm->peer.hashPubKey);
994 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
995 "Received notification about transmission to `%s'.\n",
996 GNUNET_i2s (&ntm->peer));
998 if ((GNUNET_NO == h->outbound_hdr_only) &&
999 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
1004 if (NULL == h->outbound_notify)
1009 h->outbound_notify (h->cls, &ntm->peer, em,
1010 NULL /* FIXME: atsi? */);
1012 case GNUNET_MESSAGE_TYPE_CORE_SEND_READY:
1013 if (msize != sizeof (struct SendMessageReady))
1018 smr = (const struct SendMessageReady *) msg;
1019 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1020 &smr->peer.hashPubKey);
1028 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1029 "Received notification about transmission readiness to `%s'.\n",
1030 GNUNET_i2s (&smr->peer));
1032 th = pr->pending_head;
1033 if (ntohs (smr->smr_id) != th->smr_id)
1035 /* READY message is for expired or cancelled message,
1036 ignore! (we should have already sent another request) */
1039 if ( (pr->prev != NULL) ||
1040 (pr->next != NULL) ||
1041 (h->ready_peer_head == pr) )
1043 /* we should not already be on the ready list... */
1048 GNUNET_CONTAINER_DLL_insert (h->ready_peer_head,
1051 trigger_next_request (h, GNUNET_NO);
1053 case GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO:
1054 if (ntohs (msg->size) != sizeof (struct ConfigurationInfoMessage))
1059 cim = (const struct ConfigurationInfoMessage*) msg;
1061 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1062 "Received notification about configuration update for `%s'.\n",
1063 GNUNET_i2s (&cim->peer));
1065 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1066 &cim->peer.hashPubKey);
1073 if (pr->rim_id != ntohl (cim->rim_id))
1081 ntohl (cim->reserved_amount),
1082 GNUNET_ntohll (cim->preference));
1088 GNUNET_CLIENT_receive (h->client,
1089 &main_notify_handler, h,
1090 GNUNET_TIME_UNIT_FOREVER_REL);
1095 * Task executed once we are done transmitting the INIT message.
1096 * Starts our 'receive' loop.
1098 * @param cls the 'struct GNUNET_CORE_Handle'
1099 * @param tc task context
1102 init_done_task (void *cls,
1103 const struct GNUNET_SCHEDULER_TaskContext *tc)
1105 struct GNUNET_CORE_Handle *h = cls;
1107 if (0 == (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE))
1110 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1111 "Failed to exchange INIT with core, retrying\n");
1113 reconnect_later (h);
1116 GNUNET_CLIENT_receive (h->client,
1117 &main_notify_handler,
1119 GNUNET_TIME_UNIT_FOREVER_REL);
1124 * Our current client connection went down. Clean it up
1125 * and try to reconnect!
1127 * @param h our handle to the core service
1130 reconnect (struct GNUNET_CORE_Handle *h)
1132 struct ControlMessage *cm;
1133 struct InitMessage *init;
1140 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1141 "Reconnecting to CORE service\n");
1143 if (h->client != NULL)
1145 GNUNET_CLIENT_disconnect (h->client, GNUNET_NO);
1147 GNUNET_CONTAINER_multihashmap_iterate (h->peers,
1148 &disconnect_and_free_peer_entry,
1151 h->currently_down = GNUNET_YES;
1152 h->client = GNUNET_CLIENT_connect ("core", h->cfg);
1153 if (h->client == NULL)
1155 reconnect_later (h);
1158 msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
1159 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1161 cm->cont = &init_done_task;
1163 init = (struct InitMessage*) &cm[1];
1164 init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
1165 init->header.size = htons (msize);
1166 opt = GNUNET_CORE_OPTION_SEND_CONNECT | GNUNET_CORE_OPTION_SEND_DISCONNECT;
1167 if (h->status_events != NULL)
1168 opt |= GNUNET_CORE_OPTION_SEND_STATUS_CHANGE;
1169 if (h->inbound_notify != NULL)
1171 if (h->inbound_hdr_only)
1172 opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
1174 opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
1176 if (h->outbound_notify != NULL)
1178 if (h->outbound_hdr_only)
1179 opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
1181 opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
1183 init->options = htonl (opt);
1184 ts = (uint16_t *) &init[1];
1185 for (hpos = 0; hpos < h->hcnt; hpos++)
1186 ts[hpos] = htons (h->handlers[hpos].type);
1187 GNUNET_CONTAINER_DLL_insert (h->pending_head,
1190 trigger_next_request (h, GNUNET_YES);
1196 * Connect to the core service. Note that the connection may
1197 * complete (or fail) asynchronously.
1199 * @param cfg configuration to use
1200 * @param queue_size size of the per-peer message queue
1201 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
1202 * @param init callback to call on timeout or once we have successfully
1203 * connected to the core service; note that timeout is only meaningful if init is not NULL
1204 * @param connects function to call on peer connect, can be NULL
1205 * @param disconnects function to call on peer disconnect / timeout, can be NULL
1206 * @param status_events function to call on changes to peer connection status, can be NULL
1207 * @param inbound_notify function to call for all inbound messages, can be NULL
1208 * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
1209 * GNUNET_MessageHeader and hence we do not need to give it the full message;
1210 * can be used to improve efficiency, ignored if inbound_notify is NULLL
1211 * @param outbound_notify function to call for all outbound messages, can be NULL
1212 * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
1213 * GNUNET_MessageHeader and hence we do not need to give it the full message
1214 * can be used to improve efficiency, ignored if outbound_notify is NULLL
1215 * @param handlers callbacks for messages we care about, NULL-terminated
1216 * @return handle to the core service (only useful for disconnect until 'init' is called);
1217 * NULL on error (in this case, init is never called)
1219 struct GNUNET_CORE_Handle *
1220 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
1221 unsigned int queue_size,
1223 GNUNET_CORE_StartupCallback init,
1224 GNUNET_CORE_ConnectEventHandler connects,
1225 GNUNET_CORE_DisconnectEventHandler disconnects,
1226 GNUNET_CORE_PeerStatusEventHandler status_events,
1227 GNUNET_CORE_MessageCallback inbound_notify,
1228 int inbound_hdr_only,
1229 GNUNET_CORE_MessageCallback outbound_notify,
1230 int outbound_hdr_only,
1231 const struct GNUNET_CORE_MessageHandler *handlers)
1233 struct GNUNET_CORE_Handle *h;
1235 h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
1237 h->queue_size = queue_size;
1240 h->connects = connects;
1241 h->disconnects = disconnects;
1242 h->status_events = status_events;
1243 h->inbound_notify = inbound_notify;
1244 h->outbound_notify = outbound_notify;
1245 h->inbound_hdr_only = inbound_hdr_only;
1246 h->outbound_hdr_only = outbound_hdr_only;
1247 h->handlers = handlers;
1249 h->peers = GNUNET_CONTAINER_multihashmap_create (128);
1250 h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
1251 while (handlers[h->hcnt].callback != NULL)
1253 GNUNET_assert (h->hcnt <
1254 (GNUNET_SERVER_MAX_MESSAGE_SIZE -
1255 sizeof (struct InitMessage)) / sizeof (uint16_t));
1257 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1258 "Connecting to CORE service\n");
1266 * Disconnect from the core service. This function can only
1267 * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready'
1268 * requests have been explicitly cancelled.
1270 * @param handle connection to core to disconnect
1273 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
1275 struct ControlMessage *cm;
1278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1279 "Disconnecting from CORE service\n");
1281 if (handle->cth != NULL)
1283 GNUNET_CLIENT_notify_transmit_ready_cancel (handle->cth);
1286 if (handle->client != NULL)
1288 GNUNET_CLIENT_disconnect (handle->client, GNUNET_NO);
1289 handle->client = NULL;
1291 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
1293 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
1294 handle->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
1296 while (NULL != (cm = handle->pending_head))
1298 GNUNET_CONTAINER_DLL_remove (handle->pending_head,
1299 handle->pending_tail,
1303 GNUNET_CONTAINER_multihashmap_iterate (handle->peers,
1304 &disconnect_and_free_peer_entry,
1306 GNUNET_CONTAINER_multihashmap_destroy (handle->peers);
1307 GNUNET_break (handle->ready_peer_head == NULL);
1308 GNUNET_free (handle);
1313 * Ask the core to call "notify" once it is ready to transmit the
1314 * given number of bytes to the specified "target". If we are not yet
1315 * connected to the specified peer, a call to this function will cause
1316 * us to try to establish a connection.
1318 * @param handle connection to core service
1319 * @param priority how important is the message?
1320 * @param maxdelay how long can the message wait?
1321 * @param target who should receive the message,
1322 * use NULL for this peer (loopback)
1323 * @param notify_size how many bytes of buffer space does notify want?
1324 * @param notify function to call when buffer space is available
1325 * @param notify_cls closure for notify
1326 * @return non-NULL if the notify callback was queued,
1327 * NULL if we can not even queue the request (insufficient
1328 * memory); if NULL is returned, "notify" will NOT be called.
1330 struct GNUNET_CORE_TransmitHandle *
1331 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
1333 struct GNUNET_TIME_Relative maxdelay,
1334 const struct GNUNET_PeerIdentity *target,
1336 GNUNET_CONNECTION_TransmitReadyNotify notify,
1339 struct PeerRecord *pr;
1340 struct GNUNET_CORE_TransmitHandle *th;
1341 struct GNUNET_CORE_TransmitHandle *pos;
1342 struct GNUNET_CORE_TransmitHandle *prev;
1343 struct GNUNET_CORE_TransmitHandle *minp;
1345 pr = GNUNET_CONTAINER_multihashmap_get (handle->peers,
1346 &target->hashPubKey);
1349 /* attempt to send to peer that is not connected */
1353 GNUNET_assert (notify_size + sizeof (struct SendMessage) <
1354 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1355 th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
1357 th->get_message = notify;
1358 th->get_message_cls = notify_cls;
1359 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1360 th->priority = priority;
1361 th->msize = notify_size;
1362 /* bound queue size */
1363 if (pr->queue_size == handle->queue_size)
1365 /* find lowest-priority entry */
1366 minp = pr->pending_head;
1368 while (prev != NULL)
1370 if (prev->priority < minp->priority)
1376 GNUNET_break (handle->queue_size != 0);
1377 GNUNET_break (pr->queue_size == 0);
1380 if (priority <= minp->priority)
1381 return NULL; /* priority too low */
1382 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1387 minp->get_message (minp->get_message_cls,
1392 /* Order entries by deadline, but SKIP 'HEAD' if
1393 we're in the 'ready_peer_*' DLL */
1394 pos = pr->pending_head;
1395 if ( (pr->prev != NULL) ||
1396 (pr->next != NULL) ||
1397 (pr == handle->ready_peer_head) )
1399 GNUNET_assert (pos != NULL);
1400 pos = pos->next; /* skip head */
1403 /* insertion sort */
1405 while ( (pos != NULL) &&
1406 (pos->timeout.abs_value < th->timeout.abs_value) )
1411 GNUNET_CONTAINER_DLL_insert_after (pr->pending_head,
1416 /* was the request queue previously empty? */
1417 if (pr->pending_head == th)
1418 request_next_transmission (pr);
1424 * Cancel the specified transmission-ready notification.
1426 * @param th handle that was returned by "notify_transmit_ready".
1429 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
1432 struct PeerRecord *pr = th->peer;
1433 struct GNUNET_CORE_Handle *h = pr->ch;
1436 was_head = (pr->pending_head == th);
1437 GNUNET_CONTAINER_DLL_remove (pr->pending_head,
1442 /* we're currently in the control queue, remove */
1443 GNUNET_CONTAINER_DLL_remove (h->pending_head,
1446 GNUNET_free (th->cm);
1451 if ( (pr->prev != NULL) ||
1452 (pr->next != NULL) ||
1453 (pr == h->ready_peer_head) )
1455 /* the request that was 'approved' by core was
1456 cancelled before it could be transmitted; remove
1457 us from the 'ready' list */
1458 GNUNET_CONTAINER_DLL_remove (h->ready_peer_head,
1462 request_next_transmission (pr);
1467 /* ****************** GNUNET_CORE_peer_request_connect ******************** */
1470 * Handle for a request to the core to connect to
1471 * a particular peer. Can be used to cancel the request
1472 * (before the 'cont'inuation is called).
1474 struct GNUNET_CORE_PeerRequestHandle
1478 * Link to control message.
1480 struct ControlMessage *cm;
1485 struct GNUNET_CORE_Handle *h;
1488 * Continuation to run when done.
1490 GNUNET_SCHEDULER_Task cont;
1493 * Closure for 'cont'.
1502 * Continuation called when the control message was transmitted.
1503 * Calls the original continuation and frees the remaining
1506 * @param cls the 'struct GNUNET_CORE_PeerRequestHandle'
1507 * @param tc scheduler context
1510 peer_request_connect_cont (void *cls,
1511 const struct GNUNET_SCHEDULER_TaskContext *tc)
1513 struct GNUNET_CORE_PeerRequestHandle *ret = cls;
1515 if (ret->cont != NULL)
1516 ret->cont (ret->cont_cls, tc);
1522 * Request that the core should try to connect to a particular peer.
1523 * Once the request has been transmitted to the core, the continuation
1524 * function will be called. Note that this does NOT mean that a
1525 * connection was successfully established -- it only means that the
1526 * core will now try. Successful establishment of the connection
1527 * will be signalled to the 'connects' callback argument of
1528 * 'GNUNET_CORE_connect' only. If the core service does not respond
1529 * to our connection attempt within the given time frame, 'cont' will
1530 * be called with the TIMEOUT reason code.
1532 * @param h core handle
1533 * @param timeout how long to try to talk to core
1534 * @param peer who should we connect to
1535 * @param cont function to call once the request has been completed (or timed out)
1536 * @param cont_cls closure for cont
1537 * @return NULL on error (cont will not be called), otherwise handle for cancellation
1539 struct GNUNET_CORE_PeerRequestHandle *
1540 GNUNET_CORE_peer_request_connect (struct GNUNET_CORE_Handle *h,
1541 struct GNUNET_TIME_Relative timeout,
1542 const struct GNUNET_PeerIdentity * peer,
1543 GNUNET_SCHEDULER_Task cont,
1546 struct GNUNET_CORE_PeerRequestHandle *ret;
1547 struct ControlMessage *cm;
1548 struct ConnectMessage *msg;
1550 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1551 sizeof (struct ConnectMessage));
1552 msg = (struct ConnectMessage*) &cm[1];
1553 msg->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONNECT);
1554 msg->header.size = htons (sizeof (struct ConnectMessage));
1555 msg->reserved = htonl (0);
1556 msg->timeout = GNUNET_TIME_relative_hton (timeout);
1558 GNUNET_CONTAINER_DLL_insert (h->pending_head,
1561 ret = GNUNET_malloc (sizeof (struct GNUNET_CORE_PeerRequestHandle));
1565 ret->cont_cls = cont_cls;
1566 cm->cont = &peer_request_connect_cont;
1568 if (h->pending_head == cm)
1569 trigger_next_request (h, GNUNET_NO);
1575 * Cancel a pending request to connect to a particular peer. Must not
1576 * be called after the 'cont' function was invoked.
1578 * @param req request handle that was returned for the original request
1581 GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *req)
1583 struct GNUNET_CORE_Handle *h = req->h;
1584 struct ControlMessage *cm = req->cm;
1586 GNUNET_CONTAINER_DLL_remove (h->pending_head,
1594 /* ****************** GNUNET_CORE_peer_change_preference ******************** */
1597 struct GNUNET_CORE_InformationRequestContext
1601 * Our connection to the service.
1603 struct GNUNET_CORE_Handle *h;
1606 * Function to call with the information.
1608 GNUNET_CORE_PeerConfigurationInfoCallback info;
1616 * Link to control message, NULL if CM was sent.
1618 struct ControlMessage *cm;
1621 * Link to peer record.
1623 struct PeerRecord *pr;
1628 * CM was sent, remove link so we don't double-free.
1630 * @param cls the 'struct GNUNET_CORE_InformationRequestContext'
1631 * @param tc scheduler context
1634 change_preference_send_continuation (void *cls,
1635 const struct GNUNET_SCHEDULER_TaskContext *tc)
1637 struct GNUNET_CORE_InformationRequestContext *irc = cls;
1644 * Obtain statistics and/or change preferences for the given peer.
1646 * @param h core handle
1647 * @param peer identifies the peer
1648 * @param timeout after how long should we give up (and call "info" with NULL
1649 * for "peer" to signal an error)?
1650 * @param bw_out set to the current bandwidth limit (sending) for this peer,
1651 * caller should set "bw_out" to "-1" to avoid changing
1652 * the current value; otherwise "bw_out" will be lowered to
1653 * the specified value; passing a pointer to "0" can be used to force
1654 * us to disconnect from the peer; "bw_out" might not increase
1655 * as specified since the upper bound is generally
1656 * determined by the other peer!
1657 * @param amount reserve N bytes for receiving, negative
1658 * amounts can be used to undo a (recent) reservation;
1659 * @param preference increase incoming traffic share preference by this amount;
1660 * in the absence of "amount" reservations, we use this
1661 * preference value to assign proportional bandwidth shares
1662 * to all connected peers
1663 * @param info function to call with the resulting configuration information
1664 * @param info_cls closure for info
1665 * @return NULL on error
1667 struct GNUNET_CORE_InformationRequestContext *
1668 GNUNET_CORE_peer_change_preference (struct GNUNET_CORE_Handle *h,
1669 const struct GNUNET_PeerIdentity *peer,
1670 struct GNUNET_TIME_Relative timeout,
1671 struct GNUNET_BANDWIDTH_Value32NBO bw_out,
1673 uint64_t preference,
1674 GNUNET_CORE_PeerConfigurationInfoCallback info,
1677 struct GNUNET_CORE_InformationRequestContext *irc;
1678 struct PeerRecord *pr;
1679 struct RequestInfoMessage *rim;
1680 struct ControlMessage *cm;
1682 pr = GNUNET_CONTAINER_multihashmap_get (h->peers,
1686 /* attempt to change preference on peer that is not connected */
1690 if (pr->pcic != NULL)
1692 /* second change before first one is done */
1696 irc = GNUNET_malloc (sizeof (struct GNUNET_CORE_InformationRequestContext));
1699 irc->info_cls = info_cls;
1700 cm = GNUNET_malloc (sizeof (struct ControlMessage) +
1701 sizeof (struct RequestInfoMessage));
1702 cm->cont = &change_preference_send_continuation;
1705 rim = (struct RequestInfoMessage*) &cm[1];
1706 rim->header.size = htons (sizeof (struct RequestInfoMessage));
1707 rim->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_INFO);
1708 rim->rim_id = htonl (pr->rim_id = h->rim_id_gen++);
1709 rim->limit_outbound = bw_out;
1710 rim->reserve_inbound = htonl (amount);
1711 rim->preference_change = GNUNET_htonll(preference);
1713 GNUNET_CONTAINER_DLL_insert (h->pending_head,
1717 pr->pcic_cls = info_cls;
1723 * Cancel request for getting information about a peer.
1724 * Note that an eventual change in preference, trust or bandwidth
1725 * assignment MAY have already been committed at the time,
1726 * so cancelling a request is NOT sure to undo the original
1727 * request. The original request may or may not still commit.
1728 * The only thing cancellation ensures is that the callback
1729 * from the original request will no longer be called.
1731 * @param irc context returned by the original GNUNET_CORE_peer_get_info call
1734 GNUNET_CORE_peer_change_preference_cancel (struct GNUNET_CORE_InformationRequestContext *irc)
1736 struct GNUNET_CORE_Handle *h = irc->h;
1737 struct PeerRecord *pr = irc->pr;
1739 if (irc->cm != NULL)
1741 GNUNET_CONTAINER_DLL_remove (h->pending_head,
1744 GNUNET_free (irc->cm);
1747 pr->pcic_cls = NULL;
1752 /* ********************* GNUNET_CORE_iterate_peers *********************** */
1755 * Context for 'iterate_peers' helper function.
1757 struct IterationContext
1762 GNUNET_CORE_ConnectEventHandler peer_cb;
1765 * Closure for 'peer_cb'.
1772 * Call callback for each peer.
1774 * @param cls the 'struct IterationContext'
1775 * @param hc peer identity, not used
1776 * @param value the 'struct PeerRecord'
1777 * @return GNUNET_YES (continue iteration)
1780 iterate_peers (void *cls,
1781 const GNUNET_HashCode *hc,
1784 struct IterationContext *ic = cls;
1785 struct PeerRecord *pr = value;
1787 ic->peer_cb (ic->cb_cls,
1789 NULL /* FIXME: pass atsi? */);
1795 * Obtain statistics and/or change preferences for the given peer.
1797 * @param h handle to core
1798 * @param peer_cb function to call with the peer information
1799 * @param cb_cls closure for peer_cb
1800 * @return GNUNET_OK if iterating, GNUNET_SYSERR on error
1803 GNUNET_CORE_iterate_peers (struct GNUNET_CORE_Handle *h,
1804 GNUNET_CORE_ConnectEventHandler peer_cb,
1807 struct IterationContext ic;
1809 ic.peer_cb = peer_cb;
1811 GNUNET_CONTAINER_multihashmap_iterate (h->peers,
1818 /* end of core_api.c */