]> git.ozlabs.org Git - ccan/blobdiff - ccan/tdb2/io.c
tdb2: rework io functions to return enum TDB_ERROR.
[ccan] / ccan / tdb2 / io.c
index ffd952d2aae3d23acab3af69b3ebc08ce9850ada..a0c5f5232554a3d37f1b36f3d1e2ff0fdda8657e 100644 (file)
@@ -1,4 +1,4 @@
- /* 
+ /*
    Unix SMB/CIFS implementation.
 
    trivial database library
@@ -56,7 +56,7 @@ void tdb_mmap(struct tdb_context *tdb)
         */
        if (tdb->map_ptr == MAP_FAILED) {
                tdb->map_ptr = NULL;
-               tdb_logerr(tdb, TDB_SUCCESS, TDB_DEBUG_WARNING,
+               tdb_logerr(tdb, TDB_SUCCESS, TDB_LOG_WARNING,
                           "tdb_mmap failed for size %lld (%s)",
                           (long long)tdb->map_size, strerror(errno));
        }
@@ -64,12 +64,14 @@ void tdb_mmap(struct tdb_context *tdb)
 
 /* check for an out of bounds access - if it is out of bounds then
    see if the database has been expanded by someone else and expand
-   if necessary 
+   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
@@ -80,34 +82,36 @@ static int tdb_oob(struct tdb_context *tdb, tdb_off_t len, bool probe)
                return 0;
        if (tdb->flags & TDB_INTERNAL) {
                if (!probe) {
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_FATAL,
+                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                                 "tdb_oob len %lld beyond internal"
                                 " malloc size %lld",
                                 (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_DEBUG_FATAL,
+               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);
 
        if (st.st_size < (size_t)len) {
                if (!probe) {
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_FATAL,
+                       tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
                                   "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 */
@@ -174,6 +178,7 @@ int 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;
 
        assert(!tdb->read_only);
        if (p) {
@@ -182,8 +187,11 @@ int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len)
        }
        while (len) {
                unsigned todo = len < sizeof(buf) ? len : sizeof(buf);
-               if (tdb->methods->write(tdb, off, buf, todo) == -1)
+               ecode = tdb->methods->twrite(tdb, off, buf, todo);
+               if (ecode != TDB_SUCCESS) {
+                       tdb->ecode = ecode;
                        return -1;
+               }
                len -= todo;
                off += todo;
        }
@@ -206,152 +214,117 @@ tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off)
        return ret;
 }
 
-/* Even on files, we can get partial writes due to signals. */
-bool tdb_pwrite_all(int fd, const void *buf, size_t len, tdb_off_t off)
-{
-       while (len) {
-               ssize_t ret;
-               ret = pwrite(fd, buf, len, off);
-               if (ret < 0)
-                       return false;
-               if (ret == 0) {
-                       errno = ENOSPC;
-                       return false;
-               }
-               buf = (char *)buf + ret;
-               off += ret;
-               len -= ret;
-       }
-       return true;
-}
-
-/* Even on files, we can get partial reads due to signals. */
-bool tdb_pread_all(int fd, void *buf, size_t len, tdb_off_t off)
-{
-       while (len) {
-               ssize_t ret;
-               ret = pread(fd, buf, len, off);
-               if (ret < 0)
-                       return false;
-               if (ret == 0) {
-                       /* ETOOSHORT? */
-                       errno = EWOULDBLOCK;
-                       return false;
-               }
-               buf = (char *)buf + ret;
-               off += ret;
-               len -= ret;
-       }
-       return true;
-}
-
-bool tdb_read_all(int fd, void *buf, size_t len)
-{
-       while (len) {
-               ssize_t ret;
-               ret = read(fd, buf, len);
-               if (ret < 0)
-                       return false;
-               if (ret == 0) {
-                       /* ETOOSHORT? */
-                       errno = EWOULDBLOCK;
-                       return false;
-               }
-               buf = (char *)buf + ret;
-               len -= ret;
-       }
-       return true;
-}
-
 /* 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_DEBUG_WARNING,
-                          "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;
+               return TDB_SUCCESS;
        }
 
-       if (tdb->methods->oob(tdb, off + len, 0) != 0)
-               return -1;
+       ecode = tdb->methods->oob(tdb, off + len, 0);
+       if (ecode != TDB_SUCCESS) {
+               return ecode;
+       }
 
        if (tdb->map_ptr) {
                memcpy(off + (char *)tdb->map_ptr, buf, len);
        } else {
-               if (!tdb_pwrite_all(tdb->fd, buf, len, off)) {
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_FATAL,
-                                  "tdb_write failed at %zu len=%zu (%s)",
-                                  (size_t)off, (size_t)len, strerror(errno));
-                       return -1;
+               ssize_t ret;
+               ret = pwrite(tdb->fd, buf, len, off);
+               if (ret < len) {
+                       /* This shouldn't happen: we avoid sparse files. */
+                       if (ret >= 0)
+                               errno = ENOSPC;
+
+                       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) {
                memcpy(buf, off + (char *)tdb->map_ptr, len);
        } else {
-               if (!tdb_pread_all(tdb->fd, buf, len, off)) {
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_FATAL,
-                                  "tdb_read failed at %zu "
-                                  "len=%zu (%s) map_size=%zu",
-                                (size_t)off, (size_t)len,
-                                strerror(errno),
-                                (size_t)tdb->map_size);
-                       return -1;
+               ssize_t r = pread(tdb->fd, buf, len, off);
+               if (r != len) {
+                       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)
 {
-       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_DEBUG_FATAL,
+                       tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
                                   "tdb_write: no memory converting"
                                   " %zu bytes", len);
                        return -1;
                }
                memcpy(conv, rec, len);
