libatalk/tdb/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 3 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, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 #if 0
  27 #include "replace.h"
  28 #include "system/filesys.h"
  29 #include "system/time.h"
  30 #include "system/shmem.h"
  31 #include "system/select.h"
  32 #include "system/wait.h"
  33 #include "tdb.h"
  34 #endif
  35
  36 #include <unistd.h>
  37 #include <stdint.h>
  38 #include <stdbool.h>
  39 #include <sys/stat.h>
  40 #include <fcntl.h>
  41 #include <sys/select.h>
  42 #include <sys/mman.h>
  43 #include <sys/time.h>
  44 #include <time.h>
  45 #include <utime.h>
  46 #include <sys/wait.h>
  47 #include <string.h>
  48 #include <stdlib.h>
  49 #include <limits.h>
  50 #include <stdio.h>
  51 #include <errno.h>
  52 #include <sys/param.h>
  53
  54 #ifndef __STRING
  55 #define __STRING(x)    #x
  56 #endif
  57
  58 #ifndef __STRINGSTRING
  59 #define __STRINGSTRING(x) __STRING(x)
  60 #endif
  61
  62 #ifndef __LINESTR__
  63 #define __LINESTR__ __STRINGSTRING(__LINE__)
  64 #endif
  65
  66 #ifndef __location__
  67 #define __location__ __FILE__ ":" __LINESTR__
  68 #endif
  69
  70 #include "atalk/tdb.h"
  71
  72 /* #define TDB_TRACE 1 */
  73 #ifndef HAVE_GETPAGESIZE
  74 #define getpagesize() 0x2000
  75 #endif
  76
  77 typedef uint32_t tdb_len_t;
  78 typedef uint32_t tdb_off_t;
  79
  80 #ifndef offsetof
  81 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
  82 #endif
  83
  84 #define TDB_MAGIC_FOOD "TDB file\n"
  85 #define TDB_VERSION (0x26011967 + 6)
  86 #define TDB_MAGIC (0x26011999U)
  87 #define TDB_FREE_MAGIC (~TDB_MAGIC)
  88 #define TDB_DEAD_MAGIC (0xFEE1DEAD)
  89 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
  90 #define TDB_ALIGNMENT 4
  91 #define DEFAULT_HASH_SIZE 131
  92 #define FREELIST_TOP (sizeof(struct tdb_header))
  93 #define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
  94 #define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
  95 #define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
  96 #define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
  97 #define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off_t))
  98 #define TDB_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb_off_t))
  99 #define TDB_DATA_START(hash_size) (TDB_HASH_TOP(hash_size-1) + sizeof(tdb_off_t))
 100 #define TDB_RECOVERY_HEAD offsetof(struct tdb_header, recovery_start)
 101 #define TDB_SEQNUM_OFS    offsetof(struct tdb_header, sequence_number)
 102 #define TDB_PAD_BYTE 0x42
 103 #define TDB_PAD_U32  0x42424242
 104
 105 /* NB assumes there is a local variable called "tdb" that is the
 106  * current context, also takes doubly-parenthesized print-style
 107  * argument. */
 108 #define TDB_LOG(x) tdb->log.log_fn x
 109
 110 #ifdef TDB_TRACE
 111 void tdb_trace(struct tdb_context *tdb, const char *op);
 112 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
 113 void tdb_trace_open(struct tdb_context *tdb, const char *op,
 114                     unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
 115 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
 116 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
 117 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
 118                     TDB_DATA rec);
 119 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
 120                         TDB_DATA rec, int ret);
 121 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
 122                            TDB_DATA rec, TDB_DATA ret);
 123 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
 124                              TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
 125                              int ret);
 126 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
 127                            TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
 128 #else
 129 #define tdb_trace(tdb, op)
 130 #define tdb_trace_seqnum(tdb, seqnum, op)
 131 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
 132 #define tdb_trace_ret(tdb, op, ret)
 133 #define tdb_trace_retrec(tdb, op, ret)
 134 #define tdb_trace_1rec(tdb, op, rec)
 135 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
 136 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
 137 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
 138 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
 139 #endif /* !TDB_TRACE */
 140
 141 /* lock offsets */
 142 #define GLOBAL_LOCK      0
 143 #define ACTIVE_LOCK      4
 144 #define TRANSACTION_LOCK 8
 145
 146 /* free memory if the pointer is valid and zero the pointer */
 147 #ifndef SAFE_FREE
 148 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
 149 #endif
 150
 151 #define BUCKET(hash) ((hash) % tdb->header.hash_size)
 152
 153 #define DOCONV() (tdb->flags & TDB_CONVERT)
 154 #define CONVERT(x) (DOCONV() ? tdb_convert(&x, sizeof(x)) : &x)
 155
 156
 157 /* the body of the database is made of one tdb_record for the free space
 158    plus a separate data list for each hash value */
 159 struct tdb_record {
 160         tdb_off_t next; /* offset of the next record in the list */
 161         tdb_len_t rec_len; /* total byte length of record */
 162         tdb_len_t key_len; /* byte length of key */
 163         tdb_len_t data_len; /* byte length of data */
 164         uint32_t full_hash; /* the full 32 bit hash of the key */
 165         uint32_t magic;   /* try to catch errors */
 166         /* the following union is implied:
 167                 union {
 168                         char record[rec_len];
 169                         struct {
 170                                 char key[key_len];
 171                                 char data[data_len];
 172                         }
 173                         uint32_t totalsize; (tailer)
 174                 }
 175         */
 176 };
 177
 178
 179 /* this is stored at the front of every database */
 180 struct tdb_header {
 181         char magic_food[32]; /* for /etc/magic */
 182         uint32_t version; /* version of the code */
 183         uint32_t hash_size; /* number of hash entries */
 184         tdb_off_t rwlocks; /* obsolete - kept to detect old formats */
 185         tdb_off_t recovery_start; /* offset of transaction recovery region */
 186         tdb_off_t sequence_number; /* used when TDB_SEQNUM is set */
 187         tdb_off_t reserved[29];
 188 };
 189
 190 struct tdb_lock_type {
 191         int list;
 192         uint32_t count;
 193         uint32_t ltype;
 194 };
 195
 196 struct tdb_traverse_lock {
 197         struct tdb_traverse_lock *next;
 198         uint32_t off;
 199         uint32_t hash;
 200         int lock_rw;
 201 };
 202
 203
 204 struct tdb_methods {
 205         int (*tdb_read)(struct tdb_context *, tdb_off_t , void *, tdb_len_t , int );
 206         int (*tdb_write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
 207         void (*next_hash_chain)(struct tdb_context *, uint32_t *);
 208         int (*tdb_oob)(struct tdb_context *, tdb_off_t , int );
 209         int (*tdb_expand_file)(struct tdb_context *, tdb_off_t , tdb_off_t );
 210         int (*tdb_brlock)(struct tdb_context *, tdb_off_t , int, int, int, size_t);
 211 };
 212
 213 struct tdb_context {
 214         char *name; /* the name of the database */
 215         void *map_ptr; /* where it is currently mapped */
 216         int fd; /* open file descriptor for the database */
 217         tdb_len_t map_size; /* how much space has been mapped */
 218         int read_only; /* opened read-only */
 219         int traverse_read; /* read-only traversal */
 220         int traverse_write; /* read-write traversal */
 221         struct tdb_lock_type global_lock;
 222         int num_lockrecs;
 223         struct tdb_lock_type *lockrecs; /* only real locks, all with count>0 */
 224         enum TDB_ERROR ecode; /* error code for last tdb error */
 225         struct tdb_header header; /* a cached copy of the header */
 226         uint32_t flags; /* the flags passed to tdb_open */
 227         struct tdb_traverse_lock travlocks; /* current traversal locks */
 228         struct tdb_context *next; /* all tdbs to avoid multiple opens */
 229         dev_t device;   /* uniquely identifies this tdb */
 230         ino_t inode;    /* uniquely identifies this tdb */
 231         struct tdb_logging_context log;
 232         unsigned int (*hash_fn)(TDB_DATA *key);
 233         int open_flags; /* flags used in the open - needed by reopen */
 234         unsigned int num_locks; /* number of chain locks held */
 235         const struct tdb_methods *methods;
 236         struct tdb_transaction *transaction;
 237         int page_size;
 238         int max_dead_records;
 239         int transaction_lock_count;
 240 #ifdef TDB_TRACE
 241         int tracefd;
 242 #endif
 243         volatile sig_atomic_t *interrupt_sig_ptr;
 244 };
 245
 246
 247 /*
 248   internal prototypes
 249 */
 250 int tdb_munmap(struct tdb_context *tdb);
 251 void tdb_mmap(struct tdb_context *tdb);
 252 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
 253 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
 254 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
 255 int tdb_brlock(struct tdb_context *tdb, tdb_off_t offset, int rw_type, int lck_type, int probe, size_t len);
 256 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
 257 int tdb_transaction_unlock(struct tdb_context *tdb);
 258 int tdb_brlock_upgrade(struct tdb_context *tdb, tdb_off_t offset, size_t len);
 259 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
 260 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
 261 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 262 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 263 void *tdb_convert(void *buf, uint32_t size);
 264 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
 265 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct tdb_record *rec);
 266 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 267 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 268 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
 269 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
 270 int _tdb_transaction_cancel(struct tdb_context *tdb);
 271 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
 272 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
 273 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct tdb_record *rec);
 274 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
 275 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
 276                    tdb_off_t offset, tdb_len_t len,
 277                    int (*parser)(TDB_DATA key, TDB_DATA data,
 278                                  void *private_data),
 279                    void *private_data);
 280 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
 281                            struct tdb_record *rec);
 282 void tdb_io_init(struct tdb_context *tdb);
 283 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
 284 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
 285                       struct tdb_record *rec);
 286
 287