/*
This file is part of GNUnet.
- (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010 Christian Grothoff (and other contributing authors)
+ (C) 2001, 2002, 2004, 2005, 2007, 2009, 2010, 2012 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @author Christian Grothoff
*
* TODO:
- * - HostEntries are never 'free'd (add expiration, upper bound?)
+ * - notify clients when addresses in HELLO expire (#1933)
*/
#include "platform.h"
-#include "gnunet_crypto_lib.h"
-#include "gnunet_container_lib.h"
-#include "gnunet_disk_lib.h"
+#include "gnunet_util_lib.h"
#include "gnunet_hello_lib.h"
#include "gnunet_protocols.h"
-#include "gnunet_service_lib.h"
#include "gnunet_statistics_service.h"
#include "peerinfo.h"
*/
#define DATA_HOST_CLEAN_FREQ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 60)
+
/**
* In-memory cache of known hosts.
*/
/**
* Notify all clients in the notify list about the
* given host entry changing.
+ *
+ * @param he entry of the host for which we generate a notification
+ * @return generated notification message
*/
static struct InfoMessage *
make_info_message (const struct HostEntry *he)
struct InfoMessage *im;
size_t hs;
- hs = (he->hello == NULL) ? 0 : GNUNET_HELLO_size (he->hello);
+ hs = (NULL == he->hello) ? 0 : GNUNET_HELLO_size (he->hello);
im = GNUNET_malloc (sizeof (struct InfoMessage) + hs);
im->header.size = htons (hs + sizeof (struct InfoMessage));
im->header.type = htons (GNUNET_MESSAGE_TYPE_PEERINFO_INFO);
}
+/**
+ * Address iterator that counts the remaining addresses.
+ *
+ * @param cls pointer to the counter
+ * @param address the address
+ * @param expiration expiration time for the address
+ * @return GNUNET_OK (always)
+ */
+static int
+count_addresses (void *cls, const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_TIME_Absolute expiration)
+{
+ unsigned int *cnt = cls;
+
+ (*cnt)++;
+ return GNUNET_OK;
+}
+
+
/**
* Get the filename under which we would store the GNUNET_HELLO_Message
* for the given host and protocol.
+ *
+ * @param id peer for which we need the filename for the HELLO
* @return filename of the form DIRECTORY/HOSTID
*/
static char *
}
+/**
+ * Try to read the HELLO in the given filename and discard expired
+ * addresses. Removes the file if the HELLO is mal-formed. If all
+ * addresses are expired, the HELLO is also removed (but the HELLO
+ * with the public key is still returned if it was found and valid).
+ *
+ * @param fn name of the file
+ * @param unlink_garbage if GNUNET_YES, try to remove useless files
+ * @return HELLO of the file, NULL on error
+ */
+static struct GNUNET_HELLO_Message *
+read_host_file (const char *fn,
+ int unlink_garbage)
+{
+ char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
+ const struct GNUNET_HELLO_Message *hello;
+ struct GNUNET_HELLO_Message *hello_clean;
+ int size;
+ struct GNUNET_TIME_Absolute now;
+ unsigned int left;
+
+ if (GNUNET_YES != GNUNET_DISK_file_test (fn))
+ return NULL;
+ size = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
+ hello = (const struct GNUNET_HELLO_Message *) buffer;
+ if ((size < sizeof (struct GNUNET_MessageHeader)) ||
+ (size != ntohs ((((const struct GNUNET_MessageHeader *) hello)->size)))
+ || (size != GNUNET_HELLO_size (hello)))
+ {
+ GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
+ _("Failed to parse HELLO in file `%s'\n"),
+ fn);
+ if ( (GNUNET_YES == unlink_garbage) &&
+ (0 != UNLINK (fn)) )
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
+ return NULL;
+ }
+ now = GNUNET_TIME_absolute_get ();
+ hello_clean =
+ GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES, &discard_expired,
+ &now);
+ left = 0;
+ (void) GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &count_addresses,
+ &left);
+ if (0 == left)
+ {
+ /* no addresses left, remove from disk */
+ if ( (GNUNET_YES == unlink_garbage) &&
+ (0 != UNLINK (fn)) )
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
+ }
+ return hello_clean;
+}
+
+
/**
* Add a host to the list.
*
add_host_to_known_hosts (const struct GNUNET_PeerIdentity *identity)
{
struct HostEntry *entry;
- char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
- const struct GNUNET_HELLO_Message *hello;
- struct GNUNET_HELLO_Message *hello_clean;
- int size;
- struct GNUNET_TIME_Absolute now;
char *fn;
entry = GNUNET_CONTAINER_multihashmap_get (hostmap, &identity->hashPubKey);
- if (entry != NULL)
+ if (NULL != entry)
return;
GNUNET_STATISTICS_update (stats, gettext_noop ("# peers known"), 1,
GNUNET_NO);
entry = GNUNET_malloc (sizeof (struct HostEntry));
entry->identity = *identity;
-
+ GNUNET_CONTAINER_multihashmap_put (hostmap, &entry->identity.hashPubKey, entry,
+ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
fn = get_host_filename (identity);
- if (GNUNET_DISK_file_test (fn) == GNUNET_YES)
- {
- size = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
- hello = (const struct GNUNET_HELLO_Message *) buffer;
- if ((size < sizeof (struct GNUNET_MessageHeader)) ||
- (size != ntohs ((((const struct GNUNET_MessageHeader *) hello)->size)))
- || (size != GNUNET_HELLO_size (hello)))
- {
- GNUNET_break (0);
- if (0 != UNLINK (fn))
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "unlink", fn);
- }
- else
- {
- now = GNUNET_TIME_absolute_get ();
- hello_clean =
- GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES, &discard_expired,
- &now);
- entry->hello = hello_clean;
- }
- }
+ entry->hello = read_host_file (fn, GNUNET_YES);
GNUNET_free (fn);
- GNUNET_CONTAINER_multihashmap_put (hostmap, &identity->hashPubKey, entry,
- GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
notify_all (entry);
}
/**
* Remove a file that should not be there. LOG
* success or failure.
+ *
+ * @param fullname name of the file to remove
*/
static void
remove_garbage (const char *fullname)
}
+/**
+ * Closure for 'hosts_directory_scan_callback'.
+ */
+struct DirScanContext
+{
+ /**
+ * GNUNET_YES if we should remove files that are broken,
+ * GNUNET_NO if the directory we are iterating over should
+ * be treated as read-only by us.
+ */
+ int remove_files;
+
+ /**
+ * Counter for the number of (valid) entries found, incremented
+ * by one for each match.
+ */
+ unsigned int matched;
+};
+
+
+/**
+ * Function that is called on each HELLO file in a particular directory.
+ * Try to parse the file and add the HELLO to our list.
+ *
+ * @param cls pointer to 'unsigned int' to increment for each file, or NULL
+ * if the file is from a read-only, read-once resource directory
+ * @param fullname name of the file to parse
+ * @return GNUNET_OK (continue iteration)
+ */
static int
hosts_directory_scan_callback (void *cls, const char *fullname)
{
- unsigned int *matched = cls;
+ struct DirScanContext *dsc = cls;
struct GNUNET_PeerIdentity identity;
const char *filename;
+ struct HostEntry *entry;
+ struct GNUNET_HELLO_Message *hello;
+ struct GNUNET_PeerIdentity id;
- if (GNUNET_DISK_file_test (fullname) != GNUNET_YES)
+ if (GNUNET_YES != GNUNET_DISK_file_test (fullname))
return GNUNET_OK; /* ignore non-files */
if (strlen (fullname) < sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded))
{
- remove_garbage (fullname);
+ if (GNUNET_YES == dsc->remove_files)
+ remove_garbage (fullname);
return GNUNET_OK;
}
filename =
&fullname[strlen (fullname) -
sizeof (struct GNUNET_CRYPTO_HashAsciiEncoded) + 1];
- if (filename[-1] != DIR_SEPARATOR)
+ if (DIR_SEPARATOR != filename[-1])
{
- remove_garbage (fullname);
+ if (GNUNET_YES == dsc->remove_files)
+ remove_garbage (fullname);
return GNUNET_OK;
}
if (GNUNET_OK !=
GNUNET_CRYPTO_hash_from_string (filename, &identity.hashPubKey))
{
- remove_garbage (fullname);
+ /* odd filename, but might still be valid, try getting identity from HELLO */
+ if ( (NULL != (hello = read_host_file (filename,
+ dsc->remove_files))) &&
+ (GNUNET_OK ==
+ GNUNET_HELLO_get_id (hello,
+ &id)) )
+ {
+ /* ok, found something valid, remember HELLO */
+ entry = GNUNET_malloc (sizeof (struct HostEntry));
+ entry->identity = id;
+ GNUNET_CONTAINER_multihashmap_put (hostmap, &entry->identity.hashPubKey, entry,
+ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_ONLY);
+ entry->hello = hello;
+ notify_all (entry);
+ dsc->matched++;
+ return GNUNET_OK;
+ }
+ if (GNUNET_YES == dsc->remove_files)
+ remove_garbage (fullname);
return GNUNET_OK;
}
- (*matched)++;
+ dsc->matched++;
add_host_to_known_hosts (&identity);
return GNUNET_OK;
}
/**
* Call this method periodically to scan data/hosts for new hosts.
+ *
+ * @param cls unused
+ * @param tc scheduler context, aborted if reason is shutdown
*/
static void
cron_scan_directory_data_hosts (void *cls,
const struct GNUNET_SCHEDULER_TaskContext *tc)
{
static unsigned int retries;
- unsigned int count;
+ struct DirScanContext dsc;
if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
return;
- count = 0;
if (GNUNET_SYSERR == GNUNET_DISK_directory_create (networkIdDirectory))
{
GNUNET_SCHEDULER_add_delayed_with_priority (DATA_HOST_FREQ,
&cron_scan_directory_data_hosts, NULL);
return;
}
+ dsc.matched = 0;
+ dsc.remove_files = GNUNET_YES;
GNUNET_DISK_directory_scan (networkIdDirectory,
- &hosts_directory_scan_callback, &count);
- if ((0 == count) && (0 == (++retries & 31)))
+ &hosts_directory_scan_callback, &dsc);
+ if ((0 == dsc.matched) && (0 == (++retries & 31)))
GNUNET_log (GNUNET_ERROR_TYPE_WARNING | GNUNET_ERROR_TYPE_BULK,
_("Still no peers found in `%s'!\n"), networkIdDirectory);
GNUNET_SCHEDULER_add_delayed_with_priority (DATA_HOST_FREQ,
struct HostEntry *host;
struct GNUNET_HELLO_Message *mrg;
struct GNUNET_TIME_Absolute delta;
+ unsigned int cnt;
add_host_to_known_hosts (peer);
host = GNUNET_CONTAINER_multihashmap_get (hostmap, &peer->hashPubKey);
- GNUNET_assert (host != NULL);
- if (host->hello == NULL)
+ GNUNET_assert (NULL != host);
+ if (NULL == host->hello)
{
host->hello = GNUNET_malloc (GNUNET_HELLO_size (hello));
memcpy (host->hello, hello, GNUNET_HELLO_size (hello));
delta = GNUNET_HELLO_equals (mrg, host->hello, GNUNET_TIME_absolute_get ());
if (delta.abs_value == GNUNET_TIME_UNIT_FOREVER_ABS.abs_value)
{
+ /* no differences, just ignore the update */
GNUNET_free (mrg);
return;
}
fn = get_host_filename (peer);
if (GNUNET_OK == GNUNET_DISK_directory_create_for_file (fn))
{
- if (GNUNET_SYSERR ==
- GNUNET_DISK_fn_write (fn, host->hello, GNUNET_HELLO_size (host->hello),
- GNUNET_DISK_PERM_USER_READ |
- GNUNET_DISK_PERM_USER_WRITE |
- GNUNET_DISK_PERM_GROUP_READ |
- GNUNET_DISK_PERM_OTHER_READ))
- GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
-
+ cnt = 0;
+ (void) GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &count_addresses,
+ &cnt);
+ if (0 == cnt)
+ {
+ /* no valid addresses, don't put HELLO on disk; in fact,
+ if one exists on disk, remove it */
+ (void) UNLINK (fn);
+ }
+ else
+ {
+ if (GNUNET_SYSERR ==
+ GNUNET_DISK_fn_write (fn, host->hello, GNUNET_HELLO_size (host->hello),
+ GNUNET_DISK_PERM_USER_READ |
+ GNUNET_DISK_PERM_USER_WRITE |
+ GNUNET_DISK_PERM_GROUP_READ |
+ GNUNET_DISK_PERM_OTHER_READ))
+ GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING, "write", fn);
+ }
}
GNUNET_free (fn);
notify_all (host);
}
-
/**
* Do transmit info about peer to given host.
*
* @return GNUNET_YES (continue to iterate)
*/
static int
-add_to_tc (void *cls, const GNUNET_HashCode * key, void *value)
+add_to_tc (void *cls, const struct GNUNET_HashCode * key, void *value)
{
struct GNUNET_SERVER_TransmitContext *tc = cls;
struct HostEntry *pos = value;
struct InfoMessage *im;
uint16_t hs;
- char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
+ char buf[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
hs = 0;
im = (struct InfoMessage *) buf;
/**
* @brief delete expired HELLO entries in data/hosts/
+ *
+ * @param cls pointer to current time (struct GNUNET_TIME_Absolute)
+ * @param fn filename to test to see if the HELLO expired
+ * @return GNUNET_OK (continue iteration)
*/
static int
discard_hosts_helper (void *cls, const char *fn)
{
struct GNUNET_TIME_Absolute *now = cls;
- char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1];
+ char buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE - 1] GNUNET_ALIGN;
const struct GNUNET_HELLO_Message *hello;
struct GNUNET_HELLO_Message *new_hello;
int size;
+ unsigned int cnt;
size = GNUNET_DISK_fn_read (fn, buffer, sizeof (buffer));
if (size < sizeof (struct GNUNET_MessageHeader))
}
hello = (const struct GNUNET_HELLO_Message *) buffer;
new_hello =
- GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES, &discard_expired, now);
- if (new_hello != NULL)
+ GNUNET_HELLO_iterate_addresses (hello, GNUNET_YES, &discard_expired, now);
+ cnt = 0;
+ if (NULL != new_hello)
+ (void) GNUNET_HELLO_iterate_addresses (hello, GNUNET_NO, &count_addresses, &cnt);
+ if ( (NULL != new_hello) && (0 < cnt) )
{
GNUNET_DISK_fn_write (fn, new_hello, GNUNET_HELLO_size (new_hello),
GNUNET_DISK_PERM_USER_READ |
GNUNET_DISK_PERM_USER_WRITE |
GNUNET_DISK_PERM_GROUP_READ |
GNUNET_DISK_PERM_OTHER_READ);
- GNUNET_free (new_hello);
}
else
{
GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING |
GNUNET_ERROR_TYPE_BULK, "unlink", fn);
}
+ GNUNET_free_non_null (new_hello);
return GNUNET_OK;
}
/**
- * Call this method periodically to scan data/hosts for new hosts.
+ * Call this method periodically to scan data/hosts for ancient
+ * HELLOs to expire.
+ *
+ * @param cls unused
+ * @param tc scheduler context, aborted if reason is shutdown
*/
static void
cron_clean_data_hosts (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
return;
}
-#if DEBUG_PEERINFO
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received for peer `%4s'\n",
"HELLO", GNUNET_i2s (&pid));
-#endif
bind_address (&pid, hello);
GNUNET_SERVER_receive_done (client, GNUNET_OK);
}
lpm = (const struct ListPeerMessage *) message;
GNUNET_break (0 == ntohl (lpm->reserved));
-#if DEBUG_PEERINFO
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received for peer `%4s'\n",
"GET", GNUNET_i2s (&lpm->peer));
-#endif
tc = GNUNET_SERVER_transmit_context_create (client);
GNUNET_CONTAINER_multihashmap_get_multiple (hostmap, &lpm->peer.hashPubKey,
&add_to_tc, tc);
{
struct GNUNET_SERVER_TransmitContext *tc;
-#if DEBUG_PEERINFO
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received\n", "GET_ALL");
-#endif
tc = GNUNET_SERVER_transmit_context_create (client);
GNUNET_CONTAINER_multihashmap_iterate (hostmap, &add_to_tc, tc);
GNUNET_SERVER_transmit_context_append_data (tc, NULL, 0,
}
+/**
+ * Pass the given client the information we have in the respective
+ * host entry; the client is already in the notification context.
+ *
+ * @param cls the 'struct GNUNET_SERVER_Client' to notify
+ * @param key key for the value (unused)
+ * @param value the 'struct HostEntry' to notify the client about
+ * @return GNUNET_YES (always, continue to iterate)
+ */
static int
-do_notify_entry (void *cls, const GNUNET_HashCode * key, void *value)
+do_notify_entry (void *cls, const struct GNUNET_HashCode * key, void *value)
{
struct GNUNET_SERVER_Client *client = cls;
struct HostEntry *he = value;
handle_notify (void *cls, struct GNUNET_SERVER_Client *client,
const struct GNUNET_MessageHeader *message)
{
-#if DEBUG_PEERINFO
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "`%s' message received\n", "NOTIFY");
-#endif
+ GNUNET_SERVER_client_mark_monitor (client);
GNUNET_SERVER_notification_context_add (notify_list, client);
GNUNET_CONTAINER_multihashmap_iterate (hostmap, &do_notify_entry, client);
GNUNET_SERVER_receive_done (client, GNUNET_OK);
}
+/**
+ * Release memory taken by a host entry.
+ *
+ * @param cls NULL
+ * @param key key of the host entry
+ * @param value the 'struct HostEntry' to free
+ * @return GNUNET_YES (continue to iterate)
+ */
static int
-free_host_entry (void *cls, const GNUNET_HashCode * key, void *value)
+free_host_entry (void *cls, const struct GNUNET_HashCode * key, void *value)
{
struct HostEntry *he = value;
return GNUNET_YES;
}
+
/**
* Clean up our state. Called during shutdown.
*
notify_list = NULL;
GNUNET_CONTAINER_multihashmap_iterate (hostmap, &free_host_entry, NULL);
GNUNET_CONTAINER_multihashmap_destroy (hostmap);
- if (stats != NULL)
+ if (NULL != stats)
{
GNUNET_STATISTICS_destroy (stats, GNUNET_NO);
stats = NULL;
/**
- * Process statistics requests.
+ * Start up peerinfo service.
*
* @param cls closure
* @param server the initialized server
sizeof (struct GNUNET_MessageHeader)},
{NULL, NULL, 0, 0}
};
+ char *peerdir;
+ char *ip;
+ struct DirScanContext dsc;
- hostmap = GNUNET_CONTAINER_multihashmap_create (1024);
+ hostmap = GNUNET_CONTAINER_multihashmap_create (1024, GNUNET_YES);
stats = GNUNET_STATISTICS_create ("peerinfo", cfg);
notify_list = GNUNET_SERVER_notification_context_create (server, 0);
GNUNET_assert (GNUNET_OK ==
GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL, &shutdown_task,
NULL);
GNUNET_SERVER_add_handlers (server, handlers);
+ ip = GNUNET_OS_installation_get_path (GNUNET_OS_IPK_DATADIR);
+ GNUNET_asprintf (&peerdir,
+ "%shellos",
+ ip);
+ GNUNET_free (ip);
+ GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+ _("Importing HELLOs from `%s'\n"),
+ peerdir);
+ dsc.matched = 0;
+ dsc.remove_files = GNUNET_NO;
+ GNUNET_DISK_directory_scan (peerdir,
+ &hosts_directory_scan_callback, &dsc);
+ GNUNET_free (peerdir);
}
/**
- * The main function for the statistics service.
+ * The main function for the peerinfo service.
*
* @param argc number of arguments from the command line
* @param argv command line arguments