Home | History | Annotate | Download | only in util 
      1 /**************************************************************************
      2  *
      3  * Copyright 2008 VMware, Inc.
      4  * All Rights Reserved.
      5  *
      6  * Permission is hereby granted, free of charge, to any person obtaining a
      7  * copy of this software and associated documentation files (the
      8  * "Software"), to deal in the Software without restriction, including
      9  * without limitation the rights to use, copy, modify, merge, publish,
     10  * distribute, sub license, and/or sell copies of the Software, and to
     11  * permit persons to whom the Software is furnished to do so, subject to
     12  * the following conditions:
     13  *
     14  * The above copyright notice and this permission notice (including the
     15  * next paragraph) shall be included in all copies or substantial portions
     16  * of the Software.
     17  *
     18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
     19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
     21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
     22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
     23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
     24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     25  *
     26  **************************************************************************/
     27 
     28 /**
     29  * @file
     30  * Simple cache.
     31  *
     32  * @author Jose Fonseca <jfonseca (at) vmware.com>
     33  */
     34 
     35 #ifndef U_CACHE_H_
     36 #define U_CACHE_H_
     37 
     38 
     39 #include "pipe/p_compiler.h"
     40 
     41 
     42 #ifdef __cplusplus
     43 extern "C" {
     44 #endif
     45 
     46 
     47 /**
     48  * Least Recently Used (LRU) cache.
     49  */
     50 struct util_cache;
     51 
     52 
     53 /**
     54  * Create a cache.
     55  *
     56  * @param hash hash function
     57  * @param compare should return 0 for two equal keys
     58  * @param destroy destruction callback (optional)
     59  * @param size maximum number of entries
     60  */
     61 struct util_cache *
     62 util_cache_create(uint32_t (*hash)(const void *key),
     63                   int (*compare)(const void *key1, const void *key2),
     64                   void (*destroy)(void *key, void *value),
     65                   uint32_t size);
     66 
     67 void
     68 util_cache_set(struct util_cache *cache,
     69                void *key,
     70                void *value);
     71 
     72 void *
     73 util_cache_get(struct util_cache *cache,
     74                const void *key);
     75 
     76 void
     77 util_cache_clear(struct util_cache *cache);
     78 
     79 void
     80 util_cache_destroy(struct util_cache *cache);
     81 
     82 void
     83 util_cache_remove(struct util_cache *cache,
     84                   const void *key);
     85 
     86 
     87 #ifdef __cplusplus
     88 }
     89 #endif
     90 
     91 #endif /* U_CACHE_H_ */
     92