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;
34 /* This is based on the hash algorithm from gdbm */
35 static unsigned int default_tdb_hash(TDB_DATA *key)
37 uint32_t value; /* Used to compute the hash value. */
38 uint32_t i; /* Used to cycle through random values. */
40 /* Set the initial value from the key size. */
41 for (value = 0x238F13AF * key->dsize, i=0; i < key->dsize; i++)
42 value = (value + (key->dptr[i] << (i*5 % 24)));
44 return (1103515243 * value + 12345);
48 /* initialise a new database with a specified hash size */
49 static int tdb_new_database(struct tdb_context *tdb, int hash_size)
51 struct tdb_header *newdb;
56 /* We make it up in memory, then write it out if not internal */
57 size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);
58 if (!(newdb = (struct tdb_header *)calloc(size, 1))) {
59 tdb->ecode = TDB_ERR_OOM;
63 /* Fill in the header */
64 newdb->version = TDB_VERSION;
65 newdb->hash_size = hash_size;
66 if (tdb->flags & TDB_INTERNAL) {
68 tdb->map_ptr = (char *)newdb;
69 memcpy(&tdb->header, newdb, sizeof(tdb->header));
70 /* Convert the `ondisk' version if asked. */
74 if (lseek(tdb->fd, 0, SEEK_SET) == -1)
77 if (ftruncate(tdb->fd, 0) == -1)
80 /* This creates an endian-converted header, as if read from disk */
82 memcpy(&tdb->header, newdb, sizeof(tdb->header));
83 /* Don't endian-convert the magic food! */
84 memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
85 /* we still have "ret == -1" here */
86 written = write(tdb->fd, newdb, size);
87 if (written == size) {
89 } else if (written != -1) {
90 /* call write once again, this usually should return -1 and
91 * set errno appropriately */
93 written = write(tdb->fd, newdb+written, size);
94 if (written == size) {
96 } else if (written >= 0) {
97 /* a second incomplete write - we give up.
98 * guessing the errno... */
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 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, ...)
147 struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
148 int open_flags, mode_t mode,
149 const struct tdb_logging_context *log_ctx,
150 tdb_hash_func hash_fn)
152 struct tdb_context *tdb;
154 int rev = 0, locked = 0;
159 if (!(tdb = (struct tdb_context *)calloc(1, sizeof *tdb))) {
172 tdb->flags = tdb_flags;
173 tdb->open_flags = open_flags;
177 tdb->log.log_fn = null_log_fn;
178 tdb->log.log_private = NULL;
180 tdb->hash_fn = hash_fn ? hash_fn : default_tdb_hash;
182 /* cache the page size */
183 tdb->page_size = getpagesize();
184 if (tdb->page_size <= 0) {
185 tdb->page_size = 0x2000;
188 tdb->max_dead_records = (tdb_flags & TDB_VOLATILE) ? 5 : 0;
190 if ((open_flags & O_ACCMODE) == O_WRONLY) {
191 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: can't open tdb %s write-only\n",
198 hash_size = DEFAULT_HASH_SIZE;
199 if ((open_flags & O_ACCMODE) == O_RDONLY) {
201 /* read only databases don't do locking or clear if first */
202 tdb->flags |= TDB_NOLOCK;
203 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
206 if ((tdb->flags & TDB_ALLOW_NESTING) &&
207 (tdb->flags & TDB_DISALLOW_NESTING)) {
208 tdb->ecode = TDB_ERR_NESTING;
209 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
210 "allow_nesting and disallow_nesting are not allowed together!"));
216 * TDB_ALLOW_NESTING is the default behavior.
217 * Note: this may change in future versions!
219 if (!(tdb->flags & TDB_DISALLOW_NESTING)) {
220 tdb->flags |= TDB_ALLOW_NESTING;
223 /* internal databases don't mmap or lock, and start off cleared */
224 if (tdb->flags & TDB_INTERNAL) {
225 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
226 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
227 if (tdb_new_database(tdb, hash_size) != 0) {
228 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: tdb_new_database failed!"));
234 if ((tdb->fd = open(name, open_flags, mode)) == -1) {
235 TDB_LOG((tdb, TDB_DEBUG_WARNING, "tdb_open_ex: could not open file %s: %s\n",
236 name, strerror(errno)));
237 goto fail; /* errno set by open(2) */
240 /* on exec, don't inherit the fd */
241 v = fcntl(tdb->fd, F_GETFD, 0);
242 fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
244 /* ensure there is only one process initialising at once */
245 if (tdb->methods->brlock(tdb, F_WRLCK, GLOBAL_LOCK, 1, TDB_LOCK_WAIT) == -1) {
246 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to get global lock on %s: %s\n",
247 name, strerror(errno)));
248 goto fail; /* errno set by tdb_brlock */
251 /* we need to zero database if we are the only one with it open */
252 if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
254 (locked = (tdb->methods->brlock(tdb, F_WRLCK, ACTIVE_LOCK, 1, TDB_LOCK_NOWAIT|TDB_LOCK_PROBE) == 0))) {
255 open_flags |= O_CREAT;
256 if (ftruncate(tdb->fd, 0) == -1) {
257 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
258 "failed to truncate %s: %s\n",
259 name, strerror(errno)));
260 goto fail; /* errno set by ftruncate */
265 if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
266 || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0) {
267 if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
269 errno = EIO; /* ie bad format or something */
273 rev = (tdb->flags & TDB_CONVERT);
274 } else if (tdb->header.version != TDB_VERSION
275 && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION)))) {
280 vp = (unsigned char *)&tdb->header.version;
281 vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |
282 (((uint32_t)vp[2]) << 8) | (uint32_t)vp[3];
283 tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
285 tdb->flags &= ~TDB_CONVERT;
287 tdb->flags |= TDB_CONVERT;
288 tdb_convert(&tdb->header, sizeof(tdb->header));
290 if (fstat(tdb->fd, &st) == -1)
293 if (tdb->header.rwlocks != 0) {
294 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: spinlocks no longer supported\n"));
298 /* Is it already in the open list? If so, fail. */
299 if (tdb_already_open(st.st_dev, st.st_ino)) {
300 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
301 "%s (%d,%d) is already open in this process\n",
302 name, (int)st.st_dev, (int)st.st_ino));
307 if (!(tdb->name = (char *)strdup(name))) {
312 tdb->map_size = st.st_size;
313 tdb->device = st.st_dev;
314 tdb->inode = st.st_ino;
317 if (tdb->methods->brunlock(tdb, F_WRLCK, ACTIVE_LOCK, 1) == -1) {
318 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
319 "failed to take ACTIVE_LOCK on %s: %s\n",
320 name, strerror(errno)));
326 /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
327 we didn't get the initial exclusive lock as we need to let all other
328 users know we're using it. */
330 if (tdb_flags & TDB_CLEAR_IF_FIRST) {
331 /* leave this lock in place to indicate it's in use */
332 if (tdb->methods->brlock(tdb, F_RDLCK, ACTIVE_LOCK, 1, TDB_LOCK_WAIT) == -1)
336 /* if needed, run recovery */
337 if (tdb_transaction_recover(tdb) == -1) {
343 char tracefile[strlen(name) + 32];
345 sprintf(tracefile, "%s.trace.%u", name, getpid());
346 tdb->tracefd = open(tracefile, O_WRONLY|O_CREAT|O_EXCL, 0600);
347 if (tdb->tracefd >= 0) {
348 tdb_enable_seqnum(tdb);
349 tdb_trace_open(tdb, "tdb_open", hash_size, tdb_flags,
352 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to open trace file %s!\n", tracefile));
357 /* Internal (memory-only) databases skip all the code above to
358 * do with disk files, and resume here by releasing their
359 * global lock and hooking into the active list. */
360 if (tdb->methods->brunlock(tdb, F_WRLCK, GLOBAL_LOCK, 1) == -1)
367 { int save_errno = errno;
376 if (tdb->flags & TDB_INTERNAL)
377 SAFE_FREE(tdb->map_ptr);
381 SAFE_FREE(tdb->name);
383 if (close(tdb->fd) != 0)
384 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to close tdb->fd on error!\n"));
392 * Set the maximum number of dead records per hash chain
395 void tdb_set_max_dead(struct tdb_context *tdb, int max_dead)
397 tdb->max_dead_records = max_dead;
403 * @returns -1 for error; 0 for success.
405 int tdb_close(struct tdb_context *tdb)
407 struct tdb_context **i;
410 if (tdb->transaction) {
411 tdb_transaction_cancel(tdb);
413 tdb_trace(tdb, "tdb_close");
416 if (tdb->flags & TDB_INTERNAL)
417 SAFE_FREE(tdb->map_ptr);
421 SAFE_FREE(tdb->name);
423 ret = close(tdb->fd);
426 SAFE_FREE(tdb->lockrecs);
428 /* Remove from contexts list */
429 for (i = &tdbs; *i; i = &(*i)->next) {
439 memset(tdb, 0, sizeof(*tdb));
445 /* register a loging function */
446 void tdb_set_logging_function(struct tdb_context *tdb,
447 const struct tdb_logging_context *log_ctx)
452 void *tdb_get_logging_private(struct tdb_context *tdb)
454 return tdb->log.log_private;
457 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
458 seek pointer from our parent and to re-establish locks */
459 int tdb_reopen(struct tdb_context *tdb)
463 if (tdb->flags & TDB_INTERNAL) {
464 return 0; /* Nothing to do. */
467 if (tdb->num_locks != 0 || tdb->global_lock.count) {
468 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed with locks held\n"));
472 if (tdb->transaction != 0) {
473 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed inside a transaction\n"));
477 if (tdb_munmap(tdb) != 0) {
478 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: munmap failed (%s)\n", strerror(errno)));
481 if (close(tdb->fd) != 0)
482 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
483 tdb->fd = open(tdb->name, tdb->open_flags & ~(O_CREAT|O_TRUNC), 0);
485 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: open failed (%s)\n", strerror(errno)));
488 if ((tdb->flags & TDB_CLEAR_IF_FIRST) &&
489 (tdb->methods->brlock(tdb, F_RDLCK, ACTIVE_LOCK, 1, TDB_LOCK_WAIT) == -1)) {
490 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: failed to obtain active lock\n"));
493 if (fstat(tdb->fd, &st) != 0) {
494 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
497 if (st.st_ino != tdb->inode || st.st_dev != tdb->device) {
498 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: file dev/inode has changed!\n"));
510 /* reopen all tdb's */
511 int tdb_reopen_all(int parent_longlived)
513 struct tdb_context *tdb;
515 for (tdb=tdbs; tdb; tdb = tdb->next) {
517 * If the parent is longlived (ie. a
518 * parent daemon architecture), we know
519 * it will keep it's active lock on a
520 * tdb opened with CLEAR_IF_FIRST. Thus
521 * for child processes we don't have to
522 * add an active lock. This is essential
523 * to improve performance on systems that
524 * keep POSIX locks as a non-scalable data
525 * structure in the kernel.
527 if (parent_longlived) {
528 /* Ensure no clear-if-first. */
529 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
532 if (tdb_reopen(tdb) != 0)