mdb.c 304 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
/*
Howard Chu's avatar
Howard Chu committed
8
 * Copyright 2011-2016 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

/* 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
 * declare them here. Using these APIs also means we must link to
 * ntdll.dll, which is not linked by default in user code.
 */
NTSTATUS WINAPI
NtCreateSection(OUT PHANDLE sh, IN ACCESS_MASK acc,
  IN void * oa OPTIONAL,
  IN PLARGE_INTEGER ms OPTIONAL,
  IN ULONG pp, IN ULONG aa, IN HANDLE fh OPTIONAL);

typedef enum _SECTION_INHERIT {
	ViewShare = 1,
	ViewUnmap = 2
} SECTION_INHERIT;

NTSTATUS WINAPI
NtMapViewOfSection(IN PHANDLE sh, IN HANDLE ph,
  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);

NTSTATUS WINAPI
NtClose(HANDLE h);

Howard Chu's avatar
Howard Chu committed
75
76
77
78
79
/** 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
80
81
82
#define MDB_THR_T	DWORD
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
83
84
#ifdef __GNUC__
# include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
85
#else
Howard Chu's avatar
Howard Chu committed
86
87
88
89
90
91
92
93
# define LITTLE_ENDIAN	1234
# define BIG_ENDIAN	4321
# define BYTE_ORDER	LITTLE_ENDIAN
# ifndef SSIZE_MAX
#  define SSIZE_MAX	INT_MAX
# endif
#endif
#else
Howard Chu's avatar
Howard Chu committed
94
95
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
96
#define MDB_PID_T	pid_t
Howard Chu's avatar
Howard Chu committed
97
#define MDB_THR_T	pthread_t
Howard Chu's avatar
Howard Chu committed
98
#include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
99
100
101
102
103
#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
104
#include <fcntl.h>
Howard Chu's avatar
Howard Chu committed
105
#endif
Howard Chu's avatar
Howard Chu committed
106

Howard Chu's avatar
Howard Chu committed
107
108
109
110
111
112
113
114
115
#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

116
117
#if defined(__linux) && !defined(MDB_FDATASYNC_WORKS)
/** fdatasync is broken on ext3/ext4fs on older kernels, see
Howard Chu's avatar
Howard Chu committed
118
119
120
 *	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.
121
122
123
 */
#define	BROKEN_FDATASYNC
#endif
124

Howard Chu's avatar
Howard Chu committed
125
#include <errno.h>
126
#include <limits.h>
Howard Chu's avatar
Howard Chu committed
127
#include <stddef.h>
128
#include <inttypes.h>
Howard Chu's avatar
Howard Chu committed
129
130
131
132
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
133
134
135
136
137

#ifdef _MSC_VER
#include <io.h>
typedef SSIZE_T	ssize_t;
#else
Howard Chu's avatar
Howard Chu committed
138
#include <unistd.h>
139
#endif
140

Howard Chu's avatar
Howard Chu committed
141
#if defined(__sun) || defined(ANDROID)
142
143
144
145
146
/* Most platforms have posix_memalign, older may only have memalign */
#define HAVE_MEMALIGN	1
#include <malloc.h>
#endif

147
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
148
#include <netinet/in.h>
149
150
151
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

152
#if defined(__APPLE__) || defined (BSD)
153
# if !(defined(MDB_USE_POSIX_MUTEX) || defined(MDB_USE_POSIX_SEM))
154
# define MDB_USE_SYSV_SEM	1
155
# endif
156
157
158
# define MDB_FDATASYNC		fsync
#elif defined(ANDROID)
# define MDB_FDATASYNC		fsync
159
160
#endif

161
162
#ifndef _WIN32
#include <pthread.h>
163
164
165
166
#ifdef MDB_USE_POSIX_SEM
# define MDB_USE_HASH		1
#include <semaphore.h>
#elif defined(MDB_USE_SYSV_SEM)
167
168
169
170
171
172
173
174
175
#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
176
177
#else
#define MDB_USE_POSIX_MUTEX	1
178
#endif /* MDB_USE_POSIX_SEM */
179
#endif /* !_WIN32 */
Howard Chu's avatar
Howard Chu committed
180

181
#if defined(_WIN32) + defined(MDB_USE_POSIX_SEM) + defined(MDB_USE_SYSV_SEM) \
Hallvard Furuseth's avatar
Hallvard Furuseth committed
182
183
184
185
	+ defined(MDB_USE_POSIX_MUTEX) != 1
