fixing shutdown
[oweals/gnunet.git] / src / ats / ats_api_performance.c
index 81e4dc81ea47a215244d5e237a51ef3cb79f54ad..acbc18e582b499983d30a5cdb97ee834b3723ccc 100644 (file)
@@ -129,7 +129,7 @@ struct GNUNET_ATS_AddressListHandle
   /**
    * Callback
    */
-  GNUNET_ATS_PeerInformationCallback cb;
+  GNUNET_ATS_AddressInformationCallback cb;
 
   /**
    * Callback closure
@@ -157,6 +157,8 @@ struct GNUNET_ATS_AddressListHandle
   uint32_t id;
 };
 
+
+
 /**
  * ATS Handle to obtain and/or modify performance information.
  */
@@ -169,14 +171,14 @@ struct GNUNET_ATS_PerformanceHandle
   const struct GNUNET_CONFIGURATION_Handle *cfg;
 
   /**
-   * Callback to invoke on performance changes.
+   * Callback to invoke when an address has performance changes.
    */
-  GNUNET_ATS_PeerInformationCallback infocb;
+  GNUNET_ATS_AddressInformationCallback addr_info_cb;
 
   /**
-   * Closure for 'infocb'.
+   * Closure for 'addr_info_cb'.
    */
-  void *infocb_cls;
+  void *addr_info_cb_cls;
 
   /**
    * Connection to ATS service.
@@ -213,6 +215,7 @@ struct GNUNET_ATS_PerformanceHandle
    */
   struct GNUNET_ATS_AddressListHandle *addresslist_tail;
 
+
   /**
    * Current request for transmission to ATS.
    */
@@ -223,6 +226,11 @@ struct GNUNET_ATS_PerformanceHandle
    */
   GNUNET_SCHEDULER_TaskIdentifier task;
 
+  /**
+   * Monitor request multiplexing
+   */
+  uint32_t monitor_id;
+
   /**
    * Request multiplexing
    */
@@ -265,6 +273,16 @@ static void
 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
 
 
+/**
+ * Type of a function to call when we receive a message
+ * from the service.
+ *
+ * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
+ * @param msg message received, NULL on timeout or fatal error
+ */
+static void
+process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg);
+
 /**
  * We can now transmit a message to ATS. Do it.
  *
@@ -290,6 +308,10 @@ transmit_message_to_ats (void *cls, size_t size, void *buf)
     ret += p->size;
     size -= p->size;
     GNUNET_CONTAINER_DLL_remove (ph->pending_head, ph->pending_tail, p);
+    if (GNUNET_YES == p->is_init)
+      GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
+                            GNUNET_TIME_UNIT_FOREVER_REL);
+
     GNUNET_free (p);
   }
   do_transmit (ph);
@@ -341,6 +363,7 @@ process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
   uint16_t plugin_address_length;
   uint16_t plugin_name_length;
   uint32_t ats_count;
+  int addr_active;
 
   if (ntohs (msg->size) < sizeof (struct PeerInformationMessage))
   {
@@ -352,6 +375,7 @@ process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
   ats_count = ntohl (pi->ats_count);
   plugin_address_length = ntohs (pi->address_length);
   plugin_name_length = ntohs (pi->plugin_name_length);
+  addr_active = ntohl (pi->address_active);
   atsi = (const struct GNUNET_ATS_Information *) &pi[1];
   plugin_address = (const char *) &atsi[ats_count];
   plugin_name = &plugin_address[plugin_address_length];
@@ -365,17 +389,17 @@ process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
     GNUNET_break (0);
     return GNUNET_SYSERR;
   }
-  if (ph->infocb == NULL)
+
+  if (NULL != ph->addr_info_cb)
   {
-    return GNUNET_OK;
-  }
+         address.peer = pi->peer;
+         address.address = plugin_address;
+         address.address_length = plugin_address_length;
+         address.transport_name = plugin_name;
 
-  address.peer = pi->peer;
-  address.address = plugin_address;
-  address.address_length = plugin_address_length;
-  address.transport_name = plugin_name;
-  ph->infocb (ph->infocb_cls, &address, pi->bandwidth_out, pi->bandwidth_in,
+               ph->addr_info_cb (ph->addr_info_cb_cls, &address, addr_active, pi->bandwidth_out, pi->bandwidth_in,
               atsi, ats_count);
+  }
   return GNUNET_OK;
 }
 
@@ -493,7 +517,7 @@ process_ar_message (struct GNUNET_ATS_PerformanceHandle *ph,
   }
   if (NULL == alh)
   {
-      GNUNET_break (0);
+      /* was canceled */
       return GNUNET_SYSERR;
   }
 
