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)
281 res = strtol(val, &endptr, 10);
283 if ((endptr == NULL) || (*endptr != '/')) {
284 DEBUG(2, ("Invalid gencache data format: %s\n", val));
290 if (pendptr != NULL) {
296 struct gencache_parse_state {
297 void (*parser)(time_t timeout, DATA_BLOB blob, void *private_data);
301 static int gencache_parse_fn(TDB_DATA key, TDB_DATA data, void *private_data)
303 struct gencache_parse_state *state;
309 if (data.dptr == NULL) {
312 ret = gencache_pull_timeout((char *)data.dptr, &t, &endptr);
316 state = (struct gencache_parse_state *)private_data;
317 blob = data_blob_const(
318 endptr+1, data.dsize - PTR_DIFF(endptr+1, data.dptr));
319 state->parser(t, blob, state->private_data);
323 bool gencache_parse(const char *keystr,
324 void (*parser)(time_t timeout, DATA_BLOB blob,
328 struct gencache_parse_state state;
332 if (keystr == NULL) {
335 if (tdb_data_cmp(string_term_tdb_data(keystr),
336 last_stabilize_key()) == 0) {
339 if (!gencache_init()) {
343 key = string_term_tdb_data(keystr);
344 state.parser = parser;
345 state.private_data = private_data;
347 ret = tdb_parse_record(cache_notrans, key, gencache_parse_fn, &state);
351 ret = tdb_parse_record(cache, key, gencache_parse_fn, &state);
355 struct gencache_get_data_blob_state {
361 static void gencache_get_data_blob_parser(time_t timeout, DATA_BLOB blob,
364 struct gencache_get_data_blob_state *state =
365 (struct gencache_get_data_blob_state *)private_data;
368 state->result = false;
371 state->timeout = timeout;
373 if (state->blob == NULL) {
374 state->result = true;
378 *state->blob = data_blob(blob.data, blob.length);
379 if (state->blob->data == NULL) {
380 state->result = false;
383 state->result = true;
387 * Get existing entry from the cache file.
389 * @param keystr string that represents a key of this entry
390 * @param blob DATA_BLOB that is filled with entry's blob
391 * @param timeout pointer to a time_t that is filled with entry's
394 * @retval true when entry is successfuly fetched
395 * @retval False for failure
398 bool gencache_get_data_blob(const char *keystr, DATA_BLOB *blob,
399 time_t *timeout, bool *was_expired)
401 struct gencache_get_data_blob_state state;
402 bool expired = false;
404 state.result = false;
407 if (!gencache_parse(keystr, gencache_get_data_blob_parser, &state)) {
413 if (state.timeout <= 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);
425 *timeout = state.timeout;
431 if (was_expired != NULL) {
432 *was_expired = expired;
434 if (state.result && state.blob) {
435 data_blob_free(state.blob);
440 struct stabilize_state {
444 static int stabilize_fn(struct tdb_context *tdb, TDB_DATA key, TDB_DATA val,
450 * Migrate the clear-if-first gencache data to the stable,
451 * transaction-based gencache.tdb
454 bool gencache_stabilize(void)
456 struct stabilize_state state;
460 if (!gencache_init()) {
464 res = tdb_transaction_start_nonblock(cache);
467 if (tdb_error(cache) == TDB_ERR_NOLOCK) {
469 * Someone else already does the stabilize,
470 * this does not have to be done twice
475 DEBUG(10, ("Could not start transaction on gencache.tdb: "
476 "%s\n", tdb_errorstr(cache)));
479 res = tdb_transaction_start(cache_notrans);
481 tdb_transaction_cancel(cache);
482 DEBUG(10, ("Could not start transaction on "
483 "gencache_notrans.tdb: %s\n",
484 tdb_errorstr(cache_notrans)));
489 state.written = false;
491 res = tdb_traverse(cache_notrans, stabilize_fn, &state);
492 if ((res == -1) || state.error) {
493 if ((tdb_transaction_cancel(cache_notrans) == -1)
494 || (tdb_transaction_cancel(cache) == -1)) {
495 smb_panic("tdb_transaction_cancel failed\n");
500 if (!state.written) {
501 if ((tdb_transaction_cancel(cache_notrans) == -1)
502 || (tdb_transaction_cancel(cache) == -1)) {
503 smb_panic("tdb_transaction_cancel failed\n");
508 res = tdb_transaction_commit(cache);
510 DEBUG(10, ("tdb_transaction_commit on gencache.tdb failed: "
511 "%s\n", tdb_errorstr(cache)));
512 if (tdb_transaction_cancel(cache_notrans) == -1) {
513 smb_panic("tdb_transaction_cancel failed\n");
518 res = tdb_transaction_commit(cache_notrans);
520 DEBUG(10, ("tdb_transaction_commit on gencache.tdb failed: "
521 "%s\n", tdb_errorstr(cache)));
525 now = talloc_asprintf(talloc_tos(), "%d", (int)time(NULL));
527 tdb_store(cache_notrans, last_stabilize_key(),
528 string_term_tdb_data(now), 0);
535 static int stabilize_fn(struct tdb_context *tdb, TDB_DATA key, TDB_DATA val,
538 struct stabilize_state *state = (struct stabilize_state *)priv;
542 if (tdb_data_cmp(key, last_stabilize_key()) == 0) {
546 if (!gencache_pull_timeout((char *)val.dptr, &timeout, NULL)) {
547 DEBUG(10, ("Ignoring invalid entry\n"));
550 if ((timeout < time(NULL)) || (val.dsize == 0)) {
551 res = tdb_delete(cache, key);
552 if ((res == -1) && (tdb_error(cache) == TDB_ERR_NOEXIST)) {
555 state->written = true;
558 res = tdb_store(cache, key, val, 0);
560 state->written = true;
565 DEBUG(10, ("Transfer to gencache.tdb failed: %s\n",
566 tdb_errorstr(cache)));
571 if (tdb_delete(cache_notrans, key) == -1) {
572 DEBUG(10, ("tdb_delete from gencache_notrans.tdb failed: "
573 "%s\n", tdb_errorstr(cache_notrans)));
581 * Get existing entry from the cache file.
583 * @param keystr string that represents a key of this entry
584 * @param valstr buffer that is allocated and filled with the entry value
585 * buffer's disposing must be done outside
586 * @param timeout pointer to a time_t that is filled with entry's
589 * @retval true when entry is successfuly fetched
590 * @retval False for failure
593 bool gencache_get(const char *keystr, char **value, time_t *ptimeout)
598 ret = gencache_get_data_blob(keystr, &blob, ptimeout, NULL);
602 if ((blob.data == NULL) || (blob.length == 0)) {
603 SAFE_FREE(blob.data);
606 if (blob.data[blob.length-1] != '\0') {
607 /* Not NULL terminated, can't be a string */
608 SAFE_FREE(blob.data);
612 *value = SMB_STRDUP((char *)blob.data);
613 data_blob_free(&blob);
614 if (*value == NULL) {
619 data_blob_free(&blob);
624 * Set an entry in the cache file. If there's no such
627 * @param keystr string that represents a key of this entry
628 * @param value text representation value being cached
629 * @param timeout time when the value is expired
631 * @retval true when entry is successfuly stored
632 * @retval false on failure
635 bool gencache_set(const char *keystr, const char *value, time_t timeout)
637 DATA_BLOB blob = data_blob_const(value, strlen(value)+1);
638 return gencache_set_data_blob(keystr, &blob, timeout);
641 struct gencache_iterate_blobs_state {
642 void (*fn)(const char *key, DATA_BLOB value,
643 time_t timeout, void *private_data);
649 static int gencache_iterate_blobs_fn(struct tdb_context *tdb, TDB_DATA key,
650 TDB_DATA data, void *priv)
652 struct gencache_iterate_blobs_state *state =
653 (struct gencache_iterate_blobs_state *)priv;
655 char *free_key = NULL;
659 if (tdb_data_cmp(key, last_stabilize_key()) == 0) {
662 if (state->in_persistent && tdb_exists(cache_notrans, key)) {
666 if (key.dptr[key.dsize-1] == '\0') {
667 keystr = (char *)key.dptr;
669 /* ensure 0-termination */
670 keystr = SMB_STRNDUP((char *)key.dptr, key.dsize);
674 if (!gencache_pull_timeout((char *)data.dptr, &timeout, &endptr)) {
679 if (fnmatch(state->pattern, keystr, 0) != 0) {
683 DEBUG(10, ("Calling function with arguments (key=%s, timeout=%s)\n",
684 keystr, ctime(&timeout)));
687 data_blob_const(endptr,
688 data.dsize - PTR_DIFF(endptr, data.dptr)),
689 timeout, state->private_data);
696 void gencache_iterate_blobs(void (*fn)(const char *key, DATA_BLOB value,
697 time_t timeout, void *private_data),
698 void *private_data, const char *pattern)
700 struct gencache_iterate_blobs_state state;
702 if ((fn == NULL) || (pattern == NULL) || !gencache_init()) {
706 DEBUG(5, ("Searching cache keys with pattern %s\n", pattern));
709 state.pattern = pattern;
710 state.private_data = private_data;
712 state.in_persistent = false;
713 tdb_traverse(cache_notrans, gencache_iterate_blobs_fn, &state);
715 state.in_persistent = true;
716 tdb_traverse(cache, gencache_iterate_blobs_fn, &state);
720 * Iterate through all entries which key matches to specified pattern
722 * @param fn pointer to the function that will be supplied with each single
723 * matching cache entry (key, value and timeout) as an arguments
724 * @param data void pointer to an arbitrary data that is passed directly to the fn
725 * function on each call
726 * @param keystr_pattern pattern the existing entries' keys are matched to
730 struct gencache_iterate_state {
731 void (*fn)(const char *key, const char *value, time_t timeout,
736 static void gencache_iterate_fn(const char *key, DATA_BLOB value,
737 time_t timeout, void *private_data)
739 struct gencache_iterate_state *state =
740 (struct gencache_iterate_state *)private_data;
742 char *free_val = NULL;
744 if (value.data[value.length-1] == '\0') {
745 valstr = (char *)value.data;
747 /* ensure 0-termination */
748 valstr = SMB_STRNDUP((char *)value.data, value.length);
752 DEBUG(10, ("Calling function with arguments "
753 "(key = %s, value = %s, timeout = %s)\n",
754 key, valstr, ctime(&timeout)));
756 state->fn(key, valstr, timeout, state->private_data);
761 void gencache_iterate(void (*fn)(const char *key, const char *value,
762 time_t timeout, void *dptr),
763 void *private_data, const char *pattern)
765 struct gencache_iterate_state state;
771 state.private_data = private_data;
772 gencache_iterate_blobs(gencache_iterate_fn, &state, pattern);