Add chainlock_read functions to get a read lock. Used in *massively*
[kai/samba.git] / source3 / tdb / tdbutil.c
1 /* 
2    Unix SMB/CIFS implementation.
3    tdb utility functions
4    Copyright (C) Andrew Tridgell 1992-1998
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 2 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, write to the Free Software
18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21 #include "includes.h"
22 #include <fnmatch.h>
23
24 /* these are little tdb utility functions that are meant to make
25    dealing with a tdb database a little less cumbersome in Samba */
26
27 static SIG_ATOMIC_T gotalarm;
28
29 /***************************************************************
30  Signal function to tell us we timed out.
31 ****************************************************************/
32
33 static void gotalarm_sig(void)
34 {
35         gotalarm = 1;
36 }
37
38 /****************************************************************************
39  Lock a chain with timeout (in seconds).
40 ****************************************************************************/
41
42 static int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
43 {
44         /* Allow tdb_chainlock to be interrupted by an alarm. */
45         int ret;
46         gotalarm = 0;
47         tdb_set_lock_alarm(&gotalarm);
48
49         if (timeout) {
50                 CatchSignal(SIGALRM, SIGNAL_CAST gotalarm_sig);
51                 alarm(timeout);
52         }
53
54         if (rw_type == F_RDLCK)
55                 ret = tdb_chainlock_read(tdb, key);
56         else
57                 ret = tdb_chainlock(tdb, key);
58
59         if (timeout) {
60                 alarm(0);
61                 CatchSignal(SIGALRM, SIGNAL_CAST SIG_IGN);
62                 if (gotalarm) {
63                         DEBUG(0,("tdb_chainlock_with_timeout: alarm (%u) timed out for key %s in tdb %s\n",
64                                 timeout, key.dptr, tdb->name ));
65                         return -1;
66                 }
67         }
68
69         return ret;
70 }
71
72 /****************************************************************************
73  Lock a chain by string. Return -1 if timeout or lock failed.
74 ****************************************************************************/
75
76 int tdb_lock_bystring(TDB_CONTEXT *tdb, char *keyval, unsigned int timeout)
77 {
78         TDB_DATA key;
79
80         key.dptr = keyval;
81         key.dsize = strlen(keyval)+1;
82         
83         return tdb_chainlock_with_timeout(tdb, key, timeout, F_WRLCK);
84 }
85
86 /****************************************************************************
87  Unlock a chain by string.
88 ****************************************************************************/
89
90 void tdb_unlock_bystring(TDB_CONTEXT *tdb, char *keyval)
91 {
92         TDB_DATA key;
93
94         key.dptr = keyval;
95         key.dsize = strlen(keyval)+1;
96         
97         tdb_chainunlock(tdb, key);
98 }
99
100 /****************************************************************************
101  Read lock a chain by string. Return -1 if timeout or lock failed.
102 ****************************************************************************/
103
104 int tdb_read_lock_bystring(TDB_CONTEXT *tdb, char *keyval, unsigned int timeout)
105 {
106         TDB_DATA key;
107
108         key.dptr = keyval;
109         key.dsize = strlen(keyval)+1;
110         
111         return tdb_chainlock_with_timeout(tdb, key, timeout, F_RDLCK);
112 }
113
114 /****************************************************************************
115  Read unlock a chain by string.
116 ****************************************************************************/
117
118 void tdb_read_unlock_bystring(TDB_CONTEXT *tdb, char *keyval)
119 {
120         TDB_DATA key;
121
122         key.dptr = keyval;
123         key.dsize = strlen(keyval)+1;
124         
125         tdb_chainunlock_read(tdb, key);
126 }
127
128
129 /****************************************************************************
130  Fetch a int32 value by a arbitrary blob key, return -1 if not found.
131  Output is int32 in native byte order.
132 ****************************************************************************/
133
134 int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len)
135 {
136         TDB_DATA key, data;
137         int32 ret;
138
139         key.dptr = keyval;
140         key.dsize = len;
141         data = tdb_fetch(tdb, key);
142         if (!data.dptr || data.dsize != sizeof(int32))
143                 return -1;
144         
145         ret = IVAL(data.dptr,0);
146         SAFE_FREE(data.dptr);
147         return ret;
148 }
149
150 /****************************************************************************
151  Fetch a int32 value by string key, return -1 if not found.
152  Output is int32 in native byte order.
153 ****************************************************************************/
154
155 int32 tdb_fetch_int32(TDB_CONTEXT *tdb, char *keystr)
156 {
157         return tdb_fetch_int32_byblob(tdb, keystr, strlen(keystr) + 1);
158 }
159
160 /****************************************************************************
161  Store a int32 value by an arbitary blob key, return 0 on success, -1 on failure.
162  Input is int32 in native byte order. Output in tdb is in little-endian.
163 ****************************************************************************/
164
165 int tdb_store_int32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, int32 v)
166 {
167         TDB_DATA key, data;
168         int32 v_store;
169
170         key.dptr = keystr;
171         key.dsize = len;
172         SIVAL(&v_store,0,v);
173         data.dptr = (void *)&v_store;
174         data.dsize = sizeof(int32);
175
176         return tdb_store(tdb, key, data, TDB_REPLACE);
177 }
178
179 /****************************************************************************
180  Store a int32 value by string key, return 0 on success, -1 on failure.
181  Input is int32 in native byte order. Output in tdb is in little-endian.
182 ****************************************************************************/
183
184 int tdb_store_int32(TDB_CONTEXT *tdb, char *keystr, int32 v)
185 {
186         return tdb_store_int32_byblob(tdb, keystr, strlen(keystr) + 1, v);
187 }
188
189 /****************************************************************************
190  Fetch a uint32 value by a arbitrary blob key, return -1 if not found.
191  Output is uint32 in native byte order.
192 ****************************************************************************/
193
194 BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len, uint32 *value)
195 {
196         TDB_DATA key, data;
197
198         key.dptr = keyval;
199         key.dsize = len;
200         data = tdb_fetch(tdb, key);
201         if (!data.dptr || data.dsize != sizeof(uint32))
202                 return False;
203         
204         *value = IVAL(data.dptr,0);
205         SAFE_FREE(data.dptr);
206         return True;
207 }
208
209 /****************************************************************************
210  Fetch a uint32 value by string key, return -1 if not found.
211  Output is uint32 in native byte order.
212 ****************************************************************************/
213
214 BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 *value)
215 {
216         return tdb_fetch_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
217 }
218
219 /****************************************************************************
220  Store a uint32 value by an arbitary blob key, return 0 on success, -1 on failure.
221  Input is uint32 in native byte order. Output in tdb is in little-endian.
222 ****************************************************************************/
223
224 BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, uint32 value)
225 {
226         TDB_DATA key, data;
227         uint32 v_store;
228         BOOL ret = True;
229
230         key.dptr = keystr;
231         key.dsize = len;
232         SIVAL(&v_store, 0, value);
233         data.dptr = (void *)&v_store;
234         data.dsize = sizeof(uint32);
235
236         if (tdb_store(tdb, key, data, TDB_REPLACE) == -1)
237                 ret = False;
238
239         return ret;
240 }
241
242 /****************************************************************************
243  Store a uint32 value by string key, return 0 on success, -1 on failure.
244  Input is uint32 in native byte order. Output in tdb is in little-endian.
245 ****************************************************************************/
246
247 BOOL tdb_store_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 value)
248 {
249         return tdb_store_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
250 }
251 /****************************************************************************
252  Store a buffer by a null terminated string key.  Return 0 on success, -1
253  on failure.
254 ****************************************************************************/
255
256 int tdb_store_by_string(TDB_CONTEXT *tdb, char *keystr, TDB_DATA data, int flags)
257 {
258     TDB_DATA key;
259
260     key.dptr = keystr;
261     key.dsize = strlen(keystr) + 1;
262
263     return tdb_store(tdb, key, data, flags);
264 }
265
266 /****************************************************************************
267  Fetch a buffer using a null terminated string key.  Don't forget to call
268  free() on the result dptr.
269 ****************************************************************************/
270
271 TDB_DATA tdb_fetch_by_string(TDB_CONTEXT *tdb, char *keystr)
272 {
273     TDB_DATA key;
274
275     key.dptr = keystr;
276     key.dsize = strlen(keystr) + 1;
277
278     return tdb_fetch(tdb, key);
279 }
280
281 /****************************************************************************
282  Delete an entry using a null terminated string key. 
283 ****************************************************************************/
284
285 int tdb_delete_by_string(TDB_CONTEXT *tdb, char *keystr)
286 {
287     TDB_DATA key;
288
289     key.dptr = keystr;
290     key.dsize = strlen(keystr) + 1;
291
292     return tdb_delete(tdb, key);
293 }
294
295 /****************************************************************************
296  Atomic integer change. Returns old value. To create, set initial value in *oldval. 
297 ****************************************************************************/
298
299 int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, char *keystr, int32 *oldval, int32 change_val)
300 {
301         int32 val;
302         int32 ret = -1;
303
304         if (tdb_lock_bystring(tdb, keystr,0) == -1)
305                 return -1;
306
307         if ((val = tdb_fetch_int32(tdb, keystr)) == -1) {
308                 /* The lookup failed */
309                 if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
310                         /* but not becouse it didn't exist */
311                         goto err_out;
312                 }
313                 
314                 /* Start with 'old' value */
315                 val = *oldval;
316
317         } else {
318                 /* It worked, set return value (oldval) to tdb data */
319                 *oldval = val;
320         }
321
322         /* Increment value for storage and return next time */
323         val += change_val;
324                 
325         if (tdb_store_int32(tdb, keystr, val) == -1)
326                 goto err_out;
327
328         ret = 0;
329
330   err_out:
331
332         tdb_unlock_bystring(tdb, keystr);
333         return ret;
334 }
335
336 /****************************************************************************
337  Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval. 
338 ****************************************************************************/
339
340 BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, char *keystr, uint32 *oldval, uint32 change_val)
341 {
342         uint32 val;
343         BOOL ret = False;
344
345         if (tdb_lock_bystring(tdb, keystr,0) == -1)
346                 return False;
347
348         if (!tdb_fetch_uint32(tdb, keystr, &val)) {
349                 /* It failed */
350                 if (tdb_error(tdb) != TDB_ERR_NOEXIST) { 
351                         /* and not becouse it didn't exist */
352                         goto err_out;
353                 }
354
355                 /* Start with 'old' value */
356                 val = *oldval;
357
358         } else {
359                 /* it worked, set return value (oldval) to tdb data */
360                 *oldval = val;
361
362         }
363
364         /* get a new value to store */
365         val += change_val;
366                 
367         if (!tdb_store_uint32(tdb, keystr, val))
368                 goto err_out;
369
370         ret = True;
371
372   err_out:
373
374         tdb_unlock_bystring(tdb, keystr);
375         return ret;
376 }
377
378 /****************************************************************************
379  Useful pair of routines for packing/unpacking data consisting of
380  integers and strings.
381 ****************************************************************************/
382
383 size_t tdb_pack(char *buf, int bufsize, char *fmt, ...)
384 {
385         va_list ap;
386         uint16 w;
387         uint32 d;
388         int i;
389         void *p;
390         int len;
391         char *s;
392         char c;
393         char *buf0 = buf;
394         char *fmt0 = fmt;
395         int bufsize0 = bufsize;
396
397         va_start(ap, fmt);
398
399         while (*fmt) {
400                 switch ((c = *fmt++)) {
401                 case 'w':
402                         len = 2;
403                         w = (uint16)va_arg(ap, int);
404                         if (bufsize >= len)
405                                 SSVAL(buf, 0, w);
406                         break;
407                 case 'd':
408                         len = 4;
409                         d = va_arg(ap, uint32);
410                         if (bufsize >= len)
411                                 SIVAL(buf, 0, d);
412                         break;
413                 case 'p':
414                         len = 4;
415                         p = va_arg(ap, void *);
416                         d = p?1:0;
417                         if (bufsize >= len)
418                                 SIVAL(buf, 0, d);
419                         break;
420                 case 'P':
421                         s = va_arg(ap,char *);
422                         w = strlen(s);
423                         len = w + 1;
424                         if (bufsize >= len)
425                                 memcpy(buf, s, len);
426                         break;
427                 case 'f':
428                         s = va_arg(ap,char *);
429                         w = strlen(s);
430                         len = w + 1;
431                         if (bufsize >= len)
432                                 memcpy(buf, s, len);
433                         break;
434                 case 'B':
435                         i = va_arg(ap, int);
436                         s = va_arg(ap, char *);
437                         len = 4+i;
438                         if (bufsize >= len) {
439                                 SIVAL(buf, 0, i);
440                                 memcpy(buf+4, s, i);
441                         }
442                         break;
443                 default:
444                         DEBUG(0,("Unknown tdb_pack format %c in %s\n", 
445                                  c, fmt));
446                         len = 0;
447                         break;
448                 }
449
450                 buf += len;
451                 bufsize -= len;
452         }
453
454         va_end(ap);
455
456         DEBUG(18,("tdb_pack(%s, %d) -> %d\n", 
457                  fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
458         
459         return PTR_DIFF(buf, buf0);
460 }
461
462 /****************************************************************************
463  Useful pair of routines for packing/unpacking data consisting of
464  integers and strings.
465 ****************************************************************************/
466
467 int tdb_unpack(char *buf, int bufsize, char *fmt, ...)
468 {
469         va_list ap;
470         uint16 *w;
471         uint32 *d;
472         int len;
473         int *i;
474         void **p;
475         char *s, **b;
476         char c;
477         char *buf0 = buf;
478         char *fmt0 = fmt;
479         int bufsize0 = bufsize;
480
481         va_start(ap, fmt);
482         
483         while (*fmt) {
484                 switch ((c=*fmt++)) {
485                 case 'w':
486                         len = 2;
487                         w = va_arg(ap, uint16 *);
488                         if (bufsize < len)
489                                 goto no_space;
490                         *w = SVAL(buf, 0);
491                         break;
492                 case 'd':
493                         len = 4;
494                         d = va_arg(ap, uint32 *);
495                         if (bufsize < len)
496                                 goto no_space;
497                         *d = IVAL(buf, 0);
498                         break;
499                 case 'p':
500                         len = 4;
501                         p = va_arg(ap, void **);
502                         if (bufsize < len)
503                                 goto no_space;
504                         *p = (void *)IVAL(buf, 0);
505                         break;
506                 case 'P':
507                         s = va_arg(ap,char *);
508                         len = strlen(buf) + 1;
509                         if (bufsize < len || len > sizeof(pstring))
510                                 goto no_space;
511                         memcpy(s, buf, len);
512                         break;
513                 case 'f':
514                         s = va_arg(ap,char *);
515                         len = strlen(buf) + 1;
516                         if (bufsize < len || len > sizeof(fstring))
517                                 goto no_space;
518                         memcpy(s, buf, len);
519                         break;
520                 case 'B':
521                         i = va_arg(ap, int *);
522                         b = va_arg(ap, char **);
523                         len = 4;
524                         if (bufsize < len)
525                                 goto no_space;
526                         *i = IVAL(buf, 0);
527                         if (! *i) {
528                                 *b = NULL;
529                                 break;
530                         }
531                         len += *i;
532                         if (bufsize < len)
533                                 goto no_space;
534                         *b = (char *)malloc(*i);
535                         if (! *b)
536                                 goto no_space;
537                         memcpy(*b, buf+4, *i);
538                         break;
539                 default:
540                         DEBUG(0,("Unknown tdb_unpack format %c in %s\n", 
541                                  c, fmt));
542
543                         len = 0;
544                         break;
545                 }
546
547                 buf += len;
548                 bufsize -= len;
549         }
550
551         va_end(ap);
552
553         DEBUG(18,("tdb_unpack(%s, %d) -> %d\n", 
554                  fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
555
556         return PTR_DIFF(buf, buf0);
557
558  no_space:
559         return -1;
560 }
561
562 /****************************************************************************
563  Log tdb messages via DEBUG().
564 ****************************************************************************/
565
566 static void tdb_log(TDB_CONTEXT *tdb, int level, const char *format, ...)
567 {
568         va_list ap;
569         char *ptr = NULL;
570
571         va_start(ap, format);
572         vasprintf(&ptr, format, ap);
573         va_end(ap);
574         
575         if (!ptr || !*ptr)
576                 return;
577
578         DEBUG(level, ("tdb(%s): %s", tdb->name ? tdb->name : "unnamed", ptr));
579         SAFE_FREE(ptr);
580 }
581
582 /****************************************************************************
583  Like tdb_open() but also setup a logging function that redirects to
584  the samba DEBUG() system.
585 ****************************************************************************/
586
587 TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
588                           int open_flags, mode_t mode)
589 {
590         TDB_CONTEXT *tdb;
591
592         if (!lp_use_mmap())
593                 tdb_flags |= TDB_NOMMAP;
594
595         tdb = tdb_open_ex(name, hash_size, tdb_flags, 
596                                     open_flags, mode, tdb_log);
597         if (!tdb)
598                 return NULL;
599
600         return tdb;
601 }
602
603
604 /****************************************************************************
605  Allow tdb_delete to be used as a tdb_traversal_fn.
606 ****************************************************************************/
607
608 int tdb_traverse_delete_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf,
609                      void *state)
610 {
611     return tdb_delete(the_tdb, key);
612 }
613
614
615
616 /**
617  * Search across the whole tdb for keys that match the given pattern
618  * return the result as a list of keys
619  *
620  * @param tdb pointer to opened tdb file context
621  * @param pattern searching pattern used by fnmatch(3) functions
622  *
623  * @return list of keys found by looking up with given pattern
624  **/
625 TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
626 {
627         TDB_DATA key, next;
628         TDB_LIST_NODE *list = NULL;
629         TDB_LIST_NODE *rec = NULL;
630         TDB_LIST_NODE *tmp = NULL;
631         
632         for (key = tdb_firstkey(tdb); key.dptr; key = next) {
633                 /* duplicate key string to ensure null-termination */
634                 char *key_str = (char*) strndup(key.dptr, key.dsize);
635                 if (!key_str) {
636                         DEBUG(0, ("tdb_search_keys: strndup() failed!\n"));
637                         smb_panic("strndup failed!\n");
638                 }
639                 
640                 DEBUG(18, ("checking %s for match to pattern %s\n", key_str, pattern));
641                 
642                 next = tdb_nextkey(tdb, key);
643
644                 /* do the pattern checking */
645                 if (fnmatch(pattern, key_str, 0) == 0) {
646                         rec = (TDB_LIST_NODE*) malloc(sizeof(*rec));
647                         ZERO_STRUCTP(rec);
648
649                         rec->node_key = key;
650         
651                         DLIST_ADD_END(list, rec, tmp);
652                 
653                         DEBUG(18, ("checking %s matched pattern %s\n", key_str, pattern));
654                 } else {
655                         free(key.dptr);
656                 }
657                 
658                 /* free duplicated key string */
659                 free(key_str);
660         }
661         
662         return list;
663
664 };
665
666
667 /**
668  * Free the list returned by tdb_search_keys
669  *
670  * @param node list of results found by tdb_search_keys
671  **/
672 void tdb_search_list_free(TDB_LIST_NODE* node)
673 {
674         TDB_LIST_NODE *next_node;
675         
676         while (node) {
677                 next_node = node->next;
678                 SAFE_FREE(node);
679                 node = next_node;
680         };
681 };
682
683