2 This file is part of GNUnet.
3 (C) 2009, 2010, 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 nse/gnunet-service-nse.c
23 * @brief network size estimation service
24 * @author Nathan Evans
25 * @author Christian Grothoff
27 * The purpose of this service is to estimate the size of the network.
28 * Given a specified interval, each peer hashes the most recent
29 * timestamp which is evenly divisible by that interval. This hash is
30 * compared in distance to the peer identity to choose an offset. The
31 * closer the peer identity to the hashed timestamp, the earlier the
32 * peer sends out a "nearest peer" message. The closest peer's
33 * message should thus be received before any others, which stops
34 * those peer from sending their messages at a later duration. So
35 * every peer should receive the same nearest peer message, and from
36 * this can calculate the expected number of peers in the network.
40 #include "gnunet_util_lib.h"
41 #include "gnunet_constants.h"
42 #include "gnunet_protocols.h"
43 #include "gnunet_signatures.h"
44 #include "gnunet_statistics_service.h"
45 #include "gnunet_core_service.h"
46 #include "gnunet_nse_service.h"
50 * Should messages be delayed randomly? This option should be set to
51 * GNUNET_NO only for experiments, not in production. It should also
52 * be removed once the initial experiments have been completed.
54 #define USE_RANDOM_DELAYS GNUNET_YES
57 * Should we generate a histogram with the time stamps of when we received
58 * NSE messages to disk? (for performance evaluation only, not useful in
59 * production). The associated code should also probably be removed
60 * once we're done with experiments.
62 #define ENABLE_HISTOGRAM GNUNET_NO
65 * Over how many values do we calculate the weighted average?
67 #define HISTORY_SIZE 8
70 * Size of the queue to core.
72 #define CORE_QUEUE_SIZE 2
75 * Message priority to use.
77 #define NSE_PRIORITY 5
80 #define log2(a) (log(a)/log(2))
84 * Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
86 static unsigned long long nse_work_required;
89 * Interval for sending network size estimation flood requests.
91 static struct GNUNET_TIME_Relative gnunet_nse_interval;
94 * Interval between proof find runs.
96 static struct GNUNET_TIME_Relative proof_find_delay;
100 * Handle for writing when we received messages to disk.
102 static struct GNUNET_BIO_WriteHandle *wh;
107 * Per-peer information.
113 * Pending message for this peer.
115 struct GNUNET_MessageHeader *pending_message;
118 * Core handle for sending messages to this peer.
120 struct GNUNET_CORE_TransmitHandle *th;
123 * What is the identity of the peer?
125 struct GNUNET_PeerIdentity id;
128 * Task scheduled to send message to this peer.
130 GNUNET_SCHEDULER_TaskIdentifier transmit_task;
133 * Did we receive or send a message about the previous round
134 * to this peer yet? GNUNET_YES if the previous round has
135 * been taken care of.
142 * Network size estimate reply; sent when "this"
143 * peer's timer has run out before receiving a
144 * valid reply from another peer.
146 struct GNUNET_NSE_FloodMessage
149 * Type: GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD
151 struct GNUNET_MessageHeader header;
154 * Number of hops this message has taken so far.
156 uint32_t hop_count GNUNET_PACKED;
161 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
164 * The current timestamp value (which all
165 * peers should agree on).
167 struct GNUNET_TIME_AbsoluteNBO timestamp;
170 * Number of matching bits between the hash
171 * of timestamp and the initiator's public
174 uint32_t matching_bits GNUNET_PACKED;
177 * Public key of the originator.
179 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pkey;
182 * Proof of work, causing leading zeros when hashed with pkey.
184 uint64_t proof_of_work GNUNET_PACKED;
187 * Signature (over range specified in purpose).
189 struct GNUNET_CRYPTO_RsaSignature signature;
194 * Handle to our current configuration.
196 static const struct GNUNET_CONFIGURATION_Handle *cfg;
199 * Handle to the statistics service.
201 static struct GNUNET_STATISTICS_Handle *stats;
204 * Handle to the core service.
206 static struct GNUNET_CORE_Handle *coreAPI;
209 * Map of all connected peers.
211 static struct GNUNET_CONTAINER_MultiHashMap *peers;
214 * The current network size estimate. Number of bits matching on
217 static double current_size_estimate;
220 * The standard deviation of the last HISTORY_SIZE network
223 static double current_std_dev = NAN;
226 * Current hop counter estimate (estimate for network diameter).
228 static uint32_t hop_count_max;
231 * Message for the next round, if we got any.
233 static struct GNUNET_NSE_FloodMessage next_message;
236 * Array of recent size estimate messages.
238 static struct GNUNET_NSE_FloodMessage size_estimate_messages[HISTORY_SIZE];
241 * Index of most recent estimate.
243 static unsigned int estimate_index;
246 * Number of valid entries in the history.
248 static unsigned int estimate_count;
251 * Task scheduled to update our flood message for the next round.
253 static GNUNET_SCHEDULER_TaskIdentifier flood_task;
256 * Task scheduled to compute our proof.
258 static GNUNET_SCHEDULER_TaskIdentifier proof_task;
261 * Notification context, simplifies client broadcasts.
263 static struct GNUNET_SERVER_NotificationContext *nc;
266 * The next major time.
268 static struct GNUNET_TIME_Absolute next_timestamp;
271 * The current major time.
273 static struct GNUNET_TIME_Absolute current_timestamp;
276 * The public key of this peer.
278 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
281 * The private key of this peer.
283 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
286 * The peer identity of this peer.
288 static struct GNUNET_PeerIdentity my_identity;
291 * Proof of work for this peer.
293 static uint64_t my_proof;
297 * Initialize a message to clients with the current network
300 * @param em message to fill in
303 setup_estimate_message (struct GNUNET_NSE_ClientMessage *em)
318 /* Weighted incremental algorithm for stddev according to West (1979) */
322 for (i = 0; i < estimate_count; i++)
325 htonl (size_estimate_messages
326 [(estimate_index - i +
327 HISTORY_SIZE) % HISTORY_SIZE].matching_bits);
328 weight = 1; /* was: estimate_count + 1 - i; */
330 temp = weight + sumweight;
332 r = q * weight / temp;
333 sum += sumweight * q * r;
337 variance = sum / (sumweight - 1.0);
338 GNUNET_assert (variance >= 0);
339 std_dev = sqrt (variance);
340 current_std_dev = std_dev;
341 current_size_estimate = mean;
343 em->header.size = htons (sizeof (struct GNUNET_NSE_ClientMessage));
344 em->header.type = htons (GNUNET_MESSAGE_TYPE_NSE_ESTIMATE);
345 em->reserved = htonl (0);
346 em->timestamp = GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
347 em->size_estimate = mean - 0.332747;
348 nsize = log2 (GNUNET_CONTAINER_multihashmap_size (peers) + 1);
349 if (em->size_estimate < nsize)
350 em->size_estimate = nsize;
351 em->std_deviation = std_dev;
352 GNUNET_STATISTICS_set (stats, "# nodes in the network (estimate)",
353 (uint64_t) pow (2, mean - 1.0 / 3.0), GNUNET_NO);
358 * Handler for START message from client, triggers an
359 * immediate current network estimate notification.
360 * Also, we remember the client for updates upon future
361 * estimate measurements.
364 * @param client who sent the message
365 * @param message the message received
368 handle_start_message (void *cls, struct GNUNET_SERVER_Client *client,
369 const struct GNUNET_MessageHeader *message)
371 struct GNUNET_NSE_ClientMessage em;
374 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received START message from client\n");
376 GNUNET_SERVER_notification_context_add (nc, client);
377 setup_estimate_message (&em);
378 GNUNET_SERVER_notification_context_unicast (nc, client, &em.header,
380 GNUNET_SERVER_receive_done (client, GNUNET_OK);
385 * How long should we delay a message to go the given number of
388 * @param matching_bits number of matching bits to consider
391 get_matching_bits_delay (uint32_t matching_bits)
393 /* Calculated as: S + f/2 - (f / pi) * (atan(x - p')) */
394 // S is next_timestamp (ignored in return value)
395 // f is frequency (gnunet_nse_interval)
396 // x is matching_bits
397 // p' is current_size_estimate
398 return ((double) gnunet_nse_interval.rel_value / (double) 2.0) -
399 ((gnunet_nse_interval.rel_value / M_PI) *
400 atan (matching_bits - current_size_estimate));
405 * What delay randomization should we apply for a given number of matching bits?
407 * @param matching_bits number of matching bits
408 * @return random delay to apply
410 static struct GNUNET_TIME_Relative
411 get_delay_randomization (uint32_t matching_bits)
413 #if USE_RANDOM_DELAYS
414 struct GNUNET_TIME_Relative ret;
416 if (matching_bits == 0)
417 return GNUNET_TIME_UNIT_ZERO;
419 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
420 (uint32_t) (get_matching_bits_delay
422 1) / (double) (hop_count_max +
426 return GNUNET_TIME_UNIT_ZERO;
432 * Get the number of matching bits that the given timestamp has to the given peer ID.
434 * @param timestamp time to generate key
435 * @param id peer identity to compare with
436 * @return number of matching bits
439 get_matching_bits (struct GNUNET_TIME_Absolute timestamp,
440 const struct GNUNET_PeerIdentity *id)
442 GNUNET_HashCode timestamp_hash;
444 GNUNET_CRYPTO_hash (×tamp.abs_value, sizeof (timestamp.abs_value),
446 return GNUNET_CRYPTO_hash_matching_bits (×tamp_hash, &id->hashPubKey);
451 * Get the transmission delay that should be applied for a
454 * @param round_offset -1 for the previous round (random delay between 0 and 50ms)
455 * 0 for the current round (based on our proximity to time key)
456 * @return delay that should be applied
458 static struct GNUNET_TIME_Relative
459 get_transmit_delay (int round_offset)
461 struct GNUNET_TIME_Relative ret;
462 struct GNUNET_TIME_Absolute tgt;
464 uint32_t matching_bits;
466 switch (round_offset)
469 /* previous round is randomized between 0 and 50 ms */
470 #if USE_RANDOM_DELAYS
471 ret.rel_value = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, 50);
473 ret = GNUNET_TIME_UNIT_ZERO;
476 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
477 "Transmitting previous round behind schedule in %llu ms\n",
478 (unsigned long long) ret.rel_value);
482 /* current round is based on best-known matching_bits */
484 ntohl (size_estimate_messages[estimate_index].matching_bits);
485 dist_delay = get_matching_bits_delay (matching_bits);
486 dist_delay += get_delay_randomization (matching_bits).rel_value;
487 ret.rel_value = (uint64_t) dist_delay;
489 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
490 "For round %llu, delay for %u matching bits is %llu ms\n",
491 (unsigned long long) current_timestamp.abs_value,
492 (unsigned int) matching_bits,
493 (unsigned long long) ret.rel_value);
495 /* now consider round start time and add delay to it */
496 tgt = GNUNET_TIME_absolute_add (current_timestamp, ret);
497 return GNUNET_TIME_absolute_get_remaining (tgt);
500 return GNUNET_TIME_UNIT_FOREVER_REL;
505 * Task that triggers a NSE P2P transmission.
507 * @param cls the 'struct NSEPeerEntry'
508 * @param tc scheduler context
511 transmit_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
515 * Called when core is ready to send a message we asked for
516 * out to the destination.
518 * @param cls closure (NULL)
519 * @param size number of bytes available in buf
520 * @param buf where the callee should write the message
521 * @return number of bytes written to buf
524 transmit_ready (void *cls, size_t size, void *buf)
526 struct NSEPeerEntry *peer_entry = cls;
529 peer_entry->th = NULL;
532 /* client disconnected */
535 GNUNET_assert (size >= sizeof (struct GNUNET_NSE_FloodMessage));
536 idx = estimate_index;
537 if (peer_entry->previous_round == GNUNET_NO)
539 idx = (idx + HISTORY_SIZE - 1) % HISTORY_SIZE;
540 peer_entry->previous_round = GNUNET_YES;
541 peer_entry->transmit_task =
542 GNUNET_SCHEDULER_add_delayed (get_transmit_delay (0), &transmit_task,
545 if ((ntohl (size_estimate_messages[idx].hop_count) == 0) &&
546 (GNUNET_SCHEDULER_NO_TASK != proof_task))
548 GNUNET_STATISTICS_update (stats,
549 "# flood messages not generated (no proof yet)",
554 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
555 "In round %llu, sending to `%s' estimate with %u bits\n",
557 GNUNET_TIME_absolute_ntoh (size_estimate_messages[idx].
558 timestamp).abs_value,
559 GNUNET_i2s (&peer_entry->id),
560 (unsigned int) ntohl (size_estimate_messages[idx].matching_bits));
562 if (ntohl (size_estimate_messages[idx].hop_count) == 0)
563 GNUNET_STATISTICS_update (stats, "# flood messages started", 1, GNUNET_NO);
564 GNUNET_STATISTICS_update (stats, "# flood messages transmitted", 1,
566 memcpy (buf, &size_estimate_messages[idx],
567 sizeof (struct GNUNET_NSE_FloodMessage));
568 GNUNET_STATISTICS_update (stats, "# flood messages sent", 1, GNUNET_NO);
569 return sizeof (struct GNUNET_NSE_FloodMessage);
574 * Task that triggers a NSE P2P transmission.
576 * @param cls the 'struct NSEPeerEntry'
577 * @param tc scheduler context
580 transmit_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
582 struct NSEPeerEntry *peer_entry = cls;
584 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
585 GNUNET_assert (NULL == peer_entry->th);
587 GNUNET_CORE_notify_transmit_ready (coreAPI, GNUNET_NO, NSE_PRIORITY,
588 GNUNET_TIME_UNIT_FOREVER_REL,
591 GNUNET_NSE_FloodMessage),
592 &transmit_ready, peer_entry);
597 * We've sent on our flood message or one that we received which was
598 * validated and closer than ours. Update the global list of recent
599 * messages and the average. Also re-broadcast the message to any
603 update_network_size_estimate ()
605 struct GNUNET_NSE_ClientMessage em;
607 setup_estimate_message (&em);
608 GNUNET_SERVER_notification_context_broadcast (nc, &em.header, GNUNET_YES);
613 * Setup a flood message in our history array at the given
614 * slot offset for the given timestamp.
616 * @param slot index to use
617 * @param ts timestamp to use
620 setup_flood_message (unsigned int slot, struct GNUNET_TIME_Absolute ts)
622 struct GNUNET_NSE_FloodMessage *fm;
623 uint32_t matching_bits;
625 matching_bits = get_matching_bits (ts, &my_identity);
626 fm = &size_estimate_messages[slot];
627 fm->header.size = htons (sizeof (struct GNUNET_NSE_FloodMessage));
628 fm->header.type = htons (GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD);
629 fm->hop_count = htonl (0);
630 fm->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_NSE_SEND);
632 htonl (sizeof (struct GNUNET_NSE_FloodMessage) -
633 sizeof (struct GNUNET_MessageHeader) - sizeof (uint32_t) -
634 sizeof (struct GNUNET_CRYPTO_RsaSignature));
635 fm->matching_bits = htonl (matching_bits);
636 fm->timestamp = GNUNET_TIME_absolute_hton (ts);
637 fm->pkey = my_public_key;
638 fm->proof_of_work = my_proof;
639 GNUNET_assert (GNUNET_OK ==
640 GNUNET_CRYPTO_rsa_sign (my_private_key, &fm->purpose, &fm->signature));
645 * Schedule transmission for the given peer for the current round based
646 * on what we know about the desired delay.
649 * @param key hash of peer identity
650 * @param value the 'struct NSEPeerEntry'
651 * @return GNUNET_OK (continue to iterate)
654 schedule_current_round (void *cls, const GNUNET_HashCode * key, void *value)
656 struct NSEPeerEntry *peer_entry = value;
657 struct GNUNET_TIME_Relative delay;
659 if (peer_entry->th != NULL)
661 peer_entry->previous_round = GNUNET_NO;
664 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
666 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
667 peer_entry->previous_round = GNUNET_NO;
670 get_transmit_delay ((peer_entry->previous_round == GNUNET_NO) ? -1 : 0);
671 peer_entry->transmit_task =
672 GNUNET_SCHEDULER_add_delayed (delay, &transmit_task, peer_entry);
678 * Update our flood message to be sent (and our timestamps).
681 * @param tc context for this message
684 update_flood_message (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
686 struct GNUNET_TIME_Relative offset;
689 flood_task = GNUNET_SCHEDULER_NO_TASK;
690 offset = GNUNET_TIME_absolute_get_remaining (next_timestamp);
691 if (0 != offset.rel_value)
693 /* somehow run early, delay more */
695 GNUNET_SCHEDULER_add_delayed (offset, &update_flood_message, NULL);
698 current_timestamp = next_timestamp;
700 GNUNET_TIME_absolute_add (current_timestamp, gnunet_nse_interval);
701 estimate_index = (estimate_index + 1) % HISTORY_SIZE;
702 if (estimate_count < HISTORY_SIZE)
704 if (next_timestamp.abs_value ==
705 GNUNET_TIME_absolute_ntoh (next_message.timestamp).abs_value)
707 /* we received a message for this round way early, use it! */
708 size_estimate_messages[estimate_index] = next_message;
709 size_estimate_messages[estimate_index].hop_count =
710 htonl (1 + ntohl (next_message.hop_count));
713 setup_flood_message (estimate_index, current_timestamp);
714 next_message.matching_bits = htonl (0); /* reset for 'next' round */
716 for (i = 0; i < HISTORY_SIZE; i++)
718 GNUNET_MAX (ntohl (size_estimate_messages[i].hop_count), hop_count_max);
719 GNUNET_CONTAINER_multihashmap_iterate (peers, &schedule_current_round, NULL);
721 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
722 (next_timestamp), &update_flood_message,
728 * Count the leading zeroes in hash.
731 * @return the number of leading zero bits.
734 count_leading_zeroes (const GNUNET_HashCode * hash)
736 unsigned int hash_count;
739 while ((0 == GNUNET_CRYPTO_hash_get_bit (hash, hash_count)))
746 * Check whether the given public key
747 * and integer are a valid proof of work.
749 * @param pkey the public key
750 * @param val the integer
752 * @return GNUNET_YES if valid, GNUNET_NO if not
755 check_proof_of_work (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *pkey,
758 char buf[sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
760 GNUNET_HashCode result;
762 memcpy (buf, &val, sizeof (val));
763 memcpy (&buf[sizeof (val)], pkey,
764 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
765 GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
766 return (count_leading_zeroes (&result) >=
767 nse_work_required) ? GNUNET_YES : GNUNET_NO;
772 * Write our current proof to disk.
780 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "PROOFFILE", &proof))
782 if (sizeof (my_proof) !=
783 GNUNET_DISK_fn_write (proof, &my_proof, sizeof (my_proof),
784 GNUNET_DISK_PERM_USER_READ |
785 GNUNET_DISK_PERM_USER_WRITE))
786 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", proof);
793 * Find our proof of work.
795 * @param cls closure (unused)
796 * @param tc task context
799 find_proof (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
801 #define ROUND_SIZE 10
803 char buf[sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
805 GNUNET_HashCode result;
808 proof_task = GNUNET_SCHEDULER_NO_TASK;
809 memcpy (&buf[sizeof (uint64_t)], &my_public_key,
810 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
813 while ((counter != UINT64_MAX) && (i < ROUND_SIZE))
815 memcpy (buf, &counter, sizeof (uint64_t));
816 GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
817 if (nse_work_required <= count_leading_zeroes (&result))
821 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Proof of work found: %llu!\n",
822 (unsigned long long) GNUNET_ntohll (counter));
824 for (i = 0; i < HISTORY_SIZE; i++)
825 if (ntohl (size_estimate_messages[i].hop_count) == 0)
827 size_estimate_messages[i].proof_of_work = my_proof;
828 GNUNET_assert (GNUNET_OK ==
829 GNUNET_CRYPTO_rsa_sign (my_private_key,
830 &size_estimate_messages[i].purpose,
831 &size_estimate_messages[i].signature));
839 if (my_proof / (100 * ROUND_SIZE) < counter / (100 * ROUND_SIZE))
842 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing proofs currently at %llu\n",
843 (unsigned long long) counter);
845 /* remember progress every 100 rounds */
854 GNUNET_SCHEDULER_add_delayed (proof_find_delay, &find_proof, NULL);
859 * An incoming flood message has been received which claims
860 * to have more bits matching than any we know in this time
861 * period. Verify the signature and/or proof of work.
863 * @param incoming_flood the message to verify
865 * @return GNUNET_YES if the message is verified
866 * GNUNET_NO if the key/signature don't verify
869 verify_message_crypto (const struct GNUNET_NSE_FloodMessage *incoming_flood)
872 check_proof_of_work (&incoming_flood->pkey,
873 incoming_flood->proof_of_work))
875 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Proof of work invalid: %llu!\n"),
877 GNUNET_ntohll (incoming_flood->proof_of_work));
882 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_NSE_SEND,
883 &incoming_flood->purpose,
884 &incoming_flood->signature,
885 &incoming_flood->pkey))
895 * Update transmissions for the given peer for the current round based
896 * on updated proximity information.
898 * @param cls peer entry to exclude from updates
899 * @param key hash of peer identity
900 * @param value the 'struct NSEPeerEntry'
901 * @return GNUNET_OK (continue to iterate)
904 update_flood_times (void *cls, const GNUNET_HashCode * key, void *value)
906 struct NSEPeerEntry *exclude = cls;
907 struct NSEPeerEntry *peer_entry = value;
908 struct GNUNET_TIME_Relative delay;
910 if (peer_entry->th != NULL)
911 return GNUNET_OK; /* already active */
912 if (peer_entry == exclude)
913 return GNUNET_OK; /* trigger of the update */
914 if (peer_entry->previous_round == GNUNET_NO)
916 /* still stuck in previous round, no point to update, check that
917 * we are active here though... */
918 GNUNET_break ((peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK) ||
919 (peer_entry->th != NULL));
922 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
924 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
925 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
927 delay = get_transmit_delay (0);
928 peer_entry->transmit_task =
929 GNUNET_SCHEDULER_add_delayed (delay, &transmit_task, peer_entry);
935 * Core handler for size estimate flooding messages.
937 * @param cls closure unused
938 * @param message message
939 * @param peer peer identity this message is from (ignored)
940 * @param atsi performance data (ignored)
944 handle_p2p_size_estimate (void *cls, const struct GNUNET_PeerIdentity *peer,
945 const struct GNUNET_MessageHeader *message,
946 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
948 const struct GNUNET_NSE_FloodMessage *incoming_flood;
949 struct GNUNET_TIME_Absolute ts;
950 struct NSEPeerEntry *peer_entry;
951 uint32_t matching_bits;
956 GNUNET_BIO_write_int64 (wh, GNUNET_TIME_absolute_get ().abs_value);
958 incoming_flood = (const struct GNUNET_NSE_FloodMessage *) message;
959 GNUNET_STATISTICS_update (stats, "# flood messages received", 1, GNUNET_NO);
960 matching_bits = ntohl (incoming_flood->matching_bits);
965 struct GNUNET_PeerIdentity os;
967 GNUNET_CRYPTO_hash (&incoming_flood->pkey,
968 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
970 GNUNET_snprintf (origin, sizeof (origin), "%s", GNUNET_i2s (&os));
971 GNUNET_snprintf (pred, sizeof (pred), "%s", GNUNET_i2s (peer));
972 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
973 "Flood at %llu from `%s' via `%s' at `%s' with bits %u\n",
975 GNUNET_TIME_absolute_ntoh (incoming_flood->timestamp).abs_value,
976 origin, pred, GNUNET_i2s (&my_identity),
977 (unsigned int) matching_bits);
981 peer_entry = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
982 if (NULL == peer_entry)
988 ts = GNUNET_TIME_absolute_ntoh (incoming_flood->timestamp);
990 if (ts.abs_value == current_timestamp.abs_value)
991 idx = estimate_index;
992 else if (ts.abs_value ==
993 current_timestamp.abs_value - gnunet_nse_interval.rel_value)
994 idx = (estimate_index + HISTORY_SIZE - 1) % HISTORY_SIZE;
995 else if (ts.abs_value ==
996 next_timestamp.abs_value - gnunet_nse_interval.rel_value)
998 if (matching_bits <= ntohl (next_message.matching_bits))
999 return GNUNET_OK; /* ignore, simply too early/late */
1000 if (GNUNET_YES != verify_message_crypto (incoming_flood))
1002 GNUNET_break_op (0);
1005 next_message = *incoming_flood;
1010 GNUNET_STATISTICS_update (stats,
1011 "# flood messages discarded (clock skew too large)",
1015 if (0 == (memcmp (peer, &my_identity, sizeof (struct GNUNET_PeerIdentity))))
1017 /* send to self, update our own estimate IF this also comes from us! */
1019 memcmp (&incoming_flood->pkey, &my_public_key, sizeof (my_public_key)))
1020 update_network_size_estimate ();
1023 if (matching_bits >= ntohl (size_estimate_messages[idx].matching_bits))
1025 /* cancel transmission from us to this peer for this round */
1026 if (idx == estimate_index)
1028 if (peer_entry->previous_round == GNUNET_YES)
1030 /* cancel any activity for current round */
1031 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1033 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
1034 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
1036 if (peer_entry->th != NULL)
1038 GNUNET_CORE_notify_transmit_ready_cancel (peer_entry->th);
1039 peer_entry->th = NULL;
1045 /* cancel previous round only */
1046 peer_entry->previous_round = GNUNET_YES;
1049 if (matching_bits == ntohl (size_estimate_messages[idx].matching_bits))
1051 if (matching_bits <= ntohl (size_estimate_messages[idx].matching_bits))
1053 if ((idx < estimate_index) && (peer_entry->previous_round == GNUNET_YES))
1054 peer_entry->previous_round = GNUNET_NO;
1055 /* push back our result now, that peer is spreading bad information... */
1056 if (NULL == peer_entry->th)
1058 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1059 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
1060 peer_entry->transmit_task =
1061 GNUNET_SCHEDULER_add_now (&transmit_task, peer_entry);
1063 /* Not closer than our most recent message, no need to do work here */
1064 GNUNET_STATISTICS_update (stats,
1065 "# flood messages ignored (had closer already)",
1069 if (GNUNET_YES != verify_message_crypto (incoming_flood))
1071 GNUNET_break_op (0);
1074 size_estimate_messages[idx] = *incoming_flood;
1075 size_estimate_messages[idx].hop_count =
1076 htonl (ntohl (incoming_flood->hop_count) + 1);
1078 GNUNET_MAX (ntohl (incoming_flood->hop_count) + 1, hop_count_max);
1080 /* have a new, better size estimate, inform clients */
1081 update_network_size_estimate ();
1084 GNUNET_CONTAINER_multihashmap_iterate (peers, &update_flood_times,
1092 * Method called whenever a peer connects.
1094 * @param cls closure
1095 * @param peer peer identity this notification is about
1096 * @param atsi performance data
1099 handle_core_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
1100 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
1102 struct NSEPeerEntry *peer_entry;
1105 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s' connected to us\n",
1108 peer_entry = GNUNET_malloc (sizeof (struct NSEPeerEntry));
1109 peer_entry->id = *peer;
1110 GNUNET_CONTAINER_multihashmap_put (peers, &peer->hashPubKey, peer_entry,
1111 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1112 peer_entry->transmit_task =
1113 GNUNET_SCHEDULER_add_delayed (get_transmit_delay (-1), &transmit_task,
1119 * Method called whenever a peer disconnects.
1121 * @param cls closure
1122 * @param peer peer identity this notification is about
1125 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
1127 struct NSEPeerEntry *pos;
1130 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s' disconnected from us\n",
1133 pos = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
1139 GNUNET_assert (GNUNET_YES ==
1140 GNUNET_CONTAINER_multihashmap_remove (peers, &peer->hashPubKey,
1142 if (pos->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1143 GNUNET_SCHEDULER_cancel (pos->transmit_task);
1144 if (pos->th != NULL)
1146 GNUNET_CORE_notify_transmit_ready_cancel (pos->th);
1154 * Task run during shutdown.
1160 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1162 if (flood_task != GNUNET_SCHEDULER_NO_TASK)
1164 GNUNET_SCHEDULER_cancel (flood_task);
1165 flood_task = GNUNET_SCHEDULER_NO_TASK;
1167 if (proof_task != GNUNET_SCHEDULER_NO_TASK)
1169 GNUNET_SCHEDULER_cancel (proof_task);
1170 proof_task = GNUNET_SCHEDULER_NO_TASK;
1171 write_proof (); /* remember progress */
1175 GNUNET_SERVER_notification_context_destroy (nc);
1178 if (coreAPI != NULL)
1180 GNUNET_CORE_disconnect (coreAPI);
1185 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
1190 GNUNET_CONTAINER_multihashmap_destroy (peers);
1193 if (my_private_key != NULL)
1195 GNUNET_CRYPTO_rsa_key_free (my_private_key);
1196 my_private_key = NULL;
1198 #if ENABLE_HISTOGRAM
1201 GNUNET_BIO_write_close (wh);
1209 * Called on core init/fail.
1211 * @param cls service closure
1212 * @param server handle to the server for this service
1213 * @param identity the public identity of this peer
1216 core_init (void *cls, struct GNUNET_CORE_Handle *server,
1217 const struct GNUNET_PeerIdentity *identity)
1219 struct GNUNET_TIME_Absolute now;
1220 struct GNUNET_TIME_Absolute prev_time;
1226 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connection to core FAILED!\n");
1228 GNUNET_SCHEDULER_shutdown ();
1232 memcmp (&my_identity, identity,
1233 sizeof (struct GNUNET_PeerIdentity)));
1234 now = GNUNET_TIME_absolute_get ();
1235 current_timestamp.abs_value =
1236 (now.abs_value / gnunet_nse_interval.rel_value) *
1237 gnunet_nse_interval.rel_value;
1238 next_timestamp.abs_value =
1239 current_timestamp.abs_value + gnunet_nse_interval.rel_value;
1241 for (i = 0; i < HISTORY_SIZE; i++)
1243 prev_time.abs_value =
1244 current_timestamp.abs_value - (HISTORY_SIZE - i -
1245 1) * gnunet_nse_interval.rel_value;
1246 setup_flood_message (i, prev_time);
1248 estimate_index = HISTORY_SIZE - 1;
1251 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
1252 (next_timestamp), &update_flood_message,
1258 * Handle network size estimate clients.
1260 * @param cls closure
1261 * @param server the initialized server
1262 * @param c configuration to use
1265 run (void *cls, struct GNUNET_SERVER_Handle *server,
1266 const struct GNUNET_CONFIGURATION_Handle *c)
1271 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1272 {&handle_start_message, NULL, GNUNET_MESSAGE_TYPE_NSE_START,
1273 sizeof (struct GNUNET_MessageHeader)},
1276 static const struct GNUNET_CORE_MessageHandler core_handlers[] = {
1277 {&handle_p2p_size_estimate, GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD,
1278 sizeof (struct GNUNET_NSE_FloodMessage)},
1284 GNUNET_CONFIGURATION_get_value_time (cfg, "NSE", "INTERVAL",
1285 &gnunet_nse_interval)) ||
1287 GNUNET_CONFIGURATION_get_value_time (cfg, "NSE", "WORKDELAY",
1288 &proof_find_delay)) ||
1290 GNUNET_CONFIGURATION_get_value_number (cfg, "NSE", "WORKBITS",
1291 &nse_work_required)))
1293 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1295 ("NSE service is lacking key configuration settings. Exiting.\n"));
1296 GNUNET_SCHEDULER_shutdown ();
1299 if (nse_work_required >= sizeof (GNUNET_HashCode) * 8)
1301 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1302 _("Invalid work requirement for NSE service. Exiting.\n"));
1303 GNUNET_SCHEDULER_shutdown ();
1309 GNUNET_CONFIGURATION_get_value_filename (cfg, "GNUNETD", "HOSTKEY",
1312 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1314 ("NSE service is lacking key configuration settings. Exiting.\n"));
1315 GNUNET_SCHEDULER_shutdown ();
1318 my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
1319 GNUNET_free (keyfile);
1320 if (my_private_key == NULL)
1322 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1323 _("NSE service could not access hostkey. Exiting.\n"));
1324 GNUNET_SCHEDULER_shutdown ();
1327 GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
1328 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
1329 &my_identity.hashPubKey);
1331 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "PROOFFILE", &proof))
1333 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1335 ("NSE service is lacking key configuration settings. Exiting.\n"));
1336 if (my_private_key != NULL)
1338 GNUNET_CRYPTO_rsa_key_free (my_private_key);
1339 my_private_key = NULL;
1341 GNUNET_SCHEDULER_shutdown ();
1344 if ((GNUNET_YES != GNUNET_DISK_file_test (proof)) ||
1345 (sizeof (my_proof) !=
1346 GNUNET_DISK_fn_read (proof, &my_proof, sizeof (my_proof))))
1348 GNUNET_free (proof);
1350 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1353 peers = GNUNET_CONTAINER_multihashmap_create (128);
1354 GNUNET_SERVER_add_handlers (server, handlers);
1355 nc = GNUNET_SERVER_notification_context_create (server, 1);
1356 /* Connect to core service and register core handlers */
1357 coreAPI = GNUNET_CORE_connect (cfg, /* Main configuration */
1358 CORE_QUEUE_SIZE, /* queue size */
1359 NULL, /* Closure passed to functions */
1360 &core_init, /* Call core_init once connected */
1361 &handle_core_connect, /* Handle connects */
1362 &handle_core_disconnect, /* Handle disconnects */
1363 NULL, /* Do we care about "status" updates? */
1364 NULL, /* Don't want notified about all incoming messages */
1365 GNUNET_NO, /* For header only inbound notification */
1366 NULL, /* Don't want notified about all outbound messages */
1367 GNUNET_NO, /* For header only outbound notification */
1368 core_handlers); /* Register these handlers */
1369 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
1371 #if ENABLE_HISTOGRAM
1373 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "HISTOGRAM", &proof))
1375 wh = GNUNET_BIO_write_open (proof);
1376 GNUNET_free (proof);
1379 if (coreAPI == NULL)
1381 GNUNET_SCHEDULER_shutdown ();
1384 stats = GNUNET_STATISTICS_create ("nse", cfg);
1389 * The main function for the statistics service.
1391 * @param argc number of arguments from the command line
1392 * @param argv command line arguments
1393 * @return 0 ok, 1 on error
1396 main (int argc, char *const *argv)
1398 return (GNUNET_OK ==
1399 GNUNET_SERVICE_run (argc, argv, "nse", GNUNET_SERVICE_OPTION_NONE,
1400 &run, NULL)) ? 0 : 1;
1403 /* end of gnunet-service-nse.c */