]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/io.c
tdb2: fix pread/pwrite error handling in fill and tdb_write.
[ccan] / ccan / tdb2 / io.c
index 3c24be6774a3f0a4b841809e5a20a9cfe7f417da..11914b3c76b639f63e89442758e259b21aeeb5fe 100644 (file)
@@ -67,9 +67,11 @@ void tdb_mmap(struct tdb_context *tdb)
    if necessary
    note that "len" is the minimum length needed for the db
 */
-static int tdb_oob(struct tdb_context *tdb, tdb_off_t len, bool probe)
+static enum TDB_ERROR tdb_oob(struct tdb_context *tdb, tdb_off_t len,
+                             bool probe)
 {
        struct stat st;
+       enum TDB_ERROR ecode;
 
        /* We can't hold pointers during this: we could unmap! */
        assert(!tdb->direct_access
@@ -86,17 +88,19 @@ static int tdb_oob(struct tdb_context *tdb, tdb_off_t len, bool probe)
                                 (long long)len,
                                 (long long)tdb->map_size);
                }
-               return -1;
+               return TDB_ERR_IO;
        }
 
-       if (tdb_lock_expand(tdb, F_RDLCK) != 0)
-               return -1;
+       ecode = tdb_lock_expand(tdb, F_RDLCK);
+       if (ecode != TDB_SUCCESS) {
+               return ecode;
+       }
 
        if (fstat(tdb->fd, &st) != 0) {
                tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                           "Failed to fstat file: %s", strerror(errno));
                tdb_unlock_expand(tdb, F_RDLCK);
-               return -1;
+               return TDB_ERR_IO;
        }
 
        tdb_unlock_expand(tdb, F_RDLCK);
@@ -107,7 +111,7 @@ static int tdb_oob(struct tdb_context *tdb, tdb_off_t len, bool probe)
                                   "tdb_oob len %zu beyond eof at %zu",
                                   (size_t)len, st.st_size);
                }
-               return -1;
+               return TDB_ERR_IO;
        }
 
        /* Unmap, update size, remap */
@@ -115,7 +119,7 @@ static int tdb_oob(struct tdb_context *tdb, tdb_off_t len, bool probe)
 
        tdb->map_size = st.st_size;
        tdb_mmap(tdb);
-       return 0;
+       return TDB_SUCCESS;
 }
 
 /* Endian conversion: we only ever deal with 8 byte quantities */
@@ -129,6 +133,7 @@ void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size)
        return buf;
 }
 
+/* Return first non-zero offset in offset array, or end, or -ve error. */
 /* FIXME: Return the off? */
 uint64_t tdb_find_nonzero_off(struct tdb_context *tdb,
                              tdb_off_t base, uint64_t start, uint64_t end)
