tdb: fix test helper to include own header, fix function definition.

[ccan] / ccan / tdb / open.c

diff --git a/ccan/tdb/open.c b/ccan/tdb/open.c
index 69885284c55d6abfce78b4d15d9b126a442d8ea1..aa32a45eda3957aa04e8c9444a9ba2bd749b1207 100644 (file)
--- a/ccan/tdb/open.c
+++ b/ccan/tdb/open.c
@@ -44,6 +44,25 @@ static unsigned int default_tdb_hash(TDB_DATA *key)
        return (1103515243 * value + 12345);  
 }
 
        return (1103515243 * value + 12345);  
 }
 

+/* We use two hashes to double-check they're using the right hash function. */
+void tdb_header_hash(struct tdb_context *tdb,
+                    uint32_t *magic1_hash, uint32_t *magic2_hash)
+{
+       TDB_DATA hash_key;
+       uint32_t tdb_magic = TDB_MAGIC;
+
+       hash_key.dptr = (unsigned char *)TDB_MAGIC_FOOD;
+       hash_key.dsize = sizeof(TDB_MAGIC_FOOD);
+       *magic1_hash = tdb->hash_fn(&hash_key);
+
+       hash_key.dptr = CONVERT(tdb_magic);
+       hash_key.dsize = sizeof(tdb_magic);
+       *magic2_hash = tdb->hash_fn(&hash_key);
+
+       /* Make sure at least one hash is non-zero! */
+       if (*magic1_hash == 0 && *magic2_hash == 0)
+               *magic1_hash = 1;
+}

 
 /* initialise a new database with a specified hash size */
 static int tdb_new_database(struct tdb_context *tdb, int hash_size)
 
 /* initialise a new database with a specified hash size */
 static int tdb_new_database(struct tdb_context *tdb, int hash_size)


@@ -55,12 +74,17 @@ static int tdb_new_database(struct tdb_context *tdb, int hash_size)
 
        /* We make it up in memory, then write it out if not internal */
        size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);
 
        /* We make it up in memory, then write it out if not internal */
        size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);

-       if (!(newdb = (struct tdb_header *)calloc(size, 1)))
-               return TDB_ERRCODE(TDB_ERR_OOM, -1);
+       if (!(newdb = (struct tdb_header *)calloc(size, 1))) {
+               tdb->ecode = TDB_ERR_OOM;
+               return -1;
+       }

 
        /* Fill in the header */
        newdb->version = TDB_VERSION;
        newdb->hash_size = hash_size;
 
        /* Fill in the header */
        newdb->version = TDB_VERSION;
        newdb->hash_size = hash_size;

+
+       tdb_header_hash(tdb, &newdb->magic1_hash, &newdb->magic2_hash);
+

        if (tdb->flags & TDB_INTERNAL) {
                tdb->map_size = size;
                tdb->map_ptr = (char *)newdb;
        if (tdb->flags & TDB_INTERNAL) {
                tdb->map_size = size;
                tdb->map_ptr = (char *)newdb;


@@ -153,15 +177,20 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
        unsigned char *vp;
        uint32_t vertest;
        unsigned v;
        unsigned char *vp;
        uint32_t vertest;
        unsigned v;

+       uint32_t magic1_hash;
+       uint32_t magic2_hash;
+       const char *hash_alg;

 
        if (!(tdb = (struct tdb_context *)calloc(1, sizeof *tdb))) {
                /* Can't log this */
                errno = ENOMEM;
                goto fail;
        }
 
        if (!(tdb = (struct tdb_context *)calloc(1, sizeof *tdb))) {
                /* Can't log this */
                errno = ENOMEM;
                goto fail;
        }

-

        tdb_io_init(tdb);
        tdb->fd = -1;
        tdb_io_init(tdb);
        tdb->fd = -1;

+#ifdef TDB_TRACE
+       tdb->tracefd = -1;
+#endif

        tdb->name = NULL;
        tdb->map_ptr = NULL;
        tdb->flags = tdb_flags;
        tdb->name = NULL;
        tdb->map_ptr = NULL;
        tdb->flags = tdb_flags;


@@ -172,7 +201,14 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
                tdb->log.log_fn = null_log_fn;
                tdb->log.log_private = NULL;
        }
                tdb->log.log_fn = null_log_fn;
                tdb->log.log_private = NULL;
        }

