ringfs.h

Go to the documentation of this file.

/*
 * Copyright © 2014 Kosma Moczek <kosma@cloudyourcar.com>
 * This program is free software. It comes without any warranty, to the extent
 * permitted by applicable law. You can redistribute it and/or modify it under
 * the terms of the Do What The Fuck You Want To Public License, Version 2, as
 * published by Sam Hocevar. See the COPYING file for more details.
 */

#ifndef RINGFS_H
#define RINGFS_H

#include <stdint.h>
#include <unistd.h>

struct ringfs_flash_partition
{
    int sector_size;            
    int sector_offset;          
    int sector_count;           
    int (*sector_erase)(int address);
    ssize_t (*program)(int address, const void *data, size_t size);
    ssize_t (*read)(int address, void *data, size_t size);
};

struct ringfs_loc {
    int sector;
    int slot;
};

struct ringfs {
    /* Constant values, set once at ringfs_init(). */
    const struct ringfs_flash_partition *flash;
    uint32_t version;
    int object_size;
    /* Cached values. */
    int slots_per_sector;

    /* Read/write pointers. Modified as needed. */
    struct ringfs_loc read;
    struct ringfs_loc write;
    struct ringfs_loc cursor;
};

int ringfs_init(struct ringfs *fs, const struct ringfs_flash_partition *flash, uint32_t version, int object_size);

int ringfs_format(struct ringfs *fs);

int ringfs_scan(struct ringfs *fs);

int ringfs_capacity(struct ringfs *fs);

int ringfs_count_estimate(struct ringfs *fs);

int ringfs_count_exact(struct ringfs *fs);

int ringfs_append(struct ringfs *fs, const void *object);

int ringfs_fetch(struct ringfs *fs, void *object);

int ringfs_discard(struct ringfs *fs);

int ringfs_rewind(struct ringfs *fs);

#endif

/* vim: set ts=4 sw=4 et: */