]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/open.c
tdb2: tdb_set_attribute, tdb_unset_attribute and tdb_get_attribute
[ccan] / ccan / tdb2 / open.c
index b72d783b4f34d4e16b589c6b47275a7b7285987b..c6fd9a090ecf3078bb4135e6b0651403d8379978 100644 (file)
@@ -1,4 +1,6 @@
 #include "private.h"
+#include <ccan/hash/hash.h>
+#include <assert.h>
 
 /* all lock info, to detect double-opens (fcntl file don't nest!) */
 static struct tdb_file *files = NULL;
@@ -9,6 +11,7 @@ static struct tdb_file *find_file(dev_t device, ino_t ino)
 
        for (i = files; i; i = i->next) {
                if (i->device == device && i->inode == ino) {
+                       i->refcnt++;
                        break;
                }
        }
@@ -99,12 +102,13 @@ static enum TDB_ERROR tdb_new_database(struct tdb_context *tdb,
        else
                newdb.hdr.hash_seed = random_number(tdb);
        newdb.hdr.hash_test = TDB_HASH_MAGIC;
-       newdb.hdr.hash_test = tdb->khash(&newdb.hdr.hash_test,
-                                        sizeof(newdb.hdr.hash_test),
-                                        newdb.hdr.hash_seed,
-                                        tdb->hash_priv);
+       newdb.hdr.hash_test = tdb->hash_fn(&newdb.hdr.hash_test,
+                                          sizeof(newdb.hdr.hash_test),
+                                          newdb.hdr.hash_seed,
+                                          tdb->hash_data);
        newdb.hdr.recovery = 0;
        newdb.hdr.features_used = newdb.hdr.features_offered = TDB_FEATURE_MASK;
+       newdb.hdr.seqnum = 0;
        memset(newdb.hdr.reserved, 0, sizeof(newdb.hdr.reserved));
        /* Initial hashes are empty. */
        memset(newdb.hdr.hashtable, 0, sizeof(newdb.hdr.hashtable));
@@ -174,9 +178,133 @@ static enum TDB_ERROR tdb_new_file(struct tdb_context *tdb)
        tdb->file->num_lockrecs = 0;
        tdb->file->lockrecs = NULL;
        tdb->file->allrecord_lock.count = 0;
+       tdb->file->refcnt = 1;
        return TDB_SUCCESS;
 }
 
