check_type: fix incorrect documentation.

[ccan] / ccan / tdb2 / private.h

diff --git a/ccan/tdb2/private.h b/ccan/tdb2/private.h
index 3acc06a9568e1e528f53905534a71646d48a6fb0..2062ac297b1bcb9985f026bdd8075a54473b8cef 100644 (file)
--- a/ccan/tdb2/private.h
+++ b/ccan/tdb2/private.h
@@ -60,12 +60,21 @@ typedef uint64_t tdb_off_t;
 #define TDB_HTABLE_MAGIC ((uint64_t)0x1888)
 #define TDB_CHAIN_MAGIC ((uint64_t)0x1777)
 #define TDB_FTABLE_MAGIC ((uint64_t)0x1666)
+#define TDB_CAP_MAGIC ((uint64_t)0x1555)
 #define TDB_FREE_MAGIC ((uint64_t)0xFE)
 #define TDB_HASH_MAGIC (0xA1ABE11A01092008ULL)
 #define TDB_RECOVERY_MAGIC (0xf53bc0e7ad124589ULL)
 #define TDB_RECOVERY_INVALID_MAGIC (0x0ULL)
 
-#define TDB_OFF_IS_ERR(off) unlikely(off >= (tdb_off_t)TDB_ERR_LAST)
+/* Capability bits. */
+#define TDB_CAP_TYPE_MASK      0x1FFFFFFFFFFFFFFFULL
+#define TDB_CAP_NOCHECK                0x8000000000000000ULL
+#define TDB_CAP_NOWRITE                0x4000000000000000ULL
+#define TDB_CAP_NOOPEN         0x2000000000000000ULL
+
+#define TDB_OFF_IS_ERR(off) unlikely(off >= (tdb_off_t)(long)TDB_ERR_LAST)
+#define TDB_OFF_TO_ERR(off) ((enum TDB_ERROR)(long)(off))
+#define TDB_ERR_TO_OFF(ecode) ((tdb_off_t)(long)(ecode))
 
 /* Packing errors into pointers and v.v. */
 #define TDB_PTR_IS_ERR(ptr) \
