fix uninitialized mem
[oweals/gnunet.git] / src / ats / gnunet-service-ats_performance.c
index a0062ab7ad44b2b05e07883ecedc4096c241fb44..3249ed42ad4cc37e991813315d84127ff9064273 100644 (file)
  * @author Christian Grothoff
  */
 #include "platform.h"
+#include "gnunet-service-ats.h"
+#include "gnunet-service-ats_addresses.h"
 #include "gnunet-service-ats_performance.h"
+#include "gnunet-service-ats_reservations.h"
 #include "ats.h"
 
 
+/**
+ * We keep clients that are interested in performance in a linked list.
+ */
 struct PerformanceClient
 {
-  struct PerformanceClient * next;
+  /**
+   * Next in doubly-linked list.
+   */
+  struct PerformanceClient *next;
 
-  struct PerformanceClient * prev;
+  /**
+   * Previous in doubly-linked list.
+   */
+  struct PerformanceClient *prev;
 
+  /**
+   * Actual handle to the client.
+   */
   struct GNUNET_SERVER_Client *client;
 
+  /**
+   * Options for the client.
+   */
+  enum StartFlag flag;
+
+};
+
+
+/**
+ * We keep clients that are interested in performance in a linked list.
+ */
+struct AddressIteration
+{
+  /**
+   * Actual handle to the client.
+   */
+  struct PerformanceClient *pc;
+
+  int all;
+
+  uint32_t id;
+
+  unsigned int msg_type;
 };
 
 
@@ -49,12 +87,23 @@ static struct PerformanceClient *pc_head;
  * Tail of linked list of all clients to this service.
  */
 static struct PerformanceClient *pc_tail;
 
-static struct PerformanceClient * 
+/**
+ * Context for sending messages to performance clients.
+ */
+static struct GNUNET_SERVER_NotificationContext *nc;
+
+
+/**
+ * Find the performance client associated with the given handle.
+ *
+ * @param client server handle
+ * @return internal handle
+ */
+static struct PerformanceClient *
 find_client (struct GNUNET_SERVER_Client *client)
 {
-  struct PerformanceClient * pc;
+  struct PerformanceClient *pc;
 
   for (pc = pc_head; pc != NULL; pc = pc->next)
     if (pc->client == client)
@@ -62,51 +111,505 @@ find_client (struct GNUNET_SERVER_Client *client)
   return NULL;
 }
 
+/**
+ * Unregister a client (which may have been a performance client,
+ * but this is not assured).
+ *
+ * @param client handle of the (now dead) client
+ */
+void
+GAS_performance_remove_client (struct GNUNET_SERVER_Client *client)
+{
+  struct PerformanceClient *pc;
+  pc = find_client (client);
+  if (NULL == pc)
+    return;
+  GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
+  GNUNET_SERVER_client_drop (client);
+  GNUNET_free (pc);
+}
 
+/**
+ * Transmit the given performance information to all performance
+ * clients.
+ *
+ * @param pc performance client to send to
+ * @param peer peer for which this is an address suggestion
+ * @param plugin_name 0-termintated string specifying the transport plugin
+ * @param plugin_addr binary address for the plugin to use
+ * @param plugin_addr_len number of bytes in plugin_addr
+ * @param active is this address active
+ * @param atsi performance data for the address
+ * @param atsi_count number of performance records in 'ats'
+ * @param bandwidth_out assigned outbound bandwidth
+ * @param bandwidth_in assigned inbound bandwidth
+ */
 void