@@ -139,8 +144,9 @@ uint64_t tdb_find_nonzero_off(struct tdb_context *tdb,
        /* Zero vs non-zero is the same unconverted: minor optimization. */
        val = tdb_access_read(tdb, base + start * sizeof(tdb_off_t),
                              (end - start) * sizeof(tdb_off_t), false);
-       if (!val)
-               return end;
+       if (TDB_PTR_IS_ERR(val)) {
+               return TDB_PTR_ERR(val);
+       }
 
        for (i = 0; i < (end - start); i++) {
                if (val[i])
@@ -150,7 +156,7 @@ uint64_t tdb_find_nonzero_off(struct tdb_context *tdb,
        return start + i;
 }
 
-/* Return first zero offset in num offset array, or num. */
+/* Return first zero offset in num offset array, or num, or -ve error. */
 uint64_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
                           uint64_t num)
 {
@@ -159,8 +165,9 @@ uint64_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
 
        /* Zero vs non-zero is the same unconverted: minor optimization. */
        val = tdb_access_read(tdb, off, num * sizeof(tdb_off_t), false);
-       if (!val)
-               return num;
+       if (TDB_PTR_IS_ERR(val)) {
+               return TDB_PTR_ERR(val);
+       }
 
        for (i = 0; i < num; i++) {
                if (!val[i])
@@ -170,86 +177,98 @@ uint64_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
        return i;
 }
 
-int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len)
+enum TDB_ERROR zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len)
 {
        char buf[8192] = { 0 };
        void *p = tdb->methods->direct(tdb, off, len, true);
+       enum TDB_ERROR ecode = TDB_SUCCESS;
 
        assert(!tdb->read_only);
+       if (TDB_PTR_IS_ERR(p)) {
+               return TDB_PTR_ERR(p);
+       }
        if (p) {
                memset(p, 0, len);
-               return 0;
+               return ecode;
        }
        while (len) {
                unsigned todo = len < sizeof(buf) ? len : sizeof(buf);
-               if (tdb->methods->twrite(tdb, off, buf, todo) == -1)
-                       return -1;
+               ecode = tdb->methods->twrite(tdb, off, buf, todo);
+               if (ecode != TDB_SUCCESS) {
+                       break;
+               }
                len -= todo;
                off += todo;
        }
-       return 0;
+       return ecode;
 }
 
 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off)
 {
        tdb_off_t ret;
+       enum TDB_ERROR ecode;
 
        if (likely(!(tdb->flags & TDB_CONVERT))) {
                tdb_off_t *p = tdb->methods->direct(tdb, off, sizeof(*p),
                                                    false);
+               if (TDB_PTR_IS_ERR(p)) {
+                       return TDB_PTR_ERR(p);
+               }
                if (p)
                        return *p;
        }
 
-       if (tdb_read_convert(tdb, off, &ret, sizeof(ret)) == -1)
-               return TDB_OFF_ERR;
+       ecode = tdb_read_convert(tdb, off, &ret, sizeof(ret));
+       if (ecode != TDB_SUCCESS) {
+               return ecode;
+       }
        return ret;
 }
 
 /* write a lump of data at a specified offset */
-static int tdb_write(struct tdb_context *tdb, tdb_off_t off,
-                    const void *buf, tdb_len_t len)
+static enum TDB_ERROR tdb_write(struct tdb_context *tdb, tdb_off_t off,
+                               const void *buf, tdb_len_t len)
 {
+       enum TDB_ERROR ecode;
+
        if (tdb->read_only) {
-               tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
-                          "Write to read-only database");
-               return -1;
+               return tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
+                                 "Write to read-only database");
        }
 
-       /* FIXME: Bogus optimization? */
-       if (len == 0) {
-               return 0;
+       ecode = tdb->methods->oob(tdb, off + len, 0);
+       if (ecode != TDB_SUCCESS) {
+               return ecode;
        }
 
-       if (tdb->methods->oob(tdb, off + len, 0) != 0)
-               return -1;
-
        if (tdb->map_ptr) {
                memcpy(off + (char *)tdb->map_ptr, buf, len);
        } else {
                ssize_t ret;
                ret = pwrite(tdb->fd, buf, len, off);
-               if (ret < len) {
+               if (ret != len) {
                        /* This shouldn't happen: we avoid sparse files. */
                        if (ret >= 0)
                                errno = ENOSPC;
 
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
-                                  "tdb_write: %zi at %zu len=%zu (%s)",
-                                  ret, (size_t)off, (size_t)len,
-                                  strerror(errno));
-                       return -1;
+                       return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
+                                         "tdb_write: %zi at %zu len=%zu (%s)",
+                                         ret, (size_t)off, (size_t)len,
+                                         strerror(errno));
                }
        }
-       return 0;
+       return TDB_SUCCESS;
 }
 
 /* read a lump of data at a specified offset */
