libmdbx 0.14.1.463 (2026-03-15T18:44:37+03:00)
One of the fastest compact embeddable key-value ACID storage engine without WAL.
Loading...
Searching...
No Matches
mdbx.h
Go to the documentation of this file.
1
37
38#pragma once
39/*
40 * Tested with, since 2026:
41 * - Elbrus LCC >= 1.28 (http://www.mcst.ru/lcc);
42 * - GNU C >= 11.3;
43 * - CLANG >= 14.0;
44 * - MSVC >= 19.44 (Visual Studio 2022 toolchain v143),
45 * before 2026:
46 * - Elbrus LCC >= 1.23 (http://www.mcst.ru/lcc);
47 * - GNU C >= 4.8;
48 * - CLANG >= 3.9;
49 * - MSVC >= 14.0 (Visual Studio 2015),
50 * but 19.2x could hang due optimizer bug;
51 * - AppleClang.
52 */
53
54#ifndef LIBMDBX_H
55#define LIBMDBX_H
56
57#if defined(__riscv) || defined(__riscv__) || defined(__RISCV) || defined(__RISCV__)
58#warning "The RISC-V architecture is intentionally insecure by design. \
59 Please delete this admonition at your own risk, \
60 if you make such decision informed and consciously. \
61 Refer to https://clck.ru/32d9xH for more information."
62#endif /* RISC-V */
63
64#ifdef _MSC_VER
65#pragma warning(push, 1)
66#pragma warning(disable : 4548) /* expression before comma has no effect; \
67 expected expression with side - effect */
68#pragma warning(disable : 4530) /* C++ exception handler used, but unwind \
69 * semantics are not enabled. Specify /EHsc */
70#pragma warning(disable : 4577) /* 'noexcept' used with no exception handling \
71 * mode specified; termination on exception is \
72 * not guaranteed. Specify /EHsc */
73#endif /* _MSC_VER (warnings) */
74
75/* *INDENT-OFF* */
76/* clang-format off */
157/* *INDENT-ON* */
158/* clang-format on */
159
160#include <stdarg.h>
161#include <stddef.h>
162#include <stdint.h>
163#if !defined(NDEBUG) && !defined(assert)
164#include <assert.h>
165#endif /* NDEBUG */
166
167#if defined(_WIN32) || defined(_WIN64)
168#include <windows.h>
169#include <winnt.h>
170#ifndef __mode_t_defined
171typedef unsigned short mdbx_mode_t;
172#else
173typedef mode_t mdbx_mode_t;
174#endif /* __mode_t_defined */
175typedef HANDLE mdbx_filehandle_t;
176typedef DWORD mdbx_pid_t;
177typedef DWORD mdbx_tid_t;
178#else /* Windows */
179#include <errno.h> /* for error codes */
180#include <pthread.h> /* for pthread_t */
181#include <sys/types.h> /* for pid_t */
182#include <sys/uio.h> /* for struct iovec */
183#define HAVE_STRUCT_IOVEC 1
185typedef pid_t mdbx_pid_t;
186typedef pthread_t mdbx_tid_t;
187typedef mode_t mdbx_mode_t;
188#endif /* !Windows */
189
190#ifdef _MSC_VER
191#pragma warning(pop)
192#endif
193
194#define MDBX_AMALGAMATED_SOURCE 1
195
200
201/*----------------------------------------------------------------------------*/
202
203#ifndef __has_attribute
204#define __has_attribute(x) (0)
205#endif /* __has_attribute */
206
207#ifndef __has_c_attribute
208#define __has_c_attribute(x) (0)
209#define __has_c_attribute_qualified(x) 0
210#elif !defined(__STDC_VERSION__) || __STDC_VERSION__ < 202311L
211#define __has_c_attribute_qualified(x) 0
212#elif defined(_MSC_VER)
213/* MSVC don't support `namespace::attr` syntax */
214#define __has_c_attribute_qualified(x) 0
215#else
216#define __has_c_attribute_qualified(x) __has_c_attribute(x)
217#endif /* __has_c_attribute */
218
219#ifndef __has_cpp_attribute
220#define __has_cpp_attribute(x) 0
221#define __has_cpp_attribute_qualified(x) 0
222#elif defined(_MSC_VER) || (__clang__ && __clang__ < 14)
223/* MSVC don't support `namespace::attr` syntax */
224#define __has_cpp_attribute_qualified(x) 0
225#else
226#define __has_cpp_attribute_qualified(x) __has_cpp_attribute(x)
227#endif /* __has_cpp_attribute */
228
229#ifndef __has_C23_or_CXX_attribute
230#if defined(__cplusplus)
231#define __has_C23_or_CXX_attribute(x) __has_cpp_attribute_qualified(x)
232#else
233#define __has_C23_or_CXX_attribute(x) __has_c_attribute_qualified(x)
234#endif
235#endif /* __has_C23_or_CXX_attribute */
236
237#ifndef __has_feature
238#define __has_feature(x) (0)
239#define __has_exceptions_disabled (0)
240#elif !defined(__has_exceptions_disabled)
241#define __has_exceptions_disabled (__has_feature(cxx_noexcept) && !__has_feature(cxx_exceptions))
242#endif /* __has_feature */
243
244#ifndef __has_extension
245#define __has_extension(x) __has_feature(x)
246#endif /* __has_extension */
247
248#ifndef __has_builtin
249#define __has_builtin(x) (0)
250#endif /* __has_builtin */
251
258#if defined(DOXYGEN)
259#define MDBX_PURE_FUNCTION [[gnu::pure]]
260#elif __has_C23_or_CXX_attribute(gnu::pure)
261#define MDBX_PURE_FUNCTION [[gnu::pure]]
262#elif (defined(__GNUC__) || __has_attribute(__pure__)) && \
263 (!defined(__clang__) /* https://bugs.llvm.org/show_bug.cgi?id=43275 */ || !defined(__cplusplus) || \
264 __has_exceptions_disabled)
265#define MDBX_PURE_FUNCTION __attribute__((__pure__))
266#else
267#define MDBX_PURE_FUNCTION
268#endif /* MDBX_PURE_FUNCTION */
269
273#if defined(DOXYGEN)
274#define MDBX_NOTHROW_PURE_FUNCTION [[gnu::pure, gnu::nothrow]]
275#elif __has_C23_or_CXX_attribute(gnu::pure)
276#if __has_C23_or_CXX_attribute(gnu::nothrow)
277#define MDBX_NOTHROW_PURE_FUNCTION [[gnu::pure, gnu::nothrow]]
278#else
279#define MDBX_NOTHROW_PURE_FUNCTION [[gnu::pure]]
280#endif
281#elif defined(__GNUC__) || (__has_attribute(__pure__) && __has_attribute(__nothrow__))
282#define MDBX_NOTHROW_PURE_FUNCTION __attribute__((__pure__, __nothrow__))
283#elif __has_cpp_attribute(pure)
284#define MDBX_NOTHROW_PURE_FUNCTION [[pure]]
285#else
286#define MDBX_NOTHROW_PURE_FUNCTION
287#endif /* MDBX_NOTHROW_PURE_FUNCTION */
288
299#if defined(DOXYGEN)
300#define MDBX_CONST_FUNCTION [[gnu::const]]
301#elif __has_C23_or_CXX_attribute(gnu::const)
302#define MDBX_CONST_FUNCTION [[gnu::const]]
303#elif (defined(__GNUC__) || __has_attribute(__const__)) && \
304 (!defined(__clang__) /* https://bugs.llvm.org/show_bug.cgi?id=43275 */ || !defined(__cplusplus) || \
305 __has_exceptions_disabled)
306#define MDBX_CONST_FUNCTION __attribute__((__const__))
307#else
308#define MDBX_CONST_FUNCTION MDBX_PURE_FUNCTION
309#endif /* MDBX_CONST_FUNCTION */
310
314#if defined(DOXYGEN)
315#define MDBX_NOTHROW_CONST_FUNCTION [[gnu::const, gnu::nothrow]]
316#elif __has_C23_or_CXX_attribute(gnu::const)
317#if __has_C23_or_CXX_attribute(gnu::nothrow)
318#define MDBX_NOTHROW_CONST_FUNCTION [[gnu::const, gnu::nothrow]]
319#else
320#define MDBX_NOTHROW_CONST_FUNCTION [[gnu::const]]
321#endif
322#elif defined(__GNUC__) || (__has_attribute(__const__) && __has_attribute(__nothrow__))
323#define MDBX_NOTHROW_CONST_FUNCTION __attribute__((__const__, __nothrow__))
324#elif __has_cpp_attribute_qualified(const)
325#define MDBX_NOTHROW_CONST_FUNCTION [[const]]
326#else
327#define MDBX_NOTHROW_CONST_FUNCTION MDBX_NOTHROW_PURE_FUNCTION
328#endif /* MDBX_NOTHROW_CONST_FUNCTION */
329
333#ifndef MDBX_DEPRECATED
334#ifdef __deprecated
335#define MDBX_DEPRECATED __deprecated
336#elif defined(DOXYGEN) || ((!defined(__GNUC__) || (defined(__clang__) && __clang__ > 19) || __GNUC__ > 5) && \
337 ((defined(__cplusplus) && __cplusplus >= 201403L && __has_cpp_attribute(deprecated) && \
338 __has_cpp_attribute(deprecated) >= 201309L) || \
339 (!defined(__cplusplus) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202304L)))
340#define MDBX_DEPRECATED [[deprecated]]
341#elif (defined(__GNUC__) && __GNUC__ > 5) || \
342 (__has_attribute(__deprecated__) && (!defined(__GNUC__) || defined(__clang__) || __GNUC__ > 5))
343#define MDBX_DEPRECATED __attribute__((__deprecated__))
344#elif defined(_MSC_VER)
345#define MDBX_DEPRECATED __declspec(deprecated)
346#else
347#define MDBX_DEPRECATED
348#endif
349#endif /* MDBX_DEPRECATED */
350
351#ifndef MDBX_DEPRECATED_ENUM
352#ifdef __deprecated_enum
353#define MDBX_DEPRECATED_ENUM __deprecated_enum
354#elif defined(DOXYGEN) || \
355 (!defined(_MSC_VER) || (defined(__cplusplus) && __cplusplus >= 201403L && __has_cpp_attribute(deprecated) && \
356 __has_cpp_attribute(deprecated) >= 201309L))
357#define MDBX_DEPRECATED_ENUM MDBX_DEPRECATED
358#else
359#define MDBX_DEPRECATED_ENUM /* avoid madness MSVC */
360#endif
361#endif /* MDBX_DEPRECATED_ENUM */
362
363#ifndef __dll_export
364#if defined(_WIN32) || defined(_WIN64) || defined(__CYGWIN__) || defined(__MINGW__) || defined(__MINGW32__) || \
365 defined(__MINGW64__)
366#if defined(__GNUC__) || __has_attribute(__dllexport__)
367#define __dll_export __attribute__((__dllexport__))
368#elif defined(_MSC_VER)
369#define __dll_export __declspec(dllexport)
370#else
371#define __dll_export
372#endif
373#elif defined(__GNUC__) || defined(__clang__) || __has_attribute(__visibility__)
374#define __dll_export __attribute__((__visibility__("default")))
375#else
376#define __dll_export
377#endif
378#endif /* __dll_export */
379
380#ifndef __dll_import
381#if defined(_WIN32) || defined(_WIN64) || defined(__CYGWIN__) || defined(__MINGW__) || defined(__MINGW32__) || \
382 defined(__MINGW64__)
383#if defined(__GNUC__) || __has_attribute(__dllimport__)
384#define __dll_import __attribute__((__dllimport__))
385#elif defined(_MSC_VER)
386#define __dll_import __declspec(dllimport)
387#else
388#define __dll_import
389#endif
390#else
391#define __dll_import
392#endif
393#endif /* __dll_import */
394
399#if defined(LIBMDBX_INTERNALS) && !defined(LIBMDBX_NO_EXPORTS_LEGACY_API)
400#define LIBMDBX_INLINE_API(TYPE, NAME, ARGS) \
401 /* proto of exported which uses common impl */ LIBMDBX_API TYPE NAME ARGS; \
402 /* definition of common impl */ static __inline TYPE __inline_##NAME ARGS
403#else
404#define LIBMDBX_INLINE_API(TYPE, NAME, ARGS) static __inline TYPE NAME ARGS
405#endif /* LIBMDBX_INLINE_API */
406
408#ifndef MDBX_STRINGIFY
409#define MDBX_STRINGIFY_HELPER(x) #x
410#define MDBX_STRINGIFY(x) MDBX_STRINGIFY_HELPER(x)
411#endif /* MDBX_STRINGIFY */
412
413/*----------------------------------------------------------------------------*/
414
415#ifndef __cplusplus
416#ifndef bool
417#define bool _Bool
418#endif
419#ifndef true
420#define true (1)
421#endif
422#ifndef false
423#define false (0)
424#endif
425#endif /* bool without __cplusplus */
426
428#if defined(DOXYGEN)
429#define MDBX_CXX17_NOEXCEPT noexcept
430#elif !defined(__cpp_noexcept_function_type) || __cpp_noexcept_function_type < 201510L
431#define MDBX_CXX17_NOEXCEPT
432#else
433#define MDBX_CXX17_NOEXCEPT noexcept
434#endif /* MDBX_CXX17_NOEXCEPT */
435
437#if defined(DOXYGEN)
438#define MDBX_CXX01_CONSTEXPR constexpr
439#define MDBX_CXX01_CONSTEXPR_VAR constexpr
440#elif !defined(__cplusplus)
441#define MDBX_CXX01_CONSTEXPR __inline
442#define MDBX_CXX01_CONSTEXPR_VAR const
443#elif !defined(DOXYGEN) && \
444 ((__cplusplus < 201103L && defined(__cpp_constexpr) && __cpp_constexpr < 200704L) || \
445 (defined(__LCC__) && __LCC__ < 124) || \
446 (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ < 407) && !defined(__clang__) && !defined(__LCC__)) || \
447 (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__clang__) && __clang_major__ < 4))
448#define MDBX_CXX01_CONSTEXPR inline
449#define MDBX_CXX01_CONSTEXPR_VAR const
450#else
451#define MDBX_CXX01_CONSTEXPR constexpr
452#define MDBX_CXX01_CONSTEXPR_VAR constexpr
453#endif /* MDBX_CXX01_CONSTEXPR */
454
457#if defined(DOXYGEN)
458#define MDBX_CXX11_CONSTEXPR constexpr
459#define MDBX_CXX11_CONSTEXPR_VAR constexpr
460#elif !defined(__cplusplus)
461#define MDBX_CXX11_CONSTEXPR __inline
462#define MDBX_CXX11_CONSTEXPR_VAR const
463#elif !defined(DOXYGEN) && \
464 (!defined(__cpp_constexpr) || __cpp_constexpr < 201304L || (defined(__LCC__) && __LCC__ < 124) || \
465 (defined(__GNUC__) && __GNUC__ < 6 && !defined(__clang__) && !defined(__LCC__)) || \
466 (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__clang__) && __clang_major__ < 5))
467#define MDBX_CXX11_CONSTEXPR inline
468#define MDBX_CXX11_CONSTEXPR_VAR const
469#else
470#define MDBX_CXX11_CONSTEXPR constexpr
471#define MDBX_CXX11_CONSTEXPR_VAR constexpr
472#endif /* MDBX_CXX11_CONSTEXPR */
473
476#if defined(DOXYGEN)
477#define MDBX_CXX14_CONSTEXPR constexpr
478#define MDBX_CXX14_CONSTEXPR_VAR constexpr
479#elif !defined(__cplusplus)
480#define MDBX_CXX14_CONSTEXPR __inline
481#define MDBX_CXX14_CONSTEXPR_VAR const
482#elif defined(DOXYGEN) || \
483 defined(__cpp_constexpr) && __cpp_constexpr >= 201304L && \
484 ((defined(_MSC_VER) && _MSC_VER >= 1910) || (defined(__clang__) && __clang_major__ > 4) || \
485 (defined(__GNUC__) && __GNUC__ > 6) || (!defined(__GNUC__) && !defined(__clang__) && !defined(_MSC_VER)))
486#define MDBX_CXX14_CONSTEXPR constexpr
487#define MDBX_CXX14_CONSTEXPR_VAR constexpr
488#else
489#define MDBX_CXX14_CONSTEXPR inline
490#define MDBX_CXX14_CONSTEXPR_VAR const
491#endif /* MDBX_CXX14_CONSTEXPR */
492
493#if defined(__noreturn)
494#define MDBX_NORETURN __noreturn
495#elif defined(_Noreturn)
496#define MDBX_NORETURN _Noreturn
497#elif defined(DOXYGEN) || (defined(__cplusplus) && __cplusplus >= 201103L) || \
498 (!defined(__cplusplus) && defined(__STDC_VERSION__) && __STDC_VERSION__ > 202005L)
499#define MDBX_NORETURN [[noreturn]]
500#elif defined(__GNUC__) || __has_attribute(__noreturn__)
501#define MDBX_NORETURN __attribute__((__noreturn__))
502#elif defined(_MSC_VER) && !defined(__clang__)
503#define MDBX_NORETURN __declspec(noreturn)
504#else
505#define MDBX_NORETURN
506#endif /* MDBX_NORETURN */
507
508#ifndef MDBX_PRINTF_ARGS
509#if defined(__GNUC__) || __has_attribute(__format__) || defined(DOXYGEN)
510#if defined(__MINGW__) || defined(__MINGW32__) || defined(__MINGW64__)
511#define MDBX_PRINTF_ARGS(format_index, first_arg) __attribute__((__format__(__gnu_printf__, format_index, first_arg)))
512#else
513#define MDBX_PRINTF_ARGS(format_index, first_arg) __attribute__((__format__(__printf__, format_index, first_arg)))
514#endif /* MinGW */
515#else
516#define MDBX_PRINTF_ARGS(format_index, first_arg)
517#endif
518#endif /* MDBX_PRINTF_ARGS */
519
520#if defined(DOXYGEN) || \
521 (defined(__cplusplus) && __cplusplus >= 201603L && __has_cpp_attribute(maybe_unused) && \
522 __has_cpp_attribute(maybe_unused) >= 201603L && (!defined(__clang__) || __clang__ > 19)) || \
523 (!defined(__cplusplus) && defined(__STDC_VERSION__) && __STDC_VERSION__ > 202005L)
524#define MDBX_MAYBE_UNUSED [[maybe_unused]]
525#elif defined(__GNUC__) || __has_attribute(__unused__)
526#define MDBX_MAYBE_UNUSED __attribute__((__unused__))
527#else
528#define MDBX_MAYBE_UNUSED
529#endif /* MDBX_MAYBE_UNUSED */
530
531#if __has_attribute(no_sanitize) || defined(DOXYGEN)
532#define MDBX_NOSANITIZE_ENUM __attribute((__no_sanitize__("enum")))
533#else
534#define MDBX_NOSANITIZE_ENUM
535#endif /* MDBX_NOSANITIZE_ENUM */
536
537/* Oh, below are some songs and dances since:
538 * - C++ requires explicit definition of the necessary operators.
539 * - the proper implementation of DEFINE_ENUM_FLAG_OPERATORS for C++ required
540 * the constexpr feature which is broken in most old compilers;
541 * - DEFINE_ENUM_FLAG_OPERATORS may be defined broken as in the Windows SDK. */
542#if !defined(DEFINE_ENUM_FLAG_OPERATORS) && !defined(DOXYGEN)
543
544#ifdef __cplusplus
545#if !defined(__cpp_constexpr) || __cpp_constexpr < 200704L || (defined(__LCC__) && __LCC__ < 124) || \
546 (defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__ < 407) && !defined(__clang__) && !defined(__LCC__)) || \
547 (defined(_MSC_VER) && _MSC_VER < 1910) || (defined(__clang__) && __clang_major__ < 4)
548/* The constexpr feature is not available or (may be) broken */
549#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 0
550#else
551/* C always allows these operators for enums */
552#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 1
553#endif /* __cpp_constexpr */
554
557#define DEFINE_ENUM_FLAG_OPERATORS(ENUM) \
558 extern "C++" { \
559 MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator|(ENUM a, ENUM b) { return ENUM(unsigned(a) | unsigned(b)); } \
560 MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator|=(ENUM &a, ENUM b) { return a = a | b; } \
561 MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator&(ENUM a, ENUM b) { return ENUM(unsigned(a) & unsigned(b)); } \
562 MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator&(ENUM a, unsigned b) { return ENUM(unsigned(a) & b); } \
563 MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator&(unsigned a, ENUM b) { return ENUM(a & unsigned(b)); } \
564 MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator&=(ENUM &a, ENUM b) { return a = a & b; } \
565 MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator&=(ENUM &a, unsigned b) { return a = a & b; } \
566 MDBX_CXX01_CONSTEXPR unsigned operator~(ENUM a) { return ~unsigned(a); } \
567 MDBX_NOSANITIZE_ENUM MDBX_CXX01_CONSTEXPR ENUM operator^(ENUM a, ENUM b) { return ENUM(unsigned(a) ^ unsigned(b)); } \
568 MDBX_NOSANITIZE_ENUM MDBX_CXX14_CONSTEXPR ENUM &operator^=(ENUM &a, ENUM b) { return a = a ^ b; } \
569 }
570#else /* __cplusplus */
571/* nope for C since it always allows these operators for enums */
572#define DEFINE_ENUM_FLAG_OPERATORS(ENUM)
573#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 1
574#endif /* !__cplusplus */
575
576#elif !defined(CONSTEXPR_ENUM_FLAGS_OPERATIONS)
577
578#ifdef __cplusplus
579/* DEFINE_ENUM_FLAG_OPERATORS may be defined broken as in the Windows SDK */
580#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 0
581#else
582/* C always allows these operators for enums */
583#define CONSTEXPR_ENUM_FLAGS_OPERATIONS 1
584#endif
585
586#endif /* DEFINE_ENUM_FLAG_OPERATORS */
587
589
590/*----------------------------------------------------------------------------*/
591
594
595#ifdef __cplusplus
596extern "C" {
597#endif
598
599/* MDBX version 0.14.x, but it is unstable/under-development yet. */
600#define MDBX_VERSION_UNSTABLE
601#define MDBX_VERSION_MAJOR 0
602#define MDBX_VERSION_MINOR 14
603
604#ifndef LIBMDBX_API
605#if defined(LIBMDBX_EXPORTS) || defined(DOXYGEN)
606#define LIBMDBX_API __dll_export
607#elif defined(LIBMDBX_IMPORTS)
608#define LIBMDBX_API __dll_import
609#else
610#define LIBMDBX_API
611#endif
612#endif /* LIBMDBX_API */
613
614#ifdef __cplusplus
615#if defined(__clang__) || __has_attribute(type_visibility) || defined(DOXYGEN)
616#define LIBMDBX_API_TYPE LIBMDBX_API __attribute__((type_visibility("default")))
617#else
618#define LIBMDBX_API_TYPE LIBMDBX_API
619#endif
620#else
621#define LIBMDBX_API_TYPE
622#endif /* LIBMDBX_API_TYPE */
623
624#if defined(LIBMDBX_IMPORTS)
625#define LIBMDBX_VERINFO_API __dll_import
626#else
627#define LIBMDBX_VERINFO_API __dll_export
628#endif /* LIBMDBX_VERINFO_API */
629
632 uint16_t major;
633 uint16_t minor;
634 uint16_t patch;
635 uint16_t tweak;
636 const char *semver_prerelease;
637 struct {
638 const char *datetime;
639 const char *tree;
640 const char *commit;
641 const char *describe;
642 } git;
643 const char *sourcery;
645
650 const char *datetime;
651 const char *target;
652 const char *options;
653 const char *compiler;
654 const char *flags;
655 const char *metadata;
659
660#if (defined(_WIN32) || defined(_WIN64)) && !MDBX_BUILD_SHARED_LIBRARY
661/* MDBX internally uses global and thread local storage destructors to
662 * automatically (de)initialization, releasing reader lock table slots
663 * and so on.
664 *
665 * If MDBX built as a DLL this is done out-of-the-box by DllEntry() function,
666 * which called automatically by Windows core with passing corresponding reason
667 * argument.
668 *
669 * Otherwise, if MDBX was built not as a DLL, some black magic
670 * may be required depending of Windows version:
671 *
672 * - Modern Windows versions, including Windows Vista and later, provides
673 * support for "TLS Directory" (e.g .CRT$XL[A-Z] sections in executable
674 * or dll file). In this case, MDBX capable of doing all automatically,
675 * therefore you DON'T NEED to call mdbx_module_handler()
676 * so the MDBX_MANUAL_MODULE_HANDLER defined as 0.
677 *
678 * - Obsolete versions of Windows, prior to Windows Vista, REQUIRES calling
679 * mdbx_module_handler() manually from corresponding DllMain() or WinMain()
680 * of your DLL or application,
681 * so the MDBX_MANUAL_MODULE_HANDLER defined as 1.
682 *
683 * Therefore, building MDBX as a DLL is recommended for all version of Windows.
684 * So, if you doubt, just build MDBX as the separate DLL and don't care about
685 * the MDBX_MANUAL_MODULE_HANDLER. */
686
687#ifndef _WIN32_WINNT
688#error Non-dll build libmdbx requires target Windows version \
689 to be explicitly defined via _WIN32_WINNT for properly \
690 handling thread local storage destructors.
691#endif /* _WIN32_WINNT */
692
693#if _WIN32_WINNT >= 0x0600 /* Windows Vista */
694/* As described above mdbx_module_handler() is NOT needed for Windows Vista
695 * and later. */
696#define MDBX_MANUAL_MODULE_HANDLER 0
697#else
698/* As described above mdbx_module_handler() IS REQUIRED for Windows versions
699 * prior to Windows Vista. */
700#define MDBX_MANUAL_MODULE_HANDLER 1
701void LIBMDBX_API NTAPI mdbx_module_handler(PVOID module, DWORD reason, PVOID reserved);
702#endif
703
704#endif /* Windows && !DLL && MDBX_MANUAL_MODULE_HANDLER */
705
706/* OPACITY STRUCTURES *********************************************************/
707
712#ifndef __cplusplus
713typedef struct MDBX_env MDBX_env;
714#else
715struct MDBX_env;
716#endif
717
723#ifndef __cplusplus
724typedef struct MDBX_txn MDBX_txn;
725#else
726struct MDBX_txn;
727#endif
728
736typedef uint32_t MDBX_dbi;
737
742#ifndef __cplusplus
744#else
745struct MDBX_cursor;
746#endif
747
761#ifndef HAVE_STRUCT_IOVEC
762struct iovec {
763 void *iov_base;
764 size_t iov_len;
765};
766#define HAVE_STRUCT_IOVEC
767#endif /* HAVE_STRUCT_IOVEC */
768
769#if defined(__sun) || defined(__SVR4) || defined(__svr4__)
770/* The `iov_len` is signed on Sun/Solaris.
771 * So define custom MDBX_val to avoid a lot of warnings. */
772struct MDBX_val {
773 void *iov_base;
774 size_t iov_len;
775};
776#ifndef __cplusplus
777typedef struct MDBX_val MDBX_val;
778#endif
779#else /* SunOS */
780typedef struct iovec MDBX_val;
781#endif /* ! SunOS */
782
785 MDBX_MAX_DBI = UINT32_C(32765),
786
788 MDBX_MAXDATASIZE = UINT32_C(0x7fff0000),
789
792
795};
796
797/* THE FILES *******************************************************************
798 * At the file system level, the environment corresponds to a pair of files. */
799
800#ifndef MDBX_LOCKNAME
802#if !(defined(_WIN32) || defined(_WIN64))
803#define MDBX_LOCKNAME "/mdbx.lck"
804#else
805#define MDBX_LOCKNAME_W L"\\mdbx.lck"
806#define MDBX_LOCKNAME_A "\\mdbx.lck"
807#ifdef UNICODE
808#define MDBX_LOCKNAME MDBX_LOCKNAME_W
809#else
810#define MDBX_LOCKNAME MDBX_LOCKNAME_A
811#endif /* UNICODE */
812#endif /* Windows */
813#endif /* MDBX_LOCKNAME */
814#ifndef MDBX_DATANAME
817#if !(defined(_WIN32) || defined(_WIN64))
818#define MDBX_DATANAME "/mdbx.dat"
819#else
820#define MDBX_DATANAME_W L"\\mdbx.dat"
821#define MDBX_DATANAME_A "\\mdbx.dat"
822#ifdef UNICODE
823#define MDBX_DATANAME MDBX_DATANAME_W
824#else
825#define MDBX_DATANAME MDBX_DATANAME_A
826#endif /* UNICODE */
827#endif /* Windows */
828#endif /* MDBX_DATANAME */
829
830#ifndef MDBX_LOCK_SUFFIX
832#if !(defined(_WIN32) || defined(_WIN64))
833#define MDBX_LOCK_SUFFIX "-lck"
834#else
835#define MDBX_LOCK_SUFFIX_W L"-lck"
836#define MDBX_LOCK_SUFFIX_A "-lck"
837#ifdef UNICODE
838#define MDBX_LOCK_SUFFIX MDBX_LOCK_SUFFIX_W
839#else
840#define MDBX_LOCK_SUFFIX MDBX_LOCK_SUFFIX_A
841#endif /* UNICODE */
842#endif /* Windows */
843#endif /* MDBX_LOCK_SUFFIX */
844
845/* DEBUG & LOGGING ************************************************************/
846
850
856typedef enum MDBX_log_level {
861
867
873
879
884
889
894
899
900#ifdef ENABLE_UBSAN
901 MDBX_LOG_MAX = 7 /* avoid UBSAN false-positive trap by a tests */,
902#endif /* ENABLE_UBSAN */
903
907
915typedef enum MDBX_debug_flags {
917
922
926
930
934
937
940
944
945#ifdef ENABLE_UBSAN
946 MDBX_DBG_MAX = ((unsigned)MDBX_LOG_MAX) << 16 | 127 /* avoid UBSAN false-positive trap by a tests */,
947#endif /* ENABLE_UBSAN */
948
952DEFINE_ENUM_FLAG_OPERATORS(MDBX_debug_flags)
953
954
968typedef void (*MDBX_debug_func)(MDBX_log_level_t loglevel, const char *function, int line, const char *fmt,
969 va_list args) MDBX_CXX17_NOEXCEPT;
970
972#define MDBX_LOGGER_DONTCHANGE ((MDBX_debug_func)(intptr_t)-1)
973#define MDBX_LOGGER_NOFMT_DONTCHANGE ((MDBX_debug_func_nofmt)(intptr_t)-1)
974
981
982typedef void (*MDBX_debug_func_nofmt)(MDBX_log_level_t loglevel, const char *function, int line, const char *msg,
983 unsigned length) MDBX_CXX17_NOEXCEPT;
984
986 MDBX_debug_func_nofmt logger, char *logger_buffer, size_t logger_buffer_size);
987
998typedef void (*MDBX_assert_func)(const MDBX_env *env, const char *msg, const char *function,
999 unsigned line) MDBX_CXX17_NOEXCEPT;
1000
1011
1021LIBMDBX_API const char *mdbx_dump_val(const MDBX_val *key, char *const buf, const size_t bufsize);
1022
1024MDBX_NORETURN LIBMDBX_API void mdbx_panic(const char *fmt, ...) MDBX_PRINTF_ARGS(1, 2);
1025
1028#if !((defined(_WIN32) || defined(_WIN64)) && !MDBX_WITHOUT_MSVC_CRT)
1030#endif /* MDBX_WITHOUT_MSVC_CRT */
1031LIBMDBX_API void mdbx_assert_fail(const MDBX_env *env, const char *msg, const char *func, unsigned line);
1033
1038typedef enum MDBX_env_flags {
1040
1046 MDBX_VALIDATION = UINT32_C(0x00002000),
1047
1064 MDBX_NOSUBDIR = UINT32_C(0x4000),
1065
1082 MDBX_RDONLY = UINT32_C(0x20000),
1083
1112 MDBX_EXCLUSIVE = UINT32_C(0x400000),
1113
1127 MDBX_ACCEDE = UINT32_C(0x40000000),
1128
1158 MDBX_WRITEMAP = UINT32_C(0x80000),
1159
1208 MDBX_NOSTICKYTHREADS = UINT32_C(0x200000),
1209
1211 MDBX_NOTLS MDBX_DEPRECATED_ENUM = MDBX_NOSTICKYTHREADS,
1212
1232 MDBX_NORDAHEAD = UINT32_C(0x800000),
1233
1255 MDBX_NOMEMINIT = UINT32_C(0x1000000),
1256
1268 MDBX_COALESCE MDBX_DEPRECATED_ENUM = UINT32_C(0x2000000),
1269
1292 MDBX_LIFORECLAIM = UINT32_C(0x4000000),
1293
1295 MDBX_PAGEPERTURB = UINT32_C(0x8000000),
1296
1297 /* SYNC MODES****************************************************************/
1339
1350
1367 MDBX_NOMETASYNC = UINT32_C(0x40000),
1368
1418 MDBX_SAFE_NOSYNC = UINT32_C(0x10000),
1419
1426
1469
1472DEFINE_ENUM_FLAG_OPERATORS(MDBX_env_flags)
1473
1474
1478typedef enum MDBX_txn_flags {
1484
1490
1497#if CONSTEXPR_ENUM_FLAGS_OPERATIONS || defined(DOXYGEN)
1499#else
1500 MDBX_TXN_RDONLY_PREPARE = uint32_t(MDBX_RDONLY) | uint32_t(MDBX_NOMEMINIT),
1501#endif
1502
1504 MDBX_TXN_TRY = UINT32_C(0x10000000),
1505
1508
1512
1516
1517 /* Transaction state flags ---------------------------------------------- */
1518
1522 MDBX_TXN_INVALID = INT32_MIN,
1523
1528
1533
1538
1543
1548
1553
1560
1567
1573DEFINE_ENUM_FLAG_OPERATORS(MDBX_txn_flags)
1574
1575
1579typedef enum MDBX_db_flags {
1582
1584 MDBX_REVERSEKEY = UINT32_C(0x02),
1585
1587 MDBX_DUPSORT = UINT32_C(0x04),
1588
1594 MDBX_INTEGERKEY = UINT32_C(0x08),
1595
1598 MDBX_DUPFIXED = UINT32_C(0x10),
1599
1603 MDBX_INTEGERDUP = UINT32_C(0x20),
1604
1606 MDBX_REVERSEDUP = UINT32_C(0x40),
1607
1609 MDBX_CREATE = UINT32_C(0x40000),
1610
1623DEFINE_ENUM_FLAG_OPERATORS(MDBX_db_flags)
1624
1625
1629typedef enum MDBX_put_flags {
1632
1634 MDBX_NOOVERWRITE = UINT32_C(0x10),
1635
1638 MDBX_NODUPDATA = UINT32_C(0x20),
1639
1644 MDBX_CURRENT = UINT32_C(0x40),
1645
1649 MDBX_ALLDUPS = UINT32_C(0x80),
1650
1653 MDBX_RESERVE = UINT32_C(0x10000),
1654
1657 MDBX_APPEND = UINT32_C(0x20000),
1658
1662 MDBX_APPENDDUP = UINT32_C(0x40000),
1663
1666 MDBX_MULTIPLE = UINT32_C(0x80000)
1668DEFINE_ENUM_FLAG_OPERATORS(MDBX_put_flags)
1669
1670
1704DEFINE_ENUM_FLAG_OPERATORS(MDBX_copy_flags)
1705
1706
1831
1837typedef enum MDBX_error {
1840
1843
1846
1849
1852
1855
1858
1861
1864 MDBX_PANIC = -30795,
1865
1868
1871
1874
1877
1880
1883
1887
1890
1899
1907
1910
1915
1919
1923
1926
1929
1932 MDBX_BUSY = -30778,
1933
1936
1939
1944
1948
1951
1955
1959
1962
1967
1970
1974
1977 MDBX_OUSTED = -30411,
1978
1981
1985
1986 /* The last of MDBX-added error codes */
1988
1989#if defined(_WIN32) || defined(_WIN64)
1990 MDBX_ENODATA = ERROR_HANDLE_EOF,
1991 MDBX_EINVAL = ERROR_INVALID_PARAMETER,
1992 MDBX_EACCESS = ERROR_ACCESS_DENIED,
1993 MDBX_ENOMEM = ERROR_OUTOFMEMORY,
1994 MDBX_EROFS = ERROR_FILE_READ_ONLY,
1995 MDBX_ENOSYS = ERROR_NOT_SUPPORTED,
1996 MDBX_EIO = ERROR_WRITE_FAULT,
1997 MDBX_EPERM = ERROR_INVALID_FUNCTION,
1998 MDBX_EINTR = ERROR_CANCELLED,
1999 MDBX_ENOFILE = ERROR_FILE_NOT_FOUND,
2000 MDBX_EREMOTE = ERROR_REMOTE_STORAGE_MEDIA_ERROR,
2001 MDBX_EDEADLK = ERROR_POSSIBLE_DEADLOCK
2002#else /* Windows */
2003#if defined(ENODATA) || defined(DOXYGEN)
2004 MDBX_ENODATA = ENODATA,
2005#else
2006 MDBX_ENODATA = 9919 /* for compatibility with LLVM's C++ libraries/headers */,
2007#endif /* ENODATA */
2008 MDBX_EINVAL = EINVAL,
2010 MDBX_ENOMEM = ENOMEM,
2011 MDBX_EROFS = EROFS,
2012#if defined(ENOTSUP) || defined(DOXYGEN)
2013 MDBX_ENOSYS = ENOTSUP,
2014#else
2015 MDBX_ENOSYS = ENOSYS,
2016#endif /* ENOTSUP */
2018 MDBX_EPERM = EPERM,
2019 MDBX_EINTR = EINTR,
2021#if defined(EREMOTEIO) || defined(DOXYGEN)
2023 MDBX_EREMOTE = EREMOTEIO,
2024#else
2025 MDBX_EREMOTE = ENOTBLK,
2026#endif /* EREMOTEIO */
2028#endif /* !Windows */
2029} MDBX_error_t;
2030
2035MDBX_DEPRECATED static __inline int MDBX_MAP_RESIZED_is_deprecated(void) { return MDBX_UNABLE_EXTEND_MAPSIZE; }
2036#define MDBX_MAP_RESIZED MDBX_MAP_RESIZED_is_deprecated()
2037
2056LIBMDBX_API const char *mdbx_strerror(int errnum);
2057
2082LIBMDBX_API const char *mdbx_strerror_r(int errnum, char *buf, size_t buflen);
2084
2085#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)
2090LIBMDBX_API const char *mdbx_strerror_ANSI2OEM(int errnum);
2091
2096LIBMDBX_API const char *mdbx_strerror_r_ANSI2OEM(int errnum, char *buf, size_t buflen);
2097#endif /* Bit of Windows' madness */
2098
2114
2429
2440LIBMDBX_API int mdbx_env_set_option(MDBX_env *env, const MDBX_option_t option, uint64_t value);
2441
2452LIBMDBX_API int mdbx_env_get_option(const MDBX_env *env, const MDBX_option_t option, uint64_t *pvalue);
2453
2529LIBMDBX_API int mdbx_env_open(MDBX_env *env, const char *pathname, MDBX_env_flags_t flags, mdbx_mode_t mode);
2530
2531#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)
2535LIBMDBX_API int mdbx_env_openW(MDBX_env *env, const wchar_t *pathname, MDBX_env_flags_t flags, mdbx_mode_t mode);
2536#define mdbx_env_openT(env, pathname, flags, mode) mdbx_env_openW(env, pathname, flags, mode)
2537#else
2538#define mdbx_env_openT(env, pathname, flags, mode) mdbx_env_open(env, pathname, flags, mode)
2539#endif /* Windows */
2540
2558
2579
2580#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)
2585LIBMDBX_API int mdbx_env_deleteW(const wchar_t *pathname, MDBX_env_delete_mode_t mode);
2586#define mdbx_env_deleteT(pathname, mode) mdbx_env_deleteW(pathname, mode)
2587#else
2588#define mdbx_env_deleteT(pathname, mode) mdbx_env_delete(pathname, mode)
2589#endif /* Windows */
2590
2644LIBMDBX_API int mdbx_env_copy(MDBX_env *env, const char *dest, MDBX_copy_flags_t flags);
2645
2700
2701#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)
2706LIBMDBX_API int mdbx_env_copyW(MDBX_env *env, const wchar_t *dest, MDBX_copy_flags_t flags);
2707#define mdbx_env_copyT(env, dest, flags) mdbx_env_copyW(env, dest, flags)
2708
2714#define mdbx_txn_copy2pathnameT(txn, dest, flags) mdbx_txn_copy2pathnameW(txn, dest, path)
2715#else
2716#define mdbx_env_copyT(env, dest, flags) mdbx_env_copy(env, dest, flags)
2717#define mdbx_txn_copy2pathnameT(txn, dest, flags) mdbx_txn_copy2pathname(txn, dest, path)
2718#endif /* Windows */
2719
2745
2770
2775 uint32_t ms_psize;
2777 uint32_t ms_depth;
2779 uint64_t ms_leaf_pages;
2781 uint64_t ms_entries;
2782 uint64_t ms_mod_txnid;
2783};
2784#ifndef __cplusplus
2786typedef struct MDBX_stat MDBX_stat;
2787#endif
2788
2808LIBMDBX_API int mdbx_env_stat_ex(const MDBX_env *env, const MDBX_txn *txn, MDBX_stat *stat, size_t bytes);
2809
2813MDBX_DEPRECATED inline int mdbx_env_stat(const MDBX_env *env, MDBX_stat *stat, size_t bytes) {
2814 return mdbx_env_stat_ex(env, NULL, stat, bytes);
2815}
2816
2821 struct {
2822 uint64_t lower;
2823 uint64_t upper;
2824 uint64_t current;
2825 uint64_t shrink;
2826 uint64_t grow;
2828 uint64_t mi_mapsize;
2829 uint64_t mi_dxb_fsize;
2831 uint64_t mi_last_pgno;
2836 uint32_t mi_maxreaders;
2837 uint32_t mi_numreaders;
2840 uint32_t mi_sys_upcblk;
2841 uint32_t mi_sys_ioblk;
2842
2851 struct {
2852 struct {
2853 uint64_t x, y;
2854 } current, meta[3];
2856
2873 uint32_t mi_mode;
2874
2880 struct {
2881 uint64_t newly;
2882 uint64_t cow;
2883 uint64_t clone;
2885 uint64_t split;
2886 uint64_t merge;
2887 uint64_t spill;
2888 uint64_t unspill;
2889 uint64_t wops;
2891 uint64_t prefault;
2892 uint64_t mincore;
2893 uint64_t msync;
2894 uint64_t fsync;
2896
2897 /* GUID of the database DXB file. */
2898 struct {
2899 uint64_t x, y;
2901};
2902#ifndef __cplusplus
2904typedef struct MDBX_envinfo MDBX_envinfo;
2905#endif
2906
2927LIBMDBX_API int mdbx_env_info_ex(const MDBX_env *env, const MDBX_txn *txn, MDBX_envinfo *info, size_t bytes);
2931MDBX_DEPRECATED inline int mdbx_env_info(const MDBX_env *env, MDBX_envinfo *info, size_t bytes) {
2932 return mdbx_env_info_ex(env, NULL, info, bytes);
2933}
2934
2971LIBMDBX_API int mdbx_env_sync_ex(MDBX_env *env, bool force, bool nonblock);
2972
2976inline int mdbx_env_sync(MDBX_env * env) { return mdbx_env_sync_ex(env, true, false); }
2977
2981inline int mdbx_env_sync_poll(MDBX_env * env) { return mdbx_env_sync_ex(env, false, true); }
2982
3006inline int mdbx_env_set_syncbytes(MDBX_env * env, size_t threshold) {
3007 return mdbx_env_set_option(env, MDBX_opt_sync_bytes, threshold);
3008}
3009
3024inline int mdbx_env_get_syncbytes(const MDBX_env *env, size_t *threshold) {
3025 int rc = MDBX_EINVAL;
3026 if (threshold) {
3027 uint64_t proxy = 0;
3028 rc = mdbx_env_get_option(env, MDBX_opt_sync_bytes, &proxy);
3029#ifdef assert
3030 assert(proxy <= SIZE_MAX);
3031#endif /* assert */
3032 *threshold = (size_t)proxy;
3033 }
3034 return rc;
3035}
3036
3067inline int mdbx_env_set_syncperiod(MDBX_env * env, unsigned seconds_16dot16) {
3068 return mdbx_env_set_option(env, MDBX_opt_sync_period, seconds_16dot16);
3069}
3070
3087inline int mdbx_env_get_syncperiod(const MDBX_env *env, unsigned *period_seconds_16dot16) {
3088 int rc = MDBX_EINVAL;
3089 if (period_seconds_16dot16) {
3090 uint64_t proxy = 0;
3091 rc = mdbx_env_get_option(env, MDBX_opt_sync_period, &proxy);
3092#ifdef assert
3093 assert(proxy <= UINT32_MAX);
3094#endif /* assert */
3095 *period_seconds_16dot16 = (unsigned)proxy;
3096 }
3097 return rc;
3098}
3099
3139LIBMDBX_API int mdbx_env_close_ex(MDBX_env *env, bool dont_sync);
3140
3144inline int mdbx_env_close(MDBX_env * env) { return mdbx_env_close_ex(env, false); }
3145
3146#if defined(DOXYGEN) || !(defined(_WIN32) || defined(_WIN64))
3206#endif /* Windows */
3207
3256DEFINE_ENUM_FLAG_OPERATORS(MDBX_warmup_flags)
3257
3258
3289 unsigned timeout_seconds_16dot16);
3290
3312
3323LIBMDBX_API int mdbx_env_get_flags(const MDBX_env *env, unsigned *flags);
3324
3338LIBMDBX_API int mdbx_env_get_path(const MDBX_env *env, const char **dest);
3339
3340#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)
3345LIBMDBX_API int mdbx_env_get_pathW(const MDBX_env *env, const wchar_t **dest);
3346#define mdbx_env_get_pathT(env, dest) mdbx_env_get_pathW(env, dest)
3347#else
3348#define mdbx_env_get_pathT(env, dest) mdbx_env_get_path(env, dest)
3349#endif /* Windows */
3350
3364
3561LIBMDBX_API int mdbx_env_set_geometry(MDBX_env *env, intptr_t size_lower, intptr_t size_now, intptr_t size_upper,
3562 intptr_t growth_step, intptr_t shrink_threshold, intptr_t pagesize);
3563
3566MDBX_DEPRECATED inline int mdbx_env_set_mapsize(MDBX_env * env, size_t size) {
3567 return mdbx_env_set_geometry(env, size, size, size, -1, -1, -1);
3568}
3569
3585LIBMDBX_API int mdbx_is_readahead_reasonable(size_t volume, intptr_t redundancy);
3586
3590
3594
3599
3604
3610
3615
3621
3626
3632 MDBX_db_flags_t flags);
3633
3640
3645
3669inline int mdbx_env_set_maxreaders(MDBX_env * env, unsigned readers) {
3670 return mdbx_env_set_option(env, MDBX_opt_max_readers, readers);
3671}
3672
3684inline int mdbx_env_get_maxreaders(const MDBX_env *env, unsigned *readers) {
3685 int rc = MDBX_EINVAL;
3686 if (readers) {
3687 uint64_t proxy = 0;
3688 rc = mdbx_env_get_option(env, MDBX_opt_max_readers, &proxy);
3689 *readers = (unsigned)proxy;
3690 }
3691 return rc;
3692}
3693
3715inline int mdbx_env_set_maxdbs(MDBX_env * env, MDBX_dbi dbs) {
3716 return mdbx_env_set_option(env, MDBX_opt_max_db, dbs);
3717}
3718
3729inline int mdbx_env_get_maxdbs(const MDBX_env *env, MDBX_dbi *dbs) {
3730 int rc = MDBX_EINVAL;
3731 if (dbs) {
3732 uint64_t proxy = 0;
3733 rc = mdbx_env_get_option(env, MDBX_opt_max_db, &proxy);
3734 *dbs = (MDBX_dbi)proxy;
3735 }
3736 return rc;
3737}
3738
3744
3759LIBMDBX_API int mdbx_get_sysraminfo(intptr_t *page_size, intptr_t *total_pages, intptr_t *avail_pages);
3760
3771
3782
3787
3798
3810
3820
3829
3889 void *context);
3890
3945inline int mdbx_txn_begin(MDBX_env * env, MDBX_txn *parent, MDBX_txn_flags_t flags, MDBX_txn **txn) {
3946 return mdbx_txn_begin_ex(env, parent, flags, txn, NULL);
3947}
3948
4000LIBMDBX_API int mdbx_txn_clone(const MDBX_txn *origin, MDBX_txn **in_out_clone, void *context);
4001
4012
4024
4031 uint64_t txn_id;
4032
4038
4042
4045
4049
4057
4064
4071};
4072#ifndef __cplusplus
4074typedef struct MDBX_txn_info MDBX_txn_info;
4075#endif
4076
4090LIBMDBX_API int mdbx_txn_info(const MDBX_txn *txn, MDBX_txn_info *info, bool scan_rlt);
4091
4097
4108
4121
4129 uint32_t preparation;
4133 uint32_t audit;
4136 uint32_t write;
4139 uint32_t sync;
4141 uint32_t ending;
4143 uint32_t whole;
4145 uint32_t gc_cputime;
4146
4155 struct {
4157 uint32_t wloops;
4159 uint32_t coalescences;
4162 uint32_t wipes;
4165 uint32_t flushes;
4168 uint32_t kicks;
4169
4171 uint32_t work_counter;
4173 uint32_t work_rtime_monotonic;
4176 uint32_t work_xtime_cpu;
4178 uint32_t work_rsteps;
4180 uint32_t work_xpages;
4182 uint32_t work_majflt;
4183
4185 uint32_t self_counter;
4188 uint32_t self_rtime_monotonic;
4191 uint32_t self_xtime_cpu;
4194 uint32_t self_rsteps;
4196 uint32_t self_xpages;
4198 uint32_t self_majflt;
4200 struct {
4201 uint32_t time;
4202 uint64_t volume;
4203 uint32_t calls;
4204 } pnl_merge_work, pnl_merge_self;
4205
4206 uint32_t max_reader_lag;
4208 uint32_t max_retained_pages;
4210};
4211#ifndef __cplusplus
4214#endif
4215
4269
4305
4342
4406LIBMDBX_API int mdbx_txn_amend(MDBX_txn *read_txn, MDBX_txn **ptr_write_txn, MDBX_txn_flags_t flags, void *context);
4407
4434
4485inline int mdbx_txn_commit(MDBX_txn * txn) { return mdbx_txn_commit_ex(txn, NULL); }
4486
4499
4542inline int mdbx_txn_abort(MDBX_txn * txn) { return mdbx_txn_abort_ex(txn, NULL); }
4543
4556
4591
4624LIBMDBX_API int mdbx_txn_park(MDBX_txn *txn, bool autounpark);
4625
4657LIBMDBX_API int mdbx_txn_unpark(MDBX_txn *txn, bool restart_if_ousted);
4658
4683
4709
4721 uint64_t x, y, z, v;
4722};
4723#ifndef __cplusplus
4725typedef struct MDBX_canary MDBX_canary;
4726#endif
4727
4747
4759
4780typedef int (*MDBX_cmp_func)(const MDBX_val *a, const MDBX_val *b) MDBX_CXX17_NOEXCEPT;
4781
4875LIBMDBX_API int mdbx_dbi_open(MDBX_txn *txn, const char *name, MDBX_db_flags_t flags, MDBX_dbi *dbi);
4879
4898MDBX_DEPRECATED LIBMDBX_API int mdbx_dbi_open_ex(MDBX_txn *txn, const char *name, MDBX_db_flags_t flags, MDBX_dbi *dbi,
4899 MDBX_cmp_func keycmp, MDBX_cmp_func datacmp);
4902MDBX_DEPRECATED LIBMDBX_API int mdbx_dbi_open_ex2(MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags,
4903 MDBX_dbi *dbi, MDBX_cmp_func keycmp, MDBX_cmp_func datacmp);
4904
4918LIBMDBX_API int mdbx_dbi_rename(MDBX_txn *txn, MDBX_dbi dbi, const char *name);
4922
4938typedef int (*MDBX_table_enum_func)(void *ctx, const MDBX_txn *txn, const MDBX_val *name, MDBX_db_flags_t flags,
4939 const struct MDBX_stat *stat, MDBX_dbi dbi) MDBX_CXX17_NOEXCEPT;
4940
4959
4972
4974
4975MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API uint64_t mdbx_key_from_ptrdouble(const double *const ieee754_64bit);
4976
4978
4979MDBX_NOTHROW_PURE_FUNCTION LIBMDBX_API uint32_t mdbx_key_from_ptrfloat(const float *const ieee754_32bit);
4980
4981MDBX_NOTHROW_CONST_FUNCTION inline uint64_t mdbx_key_from_int64(const int64_t i64) {
4982 return UINT64_C(0x8000000000000000) + i64;
4983}
4984
4985MDBX_NOTHROW_CONST_FUNCTION inline uint32_t mdbx_key_from_int32(const int32_t i32) {
4986 return UINT32_C(0x80000000) + i32;
4987}
4988
4989
4996
4998
5000
5002
5005
5020LIBMDBX_API int mdbx_dbi_stat(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_stat *stat, size_t bytes);
5021
5037LIBMDBX_API int mdbx_dbi_dupsort_depthmask(const MDBX_txn *txn, MDBX_dbi dbi, uint32_t *mask);
5038
5042typedef enum MDBX_dbi_state {
5052DEFINE_ENUM_FLAG_OPERATORS(MDBX_dbi_state)
5053
5054
5065LIBMDBX_API int mdbx_dbi_flags_ex(const MDBX_txn *txn, MDBX_dbi dbi, unsigned *flags, unsigned *state);
5070inline int mdbx_dbi_flags(const MDBX_txn *txn, MDBX_dbi dbi, unsigned *flags) {
5071 unsigned state;
5072 return mdbx_dbi_flags_ex(txn, dbi, flags, &state);
5073}
5074
5101
5113LIBMDBX_API int mdbx_drop(MDBX_txn *txn, MDBX_dbi dbi, bool del);
5114
5151LIBMDBX_API int mdbx_get(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data);
5152
5182LIBMDBX_API int mdbx_get_ex(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_val *key, MDBX_val *data, size_t *values_count);
5183
5213
5227typedef struct MDBX_cache_entry {
5228 uint64_t trunk_txnid;
5232 size_t offset;
5234 uint32_t length;
5236
5242 entry->offset = 0;
5243 entry->length = 0;
5244 entry->trunk_txnid = 0;
5245 entry->last_confirmed_txnid = 0;
5246}
5247
5322
5333
5359 volatile MDBX_cache_entry_t *entry);
5360
5386 MDBX_val *data, MDBX_cache_entry_t *entry);
5387
5469LIBMDBX_API int mdbx_put(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *data, MDBX_put_flags_t flags);
5470
5515LIBMDBX_API int mdbx_replace(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *new_data, MDBX_val *old_data,
5516 MDBX_put_flags_t flags);
5517
5520typedef int (*MDBX_preserve_func)(void *context, MDBX_val *target, const void *src, size_t bytes);
5521
5575LIBMDBX_API int mdbx_replace_ex(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, MDBX_val *new_data,
5576 MDBX_val *old_data, MDBX_put_flags_t flags, MDBX_preserve_func preserver,
5577 void *preserver_context);
5578
5604LIBMDBX_API int mdbx_del(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, const MDBX_val *data);
5605
5629
5640
5651
5682
5709
5721
5753
5774
5797
5820LIBMDBX_API int mdbx_txn_release_all_cursors_ex(const MDBX_txn *txn, bool unbind, size_t *count);
5821
5842inline int mdbx_txn_release_all_cursors(const MDBX_txn *txn, bool unbind) {
5843 return mdbx_txn_release_all_cursors_ex(txn, unbind, NULL);
5844}
5845
5871
5877
5883
5895
5914LIBMDBX_API int mdbx_cursor_compare(const MDBX_cursor *left, const MDBX_cursor *right, bool ignore_multival);
5915
5948
5962
5990typedef int (*MDBX_predicate_func)(void *context, MDBX_val *key, MDBX_val *value, void *arg) MDBX_CXX17_NOEXCEPT;
5991
6043LIBMDBX_API int mdbx_cursor_scan(MDBX_cursor *cursor, MDBX_predicate_func predicate, void *context,
6044 MDBX_cursor_op start_op, MDBX_cursor_op turn_op, void *arg);
6045
6116 MDBX_cursor_op from_op, MDBX_val *from_key, MDBX_val *from_value,
6117 MDBX_cursor_op turn_op, void *arg);
6118
6160LIBMDBX_API int mdbx_cursor_get_batch(MDBX_cursor *cursor, size_t *count, MDBX_val *pairs, size_t limit,
6161 MDBX_cursor_op op);
6162
6244
6276
6297
6324LIBMDBX_API int mdbx_cursor_bunch_delete(MDBX_cursor *cursor, MDBX_bunch_action_t action, uint64_t *number_of_affected);
6325
6343LIBMDBX_API int mdbx_cursor_count(const MDBX_cursor *cursor, size_t *count);
6344
6367LIBMDBX_API int mdbx_cursor_count_ex(const MDBX_cursor *cursor, size_t *count, MDBX_stat *stat, size_t bytes);
6368
6382
6395
6410
6421
6435
6460
6480LIBMDBX_API int mdbx_estimate_distance(const MDBX_cursor *first, const MDBX_cursor *last, ptrdiff_t *distance_items);
6481
6503 ptrdiff_t *distance_items);
6504
6529LIBMDBX_API int mdbx_estimate_range(const MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *begin_key,
6530 const MDBX_val *begin_data, const MDBX_val *end_key, const MDBX_val *end_data,
6531 ptrdiff_t *distance_items);
6532
6535#define MDBX_EPSILON ((MDBX_val *)((ptrdiff_t)-1))
6536
6571
6592LIBMDBX_API int mdbx_dbi_sequence(MDBX_txn *txn, MDBX_dbi dbi, uint64_t *result, uint64_t increment);
6593
6610 const MDBX_val *b);
6611
6615
6632 const MDBX_val *b);
6633
6637
6663typedef int (*MDBX_reader_list_func)(void *ctx, int num, int slot, mdbx_pid_t pid, mdbx_tid_t thread, uint64_t txnid,
6664 uint64_t lag, size_t bytes_used, size_t bytes_retained) MDBX_CXX17_NOEXCEPT;
6665
6678
6688
6701MDBX_DEPRECATED LIBMDBX_API int mdbx_txn_straggler(const MDBX_txn *txn, int *percent);
6702
6722
6737
6811typedef int (*MDBX_hsr_func)(const MDBX_env *env, const MDBX_txn *txn, mdbx_pid_t pid, mdbx_tid_t tid, uint64_t laggard,
6812 unsigned gap, size_t space, int retry) MDBX_CXX17_NOEXCEPT;
6813
6833
6847
6853
6858LIBMDBX_API int mdbx_txn_lock(MDBX_env *env, bool dont_wait);
6859
6865
6876LIBMDBX_API int mdbx_env_open_for_recovery(MDBX_env *env, const char *pathname, unsigned target_meta, bool writeable);
6877
6878#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)
6883LIBMDBX_API int mdbx_env_open_for_recoveryW(MDBX_env *env, const wchar_t *pathname, unsigned target_meta,
6884 bool writeable);
6885#define mdbx_env_open_for_recoveryT(env, pathname, target_mets, writeable) \
6886 mdbx_env_open_for_recoveryW(env, pathname, target_mets, writeable)
6887#else
6888#define mdbx_env_open_for_recoveryT(env, pathname, target_mets, writeable) \
6889 mdbx_env_open_for_recovery(env, pathname, target_mets, writeable)
6890#endif /* Windows */
6891
6897LIBMDBX_API int mdbx_env_turn_for_recovery(MDBX_env *env, unsigned target_meta);
6898
6925LIBMDBX_API int mdbx_preopen_snapinfo(const char *pathname, MDBX_envinfo *info, size_t bytes);
6926#if defined(_WIN32) || defined(_WIN64) || defined(DOXYGEN)
6931LIBMDBX_API int mdbx_preopen_snapinfoW(const wchar_t *pathname, MDBX_envinfo *info, size_t bytes);
6932#define mdbx_preopen_snapinfoT(pathname, info, bytes) mdbx_preopen_snapinfoW(pathname, info, bytes)
6933#else
6934#define mdbx_preopen_snapinfoT(pathname, info, bytes) mdbx_preopen_snapinfo(pathname, info, bytes)
6935#endif /* Windows */
6936
6959DEFINE_ENUM_FLAG_OPERATORS(MDBX_chk_flags)
6960
6961
6979
6997
7001typedef struct MDBX_chk_line {
7002 struct MDBX_chk_context *ctx;
7004 char *begin, *end, *out;
7006
7010typedef struct MDBX_chk_issue {
7011 struct MDBX_chk_issue *next;
7012 size_t count;
7013 const char *caption;
7015
7019typedef struct MDBX_chk_scope {
7021 struct MDBX_chk_internal *internal;
7022 const void *object;
7026 union {
7027 void *ptr;
7028 size_t number;
7029 } usr_z, usr_v, usr_o;
7031
7036typedef struct MDBX_chk_user_table_cookie MDBX_chk_user_table_cookie_t;
7037
7043 struct {
7044 size_t begin, end, amount, count;
7046};
7047
7051typedef struct MDBX_chk_table {
7053
7055#define MDBX_CHK_MAIN ((void *)((ptrdiff_t)0))
7057#define MDBX_CHK_GC ((void *)((ptrdiff_t)-1))
7059#define MDBX_CHK_META ((void *)((ptrdiff_t)-2))
7060
7063 int id;
7064
7066 struct {
7067 size_t all, empty, broken;
7068 size_t branch, leaf;
7070 } pages;
7094
7122
7135typedef struct MDBX_chk_callbacks {
7137 int (*scope_push)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner, const char *fmt,
7138 va_list args);
7141 void (*issue)(MDBX_chk_context_t *ctx, const char *object, uint64_t entry_number, const char *issue,
7142 const char *extra_fmt, va_list extra_args);
7144 int (*table_conclude)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table, MDBX_cursor *cursor, int err);
7146
7147 int (*table_handle_kv)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table, size_t entry_number,
7148 const MDBX_val *key, const MDBX_val *value);
7149
7152
7156 void (*print_chars)(MDBX_chk_line_t *, const char *str, size_t len);
7157 void (*print_format)(MDBX_chk_line_t *, const char *fmt, va_list args);
7158 void (*print_size)(MDBX_chk_line_t *, const char *prefix, const uint64_t value, const char *suffix);
7160
7185 const MDBX_chk_flags_t flags, MDBX_chk_severity_t verbosity,
7186 unsigned timeout_seconds_16dot16);
7187
7199
7208LIBMDBX_API const char *mdbx_ratio2digits(uint64_t numerator, uint64_t denominator, int precision, char *buffer,
7209 size_t buffer_size);
7210
7218LIBMDBX_API const char *mdbx_ratio2percents(uint64_t value, uint64_t whole, char *buffer, size_t buffer_size);
7219
7221
7239typedef int (*MDBX_gc_iter_func)(void *ctx, const MDBX_txn *txn, uint64_t span_txnid, size_t span_pgno,
7240 size_t span_length, bool span_is_reclaimable) MDBX_CXX17_NOEXCEPT;
7241
7245typedef struct MDBX_gc_info {
7249 size_t pages_gc;
7251 struct {
7252 size_t pages;
7253 struct MDBX_chk_histogram
7256 } gc_reclaimable;
7260
7292LIBMDBX_API int mdbx_gc_info(MDBX_txn *txn, MDBX_gc_info_t *info, size_t bytes, MDBX_gc_iter_func iter_func,
7293 void *iter_ctx);
7294
7309DEFINE_ENUM_FLAG_OPERATORS(MDBX_defrag_stopping_reasons)
7310
7311
7315typedef struct MDBX_defrag_result {
7320
7323
7326
7330
7333
7336
7340
7344
7354
7358
7360 unsigned cycles;
7361
7365
7369
7384typedef int (*MDBX_defrag_notify_func)(void *ctx, const MDBX_defrag_result_t *progress) MDBX_CXX17_NOEXCEPT;
7385
7475LIBMDBX_API int mdbx_env_defrag(MDBX_env *env, size_t defrag_atleast, size_t time_atleast_16dot16, size_t defrag_enough,
7476 size_t time_limit_16dot16, intptr_t acceptable_backlash, intptr_t preferred_batch,
7477 MDBX_defrag_notify_func progress_callback, void *ctx, MDBX_defrag_result_t *result);
7478
7480
7481#ifdef __cplusplus
7482} /* extern "C" */
7483#endif
7484
7485#endif /* LIBMDBX_H */
#define MDBX_NOTHROW_CONST_FUNCTION
The 'const nothrow' function attribute for optimization.
Definition mdbx.h:315
#define MDBX_CXX17_NOEXCEPT
Definition mdbx.h:429
#define MDBX_NOTHROW_PURE_FUNCTION
The 'pure nothrow' function attribute for optimization.
Definition mdbx.h:274
#define MDBX_NORETURN
Definition mdbx.h:499
uint64_t mi_mapsize
Definition mdbx.h:2828
uint32_t wipes
The number of previous reliable/stable committed points erased when working in MDBX_UTTERLY_NOSYNC mo...
size_t pages_scheduled
Definition mdbx.h:7325
uint64_t txn_space_dirty
Definition mdbx.h:4070
struct MDBX_envinfo::@012005163333303136244023145022271211024347140371 mi_geo
uint32_t gc_cputime
User-mode CPU time spent on GC update.
Definition mdbx.h:4145
const char * describe
struct MDBX_chk_histogram pgno_distribution
uint32_t mi_dxb_pagesize
Definition mdbx.h:2838
uint32_t mi_maxreaders
Definition mdbx.h:2836
MDBX_error_t errcode
Definition mdbx.h:5329
uint64_t v
Definition mdbx.h:4721
uint64_t obstructed_txnid
Definition mdbx.h:7347
intptr_t pages_shrinked
Definition mdbx.h:7319
size_t obstructed_span
Definition mdbx.h:7343
uint32_t coalescences
The number of iterations of merging GC items.
uint32_t mi_numreaders
Definition mdbx.h:2837
uint16_t patch
Definition mdbx.h:634
const char * metadata
Definition mdbx.h:655
uint32_t mi_since_sync_seconds16dot16
Definition mdbx.h:2864
uint32_t length
Definition mdbx.h:5234
uint32_t self_xpages
The number of page sequences allocation requests for the GC itself.
uint16_t major
Definition mdbx.h:632
uint64_t txn_reader_lag
Definition mdbx.h:4037
uint64_t mi_meta_txnid[3]
Definition mdbx.h:2835
MDBX_cache_status_t status
Definition mdbx.h:5331
uint64_t txn_space_leftover
Definition mdbx.h:4063
struct MDBX_envinfo::@366225332126364017271247035205240304242123014254 mi_pgop_stat
uint64_t txn_space_used
Definition mdbx.h:4041
const char * datetime
Definition mdbx.h:650
mdbx_tid_t obstructor_tid
Definition mdbx.h:7350
size_t pages_total
Definition mdbx.h:7246
uint64_t mi_recent_txnid
Definition mdbx.h:2832
size_t pages_moved
Definition mdbx.h:7322
uint64_t mi_autosync_threshold
Definition mdbx.h:2860
size_t pages_allocated
Definition mdbx.h:7248
const char * semver_prerelease
Definition mdbx.h:636
uint32_t wloops
The number of GC update iterations is greater than 1 if there were repeats/restarts.
size_t pages_gc
Definition mdbx.h:7249
uint64_t ms_branch_pages
Definition mdbx.h:2778
uint64_t ms_entries
Definition mdbx.h:2781
uint32_t gc_wallclock
Duration of GC update by wall clock.
Definition mdbx.h:4131
unsigned rough_estimation_cycle_progress_permille
Definition mdbx.h:7357
uint16_t minor
Definition mdbx.h:633
size_t offset
Definition mdbx.h:5232
uint32_t mi_since_reader_check_seconds16dot16
Definition mdbx.h:2870
uint64_t y
Definition mdbx.h:4721
size_t max_retained_pages
Definition mdbx.h:7258
size_t max_reader_lag
Definition mdbx.h:7257
uint64_t last_confirmed_txnid
Definition mdbx.h:5230
unsigned stopping_reasons
Definition mdbx.h:7364
struct MDBX_envinfo::@041066021046127331076001156004251200350305323267 mi_dxbid
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:4139
uint32_t mi_sys_ioblk
Definition mdbx.h:2841
mdbx_pid_t obstructor_pid
Definition mdbx.h:7353
uint64_t txn_space_limit_soft
Definition mdbx.h:4044
uint32_t mi_mode
Definition mdbx.h:2873
size_t pages_retained
Definition mdbx.h:7329
const char * options
Definition mdbx.h:652
uint64_t txn_id
Definition mdbx.h:4031
const char * sourcery
Definition mdbx.h:643
uint64_t mi_latter_reader_txnid
Definition mdbx.h:2833
uint64_t ms_overflow_pages
Definition mdbx.h:2780
uint32_t self_rsteps
The number of search iterations inside the GC when allocating pages for the purposes of maintaining a...
struct MDBX_envinfo::@036110245144360117333346206230046231375034327042 mi_bootid
A mostly unique ID that is regenerated on each boot.
uint32_t self_majflt
The number of page faults within the GC when allocating and preparing pages for the GC itself.
uint32_t work_majflt
The number of page faults inside the GC when allocating and preparing pages for user's data.
uint32_t preparation
Duration of preparation (commit child transactions, update table's records and cursors destroying).
Definition mdbx.h:4129
uint32_t mi_sys_upcblk
Definition mdbx.h:2840
uint64_t z
Definition mdbx.h:4721
unsigned cycles
Definition mdbx.h:7360
uint64_t txn_space_limit_hard
Definition mdbx.h:4048
uint32_t whole
The total duration of a commit.
Definition mdbx.h:4143
uint32_t flushes
The number of forced commits to disk to avoid the database growth when working outside of MDBX_UTTERL...
uint32_t work_xpages
The number of requests to allocate page sequences for the sake of user's data.
const char * flags
Definition mdbx.h:654
uint32_t self_counter
The GC's slow path execution count is for the purposes of maintaining and updating the GC itself.
size_t pages_whole
Definition mdbx.h:7335
struct MDBX_chk_histogram span_histogram
uint32_t self_rtime_monotonic
The time "by the wall clock" spent reading and searching inside the GC for the purposes of maintainin...
struct MDBX_commit_latency::@063112077126007214166021162020057361221355030117 gc_prof
Information for GC profiling.
uint64_t mi_meta_sign[3]
Definition mdbx.h:2835
uint32_t ms_psize
Definition mdbx.h:2775
uint32_t kicks
The number of accesses to the Handle-Slow-Readers mechanism to avoid void the database growth.
uint32_t audit
Duration of internal audit if enabled.
Definition mdbx.h:4133
size_t obstructed_pgno
Definition mdbx.h:7339
uint16_t tweak
Definition mdbx.h:635
const char * target
Definition mdbx.h:651
uint32_t write
Duration of writing dirty/modified data pages to a filesystem, i.e. the summary duration of a write()...
Definition mdbx.h:4136
uint64_t txn_space_retired
Definition mdbx.h:4056
uint32_t ms_depth
Definition mdbx.h:2777
uint64_t mi_dxb_fallocated
Definition mdbx.h:2830
uint64_t mi_last_pgno
Definition mdbx.h:2831
uint32_t work_counter
Number of slow/deep path GC search for the sake of placement user's data.
uint32_t self_xtime_cpu
The CPU time in user mode spent preparing pages taken from the GC for the purposes of maintaining and...
uint32_t ending
Duration of transaction ending (releasing resources).
Definition mdbx.h:4141
unsigned spent_time_16dot16
Definition mdbx.h:7367
uint64_t ms_mod_txnid
Definition mdbx.h:2782
uint32_t work_rsteps
The number of search iterations inside GC when allocating pages for the sake of user's data.
size_t pages_backed
Definition mdbx.h:7247
uint64_t trunk_txnid
Definition mdbx.h:5228
const char * datetime
uint64_t mi_self_latter_reader_txnid
Definition mdbx.h:2834
uint64_t ms_leaf_pages
Definition mdbx.h:2779
uint64_t mi_dxb_fsize
Definition mdbx.h:2829
uint64_t x
Definition mdbx.h:4721
uint32_t mi_autosync_period_seconds16dot16
Definition mdbx.h:2867
uint64_t mi_unsync_volume
Definition mdbx.h:2858
uint32_t mi_sys_pagesize
Definition mdbx.h:2839
size_t pages_left
Definition mdbx.h:7332
struct MDBX_version_info::@246336125106374236367351214106016351032060025144 git
uint32_t work_rtime_monotonic
The time "by the wall clock" spent reading and searching inside the GC for the user's data.
uint32_t work_xtime_cpu
The CPU time in user mode spent for preparing pages taken from the GC for user data,...
const char * compiler
Definition mdbx.h:653
MDBX_constants
Definition mdbx.h:783
mode_t mdbx_mode_t
Definition mdbx.h:187
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...
#define LIBMDBX_API
Definition mdbx.h:606
struct iovec MDBX_val
Generic structure used for passing keys and data in and out of the table. .
Definition mdbx.h:780
LIBMDBX_VERINFO_API const struct MDBX_version_info mdbx_version
libmdbx version information
pthread_t mdbx_tid_t
Definition mdbx.h:186
LIBMDBX_VERINFO_API const struct MDBX_build_info mdbx_build
libmdbx build information
struct MDBX_env MDBX_env
Opaque structure for a database environment.
Definition mdbx.h:713
int mdbx_filehandle_t
Definition mdbx.h:184
LIBMDBX_API const char * mdbx_liberr2str(int errnum)
pid_t mdbx_pid_t
Definition mdbx.h:185
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.
#define LIBMDBX_VERINFO_API
Definition mdbx.h:627
@ MDBX_MAX_PAGESIZE
Definition mdbx.h:794
@ MDBX_MAXDATASIZE
Definition mdbx.h:788
@ MDBX_MAX_DBI
Definition mdbx.h:785
@ MDBX_MIN_PAGESIZE
Definition mdbx.h:791
libmdbx build information
Definition mdbx.h:649
Lightweight transparent cache entry structure used by mdbx_cache_get().
Definition mdbx.h:5227
Pair of error code and cache status as a result of mdbx_cache_get().
Definition mdbx.h:5327
The fours integers markers (aka "canary") associated with the environment.
Definition mdbx.h:4720
Latency of commit stages in 1/65536 of seconds units.
Definition mdbx.h:4126
The numerical metrics of progress and result of database defragmentation.
Definition mdbx.h:7315
Information about the environment.
Definition mdbx.h:2820
Information about Garbage Collection and page usage.
Definition mdbx.h:7245
Statistics for a table in the environment.
Definition mdbx.h:2774
Information about the transaction.
Definition mdbx.h:4028
libmdbx version information,
Definition mdbx.h:631
MDBX_bunch_action_t
Modes for deleting bunches of neighboring items with self-documenting names.
Definition mdbx.h:6284
LIBMDBX_API int mdbx_cursor_del(MDBX_cursor *cursor, MDBX_put_flags_t flags)
Delete current key/data pair.
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:5520
LIBMDBX_API int mdbx_dbi_sequence(MDBX_txn *txn, MDBX_dbi dbi, uint64_t *result, uint64_t increment)
Sequence generation for a table.
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.
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.
LIBMDBX_API int mdbx_canary_put(MDBX_txn *txn, const MDBX_canary *canary)
Set integers markers (aka "canary") associated with the environment.
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
Data changing flags.
Definition mdbx.h:1629
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.
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.
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.
LIBMDBX_API int mdbx_cursor_count(const MDBX_cursor *cursor, size_t *count)
Return count values (aka duplicates) for current key.
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:4780
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:5990
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
Cache entry status returned by mdbx_cache_get().
Definition mdbx.h:5252
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.
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.
void mdbx_cache_init(MDBX_cache_entry_t *entry)
Initializes the cache entry before the first use.
Definition mdbx.h:5241
LIBMDBX_API int mdbx_del(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *key, const MDBX_val *data)
Delete items from a table.
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.
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.
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_bunch_delete(MDBX_cursor *cursor, MDBX_bunch_action_t action, uint64_t *number_of_affected)
Quickly removes bunches of neighboring items.
LIBMDBX_API int mdbx_cursor_put(MDBX_cursor *cursor, const MDBX_val *key, MDBX_val *data, MDBX_put_flags_t flags)
Store by cursor.
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.
LIBMDBX_API int mdbx_drop(MDBX_txn *txn, MDBX_dbi dbi, bool del)
Empty or delete and close a table.
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.
LIBMDBX_API int mdbx_cursor_get(MDBX_cursor *cursor, MDBX_val *key, MDBX_val *data, MDBX_cursor_op op)
Retrieve by cursor.
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
Definition mdbx.h:6293
@ MDBX_DELETE_BEFORE_INCLUDING
Definition mdbx.h:6292
@ MDBX_DELETE_WHOLE
Definition mdbx.h:6295
@ MDBX_DELETE_BEFORE_EXCLUDING
Definition mdbx.h:6291
@ MDBX_DELETE_CURRENT_VALUE
Definition mdbx.h:6285
@ MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_EXCLUDING
Definition mdbx.h:6286
@ MDBX_DELETE_AFTER_EXCLUDING
Definition mdbx.h:6294
@ MDBX_DELETE_CURRENT_MULTIVAL_ALL
Definition mdbx.h:6290
@ MDBX_DELETE_CURRENT_MULTIVAL_BEFORE_INCLUDING
Definition mdbx.h:6287
@ MDBX_DELETE_CURRENT_MULTIVAL_AFTER_INCLUDING
Definition mdbx.h:6288
@ MDBX_DELETE_CURRENT_MULTIVAL_AFTER_EXCLUDING
Definition mdbx.h:6289
@ MDBX_MULTIPLE
Definition mdbx.h:1666
@ MDBX_ALLDUPS
Definition mdbx.h:1649
@ MDBX_CURRENT
Definition mdbx.h:1644
@ MDBX_APPENDDUP
Definition mdbx.h:1662
@ MDBX_NODUPDATA
Definition mdbx.h:1638
@ MDBX_APPEND
Definition mdbx.h:1657
@ MDBX_UPSERT
Definition mdbx.h:1631
@ MDBX_RESERVE
Definition mdbx.h:1653
@ MDBX_NOOVERWRITE
Definition mdbx.h:1634
@ 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:5294
@ 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:5276
@ MDBX_CACHE_HIT
The result of getting a value is correct and was retrieved from the cache entry which is untouched.
Definition mdbx.h:5302
@ 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:5310
@ MDBX_CACHE_ERROR
The error other than MDBX_NOTFOUND has occurred.
Definition mdbx.h:5257
@ MDBX_CACHE_RACE
The result was obtained by bypassing the cache, because the given cache entry being updated by anothe...
Definition mdbx.h:5285
@ MDBX_CACHE_BEHIND
The result was obtained by bypassing the cache, because the transaction is too old to using the cache...
Definition mdbx.h:5265
@ MDBX_CACHE_REFRESHED
The result of getting a value is correct and corresponds to the fresh data readed from the database,...
Definition mdbx.h:5320
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.
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.
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:5842
LIBMDBX_API int mdbx_cursor_unbind(MDBX_cursor *cursor)
Unbind cursor from a transaction.
LIBMDBX_API MDBX_cursor * mdbx_cursor_create(void *context)
Create a cursor handle but not bind it to transaction nor DBI-handle.
LIBMDBX_API MDBX_dbi mdbx_cursor_dbi(const MDBX_cursor *cursor)
Return the cursor's table handle.
MDBX_cursor_op
Cursor operationsThis is the set of all operations for retrieving data using a cursor.
Definition mdbx.h:1710
LIBMDBX_API int mdbx_cursor_compare(const MDBX_cursor *left, const MDBX_cursor *right, bool ignore_multival)
Compares the position of the cursors.
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.
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.
LIBMDBX_API int mdbx_cursor_bind(MDBX_txn *txn, MDBX_cursor *cursor, MDBX_dbi dbi)
Bind cursor to specified transaction and DBI-handle.
LIBMDBX_API int mdbx_cursor_reset(MDBX_cursor *cursor)
Resets the cursor state.
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.
struct MDBX_cursor MDBX_cursor
Opaque structure for navigating through a table.
Definition mdbx.h:743
LIBMDBX_API int mdbx_cursor_set_userctx(MDBX_cursor *cursor, void *ctx)
Set application information associated with the cursor.
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...
LIBMDBX_API int mdbx_cursor_close2(MDBX_cursor *cursor)
Closes a cursor handle with returning error code.
LIBMDBX_API void * mdbx_cursor_get_userctx(const MDBX_cursor *cursor)
Get the application information associated with the MDBX_cursor.
LIBMDBX_API int mdbx_cursor_renew(MDBX_txn *txn, MDBX_cursor *cursor)
Renew a cursor handle for use within the given transaction.
LIBMDBX_API void mdbx_cursor_close(MDBX_cursor *cursor)
Closes a cursor handle without returning error code.
LIBMDBX_API MDBX_txn * mdbx_cursor_txn(const MDBX_cursor *cursor)
Return the cursor's transaction handle.
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.
LIBMDBX_API int mdbx_cursor_copy(const MDBX_cursor *src, MDBX_cursor *dest)
Copy cursor position and state.
@ MDBX_SET_LOWERBOUND
Definition mdbx.h:1787
@ MDBX_SEEK_AND_GET_MULTIPLE
Definition mdbx.h:1829
@ MDBX_GET_CURRENT
Definition mdbx.h:1725
@ MDBX_GET_BOTH
Definition mdbx.h:1718
@ MDBX_TO_KEY_EQUAL
Definition mdbx.h:1806
@ MDBX_GET_BOTH_RANGE
Definition mdbx.h:1722
@ MDBX_SET_KEY
Definition mdbx.h:1765
@ MDBX_FIRST_DUP
Definition mdbx.h:1715
@ MDBX_TO_KEY_LESSER_OR_EQUAL
Definition mdbx.h:1805
@ MDBX_GET_MULTIPLE
Definition mdbx.h:1730
@ MDBX_TO_EXACT_KEY_VALUE_GREATER_THAN
Definition mdbx.h:1816
@ MDBX_NEXT_NODUP
Definition mdbx.h:1750
@ MDBX_TO_EXACT_KEY_VALUE_LESSER_OR_EQUAL
Definition mdbx.h:1813
@ MDBX_TO_EXACT_KEY_VALUE_EQUAL
Definition mdbx.h:1814
@ MDBX_TO_PAIR_LESSER_OR_EQUAL
Definition mdbx.h:1821
@ MDBX_PREV_MULTIPLE
Definition mdbx.h:1773
@ MDBX_SET_RANGE
Definition mdbx.h:1768
@ MDBX_LAST_DUP
Definition mdbx.h:1736
@ MDBX_PREV
Definition mdbx.h:1753
@ MDBX_TO_PAIR_GREATER_OR_EQUAL
Definition mdbx.h:1823
@ MDBX_TO_PAIR_GREATER_THAN
Definition mdbx.h:1824
@ MDBX_LAST
Definition mdbx.h:1733
@ MDBX_TO_KEY_LESSER_THAN
Definition mdbx.h:1804
@ MDBX_PREV_DUP
Definition mdbx.h:1756
@ MDBX_TO_EXACT_KEY_VALUE_LESSER_THAN
Definition mdbx.h:1812
@ MDBX_SET
Definition mdbx.h:1762
@ MDBX_NEXT
Definition mdbx.h:1739
@ MDBX_TO_KEY_GREATER_OR_EQUAL
Definition mdbx.h:1807
@ MDBX_TO_PAIR_LESSER_THAN
Definition mdbx.h:1820
@ MDBX_NEXT_MULTIPLE
Definition mdbx.h:1747
@ MDBX_PREV_NODUP
Definition mdbx.h:1759
@ MDBX_TO_PAIR_EQUAL
Definition mdbx.h:1822
@ MDBX_NEXT_DUP
Definition mdbx.h:1742
@ MDBX_TO_EXACT_KEY_VALUE_GREATER_OR_EQUAL
Definition mdbx.h:1815
@ MDBX_SET_UPPERBOUND
Definition mdbx.h:1801
@ MDBX_TO_KEY_GREATER_THAN
Definition mdbx.h:1808
@ MDBX_FIRST
Definition mdbx.h:1712
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.
LIBMDBX_API int mdbx_dbi_rename(MDBX_txn *txn, MDBX_dbi dbi, const char *name)
Renames the table using the DBI descriptor.
LIBMDBX_API int mdbx_dbi_rename2(MDBX_txn *txn, MDBX_dbi dbi, const MDBX_val *name)
Renames the table using the DBI descriptor.
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.
LIBMDBX_API int mdbx_dbi_close(MDBX_env *env, MDBX_dbi dbi)
Close a table handle. Normally unnecessary.
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.
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.
uint32_t MDBX_dbi
A handle for an individual table (key-value spaces) in the environment.
Definition mdbx.h:736
MDBX_db_flags_t
Table flags.
Definition mdbx.h:1579
@ MDBX_INTEGERDUP
Definition mdbx.h:1603
@ MDBX_DB_ACCEDE
Definition mdbx.h:1621
@ MDBX_DB_DEFAULTS
Definition mdbx.h:1581
@ MDBX_REVERSEKEY
Definition mdbx.h:1584
@ MDBX_DUPFIXED
Definition mdbx.h:1598
@ MDBX_INTEGERKEY
Definition mdbx.h:1594
@ MDBX_REVERSEDUP
Definition mdbx.h:1606
@ MDBX_CREATE
Definition mdbx.h:1609
@ MDBX_DUPSORT
Definition mdbx.h:1587
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.
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_NORETURN LIBMDBX_API void mdbx_panic(const char *fmt,...) MDBX_PRINTF_ARGS(1
Panics with message and causes abnormal process termination.
LIBMDBX_API int mdbx_env_set_assert(MDBX_env *env, MDBX_assert_func func)
Set or reset the assert() callback of the environment.
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)
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_log_level_t
Definition mdbx.h:856
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
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_debug_flags_t
Runtime debug flags.
Definition mdbx.h:915
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_LOG_EXTRA
Definition mdbx.h:898
@ MDBX_LOG_WARN
Definition mdbx.h:872
@ MDBX_LOG_TRACE
Definition mdbx.h:893
@ MDBX_LOG_DEBUG
Definition mdbx.h:888
@ MDBX_LOG_FATAL
Definition mdbx.h:860
@ MDBX_LOG_ERROR
Definition mdbx.h:866
@ MDBX_LOG_NOTICE
Definition mdbx.h:878
@ MDBX_LOG_DONTCHANGE
Definition mdbx.h:905
@ MDBX_LOG_VERBOSE
Definition mdbx.h:883
@ MDBX_DBG_ASSERT
Definition mdbx.h:921
@ MDBX_DBG_DONT_UPGRADE
Definition mdbx.h:943
@ MDBX_DBG_LEGACY_OVERLAP
Definition mdbx.h:939
@ MDBX_DBG_LEGACY_MULTIOPEN
Definition mdbx.h:936
@ MDBX_DBG_NONE
Definition mdbx.h:916
@ MDBX_DBG_DUMP
Definition mdbx.h:933
@ MDBX_DBG_DONTCHANGE
Definition mdbx.h:950
@ MDBX_DBG_AUDIT
Definition mdbx.h:925
@ MDBX_DBG_JITTER
Definition mdbx.h:929
LIBMDBX_API const char * mdbx_strerror(int errnum)
Return a string describing a given error code.
LIBMDBX_API const char * mdbx_strerror_ANSI2OEM(int errnum)
MDBX_error_t
Errors and return codes.
Definition mdbx.h:1837
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 ...
LIBMDBX_API const char * mdbx_strerror_r(int errnum, char *buf, size_t buflen)
Return a string describing a given error code.
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:6811
LIBMDBX_API const char * mdbx_strerror_r_ANSI2OEM(int errnum, char *buf, size_t buflen)
@ MDBX_PANIC
Definition mdbx.h:1864
@ MDBX_FIRST_LMDB_ERRCODE
Definition mdbx.h:1851
@ MDBX_EKEYMISMATCH
Definition mdbx.h:1950
@ MDBX_UNABLE_EXTEND_MAPSIZE
Definition mdbx.h:1898
@ MDBX_EACCESS
Definition mdbx.h:2009
@ MDBX_EIO
Definition mdbx.h:2017
@ MDBX_PAGE_NOTFOUND
Definition mdbx.h:1857
@ MDBX_TXN_FULL
Definition mdbx.h:1882
@ MDBX_DUPLICATED_CLK
Definition mdbx.h:1969
@ MDBX_VERSION_MISMATCH
Definition mdbx.h:1867
@ MDBX_WANNA_RECOVERY
Definition mdbx.h:1947
@ MDBX_TXN_OVERLAPPING
Definition mdbx.h:1961
@ MDBX_EREMOTE
Definition mdbx.h:2023
@ MDBX_TOO_LARGE
Definition mdbx.h:1954
@ MDBX_EBADSIGN
Definition mdbx.h:1943
@ MDBX_CURSOR_FULL
Definition mdbx.h:1886
@ MDBX_ENOFILE
Definition mdbx.h:2020
@ MDBX_BAD_TXN
Definition mdbx.h:1914
@ MDBX_ENODATA
Definition mdbx.h:2004
@ MDBX_LAST_LMDB_ERRCODE
Definition mdbx.h:1928
@ MDBX_CORRUPTED
Definition mdbx.h:1860
@ MDBX_EPERM
Definition mdbx.h:2018
@ MDBX_THREAD_MISMATCH
Definition mdbx.h:1958
@ MDBX_BACKLOG_DEPLETED
Definition mdbx.h:1966
@ MDBX_SUCCESS
Definition mdbx.h:1839
@ MDBX_NOTFOUND
Definition mdbx.h:1854
@ MDBX_LAGGARD_READER
Definition mdbx.h:1984
@ MDBX_RESULT_TRUE
Definition mdbx.h:1845
@ MDBX_INVALID
Definition mdbx.h:1870
@ MDBX_BAD_VALSIZE
Definition mdbx.h:1918
@ MDBX_BUSY
Definition mdbx.h:1932
@ MDBX_OUSTED
Definition mdbx.h:1977
@ MDBX_DBS_FULL
Definition mdbx.h:1876
@ MDBX_EINVAL
Definition mdbx.h:2008
@ MDBX_BAD_RSLOT
Definition mdbx.h:1909
@ MDBX_ENOMEM
Definition mdbx.h:2010
@ MDBX_FIRST_ADDED_ERRCODE
Definition mdbx.h:1935
@ MDBX_RESULT_FALSE
Definition mdbx.h:1842
@ MDBX_EINTR
Definition mdbx.h:2019
@ MDBX_READERS_FULL
Definition mdbx.h:1879
@ MDBX_LAST_ADDED_ERRCODE
Definition mdbx.h:1987
@ MDBX_BAD_DBI
Definition mdbx.h:1922
@ MDBX_KEYEXIST
Definition mdbx.h:1848
@ MDBX_DANGLING_DBI
Definition mdbx.h:1973
@ MDBX_EDEADLK
Definition mdbx.h:2027
@ MDBX_PAGE_FULL
Definition mdbx.h:1889
@ MDBX_MAP_FULL
Definition mdbx.h:1873
@ MDBX_PROBLEM
Definition mdbx.h:1925
@ MDBX_ENOSYS
Definition mdbx.h:2013
@ MDBX_EMULTIVAL
Definition mdbx.h:1938
@ MDBX_EROFS
Definition mdbx.h:2011
@ MDBX_MVCC_RETARDED
Definition mdbx.h:1980
@ MDBX_INCOMPATIBLE
Definition mdbx.h:1906
LIBMDBX_API int mdbx_env_defrag(MDBX_env *env, size_t defrag_atleast, size_t time_atleast_16dot16, size_t defrag_enough, size_t time_limit_16dot16, intptr_t acceptable_backlash, intptr_t preferred_batch, MDBX_defrag_notify_func progress_callback, void *ctx, MDBX_defrag_result_t *result)
Performs database defragmentation.
LIBMDBX_API int mdbx_reader_check(MDBX_env *env, int *dead)
Check for stale entries in the reader lock table.
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.
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
Environment copy flags.
Definition mdbx.h:1673
LIBMDBX_API MDBX_cmp_func mdbx_get_datacmp(MDBX_db_flags_t flags)
Returns default internal data's comparator for given table flags.
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...
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:2976
int(* MDBX_defrag_notify_func)(void *ctx, const MDBX_defrag_result_t *progress) noexcept
A callback function to notify an application about the progress of defragmentation.
Definition mdbx.h:7384
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.
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...
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...
LIBMDBX_API int mdbx_thread_register(const MDBX_env *env)
Registers the current thread as a reader for the environment.
MDBX_chk_stage_t
The verification stages reported via callbacks during a database integrity check.
Definition mdbx.h:6983
LIBMDBX_API int mdbx_txn_unlock(MDBX_env *env)
Releases write-transaction lock. Provided for custom and/or complex locking scenarios.
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:2981
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...
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:7036
MDBX_chk_flags_t
Flags/options for checking the integrity of a database.
Definition mdbx.h:6941
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.
LIBMDBX_API MDBX_cmp_func mdbx_get_keycmp(MDBX_db_flags_t flags)
Returns default internal key's comparator for given table flags.
MDBX_chk_severity_t
Levels of logging/detailing of information supplied via callbacks during a database integrity check.
Definition mdbx.h:6964
LIBMDBX_API int mdbx_txn_lock(MDBX_env *env, bool dont_wait)
Acquires write-transaction lock. Provided for custom and/or complex locking scenarios.
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
Deletion modes for mdbx_env_delete().
Definition mdbx.h:2544
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_defrag_stopping_reasons_t
The returned reasons for stopping database defragmentation.
Definition mdbx.h:7300
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.
LIBMDBX_API int mdbx_cursor_ignord(MDBX_cursor *cursor)
An auxiliary function for use in tools.
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.
LIBMDBX_API int mdbx_thread_unregister(const MDBX_env *env)
Unregisters the current thread as a reader for the environment.
LIBMDBX_API int mdbx_env_sync_ex(MDBX_env *env, bool force, bool nonblock)
Flush the environment data buffers to disk.
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.
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.
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.
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
Definition mdbx.h:1692
@ MDBX_CP_DEFAULTS
Definition mdbx.h:1674
@ MDBX_CP_COMPACT
Definition mdbx.h:1678
@ MDBX_CP_RENEW_TXN
Definition mdbx.h:1697
@ MDBX_CP_THROTTLE_MVCC
Definition mdbx.h:1688
@ MDBX_CP_FORCE_DYNAMIC_SIZE
Definition mdbx.h:1681
@ MDBX_CP_DONT_FLUSH
Definition mdbx.h:1684
@ MDBX_CP_OVERWRITE
Definition mdbx.h:1701
@ MDBX_chk_gc
Definition mdbx.h:6989
@ MDBX_chk_init
Definition mdbx.h:6985
@ MDBX_chk_finalize
Definition mdbx.h:6995
@ MDBX_chk_space
Definition mdbx.h:6990
@ MDBX_chk_lock
Definition mdbx.h:6986
@ MDBX_chk_none
Definition mdbx.h:6984
@ MDBX_chk_maindb
Definition mdbx.h:6991
@ MDBX_chk_unlock
Definition mdbx.h:6994
@ MDBX_chk_meta
Definition mdbx.h:6987
@ MDBX_chk_conclude
Definition mdbx.h:6993
@ MDBX_chk_tree
Definition mdbx.h:6988
@ MDBX_chk_tables
Definition mdbx.h:6992
@ MDBX_CHK_SKIP_BTREE_TRAVERSAL
Definition mdbx.h:6949
@ MDBX_CHK_READWRITE
Definition mdbx.h:6946
@ MDBX_CHK_DEFAULTS
Definition mdbx.h:6943
@ MDBX_CHK_SKIP_KV_TRAVERSAL
Definition mdbx.h:6952
@ MDBX_CHK_IGNORE_ORDER
Definition mdbx.h:6957
@ MDBX_chk_processing
Definition mdbx.h:6973
@ MDBX_chk_result
Definition mdbx.h:6971
@ MDBX_chk_details
Definition mdbx.h:6976
@ MDBX_chk_extra
Definition mdbx.h:6977
@ MDBX_chk_severity_prio_shift
Definition mdbx.h:6965
@ MDBX_chk_severity_kind_mask
Definition mdbx.h:6966
@ MDBX_chk_notice
Definition mdbx.h:6970
@ MDBX_chk_resolution
Definition mdbx.h:6972
@ MDBX_chk_warning
Definition mdbx.h:6969
@ MDBX_chk_fatal
Definition mdbx.h:6967
@ MDBX_chk_info
Definition mdbx.h:6974
@ MDBX_chk_error
Definition mdbx.h:6968
@ MDBX_chk_verbose
Definition mdbx.h:6975
@ MDBX_ENV_WAIT_FOR_UNUSED
Wait until other processes closes the environment before deletion.
Definition mdbx.h:2556
@ MDBX_ENV_JUST_DELETE
Just delete the environment's files and directory if any.
Definition mdbx.h:2551
@ MDBX_ENV_ENSURE_UNUSED
Make sure that the environment is not being used by other processes, or return an error otherwise.
Definition mdbx.h:2554
@ MDBX_defrag_time_limit
Definition mdbx.h:7303
@ MDBX_defrag_enough_theshold
Definition mdbx.h:7302
@ MDBX_defrag_error
Definition mdbx.h:7307
@ MDBX_defrag_laggard_reader
Definition mdbx.h:7304
@ MDBX_defrag_user_break
Definition mdbx.h:7306
@ MDBX_defrag_noobstacles
Definition mdbx.h:7301
@ MDBX_defrag_large_chunk
Definition mdbx.h:7305
LIBMDBX_API int mdbx_env_create(MDBX_env **penv)
Create an MDBX environment instance.
int mdbx_env_close(MDBX_env *env)
The shortcut to calling mdbx_env_close_ex() with the dont_sync=false argument.
Definition mdbx.h:3144
MDBX_env_flags_t
Environment flags.
Definition mdbx.h:1038
LIBMDBX_API int mdbx_env_close_ex(MDBX_env *env, bool dont_sync)
Close the environment and release the memory map.
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.
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.
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
Definition mdbx.h:1232
@ MDBX_ENV_DEFAULTS
Definition mdbx.h:1039
@ MDBX_COALESCE
Definition mdbx.h:1268
@ MDBX_NOMETASYNC
Definition mdbx.h:1367
@ MDBX_LIFORECLAIM
Definition mdbx.h:1292
@ MDBX_SAFE_NOSYNC
Definition mdbx.h:1418
@ MDBX_NOTLS
Definition mdbx.h:1211
@ MDBX_SYNC_DURABLE
Definition mdbx.h:1349
@ MDBX_PAGEPERTURB
Definition mdbx.h:1295
@ MDBX_WRITEMAP
Definition mdbx.h:1158
@ MDBX_NOSTICKYTHREADS
Definition mdbx.h:1208
@ MDBX_EXCLUSIVE
Definition mdbx.h:1112
@ MDBX_NOMEMINIT
Definition mdbx.h:1255
@ MDBX_MAPASYNC
Definition mdbx.h:1425
@ MDBX_ACCEDE
Definition mdbx.h:1127
@ MDBX_NOSUBDIR
Definition mdbx.h:1064
@ MDBX_RDONLY
Definition mdbx.h:1082
@ MDBX_UTTERLY_NOSYNC
Definition mdbx.h:1468
@ MDBX_VALIDATION
Definition mdbx.h:1046
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.
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.
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.
int mdbx_env_set_mapsize(MDBX_env *env, size_t size)
Definition mdbx.h:3566
int mdbx_env_set_maxdbs(MDBX_env *env, MDBX_dbi dbs)
Set the maximum number of named tables for the environment.
Definition mdbx.h:3715
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.
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.
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:3067
MDBX_option_t
MDBX environment extra runtime options.
Definition mdbx.h:2118
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...
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:3006
MDBX_warmup_flags_t
Warming up options.
Definition mdbx.h:3212
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.
LIBMDBX_API int mdbx_env_set_userctx(MDBX_env *env, void *ctx)
Sets application information (a context pointer) associated with the environment.
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:3669
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
Controls the in-process initial allocation size for dirty pages list of a write transaction....
Definition mdbx.h:2223
@ MDBX_opt_subpage_room_threshold
Sets the minimum amount of free space on a leaf page in the absence of which the nested pages are pla...
Definition mdbx.h:2385
@ MDBX_opt_subpage_limit
Specifies the maximum size of nested pages used to accommodate a small number of multi-values associa...
Definition mdbx.h:2378
@ MDBX_opt_txn_dp_limit
Controls the in-process limit of dirty pages for a write transaction.
Definition mdbx.h:2219
@ MDBX_opt_prefer_waf_insteadof_balance
Controls the choice between striving for uniformity of page filling/density, either for reducing the ...
Definition mdbx.h:2364
@ 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:2323
@ MDBX_opt_max_db
Controls the maximum number of named tables for the environment.
Definition mdbx.h:2127
@ MDBX_opt_subpage_reserve_prereq
Sets the minimum amount of free space on the main page, if available, to reserve space in the subpage...
Definition mdbx.h:2399
@ MDBX_opt_sync_bytes
Controls interprocess/shared threshold to force flush the data buffers to disk, if MDBX_SAFE_NOSYNC i...
Definition mdbx.h:2150
@ MDBX_opt_spill_min_denominator
Controls the in-process how minimal part of the dirty pages should be spilled when necessary.
Definition mdbx.h:2255
@ 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:2278
@ MDBX_opt_split_reserve
Sets the space reservation in 1/65536 of page size when splitting page along the edge.
Definition mdbx.h:2427
@ 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:2190
@ 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:2177
@ MDBX_opt_max_readers
Defines the maximum number of threads/reader slots for all processes interacting with the database.
Definition mdbx.h:2144
@ MDBX_opt_subpage_reserve_limit
Sets the limit for reserving space on nested pages.
Definition mdbx.h:2405
@ MDBX_opt_spill_max_denominator
Controls the in-process how maximal part of the dirty pages may be spilled when necessary.
Definition mdbx.h:2239
@ MDBX_opt_sync_period
Controls interprocess/shared relative period since the last unsteady commit to force flush the data b...
Definition mdbx.h:2156
@ MDBX_opt_dp_reserve_limit
Controls the in-process limit of a pre-allocated memory items for dirty pages.
Definition mdbx.h:2204
@ MDBX_opt_writethrough_threshold
Controls the choosing between use write-through disk writes and usual ones with followed flush by the...
Definition mdbx.h:2318
@ MDBX_opt_gc_time_limit
Controls the in-process spending time limit of searching consecutive pages inside GC.
Definition mdbx.h:2342
@ MDBX_opt_merge_threshold
Controls the in-process threshold of semi-empty pages merge.
Definition mdbx.h:2290
@ MDBX_warmup_touchlimit
Definition mdbx.h:3251
@ MDBX_warmup_force
Definition mdbx.h:3221
@ MDBX_warmup_oomsafe
Definition mdbx.h:3228
@ MDBX_warmup_release
Definition mdbx.h:3254
@ MDBX_warmup_lock
Definition mdbx.h:3243
@ MDBX_warmup_default
Definition mdbx.h:3215
LIBMDBX_API int mdbx_env_get_path(const MDBX_env *env, const char **dest)
Return the path that was used in mdbx_env_open().
LIBMDBX_API int mdbx_dbi_stat(const MDBX_txn *txn, MDBX_dbi dbi, MDBX_stat *stat, size_t bytes)
Retrieve statistics for a table.
LIBMDBX_API intptr_t mdbx_limits_keysize_min(MDBX_db_flags_t flags)
Returns minimal key size in bytes for given table flags.
LIBMDBX_API uint64_t mdbx_txn_id(const MDBX_txn *txn)
Return the transaction's ID.
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.
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.
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:3684
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:3087
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.
LIBMDBX_API int mdbx_txn_straggler(const MDBX_txn *txn, int *percent)
Returns a lag of the reading for the given transaction.
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.
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.
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:5070
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.
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.
LIBMDBX_API intptr_t mdbx_limits_valsize_min(MDBX_db_flags_t flags)
Returns minimal data size in bytes for given table flags.
int mdbx_env_info(const MDBX_env *env, MDBX_envinfo *info, size_t bytes)
Return information about the MDBX environment.
Definition mdbx.h:2931
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:7239
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:3024
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...
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...
intptr_t mdbx_limits_pgsize_max(void)
Returns the maximal database page size in bytes.
Definition mdbx.h:3593
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.
LIBMDBX_API int mdbx_txn_info(const MDBX_txn *txn, MDBX_txn_info *info, bool scan_rlt)
Return information about the MDBX transaction.
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
DBI state bits returted by mdbx_dbi_flags_ex()
Definition mdbx.h:5042
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 ...
intptr_t mdbx_limits_pgsize_min(void)
Returns the minimal database page size in bytes.
Definition mdbx.h:3589
LIBMDBX_API int mdbx_env_get_maxkeysize(const MDBX_env *env)
LIBMDBX_API int mdbx_env_get_fd(const MDBX_env *env, mdbx_filehandle_t *fd)
Return the file descriptor for the given environment.
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.
LIBMDBX_API void * mdbx_env_get_userctx(const MDBX_env *env)
Returns an application information (a context pointer) associated with the environment.
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:3729
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().
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.
LIBMDBX_API size_t mdbx_default_pagesize(void)
Returns the default size of database page for the current system.
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:4938
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 ...
int mdbx_env_stat(const MDBX_env *env, MDBX_stat *stat, size_t bytes)
Return statistics about the MDBX environment.
Definition mdbx.h:2813
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,...
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.
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.
LIBMDBX_API int mdbx_env_get_flags(const MDBX_env *env, unsigned *flags)
Get environment flags.
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.
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.
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:6663
@ MDBX_DBI_DIRTY
Definition mdbx.h:5044
@ MDBX_DBI_FRESH
Definition mdbx.h:5048
@ MDBX_DBI_STALE
Definition mdbx.h:5046
@ MDBX_DBI_CREAT
Definition mdbx.h:5050
LIBMDBX_API int mdbx_txn_break(MDBX_txn *txn)
Marks transaction as broken to prevent further operations.
LIBMDBX_API int mdbx_txn_set_userctx(MDBX_txn *txn, void *ctx)
Sets application information associated (a context pointer) with the transaction.
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.
LIBMDBX_API int mdbx_txn_park(MDBX_txn *txn, bool autounpark)
Puts the reading transaction in a "parked" state.
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.
LIBMDBX_API int mdbx_txn_refresh(MDBX_txn *txn)
Refresh a read-only transaction for a recent data.
int mdbx_txn_commit(MDBX_txn *txn)
Commits all the operations of the transaction into the database.
Definition mdbx.h:4485
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.
LIBMDBX_API int mdbx_txn_rollback(MDBX_txn *txn)
Rolls back all uncommitted changes within the write transaction and keeps it running.
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...
LIBMDBX_API MDBX_env * mdbx_txn_env(const MDBX_txn *txn)
Returns the transaction's MDBX_env.
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...
LIBMDBX_API int mdbx_txn_unpark(MDBX_txn *txn, bool restart_if_ousted)
Unparks a previously parked reading transaction.
MDBX_txn_flags_t
Definition mdbx.h:1478
LIBMDBX_API void * mdbx_txn_get_userctx(const MDBX_txn *txn)
Returns an application information (a context pointer) associated with the transaction.
int mdbx_txn_abort(MDBX_txn *txn)
Abandons all the operations of the transaction instead of saving ones.
Definition mdbx.h:4542
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:3945
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.
struct MDBX_txn MDBX_txn
Opaque structure for a transaction handle.
Definition mdbx.h:724
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 ...
LIBMDBX_API int mdbx_txn_reset(MDBX_txn *txn)
Reset a read-only transaction.
LIBMDBX_API int mdbx_txn_renew(MDBX_txn *txn)
Renew a read-only transaction.
LIBMDBX_API MDBX_txn_flags_t mdbx_txn_flags(const MDBX_txn *txn)
Return the transaction's flags.
@ MDBX_TXN_RDONLY
Definition mdbx.h:1489
@ MDBX_TXN_ERROR
Definition mdbx.h:1532
@ MDBX_TXN_NOMETASYNC
Definition mdbx.h:1511
@ MDBX_TXN_SPILLS
Definition mdbx.h:1542
@ MDBX_TXN_OUSTED
Definition mdbx.h:1566
@ MDBX_TXN_NOWEAKING
Definition mdbx.h:1507
@ MDBX_TXN_HAS_CHILD
Definition mdbx.h:1547
@ MDBX_TXN_RDONLY_PREPARE
Definition mdbx.h:1498
@ MDBX_TXN_INVALID
Definition mdbx.h:1522
@ MDBX_TXN_BLOCKED
Definition mdbx.h:1571
@ MDBX_TXN_PARKED
Definition mdbx.h:1552
@ MDBX_TXN_NOSYNC
Definition mdbx.h:1515
@ MDBX_TXN_DIRTY
Definition mdbx.h:1537
@ MDBX_TXN_READWRITE
Definition mdbx.h:1483
@ MDBX_TXN_AUTOUNPARK
Definition mdbx.h:1559
@ MDBX_TXN_TRY
Definition mdbx.h:1504
@ MDBX_TXN_FINISHED
Definition mdbx.h:1527
MDBX_chk_severity_t verbosity
Definition mdbx.h:7024
MDBX_txn * txn
Definition mdbx.h:7101
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:7141
struct MDBX_chk_histogram tree_density
struct MDBX_chk_histogram::@167152105014034103340112155364354016331236072167 ranges[9]
void(* print_size)(MDBX_chk_line_t *, const char *prefix, const uint64_t value, const char *suffix)
Definition mdbx.h:7158
void(* print_done)(MDBX_chk_line_t *)
Definition mdbx.h:7155
struct MDBX_chk_internal * internal
Definition mdbx.h:7099
uint8_t scope_nesting
Definition mdbx.h:7103
char * end
Definition mdbx.h:7004
uint8_t scope_depth
Definition mdbx.h:7003
struct MDBX_chk_histogram key_len
struct MDBX_chk_histogram large_or_nested_density
int(* stage_begin)(MDBX_chk_context_t *ctx, MDBX_chk_stage_t)
Definition mdbx.h:7150
int(* stage_end)(MDBX_chk_context_t *ctx, MDBX_chk_stage_t, int err)
Definition mdbx.h:7151
int(* table_conclude)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table, MDBX_cursor *cursor, int err)
Definition mdbx.h:7144
void(* print_format)(MDBX_chk_line_t *, const char *fmt, va_list args)
Definition mdbx.h:7157
struct MDBX_chk_histogram histogram_pgno_payload
struct MDBX_chk_internal * internal
Definition mdbx.h:7021
char * begin
Definition mdbx.h:7004
size_t le1_count
Definition mdbx.h:7042
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:7137
struct MDBX_chk_histogram histogram_pgno_retained
size_t subtotal_issues
Definition mdbx.h:7025
uint8_t severity
Definition mdbx.h:7003
MDBX_chk_user_table_cookie_t * cookie
Definition mdbx.h:7052
void(* scope_pop)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner)
Definition mdbx.h:7140
struct MDBX_chk_histogram pgno
struct MDBX_chk_context * ctx
Definition mdbx.h:7002
MDBX_db_flags_t flags
Definition mdbx.h:7062
int(* scope_conclude)(MDBX_chk_context_t *ctx, MDBX_chk_scope_t *outer, MDBX_chk_scope_t *inner, int err)
Definition mdbx.h:7139
size_t le1_amount
Definition mdbx.h:7042
void(* print_flush)(MDBX_chk_line_t *)
Definition mdbx.h:7154
struct MDBX_chk_issue * next
Definition mdbx.h:7011
struct MDBX_chk_histogram large_pages
char * out
Definition mdbx.h:7004
struct MDBX_chk_histogram val_len
void(* print_chars)(MDBX_chk_line_t *, const char *str, size_t len)
Definition mdbx.h:7156
const MDBX_chk_table_t *const * tables
const void * object
Definition mdbx.h:7022
size_t count
Definition mdbx.h:7042
const char * caption
Definition mdbx.h:7013
MDBX_chk_stage_t stage
Definition mdbx.h:7023
struct MDBX_chk_histogram histogram_page_age
struct MDBX_chk_histogram height
struct MDBX_chk_histogram multival
struct MDBX_chk_histogram nested_height_or_gc_span_length
MDBX_env * env
Definition mdbx.h:7100
uint8_t empty
Definition mdbx.h:7003
size_t amount
Definition mdbx.h:7042
MDBX_chk_scope_t * scope
Definition mdbx.h:7102
MDBX_chk_issue_t * issues
Definition mdbx.h:7020
size_t payload_bytes
Definition mdbx.h:7065
size_t count
Definition mdbx.h:7012
MDBX_val name
Definition mdbx.h:7061
size_t lost_bytes
Definition mdbx.h:7065
bool(* check_break)(MDBX_chk_context_t *ctx)
Definition mdbx.h:7136
void(* table_dispose)(MDBX_chk_context_t *ctx, const MDBX_chk_table_t *table)
Definition mdbx.h:7145
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:7147
int id
Definition mdbx.h:7063
struct MDBX_chk_histogram page_age
LIBMDBX_API int mdbx_env_turn_for_recovery(MDBX_env *env, unsigned target_meta)
Turn database to the specified meta-page.
A set of callback functions used for checking the integrity of a database.
Definition mdbx.h:7135
The context for checking the integrity of a database.
Definition mdbx.h:7098
A histogram with some statistical information collected during a database integrity check.
Definition mdbx.h:7041
An issue problem was discovered during a database integrity check.
Definition mdbx.h:7010
A virtual row of the report generated during a database integrity check.
Definition mdbx.h:7001
A hierarchical context during a database integrity check.
Definition mdbx.h:7019
Information about a certain key-value table during a database integrity check.
Definition mdbx.h:7051
LIBMDBX_API float mdbx_float_from_key(const MDBX_val)
LIBMDBX_API int32_t mdbx_int32_from_key(const MDBX_val)
LIBMDBX_API int64_t mdbx_int64_from_key(const MDBX_val)
LIBMDBX_API double mdbx_double_from_key(const MDBX_val)
LIBMDBX_API int64_t mdbx_jsonInteger_from_key(const MDBX_val)
uint64_t mdbx_key_from_int64(const int64_t i64)
Definition mdbx.h:4981
LIBMDBX_API uint32_t mdbx_key_from_ptrfloat(const float *const ieee754_32bit)
LIBMDBX_API uint64_t mdbx_key_from_double(const double ieee754_64bit)
LIBMDBX_API uint32_t mdbx_key_from_float(const float ieee754_32bit)
LIBMDBX_API uint64_t mdbx_key_from_ptrdouble(const double *const ieee754_64bit)
uint32_t mdbx_key_from_int32(const int32_t i32)
Definition mdbx.h:4985
LIBMDBX_API uint64_t mdbx_key_from_jsonInteger(const int64_t json_integer)