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 it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * @file fs/gnunet-service-fs_cp.c
20 * @brief API to handle 'connected peers'
21 * @author Christian Grothoff
24 #include "gnunet_util_lib.h"
25 #include "gnunet_load_lib.h"
26 #include "gnunet-service-fs.h"
27 #include "gnunet-service-fs_cp.h"
28 #include "gnunet-service-fs_pe.h"
29 #include "gnunet-service-fs_pr.h"
30 #include "gnunet-service-fs_push.h"
31 #include "gnunet_peerstore_service.h"
35 * Ratio for moving average delay calculation. The previous
36 * average goes in with a factor of (n-1) into the calculation.
39 #define RUNAVG_DELAY_N 16
42 * How often do we flush respect values to disk?
44 #define RESPECT_FLUSH_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
47 * After how long do we discard a reply?
49 #define REPLY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
52 * Collect an instane number of statistics? May cause excessive IPC.
54 #define INSANE_STATISTICS GNUNET_NO
58 * Handle to cancel a transmission request.
60 struct GSF_PeerTransmitHandle
64 * Kept in a doubly-linked list.
66 struct GSF_PeerTransmitHandle *next;
69 * Kept in a doubly-linked list.
71 struct GSF_PeerTransmitHandle *prev;
74 * Time when this transmission request was issued.
76 struct GNUNET_TIME_Absolute transmission_request_start_time;
79 * Envelope with the actual message.
81 struct GNUNET_MQ_Envelope *env;
84 * Peer this request targets.
86 struct GSF_ConnectedPeer *cp;
89 * #GNUNET_YES if this is a query, #GNUNET_NO for content.
94 * Did we get a reservation already?
99 * Priority of this request.
107 * Handle for an entry in our delay list.
109 struct GSF_DelayedHandle
113 * Kept in a doubly-linked list.
115 struct GSF_DelayedHandle *next;
118 * Kept in a doubly-linked list.
120 struct GSF_DelayedHandle *prev;
123 * Peer this transmission belongs to.
125 struct GSF_ConnectedPeer *cp;
128 * Envelope of the message that was delayed.
130 struct GNUNET_MQ_Envelope *env;
133 * Task for the delay.
135 struct GNUNET_SCHEDULER_Task *delay_task;
138 * Size of the message.
146 * Information per peer and request.
152 * Handle to generic request (generic: from peer or local client).
154 struct GSF_PendingRequest *pr;
157 * Which specific peer issued this request?
159 struct GSF_ConnectedPeer *cp;
162 * Task for asynchronous stopping of this request.
164 struct GNUNET_SCHEDULER_Task *kill_task;
172 struct GSF_ConnectedPeer
176 * Performance data for this peer.
178 struct GSF_PeerPerformanceData ppd;
181 * Time until when we blocked this peer from migrating
184 struct GNUNET_TIME_Absolute last_migration_block;
187 * Task scheduled to revive migration to this peer.
189 struct GNUNET_SCHEDULER_Task *mig_revive_task;
192 * Messages (replies, queries, content migration) we would like to
193 * send to this peer in the near future. Sorted by priority, head.
195 struct GSF_PeerTransmitHandle *pth_head;
198 * Messages (replies, queries, content migration) we would like to
199 * send to this peer in the near future. Sorted by priority, tail.
201 struct GSF_PeerTransmitHandle *pth_tail;
204 * Messages (replies, queries, content migration) we would like to
205 * send to this peer in the near future. Sorted by priority, head.
207 struct GSF_DelayedHandle *delayed_head;
210 * Messages (replies, queries, content migration) we would like to
211 * send to this peer in the near future. Sorted by priority, tail.
213 struct GSF_DelayedHandle *delayed_tail;
216 * Context of our GNUNET_ATS_reserve_bandwidth call (or NULL).
218 struct GNUNET_ATS_ReservationContext *rc;
221 * Task scheduled if we need to retry bandwidth reservation later.
223 struct GNUNET_SCHEDULER_Task *rc_delay_task;
226 * Active requests from this neighbour, map of query to `struct PeerRequest`.
228 struct GNUNET_CONTAINER_MultiHashMap *request_map;
231 * Handle for an active request for transmission to this
234 struct GNUNET_MQ_Handle *mq;
237 * Increase in traffic preference still to be submitted
238 * to the core service for this peer.
240 uint64_t inc_preference;
243 * Number of entries in @e delayed_head DLL.
245 unsigned int delay_queue_size;
248 * Respect rating for this peer on disk.
250 uint32_t disk_respect;
253 * Which offset in @e last_p2p_replies will be updated next?
254 * (we go round-robin).
256 unsigned int last_p2p_replies_woff;
259 * Which offset in @e last_client_replies will be updated next?
260 * (we go round-robin).
262 unsigned int last_client_replies_woff;
265 * Current offset into @e last_request_times ring buffer.
267 unsigned int last_request_times_off;
270 * #GNUNET_YES if we did successfully reserve 32k bandwidth,
276 * Handle to the PEERSTORE iterate request for peer respect value
278 struct GNUNET_PEERSTORE_IterateContext *respect_iterate_req;
284 * Map from peer identities to `struct GSF_ConnectPeer` entries.
286 static struct GNUNET_CONTAINER_MultiPeerMap *cp_map;
289 * Handle to peerstore service.
291 static struct GNUNET_PEERSTORE_Handle *peerstore;
294 * Task used to flush respect values to disk.
296 static struct GNUNET_SCHEDULER_Task *fr_task;
300 * Update the latency information kept for the given peer.
302 * @param id peer record to update
303 * @param latency current latency value
306 GSF_update_peer_latency_ (const struct GNUNET_PeerIdentity *id,
307 struct GNUNET_TIME_Relative latency)
309 struct GSF_ConnectedPeer *cp;
311 cp = GSF_peer_get_ (id);
313 return; /* we're not yet connected at the core level, ignore */
314 GNUNET_LOAD_value_set_decline (cp->ppd.transmission_delay,
320 * Return the performance data record for the given peer
322 * @param cp peer to query
323 * @return performance data record for the peer
325 struct GSF_PeerPerformanceData *
326 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp)
333 * Core is ready to transmit to a peer, get the message.
335 * @param cp which peer to send a message to
338 peer_transmit (struct GSF_ConnectedPeer *cp);
342 * Function called by core upon success or failure of our bandwidth reservation request.
344 * @param cls the `struct GSF_ConnectedPeer` of the peer for which we made the request
345 * @param peer identifies the peer
346 * @param amount set to the amount that was actually reserved or unreserved;
347 * either the full requested amount or zero (no partial reservations)
348 * @param res_delay if the reservation could not be satisfied (amount was 0), how
349 * long should the client wait until re-trying?
352 ats_reserve_callback (void *cls,
353 const struct GNUNET_PeerIdentity *peer,
355 struct GNUNET_TIME_Relative res_delay);
359 * If ready (bandwidth reserved), try to schedule transmission via
360 * core for the given handle.
362 * @param pth transmission handle to schedule
365 schedule_transmission (struct GSF_PeerTransmitHandle *pth)
367 struct GSF_ConnectedPeer *cp;
368 struct GNUNET_PeerIdentity target;
371 GNUNET_assert (0 != cp->ppd.pid);
372 GNUNET_PEER_resolve (cp->ppd.pid, &target);
374 if (0 != cp->inc_preference)
376 GNUNET_ATS_performance_change_preference (GSF_ats,
378 GNUNET_ATS_PREFERENCE_BANDWIDTH,
379 (double) cp->inc_preference,
380 GNUNET_ATS_PREFERENCE_END);
381 cp->inc_preference = 0;
384 if ( (GNUNET_YES == pth->is_query) &&
385 (GNUNET_YES != pth->was_reserved) )
387 /* query, need reservation */
388 if (GNUNET_YES != cp->did_reserve)
389 return; /* not ready */
390 cp->did_reserve = GNUNET_NO;
391 /* reservation already done! */
392 pth->was_reserved = GNUNET_YES;
393 cp->rc = GNUNET_ATS_reserve_bandwidth (GSF_ats,
396 &ats_reserve_callback,
405 * Core is ready to transmit to a peer, get the message.
407 * @param cp which peer to send a message to
410 peer_transmit (struct GSF_ConnectedPeer *cp)
412 struct GSF_PeerTransmitHandle *pth = cp->pth_head;
413 struct GSF_PeerTransmitHandle *pos;
417 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
420 if (GNUNET_YES == pth->is_query)
422 cp->ppd.last_request_times[(cp->last_request_times_off++) %
423 MAX_QUEUE_PER_PEER] =
424 GNUNET_TIME_absolute_get ();
425 GNUNET_assert (0 < cp->ppd.pending_queries--);
427 else if (GNUNET_NO == pth->is_query)
429 GNUNET_assert (0 < cp->ppd.pending_replies--);
431 GNUNET_LOAD_update (cp->ppd.transmission_delay,
432 GNUNET_TIME_absolute_get_duration
433 (pth->transmission_request_start_time).rel_value_us);
434 GNUNET_MQ_send (cp->mq,
437 if (NULL != (pos = cp->pth_head))
439 GNUNET_assert (pos != pth);
440 schedule_transmission (pos);
446 * (re)try to reserve bandwidth from the given peer.
448 * @param cls the `struct GSF_ConnectedPeer` to reserve from
451 retry_reservation (void *cls)
453 struct GSF_ConnectedPeer *cp = cls;
454 struct GNUNET_PeerIdentity target;
456 GNUNET_PEER_resolve (cp->ppd.pid, &target);
457 cp->rc_delay_task = NULL;
459 GNUNET_ATS_reserve_bandwidth (GSF_ats,
462 &ats_reserve_callback, cp);
467 * Function called by core upon success or failure of our bandwidth reservation request.
469 * @param cls the `struct GSF_ConnectedPeer` of the peer for which we made the request
470 * @param peer identifies the peer
471 * @param amount set to the amount that was actually reserved or unreserved;
472 * either the full requested amount or zero (no partial reservations)
473 * @param res_delay if the reservation could not be satisfied (amount was 0), how
474 * long should the client wait until re-trying?
477 ats_reserve_callback (void *cls,
478 const struct GNUNET_PeerIdentity *peer,
480 struct GNUNET_TIME_Relative res_delay)
482 struct GSF_ConnectedPeer *cp = cls;
483 struct GSF_PeerTransmitHandle *pth;
485 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
486 "Reserved %d bytes / need to wait %s for reservation\n",
488 GNUNET_STRINGS_relative_time_to_string (res_delay, GNUNET_YES));
493 GNUNET_SCHEDULER_add_delayed (res_delay,
498 cp->did_reserve = GNUNET_YES;
502 /* reservation success, try transmission now! */
509 * Function called by PEERSTORE with peer respect record
511 * @param cls handle to connected peer entry
512 * @param record peerstore record information
513 * @param emsg error message, or NULL if no errors
516 peer_respect_cb (void *cls,
517 const struct GNUNET_PEERSTORE_Record *record,
520 struct GSF_ConnectedPeer *cp = cls;
522 GNUNET_assert (NULL != cp->respect_iterate_req);
523 if ( (NULL != record) &&
524 (sizeof (cp->disk_respect) == record->value_size))
526 cp->disk_respect = *((uint32_t *)record->value);
527 cp->ppd.respect += *((uint32_t *)record->value);
529 GSF_push_start_ (cp);
531 GNUNET_PEERSTORE_iterate_cancel (cp->respect_iterate_req);
532 cp->respect_iterate_req = NULL;
537 * Function called for each pending request whenever a new
538 * peer connects, giving us a chance to decide about submitting
539 * the existing request to the new peer.
541 * @param cls the `struct GSF_ConnectedPeer` of the new peer
542 * @param key query for the request
543 * @param pr handle to the pending request
544 * @return #GNUNET_YES to continue to iterate
547 consider_peer_for_forwarding (void *cls,
548 const struct GNUNET_HashCode *key,
549 struct GSF_PendingRequest *pr)
551 struct GSF_ConnectedPeer *cp = cls;
552 struct GNUNET_PeerIdentity pid;
555 GSF_pending_request_test_active_ (pr))
556 return GNUNET_YES; /* request is not actually active, skip! */
557 GSF_connected_peer_get_identity_ (cp, &pid);
559 GSF_pending_request_test_target_ (pr, &pid))
561 GNUNET_STATISTICS_update (GSF_stats,
562 gettext_noop ("# Loopback routes suppressed"),
567 GSF_plan_add_ (cp, pr);
573 * A peer connected to us. Setup the connected peer
577 * @param peer identity of peer that connected
578 * @param mq message queue for talking to @a peer
579 * @return our internal handle for the peer
582 GSF_peer_connect_handler (void *cls,
583 const struct GNUNET_PeerIdentity *peer,
584 struct GNUNET_MQ_Handle *mq)
586 struct GSF_ConnectedPeer *cp;
589 GNUNET_CRYPTO_cmp_peer_identity (&GSF_my_id,
592 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
593 "Connected to peer %s\n",
595 cp = GNUNET_new (struct GSF_ConnectedPeer);
596 cp->ppd.pid = GNUNET_PEER_intern (peer);
599 cp->ppd.transmission_delay = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_ZERO);
601 GNUNET_ATS_reserve_bandwidth (GSF_ats,
604 &ats_reserve_callback, cp);
605 cp->request_map = GNUNET_CONTAINER_multihashmap_create (128,
607 GNUNET_break (GNUNET_OK ==
608 GNUNET_CONTAINER_multipeermap_put (cp_map,
609 GSF_connected_peer_get_identity2_ (cp),
611 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
612 GNUNET_STATISTICS_set (GSF_stats,
613 gettext_noop ("# peers connected"),
614 GNUNET_CONTAINER_multipeermap_size (cp_map),
616 cp->respect_iterate_req
617 = GNUNET_PEERSTORE_iterate (peerstore,
623 GSF_iterate_pending_requests_ (&consider_peer_for_forwarding,
630 * It may be time to re-start migrating content to this
631 * peer. Check, and if so, restart migration.
633 * @param cls the `struct GSF_ConnectedPeer`
636 revive_migration (void *cls)
638 struct GSF_ConnectedPeer *cp = cls;
639 struct GNUNET_TIME_Relative bt;
641 cp->mig_revive_task = NULL;
642 bt = GNUNET_TIME_absolute_get_remaining (cp->ppd.migration_blocked_until);
643 if (0 != bt.rel_value_us)
645 /* still time left... */
646 cp->mig_revive_task =
647 GNUNET_SCHEDULER_add_delayed (bt, &revive_migration, cp);
650 GSF_push_start_ (cp);
655 * Get a handle for a connected peer.
657 * @param peer peer's identity
658 * @return NULL if the peer is not currently connected
660 struct GSF_ConnectedPeer *
661 GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer)
665 return GNUNET_CONTAINER_multipeermap_get (cp_map, peer);
670 * Handle P2P #GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP message.
672 * @param cls closure, the `struct GSF_ConnectedPeer`
673 * @param msm the actual message
676 handle_p2p_migration_stop (void *cls,
677 const struct MigrationStopMessage *msm)
679 struct GSF_ConnectedPeer *cp = cls;
680 struct GNUNET_TIME_Relative bt;
682 GNUNET_STATISTICS_update (GSF_stats,
683 gettext_noop ("# migration stop messages received"),
685 bt = GNUNET_TIME_relative_ntoh (msm->duration);
686 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
687 _("Migration of content to peer `%s' blocked for %s\n"),
688 GNUNET_i2s (cp->ppd.peer),
689 GNUNET_STRINGS_relative_time_to_string (bt, GNUNET_YES));
690 cp->ppd.migration_blocked_until = GNUNET_TIME_relative_to_absolute (bt);
691 if ( (NULL == cp->mig_revive_task) &&
692 (NULL == cp->respect_iterate_req) )
695 cp->mig_revive_task =
696 GNUNET_SCHEDULER_add_delayed (bt,
697 &revive_migration, cp);
703 * Free resources associated with the given peer request.
705 * @param peerreq request to free
708 free_pending_request (struct PeerRequest *peerreq)
710 struct GSF_ConnectedPeer *cp = peerreq->cp;
711 struct GSF_PendingRequestData *prd;
713 prd = GSF_pending_request_get_data_ (peerreq->pr);
714 if (NULL != peerreq->kill_task)
716 GNUNET_SCHEDULER_cancel (peerreq->kill_task);
717 peerreq->kill_task = NULL;
719 GNUNET_STATISTICS_update (GSF_stats,
720 gettext_noop ("# P2P searches active"),
723 GNUNET_break (GNUNET_YES ==
724 GNUNET_CONTAINER_multihashmap_remove (cp->request_map,
727 GNUNET_free (peerreq);
732 * Cancel all requests associated with the peer.
735 * @param query hash code of the request
736 * @param value the `struct GSF_PendingRequest`
737 * @return #GNUNET_YES (continue to iterate)
740 cancel_pending_request (void *cls,
741 const struct GNUNET_HashCode *query,
744 struct PeerRequest *peerreq = value;
745 struct GSF_PendingRequest *pr = peerreq->pr;
747 free_pending_request (peerreq);
748 GSF_pending_request_cancel_ (pr,
755 * Free the given request.
757 * @param cls the request to free
760 peer_request_destroy (void *cls)
762 struct PeerRequest *peerreq = cls;
763 struct GSF_PendingRequest *pr = peerreq->pr;
764 struct GSF_PendingRequestData *prd;
766 peerreq->kill_task = NULL;
767 prd = GSF_pending_request_get_data_ (pr);
768 cancel_pending_request (NULL,
775 * The artificial delay is over, transmit the message now.
777 * @param cls the `struct GSF_DelayedHandle` with the message
780 transmit_delayed_now (void *cls)
782 struct GSF_DelayedHandle *dh = cls;
783 struct GSF_ConnectedPeer *cp = dh->cp;
785 GNUNET_CONTAINER_DLL_remove (cp->delayed_head,
788 cp->delay_queue_size--;
789 GSF_peer_transmit_ (cp,
798 * Get the randomized delay a response should be subjected to.
800 * @return desired delay
802 static struct GNUNET_TIME_Relative
803 get_randomized_delay ()
805 struct GNUNET_TIME_Relative ret;
808 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
809 GNUNET_CRYPTO_random_u32
810 (GNUNET_CRYPTO_QUALITY_WEAK,
811 2 * GSF_avg_latency.rel_value_us + 1));
812 #if INSANE_STATISTICS
813 GNUNET_STATISTICS_update (GSF_stats,
815 ("# artificial delays introduced (ms)"),
816 ret.rel_value_us / 1000LL, GNUNET_NO);
823 * Handle a reply to a pending request. Also called if a request
824 * expires (then with data == NULL). The handler may be called
825 * many times (depending on the request type), but will not be
826 * called during or after a call to GSF_pending_request_cancel
827 * and will also not be called anymore after a call signalling
830 * @param cls `struct PeerRequest` this is an answer for
831 * @param eval evaluation of the result
832 * @param pr handle to the original pending request
833 * @param reply_anonymity_level anonymity level for the reply, UINT32_MAX for "unknown"
834 * @param expiration when does @a data expire?
835 * @param last_transmission when did we last transmit a request for this block
836 * @param type type of the block
837 * @param data response data, NULL on request expiration
838 * @param data_len number of bytes in @a data
841 handle_p2p_reply (void *cls,
842 enum GNUNET_BLOCK_EvaluationResult eval,
843 struct GSF_PendingRequest *pr,
844 uint32_t reply_anonymity_level,
845 struct GNUNET_TIME_Absolute expiration,
846 struct GNUNET_TIME_Absolute last_transmission,
847 enum GNUNET_BLOCK_Type type,
851 struct PeerRequest *peerreq = cls;
852 struct GSF_ConnectedPeer *cp = peerreq->cp;
853 struct GSF_PendingRequestData *prd;
854 struct GNUNET_MQ_Envelope *env;
855 struct PutMessage *pm;
858 GNUNET_assert (data_len + sizeof (struct PutMessage) <
859 GNUNET_MAX_MESSAGE_SIZE);
860 GNUNET_assert (peerreq->pr == pr);
861 prd = GSF_pending_request_get_data_ (pr);
864 free_pending_request (peerreq);
867 GNUNET_break (GNUNET_BLOCK_TYPE_ANY != type);
868 if ((prd->type != type) && (GNUNET_BLOCK_TYPE_ANY != prd->type))
870 GNUNET_STATISTICS_update (GSF_stats,
872 ("# replies dropped due to type mismatch"),
876 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
877 "Transmitting result for query `%s' to peer\n",
878 GNUNET_h2s (&prd->query));
879 GNUNET_STATISTICS_update (GSF_stats,
880 gettext_noop ("# replies received for other peers"),
882 msize = sizeof (struct PutMessage) + data_len;
883 if (msize >= GNUNET_MAX_MESSAGE_SIZE)
888 if ((UINT32_MAX != reply_anonymity_level) && (reply_anonymity_level > 1))
890 if (reply_anonymity_level - 1 > GSF_cover_content_count)
892 GNUNET_STATISTICS_update (GSF_stats,
894 ("# replies dropped due to insufficient cover traffic"),
898 GSF_cover_content_count -= (reply_anonymity_level - 1);
901 env = GNUNET_MQ_msg_extra (pm,
903 GNUNET_MESSAGE_TYPE_FS_PUT);
904 pm->type = htonl (type);
905 pm->expiration = GNUNET_TIME_absolute_hton (expiration);
906 GNUNET_memcpy (&pm[1],
909 if ( (UINT32_MAX != reply_anonymity_level) &&
910 (0 != reply_anonymity_level) &&
911 (GNUNET_YES == GSF_enable_randomized_delays) )
913 struct GSF_DelayedHandle *dh;
915 dh = GNUNET_new (struct GSF_DelayedHandle);
919 GNUNET_CONTAINER_DLL_insert (cp->delayed_head,
922 cp->delay_queue_size++;
924 GNUNET_SCHEDULER_add_delayed (get_randomized_delay (),
925 &transmit_delayed_now,
930 GSF_peer_transmit_ (cp,
935 if (GNUNET_BLOCK_EVALUATION_OK_LAST != eval)
937 if (NULL == peerreq->kill_task)
939 GNUNET_STATISTICS_update (GSF_stats,
941 ("# P2P searches destroyed due to ultimate reply"),
945 GNUNET_SCHEDULER_add_now (&peer_request_destroy,
952 * Increase the peer's respect by a value.
954 * @param cp which peer to change the respect value on
955 * @param value is the int value by which the
956 * peer's credit is to be increased or decreased
957 * @returns the actual change in respect (positive or negative)
960 change_peer_respect (struct GSF_ConnectedPeer *cp, int value)
964 GNUNET_assert (NULL != cp);
967 if (cp->ppd.respect + value < cp->ppd.respect)
969 value = UINT32_MAX - cp->ppd.respect;
970 cp->ppd.respect = UINT32_MAX;
973 cp->ppd.respect += value;
977 if (cp->ppd.respect < -value)
979 value = -cp->ppd.respect;
983 cp->ppd.respect += value;
990 * We've received a request with the specified priority. Bound it
991 * according to how much we respect the given peer.
993 * @param prio_in requested priority
994 * @param cp the peer making the request
995 * @return effective priority
998 bound_priority (uint32_t prio_in,
999 struct GSF_ConnectedPeer *cp)
1001 #define N ((double)128.0)
1006 ld = GSF_test_get_load_too_high_ (0);
1007 if (GNUNET_SYSERR == ld)
1009 #if INSANE_STATISTICS
1010 GNUNET_STATISTICS_update (GSF_stats,
1012 ("# requests done for free (low load)"), 1,
1015 return 0; /* excess resources */
1017 if (prio_in > INT32_MAX)
1018 prio_in = INT32_MAX;
1019 ret = -change_peer_respect (cp, -(int) prio_in);
1022 if (ret > GSF_current_priorities + N)
1023 rret = GSF_current_priorities + N;
1026 GSF_current_priorities = (GSF_current_priorities * (N - 1) + rret) / N;
1028 if ((GNUNET_YES == ld) && (ret > 0))
1030 /* try with charging */
1031 ld = GSF_test_get_load_too_high_ (ret);
1033 if (GNUNET_YES == ld)
1035 GNUNET_STATISTICS_update (GSF_stats,
1037 ("# request dropped, priority insufficient"), 1,
1040 change_peer_respect (cp, (int) ret);
1041 return -1; /* not enough resources */
1045 GNUNET_STATISTICS_update (GSF_stats,
1047 ("# requests done for a price (normal load)"), 1,
1056 * The priority level imposes a bound on the maximum
1057 * value for the ttl that can be requested.
1059 * @param ttl_in requested ttl
1060 * @param prio given priority
1061 * @return @a ttl_in if @a ttl_in is below the limit,
1062 * otherwise the ttl-limit for the given @a prio
1065 bound_ttl (int32_t ttl_in,
1068 unsigned long long allowed;
1072 allowed = ((unsigned long long) prio) * TTL_DECREMENT / 1000;
1073 if (ttl_in > allowed)
1075 if (allowed >= (1 << 30))
1084 * Closure for #test_exist_cb().
1086 struct TestExistClosure
1090 * Priority of the incoming request.
1095 * Relative TTL of the incoming request.
1100 * Type of the incoming request.
1102 enum GNUNET_BLOCK_Type type;
1105 * Set to #GNUNET_YES if we are done handling the query.
1113 * Test if the query already exists. If so, merge it, otherwise
1114 * keep `finished` at #GNUNET_NO.
1116 * @param cls our `struct TestExistClosure`
1117 * @param hc the key of the query
1118 * @param value the existing `struct PeerRequest`.
1119 * @return #GNUNET_YES to continue to iterate,
1120 * #GNUNET_NO if we successfully merged
1123 test_exist_cb (void *cls,
1124 const struct GNUNET_HashCode *hc,
1127 struct TestExistClosure *tec = cls;
1128 struct PeerRequest *peerreq = value;
1129 struct GSF_PendingRequest *pr;
1130 struct GSF_PendingRequestData *prd;
1133 prd = GSF_pending_request_get_data_ (pr);
1134 if (prd->type != tec->type)
1136 if (prd->ttl.abs_value_us >=
1137 GNUNET_TIME_absolute_get ().abs_value_us + tec->ttl * 1000LL)
1139 /* existing request has higher TTL, drop new one! */
1140 prd->priority += tec->priority;
1141 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1142 "Have existing request with higher TTL, dropping new request.\n");
1143 GNUNET_STATISTICS_update (GSF_stats,
1145 ("# requests dropped due to higher-TTL request"),
1147 tec->finished = GNUNET_YES;
1150 /* existing request has lower TTL, drop old one! */
1151 tec->priority += prd->priority;
1152 free_pending_request (peerreq);
1153 GSF_pending_request_cancel_ (pr,
1160 * Handle P2P "QUERY" message. Creates the pending request entry
1161 * and sets up all of the data structures to that we will
1162 * process replies properly. Does not initiate forwarding or
1163 * local database lookups.
1165 * @param cls the other peer involved (sender of the message)
1166 * @param gm the GET message
1169 handle_p2p_get (void *cls,
1170 const struct GetMessage *gm)
1172 struct GSF_ConnectedPeer *cps = cls;
1173 struct PeerRequest *peerreq;
1174 struct GSF_PendingRequest *pr;
1175 struct GSF_ConnectedPeer *cp;
1176 const struct GNUNET_PeerIdentity *target;
1177 enum GSF_PendingRequestOptions options;
1180 const struct GNUNET_PeerIdentity *opt;
1183 uint32_t ttl_decrement;
1184 struct TestExistClosure tec;
1185 GNUNET_PEER_Id spid;
1186 const struct GSF_PendingRequestData *prd;
1188 msize = ntohs (gm->header.size);
1189 tec.type = ntohl (gm->type);
1190 bm = ntohl (gm->hash_bitmap);
1198 opt = (const struct GNUNET_PeerIdentity *) &gm[1];
1199 bfsize = msize - sizeof (struct GetMessage) - bits * sizeof (struct GNUNET_PeerIdentity);
1200 GNUNET_STATISTICS_update (GSF_stats,
1202 ("# GET requests received (from other peers)"),
1205 GSF_cover_query_count++;
1206 bm = ntohl (gm->hash_bitmap);
1208 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
1209 cp = GSF_peer_get_ (&opt[bits++]);
1214 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
1215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1216 "Failed to find RETURN-TO peer `%s' in connection set. Dropping query.\n",
1217 GNUNET_i2s (&opt[bits - 1]));
1220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1221 "Failed to find peer `%s' in connection set. Dropping query.\n",
1222 GNUNET_i2s (cps->ppd.peer));
1223 GNUNET_STATISTICS_update (GSF_stats,
1225 ("# requests dropped due to missing reverse route"),
1230 unsigned int queue_size = GNUNET_MQ_get_length (cp->mq);
1231 queue_size += cp->ppd.pending_replies + cp->delay_queue_size;
1232 if (queue_size > MAX_QUEUE_PER_PEER)
1234 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1235 "Peer `%s' has too many replies queued already. Dropping query.\n",
1236 GNUNET_i2s (cps->ppd.peer));
1237 GNUNET_STATISTICS_update (GSF_stats,
1238 gettext_noop ("# requests dropped due to full reply queue"),
1243 /* note that we can really only check load here since otherwise
1244 * peers could find out that we are overloaded by not being
1245 * disconnected after sending us a malformed query... */
1246 tec.priority = bound_priority (ntohl (gm->priority),
1248 if (tec.priority < 0)
1250 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1251 "Dropping query from `%s', this peer is too busy.\n",
1252 GNUNET_i2s (cps->ppd.peer));
1255 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1256 "Received request for `%s' of type %u from peer `%s' with flags %u\n",
1257 GNUNET_h2s (&gm->query),
1258 (unsigned int) tec.type,
1259 GNUNET_i2s (cps->ppd.peer),
1263 (bm & GET_MESSAGE_BIT_TRANSMIT_TO)) ? (&opt[bits++]) : NULL;
1264 options = GSF_PRO_DEFAULTS;
1266 if ((GNUNET_LOAD_get_load (cp->ppd.transmission_delay) > 3 * (1 + tec.priority))
1267 || (GNUNET_LOAD_get_average (cp->ppd.transmission_delay) >
1268 GNUNET_CONSTANTS_MAX_CORK_DELAY.rel_value_us * 2 +
1269 GNUNET_LOAD_get_average (GSF_rt_entry_lifetime)))
1271 /* don't have BW to send to peer, or would likely take longer than we have for it,
1272 * so at best indirect the query */
1274 options |= GSF_PRO_FORWARD_ONLY;
1275 spid = GNUNET_PEER_intern (cps->ppd.peer);
1276 GNUNET_assert (0 != spid);
1278 tec.ttl = bound_ttl (ntohl (gm->ttl),
1280 /* decrement ttl (always) */
1282 2 * TTL_DECREMENT + GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
1284 if ( (tec.ttl < 0) &&
1285 (((int32_t) (tec.ttl - ttl_decrement)) > 0) )
1287 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1288 "Dropping query from `%s' due to TTL underflow (%d - %u).\n",
1289 GNUNET_i2s (cps->ppd.peer),
1292 GNUNET_STATISTICS_update (GSF_stats,
1294 ("# requests dropped due TTL underflow"), 1,
1296 /* integer underflow => drop (should be very rare)! */
1299 tec.ttl -= ttl_decrement;
1301 /* test if the request already exists */
1302 tec.finished = GNUNET_NO;
1303 GNUNET_CONTAINER_multihashmap_get_multiple (cp->request_map,
1307 if (GNUNET_YES == tec.finished)
1308 return; /* merged into existing request, we're done */
1310 peerreq = GNUNET_new (struct PeerRequest);
1312 pr = GSF_pending_request_create_ (options,
1317 ? (const char *) &opt[bits]
1320 ntohl (gm->filter_mutator),
1322 (uint32_t) tec.priority,
1325 GNUNET_PEER_intern (cps->ppd.peer),
1326 NULL, 0, /* replies_seen */
1329 GNUNET_assert (NULL != pr);
1330 prd = GSF_pending_request_get_data_ (pr);
1332 GNUNET_break (GNUNET_OK ==
1333 GNUNET_CONTAINER_multihashmap_put (cp->request_map,
1336 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
1337 GNUNET_STATISTICS_update (GSF_stats,
1338 gettext_noop ("# P2P query messages received and processed"),
1341 GNUNET_STATISTICS_update (GSF_stats,
1342 gettext_noop ("# P2P searches active"),
1345 GSF_pending_request_get_data_ (pr)->has_started = GNUNET_YES;
1346 GSF_local_lookup_ (pr,
1347 &GSF_consider_forwarding,
1353 * Transmit a message to the given peer as soon as possible.
1354 * If the peer disconnects before the transmission can happen,
1355 * the callback is invoked with a `NULL` @a buffer.
1357 * @param cp target peer
1358 * @param is_query is this a query (#GNUNET_YES) or content (#GNUNET_NO) or neither (#GNUNET_SYSERR)
1359 * @param priority how important is this request?
1360 * @param timeout when does this request timeout
1361 * @param size number of bytes we would like to send to the peer
1362 * @param env message to send
1365 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
1368 struct GNUNET_MQ_Envelope *env)
1370 struct GSF_PeerTransmitHandle *pth;
1371 struct GSF_PeerTransmitHandle *pos;
1372 struct GSF_PeerTransmitHandle *prev;
1374 pth = GNUNET_new (struct GSF_PeerTransmitHandle);
1375 pth->transmission_request_start_time = GNUNET_TIME_absolute_get ();
1377 pth->is_query = is_query;
1378 pth->priority = priority;
1380 /* insertion sort (by priority, descending) */
1383 while ((NULL != pos) && (pos->priority > priority))
1388 GNUNET_CONTAINER_DLL_insert_after (cp->pth_head,
1392 if (GNUNET_YES == is_query)
1393 cp->ppd.pending_queries++;
1394 else if (GNUNET_NO == is_query)
1395 cp->ppd.pending_replies++;
1396 schedule_transmission (pth);
1401 * Report on receiving a reply; update the performance record of the given peer.
1403 * @param cp responding peer (will be updated)
1404 * @param request_time time at which the original query was transmitted
1405 * @param request_priority priority of the original request
1408 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
1409 struct GNUNET_TIME_Absolute request_time,
1410 uint32_t request_priority)
1412 struct GNUNET_TIME_Relative delay;
1414 delay = GNUNET_TIME_absolute_get_duration (request_time);
1415 cp->ppd.avg_reply_delay.rel_value_us =
1416 (cp->ppd.avg_reply_delay.rel_value_us * (RUNAVG_DELAY_N - 1) +
1417 delay.rel_value_us) / RUNAVG_DELAY_N;
1418 cp->ppd.avg_priority =
1419 (cp->ppd.avg_priority * (RUNAVG_DELAY_N - 1) +
1420 request_priority) / RUNAVG_DELAY_N;
1425 * Report on receiving a reply in response to an initiating client.
1426 * Remember that this peer is good for this client.
1428 * @param cp responding peer (will be updated)
1429 * @param initiator_client local client on responsible for query
1432 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
1433 struct GSF_LocalClient *initiator_client)
1435 cp->ppd.last_client_replies[cp->last_client_replies_woff++ %
1436 CS2P_SUCCESS_LIST_SIZE] = initiator_client;
1441 * Report on receiving a reply in response to an initiating peer.
1442 * Remember that this peer is good for this initiating peer.
1444 * @param cp responding peer (will be updated)
1445 * @param initiator_peer other peer responsible for query
1448 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
1449 const struct GSF_ConnectedPeer *initiator_peer)
1453 woff = cp->last_p2p_replies_woff % P2P_SUCCESS_LIST_SIZE;
1454 GNUNET_PEER_change_rc (cp->ppd.last_p2p_replies[woff], -1);
1455 cp->ppd.last_p2p_replies[woff] = initiator_peer->ppd.pid;
1456 GNUNET_PEER_change_rc (initiator_peer->ppd.pid, 1);
1457 cp->last_p2p_replies_woff = (woff + 1) % P2P_SUCCESS_LIST_SIZE;
1462 * Write peer-respect information to a file - flush the buffer entry!
1465 * @param key peer identity
1466 * @param value the `struct GSF_ConnectedPeer` to flush
1467 * @return #GNUNET_OK to continue iteration
1470 flush_respect (void *cls,
1471 const struct GNUNET_PeerIdentity *key,
1474 struct GSF_ConnectedPeer *cp = value;
1475 struct GNUNET_PeerIdentity pid;
1477 if (cp->ppd.respect == cp->disk_respect)
1478 return GNUNET_OK; /* unchanged */
1479 GNUNET_assert (0 != cp->ppd.pid);
1480 GNUNET_PEER_resolve (cp->ppd.pid, &pid);
1481 GNUNET_PEERSTORE_store (peerstore, "fs", &pid, "respect", &cp->ppd.respect,
1482 sizeof (cp->ppd.respect),
1483 GNUNET_TIME_UNIT_FOREVER_ABS,
1484 GNUNET_PEERSTORE_STOREOPTION_REPLACE,
1492 * A peer disconnected from us. Tear down the connected peer
1496 * @param peer identity of peer that disconnected
1497 * @param internal_cls the corresponding `struct GSF_ConnectedPeer`
1500 GSF_peer_disconnect_handler (void *cls,
1501 const struct GNUNET_PeerIdentity *peer,
1504 struct GSF_ConnectedPeer *cp = internal_cls;
1505 struct GSF_PeerTransmitHandle *pth;
1506 struct GSF_DelayedHandle *dh;
1509 return; /* must have been disconnect from core with
1510 * 'peer' == my_id, ignore */
1511 flush_respect (NULL,
1514 GNUNET_assert (GNUNET_YES ==
1515 GNUNET_CONTAINER_multipeermap_remove (cp_map,
1518 GNUNET_STATISTICS_set (GSF_stats,
1519 gettext_noop ("# peers connected"),
1520 GNUNET_CONTAINER_multipeermap_size (cp_map),
1522 if (NULL != cp->respect_iterate_req)
1524 GNUNET_PEERSTORE_iterate_cancel (cp->respect_iterate_req);
1525 cp->respect_iterate_req = NULL;
1529 GNUNET_ATS_reserve_bandwidth_cancel (cp->rc);
1532 if (NULL != cp->rc_delay_task)
1534 GNUNET_SCHEDULER_cancel (cp->rc_delay_task);
1535 cp->rc_delay_task = NULL;
1537 GNUNET_CONTAINER_multihashmap_iterate (cp->request_map,
1538 &cancel_pending_request,
1540 GNUNET_CONTAINER_multihashmap_destroy (cp->request_map);
1541 cp->request_map = NULL;
1542 GSF_plan_notify_peer_disconnect_ (cp);
1543 GNUNET_LOAD_value_free (cp->ppd.transmission_delay);
1544 GNUNET_PEER_decrement_rcs (cp->ppd.last_p2p_replies,
1545 P2P_SUCCESS_LIST_SIZE);
1546 memset (cp->ppd.last_p2p_replies,
1548 sizeof (cp->ppd.last_p2p_replies));
1549 GSF_push_stop_ (cp);
1550 while (NULL != (pth = cp->pth_head))
1552 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1555 if (GNUNET_YES == pth->is_query)
1556 GNUNET_assert (0 < cp->ppd.pending_queries--);
1557 else if (GNUNET_NO == pth->is_query)
1558 GNUNET_assert (0 < cp->ppd.pending_replies--);
1561 while (NULL != (dh = cp->delayed_head))
1563 GNUNET_CONTAINER_DLL_remove (cp->delayed_head,
1566 GNUNET_MQ_discard (dh->env);
1567 cp->delay_queue_size--;
1568 GNUNET_SCHEDULER_cancel (dh->delay_task);
1571 GNUNET_PEER_change_rc (cp->ppd.pid, -1);
1572 if (NULL != cp->mig_revive_task)
1574 GNUNET_SCHEDULER_cancel (cp->mig_revive_task);
1575 cp->mig_revive_task = NULL;
1577 GNUNET_break (0 == cp->ppd.pending_queries);
1578 GNUNET_break (0 == cp->ppd.pending_replies);
1584 * Closure for #call_iterator().
1586 struct IterationContext
1589 * Function to call on each entry.
1591 GSF_ConnectedPeerIterator it;
1594 * Closure for @e it.
1601 * Function that calls the callback for each peer.
1603 * @param cls the `struct IterationContext *`
1604 * @param key identity of the peer
1605 * @param value the `struct GSF_ConnectedPeer *`
1606 * @return #GNUNET_YES to continue iteration
1609 call_iterator (void *cls,
1610 const struct GNUNET_PeerIdentity *key,
1613 struct IterationContext *ic = cls;
1614 struct GSF_ConnectedPeer *cp = value;
1624 * Iterate over all connected peers.
1626 * @param it function to call for each peer
1627 * @param it_cls closure for @a it
1630 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
1633 struct IterationContext ic;
1637 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1644 * Obtain the identity of a connected peer.
1646 * @param cp peer to get identity of
1647 * @param id identity to set (written to)
1650 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
1651 struct GNUNET_PeerIdentity *id)
1653 GNUNET_assert (0 != cp->ppd.pid);
1654 GNUNET_PEER_resolve (cp->ppd.pid, id);
1659 * Obtain the identity of a connected peer.
1661 * @param cp peer to get identity of
1662 * @return reference to peer identity, valid until peer disconnects (!)
1664 const struct GNUNET_PeerIdentity *
1665 GSF_connected_peer_get_identity2_ (const struct GSF_ConnectedPeer *cp)
1667 GNUNET_assert (0 != cp->ppd.pid);
1668 return GNUNET_PEER_resolve2 (cp->ppd.pid);
1673 * Ask a peer to stop migrating data to us until the given point
1676 * @param cp peer to ask
1677 * @param block_time until when to block
1680 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
1681 struct GNUNET_TIME_Absolute block_time)
1683 struct GNUNET_MQ_Envelope *env;
1684 struct MigrationStopMessage *msm;
1686 if (cp->last_migration_block.abs_value_us > block_time.abs_value_us)
1688 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1689 "Migration already blocked for another %s\n",
1690 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining
1691 (cp->last_migration_block), GNUNET_YES));
1692 return; /* already blocked */
1694 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Asking to stop migration for %s\n",
1695 GNUNET_STRINGS_relative_time_to_string (GNUNET_TIME_absolute_get_remaining (block_time),
1697 cp->last_migration_block = block_time;
1698 env = GNUNET_MQ_msg (msm,
1699 GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP);
1700 msm->reserved = htonl (0);
1702 = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining
1703 (cp->last_migration_block));
1704 GNUNET_STATISTICS_update (GSF_stats,
1705 gettext_noop ("# migration stop messages sent"),
1708 GSF_peer_transmit_ (cp,
1716 * Notify core about a preference we have for the given peer
1717 * (to allocate more resources towards it). The change will
1718 * be communicated the next time we reserve bandwidth with
1719 * core (not instantly).
1721 * @param cp peer to reserve bandwidth from
1722 * @param pref preference change
1725 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
1728 cp->inc_preference += pref;
1733 * Call this method periodically to flush respect information to disk.
1735 * @param cls closure, not used
1738 cron_flush_respect (void *cls)
1741 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1744 fr_task = GNUNET_SCHEDULER_add_delayed_with_priority (RESPECT_FLUSH_FREQ,
1745 GNUNET_SCHEDULER_PRIORITY_HIGH,
1746 &cron_flush_respect, NULL);
1751 * Initialize peer management subsystem.
1754 GSF_connected_peer_init_ ()
1756 cp_map = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_YES);
1757 peerstore = GNUNET_PEERSTORE_connect (GSF_cfg);
1758 fr_task = GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_HIGH,
1759 &cron_flush_respect, NULL);
1764 * Shutdown peer management subsystem.
1767 GSF_connected_peer_done_ ()
1769 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1772 GNUNET_SCHEDULER_cancel (fr_task);
1774 GNUNET_CONTAINER_multipeermap_destroy (cp_map);
1776 GNUNET_PEERSTORE_disconnect (peerstore,
1783 * Iterator to remove references to LC entry.
1785 * @param cls the `struct GSF_LocalClient *` to look for
1786 * @param key current key code
1787 * @param value value in the hash map (peer entry)
1788 * @return #GNUNET_YES (we should continue to iterate)
1791 clean_local_client (void *cls,
1792 const struct GNUNET_PeerIdentity *key,
1795 const struct GSF_LocalClient *lc = cls;
1796 struct GSF_ConnectedPeer *cp = value;
1799 for (i = 0; i < CS2P_SUCCESS_LIST_SIZE; i++)
1800 if (cp->ppd.last_client_replies[i] == lc)
1801 cp->ppd.last_client_replies[i] = NULL;
1807 * Notification that a local client disconnected. Clean up all of our
1808 * references to the given handle.
1810 * @param lc handle to the local client (henceforth invalid)
1813 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc)
1816 return; /* already cleaned up */
1817 GNUNET_CONTAINER_multipeermap_iterate (cp_map,
1818 &clean_local_client,
1823 /* end of gnunet-service-fs_cp.c */