2 Unix SMB/CIFS implementation.
4 Generic, persistent and shared between processes cache mechanism for use
5 by various parts of the Samba code
7 Copyright (C) Rafal Szczesniak 2002
8 Copyright (C) Volker Lendecke 2009
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.
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.
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/>.
27 #define DBGC_CLASS DBGC_TDB
29 #define TIMEOUT_LEN 12
30 #define CACHE_DATA_FMT "%12u/"
31 #define READ_CACHE_DATA_FMT_TEMPLATE "%%12u/%%%us"
32 #define BLOB_TYPE "DATA_BLOB"
33 #define BLOB_TYPE_LEN 9
35 static struct tdb_context *cache;
36 static struct tdb_context *cache_notrans;
40 * @brief Generic, persistent and shared between processes cache mechanism
41 * for use by various parts of the Samba code
47 * Cache initialisation function. Opens cache tdb file or creates
48 * it if does not exist.
50 * @return true on successful initialisation of the cache or
54 static bool gencache_init(void)
56 char* cache_fname = NULL;
57 int open_flags = O_RDWR|O_CREAT;
58 bool first_try = true;
60 /* skip file open if it's already opened */
61 if (cache) return True;
63 cache_fname = lock_path("gencache.tdb");
65 DEBUG(5, ("Opening cache file at %s\n", cache_fname));
68 cache = tdb_open_log(cache_fname, 0, TDB_DEFAULT|TDB_INCOMPATIBLE_HASH, open_flags, 0644);
71 ret = tdb_check(cache, NULL, NULL);
76 DEBUG(0, ("gencache_init: tdb_check(%s) failed\n",
81 DEBUG(0, ("gencache_init: tdb_check(%s) failed - retry after CLEAR_IF_FIRST\n",
83 cache = tdb_open_log(cache_fname, 0, TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH, open_flags, 0644);
92 if (!cache && (errno == EACCES)) {
93 open_flags = O_RDONLY;
94 cache = tdb_open_log(cache_fname, 0, TDB_DEFAULT|TDB_INCOMPATIBLE_HASH, open_flags,
97 DEBUG(5, ("gencache_init: Opening cache file %s read-only.\n", cache_fname));
102 DEBUG(5, ("Attempt to open gencache.tdb has failed.\n"));
106 cache_fname = lock_path("gencache_notrans.tdb");
108 DEBUG(5, ("Opening cache file at %s\n", cache_fname));
110 cache_notrans = tdb_open_log(cache_fname, 0, TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH,
112 if (cache_notrans == NULL) {
113 DEBUG(5, ("Opening %s failed: %s\n", cache_fname,
123 static TDB_DATA last_stabilize_key(void)
126 result.dptr = (uint8_t *)"@LAST_STABILIZED";
132 * Set an entry in the cache file. If there's no such
135 * @param keystr string that represents a key of this entry
136 * @param blob DATA_BLOB value being cached
137 * @param timeout time when the value is expired
139 * @retval true when entry is successfuly stored
140 * @retval false on failure
143 bool gencache_set_data_blob(const char *keystr, const DATA_BLOB *blob,
149 time_t last_stabilize;
150 static int writecount;
152 if (tdb_data_cmp(string_term_tdb_data(keystr),
153 last_stabilize_key()) == 0) {
154 DEBUG(10, ("Can't store %s as a key\n", keystr));
158 if ((keystr == NULL) || (blob == NULL)) {
162 if (!gencache_init()) return False;
164 val = talloc_asprintf(talloc_tos(), CACHE_DATA_FMT, (int)timeout);
168 val = talloc_realloc(NULL, val, char, talloc_array_length(val)-1);
172 val = (char *)talloc_append_blob(NULL, val, *blob);
177 DEBUG(10, ("Adding cache entry with key = %s and timeout ="
178 " %s (%d seconds %s)\n", keystr, ctime(&timeout),
179 (int)(timeout - time(NULL)),
180 timeout > time(NULL) ? "ahead" : "in the past"));
182 ret = tdb_store_bystring(
183 cache_notrans, keystr,
184 make_tdb_data((uint8_t *)val, talloc_array_length(val)),
193 * Every 100 writes within a single process, stabilize the cache with
194 * a transaction. This is done to prevent a single transaction to
195 * become huge and chew lots of memory.
198 if (writecount > lp_parm_int(-1, "gencache", "stabilize_count", 100)) {
199 gencache_stabilize();
205 * Every 5 minutes, call gencache_stabilize() to not let grow
206 * gencache_notrans.tdb too large.
210 databuf = tdb_fetch(cache_notrans, last_stabilize_key());
211 if ((databuf.dptr != NULL)
212 && (databuf.dptr[databuf.dsize-1] == '\0')) {
213 last_stabilize = atoi((char *)databuf.dptr);
214 SAFE_FREE(databuf.dptr);
217 + lp_parm_int(-1, "gencache", "stabilize_interval", 300))
219 gencache_stabilize();
227 * Delete one entry from the cache file.
229 * @param keystr string that represents a key of this entry
231 * @retval true upon successful deletion
232 * @retval false in case of failure
235 bool gencache_del(const char *keystr)
237 bool exists, was_expired;
241 if (keystr == NULL) {
245 if (!gencache_init()) return False;
247 DEBUG(10, ("Deleting cache entry (key = %s)\n", keystr));
250 * We delete an element by setting its timeout to 0. This way we don't
251 * have to do a transaction on gencache.tdb every time we delete an
255 exists = gencache_get_data_blob(keystr, &value, NULL, &was_expired);
257 if (!exists && was_expired) {
259 * gencache_get_data_blob has implicitly deleted this
260 * entry, so we have to return success here.
266 data_blob_free(&value);
267 ret = gencache_set(keystr, "", 0);
272 static bool gencache_pull_timeout(char *val, time_t *pres, char **pendptr)
277 res = strtol(val, &endptr, 10);
279 if ((endptr == NULL) || (*endptr != '/')) {
280 DEBUG(2, ("Invalid gencache data format: %s\n", val));
286 if (pendptr != NULL) {
292 struct gencache_parse_state {
293 void (*parser)(time_t timeout, DATA_BLOB blob, void *private_data);
297 static int gencache_parse_fn(TDB_DATA key, TDB_DATA data, void *private_data)
299 struct gencache_parse_state *state;
305 if (data.dptr == NULL) {
308 ret = gencache_pull_timeout((char *)data.dptr, &t, &endptr);
312 state = (struct gencache_parse_state *)private_data;
313 blob = data_blob_const(
314 endptr+1, data.dsize - PTR_DIFF(endptr+1, data.dptr));
315 state->parser(t, blob, state->private_data);
319 bool gencache_parse(const char *keystr,
320 void (*parser)(time_t timeout, DATA_BLOB blob,
324 struct gencache_parse_state state;
328 if (keystr == NULL) {
331 if (tdb_data_cmp(string_term_tdb_data(keystr),
332 last_stabilize_key()) == 0) {
335 if (!gencache_init()) {
339 key = string_term_tdb_data(keystr);
340 state.parser = parser;
341 state.private_data = private_data;
343 ret = tdb_parse_record(cache_notrans, key, gencache_parse_fn, &state);
347 ret = tdb_parse_record(cache, key, gencache_parse_fn, &state);
352 * Get existing entry from the cache file.
354 * @param keystr string that represents a key of this entry
355 * @param blob DATA_BLOB that is filled with entry's blob
356 * @param timeout pointer to a time_t that is filled with entry's
359 * @retval true when entry is successfuly fetched
360 * @retval False for failure
363 bool gencache_get_data_blob(const char *keystr, DATA_BLOB *blob,
364 time_t *timeout, bool *was_expired)
369 bool expired = false;
371 if (keystr == NULL) {
375 if (tdb_data_cmp(string_term_tdb_data(keystr),
376 last_stabilize_key()) == 0) {
377 DEBUG(10, ("Can't get %s as a key\n", keystr));
381 if (!gencache_init()) {
385 databuf = tdb_fetch_bystring(cache_notrans, keystr);
387 if (databuf.dptr == NULL) {
388 databuf = tdb_fetch_bystring(cache, keystr);
391 if (databuf.dptr == NULL) {
392 DEBUG(10, ("Cache entry with key = %s couldn't be found \n",
397 if (!gencache_pull_timeout((char *)databuf.dptr, &t, &endptr)) {
398 SAFE_FREE(databuf.dptr);
402 DEBUG(10, ("Returning %s cache entry: key = %s, value = %s, "
403 "timeout = %s", t > time(NULL) ? "valid" :
404 "expired", keystr, endptr+1, ctime(&t)));
408 SAFE_FREE(databuf.dptr);
412 if (t <= time(NULL)) {
415 * We're expired, delete the entry. We can't use gencache_del
416 * here, because that uses gencache_get_data_blob for checking
417 * the existence of a record. We know the thing exists and
418 * directly store an empty value with 0 timeout.
420 gencache_set(keystr, "", 0);
422 SAFE_FREE(databuf.dptr);
431 databuf.dsize - PTR_DIFF(endptr+1, databuf.dptr));
432 if (blob->data == NULL) {
433 SAFE_FREE(databuf.dptr);
434 DEBUG(0, ("memdup failed\n"));
439 SAFE_FREE(databuf.dptr);
448 if (was_expired != NULL) {
449 *was_expired = expired;
454 struct stabilize_state {
458 static int stabilize_fn(struct tdb_context *tdb, TDB_DATA key, TDB_DATA val,
464 * Migrate the clear-if-first gencache data to the stable,
465 * transaction-based gencache.tdb
468 bool gencache_stabilize(void)
470 struct stabilize_state state;
474 if (!gencache_init()) {
478 res = tdb_transaction_start_nonblock(cache);
481 if (tdb_error(cache) == TDB_ERR_NOLOCK) {
483 * Someone else already does the stabilize,
484 * this does not have to be done twice
489 DEBUG(10, ("Could not start transaction on gencache.tdb: "
490 "%s\n", tdb_errorstr(cache)));
493 res = tdb_transaction_start(cache_notrans);
495 tdb_transaction_cancel(cache);
496 DEBUG(10, ("Could not start transaction on "
497 "gencache_notrans.tdb: %s\n",
498 tdb_errorstr(cache_notrans)));
503 state.written = false;
505 res = tdb_traverse(cache_notrans, stabilize_fn, &state);
506 if ((res == -1) || state.error) {
507 if ((tdb_transaction_cancel(cache_notrans) == -1)
508 || (tdb_transaction_cancel(cache) == -1)) {
509 smb_panic("tdb_transaction_cancel failed\n");
514 if (!state.written) {
515 if ((tdb_transaction_cancel(cache_notrans) == -1)
516 || (tdb_transaction_cancel(cache) == -1)) {
517 smb_panic("tdb_transaction_cancel failed\n");
522 res = tdb_transaction_commit(cache);
524 DEBUG(10, ("tdb_transaction_commit on gencache.tdb failed: "
525 "%s\n", tdb_errorstr(cache)));
526 if (tdb_transaction_cancel(cache_notrans) == -1) {
527 smb_panic("tdb_transaction_cancel failed\n");
532 res = tdb_transaction_commit(cache_notrans);
534 DEBUG(10, ("tdb_transaction_commit on gencache.tdb failed: "
535 "%s\n", tdb_errorstr(cache)));
539 now = talloc_asprintf(talloc_tos(), "%d", (int)time(NULL));
541 tdb_store(cache_notrans, last_stabilize_key(),
542 string_term_tdb_data(now), 0);
549 static int stabilize_fn(struct tdb_context *tdb, TDB_DATA key, TDB_DATA val,
552 struct stabilize_state *state = (struct stabilize_state *)priv;
556 if (tdb_data_cmp(key, last_stabilize_key()) == 0) {
560 if (!gencache_pull_timeout((char *)val.dptr, &timeout, NULL)) {
561 DEBUG(10, ("Ignoring invalid entry\n"));
564 if ((timeout < time(NULL)) || (val.dsize == 0)) {
565 res = tdb_delete(cache, key);
566 if ((res == -1) && (tdb_error(cache) == TDB_ERR_NOEXIST)) {
569 state->written = true;
572 res = tdb_store(cache, key, val, 0);
574 state->written = true;
579 DEBUG(10, ("Transfer to gencache.tdb failed: %s\n",
580 tdb_errorstr(cache)));
585 if (tdb_delete(cache_notrans, key) == -1) {
586 DEBUG(10, ("tdb_delete from gencache_notrans.tdb failed: "
587 "%s\n", tdb_errorstr(cache_notrans)));
595 * Get existing entry from the cache file.
597 * @param keystr string that represents a key of this entry
598 * @param valstr buffer that is allocated and filled with the entry value
599 * buffer's disposing must be done outside
600 * @param timeout pointer to a time_t that is filled with entry's
603 * @retval true when entry is successfuly fetched
604 * @retval False for failure
607 bool gencache_get(const char *keystr, char **value, time_t *ptimeout)
612 ret = gencache_get_data_blob(keystr, &blob, ptimeout, NULL);
616 if ((blob.data == NULL) || (blob.length == 0)) {
617 SAFE_FREE(blob.data);
620 if (blob.data[blob.length-1] != '\0') {
621 /* Not NULL terminated, can't be a string */
622 SAFE_FREE(blob.data);
626 *value = SMB_STRDUP((char *)blob.data);
627 data_blob_free(&blob);
628 if (*value == NULL) {
633 data_blob_free(&blob);
638 * Set an entry in the cache file. If there's no such
641 * @param keystr string that represents a key of this entry
642 * @param value text representation value being cached
643 * @param timeout time when the value is expired
645 * @retval true when entry is successfuly stored
646 * @retval false on failure
649 bool gencache_set(const char *keystr, const char *value, time_t timeout)
651 DATA_BLOB blob = data_blob_const(value, strlen(value)+1);
652 return gencache_set_data_blob(keystr, &blob, timeout);
656 * Iterate through all entries which key matches to specified pattern
658 * @param fn pointer to the function that will be supplied with each single
659 * matching cache entry (key, value and timeout) as an arguments
660 * @param data void pointer to an arbitrary data that is passed directly to the fn
661 * function on each call
662 * @param keystr_pattern pattern the existing entries' keys are matched to
666 struct gencache_iterate_state {
667 void (*fn)(const char *key, const char *value, time_t timeout,
674 static int gencache_iterate_fn(struct tdb_context *tdb, TDB_DATA key,
675 TDB_DATA value, void *priv)
677 struct gencache_iterate_state *state =
678 (struct gencache_iterate_state *)priv;
680 char *free_key = NULL;
682 char *free_val = NULL;
687 if (tdb_data_cmp(key, last_stabilize_key()) == 0) {
691 if (state->in_persistent && tdb_exists(cache_notrans, key)) {
695 if (key.dptr[key.dsize-1] == '\0') {
696 keystr = (char *)key.dptr;
698 /* ensure 0-termination */
699 keystr = SMB_STRNDUP((char *)key.dptr, key.dsize);
703 if ((value.dptr == NULL) || (value.dsize <= TIMEOUT_LEN)) {
707 if (fnmatch(state->pattern, keystr, 0) != 0) {
711 if (value.dptr[value.dsize-1] == '\0') {
712 valstr = (char *)value.dptr;
714 /* ensure 0-termination */
715 valstr = SMB_STRNDUP((char *)value.dptr, value.dsize);
719 u = strtoul(valstr, &timeout_endp, 10);
721 if ((*timeout_endp != '/') || ((timeout_endp-valstr) != TIMEOUT_LEN)) {
728 DEBUG(10, ("Calling function with arguments "
729 "(key = %s, value = %s, timeout = %s)\n",
730 keystr, timeout_endp, ctime(&timeout)));
731 state->fn(keystr, timeout_endp, timeout, state->priv);
739 void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout, void* dptr),
740 void* data, const char* keystr_pattern)
742 struct gencache_iterate_state state;
744 if ((fn == NULL) || (keystr_pattern == NULL)) {
748 if (!gencache_init()) return;
750 DEBUG(5, ("Searching cache keys with pattern %s\n", keystr_pattern));
753 state.pattern = keystr_pattern;
756 state.in_persistent = false;
757 tdb_traverse(cache_notrans, gencache_iterate_fn, &state);
759 state.in_persistent = true;
760 tdb_traverse(cache, gencache_iterate_fn, &state);