mdbx_8h_source.html

#pragma once

/*

 * Tested with, since 2026:

 *  - Elbrus LCC >= 1.28 (http://www.mcst.ru/lcc);

 *  - GNU C >= 11.3;

 *  - CLANG >= 14.0;

 *  - MSVC >= 19.44 (Visual Studio 2022 toolchain v143),

 * before 2026:

 *  - Elbrus LCC >= 1.23 (http://www.mcst.ru/lcc);

 *  - GNU C >= 4.8;

 *  - CLANG >= 3.9;

 *  - MSVC >= 14.0 (Visual Studio 2015),

 *    but 19.2x could hang due optimizer bug;

 *  - AppleClang.

 */


#ifndef LIBMDBX_H

#define LIBMDBX_H


#if defined(__riscv) || defined(__riscv__) || defined(__RISCV) || defined(__RISCV__)

#warning "The RISC-V architecture is intentionally insecure by design. \

  Please delete this admonition at your own risk, \

  if you make such decision informed and consciously. \

  Refer to https://clck.ru/32d9xH for more information."

#endif /* RISC-V */


#ifdef _MSC_VER

#pragma warning(push, 1)

#pragma warning(disable : 4548) /* expression before comma has no effect;                                              \

                                   expected expression with side - effect */

#pragma warning(disable : 4530) /* C++ exception handler used, but unwind                                              \

                                 * semantics are not enabled. Specify /EHsc */

#pragma warning(disable : 4577) /* 'noexcept' used with no exception handling                                          \

                                 * mode specified; termination on exception is                                         \

                                 * not guaranteed. Specify /EHsc */

#endif                          /* _MSC_VER (warnings) */


/* *INDENT-OFF* */

/* clang-format off */

/* *INDENT-ON* */

/* clang-format on */


#include <stdarg.h>

#include <stddef.h>

#include <stdint.h>

#if !defined(NDEBUG) && !defined(assert)

#include <assert.h>

#endif /* NDEBUG */


#if defined(_WIN32) || defined(_WIN64)

#include <windows.h>

#include <winnt.h>

#ifndef __mode_t_defined

typedef unsigned short mdbx_mode_t;

#else

typedef mode_t mdbx_mode_t;

#endif /* __mode_t_defined */

typedef HANDLE mdbx_filehandle_t;

typedef DWORD mdbx_pid_t;

typedef DWORD mdbx_tid_t;

#else                  /* Windows */

#include <errno.h>     /* for error codes */

#include <pthread.h>   /* for pthread_t */

#include <sys/types.h> /* for pid_t */

#include <sys/uio.h>   /* for struct iovec */

#define HAVE_STRUCT_IOVEC 1

typedef int mdbx_filehandle_t;

typedef pid_t mdbx_pid_t;

typedef pthread_t mdbx_tid_t;

typedef mode_t mdbx_mode_t;

#endif /* !Windows */


#ifdef _MSC_VER

#pragma warning(pop)

#endif


#define MDBX_AMALGAMATED_SOURCE 1


/*----------------------------------------------------------------------------*/


#ifndef __has_attribute

#define __has_attribute(x) (0)

#endif /* __has_attribute */


#ifndef __has_c_attribute

#define __has_c_attribute(x) (0)

#define __has_c_attribute_qualified(x) 0

#elif !defined(__STDC_VERSION__) || __STDC_VERSION__ < 202311L

#define __has_c_attribute_qualified(x) 0

#elif defined(_MSC_VER)

/* MSVC don't support `namespace::attr` syntax */

#define __has_c_attribute_qualified(x) 0

#else

#define __has_c_attribute_qualified(x) __has_c_attribute(x)

#endif /* __has_c_attribute */


#ifndef __has_cpp_attribute

#define __has_cpp_attribute(x) 0

#define __has_cpp_attribute_qualified(x) 0

#elif defined(_MSC_VER) || (__clang__ && __clang__ < 14)

/* MSVC don't support `namespace::attr` syntax */

#define __has_cpp_attribute_qualified(x) 0

#else

#define __has_cpp_attribute_qualified(x) __has_cpp_attribute(x)

#endif /* __has_cpp_attribute */


#ifndef __has_C23_or_CXX_attribute

#if defined(__cplusplus)

#define __has_C23_or_CXX_attribute(x) __has_cpp_attribute_qualified(x)

#else

#define __has_C23_or_CXX_attribute(x) __has_c_attribute_qualified(x)

#endif

#endif /* __has_C23_or_CXX_attribute */


#ifndef __has_feature

#define __has_feature(x) (0)

#define __has_exceptions_disabled (0)

#elif !defined(__has_exceptions_disabled)

#define __has_exceptions_disabled (__has_feature(cxx_noexcept) && !__has_feature(cxx_exceptions))

#endif /* __has_feature */


#ifndef __has_extension

#define __has_extension(x) __has_feature(x)

#endif /* __has_extension */


#ifndef __has_builtin

#define __has_builtin(x) (0)

#endif /* __has_builtin */


#if defined(DOXYGEN)

#define MDBX_PURE_FUNCTION [[gnu::pure]]

#elif __has_C23_or_CXX_attribute(gnu::pure)

#define MDBX_PURE_FUNCTION [[gnu::pure]]

#elif (defined(__GNUC__) || __has_attribute(__pure__)) &&                                                              \

    (!defined(__clang__) /* https://bugs.llvm.org/show_bug.cgi?id=43275 */ || !defined(__cplusplus) ||                 \

     __has_exceptions_disabled)

#define MDBX_PURE_FUNCTION __attribute__((__pure__))

#else

#define MDBX_PURE_FUNCTION

#endif /* MDBX_PURE_FUNCTION */


#if defined(DOXYGEN)

#define MDBX_NOTHROW_PURE_FUNCTION [[gnu::pure, gnu::nothrow]]

#elif __has_C23_or_CXX_attribute(gnu::pure)

#if __has_C23_or_CXX_attribute(gnu::nothrow)

#define MDBX_NOTHROW_PURE_FUNCTION [[gnu::pure, gnu::nothrow]]

#else

#define MDBX_NOTHROW_PURE_FUNCTION [[gnu::pure]]

#endif

#elif defined(__GNUC__) || (__has_attribute(__pure__) && __has_attribute(__nothrow__))

#define MDBX_NOTHROW_PURE_FUNCTION __attribute__((__pure__, __nothrow__))

#elif __has_cpp_attribute(pure)

#define MDBX_NOTHROW_PURE_FUNCTION [[pure]]

#else

#define MDBX_NOTHROW_PURE_FUNCTION

#endif /* MDBX_NOTHROW_PURE_FUNCTION */


#if defined(DOXYGEN)

#define MDBX_CONST_FUNCTION [[gnu::const]]

#elif __has_C23_or_CXX_attribute(gnu::const)

#define MDBX_CONST_FUNCTION [[gnu::const]]

#elif (defined(__GNUC__) || __has_attribute(__const__)) &&                                                             \

    (!defined(__clang__) /* https://bugs.llvm.org/show_bug.cgi?id=43275 */ || !defined(__cplusplus) ||                 \

     __has_exceptions_disabled)

#define MDBX_CONST_FUNCTION __attribute__((__const__))

#else

#define MDBX_CONST_FUNCTION MDBX_PURE_FUNCTION

#endif /* MDBX_CONST_FUNCTION */


#if defined(DOXYGEN)

#define MDBX_NOTHROW_CONST_FUNCTION [[gnu::const, gnu::nothrow]]

#elif __has_C23_or_CXX_attribute(gnu::const)

#if __has_C23_or_CXX_attribute(gnu::nothrow)

#define MDBX_NOTHROW_CONST_FUNCTION [[gnu::const, gnu::nothrow]]

#else

#define MDBX_NOTHROW_CONST_FUNCTION [[gnu::const]]

#endif

#elif defined(__GNUC__) || (__has_attribute(__const__) && __has_attribute(__nothrow__))

#define MDBX_NOTHROW_CONST_FUNCTION __attribute__((__const__, __nothrow__))

#elif __has_cpp_attribute_qualified(const)

#define MDBX_NOTHROW_CONST_FUNCTION [[const]]

#else

#define MDBX_NOTHROW_CONST_FUNCTION MDBX_NOTHROW_PURE_FUNCTION

#endif /* MDBX_NOTHROW_CONST_FUNCTION */


#ifndef MDBX_DEPRECATED

#ifdef __deprecated

#define MDBX_DEPRECATED __deprecated

#elif defined(DOXYGEN) || ((!defined(__GNUC__) || (defined(__clang__) && __clang__ > 19) || __GNUC__ > 5) &&           \

                           ((defined(__cplusplus) && __cplusplus >= 201403L && __has_cpp_attribute(deprecated) &&      \

                             __has_cpp_attribute(deprecated) >= 201309L) ||                                            \

                            (!defined(__cplusplus) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202304L)))

#define MDBX_DEPRECATED [[deprecated]]

#elif (defined(__GNUC__) && __GNUC__ > 5) ||                                                                           \

    (__has_attribute(__deprecated__) && (!defined(__GNUC__) || defined(__clang__) || __GNUC__ > 5))

#define MDBX_DEPRECATED __attribute__((__deprecated__))

#elif defined(_MSC_VER)

#define MDBX_DEPRECATED __declspec(deprecated)

#else

#define MDBX_DEPRECATED

#endif

#endif /* MDBX_DEPRECATED */


#ifndef MDBX_DEPRECATED_ENUM

#ifdef __deprecated_enum

#define MDBX_DEPRECATED_ENUM __deprecated_enum

#elif defined(DOXYGEN) ||                                                                                              \

    (!defined(_MSC_VER) || (defined(__cplusplus) && __cplusplus >= 201403L && __has_cpp_attribute(deprecated) &&       \

                            __has_cpp_attribute(deprecated) >= 201309L))

#define MDBX_DEPRECATED_ENUM MDBX_DEPRECATED

#else

#define MDBX_DEPRECATED_ENUM /* avoid madness MSVC */

#endif

#endif /* MDBX_DEPRECATED_ENUM */


#ifndef __dll_export

#if defined(_WIN32) || defined(_WIN64) || defined(__CYGWIN__) || defined(__MINGW__) || defined(__MINGW32__) ||         \

    defined(__MINGW64__)

#if defined(__GNUC__) || __has_attribute(__dllexport__)

#define __dll_export __attribute__((__dllexport__))

#elif defined(_MSC_VER)

#define __dll_export __declspec(dllexport)

#else

#define __dll_export

#endif

#elif defined(__GNUC__) || defined(__clang__) || __has_attribute(__visibility__)

#define __dll_export __attribute__((__visibility__("default")))

#else

#define __dll_export

#endif

#endif /* __dll_export */


#ifndef __dll_import

#if defined(_WIN32) || defined(_WIN64) || defined(__CYGWIN__) || defined(__MINGW__) || defined(__MINGW32__) ||         \

    defined(__MINGW64__)

#if defined(__GNUC__) || __has_attribute(__dllimport__)

#define __dll_import __attribute__((__dllimport__))

#elif defined(_MSC_VER)

#define __dll_import __declspec(dllimport)

#else

#define __dll_import

#endif

#else

#define __dll_import

#endif

#endif /* __dll_import */


#if defined(LIBMDBX_INTERNALS) && !defined(LIBMDBX_NO_EXPORTS_LEGACY_API)

#define LIBMDBX_INLINE_API(TYPE, NAME, ARGS)                                                                           \

  /* proto of exported which uses common impl */ LIBMDBX_API TYPE NAME ARGS;                                           \

  /* definition of common impl */ static __inline TYPE __inline_##NAME ARGS

#else

#define LIBMDBX_INLINE_API(TYPE, NAME, ARGS) static __inline TYPE NAME ARGS

#endif /* LIBMDBX_INLINE_API */


#ifndef MDBX_STRINGIFY

#define MDBX_STRINGIFY_HELPER(x) #x

#define MDBX_STRINGIFY(x) MDBX_STRINGIFY_HELPER(x)

#endif /* MDBX_STRINGIFY */


/*----------------------------------------------------------------------------*/


#ifndef __cplusplus

#ifndef bool

#define bool _Bool

#endif

#ifndef true

#define true (1)

#endif

#ifndef false

#define false (0)

#endif

#endif /* bool without __cplusplus */


#if defined(DOXYGEN)

#define MDBX_CXX17_NOEXCEPT noexcept

#elif !defined(__cpp_noexcept_function_type) || __cpp_noexcept_function_type < 201510L

#define MDBX_CXX17_NOEXCEPT

#else

#define MDBX_CXX17_NOEXCEPT noexcept

#endif /* MDBX_CXX17_NOEXCEPT */


#if defined(DOXYGEN)

#define MDBX_CXX01_CONSTEXPR constexpr

#define MDBX_CXX01_CONSTEXPR_VAR constexpr

#elif !defined(__cplusplus)

#define MDBX_CXX01_CONSTEXPR __inline

#define MDBX_CXX01_CONSTEXPR_VAR const

#elif !defined(DOXYGEN) &&                                                                                             \

    ((__cplusplus < 201103L && defined(__cpp_constexpr) && __cpp_constexpr < 200704L) ||                               \

     (defined(__LCC__) && __LCC__ < 124) ||                                                                            \

     (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ < 407) && !defined(__clang__) && !defined(__LCC__)) ||     \

     (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__clang__) && __clang_major__ < 4))

#define MDBX_CXX01_CONSTEXPR inline

#define MDBX_CXX01_CONSTEXPR_VAR const

#else

#define MDBX_CXX01_CONSTEXPR constexpr

#define MDBX_CXX01_CONSTEXPR_VAR constexpr

#endif /* MDBX_CXX01_CONSTEXPR */


#if defined(DOXYGEN)

#define MDBX_CXX11_CONSTEXPR constexpr

#define MDBX_CXX11_CONSTEXPR_VAR constexpr

#elif !defined(__cplusplus)

#define MDBX_CXX11_CONSTEXPR __inline

#define MDBX_CXX11_CONSTEXPR_VAR const

#elif !defined(DOXYGEN) &&                                                                                             \

    (!defined(__cpp_constexpr) || __cpp_constexpr < 201304L || (defined(__LCC__) && __LCC__ < 124) ||                  \

     (defined(__GNUC__) && __GNUC__ < 6 && !defined(__clang__) && !defined(__LCC__)) ||                                \

     (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__clang__) && __clang_major__ < 5))

#define MDBX_CXX11_CONSTEXPR inline

#define MDBX_CXX11_CONSTEXPR_VAR const

#else

#define MDBX_CXX11_CONSTEXPR constexpr

#define MDBX_CXX11_CONSTEXPR_VAR constexpr

#endif /* MDBX_CXX11_CONSTEXPR */


#if defined(DOXYGEN)

#define MDBX_CXX14_CONSTEXPR constexpr

#define MDBX_CXX14_CONSTEXPR_VAR constexpr

#elif !defined(__cplusplus)

#define MDBX_CXX14_CONSTEXPR __inline

#define MDBX_CXX14_CONSTEXPR_VAR const

#elif defined(DOXYGEN) ||                                                                                              \

    defined(__cpp_constexpr) && __cpp_constexpr >= 201304L &&                                                          \

        ((defined(_MSC_VER) && _MSC_VER >= 1910) || (defined(__clang__) && __clang_major__ > 4) ||                     \

         (defined(__GNUC__) && __GNUC__ > 6) || (!defined(__GNUC__) && !defined(__clang__) && !defined(_MSC_VER)))

#define MDBX_CXX14_CONSTEXPR constexpr

#define MDBX_CXX14_CONSTEXPR_VAR constexpr

#else

#define MDBX_CXX14_CONSTEXPR inline

#define MDBX_CXX14_CONSTEXPR_VAR const

#endif /* MDBX_CXX14_CONSTEXPR */


#if defined(__noreturn)

#define MDBX_NORETURN __noreturn

#elif defined(_Noreturn)

#define MDBX_NORETURN _Noreturn

#elif defined(DOXYGEN) || (defined(__cplusplus) && __cplusplus >= 201103L) ||                                          \

    (!defined(__cplusplus) && defined(__STDC_VERSION__) && __STDC_VERSION__ > 202005L)

#define MDBX_NORETURN [[noreturn]]

#elif defined(__GNUC__) || __has_attribute(__noreturn__)

#define MDBX_NORETURN __attribute__((__noreturn__))

#elif defined(_MSC_VER) && !defined(__clang__)

#define MDBX_NORETURN __declspec(noreturn)

#else

#define MDBX_NORETURN

#endif /* MDBX_NORETURN */


#ifndef MDBX_PRINTF_ARGS

#if defined(__GNUC__) || __has_attribute(__format__) || defined(DOXYGEN)

#if defined(__MINGW__) || defined(__MINGW32__) || defined(__MINGW64__)

#define MDBX_PRINTF_ARGS(format_index, first_arg) __attribute__((__format__(__gnu_printf__, format_index, first_arg)))

#else

#define MDBX_PRINTF_ARGS(format_index, first_arg) __attribute__((__format__(__printf__, format_index, first_arg)))

#endif /* MinGW */

#else

#define MDBX_PRINTF_ARGS(format_index, first_arg)

#endif

#endif /* MDBX_PRINTF_ARGS */


#if defined(DOXYGEN) ||                                                                                                \

    (defined(__cplusplus) && __cplusplus >= 201603L && __has_cpp_attribute(maybe_unused) &&                            \

     __has_cpp_attribute(maybe_unused) >= 201603L && (!defined(__clang__) || __clang__ > 19)) ||                       \

    (!defined(__cplusplus) && defined(__STDC_VERSION__) && __STDC_VERSION__ > 202005L)

#define MDBX_MAYBE_UNUSED [[maybe_unused]]

#elif defined(__GNUC__) || __has_attribute(__unused__)

#define MDBX_MAYBE_UNUSED __attribute__((__unused__))

#else

#define MDBX_MAYBE_UNUSED

#endif /* MDBX_MAYBE_UNUSED */


#if __has_attribute(no_sanitize) || defined(DOXYGEN)

#define MDBX_NOSANITIZE_ENUM __attribute((__no_sanitize__("enum")))

#else

#define MDBX_NOSANITIZE_ENUM

#endif /* MDBX_NOSANITIZE_ENUM */


/* Oh, below are some songs and dances since:

 *  - C++ requires explicit definition of the necessary operators.

 *  - the proper implementation of DEFINE_ENUM_FLAG_OPERATORS for C++ required

 *    the constexpr feature which is broken in most old compilers;

 *  - DEFINE_ENUM_FLAG_OPERATORS may be defined broken as in the Windows SDK. */

#if !defined(DEFINE_ENUM_FLAG_OPERATORS) && !defined(DOXYGEN)


#ifdef __cplusplus

#if !defined(__cpp_constexpr) || __cpp_constexpr < 200704L || (defined(__LCC__) && __LCC__ < 124) ||                   \

    (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ < 407) && !defined(__clang__) && !defined(__LCC__)) ||      \

    (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__clang__) && __clang_major__ < 4)

/* The constexpr feature is not available or (may be) broken */

#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 0

#else

/* C always allows these operators for enums */

#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 1

#endif /* __cpp_constexpr */


#define DEFINE_ENUM_FLAG_OPERATORS(ENUM)                                                                               \

  extern "C++" {                                                                                                       \

  MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator|(ENUM a, ENUM b) { return ENUM(unsigned(a) | unsigned(b)); } \

  MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator|=(ENUM &a, ENUM b) { return a = a | b; }                    \

  MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator&(ENUM a, ENUM b) { return ENUM(unsigned(a) & unsigned(b)); } \

  MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator&(ENUM a, unsigned b) { return ENUM(unsigned(a) & b); }       \

  MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator&(unsigned a, ENUM b) { return ENUM(a & unsigned(b)); }       \

  MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator&=(ENUM &a, ENUM b) { return a = a & b; }                    \

  MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator&=(ENUM &a, unsigned b) { return a = a & b; }                \

  MDBX_CXX01_CONSTEXPR unsigned operator~(ENUM a) { return ~unsigned(a); }                                             \

  MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator^(ENUM a, ENUM b) { return ENUM(unsigned(a) ^ unsigned(b)); } \

  MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator^=(ENUM &a, ENUM b) { return a = a ^ b; }                    \

  }

#else /* __cplusplus */

/* nope for C since it always allows these operators for enums */

#define DEFINE_ENUM_FLAG_OPERATORS(ENUM)

#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 1

#endif /* !__cplusplus */


#elif !defined(CONSTEXPR_ENUM_FLAGS_OPERATIONS)


#ifdef __cplusplus

/* DEFINE_ENUM_FLAG_OPERATORS may be defined broken as in the Windows SDK */

#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 0

#else

/* C always allows these operators for enums */

#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 1

#endif


#endif /* DEFINE_ENUM_FLAG_OPERATORS */


/*----------------------------------------------------------------------------*/


#ifdef __cplusplus