-       tdb->hash_fn = hash_fn ? hash_fn : default_tdb_hash;
+
+       if (hash_fn) {
+               tdb->hash_fn = hash_fn;
+               hash_alg = "user defined";
+       } else {
+               tdb->hash_fn = default_tdb_hash;
+               hash_alg = "default";
+       }

 
        /* cache the page size */
        tdb->page_size = getpagesize();
 
        /* cache the page size */
        tdb->page_size = getpagesize();


@@ -198,6 +234,22 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
                tdb->flags &= ~TDB_CLEAR_IF_FIRST;
        }
 
                tdb->flags &= ~TDB_CLEAR_IF_FIRST;
        }
 

+       if ((tdb->flags & TDB_ALLOW_NESTING) &&
+           (tdb->flags & TDB_DISALLOW_NESTING)) {
+               tdb->ecode = TDB_ERR_NESTING;
+               TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
+                       "allow_nesting and disallow_nesting are not allowed together!"));
+               errno = EINVAL;
+               goto fail;
+       }
+
+       /*
+        * TDB_DISALLOW_NESTING is the default behavior.
+        */
+       if (!(tdb->flags & TDB_ALLOW_NESTING)) {
+               tdb->flags |= TDB_DISALLOW_NESTING;
+       }
+

        /* internal databases don't mmap or lock, and start off cleared */
        if (tdb->flags & TDB_INTERNAL) {
                tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
        /* internal databases don't mmap or lock, and start off cleared */
        if (tdb->flags & TDB_INTERNAL) {
                tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);


@@ -206,10 +258,6 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
                        TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: tdb_new_database failed!"));
                        goto fail;
                }
                        TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: tdb_new_database failed!"));
                        goto fail;
                }

-#ifdef TDB_TRACE
-               /* All tracing will fail.  That's ok. */
-               tdb->tracefd = -1;
-#endif

                goto internal;
        }
 
                goto internal;
        }
 


@@ -224,8 +272,8 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
 
        /* ensure there is only one process initialising at once */
         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
 
        /* ensure there is only one process initialising at once */

-       if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_WRLCK, F_SETLKW, 0, 1) == -1) {
-               TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to get global lock on %s: %s\n",
+       if (tdb_nest_lock(tdb, OPEN_LOCK, F_WRLCK, TDB_LOCK_WAIT) == -1) {
+               TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to get open lock on %s: %s\n",

                         name, strerror(errno)));
                goto fail;      /* errno set by tdb_brlock */
        }
                         name, strerror(errno)));
                goto fail;      /* errno set by tdb_brlock */
        }


@@ -233,7 +281,7 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
        /* we need to zero database if we are the only one with it open */
        if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
            (!tdb->read_only) &&
        /* we need to zero database if we are the only one with it open */
        if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
            (!tdb->read_only) &&

-           (locked = (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_WRLCK, F_SETLK, 0, 1) == 0))) {
+           (locked = (tdb_nest_lock(tdb, ACTIVE_LOCK, F_WRLCK, TDB_LOCK_NOWAIT|TDB_LOCK_PROBE) == 0))) {

                open_flags |= O_CREAT;
                if (ftruncate(tdb->fd, 0) == -1) {
                        TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
                open_flags |= O_CREAT;
                if (ftruncate(tdb->fd, 0) == -1) {
                        TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "


@@ -245,17 +293,19 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
 
        errno = 0;
        if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
 
        errno = 0;
        if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)

-           || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0
-           || (tdb->header.version != TDB_VERSION
-               && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION))))) {
-               /* its not a valid database - possibly initialise it */
+           || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0) {

                if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
                        if (errno == 0) {
                if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
                        if (errno == 0) {

-                       errno = EIO; /* ie bad format or something */
+                               errno = EIO; /* ie bad format or something */

                        }
                        goto fail;
                }
                rev = (tdb->flags & TDB_CONVERT);
                        }
                        goto fail;
                }
                rev = (tdb->flags & TDB_CONVERT);

