source3/include/memcache.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    In-memory cache
   4    Copyright (C) Volker Lendecke 2007-2008
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef __MEMCACHE_H__
  21 #define __MEMCACHE_H__
  22
  23 #include "includes.h"
  24
  25 struct memcache;
  26
  27 /*
  28  * A memcache can store different subkeys with overlapping keys, the
  29  * memcache_number becomes part of the key. Feel free to add caches of your
  30  * own here.
  31  *
  32  * If you add talloc type caches, also note this in the switch statement in
  33  * memcache_is_talloc().
  34  */
  35
  36 enum memcache_number {
  37         STAT_CACHE,
  38         GENCACHE_RAM,
  39         GETWD_CACHE,
  40         GETPWNAM_CACHE,         /* talloc */
  41         MANGLE_HASH2_CACHE,
  42         PDB_GETPWSID_CACHE,     /* talloc */
  43         SINGLETON_CACHE_TALLOC, /* talloc */
  44         SINGLETON_CACHE,
  45         SMB1_SEARCH_OFFSET_MAP
  46 };
  47
  48 /*
  49  * Create a memcache structure. max_size is in bytes, if you set it 0 it will
  50  * not forget anything.
  51  */
  52
  53 struct memcache *memcache_init(TALLOC_CTX *mem_ctx, size_t max_size);
  54
  55 /*
  56  * If you set this global memcache, use it as the default cache when NULL is
  57  * passed to the memcache functions below. This is a workaround for many
  58  * situations where passing the cache everywhere would be a big hassle.
  59  */
  60
  61 void memcache_set_global(struct memcache *cache);
  62
  63 /*
  64  * Add a data blob to the cache
  65  */
  66
  67 void memcache_add(struct memcache *cache, enum memcache_number n,
  68                   DATA_BLOB key, DATA_BLOB value);
  69
  70 /*
  71  * Add a talloc object to the cache. The difference to memcache_add() is that
  72  * when the objects is to be discared, talloc_free is called for it. Also
  73  * talloc_move() ownership of the object to the cache.
  74  *
  75  * Please note that the current implementation has a fixed relationship
  76  * between what cache subtypes store talloc objects and which ones store plain
  77  * blobs. We can fix this, but for now we don't have a mixed use of blobs vs
  78  * talloc objects in the cache types.
  79  */
  80
  81 void memcache_add_talloc(struct memcache *cache, enum memcache_number n,
  82                          DATA_BLOB key, void *ptr);
  83
  84 /*
  85  * Delete an object from the cache
  86  */
  87
  88 void memcache_delete(struct memcache *cache, enum memcache_number n,
  89                      DATA_BLOB key);
  90
  91 /*
  92  * Look up an object from the cache. Memory still belongs to the cache, so
  93  * make a copy of it if needed.
  94  */
  95
  96 bool memcache_lookup(struct memcache *cache, enum memcache_number n,
  97                      DATA_BLOB key, DATA_BLOB *value);
  98
  99 /*
 100  * Look up an object from the cache. Memory still belongs to the cache, so
 101  * make a copy of it if needed.
 102  */
 103
 104 void *memcache_lookup_talloc(struct memcache *cache, enum memcache_number n,
 105                              DATA_BLOB key);
 106
 107 /*
 108  * Flush a complete cache subset.
 109  */
 110
 111 void memcache_flush(struct memcache *cache, enum memcache_number n);
 112
 113 #endif