mdb.c 315 KB
Newer Older
1
/** @file mdb.c
Howard Chu's avatar
Howard Chu committed
2
 *	@brief Lightning memory-mapped database library
3
4
5
6
 *
 *	A Btree-based database management library modeled loosely on the
 *	BerkeleyDB API, but much simplified.
 */
Howard Chu's avatar
Howard Chu committed
7
/*
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
8
 * Copyright 2011-2021 Howard Chu, Symas Corp.
Howard Chu's avatar
Howard Chu committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted only as authorized by the OpenLDAP
 * Public License.
 *
 * A copy of this license is available in the file LICENSE in the
 * top-level directory of the distribution or, alternatively, at
 * <http://www.OpenLDAP.org/license.html>.
 *
 * This code is derived from btree.c written by Martin Hedenfalk.
 *
 * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
35
#ifndef _GNU_SOURCE
Hallvard Furuseth's avatar
Hallvard Furuseth committed
36
#define _GNU_SOURCE 1
37
#endif
Howard Chu's avatar
Howard Chu committed
38
#if defined(MDB_VL32) || defined(__WIN64__)
Howard Chu's avatar
Howard Chu committed
39
40
#define _FILE_OFFSET_BITS	64
#endif
Howard Chu's avatar
Howard Chu committed
41
#ifdef _WIN32
Howard Chu's avatar
Howard Chu committed
42
#include <malloc.h>
Howard Chu's avatar
Howard Chu committed
43
#include <windows.h>
44
#include <wchar.h>				/* get wcscpy() */
45
46
47
48
49
50

/* We use native NT APIs to setup the memory map, so that we can
 * let the DB file grow incrementally instead of always preallocating
 * the full size. These APIs are defined in <wdm.h> and <ntifs.h>
 * but those headers are meant for driver-level development and
 * conflict with the regular user-level headers, so we explicitly
51
52
53
 * declare them here. We get pointers to these functions from
 * NTDLL.DLL at runtime, to avoid buildtime dependencies on any
 * NTDLL import libraries.
54
 */
Howard Chu's avatar
Howard Chu committed
55
typedef NTSTATUS (WINAPI NtCreateSectionFunc)
56
  (OUT PHANDLE sh, IN ACCESS_MASK acc,
57
58
59
60
  IN void * oa OPTIONAL,
  IN PLARGE_INTEGER ms OPTIONAL,
  IN ULONG pp, IN ULONG aa, IN HANDLE fh OPTIONAL);

61
62
static NtCreateSectionFunc *NtCreateSection;

63
64
65
66
67
typedef enum _SECTION_INHERIT {
	ViewShare = 1,
	ViewUnmap = 2
} SECTION_INHERIT;

Howard Chu's avatar
Howard Chu committed
68
typedef NTSTATUS (WINAPI NtMapViewOfSectionFunc)
69
  (IN PHANDLE sh, IN HANDLE ph,
70
71
72
73
74
  IN OUT PVOID *addr, IN ULONG_PTR zbits,
  IN SIZE_T cs, IN OUT PLARGE_INTEGER off OPTIONAL,
  IN OUT PSIZE_T vs, IN SECTION_INHERIT ih,
  IN ULONG at, IN ULONG pp);

75
76
static NtMapViewOfSectionFunc *NtMapViewOfSection;

Howard Chu's avatar
Howard Chu committed
77
typedef NTSTATUS (WINAPI NtCloseFunc)(HANDLE h);
78
79

static NtCloseFunc *NtClose;
80

Howard Chu's avatar
Howard Chu committed
81
82
83
84
85
/** getpid() returns int; MinGW defines pid_t but MinGW64 typedefs it
 *  as int64 which is wrong. MSVC doesn't define it at all, so just
 *  don't use it.
 */
#define MDB_PID_T	int
Howard Chu's avatar
Howard Chu committed
86
87
88
#define MDB_THR_T	DWORD
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
89
90
#ifdef __GNUC__
# include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
91
#else
Howard Chu's avatar
Howard Chu committed
92
93
94
95
96
97
98
# define LITTLE_ENDIAN	1234
# define BIG_ENDIAN	4321
# define BYTE_ORDER	LITTLE_ENDIAN
# ifndef SSIZE_MAX
#  define SSIZE_MAX	INT_MAX
# endif
#endif
Howard Chu's avatar
Howard Chu committed
99
#define MDB_OFF_T	int64_t
Howard Chu's avatar
Howard Chu committed
100
#else
Howard Chu's avatar
Howard Chu committed
101
102
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
103
#define MDB_PID_T	pid_t
Howard Chu's avatar
Howard Chu committed
104
#define MDB_THR_T	pthread_t
Howard Chu's avatar
Howard Chu committed
105
#include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
106
107
108
109
110
#include <sys/uio.h>
#include <sys/mman.h>
#ifdef HAVE_SYS_FILE_H
#include <sys/file.h>
#endif
Howard Chu's avatar
Howard Chu committed
111
#include <fcntl.h>
112
#define MDB_OFF_T	off_t
Howard Chu's avatar
Howard Chu committed
113
#endif
Howard Chu's avatar
Howard Chu committed
114

Howard Chu's avatar
Howard Chu committed
115
116
117
118
119
120
121
122
123
#if defined(__mips) && defined(__linux)
/* MIPS has cache coherency issues, requires explicit cache control */
#include <asm/cachectl.h>
extern int cacheflush(char *addr, int nbytes, int cache);
#define CACHEFLUSH(addr, bytes, cache)	cacheflush(addr, bytes, cache)
#else
#define CACHEFLUSH(addr, bytes, cache)
#endif

124
125
#if defined(__linux) && !defined(MDB_FDATASYNC_WORKS)
/** fdatasync is broken on ext3/ext4fs on older kernels, see
Howard Chu's avatar
Howard Chu committed
126
127
128
 *	description in #mdb_env_open2 comments. You can safely
 *	define MDB_FDATASYNC_WORKS if this code will only be run
 *	on kernels 3.6 and newer.
129
130
131
 */
#define	BROKEN_FDATASYNC
#endif
132

Howard Chu's avatar
Howard Chu committed
133
#include <errno.h>
134
#include <limits.h>
Howard Chu's avatar
Howard Chu committed
135
#include <stddef.h>
136
#include <inttypes.h>
Howard Chu's avatar
Howard Chu committed
137
138
139
140
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
141
142
143
144
145

#ifdef _MSC_VER
#include <io.h>
typedef SSIZE_T	ssize_t;
#else
Howard Chu's avatar
Howard Chu committed
146
#include <unistd.h>
147
#endif
148

Howard Chu's avatar
Howard Chu committed
149
#if defined(__sun) || defined(__ANDROID__)
150
151
152
/* Most platforms have posix_memalign, older may only have memalign */
#define HAVE_MEMALIGN	1
#include <malloc.h>
153
154
155
156
/* On Solaris, we need the POSIX sigwait function */
#if defined (__sun)
# define _POSIX_PTHREAD_SEMANTICS	1
#endif
157
158
#endif

159
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
160
#include <netinet/in.h>
161
162
163
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

164
165
166
167
#if defined(__FreeBSD__) && defined(__FreeBSD_version) && __FreeBSD_version >= 1100110
# define MDB_USE_POSIX_MUTEX	1
# define MDB_USE_ROBUST	1
#elif defined(__APPLE__) || defined (BSD) || defined(__FreeBSD_kernel__)
168
# if !(defined(MDB_USE_POSIX_MUTEX) || defined(MDB_USE_POSIX_SEM))
169
# define MDB_USE_SYSV_SEM	1
170
# endif
171
# define MDB_FDATASYNC		fsync
Howard Chu's avatar
Howard Chu committed
172
#elif defined(__ANDROID__)
173
# define MDB_FDATASYNC		fsync
174
175
#endif

