]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/private.h
tdb2: rearrange log function to put data arg at the end.
[ccan] / ccan / tdb2 / private.h
index 236aa3696d6b4c30efe7e974b53500b51c2f7832..a569b1db3667b05e27e6aaf27fdf0afd02182898 100644 (file)
@@ -18,8 +18,7 @@
    License along with this library; if not, see <http://www.gnu.org/licenses/>.
 */
 
-#define _XOPEN_SOURCE 500
-#define _FILE_OFFSET_BITS 64
+#include "config.h"
 #include <stdint.h>
 #include <stdbool.h>
 #include <stdlib.h>
@@ -33,7 +32,6 @@
 #include <stdio.h>
 #include <utime.h>
 #include <unistd.h>
-#include "config.h"
 #include <ccan/tdb2/tdb2.h>
 #include <ccan/likely/likely.h>
 #include <ccan/compiler/compiler.h>
@@ -77,7 +75,7 @@ typedef uint64_t tdb_off_t;
 
 /* Packing errors into pointers and v.v. */
 #define TDB_PTR_IS_ERR(ptr) \
-       unlikely((void *)(ptr) >= (void *)(long)TDB_ERR_LAST)
+       unlikely((unsigned long)(ptr) >= (unsigned long)TDB_ERR_LAST)
 #define TDB_PTR_ERR(p) ((enum TDB_ERROR)(long)(p))
 #define TDB_ERR_PTR(err) ((void *)(long)(err))
 
@@ -91,7 +89,7 @@ typedef int tdb_bool_err;
 /* Expanding file. */
 #define TDB_EXPANSION_LOCK 2
 /* Hash chain locks. */
-#define TDB_HASH_LOCK_START 3
+#define TDB_HASH_LOCK_START 64
 
 /* Range for hash locks. */
 #define TDB_HASH_LOCK_RANGE_BITS 30
@@ -118,6 +116,9 @@ typedef int tdb_bool_err;
 #define TDB_OFF_HASH_EXTRA_BIT 57
 #define TDB_OFF_UPPER_STEAL_SUBHASH_BIT 56
 
+/* Additional features we understand.  Currently: none. */
+#define TDB_FEATURE_MASK ((uint64_t)0)
+
 /* The bit number where we store the extra hash bits. */
 /* Convenience mask to get actual offset. */
 #define TDB_OFF_MASK \
