git.ozlabs.org Git - ccan/blob - 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 /**** FIXME: Type overrides for tdb2, for transition! */
  32 #define tdb_logerr(tdb, ecode, level, ...) \
  33         tdb_logerr((struct tdb_context *)(tdb), (ecode), (level), __VA_ARGS__)
  34
  35 #define tdb_error(tdb) \
  36         tdb_error((struct tdb_context *)(tdb))
  37
  38 #define tdb_brlock(tdb1, rw_type, offset, len, flags)   \
  39         tdb_brlock((struct tdb_context *)(tdb1),        \
  40                    (rw_type), (offset), (len), (flags))
  41
  42 #define tdb_brunlock(tdb1, rw_type, offset, len) \
  43         tdb_brunlock((struct tdb_context *)(tdb1), (rw_type), (offset), (len))
  44
  45 #define tdb_nest_lock(tdb1, offset, ltype, flags)       \
  46         tdb_nest_lock((struct tdb_context *)(tdb1), (offset), (ltype), (flags))
  47
  48 #define tdb_nest_unlock(tdb1, offset, ltype)    \
  49         tdb_nest_unlock((struct tdb_context *)(tdb1), (offset), (ltype))
  50
  51 #define tdb_allrecord_lock(tdb1, offset, flags, upgradable)             \
  52         tdb_allrecord_lock((struct tdb_context *)(tdb1),                \
  53                            (offset), (flags), (upgradable))
  54
  55 #define tdb_allrecord_unlock(tdb1, ltype)                               \
  56         tdb_allrecord_unlock((struct tdb_context *)(tdb1), (ltype))
  57
  58 #define tdb_allrecord_upgrade(tdb1, start)                              \
  59         tdb_allrecord_upgrade((struct tdb_context *)(tdb1), (start))
  60
  61 #define tdb_lock_gradual(tdb1, ltype, flags, off, len)  \
  62         tdb_lock_gradual((struct tdb_context *)(tdb1),  \
  63                          (ltype), (flags), (off), (len))
  64 /***** END FIXME ***/
  65
  66 #include <limits.h>
  67
  68 /* #define TDB_TRACE 1 */
  69 #ifndef HAVE_GETPAGESIZE
  70 #define getpagesize() 0x2000
  71 #endif
  72
  73 #ifndef __STRING
  74 #define __STRING(x)    #x
  75 #endif
  76
  77 #ifndef __STRINGSTRING
  78 #define __STRINGSTRING(x) __STRING(x)
  79 #endif
  80
  81 #ifndef __location__
  82 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
  83 #endif
  84
  85 typedef uint32_t tdb1_len_t;
  86 typedef uint32_t tdb1_off_t;
  87
  88 #ifndef offsetof
  89 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
  90 #endif
  91
  92 #define TDB1_VERSION (0x26011967 + 6)
  93 #define TDB1_MAGIC (0x26011999U)
  94 #define TDB1_FREE_MAGIC (~TDB1_MAGIC)
  95 #define TDB1_DEAD_MAGIC (0xFEE1DEAD)
  96 #define TDB1_RECOVERY_MAGIC (0xf53bc0e7U)
  97 #define TDB1_RECOVERY_INVALID_MAGIC (0x0)
  98 #define TDB1_HASH_RWLOCK_MAGIC (0xbad1a51U)
  99 #define TDB1_ALIGNMENT 4
 100 #define TDB1_DEFAULT_HASH_SIZE 131
 101 #define TDB1_FREELIST_TOP (sizeof(struct tdb1_header))
 102 #define TDB1_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
 103 #define TDB1_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
 104 #define TDB1_DEAD(r) ((r)->magic == TDB1_DEAD_MAGIC)
 105 #define TDB1_BAD_MAGIC(r) ((r)->magic != TDB1_MAGIC && !TDB1_DEAD(r))
 106 #define TDB1_HASH_TOP(hash) (TDB1_FREELIST_TOP + (TDB1_BUCKET(hash)+1)*sizeof(tdb1_off_t))
 107 #define TDB1_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb1_off_t))
 108 #define TDB1_DATA_START(hash_size) (TDB1_HASH_TOP(hash_size-1) + sizeof(tdb1_off_t))
 109 #define TDB1_RECOVERY_HEAD offsetof(struct tdb1_header, recovery_start)
 110 #define TDB1_SEQNUM_OFS    offsetof(struct tdb1_header, sequence_number)
 111 #define TDB1_PAD_BYTE 0x42
 112 #define TDB1_PAD_U32  0x42424242
 113
 114 /* lock offsets */
 115 #define TDB1_OPEN_LOCK        0
 116 #define TDB1_ACTIVE_LOCK      4
 117 #define TDB1_TRANSACTION_LOCK 8
 118
 119 /* free memory if the pointer is valid and zero the pointer */
 120 #ifndef SAFE_FREE
 121 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
 122 #endif
 123
 124 #define TDB1_BUCKET(hash) ((hash) % tdb->header.hash_size)
 125
 126 #define TDB1_DOCONV() (tdb->flags & TDB_CONVERT)
 127 #define TDB1_CONV(x) (TDB1_DOCONV() ? tdb1_convert(&x, sizeof(x)) : &x)
 128
 129 /* the body of the database is made of one tdb1_record for the free space
 130    plus a separate data list for each hash value */
 131 struct tdb1_record {
 132         tdb1_off_t next; /* offset of the next record in the list */
 133         tdb1_len_t rec_len; /* total byte length of record */
 134         tdb1_len_t key_len; /* byte length of key */
 135         tdb1_len_t data_len; /* byte length of data */
 136         uint32_t full_hash; /* the full 32 bit hash of the key */
 137         uint32_t magic;   /* try to catch errors */
 138         /* the following union is implied:
 139                 union {
 140                         char record[rec_len];
 141                         struct {
 142                                 char key[key_len];
 143                                 char data[data_len];
 144                         }
 145                         uint32_t totalsize; (tailer)
 146                 }
 147         */
 148 };
 149
 150
 151 /* this is stored at the front of every database */
 152 struct tdb1_header {
 153         char magic_food[32]; /* for /etc/magic */
 154         uint32_t version; /* version of the code */
 155         uint32_t hash_size; /* number of hash entries */
 156         tdb1_off_t rwlocks; /* obsolete - kept to detect old formats */
 157         tdb1_off_t recovery_start; /* offset of transaction recovery region */
 158         tdb1_off_t sequence_number; /* used when TDB1_SEQNUM is set */
 159         uint32_t magic1_hash; /* hash of TDB_MAGIC_FOOD. */
 160         uint32_t magic2_hash; /* hash of TDB1_MAGIC. */
 161         tdb1_off_t reserved[27];
 162 };
 163
 164 struct tdb1_traverse_lock {
 165         struct tdb1_traverse_lock *next;
 166         uint32_t off;
 167         uint32_t hash;
 168         int lock_rw;
 169 };
 170
 171 struct tdb1_context;
 172
 173 struct tdb1_methods {
 174         int (*tdb1_read)(struct tdb1_context *, tdb1_off_t , void *, tdb1_len_t , int );
 175         int (*tdb1_write)(struct tdb1_context *, tdb1_off_t, const void *, tdb1_len_t);
 176         void (*next_hash_chain)(struct tdb1_context *, uint32_t *);
 177         int (*tdb1_oob)(struct tdb1_context *, tdb1_off_t , int );
 178         int (*tdb1_expand_file)(struct tdb1_context *, tdb1_off_t , tdb1_off_t );
 179 };
 180
 181 struct tdb1_context {
 182         struct tdb1_context *next;
 183
 184         char *name; /* the name of the database */
 185
 186         /* Logging function */
 187         void (*log_fn)(struct tdb1_context *tdb,
 188                        enum tdb_log_level level,
 189                        enum TDB_ERROR ecode,
 190                        const char *message,
 191                        void *data);
 192         void *log_data;
 193
 194         /* Last error we returned. */
 195         enum TDB_ERROR last_error; /* error code for last tdb error */
 196
 197         /* The actual file information */
 198         struct tdb_file *file;
 199
 200         int open_flags; /* flags used in the open - needed by reopen */
 201
 202         /* low level (fnctl) lock functions. */
 203         int (*lock_fn)(int fd, int rw, off_t off, off_t len, bool w, void *);
 204         int (*unlock_fn)(int fd, int rw, off_t off, off_t len, void *);
 205         void *lock_data;
 206
 207         uint32_t flags; /* the flags passed to tdb1_open */
 208
 209         /* Our statistics. */
 210         struct tdb_attribute_stats stats;
 211
 212         bool read_only; /* opened read-only */
 213         int traverse_read; /* read-only traversal */
 214         int traverse_write; /* read-write traversal */
 215         struct tdb1_header header; /* a cached copy of the header */
 216         struct tdb1_traverse_lock travlocks; /* current traversal locks */
 217         unsigned int (*hash_fn)(TDB_DATA *key);
 218         const struct tdb1_methods *methods;
 219         struct tdb1_transaction *transaction;
 220         int page_size;
 221         int max_dead_records;
 222 };
 223
 224 /*
 225   internal prototypes
 226 */
 227 int tdb1_munmap(struct tdb1_context *tdb);
 228 void tdb1_mmap(struct tdb1_context *tdb);
 229 int tdb1_lock(struct tdb1_context *tdb, int list, int ltype);
 230 int tdb1_nest_lock(struct tdb1_context *tdb, uint32_t offset, int ltype,
 231                   enum tdb_lock_flags flags);
 232 int tdb1_nest_unlock(struct tdb1_context *tdb, uint32_t offset, int ltype);
 233 int tdb1_unlock(struct tdb1_context *tdb, int list, int ltype);
 234 int tdb1_brlock(struct tdb1_context *tdb,
 235                int rw_type, tdb1_off_t offset, size_t len,
 236                enum tdb_lock_flags flags);
 237 int tdb1_brunlock(struct tdb1_context *tdb,
 238                  int rw_type, tdb1_off_t offset, size_t len);
 239 bool tdb1_have_extra_locks(struct tdb1_context *tdb);
 240 void tdb1_release_transaction_locks(struct tdb1_context *tdb);
 241 int tdb1_transaction_lock(struct tdb1_context *tdb, int ltype,
 242                          enum tdb_lock_flags lockflags);
 243 int tdb1_transaction_unlock(struct tdb1_context *tdb, int ltype);
 244 int tdb1_recovery_area(struct tdb1_context *tdb,
 245                       const struct tdb1_methods *methods,
 246                       tdb1_off_t *recovery_offset,
 247                       struct tdb1_record *rec);
 248 int tdb1_allrecord_lock(struct tdb1_context *tdb, int ltype,
 249                        enum tdb_lock_flags flags, bool upgradable);
 250 int tdb1_allrecord_unlock(struct tdb1_context *tdb, int ltype);
 251 int tdb1_allrecord_upgrade(struct tdb1_context *tdb);
 252 int tdb1_write_lock_record(struct tdb1_context *tdb, tdb1_off_t off);
 253 int tdb1_write_unlock_record(struct tdb1_context *tdb, tdb1_off_t off);
 254 int tdb1_ofs_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 255 int tdb1_ofs_write(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 256 void *tdb1_convert(void *buf, uint32_t size);
 257 int tdb1_free(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 258 tdb1_off_t tdb1_allocate(struct tdb1_context *tdb, tdb1_len_t length, struct tdb1_record *rec);
 259 int tdb1_ofs_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 260 int tdb1_ofs_write(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 261 int tdb1_lock_record(struct tdb1_context *tdb, tdb1_off_t off);
 262 int tdb1_unlock_record(struct tdb1_context *tdb, tdb1_off_t off);
 263 bool tdb1_needs_recovery(struct tdb1_context *tdb);
 264 int tdb1_rec_read(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 265 int tdb1_rec_write(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 266 int tdb1_do_delete(struct tdb1_context *tdb, tdb1_off_t rec_ptr, struct tdb1_record *rec);
 267 unsigned char *tdb1_alloc_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_len_t len);
 268 int tdb1_parse_data(struct tdb1_context *tdb, TDB_DATA key,
 269                    tdb1_off_t offset, tdb1_len_t len,
 270                    int (*parser)(TDB_DATA key, TDB_DATA data,
 271                                  void *private_data),
 272                    void *private_data);
 273 tdb1_off_t tdb1_find_lock_hash(struct tdb1_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
 274                            struct tdb1_record *rec);
 275 void tdb1_io_init(struct tdb1_context *tdb);
 276 int tdb1_expand(struct tdb1_context *tdb, tdb1_off_t size);
 277 int tdb1_rec_free_read(struct tdb1_context *tdb, tdb1_off_t off,
 278                       struct tdb1_record *rec);
 279 bool tdb1_write_all(int fd, const void *buf, size_t count);
 280 int tdb1_transaction_recover(struct tdb1_context *tdb);
 281 void tdb1_header_hash(struct tdb1_context *tdb,
 282                      uint32_t *magic1_hash, uint32_t *magic2_hash);
 283 unsigned int tdb1_old_hash(TDB_DATA *key);
 284 size_t tdb1_dead_space(struct tdb1_context *tdb, tdb1_off_t off);
 285 #endif /* CCAN_TDB2_TDB1_PRIVATE_H */