extern "C" {

#endif


/* MDBX version 0.14.x, but it is unstable/under-development yet. */

#define MDBX_VERSION_UNSTABLE

#define MDBX_VERSION_MAJOR 0

#define MDBX_VERSION_MINOR 14


#ifndef LIBMDBX_API

#if defined(LIBMDBX_EXPORTS) || defined(DOXYGEN)

#define LIBMDBX_API __dll_export

#elif defined(LIBMDBX_IMPORTS)

#define LIBMDBX_API __dll_import

#else

#define LIBMDBX_API

#endif

#endif /* LIBMDBX_API */


#ifdef __cplusplus

#if defined(__clang__) || __has_attribute(type_visibility) || defined(DOXYGEN)

#define LIBMDBX_API_TYPE LIBMDBX_API __attribute__((type_visibility("default")))

#else

#define LIBMDBX_API_TYPE LIBMDBX_API

#endif

#else

#define LIBMDBX_API_TYPE

#endif /* LIBMDBX_API_TYPE */


#if defined(LIBMDBX_IMPORTS)

#define LIBMDBX_VERINFO_API __dll_import

#else

#define LIBMDBX_VERINFO_API __dll_export

#endif /* LIBMDBX_VERINFO_API */


extern LIBMDBX_VERINFO_API const struct MDBX_version_info {

  uint16_t major;

  uint16_t minor;

  uint16_t patch;

  uint16_t tweak;

  const char *semver_prerelease;


  struct {

    const char *datetime;

    const char *tree;

    const char *commit;

    const char *describe;

  } git;


  const char *sourcery;

}  mdbx_version;


extern LIBMDBX_VERINFO_API const struct MDBX_build_info {

  const char *datetime;

  const char *target;

  const char *options;

  const char *compiler;

  const char *flags;

  const char *metadata;

}  mdbx_build;


#if (defined(_WIN32) || defined(_WIN64)) && !MDBX_BUILD_SHARED_LIBRARY

/* MDBX internally uses global and thread local storage destructors to

 * automatically (de)initialization, releasing reader lock table slots

 * and so on.

 *

 * If MDBX built as a DLL this is done out-of-the-box by DllEntry() function,

 * which called automatically by Windows core with passing corresponding reason

 * argument.

 *

 * Otherwise, if MDBX was built not as a DLL, some black magic

 * may be required depending of Windows version:

 *

 *  - Modern Windows versions, including Windows Vista and later, provides

 *    support for "TLS Directory" (e.g .CRT$XL[A-Z] sections in executable

 *    or dll file). In this case, MDBX capable of doing all automatically,

 *    therefore you DON'T NEED to call mdbx_module_handler()

 *    so the MDBX_MANUAL_MODULE_HANDLER defined as 0.

 *

 *  - Obsolete versions of Windows, prior to Windows Vista, REQUIRES calling

 *    mdbx_module_handler() manually from corresponding DllMain() or WinMain()

 *    of your DLL or application,

 *    so the MDBX_MANUAL_MODULE_HANDLER defined as 1.

 *

 * Therefore, building MDBX as a DLL is recommended for all version of Windows.

 * So, if you doubt, just build MDBX as the separate DLL and don't care about

 * the MDBX_MANUAL_MODULE_HANDLER. */


#ifndef _WIN32_WINNT

#error Non-dll build libmdbx requires target Windows version \

  to be explicitly defined via _WIN32_WINNT for properly \

  handling thread local storage destructors.

#endif /* _WIN32_WINNT */


#if _WIN32_WINNT >= 0x0600 /* Windows Vista */

/* As described above mdbx_module_handler() is NOT needed for Windows Vista

 * and later. */

#define MDBX_MANUAL_MODULE_HANDLER 0

#else

/* As described above mdbx_module_handler() IS REQUIRED for Windows versions

 * prior to Windows Vista. */

#define MDBX_MANUAL_MODULE_HANDLER 1

void LIBMDBX_API NTAPI mdbx_module_handler(PVOID module, DWORD reason, PVOID reserved);

#endif


#endif /* Windows && !DLL && MDBX_MANUAL_MODULE_HANDLER */


/* OPACITY STRUCTURES *********************************************************/


#ifndef __cplusplus

typedef struct MDBX_env MDBX_env;

#else

struct MDBX_env;

#endif


#ifndef __cplusplus

typedef struct MDBX_txn MDBX_txn;

#else

struct MDBX_txn;

#endif


typedef uint32_t MDBX_dbi;


#ifndef __cplusplus

typedef struct MDBX_cursor MDBX_cursor;

#else

struct MDBX_cursor;

#endif


#ifndef HAVE_STRUCT_IOVEC

struct iovec {

  void *iov_base;

  size_t iov_len;

};

#define HAVE_STRUCT_IOVEC

#endif /* HAVE_STRUCT_IOVEC */


#if defined(__sun) || defined(__SVR4) || defined(__svr4__)

/* The `iov_len` is signed on Sun/Solaris.

 * So define custom MDBX_val to avoid a lot of warnings. */

struct MDBX_val {

  void *iov_base;

  size_t iov_len;

};

#ifndef __cplusplus

typedef struct MDBX_val MDBX_val;

#endif

#else  /* SunOS */

typedef struct iovec MDBX_val;

#endif /* ! SunOS */


enum MDBX_constants {

  MDBX_MAX_DBI = UINT32_C(32765),


  MDBX_MAXDATASIZE = UINT32_C(0x7fff0000),


  MDBX_MIN_PAGESIZE = 256,


  MDBX_MAX_PAGESIZE = 65536,

};


/* THE FILES *******************************************************************

 * At the file system level, the environment corresponds to a pair of files. */


#ifndef MDBX_LOCKNAME

#if !(defined(_WIN32) || defined(_WIN64))

#define MDBX_LOCKNAME "/mdbx.lck"

#else

#define MDBX_LOCKNAME_W L"\\mdbx.lck"

#define MDBX_LOCKNAME_A "\\mdbx.lck"

#ifdef UNICODE

#define MDBX_LOCKNAME MDBX_LOCKNAME_W

#else

#define MDBX_LOCKNAME MDBX_LOCKNAME_A

#endif /* UNICODE */

#endif /* Windows */

#endif /* MDBX_LOCKNAME */

#ifndef MDBX_DATANAME

#if !(defined(_WIN32) || defined(_WIN64))

#define MDBX_DATANAME "/mdbx.dat"

#else

#define MDBX_DATANAME_W L"\\mdbx.dat"

#define MDBX_DATANAME_A "\\mdbx.dat"

#ifdef UNICODE

#define MDBX_DATANAME MDBX_DATANAME_W

#else

#define MDBX_DATANAME MDBX_DATANAME_A

#endif /* UNICODE */

#endif /* Windows */

#endif /* MDBX_DATANAME */


#ifndef MDBX_LOCK_SUFFIX

#if !(defined(_WIN32) || defined(_WIN64))

#define MDBX_LOCK_SUFFIX "-lck"

#else

#define MDBX_LOCK_SUFFIX_W L"-lck"

#define MDBX_LOCK_SUFFIX_A "-lck"

#ifdef UNICODE

#define MDBX_LOCK_SUFFIX MDBX_LOCK_SUFFIX_W

#else

#define MDBX_LOCK_SUFFIX MDBX_LOCK_SUFFIX_A

#endif /* UNICODE */

#endif /* Windows */

#endif /* MDBX_LOCK_SUFFIX */


/* DEBUG & LOGGING ************************************************************/


typedef enum MDBX_log_level {

  MDBX_LOG_FATAL = 0,


  MDBX_LOG_ERROR = 1,


  MDBX_LOG_WARN = 2,


  MDBX_LOG_NOTICE = 3,


  MDBX_LOG_VERBOSE = 4,


  MDBX_LOG_DEBUG = 5,


  MDBX_LOG_TRACE = 6,


  MDBX_LOG_EXTRA = 7,


#ifdef ENABLE_UBSAN

  MDBX_LOG_MAX = 7 /* avoid UBSAN false-positive trap by a tests */,

#endif /* ENABLE_UBSAN */


  MDBX_LOG_DONTCHANGE = -1

} MDBX_log_level_t;


typedef enum MDBX_debug_flags {

  MDBX_DBG_NONE = 0,


  MDBX_DBG_ASSERT = 1,


  MDBX_DBG_AUDIT = 2,


  MDBX_DBG_JITTER = 4,


  MDBX_DBG_DUMP = 8,


  MDBX_DBG_LEGACY_MULTIOPEN = 16,


  MDBX_DBG_LEGACY_OVERLAP = 32,


  MDBX_DBG_DONT_UPGRADE = 64,


#ifdef ENABLE_UBSAN

  MDBX_DBG_MAX = ((unsigned)MDBX_LOG_MAX) << 16 | 127 /* avoid UBSAN false-positive trap by a tests */,

#endif /* ENABLE_UBSAN */


  MDBX_DBG_DONTCHANGE = -1

} MDBX_debug_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_debug_flags)


typedef void MDBX_debug_func(MDBX_log_level_t loglevel, const char *function, int line, const char *fmt,

                             va_list args) MDBX_CXX17_NOEXCEPT;


#define MDBX_LOGGER_DONTCHANGE ((MDBX_debug_func *)(intptr_t)-1)

#define MDBX_LOGGER_NOFMT_DONTCHANGE ((MDBX_debug_func_nofmt *)(intptr_t)-1)


LIBMDBX_API int mdbx_setup_debug(MDBX_log_level_t log_level, MDBX_debug_flags_t debug_flags, MDBX_debug_func *logger);


typedef void MDBX_debug_func_nofmt(MDBX_log_level_t loglevel, const char *function, int line, const char *msg,

                                   unsigned length) MDBX_CXX17_NOEXCEPT;


LIBMDBX_API int mdbx_setup_debug_nofmt(MDBX_log_level_t log_level, MDBX_debug_flags_t debug_flags,

                                       MDBX_debug_func_nofmt *logger, char *logger_buffer, size_t logger_buffer_size);


typedef void MDBX_assert_func(const MDBX_env *env, const char *msg, const char *function,

                              unsigned line) MDBX_CXX17_NOEXCEPT;


LIBMDBX_API int mdbx_env_set_assert(MDBX_env *env, MDBX_assert_func *func);


LIBMDBX_API const char *mdbx_dump_val(const MDBX_val *key, char *const buf, const size_t bufsize);


MDBX_NORETURN LIBMDBX_API void mdbx_panic(const char *fmt, ...) MDBX_PRINTF_ARGS(1, 2);


#if !((defined(_WIN32) || defined(_WIN64)) && !MDBX_WITHOUT_MSVC_CRT)

MDBX_NORETURN

#endif /* MDBX_WITHOUT_MSVC_CRT */

LIBMDBX_API void mdbx_assert_fail(const MDBX_env *env, const char *msg, const char *func, unsigned line);


typedef enum MDBX_env_flags {

  MDBX_ENV_DEFAULTS = 0,


  MDBX_VALIDATION = UINT32_C(0x00002000),


  MDBX_NOSUBDIR = UINT32_C(0x4000),


  MDBX_RDONLY = UINT32_C(0x20000),


  MDBX_EXCLUSIVE = UINT32_C(0x400000),


  MDBX_ACCEDE = UINT32_C(0x40000000),


  MDBX_WRITEMAP = UINT32_C(0x80000),


  MDBX_NOSTICKYTHREADS = UINT32_C(0x200000),


  MDBX_NOTLS MDBX_DEPRECATED_ENUM = MDBX_NOSTICKYTHREADS,


  MDBX_NORDAHEAD = UINT32_C(0x800000),


  MDBX_NOMEMINIT = UINT32_C(0x1000000),


  MDBX_COALESCE MDBX_DEPRECATED_ENUM = UINT32_C(0x2000000),


  MDBX_LIFORECLAIM = UINT32_C(0x4000000),


  MDBX_PAGEPERTURB = UINT32_C(0x8000000),


  /* SYNC MODES****************************************************************/


  MDBX_SYNC_DURABLE = 0,


  MDBX_NOMETASYNC = UINT32_C(0x40000),


  MDBX_SAFE_NOSYNC = UINT32_C(0x10000),


  MDBX_MAPASYNC = MDBX_SAFE_NOSYNC,


  MDBX_UTTERLY_NOSYNC = MDBX_SAFE_NOSYNC | UINT32_C(0x100000),


} MDBX_env_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_env_flags)


typedef enum MDBX_txn_flags {

  MDBX_TXN_READWRITE = 0,


  MDBX_TXN_RDONLY = MDBX_RDONLY,


#if CONSTEXPR_ENUM_FLAGS_OPERATIONS || defined(DOXYGEN)

  MDBX_TXN_RDONLY_PREPARE = MDBX_RDONLY | MDBX_NOMEMINIT,

#else

  MDBX_TXN_RDONLY_PREPARE = uint32_t(MDBX_RDONLY) | uint32_t(MDBX_NOMEMINIT),

#endif


  MDBX_TXN_TRY = UINT32_C(0x10000000),


  MDBX_TXN_NOWEAKING = 0,


  MDBX_TXN_NOMETASYNC = MDBX_NOMETASYNC,


  MDBX_TXN_NOSYNC = MDBX_SAFE_NOSYNC,


  /* Transaction state flags ---------------------------------------------- */


  MDBX_TXN_INVALID = INT32_MIN,


  MDBX_TXN_FINISHED = 0x01,


  MDBX_TXN_ERROR = 0x02,


  MDBX_TXN_DIRTY = 0x04,


  MDBX_TXN_SPILLS = 0x08,


  MDBX_TXN_HAS_CHILD = 0x10,


  MDBX_TXN_PARKED = 0x20,


  MDBX_TXN_AUTOUNPARK = 0x40,


  MDBX_TXN_OUSTED = 0x80,


  MDBX_TXN_BLOCKED = MDBX_TXN_FINISHED | MDBX_TXN_ERROR | MDBX_TXN_HAS_CHILD | MDBX_TXN_PARKED

} MDBX_txn_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_txn_flags)


typedef enum MDBX_db_flags {

  MDBX_DB_DEFAULTS = 0,


  MDBX_REVERSEKEY = UINT32_C(0x02),


  MDBX_DUPSORT = UINT32_C(0x04),


  MDBX_INTEGERKEY = UINT32_C(0x08),


  MDBX_DUPFIXED = UINT32_C(0x10),


  MDBX_INTEGERDUP = UINT32_C(0x20),


  MDBX_REVERSEDUP = UINT32_C(0x40),


  MDBX_CREATE = UINT32_C(0x40000),


  MDBX_DB_ACCEDE = MDBX_ACCEDE

} MDBX_db_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_db_flags)


typedef enum MDBX_put_flags {

  MDBX_UPSERT = 0,


  MDBX_NOOVERWRITE = UINT32_C(0x10),


  MDBX_NODUPDATA = UINT32_C(0x20),


  MDBX_CURRENT = UINT32_C(0x40),


  MDBX_ALLDUPS = UINT32_C(0x80),


  MDBX_RESERVE = UINT32_C(0x10000),


  MDBX_APPEND = UINT32_C(0x20000),


  MDBX_APPENDDUP = UINT32_C(0x40000),


  MDBX_MULTIPLE = UINT32_C(0x80000)

} MDBX_put_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_put_flags)


typedef enum MDBX_copy_flags {

  MDBX_CP_DEFAULTS = 0,


  MDBX_CP_COMPACT = 1u,


  MDBX_CP_FORCE_DYNAMIC_SIZE = 2u,


  MDBX_CP_DONT_FLUSH = 4u,


  MDBX_CP_THROTTLE_MVCC = 8u,


  MDBX_CP_DISPOSE_TXN = 16u,


  MDBX_CP_RENEW_TXN = 32u,


  MDBX_CP_OVERWRITE = 64u


} MDBX_copy_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_copy_flags)


typedef enum MDBX_cursor_op {

  MDBX_FIRST,


  MDBX_FIRST_DUP,


  MDBX_GET_BOTH,


  MDBX_GET_BOTH_RANGE,


  MDBX_GET_CURRENT,


  MDBX_GET_MULTIPLE,


  MDBX_LAST,


  MDBX_LAST_DUP,


  MDBX_NEXT,


  MDBX_NEXT_DUP,


  MDBX_NEXT_MULTIPLE,


  MDBX_NEXT_NODUP,


  MDBX_PREV,


  MDBX_PREV_DUP,


  MDBX_PREV_NODUP,


  MDBX_SET,


  MDBX_SET_KEY,


  MDBX_SET_RANGE,


  MDBX_PREV_MULTIPLE,


  MDBX_SET_LOWERBOUND,


  MDBX_SET_UPPERBOUND,


  MDBX_TO_KEY_LESSER_THAN,

  MDBX_TO_KEY_LESSER_OR_EQUAL ,

  MDBX_TO_KEY_EQUAL ,

  MDBX_TO_KEY_GREATER_OR_EQUAL ,

  MDBX_TO_KEY_GREATER_THAN ,


  MDBX_TO_EXACT_KEY_VALUE_LESSER_THAN,

  MDBX_TO_EXACT_KEY_VALUE_LESSER_OR_EQUAL ,

  MDBX_TO_EXACT_KEY_VALUE_EQUAL ,

  MDBX_TO_EXACT_KEY_VALUE_GREATER_OR_EQUAL ,

  MDBX_TO_EXACT_KEY_VALUE_GREATER_THAN ,


  MDBX_TO_PAIR_LESSER_THAN,

  MDBX_TO_PAIR_LESSER_OR_EQUAL ,

  MDBX_TO_PAIR_EQUAL ,

  MDBX_TO_PAIR_GREATER_OR_EQUAL ,

  MDBX_TO_PAIR_GREATER_THAN ,


  MDBX_SEEK_AND_GET_MULTIPLE

} MDBX_cursor_op;


typedef enum MDBX_error {

  MDBX_SUCCESS = 0,


  MDBX_RESULT_FALSE = MDBX_SUCCESS,


  MDBX_RESULT_TRUE = -1,


  MDBX_KEYEXIST = -30799,


  MDBX_FIRST_LMDB_ERRCODE = MDBX_KEYEXIST,


  MDBX_NOTFOUND = -30798,


  MDBX_PAGE_NOTFOUND = -30797,


  MDBX_CORRUPTED = -30796,


  MDBX_PANIC = -30795,


  MDBX_VERSION_MISMATCH = -30794,


  MDBX_INVALID = -30793,


  MDBX_MAP_FULL = -30792,


  MDBX_DBS_FULL = -30791,


  MDBX_READERS_FULL = -30790,


  MDBX_TXN_FULL = -30788,


  MDBX_CURSOR_FULL = -30787,


  MDBX_PAGE_FULL = -30786,


  MDBX_UNABLE_EXTEND_MAPSIZE = -30785,


  MDBX_INCOMPATIBLE = -30784,


  MDBX_BAD_RSLOT = -30783,


  MDBX_BAD_TXN = -30782,


  MDBX_BAD_VALSIZE = -30781,


  MDBX_BAD_DBI = -30780,


  MDBX_PROBLEM = -30779,


  MDBX_LAST_LMDB_ERRCODE = MDBX_PROBLEM,


  MDBX_BUSY = -30778,


  MDBX_FIRST_ADDED_ERRCODE = MDBX_BUSY,


  MDBX_EMULTIVAL = -30421,


  MDBX_EBADSIGN = -30420,


  MDBX_WANNA_RECOVERY = -30419,


  MDBX_EKEYMISMATCH = -30418,


  MDBX_TOO_LARGE = -30417,


  MDBX_THREAD_MISMATCH = -30416,


  MDBX_TXN_OVERLAPPING = -30415,


  MDBX_BACKLOG_DEPLETED = -30414,


  MDBX_DUPLICATED_CLK = -30413,


  MDBX_DANGLING_DBI = -30412,


  MDBX_OUSTED = -30411,


  MDBX_MVCC_RETARDED = -30410,


  MDBX_LAGGARD_READER = -30409,


  /* The last of MDBX-added error codes */

  MDBX_LAST_ADDED_ERRCODE = MDBX_LAGGARD_READER,


#if defined(_WIN32) || defined(_WIN64)

  MDBX_ENODATA = ERROR_HANDLE_EOF,

  MDBX_EINVAL = ERROR_INVALID_PARAMETER,

  MDBX_EACCESS = ERROR_ACCESS_DENIED,

  MDBX_ENOMEM = ERROR_OUTOFMEMORY,

  MDBX_EROFS = ERROR_FILE_READ_ONLY,

  MDBX_ENOSYS = ERROR_NOT_SUPPORTED,

  MDBX_EIO = ERROR_WRITE_FAULT,

  MDBX_EPERM = ERROR_INVALID_FUNCTION,

  MDBX_EINTR = ERROR_CANCELLED,

  MDBX_ENOFILE = ERROR_FILE_NOT_FOUND,

  MDBX_EREMOTE = ERROR_REMOTE_STORAGE_MEDIA_ERROR,

  MDBX_EDEADLK = ERROR_POSSIBLE_DEADLOCK

#else /* Windows */

#if defined(ENODATA) || defined(DOXYGEN)

  MDBX_ENODATA = ENODATA,

#else

  MDBX_ENODATA = 9919 /* for compatibility with LLVM's C++ libraries/headers */,

#endif /* ENODATA */

  MDBX_EINVAL = EINVAL,

  MDBX_EACCESS = EACCES,

  MDBX_ENOMEM = ENOMEM,

  MDBX_EROFS = EROFS,

#if defined(ENOTSUP) || defined(DOXYGEN)

  MDBX_ENOSYS = ENOTSUP,

#else

  MDBX_ENOSYS = ENOSYS,

#endif /* ENOTSUP */

  MDBX_EIO = EIO,

  MDBX_EPERM = EPERM,

  MDBX_EINTR = EINTR,

  MDBX_ENOFILE = ENOENT,

#if defined(EREMOTEIO) || defined(DOXYGEN)

  MDBX_EREMOTE = EREMOTEIO,

#else

  MDBX_EREMOTE = ENOTBLK,

#endif /* EREMOTEIO */

  MDBX_EDEADLK = EDEADLK

#endif /* !Windows */

} MDBX_error_t;


MDBX_DEPRECATED static __inline int MDBX_MAP_RESIZED_is_deprecated(void) { return MDBX_UNABLE_EXTEND_MAPSIZE; }

#define MDBX_MAP_RESIZED MDBX_MAP_RESIZED_is_deprecated()


LIBMDBX_API const char *mdbx_strerror(int errnum);


LIBMDBX_API const char *mdbx_strerror_r(int errnum, char *buf, size_t buflen);

MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API const char *mdbx_liberr2str(int errnum);


#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)

LIBMDBX_API const char *mdbx_strerror_ANSI2OEM(int errnum);


LIBMDBX_API const char *mdbx_strerror_r_ANSI2OEM(int errnum, char *buf, size_t buflen);

#endif /* Bit of Windows' madness */


LIBMDBX_API int mdbx_env_create(MDBX_env **penv);


typedef enum MDBX_option {

  MDBX_opt_max_db,


  MDBX_opt_max_readers,


  MDBX_opt_sync_bytes,


  MDBX_opt_sync_period,


  MDBX_opt_rp_augment_limit,


  MDBX_opt_loose_limit,


  MDBX_opt_dp_reserve_limit,


  MDBX_opt_txn_dp_limit,


  MDBX_opt_txn_dp_initial,


  MDBX_opt_spill_max_denominator,


  MDBX_opt_spill_min_denominator,


  MDBX_opt_spill_parent4child_denominator,


  MDBX_opt_merge_threshold_16dot16_percent,


  MDBX_opt_writethrough_threshold,


  MDBX_opt_prefault_write_enable,


  MDBX_opt_gc_time_limit,


  MDBX_opt_prefer_waf_insteadof_balance,


  MDBX_opt_subpage_limit,


  MDBX_opt_subpage_room_threshold,


  MDBX_opt_subpage_reserve_prereq,


  MDBX_opt_subpage_reserve_limit

} MDBX_option_t;


LIBMDBX_API int mdbx_env_set_option(MDBX_env *env, const MDBX_option_t option, uint64_t value);


LIBMDBX_API int mdbx_env_get_option(const MDBX_env *env, const MDBX_option_t option, uint64_t *pvalue);


LIBMDBX_API int mdbx_env_open(MDBX_env *env, const char *pathname, MDBX_env_flags_t flags, mdbx_mode_t mode);


#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)

LIBMDBX_API int mdbx_env_openW(MDBX_env *env, const wchar_t *pathname, MDBX_env_flags_t flags, mdbx_mode_t mode);

#define mdbx_env_openT(env, pathname, flags, mode) mdbx_env_openW(env, pathname, flags, mode)

#else

#define mdbx_env_openT(env, pathname, flags, mode) mdbx_env_open(env, pathname, flags, mode)

#endif /* Windows */


typedef enum MDBX_env_delete_mode {

  MDBX_ENV_JUST_DELETE = 0,

  MDBX_ENV_ENSURE_UNUSED = 1,

  MDBX_ENV_WAIT_FOR_UNUSED = 2,

} MDBX_env_delete_mode_t;


LIBMDBX_API int mdbx_env_delete(const char *pathname, MDBX_env_delete_mode_t mode);


#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)

LIBMDBX_API int mdbx_env_deleteW(const wchar_t *pathname, MDBX_env_delete_mode_t mode);