-GAS_performance_add_client (struct GNUNET_SERVER_Client *client)
+GAS_performance_notify_client (struct PerformanceClient *pc,
+                               const struct GNUNET_PeerIdentity *peer,
+                               const char *plugin_name,
+                               const void *plugin_addr, size_t plugin_addr_len,
+                               const int active,
+                               const struct GNUNET_ATS_Information *atsi,
+                               uint32_t atsi_count,
+                               struct GNUNET_BANDWIDTH_Value32NBO
+                               bandwidth_out,
+                               struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 {
-  struct PerformanceClient * pc;
 
+  struct PeerInformationMessage *msg;
+  size_t plugin_name_length = strlen (plugin_name) + 1;
+  size_t msize =
+      sizeof (struct PeerInformationMessage) +
+      atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
+      plugin_name_length;
+  char buf[msize] GNUNET_ALIGN;
+  struct GNUNET_ATS_Information *atsp;
+  char *addrp;
+
+  GNUNET_assert (NULL != pc);
+  if (NULL == find_client (pc->client))
+    return; /* Client disconnected */
+
+  GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
+  GNUNET_assert (atsi_count <
+                 GNUNET_SERVER_MAX_MESSAGE_SIZE /
+                 sizeof (struct GNUNET_ATS_Information));
+  msg = (struct PeerInformationMessage *) buf;
+  msg->header.size = htons (msize);
+  msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
+  msg->id = htonl (0);
+  msg->ats_count = htonl (atsi_count);
+  msg->peer = *peer;
+  msg->address_length = htons (plugin_addr_len);
+  msg->address_active = ntohl (active);
+  msg->plugin_name_length = htons (plugin_name_length);
+  msg->bandwidth_out = bandwidth_out;
+  msg->bandwidth_in = bandwidth_in;
+  atsp = (struct GNUNET_ATS_Information *) &msg[1];
+  memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
+  addrp = (char *) &atsp[atsi_count];
+  memcpy (addrp, plugin_addr, plugin_addr_len);
+  strcpy (&addrp[plugin_addr_len], plugin_name);
+  GNUNET_SERVER_notification_context_unicast (nc, pc->client, &msg->header,
+                                              GNUNET_YES);
+}
+
+
+/**
+ * Transmit the given performance information to all performance
+ * clients.
+ *
+ * @param peer peer for which this is an address suggestion
+ * @param plugin_name 0-termintated string specifying the transport plugin
+ * @param plugin_addr binary address for the plugin to use
+ * @param plugin_addr_len number of bytes in plugin_addr
+ * @param active is this address active
+ * @param atsi performance data for the address
+ * @param atsi_count number of performance records in 'ats'
+ * @param bandwidth_out assigned outbound bandwidth
+ * @param bandwidth_in assigned inbound bandwidth
+ */
+void
+GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
+                                const char *plugin_name,
+                                const void *plugin_addr, size_t plugin_addr_len,
+                                const int active,
+                                const struct GNUNET_ATS_Information *atsi,
+                                uint32_t atsi_count,
+                                struct GNUNET_BANDWIDTH_Value32NBO
+                                bandwidth_out,
+                                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
+{
+  struct PerformanceClient *pc;
+
+  for (pc = pc_head; pc != NULL; pc = pc->next)
+    if (pc->flag == START_FLAG_PERFORMANCE_WITH_PIC)
+    {
+        GAS_performance_notify_client (pc,
+                                       peer,
+                                       plugin_name, plugin_addr, plugin_addr_len,
+                                       active,
+                                       atsi, atsi_count,
+                                       bandwidth_out, bandwidth_in);
+    }
+  GNUNET_STATISTICS_update (GSA_stats,
+                            "# performance updates given to clients", 1,
+                            GNUNET_NO);
+}
+
+
+static void
+peerinfo_it (void *cls,
+             const struct GNUNET_PeerIdentity *id,
+             const char *plugin_name,
+             const void *plugin_addr, size_t plugin_addr_len,
+             const int active,
+             const struct GNUNET_ATS_Information *atsi,
+             uint32_t atsi_count,
+             struct GNUNET_BANDWIDTH_Value32NBO
+             bandwidth_out,
+             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
+{
+  struct PerformanceClient *pc = cls;
+  GNUNET_assert (NULL != pc);
+  if (NULL == id)
+    return;
+
+  if (GNUNET_NO == active)
+    return;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Callback for peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
+              GNUNET_i2s (id),
+              plugin_name,
+              ntohl (bandwidth_out.value__),
+              ntohl (bandwidth_in.value__));
+  GAS_performance_notify_client(pc,
+                                id,
+                                plugin_name, plugin_addr, plugin_addr_len,
+                                active,
+                                atsi, atsi_count,
+                                bandwidth_out, bandwidth_in);
+}
+
+
+/**
+ * Iterator for GAS_performance_add_client
+ *
+ * @param cls the client requesting information
+ * @param id result
+ */
+static void
+peer_it (void *cls,
+         const struct GNUNET_PeerIdentity *id)
+{
+  struct PerformanceClient *pc = cls;
+  if (NULL != id)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
+    GAS_addresses_get_peer_info (id, &peerinfo_it, pc);
+  }
+}
+
+/**
+ * Register a new performance client.
+ *
+ * @param client handle of the new client
+ * @param flag flag specifying the type of the client
+ */
+void
+GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
+                            enum StartFlag flag)
+{
+  struct PerformanceClient *pc;
   GNUNET_break (NULL == find_client (client));
+
   pc = GNUNET_malloc (sizeof (struct PerformanceClient));
   pc->client = client;
-  GNUNET_CONTAINER_DLL_insert(pc_head, pc_tail, pc);
+  pc->flag = flag;
+  GNUNET_SERVER_notification_context_add (nc, client);
+  GNUNET_SERVER_client_keep (client);
+  GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
+
+  /* Send information about clients */
+  GAS_addresses_iterate_peers (&peer_it, pc);
+}
+
+static void transmit_req_addr (struct AddressIteration *ai,
+    const struct GNUNET_PeerIdentity *id,
+    const char *plugin_name,
+    const void *plugin_addr, size_t plugin_addr_len,
+    const int active,
+    const struct GNUNET_ATS_Information *atsi,
+    uint32_t atsi_count,
+    struct GNUNET_BANDWIDTH_Value32NBO
+    bandwidth_out,
+    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
+
+{
+
+  struct GNUNET_ATS_Information *atsp;
+  struct PeerInformationMessage *msg;
+  char *addrp;
+  size_t plugin_name_length;
+  size_t msize;
+
+  if (NULL != plugin_name)
+    plugin_name_length = strlen (plugin_name) + 1;
+  else
+    plugin_name_length = 0;
+  msize = sizeof (struct PeerInformationMessage) +
+          atsi_count * sizeof (struct GNUNET_ATS_Information) +
+          plugin_addr_len + plugin_name_length;
+  char buf[msize] GNUNET_ALIGN;
+
+  GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
+  GNUNET_assert (atsi_count <
+                 GNUNET_SERVER_MAX_MESSAGE_SIZE /
+                 sizeof (struct GNUNET_ATS_Information));
+  msg = (struct PeerInformationMessage *) buf;
+  msg->header.size = htons (msize);
+  msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESSLIST_RESPONSE);
+  msg->ats_count = htonl (atsi_count);
+  msg->id = htonl (ai->id);
+  if (NULL != id)
+    msg->peer = *id;
+  else
+    memset (&msg->peer, '\0', sizeof (struct GNUNET_PeerIdentity));
+  msg->address_length = htons (plugin_addr_len);
+  msg->address_active = ntohl (active);
+  msg->plugin_name_length = htons (plugin_name_length);
+  msg->bandwidth_out = bandwidth_out;
+  msg->bandwidth_in = bandwidth_in;
+  atsp = (struct GNUNET_ATS_Information *) &msg[1];
+  memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
+  addrp = (char *) &atsp[atsi_count];
+  if (NULL != plugin_addr)
+    memcpy (addrp, plugin_addr, plugin_addr_len);
+  if (NULL != plugin_name)
+    strcpy (&addrp[plugin_addr_len], plugin_name);
+  GNUNET_SERVER_notification_context_unicast (nc, ai->pc->client, &msg->header,
+                                              GNUNET_NO);
+}
+
+static void
+req_addr_peerinfo_it (void *cls,
+             const struct GNUNET_PeerIdentity *id,
+             const char *plugin_name,
+             const void *plugin_addr, size_t plugin_addr_len,
+             const int active,
+             const struct GNUNET_ATS_Information *atsi,
+             uint32_t atsi_count,
+             struct GNUNET_BANDWIDTH_Value32NBO
+             bandwidth_out,
+             struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
+{
+  struct AddressIteration *ai = cls;
+
+  GNUNET_assert (NULL != ai);
+  GNUNET_assert (NULL != ai->pc);
+  if (NULL == find_client (ai->pc->client))
+    return; /* Client disconnected */
+
+  if ((NULL == id) && (NULL == id) && (NULL == id))
+  {
+      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                  "Address iteration done\n");
+      return;
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+              "Callback for  %s peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
+              (active == GNUNET_YES) ? "ACTIVE" : "INACTIVE",
+              GNUNET_i2s (id),
+              plugin_name,
+              ntohl (bandwidth_out.value__),
+              ntohl (bandwidth_in.value__));
+
+  /* Transmit result */
+  if ((GNUNET_YES == ai->all) || (GNUNET_YES == active))
+  {
+      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                  "Sending result for  %s peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
+                  (active == GNUNET_YES) ? "ACTIVE" : "INACTIVE",
+                  GNUNET_i2s (id),
+                  plugin_name,
+                  ntohl (bandwidth_out.value__),
+                  ntohl (bandwidth_in.value__));
+    transmit_req_addr (cls,
+        id,
+        plugin_name,
+        plugin_addr, plugin_addr_len,
+        active,
+        atsi,
+        atsi_count,
+        bandwidth_out, bandwidth_in);
+  }
 }
 
 
