src/ats/ats_api.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.c
  22  * @brief automatic transport selection API
  23  * @author Christian Grothoff
  24  * @author Matthias Wachs
  25  *
  26  * TODO:
  27  * - write test case
  28  * - extend API to get performance data
  29  * - implement simplistic strategy based on say 'lowest latency' or strict ordering
  30  * - extend API to get peer preferences, implement proportional bandwidth assignment
  31  * - re-implement API against a real ATS service (!)
  32  */
  33 #include "platform.h"
  34 #include "gnunet_ats_service.h"
  35
  36 #define DEBUG_ATS GNUNET_NO
  37
  38 // NOTE: this implementation is simply supposed
  39 // to implement a simplistic strategy in-process;
  40 // in the future, we plan to replace it with a real
  41 // service implementation
  42
  43 /**
  44  * Allocation record for a peer's address.
  45  */
  46 struct AllocationRecord
  47 {
  48
  49   /**
  50    * Performance information associated with this address (array).
  51    */
  52   struct GNUNET_TRANSPORT_ATS_Information *ats;
  53
  54   /**
  55    * Name of the plugin
  56    */
  57   char *plugin_name;
  58
  59   /**
  60    * Address this record represents, allocated at the end of this struct.
  61    */
  62   const void *plugin_addr;
  63
  64   /**
  65    * Session associated with this record.
  66    */
  67   struct Session *session;
  68
  69   /**
  70    * Number of bytes in plugin_addr.
  71    */
  72   size_t plugin_addr_len;
  73
  74   /**
  75    * Number of entries in 'ats'.
  76    */
  77   uint32_t ats_count;
  78
  79   /**
  80    * Bandwidth assigned to this address right now, 0 for none.
  81    */
  82   struct GNUNET_BANDWIDTH_Value32NBO bandwidth;
  83
  84   /**
  85    * Set to GNUNET_YES if this is the connected address of a connected peer.
  86    */
  87   int connected;
  88
  89 };
  90
  91
  92 /**
  93  * Opaque handle to obtain address suggestions.
  94  */
  95 struct GNUNET_ATS_SuggestionContext
  96 {
  97
  98   /**
  99    * Function to call with our final suggestion.
 100    */
 101   GNUNET_ATS_AddressSuggestionCallback cb;
 102
 103   /**
 104    * Closure for 'cb'.
 105    */
 106   void *cb_cls;
 107
 108   /**
 109    * Global ATS handle.
 110    */
 111   struct GNUNET_ATS_Handle *atc;
 112
 113   /**
 114    * Which peer are we monitoring?
 115    */
 116   struct GNUNET_PeerIdentity target;
 117
 118 };
 119
 120
 121 /**
 122  * Handle to the ATS subsystem.
 123  */
 124 struct GNUNET_ATS_Handle
 125 {
 126   /**
 127    * Configuration.
 128    */
 129   const struct GNUNET_CONFIGURATION_Handle *cfg;
 130
 131   /**
 132    * Function to call when the allocation changes.
 133    */
 134   GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb;
 135
 136   /**
 137    * Closure for 'alloc_cb'.
 138    */
 139   void *alloc_cb_cls;
 140
 141   /**
 142    * Information about all connected peers.  Maps peer identities
 143    * to one or more 'struct AllocationRecord' values.
 144    */
 145   struct GNUNET_CONTAINER_MultiHashMap *peers;
 146
 147   /**
 148    * Map of PeerIdentities to 'struct GNUNET_ATS_SuggestionContext's.
 149    */
 150   struct GNUNET_CONTAINER_MultiHashMap *notify_map;
 151
 152
 153   /**
 154    * Task scheduled to update our bandwidth assignment.
 155    */
 156   GNUNET_SCHEDULER_TaskIdentifier ba_task;
 157
 158   /**
 159    * Total bandwidth per configuration.
 160    */
 161   unsigned long long total_bps;
 162 };
 163
 164
 165 /**
 166  * Count number of connected records.
 167  *
 168  * @param cls pointer to counter
 169  * @param key identity of the peer associated with the records
 170  * @param value a 'struct AllocationRecord'
 171  * @return GNUNET_YES (continue iteration)
 172  */
 173 static int
 174 count_connections (void *cls, const GNUNET_HashCode * key, void *value)
 175 {
 176   unsigned int *ac = cls;
 177   struct AllocationRecord *ar = value;
 178
 179   if (GNUNET_YES == ar->connected)
 180     (*ac)++;
 181   return GNUNET_YES;
 182 }
 183
 184
 185 /**
 186  * Closure for 'set_bw_connections'.
 187  */
 188 struct SetBandwidthContext
 189 {
 190   /**
 191    * ATS handle.
 192    */
 193   struct GNUNET_ATS_Handle *atc;
 194
 195   /**
 196    * Bandwidth to assign.
 197    */
 198   struct GNUNET_BANDWIDTH_Value32NBO bw;
 199 };
 200
 201
 202 /**
 203  * Set bandwidth based on record.
 204  *
 205  * @param cls 'struct SetBandwidthContext'
 206  * @param key identity of the peer associated with the records
 207  * @param value a 'struct AllocationRecord'
 208  * @return GNUNET_YES (continue iteration)
 209  */
 210 static int
 211 set_bw_connections (void *cls, const GNUNET_HashCode * key, void *value)
 212 {
 213   struct SetBandwidthContext *sbc = cls;
 214   struct AllocationRecord *ar = value;
 215
 216   if (GNUNET_YES == ar->connected)
 217   {
 218     ar->bandwidth = sbc->bw;
 219     sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
 220                         (const struct GNUNET_PeerIdentity *) key,
 221                         ar->plugin_name, ar->session, ar->plugin_addr,
 222                         ar->plugin_addr_len, ar->bandwidth);
 223   }
 224   else if (ntohl (ar->bandwidth.value__) > 0)
 225   {
 226     ar->bandwidth = GNUNET_BANDWIDTH_value_init (0);
 227     sbc->atc->alloc_cb (sbc->atc->alloc_cb_cls,
 228                         (const struct GNUNET_PeerIdentity *) key,
 229                         ar->plugin_name, ar->session, ar->plugin_addr,
 230                         ar->plugin_addr_len, ar->bandwidth);
 231   }
 232   return GNUNET_YES;
 233 }
 234
 235
 236 /**
 237  * Task run to update bandwidth assignments.
 238  *
 239  * @param cls the 'struct GNUNET_ATS_Handle'
 240  * @param tc scheduler context
 241  */
 242 static void
 243 update_bandwidth_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 244 {
 245   struct GNUNET_ATS_Handle *atc = cls;
 246   unsigned int ac = 0;
 247   struct SetBandwidthContext bwc;
 248
 249   atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
 250   /* FIXME: update calculations NICELY; what follows is a naive version */
 251   GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &count_connections, &ac);
 252   bwc.atc = atc;
 253   if (ac == 0)
 254     ac++;
 255   GNUNET_assert (ac > 0);
 256   bwc.bw = GNUNET_BANDWIDTH_value_init (atc->total_bps / ac);
 257   GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &set_bw_connections, &bwc);
 258 }
 259
 260
 261 /**
 262  * Calculate an updated bandwidth assignment and notify.
 263  *
 264  * @param atc handle
 265  * @param change which allocation record changed?
 266  */
 267 static void
 268 update_bandwidth_assignment (struct GNUNET_ATS_Handle *atc,
 269                              struct AllocationRecord *change)
 270 {
 271   /* FIXME: based on the 'change', update the LP-problem... */
 272   if (atc->ba_task == GNUNET_SCHEDULER_NO_TASK)
 273     atc->ba_task = GNUNET_SCHEDULER_add_now (&update_bandwidth_task, atc);
 274 }
 275
 276
 277 /**
 278  * Function called with feasbile addresses we might want to suggest.
 279  *
 280  * @param cls the 'struct GNUNET_ATS_SuggestionContext'
 281  * @param key identity of the peer
 282  * @param value a 'struct AllocationRecord' for the peer
 283  * @return GNUNET_NO if we're done, GNUNET_YES if we did not suggest an address yet
 284  */
 285 static int
 286 suggest_address (void *cls, const GNUNET_HashCode * key, void *value)
 287 {
 288   struct GNUNET_ATS_SuggestionContext *asc = cls;
 289   struct AllocationRecord *ar = value;
 290
 291 #if DEBUG_ATS
 292   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api",
 293                    "Suggesting address for peer `%s'\n", GNUNET_h2s (key));
 294 #endif
 295
 296   /* trivial strategy: pick first available address... */
 297   asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
 298            ar->plugin_addr_len, ar->session,
 299            GNUNET_BANDWIDTH_value_init (asc->atc->total_bps / 32), ar->ats,
 300            ar->ats_count);
 301   asc->cb = NULL;
 302   return GNUNET_NO;
 303 }
 304
 305 int
 306 map_it (void *cls, const GNUNET_HashCode * key, void *value)
 307 {
 308   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api", "Found entry for %s\n",
 309                    GNUNET_h2s (key));
 310   return GNUNET_YES;
 311 }
 312
 313 /**
 314  * We would like to establish a new connection with a peer.
 315  * ATS should suggest a good address to begin with.
 316  *
 317  * @param atc handle
 318  * @param peer identity of the new peer
 319  * @param cb function to call with the address
 320  * @param cb_cls closure for cb
 321  */
 322 struct GNUNET_ATS_SuggestionContext *
 323 GNUNET_ATS_suggest_address (struct GNUNET_ATS_Handle *atc,
 324                             const struct GNUNET_PeerIdentity *peer,
 325                             GNUNET_ATS_AddressSuggestionCallback cb,
 326                             void *cb_cls)
 327 {
 328   struct GNUNET_ATS_SuggestionContext *asc;
 329
 330 #if DEBUG_ATS
 331   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api",
 332                    "Looking up suggested address for peer `%s'\n",
 333                    GNUNET_i2s (peer));
 334 #endif
 335   int count = 0;
 336
 337   asc = GNUNET_malloc (sizeof (struct GNUNET_ATS_SuggestionContext));
 338   asc->cb = cb;
 339   asc->cb_cls = cb_cls;
 340   asc->atc = atc;
 341   asc->target = *peer;
 342   count =
 343       GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers, &peer->hashPubKey,
 344                                                   &suggest_address, asc);
 345
 346 #if DEBUG_ATS
 347   GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &map_it, (void *) peer);
 348   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api",
 349                    "Addresses %u (of %i) processed, \n", count,
 350                    GNUNET_CONTAINER_multihashmap_size (atc->peers));
 351 #endif
 352
 353   if (NULL == asc->cb)
 354   {
 355     GNUNET_free (asc);
 356     return NULL;
 357   }
 358   GNUNET_CONTAINER_multihashmap_put (atc->notify_map, &peer->hashPubKey, asc,
 359                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
 360   return asc;
 361 }
 362
 363
 364 /**
 365  * Cancel suggestion request.
 366  *
 367  * @param asc handle of the request to cancel
 368  */
 369 void
 370 GNUNET_ATS_suggest_address_cancel (struct GNUNET_ATS_SuggestionContext *asc)
 371 {
 372   GNUNET_assert (GNUNET_OK ==
 373                  GNUNET_CONTAINER_multihashmap_remove (asc->atc->notify_map,
 374                                                        &asc->target.hashPubKey,
 375                                                        asc));
 376   GNUNET_free (asc);
 377 }
 378
 379
 380 /**
 381  * Initialize the ATS subsystem.
 382  *
 383  * @param cfg configuration to use
 384  * @param alloc_cb notification to call whenever the allocation changed
 385  * @param alloc_cb_cls closure for 'alloc_cb'
 386  * @return ats context
 387  */
 388 struct GNUNET_ATS_Handle *
 389 GNUNET_ATS_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 390                  GNUNET_TRANSPORT_ATS_AllocationNotification alloc_cb,
 391                  void *alloc_cb_cls)
 392 {
 393   struct GNUNET_ATS_Handle *atc;
 394
 395 #if DEBUG_ATS
 396   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api", "ATS init\n");
 397 #endif
 398   atc = GNUNET_malloc (sizeof (struct GNUNET_ATS_Handle));
 399   atc->cfg = cfg;
 400   atc->alloc_cb = alloc_cb;
 401   atc->alloc_cb_cls = alloc_cb_cls;
 402   atc->peers = GNUNET_CONTAINER_multihashmap_create (256);
 403   atc->notify_map = GNUNET_CONTAINER_multihashmap_create (256);
 404   GNUNET_CONFIGURATION_get_value_number (cfg, "core", "TOTAL_QUOTA_OUT",
 405                                          &atc->total_bps);
 406   return atc;
 407 }
 408
 409
 410 /**
 411  * Free an allocation record.
 412  *
 413  * @param cls unused
 414  * @param key identity of the peer associated with the record
 415  * @param value the 'struct AllocationRecord' to free
 416  * @return GNUNET_OK (continue to iterate)
 417  */
 418 static int
 419 destroy_allocation_record (void *cls, const GNUNET_HashCode * key, void *value)
 420 {
 421   struct AllocationRecord *ar = value;
 422
 423   GNUNET_array_grow (ar->ats, ar->ats_count, 0);
 424   GNUNET_free (ar->plugin_name);
 425   GNUNET_free (ar);
 426   return GNUNET_OK;
 427 }
 428
 429
 430 /**
 431  * Shutdown the ATS subsystem.
 432  *
 433  * @param atc handle
 434  */
 435 void
 436 GNUNET_ATS_shutdown (struct GNUNET_ATS_Handle *atc)
 437 {
 438 #if DEBUG_ATS
 439   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api", "ATS shutdown\n");
 440 #endif
 441   if (GNUNET_SCHEDULER_NO_TASK != atc->ba_task)
 442   {
 443     GNUNET_SCHEDULER_cancel (atc->ba_task);
 444     atc->ba_task = GNUNET_SCHEDULER_NO_TASK;
 445   }
 446   GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_allocation_record,
 447                                          NULL);
 448   GNUNET_CONTAINER_multihashmap_destroy (atc->peers);
 449   GNUNET_assert (GNUNET_CONTAINER_multihashmap_size (atc->notify_map) == 0);
 450   GNUNET_CONTAINER_multihashmap_destroy (atc->notify_map);
 451   atc->notify_map = NULL;
 452   GNUNET_free (atc);
 453 }
 454
 455
 456 /**
 457  * Closure for 'update_session'
 458  */
 459 struct UpdateSessionContext
 460 {
 461   /**
 462    * Ats handle.
 463    */
 464   struct GNUNET_ATS_Handle *atc;
 465
 466   /**
 467    * Allocation record with new information.
 468    */
 469   struct AllocationRecord *arnew;
 470 };
 471
 472
 473 /**
 474  * Update an allocation record, merging with the new information
 475  *
 476  * @param cls a new 'struct AllocationRecord'
 477  * @param key identity of the peer associated with the records
 478  * @param value the old 'struct AllocationRecord'
 479  * @return GNUNET_YES if the records do not match,
 480  *         GNUNET_NO if the record do match and 'old' was updated
 481  */
 482 static int
 483 update_session (void *cls, const GNUNET_HashCode * key, void *value)
 484 {
 485   struct UpdateSessionContext *usc = cls;
 486   struct AllocationRecord *arnew = usc->arnew;
 487   struct AllocationRecord *arold = value;
 488   int change;
 489
 490 #if DEBUG_ATS
 491   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api",
 492                    "Updating session for peer `%s' plugin `%s'\n",
 493                    GNUNET_h2s (key), arold->plugin_name);
 494 #endif
 495
 496   if (0 != strcmp (arnew->plugin_name, arold->plugin_name))
 497     return GNUNET_YES;
 498   if (((arnew->session == arold->session) && (arnew->session != NULL)) ||
 499       ((arold->session == NULL) &&
 500        (arold->plugin_addr_len == arnew->plugin_addr_len) &&
 501        (0 ==
 502         memcmp (arold->plugin_addr, arnew->plugin_addr,
 503                 arnew->plugin_addr_len))))
 504   {
 505     change = GNUNET_NO;
 506     /* records match */
 507     if (arnew->session != arold->session)
 508     {
 509       arold->session = arnew->session;
 510       change = GNUNET_YES;
 511     }
 512     if ((arnew->connected == GNUNET_YES) && (arold->connected == GNUNET_NO))
 513     {
 514       arold->connected = GNUNET_YES;
 515       change = GNUNET_YES;
 516     }
 517     // FIXME: merge ats arrays of (arold, arnew);
 518
 519     if (GNUNET_YES == change)
 520       update_bandwidth_assignment (usc->atc, arold);
 521     return GNUNET_NO;
 522   }
 523   return GNUNET_YES;
 524 }
 525
 526
 527 /**
 528  * Create an allocation record with the given properties.
 529  *
 530  * @param plugin_name name of the currently used transport plugin
 531  * @param session session in use (if available)
 532  * @param plugin_addr address in use (if available)
 533  * @param plugin_addr_len number of bytes in plugin_addr
 534  * @param ats performance data for the connection
 535  * @param ats_count number of performance records in 'ats'
 536  */
 537 static struct AllocationRecord *
 538 create_allocation_record (const char *plugin_name, struct Session *session,
 539                           const void *plugin_addr, size_t plugin_addr_len,
 540                           const struct GNUNET_TRANSPORT_ATS_Information *ats,
 541                           uint32_t ats_count)
 542 {
 543   struct AllocationRecord *ar;
 544
 545   ar = GNUNET_malloc (sizeof (struct AllocationRecord) + plugin_addr_len);
 546   ar->plugin_name = GNUNET_strdup (plugin_name);
 547   ar->plugin_addr = &ar[1];
 548   memcpy (&ar[1], plugin_addr, plugin_addr_len);
 549   ar->session = session;
 550   ar->plugin_addr_len = plugin_addr_len;
 551   GNUNET_array_grow (ar->ats, ar->ats_count, ats_count);
 552   memcpy (ar->ats, ats,
 553           ats_count * sizeof (struct GNUNET_TRANSPORT_ATS_Information));
 554   return ar;
 555 }
 556
 557
 558 /**
 559  * Mark all matching allocation records as not connected.
 560  *
 561  * @param cls 'struct GTS_AtsHandle'
 562  * @param key identity of the peer associated with the record
 563  * @param value the 'struct AllocationRecord' to clear the 'connected' flag
 564  * @return GNUNET_OK (continue to iterate)
 565  */
 566 static int
 567 disconnect_peer (void *cls, const GNUNET_HashCode * key, void *value)
 568 {
 569   struct GNUNET_ATS_Handle *atc = cls;
 570   struct AllocationRecord *ar = value;
 571
 572   if (GNUNET_YES == ar->connected)
 573   {
 574     ar->connected = GNUNET_NO;
 575     update_bandwidth_assignment (atc, ar);
 576   }
 577   return GNUNET_OK;
 578 }
 579
 580
 581 /**
 582  * We established a new connection with a peer (for example, because
 583  * core asked for it or because the other peer connected to us).
 584  * Calculate bandwidth assignments including the new peer.
 585  *
 586  * @param atc handle
 587  * @param peer identity of the new peer
 588  * @param plugin_name name of the currently used transport plugin
 589  * @param session session in use (if available)
 590  * @param plugin_addr address in use (if available)
 591  * @param plugin_addr_len number of bytes in plugin_addr
 592  * @param ats performance data for the connection
 593  * @param ats_count number of performance records in 'ats'
 594  */
 595 void
 596 GNUNET_ATS_peer_connect (struct GNUNET_ATS_Handle *atc,
 597                          const struct GNUNET_PeerIdentity *peer,
 598                          const char *plugin_name, struct Session *session,
 599                          const void *plugin_addr, size_t plugin_addr_len,
 600                          const struct GNUNET_TRANSPORT_ATS_Information *ats,
 601                          uint32_t ats_count)
 602 {
 603   struct AllocationRecord *ar;
 604   struct UpdateSessionContext usc;
 605
 606   (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &disconnect_peer,
 607                                                 atc);
 608   ar = create_allocation_record (plugin_name, session, plugin_addr,
 609                                  plugin_addr_len, ats, ats_count);
 610   ar->connected = GNUNET_YES;
 611   usc.atc = atc;
 612   usc.arnew = ar;
 613   if (GNUNET_SYSERR ==
 614       GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
 615   {
 616     destroy_allocation_record (NULL, &peer->hashPubKey, ar);
 617     return;
 618   }
 619   GNUNET_assert (GNUNET_OK ==
 620                  GNUNET_CONTAINER_multihashmap_put (atc->peers,
 621                                                     &peer->hashPubKey, ar,
 622                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 623 }
 624
 625
 626 /**
 627  * We disconnected from the given peer (for example, because ats, core
 628  * or blacklist asked for it or because the other peer disconnected).
 629  * Calculate bandwidth assignments without the peer.
 630  *
 631  * @param atc handle
 632  * @param peer identity of the new peer
 633  */
 634 void
 635 GNUNET_ATS_peer_disconnect (struct GNUNET_ATS_Handle *atc,
 636                             const struct GNUNET_PeerIdentity *peer)
 637 {
 638   (void) GNUNET_CONTAINER_multihashmap_get_multiple (atc->peers,
 639                                                      &peer->hashPubKey,
 640                                                      &disconnect_peer, atc);
 641 }
 642
 643
 644 /**
 645  * Closure for 'destroy_allocation_record'
 646  */
 647 struct SessionDestroyContext
 648 {
 649   /**
 650    * Ats handle.
 651    */
 652   struct GNUNET_ATS_Handle *atc;
 653
 654   /**
 655    * Session being destroyed.
 656    */
 657   const struct Session *session;
 658 };
 659
 660
 661 /**
 662  * Free an allocation record matching the given session.
 663  *
 664  * @param cls the 'struct SessionDestroyContext'
 665  * @param key identity of the peer associated with the record
 666  * @param value the 'struct AllocationRecord' to free
 667  * @return GNUNET_OK (continue to iterate)
 668  */
 669 static int
 670 destroy_session (void *cls, const GNUNET_HashCode * key, void *value)
 671 {
 672   struct SessionDestroyContext *sdc = cls;
 673   struct AllocationRecord *ar = value;
 674
 675   if (ar->session != sdc->session)
 676     return GNUNET_OK;
 677   ar->session = NULL;
 678   if (ar->plugin_addr != NULL)
 679     return GNUNET_OK;
 680   GNUNET_assert (GNUNET_OK ==
 681                  GNUNET_CONTAINER_multihashmap_remove (sdc->atc->peers, key,
 682                                                        ar));
 683   if (GNUNET_YES == ar->connected) ;
 684   {
 685     /* FIXME: is this supposed to be allowed? What to do then? */
 686     GNUNET_break (0);
 687   }
 688   destroy_allocation_record (NULL, key, ar);
 689   return GNUNET_OK;
 690 }
 691
 692
 693 /**
 694  * A session got destroyed, stop including it as a valid address.
 695  *
 696  * @param atc handle
 697  * @param peer identity of the peer
 698  * @param session session handle that is no longer valid
 699  */
 700 void
 701 GNUNET_ATS_session_destroyed (struct GNUNET_ATS_Handle *atc,
 702                               const struct GNUNET_PeerIdentity *peer,
 703                               const struct Session *session)
 704 {
 705   struct SessionDestroyContext sdc;
 706
 707   sdc.atc = atc;
 708   sdc.session = session;
 709   (void) GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &destroy_session,
 710                                                 &sdc);
 711 }
 712
 713
 714 /**
 715  * Notify validation watcher that an entry is now valid
 716  *
 717  * @param cls 'struct ValidationEntry' that is now valid
 718  * @param key peer identity (unused)
 719  * @param value a 'GST_ValidationIteratorContext' to notify
 720  * @return GNUNET_YES (continue to iterate)
 721  */
 722 static int
 723 notify_valid (void *cls, const GNUNET_HashCode * key, void *value)
 724 {
 725   struct AllocationRecord *ar = cls;
 726   struct GNUNET_ATS_SuggestionContext *asc = value;
 727
 728   asc->cb (asc->cb_cls, &asc->target, ar->plugin_name, ar->plugin_addr,
 729            ar->plugin_addr_len, ar->session,
 730            GNUNET_BANDWIDTH_value_init (asc->atc->total_bps / 32), ar->ats,
 731            ar->ats_count);
 732   GNUNET_ATS_suggest_address_cancel (asc);
 733   return GNUNET_OK;
 734 }
 735
 736
 737 /**
 738  * We have updated performance statistics for a given address.  Note
 739  * that this function can be called for addresses that are currently
 740  * in use as well as addresses that are valid but not actively in use.
 741  * Furthermore, the peer may not even be connected to us right now (in
 742  * which case the call may be ignored or the information may be stored
 743  * for later use).  Update bandwidth assignments.
 744  *
 745  * @param atc handle
 746  * @param peer identity of the peer
 747  * @param valid_until how long is the address valid?
 748  * @param plugin_name name of the transport plugin
 749  * @param session session handle (if available)
 750  * @param plugin_addr address  (if available)
 751  * @param plugin_addr_len number of bytes in plugin_addr
 752  * @param ats performance data for the address
 753  * @param ats_count number of performance records in 'ats'
 754  */
 755 void
 756 GNUNET_ATS_address_update (struct GNUNET_ATS_Handle *atc,
 757                            const struct GNUNET_PeerIdentity *peer,
 758                            struct GNUNET_TIME_Absolute valid_until,
 759                            const char *plugin_name, struct Session *session,
 760                            const void *plugin_addr, size_t plugin_addr_len,
 761                            const struct GNUNET_TRANSPORT_ATS_Information *ats,
 762                            uint32_t ats_count)
 763 {
 764   struct AllocationRecord *ar;
 765   struct UpdateSessionContext usc;
 766
 767
 768 #if DEBUG_ATS
 769   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api",
 770                    "Updating address for peer `%s', plugin `%s'\n",
 771                    GNUNET_i2s (peer), plugin_name);
 772 #endif
 773
 774   ar = create_allocation_record (plugin_name, session, plugin_addr,
 775                                  plugin_addr_len, ats, ats_count);
 776   usc.atc = atc;
 777   usc.arnew = ar;
 778   if (GNUNET_SYSERR ==
 779       GNUNET_CONTAINER_multihashmap_iterate (atc->peers, &update_session, &usc))
 780   {
 781     destroy_allocation_record (NULL, &peer->hashPubKey, ar);
 782     return;
 783   }
 784 #if DEBUG_ATS
 785   GNUNET_log_from (GNUNET_ERROR_TYPE_DEBUG, "ats-api",
 786                    "Adding new address for peer `%s', plugin `%s'\n",
 787                    GNUNET_i2s (peer), plugin_name);
 788 #endif
 789   GNUNET_assert (GNUNET_OK ==
 790                  GNUNET_CONTAINER_multihashmap_put (atc->peers,
 791                                                     &peer->hashPubKey, ar,
 792                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE));
 793   GNUNET_CONTAINER_multihashmap_get_multiple (atc->notify_map,
 794                                               &peer->hashPubKey, &notify_valid,
 795                                               ar);
 796 }
 797
 798 /* end of file gnunet-service-transport_ats.c */