@@ -507,8 +531,10 @@ process_ar_message (struct GNUNET_ATS_PerformanceHandle *ph,
       GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
           _("Received last message for %s \n"), "ATS_ADDRESSLIST_RESPONSE");
       bandwidth_zero.value__ = htonl (0);
-      alh->cb (ph->infocb_cls,
+      if (NULL != alh->cb)
+        alh->cb (ph->addr_info_cb_cls,
               NULL,
+              GNUNET_NO,
               bandwidth_zero, bandwidth_zero,
               NULL, 0);
       GNUNET_CONTAINER_DLL_remove (ph->addresslist_head, ph->addresslist_tail, alh);
@@ -523,8 +549,10 @@ process_ar_message (struct GNUNET_ATS_PerformanceHandle *ph,
 
   if ((GNUNET_YES == alh->all_addresses) || (GNUNET_YES == active))
   {
-    alh->cb (ph->infocb_cls,
+    if (NULL != alh->cb)
+      alh->cb (ph->addr_info_cb_cls,
             &address,
+            active,
             pi->bandwidth_out, pi->bandwidth_in,
             atsi, ats_count);
   }
@@ -595,8 +623,6 @@ reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
   GNUNET_assert (NULL == ph->client);
   ph->client = GNUNET_CLIENT_connect ("ats", ph->cfg);
   GNUNET_assert (NULL != ph->client);
-  GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
-                         GNUNET_TIME_UNIT_FOREVER_REL);
   if ((NULL == (p = ph->pending_head)) || (GNUNET_YES != p->is_init))
   {
     p = GNUNET_malloc (sizeof (struct PendingMessage) +
@@ -607,9 +633,8 @@ reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
     init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
     init->header.size = htons (sizeof (struct ClientStartMessage));
     init->start_flag =
-        htonl ((ph->infocb ==
-                NULL) ? START_FLAG_PERFORMANCE_NO_PIC :
-               START_FLAG_PERFORMANCE_WITH_PIC);
+        htonl ((NULL ==ph->addr_info_cb) ?
+                       START_FLAG_PERFORMANCE_NO_PIC : START_FLAG_PERFORMANCE_WITH_PIC);
     GNUNET_CONTAINER_DLL_insert (ph->pending_head, ph->pending_tail, p);
   }
   do_transmit (ph);
@@ -621,27 +646,27 @@ reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
  * Get handle to access performance API of the ATS subsystem.
  *
  * @param cfg configuration to use
- * @param infocb function to call on allocation changes, can be NULL
- * @param infocb_cls closure for infocb
+ * @param addr_info_cb callback called when performance characteristics for
+ *     an address change
+ * @param addr_info_cb_cls closure for infocb
  * @return ats performance context
  */
 struct GNUNET_ATS_PerformanceHandle *
 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                             GNUNET_ATS_PeerInformationCallback infocb,
-                             void *infocb_cls)
+                             GNUNET_ATS_AddressInformationCallback addr_info_cb,
+                             void *addr_info_cb_cls)
 {
   struct GNUNET_ATS_PerformanceHandle *ph;
 
   ph = GNUNET_malloc (sizeof (struct GNUNET_ATS_PerformanceHandle));
   ph->cfg = cfg;
-  ph->infocb = infocb;
-  ph->infocb_cls = infocb_cls;
+  ph->addr_info_cb = addr_info_cb;
+  ph->addr_info_cb_cls = addr_info_cb_cls;
   ph->id  = 0;
   reconnect (ph);
   return ph;
 }
 
-
 /**
  * Client is done using the ATS performance subsystem, release resources.
  *
@@ -672,6 +697,7 @@ GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
     GNUNET_break (NULL == rc->rcb);
     GNUNET_free (rc);
   }
+
   if (GNUNET_SCHEDULER_NO_TASK != ph->task)
   {
     GNUNET_SCHEDULER_cancel (ph->task);
@@ -762,7 +788,7 @@ struct GNUNET_ATS_AddressListHandle*
 GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *handle,
                                        const struct GNUNET_PeerIdentity *peer,
                                        int all,
-                                       GNUNET_ATS_PeerInformationCallback infocb,
+                                       GNUNET_ATS_AddressInformationCallback infocb,
                                        void *infocb_cls)
 {
   struct GNUNET_ATS_AddressListHandle *alh;
@@ -770,6 +796,8 @@ GNUNET_ATS_performance_list_addresses (struct GNUNET_ATS_PerformanceHandle *hand
   struct AddressListRequestMessage *m;
 
   GNUNET_assert (NULL != handle);
+  if (NULL == infocb)
+    return NULL;
 
   alh = GNUNET_malloc (sizeof (struct GNUNET_ATS_AddressListHandle));
   alh->id = handle->id;
@@ -825,6 +853,22 @@ GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandl
 }
 
 
+/**
+ * Convert a GNUNET_ATS_PreferenceType to a string
+ *
+ * @param type the preference type
+ * @return a string or NULL if invalid
+ */
+const char *
+GNUNET_ATS_print_preference_type (uint32_t type)
+{
+  char *prefs[GNUNET_ATS_PreferenceCount] = GNUNET_ATS_PreferenceTypeString;
+  if (type < GNUNET_ATS_PreferenceCount)
+    return prefs[type];
+  return NULL;
+}
+
+
 /**
  * Change preferences for the given peer. Preference changes are forgotten if peers
  * disconnect.
@@ -834,7 +878,7 @@ GNUNET_ATS_performance_list_addresses_cancel (struct GNUNET_ATS_AddressListHandl
  * @param ... 0-terminated specification of the desired changes
  */
 void
-GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
+GNUNET_ATS_performance_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
                               const struct GNUNET_PeerIdentity *peer, ...)
 {
   struct PendingMessage *p;
@@ -906,4 +950,88 @@ GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
   do_transmit (ph);
 }
 
