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).
156 * NULL if we have successfully reserved 32k, otherwise non-NULL.
158 struct GNUNET_CORE_InformationRequestContext *irc;
161 * Active requests from this neighbour.
163 struct GNUNET_CONTAINER_MultiHashMap *request_map;
166 * Increase in traffic preference still to be submitted
167 * to the core service for this peer.
169 uint64_t inc_preference;
172 * Trust rating for this peer on disk.
177 * Which offset in "last_p2p_replies" will be updated next?
178 * (we go round-robin).
180 unsigned int last_p2p_replies_woff;
183 * Which offset in "last_client_replies" will be updated next?
184 * (we go round-robin).
186 unsigned int last_client_replies_woff;
189 * Current offset into 'last_request_times' ring buffer.
191 unsigned int last_request_times_off;
197 * Map from peer identities to 'struct GSF_ConnectPeer' entries.
199 static struct GNUNET_CONTAINER_MultiHashMap *cp_map;
202 * Where do we store trust information?
204 static char *trustDirectory;
208 * Get the filename under which we would store the GNUNET_HELLO_Message
209 * for the given host and protocol.
210 * @return filename of the form DIRECTORY/HOSTID
213 get_trust_filename (const struct GNUNET_PeerIdentity *id)
215 struct GNUNET_CRYPTO_HashAsciiEncoded fil;
218 GNUNET_CRYPTO_hash_to_enc (&id->hashPubKey, &fil);
219 GNUNET_asprintf (&fn, "%s%s%s", trustDirectory, DIR_SEPARATOR_STR, &fil);
225 * Find latency information in 'atsi'.
227 * @param atsi performance data
228 * @return connection latency
230 static struct GNUNET_TIME_Relative
231 get_latency (const struct GNUNET_TRANSPORT_ATS_Information *atsi)
234 return GNUNET_TIME_UNIT_SECONDS;
235 while ( (ntohl (atsi->type) != GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR) &&
236 (ntohl (atsi->type) != GNUNET_TRANSPORT_ATS_QUALITY_NET_DELAY) )
238 if (ntohl (atsi->type) == GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR)
241 /* how can we not have latency data? */
242 return GNUNET_TIME_UNIT_SECONDS;
244 return GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MILLISECONDS,
245 ntohl (atsi->value));
250 * Update the performance information kept for the given peer.
252 * @param cp peer record to update
253 * @param atsi transport performance data
256 update_atsi (struct GSF_ConnectedPeer *cp,
257 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
259 struct GNUNET_TIME_Relative latency;
261 latency = get_latency (atsi);
262 GNUNET_LOAD_value_set_decline (cp->ppd.transmission_delay,
264 /* LATER: merge atsi into cp's performance data (if we ever care...) */
269 * Return the performance data record for the given peer
271 * @param cp peer to query
272 * @return performance data record for the peer
274 struct GSF_PeerPerformanceData *
275 GSF_get_peer_performance_data_ (struct GSF_ConnectedPeer *cp)
282 * Core is ready to transmit to a peer, get the message.
284 * @param cls the 'struct GSF_PeerTransmitHandle' of the message
285 * @param size number of bytes core is willing to take
286 * @param buf where to copy the message
287 * @return number of bytes copied to buf
290 peer_transmit_ready_cb (void *cls,
294 struct GSF_PeerTransmitHandle *pth = cls;
295 struct GSF_ConnectedPeer *cp;
298 if (pth->timeout_task != GNUNET_SCHEDULER_NO_TASK)
300 GNUNET_SCHEDULER_cancel (pth->timeout_task);
301 pth->timeout_task = GNUNET_SCHEDULER_NO_TASK;
304 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
307 if (GNUNET_YES == pth->is_query)
309 cp->ppd.last_request_times[(cp->last_request_times_off++) % MAX_QUEUE_PER_PEER] = GNUNET_TIME_absolute_get ();
310 GNUNET_assert (0 < cp->ppd.pending_queries--);
312 else if (GNUNET_NO == pth->is_query)
314 GNUNET_assert (0 < cp->ppd.pending_replies--);
316 GNUNET_LOAD_update (cp->ppd.transmission_delay,
317 GNUNET_TIME_absolute_get_duration (pth->transmission_request_start_time).rel_value);
318 ret = pth->gmc (pth->gmc_cls,
326 * Function called by core upon success or failure of our bandwidth reservation request.
328 * @param cls the 'struct GSF_ConnectedPeer' of the peer for which we made the request
329 * @param peer identifies the peer
330 * @param bandwidth_out available amount of outbound bandwidth
331 * @param amount set to the amount that was actually reserved or unreserved;
332 * either the full requested amount or zero (no partial reservations)
333 * @param preference current traffic preference for the given peer
336 core_reserve_callback (void *cls,
337 const struct GNUNET_PeerIdentity *peer,
338 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
342 struct GSF_ConnectedPeer *cp = cls;
343 struct GSF_PeerTransmitHandle *pth;
349 /* failed; retry! (how did we get here!?) */
350 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
351 _("Failed to reserve bandwidth to peer `%s'\n"),
353 ip = cp->inc_preference;
354 cp->inc_preference = 0;
355 cp->irc = GNUNET_CORE_peer_change_preference (GSF_core,
357 GNUNET_TIME_UNIT_FOREVER_REL,
358 GNUNET_BANDWIDTH_VALUE_MAX,
361 &core_reserve_callback,
366 if ( (NULL != pth) &&
369 /* reservation success, try transmission now! */
370 pth->cth = GNUNET_CORE_notify_transmit_ready (GSF_core,
372 GNUNET_TIME_absolute_get_remaining (pth->timeout),
375 &peer_transmit_ready_cb,
382 * A peer connected to us. Setup the connected peer
385 * @param peer identity of peer that connected
386 * @param atsi performance data for the connection
387 * @return handle to connected peer entry
389 struct GSF_ConnectedPeer *
390 GSF_peer_connect_handler_ (const struct GNUNET_PeerIdentity *peer,
391 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
393 struct GSF_ConnectedPeer *cp;
397 cp = GNUNET_malloc (sizeof (struct GSF_ConnectedPeer));
398 cp->ppd.pid = GNUNET_PEER_intern (peer);
399 cp->ppd.transmission_delay = GNUNET_LOAD_value_init (GNUNET_TIME_UNIT_ZERO);
400 cp->irc = GNUNET_CORE_peer_change_preference (GSF_core,
402 GNUNET_TIME_UNIT_FOREVER_REL,
403 GNUNET_BANDWIDTH_VALUE_MAX,
406 &core_reserve_callback,
408 fn = get_trust_filename (peer);
409 if ((GNUNET_DISK_file_test (fn) == GNUNET_YES) &&
410 (sizeof (trust) == GNUNET_DISK_fn_read (fn, &trust, sizeof (trust))))
411 cp->disk_trust = cp->ppd.trust = ntohl (trust);
413 cp->request_map = GNUNET_CONTAINER_multihashmap_create (128);
414 GNUNET_break (GNUNET_OK ==
415 GNUNET_CONTAINER_multihashmap_put (cp_map,
418 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
419 update_atsi (cp, atsi);
420 GSF_push_start_ (cp);
426 * It may be time to re-start migrating content to this
427 * peer. Check, and if so, restart migration.
429 * @param cls the 'struct GSF_ConnectedPeer'
430 * @param tc scheduler context
433 revive_migration (void *cls,
434 const struct GNUNET_SCHEDULER_TaskContext *tc)
436 struct GSF_ConnectedPeer *cp = cls;
437 struct GNUNET_TIME_Relative bt;
439 cp->mig_revive_task = GNUNET_SCHEDULER_NO_TASK;
440 bt = GNUNET_TIME_absolute_get_remaining (cp->ppd.migration_blocked_until);
441 if (0 != bt.rel_value)
443 /* still time left... */
445 = GNUNET_SCHEDULER_add_delayed (bt,
450 GSF_push_start_ (cp);
455 * Handle P2P "MIGRATION_STOP" message.
457 * @param cls closure, always NULL
458 * @param other the other peer involved (sender or receiver, NULL
459 * for loopback messages where we are both sender and receiver)
460 * @param message the actual message
461 * @param atsi performance information
462 * @return GNUNET_OK to keep the connection open,
463 * GNUNET_SYSERR to close it (signal serious error)
466 GSF_handle_p2p_migration_stop_ (void *cls,
467 const struct GNUNET_PeerIdentity *other,
468 const struct GNUNET_MessageHeader *message,
469 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
471 struct GSF_ConnectedPeer *cp;
472 const struct MigrationStopMessage *msm;
473 struct GNUNET_TIME_Relative bt;
475 msm = (const struct MigrationStopMessage*) message;
476 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
483 bt = GNUNET_TIME_relative_ntoh (msm->duration);
484 cp->ppd.migration_blocked_until = GNUNET_TIME_relative_to_absolute (bt);
485 if (cp->mig_revive_task == GNUNET_SCHEDULER_NO_TASK)
489 = GNUNET_SCHEDULER_add_delayed (bt,
493 update_atsi (cp, atsi);
499 * Copy reply and free put message.
501 * @param cls the 'struct PutMessage'
502 * @param buf_size number of bytes available in buf
503 * @param buf where to copy the message, NULL on error (peer disconnect)
504 * @return number of bytes copied to 'buf', can be 0 (without indicating an error)
507 copy_reply (void *cls,
511 struct PutMessage *pm = cls;
516 GNUNET_assert (buf_size >= ntohs (pm->header.size));
517 size = ntohs (pm->header.size);
518 memcpy (buf, pm, size);
519 GNUNET_STATISTICS_update (GSF_stats,
520 gettext_noop ("# replies transmitted to other peers"),
527 GNUNET_STATISTICS_update (GSF_stats,
528 gettext_noop ("# replies dropped"),
538 * Handle a reply to a pending request. Also called if a request
539 * expires (then with data == NULL). The handler may be called
540 * many times (depending on the request type), but will not be
541 * called during or after a call to GSF_pending_request_cancel
542 * and will also not be called anymore after a call signalling
545 * @param cls 'struct GSF_ConnectedPeer' of the peer that would
546 * have liked an answer to the request
547 * @param pr handle to the original pending request
548 * @param expiration when does 'data' expire?
549 * @param data response data, NULL on request expiration
550 * @param data_len number of bytes in data
551 * @param more GNUNET_YES if the request remains active (may call
552 * this function again), GNUNET_NO if the request is
553 * finished (client must not call GSF_pending_request_cancel_)
556 handle_p2p_reply (void *cls,
557 struct GSF_PendingRequest *pr,
558 struct GNUNET_TIME_Absolute expiration,
563 struct GSF_ConnectedPeer *cp = cls;
564 struct GSF_PendingRequestData *prd;
565 struct PutMessage *pm;
568 prd = GSF_pending_request_get_data_ (pr);
571 GNUNET_assert (GNUNET_NO == more);
572 GNUNET_STATISTICS_update (GSF_stats,
573 gettext_noop ("# P2P searches active"),
576 GNUNET_break (GNUNET_OK ==
577 GNUNET_CONTAINER_multihashmap_remove (cp->request_map,
583 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
584 "Transmitting result for query `%s'\n",
587 GNUNET_STATISTICS_update (GSF_stats,
588 gettext_noop ("# replies received for other peers"),
591 msize = sizeof (struct PutMessage) + data_len;
592 pm = GNUNET_malloc (sizeof (msize));
593 pm->header.type = htons (GNUNET_MESSAGE_TYPE_FS_PUT);
594 pm->header.size = htons (msize);
595 pm->type = htonl (prd->type);
596 pm->expiration = GNUNET_TIME_absolute_hton (expiration);
597 memcpy (&pm[1], data, data_len);
598 (void) GSF_peer_transmit_ (cp, GNUNET_NO,
608 * Test if the DATABASE (GET) load on this peer is too high
609 * to even consider processing the query at
612 * @return GNUNET_YES if the load is too high to do anything (load high)
613 * GNUNET_NO to process normally (load normal)
614 * GNUNET_SYSERR to process for free (load low)
617 test_get_load_too_high (uint32_t priority)
622 ld = GNUNET_LOAD_get_load (datastore_get_load);
624 return GNUNET_SYSERR;
629 return GNUNET_SYSERR;
635 * Increase the host credit by a value.
637 * @param cp which peer to change the trust value on
638 * @param value is the int value by which the
639 * host credit is to be increased or decreased
640 * @returns the actual change in trust (positive or negative)
643 change_host_trust (struct GSF_ConnectedPeer *cp, int value)
647 GNUNET_assert (cp != NULL);
650 if (cp->ppd.trust + value < cp->ppd.trust)
652 value = UINT32_MAX - cp->ppd.trust;
653 cp->ppd.trust = UINT32_MAX;
656 cp->ppd.trust += value;
660 if (cp->ppd.trust < -value)
662 value = -cp->ppd.trust;
666 cp->ppd.trust += value;
673 * We've received a request with the specified priority. Bound it
674 * according to how much we trust the given peer.
676 * @param prio_in requested priority
677 * @param cp the peer making the request
678 * @return effective priority
681 bound_priority (uint32_t prio_in,
682 struct GSF_ConnectedPeer *cp)
684 #define N ((double)128.0)
689 ld = test_get_load_too_high (0);
690 if (ld == GNUNET_SYSERR)
692 GNUNET_STATISTICS_update (GSF_stats,
693 gettext_noop ("# requests done for free (low load)"),
696 return 0; /* excess resources */
698 if (prio_in > INT32_MAX)
700 ret = - change_host_trust (cp, - (int) prio_in);
703 if (ret > GSF_current_priorities + N)
704 rret = GSF_current_priorities + N;
707 GSF_current_priorities
708 = (GSF_current_priorities * (N-1) + rret)/N;
710 if ( (ld == GNUNET_YES) && (ret > 0) )
712 /* try with charging */
713 ld = test_get_load_too_high (ret);
715 if (ld == GNUNET_YES)
717 GNUNET_STATISTICS_update (GSF_stats,
718 gettext_noop ("# request dropped, priority insufficient"),
722 change_host_trust (cp, (int) ret);
723 return -1; /* not enough resources */
727 GNUNET_STATISTICS_update (GSF_stats,
728 gettext_noop ("# requests done for a price (normal load)"),
738 * The priority level imposes a bound on the maximum
739 * value for the ttl that can be requested.
741 * @param ttl_in requested ttl
742 * @param prio given priority
743 * @return ttl_in if ttl_in is below the limit,
744 * otherwise the ttl-limit for the given priority
747 bound_ttl (int32_t ttl_in, uint32_t prio)
749 unsigned long long allowed;
753 allowed = ((unsigned long long) prio) * TTL_DECREMENT / 1000;
754 if (ttl_in > allowed)
756 if (allowed >= (1 << 30))
765 * Handle P2P "QUERY" message. Creates the pending request entry
766 * and sets up all of the data structures to that we will
767 * process replies properly. Does not initiate forwarding or
768 * local database lookups.
770 * @param other the other peer involved (sender or receiver, NULL
771 * for loopback messages where we are both sender and receiver)
772 * @param message the actual message
773 * @return pending request handle, NULL on error
775 struct GSF_PendingRequest *
776 GSF_handle_p2p_query_ (const struct GNUNET_PeerIdentity *other,
777 const struct GNUNET_MessageHeader *message)
779 struct GSF_PendingRequest *pr;
780 struct GSF_PendingRequestData *prd;
781 struct GSF_ConnectedPeer *cp;
782 struct GSF_ConnectedPeer *cps;
783 const GNUNET_HashCode *namespace;
784 const struct GNUNET_PeerIdentity *target;
785 enum GSF_PendingRequestOptions options;
787 const struct GetMessage *gm;
789 const GNUNET_HashCode *opt;
792 uint32_t ttl_decrement;
795 enum GNUNET_BLOCK_Type type;
798 msize = ntohs(message->size);
799 if (msize < sizeof (struct GetMessage))
804 gm = (const struct GetMessage*) message;
806 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
807 "Received request for `%s'\n",
808 GNUNET_h2s (&gm->query));
810 type = ntohl (gm->type);
811 bm = ntohl (gm->hash_bitmap);
819 if (msize < sizeof (struct GetMessage) + bits * sizeof (GNUNET_HashCode))
824 opt = (const GNUNET_HashCode*) &gm[1];
825 bfsize = msize - sizeof (struct GetMessage) - bits * sizeof (GNUNET_HashCode);
826 /* bfsize must be power of 2, check! */
827 if (0 != ( (bfsize - 1) & bfsize))
832 GSF_cover_query_count++;
833 bm = ntohl (gm->hash_bitmap);
835 cps = GNUNET_CONTAINER_multihashmap_get (cp_map,
839 /* peer must have just disconnected */
840 GNUNET_STATISTICS_update (GSF_stats,
841 gettext_noop ("# requests dropped due to initiator not being connected"),
846 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
847 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
854 if (0 != (bm & GET_MESSAGE_BIT_RETURN_TO))
855 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
856 "Failed to find RETURN-TO peer `%4s' in connection set. Dropping query.\n",
857 GNUNET_i2s ((const struct GNUNET_PeerIdentity*) &opt[bits-1]));
860 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
861 "Failed to find peer `%4s' in connection set. Dropping query.\n",
864 GNUNET_STATISTICS_update (GSF_stats,
865 gettext_noop ("# requests dropped due to missing reverse route"),
870 /* note that we can really only check load here since otherwise
871 peers could find out that we are overloaded by not being
872 disconnected after sending us a malformed query... */
873 priority = bound_priority (ntohl (gm->priority), cps);
877 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
878 "Dropping query from `%s', this peer is too busy.\n",
884 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
885 "Received request for `%s' of type %u from peer `%4s' with flags %u\n",
886 GNUNET_h2s (&gm->query),
891 namespace = (0 != (bm & GET_MESSAGE_BIT_SKS_NAMESPACE)) ? &opt[bits++] : NULL;
892 target = (0 != (bm & GET_MESSAGE_BIT_TRANSMIT_TO)) ? ((const struct GNUNET_PeerIdentity*) &opt[bits++]) : NULL;
894 if ( (GNUNET_LOAD_get_load (cp->ppd.transmission_delay) > 3 * (1 + priority)) ||
895 (GNUNET_LOAD_get_average (cp->ppd.transmission_delay) >
896 GNUNET_CONSTANTS_MAX_CORK_DELAY.rel_value * 2 + GNUNET_LOAD_get_average (GSF_rt_entry_lifetime)) )
898 /* don't have BW to send to peer, or would likely take longer than we have for it,
899 so at best indirect the query */
901 options |= GSF_PRO_FORWARD_ONLY;
903 ttl = bound_ttl (ntohl (gm->ttl), priority);
904 /* decrement ttl (always) */
905 ttl_decrement = 2 * TTL_DECREMENT +
906 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
909 (((int32_t)(ttl - ttl_decrement)) > 0) )
912 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
913 "Dropping query from `%s' due to TTL underflow (%d - %u).\n",
918 GNUNET_STATISTICS_update (GSF_stats,
919 gettext_noop ("# requests dropped due TTL underflow"),
922 /* integer underflow => drop (should be very rare)! */
925 ttl -= ttl_decrement;
927 /* test if the request already exists */
928 pr = GNUNET_CONTAINER_multihashmap_get (cp->request_map,
932 prd = GSF_pending_request_get_data_ (pr);
933 if ( (prd->type == type) &&
934 ( (type != GNUNET_BLOCK_TYPE_FS_SBLOCK) ||
935 (0 == memcmp (&prd->namespace,
937 sizeof (GNUNET_HashCode))) ) )
939 if (prd->ttl.abs_value >= GNUNET_TIME_absolute_get().abs_value + ttl)
941 /* existing request has higher TTL, drop new one! */
942 prd->priority += priority;
944 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
945 "Have existing request with higher TTL, dropping new request.\n",
948 GNUNET_STATISTICS_update (GSF_stats,
949 gettext_noop ("# requests dropped due to higher-TTL request"),
954 /* existing request has lower TTL, drop old one! */
955 priority += prd->priority;
956 GSF_pending_request_cancel_ (pr);
957 GNUNET_assert (GNUNET_YES ==
958 GNUNET_CONTAINER_multihashmap_remove (cp->request_map,
964 pr = GSF_pending_request_create_ (options,
969 (bfsize > 0) ? (const char*)&opt[bits] : NULL,
971 ntohl (gm->filter_mutator),
975 NULL, 0, /* replies_seen */
978 GNUNET_break (GNUNET_OK ==
979 GNUNET_CONTAINER_multihashmap_put (cp->request_map,
982 GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
983 GNUNET_STATISTICS_update (GSF_stats,
984 gettext_noop ("# P2P searches received"),
987 GNUNET_STATISTICS_update (GSF_stats,
988 gettext_noop ("# P2P searches active"),
996 * Function called if there has been a timeout trying to satisfy
997 * a transmission request.
999 * @param cls the 'struct GSF_PeerTransmitHandle' of the request
1000 * @param tc scheduler context
1003 peer_transmit_timeout (void *cls,
1004 const struct GNUNET_SCHEDULER_TaskContext *tc)
1006 struct GSF_PeerTransmitHandle *pth = cls;
1007 struct GSF_ConnectedPeer *cp;
1009 pth->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1011 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1014 if (GNUNET_YES == pth->is_query)
1015 GNUNET_assert (0 < cp->ppd.pending_queries--);
1016 else if (GNUNET_NO == pth->is_query)
1017 GNUNET_assert (0 < cp->ppd.pending_replies--);
1018 GNUNET_LOAD_update (cp->ppd.transmission_delay,
1020 pth->gmc (pth->gmc_cls,
1027 * Transmit a message to the given peer as soon as possible.
1028 * If the peer disconnects before the transmission can happen,
1029 * the callback is invoked with a 'NULL' buffer.
1031 * @param cp target peer
1032 * @param is_query is this a query (GNUNET_YES) or content (GNUNET_NO) or neither (GNUNET_SYSERR)
1033 * @param priority how important is this request?
1034 * @param timeout when does this request timeout (call gmc with error)
1035 * @param size number of bytes we would like to send to the peer
1036 * @param gmc function to call to get the message
1037 * @param gmc_cls closure for gmc
1038 * @return handle to cancel request
1040 struct GSF_PeerTransmitHandle *
1041 GSF_peer_transmit_ (struct GSF_ConnectedPeer *cp,
1044 struct GNUNET_TIME_Relative timeout,
1046 GSF_GetMessageCallback gmc,
1049 struct GSF_PeerTransmitHandle *pth;
1050 struct GSF_PeerTransmitHandle *pos;
1051 struct GSF_PeerTransmitHandle *prev;
1052 struct GNUNET_PeerIdentity target;
1056 pth = GNUNET_malloc (sizeof (struct GSF_PeerTransmitHandle));
1057 pth->transmission_request_start_time = GNUNET_TIME_absolute_get ();
1058 pth->timeout = GNUNET_TIME_relative_to_absolute (timeout);
1060 pth->gmc_cls = gmc_cls;
1062 pth->is_query = is_query;
1063 pth->priority = priority;
1065 /* insertion sort (by priority, descending) */
1068 while ( (pos != NULL) &&
1069 (pos->priority > priority) )
1075 GNUNET_CONTAINER_DLL_insert (cp->pth_head,
1079 GNUNET_CONTAINER_DLL_insert_after (cp->pth_head,
1083 GNUNET_PEER_resolve (cp->ppd.pid,
1085 if (GNUNET_YES == is_query)
1087 /* query, need reservation */
1088 cp->ppd.pending_queries++;
1089 if (NULL == cp->irc)
1091 /* reservation already done! */
1092 is_ready = GNUNET_YES;
1093 ip = cp->inc_preference;
1094 cp->inc_preference = 0;
1095 cp->irc = GNUNET_CORE_peer_change_preference (GSF_core,
1097 GNUNET_TIME_UNIT_FOREVER_REL,
1098 GNUNET_BANDWIDTH_VALUE_MAX,
1101 &core_reserve_callback,
1106 /* still waiting for reservation */
1107 is_ready = GNUNET_NO;
1110 else if (GNUNET_NO == is_query)
1112 /* no reservation needed for content */
1113 cp->ppd.pending_replies++;
1114 is_ready = GNUNET_YES;
1118 /* not a query or content, no reservation needed */
1119 is_ready = GNUNET_YES;
1123 pth->cth = GNUNET_CORE_notify_transmit_ready (GSF_core,
1128 &peer_transmit_ready_cb,
1130 /* pth->cth could be NULL here, that's OK, we'll try again
1133 if (pth->cth == NULL)
1135 /* if we're waiting for reservation OR if we could not do notify_transmit_ready,
1136 install a timeout task to be on the safe side */
1137 pth->timeout_task = GNUNET_SCHEDULER_add_delayed (timeout,
1138 &peer_transmit_timeout,
1146 * Cancel an earlier request for transmission.
1148 * @param pth request to cancel
1151 GSF_peer_transmit_cancel_ (struct GSF_PeerTransmitHandle *pth)
1153 struct GSF_ConnectedPeer *cp;
1155 if (pth->timeout_task != GNUNET_SCHEDULER_NO_TASK)
1157 GNUNET_SCHEDULER_cancel (pth->timeout_task);
1158 pth->timeout_task = GNUNET_SCHEDULER_NO_TASK;
1160 if (NULL != pth->cth)
1162 GNUNET_CORE_notify_transmit_ready_cancel (pth->cth);
1166 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1169 if (GNUNET_YES == pth->is_query)
1170 GNUNET_assert (0 < cp->ppd.pending_queries--);
1171 else if (GNUNET_NO == pth->is_query)
1172 GNUNET_assert (0 < cp->ppd.pending_replies--);
1178 * Report on receiving a reply; update the performance record of the given peer.
1180 * @param cp responding peer (will be updated)
1181 * @param request_time time at which the original query was transmitted
1182 * @param request_priority priority of the original request
1185 GSF_peer_update_performance_ (struct GSF_ConnectedPeer *cp,
1186 struct GNUNET_TIME_Absolute request_time,
1187 uint32_t request_priority)
1189 struct GNUNET_TIME_Relative delay;
1191 delay = GNUNET_TIME_absolute_get_duration (request_time);
1192 cp->ppd.avg_reply_delay.rel_value = (cp->ppd.avg_reply_delay.rel_value * (RUNAVG_DELAY_N-1) + delay.rel_value) / RUNAVG_DELAY_N;
1193 cp->ppd.avg_priority = (cp->ppd.avg_priority * (RUNAVG_DELAY_N-1) + request_priority) / RUNAVG_DELAY_N;
1198 * Report on receiving a reply in response to an initiating client.
1199 * Remember that this peer is good for this client.
1201 * @param cp responding peer (will be updated)
1202 * @param initiator_client local client on responsible for query
1205 GSF_peer_update_responder_client_ (struct GSF_ConnectedPeer *cp,
1206 struct GSF_LocalClient *initiator_client)
1208 cp->ppd.last_client_replies[cp->last_client_replies_woff++ % CS2P_SUCCESS_LIST_SIZE] = initiator_client;
1213 * Report on receiving a reply in response to an initiating peer.
1214 * Remember that this peer is good for this initiating peer.
1216 * @param cp responding peer (will be updated)
1217 * @param initiator_peer other peer responsible for query
1220 GSF_peer_update_responder_peer_ (struct GSF_ConnectedPeer *cp,
1221 const struct GSF_ConnectedPeer *initiator_peer)
1223 GNUNET_PEER_change_rc (cp->ppd.last_p2p_replies[cp->last_p2p_replies_woff % P2P_SUCCESS_LIST_SIZE], -1);
1224 cp->ppd.last_p2p_replies[cp->last_p2p_replies_woff++ % P2P_SUCCESS_LIST_SIZE] = initiator_peer->ppd.pid;
1225 GNUNET_PEER_change_rc (initiator_peer->ppd.pid, 1);
1230 * Method called whenever a given peer has a status change.
1232 * @param cls closure
1233 * @param peer peer identity this notification is about
1234 * @param bandwidth_in available amount of inbound bandwidth
1235 * @param bandwidth_out available amount of outbound bandwidth
1236 * @param timeout absolute time when this peer will time out
1237 * unless we see some further activity from it
1238 * @param atsi status information
1241 GSF_peer_status_handler_ (void *cls,
1242 const struct GNUNET_PeerIdentity *peer,
1243 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
1244 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
1245 struct GNUNET_TIME_Absolute timeout,
1246 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
1248 struct GSF_ConnectedPeer *cp;
1250 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
1252 GNUNET_assert (NULL != cp);
1253 update_atsi (cp, atsi);
1258 * Cancel all requests associated with the peer.
1261 * @param query hash code of the request
1262 * @param value the 'struct GSF_PendingRequest'
1263 * @return GNUNET_YES (continue to iterate)
1266 cancel_pending_request (void *cls,
1267 const GNUNET_HashCode *query,
1270 struct GSF_PendingRequest *pr = value;
1272 GSF_pending_request_cancel_ (pr);
1278 * A peer disconnected from us. Tear down the connected peer
1282 * @param peer identity of peer that connected
1285 GSF_peer_disconnect_handler_ (void *cls,
1286 const struct GNUNET_PeerIdentity *peer)
1288 struct GSF_ConnectedPeer *cp;
1289 struct GSF_PeerTransmitHandle *pth;
1291 cp = GNUNET_CONTAINER_multihashmap_get (cp_map,
1293 GNUNET_assert (NULL != cp);
1294 GNUNET_CONTAINER_multihashmap_remove (cp_map,
1297 if (NULL != cp->migration_pth)
1299 GSF_peer_transmit_cancel_ (cp->migration_pth);
1300 cp->migration_pth = NULL;
1302 if (NULL != cp->irc)
1304 GNUNET_CORE_peer_change_preference_cancel (cp->irc);
1307 GNUNET_CONTAINER_multihashmap_iterate (cp->request_map,
1308 &cancel_pending_request,
1310 GNUNET_CONTAINER_multihashmap_destroy (cp->request_map);
1311 cp->request_map = NULL;
1312 GSF_plan_notify_peer_disconnect_ (cp);
1313 GNUNET_LOAD_value_free (cp->ppd.transmission_delay);
1314 GNUNET_PEER_decrement_rcs (cp->ppd.last_p2p_replies, P2P_SUCCESS_LIST_SIZE);
1315 while (NULL != (pth = cp->pth_head))
1317 if (NULL != pth->cth)
1319 GNUNET_CORE_notify_transmit_ready_cancel (pth->cth);
1322 GNUNET_CONTAINER_DLL_remove (cp->pth_head,
1327 GNUNET_PEER_change_rc (cp->ppd.pid, -1);
1328 if (GNUNET_SCHEDULER_NO_TASK != cp->mig_revive_task)
1330 GNUNET_SCHEDULER_cancel (cp->mig_revive_task);
1331 cp->mig_revive_task = GNUNET_SCHEDULER_NO_TASK;
1338 * Closure for 'call_iterator'.
1340 struct IterationContext
1343 * Function to call on each entry.
1345 GSF_ConnectedPeerIterator it;
1355 * Function that calls the callback for each peer.
1357 * @param cls the 'struct IterationContext*'
1358 * @param key identity of the peer
1359 * @param value the 'struct GSF_ConnectedPeer*'
1360 * @return GNUNET_YES to continue iteration
1363 call_iterator (void *cls,
1364 const GNUNET_HashCode *key,
1367 struct IterationContext *ic = cls;
1368 struct GSF_ConnectedPeer *cp = value;
1371 (const struct GNUNET_PeerIdentity*) key,
1379 * Iterate over all connected peers.
1381 * @param it function to call for each peer
1382 * @param it_cls closure for it
1385 GSF_iterate_connected_peers_ (GSF_ConnectedPeerIterator it,
1388 struct IterationContext ic;
1392 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1399 * Obtain the identity of a connected peer.
1401 * @param cp peer to reserve bandwidth from
1402 * @param id identity to set (written to)
1405 GSF_connected_peer_get_identity_ (const struct GSF_ConnectedPeer *cp,
1406 struct GNUNET_PeerIdentity *id)
1408 GNUNET_PEER_resolve (cp->ppd.pid,
1414 * Assemble a migration stop message for transmission.
1416 * @param cls the 'struct GSF_ConnectedPeer' to use
1417 * @param size number of bytes we're allowed to write to buf
1418 * @param buf where to copy the message
1419 * @return number of bytes copied to buf
1422 create_migration_stop_message (void *cls,
1426 struct GSF_ConnectedPeer *cp = cls;
1427 struct MigrationStopMessage msm;
1429 cp->migration_pth = NULL;
1432 GNUNET_assert (size > sizeof (struct MigrationStopMessage));
1433 msm.header.size = htons (sizeof (struct MigrationStopMessage));
1434 msm.header.type = htons (GNUNET_MESSAGE_TYPE_FS_MIGRATION_STOP);
1435 msm.duration = GNUNET_TIME_relative_hton (GNUNET_TIME_absolute_get_remaining (cp->last_migration_block));
1436 memcpy (buf, &msm, sizeof (struct MigrationStopMessage));
1437 return sizeof (struct MigrationStopMessage);
1442 * Ask a peer to stop migrating data to us until the given point
1445 * @param cp peer to ask
1446 * @param block_time until when to block
1449 GSF_block_peer_migration_ (struct GSF_ConnectedPeer *cp,
1450 struct GNUNET_TIME_Relative block_time)
1452 if (GNUNET_TIME_absolute_get_duration (cp->last_migration_block).rel_value > block_time.rel_value)
1453 return; /* already blocked */
1454 cp->last_migration_block = GNUNET_TIME_relative_to_absolute (block_time);
1455 if (cp->migration_pth != NULL)
1456 GSF_peer_transmit_cancel_ (cp->migration_pth);
1458 = GSF_peer_transmit_ (cp,
1461 GNUNET_TIME_UNIT_FOREVER_REL,
1462 sizeof (struct MigrationStopMessage),
1463 &create_migration_stop_message,
1469 * Write host-trust information to a file - flush the buffer entry!
1471 * @param cls closure, not used
1472 * @param key host identity
1473 * @param value the 'struct GSF_ConnectedPeer' to flush
1474 * @return GNUNET_OK to continue iteration
1477 flush_trust (void *cls,
1478 const GNUNET_HashCode *key,
1481 struct GSF_ConnectedPeer *cp = value;
1484 struct GNUNET_PeerIdentity pid;
1486 if (cp->ppd.trust == cp->disk_trust)
1487 return GNUNET_OK; /* unchanged */
1488 GNUNET_PEER_resolve (cp->ppd.pid,
1490 fn = get_trust_filename (&pid);
1491 if (cp->ppd.trust == 0)
1493 if ((0 != UNLINK (fn)) && (errno != ENOENT))
1494 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
1495 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
1499 trust = htonl (cp->ppd.trust);
1500 if (sizeof(uint32_t) == GNUNET_DISK_fn_write (fn, &trust,
1502 GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE
1503 | GNUNET_DISK_PERM_GROUP_READ | GNUNET_DISK_PERM_OTHER_READ))
1504 cp->disk_trust = cp->ppd.trust;
1512 * Notify core about a preference we have for the given peer
1513 * (to allocate more resources towards it). The change will
1514 * be communicated the next time we reserve bandwidth with
1515 * core (not instantly).
1517 * @param cp peer to reserve bandwidth from
1518 * @param pref preference change
1521 GSF_connected_peer_change_preference_ (struct GSF_ConnectedPeer *cp,
1524 cp->inc_preference += pref;
1529 * Call this method periodically to flush trust information to disk.
1531 * @param cls closure, not used
1532 * @param tc task context, not used
1535 cron_flush_trust (void *cls,
1536 const struct GNUNET_SCHEDULER_TaskContext *tc)
1541 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1546 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1548 GNUNET_SCHEDULER_add_delayed (TRUST_FLUSH_FREQ,
1555 * Initialize peer management subsystem.
1557 * @param cfg configuration to use
1560 GSF_connected_peer_init_ (struct GNUNET_CONFIGURATION_Handle *cfg)
1562 cp_map = GNUNET_CONTAINER_multihashmap_create (128);
1563 GNUNET_assert (GNUNET_OK ==
1564 GNUNET_CONFIGURATION_get_value_filename (cfg,
1568 GNUNET_DISK_directory_create (trustDirectory);
1569 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_HIGH,
1570 &cron_flush_trust, NULL);
1575 * Iterator to free peer entries.
1577 * @param cls closure, unused
1578 * @param key current key code
1579 * @param value value in the hash map (peer entry)
1580 * @return GNUNET_YES (we should continue to iterate)
1583 clean_peer (void *cls,
1584 const GNUNET_HashCode * key,
1587 GSF_peer_disconnect_handler_ (NULL,
1588 (const struct GNUNET_PeerIdentity*) key);
1594 * Shutdown peer management subsystem.
1597 GSF_connected_peer_done_ ()
1599 cron_flush_trust (NULL, NULL);
1600 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1603 GNUNET_CONTAINER_multihashmap_destroy (cp_map);
1605 GNUNET_free (trustDirectory);
1606 trustDirectory = NULL;
1611 * Iterator to remove references to LC entry.
1613 * @param cls the 'struct GSF_LocalClient*' to look for
1614 * @param key current key code
1615 * @param value value in the hash map (peer entry)
1616 * @return GNUNET_YES (we should continue to iterate)
1619 clean_local_client (void *cls,
1620 const GNUNET_HashCode * key,
1623 const struct GSF_LocalClient *lc = cls;
1624 struct GSF_ConnectedPeer *cp = value;
1627 for (i=0;i<CS2P_SUCCESS_LIST_SIZE;i++)
1628 if (cp->ppd.last_client_replies[i] == lc)
1629 cp->ppd.last_client_replies[i] = NULL;
1635 * Notification that a local client disconnected. Clean up all of our
1636 * references to the given handle.
1638 * @param lc handle to the local client (henceforth invalid)
1641 GSF_handle_local_client_disconnect_ (const struct GSF_LocalClient *lc)
1643 GNUNET_CONTAINER_multihashmap_iterate (cp_map,
1644 &clean_local_client,
1649 /* end of gnunet-service-fs_cp.c */