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