#define mdbx_env_deleteT(pathname, mode) mdbx_env_deleteW(pathname, mode)

#else

#define mdbx_env_deleteT(pathname, mode) mdbx_env_delete(pathname, mode)

#endif /* Windows */


LIBMDBX_API int mdbx_env_copy(MDBX_env *env, const char *dest, MDBX_copy_flags_t flags);


LIBMDBX_API int mdbx_txn_copy2pathname(MDBX_txn *txn, const char *dest, MDBX_copy_flags_t flags);


#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)

LIBMDBX_API int mdbx_env_copyW(MDBX_env *env, const wchar_t *dest, MDBX_copy_flags_t flags);

#define mdbx_env_copyT(env, dest, flags) mdbx_env_copyW(env, dest, flags)


LIBMDBX_API int mdbx_txn_copy2pathnameW(MDBX_txn *txn, const wchar_t *dest, MDBX_copy_flags_t flags);

#define mdbx_txn_copy2pathnameT(txn, dest, flags) mdbx_txn_copy2pathnameW(txn, dest, path)

#else

#define mdbx_env_copyT(env, dest, flags) mdbx_env_copy(env, dest, flags)

#define mdbx_txn_copy2pathnameT(txn, dest, flags) mdbx_txn_copy2pathname(txn, dest, path)

#endif /* Windows */


LIBMDBX_API int mdbx_env_copy2fd(MDBX_env *env, mdbx_filehandle_t fd, MDBX_copy_flags_t flags);


LIBMDBX_API int mdbx_txn_copy2fd(MDBX_txn *txn, mdbx_filehandle_t fd, MDBX_copy_flags_t flags);


struct MDBX_stat {

  uint32_t ms_psize;

  uint32_t ms_depth;

  uint64_t ms_branch_pages;

  uint64_t ms_leaf_pages;

  uint64_t ms_overflow_pages;

  uint64_t ms_entries;

  uint64_t ms_mod_txnid;

};


#ifndef __cplusplus

typedef struct MDBX_stat MDBX_stat;

#endif


LIBMDBX_API int mdbx_env_stat_ex(const MDBX_env *env, const MDBX_txn *txn, MDBX_stat *stat, size_t bytes);


MDBX_DEPRECATED inline int mdbx_env_stat(const MDBX_env *env, MDBX_stat *stat, size_t bytes) {

  return mdbx_env_stat_ex(env, NULL, stat, bytes);

}


struct MDBX_envinfo {


  struct {

    uint64_t lower;

    uint64_t upper;

    uint64_t current;

    uint64_t shrink;

    uint64_t grow;

  } mi_geo;


  uint64_t mi_mapsize;

  uint64_t mi_dxb_fsize;

  uint64_t mi_dxb_fallocated;

  uint64_t mi_last_pgno;

  uint64_t mi_recent_txnid;

  uint64_t mi_latter_reader_txnid;

  uint64_t mi_self_latter_reader_txnid;

  uint64_t mi_meta_txnid[3], mi_meta_sign[3];

  uint32_t mi_maxreaders;

  uint32_t mi_numreaders;

  uint32_t mi_dxb_pagesize;

  uint32_t mi_sys_pagesize;

  uint32_t mi_sys_upcblk;

  uint32_t mi_sys_ioblk;


  struct {


    struct {

      uint64_t x, y;

    } current, meta[3];


  } mi_bootid;


  uint64_t mi_unsync_volume;

  uint64_t mi_autosync_threshold;

  uint32_t mi_since_sync_seconds16dot16;

  uint32_t mi_autosync_period_seconds16dot16;

  uint32_t mi_since_reader_check_seconds16dot16;

  uint32_t mi_mode;


  struct {

    uint64_t newly;

    uint64_t cow;

    uint64_t clone;

    uint64_t split;

    uint64_t merge;

    uint64_t spill;

    uint64_t unspill;

    uint64_t wops;

    uint64_t prefault;

    uint64_t mincore;

    uint64_t msync;

    uint64_t fsync;

  } mi_pgop_stat;


  /* GUID of the database DXB file. */


  struct {

    uint64_t x, y;

  } mi_dxbid;


};


#ifndef __cplusplus

typedef struct MDBX_envinfo MDBX_envinfo;

#endif


LIBMDBX_API int mdbx_env_info_ex(const MDBX_env *env, const MDBX_txn *txn, MDBX_envinfo *info, size_t bytes);


MDBX_DEPRECATED inline int mdbx_env_info(const MDBX_env *env, MDBX_envinfo *info, size_t bytes) {

  return mdbx_env_info_ex(env, NULL, info, bytes);

}


LIBMDBX_API int mdbx_env_sync_ex(MDBX_env *env, bool force, bool nonblock);


inline int mdbx_env_sync(MDBX_env * env) { return mdbx_env_sync_ex(env, true, false); }


inline int mdbx_env_sync_poll(MDBX_env * env) { return mdbx_env_sync_ex(env, false, true); }


inline int mdbx_env_set_syncbytes(MDBX_env * env, size_t threshold) {

  return mdbx_env_set_option(env, MDBX_opt_sync_bytes, threshold);

}


inline int mdbx_env_get_syncbytes(const MDBX_env *env, size_t *threshold) {

  int rc = MDBX_EINVAL;

  if (threshold) {

    uint64_t proxy = 0;

    rc = mdbx_env_get_option(env, MDBX_opt_sync_bytes, &proxy);

#ifdef assert

    assert(proxy <= SIZE_MAX);

#endif /* assert */

    *threshold = (size_t)proxy;

  }

  return rc;

}


inline int mdbx_env_set_syncperiod(MDBX_env * env, unsigned seconds_16dot16) {

  return mdbx_env_set_option(env, MDBX_opt_sync_period, seconds_16dot16);

}


inline int mdbx_env_get_syncperiod(const MDBX_env *env, unsigned *period_seconds_16dot16) {

  int rc = MDBX_EINVAL;

  if (period_seconds_16dot16) {

    uint64_t proxy = 0;

    rc = mdbx_env_get_option(env, MDBX_opt_sync_period, &proxy);

#ifdef assert

    assert(proxy <= UINT32_MAX);

#endif /* assert */

    *period_seconds_16dot16 = (unsigned)proxy;

  }

  return rc;

}


LIBMDBX_API int mdbx_env_close_ex(MDBX_env *env, bool dont_sync);


inline int mdbx_env_close(MDBX_env * env) { return mdbx_env_close_ex(env, false); }


#if defined(DOXYGEN) || !(defined(_WIN32) || defined(_WIN64))

LIBMDBX_API int mdbx_env_resurrect_after_fork(MDBX_env *env);

#endif /* Windows */


typedef enum MDBX_warmup_flags {

  MDBX_warmup_default = 0,


  MDBX_warmup_force = 1,


  MDBX_warmup_oomsafe = 2,


  MDBX_warmup_lock = 4,


  MDBX_warmup_touchlimit = 8,


  MDBX_warmup_release = 16,

} MDBX_warmup_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_warmup_flags)


LIBMDBX_API int mdbx_env_warmup(const MDBX_env *env, const MDBX_txn *txn, MDBX_warmup_flags_t flags,

                                unsigned timeout_seconds_16dot16);


LIBMDBX_API int mdbx_env_set_flags(MDBX_env *env, MDBX_env_flags_t flags, bool onoff);


LIBMDBX_API int mdbx_env_get_flags(const MDBX_env *env, unsigned *flags);


LIBMDBX_API int mdbx_env_get_path(const MDBX_env *env, const char **dest);


#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)

LIBMDBX_API int mdbx_env_get_pathW(const MDBX_env *env, const wchar_t **dest);

#define mdbx_env_get_pathT(env, dest) mdbx_env_get_pathW(env, dest)

#else

#define mdbx_env_get_pathT(env, dest) mdbx_env_get_path(env, dest)

#endif /* Windows */


LIBMDBX_API int mdbx_env_get_fd(const MDBX_env *env, mdbx_filehandle_t *fd);


LIBMDBX_API int mdbx_env_set_geometry(MDBX_env *env, intptr_t size_lower, intptr_t size_now, intptr_t size_upper,

                                      intptr_t growth_step, intptr_t shrink_threshold, intptr_t pagesize);


MDBX_DEPRECATED inline int mdbx_env_set_mapsize(MDBX_env * env, size_t size) {

  return mdbx_env_set_geometry(env, size, size, size, -1, -1, -1);

}


LIBMDBX_API int mdbx_is_readahead_reasonable(size_t volume, intptr_t redundancy);


MDBX_NOTHROW_CONST_FUNCTION inline intptr_t mdbx_limits_pgsize_min(void) { return MDBX_MIN_PAGESIZE; }


MDBX_NOTHROW_CONST_FUNCTION inline intptr_t mdbx_limits_pgsize_max(void) { return MDBX_MAX_PAGESIZE; }


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_dbsize_min(intptr_t pagesize);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_dbsize_max(intptr_t pagesize);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_keysize_max(intptr_t pagesize, MDBX_db_flags_t flags);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_keysize_min(MDBX_db_flags_t flags);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_valsize_max(intptr_t pagesize, MDBX_db_flags_t flags);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_valsize_min(MDBX_db_flags_t flags);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_pairsize4page_max(intptr_t pagesize,

                                                                               MDBX_db_flags_t flags);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_valsize4page_max(intptr_t pagesize, MDBX_db_flags_t flags);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API intptr_t mdbx_limits_txnsize_max(intptr_t pagesize);


inline int mdbx_env_set_maxreaders(MDBX_env * env, unsigned readers) {

  return mdbx_env_set_option(env, MDBX_opt_max_readers, readers);

}


inline int mdbx_env_get_maxreaders(const MDBX_env *env, unsigned *readers) {

  int rc = MDBX_EINVAL;

  if (readers) {

    uint64_t proxy = 0;

    rc = mdbx_env_get_option(env, MDBX_opt_max_readers, &proxy);

    *readers = (unsigned)proxy;

  }

  return rc;

}


inline int mdbx_env_set_maxdbs(MDBX_env * env, MDBX_dbi dbs) {

  return mdbx_env_set_option(env, MDBX_opt_max_db, dbs);

}


inline int mdbx_env_get_maxdbs(const MDBX_env *env, MDBX_dbi *dbs) {

  int rc = MDBX_EINVAL;

  if (dbs) {

    uint64_t proxy = 0;

    rc = mdbx_env_get_option(env, MDBX_opt_max_db, &proxy);

    *dbs = (MDBX_dbi)proxy;

  }

  return rc;

}


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API size_t mdbx_default_pagesize(void);


LIBMDBX_API int mdbx_get_sysraminfo(intptr_t *page_size, intptr_t *total_pages, intptr_t *avail_pages);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_env_get_maxkeysize_ex(const MDBX_env *env, MDBX_db_flags_t flags);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_env_get_maxvalsize_ex(const MDBX_env *env, MDBX_db_flags_t flags);


MDBX_NOTHROW_PURE_FUNCTION MDBX_DEPRECATED LIBMDBX_API int mdbx_env_get_maxkeysize(const MDBX_env *env);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_env_get_pairsize4page_max(const MDBX_env *env, MDBX_db_flags_t flags);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_env_get_valsize4page_max(const MDBX_env *env, MDBX_db_flags_t flags);


LIBMDBX_API int mdbx_env_set_userctx(MDBX_env *env, void *ctx);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API void *mdbx_env_get_userctx(const MDBX_env *env);


LIBMDBX_API int mdbx_txn_begin_ex(MDBX_env *env, MDBX_txn *parent, MDBX_txn_flags_t flags, MDBX_txn **txn,

                                  void *context);


inline int mdbx_txn_begin(MDBX_env * env, MDBX_txn *parent, MDBX_txn_flags_t flags, MDBX_txn **txn) {

  return mdbx_txn_begin_ex(env, parent, flags, txn, NULL);

}


LIBMDBX_API int mdbx_txn_clone(const MDBX_txn *origin, MDBX_txn **in_out_clone, void *context);


LIBMDBX_API int mdbx_txn_set_userctx(MDBX_txn *txn, void *ctx);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API void *mdbx_txn_get_userctx(const MDBX_txn *txn);


struct MDBX_txn_info {

  uint64_t txn_id;


  uint64_t txn_reader_lag;


  uint64_t txn_space_used;


  uint64_t txn_space_limit_soft;


  uint64_t txn_space_limit_hard;


  uint64_t txn_space_retired;


  uint64_t txn_space_leftover;


  uint64_t txn_space_dirty;

};


#ifndef __cplusplus

typedef struct MDBX_txn_info MDBX_txn_info;

#endif


LIBMDBX_API int mdbx_txn_info(const MDBX_txn *txn, MDBX_txn_info *info, bool scan_rlt);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API MDBX_env *mdbx_txn_env(const MDBX_txn *txn);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API MDBX_txn_flags_t mdbx_txn_flags(const MDBX_txn *txn);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API uint64_t mdbx_txn_id(const MDBX_txn *txn);


struct MDBX_commit_latency {

  uint32_t preparation;

  uint32_t gc_wallclock;

  uint32_t audit;

  uint32_t write;

  uint32_t sync;

  uint32_t ending;

  uint32_t whole;

  uint32_t gc_cputime;


  struct {

    uint32_t wloops;

    uint32_t coalescences;

    uint32_t wipes;

    uint32_t flushes;

    uint32_t kicks;


    uint32_t work_counter;

    uint32_t work_rtime_monotonic;

    uint32_t work_xtime_cpu;

    uint32_t work_rsteps;

    uint32_t work_xpages;

    uint32_t work_majflt;


    uint32_t self_counter;

    uint32_t self_rtime_monotonic;

    uint32_t self_xtime_cpu;

    uint32_t self_rsteps;

    uint32_t self_xpages;

    uint32_t self_majflt;


    struct {

      uint32_t time;

      uint64_t volume;

      uint32_t calls;

    } pnl_merge_work, pnl_merge_self;


    uint32_t max_reader_lag;

    uint32_t max_retained_pages;

  } gc_prof;


};


#ifndef __cplusplus

typedef struct MDBX_commit_latency MDBX_commit_latency;

#endif


LIBMDBX_API int mdbx_txn_commit_ex(MDBX_txn *txn, MDBX_commit_latency *latency);


LIBMDBX_API int mdbx_txn_checkpoint(MDBX_txn *txn, MDBX_txn_flags_t weakening_durability, MDBX_commit_latency *latency);


LIBMDBX_API int mdbx_txn_commit_embark_read(MDBX_txn **ptxn, MDBX_commit_latency *latency);


LIBMDBX_API int mdbx_txn_amend(MDBX_txn *read_txn, MDBX_txn **ptr_write_txn, MDBX_txn_flags_t flags, void *context);


inline int mdbx_txn_commit(MDBX_txn * txn) { return mdbx_txn_commit_ex(txn, NULL); }


LIBMDBX_API int mdbx_txn_abort_ex(MDBX_txn *txn, MDBX_commit_latency *latency);


inline int mdbx_txn_abort(MDBX_txn * txn) { return mdbx_txn_abort_ex(txn, NULL); }


LIBMDBX_API int mdbx_txn_break(MDBX_txn *txn);


LIBMDBX_API int mdbx_txn_reset(MDBX_txn *txn);


LIBMDBX_API int mdbx_txn_park(MDBX_txn *txn, bool autounpark);


LIBMDBX_API int mdbx_txn_unpark(MDBX_txn *txn, bool restart_if_ousted);


LIBMDBX_API int mdbx_txn_renew(MDBX_txn *txn);


LIBMDBX_API int mdbx_txn_refresh(MDBX_txn *txn);


struct MDBX_canary {

  uint64_t x, y, z, v;

};


#ifndef __cplusplus

typedef struct MDBX_canary MDBX_canary;

#endif


LIBMDBX_API int mdbx_canary_put(MDBX_txn *txn, const MDBX_canary *canary);


LIBMDBX_API int mdbx_canary_get(const MDBX_txn *txn, MDBX_canary *canary);


typedef int(MDBX_cmp_func)(const MDBX_val *a, const MDBX_val *b) MDBX_CXX17_NOEXCEPT;


LIBMDBX_API int mdbx_dbi_open(MDBX_txn *txn, const char *name, MDBX_db_flags_t flags, MDBX_dbi *dbi);

LIBMDBX_API int mdbx_dbi_open2(MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags, MDBX_dbi *dbi);


MDBX_DEPRECATED LIBMDBX_API int mdbx_dbi_open_ex(MDBX_txn *txn, const char *name, MDBX_db_flags_t flags, MDBX_dbi *dbi,

                                                 MDBX_cmp_func *keycmp, MDBX_cmp_func *datacmp);

MDBX_DEPRECATED LIBMDBX_API int mdbx_dbi_open_ex2(MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags,

                                                  MDBX_dbi *dbi, MDBX_cmp_func *keycmp, MDBX_cmp_func *datacmp);


LIBMDBX_API int mdbx_dbi_rename(MDBX_txn *txn, MDBX_dbi dbi, const char *name);

LIBMDBX_API int mdbx_dbi_rename2(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *name);


typedef int(MDBX_table_enum_func)(void *ctx, const MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags,

                                  const struct MDBX_stat *stat, MDBX_dbi dbi) MDBX_CXX17_NOEXCEPT;


LIBMDBX_API int mdbx_enumerate_tables(const MDBX_txn *txn, MDBX_table_enum_func *func, void *ctx);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API uint64_t mdbx_key_from_jsonInteger(const int64_t json_integer);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API uint64_t mdbx_key_from_double(const double ieee754_64bit);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API uint64_t mdbx_key_from_ptrdouble(const double *const ieee754_64bit);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API uint32_t mdbx_key_from_float(const float ieee754_32bit);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API uint32_t mdbx_key_from_ptrfloat(const float *const ieee754_32bit);


MDBX_NOTHROW_CONST_FUNCTION inline uint64_t mdbx_key_from_int64(const int64_t i64) {

  return UINT64_C(0x8000000000000000) + i64;

}


MDBX_NOTHROW_CONST_FUNCTION inline uint32_t mdbx_key_from_int32(const int32_t i32) {

  return UINT32_C(0x80000000) + i32;

}


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int64_t mdbx_jsonInteger_from_key(const MDBX_val);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API double mdbx_double_from_key(const MDBX_val);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API float mdbx_float_from_key(const MDBX_val);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int32_t mdbx_int32_from_key(const MDBX_val);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int64_t mdbx_int64_from_key(const MDBX_val);


LIBMDBX_API int mdbx_dbi_stat(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_stat *stat, size_t bytes);


LIBMDBX_API int mdbx_dbi_dupsort_depthmask(const MDBX_txn *txn, MDBX_dbi dbi, uint32_t *mask);


typedef enum MDBX_dbi_state {

  MDBX_DBI_DIRTY = 0x01,

  MDBX_DBI_STALE = 0x02,

  MDBX_DBI_FRESH = 0x04,

  MDBX_DBI_CREAT = 0x08,

} MDBX_dbi_state_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_dbi_state)


LIBMDBX_API int mdbx_dbi_flags_ex(const MDBX_txn *txn, MDBX_dbi dbi, unsigned *flags, unsigned *state);


inline int mdbx_dbi_flags(const MDBX_txn *txn, MDBX_dbi dbi, unsigned *flags) {

  unsigned state;

  return mdbx_dbi_flags_ex(txn, dbi, flags, &state);

}


LIBMDBX_API int mdbx_dbi_close(MDBX_env *env, MDBX_dbi dbi);


LIBMDBX_API int mdbx_drop(MDBX_txn *txn, MDBX_dbi dbi, bool del);


LIBMDBX_API int mdbx_get(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data);


LIBMDBX_API int mdbx_get_ex(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_val *key, MDBX_val *data, size_t *values_count);


LIBMDBX_API int mdbx_get_equal_or_great(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_val *key, MDBX_val *data);


typedef struct MDBX_cache_entry {

  uint64_t trunk_txnid;

  uint64_t last_confirmed_txnid;

  size_t offset;

  uint32_t length;

} MDBX_cache_entry_t;


inline void mdbx_cache_init(MDBX_cache_entry_t * entry) {

  entry->offset = 0;

  entry->length = 0;

  entry->trunk_txnid = 0;

  entry->last_confirmed_txnid = 0;

}


typedef enum MDBX_cache_status {

  MDBX_CACHE_ERROR = -3,


  MDBX_CACHE_BEHIND = -2,


  MDBX_CACHE_UNABLE = -1,


  MDBX_CACHE_RACE = 0,


  MDBX_CACHE_DIRTY = 1,


  MDBX_CACHE_HIT = 2,


  MDBX_CACHE_CONFIRMED = 3,


  MDBX_CACHE_REFRESHED = 4

} MDBX_cache_status_t;


typedef struct MDBX_cache_result {

  MDBX_error_t errcode;

  MDBX_cache_status_t status;

} MDBX_cache_result_t;


LIBMDBX_API MDBX_cache_result_t mdbx_cache_get(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data,

                                               volatile MDBX_cache_entry_t *entry);


LIBMDBX_API MDBX_cache_result_t mdbx_cache_get_SingleThreaded(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key,

                                                              MDBX_val *data, MDBX_cache_entry_t *entry);


LIBMDBX_API int mdbx_put(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data, MDBX_put_flags_t flags);


LIBMDBX_API int mdbx_replace(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *new_data, MDBX_val *old_data,

                             MDBX_put_flags_t flags);


typedef int (*MDBX_preserve_func)(void *context, MDBX_val *target, const void *src, size_t bytes);


LIBMDBX_API int mdbx_replace_ex(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *new_data,

                                MDBX_val *old_data, MDBX_put_flags_t flags, MDBX_preserve_func preserver,

                                void *preserver_context);


LIBMDBX_API int mdbx_del(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, const MDBX_val *data);


LIBMDBX_API MDBX_cursor *mdbx_cursor_create(void *context);


LIBMDBX_API int mdbx_cursor_set_userctx(MDBX_cursor *cursor, void *ctx);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API void *mdbx_cursor_get_userctx(const MDBX_cursor *cursor);


LIBMDBX_API int mdbx_cursor_bind(MDBX_txn *txn, MDBX_cursor *cursor, MDBX_dbi dbi);


LIBMDBX_API int mdbx_cursor_unbind(MDBX_cursor *cursor);


LIBMDBX_API int mdbx_cursor_reset(MDBX_cursor *cursor);


LIBMDBX_API int mdbx_cursor_open(MDBX_txn *txn, MDBX_dbi dbi, MDBX_cursor **cursor);


LIBMDBX_API void mdbx_cursor_close(MDBX_cursor *cursor);


LIBMDBX_API int mdbx_cursor_close2(MDBX_cursor *cursor);


LIBMDBX_API int mdbx_txn_release_all_cursors_ex(const MDBX_txn *txn, bool unbind, size_t *count);


inline int mdbx_txn_release_all_cursors(const MDBX_txn *txn, bool unbind) {

  return mdbx_txn_release_all_cursors_ex(txn, unbind, NULL);

}


