document options provided
[oweals/gnunet.git] / src / ats / gnunet-service-ats_scheduling.c
index bf2c6187ab5dbc3fd2640a03dee6e2dcd530047d..8a0cf0a8e282f8553e9476c14cb8848abed63c67 100644 (file)
  * @file ats/gnunet-service-ats_scheduling.c
  * @brief ats service, interaction with 'scheduling' API
  * @author Matthias Wachs
+ * @author Christian Grothoff
  */
 #include "platform.h"
+#include "gnunet-service-ats.h"
+#include "gnunet-service-ats_addresses.h"
 #include "gnunet-service-ats_scheduling.h"
 #include "ats.h"
 
 
-struct SchedulingClient
-{
-  struct SchedulingClient * next;
-
-  struct SchedulingClient * prev;
-
-  struct GNUNET_SERVER_Client *client;
+/**
+ * Context for sending messages to clients.
+ */
+static struct GNUNET_SERVER_NotificationContext *nc;
 
-};
+/**
+ * Actual handle to the client.
+ */
+static struct GNUNET_SERVER_Client *my_client;
 
 
 /**
- * Head of linked list of all clients to this service.
+ * Handle to address subsystem
  */
-static struct SchedulingClient *sc_head;
+static struct GAS_Addresses_Handle *address_handle;
 
 /**
- * Tail of linked list of all clients to this service.
+ * Register a new scheduling client.
+ *
+ * @param client handle of the new client
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
-static struct SchedulingClient *sc_tail;
-
-
-static struct SchedulingClient * 
-find_client (struct GNUNET_SERVER_Client *client)
+int
+GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client)
 {
-  struct SchedulingClient * sc;
-
-  for (sc = sc_head; sc != NULL; sc = sc->next)
-    if (sc->client == client)
-      return sc;
-  return NULL;
+  if (my_client != NULL)
+  {
+    GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+                "This ATS already has a scheduling client, refusing new scheduling client for now.\n");
+    return GNUNET_SYSERR;
+  }
+  my_client = client;
+  GNUNET_SERVER_notification_context_add (nc, client);
+  return GNUNET_OK;
 }
 
 
+/**
+ * Unregister a client (which may have been a scheduling client,
+ * but this is not assured).
+ *
+ * @param client handle of the (now dead) client
+ */
 void
-GAS_add_scheduling_client (struct GNUNET_SERVER_Client *client)
+GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
 {
-  struct SchedulingClient *sc;
-
-  GNUNET_break (NULL == find_client (client));
-  sc = GNUNET_malloc (sizeof (struct SchedulingClient));
-  sc->client = client;
-  GNUNET_SERVER_client_keep (client);
-  GNUNET_CONTAINER_DLL_insert(sc_head, sc_tail, sc);
+  if (my_client != client)
+    return;
+  GAS_addresses_destroy_all (address_handle);
+  my_client = NULL;
 }
 
 
