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 /****************************************************************************
33 Useful pair of routines for packing/unpacking data consisting of
35 ****************************************************************************/
37 static size_t tdb_pack_va(uint8_t *buf, int bufsize, const char *fmt, va_list ap)
47 const char *fmt0 = fmt;
48 int bufsize0 = bufsize;
51 switch ((c = *fmt++)) {
52 case 'b': /* unsigned 8-bit integer */
54 bt = (uint8_t)va_arg(ap, int);
55 if (bufsize && bufsize >= len)
58 case 'w': /* unsigned 16-bit integer */
60 w = (uint16_t)va_arg(ap, int);
61 if (bufsize && bufsize >= len)
64 case 'd': /* signed 32-bit integer (standard int in most systems) */
66 d = va_arg(ap, uint32_t);
67 if (bufsize && bufsize >= len)
70 case 'p': /* pointer */
72 p = va_arg(ap, void *);
74 if (bufsize && bufsize >= len)
77 case 'P': /* null-terminated string */
78 case 'f': /* null-terminated string */
79 s = va_arg(ap,char *);
81 smb_panic("Invalid argument");
85 if (bufsize && bufsize >= len)
88 case 'B': /* fixed-length string */
90 s = va_arg(ap, char *);
92 if (bufsize && bufsize >= len) {
100 DEBUG(0,("Unknown tdb_pack format %c in %s\n",
115 DEBUG(18,("tdb_pack_va(%s, %d) -> %d\n",
116 fmt0, bufsize0, (int)to_write));
121 size_t tdb_pack(uint8_t *buf, int bufsize, const char *fmt, ...)
127 result = tdb_pack_va(buf, bufsize, fmt, ap);
132 /****************************************************************************
133 Useful pair of routines for packing/unpacking data consisting of
134 integers and strings.
135 ****************************************************************************/
137 int tdb_unpack(const uint8_t *buf, int in_bufsize, const char *fmt, ...)
143 size_t bufsize = in_bufsize;
149 const uint8_t *buf0 = buf;
150 const char *fmt0 = fmt;
155 switch ((c=*fmt++)) {
156 case 'b': /* unsigned 8-bit integer */
158 bt = va_arg(ap, uint8_t *);
163 case 'w': /* unsigned 16-bit integer */
165 w = va_arg(ap, uint16_t *);
170 case 'd': /* unsigned 32-bit integer (standard int in most systems) */
172 d = va_arg(ap, uint32_t *);
177 case 'p': /* pointer */
179 p = va_arg(ap, void **);
183 * This isn't a real pointer - only a token (1 or 0)
184 * to mark the fact a pointer is present.
187 *p = (void *)(IVAL(buf, 0) ? (void *)1 : NULL);
189 case 'P': /* null-terminated string */
190 /* Return malloc'ed string. */
191 ps = va_arg(ap,char **);
192 len = strnlen((const char *)buf, bufsize) + 1;
196 *ps = SMB_STRDUP((const char *)buf);
202 case 'f': /* null-terminated string */
203 s = va_arg(ap,char *);
204 len = strnlen((const char *)buf, bufsize) + 1;
205 if (bufsize < len || len > sizeof(fstring))
211 case 'B': /* fixed-length string */
212 i = va_arg(ap, uint32_t *);
213 b = va_arg(ap, char **);
229 *b = (char *)SMB_MALLOC(*i);
232 memcpy(*b, buf+4, *i);
236 DEBUG(0,("Unknown tdb_unpack format %c in %s\n",
249 DEBUG(18,("tdb_unpack(%s, %d) -> %d\n",
250 fmt0, in_bufsize, (int)PTR_DIFF(buf, buf0)));
252 return PTR_DIFF(buf, buf0);
260 /****************************************************************************
261 Log tdb messages via DEBUG().
262 ****************************************************************************/
264 static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level,
265 const char *format, ...) PRINTF_ATTRIBUTE(3,4);
267 static void tdb_log(TDB_CONTEXT *tdb, enum tdb_debug_level level, const char *format, ...)
273 va_start(ap, format);
274 ret = vasprintf(&ptr, format, ap);
277 if ((ret == -1) || !*ptr)
280 DEBUG((int)level, ("tdb(%s): %s", tdb_name(tdb) ? tdb_name(tdb) : "unnamed", ptr));
284 /****************************************************************************
285 Like tdb_open() but also setup a logging function that redirects to
286 the samba DEBUG() system.
287 ****************************************************************************/
289 TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
290 int open_flags, mode_t mode)
293 struct tdb_logging_context log_ctx = { .log_fn = tdb_log };
296 tdb_flags |= TDB_NOMMAP;
298 if ((hash_size == 0) && (name != NULL)) {
299 const char *base = strrchr_m(name, '/');
306 hash_size = lp_parm_int(-1, "tdb_hashsize", base, 0);
309 tdb = tdb_open_ex(name, hash_size, tdb_flags,
310 open_flags, mode, &log_ctx, NULL);
317 int tdb_data_cmp(TDB_DATA t1, TDB_DATA t2)
320 if (t1.dptr == NULL && t2.dptr != NULL) {
323 if (t1.dptr != NULL && t2.dptr == NULL) {
326 if (t1.dptr == t2.dptr) {
327 return t1.dsize - t2.dsize;
329 ret = memcmp(t1.dptr, t2.dptr, MIN(t1.dsize, t2.dsize));
331 return t1.dsize - t2.dsize;
336 char *tdb_data_string(TALLOC_CTX *mem_ctx, TDB_DATA d)
340 cbuf *ost = cbuf_new(mem_ctx);
346 len = cbuf_printf(ost, "%zu:", d.dsize);
351 if (d.dptr == NULL) {
352 len = cbuf_puts(ost, "<NULL>", -1);
354 len = cbuf_print_quoted(ost, (const char*)d.dptr, d.dsize);
360 cbuf_swapptr(ost, &ret, 0);
361 talloc_steal(mem_ctx, ret);
368 char *tdb_data_dbg(TDB_DATA d)
370 return hex_encode_talloc(talloc_tos(), d.dptr, d.dsize);
373 static sig_atomic_t gotalarm;
375 /***************************************************************
376 Signal function to tell us we timed out.
377 ****************************************************************/
379 static void gotalarm_sig(int signum)
384 /****************************************************************************
385 Lock a chain with timeout (in seconds).
386 ****************************************************************************/
388 static int tdb_chainlock_with_timeout_internal( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout, int rw_type)
390 /* Allow tdb_chainlock to be interrupted by an alarm. */
395 CatchSignal(SIGALRM, gotalarm_sig);
396 tdb_setalarm_sigptr(tdb, &gotalarm);
400 if (rw_type == F_RDLCK)
401 ret = tdb_chainlock_read(tdb, key);
403 ret = tdb_chainlock(tdb, key);
407 tdb_setalarm_sigptr(tdb, NULL);
408 CatchSignal(SIGALRM, SIG_IGN);
409 if (gotalarm && (ret != 0)) {
410 DEBUG(0,("tdb_chainlock_with_timeout_internal: alarm (%u) timed out for key %s in tdb %s\n",
411 timeout, key.dptr, tdb_name(tdb)));
412 /* TODO: If we time out waiting for a lock, it might
413 * be nice to use F_GETLK to get the pid of the
414 * process currently holding the lock and print that
415 * as part of the debugging message. -- mbp */
420 return ret == 0 ? 0 : -1;
423 /****************************************************************************
424 Write lock a chain. Return non-zero if timeout or lock failed.
425 ****************************************************************************/
427 int tdb_chainlock_with_timeout( TDB_CONTEXT *tdb, TDB_DATA key, unsigned int timeout)
429 return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_WRLCK);
432 int tdb_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval,
435 TDB_DATA key = string_term_tdb_data(keyval);
437 return tdb_chainlock_with_timeout(tdb, key, timeout);
440 /****************************************************************************
441 Read lock a chain by string. Return non-zero if timeout or lock failed.
442 ****************************************************************************/
444 int tdb_read_lock_bystring_with_timeout(TDB_CONTEXT *tdb, const char *keyval, unsigned int timeout)
446 TDB_DATA key = string_term_tdb_data(keyval);
448 return tdb_chainlock_with_timeout_internal(tdb, key, timeout, F_RDLCK);