#include "gnunet_ats_service.h"
#include "gnunet_transport_service.h"
+/**
+ * FIXME
+ */
#define TIMEOUT GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 5)
+/**
+ * FIXME
+ */
#define BIG_M_STRING "unlimited"
/**
* Final status code.
*/
static int ret;
+
+/**
+ * FIXME
+ */
static int results;
+
+/**
+ * FIXME
+ */
static int resolve_addresses_numeric;
+
+/**
+ * FIXME
+ */
static int receive_done;
/**
*/
static char *pid_str;
+/**
+ * FIXME
+ */
static char *type_str;
+
+/**
+ * FIXME
+ */
static unsigned int value;
+
+/**
+ * FIXME
+ */
static int pending;
/**
*/
static int op_monitor;
+/**
+ * FIXME
+ */
static struct GNUNET_ATS_PerformanceHandle *ph;
+/**
+ * FIXME
+ */
static struct GNUNET_ATS_AddressListHandle *alh;
+/**
+ * FIXME
+ */
static struct GNUNET_CONFIGURATION_Handle *cfg;
+/**
+ * FIXME
+ */
static GNUNET_SCHEDULER_TaskIdentifier end_task;
+/**
+ * FIXME
+ */
static struct GNUNET_CONTAINER_MultiPeerMap *addresses;
+/**
+ * Structure used to remember all pending address resolutions.
+ * We keep address information in here while we talk to transport
+ * to map the address to a string.
+ */
struct PendingResolutions
{
+ /**
+ * Kept in a DLL.
+ */
struct PendingResolutions *next;
+
+ /**
+ * Kept in a DLL.
+ */
struct PendingResolutions *prev;
+ /**
+ * Copy of the address we are resolving.
+ */
struct GNUNET_HELLO_Address *address;
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
+ /**
+ * Handle to the transport request to convert the address
+ * to a string.
+ */
+ struct GNUNET_TRANSPORT_AddressToStringContext *tats_ctx;
+
+ /**
+ * Array of performance data.
+ */
struct GNUNET_ATS_Information *ats;
+
+ /**
+ * Length of the @e ats array.
+ */
uint32_t ats_count;
- struct GNUNET_TRANSPORT_AddressToStringContext * tats_ctx;
+ /**
+ * Amount of outbound bandwidth assigned by ATS.
+ */
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
+
+ /**
+ * Amount of inbound bandwidth assigned by ATS.
+ */
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
+
+ /**
+ * Is this an active address?
+ */
+ int active;
};
+
+/**
+ * Information we keep for an address. Used to avoid
+ * printing the same data multiple times.
+ */
struct ATSAddress
{
+ /**
+ * Address information.
+ */
struct GNUNET_HELLO_Address *address;
+
+ /**
+ * Current outbound bandwidth.
+ */
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
+
+ /**
+ * Current inbound bandwidth.
+ */
struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
-};
+ /**
+ * Is this an active address?
+ */
+ int active;
+
+};
+/**
+ * Head of list of pending resolution requests.
+ */
static struct PendingResolutions *head;
+/**
+ * Tail of list of pending resolution requests.
+ */
static struct PendingResolutions *tail;
+/**
+ * Free address corresponding to a given peer.
+ *
+ * @param cls NULL
+ * @param key peer identity
+ * @param value the `struct ATSAddress *` to be freed
+ * @return #GNUNET_YES (always)
+ */
static int
free_addr_it (void *cls,
const struct GNUNET_PeerIdentity *key,
}
+/**
+ * Task run on shutdown.
+ *
+ * @param cls NULL
+ * @param tc scheduler context
+ */
static void
end (void *cls,
const struct GNUNET_SCHEDULER_TaskContext *tc)
GNUNET_free(pr);
pending++;
}
-
- GNUNET_CONTAINER_multipeermap_iterate(addresses, &free_addr_it, NULL);
- GNUNET_CONTAINER_multipeermap_destroy(addresses);
+ GNUNET_CONTAINER_multipeermap_iterate (addresses,
+ &free_addr_it,
+ NULL);
+ GNUNET_CONTAINER_multipeermap_destroy (addresses);
+ addresses = NULL;
if (0 < pending)
- fprintf (stderr, _("%u address resolutions had a timeout\n"), pending);
+ FPRINTF (stderr,
+ _("%u address resolutions had a timeout\n"),
+ pending);
if (op_list_used || op_list_all)
- fprintf (stderr, _("ATS returned results for %u addresses\n"), results);
+ FPRINTF (stderr,
+ _("ATS returned results for %u addresses\n"),
+ results);
ret = 0;
}
+/**
+ * Function to call with a textual representation of an address. This
+ * function will be called several times with different possible
+ * textual representations, and a last time with @address being NULL
+ * to signal the end of the iteration. Note that @address NULL
+ * always is the last call, regardless of the value in @a res.
+ *
+ * @param cls closure, a `struct PendingResolutions *`
+ * @param address NULL on end of iteration,
+ * otherwise 0-terminated printable UTF-8 string,
+ * in particular an empty string if @a res is #GNUNET_NO
+ * @param res result of the address to string conversion:
+ * if #GNUNET_OK: conversion successful
+ * if #GNUNET_NO: address was invalid (or not supported)
+ * if #GNUNET_SYSERR: communication error (IPC error)
+ */
static void
transport_addr_to_str_cb (void *cls,
const char *address,
int res)
{
- struct PendingResolutions * pr = cls;
+ struct PendingResolutions *pr = cls;
char *ats_str;
char *ats_tmp;
char *ats_prop_arr[GNUNET_ATS_PropertyCount] = GNUNET_ATS_PropertyStrings;
uint32_t ats_value;
uint32_t network;
- if (res == GNUNET_SYSERR)
- {
- fprintf (stderr,
- "Failed to convert address for peer `%s' plugin `%s' length %lu to string \n",
- GNUNET_i2s (&pr->address->peer),
- pr->address->transport_name,
- pr->address->address_length);
- return;
- }
-
if (NULL == address)
{
/* We're done */
GNUNET_SCHEDULER_cancel (end_task);
end_task = GNUNET_SCHEDULER_add_now (end, NULL);
}
-
+ return;
+ }
+ switch (res)
+ {
+ case GNUNET_SYSERR:
+ FPRINTF (stderr,
+ "Failed to convert address for peer `%s' plugin `%s' length %lu to string (communication error)\n",
+ GNUNET_i2s (&pr->address->peer),
+ pr->address->transport_name,
+ pr->address->address_length);
+ return;
+ case GNUNET_NO:
+ FPRINTF (stderr,
+ "Failed to convert address for peer `%s' plugin `%s' length %lu to string (address invalid or not supported)\n",
+ GNUNET_i2s (&pr->address->peer),
+ pr->address->transport_name,
+ pr->address->address_length);
+ return;
+ case GNUNET_OK:
+ /* continues below */
+ break;
+ default:
+ GNUNET_break (0);
return;
}
- ats_str = GNUNET_strdup("");
+ ats_str = GNUNET_strdup (pr->active ? _("active ") : _("inactive "));
network = GNUNET_ATS_NET_UNSPECIFIED;
for (c = 0; c < pr->ats_count; c++)
{
if (ats_type > GNUNET_ATS_PropertyCount)
{
- fprintf (stderr,
+ FPRINTF (stderr,
"Invalid ATS property type %u %u for address %s\n",
ats_type,
pr->ats[c].type,
GNUNET_free(ats_prop_value);
}
- fprintf (stderr,
+ FPRINTF (stderr,
_("Peer `%s' plugin `%s', address `%s', `%s' bw out: %u Bytes/s, bw in %u Bytes/s, %s\n"),
GNUNET_i2s (&pr->address->peer),
pr->address->transport_name,
ntohl (pr->bandwidth_out.value__),
ntohl (pr->bandwidth_in.value__),
ats_str);
- GNUNET_free(ats_str);
+ GNUNET_free (ats_str);
}
+/**
+ * Closure for #find_address_it().
+ */
struct AddressFindCtx
{
+ /**
+ * Address we are looking for.
+ */
const struct GNUNET_HELLO_Address *src;
+
+ /**
+ * Where to write the `struct ATSAddress` if we found one that matches.
+ */
struct ATSAddress *res;
};
+/**
+ * Find address corresponding to a given peer.
+ *
+ * @param cls the `struct AddressFindCtx *`
+ * @param key peer identity
+ * @param value the `struct ATSAddress *` for an existing address
+ * @return #GNUNET_NO if we found a match, #GNUNET_YES if not
+ */
static int
find_address_it (void *cls,
const struct GNUNET_PeerIdentity *key,
actx->res = exist;
return GNUNET_NO;
}
-
return GNUNET_YES;
}
*
* @param cls closure (NULL)
* @param address the address, NULL if ATS service was disconnected
- * @param address_active is this address actively used to maintain a connection
- to a peer
+ * @param active #GNUNET_YES if this address is actively used
+ * to maintain a connection to a peer;
+ * #GNUNET_NO if the address is not actively used;
+ * #GNUNET_SYSERR if this address is no longer available for ATS
* @param bandwidth_out assigned outbound bandwidth for the connection
* @param bandwidth_in assigned inbound bandwidth for the connection
* @param ats performance data for the address (as far as known)
* @param ats_count number of performance records in @a ats
*/
static void
-ats_perf_mon_cb(void *cls,
- const struct GNUNET_HELLO_Address *address,
- int active,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
- const struct GNUNET_ATS_Information *ats,
- uint32_t ats_count)
+ats_perf_mon_cb (void *cls,
+ const struct GNUNET_HELLO_Address *address,
+ int active,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+ const struct GNUNET_ATS_Information *ats,
+ uint32_t ats_count)
{
struct PendingResolutions *pr;
struct PendingResolutions *cur;
GNUNET_free (cur);
}
- GNUNET_CONTAINER_multipeermap_iterate(addresses, &free_addr_it, NULL);
+ GNUNET_CONTAINER_multipeermap_iterate (addresses,
+ &free_addr_it,
+ NULL);
+ return;
+ }
+ if (GNUNET_SYSERR == active)
+ {
+ /* remove address */
+ struct AddressFindCtx actx;
+
+ actx.src = address;
+ actx.res = NULL;
+ GNUNET_CONTAINER_multipeermap_get_multiple (addresses,
+ &address->peer,
+ &find_address_it,
+ &actx);
+ if (NULL == actx.res)
+ {
+ GNUNET_break (0);
+ return;
+ }
+ GNUNET_break (GNUNET_OK ==
+ GNUNET_CONTAINER_multipeermap_remove (addresses,
+ &address->peer,
+ actx.res));
+ FPRINTF (stderr,
+ _("Removed address of peer `%s' with plugin `%s'\n"),
+ GNUNET_i2s (&address->peer),
+ actx.res->address->transport_name);
+ GNUNET_HELLO_address_free (actx.res);
+ GNUNET_free (actx.res);
return;
}
actx.src = address;
actx.res = NULL;
-
- GNUNET_CONTAINER_multipeermap_iterate (addresses,
- &find_address_it,
- &actx);
+ GNUNET_CONTAINER_multipeermap_get_multiple (addresses,
+ &address->peer,
+ &find_address_it,
+ &actx);
if ((NULL != actx.res))
{
if ((bandwidth_in.value__ == actx.res->bandwidth_in.value__) &&
- (bandwidth_out.value__ == actx.res->bandwidth_out.value__))
+ (bandwidth_out.value__ == actx.res->bandwidth_out.value__) &&
+ (active == actx.res->active))
{
return; /* Nothing to do here */
}
actx.res->bandwidth_out = bandwidth_out;
}
}
- a = GNUNET_new (struct ATSAddress);
- a->address = GNUNET_HELLO_address_copy(address);
- a->bandwidth_in = bandwidth_in;
- a->bandwidth_out = bandwidth_out;
- GNUNET_CONTAINER_multipeermap_put (addresses,
- &address->peer,
- a,
- GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
+ else
+ {
+ a = GNUNET_new (struct ATSAddress);
+
+ a->address = GNUNET_HELLO_address_copy(address);
+ a->bandwidth_in = bandwidth_in;
+ a->bandwidth_out = bandwidth_out;
+ a->active = active;
+ GNUNET_CONTAINER_multipeermap_put (addresses,
+ &address->peer,
+ a,
+ GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
+ }
}
pr = GNUNET_malloc (sizeof (struct PendingResolutions) +
pr->address = GNUNET_HELLO_address_copy (address);
pr->bandwidth_in = bandwidth_in;
pr->bandwidth_out = bandwidth_out;
+ pr->active = active;
pr->tats_ctx = GNUNET_TRANSPORT_address_to_string (cfg, address,
resolve_addresses_numeric,
GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10),
}
+/**
+ * Signature of a function that is called with QoS information about an address.
+ *
+ * @param cls closure (NULL)
+ * @param address the address, NULL if ATS service was disconnected
+ * @param active is this address actively used to maintain a connection
+ to a peer
+ * @param bandwidth_out assigned outbound bandwidth for the connection
+ * @param bandwidth_in assigned inbound bandwidth for the connection
+ * @param ats performance data for the address (as far as known)
+ * @param ats_count number of performance records in @a ats
+ */
static void
-ats_perf_cb(void *cls,
- const struct GNUNET_HELLO_Address *address,
- int active,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
- struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
- const struct GNUNET_ATS_Information *ats,
- uint32_t ats_count)
+ats_perf_cb (void *cls,
+ const struct GNUNET_HELLO_Address *address,
+ int active,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+ const struct GNUNET_ATS_Information *ats,
+ uint32_t ats_count)
{
- struct PendingResolutions * pr;
+ struct PendingResolutions *pr;
if (NULL == address)
{
pr->address = GNUNET_HELLO_address_copy (address);
pr->bandwidth_in = bandwidth_in;
pr->bandwidth_out = bandwidth_out;
+ pr->active = active;
pr->tats_ctx = GNUNET_TRANSPORT_address_to_string (cfg, address,
- resolve_addresses_numeric,
- GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10),
- transport_addr_to_str_cb, pr);
- GNUNET_CONTAINER_DLL_insert(head, tail, pr);
+ resolve_addresses_numeric,
+ GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 10),
+ &transport_addr_to_str_cb, pr);
+ GNUNET_CONTAINER_DLL_insert (head, tail, pr);
results++;
pending++;
}
+/**
+ * Print information about the quotas configured for the various
+ * network scopes.
+ *
+ * @param cfg configuration to obtain quota information from
+ * @return total number of ATS network types known
+ */
static unsigned int
-print_quotas(const struct GNUNET_CONFIGURATION_Handle *cfg)
+print_quotas (const struct GNUNET_CONFIGURATION_Handle *cfg)
{
char *network_str[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkTypeString;
char * entry_in = NULL;
for (c = 0; (c < GNUNET_ATS_NetworkTypeCount); c++)
{
- GNUNET_asprintf (&entry_out, "%s_QUOTA_OUT", network_str[c]);
- GNUNET_asprintf (&entry_in, "%s_QUOTA_IN", network_str[c]);
+ GNUNET_asprintf (&entry_out,
+ "%s_QUOTA_OUT",
+ network_str[c]);
+ GNUNET_asprintf (&entry_in,
+ "%s_QUOTA_IN",
+ network_str[c]);
/* quota out */
- if (GNUNET_OK
- == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", entry_out,
- "a_out_str))
+ if (GNUNET_OK ==
+ GNUNET_CONFIGURATION_get_value_string (cfg,
+ "ats",
+ entry_out,
+ "a_out_str))
{
if (0 == strcmp (quota_out_str, BIG_M_STRING)
- || (GNUNET_SYSERR
- == GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str, "a_out)))
+ || (GNUNET_SYSERR ==
+ GNUNET_STRINGS_fancy_size_to_bytes (quota_out_str,
+ "a_out)))
quota_out = UINT32_MAX;
GNUNET_free(quota_out_str);
}
else
{
- fprintf (stderr, "Outbound quota for network `%11s' not configured!\n",
- network_str[c]);
+ FPRINTF (stderr,
+ "Outbound quota for network `%11s' not configured!\n",
+ network_str[c]);
GNUNET_asprintf ("a_out_str, "-");
}
GNUNET_free(entry_out);
/* quota in */
- if (GNUNET_OK
- == GNUNET_CONFIGURATION_get_value_string (cfg, "ats", entry_in,
- "a_in_str))
+ if (GNUNET_OK ==
+ GNUNET_CONFIGURATION_get_value_string (cfg,
+ "ats",
+ entry_in,
+ "a_in_str))
{
if (0 == strcmp (quota_in_str, BIG_M_STRING)
- || (GNUNET_SYSERR
- == GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, "a_in)))
+ || (GNUNET_SYSERR ==
+ GNUNET_STRINGS_fancy_size_to_bytes (quota_in_str, "a_in)))
quota_in = UINT32_MAX;
GNUNET_free(quota_in_str);
GNUNET_asprintf ("a_in_str, "%llu", quota_in);
}
else
{
- fprintf (stderr, "Inbound quota for network `%11s' not configured!\n",
- network_str[c]);
+ FPRINTF (stderr,
+ "Inbound quota for network `%11s' not configured!\n",
+ network_str[c]);
GNUNET_asprintf ("a_in_str, "-");
}
GNUNET_free(entry_in);
- fprintf (stderr, _("Quota for network `%11s' (in/out): %10s / %10s\n"),
- network_str[c], quota_in_str, quota_out_str);
+ FPRINTF (stderr,
+ _("Quota for network `%11s' (in/out): %10s / %10s\n"),
+ network_str[c],
+ quota_in_str,
+ quota_out_str);
GNUNET_free(quota_out_str);
GNUNET_free(quota_in_str);
}
}
+/**
+ * Function called with the result from the test if ATS is
+ * running. Runs the actual main logic.
+ *
+ * @param cls the `struct GNUNET_CONFIGURATION_Handle *`
+ * @param result result of the test, #GNUNET_YES if ATS is running
+ */
static void
-testservice_ats(void *cls, int result)
+testservice_ats (void *cls,
+ int result)
{
struct GNUNET_CONFIGURATION_Handle *cfg = cls;
struct GNUNET_PeerIdentity pid;
if (GNUNET_YES != result)
{
- FPRINTF (stderr, _("Service `%s' is not running\n"), "ats");
+ FPRINTF (stderr,
+ _("Service `%s' is not running\n"),
+ "ats");
return;
}
if ((1 < c))
{
FPRINTF (stderr,
- _("Please select one operation : %s or %s or %s or %s or %s\n"),
- "--used", "--all", "--monitor", "--preference", "--quotas");
+ _("Please select one operation : %s or %s or %s or %s or %s\n"),
+ "--used",
+ "--all",
+ "--monitor",
+ "--preference",
+ "--quotas");
return;
}
if ((0 == c))
ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
if (NULL == ph)
{
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("Cannot connect to ATS service, exiting...\n"));
return;
}
alh = GNUNET_ATS_performance_list_addresses (ph,
- (NULL == pid_str) ? NULL : &pid, GNUNET_YES, ats_perf_cb, NULL);
+ (NULL == pid_str) ? NULL : &pid,
+ GNUNET_YES,
+ &ats_perf_cb, NULL);
if (NULL == alh)
{
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("Cannot issue request to ATS service, exiting...\n"));
end_task = GNUNET_SCHEDULER_add_now (&end, NULL);
return;
{
ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
if (NULL == ph)
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("Cannot connect to ATS service, exiting...\n"));
alh = GNUNET_ATS_performance_list_addresses (ph,
- (NULL == pid_str) ? NULL : &pid, GNUNET_NO, ats_perf_cb, NULL);
+ (NULL == pid_str)
+ ? NULL
+ : &pid,
+ GNUNET_NO,
+ &ats_perf_cb, NULL);
if (NULL == alh)
{
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("Cannot issue request to ATS service, exiting...\n"));
end_task = GNUNET_SCHEDULER_add_now (&end, NULL);
return;
}
else if (op_monitor)
{
- ph = GNUNET_ATS_performance_init (cfg, &ats_perf_mon_cb, NULL);
+ ph = GNUNET_ATS_performance_init (cfg,
+ &ats_perf_mon_cb,
+ NULL);
if (NULL == ph)
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("Cannot connect to ATS service, exiting...\n"));
end_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_FOREVER_REL,
&end,
{
if (NULL == type_str)
{
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("No preference type given!\n"));
return;
}
if (NULL == pid_str)
{
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("No peer given!\n"));
return;
}
type = GNUNET_ATS_PREFERENCE_BANDWIDTH;
else
{
- FPRINTF (stderr, "%s", _("Valid type required\n"));
+ FPRINTF (stderr,
+ "%s",
+ _("Valid type required\n"));
return;
}
/* set */
ph = GNUNET_ATS_performance_init (cfg, NULL, NULL);
if (NULL == ph)
- fprintf (stderr,
+ FPRINTF (stderr,
+ "%s",
_("Cannot connect to ATS service, exiting...\n"));
GNUNET_ATS_performance_change_preference (ph, &pid, type, (double) value,
* @return 0 ok, 1 on error
*/
int
-main(int argc, char * const *argv)
+main (int argc,
+ char * const *argv)
{
int res;