tskit 0.15.0

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <assert.h>
#include <errno.h>
#include <stdbool.h>

#include "kastore.h"

/* Private flag used to indicate when we have opened the file ourselves
 * and need to free it. */
/* Note: we use 1<<14 to keep this flag at the end of the flag space,
 * and this is the highest bit that can be guaranteed to fit into
 * an int. */
#define OWN_FILE (1 << 14)

const char *
kas_strerror(int err)
{
    const char *ret = "Unknown error";

    switch (err) {
        case KAS_ERR_GENERIC:
            ret = "Generic error; please file a bug report";
            break;
        case KAS_ERR_IO:
            if (errno != 0) {
                ret = strerror(errno);
            } else {
                ret = "I/O error with errno unset. Please file a bug report";
            }
            break;
        case KAS_ERR_BAD_MODE:
            ret = "Bad open mode; must be \"r\", \"w\", or \"a\"";
            break;
        case KAS_ERR_BAD_FLAGS:
            ret = "Unknown flags specified. Only (KAS_GET_TAKES_OWNERSHIP and/or"
                  "KAS_READ_ALL) or 0 can be specified "
                  "for open, and KAS_BORROWS_ARRAY or 0 for put";
            break;
        case KAS_ERR_NO_MEMORY:
            ret = "Out of memory";
            break;
        case KAS_ERR_BAD_FILE_FORMAT:
            ret = "File not in KAS format";
            break;
        case KAS_ERR_VERSION_TOO_OLD:
            ret = "File format version is too old. Please upgrade using "
                  "'kas upgrade <filename>'";
            break;
        case KAS_ERR_VERSION_TOO_NEW:
            ret = "File format version is too new. Please upgrade your "
                  "kastore library version";
            break;
        case KAS_ERR_BAD_TYPE:
            ret = "Unknown data type";
            break;
        case KAS_ERR_DUPLICATE_KEY:
            ret = "Duplicate key provided";
            break;
        case KAS_ERR_KEY_NOT_FOUND:
            ret = "Key not found";
            break;
        case KAS_ERR_EMPTY_KEY:
            ret = "Keys cannot be empty";
            break;
        case KAS_ERR_ILLEGAL_OPERATION:
            ret = "Cannot perform the requested operation in the current mode";
            break;
        case KAS_ERR_TYPE_MISMATCH:
            ret = "Mismatch between requested and stored types for array";
            break;
        case KAS_ERR_EOF:
            ret = "End of file";
            break;
    }
    return ret;
}

kas_version_t
kas_version(void)
{
    kas_version_t version;

    version.major = KAS_VERSION_MAJOR;
    version.minor = KAS_VERSION_MINOR;
    version.patch = KAS_VERSION_PATCH;
    return version;
}

static size_t
type_size(int type)
{
    const size_t type_size_map[] = { 1, 1, 2, 2, 4, 4, 8, 8, 4, 8 };
    assert(type < KAS_NUM_TYPES);
    return type_size_map[type];
}

/* Compare item keys lexicographically. */
static int
compare_items(const void *a, const void *b)
{
    const kaitem_t *ia = (const kaitem_t *) a;
    const kaitem_t *ib = (const kaitem_t *) b;
    size_t len = ia->key_len < ib->key_len ? ia->key_len : ib->key_len;
    int ret = memcmp(ia->key, ib->key, len);
    if (ret == 0) {
        ret = (ia->key_len > ib->key_len) - (ia->key_len < ib->key_len);
    }
    return ret;
}

/* When a read error occurs we don't know whether this is because the file
 * ended unexpectedly or an IO error occured. If the file ends unexpectedly
 * this is a file format error.
 */
static int KAS_WARN_UNUSED
kastore_get_read_io_error(kastore_t *self)
{
    int ret = KAS_ERR_IO;

    if (feof(self->file) || errno == 0) {
        ret = KAS_ERR_BAD_FILE_FORMAT;
    }
    return ret;
}

