X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ftdb2%2Fprivate.h;h=236aa3696d6b4c30efe7e974b53500b51c2f7832;hp=75e49c8313fcee17d40f8fe01ecd7953c7305fb3;hb=3835bb95d716cb6448913792b0d8d539877d93e9;hpb=aa12380008323e14f8d7dabe78b174b72f69e2dd diff --git a/ccan/tdb2/private.h b/ccan/tdb2/private.h index 75e49c83..236aa369 100644 --- a/ccan/tdb2/private.h +++ b/ccan/tdb2/private.h @@ -1,6 +1,6 @@ #ifndef TDB_PRIVATE_H #define TDB_PRIVATE_H - /* + /* Trivial Database 2: private types and prototypes Copyright (C) Rusty Russell 2010 @@ -73,7 +73,16 @@ 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) +#define TDB_PTR_ERR(p) ((enum TDB_ERROR)(long)(p)) +#define TDB_ERR_PTR(err) ((void *)(long)(err)) + +/* Common case of returning true, false or -ve error. */ +typedef int tdb_bool_err; /* Prevent others from opening the file. */ #define TDB_OPEN_LOCK 0 @@ -325,17 +334,20 @@ struct tdb_context { int mmap_flags; /* Error code for last tdb error. */ - enum TDB_ERROR ecode; + enum TDB_ERROR ecode; /* the flags passed to tdb_open, for tdb_reopen. */ uint32_t flags; /* Logging function */ - tdb_logfn_t logfn; + void (*logfn)(struct tdb_context *tdb, + enum tdb_log_level level, + void *log_private, + const char *message); void *log_private; /* Hash function. */ - tdb_hashfn_t khash; + uint64_t (*khash)(const void *key, size_t len, uint64_t seed, void *); void *hash_priv; uint64_t hash_seed; @@ -361,15 +373,17 @@ struct tdb_context { /* Single list of all TDBs, to avoid multiple opens. */ struct tdb_context *next; - dev_t device; + dev_t device; ino_t inode; }; struct tdb_methods { - int (*read)(struct tdb_context *, tdb_off_t, void *, tdb_len_t); - int (*write)(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); }; @@ -379,6 +393,14 @@ struct tdb_methods { /* hash.c: */ void tdb_hash_init(struct tdb_context *tdb); +tdb_bool_err first_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); @@ -393,38 +415,38 @@ 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); @@ -453,16 +475,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, @@ -478,12 +501,12 @@ 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); @@ -497,61 +520,54 @@ void add_stat_(struct tdb_context *tdb, uint64_t *stat, size_t val); void tdb_lock_init(struct tdb_context *tdb); /* Lock/unlock a range of hashes. */ -int tdb_lock_hashes(struct tdb_context *tdb, - tdb_off_t hash_lock, tdb_len_t hash_range, - int ltype, enum tdb_lock_flags waitflag); -int tdb_unlock_hashes(struct tdb_context *tdb, - tdb_off_t hash_lock, - tdb_len_t hash_range, int ltype); +enum TDB_ERROR tdb_lock_hashes(struct tdb_context *tdb, + tdb_off_t hash_lock, tdb_len_t hash_range, + int ltype, enum tdb_lock_flags waitflag); +enum TDB_ERROR tdb_unlock_hashes(struct tdb_context *tdb, + tdb_off_t hash_lock, + tdb_len_t hash_range, int ltype); /* Lock/unlock a particular free bucket. */ -int tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off, - enum tdb_lock_flags waitflag); +enum TDB_ERROR tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off, + enum tdb_lock_flags waitflag); void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off); /* Serialize transaction start. */ -int tdb_transaction_lock(struct tdb_context *tdb, int ltype); -int tdb_transaction_unlock(struct tdb_context *tdb, int ltype); +enum TDB_ERROR tdb_transaction_lock(struct tdb_context *tdb, int ltype); +void tdb_transaction_unlock(struct tdb_context *tdb, int ltype); /* Do we have any hash locks (ie. via tdb_chainlock) ? */ bool tdb_has_hash_locks(struct tdb_context *tdb); /* Lock entire database. */ -int tdb_allrecord_lock(struct tdb_context *tdb, int ltype, - enum tdb_lock_flags flags, bool upgradable); -int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype); -int tdb_allrecord_upgrade(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); /* Serialize db open. */ -int tdb_lock_open(struct tdb_context *tdb, enum tdb_lock_flags flags); +enum TDB_ERROR tdb_lock_open(struct tdb_context *tdb, + enum tdb_lock_flags flags); void tdb_unlock_open(struct tdb_context *tdb); bool tdb_has_open_lock(struct tdb_context *tdb); /* Serialize db expand. */ -int tdb_lock_expand(struct tdb_context *tdb, int ltype); +enum TDB_ERROR tdb_lock_expand(struct tdb_context *tdb, int ltype); void tdb_unlock_expand(struct tdb_context *tdb, int ltype); bool tdb_has_expansion_lock(struct tdb_context *tdb); /* If it needs recovery, grab all the locks and do it. */ -int tdb_lock_and_recover(struct tdb_context *tdb); - -/* traverse.c: */ -int first_in_hash(struct tdb_context *tdb, int ltype, - struct traverse_info *tinfo, - TDB_DATA *kbuf, size_t *dlen); -int next_in_hash(struct tdb_context *tdb, int ltype, - struct traverse_info *tinfo, - TDB_DATA *kbuf, size_t *dlen); +enum TDB_ERROR tdb_lock_and_recover(struct tdb_context *tdb); /* transaction.c: */ int tdb_transaction_recover(struct tdb_context *tdb); bool tdb_needs_recovery(struct tdb_context *tdb); /* tdb.c: */ -void COLD tdb_logerr(struct tdb_context *tdb, - enum TDB_ERROR ecode, - enum tdb_debug_level level, - const char *fmt, ...); +enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb, + enum TDB_ERROR ecode, + enum tdb_log_level level, + const char *fmt, ...); #ifdef TDB_TRACE void tdb_trace(struct tdb_context *tdb, const char *op);