+enum TDB_ERROR tdb_set_attribute(struct tdb_context *tdb,
+                                const union tdb_attribute *attr)
+{
+       switch (attr->base.attr) {
+       case TDB_ATTRIBUTE_LOG:
+               tdb->log_fn = attr->log.fn;
+               tdb->log_data = attr->log.data;
+               break;
+       case TDB_ATTRIBUTE_HASH:
+       case TDB_ATTRIBUTE_SEED:
+       case TDB_ATTRIBUTE_OPENHOOK:
+               return tdb->last_error
+                       = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                    TDB_LOG_USE_ERROR,
+                                    "tdb_set_attribute:"
+                                    " cannot set %s after opening",
+                                    attr->base.attr == TDB_ATTRIBUTE_HASH
+                                    ? "TDB_ATTRIBUTE_HASH"
+                                    : attr->base.attr == TDB_ATTRIBUTE_SEED
+                                    ? "TDB_ATTRIBUTE_SEED"
+                                    : "TDB_ATTRIBUTE_OPENHOOK");
+       case TDB_ATTRIBUTE_FLOCK:
+               tdb->lock_fn = attr->flock.lock;
+               tdb->unlock_fn = attr->flock.unlock;
+               tdb->lock_data = attr->flock.data;
+               break;
+       default:
+               return tdb->last_error
+                       = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                    TDB_LOG_USE_ERROR,
+                                    "tdb_set_attribute:"
+                                    " unknown attribute type %u",
+                                    attr->base.attr);
+       }
+       return TDB_SUCCESS;
+}
+
+static uint64_t jenkins_hash(const void *key, size_t length, uint64_t seed,
+                            void *unused)
+{
+       uint64_t ret;
+       /* hash64_stable assumes lower bits are more important; they are a
+        * slightly better hash.  We use the upper bits first, so swap them. */
+       ret = hash64_stable((const unsigned char *)key, length, seed);
+       return (ret >> 32) | (ret << 32);
+}
+
+enum TDB_ERROR tdb_get_attribute(struct tdb_context *tdb,
+                                union tdb_attribute *attr)
+{
+       switch (attr->base.attr) {
+       case TDB_ATTRIBUTE_LOG:
+               if (!tdb->log_fn)
+                       return tdb->last_error = TDB_ERR_NOEXIST;
+               attr->log.fn = tdb->log_fn;
+               attr->log.data = tdb->log_data;
+               break;
+       case TDB_ATTRIBUTE_HASH:
+               attr->hash.fn = tdb->hash_fn;
+               attr->hash.data = tdb->hash_data;
+               break;
+       case TDB_ATTRIBUTE_SEED:
+               attr->seed.seed = tdb->hash_seed;
+               break;
+       case TDB_ATTRIBUTE_OPENHOOK:
+               return tdb->last_error
+                       = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                    TDB_LOG_USE_ERROR,
+                                    "tdb_get_attribute:"
+                                    " cannot get TDB_ATTRIBUTE_OPENHOOK");
+       case TDB_ATTRIBUTE_STATS:
+               /* FIXME */
+               return TDB_ERR_EINVAL;
+       case TDB_ATTRIBUTE_FLOCK:
+               attr->flock.lock = tdb->lock_fn;
+               attr->flock.unlock = tdb->unlock_fn;
+               attr->flock.data = tdb->lock_data;
+               break;
+       default:
+               return tdb->last_error
+                       = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                    TDB_LOG_USE_ERROR,
+                                    "tdb_get_attribute:"
+                                    " unknown attribute type %u",
+                                    attr->base.attr);
+       }
+       attr->base.next = NULL;
+       return TDB_SUCCESS;
+}
+
+void tdb_unset_attribute(struct tdb_context *tdb,
+                        enum tdb_attribute_type type)
+{
+       switch (type) {
+       case TDB_ATTRIBUTE_LOG:
+               tdb->log_fn = NULL;
+               break;
+       case TDB_ATTRIBUTE_HASH:
+       case TDB_ATTRIBUTE_SEED:
+       case TDB_ATTRIBUTE_OPENHOOK:
+               tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
+                          "tdb_unset_attribute: cannot unset %s after opening",
+                          type == TDB_ATTRIBUTE_HASH
+                          ? "TDB_ATTRIBUTE_HASH"
+                          : type == TDB_ATTRIBUTE_SEED
+                          ? "TDB_ATTRIBUTE_SEED"
+                          : "TDB_ATTRIBUTE_OPENHOOK");
+               break;
+       case TDB_ATTRIBUTE_STATS:
+               /* FIXME */
+               break;
+       case TDB_ATTRIBUTE_FLOCK:
+               tdb->lock_fn = tdb_fcntl_lock;
+               tdb->unlock_fn = tdb_fcntl_unlock;
+               break;
+       default:
+               tdb_logerr(tdb, TDB_ERR_EINVAL,
+                          TDB_LOG_USE_ERROR,
+                          "tdb_unset_attribute: unknown attribute type %u",
+                          type);
+       }
+}
+
 struct tdb_context *tdb_open(const char *name, int tdb_flags,
                             int open_flags, mode_t mode,
                             union tdb_attribute *attr)
@@ -189,6 +317,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
        ssize_t rlen;
        struct tdb_header hdr;
        struct tdb_attribute_seed *seed = NULL;
+       struct tdb_attribute_openhook *openhook = NULL;
        tdb_bool_err berr;
        enum TDB_ERROR ecode;
 
@@ -201,23 +330,22 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
        tdb->name = NULL;
        tdb->direct_access = 0;
        tdb->flags = tdb_flags;
-       tdb->logfn = NULL;
+       tdb->log_fn = NULL;
        tdb->transaction = NULL;
        tdb->stats = NULL;
        tdb->access = NULL;
+       tdb->last_error = TDB_SUCCESS;
        tdb->file = NULL;
