mdb.c 272 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-2015 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
#ifdef _WIN32
Howard Chu's avatar
Howard Chu committed
39
#include <malloc.h>
Howard Chu's avatar
Howard Chu committed
40
#include <windows.h>
Howard Chu's avatar
Howard Chu committed
41
42
43
44
45
/** 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
46
47
48
#define MDB_THR_T	DWORD
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
49
50
#ifdef __GNUC__
# include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
51
#else
Howard Chu's avatar
Howard Chu committed
52
53
54
55
56
57
58
59
# 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
60
61
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
62
#define MDB_PID_T	pid_t
Howard Chu's avatar
Howard Chu committed
63
#define MDB_THR_T	pthread_t
Howard Chu's avatar
Howard Chu committed
64
#include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
65
66
67
68
69
#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
70
#include <fcntl.h>
Howard Chu's avatar
Howard Chu committed
71
#endif
Howard Chu's avatar
Howard Chu committed
72

Howard Chu's avatar
Howard Chu committed
73
74
75
76
77
78
79
80
81
#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

82
83
#if defined(__linux) && !defined(MDB_FDATASYNC_WORKS)
/** fdatasync is broken on ext3/ext4fs on older kernels, see
Howard Chu's avatar
Howard Chu committed
84
85
86
 *	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.
87
88
89
 */
#define	BROKEN_FDATASYNC
#endif
90

Howard Chu's avatar
Howard Chu committed
91
#include <errno.h>
92
#include <limits.h>
Howard Chu's avatar
Howard Chu committed
93
#include <stddef.h>
94
#include <inttypes.h>
Howard Chu's avatar
Howard Chu committed
95
96
97
98
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
99
100
101
102
103

#ifdef _MSC_VER
#include <io.h>
typedef SSIZE_T	ssize_t;
#else
Howard Chu's avatar
Howard Chu committed
104
#include <unistd.h>
105
#endif
106

Howard Chu's avatar
Howard Chu committed
107
#if defined(__sun) || defined(ANDROID)
108
109
110
111
112
/* Most platforms have posix_memalign, older may only have memalign */
#define HAVE_MEMALIGN	1
#include <malloc.h>
#endif

113
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
114
#include <netinet/in.h>
115
116
117
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

118
#if defined(__APPLE__) || defined (BSD)
119
# if !(defined(MDB_USE_POSIX_MUTEX) || defined(MDB_USE_POSIX_SEM))
120
# define MDB_USE_SYSV_SEM	1
121
# endif
122
123
124
# define MDB_FDATASYNC		fsync
#elif defined(ANDROID)
# define MDB_FDATASYNC		fsync
125
126
#endif

127
128
#ifndef _WIN32
#include <pthread.h>
129
130
131
132
#ifdef MDB_USE_POSIX_SEM
# define MDB_USE_HASH		1
#include <semaphore.h>
#elif defined(MDB_USE_SYSV_SEM)
133
134
135
136
137
138
139
140
141
#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
142
143
#else
#define MDB_USE_POSIX_MUTEX	1
144
#endif /* MDB_USE_POSIX_SEM */
145
#endif /* !_WIN32 */
Howard Chu's avatar
Howard Chu committed
146

147
#if defined(_WIN32) + defined(MDB_USE_POSIX_SEM) + defined(MDB_USE_SYSV_SEM) \
Hallvard Furuseth's avatar
Hallvard Furuseth committed
148
149
150
151
	+ defined(MDB_USE_POSIX_MUTEX) != 1
# error "Ambiguous shared-lock implementation"
#endif

152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
#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
167
#ifndef BYTE_ORDER
Howard Chu's avatar
Howard Chu committed
168
169
170
171
172
173
174
175
176
177
178
179
# 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
180
#endif
Howard Chu's avatar
Howard Chu committed
181

Howard Chu's avatar
Howard Chu committed
182
183
184
185
186
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
187
188
#endif

Howard Chu's avatar
Howard Chu committed
189
#if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
Howard Chu's avatar
Howard Chu committed
190
191
192
#define MISALIGNED_OK	1
#endif

Howard Chu's avatar
Howard Chu committed
193
#include "lmdb.h"
194
195
#include "midl.h"

