]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/tdb.c
failtest: add --trace to replace --tracepath
[ccan] / ccan / tdb2 / tdb.c
index d3d12250cea8b21f4bf76431957f660796d83dad..62607bf1e5d8eb2f4c9bf9002aa9b30e299a9af9 100644 (file)
@@ -1,10 +1,24 @@
+ /*
+   Trivial Database 2: fetch, store and misc routines.
+   Copyright (C) Rusty Russell 2010
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Lesser General Public
+   License as published by the Free Software Foundation; either
+   version 3 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Lesser General Public License for more details.
+
+   You should have received a copy of the GNU Lesser General Public
+   License along with this library; if not, see <http://www.gnu.org/licenses/>.
+*/
 #include "private.h"
 #include <ccan/asprintf/asprintf.h>
 #include <stdarg.h>
 
-/* The null return. */
-struct tdb_data tdb_null = { .dptr = NULL, .dsize = 0 };
-
 static enum TDB_ERROR update_rec_hdr(struct tdb_context *tdb,
                                     tdb_off_t off,
                                     tdb_len_t keylen,
@@ -36,15 +50,16 @@ static enum TDB_ERROR replace_data(struct tdb_context *tdb,
        new_off = alloc(tdb, key.dsize, dbuf.dsize, h->h, TDB_USED_MAGIC,
                        growing);
        if (TDB_OFF_IS_ERR(new_off)) {
-               return new_off;
+               return TDB_OFF_TO_ERR(new_off);
        }
 
        /* We didn't like the existing one: remove it. */
        if (old_off) {
-               add_stat(tdb, frees, 1);
+               tdb->stats.frees++;
                ecode = add_free_record(tdb, old_off,
                                        sizeof(struct tdb_used_record)
-                                       + key.dsize + old_room);
+                                       + key.dsize + old_room,
+                                       TDB_LOCK_WAIT, true);
                if (ecode == TDB_SUCCESS)
                        ecode = replace_in_hash(tdb, h, new_off);
        } else {
@@ -55,18 +70,20 @@ static enum TDB_ERROR replace_data(struct tdb_context *tdb,
        }
 
        new_off += sizeof(struct tdb_used_record);
-       ecode = tdb->methods->twrite(tdb, new_off, key.dptr, key.dsize);
+       ecode = tdb->tdb2.io->twrite(tdb, new_off, key.dptr, key.dsize);
        if (ecode != TDB_SUCCESS) {
                return ecode;
        }
 
        new_off += key.dsize;
-       ecode = tdb->methods->twrite(tdb, new_off, dbuf.dptr, dbuf.dsize);
+       ecode = tdb->tdb2.io->twrite(tdb, new_off, dbuf.dptr, dbuf.dsize);
        if (ecode != TDB_SUCCESS) {
                return ecode;
        }
 
-       /* FIXME: tdb_increment_seqnum(tdb); */
+       if (tdb->flags & TDB_SEQNUM)
+               tdb_inc_seqnum(tdb);
+
        return TDB_SUCCESS;
 }
 
@@ -77,11 +94,14 @@ static enum TDB_ERROR update_data(struct tdb_context *tdb,
 {
        enum TDB_ERROR ecode;
 
-       ecode = tdb->methods->twrite(tdb, off, dbuf.dptr, dbuf.dsize);
+       ecode = tdb->tdb2.io->twrite(tdb, off, dbuf.dptr, dbuf.dsize);
        if (ecode == TDB_SUCCESS && extra) {
                /* Put a zero in; future versions may append other data. */
-               ecode = tdb->methods->twrite(tdb, off + dbuf.dsize, "", 1);
+               ecode = tdb->tdb2.io->twrite(tdb, off + dbuf.dsize, "", 1);
        }
+       if (tdb->flags & TDB_SEQNUM)
+               tdb_inc_seqnum(tdb);
+
        return ecode;
 }
 
@@ -94,9 +114,15 @@ enum TDB_ERROR tdb_store(struct tdb_context *tdb,
        struct tdb_used_record rec;
        enum TDB_ERROR ecode;
 
+       if (tdb->flags & TDB_VERSION1) {
+               if (tdb1_store(tdb, key, dbuf, flag) == -1)
+                       return tdb->last_error;
+               return TDB_SUCCESS;
+       }
+
        off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
        if (TDB_OFF_IS_ERR(off)) {
-               return off;
+               return tdb->last_error = TDB_OFF_TO_ERR(off);
        }
 
        /* Now we have lock on this hash bucket. */
@@ -126,7 +152,7 @@ enum TDB_ERROR tdb_store(struct tdb_context *tdb,
                                }
                                tdb_unlock_hashes(tdb, h.hlock_start,
                                                  h.hlock_range, F_WRLCK);
-                               return TDB_SUCCESS;
+                               return tdb->last_error = TDB_SUCCESS;
                        }
                } else {
                        if (flag == TDB_MODIFY) {
@@ -143,7 +169,7 @@ enum TDB_ERROR tdb_store(struct tdb_context *tdb,
        ecode = replace_data(tdb, &h, key, dbuf, off, old_room, off);
 out:
        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_WRLCK);
-       return ecode;
+       return tdb->last_error = ecode;
 }
 
 enum TDB_ERROR tdb_append(struct tdb_context *tdb,
@@ -157,9 +183,15 @@ enum TDB_ERROR tdb_append(struct tdb_context *tdb,
        struct tdb_data new_dbuf;
        enum TDB_ERROR ecode;
 
+       if (tdb->flags & TDB_VERSION1) {
+               if (tdb1_append(tdb, key, dbuf) == -1)
+                       return tdb->last_error;
+               return TDB_SUCCESS;
+       }
+
        off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
        if (TDB_OFF_IS_ERR(off)) {
-               return off;
+               return tdb->last_error = TDB_OFF_TO_ERR(off);
        }
 
        if (off) {
@@ -191,7 +223,7 @@ enum TDB_ERROR tdb_append(struct tdb_context *tdb,
                                                    + dbuf.dsize));
                        goto out;
                }
-               ecode = tdb->methods->tread(tdb, off + sizeof(rec) + key.dsize,
+               ecode = tdb->tdb2.io->tread(tdb, off + sizeof(rec) + key.dsize,
                                            newdata, old_dlen);
                if (ecode != TDB_SUCCESS) {
                        goto out_free_newdata;
@@ -211,7 +243,7 @@ out_free_newdata:
        free(newdata);
 out:
        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_WRLCK);
-       return ecode;
+       return tdb->last_error = ecode;
 }
 
 enum TDB_ERROR tdb_fetch(struct tdb_context *tdb, struct tdb_data key,
@@ -222,9 +254,12 @@ enum TDB_ERROR tdb_fetch(struct tdb_context *tdb, struct tdb_data key,
        struct hash_info h;
        enum TDB_ERROR ecode;
 
+       if (tdb->flags & TDB_VERSION1)
+               return tdb1_fetch(tdb, key, data);
+
        off = find_and_lock(tdb, key, F_RDLCK, &h, &rec, NULL);
        if (TDB_OFF_IS_ERR(off)) {
-               return off;
+               return tdb->last_error = TDB_OFF_TO_ERR(off);
        }
 
        if (!off) {
@@ -240,7 +275,7 @@ enum TDB_ERROR tdb_fetch(struct tdb_context *tdb, struct tdb_data key,
        }
 
        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_RDLCK);
-       return ecode;
+       return tdb->last_error = ecode;
 }
 
 bool tdb_exists(struct tdb_context *tdb, TDB_DATA key)
@@ -249,12 +284,18 @@ bool tdb_exists(struct tdb_context *tdb, TDB_DATA key)
        struct tdb_used_record rec;
        struct hash_info h;
 
+       if (tdb->flags & TDB_VERSION1) {
+               return tdb1_exists(tdb, key);
+       }
+
        off = find_and_lock(tdb, key, F_RDLCK, &h, &rec, NULL);
        if (TDB_OFF_IS_ERR(off)) {
+               tdb->last_error = TDB_OFF_TO_ERR(off);
                return false;
        }
        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_RDLCK);
 
+       tdb->last_error = TDB_SUCCESS;
        return off ? true : false;
 }
 
@@ -265,9 +306,15 @@ enum TDB_ERROR tdb_delete(struct tdb_context *tdb, struct tdb_data key)
        struct hash_info h;
        enum TDB_ERROR ecode;
 
+       if (tdb->flags & TDB_VERSION1) {
+               if (tdb1_delete(tdb, key) == -1)
+                       return tdb->last_error;
+               return TDB_SUCCESS;
+       }
+
        off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
        if (TDB_OFF_IS_ERR(off)) {
-               return off;
+               return tdb->last_error = TDB_OFF_TO_ERR(off);
        }
 
        if (!off) {
@@ -281,16 +328,20 @@ enum TDB_ERROR tdb_delete(struct tdb_context *tdb, struct tdb_data key)
        }
 
        /* Free the deleted entry. */
-       add_stat(tdb, frees, 1);
+       tdb->stats.frees++;
        ecode = add_free_record(tdb, off,
                                sizeof(struct tdb_used_record)
                                + rec_key_length(&rec)
                                + rec_data_length(&rec)
-                               + rec_extra_padding(&rec));
+                               + rec_extra_padding(&rec),
+                               TDB_LOCK_WAIT, true);
+
+       if (tdb->flags & TDB_SEQNUM)
+               tdb_inc_seqnum(tdb);
 
 unlock:
        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_WRLCK);
