]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/tdb2.h
tdb2: implement tdb_exists and tdb_parse_record
[ccan] / ccan / tdb2 / tdb2.h
index c0ab8eb07529d521b359874d8cdcf541783714c3..50903a7641bfcc409c2c26d7d74a0a1c40210d60 100644 (file)
@@ -38,8 +38,11 @@ extern "C" {
 #include <signal.h>
 /* For uint64_t */
 #include <stdint.h>
+/* For bool */
+#include <stdbool.h>
 #endif
 #include <ccan/compiler/compiler.h>
+#include <ccan/typesafe_cb/typesafe_cb.h>
 
 union tdb_attribute;
 struct tdb_context;
@@ -196,6 +199,15 @@ 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_transaction_start - start a transaction
  * @tdb: the tdb context returned from tdb_open()
@@ -249,9 +261,6 @@ enum TDB_ERROR tdb_transaction_commit(struct tdb_context *tdb);
  */
 enum TDB_ERROR tdb_transaction_prepare_commit(struct tdb_context *tdb);
 
-/* FIXME: Make typesafe */
-typedef int (*tdb_traverse_func)(struct tdb_context *, TDB_DATA, TDB_DATA, void *);
-
 /**
  * tdb_traverse - traverse a TDB
  * @tdb: the tdb context returned from tdb_open()
@@ -269,8 +278,39 @@ typedef int (*tdb_traverse_func)(struct tdb_context *, TDB_DATA, TDB_DATA, void
  * On success, returns the number of keys iterated.  On error returns
  * a negative enum TDB_ERROR value.
  */
-int64_t tdb_traverse(struct tdb_context *tdb, tdb_traverse_func fn, void *p);
+#define tdb_traverse(tdb, fn, p)                                       \
+       tdb_traverse_(tdb, typesafe_cb_preargs(int, (fn), (p),          \
+                                              struct tdb_context *,    \
+                                              TDB_DATA, TDB_DATA), (p))
+
+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_firstkey - get the "first" key in a TDB
  * @tdb: the tdb context returned from tdb_open()
@@ -323,22 +363,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.
@@ -365,6 +423,37 @@ 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);
+
 /**
  * enum tdb_attribute_type - descriminator for union tdb_attribute.
  */