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