@@ -242,7 +243,12 @@ struct tdb_header {
        tdb_off_t free_table; /* (First) free table. */
        tdb_off_t recovery; /* Transaction recovery area. */
 
-       tdb_off_t reserved[26];
+       uint64_t features_used; /* Features all writers understand */
+       uint64_t features_offered; /* Features offered */
+
+       uint64_t seqnum; /* Sequence number for TDB_SEQNUM */
+
+       tdb_off_t reserved[23];
 
        /* Top level hash table. */
        tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
@@ -296,7 +302,8 @@ enum tdb_lock_flags {
        TDB_LOCK_NOCHECK = 4,
 };
 
-struct tdb_lock_type {
+struct tdb_lock {
+       struct tdb_context *owner;
        uint32_t off;
        uint32_t count;
        uint32_t ltype;
@@ -311,21 +318,39 @@ struct tdb_access_hdr {
        bool convert;
 };
 
-struct tdb_context {
-       /* Filename of the database. */
-       const char *name;
+struct tdb_file {
+       /* Single list of all TDBs, to detect multiple opens. */
+       struct tdb_file *next;
+
+       /* How many are sharing us? */
+       unsigned int refcnt;
 
        /* Mmap (if any), or malloc (for TDB_INTERNAL). */
        void *map_ptr;
 
-       /* Are we accessing directly? (debugging check). */
-       int direct_access;
+       /* How much space has been mapped (<= current file size) */
+       tdb_len_t map_size;
 
-        /* Open file descriptor (undefined for TDB_INTERNAL). */
+       /* The file descriptor (-1 for TDB_INTERNAL). */
        int fd;
 
-       /* How much space has been mapped (<= current file size) */
-       tdb_len_t map_size;
+       /* Lock information */
+       pid_t locker;
+       struct tdb_lock allrecord_lock;
+       size_t num_lockrecs;
+       struct tdb_lock *lockrecs;
+
+       /* Identity of this file. */
+       dev_t device;
+       ino_t inode;
+};
+
+struct tdb_context {
+       /* Filename of the database. */
+       const char *name;
+
+       /* Are we accessing directly? (debugging check). */
+       int direct_access;
 
        /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
        bool read_only;
@@ -340,15 +365,15 @@ struct tdb_context {
        uint32_t flags;
 
        /* Logging function */
-       void (*logfn)(struct tdb_context *tdb,
-                     enum tdb_log_level level,
-                     void *log_private,
-                     const char *message);
-       void *log_private;
+       void (*log_fn)(struct tdb_context *tdb,
+                      enum tdb_log_level level,
+                      const char *message,
+                      void *data);
+       void *log_data;
 
        /* Hash function. */
-       uint64_t (*khash)(const void *key, size_t len, uint64_t seed, void *);
-       void *hash_priv;
+       uint64_t (*hash_fn)(const void *key, size_t len, uint64_t seed, void *);
+       void *hash_data;
        uint64_t hash_seed;
 
        /* Set if we are in a transaction. */
@@ -361,20 +386,16 @@ struct tdb_context {
        /* IO methods: changes for transactions. */
        const struct tdb_methods *methods;
 
-       /* Lock information */
-       struct tdb_lock_type allrecord_lock;
-       size_t num_lockrecs;
-       struct tdb_lock_type *lockrecs;
-
        struct tdb_attribute_stats *stats;
 
        /* Direct access information */
        struct tdb_access_hdr *access;
 
-       /* Single list of all TDBs, to avoid multiple opens. */
-       struct tdb_context *next;
-       dev_t device;
-       ino_t inode;
+       /* Last error we returned. */
+       enum TDB_ERROR last_error;
+
+       /* The actual file information */
+       struct tdb_file *file;
 };
 
 struct tdb_methods {
@@ -453,7 +474,7 @@ unsigned int size_to_bucket(tdb_len_t data_len);
 tdb_off_t bucket_off(tdb_off_t ftable_off, unsigned bucket);
 
 /* Used by tdb_summary */
-size_t dead_space(struct tdb_context *tdb, tdb_off_t off);
+tdb_off_t dead_space(struct tdb_context *tdb, tdb_off_t off);
 
 /* io.c: */
 /* Initialize tdb->methods. */
@@ -463,7 +484,7 @@ void tdb_io_init(struct tdb_context *tdb);
 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
 
 /* Unmap and try to map the tdb. */
-void tdb_munmap(struct tdb_context *tdb);
+void tdb_munmap(struct tdb_file *file);
 void tdb_mmap(struct tdb_context *tdb);
 
 /* Either alloc a copy, or give direct access.  Release frees or noop. */
@@ -508,6 +529,9 @@ enum TDB_ERROR tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
 enum TDB_ERROR tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
                                void *rec, size_t len);
 
+/* Bump the seqnum (caller checks for tdb->flags & TDB_SEQNUM) */
+void tdb_inc_seqnum(struct tdb_context *tdb);
+
 /* Adds a stat, if it's in range. */
 void add_stat_(struct tdb_context *tdb, uint64_t *stat, size_t val);
 #define add_stat(tdb, statname, val)                                   \
@@ -517,8 +541,6 @@ void add_stat_(struct tdb_context *tdb, uint64_t *stat, size_t val);
        } while (0)
 
 /* lock.c: */
-void tdb_lock_init(struct tdb_context *tdb);
-
 /* 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,
@@ -527,6 +549,9 @@ enum TDB_ERROR tdb_unlock_hashes(struct tdb_context *tdb,
                                 tdb_off_t hash_lock,
                                 tdb_len_t hash_range, int ltype);
 
+/* For closing the file. */
+void tdb_lock_cleanup(struct tdb_context *tdb);
+
 /* Lock/unlock a particular free bucket. */
 enum TDB_ERROR tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
                                    enum tdb_lock_flags waitflag);
@@ -560,8 +585,8 @@ bool tdb_has_expansion_lock(struct tdb_context *tdb);
 enum TDB_ERROR tdb_lock_and_recover(struct tdb_context *tdb);
 
 /* transaction.c: */
-int tdb_transaction_recover(struct tdb_context *tdb);
-bool tdb_needs_recovery(struct tdb_context *tdb);
+enum TDB_ERROR tdb_transaction_recover(struct tdb_context *tdb);
+tdb_bool_err tdb_needs_recovery(struct tdb_context *tdb);
 
 /* tdb.c: */
 enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,