X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ftdb2%2Ftdb2.h;h=3fa99b15dbb6cab3d09162b3789efd5b8501e875;hp=802bcdbe10e02d7b52fc51fb90a9cec968a2f527;hb=926996e88c32445c874ff9c4f47f159db6b45995;hpb=5a5b9f8d3d187b15b9e7b427c7c3b2ac5ee7c6be diff --git a/ccan/tdb2/tdb2.h b/ccan/tdb2/tdb2.h index 802bcdbe..3fa99b15 100644 --- a/ccan/tdb2/tdb2.h +++ b/ccan/tdb2/tdb2.h @@ -30,6 +30,10 @@ extern "C" { #endif #ifndef _SAMBA_BUILD_ +#include "config.h" +#if HAVE_FILE_OFFSET_BITS +#define _FILE_OFFSET_BITS 64 +#endif /* For mode_t */ #include /* For O_* flags. */ @@ -80,6 +84,22 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags, #define TDB_CONVERT 16 /* convert endian */ #define TDB_NOSYNC 64 /* don't use synchronous transactions */ #define TDB_SEQNUM 128 /* maintain a sequence number */ +#define TDB_ALLOW_NESTING 256 /* fake nested transactions */ +#define TDB_RDONLY 512 /* implied by O_RDONLY */ +#define TDB_VERSION1 1024 /* create/open an old style TDB */ +#define TDB_CANT_CHECK 2048 /* has a feature which we don't understand */ + +/** + * tdb1_incompatible_hash - better (Jenkins) hash for tdb1 + * + * This is better than the default hash for tdb1; but older versions of the + * tdb library (prior to version 1.2.6) won't be able to open them. + * + * It only makes sense to specify this (using tdb_attribute_hash) when + * creating (with O_CREAT) an old tdb version using TDB_VERSION1. It's + * equivalent to the TDB_INCOMPATIBLE_HASH flag for tdb1. + */ +uint64_t tdb1_incompatible_hash(const void *, size_t, uint64_t, void *); /** * tdb_close - close and free a tdb. @@ -248,6 +268,15 @@ static inline struct tdb_data tdb_mkdata(const void *p, size_t len) * to read the tdb, but not alter it (they will block), nor will they see * any changes until tdb_transaction_commit() is called. * + * Note that if the TDB_ALLOW_NESTING flag is set, a tdb_transaction_start() + * within a transaction will succeed, but it's not a real transaction: + * (1) An inner transaction which is committed is not actually committed until + * the outer transaction is; if the outer transaction is cancelled, the + * inner ones are discarded. + * (2) tdb_transaction_cancel() marks the outer transaction as having an error, + * so the final tdb_transaction_commit() will fail. + * (3) the outer transaction will see the results of the inner transaction. + * * See Also: * tdb_transaction_cancel, tdb_transaction_commit. */ @@ -288,6 +317,9 @@ enum TDB_ERROR tdb_transaction_commit(struct tdb_context *tdb); * tdb_transaction_commit): if this succeeds then a transaction will only * fail if the write() or fsync() calls fail. * + * If this fails you must still call tdb_transaction_cancel() to cancel + * the transaction. + * * See Also: * tdb_transaction_commit() */ @@ -324,7 +356,7 @@ int64_t tdb_traverse_(struct tdb_context *tdb, * @tdb: the tdb context returned from tdb_open() * @key: the key whose record we should hand to @parse * @parse: the function to call for the data - * @p: the private pointer to hand to @parse (types must match). + * @data: the private pointer to hand to @parse (types must match). * * This avoids a copy for many cases, by handing you a pointer into * the memory-mapped database. It also locks the record to prevent @@ -332,18 +364,18 @@ int64_t tdb_traverse_(struct tdb_context *tdb, * * Do not alter the data handed to parse()! */ -#define tdb_parse_record(tdb, key, parse, p) \ +#define tdb_parse_record(tdb, key, parse, data) \ tdb_parse_record_((tdb), (key), \ typesafe_cb_preargs(enum TDB_ERROR, void *, \ - (parse), (p), \ - TDB_DATA, TDB_DATA), (p)) + (parse), (data), \ + TDB_DATA, TDB_DATA), (data)) enum TDB_ERROR tdb_parse_record_(struct tdb_context *tdb, TDB_DATA key, - enum TDB_ERROR (*parse)(TDB_DATA key, - TDB_DATA data, - void *p), - void *p); + enum TDB_ERROR (*parse)(TDB_DATA k, + TDB_DATA d, + void *data), + void *data); /** * tdb_get_seqnum - get a database sequence number @@ -486,31 +518,46 @@ void tdb_unlockall_read(struct tdb_context *tdb); */ enum TDB_ERROR tdb_wipe_all(struct tdb_context *tdb); +/** + * tdb_repack - repack the database + * @tdb: the tdb context returned from tdb_open() + * + * This repacks the database; if it is suffering from a great deal of + * fragmentation this might help. However, it can take twice the + * memory of the existing TDB. + */ +enum TDB_ERROR tdb_repack(struct tdb_context *tdb); + /** * tdb_check - check a TDB for consistency * @tdb: the tdb context returned from tdb_open() * @check: function to check each key/data pair (or NULL) - * @private_data: argument for @check, must match type. + * @data: argument for @check, must match type. * * This performs a consistency check of the open database, optionally calling * a check() function on each record so you can do your own data consistency * checks as well. If check() returns an error, that is returned from * tdb_check(). * + * Note that the TDB uses a feature which we don't understand which + * indicates we can't run tdb_check(), this will log a warning to that + * effect and return TDB_SUCCESS. You can detect this condition by + * looking for TDB_CANT_CHECK in tdb_get_flags(). + * * Returns TDB_SUCCESS or an error. */ -#define tdb_check(tdb, check, private_data) \ +#define tdb_check(tdb, check, data) \ tdb_check_((tdb), typesafe_cb_preargs(enum TDB_ERROR, void *, \ - (check), (private_data), \ + (check), (data), \ struct tdb_data, \ struct tdb_data), \ - (private_data)) + (data)) enum TDB_ERROR tdb_check_(struct tdb_context *tdb, - enum TDB_ERROR (*check)(struct tdb_data key, - struct tdb_data data, - void *private_data), - void *private_data); + enum TDB_ERROR (*check)(struct tdb_data k, + struct tdb_data d, + void *data), + void *data); /** * tdb_error - get the last error (not threadsafe) @@ -562,7 +609,7 @@ unsigned int tdb_get_flags(struct tdb_context *tdb); /** * tdb_add_flag - set a flag for a tdb * @tdb: the tdb context returned from tdb_open() - * @flag: one of TDB_NOLOCK, TDB_NOMMAP or TDB_NOSYNC. + * @flag: one of TDB_NOLOCK, TDB_NOMMAP, TDB_NOSYNC or TDB_ALLOW_NESTING. * * You can use this to set a flag on the TDB. You cannot set these flags * on a TDB_INTERNAL tdb. @@ -572,13 +619,69 @@ void tdb_add_flag(struct tdb_context *tdb, unsigned flag); /** * tdb_remove_flag - unset a flag for a tdb * @tdb: the tdb context returned from tdb_open() - * @flag: one of TDB_NOLOCK, TDB_NOMMAP or TDB_NOSYNC. + * @flag: one of TDB_NOLOCK, TDB_NOMMAP, TDB_NOSYNC or TDB_ALLOW_NESTING. * * You can use this to clear a flag on the TDB. You cannot clear flags * on a TDB_INTERNAL tdb. */ void tdb_remove_flag(struct tdb_context *tdb, unsigned flag); +/** + * enum tdb_attribute_type - descriminator for union tdb_attribute. + */ +enum tdb_attribute_type { + TDB_ATTRIBUTE_LOG = 0, + TDB_ATTRIBUTE_HASH = 1, + TDB_ATTRIBUTE_SEED = 2, + TDB_ATTRIBUTE_STATS = 3, + TDB_ATTRIBUTE_OPENHOOK = 4, + TDB_ATTRIBUTE_FLOCK = 5, + TDB_ATTRIBUTE_TDB1_HASHSIZE = 128, + TDB_ATTRIBUTE_TDB1_MAX_DEAD = 129, +}; + +/** + * tdb_get_attribute - get an attribute for an existing tdb + * @tdb: the tdb context returned from tdb_open() + * @attr: the union tdb_attribute to set. + * + * This gets an attribute from a TDB which has previously been set (or + * may return the default values). Set @attr.base.attr to the + * attribute type you want get. + */ +enum TDB_ERROR tdb_get_attribute(struct tdb_context *tdb, + union tdb_attribute *attr); + +/** + * tdb_set_attribute - set an attribute for an existing tdb + * @tdb: the tdb context returned from tdb_open() + * @attr: the union tdb_attribute to set. + * + * This sets an attribute on a TDB, overriding any previous attribute + * of the same type. It returns TDB_ERR_EINVAL if the attribute is + * unknown or invalid. + * + * Note that TDB_ATTRIBUTE_HASH, TDB_ATTRIBUTE_SEED, + * TDB_ATTRIBUTE_OPENHOOK and TDB_ATTRIBUTE_TDB1_HASHSIZE cannot + * currently be set after tdb_open. + */ +enum TDB_ERROR tdb_set_attribute(struct tdb_context *tdb, + const union tdb_attribute *attr); + +/** + * tdb_unset_attribute - reset an attribute for an existing tdb + * @tdb: the tdb context returned from tdb_open() + * @type: the attribute type to unset. + * + * This unsets an attribute on a TDB, returning it to the defaults + * (where applicable). + * + * Note that it only makes sense for TDB_ATTRIBUTE_LOG and TDB_ATTRIBUTE_FLOCK + * to be unset. + */ +void tdb_unset_attribute(struct tdb_context *tdb, + enum tdb_attribute_type type); + /** * tdb_name - get the name of a tdb * @tdb: the tdb context returned from tdb_open() @@ -600,14 +703,18 @@ const char *tdb_name(const struct tdb_context *tdb); int tdb_fd(const struct tdb_context *tdb); /** - * enum tdb_attribute_type - descriminator for union tdb_attribute. + * tdb_foreach - iterate through every open TDB. + * @fn: the function to call for every TDB + * @p: the pointer to hand to @fn + * + * TDB internally keeps track of all open TDBs; this function allows you to + * iterate through them. If @fn returns non-zero, traversal stops. */ -enum tdb_attribute_type { - TDB_ATTRIBUTE_LOG = 0, - TDB_ATTRIBUTE_HASH = 1, - TDB_ATTRIBUTE_SEED = 2, - TDB_ATTRIBUTE_STATS = 3 -}; +#define tdb_foreach(fn, p) \ + tdb_foreach_(typesafe_cb_preargs(int, void *, (fn), (p), \ + struct tdb_context *), (p)) + +void tdb_foreach_(int (*fn)(struct tdb_context *, void *), void *p); /** * struct tdb_attribute_base - common fields for all tdb attributes. @@ -640,11 +747,12 @@ enum tdb_log_level { */ struct tdb_attribute_log { struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_LOG */ - void (*log_fn)(struct tdb_context *tdb, - enum tdb_log_level level, - void *log_private, - const char *message); - void *log_private; + void (*fn)(struct tdb_context *tdb, + enum tdb_log_level level, + enum TDB_ERROR ecode, + const char *message, + void *data); + void *data; }; /** @@ -661,9 +769,9 @@ struct tdb_attribute_log { */ struct tdb_attribute_hash { struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_HASH */ - uint64_t (*hash_fn)(const void *key, size_t len, uint64_t seed, - void *priv); - void *hash_private; + uint64_t (*fn)(const void *key, size_t len, uint64_t seed, + void *data); + void *data; }; /** @@ -681,13 +789,13 @@ struct tdb_attribute_seed { * struct tdb_attribute_stats - tdb operational statistics * * This attribute records statistics of various low-level TDB operations. - * This can be used to assist performance evaluation. + * This can be used to assist performance evaluation. This is only + * useful for tdb_get_attribute(). * * New fields will be added at the end, hence the "size" argument which - * indicates how large your structure is. If your size is larger than - * that known about by this version of tdb, the size will be reduced to - * the known structure size. Thus you can detect older versions, and - * thus know that newer stats will not be updated. + * indicates how large your structure is: it must be filled in before + * calling tdb_get_attribute(), which will overwrite it with the size + * tdb knows about. */ struct tdb_attribute_stats { struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_STATS */ @@ -699,21 +807,92 @@ struct tdb_attribute_stats { uint64_t alloc_bucket_max; uint64_t alloc_leftover; uint64_t alloc_coalesce_tried; + uint64_t alloc_coalesce_iterate_clash; uint64_t alloc_coalesce_lockfail; uint64_t alloc_coalesce_race; uint64_t alloc_coalesce_succeeded; - uint64_t alloc_coalesce_num_merged; + uint64_t alloc_coalesce_num_merged; uint64_t compares; uint64_t compare_wrong_bucket; uint64_t compare_wrong_offsetbits; uint64_t compare_wrong_keylen; uint64_t compare_wrong_rechash; uint64_t compare_wrong_keycmp; + uint64_t transactions; + uint64_t transaction_cancel; + uint64_t transaction_nest; + uint64_t transaction_expand_file; + uint64_t transaction_read_direct; + uint64_t transaction_read_direct_fail; + uint64_t transaction_write_direct; + uint64_t transaction_write_direct_fail; uint64_t expands; uint64_t frees; uint64_t locks; - uint64_t lock_lowlevel; - uint64_t lock_nonblock; + uint64_t lock_lowlevel; + uint64_t lock_nonblock; + uint64_t lock_nonblock_fail; +}; + +/** + * struct tdb_attribute_openhook - tdb special effects hook for open + * + * This attribute contains a function to call once we have the OPEN_LOCK + * for the tdb, but before we've examined its contents. If this succeeds, + * the tdb will be populated if it's then zero-length. + * + * This is a hack to allow support for TDB1-style TDB_CLEAR_IF_FIRST + * behaviour. + */ +struct tdb_attribute_openhook { + struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_OPENHOOK */ + enum TDB_ERROR (*fn)(int fd, void *data); + void *data; +}; + +/** + * struct tdb_attribute_flock - tdb special effects hook for file locking + * + * This attribute contains function to call to place locks on a file; it can + * be used to support non-blocking operations or lock proxying. + * + * They should return 0 on success, -1 on failure and set errno. + * + * An error will be logged on error if errno is neither EAGAIN nor EINTR + * (normally it would only return EAGAIN if waitflag is false, and + * loop internally on EINTR). + */ +struct tdb_attribute_flock { + struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_FLOCK */ + int (*lock)(int fd,int rw, off_t off, off_t len, bool waitflag, void *); + int (*unlock)(int fd, int rw, off_t off, off_t len, void *); + void *data; +}; + +/** + * struct tdb_attribute_tdb1_hashsize - tdb1 hashsize + * + * This attribute allows setting the TDB1 hashsize; it only makes sense with + * O_CREAT and TDB_VERSION1. + * + * Hashsize should generally be a prime, such as 10007. + */ +struct tdb_attribute_tdb1_hashsize { + struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_TDB1_HASHSIZE */ + unsigned int hsize; +}; + +/** + * struct tdb_attribute_tdb1_max_dead - tdb1 number of maximum dead records. + * + * TDB1 has a method to speed up its slow free list: it lets a certain + * number of "dead" records build up before freeing them. This is + * particularly useful for volatile TDBs; setting it to 5 is + * equivalent to tdb1's TDB_VOLATILE flag. + */ +struct tdb_attribute_tdb1_max_dead { + struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_TDB1_MAX_DEAD */ + unsigned int max_dead; }; /** @@ -723,7 +902,8 @@ struct tdb_attribute_stats { * * See also: * struct tdb_attribute_log, struct tdb_attribute_hash, - * struct tdb_attribute_seed, struct tdb_attribute_stats. + * struct tdb_attribute_seed, struct tdb_attribute_stats, + * struct tdb_attribute_openhook, struct tdb_attribute_flock. */ union tdb_attribute { struct tdb_attribute_base base; @@ -731,6 +911,10 @@ union tdb_attribute { struct tdb_attribute_hash hash; struct tdb_attribute_seed seed; struct tdb_attribute_stats stats; + struct tdb_attribute_openhook openhook; + struct tdb_attribute_flock flock; + struct tdb_attribute_tdb1_hashsize tdb1_hashsize; + struct tdb_attribute_tdb1_max_dead tdb1_max_dead; }; #ifdef __cplusplus