container_of: don't put member_ptr in container_off.
[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 /* We use two hashes to double-check they're using the right hash function. */
34 void tdb_header_hash(struct tdb_context *tdb,
35                      uint32_t *magic1_hash, uint32_t *magic2_hash)
36 {
37         TDB_DATA hash_key;
38         uint32_t tdb_magic = TDB_MAGIC;
39
40         hash_key.dptr = (unsigned char *)TDB_MAGIC_FOOD;
41         hash_key.dsize = sizeof(TDB_MAGIC_FOOD);
42         *magic1_hash = tdb->hash_fn(&hash_key);
43
44         hash_key.dptr = CONVERT(tdb_magic);
45         hash_key.dsize = sizeof(tdb_magic);
46         *magic2_hash = tdb->hash_fn(&hash_key);
47
48         /* Make sure at least one hash is non-zero! */
49         if (*magic1_hash == 0 && *magic2_hash == 0)
50                 *magic1_hash = 1;
51 }
52
53 /* initialise a new database with a specified hash size */
54 static int tdb_new_database(struct tdb_context *tdb, int hash_size)
55 {
56         struct tdb_header *newdb;
57         size_t size;
58         int ret = -1;
59         ssize_t written;
60
61         /* We make it up in memory, then write it out if not internal */
62         size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);
63         if (!(newdb = (struct tdb_header *)calloc(size, 1))) {
64                 tdb->ecode = TDB_ERR_OOM;
65                 return -1;
66         }
67
68         /* Fill in the header */
69         newdb->version = TDB_VERSION;
70         newdb->hash_size = hash_size;
71
72         tdb_header_hash(tdb, &newdb->magic1_hash, &newdb->magic2_hash);
73
74         /* Make sure older tdbs (which don't check the magic hash fields)
75          * will refuse to open this TDB. */
76         if (tdb->flags & TDB_INCOMPATIBLE_HASH)
77                 newdb->rwlocks = TDB_HASH_RWLOCK_MAGIC;
78
79         if (tdb->flags & TDB_INTERNAL) {
80                 tdb->map_size = size;
81                 tdb->map_ptr = (char *)newdb;
82                 memcpy(&tdb->header, newdb, sizeof(tdb->header));
83                 /* Convert the `ondisk' version if asked. */
84                 CONVERT(*newdb);
85                 return 0;
86         }
87         if (lseek(tdb->fd, 0, SEEK_SET) == -1)
88                 goto fail;
89
90         if (ftruncate(tdb->fd, 0) == -1)
91                 goto fail;
92
93         /* This creates an endian-converted header, as if read from disk */
94         CONVERT(*newdb);
95         memcpy(&tdb->header, newdb, sizeof(tdb->header));
96         /* Don't endian-convert the magic food! */
97         memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
98         /* we still have "ret == -1" here */
99         written = write(tdb->fd, newdb, size);
100         if (written == size) {
101                 ret = 0;
102         } else if (written != -1) {
103                 /* call write once again, this usually should return -1 and
104                  * set errno appropriately */
105                 size -= written;
106                 written = write(tdb->fd, newdb+written, size);
107                 if (written == size) {
108                 ret = 0;
109                 } else if (written >= 0) {
110                         /* a second incomplete write - we give up.
111                          * guessing the errno... */
112                         errno = ENOSPC;
113                 }
114         }
115
116   fail:
117         SAFE_FREE(newdb);
118         return ret;
119 }
120
121
122
123 static int tdb_already_open(dev_t device,
124                             ino_t ino)
125 {
126         struct tdb_context *i;
127         
128         for (i = tdbs; i; i = i->next) {
129                 if (i->device == device && i->inode == ino) {
130                         return 1;
131                 }
132         }
133
134         return 0;
135 }
136
137 /* open the database, creating it if necessary 
138
139    The open_flags and mode are passed straight to the open call on the
140    database file. A flags value of O_WRONLY is invalid. The hash size
141    is advisory, use zero for a default value.
142
143    Return is NULL on error, in which case errno is also set.  Don't 
144    try to call tdb_error or tdb_errname, just do strerror(errno).
145
146    @param name may be NULL for internal databases. */
147 struct tdb_context *tdb_open(const char *name, int hash_size, int tdb_flags,
148                       int open_flags, mode_t mode)
149 {
150         return tdb_open_ex(name, hash_size, tdb_flags, open_flags, mode, NULL, NULL);
151 }
152
153 /* a default logging function */
154 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...) PRINTF_FMT(3, 4);
155 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...)
156 {
157 }
158
159 static bool check_header_hash(struct tdb_context *tdb,
160                               bool default_hash, uint32_t *m1, uint32_t *m2)
161 {
162         tdb_header_hash(tdb, m1, m2);
163         if (tdb->header.magic1_hash == *m1 &&
164             tdb->header.magic2_hash == *m2) {
165                 return true;
166         }
167
168         /* If they explicitly set a hash, always respect it. */
169         if (!default_hash)
170                 return false;
171
172         /* Otherwise, try the other inbuilt hash. */
173         if (tdb->hash_fn == tdb_old_hash)
174                 tdb->hash_fn = tdb_jenkins_hash;
175         else
176                 tdb->hash_fn = tdb_old_hash;
177         return check_header_hash(tdb, false, m1, m2);
178 }
179
180 struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
181                                 int open_flags, mode_t mode,
182                                 const struct tdb_logging_context *log_ctx,
183                                 tdb_hash_func hash_fn)
184 {
185         struct tdb_context *tdb;
186         struct stat st;
187         int rev = 0, locked = 0;
188         unsigned char *vp;
189         uint32_t vertest;
190         unsigned v;
191         const char *hash_alg;
192         uint32_t magic1, magic2;
193
194         if (!(tdb = (struct tdb_context *)calloc(1, sizeof *tdb))) {
195                 /* Can't log this */
196                 errno = ENOMEM;
197                 goto fail;
198         }
199         tdb_io_init(tdb);
200         tdb->fd = -1;
201 #ifdef TDB_TRACE
202         tdb->tracefd = -1;
203 #endif
204         tdb->name = NULL;
205         tdb->map_ptr = NULL;
206         tdb->flags = tdb_flags;
207         tdb->open_flags = open_flags;
208         if (log_ctx) {
209                 tdb->log = *log_ctx;
210         } else {
211                 tdb->log.log_fn = null_log_fn;
212                 tdb->log.log_private = NULL;
213         }
214
215         if (hash_fn) {
216                 tdb->hash_fn = hash_fn;
217                 hash_alg = "the user defined";
218         } else {
219                 /* This controls what we use when creating a tdb. */
220                 if (tdb->flags & TDB_INCOMPATIBLE_HASH) {
221                         tdb->hash_fn = tdb_jenkins_hash;
222                 } else {
223                         tdb->hash_fn = tdb_old_hash;
224                 }
225                 hash_alg = "either default";
226         }
227
228         /* cache the page size */
229         tdb->page_size = getpagesize();
230         if (tdb->page_size <= 0) {
231                 tdb->page_size = 0x2000;
232         }
233
234         tdb->max_dead_records = (tdb_flags & TDB_VOLATILE) ? 5 : 0;
235
236         if ((open_flags & O_ACCMODE) == O_WRONLY) {
237                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: can't open tdb %s write-only\n",
238                          name));
239                 errno = EINVAL;
240                 goto fail;
241         }
242         
243         if (hash_size == 0)
244                 hash_size = DEFAULT_HASH_SIZE;
245         if ((open_flags & O_ACCMODE) == O_RDONLY) {
246                 tdb->read_only = 1;
247                 /* read only databases don't do locking or clear if first */
248                 tdb->flags |= TDB_NOLOCK;
249                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
250         }
251
252         if ((tdb->flags & TDB_ALLOW_NESTING) &&
253             (tdb->flags & TDB_DISALLOW_NESTING)) {
254                 tdb->ecode = TDB_ERR_NESTING;
255                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
256                         "allow_nesting and disallow_nesting are not allowed together!"));
257                 errno = EINVAL;
258                 goto fail;
259         }
260
261         /*
262          * TDB_DISALLOW_NESTING is the default behavior.
263          */
264         if (!(tdb->flags & TDB_ALLOW_NESTING)) {
265                 tdb->flags |= TDB_DISALLOW_NESTING;
266         }
267
268         /* internal databases don't mmap or lock, and start off cleared */
269         if (tdb->flags & TDB_INTERNAL) {
270                 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
271                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
272                 if (tdb_new_database(tdb, hash_size) != 0) {
273                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: tdb_new_database failed!"));
274                         goto fail;
275                 }
276                 goto internal;
277         }
278
279         if ((tdb->fd = open(name, open_flags, mode)) == -1) {
280                 TDB_LOG((tdb, TDB_DEBUG_WARNING, "tdb_open_ex: could not open file %s: %s\n",
281                          name, strerror(errno)));
282                 goto fail;      /* errno set by open(2) */
283         }
284
285         /* on exec, don't inherit the fd */
286         v = fcntl(tdb->fd, F_GETFD, 0);
287         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
288
289         /* ensure there is only one process initialising at once */
290         if (tdb_nest_lock(tdb, OPEN_LOCK, F_WRLCK, TDB_LOCK_WAIT) == -1) {
291                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to get open lock on %s: %s\n",
292                          name, strerror(errno)));
293                 goto fail;      /* errno set by tdb_brlock */
294         }
295
296         /* we need to zero database if we are the only one with it open */
297         if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
298             (!tdb->read_only) &&
299             (locked = (tdb_nest_lock(tdb, ACTIVE_LOCK, F_WRLCK, TDB_LOCK_NOWAIT|TDB_LOCK_PROBE) == 0))) {
300                 open_flags |= O_CREAT;
301                 if (ftruncate(tdb->fd, 0) == -1) {
302                         TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
303                                  "failed to truncate %s: %s\n",
304                                  name, strerror(errno)));
305                         goto fail; /* errno set by ftruncate */
306                 }
307         }
308
309         errno = 0;
310         if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
311             || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0) {
312                 if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
313                         if (errno == 0) {
314                                 errno = EIO; /* ie bad format or something */
315                         }
316                         goto fail;
317                 }
318                 rev = (tdb->flags & TDB_CONVERT);
319         } else if (tdb->header.version != TDB_VERSION
320                    && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION)))) {
321                 /* wrong version */
322                 errno = EIO;
323                 goto fail;
324         }
325         vp = (unsigned char *)&tdb->header.version;
326         vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |
327                   (((uint32_t)vp[2]) << 8) | (uint32_t)vp[3];
328         tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
329         if (!rev)
330                 tdb->flags &= ~TDB_CONVERT;
331         else {
332                 tdb->flags |= TDB_CONVERT;
333                 tdb_convert(&tdb->header, sizeof(tdb->header));
334         }
335         if (fstat(tdb->fd, &st) == -1)
336                 goto fail;
337
338         if (tdb->header.rwlocks != 0 &&
339             tdb->header.rwlocks != TDB_HASH_RWLOCK_MAGIC) {
340                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: spinlocks no longer supported\n"));
341                 goto fail;
342         }
343
344         if ((tdb->header.magic1_hash == 0) && (tdb->header.magic2_hash == 0)) {
345                 /* older TDB without magic hash references */
346                 tdb->hash_fn = tdb_old_hash;
347         } else if (!check_header_hash(tdb, !hash_fn, &magic1, &magic2)) {
348                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
349                          "%s was not created with %s hash function we are using\n"
350                          "magic1_hash[0x%08X %s 0x%08X] "
351                          "magic2_hash[0x%08X %s 0x%08X]\n",
352                          name, hash_alg,
353                          tdb->header.magic1_hash,
354                          (tdb->header.magic1_hash == magic1) ? "==" : "!=",
355                          magic1,
356                          tdb->header.magic2_hash,
357                          (tdb->header.magic2_hash == magic2) ? "==" : "!=",
358                          magic2));
359                 errno = EINVAL;
360                 goto fail;
361         }
362
363         /* Is it already in the open list?  If so, fail. */
364         if (tdb_already_open(st.st_dev, st.st_ino)) {
365                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
366                          "%s (%d,%d) is already open in this process\n",
367                          name, (int)st.st_dev, (int)st.st_ino));
368                 errno = EBUSY;
369                 goto fail;
370         }
371
372         if (!(tdb->name = (char *)strdup(name))) {
373                 errno = ENOMEM;
374                 goto fail;
375         }
376
377         tdb->map_size = st.st_size;
378         tdb->device = st.st_dev;
379         tdb->inode = st.st_ino;
380         tdb_mmap(tdb);
381         if (locked) {
382                 if (tdb_nest_unlock(tdb, ACTIVE_LOCK, F_WRLCK, false) == -1) {
383                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
384                                  "failed to take ACTIVE_LOCK on %s: %s\n",
385                                  name, strerror(errno)));
386                         goto fail;
387                 }
388
389         }
390
391         /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
392            we didn't get the initial exclusive lock as we need to let all other
393            users know we're using it. */
394
395         if (tdb_flags & TDB_CLEAR_IF_FIRST) {
396                 /* leave this lock in place to indicate it's in use */
397                 if (tdb_nest_lock(tdb, ACTIVE_LOCK, F_RDLCK, TDB_LOCK_WAIT) == -1) {
398                         goto fail;
399                 }
400         }
401
402         /* if needed, run recovery */
403         if (tdb_transaction_recover(tdb) == -1) {
404                 goto fail;
405         }
406
407 #ifdef TDB_TRACE
408         {
409                 char tracefile[strlen(name) + 32];
410
411                 snprintf(tracefile, sizeof(tracefile),
412                          "%s.trace.%li", name, (long)getpid());
413                 tdb->tracefd = open(tracefile, O_WRONLY|O_CREAT|O_EXCL, 0600);
414                 if (tdb->tracefd >= 0) {
415                         tdb_enable_seqnum(tdb);
416                         tdb_trace_open(tdb, "tdb_open", hash_size, tdb_flags,
417                                        open_flags);
418                 } else
419                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to open trace file %s!\n", tracefile));
420         }
421 #endif
422
423  internal:
424         /* Internal (memory-only) databases skip all the code above to
425          * do with disk files, and resume here by releasing their
426          * open lock and hooking into the active list. */
427         if (tdb_nest_unlock(tdb, OPEN_LOCK, F_WRLCK, false) == -1) {
428                 goto fail;
429         }
430         tdb->next = tdbs;
431         tdbs = tdb;
432         return tdb;
433
434  fail:
435         { int save_errno = errno;
436
437         if (!tdb)
438                 return NULL;
439
440 #ifdef TDB_TRACE
441         close(tdb->tracefd);
442 #endif
443         if (tdb->map_ptr) {
444                 if (tdb->flags & TDB_INTERNAL)
445                         SAFE_FREE(tdb->map_ptr);
446                 else
447                         tdb_munmap(tdb);
448         }
449         SAFE_FREE(tdb->name);
450         if (tdb->fd != -1)
451                 if (close(tdb->fd) != 0)
452                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to close tdb->fd on error!\n"));
453         SAFE_FREE(tdb->lockrecs);
454         SAFE_FREE(tdb);
455         errno = save_errno;
456         return NULL;
457         }
458 }
459
460 /*
461  * Set the maximum number of dead records per hash chain
462  */
463
464 void tdb_set_max_dead(struct tdb_context *tdb, int max_dead)
465 {
466         tdb->max_dead_records = max_dead;
467 }
468
469 /**
470  * Close a database.
471  *
472  * @returns -1 for error; 0 for success.
473  **/
474 int tdb_close(struct tdb_context *tdb)
475 {
476         struct tdb_context **i;
477         int ret = 0;
478
479         if (tdb->transaction) {
480                 tdb_transaction_cancel(tdb);
481         }
482         tdb_trace(tdb, "tdb_close");
483
484         if (tdb->map_ptr) {
485                 if (tdb->flags & TDB_INTERNAL)
486                         SAFE_FREE(tdb->map_ptr);
487                 else
488                         tdb_munmap(tdb);
489         }
490         SAFE_FREE(tdb->name);
491         if (tdb->fd != -1) {
492                 ret = close(tdb->fd);
493                 tdb->fd = -1;
494         }
495         SAFE_FREE(tdb->lockrecs);
496
497         /* Remove from contexts list */
498         for (i = &tdbs; *i; i = &(*i)->next) {
499                 if (*i == tdb) {
500                         *i = tdb->next;
501                         break;
502                 }
503         }
504
505 #ifdef TDB_TRACE
506         close(tdb->tracefd);
507 #endif
508         memset(tdb, 0, sizeof(*tdb));
509         SAFE_FREE(tdb);
510
511         return ret;
512 }
513
514 /* register a loging function */
515 void tdb_set_logging_function(struct tdb_context *tdb,
516                               const struct tdb_logging_context *log_ctx)
517 {
518         tdb->log = *log_ctx;
519 }
520
521 void *tdb_get_logging_private(struct tdb_context *tdb)
522 {
523         return tdb->log.log_private;
524 }
525
526 static int tdb_reopen_internal(struct tdb_context *tdb, bool active_lock)
527 {
528         struct stat st;
529
530         if (tdb->flags & TDB_INTERNAL) {
531                 return 0; /* Nothing to do. */
532         }
533
534         if (tdb_have_extra_locks(tdb)) {
535                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed with locks held\n"));
536                 goto fail;
537         }
538
539         if (tdb->transaction != 0) {
540                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed inside a transaction\n"));
541                 goto fail;
542         }
543
544         if (tdb_munmap(tdb) != 0) {
545                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: munmap failed (%s)\n", strerror(errno)));
546                 goto fail;
547         }
548         if (close(tdb->fd) != 0)
549                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
550         tdb->fd = open(tdb->name, tdb->open_flags & ~(O_CREAT|O_TRUNC), 0);
551         if (tdb->fd == -1) {
552                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: open failed (%s)\n", strerror(errno)));
553                 goto fail;
554         }
555         if (fstat(tdb->fd, &st) != 0) {
556                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
557                 goto fail;
558         }
559         if (st.st_ino != tdb->inode || st.st_dev != tdb->device) {
560                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: file dev/inode has changed!\n"));
561                 goto fail;
562         }
563         tdb_mmap(tdb);
564
565         /* We may still think we hold the active lock. */
566         tdb->num_lockrecs = 0;
567         SAFE_FREE(tdb->lockrecs);
568
569         if (active_lock && tdb_nest_lock(tdb, ACTIVE_LOCK, F_RDLCK, TDB_LOCK_WAIT) == -1) {
570                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: failed to obtain active lock\n"));
571                 goto fail;
572         }
573
574         return 0;
575
576 fail:
577         tdb_close(tdb);
578         return -1;
579 }
580
581 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
582    seek pointer from our parent and to re-establish locks */
583 int tdb_reopen(struct tdb_context *tdb)
584 {
585         return tdb_reopen_internal(tdb, tdb->flags & TDB_CLEAR_IF_FIRST);
586 }
587
588 /* reopen all tdb's */
589 int tdb_reopen_all(int parent_longlived)
590 {
591         struct tdb_context *tdb;
592
593         for (tdb=tdbs; tdb; tdb = tdb->next) {
594                 bool active_lock = (tdb->flags & TDB_CLEAR_IF_FIRST);
595
596                 /*
597                  * If the parent is longlived (ie. a
598                  * parent daemon architecture), we know
599                  * it will keep it's active lock on a
600                  * tdb opened with CLEAR_IF_FIRST. Thus
601                  * for child processes we don't have to
602                  * add an active lock. This is essential
603                  * to improve performance on systems that
604                  * keep POSIX locks as a non-scalable data
605                  * structure in the kernel.
606                  */
607                 if (parent_longlived) {
608                         /* Ensure no clear-if-first. */
609                         active_lock = false;
610                 }
611
612                 if (tdb_reopen_internal(tdb, active_lock) != 0)
613                         return -1;
614         }
615
616         return 0;
617 }