LIBMDBX_API int mdbx_cursor_renew(MDBX_txn *txn, MDBX_cursor *cursor);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API MDBX_txn *mdbx_cursor_txn(const MDBX_cursor *cursor);


LIBMDBX_API MDBX_dbi mdbx_cursor_dbi(const MDBX_cursor *cursor);


LIBMDBX_API int mdbx_cursor_copy(const MDBX_cursor *src, MDBX_cursor *dest);


LIBMDBX_API int mdbx_cursor_compare(const MDBX_cursor *left, const MDBX_cursor *right, bool ignore_multival);


LIBMDBX_API int mdbx_cursor_get(MDBX_cursor *cursor, MDBX_val *key, MDBX_val *data, MDBX_cursor_op op);


LIBMDBX_API int mdbx_cursor_ignord(MDBX_cursor *cursor);


typedef int(MDBX_predicate_func)(void *context, MDBX_val *key, MDBX_val *value, void *arg) MDBX_CXX17_NOEXCEPT;


LIBMDBX_API int mdbx_cursor_scan(MDBX_cursor *cursor, MDBX_predicate_func *predicate, void *context,

                                 MDBX_cursor_op start_op, MDBX_cursor_op turn_op, void *arg);


LIBMDBX_API int mdbx_cursor_scan_from(MDBX_cursor *cursor, MDBX_predicate_func *predicate, void *context,

                                      MDBX_cursor_op from_op, MDBX_val *from_key, MDBX_val *from_value,

                                      MDBX_cursor_op turn_op, void *arg);


LIBMDBX_API int mdbx_cursor_get_batch(MDBX_cursor *cursor, size_t *count, MDBX_val *pairs, size_t limit,

                                      MDBX_cursor_op op);


LIBMDBX_API int mdbx_cursor_put(MDBX_cursor *cursor, const MDBX_val *key, MDBX_val *data, MDBX_put_flags_t flags);


LIBMDBX_API int mdbx_cursor_del(MDBX_cursor *cursor, MDBX_put_flags_t flags);


typedef enum MDBX_bunch_action {

  MDBX_DELETE_CURRENT_VALUE,

  MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_EXCLUDING,

  MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_INCLUDING,

  MDBX_DELETE_CURRENT_MULTIVAL_AFTER_INCLUDING,

  MDBX_DELETE_CURRENT_MULTIVAL_AFTER_EXCLUDING,

  MDBX_DELETE_CURRENT_MULTIVAL_ALL,

  MDBX_DELETE_BEFORE_EXCLUDING,

  MDBX_DELETE_BEFORE_INCLUDING,

  MDBX_DELETE_AFTER_INCLUDING,

  MDBX_DELETE_AFTER_EXCLUDING,

  MDBX_DELETE_WHOLE,

} MDBX_bunch_action_t;


LIBMDBX_API int mdbx_cursor_bunch_delete(MDBX_cursor *cursor, MDBX_bunch_action_t action, uint64_t *number_of_affected);


LIBMDBX_API int mdbx_cursor_count(const MDBX_cursor *cursor, size_t *count);


LIBMDBX_API int mdbx_cursor_count_ex(const MDBX_cursor *cursor, size_t *count, MDBX_stat *stat, size_t bytes);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_cursor_eof(const MDBX_cursor *cursor);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_cursor_on_first(const MDBX_cursor *cursor);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_cursor_on_first_dup(const MDBX_cursor *cursor);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_cursor_on_last(const MDBX_cursor *cursor);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_cursor_on_last_dup(const MDBX_cursor *cursor);


LIBMDBX_API int mdbx_estimate_distance(const MDBX_cursor *first, const MDBX_cursor *last, ptrdiff_t *distance_items);


LIBMDBX_API int mdbx_estimate_move(const MDBX_cursor *cursor, MDBX_val *key, MDBX_val *data, MDBX_cursor_op move_op,

                                   ptrdiff_t *distance_items);


LIBMDBX_API int mdbx_estimate_range(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *begin_key,

                                    const MDBX_val *begin_data, const MDBX_val *end_key, const MDBX_val *end_data,

                                    ptrdiff_t *distance_items);


#define MDBX_EPSILON ((MDBX_val *)((ptrdiff_t)-1))


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_is_dirty(const MDBX_txn *txn, const void *ptr);


LIBMDBX_API int mdbx_dbi_sequence(MDBX_txn *txn, MDBX_dbi dbi, uint64_t *result, uint64_t increment);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_cmp(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *a,

                                                    const MDBX_val *b);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API MDBX_cmp_func *mdbx_get_keycmp(MDBX_db_flags_t flags);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API int mdbx_dcmp(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *a,

                                                     const MDBX_val *b);


MDBX_NOTHROW_CONST_FUNCTION LIBMDBX_API MDBX_cmp_func *mdbx_get_datacmp(MDBX_db_flags_t flags);


typedef int(MDBX_reader_list_func)(void *ctx, int num, int slot, mdbx_pid_t pid, mdbx_tid_t thread, uint64_t txnid,

                                   uint64_t lag, size_t bytes_used, size_t bytes_retained) MDBX_CXX17_NOEXCEPT;


LIBMDBX_API int mdbx_reader_list(const MDBX_env *env, MDBX_reader_list_func *func, void *ctx);


LIBMDBX_API int mdbx_reader_check(MDBX_env *env, int *dead);


MDBX_DEPRECATED LIBMDBX_API int mdbx_txn_straggler(const MDBX_txn *txn, int *percent);


LIBMDBX_API int mdbx_thread_register(const MDBX_env *env);


LIBMDBX_API int mdbx_thread_unregister(const MDBX_env *env);


typedef int(MDBX_hsr_func)(const MDBX_env *env, const MDBX_txn *txn, mdbx_pid_t pid, mdbx_tid_t tid, uint64_t laggard,

                           unsigned gap, size_t space, int retry) MDBX_CXX17_NOEXCEPT;


LIBMDBX_API int mdbx_env_set_hsr(MDBX_env *env, MDBX_hsr_func *hsr_callback);


MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API MDBX_hsr_func *mdbx_env_get_hsr(const MDBX_env *env);


LIBMDBX_API int mdbx_txn_lock(MDBX_env *env, bool dont_wait);


LIBMDBX_API int mdbx_txn_unlock(MDBX_env *env);


LIBMDBX_API int mdbx_env_open_for_recovery(MDBX_env *env, const char *pathname, unsigned target_meta, bool writeable);


#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)

LIBMDBX_API int mdbx_env_open_for_recoveryW(MDBX_env *env, const wchar_t *pathname, unsigned target_meta,

                                            bool writeable);


#define mdbx_env_open_for_recoveryT(env, pathname, target_mets, writeable)                                             \

  mdbx_env_open_for_recoveryW(env, pathname, target_mets, writeable)


#else

#define mdbx_env_open_for_recoveryT(env, pathname, target_mets, writeable)                                             \

  mdbx_env_open_for_recovery(env, pathname, target_mets, writeable)

#endif /* Windows */


LIBMDBX_API int mdbx_env_turn_for_recovery(MDBX_env *env, unsigned target_meta);


LIBMDBX_API int mdbx_preopen_snapinfo(const char *pathname, MDBX_envinfo *info, size_t bytes);

#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)

LIBMDBX_API int mdbx_preopen_snapinfoW(const wchar_t *pathname, MDBX_envinfo *info, size_t bytes);

#define mdbx_preopen_snapinfoT(pathname, info, bytes) mdbx_preopen_snapinfoW(pathname, info, bytes)

#else

#define mdbx_preopen_snapinfoT(pathname, info, bytes) mdbx_preopen_snapinfo(pathname, info, bytes)

#endif /* Windows */


typedef enum MDBX_chk_flags {

  MDBX_CHK_DEFAULTS = 0,


  MDBX_CHK_READWRITE = 1,


  MDBX_CHK_SKIP_BTREE_TRAVERSAL = 2,


  MDBX_CHK_SKIP_KV_TRAVERSAL = 4,


  MDBX_CHK_IGNORE_ORDER = 8

} MDBX_chk_flags_t;


DEFINE_ENUM_FLAG_OPERATORS(MDBX_chk_flags)


typedef enum MDBX_chk_severity {

  MDBX_chk_severity_prio_shift = 4,

  MDBX_chk_severity_kind_mask = 0xF,

  MDBX_chk_fatal = 0x00u,

  MDBX_chk_error = 0x11u,

  MDBX_chk_warning = 0x22u,

  MDBX_chk_notice = 0x33u,

  MDBX_chk_result = 0x44u,

  MDBX_chk_resolution = 0x55u,

  MDBX_chk_processing = 0x56u,

  MDBX_chk_info = 0x67u,

  MDBX_chk_verbose = 0x78u,

  MDBX_chk_details = 0x89u,

  MDBX_chk_extra = 0x9Au

} MDBX_chk_severity_t;


typedef enum MDBX_chk_stage {

  MDBX_chk_none,

  MDBX_chk_init,

  MDBX_chk_lock,

  MDBX_chk_meta,

  MDBX_chk_tree,

  MDBX_chk_gc,

  MDBX_chk_space,

  MDBX_chk_maindb,

  MDBX_chk_tables,

  MDBX_chk_conclude,

  MDBX_chk_unlock,

  MDBX_chk_finalize

} MDBX_chk_stage_t;


typedef struct MDBX_chk_line {

  struct MDBX_chk_context *ctx;

  uint8_t severity, scope_depth, empty;

  char *begin, *end, *out;

} MDBX_chk_line_t;


typedef struct MDBX_chk_issue {

  struct MDBX_chk_issue *next;

  size_t count;

  const char *caption;

} MDBX_chk_issue_t;


typedef struct MDBX_chk_scope {

  MDBX_chk_issue_t *issues;

  struct MDBX_chk_internal *internal;

  const void *object;

  MDBX_chk_stage_t stage;

  MDBX_chk_severity_t verbosity;

  size_t subtotal_issues;


  union {

    void *ptr;

    size_t number;

  } usr_z, usr_v, usr_o;


} MDBX_chk_scope_t;


typedef struct MDBX_chk_user_table_cookie MDBX_chk_user_table_cookie_t;


struct MDBX_chk_histogram {

  size_t amount, count, le1_amount, le1_count;


  struct {

    size_t begin, end, amount, count;

  } ranges[9];


};


typedef struct MDBX_chk_table {

  MDBX_chk_user_table_cookie_t *cookie;


#define MDBX_CHK_MAIN ((void *)((ptrdiff_t)0))

#define MDBX_CHK_GC ((void *)((ptrdiff_t)-1))

#define MDBX_CHK_META ((void *)((ptrdiff_t)-2))


  MDBX_val name;

  MDBX_db_flags_t flags;

  int id;


  size_t payload_bytes, lost_bytes;


  struct {

    size_t all, empty, broken;

    size_t branch, leaf;

    size_t nested_branch, nested_leaf, nested_subleaf;

  } pages;


  struct {

    struct MDBX_chk_histogram height;

    struct MDBX_chk_histogram large_pages;

    struct MDBX_chk_histogram nested_height_or_gc_span_length;

    struct MDBX_chk_histogram key_len;

    struct MDBX_chk_histogram val_len;

    struct MDBX_chk_histogram multival;

    struct MDBX_chk_histogram tree_density;

    struct MDBX_chk_histogram large_or_nested_density;

    struct MDBX_chk_histogram page_age;

    struct MDBX_chk_histogram pgno;

  } histogram;


} MDBX_chk_table_t;


typedef struct MDBX_chk_context {

  struct MDBX_chk_internal *internal;

  MDBX_env *env;

  MDBX_txn *txn;

  MDBX_chk_scope_t *scope;

  uint8_t scope_nesting;


  struct {

    size_t total_payload_bytes;

    size_t table_total, table_processed;

    size_t total_unused_bytes, unused_pages;

    size_t processed_pages, reclaimable_pages, gc_pages, alloc_pages, backed_pages;

    size_t problems_meta, tree_problems, gc_tree_problems, kv_tree_problems, problems_gc, problems_kv, total_problems;

    uint64_t steady_txnid, recent_txnid;

    struct MDBX_chk_histogram histogram_page_age;

    struct MDBX_chk_histogram histogram_pgno_payload;

    struct MDBX_chk_histogram histogram_pgno_retained;

    const MDBX_chk_table_t *const *tables;

  } result;


} MDBX_chk_context_t;


typedef struct MDBX_chk_callbacks {

  bool (*check_break)(MDBX_chk_context_t *ctx);

  int (*scope_push)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner, const char *fmt,

                    va_list args);

  int (*scope_conclude)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner, int err);

  void (*scope_pop)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner);

  void (*issue)(MDBX_chk_context_t *ctx, const char *object, uint64_t entry_number, const char *issue,

                const char *extra_fmt, va_list extra_args);

  MDBX_chk_user_table_cookie_t *(*table_filter)(MDBX_chk_context_t *ctx, const MDBX_val *name, MDBX_db_flags_t flags);

  int (*table_conclude)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table, MDBX_cursor *cursor, int err);

  void (*table_dispose)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table);


  int (*table_handle_kv)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table, size_t entry_number,

                         const MDBX_val *key, const MDBX_val *value);


  int (*stage_begin)(MDBX_chk_context_t *ctx, MDBX_chk_stage_t);

  int (*stage_end)(MDBX_chk_context_t *ctx, MDBX_chk_stage_t, int err);


  MDBX_chk_line_t *(*print_begin)(MDBX_chk_context_t *ctx, MDBX_chk_severity_t severity);

  void (*print_flush)(MDBX_chk_line_t *);

  void (*print_done)(MDBX_chk_line_t *);

  void (*print_chars)(MDBX_chk_line_t *, const char *str, size_t len);

  void (*print_format)(MDBX_chk_line_t *, const char *fmt, va_list args);

  void (*print_size)(MDBX_chk_line_t *, const char *prefix, const uint64_t value, const char *suffix);

} MDBX_chk_callbacks_t;


LIBMDBX_API int mdbx_env_chk(MDBX_env *env, const MDBX_chk_callbacks_t *cb, MDBX_chk_context_t *ctx,

                             const MDBX_chk_flags_t flags, MDBX_chk_severity_t verbosity,

                             unsigned timeout_seconds_16dot16);


LIBMDBX_API int mdbx_env_chk_encount_problem(MDBX_chk_context_t *ctx);


LIBMDBX_API const char *mdbx_ratio2digits(uint64_t numerator, uint64_t denominator, int precision, char *buffer,

                                          size_t buffer_size);


LIBMDBX_API const char *mdbx_ratio2percents(uint64_t value, uint64_t whole, char *buffer, size_t buffer_size);


typedef int(MDBX_gc_iter_func)(void *ctx, const MDBX_txn *txn, uint64_t span_txnid, size_t span_pgno,

                               size_t span_length, bool span_is_reclaimable) MDBX_CXX17_NOEXCEPT;


typedef struct MDBX_gc_info {

  size_t pages_total;

  size_t pages_backed;

  size_t pages_allocated;

  size_t pages_gc;


  struct {

    size_t pages;

    struct MDBX_chk_histogram

        span_histogram;

    struct MDBX_chk_histogram pgno_distribution;

  } gc_reclaimable;


} MDBX_gc_info_t;


LIBMDBX_API int mdbx_gc_info(MDBX_txn *txn, MDBX_gc_info_t *info, size_t bytes, MDBX_gc_iter_func iter_func,

                             void *iter_ctx);


#ifdef __cplusplus

} /* extern "C" */

#endif


#endif /* LIBMDBX_H */

MDBX_NOTHROW_CONST_FUNCTION
#define MDBX_NOTHROW_CONST_FUNCTION
The 'const nothrow' function attribute for optimization.
Definition mdbx.h:315

MDBX_CXX17_NOEXCEPT
#define MDBX_CXX17_NOEXCEPT
Definition mdbx.h:429

MDBX_NOTHROW_PURE_FUNCTION
#define MDBX_NOTHROW_PURE_FUNCTION
The 'pure nothrow' function attribute for optimization.
Definition mdbx.h:274

MDBX_NORETURN
#define MDBX_NORETURN
Definition mdbx.h:499

MDBX_envinfo.mi_geo::upper
uint64_t upper

MDBX_envinfo::mi_mapsize
uint64_t mi_mapsize
Definition mdbx.h:2804

MDBX_commit_latency.gc_prof.pnl_merge_self::time
uint32_t time

MDBX_commit_latency.gc_prof::wipes
uint32_t wipes
The number of previous reliable/stable committed points erased when working in MDBX_UTTERLY_NOSYNC mo...

MDBX_txn_info::txn_space_dirty
uint64_t txn_space_dirty
Definition mdbx.h:4046

MDBX_envinfo::mi_geo
struct MDBX_envinfo::@012005163333303136244023145022271211024347140371 mi_geo

MDBX_commit_latency::gc_cputime
uint32_t gc_cputime
User-mode CPU time spent on GC update.
Definition mdbx.h:4121

MDBX_version_info.git::describe
const char * describe

MDBX_gc_info_t.gc_reclaimable::pgno_distribution
struct MDBX_chk_histogram pgno_distribution

MDBX_envinfo::mi_dxb_pagesize
uint32_t mi_dxb_pagesize
Definition mdbx.h:2814

MDBX_envinfo::mi_maxreaders
uint32_t mi_maxreaders
Definition mdbx.h:2812

MDBX_cache_result_t::errcode
MDBX_error_t errcode
Definition mdbx.h:5272

MDBX_canary::v
uint64_t v
Definition mdbx.h:4664

MDBX_commit_latency.gc_prof::coalescences
uint32_t coalescences
The number of iterations of merging GC items.

MDBX_envinfo::mi_numreaders
uint32_t mi_numreaders
Definition mdbx.h:2813

MDBX_version_info::patch
uint16_t patch
Definition mdbx.h:634

MDBX_build_info::metadata
const char * metadata
Definition mdbx.h:655

MDBX_commit_latency.gc_prof.pnl_merge_self::volume
uint64_t volume

MDBX_envinfo::mi_since_sync_seconds16dot16
uint32_t mi_since_sync_seconds16dot16
Definition mdbx.h:2840

MDBX_cache_entry_t::length
uint32_t length
Definition mdbx.h:5177

MDBX_commit_latency.gc_prof::self_xpages
uint32_t self_xpages
The number of page sequences allocation requests for the GC itself.

MDBX_version_info::major
uint16_t major
Definition mdbx.h:632

MDBX_txn_info::txn_reader_lag
uint64_t txn_reader_lag
Definition mdbx.h:4013

MDBX_envinfo::mi_meta_txnid
uint64_t mi_meta_txnid[3]
Definition mdbx.h:2811

MDBX_cache_result_t::status
MDBX_cache_status_t status
Definition mdbx.h:5274

MDBX_envinfo.mi_bootid.current::y
uint64_t y

MDBX_envinfo.mi_geo::current
uint64_t current

MDBX_txn_info::txn_space_leftover
uint64_t txn_space_leftover
Definition mdbx.h:4039

MDBX_envinfo::mi_pgop_stat
struct MDBX_envinfo::@366225332126364017271247035205240304242123014254 mi_pgop_stat

MDBX_txn_info::txn_space_used
uint64_t txn_space_used
Definition mdbx.h:4017

MDBX_build_info::datetime
const char * datetime
Definition mdbx.h:650

MDBX_envinfo.mi_geo::grow
uint64_t grow

MDBX_gc_info_t::pages_total
size_t pages_total
Definition mdbx.h:7171

MDBX_envinfo::mi_recent_txnid
uint64_t mi_recent_txnid
Definition mdbx.h:2808

MDBX_envinfo::mi_autosync_threshold
uint64_t mi_autosync_threshold
Definition mdbx.h:2836

MDBX_gc_info_t::pages_allocated
size_t pages_allocated
Definition mdbx.h:7173

MDBX_version_info::semver_prerelease
const char * semver_prerelease
Definition mdbx.h:636

MDBX_commit_latency.gc_prof::wloops
uint32_t wloops
The number of GC update iterations is greater than 1 if there were repeats/restarts.

MDBX_gc_info_t::pages_gc
size_t pages_gc
Definition mdbx.h:7174

MDBX_stat::ms_branch_pages
uint64_t ms_branch_pages
Definition mdbx.h:2754

MDBX_stat::ms_entries
uint64_t ms_entries
Definition mdbx.h:2757

MDBX_commit_latency::gc_wallclock
uint32_t gc_wallclock
Duration of GC update by wall clock.
Definition mdbx.h:4107

MDBX_envinfo.mi_pgop_stat::merge
uint64_t merge

MDBX_version_info::minor
uint16_t minor
Definition mdbx.h:633

MDBX_cache_entry_t::offset
size_t offset
Definition mdbx.h:5175

MDBX_envinfo::mi_since_reader_check_seconds16dot16
uint32_t mi_since_reader_check_seconds16dot16
Definition mdbx.h:2846

MDBX_canary::y
uint64_t y
Definition mdbx.h:4664

MDBX_cache_entry_t::last_confirmed_txnid
uint64_t last_confirmed_txnid
Definition mdbx.h:5173

MDBX_envinfo.mi_pgop_stat::cow
uint64_t cow

MDBX_envinfo.mi_geo::lower
uint64_t lower

MDBX_envinfo.mi_pgop_stat::spill
uint64_t spill

MDBX_envinfo::mi_dxbid
struct MDBX_envinfo::@041066021046127331076001156004251200350305323267 mi_dxbid

MDBX_commit_latency::sync
uint32_t sync
Duration of syncing written data to the disk/storage, i.e. the duration of a fdatasync() or a msync()...
Definition mdbx.h:4115

MDBX_envinfo::mi_sys_ioblk
uint32_t mi_sys_ioblk
Definition mdbx.h:2817

MDBX_txn_info::txn_space_limit_soft
uint64_t txn_space_limit_soft
Definition mdbx.h:4020

MDBX_envinfo::mi_mode
uint32_t mi_mode
Definition mdbx.h:2849

MDBX_build_info::options
const char * options
Definition mdbx.h:652

MDBX_txn_info::txn_id
uint64_t txn_id
Definition mdbx.h:4007

MDBX_version_info::sourcery
const char * sourcery
Definition mdbx.h:643

MDBX_envinfo.mi_geo::shrink
uint64_t shrink

MDBX_envinfo.mi_pgop_stat::msync
uint64_t msync

MDBX_envinfo.mi_pgop_stat::prefault
uint64_t prefault

MDBX_envinfo::mi_latter_reader_txnid
uint64_t mi_latter_reader_txnid
Definition mdbx.h:2809

MDBX_stat::ms_overflow_pages
uint64_t ms_overflow_pages
Definition mdbx.h:2756

MDBX_commit_latency.gc_prof::self_rsteps
uint32_t self_rsteps
The number of search iterations inside the GC when allocating pages for the purposes of maintaining a...

MDBX_envinfo::mi_bootid
struct MDBX_envinfo::@036110245144360117333346206230046231375034327042 mi_bootid
A mostly unique ID that is regenerated on each boot.

MDBX_envinfo.mi_bootid.current::x
uint64_t x

MDBX_commit_latency.gc_prof::self_majflt
uint32_t self_majflt
The number of page faults within the GC when allocating and preparing pages for the GC itself.