176
177
#ifndef _WIN32
#include <pthread.h>
178
#include <signal.h>
179
180
181
182
#ifdef MDB_USE_POSIX_SEM
# define MDB_USE_HASH		1
#include <semaphore.h>
#elif defined(MDB_USE_SYSV_SEM)
183
184
185
186
187
188
189
190
191
#include <sys/ipc.h>
#include <sys/sem.h>
#ifdef _SEM_SEMUN_UNDEFINED
union semun {
	int val;
	struct semid_ds *buf;
	unsigned short *array;
};
#endif /* _SEM_SEMUN_UNDEFINED */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
192
193
#else
#define MDB_USE_POSIX_MUTEX	1
194
#endif /* MDB_USE_POSIX_SEM */
195
#endif /* !_WIN32 */
Howard Chu's avatar
Howard Chu committed
196

197
#if defined(_WIN32) + defined(MDB_USE_POSIX_SEM) + defined(MDB_USE_SYSV_SEM) \
Hallvard Furuseth's avatar
Hallvard Furuseth committed
198
199
200
201
	+ defined(MDB_USE_POSIX_MUTEX) != 1
# error "Ambiguous shared-lock implementation"
#endif

202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
#ifdef USE_VALGRIND
#include <valgrind/memcheck.h>
#define VGMEMP_CREATE(h,r,z)    VALGRIND_CREATE_MEMPOOL(h,r,z)
#define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
#define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
#define VGMEMP_DESTROY(h)	VALGRIND_DESTROY_MEMPOOL(h)
#define VGMEMP_DEFINED(a,s)	VALGRIND_MAKE_MEM_DEFINED(a,s)
#else
#define VGMEMP_CREATE(h,r,z)
#define VGMEMP_ALLOC(h,a,s)
#define VGMEMP_FREE(h,a)
#define VGMEMP_DESTROY(h)
#define VGMEMP_DEFINED(a,s)
#endif

Howard Chu's avatar
Howard Chu committed
217
#ifndef BYTE_ORDER
Howard Chu's avatar
Howard Chu committed
218
219
220
221
222
223
224
225
226
227
228
229
# if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
/* Solaris just defines one or the other */
#  define LITTLE_ENDIAN	1234
#  define BIG_ENDIAN	4321
#  ifdef _LITTLE_ENDIAN
#   define BYTE_ORDER  LITTLE_ENDIAN
#  else
#   define BYTE_ORDER  BIG_ENDIAN
#  endif
# else
#  define BYTE_ORDER   __BYTE_ORDER
# endif
Howard Chu's avatar
Howard Chu committed
230
#endif
Howard Chu's avatar
Howard Chu committed
231

Howard Chu's avatar
Howard Chu committed
232
233
234
235
236
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
237
238
#endif

Howard Chu's avatar
Howard Chu committed
239
#if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
Howard Chu's avatar
Howard Chu committed
240
241
242
#define MISALIGNED_OK	1
#endif

Howard Chu's avatar
Howard Chu committed
243
#include "lmdb.h"
244
245
#include "midl.h"

Howard Chu's avatar
Howard Chu committed
246
247
#if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
# error "Unknown or unsupported endianness (BYTE_ORDER)"
248
#elif (-6 & 5) || CHAR_BIT!=8 || UINT_MAX!=0xffffffff || MDB_SIZE_MAX%UINT_MAX
249
250
251
# error "Two's complement, reasonably sized integer types, please"
#endif

252
253
#ifdef __GNUC__
/** Put infrequently used env functions in separate section */
Howard Chu's avatar
Howard Chu committed
254
255
256
257
258
# ifdef __APPLE__
#  define	ESECT	__attribute__ ((section("__TEXT,text_env")))
# else
#  define	ESECT	__attribute__ ((section("text_env")))
# endif
259
260
261
262
#else
#define ESECT
#endif

Howard Chu's avatar
Howard Chu committed
263
#ifdef _WIN32
264
265
266
267
268
#define CALL_CONV WINAPI
#else
#define CALL_CONV
#endif

Howard Chu's avatar
Howard Chu committed
269
/** @defgroup internal	LMDB Internals
270
271
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
272
/** @defgroup compat	Compatibility Macros
Howard Chu's avatar
Howard Chu committed
273
274
275
276
 *	A bunch of macros to minimize the amount of platform-specific ifdefs
 *	needed throughout the rest of the code. When the features this library
 *	needs are similar enough to POSIX to be hidden in a one-or-two line
 *	replacement, this macro approach is used.
277
278
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
279

Hallvard Furuseth's avatar
Hallvard Furuseth committed
280
	/** Features under development */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
281
282
283
284
#ifndef MDB_DEVEL
#define MDB_DEVEL 0
#endif

Hallvard Furuseth's avatar
Hallvard Furuseth committed
285
286
287
288
289
290
291
292
293
294
	/** Wrapper around __func__, which is a C99 feature */
#if __STDC_VERSION__ >= 199901L
# define mdb_func_	__func__
#elif __GNUC__ >= 2 || _MSC_VER >= 1300
# define mdb_func_	__FUNCTION__
#else
/* If a debug message says <mdb_unknown>(), update the #if statements above */
# define mdb_func_	"<mdb_unknown>"
#endif

295
296
297
298
299
300
/* Internal error codes, not exposed outside liblmdb */
#define	MDB_NO_ROOT		(MDB_LAST_ERRCODE + 10)
#ifdef _WIN32
#define MDB_OWNERDEAD	((int) WAIT_ABANDONED)
#elif defined MDB_USE_SYSV_SEM
#define MDB_OWNERDEAD	(MDB_LAST_ERRCODE + 11)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
301
302
303
304
#elif defined(MDB_USE_POSIX_MUTEX) && defined(EOWNERDEAD)
#define MDB_OWNERDEAD	EOWNERDEAD	/**< #LOCK_MUTEX0() result if dead owner */
#endif

305
306
307
#ifdef __GLIBC__
#define	GLIBC_VER	((__GLIBC__ << 16 )| __GLIBC_MINOR__)
#endif
308
309
/** Some platforms define the EOWNERDEAD error code
 * even though they don't support Robust Mutexes.
310
 * Compile with -DMDB_USE_ROBUST=0, or use some other
311
312
313
314
315
 * mechanism like -DMDB_USE_SYSV_SEM instead of
 * -DMDB_USE_POSIX_MUTEX. (SysV semaphores are
 * also Robust, but some systems don't support them
 * either.)
 */
316
#ifndef MDB_USE_ROBUST
317
/* Android currently lacks Robust Mutex support. So does glibc < 2.4. */
Howard Chu's avatar
Howard Chu committed
318
# if defined(MDB_USE_POSIX_MUTEX) && (defined(__ANDROID__) || \
319
320
321
322
	(defined(__GLIBC__) && GLIBC_VER < 0x020004))
#  define MDB_USE_ROBUST	0
# else
#  define MDB_USE_ROBUST	1
323
324
325
326
# endif
#endif /* !MDB_USE_ROBUST */

#if defined(MDB_USE_POSIX_MUTEX) && (MDB_USE_ROBUST)
327
/* glibc < 2.12 only provided _np API */
328
329
#  if (defined(__GLIBC__) && GLIBC_VER < 0x02000c) || \
	(defined(PTHREAD_MUTEX_ROBUST_NP) && !defined(PTHREAD_MUTEX_ROBUST))
330
331
332
333
#   define PTHREAD_MUTEX_ROBUST	PTHREAD_MUTEX_ROBUST_NP
#   define pthread_mutexattr_setrobust(attr, flag)	pthread_mutexattr_setrobust_np(attr, flag)
#   define pthread_mutex_consistent(mutex)	pthread_mutex_consistent_np(mutex)
#  endif
334
#endif /* MDB_USE_POSIX_MUTEX && MDB_USE_ROBUST */
335