-               ret = tdb->methods->write(tdb, off,
-                                         tdb_convert(tdb, conv, len), len);
+               ecode = tdb->methods->twrite(tdb, off,
+                                          tdb_convert(tdb, conv, len), len);
                free(conv);
-       } else
-               ret = tdb->methods->write(tdb, off, rec, len);
+       } else {
+               ecode = tdb->methods->twrite(tdb, off, rec, len);
+       }
 
-       return ret;
+       if (ecode != TDB_SUCCESS) {
+               tdb->ecode = ecode;
+               return -1;
+       }
+       return 0;
 }
 
 int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
                      void *rec, size_t len)
 {
-       int ret = tdb->methods->read(tdb, off, rec, len);
+       enum TDB_ERROR ecode = tdb->methods->tread(tdb, off, rec, len);
        tdb_convert(tdb, rec, len);
-       return ret;
+       if (ecode != TDB_SUCCESS) {
+               tdb->ecode = ecode;
+               return -1;
+       }
+       return 0;
 }
 
 int 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_DEBUG_WARNING,
+               tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
                           "Write to read-only database");
                return -1;
        }
@@ -371,17 +344,21 @@ 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);
        if (!buf) {
-               tdb_logerr(tdb, TDB_ERR_OOM, TDB_DEBUG_ERROR,
+               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->read(tdb, offset, buf+prefix,
-                                              len) == -1)) {
-               free(buf);
-               buf = NULL;
+       } else {
+               ecode = tdb->methods->tread(tdb, offset, buf+prefix, len);
+               if (unlikely(ecode != TDB_SUCCESS)) {
+                       tdb->ecode = ecode;
+                       free(buf);
+                       buf = NULL;
+               }
        }
        return buf;
 }
