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