-static int tdb_read(struct tdb_context *tdb, tdb_off_t off, void *buf,
-                   tdb_len_t len)
+static enum TDB_ERROR tdb_read(struct tdb_context *tdb, tdb_off_t off,
+                              void *buf, tdb_len_t len)
 {
-       if (tdb->methods->oob(tdb, off + len, 0) != 0) {
-               return -1;
+       enum TDB_ERROR ecode;
+
+       ecode = tdb->methods->oob(tdb, off + len, 0);
+       if (ecode != TDB_SUCCESS) {
+               return ecode;
        }
 
        if (tdb->map_ptr) {
@@ -257,62 +276,64 @@ static int tdb_read(struct tdb_context *tdb, tdb_off_t off, void *buf,
        } else {
                ssize_t r = pread(tdb->fd, buf, len, off);
                if (r != len) {
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
-                                  "tdb_read failed with %zi at %zu "
-                                  "len=%zu (%s) map_size=%zu",
-                                  r, (size_t)off, (size_t)len,
-                                  strerror(errno),
-                                  (size_t)tdb->map_size);
-                       return -1;
+                       return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
+                                         "tdb_read failed with %zi at %zu "
+                                         "len=%zu (%s) map_size=%zu",
+                                         r, (size_t)off, (size_t)len,
+                                         strerror(errno),
+                                         (size_t)tdb->map_size);
                }
        }
-       return 0;
+       return TDB_SUCCESS;
 }
 
-int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
-                     const void *rec, size_t len)
+enum TDB_ERROR tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
+                                const void *rec, size_t len)
 {
-       int ret;
+       enum TDB_ERROR ecode;
+
        if (unlikely((tdb->flags & TDB_CONVERT))) {
                void *conv = malloc(len);
                if (!conv) {
-                       tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
-                                  "tdb_write: no memory converting"
-                                  " %zu bytes", len);
-                       return -1;
+                       return tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
+                                         "tdb_write: no memory converting"
+                                         " %zu bytes", len);
                }
                memcpy(conv, rec, len);
-               ret = tdb->methods->twrite(tdb, off,
+               ecode = tdb->methods->twrite(tdb, off,
                                           tdb_convert(tdb, conv, len), len);
                free(conv);
-       } else
-               ret = tdb->methods->twrite(tdb, off, rec, len);
-
-       return ret;
+       } else {
+               ecode = tdb->methods->twrite(tdb, off, rec, len);
+       }
+       return ecode;
 }
 
-int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
-                     void *rec, size_t len)
+enum TDB_ERROR tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
+                               void *rec, size_t len)
 {
-       int ret = tdb->methods->tread(tdb, off, rec, len);
+       enum TDB_ERROR ecode = tdb->methods->tread(tdb, off, rec, len);
        tdb_convert(tdb, rec, len);
-       return ret;
+       return ecode;
 }
 
-int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val)
+enum TDB_ERROR tdb_write_off(struct tdb_context *tdb,
+                            tdb_off_t off, tdb_off_t val)
 {
        if (tdb->read_only) {
-               tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
-                          "Write to read-only database");
-               return -1;
+               return tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
+                                 "Write to read-only database");
        }
 
        if (likely(!(tdb->flags & TDB_CONVERT))) {
                tdb_off_t *p = tdb->methods->direct(tdb, off, sizeof(*p),
                                                    true);
+               if (TDB_PTR_IS_ERR(p)) {
+                       return TDB_PTR_ERR(p);
+               }
                if (p) {
                        *p = val;
-                       return 0;
+                       return TDB_SUCCESS;
                }
        }
        return tdb_write_convert(tdb, off, &val, sizeof(val));
@@ -322,6 +343,7 @@ static void *_tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset,
                             tdb_len_t len, unsigned int prefix)
 {
        void *buf;
+       enum TDB_ERROR ecode;
 
        /* some systems don't like zero length malloc */
        buf = malloc(prefix + len ? prefix + len : 1);
@@ -329,10 +351,13 @@ static void *_tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset,
                tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_USE_ERROR,
                           "tdb_alloc_read malloc failed len=%zu",
                           (size_t)(prefix + len));
