source/lib/memcache.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    In-memory cache
   4    Copyright (C) Volker Lendecke 2007
   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 #include "memcache.h"
  21 #include "rbtree.h"
  22
  23 static struct memcache *global_cache;
  24
  25 struct memcache_element {
  26         struct rb_node rb_node;
  27         struct memcache_element *prev, *next;
  28         size_t keylength, valuelength;
  29         uint8 n;                /* This is really an enum, but save memory */
  30         char data[1];           /* placeholder for offsetof */
  31 };
  32
  33 struct memcache {
  34         struct memcache_element *mru, *lru;
  35         struct rb_root tree;
  36         size_t size;
  37         size_t max_size;
  38 };
  39
  40 static void memcache_element_parse(struct memcache_element *e,
  41                                    DATA_BLOB *key, DATA_BLOB *value);
  42
  43 static bool memcache_is_talloc(enum memcache_number n)
  44 {
  45         bool result;
  46
  47         switch (n) {
  48         case GETPWNAM_CACHE:
  49                 result = true;
  50                 break;
  51         default:
  52                 result = false;
  53                 break;
  54         }
  55
  56         return result;
  57 }
  58
  59 static int memcache_destructor(struct memcache *cache) {
  60         struct memcache_element *e, *next;
  61
  62         for (e = cache->mru; e != NULL; e = next) {
  63                 next = e->next;
  64                 if (memcache_is_talloc(e->n)
  65                     && (e->valuelength == sizeof(void *))) {
  66                         DATA_BLOB key, value;
  67                         void *ptr;
  68                         memcache_element_parse(e, &key, &value);
  69                         memcpy(&ptr, value.data, sizeof(ptr));
  70                         TALLOC_FREE(ptr);
  71                 }
  72                 SAFE_FREE(e);
  73         }
  74         return 0;
  75 }
  76
  77 struct memcache *memcache_init(TALLOC_CTX *mem_ctx, size_t max_size)
  78 {
  79         struct memcache *result;
  80
  81         result = TALLOC_ZERO_P(mem_ctx, struct memcache);
  82         if (result == NULL) {
  83                 return NULL;
  84         }
  85         result->max_size = max_size;
  86         talloc_set_destructor(result, memcache_destructor);
  87         return result;
  88 }
  89
  90 void memcache_set_global(struct memcache *cache)
  91 {
  92         TALLOC_FREE(global_cache);
  93         global_cache = cache;
  94 }
  95
  96 static struct memcache_element *memcache_node2elem(struct rb_node *node)
  97 {
  98         return (struct memcache_element *)
  99                 ((char *)node - offsetof(struct memcache_element, rb_node));
 100 }
 101
 102 static void memcache_element_parse(struct memcache_element *e,
 103                                    DATA_BLOB *key, DATA_BLOB *value)
 104 {
 105         key->data = ((uint8 *)e) + offsetof(struct memcache_element, data);
 106         key->length = e->keylength;
 107         value->data = key->data + e->keylength;
 108         value->length = e->valuelength;
 109 }
 110
 111 static size_t memcache_element_size(size_t key_length, size_t value_length)
 112 {
 113         return sizeof(struct memcache_element) - 1 + key_length + value_length;
 114 }
 115
 116 static int memcache_compare(struct memcache_element *e, enum memcache_number n,
 117                             DATA_BLOB key)
 118 {
 119         DATA_BLOB this_key, this_value;
 120
 121         if ((int)e->n < (int)n) return -1;
 122         if ((int)e->n > (int)n) return 1;
 123
 124         if (e->keylength < key.length) return -1;
 125         if (e->keylength > key.length) return 1;
 126
 127         memcache_element_parse(e, &this_key, &this_value);
 128         return memcmp(this_key.data, key.data, key.length);
 129 }
 130
 131 static struct memcache_element *memcache_find(
 132         struct memcache *cache, enum memcache_number n, DATA_BLOB key)
 133 {
 134         struct rb_node *node;
 135
 136         node = cache->tree.rb_node;
 137
 138         while (node != NULL) {
 139                 struct memcache_element *elem = memcache_node2elem(node);
 140                 int cmp;
 141
 142                 cmp = memcache_compare(elem, n, key);
 143                 if (cmp == 0) {
 144                         return elem;
 145                 }
 146                 node = (cmp < 0) ? node->rb_left : node->rb_right;
 147         }
 148
 149         return NULL;
 150 }
 151
 152 bool memcache_lookup(struct memcache *cache, enum memcache_number n,
 153                      DATA_BLOB key, DATA_BLOB *value)
 154 {
 155         struct memcache_element *e;
 156
 157         if (cache == NULL) {
 158                 cache = global_cache;
 159         }
 160         if (cache == NULL) {
 161                 return false;
 162         }
 163
 164         e = memcache_find(cache, n, key);
 165         if (e == NULL) {
 166                 return false;
 167         }
 168
 169         if (cache->size != 0) {
 170                 /*
 171                  * Do LRU promotion only when we will ever shrink
 172                  */
 173                 if (e == cache->lru) {
 174                         cache->lru = e->prev;
 175                 }
 176                 DLIST_PROMOTE(cache->mru, e);
 177                 if (cache->mru == NULL) {
 178                         cache->mru = e;
 179                 }
 180         }
 181
 182         memcache_element_parse(e, &key, value);
 183         return true;
 184 }
 185
 186 void *memcache_lookup_talloc(struct memcache *cache, enum memcache_number n,
 187                              DATA_BLOB key)
 188 {
 189         DATA_BLOB value;
 190         void *result;
 191
 192         if (!memcache_lookup(cache, n, key, &value)) {
 193                 return NULL;
 194         }
 195
 196         if (value.length != sizeof(result)) {
 197                 return NULL;
 198         }
 199
 200         memcpy(&result, value.data, sizeof(result));
 201
 202         return result;
 203 }
 204
 205 static void memcache_delete_element(struct memcache *cache,
 206                                     struct memcache_element *e)
 207 {
 208         rb_erase(&e->rb_node, &cache->tree);
 209
 210         if (e == cache->lru) {
 211                 cache->lru = e->prev;
 212         }
 213         DLIST_REMOVE(cache->mru, e);
 214
 215         cache->size -= memcache_element_size(e->keylength, e->valuelength);
 216
 217         SAFE_FREE(e);
 218 }
 219
 220 static void memcache_trim(struct memcache *cache)
 221 {
 222         if (cache->max_size == 0) {
 223                 return;
 224         }
 225
 226         while ((cache->size > cache->max_size) && (cache->lru != NULL)) {
 227                 memcache_delete_element(cache, cache->lru);
 228         }
 229 }
 230
 231 void memcache_delete(struct memcache *cache, enum memcache_number n,
 232                      DATA_BLOB key)
 233 {
 234         struct memcache_element *e;
 235
 236         if (cache == NULL) {
 237                 cache = global_cache;
 238         }
 239         if (cache == NULL) {
 240                 return;
 241         }
 242
 243         e = memcache_find(cache, n, key);
 244         if (e == NULL) {
 245                 return;
 246         }
 247
 248         memcache_delete_element(cache, e);
 249 }
 250
 251 void memcache_add(struct memcache *cache, enum memcache_number n,
 252                   DATA_BLOB key, DATA_BLOB value)
 253 {
 254         struct memcache_element *e;
 255         struct rb_node **p;
 256         struct rb_node *parent;
 257         DATA_BLOB cache_key, cache_value;
 258         size_t element_size;
 259
 260         if (cache == NULL) {
 261                 cache = global_cache;
 262         }
 263         if (cache == NULL) {
 264                 return;
 265         }
 266
 267         if (key.length == 0) {
 268                 return;
 269         }
 270
 271         e = memcache_find(cache, n, key);
 272
 273         if (e != NULL) {
 274                 memcache_element_parse(e, &cache_key, &cache_value);
 275
 276                 if (value.length <= cache_value.length) {
 277                         /*
 278                          * We can reuse the existing record
 279                          */
 280                         memcpy(cache_value.data, value.data, value.length);
 281                         e->valuelength = value.length;
 282                         return;
 283                 }
 284
 285                 memcache_delete_element(cache, e);
 286         }
 287
 288         element_size = memcache_element_size(key.length, value.length);
 289
 290
 291         e = (struct memcache_element *)SMB_MALLOC(element_size);
 292
 293         if (e == NULL) {
 294                 DEBUG(0, ("malloc failed\n"));
 295                 return;
 296         }
 297
 298         e->n = n;
 299         e->keylength = key.length;
 300         e->valuelength = value.length;
 301
 302         memcache_element_parse(e, &cache_key, &cache_value);
 303         memcpy(cache_key.data, key.data, key.length);
 304         memcpy(cache_value.data, value.data, value.length);
 305
 306         parent = NULL;
 307         p = &cache->tree.rb_node;
 308
 309         while (*p) {
 310                 struct memcache_element *elem = memcache_node2elem(*p);
 311                 int cmp;
 312
 313                 parent = (*p);
 314
 315                 cmp = memcache_compare(elem, n, key);
 316
 317                 p = (cmp < 0) ? &(*p)->rb_left : &(*p)->rb_right;
 318         }
 319
 320         rb_link_node(&e->rb_node, parent, p);
 321         rb_insert_color(&e->rb_node, &cache->tree);
 322
 323         DLIST_ADD(cache->mru, e);
 324         if (cache->lru == NULL) {
 325                 cache->lru = e;
 326         }
 327
 328         cache->size += element_size;
 329         memcache_trim(cache);
 330 }
 331
 332 void memcache_add_talloc(struct memcache *cache, enum memcache_number n,
 333                          DATA_BLOB key, void *ptr)
 334 {
 335         return memcache_add(cache, n, key, data_blob_const(&ptr, sizeof(ptr)));
 336 }
 337
 338 void memcache_flush(struct memcache *cache, enum memcache_number n)
 339 {
 340         struct rb_node *node;
 341
 342         if (cache == NULL) {
 343                 cache = global_cache;
 344         }
 345         if (cache == NULL) {
 346                 return;
 347         }
 348
 349         /*
 350          * Find the smallest element of number n
 351          */
 352
 353         node = cache->tree.rb_node;
 354         if (node == NULL) {
 355                 return;
 356         }
 357
 358         while (true) {
 359                 struct memcache_element *elem = memcache_node2elem(node);
 360                 struct rb_node *next;
 361
 362                 if ((int)elem->n < (int)n) {
 363                         next = node->rb_right;
 364                 }
 365                 else {
 366                         next = node->rb_left;
 367                 }
 368                 if (next == NULL) {
 369                         break;
 370                 }
 371                 node = next;
 372         }
 373
 374         node = rb_next(node);
 375         if (node == NULL) {
 376                 return;
 377         }
 378
 379         while (node != NULL) {
 380                 struct memcache_element *e = memcache_node2elem(node);
 381                 struct rb_node *next = rb_next(node);
 382
 383                 memcache_delete_element(cache, e);
 384                 node = next;
 385         }
 386 }