2 Unix SMB/CIFS implementation.
4 trivial database library
6 Copyright (C) Andrew Tridgell 1999-2005
7 Copyright (C) Paul `Rusty' Russell 2000
8 Copyright (C) Jeremy Allison 2000-2003
10 ** NOTE! The following LGPL license applies to the tdb
11 ** library. This does NOT imply that all of Samba is released
14 This library is free software; you can redistribute it and/or
15 modify it under the terms of the GNU Lesser General Public
16 License as published by the Free Software Foundation; either
17 version 3 of the License, or (at your option) any later version.
19 This library is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 Lesser General Public License for more details.
24 You should have received a copy of the GNU Lesser General Public
25 License along with this library; if not, see <http://www.gnu.org/licenses/>.
28 #include "tdb_private.h"
30 /* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
31 static struct tdb_context
*tdbs
= NULL
;
33 /* We use two hashes to double-check they're using the right hash function. */
34 void tdb_header_hash(struct tdb_context
*tdb
,
35 uint32_t *magic1_hash
, uint32_t *magic2_hash
)
38 uint32_t tdb_magic
= TDB_MAGIC
;
40 hash_key
.dptr
= discard_const_p(unsigned char, TDB_MAGIC_FOOD
);
41 hash_key
.dsize
= sizeof(TDB_MAGIC_FOOD
);
42 *magic1_hash
= tdb
->hash_fn(&hash_key
);
44 hash_key
.dptr
= (unsigned char *)CONVERT(tdb_magic
);
45 hash_key
.dsize
= sizeof(tdb_magic
);
46 *magic2_hash
= tdb
->hash_fn(&hash_key
);
48 /* Make sure at least one hash is non-zero! */
49 if (*magic1_hash
== 0 && *magic2_hash
== 0)
53 /* initialise a new database with a specified hash size */
54 static int tdb_new_database(struct tdb_context
*tdb
, struct tdb_header
*header
,
57 struct tdb_header
*newdb
;
61 /* We make it up in memory, then write it out if not internal */
62 size
= sizeof(struct tdb_header
) + (hash_size
+1)*sizeof(tdb_off_t
);
63 if (!(newdb
= (struct tdb_header
*)calloc(size
, 1))) {
64 tdb
->ecode
= TDB_ERR_OOM
;
68 /* Fill in the header */
69 newdb
->version
= TDB_VERSION
;
70 newdb
->hash_size
= hash_size
;
72 tdb_header_hash(tdb
, &newdb
->magic1_hash
, &newdb
->magic2_hash
);
74 /* Make sure older tdbs (which don't check the magic hash fields)
75 * will refuse to open this TDB. */
76 if (tdb
->flags
& TDB_INCOMPATIBLE_HASH
)
77 newdb
->rwlocks
= TDB_HASH_RWLOCK_MAGIC
;
79 if (tdb
->flags
& TDB_INTERNAL
) {
81 tdb
->map_ptr
= (char *)newdb
;
82 memcpy(header
, newdb
, sizeof(*header
));
83 /* Convert the `ondisk' version if asked. */
87 if (lseek(tdb
->fd
, 0, SEEK_SET
) == -1)
90 if (ftruncate(tdb
->fd
, 0) == -1)
93 /* This creates an endian-converted header, as if read from disk */
95 memcpy(header
, newdb
, sizeof(*header
));
96 /* Don't endian-convert the magic food! */
97 memcpy(newdb
->magic_food
, TDB_MAGIC_FOOD
, strlen(TDB_MAGIC_FOOD
)+1);
99 if (!tdb_write_all(tdb
->fd
, newdb
, size
))
110 static int tdb_already_open(dev_t device
,
113 struct tdb_context
*i
;
115 for (i
= tdbs
; i
; i
= i
->next
) {
116 if (i
->device
== device
&& i
->inode
== ino
) {
124 /* open the database, creating it if necessary
126 The open_flags and mode are passed straight to the open call on the
127 database file. A flags value of O_WRONLY is invalid. The hash size
128 is advisory, use zero for a default value.
130 Return is NULL on error, in which case errno is also set. Don't
131 try to call tdb_error or tdb_errname, just do strerror(errno).
133 @param name may be NULL for internal databases. */
134 _PUBLIC_
struct tdb_context
*tdb_open(const char *name
, int hash_size
, int tdb_flags
,
135 int open_flags
, mode_t mode
)
137 return tdb_open_ex(name
, hash_size
, tdb_flags
, open_flags
, mode
, NULL
, NULL
);
140 /* a default logging function */
141 static void null_log_fn(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *fmt
, ...) PRINTF_ATTRIBUTE(3, 4);
142 static void null_log_fn(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *fmt
, ...)
146 static bool check_header_hash(struct tdb_context
*tdb
,
147 struct tdb_header
*header
,
148 bool default_hash
, uint32_t *m1
, uint32_t *m2
)
150 tdb_header_hash(tdb
, m1
, m2
);
151 if (header
->magic1_hash
== *m1
&&
152 header
->magic2_hash
== *m2
) {
156 /* If they explicitly set a hash, always respect it. */
160 /* Otherwise, try the other inbuilt hash. */
161 if (tdb
->hash_fn
== tdb_old_hash
)
162 tdb
->hash_fn
= tdb_jenkins_hash
;
164 tdb
->hash_fn
= tdb_old_hash
;
165 return check_header_hash(tdb
, header
, false, m1
, m2
);
168 _PUBLIC_
struct tdb_context
*tdb_open_ex(const char *name
, int hash_size
, int tdb_flags
,
169 int open_flags
, mode_t mode
,
170 const struct tdb_logging_context
*log_ctx
,
171 tdb_hash_func hash_fn
)
173 struct tdb_header header
;
174 struct tdb_context
*tdb
;
176 int rev
= 0, locked
= 0;
180 const char *hash_alg
;
181 uint32_t magic1
, magic2
;
185 if (!(tdb
= (struct tdb_context
*)calloc(1, sizeof *tdb
))) {
197 tdb
->flags
= tdb_flags
;
198 tdb
->open_flags
= open_flags
;
202 tdb
->log
.log_fn
= null_log_fn
;
203 tdb
->log
.log_private
= NULL
;
206 if (name
== NULL
&& (tdb_flags
& TDB_INTERNAL
)) {
207 name
= "__TDB_INTERNAL__";
211 tdb
->name
= discard_const_p(char, "__NULL__");
212 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: called with name == NULL\n"));
218 /* now make a copy of the name, as the caller memory might go away */
219 if (!(tdb
->name
= (char *)strdup(name
))) {
221 * set the name as the given string, so that tdb_name() will
222 * work in case of an error.
224 tdb
->name
= discard_const_p(char, name
);
225 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: can't strdup(%s)\n",
233 tdb
->hash_fn
= hash_fn
;
234 hash_alg
= "the user defined";
236 /* This controls what we use when creating a tdb. */
237 if (tdb
->flags
& TDB_INCOMPATIBLE_HASH
) {
238 tdb
->hash_fn
= tdb_jenkins_hash
;
240 tdb
->hash_fn
= tdb_old_hash
;
242 hash_alg
= "either default";
245 /* cache the page size */
246 tdb
->page_size
= getpagesize();
247 if (tdb
->page_size
<= 0) {
248 tdb
->page_size
= 0x2000;
251 tdb
->max_dead_records
= (tdb_flags
& TDB_VOLATILE
) ? 5 : 0;
253 if ((open_flags
& O_ACCMODE
) == O_WRONLY
) {
254 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: can't open tdb %s write-only\n",
261 hash_size
= DEFAULT_HASH_SIZE
;
262 if ((open_flags
& O_ACCMODE
) == O_RDONLY
) {
264 /* read only databases don't do locking or clear if first */
265 tdb
->flags
|= TDB_NOLOCK
;
266 tdb
->flags
&= ~TDB_CLEAR_IF_FIRST
;
269 if ((tdb
->flags
& TDB_ALLOW_NESTING
) &&
270 (tdb
->flags
& TDB_DISALLOW_NESTING
)) {
271 tdb
->ecode
= TDB_ERR_NESTING
;
272 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
273 "allow_nesting and disallow_nesting are not allowed together!"));
278 if (getenv("TDB_NO_FSYNC")) {
279 tdb
->flags
|= TDB_NOSYNC
;
283 * TDB_ALLOW_NESTING is the default behavior.
284 * Note: this may change in future versions!
286 if (!(tdb
->flags
& TDB_DISALLOW_NESTING
)) {
287 tdb
->flags
|= TDB_ALLOW_NESTING
;
290 /* internal databases don't mmap or lock, and start off cleared */
291 if (tdb
->flags
& TDB_INTERNAL
) {
292 tdb
->flags
|= (TDB_NOLOCK
| TDB_NOMMAP
);
293 tdb
->flags
&= ~TDB_CLEAR_IF_FIRST
;
294 if (tdb_new_database(tdb
, &header
, hash_size
) != 0) {
295 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: tdb_new_database failed!"));
298 tdb
->hash_size
= hash_size
;
302 if ((tdb
->fd
= open(name
, open_flags
, mode
)) == -1) {
303 TDB_LOG((tdb
, TDB_DEBUG_WARNING
, "tdb_open_ex: could not open file %s: %s\n",
304 name
, strerror(errno
)));
305 goto fail
; /* errno set by open(2) */
308 /* on exec, don't inherit the fd */
309 v
= fcntl(tdb
->fd
, F_GETFD
, 0);
310 fcntl(tdb
->fd
, F_SETFD
, v
| FD_CLOEXEC
);
312 /* ensure there is only one process initialising at once */
313 if (tdb_nest_lock(tdb
, OPEN_LOCK
, F_WRLCK
, TDB_LOCK_WAIT
) == -1) {
314 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: failed to get open lock on %s: %s\n",
315 name
, strerror(errno
)));
316 goto fail
; /* errno set by tdb_brlock */
319 /* we need to zero database if we are the only one with it open */
320 if ((tdb_flags
& TDB_CLEAR_IF_FIRST
) &&
322 (locked
= (tdb_nest_lock(tdb
, ACTIVE_LOCK
, F_WRLCK
, TDB_LOCK_NOWAIT
|TDB_LOCK_PROBE
) == 0))) {
324 ret
= tdb_brlock(tdb
, F_WRLCK
, FREELIST_TOP
, 0,
327 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
328 "tdb_brlock failed for %s: %s\n",
329 name
, strerror(errno
)));
332 ret
= tdb_new_database(tdb
, &header
, hash_size
);
334 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
335 "tdb_new_database failed for %s: %s\n",
336 name
, strerror(errno
)));
340 ret
= tdb_brunlock(tdb
, F_WRLCK
, FREELIST_TOP
, 0);
342 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
343 "tdb_unlockall failed for %s: %s\n",
344 name
, strerror(errno
)));
347 ret
= lseek(tdb
->fd
, 0, SEEK_SET
);
349 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
350 "lseek failed for %s: %s\n",
351 name
, strerror(errno
)));
357 if (read(tdb
->fd
, &header
, sizeof(header
)) != sizeof(header
)
358 || strcmp(header
.magic_food
, TDB_MAGIC_FOOD
) != 0) {
359 if (!(open_flags
& O_CREAT
) ||
360 tdb_new_database(tdb
, &header
, hash_size
) == -1) {
362 errno
= EIO
; /* ie bad format or something */
366 rev
= (tdb
->flags
& TDB_CONVERT
);
367 } else if (header
.version
!= TDB_VERSION
368 && !(rev
= (header
.version
==TDB_BYTEREV(TDB_VERSION
)))) {
373 vp
= (unsigned char *)&header
.version
;
374 vertest
= (((uint32_t)vp
[0]) << 24) | (((uint32_t)vp
[1]) << 16) |
375 (((uint32_t)vp
[2]) << 8) | (uint32_t)vp
[3];
376 tdb
->flags
|= (vertest
==TDB_VERSION
) ? TDB_BIGENDIAN
: 0;
378 tdb
->flags
&= ~TDB_CONVERT
;
380 tdb
->flags
|= TDB_CONVERT
;
381 tdb_convert(&header
, sizeof(header
));
383 if (fstat(tdb
->fd
, &st
) == -1)
386 if (header
.rwlocks
!= 0 &&
387 header
.rwlocks
!= TDB_HASH_RWLOCK_MAGIC
) {
388 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: spinlocks no longer supported\n"));
391 tdb
->hash_size
= header
.hash_size
;
393 if ((header
.magic1_hash
== 0) && (header
.magic2_hash
== 0)) {
394 /* older TDB without magic hash references */
395 tdb
->hash_fn
= tdb_old_hash
;
396 } else if (!check_header_hash(tdb
, &header
, !hash_fn
,
398 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
399 "%s was not created with %s hash function we are using\n"
400 "magic1_hash[0x%08X %s 0x%08X] "
401 "magic2_hash[0x%08X %s 0x%08X]\n",
404 (header
.magic1_hash
== magic1
) ? "==" : "!=",
407 (header
.magic2_hash
== magic2
) ? "==" : "!=",
413 /* Is it already in the open list? If so, fail. */
414 if (tdb_already_open(st
.st_dev
, st
.st_ino
)) {
415 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: "
416 "%s (%d,%d) is already open in this process\n",
417 name
, (int)st
.st_dev
, (int)st
.st_ino
));
422 /* Beware truncation! */
423 tdb
->map_size
= st
.st_size
;
424 if (tdb
->map_size
!= st
.st_size
) {
425 /* Ensure ecode is set for log fn. */
426 tdb
->ecode
= TDB_ERR_IO
;
427 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
428 "len %llu too large!\n", (long long)st
.st_size
));
433 tdb
->device
= st
.st_dev
;
434 tdb
->inode
= st
.st_ino
;
437 if (tdb_nest_unlock(tdb
, ACTIVE_LOCK
, F_WRLCK
, false) == -1) {
438 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: "
439 "failed to release ACTIVE_LOCK on %s: %s\n",
440 name
, strerror(errno
)));
446 /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
447 we didn't get the initial exclusive lock as we need to let all other
448 users know we're using it. */
450 if (tdb_flags
& TDB_CLEAR_IF_FIRST
) {
451 /* leave this lock in place to indicate it's in use */
452 if (tdb_nest_lock(tdb
, ACTIVE_LOCK
, F_RDLCK
, TDB_LOCK_WAIT
) == -1) {
457 /* if needed, run recovery */
458 if (tdb_transaction_recover(tdb
) == -1) {
464 char tracefile
[strlen(name
) + 32];
466 snprintf(tracefile
, sizeof(tracefile
),
467 "%s.trace.%li", name
, (long)getpid());
468 tdb
->tracefd
= open(tracefile
, O_WRONLY
|O_CREAT
|O_EXCL
, 0600);
469 if (tdb
->tracefd
>= 0) {
470 tdb_enable_seqnum(tdb
);
471 tdb_trace_open(tdb
, "tdb_open", hash_size
, tdb_flags
,
474 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: failed to open trace file %s!\n", tracefile
));
479 /* Internal (memory-only) databases skip all the code above to
480 * do with disk files, and resume here by releasing their
481 * open lock and hooking into the active list. */
482 if (tdb_nest_unlock(tdb
, OPEN_LOCK
, F_WRLCK
, false) == -1) {
490 { int save_errno
= errno
;
499 if (tdb
->flags
& TDB_INTERNAL
)
500 SAFE_FREE(tdb
->map_ptr
);
505 if (close(tdb
->fd
) != 0)
506 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: failed to close tdb->fd on error!\n"));
507 SAFE_FREE(tdb
->lockrecs
);
508 SAFE_FREE(tdb
->name
);
516 * Set the maximum number of dead records per hash chain
519 _PUBLIC_
void tdb_set_max_dead(struct tdb_context
*tdb
, int max_dead
)
521 tdb
->max_dead_records
= max_dead
;
527 * @returns -1 for error; 0 for success.
529 _PUBLIC_
int tdb_close(struct tdb_context
*tdb
)
531 struct tdb_context
**i
;
534 if (tdb
->transaction
) {
535 tdb_transaction_cancel(tdb
);
537 tdb_trace(tdb
, "tdb_close");
540 if (tdb
->flags
& TDB_INTERNAL
)
541 SAFE_FREE(tdb
->map_ptr
);
545 SAFE_FREE(tdb
->name
);
547 ret
= close(tdb
->fd
);
550 SAFE_FREE(tdb
->lockrecs
);
552 /* Remove from contexts list */
553 for (i
= &tdbs
; *i
; i
= &(*i
)->next
) {
563 memset(tdb
, 0, sizeof(*tdb
));
569 /* register a loging function */
570 _PUBLIC_
void tdb_set_logging_function(struct tdb_context
*tdb
,
571 const struct tdb_logging_context
*log_ctx
)
576 _PUBLIC_
void *tdb_get_logging_private(struct tdb_context
*tdb
)
578 return tdb
->log
.log_private
;
581 static int tdb_reopen_internal(struct tdb_context
*tdb
, bool active_lock
)
583 #if !defined(LIBREPLACE_PREAD_NOT_REPLACED) || \
584 !defined(LIBREPLACE_PWRITE_NOT_REPLACED)
588 if (tdb
->flags
& TDB_INTERNAL
) {
589 return 0; /* Nothing to do. */
592 if (tdb_have_extra_locks(tdb
)) {
593 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_reopen: reopen not allowed with locks held\n"));
597 if (tdb
->transaction
!= 0) {
598 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_reopen: reopen not allowed inside a transaction\n"));
602 /* If we have real pread & pwrite, we can skip reopen. */
603 #if !defined(LIBREPLACE_PREAD_NOT_REPLACED) || \
604 !defined(LIBREPLACE_PWRITE_NOT_REPLACED)
605 if (tdb_munmap(tdb
) != 0) {
606 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: munmap failed (%s)\n", strerror(errno
)));
609 if (close(tdb
->fd
) != 0)
610 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
611 tdb
->fd
= open(tdb
->name
, tdb
->open_flags
& ~(O_CREAT
|O_TRUNC
), 0);
613 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: open failed (%s)\n", strerror(errno
)));
616 if (fstat(tdb
->fd
, &st
) != 0) {
617 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: fstat failed (%s)\n", strerror(errno
)));
620 if (st
.st_ino
!= tdb
->inode
|| st
.st_dev
!= tdb
->device
) {
621 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: file dev/inode has changed!\n"));
624 if (tdb_mmap(tdb
) != 0) {
627 #endif /* fake pread or pwrite */
629 /* We may still think we hold the active lock. */
630 tdb
->num_lockrecs
= 0;
631 SAFE_FREE(tdb
->lockrecs
);
633 if (active_lock
&& tdb_nest_lock(tdb
, ACTIVE_LOCK
, F_RDLCK
, TDB_LOCK_WAIT
) == -1) {
634 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: failed to obtain active lock\n"));
645 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
646 seek pointer from our parent and to re-establish locks */
647 _PUBLIC_
int tdb_reopen(struct tdb_context
*tdb
)
649 return tdb_reopen_internal(tdb
, tdb
->flags
& TDB_CLEAR_IF_FIRST
);
652 /* reopen all tdb's */
653 _PUBLIC_
int tdb_reopen_all(int parent_longlived
)
655 struct tdb_context
*tdb
;
657 for (tdb
=tdbs
; tdb
; tdb
= tdb
->next
) {
658 bool active_lock
= (tdb
->flags
& TDB_CLEAR_IF_FIRST
);
661 * If the parent is longlived (ie. a
662 * parent daemon architecture), we know
663 * it will keep it's active lock on a
664 * tdb opened with CLEAR_IF_FIRST. Thus
665 * for child processes we don't have to
666 * add an active lock. This is essential
667 * to improve performance on systems that
668 * keep POSIX locks as a non-scalable data
669 * structure in the kernel.
671 if (parent_longlived
) {
672 /* Ensure no clear-if-first. */
676 if (tdb_reopen_internal(tdb
, active_lock
) != 0)