]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/tdb2.h
ttxml: made alloc failure consistent - return NULL
[ccan] / ccan / tdb2 / tdb2.h
index be5d50027712d4cf511ce60b02ae5e95bfc850e1..3fa99b15dbb6cab3d09162b3789efd5b8501e875 100644 (file)
@@ -87,6 +87,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
 #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
@@ -538,6 +539,11 @@ enum TDB_ERROR tdb_repack(struct tdb_context *tdb);
  * 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, data)                                    \
@@ -631,6 +637,7 @@ enum tdb_attribute_type {
        TDB_ATTRIBUTE_OPENHOOK = 4,
        TDB_ATTRIBUTE_FLOCK = 5,
        TDB_ATTRIBUTE_TDB1_HASHSIZE = 128,
+       TDB_ATTRIBUTE_TDB1_MAX_DEAD = 129,
 };
 
 /**
@@ -875,6 +882,19 @@ struct 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;
+};
+
 /**
  * union tdb_attribute - tdb attributes.
  *
@@ -894,6 +914,7 @@ union tdb_attribute {
        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