mdb.c 258 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
99
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
100

Howard Chu's avatar
Howard Chu committed
101
#if defined(__sun) || defined(ANDROID)
102
103
104
105
106
/* Most platforms have posix_memalign, older may only have memalign */
#define HAVE_MEMALIGN	1
#include <malloc.h>
#endif

107
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
108
#include <netinet/in.h>
109
110
111
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

112
#if defined(__APPLE__) || defined (BSD)
113
114
115
116
# define MDB_USE_POSIX_SEM	1
# define MDB_FDATASYNC		fsync
#elif defined(ANDROID)
# define MDB_FDATASYNC		fsync
117
118
#endif

119
120
#ifndef _WIN32
#include <pthread.h>
121
#ifdef MDB_USE_POSIX_SEM
122
# define MDB_USE_HASH		1
Howard Chu's avatar
Howard Chu committed
123
124
125
126
#include <semaphore.h>
#endif
#endif

127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
#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
142
#ifndef BYTE_ORDER
Howard Chu's avatar
Howard Chu committed
143
144
145
146
147
148
149
150
151
152
153
154
# 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
155
#endif
Howard Chu's avatar
Howard Chu committed
156

Howard Chu's avatar
Howard Chu committed
157
158
159
160
161
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
162
163
#endif

Howard Chu's avatar
Howard Chu committed
164
#if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
Howard Chu's avatar
Howard Chu committed
165
166
167
#define MISALIGNED_OK	1
#endif

Howard Chu's avatar
Howard Chu committed
168
#include "lmdb.h"
169
170
#include "midl.h"

Howard Chu's avatar
Howard Chu committed
171
172
#if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
# error "Unknown or unsupported endianness (BYTE_ORDER)"
173
174
175
176
#elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
# error "Two's complement, reasonably sized integer types, please"
#endif

177
178
#ifdef __GNUC__
/** Put infrequently used env functions in separate section */
Howard Chu's avatar
Howard Chu committed
179
180
181
182
183
# ifdef __APPLE__
#  define	ESECT	__attribute__ ((section("__TEXT,text_env")))
# else
#  define	ESECT	__attribute__ ((section("text_env")))
# endif
184
185
186
187
#else
#define ESECT
#endif

Howard Chu's avatar
Howard Chu committed
188
/** @defgroup internal	LMDB Internals
189
190
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
191
/** @defgroup compat	Compatibility Macros
Howard Chu's avatar
Howard Chu committed
192
193
194
195
 *	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.
196
197
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
198

Hallvard Furuseth's avatar
Hallvard Furuseth committed
199
	/** Features under development */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
200
201
202
203
#ifndef MDB_DEVEL
#define MDB_DEVEL 0
#endif

