2 Unix SMB/CIFS implementation.
4 Copyright (C) Andrew Tridgell 1992-1998
5 Copyright (C) Rafal Szczesniak 2002
6 Copyright (C) Michael Adam 2007
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "system/filesys.h"
32 /* these are little tdb utility functions that are meant to make
33 dealing with a tdb database a little less cumbersome in Samba */
35 int tdb_trans_store_bystring(TDB_CONTEXT *tdb, const char *keystr,
36 TDB_DATA data, int flags)
38 TDB_DATA key = string_term_tdb_data(keystr);
40 return tdb_trans_store(tdb, key, data, flags);
43 /****************************************************************************
44 Useful pair of routines for packing/unpacking data consisting of
46 ****************************************************************************/
48 static size_t tdb_pack_va(uint8_t *buf, int bufsize, const char *fmt, va_list ap)
59 const char *fmt0 = fmt;
60 int bufsize0 = bufsize;
63 switch ((c = *fmt++)) {
64 case 'b': /* unsigned 8-bit integer */
66 bt = (uint8_t)va_arg(ap, int);
67 if (bufsize && bufsize >= len)
70 case 'w': /* unsigned 16-bit integer */
72 w = (uint16_t)va_arg(ap, int);
73 if (bufsize && bufsize >= len)
76 case 'd': /* signed 32-bit integer (standard int in most systems) */
78 d = va_arg(ap, uint32_t);
79 if (bufsize && bufsize >= len)
82 case 'p': /* pointer */
84 p = va_arg(ap, void *);
86 if (bufsize && bufsize >= len)
89 case 'P': /* null-terminated string */
90 s = va_arg(ap,char *);
93 if (bufsize && bufsize >= len)
96 case 'f': /* null-terminated string */
97 s = va_arg(ap,char *);
100 if (bufsize && bufsize >= len)
103 case 'B': /* fixed-length string */
105 s = va_arg(ap, char *);
107 if (bufsize && bufsize >= len) {
113 DEBUG(0,("Unknown tdb_pack format %c in %s\n",
126 DEBUG(18,("tdb_pack_va(%s, %d) -> %d\n",
127 fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
129 return PTR_DIFF(buf, buf0);
132 size_t tdb_pack(uint8_t *buf, int bufsize, const char *fmt, ...)
138 result = tdb_pack_va(buf, bufsize, fmt, ap);
143 bool tdb_pack_append(TALLOC_CTX *mem_ctx, uint8_t **buf, size_t *len,
144 const char *fmt, ...)
150 len1 = tdb_pack_va(NULL, 0, fmt, ap);
153 if (mem_ctx != NULL) {
154 *buf = talloc_realloc(mem_ctx, *buf, uint8_t,
157 *buf = SMB_REALLOC_ARRAY(*buf, uint8_t, (*len) + len1);
165 len2 = tdb_pack_va((*buf)+(*len), len1, fmt, ap);
177 /****************************************************************************
178 Useful pair of routines for packing/unpacking data consisting of
179 integers and strings.
180 ****************************************************************************/
182 int tdb_unpack(const uint8_t *buf, int bufsize, const char *fmt, ...)
193 const uint8_t *buf0 = buf;
194 const char *fmt0 = fmt;
195 int bufsize0 = bufsize;
200 switch ((c=*fmt++)) {
201 case 'b': /* unsigned 8-bit integer */
203 bt = va_arg(ap, uint8_t *);
208 case 'w': /* unsigned 16-bit integer */
210 w = va_arg(ap, uint16_t *);
215 case 'd': /* unsigned 32-bit integer (standard int in most systems) */
217 d = va_arg(ap, uint32_t *);
222 case 'p': /* pointer */
224 p = va_arg(ap, void **);
228 * This isn't a real pointer - only a token (1 or 0)
229 * to mark the fact a pointer is present.
232 *p = (void *)(IVAL(buf, 0) ? (void *)1 : NULL);
234 case 'P': /* null-terminated string */
235 /* Return malloc'ed string. */
236 ps = va_arg(ap,char **);
237 len = strnlen((const char *)buf, bufsize) + 1;
240 *ps = SMB_STRDUP((const char *)buf);
245 case 'f': /* null-terminated string */
246 s = va_arg(ap,char *);
247 len = strnlen((const char *)buf, bufsize) + 1;
248 if (bufsize < len || len > sizeof(fstring))
252 case 'B': /* fixed-length string */
253 i = va_arg(ap, int *);
254 b = va_arg(ap, char **);
266 *b = (char *)SMB_MALLOC(*i);
269 memcpy(*b, buf+4, *i);
272 DEBUG(0,("Unknown tdb_unpack format %c in %s\n",
285 DEBUG(18,("tdb_unpack(%s, %d) -> %d\n",
286 fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
288 return PTR_DIFF(buf, buf0);
296 /****************************************************************************
297 Log tdb messages via DEBUG().
298 ****************************************************************************/
300 static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
301 const char *format, ...) PRINTF_ATTRIBUTE(3,4);
303 static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, const char *format, ...)
309 va_start(ap, format);
310 ret = vasprintf(&ptr, format, ap);
313 if ((ret == -1) || !*ptr)
316 DEBUG((int)level, ("tdb(%s): %s", tdb_name(tdb) ? tdb_name(tdb) : "unnamed", ptr));
320 /****************************************************************************
321 Like tdb_open() but also setup a logging function that redirects to
322 the samba DEBUG() system.
323 ****************************************************************************/
325 TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
326 int open_flags, mode_t mode)
329 struct tdb_logging_context log_ctx = { .log_fn = tdb_log };
332 tdb_flags |= TDB_NOMMAP;
334 if ((hash_size == 0) && (name != NULL)) {
335 const char *base = strrchr_m(name, '/');
342 hash_size = lp_parm_int(-1, "tdb_hashsize", base, 0);
345 tdb = tdb_open_ex(name, hash_size, tdb_flags,
346 open_flags, mode, &log_ctx, NULL);
353 /****************************************************************************
354 tdb_store, wrapped in a transaction. This way we make sure that a process
355 that dies within writing does not leave a corrupt tdb behind.
356 ****************************************************************************/
358 int tdb_trans_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf,
363 if ((res = tdb_transaction_start(tdb)) != 0) {
364 DEBUG(5, ("tdb_transaction_start failed\n"));
368 if ((res = tdb_store(tdb, key, dbuf, flag)) != 0) {
369 DEBUG(10, ("tdb_store failed\n"));
370 tdb_transaction_cancel(tdb);
374 if ((res = tdb_transaction_commit(tdb)) != 0) {
375 DEBUG(5, ("tdb_transaction_commit failed\n"));
381 /****************************************************************************
382 tdb_delete, wrapped in a transaction. This way we make sure that a process
383 that dies within deleting does not leave a corrupt tdb behind.
384 ****************************************************************************/
386 int tdb_trans_delete(struct tdb_context *tdb, TDB_DATA key)
390 if ((res = tdb_transaction_start(tdb)) != 0) {
391 DEBUG(5, ("tdb_transaction_start failed\n"));
395 if ((res = tdb_delete(tdb, key)) != 0) {
396 DEBUG(10, ("tdb_delete failed\n"));
397 tdb_transaction_cancel(tdb);
401 if ((res = tdb_transaction_commit(tdb)) != 0) {
402 DEBUG(5, ("tdb_transaction_commit failed\n"));
408 int tdb_data_cmp(TDB_DATA t1, TDB_DATA t2)
411 if (t1.dptr == NULL && t2.dptr != NULL) {
414 if (t1.dptr != NULL && t2.dptr == NULL) {
417 if (t1.dptr == t2.dptr) {
418 return t1.dsize - t2.dsize;
420 ret = memcmp(t1.dptr, t2.dptr, MIN(t1.dsize, t2.dsize));
422 return t1.dsize - t2.dsize;
427 char *tdb_data_string(TALLOC_CTX *mem_ctx, TDB_DATA d)
431 cbuf *ost = cbuf_new(mem_ctx);
437 len = cbuf_printf(ost, "%zu:", d.dsize);
442 if (d.dptr == NULL) {
443 len = cbuf_puts(ost, "<NULL>", -1);
445 len = cbuf_print_quoted(ost, (const char*)d.dptr, d.dsize);
451 cbuf_swapptr(ost, &ret, 0);
452 talloc_steal(mem_ctx, ret);
459 static sig_atomic_t gotalarm;
461 /***************************************************************
462 Signal function to tell us we timed out.
463 ****************************************************************/
465 static void gotalarm_sig(int signum)
470 /****************************************************************************
471 Lock a chain with timeout (in seconds).
472 ****************************************************************************/
474 static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
476 /* Allow tdb_chainlock to be interrupted by an alarm. */
481 CatchSignal(SIGALRM, gotalarm_sig);
482 tdb_setalarm_sigptr(tdb, &gotalarm);
486 if (rw_type == F_RDLCK)
487 ret = tdb_chainlock_read(tdb, key);
489 ret = tdb_chainlock(tdb, key);
493 tdb_setalarm_sigptr(tdb, NULL);
494 CatchSignal(SIGALRM, SIG_IGN);
495 if (gotalarm && (ret != 0)) {
496 DEBUG(0,("tdb_chainlock_with_timeout_internal: alarm (%u) timed out for key %s in tdb %s\n",
497 timeout, key.dptr, tdb_name(tdb)));
498 /* TODO: If we time out waiting for a lock, it might
499 * be nice to use F_GETLK to get the pid of the
500 * process currently holding the lock and print that
501 * as part of the debugging message. -- mbp */
506 return ret == 0 ? 0 : -1;
509 /****************************************************************************
510 Write lock a chain. Return non-zero if timeout or lock failed.
511 ****************************************************************************/
513 int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
515 return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
518 int tdb_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
521 TDB_DATA key = string_term_tdb_data(keyval);
523 return tdb_chainlock_with_timeout(tdb, key, timeout);
526 /****************************************************************************
527 Read lock a chain by string. Return non-zero if timeout or lock failed.
528 ****************************************************************************/
530 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout)
532 TDB_DATA key = string_term_tdb_data(keyval);
534 return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);