src/ats/gnunet-service-ats_scheduling.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_scheduling.c
  23  * @brief ats service, interaction with 'scheduling' 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_scheduling.h"
  31 #include "ats.h"
  32
  33
  34 /**
  35  * Context for sending messages to clients.
  36  */
  37 static struct GNUNET_SERVER_NotificationContext *nc;
  38
  39 /**
  40  * Actual handle to the client.
  41  */
  42 static struct GNUNET_SERVER_Client *my_client;
  43
  44
  45 /**
  46  * Handle to address subsystem
  47  */
  48 static struct GAS_Addresses_Handle *address_handle;
  49
  50 /**
  51  * Register a new scheduling client.
  52  *
  53  * @param client handle of the new client
  54  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  55  */
  56 int
  57 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client)
  58 {
  59   if (my_client != NULL)
  60   {
  61     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
  62                 "This ATS already has a scheduling client, refusing new scheduling client for now.\n");
  63     return GNUNET_SYSERR;
  64   }
  65   my_client = client;
  66   GNUNET_SERVER_notification_context_add (nc, client);
  67   return GNUNET_OK;
  68 }
  69
  70
  71 /**
  72  * Unregister a client (which may have been a scheduling client,
  73  * but this is not assured).
  74  *
  75  * @param client handle of the (now dead) client
  76  */
  77 void
  78 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
  79 {
  80   if (my_client != client)
  81     return;
  82   GAS_addresses_destroy_all (address_handle);
  83   my_client = NULL;
  84 }
  85
  86
  87 /**
  88  * Transmit the given address suggestion and bandwidth update to all scheduling
  89  * clients.
  90  *
  91  * @param peer peer for which this is an address suggestion
  92  * @param plugin_name 0-termintated string specifying the transport plugin
  93  * @param plugin_addr binary address for the plugin to use
  94  * @param plugin_addr_len number of bytes in plugin_addr
  95  * @param session_id session ID to use for the given client (other clients will see 0)
  96  * @param atsi performance data for the address
  97  * @param atsi_count number of performance records in 'ats'
  98  * @param bandwidth_out assigned outbound bandwidth
  99  * @param bandwidth_in assigned inbound bandwidth
 100  */
 101 void
 102 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity
 103                                             *peer, const char *plugin_name,
 104                                             const void *plugin_addr,
 105                                             size_t plugin_addr_len,
 106                                             uint32_t session_id,
 107                                             const struct GNUNET_ATS_Information
 108                                             *atsi, uint32_t atsi_count,
 109                                             struct GNUNET_BANDWIDTH_Value32NBO
 110                                             bandwidth_out,
 111                                             struct GNUNET_BANDWIDTH_Value32NBO
 112                                             bandwidth_in)
 113 {
 114   struct AddressSuggestionMessage *msg;
 115   size_t plugin_name_length = strlen (plugin_name) + 1;
 116   size_t msize =
 117       sizeof (struct AddressSuggestionMessage) +
 118       atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
 119       plugin_name_length;
 120   char buf[msize] GNUNET_ALIGN;
 121   struct GNUNET_ATS_Information *atsp;
 122   char *addrp;
 123
 124   if (my_client == NULL)
 125     return;
 126   GNUNET_STATISTICS_update (GSA_stats, "# address suggestions made", 1,
 127                             GNUNET_NO);
 128   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 129   GNUNET_assert (atsi_count <
 130                  GNUNET_SERVER_MAX_MESSAGE_SIZE /
 131                  sizeof (struct GNUNET_ATS_Information));
 132   msg = (struct AddressSuggestionMessage *) buf;
 133   msg->header.size = htons (msize);
 134   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
 135   msg->ats_count = htonl (atsi_count);
 136   msg->peer = *peer;
 137   msg->address_length = htons (plugin_addr_len);
 138   msg->plugin_name_length = htons (plugin_name_length);
 139   msg->session_id = htonl (session_id);
 140   msg->bandwidth_out = bandwidth_out;
 141   msg->bandwidth_in = bandwidth_in;
 142   atsp = (struct GNUNET_ATS_Information *) &msg[1];
 143   memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
 144   addrp = (char *) &atsp[atsi_count];
 145   memcpy (addrp, plugin_addr, plugin_addr_len);
 146   strcpy (&addrp[plugin_addr_len], plugin_name);
 147
 148   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 149               "ATS sends quota for peer `%s': (in/out) %u/%u\n",
 150               GNUNET_i2s (peer), ntohl (bandwidth_in.value__),
 151               ntohl (bandwidth_out.value__));
 152
 153   GNUNET_SERVER_notification_context_unicast (nc, my_client, &msg->header,
 154                                               GNUNET_YES);
 155 }
 156
 157
 158 /**
 159  * Handle 'request address' messages from clients.
 160  *
 161  * @param cls unused, NULL
 162  * @param client client that sent the request
 163  * @param message the request message
 164  */
 165 void
 166 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
 167                             const struct GNUNET_MessageHeader *message)
 168 {
 169   const struct RequestAddressMessage *msg =
 170       (const struct RequestAddressMessage *) message;
 171
 172   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 173               "REQUEST_ADDRESS");
 174   GNUNET_break (0 == ntohl (msg->reserved));
 175   GAS_addresses_request_address (address_handle, &msg->peer);
 176   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 177 }
 178
 179
 180 /**
 181  * Handle 'request address' messages from clients.
 182  *
 183  * @param cls unused, NULL
 184  * @param client client that sent the request
 185  * @param message the request message
 186  */
 187 void
 188 GAS_handle_request_address_cancel (void *cls,
 189                                    struct GNUNET_SERVER_Client *client,
 190                                    const struct GNUNET_MessageHeader *message)
 191 {
 192   const struct RequestAddressMessage *msg =
 193       (const struct RequestAddressMessage *) message;
 194
 195   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 196               "REQUEST_ADDRESS_CANCEL");
 197   GNUNET_break (0 == ntohl (msg->reserved));
 198
 199   GAS_addresses_request_address_cancel (address_handle, &msg->peer);
 200
 201   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 202 }
 203
 204 /**
 205  * Handle 'reset backoff' messages from clients.
 206  *
 207  * @param cls unused, NULL
 208  * @param client client that sent the request
 209  * @param message the request message
 210  */
 211 void
 212 GAS_handle_reset_backoff (void *cls,
 213                           struct GNUNET_SERVER_Client *client,
 214                           const struct GNUNET_MessageHeader *message)
 215 {
 216   const struct ResetBackoffMessage *msg =
 217       (const struct ResetBackoffMessage *) message;
 218
 219   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 220               "RESET_BACKOFF");
 221   GNUNET_break (0 == ntohl (msg->reserved));
 222   GAS_addresses_handle_backoff_reset (address_handle, &msg->peer);
 223   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 224 }
 225
 226 /**
 227  * Handle 'address add' messages from clients.
 228  *
 229  * @param cls unused, NULL
 230  * @param client client that sent the request
 231  * @param message the request message
 232  */
 233 void
 234 GAS_handle_address_add (void *cls, struct GNUNET_SERVER_Client *client,
 235                         const struct GNUNET_MessageHeader *message)
 236 {
 237   const struct AddressUpdateMessage *m;
 238   const struct GNUNET_ATS_Information *atsi;
 239   const char *address;
 240   const char *plugin_name;
 241   uint16_t address_length;
 242   uint16_t plugin_name_length;
 243   uint32_t ats_count;
 244   uint16_t size;
 245
 246   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 247               "ADDRESS_ADD");
 248   size = ntohs (message->size);
 249   if (size < sizeof (struct AddressUpdateMessage))
 250   {
 251     GNUNET_break (0);
 252     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 253     return;
 254   }
 255   m = (const struct AddressUpdateMessage *) message;
 256   ats_count = ntohl (m->ats_count);
 257   address_length = ntohs (m->address_length);
 258   plugin_name_length = ntohs (m->plugin_name_length);
 259   atsi = (const struct GNUNET_ATS_Information *) &m[1];
 260   address = (const char *) &atsi[ats_count];
 261   if (plugin_name_length != 0)
 262     plugin_name = &address[address_length];
 263   else
 264     plugin_name = "";
 265
 266   if ((address_length + plugin_name_length +
 267        ats_count * sizeof (struct GNUNET_ATS_Information) +
 268        sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
 269       (ats_count >
 270        GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
 271        ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
 272   {
 273     GNUNET_break (0);
 274     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 275     return;
 276   }
 277   GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
 278                             GNUNET_NO);
 279   GAS_addresses_add (address_handle, &m->peer, plugin_name, address, address_length,
 280                         ntohl (m->session_id), atsi, ats_count);
 281   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 282 }
 283
 284
 285 /**
 286  * Handle 'address update' messages from clients.
 287  *
 288  * @param cls unused, NULL
 289  * @param client client that sent the request
 290  * @param message the request message
 291  */
 292 void
 293 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
 294                            const struct GNUNET_MessageHeader *message)
 295 {
 296   const struct AddressUpdateMessage *m;
 297   const struct GNUNET_ATS_Information *atsi;
 298   const char *address;
 299   const char *plugin_name;
 300   uint16_t address_length;
 301   uint16_t plugin_name_length;
 302   uint32_t ats_count;
 303   uint16_t size;
 304
 305   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 306               "ADDRESS_UPDATE");
 307   size = ntohs (message->size);
 308   if (size < sizeof (struct AddressUpdateMessage))
 309   {
 310     GNUNET_break (0);
 311     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 312     return;
 313   }
 314   m = (const struct AddressUpdateMessage *) message;
 315   ats_count = ntohl (m->ats_count);
 316   address_length = ntohs (m->address_length);
 317   plugin_name_length = ntohs (m->plugin_name_length);
 318   atsi = (const struct GNUNET_ATS_Information *) &m[1];
 319   address = (const char *) &atsi[ats_count];
 320   if (plugin_name_length != 0)
 321     plugin_name = &address[address_length];
 322   else
 323     plugin_name = "";
 324
 325   if ((address_length + plugin_name_length +
 326        ats_count * sizeof (struct GNUNET_ATS_Information) +
 327        sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
 328       (ats_count >
 329        GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information)) ||
 330        ((plugin_name_length > 0) && (plugin_name[plugin_name_length - 1] != '\0')))
 331   {
 332     GNUNET_break (0);
 333     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 334     return;
 335   }
 336   GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
 337                             GNUNET_NO);
 338   GAS_addresses_update (address_handle, &m->peer, plugin_name, address, address_length,
 339                         ntohl (m->session_id), atsi, ats_count);
 340   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 341 }
 342
 343
 344 /**
 345  * Handle 'address in use' messages from clients.
 346  *
 347  * @param cls unused, NULL
 348  * @param client client that sent the request
 349  * @param message the request message
 350  */
 351 void
 352 GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
 353                            const struct GNUNET_MessageHeader *message)
 354 {
 355   const struct AddressUseMessage *m;
 356   const char *address;
 357   const char *plugin_name;
 358   int res;
 359   uint16_t address_length;
 360   uint16_t plugin_name_length;
 361
 362   uint16_t size;
 363   uint16_t in_use;
 364
 365   size = ntohs (message->size);
 366   if (size < sizeof (struct AddressUseMessage))
 367   {
 368     GNUNET_break (0);
 369     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 370     return;
 371   }
 372   m = (const struct AddressUseMessage *) message;
 373
 374   address_length = ntohs (m->address_length);
 375   plugin_name_length = ntohs (m->plugin_name_length);
 376
 377   address = (const char *) &m[1];
 378   if (plugin_name_length != 0)
 379     plugin_name = &address[address_length];
 380   else
 381     plugin_name = "";
 382
 383   if ((address_length + plugin_name_length +
 384        sizeof (struct AddressUseMessage) != ntohs (message->size)) ||
 385       ((plugin_name_length > 0) &&
 386       (plugin_name[plugin_name_length - 1] != '\0')))
 387   {
 388     GNUNET_break (0);
 389     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 390     return;
 391   }
 392
 393   in_use = ntohs (m->in_use);
 394   res = GAS_addresses_in_use (address_handle,
 395                               &m->peer,
 396                               plugin_name,
 397                               address,
 398                               address_length,
 399                               ntohl (m->session_id),
 400                               in_use);
 401
 402   if (res == GNUNET_OK)
 403     GNUNET_SERVER_receive_done (client, GNUNET_OK);
 404   else
 405   {
 406     GNUNET_break (0);
 407     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 408   }
 409
 410 }
 411
 412 /**
 413  * Handle 'address destroyed' messages from clients.
 414  *
 415  * @param cls unused, NULL
 416  * @param client client that sent the request
 417  * @param message the request message
 418  */
 419 void
 420 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
 421                               const struct GNUNET_MessageHeader *message)
 422 {
 423   const struct AddressDestroyedMessage *m;
 424   struct SessionReleaseMessage srm;
 425   const char *address;
 426   const char *plugin_name;
 427   uint16_t address_length;
 428   uint16_t plugin_name_length;
 429   uint16_t size;
 430
 431   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message of size %u %u\n",
 432               "ADDRESS_DESTROYED", ntohs (message->size),
 433               sizeof (struct AddressDestroyedMessage));
 434   size = ntohs (message->size);
 435   if ((size < sizeof (struct AddressDestroyedMessage)) || (client != my_client))
 436   {
 437     GNUNET_break (0);
 438     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 439     return;
 440   }
 441   m = (const struct AddressDestroyedMessage *) message;
 442   GNUNET_break (0 == ntohl (m->reserved));
 443   address_length = ntohs (m->address_length);
 444   plugin_name_length = ntohs (m->plugin_name_length);
 445   address = (const char *) &m[1];
 446   if (plugin_name_length != 0)
 447     plugin_name = &address[address_length];
 448   else
 449     plugin_name = "";
 450   if ((address_length + plugin_name_length +
 451        sizeof (struct AddressDestroyedMessage) != ntohs (message->size)))
 452   {
 453     GNUNET_break (0);
 454     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 455     return;
 456   }
 457   if ((plugin_name_length == 0) ||
 458       (plugin_name[plugin_name_length - 1] != '\0'))
 459   {
 460     GNUNET_break (0);
 461     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 462     return;
 463   }
 464   GNUNET_STATISTICS_update (GSA_stats, "# addresses destroyed", 1, GNUNET_NO);
 465   GAS_addresses_destroy (address_handle, &m->peer, plugin_name,
 466                          address, address_length,
 467                          ntohl (m->session_id));
 468   if (0 != ntohl (m->session_id))
 469   {
 470     srm.header.type = ntohs (GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE);
 471     srm.header.size = ntohs (sizeof (struct SessionReleaseMessage));
 472     srm.session_id = m->session_id;
 473     srm.peer = m->peer;
 474     GNUNET_SERVER_notification_context_unicast (nc, client, &srm.header,
 475                                                 GNUNET_NO);
 476   }
 477   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 478 }
 479
 480
 481 /**
 482  * Initialize scheduling subsystem.
 483  *
 484  * @param server handle to our server
 485  * @param ah the address handle to use
 486  */
 487 void
 488 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server, struct GAS_Addresses_Handle *ah)
 489 {
 490   GNUNET_assert (NULL != ah);
 491   address_handle = ah;
 492   nc = GNUNET_SERVER_notification_context_create (server, 128);
 493 }
 494
 495
 496 /**
 497  * Shutdown scheduling subsystem.
 498  */
 499 void
 500 GAS_scheduling_done ()
 501 {
 502   if (NULL != my_client)
 503   {
 504     my_client = NULL;
 505   }
 506   GNUNET_SERVER_notification_context_destroy (nc);
 507   nc = NULL;
 508
 509 }
 510
 511
 512 /* end of gnunet-service-ats_scheduling.c */