Hallvard Furuseth's avatar
Hallvard Furuseth committed
204
205
206
207
208
209
210
211
212
213
	/** 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

Howard Chu's avatar
Howard Chu committed
214
#ifdef _WIN32
Howard Chu's avatar
Howard Chu committed
215
#define MDB_USE_HASH	1
216
#define MDB_PIDLOCK	0
Howard Chu's avatar
Howard Chu committed
217
218
#define THREAD_RET	DWORD
#define pthread_t	HANDLE
Howard Chu's avatar
Howard Chu committed
219
#define pthread_mutex_t	HANDLE
Howard Chu's avatar
Howard Chu committed
220
#define pthread_cond_t	HANDLE
Howard Chu's avatar
Howard Chu committed
221
222
#define pthread_key_t	DWORD
#define pthread_self()	GetCurrentThreadId()
223
224
#define pthread_key_create(x,y)	\
	((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
Howard Chu's avatar
Howard Chu committed
225
226
#define pthread_key_delete(x)	TlsFree(x)
#define pthread_getspecific(x)	TlsGetValue(x)
227
#define pthread_setspecific(x,y)	(TlsSetValue(x,y) ? 0 : ErrCode())
Howard Chu's avatar
Howard Chu committed
228
229
#define pthread_mutex_unlock(x)	ReleaseMutex(*x)
#define pthread_mutex_lock(x)	WaitForSingleObject(*x, INFINITE)
Howard Chu's avatar
Howard Chu committed
230
#define pthread_cond_signal(x)	SetEvent(*x)
Howard Chu's avatar
Howard Chu committed
231
#define pthread_cond_wait(cond,mutex)	do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
Howard Chu's avatar
Howard Chu committed
232
233
#define THREAD_CREATE(thr,start,arg)	thr=CreateThread(NULL,0,start,arg,0,NULL)
#define THREAD_FINISH(thr)	WaitForSingleObject(thr, INFINITE)
Howard Chu's avatar
Howard Chu committed
234
235
236
237
#define LOCK_MUTEX_R(env)	pthread_mutex_lock(&(env)->me_rmutex)
#define UNLOCK_MUTEX_R(env)	pthread_mutex_unlock(&(env)->me_rmutex)
#define LOCK_MUTEX_W(env)	pthread_mutex_lock(&(env)->me_wmutex)
#define UNLOCK_MUTEX_W(env)	pthread_mutex_unlock(&(env)->me_wmutex)
Howard Chu's avatar
Howard Chu committed
238
#define getpid()	GetCurrentProcessId()
239
#define	MDB_FDATASYNC(fd)	(!FlushFileBuffers(fd))
240
#define	MDB_MSYNC(addr,len,flags)	(!FlushViewOfFile(addr,len))
Howard Chu's avatar
Howard Chu committed
241
#define	ErrCode()	GetLastError()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
242
#define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
243
#define	close(fd)	(CloseHandle(fd) ? 0 : -1)
Howard Chu's avatar
Howard Chu committed
244
#define	munmap(ptr,len)	UnmapViewOfFile(ptr)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
245
#ifdef PROCESS_QUERY_LIMITED_INFORMATION
Hallvard Furuseth's avatar
Hallvard Furuseth committed
246
247
248
249
#define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
#else
#define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
#endif
250
#define	Z	"I"
Howard Chu's avatar
Howard Chu committed
251
#else
Howard Chu's avatar
Howard Chu committed
252
253
254
#define THREAD_RET	void *
#define THREAD_CREATE(thr,start,arg)	pthread_create(&thr,NULL,start,arg)
#define THREAD_FINISH(thr)	pthread_join(thr,NULL)
255
#define	Z	"z"			/**< printf format modifier for size_t */
256

257
258
259
	/** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
#define MDB_PIDLOCK			1

260
#ifdef MDB_USE_POSIX_SEM
261
262

#define LOCK_MUTEX_R(env)	mdb_sem_wait((env)->me_rmutex)
Howard Chu's avatar
Howard Chu committed
263
#define UNLOCK_MUTEX_R(env)	sem_post((env)->me_rmutex)
264
#define LOCK_MUTEX_W(env)	mdb_sem_wait((env)->me_wmutex)
Howard Chu's avatar
Howard Chu committed
265
#define UNLOCK_MUTEX_W(env)	sem_post((env)->me_wmutex)
266
267
268
269
270
271
272
273
274

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

Howard Chu's avatar
Howard Chu committed
275
#else
Howard Chu's avatar
Howard Chu committed
276
277
	/** Lock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
278
#define LOCK_MUTEX_R(env)	pthread_mutex_lock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
279
280
	/** Unlock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
281
#define UNLOCK_MUTEX_R(env)	pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
282
283
284
285
286

	/** Lock the writer mutex.
	 *	Only a single write transaction is allowed at a time. Other writers
	 *	will block waiting for this mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
287
#define LOCK_MUTEX_W(env)	pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
Howard Chu's avatar
Howard Chu committed
288
289
	/** Unlock the writer mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
290
#define UNLOCK_MUTEX_W(env)	pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
291
#endif	/* MDB_USE_POSIX_SEM */
Howard Chu's avatar
Howard Chu committed
292
293
294

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

297
298
299
300
301
302
	/** 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
303
304
305
306
	/**	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
307
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
308
309
310
311
312

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

316
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
317
#define MNAME_LEN	32
318
319
#else
#define MNAME_LEN	(sizeof(pthread_mutex_t))
Howard Chu's avatar
Howard Chu committed
320
321
#endif

322
/** @} */
Howard Chu's avatar
Howard Chu committed
323

324
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
325
326
327
328
329
330
/**	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
331
332
333
334
335
336
 * 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
337
338
339
340
341
342
343
#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
344
345
346
347
348
349
350
351
352
353
354
355
#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
356
357
#endif

Howard Chu's avatar
Howard Chu committed
358
359
360
361
362
363
364
365
	/** 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.
	 */
