added simulation
[oweals/gnunet.git] / src / ats / gnunet-service-ats_addresses.c
index 2962f2dcfb1e87a154c11bc1e858339d957a2465..24fb8dbfe9f7ed6abb841721434c07c1a8a9a742 100644 (file)
@@ -249,6 +249,27 @@ struct GAS_Addresses_Suggestion_Requests
   struct GNUNET_PeerIdentity id;
 };
 
+ /**
+  * Pending Address suggestion requests
+  */
+ struct GAS_Addresses_Preference_Clients
+ {
+   /**
+    * Next in DLL
+    */
+   struct GAS_Addresses_Preference_Clients *next;
+
+   /**
+    * Previous in DLL
+    */
+   struct GAS_Addresses_Preference_Clients *prev;
+
+   /**
+    * Peer ID
+    */
+   void *client;
+ };
+
 /**
  * Handle for ATS address component
  */
@@ -265,19 +286,14 @@ struct GAS_Addresses_Handle
   struct GNUNET_CONTAINER_MultiPeerMap *addresses;
 
   /**
-   * Configure WAN quota in
-   */
-  unsigned long long wan_quota_in;
-
-  /**
-   * Configure WAN quota out
+   * Is ATS addresses running
    */
-  unsigned long long wan_quota_out;
+  int running;
 
   /**
-   * Is ATS addresses running
+   * Preferences clients
    */
-  int running;
+  int pref_clients;
 
   /**
    * Configured ATS solver
@@ -292,16 +308,31 @@ struct GAS_Addresses_Handle
   /**
    * Address suggestion requests DLL head
    */
-  struct GAS_Addresses_Suggestion_Requests *r_head;
+  struct GAS_Addresses_Suggestion_Requests *pending_requests_head;
 
   /**
    * Address suggestion requests DLL tail
    */
-  struct GAS_Addresses_Suggestion_Requests *r_tail;
+  struct GAS_Addresses_Suggestion_Requests *pending_requests_tail;
+
+  /**
+   * Address suggestion requests DLL head
+   */
+  struct GAS_Addresses_Preference_Clients *preference_clients_head;
 
-  /* Solver functions */
+  /**
+   * Address suggestion requests DLL head
+   */
+  struct GAS_Addresses_Preference_Clients *preference_clients_tail;
+
+  /**
+   * Solver functions
+   */
   struct GNUNET_ATS_PluginEnvironment env;
 
+  /**
+   * Solver plugin name as string
+   */
   char *plugin;
 };
 
@@ -630,6 +661,34 @@ find_exact_address (struct GAS_Addresses_Handle *handle,
   return ea;
 }
 
