809f13555552ac85811946f1d8dd212cc92f0200
[ccan] / ccan / tdb2 / tdb1_private.h
1 #ifndef CCAN_TDB2_TDB1_PRIVATE_H
2 #define CCAN_TDB2_TDB1_PRIVATE_H
3  /*
4    Unix SMB/CIFS implementation.
5
6    trivial database library - private includes
7
8    Copyright (C) Andrew Tridgell              2005
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 #ifndef _SAMBA_BUILD_
29 #include "config.h"
30 /* This keeps us consistent with TDB2 code. */
31 #if HAVE_FILE_OFFSET_BITS
32 #define _FILE_OFFSET_BITS 64
33 #endif
34 #include <stdint.h>
35 #include <stdbool.h>
36 #include <string.h>
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #include <sys/mman.h>
40 #include <sys/time.h>
41 #include <fcntl.h>
42 #include <unistd.h>
43 #include <errno.h>
44 #include <stdlib.h>
45 #include <limits.h>
46 #include <stdio.h>
47 #include <utime.h>
48 #else
49 #include "replace.h"
50 #include "system/filesys.h"
51 #include "system/time.h"
52 #include "system/shmem.h"
53 #include "system/select.h"
54 #include "system/wait.h"
55 #endif
56
57 #include "tdb1.h"
58
59 /* Temporary wrapper to avoid undue churn in test/ */
60 #define tdb1_error(tdb) ((tdb)->ecode)
61
62 /* #define TDB_TRACE 1 */
63 #ifndef HAVE_GETPAGESIZE
64 #define getpagesize() 0x2000
65 #endif
66
67 #ifndef __STRING
68 #define __STRING(x)    #x
69 #endif
70
71 #ifndef __STRINGSTRING
72 #define __STRINGSTRING(x) __STRING(x)
73 #endif
74
75 #ifndef __location__
76 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
77 #endif
78
79 typedef uint32_t tdb1_len_t;
80 typedef uint32_t tdb1_off_t;
81
82 #ifndef offsetof
83 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
84 #endif
85
86 #define TDB1_MAGIC_FOOD "TDB file\n"
87 #define TDB1_VERSION (0x26011967 + 6)
88 #define TDB1_MAGIC (0x26011999U)
89 #define TDB1_FREE_MAGIC (~TDB1_MAGIC)
90 #define TDB1_DEAD_MAGIC (0xFEE1DEAD)
91 #define TDB1_RECOVERY_MAGIC (0xf53bc0e7U)
92 #define TDB1_RECOVERY_INVALID_MAGIC (0x0)
93 #define TDB1_HASH_RWLOCK_MAGIC (0xbad1a51U)
94 #define TDB1_ALIGNMENT 4
95 #define TDB1_DEFAULT_HASH_SIZE 131
96 #define TDB1_FREELIST_TOP (sizeof(struct tdb1_header))
97 #define TDB1_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
98 #define TDB1_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
99 #define TDB1_DEAD(r) ((r)->magic == TDB1_DEAD_MAGIC)
100 #define TDB1_BAD_MAGIC(r) ((r)->magic != TDB1_MAGIC && !TDB1_DEAD(r))
101 #define TDB1_HASH_TOP(hash) (TDB1_FREELIST_TOP + (TDB1_BUCKET(hash)+1)*sizeof(tdb1_off_t))
102 #define TDB1_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb1_off_t))
103 #define TDB1_DATA_START(hash_size) (TDB1_HASH_TOP(hash_size-1) + sizeof(tdb1_off_t))
104 #define TDB1_RECOVERY_HEAD offsetof(struct tdb1_header, recovery_start)
105 #define TDB1_SEQNUM_OFS    offsetof(struct tdb1_header, sequence_number)
106 #define TDB1_PAD_BYTE 0x42
107 #define TDB1_PAD_U32  0x42424242
108
109 /* NB assumes there is a local variable called "tdb" that is the
110  * current context, also takes doubly-parenthesized print-style
111  * argument. */
112 #define TDB1_LOG(x) tdb->log.log_fn x
113
114 /* lock offsets */
115 #define TDB1_OPEN_LOCK        0
116 #define TDB1_ACTIVE_LOCK      4
117 #define TDB1_TRANSACTION_LOCK 8
118
119 /* free memory if the pointer is valid and zero the pointer */
120 #ifndef SAFE_FREE
121 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
122 #endif
123
124 #define TDB1_BUCKET(hash) ((hash) % tdb->header.hash_size)
125
126 #define TDB1_DOCONV() (tdb->flags & TDB1_CONVERT)
127 #define TDB1_CONV(x) (TDB1_DOCONV() ? tdb1_convert(&x, sizeof(x)) : &x)
128
129 /* the body of the database is made of one tdb1_record for the free space
130    plus a separate data list for each hash value */
131 struct tdb1_record {
132         tdb1_off_t next; /* offset of the next record in the list */
133         tdb1_len_t rec_len; /* total byte length of record */
134         tdb1_len_t key_len; /* byte length of key */
135         tdb1_len_t data_len; /* byte length of data */
136         uint32_t full_hash; /* the full 32 bit hash of the key */
137         uint32_t magic;   /* try to catch errors */
138         /* the following union is implied:
139                 union {
140                         char record[rec_len];
141                         struct {
142                                 char key[key_len];
143                                 char data[data_len];
144                         }
145                         uint32_t totalsize; (tailer)
146                 }
147         */
148 };
149
150
151 /* this is stored at the front of every database */
152 struct tdb1_header {
153         char magic_food[32]; /* for /etc/magic */
154         uint32_t version; /* version of the code */
155         uint32_t hash_size; /* number of hash entries */
156         tdb1_off_t rwlocks; /* obsolete - kept to detect old formats */
157         tdb1_off_t recovery_start; /* offset of transaction recovery region */
158         tdb1_off_t sequence_number; /* used when TDB1_SEQNUM is set */
159         uint32_t magic1_hash; /* hash of TDB1_MAGIC_FOOD. */
160         uint32_t magic2_hash; /* hash of TDB1_MAGIC. */
161         tdb1_off_t reserved[27];
162 };
163
164 struct tdb1_lock_type {
165         uint32_t off;
166         uint32_t count;
167         uint32_t ltype;
168 };
169
170 struct tdb1_traverse_lock {
171         struct tdb1_traverse_lock *next;
172         uint32_t off;
173         uint32_t hash;
174         int lock_rw;
175 };
176
177 enum tdb1_lock_flags {
178         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
179         TDB1_LOCK_NOWAIT = 0,
180         TDB1_LOCK_WAIT = 1,
181         /* If set, don't log an error on failure. */
182         TDB1_LOCK_PROBE = 2,
183 };
184
185 struct tdb1_context;
186
187 struct tdb1_methods {
188         int (*tdb1_read)(struct tdb1_context *, tdb1_off_t , void *, tdb1_len_t , int );
189         int (*tdb1_write)(struct tdb1_context *, tdb1_off_t, const void *, tdb1_len_t);
190         void (*next_hash_chain)(struct tdb1_context *, uint32_t *);
191         int (*tdb1_oob)(struct tdb1_context *, tdb1_off_t , int );
192         int (*tdb1_expand_file)(struct tdb1_context *, tdb1_off_t , tdb1_off_t );
193 };
194
195 struct tdb1_context {
196         char *name; /* the name of the database */
197         void *map_ptr; /* where it is currently mapped */
198         int fd; /* open file descriptor for the database */
199         tdb1_len_t map_size; /* how much space has been mapped */
200         int read_only; /* opened read-only */
201         int traverse_read; /* read-only traversal */
202         int traverse_write; /* read-write traversal */
203         struct tdb1_lock_type allrecord_lock; /* .offset == upgradable */
204         int num_lockrecs;
205         struct tdb1_lock_type *lockrecs; /* only real locks, all with count>0 */
206         enum TDB1_ERROR ecode; /* error code for last tdb error */
207         struct tdb1_header header; /* a cached copy of the header */
208         uint32_t flags; /* the flags passed to tdb1_open */
209         struct tdb1_traverse_lock travlocks; /* current traversal locks */
210         struct tdb1_context *next; /* all tdbs to avoid multiple opens */
211         dev_t device;   /* uniquely identifies this tdb */
212         ino_t inode;    /* uniquely identifies this tdb */
213         struct tdb1_logging_context log;
214         unsigned int (*hash_fn)(TDB1_DATA *key);
215         int open_flags; /* flags used in the open - needed by reopen */
216         const struct tdb1_methods *methods;
217         struct tdb1_transaction *transaction;
218         int page_size;
219         int max_dead_records;
220 };
221
222 /*
223   internal prototypes
224 */
225 int tdb1_munmap(struct tdb1_context *tdb);
226 void tdb1_mmap(struct tdb1_context *tdb);
227 int tdb1_lock(struct tdb1_context *tdb, int list, int ltype);
228 int tdb1_nest_lock(struct tdb1_context *tdb, uint32_t offset, int ltype,
229                   enum tdb1_lock_flags flags);
230 int tdb1_nest_unlock(struct tdb1_context *tdb, uint32_t offset, int ltype);
231 int tdb1_unlock(struct tdb1_context *tdb, int list, int ltype);
232 int tdb1_brlock(struct tdb1_context *tdb,
233                int rw_type, tdb1_off_t offset, size_t len,
234                enum tdb1_lock_flags flags);
235 int tdb1_brunlock(struct tdb1_context *tdb,
236                  int rw_type, tdb1_off_t offset, size_t len);
237 bool tdb1_have_extra_locks(struct tdb1_context *tdb);
238 void tdb1_release_transaction_locks(struct tdb1_context *tdb);
239 int tdb1_transaction_lock(struct tdb1_context *tdb, int ltype,
240                          enum tdb1_lock_flags lockflags);
241 int tdb1_transaction_unlock(struct tdb1_context *tdb, int ltype);
242 int tdb1_recovery_area(struct tdb1_context *tdb,
243                       const struct tdb1_methods *methods,
244                       tdb1_off_t *recovery_offset,
245                       struct tdb1_record *rec);
246 int tdb1_allrecord_lock(struct tdb1_context *tdb, int ltype,
247                        enum tdb1_lock_flags flags, bool upgradable);
248 int tdb1_allrecord_unlock(struct tdb1_context *tdb, int ltype);
249 int tdb1_allrecord_upgrade(struct tdb1_context *tdb);
250 int tdb1_write_lock_record(struct tdb1_context *tdb, tdb1_off_t off);
251 int tdb1_write_unlock_record(struct tdb1_context *tdb, tdb1_off_t off);
252 int tdb1_ofs_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
253 int tdb1_ofs_write(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
254 void *tdb1_convert(void *buf, uint32_t size);
255 int tdb1_free(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
256 tdb1_off_t tdb1_allocate(struct tdb1_context *tdb, tdb1_len_t length, struct tdb1_record *rec);
257 int tdb1_ofs_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
258 int tdb1_ofs_write(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
259 int tdb1_lock_record(struct tdb1_context *tdb, tdb1_off_t off);
260 int tdb1_unlock_record(struct tdb1_context *tdb, tdb1_off_t off);
261 bool tdb1_needs_recovery(struct tdb1_context *tdb);
262 int tdb1_rec_read(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
263 int tdb1_rec_write(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
264 int tdb1_do_delete(struct tdb1_context *tdb, tdb1_off_t rec_ptr, struct tdb1_record *rec);
265 unsigned char *tdb1_alloc_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_len_t len);
266 int tdb1_parse_data(struct tdb1_context *tdb, TDB1_DATA key,
267                    tdb1_off_t offset, tdb1_len_t len,
268                    int (*parser)(TDB1_DATA key, TDB1_DATA data,
269                                  void *private_data),
270                    void *private_data);
271 tdb1_off_t tdb1_find_lock_hash(struct tdb1_context *tdb, TDB1_DATA key, uint32_t hash, int locktype,
272                            struct tdb1_record *rec);
273 void tdb1_io_init(struct tdb1_context *tdb);
274 int tdb1_expand(struct tdb1_context *tdb, tdb1_off_t size);
275 int tdb1_rec_free_read(struct tdb1_context *tdb, tdb1_off_t off,
276                       struct tdb1_record *rec);
277 bool tdb1_write_all(int fd, const void *buf, size_t count);
278 int tdb1_transaction_recover(struct tdb1_context *tdb);
279 void tdb1_header_hash(struct tdb1_context *tdb,
280                      uint32_t *magic1_hash, uint32_t *magic2_hash);
281 unsigned int tdb1_old_hash(TDB1_DATA *key);
282 size_t tdb1_dead_space(struct tdb1_context *tdb, tdb1_off_t off);
283 #endif /* CCAN_TDB2_TDB1_PRIVATE_H */