366
typedef MDB_ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
367

368
369
370
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
371
typedef MDB_ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
372

Howard Chu's avatar
Howard Chu committed
373
374
375
/** @defgroup debug	Debug Macros
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
376
#ifndef MDB_DEBUG
377
	/**	Enable debug output.  Needs variable argument macros (a C99 feature).
Howard Chu's avatar
Howard Chu committed
378
379
380
	 *	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
381
#define MDB_DEBUG 0
382
#endif
Howard Chu's avatar
Howard Chu committed
383

384
#if MDB_DEBUG
385
static int mdb_debug;
386
static txnid_t mdb_debug_start;
387

388
389
390
391
392
	/**	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
393
	fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
Howard Chu's avatar
Howard Chu committed
394
#else
395
# define DPRINTF(args)	((void) 0)
Howard Chu's avatar
Howard Chu committed
396
#endif
Howard Chu's avatar
Howard Chu committed
397
398
399
	/**	Print a debug string.
	 *	The string is printed literally, with no format processing.
	 */
400
#define DPUTS(arg)	DPRINTF(("%s", arg))
401
402
403
	/** 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
404
/** @} */
Howard Chu's avatar
Howard Chu committed
405

406
407
	/**	@brief The maximum size of a database page.
	 *
Hallvard Furuseth's avatar
Hallvard Furuseth committed
408
409
	 *	It is 32k or 64k, since value-PAGEBASE must fit in
	 *	#MDB_page.%mp_upper.
410
411
412
413
	 *
	 *	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
414
415
416
417
418
419
420
421
	 *
	 *	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
422
#define MAX_PAGESIZE	 (PAGEBASE ? 0x10000 : 0x8000)
Howard Chu's avatar
Howard Chu committed
423
424
425
426
427
428
429
430
431
432
433
434
435

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

Howard Chu's avatar
Howard Chu committed
438
	/**	A stamp that identifies a file as an LMDB file.
Howard Chu's avatar
Howard Chu committed
439
440
441
	 *	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
442
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
443

444
	/**	The version number for a database's datafile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
445
#define MDB_DATA_VERSION	 ((MDB_DEVEL) ? 999 : 1)
446
447
	/**	The version number for a database's lockfile format. */
#define MDB_LOCK_VERSION	 1
Howard Chu's avatar
Howard Chu committed
448

449
	/**	@brief The max size of a key we can write, or 0 for dynamic max.
450
	 *
451
452
453
	 *	Define this as 0 to compute the max from the page size.  511
	 *	is default for backwards compat: liblmdb <= 0.9.10 can break
	 *	when modifying a DB with keys/dupsort data bigger than its max.
454
	 *	#MDB_DEVEL sets the default to 0.
455
	 *
456
457
458
	 *	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
459
	 */
460
#ifndef MDB_MAXKEYSIZE
461
#define MDB_MAXKEYSIZE	 ((MDB_DEVEL) ? 0 : 511)
462
463
464
465
466
467
468
#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)
469
#endif
Howard Chu's avatar
Howard Chu committed
470

471
472
473
474
475
476
	/**	@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
477
#if MDB_DEBUG
478
479
480
481
	/**	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
482
483
484
485
	/**	A key buffer.
	 *	@ingroup debug
	 *	This is used for printing a hex dump of a key's contents.
	 */
486
#define DKBUF	char kbuf[DKBUF_MAXKEYSIZE*2+1]
Howard Chu's avatar
Howard Chu committed
487
488
489
490
	/**	Display a key in hex.
	 *	@ingroup debug
	 *	Invoke a function to display a key in hex.
	 */
Howard Chu's avatar
Howard Chu committed
491
492
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
Howard Chu's avatar
Howard Chu committed
493
#define	DKBUF
Howard Chu's avatar
Howard Chu committed
494
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
495
#endif
Howard Chu's avatar
Howard Chu committed
496

Howard Chu's avatar
Howard Chu committed
497
498
499
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
500
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
501

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