+       } else if (tdb->header.version != TDB_VERSION
+                  && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION)))) {
+               /* wrong version */
+               errno = EIO;
+               goto fail;

        }
        vp = (unsigned char *)&tdb->header.version;
        vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |
        }
        vp = (unsigned char *)&tdb->header.version;
        vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |


@@ -275,6 +325,27 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
                goto fail;
        }
 
                goto fail;
        }
 

+       tdb_header_hash(tdb, &magic1_hash, &magic2_hash);
+
+       if ((tdb->header.magic1_hash == 0) && (tdb->header.magic2_hash == 0)) {
+               /* older TDB without magic hash references */
+       } else if ((tdb->header.magic1_hash != magic1_hash) ||
+                  (tdb->header.magic2_hash != magic2_hash)) {
+               TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
+                        "%s was not created with the %s hash function we are using\n"
+                        "magic1_hash[0x%08X %s 0x%08X] "
+                        "magic2_hash[0x%08X %s 0x%08X]\n",
+                        name, hash_alg,
+                        tdb->header.magic1_hash,
+                        (tdb->header.magic1_hash == magic1_hash) ? "==" : "!=",
+                        magic1_hash,
+                        tdb->header.magic2_hash,
+                        (tdb->header.magic2_hash == magic2_hash) ? "==" : "!=",
+                        magic2_hash));
+               errno = EINVAL;
+               goto fail;
+       }
+

        /* Is it already in the open list?  If so, fail. */
        if (tdb_already_open(st.st_dev, st.st_ino)) {
                TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
        /* Is it already in the open list?  If so, fail. */
        if (tdb_already_open(st.st_dev, st.st_ino)) {
                TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "


@@ -294,7 +365,7 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
        tdb->inode = st.st_ino;
        tdb_mmap(tdb);
        if (locked) {
        tdb->inode = st.st_ino;
        tdb_mmap(tdb);
        if (locked) {

-               if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_UNLCK, F_SETLK, 0, 1) == -1) {
+               if (tdb_nest_unlock(tdb, ACTIVE_LOCK, F_WRLCK, false) == -1) {

                        TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
                                 "failed to take ACTIVE_LOCK on %s: %s\n",
                                 name, strerror(errno)));
                        TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
                                 "failed to take ACTIVE_LOCK on %s: %s\n",
                                 name, strerror(errno)));


@@ -309,8 +380,9 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
 
        if (tdb_flags & TDB_CLEAR_IF_FIRST) {
                /* leave this lock in place to indicate it's in use */
 
        if (tdb_flags & TDB_CLEAR_IF_FIRST) {
                /* leave this lock in place to indicate it's in use */

-               if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0, 1) == -1)
+               if (tdb_nest_lock(tdb, ACTIVE_LOCK, F_RDLCK, TDB_LOCK_WAIT) == -1) {

                        goto fail;
                        goto fail;

+               }

        }
 
        /* if needed, run recovery */
        }
 
        /* if needed, run recovery */