static int KAS_WARN_UNUSED
kastore_write_header(kastore_t *self)
{
    int ret = 0;
    char header[KAS_HEADER_SIZE];
    uint16_t version_major = KAS_FILE_VERSION_MAJOR;
    uint16_t version_minor = KAS_FILE_VERSION_MINOR;
    uint32_t num_items = (uint32_t) self->num_items;
    uint64_t file_size = (uint64_t) self->file_size;

    memset(header, 0, sizeof(header));
    memcpy(header, KAS_MAGIC, 8);
    memcpy(header + 8, &version_major, 2);
    memcpy(header + 10, &version_minor, 2);
    memcpy(header + 12, &num_items, 4);
    memcpy(header + 16, &file_size, 8);
    /* Rest of header is reserved */
    if (fwrite(header, KAS_HEADER_SIZE, 1, self->file) != 1) {
        ret = KAS_ERR_IO;
        goto out;
    }
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_read_header(kastore_t *self)
{
    int ret = 0;
    char header[KAS_HEADER_SIZE];
    uint16_t version_major, version_minor;
    uint32_t num_items;
    uint64_t file_size;
    size_t count;

    count = fread(header, 1, KAS_HEADER_SIZE, self->file);
    if (count == 0 && feof(self->file)) {
        ret = KAS_ERR_EOF;
        goto out;
    } else if (count != KAS_HEADER_SIZE) {
        ret = kastore_get_read_io_error(self);
        goto out;
    }
    if (strncmp(header, KAS_MAGIC, 8) != 0) {
        ret = KAS_ERR_BAD_FILE_FORMAT;
        goto out;
    }
    memcpy(&version_major, header + 8, 2);
    memcpy(&version_minor, header + 10, 2);
    memcpy(&num_items, header + 12, 4);
    memcpy(&file_size, header + 16, 8);
    self->file_version[0] = (int) version_major;
    self->file_version[1] = (int) version_minor;
    if (self->file_version[0] < KAS_FILE_VERSION_MAJOR) {
        ret = KAS_ERR_VERSION_TOO_OLD;
        goto out;
    } else if (self->file_version[0] > KAS_FILE_VERSION_MAJOR) {
        ret = KAS_ERR_VERSION_TOO_NEW;
        goto out;
    }
    self->num_items = num_items;
    self->file_size = (size_t) file_size;
    if (self->file_size < KAS_HEADER_SIZE) {
        ret = KAS_ERR_BAD_FILE_FORMAT;
        goto out;
    }
out:
    return ret;
}

/* Compute the locations of the keys and arrays in the file. */
static void
kastore_pack_items(kastore_t *self)
{
    size_t j, offset, remainder;

    /* Pack the keys */
    offset = KAS_HEADER_SIZE + self->num_items * KAS_ITEM_DESCRIPTOR_SIZE;
    for (j = 0; j < self->num_items; j++) {
        self->items[j].key_start = offset;
        offset += self->items[j].key_len;
    }
    /* Pack the arrays */
    for (j = 0; j < self->num_items; j++) {
        remainder = offset % KAS_ARRAY_ALIGN;
        if (remainder != 0) {
            offset += KAS_ARRAY_ALIGN - remainder;
        }
        self->items[j].array_start = offset;
        offset += self->items[j].array_len * type_size(self->items[j].type);
    }
    self->file_size = offset;
}

static int KAS_WARN_UNUSED
kastore_write_descriptors(kastore_t *self)
{
    int ret = 0;
    size_t j;
    uint8_t type;
    uint64_t key_start, key_len, array_start, array_len;
    char descriptor[KAS_ITEM_DESCRIPTOR_SIZE];

    for (j = 0; j < self->num_items; j++) {
        memset(descriptor, 0, KAS_ITEM_DESCRIPTOR_SIZE);
        type = (uint8_t) self->items[j].type;
        key_start = (uint64_t) self->items[j].key_start;
        key_len = (uint64_t) self->items[j].key_len;
        array_start = (uint64_t) self->items[j].array_start;
        array_len = (uint64_t) self->items[j].array_len;
        memcpy(descriptor, &type, 1);
        /* Bytes 1-8 are reserved */
        memcpy(descriptor + 8, &key_start, 8);
        memcpy(descriptor + 16, &key_len, 8);
        memcpy(descriptor + 24, &array_start, 8);
        memcpy(descriptor + 32, &array_len, 8);
        /* Rest of descriptor is reserved */
        if (fwrite(descriptor, sizeof(descriptor), 1, self->file) != 1) {
            ret = KAS_ERR_IO;
            goto out;
        }
    }
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_read_descriptors(kastore_t *self)
{
    int ret = KAS_ERR_BAD_FILE_FORMAT;
    size_t j;
    uint8_t type;
    uint64_t key_start, key_len, array_start, array_len;
    char *descriptor;
    size_t descriptor_offset, offset, remainder, size, count;
    char *read_buffer = NULL;

    size = self->num_items * KAS_ITEM_DESCRIPTOR_SIZE;
    if (size + KAS_HEADER_SIZE > self->file_size) {
        goto out;
    }
    read_buffer = (char *) malloc(size);
    if (read_buffer == NULL) {
        ret = KAS_ERR_NO_MEMORY;
        goto out;
    }
    count = fread(read_buffer, size, 1, self->file);
    if (count == 0) {
        ret = kastore_get_read_io_error(self);
        goto out;
    }

    descriptor_offset = 0;
    for (j = 0; j < self->num_items; j++) {
        descriptor = read_buffer + descriptor_offset;
        descriptor_offset += KAS_ITEM_DESCRIPTOR_SIZE;
        memcpy(&type, descriptor, 1);
        memcpy(&key_start, descriptor + 8, 8);
        memcpy(&key_len, descriptor + 16, 8);
        memcpy(&array_start, descriptor + 24, 8);
        memcpy(&array_len, descriptor + 32, 8);

        if (type >= KAS_NUM_TYPES) {
            ret = KAS_ERR_BAD_TYPE;
            goto out;
        }
        self->items[j].type = (int) type;
        if (key_start + key_len > self->file_size) {
            goto out;
        }
        self->items[j].key_start = (size_t) key_start;
        self->items[j].key_len = (size_t) key_len;
        if (array_start + array_len * type_size(type) > self->file_size) {
            goto out;
        }
        self->items[j].array_start = (size_t) array_start;
        self->items[j].array_len = (size_t) array_len;
    }

    /* Check the integrity of the key and array packing. Keys must
     * be packed sequentially starting immediately after the descriptors. */
    offset = KAS_HEADER_SIZE + self->num_items * KAS_ITEM_DESCRIPTOR_SIZE;
    for (j = 0; j < self->num_items; j++) {
        if (self->items[j].key_start != offset) {
            ret = KAS_ERR_BAD_FILE_FORMAT;
            goto out;
        }
        offset += self->items[j].key_len;
    }
    for (j = 0; j < self->num_items; j++) {
        /* Arrays are 8 byte aligned and adjacent */
        remainder = offset % KAS_ARRAY_ALIGN;
        if (remainder != 0) {
            offset += KAS_ARRAY_ALIGN - remainder;
        }
        if (self->items[j].array_start != offset) {
            ret = KAS_ERR_BAD_FILE_FORMAT;
            goto out;
        }
        offset += self->items[j].array_len * type_size(self->items[j].type);
    }
    if (offset != self->file_size) {
        ret = KAS_ERR_BAD_FILE_FORMAT;
        goto out;
    }
    ret = 0;
out:
    kas_safe_free(read_buffer);
    return ret;
}

static int KAS_WARN_UNUSED
kastore_write_data(kastore_t *self)
{
    int ret = 0;
    size_t j, size, offset, padding;
    char pad[KAS_ARRAY_ALIGN] = { 0, 0, 0, 0, 0, 0, 0 };
    const void *write_array;

    offset = KAS_HEADER_SIZE + self->num_items * KAS_ITEM_DESCRIPTOR_SIZE;

    /* Write the keys. */
    for (j = 0; j < self->num_items; j++) {
        assert(offset == self->items[j].key_start);
        if (fwrite(self->items[j].key, self->items[j].key_len, 1, self->file) != 1) {
            ret = KAS_ERR_IO;
            goto out;
        }
        offset += self->items[j].key_len;
    }
    /* Write the arrays. */
    for (j = 0; j < self->num_items; j++) {
        padding = self->items[j].array_start - offset;
        assert(padding < KAS_ARRAY_ALIGN);
        if (padding > 0 && fwrite(pad, padding, 1, self->file) != 1) {
            ret = KAS_ERR_IO;
            goto out;
        }
        size = self->items[j].array_len * type_size(self->items[j].type);
        write_array = self->items[j].borrowed_array != NULL
                          ? self->items[j].borrowed_array
                          : self->items[j].array;
        assert(write_array != NULL);
        if (size > 0 && fwrite(write_array, size, 1, self->file) != 1) {
            ret = KAS_ERR_IO;
            goto out;
        }
        offset = self->items[j].array_start + size;
    }
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_read_file(kastore_t *self)
{
    int ret = 0;
    size_t count, size, offset, j;
    bool read_all = !!(self->flags & KAS_READ_ALL);

    offset = KAS_HEADER_SIZE + self->num_items * KAS_ITEM_DESCRIPTOR_SIZE;

    /* Read in up to the start of first array. This will contain all the keys. */
    size = self->items[0].array_start;

    assert(size > offset);
    size -= offset;

    self->key_read_buffer = (char *) malloc(size);
    if (self->key_read_buffer == NULL) {
        ret = KAS_ERR_NO_MEMORY;
        goto out;
    }
    count = fread(self->key_read_buffer, size, 1, self->file);
    if (count == 0) {
        ret = kastore_get_read_io_error(self);
        goto out;
    }
    /* Assign the pointers for the keys and arrays */
    for (j = 0; j < self->num_items; j++) {
        /* keys are already loaded in the read buffer */
        self->items[j].key = self->key_read_buffer + self->items[j].key_start - offset;
        if (read_all) {
            if (j == self->num_items - 1) {
                size = self->file_size - self->items[j].array_start;
            } else {
                size = self->items[j + 1].array_start - self->items[j].array_start;
            }
            self->items[j].array = (char *) malloc(size == 0 ? 1 : size);
            if (self->items[j].array == NULL) {
                ret = KAS_ERR_NO_MEMORY;
                goto out;
            }
            if (size > 0) {
                count = fread(self->items[j].array, size, 1, self->file);
                if (count == 0) {
                    ret = kastore_get_read_io_error(self);
                    goto out;
                }
            }
        }
    }
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_read_item(kastore_t *self, kaitem_t *item)
{
    int ret = 0;
    int err;
    size_t size = item->array_len * type_size(item->type);
    size_t count;

    item->array = malloc(size == 0 ? 1 : size);
    if (item->array == NULL) {
        ret = KAS_ERR_NO_MEMORY;
        goto out;
    }
    if (size > 0) {
        err = fseek(self->file, self->file_offset + (long) item->array_start, SEEK_SET);
        if (err != 0) {
            ret = KAS_ERR_IO;
            goto out;
        }
        count = fread(item->array, size, 1, self->file);
        if (count == 0) {
            ret = kastore_get_read_io_error(self);
            goto out;
        }
    }
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_write_file(kastore_t *self)
{
    int ret = 0;

    qsort(self->items, self->num_items, sizeof(kaitem_t), compare_items);
    kastore_pack_items(self);
    ret = kastore_write_header(self);
    if (ret != 0) {
        goto out;
    }
    ret = kastore_write_descriptors(self);
    if (ret != 0) {
        goto out;
    }
    ret = kastore_write_data(self);
    if (ret != 0) {
        goto out;
    }
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_read(kastore_t *self)
{
    int ret = 0;

    if (!(self->flags & KAS_READ_ALL)) {
        /* Record the current file offset, in case this is a multi-store file,
         * so that we can seek to the correct location in kastore_read_item().
         */
        self->file_offset = ftell(self->file);
        if (self->file_offset == -1) {
            ret = KAS_ERR_IO;
            goto out;
        }
    }
    ret = kastore_read_header(self);
    if (ret != 0) {
        goto out;
    }
    if (self->num_items > 0) {
        self->items = (kaitem_t *) calloc(self->num_items, sizeof(*self->items));
        if (self->items == NULL) {
            ret = KAS_ERR_NO_MEMORY;
            goto out;
        }
        ret = kastore_read_descriptors(self);
        if (ret != 0) {
            goto out;
        }
        ret = kastore_read_file(self);
        if (ret != 0) {
            goto out;
        }
    } else if (self->file_size != KAS_HEADER_SIZE) {
        ret = KAS_ERR_BAD_FILE_FORMAT;
        goto out;
    }
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_insert_all(kastore_t *self, kastore_t *other)
{
    size_t j;
    int ret = 0;
    kaitem_t item;

    for (j = 0; j < other->num_items; j++) {
        item = other->items[j];
        ret = kastore_put(
            self, item.key, item.key_len, item.array, item.array_len, item.type, 0);
        if (ret != 0) {
            goto out;
        }
    }
out:
    return ret;
}

int KAS_WARN_UNUSED
kastore_open(kastore_t *self, const char *filename, const char *mode, int flags)
{
    int ret = 0;
    const char *file_mode;
    bool appending = false;
    kastore_t tmp;
    FILE *file;
    int err;

    memset(self, 0, sizeof(*self));
    memset(&tmp, 0, sizeof(tmp));
    if (strlen(mode) != 1) {
        ret = KAS_ERR_BAD_MODE;
        goto out;
    }
    if (strncmp(mode, "r", 1) == 0) {
        file_mode = "rb";
    } else if (strncmp(mode, "w", 1) == 0) {
        file_mode = "wb";
    } else if (strncmp(mode, "a", 1) == 0) {
        mode = "w";
        file_mode = "wb";
        appending = true;
    } else {
        ret = KAS_ERR_BAD_MODE;
        goto out;
    }
    if (appending) {
        ret = kastore_open(&tmp, filename, "r", KAS_READ_ALL);
        if (ret != 0) {
            goto out;
        }
        /* tmp will now have read all of the data into memory. We can now
         * close its file. We have to do this for Windows. */
        err = fclose(tmp.file);
        tmp.file = NULL;
        if (err != 0) {
            ret = KAS_ERR_IO;
            goto out;
        }
    }
    file = fopen(filename, file_mode);
    if (file == NULL) {
        ret = KAS_ERR_IO;
        goto out;
    }
    ret = kastore_openf(self, file, mode, flags);
    if (ret != 0) {
        (void) fclose(file);
    } else {
        self->flags |= OWN_FILE;
        if (appending) {
            ret = kastore_insert_all(self, &tmp);
        }
    }
out:
    if (appending) {
        kastore_close(&tmp);
    }
    return ret;
}

int KAS_WARN_UNUSED
kastore_openf(kastore_t *self, FILE *file, const char *mode, int flags)
{
    int ret = 0;

    memset(self, 0, sizeof(*self));
    if (strlen(mode) != 1) {
        ret = KAS_ERR_BAD_MODE;
        goto out;
    }
    if (strncmp(mode, "r", 1) == 0) {
        self->mode = KAS_READ;
    } else if (strncmp(mode, "w", 1) == 0) {
        self->mode = KAS_WRITE;
    } else {
        ret = KAS_ERR_BAD_MODE;
        goto out;
    }

    if (flags > (KAS_READ_ALL | KAS_GET_TAKES_OWNERSHIP) || flags < 0) {
        ret = KAS_ERR_BAD_FLAGS;
        goto out;
    }

    self->flags = flags;
    self->file = file;
    if (self->mode == KAS_READ) {
        ret = kastore_read(self);
    }
out:
    return ret;
}

int KAS_WARN_UNUSED
kastore_close(kastore_t *self)
{
    int ret = 0;
    int err;
    size_t j;

    if (self->mode == KAS_WRITE) {
        if (self->file != NULL) {
            ret = kastore_write_file(self);
            if (ret != 0) {
                /* Ignore errors on close now */
                if (self->flags & OWN_FILE) {
                    fclose(self->file);
                }
                self->file = NULL;
            }
        }
        if (self->items != NULL) {
            /* We only alloc memory for the keys and arrays in write mode */
            for (j = 0; j < self->num_items; j++) {
                kas_safe_free(self->items[j].key);
                kas_safe_free(self->items[j].array);
            }
        }
    } else {
        kas_safe_free(self->key_read_buffer);
        if (self->items != NULL) {
            for (j = 0; j < self->num_items; j++) {
                kas_safe_free(self->items[j].array);
            }
        }
    }
    kas_safe_free(self->items);
    if (self->file != NULL && (self->flags & OWN_FILE)) {
        err = fclose(self->file);
        if (err != 0) {
            ret = KAS_ERR_IO;
        }
    }
    memset(self, 0, sizeof(*self));
    return ret;
}

static int
kastore_find_item(kastore_t *self, const char *key, size_t key_len, kaitem_t **item)
{
    int ret = KAS_ERR_KEY_NOT_FOUND;
    kaitem_t search;
    search.key = (char *) malloc(key_len);
    search.key_len = key_len;

    if (self->mode != KAS_READ) {
        ret = KAS_ERR_ILLEGAL_OPERATION;
        goto out;
    }
    if (search.key == NULL) {
        ret = KAS_ERR_NO_MEMORY;
        goto out;
    }
    memcpy(search.key, key, key_len);
    *item = bsearch(
        &search, self->items, self->num_items, sizeof(kaitem_t), compare_items);
    if (*item == NULL) {
        goto out;
    }
    ret = 0;
out:
    kas_safe_free(search.key);
    return ret;
}

int KAS_WARN_UNUSED
kastore_contains(kastore_t *self, const char *key, size_t key_len)
{
    kaitem_t *item;
    int ret = kastore_find_item(self, key, key_len, &item);
    if (ret == 0) {
        ret = 1;
    } else if (ret == KAS_ERR_KEY_NOT_FOUND) {
        ret = 0;
    }
    return ret;
}

int KAS_WARN_UNUSED
kastore_containss(kastore_t *self, const char *key)
{
    return kastore_contains(self, key, strlen(key));
}

int KAS_WARN_UNUSED
kastore_get(kastore_t *self, const char *key, size_t key_len, void **array,
    size_t *array_len, int *type)
{
    kaitem_t *item;
    int ret = kastore_find_item(self, key, key_len, &item);
    if (ret != 0) {
        goto out;
    }
    if (item->array == NULL) {
        ret = kastore_read_item(self, item);
        if (ret != 0) {
            goto out;
        }
    }
    *array = item->array;
    *array_len = item->array_len;
    *type = item->type;
    if (self->flags & KAS_GET_TAKES_OWNERSHIP) {
        item->array = NULL;
    }
    ret = 0;
out:
    return ret;
}

int KAS_WARN_UNUSED
kastore_gets(
    kastore_t *self, const char *key, void **array, size_t *array_len, int *type)
{
    return kastore_get(self, key, strlen(key), array, array_len, type);
}

static int KAS_WARN_UNUSED
kastore_gets_type(
    kastore_t *self, const char *key, void **array, size_t *array_len, int type)
{
    int loaded_type = -1;
    int ret;

    ret = kastore_get(self, key, strlen(key), array, array_len, &loaded_type);
    if (ret != 0) {
        goto out;
    }
    if (type != loaded_type) {
        ret = KAS_ERR_TYPE_MISMATCH;
        goto out;
    }
out:
    return ret;
}

int KAS_WARN_UNUSED
kastore_gets_int8(kastore_t *self, const char *key, int8_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_INT8);
}

int KAS_WARN_UNUSED
kastore_gets_uint8(kastore_t *self, const char *key, uint8_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_UINT8);
}

int KAS_WARN_UNUSED
kastore_gets_int16(kastore_t *self, const char *key, int16_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_INT16);
}

int KAS_WARN_UNUSED
kastore_gets_uint16(
    kastore_t *self, const char *key, uint16_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_UINT16);
}

int KAS_WARN_UNUSED
kastore_gets_int32(kastore_t *self, const char *key, int32_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_INT32);
}

int KAS_WARN_UNUSED
kastore_gets_uint32(
    kastore_t *self, const char *key, uint32_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_UINT32);
}

int KAS_WARN_UNUSED
kastore_gets_int64(kastore_t *self, const char *key, int64_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_INT64);
}

