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