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