+/**
+ * Function allowing the solver to obtain normalized preference
+ * values from solver
+ *
+ * @param cls unused
+ * @param id the peer to return the normalized properties for
+ * @return array of double values with |GNUNET_ATS_PreferenceCount| elements
+ */
+const double *
+get_preferences_cb (void *cls, const struct GNUNET_PeerIdentity *id)
+{
+  return GAS_normalization_get_preferences_by_peer (id);
+}
+
+/**
+ * Function allowing the solver to obtain normalized property
+ * values for an address from solver
+ *
+ * @param cls unused
+ * @param address the address
+ * @return array of double values with |GNUNET_ATS_QualityPropertiesCount| elements
+ */
+const double *
+get_property_cb (void *cls, const struct ATS_Address *address)
+{
+  return GAS_normalization_get_properties ((struct ATS_Address *) address);
+}
+
 /**
  * Extract an ATS performance info from an address
  *
@@ -1130,7 +1189,7 @@ void
 GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
     const struct GNUNET_PeerIdentity *peer)
 {
-  struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
+  struct GAS_Addresses_Suggestion_Requests *cur = handle->pending_requests_head;
 
   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Received request: `%s' for peer %s\n",
       "request_address_cancel", GNUNET_i2s (peer));
@@ -1153,7 +1212,7 @@ GAS_addresses_request_address_cancel (struct GAS_Addresses_Handle *handle,
   GAS_addresses_handle_backoff_reset (handle, peer);
   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Removed request pending for peer `%s\n",
       GNUNET_i2s (peer));
-  GNUNET_CONTAINER_DLL_remove(handle->r_head, handle->r_tail, cur);
+  GNUNET_CONTAINER_DLL_remove(handle->pending_requests_head, handle->pending_requests_tail, cur);
   GNUNET_free(cur);
 }
 
@@ -1168,7 +1227,7 @@ void
 GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
     const struct GNUNET_PeerIdentity *peer)
 {
-  struct GAS_Addresses_Suggestion_Requests *cur = handle->r_head;
+  struct GAS_Addresses_Suggestion_Requests *cur = handle->pending_requests_head;
   struct ATS_Address *aa;
 
   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Received `%s' for peer `%s'\n",
@@ -1189,16 +1248,9 @@ GAS_addresses_request_address (struct GAS_Addresses_Handle *handle,
     GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
         "Adding new address suggestion request for `%s'\n",
          GNUNET_i2s (peer));
-    GNUNET_CONTAINER_DLL_insert(handle->r_head, handle->r_tail, cur);
+    GNUNET_CONTAINER_DLL_insert(handle->pending_requests_head, handle->pending_requests_tail, cur);
   }
 
-  /*
-   * Debuging information about addresses
-   *
-   * GNUNET_CONTAINER_multihashmap_get_multiple(handle->addresses,
-   *  &peer->hashPubKey, &addrinfo_it, (void *) peer);
-   */
-
   /* Get prefered address from solver */
   aa = (struct ATS_Address *) handle->env.sf.s_get (handle->solver, peer);
   if (NULL == aa)
@@ -1273,15 +1325,306 @@ GAS_addresses_handle_backoff_reset (struct GAS_Addresses_Handle *handle,
                                                                   &reset_address_it, NULL));
 }
 
