src/ats/ats_api_performance.c

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2010,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  * @file ats/ats_api_performance.c
  22  * @brief automatic transport selection and outbound bandwidth determination
  23  * @author Christian Grothoff
  24  * @author Matthias Wachs
  25   */
  26 #include "platform.h"
  27 #include "gnunet_ats_service.h"
  28 #include "ats.h"
  29
  30
  31 /**
  32  * Message in linked list we should send to the ATS service.  The
  33  * actual binary message follows this struct.
  34  */
  35 struct PendingMessage
  36 {
  37
  38   /**
  39    * Kept in a DLL.
  40    */
  41   struct PendingMessage *next;
  42
  43   /**
  44    * Kept in a DLL.
  45    */
  46   struct PendingMessage *prev;
  47
  48   /**
  49    * Size of the message.
  50    */
  51   size_t size;
  52
  53   /**
  54    * Is this the 'ATS_START' message?
  55    */
  56   int is_init;
  57 };
  58
  59
  60 /**
  61  * Linked list of pending reservations.
  62  */
  63 struct GNUNET_ATS_ReservationContext
  64 {
  65
  66   /**
  67    * Kept in a DLL.
  68    */
  69   struct GNUNET_ATS_ReservationContext *next;
  70
  71   /**
  72    * Kept in a DLL.
  73    */
  74   struct GNUNET_ATS_ReservationContext *prev;
  75
  76   /**
  77    * Target peer.
  78    */
  79   struct GNUNET_PeerIdentity peer;
  80
  81   /**
  82    * Desired reservation
  83    */
  84   int32_t size;
  85
  86   /**
  87    * Function to call on result.
  88    */
  89   GNUNET_ATS_ReservationCallback rcb;
  90
  91   /**
  92    * Closure for 'rcb'
  93    */
  94   void *rcb_cls;
  95
  96   /**
  97    * Do we need to undo this reservation if it succeeded?  Set to
  98    * GNUNET_YES if a reservation is cancelled.  (at that point, 'info'
  99    * is also set to NULL; however, info will ALSO be NULL for the
 100    * reservation context that is created to undo the original request,
 101    * so 'info' being NULL cannot be used to check if undo is
 102    * required).
 103    */
 104   int undo;
 105 };
 106
 107
 108 /**
 109  * ATS Handle to obtain and/or modify performance information.
 110  */
 111 struct GNUNET_ATS_PerformanceHandle
 112 {
 113
 114   /**
 115    * Our configuration.
 116    */
 117   const struct GNUNET_CONFIGURATION_Handle *cfg;
 118
 119   /**
 120    * Callback to invoke on performance changes.
 121    */
 122   GNUNET_ATS_PeerInformationCallback infocb;
 123
 124   /**
 125    * Closure for 'infocb'.
 126    */
 127   void *infocb_cls;
 128
 129   /**
 130    * Connection to ATS service.
 131    */
 132   struct GNUNET_CLIENT_Connection *client;
 133
 134   /**
 135    * Head of list of messages for the ATS service.
 136    */
 137   struct PendingMessage *pending_head;
 138
 139   /**
 140    * Tail of list of messages for the ATS service
 141    */
 142   struct PendingMessage *pending_tail;
 143
 144   /**
 145    * Head of linked list of pending reservation requests.
 146    */
 147   struct GNUNET_ATS_ReservationContext *reservation_head;
 148
 149   /**
 150    * Tail of linked list of pending reservation requests.
 151    */
 152   struct GNUNET_ATS_ReservationContext *reservation_tail;
 153
 154   /**
 155    * Current request for transmission to ATS.
 156    */
 157   struct GNUNET_CLIENT_TransmitHandle *th;
 158
 159   /**
 160    * Task to trigger reconnect.
 161    */
 162   GNUNET_SCHEDULER_TaskIdentifier task;
 163
 164 };
 165
 166
 167 /**
 168  * Re-establish the connection to the ATS service.
 169  *
 170  * @param ph handle to use to re-connect.
 171  */
 172 static void
 173 reconnect (struct GNUNET_ATS_PerformanceHandle *ph);
 174
 175
 176 /**
 177  * Re-establish the connection to the ATS service.
 178  *
 179  * @param cls handle to use to re-connect.
 180  * @param tc scheduler context
 181  */
 182 static void
 183 reconnect_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 184 {
 185   struct GNUNET_ATS_PerformanceHandle *ph = cls;
 186
 187   ph->task = GNUNET_SCHEDULER_NO_TASK;
 188   reconnect (ph);
 189 }
 190
 191
 192 /**
 193  * Transmit messages from the message queue to the service
 194  * (if there are any, and if we are not already trying).
 195  *
 196  * @param ph handle to use
 197  */
 198 static void
 199 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph);
 200
 201
 202 /**
 203  * We can now transmit a message to ATS. Do it.
 204  *
 205  * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
 206  * @param size number of bytes we can transmit to ATS
 207  * @param buf where to copy the messages
 208  * @return number of bytes copied into buf
 209  */
 210 static size_t
 211 transmit_message_to_ats (void *cls, size_t size, void *buf)
 212 {
 213   struct GNUNET_ATS_PerformanceHandle *ph = cls;
 214   struct PendingMessage *p;
 215   size_t ret;
 216   char *cbuf;
 217
 218   ph->th = NULL;
 219   ret = 0;
 220   cbuf = buf;
 221   while ((NULL != (p = ph->pending_head)) && (p->size <= size))
 222   {
 223     memcpy (&cbuf[ret], &p[1], p->size);
 224     ret += p->size;
 225     size -= p->size;
 226     GNUNET_CONTAINER_DLL_remove (ph->pending_head, ph->pending_tail, p);
 227     GNUNET_free (p);
 228   }
 229   do_transmit (ph);
 230   return ret;
 231 }
 232
 233
 234 /**
 235  * Transmit messages from the message queue to the service
 236  * (if there are any, and if we are not already trying).
 237  *
 238  * @param ph handle to use
 239  */
 240 static void
 241 do_transmit (struct GNUNET_ATS_PerformanceHandle *ph)
 242 {
 243   struct PendingMessage *p;
 244
 245   if (NULL != ph->th)
 246     return;
 247   if (NULL == (p = ph->pending_head))
 248     return;
 249   if (NULL == ph->client)
 250     return;                     /* currently reconnecting */
 251   ph->th =
 252       GNUNET_CLIENT_notify_transmit_ready (ph->client, p->size,
 253                                            GNUNET_TIME_UNIT_FOREVER_REL,
 254                                            GNUNET_YES, &transmit_message_to_ats,
 255                                            ph);
 256 }
 257
 258
 259 /**
 260  * We received a peer information message.  Validate and process it.
 261  *
 262  * @param ph our context with the callback
 263  * @param msg the message
 264  * @return GNUNET_OK if the message was well-formed
 265  */
 266 static int
 267 process_pi_message (struct GNUNET_ATS_PerformanceHandle *ph,
 268                     const struct GNUNET_MessageHeader *msg)
 269 {
 270   const struct PeerInformationMessage *pi;
 271   const struct GNUNET_ATS_Information *atsi;
 272   const char *plugin_address;
 273   const char *plugin_name;
 274   struct GNUNET_HELLO_Address address;
 275   uint16_t plugin_address_length;
 276   uint16_t plugin_name_length;
 277   uint32_t ats_count;
 278
 279   if (ph->infocb == NULL)
 280   {
 281     GNUNET_break (0);
 282     return GNUNET_SYSERR;
 283   }
 284   if (ntohs (msg->size) < sizeof (struct PeerInformationMessage))
 285   {
 286     GNUNET_break (0);
 287     return GNUNET_SYSERR;
 288   }
 289   pi = (const struct PeerInformationMessage *) msg;
 290   ats_count = ntohl (pi->ats_count);
 291   plugin_address_length = ntohs (pi->address_length);
 292   plugin_name_length = ntohs (pi->plugin_name_length);
 293   atsi = (const struct GNUNET_ATS_Information *) &pi[1];
 294   plugin_address = (const char *) &atsi[ats_count];
 295   plugin_name = &plugin_address[plugin_address_length];
 296   if ((plugin_address_length + plugin_name_length +
 297        ats_count * sizeof (struct GNUNET_ATS_Information) +
 298        sizeof (struct PeerInformationMessage) != ntohs (msg->size)) ||
 299       (ats_count >
 300        GNUNET_SERVER_MAX_MESSAGE_SIZE / sizeof (struct GNUNET_ATS_Information))
 301       || (plugin_name[plugin_name_length - 1] != '\0'))
 302   {
 303     GNUNET_break (0);
 304     return GNUNET_SYSERR;
 305   }
 306   address.peer = pi->peer;
 307   address.address = plugin_address;
 308   address.address_length = plugin_address_length;
 309   address.transport_name = plugin_name;
 310   ph->infocb (ph->infocb_cls, &address, pi->bandwidth_out, pi->bandwidth_in,
 311               atsi, ats_count);
 312   return GNUNET_OK;
 313 }
 314
 315
 316 /**
 317  * We received a reservation result message.  Validate and process it.
 318  *
 319  * @param ph our context with the callback
 320  * @param msg the message
 321  * @return GNUNET_OK if the message was well-formed
 322  */
 323 static int
 324 process_rr_message (struct GNUNET_ATS_PerformanceHandle *ph,
 325                     const struct GNUNET_MessageHeader *msg)
 326 {
 327   const struct ReservationResultMessage *rr;
 328   struct GNUNET_ATS_ReservationContext *rc;
 329   int32_t amount;
 330
 331   if (ntohs (msg->size) < sizeof (struct ReservationResultMessage))
 332   {
 333     GNUNET_break (0);
 334     return GNUNET_SYSERR;
 335   }
 336   rr = (const struct ReservationResultMessage *) msg;
 337   amount = ntohl (rr->amount);
 338   rc = ph->reservation_head;
 339   if (0 != memcmp (&rr->peer, &rc->peer, sizeof (struct GNUNET_PeerIdentity)))
 340   {
 341     GNUNET_break (0);
 342     return GNUNET_SYSERR;
 343   }
 344   GNUNET_CONTAINER_DLL_remove (ph->reservation_head, ph->reservation_tail, rc);
 345   if ((amount == 0) || (rc->rcb != NULL))
 346   {
 347     /* tell client if not cancelled */
 348     if (rc->rcb != NULL)
 349       rc->rcb (rc->rcb_cls, &rr->peer, amount,
 350                GNUNET_TIME_relative_ntoh (rr->res_delay));
 351     GNUNET_free (rc);
 352     return GNUNET_OK;
 353   }
 354   /* amount non-zero, but client cancelled, consider undo! */
 355   if (GNUNET_YES != rc->undo)
 356   {
 357     GNUNET_free (rc);
 358     return GNUNET_OK;           /* do not try to undo failed undos or negative amounts */
 359   }
 360   GNUNET_free (rc);
 361   (void) GNUNET_ATS_reserve_bandwidth (ph, &rr->peer, -amount, NULL, NULL);
 362   return GNUNET_OK;
 363 }
 364
 365
 366 /**
 367  * Type of a function to call when we receive a message
 368  * from the service.
 369  *
 370  * @param cls the 'struct GNUNET_ATS_SchedulingHandle'
 371  * @param msg message received, NULL on timeout or fatal error
 372  */
 373 static void
 374 process_ats_message (void *cls, const struct GNUNET_MessageHeader *msg)
 375 {
 376   struct GNUNET_ATS_PerformanceHandle *ph = cls;
 377
 378   if (NULL == msg)
 379     goto reconnect;
 380   switch (ntohs (msg->type))
 381   {
 382   case GNUNET_MESSAGE_TYPE_ATS_PEER_INFORMATION:
 383     if (GNUNET_OK != process_pi_message (ph, msg))
 384       goto reconnect;
 385     break;
 386   case GNUNET_MESSAGE_TYPE_ATS_RESERVATION_RESULT:
 387     if (GNUNET_OK != process_rr_message (ph, msg))
 388       goto reconnect;
 389     break;
 390   default:
 391     GNUNET_break (0);
 392     goto reconnect;
 393     return;
 394   }
 395   GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
 396                          GNUNET_TIME_UNIT_FOREVER_REL);
 397   return;
 398 reconnect:
 399   GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
 400   ph->client = NULL;
 401   ph->task =
 402       GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_SECONDS, &reconnect_task,
 403                                     ph);
 404 }
 405
 406
 407 /**
 408  * Re-establish the connection to the ATS service.
 409  *
 410  * @param ph handle to use to re-connect.
 411  */
 412 static void
 413 reconnect (struct GNUNET_ATS_PerformanceHandle *ph)
 414 {
 415   struct PendingMessage *p;
 416   struct ClientStartMessage *init;
 417
 418   GNUNET_assert (NULL == ph->client);
 419   ph->client = GNUNET_CLIENT_connect ("ats", ph->cfg);
 420   GNUNET_assert (NULL != ph->client);
 421   GNUNET_CLIENT_receive (ph->client, &process_ats_message, ph,
 422                          GNUNET_TIME_UNIT_FOREVER_REL);
 423   if ((NULL == (p = ph->pending_head)) || (GNUNET_YES != p->is_init))
 424   {
 425     p = GNUNET_malloc (sizeof (struct PendingMessage) +
 426                        sizeof (struct ClientStartMessage));
 427     p->size = sizeof (struct ClientStartMessage);
 428     p->is_init = GNUNET_YES;
 429     init = (struct ClientStartMessage *) &p[1];
 430     init->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_START);
 431     init->header.size = htons (sizeof (struct ClientStartMessage));
 432     init->start_flag =
 433         htonl ((ph->infocb ==
 434                 NULL) ? START_FLAG_PERFORMANCE_NO_PIC :
 435                START_FLAG_PERFORMANCE_WITH_PIC);
 436     GNUNET_CONTAINER_DLL_insert (ph->pending_head, ph->pending_tail, p);
 437   }
 438   do_transmit (ph);
 439 }
 440
 441
 442
 443 /**
 444  * Get handle to access performance API of the ATS subsystem.
 445  *
 446  * @param cfg configuration to use
 447  * @param infocb function to call on allocation changes, can be NULL
 448  * @param infocb_cls closure for infocb
 449  * @return ats performance context
 450  */
 451 struct GNUNET_ATS_PerformanceHandle *
 452 GNUNET_ATS_performance_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 453                              GNUNET_ATS_PeerInformationCallback infocb,
 454                              void *infocb_cls)
 455 {
 456   struct GNUNET_ATS_PerformanceHandle *ph;
 457
 458   ph = GNUNET_malloc (sizeof (struct GNUNET_ATS_PerformanceHandle));
 459   ph->cfg = cfg;
 460   ph->infocb = infocb;
 461   ph->infocb_cls = infocb_cls;
 462   reconnect (ph);
 463   return ph;
 464 }
 465
 466
 467 /**
 468  * Client is done using the ATS performance subsystem, release resources.
 469  *
 470  * @param ph handle
 471  */
 472 void
 473 GNUNET_ATS_performance_done (struct GNUNET_ATS_PerformanceHandle *ph)
 474 {
 475   struct PendingMessage *p;
 476   struct GNUNET_ATS_ReservationContext *rc;
 477
 478   while (NULL != (p = ph->pending_head))
 479   {
 480     GNUNET_CONTAINER_DLL_remove (ph->pending_head, ph->pending_tail, p);
 481     GNUNET_free (p);
 482   }
 483   while (NULL != (rc = ph->reservation_head))
 484   {
 485     GNUNET_CONTAINER_DLL_remove (ph->reservation_head, ph->reservation_tail,
 486                                  rc);
 487     GNUNET_break (NULL == rc->rcb);
 488     GNUNET_free (rc);
 489   }
 490   if (GNUNET_SCHEDULER_NO_TASK != ph->task)
 491   {
 492     GNUNET_SCHEDULER_cancel (ph->task);
 493     ph->task = GNUNET_SCHEDULER_NO_TASK;
 494   }
 495   if (NULL != ph->client)
 496   {
 497     GNUNET_CLIENT_disconnect (ph->client, GNUNET_NO);
 498     ph->client = NULL;
 499   }
 500   GNUNET_free (ph);
 501 }
 502
 503
 504 /**
 505  * Reserve inbound bandwidth from the given peer.  ATS will look at
 506  * the current amount of traffic we receive from the peer and ensure
 507  * that the peer could add 'amount' of data to its stream.
 508  *
 509  * @param ph performance handle
 510  * @param peer identifies the peer
 511  * @param amount reserve N bytes for receiving, negative
 512  *                amounts can be used to undo a (recent) reservation;
 513  * @param rcb function to call with the resulting reservation information
 514  * @param rcb_cls closure for info
 515  * @return NULL on error
 516  * @deprecated will be replaced soon
 517  */
 518 struct GNUNET_ATS_ReservationContext *
 519 GNUNET_ATS_reserve_bandwidth (struct GNUNET_ATS_PerformanceHandle *ph,
 520                               const struct GNUNET_PeerIdentity *peer,
 521                               int32_t amount,
 522                               GNUNET_ATS_ReservationCallback rcb, void *rcb_cls)
 523 {
 524   struct GNUNET_ATS_ReservationContext *rc;
 525   struct PendingMessage *p;
 526   struct ReservationRequestMessage *m;
 527
 528   rc = GNUNET_malloc (sizeof (struct GNUNET_ATS_ReservationContext));
 529   rc->size = amount;
 530   rc->peer = *peer;
 531   rc->rcb = rcb;
 532   rc->rcb_cls = rcb_cls;
 533   if ((rcb != NULL) && (amount > 0))
 534     rc->undo = GNUNET_YES;
 535   GNUNET_CONTAINER_DLL_insert_tail (ph->reservation_head, ph->reservation_tail,
 536                                     rc);
 537
 538   p = GNUNET_malloc (sizeof (struct PendingMessage) +
 539                      sizeof (struct ReservationRequestMessage));
 540   p->size = sizeof (struct ReservationRequestMessage);
 541   p->is_init = GNUNET_NO;
 542   m = (struct ReservationRequestMessage *) &p[1];
 543   m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_RESERVATION_REQUEST);
 544   m->header.size = htons (sizeof (struct ReservationRequestMessage));
 545   m->amount = htonl (amount);
 546   m->peer = *peer;
 547   GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head, ph->pending_tail, p);
 548   do_transmit (ph);
 549   return rc;
 550 }
 551
 552
 553 /**
 554  * Cancel request for reserving bandwidth.
 555  *
 556  * @param rc context returned by the original GNUNET_ATS_reserve_bandwidth call
 557  */
 558 void
 559 GNUNET_ATS_reserve_bandwidth_cancel (struct GNUNET_ATS_ReservationContext *rc)
 560 {
 561   rc->rcb = NULL;
 562 }
 563
 564
 565 /**
 566  * Change preferences for the given peer. Preference changes are forgotten if peers
 567  * disconnect.
 568  *
 569  * @param ph performance handle
 570  * @param peer identifies the peer
 571  * @param ... 0-terminated specification of the desired changes
 572  */
 573 void
 574 GNUNET_ATS_change_preference (struct GNUNET_ATS_PerformanceHandle *ph,
 575                               const struct GNUNET_PeerIdentity *peer, ...)
 576 {
 577   struct PendingMessage *p;
 578   struct ChangePreferenceMessage *m;
 579   size_t msize;
 580   uint32_t count;
 581   struct PreferenceInformation *pi;
 582   va_list ap;
 583   enum GNUNET_ATS_PreferenceKind kind;
 584
 585   count = 0;
 586   va_start (ap, peer);
 587   while (GNUNET_ATS_PREFERENCE_END !=
 588          (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
 589   {
 590     switch (kind)
 591     {
 592     case GNUNET_ATS_PREFERENCE_BANDWIDTH:
 593       count++;
 594       (void) va_arg (ap, double);
 595
 596       break;
 597     case GNUNET_ATS_PREFERENCE_LATENCY:
 598       count++;
 599       (void) va_arg (ap, double);
 600
 601       break;
 602     default:
 603       GNUNET_assert (0);
 604     }
 605   }
 606   va_end (ap);
 607   msize =
 608       count * sizeof (struct PreferenceInformation) +
 609       sizeof (struct ChangePreferenceMessage);
 610   p = GNUNET_malloc (sizeof (struct PendingMessage) + msize);
 611   p->size = msize;
 612   p->is_init = GNUNET_NO;
 613   m = (struct ChangePreferenceMessage *) &p[1];
 614   m->header.type = htons (GNUNET_MESSAGE_TYPE_ATS_PREFERENCE_CHANGE);
 615   m->header.size = htons (msize);
 616   m->num_preferences = htonl (count);
 617   m->peer = *peer;
 618   pi = (struct PreferenceInformation *) &m[1];
 619   count = 0;
 620   va_start (ap, peer);
 621   while (GNUNET_ATS_PREFERENCE_END !=
 622          (kind = va_arg (ap, enum GNUNET_ATS_PreferenceKind)))
 623   {
 624     pi[count].preference_kind = htonl (kind);
 625     switch (kind)
 626     {
 627     case GNUNET_ATS_PREFERENCE_BANDWIDTH:
 628       pi[count].preference_value = (float) va_arg (ap, double);
 629
 630       count++;
 631       break;
 632     case GNUNET_ATS_PREFERENCE_LATENCY:
 633       pi[count].preference_value = (float) va_arg (ap, double);
 634
 635       count++;
 636       break;
 637     default:
 638       GNUNET_assert (0);
 639     }
 640   }
 641   va_end (ap);
 642   GNUNET_CONTAINER_DLL_insert_tail (ph->pending_head, ph->pending_tail, p);
 643   do_transmit (ph);
 644 }
 645
 646 /* end of ats_api_performance.c */