-       tdb_hash_init(tdb);
+       tdb->lock_fn = tdb_fcntl_lock;
+       tdb->unlock_fn = tdb_fcntl_unlock;
+       tdb->hash_fn = jenkins_hash;
        tdb_io_init(tdb);
 
        while (attr) {
                switch (attr->base.attr) {
-               case TDB_ATTRIBUTE_LOG:
-                       tdb->logfn = attr->log.log_fn;
-                       tdb->log_private = attr->log.log_private;
-                       break;
                case TDB_ATTRIBUTE_HASH:
-                       tdb->khash = attr->hash.hash_fn;
-                       tdb->hash_priv = attr->hash.hash_private;
+                       tdb->hash_fn = attr->hash.fn;
+                       tdb->hash_data = attr->hash.data;
                        break;
                case TDB_ATTRIBUTE_SEED:
                        seed = &attr->seed;
@@ -228,19 +356,20 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                        if (tdb->stats->size > sizeof(attr->stats))
                                tdb->stats->size = sizeof(attr->stats);
                        break;
+               case TDB_ATTRIBUTE_OPENHOOK:
+                       openhook = &attr->openhook;
+                       break;
                default:
-                       ecode = tdb_logerr(tdb, TDB_ERR_EINVAL,
-                                          TDB_LOG_USE_ERROR,
-                                          "tdb_open:"
-                                          " unknown attribute type %u",
-                                          attr->base.attr);
-                       goto fail;
+                       /* These are set as normal. */
+                       ecode = tdb_set_attribute(tdb, attr);
+                       if (ecode != TDB_SUCCESS)
+                               goto fail;
                }
                attr = attr->base.next;
        }
 
        if (tdb_flags & ~(TDB_INTERNAL | TDB_NOLOCK | TDB_NOMMAP | TDB_CONVERT
-                         | TDB_NOSYNC)) {
+                         | TDB_NOSYNC | TDB_SEQNUM)) {
                ecode = tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
                                   "tdb_open: unknown flags %u", tdb_flags);
                goto fail;
@@ -273,6 +402,16 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                if (ecode != TDB_SUCCESS) {
                        goto fail;
                }
+               if (name) {
+                       tdb->name = strdup(name);
+                       if (!tdb->name) {
+                               ecode = tdb_logerr(tdb, TDB_ERR_OOM,
+                                                  TDB_LOG_ERROR,
+                                                  "tdb_open: failed to"
+                                                  " allocate name");
+                               goto fail;
+                       }
+               }
                tdb_convert(tdb, &hdr.hash_seed, sizeof(hdr.hash_seed));
                tdb->hash_seed = hdr.hash_seed;
                tdb_ftable_init(tdb);
@@ -291,7 +430,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                        tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                                   "tdb_open: could not open file %s: %s",
                                   name, strerror(errno));
-                       goto fail;
+                       goto fail_errno;
                }
 
                /* on exec, don't inherit the fd */
@@ -303,7 +442,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                        tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                                   "tdb_open: could not stat open %s: %s",
                                   name, strerror(errno));
-                       goto fail;
+                       goto fail_errno;
                }
 
                ecode = tdb_new_file(tdb);
@@ -316,23 +455,28 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                tdb->file->inode = st.st_ino;
                tdb->file->map_ptr = NULL;
                tdb->file->map_size = sizeof(struct tdb_header);
-       } else {
-               /* FIXME */
-               ecode = tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
-                                  "tdb_open: %s (%d,%d) is already open in"
-                                  " this process",
-                                  name, (int)st.st_dev, (int)st.st_ino);
-               goto fail;
        }
 
        /* ensure there is only one process initialising at once */
        ecode = tdb_lock_open(tdb, TDB_LOCK_WAIT|TDB_LOCK_NOCHECK);
        if (ecode != TDB_SUCCESS) {
-               goto fail;
+               saved_errno = errno;
+               goto fail_errno;
+       }
+
+       /* call their open hook if they gave us one. */
+       if (openhook) {
+               ecode = openhook->fn(tdb->file->fd, openhook->data);
+               if (ecode != TDB_SUCCESS) {
+                       tdb_logerr(tdb, ecode, TDB_LOG_ERROR,
+                                  "tdb_open: open hook failed");
+                       goto fail;
+               }
+               open_flags |= O_CREAT;
        }
 
        /* If they used O_TRUNC, read will return 0. */
