TDB_FileX/TDB_FileX.xs

#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"

#if __linux__
#include <sys/ioctl.h>
#include <linux/fs.h>
#endif

#include <sys/types.h>
#include <tdb.h>

#define XXH_STATIC_LINKING_ONLY
#define XXH_IMPLEMENTATION
#define XXH_INLINE_ALL
#include "xxHash/xxhash.h"

static void
set_nocow (const char *path, int flags, int mode)
{
  #if __linux__ && FS_NOCOW_FL && O_CLOEXEC
    int fd = open (path, flags, mode | O_CLOEXEC);

    if (fd >= 0)
      {
        int flags;
        if (!ioctl (fd, FS_IOC_GETFLAGS, &flags))
          {
            flags |= FS_NOCOW_FL;
            ioctl (fd, FS_IOC_SETFLAGS, &flags);
          }
    
        close (fd);
      }
  #endif
}

static void
log_func_cb (TDB_CONTEXT *tdb, enum tdb_debug_level level, const char *fmt, ...)
{
  va_list ap;
  bool xfalse = FALSE;
  SV *cb = (SV *)tdb_get_logging_private (tdb);
  
  if (!cb)
    return;

  dSP;
  dXSTARG;

  ENTER;
  SAVETMPS;

  va_start (ap, fmt);

  SV *sv = sv_newmortal ();
  sv_vsetpvfn (sv, fmt, strlen (fmt), &ap, NULL, 0, &xfalse);

  va_end (ap);

  PUSHMARK (SP);
  XPUSHi (level);
  XPUSHs (sv);

  PUTBACK;
  call_sv (cb, G_VOID | G_DISCARD);

  FREETMPS;
  LEAVE;
}

static int
traverse_cb (TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA data, void *private_data)
{
  dSP;

  ENTER;
  SAVETMPS;

  PUSHMARK (SP);
  XPUSHs (sv_2mortal (newSVpv (key .dptr, key .dsize)));
  XPUSHs (sv_2mortal (newSVpv (data.dptr, data.dsize)));
  PUTBACK;

  int count = call_sv ((SV *)private_data, G_SCALAR);

  SPAGAIN;

  if (count != 1)
    croak ("tdb_traverse callback returned %d args\n", count);

  SV *retval = POPs;
  int ret = !SvTRUE (retval);

  PUTBACK;
  FREETMPS;
  LEAVE;

  return ret;
}

static int
check_cb (TDB_DATA key, TDB_DATA data, void *private_data)
{
  dSP;

  ENTER;
  SAVETMPS;

  PUSHMARK (SP);
  XPUSHs (sv_2mortal (newSVpv (key .dptr, key .dsize)));
  XPUSHs (sv_2mortal (newSVpv (data.dptr, data.dsize)));

  PUTBACK;
  int count = call_sv ((SV *)private_data, G_SCALAR);
  SPAGAIN;

  if (count != 1)
    croak ("tdb_check callback returned %d args\n", count);

  SV *retval = POPs;
  int ret = SvTRUE (retval) ? 0 : -1;

  PUTBACK;
  FREETMPS;
  LEAVE;

  return ret;
}

static void
rescue_cb (TDB_DATA key, TDB_DATA data, void *private_data)
{
  dSP;

  ENTER;
  SAVETMPS;

  PUSHMARK (SP);
  XPUSHs (sv_2mortal (newSVpv (key .dptr, key .dsize)));
  XPUSHs (sv_2mortal (newSVpv (data.dptr, data.dsize)));

  PUTBACK;
  call_sv ((SV *)private_data, G_VOID | G_DISCARD);

  FREETMPS;
  LEAVE;
}

// https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
// https://github.com/skeeto/hash-prospector/issues/19
static unsigned int
fnv1ax_hash (TDB_DATA *key)
{
  unsigned int x = sizeof (unsigned int) < 8 ? 0x811c9dc5U : 0xcbf29ce484222325U;

  for (size_t i = 0; i < key->dsize; ++i)
    x = (x ^ key->dptr[i]) * (sizeof (unsigned int) < 8 ? 0x01000193U : 0x00000100000001b3U);

  x ^= x >> 16; x *= 0x21f0aaadU;
  x ^= x >> 15; x *= 0x735a2d97U;
  x ^= x >> 15;

  return x;
}

static unsigned int
xxh3_hash (TDB_DATA *key)
{
  return XXH3_64bits (key->dptr, key->dsize);
}

