src/ats/gnunet-service-ats_performance.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file ats/gnunet-service-ats_performance.c
  23  * @brief ats service, interaction with 'performance' API
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #include "platform.h"
  28 #include "gnunet-service-ats.h"
  29 #include "gnunet-service-ats_addresses.h"
  30 #include "gnunet-service-ats_performance.h"
  31 #include "gnunet-service-ats_reservations.h"
  32 #include "ats.h"
  33
  34
  35 /**
  36  * We keep clients that are interested in performance in a linked list.
  37  */
  38 struct PerformanceClient
  39 {
  40   /**
  41    * Next in doubly-linked list.
  42    */
  43   struct PerformanceClient *next;
  44
  45   /**
  46    * Previous in doubly-linked list.
  47    */
  48   struct PerformanceClient *prev;
  49
  50   /**
  51    * Actual handle to the client.
  52    */
  53   struct GNUNET_SERVER_Client *client;
  54
  55   /**
  56    * Options for the client.
  57    */
  58   enum StartFlag flag;
  59
  60 };
  61
  62
  63 /**
  64  * Head of linked list of all clients to this service.
  65  */
  66 static struct PerformanceClient *pc_head;
  67
  68 /**
  69  * Tail of linked list of all clients to this service.
  70  */
  71 static struct PerformanceClient *pc_tail;
  72
  73 /**
  74  * Context for sending messages to performance clients.
  75  */
  76 static struct GNUNET_SERVER_NotificationContext *nc;
  77
  78
  79 /**
  80  * Find the performance client associated with the given handle.
  81  *
  82  * @param client server handle
  83  * @return internal handle
  84  */
  85 static struct PerformanceClient *
  86 find_client (struct GNUNET_SERVER_Client *client)
  87 {
  88   struct PerformanceClient *pc;
  89
  90   for (pc = pc_head; pc != NULL; pc = pc->next)
  91     if (pc->client == client)
  92       return pc;
  93   return NULL;
  94 }
  95
  96
  97 /**
  98  * Register a new performance client.
  99  *
 100  * @param client handle of the new client
 101  * @param flag flag specifying the type of the client
 102  */
 103 void
 104 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
 105                             enum StartFlag flag)
 106 {
 107   struct PerformanceClient *pc;
 108
 109   GNUNET_break (NULL == find_client (client));
 110   pc = GNUNET_malloc (sizeof (struct PerformanceClient));
 111   pc->client = client;
 112   pc->flag = flag;
 113   GNUNET_SERVER_notification_context_add (nc, client);
 114   GNUNET_SERVER_client_keep (client);
 115   GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
 116 }
 117
 118
 119 /**
 120  * Unregister a client (which may have been a performance client,
 121  * but this is not assured).
 122  *
 123  * @param client handle of the (now dead) client
 124  */
 125 void
 126 GAS_performance_remove_client (struct GNUNET_SERVER_Client *client)
 127 {
 128   struct PerformanceClient *pc;
 129
 130   pc = find_client (client);
 131   if (NULL == pc)
 132     return;
 133   GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
 134   GNUNET_SERVER_client_drop (client);
 135   GNUNET_free (pc);
 136 }
 137
 138
 139 /**
 140  * Transmit the given performance information to all performance
 141  * clients.
 142  *
 143  * @param peer peer for which this is an address suggestion
 144  * @param plugin_name 0-termintated string specifying the transport plugin
 145  * @param plugin_addr binary address for the plugin to use
 146  * @param plugin_addr_len number of bytes in plugin_addr
 147  * @param atsi performance data for the address
 148  * @param atsi_count number of performance records in 'ats'
 149  * @param bandwidth_out assigned outbound bandwidth
 150  * @param bandwidth_in assigned inbound bandwidth
 151  */
 152 void
 153 GAS_performance_notify_clients (const struct GNUNET_PeerIdentity *peer,
 154                                 const char *plugin_name,
 155                                 const void *plugin_addr, size_t plugin_addr_len,
 156                                 const struct GNUNET_ATS_Information *atsi,
 157                                 uint32_t atsi_count,
 158                                 struct GNUNET_BANDWIDTH_Value32NBO
 159                                 bandwidth_out,
 160                                 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 161 {
 162   struct PerformanceClient *pc;
 163   struct PeerInformationMessage *msg;
 164   size_t plugin_name_length = strlen (plugin_name) + 1;
 165   size_t msize =
 166       sizeof (struct PeerInformationMessage) +
 167       atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
 168       plugin_name_length;
 169   char buf[msize];
 170   struct GNUNET_ATS_Information *atsp;
 171   char *addrp;
 172
 173   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 174   GNUNET_assert (atsi_count <
 175                  GNUNET_SERVER_MAX_MESSAGE_SIZE /
 176                  sizeof (struct GNUNET_ATS_Information));
 177   msg = (struct PeerInformationMessage *) buf;
 178   msg->header.size = htons (msize);
 179   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
 180   msg->ats_count = htonl (atsi_count);
 181   msg->peer = *peer;
 182   msg->address_length = htons (plugin_addr_len);
 183   msg->plugin_name_length = htons (plugin_name_length);
 184   msg->bandwidth_out = bandwidth_out;
 185   msg->bandwidth_in = bandwidth_in;
 186   atsp = (struct GNUNET_ATS_Information *) &msg[1];
 187   memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
 188   addrp = (char *) &atsp[atsi_count];
 189   memcpy (addrp, plugin_addr, plugin_addr_len);
 190   strcpy (&addrp[plugin_addr_len], plugin_name);
 191   for (pc = pc_head; pc != NULL; pc = pc->next)
 192     if (pc->flag == START_FLAG_PERFORMANCE_WITH_PIC)
 193     {
 194       GNUNET_SERVER_notification_context_unicast (nc, pc->client, &msg->header,
 195                                                   GNUNET_YES);
 196       GNUNET_STATISTICS_update (GSA_stats,
 197                                 "# performance updates given to clients", 1,
 198                                 GNUNET_NO);
 199     }
 200 }
 201
 202
 203 /**
 204  * Handle 'reservation request' messages from clients.
 205  *
 206  * @param cls unused, NULL
 207  * @param client client that sent the request
 208  * @param message the request message
 209  */
 210 void
 211 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
 212                                 const struct GNUNET_MessageHeader *message)
 213 {
 214   const struct ReservationRequestMessage *msg =
 215       (const struct ReservationRequestMessage *) message;
 216   struct ReservationResultMessage result;
 217   int32_t amount;
 218   struct GNUNET_TIME_Relative res_delay;
 219
 220   if (NULL == find_client (client))
 221   {
 222     /* missing start message! */
 223     GNUNET_break (0);
 224     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 225     return;
 226   }
 227   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 228               "RESERVATION_REQUEST");
 229   amount = (int32_t) ntohl (msg->amount);
 230   res_delay = GAS_reservations_reserve (&msg->peer, amount);
 231   if (res_delay.rel_value > 0)
 232     amount = 0;
 233   result.header.size = htons (sizeof (struct ReservationResultMessage));
 234   result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
 235   result.amount = htonl (amount);
 236   result.peer = msg->peer;
 237   result.res_delay = GNUNET_TIME_relative_hton (res_delay);
 238   GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
 239                             GNUNET_NO);
 240   GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
 241                                               GNUNET_NO);
 242   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 243 }
 244
 245
 246 /**
 247  * Handle 'preference change' messages from clients.
 248  *
 249  * @param cls unused, NULL
 250  * @param client client that sent the request
 251  * @param message the request message
 252  */
 253 void
 254 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
 255                               const struct GNUNET_MessageHeader *message)
 256 {
 257   const struct ChangePreferenceMessage *msg;
 258   const struct PreferenceInformation *pi;
 259   uint16_t msize;
 260   uint32_t nump;
 261   uint32_t i;
 262
 263   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 264               "PREFERENCE_CHANGE");
 265   msize = ntohs (message->size);
 266   if (msize < sizeof (struct ChangePreferenceMessage))
 267   {
 268     GNUNET_break (0);
 269     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 270     return;
 271   }
 272   msg = (const struct ChangePreferenceMessage *) message;
 273   nump = ntohl (msg->num_preferences);
 274   if (msize !=
 275       sizeof (struct ChangePreferenceMessage) +
 276       nump * sizeof (struct PreferenceInformation))
 277   {
 278     GNUNET_break (0);
 279     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 280     return;
 281   }
 282   GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
 283                             1, GNUNET_NO);
 284   pi = (const struct PreferenceInformation *) &msg[1];
 285   for (i = 0; i < nump; i++)
 286     GAS_addresses_change_preference (&msg->peer,
 287                                      (enum GNUNET_ATS_PreferenceKind)
 288                                      ntohl (pi[i].preference_kind),
 289                                      pi[i].preference_value);
 290   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 291 }
 292
 293
 294 /**
 295  * Initialize performance subsystem.
 296  *
 297  * @param server handle to our server
 298  */
 299 void
 300 GAS_performance_init (struct GNUNET_SERVER_Handle *server)
 301 {
 302   nc = GNUNET_SERVER_notification_context_create (server, 128);
 303 }
 304
 305
 306 /**
 307  * Shutdown performance subsystem.
 308  */
 309 void
 310 GAS_performance_done ()
 311 {
 312   GNUNET_SERVER_notification_context_destroy (nc);
 313   nc = NULL;
 314 }
 315
 316 /* end of gnunet-service-ats_performance.c */