src/ats/ats_api_scheduling.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010-2015 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20 /**
  21  * @file ats/ats_api_scheduling.c
  22  * @brief automatic transport selection and outbound bandwidth determination
  23  * @author Christian Grothoff
  24  * @author Matthias Wachs
  25  *
  26  * TODO:
  27  * - we could avoid a linear scan over the
  28  *   active addresses in some cases, so if
  29  *   there is need, we can still optimize here
  30  * - we might want to split off the logic to
  31  *   determine LAN vs. WAN, as it has nothing
  32  *   to do with accessing the ATS service.
  33  */
  34 #include "platform.h"
  35 #include "gnunet_ats_service.h"
  36 #include "ats.h"
  37
  38 /**
  39  * How frequently do we scan the interfaces for changes to the addresses?
  40  */
  41 #define INTERFACE_PROCESSING_INTERVAL GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 2)
  42
  43 #define LOG(kind,...) GNUNET_log_from(kind, "ats-scheduling-api", __VA_ARGS__)
  44
  45 /**
  46  * Session ID we use if there is no session / slot.
  47  */
  48 #define NOT_FOUND 0
  49
  50
  51 /**
  52  * Information we track per address, incoming or outgoing.  It also
  53  * doesn't matter if we have a session, any address that ATS is
  54  * allowed to suggest right now should be tracked.
  55  */
  56 struct GNUNET_ATS_AddressRecord
  57 {
  58
  59   /**
  60    * Scheduling handle this address record belongs to.
  61    */
  62   struct GNUNET_ATS_SchedulingHandle *sh;
  63
  64   /**
  65    * Address data.
  66    */
  67   struct GNUNET_HELLO_Address *address;
  68
  69   /**
  70    * Session handle.  NULL if we have an address but no
  71    * active session for this address.
  72    */
  73   struct GNUNET_ATS_Session *session;
  74
  75   /**
  76    * Performance data about the address.
  77    */
  78   struct GNUNET_ATS_PropertiesNBO properties;
  79
  80   /**
  81    * Which slot (index) in the session array does
  82    * this record correspond to?
  83    * FIXME: a linear search on this is really crappy!
  84    * Maybe switch to a 64-bit global counter and be
  85    * done with it?  Or does that then cause too much
  86    * trouble on the ATS-service side?
  87    */
  88   uint32_t slot;
  89
  90   /**
  91    * We're about to destroy this address record, just ATS does
  92    * not know this yet.  Once ATS confirms its destruction,
  93    * we can clean up.
  94    */
  95   int in_destroy;
  96 };
  97
  98
  99 /**
 100  * Handle to the ATS subsystem for bandwidth/transport scheduling information.
 101  */
 102 struct GNUNET_ATS_SchedulingHandle
 103 {
 104
 105   /**
 106    * Our configuration.
 107    */
 108   const struct GNUNET_CONFIGURATION_Handle *cfg;
 109
 110   /**
 111    * Callback to invoke on suggestions.
 112    */
 113   GNUNET_ATS_AddressSuggestionCallback suggest_cb;
 114
 115   /**
 116    * Closure for @e suggest_cb.
 117    */
 118   void *suggest_cb_cls;
 119
 120   /**
 121    * Connection to ATS service.
 122    */
 123   struct GNUNET_CLIENT_Connection *client;
 124
 125   /**
 126    * Message queue for sending requests to the ATS service.
 127    */
 128   struct GNUNET_MQ_Handle *mq;
 129
 130   /**
 131    * Array of session objects (we need to translate them to numbers and back
 132    * for the protocol; the offset in the array is the session number on the
 133    * network).  Index 0 is always NULL and reserved to represent the NULL pointer.
 134    * Unused entries are also NULL.
 135    */
 136   struct GNUNET_ATS_AddressRecord **session_array;
 137
 138   /**
 139    * Task to trigger reconnect.
 140    */
 141   struct GNUNET_SCHEDULER_Task *task;
 142
 143   /**
 144    * Reconnect backoff delay.
 145    */
 146   struct GNUNET_TIME_Relative backoff;
 147
 148   /**
 149    * Size of the @e session_array.
 150    */
 151   unsigned int session_array_size;
 152
 153 };
 154
 155
 156 /**
 157  * Re-establish the connection to the ATS service.
 158  *
 159  * @param sh handle to use to re-connect.
 160  */
 161 static void
 162 reconnect (struct GNUNET_ATS_SchedulingHandle *sh);
 163
 164
 165 /**
 166  * Re-establish the connection to the ATS service.
 167  *
 168  * @param cls handle to use to re-connect.
 169  */
 170 static void
 171 reconnect_task (void *cls)
 172 {
 173   struct GNUNET_ATS_SchedulingHandle *sh = cls;
 174
 175   sh->task = NULL;
 176   reconnect (sh);
 177 }
 178
 179
 180 /**
 181  * Disconnect from ATS and then reconnect.
 182  *
 183  * @param sh our handle
 184  */
 185 static void
 186 force_reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
 187 {
 188   if (NULL != sh->mq)
 189   {
 190     GNUNET_MQ_destroy (sh->mq);
 191     sh->mq = NULL;
 192   }
 193   if (NULL != sh->client)
 194   {
 195     GNUNET_CLIENT_disconnect (sh->client);
 196     sh->client = NULL;
 197   }
 198   sh->suggest_cb (sh->suggest_cb_cls,
 199                   NULL, NULL, NULL,
 200                   GNUNET_BANDWIDTH_ZERO,
 201                   GNUNET_BANDWIDTH_ZERO);
 202   sh->backoff = GNUNET_TIME_STD_BACKOFF (sh->backoff);
 203   sh->task = GNUNET_SCHEDULER_add_delayed (sh->backoff,
 204                                            &reconnect_task,
 205                                            sh);
 206 }
 207
 208
 209 /**
 210  * Find the session object corresponding to the given session ID.
 211  *
 212  * @param sh our handle
 213  * @param session_id current session ID
 214  * @param peer peer the session belongs to
 215  * @return the session object (or NULL)
 216  */
 217 static struct GNUNET_ATS_AddressRecord *
 218 find_session (struct GNUNET_ATS_SchedulingHandle *sh,
 219               uint32_t session_id,
 220               const struct GNUNET_PeerIdentity *peer)
 221 {
 222   struct GNUNET_ATS_AddressRecord *ar;
 223
 224   if (session_id >= sh->session_array_size)
 225   {
 226     GNUNET_break (0);
 227     return NULL;
 228   }
 229   if (0 == session_id)
 230     return NULL;
 231   ar = sh->session_array[session_id];
 232   if (NULL == ar)
 233   {
 234     GNUNET_break (0);
 235     return NULL;
 236   }
 237   if (NULL == ar->address)
 238   {
 239     /* address was destroyed in the meantime, this can happen
 240        as we communicate asynchronously with the ATS service. */
 241     return NULL;
 242   }
 243   if (0 != memcmp (peer,
 244                    &ar->address->peer,
 245                    sizeof (struct GNUNET_PeerIdentity)))
 246   {
 247     GNUNET_break (0);
 248     return NULL;
 249   }
 250   return ar;
 251 }
 252
 253
 254 /**
 255  * Get an available session ID.
 256  *
 257  * @param sh our handle
 258  * @return an unused slot, but never NOT_FOUND (0)
 259  */
 260 static uint32_t
 261 find_empty_session_slot (struct GNUNET_ATS_SchedulingHandle *sh)
 262 {
 263   static uint32_t off;
 264   uint32_t i;
 265
 266   i = 0;
 267   while ( ( (NOT_FOUND == off) ||
 268             (NULL != sh->session_array[off % sh->session_array_size]) ) &&
 269           (i < sh->session_array_size) )
 270   {
 271     off++;
 272     i++;
 273   }
 274   if ( (NOT_FOUND != off % sh->session_array_size) &&
 275        (NULL == sh->session_array[off % sh->session_array_size]) )
 276     return off;
 277   i = sh->session_array_size;
 278   GNUNET_array_grow (sh->session_array,
 279                      sh->session_array_size,
 280                      sh->session_array_size * 2);
 281   return i;
 282 }
 283
 284
 285 /**
 286  * Get the ID for the given session object.
 287  *
 288  * @param sh our handle
 289  * @param session session object
 290  * @param address the address we are looking for
 291  * @return the session id or NOT_FOUND for error
 292  */
 293 static uint32_t
 294 find_session_id (struct GNUNET_ATS_SchedulingHandle *sh,
 295                  struct GNUNET_ATS_Session *session,
 296                  const struct GNUNET_HELLO_Address *address)
 297 {
 298   uint32_t i;
 299
 300   if (NULL == address)
 301   {
 302     GNUNET_break (0);
 303     return NOT_FOUND;
 304   }
 305   for (i = 1; i < sh->session_array_size; i++)
 306     if ( (NULL != sh->session_array[i]) &&
 307          (GNUNET_NO == sh->session_array[i]->in_destroy) &&
 308          ( (session == sh->session_array[i]->session) ||
 309            (NULL == sh->session_array[i]->session) ) &&
 310          (0 == memcmp (&address->peer,
 311                        &sh->session_array[i]->address->peer,
 312                        sizeof (struct GNUNET_PeerIdentity))) &&
 313          (0 == GNUNET_HELLO_address_cmp (address,
 314                                          sh->session_array[i]->address)) )
 315       return i;
 316   return NOT_FOUND;
 317 }
 318
 319
 320 /**
 321  * Release the session slot from the session table (ATS service is
 322  * also done using it).
 323  *
 324  * @param sh our handle
 325  * @param session_id identifies session that is no longer valid
 326  */
 327 static void
 328 release_session (struct GNUNET_ATS_SchedulingHandle *sh,
 329                  uint32_t session_id)
 330 {
 331   struct GNUNET_ATS_AddressRecord *ar;
 332
 333   if (NOT_FOUND == session_id)
 334     return;
 335   if (session_id >= sh->session_array_size)
 336   {
 337     GNUNET_break (0);
 338     force_reconnect (sh);
 339     return;
 340   }
 341   /* this slot should have been removed from remove_session before */
 342   ar = sh->session_array[session_id];
 343   if (NULL != ar->session)
 344   {
 345     GNUNET_break (0);
 346     force_reconnect (sh);
 347     return;
 348   }
 349   GNUNET_HELLO_address_free (ar->address);
 350   GNUNET_free (ar);
 351   sh->session_array[session_id] = NULL;
 352 }
 353
 354
 355 /**
 356  * Type of a function to call when we receive a session release
 357  * message from the service.
 358  *
 359  * @param cls the `struct GNUNET_ATS_SchedulingHandle`
 360  * @param msg message received, NULL on timeout or fatal error
 361  */
 362 static void
 363 process_ats_session_release_message (void *cls,
 364                                      const struct GNUNET_MessageHeader *msg)
 365 {
 366   struct GNUNET_ATS_SchedulingHandle *sh = cls;
 367   const struct GNUNET_ATS_SessionReleaseMessage *srm;
 368
 369   srm = (const struct GNUNET_ATS_SessionReleaseMessage *) msg;
 370   /* Note: peer field in srm not necessary right now,
 371      but might be good to have in the future */
 372   release_session (sh,
 373                    ntohl (srm->session_id));
 374 }
 375
 376
 377 /**
 378  * Type of a function to call when we receive a address suggestion
 379  * message from the service.
 380  *
 381  * @param cls the `struct GNUNET_ATS_SchedulingHandle`
 382  * @param msg message received, NULL on timeout or fatal error
 383  */
 384 static void
 385 process_ats_address_suggestion_message (void *cls,
 386                                         const struct GNUNET_MessageHeader *msg)
 387 {
 388   struct GNUNET_ATS_SchedulingHandle *sh = cls;
 389   const struct AddressSuggestionMessage *m;
 390   struct GNUNET_ATS_AddressRecord *ar;
 391   uint32_t session_id;
 392
 393   m = (const struct AddressSuggestionMessage *) msg;
 394   session_id = ntohl (m->session_id);
 395   if (0 == session_id)
 396   {
 397     GNUNET_break (0);
 398     force_reconnect (sh);
 399     return;
 400   }
 401   ar = find_session (sh,
 402                      session_id,
 403                      &m->peer);
 404   if (NULL == ar)
 405   {
 406     GNUNET_break (0);
 407     force_reconnect (sh);
 408     return;
 409   }
 410   if (NULL == sh->suggest_cb)
 411     return;
 412   if (GNUNET_YES == ar->in_destroy)
 413   {
 414     /* ignore suggestion, as this address is dying, unless BW is 0,
 415        in that case signal 'disconnect' via BW 0 */
 416     if ( (0 == ntohl (m->bandwidth_out.value__)) &&
 417          (0 == ntohl (m->bandwidth_in.value__)) )
 418     {
 419       LOG (GNUNET_ERROR_TYPE_DEBUG,
 420            "ATS suggests disconnect from peer `%s' with BW %u/%u\n",
 421            GNUNET_i2s (&ar->address->peer),
 422            (unsigned int) ntohl (m->bandwidth_out.value__),
 423            (unsigned int) ntohl (m->bandwidth_in.value__));
 424       sh->suggest_cb (sh->suggest_cb_cls,
 425                       &m->peer,
 426                       NULL,
 427                       NULL,
 428                       m->bandwidth_out,
 429                       m->bandwidth_in);
 430     }
 431     return;
 432   }
 433   if ( (NULL == ar->session) &&
 434        (GNUNET_HELLO_address_check_option (ar->address,
 435                                            GNUNET_HELLO_ADDRESS_INFO_INBOUND)) )
 436   {
 437     GNUNET_break (0);
 438     return;
 439   }
 440   sh->backoff = GNUNET_TIME_UNIT_ZERO;
 441   LOG (GNUNET_ERROR_TYPE_DEBUG,
 442        "ATS suggests address slot %u for peer `%s' using plugin %s\n",
 443        ar->slot,
 444        GNUNET_i2s (&ar->address->peer),
 445        ar->address->transport_name);
 446   sh->suggest_cb (sh->suggest_cb_cls,
 447                   &m->peer,
 448                   ar->address,
 449                   ar->session,
 450                   m->bandwidth_out,
 451                   m->bandwidth_in);
 452 }
 453
 454
 455 /**
 456  * We encountered an error handling the MQ to the
 457  * ATS service.  Reconnect.
 458  *
 459  * @param cls the `struct GNUNET_ATS_SchedulingHandle`
 460  * @param error details about the error
 461  */
 462 static void
 463 error_handler (void *cls,
 464                enum GNUNET_MQ_Error error)
 465 {
 466   struct GNUNET_ATS_SchedulingHandle *sh = cls;
 467
 468   LOG (GNUNET_ERROR_TYPE_DEBUG,
 469        "ATS connection died (code %d), reconnecting\n",
 470        (int) error);
 471   force_reconnect (sh);
 472 }
 473
 474
 475 /**
 476  * Generate and transmit the `struct AddressAddMessage` for the given
 477  * address record.
 478  *
 479  * @param sh the scheduling handle to use for transmission
 480  * @param ar the address to inform the ATS service about
 481  */
 482 static void
 483 send_add_address_message (struct GNUNET_ATS_SchedulingHandle *sh,
 484                           const struct GNUNET_ATS_AddressRecord *ar)
 485 {
 486   struct GNUNET_MQ_Envelope *ev;
 487   struct AddressAddMessage *m;
 488   char *pm;
 489   size_t namelen;
 490   size_t msize;
 491
 492   if (NULL == sh->mq)
 493     return; /* disconnected, skip for now */
 494   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != ar->properties.scope);
 495   namelen = strlen (ar->address->transport_name) + 1;
 496   msize = ar->address->address_length + namelen;
 497   ev = GNUNET_MQ_msg_extra (m, msize, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD);
 498   m->peer = ar->address->peer;
 499   m->address_length = htons (ar->address->address_length);
 500   m->address_local_info = htonl ((uint32_t) ar->address->local_info);
 501   m->plugin_name_length = htons (namelen);
 502   m->session_id = htonl (ar->slot);
 503   m->properties = ar->properties;
 504
 505   LOG (GNUNET_ERROR_TYPE_DEBUG,
 506        "Adding address for peer `%s', plugin `%s', session %p slot %u\n",
 507        GNUNET_i2s (&ar->address->peer),
 508        ar->address->transport_name,
 509        ar->session,
 510        ar->slot);
 511   pm = (char *) &m[1];
 512   memcpy (pm,
 513           ar->address->address,
 514           ar->address->address_length);
 515   if (NULL != ar->address->transport_name)
 516     memcpy (&pm[ar->address->address_length],
 517             ar->address->transport_name,
 518             namelen);
 519   GNUNET_MQ_send (sh->mq, ev);
 520 }
 521
 522
 523 /**
 524  * Re-establish the connection to the ATS service.
 525  *
 526  * @param sh handle to use to re-connect.
 527  */
 528 static void
 529 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
 530 {
 531   static const struct GNUNET_MQ_MessageHandler handlers[] =
 532     { { &process_ats_session_release_message,
 533         GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE,
 534         sizeof (struct GNUNET_ATS_SessionReleaseMessage) },
 535       { &process_ats_address_suggestion_message,
 536         GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION,
 537         sizeof (struct AddressSuggestionMessage) },
 538       { NULL, 0, 0 } };
 539   struct GNUNET_MQ_Envelope *ev;
 540   struct ClientStartMessage *init;
 541   unsigned int i;
 542   struct GNUNET_ATS_AddressRecord *ar;
 543
 544   GNUNET_assert (NULL == sh->client);
 545   sh->client = GNUNET_CLIENT_connect ("ats",
 546                                       sh->cfg);
 547   if (NULL == sh->client)
 548   {
 549     GNUNET_break (0);
 550     force_reconnect (sh);
 551     return;
 552   }
 553   sh->mq = GNUNET_MQ_queue_for_connection_client (sh->client,
 554                                                   handlers,
 555                                                   &error_handler,
 556                                                   sh);
 557   ev = GNUNET_MQ_msg (init,
 558                       GNUNET_MESSAGE_TYPE_ATS_START);
 559   init->start_flag = htonl (START_FLAG_SCHEDULING);
 560   GNUNET_MQ_send (sh->mq, ev);
 561   if (NULL == sh->mq)
 562     return;
 563   for (i=0;i<sh->session_array_size;i++)
 564   {
 565     ar = sh->session_array[i];
 566     if (NULL == ar)
 567       continue;
 568     send_add_address_message (sh, ar);
 569     if (NULL == sh->mq)
 570       return;
 571   }
 572 }
 573
 574
 575 /**
 576  * Initialize the ATS subsystem.
 577  *
 578  * @param cfg configuration to use
 579  * @param suggest_cb notification to call whenever the suggestation changed
 580  * @param suggest_cb_cls closure for @a suggest_cb
 581  * @return ats context
 582  */
 583 struct GNUNET_ATS_SchedulingHandle *
 584 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 585                             GNUNET_ATS_AddressSuggestionCallback suggest_cb,
 586                             void *suggest_cb_cls)
 587 {
 588   struct GNUNET_ATS_SchedulingHandle *sh;
 589
 590   sh = GNUNET_new (struct GNUNET_ATS_SchedulingHandle);
 591   sh->cfg = cfg;
 592   sh->suggest_cb = suggest_cb;
 593   sh->suggest_cb_cls = suggest_cb_cls;
 594   GNUNET_array_grow (sh->session_array,
 595                      sh->session_array_size,
 596                      4);
 597   reconnect (sh);
 598   return sh;
 599 }
 600
 601
 602 /**
 603  * Client is done with ATS scheduling, release resources.
 604  *
 605  * @param sh handle to release
 606  */
 607 void
 608 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
 609 {
 610   struct GNUNET_ATS_AddressRecord *ar;
 611   unsigned int i;
 612
 613   if (NULL != sh->mq)
 614   {
 615     GNUNET_MQ_destroy (sh->mq);
 616     sh->mq = NULL;
 617   }
 618   if (NULL != sh->client)
 619   {
 620     GNUNET_CLIENT_disconnect (sh->client);
 621     sh->client = NULL;
 622   }
 623   if (NULL != sh->task)
 624   {
 625     GNUNET_SCHEDULER_cancel (sh->task);
 626     sh->task = NULL;
 627   }
 628   for (i=0;i<sh->session_array_size;i++)
 629   {
 630     if (NULL != (ar = sh->session_array[i]))
 631     {
 632       GNUNET_HELLO_address_free (ar->address);
 633       GNUNET_free (ar);
 634       sh->session_array[i] = NULL;
 635     }
 636   }
 637   GNUNET_array_grow (sh->session_array,
 638                      sh->session_array_size,
 639                      0);
 640   GNUNET_free (sh);
 641 }
 642
 643
 644 /**
 645  * We have a new address ATS should know. Addresses have to be added
 646  * with this function before they can be: updated, set in use and
 647  * destroyed.
 648  *
 649  * @param sh handle
 650  * @param address the address
 651  * @param session session handle, can be NULL
 652  * @param prop performance data for the address
 653  * @return handle to the address representation inside ATS, NULL
 654  *         on error (i.e. ATS knows this exact address already)
 655  */
 656 struct GNUNET_ATS_AddressRecord *
 657 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
 658                         const struct GNUNET_HELLO_Address *address,
 659                         struct GNUNET_ATS_Session *session,
 660                         const struct GNUNET_ATS_Properties *prop)
 661 {
 662   struct GNUNET_ATS_AddressRecord *ar;
 663   size_t namelen;
 664   size_t msize;
 665   uint32_t s;
 666
 667   if (NULL == address)
 668   {
 669     /* we need a valid address */
 670     GNUNET_break (0);
 671     return NULL;
 672   }
 673   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != prop->scope);
 674   namelen = strlen (address->transport_name) + 1;
 675   msize = address->address_length + namelen;
 676   if ((msize + sizeof (struct AddressUpdateMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
 677       (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
 678       (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) )
 679   {
 680     /* address too large for us, this should not happen */
 681     GNUNET_break (0);
 682     return NULL;
 683   }
 684
 685   if (NOT_FOUND !=
 686       find_session_id (sh,
 687                        session,
 688                        address))
 689   {
 690     /* Already existing, nothing todo, but this should not happen */
 691     GNUNET_break (0);
 692     return NULL;
 693   }
 694   s = find_empty_session_slot (sh);
 695   ar = GNUNET_new (struct GNUNET_ATS_AddressRecord);
 696   ar->sh = sh;
 697   ar->slot = s;
 698   ar->session = session;
 699   ar->address = GNUNET_HELLO_address_copy (address);
 700   GNUNET_ATS_properties_hton (&ar->properties,
 701                               prop);
 702   sh->session_array[s] = ar;
 703   send_add_address_message (sh, ar);
 704   return ar;
 705 }
 706
 707
 708 /**
 709  * An address was used to initiate a session.
 710  *
 711  * @param ar address record to update information for
 712  * @param session session handle
 713  */
 714 void
 715 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
 716                                 struct GNUNET_ATS_Session *session)
 717 {
 718   GNUNET_break (NULL == ar->session);
 719   ar->session = session;
 720 }
 721
 722
 723 /**
 724  * A session was destroyed, disassociate it from the
 725  * given address record.  If this was an incoming
 726  * addess, destroy the address as well.
 727  *
 728  * @param ar address record to update information for
 729  * @param session session handle
 730  * @return #GNUNET_YES if the @a ar was destroyed because
 731  *                     it was an incoming address,
 732  *         #GNUNET_NO if the @ar was kept because we can
 733  *                    use it still to establish a new session
 734  */
 735 int
 736 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
 737                                 struct GNUNET_ATS_Session *session)
 738 {
 739   GNUNET_assert (session == ar->session);
 740   ar->session = NULL;
 741   if (GNUNET_HELLO_address_check_option (ar->address,
 742                                          GNUNET_HELLO_ADDRESS_INFO_INBOUND))
 743   {
 744     GNUNET_ATS_address_destroy (ar);
 745     return GNUNET_YES;
 746   }
 747   return GNUNET_NO;
 748 }
 749
 750
 751 /**
 752  * We have updated performance statistics for a given address.  Note
 753  * that this function can be called for addresses that are currently
 754  * in use as well as addresses that are valid but not actively in use.
 755  * Furthermore, the peer may not even be connected to us right now (in
 756  * which case the call may be ignored or the information may be stored
 757  * for later use).  Update bandwidth assignments.
 758  *
 759  * @param ar address record to update information for
 760  * @param prop performance data for the address
 761  */
 762 void
 763 GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
 764                            const struct GNUNET_ATS_Properties *prop)
 765 {
 766   struct GNUNET_ATS_SchedulingHandle *sh = ar->sh;
 767   struct GNUNET_MQ_Envelope *ev;
 768   struct AddressUpdateMessage *m;
 769
 770   LOG (GNUNET_ERROR_TYPE_DEBUG,
 771        "Updating address for peer `%s', plugin `%s', session %p slot %u\n",
 772        GNUNET_i2s (&ar->address->peer),
 773        ar->address->transport_name,
 774        ar->session,
 775        ar->slot);
 776   GNUNET_break (GNUNET_ATS_NET_UNSPECIFIED != prop->scope);
 777   GNUNET_ATS_properties_hton (&ar->properties,
 778                               prop);
 779   if (NULL == sh->mq)
 780     return; /* disconnected, skip for now */
 781   ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
 782   m->session_id = htonl (ar->slot);
 783   m->peer = ar->address->peer;
 784   m->properties = ar->properties;
 785   GNUNET_MQ_send (sh->mq,
 786                   ev);
 787 }
 788
 789
 790 /**
 791  * An address got destroyed, stop using it as a valid address.
 792  *
 793  * @param ar address to destroy
 794  */
 795 void
 796 GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar)
 797 {
 798   struct GNUNET_ATS_SchedulingHandle *sh = ar->sh;
 799   struct GNUNET_MQ_Envelope *ev;
 800   struct AddressDestroyedMessage *m;
 801
 802   LOG (GNUNET_ERROR_TYPE_DEBUG,
 803        "Deleting address for peer `%s', plugin `%s', slot %u session %p\n",
 804        GNUNET_i2s (&ar->address->peer),
 805        ar->address->transport_name,
 806        ar->slot,
 807        ar->session);
 808   GNUNET_break (NULL == ar->session);
 809   ar->session = NULL;
 810   ar->in_destroy = GNUNET_YES;
 811   if (NULL == sh->mq)
 812     return;
 813   ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
 814   m->session_id = htonl (ar->slot);
 815   m->peer = ar->address->peer;
 816   GNUNET_MQ_send (sh->mq, ev);
 817 }
 818
 819
 820 /* end of ats_api_scheduling.c */