int KAS_WARN_UNUSED
kastore_gets_uint64(
    kastore_t *self, const char *key, uint64_t **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_UINT64);
}

int KAS_WARN_UNUSED
kastore_gets_float32(kastore_t *self, const char *key, float **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_FLOAT32);
}

int KAS_WARN_UNUSED
kastore_gets_float64(kastore_t *self, const char *key, double **array, size_t *array_len)
{
    return kastore_gets_type(self, key, (void **) array, array_len, KAS_FLOAT64);
}

static int KAS_WARN_UNUSED
kastore_put_item(kastore_t *self, kaitem_t **ret_item, const char *key, size_t key_len,
    int type, int KAS_UNUSED(flags))
{
    int ret = 0;
    kaitem_t *new_item;
    kaitem_t *p;
    size_t j;

    if (self->mode != KAS_WRITE) {
        ret = KAS_ERR_ILLEGAL_OPERATION;
        goto out;
    }
    if (type < 0 || type >= KAS_NUM_TYPES) {
        ret = KAS_ERR_BAD_TYPE;
        goto out;
    }
    if (key_len == 0) {
        ret = KAS_ERR_EMPTY_KEY;
        goto out;
    }
    /* This isn't terribly efficient, but we're not expecting large
     * numbers of items. */
    p = (kaitem_t *) realloc(self->items, (self->num_items + 1) * sizeof(*self->items));
    if (p == NULL) {
        ret = KAS_ERR_NO_MEMORY;
        goto out;
    }
    self->items = p;
    new_item = self->items + self->num_items;

    memset(new_item, 0, sizeof(*new_item));
    new_item->type = type;
    new_item->key_len = key_len;
    new_item->key = (char *) malloc(key_len);
    if (new_item->key == NULL) {
        kas_safe_free(new_item->key);
        ret = KAS_ERR_NO_MEMORY;
        goto out;
    }
    self->num_items++;
    memcpy(new_item->key, key, key_len);

    /* Check if this key is already in here. OK, this is a quadratic time
     * algorithm, but we're not expecting to have lots of items (< 100). In
     * this case, the simple algorithm is probably better. If/when we ever
     * deal with more items than this, then we will need a better algorithm.
     */
    for (j = 0; j < self->num_items - 1; j++) {
        if (compare_items(new_item, self->items + j) == 0) {
            /* Free the key memory and remove this item */
            self->num_items--;
            kas_safe_free(new_item->key);
            ret = KAS_ERR_DUPLICATE_KEY;
            goto out;
        }
    }
    *ret_item = new_item;
out:
    return ret;
}

