2 This file is part of GNUnet.
3 (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010 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 peerinfo/gnunet-service-peerinfo.c
23 * @brief maintains list of known peers
25 * Code to maintain the list of currently known hosts (in memory
26 * structure of data/hosts/).
28 * @author Christian Grothoff
31 * - HostEntries are never 'free'd (add expiration, upper bound?)
35 #include "gnunet_crypto_lib.h"
36 #include "gnunet_container_lib.h"
37 #include "gnunet_disk_lib.h"
38 #include "gnunet_hello_lib.h"
39 #include "gnunet_protocols.h"
40 #include "gnunet_service_lib.h"
41 #include "gnunet_statistics_service.h"
45 * How often do we scan the HOST_DIR for new entries?
47 #define DATA_HOST_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
50 * How often do we discard old entries in data/hosts/?
52 #define DATA_HOST_CLEAN_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 60)
55 * In-memory cache of known hosts.
61 * Identity of the peer.
63 struct GNUNET_PeerIdentity identity;
66 * Hello for the peer (can be NULL)
68 struct GNUNET_HELLO_Message *hello;
74 * The in-memory list of known hosts, mapping of
75 * host IDs to 'struct HostEntry*' values.
77 static struct GNUNET_CONTAINER_MultiHashMap *hostmap;
80 * Clients to immediately notify about all changes.
82 static struct GNUNET_SERVER_NotificationContext *notify_list;
85 * Directory where the hellos are stored in (data/hosts)
87 static char *networkIdDirectory;
90 * Handle for reporting statistics.
92 static struct GNUNET_STATISTICS_Handle *stats;
96 * Notify all clients in the notify list about the
97 * given host entry changing.
99 static struct InfoMessage *
100 make_info_message (const struct HostEntry *he)
102 struct InfoMessage *im;
105 hs = (he->hello == NULL) ? 0 : GNUNET_HELLO_size (he->hello);
106 im = GNUNET_malloc (sizeof (struct InfoMessage) + hs);
107 im->header.size = htons (hs + sizeof (struct InfoMessage));
108 im->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_INFO);
109 im->peer = he->identity;
110 if (he->hello != NULL)
111 memcpy (&im[1], he->hello, hs);
117 * Address iterator that causes expired entries to be discarded.
119 * @param cls pointer to the current time
120 * @param tname name of the transport
121 * @param expiration expiration time for the address
122 * @param addr the address
123 * @param addrlen length of addr in bytes
124 * @return GNUNET_NO if expiration smaller than the current time
127 discard_expired (void *cls,
129 struct GNUNET_TIME_Absolute expiration,
130 const void *addr, uint16_t addrlen)
132 const struct GNUNET_TIME_Absolute *now = cls;
133 if (now->value > expiration.value)
135 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
136 _("Removing expired address of transport `%s'\n"),
145 * Get the filename under which we would store the GNUNET_HELLO_Message
146 * for the given host and protocol.
147 * @return filename of the form DIRECTORY/HOSTID
150 get_host_filename (const struct GNUNET_PeerIdentity *id)
152 struct GNUNET_CRYPTO_HashAsciiEncoded fil;
155 GNUNET_CRYPTO_hash_to_enc (&id->hashPubKey, &fil);
156 GNUNET_asprintf (&fn,
157 "%s%s%s", networkIdDirectory, DIR_SEPARATOR_STR, &fil);
163 * Broadcast information about the given entry to all
166 * @param entry entry to broadcast about
169 notify_all (struct HostEntry *entry)
171 struct InfoMessage *msg;
173 msg = make_info_message (entry);
174 GNUNET_SERVER_notification_context_broadcast (notify_list,
182 * Add a host to the list.
184 * @param identity the identity of the host
187 add_host_to_known_hosts (const struct GNUNET_PeerIdentity *identity)
189 struct HostEntry *entry;
190 char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
191 const struct GNUNET_HELLO_Message *hello;
192 struct GNUNET_HELLO_Message *hello_clean;
194 struct GNUNET_TIME_Absolute now;
197 entry = GNUNET_CONTAINER_multihashmap_get (hostmap,
198 &identity->hashPubKey);
201 GNUNET_STATISTICS_update (stats,
202 gettext_noop ("# peers known"),
205 entry = GNUNET_malloc (sizeof (struct HostEntry));
206 entry->identity = *identity;
208 fn = get_host_filename (identity);
209 if (GNUNET_DISK_file_test (fn) == GNUNET_YES)
211 size = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
212 hello = (const struct GNUNET_HELLO_Message *) buffer;
213 if ( (size < sizeof (struct GNUNET_MessageHeader)) ||
214 (size != ntohs((((const struct GNUNET_MessageHeader*) hello)->size))) ||
215 (size != GNUNET_HELLO_size (hello)) )
218 if (0 != UNLINK (fn))
219 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
225 now = GNUNET_TIME_absolute_get ();
226 hello_clean = GNUNET_HELLO_iterate_addresses (hello,
228 &discard_expired, &now);
229 entry->hello = hello_clean;
233 GNUNET_CONTAINER_multihashmap_put (hostmap,
234 &identity->hashPubKey,
236 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
242 * Remove a file that should not be there. LOG
243 * success or failure.
246 remove_garbage (const char *fullname)
248 if (0 == UNLINK (fullname))
249 GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
251 ("File `%s' in directory `%s' does not match naming convention. "
252 "Removed.\n"), fullname, networkIdDirectory);
254 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR |
255 GNUNET_ERROR_TYPE_BULK, "unlink", fullname);
260 hosts_directory_scan_callback (void *cls,
261 const char *fullname)
263 unsigned int *matched = cls;
264 struct GNUNET_PeerIdentity identity;
265 const char *filename;
267 if (GNUNET_DISK_file_test (fullname) != GNUNET_YES)
268 return GNUNET_OK; /* ignore non-files */
269 if (strlen (fullname) < sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded))
271 remove_garbage (fullname);
275 &fullname[strlen (fullname) -
276 sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1];
277 if (filename[-1] != DIR_SEPARATOR)
279 remove_garbage (fullname);
282 if (GNUNET_OK != GNUNET_CRYPTO_hash_from_string (filename,
283 &identity.hashPubKey))
285 remove_garbage (fullname);
289 add_host_to_known_hosts (&identity);
295 * Call this method periodically to scan data/hosts for new hosts.
298 cron_scan_directory_data_hosts (void *cls,
299 const struct GNUNET_SCHEDULER_TaskContext *tc)
301 static unsigned int retries;
304 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
307 GNUNET_DISK_directory_create (networkIdDirectory);
308 GNUNET_DISK_directory_scan (networkIdDirectory,
309 &hosts_directory_scan_callback, &count);
310 if ((0 == count) && (0 == (++retries & 31)))
311 GNUNET_log (GNUNET_ERROR_TYPE_WARNING |
312 GNUNET_ERROR_TYPE_BULK,
313 _("Still no peers found in `%s'!\n"), networkIdDirectory);
314 GNUNET_SCHEDULER_add_delayed (tc->sched,
316 &cron_scan_directory_data_hosts, NULL);
321 * Bind a host address (hello) to a hostId.
323 * @param peer the peer for which this is a hello
324 * @param hello the verified (!) hello message
327 bind_address (const struct GNUNET_PeerIdentity *peer,
328 const struct GNUNET_HELLO_Message *hello)
331 struct HostEntry *host;
332 struct GNUNET_HELLO_Message *mrg;
333 struct GNUNET_TIME_Absolute delta;
335 add_host_to_known_hosts (peer);
336 host = GNUNET_CONTAINER_multihashmap_get (hostmap,
338 GNUNET_assert (host != NULL);
339 if (host->hello == NULL)
341 host->hello = GNUNET_malloc (GNUNET_HELLO_size (hello));
342 memcpy (host->hello, hello, GNUNET_HELLO_size (hello));
346 mrg = GNUNET_HELLO_merge (host->hello, hello);
347 delta = GNUNET_HELLO_equals (mrg,
349 GNUNET_TIME_absolute_get ());
350 if (delta.value == GNUNET_TIME_UNIT_FOREVER_ABS.value)
355 GNUNET_free (host->hello);
358 fn = get_host_filename (peer);
359 GNUNET_DISK_directory_create_for_file (fn);
360 GNUNET_DISK_fn_write (fn,
362 GNUNET_HELLO_size (host->hello),
363 GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE
364 | GNUNET_DISK_PERM_GROUP_READ | GNUNET_DISK_PERM_OTHER_READ);
372 * Do transmit info about peer to given host.
374 * @param cls NULL to hit all hosts, otherwise specifies a particular target
376 * @param value information to transmit
377 * @return GNUNET_YES (continue to iterate)
380 add_to_tc (void *cls,
381 const GNUNET_HashCode *key,
384 struct GNUNET_SERVER_TransmitContext *tc = cls;
385 struct HostEntry *pos = value;
386 struct InfoMessage *im;
388 char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
391 im = (struct InfoMessage *) buf;
392 if (pos->hello != NULL)
394 hs = GNUNET_HELLO_size (pos->hello);
396 GNUNET_SERVER_MAX_MESSAGE_SIZE -
397 sizeof (struct InfoMessage));
398 memcpy (&im[1], pos->hello, hs);
400 im->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_INFO);
401 im->header.size = htons (sizeof (struct InfoMessage) + hs);
402 im->reserved = htonl (0);
403 im->peer = pos->identity;
404 GNUNET_SERVER_transmit_context_append_message (tc,
411 * @brief delete expired HELLO entries in data/hosts/
414 discard_hosts_helper (void *cls, const char *fn)
416 struct GNUNET_TIME_Absolute *now = cls;
417 char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
418 const struct GNUNET_HELLO_Message *hello;
419 struct GNUNET_HELLO_Message *new_hello;
422 size = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
423 if (size < sizeof (struct GNUNET_MessageHeader))
425 if (0 != UNLINK (fn))
426 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
427 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
430 hello = (const struct GNUNET_HELLO_Message *) buffer;
431 new_hello = GNUNET_HELLO_iterate_addresses (hello,
433 &discard_expired, now);
434 if (new_hello != NULL)
436 GNUNET_DISK_fn_write (fn,
438 GNUNET_HELLO_size (new_hello),
439 GNUNET_DISK_PERM_USER_READ | GNUNET_DISK_PERM_USER_WRITE
440 | GNUNET_DISK_PERM_GROUP_READ | GNUNET_DISK_PERM_OTHER_READ);
441 GNUNET_free (new_hello);
445 if (0 != UNLINK (fn))
446 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
447 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
454 * Call this method periodically to scan data/hosts for new hosts.
457 cron_clean_data_hosts (void *cls,
458 const struct GNUNET_SCHEDULER_TaskContext *tc)
460 struct GNUNET_TIME_Absolute now;
462 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
464 now = GNUNET_TIME_absolute_get ();
465 GNUNET_DISK_directory_scan (networkIdDirectory,
466 &discard_hosts_helper, &now);
467 GNUNET_SCHEDULER_add_delayed (tc->sched,
468 DATA_HOST_CLEAN_FREQ,
469 &cron_clean_data_hosts, NULL);
474 * Handle HELLO-message.
477 * @param client identification of the client
478 * @param message the actual message
481 handle_hello (void *cls,
482 struct GNUNET_SERVER_Client *client,
483 const struct GNUNET_MessageHeader *message)
485 const struct GNUNET_HELLO_Message *hello;
486 struct GNUNET_PeerIdentity pid;
488 hello = (const struct GNUNET_HELLO_Message *) message;
489 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
492 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
496 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
497 "`%s' message received for peer `%4s'\n",
501 bind_address (&pid, hello);
502 GNUNET_SERVER_receive_done (client, GNUNET_OK);
507 * Handle GET-message.
510 * @param client identification of the client
511 * @param message the actual message
514 handle_get (void *cls,
515 struct GNUNET_SERVER_Client *client,
516 const struct GNUNET_MessageHeader *message)
518 const struct ListPeerMessage *lpm;
519 struct GNUNET_SERVER_TransmitContext *tc;
521 lpm = (const struct ListPeerMessage *) message;
522 GNUNET_break (0 == ntohl (lpm->reserved));
524 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
525 "`%s' message received for peer `%4s'\n",
527 GNUNET_i2s (&lpm->peer));
529 tc = GNUNET_SERVER_transmit_context_create (client);
530 GNUNET_CONTAINER_multihashmap_get_multiple (hostmap,
531 &lpm->peer.hashPubKey,
534 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
535 GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END);
536 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
541 * Handle GET-ALL-message.
544 * @param client identification of the client
545 * @param message the actual message
548 handle_get_all (void *cls,
549 struct GNUNET_SERVER_Client *client,
550 const struct GNUNET_MessageHeader *message)
552 struct GNUNET_SERVER_TransmitContext *tc;
555 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
556 "`%s' message received\n",
559 tc = GNUNET_SERVER_transmit_context_create (client);
560 GNUNET_CONTAINER_multihashmap_iterate (hostmap,
563 GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
564 GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END);
565 GNUNET_SERVER_transmit_context_run (tc, GNUNET_TIME_UNIT_FOREVER_REL);
570 do_notify_entry (void *cls,
571 const GNUNET_HashCode *key,
574 struct GNUNET_SERVER_Client *client = cls;
575 struct HostEntry *he = value;
576 struct InfoMessage *msg;
578 msg = make_info_message (he);
579 GNUNET_SERVER_notification_context_unicast (notify_list,
589 * Handle NOTIFY-message.
592 * @param client identification of the client
593 * @param message the actual message
596 handle_notify (void *cls,
597 struct GNUNET_SERVER_Client *client,
598 const struct GNUNET_MessageHeader *message)
601 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
602 "`%s' message received\n",
605 GNUNET_SERVER_notification_context_add (notify_list,
607 GNUNET_CONTAINER_multihashmap_iterate (hostmap,
614 free_host_entry (void *cls,
615 const GNUNET_HashCode *key,
618 struct HostEntry *he = value;
620 GNUNET_free_non_null (he->hello);
626 * Clean up our state. Called during shutdown.
629 * @param tc scheduler task context, unused
632 shutdown_task (void *cls,
633 const struct GNUNET_SCHEDULER_TaskContext *tc)
635 GNUNET_SERVER_notification_context_destroy (notify_list);
637 GNUNET_CONTAINER_multihashmap_iterate (hostmap,
640 GNUNET_CONTAINER_multihashmap_destroy (hostmap);
643 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
650 * Process statistics requests.
653 * @param sched scheduler to use
654 * @param server the initialized server
655 * @param cfg configuration to use
659 struct GNUNET_SCHEDULER_Handle *sched,
660 struct GNUNET_SERVER_Handle *server,
661 const struct GNUNET_CONFIGURATION_Handle *cfg)
663 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
664 {&handle_hello, NULL, GNUNET_MESSAGE_TYPE_HELLO, 0},
665 {&handle_get, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_GET,
666 sizeof (struct ListPeerMessage)},
667 {&handle_get_all, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL,
668 sizeof (struct GNUNET_MessageHeader)},
669 {&handle_notify, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY,
670 sizeof (struct GNUNET_MessageHeader)},
674 hostmap = GNUNET_CONTAINER_multihashmap_create (1024);
675 stats = GNUNET_STATISTICS_create (sched, "peerinfo", cfg);
676 notify_list = GNUNET_SERVER_notification_context_create (server, 0);
677 GNUNET_assert (GNUNET_OK ==
678 GNUNET_CONFIGURATION_get_value_filename (cfg,
681 &networkIdDirectory));
682 GNUNET_DISK_directory_create (networkIdDirectory);
683 GNUNET_SCHEDULER_add_with_priority (sched,
684 GNUNET_SCHEDULER_PRIORITY_IDLE,
685 &cron_scan_directory_data_hosts, NULL);
686 GNUNET_SCHEDULER_add_with_priority (sched,
687 GNUNET_SCHEDULER_PRIORITY_IDLE,
688 &cron_clean_data_hosts, NULL);
689 GNUNET_SCHEDULER_add_delayed (sched,
690 GNUNET_TIME_UNIT_FOREVER_REL,
691 &shutdown_task, NULL);
692 GNUNET_SERVER_add_handlers (server, handlers);
697 * The main function for the statistics service.
699 * @param argc number of arguments from the command line
700 * @param argv command line arguments
701 * @return 0 ok, 1 on error
704 main (int argc, char *const *argv)
709 GNUNET_SERVICE_run (argc,
712 GNUNET_SERVICE_OPTION_NONE,
713 &run, NULL)) ? 0 : 1;
714 GNUNET_free_non_null (networkIdDirectory);
719 /* end of gnunet-service-peerinfo.c */