d86ffff64690e277e26e0c0e24613728e19e5e4c
[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 2 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, write to the Free Software
26    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27 */
28
29 #include "tdb_private.h"
30
31 /* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
32 static struct tdb_context *tdbs = NULL;
33
34
35 /* This is based on the hash algorithm from gdbm */
36 static unsigned int default_tdb_hash(TDB_DATA *key)
37 {
38         u32 value;      /* Used to compute the hash value.  */
39         u32   i;        /* Used to cycle through random values. */
40
41         /* Set the initial value from the key size. */
42         for (value = 0x238F13AF * key->dsize, i=0; i < key->dsize; i++)
43                 value = (value + (key->dptr[i] << (i*5 % 24)));
44
45         return (1103515243 * value + 12345);  
46 }
47
48
49 /* initialise a new database with a specified hash size */
50 static int tdb_new_database(struct tdb_context *tdb, int hash_size)
51 {
52         struct tdb_header *newdb;
53         int size, ret = -1;
54
55         /* We make it up in memory, then write it out if not internal */
56         size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);
57         if (!(newdb = calloc(size, 1)))
58                 return TDB_ERRCODE(TDB_ERR_OOM, -1);
59
60         /* Fill in the header */
61         newdb->version = TDB_VERSION;
62         newdb->hash_size = hash_size;
63         if (tdb->flags & TDB_INTERNAL) {
64                 tdb->map_size = size;
65                 tdb->map_ptr = (char *)newdb;
66                 memcpy(&tdb->header, newdb, sizeof(tdb->header));
67                 /* Convert the `ondisk' version if asked. */
68                 CONVERT(*newdb);
69                 return 0;
70         }
71         if (lseek(tdb->fd, 0, SEEK_SET) == -1)
72                 goto fail;
73
74         if (ftruncate(tdb->fd, 0) == -1)
75                 goto fail;
76
77         /* This creates an endian-converted header, as if read from disk */
78         CONVERT(*newdb);
79         memcpy(&tdb->header, newdb, sizeof(tdb->header));
80         /* Don't endian-convert the magic food! */
81         memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
82         if (write(tdb->fd, newdb, size) != size) {
83                 ret = -1;
84         } else {
85                 ret = 0;
86         }
87
88   fail:
89         SAFE_FREE(newdb);
90         return ret;
91 }
92
93
94
95 static int tdb_already_open(dev_t device,
96                             ino_t ino)
97 {
98         struct tdb_context *i;
99         
100         for (i = tdbs; i; i = i->next) {
101                 if (i->device == device && i->inode == ino) {
102                         return 1;
103                 }
104         }
105
106         return 0;
107 }
108
109 /* open the database, creating it if necessary 
110
111    The open_flags and mode are passed straight to the open call on the
112    database file. A flags value of O_WRONLY is invalid. The hash size
113    is advisory, use zero for a default value.
114
115    Return is NULL on error, in which case errno is also set.  Don't 
116    try to call tdb_error or tdb_errname, just do strerror(errno).
117
118    @param name may be NULL for internal databases. */
119 struct tdb_context *tdb_open(const char *name, int hash_size, int tdb_flags,
120                       int open_flags, mode_t mode)
121 {
122         return tdb_open_ex(name, hash_size, tdb_flags, open_flags, mode, NULL, NULL);
123 }
124
125 /* a default logging function */
126 static void null_log_fn(struct tdb_context *tdb, int level, const char *fmt, ...)
127 {
128 }
129
130
131 struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
132                          int open_flags, mode_t mode,
133                          tdb_log_func log_fn,
134                          tdb_hash_func hash_fn)
135 {
136         struct tdb_context *tdb;
137         struct stat st;
138         int rev = 0, locked = 0;
139         uint8_t *vp;
140         u32 vertest;
141
142         if (!(tdb = calloc(1, sizeof *tdb))) {
143                 /* Can't log this */
144                 errno = ENOMEM;
145                 goto fail;
146         }
147         tdb->fd = -1;
148         tdb->name = NULL;
149         tdb->map_ptr = NULL;
150         tdb->flags = tdb_flags;
151         tdb->open_flags = open_flags;
152         tdb->log_fn = log_fn?log_fn:null_log_fn;
153         tdb->hash_fn = hash_fn ? hash_fn : default_tdb_hash;
154
155         if ((open_flags & O_ACCMODE) == O_WRONLY) {
156                 TDB_LOG((tdb, 0, "tdb_open_ex: can't open tdb %s write-only\n",
157                          name));
158                 errno = EINVAL;
159                 goto fail;
160         }
161         
162         if (hash_size == 0)
163                 hash_size = DEFAULT_HASH_SIZE;
164         if ((open_flags & O_ACCMODE) == O_RDONLY) {
165                 tdb->read_only = 1;
166                 /* read only databases don't do locking or clear if first */
167                 tdb->flags |= TDB_NOLOCK;
168                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
169         }
170
171         /* internal databases don't mmap or lock, and start off cleared */
172         if (tdb->flags & TDB_INTERNAL) {
173                 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
174                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
175                 if (tdb_new_database(tdb, hash_size) != 0) {
176                         TDB_LOG((tdb, 0, "tdb_open_ex: tdb_new_database failed!"));
177                         goto fail;
178                 }
179                 goto internal;
180         }
181
182         if ((tdb->fd = open(name, open_flags, mode)) == -1) {
183                 TDB_LOG((tdb, 5, "tdb_open_ex: could not open file %s: %s\n",
184                          name, strerror(errno)));
185                 goto fail;      /* errno set by open(2) */
186         }
187
188         /* ensure there is only one process initialising at once */
189         if (tdb_brlock(tdb, GLOBAL_LOCK, F_WRLCK, F_SETLKW, 0) == -1) {
190                 TDB_LOG((tdb, 0, "tdb_open_ex: failed to get global lock on %s: %s\n",
191                          name, strerror(errno)));
192                 goto fail;      /* errno set by tdb_brlock */
193         }
194
195         /* we need to zero database if we are the only one with it open */
196         if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
197             (locked = (tdb_brlock(tdb, ACTIVE_LOCK, F_WRLCK, F_SETLK, 0) == 0))) {
198                 open_flags |= O_CREAT;
199                 if (ftruncate(tdb->fd, 0) == -1) {
200                         TDB_LOG((tdb, 0, "tdb_open_ex: "
201                                  "failed to truncate %s: %s\n",
202                                  name, strerror(errno)));
203                         goto fail; /* errno set by ftruncate */
204                 }
205         }
206
207         if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
208             || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0
209             || (tdb->header.version != TDB_VERSION
210                 && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION))))) {
211                 /* its not a valid database - possibly initialise it */
212                 if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
213                         errno = EIO; /* ie bad format or something */
214                         goto fail;
215                 }
216                 rev = (tdb->flags & TDB_CONVERT);
217         }
218         vp = (uint8_t *)&tdb->header.version;
219         vertest = (((u32)vp[0]) << 24) | (((u32)vp[1]) << 16) |
220                   (((u32)vp[2]) << 8) | (u32)vp[3];
221         tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
222         if (!rev)
223                 tdb->flags &= ~TDB_CONVERT;
224         else {
225                 tdb->flags |= TDB_CONVERT;
226                 tdb_convert(&tdb->header, sizeof(tdb->header));
227         }
228         if (fstat(tdb->fd, &st) == -1)
229                 goto fail;
230
231         if (tdb->header.rwlocks != 0) {
232                 TDB_LOG((tdb, 5, "tdb_open_ex: spinlocks no longer supported\n"));
233                 goto fail;
234         }
235
236         /* Is it already in the open list?  If so, fail. */
237         if (tdb_already_open(st.st_dev, st.st_ino)) {
238                 TDB_LOG((tdb, 2, "tdb_open_ex: "
239                          "%s (%d,%d) is already open in this process\n",
240                          name, (int)st.st_dev, (int)st.st_ino));
241                 errno = EBUSY;
242                 goto fail;
243         }
244
245         if (!(tdb->name = (char *)strdup(name))) {
246                 errno = ENOMEM;
247                 goto fail;
248         }
249
250         tdb->map_size = st.st_size;
251         tdb->device = st.st_dev;
252         tdb->inode = st.st_ino;
253         tdb->locked = calloc(tdb->header.hash_size+1, sizeof(tdb->locked[0]));
254         if (!tdb->locked) {
255                 TDB_LOG((tdb, 2, "tdb_open_ex: "
256                          "failed to allocate lock structure for %s\n",
257                          name));
258                 errno = ENOMEM;
259                 goto fail;
260         }
261         tdb_mmap(tdb);
262         if (locked) {
263                 if (tdb_brlock(tdb, ACTIVE_LOCK, F_UNLCK, F_SETLK, 0) == -1) {
264                         TDB_LOG((tdb, 0, "tdb_open_ex: "
265                                  "failed to take ACTIVE_LOCK on %s: %s\n",
266                                  name, strerror(errno)));
267                         goto fail;
268                 }
269
270         }
271
272         /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
273            we didn't get the initial exclusive lock as we need to let all other
274            users know we're using it. */
275
276         if (tdb_flags & TDB_CLEAR_IF_FIRST) {
277                 /* leave this lock in place to indicate it's in use */
278                 if (tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0) == -1)
279                         goto fail;
280         }
281
282  internal:
283         /* Internal (memory-only) databases skip all the code above to
284          * do with disk files, and resume here by releasing their
285          * global lock and hooking into the active list. */
286         if (tdb_brlock(tdb, GLOBAL_LOCK, F_UNLCK, F_SETLKW, 0) == -1)
287                 goto fail;
288         tdb->next = tdbs;
289         tdbs = tdb;
290         return tdb;
291
292  fail:
293         { int save_errno = errno;
294
295         if (!tdb)
296                 return NULL;
297         
298         if (tdb->map_ptr) {
299                 if (tdb->flags & TDB_INTERNAL)
300                         SAFE_FREE(tdb->map_ptr);
301                 else
302                         tdb_munmap(tdb);
303         }
304         SAFE_FREE(tdb->name);
305         if (tdb->fd != -1)
306                 if (close(tdb->fd) != 0)
307                         TDB_LOG((tdb, 5, "tdb_open_ex: failed to close tdb->fd on error!\n"));
308         SAFE_FREE(tdb->locked);
309         SAFE_FREE(tdb);
310         errno = save_errno;
311         return NULL;
312         }
313 }
314
315 /**
316  * Close a database.
317  *
318  * @returns -1 for error; 0 for success.
319  **/
320 int tdb_close(struct tdb_context *tdb)
321 {
322         struct tdb_context **i;
323         int ret = 0;
324
325         if (tdb->map_ptr) {
326                 if (tdb->flags & TDB_INTERNAL)
327                         SAFE_FREE(tdb->map_ptr);
328                 else
329                         tdb_munmap(tdb);
330         }
331         SAFE_FREE(tdb->name);
332         if (tdb->fd != -1)
333                 ret = close(tdb->fd);
334         SAFE_FREE(tdb->locked);
335
336         /* Remove from contexts list */
337         for (i = &tdbs; *i; i = &(*i)->next) {
338                 if (*i == tdb) {
339                         *i = tdb->next;
340                         break;
341                 }
342         }
343
344         memset(tdb, 0, sizeof(*tdb));
345         SAFE_FREE(tdb);
346
347         return ret;
348 }
349
350 /* register a loging function */
351 void tdb_logging_function(struct tdb_context *tdb, void (*fn)(struct tdb_context *, int , const char *, ...))
352 {
353         tdb->log_fn = fn?fn:null_log_fn;
354 }
355
356
357 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
358    seek pointer from our parent and to re-establish locks */
359 int tdb_reopen(struct tdb_context *tdb)
360 {
361         struct stat st;
362
363         if (tdb->flags & TDB_INTERNAL)
364                 return 0; /* Nothing to do. */
365         if (tdb_munmap(tdb) != 0) {
366                 TDB_LOG((tdb, 0, "tdb_reopen: munmap failed (%s)\n", strerror(errno)));
367                 goto fail;
368         }
369         if (close(tdb->fd) != 0)
370                 TDB_LOG((tdb, 0, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
371         tdb->fd = open(tdb->name, tdb->open_flags & ~(O_CREAT|O_TRUNC), 0);
372         if (tdb->fd == -1) {
373                 TDB_LOG((tdb, 0, "tdb_reopen: open failed (%s)\n", strerror(errno)));
374                 goto fail;
375         }
376         if ((tdb->flags & TDB_CLEAR_IF_FIRST) && 
377             (tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0) == -1)) {
378                 TDB_LOG((tdb, 0, "tdb_reopen: failed to obtain active lock\n"));
379                 goto fail;
380         }
381         if (fstat(tdb->fd, &st) != 0) {
382                 TDB_LOG((tdb, 0, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
383                 goto fail;
384         }
385         if (st.st_ino != tdb->inode || st.st_dev != tdb->device) {
386                 TDB_LOG((tdb, 0, "tdb_reopen: file dev/inode has changed!\n"));
387                 goto fail;
388         }
389         tdb_mmap(tdb);
390
391         return 0;
392
393 fail:
394         tdb_close(tdb);
395         return -1;
396 }
397
398 /* reopen all tdb's */
399 int tdb_reopen_all(void)
400 {
401         struct tdb_context *tdb;
402
403         for (tdb=tdbs; tdb; tdb = tdb->next) {
404                 if (tdb_reopen(tdb) != 0)
405                         return -1;
406         }
407
408         return 0;
409 }