@@ -322,22 +394,25 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
        {
                char tracefile[strlen(name) + 32];
 
        {
                char tracefile[strlen(name) + 32];
 

-               sprintf(tracefile, "%s.trace.%u", name, getpid());
+               snprintf(tracefile, sizeof(tracefile),
+                        "%s.trace.%li", name, (long)getpid());

                tdb->tracefd = open(tracefile, O_WRONLY|O_CREAT|O_EXCL, 0600);
                tdb->tracefd = open(tracefile, O_WRONLY|O_CREAT|O_EXCL, 0600);

-               if (tdb->tracefd < 0)
-                       goto fail;
-               tdb_enable_seqnum(tdb);
-               tdb_trace_open(tdb, "tdb_open", hash_size, tdb_flags,
-                              open_flags);
+               if (tdb->tracefd >= 0) {
+                       tdb_enable_seqnum(tdb);
+                       tdb_trace_open(tdb, "tdb_open", hash_size, tdb_flags,
+                                      open_flags);
+               } else
+                       TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to open trace file %s!\n", tracefile));

        }
 #endif
 
  internal:
        /* Internal (memory-only) databases skip all the code above to
         * do with disk files, and resume here by releasing their
        }
 #endif
 
  internal:
        /* Internal (memory-only) databases skip all the code above to
         * do with disk files, and resume here by releasing their

-        * global lock and hooking into the active list. */
-       if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_UNLCK, F_SETLKW, 0, 1) == -1)
+        * open lock and hooking into the active list. */
+       if (tdb_nest_unlock(tdb, OPEN_LOCK, F_WRLCK, false) == -1) {

                goto fail;
                goto fail;

+       }

        tdb->next = tdbs;
        tdbs = tdb;
        return tdb;
        tdb->next = tdbs;
        tdbs = tdb;
        return tdb;


@@ -348,8 +423,9 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
        if (!tdb)
                return NULL;
 
        if (!tdb)
                return NULL;
 

+#ifdef TDB_TRACE

        close(tdb->tracefd);
        close(tdb->tracefd);

-       
+#endif

        if (tdb->map_ptr) {
                if (tdb->flags & TDB_INTERNAL)
                        SAFE_FREE(tdb->map_ptr);
        if (tdb->map_ptr) {
                if (tdb->flags & TDB_INTERNAL)
                        SAFE_FREE(tdb->map_ptr);


@@ -360,6 +436,7 @@ struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
        if (tdb->fd != -1)
                if (close(tdb->fd) != 0)
                        TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to close tdb->fd on error!\n"));
        if (tdb->fd != -1)
                if (close(tdb->fd) != 0)
                        TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to close tdb->fd on error!\n"));

+       SAFE_FREE(tdb->lockrecs);

        SAFE_FREE(tdb);
        errno = save_errno;
        return NULL;
        SAFE_FREE(tdb);
        errno = save_errno;
        return NULL;


@@ -385,10 +462,10 @@ int tdb_close(struct tdb_context *tdb)
        struct tdb_context **i;
        int ret = 0;
 
        struct tdb_context **i;
        int ret = 0;
 

-       tdb_trace(tdb, "tdb_close");

        if (tdb->transaction) {
        if (tdb->transaction) {

-               tdb_transaction_cancel_internal(tdb);
+               tdb_transaction_cancel(tdb);

        }
        }

+       tdb_trace(tdb, "tdb_close");

 
        if (tdb->map_ptr) {
                if (tdb->flags & TDB_INTERNAL)
 
        if (tdb->map_ptr) {
                if (tdb->flags & TDB_INTERNAL)


@@ -397,8 +474,10 @@ int tdb_close(struct tdb_context *tdb)
                        tdb_munmap(tdb);
        }
        SAFE_FREE(tdb->name);
                        tdb_munmap(tdb);
        }
        SAFE_FREE(tdb->name);

-       if (tdb->fd != -1)
+       if (tdb->fd != -1) {

                ret = close(tdb->fd);
                ret = close(tdb->fd);

+               tdb->fd = -1;
+       }

        SAFE_FREE(tdb->lockrecs);
 
        /* Remove from contexts list */
        SAFE_FREE(tdb->lockrecs);
 
        /* Remove from contexts list */


@@ -409,7 +488,9 @@ int tdb_close(struct tdb_context *tdb)
                }
        }
 
                }
        }
 

+#ifdef TDB_TRACE

        close(tdb->tracefd);
        close(tdb->tracefd);

+#endif

        memset(tdb, 0, sizeof(*tdb));
        SAFE_FREE(tdb);
 
        memset(tdb, 0, sizeof(*tdb));
        SAFE_FREE(tdb);
 


