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