MDBX_commit_latency.gc_prof::work_majflt
uint32_t work_majflt
The number of page faults inside the GC when allocating and preparing pages for user's data.

MDBX_commit_latency::preparation
uint32_t preparation
Duration of preparation (commit child transactions, update table's records and cursors destroying).
Definition mdbx.h:4105

MDBX_envinfo::mi_sys_upcblk
uint32_t mi_sys_upcblk
Definition mdbx.h:2816

MDBX_envinfo.mi_pgop_stat::newly
uint64_t newly

MDBX_canary::z
uint64_t z
Definition mdbx.h:4664

MDBX_txn_info::txn_space_limit_hard
uint64_t txn_space_limit_hard
Definition mdbx.h:4024

MDBX_commit_latency::whole
uint32_t whole
The total duration of a commit.
Definition mdbx.h:4119

MDBX_commit_latency.gc_prof::flushes
uint32_t flushes
The number of forced commits to disk to avoid the database growth when working outside of MDBX_UTTERL...

MDBX_commit_latency.gc_prof::work_xpages
uint32_t work_xpages
The number of requests to allocate page sequences for the sake of user's data.

MDBX_build_info::flags
const char * flags
Definition mdbx.h:654

MDBX_commit_latency.gc_prof::self_counter
uint32_t self_counter
The GC's slow path execution count is for the purposes of maintaining and updating the GC itself.

MDBX_gc_info_t.gc_reclaimable::span_histogram
struct MDBX_chk_histogram span_histogram

MDBX_gc_info_t.gc_reclaimable::pages
size_t pages

MDBX_commit_latency.gc_prof::self_rtime_monotonic
uint32_t self_rtime_monotonic
The time "by the wall clock" spent reading and searching inside the GC for the purposes of maintainin...

MDBX_commit_latency::gc_prof
struct MDBX_commit_latency::@063112077126007214166021162020057361221355030117 gc_prof
Information for GC profiling.

MDBX_envinfo::mi_meta_sign
uint64_t mi_meta_sign[3]
Definition mdbx.h:2811

MDBX_stat::ms_psize
uint32_t ms_psize
Definition mdbx.h:2751

MDBX_commit_latency.gc_prof::kicks
uint32_t kicks
The number of accesses to the Handle-Slow-Readers mechanism to avoid void the database growth.

MDBX_commit_latency::audit
uint32_t audit
Duration of internal audit if enabled.
Definition mdbx.h:4109

MDBX_version_info.git::tree
const char * tree

MDBX_version_info::tweak
uint16_t tweak
Definition mdbx.h:635

MDBX_build_info::target
const char * target
Definition mdbx.h:651

MDBX_commit_latency::write
uint32_t write
Duration of writing dirty/modified data pages to a filesystem, i.e. the summary duration of a write()...
Definition mdbx.h:4112

MDBX_txn_info::txn_space_retired
uint64_t txn_space_retired
Definition mdbx.h:4032

MDBX_stat::ms_depth
uint32_t ms_depth
Definition mdbx.h:2753

MDBX_envinfo::mi_dxb_fallocated
uint64_t mi_dxb_fallocated
Definition mdbx.h:2806

MDBX_envinfo.mi_pgop_stat::mincore
uint64_t mincore

MDBX_envinfo::mi_last_pgno
uint64_t mi_last_pgno
Definition mdbx.h:2807

MDBX_commit_latency.gc_prof::work_counter
uint32_t work_counter
Number of slow/deep path GC search for the sake of placement user's data.

MDBX_commit_latency.gc_prof::self_xtime_cpu
uint32_t self_xtime_cpu
The CPU time in user mode spent preparing pages taken from the GC for the purposes of maintaining and...

MDBX_commit_latency::ending
uint32_t ending
Duration of transaction ending (releasing resources).
Definition mdbx.h:4117

MDBX_envinfo.mi_pgop_stat::clone
uint64_t clone

MDBX_stat::ms_mod_txnid
uint64_t ms_mod_txnid
Definition mdbx.h:2758

MDBX_commit_latency.gc_prof::work_rsteps
uint32_t work_rsteps
The number of search iterations inside GC when allocating pages for the sake of user's data.

MDBX_gc_info_t::pages_backed
size_t pages_backed
Definition mdbx.h:7172

MDBX_cache_entry_t::trunk_txnid
uint64_t trunk_txnid
Definition mdbx.h:5171

MDBX_version_info.git::datetime
const char * datetime

MDBX_envinfo::mi_self_latter_reader_txnid
uint64_t mi_self_latter_reader_txnid
Definition mdbx.h:2810

MDBX_envinfo.mi_pgop_stat::fsync
uint64_t fsync

MDBX_stat::ms_leaf_pages
uint64_t ms_leaf_pages
Definition mdbx.h:2755

MDBX_envinfo::mi_dxb_fsize
uint64_t mi_dxb_fsize
Definition mdbx.h:2805

MDBX_canary::x
uint64_t x
Definition mdbx.h:4664

MDBX_envinfo::mi_autosync_period_seconds16dot16
uint32_t mi_autosync_period_seconds16dot16
Definition mdbx.h:2843

MDBX_envinfo::mi_unsync_volume
uint64_t mi_unsync_volume
Definition mdbx.h:2834

MDBX_envinfo::mi_sys_pagesize
uint32_t mi_sys_pagesize
Definition mdbx.h:2815

MDBX_envinfo.mi_pgop_stat::split
uint64_t split

MDBX_commit_latency.gc_prof.pnl_merge_self::calls
uint32_t calls

MDBX_version_info::git
struct MDBX_version_info::@246336125106374236367351214106016351032060025144 git

MDBX_commit_latency.gc_prof::work_rtime_monotonic
uint32_t work_rtime_monotonic
The time "by the wall clock" spent reading and searching inside the GC for the user's data.

MDBX_commit_latency.gc_prof::work_xtime_cpu
uint32_t work_xtime_cpu
The CPU time in user mode spent for preparing pages taken from the GC for user data,...

MDBX_envinfo.mi_pgop_stat::unspill
uint64_t unspill

MDBX_build_info::compiler
const char * compiler
Definition mdbx.h:653

MDBX_envinfo.mi_pgop_stat::wops
uint64_t wops

MDBX_version_info.git::commit
const char * commit

mdbx_env_get_hsr
LIBMDBX_API MDBX_hsr_func * mdbx_env_get_hsr(const MDBX_env *env)
Gets current Handle-Slow-Readers callback used to resolve database full/overflow issue due to a reade...

MDBX_constants
MDBX_constants
Definition mdbx.h:783

mdbx_mode_t
mode_t mdbx_mode_t
Definition mdbx.h:187

LIBMDBX_API
#define LIBMDBX_API
Definition mdbx.h:606

MDBX_val
struct iovec MDBX_val
Generic structure used for passing keys and data in and out of the table. .
Definition mdbx.h:780

mdbx_version
LIBMDBX_VERINFO_API const struct MDBX_version_info mdbx_version
libmdbx version information

mdbx_tid_t
pthread_t mdbx_tid_t
Definition mdbx.h:186

mdbx_build
LIBMDBX_VERINFO_API const struct MDBX_build_info mdbx_build
libmdbx build information

MDBX_env
struct MDBX_env MDBX_env
Opaque structure for a database environment.
Definition mdbx.h:713

mdbx_filehandle_t
int mdbx_filehandle_t
Definition mdbx.h:184

mdbx_liberr2str
LIBMDBX_API const char * mdbx_liberr2str(int errnum)

mdbx_pid_t
pid_t mdbx_pid_t
Definition mdbx.h:185

mdbx_env_openW
LIBMDBX_API int mdbx_env_openW(MDBX_env *env, const wchar_t *pathname, MDBX_env_flags_t flags, mdbx_mode_t mode)
Open an environment instance.

LIBMDBX_VERINFO_API
#define LIBMDBX_VERINFO_API
Definition mdbx.h:627

MDBX_MAX_PAGESIZE
@ MDBX_MAX_PAGESIZE
Definition mdbx.h:794

MDBX_MAXDATASIZE
@ MDBX_MAXDATASIZE
Definition mdbx.h:788

MDBX_MAX_DBI
@ MDBX_MAX_DBI
Definition mdbx.h:785

MDBX_MIN_PAGESIZE
@ MDBX_MIN_PAGESIZE
Definition mdbx.h:791

MDBX_build_info
libmdbx build information
Definition mdbx.h:649

MDBX_cache_entry_t
Lightweight transparent cache entry structure used by mdbx_cache_get().
Definition mdbx.h:5170

MDBX_cache_result_t
Pair of error code and cache status as a result of mdbx_cache_get().
Definition mdbx.h:5270

MDBX_canary
The fours integers markers (aka "canary") associated with the environment.
Definition mdbx.h:4663

MDBX_commit_latency
Latency of commit stages in 1/65536 of seconds units.
Definition mdbx.h:4102

MDBX_envinfo
Information about the environment.
Definition mdbx.h:2796

MDBX_gc_info_t
Information about Garbage Collection and page usage.
Definition mdbx.h:7170

MDBX_stat
Statistics for a table in the environment.
Definition mdbx.h:2750

MDBX_txn_info
Information about the transaction.
Definition mdbx.h:4004

MDBX_version_info
libmdbx version information,
Definition mdbx.h:631

MDBX_bunch_action_t
MDBX_bunch_action_t
Modes for deleting bunches of neighboring items with self-documenting names.
Definition mdbx.h:6227

mdbx_cursor_del
LIBMDBX_API int mdbx_cursor_del(MDBX_cursor *cursor, MDBX_put_flags_t flags)
Delete current key/data pair.

MDBX_preserve_func
int(* MDBX_preserve_func)(void *context, MDBX_val *target, const void *src, size_t bytes)
A data preservation callback for using within mdbx_replace_ex().
Definition mdbx.h:5463

mdbx_dbi_sequence
LIBMDBX_API int mdbx_dbi_sequence(MDBX_txn *txn, MDBX_dbi dbi, uint64_t *result, uint64_t increment)
Sequence generation for a table.

mdbx_get_equal_or_great
LIBMDBX_API int mdbx_get_equal_or_great(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_val *key, MDBX_val *data)
Get equal or great item from a table.

mdbx_cursor_scan
LIBMDBX_API int mdbx_cursor_scan(MDBX_cursor *cursor, MDBX_predicate_func *predicate, void *context, MDBX_cursor_op start_op, MDBX_cursor_op turn_op, void *arg)
Scans the table using the passed predicate, reducing the associated overhead.

mdbx_canary_put
LIBMDBX_API int mdbx_canary_put(MDBX_txn *txn, const MDBX_canary *canary)
Set integers markers (aka "canary") associated with the environment.

mdbx_canary_get
LIBMDBX_API int mdbx_canary_get(const MDBX_txn *txn, MDBX_canary *canary)
Returns fours integers markers (aka "canary") associated with the environment.

MDBX_put_flags_t
MDBX_put_flags_t
Data changing flags.
Definition mdbx.h:1629

mdbx_cache_get
LIBMDBX_API MDBX_cache_result_t mdbx_cache_get(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data, volatile MDBX_cache_entry_t *entry)
Gets items from a table using cache including multithreaded cases.

mdbx_replace_ex
LIBMDBX_API int mdbx_replace_ex(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *new_data, MDBX_val *old_data, MDBX_put_flags_t flags, MDBX_preserve_func preserver, void *preserver_context)
Replaces item in a table using preservation callback for an original data.

mdbx_cursor_get_batch
LIBMDBX_API int mdbx_cursor_get_batch(MDBX_cursor *cursor, size_t *count, MDBX_val *pairs, size_t limit, MDBX_cursor_op op)
Retrieve multiple non-dupsort key/value pairs by cursor.

mdbx_cursor_count
LIBMDBX_API int mdbx_cursor_count(const MDBX_cursor *cursor, size_t *count)
Return count values (aka duplicates) for current key.

mdbx_cursor_count_ex
LIBMDBX_API int mdbx_cursor_count_ex(const MDBX_cursor *cursor, size_t *count, MDBX_stat *stat, size_t bytes)
Return count values (aka duplicates) and nested b-tree statistics for current key.

MDBX_cache_status_t
MDBX_cache_status_t
Cache entry status returned by mdbx_cache_get().
Definition mdbx.h:5195

mdbx_cache_get_SingleThreaded
LIBMDBX_API MDBX_cache_result_t mdbx_cache_get_SingleThreaded(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data, MDBX_cache_entry_t *entry)
Gets items from a table using cache within single-thread cases only.

mdbx_cursor_scan_from
LIBMDBX_API int mdbx_cursor_scan_from(MDBX_cursor *cursor, MDBX_predicate_func *predicate, void *context, MDBX_cursor_op from_op, MDBX_val *from_key, MDBX_val *from_value, MDBX_cursor_op turn_op, void *arg)

mdbx_cmp
LIBMDBX_API int mdbx_cmp(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *a, const MDBX_val *b)
Compare two keys according to a particular table.

mdbx_cache_init
void mdbx_cache_init(MDBX_cache_entry_t *entry)
Initializes the cache entry before the first use.
Definition mdbx.h:5184

MDBX_cmp_func
int MDBX_cmp_func(const MDBX_val *a, const MDBX_val *b) noexcept
A callback function used to compare two keys in a table.
Definition mdbx.h:4723

mdbx_del
LIBMDBX_API int mdbx_del(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, const MDBX_val *data)
Delete items from a table.

mdbx_replace
LIBMDBX_API int mdbx_replace(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *new_data, MDBX_val *old_data, MDBX_put_flags_t flags)
Replaces item in a table.

mdbx_get_ex
LIBMDBX_API int mdbx_get_ex(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_val *key, MDBX_val *data, size_t *values_count)
Get items from a table and optionally number of data items for a given key.

MDBX_predicate_func
int MDBX_predicate_func(void *context, MDBX_val *key, MDBX_val *value, void *arg) noexcept
The type of predicative callback functions used by mdbx_cursor_scan() and mdbx_cursor_scan_from() to ...
Definition mdbx.h:5933

mdbx_cursor_bunch_delete
LIBMDBX_API int mdbx_cursor_bunch_delete(MDBX_cursor *cursor, MDBX_bunch_action_t action, uint64_t *number_of_affected)
Quickly removes bunches of neighboring items.

mdbx_cursor_put
LIBMDBX_API int mdbx_cursor_put(MDBX_cursor *cursor, const MDBX_val *key, MDBX_val *data, MDBX_put_flags_t flags)
Store by cursor.

mdbx_put
LIBMDBX_API int mdbx_put(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data, MDBX_put_flags_t flags)
Store items into a table.

mdbx_drop
LIBMDBX_API int mdbx_drop(MDBX_txn *txn, MDBX_dbi dbi, bool del)
Empty or delete and close a table.

mdbx_dcmp
LIBMDBX_API int mdbx_dcmp(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *a, const MDBX_val *b)
Compare two data items according to a particular table.

mdbx_cursor_get
LIBMDBX_API int mdbx_cursor_get(MDBX_cursor *cursor, MDBX_val *key, MDBX_val *data, MDBX_cursor_op op)
Retrieve by cursor.

mdbx_get
LIBMDBX_API int mdbx_get(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data)
Get items from a table.

MDBX_DELETE_AFTER_INCLUDING
@ MDBX_DELETE_AFTER_INCLUDING
Definition mdbx.h:6236

MDBX_DELETE_BEFORE_INCLUDING
@ MDBX_DELETE_BEFORE_INCLUDING
Definition mdbx.h:6235

MDBX_DELETE_WHOLE
@ MDBX_DELETE_WHOLE
Definition mdbx.h:6238

MDBX_DELETE_BEFORE_EXCLUDING
@ MDBX_DELETE_BEFORE_EXCLUDING
Definition mdbx.h:6234

MDBX_DELETE_CURRENT_VALUE
@ MDBX_DELETE_CURRENT_VALUE
Definition mdbx.h:6228

MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_EXCLUDING
@ MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_EXCLUDING
Definition mdbx.h:6229

MDBX_DELETE_AFTER_EXCLUDING
@ MDBX_DELETE_AFTER_EXCLUDING
Definition mdbx.h:6237

MDBX_DELETE_CURRENT_MULTIVAL_ALL
@ MDBX_DELETE_CURRENT_MULTIVAL_ALL
Definition mdbx.h:6233

MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_INCLUDING
@ MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_INCLUDING
Definition mdbx.h:6230

MDBX_DELETE_CURRENT_MULTIVAL_AFTER_INCLUDING
@ MDBX_DELETE_CURRENT_MULTIVAL_AFTER_INCLUDING
Definition mdbx.h:6231

MDBX_DELETE_CURRENT_MULTIVAL_AFTER_EXCLUDING
@ MDBX_DELETE_CURRENT_MULTIVAL_AFTER_EXCLUDING
Definition mdbx.h:6232

MDBX_MULTIPLE
@ MDBX_MULTIPLE
Definition mdbx.h:1666

MDBX_ALLDUPS
@ MDBX_ALLDUPS
Definition mdbx.h:1649

MDBX_CURRENT
@ MDBX_CURRENT
Definition mdbx.h:1644

MDBX_APPENDDUP
@ MDBX_APPENDDUP
Definition mdbx.h:1662

MDBX_NODUPDATA
@ MDBX_NODUPDATA
Definition mdbx.h:1638

MDBX_APPEND
@ MDBX_APPEND
Definition mdbx.h:1657

MDBX_UPSERT
@ MDBX_UPSERT
Definition mdbx.h:1631

MDBX_RESERVE
@ MDBX_RESERVE
Definition mdbx.h:1653

MDBX_NOOVERWRITE
@ MDBX_NOOVERWRITE
Definition mdbx.h:1634

MDBX_CACHE_DIRTY
@ MDBX_CACHE_DIRTY
The result of getting a value is correct, but it cannot be cached since the changes have not been com...
Definition mdbx.h:5237

MDBX_CACHE_UNABLE
@ MDBX_CACHE_UNABLE
The result of getting a value is correct, but it cannot be cached since there the ABA-like issue is i...
Definition mdbx.h:5219

MDBX_CACHE_HIT
@ MDBX_CACHE_HIT
The result of getting a value is correct and was retrieved from the cache entry which is untouched.
Definition mdbx.h:5245

MDBX_CACHE_CONFIRMED
@ MDBX_CACHE_CONFIRMED
The result of getting a value is correct and has been retrieved from the cache, which has been altere...
Definition mdbx.h:5253

MDBX_CACHE_ERROR
@ MDBX_CACHE_ERROR
The error other than MDBX_NOTFOUND has occurred.
Definition mdbx.h:5200

MDBX_CACHE_RACE
@ MDBX_CACHE_RACE
The result was obtained by bypassing the cache, because the given cache entry being updated by anothe...
Definition mdbx.h:5228

MDBX_CACHE_BEHIND
@ MDBX_CACHE_BEHIND
The result was obtained by bypassing the cache, because the transaction is too old to using the cache...
Definition mdbx.h:5208

MDBX_CACHE_REFRESHED
@ MDBX_CACHE_REFRESHED
The result of getting a value is correct and corresponds to the fresh data readed from the database,...
Definition mdbx.h:5263

mdbx_cursor_on_first_dup
LIBMDBX_API int mdbx_cursor_on_first_dup(const MDBX_cursor *cursor)
Determines whether the cursor is on the first or single multi-value corresponding to the key.

mdbx_cursor_open
LIBMDBX_API int mdbx_cursor_open(MDBX_txn *txn, MDBX_dbi dbi, MDBX_cursor **cursor)
Create a cursor handle for the specified transaction and DBI handle.

mdbx_txn_release_all_cursors
int mdbx_txn_release_all_cursors(const MDBX_txn *txn, bool unbind)
Unbind or closes all cursors of a given transaction and of all its parent transactions if ones are.
Definition mdbx.h:5785

mdbx_cursor_unbind
LIBMDBX_API int mdbx_cursor_unbind(MDBX_cursor *cursor)
Unbind cursor from a transaction.

mdbx_cursor_create
LIBMDBX_API MDBX_cursor * mdbx_cursor_create(void *context)
Create a cursor handle but not bind it to transaction nor DBI-handle.

mdbx_cursor_dbi
LIBMDBX_API MDBX_dbi mdbx_cursor_dbi(const MDBX_cursor *cursor)
Return the cursor's table handle.

MDBX_cursor_op
MDBX_cursor_op
Cursor operationsThis is the set of all operations for retrieving data using a cursor.
Definition mdbx.h:1710

mdbx_cursor_compare
LIBMDBX_API int mdbx_cursor_compare(const MDBX_cursor *left, const MDBX_cursor *right, bool ignore_multival)
Compares the position of the cursors.

mdbx_cursor_on_last_dup
LIBMDBX_API int mdbx_cursor_on_last_dup(const MDBX_cursor *cursor)
Determines whether the cursor is on the last or single multi-value corresponding to the key.

mdbx_cursor_on_first
LIBMDBX_API int mdbx_cursor_on_first(const MDBX_cursor *cursor)
Determines whether the cursor is pointed to the first key-value pair or not.

mdbx_cursor_bind
LIBMDBX_API int mdbx_cursor_bind(MDBX_txn *txn, MDBX_cursor *cursor, MDBX_dbi dbi)
Bind cursor to specified transaction and DBI-handle.

mdbx_cursor_reset
LIBMDBX_API int mdbx_cursor_reset(MDBX_cursor *cursor)
Resets the cursor state.

mdbx_txn_release_all_cursors_ex
LIBMDBX_API int mdbx_txn_release_all_cursors_ex(const MDBX_txn *txn, bool unbind, size_t *count)
Unbind or closes all cursors of a given transaction and of all its parent transactions if ones are.

MDBX_cursor
struct MDBX_cursor MDBX_cursor
Opaque structure for navigating through a table.
Definition mdbx.h:743

mdbx_cursor_set_userctx
LIBMDBX_API int mdbx_cursor_set_userctx(MDBX_cursor *cursor, void *ctx)
Set application information associated with the cursor.

mdbx_cursor_eof
LIBMDBX_API int mdbx_cursor_eof(const MDBX_cursor *cursor)
Determines whether the cursor is pointed to a key-value pair or not, i.e. was not positioned or point...

mdbx_cursor_close2
LIBMDBX_API int mdbx_cursor_close2(MDBX_cursor *cursor)
Closes a cursor handle with returning error code.

mdbx_cursor_get_userctx
LIBMDBX_API void * mdbx_cursor_get_userctx(const MDBX_cursor *cursor)
Get the application information associated with the MDBX_cursor.

mdbx_cursor_renew
LIBMDBX_API int mdbx_cursor_renew(MDBX_txn *txn, MDBX_cursor *cursor)
Renew a cursor handle for use within the given transaction.

mdbx_cursor_close
LIBMDBX_API void mdbx_cursor_close(MDBX_cursor *cursor)
Closes a cursor handle without returning error code.

mdbx_cursor_txn
LIBMDBX_API MDBX_txn * mdbx_cursor_txn(const MDBX_cursor *cursor)
Return the cursor's transaction handle.

mdbx_cursor_on_last
LIBMDBX_API int mdbx_cursor_on_last(const MDBX_cursor *cursor)
Determines whether the cursor is pointed to the last key-value pair or not.

mdbx_cursor_copy
LIBMDBX_API int mdbx_cursor_copy(const MDBX_cursor *src, MDBX_cursor *dest)
Copy cursor position and state.

MDBX_SET_LOWERBOUND
@ MDBX_SET_LOWERBOUND
Definition mdbx.h:1787

MDBX_SEEK_AND_GET_MULTIPLE
@ MDBX_SEEK_AND_GET_MULTIPLE
Definition mdbx.h:1829

MDBX_GET_CURRENT
@ MDBX_GET_CURRENT
Definition mdbx.h:1725

MDBX_GET_BOTH
@ MDBX_GET_BOTH
Definition mdbx.h:1718

MDBX_TO_KEY_EQUAL
@ MDBX_TO_KEY_EQUAL
Definition mdbx.h:1806

MDBX_GET_BOTH_RANGE
@ MDBX_GET_BOTH_RANGE
Definition mdbx.h:1722

MDBX_SET_KEY
@ MDBX_SET_KEY
Definition mdbx.h:1765

MDBX_FIRST_DUP
@ MDBX_FIRST_DUP
Definition mdbx.h:1715

MDBX_TO_KEY_LESSER_OR_EQUAL
@ MDBX_TO_KEY_LESSER_OR_EQUAL
Definition mdbx.h:1805

MDBX_GET_MULTIPLE
@ MDBX_GET_MULTIPLE
Definition mdbx.h:1730

MDBX_TO_EXACT_KEY_VALUE_GREATER_THAN
@ MDBX_TO_EXACT_KEY_VALUE_GREATER_THAN
Definition mdbx.h:1816

MDBX_NEXT_NODUP
@ MDBX_NEXT_NODUP
Definition mdbx.h:1750

MDBX_TO_EXACT_KEY_VALUE_LESSER_OR_EQUAL
@ MDBX_TO_EXACT_KEY_VALUE_LESSER_OR_EQUAL
Definition mdbx.h:1813

MDBX_TO_EXACT_KEY_VALUE_EQUAL
@ MDBX_TO_EXACT_KEY_VALUE_EQUAL
Definition mdbx.h:1814

MDBX_TO_PAIR_LESSER_OR_EQUAL
@ MDBX_TO_PAIR_LESSER_OR_EQUAL
Definition mdbx.h:1821

MDBX_PREV_MULTIPLE
@ MDBX_PREV_MULTIPLE
Definition mdbx.h:1773

MDBX_SET_RANGE
@ MDBX_SET_RANGE
Definition mdbx.h:1768

MDBX_LAST_DUP
@ MDBX_LAST_DUP
Definition mdbx.h:1736

MDBX_PREV
@ MDBX_PREV
Definition mdbx.h:1753

MDBX_TO_PAIR_GREATER_OR_EQUAL
@ MDBX_TO_PAIR_GREATER_OR_EQUAL
Definition mdbx.h:1823

MDBX_TO_PAIR_GREATER_THAN
@ MDBX_TO_PAIR_GREATER_THAN
Definition mdbx.h:1824

MDBX_LAST
@ MDBX_LAST
Definition mdbx.h:1733

MDBX_TO_KEY_LESSER_THAN
@ MDBX_TO_KEY_LESSER_THAN
Definition mdbx.h:1804

MDBX_PREV_DUP
@ MDBX_PREV_DUP
Definition mdbx.h:1756

MDBX_TO_EXACT_KEY_VALUE_LESSER_THAN
@ MDBX_TO_EXACT_KEY_VALUE_LESSER_THAN
Definition mdbx.h:1812

MDBX_SET
@ MDBX_SET
Definition mdbx.h:1762

MDBX_NEXT
@ MDBX_NEXT
Definition mdbx.h:1739

MDBX_TO_KEY_GREATER_OR_EQUAL
@ MDBX_TO_KEY_GREATER_OR_EQUAL
Definition mdbx.h:1807

MDBX_TO_PAIR_LESSER_THAN
@ MDBX_TO_PAIR_LESSER_THAN
Definition mdbx.h:1820

MDBX_NEXT_MULTIPLE
@ MDBX_NEXT_MULTIPLE
Definition mdbx.h:1747

MDBX_PREV_NODUP
@ MDBX_PREV_NODUP
Definition mdbx.h:1759

MDBX_TO_PAIR_EQUAL
@ MDBX_TO_PAIR_EQUAL
Definition mdbx.h:1822

MDBX_NEXT_DUP
@ MDBX_NEXT_DUP
Definition mdbx.h:1742

MDBX_TO_EXACT_KEY_VALUE_GREATER_OR_EQUAL
@ MDBX_TO_EXACT_KEY_VALUE_GREATER_OR_EQUAL
Definition mdbx.h:1815

MDBX_SET_UPPERBOUND
@ MDBX_SET_UPPERBOUND
Definition mdbx.h:1801

MDBX_TO_KEY_GREATER_THAN
@ MDBX_TO_KEY_GREATER_THAN
Definition mdbx.h:1808

MDBX_FIRST
@ MDBX_FIRST
Definition mdbx.h:1712

mdbx_dbi_open_ex2
LIBMDBX_API int mdbx_dbi_open_ex2(MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags, MDBX_dbi *dbi, MDBX_cmp_func *keycmp, MDBX_cmp_func *datacmp)
Open or Create a named table in the environment with using custom comparison functions.

mdbx_dbi_open_ex
LIBMDBX_API int mdbx_dbi_open_ex(MDBX_txn *txn, const char *name, MDBX_db_flags_t flags, MDBX_dbi *dbi, MDBX_cmp_func *keycmp, MDBX_cmp_func *datacmp)
Open or Create a named table in the environment with using custom comparison functions.

mdbx_dbi_rename
LIBMDBX_API int mdbx_dbi_rename(MDBX_txn *txn, MDBX_dbi dbi, const char *name)
Renames the table using the DBI descriptor.

mdbx_dbi_rename2
LIBMDBX_API int mdbx_dbi_rename2(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *name)
Renames the table using the DBI descriptor.

mdbx_dbi_close
LIBMDBX_API int mdbx_dbi_close(MDBX_env *env, MDBX_dbi dbi)
Close a table handle. Normally unnecessary.

mdbx_dbi_open
LIBMDBX_API int mdbx_dbi_open(MDBX_txn *txn, const char *name, MDBX_db_flags_t flags, MDBX_dbi *dbi)
Open or Create a named table in the environment.

mdbx_dbi_open2
LIBMDBX_API int mdbx_dbi_open2(MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags, MDBX_dbi *dbi)
Open or Create a named table in the environment.

MDBX_dbi
uint32_t MDBX_dbi
A handle for an individual table (key-value spaces) in the environment.
Definition mdbx.h:736

MDBX_db_flags_t
MDBX_db_flags_t
Table flags.
Definition mdbx.h:1579

MDBX_INTEGERDUP
@ MDBX_INTEGERDUP
Definition mdbx.h:1603

MDBX_DB_ACCEDE
@ MDBX_DB_ACCEDE
Definition mdbx.h:1621

MDBX_DB_DEFAULTS
@ MDBX_DB_DEFAULTS
Definition mdbx.h:1581

MDBX_REVERSEKEY
@ MDBX_REVERSEKEY
Definition mdbx.h:1584

MDBX_DUPFIXED
@ MDBX_DUPFIXED
Definition mdbx.h:1598

MDBX_INTEGERKEY
@ MDBX_INTEGERKEY
Definition mdbx.h:1594

MDBX_REVERSEDUP
@ MDBX_REVERSEDUP
Definition mdbx.h:1606

MDBX_CREATE
@ MDBX_CREATE
Definition mdbx.h:1609

MDBX_DUPSORT
@ MDBX_DUPSORT
Definition mdbx.h:1587

mdbx_dump_val
LIBMDBX_API const char * mdbx_dump_val(const MDBX_val *key, char *const buf, const size_t bufsize)
Dump given MDBX_val to the buffer.

mdbx_panic
MDBX_NORETURN LIBMDBX_API void mdbx_panic(const char *fmt,...) MDBX_PRINTF_ARGS(1
Panics with message and causes abnormal process termination.

MDBX_debug_func_nofmt
void MDBX_debug_func_nofmt(MDBX_log_level_t loglevel, const char *function, int line, const char *msg, unsigned length) noexcept
Definition mdbx.h:982

MDBX_assert_func
void MDBX_assert_func(const MDBX_env *env, const char *msg, const char *function, unsigned line) noexcept
A callback function for most MDBX assert() failures, called before printing the message and aborting.
Definition mdbx.h:998

MDBX_log_level_t
MDBX_log_level_t
Definition mdbx.h:856

MDBX_debug_flags_t
MDBX_debug_flags_t
Runtime debug flags.
Definition mdbx.h:915

mdbx_env_set_assert
LIBMDBX_API int mdbx_env_set_assert(MDBX_env *env, MDBX_assert_func *func)
Set or reset the assert() callback of the environment.

mdbx_assert_fail
MDBX_NORETURN LIBMDBX_API void MDBX_NORETURN LIBMDBX_API void mdbx_assert_fail(const MDBX_env *env, const char *msg, const char *func, unsigned line)
Panics with asserton failed message and causes abnormal process termination.

MDBX_debug_func
void MDBX_debug_func(MDBX_log_level_t loglevel, const char *function, int line, const char *fmt, va_list args) noexcept
A debug-logger callback function, called before printing the message and aborting.
Definition mdbx.h:968

mdbx_setup_debug
LIBMDBX_API int mdbx_setup_debug(MDBX_log_level_t log_level, MDBX_debug_flags_t debug_flags, MDBX_debug_func *logger)
Setup global log-level, debug options and debug logger.

mdbx_setup_debug_nofmt
LIBMDBX_API int mdbx_setup_debug_nofmt(MDBX_log_level_t log_level, MDBX_debug_flags_t debug_flags, MDBX_debug_func_nofmt *logger, char *logger_buffer, size_t logger_buffer_size)

MDBX_LOG_EXTRA
@ MDBX_LOG_EXTRA
Definition mdbx.h:898

MDBX_LOG_WARN
@ MDBX_LOG_WARN
Definition mdbx.h:872

MDBX_LOG_TRACE
@ MDBX_LOG_TRACE
Definition mdbx.h:893

MDBX_LOG_DEBUG
@ MDBX_LOG_DEBUG
Definition mdbx.h:888

MDBX_LOG_FATAL
@ MDBX_LOG_FATAL
Definition mdbx.h:860

MDBX_LOG_ERROR
@ MDBX_LOG_ERROR
Definition mdbx.h:866

MDBX_LOG_NOTICE
@ MDBX_LOG_NOTICE
Definition mdbx.h:878

MDBX_LOG_DONTCHANGE
@ MDBX_LOG_DONTCHANGE
Definition mdbx.h:905

MDBX_LOG_VERBOSE
@ MDBX_LOG_VERBOSE
Definition mdbx.h:883

MDBX_DBG_ASSERT
@ MDBX_DBG_ASSERT
Definition mdbx.h:921

MDBX_DBG_DONT_UPGRADE
@ MDBX_DBG_DONT_UPGRADE
Definition mdbx.h:943

MDBX_DBG_LEGACY_OVERLAP
@ MDBX_DBG_LEGACY_OVERLAP
Definition mdbx.h:939

MDBX_DBG_LEGACY_MULTIOPEN
@ MDBX_DBG_LEGACY_MULTIOPEN
Definition mdbx.h:936

MDBX_DBG_NONE
@ MDBX_DBG_NONE
Definition mdbx.h:916

MDBX_DBG_DUMP
@ MDBX_DBG_DUMP
Definition mdbx.h:933

MDBX_DBG_DONTCHANGE
@ MDBX_DBG_DONTCHANGE
Definition mdbx.h:950

MDBX_DBG_AUDIT
@ MDBX_DBG_AUDIT
Definition mdbx.h:925

MDBX_DBG_JITTER
@ MDBX_DBG_JITTER
Definition mdbx.h:929

mdbx_env_set_hsr
LIBMDBX_API int mdbx_env_set_hsr(MDBX_env *env, MDBX_hsr_func *hsr_callback)
Sets a Handle-Slow-Readers callback to resolve database full/overflow issue due to a reader(s) which ...

mdbx_strerror
LIBMDBX_API const char * mdbx_strerror(int errnum)
Return a string describing a given error code.

MDBX_hsr_func
int MDBX_hsr_func(const MDBX_env *env, const MDBX_txn *txn, mdbx_pid_t pid, mdbx_tid_t tid, uint64_t laggard, unsigned gap, size_t space, int retry) noexcept
A Handle-Slow-Readers callback function to resolve database full/overflow issue due to a reader(s) wh...
Definition mdbx.h:6754

mdbx_strerror_ANSI2OEM
LIBMDBX_API const char * mdbx_strerror_ANSI2OEM(int errnum)

MDBX_error_t
MDBX_error_t
Errors and return codes.
Definition mdbx.h:1837

mdbx_strerror_r
LIBMDBX_API const char * mdbx_strerror_r(int errnum, char *buf, size_t buflen)
Return a string describing a given error code.

mdbx_strerror_r_ANSI2OEM
LIBMDBX_API const char * mdbx_strerror_r_ANSI2OEM(int errnum, char *buf, size_t buflen)

MDBX_PANIC
@ MDBX_PANIC
Definition mdbx.h:1864

MDBX_FIRST_LMDB_ERRCODE
@ MDBX_FIRST_LMDB_ERRCODE
Definition mdbx.h:1851

MDBX_EKEYMISMATCH
@ MDBX_EKEYMISMATCH
Definition mdbx.h:1952

MDBX_UNABLE_EXTEND_MAPSIZE
@ MDBX_UNABLE_EXTEND_MAPSIZE
Definition mdbx.h:1898

MDBX_EACCESS
@ MDBX_EACCESS
Definition mdbx.h:2011

MDBX_EIO
@ MDBX_EIO
Definition mdbx.h:2019

MDBX_PAGE_NOTFOUND
@ MDBX_PAGE_NOTFOUND
Definition mdbx.h:1857

MDBX_TXN_FULL
@ MDBX_TXN_FULL
Definition mdbx.h:1882

MDBX_DUPLICATED_CLK
@ MDBX_DUPLICATED_CLK
Definition mdbx.h:1971

MDBX_VERSION_MISMATCH
@ MDBX_VERSION_MISMATCH
Definition mdbx.h:1867

MDBX_WANNA_RECOVERY
@ MDBX_WANNA_RECOVERY
Definition mdbx.h:1949

MDBX_TXN_OVERLAPPING
@ MDBX_TXN_OVERLAPPING
Definition mdbx.h:1963

MDBX_EREMOTE
@ MDBX_EREMOTE
Definition mdbx.h:2025

MDBX_TOO_LARGE
@ MDBX_TOO_LARGE
Definition mdbx.h:1956

MDBX_EBADSIGN
@ MDBX_EBADSIGN
Definition mdbx.h:1945

MDBX_CURSOR_FULL
@ MDBX_CURSOR_FULL
Definition mdbx.h:1886

MDBX_ENOFILE
@ MDBX_ENOFILE
Definition mdbx.h:2022

MDBX_BAD_TXN
@ MDBX_BAD_TXN
Definition mdbx.h:1916

MDBX_ENODATA
@ MDBX_ENODATA
Definition mdbx.h:2006

MDBX_LAST_LMDB_ERRCODE
@ MDBX_LAST_LMDB_ERRCODE
Definition mdbx.h:1930

MDBX_CORRUPTED
@ MDBX_CORRUPTED
Definition mdbx.h:1860

MDBX_EPERM
@ MDBX_EPERM
Definition mdbx.h:2020

MDBX_THREAD_MISMATCH
@ MDBX_THREAD_MISMATCH
Definition mdbx.h:1960

MDBX_BACKLOG_DEPLETED
@ MDBX_BACKLOG_DEPLETED
Definition mdbx.h:1968

MDBX_SUCCESS
@ MDBX_SUCCESS
Definition mdbx.h:1839

MDBX_NOTFOUND
@ MDBX_NOTFOUND
Definition mdbx.h:1854

MDBX_LAGGARD_READER
@ MDBX_LAGGARD_READER
Definition mdbx.h:1986

MDBX_RESULT_TRUE
@ MDBX_RESULT_TRUE
Definition mdbx.h:1845

MDBX_INVALID
@ MDBX_INVALID
Definition mdbx.h:1870

MDBX_BAD_VALSIZE
@ MDBX_BAD_VALSIZE
Definition mdbx.h:1920

MDBX_BUSY
@ MDBX_BUSY
Definition mdbx.h:1934

MDBX_OUSTED
@ MDBX_OUSTED
Definition mdbx.h:1979

MDBX_DBS_FULL
@ MDBX_DBS_FULL
Definition mdbx.h:1876

MDBX_EINVAL
@ MDBX_EINVAL
Definition mdbx.h:2010

MDBX_BAD_RSLOT
@ MDBX_BAD_RSLOT
Definition mdbx.h:1911

MDBX_ENOMEM
@ MDBX_ENOMEM
Definition mdbx.h:2012

MDBX_FIRST_ADDED_ERRCODE
@ MDBX_FIRST_ADDED_ERRCODE
Definition mdbx.h:1937

MDBX_RESULT_FALSE
@ MDBX_RESULT_FALSE
Definition mdbx.h:1842

MDBX_EINTR
@ MDBX_EINTR
Definition mdbx.h:2021

MDBX_READERS_FULL
@ MDBX_READERS_FULL
Definition mdbx.h:1879

MDBX_LAST_ADDED_ERRCODE
@ MDBX_LAST_ADDED_ERRCODE
Definition mdbx.h:1989

MDBX_BAD_DBI
@ MDBX_BAD_DBI
Definition mdbx.h:1924

MDBX_KEYEXIST
@ MDBX_KEYEXIST
Definition mdbx.h:1848

MDBX_DANGLING_DBI
@ MDBX_DANGLING_DBI
Definition mdbx.h:1975

MDBX_EDEADLK
@ MDBX_EDEADLK
Definition mdbx.h:2029

MDBX_PAGE_FULL
@ MDBX_PAGE_FULL
Definition mdbx.h:1889

MDBX_MAP_FULL
@ MDBX_MAP_FULL
Definition mdbx.h:1873

MDBX_PROBLEM
@ MDBX_PROBLEM
Definition mdbx.h:1927

MDBX_ENOSYS
@ MDBX_ENOSYS
Definition mdbx.h:2015

MDBX_EMULTIVAL
@ MDBX_EMULTIVAL
Definition mdbx.h:1940

MDBX_EROFS
@ MDBX_EROFS
Definition mdbx.h:2013

MDBX_MVCC_RETARDED
@ MDBX_MVCC_RETARDED
Definition mdbx.h:1982

MDBX_INCOMPATIBLE
@ MDBX_INCOMPATIBLE
Definition mdbx.h:1908

mdbx_get_datacmp
LIBMDBX_API MDBX_cmp_func * mdbx_get_datacmp(MDBX_db_flags_t flags)
Returns default internal data's comparator for given table flags.

mdbx_reader_check
LIBMDBX_API int mdbx_reader_check(MDBX_env *env, int *dead)
Check for stale entries in the reader lock table.

mdbx_env_copy
LIBMDBX_API int mdbx_env_copy(MDBX_env *env, const char *dest, MDBX_copy_flags_t flags)
Copy an MDBX environment to the specified path, with options.

mdbx_txn_copy2pathname
LIBMDBX_API int mdbx_txn_copy2pathname(MDBX_txn *txn, const char *dest, MDBX_copy_flags_t flags)
Copy an MDBX environment by given read transaction to the specified path, with options.

MDBX_copy_flags_t
MDBX_copy_flags_t
Environment copy flags.
Definition mdbx.h:1673

mdbx_env_sync
int mdbx_env_sync(MDBX_env *env)
The shortcut to calling mdbx_env_sync_ex() with the force=true and nonblock=false arguments.
Definition mdbx.h:2952

mdbx_get_keycmp
LIBMDBX_API MDBX_cmp_func * mdbx_get_keycmp(MDBX_db_flags_t flags)
Returns default internal key's comparator for given table flags.

mdbx_is_readahead_reasonable
LIBMDBX_API int mdbx_is_readahead_reasonable(size_t volume, intptr_t redundancy)
Find out whether to use readahead or not, based on the given database size and the amount of availabl...

mdbx_thread_register
LIBMDBX_API int mdbx_thread_register(const MDBX_env *env)
Registers the current thread as a reader for the environment.

mdbx_env_sync_poll
int mdbx_env_sync_poll(MDBX_env *env)
The shortcut to calling mdbx_env_sync_ex() with the force=false and nonblock=true arguments.
Definition mdbx.h:2957

mdbx_env_deleteW
LIBMDBX_API int mdbx_env_deleteW(const wchar_t *pathname, MDBX_env_delete_mode_t mode)
Delete the environment's files in a proper and multiprocess-safe way.

mdbx_env_resurrect_after_fork
LIBMDBX_API int mdbx_env_resurrect_after_fork(MDBX_env *env)
Restores an instance of the environment in a child process after forking the parent process using for...

MDBX_env_delete_mode_t
MDBX_env_delete_mode_t
Deletion modes for mdbx_env_delete().
Definition mdbx.h:2520

mdbx_env_copy2fd
LIBMDBX_API int mdbx_env_copy2fd(MDBX_env *env, mdbx_filehandle_t fd, MDBX_copy_flags_t flags)
Copy an environment to the specified file descriptor, with options.

mdbx_cursor_ignord
LIBMDBX_API int mdbx_cursor_ignord(MDBX_cursor *cursor)
An auxiliary function for use in tools.

mdbx_env_copyW
LIBMDBX_API int mdbx_env_copyW(MDBX_env *env, const wchar_t *dest, MDBX_copy_flags_t flags)
Copy an MDBX environment to the specified path, with options.

mdbx_thread_unregister
LIBMDBX_API int mdbx_thread_unregister(const MDBX_env *env)
Unregisters the current thread as a reader for the environment.

mdbx_env_sync_ex
LIBMDBX_API int mdbx_env_sync_ex(MDBX_env *env, bool force, bool nonblock)
Flush the environment data buffers to disk.

mdbx_txn_copy2fd
LIBMDBX_API int mdbx_txn_copy2fd(MDBX_txn *txn, mdbx_filehandle_t fd, MDBX_copy_flags_t flags)
Copy an environment by given read transaction to the specified file descriptor, with options.

mdbx_env_delete
LIBMDBX_API int mdbx_env_delete(const char *pathname, MDBX_env_delete_mode_t mode)
Delete the environment's files in a proper and multiprocess-safe way.

mdbx_env_open_for_recoveryW
LIBMDBX_API int mdbx_env_open_for_recoveryW(MDBX_env *env, const wchar_t *pathname, unsigned target_meta, bool writeable)
Open an environment instance using specific meta-page for checking and recovery.

mdbx_txn_copy2pathnameW
LIBMDBX_API int mdbx_txn_copy2pathnameW(MDBX_txn *txn, const wchar_t *dest, MDBX_copy_flags_t flags)
Copy an MDBX environment by given read transaction to the specified path, with options.

MDBX_CP_DISPOSE_TXN
@ MDBX_CP_DISPOSE_TXN
Definition mdbx.h:1692

MDBX_CP_DEFAULTS
@ MDBX_CP_DEFAULTS
Definition mdbx.h:1674

MDBX_CP_COMPACT
@ MDBX_CP_COMPACT
Definition mdbx.h:1678

MDBX_CP_RENEW_TXN
@ MDBX_CP_RENEW_TXN
Definition mdbx.h:1697

MDBX_CP_THROTTLE_MVCC
@ MDBX_CP_THROTTLE_MVCC
Definition mdbx.h:1688

MDBX_CP_FORCE_DYNAMIC_SIZE
@ MDBX_CP_FORCE_DYNAMIC_SIZE
Definition mdbx.h:1681

MDBX_CP_DONT_FLUSH
@ MDBX_CP_DONT_FLUSH
Definition mdbx.h:1684

MDBX_CP_OVERWRITE
@ MDBX_CP_OVERWRITE
Definition mdbx.h:1701

MDBX_ENV_WAIT_FOR_UNUSED
@ MDBX_ENV_WAIT_FOR_UNUSED
Wait until other processes closes the environment before deletion.
Definition mdbx.h:2532

MDBX_ENV_JUST_DELETE
@ MDBX_ENV_JUST_DELETE
Just delete the environment's files and directory if any.
Definition mdbx.h:2527

MDBX_ENV_ENSURE_UNUSED
@ MDBX_ENV_ENSURE_UNUSED
Make sure that the environment is not being used by other processes, or return an error otherwise.
Definition mdbx.h:2530

mdbx_env_create
LIBMDBX_API int mdbx_env_create(MDBX_env **penv)
Create an MDBX environment instance.

mdbx_env_close
int mdbx_env_close(MDBX_env *env)
The shortcut to calling mdbx_env_close_ex() with the dont_sync=false argument.
Definition mdbx.h:3120

MDBX_env_flags_t
MDBX_env_flags_t
Environment flags.
Definition mdbx.h:1038

mdbx_env_close_ex
LIBMDBX_API int mdbx_env_close_ex(MDBX_env *env, bool dont_sync)
Close the environment and release the memory map.

mdbx_preopen_snapinfoW
LIBMDBX_API int mdbx_preopen_snapinfoW(const wchar_t *pathname, MDBX_envinfo *info, size_t bytes)
Gets basic information about the database without opening it.

mdbx_env_open
LIBMDBX_API int mdbx_env_open(MDBX_env *env, const char *pathname, MDBX_env_flags_t flags, mdbx_mode_t mode)
Open an environment instance.

mdbx_preopen_snapinfo
LIBMDBX_API int mdbx_preopen_snapinfo(const char *pathname, MDBX_envinfo *info, size_t bytes)
Gets basic information about the database without opening it.

MDBX_NORDAHEAD
@ MDBX_NORDAHEAD
Definition mdbx.h:1232

MDBX_ENV_DEFAULTS
@ MDBX_ENV_DEFAULTS
Definition mdbx.h:1039

MDBX_COALESCE
@ MDBX_COALESCE
Definition mdbx.h:1268

MDBX_NOMETASYNC
@ MDBX_NOMETASYNC
Definition mdbx.h:1367

MDBX_LIFORECLAIM
@ MDBX_LIFORECLAIM
Definition mdbx.h:1292

MDBX_SAFE_NOSYNC
@ MDBX_SAFE_NOSYNC
Definition mdbx.h:1418

MDBX_NOTLS
@ MDBX_NOTLS
Definition mdbx.h:1211

MDBX_SYNC_DURABLE
@ MDBX_SYNC_DURABLE
Definition mdbx.h:1349

MDBX_PAGEPERTURB
@ MDBX_PAGEPERTURB
Definition mdbx.h:1295

MDBX_WRITEMAP
@ MDBX_WRITEMAP
Definition mdbx.h:1158

MDBX_NOSTICKYTHREADS
@ MDBX_NOSTICKYTHREADS
Definition mdbx.h:1208

MDBX_EXCLUSIVE
@ MDBX_EXCLUSIVE
Definition mdbx.h:1112

MDBX_NOMEMINIT
@ MDBX_NOMEMINIT
Definition mdbx.h:1255

MDBX_MAPASYNC
@ MDBX_MAPASYNC
Definition mdbx.h:1425

MDBX_ACCEDE
@ MDBX_ACCEDE
Definition mdbx.h:1127

MDBX_NOSUBDIR
@ MDBX_NOSUBDIR
Definition mdbx.h:1064

MDBX_RDONLY
@ MDBX_RDONLY
Definition mdbx.h:1082

MDBX_UTTERLY_NOSYNC
@ MDBX_UTTERLY_NOSYNC
Definition mdbx.h:1468

MDBX_VALIDATION
@ MDBX_VALIDATION
Definition mdbx.h:1046

mdbx_estimate_distance
LIBMDBX_API int mdbx_estimate_distance(const MDBX_cursor *first, const MDBX_cursor *last, ptrdiff_t *distance_items)
Estimates the distance between cursors as a number of elements.

mdbx_estimate_move
LIBMDBX_API int mdbx_estimate_move(const MDBX_cursor *cursor, MDBX_val *key, MDBX_val *data, MDBX_cursor_op move_op, ptrdiff_t *distance_items)
Estimates the move distance.

mdbx_estimate_range
LIBMDBX_API int mdbx_estimate_range(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *begin_key, const MDBX_val *begin_data, const MDBX_val *end_key, const MDBX_val *end_data, ptrdiff_t *distance_items)
Estimates the size of a range as a number of elements.

mdbx_env_set_mapsize
int mdbx_env_set_mapsize(MDBX_env *env, size_t size)
Definition mdbx.h:3542

mdbx_env_set_maxdbs
int mdbx_env_set_maxdbs(MDBX_env *env, MDBX_dbi dbs)
Set the maximum number of named tables for the environment.
Definition mdbx.h:3691

mdbx_env_warmup
LIBMDBX_API int mdbx_env_warmup(const MDBX_env *env, const MDBX_txn *txn, MDBX_warmup_flags_t flags, unsigned timeout_seconds_16dot16)
Warms up the database by loading pages into memory, optionally lock ones.

mdbx_env_get_option
LIBMDBX_API int mdbx_env_get_option(const MDBX_env *env, const MDBX_option_t option, uint64_t *pvalue)
Gets the value of extra runtime options from an environment.

mdbx_env_set_syncperiod
int mdbx_env_set_syncperiod(MDBX_env *env, unsigned seconds_16dot16)
Sets relative period since the last unsteady commit to force flush the data buffers to disk,...
Definition mdbx.h:3043

MDBX_option_t
MDBX_option_t
MDBX environment extra runtime options.
Definition mdbx.h:2120

mdbx_env_set_geometry
LIBMDBX_API int mdbx_env_set_geometry(MDBX_env *env, intptr_t size_lower, intptr_t size_now, intptr_t size_upper, intptr_t growth_step, intptr_t shrink_threshold, intptr_t pagesize)
Set all size-related parameters of environment, including page size and the min/max size of the memor...

mdbx_env_set_syncbytes
int mdbx_env_set_syncbytes(MDBX_env *env, size_t threshold)
Sets threshold to force flush the data buffers to disk, even any of MDBX_SAFE_NOSYNC flag in the envi...
Definition mdbx.h:2982

MDBX_warmup_flags_t
MDBX_warmup_flags_t
Warming up options.
Definition mdbx.h:3188

mdbx_env_set_option
LIBMDBX_API int mdbx_env_set_option(MDBX_env *env, const MDBX_option_t option, uint64_t value)
Sets the value of a extra runtime options for an environment.

mdbx_env_set_userctx
LIBMDBX_API int mdbx_env_set_userctx(MDBX_env *env, void *ctx)
Sets application information (a context pointer) associated with the environment.

mdbx_env_set_maxreaders
int mdbx_env_set_maxreaders(MDBX_env *env, unsigned readers)
Set the maximum number of threads/reader slots for for all processes interacts with the database.
Definition mdbx.h:3645

mdbx_env_set_flags
LIBMDBX_API int mdbx_env_set_flags(MDBX_env *env, MDBX_env_flags_t flags, bool onoff)
Set environment flags.

MDBX_opt_txn_dp_initial
@ MDBX_opt_txn_dp_initial
Controls the in-process initial allocation size for dirty pages list of a write transaction....
Definition mdbx.h:2225

MDBX_opt_subpage_room_threshold
@ MDBX_opt_subpage_room_threshold
Sets the minimum amount of free space on a leaf page in %, in the absence of which the nested pages a...
Definition mdbx.h:2385

MDBX_opt_subpage_limit
@ MDBX_opt_subpage_limit
Specifies, in % of a usual page, the maximum size of nested pages used to accommodate a small number ...
Definition mdbx.h:2379

MDBX_opt_txn_dp_limit
@ MDBX_opt_txn_dp_limit
Controls the in-process limit of dirty pages for a write transaction.
Definition mdbx.h:2221

MDBX_opt_prefer_waf_insteadof_balance
@ MDBX_opt_prefer_waf_insteadof_balance
Controls the choice between striving for uniformity of page filling/density, either for reducing the ...
Definition mdbx.h:2366

MDBX_opt_prefault_write_enable
@ MDBX_opt_prefault_write_enable
Controls prevention of page-faults of reclaimed and allocated pages in the MDBX_WRITEMAP mode by clea...
Definition mdbx.h:2325

MDBX_opt_max_db
@ MDBX_opt_max_db
Controls the maximum number of named tables for the environment.
Definition mdbx.h:2129

MDBX_opt_merge_threshold_16dot16_percent
@ MDBX_opt_merge_threshold_16dot16_percent
Controls the in-process threshold of semi-empty pages merge.
Definition mdbx.h:2292

MDBX_opt_subpage_reserve_prereq
@ MDBX_opt_subpage_reserve_prereq
Sets the minimum amount of free space on the main page in %, if available, to reserve space in the su...
Definition mdbx.h:2398

MDBX_opt_sync_bytes
@ MDBX_opt_sync_bytes
Controls interprocess/shared threshold to force flush the data buffers to disk, if MDBX_SAFE_NOSYNC i...
Definition mdbx.h:2152

MDBX_opt_spill_min_denominator
@ MDBX_opt_spill_min_denominator
Controls the in-process how minimal part of the dirty pages should be spilled when necessary.
Definition mdbx.h:2257

MDBX_opt_spill_parent4child_denominator
@ MDBX_opt_spill_parent4child_denominator
Controls the in-process how much of the parent transaction dirty pages will be spilled while start ea...
Definition mdbx.h:2280

MDBX_opt_loose_limit
@ MDBX_opt_loose_limit
Controls the in-process limit to grow a cache of dirty pages for reuse in the current transaction.
Definition mdbx.h:2192

MDBX_opt_rp_augment_limit
@ MDBX_opt_rp_augment_limit
Controls the in-process limit to grow a list of reclaimed/recycled page's numbers for finding a seque...
Definition mdbx.h:2179

MDBX_opt_max_readers
@ MDBX_opt_max_readers
Defines the maximum number of threads/reader slots for all processes interacting with the database.
Definition mdbx.h:2146

MDBX_opt_subpage_reserve_limit
@ MDBX_opt_subpage_reserve_limit
Sets, as a % of a usual page, the limit for reserving space on nested pages.
Definition mdbx.h:2403

MDBX_opt_spill_max_denominator
@ MDBX_opt_spill_max_denominator
Controls the in-process how maximal part of the dirty pages may be spilled when necessary.
Definition mdbx.h:2241

MDBX_opt_sync_period
@ MDBX_opt_sync_period
Controls interprocess/shared relative period since the last unsteady commit to force flush the data b...
Definition mdbx.h:2158

MDBX_opt_dp_reserve_limit
@ MDBX_opt_dp_reserve_limit
Controls the in-process limit of a pre-allocated memory items for dirty pages.
Definition mdbx.h:2206

MDBX_opt_writethrough_threshold
@ MDBX_opt_writethrough_threshold
Controls the choosing between use write-through disk writes and usual ones with followed flush by the...
Definition mdbx.h:2320

MDBX_opt_gc_time_limit
@ MDBX_opt_gc_time_limit
Controls the in-process spending time limit of searching consecutive pages inside GC.
Definition mdbx.h:2344

MDBX_warmup_touchlimit
@ MDBX_warmup_touchlimit
Definition mdbx.h:3227

MDBX_warmup_force
@ MDBX_warmup_force
Definition mdbx.h:3197

MDBX_warmup_oomsafe
@ MDBX_warmup_oomsafe
Definition mdbx.h:3204

MDBX_warmup_release
@ MDBX_warmup_release
Definition mdbx.h:3230

MDBX_warmup_lock
@ MDBX_warmup_lock
Definition mdbx.h:3219

MDBX_warmup_default
@ MDBX_warmup_default
Definition mdbx.h:3191

mdbx_env_get_path
LIBMDBX_API int mdbx_env_get_path(const MDBX_env *env, const char **dest)
Return the path that was used in mdbx_env_open().

mdbx_dbi_stat
LIBMDBX_API int mdbx_dbi_stat(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_stat *stat, size_t bytes)
Retrieve statistics for a table.

mdbx_limits_keysize_min
LIBMDBX_API intptr_t mdbx_limits_keysize_min(MDBX_db_flags_t flags)
Returns minimal key size in bytes for given table flags.

mdbx_txn_id
LIBMDBX_API uint64_t mdbx_txn_id(const MDBX_txn *txn)
Return the transaction's ID.

mdbx_limits_valsize_max
LIBMDBX_API intptr_t mdbx_limits_valsize_max(intptr_t pagesize, MDBX_db_flags_t flags)
Returns maximal data size in bytes for given page size and table flags, or -1 if pagesize is invalid.

mdbx_env_info_ex
LIBMDBX_API int mdbx_env_info_ex(const MDBX_env *env, const MDBX_txn *txn, MDBX_envinfo *info, size_t bytes)
Return information about the MDBX environment.

mdbx_env_get_maxreaders
int mdbx_env_get_maxreaders(const MDBX_env *env, unsigned *readers)
Get the maximum number of threads/reader slots for the environment.
Definition mdbx.h:3660

mdbx_env_get_syncperiod
int mdbx_env_get_syncperiod(const MDBX_env *env, unsigned *period_seconds_16dot16)
Get relative period since the last unsteady commit to force flush the data buffers to disk,...
Definition mdbx.h:3063

mdbx_env_get_maxkeysize_ex
LIBMDBX_API int mdbx_env_get_maxkeysize_ex(const MDBX_env *env, MDBX_db_flags_t flags)
Returns the maximum size of keys can put.

mdbx_txn_straggler
LIBMDBX_API int mdbx_txn_straggler(const MDBX_txn *txn, int *percent)
Returns a lag of the reading for the given transaction.

mdbx_env_get_maxvalsize_ex
LIBMDBX_API int mdbx_env_get_maxvalsize_ex(const MDBX_env *env, MDBX_db_flags_t flags)
Returns the maximum size of data we can put.

mdbx_env_stat_ex
LIBMDBX_API int mdbx_env_stat_ex(const MDBX_env *env, const MDBX_txn *txn, MDBX_stat *stat, size_t bytes)
Return statistics about the MDBX environment.

mdbx_dbi_flags
int mdbx_dbi_flags(const MDBX_txn *txn, MDBX_dbi dbi, unsigned *flags)
The shortcut to calling mdbx_dbi_flags_ex() with state=NULL for discarding it result.
Definition mdbx.h:5013

mdbx_gc_info
LIBMDBX_API int mdbx_gc_info(MDBX_txn *txn, MDBX_gc_info_t *info, size_t bytes, MDBX_gc_iter_func iter_func, void *iter_ctx)
Provides information of Garbage Collection and page usage.

mdbx_env_get_pairsize4page_max
LIBMDBX_API int mdbx_env_get_pairsize4page_max(const MDBX_env *env, MDBX_db_flags_t flags)
Returns maximal size of key-value pair to fit in a single page for specified table flags.

mdbx_limits_valsize_min
LIBMDBX_API intptr_t mdbx_limits_valsize_min(MDBX_db_flags_t flags)
Returns minimal data size in bytes for given table flags.

mdbx_env_info
int mdbx_env_info(const MDBX_env *env, MDBX_envinfo *info, size_t bytes)
Return information about the MDBX environment.
Definition mdbx.h:2907

MDBX_gc_iter_func
int MDBX_gc_iter_func(void *ctx, const MDBX_txn *txn, uint64_t span_txnid, size_t span_pgno, size_t span_length, bool span_is_reclaimable) noexcept
A callback function for iterating GC entries.
Definition mdbx.h:7164

mdbx_env_get_syncbytes
int mdbx_env_get_syncbytes(const MDBX_env *env, size_t *threshold)
Get threshold to force flush the data buffers to disk, even any of MDBX_SAFE_NOSYNC flag in the envir...
Definition mdbx.h:3000

mdbx_enumerate_tables
LIBMDBX_API int mdbx_enumerate_tables(const MDBX_txn *txn, MDBX_table_enum_func *func, void *ctx)
Enumerates user's named tables in a database.

mdbx_limits_valsize4page_max
LIBMDBX_API intptr_t mdbx_limits_valsize4page_max(intptr_t pagesize, MDBX_db_flags_t flags)
Returns maximal data size in bytes to fit in a leaf-page or single large/overflow-page with the given...

mdbx_limits_txnsize_max
LIBMDBX_API intptr_t mdbx_limits_txnsize_max(intptr_t pagesize)
Returns maximal write transaction size (i.e. limit for summary volume of dirty pages) in bytes for gi...

mdbx_limits_pgsize_max
intptr_t mdbx_limits_pgsize_max(void)
Returns the maximal database page size in bytes.
Definition mdbx.h:3569

mdbx_dbi_dupsort_depthmask
LIBMDBX_API int mdbx_dbi_dupsort_depthmask(const MDBX_txn *txn, MDBX_dbi dbi, uint32_t *mask)
Retrieve depth (bitmask) information of nested dupsort (multi-value) B+trees for given table.

mdbx_txn_info
LIBMDBX_API int mdbx_txn_info(const MDBX_txn *txn, MDBX_txn_info *info, bool scan_rlt)
Return information about the MDBX transaction.

mdbx_is_dirty
LIBMDBX_API int mdbx_is_dirty(const MDBX_txn *txn, const void *ptr)
Determines whether the given address is on a dirty database page of the transaction or not.

MDBX_dbi_state_t
MDBX_dbi_state_t
DBI state bits returted by mdbx_dbi_flags_ex()
Definition mdbx.h:4985

mdbx_env_get_valsize4page_max
LIBMDBX_API int mdbx_env_get_valsize4page_max(const MDBX_env *env, MDBX_db_flags_t flags)
Returns maximal data size in bytes to fit in a leaf-page or single large/overflow-page for specified ...

mdbx_limits_pgsize_min
intptr_t mdbx_limits_pgsize_min(void)
Returns the minimal database page size in bytes.
Definition mdbx.h:3565

mdbx_env_get_maxkeysize
LIBMDBX_API int mdbx_env_get_maxkeysize(const MDBX_env *env)

mdbx_env_get_fd
LIBMDBX_API int mdbx_env_get_fd(const MDBX_env *env, mdbx_filehandle_t *fd)
Return the file descriptor for the given environment.

mdbx_env_get_userctx
LIBMDBX_API void * mdbx_env_get_userctx(const MDBX_env *env)
Returns an application information (a context pointer) associated with the environment.

MDBX_reader_list_func
int MDBX_reader_list_func(void *ctx, int num, int slot, mdbx_pid_t pid, mdbx_tid_t thread, uint64_t txnid, uint64_t lag, size_t bytes_used, size_t bytes_retained) noexcept
A callback function used to enumerate the reader lock table.
Definition mdbx.h:6606

mdbx_env_get_maxdbs
int mdbx_env_get_maxdbs(const MDBX_env *env, MDBX_dbi *dbs)
Get the maximum number of named tables for the environment.
Definition mdbx.h:3705

mdbx_env_get_pathW
LIBMDBX_API int mdbx_env_get_pathW(const MDBX_env *env, const wchar_t **dest)
Return the path that was used in mdbx_env_open().

mdbx_limits_keysize_max
LIBMDBX_API intptr_t mdbx_limits_keysize_max(intptr_t pagesize, MDBX_db_flags_t flags)
Returns maximal key size in bytes for given page size and table flags, or -1 if pagesize is invalid.

mdbx_default_pagesize
LIBMDBX_API size_t mdbx_default_pagesize(void)
Returns the default size of database page for the current system.

mdbx_reader_list
LIBMDBX_API int mdbx_reader_list(const MDBX_env *env, MDBX_reader_list_func *func, void *ctx)
Enumerate the entries in the reader lock table.

mdbx_get_sysraminfo
LIBMDBX_API int mdbx_get_sysraminfo(intptr_t *page_size, intptr_t *total_pages, intptr_t *avail_pages)
Returns basic information about system RAM. This function provides a portable way to get information ...

mdbx_env_stat
int mdbx_env_stat(const MDBX_env *env, MDBX_stat *stat, size_t bytes)
Return statistics about the MDBX environment.
Definition mdbx.h:2789

mdbx_limits_pairsize4page_max
LIBMDBX_API intptr_t mdbx_limits_pairsize4page_max(intptr_t pagesize, MDBX_db_flags_t flags)
Returns maximal size of key-value pair to fit in a single page with the given size and table flags,...

mdbx_limits_dbsize_max
LIBMDBX_API intptr_t mdbx_limits_dbsize_max(intptr_t pagesize)
Returns maximal database size in bytes for given page size, or -1 if pagesize is invalid.

mdbx_limits_dbsize_min
LIBMDBX_API intptr_t mdbx_limits_dbsize_min(intptr_t pagesize)
Returns minimal database size in bytes for given page size, or -1 if pagesize is invalid.

mdbx_env_get_flags
LIBMDBX_API int mdbx_env_get_flags(const MDBX_env *env, unsigned *flags)
Get environment flags.

MDBX_table_enum_func
int MDBX_table_enum_func(void *ctx, const MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags, const struct MDBX_stat *stat, MDBX_dbi dbi) noexcept
A callback function for listing user's named tables.
Definition mdbx.h:4881

mdbx_dbi_flags_ex
LIBMDBX_API int mdbx_dbi_flags_ex(const MDBX_txn *txn, MDBX_dbi dbi, unsigned *flags, unsigned *state)
Retrieve the DB flags and status for a table handle.

MDBX_DBI_DIRTY
@ MDBX_DBI_DIRTY
Definition mdbx.h:4987

MDBX_DBI_FRESH
@ MDBX_DBI_FRESH
Definition mdbx.h:4991

MDBX_DBI_STALE
@ MDBX_DBI_STALE
Definition mdbx.h:4989

MDBX_DBI_CREAT
@ MDBX_DBI_CREAT
Definition mdbx.h:4993

mdbx_txn_break
LIBMDBX_API int mdbx_txn_break(MDBX_txn *txn)
Marks transaction as broken to prevent further operations.

mdbx_txn_set_userctx
LIBMDBX_API int mdbx_txn_set_userctx(MDBX_txn *txn, void *ctx)
Sets application information associated (a context pointer) with the transaction.

mdbx_txn_clone
LIBMDBX_API int mdbx_txn_clone(const MDBX_txn *origin, MDBX_txn **in_out_clone, void *context)
Starts a read-only clone of a given transaction.

mdbx_txn_park
LIBMDBX_API int mdbx_txn_park(MDBX_txn *txn, bool autounpark)
Puts the reading transaction in a "parked" state.

mdbx_txn_begin_ex
LIBMDBX_API int mdbx_txn_begin_ex(MDBX_env *env, MDBX_txn *parent, MDBX_txn_flags_t flags, MDBX_txn **txn, void *context)
Create a transaction with a user provided context pointer for use with the environment.

mdbx_txn_refresh
LIBMDBX_API int mdbx_txn_refresh(MDBX_txn *txn)
Refresh a read-only transaction for a recent data.

mdbx_txn_commit
int mdbx_txn_commit(MDBX_txn *txn)
Commits all the operations of the transaction into the database.
Definition mdbx.h:4430

mdbx_txn_commit_ex
LIBMDBX_API int mdbx_txn_commit_ex(MDBX_txn *txn, MDBX_commit_latency *latency)
Commits all changes of the transaction into a database with collecting latencies information.

mdbx_txn_abort_ex
LIBMDBX_API int mdbx_txn_abort_ex(MDBX_txn *txn, MDBX_commit_latency *latency)
Abandons all the operations of the transaction instead of saving ones with collecting latencies infor...

mdbx_txn_env
LIBMDBX_API MDBX_env * mdbx_txn_env(const MDBX_txn *txn)
Returns the transaction's MDBX_env.

mdbx_txn_checkpoint
LIBMDBX_API int mdbx_txn_checkpoint(MDBX_txn *txn, MDBX_txn_flags_t weakening_durability, MDBX_commit_latency *latency)
Commits all the operations of the transaction and immediately starts next without releasing any locks...

mdbx_txn_unpark
LIBMDBX_API int mdbx_txn_unpark(MDBX_txn *txn, bool restart_if_ousted)
Unparks a previously parked reading transaction.

MDBX_txn_flags_t
MDBX_txn_flags_t
Definition mdbx.h:1478

mdbx_txn_get_userctx
LIBMDBX_API void * mdbx_txn_get_userctx(const MDBX_txn *txn)
Returns an application information (a context pointer) associated with the transaction.

mdbx_txn_abort
int mdbx_txn_abort(MDBX_txn *txn)
Abandons all the operations of the transaction instead of saving ones.
Definition mdbx.h:4485

mdbx_txn_begin
int mdbx_txn_begin(MDBX_env *env, MDBX_txn *parent, MDBX_txn_flags_t flags, MDBX_txn **txn)
Create a transaction for use with the environment.
Definition mdbx.h:3921

mdbx_txn_amend
LIBMDBX_API int mdbx_txn_amend(MDBX_txn *read_txn, MDBX_txn **ptr_write_txn, MDBX_txn_flags_t flags, void *context)
Starts a writing transaction to amending data in the MVCC-snapshot used by the read-only transaction.

MDBX_txn
struct MDBX_txn MDBX_txn
Opaque structure for a transaction handle.
Definition mdbx.h:724

mdbx_txn_commit_embark_read
LIBMDBX_API int mdbx_txn_commit_embark_read(MDBX_txn **ptxn, MDBX_commit_latency *latency)
Commits all the operations of the transaction and immediately starts read transaction before release ...

mdbx_txn_reset
LIBMDBX_API int mdbx_txn_reset(MDBX_txn *txn)
Reset a read-only transaction.

mdbx_txn_renew
LIBMDBX_API int mdbx_txn_renew(MDBX_txn *txn)
Renew a read-only transaction.

mdbx_txn_flags
LIBMDBX_API MDBX_txn_flags_t mdbx_txn_flags(const MDBX_txn *txn)
Return the transaction's flags.

MDBX_TXN_RDONLY
@ MDBX_TXN_RDONLY
Definition mdbx.h:1489

MDBX_TXN_ERROR
@ MDBX_TXN_ERROR
Definition mdbx.h:1532

MDBX_TXN_NOMETASYNC
@ MDBX_TXN_NOMETASYNC
Definition mdbx.h:1511

MDBX_TXN_SPILLS
@ MDBX_TXN_SPILLS
Definition mdbx.h:1542

MDBX_TXN_OUSTED
@ MDBX_TXN_OUSTED
Definition mdbx.h:1566

MDBX_TXN_NOWEAKING
@ MDBX_TXN_NOWEAKING
Definition mdbx.h:1507

MDBX_TXN_HAS_CHILD
@ MDBX_TXN_HAS_CHILD
Definition mdbx.h:1547

MDBX_TXN_RDONLY_PREPARE
@ MDBX_TXN_RDONLY_PREPARE
Definition mdbx.h:1498

MDBX_TXN_INVALID
@ MDBX_TXN_INVALID
Definition mdbx.h:1522

MDBX_TXN_BLOCKED
@ MDBX_TXN_BLOCKED
Definition mdbx.h:1571

MDBX_TXN_PARKED
@ MDBX_TXN_PARKED
Definition mdbx.h:1552

MDBX_TXN_NOSYNC
@ MDBX_TXN_NOSYNC
Definition mdbx.h:1515

MDBX_TXN_DIRTY
@ MDBX_TXN_DIRTY
Definition mdbx.h:1537

MDBX_TXN_READWRITE
@ MDBX_TXN_READWRITE
Definition mdbx.h:1483

MDBX_TXN_AUTOUNPARK
@ MDBX_TXN_AUTOUNPARK
Definition mdbx.h:1559

MDBX_TXN_TRY
@ MDBX_TXN_TRY
Definition mdbx.h:1504

MDBX_TXN_FINISHED
@ MDBX_TXN_FINISHED
Definition mdbx.h:1527

MDBX_chk_scope_t::verbosity
MDBX_chk_severity_t verbosity
Definition mdbx.h:6958

MDBX_chk_context_t::txn
MDBX_txn * txn
Definition mdbx.h:7031

MDBX_chk_context_t.result::unused_pages
size_t unused_pages

MDBX_chk_callbacks_t::issue
void(* issue)(MDBX_chk_context_t *ctx, const char *object, uint64_t entry_number, const char *issue, const char *extra_fmt, va_list extra_args)
Definition mdbx.h:7070

MDBX_chk_table_t.histogram::tree_density
struct MDBX_chk_histogram tree_density

MDBX_chk_histogram::ranges
struct MDBX_chk_histogram::@167152105014034103340112155364354016331236072167 ranges[9]

MDBX_chk_callbacks_t::print_size
void(* print_size)(MDBX_chk_line_t *, const char *prefix, const uint64_t value, const char *suffix)
Definition mdbx.h:7087

MDBX_chk_callbacks_t::print_done
void(* print_done)(MDBX_chk_line_t *)
Definition mdbx.h:7084

MDBX_chk_context_t::internal
struct MDBX_chk_internal * internal
Definition mdbx.h:7029

MDBX_chk_context_t::scope_nesting
uint8_t scope_nesting
Definition mdbx.h:7033

MDBX_chk_line_t::end
char * end
Definition mdbx.h:6940

MDBX_chk_line_t::scope_depth
uint8_t scope_depth
Definition mdbx.h:6939

MDBX_chk_table_t.histogram::key_len
struct MDBX_chk_histogram key_len

MDBX_chk_context_t.result::problems_kv
size_t problems_kv

MDBX_chk_context_t.result::processed_pages
size_t processed_pages

MDBX_chk_table_t.histogram::large_or_nested_density
struct MDBX_chk_histogram large_or_nested_density

MDBX_chk_callbacks_t::stage_begin
int(* stage_begin)(MDBX_chk_context_t *ctx, MDBX_chk_stage_t)
Definition mdbx.h:7079

MDBX_chk_callbacks_t::stage_end
int(* stage_end)(MDBX_chk_context_t *ctx, MDBX_chk_stage_t, int err)
Definition mdbx.h:7080

MDBX_chk_table_t.pages::nested_leaf
size_t nested_leaf

MDBX_chk_callbacks_t::table_conclude
int(* table_conclude)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table, MDBX_cursor *cursor, int err)
Definition mdbx.h:7073

MDBX_chk_callbacks_t::print_format
void(* print_format)(MDBX_chk_line_t *, const char *fmt, va_list args)
Definition mdbx.h:7086

MDBX_chk_context_t.result::histogram_pgno_payload
struct MDBX_chk_histogram histogram_pgno_payload

MDBX_chk_scope_t::internal
struct MDBX_chk_internal * internal
Definition mdbx.h:6955

MDBX_chk_scope_t.usr_o::ptr
void * ptr

MDBX_chk_line_t::begin
char * begin
Definition mdbx.h:6940

MDBX_chk_histogram::le1_count
size_t le1_count
Definition mdbx.h:6974

MDBX_chk_callbacks_t::scope_push
int(* scope_push)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner, const char *fmt, va_list args)
Definition mdbx.h:7066

