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   GNUNET_SERVER_client_keep (client);
  63   return GNUNET_OK;
  64 }
  65
  66
  67 /**
  68  * Unregister a client (which may have been a scheduling client,
  69  * but this is not assured).
  70  *
  71  * @param client handle of the (now dead) client
  72  */
  73 void
  74 GAS_scheduling_remove_client (struct GNUNET_SERVER_Client *client)
  75 {
  76   if (my_client != client)
  77     return;
  78   GAS_addresses_destroy_all ();
  79   GNUNET_SERVER_client_drop (client);
  80   my_client = NULL;
  81 }
  82
  83
  84 /**
  85  * Transmit the given address suggestion and bandwidth update to all scheduling
  86  * clients.
  87  *
  88  * @param peer peer for which this is an address suggestion
  89  * @param plugin_name 0-termintated string specifying the transport plugin
  90  * @param plugin_addr binary address for the plugin to use
  91  * @param plugin_addr_len number of bytes in plugin_addr
  92  * @param session_id session ID to use for the given client (other clients will see 0)
  93  * @param atsi performance data for the address
  94  * @param atsi_count number of performance records in 'ats'
  95  * @param bandwidth_out assigned outbound bandwidth
  96  * @param bandwidth_in assigned inbound bandwidth
  97  */
  98 void
  99 GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity
 100                                             *peer, const char *plugin_name,
 101                                             const void *plugin_addr,
 102                                             size_t plugin_addr_len,
 103                                             uint32_t session_id,
 104                                             const struct GNUNET_ATS_Information
 105                                             *atsi, uint32_t atsi_count,
 106                                             struct GNUNET_BANDWIDTH_Value32NBO
 107                                             bandwidth_out,
 108                                             struct GNUNET_BANDWIDTH_Value32NBO
 109                                             bandwidth_in)
 110 {
 111   struct AddressSuggestionMessage *msg;
 112   size_t plugin_name_length = strlen (plugin_name) + 1;
 113   size_t msize =
 114       sizeof (struct AddressSuggestionMessage) +
 115       atsi_count * sizeof (struct GNUNET_ATS_Information) + plugin_addr_len +
 116       plugin_name_length;
 117   char buf[msize];
 118   struct GNUNET_ATS_Information *atsp;
 119   char *addrp;
 120
 121   if (my_client == NULL)
 122     return;
 123   GNUNET_STATISTICS_update (GSA_stats, "# address suggestions made", 1,
 124                             GNUNET_NO);
 125   GNUNET_assert (msize < GNUNET_SERVER_MAX_MESSAGE_SIZE);
 126   GNUNET_assert (atsi_count <
 127                  GNUNET_SERVER_MAX_MESSAGE_SIZE /
 128                  sizeof (struct GNUNET_ATS_Information));
 129   msg = (struct AddressSuggestionMessage *) buf;
 130   msg->header.size = htons (msize);
 131   msg->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION);
 132   msg->ats_count = htonl (atsi_count);
 133   msg->peer = *peer;
 134   msg->address_length = htons (plugin_addr_len);
 135   msg->plugin_name_length = htons (plugin_name_length);
 136   msg->session_id = htonl (session_id);
 137   msg->bandwidth_out = bandwidth_out;
 138   msg->bandwidth_in = bandwidth_in;
 139   atsp = (struct GNUNET_ATS_Information *) &msg[1];
 140   memcpy (atsp, atsi, sizeof (struct GNUNET_ATS_Information) * atsi_count);
 141   addrp = (char *) &atsp[atsi_count];
 142   memcpy (addrp, plugin_addr, plugin_addr_len);
 143   strcpy (&addrp[plugin_addr_len], plugin_name);
 144   GNUNET_SERVER_notification_context_unicast (nc, my_client, &msg->header,
 145                                               GNUNET_YES);
 146 }
 147
 148
 149 /**
 150  * Handle 'request address' messages from clients.
 151  *
 152  * @param cls unused, NULL
 153  * @param client client that sent the request
 154  * @param message the request message
 155  */
 156 void
 157 GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
 158                             const struct GNUNET_MessageHeader *message)
 159 {
 160   const struct RequestAddressMessage *msg =
 161       (const struct RequestAddressMessage *) message;
 162
 163   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 164               "REQUEST_ADDRESS");
 165   GNUNET_STATISTICS_update (GSA_stats, "# address requests received", 1,
 166                             GNUNET_NO);
 167   GNUNET_break (0 == ntohl (msg->reserved));
 168   GAS_addresses_request_address (&msg->peer);
 169   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 170 }
 171
 172
 173 /**
 174  * Handle 'request address' messages from clients.
 175  *
 176  * @param cls unused, NULL
 177  * @param client client that sent the request
 178  * @param message the request message
 179  */
 180 void
 181 GAS_handle_request_address_cancel (void *cls, struct GNUNET_SERVER_Client *client,
 182                             const struct GNUNET_MessageHeader *message)
 183 {
 184   const struct RequestAddressMessage *msg =
 185       (const struct RequestAddressMessage *) message;
 186
 187   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 188               "REQUEST_ADDRESS_CANCEL");
 189   GNUNET_break (0 == ntohl (msg->reserved));
 190
 191   /* TODO */
 192
 193   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 194 }
 195
 196
 197 /**
 198  * Handle 'address update' messages from clients.
 199  *
 200  * @param cls unused, NULL
 201  * @param client client that sent the request
 202  * @param message the request message
 203  */
 204 void
 205 GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
 206                            const struct GNUNET_MessageHeader *message)
 207 {
 208   const struct AddressUpdateMessage *m;
 209   const struct GNUNET_ATS_Information *atsi;
 210   const char *address;
 211   const char *plugin_name;
 212   uint16_t address_length;
 213   uint16_t plugin_name_length;
 214   uint32_t ats_count;
 215   uint16_t size;
 216
 217   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message\n",
 218               "ADDRESS_UPDATE");
 219   size = ntohs (message->size);
 220   if (size < sizeof (struct AddressUpdateMessage))
 221   {
 222     GNUNET_break (0);
 223     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 224     return;
 225   }
 226   m = (const struct AddressUpdateMessage *) message;
 227   ats_count = ntohl (m->ats_count);
 228   address_length = ntohs (m->address_length);
 229   plugin_name_length = ntohs (m->plugin_name_length);
 230   atsi = (const struct GNUNET_ATS_Information *) &m[1];
 231   address = (const char *) &atsi[ats_count];
 232   if (plugin_name_length != 0)
 233     plugin_name = &address[address_length];
 234   else
 235     plugin_name = "";
 236   if ((address_length + plugin_name_length +
 237        ats_count * sizeof (struct GNUNET_ATS_Information) +
 238        sizeof (struct AddressUpdateMessage) != ntohs (message->size)) ||
 239       (ats_count >
 240        GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
 241       || (plugin_name[plugin_name_length - 1] != '\0'))
 242   {
 243     GNUNET_break (0);
 244     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 245     return;
 246   }
 247   GNUNET_STATISTICS_update (GSA_stats, "# address updates received", 1,
 248                             GNUNET_NO);
 249   GAS_addresses_update (&m->peer, plugin_name, address, address_length,
 250                         ntohl (m->session_id), atsi, ats_count);
 251   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 252 }
 253
 254
 255 /**
 256  * Handle 'address in use' messages from clients.
 257  *
 258  * @param cls unused, NULL
 259  * @param client client that sent the request
 260  * @param message the request message
 261  */
 262 void
 263 GAS_handle_address_in_use (void *cls, struct GNUNET_SERVER_Client *client,
 264                            const struct GNUNET_MessageHeader *message)
 265 {
 266   const struct AddressUseMessage *m;
 267   const char *address;
 268   const char *plugin_name;
 269   uint16_t address_length;
 270   uint16_t plugin_name_length;
 271
 272   uint16_t size;
 273   uint16_t in_use;
 274
 275   size = ntohs (message->size);
 276   if (size < sizeof (struct AddressUseMessage))
 277   {
 278     GNUNET_break (0);
 279     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 280     return;
 281   }
 282   m = (const struct AddressUseMessage *) message;
 283
 284   address_length = ntohs (m->address_length);
 285   plugin_name_length = ntohs (m->plugin_name_length);
 286
 287   address = (const char *) &m[1];
 288   if (plugin_name_length != 0)
 289     plugin_name = &address[address_length];
 290   else
 291     plugin_name = "";
 292
 293   if ((address_length + plugin_name_length +
 294        sizeof (struct AddressUseMessage) != ntohs (message->size)) ||
 295       (plugin_name[plugin_name_length - 1] != '\0'))
 296   {
 297     GNUNET_break (0);
 298     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 299     return;
 300   }
 301
 302   in_use = ntohs (m->in_use);
 303   GAS_addresses_in_use (&m->peer,
 304                         plugin_name,
 305                         address,
 306                         address_length,
 307                         ntohl (m->session_id),
 308                         in_use);
 309
 310   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 311 }
 312
 313 /**
 314  * Handle 'address destroyed' messages from clients.
 315  *
 316  * @param cls unused, NULL
 317  * @param client client that sent the request
 318  * @param message the request message
 319  */
 320 void
 321 GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
 322                               const struct GNUNET_MessageHeader *message)
 323 {
 324   const struct AddressDestroyedMessage *m;
 325   struct SessionReleaseMessage srm;
 326   const char *address;
 327   const char *plugin_name;
 328   uint16_t address_length;
 329   uint16_t plugin_name_length;
 330   uint16_t size;
 331
 332   GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Received `%s' message of size %u %u\n",
 333               "ADDRESS_DESTROYED", ntohs (message->size),
 334               sizeof (struct AddressDestroyedMessage));
 335   size = ntohs (message->size);
 336   if ((size < sizeof (struct AddressDestroyedMessage)) || (client != my_client))
 337   {
 338     GNUNET_break (0);
 339     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 340     return;
 341   }
 342   m = (const struct AddressDestroyedMessage *) message;
 343   GNUNET_break (0 == ntohl (m->reserved));
 344   address_length = ntohs (m->address_length);
 345   plugin_name_length = ntohs (m->plugin_name_length);
 346   address = (const char *) &m[1];
 347   if (plugin_name_length != 0)
 348     plugin_name = &address[address_length];
 349   else
 350     plugin_name = "";
 351   if ((address_length + plugin_name_length +
 352        sizeof (struct AddressDestroyedMessage) != ntohs (message->size)))
 353   {
 354     GNUNET_break (0);
 355     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 356     return;
 357   }
 358   if ((plugin_name_length != 0) &&
 359       (plugin_name[plugin_name_length - 1] != '\0'))
 360   {
 361     GNUNET_break (0);
 362     GNUNET_SERVER_receive_done (client, GNUNET_SYSERR);
 363     return;
 364   }
 365   GNUNET_STATISTICS_update (GSA_stats, "# addresses destroyed", 1, GNUNET_NO);
 366   GAS_addresses_destroy (&m->peer, plugin_name, address, address_length,
 367                          ntohl (m->session_id));
 368   if (0 != ntohl (m->session_id))
 369   {
 370     srm.header.type = ntohs (GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE);
 371     srm.header.size = ntohs (sizeof (struct SessionReleaseMessage));
 372     srm.session_id = m->session_id;
 373     srm.peer = m->peer;
 374     GNUNET_SERVER_notification_context_unicast (nc, client, &srm.header,
 375                                                 GNUNET_NO);
 376   }
 377   GNUNET_SERVER_receive_done (client, GNUNET_OK);
 378 }
 379
 380
 381 /**
 382  * Initialize scheduling subsystem.
 383  *
 384  * @param server handle to our server
 385  */
 386 void
 387 GAS_scheduling_init (struct GNUNET_SERVER_Handle *server)
 388 {
 389   nc = GNUNET_SERVER_notification_context_create (server, 128);
 390 }
 391
 392
 393 /**
 394  * Shutdown scheduling subsystem.
 395  */
 396 void
 397 GAS_scheduling_done ()
 398 {
 399   GNUNET_SERVER_notification_context_destroy (nc);
 400   nc = NULL;
 401 }
 402
 403
 404 /* end of gnunet-service-ats_scheduling.c */