static unsigned int
custom_hash (TDB_DATA *key, SV *cb)
{
  dSP;

  ENTER;
  SAVETMPS;

  PUSHMARK (SP);
  XPUSHs (sv_2mortal (newSVpv (key->dptr, key->dsize)));

  PUTBACK;
  int count = call_sv (cb, G_SCALAR);
  SPAGAIN;

  if (count != 1)
    croak ("hash callback returned %d vaslues, expecte4d exactly 1", count);

  unsigned int hash = POPu;

  PUTBACK;
  FREETMPS;
  LEAVE;

  return hash;
}

static void
croak_on_error_slowpath (TDB_CONTEXT *tdb)
{
  errno = tdb_error (tdb);
  croak_sv (sv_2mortal (newSVpv (tdb_errorstr (tdb), 0)));
}

#define croak_on_error(res) do { if ((res) < 0) croak_on_error_slowpath (tdb); } while (0)

static SV *custom_hash_cb[4];

static unsigned int custom_hash_1 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[0]); }
static unsigned int custom_hash_2 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[1]); }
static unsigned int custom_hash_3 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[2]); }
static unsigned int custom_hash_4 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[3]); }

typedef int mone_on_fail;

MODULE = TDB_FileX              PACKAGE = TDB_FileX             PREFIX = tdb_

PROTOTYPES: DISABLE

BOOT:
{
        HV *stash = gv_stashpv ("TDB_FileX", 1);

        static const struct {
          const char *name;
          IV iv;
        } *civ, const_iv[] = {
#         define const_iv(name) { # name, (IV) TDB_ ## name },
          const_iv (ALLOW_NESTING)
          const_iv (BIGENDIAN)
          const_iv (CLEAR_IF_FIRST)
          const_iv (CONVERT)
          const_iv (DEFAULT)
          const_iv (DISALLOW_NESTING)
          const_iv (INCOMPATIBLE_HASH)
          const_iv (INSERT)
          const_iv (INTERNAL)
          const_iv (MODIFY)
          const_iv (MUTEX_LOCKING)
          const_iv (NOLOCK)
          const_iv (NOMMAP)
          const_iv (NOSYNC)
          const_iv (REPLACE)
          const_iv (SEQNUM)
          const_iv (VOLATILE)

          const_iv (ERR_CORRUPT)
          const_iv (ERR_IO)
          const_iv (ERR_LOCK)
          const_iv (ERR_OOM)
          const_iv (ERR_EXISTS)
          const_iv (ERR_NOLOCK)
          const_iv (ERR_LOCK_TIMEOUT)
          const_iv (ERR_NOEXIST)
          const_iv (ERR_EINVAL)
          const_iv (ERR_RDONLY)
          const_iv (SUCCESS)

          const_iv (DEBUG_FATAL)
          const_iv (DEBUG_ERROR)
          const_iv (DEBUG_WARNING)
          const_iv (DEBUG_TRACE)
        };
        
        for (civ = const_iv + sizeof (const_iv) / sizeof (const_iv [0]); civ > const_iv; civ--)
          newCONSTSUB (stash, (char *)civ[-1].name, newSViv (civ[-1].iv));
        
        tdb_runtime_check_for_robust_mutexes ();
}

SV *
set_hash_function (int idx, SV *cb = 0)
        PROTOTYPE: $;$
        CODE:
{
        if (idx < 1 || idx > 4)
          croak ("hash function index must be between 1 and 4");

        SV **cbp = &custom_hash_cb[idx - 1];

        RETVAL = *cbp ? newSVsv (*cbp) : &PL_sv_undef;

        if (cb)
          {
            SvREFCNT_dec (*cbp);
            *cbp = SvOK (cb) ? newSVsv (cb) : 0;
          }
}
        OUTPUT: RETVAL

void
DESTROY (TDB_CONTEXT *tdb)
        CODE:
        if (tdb)
          {
            SvREFCNT_dec ((SV *)tdb_get_logging_private (tdb));
            tdb_close (tdb);
          }

NO_OUTPUT int
tdb_delete (TDB_CONTEXT *tdb, TDB_DATA key)
        ALIAS:
           DELETE = 0
        POSTCALL:
        croak_on_error (RETVAL);

NO_OUTPUT int
tdb_wipe_all (TDB_CONTEXT *tdb)
        ALIAS:
           CLEAR = 0
        CODE:
        tdb_wipe_all (tdb);
        POSTCALL:
        croak_on_error (RETVAL);

void
tdb_dump_all (TDB_CONTEXT *tdb)

enum TDB_ERROR
tdb_error (TDB_CONTEXT *tdb)

const char *
tdb_errorstr (TDB_CONTEXT *tdb)