MDBX_chk_context_t.result::histogram_pgno_retained
struct MDBX_chk_histogram histogram_pgno_retained

MDBX_chk_context_t.result::problems_meta
size_t problems_meta

MDBX_chk_table_t.pages::broken
size_t broken

MDBX_chk_scope_t::subtotal_issues
size_t subtotal_issues
Definition mdbx.h:6959

MDBX_chk_context_t.result::total_unused_bytes
size_t total_unused_bytes

MDBX_chk_line_t::severity
uint8_t severity
Definition mdbx.h:6939

MDBX_chk_table_t::cookie
MDBX_chk_user_table_cookie_t * cookie
Definition mdbx.h:6983

MDBX_chk_callbacks_t::scope_pop
void(* scope_pop)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner)
Definition mdbx.h:7069

MDBX_chk_table_t.histogram::pgno
struct MDBX_chk_histogram pgno

MDBX_chk_line_t::ctx
struct MDBX_chk_context * ctx
Definition mdbx.h:6938

MDBX_chk_table_t::flags
MDBX_db_flags_t flags
Definition mdbx.h:6993

MDBX_chk_callbacks_t::scope_conclude
int(* scope_conclude)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner, int err)
Definition mdbx.h:7068

MDBX_chk_context_t.result::reclaimable_pages
size_t reclaimable_pages

