bitablecommon.h

Go to the documentation of this file.

#ifndef BITABLE_COMMON_H__
#define BITABLE_COMMON_H__
#pragma once

#include <stdint.h>
#include <stdlib.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Used to define DLL exports/imports across platforms. Define BITABLE_DLL if using bitable in dll mode*/
#if defined BITABLE_DLL
#if defined _WIN32 || defined __CYGWIN__
#if defined BITABLE_DLL_EXPORT
#define BITABLE_API __declspec(dllexport)
#else
#define BITABLE_API __declspec(dllimport)
#endif
#else
#if __GNUC__ >= 4 || defined __clang__
#define BITABLE_API __attribute__ ((visibility ("default")))
#endif
#endif
#else 

#define BITABLE_API
#endif

#define BITABLE_MAX_KEY_SIZE 768

#define BITABLE_MIN_PAGE_SIZE 2048

#define BITABLE_MAX_PAGE_SIZE 65536

#define BITABLE_MAX_ALIGNMENT 512

#define BITABLE_MAX_BRANCH_LEVELS 32

typedef enum BitableResult
{
    BR_SUCCESS                  = 0,

    BR_END_OF_SEQUENCE          = 1,

    BR_FILE_OPEN_FAILED         = 2,
    
    BR_FILE_OPERATION_FAILED    = 3,

    BR_FILE_TOO_LARGE           = 4,

    BR_BAD_PATH                 = 5,

    BR_ALREADY_OPEN             = 6,

    BR_FILE_TOO_SMALL           = 7,

    BR_HEADER_CORRUPT           = 8,

    BR_KEY_NOT_FOUND            = 9,

    BR_INVALID_CURSOR_LOCATION  = 10,

    BR_MAXIMUM_TABLE_TREE_DEPTH = 11,

    BR_KEY_INVALID            = 12,

    BR_PAGESIZE_INVALID         = 13,

    BR_ALIGNMENT_INVALID        = 14

} BitableResult;

typedef enum BitableReadOpenFlags
{

    BRO_NONE = 0,

    BRO_RANDOM = 1,

    BRO_SEQUENTIAL = 2

} BitableReadOpenFlags;

typedef struct BitableValue
{
    const void* data;

    int32_t size; 

} BitableValue;

typedef struct BitablePaths
{
    char* leafPath;

    char* largeValuePath;

    char* branchPaths[ BITABLE_MAX_BRANCH_LEVELS ];

} BitablePaths;

typedef struct BitableStats
{

    uint64_t itemCount;

    uint64_t leafPages;

    uint64_t largeValueStoreSize;

    uint32_t depth;

    uint32_t keyAlignment;

    uint32_t valueAlignment;

    uint32_t pageSize;

} BitableStats;

typedef int (BitableComparisonFunction)(const BitableValue* left, const BitableValue* right);

BITABLE_API void bitable_build_paths( BitablePaths* paths, const char* basePath );

BITABLE_API void bitable_free_paths( BitablePaths* paths );

#ifdef __cplusplus
}
#endif 

#endif // -- BITABLE_COMMON_H__