+
+
+static int
+eval_count_active_it (void *cls, const struct GNUNET_PeerIdentity *id, void *obj)
+{
+  int *request_fulfilled = cls;
+  struct ATS_Address *addr = obj;
+
+  if (GNUNET_YES == addr->active)
+    (*request_fulfilled) = GNUNET_YES;
+
+  if (*request_fulfilled == GNUNET_YES)
+    return GNUNET_NO;
+  else
+    return GNUNET_YES;
+}
+
+
+/**
+ * Summary context
+ */
+struct SummaryContext {
+  /**
+   * Sum of the utilized inbound bandwidth per network
+   */
+  unsigned long long bandwidth_in_assigned[GNUNET_ATS_NetworkTypeCount];
+
+  /**
+   * Sum of the utilized outbound bandwidth per network
+   */
+  unsigned long long bandwidth_out_assigned[GNUNET_ATS_NetworkTypeCount];
+
+  /**
+   * Sum addresses within a network
+   */
+  unsigned int addresses_in_network[GNUNET_ATS_NetworkTypeCount];
+};
+
+
+static int
+eval_sum_bw_used (void *cls, const struct GNUNET_PeerIdentity *id, void *obj)
+{
+  struct ATS_Address *addr = obj;
+  int networks[GNUNET_ATS_NetworkTypeCount] = GNUNET_ATS_NetworkType;
+  int net;
+  struct SummaryContext  *ctx = cls;
+
+  int c;
+
+  if (GNUNET_YES == addr->active)
+  {
+    net = get_performance_info (addr, GNUNET_ATS_NETWORK_TYPE);
+    for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
+    {
+      if (net == networks[c])
+      {
+        ctx->addresses_in_network[c] ++;
+        ctx->bandwidth_in_assigned[c] += ntohl (addr->assigned_bw_in.value__);
+        ctx->bandwidth_out_assigned[c] += ntohl (addr->assigned_bw_out.value__);
+      }
+    }
+    GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Active address in  %s with (in/out) %llu/%llu Bps\n",
+        GNUNET_ATS_print_network_type(net),
+        ntohl (addr->assigned_bw_in.value__),
+        ntohl (addr->assigned_bw_out.value__));
+  }
+  return GNUNET_OK;
+}
+
+/**
+ * Summary context
+ */
+struct RelativityContext {
+
+  struct GAS_Addresses_Handle *ah;
+};
+
+static int
+find_active_address (void *cls, const struct GNUNET_PeerIdentity *id, void *obj)
+{
+  struct ATS_Address **res = cls;
+  struct ATS_Address *addr = obj;
+
+  if (GNUNET_YES == addr->active)
+    (*res) = addr;
+
+  if (NULL != (*res))
+    return GNUNET_NO;
+  else
+    return GNUNET_YES;
+}
+
 /**
- * Evaluathe current bandwidth assignment
+ * Evaluate current bandwidth assignment
+ *
+ * @param ah address handle
  */
 void
 GAS_addresses_evaluate_assignment (struct GAS_Addresses_Handle *ah)
 {
+  struct GAS_Addresses_Suggestion_Requests *cur;
+  struct GAS_Addresses_Preference_Clients *pcur;
+  int c;
+
+  float quality_requests_fulfilled = 0.0;
+  float quality_bandwidth_utilization[GNUNET_ATS_NetworkTypeCount];
+  float quality_bandwidth_utilization_total = 0.0;
+  float quality_application_requirements = 0.0;
+  float guq = 0.0;
+
+  int include_requests;
+  int include_utilization;
+  int include_requirements;
+
+  /* Variable related to requests */
+  unsigned int requests_pending;
+  unsigned int requests_fulfilled;
+  unsigned int request_active;
+
+  /* Variable related to utilization */
+  struct SummaryContext sum;
+  struct ATS_Address *active_address;
+  int network_count;
+
+  /* Variables for preferences */
+  int prefs[GNUNET_ATS_PreferenceCount] = GNUNET_ATS_PreferenceType;
+  double pref_val;
+  double prop_val;
+  const double *norm_values;
+  double prefs_fulfill[GNUNET_ATS_PreferenceCount];
+  int prefs_clients[GNUNET_ATS_PreferenceCount];
+  int rels;
+
   GNUNET_assert (NULL != ah);
-  GNUNET_log(GNUNET_ERROR_TYPE_DEBUG, "Current assignment has quality: Not implemented!\n");
+  GNUNET_assert (NULL != ah->addresses);
+
+  requests_pending = 0;
+  requests_fulfilled = 0;
+  /* 1) How many requests could be fulfilled? */
+  for (cur = ah->pending_requests_head; NULL != cur; cur = cur->next)
+  {
+    request_active = GNUNET_NO;
+    GNUNET_CONTAINER_multipeermap_get_multiple (ah->addresses,
+        &cur->id, &eval_count_active_it, &request_active);
+    if (GNUNET_YES == request_active)
+      requests_fulfilled ++;
+    requests_pending ++;
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer `%s': %u pending requests, %s\n",
+        GNUNET_i2s (&cur->id),
+        requests_pending,
+        (GNUNET_YES == request_active) ? "active adress" : "no active address");
+
+  }
+  if (requests_pending > 0)
+  {
+    quality_requests_fulfilled = (float) requests_fulfilled / requests_pending;
+    include_requests = GNUNET_YES;
+  }
+  else
+  {
+    quality_requests_fulfilled = 0.0;
+    include_requests = GNUNET_NO;
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%u pending requests, %u requests fullfilled\n",
+      requests_pending, requests_fulfilled);
+
+  /* 2) How well is bandwidth utilized? */
+  network_count = 0;
+  for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
+  {
+    quality_bandwidth_utilization[c] = 0.0;
+    sum.addresses_in_network[c] = 0;
+    sum.bandwidth_in_assigned[c] = 0;
+    sum.bandwidth_out_assigned[c] = 0;
+  }
+  GNUNET_CONTAINER_multipeermap_iterate(ah->addresses,
+      &eval_sum_bw_used, &sum);
+  for (c = 0; c < GNUNET_ATS_NetworkTypeCount; c++)
+  {
+    quality_bandwidth_utilization[c] = (((float)sum.bandwidth_out_assigned[c] / ah->env.out_quota[c]) +
+        ((float)sum.bandwidth_in_assigned[c] / ah->env.in_quota[c])) / 2;
+
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Utilization for network `%s': %f\n",
+         GNUNET_ATS_print_network_type(ah->env.networks[c]),
+         quality_bandwidth_utilization[c]);
+    if (sum.addresses_in_network[c] > 0)
+    {
+      quality_bandwidth_utilization_total += quality_bandwidth_utilization[c];
+      network_count ++;
+    }
+  }
+  if (0 < network_count)
+  {
+    quality_bandwidth_utilization_total /= network_count;
+    include_utilization = GNUNET_YES;
+  }
+  else
+  {
+    quality_bandwidth_utilization_total = 0.0;
+    include_utilization = GNUNET_NO;
+  }
+
+  /* 3) How well does selection match application requirements */
+  include_requirements = GNUNET_NO;
+  if (0 == ah->pref_clients)
+  {
+    include_requirements = GNUNET_NO;
+  }
+  else
+  {
+    for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
+    {
+      prefs_fulfill[c] = 0.0;
+      prefs_clients[c] = 0;
+    }
 
+    for (cur = ah->pending_requests_head; NULL != cur; cur = cur->next)
+    {
+      active_address = NULL;
+      GNUNET_CONTAINER_multipeermap_get_multiple (ah->addresses,
+          &cur->id, &find_active_address, &active_address);
+
+      for (pcur = ah->preference_clients_head; NULL != pcur; pcur = pcur->next)
+      {
+        for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
+        {
+          if (prefs[c] == GNUNET_ATS_PREFERENCE_END)
+            continue;
+          pref_val = -1.0;
+          pref_val = GAS_normalization_get_preferences_by_client (pcur->client, &cur->id, prefs[c]);
+          if (-1.0 == pref_val)
+          {
+            GNUNET_break (0);
+            continue;
+          }
+
+          if (DEFAULT_REL_PREFERENCE == pref_val)
+          {
+            /* Default preference value */
+            continue;
+          }
+
+          if (NULL != active_address)
+          {
+            norm_values = GAS_normalization_get_properties (active_address);
+            prop_val = norm_values[c];
+            if ((norm_values[c] <= 1.0) || (norm_values[c] >= 2.0))
+                prop_val = DEFAULT_REL_QUALITY;
+          }
+          else
+          {
+            prop_val = DEFAULT_REL_QUALITY;
+          }
+
+          /* We now have preference values [1..2] and properties [1..2] */
+
+          GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "%u Client %p, Peer %s Property %s: pref: %.3f prop %.3f \n",
+              c,
+              pcur->client,
+              GNUNET_i2s (&cur->id),
+              GNUNET_ATS_print_preference_type(prefs[c]),
+              pref_val,
+              prop_val);
+
+          prefs_fulfill[c] += (pref_val * prop_val) / 2;
+          prefs_clients[c] ++;
+        }
+      }
+    }
+    rels = 0;
+    for (c = 0; c < GNUNET_ATS_PreferenceCount; c++)
+    {
+      if (0 < prefs_clients[c])
+      {
+        prefs_fulfill[c] /= prefs_clients[c];
+        rels ++;
+        quality_application_requirements += prefs_fulfill[c];
+      }
+    }
+    if (rels > 0)
+      quality_application_requirements /= rels;
+    else
+      quality_application_requirements = 0.0;
+
+    include_requirements = GNUNET_YES;
+  }
+  /* GUQ */
+
+  if (include_requests + include_utilization + include_requirements > 0)
+    guq = (quality_requests_fulfilled + quality_bandwidth_utilization_total + quality_application_requirements) /
+      (include_requests + include_utilization + include_requirements);
+  else
+    guq = 0.0;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+      "Requests fulfilled %.3f bandwidth utilized %.3f application preferences met %.3f => %.3f\n",
+      quality_requests_fulfilled,
+      quality_bandwidth_utilization_total,
+      quality_application_requirements,
+      guq);
 }
 
 /**
@@ -1427,32 +1770,41 @@ normalized_property_changed_cb (void *cls, struct ATS_Address *address,
   ah->env.sf.s_address_update_property (ah->solver, address, type, 0, prop_rel);
 }
 
-/**
- * Function allowing the solver to obtain normalized preference
- * values from solver
- *
- * @param cls unused
- * @param id the peer to return the normalized properties for
- * @return array of double values with |GNUNET_ATS_PreferenceCount| elements
- */
-const double *
-get_preferences_cb (void *cls, const struct GNUNET_PeerIdentity *id)
+static struct GAS_Addresses_Preference_Clients *
+find_preference_client (struct GAS_Addresses_Handle *handle, void *client)
 {
-  return GAS_normalization_get_preferences (id);
+  struct GAS_Addresses_Preference_Clients *cur;
+
+  for (cur = handle->preference_clients_head; NULL != cur; cur = cur->next)
+  {
+    if (cur->client == client)
+      return cur;
+  }
+  return NULL;
 }
 
 /**
- * Function allowing the solver to obtain normalized property
- * values for an address from solver
+ * A performance client disconnected
  *
- * @param cls unused
- * @param address the address
- * @return array of double values with |GNUNET_ATS_QualityPropertiesCount| elements
+ * @param handle address handle
+ * @param client the client
  */