+/**
+ * Iterator for GAS_handle_request_address_list
+ *
+ * @param cls the client requesting information
+ * @param id result
+ */
+static void
+req_addr_peer_it (void *cls,
+         const struct GNUNET_PeerIdentity *id)
+{
+  struct AddressIteration *ai = cls;
+  if (NULL != id)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
+    GAS_addresses_get_peer_info (id, &req_addr_peerinfo_it, ai);
+  }
+  else
+  {
+      GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Peer iteration done\n");
+  }
+}
+
+/**
+ * Handle 'address list request' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
 void
-GAS_performance_remove_client (struct GNUNET_SERVER_Client *client)
+GAS_handle_request_address_list (void *cls, struct GNUNET_SERVER_Client *client,
+                                 const struct GNUNET_MessageHeader *message)
 {
-  struct PerformanceClient * pc;
+  struct PerformanceClient *pc;
+  struct AddressIteration ai;
+  struct AddressListRequestMessage * alrm = (struct AddressListRequestMessage *) message;
+  struct GNUNET_PeerIdentity allzeros;
+  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_zero;
 
-  pc = find_client (client);
-  if (NULL == pc)
-    return;
-  GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
-  GNUNET_SERVER_client_drop (client);
-  GNUNET_free (pc);
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "ADDRESSLIST_REQUEST");
+
+  if (NULL == (pc = find_client(client)))
+  {
+      GNUNET_break (0);
+      return;
+  }
+
+  ai.all = ntohl (alrm->all);
+  ai.id = ntohl (alrm->id);
+  ai.pc = pc;
+
+  memset (&allzeros, '\0', sizeof (struct GNUNET_PeerIdentity));
+  bandwidth_zero.value__ = htonl (0);
+  if (0 == memcmp (&alrm->peer, &allzeros, sizeof (struct GNUNET_PeerIdentity)))
+  {
+      /* Return addresses for all peers */
+      GAS_addresses_iterate_peers (&req_addr_peer_it, &ai);
+      transmit_req_addr (&ai, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, bandwidth_zero, bandwidth_zero);
+  }
+  else
+  {
+      /* Return addresses for a specific peer */
+      GAS_addresses_get_peer_info (&alrm->peer, &req_addr_peerinfo_it, &ai);
+      transmit_req_addr (&ai, NULL, NULL, NULL, 0, GNUNET_NO, NULL, 0, bandwidth_zero, bandwidth_zero);
+  }
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
 
