tdb2: don't cancel transaction when tdb_transaction_prepare_commit fails

[ccan] / ccan / tdb2 / tdb2.h

diff --git a/ccan/tdb2/tdb2.h b/ccan/tdb2/tdb2.h
index 802bcdbe10e02d7b52fc51fb90a9cec968a2f527..d78ef974b340cece0ac3306c7052edd21928deb5 100644 (file)
--- a/ccan/tdb2/tdb2.h
+++ b/ccan/tdb2/tdb2.h
@@ -288,6 +288,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 +327,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 +335,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
@@ -490,7 +493,7 @@ 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: 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
@@ -499,18 +502,18 @@ enum TDB_ERROR tdb_wipe_all(struct tdb_context *tdb);
  *
  * 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)
@@ -606,7 +609,8 @@ enum tdb_attribute_type {
        TDB_ATTRIBUTE_LOG = 0,
        TDB_ATTRIBUTE_HASH = 1,
        TDB_ATTRIBUTE_SEED = 2,
-       TDB_ATTRIBUTE_STATS = 3
+       TDB_ATTRIBUTE_STATS = 3,
+       TDB_ATTRIBUTE_OPENHOOK = 4
 };
 
 /**
@@ -640,11 +644,11 @@ 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,
+                  const char *message,
+                  void *data);
+       void *data;
 };
 
 /**
@@ -661,9 +665,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;
 };
 
 /**
@@ -716,6 +720,22 @@ struct tdb_attribute_stats {
        uint64_t    lock_nonblock;
 };
 
+/**
+ * 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;
+};
+
 /**
  * union tdb_attribute - tdb attributes.
  *
@@ -723,7 +743,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.
  */
 union tdb_attribute {
        struct tdb_attribute_base base;
@@ -731,6 +752,7 @@ union tdb_attribute {
        struct tdb_attribute_hash hash;
        struct tdb_attribute_seed seed;
        struct tdb_attribute_stats stats;
+       struct tdb_attribute_openhook openhook;
 };
 
 #ifdef  __cplusplus