2 Unix SMB/CIFS implementation.
4 trivial database library - private includes
6 Copyright (C) Andrew Tridgell 2005
8 ** NOTE! The following LGPL license applies to the tdb
9 ** library. This does NOT imply that all of Samba is released
12 This library is free software; you can redistribute it and/or
13 modify it under the terms of the GNU Lesser General Public
14 License as published by the Free Software Foundation; either
15 version 3 of the License, or (at your option) any later version.
17 This library is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 Lesser General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public
23 License along with this library; if not, see <http://www.gnu.org/licenses/>.
27 #include "system/filesys.h"
28 #include "system/time.h"
29 #include "system/shmem.h"
30 #include "system/select.h"
31 #include "system/wait.h"
34 #ifndef HAVE_GETPAGESIZE
35 #define getpagesize() 0x2000
38 typedef uint32_t tdb_len_t;
39 typedef uint32_t tdb_off_t;
42 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
45 #define TDB_MAGIC_FOOD "TDB file\n"
46 #define TDB_VERSION (0x26011967 + 6)
47 #define TDB_MAGIC (0x26011999U)
48 #define TDB_FREE_MAGIC (~TDB_MAGIC)
49 #define TDB_DEAD_MAGIC (0xFEE1DEAD)
50 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
51 #define TDB_RECOVERY_INVALID_MAGIC (0x0)
52 #define TDB_HASH_RWLOCK_MAGIC (0xbad1a51U)
53 #define TDB_ALIGNMENT 4
54 #define DEFAULT_HASH_SIZE 131
55 #define FREELIST_TOP (sizeof(struct tdb_header))
56 #define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
57 #define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
58 #define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
59 #define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
60 #define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off_t))
61 #define TDB_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb_off_t))
62 #define TDB_DATA_START(hash_size) (TDB_HASH_TOP(hash_size-1) + sizeof(tdb_off_t))
63 #define TDB_RECOVERY_HEAD offsetof(struct tdb_header, recovery_start)
64 #define TDB_SEQNUM_OFS offsetof(struct tdb_header, sequence_number)
65 #define TDB_PAD_BYTE 0x42
66 #define TDB_PAD_U32 0x42424242
68 /* NB assumes there is a local variable called "tdb" that is the
69 * current context, also takes doubly-parenthesized print-style
71 #define TDB_LOG(x) tdb->log.log_fn x
76 #define TRANSACTION_LOCK 8
78 /* free memory if the pointer is valid and zero the pointer */
80 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
83 #define BUCKET(hash) ((hash) % tdb->header.hash_size)
85 #define DOCONV() (tdb->flags & TDB_CONVERT)
86 #define CONVERT(x) (DOCONV() ? tdb_convert(&x, sizeof(x)) : &x)
89 /* the body of the database is made of one list_struct for the free space
90 plus a separate data list for each hash value */
92 tdb_off_t next; /* offset of the next record in the list */
93 tdb_len_t rec_len; /* total byte length of record */
94 tdb_len_t key_len; /* byte length of key */
95 tdb_len_t data_len; /* byte length of data */
96 uint32_t full_hash; /* the full 32 bit hash of the key */
97 uint32_t magic; /* try to catch errors */
98 /* the following union is implied:
100 char record[rec_len];
105 uint32_t totalsize; (tailer)
111 /* this is stored at the front of every database */
113 char magic_food[32]; /* for /etc/magic */
114 uint32_t version; /* version of the code */
115 uint32_t hash_size; /* number of hash entries */
116 tdb_off_t rwlocks; /* obsolete - kept to detect old formats */
117 tdb_off_t recovery_start; /* offset of transaction recovery region */
118 tdb_off_t sequence_number; /* used when TDB_SEQNUM is set */
119 uint32_t magic1_hash; /* hash of TDB_MAGIC_FOOD. */
120 uint32_t magic2_hash; /* hash of TDB_MAGIC. */
121 tdb_off_t reserved[27];
124 struct tdb_lock_type {
130 struct tdb_traverse_lock {
131 struct tdb_traverse_lock *next;
139 int (*tdb_read)(struct tdb_context *, tdb_off_t , void *, tdb_len_t , int );
140 int (*tdb_write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
141 void (*next_hash_chain)(struct tdb_context *, uint32_t *);
142 int (*tdb_oob)(struct tdb_context *, tdb_off_t , int );
143 int (*tdb_expand_file)(struct tdb_context *, tdb_off_t , tdb_off_t );
144 int (*tdb_brlock)(struct tdb_context *, tdb_off_t , int, int, int, size_t);
148 char *name; /* the name of the database */
149 void *map_ptr; /* where it is currently mapped */
150 int fd; /* open file descriptor for the database */
151 tdb_len_t map_size; /* how much space has been mapped */
152 int read_only; /* opened read-only */
153 int traverse_read; /* read-only traversal */
154 int traverse_write; /* read-write traversal */
155 struct tdb_lock_type global_lock;
157 struct tdb_lock_type *lockrecs; /* only real locks, all with count>0 */
158 enum TDB_ERROR ecode; /* error code for last tdb error */
159 struct tdb_header header; /* a cached copy of the header */
160 uint32_t flags; /* the flags passed to tdb_open */
161 struct tdb_traverse_lock travlocks; /* current traversal locks */
162 struct tdb_context *next; /* all tdbs to avoid multiple opens */
163 dev_t device; /* uniquely identifies this tdb */
164 ino_t inode; /* uniquely identifies this tdb */
165 struct tdb_logging_context log;
166 unsigned int (*hash_fn)(TDB_DATA *key);
167 int open_flags; /* flags used in the open - needed by reopen */
168 unsigned int num_locks; /* number of chain locks held */
169 const struct tdb_methods *methods;
170 struct tdb_transaction *transaction;
172 int max_dead_records;
173 bool have_transaction_lock;
174 volatile sig_atomic_t *interrupt_sig_ptr;
181 int tdb_munmap(struct tdb_context *tdb);
182 void tdb_mmap(struct tdb_context *tdb);
183 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
184 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
185 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
186 int tdb_brlock(struct tdb_context *tdb, tdb_off_t offset, int rw_type, int lck_type, int probe, size_t len);
187 int tdb_transaction_lock(struct tdb_context *tdb, int ltype, bool block);
188 int tdb_transaction_unlock(struct tdb_context *tdb);
189 int tdb_brlock_upgrade(struct tdb_context *tdb, tdb_off_t offset, size_t len);
190 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
191 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
192 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
193 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
194 void *tdb_convert(void *buf, uint32_t size);
195 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
196 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct list_struct *rec);
197 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
198 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
199 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
200 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
201 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
202 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
203 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct list_struct *rec);
204 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
205 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
206 tdb_off_t offset, tdb_len_t len,
207 int (*parser)(TDB_DATA key, TDB_DATA data,
210 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
211 struct list_struct *rec);
212 void tdb_io_init(struct tdb_context *tdb);
213 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
214 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
215 struct list_struct *rec);
216 void tdb_header_hash(struct tdb_context *tdb,
217 uint32_t *magic1_hash, uint32_t *magic2_hash);
218 unsigned int tdb_old_hash(TDB_DATA *key);