src/testbed/gnunet-service-testbed_cache.c

   1 /*
   2   This file is part of GNUnet.
   3   (C) 2012 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 2, or (at your
   8   option) any later version.
   9
  10   GNUnet is distributed in the hope that it will be useful, but
  11   WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with GNUnet; see the file COPYING.  If not, write to the
  17   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18   Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file testbed/gnunet-service-testbed_cache.c
  23  * @brief testbed cache implementation
  24  * @author Sree Harsha Totakura
  25  */
  26 #include "gnunet-service-testbed.h"
  27
  28 /**
  29  * Redefine LOG with a changed log component string
  30  */
  31 #ifdef LOG
  32 #undef LOG
  33 #endif
  34 #define LOG(kind,...)                                   \
  35   GNUNET_log_from (kind, "testbed-cache", __VA_ARGS__)
  36
  37
  38 /**
  39  * Time to expire a cache entry
  40  */
  41 #define CACHE_EXPIRY                            \
  42   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  43
  44
  45 /**
  46  * Type of cache-get requests
  47  */
  48 enum CacheGetType
  49 {
  50   /**
  51    * Get transport handle
  52    */
  53   CGT_TRANSPORT_HANDLE = 1,
  54
  55   /**
  56    * Get core handle
  57    */
  58   CGT_CORE_HANDLE
  59 };
  60
  61
  62 /**
  63  * The cache-get request handle
  64  */
  65 struct GSTCacheGetHandle;
  66
  67
  68 /**
  69  * This context structure is used to maintain a queue of notifications to check
  70  * which of them are to be notified when a peer is connected.
  71  */
  72 struct ConnectNotifyContext
  73 {
  74   /**
  75    * The next ptr for the DLL
  76    */
  77   struct ConnectNotifyContext *next;
  78
  79   /**
  80    * The prev ptr for the DLL
  81    */
  82   struct ConnectNotifyContext *prev;
  83
  84   /**
  85    * The peer identity of the target peer. When this target peer is connected,
  86    * call the notify callback
  87    */
  88   const struct GNUNET_PeerIdentity *target;
  89
  90   /**
  91    * The notify callback to be called when the target peer is connected
  92    */
  93   GST_cache_peer_connect_notify cb;
  94
  95   /**
  96    * The closure for the notify callback
  97    */
  98   void *cb_cls;
  99
 100   /**
 101    * The GSTCacheGetHandle reposible for creating this context
 102    */
 103   struct GSTCacheGetHandle *cgh;
 104
 105 };
 106
 107
 108 /**
 109  * The cache-get request handle
 110  */
 111 struct GSTCacheGetHandle
 112 {
 113   /**
 114    * The next ptr for the DLL. Used in struct CacheEntry
 115    */
 116   struct GSTCacheGetHandle *next;
 117
 118   /**
 119    * The prev ptr for the DLL. Used in struct CacheEntry
 120    */
 121   struct GSTCacheGetHandle *prev;
 122
 123   /**
 124    * The cache entry object this handle corresponds to
 125    */
 126   struct CacheEntry *entry;
 127
 128   /**
 129    * The cache callback to call when a handle is available
 130    */
 131   GST_cache_handle_ready_cb cb;
 132
 133   /**
 134    * The closure for the above callback
 135    */
 136   void *cb_cls;
 137
 138   /**
 139    * The peer connect notify context created for this handle; can be NULL
 140    */
 141   struct ConnectNotifyContext *nctxt;
 142
 143   /**
 144    * The type of this cache-get request
 145    */
 146   enum CacheGetType type;
 147
 148   /**
 149    * Did we call the cache callback already?
 150    */
 151   int notify_called;
 152 };
 153
 154 /**
 155  * Cache entry
 156  */
 157 struct CacheEntry
 158 {
 159   /**
 160    * DLL next ptr for least recently used cache entries
 161    */
 162   struct CacheEntry *next;
 163
 164   /**
 165    * DLL prev ptr for least recently used cache entries
 166    */
 167   struct CacheEntry *prev;
 168
 169   /**
 170    * The transport handle to the peer corresponding to this entry; can be NULL
 171    */
 172   struct GNUNET_TRANSPORT_Handle *transport_handle;
 173
 174   /**
 175    * The operation handle for transport handle
 176    */
 177   struct GNUNET_TESTBED_Operation *transport_op;
 178
 179   /**
 180    * The core handle to the peer corresponding to this entry; can be NULL
 181    */
 182   struct GNUNET_CORE_Handle *core_handle;
 183
 184   /**
 185    * The operation handle for core handle
 186    */
 187   struct GNUNET_TESTBED_Operation *core_op;
 188
 189   /**
 190    * The peer identity of this peer. Will be set upon opening a connection to
 191    * the peers CORE service. Will be NULL until then and after the CORE
 192    * connection is closed
 193    */
 194   struct GNUNET_PeerIdentity *peer_identity;
 195
 196   /**
 197    * The configuration of the peer. Should be not NULL as long as the core_handle
 198    * or transport_handle are valid
 199    */
 200   struct GNUNET_CONFIGURATION_Handle *cfg;
 201
 202   /**
 203    * The key for this entry
 204    */
 205   struct GNUNET_HashCode key;
 206
 207   /**
 208    * The HELLO message
 209    */
 210   struct GNUNET_MessageHeader *hello;
 211
 212   /**
 213    * the head of the CacheGetHandle queue
 214    */
 215   struct GSTCacheGetHandle *cgh_qhead;
 216
 217   /**
 218    * the tail of the CacheGetHandle queue
 219    */
 220   struct GSTCacheGetHandle *cgh_qtail;
 221
 222   /**
 223    * DLL head for the queue of notifications contexts to check which of them are to
 224    * be notified when a peer is connected.
 225    */
 226   struct ConnectNotifyContext *nctxt_qhead;
 227
 228   /**
 229    * DLL tail for the queue of notifications contexts to check which of them are to
 230    * be notified when a peer is connected.
 231    */
 232   struct ConnectNotifyContext *nctxt_qtail;
 233
 234   /**
 235    * The task that calls the cache callback
 236    */
 237   GNUNET_SCHEDULER_TaskIdentifier notify_task;
 238
 239   /**
 240    * The task to expire this cache entry, free any handlers it has opened and
 241    * mark their corresponding operations as done.
 242    */
 243   GNUNET_SCHEDULER_TaskIdentifier expire_task;
 244
 245   /**
 246    * Number of operations this cache entry is being used
 247    */
 248   unsigned int demand;
 249
 250   /**
 251    * The id of the peer this entry corresponds to
 252    */
 253   unsigned int peer_id;
 254
 255   /**
 256    * Is this entry in LRU cache queue?
 257    */
 258   unsigned int in_lru;
 259 };
 260
 261
 262 /**
 263  * Hashmap to maintain cache
 264  */
 265 static struct GNUNET_CONTAINER_MultiHashMap *cache;
 266
 267 /**
 268  * DLL head for least recently used cache entries; least recently used
 269  * cache items are at the head. The cache enties are added to this queue when
 270  * their demand becomes zero. They are removed from the queue when they are
 271  * needed by any operation.
 272  */
 273 static struct CacheEntry *lru_cache_head;
 274
 275 /**
 276  * DLL tail for least recently used cache entries; recently used cache
 277  * items are at the tail.The cache enties are added to this queue when
 278  * their demand becomes zero. They are removed from the queue when they are
 279  * needed by any operation.
 280  */
 281 static struct CacheEntry *lru_cache_tail;
 282
 283 /**
 284  * the size of the LRU queue
 285  */
 286 static unsigned int lru_cache_size;
 287
 288 /**
 289  * the threshold size for the LRU queue
 290  */
 291 static unsigned int lru_cache_threshold_size;
 292
 293 /**
 294  * The total number of elements in cache
 295  */
 296 static unsigned int cache_size;
 297
 298
 299 /**
 300  * Looks up in the cache and returns the entry
 301  *
 302  * @param key the peer identity of the peer whose corresponding entry has to be
 303  *          looked up
 304  * @return the HELLO message; NULL if not found
 305  */
 306 static struct CacheEntry *
 307 cache_lookup (const struct GNUNET_HashCode *key)
 308 {
 309   struct CacheEntry *entry;
 310
 311   if (NULL == cache)
 312     return NULL;
 313   entry = GNUNET_CONTAINER_multihashmap_get (cache, key);
 314   return entry;
 315 }
 316
 317
 318 /**
 319  * Function to disconnect the core and transport handles; free the existing
 320  * configuration; and remove from the LRU cache list. The entry is left to be in
 321  * the hash table so that the HELLO can still be found later
 322  *
 323  * @param entry the cache entry
 324  */
 325 static void
 326 close_handles (struct CacheEntry *entry)
 327 {
 328   struct ConnectNotifyContext *ctxt;
 329
 330   GNUNET_assert (0 == entry->demand);
 331   if (GNUNET_YES == entry->in_lru)
 332   {
 333     GNUNET_assert (0 < lru_cache_size);
 334     if (GNUNET_SCHEDULER_NO_TASK != entry->expire_task)
 335     {
 336       GNUNET_SCHEDULER_cancel (entry->expire_task);
 337       entry->expire_task = GNUNET_SCHEDULER_NO_TASK;
 338     }
 339     GNUNET_CONTAINER_DLL_remove (lru_cache_head, lru_cache_tail, entry);
 340     lru_cache_size--;
 341     entry->in_lru = GNUNET_NO;
 342   }
 343   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == entry->expire_task);
 344   while (NULL != (ctxt = entry->nctxt_qhead))
 345   {
 346     GNUNET_CONTAINER_DLL_remove (entry->nctxt_qhead, entry->nctxt_qtail, ctxt);
 347     GNUNET_free (ctxt);
 348   }
 349   LOG_DEBUG ("Cleaning up handles from an entry in cache\n");
 350   if (NULL != entry->transport_handle)
 351     GNUNET_assert (NULL != entry->transport_op);
 352   if (NULL != entry->transport_op)
 353   {
 354     GNUNET_TESTBED_operation_done (entry->transport_op);
 355     entry->transport_op = NULL;
 356   }
 357   if (NULL != entry->core_op)
 358   {
 359     GNUNET_TESTBED_operation_done (entry->core_op);
 360     entry->core_op = NULL;
 361   }
 362   GNUNET_assert (NULL == entry->core_handle);
 363   if (NULL != entry->cfg)
 364   {
 365     GNUNET_CONFIGURATION_destroy (entry->cfg);
 366     entry->cfg = NULL;
 367   }
 368 }
 369
 370
 371 /**
 372  * The task to expire this cache entry, free any handlers it has opened and
 373  * mark their corresponding operations as done.
 374  *
 375  * @param cls the CacheEntry
 376  * @param tc the scheduler task context
 377  */
 378 static void
 379 expire_cache_entry (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 380 {
 381   struct CacheEntry *entry = cls;
 382
 383   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != entry->expire_task);
 384   entry->expire_task = GNUNET_SCHEDULER_NO_TASK;
 385   close_handles (entry);
 386 }
 387
 388
 389 /**
 390  * Creates a new cache entry and then puts it into the cache's hashtable.
 391  *
 392  * @param key the hash code to use for inserting the newly created entry
 393  * @param peer_id the index of the peer to tag the newly created entry
 394  * @return the newly created entry
 395  */
 396 static struct CacheEntry *
 397 add_entry (const struct GNUNET_HashCode *key, unsigned int peer_id)
 398 {
 399   struct CacheEntry *entry;
 400
 401   entry = GNUNET_malloc (sizeof (struct CacheEntry));
 402   entry->peer_id = peer_id;
 403   memcpy (&entry->key, key, sizeof (struct GNUNET_HashCode));
 404   GNUNET_assert (GNUNET_OK ==
 405                  GNUNET_CONTAINER_multihashmap_put (cache, &entry->key, entry,
 406                                                     GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST));
 407   cache_size++;
 408   return entry;
 409 }
 410
 411
 412 /**
 413  * Function to find a suitable GSTCacheGetHandle which is waiting for one of the
 414  * handles in given entry to be available.
 415  *
 416  * @param entry the cache entry whose GSTCacheGetHandle list has to be searched
 417  * @param head the starting list element in the GSTCacheGetHandle where the
 418  *          search has to be begin
 419  * @return a suitable GSTCacheGetHandle whose handle ready notify callback
 420  *           hasn't been called yet. NULL if no such suitable GSTCacheGetHandle
 421  *           is found
 422  */
 423 static struct GSTCacheGetHandle *
 424 search_suitable_cgh (const struct CacheEntry *entry,
 425                      const struct GSTCacheGetHandle *head)
 426 {
 427   const struct GSTCacheGetHandle *cgh;
 428
 429   for (cgh = head; NULL != cgh; cgh = cgh->next)
 430   {
 431     if (GNUNET_YES == cgh->notify_called)
 432       return NULL;
 433     switch (cgh->type)
 434     {
 435     case CGT_TRANSPORT_HANDLE:
 436       if (NULL == entry->transport_handle)
 437         continue;
 438       break;
 439     case CGT_CORE_HANDLE:
 440       if (NULL == entry->core_handle)
 441         continue;
 442       if (NULL == entry->peer_identity) /* Our CORE connection isn't ready yet */
 443         continue;
 444       break;
 445     }
 446     break;
 447   }
 448   return (struct GSTCacheGetHandle *) cgh;
 449 }
 450
 451
 452 /**
 453  * Task to call the handle ready notify callback of a queued GSTCacheGetHandle
 454  * of an entry when one or all of its handles are available.
 455  *
 456  * @param cls the cache entry
 457  * @param tc the task context from scheduler
 458  */
 459 static void
 460 call_cgh_cb (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
 461 {
 462   struct CacheEntry *entry = cls;
 463   struct GSTCacheGetHandle *cgh;
 464   const struct GSTCacheGetHandle *cgh2;
 465
 466   GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != entry->notify_task);
 467   entry->notify_task = GNUNET_SCHEDULER_NO_TASK;
 468   cgh = search_suitable_cgh (entry, entry->cgh_qhead);
 469   GNUNET_assert (NULL != cgh);
 470   cgh2 = NULL;
 471   if (NULL != cgh->next)
 472     cgh2 = search_suitable_cgh (entry, cgh->next);
 473   GNUNET_CONTAINER_DLL_remove (entry->cgh_qhead, entry->cgh_qtail, cgh);
 474   cgh->notify_called = GNUNET_YES;
 475   GNUNET_CONTAINER_DLL_insert_tail (entry->cgh_qhead, entry->cgh_qtail, cgh);
 476   if (NULL != cgh2)
 477     entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
 478   if (NULL != cgh->nctxt)
 479   {                             /* Register the peer connect notify callback */
 480     GNUNET_CONTAINER_DLL_insert_tail (entry->nctxt_qhead, entry->nctxt_qtail,
 481                                       cgh->nctxt);
 482   }
 483   LOG_DEBUG ("Calling notify for handle type %u\n", cgh->type);
 484   cgh->cb (cgh->cb_cls, entry->core_handle, entry->transport_handle,
 485            entry->peer_identity);
 486 }
 487
 488
 489 /**
 490  * Function called from peer connect notify callbacks from CORE and TRANSPORT
 491  * connections. This function calls the pendning peer connect notify callbacks
 492  * which are queued in an entry.
 493  *
 494  * @param cls the cache entry
 495  * @param peer the peer that connected
 496  * @param type the type of the handle this notification corresponds to
 497  */
 498 static void
 499 peer_connect_notify_cb (void *cls, const struct GNUNET_PeerIdentity *peer,
 500                         const enum CacheGetType type)
 501 {
 502   struct CacheEntry *entry = cls;
 503   struct ConnectNotifyContext *ctxt;
 504   struct ConnectNotifyContext *ctxt2;
 505   GST_cache_peer_connect_notify cb;
 506   void *cb_cls;
 507
 508
 509   for (ctxt = entry->nctxt_qhead; NULL != ctxt;)
 510   {
 511     GNUNET_assert (NULL != ctxt->cgh);
 512     if (type != ctxt->cgh->type)
 513     {
 514       ctxt = ctxt->next;
 515       continue;
 516     }
 517     if (0 != memcmp (ctxt->target, peer, sizeof (struct GNUNET_PeerIdentity)))
 518     {
 519       ctxt = ctxt->next;
 520       continue;
 521     }
 522     cb = ctxt->cb;
 523     cb_cls = ctxt->cb_cls;
 524     ctxt->cgh->nctxt = NULL;
 525     ctxt2 = ctxt->next;
 526     GNUNET_CONTAINER_DLL_remove (entry->nctxt_qhead, entry->nctxt_qtail, ctxt);
 527     GNUNET_free (ctxt);
 528     ctxt = ctxt2;
 529     cb (cb_cls, peer);
 530   }
 531   if (NULL == ctxt)
 532     return;
 533
 534 }
 535
 536
 537 /**
 538  * Function called to notify transport users that another
 539  * peer connected to us.
 540  *
 541  * @param cls closure
 542  * @param peer the peer that connected
 543  * @param ats performance data
 544  * @param ats_count number of entries in ats (excluding 0-termination)
 545  */
 546 static void
 547 transport_peer_connect_notify_cb (void *cls,
 548                                   const struct GNUNET_PeerIdentity *peer)
 549 {
 550   peer_connect_notify_cb (cls, peer, CGT_TRANSPORT_HANDLE);
 551 }
 552
 553
 554 /**
 555  * Function called when resources for opening a connection to TRANSPORT are
 556  * available.
 557  *
 558  * @param cls the cache entry
 559  */
 560 static void
 561 opstart_get_handle_transport (void *cls)
 562 {
 563   struct CacheEntry *entry = cls;
 564
 565   GNUNET_assert (NULL != entry);
 566   LOG_DEBUG ("Opening a transport connection to peer %u\n", entry->peer_id);
 567   entry->transport_handle =
 568       GNUNET_TRANSPORT_connect (entry->cfg, NULL, entry, NULL,
 569                                 &transport_peer_connect_notify_cb, NULL);
 570   if (NULL == entry->transport_handle)
 571   {
 572     GNUNET_break (0);
 573     return;
 574   }
 575   if (0 == entry->demand)
 576     return;
 577   if (GNUNET_SCHEDULER_NO_TASK != entry->notify_task)
 578     return;
 579   if (NULL != search_suitable_cgh (entry, entry->cgh_qhead))
 580     entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
 581 }
 582
 583
 584 /**
 585  * Function called when the operation responsible for opening a TRANSPORT
 586  * connection is marked as done.
 587  *
 588  * @param cls the cache entry
 589  */
 590 static void
 591 oprelease_get_handle_transport (void *cls)
 592 {
 593   struct CacheEntry *entry = cls;
 594
 595   if (NULL == entry->transport_handle)
 596     return;
 597   GNUNET_TRANSPORT_disconnect (entry->transport_handle);
 598   entry->transport_handle = NULL;
 599 }
 600
 601
 602 /**
 603  * Function called after GNUNET_CORE_connect has succeeded (or failed
 604  * for good).  Note that the private key of the peer is intentionally
 605  * not exposed here; if you need it, your process should try to read
 606  * the private key file directly (which should work if you are
 607  * authorized...).  Implementations of this function must not call
 608  * GNUNET_CORE_disconnect (other than by scheduling a new task to
 609  * do this later).
 610  *
 611  * @param cls closure
 612  * @param server handle to the server, NULL if we failed
 613  * @param my_identity ID of this peer, NULL if we failed
 614  */
 615 static void
 616 core_startup_cb (void *cls, struct GNUNET_CORE_Handle *server,
 617                  const struct GNUNET_PeerIdentity *my_identity)
 618 {
 619   struct CacheEntry *entry = cls;
 620
 621   if (NULL == my_identity)
 622   {
 623     GNUNET_break (0);
 624     return;
 625   }
 626   GNUNET_assert (NULL == entry->peer_identity);
 627   GNUNET_break (NULL != server);
 628   entry->core_handle = server;
 629   entry->peer_identity = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
 630   memcpy (entry->peer_identity, my_identity,
 631           sizeof (struct GNUNET_PeerIdentity));
 632   if (0 == entry->demand)
 633     return;
 634   if (GNUNET_SCHEDULER_NO_TASK != entry->notify_task)
 635     return;
 636   if (NULL != search_suitable_cgh (entry, entry->cgh_qhead))
 637     entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
 638 }
 639
 640
 641 /**
 642  * Method called whenever a given peer connects at CORE level
 643  *
 644  * @param cls closure
 645  * @param peer peer identity this notification is about
 646  */
 647 static void
 648 core_peer_connect_cb (void *cls, const struct GNUNET_PeerIdentity *peer)
 649 {
 650   peer_connect_notify_cb (cls, peer, CGT_CORE_HANDLE);
 651 }
 652
 653
 654 /**
 655  * Function called when resources for opening a connection to CORE are
 656  * available.
 657  *
 658  * @param cls the cache entry
 659  */
 660 static void
 661 opstart_get_handle_core (void *cls)
 662 {
 663   struct CacheEntry *entry = cls;
 664
 665   const struct GNUNET_CORE_MessageHandler no_handlers[] = {
 666     {NULL, 0, 0}
 667   };
 668
 669   GNUNET_assert (NULL != entry);
 670   LOG_DEBUG ("Opening a CORE connection to peer %u\n", entry->peer_id);
 671   entry->core_handle =
 672       GNUNET_CORE_connect (entry->cfg, entry,        /* closure */
 673                            &core_startup_cb, /* core startup notify */
 674                            &core_peer_connect_cb,    /* peer connect notify */
 675                            NULL,     /* peer disconnect notify */
 676                            NULL,     /* inbound notify */
 677                            GNUNET_NO,        /* inbound header only? */
 678                            NULL,     /* outbound notify */
 679                            GNUNET_NO,        /* outbound header only? */
 680                            no_handlers);
 681 }
 682
 683
 684 /**
 685  * Function called when the operation responsible for opening a TRANSPORT
 686  * connection is marked as done.
 687  *
 688  * @param cls the cache entry
 689  */
 690 static void
 691 oprelease_get_handle_core (void *cls)
 692 {
 693   struct CacheEntry *entry = cls;
 694
 695   if (NULL == entry->core_handle)
 696     return;
 697   GNUNET_CORE_disconnect (entry->core_handle);
 698   entry->core_handle = NULL;
 699   GNUNET_free_non_null (entry->peer_identity);
 700   entry->peer_identity = NULL;
 701 }
 702
 703
 704 /**
 705  * Function to get a handle with given configuration. The type of the handle is
 706  * implicitly provided in the GSTCacheGetHandle. If the handle is already cached
 707  * before, it will be retured in the given callback; the peer_id is used to
 708  * lookup in the cache; if not, a new operation is started to open the transport
 709  * handle and will be given in the callback when it is available.
 710  *
 711  * @param peer_id the index of the peer
 712  * @param cgh the CacheGetHandle
 713  * @param cfg the configuration with which the transport handle has to be
 714  *          created if it was not present in the cache
 715  * @param target the peer identify of the peer whose connection to
 716  *          TRANSPORT/CORE (depending on the type of 'cgh') subsystem will be
 717  *          notified through the connect_notify_cb. Can be NULL
 718  * @param connect_notify_cb the callback to call when the given target peer is
 719  *          connected. This callback will only be called once or never again (in
 720  *          case the target peer cannot be connected). Can be NULL
 721  * @param connect_notify_cb_cls the closure for the above callback
 722  * @return the handle which can be used to cancel or mark that the handle is no
 723  *           longer being used
 724  */
 725 static struct GSTCacheGetHandle *
 726 cache_get_handle (unsigned int peer_id, struct GSTCacheGetHandle *cgh,
 727                   const struct GNUNET_CONFIGURATION_Handle *cfg,
 728                   const struct GNUNET_PeerIdentity *target,
 729                   GST_cache_peer_connect_notify connect_notify_cb,
 730                   void *connect_notify_cb_cls)
 731 {
 732   struct GNUNET_HashCode key;
 733   void *handle;
 734   struct CacheEntry *entry;
 735   struct ConnectNotifyContext *ctxt;
 736   struct GNUNET_TESTBED_Operation *op;
 737
 738   GNUNET_assert (0 != cgh->type);
 739   GNUNET_CRYPTO_hash (&peer_id, sizeof (peer_id), &key);
 740   handle = NULL;
 741   entry = cache_lookup (&key);
 742   if (NULL != entry)
 743   {
 744     if (GNUNET_YES == entry->in_lru)
 745     {
 746       GNUNET_assert (0 == entry->demand);
 747       GNUNET_assert (0 < lru_cache_size);
 748       if (GNUNET_SCHEDULER_NO_TASK != entry->expire_task)
 749       {
 750         GNUNET_SCHEDULER_cancel (entry->expire_task);
 751         entry->expire_task = GNUNET_SCHEDULER_NO_TASK;
 752       }
 753       GNUNET_CONTAINER_DLL_remove (lru_cache_head, lru_cache_tail, entry);
 754       lru_cache_size--;
 755       entry->in_lru = GNUNET_NO;
 756     }
 757     switch (cgh->type)
 758     {
 759     case CGT_TRANSPORT_HANDLE:
 760       handle = entry->transport_handle;
 761       if (NULL != handle)
 762         LOG_DEBUG ("Found TRANSPORT handle in cache for peer %u\n",
 763                    entry->peer_id);
 764       break;
 765     case CGT_CORE_HANDLE:
 766       handle = entry->core_handle;
 767       if (NULL != handle)
 768         LOG_DEBUG ("Found CORE handle in cache for peer %u\n", entry->peer_id);
 769       break;
 770     }
 771   }
 772   if (NULL == entry)
 773     entry = add_entry (&key, peer_id);
 774   if (NULL == entry->cfg)
 775     entry->cfg = GNUNET_CONFIGURATION_dup (cfg);
 776   entry->demand++;
 777   cgh->entry = entry;
 778   GNUNET_CONTAINER_DLL_insert (entry->cgh_qhead, entry->cgh_qtail, cgh);
 779   if ((NULL != target) && (NULL != connect_notify_cb))
 780   {
 781     ctxt = GNUNET_malloc (sizeof (struct ConnectNotifyContext));
 782     ctxt->target = target;
 783     ctxt->cb = connect_notify_cb;
 784     ctxt->cb_cls = connect_notify_cb_cls;
 785     GNUNET_assert (NULL == cgh->nctxt);
 786     cgh->nctxt = ctxt;
 787     ctxt->cgh = cgh;
 788   }
 789   if (NULL != handle)
 790   {
 791     if (GNUNET_SCHEDULER_NO_TASK == entry->notify_task)
 792     {
 793       if (NULL != search_suitable_cgh (entry, entry->cgh_qhead))
 794         entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
 795     }
 796     return cgh;
 797   }
 798   switch (cgh->type)
 799   {
 800   case CGT_TRANSPORT_HANDLE:
 801     if (NULL != entry->transport_op)
 802       return cgh;
 803     op = GNUNET_TESTBED_operation_create_ (entry, &opstart_get_handle_transport,
 804                                            &oprelease_get_handle_transport);
 805     entry->transport_op = op;
 806     break;
 807   case CGT_CORE_HANDLE:
 808     if (NULL != entry->core_op)
 809       return cgh;
 810     op = GNUNET_TESTBED_operation_create_ (entry, &opstart_get_handle_core,
 811                                            &oprelease_get_handle_core);
 812     entry->core_op = op;
 813     break;
 814   }
 815   GNUNET_TESTBED_operation_queue_insert_ (GST_opq_openfds, op);
 816   GNUNET_TESTBED_operation_begin_wait_ (op);
 817   return cgh;
 818 }
 819
 820
 821 /**
 822  * Iterator over hash map entries.
 823  *
 824  * @param cls closure
 825  * @param key current key code
 826  * @param value value in the hash map
 827  * @return GNUNET_YES if we should continue to
 828  *         iterate,
 829  *         GNUNET_NO if not.
 830  */
 831 static int
 832 cache_clear_iterator (void *cls, const struct GNUNET_HashCode *key, void *value)
 833 {
 834   struct CacheEntry *entry = value;
 835   static unsigned int ncleared;
 836
 837   GNUNET_assert (NULL != entry);
 838   GNUNET_break (0 == entry->demand);
 839   LOG_DEBUG ("Clearing entry %u of %u\n", ++ncleared, cache_size);
 840   GNUNET_CONTAINER_multihashmap_remove (cache, key, value);
 841   close_handles (entry);
 842   GNUNET_free_non_null (entry->hello);
 843   GNUNET_break (GNUNET_SCHEDULER_NO_TASK == entry->expire_task);
 844   GNUNET_assert (NULL == entry->transport_handle);
 845   GNUNET_assert (NULL == entry->transport_op);
 846   GNUNET_assert (NULL == entry->core_handle);
 847   GNUNET_assert (NULL == entry->core_op);
 848   GNUNET_assert (NULL == entry->cfg);
 849   GNUNET_assert (NULL == entry->cgh_qhead);
 850   GNUNET_assert (NULL == entry->cgh_qtail);
 851   GNUNET_assert (NULL == entry->nctxt_qhead);
 852   GNUNET_assert (NULL == entry->nctxt_qtail);
 853   GNUNET_free (entry);
 854   return GNUNET_YES;
 855 }
 856
 857
 858 /**
 859  * Clear cache
 860  */
 861 void
 862 GST_cache_clear ()
 863 {
 864   GNUNET_CONTAINER_multihashmap_iterate (cache, &cache_clear_iterator, NULL);
 865   GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (cache));
 866   GNUNET_CONTAINER_multihashmap_destroy (cache);
 867   cache = NULL;
 868   lru_cache_size = 0;
 869   lru_cache_threshold_size = 0;
 870   cache_size = 0;
 871   lru_cache_head = NULL;
 872   lru_cache_tail = NULL;
 873 }
 874
 875
 876 /**
 877  * Initializes the cache
 878  *
 879  * @param size the size of the cache
 880  */
 881 void
 882 GST_cache_init (unsigned int size)
 883 {
 884   if (0 == size)
 885     return;
 886   lru_cache_threshold_size = size;
 887   if (size > 1)
 888     size = size / 2;
 889   cache = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_YES);
 890 }
 891
 892
 893 /**
 894  * Mark the GetCacheHandle as being done if a handle has been provided already
 895  * or as being cancelled if the callback for the handle hasn't been called.
 896  *
 897  * @param cgh the CacheGetHandle handle
 898  */
 899 void
 900 GST_cache_get_handle_done (struct GSTCacheGetHandle *cgh)
 901 {
 902   struct CacheEntry *entry;
 903
 904   entry = cgh->entry;
 905   GNUNET_assert (NULL != entry);
 906   GNUNET_assert (0 < entry->demand);
 907   entry->demand--;
 908   if (GNUNET_SCHEDULER_NO_TASK != entry->notify_task)
 909   {
 910     GNUNET_SCHEDULER_cancel (entry->notify_task);
 911     entry->notify_task = GNUNET_SCHEDULER_NO_TASK;
 912   }
 913   GNUNET_CONTAINER_DLL_remove (entry->cgh_qhead, entry->cgh_qtail, cgh);
 914   if (NULL != cgh->nctxt)
 915   {
 916     GNUNET_assert (cgh == cgh->nctxt->cgh);
 917     if (GNUNET_YES == cgh->notify_called)
 918       GNUNET_CONTAINER_DLL_remove (entry->nctxt_qhead, entry->nctxt_qtail,
 919                                    cgh->nctxt);
 920     GNUNET_free (cgh->nctxt);
 921   }
 922   GNUNET_free (cgh);
 923   if (0 == entry->demand)
 924   {
 925     entry->expire_task =
 926         GNUNET_SCHEDULER_add_delayed (CACHE_EXPIRY, &expire_cache_entry, entry);
 927     GNUNET_CONTAINER_DLL_insert_tail (lru_cache_head, lru_cache_tail, entry);
 928     lru_cache_size++;
 929     entry->in_lru = GNUNET_YES;
 930     if (lru_cache_size > lru_cache_threshold_size)
 931       close_handles (lru_cache_head);
 932   }
 933   else
 934   {
 935     struct GSTCacheGetHandle *cgh2;
 936
 937     if (NULL != (cgh2 = search_suitable_cgh (entry, entry->cgh_qhead)))
 938       entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
 939   }
 940 }
 941
 942
 943 /**
 944  * Get a transport handle with the given configuration.  If the handle is
 945  * already cached before, it will be retured in the given callback; the peer_id
 946  * is used to lookup in the cache; if not, a new operation is started to open the
 947  * transport handle and will be given in the callback when it is available.
 948  *
 949  * @param peer_id the index of the peer
 950  * @param cfg the configuration with which the transport handle has to be
 951  *          created if it was not present in the cache
 952  * @param cb the callback to notify when the transport handle is available
 953  * @param cb_cls the closure for the above callback
 954  * @param target the peer identify of the peer whose connection to our TRANSPORT
 955  *          subsystem will be notified through the connect_notify_cb. Can be NULL
 956  * @param connect_notify_cb the callback to call when the given target peer is
 957  *          connected. This callback will only be called once or never again (in
 958  *          case the target peer cannot be connected). Can be NULL
 959  * @param connect_notify_cb_cls the closure for the above callback
 960  * @return the handle which can be used to cancel or mark that the handle is no
 961  *           longer being used
 962  */
 963 struct GSTCacheGetHandle *
 964 GST_cache_get_handle_transport (unsigned int peer_id,
 965                                 const struct GNUNET_CONFIGURATION_Handle *cfg,
 966                                 GST_cache_handle_ready_cb cb, void *cb_cls,
 967                                 const struct GNUNET_PeerIdentity *target,
 968                                 GST_cache_peer_connect_notify connect_notify_cb,
 969                                 void *connect_notify_cb_cls)
 970 {
 971   struct GSTCacheGetHandle *cgh;
 972
 973   cgh = GNUNET_malloc (sizeof (struct GSTCacheGetHandle));
 974   cgh->cb = cb;
 975   cgh->cb_cls = cb_cls;
 976   cgh->type = CGT_TRANSPORT_HANDLE;
 977   return cache_get_handle (peer_id, cgh, cfg, target, connect_notify_cb,
 978                            connect_notify_cb_cls);
 979 }
 980
 981
 982 /**
 983  * Get a CORE handle with the given configuration. If the handle is already
 984  * cached before, it will be retured in the given callback; the peer_id is used
 985  * to lookup in the cache. If the handle is not cached before, a new operation
 986  * is started to open the CORE handle and will be given in the callback when it
 987  * is available along with the peer identity
 988  *
 989  * @param peer_id the index of the peer
 990  * @param cfg the configuration with which the transport handle has to be
 991  *          created if it was not present in the cache
 992  * @param cb the callback to notify when the transport handle is available
 993  * @param cb_cls the closure for the above callback
 994  * @param target the peer identify of the peer whose connection to our CORE
 995  *          subsystem will be notified through the connect_notify_cb. Can be NULL
 996  * @param connect_notify_cb the callback to call when the given target peer is
 997  *          connected. This callback will only be called once or never again (in
 998  *          case the target peer cannot be connected). Can be NULL
 999  * @param connect_notify_cb_cls the closure for the above callback
1000  * @return the handle which can be used to cancel or mark that the handle is no
1001  *           longer being used
1002  */
1003 struct GSTCacheGetHandle *
1004 GST_cache_get_handle_core (unsigned int peer_id,
1005                            const struct GNUNET_CONFIGURATION_Handle *cfg,
1006                            GST_cache_handle_ready_cb cb, void *cb_cls,
1007                            const struct GNUNET_PeerIdentity *target,
1008                            GST_cache_peer_connect_notify connect_notify_cb,
1009                            void *connect_notify_cb_cls)
1010 {
1011   struct GSTCacheGetHandle *cgh;
1012
1013   cgh = GNUNET_malloc (sizeof (struct GSTCacheGetHandle));
1014   cgh->cb = cb;
1015   cgh->cb_cls = cb_cls;
1016   cgh->type = CGT_CORE_HANDLE;
1017   return cache_get_handle (peer_id, cgh, cfg, target, connect_notify_cb,
1018                            connect_notify_cb_cls);
1019 }
1020
1021
1022 /**
1023  * Looks up in the hello cache and returns the HELLO of the given peer
1024  *
1025  * @param peer_id the index of the peer whose HELLO has to be looked up
1026  * @return the HELLO message; NULL if not found
1027  */
1028 const struct GNUNET_MessageHeader *
1029 GST_cache_lookup_hello (const unsigned int peer_id)
1030 {
1031   struct CacheEntry *entry;
1032   struct GNUNET_HashCode key;
1033
1034   LOG_DEBUG ("Looking up HELLO for peer %u\n", peer_id);
1035   GNUNET_CRYPTO_hash (&peer_id, sizeof (peer_id), &key);
1036   entry = cache_lookup (&key);
1037   if (NULL == entry)
1038     return NULL;
1039   if (NULL != entry->hello)
1040     LOG_DEBUG ("HELLO found for peer %u\n", peer_id);
1041   return entry->hello;
1042 }
1043
1044
1045 /**
1046  * Caches the HELLO of the given peer. Updates the HELLO if it was already
1047  * cached before
1048  *
1049  * @param peer_id the peer identity of the peer whose HELLO has to be cached
1050  * @param hello the HELLO message
1051  */
1052 void
1053 GST_cache_add_hello (const unsigned int peer_id,
1054                      const struct GNUNET_MessageHeader *hello)
1055 {
1056   struct CacheEntry *entry;
1057   struct GNUNET_HashCode key;
1058
1059   GNUNET_CRYPTO_hash (&peer_id, sizeof (peer_id), &key);
1060   entry = GNUNET_CONTAINER_multihashmap_get (cache, &key);
1061   if (NULL == entry)
1062     entry = add_entry (&key, peer_id);
1063   GNUNET_free_non_null (entry->hello);
1064   entry->hello = GNUNET_copy_message (hello);
1065 }
1066
1067 /* end of gnunet-service-testbed_hc.c */