2 This file is part of GNUnet.
3 (C) 2012 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file testbed/gnunet-service-testbed_cache.c
23 * @brief testbed cache implementation
24 * @author Sree Harsha Totakura
26 #include "gnunet-service-testbed.h"
29 * Redefine LOG with a changed log component string
34 #define LOG(kind,...) \
35 GNUNET_log_from (kind, "testbed-cache", __VA_ARGS__)
39 * Time to expire a cache entry
41 #define CACHE_EXPIRY \
42 GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
46 * Type of cache-get requests
51 * Get transport handle
53 CGT_TRANSPORT_HANDLE = 1,
63 * The cache-get request handle
65 struct GSTCacheGetHandle;
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.
72 struct ConnectNotifyContext
75 * The next ptr for the DLL
77 struct ConnectNotifyContext *next;
80 * The prev ptr for the DLL
82 struct ConnectNotifyContext *prev;
85 * The peer identity of the target peer. When this target peer is connected,
86 * call the notify callback
88 const struct GNUNET_PeerIdentity *target;
91 * The notify callback to be called when the target peer is connected
93 GST_cache_peer_connect_notify cb;
96 * The closure for the notify callback
101 * The GSTCacheGetHandle reposible for creating this context
103 struct GSTCacheGetHandle *cgh;
109 * The cache-get request handle
111 struct GSTCacheGetHandle
114 * The next ptr for the DLL. Used in struct CacheEntry
116 struct GSTCacheGetHandle *next;
119 * The prev ptr for the DLL. Used in struct CacheEntry
121 struct GSTCacheGetHandle *prev;
124 * The cache entry object this handle corresponds to
126 struct CacheEntry *entry;
129 * The cache callback to call when a handle is available
131 GST_cache_handle_ready_cb cb;
134 * The closure for the above callback
139 * The peer connect notify context created for this handle; can be NULL
141 struct ConnectNotifyContext *nctxt;
144 * The type of this cache-get request
146 enum CacheGetType type;
149 * Did we call the cache callback already?
160 * DLL next ptr for least recently used cache entries
162 struct CacheEntry *next;
165 * DLL prev ptr for least recently used cache entries
167 struct CacheEntry *prev;
170 * The transport handle to the peer corresponding to this entry; can be NULL
172 struct GNUNET_TRANSPORT_Handle *transport_handle;
175 * The operation handle for transport handle
177 struct GNUNET_TESTBED_Operation *transport_op;
180 * The core handle to the peer corresponding to this entry; can be NULL
182 struct GNUNET_CORE_Handle *core_handle;
185 * The operation handle for core handle
187 struct GNUNET_TESTBED_Operation *core_op;
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
194 struct GNUNET_PeerIdentity *peer_identity;
197 * The configuration of the peer. Should be not NULL as long as the core_handle
198 * or transport_handle are valid
200 struct GNUNET_CONFIGURATION_Handle *cfg;
203 * The key for this entry
205 struct GNUNET_HashCode key;
210 struct GNUNET_MessageHeader *hello;
213 * the head of the CacheGetHandle queue
215 struct GSTCacheGetHandle *cgh_qhead;
218 * the tail of the CacheGetHandle queue
220 struct GSTCacheGetHandle *cgh_qtail;
223 * DLL head for the queue of notifications contexts to check which of them are to
224 * be notified when a peer is connected.
226 struct ConnectNotifyContext *nctxt_qhead;
229 * DLL tail for the queue of notifications contexts to check which of them are to
230 * be notified when a peer is connected.
232 struct ConnectNotifyContext *nctxt_qtail;
235 * The task that calls the cache callback
237 GNUNET_SCHEDULER_TaskIdentifier notify_task;
240 * The task to expire this cache entry, free any handlers it has opened and
241 * mark their corresponding operations as done.
243 GNUNET_SCHEDULER_TaskIdentifier expire_task;
246 * Number of operations this cache entry is being used
251 * The id of the peer this entry corresponds to
253 unsigned int peer_id;
256 * Is this entry in LRU cache queue?
263 * Hashmap to maintain cache
265 static struct GNUNET_CONTAINER_MultiHashMap *cache;
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.
273 static struct CacheEntry *lru_cache_head;
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.
281 static struct CacheEntry *lru_cache_tail;
284 * the size of the LRU queue
286 static unsigned int lru_cache_size;
289 * the threshold size for the LRU queue
291 static unsigned int lru_cache_threshold_size;
294 * The total number of elements in cache
296 static unsigned int cache_size;
300 * Looks up in the cache and returns the entry
302 * @param key the peer identity of the peer whose corresponding entry has to be
304 * @return the HELLO message; NULL if not found
306 static struct CacheEntry *
307 cache_lookup (const struct GNUNET_HashCode *key)
309 struct CacheEntry *entry;
313 entry = GNUNET_CONTAINER_multihashmap_get (cache, key);
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
323 * @param entry the cache entry
326 close_handles (struct CacheEntry *entry)
328 struct ConnectNotifyContext *ctxt;
330 GNUNET_assert (0 == entry->demand);
331 if (GNUNET_YES == entry->in_lru)
333 GNUNET_assert (0 < lru_cache_size);
334 if (GNUNET_SCHEDULER_NO_TASK != entry->expire_task)
336 GNUNET_SCHEDULER_cancel (entry->expire_task);
337 entry->expire_task = GNUNET_SCHEDULER_NO_TASK;
339 GNUNET_CONTAINER_DLL_remove (lru_cache_head, lru_cache_tail, entry);
341 entry->in_lru = GNUNET_NO;
343 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == entry->expire_task);
344 while (NULL != (ctxt = entry->nctxt_qhead))
346 GNUNET_CONTAINER_DLL_remove (entry->nctxt_qhead, entry->nctxt_qtail, ctxt);
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)
354 GNUNET_TESTBED_operation_done (entry->transport_op);
355 entry->transport_op = NULL;
357 if (NULL != entry->core_op)
359 GNUNET_TESTBED_operation_done (entry->core_op);
360 entry->core_op = NULL;
362 GNUNET_assert (NULL == entry->core_handle);
363 if (NULL != entry->cfg)
365 GNUNET_CONFIGURATION_destroy (entry->cfg);
372 * The task to expire this cache entry, free any handlers it has opened and
373 * mark their corresponding operations as done.
375 * @param cls the CacheEntry
376 * @param tc the scheduler task context
379 expire_cache_entry (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
381 struct CacheEntry *entry = cls;
383 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != entry->expire_task);
384 entry->expire_task = GNUNET_SCHEDULER_NO_TASK;
385 close_handles (entry);
390 * Creates a new cache entry and then puts it into the cache's hashtable.
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
396 static struct CacheEntry *
397 add_entry (const struct GNUNET_HashCode *key, unsigned int peer_id)
399 struct CacheEntry *entry;
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));
413 * Function to find a suitable GSTCacheGetHandle which is waiting for one of the
414 * handles in given entry to be available.
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
423 static struct GSTCacheGetHandle *
424 search_suitable_cgh (const struct CacheEntry *entry,
425 const struct GSTCacheGetHandle *head)
427 const struct GSTCacheGetHandle *cgh;
429 for (cgh = head; NULL != cgh; cgh = cgh->next)
431 if (GNUNET_YES == cgh->notify_called)
435 case CGT_TRANSPORT_HANDLE:
436 if (NULL == entry->transport_handle)
439 case CGT_CORE_HANDLE:
440 if (NULL == entry->core_handle)
442 if (NULL == entry->peer_identity) /* Our CORE connection isn't ready yet */
448 return (struct GSTCacheGetHandle *) cgh;
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.
456 * @param cls the cache entry
457 * @param tc the task context from scheduler
460 call_cgh_cb (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
462 struct CacheEntry *entry = cls;
463 struct GSTCacheGetHandle *cgh;
464 const struct GSTCacheGetHandle *cgh2;
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);
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);
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,
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);
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.
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
499 peer_connect_notify_cb (void *cls, const struct GNUNET_PeerIdentity *peer,
500 const enum CacheGetType type)
502 struct CacheEntry *entry = cls;
503 struct ConnectNotifyContext *ctxt;
504 struct ConnectNotifyContext *ctxt2;
505 GST_cache_peer_connect_notify cb;
509 for (ctxt = entry->nctxt_qhead; NULL != ctxt;)
511 GNUNET_assert (NULL != ctxt->cgh);
512 if (type != ctxt->cgh->type)
517 if (0 != memcmp (ctxt->target, peer, sizeof (struct GNUNET_PeerIdentity)))
523 cb_cls = ctxt->cb_cls;
524 ctxt->cgh->nctxt = NULL;
526 GNUNET_CONTAINER_DLL_remove (entry->nctxt_qhead, entry->nctxt_qtail, ctxt);
538 * Function called to notify transport users that another
539 * peer connected to us.
542 * @param peer the peer that connected
545 transport_peer_connect_notify_cb (void *cls,
546 const struct GNUNET_PeerIdentity *peer)
548 peer_connect_notify_cb (cls, peer, CGT_TRANSPORT_HANDLE);
553 * Function called when resources for opening a connection to TRANSPORT are
556 * @param cls the cache entry
559 opstart_get_handle_transport (void *cls)
561 struct CacheEntry *entry = cls;
563 GNUNET_assert (NULL != entry);
564 LOG_DEBUG ("Opening a transport connection to peer %u\n", entry->peer_id);
565 entry->transport_handle =
566 GNUNET_TRANSPORT_connect (entry->cfg, NULL, entry, NULL,
567 &transport_peer_connect_notify_cb, NULL);
568 if (NULL == entry->transport_handle)
573 if (0 == entry->demand)
575 if (GNUNET_SCHEDULER_NO_TASK != entry->notify_task)
577 if (NULL != search_suitable_cgh (entry, entry->cgh_qhead))
578 entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
583 * Function called when the operation responsible for opening a TRANSPORT
584 * connection is marked as done.
586 * @param cls the cache entry
589 oprelease_get_handle_transport (void *cls)
591 struct CacheEntry *entry = cls;
593 if (NULL == entry->transport_handle)
595 GNUNET_TRANSPORT_disconnect (entry->transport_handle);
596 entry->transport_handle = NULL;
601 * Function called after GNUNET_CORE_connect has succeeded (or failed
602 * for good). Note that the private key of the peer is intentionally
603 * not exposed here; if you need it, your process should try to read
604 * the private key file directly (which should work if you are
605 * authorized...). Implementations of this function must not call
606 * GNUNET_CORE_disconnect (other than by scheduling a new task to
610 * @param server handle to the server, NULL if we failed
611 * @param my_identity ID of this peer, NULL if we failed
614 core_startup_cb (void *cls, struct GNUNET_CORE_Handle *server,
615 const struct GNUNET_PeerIdentity *my_identity)
617 struct CacheEntry *entry = cls;
619 if (NULL == my_identity)
624 GNUNET_assert (NULL == entry->peer_identity);
625 GNUNET_break (NULL != server);
626 entry->core_handle = server;
627 entry->peer_identity = GNUNET_malloc (sizeof (struct GNUNET_PeerIdentity));
628 memcpy (entry->peer_identity, my_identity,
629 sizeof (struct GNUNET_PeerIdentity));
630 if (0 == entry->demand)
632 if (GNUNET_SCHEDULER_NO_TASK != entry->notify_task)
634 if (NULL != search_suitable_cgh (entry, entry->cgh_qhead))
635 entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
640 * Method called whenever a given peer connects at CORE level
643 * @param peer peer identity this notification is about
646 core_peer_connect_cb (void *cls, const struct GNUNET_PeerIdentity *peer)
648 peer_connect_notify_cb (cls, peer, CGT_CORE_HANDLE);
653 * Function called when resources for opening a connection to CORE are
656 * @param cls the cache entry
659 opstart_get_handle_core (void *cls)
661 struct CacheEntry *entry = cls;
663 const struct GNUNET_CORE_MessageHandler no_handlers[] = {
667 GNUNET_assert (NULL != entry);
668 LOG_DEBUG ("Opening a CORE connection to peer %u\n", entry->peer_id);
670 GNUNET_CORE_connect (entry->cfg, entry, /* closure */
671 &core_startup_cb, /* core startup notify */
672 &core_peer_connect_cb, /* peer connect notify */
673 NULL, /* peer disconnect notify */
674 NULL, /* inbound notify */
675 GNUNET_NO, /* inbound header only? */
676 NULL, /* outbound notify */
677 GNUNET_NO, /* outbound header only? */
683 * Function called when the operation responsible for opening a TRANSPORT
684 * connection is marked as done.
686 * @param cls the cache entry
689 oprelease_get_handle_core (void *cls)
691 struct CacheEntry *entry = cls;
693 if (NULL == entry->core_handle)
695 GNUNET_CORE_disconnect (entry->core_handle);
696 entry->core_handle = NULL;
697 GNUNET_free_non_null (entry->peer_identity);
698 entry->peer_identity = NULL;
703 * Function to get a handle with given configuration. The type of the handle is
704 * implicitly provided in the GSTCacheGetHandle. If the handle is already cached
705 * before, it will be retured in the given callback; the peer_id is used to
706 * lookup in the cache; if not, a new operation is started to open the transport
707 * handle and will be given in the callback when it is available.
709 * @param peer_id the index of the peer
710 * @param cgh the CacheGetHandle
711 * @param cfg the configuration with which the transport handle has to be
712 * created if it was not present in the cache
713 * @param target the peer identify of the peer whose connection to
714 * TRANSPORT/CORE (depending on the type of 'cgh') subsystem will be
715 * notified through the connect_notify_cb. Can be NULL
716 * @param connect_notify_cb the callback to call when the given target peer is
717 * connected. This callback will only be called once or never again (in
718 * case the target peer cannot be connected). Can be NULL
719 * @param connect_notify_cb_cls the closure for the above callback
720 * @return the handle which can be used to cancel or mark that the handle is no
723 static struct GSTCacheGetHandle *
724 cache_get_handle (unsigned int peer_id, struct GSTCacheGetHandle *cgh,
725 const struct GNUNET_CONFIGURATION_Handle *cfg,
726 const struct GNUNET_PeerIdentity *target,
727 GST_cache_peer_connect_notify connect_notify_cb,
728 void *connect_notify_cb_cls)
730 struct GNUNET_HashCode key;
732 struct CacheEntry *entry;
733 struct ConnectNotifyContext *ctxt;
734 struct GNUNET_TESTBED_Operation *op;
736 GNUNET_assert (0 != cgh->type);
737 GNUNET_CRYPTO_hash (&peer_id, sizeof (peer_id), &key);
739 entry = cache_lookup (&key);
742 if (GNUNET_YES == entry->in_lru)
744 GNUNET_assert (0 == entry->demand);
745 GNUNET_assert (0 < lru_cache_size);
746 if (GNUNET_SCHEDULER_NO_TASK != entry->expire_task)
748 GNUNET_SCHEDULER_cancel (entry->expire_task);
749 entry->expire_task = GNUNET_SCHEDULER_NO_TASK;
751 GNUNET_CONTAINER_DLL_remove (lru_cache_head, lru_cache_tail, entry);
753 entry->in_lru = GNUNET_NO;
757 case CGT_TRANSPORT_HANDLE:
758 handle = entry->transport_handle;
760 LOG_DEBUG ("Found TRANSPORT handle in cache for peer %u\n",
763 case CGT_CORE_HANDLE:
764 handle = entry->core_handle;
766 LOG_DEBUG ("Found CORE handle in cache for peer %u\n", entry->peer_id);
771 entry = add_entry (&key, peer_id);
772 if (NULL == entry->cfg)
773 entry->cfg = GNUNET_CONFIGURATION_dup (cfg);
776 GNUNET_CONTAINER_DLL_insert (entry->cgh_qhead, entry->cgh_qtail, cgh);
777 if ((NULL != target) && (NULL != connect_notify_cb))
779 ctxt = GNUNET_malloc (sizeof (struct ConnectNotifyContext));
780 ctxt->target = target;
781 ctxt->cb = connect_notify_cb;
782 ctxt->cb_cls = connect_notify_cb_cls;
783 GNUNET_assert (NULL == cgh->nctxt);
789 if (GNUNET_SCHEDULER_NO_TASK == entry->notify_task)
791 if (NULL != search_suitable_cgh (entry, entry->cgh_qhead))
792 entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
798 case CGT_TRANSPORT_HANDLE:
799 if (NULL != entry->transport_op)
801 op = GNUNET_TESTBED_operation_create_ (entry, &opstart_get_handle_transport,
802 &oprelease_get_handle_transport);
803 entry->transport_op = op;
805 case CGT_CORE_HANDLE:
806 if (NULL != entry->core_op)
808 op = GNUNET_TESTBED_operation_create_ (entry, &opstart_get_handle_core,
809 &oprelease_get_handle_core);
813 GNUNET_TESTBED_operation_queue_insert_ (GST_opq_openfds, op);
814 GNUNET_TESTBED_operation_begin_wait_ (op);
820 * Iterator over hash map entries.
823 * @param key current key code
824 * @param value value in the hash map
825 * @return GNUNET_YES if we should continue to
830 cache_clear_iterator (void *cls, const struct GNUNET_HashCode *key, void *value)
832 struct CacheEntry *entry = value;
833 static unsigned int ncleared;
835 GNUNET_assert (NULL != entry);
836 GNUNET_break (0 == entry->demand);
837 LOG_DEBUG ("Clearing entry %u of %u\n", ++ncleared, cache_size);
838 GNUNET_CONTAINER_multihashmap_remove (cache, key, value);
839 close_handles (entry);
840 GNUNET_free_non_null (entry->hello);
841 GNUNET_break (GNUNET_SCHEDULER_NO_TASK == entry->expire_task);
842 GNUNET_assert (NULL == entry->transport_handle);
843 GNUNET_assert (NULL == entry->transport_op);
844 GNUNET_assert (NULL == entry->core_handle);
845 GNUNET_assert (NULL == entry->core_op);
846 GNUNET_assert (NULL == entry->cfg);
847 GNUNET_assert (NULL == entry->cgh_qhead);
848 GNUNET_assert (NULL == entry->cgh_qtail);
849 GNUNET_assert (NULL == entry->nctxt_qhead);
850 GNUNET_assert (NULL == entry->nctxt_qtail);
862 GNUNET_CONTAINER_multihashmap_iterate (cache, &cache_clear_iterator, NULL);
863 GNUNET_assert (0 == GNUNET_CONTAINER_multihashmap_size (cache));
864 GNUNET_CONTAINER_multihashmap_destroy (cache);
867 lru_cache_threshold_size = 0;
869 lru_cache_head = NULL;
870 lru_cache_tail = NULL;
875 * Initializes the cache
877 * @param size the size of the cache
880 GST_cache_init (unsigned int size)
884 lru_cache_threshold_size = size;
887 cache = GNUNET_CONTAINER_multihashmap_create (size, GNUNET_YES);
892 * Mark the GetCacheHandle as being done if a handle has been provided already
893 * or as being cancelled if the callback for the handle hasn't been called.
895 * @param cgh the CacheGetHandle handle
898 GST_cache_get_handle_done (struct GSTCacheGetHandle *cgh)
900 struct CacheEntry *entry;
903 GNUNET_assert (NULL != entry);
904 GNUNET_assert (0 < entry->demand);
906 if (GNUNET_SCHEDULER_NO_TASK != entry->notify_task)
908 GNUNET_SCHEDULER_cancel (entry->notify_task);
909 entry->notify_task = GNUNET_SCHEDULER_NO_TASK;
911 GNUNET_CONTAINER_DLL_remove (entry->cgh_qhead, entry->cgh_qtail, cgh);
912 if (NULL != cgh->nctxt)
914 GNUNET_assert (cgh == cgh->nctxt->cgh);
915 if (GNUNET_YES == cgh->notify_called)
916 GNUNET_CONTAINER_DLL_remove (entry->nctxt_qhead, entry->nctxt_qtail,
918 GNUNET_free (cgh->nctxt);
921 if (0 == entry->demand)
924 GNUNET_SCHEDULER_add_delayed (CACHE_EXPIRY, &expire_cache_entry, entry);
925 GNUNET_CONTAINER_DLL_insert_tail (lru_cache_head, lru_cache_tail, entry);
927 entry->in_lru = GNUNET_YES;
928 if (lru_cache_size > lru_cache_threshold_size)
929 close_handles (lru_cache_head);
933 struct GSTCacheGetHandle *cgh2;
935 if (NULL != (cgh2 = search_suitable_cgh (entry, entry->cgh_qhead)))
936 entry->notify_task = GNUNET_SCHEDULER_add_now (&call_cgh_cb, entry);
942 * Get a transport handle with the given configuration. If the handle is
943 * already cached before, it will be retured in the given callback; the peer_id
944 * is used to lookup in the cache; if not, a new operation is started to open the
945 * transport handle and will be given in the callback when it is available.
947 * @param peer_id the index of the peer
948 * @param cfg the configuration with which the transport handle has to be
949 * created if it was not present in the cache
950 * @param cb the callback to notify when the transport handle is available
951 * @param cb_cls the closure for the above callback
952 * @param target the peer identify of the peer whose connection to our TRANSPORT
953 * subsystem will be notified through the connect_notify_cb. Can be NULL
954 * @param connect_notify_cb the callback to call when the given target peer is
955 * connected. This callback will only be called once or never again (in
956 * case the target peer cannot be connected). Can be NULL
957 * @param connect_notify_cb_cls the closure for the above callback
958 * @return the handle which can be used to cancel or mark that the handle is no
961 struct GSTCacheGetHandle *
962 GST_cache_get_handle_transport (unsigned int peer_id,
963 const struct GNUNET_CONFIGURATION_Handle *cfg,
964 GST_cache_handle_ready_cb cb, void *cb_cls,
965 const struct GNUNET_PeerIdentity *target,
966 GST_cache_peer_connect_notify connect_notify_cb,
967 void *connect_notify_cb_cls)
969 struct GSTCacheGetHandle *cgh;
971 cgh = GNUNET_malloc (sizeof (struct GSTCacheGetHandle));
973 cgh->cb_cls = cb_cls;
974 cgh->type = CGT_TRANSPORT_HANDLE;
975 return cache_get_handle (peer_id, cgh, cfg, target, connect_notify_cb,
976 connect_notify_cb_cls);
981 * Get a CORE handle with the given configuration. If the handle is already
982 * cached before, it will be retured in the given callback; the peer_id is used
983 * to lookup in the cache. If the handle is not cached before, a new operation
984 * is started to open the CORE handle and will be given in the callback when it
985 * is available along with the peer identity
987 * @param peer_id the index of the peer
988 * @param cfg the configuration with which the transport handle has to be
989 * created if it was not present in the cache
990 * @param cb the callback to notify when the transport handle is available
991 * @param cb_cls the closure for the above callback
992 * @param target the peer identify of the peer whose connection to our CORE
993 * subsystem will be notified through the connect_notify_cb. Can be NULL
994 * @param connect_notify_cb the callback to call when the given target peer is
995 * connected. This callback will only be called once or never again (in
996 * case the target peer cannot be connected). Can be NULL
997 * @param connect_notify_cb_cls the closure for the above callback
998 * @return the handle which can be used to cancel or mark that the handle is no
1001 struct GSTCacheGetHandle *
1002 GST_cache_get_handle_core (unsigned int peer_id,
1003 const struct GNUNET_CONFIGURATION_Handle *cfg,
1004 GST_cache_handle_ready_cb cb, void *cb_cls,
1005 const struct GNUNET_PeerIdentity *target,
1006 GST_cache_peer_connect_notify connect_notify_cb,
1007 void *connect_notify_cb_cls)
1009 struct GSTCacheGetHandle *cgh;
1011 cgh = GNUNET_malloc (sizeof (struct GSTCacheGetHandle));
1013 cgh->cb_cls = cb_cls;
1014 cgh->type = CGT_CORE_HANDLE;
1015 return cache_get_handle (peer_id, cgh, cfg, target, connect_notify_cb,
1016 connect_notify_cb_cls);
1021 * Looks up in the hello cache and returns the HELLO of the given peer
1023 * @param peer_id the index of the peer whose HELLO has to be looked up
1024 * @return the HELLO message; NULL if not found
1026 const struct GNUNET_MessageHeader *
1027 GST_cache_lookup_hello (const unsigned int peer_id)
1029 struct CacheEntry *entry;
1030 struct GNUNET_HashCode key;
1032 LOG_DEBUG ("Looking up HELLO for peer %u\n", peer_id);
1033 GNUNET_CRYPTO_hash (&peer_id, sizeof (peer_id), &key);
1034 entry = cache_lookup (&key);
1037 if (NULL != entry->hello)
1038 LOG_DEBUG ("HELLO found for peer %u\n", peer_id);
1039 return entry->hello;
1044 * Caches the HELLO of the given peer. Updates the HELLO if it was already
1047 * @param peer_id the peer identity of the peer whose HELLO has to be cached
1048 * @param hello the HELLO message
1051 GST_cache_add_hello (const unsigned int peer_id,
1052 const struct GNUNET_MessageHeader *hello)
1054 struct CacheEntry *entry;
1055 struct GNUNET_HashCode key;
1057 GNUNET_CRYPTO_hash (&peer_id, sizeof (peer_id), &key);
1058 entry = GNUNET_CONTAINER_multihashmap_get (cache, &key);
1060 entry = add_entry (&key, peer_id);
1061 GNUNET_free_non_null (entry->hello);
1062 entry->hello = GNUNET_copy_message (hello);
1065 /* end of gnunet-service-testbed_hc.c */