X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ftdb2%2Fprivate.h;h=cc791b0bb4e3da3226c22862b21d03e32304e931;hp=4ecda6a5f529729518b051a53db711f582fde6db;hb=dc9da1e34fe6a9d113fd57e116ebbc6d5bd54819;hpb=850c5cfed46cd4f38df79783791969c7b30ad9da
diff --git a/ccan/tdb2/private.h b/ccan/tdb2/private.h
index 4ecda6a5..cc791b0b 100644
--- a/ccan/tdb2/private.h
+++ b/ccan/tdb2/private.h
@@ -18,8 +18,7 @@
License along with this library; if not, see .
*/
-#define _XOPEN_SOURCE 500
-#define _FILE_OFFSET_BITS 64
+#include "config.h"
#include
#include
#include
@@ -33,7 +32,6 @@
#include
#include
#include
-#include "config.h"
#include
#include
#include
@@ -73,12 +71,11 @@ typedef uint64_t tdb_off_t;
#define TDB_RECOVERY_MAGIC (0xf53bc0e7ad124589ULL)
#define TDB_RECOVERY_INVALID_MAGIC (0x0ULL)
-#define TDB_OFF_ERR ((tdb_off_t)-1)
#define TDB_OFF_IS_ERR(off) unlikely(off >= (tdb_off_t)TDB_ERR_LAST)
/* Packing errors into pointers and v.v. */
#define TDB_PTR_IS_ERR(ptr) \
- unlikely((void *)(ptr) >= (void *)(long)TDB_ERR_LAST)
+ unlikely((unsigned long)(ptr) >= (unsigned long)TDB_ERR_LAST)
#define TDB_PTR_ERR(p) ((enum TDB_ERROR)(long)(p))
#define TDB_ERR_PTR(err) ((void *)(long)(err))
@@ -92,7 +89,7 @@ typedef int tdb_bool_err;
/* Expanding file. */
#define TDB_EXPANSION_LOCK 2
/* Hash chain locks. */
-#define TDB_HASH_LOCK_START 3
+#define TDB_HASH_LOCK_START 64
/* Range for hash locks. */
#define TDB_HASH_LOCK_RANGE_BITS 30
@@ -119,6 +116,9 @@ typedef int tdb_bool_err;
#define TDB_OFF_HASH_EXTRA_BIT 57
#define TDB_OFF_UPPER_STEAL_SUBHASH_BIT 56
+/* Additional features we understand. Currently: none. */
+#define TDB_FEATURE_MASK ((uint64_t)0)
+
/* The bit number where we store the extra hash bits. */
/* Convenience mask to get actual offset. */
#define TDB_OFF_MASK \
@@ -243,7 +243,12 @@ struct tdb_header {
tdb_off_t free_table; /* (First) free table. */
tdb_off_t recovery; /* Transaction recovery area. */
- tdb_off_t reserved[26];
+ uint64_t features_used; /* Features all writers understand */
+ uint64_t features_offered; /* Features offered */
+
+ uint64_t seqnum; /* Sequence number for TDB_SEQNUM */
+
+ tdb_off_t reserved[23];
/* Top level hash table. */
tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
@@ -297,7 +302,8 @@ enum tdb_lock_flags {
TDB_LOCK_NOCHECK = 4,
};
-struct tdb_lock_type {
+struct tdb_lock {
+ struct tdb_context *owner;
uint32_t off;
uint32_t count;
uint32_t ltype;
@@ -312,21 +318,39 @@ struct tdb_access_hdr {
bool convert;
};
-struct tdb_context {
- /* Filename of the database. */
- const char *name;
+struct tdb_file {
+ /* Single list of all TDBs, to detect multiple opens. */
+ struct tdb_file *next;
+
+ /* How many are sharing us? */
+ unsigned int refcnt;
/* Mmap (if any), or malloc (for TDB_INTERNAL). */
void *map_ptr;
- /* Are we accessing directly? (debugging check). */
- int direct_access;
+ /* How much space has been mapped (<= current file size) */
+ tdb_len_t map_size;
- /* Open file descriptor (undefined for TDB_INTERNAL). */
+ /* The file descriptor (-1 for TDB_INTERNAL). */
int fd;
- /* How much space has been mapped (<= current file size) */
- tdb_len_t map_size;
+ /* Lock information */
+ pid_t locker;
+ struct tdb_lock allrecord_lock;
+ size_t num_lockrecs;
+ struct tdb_lock *lockrecs;
+
+ /* Identity of this file. */
+ dev_t device;
+ 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;
@@ -334,24 +358,26 @@ struct tdb_context {
/* mmap read only? */
int mmap_flags;
- /* Error code for last tdb error. */
- enum TDB_ERROR ecode;
-
/* the flags passed to tdb_open, for tdb_reopen. */
uint32_t flags;
/* Logging function */
- void (*logfn)(struct tdb_context *tdb,
- enum tdb_log_level level,
- void *log_private,
- const char *message);
- void *log_private;
+ void (*log_fn)(struct tdb_context *tdb,
+ enum tdb_log_level level,
+ const char *message,
+ void *data);
+ void *log_data;
/* Hash function. */
- uint64_t (*khash)(const void *key, size_t len, uint64_t seed, void *);
- void *hash_priv;
+ 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;
@@ -362,27 +388,26 @@ struct tdb_context {
/* IO methods: changes for transactions. */
const struct tdb_methods *methods;
- /* Lock information */
- struct tdb_lock_type allrecord_lock;
- size_t num_lockrecs;
- struct tdb_lock_type *lockrecs;
-
- struct tdb_attribute_stats *stats;
+ /* Our statistics. */
+ struct tdb_attribute_stats stats;
/* Direct access information */
struct tdb_access_hdr *access;
- /* Single list of all TDBs, to avoid multiple opens. */
- struct tdb_context *next;
- dev_t device;
- ino_t inode;
+ /* Last error we returned. */
+ enum TDB_ERROR last_error;
+
+ /* The actual file information */
+ struct tdb_file *file;
};
struct tdb_methods {
- int (*tread)(struct tdb_context *, tdb_off_t, void *, tdb_len_t);
- int (*twrite)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
- int (*oob)(struct tdb_context *, tdb_off_t, bool);
- int (*expand_file)(struct tdb_context *, tdb_len_t);
+ enum TDB_ERROR (*tread)(struct tdb_context *, tdb_off_t, void *,
+ tdb_len_t);
+ enum TDB_ERROR (*twrite)(struct tdb_context *, tdb_off_t, const void *,
+ tdb_len_t);
+ enum TDB_ERROR (*oob)(struct tdb_context *, tdb_off_t, bool);
+ enum TDB_ERROR (*expand_file)(struct tdb_context *, tdb_len_t);
void *(*direct)(struct tdb_context *, tdb_off_t, size_t, bool);
};
@@ -390,15 +415,13 @@ struct tdb_methods {
internal prototypes
*/
/* hash.c: */
-void tdb_hash_init(struct tdb_context *tdb);
-
-int first_in_hash(struct tdb_context *tdb,
- struct traverse_info *tinfo,
- TDB_DATA *kbuf, size_t *dlen);
+tdb_bool_err first_in_hash(struct tdb_context *tdb,
+ struct traverse_info *tinfo,
+ TDB_DATA *kbuf, size_t *dlen);
-int next_in_hash(struct tdb_context *tdb,
- struct traverse_info *tinfo,
- TDB_DATA *kbuf, size_t *dlen);
+tdb_bool_err next_in_hash(struct tdb_context *tdb,
+ struct traverse_info *tinfo,
+ TDB_DATA *kbuf, size_t *dlen);
/* Hash random memory. */
uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
@@ -414,45 +437,45 @@ tdb_off_t find_and_lock(struct tdb_context *tdb,
struct tdb_used_record *rec,
struct traverse_info *tinfo);
-int replace_in_hash(struct tdb_context *tdb,
- struct hash_info *h,
- tdb_off_t new_off);
+enum TDB_ERROR replace_in_hash(struct tdb_context *tdb,
+ struct hash_info *h,
+ tdb_off_t new_off);
-int add_to_hash(struct tdb_context *tdb, struct hash_info *h,
- tdb_off_t new_off);
+enum TDB_ERROR add_to_hash(struct tdb_context *tdb, struct hash_info *h,
+ tdb_off_t new_off);
-int delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
+enum TDB_ERROR delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
/* For tdb_check */
bool is_subhash(tdb_off_t val);
/* free.c: */
-int tdb_ftable_init(struct tdb_context *tdb);
+enum TDB_ERROR tdb_ftable_init(struct tdb_context *tdb);
/* check.c needs these to iterate through free lists. */
tdb_off_t first_ftable(struct tdb_context *tdb);
tdb_off_t next_ftable(struct tdb_context *tdb, tdb_off_t ftable);
-/* This returns space or TDB_OFF_ERR. */
+/* This returns space or -ve error number. */
tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
uint64_t hash, unsigned magic, bool growing);
/* Put this record in a free list. */
-int add_free_record(struct tdb_context *tdb,
- tdb_off_t off, tdb_len_t len_with_header);
+enum TDB_ERROR add_free_record(struct tdb_context *tdb,
+ tdb_off_t off, tdb_len_t len_with_header);
/* Set up header for a used/ftable/htable/chain record. */
-int set_header(struct tdb_context *tdb,
- struct tdb_used_record *rec,
- unsigned magic, uint64_t keylen, uint64_t datalen,
- uint64_t actuallen, unsigned hashlow);
+enum TDB_ERROR set_header(struct tdb_context *tdb,
+ struct tdb_used_record *rec,
+ unsigned magic, uint64_t keylen, uint64_t datalen,
+ uint64_t actuallen, unsigned hashlow);
/* Used by tdb_check to verify. */
unsigned int size_to_bucket(tdb_len_t data_len);
tdb_off_t bucket_off(tdb_off_t ftable_off, unsigned bucket);
/* Used by tdb_summary */
-size_t dead_space(struct tdb_context *tdb, tdb_off_t off);
+tdb_off_t dead_space(struct tdb_context *tdb, tdb_off_t off);
/* io.c: */
/* Initialize tdb->methods. */
@@ -462,7 +485,7 @@ void tdb_io_init(struct tdb_context *tdb);
void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
/* Unmap and try to map the tdb. */
-void tdb_munmap(struct tdb_context *tdb);
+void tdb_munmap(struct tdb_file *file);
void tdb_mmap(struct tdb_context *tdb);
/* Either alloc a copy, or give direct access. Release frees or noop. */
@@ -474,16 +497,17 @@ void *tdb_access_write(struct tdb_context *tdb,
/* Release result of tdb_access_read/write. */
void tdb_access_release(struct tdb_context *tdb, const void *p);
/* Commit result of tdb_acces_write. */
-int tdb_access_commit(struct tdb_context *tdb, void *p);
+enum TDB_ERROR tdb_access_commit(struct tdb_context *tdb, void *p);
/* Convenience routine to get an offset. */
tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
/* Write an offset at an offset. */
-int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val);
+enum TDB_ERROR tdb_write_off(struct tdb_context *tdb, tdb_off_t off,
+ tdb_off_t val);
/* Clear an ondisk area. */
-int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
+enum TDB_ERROR zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
/* Return a non-zero offset between >= start < end in this array (or end). */
tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb,
@@ -499,24 +523,17 @@ tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
/* Writes a converted copy of a record. */
-int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
- const void *rec, size_t len);
+enum TDB_ERROR tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
+ const void *rec, size_t len);
/* Reads record and converts it */
-int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
- void *rec, size_t len);
+enum TDB_ERROR tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
+ void *rec, size_t len);
-/* Adds a stat, if it's in range. */
-void add_stat_(struct tdb_context *tdb, uint64_t *stat, size_t val);
-#define add_stat(tdb, statname, val) \
- do { \
- if (unlikely((tdb)->stats)) \
- add_stat_((tdb), &(tdb)->stats->statname, (val)); \
- } while (0)
+/* Bump the seqnum (caller checks for tdb->flags & TDB_SEQNUM) */
+void tdb_inc_seqnum(struct tdb_context *tdb);
/* lock.c: */
-void tdb_lock_init(struct tdb_context *tdb);
-
/* Lock/unlock a range of hashes. */
enum TDB_ERROR tdb_lock_hashes(struct tdb_context *tdb,
tdb_off_t hash_lock, tdb_len_t hash_range,
@@ -525,6 +542,9 @@ enum TDB_ERROR tdb_unlock_hashes(struct tdb_context *tdb,
tdb_off_t hash_lock,
tdb_len_t hash_range, int ltype);
+/* For closing the file. */
+void tdb_lock_cleanup(struct tdb_context *tdb);
+
/* Lock/unlock a particular free bucket. */
enum TDB_ERROR tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
enum tdb_lock_flags waitflag);
@@ -557,9 +577,13 @@ 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);
+/* 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 *);
+
/* transaction.c: */
-int tdb_transaction_recover(struct tdb_context *tdb);
-bool tdb_needs_recovery(struct tdb_context *tdb);
+enum TDB_ERROR tdb_transaction_recover(struct tdb_context *tdb);
+tdb_bool_err tdb_needs_recovery(struct tdb_context *tdb);
/* tdb.c: */
enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,