Howard Chu's avatar
Howard Chu committed
196
197
#if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
# error "Unknown or unsupported endianness (BYTE_ORDER)"
198
199
200
201
#elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
# error "Two's complement, reasonably sized integer types, please"
#endif

202
203
#ifdef __GNUC__
/** Put infrequently used env functions in separate section */
Howard Chu's avatar
Howard Chu committed
204
205
206
207
208
# ifdef __APPLE__
#  define	ESECT	__attribute__ ((section("__TEXT,text_env")))
# else
#  define	ESECT	__attribute__ ((section("text_env")))
# endif
209
210
211
212
#else
#define ESECT
#endif

213
214
215
216
217
218
#ifdef _MSC_VER
#define CALL_CONV WINAPI
#else
#define CALL_CONV
#endif

Howard Chu's avatar
Howard Chu committed
219
/** @defgroup internal	LMDB Internals
220
221
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
222
/** @defgroup compat	Compatibility Macros
Howard Chu's avatar
Howard Chu committed
223
224
225
226
 *	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.
227
228
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
229

Hallvard Furuseth's avatar
Hallvard Furuseth committed
230
	/** Features under development */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
231
232
233
234
#ifndef MDB_DEVEL
#define MDB_DEVEL 0
#endif

Hallvard Furuseth's avatar
Hallvard Furuseth committed
235
236
237
238
239
240
241
242
243
244
	/** 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

245
246
247
248
249
250
/* 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
251
252
253
254
#elif defined(MDB_USE_POSIX_MUTEX) && defined(EOWNERDEAD)
#define MDB_OWNERDEAD	EOWNERDEAD	/**< #LOCK_MUTEX0() result if dead owner */
#endif

255
256
257

/** Some platforms define the EOWNERDEAD error code
 * even though they don't support Robust Mutexes.
258
 * Compile with -DMDB_USE_ROBUST=0, or use some other
259
260
261
262
263
 * 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.)
 */
264
265
266
267
268
269
#ifndef MDB_USE_ROBUST
/* Android currently lacks Robust Mutex support */
#if defined(ANDROID) && defined(MDB_USE_POSIX_MUTEX) && !defined(MDB_USE_ROBUST)
#define MDB_USE_ROBUST	0
#else
#define MDB_USE_ROBUST	1
270
#endif
271
#endif /* MDB_USE_ROBUST */
272

273
#if defined(MDB_OWNERDEAD) && MDB_USE_ROBUST
Hallvard Furuseth's avatar
Hallvard Furuseth committed
274
#define MDB_ROBUST_SUPPORTED	1
275
276
#endif

