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  * Register a new scheduling client.
  47  *
  48  * @param client handle of the new client
  49  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  50  */
  51 int
  52 GAS_scheduling_add_client (struct GNUNET_SERVER_Client *client)
  53 {
  54   if (my_client != NULL)
  55   {
  56     GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
  57                 "This ATS already has a scheduling client, refusing new scheduling client for now.\n");
  58     return GNUNET_SYSERR;
  59   }
  60   my_client = client;
  61   GNUNET_SERVER_notification_context_add (nc, client);
  62   return GNUNET_OK;
  63 }
  64
  65
  66 /**
  67  * Unregister a client (which may have been a scheduling client,
  68  * but this is not assured).
  69  *
  70  * @param client handle of the (now dead) client
  71  */
  72 void
  73 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
  74 {
  75   if (my_client != client)
  76     return;
  77   GAS_addresses_destroy_all ();
  78   my_client = NULL;
  79 }
  80
  81
  82 /**
  83  * Transmit the given address suggestion and bandwidth update to all scheduling
  84  * clients.
  85  *
  86  * @param peer peer for which this is an address suggestion
  87  * @param plugin_name 0-termintated string specifying the transport plugin
  88  * @param plugin_addr binary address for the plugin to use
  89  * @param plugin_addr_len number of bytes in plugin_addr
  90  * @param session_id session ID to use for the given client (other clients will see 0)
  91  * @param atsi performance data for the address
  92  * @param atsi_count number of performance records in 'ats'
  93  * @param bandwidth_out assigned outbound bandwidth
  94  * @param bandwidth_in assigned inbound bandwidth
  95  */
  96 void
  97 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity
  98                                             *peer, const char *plugin_name,
  99                                             const void *plugin_addr,
 100                                             size_t plugin_addr_len,
 101                                             uint32_t session_id,
 102                                             const struct GNUNET_ATS_Information
 103                                             *atsi, uint32_t atsi_count,
 104                                             struct GNUNET_BANDWIDTH_Value32NBO
 105                                             bandwidth_out,
 106                                             struct GNUNET_BANDWIDTH_Value32NBO
 107                                             bandwidth_in)
 108 {
 109   struct AddressSuggestionMessage *msg;
 110   size_t plugin_name_length = strlen (plugin_name) + 1;
 111   size_t msize =
 112       sizeof (struct AddressSuggestionMessage) +
 113       atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
 114       plugin_name_length;
 115   char buf[msize] GNUNET_ALIGN;
 116   struct GNUNET_ATS_Information *atsp;
 117   char *addrp;
 118
 119   if (my_client == NULL)
 120     return;
 121   GNUNET_STATISTICS_update (GSA_stats, "# address suggestions made", 1,
 122                             GNUNET_NO);
 123   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 124   GNUNET_assert (atsi_count <
 125                  GNUNET_SERVER_MAX_MESSAGE_SIZE /
 126                  sizeof (struct GNUNET_ATS_Information));
 127   msg = (struct AddressSuggestionMessage *) buf;
 128   msg->header.size = htons (msize);
 129   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
 130   msg->ats_count = htonl (atsi_count);
 131   msg->peer = *peer;
 132   msg->address_length = htons (plugin_addr_len);
 133   msg->plugin_name_length = htons (plugin_name_length);
 134   msg->session_id = htonl (session_id);
 135   msg->bandwidth_out = bandwidth_out;
 136   msg->bandwidth_in = bandwidth_in;
 137   atsp = (struct GNUNET_ATS_Information *) &msg[1];
 138   memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
 139   addrp = (char *) &atsp[atsi_count];
 140   memcpy (addrp, plugin_addr, plugin_addr_len);
 141   strcpy (&addrp[plugin_addr_len], plugin_name);
 142
 143   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
 144               "ATS sends quota for peer `%s': (in/out) %u/%u\n",
 145               GNUNET_i2s (peer), ntohl (bandwidth_in.value__),
 146               ntohl (bandwidth_out.value__));
 147
 148   GNUNET_SERVER_notification_context_unicast (nc, my_client, &msg->header,
 149                                               GNUNET_YES);
 150 }
 151
 152
 153 /**
 154  * Handle 'request address' messages from clients.
 155  *
 156  * @param cls unused, NULL
 157  * @param client client that sent the request
 158  * @param message the request message
 159  */
 160 void
 161 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
 162                             const struct GNUNET_MessageHeader *message)
 163 {
 164   const struct RequestAddressMessage *msg =
 165       (const struct RequestAddressMessage *) message;
 166
 167   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 168               "REQUEST_ADDRESS");
 169   GNUNET_STATISTICS_update (GSA_stats, "# address requests received", 1,
 170                             GNUNET_NO);
 171   GNUNET_break (0 == ntohl (msg->reserved));
 172   GAS_addresses_request_address (&msg->peer);
 173   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 174 }
 175
 176
 177 /**
 178  * Handle 'request address' messages from clients.
 179  *
 180  * @param cls unused, NULL
 181  * @param client client that sent the request
 182  * @param message the request message
 183  */
 184 void
 185 GAS_handle_request_address_cancel (void *cls,
 186                                    struct GNUNET_SERVER_Client *client,
 187                                    const struct GNUNET_MessageHeader *message)
 188 {
 189   const struct RequestAddressMessage *msg =
 190       (const struct RequestAddressMessage *) message;
 191
 192   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 193               "REQUEST_ADDRESS_CANCEL");
 194   GNUNET_break (0 == ntohl (msg->reserved));
 195
 196   /* TODO */
 197
 198   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 199 }
 200
 201 /**
 202  * Handle 'reset backoff' messages from clients.
 203  *
 204  * @param cls unused, NULL
 205  * @param client client that sent the request
 206  * @param message the request message
 207  */
 208 void
 209 GAS_handle_reset_backoff (void *cls,
 210                           struct GNUNET_SERVER_Client *client,
 211                           const struct GNUNET_MessageHeader *message)
 212 {
 213   const struct ResetBackoffMessage *msg =
 214       (const struct ResetBackoffMessage *) message;
 215
 216   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 217               "RESET_BACKOFF");
 218   GNUNET_STATISTICS_update (GSA_stats, "# backoff reset requests received", 1,
 219                             GNUNET_NO);
 220   GNUNET_break (0 == ntohl (msg->reserved));
 221   GAS_addresses_handle_backoff_reset (&msg->peer);
 222   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 223 }
 224
 225
 226 /**
 227  * Handle 'address update' 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_update (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_UPDATE");
 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_update (&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 in use' 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_in_use (void *cls, struct GNUNET_SERVER_Client *client,
 294                            const struct GNUNET_MessageHeader *message)
 295 {
 296   const struct AddressUseMessage *m;
 297   const char *address;
 298   const char *plugin_name;
 299   int res;
 300   uint16_t address_length;
 301   uint16_t plugin_name_length;
 302
 303   uint16_t size;
 304   uint16_t in_use;
 305
 306   size = ntohs (message->size);
 307   if (size < sizeof (struct AddressUseMessage))
 308   {
 309     GNUNET_break (0);
 310     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 311     return;
 312   }
 313   m = (const struct AddressUseMessage *) message;
 314
 315   address_length = ntohs (m->address_length);
 316   plugin_name_length = ntohs (m->plugin_name_length);
 317
 318   address = (const char *) &m[1];
 319   if (plugin_name_length != 0)
 320     plugin_name = &address[address_length];
 321   else
 322     plugin_name = "";
 323
 324   if ((address_length + plugin_name_length +
 325        sizeof (struct AddressUseMessage) != ntohs (message->size)) ||
 326       ((plugin_name_length > 0) &&
 327       (plugin_name[plugin_name_length - 1] != '\0')))
 328   {
 329     GNUNET_break (0);
 330     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 331     return;
 332   }
 333
 334   in_use = ntohs (m->in_use);
 335   res = GAS_addresses_in_use (&m->peer,
 336                              plugin_name,
 337                              address,
 338                              address_length,
 339                              ntohl (m->session_id),
 340                              in_use);
 341
 342   if (res == GNUNET_OK)
 343     GNUNET_SERVER_receive_done (client, GNUNET_OK);
 344   else
 345   {
 346     GNUNET_break (0);
 347     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 348   }
 349
 350 }
 351
 352 /**
 353  * Handle 'address destroyed' messages from clients.
 354  *
 355  * @param cls unused, NULL
 356  * @param client client that sent the request
 357  * @param message the request message
 358  */
 359 void
 360 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
 361                               const struct GNUNET_MessageHeader *message)
 362 {
 363   const struct AddressDestroyedMessage *m;
 364   struct SessionReleaseMessage srm;
 365   const char *address;
 366   const char *plugin_name;
 367   uint16_t address_length;
 368   uint16_t plugin_name_length;
 369   uint16_t size;
 370
 371   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message of size %u %u\n",
 372               "ADDRESS_DESTROYED", ntohs (message->size),
 373               sizeof (struct AddressDestroyedMessage));
 374   size = ntohs (message->size);
 375   if ((size < sizeof (struct AddressDestroyedMessage)) || (client != my_client))
 376   {
 377     GNUNET_break (0);
 378     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 379     return;
 380   }
 381   m = (const struct AddressDestroyedMessage *) message;
 382   GNUNET_break (0 == ntohl (m->reserved));
 383   address_length = ntohs (m->address_length);
 384   plugin_name_length = ntohs (m->plugin_name_length);
 385   address = (const char *) &m[1];
 386   if (plugin_name_length != 0)
 387     plugin_name = &address[address_length];
 388   else
 389     plugin_name = "";
 390   if ((address_length + plugin_name_length +
 391        sizeof (struct AddressDestroyedMessage) != ntohs (message->size)))
 392   {
 393     GNUNET_break (0);
 394     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 395     return;
 396   }
 397   if ((plugin_name_length == 0) ||
 398       (plugin_name[plugin_name_length - 1] != '\0'))
 399   {
 400     GNUNET_break (0);
 401     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 402     return;
 403   }
 404   GNUNET_STATISTICS_update (GSA_stats, "# addresses destroyed", 1, GNUNET_NO);
 405   GAS_addresses_destroy (&m->peer, plugin_name, address, address_length,
 406                          ntohl (m->session_id));
 407   if (0 != ntohl (m->session_id))
 408   {
 409     srm.header.type = ntohs (GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE);
 410     srm.header.size = ntohs (sizeof (struct SessionReleaseMessage));
 411     srm.session_id = m->session_id;
 412     srm.peer = m->peer;
 413     GNUNET_SERVER_notification_context_unicast (nc, client, &srm.header,
 414                                                 GNUNET_NO);
 415   }
 416   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 417 }
 418
 419
 420 /**
 421  * Initialize scheduling subsystem.
 422  *
 423  * @param server handle to our server
 424  */
 425 void
 426 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server)
 427 {
 428   nc = GNUNET_SERVER_notification_context_create (server, 128);
 429 }
 430
 431
 432 /**
 433  * Shutdown scheduling subsystem.
 434  */
 435 void
 436 GAS_scheduling_done ()
 437 {
 438   if (NULL != my_client)
 439   {
 440     my_client = NULL;
 441   }
 442   GNUNET_SERVER_notification_context_destroy (nc);
 443   nc = NULL;
 444
 445 }
 446
 447
 448 /* end of gnunet-service-ats_scheduling.c */