505
506
507
	/** 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
508
509
510
511
	/**	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
512
513
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
514
515
516
517
	/**	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
518
519
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
520
521
522
523
524
525
526
/**	@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
527
528
 *	If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
 *
Howard Chu's avatar
Howard Chu committed
529
530
 *	No reader table is used if the database is on a read-only filesystem, or
 *	if #MDB_NOLOCK is set.
531
 *
Howard Chu's avatar
Howard Chu committed
532
533
534
 *	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
535
536
 *	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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 *	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
571
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
572
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
573
574
#endif

Howard Chu's avatar
Howard Chu committed
575
576
577
578
579
580
581
582
	/**	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
583
typedef struct MDB_rxbody {
584
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
585
586
587
588
589
590
	 *	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.
	 */
Leonid Yuriev's avatar
Leonid Yuriev committed
591
	volatile txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
592
	/** The process ID of the process owning this reader txn. */
Leonid Yuriev's avatar
Leonid Yuriev committed
593
	volatile MDB_PID_T	mrb_pid;
Howard Chu's avatar
Howard Chu committed
594
	/** The thread ID of the thread owning this txn. */
Leonid Yuriev's avatar
Leonid Yuriev committed
595
	volatile MDB_THR_T	mrb_tid;
Howard Chu's avatar
Howard Chu committed
596
597
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
598
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
599
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
600
601
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
602
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
603
604
605
#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
606
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
607
608
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
609
610
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
611
612
613
614
615
616
617
	/** 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
618
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
619
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
620
621
622
623
	 *	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
624
	 */