static int KAS_WARN_UNUSED
kastore_bput(kastore_t *self, const char *key, size_t key_len, const void *array,
    size_t array_len, int type, int flags)
{
    int ret = 0;
    kaitem_t *item;
    ret = kastore_put_item(self, &item, key, key_len, type, flags);
    if (ret != 0) {
        goto out;
    }
    if (array == NULL) {
        /* Both can't be null, so assign a dummy array */
        item->array = malloc(1);
    } else {
        item->borrowed_array = array;
    }
    item->borrowed_array = array;
    item->array_len = array_len;
out:
    return ret;
}

int KAS_WARN_UNUSED
kastore_put(kastore_t *self, const char *key, size_t key_len, const void *array,
    size_t array_len, int type, int flags)
{
    int ret;
    size_t array_size;
    void *array_copy = NULL;

    if (flags != KAS_BORROWS_ARRAY && flags != 0) {
        ret = KAS_ERR_BAD_FLAGS;
        goto out;
    }

    if (type < 0 || type >= KAS_NUM_TYPES) {
        ret = KAS_ERR_BAD_TYPE;
        goto out;
    }
    if (flags & KAS_BORROWS_ARRAY) {
        ret = kastore_bput(self, key, key_len, array, array_len, type, flags);
    } else {
        array_size = type_size(type) * array_len;
        array_copy = malloc(array_size == 0 ? 1 : array_size);
        if (array_copy == NULL) {
            ret = KAS_ERR_NO_MEMORY;
            goto out;
        }
        memcpy(array_copy, array, array_size);
        ret = kastore_oput(self, key, key_len, array_copy, array_len, type, flags);
        if (ret == 0) {
            /* Kastore has taken ownership of the array, so we don't need to free it */
            array_copy = NULL;
        }
    }
out:
    kas_safe_free(array_copy);
    return ret;
}

