2 This file is part of GNUnet.
3 (C) 2009 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 2, 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_core_service.h"
33 * Context for the core service connection.
35 struct GNUNET_CORE_Handle
41 struct GNUNET_SCHEDULER_Handle *sched;
44 * Configuration we're using.
46 struct GNUNET_CONFIGURATION_Handle *cfg;
49 * Closure for the various callbacks.
54 * Function to call once we've handshaked with the core service.
56 GNUNET_CORE_StartupCallback init;
59 * Function to call whenever we're notified about a peer connecting.
61 GNUNET_CORE_ClientEventHandler connects;
64 * Function to call whenever we're notified about a peer disconnecting.
66 GNUNET_CORE_ClientEventHandler disconnects;
69 * Function to call whenever we're asked to generate traffic
70 * (data provided to be transmitted back to the service).
72 GNUNET_CORE_BufferFillCallback bfc;
75 * Function to call whenever we receive an inbound message.
77 GNUNET_CORE_MessageCallback inbound_notify;
80 * Function to call whenever we receive an outbound message.
82 GNUNET_CORE_MessageCallback outbound_notify;
85 * Function handlers for messages of particular type.
87 const struct GNUNET_CORE_MessageHandler *handlers;
90 * Our connection to the service.
92 struct GNUNET_CLIENT_Connection *client;
95 * Handle for our current transmission request.
97 struct GNUNET_NETWORK_TransmitHandle *th;
100 * Head of doubly-linked list of pending requests.
102 struct GNUNET_CORE_TransmitHandle *pending_head;
105 * Tail of doubly-linked list of pending requests.
107 struct GNUNET_CORE_TransmitHandle *pending_tail;
110 * Currently submitted request (or NULL)
112 struct GNUNET_CORE_TransmitHandle *submitted;
115 * How long to wait until we time out the connection attempt?
117 struct GNUNET_TIME_Absolute startup_timeout;
120 * ID of reconnect task (if any).
122 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
125 * Number of entries in the handlers array.
130 * For inbound notifications without a specific handler, do
131 * we expect to only receive headers?
133 int inbound_hdr_only;
136 * For outbound notifications without a specific handler, do
137 * we expect to only receive headers?
139 int outbound_hdr_only;
142 * Are we currently disconnected and hence unable to forward
150 * Handle for a transmission request.
152 struct GNUNET_CORE_TransmitHandle
156 * We keep active transmit handles in a doubly-linked list.
158 struct GNUNET_CORE_TransmitHandle *next;
161 * We keep active transmit handles in a doubly-linked list.
163 struct GNUNET_CORE_TransmitHandle *prev;
166 * Corresponding core handle.
168 struct GNUNET_CORE_Handle *ch;
171 * Function that will be called to get the actual request
172 * (once we are ready to transmit this request to the core).
173 * The function will be called with a NULL buffer to signal
176 GNUNET_NETWORK_TransmitReadyNotify get_message;
179 * Closure for get_message.
181 void *get_message_cls;
184 * If this entry is for a configuration request, pointer
185 * to the information callback; otherwise NULL.
187 GNUNET_CORE_PeerConfigurationInfoCallback info;
195 * If this entry is for a transmission request, pointer
196 * to the notify callback; otherwise NULL.
198 GNUNET_NETWORK_TransmitReadyNotify notify;
201 * Closure for notify.
206 * Peer the request is about.
208 struct GNUNET_PeerIdentity peer;
211 * Timeout for this handle.
213 struct GNUNET_TIME_Absolute timeout;
216 * ID of timeout task.
218 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
221 * How important is this message?
226 * Size of this request.
235 * Function called when we are ready to transmit our
236 * "START" message (or when this operation timed out).
239 * @param size number of bytes available in buf
240 * @param buf where the callee should write the message
241 * @return number of bytes written to buf
243 static size_t transmit_start (void *cls, size_t size, void *buf);
247 * Our current client connection went down. Clean it up
248 * and try to reconnect!
251 reconnect (struct GNUNET_CORE_Handle *h)
253 GNUNET_CLIENT_disconnect (h->client);
254 h->currently_down = GNUNET_YES;
255 h->client = GNUNET_CLIENT_connect (h->sched, "core", h->cfg);
256 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
257 sizeof (struct InitMessage) +
258 sizeof (uint16_t) * h->hcnt,
259 GNUNET_TIME_UNIT_SECONDS,
265 * The given request hit its timeout. Remove from the
266 * doubly-linked list and call the respective continuation.
268 * @param cls the transmit handle of the request that timed out
269 * @param tc context, can be NULL (!)
272 timeout_request (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
274 struct GNUNET_CORE_TransmitHandle *th = cls;
275 struct GNUNET_CORE_Handle *h;
277 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
278 "Transmission request timed out.\n");
280 th->timeout_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
281 GNUNET_assert (0 == th->get_message (th->get_message_cls, 0, NULL));
282 GNUNET_CORE_notify_transmit_ready_cancel (th);
287 * Function called when we are ready to transmit a request from our
288 * request list (or when this operation timed out).
291 * @param size number of bytes available in buf
292 * @param buf where the callee should write the message
293 * @return number of bytes written to buf
296 request_start (void *cls, size_t size, void *buf)
298 struct GNUNET_CORE_Handle *h = cls;
299 struct GNUNET_CORE_TransmitHandle *th;
303 th = h->pending_head;
306 timeout_request (th, NULL);
309 /* create new timeout task (in case core takes too long to respond!) */
310 th->timeout_task = GNUNET_SCHEDULER_add_delayed (h->sched,
312 GNUNET_SCHEDULER_PRIORITY_KEEP,
313 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
314 GNUNET_TIME_absolute_get_remaining
316 &timeout_request, th);
317 /* remove th from doubly-linked pending list, move to submitted */
318 GNUNET_assert (th->prev == NULL);
319 h->pending_head = th->next;
320 if (th->next == NULL)
321 h->pending_tail = NULL;
323 th->next->prev = NULL;
324 GNUNET_assert (h->submitted == NULL);
326 GNUNET_assert (size >= th->msize);
327 ret = th->get_message (th->get_message_cls, size, buf);
328 GNUNET_assert (ret <= size);
334 * Check the list of pending requests, send the next
338 trigger_next_request (struct GNUNET_CORE_Handle *h)
340 struct GNUNET_CORE_TransmitHandle *th;
341 if (h->currently_down)
342 return; /* connection temporarily down */
343 if (NULL == (th = h->pending_head))
344 return; /* no requests pending */
345 GNUNET_assert (NULL == h->th);
346 GNUNET_SCHEDULER_cancel (h->sched, th->timeout_task);
347 th->timeout_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
348 h->th = GNUNET_CLIENT_notify_transmit_ready (h->client,
350 GNUNET_TIME_absolute_get_remaining
351 (th->timeout), &request_start,
357 * cls is a pointer to a 32 bit number followed by that
358 * amount of data. If possible, copy to buf and return
359 * number of bytes copied. Always free the buffer.
362 copy_and_free (void *cls, size_t size, void *buf)
367 memcpy (&have, cbuf, sizeof (uint32_t));
370 /* timeout / error case */
374 memcpy (buf, cbuf + sizeof (uint32_t), have);
381 * Call bfc callback to solicit traffic for the given peer.
384 solicit_traffic (struct GNUNET_CORE_Handle *h,
385 const struct GNUNET_PeerIdentity *peer, uint32_t amount)
391 have = h->bfc (h->cls, peer, buf, amount);
394 GNUNET_assert (have >= sizeof (struct GNUNET_MessageHeader));
395 cbuf = GNUNET_malloc (have + sizeof (uint32_t));
396 memcpy (cbuf, &have, sizeof (uint32_t));
397 memcpy (cbuf + sizeof (uint32_t), buf, have);
398 GNUNET_CORE_notify_transmit_ready (h,
400 GNUNET_TIME_UNIT_SECONDS,
401 peer, have, ©_and_free, cbuf);
406 * Handler for most messages received from the core.
409 main_handler (void *cls, const struct GNUNET_MessageHeader *msg)
411 struct GNUNET_CORE_Handle *h = cls;
413 const struct ConnectNotifyMessage *cnm;
414 const struct NotifyTrafficMessage *ntm;
415 const struct ConfigurationInfoMessage *cim;
416 const struct SolicitTrafficMessage *stm;
417 const struct GNUNET_MessageHeader *em;
421 const struct GNUNET_CORE_MessageHandler *mh;
425 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
427 ("Client was disconnected from core service, trying to reconnect.\n"));
431 msize = ntohs (msg->size);
433 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
434 "Processing message of type %u and size %u from core service\n",
435 ntohs (msg->type), msize);
437 switch (ntohs (msg->type))
439 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT:
440 if (NULL == h->connects)
445 if (msize != sizeof (struct ConnectNotifyMessage))
450 cnm = (const struct ConnectNotifyMessage *) msg;
454 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT:
455 if (NULL == h->disconnects)
460 if (msize != sizeof (struct ConnectNotifyMessage))
465 cnm = (const struct ConnectNotifyMessage *) msg;
466 h->disconnects (h->cls,
469 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND:
471 sizeof (struct NotifyTrafficMessage) +
472 sizeof (struct GNUNET_MessageHeader))
477 ntm = (const struct NotifyTrafficMessage *) msg;
478 em = (const struct GNUNET_MessageHeader *) &ntm[1];
480 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
481 "Received message of type %u from peer `%4s'\n",
482 ntohs (em->type), GNUNET_i2s (&ntm->peer));
484 if ((GNUNET_NO == h->inbound_hdr_only) &&
485 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
490 et = ntohs (em->type);
491 for (hpos = 0; hpos < h->hcnt; hpos++)
493 mh = &h->handlers[hpos];
496 if ((mh->expected_size != ntohs (em->size)) &&
497 (mh->expected_size != 0))
503 h->handlers[hpos].callback (h->cls, &ntm->peer, em))
505 /* error in processing, disconnect ! */
510 if (NULL != h->inbound_notify)
511 h->inbound_notify (h->cls, &ntm->peer, em);
513 case GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND:
515 sizeof (struct NotifyTrafficMessage) +
516 sizeof (struct GNUNET_MessageHeader))
521 ntm = (const struct NotifyTrafficMessage *) msg;
522 em = (const struct GNUNET_MessageHeader *) &ntm[1];
523 if ((GNUNET_NO == h->outbound_hdr_only) &&
524 (msize != ntohs (em->size) + sizeof (struct NotifyTrafficMessage)))
529 if (NULL == h->outbound_notify)
534 h->outbound_notify (h->cls, &ntm->peer, em);
536 case GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO:
537 if (msize != sizeof (struct ConfigurationInfoMessage))
542 if (NULL == h->submitted)
544 cim = (const struct ConfigurationInfoMessage *) msg;
546 /* process configuration data */
547 if (h->submitted->info != NULL)
548 h->submitted->info (h->submitted->info_cls,
551 ntohl (cim->bpm_out),
552 GNUNET_TIME_relative_ntoh (cim->latency),
553 (int) ntohl (cim->reserved_amount),
555 /* done, clean up! */
556 GNUNET_CORE_notify_transmit_ready_cancel (h->submitted);
557 trigger_next_request (h);
559 case GNUNET_MESSAGE_TYPE_CORE_SOLICIT_TRAFFIC:
560 if (msize != sizeof (struct SolicitTrafficMessage))
565 stm = (const struct SolicitTrafficMessage *) msg;
571 ss = ntohl (stm->solicit_size);
572 if ((ss > GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
573 (ss + sizeof (struct SendMessage) > GNUNET_SERVER_MAX_MESSAGE_SIZE))
578 solicit_traffic (h, &stm->peer, ss);
584 GNUNET_CLIENT_receive (h->client,
585 &main_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
591 * Function called when we are ready to transmit our
592 * "START" message (or when this operation timed out).
595 * @param size number of bytes available in buf
596 * @param buf where the callee should write the message
597 * @return number of bytes written to buf
599 static size_t transmit_start (void *cls, size_t size, void *buf);
603 * Function called on the first message received from
604 * the service (contains our public key, etc.).
605 * Should trigger calling the init callback
606 * and then start our regular message processing.
609 * @param msg message received, NULL on timeout or fatal error
612 init_reply_handler (void *cls, const struct GNUNET_MessageHeader *msg)
614 struct GNUNET_CORE_Handle *h = cls;
615 const struct InitReplyMessage *m;
616 GNUNET_CORE_StartupCallback init;
617 struct GNUNET_PeerIdentity my_identity;
620 (ntohs (msg->size) != sizeof (struct InitReplyMessage)) ||
621 (ntohs (msg->type) != GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY))
623 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
625 ("Error connecting to core service (failed to receive `%s' message).\n"),
627 GNUNET_break (msg == NULL);
628 transmit_start (h, 0, NULL);
631 m = (const struct InitReplyMessage *) msg;
632 /* start our message processing loop */
634 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
636 ("Successfully connected to core service, starting processing loop.\n"));
638 h->currently_down = GNUNET_NO;
639 trigger_next_request (h);
640 GNUNET_CLIENT_receive (h->client,
641 &main_handler, h, GNUNET_TIME_UNIT_FOREVER_REL);
642 if (NULL != (init = h->init))
644 /* mark so we don't call init on reconnect */
647 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
648 _("Successfully connected to core service.\n"));
650 GNUNET_CRYPTO_hash (&m->publicKey,
652 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
653 &my_identity.hashPubKey);
654 init (h->cls, h, &my_identity, &m->publicKey);
660 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
662 struct GNUNET_CORE_Handle *h = cls;
663 h->reconnect_task = GNUNET_SCHEDULER_NO_PREREQUISITE_TASK;
669 * Function called when we are ready to transmit our
670 * "START" message (or when this operation timed out).
673 * @param size number of bytes available in buf
674 * @param buf where the callee should write the message
675 * @return number of bytes written to buf
678 transmit_start (void *cls, size_t size, void *buf)
680 struct GNUNET_CORE_Handle *h = cls;
681 struct InitMessage *init;
686 struct GNUNET_TIME_Relative delay;
691 if ((h->init == NULL) ||
692 (GNUNET_TIME_absolute_get ().value < h->startup_timeout.value))
694 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
695 _("Failed to connect to core service, retrying.\n"));
696 delay = GNUNET_TIME_absolute_get_remaining (h->startup_timeout);
697 if ((h->init == NULL) || (delay.value > 1000))
698 delay = GNUNET_TIME_UNIT_SECONDS;
701 GNUNET_TIME_relative_to_absolute (GNUNET_TIME_UNIT_MINUTES);
703 GNUNET_SCHEDULER_add_delayed (h->sched, GNUNET_NO,
704 GNUNET_SCHEDULER_PRIORITY_IDLE,
705 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
706 delay, &reconnect_task, h);
709 /* timeout on initial connect */
710 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
711 _("Failed to connect to core service, giving up.\n"));
712 h->init (h->cls, NULL, NULL, NULL);
713 GNUNET_CORE_disconnect (h);
716 msize = h->hcnt * sizeof (uint16_t) + sizeof (struct InitMessage);
717 GNUNET_assert (size >= msize);
719 init->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_INIT);
720 init->header.size = htons (msize);
721 opt = GNUNET_CORE_OPTION_NOTHING;
722 if (h->connects != NULL)
723 opt |= GNUNET_CORE_OPTION_SEND_CONNECT;
724 if (h->disconnects != NULL)
725 opt |= GNUNET_CORE_OPTION_SEND_DISCONNECT;
727 opt |= GNUNET_CORE_OPTION_SEND_BFC;
728 if (h->inbound_notify != NULL)
730 if (h->inbound_hdr_only)
731 opt |= GNUNET_CORE_OPTION_SEND_HDR_INBOUND;
733 opt |= GNUNET_CORE_OPTION_SEND_FULL_INBOUND;
735 if (h->outbound_notify != NULL)
737 if (h->outbound_hdr_only)
738 opt |= GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND;
740 opt |= GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND;
742 init->options = htonl (opt);
743 ts = (uint16_t *) & init[1];
744 for (hpos = 0; hpos < h->hcnt; hpos++)
745 ts[hpos] = htons (h->handlers[hpos].type);
746 GNUNET_CLIENT_receive (h->client,
749 GNUNET_TIME_absolute_get_remaining
750 (h->startup_timeout));
751 return sizeof (struct InitMessage) + h->hcnt * sizeof (uint16_t);
756 * Connect to the core service. Note that the connection may
757 * complete (or fail) asynchronously.
759 * @param sched scheduler to use
760 * @param cfg configuration to use
761 * @param timeout after how long should we give up trying to connect to the core service?
762 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
763 * @param init callback to call on timeout or once we have successfully
764 * connected to the core service
765 * @param connects function to call on peer connect, can be NULL
766 * @param disconnects function to call on peer disconnect / timeout, can be NULL
767 * @param bfc function to call to fill up spare bandwidth, can be NULL
768 * @param inbound_notify function to call for all inbound messages, can be NULL
769 * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
770 * GNUNET_MessageHeader and hence we do not need to give it the full message;
771 * can be used to improve efficiency, ignored if inbound_notify is NULLL
772 * @param outbound_notify function to call for all outbound messages, can be NULL
773 * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
774 * GNUNET_MessageHeader and hence we do not need to give it the full message
775 * can be used to improve efficiency, ignored if outbound_notify is NULLL
776 * @param handlers callbacks for messages we care about, NULL-terminated
779 GNUNET_CORE_connect (struct GNUNET_SCHEDULER_Handle *sched,
780 struct GNUNET_CONFIGURATION_Handle *cfg,
781 struct GNUNET_TIME_Relative timeout,
783 GNUNET_CORE_StartupCallback init,
784 GNUNET_CORE_ClientEventHandler connects,
785 GNUNET_CORE_ClientEventHandler disconnects,
786 GNUNET_CORE_BufferFillCallback bfc,
787 GNUNET_CORE_MessageCallback inbound_notify,
788 int inbound_hdr_only,
789 GNUNET_CORE_MessageCallback outbound_notify,
790 int outbound_hdr_only,
791 const struct GNUNET_CORE_MessageHandler *handlers)
793 struct GNUNET_CORE_Handle *h;
795 GNUNET_assert (init != NULL);
796 h = GNUNET_malloc (sizeof (struct GNUNET_CORE_Handle));
801 h->connects = connects;
802 h->disconnects = disconnects;
804 h->inbound_notify = inbound_notify;
805 h->outbound_notify = outbound_notify;
806 h->inbound_hdr_only = inbound_hdr_only;
807 h->outbound_hdr_only = outbound_hdr_only;
808 h->handlers = handlers;
809 h->client = GNUNET_CLIENT_connect (sched, "core", cfg);
810 h->startup_timeout = GNUNET_TIME_relative_to_absolute (timeout);
812 while (handlers[h->hcnt].callback != NULL)
814 GNUNET_assert (h->hcnt <
815 (GNUNET_SERVER_MAX_MESSAGE_SIZE -
816 sizeof (struct InitMessage)) / sizeof (uint16_t));
818 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
819 "Trying to connect to core service in next %llu ms.\n",
823 GNUNET_CLIENT_notify_transmit_ready (h->client,
824 sizeof (struct InitMessage) +
825 sizeof (uint16_t) * h->hcnt, timeout,
831 * Disconnect from the core service.
833 * @param handle connection to core to disconnect
836 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle)
838 if (handle->th != NULL)
839 GNUNET_NETWORK_notify_transmit_ready_cancel (handle->th);
840 if (handle->reconnect_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
841 GNUNET_SCHEDULER_cancel (handle->sched, handle->reconnect_task);
842 GNUNET_CLIENT_disconnect (handle->client);
843 GNUNET_free (handle);
848 * Build the configure message.
851 produce_configure_message (void *cls, size_t size, void *buf)
853 struct GNUNET_CORE_TransmitHandle *th = cls;
854 struct GNUNET_CORE_Handle *ch = th->ch;
858 /* communicate handle timeout/error! */
859 if (th->info != NULL)
860 th->info (th->info_cls, NULL, 0, 0, GNUNET_TIME_UNIT_ZERO, 0, 0.0);
861 if (th->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
862 GNUNET_CORE_notify_transmit_ready_cancel (th);
863 if (ch->submitted == th)
864 ch->submitted = NULL;
865 trigger_next_request (ch);
868 GNUNET_assert (size >= sizeof (struct RequestConfigureMessage));
869 memcpy (buf, &th[1], sizeof (struct RequestConfigureMessage));
870 if (th->prev == NULL)
871 ch->pending_head = th->next;
873 th->prev->next = th->next;
874 if (th->next == NULL)
875 ch->pending_tail = th->prev;
877 th->next->prev = th->prev;
878 GNUNET_assert (ch->submitted == NULL);
880 return sizeof (struct RequestConfigureMessage);
885 * Obtain statistics and/or change preferences for the given peer.
887 * @param handle connection to core to use
888 * @param peer identifies the peer
889 * @param timeout after how long should we give up (and call "info" with NULL
890 * for "peer" to signal an error)?
891 * @param bpm_out set to the current bandwidth limit (sending) for this peer,
892 * caller should set "bpm_out" to "-1" to avoid changing
893 * the current value; otherwise "bpm_out" will be lowered to
894 * the specified value; passing a pointer to "0" can be used to force
895 * us to disconnect from the peer; "bpm_out" might not increase
896 * as specified since the upper bound is generally
897 * determined by the other peer!
898 * @param amount reserve N bytes for receiving, negative
899 * amounts can be used to undo a (recent) reservation;
900 * @param preference increase incoming traffic share preference by this amount;
901 * in the absence of "amount" reservations, we use this
902 * preference value to assign proportional bandwidth shares
903 * to all connected peers
904 * @param info function to call with the resulting configuration information
905 * @param info_cls closure for info
908 GNUNET_CORE_peer_configure (struct GNUNET_CORE_Handle *handle,
909 const struct GNUNET_PeerIdentity *peer,
910 struct GNUNET_TIME_Relative timeout,
911 unsigned int bpm_out,
913 unsigned long long preference,
914 GNUNET_CORE_PeerConfigurationInfoCallback info,
917 struct RequestConfigureMessage *rcm;
918 struct GNUNET_CORE_TransmitHandle *th;
920 th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle) +
921 sizeof (struct RequestConfigureMessage));
923 th->prev = handle->pending_tail;
924 if (handle->pending_tail == NULL)
925 handle->pending_head = th;
927 handle->pending_tail->next = th;
929 th->get_message = &produce_configure_message;
930 th->get_message_cls = th;
932 th->info_cls = info_cls;
933 th->timeout = GNUNET_TIME_relative_to_absolute (timeout);
934 th->timeout_task = GNUNET_SCHEDULER_add_delayed (handle->sched,
936 GNUNET_SCHEDULER_PRIORITY_KEEP,
937 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
939 &timeout_request, th);
940 th->msize = sizeof (struct RequestConfigureMessage);
941 rcm = (struct RequestConfigureMessage *) &th[1];
942 rcm->header.size = htons (sizeof (struct RequestConfigureMessage));
943 rcm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONFIGURE);
944 rcm->reserved = htonl (0);
945 rcm->limit_outbound_bpm = htonl (bpm_out);
946 rcm->reserve_inbound = htonl (amount);
947 rcm->preference_change = GNUNET_htonll(preference);
949 if (handle->pending_head == th)
950 trigger_next_request (handle);
955 * Build the message requesting data transmission.
958 produce_send (void *cls, size_t size, void *buf)
960 struct GNUNET_CORE_TransmitHandle *th = cls;
961 struct GNUNET_CORE_Handle *h;
962 struct SendMessage *sm;
964 GNUNET_NETWORK_TransmitReadyNotify notify;
970 /* timeout or error */
972 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
973 "P2P transmission request for `%4s' timed out.\n",
974 GNUNET_i2s(&th->peer));
976 GNUNET_assert (0 == th->notify (th->notify_cls, 0, NULL));
977 if (th->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
978 GNUNET_CORE_notify_transmit_ready_cancel (th);
979 trigger_next_request (h);
983 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
984 "Preparing for P2P transmission to `%4s'.\n",
985 GNUNET_i2s(&th->peer));
987 GNUNET_assert (th->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK);
988 sm = (struct SendMessage *) buf;
989 sm->header.type = htons (GNUNET_MESSAGE_TYPE_CORE_SEND);
990 sm->priority = htonl (th->priority);
991 sm->deadline = GNUNET_TIME_absolute_hton (th->timeout);
994 notify_cls = th->notify_cls;
995 GNUNET_CORE_notify_transmit_ready_cancel (th);
996 trigger_next_request (h);
997 GNUNET_assert (size >= sizeof (struct SendMessage));
998 dt = notify (notify_cls, size - sizeof (struct SendMessage), &sm[1]);
999 sm->header.size = htons (dt + sizeof (struct SendMessage));
1000 GNUNET_assert (dt + sizeof (struct SendMessage) < size);
1001 return dt + sizeof (struct SendMessage);
1006 * Ask the core to call "notify" once it is ready to transmit the
1007 * given number of bytes to the specified "target". If we are not yet
1008 * connected to the specified peer, a call to this function will cause
1009 * us to try to establish a connection.
1011 * @param handle connection to core service
1012 * @param priority how important is the message?
1013 * @param maxdelay how long can the message wait?
1014 * @param target who should receive the message,
1015 * use NULL for this peer (loopback)
1016 * @param notify_size how many bytes of buffer space does notify want?
1017 * @param notify function to call when buffer space is available
1018 * @param notify_cls closure for notify
1019 * @return non-NULL if the notify callback was queued,
1020 * NULL if we can not even queue the request (insufficient
1021 * memory); if NULL is returned, "notify" will NOT be called.
1023 struct GNUNET_CORE_TransmitHandle *
1024 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle,
1025 unsigned int priority,
1026 struct GNUNET_TIME_Relative maxdelay,
1027 const struct GNUNET_PeerIdentity *target,
1029 GNUNET_NETWORK_TransmitReadyNotify notify,
1032 struct GNUNET_CORE_TransmitHandle *th;
1034 GNUNET_assert (notify_size + sizeof (struct SendMessage) <
1035 GNUNET_SERVER_MAX_MESSAGE_SIZE);
1036 th = GNUNET_malloc (sizeof (struct GNUNET_CORE_TransmitHandle));
1038 /* append to list */
1039 th->prev = handle->pending_tail;
1040 if (handle->pending_tail == NULL)
1041 handle->pending_head = th;
1043 handle->pending_tail->next = th;
1044 th->get_message = &produce_send;
1045 th->get_message_cls = th;
1046 th->notify = notify;
1047 th->notify_cls = notify_cls;
1049 th->timeout = GNUNET_TIME_relative_to_absolute (maxdelay);
1050 th->timeout_task = GNUNET_SCHEDULER_add_delayed (handle->sched,
1052 GNUNET_SCHEDULER_PRIORITY_KEEP,
1053 GNUNET_SCHEDULER_NO_PREREQUISITE_TASK,
1055 &timeout_request, th);
1056 th->priority = priority;
1057 th->msize = sizeof (struct SendMessage) + notify_size;
1058 /* was the request queue previously empty? */
1059 if (handle->pending_head == th)
1060 trigger_next_request (handle);
1066 * Cancel the specified transmission-ready notification.
1068 * @param h handle that was returned by "notify_transmit_ready".
1071 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
1074 struct GNUNET_CORE_Handle *handle = h->ch;
1076 if (handle->submitted == h)
1078 handle->submitted = NULL;
1082 if (h->prev == NULL)
1083 handle->pending_head = h->next;
1085 h->prev->next = h->next;
1086 if (h->next == NULL)
1087 handle->pending_tail = h->prev;
1089 h->next->prev = h->prev;
1091 if (h->timeout_task != GNUNET_SCHEDULER_NO_PREREQUISITE_TASK)
1092 GNUNET_SCHEDULER_cancel (handle->sched, h->timeout_task);
1097 /* end of core_api.c */