src/ats/ats_api_scheduling.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010-2015 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_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 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?  FIXME:
  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  * @param tc scheduler context
 170  */
 171 static void
 172 reconnect_task (void *cls,
 173                 const struct GNUNET_SCHEDULER_TaskContext *tc)
 174 {
 175   struct GNUNET_ATS_SchedulingHandle *sh = cls;
 176
 177   sh->task = NULL;
 178   reconnect (sh);
 179 }
 180
 181
 182 /**
 183  * Disconnect from ATS and then reconnect.
 184  *
 185  * @param sh our handle
 186  */
 187 static void
 188 force_reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
 189 {
 190   if (NULL != sh->mq)
 191   {
 192     GNUNET_MQ_destroy (sh->mq);
 193     sh->mq = NULL;
 194   }
 195   if (NULL != sh->client)
 196   {
 197     GNUNET_CLIENT_disconnect (sh->client);
 198     sh->client = NULL;
 199   }
 200   sh->suggest_cb (sh->suggest_cb_cls,
 201                   NULL, NULL, NULL,
 202                   GNUNET_BANDWIDTH_ZERO,
 203                   GNUNET_BANDWIDTH_ZERO);
 204   sh->backoff = GNUNET_TIME_STD_BACKOFF (sh->backoff);
 205   sh->task = GNUNET_SCHEDULER_add_delayed (sh->backoff,
 206                                            &reconnect_task,
 207                                            sh);
 208 }
 209
 210
 211 /**
 212  * Find the session object corresponding to the given session ID.
 213  *
 214  * @param sh our handle
 215  * @param session_id current session ID
 216  * @param peer peer the session belongs to
 217  * @return the session object (or NULL)
 218  */
 219 static struct GNUNET_ATS_AddressRecord *
 220 find_session (struct GNUNET_ATS_SchedulingHandle *sh,
 221               uint32_t session_id,
 222               const struct GNUNET_PeerIdentity *peer)
 223 {
 224   struct GNUNET_ATS_AddressRecord *ar;
 225
 226   if (session_id >= sh->session_array_size)
 227   {
 228     GNUNET_break (0);
 229     return NULL;
 230   }
 231   if (0 == session_id)
 232     return NULL;
 233   ar = sh->session_array[session_id];
 234   if (NULL == ar)
 235   {
 236     GNUNET_break (0);
 237     return NULL;
 238   }
 239   if (NULL == ar->address)
 240   {
 241     /* address was destroyed in the meantime, this can happen
 242        as we communicate asynchronously with the ATS service. */
 243     return NULL;
 244   }
 245   if (0 != memcmp (peer,
 246                    &ar->address->peer,
 247                    sizeof (struct GNUNET_PeerIdentity)))
 248   {
 249     GNUNET_break (0);
 250     force_reconnect (sh);
 251     return NULL;
 252   }
 253   return ar;
 254 }
 255
 256
 257 /**
 258  * Get an available session ID.
 259  *
 260  * @param sh our handle
 261  * @return an unused slot, but never NOT_FOUND (0)
 262  */
 263 static uint32_t
 264 find_empty_session_slot (struct GNUNET_ATS_SchedulingHandle *sh)
 265 {
 266   static uint32_t off;
 267   uint32_t i;
 268
 269   i = 0;
 270   while ( ( (NOT_FOUND == off) ||
 271             (NULL != sh->session_array[off % sh->session_array_size]) ) &&
 272           (i < sh->session_array_size) )
 273   {
 274     off++;
 275     i++;
 276   }
 277   if ( (NOT_FOUND != off % sh->session_array_size) &&
 278        (NULL == sh->session_array[off % sh->session_array_size]) )
 279     return off;
 280   i = sh->session_array_size;
 281   GNUNET_array_grow (sh->session_array,
 282                      sh->session_array_size,
 283                      sh->session_array_size * 2);
 284   return i;
 285 }
 286
 287
 288 /**
 289  * Get the ID for the given session object.
 290  *
 291  * @param sh our handle
 292  * @param session session object
 293  * @param address the address we are looking for
 294  * @return the session id or NOT_FOUND for error
 295  */
 296 static uint32_t
 297 find_session_id (struct GNUNET_ATS_SchedulingHandle *sh,
 298                  struct Session *session,
 299                  const struct GNUNET_HELLO_Address *address)
 300 {
 301   uint32_t i;
 302
 303   if (NULL == address)
 304   {
 305     GNUNET_break (0);
 306     return NOT_FOUND;
 307   }
 308   for (i = 1; i < sh->session_array_size; i++)
 309     if ( (NULL != sh->session_array[i]) &&
 310          (GNUNET_NO == sh->session_array[i]->in_destroy) &&
 311          ( (session == sh->session_array[i]->session) ||
 312            (NULL == sh->session_array[i]->session) ) &&
 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 SessionReleaseMessage *srm;
 368
 369   srm = (const struct 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_ERROR,
 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   namelen = strlen (ar->address->transport_name) + 1;
 495   msize = ar->address->address_length + namelen;
 496   ev = GNUNET_MQ_msg_extra (m, msize, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_ADD);
 497   m->peer = ar->address->peer;
 498   m->address_length = htons (ar->address->address_length);
 499   m->address_local_info = htonl ((uint32_t) ar->address->local_info);
 500   m->plugin_name_length = htons (namelen);
 501   m->session_id = htonl (ar->slot);
 502   m->properties = ar->properties;
 503
 504   LOG (GNUNET_ERROR_TYPE_DEBUG,
 505        "Adding address for peer `%s', plugin `%s', session %p slot %u\n",
 506        GNUNET_i2s (&ar->address->peer),
 507        ar->address->transport_name,
 508        ar->session,
 509        ar->slot);
 510   pm = (char *) &m[1];
 511   memcpy (pm,
 512           ar->address->address,
 513           ar->address->address_length);
 514   if (NULL != ar->address->transport_name)
 515     memcpy (&pm[ar->address->address_length],
 516             ar->address->transport_name,
 517             namelen);
 518   GNUNET_MQ_send (sh->mq, ev);
 519 }
 520
 521
 522 /**
 523  * Re-establish the connection to the ATS service.
 524  *
 525  * @param sh handle to use to re-connect.
 526  */
 527 static void
 528 reconnect (struct GNUNET_ATS_SchedulingHandle *sh)
 529 {
 530   static const struct GNUNET_MQ_MessageHandler handlers[] =
 531     { { &process_ats_session_release_message,
 532         GNUNET_MESSAGE_TYPE_ATS_SESSION_RELEASE,
 533         sizeof (struct SessionReleaseMessage) },
 534       { &process_ats_address_suggestion_message,
 535         GNUNET_MESSAGE_TYPE_ATS_ADDRESS_SUGGESTION,
 536         sizeof (struct AddressSuggestionMessage) },
 537       { NULL, 0, 0 } };
 538   struct GNUNET_MQ_Envelope *ev;
 539   struct ClientStartMessage *init;
 540   unsigned int i;
 541   struct GNUNET_ATS_AddressRecord *ar;
 542
 543   GNUNET_assert (NULL == sh->client);
 544   sh->client = GNUNET_CLIENT_connect ("ats",
 545                                       sh->cfg);
 546   if (NULL == sh->client)
 547   {
 548     GNUNET_break (0);
 549     force_reconnect (sh);
 550     return;
 551   }
 552   sh->mq = GNUNET_MQ_queue_for_connection_client (sh->client,
 553                                                   handlers,
 554                                                   &error_handler,
 555                                                   sh);
 556   ev = GNUNET_MQ_msg (init,
 557                       GNUNET_MESSAGE_TYPE_ATS_START);
 558   init->start_flag = htonl (START_FLAG_SCHEDULING);
 559   GNUNET_MQ_send (sh->mq, ev);
 560   if (NULL == sh->mq)
 561     return;
 562   for (i=0;i<sh->session_array_size;i++)
 563   {
 564     ar = sh->session_array[i];
 565     if (NULL == ar)
 566       continue;
 567     send_add_address_message (sh, ar);
 568     if (NULL == sh->mq)
 569       return;
 570   }
 571 }
 572
 573
 574 /**
 575  * Initialize the ATS subsystem.
 576  *
 577  * @param cfg configuration to use
 578  * @param suggest_cb notification to call whenever the suggestation changed
 579  * @param suggest_cb_cls closure for @a suggest_cb
 580  * @return ats context
 581  */
 582 struct GNUNET_ATS_SchedulingHandle *
 583 GNUNET_ATS_scheduling_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 584                             GNUNET_ATS_AddressSuggestionCallback suggest_cb,
 585                             void *suggest_cb_cls)
 586 {
 587   struct GNUNET_ATS_SchedulingHandle *sh;
 588
 589   sh = GNUNET_new (struct GNUNET_ATS_SchedulingHandle);
 590   sh->cfg = cfg;
 591   sh->suggest_cb = suggest_cb;
 592   sh->suggest_cb_cls = suggest_cb_cls;
 593   GNUNET_array_grow (sh->session_array,
 594                      sh->session_array_size,
 595                      4);
 596   reconnect (sh);
 597   return sh;
 598 }
 599
 600
 601 /**
 602  * Client is done with ATS scheduling, release resources.
 603  *
 604  * @param sh handle to release
 605  */
 606 void
 607 GNUNET_ATS_scheduling_done (struct GNUNET_ATS_SchedulingHandle *sh)
 608 {
 609   struct GNUNET_ATS_AddressRecord *ar;
 610   unsigned int i;
 611
 612   if (NULL != sh->mq)
 613   {
 614     GNUNET_MQ_destroy (sh->mq);
 615     sh->mq = NULL;
 616   }
 617   if (NULL != sh->client)
 618   {
 619     GNUNET_CLIENT_disconnect (sh->client);
 620     sh->client = NULL;
 621   }
 622   if (NULL != sh->task)
 623   {
 624     GNUNET_SCHEDULER_cancel (sh->task);
 625     sh->task = NULL;
 626   }
 627   for (i=0;i<sh->session_array_size;i++)
 628   {
 629     if (NULL != (ar = sh->session_array[i]))
 630     {
 631       GNUNET_HELLO_address_free (ar->address);
 632       GNUNET_free (ar);
 633       sh->session_array[i] = NULL;
 634     }
 635   }
 636   GNUNET_array_grow (sh->session_array,
 637                      sh->session_array_size,
 638                      0);
 639   GNUNET_free (sh);
 640 }
 641
 642
 643 /**
 644  * We have a new address ATS should know. Addresses have to be added
 645  * with this function before they can be: updated, set in use and
 646  * destroyed.
 647  *
 648  * @param sh handle
 649  * @param address the address
 650  * @param session session handle, can be NULL
 651  * @param prop performance data for the address
 652  * @return handle to the address representation inside ATS, NULL
 653  *         on error (i.e. ATS knows this exact address already)
 654  */
 655 struct GNUNET_ATS_AddressRecord *
 656 GNUNET_ATS_address_add (struct GNUNET_ATS_SchedulingHandle *sh,
 657                         const struct GNUNET_HELLO_Address *address,
 658                         struct Session *session,
 659                         const struct GNUNET_ATS_Properties *prop)
 660 {
 661   struct GNUNET_ATS_AddressRecord *ar;
 662   size_t namelen;
 663   size_t msize;
 664   uint32_t s;
 665
 666   if (NULL == address)
 667   {
 668     /* we need a valid address */
 669     GNUNET_break (0);
 670     return NULL;
 671   }
 672   namelen = strlen (address->transport_name) + 1;
 673   msize = address->address_length + namelen;
 674   if ((msize + sizeof (struct AddressUpdateMessage) >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
 675       (address->address_length >= GNUNET_SERVER_MAX_MESSAGE_SIZE) ||
 676       (namelen >= GNUNET_SERVER_MAX_MESSAGE_SIZE) )
 677   {
 678     /* address too large for us, this should not happen */
 679     GNUNET_break (0);
 680     return NULL;
 681   }
 682
 683   if (NOT_FOUND !=
 684       find_session_id (sh,
 685                        session,
 686                        address))
 687   {
 688     /* Already existing, nothing todo, but this should not happen */
 689     GNUNET_break (0);
 690     return NULL;
 691   }
 692   s = find_empty_session_slot (sh);
 693   ar = GNUNET_new (struct GNUNET_ATS_AddressRecord);
 694   ar->sh = sh;
 695   ar->slot = s;
 696   ar->session = session;
 697   ar->address = GNUNET_HELLO_address_copy (address);
 698   GNUNET_ATS_properties_hton (&ar->properties,
 699                               prop);
 700   sh->session_array[s] = ar;
 701   send_add_address_message (sh, ar);
 702   return ar;
 703 }
 704
 705
 706 /**
 707  * An address was used to initiate a session.
 708  *
 709  * @param ar address record to update information for
 710  * @param session session handle
 711  */
 712 void
 713 GNUNET_ATS_address_add_session (struct GNUNET_ATS_AddressRecord *ar,
 714                                 struct Session *session)
 715 {
 716   GNUNET_break (NULL == ar->session);
 717   ar->session = session;
 718 }
 719
 720
 721 /**
 722  * A session was destroyed, disassociate it from the
 723  * given address record.  If this was an incoming
 724  * addess, destroy the address as well.
 725  *
 726  * @param ar address record to update information for
 727  * @param session session handle
 728  * @return #GNUNET_YES if the @a ar was destroyed because
 729  *                     it was an incoming address,
 730  *         #GNUNET_NO if the @ar was kept because we can
 731  *                    use it still to establish a new session
 732  */
 733 int
 734 GNUNET_ATS_address_del_session (struct GNUNET_ATS_AddressRecord *ar,
 735                                 struct Session *session)
 736 {
 737   GNUNET_assert (session == ar->session);
 738   ar->session = NULL;
 739   if (GNUNET_HELLO_address_check_option (ar->address,
 740                                          GNUNET_HELLO_ADDRESS_INFO_INBOUND))
 741   {
 742     GNUNET_ATS_address_destroy (ar);
 743     return GNUNET_YES;
 744   }
 745   return GNUNET_NO;
 746 }
 747
 748
 749 /**
 750  * We have updated performance statistics for a given address.  Note
 751  * that this function can be called for addresses that are currently
 752  * in use as well as addresses that are valid but not actively in use.
 753  * Furthermore, the peer may not even be connected to us right now (in
 754  * which case the call may be ignored or the information may be stored
 755  * for later use).  Update bandwidth assignments.
 756  *
 757  * @param ar address record to update information for
 758  * @param prop performance data for the address
 759  */
 760 void
 761 GNUNET_ATS_address_update (struct GNUNET_ATS_AddressRecord *ar,
 762                            const struct GNUNET_ATS_Properties *prop)
 763 {
 764   struct GNUNET_ATS_SchedulingHandle *sh = ar->sh;
 765   struct GNUNET_MQ_Envelope *ev;
 766   struct AddressUpdateMessage *m;
 767
 768   LOG (GNUNET_ERROR_TYPE_DEBUG,
 769        "Updating address for peer `%s', plugin `%s', session %p slot %u\n",
 770        GNUNET_i2s (&ar->address->peer),
 771        ar->address->transport_name,
 772        ar->session,
 773        ar->slot);
 774   GNUNET_ATS_properties_hton (&ar->properties,
 775                               prop);
 776   if (NULL == sh->mq)
 777     return; /* disconnected, skip for now */
 778   ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_UPDATE);
 779   m->session_id = htonl (ar->slot);
 780   m->peer = ar->address->peer;
 781   m->properties = ar->properties;
 782   GNUNET_MQ_send (sh->mq,
 783                   ev);
 784 }
 785
 786
 787
 788 /**
 789  * An address got destroyed, stop using it as a valid address.
 790  *
 791  * @param ar address to destroy
 792  */
 793 void
 794 GNUNET_ATS_address_destroy (struct GNUNET_ATS_AddressRecord *ar)
 795 {
 796   struct GNUNET_ATS_SchedulingHandle *sh = ar->sh;
 797   struct GNUNET_MQ_Envelope *ev;
 798   struct AddressDestroyedMessage *m;
 799
 800   LOG (GNUNET_ERROR_TYPE_DEBUG,
 801        "Deleting address for peer `%s', plugin `%s', slot %u session %p\n",
 802        GNUNET_i2s (&ar->address->peer),
 803        ar->address->transport_name,
 804        ar->slot,
 805        ar->session);
 806   GNUNET_break (NULL == ar->session);
 807   ar->session = NULL;
 808   ar->in_destroy = GNUNET_YES;
 809   if (NULL == sh->mq)
 810     return;
 811   ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_ADDRESS_DESTROYED);
 812   m->session_id = htonl (ar->slot);
 813   m->peer = ar->address->peer;
 814   GNUNET_MQ_send (sh->mq, ev);
 815 }
 816
 817
 818 /* end of ats_api_scheduling.c */