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  * Unregister a client (which may have been a performance client,
  98  * but this is not assured).
  99  *
 100  * @param client handle of the (now dead) client
 101  */
 102 void
 103 GAS_performance_remove_client (struct GNUNET_SERVER_Client *client)
 104 {
 105   struct PerformanceClient *pc;
 106   pc = find_client (client);
 107   if (NULL == pc)
 108     return;
 109   GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
 110   GNUNET_SERVER_client_drop (client);
 111   GNUNET_free (pc);
 112 }
 113
 114 /**
 115  * Transmit the given performance information to all performance
 116  * clients.
 117  *
 118  * @param pc performance client to send to
 119  * @param peer peer for which this is an address suggestion
 120  * @param plugin_name 0-termintated string specifying the transport plugin
 121  * @param plugin_addr binary address for the plugin to use
 122  * @param plugin_addr_len number of bytes in plugin_addr
 123  * @param atsi performance data for the address
 124  * @param atsi_count number of performance records in 'ats'
 125  * @param bandwidth_out assigned outbound bandwidth
 126  * @param bandwidth_in assigned inbound bandwidth
 127  */
 128 void
 129 GAS_performance_notify_client (struct PerformanceClient *pc,
 130                                const struct GNUNET_PeerIdentity *peer,
 131                                const char *plugin_name,
 132                                const void *plugin_addr, size_t plugin_addr_len,
 133                                const struct GNUNET_ATS_Information *atsi,
 134                                uint32_t atsi_count,
 135                                struct GNUNET_BANDWIDTH_Value32NBO
 136                                bandwidth_out,
 137                                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 138 {
 139
 140   struct PeerInformationMessage *msg;
 141   size_t plugin_name_length = strlen (plugin_name) + 1;
 142   size_t msize =
 143       sizeof (struct PeerInformationMessage) +
 144       atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
 145       plugin_name_length;
 146   char buf[msize] GNUNET_ALIGN;
 147   struct GNUNET_ATS_Information *atsp;
 148   char *addrp;
 149
 150   GNUNET_assert (NULL != pc);
 151   if (NULL == find_client (pc->client))
 152     return; /* Client disconnected */
 153
 154   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 155   GNUNET_assert (atsi_count <
 156                  GNUNET_SERVER_MAX_MESSAGE_SIZE /
 157                  sizeof (struct GNUNET_ATS_Information));
 158   msg = (struct PeerInformationMessage *) buf;
 159   msg->header.size = htons (msize);
 160   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
 161   msg->ats_count = htonl (atsi_count);
 162   msg->peer = *peer;
 163   msg->address_length = htons (plugin_addr_len);
 164   msg->plugin_name_length = htons (plugin_name_length);
 165   msg->bandwidth_out = bandwidth_out;
 166   msg->bandwidth_in = bandwidth_in;
 167   atsp = (struct GNUNET_ATS_Information *) &msg[1];
 168   memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
 169   addrp = (char *) &atsp[atsi_count];
 170   memcpy (addrp, plugin_addr, plugin_addr_len);
 171   strcpy (&addrp[plugin_addr_len], plugin_name);
 172   GNUNET_SERVER_notification_context_unicast (nc, pc->client, &msg->header,
 173                                               GNUNET_YES);
 174 }
 175
 176
 177 /**
 178  * Transmit the given performance information to all performance
 179  * clients.
 180  *
 181  * @param peer peer for which this is an address suggestion
 182  * @param plugin_name 0-termintated string specifying the transport plugin
 183  * @param plugin_addr binary address for the plugin to use
 184  * @param plugin_addr_len number of bytes in plugin_addr
 185  * @param atsi performance data for the address
 186  * @param atsi_count number of performance records in 'ats'
 187  * @param bandwidth_out assigned outbound bandwidth
 188  * @param bandwidth_in assigned inbound bandwidth
 189  */
 190 void
 191 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
 192                                 const char *plugin_name,
 193                                 const void *plugin_addr, size_t plugin_addr_len,
 194                                 const struct GNUNET_ATS_Information *atsi,
 195                                 uint32_t atsi_count,
 196                                 struct GNUNET_BANDWIDTH_Value32NBO
 197                                 bandwidth_out,
 198                                 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 199 {
 200   struct PerformanceClient *pc;
 201
 202   for (pc = pc_head; pc != NULL; pc = pc->next)
 203     if (pc->flag == START_FLAG_PERFORMANCE_WITH_PIC)
 204     {
 205         GAS_performance_notify_client (pc,
 206                                        peer,
 207                                        plugin_name, plugin_addr, plugin_addr_len,
 208                                        atsi, atsi_count,
 209                                        bandwidth_out, bandwidth_in);
 210     }
 211
 212   GNUNET_STATISTICS_update (GSA_stats,
 213                             "# performance updates given to clients", 1,
 214                             GNUNET_NO);
 215 }
 216
 217
 218 static void
 219 peerinfo_it (void *cls,
 220              const struct GNUNET_PeerIdentity *id,
 221              const char *plugin_name,
 222              const void *plugin_addr, size_t plugin_addr_len,
 223              const int active,
 224              const struct GNUNET_ATS_Information *atsi,
 225              uint32_t atsi_count,
 226              struct GNUNET_BANDWIDTH_Value32NBO
 227              bandwidth_out,
 228              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 229 {
 230   struct PerformanceClient *pc = cls;
 231   GNUNET_assert (NULL != pc);
 232   if (NULL == id)
 233     return;
 234   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 235               "Callback for peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
 236               GNUNET_i2s (id),
 237               plugin_name,
 238               ntohl (bandwidth_out.value__),
 239               ntohl (bandwidth_in.value__));
 240   GAS_performance_notify_client(pc,
 241                                 id,
 242                                 plugin_name, plugin_addr, plugin_addr_len,
 243                                 atsi, atsi_count,
 244                                 bandwidth_out, bandwidth_in);
 245 }
 246
 247
 248 /**
 249  * Iterator for GAS_performance_add_client
 250  *
 251  * @param cls the client requesting information
 252  * @param id result
 253  */
 254 static void
 255 peer_it (void *cls,
 256          const struct GNUNET_PeerIdentity *id)
 257 {
 258   struct PerformanceClient *pc = cls;
 259   if (NULL != id)
 260   {
 261     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
 262     GAS_addresses_get_peer_info (id, &peerinfo_it, pc);
 263   }
 264 }
 265
 266 /**
 267  * Register a new performance client.
 268  *
 269  * @param client handle of the new client
 270  * @param flag flag specifying the type of the client
 271  */
 272 void
 273 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
 274                             enum StartFlag flag)
 275 {
 276   struct PerformanceClient *pc;
 277
 278   GNUNET_break (NULL == find_client (client));
 279   pc = GNUNET_malloc (sizeof (struct PerformanceClient));
 280   pc->client = client;
 281   pc->flag = flag;
 282   GNUNET_SERVER_notification_context_add (nc, client);
 283   GNUNET_SERVER_client_keep (client);
 284   GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
 285
 286   /* Send information about clients */
 287   GAS_addresses_iterate_peers (&peer_it, pc);
 288 }
 289
 290 /**
 291  * Handle 'address list request' messages from clients.
 292  *
 293  * @param cls unused, NULL
 294  * @param client client that sent the request
 295  * @param message the request message
 296  */
 297 void
 298 GAS_handle_request_address_list (void *cls, struct GNUNET_SERVER_Client *client,
 299                                  const struct GNUNET_MessageHeader *message)
 300 {
 301   struct PerformanceClient *pc;
 302   struct AddressListRequestMessage * alrm = (struct AddressListRequestMessage *) message;
 303   struct GNUNET_PeerIdentity allzeros;
 304
 305   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 306               "ADDRESSLIST_REQUEST");
 307
 308   if (NULL == (pc = find_client(client)))
 309   {
 310       GNUNET_break (0);
 311       return;
 312   }
 313
 314   memset (&allzeros, '\0', sizeof (struct GNUNET_PeerIdentity));
 315   if (0 == memcmp (&alrm->peer, &allzeros, sizeof (struct GNUNET_PeerIdentity)))
 316   {
 317       /* Return addresses for all peers */
 318       GAS_addresses_iterate_peers (&peer_it, pc);
 319   }
 320   else
 321   {
 322       /* Return addresses for a specific peer */
 323       GAS_addresses_get_peer_info (&alrm->peer, &peerinfo_it, pc);
 324   }
 325
 326
 327 }
 328
 329
 330
 331 /**
 332  * Handle 'reservation request' messages from clients.
 333  *
 334  * @param cls unused, NULL
 335  * @param client client that sent the request
 336  * @param message the request message
 337  */
 338 void
 339 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
 340                                 const struct GNUNET_MessageHeader *message)
 341 {
 342   const struct ReservationRequestMessage *msg =
 343       (const struct ReservationRequestMessage *) message;
 344   struct ReservationResultMessage result;
 345   int32_t amount;
 346   struct GNUNET_TIME_Relative res_delay;
 347
 348   if (NULL == find_client (client))
 349   {
 350     /* missing start message! */
 351     GNUNET_break (0);
 352     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 353     return;
 354   }
 355   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 356               "RESERVATION_REQUEST");
 357   amount = (int32_t) ntohl (msg->amount);
 358   res_delay = GAS_reservations_reserve (&msg->peer, amount);
 359   if (res_delay.rel_value > 0)
 360     amount = 0;
 361   result.header.size = htons (sizeof (struct ReservationResultMessage));
 362   result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
 363   result.amount = htonl (amount);
 364   result.peer = msg->peer;
 365   result.res_delay = GNUNET_TIME_relative_hton (res_delay);
 366   GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
 367                             GNUNET_NO);
 368   GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
 369                                               GNUNET_NO);
 370   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 371 }
 372
 373
 374 /**
 375  * Handle 'preference change' messages from clients.
 376  *
 377  * @param cls unused, NULL
 378  * @param client client that sent the request
 379  * @param message the request message
 380  */
 381 void
 382 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
 383                               const struct GNUNET_MessageHeader *message)
 384 {
 385   const struct ChangePreferenceMessage *msg;
 386   const struct PreferenceInformation *pi;
 387   uint16_t msize;
 388   uint32_t nump;
 389   uint32_t i;
 390
 391   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 392               "PREFERENCE_CHANGE");
 393   msize = ntohs (message->size);
 394   if (msize < sizeof (struct ChangePreferenceMessage))
 395   {
 396     GNUNET_break (0);
 397     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 398     return;
 399   }
 400   msg = (const struct ChangePreferenceMessage *) message;
 401   nump = ntohl (msg->num_preferences);
 402   if (msize !=
 403       sizeof (struct ChangePreferenceMessage) +
 404       nump * sizeof (struct PreferenceInformation))
 405   {
 406     GNUNET_break (0);
 407     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 408     return;
 409   }
 410   GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
 411                             1, GNUNET_NO);
 412   pi = (const struct PreferenceInformation *) &msg[1];
 413   for (i = 0; i < nump; i++)
 414     GAS_addresses_change_preference (&msg->peer,
 415                                      (enum GNUNET_ATS_PreferenceKind)
 416                                      ntohl (pi[i].preference_kind),
 417                                      pi[i].preference_value);
 418   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 419 }
 420
 421
 422 /**
 423  * Initialize performance subsystem.
 424  *
 425  * @param server handle to our server
 426  */
 427 void
 428 GAS_performance_init (struct GNUNET_SERVER_Handle *server)
 429 {
 430   nc = GNUNET_SERVER_notification_context_create (server, 128);
 431 }
 432
 433
 434 /**
 435  * Shutdown performance subsystem.
 436  */
 437 void
 438 GAS_performance_done ()
 439 {
 440   GNUNET_SERVER_notification_context_destroy (nc);
 441   nc = NULL;
 442 }
 443
 444 /* end of gnunet-service-ats_performance.c */