@@ -228,7 +237,8 @@ struct tdb_header {
 
        uint64_t seqnum; /* Sequence number for TDB_SEQNUM */
 
-       tdb_off_t reserved[23];
+       tdb_off_t capabilities; /* Optional linked list of capabilities. */
+       tdb_off_t reserved[22];
 
        /* Top level hash table. */
        tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
@@ -240,6 +250,13 @@ struct tdb_freetable {
        tdb_off_t buckets[TDB_FREE_BUCKETS];
 };
 
+struct tdb_capability {
+       struct tdb_used_record hdr;
+       tdb_off_t type;
+       tdb_off_t next;
+       /* ... */
+};
+
 /* Information about a particular (locked) hash entry. */
 struct hash_info {
        /* Full hash value of entry. */
@@ -342,13 +359,13 @@ struct tdb_methods {
 uint64_t tdb_jenkins_hash(const void *key, size_t length, uint64_t seed,
                          void *unused);
 
-tdb_bool_err first_in_hash(struct tdb_context *tdb,
-                          struct traverse_info *tinfo,
-                          TDB_DATA *kbuf, size_t *dlen);
+enum TDB_ERROR first_in_hash(struct tdb_context *tdb,
+                            struct traverse_info *tinfo,
+                            TDB_DATA *kbuf, size_t *dlen);
 
-tdb_bool_err next_in_hash(struct tdb_context *tdb,
-                         struct traverse_info *tinfo,
-                         TDB_DATA *kbuf, size_t *dlen);
+enum TDB_ERROR next_in_hash(struct tdb_context *tdb,
+                           struct traverse_info *tinfo,
+                           TDB_DATA *kbuf, size_t *dlen);
 
 /* Hash random memory. */
 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
@@ -375,6 +392,8 @@ enum TDB_ERROR delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
 
 /* For tdb_check */
 bool is_subhash(tdb_off_t val);
+enum TDB_ERROR unknown_capability(struct tdb_context *tdb, const char *caller,
+                                 tdb_off_t type);
 
 /* free.c: */
 enum TDB_ERROR tdb_ftable_init(struct tdb_context *tdb);
@@ -393,7 +412,7 @@ enum TDB_ERROR add_free_record(struct tdb_context *tdb,
                               enum tdb_lock_flags waitflag,
                               bool coalesce_ok);
 
-/* Set up header for a used/ftable/htable/chain record. */
+/* Set up header for a used/ftable/htable/chain/capability record. */
 enum TDB_ERROR set_header(struct tdb_context *tdb,
                          struct tdb_used_record *rec,
                          unsigned magic, uint64_t keylen, uint64_t datalen,
@@ -463,6 +482,12 @@ enum TDB_ERROR tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
 void tdb_inc_seqnum(struct tdb_context *tdb);
 
 /* lock.c: */
+/* Print message because another tdb owns a lock we want. */
+enum TDB_ERROR owner_conflict(struct tdb_context *tdb, const char *call);
+
+/* If we fork, we no longer really own locks. */
+bool check_lock_pid(struct tdb_context *tdb, const char *call, bool log);
+
 /* Lock/unlock a range of hashes. */
 enum TDB_ERROR tdb_lock_hashes(struct tdb_context *tdb,
                               tdb_off_t hash_lock, tdb_len_t hash_range,
@@ -631,10 +656,18 @@ struct tdb_context {
 
 #define TDB1_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
 
+/* tdb1_check.c: */
+int tdb1_check(struct tdb_context *tdb,
+              enum TDB_ERROR (*check)(TDB_DATA key, TDB_DATA data, void *),
+              void *private_data);
+
+
 /* tdb1_open.c: */
-int tdb1_new_database(struct tdb_context *tdb,
-                     struct tdb_attribute_tdb1_hashsize *hashsize);
-enum TDB_ERROR tdb1_open(struct tdb_context *tdb);
+enum TDB_ERROR tdb1_new_database(struct tdb_context *tdb,
+                                struct tdb_attribute_tdb1_hashsize *hashsize,
+                                struct tdb_attribute_tdb1_max_dead *max_dead);
+enum TDB_ERROR tdb1_open(struct tdb_context *tdb,
+                        struct tdb_attribute_tdb1_max_dead *max_dead);
 
 /* tdb1_io.c: */
 enum TDB_ERROR tdb1_probe_length(struct tdb_context *tdb);
@@ -658,6 +691,9 @@ int tdb1_traverse(struct tdb_context *tdb,
                  int (*)(struct tdb_context *, TDB_DATA, TDB_DATA, void *),
                  void *private_data);
 
+/* tdb1_summary.c: */
+char *tdb1_summary(struct tdb_context *tdb);
+
 /* tdb1_tdb.c: */
 int tdb1_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf, int flag);
 enum TDB_ERROR tdb1_fetch(struct tdb_context *tdb, TDB_DATA key,
@@ -665,6 +701,23 @@ enum TDB_ERROR tdb1_fetch(struct tdb_context *tdb, TDB_DATA key,
 int tdb1_append(struct tdb_context *tdb, TDB_DATA key, TDB_DATA new_dbuf);
 int tdb1_delete(struct tdb_context *tdb, TDB_DATA key);
 int tdb1_exists(struct tdb_context *tdb, TDB_DATA key);
+enum TDB_ERROR tdb1_parse_record(struct tdb_context *tdb, TDB_DATA key,
+                                enum TDB_ERROR (*parser)(TDB_DATA key,
+                                                         TDB_DATA data,
+                                                         void *private_data),
+                                void *private_data);
+void tdb1_increment_seqnum_nonblock(struct tdb_context *tdb);
+int tdb1_get_seqnum(struct tdb_context *tdb);
+int tdb1_wipe_all(struct tdb_context *tdb);
+
+/* tdb1_transaction.c: */
+int tdb1_transaction_start(struct tdb_context *tdb);
+int tdb1_transaction_prepare_commit(struct tdb_context *tdb);
+int tdb1_transaction_commit(struct tdb_context *tdb);
+
+/* tdb1_traverse.c: */
+TDB_DATA tdb1_firstkey(struct tdb_context *tdb);
+TDB_DATA tdb1_nextkey(struct tdb_context *tdb, TDB_DATA key);
 
 /* tdb.c: */
 enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,