8e246e32832161ab86f92857689a4cb9626d110e
[ira/wip.git] / source / lib / tdb / common / tdb_private.h
1  /* 
2    Unix SMB/CIFS implementation.
3
4    trivial database library - private includes
5
6    Copyright (C) Andrew Tridgell              2005
7    
8      ** NOTE! The following LGPL license applies to the tdb
9      ** library. This does NOT imply that all of Samba is released
10      ** under the LGPL
11    
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 2 of the License, or (at your option) any later version.
16
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.
21
22    You should have received a copy of the GNU Lesser General Public
23    License along with this library; if not, write to the Free Software
24    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25 */
26
27 #ifndef _SAMBA_BUILD_
28 #if HAVE_CONFIG_H
29 #include <config.h>
30 #endif
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <stdint.h>
35 #include <fcntl.h>
36 #include <unistd.h>
37 #include <string.h>
38 #include <fcntl.h>
39 #include <errno.h>
40 #include <sys/mman.h>
41 #include <sys/stat.h>
42 #include "tdbconfig.h"
43 #include "tdb.h"
44 #else
45 #include "includes.h"
46 #include "lib/tdb/include/tdb.h"
47 #include "system/time.h"
48 #include "system/shmem.h"
49 #include "system/filesys.h"
50 #endif
51
52 #ifndef u32
53 #define u32 unsigned
54 #endif
55
56 typedef u32 tdb_len_t;
57 typedef u32 tdb_off_t;
58
59 #define TDB_MAGIC_FOOD "TDB file\n"
60 #define TDB_VERSION (0x26011967 + 6)
61 #define TDB_MAGIC (0x26011999U)
62 #define TDB_FREE_MAGIC (~TDB_MAGIC)
63 #define TDB_DEAD_MAGIC (0xFEE1DEAD)
64 #define TDB_ALIGNMENT 4
65 #define MIN_REC_SIZE (2*sizeof(struct list_struct) + TDB_ALIGNMENT)
66 #define DEFAULT_HASH_SIZE 131
67 #define TDB_PAGE_SIZE 0x2000
68 #define FREELIST_TOP (sizeof(struct tdb_header))
69 #define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
70 #define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
71 #define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
72 #define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
73 #define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off_t))
74 #define TDB_DATA_START(hash_size) TDB_HASH_TOP(hash_size-1)
75
76
77 /* NB assumes there is a local variable called "tdb" that is the
78  * current context, also takes doubly-parenthesized print-style
79  * argument. */
80 #define TDB_LOG(x) tdb->log_fn x
81
82 /* lock offsets */
83 #define GLOBAL_LOCK 0
84 #define ACTIVE_LOCK 4
85
86 #ifndef MAP_FILE
87 #define MAP_FILE 0
88 #endif
89
90 #ifndef MAP_FAILED
91 #define MAP_FAILED ((void *)-1)
92 #endif
93
94 #ifndef discard_const_p
95 # if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
96 #  define discard_const(ptr) ((void *)((intptr_t)(ptr)))
97 # else
98 #  define discard_const(ptr) ((void *)(ptr))
99 # endif
100 # define discard_const_p(type, ptr) ((type *)discard_const(ptr))
101 #endif
102
103 /* free memory if the pointer is valid and zero the pointer */
104 #ifndef SAFE_FREE
105 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
106 #endif
107
108 #define BUCKET(hash) ((hash) % tdb->header.hash_size)
109
110 #define DOCONV() (tdb->flags & TDB_CONVERT)
111 #define CONVERT(x) (DOCONV() ? tdb_convert(&x, sizeof(x)) : &x)
112
113
114 /* the body of the database is made of one list_struct for the free space
115    plus a separate data list for each hash value */
116 struct list_struct {
117         tdb_off_t next; /* offset of the next record in the list */
118         tdb_len_t rec_len; /* total byte length of record */
119         tdb_len_t key_len; /* byte length of key */
120         tdb_len_t data_len; /* byte length of data */
121         u32 full_hash; /* the full 32 bit hash of the key */
122         u32 magic;   /* try to catch errors */
123         /* the following union is implied:
124                 union {
125                         char record[rec_len];
126                         struct {
127                                 char key[key_len];
128                                 char data[data_len];
129                         }
130                         u32 totalsize; (tailer)
131                 }
132         */
133 };
134
135
136 /* this is stored at the front of every database */
137 struct tdb_header {
138         char magic_food[32]; /* for /etc/magic */
139         u32 version; /* version of the code */
140         u32 hash_size; /* number of hash entries */
141         tdb_off_t rwlocks;
142         tdb_off_t reserved[31];
143 };
144
145 struct tdb_lock_type {
146         u32 count;
147         u32 ltype;
148 };
149
150 struct tdb_traverse_lock {
151         struct tdb_traverse_lock *next;
152         u32 off;
153         u32 hash;
154 };
155
156
157 struct tdb_context {
158         char *name; /* the name of the database */
159         void *map_ptr; /* where it is currently mapped */
160         int fd; /* open file descriptor for the database */
161         tdb_len_t map_size; /* how much space has been mapped */
162         int read_only; /* opened read-only */
163         struct tdb_lock_type *locked; /* array of chain locks */
164         enum TDB_ERROR ecode; /* error code for last tdb error */
165         struct tdb_header header; /* a cached copy of the header */
166         u32 flags; /* the flags passed to tdb_open */
167         struct tdb_traverse_lock travlocks; /* current traversal locks */
168         struct tdb_context *next; /* all tdbs to avoid multiple opens */
169         dev_t device;   /* uniquely identifies this tdb */
170         ino_t inode;    /* uniquely identifies this tdb */
171         void (*log_fn)(struct tdb_context *tdb, int level, const char *, ...) PRINTF_ATTRIBUTE(3,4); /* logging function */
172         unsigned int (*hash_fn)(TDB_DATA *key);
173         int open_flags; /* flags used in the open - needed by reopen */
174         struct tdb_transaction *transaction;
175 };
176
177
178 /*
179   internal prototypes
180 */
181 int tdb_munmap(struct tdb_context *tdb);
182 void tdb_mmap(struct tdb_context *tdb);
183 int tdb_read(struct tdb_context *tdb, tdb_off_t off, void *buf, tdb_len_t len, int cv);
184 int tdb_write(struct tdb_context *tdb, tdb_off_t off, void *buf, tdb_len_t len);
185 int tdb_oob(struct tdb_context *tdb, tdb_off_t len, int probe);
186 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
187 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
188 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
189 int tdb_brlock(struct tdb_context *tdb, tdb_off_t offset, int rw_type, int lck_type, int probe);
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, u32 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 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, u32 hash, int locktype,
206                            struct list_struct *rec);
207 void tdb_next_hash_chain(struct tdb_context *tdb, u32 *chain);
208