336
#if defined(MDB_OWNERDEAD) && (MDB_USE_ROBUST)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
337
#define MDB_ROBUST_SUPPORTED	1
338
339
#endif

Howard Chu's avatar
Howard Chu committed
340
#ifdef _WIN32
Howard Chu's avatar
Howard Chu committed
341
#define MDB_USE_HASH	1
342
#define MDB_PIDLOCK	0
Howard Chu's avatar
Howard Chu committed
343
344
#define THREAD_RET	DWORD
#define pthread_t	HANDLE
Howard Chu's avatar
Howard Chu committed
345
#define pthread_mutex_t	HANDLE
Howard Chu's avatar
Howard Chu committed
346
#define pthread_cond_t	HANDLE
347
typedef HANDLE mdb_mutex_t, mdb_mutexref_t;
Howard Chu's avatar
Howard Chu committed
348
349
#define pthread_key_t	DWORD
#define pthread_self()	GetCurrentThreadId()
350
351
#define pthread_key_create(x,y)	\
	((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
Howard Chu's avatar
Howard Chu committed
352
353
#define pthread_key_delete(x)	TlsFree(x)
#define pthread_getspecific(x)	TlsGetValue(x)
354
#define pthread_setspecific(x,y)	(TlsSetValue(x,y) ? 0 : ErrCode())
Howard Chu's avatar
Howard Chu committed
355
356
#define pthread_mutex_unlock(x)	ReleaseMutex(*x)
#define pthread_mutex_lock(x)	WaitForSingleObject(*x, INFINITE)
Howard Chu's avatar
Howard Chu committed
357
#define pthread_cond_signal(x)	SetEvent(*x)
Howard Chu's avatar
Howard Chu committed
358
#define pthread_cond_wait(cond,mutex)	do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
359
360
361
362
#define THREAD_CREATE(thr,start,arg) \
	(((thr) = CreateThread(NULL, 0, start, arg, 0, NULL)) ? 0 : ErrCode())
#define THREAD_FINISH(thr) \
	(WaitForSingleObject(thr, INFINITE) ? ErrCode() : 0)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
363
364
#define LOCK_MUTEX0(mutex)		WaitForSingleObject(mutex, INFINITE)
#define UNLOCK_MUTEX(mutex)		ReleaseMutex(mutex)
365
#define mdb_mutex_consistent(mutex)	0
Howard Chu's avatar
Howard Chu committed
366
#define getpid()	GetCurrentProcessId()
367
#define	MDB_FDATASYNC(fd)	(!FlushFileBuffers(fd))
368
#define	MDB_MSYNC(addr,len,flags)	(!FlushViewOfFile(addr,len))
Howard Chu's avatar
Howard Chu committed
369
#define	ErrCode()	GetLastError()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
370
#define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
371
#define	close(fd)	(CloseHandle(fd) ? 0 : -1)
Howard Chu's avatar
Howard Chu committed
372
#define	munmap(ptr,len)	UnmapViewOfFile(ptr)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
373
#ifdef PROCESS_QUERY_LIMITED_INFORMATION
Hallvard Furuseth's avatar
Hallvard Furuseth committed
374
375
376
377
#define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
#else
#define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
#endif
Howard Chu's avatar
Howard Chu committed
378
#else
Howard Chu's avatar
Howard Chu committed
379
380
381
#define THREAD_RET	void *
#define THREAD_CREATE(thr,start,arg)	pthread_create(&thr,NULL,start,arg)
#define THREAD_FINISH(thr)	pthread_join(thr,NULL)
382

383
384
385
	/** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
#define MDB_PIDLOCK			1

386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
#ifdef MDB_USE_POSIX_SEM

typedef sem_t *mdb_mutex_t, *mdb_mutexref_t;
#define LOCK_MUTEX0(mutex)		mdb_sem_wait(mutex)
#define UNLOCK_MUTEX(mutex)		sem_post(mutex)

static int
mdb_sem_wait(sem_t *sem)
{
   int rc;
   while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
   return rc;
}

#elif defined MDB_USE_SYSV_SEM
401

402
403
404
typedef struct mdb_mutex {
	int semid;
	int semnum;
405
	int *locked;
406
} mdb_mutex_t[1], *mdb_mutexref_t;
407

Hallvard Furuseth's avatar
Hallvard Furuseth committed
408
#define LOCK_MUTEX0(mutex)		mdb_sem_wait(mutex)
409
410
411
#define UNLOCK_MUTEX(mutex)		do { \
	struct sembuf sb = { 0, 1, SEM_UNDO }; \
	sb.sem_num = (mutex)->semnum; \
412
	*(mutex)->locked = 0; \
413
414
	semop((mutex)->semid, &sb, 1); \
} while(0)
415
416

static int
417
mdb_sem_wait(mdb_mutexref_t sem)
418
{
419
420
421
422
423
424
425
426
427
428
429
	int rc, *locked = sem->locked;
	struct sembuf sb = { 0, -1, SEM_UNDO };
	sb.sem_num = sem->semnum;
	do {
		if (!semop(sem->semid, &sb, 1)) {
			rc = *locked ? MDB_OWNERDEAD : MDB_SUCCESS;
			*locked = 1;
			break;
		}
	} while ((rc = errno) == EINTR);
	return rc;
430
431
}

432
433
#define mdb_mutex_consistent(mutex)	0

Hallvard Furuseth's avatar
Hallvard Furuseth committed
434
#else	/* MDB_USE_POSIX_MUTEX: */
435
	/** Shared mutex/semaphore as the original is stored.
436
	 *
437
438
439
	 *	Not for copies.  Instead it can be assigned to an #mdb_mutexref_t.
	 *	When mdb_mutexref_t is a pointer and mdb_mutex_t is not, then it
	 *	is array[size 1] so it can be assigned to the pointer.
Howard Chu's avatar
Howard Chu committed
440
	 */
441
442
443
typedef pthread_mutex_t mdb_mutex_t[1];
	/** Reference to an #mdb_mutex_t */
typedef pthread_mutex_t *mdb_mutexref_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
444
445
	/** Lock the reader or writer mutex.
	 *	Returns 0 or a code to give #mdb_mutex_failed(), as in #LOCK_MUTEX().
Howard Chu's avatar
Howard Chu committed
446
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
447
448
#define LOCK_MUTEX0(mutex)	pthread_mutex_lock(mutex)
	/** Unlock the reader or writer mutex.
Howard Chu's avatar
Howard Chu committed
449
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
450
#define UNLOCK_MUTEX(mutex)	pthread_mutex_unlock(mutex)
451
452
453
	/** Mark mutex-protected data as repaired, after death of previous owner.
	 */
#define mdb_mutex_consistent(mutex)	pthread_mutex_consistent(mutex)
454
#endif	/* MDB_USE_POSIX_SEM || MDB_USE_SYSV_SEM */
Howard Chu's avatar
Howard Chu committed
455
456
457

	/** Get the error code for the last failed system function.
	 */
Howard Chu's avatar
Howard Chu committed
458
#define	ErrCode()	errno
Howard Chu's avatar
Howard Chu committed
459

460
461
462
463
464
465
	/** An abstraction for a file handle.
	 *	On POSIX systems file handles are small integers. On Windows
	 *	they're opaque pointers.
	 */
#define	HANDLE	int

Howard Chu's avatar
Howard Chu committed
466
467
468
469
	/**	A value for an invalid file handle.
	 *	Mainly used to initialize file variables and signify that they are
	 *	unused.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
470
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
471
472
473
474
475

	/** Get the size of a memory page for the system.
	 *	This is the basic size that the platform's memory manager uses, and is
	 *	fundamental to the use of memory-mapped files.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
476
#define	GET_PAGESIZE(x)	((x) = sysconf(_SC_PAGE_SIZE))
Howard Chu's avatar
Howard Chu committed
477
#endif
Howard Chu's avatar
Howard Chu committed
478

479
#define	Z	MDB_FMT_Z	/**< printf/scanf format modifier for size_t */
480
#define	Yu	MDB_PRIy(u)	/**< printf format for #mdb_size_t */
481
#define	Yd	MDB_PRIy(d)	/**< printf format for 'signed #mdb_size_t' */
Howard Chu's avatar
Howard Chu committed
482

483
#ifdef MDB_USE_SYSV_SEM
484
#define MNAME_LEN	(sizeof(int))
485
486
#else
#define MNAME_LEN	(sizeof(pthread_mutex_t))
Howard Chu's avatar
Howard Chu committed
487
488
#endif

489
490
491
492
493
494
495
496
497
/** Initial part of #MDB_env.me_mutexname[].
 *	Changes to this code must be reflected in #MDB_LOCK_FORMAT.
 */
#ifdef _WIN32
#define MUTEXNAME_PREFIX		"Global\\MDB"
#elif defined MDB_USE_POSIX_SEM
#define MUTEXNAME_PREFIX		"/MDB"
#endif

498
/** @} */
Howard Chu's avatar
Howard Chu committed
499

Hallvard Furuseth's avatar
Hallvard Furuseth committed
500
501
502
503
504
505
506
#ifdef MDB_ROBUST_SUPPORTED
	/** Lock mutex, handle any error, set rc = result.
	 *	Return 0 on success, nonzero (not rc) on error.
	 */
#define LOCK_MUTEX(rc, env, mutex) \
	(((rc) = LOCK_MUTEX0(mutex)) && \
	 ((rc) = mdb_mutex_failed(env, mutex, rc)))
507
static int mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc);
Hallvard Furuseth's avatar
Hallvard Furuseth committed
508
509
510
511
512
#else
#define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
#define mdb_mutex_failed(env, mutex, rc) (rc)
#endif

513
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
514
515
516
517
518
519
/**	A flag for opening a file and requesting synchronous data writes.
 *	This is only used when writing a meta page. It's not strictly needed;
 *	we could just do a normal write and then immediately perform a flush.
 *	But if this flag is available it saves us an extra system call.
 *
 *	@note If O_DSYNC is undefined but exists in /usr/include,
Hallvard Furuseth's avatar
Hallvard Furuseth committed
520
521
522
 * preferably set some compiler flag to get the definition.
 */
#ifndef MDB_DSYNC
523
# ifdef O_DSYNC
Hallvard Furuseth's avatar
Hallvard Furuseth committed
524
# define MDB_DSYNC	O_DSYNC
525
526
527
# else
# define MDB_DSYNC	O_SYNC
# endif
Hallvard Furuseth's avatar
Hallvard Furuseth committed
528
#endif
529
530
531
532
533
534
535
#endif

/** Function for flushing the data of a file. Define this to fsync
 *	if fdatasync() is not supported.
 */
#ifndef MDB_FDATASYNC
# define MDB_FDATASYNC	fdatasync
536
537
538
539
540
541
542
543
544
545
546
547
#endif

#ifndef MDB_MSYNC
# define MDB_MSYNC(addr,len,flags)	msync(addr,len,flags)
#endif

#ifndef MS_SYNC
#define	MS_SYNC	1
#endif

#ifndef MS_ASYNC
#define	MS_ASYNC	0
548
549
#endif

Howard Chu's avatar
Howard Chu committed
550
551
552
553
554
555
556
557
	/** A page number in the database.
	 *	Note that 64 bit page numbers are overkill, since pages themselves
	 *	already represent 12-13 bits of addressable memory, and the OS will
	 *	always limit applications to a maximum of 63 bits of address space.
	 *
	 *	@note In the #MDB_node structure, we only store 48 bits of this value,
	 *	which thus limits us to only 60 bits of addressable data.
	 */
558
typedef MDB_ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
559

560
561
562
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
563
typedef MDB_ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
564

Howard Chu's avatar
Howard Chu committed
565
566
567
/** @defgroup debug	Debug Macros
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
568
#ifndef MDB_DEBUG
569
	/**	Enable debug output.  Needs variable argument macros (a C99 feature).
Howard Chu's avatar
Howard Chu committed
570
571
572
	 *	Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
	 *	read from and written to the database (used for free space management).
	 */
Howard Chu's avatar
Howard Chu committed
573
#define MDB_DEBUG 0
574
#endif
Howard Chu's avatar
Howard Chu committed
575

576
#if MDB_DEBUG
577
static int mdb_debug;
578
static txnid_t mdb_debug_start;
579

580
581
582
583
584
	/**	Print a debug message with printf formatting.
	 *	Requires double parenthesis around 2 or more args.
	 */
# define DPRINTF(args) ((void) ((mdb_debug) && DPRINTF0 args))
# define DPRINTF0(fmt, ...) \
Hallvard Furuseth's avatar
Hallvard Furuseth committed
585
	fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
Howard Chu's avatar
Howard Chu committed
586
#else
587
# define DPRINTF(args)	((void) 0)
Howard Chu's avatar
Howard Chu committed
588
#endif
Howard Chu's avatar
Howard Chu committed
589
590
591
	/**	Print a debug string.
	 *	The string is printed literally, with no format processing.
	 */
592
#define DPUTS(arg)	DPRINTF(("%s", arg))
593
594
595
	/** Debuging output value of a cursor DBI: Negative in a sub-cursor. */
#define DDBI(mc) \
	(((mc)->mc_flags & C_SUB) ? -(int)(mc)->mc_dbi : (int)(mc)->mc_dbi)
Howard Chu's avatar
Howard Chu committed
596
/** @} */
Howard Chu's avatar
Howard Chu committed
597

598
599
	/**	@brief The maximum size of a database page.
	 *
Hallvard Furuseth's avatar
Hallvard Furuseth committed
600
601
	 *	It is 32k or 64k, since value-PAGEBASE must fit in
	 *	#MDB_page.%mp_upper.
602
603
604
605
	 *
	 *	LMDB will use database pages < OS pages if needed.
	 *	That causes more I/O in write transactions: The OS must
	 *	know (read) the whole page before writing a partial page.
Howard Chu's avatar
Howard Chu committed
606
607
608
609
610
611
612
613
	 *
	 *	Note that we don't currently support Huge pages. On Linux,
	 *	regular data files cannot use Huge pages, and in general
	 *	Huge pages aren't actually pageable. We rely on the OS
	 *	demand-pager to read our data and page it out when memory
	 *	pressure from other processes is high. So until OSs have
	 *	actual paging support for Huge pages, they're not viable.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
614
#define MAX_PAGESIZE	 (PAGEBASE ? 0x10000 : 0x8000)
Howard Chu's avatar
Howard Chu committed
615
616
617
618
619
620
621
622
623
624
625
626
627

	/** The minimum number of keys required in a database page.
	 *	Setting this to a larger value will place a smaller bound on the
	 *	maximum size of a data item. Data items larger than this size will
	 *	be pushed into overflow pages instead of being stored directly in
	 *	the B-tree node. This value used to default to 4. With a page size
	 *	of 4096 bytes that meant that any item larger than 1024 bytes would
	 *	go into an overflow page. That also meant that on average 2-3KB of
	 *	each overflow page was wasted space. The value cannot be lower than
	 *	2 because then there would no longer be a tree structure. With this
	 *	value, items larger than 2KB will go into overflow pages, and on
	 *	average only 1KB will be wasted.
	 */
Howard Chu's avatar
Howard Chu committed
628
#define MDB_MINKEYS	 2
Howard Chu's avatar
Howard Chu committed
629

Howard Chu's avatar
Howard Chu committed
630
	/**	A stamp that identifies a file as an LMDB file.
Howard Chu's avatar
Howard Chu committed
631
632
633
	 *	There's nothing special about this value other than that it is easily
	 *	recognizable, and it will reflect any byte order mismatches.
	 */
Howard Chu's avatar
Howard Chu committed
634
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
635

636
	/**	The version number for a database's datafile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
637
#define MDB_DATA_VERSION	 ((MDB_DEVEL) ? 999 : 1)
638
	/**	The version number for a database's lockfile format. */
639
#define MDB_LOCK_VERSION	 ((MDB_DEVEL) ? 999 : 2)
640
641
642
643
	/** Number of bits representing #MDB_LOCK_VERSION in #MDB_LOCK_FORMAT.
	 *	The remaining bits must leave room for #MDB_lock_desc.
	 */
#define MDB_LOCK_VERSION_BITS 12
Howard Chu's avatar
Howard Chu committed
644

645
	/**	@brief The max size of a key we can write, or 0 for computed max.
646
	 *
647
648
649
650
651
652
653
654
655
	 *	This macro should normally be left alone or set to 0.
	 *	Note that a database with big keys or dupsort data cannot be
	 *	reliably modified by a liblmdb which uses a smaller max.
	 *	The default is 511 for backwards compat, or 0 when #MDB_DEVEL.
	 *
	 *	Other values are allowed, for backwards compat.  However:
	 *	A value bigger than the computed max can break if you do not
	 *	know what you are doing, and liblmdb <= 0.9.10 can break when
	 *	modifying a DB with keys/dupsort data bigger than its max.
656
	 *
657
658
659
	 *	Data items in an #MDB_DUPSORT database are also limited to
	 *	this size, since they're actually keys of a sub-DB.  Keys and
	 *	#MDB_DUPSORT data items must fit on a node in a regular page.
Howard Chu's avatar
Howard Chu committed
660
	 */
661
#ifndef MDB_MAXKEYSIZE
662
#define MDB_MAXKEYSIZE	 ((MDB_DEVEL) ? 0 : 511)
663
664
665
666
667
668
669
#endif

	/**	The maximum size of a key we can write to the environment. */
#if MDB_MAXKEYSIZE
#define ENV_MAXKEY(env)	(MDB_MAXKEYSIZE)
#else
#define ENV_MAXKEY(env)	((env)->me_maxkey)
670
#endif
Howard Chu's avatar
Howard Chu committed
671

672
673
674
675
676
677
	/**	@brief The maximum size of a data item.
	 *
	 *	We only store a 32 bit value for node sizes.
	 */
#define MAXDATASIZE	0xffffffffUL

Howard Chu's avatar
Howard Chu committed
678
#if MDB_DEBUG
679
680
681
682
	/**	Key size which fits in a #DKBUF.
	 *	@ingroup debug
	 */
#define DKBUF_MAXKEYSIZE ((MDB_MAXKEYSIZE) > 0 ? (MDB_MAXKEYSIZE) : 511)
Howard Chu's avatar
Howard Chu committed
683
684
685
686
	/**	A key buffer.
	 *	@ingroup debug
	 *	This is used for printing a hex dump of a key's contents.
	 */
687
#define DKBUF	char kbuf[DKBUF_MAXKEYSIZE*2+1]
Howard Chu's avatar
Howard Chu committed
688
689
690
691
	/**	Display a key in hex.
	 *	@ingroup debug
	 *	Invoke a function to display a key in hex.
	 */
Howard Chu's avatar
Howard Chu committed
692
693
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
Howard Chu's avatar
Howard Chu committed
694
#define	DKBUF
Howard Chu's avatar
Howard Chu committed
695
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
696
#endif
Howard Chu's avatar
Howard Chu committed
697

Howard Chu's avatar
Howard Chu committed
698
699
700
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
701
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
702

703
	/** Test if the flags \b f are set in a flag word \b w. */
Howard Chu's avatar
Howard Chu committed
704
705
#define F_ISSET(w, f)	 (((w) & (f)) == (f))

706
707
708
	/** Round \b n up to an even number. */
#define EVEN(n)		(((n) + 1U) & -2) /* sign-extending -2 to match n+1U */

709
710
711
712
713
714
715
716
717
718
719
720
721
	/** Least significant 1-bit of \b n.  n must be of an unsigned type. */
#define LOW_BIT(n)		((n) & (-(n)))

	/** (log2(\b p2) % \b n), for p2 = power of 2 and 0 < n < 8. */
#define LOG2_MOD(p2, n)	(7 - 86 / ((p2) % ((1U<<(n))-1) + 11))
	/* Explanation: Let p2 = 2**(n*y + x), x<n and M = (1U<<n)-1. Now p2 =
	 * (M+1)**y * 2**x = 2**x (mod M). Finally "/" "happens" to return 7-x.
	 */

	/** Should be alignment of \b type. Ensure it is a power of 2. */
#define ALIGNOF2(type) \
	LOW_BIT(offsetof(struct { char ch_; type align_; }, align_))

Howard Chu's avatar
Howard Chu committed
722
723
724
725
	/**	Used for offsets within a single page.
	 *	Since memory pages are typically 4 or 8KB in size, 12-13 bits,
	 *	this is plenty.
	 */
Howard Chu's avatar
Howard Chu committed
726
727
typedef uint16_t	 indx_t;

728
729
typedef unsigned long long	mdb_hash_t;

Howard Chu's avatar
Howard Chu committed
730
731
732
733
	/**	Default size of memory map.
	 *	This is certainly too small for any actual applications. Apps should always set
	 *	the size explicitly using #mdb_env_set_mapsize().
	 */
Howard Chu's avatar
Howard Chu committed
734
735
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
736
737
738
739
740
741
742
/**	@defgroup readers	Reader Lock Table
 *	Readers don't acquire any locks for their data access. Instead, they
 *	simply record their transaction ID in the reader table. The reader
 *	mutex is needed just to find an empty slot in the reader table. The
 *	slot's address is saved in thread-specific data so that subsequent read
 *	transactions started by the same thread need no further locking to proceed.
 *
Howard Chu's avatar
Howard Chu committed
743
744
 *	If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
 *
Howard Chu's avatar
Howard Chu committed
745
746
 *	No reader table is used if the database is on a read-only filesystem, or
 *	if #MDB_NOLOCK is set.
747
 *
Howard Chu's avatar
Howard Chu committed
748
749
750
 *	Since the database uses multi-version concurrency control, readers don't
 *	actually need any locking. This table is used to keep track of which
 *	readers are using data from which old transactions, so that we'll know
751
752
 *	when a particular old transaction is no longer in use. Old transactions
 *	that have discarded any data pages can then have those pages reclaimed
Howard Chu's avatar
Howard Chu committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 *	for use by a later write transaction.
 *
 *	The lock table is constructed such that reader slots are aligned with the
 *	processor's cache line size. Any slot is only ever used by one thread.
 *	This alignment guarantees that there will be no contention or cache
 *	thrashing as threads update their own slot info, and also eliminates
 *	any need for locking when accessing a slot.
 *
 *	A writer thread will scan every slot in the table to determine the oldest
 *	outstanding reader transaction. Any freed pages older than this will be
 *	reclaimed by the writer. The writer doesn't use any locks when scanning
 *	this table. This means that there's no guarantee that the writer will
 *	see the most up-to-date reader info, but that's not required for correct
 *	operation - all we need is to know the upper bound on the oldest reader,
 *	we don't care at all about the newest reader. So the only consequence of
 *	reading stale information here is that old pages might hang around a
 *	while longer before being reclaimed. That's actually good anyway, because
 *	the longer we delay reclaiming old pages, the more likely it is that a
 *	string of contiguous pages can be found after coalescing old pages from
 *	many old transactions together.
 *	@{
 */
	/**	Number of slots in the reader table.
	 *	This value was chosen somewhat arbitrarily. 126 readers plus a
	 *	couple mutexes fit exactly into 8KB on my development machine.
	 *	Applications should set the table size using #mdb_env_set_maxreaders().
	 */
#define DEFAULT_READERS	126

	/**	The size of a CPU cache line in bytes. We want our lock structures
	 *	aligned to this size to avoid false cache line sharing in the
	 *	lock table.
	 *	This value works for most CPUs. For Itanium this should be 128.
	 */
Howard Chu's avatar
Howard Chu committed
787
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
788
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
789
790
#endif

Howard Chu's avatar
Howard Chu committed
791
792
793
794
795
796
797
798
	/**	The information we store in a single slot of the reader table.
	 *	In addition to a transaction ID, we also record the process and
	 *	thread ID that owns a slot, so that we can detect stale information,
	 *	e.g. threads or processes that went away without cleaning up.
	 *	@note We currently don't check for stale records. We simply re-init
	 *	the table when we know that we're the only process opening the
	 *	lock file.
	 */
Howard Chu's avatar
Howard Chu committed
799
typedef struct MDB_rxbody {
800
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
801
802
803
804
805
806
	 *	Multiple readers that start at the same time will probably have the
	 *	same ID here. Again, it's not important to exclude them from
	 *	anything; all we need to know is which version of the DB they
	 *	started from so we can avoid overwriting any data used in that
	 *	particular version.
	 */
807
	volatile txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
808
	/** The process ID of the process owning this reader txn. */
809
	volatile MDB_PID_T	mrb_pid;
Howard Chu's avatar
Howard Chu committed
810
	/** The thread ID of the thread owning this txn. */
811
	volatile MDB_THR_T	mrb_tid;
Howard Chu's avatar
Howard Chu committed
812
813
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
814
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
815
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
816
817
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
818
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
819
820
821
#define	mr_txnid	mru.mrx.mrb_txnid
#define	mr_pid	mru.mrx.mrb_pid
#define	mr_tid	mru.mrx.mrb_tid
Howard Chu's avatar
Howard Chu committed
822
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
823
824
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
825
826
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
827
828
829
830
831
832
833
	/** The header for the reader table.
	 *	The table resides in a memory-mapped file. (This is a different file
	 *	than is used for the main database.)
	 *
	 *	For POSIX the actual mutexes reside in the shared memory of this
	 *	mapped file. On Windows, mutexes are named objects allocated by the
	 *	kernel; we store the mutex names in this mapped file so that other
Howard Chu's avatar
Howard Chu committed
834
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
835
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
836
837
838
839
	 *	process-shared POSIX mutexes. For these cases where a named object
	 *	is used, the object name is derived from a 64 bit FNV hash of the
	 *	environment pathname. As such, naming collisions are extremely
	 *	unlikely. If a collision occurs, the results are unpredictable.
Howard Chu's avatar
Howard Chu committed
840
	 */
Howard Chu's avatar
Howard Chu committed
841
typedef struct MDB_txbody {
Howard Chu's avatar
Howard Chu committed
842
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
843
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
844
	uint32_t	mtb_magic;
845
846
		/** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
	uint32_t	mtb_format;
847
848
849
850
851
852
853
854
855
856
		/**	The ID of the last transaction committed to the database.
		 *	This is recorded here only for convenience; the value can always
		 *	be determined by reading the main database meta pages.
		 */
	volatile txnid_t		mtb_txnid;
		/** The number of slots that have been used in the reader table.
		 *	This always records the maximum count, it is not decremented
		 *	when readers release their slots.
		 */
	volatile unsigned	mtb_numreaders;
857
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
858
859
		/** Binary form of names of the reader/writer locks */
	mdb_hash_t			mtb_mutexid;
860
861
#elif defined(MDB_USE_SYSV_SEM)
	int 	mtb_semid;
862
	int		mtb_rlocked;
Howard Chu's avatar
Howard Chu committed
863
#else
Howard Chu's avatar
Howard Chu committed
864
		/** Mutex protecting access to this table.
865
		 *	This is the reader table lock used with LOCK_MUTEX().
Howard Chu's avatar
Howard Chu committed
866
		 */
867
	mdb_mutex_t	mtb_rmutex;
Howard Chu's avatar
Howard Chu committed
868
#endif
Howard Chu's avatar
Howard Chu committed
869
870
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
871
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
872
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
873
874
875
	union {
		MDB_txbody mtb;
#define mti_magic	mt1.mtb.mtb_magic
876
#define mti_format	mt1.mtb.mtb_format
Hallvard Furuseth's avatar
Hallvard Furuseth committed
877
#define mti_rmutex	mt1.mtb.mtb_rmutex
Howard Chu's avatar
Howard Chu committed
878
879
#define mti_txnid	mt1.mtb.mtb_txnid
#define mti_numreaders	mt1.mtb.mtb_numreaders
880
#define mti_mutexid	mt1.mtb.mtb_mutexid
881
882
#ifdef MDB_USE_SYSV_SEM
#define	mti_semid	mt1.mtb.mtb_semid
883
884
885
886
#define	mti_rlocked	mt1.mtb.mtb_rlocked
#endif
		char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mt1;
887
#if !(defined(_WIN32) || defined(MDB_USE_POSIX_SEM))
Howard Chu's avatar
Howard Chu committed
888
	union {
889
#ifdef MDB_USE_SYSV_SEM
890
891
		int mt2_wlocked;
#define mti_wlocked	mt2.mt2_wlocked
Howard Chu's avatar
Howard Chu committed
892
#else
893
		mdb_mutex_t	mt2_wmutex;
Howard Chu's avatar
Howard Chu committed
894
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
895
#endif
896
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
897
	} mt2;
898
#endif
Howard Chu's avatar
Howard Chu committed
899
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
900
} MDB_txninfo;
901
902
903

	/** Lockfile format signature: version, features and field layout */
#define MDB_LOCK_FORMAT \
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
	((uint32_t)         \
	 (((MDB_LOCK_VERSION) % (1U << MDB_LOCK_VERSION_BITS)) \
	  + MDB_lock_desc     * (1U << MDB_LOCK_VERSION_BITS)))

	/** Lock type and layout. Values 0-119. _WIN32 implies #MDB_PIDLOCK.
	 *	Some low values are reserved for future tweaks.
	 */
#ifdef _WIN32
# define MDB_LOCK_TYPE	(0 + ALIGNOF2(mdb_hash_t)/8 % 2)
#elif defined MDB_USE_POSIX_SEM
# define MDB_LOCK_TYPE	(4 + ALIGNOF2(mdb_hash_t)/8 % 2)
#elif defined MDB_USE_SYSV_SEM
# define MDB_LOCK_TYPE	(8)
#elif defined MDB_USE_POSIX_MUTEX
/* We do not know the inside of a POSIX mutex and how to check if mutexes
 * used by two executables are compatible. Just check alignment and size.
 */
# define MDB_LOCK_TYPE	(10 + \
		LOG2_MOD(ALIGNOF2(pthread_mutex_t), 5) + \
		sizeof(pthread_mutex_t) / 4U % 22 * 5)
#endif

enum {
	/** Magic number for lockfile layout and features.
	 *
	 *  This *attempts* to stop liblmdb variants compiled with conflicting
	 *	options from using the lockfile at the same time and thus breaking
	 *	it.  It describes locking types, and sizes and sometimes alignment
	 *	of the various lockfile items.
	 *
	 *	The detected ranges are mostly guesswork, or based simply on how
	 *	big they could be without using more bits.  So we can tweak them
	 *	in good conscience when updating #MDB_LOCK_VERSION.
	 */
	MDB_lock_desc =
	/* Default CACHELINE=64 vs. other values (have seen mention of 32-256) */
	(CACHELINE==64 ? 0 : 1 + LOG2_MOD(CACHELINE >> (CACHELINE>64), 5))
	+ 6  * (sizeof(MDB_PID_T)/4 % 3)    /* legacy(2) to word(4/8)? */
	+ 18 * (sizeof(pthread_t)/4 % 5)    /* can be struct{id, active data} */
	+ 90 * (sizeof(MDB_txbody) / CACHELINE % 3)
	+ 270 * (MDB_LOCK_TYPE % 120)
	/* The above is < 270*120 < 2**15 */
	+ ((sizeof(txnid_t) == 8) << 15)    /* 32bit/64bit */
	+ ((sizeof(MDB_reader) > CACHELINE) << 16)
	/* Not really needed - implied by MDB_LOCK_TYPE != (_WIN32 locking) */
	+ (((MDB_PIDLOCK) != 0)   << 17)
	/* 18 bits total: Must be <= (32 - MDB_LOCK_VERSION_BITS). */
};
Howard Chu's avatar
Howard Chu committed
952
/** @} */
Howard Chu's avatar
Howard Chu committed
953

Hallvard Furuseth's avatar
Hallvard Furuseth committed
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
/** Common header for all page types. The page type depends on #mp_flags.
 *
 * #P_BRANCH and #P_LEAF pages have unsorted '#MDB_node's at the end, with
 * sorted #mp_ptrs[] entries referring to them. Exception: #P_LEAF2 pages
 * omit mp_ptrs and pack sorted #MDB_DUPFIXED values after the page header.
 *
 * #P_OVERFLOW records occupy one or more contiguous pages where only the
 * first has a page header. They hold the real data of #F_BIGDATA nodes.
 *
 * #P_SUBP sub-pages are small leaf "pages" with duplicate data.
 * A node with flag #F_DUPDATA but not #F_SUBDATA contains a sub-page.
 * (Duplicate data can also go in sub-databases, which use normal pages.)
 *
 * #P_META pages contain #MDB_meta, the start point of an LMDB snapshot.
 *
 * Each non-metapage up to #MDB_meta.%mm_last_pg is reachable exactly once
 * in the snapshot: Either used by a database or listed in a freeDB record.
Howard Chu's avatar
Howard Chu committed
971
 */
Howard Chu's avatar
Howard Chu committed
972
typedef struct MDB_page {
973
974
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
975
	union {
976
		pgno_t		p_pgno;	/**< page number */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
977
		struct MDB_page *p_next; /**< for in-memory list of freed pages */
978
	} mp_p;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
979
	uint16_t	mp_pad;			/**< key size if this is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
980
981
982
983
984
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
985
986
987
988
#define	P_BRANCH	 0x01		/**< branch page */
#define	P_LEAF		 0x02		/**< leaf page */
#define	P_OVERFLOW	 0x04		/**< overflow page */
#define	P_META		 0x08		/**< meta page */
989
#define	P_DIRTY		 0x10		/**< dirty page, also set for #P_SUBP pages */
Howard Chu's avatar
Howard Chu committed
990
#define	P_LEAF2		 0x20		/**< for #MDB_DUPFIXED records */
Howard Chu's avatar
Howard Chu committed
991
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
992
#define	P_LOOSE		 0x4000		/**< page was dirtied then freed, can be reused */
Howard Chu's avatar
Howard Chu committed
993
#define	P_KEEP		 0x8000		/**< leave this page alone during spill */
Howard Chu's avatar
Howard Chu committed
994
/** @} */
Howard Chu's avatar
Howard Chu committed
995
	uint16_t	mp_flags;		/**< @ref mdb_page */
996
997
998
#define mp_lower	mp_pb.pb.pb_lower
#define mp_upper	mp_pb.pb.pb_upper
#define mp_pages	mp_pb.pb_pages
Howard Chu's avatar
Howard Chu committed
999
	union {
Howard Chu's avatar
Howard Chu committed
1000
		struct {
1001
1002
1003
1004
1005
			indx_t		pb_lower;		/**< lower bound of free space */
			indx_t		pb_upper;		/**< upper bound of free space */
		} pb;
		uint32_t	pb_pages;	/**< number of overflow pages */
	} mp_pb;
Howard Chu's avatar
Howard Chu committed
1006
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
1007
1008
} MDB_page;

Howard Chu's avatar
Howard Chu committed
1009
	/** Size of the page header, excluding dynamic data at the end */
1010
#define PAGEHDRSZ	 ((unsigned) offsetof(MDB_page, mp_ptrs))
Howard Chu's avatar
Howard Chu committed
1011

Howard Chu's avatar
Howard Chu committed
1012
1013
1014
	/** Address of first usable data byte in a page, after the header */
#define METADATA(p)	 ((void *)((char *)(p) + PAGEHDRSZ))

1015
	/** ITS#7713, change PAGEBASE to handle 65536 byte pages */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1016
#define	PAGEBASE	((MDB_DEVEL) ? PAGEHDRSZ : 0)
1017

Howard Chu's avatar
Howard Chu committed
1018
	/** Number of nodes on a page */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1019
#define NUMKEYS(p)	 (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
Howard Chu's avatar
Howard Chu committed
1020
1021

	/** The amount of space remaining in the page */
Howard Chu's avatar
Howard Chu committed
1022
#define SIZELEFT(p)	 (indx_t)((p)->mp_upper - (p)->mp_lower)
Howard Chu's avatar
Howard Chu committed
1023
1024

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
1025
1026
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
1027
1028
1029
1030
1031
1032
	/** The minimum page fill factor, in tenths of a percent.
	 *	Pages emptier than this are candidates for merging.
	 */
#define FILL_THRESHOLD	 250

	/** Test if a page is a leaf page */
Howard Chu's avatar
Howard Chu committed
1033
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
1034
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
1035
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
1036
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
1037
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
1038
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
1039
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
1040
1041
	/** Test if a page is a sub page */
#define IS_SUBP(p)	 F_ISSET((p)->mp_flags, P_SUBP)
Howard Chu's avatar
Howard Chu committed
1042

Howard Chu's avatar
Howard Chu committed
1043
	/** The number of overflow pages needed to store the given size. */
1044
#define OVPAGES(size, psize)	((PAGEHDRSZ-1 + (size)) / (psize) + 1)
Howard Chu's avatar
Howard Chu committed
1045

Hallvard Furuseth's avatar
Hallvard Furuseth committed
1046
1047
1048
	/** Link in #MDB_txn.%mt_loose_pgs list.
	 *  Kept outside the page header, which is needed when reusing the page.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1049
#define NEXT_LOOSE_PAGE(p)		(*(MDB_page **)((p) + 2))
1050

Howard Chu's avatar
Howard Chu committed
1051
	/** Header for a single key/data pair within a page.
1052
1053
	 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
	 * We guarantee 2-byte alignment for 'MDB_node's.
1054
1055
1056
1057
1058
	 *
	 * #mn_lo and #mn_hi are used for data size on leaf nodes, and for child
	 * pgno on branch nodes.  On 64 bit platforms, #mn_flags is also used
	 * for pgno.  (Branch nodes have no flags).  Lo and hi are in host byte
	 * order in case some accesses can be optimized to 32-bit word access.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1059
1060
1061
1062
1063
	 *
	 * Leaf node flags describe node contents.  #F_BIGDATA says the node's
	 * data part is the page number of an overflow page with actual data.
	 * #F_DUPDATA and #F_SUBDATA can be combined giving duplicate data in
	 * a sub-page/sub-database, and named databases (just #F_SUBDATA).
Howard Chu's avatar
Howard Chu committed
1064
1065
	 */
typedef struct MDB_node {
1066
1067
	/** part of data size or pgno
	 *	@{ */
1068
#if BYTE_ORDER == LITTLE_ENDIAN
1069
	unsigned short	mn_lo, mn_hi;
1070
1071
1072
#else
	unsigned short	mn_hi, mn_lo;
#endif
1073
	/** @} */
Howard Chu's avatar
Howard Chu committed
1074
1075
1076
1077
1078
/** @defgroup mdb_node Node Flags
 *	@ingroup internal
 *	Flags for node headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
1079
1080
1081
#define F_BIGDATA	 0x01			/**< data put on overflow page */
#define F_SUBDATA	 0x02			/**< data is a sub-database */
#define F_DUPDATA	 0x04			/**< data has duplicates */
Howard Chu's avatar
Howard Chu committed
1082
1083

/** valid flags for #mdb_node_add() */
1084
#define	NODE_ADD_FLAGS	(F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
Howard Chu's avatar
Howard Chu committed
1085

Howard Chu's avatar
Howard Chu committed
1086
1087
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
1088
1089
1090
1091
1092
1093
1094
	unsigned short	mn_ksize;		/**< key size */
	char		mn_data[1];			/**< key and data are appended here */
} MDB_node;

	/** Size of the node header, excluding dynamic data at the end */
#define NODESIZE	 offsetof(MDB_node, mn_data)

1095
1096
1097
	/** Bit position of top word in page number, for shifting mn_flags */
#define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)

Howard Chu's avatar
Howard Chu committed
1098
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
1099
1100
1101
1102
	 *	This is just the node header plus the key, there is no data.
	 */
#define INDXSIZE(k)	 (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))

Howard Chu's avatar
Howard Chu committed
1103
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
1104
1105
1106
1107
	 *	This is node header plus key plus data size.
	 */
#define LEAFSIZE(k, d)	 (NODESIZE + (k)->mv_size + (d)->mv_size)

Howard Chu's avatar
Howard Chu committed
1108
	/** Address of node \b i in page \b p */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1109
#define NODEPTR(p, i)	 ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
Howard Chu's avatar
Howard Chu committed
1110
1111
1112
1113
1114
1115
1116
1117

	/** Address of the key for the node */
#define NODEKEY(node)	 (void *)((node)->mn_data)

	/** Address of the data for a node */
#define NODEDATA(node)	 (void *)((char *)(node)->mn_data + (node)->mn_ksize)

	/** Get the page number pointed to by a branch node */
1118
1119
1120
#define NODEPGNO(node) \
	((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
	 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
Howard Chu's avatar
Howard Chu committed
1121
1122
1123
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
1124
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
1125
1126
1127
1128
1129
1130
1131
1132
1133

	/** Get the size of the data in a leaf node */
#define NODEDSZ(node)	 ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
	/** Set the size of the data for a leaf node */
#define SETDSZ(node,size)	do { \
	(node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
	/** The size of a key in a node */
#define NODEKSZ(node)	 ((node)->mn_ksize)

Howard Chu's avatar
Howard Chu committed
1134
1135
1136
1137
	/** Copy a page number from src to dst */
#ifdef MISALIGNED_OK
#define COPY_PGNO(dst,src)	dst = src
#else
1138
#if MDB_SIZE_MAX > 0xffffffffU
Howard Chu's avatar
Howard Chu committed
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
#define COPY_PGNO(dst,src)	do { \
	unsigned short *s, *d;	\
	s = (unsigned short *)&(src);	\
	d = (unsigned short *)&(dst);	\
	*d++ = *s++;	\
	*d++ = *s++;	\
	*d++ = *s++;	\
	*d = *s;	\
} while (0)
#else
#define COPY_PGNO(dst,src)	do { \
	unsigned short *s, *d;	\
	s = (unsigned short *)&(src);	\
	d = (unsigned short *)&(dst);	\
	*d++ = *s++;	\
	*d = *s;	\
} while (0)
#endif
#endif
Howard Chu's avatar
Howard Chu committed
1158
1159
1160
1161
1162
1163
	/** The address of a key in a LEAF2 page.
	 *	LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
	 *	There are no node headers, keys are stored contiguously.
	 */
#define LEAF2KEY(p, i, ks)	((char *)(p) + PAGEHDRSZ + ((i)*(ks)))

Howard Chu's avatar
Howard Chu committed
1164
1165
1166
1167
1168
1169
	/** Set the \b node's key into \b keyptr, if requested. */
#define MDB_GET_KEY(node, keyptr)	{ if ((keyptr) != NULL) { \
	(keyptr)->mv_size = NODEKSZ(node); (keyptr)->mv_data = NODEKEY(node); } }

	/** Set the \b node's key into \b key. */
#define MDB_GET_KEY2(node, key)	{ key.mv_size = NODEKSZ(node); key.mv_data = NODEKEY(node); }
Howard Chu's avatar
Howard Chu committed
1170
1171

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
1172
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
1173
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
1174
	uint16_t	md_flags;	/**< @ref mdb_dbi_open */
Howard Chu's avatar
Howard Chu committed
1175
	uint16_t	md_depth;	/**< depth of this tree */
1176
1177
1178
	pgno_t		md_branch_pages;	/**< number of internal pages */
	pgno_t		md_leaf_pages;		/**< number of leaf pages */
	pgno_t		md_overflow_pages;	/**< number of overflow pages */
1179
	mdb_size_t	md_entries;		/**< number of data items */
Howard Chu's avatar
Howard Chu committed
1180
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
1181
1182
} MDB_db;