-const double *
-get_property_cb (void *cls, const struct ATS_Address *address)
+
+void
+GAS_addresses_preference_client_disconnect (struct GAS_Addresses_Handle *handle,
+    void *client)
 {
-  return GAS_normalization_get_properties ((struct ATS_Address *) address);
+  struct GAS_Addresses_Preference_Clients * pc;
+  if (NULL != (pc = find_preference_client (handle, client)))
+  {
+    GNUNET_CONTAINER_DLL_remove (handle->preference_clients_head,
+        handle->preference_clients_tail, pc);
+    GNUNET_free (pc);
+    GNUNET_assert (handle->pref_clients > 0);
+    handle->pref_clients --;
+    GNUNET_STATISTICS_set (handle->stat, "# active performance clients", handle->pref_clients, GNUNET_NO);
+  }
+  GAS_normalization_preference_client_disconnect (client);
 }
 
 /**
@@ -1465,10 +1817,11 @@ get_property_cb (void *cls, const struct ATS_Address *address)
  * @param score_abs the new preference score
  */
 void
-GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
+GAS_addresses_preference_change (struct GAS_Addresses_Handle *handle,
     void *client, const struct GNUNET_PeerIdentity *peer,
     enum GNUNET_ATS_PreferenceKind kind, float score_abs)
 {
+  struct GAS_Addresses_Preference_Clients * pc;
   GNUNET_log(GNUNET_ERROR_TYPE_DEBUG,
       "Received `%s' for peer `%s' for client %p\n", "CHANGE PREFERENCE",
       GNUNET_i2s (peer), client);
@@ -1486,6 +1839,16 @@ GAS_addresses_change_preference (struct GAS_Addresses_Handle *handle,
     return;
   }
 
+  if (NULL == find_preference_client (handle, client))
+  {
+    pc = GNUNET_malloc (sizeof (struct GAS_Addresses_Preference_Clients));
+    pc->client = client;
+    GNUNET_CONTAINER_DLL_insert (handle->preference_clients_head,
+        handle->preference_clients_tail, pc);
+    handle->pref_clients ++;
+    GNUNET_STATISTICS_set (handle->stat, "# active performance clients", handle->pref_clients, GNUNET_NO);
+  }
+
   handle->env.sf.s_bulk_start (handle->solver);
   /* Tell normalization about change, normalization will call callback if preference changed */
   GAS_normalization_normalize_preference (client, peer, kind, score_abs);
@@ -1677,7 +2040,7 @@ bandwidth_changed_cb (void *cls, struct ATS_Address *address)
   GAS_performance_notify_all_clients (&address->peer, address->plugin,
       address->addr, address->addr_len, address->session_id, address->atsi,
       address->atsi_count, address->assigned_bw_out, address->assigned_bw_in);
-  cur = handle->r_head;
+  cur = handle->pending_requests_head;
   while (NULL != cur)
   {
     if (0 == memcmp (&address->peer, &cur->id, sizeof(cur->id)))
@@ -1739,6 +2102,7 @@ GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
   ah->stat = (struct GNUNET_STATISTICS_Handle *) stats;
   /* Initialize the addresses database */
   ah->addresses = GNUNET_CONTAINER_multipeermap_create (128, GNUNET_NO);
+  ah->pref_clients = 0;
   GNUNET_assert(NULL != ah->addresses);
 
   /* Figure out configured solution method */
@@ -1787,9 +2151,9 @@ GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
     GNUNET_free(mode_str);
   }
 
-  load_quotas (cfg, quotas_in, quotas_out, GNUNET_ATS_NetworkTypeCount);
+  load_quotas (cfg, quotas_out, quotas_in, GNUNET_ATS_NetworkTypeCount);
   ah->env.info_cb = &solver_info_cb;
-  ah->env.info_cb_cls = &ah;
+  ah->env.info_cb_cls = ah;
   ah->env.bandwidth_changed_cb = &bandwidth_changed_cb;
   ah->env.bw_changed_cb_cls = ah;
   ah->env.get_preferences = &get_preferences_cb;
@@ -1907,6 +2271,7 @@ void
 GAS_addresses_done (struct GAS_Addresses_Handle *handle)
 {
   struct GAS_Addresses_Suggestion_Requests *cur;
+  struct GAS_Addresses_Preference_Clients *pcur;
 
   GNUNET_log(GNUNET_ERROR_TYPE_INFO, "Shutting down addresses\n");
   GNUNET_assert(NULL != handle);
@@ -1914,12 +2279,22 @@ GAS_addresses_done (struct GAS_Addresses_Handle *handle)
   handle->running = GNUNET_NO;
   GNUNET_CONTAINER_multipeermap_destroy (handle->addresses);
   handle->addresses = NULL;
-  while (NULL != (cur = handle->r_head))
+  while (NULL != (cur = handle->pending_requests_head))
   {
-    GNUNET_CONTAINER_DLL_remove(handle->r_head, handle->r_tail, cur);
+    GNUNET_CONTAINER_DLL_remove(handle->pending_requests_head, handle->pending_requests_tail, cur);
     GNUNET_free(cur);
   }
 
+  while (NULL != (pcur = handle->preference_clients_head))
+  {
+    GNUNET_CONTAINER_DLL_remove (handle->preference_clients_head,
+        handle->preference_clients_tail, pcur);
+    GNUNET_assert (handle->pref_clients > 0);
+    handle->pref_clients --;
+    GNUNET_STATISTICS_set (handle->stat, "# active performance clients", handle->pref_clients, GNUNET_NO);
+    GNUNET_free (pcur);
+  }
+
   GNUNET_PLUGIN_unload (handle->plugin, handle->solver);
   GNUNET_free (handle->plugin);
   GNUNET_free(handle);