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 static void
 218 peerinfo_it (void *cls,
 219              const struct GNUNET_PeerIdentity *id,
 220              const char *plugin_name,
 221              const void *plugin_addr, size_t plugin_addr_len,
 222              const struct GNUNET_ATS_Information *atsi,
 223              uint32_t atsi_count,
 224              struct GNUNET_BANDWIDTH_Value32NBO
 225              bandwidth_out,
 226              struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 227 {
 228   GNUNET_assert (NULL != cls);
 229   if (NULL != id)
 230   {
 231     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s' plugin `%s' BW out %llu, BW in %llu \n",
 232         GNUNET_i2s (id),
 233         plugin_name, ntohl (bandwidth_out.value__), ntohl (bandwidth_in.value__));
 234     GAS_performance_notify_client(cls,
 235         id,
 236         plugin_name, plugin_addr, plugin_addr_len,
 237         atsi, atsi_count,
 238         bandwidth_out, bandwidth_in);
 239   }
 240
 241 }
 242
 243 static void
 244 peer_it (void *cls,
 245          const struct GNUNET_PeerIdentity *id)
 246 {
 247   if (NULL != id)
 248   {
 249     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
 250     GAS_addresses_get_peer_info (id, &peerinfo_it, cls);
 251   }
 252 }
 253
 254 /**
 255  * Register a new performance client.
 256  *
 257  * @param client handle of the new client
 258  * @param flag flag specifying the type of the client
 259  */
 260 void
 261 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
 262                             enum StartFlag flag)
 263 {
 264   struct PerformanceClient *pc;
 265
 266   GNUNET_break (NULL == find_client (client));
 267   pc = GNUNET_malloc (sizeof (struct PerformanceClient));
 268   pc->client = client;
 269   pc->flag = flag;
 270   GNUNET_SERVER_notification_context_add (nc, client);
 271   GNUNET_SERVER_client_keep (client);
 272   GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
 273
 274   /* Send information about clients */
 275   GAS_addresses_iterate_peers (&peer_it, pc);
 276 }
 277
 278
 279
 280 /**
 281  * Handle 'reservation request' messages from clients.
 282  *
 283  * @param cls unused, NULL
 284  * @param client client that sent the request
 285  * @param message the request message
 286  */
 287 void
 288 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
 289                                 const struct GNUNET_MessageHeader *message)
 290 {
 291   const struct ReservationRequestMessage *msg =
 292       (const struct ReservationRequestMessage *) message;
 293   struct ReservationResultMessage result;
 294   int32_t amount;
 295   struct GNUNET_TIME_Relative res_delay;
 296
 297   if (NULL == find_client (client))
 298   {
 299     /* missing start message! */
 300     GNUNET_break (0);
 301     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 302     return;
 303   }
 304   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 305               "RESERVATION_REQUEST");
 306   amount = (int32_t) ntohl (msg->amount);
 307   res_delay = GAS_reservations_reserve (&msg->peer, amount);
 308   if (res_delay.rel_value > 0)
 309     amount = 0;
 310   result.header.size = htons (sizeof (struct ReservationResultMessage));
 311   result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
 312   result.amount = htonl (amount);
 313   result.peer = msg->peer;
 314   result.res_delay = GNUNET_TIME_relative_hton (res_delay);
 315   GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
 316                             GNUNET_NO);
 317   GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
 318                                               GNUNET_NO);
 319   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 320 }
 321
 322
 323 /**
 324  * Handle 'preference change' messages from clients.
 325  *
 326  * @param cls unused, NULL
 327  * @param client client that sent the request
 328  * @param message the request message
 329  */
 330 void
 331 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
 332                               const struct GNUNET_MessageHeader *message)
 333 {
 334   const struct ChangePreferenceMessage *msg;
 335   const struct PreferenceInformation *pi;
 336   uint16_t msize;
 337   uint32_t nump;
 338   uint32_t i;
 339
 340   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 341               "PREFERENCE_CHANGE");
 342   msize = ntohs (message->size);
 343   if (msize < sizeof (struct ChangePreferenceMessage))
 344   {
 345     GNUNET_break (0);
 346     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 347     return;
 348   }
 349   msg = (const struct ChangePreferenceMessage *) message;
 350   nump = ntohl (msg->num_preferences);
 351   if (msize !=
 352       sizeof (struct ChangePreferenceMessage) +
 353       nump * sizeof (struct PreferenceInformation))
 354   {
 355     GNUNET_break (0);
 356     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 357     return;
 358   }
 359   GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
 360                             1, GNUNET_NO);
 361   pi = (const struct PreferenceInformation *) &msg[1];
 362   for (i = 0; i < nump; i++)
 363     GAS_addresses_change_preference (&msg->peer,
 364                                      (enum GNUNET_ATS_PreferenceKind)
 365                                      ntohl (pi[i].preference_kind),
 366                                      pi[i].preference_value);
 367   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 368 }
 369
 370
 371 /**
 372  * Initialize performance subsystem.
 373  *
 374  * @param server handle to our server
 375  */
 376 void
 377 GAS_performance_init (struct GNUNET_SERVER_Handle *server)
 378 {
 379   nc = GNUNET_SERVER_notification_context_create (server, 128);
 380 }
 381
 382
 383 /**
 384  * Shutdown performance subsystem.
 385  */
 386 void
 387 GAS_performance_done ()
 388 {
 389   GNUNET_SERVER_notification_context_destroy (nc);
 390   nc = NULL;
 391 }
 392
 393 /* end of gnunet-service-ats_performance.c */