# error "Ambiguous shared-lock implementation"
#endif

186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
#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
201
#ifndef BYTE_ORDER
Howard Chu's avatar
Howard Chu committed
202
203
204
205
206
207
208
209
210
211
212
213
# 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
214
#endif
Howard Chu's avatar
Howard Chu committed
215

Howard Chu's avatar
Howard Chu committed
216
217
218
219
220
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
221
222
#endif

Howard Chu's avatar
Howard Chu committed
223
#if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
Howard Chu's avatar
Howard Chu committed
224
225
226
#define MISALIGNED_OK	1
#endif

Howard Chu's avatar
Howard Chu committed
227
#include "lmdb.h"
228
229
#include "midl.h"

Howard Chu's avatar
Howard Chu committed
230
231
#if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
# error "Unknown or unsupported endianness (BYTE_ORDER)"
232
#elif (-6 & 5) || CHAR_BIT!=8 || UINT_MAX!=0xffffffff || MDB_SIZE_MAX%UINT_MAX
233
234
235
# error "Two's complement, reasonably sized integer types, please"
#endif

236
237
#ifdef __GNUC__
/** Put infrequently used env functions in separate section */
Howard Chu's avatar
Howard Chu committed
238
239
240
241
242
# ifdef __APPLE__
#  define	ESECT	__attribute__ ((section("__TEXT,text_env")))
# else
#  define	ESECT	__attribute__ ((section("text_env")))
# endif
243
244
245
246
#else
#define ESECT
#endif

Howard Chu's avatar
Howard Chu committed
247
#ifdef _WIN32
248
249
250
251
252
#define CALL_CONV WINAPI
#else
#define CALL_CONV
#endif

Howard Chu's avatar
Howard Chu committed
253
/** @defgroup internal	LMDB Internals
254
255
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
256
/** @defgroup compat	Compatibility Macros
Howard Chu's avatar
Howard Chu committed
257
258
259
260
 *	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.
261
262
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
263

Hallvard Furuseth's avatar
Hallvard Furuseth committed
264
	/** Features under development */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
265
266
267
268
#ifndef MDB_DEVEL
#define MDB_DEVEL 0
#endif

Hallvard Furuseth's avatar
Hallvard Furuseth committed
269
270
271
272
273
274
275
276
277
278
	/** 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

279
280
281
282
283
284
/* 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
285
286
287
288
#elif defined(MDB_USE_POSIX_MUTEX) && defined(EOWNERDEAD)
#define MDB_OWNERDEAD	EOWNERDEAD	/**< #LOCK_MUTEX0() result if dead owner */
#endif

289
290
291
#ifdef __GLIBC__
#define	GLIBC_VER	((__GLIBC__ << 16 )| __GLIBC_MINOR__)
#endif
292
293
/** Some platforms define the EOWNERDEAD error code
 * even though they don't support Robust Mutexes.
294
 * Compile with -DMDB_USE_ROBUST=0, or use some other
295
296
297
298
299
 * 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.)
 */
300
#ifndef MDB_USE_ROBUST
301
302
303
304
305
306
/* Android currently lacks Robust Mutex support. So does glibc < 2.4. */
# if defined(MDB_USE_POSIX_MUTEX) && (defined(ANDROID) || \
	(defined(__GLIBC__) && GLIBC_VER < 0x020004))
#  define MDB_USE_ROBUST	0
# else
#  define MDB_USE_ROBUST	1
307
308
309
310
# endif
#endif /* !MDB_USE_ROBUST */

#if defined(MDB_USE_POSIX_MUTEX) && (MDB_USE_ROBUST)
311
/* glibc < 2.12 only provided _np API */
312
313
#  if (defined(__GLIBC__) && GLIBC_VER < 0x02000c) || \
	(defined(PTHREAD_MUTEX_ROBUST_NP) && !defined(PTHREAD_MUTEX_ROBUST))
314
315
316
317
#   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
318
#endif /* MDB_USE_POSIX_MUTEX && MDB_USE_ROBUST */
319

320
#if defined(MDB_OWNERDEAD) && (MDB_USE_ROBUST)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
321
#define MDB_ROBUST_SUPPORTED	1
322
323
#endif

