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
  30 #include <limits.h>
  31
  32 /* #define TDB_TRACE 1 */
  33 #ifndef HAVE_GETPAGESIZE
  34 #define getpagesize() 0x2000
  35 #endif
  36
  37 #ifndef __STRING
  38 #define __STRING(x)    #x
  39 #endif
  40
  41 #ifndef __STRINGSTRING
  42 #define __STRINGSTRING(x) __STRING(x)
  43 #endif
  44
  45 #ifndef __location__
  46 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
  47 #endif
  48
  49 #ifndef offsetof
  50 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
  51 #endif
  52
  53 #define TDB1_VERSION (0x26011967 + 6)
  54 #define TDB1_MAGIC (0x26011999U)
  55 #define TDB1_FREE_MAGIC (~TDB1_MAGIC)
  56 #define TDB1_DEAD_MAGIC (0xFEE1DEAD)
  57 #define TDB1_RECOVERY_MAGIC (0xf53bc0e7U)
  58 #define TDB1_RECOVERY_INVALID_MAGIC (0x0)
  59 #define TDB1_HASH_RWLOCK_MAGIC (0xbad1a51U)
  60 #define TDB1_ALIGNMENT 4
  61 #define TDB1_DEFAULT_HASH_SIZE 131
  62 #define TDB1_FREELIST_TOP (sizeof(struct tdb1_header))
  63 #define TDB1_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
  64 #define TDB1_DEAD(r) ((r)->magic == TDB1_DEAD_MAGIC)
  65 #define TDB1_BAD_MAGIC(r) ((r)->magic != TDB1_MAGIC && !TDB1_DEAD(r))
  66 #define TDB1_HASH_TOP(hash) (TDB1_FREELIST_TOP + (TDB1_BUCKET(hash)+1)*sizeof(tdb1_off_t))
  67 #define TDB1_HASHTABLE_SIZE(tdb) ((tdb->tdb1.header.hash_size+1)*sizeof(tdb1_off_t))
  68 #define TDB1_DATA_START(hash_size) (TDB1_HASH_TOP(hash_size-1) + sizeof(tdb1_off_t))
  69 #define TDB1_RECOVERY_HEAD offsetof(struct tdb1_header, recovery_start)
  70 #define TDB1_SEQNUM_OFS    offsetof(struct tdb1_header, sequence_number)
  71 #define TDB1_PAD_BYTE 0x42
  72 #define TDB1_PAD_U32  0x42424242
  73
  74 /* lock offsets */
  75 #define TDB1_OPEN_LOCK        0
  76 #define TDB1_ACTIVE_LOCK      4
  77 #define TDB1_TRANSACTION_LOCK 8
  78
  79 /* free memory if the pointer is valid and zero the pointer */
  80 #ifndef SAFE_FREE
  81 #define SAFE_FREE(x) do { if ((x) != NULL) {free((void *)x); (x)=NULL;} } while(0)
  82 #endif
  83
  84 #define TDB1_BUCKET(hash) ((hash) % tdb->tdb1.header.hash_size)
  85
  86 #define TDB1_DOCONV() (tdb->flags & TDB_CONVERT)
  87 #define TDB1_CONV(x) (TDB1_DOCONV() ? tdb1_convert(&x, sizeof(x)) : &x)
  88
  89 /* the body of the database is made of one tdb1_record for the free space
  90    plus a separate data list for each hash value */
  91 struct tdb1_record {
  92         tdb1_off_t next; /* offset of the next record in the list */
  93         tdb1_len_t rec_len; /* total byte length of record */
  94         tdb1_len_t key_len; /* byte length of key */
  95         tdb1_len_t data_len; /* byte length of data */
  96         uint32_t full_hash; /* the full 32 bit hash of the key */
  97         uint32_t magic;   /* try to catch errors */
  98         /* the following union is implied:
  99                 union {
 100                         char record[rec_len];
 101                         struct {
 102                                 char key[key_len];
 103                                 char data[data_len];
 104                         }
 105                         uint32_t totalsize; (tailer)
 106                 }
 107         */
 108 };
 109
 110
 111 struct tdb1_methods {
 112         int (*tdb1_read)(struct tdb_context *, tdb1_off_t , void *, tdb1_len_t , int );
 113         int (*tdb1_write)(struct tdb_context *, tdb1_off_t, const void *, tdb1_len_t);
 114         void (*next_hash_chain)(struct tdb_context *, uint32_t *);
 115         int (*tdb1_oob)(struct tdb_context *, tdb1_off_t , int );
 116         int (*tdb1_expand_file)(struct tdb_context *, tdb1_off_t , tdb1_off_t );
 117 };
 118
 119
 120 /*
 121   internal prototypes
 122 */
 123 int tdb1_munmap(struct tdb_context *tdb);
 124 void tdb1_mmap(struct tdb_context *tdb);
 125 int tdb1_lock(struct tdb_context *tdb, int list, int ltype);
 126 int tdb1_nest_lock(struct tdb_context *tdb, uint32_t offset, int ltype,
 127                   enum tdb_lock_flags flags);
 128 int tdb1_nest_unlock(struct tdb_context *tdb, uint32_t offset, int ltype);
 129 int tdb1_unlock(struct tdb_context *tdb, int list, int ltype);
 130 int tdb1_brlock(struct tdb_context *tdb,
 131                int rw_type, tdb1_off_t offset, size_t len,
 132                enum tdb_lock_flags flags);
 133 int tdb1_brunlock(struct tdb_context *tdb,
 134                  int rw_type, tdb1_off_t offset, size_t len);
 135 bool tdb1_have_extra_locks(struct tdb_context *tdb);
 136 void tdb1_release_transaction_locks(struct tdb_context *tdb);
 137 int tdb1_transaction_lock(struct tdb_context *tdb, int ltype,
 138                          enum tdb_lock_flags lockflags);
 139 int tdb1_transaction_unlock(struct tdb_context *tdb, int ltype);
 140 int tdb1_recovery_area(struct tdb_context *tdb,
 141                       const struct tdb1_methods *methods,
 142                       tdb1_off_t *recovery_offset,
 143                       struct tdb1_record *rec);
 144 int tdb1_allrecord_upgrade(struct tdb_context *tdb);
 145 int tdb1_write_lock_record(struct tdb_context *tdb, tdb1_off_t off);
 146 int tdb1_write_unlock_record(struct tdb_context *tdb, tdb1_off_t off);
 147 int tdb1_ofs_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 148 int tdb1_ofs_write(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 149 void *tdb1_convert(void *buf, uint32_t size);
 150 int tdb1_free(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 151 tdb1_off_t tdb1_allocate(struct tdb_context *tdb, tdb1_len_t length, struct tdb1_record *rec);
 152 int tdb1_ofs_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 153 int tdb1_ofs_write(struct tdb_context *tdb, tdb1_off_t offset, tdb1_off_t *d);
 154 int tdb1_lock_record(struct tdb_context *tdb, tdb1_off_t off);
 155 int tdb1_unlock_record(struct tdb_context *tdb, tdb1_off_t off);
 156 tdb_bool_err tdb1_needs_recovery(struct tdb_context *tdb);
 157 int tdb1_rec_read(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 158 int tdb1_rec_write(struct tdb_context *tdb, tdb1_off_t offset, struct tdb1_record *rec);
 159 int tdb1_do_delete(struct tdb_context *tdb, tdb1_off_t rec_ptr, struct tdb1_record *rec);
 160 unsigned char *tdb1_alloc_read(struct tdb_context *tdb, tdb1_off_t offset, tdb1_len_t len);
 161 enum TDB_ERROR tdb1_parse_data(struct tdb_context *tdb, TDB_DATA key,
 162                                tdb1_off_t offset, tdb1_len_t len,
 163                                enum TDB_ERROR (*parser)(TDB_DATA key,
 164                                                         TDB_DATA data,
 165                                                         void *private_data),
 166                                void *private_data);
 167 tdb1_off_t tdb1_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
 168                            struct tdb1_record *rec);
 169 void tdb1_io_init(struct tdb_context *tdb);
 170 int tdb1_expand(struct tdb_context *tdb, tdb1_off_t size);
 171 int tdb1_rec_free_read(struct tdb_context *tdb, tdb1_off_t off,
 172                       struct tdb1_record *rec);
 173 bool tdb1_write_all(int fd, const void *buf, size_t count);
 174 void tdb1_header_hash(struct tdb_context *tdb,
 175                      uint32_t *magic1_hash, uint32_t *magic2_hash);
 176 uint64_t tdb1_old_hash(const void *key, size_t len, uint64_t seed, void *);
 177 size_t tdb1_dead_space(struct tdb_context *tdb, tdb1_off_t off);
 178 #endif /* CCAN_TDB2_TDB1_PRIVATE_H */