r23161: Add TDB_VOLATILE as open_flag to activate the per-hashchain dead record
[sfrench/samba-autobuild/.git] / source / lib / tdb / common / open.c
1  /* 
2    Unix SMB/CIFS implementation.
3
4    trivial database library
5
6    Copyright (C) Andrew Tridgell              1999-2005
7    Copyright (C) Paul `Rusty' Russell              2000
8    Copyright (C) Jeremy Allison                    2000-2003
9    
10      ** NOTE! The following LGPL license applies to the tdb
11      ** library. This does NOT imply that all of Samba is released
12      ** under the LGPL
13    
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.
18
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.
23
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
27 */
28
29 #include "tdb_private.h"
30
31 /* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
32 static struct tdb_context *tdbs = NULL;
33
34
35 /* This is based on the hash algorithm from gdbm */
36 static unsigned int default_tdb_hash(TDB_DATA *key)
37 {
38         u32 value;      /* Used to compute the hash value.  */
39         u32   i;        /* Used to cycle through random values. */
40
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)));
44
45         return (1103515243 * value + 12345);  
46 }
47
48
49 /* initialise a new database with a specified hash size */
50 static int tdb_new_database(struct tdb_context *tdb, int hash_size)
51 {
52         struct tdb_header *newdb;
53         int size, ret = -1;
54
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 = (struct tdb_header *)calloc(size, 1)))
58                 return TDB_ERRCODE(TDB_ERR_OOM, -1);
59
60         /* Fill in the header */
61         newdb->version = TDB_VERSION;
62         newdb->hash_size = hash_size;
63         if (tdb->flags & TDB_INTERNAL) {
64                 tdb->map_size = size;
65                 tdb->map_ptr = (char *)newdb;
66                 memcpy(&tdb->header, newdb, sizeof(tdb->header));
67                 /* Convert the `ondisk' version if asked. */
68                 CONVERT(*newdb);
69                 return 0;
70         }
71         if (lseek(tdb->fd, 0, SEEK_SET) == -1)
72                 goto fail;
73
74         if (ftruncate(tdb->fd, 0) == -1)
75                 goto fail;
76
77         /* This creates an endian-converted header, as if read from disk */
78         CONVERT(*newdb);
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) {
83                 ret = -1;
84         } else {
85                 ret = 0;
86         }
87
88   fail:
89         SAFE_FREE(newdb);
90         return ret;
91 }
92
93
94
95 static int tdb_already_open(dev_t device,
96                             ino_t ino)
97 {
98         struct tdb_context *i;
99         
100         for (i = tdbs; i; i = i->next) {
101                 if (i->device == device && i->inode == ino) {
102                         return 1;
103                 }
104         }
105
106         return 0;
107 }
108
109 /* open the database, creating it if necessary 
110
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.
114
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).
117
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)
121 {
122         return tdb_open_ex(name, hash_size, tdb_flags, open_flags, mode, NULL, NULL);
123 }
124
125 /* a default logging function */
126 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
127 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...)
128 {
129 }
130
131
132 struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
133                                 int open_flags, mode_t mode,
134                                 const struct tdb_logging_context *log_ctx,
135                                 tdb_hash_func hash_fn)
136 {
137         struct tdb_context *tdb;
138         struct stat st;
139         int rev = 0, locked = 0;
140         unsigned char *vp;
141         u32 vertest;
142
143         if (!(tdb = (struct tdb_context *)calloc(1, sizeof *tdb))) {
144                 /* Can't log this */
145                 errno = ENOMEM;
146                 goto fail;
147         }
148         tdb_io_init(tdb);
149         tdb->fd = -1;
150         tdb->name = NULL;
151         tdb->map_ptr = NULL;
152         tdb->flags = tdb_flags;
153         tdb->open_flags = open_flags;
154         if (log_ctx) {
155                 tdb->log = *log_ctx;
156         } else {
157                 tdb->log.log_fn = null_log_fn;
158                 tdb->log.log_private = NULL;
159         }
160         tdb->hash_fn = hash_fn ? hash_fn : default_tdb_hash;
161
162         /* cache the page size */
163         tdb->page_size = getpagesize();
164         if (tdb->page_size <= 0) {
165                 tdb->page_size = 0x2000;
166         }
167
168         if (open_flags & TDB_VOLATILE) {
169                 tdb->max_dead_records = 5;
170         }
171
172         if ((open_flags & O_ACCMODE) == O_WRONLY) {
173                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: can't open tdb %s write-only\n",
174                          name));
175                 errno = EINVAL;
176                 goto fail;
177         }
178         
179         if (hash_size == 0)
180                 hash_size = DEFAULT_HASH_SIZE;
181         if ((open_flags & O_ACCMODE) == O_RDONLY) {
182                 tdb->read_only = 1;
183                 /* read only databases don't do locking or clear if first */
184                 tdb->flags |= TDB_NOLOCK;
185                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
186         }
187
188         /* internal databases don't mmap or lock, and start off cleared */
189         if (tdb->flags & TDB_INTERNAL) {
190                 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
191                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
192                 if (tdb_new_database(tdb, hash_size) != 0) {
193                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: tdb_new_database failed!"));
194                         goto fail;
195                 }
196                 goto internal;
197         }
198
199         if ((tdb->fd = open(name, open_flags, mode)) == -1) {
200                 TDB_LOG((tdb, TDB_DEBUG_WARNING, "tdb_open_ex: could not open file %s: %s\n",
201                          name, strerror(errno)));
202                 goto fail;      /* errno set by open(2) */
203         }
204
205         /* ensure there is only one process initialising at once */
206         if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_WRLCK, F_SETLKW, 0, 1) == -1) {
207                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to get global lock on %s: %s\n",
208                          name, strerror(errno)));
209                 goto fail;      /* errno set by tdb_brlock */
210         }
211
212         /* we need to zero database if we are the only one with it open */
213         if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
214             (locked = (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_WRLCK, F_SETLK, 0, 1) == 0))) {
215                 open_flags |= O_CREAT;
216                 if (ftruncate(tdb->fd, 0) == -1) {
217                         TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
218                                  "failed to truncate %s: %s\n",
219                                  name, strerror(errno)));
220                         goto fail; /* errno set by ftruncate */
221                 }
222         }
223
224         if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
225             || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0
226             || (tdb->header.version != TDB_VERSION
227                 && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION))))) {
228                 /* its not a valid database - possibly initialise it */
229                 if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
230                         errno = EIO; /* ie bad format or something */
231                         goto fail;
232                 }
233                 rev = (tdb->flags & TDB_CONVERT);
234         }
235         vp = (unsigned char *)&tdb->header.version;
236         vertest = (((u32)vp[0]) << 24) | (((u32)vp[1]) << 16) |
237                   (((u32)vp[2]) << 8) | (u32)vp[3];
238         tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
239         if (!rev)
240                 tdb->flags &= ~TDB_CONVERT;
241         else {
242                 tdb->flags |= TDB_CONVERT;
243                 tdb_convert(&tdb->header, sizeof(tdb->header));
244         }
245         if (fstat(tdb->fd, &st) == -1)
246                 goto fail;
247
248         if (tdb->header.rwlocks != 0) {
249                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: spinlocks no longer supported\n"));
250                 goto fail;
251         }
252
253         /* Is it already in the open list?  If so, fail. */
254         if (tdb_already_open(st.st_dev, st.st_ino)) {
255                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
256                          "%s (%d,%d) is already open in this process\n",
257                          name, (int)st.st_dev, (int)st.st_ino));
258                 errno = EBUSY;
259                 goto fail;
260         }
261
262         if (!(tdb->name = (char *)strdup(name))) {
263                 errno = ENOMEM;
264                 goto fail;
265         }
266
267         tdb->map_size = st.st_size;
268         tdb->device = st.st_dev;
269         tdb->inode = st.st_ino;
270         tdb->max_dead_records = 0;
271         tdb_mmap(tdb);
272         if (locked) {
273                 if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_UNLCK, F_SETLK, 0, 1) == -1) {
274                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
275                                  "failed to take ACTIVE_LOCK on %s: %s\n",
276                                  name, strerror(errno)));
277                         goto fail;
278                 }
279
280         }
281
282         /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
283            we didn't get the initial exclusive lock as we need to let all other
284            users know we're using it. */
285
286         if (tdb_flags & TDB_CLEAR_IF_FIRST) {
287                 /* leave this lock in place to indicate it's in use */
288                 if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0, 1) == -1)
289                         goto fail;
290         }
291
292         /* if needed, run recovery */
293         if (tdb_transaction_recover(tdb) == -1) {
294                 goto fail;
295         }
296
297  internal:
298         /* Internal (memory-only) databases skip all the code above to
299          * do with disk files, and resume here by releasing their
300          * global lock and hooking into the active list. */
301         if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_UNLCK, F_SETLKW, 0, 1) == -1)
302                 goto fail;
303         tdb->next = tdbs;
304         tdbs = tdb;
305         return tdb;
306
307  fail:
308         { int save_errno = errno;
309
310         if (!tdb)
311                 return NULL;
312         
313         if (tdb->map_ptr) {
314                 if (tdb->flags & TDB_INTERNAL)
315                         SAFE_FREE(tdb->map_ptr);
316                 else
317                         tdb_munmap(tdb);
318         }
319         SAFE_FREE(tdb->name);
320         if (tdb->fd != -1)
321                 if (close(tdb->fd) != 0)
322                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to close tdb->fd on error!\n"));
323         SAFE_FREE(tdb);
324         errno = save_errno;
325         return NULL;
326         }
327 }
328
329 /*
330  * Set the maximum number of dead records per hash chain
331  */
332
333 void tdb_set_max_dead(struct tdb_context *tdb, int max_dead)
334 {
335         tdb->max_dead_records = max_dead;
336 }
337
338 /**
339  * Close a database.
340  *
341  * @returns -1 for error; 0 for success.
342  **/
343 int tdb_close(struct tdb_context *tdb)
344 {
345         struct tdb_context **i;
346         int ret = 0;
347
348         if (tdb->transaction) {
349                 tdb_transaction_cancel(tdb);
350         }
351
352         if (tdb->map_ptr) {
353                 if (tdb->flags & TDB_INTERNAL)
354                         SAFE_FREE(tdb->map_ptr);
355                 else
356                         tdb_munmap(tdb);
357         }
358         SAFE_FREE(tdb->name);
359         if (tdb->fd != -1)
360                 ret = close(tdb->fd);
361         SAFE_FREE(tdb->lockrecs);
362
363         /* Remove from contexts list */
364         for (i = &tdbs; *i; i = &(*i)->next) {
365                 if (*i == tdb) {
366                         *i = tdb->next;
367                         break;
368                 }
369         }
370
371         memset(tdb, 0, sizeof(*tdb));
372         SAFE_FREE(tdb);
373
374         return ret;
375 }
376
377 /* register a loging function */
378 void tdb_set_logging_function(struct tdb_context *tdb,
379                               const struct tdb_logging_context *log_ctx)
380 {
381         tdb->log = *log_ctx;
382 }
383
384 void *tdb_get_logging_private(struct tdb_context *tdb)
385 {
386         return tdb->log.log_private;
387 }
388
389 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
390    seek pointer from our parent and to re-establish locks */
391 int tdb_reopen(struct tdb_context *tdb)
392 {
393         struct stat st;
394
395         if (tdb->flags & TDB_INTERNAL) {
396                 return 0; /* Nothing to do. */
397         }
398
399         if (tdb->num_locks != 0 || tdb->global_lock.count) {
400                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed with locks held\n"));
401                 goto fail;
402         }
403
404         if (tdb->transaction != 0) {
405                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed inside a transaction\n"));
406                 goto fail;
407         }
408
409         if (tdb_munmap(tdb) != 0) {
410                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: munmap failed (%s)\n", strerror(errno)));
411                 goto fail;
412         }
413         if (close(tdb->fd) != 0)
414                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
415         tdb->fd = open(tdb->name, tdb->open_flags & ~(O_CREAT|O_TRUNC), 0);
416         if (tdb->fd == -1) {
417                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: open failed (%s)\n", strerror(errno)));
418                 goto fail;
419         }
420         if ((tdb->flags & TDB_CLEAR_IF_FIRST) && 
421             (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0, 1) == -1)) {
422                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: failed to obtain active lock\n"));
423                 goto fail;
424         }
425         if (fstat(tdb->fd, &st) != 0) {
426                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
427                 goto fail;
428         }
429         if (st.st_ino != tdb->inode || st.st_dev != tdb->device) {
430                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: file dev/inode has changed!\n"));
431                 goto fail;
432         }
433         tdb_mmap(tdb);
434
435         return 0;
436
437 fail:
438         tdb_close(tdb);
439         return -1;
440 }
441
442 /* reopen all tdb's */
443 int tdb_reopen_all(int parent_longlived)
444 {
445         struct tdb_context *tdb;
446
447         for (tdb=tdbs; tdb; tdb = tdb->next) {
448                 /*
449                  * If the parent is longlived (ie. a
450                  * parent daemon architecture), we know
451                  * it will keep it's active lock on a
452                  * tdb opened with CLEAR_IF_FIRST. Thus
453                  * for child processes we don't have to
454                  * add an active lock. This is essential
455                  * to improve performance on systems that
456                  * keep POSIX locks as a non-scalable data
457                  * structure in the kernel.
458                  */
459                 if (parent_longlived) {
460                         /* Ensure no clear-if-first. */
461                         tdb->flags &= ~TDB_CLEAR_IF_FIRST;
462                 }
463
464                 if (tdb_reopen(tdb) != 0)
465                         return -1;
466         }
467
468         return 0;
469 }