-       } else if (unlikely(tdb->methods->tread(tdb, offset, buf+prefix, len)
-                           == -1)) {
-               free(buf);
-               buf = NULL;
+               return TDB_ERR_PTR(TDB_ERR_OOM);
+       } else {
+               ecode = tdb->methods->tread(tdb, offset, buf+prefix, len);
+               if (unlikely(ecode != TDB_SUCCESS)) {
+                       free(buf);
+                       return TDB_ERR_PTR(ecode);
+               }
        }
        return buf;
 }
@@ -343,47 +368,47 @@ void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len)
        return _tdb_alloc_read(tdb, offset, len, 0);
 }
 
-static int fill(struct tdb_context *tdb,
-               const void *buf, size_t size,
-               tdb_off_t off, tdb_len_t len)
+static enum TDB_ERROR fill(struct tdb_context *tdb,
+                          const void *buf, size_t size,
+                          tdb_off_t off, tdb_len_t len)
 {
        while (len) {
                size_t n = len > size ? size : len;
                ssize_t ret = pwrite(tdb->fd, buf, n, off);
-               if (ret < n) {
+               if (ret != n) {
                        if (ret >= 0)
                                errno = ENOSPC;
 
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
-                                  "fill failed: %zi at %zu len=%zu (%s)",
-                                  ret, (size_t)off, (size_t)len,
-                                  strerror(errno));
-                       return -1;
+                       return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
+                                         "fill failed:"
+                                         " %zi at %zu len=%zu (%s)",
+                                         ret, (size_t)off, (size_t)len,
+                                         strerror(errno));
                }
                len -= n;
                off += n;
        }
-       return 0;
+       return TDB_SUCCESS;
 }
 
 /* expand a file.  we prefer to use ftruncate, as that is what posix
   says to use for mmap expansion */
-static int tdb_expand_file(struct tdb_context *tdb, tdb_len_t addition)
+static enum TDB_ERROR tdb_expand_file(struct tdb_context *tdb,
+                                     tdb_len_t addition)
 {
        char buf[8192];
+       enum TDB_ERROR ecode;
 
        if (tdb->read_only) {
-               tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
-                          "Expand on read-only database");
-               return -1;
+               return tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
+                                 "Expand on read-only database");
        }
 
        if (tdb->flags & TDB_INTERNAL) {
                char *new = realloc(tdb->map_ptr, tdb->map_size + addition);
                if (!new) {
-                       tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
-                                  "No memory to expand database");
-                       return -1;
+                       return tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
+                                         "No memory to expand database");
                }
                tdb->map_ptr = new;
                tdb->map_size += addition;
@@ -400,12 +425,13 @@ static int tdb_expand_file(struct tdb_context *tdb, tdb_len_t addition)
                   file isn't sparse, which would be very bad if we ran out of
                   disk. This must be done with write, not via mmap */
                memset(buf, 0x43, sizeof(buf));
-               if (0 || fill(tdb, buf, sizeof(buf), tdb->map_size, addition) == -1)
-                       return -1;
+               ecode = fill(tdb, buf, sizeof(buf), tdb->map_size, addition);
+               if (ecode != TDB_SUCCESS)
+                       return ecode;
                tdb->map_size += addition;
                tdb_mmap(tdb);
        }