1183
1184
#define MDB_VALID	0x8000		/**< DB handle is valid, for me_dbflags */
#define PERSISTENT_FLAGS	(0xffff & ~(MDB_VALID))
1185
	/** #mdb_dbi_open() flags */
1186
1187
1188
#define VALID_FLAGS	(MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
	MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)

Howard Chu's avatar
Howard Chu committed
1189
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
1190
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
1191
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
1192
#define	MAIN_DBI	1
1193
1194
1195
1196
1197
	/** Number of DBs in metapage (free and main) - also hardcoded elsewhere */
#define CORE_DBS	2

	/** Number of meta pages - also hardcoded elsewhere */
#define NUM_METAS	2
Howard Chu's avatar
Howard Chu committed
1198

1199
1200
1201
1202
	/** Meta page content.
	 *	A meta page is the start point for accessing a database snapshot.
	 *	Pages 0-1 are meta pages. Transaction N writes meta page #(N % 2).
	 */
Howard Chu's avatar
Howard Chu committed
1203
typedef struct MDB_meta {
Howard Chu's avatar
Howard Chu committed
1204
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
1205
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
1206
	uint32_t	mm_magic;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1207
		/** Version number of this file. Must be set to #MDB_DATA_VERSION. */
Howard Chu's avatar
Howard Chu committed
1208
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
1209
1210
1211
1212
1213
1214
1215
#ifdef MDB_VL32
	union {		/* always zero since we don't support fixed mapping in MDB_VL32 */
		MDB_ID	mmun_ull;
		void *mmun_address;
	} mm_un;
#define	mm_address mm_un.mmun_address
#else
Howard Chu's avatar
Howard Chu committed
1216
	void		*mm_address;		/**< address for fixed mapping */
Howard Chu's avatar
Howard Chu committed
1217
#endif
1218
	mdb_size_t	mm_mapsize;			/**< size of mmap region */
1219
	MDB_db		mm_dbs[CORE_DBS];	/**< first is free space, 2nd is main db */
Howard Chu's avatar
Howard Chu committed
1220
	/** The size of pages used in this DB */