int KAS_WARN_UNUSED
kastore_oput(kastore_t *self, const char *key, size_t key_len, void *array,
    size_t array_len, int type, int flags)
{
    int ret = 0;
    kaitem_t *item;

    if (flags != 0) {
        ret = KAS_ERR_BAD_FLAGS;
        goto out;
    }

    ret = kastore_put_item(self, &item, key, key_len, type, flags);
    if (ret != 0) {
        goto out;
    }
    item->array = array;
    item->array_len = array_len;
out:
    return ret;
}

int KAS_WARN_UNUSED
kastore_puts(kastore_t *self, const char *key, const void *array, size_t array_len,
    int type, int flags)
{
    return kastore_put(self, key, strlen(key), array, array_len, type, flags);
}

int KAS_WARN_UNUSED
kastore_puts_int8(
    kastore_t *self, const char *key, const int8_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_INT8, flags);
}

int KAS_WARN_UNUSED
kastore_puts_uint8(
    kastore_t *self, const char *key, const uint8_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_UINT8, flags);
}

int KAS_WARN_UNUSED
kastore_puts_int16(
    kastore_t *self, const char *key, const int16_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_INT16, flags);
}

int KAS_WARN_UNUSED
kastore_puts_uint16(
    kastore_t *self, const char *key, const uint16_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_UINT16, flags);
}