SV *
tdb_exists (TDB_CONTEXT *tdb, TDB_DATA key)
        ALIAS:
           EXISTS = 0
        CODE:
        RETVAL = tdb_exists (tdb, key) ? &PL_sv_yes : &PL_sv_no;
        OUTPUT: RETVAL

TDB_DATA
tdb_fetch (TDB_CONTEXT *tdb, TDB_DATA key)
        ALIAS:
           FETCH  = 0

NO_OUTPUT int
tdb_store (TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag = TDB_REPLACE)
        ALIAS:
           STORE = 0
        POSTCALL:
        croak_on_error (RETVAL);

NO_OUTPUT int
tdb_append (TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf)
        POSTCALL:
        croak_on_error (RETVAL);

TDB_DATA
tdb_firstkey (TDB_CONTEXT *tdb)
        ALIAS:
           FIRSTKEY = 0

NO_OUTPUT int
tdb_context_only_and_mone_on_fail (TDB_CONTEXT *tdb)
        INTERFACE:
        tdb_lockall
        tdb_lockall_nonblock
        tdb_unlockall
        tdb_lockall_read
        tdb_lockall_read_nonblock
        tdb_unlockall_read
        tdb_lockall_mark
        tdb_lockall_unmark
        tdb_transaction_start
        tdb_transaction_start_nonblock
        tdb_transaction_cancel
        tdb_transaction_commit
        tdb_transaction_prepare_commit
        tdb_repack
        POSTCALL:
        croak_on_error (RETVAL);

bool         tdb_transaction_active               (TDB_CONTEXT *tdb)

void         tdb_enable_seqnum                    (TDB_CONTEXT *tdb)

int          tdb_get_seqnum                       (TDB_CONTEXT *tdb)

void         tdb_increment_seqnum_nonblock        (TDB_CONTEXT *tdb)

int          tdb_hash_size                        (TDB_CONTEXT *tdb)

size_t       tdb_map_size                         (TDB_CONTEXT *tdb)

int          tdb_get_flags                        (TDB_CONTEXT *tdb)

void         tdb_add_flags                        (TDB_CONTEXT *tdb, unsigned int flag)

void         tdb_remove_flags                     (TDB_CONTEXT *tdb, unsigned int flag)

bool         tdb_runtime_check_for_robust_mutexes ()

void
tdb_set_logging_function (TDB_CONTEXT *tdb, SV *cb)
        CODE:
        struct tdb_logging_context ctx;
        ctx.log_fn = log_func_cb;
        ctx.log_private = (SV *)newSVsv (cb);
        SvREFCNT_dec ((SV *)tdb_get_logging_private (tdb));
        tdb_set_logging_function (tdb, &ctx);

TDB_DATA
tdb_nextkey (TDB_CONTEXT *tdb, TDB_DATA key)
        ALIAS:
           NEXTKEY = 0

TDB_CONTEXT *
tdb_open (char *class, char *path, ...)
        ALIAS:
           TIEHASH = 0
        CODE:
        tdb_hash_func hash_func = 0;
        struct tdb_logging_context ctx = { 0 };
        int tdb_flags = TDB_DEFAULT;
        int open_flags = O_RDWR | O_CREAT;
        mode_t mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
        int hash_size = 0;
        int nocow = 0;

        for (int i = 2; i < items - 1; i += 2)
          {
            const char *k = SvPVbyte_nolen (ST (i));
            SV         *v = ST (i + 1);

            if      (strEQ (k, "tdb_flags" )) tdb_flags  = SvIV (v);
            else if (strEQ (k, "open_flags")) open_flags = SvIV (v);
            else if (strEQ (k, "mode"      )) mode       = SvUV (v);
            else if (strEQ (k, "hash_size" )) hash_size  = SvIV (v);
            else if (strEQ (k, "log_cb"))
              {
                SvREFCNT_dec (ctx.log_private);
                ctx.log_fn = 0;
                ctx.log_private = 0;

                if (SvOK (v))
                  {
                    ctx.log_fn = log_func_cb;
                    ctx.log_private = (void *)newSVsv (v);
                  }
              }
            else if (strEQ (k, "hash"))
              {
                const char *f = SvPVbyte_nolen (v);

                if      (!SvOK (v)           ) hash_func = 0;
                else if (strEQ (f, "default")) hash_func = 0;
                else if (strEQ (f, "jenkins")) hash_func = tdb_jenkins_hash;
                else if (strEQ (f, "fnv1ax" )) hash_func = fnv1ax_hash;
                else if (strEQ (f, "xxh3"   )) hash_func = xxh3_hash;
                else if (strEQ (f, "1"      )) hash_func = custom_hash_1;
                else if (strEQ (f, "2"      )) hash_func = custom_hash_2;
                else if (strEQ (f, "3"      )) hash_func = custom_hash_3;
                else if (strEQ (f, "4"      )) hash_func = custom_hash_4;
                else
                  croak ("%s: not a known hash function", f);
              }
            else if (strEQ (k, "mutex"))
              {
                if (SvTRUE (v))
                  {
                    if (tdb_runtime_check_for_robust_mutexes ())
                      tdb_flags |= TDB_MUTEX_LOCKING;
                  }
                else
                  tdb_flags &= ~TDB_MUTEX_LOCKING;
              }
            else if (strEQ (k, "nocow"))
              nocow = SvTRUE (v);
            else
              croak ("%s: not a known parameter name", k);
          }

        if (nocow && (open_flags & O_CREAT))
          set_nocow (path, open_flags, mode);

        RETVAL = tdb_open_ex (path, hash_size, tdb_flags, open_flags, mode, ctx.log_fn ? &ctx : 0, hash_func);

        if (!RETVAL)
          {
            SvREFCNT_dec ((SV *)ctx.log_private);
            XSRETURN_UNDEF;
          }
        OUTPUT: RETVAL

