2 This file is part of GNUnet.
3 (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010, 2012 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 * - notify clients when addresses in HELLO expire (#1933)
35 #include "gnunet_util_lib.h"
36 #include "gnunet_hello_lib.h"
37 #include "gnunet_protocols.h"
38 #include "gnunet_statistics_service.h"
42 * How often do we scan the HOST_DIR for new entries?
44 #define DATA_HOST_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
47 * How often do we discard old entries in data/hosts/?
49 #define DATA_HOST_CLEAN_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 60)
53 * In-memory cache of known hosts.
59 * Identity of the peer.
61 struct GNUNET_PeerIdentity identity;
64 * Hello for the peer (can be NULL)
66 struct GNUNET_HELLO_Message *hello;
69 * Friend only hello for the peer (can be NULL)
71 struct GNUNET_HELLO_Message *friend_only_hello;
76 * Transmit context for GET requests
78 struct TransmitContext
81 * Server transmit context
83 struct GNUNET_SERVER_TransmitContext *tc;
86 * Include friend only HELLOs GNUNET_YES or _NO
92 * Result of reading a file
94 struct ReadHostFileContext
97 * Hello for the peer (can be NULL)
99 struct GNUNET_HELLO_Message *hello;
102 * Friend only hello for the peer (can be NULL)
104 struct GNUNET_HELLO_Message *friend_only_hello;
109 * Client notification context
111 struct NotificationContext
116 struct NotificationContext *prev;
121 struct NotificationContext *next;
126 struct GNUNET_SERVER_Client *client;
129 * Interested in friend only HELLO?
131 int include_friend_only;
136 * The in-memory list of known hosts, mapping of
137 * host IDs to 'struct HostEntry*' values.
139 static struct GNUNET_CONTAINER_MultiPeerMap *hostmap;
142 * Clients to immediately notify about all changes.
144 static struct GNUNET_SERVER_NotificationContext *notify_list;
147 * Directory where the hellos are stored in (peerinfo/)
149 static char *networkIdDirectory;
152 * Handle for reporting statistics.
154 static struct GNUNET_STATISTICS_Handle *stats;
157 * DLL of notification contexts: head
159 static struct NotificationContext *nc_head;
162 * DLL of notification contexts: tail
164 static struct NotificationContext *nc_tail;
168 * Notify all clients in the notify list about the
169 * given host entry changing.
171 * @param he entry of the host for which we generate a notification
172 * @param include_friend_only create public of friend-only message
173 * @return generated notification message
175 static struct InfoMessage *
176 make_info_message (const struct HostEntry *he, int include_friend_only)
178 struct InfoMessage *im;
179 struct GNUNET_HELLO_Message *src;
182 if (GNUNET_YES == include_friend_only)
183 src = he->friend_only_hello;
187 hs = (NULL == src) ? 0 : GNUNET_HELLO_size (src);
188 im = GNUNET_malloc (sizeof (struct InfoMessage) + hs);
189 im->header.size = htons (hs + sizeof (struct InfoMessage));
190 im->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_INFO);
191 im->peer = he->identity;
193 memcpy (&im[1], src, hs);
199 * Address iterator that causes expired entries to be discarded.
201 * @param cls pointer to the current time
202 * @param address the address
203 * @param expiration expiration time for the address
204 * @return GNUNET_NO if expiration smaller than the current time
207 discard_expired (void *cls, const struct GNUNET_HELLO_Address *address,
208 struct GNUNET_TIME_Absolute expiration)
210 const struct GNUNET_TIME_Absolute *now = cls;
212 if (now->abs_value_us > expiration.abs_value_us)
214 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
215 _("Removing expired address of transport `%s'\n"),
216 address->transport_name);
224 * Address iterator that counts the remaining addresses.
226 * @param cls pointer to the counter
227 * @param address the address
228 * @param expiration expiration time for the address
229 * @return GNUNET_OK (always)
232 count_addresses (void *cls, const struct GNUNET_HELLO_Address *address,
233 struct GNUNET_TIME_Absolute expiration)
235 unsigned int *cnt = cls;
243 * Get the filename under which we would store the GNUNET_HELLO_Message
244 * for the given host and protocol.
246 * @param id peer for which we need the filename for the HELLO
247 * @return filename of the form DIRECTORY/HOSTID
250 get_host_filename (const struct GNUNET_PeerIdentity *id)
254 if (NULL == networkIdDirectory)
256 GNUNET_asprintf (&fn, "%s%s%s", networkIdDirectory, DIR_SEPARATOR_STR,
257 GNUNET_i2s_full (id));
263 * Broadcast information about the given entry to all
266 * @param entry entry to broadcast about
269 notify_all (struct HostEntry *entry)
271 struct InfoMessage *msg_pub;
272 struct InfoMessage *msg_friend;
273 struct NotificationContext *cur;
275 msg_pub = make_info_message (entry, GNUNET_NO);
276 msg_friend = make_info_message (entry, GNUNET_YES);
277 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
278 "Notifying all clients about peer `%s'\n",
279 GNUNET_i2s(&entry->identity));
280 for (cur = nc_head; NULL != cur; cur = cur->next)
282 if (GNUNET_NO == cur->include_friend_only)
284 GNUNET_SERVER_notification_context_unicast (notify_list,
289 if (GNUNET_YES == cur->include_friend_only)
291 GNUNET_SERVER_notification_context_unicast (notify_list,
297 GNUNET_free (msg_pub);
298 GNUNET_free (msg_friend);
303 * Bind a host address (hello) to a hostId.
305 * @param peer the peer for which this is a hello
306 * @param hello the verified (!) hello message
309 update_hello (const struct GNUNET_PeerIdentity *peer,
310 const struct GNUNET_HELLO_Message *hello);
314 * Try to read the HELLOs in the given filename and discard expired
315 * addresses. Removes the file if one the HELLO is mal-formed. If all
316 * addresses are expired, the HELLO is also removed (but the HELLO
317 * with the public key is still returned if it was found and valid).
319 * The file can contain multiple HELLO messages, but onlu a public and a friend only
320 * HELLO should be included
322 * @param fn name of the file
323 * @param unlink_garbage if GNUNET_YES, try to remove useless files
324 * @param r ReadHostFileContext to store the resutl
327 read_host_file (const char *fn, int unlink_garbage, struct ReadHostFileContext *r)
329 char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
330 unsigned int size_total;
331 struct GNUNET_TIME_Absolute now;
334 const struct GNUNET_HELLO_Message *hello;
335 struct GNUNET_HELLO_Message *hello_clean;
339 r->friend_only_hello = NULL;
342 if (GNUNET_YES != GNUNET_DISK_file_test (fn))
347 size_total = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
348 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Read %u bytes from `%s'\n", size_total, fn);
349 if (size_total < sizeof (struct GNUNET_MessageHeader))
351 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
352 _("Failed to parse HELLO in file `%s': %s\n"),
353 fn, "Fail has invalid size");
354 if ( (GNUNET_YES == unlink_garbage) &&
355 (0 != UNLINK (fn)) &&
357 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
362 while (read_pos < size_total)
364 hello = (const struct GNUNET_HELLO_Message *) &buffer[read_pos];
365 size_hello = GNUNET_HELLO_size (hello);
368 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
369 _("Failed to parse HELLO in file `%s': %s %u \n"),
370 fn, "HELLO is invalid and has size of ", size_hello);
371 if ((GNUNET_YES == unlink_garbage) &&
372 (0 != UNLINK (fn)) &&
374 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
378 now = GNUNET_TIME_absolute_get ();
379 hello_clean = GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES,
380 &discard_expired, &now);
382 (void) GNUNET_HELLO_iterate_addresses (hello_clean, GNUNET_NO,
383 &count_addresses, &left);
387 GNUNET_free (hello_clean);
391 if (GNUNET_NO == GNUNET_HELLO_is_friend_only (hello_clean))
393 if (NULL == r->hello)
394 r->hello = hello_clean;
398 GNUNET_free (r->hello);
399 r->hello = hello_clean;
404 if (NULL == r->friend_only_hello)
405 r->friend_only_hello = hello_clean;
409 GNUNET_free (r->friend_only_hello);
410 r->friend_only_hello = hello_clean;
413 read_pos += size_hello;
418 /* no addresses left, remove from disk */
419 if ((GNUNET_YES == unlink_garbage) && (0 != UNLINK (fn)))
420 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
423 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
424 "Found `%s' and `%s' HELLO message in file\n",
425 (NULL != r->hello) ? "public" : "NO public",
426 (NULL != r->friend_only_hello) ? "friend only" : "NO friend only");
431 * Add a host to the list and notify clients about this event
433 * @param identity the identity of the host
434 * @return the HostEntry
436 static struct HostEntry *
437 add_host_to_known_hosts (const struct GNUNET_PeerIdentity *identity)
439 struct HostEntry *entry;
440 struct ReadHostFileContext r;
443 entry = GNUNET_CONTAINER_multipeermap_get (hostmap, identity);
446 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Adding new peer `%s'\n", GNUNET_i2s (identity));
447 GNUNET_STATISTICS_update (stats, gettext_noop ("# peers known"), 1,
449 entry = GNUNET_new (struct HostEntry);
450 entry->identity = *identity;
451 GNUNET_assert (GNUNET_OK ==
452 GNUNET_CONTAINER_multipeermap_put (hostmap, &entry->identity, entry,
453 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
455 fn = get_host_filename (identity);
458 read_host_file (fn, GNUNET_YES, &r);
460 update_hello (identity, r.hello);
461 if (NULL != r.friend_only_hello)
462 update_hello (identity, r.friend_only_hello);
463 GNUNET_free_non_null (r.hello);
464 GNUNET_free_non_null (r.friend_only_hello);
473 * Remove a file that should not be there. LOG
474 * success or failure.
476 * @param fullname name of the file to remove
479 remove_garbage (const char *fullname)
481 if (0 == UNLINK (fullname))
482 GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
484 ("File `%s' in directory `%s' does not match naming convention. "
485 "Removed.\n"), fullname, networkIdDirectory);
487 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
493 * Closure for 'hosts_directory_scan_callback'.
495 struct DirScanContext
498 * GNUNET_YES if we should remove files that are broken,
499 * GNUNET_NO if the directory we are iterating over should
500 * be treated as read-only by us.
505 * Counter for the number of (valid) entries found, incremented
506 * by one for each match.
508 unsigned int matched;
513 * Function that is called on each HELLO file in a particular directory.
514 * Try to parse the file and add the HELLO to our list.
516 * @param cls pointer to 'unsigned int' to increment for each file, or NULL
517 * if the file is from a read-only, read-once resource directory
518 * @param fullname name of the file to parse
519 * @return #GNUNET_OK (continue iteration)
522 hosts_directory_scan_callback (void *cls, const char *fullname)
524 struct DirScanContext *dsc = cls;
525 struct GNUNET_PeerIdentity identity;
526 struct ReadHostFileContext r;
527 const char *filename;
528 struct GNUNET_PeerIdentity id_public;
529 struct GNUNET_PeerIdentity id_friend;
530 struct GNUNET_PeerIdentity id;
532 if (GNUNET_YES != GNUNET_DISK_file_test (fullname))
533 return GNUNET_OK; /* ignore non-files */
535 filename = strrchr (fullname, DIR_SEPARATOR);
536 if ((NULL == filename) || (1 > strlen (filename)))
541 read_host_file (fullname, dsc->remove_files, &r);
542 if ( (NULL == r.hello) && (NULL == r.friend_only_hello))
544 if (GNUNET_YES == dsc->remove_files)
545 remove_garbage (fullname);
549 if (NULL != r.friend_only_hello)
551 if (GNUNET_OK != GNUNET_HELLO_get_id (r.friend_only_hello, &id_friend))
552 if (GNUNET_YES == dsc->remove_files)
554 remove_garbage (fullname);
561 if (GNUNET_OK != GNUNET_HELLO_get_id (r.hello, &id_public))
562 if (GNUNET_YES == dsc->remove_files)
564 remove_garbage (fullname);
570 if ( (NULL != r.hello) && (NULL != r.friend_only_hello) &&
571 (0 != memcmp (&id_friend, &id_public, sizeof (id_friend))) )
573 /* HELLOs are not for the same peer */
575 if (GNUNET_YES == dsc->remove_files)
576 remove_garbage (fullname);
579 if (GNUNET_OK == GNUNET_CRYPTO_eddsa_public_key_from_string (filename,
581 &identity.public_key))
583 if (0 != memcmp (&id, &identity, sizeof (id_friend)))
585 /* HELLOs are not for the same peer */
587 if (GNUNET_YES == dsc->remove_files)
588 remove_garbage (fullname);
593 /* ok, found something valid, remember HELLO */
594 add_host_to_known_hosts (&id);
597 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating peer `%s' public HELLO \n",
599 update_hello (&id, r.hello);
600 GNUNET_free (r.hello);
602 if (NULL != r.friend_only_hello)
604 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating peer `%s' friend only HELLO \n",
606 update_hello (&id, r.friend_only_hello);
607 GNUNET_free (r.friend_only_hello);
615 * Call this method periodically to scan data/hosts for new hosts.
618 * @param tc scheduler context, aborted if reason is shutdown
621 cron_scan_directory_data_hosts (void *cls,
622 const struct GNUNET_SCHEDULER_TaskContext *tc)
624 static unsigned int retries;
625 struct DirScanContext dsc;
627 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
629 if (GNUNET_SYSERR == GNUNET_DISK_directory_create (networkIdDirectory))
631 GNUNET_SCHEDULER_add_delayed_with_priority (DATA_HOST_FREQ,
632 GNUNET_SCHEDULER_PRIORITY_IDLE,
633 &cron_scan_directory_data_hosts, NULL);
637 dsc.remove_files = GNUNET_YES;
638 GNUNET_log (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
639 _("Scanning directory `%s'\n"), networkIdDirectory);
640 GNUNET_DISK_directory_scan (networkIdDirectory,
641 &hosts_directory_scan_callback, &dsc);
642 if ((0 == dsc.matched) && (0 == (++retries & 31)))
643 GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
644 _("Still no peers found in `%s'!\n"), networkIdDirectory);
645 GNUNET_SCHEDULER_add_delayed_with_priority (DATA_HOST_FREQ,
646 GNUNET_SCHEDULER_PRIORITY_IDLE,
647 &cron_scan_directory_data_hosts,
652 static struct GNUNET_HELLO_Message *
653 update_friend_hello (const struct GNUNET_HELLO_Message *hello,
654 const struct GNUNET_HELLO_Message *friend_hello)
656 struct GNUNET_HELLO_Message * res;
657 struct GNUNET_HELLO_Message * tmp;
658 struct GNUNET_CRYPTO_EddsaPublicKey pk;
660 if (NULL != friend_hello)
662 res = GNUNET_HELLO_merge (hello, friend_hello);
663 GNUNET_assert (GNUNET_YES == GNUNET_HELLO_is_friend_only (res));
668 GNUNET_HELLO_get_key (hello, &pk))
673 tmp = GNUNET_HELLO_create (&pk, NULL, NULL, GNUNET_YES);
674 res = GNUNET_HELLO_merge (hello, tmp);
676 GNUNET_assert (GNUNET_YES == GNUNET_HELLO_is_friend_only (res));
682 * Bind a host address (hello) to a hostId.
684 * @param peer the peer for which this is a hello
685 * @param hello the verified (!) hello message
688 update_hello (const struct GNUNET_PeerIdentity *peer,
689 const struct GNUNET_HELLO_Message *hello)
692 struct HostEntry *host;
693 struct GNUNET_HELLO_Message *mrg;
694 struct GNUNET_HELLO_Message **dest;
695 struct GNUNET_TIME_Absolute delta;
698 int friend_hello_type;
700 int store_friend_hello;
704 host = GNUNET_CONTAINER_multipeermap_get (hostmap, peer);
705 GNUNET_assert (NULL != host);
707 friend_hello_type = GNUNET_HELLO_is_friend_only (hello);
708 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Updating %s HELLO for `%s'\n",
709 (GNUNET_YES == friend_hello_type) ? "friend-only" : "public",
713 if (GNUNET_YES == friend_hello_type)
715 dest = &host->friend_only_hello;
724 (*dest) = GNUNET_malloc (GNUNET_HELLO_size (hello));
725 memcpy ((*dest), hello, GNUNET_HELLO_size (hello));
729 mrg = GNUNET_HELLO_merge ((*dest), hello);
730 delta = GNUNET_HELLO_equals (mrg, (*dest), GNUNET_TIME_absolute_get ());
731 if (delta.abs_value_us == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
733 /* no differences, just ignore the update */
734 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "No change in %s HELLO for `%s'\n",
735 (GNUNET_YES == friend_hello_type) ? "friend-only" : "public",
740 GNUNET_free ((*dest));
744 if ((NULL != (host->hello)) && (GNUNET_NO == friend_hello_type))
746 /* Update friend only hello */
747 mrg = update_friend_hello (host->hello, host->friend_only_hello);
748 if (NULL != host->friend_only_hello)
749 GNUNET_free (host->friend_only_hello);
750 host->friend_only_hello = mrg;
753 if (NULL != host->hello)
754 GNUNET_assert ((GNUNET_NO == GNUNET_HELLO_is_friend_only (host->hello)));
755 if (NULL != host->friend_only_hello)
756 GNUNET_assert ((GNUNET_YES == GNUNET_HELLO_is_friend_only(host->friend_only_hello)));
758 fn = get_host_filename (peer);
760 (GNUNET_OK == GNUNET_DISK_directory_create_for_file (fn)) )
762 store_hello = GNUNET_NO;
765 if (NULL != host->hello)
766 (void) GNUNET_HELLO_iterate_addresses (host->hello,
767 GNUNET_NO, &count_addresses, &cnt);
770 store_hello = GNUNET_YES;
771 size += GNUNET_HELLO_size (host->hello);
774 if (NULL != host->friend_only_hello)
775 (void) GNUNET_HELLO_iterate_addresses (host->friend_only_hello, GNUNET_NO,
776 &count_addresses, &cnt);
777 store_friend_hello = GNUNET_NO;
780 store_friend_hello = GNUNET_YES;
781 size += GNUNET_HELLO_size (host->friend_only_hello);
784 if ((GNUNET_NO == store_hello) && (GNUNET_NO == store_friend_hello))
786 /* no valid addresses, don't put HELLO on disk; in fact,
787 if one exists on disk, remove it */
792 buffer = GNUNET_malloc (size);
795 if (GNUNET_YES == store_hello)
797 memcpy (buffer, host->hello, GNUNET_HELLO_size (host->hello));
798 pos += GNUNET_HELLO_size (host->hello);
800 if (GNUNET_YES == store_friend_hello)
802 memcpy (&buffer[pos], host->friend_only_hello, GNUNET_HELLO_size (host->friend_only_hello));
803 pos += GNUNET_HELLO_size (host->friend_only_hello);
805 GNUNET_assert (pos == size);
807 if (GNUNET_SYSERR == GNUNET_DISK_fn_write (fn, buffer, size,
808 GNUNET_DISK_PERM_USER_READ |
809 GNUNET_DISK_PERM_USER_WRITE |
810 GNUNET_DISK_PERM_GROUP_READ |
811 GNUNET_DISK_PERM_OTHER_READ))
812 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
814 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Stored %s %s HELLO in %s with total size %u\n",
815 (GNUNET_YES == store_friend_hello) ? "friend-only": "",
816 (GNUNET_YES == store_hello) ? "public": "",
818 GNUNET_free (buffer);
821 GNUNET_free_non_null (fn);
827 * Do transmit info about peer to given host.
829 * @param cls NULL to hit all hosts, otherwise specifies a particular target
831 * @param value information to transmit
832 * @return GNUNET_YES (continue to iterate)
835 add_to_tc (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
837 struct TransmitContext *tc = cls;
838 struct HostEntry *pos = value;
839 struct InfoMessage *im;
841 char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
844 im = (struct InfoMessage *) buf;
846 if ((pos->hello != NULL) && (GNUNET_NO == tc->friend_only))
848 /* Copy public HELLO */
849 hs = GNUNET_HELLO_size (pos->hello);
850 GNUNET_assert (hs < GNUNET_SERVER_MAX_MESSAGE_SIZE -
851 sizeof (struct InfoMessage));
852 memcpy (&im[1], pos->hello, hs);
853 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
854 "Sending public HELLO with size %u for peer `%4s'\n",
855 hs, GNUNET_i2s (key));
857 else if ((pos->friend_only_hello != NULL) && (GNUNET_YES == tc->friend_only))
859 /* Copy friend only HELLO */
860 hs = GNUNET_HELLO_size (pos->friend_only_hello);
861 GNUNET_assert (hs < GNUNET_SERVER_MAX_MESSAGE_SIZE -
862 sizeof (struct InfoMessage));
863 memcpy (&im[1], pos->friend_only_hello, hs);
864 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
865 "Sending friend-only HELLO with size %u for peer `%4s'\n",
866 hs, GNUNET_i2s (key));
870 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
871 "Adding no HELLO for peer `%s'\n",
875 im->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_INFO);
876 im->header.size = htons (sizeof (struct InfoMessage) + hs);
877 im->reserved = htonl (0);
878 im->peer = pos->identity;
879 GNUNET_SERVER_transmit_context_append_message (tc->tc, &im->header);
885 * @brief delete expired HELLO entries in directory
887 * @param cls pointer to current time (struct GNUNET_TIME_Absolute)
888 * @param fn filename to test to see if the HELLO expired
889 * @return GNUNET_OK (continue iteration)
892 discard_hosts_helper (void *cls, const char *fn)
894 struct GNUNET_TIME_Absolute *now = cls;
895 char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
896 const struct GNUNET_HELLO_Message *hello;
897 struct GNUNET_HELLO_Message *new_hello;
899 unsigned int cur_hello_size;
900 unsigned int new_hello_size;
907 read_size = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
908 if (read_size < sizeof (struct GNUNET_MessageHeader))
910 if (0 != UNLINK (fn))
911 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
912 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
916 writebuffer = GNUNET_malloc (read_size);
919 while (read_pos < read_size)
921 /* Check each HELLO */
922 hello = (const struct GNUNET_HELLO_Message *) &buffer[read_pos];
923 cur_hello_size = GNUNET_HELLO_size (hello);
924 if (0 == cur_hello_size)
926 /* Invalid data, discard */
927 if (0 != UNLINK (fn))
928 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
929 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
932 new_hello = GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES, &discard_expired, now);
934 if (NULL != new_hello)
935 (void) GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &count_addresses, &cnt);
936 if ( (NULL != new_hello) && (0 < cnt) )
938 /* Store new HELLO to write it when done */
939 new_hello_size = GNUNET_HELLO_size (new_hello);
940 memcpy (&writebuffer[write_pos], new_hello, new_hello_size);
941 write_pos += new_hello_size;
943 read_pos += cur_hello_size;
944 GNUNET_free_non_null (new_hello);
949 GNUNET_DISK_fn_write (fn, writebuffer,write_pos,
950 GNUNET_DISK_PERM_USER_READ |
951 GNUNET_DISK_PERM_USER_WRITE |
952 GNUNET_DISK_PERM_GROUP_READ |
953 GNUNET_DISK_PERM_OTHER_READ);
955 else if (0 != UNLINK (fn))
956 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
957 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
959 GNUNET_free (writebuffer);
965 * Call this method periodically to scan peerinfo/ for ancient
969 * @param tc scheduler context, aborted if reason is shutdown
972 cron_clean_data_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
974 struct GNUNET_TIME_Absolute now;
976 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
978 now = GNUNET_TIME_absolute_get ();
979 GNUNET_log (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
980 _("Cleaning up directory `%s'\n"), networkIdDirectory);
981 GNUNET_DISK_directory_scan (networkIdDirectory, &discard_hosts_helper, &now);
982 GNUNET_SCHEDULER_add_delayed (DATA_HOST_CLEAN_FREQ, &cron_clean_data_hosts,
988 * Handle HELLO-message.
991 * @param client identification of the client
992 * @param message the actual message
995 handle_hello (void *cls, struct GNUNET_SERVER_Client *client,
996 const struct GNUNET_MessageHeader *message)
998 const struct GNUNET_HELLO_Message *hello;
999 struct GNUNET_PeerIdentity pid;
1001 hello = (const struct GNUNET_HELLO_Message *) message;
1002 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
1005 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1008 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received for peer `%4s'\n",
1009 "HELLO", GNUNET_i2s (&pid));
1010 add_host_to_known_hosts (&pid);
1011 update_hello (&pid, hello);
1012 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1017 * Handle GET-message.
1019 * @param cls closure
1020 * @param client identification of the client
1021 * @param message the actual message
1024 handle_get (void *cls, struct GNUNET_SERVER_Client *client,
1025 const struct GNUNET_MessageHeader *message)
1027 const struct ListPeerMessage *lpm;
1028 struct TransmitContext tcx;
1030 lpm = (const struct ListPeerMessage *) message;
1031 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received for peer `%4s'\n",
1032 "GET", GNUNET_i2s (&lpm->peer));
1033 tcx.friend_only = ntohl (lpm->include_friend_only);
1034 tcx.tc = GNUNET_SERVER_transmit_context_create (client);
1035 GNUNET_CONTAINER_multipeermap_get_multiple (hostmap, &lpm->peer,
1037 GNUNET_SERVER_transmit_context_append_data (tcx.tc, NULL, 0,
1038 GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END);
1039 GNUNET_SERVER_transmit_context_run (tcx.tc, GNUNET_TIME_UNIT_FOREVER_REL);
1044 * Handle GET-ALL-message.
1046 * @param cls closure
1047 * @param client identification of the client
1048 * @param message the actual message
1051 handle_get_all (void *cls, struct GNUNET_SERVER_Client *client,
1052 const struct GNUNET_MessageHeader *message)
1054 const struct ListAllPeersMessage *lapm;
1055 struct TransmitContext tcx;
1057 lapm = (const struct ListAllPeersMessage *) message;
1058 tcx.friend_only = ntohl (lapm->include_friend_only);
1059 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received\n", "GET_ALL");
1060 tcx.tc = GNUNET_SERVER_transmit_context_create (client);
1061 GNUNET_CONTAINER_multipeermap_iterate (hostmap, &add_to_tc, &tcx);
1062 GNUNET_SERVER_transmit_context_append_data (tcx.tc, NULL, 0,
1063 GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END);
1064 GNUNET_SERVER_transmit_context_run (tcx.tc, GNUNET_TIME_UNIT_FOREVER_REL);
1070 * Pass the given client the information we have in the respective
1071 * host entry; the client is already in the notification context.
1073 * @param cls the 'struct GNUNET_SERVER_Client' to notify
1074 * @param key key for the value (unused)
1075 * @param value the 'struct HostEntry' to notify the client about
1076 * @return GNUNET_YES (always, continue to iterate)
1079 do_notify_entry (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
1081 struct NotificationContext *nc = cls;
1082 struct HostEntry *he = value;
1083 struct InfoMessage *msg;
1085 if ((NULL == he->hello) && (GNUNET_NO == nc->include_friend_only))
1087 /* We have no public hello */
1091 if ( (NULL == he->friend_only_hello) &&
1092 (GNUNET_YES == nc->include_friend_only) )
1094 /* We have no friend hello */
1098 msg = make_info_message (he, nc->include_friend_only);
1099 GNUNET_SERVER_notification_context_unicast (notify_list,
1109 * Handle NOTIFY-message.
1111 * @param cls closure
1112 * @param client identification of the client
1113 * @param message the actual message
1116 handle_notify (void *cls, struct GNUNET_SERVER_Client *client,
1117 const struct GNUNET_MessageHeader *message)
1119 struct NotifyMessage *nm = (struct NotifyMessage *) message;
1120 struct NotificationContext *nc;
1122 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1123 "`%s' message received\n",
1125 nc = GNUNET_malloc (sizeof (struct NotificationContext));
1126 nc->client = client;
1127 nc->include_friend_only = ntohl (nm->include_friend_only);
1129 GNUNET_CONTAINER_DLL_insert (nc_head, nc_tail, nc);
1130 GNUNET_SERVER_client_mark_monitor (client);
1131 GNUNET_SERVER_notification_context_add (notify_list, client);
1132 GNUNET_CONTAINER_multipeermap_iterate (hostmap, &do_notify_entry, nc);
1133 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1138 * Client disconnect callback
1141 * @param client server client
1144 disconnect_cb (void *cls,struct GNUNET_SERVER_Client *client)
1146 struct NotificationContext *cur;
1148 for (cur = nc_head; NULL != cur; cur = cur->next)
1149 if (cur->client == client)
1153 GNUNET_CONTAINER_DLL_remove (nc_head, nc_tail, cur);
1159 * Release memory taken by a host entry.
1162 * @param key key of the host entry
1163 * @param value the 'struct HostEntry' to free
1164 * @return GNUNET_YES (continue to iterate)
1167 free_host_entry (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
1169 struct HostEntry *he = value;
1171 GNUNET_free_non_null (he->hello);
1172 GNUNET_free_non_null (he->friend_only_hello);
1179 * Clean up our state. Called during shutdown.
1182 * @param tc scheduler task context, unused
1185 shutdown_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
1187 struct NotificationContext *cur;
1188 struct NotificationContext *next;
1190 GNUNET_SERVER_notification_context_destroy (notify_list);
1193 for (cur = nc_head; NULL != cur; cur = next)
1196 GNUNET_CONTAINER_DLL_remove (nc_head, nc_tail, cur);
1199 GNUNET_CONTAINER_multipeermap_iterate (hostmap, &free_host_entry, NULL);
1200 GNUNET_CONTAINER_multipeermap_destroy (hostmap);
1203 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
1210 * Start up peerinfo service.
1212 * @param cls closure
1213 * @param server the initialized server
1214 * @param cfg configuration to use
1217 run (void *cls, struct GNUNET_SERVER_Handle *server,
1218 const struct GNUNET_CONFIGURATION_Handle *cfg)
1220 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1221 {&handle_hello, NULL, GNUNET_MESSAGE_TYPE_HELLO, 0},
1222 {&handle_get, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_GET,
1223 sizeof (struct ListPeerMessage)},
1224 {&handle_get_all, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL,
1225 sizeof (struct ListAllPeersMessage)},
1226 {&handle_notify, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY,
1227 sizeof (struct NotifyMessage)},
1232 struct DirScanContext dsc;
1236 hostmap = GNUNET_CONTAINER_multipeermap_create (1024, GNUNET_YES);
1237 stats = GNUNET_STATISTICS_create ("peerinfo", cfg);
1238 notify_list = GNUNET_SERVER_notification_context_create (server, 0);
1239 noio = GNUNET_CONFIGURATION_get_value_yesno (cfg, "peerinfo", "NO_IO");
1240 use_included = GNUNET_CONFIGURATION_get_value_yesno (cfg, "peerinfo", "USE_INCLUDED_HELLOS");
1241 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
1243 if (GNUNET_YES != noio)
1245 GNUNET_assert (GNUNET_OK ==
1246 GNUNET_CONFIGURATION_get_value_filename (cfg, "peerinfo",
1248 &networkIdDirectory));
1250 GNUNET_DISK_directory_create (networkIdDirectory))
1252 GNUNET_SCHEDULER_shutdown ();
1256 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1257 &cron_scan_directory_data_hosts, NULL);
1259 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1260 &cron_clean_data_hosts, NULL);
1261 if (GNUNET_YES == use_included)
1263 ip = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
1264 GNUNET_asprintf (&peerdir,
1269 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1270 _("Importing HELLOs from `%s'\n"),
1273 dsc.remove_files = GNUNET_NO;
1275 GNUNET_DISK_directory_scan (peerdir,
1276 &hosts_directory_scan_callback, &dsc);
1278 GNUNET_free (peerdir);
1281 GNUNET_SERVER_add_handlers (server, handlers);
1282 GNUNET_SERVER_disconnect_notify (server, &disconnect_cb, NULL) ;
1287 * The main function for the peerinfo service.
1289 * @param argc number of arguments from the command line
1290 * @param argv command line arguments
1291 * @return 0 ok, 1 on error
1294 main (int argc, char *const *argv)
1300 GNUNET_SERVICE_run (argc, argv, "peerinfo", GNUNET_SERVICE_OPTION_NONE,
1301 &run, NULL)) ? 0 : 1;
1302 GNUNET_free_non_null (networkIdDirectory);
1307 /* end of gnunet-service-peerinfo.c */