+
+/**
+ * Handle 'reservation request' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
 void
 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
-                      const struct GNUNET_MessageHeader *message)
-
+                                const struct GNUNET_MessageHeader *message)
 {
-  // struct AddressUpdateMessage * msg = (struct AddressUpdateMessage *) message;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "RESERVATION_REQUEST");
+  const struct ReservationRequestMessage *msg =
+      (const struct ReservationRequestMessage *) message;
+  struct ReservationResultMessage result;
+  int32_t amount;
+  struct GNUNET_TIME_Relative res_delay;
+
+  if (NULL == find_client (client))
+  {
+    /* missing start message! */
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "RESERVATION_REQUEST");
+  amount = (int32_t) ntohl (msg->amount);
+  res_delay = GAS_reservations_reserve (&msg->peer, amount);
+  if (res_delay.rel_value > 0)
+    amount = 0;
+  result.header.size = htons (sizeof (struct ReservationResultMessage));
+  result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
+  result.amount = htonl (amount);
+  result.peer = msg->peer;
+  result.res_delay = GNUNET_TIME_relative_hton (res_delay);
+  GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
+                            GNUNET_NO);
+  GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
+                                              GNUNET_NO);
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
 
+/**
+ * Handle 'preference change' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
 void
 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
-                      const struct GNUNET_MessageHeader *message)
+                              const struct GNUNET_MessageHeader *message)
+{
+  const struct ChangePreferenceMessage *msg;
+  const struct PreferenceInformation *pi;
+  uint16_t msize;
+  uint32_t nump;
+  uint32_t i;
 
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "PREFERENCE_CHANGE");
+  msize = ntohs (message->size);
+  if (msize < sizeof (struct ChangePreferenceMessage))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  msg = (const struct ChangePreferenceMessage *) message;
+  nump = ntohl (msg->num_preferences);
+  if (msize !=
+      sizeof (struct ChangePreferenceMessage) +
+      nump * sizeof (struct PreferenceInformation))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
+                            1, GNUNET_NO);
+  pi = (const struct PreferenceInformation *) &msg[1];
+  for (i = 0; i < nump; i++)
+    GAS_addresses_change_preference (&msg->peer,
+                                     (enum GNUNET_ATS_PreferenceKind)
+                                     ntohl (pi[i].preference_kind),
+                                     pi[i].preference_value);
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+}
+
+
+/**
+ * Initialize performance subsystem.
+ *
+ * @param server handle to our server
+ */
+void
+GAS_performance_init (struct GNUNET_SERVER_Handle *server)
 {
-  // struct ChangePreferenceMessage * msg = (struct ChangePreferenceMessage *) message;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "PREFERENCE_CHANGE");
+  nc = GNUNET_SERVER_notification_context_create (server, 128);
 }
 
 
+/**
+ * Shutdown performance subsystem.
+ */
+void
+GAS_performance_done ()
+{
+  GNUNET_SERVER_notification_context_destroy (nc);
+  nc = NULL;
+}
+
 /* end of gnunet-service-ats_performance.c */