-       rlen = read(tdb->file->fd, &hdr, sizeof(hdr));
+       rlen = pread(tdb->file->fd, &hdr, sizeof(hdr), 0);
        if (rlen == 0 && (open_flags & O_CREAT)) {
                ecode = tdb_new_database(tdb, seed, &hdr);
                if (ecode != TDB_SUCCESS) {
@@ -416,50 +560,54 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                goto fail;
        }
 
-       /* Add to linked list. */
-       files = tdb->file;
+       /* Add to linked list if we're new. */
+       if (tdb->file->refcnt == 1)
+               files = tdb->file;
        return tdb;
 
  fail:
        /* Map ecode to some logical errno. */
-       if (!saved_errno) {
-               switch (ecode) {
-               case TDB_ERR_CORRUPT:
-               case TDB_ERR_IO:
-                       saved_errno = EIO;
-                       break;
-               case TDB_ERR_LOCK:
-                       saved_errno = EWOULDBLOCK;
-                       break;
-               case TDB_ERR_OOM:
-                       saved_errno = ENOMEM;
-                       break;
-               case TDB_ERR_EINVAL:
-                       saved_errno = EINVAL;
-                       break;
-               default:
-                       saved_errno = EINVAL;
-                       break;
-               }
+       switch (ecode) {
+       case TDB_ERR_CORRUPT:
+       case TDB_ERR_IO:
+               saved_errno = EIO;
+               break;
+       case TDB_ERR_LOCK:
+               saved_errno = EWOULDBLOCK;
+               break;
+       case TDB_ERR_OOM:
+               saved_errno = ENOMEM;
+               break;
+       case TDB_ERR_EINVAL:
+               saved_errno = EINVAL;
+               break;
+       default:
+               saved_errno = EINVAL;
+               break;
        }
 
+fail_errno:
 #ifdef TDB_TRACE
        close(tdb->tracefd);
 #endif
-       free((char *)tdb->name);
+       free(cast_const(char *, tdb->name));
        if (tdb->file) {
-               if (tdb->file->map_ptr) {
-                       if (tdb->flags & TDB_INTERNAL) {
-                               free(tdb->file->map_ptr);
-                       } else
-                               tdb_munmap(tdb->file);
+               tdb_lock_cleanup(tdb);
+               if (--tdb->file->refcnt == 0) {
+                       assert(tdb->file->num_lockrecs == 0);
+                       if (tdb->file->map_ptr) {
+                               if (tdb->flags & TDB_INTERNAL) {
+                                       free(tdb->file->map_ptr);
+                               } else
+                                       tdb_munmap(tdb->file);
+                       }
+                       if (close(tdb->file->fd) != 0)
+                               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
+                                          "tdb_open: failed to close tdb fd"
+                                          " on error: %s", strerror(errno));
+                       free(tdb->file->lockrecs);
+                       free(tdb->file);
                }
-               if (close(tdb->file->fd) != 0)
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
-                                  "tdb_open: failed to close tdb fd"
-                                  " on error: %s", strerror(errno));
-               free(tdb->file->lockrecs);
-               free(tdb->file);
        }
 
        free(tdb);
@@ -483,20 +631,24 @@ int tdb_close(struct tdb_context *tdb)
                else
                        tdb_munmap(tdb->file);
        }
-       free((char *)tdb->name);
+       free(cast_const(char *, tdb->name));
        if (tdb->file) {
                struct tdb_file **i;
-               ret = close(tdb->file->fd);
 
-               /* Remove from files list */
-               for (i = &files; *i; i = &(*i)->next) {
-                       if (*i == tdb->file) {
-                               *i = tdb->file->next;
-                               break;
+               tdb_lock_cleanup(tdb);
+               if (--tdb->file->refcnt == 0) {
+                       ret = close(tdb->file->fd);
+
+                       /* Remove from files list */
+                       for (i = &files; *i; i = &(*i)->next) {
+                               if (*i == tdb->file) {
+                                       *i = tdb->file->next;
+                                       break;
+                               }
                        }
+                       free(tdb->file->lockrecs);
+                       free(tdb->file);
                }
-               free(tdb->file->lockrecs);
-               free(tdb->file);
        }
 
 #ifdef TDB_TRACE