2 This file is part of GNUnet.
3 (C) 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file fs/gnunet-service-fs_cp.c
23 * @brief API to handle 'connected peers'
24 * @author Christian Grothoff
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"
35 * How often do we flush trust values to disk?
37 #define TRUST_FLUSH_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 5)
40 * After how long do we discard a reply?
42 #define REPLY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
46 * Handle to cancel a transmission request.
48 struct GSF_PeerTransmitHandle
52 * Kept in a doubly-linked list.
54 struct GSF_PeerTransmitHandle *next;
57 * Kept in a doubly-linked list.
59 struct GSF_PeerTransmitHandle *prev;
62 * Handle for an active request for transmission to this
63 * peer, or NULL (if core queue was full).
65 struct GNUNET_CORE_TransmitHandle *cth;
68 * Time when this transmission request was issued.
70 struct GNUNET_TIME_Absolute transmission_request_start_time;
73 * Timeout for this request.
75 struct GNUNET_TIME_Absolute timeout;
78 * Task called on timeout, or 0 for none.
80 GNUNET_SCHEDULER_TaskIdentifier timeout_task;
83 * Function to call to get the actual message.
85 GSF_GetMessageCallback gmc;
88 * Peer this request targets.
90 struct GSF_ConnectedPeer *cp;
98 * Size of the message to be transmitted.
103 * GNUNET_YES if this is a query, GNUNET_NO for content.
108 * Priority of this request.
118 struct GSF_ConnectedPeer
122 * Performance data for this peer.
124 struct GSF_PeerPerformanceData ppd;
127 * Time until when we blocked this peer from migrating
130 struct GNUNET_TIME_Absolute last_migration_block;
133 * Task scheduled to revive migration to this peer.
135 GNUNET_SCHEDULER_TaskIdentifier mig_revive_task;
138 * Messages (replies, queries, content migration) we would like to
139 * send to this peer in the near future. Sorted by priority, head.
141 struct GSF_PeerTransmitHandle *pth_head;
144 * Messages (replies, queries, content migration) we would like to
145 * send to this peer in the near future. Sorted by priority, tail.
147 struct GSF_PeerTransmitHandle *pth_tail;
150 * Migration stop message in our queue, or NULL if we have none pending.
152 struct GSF_PeerTransmitHandle *migration_pth;
155 * Context of our GNUNET_CORE_peer_change_preference call (or NULL).
157 struct GNUNET_CORE_InformationRequestContext *irc;
160 * Task scheduled if we need to retry bandwidth reservation later.
162 GNUNET_SCHEDULER_TaskIdentifier irc_delay_task;
165 * Active requests from this neighbour.
167 struct GNUNET_CONTAINER_MultiHashMap *request_map;
170 * Increase in traffic preference still to be submitted
171 * to the core service for this peer.
173 uint64_t inc_preference;
176 * Trust rating for this peer on disk.
181 * Which offset in "last_p2p_replies" will be updated next?
182 * (we go round-robin).
184 unsigned int last_p2p_replies_woff;
187 * Which offset in "last_client_replies" will be updated next?
188 * (we go round-robin).
190 unsigned int last_client_replies_woff;
193 * Current offset into 'last_request_times' ring buffer.
195 unsigned int last_request_times_off;
198 * GNUNET_YES if we did successfully reserve 32k bandwidth,
207 * Map from peer identities to 'struct GSF_ConnectPeer' entries.
209 static struct GNUNET_CONTAINER_MultiHashMap *cp_map;
212 * Where do we store trust information?
214 static char *trustDirectory;
218 * Get the filename under which we would store the GNUNET_HELLO_Message
219 * for the given host and protocol.
220 * @return filename of the form DIRECTORY/HOSTID
223 get_trust_filename (const struct GNUNET_PeerIdentity *id)
225 struct GNUNET_CRYPTO_HashAsciiEncoded fil;
228 GNUNET_CRYPTO_hash_to_enc (&id->hashPubKey, &fil);
229 GNUNET_asprintf (&fn, "%s%s%s", trustDirectory, DIR_SEPARATOR_STR, &fil);
235 * Find latency information in 'atsi'.
237 * @param atsi performance data
238 * @return connection latency
240 static struct GNUNET_TIME_Relative
241 get_latency (const struct GNUNET_TRANSPORT_ATS_Information *atsi)
244 return GNUNET_TIME_UNIT_SECONDS;
245 while ( (ntohl (atsi->type) != GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR) &&
246 (ntohl (atsi->type) != GNUNET_TRANSPORT_ATS_QUALITY_NET_DELAY) )
248 if (ntohl (atsi->type) == GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR)
251 /* how can we not have latency data? */
252 return GNUNET_TIME_UNIT_SECONDS;
254 return GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
255 ntohl (atsi->value));
260 * Update the performance information kept for the given peer.
262 * @param cp peer record to update
263 * @param atsi transport performance data
266 update_atsi (struct GSF_ConnectedPeer *cp,
267 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
269 struct GNUNET_TIME_Relative latency;
271 latency = get_latency (atsi);
272 GNUNET_LOAD_value_set_decline (cp->ppd.transmission_delay,
274 /* LATER: merge atsi into cp's performance data (if we ever care...) */
279 * Return the performance data record for the given peer
281 * @param cp peer to query
282 * @return performance data record for the peer
284 struct GSF_PeerPerformanceData *
285 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp)
292 * Core is ready to transmit to a peer, get the message.
294 * @param cls the 'struct GSF_PeerTransmitHandle' of the message
295 * @param size number of bytes core is willing to take
296 * @param buf where to copy the message
297 * @return number of bytes copied to buf
300 peer_transmit_ready_cb (void *cls,
304 struct GSF_PeerTransmitHandle *pth = cls;
305 struct GSF_ConnectedPeer *cp;
308 if (pth->timeout_task != GNUNET_SCHEDULER_NO_TASK)
310 GNUNET_SCHEDULER_cancel (pth->timeout_task);
311 pth->timeout_task = GNUNET_SCHEDULER_NO_TASK;
314 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
317 if (GNUNET_YES == pth->is_query)
319 cp->ppd.last_request_times[(cp->last_request_times_off++) % MAX_QUEUE_PER_PEER] = GNUNET_TIME_absolute_get ();
320 GNUNET_assert (0 < cp->ppd.pending_queries--);
322 else if (GNUNET_NO == pth->is_query)
324 GNUNET_assert (0 < cp->ppd.pending_replies--);
326 GNUNET_LOAD_update (cp->ppd.transmission_delay,
327 GNUNET_TIME_absolute_get_duration (pth->transmission_request_start_time).rel_value);
328 ret = pth->gmc (pth->gmc_cls,
336 * Function called by core upon success or failure of our bandwidth reservation request.
338 * @param cls the 'struct GSF_ConnectedPeer' of the peer for which we made the request
339 * @param peer identifies the peer
340 * @param bandwidth_out available amount of outbound bandwidth
341 * @param amount set to the amount that was actually reserved or unreserved;
342 * either the full requested amount or zero (no partial reservations)
343 * @param res_delay if the reservation could not be satisfied (amount was 0), how
344 * long should the client wait until re-trying?
345 * @param preference current traffic preference for the given peer
348 core_reserve_callback (void *cls,
349 const struct GNUNET_PeerIdentity *peer,
350 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
352 struct GNUNET_TIME_Relative res_delay,
353 uint64_t preference);
357 * (re)try to reserve bandwidth from the given peer.
359 * @param cls the 'struct GSF_ConnectedPeer' to reserve from
360 * @param tc scheduler context
363 retry_reservation (void *cls,
364 const struct GNUNET_SCHEDULER_TaskContext *tc)
366 struct GSF_ConnectedPeer *cp = cls;
368 struct GNUNET_PeerIdentity target;
370 GNUNET_PEER_resolve (cp->ppd.pid,
372 cp->irc_delay_task = GNUNET_SCHEDULER_NO_TASK;
373 ip = cp->inc_preference;
374 cp->inc_preference = 0;
375 cp->irc = GNUNET_CORE_peer_change_preference (GSF_core,
377 GNUNET_TIME_UNIT_FOREVER_REL,
378 GNUNET_BANDWIDTH_VALUE_MAX,
381 &core_reserve_callback,
387 * Function called by core upon success or failure of our bandwidth reservation request.
389 * @param cls the 'struct GSF_ConnectedPeer' of the peer for which we made the request
390 * @param peer identifies the peer
391 * @param bandwidth_out available amount of outbound bandwidth
392 * @param amount set to the amount that was actually reserved or unreserved;
393 * either the full requested amount or zero (no partial reservations)
394 * @param res_delay if the reservation could not be satisfied (amount was 0), how
395 * long should the client wait until re-trying?
396 * @param preference current traffic preference for the given peer
399 core_reserve_callback (void *cls,
400 const struct GNUNET_PeerIdentity *peer,
401 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
403 struct GNUNET_TIME_Relative res_delay,
406 struct GSF_ConnectedPeer *cp = cls;
407 struct GSF_PeerTransmitHandle *pth;
412 cp->irc_delay_task = GNUNET_SCHEDULER_add_delayed (res_delay,
417 cp->did_reserve = GNUNET_YES;
419 if ( (NULL != pth) &&
422 /* reservation success, try transmission now! */
423 pth->cth = GNUNET_CORE_notify_transmit_ready (GSF_core,
426 GNUNET_TIME_absolute_get_remaining (pth->timeout),
429 &peer_transmit_ready_cb,
436 * A peer connected to us. Setup the connected peer
439 * @param peer identity of peer that connected
440 * @param atsi performance data for the connection
441 * @return handle to connected peer entry
443 struct GSF_ConnectedPeer *
444 GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
445 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
447 struct GSF_ConnectedPeer *cp;
451 cp = GNUNET_malloc (sizeof (struct GSF_ConnectedPeer));
452 cp->ppd.pid = GNUNET_PEER_intern (peer);
453 cp->ppd.transmission_delay = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_ZERO);
454 cp->irc = GNUNET_CORE_peer_change_preference (GSF_core,
456 GNUNET_TIME_UNIT_FOREVER_REL,
457 GNUNET_BANDWIDTH_VALUE_MAX,
460 &core_reserve_callback,
462 fn = get_trust_filename (peer);
463 if ((GNUNET_DISK_file_test (fn) == GNUNET_YES) &&
464 (sizeof (trust) == GNUNET_DISK_fn_read (fn, &trust, sizeof (trust))))
465 cp->disk_trust = cp->ppd.trust = ntohl (trust);
467 cp->request_map = GNUNET_CONTAINER_multihashmap_create (128);
468 GNUNET_break (GNUNET_OK ==
469 GNUNET_CONTAINER_multihashmap_put (cp_map,
472 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
473 update_atsi (cp, atsi);
474 GSF_push_start_ (cp);
480 * It may be time to re-start migrating content to this
481 * peer. Check, and if so, restart migration.
483 * @param cls the 'struct GSF_ConnectedPeer'
484 * @param tc scheduler context
487 revive_migration (void *cls,
488 const struct GNUNET_SCHEDULER_TaskContext *tc)
490 struct GSF_ConnectedPeer *cp = cls;
491 struct GNUNET_TIME_Relative bt;
493 cp->mig_revive_task = GNUNET_SCHEDULER_NO_TASK;
494 bt = GNUNET_TIME_absolute_get_remaining (cp->ppd.migration_blocked_until);
495 if (0 != bt.rel_value)
497 /* still time left... */
499 = GNUNET_SCHEDULER_add_delayed (bt,
504 GSF_push_start_ (cp);
509 * Get a handle for a connected peer.
511 * @param peer peer's identity
513 struct GSF_ConnectedPeer *
514 GSF_peer_get_ (const struct GNUNET_PeerIdentity *peer)
516 return GNUNET_CONTAINER_multihashmap_get (cp_map,
522 * Handle P2P "MIGRATION_STOP" message.
524 * @param cls closure, always NULL
525 * @param other the other peer involved (sender or receiver, NULL
526 * for loopback messages where we are both sender and receiver)
527 * @param message the actual message
528 * @param atsi performance information
529 * @return GNUNET_OK to keep the connection open,
530 * GNUNET_SYSERR to close it (signal serious error)
533 GSF_handle_p2p_migration_stop_ (void *cls,
534 const struct GNUNET_PeerIdentity *other,
535 const struct GNUNET_MessageHeader *message,
536 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
538 struct GSF_ConnectedPeer *cp;
539 const struct MigrationStopMessage *msm;
540 struct GNUNET_TIME_Relative bt;
542 msm = (const struct MigrationStopMessage*) message;
543 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
550 bt = GNUNET_TIME_relative_ntoh (msm->duration);
551 cp->ppd.migration_blocked_until = GNUNET_TIME_relative_to_absolute (bt);
552 if (cp->mig_revive_task == GNUNET_SCHEDULER_NO_TASK)
556 = GNUNET_SCHEDULER_add_delayed (bt,
560 update_atsi (cp, atsi);
566 * Copy reply and free put message.
568 * @param cls the 'struct PutMessage'
569 * @param buf_size number of bytes available in buf
570 * @param buf where to copy the message, NULL on error (peer disconnect)
571 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
574 copy_reply (void *cls,
578 struct PutMessage *pm = cls;
583 GNUNET_assert (buf_size >= ntohs (pm->header.size));
584 size = ntohs (pm->header.size);
585 memcpy (buf, pm, size);
586 GNUNET_STATISTICS_update (GSF_stats,
587 gettext_noop ("# replies transmitted to other peers"),
594 GNUNET_STATISTICS_update (GSF_stats,
595 gettext_noop ("# replies dropped"),
605 * Handle a reply to a pending request. Also called if a request
606 * expires (then with data == NULL). The handler may be called
607 * many times (depending on the request type), but will not be
608 * called during or after a call to GSF_pending_request_cancel
609 * and will also not be called anymore after a call signalling
612 * @param cls 'struct GSF_ConnectedPeer' of the peer that would
613 * have liked an answer to the request
614 * @param pr handle to the original pending request
615 * @param expiration when does 'data' expire?
616 * @param type type of the block
617 * @param data response data, NULL on request expiration
618 * @param data_len number of bytes in data
621 handle_p2p_reply (void *cls,
622 struct GSF_PendingRequest *pr,
623 struct GNUNET_TIME_Absolute expiration,
624 enum GNUNET_BLOCK_Type type,
628 struct GSF_ConnectedPeer *cp = cls;
629 struct GSF_PendingRequestData *prd;
630 struct PutMessage *pm;
633 prd = GSF_pending_request_get_data_ (pr);
636 GNUNET_STATISTICS_update (GSF_stats,
637 gettext_noop ("# P2P searches active"),
640 GNUNET_break (GNUNET_OK ==
641 GNUNET_CONTAINER_multihashmap_remove (cp->request_map,
646 GNUNET_break (type != GNUNET_BLOCK_TYPE_ANY);
647 if ( (prd->type != type) &&
648 (prd->type != GNUNET_BLOCK_TYPE_ANY) )
654 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
655 "Transmitting result for query `%s'\n",
656 GNUNET_h2s (&prd->query));
658 GNUNET_STATISTICS_update (GSF_stats,
659 gettext_noop ("# replies received for other peers"),
662 msize = sizeof (struct PutMessage) + data_len;
663 if (msize >= GNUNET_SERVER_MAX_MESSAGE_SIZE)
668 pm = GNUNET_malloc (sizeof (msize));
669 pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
670 pm->header.size = htons (msize);
671 pm->type = htonl (type);
672 pm->expiration = GNUNET_TIME_absolute_hton (expiration);
673 memcpy (&pm[1], data, data_len);
674 (void) GSF_peer_transmit_ (cp, GNUNET_NO,
684 * Increase the host credit by a value.
686 * @param cp which peer to change the trust value on
687 * @param value is the int value by which the
688 * host credit is to be increased or decreased
689 * @returns the actual change in trust (positive or negative)
692 change_host_trust (struct GSF_ConnectedPeer *cp, int value)
696 GNUNET_assert (cp != NULL);
699 if (cp->ppd.trust + value < cp->ppd.trust)
701 value = UINT32_MAX - cp->ppd.trust;
702 cp->ppd.trust = UINT32_MAX;
705 cp->ppd.trust += value;
709 if (cp->ppd.trust < -value)
711 value = -cp->ppd.trust;
715 cp->ppd.trust += value;
722 * We've received a request with the specified priority. Bound it
723 * according to how much we trust the given peer.
725 * @param prio_in requested priority
726 * @param cp the peer making the request
727 * @return effective priority
730 bound_priority (uint32_t prio_in,
731 struct GSF_ConnectedPeer *cp)
733 #define N ((double)128.0)
738 ld = GSF_test_get_load_too_high_ (0);
739 if (ld == GNUNET_SYSERR)
741 GNUNET_STATISTICS_update (GSF_stats,
742 gettext_noop ("# requests done for free (low load)"),
745 return 0; /* excess resources */
747 if (prio_in > INT32_MAX)
749 ret = - change_host_trust (cp, - (int) prio_in);
752 if (ret > GSF_current_priorities + N)
753 rret = GSF_current_priorities + N;
756 GSF_current_priorities
757 = (GSF_current_priorities * (N-1) + rret)/N;
759 if ( (ld == GNUNET_YES) && (ret > 0) )
761 /* try with charging */
762 ld = GSF_test_get_load_too_high_ (ret);
764 if (ld == GNUNET_YES)
766 GNUNET_STATISTICS_update (GSF_stats,
767 gettext_noop ("# request dropped, priority insufficient"),
771 change_host_trust (cp, (int) ret);
772 return -1; /* not enough resources */
776 GNUNET_STATISTICS_update (GSF_stats,
777 gettext_noop ("# requests done for a price (normal load)"),
787 * The priority level imposes a bound on the maximum
788 * value for the ttl that can be requested.
790 * @param ttl_in requested ttl
791 * @param prio given priority
792 * @return ttl_in if ttl_in is below the limit,
793 * otherwise the ttl-limit for the given priority
796 bound_ttl (int32_t ttl_in, uint32_t prio)
798 unsigned long long allowed;
802 allowed = ((unsigned long long) prio) * TTL_DECREMENT / 1000;
803 if (ttl_in > allowed)
805 if (allowed >= (1 << 30))
814 * Handle P2P "QUERY" message. Creates the pending request entry
815 * and sets up all of the data structures to that we will
816 * process replies properly. Does not initiate forwarding or
817 * local database lookups.
819 * @param other the other peer involved (sender or receiver, NULL
820 * for loopback messages where we are both sender and receiver)
821 * @param message the actual message
822 * @return pending request handle, NULL on error
824 struct GSF_PendingRequest *
825 GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
826 const struct GNUNET_MessageHeader *message)
828 struct GSF_PendingRequest *pr;
829 struct GSF_PendingRequestData *prd;
830 struct GSF_ConnectedPeer *cp;
831 struct GSF_ConnectedPeer *cps;
832 const GNUNET_HashCode *namespace;
833 const struct GNUNET_PeerIdentity *target;
834 enum GSF_PendingRequestOptions options;
836 const struct GetMessage *gm;
838 const GNUNET_HashCode *opt;
841 uint32_t ttl_decrement;
844 enum GNUNET_BLOCK_Type type;
847 msize = ntohs(message->size);
848 if (msize < sizeof (struct GetMessage))
853 gm = (const struct GetMessage*) message;
855 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
856 "Received request for `%s'\n",
857 GNUNET_h2s (&gm->query));
859 type = ntohl (gm->type);
860 bm = ntohl (gm->hash_bitmap);
868 if (msize < sizeof (struct GetMessage) + bits * sizeof (GNUNET_HashCode))
873 opt = (const GNUNET_HashCode*) &gm[1];
874 bfsize = msize - sizeof (struct GetMessage) - bits * sizeof (GNUNET_HashCode);
875 /* bfsize must be power of 2, check! */
876 if (0 != ( (bfsize - 1) & bfsize))
881 GSF_cover_query_count++;
882 bm = ntohl (gm->hash_bitmap);
884 cps = GNUNET_CONTAINER_multihashmap_get (cp_map,
888 /* peer must have just disconnected */
889 GNUNET_STATISTICS_update (GSF_stats,
890 gettext_noop ("# requests dropped due to initiator not being connected"),
895 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
896 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
903 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
904 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
905 "Failed to find RETURN-TO peer `%4s' in connection set. Dropping query.\n",
906 GNUNET_i2s ((const struct GNUNET_PeerIdentity*) &opt[bits-1]));
909 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
910 "Failed to find peer `%4s' in connection set. Dropping query.\n",
913 GNUNET_STATISTICS_update (GSF_stats,
914 gettext_noop ("# requests dropped due to missing reverse route"),
919 /* note that we can really only check load here since otherwise
920 peers could find out that we are overloaded by not being
921 disconnected after sending us a malformed query... */
922 priority = bound_priority (ntohl (gm->priority), cps);
926 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
927 "Dropping query from `%s', this peer is too busy.\n",
933 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
934 "Received request for `%s' of type %u from peer `%4s' with flags %u\n",
935 GNUNET_h2s (&gm->query),
940 namespace = (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE)) ? &opt[bits++] : NULL;
941 target = (0 != (bm & GET_MESSAGE_BIT_TRANSMIT_TO)) ? ((const struct GNUNET_PeerIdentity*) &opt[bits++]) : NULL;
944 if ( (GNUNET_LOAD_get_load (cp->ppd.transmission_delay) > 3 * (1 + priority)) ||
945 (GNUNET_LOAD_get_average (cp->ppd.transmission_delay) >
946 GNUNET_CONSTANTS_MAX_CORK_DELAY.rel_value * 2 + GNUNET_LOAD_get_average (GSF_rt_entry_lifetime)) )
948 /* don't have BW to send to peer, or would likely take longer than we have for it,
949 so at best indirect the query */
951 options |= GSF_PRO_FORWARD_ONLY;
952 spid = GNUNET_PEER_intern (other);
954 ttl = bound_ttl (ntohl (gm->ttl), priority);
955 /* decrement ttl (always) */
956 ttl_decrement = 2 * TTL_DECREMENT +
957 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
960 (((int32_t)(ttl - ttl_decrement)) > 0) )
963 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
964 "Dropping query from `%s' due to TTL underflow (%d - %u).\n",
969 GNUNET_STATISTICS_update (GSF_stats,
970 gettext_noop ("# requests dropped due TTL underflow"),
973 /* integer underflow => drop (should be very rare)! */
976 ttl -= ttl_decrement;
978 /* test if the request already exists */
979 pr = GNUNET_CONTAINER_multihashmap_get (cp->request_map,
983 prd = GSF_pending_request_get_data_ (pr);
984 if ( (prd->type == type) &&
985 ( (type != GNUNET_BLOCK_TYPE_FS_SBLOCK) ||
986 (0 == memcmp (&prd->namespace,
988 sizeof (GNUNET_HashCode))) ) )
990 if (prd->ttl.abs_value >= GNUNET_TIME_absolute_get().abs_value + ttl)
992 /* existing request has higher TTL, drop new one! */
993 prd->priority += priority;
995 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
996 "Have existing request with higher TTL, dropping new request.\n",
999 GNUNET_STATISTICS_update (GSF_stats,
1000 gettext_noop ("# requests dropped due to higher-TTL request"),
1005 /* existing request has lower TTL, drop old one! */
1006 priority += prd->priority;
1007 GSF_pending_request_cancel_ (pr);
1008 GNUNET_assert (GNUNET_YES ==
1009 GNUNET_CONTAINER_multihashmap_remove (cp->request_map,
1015 pr = GSF_pending_request_create_ (options,
1020 (bfsize > 0) ? (const char*)&opt[bits] : NULL,
1022 ntohl (gm->filter_mutator),
1024 (uint32_t) priority,
1027 NULL, 0, /* replies_seen */
1030 GNUNET_break (GNUNET_OK ==
1031 GNUNET_CONTAINER_multihashmap_put (cp->request_map,
1034 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
1035 GNUNET_STATISTICS_update (GSF_stats,
1036 gettext_noop ("# P2P searches received"),
1039 GNUNET_STATISTICS_update (GSF_stats,
1040 gettext_noop ("# P2P searches active"),
1048 * Function called if there has been a timeout trying to satisfy
1049 * a transmission request.
1051 * @param cls the 'struct GSF_PeerTransmitHandle' of the request
1052 * @param tc scheduler context
1055 peer_transmit_timeout (void *cls,
1056 const struct GNUNET_SCHEDULER_TaskContext *tc)
1058 struct GSF_PeerTransmitHandle *pth = cls;
1059 struct GSF_ConnectedPeer *cp;
1061 pth->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1063 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1066 if (GNUNET_YES == pth->is_query)
1067 GNUNET_assert (0 < cp->ppd.pending_queries--);
1068 else if (GNUNET_NO == pth->is_query)
1069 GNUNET_assert (0 < cp->ppd.pending_replies--);
1070 GNUNET_LOAD_update (cp->ppd.transmission_delay,
1072 pth->gmc (pth->gmc_cls,
1079 * Transmit a message to the given peer as soon as possible.
1080 * If the peer disconnects before the transmission can happen,
1081 * the callback is invoked with a 'NULL' buffer.
1083 * @param cp target peer
1084 * @param is_query is this a query (GNUNET_YES) or content (GNUNET_NO) or neither (GNUNET_SYSERR)
1085 * @param priority how important is this request?
1086 * @param timeout when does this request timeout (call gmc with error)
1087 * @param size number of bytes we would like to send to the peer
1088 * @param gmc function to call to get the message
1089 * @param gmc_cls closure for gmc
1090 * @return handle to cancel request
1092 struct GSF_PeerTransmitHandle *
1093 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
1096 struct GNUNET_TIME_Relative timeout,
1098 GSF_GetMessageCallback gmc,
1101 struct GSF_PeerTransmitHandle *pth;
1102 struct GSF_PeerTransmitHandle *pos;
1103 struct GSF_PeerTransmitHandle *prev;
1104 struct GNUNET_PeerIdentity target;
1108 pth = GNUNET_malloc (sizeof (struct GSF_PeerTransmitHandle));
1109 pth->transmission_request_start_time = GNUNET_TIME_absolute_get ();
1110 pth->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1112 pth->gmc_cls = gmc_cls;
1114 pth->is_query = is_query;
1115 pth->priority = priority;
1117 /* insertion sort (by priority, descending) */
1120 while ( (pos != NULL) &&
1121 (pos->priority > priority) )
1127 GNUNET_CONTAINER_DLL_insert (cp->pth_head,
1131 GNUNET_CONTAINER_DLL_insert_after (cp->pth_head,
1135 GNUNET_PEER_resolve (cp->ppd.pid,
1137 if (GNUNET_YES == is_query)
1139 /* query, need reservation */
1140 cp->ppd.pending_queries++;
1141 if (GNUNET_YES == cp->did_reserve)
1143 cp->did_reserve = GNUNET_NO;
1144 /* reservation already done! */
1145 is_ready = GNUNET_YES;
1146 ip = cp->inc_preference;
1147 cp->inc_preference = 0;
1148 cp->irc = GNUNET_CORE_peer_change_preference (GSF_core,
1150 GNUNET_TIME_UNIT_FOREVER_REL,
1151 GNUNET_BANDWIDTH_VALUE_MAX,
1154 &core_reserve_callback,
1159 /* still waiting for reservation */
1160 is_ready = GNUNET_NO;
1163 else if (GNUNET_NO == is_query)
1165 /* no reservation needed for content */
1166 cp->ppd.pending_replies++;
1167 is_ready = GNUNET_YES;
1171 /* not a query or content, no reservation needed */
1172 is_ready = GNUNET_YES;
1176 pth->cth = GNUNET_CORE_notify_transmit_ready (GSF_core,
1182 &peer_transmit_ready_cb,
1184 /* pth->cth could be NULL here, that's OK, we'll try again
1187 if (pth->cth == NULL)
1189 /* if we're waiting for reservation OR if we could not do notify_transmit_ready,
1190 install a timeout task to be on the safe side */
1191 pth->timeout_task = GNUNET_SCHEDULER_add_delayed (timeout,
1192 &peer_transmit_timeout,
1200 * Cancel an earlier request for transmission.
1202 * @param pth request to cancel
1205 GSF_peer_transmit_cancel_ (struct GSF_PeerTransmitHandle *pth)
1207 struct GSF_ConnectedPeer *cp;
1209 if (pth->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1211 GNUNET_SCHEDULER_cancel (pth->timeout_task);
1212 pth->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1214 if (NULL != pth->cth)
1216 GNUNET_CORE_notify_transmit_ready_cancel (pth->cth);
1220 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1223 if (GNUNET_YES == pth->is_query)
1224 GNUNET_assert (0 < cp->ppd.pending_queries--);
1225 else if (GNUNET_NO == pth->is_query)
1226 GNUNET_assert (0 < cp->ppd.pending_replies--);
1232 * Report on receiving a reply; update the performance record of the given peer.
1234 * @param cp responding peer (will be updated)
1235 * @param request_time time at which the original query was transmitted
1236 * @param request_priority priority of the original request
1239 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
1240 struct GNUNET_TIME_Absolute request_time,
1241 uint32_t request_priority)
1243 struct GNUNET_TIME_Relative delay;
1245 delay = GNUNET_TIME_absolute_get_duration (request_time);
1246 cp->ppd.avg_reply_delay.rel_value = (cp->ppd.avg_reply_delay.rel_value * (RUNAVG_DELAY_N-1) + delay.rel_value) / RUNAVG_DELAY_N;
1247 cp->ppd.avg_priority = (cp->ppd.avg_priority * (RUNAVG_DELAY_N-1) + request_priority) / RUNAVG_DELAY_N;
1252 * Report on receiving a reply in response to an initiating client.
1253 * Remember that this peer is good for this client.
1255 * @param cp responding peer (will be updated)
1256 * @param initiator_client local client on responsible for query
1259 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
1260 struct GSF_LocalClient *initiator_client)
1262 cp->ppd.last_client_replies[cp->last_client_replies_woff++ % CS2P_SUCCESS_LIST_SIZE] = initiator_client;
1267 * Report on receiving a reply in response to an initiating peer.
1268 * Remember that this peer is good for this initiating peer.
1270 * @param cp responding peer (will be updated)
1271 * @param initiator_peer other peer responsible for query
1274 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
1275 const struct GSF_ConnectedPeer *initiator_peer)
1277 GNUNET_PEER_change_rc (cp->ppd.last_p2p_replies[cp->last_p2p_replies_woff % P2P_SUCCESS_LIST_SIZE], -1);
1278 cp->ppd.last_p2p_replies[cp->last_p2p_replies_woff++ % P2P_SUCCESS_LIST_SIZE] = initiator_peer->ppd.pid;
1279 GNUNET_PEER_change_rc (initiator_peer->ppd.pid, 1);
1284 * Method called whenever a given peer has a status change.
1286 * @param cls closure
1287 * @param peer peer identity this notification is about
1288 * @param bandwidth_in available amount of inbound bandwidth
1289 * @param bandwidth_out available amount of outbound bandwidth
1290 * @param timeout absolute time when this peer will time out
1291 * unless we see some further activity from it
1292 * @param atsi status information
1295 GSF_peer_status_handler_ (void *cls,
1296 const struct GNUNET_PeerIdentity *peer,
1297 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1298 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
1299 struct GNUNET_TIME_Absolute timeout,
1300 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
1302 struct GSF_ConnectedPeer *cp;
1304 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
1306 GNUNET_assert (NULL != cp);
1307 update_atsi (cp, atsi);
1312 * Cancel all requests associated with the peer.
1315 * @param query hash code of the request
1316 * @param value the 'struct GSF_PendingRequest'
1317 * @return GNUNET_YES (continue to iterate)
1320 cancel_pending_request (void *cls,
1321 const GNUNET_HashCode *query,
1324 struct GSF_PendingRequest *pr = value;
1326 GSF_pending_request_cancel_ (pr);
1332 * A peer disconnected from us. Tear down the connected peer
1336 * @param peer identity of peer that connected
1339 GSF_peer_disconnect_handler_ (void *cls,
1340 const struct GNUNET_PeerIdentity *peer)
1342 struct GSF_ConnectedPeer *cp;
1343 struct GSF_PeerTransmitHandle *pth;
1345 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
1348 return; /* must have been disconnect from core with
1349 'peer' == my_id, ignore */
1350 GNUNET_CONTAINER_multihashmap_remove (cp_map,
1353 if (NULL != cp->migration_pth)
1355 GSF_peer_transmit_cancel_ (cp->migration_pth);
1356 cp->migration_pth = NULL;
1358 if (NULL != cp->irc)
1360 GNUNET_CORE_peer_change_preference_cancel (cp->irc);
1363 if (GNUNET_SCHEDULER_NO_TASK != cp->irc_delay_task)
1365 GNUNET_SCHEDULER_cancel (cp->irc_delay_task);
1366 cp->irc_delay_task = GNUNET_SCHEDULER_NO_TASK;
1368 GNUNET_CONTAINER_multihashmap_iterate (cp->request_map,
1369 &cancel_pending_request,
1371 GNUNET_CONTAINER_multihashmap_destroy (cp->request_map);
1372 cp->request_map = NULL;
1373 GSF_plan_notify_peer_disconnect_ (cp);
1374 GNUNET_LOAD_value_free (cp->ppd.transmission_delay);
1375 GNUNET_PEER_decrement_rcs (cp->ppd.last_p2p_replies, P2P_SUCCESS_LIST_SIZE);
1376 while (NULL != (pth = cp->pth_head))
1378 if (NULL != pth->cth)
1380 GNUNET_CORE_notify_transmit_ready_cancel (pth->cth);
1383 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1388 GNUNET_PEER_change_rc (cp->ppd.pid, -1);
1389 if (GNUNET_SCHEDULER_NO_TASK != cp->mig_revive_task)
1391 GNUNET_SCHEDULER_cancel (cp->mig_revive_task);
1392 cp->mig_revive_task = GNUNET_SCHEDULER_NO_TASK;
1399 * Closure for 'call_iterator'.
1401 struct IterationContext
1404 * Function to call on each entry.
1406 GSF_ConnectedPeerIterator it;
1416 * Function that calls the callback for each peer.
1418 * @param cls the 'struct IterationContext*'
1419 * @param key identity of the peer
1420 * @param value the 'struct GSF_ConnectedPeer*'
1421 * @return GNUNET_YES to continue iteration
1424 call_iterator (void *cls,
1425 const GNUNET_HashCode *key,
1428 struct IterationContext *ic = cls;
1429 struct GSF_ConnectedPeer *cp = value;
1432 (const struct GNUNET_PeerIdentity*) key,
1440 * Iterate over all connected peers.
1442 * @param it function to call for each peer
1443 * @param it_cls closure for it
1446 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
1449 struct IterationContext ic;
1453 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1460 * Obtain the identity of a connected peer.
1462 * @param cp peer to reserve bandwidth from
1463 * @param id identity to set (written to)
1466 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
1467 struct GNUNET_PeerIdentity *id)
1469 GNUNET_PEER_resolve (cp->ppd.pid,
1475 * Assemble a migration stop message for transmission.
1477 * @param cls the 'struct GSF_ConnectedPeer' to use
1478 * @param size number of bytes we're allowed to write to buf
1479 * @param buf where to copy the message
1480 * @return number of bytes copied to buf
1483 create_migration_stop_message (void *cls,
1487 struct GSF_ConnectedPeer *cp = cls;
1488 struct MigrationStopMessage msm;
1490 cp->migration_pth = NULL;
1493 GNUNET_assert (size > sizeof (struct MigrationStopMessage));
1494 msm.header.size = htons (sizeof (struct MigrationStopMessage));
1495 msm.header.type = htons (GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP);
1496 msm.duration = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining (cp->last_migration_block));
1497 memcpy (buf, &msm, sizeof (struct MigrationStopMessage));
1498 return sizeof (struct MigrationStopMessage);
1503 * Ask a peer to stop migrating data to us until the given point
1506 * @param cp peer to ask
1507 * @param block_time until when to block
1510 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
1511 struct GNUNET_TIME_Relative block_time)
1513 if (GNUNET_TIME_absolute_get_duration (cp->last_migration_block).rel_value > block_time.rel_value)
1514 return; /* already blocked */
1515 cp->last_migration_block = GNUNET_TIME_relative_to_absolute (block_time);
1516 if (cp->migration_pth != NULL)
1517 GSF_peer_transmit_cancel_ (cp->migration_pth);
1519 = GSF_peer_transmit_ (cp,
1522 GNUNET_TIME_UNIT_FOREVER_REL,
1523 sizeof (struct MigrationStopMessage),
1524 &create_migration_stop_message,
1530 * Write host-trust information to a file - flush the buffer entry!
1532 * @param cls closure, not used
1533 * @param key host identity
1534 * @param value the 'struct GSF_ConnectedPeer' to flush
1535 * @return GNUNET_OK to continue iteration
1538 flush_trust (void *cls,
1539 const GNUNET_HashCode *key,
1542 struct GSF_ConnectedPeer *cp = value;
1545 struct GNUNET_PeerIdentity pid;
1547 if (cp->ppd.trust == cp->disk_trust)
1548 return GNUNET_OK; /* unchanged */
1549 GNUNET_PEER_resolve (cp->ppd.pid,
1551 fn = get_trust_filename (&pid);
1552 if (cp->ppd.trust == 0)
1554 if ((0 != UNLINK (fn)) && (errno != ENOENT))
1555 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
1556 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
1560 trust = htonl (cp->ppd.trust);
1561 if (sizeof(uint32_t) == GNUNET_DISK_fn_write (fn, &trust,
1563 GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE
1564 | GNUNET_DISK_PERM_GROUP_READ | GNUNET_DISK_PERM_OTHER_READ))
1565 cp->disk_trust = cp->ppd.trust;
1573 * Notify core about a preference we have for the given peer
1574 * (to allocate more resources towards it). The change will
1575 * be communicated the next time we reserve bandwidth with
1576 * core (not instantly).
1578 * @param cp peer to reserve bandwidth from
1579 * @param pref preference change
1582 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
1585 cp->inc_preference += pref;
1590 * Call this method periodically to flush trust information to disk.
1592 * @param cls closure, not used
1593 * @param tc task context, not used
1596 cron_flush_trust (void *cls,
1597 const struct GNUNET_SCHEDULER_TaskContext *tc)
1602 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1607 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1609 GNUNET_SCHEDULER_add_delayed (TRUST_FLUSH_FREQ,
1616 * Initialize peer management subsystem.
1619 GSF_connected_peer_init_ ()
1621 cp_map = GNUNET_CONTAINER_multihashmap_create (128);
1622 GNUNET_assert (GNUNET_OK ==
1623 GNUNET_CONFIGURATION_get_value_filename (GSF_cfg,
1627 GNUNET_DISK_directory_create (trustDirectory);
1628 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_HIGH,
1629 &cron_flush_trust, NULL);
1634 * Iterator to free peer entries.
1636 * @param cls closure, unused
1637 * @param key current key code
1638 * @param value value in the hash map (peer entry)
1639 * @return GNUNET_YES (we should continue to iterate)
1642 clean_peer (void *cls,
1643 const GNUNET_HashCode * key,
1646 GSF_peer_disconnect_handler_ (NULL,
1647 (const struct GNUNET_PeerIdentity*) key);
1653 * Shutdown peer management subsystem.
1656 GSF_connected_peer_done_ ()
1658 cron_flush_trust (NULL, NULL);
1659 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1662 GNUNET_CONTAINER_multihashmap_destroy (cp_map);
1664 GNUNET_free (trustDirectory);
1665 trustDirectory = NULL;
1670 * Iterator to remove references to LC entry.
1672 * @param cls the 'struct GSF_LocalClient*' to look for
1673 * @param key current key code
1674 * @param value value in the hash map (peer entry)
1675 * @return GNUNET_YES (we should continue to iterate)
1678 clean_local_client (void *cls,
1679 const GNUNET_HashCode * key,
1682 const struct GSF_LocalClient *lc = cls;
1683 struct GSF_ConnectedPeer *cp = value;
1686 for (i=0;i<CS2P_SUCCESS_LIST_SIZE;i++)
1687 if (cp->ppd.last_client_replies[i] == lc)
1688 cp->ppd.last_client_replies[i] = NULL;
1694 * Notification that a local client disconnected. Clean up all of our
1695 * references to the given handle.
1697 * @param lc handle to the local client (henceforth invalid)
1700 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc)
1703 return; /* already cleaned up */
1704 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1705 &clean_local_client,
1710 /* end of gnunet-service-fs_cp.c */