int KAS_WARN_UNUSED
kastore_puts_int32(
    kastore_t *self, const char *key, const int32_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_INT32, flags);
}

int KAS_WARN_UNUSED
kastore_puts_uint32(
    kastore_t *self, const char *key, const uint32_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_UINT32, flags);
}

int KAS_WARN_UNUSED
kastore_puts_int64(
    kastore_t *self, const char *key, const int64_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_INT64, flags);
}

int KAS_WARN_UNUSED
kastore_puts_uint64(
    kastore_t *self, const char *key, const uint64_t *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_UINT64, flags);
}

int KAS_WARN_UNUSED
kastore_puts_float32(
    kastore_t *self, const char *key, const float *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_FLOAT32, flags);
}

int KAS_WARN_UNUSED
kastore_puts_float64(
    kastore_t *self, const char *key, const double *array, size_t array_len, int flags)
{
    return kastore_puts(self, key, (const void *) array, array_len, KAS_FLOAT64, flags);
}

int KAS_WARN_UNUSED
kastore_oputs(
    kastore_t *self, const char *key, void *array, size_t array_len, int type, int flags)
{
    return kastore_oput(self, key, strlen(key), array, array_len, type, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_int8(
    kastore_t *self, const char *key, int8_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_INT8, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_uint8(
    kastore_t *self, const char *key, uint8_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_UINT8, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_int16(
    kastore_t *self, const char *key, int16_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_INT16, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_uint16(
    kastore_t *self, const char *key, uint16_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_UINT16, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_int32(
    kastore_t *self, const char *key, int32_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_INT32, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_uint32(
    kastore_t *self, const char *key, uint32_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_UINT32, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_int64(
    kastore_t *self, const char *key, int64_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_INT64, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_uint64(
    kastore_t *self, const char *key, uint64_t *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_UINT64, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_float32(
    kastore_t *self, const char *key, float *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_FLOAT32, flags);
}

int KAS_WARN_UNUSED
kastore_oputs_float64(
    kastore_t *self, const char *key, double *array, size_t array_len, int flags)
{
    return kastore_oputs(self, key, (void *) array, array_len, KAS_FLOAT64, flags);
}

void
kastore_print_state(kastore_t *self, FILE *out)
{
    kaitem_t *item;
    size_t j;

    fprintf(out, "============================\n");
    fprintf(out, "kastore state\n");
    fprintf(out, "file_version = %d.%d\n", self->file_version[0], self->file_version[1]);
    fprintf(out, "mode  = %d\n", self->mode);
    fprintf(out, "flags = %d\n", self->flags);
    fprintf(out, "num_items = %zu\n", self->num_items);
    fprintf(out, "file_size = %zu\n", self->file_size);
    fprintf(out, "own_file  = %d\n", !!(self->flags & OWN_FILE));
    fprintf(out, "file = '%p'\n", (void *) self->file);
    fprintf(out, "============================\n");
    for (j = 0; j < self->num_items; j++) {
        item = self->items + j;
        fprintf(out,
            "%.*s: type=%d, key_start=%zu, key_len=%zu, key=%p, "
            "array_start=%zu, array_len=%zu, array=%p\n",
            (int) item->key_len, item->key, item->type, item->key_start, item->key_len,
            (void *) item->key, item->array_start, item->array_len,
            (void *) item->array);
    }
    fprintf(out, "============================\n");
}