]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/tdb.c
tdb2: rework some io.c functions to encode errors in their pointer returns.
[ccan] / ccan / tdb2 / tdb.c
index e3b579d0f259ad94498fe740f84bef7dc52d9d2b..130bb6b594f687ea81cd3ed59b223dcaf861b8bc 100644 (file)
@@ -49,8 +49,6 @@ static uint64_t random_number(struct tdb_context *tdb)
        fd = open("/dev/urandom", O_RDONLY);
        if (fd >= 0) {
                if (read_all(fd, &ret, sizeof(ret))) {
-                       tdb_logerr(tdb, TDB_SUCCESS, TDB_DEBUG_TRACE,
-                                "tdb_open: random from /dev/urandom");
                        close(fd);
                        return ret;
                }
@@ -65,9 +63,6 @@ static uint64_t random_number(struct tdb_context *tdb)
                        char reply[1 + sizeof(uint64_t)];
                        int r = read(fd, reply, sizeof(reply));
                        if (r > 1) {
-                               tdb_logerr(tdb, TDB_SUCCESS, TDB_DEBUG_TRACE,
-                                          "tdb_open: %u random bytes from"
-                                          " /dev/egd-pool", r-1);
                                /* Copy at least some bytes. */
                                memcpy(&ret, reply+1, r - 1);
                                if (reply[0] == sizeof(uint64_t)
@@ -83,7 +78,7 @@ static uint64_t random_number(struct tdb_context *tdb)
        /* Fallback: pid and time. */
        gettimeofday(&now, NULL);
        ret = getpid() * 100132289ULL + now.tv_sec * 1000000ULL + now.tv_usec;
-       tdb_logerr(tdb, TDB_SUCCESS, TDB_DEBUG_TRACE,
+       tdb_logerr(tdb, TDB_SUCCESS, TDB_LOG_WARNING,
                   "tdb_open: random from getpid and time");
        return ret;
 }
@@ -101,6 +96,7 @@ static int tdb_new_database(struct tdb_context *tdb,
        /* We make it up in memory, then write it out if not internal */
        struct new_database newdb;
        unsigned int magic_len;
+       ssize_t rlen;
 
        /* Fill in the header */
        newdb.hdr.version = TDB_VERSION;
@@ -140,7 +136,7 @@ static int tdb_new_database(struct tdb_context *tdb,
                tdb->map_size = sizeof(newdb);
                tdb->map_ptr = malloc(tdb->map_size);
                if (!tdb->map_ptr) {
-                       tdb_logerr(tdb, TDB_ERR_OOM, TDB_DEBUG_FATAL,
+                       tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
                                   "tdb_new_database: failed to allocate");
                        return -1;
                }
@@ -153,10 +149,13 @@ static int tdb_new_database(struct tdb_context *tdb,
        if (ftruncate(tdb->fd, 0) == -1)
                return -1;
 
-       if (!tdb_pwrite_all(tdb->fd, &newdb, sizeof(newdb), 0)) {
-               tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_FATAL,
-                          "tdb_new_database: failed to write: %s",
-                          strerror(errno));
+       rlen = write(tdb->fd, &newdb, sizeof(newdb));
+       if (rlen != sizeof(newdb)) {
+               if (rlen >= 0)
+                       errno = ENOSPC;
+               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
+                          "tdb_new_database: %zi writing header: %s",
+                          rlen, strerror(errno));
                return -1;
        }
        return 0;
@@ -174,6 +173,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;
+       enum TDB_ERROR ecode;
 
        tdb = malloc(sizeof(*tdb));
        if (!tdb) {
@@ -216,7 +216,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                                tdb->stats->size = sizeof(attr->stats);
                        break;
                default:
-                       tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_DEBUG_ERROR,
+                       tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
                                   "tdb_open: unknown attribute type %u",
                                   attr->base.attr);
                        goto fail;
@@ -225,7 +225,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
        }
 
        if ((open_flags & O_ACCMODE) == O_WRONLY) {
-               tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
                           "tdb_open: can't open tdb %s write-only", name);
                goto fail;
        }
@@ -255,7 +255,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
        if ((tdb->fd = open(name, open_flags, mode)) == -1) {
                /* errno set by open(2) */
                saved_errno = errno;
-               tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                           "tdb_open: could not open file %s: %s",
                           name, strerror(errno));
                goto fail;
@@ -266,9 +266,8 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
 
        /* ensure there is only one process initialising at once */
-       if (tdb_lock_open(tdb, TDB_LOCK_WAIT|TDB_LOCK_NOCHECK) == -1) {
-               /* errno set by tdb_brlock */
-               saved_errno = errno;
+       tdb->ecode = tdb_lock_open(tdb, TDB_LOCK_WAIT|TDB_LOCK_NOCHECK);
+       if (tdb->ecode != TDB_SUCCESS) {
                goto fail;
        }
 
@@ -279,13 +278,13 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                        goto fail;
                }
        } else if (rlen < 0) {
-               tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                           "tdb_open: error %s reading %s",
                           strerror(errno), name);
                goto fail;
        } else if (rlen < sizeof(hdr)
                   || strcmp(hdr.magic_food, TDB_MAGIC_FOOD) != 0) {
-               tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                           "tdb_open: %s is not a tdb file", name);
                goto fail;
        }