Howard Chu's avatar
Howard Chu committed
277
#ifdef _WIN32
Howard Chu's avatar
Howard Chu committed
278
#define MDB_USE_HASH	1
279
#define MDB_PIDLOCK	0
Howard Chu's avatar
Howard Chu committed
280
281
#define THREAD_RET	DWORD
#define pthread_t	HANDLE
Howard Chu's avatar
Howard Chu committed
282
#define pthread_mutex_t	HANDLE
Howard Chu's avatar
Howard Chu committed
283
#define pthread_cond_t	HANDLE
284
typedef HANDLE mdb_mutex_t, mdb_mutexref_t;
Howard Chu's avatar
Howard Chu committed
285
286
#define pthread_key_t	DWORD
#define pthread_self()	GetCurrentThreadId()
287
288
#define pthread_key_create(x,y)	\
	((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
Howard Chu's avatar
Howard Chu committed
289
290
#define pthread_key_delete(x)	TlsFree(x)
#define pthread_getspecific(x)	TlsGetValue(x)
291
#define pthread_setspecific(x,y)	(TlsSetValue(x,y) ? 0 : ErrCode())
Howard Chu's avatar
Howard Chu committed
292
293
#define pthread_mutex_unlock(x)	ReleaseMutex(*x)
#define pthread_mutex_lock(x)	WaitForSingleObject(*x, INFINITE)
Howard Chu's avatar
Howard Chu committed
294
#define pthread_cond_signal(x)	SetEvent(*x)
Howard Chu's avatar
Howard Chu committed
295
#define pthread_cond_wait(cond,mutex)	do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
Howard Chu's avatar
Howard Chu committed
296
297
#define THREAD_CREATE(thr,start,arg)	thr=CreateThread(NULL,0,start,arg,0,NULL)
#define THREAD_FINISH(thr)	WaitForSingleObject(thr, INFINITE)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
298
299
#define LOCK_MUTEX0(mutex)		WaitForSingleObject(mutex, INFINITE)
#define UNLOCK_MUTEX(mutex)		ReleaseMutex(mutex)
300
#define mdb_mutex_consistent(mutex)	0
Howard Chu's avatar
Howard Chu committed
301
#define getpid()	GetCurrentProcessId()
302
#define	MDB_FDATASYNC(fd)	(!FlushFileBuffers(fd))
303
#define	MDB_MSYNC(addr,len,flags)	(!FlushViewOfFile(addr,len))
Howard Chu's avatar
Howard Chu committed
304
#define	ErrCode()	GetLastError()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
305
#define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
306
#define	close(fd)	(CloseHandle(fd) ? 0 : -1)
Howard Chu's avatar
Howard Chu committed
307
#define	munmap(ptr,len)	UnmapViewOfFile(ptr)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
308
#ifdef PROCESS_QUERY_LIMITED_INFORMATION
Hallvard Furuseth's avatar
Hallvard Furuseth committed
309
310
311
312
#define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
#else
#define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
#endif
313
#define	Z	"I"
Howard Chu's avatar
Howard Chu committed
314
#else
Howard Chu's avatar
Howard Chu committed
315
316
317
#define THREAD_RET	void *
#define THREAD_CREATE(thr,start,arg)	pthread_create(&thr,NULL,start,arg)
#define THREAD_FINISH(thr)	pthread_join(thr,NULL)
318
#define	Z	"z"			/**< printf format modifier for size_t */
319

320
321
322
	/** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
#define MDB_PIDLOCK			1

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
#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
338

339
340
341
typedef struct mdb_mutex {
	int semid;
	int semnum;
342
	int *locked;
343
} mdb_mutex_t[1], *mdb_mutexref_t;
344

Hallvard Furuseth's avatar
Hallvard Furuseth committed
345
#define LOCK_MUTEX0(mutex)		mdb_sem_wait(mutex)
346
347
348
#define UNLOCK_MUTEX(mutex)		do { \
	struct sembuf sb = { 0, 1, SEM_UNDO }; \
	sb.sem_num = (mutex)->semnum; \
349
	*(mutex)->locked = 0; \
350
351
	semop((mutex)->semid, &sb, 1); \
} while(0)
352
353

static int
354
mdb_sem_wait(mdb_mutexref_t sem)
355
{
356
357
358
359
360
361
362
363
364
365
366
	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;
367
368
}

369
370
#define mdb_mutex_consistent(mutex)	0

Hallvard Furuseth's avatar
Hallvard Furuseth committed
371
#else	/* MDB_USE_POSIX_MUTEX: */
372
373
374
375
376
377
	/** 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
378
	 */
379
380
typedef pthread_mutex_t mdb_mutex_t[1], *mdb_mutexref_t;
	/*	@} */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
381
382
	/** 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
383
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
384
385
#define LOCK_MUTEX0(mutex)	pthread_mutex_lock(mutex)
	/** Unlock the reader or writer mutex.
Howard Chu's avatar
Howard Chu committed
386
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
387
#define UNLOCK_MUTEX(mutex)	pthread_mutex_unlock(mutex)
388
389
390
	/** Mark mutex-protected data as repaired, after death of previous owner.
	 */
#define mdb_mutex_consistent(mutex)	pthread_mutex_consistent(mutex)
391
#endif	/* MDB_USE_POSIX_SEM || MDB_USE_SYSV_SEM */
Howard Chu's avatar
Howard Chu committed
392
393
394

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

397
398
399
400
401
402
	/** 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
403
404
405
406
	/**	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
407
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
408
409
410
411
412

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

416
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
417
#define MNAME_LEN	32
418
#elif defined(MDB_USE_SYSV_SEM)
419
#define MNAME_LEN	(sizeof(int))
420
421
#else
#define MNAME_LEN	(sizeof(pthread_mutex_t))
Howard Chu's avatar
Howard Chu committed
422
423
#endif

424
425
426
427
428
429
#ifdef MDB_USE_SYSV_SEM
#define SYSV_SEM_FLAG	1		/**< SysV sems in lockfile format */
#else
#define SYSV_SEM_FLAG	0
#endif

430
/** @} */
Howard Chu's avatar
Howard Chu committed
431

Hallvard Furuseth's avatar
Hallvard Furuseth committed
432
433
434
435
436
437
438
#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)))
439
static int mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc);
Hallvard Furuseth's avatar
Hallvard Furuseth committed
440
441
442
443
444
#else
#define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
#define mdb_mutex_failed(env, mutex, rc) (rc)
#endif

445
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
446
447
448
449
450
451
/**	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
452
453
454
455
456
457
 * preferably set some compiler flag to get the definition.
 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
 */
#ifndef MDB_DSYNC
# define MDB_DSYNC	O_DSYNC
#endif
458
459
460
461
462
463
464
#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
465
466
467
468
469
470
471
472
473
474
475
476
#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
477
478
#endif

Howard Chu's avatar
Howard Chu committed
479
480
481
482
483
484
485
486
	/** 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.
	 */
487
typedef MDB_ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
488

489
490
491
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
492
typedef MDB_ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
493

Howard Chu's avatar
Howard Chu committed
494
495
496
/** @defgroup debug	Debug Macros
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
497
#ifndef MDB_DEBUG
498
	/**	Enable debug output.  Needs variable argument macros (a C99 feature).
Howard Chu's avatar
Howard Chu committed
499
500
501
	 *	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
502
#define MDB_DEBUG 0
503
#endif
Howard Chu's avatar
Howard Chu committed
504

505
#if MDB_DEBUG
506
static int mdb_debug;
507
static txnid_t mdb_debug_start;
508

509
510
511
512
513
	/**	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
514
	fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
Howard Chu's avatar
Howard Chu committed
515
#else
516
# define DPRINTF(args)	((void) 0)
Howard Chu's avatar
Howard Chu committed
517
#endif
Howard Chu's avatar
Howard Chu committed
518
519
520
	/**	Print a debug string.
	 *	The string is printed literally, with no format processing.
	 */
521
#define DPUTS(arg)	DPRINTF(("%s", arg))
522
523
524
	/** 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
525
/** @} */
Howard Chu's avatar
Howard Chu committed
526

527
528
	/**	@brief The maximum size of a database page.
	 *
Hallvard Furuseth's avatar
Hallvard Furuseth committed
529
530
	 *	It is 32k or 64k, since value-PAGEBASE must fit in
	 *	#MDB_page.%mp_upper.
531
532
533
534
	 *
	 *	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
535
536
537
538
539
540
541
542
	 *
	 *	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
543
#define MAX_PAGESIZE	 (PAGEBASE ? 0x10000 : 0x8000)
Howard Chu's avatar
Howard Chu committed
544
545
546
547
548
549
550
551
552
553
554
555
556

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

Howard Chu's avatar
Howard Chu committed
559
	/**	A stamp that identifies a file as an LMDB file.
Howard Chu's avatar
Howard Chu committed
560
561
562
	 *	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
563
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
564

565
	/**	The version number for a database's datafile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
566
#define MDB_DATA_VERSION	 ((MDB_DEVEL) ? 999 : 1)
567
	/**	The version number for a database's lockfile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
568
#define MDB_LOCK_VERSION	 ((MDB_DEVEL) ? 999 : 1)
Howard Chu's avatar
Howard Chu committed
569

570
	/**	@brief The max size of a key we can write, or 0 for computed max.
571
	 *
572
573
574
575
576
577
578
579
580
	 *	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.
581
	 *
582
583
584
	 *	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
585
	 */
586
#ifndef MDB_MAXKEYSIZE
587
#define MDB_MAXKEYSIZE	 ((MDB_DEVEL) ? 0 : 511)
588
589
590
591
592
593
594
#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)
595
#endif
Howard Chu's avatar
Howard Chu committed
596

597
598
599
600
601
602
	/**	@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
603
#if MDB_DEBUG
604
605
606
607
	/**	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
608
609
610
611
	/**	A key buffer.
	 *	@ingroup debug
	 *	This is used for printing a hex dump of a key's contents.
	 */
612
#define DKBUF	char kbuf[DKBUF_MAXKEYSIZE*2+1]
Howard Chu's avatar
Howard Chu committed
613
614
615
616
	/**	Display a key in hex.
	 *	@ingroup debug
	 *	Invoke a function to display a key in hex.
	 */
Howard Chu's avatar
Howard Chu committed
617
618
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
Howard Chu's avatar
Howard Chu committed
619
#define	DKBUF
Howard Chu's avatar
Howard Chu committed
620
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
621
#endif
Howard Chu's avatar
Howard Chu committed
622

Howard Chu's avatar
Howard Chu committed
623
624
625
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
626
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
627

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

631
632
633
	/** 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
634
635
636
637
	/**	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
638
639
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
640
641
642
643
	/**	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
644
645
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
646
647
648
649
650
651
652
/**	@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
653
654
 *	If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
 *
Howard Chu's avatar
Howard Chu committed
655
656
 *	No reader table is used if the database is on a read-only filesystem, or
 *	if #MDB_NOLOCK is set.
657
 *
Howard Chu's avatar
Howard Chu committed
658
659
660
 *	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
661
662
 *	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
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 *	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
697
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
698
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
699
700
#endif

Howard Chu's avatar
Howard Chu committed
701
702
703
704
705
706
707
708
	/**	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
709
typedef struct MDB_rxbody {
710
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
711
712
713
714
715
716
	 *	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.
	 */
717
	volatile txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
718
	/** The process ID of the process owning this reader txn. */
719
	volatile MDB_PID_T	mrb_pid;
Howard Chu's avatar
Howard Chu committed
720
	/** The thread ID of the thread owning this txn. */
721
	volatile MDB_THR_T	mrb_tid;
Howard Chu's avatar
Howard Chu committed
722
723
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
724
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
725
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
726
727
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
728
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
729
730
731
#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
732
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
733
734
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
735
736
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
737
738
739
740
741
742
743
	/** 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
744
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
745
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
746
747
748
749
	 *	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
750
	 */
Howard Chu's avatar
Howard Chu committed
751
typedef struct MDB_txbody {
Howard Chu's avatar
Howard Chu committed
752
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
753
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
754
	uint32_t	mtb_magic;
755
756
		/** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
	uint32_t	mtb_format;
757
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
758
	char	mtb_rmname[MNAME_LEN];
759
760
#elif defined(MDB_USE_SYSV_SEM)
	int 	mtb_semid;
761
	int		mtb_rlocked;
Howard Chu's avatar
Howard Chu committed
762
#else
Howard Chu's avatar
Howard Chu committed
763
		/** Mutex protecting access to this table.
764
		 *	This is the reader table lock used with LOCK_MUTEX().
Howard Chu's avatar
Howard Chu committed
765
		 */
766
	mdb_mutex_t	mtb_rmutex;
Howard Chu's avatar
Howard Chu committed
767
#endif
Howard Chu's avatar
Howard Chu committed
768
769
770
771
		/**	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.
		 */
772
	volatile txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
773
774
775
776
		/** 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.
		 */
777
	volatile unsigned	mtb_numreaders;
Howard Chu's avatar
Howard Chu committed
778
779
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
780
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
781
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
782
783
784
	union {
		MDB_txbody mtb;
#define mti_magic	mt1.mtb.mtb_magic
785
#define mti_format	mt1.mtb.mtb_format
Hallvard Furuseth's avatar
Hallvard Furuseth committed
786
#define mti_rmutex	mt1.mtb.mtb_rmutex
Howard Chu's avatar
Howard Chu committed
787
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
788
789
#define mti_txnid	mt1.mtb.mtb_txnid
#define mti_numreaders	mt1.mtb.mtb_numreaders
790
791
#ifdef MDB_USE_SYSV_SEM
#define	mti_semid	mt1.mtb.mtb_semid
792
793
794
795
#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
796
	union {
797
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
798
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
799
#define	mti_wmname	mt2.mt2_wmname
800
801
802
#elif defined MDB_USE_SYSV_SEM
		int mt2_wlocked;
#define mti_wlocked	mt2.mt2_wlocked
Howard Chu's avatar
Howard Chu committed
803
#else
804
		mdb_mutex_t	mt2_wmutex;
Howard Chu's avatar
Howard Chu committed
805
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
806
#endif
807
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
808
809
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
810
} MDB_txninfo;
811
812
813
814
815
816

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

Howard Chu's avatar
Howard Chu committed
821
/** Common header for all page types.
Howard Chu's avatar
Howard Chu committed
822
 * Overflow records occupy a number of contiguous pages with no
Howard Chu's avatar
Howard Chu committed
823
824
 * headers on any page after the first.
 */
Howard Chu's avatar
Howard Chu committed
825
typedef struct MDB_page {
826
827
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
828
	union {
829
		pgno_t		p_pgno;	/**< page number */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
830
		struct MDB_page *p_next; /**< for in-memory list of freed pages */
831
	} mp_p;
Howard Chu's avatar
Howard Chu committed
832
	uint16_t	mp_pad;
Howard Chu's avatar
Howard Chu committed
833
834
835
836
837
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
838
839
840
841
#define	P_BRANCH	 0x01		/**< branch page */
#define	P_LEAF		 0x02		/**< leaf page */
#define	P_OVERFLOW	 0x04		/**< overflow page */
#define	P_META		 0x08		/**< meta page */
842
#define	P_DIRTY		 0x10		/**< dirty page, also set for #P_SUBP pages */
Howard Chu's avatar
Howard Chu committed
843
#define	P_LEAF2		 0x20		/**< for #MDB_DUPFIXED records */
Howard Chu's avatar
Howard Chu committed
844
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
845
#define	P_LOOSE		 0x4000		/**< page was dirtied then freed, can be reused */
Howard Chu's avatar
Howard Chu committed
846
#define	P_KEEP		 0x8000		/**< leave this page alone during spill */
Howard Chu's avatar
Howard Chu committed
847
/** @} */
Howard Chu's avatar
Howard Chu committed
848
	uint16_t	mp_flags;		/**< @ref mdb_page */
849
850
851
#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
852
	union {
Howard Chu's avatar
Howard Chu committed
853
		struct {
854
855
856
857
858
			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
859
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
860
861
} MDB_page;

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

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

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

Howard Chu's avatar
Howard Chu committed
871
	/** Number of nodes on a page */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
872
#define NUMKEYS(p)	 (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
Howard Chu's avatar
Howard Chu committed
873
874

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
878
879
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
880
881
882
883
884
885
	/** 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
886
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
887
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
888
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
889
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
890
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
891
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
892
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
893
894
	/** 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
895

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

899
	/** Link in #MDB_txn.%mt_loose_pgs list */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
900
#define NEXT_LOOSE_PAGE(p)		(*(MDB_page **)((p) + 2))
901

Howard Chu's avatar
Howard Chu committed
902
	/** Header for a single key/data pair within a page.
903
904
	 * 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
905
906
907
908
	 */
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
909
	 * is also used for pgno. (Branch nodes have no flags).
Howard Chu's avatar
Howard Chu committed
910
	 * They are in host byte order in case that lets some
911
	 * accesses be optimized into a 32-bit word access.
Howard Chu's avatar
Howard Chu committed
912
	 */
913
914
915
916
917
#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
918
919
920
921
922
/** @defgroup mdb_node Node Flags
 *	@ingroup internal
 *	Flags for node headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
923
924
925
#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
926
927

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

Howard Chu's avatar
Howard Chu committed
930
931
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
932
933
934
935
936
937
938
	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)

939
940
941
	/** 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
942
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
943
944
945
946
	 *	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
947
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
948
949
950
951
	 *	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
952
	/** Address of node \b i in page \b p */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
953
#define NODEPTR(p, i)	 ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
Howard Chu's avatar
Howard Chu committed
954
955
956
957
958
959
960
961

	/** 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 */
962
963
964
#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
965
966
967
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
968
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
969
970
971
972
973
974
975
976
977

	/** 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
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
	/** Copy a page number from src to dst */
#ifdef MISALIGNED_OK
#define COPY_PGNO(dst,src)	dst = src
#else
#if SIZE_MAX > 4294967295UL
#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
1002
1003
1004
1005
1006
1007
	/** 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
1008
1009
1010
1011
1012
1013
	/** 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
1014
1015

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
1016
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
1017
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
1018
	uint16_t	md_flags;	/**< @ref mdb_dbi_open */
Howard Chu's avatar
Howard Chu committed
1019
	uint16_t	md_depth;	/**< depth of this tree */
1020
1021
1022
1023
	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 */
	size_t		md_entries;		/**< number of data items */
Howard Chu's avatar
Howard Chu committed
1024
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
1025
1026
} MDB_db;

1027
	/** mdb_dbi_open flags */
1028
1029
#define MDB_VALID	0x8000		/**< DB handle is valid, for me_dbflags */
#define PERSISTENT_FLAGS	(0xffff & ~(MDB_VALID))
1030
1031
1032
#define VALID_FLAGS	(MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
	MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)

Howard Chu's avatar
Howard Chu committed
1033
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
1034
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
1035
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
1036
#define	MAIN_DBI	1
1037
1038
1039
1040
1041
	/** 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
1042

1043
1044
1045
1046
	/** 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
1047
typedef struct MDB_meta {
Howard Chu's avatar
Howard Chu committed
1048
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
1049
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
1050
	uint32_t	mm_magic;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1051
		/** Version number of this file. Must be set to #MDB_DATA_VERSION. */
Howard Chu's avatar
Howard Chu committed
1052
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
1053
1054
	void		*mm_address;		/**< address for fixed mapping */
	size_t		mm_mapsize;			/**< size of mmap region */
1055
	MDB_db		mm_dbs[CORE_DBS];	/**< first is free space, 2nd is main db */
Howard Chu's avatar
Howard Chu committed
1056
	/** The size of pages used in this DB */
1057
#define	mm_psize	mm_dbs[FREE_DBI].md_pad
Howard Chu's avatar
Howard Chu committed
1058
	/** Any persistent environment flags. @ref mdb_env */
1059
#define	mm_flags	mm_dbs[FREE_DBI].md_flags
Howard Chu's avatar
Howard Chu committed
1060
	pgno_t		mm_last_pg;			/**< last used page in file */
1061
	volatile txnid_t	mm_txnid;	/**< txnid that committed this page */
Howard Chu's avatar
Howard Chu committed
1062
1063
} MDB_meta;

1064
	/** Buffer for a stack-allocated meta page.
1065
1066
1067
1068
	 *	The members define size and alignment, and silence type
	 *	aliasing warnings.  They are not used directly; that could
	 *	mean incorrectly using several union members in parallel.
	 */
1069
typedef union MDB_metabuf {
1070
1071
1072
1073
1074
	MDB_page	mb_page;
	struct {
		char		mm_pad[PAGEHDRSZ];
		MDB_meta	mm_meta;
	} mb_metabuf;
1075
} MDB_metabuf;
1076

Howard Chu's avatar
Howard Chu committed
1077
1078
1079
1080
1081
1082
1083
1084
1085
	/** Auxiliary DB info.
	 *	The information here is mostly static/read-only. There is
	 *	only a single copy of this record in the environment.
	 */
typedef struct MDB_dbx {
	MDB_val		md_name;		/**< name of the database */
	MDB_cmp_func	*md_cmp;	/**< function for comparing keys */
	MDB_cmp_func	*md_dcmp;	/**< function for comparing data items */
	MDB_rel_func	*md_rel;	/**< user relocate function */
1086
	void		*md_relctx;		/**< user-provided context for md_rel */
Howard Chu's avatar
Howard Chu committed
1087
} MDB_dbx;
Howard Chu's avatar
Howard Chu committed
1088

Howard Chu's avatar
Howard Chu committed
1089
1090
1091
1092
	/** A database transaction.
	 *	Every operation requires a transaction handle.
	 */
struct MDB_txn {
1093
	MDB_txn		*mt_parent;		/**< parent of a nested txn */
1094
1095
	/** Nested txn under this txn, set together with flag #MDB_TXN_HAS_CHILD */
	MDB_txn		*mt_child;
Howard Chu's avatar
Howard Chu committed
1096
1097
1098
1099
1100
	pgno_t		mt_next_pgno;	/**< next unallocated page */
	/** The ID of this transaction. IDs are integers incrementing from 1.
	 *	Only committed write transactions increment the ID. If a transaction
	 *	aborts, the ID may be re-used by the next writer.
	 */
1101
	txnid_t		mt_txnid;