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 #ifndef _SAMBA_BUILD_
  29 #include "config.h"
  30 /* This keeps us consistent with TDB2 code. */
  31 #if HAVE_FILE_OFFSET_BITS
  32 #define _FILE_OFFSET_BITS 64
  33 #endif
  34 #include <stdint.h>
  35 #include <stdbool.h>
  36 #include <string.h>
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #include <sys/mman.h>
  40 #include <sys/time.h>
  41 #include <fcntl.h>
  42 #include <unistd.h>
  43 #include <errno.h>
  44 #include <stdlib.h>
  45 #include <limits.h>
  46 #include <stdio.h>
  47 #include <utime.h>
  48
  49 #ifndef _PUBLIC_
  50 #define _PUBLIC_
  51 #endif
  52
  53 #else
  54 #include "replace.h"
  55 #include "system/filesys.h"
  56 #include "system/time.h"
  57 #include "system/shmem.h"
  58 #include "system/select.h"
  59 #include "system/wait.h"
  60 #endif
  61
  62 #include "tdb1.h"
  63
  64 /* Temporary wrapper to avoid undue churn in test/ */
  65 #define tdb1_error(tdb) ((tdb)->ecode)
  66
  67 /* #define TDB_TRACE 1 */
  68 #ifndef HAVE_GETPAGESIZE
  69 #define getpagesize() 0x2000
  70 #endif
  71
  72 #ifndef __STRING
  73 #define __STRING(x)    #x
  74 #endif
  75
  76 #ifndef __STRINGSTRING
  77 #define __STRINGSTRING(x) __STRING(x)
  78 #endif
  79
  80 #ifndef __location__
  81 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
  82 #endif
  83
  84 typedef uint32_t tdb1_len_t;
  85 typedef uint32_t tdb1_off_t;
  86
  87 #ifndef offsetof
  88 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
  89 #endif
  90
  91 #define TDB1_MAGIC_FOOD "TDB file\n"
  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 /* NB assumes there is a local variable called "tdb" that is the
 115  * current context, also takes doubly-parenthesized print-style
 116  * argument. */
 117 #define TDB1_LOG(x) tdb->log.log_fn x
 118
 119 /* lock offsets */
 120 #define TDB1_OPEN_LOCK        0
 121 #define TDB1_ACTIVE_LOCK      4
 122 #define TDB1_TRANSACTION_LOCK 8
 123
 124 /* free memory if the pointer is valid and zero the pointer */
 125 #ifndef SAFE_FREE
 126 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
 127 #endif
 128
 129 #define TDB1_BUCKET(hash) ((hash) % tdb->header.hash_size)
 130
 131 #define TDB1_DOCONV() (tdb->flags & TDB1_CONVERT)
 132 #define TDB1_CONV(x) (TDB1_DOCONV() ? tdb1_convert(&x, sizeof(x)) : &x)
 133
 134 /* the body of the database is made of one tdb1_record for the free space
 135    plus a separate data list for each hash value */
 136 struct tdb1_record {
 137         tdb1_off_t next; /* offset of the next record in the list */
 138         tdb1_len_t rec_len; /* total byte length of record */
 139         tdb1_len_t key_len; /* byte length of key */
 140         tdb1_len_t data_len; /* byte length of data */
 141         uint32_t full_hash; /* the full 32 bit hash of the key */
 142         uint32_t magic;   /* try to catch errors */
 143         /* the following union is implied:
 144                 union {
 145                         char record[rec_len];
 146                         struct {
 147                                 char key[key_len];
 148                                 char data[data_len];
 149                         }
 150                         uint32_t totalsize; (tailer)
 151                 }
 152         */
 153 };
 154
 155
 156 /* this is stored at the front of every database */
 157 struct tdb1_header {
 158         char magic_food[32]; /* for /etc/magic */
 159         uint32_t version; /* version of the code */
 160         uint32_t hash_size; /* number of hash entries */
 161         tdb1_off_t rwlocks; /* obsolete - kept to detect old formats */
 162         tdb1_off_t recovery_start; /* offset of transaction recovery region */
 163         tdb1_off_t sequence_number; /* used when TDB1_SEQNUM is set */
 164         uint32_t magic1_hash; /* hash of TDB1_MAGIC_FOOD. */
 165         uint32_t magic2_hash; /* hash of TDB1_MAGIC. */
 166         tdb1_off_t reserved[27];
 167 };
 168
 169 struct tdb1_lock_type {
 170         uint32_t off;
 171         uint32_t count;
 172         uint32_t ltype;
 173 };
 174
 175 struct tdb1_traverse_lock {
 176         struct tdb1_traverse_lock *next;
 177         uint32_t off;
 178         uint32_t hash;
 179         int lock_rw;
 180 };
 181
 182 enum tdb1_lock_flags {
 183         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
 184         TDB1_LOCK_NOWAIT = 0,
 185         TDB1_LOCK_WAIT = 1,
 186         /* If set, don't log an error on failure. */
 187         TDB1_LOCK_PROBE = 2,
 188         /* If set, don't actually lock at all. */
 189         TDB1_LOCK_MARK_ONLY = 4,
 190 };
 191
 192 struct tdb1_context;
 193
 194 struct tdb1_methods {
 195         int (*tdb1_read)(struct tdb1_context *, tdb1_off_t , void *, tdb1_len_t , int );
 196         int (*tdb1_write)(struct tdb1_context *, tdb1_off_t, const void *, tdb1_len_t);
 197         void (*next_hash_chain)(struct tdb1_context *, uint32_t *);
 198         int (*tdb1_oob)(struct tdb1_context *, tdb1_off_t , int );
 199         int (*tdb1_expand_file)(struct tdb1_context *, tdb1_off_t , tdb1_off_t );
 200 };
 201
 202 struct tdb1_context {
 203         char *name; /* the name of the database */
 204         void *map_ptr; /* where it is currently mapped */
 205         int fd; /* open file descriptor for the database */
 206         tdb1_len_t map_size; /* how much space has been mapped */
 207         int read_only; /* opened read-only */
 208         int traverse_read; /* read-only traversal */
 209         int traverse_write; /* read-write traversal */
 210         struct tdb1_lock_type allrecord_lock; /* .offset == upgradable */
 211         int num_lockrecs;
 212         struct tdb1_lock_type *lockrecs; /* only real locks, all with count>0 */
 213         enum TDB1_ERROR ecode; /* error code for last tdb error */
 214         struct tdb1_header header; /* a cached copy of the header */
 215         uint32_t flags; /* the flags passed to tdb1_open */
 216         struct tdb1_traverse_lock travlocks; /* current traversal locks */
 217         struct tdb1_context *next; /* all tdbs to avoid multiple opens */
 218         dev_t device;   /* uniquely identifies this tdb */
 219         ino_t inode;    /* uniquely identifies this tdb */
 220         struct tdb1_logging_context log;
 221         unsigned int (*hash_fn)(TDB1_DATA *key);
 222         int open_flags; /* flags used in the open - needed by reopen */
 223         const struct tdb1_methods *methods;
 224         struct tdb1_transaction *transaction;
 225         int page_size;
 226         int max_dead_records;
 227 };
 228
 229 /*
 230   internal prototypes
 231 */
 232 int tdb1_munmap(struct tdb1_context *tdb);
 233 void tdb1_mmap(struct tdb1_context *tdb);
 234 int tdb1_lock(struct tdb1_context *tdb, int list, int ltype);
 235 int tdb1_nest_lock(struct tdb1_context *tdb, uint32_t offset, int ltype,
 236                   enum tdb1_lock_flags flags);
 237 int tdb1_nest_unlock(struct tdb1_context *tdb, uint32_t offset, int ltype,
 238                     bool mark_lock);
 239 int tdb1_unlock(struct tdb1_context *tdb, int list, int ltype);
 240 int tdb1_brlock(struct tdb1_context *tdb,
 241                int rw_type, tdb1_off_t offset, size_t len,
 242                enum tdb1_lock_flags flags);
 243 int tdb1_brunlock(struct tdb1_context *tdb,
 244                  int rw_type, tdb1_off_t offset, size_t len);
 245 bool tdb1_have_extra_locks(struct tdb1_context *tdb);
 246 void tdb1_release_transaction_locks(struct tdb1_context *tdb);
 247 int tdb1_transaction_lock(struct tdb1_context *tdb, int ltype,
 248                          enum tdb1_lock_flags lockflags);
 249 int tdb1_transaction_unlock(struct tdb1_context *tdb, int ltype);
 250 int tdb1_recovery_area(struct tdb1_context *tdb,
 251                       const struct tdb1_methods *methods,
 252                       tdb1_off_t *recovery_offset,
 253                       struct tdb1_record *rec);
 254 int tdb1_allrecord_lock(struct tdb1_context *tdb, int ltype,
 255                        enum tdb1_lock_flags flags, bool upgradable);
 256 int tdb1_allrecord_unlock(struct tdb1_context *tdb, int ltype, bool mark_lock);
 257 int tdb1_allrecord_upgrade(struct tdb1_context *tdb);
 258 int tdb1_write_lock_record(struct tdb1_context *tdb, tdb1_off_t off);
 259 int tdb1_write_unlock_record(struct tdb1_context *tdb, tdb1_off_t off);
 260 int tdb1_ofs_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 261 int tdb1_ofs_write(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 262 void *tdb1_convert(void *buf, uint32_t size);
 263 int tdb1_free(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 264 tdb1_off_t tdb1_allocate(struct tdb1_context *tdb, tdb1_len_t length, struct tdb1_record *rec);
 265 int tdb1_ofs_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 266 int tdb1_ofs_write(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 267 int tdb1_lock_record(struct tdb1_context *tdb, tdb1_off_t off);
 268 int tdb1_unlock_record(struct tdb1_context *tdb, tdb1_off_t off);
 269 bool tdb1_needs_recovery(struct tdb1_context *tdb);
 270 int tdb1_rec_read(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 271 int tdb1_rec_write(struct tdb1_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 272 int tdb1_do_delete(struct tdb1_context *tdb, tdb1_off_t rec_ptr, struct tdb1_record *rec);
 273 unsigned char *tdb1_alloc_read(struct tdb1_context *tdb, tdb1_off_t offset, tdb1_len_t len);
 274 int tdb1_parse_data(struct tdb1_context *tdb, TDB1_DATA key,
 275                    tdb1_off_t offset, tdb1_len_t len,
 276                    int (*parser)(TDB1_DATA key, TDB1_DATA data,
 277                                  void *private_data),
 278                    void *private_data);
 279 tdb1_off_t tdb1_find_lock_hash(struct tdb1_context *tdb, TDB1_DATA key, uint32_t hash, int locktype,
 280                            struct tdb1_record *rec);
 281 void tdb1_io_init(struct tdb1_context *tdb);
 282 int tdb1_expand(struct tdb1_context *tdb, tdb1_off_t size);
 283 int tdb1_rec_free_read(struct tdb1_context *tdb, tdb1_off_t off,
 284                       struct tdb1_record *rec);
 285 bool tdb1_write_all(int fd, const void *buf, size_t count);
 286 int tdb1_transaction_recover(struct tdb1_context *tdb);
 287 void tdb1_header_hash(struct tdb1_context *tdb,
 288                      uint32_t *magic1_hash, uint32_t *magic2_hash);
 289 unsigned int tdb1_old_hash(TDB1_DATA *key);
 290 size_t tdb1_dead_space(struct tdb1_context *tdb, tdb1_off_t off);
 291 #endif /* CCAN_TDB2_TDB1_PRIVATE_H */