@@ -295,7 +294,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                        tdb->flags |= TDB_CONVERT;
                else {
                        /* wrong version */
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_ERROR,
+                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                                   "tdb_open: %s is unknown version 0x%llx",
                                   name, (long long)hdr.version);
                        goto fail;
@@ -308,7 +307,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
        hash_test = tdb_hash(tdb, &hash_test, sizeof(hash_test));
        if (hdr.hash_test != hash_test) {
                /* wrong hash variant */
-               tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                           "tdb_open: %s uses a different hash function",
                           name);
                goto fail;
@@ -316,7 +315,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
 
        if (fstat(tdb->fd, &st) == -1) {
                saved_errno = errno;
-               tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                           "tdb_open: could not stat open %s: %s",
                           name, strerror(errno));
                goto fail;
@@ -325,7 +324,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
        /* Is it already in the open list?  If so, fail. */
        if (tdb_already_open(st.st_dev, st.st_ino)) {
                /* FIXME */
-               tdb_logerr(tdb, TDB_ERR_NESTING, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_USE_ERROR,
                           "tdb_open: %s (%d,%d) is already open in this"
                           " process",
                           name, (int)st.st_dev, (int)st.st_ino);
@@ -334,7 +333,7 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
 
        tdb->name = strdup(name);
        if (!tdb->name) {
-               tdb_logerr(tdb, TDB_ERR_OOM, TDB_DEBUG_ERROR,
+               tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
                           "tdb_open: failed to allocate name");
                goto fail;
        }
@@ -347,8 +346,12 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
        tdb->methods->oob(tdb, tdb->map_size + 1, true);
 
        /* Now it's fully formed, recover if necessary. */
-       if (tdb_needs_recovery(tdb) && tdb_lock_and_recover(tdb) == -1) {
-               goto fail;
+       if (tdb_needs_recovery(tdb)) {
+               ecode = tdb_lock_and_recover(tdb);
+               if (ecode != TDB_SUCCESS) {
+                       tdb->ecode = ecode;
+                       goto fail;
+               }
        }
 
        if (tdb_ftable_init(tdb) == -1)
@@ -375,9 +378,6 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                case TDB_ERR_EINVAL:
                        saved_errno = EINVAL;
                        break;
-               case TDB_ERR_NESTING:
-                       saved_errno = EBUSY;
-                       break;
                default:
                        saved_errno = EINVAL;
                        break;
@@ -393,12 +393,13 @@ struct tdb_context *tdb_open(const char *name, int tdb_flags,
                } else
                        tdb_munmap(tdb);
        }
+       free(tdb->lockrecs);
        free((char *)tdb->name);
        if (tdb->fd != -1)
                if (close(tdb->fd) != 0)
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_ERROR,
+                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                                   "tdb_open: failed to close tdb->fd"
-                                  " on error!");
+                                  " on error: %s", strerror(errno));
        free(tdb);
        errno = saved_errno;
        return NULL;
