tdb2: make jenkins_hash function non-static, rename to tdb_jenkins_hash.
[ccan] / ccan / tdb2 / private.h
index 213e83615a33cc00090175badb2b05e1c3aca24e..4bce11a1c539ea8e39bb09c6179d495bf669e342 100644 (file)
    License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */
 
-#include "config.h"
-#if HAVE_FILE_OFFSET_BITS
-#define _FILE_OFFSET_BITS 64
-#endif
-#include <stdint.h>
-#include <stdbool.h>
+#include <ccan/tdb2/tdb2.h>
 #include <stdlib.h>
 #include <stddef.h>
 #include <sys/time.h>
 #include <sys/mman.h>
 #include <unistd.h>
 #include <fcntl.h>
-#include <string.h>
 #include <errno.h>
 #include <stdio.h>
 #include <utime.h>
 #include <unistd.h>
-#include <ccan/tdb2/tdb2.h>
 #include <ccan/likely/likely.h>
-#include <ccan/compiler/compiler.h>
-#if HAVE_BYTESWAP_H
-#include <byteswap.h>
-#endif
+#include <ccan/endian/endian.h>
 
 #ifndef TEST_IT
 #define TEST_IT(cond)
@@ -87,10 +77,10 @@ typedef int tdb_bool_err;
 
 /* Prevent others from opening the file. */
 #define TDB_OPEN_LOCK 0
-/* Doing a transaction. */
-#define TDB_TRANSACTION_LOCK 1
 /* Expanding file. */
 #define TDB_EXPANSION_LOCK 2
+/* Doing a transaction. */
+#define TDB_TRANSACTION_LOCK 8
 /* Hash chain locks. */
 #define TDB_HASH_LOCK_START 64
 
@@ -137,20 +127,6 @@ typedef int tdb_bool_err;
 /* Indicates this entry is not on an flist (can happen during coalescing) */
 #define TDB_FTABLE_NONE ((1ULL << TDB_OFF_UPPER_STEAL) - 1)
 
