Use -O not -O3: reduces ccan/tdb test time from 24 to 18 seconds.
[ccan] / ccan / tdb / tdb_private.h
1 #ifndef TDB_PRIVATE_H
2 #define TDB_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 #ifdef _SAMBA_BUILD_
29 #include "replace.h"
30 #include "system/filesys.h"
31 #include "system/time.h"
32 #include "system/shmem.h"
33 #include "system/select.h"
34 #include "system/wait.h"
35 #else
36 #define _XOPEN_SOURCE 500
37 #define _FILE_OFFSET_BITS 64
38 #include <stdint.h>
39 #include <stdbool.h>
40 #include <stdlib.h>
41 #include <sys/time.h>
42 #include <sys/mman.h>
43 #include <unistd.h>
44 #include <fcntl.h>
45 #include <string.h>
46 #include <errno.h>
47 #include <stdio.h>
48 #include <utime.h>
49 #include "config.h"
50 #endif
51 #include "tdb.h"
52
53 /* #define TDB_TRACE 1 */
54
55 #if HAVE_GETPAGESIZE
56 #define getpagesize() 0x2000
57 #endif
58
59 typedef uint32_t tdb_len_t;
60 typedef uint32_t tdb_off_t;
61
62 #ifndef offsetof
63 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
64 #endif
65
66 #define TDB_MAGIC_FOOD "TDB file\n"
67 #define TDB_VERSION (0x26011967 + 6)
68 #define TDB_MAGIC (0x26011999U)
69 #define TDB_FREE_MAGIC (~TDB_MAGIC)
70 #define TDB_DEAD_MAGIC (0xFEE1DEAD)
71 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
72 #define TDB_ALIGNMENT 4
73 #define DEFAULT_HASH_SIZE 131
74 #define FREELIST_TOP (sizeof(struct tdb_header))
75 #define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
76 #define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
77 #define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
78 #define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
79 #define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off_t))
80 #define TDB_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb_off_t))
81 #define TDB_DATA_START(hash_size) (TDB_HASH_TOP(hash_size-1) + sizeof(tdb_off_t))
82 #define TDB_RECOVERY_HEAD offsetof(struct tdb_header, recovery_start)
83 #define TDB_SEQNUM_OFS    offsetof(struct tdb_header, sequence_number)
84 #define TDB_PAD_BYTE 0x42
85 #define TDB_PAD_U32  0x42424242
86
87 /* NB assumes there is a local variable called "tdb" that is the
88  * current context, also takes doubly-parenthesized print-style
89  * argument. */
90 #define TDB_LOG(x) tdb->log.log_fn x
91
92 #ifdef TDB_TRACE
93 void tdb_trace(struct tdb_context *tdb, const char *op);
94 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
95 void tdb_trace_open(struct tdb_context *tdb, const char *op,
96                     unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
97 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
98 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
99 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
100                     TDB_DATA rec);
101 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
102                         TDB_DATA rec, int ret);
103 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
104                            TDB_DATA rec, TDB_DATA ret);
105 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
106                              TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
107                              int ret);
108 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
109                            TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
110 #else
111 #define tdb_trace(tdb, op)
112 #define tdb_trace_seqnum(tdb, seqnum, op)
113 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
114 #define tdb_trace_ret(tdb, op, ret)
115 #define tdb_trace_retrec(tdb, op, ret)
116 #define tdb_trace_1rec(tdb, op, rec)
117 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
118 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
119 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
120 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
121 #endif /* !TDB_TRACE */
122
123 /* lock offsets */
124 #define GLOBAL_LOCK      0
125 #define ACTIVE_LOCK      4
126 #define TRANSACTION_LOCK 8
127
128 /* free memory if the pointer is valid and zero the pointer */
129 #ifndef SAFE_FREE
130 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
131 #endif
132
133 #define BUCKET(hash) ((hash) % tdb->header.hash_size)
134
135 #define DOCONV() (tdb->flags & TDB_CONVERT)
136 #define CONVERT(x) (DOCONV() ? tdb_convert(&x, sizeof(x)) : &x)
137
138
139 /* the body of the database is made of one list_struct for the free space
140    plus a separate data list for each hash value */
141 struct list_struct {
142         tdb_off_t next; /* offset of the next record in the list */
143         tdb_len_t rec_len; /* total byte length of record */
144         tdb_len_t key_len; /* byte length of key */
145         tdb_len_t data_len; /* byte length of data */
146         uint32_t full_hash; /* the full 32 bit hash of the key */
147         uint32_t magic;   /* try to catch errors */
148         /* the following union is implied:
149                 union {
150                         char record[rec_len];
151                         struct {
152                                 char key[key_len];
153                                 char data[data_len];
154                         }
155                         uint32_t totalsize; (tailer)
156                 }
157         */
158 };
159
160
161 /* this is stored at the front of every database */
162 struct tdb_header {
163         char magic_food[32]; /* for /etc/magic */
164         uint32_t version; /* version of the code */
165         uint32_t hash_size; /* number of hash entries */
166         tdb_off_t rwlocks; /* obsolete - kept to detect old formats */
167         tdb_off_t recovery_start; /* offset of transaction recovery region */
168         tdb_off_t sequence_number; /* used when TDB_SEQNUM is set */
169         tdb_off_t reserved[29];
170 };
171
172 struct tdb_lock_type {
173         int list;
174         uint32_t count;
175         uint32_t ltype;
176 };
177
178 struct tdb_traverse_lock {
179         struct tdb_traverse_lock *next;
180         uint32_t off;
181         uint32_t hash;
182         int lock_rw;
183 };
184
185 enum tdb_lock_flags {
186         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
187         TDB_LOCK_NOWAIT = 0,
188         TDB_LOCK_WAIT = 1,
189         /* If set, don't log an error on failure. */
190         TDB_LOCK_PROBE = 2,
191         /* If set, don't actually lock at all. */
192         TDB_LOCK_MARK_ONLY = 4,
193 };
194
195 struct tdb_methods {
196         int (*tdb_read)(struct tdb_context *, tdb_off_t , void *, tdb_len_t , int );
197         int (*tdb_write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
198         void (*next_hash_chain)(struct tdb_context *, uint32_t *);
199         int (*tdb_oob)(struct tdb_context *, tdb_off_t , int );
200         int (*tdb_expand_file)(struct tdb_context *, tdb_off_t , tdb_off_t );
201         int (*brlock)(struct tdb_context *, int, tdb_off_t, size_t, enum tdb_lock_flags);
202         int (*brunlock)(struct tdb_context *, int, tdb_off_t, size_t);
203 };
204
205 struct tdb_context {
206         char *name; /* the name of the database */
207         void *map_ptr; /* where it is currently mapped */
208         int fd; /* open file descriptor for the database */
209         tdb_len_t map_size; /* how much space has been mapped */
210         int read_only; /* opened read-only */
211         int traverse_read; /* read-only traversal */
212         int traverse_write; /* read-write traversal */
213         struct tdb_lock_type global_lock;
214         int num_lockrecs;
215         struct tdb_lock_type *lockrecs; /* only real locks, all with count>0 */
216         enum TDB_ERROR ecode; /* error code for last tdb error */
217         struct tdb_header header; /* a cached copy of the header */
218         uint32_t flags; /* the flags passed to tdb_open */
219         struct tdb_traverse_lock travlocks; /* current traversal locks */
220         struct tdb_context *next; /* all tdbs to avoid multiple opens */
221         dev_t device;   /* uniquely identifies this tdb */
222         ino_t inode;    /* uniquely identifies this tdb */
223         struct tdb_logging_context log;
224         unsigned int (*hash_fn)(TDB_DATA *key);
225         int open_flags; /* flags used in the open - needed by reopen */
226         unsigned int num_locks; /* number of chain locks held */
227         const struct tdb_methods *methods;
228         struct tdb_transaction *transaction;
229         int page_size;
230         int max_dead_records;
231         int transaction_lock_count;
232 #ifdef TDB_TRACE
233         int tracefd;
234         uint32_t transaction_prepare_seqnum;
235 #endif
236         volatile sig_atomic_t *interrupt_sig_ptr;
237 };
238
239
240 /*
241   internal prototypes
242 */
243 int tdb_munmap(struct tdb_context *tdb);
244 void tdb_mmap(struct tdb_context *tdb);
245 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
246 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
247 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
248 int tdb_brlock(struct tdb_context *tdb,
249                int rw_type, tdb_off_t offset, size_t len,
250                enum tdb_lock_flags flags);
251 int tdb_brunlock(struct tdb_context *tdb,
252                  int rw_type, tdb_off_t offset, size_t len);
253 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
254 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
255 int tdb_brlock_upgrade(struct tdb_context *tdb, tdb_off_t offset, size_t len);
256 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
257 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
258 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
259 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
260 void *tdb_convert(void *buf, uint32_t size);
261 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
262 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct list_struct *rec);
263 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
264 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
265 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
266 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
267 int _tdb_transaction_cancel(struct tdb_context *tdb, int ltype);
268 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
269 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
270 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct list_struct *rec);
271 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
272 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
273                    tdb_off_t offset, tdb_len_t len,
274                    int (*parser)(TDB_DATA key, TDB_DATA data,
275                                  void *private_data),
276                    void *private_data);
277 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
278                            struct list_struct *rec);
279 void tdb_io_init(struct tdb_context *tdb);
280 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
281 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
282                       struct list_struct *rec);
283
284
285 #endif