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 #define _XOPEN_SOURCE 500
  33
  34 #include <stdlib.h>
  35 #include <stdio.h>
  36 #include <stdint.h>
  37 #include <fcntl.h>
  38 #include <unistd.h>
  39 #include <string.h>
  40 #include <fcntl.h>
  41 #include <errno.h>
  42 #include <sys/mman.h>
  43 #include <sys/stat.h>
  44 #include "config.h"
  45 #include "tdb.h"
  46 #else
  47 #include "includes.h"
  48 #include "lib/tdb/include/tdb.h"
  49 #include "system/time.h"
  50 #include "system/shmem.h"
  51 #include "system/filesys.h"
  52 #endif
  53
  54 #ifndef u32
  55 #define u32 unsigned
  56 #endif
  57
  58 typedef u32 tdb_len_t;
  59 typedef u32 tdb_off_t;
  60
  61 #ifndef offsetof
  62 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
  63 #endif
  64
  65 #define TDB_MAGIC_FOOD "TDB file\n"
  66 #define TDB_VERSION (0x26011967 + 6)
  67 #define TDB_MAGIC (0x26011999U)
  68 #define TDB_FREE_MAGIC (~TDB_MAGIC)
  69 #define TDB_DEAD_MAGIC (0xFEE1DEAD)
  70 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
  71 #define TDB_ALIGNMENT 4
  72 #define MIN_REC_SIZE (2*sizeof(struct list_struct) + TDB_ALIGNMENT)
  73 #define DEFAULT_HASH_SIZE 131
  74 #define FREELIST_TOP (sizeof(struct tdb_header))
  75 #define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
  76 #define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
  77 #define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
  78 #define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
  79 #define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off_t))
  80 #define TDB_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb_off_t))
  81 #define TDB_DATA_START(hash_size) TDB_HASH_TOP(hash_size-1)
  82 #define TDB_RECOVERY_HEAD offsetof(struct tdb_header, recovery_start)
  83 #define TDB_PAD_BYTE 0x42
  84 #define TDB_PAD_U32  0x42424242
  85
  86 /* NB assumes there is a local variable called "tdb" that is the
  87  * current context, also takes doubly-parenthesized print-style
  88  * argument. */
  89 #define TDB_LOG(x) tdb->log_fn x
  90
  91 /* lock offsets */
  92 #define GLOBAL_LOCK      0
  93 #define ACTIVE_LOCK      4
  94 #define TRANSACTION_LOCK 8
  95
  96 #ifndef MAP_FILE
  97 #define MAP_FILE 0
  98 #endif
  99
 100 #ifndef MAP_FAILED
 101 #define MAP_FAILED ((void *)-1)
 102 #endif
 103
 104 #ifndef discard_const_p
 105 # if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
 106 #  define discard_const(ptr) ((void *)((intptr_t)(ptr)))
 107 # else
 108 #  define discard_const(ptr) ((void *)(ptr))
 109 # endif
 110 # define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 111 #endif
 112
 113 /* free memory if the pointer is valid and zero the pointer */
 114 #ifndef SAFE_FREE
 115 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
 116 #endif
 117
 118 #define BUCKET(hash) ((hash) % tdb->header.hash_size)
 119
 120 #define DOCONV() (tdb->flags & TDB_CONVERT)
 121 #define CONVERT(x) (DOCONV() ? tdb_convert(&x, sizeof(x)) : &x)
 122
 123
 124 /* the body of the database is made of one list_struct for the free space
 125    plus a separate data list for each hash value */
 126 struct list_struct {
 127         tdb_off_t next; /* offset of the next record in the list */
 128         tdb_len_t rec_len; /* total byte length of record */
 129         tdb_len_t key_len; /* byte length of key */
 130         tdb_len_t data_len; /* byte length of data */
 131         u32 full_hash; /* the full 32 bit hash of the key */
 132         u32 magic;   /* try to catch errors */
 133         /* the following union is implied:
 134                 union {
 135                         char record[rec_len];
 136                         struct {
 137                                 char key[key_len];
 138                                 char data[data_len];
 139                         }
 140                         u32 totalsize; (tailer)
 141                 }
 142         */
 143 };
 144
 145
 146 /* this is stored at the front of every database */
 147 struct tdb_header {
 148         char magic_food[32]; /* for /etc/magic */
 149         u32 version; /* version of the code */
 150         u32 hash_size; /* number of hash entries */
 151         tdb_off_t rwlocks; /* obsolete - kept to detect old formats */
 152         tdb_off_t recovery_start; /* offset of transaction recovery region */
 153         tdb_off_t reserved[30];
 154 };
 155
 156 struct tdb_lock_type {
 157         u32 count;
 158         u32 ltype;
 159 };
 160
 161 struct tdb_traverse_lock {
 162         struct tdb_traverse_lock *next;
 163         u32 off;
 164         u32 hash;
 165 };
 166
 167
 168 struct tdb_methods {
 169         int (*tdb_read)(struct tdb_context *, tdb_off_t , void *, tdb_len_t , int );
 170         int (*tdb_write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
 171         void (*next_hash_chain)(struct tdb_context *, u32 *);
 172         int (*tdb_oob)(struct tdb_context *, tdb_off_t , int );
 173         int (*tdb_expand_file)(struct tdb_context *, tdb_off_t , tdb_off_t );
 174         int (*tdb_brlock)(struct tdb_context *, tdb_off_t , int, int, int);
 175 };
 176
 177 struct tdb_context {
 178         char *name; /* the name of the database */
 179         void *map_ptr; /* where it is currently mapped */
 180         int fd; /* open file descriptor for the database */
 181         tdb_len_t map_size; /* how much space has been mapped */
 182         int read_only; /* opened read-only */
 183         struct tdb_lock_type *locked; /* array of chain locks */
 184         enum TDB_ERROR ecode; /* error code for last tdb error */
 185         struct tdb_header header; /* a cached copy of the header */
 186         u32 flags; /* the flags passed to tdb_open */
 187         struct tdb_traverse_lock travlocks; /* current traversal locks */
 188         struct tdb_context *next; /* all tdbs to avoid multiple opens */
 189         dev_t device;   /* uniquely identifies this tdb */
 190         ino_t inode;    /* uniquely identifies this tdb */
 191         void (*log_fn)(struct tdb_context *tdb, int level, const char *, ...) PRINTF_ATTRIBUTE(3,4); /* logging function */
 192         unsigned int (*hash_fn)(TDB_DATA *key);
 193         int open_flags; /* flags used in the open - needed by reopen */
 194         unsigned int num_locks; /* number of chain locks held */
 195         const struct tdb_methods *methods;
 196         struct tdb_transaction *transaction;
 197         int page_size;
 198 };
 199
 200
 201 /*
 202   internal prototypes
 203 */
 204 int tdb_munmap(struct tdb_context *tdb);
 205 void tdb_mmap(struct tdb_context *tdb);
 206 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
 207 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
 208 int tdb_brlock(struct tdb_context *tdb, tdb_off_t offset, int rw_type, int lck_type, int probe);
 209 int tdb_brlock_len(struct tdb_context *tdb, tdb_off_t offset,
 210                    int rw_type, int lck_type, int probe, size_t len);
 211 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
 212 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
 213 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 214 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 215 void *tdb_convert(void *buf, u32 size);
 216 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
 217 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct list_struct *rec);
 218 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 219 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 220 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
 221 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
 222 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
 223 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct list_struct *rec);
 224 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct list_struct *rec);
 225 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
 226 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, u32 hash, int locktype,
 227                            struct list_struct *rec);
 228 void tdb_io_init(struct tdb_context *tdb);
 229 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
 230
 231