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
;
80 * If we have any features we add the FEATURE_FLAG_MAGIC, overwriting the
81 * TDB_HASH_RWLOCK_MAGIC above.
83 if (newdb
->feature_flags
!= 0) {
84 newdb
->rwlocks
= TDB_FEATURE_FLAG_MAGIC
;
88 * It's required for some following code pathes
89 * to have the fields on 'tdb' up-to-date.
91 tdb
->feature_flags
= newdb
->feature_flags
;
93 if (tdb
->flags
& TDB_INTERNAL
) {
95 tdb
->map_ptr
= (char *)newdb
;
96 memcpy(header
, newdb
, sizeof(*header
));
97 /* Convert the `ondisk' version if asked. */
101 if (lseek(tdb
->fd
, 0, SEEK_SET
) == -1)
104 if (ftruncate(tdb
->fd
, 0) == -1)
107 /* This creates an endian-converted header, as if read from disk */
109 memcpy(header
, newdb
, sizeof(*header
));
110 /* Don't endian-convert the magic food! */
111 memcpy(newdb
->magic_food
, TDB_MAGIC_FOOD
, strlen(TDB_MAGIC_FOOD
)+1);
113 if (!tdb_write_all(tdb
->fd
, newdb
, size
))
124 static int tdb_already_open(dev_t device
,
127 struct tdb_context
*i
;
129 for (i
= tdbs
; i
; i
= i
->next
) {
130 if (i
->device
== device
&& i
->inode
== ino
) {
138 /* open the database, creating it if necessary
140 The open_flags and mode are passed straight to the open call on the
141 database file. A flags value of O_WRONLY is invalid. The hash size
142 is advisory, use zero for a default value.
144 Return is NULL on error, in which case errno is also set. Don't
145 try to call tdb_error or tdb_errname, just do strerror(errno).
147 @param name may be NULL for internal databases. */
148 _PUBLIC_
struct tdb_context
*tdb_open(const char *name
, int hash_size
, int tdb_flags
,
149 int open_flags
, mode_t mode
)
151 return tdb_open_ex(name
, hash_size
, tdb_flags
, open_flags
, mode
, NULL
, NULL
);
154 /* a default logging function */
155 static void null_log_fn(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *fmt
, ...) PRINTF_ATTRIBUTE(3, 4);
156 static void null_log_fn(struct tdb_context
*tdb
, enum tdb_debug_level level
, const char *fmt
, ...)
160 static bool check_header_hash(struct tdb_context
*tdb
,
161 struct tdb_header
*header
,
162 bool default_hash
, uint32_t *m1
, uint32_t *m2
)
164 tdb_header_hash(tdb
, m1
, m2
);
165 if (header
->magic1_hash
== *m1
&&
166 header
->magic2_hash
== *m2
) {
170 /* If they explicitly set a hash, always respect it. */
174 /* Otherwise, try the other inbuilt hash. */
175 if (tdb
->hash_fn
== tdb_old_hash
)
176 tdb
->hash_fn
= tdb_jenkins_hash
;
178 tdb
->hash_fn
= tdb_old_hash
;
179 return check_header_hash(tdb
, header
, false, m1
, m2
);
182 _PUBLIC_
struct tdb_context
*tdb_open_ex(const char *name
, int hash_size
, int tdb_flags
,
183 int open_flags
, mode_t mode
,
184 const struct tdb_logging_context
*log_ctx
,
185 tdb_hash_func hash_fn
)
187 int orig_errno
= errno
;
188 struct tdb_header header
;
189 struct tdb_context
*tdb
;
191 int rev
= 0, locked
= 0;
195 const char *hash_alg
;
196 uint32_t magic1
, magic2
;
201 if (!(tdb
= (struct tdb_context
*)calloc(1, sizeof *tdb
))) {
208 if (tdb_flags
& TDB_INTERNAL
) {
209 tdb_flags
|= TDB_INCOMPATIBLE_HASH
;
218 tdb
->flags
= tdb_flags
;
219 tdb
->open_flags
= open_flags
;
223 tdb
->log
.log_fn
= null_log_fn
;
224 tdb
->log
.log_private
= NULL
;
227 if (name
== NULL
&& (tdb_flags
& TDB_INTERNAL
)) {
228 name
= "__TDB_INTERNAL__";
232 tdb
->name
= discard_const_p(char, "__NULL__");
233 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: called with name == NULL\n"));
239 /* now make a copy of the name, as the caller memory might go away */
240 if (!(tdb
->name
= (char *)strdup(name
))) {
242 * set the name as the given string, so that tdb_name() will
243 * work in case of an error.
245 tdb
->name
= discard_const_p(char, name
);
246 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: can't strdup(%s)\n",
254 tdb
->hash_fn
= hash_fn
;
255 hash_alg
= "the user defined";
257 /* This controls what we use when creating a tdb. */
258 if (tdb
->flags
& TDB_INCOMPATIBLE_HASH
) {
259 tdb
->hash_fn
= tdb_jenkins_hash
;
261 tdb
->hash_fn
= tdb_old_hash
;
263 hash_alg
= "either default";
266 /* cache the page size */
267 tdb
->page_size
= getpagesize();
268 if (tdb
->page_size
<= 0) {
269 tdb
->page_size
= 0x2000;
272 tdb
->max_dead_records
= (tdb_flags
& TDB_VOLATILE
) ? 5 : 0;
274 if ((open_flags
& O_ACCMODE
) == O_WRONLY
) {
275 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: can't open tdb %s write-only\n",
282 hash_size
= DEFAULT_HASH_SIZE
;
283 if ((open_flags
& O_ACCMODE
) == O_RDONLY
) {
285 /* read only databases don't do locking or clear if first */
286 tdb
->flags
|= TDB_NOLOCK
;
287 tdb
->flags
&= ~TDB_CLEAR_IF_FIRST
;
290 if ((tdb
->flags
& TDB_ALLOW_NESTING
) &&
291 (tdb
->flags
& TDB_DISALLOW_NESTING
)) {
292 tdb
->ecode
= TDB_ERR_NESTING
;
293 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
294 "allow_nesting and disallow_nesting are not allowed together!"));
299 if (getenv("TDB_NO_FSYNC")) {
300 tdb
->flags
|= TDB_NOSYNC
;
304 * TDB_ALLOW_NESTING is the default behavior.
305 * Note: this may change in future versions!
307 if (!(tdb
->flags
& TDB_DISALLOW_NESTING
)) {
308 tdb
->flags
|= TDB_ALLOW_NESTING
;
311 /* internal databases don't mmap or lock, and start off cleared */
312 if (tdb
->flags
& TDB_INTERNAL
) {
313 tdb
->flags
|= (TDB_NOLOCK
| TDB_NOMMAP
);
314 tdb
->flags
&= ~TDB_CLEAR_IF_FIRST
;
315 if (tdb_new_database(tdb
, &header
, hash_size
) != 0) {
316 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: tdb_new_database failed!"));
319 tdb
->hash_size
= hash_size
;
323 if ((tdb
->fd
= open(name
, open_flags
, mode
)) == -1) {
324 TDB_LOG((tdb
, TDB_DEBUG_WARNING
, "tdb_open_ex: could not open file %s: %s\n",
325 name
, strerror(errno
)));
326 goto fail
; /* errno set by open(2) */
329 /* on exec, don't inherit the fd */
330 v
= fcntl(tdb
->fd
, F_GETFD
, 0);
331 fcntl(tdb
->fd
, F_SETFD
, v
| FD_CLOEXEC
);
333 /* ensure there is only one process initialising at once */
334 if (tdb_nest_lock(tdb
, OPEN_LOCK
, F_WRLCK
, TDB_LOCK_WAIT
) == -1) {
335 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: failed to get open lock on %s: %s\n",
336 name
, strerror(errno
)));
337 goto fail
; /* errno set by tdb_brlock */
340 /* we need to zero database if we are the only one with it open */
341 if ((tdb_flags
& TDB_CLEAR_IF_FIRST
) &&
343 (locked
= (tdb_nest_lock(tdb
, ACTIVE_LOCK
, F_WRLCK
, TDB_LOCK_NOWAIT
|TDB_LOCK_PROBE
) == 0))) {
344 ret
= tdb_brlock(tdb
, F_WRLCK
, FREELIST_TOP
, 0,
347 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
348 "tdb_brlock failed for %s: %s\n",
349 name
, strerror(errno
)));
352 ret
= tdb_new_database(tdb
, &header
, hash_size
);
354 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
355 "tdb_new_database failed for %s: %s\n",
356 name
, strerror(errno
)));
360 ret
= tdb_brunlock(tdb
, F_WRLCK
, FREELIST_TOP
, 0);
362 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
363 "tdb_unlockall failed for %s: %s\n",
364 name
, strerror(errno
)));
367 ret
= lseek(tdb
->fd
, 0, SEEK_SET
);
369 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
370 "lseek failed for %s: %s\n",
371 name
, strerror(errno
)));
377 if (read(tdb
->fd
, &header
, sizeof(header
)) != sizeof(header
)
378 || strcmp(header
.magic_food
, TDB_MAGIC_FOOD
) != 0) {
379 if (!(open_flags
& O_CREAT
) ||
380 tdb_new_database(tdb
, &header
, hash_size
) == -1) {
382 errno
= EIO
; /* ie bad format or something */
386 rev
= (tdb
->flags
& TDB_CONVERT
);
387 } else if (header
.version
!= TDB_VERSION
388 && !(rev
= (header
.version
==TDB_BYTEREV(TDB_VERSION
)))) {
393 vp
= (unsigned char *)&header
.version
;
394 vertest
= (((uint32_t)vp
[0]) << 24) | (((uint32_t)vp
[1]) << 16) |
395 (((uint32_t)vp
[2]) << 8) | (uint32_t)vp
[3];
396 tdb
->flags
|= (vertest
==TDB_VERSION
) ? TDB_BIGENDIAN
: 0;
398 tdb
->flags
&= ~TDB_CONVERT
;
400 tdb
->flags
|= TDB_CONVERT
;
401 tdb_convert(&header
, sizeof(header
));
405 * We only use st.st_dev and st.st_ino from the raw fstat()
406 * call, everything else needs to use tdb_fstat() in order
407 * to skip tdb->hdr_ofs!
409 if (fstat(tdb
->fd
, &st
) == -1) {
412 tdb
->device
= st
.st_dev
;
413 tdb
->inode
= st
.st_ino
;
416 if (header
.rwlocks
!= 0 &&
417 header
.rwlocks
!= TDB_FEATURE_FLAG_MAGIC
&&
418 header
.rwlocks
!= TDB_HASH_RWLOCK_MAGIC
) {
419 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: spinlocks no longer supported\n"));
423 tdb
->hash_size
= header
.hash_size
;
425 if (header
.rwlocks
== TDB_FEATURE_FLAG_MAGIC
) {
426 tdb
->feature_flags
= header
.feature_flags
;
429 if (tdb
->feature_flags
& ~TDB_SUPPORTED_FEATURE_FLAGS
) {
430 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: unsupported "
431 "features in tdb %s: 0x%08x (supported: 0x%08x)\n",
432 name
, (unsigned)tdb
->feature_flags
,
433 (unsigned)TDB_SUPPORTED_FEATURE_FLAGS
));
438 if ((header
.magic1_hash
== 0) && (header
.magic2_hash
== 0)) {
439 /* older TDB without magic hash references */
440 tdb
->hash_fn
= tdb_old_hash
;
441 } else if (!check_header_hash(tdb
, &header
, !hash_fn
,
443 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_open_ex: "
444 "%s was not created with %s hash function we are using\n"
445 "magic1_hash[0x%08X %s 0x%08X] "
446 "magic2_hash[0x%08X %s 0x%08X]\n",
449 (header
.magic1_hash
== magic1
) ? "==" : "!=",
452 (header
.magic2_hash
== magic2
) ? "==" : "!=",
458 /* Is it already in the open list? If so, fail. */
459 if (tdb_already_open(tdb
->device
, tdb
->inode
)) {
460 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: "
461 "%s (%d,%d) is already open in this process\n",
462 name
, (int)tdb
->device
, (int)tdb
->inode
));
468 * We had tdb_mmap(tdb) here before,
469 * but we need to use tdb_fstat(),
470 * which is triggered from tdb_oob() before calling tdb_mmap().
471 * As this skips tdb->hdr_ofs.
474 ret
= tdb
->methods
->tdb_oob(tdb
, 0, 1, 0);
481 if (tdb_nest_unlock(tdb
, ACTIVE_LOCK
, F_WRLCK
, false) == -1) {
482 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: "
483 "failed to release ACTIVE_LOCK on %s: %s\n",
484 name
, strerror(errno
)));
490 /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
491 we didn't get the initial exclusive lock as we need to let all other
492 users know we're using it. */
494 if (tdb_flags
& TDB_CLEAR_IF_FIRST
) {
495 /* leave this lock in place to indicate it's in use */
496 if (tdb_nest_lock(tdb
, ACTIVE_LOCK
, F_RDLCK
, TDB_LOCK_WAIT
) == -1) {
501 /* if needed, run recovery */
502 if (tdb_transaction_recover(tdb
) == -1) {
508 char tracefile
[strlen(name
) + 32];
510 snprintf(tracefile
, sizeof(tracefile
),
511 "%s.trace.%li", name
, (long)getpid());
512 tdb
->tracefd
= open(tracefile
, O_WRONLY
|O_CREAT
|O_EXCL
, 0600);
513 if (tdb
->tracefd
>= 0) {
514 tdb_enable_seqnum(tdb
);
515 tdb_trace_open(tdb
, "tdb_open", hash_size
, tdb_flags
,
518 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: failed to open trace file %s!\n", tracefile
));
523 /* Internal (memory-only) databases skip all the code above to
524 * do with disk files, and resume here by releasing their
525 * open lock and hooking into the active list. */
526 if (tdb_nest_unlock(tdb
, OPEN_LOCK
, F_WRLCK
, false) == -1) {
535 { int save_errno
= errno
;
544 if (tdb
->flags
& TDB_INTERNAL
)
545 SAFE_FREE(tdb
->map_ptr
);
550 if (close(tdb
->fd
) != 0)
551 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_open_ex: failed to close tdb->fd on error!\n"));
552 SAFE_FREE(tdb
->lockrecs
);
553 SAFE_FREE(tdb
->name
);
561 * Set the maximum number of dead records per hash chain
564 _PUBLIC_
void tdb_set_max_dead(struct tdb_context
*tdb
, int max_dead
)
566 tdb
->max_dead_records
= max_dead
;
572 * @returns -1 for error; 0 for success.
574 _PUBLIC_
int tdb_close(struct tdb_context
*tdb
)
576 struct tdb_context
**i
;
579 if (tdb
->transaction
) {
580 tdb_transaction_cancel(tdb
);
582 tdb_trace(tdb
, "tdb_close");
585 if (tdb
->flags
& TDB_INTERNAL
)
586 SAFE_FREE(tdb
->map_ptr
);
590 SAFE_FREE(tdb
->name
);
592 ret
= close(tdb
->fd
);
595 SAFE_FREE(tdb
->lockrecs
);
597 /* Remove from contexts list */
598 for (i
= &tdbs
; *i
; i
= &(*i
)->next
) {
608 memset(tdb
, 0, sizeof(*tdb
));
614 /* register a loging function */
615 _PUBLIC_
void tdb_set_logging_function(struct tdb_context
*tdb
,
616 const struct tdb_logging_context
*log_ctx
)
621 _PUBLIC_
void *tdb_get_logging_private(struct tdb_context
*tdb
)
623 return tdb
->log
.log_private
;
626 static int tdb_reopen_internal(struct tdb_context
*tdb
, bool active_lock
)
628 #if !defined(LIBREPLACE_PREAD_NOT_REPLACED) || \
629 !defined(LIBREPLACE_PWRITE_NOT_REPLACED)
633 if (tdb
->flags
& TDB_INTERNAL
) {
634 return 0; /* Nothing to do. */
637 if (tdb_have_extra_locks(tdb
)) {
638 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_reopen: reopen not allowed with locks held\n"));
642 if (tdb
->transaction
!= 0) {
643 TDB_LOG((tdb
, TDB_DEBUG_ERROR
, "tdb_reopen: reopen not allowed inside a transaction\n"));
647 /* If we have real pread & pwrite, we can skip reopen. */
648 #if !defined(LIBREPLACE_PREAD_NOT_REPLACED) || \
649 !defined(LIBREPLACE_PWRITE_NOT_REPLACED)
650 if (tdb_munmap(tdb
) != 0) {
651 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: munmap failed (%s)\n", strerror(errno
)));
654 if (close(tdb
->fd
) != 0)
655 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
656 tdb
->fd
= open(tdb
->name
, tdb
->open_flags
& ~(O_CREAT
|O_TRUNC
), 0);
658 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: open failed (%s)\n", strerror(errno
)));
662 * We only use st.st_dev and st.st_ino from the raw fstat()
663 * call, everything else needs to use tdb_fstat() in order
664 * to skip tdb->hdr_ofs!
666 if (fstat(tdb
->fd
, &st
) != 0) {
667 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: fstat failed (%s)\n", strerror(errno
)));
670 if (st
.st_ino
!= tdb
->inode
|| st
.st_dev
!= tdb
->device
) {
671 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: file dev/inode has changed!\n"));
677 * We had tdb_mmap(tdb) here before,
678 * but we need to use tdb_fstat(),
679 * which is triggered from tdb_oob() before calling tdb_mmap().
680 * As this skips tdb->hdr_ofs.
683 if (tdb
->methods
->tdb_oob(tdb
, 0, 1, 0) != 0) {
686 #endif /* fake pread or pwrite */
688 /* We may still think we hold the active lock. */
689 tdb
->num_lockrecs
= 0;
690 SAFE_FREE(tdb
->lockrecs
);
691 tdb
->lockrecs_array_length
= 0;
693 if (active_lock
&& tdb_nest_lock(tdb
, ACTIVE_LOCK
, F_RDLCK
, TDB_LOCK_WAIT
) == -1) {
694 TDB_LOG((tdb
, TDB_DEBUG_FATAL
, "tdb_reopen: failed to obtain active lock\n"));
705 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
706 seek pointer from our parent and to re-establish locks */
707 _PUBLIC_
int tdb_reopen(struct tdb_context
*tdb
)
709 return tdb_reopen_internal(tdb
, tdb
->flags
& TDB_CLEAR_IF_FIRST
);
712 /* reopen all tdb's */
713 _PUBLIC_
int tdb_reopen_all(int parent_longlived
)
715 struct tdb_context
*tdb
;
717 for (tdb
=tdbs
; tdb
; tdb
= tdb
->next
) {
718 bool active_lock
= (tdb
->flags
& TDB_CLEAR_IF_FIRST
);
721 * If the parent is longlived (ie. a
722 * parent daemon architecture), we know
723 * it will keep it's active lock on a
724 * tdb opened with CLEAR_IF_FIRST. Thus
725 * for child processes we don't have to
726 * add an active lock. This is essential
727 * to improve performance on systems that
728 * keep POSIX locks as a non-scalable data
729 * structure in the kernel.
731 if (parent_longlived
) {
732 /* Ensure no clear-if-first. */
736 if (tdb_reopen_internal(tdb
, active_lock
) != 0)