void
tdb_printfreelist (TDB_CONTEXT *tdb)

void
tdb_reopen (TDB_CONTEXT *tdb)
        PROTOTYPE:
        CODE:
        void *logcb = tdb_get_logging_private (tdb);

        int res = tdb_reopen (tdb);

        if (res < 0)
          {
            /* tdb_reopen frees the TDB_CONTEXT on failure,
             * so set scalar value to 0 to avoid double free on DESTROY */
            sv_setiv ((SV*)SvRV (ST (0)), 0);
            SvREFCNT_dec ((SV *)logcb);
            croak ("tdb_reopen failed");
          }

# FIXME: if this fails, we need to undef $tdb or something
# .. which we can't do - cos we don't know where it failed :(
# maybe reimplement this ourselves?
NO_OUTPUT int
tdb_reopen_all (int parent_longlived = 0)
        POSTCALL:
        if (RETVAL < 0)
          croak ("tdb_reopen_all failed");

int
tdb_fd (TDB_CONTEXT *tdb)

const char *
tdb_name (TDB_CONTEXT *tdb)

int
tdb_traverse (TDB_CONTEXT *tdb, SV *fn = &PL_sv_undef)
        ALIAS:
           tdb_traverse_read = 1
        CODE:
        RETVAL = (ix ? tdb_traverse_read : tdb_traverse) (tdb, SvOK (fn) ? traverse_cb: 0, fn);
        croak_on_error (RETVAL);
        OUTPUT: RETVAL

mone_on_fail
tdb_check (TDB_CONTEXT *tdb, SV *fn = &PL_sv_undef)
        CODE:
        RETVAL = tdb_check (tdb, SvOK (fn) ? check_cb : 0, fn);
        OUTPUT: RETVAL

mone_on_fail
tdb_rescue (TDB_CONTEXT *tdb, SV *fn)
        CODE:
        RETVAL = tdb_rescue (tdb, rescue_cb, fn);
        OUTPUT: RETVAL