-       return ecode;
+       return tdb->last_error = ecode;
 }
 
 unsigned int tdb_get_flags(struct tdb_context *tdb)
@@ -298,11 +349,33 @@ unsigned int tdb_get_flags(struct tdb_context *tdb)
        return tdb->flags;
 }
 
+static bool inside_transaction(const struct tdb_context *tdb)
+{
+       if (tdb->flags & TDB_VERSION1)
+               return tdb->tdb1.transaction != NULL;
+       else
+               return tdb->tdb2.transaction != NULL;
+}
+
+static bool readonly_changable(struct tdb_context *tdb, const char *caller)
+{
+       if (inside_transaction(tdb)) {
+               tdb->last_error = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                            TDB_LOG_USE_ERROR,
+                                            "%s: can't change"
+                                            " TDB_RDONLY inside transaction",
+                                            caller);
+               return false;
+       }
+       return true;
+}
+
 void tdb_add_flag(struct tdb_context *tdb, unsigned flag)
 {
        if (tdb->flags & TDB_INTERNAL) {
-               tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
-                          "tdb_add_flag: internal db");
+               tdb->last_error = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                            TDB_LOG_USE_ERROR,
+                                            "tdb_add_flag: internal db");
                return;
        }
        switch (flag) {
@@ -316,17 +389,30 @@ void tdb_add_flag(struct tdb_context *tdb, unsigned flag)
        case TDB_NOSYNC:
                tdb->flags |= TDB_NOSYNC;
                break;
+       case TDB_SEQNUM:
+               tdb->flags |= TDB_SEQNUM;
+               break;
+       case TDB_ALLOW_NESTING:
+               tdb->flags |= TDB_ALLOW_NESTING;
+               break;
+       case TDB_RDONLY:
+               if (readonly_changable(tdb, "tdb_add_flag"))
+                       tdb->flags |= TDB_RDONLY;
+               break;
        default:
-               tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
-                          "tdb_add_flag: Unknown flag %u", flag);
+               tdb->last_error = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                            TDB_LOG_USE_ERROR,
+                                            "tdb_add_flag: Unknown flag %u",
+                                            flag);
        }
 }
 
 void tdb_remove_flag(struct tdb_context *tdb, unsigned flag)
 {
        if (tdb->flags & TDB_INTERNAL) {
-               tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
-                          "tdb_remove_flag: internal db");
+               tdb->last_error = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                            TDB_LOG_USE_ERROR,
+                                            "tdb_remove_flag: internal db");
                return;
        }
        switch (flag) {
@@ -340,29 +426,54 @@ void tdb_remove_flag(struct tdb_context *tdb, unsigned flag)
        case TDB_NOSYNC:
                tdb->flags &= ~TDB_NOSYNC;
                break;
+       case TDB_SEQNUM:
+               tdb->flags &= ~TDB_SEQNUM;
+               break;
+       case TDB_ALLOW_NESTING:
+               tdb->flags &= ~TDB_ALLOW_NESTING;
+               break;
+       case TDB_RDONLY:
+               if ((tdb->open_flags & O_ACCMODE) == O_RDONLY) {
+                       tdb->last_error = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                                    TDB_LOG_USE_ERROR,
+                                                    "tdb_remove_flag: can't"
+                                                    " remove TDB_RDONLY on tdb"
+                                                    " opened with O_RDONLY");
+                       break;
+               }
+               if (readonly_changable(tdb, "tdb_remove_flag"))
+                       tdb->flags &= ~TDB_RDONLY;
+               break;
        default:
-               tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
-                          "tdb_remove_flag: Unknown flag %u", flag);
+               tdb->last_error = tdb_logerr(tdb, TDB_ERR_EINVAL,
+                                            TDB_LOG_USE_ERROR,
+                                            "tdb_remove_flag: Unknown flag %u",
+                                            flag);
        }
 }
 
 const char *tdb_errorstr(enum TDB_ERROR ecode)
 {
        /* Gcc warns if you miss a case in the switch, so use that. */
-       switch (ecode) {
-       case TDB_SUCCESS: return "Success";
-       case TDB_ERR_CORRUPT: return "Corrupt database";
-       case TDB_ERR_IO: return "IO Error";
-       case TDB_ERR_LOCK: return "Locking error";
-       case TDB_ERR_OOM: return "Out of memory";
-       case TDB_ERR_EXISTS: return "Record exists";
-       case TDB_ERR_EINVAL: return "Invalid parameter";
-       case TDB_ERR_NOEXIST: return "Record does not exist";
-       case TDB_ERR_RDONLY: return "write not permitted";
+       switch (TDB_ERR_TO_OFF(ecode)) {
+       case TDB_ERR_TO_OFF(TDB_SUCCESS): return "Success";
+       case TDB_ERR_TO_OFF(TDB_ERR_CORRUPT): return "Corrupt database";
+       case TDB_ERR_TO_OFF(TDB_ERR_IO): return "IO Error";
+       case TDB_ERR_TO_OFF(TDB_ERR_LOCK): return "Locking error";
+       case TDB_ERR_TO_OFF(TDB_ERR_OOM): return "Out of memory";
+       case TDB_ERR_TO_OFF(TDB_ERR_EXISTS): return "Record exists";
+       case TDB_ERR_TO_OFF(TDB_ERR_EINVAL): return "Invalid parameter";
+       case TDB_ERR_TO_OFF(TDB_ERR_NOEXIST): return "Record does not exist";
+       case TDB_ERR_TO_OFF(TDB_ERR_RDONLY): return "write not permitted";
        }
        return "Invalid error code";
 }
 
+enum TDB_ERROR tdb_error(struct tdb_context *tdb)
+{
+       return tdb->last_error;
+}
+
 enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
                               enum TDB_ERROR ecode,
                               enum tdb_log_level level,
@@ -374,7 +485,7 @@ enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
        /* tdb_open paths care about errno, so save it. */
        int saved_errno = errno;
 
-       if (!tdb->logfn)
+       if (!tdb->log_fn)
                return ecode;
 
        va_start(ap, fmt);
@@ -382,11 +493,11 @@ enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
        va_end(ap);
 
        if (len < 0) {
-               tdb->logfn(tdb, TDB_LOG_ERROR, tdb->log_private,
-                          "out of memory formatting message:");
-               tdb->logfn(tdb, level, tdb->log_private, fmt);
+               tdb->log_fn(tdb, TDB_LOG_ERROR, TDB_ERR_OOM,
+                           "out of memory formatting message:", tdb->log_data);
+               tdb->log_fn(tdb, level, ecode, fmt, tdb->log_data);
        } else {
-               tdb->logfn(tdb, level, tdb->log_private, message);
+               tdb->log_fn(tdb, level, ecode, message, tdb->log_data);
                free(message);
        }
        errno = saved_errno;
@@ -395,39 +506,137 @@ enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
 
 enum TDB_ERROR tdb_parse_record_(struct tdb_context *tdb,
                                 TDB_DATA key,
-                                enum TDB_ERROR (*parse)(TDB_DATA key,
-                                                        TDB_DATA data,
-                                                        void *p),
-                                void *p)
+                                enum TDB_ERROR (*parse)(TDB_DATA k,
+                                                        TDB_DATA d,
+                                                        void *data),
+                                void *data)
 {
        tdb_off_t off;
        struct tdb_used_record rec;
        struct hash_info h;
-       TDB_DATA data;
        enum TDB_ERROR ecode;
 
+       if (tdb->flags & TDB_VERSION1) {
+               return tdb->last_error = tdb1_parse_record(tdb, key, parse,
+                                                          data);
+       }
+
        off = find_and_lock(tdb, key, F_RDLCK, &h, &rec, NULL);
        if (TDB_OFF_IS_ERR(off)) {
-               return off;
+               return tdb->last_error = TDB_OFF_TO_ERR(off);
        }
 
        if (!off) {
                ecode = TDB_ERR_NOEXIST;
        } else {
-               data.dsize = rec_data_length(&rec);
-               data.dptr = (void *)tdb_access_read(tdb,
-                                                   off + sizeof(rec)
-                                                   + key.dsize,
-                                                   data.dsize, false);
-               if (TDB_PTR_IS_ERR(data.dptr)) {
-                       ecode = TDB_PTR_ERR(data.dptr);
+               const void *dptr;
+               dptr = tdb_access_read(tdb, off + sizeof(rec) + key.dsize,
+                                      rec_data_length(&rec), false);
+               if (TDB_PTR_IS_ERR(dptr)) {
+                       ecode = TDB_PTR_ERR(dptr);
                } else {
-                       ecode = parse(key, data, p);
-                       tdb_access_release(tdb, data.dptr);
+                       TDB_DATA d = tdb_mkdata(dptr, rec_data_length(&rec));
+
+                       ecode = parse(key, d, data);
+                       tdb_access_release(tdb, dptr);
                }
        }
 
        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_RDLCK);
-       return ecode;
+       return tdb->last_error = ecode;
+}
+
+const char *tdb_name(const struct tdb_context *tdb)
+{
+       return tdb->name;
+}
+
+int64_t tdb_get_seqnum(struct tdb_context *tdb)
+{
+       tdb_off_t off;
+
+       if (tdb->flags & TDB_VERSION1) {
+               tdb1_off_t val;
+               tdb->last_error = TDB_SUCCESS;
+               val = tdb1_get_seqnum(tdb);
+
+               if (tdb->last_error != TDB_SUCCESS)
+                       return TDB_ERR_TO_OFF(tdb->last_error);
+               else
+                       return val;
+       }
+
+       off = tdb_read_off(tdb, offsetof(struct tdb_header, seqnum));
+       if (TDB_OFF_IS_ERR(off))
+               tdb->last_error = TDB_OFF_TO_ERR(off);
+       else
+               tdb->last_error = TDB_SUCCESS;
+       return off;
+}
+       
+
+int tdb_fd(const struct tdb_context *tdb)
+{
+       return tdb->file->fd;
+}
+
+struct traverse_state {
+       enum TDB_ERROR error;
+       struct tdb_context *dest_db;
+};
+
+/*
+  traverse function for repacking
+ */
+static int repack_traverse(struct tdb_context *tdb, TDB_DATA key, TDB_DATA data,
+                          struct traverse_state *state)
+{
+       state->error = tdb_store(state->dest_db, key, data, TDB_INSERT);
+       if (state->error != TDB_SUCCESS) {
+               return -1;
+       }
+       return 0;
 }
 