+/**
+ * Send feedback to ATS on how good a the requirements for a peer and a
+ * preference is satisfied by ATS
+ *
+ * @param ph performance handle
+ * @param scope the time interval this valid for: [now - scope .. now]
+ * @param peer identifies the peer
+ * @param ... 0-terminated specification of the desired changes
+ */
+void
+GNUNET_ATS_performance_give_feedback (struct GNUNET_ATS_PerformanceHandle *ph,
+                                                                                                                                                       const struct GNUNET_PeerIdentity *peer,
+                                                                                                                                                       const struct GNUNET_TIME_Relative scope, ...)
+{
+  struct PendingMessage *p;
+  struct FeedbackPreferenceMessage *m;
+  size_t msize;
+  uint32_t count;
+  struct PreferenceInformation *pi;
+  va_list ap;
+  enum GNUNET_ATS_PreferenceKind kind;
+
+  count = 0;
+  va_start (ap, scope);
+  while (GNUNET_ATS_PREFERENCE_END !=
+         (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
+  {
+    switch (kind)
+    {
+    case GNUNET_ATS_PREFERENCE_BANDWIDTH:
+      count++;
+      (void) va_arg (ap, double);
+
+      break;
+    case GNUNET_ATS_PREFERENCE_LATENCY:
+      count++;
+      (void) va_arg (ap, double);
+
+      break;
+    default:
+      GNUNET_assert (0);
+    }
+  }
+  va_end (ap);
+  msize =
+      count * sizeof (struct PreferenceInformation) +
+      sizeof (struct FeedbackPreferenceMessage);
+  p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
+  p->size = msize;
+  p->is_init = GNUNET_NO;
+  m = (struct FeedbackPreferenceMessage *) &p[1];
+  m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_FEEDBACK);
+  m->header.size = htons (msize);
+  m->scope = GNUNET_TIME_relative_hton (scope);
+  m->num_feedback = htonl (count);
+  m->peer = *peer;
+  pi = (struct PreferenceInformation *) &m[1];
+  count = 0;
+  va_start (ap, scope);
+  while (GNUNET_ATS_PREFERENCE_END !=
+         (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
+  {
+    pi[count].preference_kind = htonl (kind);
+    switch (kind)
+    {
+    case GNUNET_ATS_PREFERENCE_BANDWIDTH:
+      pi[count].preference_value = (float) va_arg (ap, double);
+
+      count++;
+      break;
+    case GNUNET_ATS_PREFERENCE_LATENCY:
+      pi[count].preference_value = (float) va_arg (ap, double);
+
+      count++;
+      break;
+    default:
+      GNUNET_assert (0);
+    }
+  }
+  va_end (ap);
+  GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head, ph->pending_tail, p);
+  do_transmit (ph);
+}
+
 /* end of ats_api_performance.c */