-       return 0;
+       return TDB_SUCCESS;
 }
 
 const void *tdb_access_read(struct tdb_context *tdb,
@@ -413,18 +439,24 @@ const void *tdb_access_read(struct tdb_context *tdb,
 {
        const void *ret = NULL;
 
-       if (likely(!(tdb->flags & TDB_CONVERT)))
+       if (likely(!(tdb->flags & TDB_CONVERT))) {
                ret = tdb->methods->direct(tdb, off, len, false);
 
+               if (TDB_PTR_IS_ERR(ret)) {
+                       return ret;
+               }
+       }
        if (!ret) {
                struct tdb_access_hdr *hdr;
                hdr = _tdb_alloc_read(tdb, off, len, sizeof(*hdr));
-               if (hdr) {
-                       hdr->next = tdb->access;
-                       tdb->access = hdr;
-                       ret = hdr + 1;
-                       if (convert)
-                               tdb_convert(tdb, (void *)ret, len);
+               if (TDB_PTR_IS_ERR(hdr)) {
+                       return hdr;
+               }
+               hdr->next = tdb->access;
+               tdb->access = hdr;
+               ret = hdr + 1;
+               if (convert) {
+                       tdb_convert(tdb, (void *)ret, len);
                }
        } else
                tdb->direct_access++;
@@ -440,25 +472,31 @@ void *tdb_access_write(struct tdb_context *tdb,
        if (tdb->read_only) {
                tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
                           "Write to read-only database");
-               return NULL;
+               return TDB_ERR_PTR(TDB_ERR_RDONLY);
        }
 
-       if (likely(!(tdb->flags & TDB_CONVERT)))
+       if (likely(!(tdb->flags & TDB_CONVERT))) {
                ret = tdb->methods->direct(tdb, off, len, true);
 
+               if (TDB_PTR_IS_ERR(ret)) {
+                       return ret;
+               }
+       }
+
        if (!ret) {
                struct tdb_access_hdr *hdr;
                hdr = _tdb_alloc_read(tdb, off, len, sizeof(*hdr));
-               if (hdr) {
-                       hdr->next = tdb->access;
-                       tdb->access = hdr;
-                       hdr->off = off;
-                       hdr->len = len;
-                       hdr->convert = convert;
-                       ret = hdr + 1;
-                       if (convert)
-                               tdb_convert(tdb, (void *)ret, len);
+               if (TDB_PTR_IS_ERR(hdr)) {
+                       return hdr;
                }
+               hdr->next = tdb->access;
+               tdb->access = hdr;
+               hdr->off = off;
+               hdr->len = len;
+               hdr->convert = convert;
+               ret = hdr + 1;
+               if (convert)
+                       tdb_convert(tdb, (void *)ret, len);
        } else
                tdb->direct_access++;
 
@@ -488,33 +526,38 @@ void tdb_access_release(struct tdb_context *tdb, const void *p)
                tdb->direct_access--;
 }
 
-int tdb_access_commit(struct tdb_context *tdb, void *p)
+enum TDB_ERROR tdb_access_commit(struct tdb_context *tdb, void *p)
 {
        struct tdb_access_hdr *hdr, **hp = find_hdr(tdb, p);
-       int ret = 0;
+       enum TDB_ERROR ecode;
 
        if (hp) {
                hdr = *hp;
                if (hdr->convert)
-                       ret = tdb_write_convert(tdb, hdr->off, p, hdr->len);
+                       ecode = tdb_write_convert(tdb, hdr->off, p, hdr->len);
                else
-                       ret = tdb_write(tdb, hdr->off, p, hdr->len);
+                       ecode = tdb_write(tdb, hdr->off, p, hdr->len);
                *hp = hdr->next;
                free(hdr);
-       } else
+       } else {
                tdb->direct_access--;
+               ecode = TDB_SUCCESS;
+       }
 
-       return ret;
+       return ecode;
 }
 
 static void *tdb_direct(struct tdb_context *tdb, tdb_off_t off, size_t len,
                        bool write_mode)
 {
+       enum TDB_ERROR ecode;
+
        if (unlikely(!tdb->map_ptr))
                return NULL;
 
-       if (unlikely(tdb_oob(tdb, off + len, true) == -1))
-               return NULL;
+       ecode = tdb_oob(tdb, off + len, true);
+       if (unlikely(ecode != TDB_SUCCESS))
+               return TDB_ERR_PTR(ecode);
        return (char *)tdb->map_ptr + off;
 }