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.
39 #include "gnunet_util_lib.h"
40 #include "gnunet_constants.h"
41 #include "gnunet_protocols.h"
42 #include "gnunet_signatures.h"
43 #include "gnunet_statistics_service.h"
44 #include "gnunet_core_service.h"
45 #include "gnunet_nse_service.h"
49 * Should messages be delayed randomly? This option should be set to
50 * GNUNET_NO only for experiments, not in production. It should also
51 * be removed once the initial experiments have been completed.
53 #define USE_RANDOM_DELAYS GNUNET_YES
56 * Should we generate a histogram with the time stamps of when we received
57 * NSE messages to disk? (for performance evaluation only, not useful in
58 * production). The associated code should also probably be removed
59 * once we're done with experiments.
61 #define ENABLE_HISTOGRAM GNUNET_NO
64 * Over how many values do we calculate the weighted average?
66 #define HISTORY_SIZE 8
69 * Size of the queue to core.
71 #define CORE_QUEUE_SIZE 2
74 * Message priority to use.
76 #define NSE_PRIORITY 5
79 * Amount of work required (W-bit collisions) for NSE proofs, in collision-bits.
81 static unsigned long long nse_work_required;
84 * Interval for sending network size estimation flood requests.
86 static struct GNUNET_TIME_Relative gnunet_nse_interval;
89 * Interval between proof find runs.
91 static struct GNUNET_TIME_Relative proof_find_delay;
95 * Handle for writing when we received messages to disk.
97 static struct GNUNET_BIO_WriteHandle *wh;
102 * Per-peer information.
108 * Pending message for this peer.
110 struct GNUNET_MessageHeader *pending_message;
113 * Core handle for sending messages to this peer.
115 struct GNUNET_CORE_TransmitHandle *th;
118 * What is the identity of the peer?
120 struct GNUNET_PeerIdentity id;
123 * Task scheduled to send message to this peer.
125 GNUNET_SCHEDULER_TaskIdentifier transmit_task;
128 * Did we receive or send a message about the previous round
129 * to this peer yet? GNUNET_YES if the previous round has
130 * been taken care of.
137 * Network size estimate reply; sent when "this"
138 * peer's timer has run out before receiving a
139 * valid reply from another peer.
141 struct GNUNET_NSE_FloodMessage
144 * Type: GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD
146 struct GNUNET_MessageHeader header;
149 * Number of hops this message has taken so far.
156 struct GNUNET_CRYPTO_RsaSignaturePurpose purpose;
159 * The current timestamp value (which all
160 * peers should agree on).
162 struct GNUNET_TIME_AbsoluteNBO timestamp;
165 * Number of matching bits between the hash
166 * of timestamp and the initiator's public
169 uint32_t matching_bits;
172 * Public key of the originator.
174 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded pkey;
177 * Proof of work, causing leading zeros when hashed with pkey.
179 uint64_t proof_of_work;
182 * Signature (over range specified in purpose).
184 struct GNUNET_CRYPTO_RsaSignature signature;
189 * Handle to our current configuration.
191 static const struct GNUNET_CONFIGURATION_Handle *cfg;
194 * Handle to the statistics service.
196 static struct GNUNET_STATISTICS_Handle *stats;
199 * Handle to the core service.
201 static struct GNUNET_CORE_Handle *coreAPI;
204 * Map of all connected peers.
206 static struct GNUNET_CONTAINER_MultiHashMap *peers;
209 * The current network size estimate. Number of bits matching on
212 static double current_size_estimate;
215 * The standard deviation of the last HISTORY_SIZE network
218 static double current_std_dev = NAN;
221 * Current hop counter estimate (estimate for network diameter).
223 static uint32_t hop_count_max;
226 * Message for the next round, if we got any.
228 static struct GNUNET_NSE_FloodMessage next_message;
231 * Array of recent size estimate messages.
233 static struct GNUNET_NSE_FloodMessage size_estimate_messages[HISTORY_SIZE];
236 * Index of most recent estimate.
238 static unsigned int estimate_index;
241 * Number of valid entries in the history.
243 static unsigned int estimate_count;
246 * Task scheduled to update our flood message for the next round.
248 static GNUNET_SCHEDULER_TaskIdentifier flood_task;
251 * Task scheduled to compute our proof.
253 static GNUNET_SCHEDULER_TaskIdentifier proof_task;
256 * Notification context, simplifies client broadcasts.
258 static struct GNUNET_SERVER_NotificationContext *nc;
261 * The next major time.
263 static struct GNUNET_TIME_Absolute next_timestamp;
266 * The current major time.
268 static struct GNUNET_TIME_Absolute current_timestamp;
271 * The public key of this peer.
273 static struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded my_public_key;
276 * The private key of this peer.
278 static struct GNUNET_CRYPTO_RsaPrivateKey *my_private_key;
281 * The peer identity of this peer.
283 static struct GNUNET_PeerIdentity my_identity;
286 * Proof of work for this peer.
288 static uint64_t my_proof;
292 * Initialize a message to clients with the current network
295 * @param em message to fill in
298 setup_estimate_message (struct GNUNET_NSE_ClientMessage *em)
312 /* Weighted incremental algorithm for stddev according to West (1979) */
316 for (i = 0; i < estimate_count; i++)
319 htonl (size_estimate_messages
320 [(estimate_index - i +
321 HISTORY_SIZE) % HISTORY_SIZE].matching_bits);
322 weight = 1; /* was: estimate_count + 1 - i; */
324 temp = weight + sumweight;
326 r = q * weight / temp;
327 sum += sumweight * q * r;
331 variance = sum / (sumweight - 1.0);
332 GNUNET_assert (variance >= 0);
333 std_dev = sqrt (variance);
334 current_std_dev = std_dev;
335 current_size_estimate = mean;
337 em->header.size = htons (sizeof (struct GNUNET_NSE_ClientMessage));
338 em->header.type = htons (GNUNET_MESSAGE_TYPE_NSE_ESTIMATE);
339 em->reserved = htonl (0);
340 em->timestamp = GNUNET_TIME_absolute_hton (GNUNET_TIME_absolute_get ());
341 em->size_estimate = mean - 1.0 / 3.0;
342 em->std_deviation = std_dev;
343 GNUNET_STATISTICS_set (stats, "# nodes in the network (estimate)",
344 (uint64_t) pow (2, mean - 1.0 / 3.0), GNUNET_NO);
349 * Handler for START message from client, triggers an
350 * immediate current network estimate notification.
351 * Also, we remember the client for updates upon future
352 * estimate measurements.
355 * @param client who sent the message
356 * @param message the message received
359 handle_start_message (void *cls, struct GNUNET_SERVER_Client *client,
360 const struct GNUNET_MessageHeader *message)
362 struct GNUNET_NSE_ClientMessage em;
365 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received START message from client\n");
367 GNUNET_SERVER_notification_context_add (nc, client);
368 setup_estimate_message (&em);
369 GNUNET_SERVER_notification_context_unicast (nc, client, &em.header,
371 GNUNET_SERVER_receive_done (client, GNUNET_OK);
376 * How long should we delay a message to go the given number of
379 * @param matching_bits number of matching bits to consider
382 get_matching_bits_delay (uint32_t matching_bits)
384 /* Calculated as: S + f/2 - (f / pi) * (atan(x - p')) */
385 // S is next_timestamp (ignored in return value)
386 // f is frequency (gnunet_nse_interval)
387 // x is matching_bits
388 // p' is current_size_estimate
389 return ((double) gnunet_nse_interval.rel_value / (double) 2.0) -
390 ((gnunet_nse_interval.rel_value / M_PI) *
391 atan (matching_bits - current_size_estimate));
396 * What delay randomization should we apply for a given number of matching bits?
398 * @param matching_bits number of matching bits
399 * @return random delay to apply
401 static struct GNUNET_TIME_Relative
402 get_delay_randomization (uint32_t matching_bits)
404 #if USE_RANDOM_DELAYS
405 struct GNUNET_TIME_Relative ret;
407 if (matching_bits == 0)
408 return GNUNET_TIME_UNIT_ZERO;
410 GNUNET_CRYPTO_random_u32 (GNUNET_CRYPTO_QUALITY_WEAK,
411 (uint32_t) (get_matching_bits_delay
413 1) / (double) (hop_count_max +
417 return GNUNET_TIME_UNIT_ZERO;
423 * Get the number of matching bits that the given timestamp has to the given peer ID.
425 * @param timestamp time to generate key
426 * @param id peer identity to compare with
427 * @return number of matching bits
430 get_matching_bits (struct GNUNET_TIME_Absolute timestamp,
431 const struct GNUNET_PeerIdentity *id)
433 GNUNET_HashCode timestamp_hash;
435 GNUNET_CRYPTO_hash (×tamp.abs_value, sizeof (timestamp.abs_value),
437 return GNUNET_CRYPTO_hash_matching_bits (×tamp_hash, &id->hashPubKey);
442 * Get the transmission delay that should be applied for a
445 * @param round_offset -1 for the previous round (random delay between 0 and 50ms)
446 * 0 for the current round (based on our proximity to time key)
447 * @return delay that should be applied
449 static struct GNUNET_TIME_Relative
450 get_transmit_delay (int round_offset)
452 struct GNUNET_TIME_Relative ret;
453 struct GNUNET_TIME_Absolute tgt;
455 uint32_t matching_bits;
457 switch (round_offset)
460 /* previous round is randomized between 0 and 50 ms */
461 #if USE_RANDOM_DELAYS
462 ret.rel_value = GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_WEAK, 50);
464 ret = GNUNET_TIME_UNIT_ZERO;
467 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
468 "Transmitting previous round behind schedule in %llu ms\n",
469 (unsigned long long) ret.rel_value);
473 /* current round is based on best-known matching_bits */
475 ntohl (size_estimate_messages[estimate_index].matching_bits);
476 dist_delay = get_matching_bits_delay (matching_bits);
477 dist_delay += get_delay_randomization (matching_bits).rel_value;
478 ret.rel_value = (uint64_t) dist_delay;
480 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
481 "For round %llu, delay for %u matching bits is %llu ms\n",
482 (unsigned long long) current_timestamp.abs_value,
483 (unsigned int) matching_bits,
484 (unsigned long long) ret.rel_value);
486 /* now consider round start time and add delay to it */
487 tgt = GNUNET_TIME_absolute_add (current_timestamp, ret);
488 return GNUNET_TIME_absolute_get_remaining (tgt);
491 return GNUNET_TIME_UNIT_FOREVER_REL;
496 * Task that triggers a NSE P2P transmission.
498 * @param cls the 'struct NSEPeerEntry'
499 * @param tc scheduler context
502 transmit_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
506 * Called when core is ready to send a message we asked for
507 * out to the destination.
509 * @param cls closure (NULL)
510 * @param size number of bytes available in buf
511 * @param buf where the callee should write the message
512 * @return number of bytes written to buf
515 transmit_ready (void *cls, size_t size, void *buf)
517 struct NSEPeerEntry *peer_entry = cls;
520 peer_entry->th = NULL;
523 /* client disconnected */
526 GNUNET_assert (size >= sizeof (struct GNUNET_NSE_FloodMessage));
527 idx = estimate_index;
528 if (peer_entry->previous_round == GNUNET_NO)
530 idx = (idx + HISTORY_SIZE - 1) % HISTORY_SIZE;
531 peer_entry->previous_round = GNUNET_YES;
532 peer_entry->transmit_task =
533 GNUNET_SCHEDULER_add_delayed (get_transmit_delay (0), &transmit_task,
536 if ((ntohl (size_estimate_messages[idx].hop_count) == 0) &&
537 (GNUNET_SCHEDULER_NO_TASK != proof_task))
539 GNUNET_STATISTICS_update (stats,
540 "# flood messages not generated (no proof yet)",
545 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
546 "In round %llu, sending to `%s' estimate with %u bits\n",
548 GNUNET_TIME_absolute_ntoh (size_estimate_messages[idx].
549 timestamp).abs_value,
550 GNUNET_i2s (&peer_entry->id),
551 (unsigned int) ntohl (size_estimate_messages[idx].matching_bits));
553 if (ntohl (size_estimate_messages[idx].hop_count) == 0)
554 GNUNET_STATISTICS_update (stats, "# flood messages started", 1, GNUNET_NO);
555 GNUNET_STATISTICS_update (stats, "# flood messages transmitted", 1,
557 memcpy (buf, &size_estimate_messages[idx],
558 sizeof (struct GNUNET_NSE_FloodMessage));
559 GNUNET_STATISTICS_update (stats, "# flood messages sent", 1, GNUNET_NO);
560 return sizeof (struct GNUNET_NSE_FloodMessage);
565 * Task that triggers a NSE P2P transmission.
567 * @param cls the 'struct NSEPeerEntry'
568 * @param tc scheduler context
571 transmit_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
573 struct NSEPeerEntry *peer_entry = cls;
575 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
576 GNUNET_assert (NULL == peer_entry->th);
578 GNUNET_CORE_notify_transmit_ready (coreAPI, GNUNET_NO, NSE_PRIORITY,
579 GNUNET_TIME_UNIT_FOREVER_REL,
582 GNUNET_NSE_FloodMessage),
583 &transmit_ready, peer_entry);
588 * We've sent on our flood message or one that we received which was
589 * validated and closer than ours. Update the global list of recent
590 * messages and the average. Also re-broadcast the message to any
594 update_network_size_estimate ()
596 struct GNUNET_NSE_ClientMessage em;
598 setup_estimate_message (&em);
599 GNUNET_SERVER_notification_context_broadcast (nc, &em.header, GNUNET_YES);
604 * Setup a flood message in our history array at the given
605 * slot offset for the given timestamp.
607 * @param slot index to use
608 * @param ts timestamp to use
611 setup_flood_message (unsigned int slot, struct GNUNET_TIME_Absolute ts)
613 struct GNUNET_NSE_FloodMessage *fm;
614 uint32_t matching_bits;
616 matching_bits = get_matching_bits (ts, &my_identity);
617 fm = &size_estimate_messages[slot];
618 fm->header.size = htons (sizeof (struct GNUNET_NSE_FloodMessage));
619 fm->header.type = htons (GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD);
620 fm->hop_count = htonl (0);
621 fm->purpose.purpose = htonl (GNUNET_SIGNATURE_PURPOSE_NSE_SEND);
623 htonl (sizeof (struct GNUNET_NSE_FloodMessage) -
624 sizeof (struct GNUNET_MessageHeader) - sizeof (uint32_t) -
625 sizeof (struct GNUNET_CRYPTO_RsaSignature));
626 fm->matching_bits = htonl (matching_bits);
627 fm->timestamp = GNUNET_TIME_absolute_hton (ts);
628 fm->pkey = my_public_key;
629 fm->proof_of_work = my_proof;
630 GNUNET_CRYPTO_rsa_sign (my_private_key, &fm->purpose, &fm->signature);
635 * Schedule transmission for the given peer for the current round based
636 * on what we know about the desired delay.
639 * @param key hash of peer identity
640 * @param value the 'struct NSEPeerEntry'
641 * @return GNUNET_OK (continue to iterate)
644 schedule_current_round (void *cls, const GNUNET_HashCode * key, void *value)
646 struct NSEPeerEntry *peer_entry = value;
647 struct GNUNET_TIME_Relative delay;
649 if (peer_entry->th != NULL)
651 peer_entry->previous_round = GNUNET_NO;
654 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
656 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
657 peer_entry->previous_round = GNUNET_NO;
660 get_transmit_delay ((peer_entry->previous_round == GNUNET_NO) ? -1 : 0);
661 peer_entry->transmit_task =
662 GNUNET_SCHEDULER_add_delayed (delay, &transmit_task, peer_entry);
668 * Update our flood message to be sent (and our timestamps).
671 * @param tc context for this message
674 update_flood_message (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
676 struct GNUNET_TIME_Relative offset;
679 flood_task = GNUNET_SCHEDULER_NO_TASK;
680 offset = GNUNET_TIME_absolute_get_remaining (next_timestamp);
681 if (0 != offset.rel_value)
683 /* somehow run early, delay more */
685 GNUNET_SCHEDULER_add_delayed (offset, &update_flood_message, NULL);
688 current_timestamp = next_timestamp;
690 GNUNET_TIME_absolute_add (current_timestamp, gnunet_nse_interval);
691 estimate_index = (estimate_index + 1) % HISTORY_SIZE;
692 if (estimate_count < HISTORY_SIZE)
694 if (next_timestamp.abs_value ==
695 GNUNET_TIME_absolute_ntoh (next_message.timestamp).abs_value)
697 /* we received a message for this round way early, use it! */
698 size_estimate_messages[estimate_index] = next_message;
699 size_estimate_messages[estimate_index].hop_count =
700 htonl (1 + ntohl (next_message.hop_count));
703 setup_flood_message (estimate_index, current_timestamp);
704 next_message.matching_bits = htonl (0); /* reset for 'next' round */
706 for (i = 0; i < HISTORY_SIZE; i++)
708 GNUNET_MAX (ntohl (size_estimate_messages[i].hop_count), hop_count_max);
709 GNUNET_CONTAINER_multihashmap_iterate (peers, &schedule_current_round, NULL);
711 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
712 (next_timestamp), &update_flood_message,
718 * Count the leading zeroes in hash.
721 * @return the number of leading zero bits.
724 count_leading_zeroes (const GNUNET_HashCode * hash)
726 unsigned int hash_count;
729 while ((0 == GNUNET_CRYPTO_hash_get_bit (hash, hash_count)))
736 * Check whether the given public key
737 * and integer are a valid proof of work.
739 * @param pkey the public key
740 * @param val the integer
742 * @return GNUNET_YES if valid, GNUNET_NO if not
745 check_proof_of_work (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *pkey,
748 char buf[sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
750 GNUNET_HashCode result;
752 memcpy (buf, &val, sizeof (val));
753 memcpy (&buf[sizeof (val)], pkey,
754 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
755 GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
756 return (count_leading_zeroes (&result) >=
757 nse_work_required) ? GNUNET_YES : GNUNET_NO;
762 * Write our current proof to disk.
770 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "PROOFFILE", &proof))
772 if (sizeof (my_proof) !=
773 GNUNET_DISK_fn_write (proof, &my_proof, sizeof (my_proof),
774 GNUNET_DISK_PERM_USER_READ |
775 GNUNET_DISK_PERM_USER_WRITE))
776 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", proof);
783 * Find our proof of work.
785 * @param cls closure (unused)
786 * @param tc task context
789 find_proof (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
791 #define ROUND_SIZE 10
793 char buf[sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded) +
795 GNUNET_HashCode result;
798 proof_task = GNUNET_SCHEDULER_NO_TASK;
799 memcpy (&buf[sizeof (uint64_t)], &my_public_key,
800 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded));
803 while ((counter != UINT64_MAX) && (i < ROUND_SIZE))
805 memcpy (buf, &counter, sizeof (uint64_t));
806 GNUNET_CRYPTO_hash (buf, sizeof (buf), &result);
807 if (nse_work_required <= count_leading_zeroes (&result))
811 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Proof of work found: %llu!\n",
812 (unsigned long long) GNUNET_ntohll (counter));
814 for (i = 0; i < HISTORY_SIZE; i++)
815 if (ntohl (size_estimate_messages[i].hop_count) == 0)
817 size_estimate_messages[i].proof_of_work = my_proof;
818 GNUNET_CRYPTO_rsa_sign (my_private_key,
819 &size_estimate_messages[i].purpose,
820 &size_estimate_messages[i].signature);
828 if (my_proof / (100 * ROUND_SIZE) < counter / (100 * ROUND_SIZE))
831 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Testing proofs currently at %llu\n",
832 (unsigned long long) counter);
834 /* remember progress every 100 rounds */
843 GNUNET_SCHEDULER_add_delayed (proof_find_delay, &find_proof, NULL);
848 * An incoming flood message has been received which claims
849 * to have more bits matching than any we know in this time
850 * period. Verify the signature and/or proof of work.
852 * @param incoming_flood the message to verify
854 * @return GNUNET_YES if the message is verified
855 * GNUNET_NO if the key/signature don't verify
858 verify_message_crypto (const struct GNUNET_NSE_FloodMessage *incoming_flood)
861 check_proof_of_work (&incoming_flood->pkey,
862 incoming_flood->proof_of_work))
864 GNUNET_log (GNUNET_ERROR_TYPE_INFO, _("Proof of work invalid: %llu!\n"),
866 GNUNET_ntohll (incoming_flood->proof_of_work));
871 GNUNET_CRYPTO_rsa_verify (GNUNET_SIGNATURE_PURPOSE_NSE_SEND,
872 &incoming_flood->purpose,
873 &incoming_flood->signature,
874 &incoming_flood->pkey))
884 * Update transmissions for the given peer for the current round based
885 * on updated proximity information.
887 * @param cls peer entry to exclude from updates
888 * @param key hash of peer identity
889 * @param value the 'struct NSEPeerEntry'
890 * @return GNUNET_OK (continue to iterate)
893 update_flood_times (void *cls, const GNUNET_HashCode * key, void *value)
895 struct NSEPeerEntry *exclude = cls;
896 struct NSEPeerEntry *peer_entry = value;
897 struct GNUNET_TIME_Relative delay;
899 if (peer_entry->th != NULL)
900 return GNUNET_OK; /* already active */
901 if (peer_entry == exclude)
902 return GNUNET_OK; /* trigger of the update */
903 if (peer_entry->previous_round == GNUNET_NO)
905 /* still stuck in previous round, no point to update, check that
906 * we are active here though... */
907 GNUNET_break ((peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK) ||
908 (peer_entry->th != NULL));
911 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
913 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
914 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
916 delay = get_transmit_delay (0);
917 peer_entry->transmit_task =
918 GNUNET_SCHEDULER_add_delayed (delay, &transmit_task, peer_entry);
924 * Core handler for size estimate flooding messages.
926 * @param cls closure unused
927 * @param message message
928 * @param peer peer identity this message is from (ignored)
929 * @param atsi performance data (ignored)
933 handle_p2p_size_estimate (void *cls, const struct GNUNET_PeerIdentity *peer,
934 const struct GNUNET_MessageHeader *message,
935 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
937 const struct GNUNET_NSE_FloodMessage *incoming_flood;
938 struct GNUNET_TIME_Absolute ts;
939 struct NSEPeerEntry *peer_entry;
940 uint32_t matching_bits;
945 GNUNET_BIO_write_int64 (wh, GNUNET_TIME_absolute_get ().abs_value);
947 incoming_flood = (const struct GNUNET_NSE_FloodMessage *) message;
948 GNUNET_STATISTICS_update (stats, "# flood messages received", 1, GNUNET_NO);
949 matching_bits = ntohl (incoming_flood->matching_bits);
954 struct GNUNET_PeerIdentity os;
956 GNUNET_CRYPTO_hash (&incoming_flood->pkey,
957 sizeof (struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded),
959 GNUNET_snprintf (origin, sizeof (origin), "%s", GNUNET_i2s (&os));
960 GNUNET_snprintf (pred, sizeof (pred), "%s", GNUNET_i2s (peer));
961 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
962 "Flood at %llu from `%s' via `%s' at `%s' with bits %u\n",
964 GNUNET_TIME_absolute_ntoh (incoming_flood->timestamp).abs_value,
965 origin, pred, GNUNET_i2s (&my_identity),
966 (unsigned int) matching_bits);
970 peer_entry = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
971 if (NULL == peer_entry)
977 ts = GNUNET_TIME_absolute_ntoh (incoming_flood->timestamp);
979 if (ts.abs_value == current_timestamp.abs_value)
980 idx = estimate_index;
981 else if (ts.abs_value ==
982 current_timestamp.abs_value - gnunet_nse_interval.rel_value)
983 idx = (estimate_index + HISTORY_SIZE - 1) % HISTORY_SIZE;
984 else if (ts.abs_value ==
985 next_timestamp.abs_value - gnunet_nse_interval.rel_value)
987 if (matching_bits <= ntohl (next_message.matching_bits))
988 return GNUNET_OK; /* ignore, simply too early/late */
989 if (GNUNET_YES != verify_message_crypto (incoming_flood))
994 next_message = *incoming_flood;
999 GNUNET_STATISTICS_update (stats,
1000 "# flood messages discarded (clock skew too large)",
1004 if (0 == (memcmp (peer, &my_identity, sizeof (struct GNUNET_PeerIdentity))))
1006 /* send to self, update our own estimate IF this also comes from us! */
1008 memcmp (&incoming_flood->pkey, &my_public_key, sizeof (my_public_key)))
1009 update_network_size_estimate ();
1012 if (matching_bits >= ntohl (size_estimate_messages[idx].matching_bits))
1014 /* cancel transmission from us to this peer for this round */
1015 if (idx == estimate_index)
1017 if (peer_entry->previous_round == GNUNET_YES)
1019 /* cancel any activity for current round */
1020 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1022 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
1023 peer_entry->transmit_task = GNUNET_SCHEDULER_NO_TASK;
1025 if (peer_entry->th != NULL)
1027 GNUNET_CORE_notify_transmit_ready_cancel (peer_entry->th);
1028 peer_entry->th = NULL;
1034 /* cancel previous round only */
1035 peer_entry->previous_round = GNUNET_YES;
1038 if (matching_bits == ntohl (size_estimate_messages[idx].matching_bits))
1040 if (matching_bits <= ntohl (size_estimate_messages[idx].matching_bits))
1042 if ((idx < estimate_index) && (peer_entry->previous_round == GNUNET_YES))
1043 peer_entry->previous_round = GNUNET_NO;
1044 /* push back our result now, that peer is spreading bad information... */
1045 if (NULL == peer_entry->th)
1047 if (peer_entry->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1048 GNUNET_SCHEDULER_cancel (peer_entry->transmit_task);
1049 peer_entry->transmit_task =
1050 GNUNET_SCHEDULER_add_now (&transmit_task, peer_entry);
1052 /* Not closer than our most recent message, no need to do work here */
1053 GNUNET_STATISTICS_update (stats,
1054 "# flood messages ignored (had closer already)",
1058 if (GNUNET_YES != verify_message_crypto (incoming_flood))
1060 GNUNET_break_op (0);
1063 size_estimate_messages[idx] = *incoming_flood;
1064 size_estimate_messages[idx].hop_count =
1065 htonl (ntohl (incoming_flood->hop_count) + 1);
1067 GNUNET_MAX (ntohl (incoming_flood->hop_count) + 1, hop_count_max);
1069 /* have a new, better size estimate, inform clients */
1070 update_network_size_estimate ();
1073 GNUNET_CONTAINER_multihashmap_iterate (peers, &update_flood_times,
1081 * Method called whenever a peer connects.
1083 * @param cls closure
1084 * @param peer peer identity this notification is about
1085 * @param atsi performance data
1088 handle_core_connect (void *cls, const struct GNUNET_PeerIdentity *peer,
1089 const struct GNUNET_TRANSPORT_ATS_Information *atsi)
1091 struct NSEPeerEntry *peer_entry;
1094 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s' connected to us\n",
1097 peer_entry = GNUNET_malloc (sizeof (struct NSEPeerEntry));
1098 peer_entry->id = *peer;
1099 GNUNET_CONTAINER_multihashmap_put (peers, &peer->hashPubKey, peer_entry,
1100 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
1101 peer_entry->transmit_task =
1102 GNUNET_SCHEDULER_add_delayed (get_transmit_delay (-1), &transmit_task,
1108 * Method called whenever a peer disconnects.
1110 * @param cls closure
1111 * @param peer peer identity this notification is about
1114 handle_core_disconnect (void *cls, const struct GNUNET_PeerIdentity *peer)
1116 struct NSEPeerEntry *pos;
1119 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s' disconnected from us\n",
1122 pos = GNUNET_CONTAINER_multihashmap_get (peers, &peer->hashPubKey);
1128 GNUNET_assert (GNUNET_YES ==
1129 GNUNET_CONTAINER_multihashmap_remove (peers, &peer->hashPubKey,
1131 if (pos->transmit_task != GNUNET_SCHEDULER_NO_TASK)
1132 GNUNET_SCHEDULER_cancel (pos->transmit_task);
1133 if (pos->th != NULL)
1135 GNUNET_CORE_notify_transmit_ready_cancel (pos->th);
1143 * Task run during shutdown.
1149 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1151 if (flood_task != GNUNET_SCHEDULER_NO_TASK)
1153 GNUNET_SCHEDULER_cancel (flood_task);
1154 flood_task = GNUNET_SCHEDULER_NO_TASK;
1156 if (proof_task != GNUNET_SCHEDULER_NO_TASK)
1158 GNUNET_SCHEDULER_cancel (proof_task);
1159 proof_task = GNUNET_SCHEDULER_NO_TASK;
1160 write_proof (); /* remember progress */
1164 GNUNET_SERVER_notification_context_destroy (nc);
1167 if (coreAPI != NULL)
1169 GNUNET_CORE_disconnect (coreAPI);
1174 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
1179 GNUNET_CONTAINER_multihashmap_destroy (peers);
1182 if (my_private_key != NULL)
1184 GNUNET_CRYPTO_rsa_key_free (my_private_key);
1185 my_private_key = NULL;
1187 #if ENABLE_HISTOGRAM
1190 GNUNET_BIO_write_close (wh);
1198 * Called on core init/fail.
1200 * @param cls service closure
1201 * @param server handle to the server for this service
1202 * @param identity the public identity of this peer
1203 * @param publicKey the public key of this peer
1206 core_init (void *cls, struct GNUNET_CORE_Handle *server,
1207 const struct GNUNET_PeerIdentity *identity,
1208 const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded *publicKey)
1210 struct GNUNET_TIME_Absolute now;
1211 struct GNUNET_TIME_Absolute prev_time;
1217 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Connection to core FAILED!\n");
1219 GNUNET_SCHEDULER_shutdown ();
1223 memcmp (&my_identity, identity,
1224 sizeof (struct GNUNET_PeerIdentity)));
1225 now = GNUNET_TIME_absolute_get ();
1226 current_timestamp.abs_value =
1227 (now.abs_value / gnunet_nse_interval.rel_value) *
1228 gnunet_nse_interval.rel_value;
1229 next_timestamp.abs_value =
1230 current_timestamp.abs_value + gnunet_nse_interval.rel_value;
1232 for (i = 0; i < HISTORY_SIZE; i++)
1234 prev_time.abs_value =
1235 current_timestamp.abs_value - (HISTORY_SIZE - i -
1236 1) * gnunet_nse_interval.rel_value;
1237 setup_flood_message (i, prev_time);
1239 estimate_index = HISTORY_SIZE - 1;
1242 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
1243 (next_timestamp), &update_flood_message,
1249 * Handle network size estimate clients.
1251 * @param cls closure
1252 * @param server the initialized server
1253 * @param c configuration to use
1256 run (void *cls, struct GNUNET_SERVER_Handle *server,
1257 const struct GNUNET_CONFIGURATION_Handle *c)
1262 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1263 {&handle_start_message, NULL, GNUNET_MESSAGE_TYPE_NSE_START,
1264 sizeof (struct GNUNET_MessageHeader)},
1267 static const struct GNUNET_CORE_MessageHandler core_handlers[] = {
1268 {&handle_p2p_size_estimate, GNUNET_MESSAGE_TYPE_NSE_P2P_FLOOD,
1269 sizeof (struct GNUNET_NSE_FloodMessage)},
1275 GNUNET_CONFIGURATION_get_value_time (cfg, "NSE", "INTERVAL",
1276 &gnunet_nse_interval)) ||
1278 GNUNET_CONFIGURATION_get_value_time (cfg, "NSE", "WORKDELAY",
1279 &proof_find_delay)) ||
1281 GNUNET_CONFIGURATION_get_value_number (cfg, "NSE", "WORKBITS",
1282 &nse_work_required)))
1284 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1286 ("NSE service is lacking key configuration settings. Exiting.\n"));
1287 GNUNET_SCHEDULER_shutdown ();
1290 if (nse_work_required >= sizeof (GNUNET_HashCode) * 8)
1292 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1293 _("Invalid work requirement for NSE service. Exiting.\n"));
1294 GNUNET_SCHEDULER_shutdown ();
1300 GNUNET_CONFIGURATION_get_value_filename (cfg, "GNUNETD", "HOSTKEY",
1303 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1305 ("NSE service is lacking key configuration settings. Exiting.\n"));
1306 GNUNET_SCHEDULER_shutdown ();
1309 my_private_key = GNUNET_CRYPTO_rsa_key_create_from_file (keyfile);
1310 GNUNET_free (keyfile);
1311 if (my_private_key == NULL)
1313 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1314 _("NSE service could not access hostkey. Exiting.\n"));
1315 GNUNET_SCHEDULER_shutdown ();
1318 GNUNET_CRYPTO_rsa_key_get_public (my_private_key, &my_public_key);
1319 GNUNET_CRYPTO_hash (&my_public_key, sizeof (my_public_key),
1320 &my_identity.hashPubKey);
1322 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "PROOFFILE", &proof))
1324 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
1326 ("NSE service is lacking key configuration settings. Exiting.\n"));
1327 if (my_private_key != NULL)
1329 GNUNET_CRYPTO_rsa_key_free (my_private_key);
1330 my_private_key = NULL;
1332 GNUNET_SCHEDULER_shutdown ();
1335 if ((GNUNET_YES != GNUNET_DISK_file_test (proof)) ||
1336 (sizeof (my_proof) !=
1337 GNUNET_DISK_fn_read (proof, &my_proof, sizeof (my_proof))))
1339 GNUNET_free (proof);
1341 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1344 peers = GNUNET_CONTAINER_multihashmap_create (128);
1345 GNUNET_SERVER_add_handlers (server, handlers);
1346 nc = GNUNET_SERVER_notification_context_create (server, 1);
1347 /* Connect to core service and register core handlers */
1348 coreAPI = GNUNET_CORE_connect (cfg, /* Main configuration */
1349 CORE_QUEUE_SIZE, /* queue size */
1350 NULL, /* Closure passed to functions */
1351 &core_init, /* Call core_init once connected */
1352 &handle_core_connect, /* Handle connects */
1353 &handle_core_disconnect, /* Handle disconnects */
1354 NULL, /* Do we care about "status" updates? */
1355 NULL, /* Don't want notified about all incoming messages */
1356 GNUNET_NO, /* For header only inbound notification */
1357 NULL, /* Don't want notified about all outbound messages */
1358 GNUNET_NO, /* For header only outbound notification */
1359 core_handlers); /* Register these handlers */
1360 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
1362 #if ENABLE_HISTOGRAM
1364 GNUNET_CONFIGURATION_get_value_filename (cfg, "NSE", "HISTOGRAM", &proof))
1366 wh = GNUNET_BIO_write_open (proof);
1367 GNUNET_free (proof);
1370 if (coreAPI == NULL)
1372 GNUNET_SCHEDULER_shutdown ();
1375 stats = GNUNET_STATISTICS_create ("nse", cfg);
1380 * The main function for the statistics service.
1382 * @param argc number of arguments from the command line
1383 * @param argv command line arguments
1384 * @return 0 ok, 1 on error
1387 main (int argc, char *const *argv)
1389 return (GNUNET_OK ==
1390 GNUNET_SERVICE_run (argc, argv, "nse", GNUNET_SERVICE_OPTION_NONE,
1391 &run, NULL)) ? 0 : 1;
1394 /* end of gnunet-service-nse.c */