2 This file is part of GNUnet.
3 Copyright (C) 2001-2014 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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, 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
32 #include "gnunet_util_lib.h"
33 #include "gnunet_hello_lib.h"
34 #include "gnunet_protocols.h"
35 #include "gnunet_statistics_service.h"
39 * How often do we scan the HOST_DIR for new entries?
41 #define DATA_HOST_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 15)
44 * How often do we discard old entries in data/hosts/?
46 #define DATA_HOST_CLEAN_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 60)
50 * In-memory cache of known hosts.
56 * Identity of the peer.
58 struct GNUNET_PeerIdentity identity;
61 * Hello for the peer (can be NULL)
63 struct GNUNET_HELLO_Message *hello;
66 * Friend only hello for the peer (can be NULL)
68 struct GNUNET_HELLO_Message *friend_only_hello;
73 * Transmit context for GET requests
75 struct TransmitContext
78 * Server transmit context
80 struct GNUNET_SERVER_TransmitContext *tc;
83 * Include friend only HELLOs #GNUNET_YES or #GNUNET_NO
90 * Result of reading a file
92 struct ReadHostFileContext
95 * Hello for the peer (can be NULL)
97 struct GNUNET_HELLO_Message *hello;
100 * Friend only hello for the peer (can be NULL)
102 struct GNUNET_HELLO_Message *friend_only_hello;
107 * Client notification context
109 struct NotificationContext
114 struct NotificationContext *prev;
119 struct NotificationContext *next;
124 struct GNUNET_SERVER_Client *client;
127 * Interested in friend only HELLO?
129 int include_friend_only;
134 * The in-memory list of known hosts, mapping of
135 * host IDs to 'struct HostEntry*' values.
137 static struct GNUNET_CONTAINER_MultiPeerMap *hostmap;
140 * Clients to immediately notify about all changes.
142 static struct GNUNET_SERVER_NotificationContext *notify_list;
145 * Directory where the hellos are stored in (peerinfo/)
147 static char *networkIdDirectory;
150 * Handle for reporting statistics.
152 static struct GNUNET_STATISTICS_Handle *stats;
155 * DLL of notification contexts: head
157 static struct NotificationContext *nc_head;
160 * DLL of notification contexts: tail
162 static struct NotificationContext *nc_tail;
166 * Notify all clients in the notify list about the
167 * given host entry changing.
169 * @param he entry of the host for which we generate a notification
170 * @param include_friend_only create public of friend-only message
171 * @return generated notification message
173 static struct InfoMessage *
174 make_info_message (const struct HostEntry *he,
175 int include_friend_only)
177 struct InfoMessage *im;
178 struct GNUNET_HELLO_Message *src;
181 if (GNUNET_YES == include_friend_only)
182 src = he->friend_only_hello;
186 hs = (NULL == src) ? 0 : GNUNET_HELLO_size (src);
187 im = GNUNET_malloc (sizeof (struct InfoMessage) + hs);
188 im->header.size = htons (hs + sizeof (struct InfoMessage));
189 im->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_INFO);
190 im->peer = he->identity;
192 memcpy (&im[1], src, hs);
198 * Address iterator that causes expired entries to be discarded.
200 * @param cls pointer to the current time
201 * @param address the address
202 * @param expiration expiration time for the address
203 * @return #GNUNET_NO if expiration smaller than the current time
206 discard_expired (void *cls,
207 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,
233 const struct GNUNET_HELLO_Address *address,
234 struct GNUNET_TIME_Absolute expiration)
236 unsigned int *cnt = cls;
244 * Get the filename under which we would store the GNUNET_HELLO_Message
245 * for the given host and protocol.
247 * @param id peer for which we need the filename for the HELLO
248 * @return filename of the form DIRECTORY/HOSTID
251 get_host_filename (const struct GNUNET_PeerIdentity *id)
255 if (NULL == networkIdDirectory)
257 GNUNET_asprintf (&fn, "%s%s%s", networkIdDirectory, DIR_SEPARATOR_STR,
258 GNUNET_i2s_full (id));
264 * Broadcast information about the given entry to all
267 * @param entry entry to broadcast about
270 notify_all (struct HostEntry *entry)
272 struct InfoMessage *msg_pub;
273 struct InfoMessage *msg_friend;
274 struct NotificationContext *cur;
276 msg_pub = make_info_message (entry, GNUNET_NO);
277 msg_friend = make_info_message (entry, GNUNET_YES);
278 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
279 "Notifying all clients about peer `%s'\n",
280 GNUNET_i2s(&entry->identity));
281 for (cur = nc_head; NULL != cur; cur = cur->next)
283 if (GNUNET_NO == cur->include_friend_only)
285 GNUNET_SERVER_notification_context_unicast (notify_list,
290 if (GNUNET_YES == cur->include_friend_only)
292 GNUNET_SERVER_notification_context_unicast (notify_list,
298 GNUNET_free (msg_pub);
299 GNUNET_free (msg_friend);
304 * Bind a host address (hello) to a hostId.
306 * @param peer the peer for which this is a hello
307 * @param hello the verified (!) hello message
310 update_hello (const struct GNUNET_PeerIdentity *peer,
311 const struct GNUNET_HELLO_Message *hello);
315 * Try to read the HELLOs in the given filename and discard expired
316 * addresses. Removes the file if one the HELLO is malformed. If all
317 * addresses are expired, the HELLO is also removed (but the HELLO
318 * with the public key is still returned if it was found and valid).
319 * The file can contain multiple HELLO messages.
321 * @param fn name of the file
322 * @param unlink_garbage if #GNUNET_YES, try to remove useless files
323 * @param r ReadHostFileContext to store the resutl
326 read_host_file (const char *fn,
328 struct ReadHostFileContext *r)
330 char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
331 unsigned int size_total;
332 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))
344 size_total = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
345 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
346 "Read %u bytes from `%s'\n",
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,
364 while (read_pos < size_total)
366 hello = (const struct GNUNET_HELLO_Message *) &buffer[read_pos];
367 size_hello = GNUNET_HELLO_size (hello);
370 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
371 _("Failed to parse HELLO in file `%s'\n"),
373 if ((GNUNET_YES == unlink_garbage) &&
374 (0 != UNLINK (fn)) &&
376 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
382 now = GNUNET_TIME_absolute_get ();
383 hello_clean = GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES,
384 &discard_expired, &now);
385 if (NULL == hello_clean)
387 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
388 _("Failed to parse HELLO in file `%s'\n"),
390 if ((GNUNET_YES == unlink_garbage) &&
391 (0 != UNLINK (fn)) &&
393 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
399 (void) GNUNET_HELLO_iterate_addresses (hello_clean, GNUNET_NO,
400 &count_addresses, &left);
404 GNUNET_free (hello_clean);
408 if (GNUNET_NO == GNUNET_HELLO_is_friend_only (hello_clean))
410 if (NULL == r->hello)
411 r->hello = hello_clean;
415 GNUNET_free (r->hello);
416 r->hello = hello_clean;
421 if (NULL == r->friend_only_hello)
422 r->friend_only_hello = hello_clean;
426 GNUNET_free (r->friend_only_hello);
427 r->friend_only_hello = hello_clean;
430 read_pos += size_hello;
435 /* no addresses left, remove from disk */
436 if ( (GNUNET_YES == unlink_garbage) &&
438 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
442 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
443 "Found `%s' and `%s' HELLO message in file\n",
444 (NULL != r->hello) ? "public" : "NON-public",
445 (NULL != r->friend_only_hello) ? "friend only" : "NO friend only");
450 * Add a host to the list and notify clients about this event
452 * @param identity the identity of the host
453 * @return the HostEntry
455 static struct HostEntry *
456 add_host_to_known_hosts (const struct GNUNET_PeerIdentity *identity)
458 struct HostEntry *entry;
459 struct ReadHostFileContext r;
462 entry = GNUNET_CONTAINER_multipeermap_get (hostmap, identity);
465 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
466 "Adding new peer `%s'\n",
467 GNUNET_i2s (identity));
468 GNUNET_STATISTICS_update (stats, gettext_noop ("# peers known"), 1,
470 entry = GNUNET_new (struct HostEntry);
471 entry->identity = *identity;
472 GNUNET_assert (GNUNET_OK ==
473 GNUNET_CONTAINER_multipeermap_put (hostmap,
476 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY));
478 fn = get_host_filename (identity);
481 read_host_file (fn, GNUNET_YES, &r);
483 update_hello (identity, r.hello);
484 if (NULL != r.friend_only_hello)
485 update_hello (identity, r.friend_only_hello);
486 GNUNET_free_non_null (r.hello);
487 GNUNET_free_non_null (r.friend_only_hello);
496 * Remove a file that should not be there. LOG
497 * success or failure.
499 * @param fullname name of the file to remove
502 remove_garbage (const char *fullname)
504 if (0 == UNLINK (fullname))
505 GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
506 _("File `%s' in directory `%s' does not match naming convention. Removed.\n"),
510 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
517 * Closure for #hosts_directory_scan_callback().
519 struct DirScanContext
522 * #GNUNET_YES if we should remove files that are broken,
523 * #GNUNET_NO if the directory we are iterating over should
524 * be treated as read-only by us.
529 * Counter for the number of (valid) entries found, incremented
530 * by one for each match.
532 unsigned int matched;
537 * Function that is called on each HELLO file in a particular directory.
538 * Try to parse the file and add the HELLO to our list.
540 * @param cls pointer to 'unsigned int' to increment for each file, or NULL
541 * if the file is from a read-only, read-once resource directory
542 * @param fullname name of the file to parse
543 * @return #GNUNET_OK (continue iteration)
546 hosts_directory_scan_callback (void *cls,
547 const char *fullname)
549 struct DirScanContext *dsc = cls;
550 struct GNUNET_PeerIdentity identity;
551 struct ReadHostFileContext r;
552 const char *filename;
553 struct GNUNET_PeerIdentity id_public;
554 struct GNUNET_PeerIdentity id_friend;
555 struct GNUNET_PeerIdentity id;
557 if (GNUNET_YES != GNUNET_DISK_file_test (fullname))
558 return GNUNET_OK; /* ignore non-files */
560 filename = strrchr (fullname, DIR_SEPARATOR);
561 if ((NULL == filename) || (1 > strlen (filename)))
566 read_host_file (fullname, dsc->remove_files, &r);
567 if ( (NULL == r.hello) && (NULL == r.friend_only_hello))
569 if (NULL != r.friend_only_hello)
571 if (GNUNET_OK != GNUNET_HELLO_get_id (r.friend_only_hello, &id_friend))
572 if (GNUNET_YES == dsc->remove_files)
574 remove_garbage (fullname);
581 if (GNUNET_OK != GNUNET_HELLO_get_id (r.hello, &id_public))
582 if (GNUNET_YES == dsc->remove_files)
584 remove_garbage (fullname);
590 if ( (NULL != r.hello) && (NULL != r.friend_only_hello) &&
591 (0 != memcmp (&id_friend, &id_public, sizeof (id_friend))) )
593 /* HELLOs are not for the same peer */
595 if (GNUNET_YES == dsc->remove_files)
596 remove_garbage (fullname);
600 GNUNET_CRYPTO_eddsa_public_key_from_string (filename,
602 &identity.public_key))
604 if (0 != memcmp (&id, &identity, sizeof (id_friend)))
606 /* HELLOs are not for the same peer */
608 if (GNUNET_YES == dsc->remove_files)
609 remove_garbage (fullname);
614 /* ok, found something valid, remember HELLO */
615 add_host_to_known_hosts (&id);
618 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
619 "Updating peer `%s' public HELLO \n",
621 update_hello (&id, r.hello);
622 GNUNET_free (r.hello);
624 if (NULL != r.friend_only_hello)
626 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
627 "Updating peer `%s' friend only HELLO \n",
629 update_hello (&id, r.friend_only_hello);
630 GNUNET_free (r.friend_only_hello);
638 * Call this method periodically to scan data/hosts for new hosts.
641 * @param tc scheduler context, aborted if reason is shutdown
644 cron_scan_directory_data_hosts (void *cls,
645 const struct GNUNET_SCHEDULER_TaskContext *tc)
647 static unsigned int retries;
648 struct DirScanContext dsc;
650 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
652 if (GNUNET_SYSERR == GNUNET_DISK_directory_create (networkIdDirectory))
654 GNUNET_SCHEDULER_add_delayed_with_priority (DATA_HOST_FREQ,
655 GNUNET_SCHEDULER_PRIORITY_IDLE,
656 &cron_scan_directory_data_hosts, NULL);
660 dsc.remove_files = GNUNET_YES;
661 GNUNET_log (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
662 _("Scanning directory `%s'\n"),
664 GNUNET_DISK_directory_scan (networkIdDirectory,
665 &hosts_directory_scan_callback, &dsc);
666 if ((0 == dsc.matched) && (0 == (++retries & 31)))
667 GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
668 _("Still no peers found in `%s'!\n"),
670 GNUNET_SCHEDULER_add_delayed_with_priority (DATA_HOST_FREQ,
671 GNUNET_SCHEDULER_PRIORITY_IDLE,
672 &cron_scan_directory_data_hosts,
678 * Update the HELLO of a friend by merging the addresses.
680 * @param hello original hello
681 * @param friend_hello hello with additional addresses
682 * @return merged HELLO
684 static struct GNUNET_HELLO_Message *
685 update_friend_hello (const struct GNUNET_HELLO_Message *hello,
686 const struct GNUNET_HELLO_Message *friend_hello)
688 struct GNUNET_HELLO_Message * res;
689 struct GNUNET_HELLO_Message * tmp;
690 struct GNUNET_CRYPTO_EddsaPublicKey pk;
692 if (NULL != friend_hello)
694 res = GNUNET_HELLO_merge (hello, friend_hello);
695 GNUNET_assert (GNUNET_YES == GNUNET_HELLO_is_friend_only (res));
700 GNUNET_HELLO_get_key (hello, &pk))
705 tmp = GNUNET_HELLO_create (&pk, NULL, NULL, GNUNET_YES);
706 res = GNUNET_HELLO_merge (hello, tmp);
708 GNUNET_assert (GNUNET_YES == GNUNET_HELLO_is_friend_only (res));
714 * Bind a host address (hello) to a hostId.
716 * @param peer the peer for which this is a hello
717 * @param hello the verified (!) hello message
720 update_hello (const struct GNUNET_PeerIdentity *peer,
721 const struct GNUNET_HELLO_Message *hello)
724 struct HostEntry *host;
725 struct GNUNET_HELLO_Message *mrg;
726 struct GNUNET_HELLO_Message **dest;
727 struct GNUNET_TIME_Absolute delta;
730 int friend_hello_type;
732 int store_friend_hello;
736 host = GNUNET_CONTAINER_multipeermap_get (hostmap, peer);
737 GNUNET_assert (NULL != host);
739 friend_hello_type = GNUNET_HELLO_is_friend_only (hello);
740 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
741 "Updating %s HELLO for `%s'\n",
742 (GNUNET_YES == friend_hello_type) ? "friend-only" : "public",
746 if (GNUNET_YES == friend_hello_type)
748 dest = &host->friend_only_hello;
757 (*dest) = GNUNET_malloc (GNUNET_HELLO_size (hello));
758 memcpy ((*dest), hello, GNUNET_HELLO_size (hello));
762 mrg = GNUNET_HELLO_merge ((*dest), hello);
763 delta = GNUNET_HELLO_equals (mrg, (*dest), GNUNET_TIME_absolute_get ());
764 if (delta.abs_value_us == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value_us)
766 /* no differences, just ignore the update */
767 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
768 "No change in %s HELLO for `%s'\n",
769 (GNUNET_YES == friend_hello_type) ? "friend-only" : "public",
774 GNUNET_free ((*dest));
778 if ( (NULL != (host->hello)) &&
779 (GNUNET_NO == friend_hello_type) )
781 /* Update friend only hello */
782 mrg = update_friend_hello (host->hello, host->friend_only_hello);
783 if (NULL != host->friend_only_hello)
784 GNUNET_free (host->friend_only_hello);
785 host->friend_only_hello = mrg;
788 if (NULL != host->hello)
789 GNUNET_assert ((GNUNET_NO ==
790 GNUNET_HELLO_is_friend_only (host->hello)));
791 if (NULL != host->friend_only_hello)
792 GNUNET_assert ((GNUNET_YES ==
793 GNUNET_HELLO_is_friend_only (host->friend_only_hello)));
795 fn = get_host_filename (peer);
798 GNUNET_DISK_directory_create_for_file (fn)) )
800 store_hello = GNUNET_NO;
803 if (NULL != host->hello)
804 (void) GNUNET_HELLO_iterate_addresses (host->hello,
810 store_hello = GNUNET_YES;
811 size += GNUNET_HELLO_size (host->hello);
814 if (NULL != host->friend_only_hello)
815 (void) GNUNET_HELLO_iterate_addresses (host->friend_only_hello,
819 store_friend_hello = GNUNET_NO;
822 store_friend_hello = GNUNET_YES;
823 size += GNUNET_HELLO_size (host->friend_only_hello);
826 if ( (GNUNET_NO == store_hello) &&
827 (GNUNET_NO == store_friend_hello) )
829 /* no valid addresses, don't put HELLO on disk; in fact,
830 if one exists on disk, remove it */
835 buffer = GNUNET_malloc (size);
838 if (GNUNET_YES == store_hello)
840 memcpy (buffer, host->hello,
841 GNUNET_HELLO_size (host->hello));
842 pos += GNUNET_HELLO_size (host->hello);
844 if (GNUNET_YES == store_friend_hello)
846 memcpy (&buffer[pos], host->friend_only_hello, GNUNET_HELLO_size (host->friend_only_hello));
847 pos += GNUNET_HELLO_size (host->friend_only_hello);
849 GNUNET_assert (pos == size);
851 if (GNUNET_SYSERR == GNUNET_DISK_fn_write (fn, buffer, size,
852 GNUNET_DISK_PERM_USER_READ |
853 GNUNET_DISK_PERM_USER_WRITE |
854 GNUNET_DISK_PERM_GROUP_READ |
855 GNUNET_DISK_PERM_OTHER_READ))
856 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
858 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
859 "Stored %s %s HELLO in %s with total size %u\n",
860 (GNUNET_YES == store_friend_hello) ? "friend-only": "",
861 (GNUNET_YES == store_hello) ? "public": "",
863 GNUNET_free (buffer);
866 GNUNET_free_non_null (fn);
872 * Do transmit info about peer to given host.
874 * @param cls NULL to hit all hosts, otherwise specifies a particular target
876 * @param value information to transmit
877 * @return #GNUNET_YES (continue to iterate)
880 add_to_tc (void *cls,
881 const struct GNUNET_PeerIdentity *key,
884 struct TransmitContext *tc = cls;
885 struct HostEntry *pos = value;
886 struct InfoMessage *im;
888 char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
891 im = (struct InfoMessage *) buf;
893 if ( (NULL != pos->hello) &&
894 (GNUNET_NO == tc->friend_only) )
896 /* Copy public HELLO */
897 hs = GNUNET_HELLO_size (pos->hello);
898 GNUNET_assert (hs < GNUNET_SERVER_MAX_MESSAGE_SIZE -
899 sizeof (struct InfoMessage));
900 memcpy (&im[1], pos->hello, hs);
901 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
902 "Sending public HELLO with size %u for peer `%4s'\n",
903 hs, GNUNET_i2s (key));
905 else if ( (NULL != pos->friend_only_hello) &&
906 (GNUNET_YES == tc->friend_only) )
908 /* Copy friend only HELLO */
909 hs = GNUNET_HELLO_size (pos->friend_only_hello);
910 GNUNET_assert (hs < GNUNET_SERVER_MAX_MESSAGE_SIZE -
911 sizeof (struct InfoMessage));
912 memcpy (&im[1], pos->friend_only_hello, hs);
913 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
914 "Sending friend-only HELLO with size %u for peer `%4s'\n",
920 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
921 "Adding no HELLO for peer `%s'\n",
925 im->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_INFO);
926 im->header.size = htons (sizeof (struct InfoMessage) + hs);
927 im->reserved = htonl (0);
928 im->peer = pos->identity;
929 GNUNET_SERVER_transmit_context_append_message (tc->tc, &im->header);
935 * @brief delete expired HELLO entries in directory
937 * @param cls pointer to current time (`struct GNUNET_TIME_Absolute *`)
938 * @param fn filename to test to see if the HELLO expired
939 * @return #GNUNET_OK (continue iteration)
942 discard_hosts_helper (void *cls,
945 struct GNUNET_TIME_Absolute *now = cls;
946 char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
947 const struct GNUNET_HELLO_Message *hello;
948 struct GNUNET_HELLO_Message *new_hello;
950 unsigned int cur_hello_size;
951 unsigned int new_hello_size;
957 read_size = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
958 if (read_size < sizeof (struct GNUNET_MessageHeader))
960 if (0 != UNLINK (fn))
961 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
962 GNUNET_ERROR_TYPE_BULK, "unlink", fn);
966 writebuffer = GNUNET_malloc (read_size);
969 while (read_pos < read_size)
971 /* Check each HELLO */
972 hello = (const struct GNUNET_HELLO_Message *) &buffer[read_pos];
973 cur_hello_size = GNUNET_HELLO_size (hello);
974 if (0 == cur_hello_size)
976 /* Invalid data, discard */
977 if (0 != UNLINK (fn))
978 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
979 GNUNET_ERROR_TYPE_BULK,
983 new_hello = GNUNET_HELLO_iterate_addresses (hello,
985 &discard_expired, now);
987 if (NULL != new_hello)
988 (void) GNUNET_HELLO_iterate_addresses (hello,
990 &count_addresses, &cnt);
991 if ( (NULL != new_hello) && (0 < cnt) )
993 /* Store new HELLO to write it when done */
994 new_hello_size = GNUNET_HELLO_size (new_hello);
995 memcpy (&writebuffer[write_pos], new_hello, new_hello_size);
996 write_pos += new_hello_size;
998 read_pos += cur_hello_size;
999 GNUNET_free_non_null (new_hello);
1004 GNUNET_DISK_fn_write (fn, writebuffer,write_pos,
1005 GNUNET_DISK_PERM_USER_READ |
1006 GNUNET_DISK_PERM_USER_WRITE |
1007 GNUNET_DISK_PERM_GROUP_READ |
1008 GNUNET_DISK_PERM_OTHER_READ);
1010 else if (0 != UNLINK (fn))
1011 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
1012 GNUNET_ERROR_TYPE_BULK,
1015 GNUNET_free (writebuffer);
1021 * Call this method periodically to scan peerinfo/ for ancient
1025 * @param tc scheduler context, aborted if reason is shutdown
1028 cron_clean_data_hosts (void *cls,
1029 const struct GNUNET_SCHEDULER_TaskContext *tc)
1031 struct GNUNET_TIME_Absolute now;
1033 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
1035 now = GNUNET_TIME_absolute_get ();
1036 GNUNET_log (GNUNET_ERROR_TYPE_INFO | GNUNET_ERROR_TYPE_BULK,
1037 _("Cleaning up directory `%s'\n"),
1038 networkIdDirectory);
1039 GNUNET_DISK_directory_scan (networkIdDirectory,
1040 &discard_hosts_helper,
1042 GNUNET_SCHEDULER_add_delayed (DATA_HOST_CLEAN_FREQ,
1043 &cron_clean_data_hosts,
1049 * Handle HELLO-message.
1051 * @param cls closure
1052 * @param client identification of the client
1053 * @param message the actual message
1056 handle_hello (void *cls,
1057 struct GNUNET_SERVER_Client *client,
1058 const struct GNUNET_MessageHeader *message)
1060 const struct GNUNET_HELLO_Message *hello;
1061 struct GNUNET_PeerIdentity pid;
1063 hello = (const struct GNUNET_HELLO_Message *) message;
1064 if (GNUNET_OK != GNUNET_HELLO_get_id (hello, &pid))
1067 GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
1070 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1071 "`%s' message received for peer `%4s'\n",
1074 add_host_to_known_hosts (&pid);
1075 update_hello (&pid, hello);
1076 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1081 * Handle GET-message.
1083 * @param cls closure
1084 * @param client identification of the client
1085 * @param message the actual message
1088 handle_get (void *cls,
1089 struct GNUNET_SERVER_Client *client,
1090 const struct GNUNET_MessageHeader *message)
1092 const struct ListPeerMessage *lpm;
1093 struct TransmitContext tcx;
1095 lpm = (const struct ListPeerMessage *) message;
1096 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1097 "`%s' message received for peer `%4s'\n",
1099 GNUNET_i2s (&lpm->peer));
1100 tcx.friend_only = ntohl (lpm->include_friend_only);
1101 tcx.tc = GNUNET_SERVER_transmit_context_create (client);
1102 GNUNET_CONTAINER_multipeermap_get_multiple (hostmap, &lpm->peer,
1104 GNUNET_SERVER_transmit_context_append_data (tcx.tc, NULL, 0,
1105 GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END);
1106 GNUNET_SERVER_transmit_context_run (tcx.tc, GNUNET_TIME_UNIT_FOREVER_REL);
1111 * Handle GET-ALL-message.
1113 * @param cls closure
1114 * @param client identification of the client
1115 * @param message the actual message
1118 handle_get_all (void *cls, struct GNUNET_SERVER_Client *client,
1119 const struct GNUNET_MessageHeader *message)
1121 const struct ListAllPeersMessage *lapm;
1122 struct TransmitContext tcx;
1124 lapm = (const struct ListAllPeersMessage *) message;
1125 tcx.friend_only = ntohl (lapm->include_friend_only);
1126 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1127 "`%s' message received\n",
1129 GNUNET_SERVER_disable_receive_done_warning (client);
1130 tcx.tc = GNUNET_SERVER_transmit_context_create (client);
1131 GNUNET_CONTAINER_multipeermap_iterate (hostmap,
1134 GNUNET_SERVER_transmit_context_append_data (tcx.tc, NULL, 0,
1135 GNUNET_MESSAGE_TYPE_PEERINFO_INFO_END);
1136 GNUNET_SERVER_transmit_context_run (tcx.tc, GNUNET_TIME_UNIT_FOREVER_REL);
1142 * Pass the given client the information we have in the respective
1143 * host entry; the client is already in the notification context.
1145 * @param cls the `struct GNUNET_SERVER_Client` to notify
1146 * @param key key for the value (unused)
1147 * @param value the `struct HostEntry` to notify the client about
1148 * @return #GNUNET_YES (always, continue to iterate)
1151 do_notify_entry (void *cls,
1152 const struct GNUNET_PeerIdentity *key,
1155 struct NotificationContext *nc = cls;
1156 struct HostEntry *he = value;
1157 struct InfoMessage *msg;
1159 if ( (NULL == he->hello) &&
1160 (GNUNET_NO == nc->include_friend_only) )
1162 /* We have no public hello */
1166 if ( (NULL == he->friend_only_hello) &&
1167 (GNUNET_YES == nc->include_friend_only) )
1169 /* We have no friend hello */
1173 msg = make_info_message (he, nc->include_friend_only);
1174 GNUNET_SERVER_notification_context_unicast (notify_list,
1184 * Handle NOTIFY-message.
1186 * @param cls closure
1187 * @param client identification of the client
1188 * @param message the actual message
1191 handle_notify (void *cls,
1192 struct GNUNET_SERVER_Client *client,
1193 const struct GNUNET_MessageHeader *message)
1195 struct NotifyMessage *nm = (struct NotifyMessage *) message;
1196 struct NotificationContext *nc;
1198 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1199 "`%s' message received\n",
1201 nc = GNUNET_new (struct NotificationContext);
1202 nc->client = client;
1203 nc->include_friend_only = ntohl (nm->include_friend_only);
1205 GNUNET_CONTAINER_DLL_insert (nc_head, nc_tail, nc);
1206 GNUNET_SERVER_client_mark_monitor (client);
1207 GNUNET_SERVER_notification_context_add (notify_list, client);
1208 GNUNET_CONTAINER_multipeermap_iterate (hostmap, &do_notify_entry, nc);
1209 GNUNET_SERVER_receive_done (client, GNUNET_OK);
1214 * Client disconnect callback
1217 * @param client server client
1220 disconnect_cb (void *cls,
1221 struct GNUNET_SERVER_Client *client)
1223 struct NotificationContext *cur;
1225 for (cur = nc_head; NULL != cur; cur = cur->next)
1226 if (cur->client == client)
1230 GNUNET_CONTAINER_DLL_remove (nc_head, nc_tail, cur);
1236 * Release memory taken by a host entry.
1239 * @param key key of the host entry
1240 * @param value the `struct HostEntry` to free
1241 * @return #GNUNET_YES (continue to iterate)
1244 free_host_entry (void *cls,
1245 const struct GNUNET_PeerIdentity *key,
1248 struct HostEntry *he = value;
1250 GNUNET_free_non_null (he->hello);
1251 GNUNET_free_non_null (he->friend_only_hello);
1258 * Clean up our state. Called during shutdown.
1261 * @param tc scheduler task context, unused
1264 shutdown_task (void *cls,
1265 const struct GNUNET_SCHEDULER_TaskContext *tc)
1267 struct NotificationContext *cur;
1268 struct NotificationContext *next;
1270 GNUNET_SERVER_notification_context_destroy (notify_list);
1273 for (cur = nc_head; NULL != cur; cur = next)
1276 GNUNET_CONTAINER_DLL_remove (nc_head, nc_tail, cur);
1279 GNUNET_CONTAINER_multipeermap_iterate (hostmap,
1282 GNUNET_CONTAINER_multipeermap_destroy (hostmap);
1285 GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
1292 * Start up peerinfo service.
1294 * @param cls closure
1295 * @param server the initialized server
1296 * @param cfg configuration to use
1300 struct GNUNET_SERVER_Handle *server,
1301 const struct GNUNET_CONFIGURATION_Handle *cfg)
1303 static const struct GNUNET_SERVER_MessageHandler handlers[] = {
1304 {&handle_hello, NULL, GNUNET_MESSAGE_TYPE_HELLO, 0},
1305 {&handle_get, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_GET,
1306 sizeof (struct ListPeerMessage)},
1307 {&handle_get_all, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_GET_ALL,
1308 sizeof (struct ListAllPeersMessage)},
1309 {&handle_notify, NULL, GNUNET_MESSAGE_TYPE_PEERINFO_NOTIFY,
1310 sizeof (struct NotifyMessage)},
1315 struct DirScanContext dsc;
1319 hostmap = GNUNET_CONTAINER_multipeermap_create (1024, GNUNET_YES);
1320 stats = GNUNET_STATISTICS_create ("peerinfo", cfg);
1321 notify_list = GNUNET_SERVER_notification_context_create (server, 0);
1322 noio = GNUNET_CONFIGURATION_get_value_yesno (cfg, "peerinfo", "NO_IO");
1323 use_included = GNUNET_CONFIGURATION_get_value_yesno (cfg,
1325 "USE_INCLUDED_HELLOS");
1326 if (GNUNET_SYSERR == use_included)
1327 use_included = GNUNET_NO;
1328 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
1331 if (GNUNET_YES != noio)
1333 GNUNET_assert (GNUNET_OK ==
1334 GNUNET_CONFIGURATION_get_value_filename (cfg, "peerinfo",
1336 &networkIdDirectory));
1338 GNUNET_DISK_directory_create (networkIdDirectory))
1340 GNUNET_SCHEDULER_shutdown ();
1344 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1345 &cron_scan_directory_data_hosts, NULL);
1347 GNUNET_SCHEDULER_add_with_priority (GNUNET_SCHEDULER_PRIORITY_IDLE,
1348 &cron_clean_data_hosts, NULL);
1349 if (GNUNET_YES == use_included)
1351 ip = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
1352 GNUNET_asprintf (&peerdir,
1357 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
1358 _("Importing HELLOs from `%s'\n"),
1361 dsc.remove_files = GNUNET_NO;
1363 GNUNET_DISK_directory_scan (peerdir,
1364 &hosts_directory_scan_callback,
1366 GNUNET_free (peerdir);
1370 GNUNET_log(GNUNET_ERROR_TYPE_INFO,
1371 _("Skipping import of included HELLOs\n"));
1374 GNUNET_SERVER_add_handlers (server, handlers);
1375 GNUNET_SERVER_disconnect_notify (server,
1382 * The main function for the peerinfo service.
1384 * @param argc number of arguments from the command line
1385 * @param argv command line arguments
1386 * @return 0 ok, 1 on error
1396 GNUNET_SERVICE_run (argc, argv,
1398 GNUNET_SERVICE_OPTION_NONE,
1399 &run, NULL)) ? 0 : 1;
1400 GNUNET_free_non_null (networkIdDirectory);
1405 /* end of gnunet-service-peerinfo.c */