Howard Chu's avatar
Howard Chu committed
324
#ifdef _WIN32
Howard Chu's avatar
Howard Chu committed
325
#define MDB_USE_HASH	1
326
#define MDB_PIDLOCK	0
Howard Chu's avatar
Howard Chu committed
327
328
#define THREAD_RET	DWORD
#define pthread_t	HANDLE
Howard Chu's avatar
Howard Chu committed
329
#define pthread_mutex_t	HANDLE
Howard Chu's avatar
Howard Chu committed
330
#define pthread_cond_t	HANDLE
331
typedef HANDLE mdb_mutex_t, mdb_mutexref_t;
Howard Chu's avatar
Howard Chu committed
332
333
#define pthread_key_t	DWORD
#define pthread_self()	GetCurrentThreadId()
334
335
#define pthread_key_create(x,y)	\
	((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
Howard Chu's avatar
Howard Chu committed
336
337
#define pthread_key_delete(x)	TlsFree(x)
#define pthread_getspecific(x)	TlsGetValue(x)
338
#define pthread_setspecific(x,y)	(TlsSetValue(x,y) ? 0 : ErrCode())
Howard Chu's avatar
Howard Chu committed
339
340
#define pthread_mutex_unlock(x)	ReleaseMutex(*x)
#define pthread_mutex_lock(x)	WaitForSingleObject(*x, INFINITE)
Howard Chu's avatar
Howard Chu committed
341
#define pthread_cond_signal(x)	SetEvent(*x)
Howard Chu's avatar
Howard Chu committed
342
#define pthread_cond_wait(cond,mutex)	do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
343
344
345
346
#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
347
348
#define LOCK_MUTEX0(mutex)		WaitForSingleObject(mutex, INFINITE)
#define UNLOCK_MUTEX(mutex)		ReleaseMutex(mutex)
349
#define mdb_mutex_consistent(mutex)	0
Howard Chu's avatar
Howard Chu committed
350
#define getpid()	GetCurrentProcessId()
351
#define	MDB_FDATASYNC(fd)	(!FlushFileBuffers(fd))
352
#define	MDB_MSYNC(addr,len,flags)	(!FlushViewOfFile(addr,len))
Howard Chu's avatar
Howard Chu committed
353
#define	ErrCode()	GetLastError()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
354
#define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
355
#define	close(fd)	(CloseHandle(fd) ? 0 : -1)
Howard Chu's avatar
Howard Chu committed
356
#define	munmap(ptr,len)	UnmapViewOfFile(ptr)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
357
#ifdef PROCESS_QUERY_LIMITED_INFORMATION
Hallvard Furuseth's avatar
Hallvard Furuseth committed
358
359
360
361
#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
362
#else
Howard Chu's avatar
Howard Chu committed
363
364
365
#define THREAD_RET	void *
#define THREAD_CREATE(thr,start,arg)	pthread_create(&thr,NULL,start,arg)
#define THREAD_FINISH(thr)	pthread_join(thr,NULL)
366

367
368
369
	/** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
#define MDB_PIDLOCK			1

370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
#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
385

386
387
388
typedef struct mdb_mutex {
	int semid;
	int semnum;
389
	int *locked;
390
} mdb_mutex_t[1], *mdb_mutexref_t;
391

Hallvard Furuseth's avatar
Hallvard Furuseth committed
392
#define LOCK_MUTEX0(mutex)		mdb_sem_wait(mutex)
393
394
395
#define UNLOCK_MUTEX(mutex)		do { \
	struct sembuf sb = { 0, 1, SEM_UNDO }; \
	sb.sem_num = (mutex)->semnum; \
396
	*(mutex)->locked = 0; \
397
398
	semop((mutex)->semid, &sb, 1); \
} while(0)
399
400

static int
401
mdb_sem_wait(mdb_mutexref_t sem)
402
{
403
404
405
406
407
408
409
410
411
412
413
	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;
414
415
}

416
417
#define mdb_mutex_consistent(mutex)	0

Hallvard Furuseth's avatar
Hallvard Furuseth committed
418
#else	/* MDB_USE_POSIX_MUTEX: */
419
420
421
422
423
424
	/** Shared mutex/semaphore as it is stored (mdb_mutex_t), and as
	 *	local variables keep it (mdb_mutexref_t).
	 *
	 *	An mdb_mutex_t can be assigned to an mdb_mutexref_t.  They can
	 *	be the same, or an array[size 1] and a pointer.
	 *	@{
Howard Chu's avatar
Howard Chu committed
425
	 */
426
427
typedef pthread_mutex_t mdb_mutex_t[1], *mdb_mutexref_t;
	/*	@} */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
428
429
	/** 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
430
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
431
432
#define LOCK_MUTEX0(mutex)	pthread_mutex_lock(mutex)
	/** Unlock the reader or writer mutex.
Howard Chu's avatar
Howard Chu committed
433
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
434
#define UNLOCK_MUTEX(mutex)	pthread_mutex_unlock(mutex)
435
436
437
	/** Mark mutex-protected data as repaired, after death of previous owner.
	 */
#define mdb_mutex_consistent(mutex)	pthread_mutex_consistent(mutex)
438
#endif	/* MDB_USE_POSIX_SEM || MDB_USE_SYSV_SEM */
Howard Chu's avatar
Howard Chu committed
439
440
441

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

444
445
446
447
448
449
	/** 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
450
451
452
453
	/**	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
454
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
455
456
457
458
459

	/** 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
460
#define	GET_PAGESIZE(x)	((x) = sysconf(_SC_PAGE_SIZE))
Howard Chu's avatar
Howard Chu committed
461
#endif
Howard Chu's avatar
Howard Chu committed
462

463
#define	Z	MDB_FMT_Z	/**< printf/scanf format modifier for size_t */
464
465
#define	Yu	MDB_PRIy(u)	/**< printf format for #mdb_size_t */
#define	Yd	MDB_PRIy(d)	/**< printf format for "signed #mdb_size_t" */
Howard Chu's avatar
Howard Chu committed
466

467
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
468
#define MNAME_LEN	32
469
#elif defined(MDB_USE_SYSV_SEM)
470
#define MNAME_LEN	(sizeof(int))
471
472
#else
#define MNAME_LEN	(sizeof(pthread_mutex_t))
Howard Chu's avatar
Howard Chu committed
473
474
#endif

475
476
477
478
479
480
#ifdef MDB_USE_SYSV_SEM
#define SYSV_SEM_FLAG	1		/**< SysV sems in lockfile format */
#else
#define SYSV_SEM_FLAG	0
#endif

481
/** @} */
Howard Chu's avatar
Howard Chu committed
482

Hallvard Furuseth's avatar
Hallvard Furuseth committed
483
484
485
486
487
488
489
#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)))
490
static int mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc);
Hallvard Furuseth's avatar
Hallvard Furuseth committed
491
492
493
494
495
#else
#define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
#define mdb_mutex_failed(env, mutex, rc) (rc)
#endif

496
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
497
498
499
500
501
502
/**	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
503
504
505
 * preferably set some compiler flag to get the definition.
 */
#ifndef MDB_DSYNC
506
# ifdef O_DSYNC
Hallvard Furuseth's avatar
Hallvard Furuseth committed
507
# define MDB_DSYNC	O_DSYNC
508
509
510
# else
# define MDB_DSYNC	O_SYNC
# endif
Hallvard Furuseth's avatar
Hallvard Furuseth committed
511
#endif
512
513
514
515
516
517
518
#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
519
520
521
522
523
524
525
526
527
528
529
530
#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
531
532
#endif

Howard Chu's avatar
Howard Chu committed
533
534
535
536
537
538
539
540
	/** 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.
	 */
541
typedef MDB_ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
542

543
544
545
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
546
typedef MDB_ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
547

Howard Chu's avatar
Howard Chu committed
548
549
550
/** @defgroup debug	Debug Macros
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
551
#ifndef MDB_DEBUG
552
	/**	Enable debug output.  Needs variable argument macros (a C99 feature).
Howard Chu's avatar
Howard Chu committed
553
554
555
	 *	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
556
#define MDB_DEBUG 0
557
#endif
Howard Chu's avatar
Howard Chu committed
558

559
#if MDB_DEBUG
560
static int mdb_debug;
561
static txnid_t mdb_debug_start;
562

563
564
565
566
567
	/**	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
568
	fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
Howard Chu's avatar
Howard Chu committed
569
#else
570
# define DPRINTF(args)	((void) 0)
Howard Chu's avatar
Howard Chu committed
571
#endif
Howard Chu's avatar
Howard Chu committed
572
573
574
	/**	Print a debug string.
	 *	The string is printed literally, with no format processing.
	 */
575
#define DPUTS(arg)	DPRINTF(("%s", arg))
576
577
578
	/** 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
579
/** @} */
Howard Chu's avatar
Howard Chu committed
580

581
582
	/**	@brief The maximum size of a database page.
	 *
Hallvard Furuseth's avatar
Hallvard Furuseth committed
583
584
	 *	It is 32k or 64k, since value-PAGEBASE must fit in
	 *	#MDB_page.%mp_upper.
585
586
587
588
	 *
	 *	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
589
590
591
592
593
594
595
596
	 *
	 *	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
597
#define MAX_PAGESIZE	 (PAGEBASE ? 0x10000 : 0x8000)
Howard Chu's avatar
Howard Chu committed
598
599
600
601
602
603
604
605
606
607
608
609
610

	/** 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
611
#define MDB_MINKEYS	 2
Howard Chu's avatar
Howard Chu committed
612

Howard Chu's avatar
Howard Chu committed
613
	/**	A stamp that identifies a file as an LMDB file.
Howard Chu's avatar
Howard Chu committed
614
615
616
	 *	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
617
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
618

619
	/**	The version number for a database's datafile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
620
#define MDB_DATA_VERSION	 ((MDB_DEVEL) ? 999 : 1)
621
	/**	The version number for a database's lockfile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
622
#define MDB_LOCK_VERSION	 ((MDB_DEVEL) ? 999 : 1)
Howard Chu's avatar
Howard Chu committed
623

624
	/**	@brief The max size of a key we can write, or 0 for computed max.
625
	 *
626
627
628
629
630
631
632
633
634
	 *	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.
635
	 *
636
637
638
	 *	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
639
	 */
640
#ifndef MDB_MAXKEYSIZE
641
#define MDB_MAXKEYSIZE	 ((MDB_DEVEL) ? 0 : 511)
642
643
644
645
646
647
648
#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)
649
#endif
Howard Chu's avatar
Howard Chu committed
650

651
652
653
654
655
656
	/**	@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
657
#if MDB_DEBUG
658
659
660
661
	/**	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
662
663
664
665
	/**	A key buffer.
	 *	@ingroup debug
	 *	This is used for printing a hex dump of a key's contents.
	 */
666
#define DKBUF	char kbuf[DKBUF_MAXKEYSIZE*2+1]
Howard Chu's avatar
Howard Chu committed
667
668
669
670
	/**	Display a key in hex.
	 *	@ingroup debug
	 *	Invoke a function to display a key in hex.
	 */
Howard Chu's avatar
Howard Chu committed
671
672
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
Howard Chu's avatar
Howard Chu committed
673
#define	DKBUF
Howard Chu's avatar
Howard Chu committed
674
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
675
#endif
Howard Chu's avatar
Howard Chu committed
676

Howard Chu's avatar
Howard Chu committed
677
678
679
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
680
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
681

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

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

Howard Chu's avatar
Howard Chu committed
688
689
690
691
	/**	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
692
693
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
694
695
696
697
	/**	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
698
699
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
700
701
702
703
704
705
706
/**	@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
707
708
 *	If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
 *
Howard Chu's avatar
Howard Chu committed
709
710
 *	No reader table is used if the database is on a read-only filesystem, or
 *	if #MDB_NOLOCK is set.
711
 *
Howard Chu's avatar
Howard Chu committed
712
713
714
 *	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
715
716
 *	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
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 *	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
751
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
752
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
753
754
#endif

Howard Chu's avatar
Howard Chu committed
755
756
757
758
759
760
761
762
	/**	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
763
typedef struct MDB_rxbody {
764
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
765
766
767
768
769
770
	 *	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.
	 */
771
	volatile txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
772
	/** The process ID of the process owning this reader txn. */
773
	volatile MDB_PID_T	mrb_pid;
Howard Chu's avatar
Howard Chu committed
774
	/** The thread ID of the thread owning this txn. */
775
	volatile MDB_THR_T	mrb_tid;
Howard Chu's avatar
Howard Chu committed
776
777
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
778
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
779
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
780
781
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
782
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
783
784
785
#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
786
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
787
788
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
789
790
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
791
792
793
794
795
796
797
	/** 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
798
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
799
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
800
801
802
803
	 *	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
804
	 */
Howard Chu's avatar
Howard Chu committed
805
typedef struct MDB_txbody {
Howard Chu's avatar
Howard Chu committed
806
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
807
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
808
	uint32_t	mtb_magic;
809
810
		/** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
	uint32_t	mtb_format;
811
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
812
	char	mtb_rmname[MNAME_LEN];
813
814
#elif defined(MDB_USE_SYSV_SEM)
	int 	mtb_semid;
815
	int		mtb_rlocked;
Howard Chu's avatar
Howard Chu committed
816
#else
Howard Chu's avatar
Howard Chu committed
817
		/** Mutex protecting access to this table.
818
		 *	This is the reader table lock used with LOCK_MUTEX().
Howard Chu's avatar
Howard Chu committed
819
		 */
820
	mdb_mutex_t	mtb_rmutex;
Howard Chu's avatar
Howard Chu committed
821
#endif
Howard Chu's avatar
Howard Chu committed
822
823
824
825
		/**	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.
		 */
826
	volatile txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
827
828
829
830
		/** 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.
		 */
831
	volatile unsigned	mtb_numreaders;
Howard Chu's avatar
Howard Chu committed
832
833
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
834
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
835
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
836
837
838
	union {
		MDB_txbody mtb;
#define mti_magic	mt1.mtb.mtb_magic
839
#define mti_format	mt1.mtb.mtb_format
Hallvard Furuseth's avatar
Hallvard Furuseth committed
840
#define mti_rmutex	mt1.mtb.mtb_rmutex
Howard Chu's avatar
Howard Chu committed
841
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
842
843
#define mti_txnid	mt1.mtb.mtb_txnid
#define mti_numreaders	mt1.mtb.mtb_numreaders
844
845
#ifdef MDB_USE_SYSV_SEM
#define	mti_semid	mt1.mtb.mtb_semid
846
847
848
849
#define	mti_rlocked	mt1.mtb.mtb_rlocked
#endif
		char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mt1;
Howard Chu's avatar
Howard Chu committed
850
	union {
851
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
852
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
853
#define	mti_wmname	mt2.mt2_wmname
854
855
856
#elif defined MDB_USE_SYSV_SEM
		int mt2_wlocked;
#define mti_wlocked	mt2.mt2_wlocked
Howard Chu's avatar
Howard Chu committed
857
#else
858
		mdb_mutex_t	mt2_wmutex;
Howard Chu's avatar
Howard Chu committed
859
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
860
#endif
861
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
862
863
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
864
} MDB_txninfo;
865
866
867
868
869
870

	/** Lockfile format signature: version, features and field layout */
#define MDB_LOCK_FORMAT \
	((uint32_t) \
	 ((MDB_LOCK_VERSION) \
	  /* Flags which describe functionality */ \
871
	  + (SYSV_SEM_FLAG << 18) \
872
	  + (((MDB_PIDLOCK) != 0) << 16)))
Howard Chu's avatar
Howard Chu committed
873
/** @} */
Howard Chu's avatar
Howard Chu committed
874

Hallvard Furuseth's avatar
Hallvard Furuseth committed
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
/** 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
892
 */
Howard Chu's avatar
Howard Chu committed
893
typedef struct MDB_page {
894
895
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
896
	union {
897
		pgno_t		p_pgno;	/**< page number */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
898
		struct MDB_page *p_next; /**< for in-memory list of freed pages */
899
	} mp_p;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
900
	uint16_t	mp_pad;			/**< key size if this is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
901
902
903
904
905
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
906
907
908
909
#define	P_BRANCH	 0x01		/**< branch page */
#define	P_LEAF		 0x02		/**< leaf page */
#define	P_OVERFLOW	 0x04		/**< overflow page */
#define	P_META		 0x08		/**< meta page */
910
#define	P_DIRTY		 0x10		/**< dirty page, also set for #P_SUBP pages */
Howard Chu's avatar
Howard Chu committed
911
#define	P_LEAF2		 0x20		/**< for #MDB_DUPFIXED records */
Howard Chu's avatar
Howard Chu committed
912
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
913
#define	P_LOOSE		 0x4000		/**< page was dirtied then freed, can be reused */
Howard Chu's avatar
Howard Chu committed
914
#define	P_KEEP		 0x8000		/**< leave this page alone during spill */
Howard Chu's avatar
Howard Chu committed
915
/** @} */
Howard Chu's avatar
Howard Chu committed
916
	uint16_t	mp_flags;		/**< @ref mdb_page */
917
918
919
#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
920
	union {
Howard Chu's avatar
Howard Chu committed
921
		struct {
922
923
924
925
926
			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
927
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
928
929
} MDB_page;

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

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

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

Howard Chu's avatar
Howard Chu committed
939
	/** Number of nodes on a page */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
940
#define NUMKEYS(p)	 (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
Howard Chu's avatar
Howard Chu committed
941
942

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
946
947
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
948
949
950
951
952
953
	/** 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
954
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
955
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
956
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
957
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
958
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
959
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
960
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
961
962
	/** 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
963

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

Hallvard Furuseth's avatar
Hallvard Furuseth committed
967
968
969
	/** 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
970
#define NEXT_LOOSE_PAGE(p)		(*(MDB_page **)((p) + 2))
971

Howard Chu's avatar
Howard Chu committed
972
	/** Header for a single key/data pair within a page.
973
974
	 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
	 * We guarantee 2-byte alignment for 'MDB_node's.
Howard Chu's avatar
Howard Chu committed
975
976
977
978
	 */
typedef struct MDB_node {
	/** lo and hi are used for data size on leaf nodes and for
	 * child pgno on branch nodes. On 64 bit platforms, flags
979
	 * is also used for pgno. (Branch nodes have no flags).
Howard Chu's avatar
Howard Chu committed
980
	 * They are in host byte order in case that lets some
981
	 * accesses be optimized into a 32-bit word access.
Howard Chu's avatar
Howard Chu committed
982
	 */
983
984
985
986
987
#if BYTE_ORDER == LITTLE_ENDIAN
	unsigned short	mn_lo, mn_hi;	/**< part of data size or pgno */
#else
	unsigned short	mn_hi, mn_lo;
#endif
Howard Chu's avatar
Howard Chu committed
988
989
990
991
992
/** @defgroup mdb_node Node Flags
 *	@ingroup internal
 *	Flags for node headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
993
994
995
#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
996
997

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

Howard Chu's avatar
Howard Chu committed
1000
1001
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
1002
1003
1004
1005
1006
1007
1008
	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)

1009
1010
1011
	/** 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
1012
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
1013
1014
1015
1016
	 *	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
1017
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
1018
1019
1020
1021
	 *	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
1022
	/** Address of node \b i in page \b p */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1023
#define NODEPTR(p, i)	 ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
Howard Chu's avatar
Howard Chu committed
1024
1025
1026
1027
1028
1029
1030
1031

	/** 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 */
1032
1033
1034
#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
1035
1036
1037
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
1038
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
1039
1040
1041
1042
1043
1044
1045
1046
1047

	/** 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
1048
1049
1050
1051
	/** Copy a page number from src to dst */
#ifdef MISALIGNED_OK
#define COPY_PGNO(dst,src)	dst = src
#else
1052
#if MDB_SIZE_MAX > 0xffffffffU
Howard Chu's avatar
Howard Chu committed
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
#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
1072
1073
1074
1075
1076
1077
	/** 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
1078
1079
1080
1081
1082
1083
	/** 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
1084
1085

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
1086
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
1087
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
1088
	uint16_t	md_flags;	/**< @ref mdb_dbi_open */
Howard Chu's avatar
Howard Chu committed
1089
	uint16_t	md_depth;	/**< depth of this tree */
1090
1091
1092
	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 */
1093
	mdb_size_t	md_entries;		/**< number of data items */
Howard Chu's avatar
Howard Chu committed
1094
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
1095
1096
} MDB_db;

1097
1098
#define MDB_VALID	0x8000		/**< DB handle is valid, for me_dbflags */
#define PERSISTENT_FLAGS	(0xffff & ~(MDB_VALID))
1099
	/** #mdb_dbi_open() flags */
1100
1101
1102
#define VALID_FLAGS	(MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
	MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)

Howard Chu's avatar
Howard Chu committed
1103
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
1104
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
1105
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
1106
#define	MAIN_DBI	1
1107
1108
1109
1110
1111
	/** 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
1112

1113
1114
1115
1116
	/** 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
1117
typedef struct MDB_meta {
Howard Chu's avatar
Howard Chu committed
1118
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
1119
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
1120
	uint32_t	mm_magic;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1121
		/** Version number of this file. Must be set to #MDB_DATA_VERSION. */
Howard Chu's avatar
Howard Chu committed
1122
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
1123
1124