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 static void
  98 peerinfo_it (void *cls,
  99              const struct GNUNET_PeerIdentity *id,
 100              const char *plugin)
 101 {
 102   struct PerformanceClient *pc = cls;
 103   GNUNET_assert (NULL != pc);
 104   if (NULL != id)
 105   {
 106     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s' plugin `%s'\n", GNUNET_i2s (id), plugin);
 107     /* TODO: Notify client here! */
 108     //GNUNET_break (0);
 109   }
 110
 111 }
 112
 113 static void
 114 peer_it (void *cls,
 115          const struct GNUNET_PeerIdentity *id)
 116 {
 117   if (NULL != id)
 118   {
 119     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Callback for peer `%s'\n", GNUNET_i2s (id));
 120     GAS_addresses_get_peer_info (id, &peerinfo_it, cls);
 121   }
 122 }
 123
 124 /**
 125  * Register a new performance client.
 126  *
 127  * @param client handle of the new client
 128  * @param flag flag specifying the type of the client
 129  */
 130 void
 131 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
 132                             enum StartFlag flag)
 133 {
 134   struct PerformanceClient *pc;
 135
 136   GNUNET_break (NULL == find_client (client));
 137   pc = GNUNET_malloc (sizeof (struct PerformanceClient));
 138   pc->client = client;
 139   pc->flag = flag;
 140   GNUNET_SERVER_notification_context_add (nc, client);
 141   GNUNET_SERVER_client_keep (client);
 142   GNUNET_CONTAINER_DLL_insert (pc_head, pc_tail, pc);
 143
 144   /* Send information about clients */
 145   GAS_addresses_iterate_peers (&peer_it, pc);
 146 }
 147
 148
 149 /**
 150  * Unregister a client (which may have been a performance client,
 151  * but this is not assured).
 152  *
 153  * @param client handle of the (now dead) client
 154  */
 155 void
 156 GAS_performance_remove_client (struct GNUNET_SERVER_Client *client)
 157 {
 158   struct PerformanceClient *pc;
 159
 160   pc = find_client (client);
 161   if (NULL == pc)
 162     return;
 163   GNUNET_CONTAINER_DLL_remove (pc_head, pc_tail, pc);
 164   GNUNET_SERVER_client_drop (client);
 165   GNUNET_free (pc);
 166 }
 167
 168
 169 /**
 170  * Transmit the given performance information to all performance
 171  * clients.
 172  *
 173  * @param peer peer for which this is an address suggestion
 174  * @param plugin_name 0-termintated string specifying the transport plugin
 175  * @param plugin_addr binary address for the plugin to use
 176  * @param plugin_addr_len number of bytes in plugin_addr
 177  * @param atsi performance data for the address
 178  * @param atsi_count number of performance records in 'ats'
 179  * @param bandwidth_out assigned outbound bandwidth
 180  * @param bandwidth_in assigned inbound bandwidth
 181  */
 182 void
 183 GAS_performance_notify_clients (const struct GNUNET_PeerIdentity *peer,
 184                                 const char *plugin_name,
 185                                 const void *plugin_addr, size_t plugin_addr_len,
 186                                 const struct GNUNET_ATS_Information *atsi,
 187                                 uint32_t atsi_count,
 188                                 struct GNUNET_BANDWIDTH_Value32NBO
 189                                 bandwidth_out,
 190                                 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in)
 191 {
 192   struct PerformanceClient *pc;
 193   struct PeerInformationMessage *msg;
 194   size_t plugin_name_length = strlen (plugin_name) + 1;
 195   size_t msize =
 196       sizeof (struct PeerInformationMessage) +
 197       atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
 198       plugin_name_length;
 199   char buf[msize] GNUNET_ALIGN;
 200   struct GNUNET_ATS_Information *atsp;
 201   char *addrp;
 202
 203   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 204   GNUNET_assert (atsi_count <
 205                  GNUNET_SERVER_MAX_MESSAGE_SIZE /
 206                  sizeof (struct GNUNET_ATS_Information));
 207   msg = (struct PeerInformationMessage *) buf;
 208   msg->header.size = htons (msize);
 209   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION);
 210   msg->ats_count = htonl (atsi_count);
 211   msg->peer = *peer;
 212   msg->address_length = htons (plugin_addr_len);
 213   msg->plugin_name_length = htons (plugin_name_length);
 214   msg->bandwidth_out = bandwidth_out;
 215   msg->bandwidth_in = bandwidth_in;
 216   atsp = (struct GNUNET_ATS_Information *) &msg[1];
 217   memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
 218   addrp = (char *) &atsp[atsi_count];
 219   memcpy (addrp, plugin_addr, plugin_addr_len);
 220   strcpy (&addrp[plugin_addr_len], plugin_name);
 221   for (pc = pc_head; pc != NULL; pc = pc->next)
 222     if (pc->flag == START_FLAG_PERFORMANCE_WITH_PIC)
 223     {
 224       GNUNET_SERVER_notification_context_unicast (nc, pc->client, &msg->header,
 225                                                   GNUNET_YES);
 226       GNUNET_STATISTICS_update (GSA_stats,
 227                                 "# performance updates given to clients", 1,
 228                                 GNUNET_NO);
 229     }
 230 }
 231
 232
 233 /**
 234  * Handle 'reservation request' messages from clients.
 235  *
 236  * @param cls unused, NULL
 237  * @param client client that sent the request
 238  * @param message the request message
 239  */
 240 void
 241 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
 242                                 const struct GNUNET_MessageHeader *message)
 243 {
 244   const struct ReservationRequestMessage *msg =
 245       (const struct ReservationRequestMessage *) message;
 246   struct ReservationResultMessage result;
 247   int32_t amount;
 248   struct GNUNET_TIME_Relative res_delay;
 249
 250   if (NULL == find_client (client))
 251   {
 252     /* missing start message! */
 253     GNUNET_break (0);
 254     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 255     return;
 256   }
 257   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 258               "RESERVATION_REQUEST");
 259   amount = (int32_t) ntohl (msg->amount);
 260   res_delay = GAS_reservations_reserve (&msg->peer, amount);
 261   if (res_delay.rel_value > 0)
 262     amount = 0;
 263   result.header.size = htons (sizeof (struct ReservationResultMessage));
 264   result.header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT);
 265   result.amount = htonl (amount);
 266   result.peer = msg->peer;
 267   result.res_delay = GNUNET_TIME_relative_hton (res_delay);
 268   GNUNET_STATISTICS_update (GSA_stats, "# reservation requests processed", 1,
 269                             GNUNET_NO);
 270   GNUNET_SERVER_notification_context_unicast (nc, client, &result.header,
 271                                               GNUNET_NO);
 272   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 273 }
 274
 275
 276 /**
 277  * Handle 'preference change' messages from clients.
 278  *
 279  * @param cls unused, NULL
 280  * @param client client that sent the request
 281  * @param message the request message
 282  */
 283 void
 284 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
 285                               const struct GNUNET_MessageHeader *message)
 286 {
 287   const struct ChangePreferenceMessage *msg;
 288   const struct PreferenceInformation *pi;
 289   uint16_t msize;
 290   uint32_t nump;
 291   uint32_t i;
 292
 293   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 294               "PREFERENCE_CHANGE");
 295   msize = ntohs (message->size);
 296   if (msize < sizeof (struct ChangePreferenceMessage))
 297   {
 298     GNUNET_break (0);
 299     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 300     return;
 301   }
 302   msg = (const struct ChangePreferenceMessage *) message;
 303   nump = ntohl (msg->num_preferences);
 304   if (msize !=
 305       sizeof (struct ChangePreferenceMessage) +
 306       nump * sizeof (struct PreferenceInformation))
 307   {
 308     GNUNET_break (0);
 309     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 310     return;
 311   }
 312   GNUNET_STATISTICS_update (GSA_stats, "# preference change requests processed",
 313                             1, GNUNET_NO);
 314   pi = (const struct PreferenceInformation *) &msg[1];
 315   for (i = 0; i < nump; i++)
 316     GAS_addresses_change_preference (&msg->peer,
 317                                      (enum GNUNET_ATS_PreferenceKind)
 318                                      ntohl (pi[i].preference_kind),
 319                                      pi[i].preference_value);
 320   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 321 }
 322
 323
 324 /**
 325  * Initialize performance subsystem.
 326  *
 327  * @param server handle to our server
 328  */
 329 void
 330 GAS_performance_init (struct GNUNET_SERVER_Handle *server)
 331 {
 332   nc = GNUNET_SERVER_notification_context_create (server, 128);
 333 }
 334
 335
 336 /**
 337  * Shutdown performance subsystem.
 338  */
 339 void
 340 GAS_performance_done ()
 341 {
 342   GNUNET_SERVER_notification_context_destroy (nc);
 343   nc = NULL;
 344 }
 345
 346 /* end of gnunet-service-ats_performance.c */