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