osl.h

Go to the documentation of this file.

#ifndef _OSL_H
#define _OSL_H
/*
 * Copyright (C) 2007-2009 Andre Noll <maan@tuebingen.mpg.de>
 *
 * Licensed under the GPL v2. For licencing details see COPYING.
 */

#include <sys/mman.h>
#include <inttypes.h>

#pragma GCC visibility push(default)

struct osl_object {
        void *data;
        size_t size;
};

enum osl_table_flags {
        OSL_LARGE_TABLE = 1
};

enum osl_storage_type {
        OSL_MAPPED_STORAGE,
         OSL_DISK_STORAGE,
        OSL_NO_STORAGE
};

enum osl_storage_flags {
        OSL_RBTREE = 1,
        OSL_FIXED_SIZE = 2,
        OSL_UNIQUE = 4,
        OSL_DONT_FREE = 8
};

struct osl_table;
struct osl_row;

typedef int osl_compare_func(const struct osl_object *obj1,
        const struct osl_object *obj2);

typedef int osl_rbtree_loop_func(struct osl_row *row, void *data);

struct osl_column_description {
        uint16_t storage_type;
        uint16_t storage_flags;
        char *name;
        osl_compare_func *compare_function;
        uint32_t data_size;
};

struct osl_table_description {
        const char *dir;
        const char *name;
        uint16_t num_columns;
        uint8_t flags;
        struct osl_column_description *column_descriptions;
};

enum osl_close_flags {
        OSL_MARK_CLEAN = 1,
        OSL_FREE_VOLATILE = 2
};

int osl_create_table(const struct osl_table_description *desc);

int osl_open_table(const struct osl_table_description *desc,
        struct osl_table **result);

int osl_close_table(struct osl_table *t, enum osl_close_flags flags);

int osl_get_row(const struct osl_table *t, unsigned col_num,
        const struct osl_object *obj, struct osl_row **result);

int osl_get_object(const struct osl_table *t, const struct osl_row *row,
        unsigned col_num, struct osl_object *object);

int osl_open_disk_object(const struct osl_table *t,
        const struct osl_row *r, unsigned col_num, struct osl_object *obj);

int osl_close_disk_object(struct osl_object *obj);

int osl_add_and_get_row(struct osl_table *t, struct osl_object *objects,
        struct osl_row **row);

int osl_add_row(struct osl_table *t, struct osl_object *objects);

int osl_del_row(struct osl_table *t, struct osl_row *row);

int osl_rbtree_loop(const struct osl_table *t, unsigned col_num,
        void *private_data, osl_rbtree_loop_func *func);

int osl_rbtree_loop_reverse(const struct osl_table *t, unsigned col_num,
        void *private_data, osl_rbtree_loop_func *func);

int osl_update_object(struct osl_table *t, const struct osl_row *r,
        unsigned col_num, struct osl_object *obj);

int osl_get_num_rows(const struct osl_table *t, unsigned *num_rows);

int osl_rbtree_first_row(const struct osl_table *t, unsigned col_num,
        struct osl_row **result);

int osl_rbtree_last_row(const struct osl_table *t, unsigned col_num,
        struct osl_row **result);

int osl_get_nth_row(const struct osl_table *t, unsigned col_num,
        unsigned n, struct osl_row **result);

int osl_get_rank(const struct osl_table *t, struct osl_row *r,
        unsigned col_num, unsigned *rank);

const char *osl_strerror(int num);

#pragma GCC visibility pop

enum osl_errors {       E_OSL_BAD_DB_DIR=1,
        E_OSL_NO_COLUMN_DESC,
        E_OSL_BAD_NAME,
        E_OSL_BAD_STORAGE_TYPE,
        E_OSL_BAD_STORAGE_FLAGS,
        E_OSL_NO_COLUMN_NAME,
        E_OSL_NO_COLUMNS,
        E_OSL_BAD_COLUMN_NAME,
        E_OSL_NO_UNIQUE_RBTREE_COLUMN,
        E_OSL_NO_RBTREE_COL,
        E_OSL_DUPLICATE_COL_NAME,
        E_OSL_BAD_STORAGE_SIZE,
        E_OSL_NO_COMPARE_FUNC,
        E_OSL_BAD_DATA_SIZE,
        E_OSL_NOT_MAPPED,
        E_OSL_ALREADY_MAPPED,
        E_OSL_BAD_SIZE,
        E_OSL_BAD_TABLE,
        E_OSL_BAD_TABLE_DESC,
        E_OSL_RB_KEY_EXISTS,
        E_OSL_RB_KEY_NOT_FOUND,
        E_OSL_BAD_ROW_NUM,
        E_OSL_INDEX_CORRUPTION,
        E_OSL_LSEEK,
        E_OSL_BUSY,
        E_OSL_SHORT_TABLE,
        E_OSL_NO_MAGIC,
        E_OSL_VERSION_MISMATCH,
        E_OSL_BAD_COLUMN_NUM,
        E_OSL_BAD_TABLE_FLAGS,
        E_OSL_BAD_ROW,
        E_OSL_EMPTY,
        E_OSL_MMAP,
        E_OSL_LOOP,
        E_OSL_NOMEM,
        E_OSL_NOTDIR,
        E_OSL_STAT,
        E_OSL_UNLINK,
        E_OSL_WRITE,
        E_OSL_OPEN,
        E_OSL_TRUNCATE,
        E_OSL_MKDIR,
        E_OSL_RENAME,
        E_OSL_MUNMAP,
        E_OSL_FSTAT,
        E_OSL_DIR_EXISTS,
        E_OSL_NOENT};
#endif /* _OSL_H */