+/**
+ * Transmit the given address suggestion and bandwidth update to all scheduling
+ * 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 session_id session ID to use for the given client (other clients will see 0)
+ * @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_remove_scheduling_client (struct GNUNET_SERVER_Client *client)
+GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity
+                                            *peer, const char *plugin_name,
+                                            const void *plugin_addr,
+                                            size_t plugin_addr_len,
+                                            uint32_t session_id,
+                                            const struct GNUNET_ATS_Information
+                                            *atsi, uint32_t atsi_count,
+                                            struct GNUNET_BANDWIDTH_Value32NBO
+                                            bandwidth_out,
+                                            struct GNUNET_BANDWIDTH_Value32NBO
+                                            bandwidth_in)
 {
-  struct SchedulingClient * sc;
-
-  sc = find_client (client);
-  if (NULL == sc)
+  struct AddressSuggestionMessage *msg;
+  size_t plugin_name_length = strlen (plugin_name) + 1;
+  size_t msize =
+      sizeof (struct AddressSuggestionMessage) +
+      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;
+
+  if (my_client == NULL)
     return;
-  GNUNET_CONTAINER_DLL_remove (sc_head, sc_tail, sc);
-  GNUNET_SERVER_client_drop (client);
-  GNUNET_free (sc);
+  GNUNET_STATISTICS_update (GSA_stats, "# address suggestions made", 1,
+                            GNUNET_NO);
+  GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
+  GNUNET_assert (atsi_count <
+                 GNUNET_SERVER_MAX_MESSAGE_SIZE /
+                 sizeof (struct GNUNET_ATS_Information));
+  msg = (struct AddressSuggestionMessage *) buf;
+  msg->header.size = htons (msize);
+  msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
+  msg->ats_count = htonl (atsi_count);
+  msg->peer = *peer;
+  msg->address_length = htons (plugin_addr_len);
+  msg->plugin_name_length = htons (plugin_name_length);
+  msg->session_id = htonl (session_id);
+  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_log (GNUNET_ERROR_TYPE_DEBUG,
+              "ATS sends quota for peer `%s': (in/out) %u/%u\n",
+              GNUNET_i2s (peer), ntohl (bandwidth_in.value__),
+              ntohl (bandwidth_out.value__));
+
+  GNUNET_SERVER_notification_context_unicast (nc, my_client, &msg->header,
+                                              GNUNET_YES);
 }
 
 
+/**
+ * Handle 'request address' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
 void
 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
-                      const struct GNUNET_MessageHeader *message)
+                            const struct GNUNET_MessageHeader *message)
+{
+  const struct RequestAddressMessage *msg =
+      (const struct RequestAddressMessage *) message;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "REQUEST_ADDRESS");
+  GNUNET_break (0 == ntohl (msg->reserved));
+  GAS_addresses_request_address (address_handle, &msg->peer);
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+}
 
+
+/**
+ * Handle 'request address' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
+void
+GAS_handle_request_address_cancel (void *cls,
+                                   struct GNUNET_SERVER_Client *client,
+                                   const struct GNUNET_MessageHeader *message)
 {
-  // struct RequestAddressMessage * msg = (struct RequestAddressMessage *) message;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "REQUEST_ADDRESS");
+  const struct RequestAddressMessage *msg =
+      (const struct RequestAddressMessage *) message;
 
-}
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "REQUEST_ADDRESS_CANCEL");
+  GNUNET_break (0 == ntohl (msg->reserved));
 
+  GAS_addresses_request_address_cancel (address_handle, &msg->peer);
+
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+}
 
+/**
+ * Handle 'reset backoff' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
 void
-GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
-                      const struct GNUNET_MessageHeader *message)
+GAS_handle_reset_backoff (void *cls,
+                          struct GNUNET_SERVER_Client *client,
+                          const struct GNUNET_MessageHeader *message)
+{
+  const struct ResetBackoffMessage *msg =
+      (const struct ResetBackoffMessage *) message;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "RESET_BACKOFF");
+  GNUNET_break (0 == ntohl (msg->reserved));
+  GAS_addresses_handle_backoff_reset (address_handle, &msg->peer);
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+}
 
+/**
+ * Handle 'address add' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
+void
+GAS_handle_address_add (void *cls, struct GNUNET_SERVER_Client *client,
+                        const struct GNUNET_MessageHeader *message)
 {
-#if 0
-  struct AddressUpdateMessage * msg = (struct AddressUpdateMessage *) message;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "ADDRESS_UPDATE");
+  const struct AddressUpdateMessage *m;
+  const struct GNUNET_ATS_Information *atsi;
+  const char *address;
+  const char *plugin_name;
+  uint16_t address_length;
+  uint16_t plugin_name_length;
+  uint32_t ats_count;
+  uint16_t size;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "ADDRESS_ADD");
+  size = ntohs (message->size);
+  if (size < sizeof (struct AddressUpdateMessage))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  m = (const struct AddressUpdateMessage *) message;
+  ats_count = ntohl (m->ats_count);
+  address_length = ntohs (m->address_length);
+  plugin_name_length = ntohs (m->plugin_name_length);
+  atsi = (const struct GNUNET_ATS_Information *) &m[1];
+  address = (const char *) &atsi[ats_count];
+  if (plugin_name_length != 0)
+    plugin_name = &address[address_length];
+  else
+    plugin_name = "";
+
+  if ((address_length + plugin_name_length +
+       ats_count * sizeof (struct GNUNET_ATS_Information) +
+       sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
+      (ats_count >
+       GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
+       ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
+                            GNUNET_NO);
+  GAS_addresses_add (address_handle, &m->peer, plugin_name, address, address_length,
+                        ntohl (m->session_id), atsi, ats_count);
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+}
 
-  struct GNUNET_TRANSPORT_ATS_Information *am;
-  char *pm;
 
-  size_t size = ntohs (msg->header.size);
-  if ((size <= sizeof (struct AddressUpdateMessage)) || (size >= GNUNET_SERVER_MAX_MESSAGE_SIZE))
+/**
+ * Handle 'address update' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
+void
+GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
+                           const struct GNUNET_MessageHeader *message)
+{
+  const struct AddressUpdateMessage *m;
+  const struct GNUNET_ATS_Information *atsi;
+  const char *address;
+  const char *plugin_name;
+  uint16_t address_length;
+  uint16_t plugin_name_length;
+  uint32_t ats_count;
+  uint16_t size;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
+              "ADDRESS_UPDATE");
+  size = ntohs (message->size);
+  if (size < sizeof (struct AddressUpdateMessage))
   {
     GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
     return;
   }
+  m = (const struct AddressUpdateMessage *) message;
+  ats_count = ntohl (m->ats_count);
+  address_length = ntohs (m->address_length);
+  plugin_name_length = ntohs (m->plugin_name_length);
+  atsi = (const struct GNUNET_ATS_Information *) &m[1];
+  address = (const char *) &atsi[ats_count];
+  if (plugin_name_length != 0)
+    plugin_name = &address[address_length];
+  else
+    plugin_name = "";
+
+  if ((address_length + plugin_name_length +
+       ats_count * sizeof (struct GNUNET_ATS_Information) +
+       sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
+      (ats_count >
+       GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
+       ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
+                            GNUNET_NO);
+  GAS_addresses_update (address_handle, &m->peer, plugin_name, address, address_length,
+                        ntohl (m->session_id), atsi, ats_count);
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
+}
 
-  size_t ats_count = ntohs (msg->ats_count);
-  size_t addr_len = ntohs (msg->address_length);
-  size_t plugin_len = ntohs (msg->plugin_name_length) + 1 ;
 
-  if (
-       (plugin_len  >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
-       (addr_len  >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
-       (addr_len >= GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_TRANSPORT_ATS_Information)) )
+/**
+ * Handle 'address in use' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
+void
+GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
+                           const struct GNUNET_MessageHeader *message)
+{
+  const struct AddressUseMessage *m;
+  const char *address;
+  const char *plugin_name;
+  int res;
+  uint16_t address_length;
+  uint16_t plugin_name_length;
+
+  uint16_t size;
+  uint16_t in_use;
+
+  size = ntohs (message->size);
+  if (size < sizeof (struct AddressUseMessage))
   {
     GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
     return;
   }
+  m = (const struct AddressUseMessage *) message;
 
-  struct ATS_Address * aa = GNUNET_malloc (sizeof (struct ATS_Address) +
-                                           ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information) +
-                                           addr_len +
-                                           plugin_len);
+  address_length = ntohs (m->address_length);
+  plugin_name_length = ntohs (m->plugin_name_length);
 
+  address = (const char *) &m[1];
+  if (plugin_name_length != 0)
+    plugin_name = &address[address_length];
+  else
+    plugin_name = "";
 
+  if ((address_length + plugin_name_length +
+       sizeof (struct AddressUseMessage) != ntohs (message->size)) ||
+      ((plugin_name_length > 0) &&
+      (plugin_name[plugin_name_length - 1] != '\0')))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
 
-  memcpy (&aa->peer, &msg->peer, sizeof (struct GNUNET_PeerIdentity));
-  aa->addr_len = addr_len;
-  aa->ats_count = ats_count;
-  aa->ats = (struct GNUNET_TRANSPORT_ATS_Information *) &aa[1];
+  in_use = ntohs (m->in_use);
+  res = GAS_addresses_in_use (address_handle,
+                              &m->peer,
+                              plugin_name,
+                              address,
+                              address_length,
+                              ntohl (m->session_id),
+                              in_use);
+
+  if (res == GNUNET_OK)
+    GNUNET_SERVER_receive_done (client, GNUNET_OK);
+  else
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+  }
 
-  am = (struct GNUNET_TRANSPORT_ATS_Information*) &msg[1];
-  memcpy (&aa->ats, am, ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
-  pm = (char *) &am[ats_count];
-  memcpy (aa->addr, pm, addr_len);
-  memcpy (aa->plugin, &pm[plugin_len], plugin_len);
-  aa->session_id = ntohl(msg->session_id);
+}
 
-  GNUNET_assert (GNUNET_OK == GNUNET_CONTAINER_multihashmap_put(addresses, &aa->peer.hashPubKey, aa, GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
-#endif
+/**
+ * Handle 'address destroyed' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
+void
+GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
+                              const struct GNUNET_MessageHeader *message)
+{
+  const struct AddressDestroyedMessage *m;
+  struct SessionReleaseMessage srm;
+  const char *address;
+  const char *plugin_name;
+  uint16_t address_length;
+  uint16_t plugin_name_length;
+  uint16_t size;
+
+  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message of size %u %u\n",
+              "ADDRESS_DESTROYED", ntohs (message->size),
+              sizeof (struct AddressDestroyedMessage));
+  size = ntohs (message->size);
+  if ((size < sizeof (struct AddressDestroyedMessage)) || (client != my_client))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  m = (const struct AddressDestroyedMessage *) message;
+  GNUNET_break (0 == ntohl (m->reserved));
+  address_length = ntohs (m->address_length);
+  plugin_name_length = ntohs (m->plugin_name_length);
+  address = (const char *) &m[1];
+  if (plugin_name_length != 0)
+    plugin_name = &address[address_length];
+  else
+    plugin_name = "";
+  if ((address_length + plugin_name_length +
+       sizeof (struct AddressDestroyedMessage) != ntohs (message->size)))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  if ((plugin_name_length == 0) ||
+      (plugin_name[plugin_name_length - 1] != '\0'))
+  {
+    GNUNET_break (0);
+    GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
+    return;
+  }
+  GNUNET_STATISTICS_update (GSA_stats, "# addresses destroyed", 1, GNUNET_NO);
+  GAS_addresses_destroy (address_handle, &m->peer, plugin_name,
+                         address, address_length,
+                         ntohl (m->session_id));
+  if (0 != ntohl (m->session_id))
+  {
+    srm.header.type = ntohs (GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE);
+    srm.header.size = ntohs (sizeof (struct SessionReleaseMessage));
+    srm.session_id = m->session_id;
+    srm.peer = m->peer;
+    GNUNET_SERVER_notification_context_unicast (nc, client, &srm.header,
+                                                GNUNET_NO);
+  }
+  GNUNET_SERVER_receive_done (client, GNUNET_OK);
 }
 
 
+/**
+ * Initialize scheduling subsystem.
+ *
+ * @param server handle to our server
+ * @param ah the address handle to use
+ */
 void
-GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
-                      const struct GNUNET_MessageHeader *message)
+GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *ah)
+{
+  GNUNET_assert (NULL != ah);
+  address_handle = ah;
+  nc = GNUNET_SERVER_notification_context_create (server, 128);
+}
 
+
+/**
+ * Shutdown scheduling subsystem.
+ */
+void
+GAS_scheduling_done ()
 {
-#if 0
-  // struct AddressDestroyedMessage * msg = (struct AddressDestroyedMessage *) message;
-  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n", "ADDRESS_DESTROYED");
-/*
-  struct GNUNET_PeerIdentity *peer = &msg->peer;
-  struct ATS_Address * aa = find_address_by_addr (peer);
-  GNUNET_CONTAINER_multihashmap_remove(addresses, peer, aa);
-  GNUNET_free (aa);*/
-#endif
+  if (NULL != my_client)
+  {
+    my_client = NULL;
+  }
+  GNUNET_SERVER_notification_context_destroy (nc);
+  nc = NULL;
+
 }
 
+
 /* end of gnunet-service-ats_scheduling.c */