@@ -428,9 +509,7 @@ void *tdb_get_logging_private(struct tdb_context *tdb)
        return tdb->log.log_private;
 }
 
        return tdb->log.log_private;
 }
 

-/* reopen a tdb - this can be used after a fork to ensure that we have an independent
-   seek pointer from our parent and to re-establish locks */
-int tdb_reopen(struct tdb_context *tdb)
+static int tdb_reopen_internal(struct tdb_context *tdb, bool active_lock)

 {
        struct stat st;
 
 {
        struct stat st;
 


@@ -438,7 +517,7 @@ int tdb_reopen(struct tdb_context *tdb)
                return 0; /* Nothing to do. */
        }
 
                return 0; /* Nothing to do. */
        }
 

-       if (tdb->num_locks != 0 || tdb->global_lock.count) {
+       if (tdb_have_extra_locks(tdb)) {

                TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed with locks held\n"));
                goto fail;
        }
                TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed with locks held\n"));
                goto fail;
        }


@@ -459,11 +538,6 @@ int tdb_reopen(struct tdb_context *tdb)
                TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: open failed (%s)\n", strerror(errno)));
                goto fail;
        }
                TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: open failed (%s)\n", strerror(errno)));
                goto fail;
        }

-       if ((tdb->flags & TDB_CLEAR_IF_FIRST) && 
-           (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0, 1) == -1)) {
-               TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: failed to obtain active lock\n"));
-               goto fail;
-       }

        if (fstat(tdb->fd, &st) != 0) {
                TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
                goto fail;
        if (fstat(tdb->fd, &st) != 0) {
                TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
                goto fail;


@@ -474,6 +548,15 @@ int tdb_reopen(struct tdb_context *tdb)
        }
        tdb_mmap(tdb);
 
        }
        tdb_mmap(tdb);
 

+       /* We may still think we hold the active lock. */
+       tdb->num_lockrecs = 0;
+       SAFE_FREE(tdb->lockrecs);
+
+       if (active_lock && tdb_nest_lock(tdb, ACTIVE_LOCK, F_RDLCK, TDB_LOCK_WAIT) == -1) {
+               TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: failed to obtain active lock\n"));
+               goto fail;
+       }
+

        return 0;
 
 fail:
        return 0;
 
 fail:


@@ -481,12 +564,21 @@ fail:
        return -1;
 }
 
        return -1;
 }
 

+/* reopen a tdb - this can be used after a fork to ensure that we have an independent
+   seek pointer from our parent and to re-establish locks */
+int tdb_reopen(struct tdb_context *tdb)
+{
+       return tdb_reopen_internal(tdb, tdb->flags & TDB_CLEAR_IF_FIRST);
+}
+

 /* reopen all tdb's */
 int tdb_reopen_all(int parent_longlived)
 {
        struct tdb_context *tdb;
 
        for (tdb=tdbs; tdb; tdb = tdb->next) {
 /* reopen all tdb's */
 int tdb_reopen_all(int parent_longlived)
 {
        struct tdb_context *tdb;
 
        for (tdb=tdbs; tdb; tdb = tdb->next) {

+               bool active_lock = (tdb->flags & TDB_CLEAR_IF_FIRST);
+

                /*
                 * If the parent is longlived (ie. a
                 * parent daemon architecture), we know
                /*
                 * If the parent is longlived (ie. a
                 * parent daemon architecture), we know


@@ -500,10 +592,10 @@ int tdb_reopen_all(int parent_longlived)
                 */
                if (parent_longlived) {
                        /* Ensure no clear-if-first. */
                 */
                if (parent_longlived) {
                        /* Ensure no clear-if-first. */

-                       tdb->flags &= ~TDB_CLEAR_IF_FIRST;
+                       active_lock = false;

                }
 
                }
 

-               if (tdb_reopen(tdb) != 0)
+               if (tdb_reopen_internal(tdb, active_lock) != 0)

                        return -1;
        }
 
                        return -1;
        }