Howard Chu's avatar
Howard Chu committed
625
typedef struct MDB_txbody {
Howard Chu's avatar
Howard Chu committed
626
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
627
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
628
	uint32_t	mtb_magic;
629
630
		/** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
	uint32_t	mtb_format;
631
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
632
	char	mtb_rmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
633
#else
Howard Chu's avatar
Howard Chu committed
634
635
636
		/** Mutex protecting access to this table.
		 *	This is the reader lock that #LOCK_MUTEX_R acquires.
		 */
Howard Chu's avatar
Howard Chu committed
637
	pthread_mutex_t	mtb_mutex;
Howard Chu's avatar
Howard Chu committed
638
#endif
Howard Chu's avatar
Howard Chu committed
639
640
641
642
		/**	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.
		 */
Leonid Yuriev's avatar
Leonid Yuriev committed
643
	volatile txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
644
645
646
647
		/** 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.
		 */
Leonid Yuriev's avatar
Leonid Yuriev committed
648
	volatile unsigned	mtb_numreaders;
Howard Chu's avatar
Howard Chu committed
649
650
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
651
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
652
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
653
654
655
	union {
		MDB_txbody mtb;
#define mti_magic	mt1.mtb.mtb_magic
656
#define mti_format	mt1.mtb.mtb_format
Howard Chu's avatar
Howard Chu committed
657
#define mti_mutex	mt1.mtb.mtb_mutex
Howard Chu's avatar
Howard Chu committed
658
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
659
660
661
662
663
#define mti_txnid	mt1.mtb.mtb_txnid
#define mti_numreaders	mt1.mtb.mtb_numreaders
		char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mt1;
	union {
664
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
665
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
666
667
#define	mti_wmname	mt2.mt2_wmname
#else
Howard Chu's avatar
Howard Chu committed
668
669
		pthread_mutex_t	mt2_wmutex;
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
670
#endif
671
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
672
673
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
674
} MDB_txninfo;
675
676
677
678
679
680
681

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

Howard Chu's avatar
Howard Chu committed
684
/** Common header for all page types.
Howard Chu's avatar
Howard Chu committed
685
 * Overflow records occupy a number of contiguous pages with no
Howard Chu's avatar
Howard Chu committed
686
687
 * headers on any page after the first.
 */
Howard Chu's avatar
Howard Chu committed
688
typedef struct MDB_page {
689
690
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
691
	union {
692
		pgno_t		p_pgno;	/**< page number */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
693
		struct MDB_page *p_next; /**< for in-memory list of freed pages */
694
	} mp_p;
Howard Chu's avatar
Howard Chu committed
695
	uint16_t	mp_pad;
Howard Chu's avatar
Howard Chu committed
696
697
698
699
700
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
701
702
703
704
#define	P_BRANCH	 0x01		/**< branch page */
#define	P_LEAF		 0x02		/**< leaf page */
#define	P_OVERFLOW	 0x04		/**< overflow page */
#define	P_META		 0x08		/**< meta page */
705
#define	P_DIRTY		 0x10		/**< dirty page, also set for #P_SUBP pages */
Howard Chu's avatar
Howard Chu committed
706
#define	P_LEAF2		 0x20		/**< for #MDB_DUPFIXED records */
Howard Chu's avatar
Howard Chu committed
707
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
708
#define	P_LOOSE		 0x4000		/**< page was dirtied then freed, can be reused */
Howard Chu's avatar
Howard Chu committed
709
#define	P_KEEP		 0x8000		/**< leave this page alone during spill */
Howard Chu's avatar
Howard Chu committed
710
/** @} */
Howard Chu's avatar
Howard Chu committed
711
	uint16_t	mp_flags;		/**< @ref mdb_page */
712
713
714
#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
715
	union {
Howard Chu's avatar
Howard Chu committed
716
		struct {
717
718
719
720
721
			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
722
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
723
724
} MDB_page;

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

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

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

Howard Chu's avatar
Howard Chu committed
734
	/** Number of nodes on a page */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
735
#define NUMKEYS(p)	 (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
Howard Chu's avatar
Howard Chu committed
736
737

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
741
742
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
743
744
745
746
747
748
	/** 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
749
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
750
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
751
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
752
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
753
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
754
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
755
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
756
757
	/** 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
758

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

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

Howard Chu's avatar
Howard Chu committed
765
	/** Header for a single key/data pair within a page.
766
767
	 * 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
768
769
770
771
	 */
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
772
	 * is also used for pgno. (Branch nodes have no flags).
Howard Chu's avatar
Howard Chu committed
773
	 * They are in host byte order in case that lets some
774
	 * accesses be optimized into a 32-bit word access.
Howard Chu's avatar
Howard Chu committed
775
	 */
776
777
778
779
780
#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
781
782
783
784
785
/** @defgroup mdb_node Node Flags
 *	@ingroup internal
 *	Flags for node headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
786
787
788
#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
789
790

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

Howard Chu's avatar
Howard Chu committed
793
794
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
795
796
797
798
799
800
801
	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)

802
803
804
	/** 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
805
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
806
807
808
809
	 *	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
810
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
811
812
813
814
	 *	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
815
	/** Address of node \b i in page \b p */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
816
#define NODEPTR(p, i)	 ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
Howard Chu's avatar
Howard Chu committed
817
818
819
820
821
822
823
824

	/** 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 */
825
826
827
#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
828
829
830
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
831
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
832
833
834
835
836
837
838
839
840

	/** 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
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
	/** 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
865
866
867
868
869
870
	/** 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
871
872
873
874
875
876
	/** 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
877
878

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
879
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
880
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
881
	uint16_t	md_flags;	/**< @ref mdb_dbi_open */
Howard Chu's avatar
Howard Chu committed
882
	uint16_t	md_depth;	/**< depth of this tree */
883
884
885
886
	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
887
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
888
889
} MDB_db;

890
	/** mdb_dbi_open flags */
891
892
#define MDB_VALID	0x8000		/**< DB handle is valid, for me_dbflags */
#define PERSISTENT_FLAGS	(0xffff & ~(MDB_VALID))
893
894
895
#define VALID_FLAGS	(MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
	MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)

Howard Chu's avatar
Howard Chu committed
896
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
897
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
898
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
899
900
#define	MAIN_DBI	1

901
902
903
904
	/** 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
905
typedef struct MDB_meta {
Howard Chu's avatar
Howard Chu committed
906
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
907
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
908
	uint32_t	mm_magic;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
909
		/** Version number of this file. Must be set to #MDB_DATA_VERSION. */
Howard Chu's avatar
Howard Chu committed
910
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
911
912
913
914
	void		*mm_address;		/**< address for fixed mapping */
	size_t		mm_mapsize;			/**< size of mmap region */
	MDB_db		mm_dbs[2];			/**< first is free space, 2nd is main db */
	/** The size of pages used in this DB */
Howard Chu's avatar
Howard Chu committed
915
#define	mm_psize	mm_dbs[0].md_pad
Howard Chu's avatar
Howard Chu committed
916
	/** Any persistent environment flags. @ref mdb_env */
Howard Chu's avatar
Howard Chu committed
917
#define	mm_flags	mm_dbs[0].md_flags
Howard Chu's avatar
Howard Chu committed
918
	pgno_t		mm_last_pg;			/**< last used page in file */
Leonid Yuriev's avatar
Leonid Yuriev committed
919
	volatile txnid_t	mm_txnid;	/**< txnid that committed this page */
Howard Chu's avatar
Howard Chu committed
920
921
} MDB_meta;

922
	/** Buffer for a stack-allocated meta page.
923
924
925
926
	 *	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.
	 */
927
typedef union MDB_metabuf {
928
929
930
931
932
	MDB_page	mb_page;
	struct {
		char		mm_pad[PAGEHDRSZ];
		MDB_meta	mm_meta;
	} mb_metabuf;
933
} MDB_metabuf;
934

Howard Chu's avatar
Howard Chu committed
935
936
937
938
939
940
941
942
943
	/** 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 */
944
	void		*md_relctx;		/**< user-provided context for md_rel */
Howard Chu's avatar
Howard Chu committed
945
} MDB_dbx;
Howard Chu's avatar
Howard Chu committed
946