@@ -398,10 +375,15 @@ static int fill(struct tdb_context *tdb,
 {
        while (len) {
                size_t n = len > size ? size : len;
-
-               if (!tdb_pwrite_all(tdb->fd, buf, n, off)) {
-                       tdb_logerr(tdb, TDB_ERR_IO, TDB_DEBUG_FATAL,
-                                "fill write failed: giving up!");
+               ssize_t ret = pwrite(tdb->fd, buf, n, off);
+               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;
                }
                len -= n;
@@ -412,22 +394,21 @@ static int fill(struct tdb_context *tdb,
 
 /* 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];
 
        if (tdb->read_only) {
-               tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_DEBUG_WARNING,
-                          "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_DEBUG_FATAL,
-                                  "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;
@@ -444,25 +425,18 @@ 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;
+               if (fill(tdb, buf, sizeof(buf), tdb->map_size, addition) == -1)
+                       return tdb->ecode;
                tdb->map_size += addition;
                tdb_mmap(tdb);
        }
-       return 0;
+       return TDB_SUCCESS;
 }
 
-/* This is only neded for tdb_access_commit, but used everywhere to simplify. */
-struct tdb_access_hdr {
-       tdb_off_t off;
-       tdb_len_t len;
-       bool convert;
-};
-
 const void *tdb_access_read(struct tdb_context *tdb,
                            tdb_off_t off, tdb_len_t len, bool convert)
 {
-       const void *ret = NULL; 
+       const void *ret = NULL;
 
        if (likely(!(tdb->flags & TDB_CONVERT)))
                ret = tdb->methods->direct(tdb, off, len, false);
@@ -471,6 +445,8 @@ const void *tdb_access_read(struct tdb_context *tdb,
                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);
@@ -487,7 +463,7 @@ void *tdb_access_write(struct tdb_context *tdb,
        void *ret = NULL;
 
        if (tdb->read_only) {
-               tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_DEBUG_WARNING,
+               tdb_logerr(tdb, TDB_ERR_RDONLY, TDB_LOG_USE_ERROR,
                           "Write to read-only database");
                return NULL;
        }
@@ -499,6 +475,8 @@ void *tdb_access_write(struct tdb_context *tdb,
                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;
@@ -512,35 +490,41 @@ void *tdb_access_write(struct tdb_context *tdb,
        return ret;
 }
 
-bool is_direct(const struct tdb_context *tdb, const void *p)
+static struct tdb_access_hdr **find_hdr(struct tdb_context *tdb, const void *p)
 {
-       return (tdb->map_ptr
-               && (char *)p >= (char *)tdb->map_ptr
-               && (char *)p < (char *)tdb->map_ptr + tdb->map_size);
+       struct tdb_access_hdr **hp;
+
+       for (hp = &tdb->access; *hp; hp = &(*hp)->next) {
+               if (*hp + 1 == p)
+                       return hp;
+       }
+       return NULL;
 }
 
 void tdb_access_release(struct tdb_context *tdb, const void *p)
 {
-       if (is_direct(tdb, p))
+       struct tdb_access_hdr *hdr, **hp = find_hdr(tdb, p);
+
+       if (hp) {
+               hdr = *hp;
+               *hp = hdr->next;
+               free(hdr);
+       } else
                tdb->direct_access--;
-       else
-               free((struct tdb_access_hdr *)p - 1);
 }
 
 int tdb_access_commit(struct tdb_context *tdb, void *p)
 {
+       struct tdb_access_hdr *hdr, **hp = find_hdr(tdb, p);
        int ret = 0;
 
-       if (!tdb->map_ptr
-           || (char *)p < (char *)tdb->map_ptr
-           || (char *)p >= (char *)tdb->map_ptr + tdb->map_size) {
-               struct tdb_access_hdr *hdr;
-
-               hdr = (struct tdb_access_hdr *)p - 1;
+       if (hp) {
+               hdr = *hp;
                if (hdr->convert)
                        ret = tdb_write_convert(tdb, hdr->off, p, hdr->len);
                else
                        ret = tdb_write(tdb, hdr->off, p, hdr->len);
+               *hp = hdr->next;
                free(hdr);
        } else
                tdb->direct_access--;
@@ -549,20 +533,20 @@ int tdb_access_commit(struct tdb_context *tdb, void *p)
 }
 
 static void *tdb_direct(struct tdb_context *tdb, tdb_off_t off, size_t len,
-                       bool write)
+                       bool write_mode)
 {
        if (unlikely(!tdb->map_ptr))
                return NULL;
 
-       if (unlikely(tdb_oob(tdb, off + len, true) == -1))
+       if (unlikely(tdb_oob(tdb, off + len, true) != TDB_SUCCESS))
                return NULL;
        return (char *)tdb->map_ptr + off;
 }
 
-void add_stat_(struct tdb_context *tdb, uint64_t *stat, size_t val)
+void add_stat_(struct tdb_context *tdb, uint64_t *s, size_t val)
 {
-       if ((uintptr_t)stat < (uintptr_t)tdb->stats + tdb->stats->size)
-               *stat += val;
+       if ((uintptr_t)s < (uintptr_t)tdb->stats + tdb->stats->size)
+               *s += val;
 }
 
 static const struct tdb_methods io_methods = {