X-Git-Url: http://git.ozlabs.org/?a=blobdiff_plain;f=ccan%2Ftdb2%2Ftdb2.h;h=0940be1ceac40797435eaaa6241cbdd0e787484f;hb=8d8de08d9079f503256e1682dfa93bb22dcd4ad0;hp=52c26959d02cb412496b7f00a5e8eff542ed2667;hpb=5d226247fd983bdde5780e672a5ae38391356265;p=ccan diff --git a/ccan/tdb2/tdb2.h b/ccan/tdb2/tdb2.h index 52c26959..0940be1c 100644 --- a/ccan/tdb2/tdb2.h +++ b/ccan/tdb2/tdb2.h @@ -38,6 +38,10 @@ extern "C" { #include /* For uint64_t */ #include +/* For bool */ +#include +/* For memcmp */ +#include #endif #include #include @@ -74,6 +78,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags, #define TDB_NOMMAP 8 /* don't use mmap */ #define TDB_CONVERT 16 /* convert endian */ #define TDB_NOSYNC 64 /* don't use synchronous transactions */ +#define TDB_SEQNUM 128 /* maintain a sequence number */ /** * tdb_close - close and free a tdb. @@ -197,6 +202,25 @@ enum TDB_ERROR tdb_append(struct tdb_context *tdb, */ enum TDB_ERROR tdb_delete(struct tdb_context *tdb, struct tdb_data key); +/** + * tdb_exists - does a key exist in the database? + * @tdb: the tdb context returned from tdb_open() + * @key: the key to search for. + * + * Returns true if it exists, or false if it doesn't or any other error. + */ +bool tdb_exists(struct tdb_context *tdb, TDB_DATA key); + +/** + * tdb_deq - are struct tdb_data equal? + * @a: one struct tdb_data + * @b: another struct tdb_data + */ +static inline bool tdb_deq(struct tdb_data a, struct tdb_data b) +{ + return a.dsize == b.dsize && memcmp(a.dptr, b.dptr, a.dsize) == 0; +} + /** * tdb_transaction_start - start a transaction * @tdb: the tdb context returned from tdb_open() @@ -276,6 +300,49 @@ int64_t tdb_traverse_(struct tdb_context *tdb, int (*fn)(struct tdb_context *, TDB_DATA, TDB_DATA, void *), void *p); +/** + * tdb_parse_record - operate directly on data in the database. + * @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). + * + * This avoids a copy for many cases, by handing you a pointer into + * the memory-mapped database. It also locks the record to prevent + * other accesses at the same time. + * + * Do not alter the data handed to parse()! + */ +#define tdb_parse_record(tdb, key, parse, p) \ + tdb_parse_record_((tdb), (key), \ + typesafe_cb_preargs(enum TDB_ERROR, (parse), (p), \ + TDB_DATA, TDB_DATA), (p)) + +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); + +/** + * tdb_get_seqnum - get a database sequence number + * @tdb: the tdb context returned from tdb_open() + * + * This returns a sequence number: any change to the database from a + * tdb context opened with the TDB_SEQNUM flag will cause that number + * to increment. Note that the incrementing is unreliable (it is done + * without locking), so this is only useful as an optimization. + * + * For example, you may have a regular database backup routine which + * does not operate if the sequence number is unchanged. In the + * unlikely event of a failed increment, it will be backed up next + * time any way. + * + * Returns an enum TDB_ERROR (ie. negative) on error. + */ +int64_t tdb_get_seqnum(struct tdb_context *tdb); + /** * tdb_firstkey - get the "first" key in a TDB * @tdb: the tdb context returned from tdb_open() @@ -328,22 +395,40 @@ enum TDB_ERROR tdb_chainlock(struct tdb_context *tdb, TDB_DATA key); */ enum TDB_ERROR tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key); +/** + * tdb_wipe_all - wipe the database clean + * @tdb: the tdb context returned from tdb_open() + * + * Completely erase the database. This is faster than iterating through + * each key and doing tdb_delete. + */ +enum TDB_ERROR tdb_wipe_all(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: pointer for @check + * @private: 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(). + * + * Returns TDB_SUCCESS or an error. */ -enum TDB_ERROR tdb_check(struct tdb_context *tdb, - enum TDB_ERROR (*check)(TDB_DATA key, - TDB_DATA data, - void *private_data), - void *private_data); +#define tdb_check(tdb, check, private) \ + tdb_check_((tdb), typesafe_cb_preargs(enum TDB_ERROR, \ + (check), (private), \ + struct tdb_data, \ + struct tdb_data), \ + (private)) + +enum TDB_ERROR tdb_check_(struct tdb_context *tdb, + enum TDB_ERROR (*check)(struct tdb_data key, + struct tdb_data data, + void *private), + void *private); /** * enum tdb_summary_flags - flags for tdb_summary. @@ -370,6 +455,57 @@ enum TDB_ERROR tdb_summary(struct tdb_context *tdb, enum tdb_summary_flags flags, char **summary); + +/** + * tdb_get_flags - return the flags for a tdb + * @tdb: the tdb context returned from tdb_open() + * + * This returns the flags on the current tdb. Some of these are caused by + * the flags argument to tdb_open(), others (such as TDB_CONVERT) are + * intuited. + */ +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. + * + * You can use this to set a flag on the TDB. You cannot set these flags + * on a TDB_INTERNAL tdb. + */ +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. + * + * 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); + +/** + * tdb_name - get the name of a tdb + * @tdb: the tdb context returned from tdb_open() + * + * This returns a copy of the name string, made at tdb_open() time. If that + * argument was NULL (possible for a TDB_INTERNAL db) this will return NULL. + * + * This is mostly useful for logging. + */ +const char *tdb_name(const struct tdb_context *tdb); + +/** + * tdb_fd - get the file descriptor of a tdb + * @tdb: the tdb context returned from tdb_open() + * + * This returns the file descriptor for the underlying database file, or -1 + * for TDB_INTERNAL. + */ +int tdb_fd(const struct tdb_context *tdb); + /** * enum tdb_attribute_type - descriminator for union tdb_attribute. */ @@ -504,11 +640,6 @@ union tdb_attribute { struct tdb_attribute_stats stats; }; -/** - * tdb_null - a convenient value for errors. - */ -extern struct tdb_data tdb_null; - #ifdef __cplusplus } #endif