tdb2: Implement tdb_get_flags, tdb_add_flag and tdb_remove_flag.
[ccan] / ccan / tdb2 / tdb2.h
index c0ab8eb07529d521b359874d8cdcf541783714c3..47661da245352583f5491b440fec2e58b1ff0e68 100644 (file)
@@ -40,6 +40,7 @@ extern "C" {
 #include <stdint.h>
 #endif
 #include <ccan/compiler/compiler.h>
+#include <ccan/typesafe_cb/typesafe_cb.h>
 
 union tdb_attribute;
 struct tdb_context;
@@ -249,9 +250,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,7 +267,14 @@ 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_firstkey - get the "first" key in a TDB
@@ -327,18 +332,27 @@ enum TDB_ERROR tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key);
  * 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 +379,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.
  */