@@ -412,12 +413,18 @@ static int update_rec_hdr(struct tdb_context *tdb,
                          uint64_t h)
 {
        uint64_t dataroom = rec_data_length(rec) + rec_extra_padding(rec);
+       enum TDB_ERROR ecode;
 
        if (set_header(tdb, rec, TDB_USED_MAGIC, keylen, datalen,
                       keylen + dataroom, h))
                return -1;
 
-       return tdb_write_convert(tdb, off, rec, sizeof(*rec));
+       ecode = tdb_write_convert(tdb, off, rec, sizeof(*rec));
+       if (ecode != TDB_SUCCESS) {
+               tdb->ecode = ecode;
+               return -1;
+       }
+       return 0;
 }
 
 /* Returns -1 on error, 0 on OK */
@@ -428,6 +435,7 @@ static int replace_data(struct tdb_context *tdb,
                        bool growing)
 {
        tdb_off_t new_off;
+       enum TDB_ERROR ecode;
 
        /* Allocate a new record. */
        new_off = alloc(tdb, key.dsize, dbuf.dsize, h->h, TDB_USED_MAGIC,
@@ -449,12 +457,18 @@ static int replace_data(struct tdb_context *tdb,
        }
 
        new_off += sizeof(struct tdb_used_record);
-       if (tdb->methods->write(tdb, new_off, key.dptr, key.dsize) == -1)
+       ecode = tdb->methods->twrite(tdb, new_off, key.dptr, key.dsize);
+       if (ecode != TDB_SUCCESS) {
+               tdb->ecode = ecode;
                return -1;
+       }
 
        new_off += key.dsize;
-       if (tdb->methods->write(tdb, new_off, dbuf.dptr, dbuf.dsize) == -1)
+       ecode = tdb->methods->twrite(tdb, new_off, dbuf.dptr, dbuf.dsize);
+       if (ecode != TDB_SUCCESS) {
+               tdb->ecode = ecode;
                return -1;
+       }
 
        /* FIXME: tdb_increment_seqnum(tdb); */
        return 0;
@@ -468,6 +482,7 @@ int tdb_store(struct tdb_context *tdb,
        tdb_len_t old_room = 0;
        struct tdb_used_record rec;
        int ret;
+       enum TDB_ERROR ecode;
 
        off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
        if (unlikely(off == TDB_OFF_ERR))
@@ -489,10 +504,15 @@ int tdb_store(struct tdb_context *tdb,
                                                   key.dsize, dbuf.dsize,
                                                   &rec, h.h))
                                        goto fail;
-                               if (tdb->methods->write(tdb, off + sizeof(rec)
-                                                       + key.dsize,
-                                                       dbuf.dptr, dbuf.dsize))
+                               ecode = tdb->methods->twrite(tdb,
+                                                            off + sizeof(rec)
+                                                            + key.dsize,
+                                                            dbuf.dptr,
+                                                            dbuf.dsize);
+                               if (ecode != TDB_SUCCESS) {
+                                       tdb->ecode = ecode;
                                        goto fail;
+                               }
                                tdb_unlock_hashes(tdb, h.hlock_start,
                                                  h.hlock_range, F_WRLCK);
                                return 0;
@@ -527,6 +547,7 @@ int tdb_append(struct tdb_context *tdb,
        tdb_len_t old_room = 0, old_dlen;
        unsigned char *newdata;
        struct tdb_data new_dbuf;
+       enum TDB_ERROR ecode;
        int ret;
 
        off = find_and_lock(tdb, key, F_WRLCK, &h, &rec, NULL);
@@ -544,9 +565,12 @@ int tdb_append(struct tdb_context *tdb,
                                goto fail;
 
                        off += sizeof(rec) + key.dsize + old_dlen;
-                       if (tdb->methods->write(tdb, off, dbuf.dptr,
-                                               dbuf.dsize) == -1)
+                       ecode = tdb->methods->twrite(tdb, off, dbuf.dptr,
+                                                    dbuf.dsize);
+                       if (ecode != TDB_SUCCESS) {
+                               tdb->ecode = ecode;
                                goto fail;
+                       }
 
                        /* FIXME: tdb_increment_seqnum(tdb); */
                        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range,
@@ -557,13 +581,15 @@ int tdb_append(struct tdb_context *tdb,
                /* Slow path. */
                newdata = malloc(key.dsize + old_dlen + dbuf.dsize);
                if (!newdata) {
-                       tdb_logerr(tdb, TDB_ERR_OOM, TDB_DEBUG_FATAL,
+                       tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
                                   "tdb_append: failed to allocate %zu bytes",
                                   (size_t)(key.dsize+old_dlen+dbuf.dsize));
                        goto fail;
                }
-               if (tdb->methods->read(tdb, off + sizeof(rec) + key.dsize,
-                                      newdata, old_dlen) != 0) {
+               ecode = tdb->methods->tread(tdb, off + sizeof(rec) + key.dsize,
+                                           newdata, old_dlen);
+               if (ecode != TDB_SUCCESS) {
+                       tdb->ecode = ecode;
                        free(newdata);
                        goto fail;
                }
@@ -605,6 +631,10 @@ struct tdb_data tdb_fetch(struct tdb_context *tdb, struct tdb_data key)
                ret.dsize = rec_data_length(&rec);
                ret.dptr = tdb_alloc_read(tdb, off + sizeof(rec) + key.dsize,
                                          ret.dsize);
+               if (TDB_PTR_IS_ERR(ret.dptr)) {
+                       tdb->ecode = TDB_PTR_ERR(ret.dptr);
+                       ret = tdb_null;
+               }
        }
 
        tdb_unlock_hashes(tdb, h.hlock_start, h.hlock_range, F_RDLCK);
@@ -702,7 +732,6 @@ const char *tdb_errorstr(const struct tdb_context *tdb)
        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_NESTING: return "Transaction already started";
        case TDB_ERR_EINVAL: return "Invalid parameter";
        case TDB_ERR_NOEXIST: return "Record does not exist";
        case TDB_ERR_RDONLY: return "write not permitted";
@@ -710,10 +739,10 @@ const char *tdb_errorstr(const struct tdb_context *tdb)
        return "Invalid error code";
 }
 
-void COLD tdb_logerr(struct tdb_context *tdb,
-                    enum TDB_ERROR ecode,
-                    enum tdb_debug_level level,
-                    const char *fmt, ...)
+enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
+                              enum TDB_ERROR ecode,
+                              enum tdb_log_level level,
+                              const char *fmt, ...)
 {
        char *message;
        va_list ap;
@@ -724,7 +753,7 @@ void COLD tdb_logerr(struct tdb_context *tdb,
        tdb->ecode = ecode;
 
        if (!tdb->logfn)
-               return;
+               return ecode;
 
        /* FIXME: Doesn't assume asprintf. */
        va_start(ap, fmt);
@@ -733,9 +762,10 @@ void COLD tdb_logerr(struct tdb_context *tdb,
 
        message = malloc(len + 1);
        if (!message) {
-               tdb->logfn(tdb, level, tdb->log_private,
-                          "out of memory formatting message");
-               return;
+               tdb->logfn(tdb, TDB_LOG_ERROR, tdb->log_private,
+                          "out of memory formatting message:");
+               tdb->logfn(tdb, level, tdb->log_private, fmt);
+               return ecode;
        }
        va_start(ap, fmt);
        len = vsprintf(message, fmt, ap);
@@ -743,4 +773,5 @@ void COLD tdb_logerr(struct tdb_context *tdb,
        tdb->logfn(tdb, level, tdb->log_private, message);
        free(message);
        errno = saved_errno;
+       return ecode;
 }