MDBX_chk_histogram.ranges::end
size_t end

MDBX_chk_histogram::le1_amount
size_t le1_amount
Definition mdbx.h:6974

MDBX_chk_callbacks_t::print_flush
void(* print_flush)(MDBX_chk_line_t *)
Definition mdbx.h:7083

MDBX_chk_table_t.pages::nested_branch
size_t nested_branch

MDBX_chk_issue_t::next
struct MDBX_chk_issue * next
Definition mdbx.h:6946

MDBX_chk_context_t.result::gc_tree_problems
size_t gc_tree_problems

MDBX_chk_table_t.histogram::large_pages
struct MDBX_chk_histogram large_pages

MDBX_chk_line_t::out
char * out
Definition mdbx.h:6940

MDBX_chk_histogram.ranges::begin
size_t begin

MDBX_chk_context_t.result::problems_gc
size_t problems_gc

MDBX_chk_table_t.histogram::val_len
struct MDBX_chk_histogram val_len

MDBX_chk_callbacks_t::print_chars
void(* print_chars)(MDBX_chk_line_t *, const char *str, size_t len)
Definition mdbx.h:7085

MDBX_chk_context_t.result::alloc_pages
size_t alloc_pages

MDBX_chk_table_t.pages::branch
size_t branch

MDBX_chk_context_t.result::tables
const MDBX_chk_table_t *const * tables