Revision:	1.4
Committed:	Fri May 2 19:39:41 2025 UTC (16 months, 1 week ago) by root
Branch:	MAIN
Changes since 1.3:	+31 -0 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	root	1.1	#include "EXTERN.h"
2			#include "perl.h"
3			#include "XSUB.h"
4
5	root	1.4	#if __linux__
6			#include <sys/ioctl.h>
7			#include <linux/fs.h>
8			#endif
9
10	root	1.1	#include <sys/types.h>
11			#include <tdb.h>
12
13			#define XXH_STATIC_LINKING_ONLY
14			#define XXH_IMPLEMENTATION
15			#define XXH_INLINE_ALL
16			#include "xxHash/xxhash.h"
17
18			static void
19	root	1.4	set_nocow (const char *path, int flags, int mode)
20			{
21			#if __linux__ && FS_NOCOW_FL && O_CLOEXEC
22			int fd = open (path, flags, mode \| O_CLOEXEC);
23
24			if (fd >= 0)
25			{
26			int flags;
27			if (!ioctl (fd, FS_IOC_GETFLAGS, &flags))
28			{
29			flags \|= FS_NOCOW_FL;
30			ioctl (fd, FS_IOC_SETFLAGS, &flags);
31			}
32
33			close (fd);
34			}
35			#endif
36			}
37
38			static void
39	root	1.1	log_func_cb (TDB_CONTEXT tdb, enum tdb_debug_level level, const char fmt, ...)
40			{
41			va_list ap;
42			bool xfalse = FALSE;
43			SV cb = (SV )tdb_get_logging_private (tdb);
44
45			if (!cb)
46			return;
47
48			dSP;
49			dXSTARG;
50
51			ENTER;
52			SAVETMPS;
53
54			va_start (ap, fmt);
55
56			SV *sv = sv_newmortal ();
57			sv_vsetpvfn (sv, fmt, strlen (fmt), &ap, NULL, 0, &xfalse);
58
59			va_end (ap);
60
61			PUSHMARK (SP);
62			XPUSHi (level);
63			XPUSHs (sv);
64	root	1.3
65	root	1.1	PUTBACK;
66			call_sv (cb, G_VOID \| G_DISCARD);
67
68			FREETMPS;
69			LEAVE;
70			}
71
72			static int
73	root	1.3	traverse_cb (TDB_CONTEXT tdb, TDB_DATA key, TDB_DATA data, void private_data)
74	root	1.1	{
75			dSP;
76
77			ENTER;
78			SAVETMPS;
79
80			PUSHMARK (SP);
81			XPUSHs (sv_2mortal (newSVpv (key .dptr, key .dsize)));
82			XPUSHs (sv_2mortal (newSVpv (data.dptr, data.dsize)));
83			PUTBACK;
84
85	root	1.3	int count = call_sv ((SV *)private_data, G_SCALAR);
86	root	1.1
87			SPAGAIN;
88
89			if (count != 1)
90			croak ("tdb_traverse callback returned %d args\n", count);
91
92			SV *retval = POPs;
93			int ret = !SvTRUE (retval);
94
95			PUTBACK;
96			FREETMPS;
97			LEAVE;
98
99			return ret;
100			}
101
102	root	1.3	static int
103			check_cb (TDB_DATA key, TDB_DATA data, void *private_data)
104			{
105			dSP;
106
107			ENTER;
108			SAVETMPS;
109
110			PUSHMARK (SP);
111			XPUSHs (sv_2mortal (newSVpv (key .dptr, key .dsize)));
112			XPUSHs (sv_2mortal (newSVpv (data.dptr, data.dsize)));
113
114			PUTBACK;
115			int count = call_sv ((SV *)private_data, G_SCALAR);
116			SPAGAIN;
117
118			if (count != 1)
119			croak ("tdb_check callback returned %d args\n", count);
120
121			SV *retval = POPs;
122			int ret = SvTRUE (retval) ? 0 : -1;
123
124			PUTBACK;
125			FREETMPS;
126			LEAVE;
127
128			return ret;
129			}
130
131			static void
132			rescue_cb (TDB_DATA key, TDB_DATA data, void *private_data)
133			{
134			dSP;
135
136			ENTER;
137			SAVETMPS;
138
139			PUSHMARK (SP);
140			XPUSHs (sv_2mortal (newSVpv (key .dptr, key .dsize)));
141			XPUSHs (sv_2mortal (newSVpv (data.dptr, data.dsize)));
142
143			PUTBACK;
144			call_sv ((SV *)private_data, G_VOID \| G_DISCARD);
145
146			FREETMPS;
147			LEAVE;
148			}
149
150	root	1.1	// https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function
151			// https://github.com/skeeto/hash-prospector/issues/19
152			static unsigned int
153			fnv1ax_hash (TDB_DATA *key)
154			{
155			unsigned int x = sizeof (unsigned int) < 8 ? 0x811c9dc5U : 0xcbf29ce484222325U;
156
157			for (size_t i = 0; i < key->dsize; ++i)
158			x = (x ^ key->dptr[i]) * (sizeof (unsigned int) < 8 ? 0x01000193U : 0x00000100000001b3U);
159
160			x ^= x >> 16; x *= 0x21f0aaadU;
161			x ^= x >> 15; x *= 0x735a2d97U;
162			x ^= x >> 15;
163
164			return x;
165			}
166
167			static unsigned int
168			xxh3_hash (TDB_DATA *key)
169			{
170			return XXH3_64bits (key->dptr, key->dsize);
171			}
172
173			static unsigned int
174			custom_hash (TDB_DATA key, SV cb)
175			{
176			dSP;
177
178			ENTER;
179			SAVETMPS;
180
181			PUSHMARK (SP);
182			XPUSHs (sv_2mortal (newSVpv (key->dptr, key->dsize)));
183	root	1.3
184	root	1.1	PUTBACK;
185			int count = call_sv (cb, G_SCALAR);
186			SPAGAIN;
187
188			if (count != 1)
189			croak ("hash callback returned %d vaslues, expecte4d exactly 1", count);
190
191			unsigned int hash = POPu;
192
193			PUTBACK;
194			FREETMPS;
195			LEAVE;
196
197			return hash;
198			}
199
200	root	1.2	static void
201			croak_on_error_slowpath (TDB_CONTEXT *tdb)
202			{
203			errno = tdb_error (tdb);
204			croak_sv (sv_2mortal (newSVpv (tdb_errorstr (tdb), 0)));
205			}
206
207			#define croak_on_error(res) do { if ((res) < 0) croak_on_error_slowpath (tdb); } while (0)
208
209	root	1.1	static SV *custom_hash_cb[4];
210
211			static unsigned int custom_hash_1 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[0]); }
212			static unsigned int custom_hash_2 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[1]); }
213			static unsigned int custom_hash_3 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[2]); }
214			static unsigned int custom_hash_4 (TDB_DATA *key) { return custom_hash (key, custom_hash_cb[3]); }
215
216			typedef int mone_on_fail;
217
218			MODULE = TDB_FileX PACKAGE = TDB_FileX PREFIX = tdb_
219
220			PROTOTYPES: DISABLE
221
222			BOOT:
223			{
224			HV *stash = gv_stashpv ("TDB_FileX", 1);
225
226			static const struct {
227			const char *name;
228			IV iv;
229			} *civ, const_iv[] = {
230			# define const_iv(name) { # name, (IV) TDB_ ## name },
231			const_iv (ALLOW_NESTING)
232			const_iv (BIGENDIAN)
233			const_iv (CLEAR_IF_FIRST)
234			const_iv (CONVERT)
235			const_iv (DEFAULT)
236			const_iv (DISALLOW_NESTING)
237			const_iv (INCOMPATIBLE_HASH)
238			const_iv (INSERT)
239			const_iv (INTERNAL)
240			const_iv (MODIFY)
241			const_iv (MUTEX_LOCKING)
242			const_iv (NOLOCK)
243			const_iv (NOMMAP)
244			const_iv (NOSYNC)
245			const_iv (REPLACE)
246			const_iv (SEQNUM)
247			const_iv (VOLATILE)
248
249			const_iv (ERR_CORRUPT)
250			const_iv (ERR_IO)
251			const_iv (ERR_LOCK)
252			const_iv (ERR_OOM)
253			const_iv (ERR_EXISTS)
254			const_iv (ERR_NOLOCK)
255			const_iv (ERR_LOCK_TIMEOUT)
256			const_iv (ERR_NOEXIST)
257			const_iv (ERR_EINVAL)
258			const_iv (ERR_RDONLY)
259			const_iv (SUCCESS)
260
261			const_iv (DEBUG_FATAL)
262			const_iv (DEBUG_ERROR)
263			const_iv (DEBUG_WARNING)
264			const_iv (DEBUG_TRACE)
265			};
266
267			for (civ = const_iv + sizeof (const_iv) / sizeof (const_iv [0]); civ > const_iv; civ--)
268			newCONSTSUB (stash, (char *)civ[-1].name, newSViv (civ[-1].iv));
269
270			tdb_runtime_check_for_robust_mutexes ();
271			}
272
273			SV *
274			set_hash_function (int idx, SV *cb = 0)
275			PROTOTYPE: $;$
276			CODE:
277			{
278			if (idx < 1 \|\| idx > 4)
279			croak ("hash function index must be between 1 and 4");
280
281			SV **cbp = &custom_hash_cb[idx - 1];
282
283			RETVAL = cbp ? newSVsv (cbp) : &PL_sv_undef;
284
285			if (cb)
286			{
287			SvREFCNT_dec (*cbp);
288			*cbp = SvOK (cb) ? newSVsv (cb) : 0;
289			}
290			}
291			OUTPUT: RETVAL
292
293			void
294			DESTROY (TDB_CONTEXT *tdb)
295			CODE:
296			if (tdb)
297			{
298			SvREFCNT_dec ((SV *)tdb_get_logging_private (tdb));
299			tdb_close (tdb);
300			}
301
302	root	1.2	NO_OUTPUT int
303	root	1.1	tdb_delete (TDB_CONTEXT *tdb, TDB_DATA key)
304			ALIAS:
305			DELETE = 0
306	root	1.2	POSTCALL:
307			croak_on_error (RETVAL);
308	root	1.1
309	root	1.2	NO_OUTPUT int
310	root	1.1	tdb_wipe_all (TDB_CONTEXT *tdb)
311			ALIAS:
312			CLEAR = 0
313			CODE:
314			tdb_wipe_all (tdb);
315	root	1.2	POSTCALL:
316			croak_on_error (RETVAL);
317	root	1.1
318			void
319			tdb_dump_all (TDB_CONTEXT *tdb)
320
321			enum TDB_ERROR
322			tdb_error (TDB_CONTEXT *tdb)
323
324			const char *
325			tdb_errorstr (TDB_CONTEXT *tdb)
326
327	root	1.2	SV *
328	root	1.1	tdb_exists (TDB_CONTEXT *tdb, TDB_DATA key)
329			ALIAS:
330			EXISTS = 0
331	root	1.2	CODE:
332			RETVAL = tdb_exists (tdb, key) ? &PL_sv_yes : &PL_sv_no;
333			OUTPUT: RETVAL
334	root	1.1
335			TDB_DATA
336			tdb_fetch (TDB_CONTEXT *tdb, TDB_DATA key)
337			ALIAS:
338			FETCH = 0
339
340	root	1.2	NO_OUTPUT int
341			tdb_store (TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag = TDB_REPLACE)
342			ALIAS:
343			STORE = 0
344			POSTCALL:
345			croak_on_error (RETVAL);
346
347			NO_OUTPUT int
348	root	1.1	tdb_append (TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf)
349	root	1.2	POSTCALL:
350			croak_on_error (RETVAL);
351	root	1.1
352			TDB_DATA
353			tdb_firstkey (TDB_CONTEXT *tdb)
354			ALIAS:
355			FIRSTKEY = 0
356
357	root	1.2	NO_OUTPUT int
358			tdb_context_only_and_mone_on_fail (TDB_CONTEXT *tdb)
359			INTERFACE:
360			tdb_lockall
361			tdb_lockall_nonblock
362			tdb_unlockall
363			tdb_lockall_read
364			tdb_lockall_read_nonblock
365			tdb_unlockall_read
366			tdb_lockall_mark
367			tdb_lockall_unmark
368			tdb_transaction_start
369			tdb_transaction_start_nonblock
370			tdb_transaction_cancel
371			tdb_transaction_commit
372			tdb_transaction_prepare_commit
373			tdb_repack
374			POSTCALL:
375			croak_on_error (RETVAL);
376	root	1.1
377			bool tdb_transaction_active (TDB_CONTEXT *tdb)
378
379			void tdb_enable_seqnum (TDB_CONTEXT *tdb)
380
381			int tdb_get_seqnum (TDB_CONTEXT *tdb)
382
383			void tdb_increment_seqnum_nonblock (TDB_CONTEXT *tdb)
384
385			int tdb_hash_size (TDB_CONTEXT *tdb)
386
387			size_t tdb_map_size (TDB_CONTEXT *tdb)
388
389			int tdb_get_flags (TDB_CONTEXT *tdb)
390
391			void tdb_add_flags (TDB_CONTEXT *tdb, unsigned int flag)
392
393			void tdb_remove_flags (TDB_CONTEXT *tdb, unsigned int flag)
394
395			bool tdb_runtime_check_for_robust_mutexes ()
396
397			void
398			tdb_set_logging_function (TDB_CONTEXT tdb, SV cb)
399			CODE:
400			struct tdb_logging_context ctx;
401			ctx.log_fn = log_func_cb;
402			ctx.log_private = (SV *)newSVsv (cb);
403			SvREFCNT_dec ((SV *)tdb_get_logging_private (tdb));
404			tdb_set_logging_function (tdb, &ctx);
405
406			TDB_DATA
407			tdb_nextkey (TDB_CONTEXT *tdb, TDB_DATA key)
408			ALIAS:
409			NEXTKEY = 0
410
411			TDB_CONTEXT *
412			tdb_open (char class, char path, ...)
413			ALIAS:
414			TIEHASH = 0
415			CODE:
416			tdb_hash_func hash_func = 0;
417			struct tdb_logging_context ctx = { 0 };
418			int tdb_flags = TDB_DEFAULT;
419			int open_flags = O_RDWR \| O_CREAT;
420			mode_t mode = S_IRUSR \| S_IWUSR \| S_IRGRP \| S_IWGRP \| S_IROTH \| S_IWOTH;
421			int hash_size = 0;
422	root	1.4	int nocow = 0;
423	root	1.1
424			for (int i = 2; i < items - 1; i += 2)
425			{
426			const char *k = SvPVbyte_nolen (ST (i));
427			SV *v = ST (i + 1);
428
429			if (strEQ (k, "tdb_flags" )) tdb_flags = SvIV (v);
430			else if (strEQ (k, "open_flags")) open_flags = SvIV (v);
431			else if (strEQ (k, "mode" )) mode = SvUV (v);
432			else if (strEQ (k, "hash_size" )) hash_size = SvIV (v);
433			else if (strEQ (k, "log_cb"))
434			{
435			SvREFCNT_dec (ctx.log_private);
436			ctx.log_fn = 0;
437			ctx.log_private = 0;
438
439			if (SvOK (v))
440			{
441			ctx.log_fn = log_func_cb;
442			ctx.log_private = (void *)newSVsv (v);
443			}
444			}
445			else if (strEQ (k, "hash"))
446			{
447			const char *f = SvPVbyte_nolen (v);
448
449			if (!SvOK (v) ) hash_func = 0;
450			else if (strEQ (f, "default")) hash_func = 0;
451			else if (strEQ (f, "jenkins")) hash_func = tdb_jenkins_hash;
452			else if (strEQ (f, "fnv1ax" )) hash_func = fnv1ax_hash;
453			else if (strEQ (f, "xxh3" )) hash_func = xxh3_hash;
454			else if (strEQ (f, "1" )) hash_func = custom_hash_1;
455			else if (strEQ (f, "2" )) hash_func = custom_hash_2;
456			else if (strEQ (f, "3" )) hash_func = custom_hash_3;
457			else if (strEQ (f, "4" )) hash_func = custom_hash_4;
458			else
459			croak ("%s: not a known hash function", f);
460			}
461			else if (strEQ (k, "mutex"))
462			{
463			if (SvTRUE (v))
464			{
465			if (tdb_runtime_check_for_robust_mutexes ())
466			tdb_flags \|= TDB_MUTEX_LOCKING;
467			}
468			else
469			tdb_flags &= ~TDB_MUTEX_LOCKING;
470			}
471	root	1.4	else if (strEQ (k, "nocow"))
472			nocow = SvTRUE (v);
473	root	1.1	else
474			croak ("%s: not a known parameter name", k);
475			}
476
477	root	1.4	if (nocow && (open_flags & O_CREAT))
478			set_nocow (path, open_flags, mode);
479
480	root	1.1	RETVAL = tdb_open_ex (path, hash_size, tdb_flags, open_flags, mode, ctx.log_fn ? &ctx : 0, hash_func);
481
482			if (!RETVAL)
483			{
484			SvREFCNT_dec ((SV *)ctx.log_private);
485			XSRETURN_UNDEF;
486			}
487			OUTPUT: RETVAL
488
489			void
490			tdb_printfreelist (TDB_CONTEXT *tdb)
491
492	root	1.2	void
493	root	1.1	tdb_reopen (TDB_CONTEXT *tdb)
494			PROTOTYPE:
495			CODE:
496			void *logcb = tdb_get_logging_private (tdb);
497
498	root	1.2	int res = tdb_reopen (tdb);
499	root	1.1
500	root	1.2	if (res < 0)
501	root	1.1	{
502			/* tdb_reopen frees the TDB_CONTEXT on failure,
503			* so set scalar value to 0 to avoid double free on DESTROY */
504			sv_setiv ((SV*)SvRV (ST (0)), 0);
505			SvREFCNT_dec ((SV *)logcb);
506	root	1.2	croak ("tdb_reopen failed");
507	root	1.1	}
508
509			# FIXME: if this fails, we need to undef $tdb or something
510			# .. which we can't do - cos we don't know where it failed :(
511			# maybe reimplement this ourselves?
512	root	1.2	NO_OUTPUT int
513	root	1.1	tdb_reopen_all (int parent_longlived = 0)
514	root	1.2	POSTCALL:
515			if (RETVAL < 0)
516			croak ("tdb_reopen_all failed");
517	root	1.1
518			int
519			tdb_fd (TDB_CONTEXT *tdb)
520
521			const char *
522			tdb_name (TDB_CONTEXT *tdb)
523
524			int
525			tdb_traverse (TDB_CONTEXT tdb, SV fn = &PL_sv_undef)
526			ALIAS:
527			tdb_traverse_read = 1
528			CODE:
529	root	1.2	RETVAL = (ix ? tdb_traverse_read : tdb_traverse) (tdb, SvOK (fn) ? traverse_cb: 0, fn);
530			croak_on_error (RETVAL);
531	root	1.1	OUTPUT: RETVAL
532
533	root	1.3	mone_on_fail
534			tdb_check (TDB_CONTEXT tdb, SV fn = &PL_sv_undef)
535			CODE:
536			RETVAL = tdb_check (tdb, SvOK (fn) ? check_cb : 0, fn);
537			OUTPUT: RETVAL
538
539			mone_on_fail
540			tdb_rescue (TDB_CONTEXT tdb, SV fn)
541			CODE:
542			RETVAL = tdb_rescue (tdb, rescue_cb, fn);
543			OUTPUT: RETVAL
544