+enum TDB_ERROR tdb_repack(struct tdb_context *tdb)
+{
+       struct tdb_context *tmp_db;
+       struct traverse_state state;
+
+       state.error = tdb_transaction_start(tdb);
+       if (state.error != TDB_SUCCESS) {
+               return state.error;
+       }
+
+       tmp_db = tdb_open("tmpdb", TDB_INTERNAL, O_RDWR|O_CREAT, 0, NULL);
+       if (tmp_db == NULL) {
+               state.error = tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
+                                        __location__
+                                        " Failed to create tmp_db");
+               tdb_transaction_cancel(tdb);
+               return tdb->last_error = state.error;
+       }
+
+       state.dest_db = tmp_db;
+       if (tdb_traverse(tdb, repack_traverse, &state) < 0) {
+               goto fail;
+       }
+
+       state.error = tdb_wipe_all(tdb);
+       if (state.error != TDB_SUCCESS) {
+               goto fail;
+       }
+
+       state.dest_db = tdb;
+       if (tdb_traverse(tmp_db, repack_traverse, &state) < 0) {
+               goto fail;
+       }
+
+       tdb_close(tmp_db);
+       return tdb_transaction_commit(tdb);
+
+fail:
+       tdb_transaction_cancel(tdb);
+       tdb_close(tmp_db);
+       return state.error;
+}