MDBX_chk_scope_t::object
const void * object
Definition mdbx.h:6956

MDBX_chk_histogram::count
size_t count
Definition mdbx.h:6974

MDBX_chk_context_t.result::backed_pages
size_t backed_pages

MDBX_chk_table_t.pages::all
size_t all

MDBX_chk_issue_t::caption
const char * caption
Definition mdbx.h:6948

MDBX_chk_scope_t::stage
MDBX_chk_stage_t stage
Definition mdbx.h:6957

MDBX_chk_table_t.pages::empty
size_t empty

MDBX_chk_context_t.result::total_payload_bytes
size_t total_payload_bytes

MDBX_chk_table_t.pages::nested_subleaf
size_t nested_subleaf

MDBX_chk_context_t.result::recent_txnid
uint64_t recent_txnid

MDBX_chk_scope_t.usr_o::number
size_t number

MDBX_chk_context_t.result::histogram_page_age
struct MDBX_chk_histogram histogram_page_age

MDBX_chk_table_t.histogram::height
struct MDBX_chk_histogram height

MDBX_chk_table_t.histogram::multival
struct MDBX_chk_histogram multival

MDBX_chk_table_t.pages::leaf
size_t leaf

MDBX_chk_table_t.histogram::nested_height_or_gc_span_length
struct MDBX_chk_histogram nested_height_or_gc_span_length

MDBX_chk_context_t::env
MDBX_env * env
Definition mdbx.h:7030

MDBX_chk_line_t::empty
uint8_t empty
Definition mdbx.h:6939

MDBX_chk_context_t.result::tree_problems
size_t tree_problems

MDBX_chk_histogram::amount
size_t amount
Definition mdbx.h:6974

MDBX_chk_context_t::scope
MDBX_chk_scope_t * scope
Definition mdbx.h:7032

MDBX_chk_scope_t::issues
MDBX_chk_issue_t * issues
Definition mdbx.h:6954

MDBX_chk_context_t.result::total_problems
size_t total_problems

MDBX_chk_table_t::payload_bytes
size_t payload_bytes
Definition mdbx.h:6996

MDBX_chk_issue_t::count
size_t count
Definition mdbx.h:6947

MDBX_chk_table_t::name
MDBX_val name
Definition mdbx.h:6992

MDBX_chk_context_t.result::kv_tree_problems
size_t kv_tree_problems

MDBX_chk_context_t.result::gc_pages
size_t gc_pages

MDBX_chk_histogram.ranges::count
size_t count

MDBX_chk_table_t::lost_bytes
size_t lost_bytes
Definition mdbx.h:6996

MDBX_chk_callbacks_t::check_break
bool(* check_break)(MDBX_chk_context_t *ctx)
Definition mdbx.h:7065

MDBX_chk_callbacks_t::table_dispose
void(* table_dispose)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table)
Definition mdbx.h:7074

MDBX_chk_callbacks_t::table_handle_kv
int(* table_handle_kv)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table, size_t entry_number, const MDBX_val *key, const MDBX_val *value)
Definition mdbx.h:7076

MDBX_chk_histogram.ranges::amount
size_t amount

MDBX_chk_context_t.result::table_processed
size_t table_processed

MDBX_chk_context_t.result::steady_txnid
uint64_t steady_txnid

MDBX_chk_table_t::id
int id
Definition mdbx.h:6994

MDBX_chk_context_t.result::table_total
size_t table_total

MDBX_chk_table_t.histogram::page_age
struct MDBX_chk_histogram page_age

mdbx_env_chk_encount_problem
LIBMDBX_API int mdbx_env_chk_encount_problem(MDBX_chk_context_t *ctx)
An auxiliary function to account issues detected by an application, including those coming to an appl...

mdbx_env_chk
LIBMDBX_API int mdbx_env_chk(MDBX_env *env, const MDBX_chk_callbacks_t *cb, MDBX_chk_context_t *ctx, const MDBX_chk_flags_t flags, MDBX_chk_severity_t verbosity, unsigned timeout_seconds_16dot16)
Checks the integrity of a database.

mdbx_ratio2digits
LIBMDBX_API const char * mdbx_ratio2digits(uint64_t numerator, uint64_t denominator, int precision, char *buffer, size_t buffer_size)
An auxiliary function for converting fractions to string of decimal digits without using floating-poi...

MDBX_chk_stage_t
MDBX_chk_stage_t
The verification stages reported via callbacks during a database integrity check.
Definition mdbx.h:6920

mdbx_txn_unlock
LIBMDBX_API int mdbx_txn_unlock(MDBX_env *env)
Releases write-transaction lock. Provided for custom and/or complex locking scenarios.

mdbx_ratio2percents
LIBMDBX_API const char * mdbx_ratio2percents(uint64_t value, uint64_t whole, char *buffer, size_t buffer_size)
An auxiliary function for converting fractions to percentage string without using floating-point oper...

MDBX_chk_user_table_cookie_t
struct MDBX_chk_user_table_cookie MDBX_chk_user_table_cookie_t
A custom type for binding additional data associated with a certain key-value table during a database...
Definition mdbx.h:6969

MDBX_chk_flags_t
MDBX_chk_flags_t
Flags/options for checking the integrity of a database.
Definition mdbx.h:6880

MDBX_chk_severity_t
MDBX_chk_severity_t
Levels of logging/detailing of information supplied via callbacks during a database integrity check.
Definition mdbx.h:6902

mdbx_txn_lock
LIBMDBX_API int mdbx_txn_lock(MDBX_env *env, bool dont_wait)
Acquires write-transaction lock. Provided for custom and/or complex locking scenarios.

mdbx_env_turn_for_recovery
LIBMDBX_API int mdbx_env_turn_for_recovery(MDBX_env *env, unsigned target_meta)
Turn database to the specified meta-page.

mdbx_env_open_for_recovery
LIBMDBX_API int mdbx_env_open_for_recovery(MDBX_env *env, const char *pathname, unsigned target_meta, bool writeable)
Open an environment instance using specific meta-page for checking and recovery.

MDBX_chk_gc
@ MDBX_chk_gc
Definition mdbx.h:6926

MDBX_chk_init
@ MDBX_chk_init
Definition mdbx.h:6922

MDBX_chk_finalize
@ MDBX_chk_finalize
Definition mdbx.h:6932

MDBX_chk_space
@ MDBX_chk_space
Definition mdbx.h:6927

MDBX_chk_lock
@ MDBX_chk_lock
Definition mdbx.h:6923

MDBX_chk_none
@ MDBX_chk_none
Definition mdbx.h:6921

MDBX_chk_maindb
@ MDBX_chk_maindb
Definition mdbx.h:6928

MDBX_chk_unlock
@ MDBX_chk_unlock
Definition mdbx.h:6931

MDBX_chk_meta
@ MDBX_chk_meta
Definition mdbx.h:6924

MDBX_chk_conclude
@ MDBX_chk_conclude
Definition mdbx.h:6930

MDBX_chk_tree
@ MDBX_chk_tree
Definition mdbx.h:6925

MDBX_chk_tables
@ MDBX_chk_tables
Definition mdbx.h:6929

MDBX_CHK_SKIP_BTREE_TRAVERSAL
@ MDBX_CHK_SKIP_BTREE_TRAVERSAL
Definition mdbx.h:6888

MDBX_CHK_READWRITE
@ MDBX_CHK_READWRITE
Definition mdbx.h:6885

MDBX_CHK_DEFAULTS
@ MDBX_CHK_DEFAULTS
Definition mdbx.h:6882

MDBX_CHK_SKIP_KV_TRAVERSAL
@ MDBX_CHK_SKIP_KV_TRAVERSAL
Definition mdbx.h:6891

MDBX_CHK_IGNORE_ORDER
@ MDBX_CHK_IGNORE_ORDER
Definition mdbx.h:6896

MDBX_chk_processing
@ MDBX_chk_processing
Definition mdbx.h:6911

MDBX_chk_result
@ MDBX_chk_result
Definition mdbx.h:6909

MDBX_chk_details
@ MDBX_chk_details
Definition mdbx.h:6914

MDBX_chk_extra
@ MDBX_chk_extra
Definition mdbx.h:6915

MDBX_chk_severity_prio_shift
@ MDBX_chk_severity_prio_shift
Definition mdbx.h:6903

MDBX_chk_severity_kind_mask
@ MDBX_chk_severity_kind_mask
Definition mdbx.h:6904

MDBX_chk_notice
@ MDBX_chk_notice
Definition mdbx.h:6908

MDBX_chk_resolution
@ MDBX_chk_resolution
Definition mdbx.h:6910

MDBX_chk_warning
@ MDBX_chk_warning
Definition mdbx.h:6907

MDBX_chk_fatal
@ MDBX_chk_fatal
Definition mdbx.h:6905

MDBX_chk_info
@ MDBX_chk_info
Definition mdbx.h:6912

MDBX_chk_error
@ MDBX_chk_error
Definition mdbx.h:6906

MDBX_chk_verbose
@ MDBX_chk_verbose
Definition mdbx.h:6913

MDBX_chk_callbacks_t
A set of callback functions used for checking the integrity of a database.
Definition mdbx.h:7064

MDBX_chk_context_t
The context for checking the integrity of a database.
Definition mdbx.h:7028

MDBX_chk_histogram
A histogram with some statistical information collected during a database integrity check.
Definition mdbx.h:6973

MDBX_chk_issue_t
An issue problem was discovered during a database integrity check.
Definition mdbx.h:6945

MDBX_chk_line_t
A virtual row of the report generated during a database integrity check.
Definition mdbx.h:6937

MDBX_chk_scope_t
A hierarchical context during a database integrity check.
Definition mdbx.h:6953

MDBX_chk_table_t
Information about a certain key-value table during a database integrity check.
Definition mdbx.h:6982

mdbx_float_from_key
LIBMDBX_API float mdbx_float_from_key(const MDBX_val)

mdbx_int32_from_key
LIBMDBX_API int32_t mdbx_int32_from_key(const MDBX_val)

mdbx_int64_from_key
LIBMDBX_API int64_t mdbx_int64_from_key(const MDBX_val)

mdbx_double_from_key
LIBMDBX_API double mdbx_double_from_key(const MDBX_val)

mdbx_jsonInteger_from_key
LIBMDBX_API int64_t mdbx_jsonInteger_from_key(const MDBX_val)

mdbx_key_from_int64
uint64_t mdbx_key_from_int64(const int64_t i64)
Definition mdbx.h:4924

mdbx_key_from_ptrfloat
LIBMDBX_API uint32_t mdbx_key_from_ptrfloat(const float *const ieee754_32bit)

mdbx_key_from_double
LIBMDBX_API uint64_t mdbx_key_from_double(const double ieee754_64bit)

mdbx_key_from_float
LIBMDBX_API uint32_t mdbx_key_from_float(const float ieee754_32bit)

mdbx_key_from_ptrdouble
LIBMDBX_API uint64_t mdbx_key_from_ptrdouble(const double *const ieee754_64bit)

mdbx_key_from_int32
uint32_t mdbx_key_from_int32(const int32_t i32)
Definition mdbx.h:4928

mdbx_key_from_jsonInteger
LIBMDBX_API uint64_t mdbx_key_from_jsonInteger(const int64_t json_integer)