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