-#if !HAVE_BSWAP_64
-static inline uint64_t bswap_64(uint64_t x)
-{
-       return (((x&0x000000FFULL)<<56)
-               | ((x&0x0000FF00ULL)<<48)
-               | ((x&0x00FF0000ULL)<<40)
-               | ((x&0xFF000000ULL)<<32)
-               | ((x>>8)&0xFF000000ULL)
-               | ((x>>16)&0x00FF0000ULL)
-               | ((x>>24)&0x0000FF00ULL)
-               | ((x>>32)&0x000000FFULL));
-}
-#endif
-
 struct tdb_used_record {
        /* For on-disk compatibility, we avoid bitfields:
           magic: 16,        (highest)
@@ -222,7 +198,7 @@ static inline unsigned frec_ftable(const struct tdb_free_record *f)
 
 struct tdb_recovery_record {
        uint64_t magic;
-       /* Length of record. */
+       /* Length of record (add this header to get total length). */
        uint64_t max_len;
        /* Length used. */
        uint64_t len;
@@ -295,6 +271,9 @@ struct traverse_info {
        tdb_off_t prev;
 };
 
+typedef uint32_t tdb1_len_t;
+typedef uint32_t tdb1_off_t;
+
 enum tdb_lock_flags {
        /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
        TDB_LOCK_NOWAIT = 0,
@@ -307,7 +286,7 @@ enum tdb_lock_flags {
 
 struct tdb_lock {
        struct tdb_context *owner;
-       uint32_t off;
+       off_t off;
        uint32_t count;
        uint32_t ltype;
 };
@@ -322,9 +301,6 @@ struct tdb_access_hdr {
 };
 
 struct tdb_file {
-       /* Single list of all TDBs, to detect multiple opens. */
-       struct tdb_file *next;
-
        /* How many are sharing us? */
        unsigned int refcnt;
 
@@ -348,62 +324,6 @@ struct tdb_file {
        ino_t inode;
 };
 
-struct tdb_context {
-       /* Filename of the database. */
-       const char *name;
-
-       /* Are we accessing directly? (debugging check). */
-       int direct_access;
-
-       /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
-       bool read_only;
-
-       /* mmap read only? */
-       int mmap_flags;
-
-       /* the flags passed to tdb_open, for tdb_reopen. */
-       uint32_t flags;
-
-       /* Logging function */
-       void (*log_fn)(struct tdb_context *tdb,
-                      enum tdb_log_level level,
-                      const char *message,
-                      void *data);
-       void *log_data;
-
-       /* Hash function. */
-       uint64_t (*hash_fn)(const void *key, size_t len, uint64_t seed, void *);
-       void *hash_data;
-       uint64_t hash_seed;
-
-       /* low level (fnctl) lock functions. */
-       int (*lock_fn)(int fd, int rw, off_t off, off_t len, bool w, void *);
-       int (*unlock_fn)(int fd, int rw, off_t off, off_t len, void *);
-       void *lock_data;
-
-       /* Set if we are in a transaction. */
-       struct tdb_transaction *transaction;
-       
-       /* What free table are we using? */
-       tdb_off_t ftable_off;
-       unsigned int ftable;
-
-       /* IO methods: changes for transactions. */
-       const struct tdb_methods *methods;
-
-       /* Our statistics. */
-       struct tdb_attribute_stats stats;
-
-       /* Direct access information */
-       struct tdb_access_hdr *access;
-
-       /* Last error we returned. */
-       enum TDB_ERROR last_error;
-
-       /* The actual file information */
-       struct tdb_file *file;
-};
-
 struct tdb_methods {
        enum TDB_ERROR (*tread)(struct tdb_context *, tdb_off_t, void *,
                                tdb_len_t);
@@ -418,6 +338,9 @@ struct tdb_methods {
   internal prototypes
 */
 /* hash.c: */
+uint64_t tdb_jenkins_hash(const void *key, size_t length, uint64_t seed,
+                         void *unused);
+
 tdb_bool_err first_in_hash(struct tdb_context *tdb,
                           struct traverse_info *tinfo,
                           TDB_DATA *kbuf, size_t *dlen);
@@ -466,7 +389,8 @@ tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
 /* Put this record in a free list. */
 enum TDB_ERROR add_free_record(struct tdb_context *tdb,
                               tdb_off_t off, tdb_len_t len_with_header,
-                              enum tdb_lock_flags waitflag);
+                              enum tdb_lock_flags waitflag,
+                              bool coalesce_ok);
 
 /* Set up header for a used/ftable/htable/chain record. */
 enum TDB_ERROR set_header(struct tdb_context *tdb,
@@ -565,12 +489,12 @@ bool tdb_has_hash_locks(struct tdb_context *tdb);
 enum TDB_ERROR tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
                                  enum tdb_lock_flags flags, bool upgradable);
 void tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
-enum TDB_ERROR tdb_allrecord_upgrade(struct tdb_context *tdb);
+enum TDB_ERROR tdb_allrecord_upgrade(struct tdb_context *tdb, off_t start);
 
 /* Serialize db open. */
 enum TDB_ERROR tdb_lock_open(struct tdb_context *tdb,
-                            enum tdb_lock_flags flags);
-void tdb_unlock_open(struct tdb_context *tdb);
+                            int ltype, enum tdb_lock_flags flags);
+void tdb_unlock_open(struct tdb_context *tdb, int ltype);
 bool tdb_has_open_lock(struct tdb_context *tdb);
 
 /* Serialize db expand. */
@@ -581,6 +505,25 @@ bool tdb_has_expansion_lock(struct tdb_context *tdb);
 /* If it needs recovery, grab all the locks and do it. */
 enum TDB_ERROR tdb_lock_and_recover(struct tdb_context *tdb);
 
+/* Byte-range lock wrappers for TDB1 to access. */
+enum TDB_ERROR tdb_brlock(struct tdb_context *tdb,
+                         int rw_type, tdb_off_t offset, tdb_off_t len,
+                         enum tdb_lock_flags flags);
+
+enum TDB_ERROR tdb_brunlock(struct tdb_context *tdb,
+                           int rw_type, tdb_off_t offset, size_t len);
+
+enum TDB_ERROR tdb_nest_lock(struct tdb_context *tdb,
+                            tdb_off_t offset, int ltype,
+                            enum tdb_lock_flags flags);
+
+enum TDB_ERROR tdb_nest_unlock(struct tdb_context *tdb,
+                              tdb_off_t off, int ltype);
+
+enum TDB_ERROR tdb_lock_gradual(struct tdb_context *tdb,
+                               int ltype, enum tdb_lock_flags flags,
+                               tdb_off_t off, tdb_off_t len);
+
 /* Default lock and unlock functions. */
 int tdb_fcntl_lock(int fd, int rw, off_t off, off_t len, bool waitflag, void *);
 int tdb_fcntl_unlock(int fd, int rw, off_t off, off_t len, void *);
@@ -589,6 +532,102 @@ int tdb_fcntl_unlock(int fd, int rw, off_t off, off_t len, void *);
 enum TDB_ERROR tdb_transaction_recover(struct tdb_context *tdb);
 tdb_bool_err tdb_needs_recovery(struct tdb_context *tdb);
 
+/* this is stored at the front of every database */
+struct tdb1_header {
+       char magic_food[32]; /* for /etc/magic */
+       uint32_t version; /* version of the code */
+       uint32_t hash_size; /* number of hash entries */
+       tdb1_off_t rwlocks; /* obsolete - kept to detect old formats */
+       tdb1_off_t recovery_start; /* offset of transaction recovery region */
+       tdb1_off_t sequence_number; /* used when TDB1_SEQNUM is set */
+       uint32_t magic1_hash; /* hash of TDB_MAGIC_FOOD. */
+       uint32_t magic2_hash; /* hash of TDB1_MAGIC. */
+       tdb1_off_t reserved[27];
+};
+
+struct tdb1_traverse_lock {
+       struct tdb1_traverse_lock *next;
+       uint32_t off;
+       uint32_t hash;
+       int lock_rw;
+};
+
+struct tdb_context {
+       /* Single list of all TDBs, to detect multiple opens. */
+       struct tdb_context *next;
+
+       /* Filename of the database. */
+       const char *name;
+
+       /* Logging function */
+       void (*log_fn)(struct tdb_context *tdb,
+                      enum tdb_log_level level,
+                      enum TDB_ERROR ecode,
+                      const char *message,
+                      void *data);
+       void *log_data;
+
+       /* Open flags passed to tdb_open. */
+       int open_flags;
+
+       /* low level (fnctl) lock functions. */
+       int (*lock_fn)(int fd, int rw, off_t off, off_t len, bool w, void *);
+       int (*unlock_fn)(int fd, int rw, off_t off, off_t len, void *);
+       void *lock_data;
+
+       /* the tdb flags passed to tdb_open. */
+       uint32_t flags;
+
+       /* Our statistics. */
+       struct tdb_attribute_stats stats;
+
+       /* The actual file information */
+       struct tdb_file *file;
+
+       /* Hash function. */
+       uint64_t (*hash_fn)(const void *key, size_t len, uint64_t seed, void *);
+       void *hash_data;
+       uint64_t hash_seed;
+
+       /* Our open hook, if any. */
+       enum TDB_ERROR (*openhook)(int fd, void *data);
+       void *openhook_data;
+
+       /* Last error we returned. */
+       enum TDB_ERROR last_error;
+
+       struct {
+
+               /* Are we accessing directly? (debugging check). */
+               int direct_access;
+
+               /* Set if we are in a transaction. */
+               struct tdb_transaction *transaction;
+
+               /* What free table are we using? */
+               tdb_off_t ftable_off;
+               unsigned int ftable;
+
+               /* IO methods: changes for transactions. */
+               const struct tdb_methods *io;
+
+               /* Direct access information */
+               struct tdb_access_hdr *access;
+       } tdb2;
+
+       struct {
+               int traverse_read; /* read-only traversal */
+               int traverse_write; /* read-write traversal */
+
+               struct tdb1_header header; /* a cached copy of the header */
+               struct tdb1_traverse_lock travlocks; /* current traversal locks */
+               const struct tdb1_methods *io;
+               struct tdb1_transaction *transaction;
+               int page_size;
+               int max_dead_records;
+       } tdb1;
+};
+
 /* tdb.c: */
 enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
                               enum TDB_ERROR ecode,