2 This file is part of GNUnet.
3 Copyright (C) 2011, 2016 GNUnet e.V.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
21 * @file fs/gnunet-service-fs_cp.c
22 * @brief API to handle 'connected peers'
23 * @author Christian Grothoff
26 #include "gnunet_util_lib.h"
27 #include "gnunet_load_lib.h"
28 #include "gnunet-service-fs.h"
29 #include "gnunet-service-fs_cp.h"
30 #include "gnunet-service-fs_pe.h"
31 #include "gnunet-service-fs_pr.h"
32 #include "gnunet-service-fs_push.h"
33 #include "gnunet_peerstore_service.h"
37 * Ratio for moving average delay calculation. The previous
38 * average goes in with a factor of (n-1) into the calculation.
41 #define RUNAVG_DELAY_N 16
44 * How often do we flush respect values to disk?
46 #define RESPECT_FLUSH_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
49 * After how long do we discard a reply?
51 #define REPLY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
54 * Collect an instane number of statistics? May cause excessive IPC.
56 #define INSANE_STATISTICS GNUNET_NO
60 * Handle to cancel a transmission request.
62 struct GSF_PeerTransmitHandle
66 * Kept in a doubly-linked list.
68 struct GSF_PeerTransmitHandle *next;
71 * Kept in a doubly-linked list.
73 struct GSF_PeerTransmitHandle *prev;
76 * Time when this transmission request was issued.
78 struct GNUNET_TIME_Absolute transmission_request_start_time;
81 * Envelope with the actual message.
83 struct GNUNET_MQ_Envelope *env;
86 * Peer this request targets.
88 struct GSF_ConnectedPeer *cp;
91 * #GNUNET_YES if this is a query, #GNUNET_NO for content.
96 * Did we get a reservation already?
101 * Priority of this request.
109 * Handle for an entry in our delay list.
111 struct GSF_DelayedHandle
115 * Kept in a doubly-linked list.
117 struct GSF_DelayedHandle *next;
120 * Kept in a doubly-linked list.
122 struct GSF_DelayedHandle *prev;
125 * Peer this transmission belongs to.
127 struct GSF_ConnectedPeer *cp;
130 * Envelope of the message that was delayed.
132 struct GNUNET_MQ_Envelope *env;
135 * Task for the delay.
137 struct GNUNET_SCHEDULER_Task *delay_task;
140 * Size of the message.
148 * Information per peer and request.
154 * Handle to generic request (generic: from peer or local client).
156 struct GSF_PendingRequest *pr;
159 * Which specific peer issued this request?
161 struct GSF_ConnectedPeer *cp;
164 * Task for asynchronous stopping of this request.
166 struct GNUNET_SCHEDULER_Task *kill_task;
174 struct GSF_ConnectedPeer
178 * Performance data for this peer.
180 struct GSF_PeerPerformanceData ppd;
183 * Time until when we blocked this peer from migrating
186 struct GNUNET_TIME_Absolute last_migration_block;
189 * Task scheduled to revive migration to this peer.
191 struct GNUNET_SCHEDULER_Task *mig_revive_task;
194 * Messages (replies, queries, content migration) we would like to
195 * send to this peer in the near future. Sorted by priority, head.
197 struct GSF_PeerTransmitHandle *pth_head;
200 * Messages (replies, queries, content migration) we would like to
201 * send to this peer in the near future. Sorted by priority, tail.
203 struct GSF_PeerTransmitHandle *pth_tail;
206 * Messages (replies, queries, content migration) we would like to
207 * send to this peer in the near future. Sorted by priority, head.
209 struct GSF_DelayedHandle *delayed_head;
212 * Messages (replies, queries, content migration) we would like to
213 * send to this peer in the near future. Sorted by priority, tail.
215 struct GSF_DelayedHandle *delayed_tail;
218 * Context of our GNUNET_ATS_reserve_bandwidth call (or NULL).
220 struct GNUNET_ATS_ReservationContext *rc;
223 * Task scheduled if we need to retry bandwidth reservation later.
225 struct GNUNET_SCHEDULER_Task *rc_delay_task;
228 * Active requests from this neighbour, map of query to `struct PeerRequest`.
230 struct GNUNET_CONTAINER_MultiHashMap *request_map;
233 * Handle for an active request for transmission to this
236 struct GNUNET_MQ_Handle *mq;
239 * Increase in traffic preference still to be submitted
240 * to the core service for this peer.
242 uint64_t inc_preference;
245 * Number of entries in @e delayed_head DLL.
247 unsigned int delay_queue_size;
250 * Respect rating for this peer on disk.
252 uint32_t disk_respect;
255 * Which offset in @e last_p2p_replies will be updated next?
256 * (we go round-robin).
258 unsigned int last_p2p_replies_woff;
261 * Which offset in @e last_client_replies will be updated next?
262 * (we go round-robin).
264 unsigned int last_client_replies_woff;
267 * Current offset into @e last_request_times ring buffer.
269 unsigned int last_request_times_off;
272 * #GNUNET_YES if we did successfully reserve 32k bandwidth,
278 * Handle to the PEERSTORE iterate request for peer respect value
280 struct GNUNET_PEERSTORE_IterateContext *respect_iterate_req;
286 * Map from peer identities to `struct GSF_ConnectPeer` entries.
288 static struct GNUNET_CONTAINER_MultiPeerMap *cp_map;
291 * Handle to peerstore service.
293 static struct GNUNET_PEERSTORE_Handle *peerstore;
296 * Task used to flush respect values to disk.
298 static struct GNUNET_SCHEDULER_Task *fr_task;
302 * Update the latency information kept for the given peer.
304 * @param id peer record to update
305 * @param latency current latency value
308 GSF_update_peer_latency_ (const struct GNUNET_PeerIdentity *id,
309 struct GNUNET_TIME_Relative latency)
311 struct GSF_ConnectedPeer *cp;
313 cp = GSF_peer_get_ (id);
315 return; /* we're not yet connected at the core level, ignore */
316 GNUNET_LOAD_value_set_decline (cp->ppd.transmission_delay,
322 * Return the performance data record for the given peer
324 * @param cp peer to query
325 * @return performance data record for the peer
327 struct GSF_PeerPerformanceData *
328 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp)
335 * Core is ready to transmit to a peer, get the message.
337 * @param cp which peer to send a message to
340 peer_transmit (struct GSF_ConnectedPeer *cp);
344 * Function called by core upon success or failure of our bandwidth reservation request.
346 * @param cls the `struct GSF_ConnectedPeer` of the peer for which we made the request
347 * @param peer identifies the peer
348 * @param amount set to the amount that was actually reserved or unreserved;
349 * either the full requested amount or zero (no partial reservations)
350 * @param res_delay if the reservation could not be satisfied (amount was 0), how
351 * long should the client wait until re-trying?
354 ats_reserve_callback (void *cls,
355 const struct GNUNET_PeerIdentity *peer,
357 struct GNUNET_TIME_Relative res_delay);
361 * If ready (bandwidth reserved), try to schedule transmission via
362 * core for the given handle.
364 * @param pth transmission handle to schedule
367 schedule_transmission (struct GSF_PeerTransmitHandle *pth)
369 struct GSF_ConnectedPeer *cp;
370 struct GNUNET_PeerIdentity target;
373 GNUNET_assert (0 != cp->ppd.pid);
374 GNUNET_PEER_resolve (cp->ppd.pid, &target);
376 if (0 != cp->inc_preference)
378 GNUNET_ATS_performance_change_preference (GSF_ats,
380 GNUNET_ATS_PREFERENCE_BANDWIDTH,
381 (double) cp->inc_preference,
382 GNUNET_ATS_PREFERENCE_END);
383 cp->inc_preference = 0;
386 if ( (GNUNET_YES == pth->is_query) &&
387 (GNUNET_YES != pth->was_reserved) )
389 /* query, need reservation */
390 if (GNUNET_YES != cp->did_reserve)
391 return; /* not ready */
392 cp->did_reserve = GNUNET_NO;
393 /* reservation already done! */
394 pth->was_reserved = GNUNET_YES;
395 cp->rc = GNUNET_ATS_reserve_bandwidth (GSF_ats,
398 &ats_reserve_callback,
407 * Core is ready to transmit to a peer, get the message.
409 * @param cp which peer to send a message to
412 peer_transmit (struct GSF_ConnectedPeer *cp)
414 struct GSF_PeerTransmitHandle *pth = cp->pth_head;
415 struct GSF_PeerTransmitHandle *pos;
419 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
422 if (GNUNET_YES == pth->is_query)
424 cp->ppd.last_request_times[(cp->last_request_times_off++) %
425 MAX_QUEUE_PER_PEER] =
426 GNUNET_TIME_absolute_get ();
427 GNUNET_assert (0 < cp->ppd.pending_queries--);
429 else if (GNUNET_NO == pth->is_query)
431 GNUNET_assert (0 < cp->ppd.pending_replies--);
433 GNUNET_LOAD_update (cp->ppd.transmission_delay,
434 GNUNET_TIME_absolute_get_duration
435 (pth->transmission_request_start_time).rel_value_us);
436 GNUNET_MQ_send (cp->mq,
439 if (NULL != (pos = cp->pth_head))
441 GNUNET_assert (pos != pth);
442 schedule_transmission (pos);
448 * (re)try to reserve bandwidth from the given peer.
450 * @param cls the `struct GSF_ConnectedPeer` to reserve from
453 retry_reservation (void *cls)
455 struct GSF_ConnectedPeer *cp = cls;
456 struct GNUNET_PeerIdentity target;
458 GNUNET_PEER_resolve (cp->ppd.pid, &target);
459 cp->rc_delay_task = NULL;
461 GNUNET_ATS_reserve_bandwidth (GSF_ats,
464 &ats_reserve_callback, cp);
469 * Function called by core upon success or failure of our bandwidth reservation request.
471 * @param cls the `struct GSF_ConnectedPeer` of the peer for which we made the request
472 * @param peer identifies the peer
473 * @param amount set to the amount that was actually reserved or unreserved;
474 * either the full requested amount or zero (no partial reservations)
475 * @param res_delay if the reservation could not be satisfied (amount was 0), how
476 * long should the client wait until re-trying?
479 ats_reserve_callback (void *cls,
480 const struct GNUNET_PeerIdentity *peer,
482 struct GNUNET_TIME_Relative res_delay)
484 struct GSF_ConnectedPeer *cp = cls;
485 struct GSF_PeerTransmitHandle *pth;
487 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
488 "Reserved %d bytes / need to wait %s for reservation\n",
490 GNUNET_STRINGS_relative_time_to_string (res_delay, GNUNET_YES));
495 GNUNET_SCHEDULER_add_delayed (res_delay,
500 cp->did_reserve = GNUNET_YES;
504 /* reservation success, try transmission now! */
511 * Function called by PEERSTORE with peer respect record
513 * @param cls handle to connected peer entry
514 * @param record peerstore record information
515 * @param emsg error message, or NULL if no errors
518 peer_respect_cb (void *cls,
519 const struct GNUNET_PEERSTORE_Record *record,
522 struct GSF_ConnectedPeer *cp = cls;
524 GNUNET_assert (NULL != cp->respect_iterate_req);
525 if ( (NULL != record) &&
526 (sizeof (cp->disk_respect) == record->value_size))
528 cp->disk_respect = *((uint32_t *)record->value);
529 cp->ppd.respect += *((uint32_t *)record->value);
531 GSF_push_start_ (cp);
533 GNUNET_PEERSTORE_iterate_cancel (cp->respect_iterate_req);
534 cp->respect_iterate_req = NULL;
539 * Function called for each pending request whenever a new
540 * peer connects, giving us a chance to decide about submitting
541 * the existing request to the new peer.
543 * @param cls the `struct GSF_ConnectedPeer` of the new peer
544 * @param key query for the request
545 * @param pr handle to the pending request
546 * @return #GNUNET_YES to continue to iterate
549 consider_peer_for_forwarding (void *cls,
550 const struct GNUNET_HashCode *key,
551 struct GSF_PendingRequest *pr)
553 struct GSF_ConnectedPeer *cp = cls;
554 struct GNUNET_PeerIdentity pid;
557 GSF_pending_request_test_active_ (pr))
558 return GNUNET_YES; /* request is not actually active, skip! */
559 GSF_connected_peer_get_identity_ (cp, &pid);
561 GSF_pending_request_test_target_ (pr, &pid))
563 GNUNET_STATISTICS_update (GSF_stats,
564 gettext_noop ("# Loopback routes suppressed"),
569 GSF_plan_add_ (cp, pr);
575 * A peer connected to us. Setup the connected peer
579 * @param peer identity of peer that connected
580 * @param mq message queue for talking to @a peer
581 * @return our internal handle for the peer
584 GSF_peer_connect_handler (void *cls,
585 const struct GNUNET_PeerIdentity *peer,
586 struct GNUNET_MQ_Handle *mq)
588 struct GSF_ConnectedPeer *cp;
591 GNUNET_CRYPTO_cmp_peer_identity (&GSF_my_id,
594 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
595 "Connected to peer %s\n",
597 cp = GNUNET_new (struct GSF_ConnectedPeer);
598 cp->ppd.pid = GNUNET_PEER_intern (peer);
601 cp->ppd.transmission_delay = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_ZERO);
603 GNUNET_ATS_reserve_bandwidth (GSF_ats,
606 &ats_reserve_callback, cp);
607 cp->request_map = GNUNET_CONTAINER_multihashmap_create (128,
609 GNUNET_break (GNUNET_OK ==
610 GNUNET_CONTAINER_multipeermap_put (cp_map,
611 GSF_connected_peer_get_identity2_ (cp),
613 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
614 GNUNET_STATISTICS_set (GSF_stats,
615 gettext_noop ("# peers connected"),
616 GNUNET_CONTAINER_multipeermap_size (cp_map),
618 cp->respect_iterate_req
619 = GNUNET_PEERSTORE_iterate (peerstore,
623 GNUNET_TIME_UNIT_FOREVER_REL,
626 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding,
633 * It may be time to re-start migrating content to this
634 * peer. Check, and if so, restart migration.
636 * @param cls the `struct GSF_ConnectedPeer`
639 revive_migration (void *cls)
641 struct GSF_ConnectedPeer *cp = cls;
642 struct GNUNET_TIME_Relative bt;
644 cp->mig_revive_task = NULL;
645 bt = GNUNET_TIME_absolute_get_remaining (cp->ppd.migration_blocked_until);
646 if (0 != bt.rel_value_us)
648 /* still time left... */
649 cp->mig_revive_task =
650 GNUNET_SCHEDULER_add_delayed (bt, &revive_migration, cp);
653 GSF_push_start_ (cp);
658 * Get a handle for a connected peer.
660 * @param peer peer's identity
661 * @return NULL if the peer is not currently connected
663 struct GSF_ConnectedPeer *
664 GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer)
668 return GNUNET_CONTAINER_multipeermap_get (cp_map, peer);
673 * Handle P2P #GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP message.
675 * @param cls closure, the `struct GSF_ConnectedPeer`
676 * @param msm the actual message
679 handle_p2p_migration_stop (void *cls,
680 const struct MigrationStopMessage *msm)
682 struct GSF_ConnectedPeer *cp = cls;
683 struct GNUNET_TIME_Relative bt;
685 GNUNET_STATISTICS_update (GSF_stats,
686 gettext_noop ("# migration stop messages received"),
688 bt = GNUNET_TIME_relative_ntoh (msm->duration);
689 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
690 _("Migration of content to peer `%s' blocked for %s\n"),
691 GNUNET_i2s (cp->ppd.peer),
692 GNUNET_STRINGS_relative_time_to_string (bt, GNUNET_YES));
693 cp->ppd.migration_blocked_until = GNUNET_TIME_relative_to_absolute (bt);
694 if ( (NULL == cp->mig_revive_task) &&
695 (NULL == cp->respect_iterate_req) )
698 cp->mig_revive_task =
699 GNUNET_SCHEDULER_add_delayed (bt,
700 &revive_migration, cp);
706 * Free resources associated with the given peer request.
708 * @param peerreq request to free
711 free_pending_request (struct PeerRequest *peerreq)
713 struct GSF_ConnectedPeer *cp = peerreq->cp;
714 struct GSF_PendingRequestData *prd;
716 prd = GSF_pending_request_get_data_ (peerreq->pr);
717 if (NULL != peerreq->kill_task)
719 GNUNET_SCHEDULER_cancel (peerreq->kill_task);
720 peerreq->kill_task = NULL;
722 GNUNET_STATISTICS_update (GSF_stats,
723 gettext_noop ("# P2P searches active"),
726 GNUNET_break (GNUNET_YES ==
727 GNUNET_CONTAINER_multihashmap_remove (cp->request_map,
730 GNUNET_free (peerreq);
735 * Cancel all requests associated with the peer.
738 * @param query hash code of the request
739 * @param value the `struct GSF_PendingRequest`
740 * @return #GNUNET_YES (continue to iterate)
743 cancel_pending_request (void *cls,
744 const struct GNUNET_HashCode *query,
747 struct PeerRequest *peerreq = value;
748 struct GSF_PendingRequest *pr = peerreq->pr;
750 free_pending_request (peerreq);
751 GSF_pending_request_cancel_ (pr,
758 * Free the given request.
760 * @param cls the request to free
763 peer_request_destroy (void *cls)
765 struct PeerRequest *peerreq = cls;
766 struct GSF_PendingRequest *pr = peerreq->pr;
767 struct GSF_PendingRequestData *prd;
769 peerreq->kill_task = NULL;
770 prd = GSF_pending_request_get_data_ (pr);
771 cancel_pending_request (NULL,
778 * The artificial delay is over, transmit the message now.
780 * @param cls the `struct GSF_DelayedHandle` with the message
783 transmit_delayed_now (void *cls)
785 struct GSF_DelayedHandle *dh = cls;
786 struct GSF_ConnectedPeer *cp = dh->cp;
788 GNUNET_CONTAINER_DLL_remove (cp->delayed_head,
791 cp->delay_queue_size--;
792 GSF_peer_transmit_ (cp,
801 * Get the randomized delay a response should be subjected to.
803 * @return desired delay
805 static struct GNUNET_TIME_Relative
806 get_randomized_delay ()
808 struct GNUNET_TIME_Relative ret;
811 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
812 GNUNET_CRYPTO_random_u32
813 (GNUNET_CRYPTO_QUALITY_WEAK,
814 2 * GSF_avg_latency.rel_value_us + 1));
815 #if INSANE_STATISTICS
816 GNUNET_STATISTICS_update (GSF_stats,
818 ("# artificial delays introduced (ms)"),
819 ret.rel_value_us / 1000LL, GNUNET_NO);
826 * Handle a reply to a pending request. Also called if a request
827 * expires (then with data == NULL). The handler may be called
828 * many times (depending on the request type), but will not be
829 * called during or after a call to GSF_pending_request_cancel
830 * and will also not be called anymore after a call signalling
833 * @param cls `struct PeerRequest` this is an answer for
834 * @param eval evaluation of the result
835 * @param pr handle to the original pending request
836 * @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
837 * @param expiration when does @a data expire?
838 * @param last_transmission when did we last transmit a request for this block
839 * @param type type of the block
840 * @param data response data, NULL on request expiration
841 * @param data_len number of bytes in @a data
844 handle_p2p_reply (void *cls,
845 enum GNUNET_BLOCK_EvaluationResult eval,
846 struct GSF_PendingRequest *pr,
847 uint32_t reply_anonymity_level,
848 struct GNUNET_TIME_Absolute expiration,
849 struct GNUNET_TIME_Absolute last_transmission,
850 enum GNUNET_BLOCK_Type type,
854 struct PeerRequest *peerreq = cls;
855 struct GSF_ConnectedPeer *cp = peerreq->cp;
856 struct GSF_PendingRequestData *prd;
857 struct GNUNET_MQ_Envelope *env;
858 struct PutMessage *pm;
861 GNUNET_assert (data_len + sizeof (struct PutMessage) <
862 GNUNET_SERVER_MAX_MESSAGE_SIZE);
863 GNUNET_assert (peerreq->pr == pr);
864 prd = GSF_pending_request_get_data_ (pr);
867 free_pending_request (peerreq);
870 GNUNET_break (GNUNET_BLOCK_TYPE_ANY != type);
871 if ((prd->type != type) && (GNUNET_BLOCK_TYPE_ANY != prd->type))
873 GNUNET_STATISTICS_update (GSF_stats,
875 ("# replies dropped due to type mismatch"),
879 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
880 "Transmitting result for query `%s' to peer\n",
881 GNUNET_h2s (&prd->query));
882 GNUNET_STATISTICS_update (GSF_stats,
883 gettext_noop ("# replies received for other peers"),
885 msize = sizeof (struct PutMessage) + data_len;
886 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
891 if ((UINT32_MAX != reply_anonymity_level) && (reply_anonymity_level > 1))
893 if (reply_anonymity_level - 1 > GSF_cover_content_count)
895 GNUNET_STATISTICS_update (GSF_stats,
897 ("# replies dropped due to insufficient cover traffic"),
901 GSF_cover_content_count -= (reply_anonymity_level - 1);
904 env = GNUNET_MQ_msg_extra (pm,
906 GNUNET_MESSAGE_TYPE_FS_PUT);
907 pm->type = htonl (type);
908 pm->expiration = GNUNET_TIME_absolute_hton (expiration);
909 GNUNET_memcpy (&pm[1],
912 if ( (UINT32_MAX != reply_anonymity_level) &&
913 (0 != reply_anonymity_level) &&
914 (GNUNET_YES == GSF_enable_randomized_delays) )
916 struct GSF_DelayedHandle *dh;
918 dh = GNUNET_new (struct GSF_DelayedHandle);
922 GNUNET_CONTAINER_DLL_insert (cp->delayed_head,
925 cp->delay_queue_size++;
927 GNUNET_SCHEDULER_add_delayed (get_randomized_delay (),
928 &transmit_delayed_now,
933 GSF_peer_transmit_ (cp,
938 if (GNUNET_BLOCK_EVALUATION_OK_LAST != eval)
940 if (NULL == peerreq->kill_task)
942 GNUNET_STATISTICS_update (GSF_stats,
944 ("# P2P searches destroyed due to ultimate reply"),
948 GNUNET_SCHEDULER_add_now (&peer_request_destroy,
955 * Increase the peer's respect by a value.
957 * @param cp which peer to change the respect value on
958 * @param value is the int value by which the
959 * peer's credit is to be increased or decreased
960 * @returns the actual change in respect (positive or negative)
963 change_peer_respect (struct GSF_ConnectedPeer *cp, int value)
967 GNUNET_assert (NULL != cp);
970 if (cp->ppd.respect + value < cp->ppd.respect)
972 value = UINT32_MAX - cp->ppd.respect;
973 cp->ppd.respect = UINT32_MAX;
976 cp->ppd.respect += value;
980 if (cp->ppd.respect < -value)
982 value = -cp->ppd.respect;
986 cp->ppd.respect += value;
993 * We've received a request with the specified priority. Bound it
994 * according to how much we respect the given peer.
996 * @param prio_in requested priority
997 * @param cp the peer making the request
998 * @return effective priority
1001 bound_priority (uint32_t prio_in,
1002 struct GSF_ConnectedPeer *cp)
1004 #define N ((double)128.0)
1009 ld = GSF_test_get_load_too_high_ (0);
1010 if (GNUNET_SYSERR == ld)
1012 #if INSANE_STATISTICS
1013 GNUNET_STATISTICS_update (GSF_stats,
1015 ("# requests done for free (low load)"), 1,
1018 return 0; /* excess resources */
1020 if (prio_in > INT32_MAX)
1021 prio_in = INT32_MAX;
1022 ret = -change_peer_respect (cp, -(int) prio_in);
1025 if (ret > GSF_current_priorities + N)
1026 rret = GSF_current_priorities + N;
1029 GSF_current_priorities = (GSF_current_priorities * (N - 1) + rret) / N;
1031 if ((GNUNET_YES == ld) && (ret > 0))
1033 /* try with charging */
1034 ld = GSF_test_get_load_too_high_ (ret);
1036 if (GNUNET_YES == ld)
1038 GNUNET_STATISTICS_update (GSF_stats,
1040 ("# request dropped, priority insufficient"), 1,
1043 change_peer_respect (cp, (int) ret);
1044 return -1; /* not enough resources */
1048 GNUNET_STATISTICS_update (GSF_stats,
1050 ("# requests done for a price (normal load)"), 1,
1059 * The priority level imposes a bound on the maximum
1060 * value for the ttl that can be requested.
1062 * @param ttl_in requested ttl
1063 * @param prio given priority
1064 * @return @a ttl_in if @a ttl_in is below the limit,
1065 * otherwise the ttl-limit for the given @a prio
1068 bound_ttl (int32_t ttl_in,
1071 unsigned long long allowed;
1075 allowed = ((unsigned long long) prio) * TTL_DECREMENT / 1000;
1076 if (ttl_in > allowed)
1078 if (allowed >= (1 << 30))
1087 * Closure for #test_exist_cb().
1089 struct TestExistClosure
1093 * Priority of the incoming request.
1098 * Relative TTL of the incoming request.
1103 * Type of the incoming request.
1105 enum GNUNET_BLOCK_Type type;
1108 * Set to #GNUNET_YES if we are done handling the query.
1116 * Test if the query already exists. If so, merge it, otherwise
1117 * keep `finished` at #GNUNET_NO.
1119 * @param cls our `struct TestExistClosure`
1120 * @param hc the key of the query
1121 * @param value the existing `struct PeerRequest`.
1122 * @return #GNUNET_YES to continue to iterate,
1123 * #GNUNET_NO if we successfully merged
1126 test_exist_cb (void *cls,
1127 const struct GNUNET_HashCode *hc,
1130 struct TestExistClosure *tec = cls;
1131 struct PeerRequest *peerreq = value;
1132 struct GSF_PendingRequest *pr;
1133 struct GSF_PendingRequestData *prd;
1136 prd = GSF_pending_request_get_data_ (pr);
1137 if (prd->type != tec->type)
1139 if (prd->ttl.abs_value_us >=
1140 GNUNET_TIME_absolute_get ().abs_value_us + tec->ttl * 1000LL)
1142 /* existing request has higher TTL, drop new one! */
1143 prd->priority += tec->priority;
1144 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1145 "Have existing request with higher TTL, dropping new request.\n");
1146 GNUNET_STATISTICS_update (GSF_stats,
1148 ("# requests dropped due to higher-TTL request"),
1150 tec->finished = GNUNET_YES;
1153 /* existing request has lower TTL, drop old one! */
1154 tec->priority += prd->priority;
1155 free_pending_request (peerreq);
1156 GSF_pending_request_cancel_ (pr,
1163 * Handle P2P "QUERY" message. Creates the pending request entry
1164 * and sets up all of the data structures to that we will
1165 * process replies properly. Does not initiate forwarding or
1166 * local database lookups.
1168 * @param cls the other peer involved (sender of the message)
1169 * @param gm the GET message
1172 handle_p2p_get (void *cls,
1173 const struct GetMessage *gm)
1175 struct GSF_ConnectedPeer *cps = cls;
1176 struct PeerRequest *peerreq;
1177 struct GSF_PendingRequest *pr;
1178 struct GSF_ConnectedPeer *cp;
1179 const struct GNUNET_PeerIdentity *target;
1180 enum GSF_PendingRequestOptions options;
1183 const struct GNUNET_PeerIdentity *opt;
1186 uint32_t ttl_decrement;
1187 struct TestExistClosure tec;
1188 GNUNET_PEER_Id spid;
1189 const struct GSF_PendingRequestData *prd;
1191 msize = ntohs (gm->header.size);
1192 tec.type = ntohl (gm->type);
1193 bm = ntohl (gm->hash_bitmap);
1201 opt = (const struct GNUNET_PeerIdentity *) &gm[1];
1202 bfsize = msize - sizeof (struct GetMessage) - bits * sizeof (struct GNUNET_PeerIdentity);
1203 GNUNET_STATISTICS_update (GSF_stats,
1205 ("# GET requests received (from other peers)"),
1208 GSF_cover_query_count++;
1209 bm = ntohl (gm->hash_bitmap);
1211 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
1212 cp = GSF_peer_get_ (&opt[bits++]);
1217 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
1218 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1219 "Failed to find RETURN-TO peer `%s' in connection set. Dropping query.\n",
1220 GNUNET_i2s (&opt[bits - 1]));
1223 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1224 "Failed to find peer `%s' in connection set. Dropping query.\n",
1225 GNUNET_i2s (cps->ppd.peer));
1226 GNUNET_STATISTICS_update (GSF_stats,
1228 ("# requests dropped due to missing reverse route"),
1233 if (cp->ppd.pending_replies + cp->delay_queue_size > MAX_QUEUE_PER_PEER)
1235 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1236 "Peer `%s' has too many replies queued already. Dropping query.\n",
1237 GNUNET_i2s (cps->ppd.peer));
1238 GNUNET_STATISTICS_update (GSF_stats,
1239 gettext_noop ("# requests dropped due to full reply queue"),
1244 /* note that we can really only check load here since otherwise
1245 * peers could find out that we are overloaded by not being
1246 * disconnected after sending us a malformed query... */
1247 tec.priority = bound_priority (ntohl (gm->priority),
1249 if (tec.priority < 0)
1251 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1252 "Dropping query from `%s', this peer is too busy.\n",
1253 GNUNET_i2s (cps->ppd.peer));
1256 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1257 "Received request for `%s' of type %u from peer `%s' with flags %u\n",
1258 GNUNET_h2s (&gm->query),
1259 (unsigned int) tec.type,
1260 GNUNET_i2s (cps->ppd.peer),
1264 (bm & GET_MESSAGE_BIT_TRANSMIT_TO)) ? (&opt[bits++]) : NULL;
1265 options = GSF_PRO_DEFAULTS;
1267 if ((GNUNET_LOAD_get_load (cp->ppd.transmission_delay) > 3 * (1 + tec.priority))
1268 || (GNUNET_LOAD_get_average (cp->ppd.transmission_delay) >
1269 GNUNET_CONSTANTS_MAX_CORK_DELAY.rel_value_us * 2 +
1270 GNUNET_LOAD_get_average (GSF_rt_entry_lifetime)))
1272 /* don't have BW to send to peer, or would likely take longer than we have for it,
1273 * so at best indirect the query */
1275 options |= GSF_PRO_FORWARD_ONLY;
1276 spid = GNUNET_PEER_intern (cps->ppd.peer);
1277 GNUNET_assert (0 != spid);
1279 tec.ttl = bound_ttl (ntohl (gm->ttl),
1281 /* decrement ttl (always) */
1283 2 * TTL_DECREMENT + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1285 if ( (tec.ttl < 0) &&
1286 (((int32_t) (tec.ttl - ttl_decrement)) > 0) )
1288 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1289 "Dropping query from `%s' due to TTL underflow (%d - %u).\n",
1290 GNUNET_i2s (cps->ppd.peer),
1293 GNUNET_STATISTICS_update (GSF_stats,
1295 ("# requests dropped due TTL underflow"), 1,
1297 /* integer underflow => drop (should be very rare)! */
1300 tec.ttl -= ttl_decrement;
1302 /* test if the request already exists */
1303 tec.finished = GNUNET_NO;
1304 GNUNET_CONTAINER_multihashmap_get_multiple (cp->request_map,
1308 if (GNUNET_YES == tec.finished)
1309 return; /* merged into existing request, we're done */
1311 peerreq = GNUNET_new (struct PeerRequest);
1313 pr = GSF_pending_request_create_ (options,
1318 ? (const char *) &opt[bits]
1321 ntohl (gm->filter_mutator),
1323 (uint32_t) tec.priority,
1326 GNUNET_PEER_intern (cps->ppd.peer),
1327 NULL, 0, /* replies_seen */
1330 GNUNET_assert (NULL != pr);
1331 prd = GSF_pending_request_get_data_ (pr);
1333 GNUNET_break (GNUNET_OK ==
1334 GNUNET_CONTAINER_multihashmap_put (cp->request_map,
1337 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
1338 GNUNET_STATISTICS_update (GSF_stats,
1339 gettext_noop ("# P2P query messages received and processed"),
1342 GNUNET_STATISTICS_update (GSF_stats,
1343 gettext_noop ("# P2P searches active"),
1346 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
1347 GSF_local_lookup_ (pr,
1348 &GSF_consider_forwarding,
1354 * Transmit a message to the given peer as soon as possible.
1355 * If the peer disconnects before the transmission can happen,
1356 * the callback is invoked with a `NULL` @a buffer.
1358 * @param cp target peer
1359 * @param is_query is this a query (#GNUNET_YES) or content (#GNUNET_NO) or neither (#GNUNET_SYSERR)
1360 * @param priority how important is this request?
1361 * @param timeout when does this request timeout
1362 * @param size number of bytes we would like to send to the peer
1363 * @param env message to send
1366 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
1369 struct GNUNET_MQ_Envelope *env)
1371 struct GSF_PeerTransmitHandle *pth;
1372 struct GSF_PeerTransmitHandle *pos;
1373 struct GSF_PeerTransmitHandle *prev;
1375 pth = GNUNET_new (struct GSF_PeerTransmitHandle);
1376 pth->transmission_request_start_time = GNUNET_TIME_absolute_get ();
1378 pth->is_query = is_query;
1379 pth->priority = priority;
1381 /* insertion sort (by priority, descending) */
1384 while ((NULL != pos) && (pos->priority > priority))
1389 GNUNET_CONTAINER_DLL_insert_after (cp->pth_head,
1393 if (GNUNET_YES == is_query)
1394 cp->ppd.pending_queries++;
1395 else if (GNUNET_NO == is_query)
1396 cp->ppd.pending_replies++;
1397 schedule_transmission (pth);
1402 * Report on receiving a reply; update the performance record of the given peer.
1404 * @param cp responding peer (will be updated)
1405 * @param request_time time at which the original query was transmitted
1406 * @param request_priority priority of the original request
1409 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
1410 struct GNUNET_TIME_Absolute request_time,
1411 uint32_t request_priority)
1413 struct GNUNET_TIME_Relative delay;
1415 delay = GNUNET_TIME_absolute_get_duration (request_time);
1416 cp->ppd.avg_reply_delay.rel_value_us =
1417 (cp->ppd.avg_reply_delay.rel_value_us * (RUNAVG_DELAY_N - 1) +
1418 delay.rel_value_us) / RUNAVG_DELAY_N;
1419 cp->ppd.avg_priority =
1420 (cp->ppd.avg_priority * (RUNAVG_DELAY_N - 1) +
1421 request_priority) / RUNAVG_DELAY_N;
1426 * Report on receiving a reply in response to an initiating client.
1427 * Remember that this peer is good for this client.
1429 * @param cp responding peer (will be updated)
1430 * @param initiator_client local client on responsible for query
1433 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
1434 struct GSF_LocalClient *initiator_client)
1436 cp->ppd.last_client_replies[cp->last_client_replies_woff++ %
1437 CS2P_SUCCESS_LIST_SIZE] = initiator_client;
1442 * Report on receiving a reply in response to an initiating peer.
1443 * Remember that this peer is good for this initiating peer.
1445 * @param cp responding peer (will be updated)
1446 * @param initiator_peer other peer responsible for query
1449 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
1450 const struct GSF_ConnectedPeer *initiator_peer)
1454 woff = cp->last_p2p_replies_woff % P2P_SUCCESS_LIST_SIZE;
1455 GNUNET_PEER_change_rc (cp->ppd.last_p2p_replies[woff], -1);
1456 cp->ppd.last_p2p_replies[woff] = initiator_peer->ppd.pid;
1457 GNUNET_PEER_change_rc (initiator_peer->ppd.pid, 1);
1458 cp->last_p2p_replies_woff = (woff + 1) % P2P_SUCCESS_LIST_SIZE;
1463 * Write peer-respect information to a file - flush the buffer entry!
1466 * @param key peer identity
1467 * @param value the `struct GSF_ConnectedPeer` to flush
1468 * @return #GNUNET_OK to continue iteration
1471 flush_respect (void *cls,
1472 const struct GNUNET_PeerIdentity *key,
1475 struct GSF_ConnectedPeer *cp = value;
1476 struct GNUNET_PeerIdentity pid;
1478 if (cp->ppd.respect == cp->disk_respect)
1479 return GNUNET_OK; /* unchanged */
1480 GNUNET_assert (0 != cp->ppd.pid);
1481 GNUNET_PEER_resolve (cp->ppd.pid, &pid);
1482 GNUNET_PEERSTORE_store (peerstore, "fs", &pid, "respect", &cp->ppd.respect,
1483 sizeof (cp->ppd.respect),
1484 GNUNET_TIME_UNIT_FOREVER_ABS,
1485 GNUNET_PEERSTORE_STOREOPTION_REPLACE,
1493 * A peer disconnected from us. Tear down the connected peer
1497 * @param peer identity of peer that disconnected
1498 * @param internal_cls the corresponding `struct GSF_ConnectedPeer`
1501 GSF_peer_disconnect_handler (void *cls,
1502 const struct GNUNET_PeerIdentity *peer,
1505 struct GSF_ConnectedPeer *cp = internal_cls;
1506 struct GSF_PeerTransmitHandle *pth;
1507 struct GSF_DelayedHandle *dh;
1510 return; /* must have been disconnect from core with
1511 * 'peer' == my_id, ignore */
1512 flush_respect (NULL,
1515 GNUNET_assert (GNUNET_YES ==
1516 GNUNET_CONTAINER_multipeermap_remove (cp_map,
1519 GNUNET_STATISTICS_set (GSF_stats,
1520 gettext_noop ("# peers connected"),
1521 GNUNET_CONTAINER_multipeermap_size (cp_map),
1523 if (NULL != cp->respect_iterate_req)
1525 GNUNET_PEERSTORE_iterate_cancel (cp->respect_iterate_req);
1526 cp->respect_iterate_req = NULL;
1530 GNUNET_ATS_reserve_bandwidth_cancel (cp->rc);
1533 if (NULL != cp->rc_delay_task)
1535 GNUNET_SCHEDULER_cancel (cp->rc_delay_task);
1536 cp->rc_delay_task = NULL;
1538 GNUNET_CONTAINER_multihashmap_iterate (cp->request_map,
1539 &cancel_pending_request,
1541 GNUNET_CONTAINER_multihashmap_destroy (cp->request_map);
1542 cp->request_map = NULL;
1543 GSF_plan_notify_peer_disconnect_ (cp);
1544 GNUNET_LOAD_value_free (cp->ppd.transmission_delay);
1545 GNUNET_PEER_decrement_rcs (cp->ppd.last_p2p_replies,
1546 P2P_SUCCESS_LIST_SIZE);
1547 memset (cp->ppd.last_p2p_replies,
1549 sizeof (cp->ppd.last_p2p_replies));
1550 GSF_push_stop_ (cp);
1551 while (NULL != (pth = cp->pth_head))
1553 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1556 if (GNUNET_YES == pth->is_query)
1557 GNUNET_assert (0 < cp->ppd.pending_queries--);
1558 else if (GNUNET_NO == pth->is_query)
1559 GNUNET_assert (0 < cp->ppd.pending_replies--);
1562 while (NULL != (dh = cp->delayed_head))
1564 GNUNET_CONTAINER_DLL_remove (cp->delayed_head,
1567 GNUNET_MQ_discard (dh->env);
1568 cp->delay_queue_size--;
1569 GNUNET_SCHEDULER_cancel (dh->delay_task);
1572 GNUNET_PEER_change_rc (cp->ppd.pid, -1);
1573 if (NULL != cp->mig_revive_task)
1575 GNUNET_SCHEDULER_cancel (cp->mig_revive_task);
1576 cp->mig_revive_task = NULL;
1578 GNUNET_break (0 == cp->ppd.pending_queries);
1579 GNUNET_break (0 == cp->ppd.pending_replies);
1585 * Closure for #call_iterator().
1587 struct IterationContext
1590 * Function to call on each entry.
1592 GSF_ConnectedPeerIterator it;
1595 * Closure for @e it.
1602 * Function that calls the callback for each peer.
1604 * @param cls the `struct IterationContext *`
1605 * @param key identity of the peer
1606 * @param value the `struct GSF_ConnectedPeer *`
1607 * @return #GNUNET_YES to continue iteration
1610 call_iterator (void *cls,
1611 const struct GNUNET_PeerIdentity *key,
1614 struct IterationContext *ic = cls;
1615 struct GSF_ConnectedPeer *cp = value;
1625 * Iterate over all connected peers.
1627 * @param it function to call for each peer
1628 * @param it_cls closure for @a it
1631 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
1634 struct IterationContext ic;
1638 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1645 * Obtain the identity of a connected peer.
1647 * @param cp peer to get identity of
1648 * @param id identity to set (written to)
1651 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
1652 struct GNUNET_PeerIdentity *id)
1654 GNUNET_assert (0 != cp->ppd.pid);
1655 GNUNET_PEER_resolve (cp->ppd.pid, id);
1660 * Obtain the identity of a connected peer.
1662 * @param cp peer to get identity of
1663 * @return reference to peer identity, valid until peer disconnects (!)
1665 const struct GNUNET_PeerIdentity *
1666 GSF_connected_peer_get_identity2_ (const struct GSF_ConnectedPeer *cp)
1668 GNUNET_assert (0 != cp->ppd.pid);
1669 return GNUNET_PEER_resolve2 (cp->ppd.pid);
1674 * Ask a peer to stop migrating data to us until the given point
1677 * @param cp peer to ask
1678 * @param block_time until when to block
1681 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
1682 struct GNUNET_TIME_Absolute block_time)
1684 struct GNUNET_MQ_Envelope *env;
1685 struct MigrationStopMessage *msm;
1687 if (cp->last_migration_block.abs_value_us > block_time.abs_value_us)
1689 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1690 "Migration already blocked for another %s\n",
1691 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining
1692 (cp->last_migration_block), GNUNET_YES));
1693 return; /* already blocked */
1695 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Asking to stop migration for %s\n",
1696 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (block_time),
1698 cp->last_migration_block = block_time;
1699 env = GNUNET_MQ_msg (msm,
1700 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP);
1701 msm->reserved = htonl (0);
1703 = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining
1704 (cp->last_migration_block));
1705 GNUNET_STATISTICS_update (GSF_stats,
1706 gettext_noop ("# migration stop messages sent"),
1709 GSF_peer_transmit_ (cp,
1717 * Notify core about a preference we have for the given peer
1718 * (to allocate more resources towards it). The change will
1719 * be communicated the next time we reserve bandwidth with
1720 * core (not instantly).
1722 * @param cp peer to reserve bandwidth from
1723 * @param pref preference change
1726 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
1729 cp->inc_preference += pref;
1734 * Call this method periodically to flush respect information to disk.
1736 * @param cls closure, not used
1739 cron_flush_respect (void *cls)
1742 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1745 fr_task = GNUNET_SCHEDULER_add_delayed_with_priority (RESPECT_FLUSH_FREQ,
1746 GNUNET_SCHEDULER_PRIORITY_HIGH,
1747 &cron_flush_respect, NULL);
1752 * Initialize peer management subsystem.
1755 GSF_connected_peer_init_ ()
1757 cp_map = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
1758 peerstore = GNUNET_PEERSTORE_connect (GSF_cfg);
1759 fr_task = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_HIGH,
1760 &cron_flush_respect, NULL);
1765 * Shutdown peer management subsystem.
1768 GSF_connected_peer_done_ ()
1770 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1773 GNUNET_SCHEDULER_cancel (fr_task);
1775 GNUNET_CONTAINER_multipeermap_destroy (cp_map);
1777 GNUNET_PEERSTORE_disconnect (peerstore,
1784 * Iterator to remove references to LC entry.
1786 * @param cls the `struct GSF_LocalClient *` to look for
1787 * @param key current key code
1788 * @param value value in the hash map (peer entry)
1789 * @return #GNUNET_YES (we should continue to iterate)
1792 clean_local_client (void *cls,
1793 const struct GNUNET_PeerIdentity *key,
1796 const struct GSF_LocalClient *lc = cls;
1797 struct GSF_ConnectedPeer *cp = value;
1800 for (i = 0; i < CS2P_SUCCESS_LIST_SIZE; i++)
1801 if (cp->ppd.last_client_replies[i] == lc)
1802 cp->ppd.last_client_replies[i] = NULL;
1808 * Notification that a local client disconnected. Clean up all of our
1809 * references to the given handle.
1811 * @param lc handle to the local client (henceforth invalid)
1814 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc)
1817 return; /* already cleaned up */
1818 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1819 &clean_local_client,
1824 /* end of gnunet-service-fs_cp.c */