source3/lib/gencache.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Generic, persistent and shared between processes cache mechanism for use
   5    by various parts of the Samba code
   6
   7    Copyright (C) Rafal Szczesniak    2002
   8    Copyright (C) Volker Lendecke     2009
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #include "includes.h"
  25 #include "system/filesys.h"
  26 #include "system/glob.h"
  27 #include "util_tdb.h"
  28
  29 #undef  DBGC_CLASS
  30 #define DBGC_CLASS DBGC_TDB
  31
  32 #define TIMEOUT_LEN 12
  33 #define CACHE_DATA_FMT  "%12u/"
  34 #define READ_CACHE_DATA_FMT_TEMPLATE "%%12u/%%%us"
  35 #define BLOB_TYPE "DATA_BLOB"
  36 #define BLOB_TYPE_LEN 9
  37
  38 static struct tdb_context *cache;
  39 static struct tdb_context *cache_notrans;
  40
  41 /**
  42  * @file gencache.c
  43  * @brief Generic, persistent and shared between processes cache mechanism
  44  *        for use by various parts of the Samba code
  45  *
  46  **/
  47
  48
  49 /**
  50  * Cache initialisation function. Opens cache tdb file or creates
  51  * it if does not exist.
  52  *
  53  * @return true on successful initialisation of the cache or
  54  *         false on failure
  55  **/
  56
  57 static bool gencache_init(void)
  58 {
  59         char* cache_fname = NULL;
  60         int open_flags = O_RDWR|O_CREAT;
  61         bool first_try = true;
  62
  63         /* skip file open if it's already opened */
  64         if (cache) return True;
  65
  66         cache_fname = lock_path("gencache.tdb");
  67
  68         DEBUG(5, ("Opening cache file at %s\n", cache_fname));
  69
  70 again:
  71         cache = tdb_open_log(cache_fname, 0, TDB_DEFAULT|TDB_INCOMPATIBLE_HASH, open_flags, 0644);
  72         if (cache) {
  73                 int ret;
  74                 ret = tdb_check(cache, NULL, NULL);
  75                 if (ret != 0) {
  76                         tdb_close(cache);
  77                         cache = NULL;
  78                         if (!first_try) {
  79                                 DEBUG(0, ("gencache_init: tdb_check(%s) failed\n",
  80                                           cache_fname));
  81                                 return false;
  82                         }
  83                         first_try = false;
  84                         DEBUG(0, ("gencache_init: tdb_check(%s) failed - retry after truncate\n",
  85                                   cache_fname));
  86                         truncate(cache_fname, 0);
  87                         goto again;
  88                 }
  89         }
  90
  91         if (!cache && (errno == EACCES)) {
  92                 open_flags = O_RDONLY;
  93                 cache = tdb_open_log(cache_fname, 0, TDB_DEFAULT|TDB_INCOMPATIBLE_HASH, open_flags,
  94                                      0644);
  95                 if (cache) {
  96                         DEBUG(5, ("gencache_init: Opening cache file %s read-only.\n", cache_fname));
  97                 }
  98         }
  99
 100         if (!cache) {
 101                 DEBUG(5, ("Attempt to open gencache.tdb has failed.\n"));
 102                 return False;
 103         }
 104
 105         cache_fname = lock_path("gencache_notrans.tdb");
 106
 107         DEBUG(5, ("Opening cache file at %s\n", cache_fname));
 108
 109         cache_notrans = tdb_open_log(cache_fname, 0, TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH,
 110                                      open_flags, 0644);
 111         if (cache_notrans == NULL) {
 112                 DEBUG(5, ("Opening %s failed: %s\n", cache_fname,
 113                           strerror(errno)));
 114                 tdb_close(cache);
 115                 cache = NULL;
 116                 return false;
 117         }
 118
 119         return True;
 120 }
 121
 122 static TDB_DATA last_stabilize_key(void)
 123 {
 124         TDB_DATA result;
 125         result.dptr = discard_const_p(uint8_t, "@LAST_STABILIZED");
 126         result.dsize = 17;
 127         return result;
 128 }
 129
 130 /**
 131  * Set an entry in the cache file. If there's no such
 132  * one, then add it.
 133  *
 134  * @param keystr string that represents a key of this entry
 135  * @param blob DATA_BLOB value being cached
 136  * @param timeout time when the value is expired
 137  *
 138  * @retval true when entry is successfuly stored
 139  * @retval false on failure
 140  **/
 141
 142 bool gencache_set_data_blob(const char *keystr, const DATA_BLOB *blob,
 143                             time_t timeout)
 144 {
 145         int ret;
 146         TDB_DATA databuf;
 147         char* val;
 148         time_t last_stabilize;
 149         static int writecount;
 150
 151         if (tdb_data_cmp(string_term_tdb_data(keystr),
 152                          last_stabilize_key()) == 0) {
 153                 DEBUG(10, ("Can't store %s as a key\n", keystr));
 154                 return false;
 155         }
 156
 157         if ((keystr == NULL) || (blob == NULL)) {
 158                 return false;
 159         }
 160
 161         if (!gencache_init()) return False;
 162
 163         val = talloc_asprintf(talloc_tos(), CACHE_DATA_FMT, (int)timeout);
 164         if (val == NULL) {
 165                 return False;
 166         }
 167         val = talloc_realloc(NULL, val, char, talloc_array_length(val)-1);
 168         if (val == NULL) {
 169                 return false;
 170         }
 171         val = (char *)talloc_append_blob(NULL, val, *blob);
 172         if (val == NULL) {
 173                 return false;
 174         }
 175
 176         DEBUG(10, ("Adding cache entry with key = %s and timeout ="
 177                    " %s (%d seconds %s)\n", keystr, ctime(&timeout),
 178                    (int)(timeout - time(NULL)),
 179                    timeout > time(NULL) ? "ahead" : "in the past"));
 180
 181         ret = tdb_store_bystring(
 182                 cache_notrans, keystr,
 183                 make_tdb_data((uint8_t *)val, talloc_array_length(val)),
 184                 0);
 185         TALLOC_FREE(val);
 186
 187         if (ret != 0) {
 188                 return false;
 189         }
 190
 191         /*
 192          * Every 100 writes within a single process, stabilize the cache with
 193          * a transaction. This is done to prevent a single transaction to
 194          * become huge and chew lots of memory.
 195          */
 196         writecount += 1;
 197         if (writecount > lp_parm_int(-1, "gencache", "stabilize_count", 100)) {
 198                 gencache_stabilize();
 199                 writecount = 0;
 200                 goto done;
 201         }
 202
 203         /*
 204          * Every 5 minutes, call gencache_stabilize() to not let grow
 205          * gencache_notrans.tdb too large.
 206          */
 207
 208         last_stabilize = 0;
 209         databuf = tdb_fetch_compat(cache_notrans, last_stabilize_key());
 210         if ((databuf.dptr != NULL)
 211             && (databuf.dptr[databuf.dsize-1] == '\0')) {
 212                 last_stabilize = atoi((char *)databuf.dptr);
 213                 SAFE_FREE(databuf.dptr);
 214         }
 215         if ((last_stabilize
 216              + lp_parm_int(-1, "gencache", "stabilize_interval", 300))
 217             < time(NULL)) {
 218                 gencache_stabilize();
 219         }
 220
 221 done:
 222         return ret == 0;
 223 }
 224
 225 /**
 226  * Delete one entry from the cache file.
 227  *
 228  * @param keystr string that represents a key of this entry
 229  *
 230  * @retval true upon successful deletion
 231  * @retval false in case of failure
 232  **/
 233
 234 bool gencache_del(const char *keystr)
 235 {
 236         bool exists, was_expired;
 237         bool ret = false;
 238         DATA_BLOB value;
 239
 240         if (keystr == NULL) {
 241                 return false;
 242         }
 243
 244         if (!gencache_init()) return False;
 245
 246         DEBUG(10, ("Deleting cache entry (key = %s)\n", keystr));
 247
 248         /*
 249          * We delete an element by setting its timeout to 0. This way we don't
 250          * have to do a transaction on gencache.tdb every time we delete an
 251          * element.
 252          */
 253
 254         exists = gencache_get_data_blob(keystr, &value, NULL, &was_expired);
 255
 256         if (!exists && was_expired) {
 257                 /*
 258                  * gencache_get_data_blob has implicitly deleted this
 259                  * entry, so we have to return success here.
 260                  */
 261                 return true;
 262         }
 263
 264         if (exists) {
 265                 data_blob_free(&value);
 266                 ret = gencache_set(keystr, "", 0);
 267         }
 268         return ret;
 269 }
 270
 271 static bool gencache_pull_timeout(char *val, time_t *pres, char **pendptr)
 272 {
 273         time_t res;
 274         char *endptr;
 275
 276         if (val == NULL) {
 277                 return false;
 278         }
 279
 280         res = strtol(val, &endptr, 10);
 281
 282         if ((endptr == NULL) || (*endptr != '/')) {
 283                 DEBUG(2, ("Invalid gencache data format: %s\n", val));
 284                 return false;
 285         }
 286         if (pres != NULL) {
 287                 *pres = res;
 288         }
 289         if (pendptr != NULL) {
 290                 *pendptr = endptr;
 291         }
 292         return true;
 293 }
 294
 295 struct gencache_parse_state {
 296         void (*parser)(time_t timeout, DATA_BLOB blob, void *private_data);
 297         void *private_data;
 298 };
 299
 300 static int gencache_parse_fn(TDB_DATA key, TDB_DATA data, void *private_data)
 301 {
 302         struct gencache_parse_state *state;
 303         DATA_BLOB blob;
 304         time_t t;
 305         char *endptr;
 306         bool ret;
 307
 308         if (data.dptr == NULL) {
 309                 return -1;
 310         }
 311         ret = gencache_pull_timeout((char *)data.dptr, &t, &endptr);
 312         if (!ret) {
 313                 return -1;
 314         }
 315         state = (struct gencache_parse_state *)private_data;
 316         blob = data_blob_const(
 317                 endptr+1, data.dsize - PTR_DIFF(endptr+1, data.dptr));
 318         state->parser(t, blob, state->private_data);
 319         return 0;
 320 }
 321
 322 bool gencache_parse(const char *keystr,
 323                     void (*parser)(time_t timeout, DATA_BLOB blob,
 324                                    void *private_data),
 325                     void *private_data)
 326 {
 327         struct gencache_parse_state state;
 328         TDB_DATA key;
 329         int ret;
 330
 331         if (keystr == NULL) {
 332                 return false;
 333         }
 334         if (tdb_data_cmp(string_term_tdb_data(keystr),
 335                          last_stabilize_key()) == 0) {
 336                 return false;
 337         }
 338         if (!gencache_init()) {
 339                 return false;
 340         }
 341
 342         key = string_term_tdb_data(keystr);
 343         state.parser = parser;
 344         state.private_data = private_data;
 345
 346         ret = tdb_parse_record(cache_notrans, key, gencache_parse_fn, &state);
 347         if (ret != -1) {
 348                 return true;
 349         }
 350         ret = tdb_parse_record(cache, key, gencache_parse_fn, &state);
 351         return (ret != -1);
 352 }
 353
 354 struct gencache_get_data_blob_state {
 355         DATA_BLOB *blob;
 356         time_t timeout;
 357         bool result;
 358 };
 359
 360 static void gencache_get_data_blob_parser(time_t timeout, DATA_BLOB blob,
 361                                           void *private_data)
 362 {
 363         struct gencache_get_data_blob_state *state =
 364                 (struct gencache_get_data_blob_state *)private_data;
 365
 366         if (timeout == 0) {
 367                 state->result = false;
 368                 return;
 369         }
 370         state->timeout = timeout;
 371
 372         if (state->blob == NULL) {
 373                 state->result = true;
 374                 return;
 375         }
 376
 377         *state->blob = data_blob(blob.data, blob.length);
 378         if (state->blob->data == NULL) {
 379                 state->result = false;
 380                 return;
 381         }
 382         state->result = true;
 383 }
 384
 385 /**
 386  * Get existing entry from the cache file.
 387  *
 388  * @param keystr string that represents a key of this entry
 389  * @param blob DATA_BLOB that is filled with entry's blob
 390  * @param timeout pointer to a time_t that is filled with entry's
 391  *        timeout
 392  *
 393  * @retval true when entry is successfuly fetched
 394  * @retval False for failure
 395  **/
 396
 397 bool gencache_get_data_blob(const char *keystr, DATA_BLOB *blob,
 398                             time_t *timeout, bool *was_expired)
 399 {
 400         struct gencache_get_data_blob_state state;
 401         bool expired = false;
 402
 403         state.result = false;
 404         state.blob = blob;
 405
 406         if (!gencache_parse(keystr, gencache_get_data_blob_parser, &state)) {
 407                 goto fail;
 408         }
 409         if (!state.result) {
 410                 goto fail;
 411         }
 412         if (state.timeout <= time(NULL)) {
 413                 /*
 414                  * We're expired, delete the entry. We can't use gencache_del
 415                  * here, because that uses gencache_get_data_blob for checking
 416                  * the existence of a record. We know the thing exists and
 417                  * directly store an empty value with 0 timeout.
 418                  */
 419                 gencache_set(keystr, "", 0);
 420                 expired = true;
 421                 goto fail;
 422         }
 423         if (timeout) {
 424                 *timeout = state.timeout;
 425         }
 426
 427         return True;
 428
 429 fail:
 430         if (was_expired != NULL) {
 431                 *was_expired = expired;
 432         }
 433         if (state.result && state.blob) {
 434                 data_blob_free(state.blob);
 435         }
 436         return false;
 437 }
 438
 439 struct stabilize_state {
 440         bool written;
 441         bool error;
 442 };
 443 static int stabilize_fn(struct tdb_context *tdb, TDB_DATA key, TDB_DATA val,
 444                         void *priv);
 445
 446 /**
 447  * Stabilize gencache
 448  *
 449  * Migrate the clear-if-first gencache data to the stable,
 450  * transaction-based gencache.tdb
 451  */
 452
 453 bool gencache_stabilize(void)
 454 {
 455         struct stabilize_state state;
 456         int res;
 457         char *now;
 458
 459         if (!gencache_init()) {
 460                 return false;
 461         }
 462
 463         res = tdb_transaction_start_nonblock(cache);
 464         if (res != 0) {
 465
 466                 if (tdb_error(cache) == TDB_ERR_NOLOCK) {
 467                         /*
 468                          * Someone else already does the stabilize,
 469                          * this does not have to be done twice
 470                          */
 471                         return true;
 472                 }
 473
 474                 DEBUG(10, ("Could not start transaction on gencache.tdb: "
 475                            "%s\n", tdb_errorstr_compat(cache)));
 476                 return false;
 477         }
 478         res = tdb_transaction_start(cache_notrans);
 479         if (res != 0) {
 480                 tdb_transaction_cancel(cache);
 481                 DEBUG(10, ("Could not start transaction on "
 482                            "gencache_notrans.tdb: %s\n",
 483                            tdb_errorstr_compat(cache_notrans)));
 484                 return false;
 485         }
 486
 487         state.error = false;
 488         state.written = false;
 489
 490         res = tdb_traverse(cache_notrans, stabilize_fn, &state);
 491         if ((res < 0) || state.error) {
 492                 tdb_transaction_cancel(cache_notrans);
 493                 tdb_transaction_cancel(cache);
 494                 return false;
 495         }
 496
 497         if (!state.written) {
 498                 tdb_transaction_cancel(cache_notrans);
 499                 tdb_transaction_cancel(cache);
 500                 return true;
 501         }
 502
 503         res = tdb_transaction_commit(cache);
 504         if (res != 0) {
 505                 DEBUG(10, ("tdb_transaction_commit on gencache.tdb failed: "
 506                            "%s\n", tdb_errorstr_compat(cache)));
 507                 tdb_transaction_cancel(cache_notrans);
 508                 return false;
 509         }
 510
 511         res = tdb_transaction_commit(cache_notrans);
 512         if (res != 0) {
 513                 DEBUG(10, ("tdb_transaction_commit on gencache.tdb failed: "
 514                            "%s\n", tdb_errorstr_compat(cache)));
 515                 return false;
 516         }
 517
 518         now = talloc_asprintf(talloc_tos(), "%d", (int)time(NULL));
 519         if (now != NULL) {
 520                 tdb_store(cache_notrans, last_stabilize_key(),
 521                           string_term_tdb_data(now), 0);
 522                 TALLOC_FREE(now);
 523         }
 524
 525         return true;
 526 }
 527
 528 static int stabilize_fn(struct tdb_context *tdb, TDB_DATA key, TDB_DATA val,
 529                         void *priv)
 530 {
 531         struct stabilize_state *state = (struct stabilize_state *)priv;
 532         int res;
 533         time_t timeout;
 534
 535         if (tdb_data_cmp(key, last_stabilize_key()) == 0) {
 536                 return 0;
 537         }
 538
 539         if (!gencache_pull_timeout((char *)val.dptr, &timeout, NULL)) {
 540                 DEBUG(10, ("Ignoring invalid entry\n"));
 541                 return 0;
 542         }
 543         if ((timeout < time(NULL)) || (val.dsize == 0)) {
 544                 res = tdb_delete(cache, key);
 545                 if ((res != 0) && (tdb_error(cache) == TDB_ERR_NOEXIST)) {
 546                         res = 0;
 547                 } else {
 548                         state->written = true;
 549                 }
 550         } else {
 551                 res = tdb_store(cache, key, val, 0);
 552                 if (res == 0) {
 553                         state->written = true;
 554                 }
 555         }
 556
 557         if (res != 0) {
 558                 DEBUG(10, ("Transfer to gencache.tdb failed: %s\n",
 559                            tdb_errorstr_compat(cache)));
 560                 state->error = true;
 561                 return -1;
 562         }
 563
 564         if (tdb_delete(cache_notrans, key) != 0) {
 565                 DEBUG(10, ("tdb_delete from gencache_notrans.tdb failed: "
 566                            "%s\n", tdb_errorstr_compat(cache_notrans)));
 567                 state->error = true;
 568                 return -1;
 569         }
 570         return 0;
 571 }
 572
 573 /**
 574  * Get existing entry from the cache file.
 575  *
 576  * @param keystr string that represents a key of this entry
 577  * @param valstr buffer that is allocated and filled with the entry value
 578  *        buffer's disposing must be done outside
 579  * @param timeout pointer to a time_t that is filled with entry's
 580  *        timeout
 581  *
 582  * @retval true when entry is successfuly fetched
 583  * @retval False for failure
 584  **/
 585
 586 bool gencache_get(const char *keystr, char **value, time_t *ptimeout)
 587 {
 588         DATA_BLOB blob;
 589         bool ret = False;
 590
 591         ret = gencache_get_data_blob(keystr, &blob, ptimeout, NULL);
 592         if (!ret) {
 593                 return false;
 594         }
 595         if ((blob.data == NULL) || (blob.length == 0)) {
 596                 SAFE_FREE(blob.data);
 597                 return false;
 598         }
 599         if (blob.data[blob.length-1] != '\0') {
 600                 /* Not NULL terminated, can't be a string */
 601                 SAFE_FREE(blob.data);
 602                 return false;
 603         }
 604         if (value) {
 605                 *value = SMB_STRDUP((char *)blob.data);
 606                 data_blob_free(&blob);
 607                 if (*value == NULL) {
 608                         return false;
 609                 }
 610                 return true;
 611         }
 612         data_blob_free(&blob);
 613         return true;
 614 }
 615
 616 /**
 617  * Set an entry in the cache file. If there's no such
 618  * one, then add it.
 619  *
 620  * @param keystr string that represents a key of this entry
 621  * @param value text representation value being cached
 622  * @param timeout time when the value is expired
 623  *
 624  * @retval true when entry is successfuly stored
 625  * @retval false on failure
 626  **/
 627
 628 bool gencache_set(const char *keystr, const char *value, time_t timeout)
 629 {
 630         DATA_BLOB blob = data_blob_const(value, strlen(value)+1);
 631         return gencache_set_data_blob(keystr, &blob, timeout);
 632 }
 633
 634 struct gencache_iterate_blobs_state {
 635         void (*fn)(const char *key, DATA_BLOB value,
 636                    time_t timeout, void *private_data);
 637         const char *pattern;
 638         void *private_data;
 639         bool in_persistent;
 640 };
 641
 642 static int gencache_iterate_blobs_fn(struct tdb_context *tdb, TDB_DATA key,
 643                                      TDB_DATA data, void *priv)
 644 {
 645         struct gencache_iterate_blobs_state *state =
 646                 (struct gencache_iterate_blobs_state *)priv;
 647         char *keystr;
 648         char *free_key = NULL;
 649         time_t timeout;
 650         char *endptr;
 651
 652         if (tdb_data_cmp(key, last_stabilize_key()) == 0) {
 653                 return 0;
 654         }
 655         if (state->in_persistent && tdb_exists(cache_notrans, key)) {
 656                 return 0;
 657         }
 658
 659         if (key.dptr[key.dsize-1] == '\0') {
 660                 keystr = (char *)key.dptr;
 661         } else {
 662                 /* ensure 0-termination */
 663                 keystr = SMB_STRNDUP((char *)key.dptr, key.dsize);
 664                 free_key = keystr;
 665         }
 666
 667         if (!gencache_pull_timeout((char *)data.dptr, &timeout, &endptr)) {
 668                 goto done;
 669         }
 670         endptr += 1;
 671
 672         if (fnmatch(state->pattern, keystr, 0) != 0) {
 673                 goto done;
 674         }
 675
 676         DEBUG(10, ("Calling function with arguments (key=%s, timeout=%s)\n",
 677                    keystr, ctime(&timeout)));
 678
 679         state->fn(keystr,
 680                   data_blob_const(endptr,
 681                                   data.dsize - PTR_DIFF(endptr, data.dptr)),
 682                   timeout, state->private_data);
 683
 684  done:
 685         SAFE_FREE(free_key);
 686         return 0;
 687 }
 688
 689 void gencache_iterate_blobs(void (*fn)(const char *key, DATA_BLOB value,
 690                                        time_t timeout, void *private_data),
 691                             void *private_data, const char *pattern)
 692 {
 693         struct gencache_iterate_blobs_state state;
 694
 695         if ((fn == NULL) || (pattern == NULL) || !gencache_init()) {
 696                 return;
 697         }
 698
 699         DEBUG(5, ("Searching cache keys with pattern %s\n", pattern));
 700
 701         state.fn = fn;
 702         state.pattern = pattern;
 703         state.private_data = private_data;
 704
 705         state.in_persistent = false;
 706         tdb_traverse(cache_notrans, gencache_iterate_blobs_fn, &state);
 707
 708         state.in_persistent = true;
 709         tdb_traverse(cache, gencache_iterate_blobs_fn, &state);
 710 }
 711
 712 /**
 713  * Iterate through all entries which key matches to specified pattern
 714  *
 715  * @param fn pointer to the function that will be supplied with each single
 716  *        matching cache entry (key, value and timeout) as an arguments
 717  * @param data void pointer to an arbitrary data that is passed directly to the fn
 718  *        function on each call
 719  * @param keystr_pattern pattern the existing entries' keys are matched to
 720  *
 721  **/
 722
 723 struct gencache_iterate_state {
 724         void (*fn)(const char *key, const char *value, time_t timeout,
 725                    void *priv);
 726         void *private_data;
 727 };
 728
 729 static void gencache_iterate_fn(const char *key, DATA_BLOB value,
 730                                 time_t timeout, void *private_data)
 731 {
 732         struct gencache_iterate_state *state =
 733                 (struct gencache_iterate_state *)private_data;
 734         char *valstr;
 735         char *free_val = NULL;
 736
 737         if (value.data[value.length-1] == '\0') {
 738                 valstr = (char *)value.data;
 739         } else {
 740                 /* ensure 0-termination */
 741                 valstr = SMB_STRNDUP((char *)value.data, value.length);
 742                 free_val = valstr;
 743         }
 744
 745         DEBUG(10, ("Calling function with arguments "
 746                    "(key = %s, value = %s, timeout = %s)\n",
 747                    key, valstr, ctime(&timeout)));
 748
 749         state->fn(key, valstr, timeout, state->private_data);
 750
 751         SAFE_FREE(free_val);
 752 }
 753
 754 void gencache_iterate(void (*fn)(const char *key, const char *value,
 755                                  time_t timeout, void *dptr),
 756                       void *private_data, const char *pattern)
 757 {
 758         struct gencache_iterate_state state;
 759
 760         if (fn == NULL) {
 761                 return;
 762         }
 763         state.fn = fn;
 764         state.private_data = private_data;
 765         gencache_iterate_blobs(gencache_iterate_fn, &state, pattern);
 766 }