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 2 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, write to the Free Software
26
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29
#include "tdb_private.h"
31
/* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
32
static struct tdb_context *tdbs = NULL;
35
/* This is based on the hash algorithm from gdbm */
36
static unsigned int default_tdb_hash(TDB_DATA *key)
38
u32 value; /* Used to compute the hash value. */
39
u32 i; /* Used to cycle through random values. */
41
/* Set the initial value from the key size. */
42
for (value = 0x238F13AF * key->dsize, i=0; i < key->dsize; i++)
43
value = (value + (key->dptr[i] << (i*5 % 24)));
45
return (1103515243 * value + 12345);
49
/* initialise a new database with a specified hash size */
50
static int tdb_new_database(struct tdb_context *tdb, int hash_size)
52
struct tdb_header *newdb;
55
/* We make it up in memory, then write it out if not internal */
56
size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);
57
if (!(newdb = calloc(size, 1)))
58
return TDB_ERRCODE(TDB_ERR_OOM, -1);
60
/* Fill in the header */
61
newdb->version = TDB_VERSION;
62
newdb->hash_size = hash_size;
63
if (tdb->flags & TDB_INTERNAL) {
65
tdb->map_ptr = (char *)newdb;
66
memcpy(&tdb->header, newdb, sizeof(tdb->header));
67
/* Convert the `ondisk' version if asked. */
71
if (lseek(tdb->fd, 0, SEEK_SET) == -1)
74
if (ftruncate(tdb->fd, 0) == -1)
77
/* This creates an endian-converted header, as if read from disk */
79
memcpy(&tdb->header, newdb, sizeof(tdb->header));
80
/* Don't endian-convert the magic food! */
81
memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
82
if (write(tdb->fd, newdb, size) != size) {
95
static int tdb_already_open(dev_t device,
98
struct tdb_context *i;
100
for (i = tdbs; i; i = i->next) {
101
if (i->device == device && i->inode == ino) {
109
/* open the database, creating it if necessary
111
The open_flags and mode are passed straight to the open call on the
112
database file. A flags value of O_WRONLY is invalid. The hash size
113
is advisory, use zero for a default value.
115
Return is NULL on error, in which case errno is also set. Don't
116
try to call tdb_error or tdb_errname, just do strerror(errno).
118
@param name may be NULL for internal databases. */
119
struct tdb_context *tdb_open(const char *name, int hash_size, int tdb_flags,
120
int open_flags, mode_t mode)
122
return tdb_open_ex(name, hash_size, tdb_flags, open_flags, mode, NULL, NULL);
125
/* a default logging function */
126
static void null_log_fn(struct tdb_context *tdb, int level, const char *fmt, ...)
131
struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
132
int open_flags, mode_t mode,
134
tdb_hash_func hash_fn)
136
struct tdb_context *tdb;
138
int rev = 0, locked = 0;
142
if (!(tdb = calloc(1, sizeof *tdb))) {
151
tdb->flags = tdb_flags;
152
tdb->open_flags = open_flags;
153
tdb->log_fn = log_fn?log_fn:null_log_fn;
154
tdb->hash_fn = hash_fn ? hash_fn : default_tdb_hash;
156
/* cache the page size */
157
tdb->page_size = getpagesize();
158
if (tdb->page_size <= 0) {
159
tdb->page_size = 0x2000;
162
if ((open_flags & O_ACCMODE) == O_WRONLY) {
163
TDB_LOG((tdb, 0, "tdb_open_ex: can't open tdb %s write-only\n",
170
hash_size = DEFAULT_HASH_SIZE;
171
if ((open_flags & O_ACCMODE) == O_RDONLY) {
173
/* read only databases don't do locking or clear if first */
174
tdb->flags |= TDB_NOLOCK;
175
tdb->flags &= ~TDB_CLEAR_IF_FIRST;
178
/* internal databases don't mmap or lock, and start off cleared */
179
if (tdb->flags & TDB_INTERNAL) {
180
tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
181
tdb->flags &= ~TDB_CLEAR_IF_FIRST;
182
if (tdb_new_database(tdb, hash_size) != 0) {
183
TDB_LOG((tdb, 0, "tdb_open_ex: tdb_new_database failed!"));
189
if ((tdb->fd = open(name, open_flags, mode)) == -1) {
190
TDB_LOG((tdb, 5, "tdb_open_ex: could not open file %s: %s\n",
191
name, strerror(errno)));
192
goto fail; /* errno set by open(2) */
195
/* ensure there is only one process initialising at once */
196
if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_WRLCK, F_SETLKW, 0) == -1) {
197
TDB_LOG((tdb, 0, "tdb_open_ex: failed to get global lock on %s: %s\n",
198
name, strerror(errno)));
199
goto fail; /* errno set by tdb_brlock */
202
/* we need to zero database if we are the only one with it open */
203
if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
204
(locked = (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_WRLCK, F_SETLK, 0) == 0))) {
205
open_flags |= O_CREAT;
206
if (ftruncate(tdb->fd, 0) == -1) {
207
TDB_LOG((tdb, 0, "tdb_open_ex: "
208
"failed to truncate %s: %s\n",
209
name, strerror(errno)));
210
goto fail; /* errno set by ftruncate */
214
if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
215
|| strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0
216
|| (tdb->header.version != TDB_VERSION
217
&& !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION))))) {
218
/* its not a valid database - possibly initialise it */
219
if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
220
errno = EIO; /* ie bad format or something */
223
rev = (tdb->flags & TDB_CONVERT);
225
vp = (unsigned char *)&tdb->header.version;
226
vertest = (((u32)vp[0]) << 24) | (((u32)vp[1]) << 16) |
227
(((u32)vp[2]) << 8) | (u32)vp[3];
228
tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
230
tdb->flags &= ~TDB_CONVERT;
232
tdb->flags |= TDB_CONVERT;
233
tdb_convert(&tdb->header, sizeof(tdb->header));
235
if (fstat(tdb->fd, &st) == -1)
238
if (tdb->header.rwlocks != 0) {
239
TDB_LOG((tdb, 5, "tdb_open_ex: spinlocks no longer supported\n"));
243
/* Is it already in the open list? If so, fail. */
244
if (tdb_already_open(st.st_dev, st.st_ino)) {
245
TDB_LOG((tdb, 2, "tdb_open_ex: "
246
"%s (%d,%d) is already open in this process\n",
247
name, (int)st.st_dev, (int)st.st_ino));
252
if (!(tdb->name = (char *)strdup(name))) {
257
tdb->map_size = st.st_size;
258
tdb->device = st.st_dev;
259
tdb->inode = st.st_ino;
260
tdb->locked = calloc(tdb->header.hash_size+1, sizeof(tdb->locked[0]));
262
TDB_LOG((tdb, 2, "tdb_open_ex: "
263
"failed to allocate lock structure for %s\n",
270
if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_UNLCK, F_SETLK, 0) == -1) {
271
TDB_LOG((tdb, 0, "tdb_open_ex: "
272
"failed to take ACTIVE_LOCK on %s: %s\n",
273
name, strerror(errno)));
279
/* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
280
we didn't get the initial exclusive lock as we need to let all other
281
users know we're using it. */
283
if (tdb_flags & TDB_CLEAR_IF_FIRST) {
284
/* leave this lock in place to indicate it's in use */
285
if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0) == -1)
289
/* if needed, run recovery */
290
if (tdb_transaction_recover(tdb) == -1) {
295
/* Internal (memory-only) databases skip all the code above to
296
* do with disk files, and resume here by releasing their
297
* global lock and hooking into the active list. */
298
if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_UNLCK, F_SETLKW, 0) == -1)
305
{ int save_errno = errno;
311
if (tdb->flags & TDB_INTERNAL)
312
SAFE_FREE(tdb->map_ptr);
316
SAFE_FREE(tdb->name);
318
if (close(tdb->fd) != 0)
319
TDB_LOG((tdb, 5, "tdb_open_ex: failed to close tdb->fd on error!\n"));
320
SAFE_FREE(tdb->locked);
330
* @returns -1 for error; 0 for success.
332
int tdb_close(struct tdb_context *tdb)
334
struct tdb_context **i;
337
if (tdb->transaction) {
338
tdb_transaction_cancel(tdb);
342
if (tdb->flags & TDB_INTERNAL)
343
SAFE_FREE(tdb->map_ptr);
347
SAFE_FREE(tdb->name);
349
ret = close(tdb->fd);
350
SAFE_FREE(tdb->locked);
352
/* Remove from contexts list */
353
for (i = &tdbs; *i; i = &(*i)->next) {
360
memset(tdb, 0, sizeof(*tdb));
366
/* register a loging function */
367
void tdb_logging_function(struct tdb_context *tdb, void (*fn)(struct tdb_context *, int , const char *, ...))
369
tdb->log_fn = fn?fn:null_log_fn;
373
/* reopen a tdb - this can be used after a fork to ensure that we have an independent
374
seek pointer from our parent and to re-establish locks */
375
int tdb_reopen(struct tdb_context *tdb)
379
if (tdb->flags & TDB_INTERNAL) {
380
return 0; /* Nothing to do. */
383
if (tdb->num_locks != 0) {
384
TDB_LOG((tdb, 0, "tdb_reopen: reopen not allowed with locks held\n"));
388
if (tdb->transaction != 0) {
389
TDB_LOG((tdb, 0, "tdb_reopen: reopen not allowed inside a transaction\n"));
393
if (tdb_munmap(tdb) != 0) {
394
TDB_LOG((tdb, 0, "tdb_reopen: munmap failed (%s)\n", strerror(errno)));
397
if (close(tdb->fd) != 0)
398
TDB_LOG((tdb, 0, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
399
tdb->fd = open(tdb->name, tdb->open_flags & ~(O_CREAT|O_TRUNC), 0);
401
TDB_LOG((tdb, 0, "tdb_reopen: open failed (%s)\n", strerror(errno)));
404
if ((tdb->flags & TDB_CLEAR_IF_FIRST) &&
405
(tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0) == -1)) {
406
TDB_LOG((tdb, 0, "tdb_reopen: failed to obtain active lock\n"));
409
if (fstat(tdb->fd, &st) != 0) {
410
TDB_LOG((tdb, 0, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
413
if (st.st_ino != tdb->inode || st.st_dev != tdb->device) {
414
TDB_LOG((tdb, 0, "tdb_reopen: file dev/inode has changed!\n"));
426
/* reopen all tdb's */
427
int tdb_reopen_all(int parent_longlived)
429
struct tdb_context *tdb;
431
for (tdb=tdbs; tdb; tdb = tdb->next) {
433
* If the parent is longlived (ie. a
434
* parent daemon architecture), we know
435
* it will keep it's active lock on a
436
* tdb opened with CLEAR_IF_FIRST. Thus
437
* for child processes we don't have to
438
* add an active lock. This is essential
439
* to improve performance on systems that
440
* keep POSIX locks as a non-scalable data
441
* structure in the kernel.
443
if (parent_longlived) {
444
/* Ensure no clear-if-first. */
445
tdb->flags &= ~TDB_CLEAR_IF_FIRST;
448
if (tdb_reopen(tdb) != 0)
added
removed
source/tdb/open.c