Howard Chu's avatar
Howard Chu committed
947
948
949
950
	/** A database transaction.
	 *	Every operation requires a transaction handle.
	 */
struct MDB_txn {
951
952
	MDB_txn		*mt_parent;		/**< parent of a nested txn */
	MDB_txn		*mt_child;		/**< nested txn under this txn */
Howard Chu's avatar
Howard Chu committed
953
954
955
956
957
	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.
	 */
958
	txnid_t		mt_txnid;
Howard Chu's avatar
Howard Chu committed
959
960
961
	MDB_env		*mt_env;		/**< the DB environment */
	/** The list of pages that became unused during this transaction.
	 */
962
	MDB_IDL		mt_free_pgs;
Howard Chu's avatar
Howard Chu committed
963
	/** The list of loose pages that became unused and may be reused
964
	 *	in this transaction, linked through #NEXT_LOOSE_PAGE(page).
Howard Chu's avatar
Howard Chu committed
965
966
	 */
	MDB_page	*mt_loose_pgs;
967
968
	/* #Number of loose pages (#mt_loose_pgs) */
	int			mt_loose_count;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
969
	/** The sorted list of dirty pages we temporarily wrote to disk
970
971
	 *	because the dirty list was full. page numbers in here are
	 *	shifted left by 1, deleted slots have the LSB set.
Howard Chu's avatar
Howard Chu committed
972
973
	 */
	MDB_IDL		mt_spill_pgs;
Howard Chu's avatar
Howard Chu committed
974
	union {
Hallvard Furuseth's avatar
Hallvard Furuseth committed
975
976
977
978
		/** For write txns: Modified pages. Sorted when not MDB_WRITEMAP. */
		MDB_ID2L	dirty_list;
		/** For read txns: This thread/txn's reader table slot, or NULL. */
		MDB_reader	*reader;
Howard Chu's avatar
Howard Chu committed
979
980
981
982
983
	} mt_u;
	/** Array of records for each DB known in the environment. */
	MDB_dbx		*mt_dbxs;
	/** Array of MDB_db records for each known DB */
	MDB_db		*mt_dbs;
984
985
	/** Array of sequence numbers for each DB handle */
	unsigned int	*mt_dbiseqs;
Howard Chu's avatar
Howard Chu committed
986
987
988
989
/** @defgroup mt_dbflag	Transaction DB Flags
 *	@ingroup internal
 * @{
 */
990
#define DB_DIRTY	0x01		/**< DB was modified or is DUPSORT data */
991
992
#define DB_STALE	0x02		/**< Named-DB record is older than txnID */
#define DB_NEW		0x04		/**< Named-DB handle opened in this txn */
993
#define DB_VALID	0x08		/**< DB handle is valid, see also #MDB_VALID */
Howard Chu's avatar
Howard Chu committed
994
/** @} */
995
	/** In write txns, array of cursors for each DB */
Howard Chu's avatar
Howard Chu committed
996
	MDB_cursor	**mt_cursors;
Howard Chu's avatar
Howard Chu committed
997
998
	/** Array of flags for each DB */
	unsigned char	*mt_dbflags;
Howard Chu's avatar
Howard Chu committed
999
1000
	/**	Number of DB records in use. This number only ever increments;
	 *	we don't decrement it when individual DB handles are closed.
For faster browsing, not all history is shown. View entire blame