tdb2: add TDB_ATTRIBUTE_TDB1_HASHSIZE
[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 #include "private.h"
29 #include "tdb1.h"
30
31 #include <limits.h>
32
33 /* #define TDB_TRACE 1 */
34 #ifndef HAVE_GETPAGESIZE
35 #define getpagesize() 0x2000
36 #endif
37
38 #ifndef __STRING
39 #define __STRING(x)    #x
40 #endif
41
42 #ifndef __STRINGSTRING
43 #define __STRINGSTRING(x) __STRING(x)
44 #endif
45
46 #ifndef __location__
47 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
48 #endif
49
50 #ifndef offsetof
51 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
52 #endif
53
54 #define TDB1_VERSION (0x26011967 + 6)
55 #define TDB1_MAGIC (0x26011999U)
56 #define TDB1_FREE_MAGIC (~TDB1_MAGIC)
57 #define TDB1_DEAD_MAGIC (0xFEE1DEAD)
58 #define TDB1_RECOVERY_MAGIC (0xf53bc0e7U)
59 #define TDB1_RECOVERY_INVALID_MAGIC (0x0)
60 #define TDB1_HASH_RWLOCK_MAGIC (0xbad1a51U)
61 #define TDB1_ALIGNMENT 4
62 #define TDB1_DEFAULT_HASH_SIZE 131
63 #define TDB1_FREELIST_TOP (sizeof(struct tdb1_header))
64 #define TDB1_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
65 #define TDB1_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
66 #define TDB1_DEAD(r) ((r)->magic == TDB1_DEAD_MAGIC)
67 #define TDB1_BAD_MAGIC(r) ((r)->magic != TDB1_MAGIC && !TDB1_DEAD(r))
68 #define TDB1_HASH_TOP(hash) (TDB1_FREELIST_TOP + (TDB1_BUCKET(hash)+1)*sizeof(tdb1_off_t))
69 #define TDB1_HASHTABLE_SIZE(tdb) ((tdb->tdb1.header.hash_size+1)*sizeof(tdb1_off_t))
70 #define TDB1_DATA_START(hash_size) (TDB1_HASH_TOP(hash_size-1) + sizeof(tdb1_off_t))
71 #define TDB1_RECOVERY_HEAD offsetof(struct tdb1_header, recovery_start)
72 #define TDB1_SEQNUM_OFS    offsetof(struct tdb1_header, sequence_number)
73 #define TDB1_PAD_BYTE 0x42
74 #define TDB1_PAD_U32  0x42424242
75
76 /* lock offsets */
77 #define TDB1_OPEN_LOCK        0
78 #define TDB1_ACTIVE_LOCK      4
79 #define TDB1_TRANSACTION_LOCK 8
80
81 /* free memory if the pointer is valid and zero the pointer */
82 #ifndef SAFE_FREE
83 #define SAFE_FREE(x) do { if ((x) != NULL) {free((void *)x); (x)=NULL;} } while(0)
84 #endif
85
86 #define TDB1_BUCKET(hash) ((hash) % tdb->tdb1.header.hash_size)
87
88 #define TDB1_DOCONV() (tdb->flags & TDB_CONVERT)
89 #define TDB1_CONV(x) (TDB1_DOCONV() ? tdb1_convert(&x, sizeof(x)) : &x)
90
91 /* the body of the database is made of one tdb1_record for the free space
92    plus a separate data list for each hash value */
93 struct tdb1_record {
94         tdb1_off_t next; /* offset of the next record in the list */
95         tdb1_len_t rec_len; /* total byte length of record */
96         tdb1_len_t key_len; /* byte length of key */
97         tdb1_len_t data_len; /* byte length of data */
98         uint32_t full_hash; /* the full 32 bit hash of the key */
99         uint32_t magic;   /* try to catch errors */
100         /* the following union is implied:
101                 union {
102                         char record[rec_len];
103                         struct {
104                                 char key[key_len];
105                                 char data[data_len];
106                         }
107                         uint32_t totalsize; (tailer)
108                 }
109         */
110 };
111
112
113 struct tdb1_methods {
114         int (*tdb1_read)(struct tdb_context *, tdb1_off_t , void *, tdb1_len_t , int );
115         int (*tdb1_write)(struct tdb_context *, tdb1_off_t, const void *, tdb1_len_t);
116         void (*next_hash_chain)(struct tdb_context *, uint32_t *);
117         int (*tdb1_oob)(struct tdb_context *, tdb1_off_t , int );
118         int (*tdb1_expand_file)(struct tdb_context *, tdb1_off_t , tdb1_off_t );
119 };
120
121
122 /*
123   internal prototypes
124 */
125 int tdb1_munmap(struct tdb_context *tdb);
126 void tdb1_mmap(struct tdb_context *tdb);
127 int tdb1_lock(struct tdb_context *tdb, int list, int ltype);
128 int tdb1_nest_lock(struct tdb_context *tdb, uint32_t offset, int ltype,
129                   enum tdb_lock_flags flags);
130 int tdb1_nest_unlock(struct tdb_context *tdb, uint32_t offset, int ltype);
131 int tdb1_unlock(struct tdb_context *tdb, int list, int ltype);
132 int tdb1_brlock(struct tdb_context *tdb,
133                int rw_type, tdb1_off_t offset, size_t len,
134                enum tdb_lock_flags flags);
135 int tdb1_brunlock(struct tdb_context *tdb,
136                  int rw_type, tdb1_off_t offset, size_t len);
137 bool tdb1_have_extra_locks(struct tdb_context *tdb);
138 void tdb1_release_transaction_locks(struct tdb_context *tdb);
139 int tdb1_transaction_lock(struct tdb_context *tdb, int ltype,
140                          enum tdb_lock_flags lockflags);
141 int tdb1_transaction_unlock(struct tdb_context *tdb, int ltype);
142 int tdb1_recovery_area(struct tdb_context *tdb,
143                       const struct tdb1_methods *methods,
144                       tdb1_off_t *recovery_offset,
145                       struct tdb1_record *rec);
146 int tdb1_allrecord_lock(struct tdb_context *tdb, int ltype,
147                        enum tdb_lock_flags flags, bool upgradable);
148 int tdb1_allrecord_unlock(struct tdb_context *tdb, int ltype);
149 int tdb1_allrecord_upgrade(struct tdb_context *tdb);
150 int tdb1_write_lock_record(struct tdb_context *tdb, tdb1_off_t off);
151 int tdb1_write_unlock_record(struct tdb_context *tdb, tdb1_off_t off);
152 int tdb1_ofs_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
153 int tdb1_ofs_write(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
154 void *tdb1_convert(void *buf, uint32_t size);
155 int tdb1_free(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
156 tdb1_off_t tdb1_allocate(struct tdb_context *tdb, tdb1_len_t length, struct tdb1_record *rec);
157 int tdb1_ofs_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
158 int tdb1_ofs_write(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
159 int tdb1_lock_record(struct tdb_context *tdb, tdb1_off_t off);
160 int tdb1_unlock_record(struct tdb_context *tdb, tdb1_off_t off);
161 bool tdb1_needs_recovery(struct tdb_context *tdb);
162 int tdb1_rec_read(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
163 int tdb1_rec_write(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
164 int tdb1_do_delete(struct tdb_context *tdb, tdb1_off_t rec_ptr, struct tdb1_record *rec);
165 unsigned char *tdb1_alloc_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_len_t len);
166 int tdb1_parse_data(struct tdb_context *tdb, TDB_DATA key,
167                    tdb1_off_t offset, tdb1_len_t len,
168                    int (*parser)(TDB_DATA key, TDB_DATA data,
169                                  void *private_data),
170                    void *private_data);
171 tdb1_off_t tdb1_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
172                            struct tdb1_record *rec);
173 void tdb1_io_init(struct tdb_context *tdb);
174 int tdb1_expand(struct tdb_context *tdb, tdb1_off_t size);
175 int tdb1_rec_free_read(struct tdb_context *tdb, tdb1_off_t off,
176                       struct tdb1_record *rec);
177 bool tdb1_write_all(int fd, const void *buf, size_t count);
178 int tdb1_transaction_recover(struct tdb_context *tdb);
179 void tdb1_header_hash(struct tdb_context *tdb,
180                      uint32_t *magic1_hash, uint32_t *magic2_hash);
181 uint64_t tdb1_old_hash(const void *key, size_t len, uint64_t seed, void *);
182 size_t tdb1_dead_space(struct tdb_context *tdb, tdb1_off_t off);
183 #endif /* CCAN_TDB2_TDB1_PRIVATE_H */