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