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
/*
Howard Chu's avatar
Howard Chu committed
8
 * Copyright 2011-2014 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

Howard Chu's avatar
Howard Chu committed
83
#include <errno.h>
84
#include <limits.h>
Howard Chu's avatar
Howard Chu committed
85
#include <stddef.h>
86
#include <inttypes.h>
Howard Chu's avatar
Howard Chu committed
87
88
89
90
91
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
92

Howard Chu's avatar
Howard Chu committed
93
#if defined(__sun) || defined(ANDROID)
94
95
96
97
98
/* Most platforms have posix_memalign, older may only have memalign */
#define HAVE_MEMALIGN	1
#include <malloc.h>
#endif

99
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
100
#include <netinet/in.h>
101
102
103
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

104
#if defined(__APPLE__) || defined (BSD)
105
106
107
108
# define MDB_USE_POSIX_SEM	1
# define MDB_FDATASYNC		fsync
#elif defined(ANDROID)
# define MDB_FDATASYNC		fsync
109
110
#endif

111
112
#ifndef _WIN32
#include <pthread.h>
113
#ifdef MDB_USE_POSIX_SEM
114
# define MDB_USE_HASH		1
Howard Chu's avatar
Howard Chu committed
115
116
117
118
#include <semaphore.h>
#endif
#endif

119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
#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
134
#ifndef BYTE_ORDER
Howard Chu's avatar
Howard Chu committed
135
136
137
138
139
140
141
142
143
144
145
146
# 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
147
#endif
Howard Chu's avatar
Howard Chu committed
148

Howard Chu's avatar
Howard Chu committed
149
150
151
152
153
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
154
155
#endif

Howard Chu's avatar
Howard Chu committed
156
#if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
Howard Chu's avatar
Howard Chu committed
157
158
159
#define MISALIGNED_OK	1
#endif

Howard Chu's avatar
Howard Chu committed
160
#include "lmdb.h"
161
162
#include "midl.h"

Howard Chu's avatar
Howard Chu committed
163
164
#if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
# error "Unknown or unsupported endianness (BYTE_ORDER)"
165
166
167
168
#elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
# error "Two's complement, reasonably sized integer types, please"
#endif

169
170
#ifdef __GNUC__
/** Put infrequently used env functions in separate section */
Howard Chu's avatar
Howard Chu committed
171
172
173
174
175
# ifdef __APPLE__
#  define	ESECT	__attribute__ ((section("__TEXT,text_env")))
# else
#  define	ESECT	__attribute__ ((section("text_env")))
# endif
176
177
178
179
#else
#define ESECT
#endif

Howard Chu's avatar
Howard Chu committed
180
/** @defgroup internal	LMDB Internals
181
182
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
183
/** @defgroup compat	Compatibility Macros
Howard Chu's avatar
Howard Chu committed
184
185
186
187
 *	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.
188
189
 *	@{
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
190

Hallvard Furuseth's avatar
Hallvard Furuseth committed
191
	/** Features under development */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
192
193
#ifndef MDB_DEVEL
#define MDB_DEVEL 0
Hallvard Furuseth's avatar
Hallvard Furuseth committed
194
195
196
197
#endif

#if MDB_DEVEL && (defined(_WIN32) || (defined(EOWNERDEAD) && !defined(MDB_USE_POSIX_SEM)))
#define MDB_ROBUST_SUPPORTED	1
Hallvard Furuseth's avatar
Hallvard Furuseth committed
198
199
#endif

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

254
255
256
	/** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
#define MDB_PIDLOCK			1

257
#ifdef MDB_USE_POSIX_SEM
258

Hallvard Furuseth's avatar
Hallvard Furuseth committed
259
260
261
262
typedef sem_t *mdb_mutex_t;
#define MDB_MUTEX(env, rw)		((env)->me_##rw##mutex)
#define LOCK_MUTEX0(mutex)		mdb_sem_wait(mutex)
#define UNLOCK_MUTEX(mutex)		sem_post(mutex)
263
264
265
266
267
268
269
270
271

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
272
#else
Hallvard Furuseth's avatar
Hallvard Furuseth committed
273
	/** Pointer/HANDLE type of shared mutex/semaphore.
Howard Chu's avatar
Howard Chu committed
274
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
275
276
typedef pthread_mutex_t *mdb_mutex_t;
	/** Mutex for the reader table (rw = r) or write transaction (rw = w).
Howard Chu's avatar
Howard Chu committed
277
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
278
279
280
#define MDB_MUTEX(env, rw)	(&(env)->me_txns->mti_##rw##mutex)
	/** 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
281
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
282
283
#define LOCK_MUTEX0(mutex)	pthread_mutex_lock(mutex)
	/** Unlock the reader or writer mutex.
Howard Chu's avatar
Howard Chu committed
284
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
285
#define UNLOCK_MUTEX(mutex)	pthread_mutex_unlock(mutex)
286
#endif	/* MDB_USE_POSIX_SEM */
Howard Chu's avatar
Howard Chu committed
287
288
289

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

292
293
294
295
296
297
	/** 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
298
299
300
301
	/**	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
302
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
303
304
305
306
307

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

311
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
312
#define MNAME_LEN	32
313
314
#else
#define MNAME_LEN	(sizeof(pthread_mutex_t))
Howard Chu's avatar
Howard Chu committed
315
316
#endif

317
/** @} */
Howard Chu's avatar
Howard Chu committed
318

Hallvard Furuseth's avatar
Hallvard Furuseth committed
319
320
321
322
323
324
325
326
327
328
329
330
331
#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)))
static int mdb_mutex_failed(MDB_env *env, mdb_mutex_t mutex, int rc);
#else
#define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
#define mdb_mutex_failed(env, mutex, rc) (rc)
#endif

332
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
333
334
335
336
337
338
/**	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
339
340
341
342
343
344
 * 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
345
346
347
348
349
350
351
#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
352
353
354
355
356
357
358
359
360
361
362
363
#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
364
365
#endif

Howard Chu's avatar
Howard Chu committed
366
367
368
369
370
371
372
373
	/** 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.
	 */
374
typedef MDB_ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
375

376
377
378
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
379
typedef MDB_ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
380

Howard Chu's avatar
Howard Chu committed
381
382
383
/** @defgroup debug	Debug Macros
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
384
#ifndef MDB_DEBUG
385
	/**	Enable debug output.  Needs variable argument macros (a C99 feature).
Howard Chu's avatar
Howard Chu committed
386
387
388
	 *	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
389
#define MDB_DEBUG 0
390
#endif
Howard Chu's avatar
Howard Chu committed
391

392
#if MDB_DEBUG
393
static int mdb_debug;
394
static txnid_t mdb_debug_start;
395

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

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

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

Howard Chu's avatar
Howard Chu committed
446
	/**	A stamp that identifies a file as an LMDB file.
Howard Chu's avatar
Howard Chu committed
447
448
449
	 *	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
450
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
451

452
	/**	The version number for a database's datafile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
453
#define MDB_DATA_VERSION	 ((MDB_DEVEL) ? 999 : 1)
454
	/**	The version number for a database's lockfile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
455
#define MDB_LOCK_VERSION	 ((MDB_DEVEL) ? 999 : 1)
Howard Chu's avatar
Howard Chu committed
456

457
	/**	@brief The max size of a key we can write, or 0 for dynamic max.
458
	 *
459
460
461
	 *	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.
462
	 *	#MDB_DEVEL sets the default to 0.
463
	 *
464
465
466
	 *	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
467
	 */
468
#ifndef MDB_MAXKEYSIZE
469
#define MDB_MAXKEYSIZE	 ((MDB_DEVEL) ? 0 : 511)
470
471
472
473
474
475
476
#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)
477
#endif
Howard Chu's avatar
Howard Chu committed
478

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

Howard Chu's avatar
Howard Chu committed
505
506
507
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
508
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
509

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

513
514
515
	/** 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
516
517
518
519
	/**	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
520
521
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
522
523
524
525
	/**	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
526
527
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
528
529
530
531
532
533
534
/**	@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
535
536
 *	If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
 *
Howard Chu's avatar
Howard Chu committed
537
538
 *	No reader table is used if the database is on a read-only filesystem, or
 *	if #MDB_NOLOCK is set.
539
 *
Howard Chu's avatar
Howard Chu committed
540
541
542
 *	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
543
544
 *	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
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
571
572
573
574
575
576
577
578
 *	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
579
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
580
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
581
582
#endif

Howard Chu's avatar
Howard Chu committed
583
584
585
586
587
588
589
590
	/**	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
591
typedef struct MDB_rxbody {
592
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
593
594
595
596
597
598
	 *	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.
	 */
599
	txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
600
	/** The process ID of the process owning this reader txn. */
Howard Chu's avatar
Howard Chu committed
601
	MDB_PID_T	mrb_pid;
Howard Chu's avatar
Howard Chu committed
602
	/** The thread ID of the thread owning this txn. */
Howard Chu's avatar
Howard Chu committed
603
	MDB_THR_T	mrb_tid;
Howard Chu's avatar
Howard Chu committed
604
605
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
606
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
607
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
608
609
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
610
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
611
612
613
#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
614
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
615
616
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
617
618
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
619
620
621
622
623
624
625
	/** 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
626
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
627
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
628
629
630
631
	 *	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
632
	 */
Howard Chu's avatar
Howard Chu committed
633
typedef struct MDB_txbody {
Howard Chu's avatar
Howard Chu committed
634
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
635
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
636
	uint32_t	mtb_magic;
637
638
		/** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
	uint32_t	mtb_format;
639
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
640
	char	mtb_rmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
641
#else
Howard Chu's avatar
Howard Chu committed
642
		/** Mutex protecting access to this table.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
643
		 *	This is the #MDB_MUTEX(env,r) reader table lock.
Howard Chu's avatar
Howard Chu committed
644
		 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
645
	pthread_mutex_t	mtb_rmutex;
Howard Chu's avatar
Howard Chu committed
646
#endif
Howard Chu's avatar
Howard Chu committed
647
648
649
650
		/**	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.
		 */
651
	txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
652
653
654
655
		/** 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.
		 */
656
	unsigned	mtb_numreaders;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
657
658
		/** Flags which the lock file was initialized with. */
	unsigned	mtb_flags;
Howard Chu's avatar
Howard Chu committed
659
660
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
661
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
662
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
663
664
665
	union {
		MDB_txbody mtb;
#define mti_magic	mt1.mtb.mtb_magic
666
#define mti_format	mt1.mtb.mtb_format
Hallvard Furuseth's avatar
Hallvard Furuseth committed
667
#define mti_rmutex	mt1.mtb.mtb_rmutex
Howard Chu's avatar
Howard Chu committed
668
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
669
670
#define mti_txnid	mt1.mtb.mtb_txnid
#define mti_numreaders	mt1.mtb.mtb_numreaders
Hallvard Furuseth's avatar
Hallvard Furuseth committed
671
#define mti_flags	mt1.mtb.mtb_flags
Howard Chu's avatar
Howard Chu committed
672
673
674
		char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mt1;
	union {
675
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
676
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
677
678
#define	mti_wmname	mt2.mt2_wmname
#else
Howard Chu's avatar
Howard Chu committed
679
680
		pthread_mutex_t	mt2_wmutex;
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
681
#endif
682
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
683
684
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
685
} MDB_txninfo;
686
687
688
689
690
691
692

	/** 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
693
/** @} */
Howard Chu's avatar
Howard Chu committed
694

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

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

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

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

Howard Chu's avatar
Howard Chu committed
745
	/** Number of nodes on a page */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
746
#define NUMKEYS(p)	 (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
Howard Chu's avatar
Howard Chu committed
747
748

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
752
753
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
754
755
756
757
758
759
	/** 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
760
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
761
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
762
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
763
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
764
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
765
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
766
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
767
768
	/** 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
769

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

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

Howard Chu's avatar
Howard Chu committed
776
	/** Header for a single key/data pair within a page.
777
778
	 * 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
779
780
781
782
	 */
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
783
	 * is also used for pgno. (Branch nodes have no flags).
Howard Chu's avatar
Howard Chu committed
784
	 * They are in host byte order in case that lets some
785
	 * accesses be optimized into a 32-bit word access.
Howard Chu's avatar
Howard Chu committed
786
	 */
787
788
789
790
791
#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
792
793
794
795
796
/** @defgroup mdb_node Node Flags
 *	@ingroup internal
 *	Flags for node headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
797
798
799
#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
800
801

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

Howard Chu's avatar
Howard Chu committed
804
805
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
806
807
808
809
810
811
812
	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)

813
814
815
	/** 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
816
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
817
818
819
820
	 *	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
821
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
822
823
824
825
	 *	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
826
	/** Address of node \b i in page \b p */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
827
#define NODEPTR(p, i)	 ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
Howard Chu's avatar
Howard Chu committed
828
829
830
831
832
833
834
835

	/** 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 */
836
837
838
#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
839
840
841
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
842
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
843
844
845
846
847
848
849
850
851

	/** 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
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
	/** 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
876
877
878
879
880
881
	/** 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
882
883
884
885
886
887
	/** 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
888
889

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
890
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
891
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
892
	uint16_t	md_flags;	/**< @ref mdb_dbi_open */
Howard Chu's avatar
Howard Chu committed
893
	uint16_t	md_depth;	/**< depth of this tree */
894
895
896
897
	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
898
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
899
900
} MDB_db;

901
	/** mdb_dbi_open flags */
902
903
#define MDB_VALID	0x8000		/**< DB handle is valid, for me_dbflags */
#define PERSISTENT_FLAGS	(0xffff & ~(MDB_VALID))
904
905
906
#define VALID_FLAGS	(MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
	MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)

Howard Chu's avatar
Howard Chu committed
907
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
908
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
909
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
910
911
#define	MAIN_DBI	1

912
913
914
915
	/** 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
916
typedef struct MDB_meta {
Howard Chu's avatar
Howard Chu committed
917
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
918
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
919
	uint32_t	mm_magic;
920
		/** Version number of this lock file. Must be set to #MDB_DATA_VERSION. */
Howard Chu's avatar
Howard Chu committed
921
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
922
923
924
925
	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
926
#define	mm_psize	mm_dbs[0].md_pad
Howard Chu's avatar
Howard Chu committed
927
	/** Any persistent environment flags. @ref mdb_env */
Howard Chu's avatar
Howard Chu committed
928
#define	mm_flags	mm_dbs[0].md_flags
Howard Chu's avatar
Howard Chu committed
929
	pgno_t		mm_last_pg;			/**< last used page in file */
930
	txnid_t		mm_txnid;			/**< txnid that committed this page */
Howard Chu's avatar
Howard Chu committed
931
932
} MDB_meta;

933
	/** Buffer for a stack-allocated meta page.
934
935
936
937
	 *	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.
	 */
938
typedef union MDB_metabuf {
939
940
941
942
943
	MDB_page	mb_page;
	struct {
		char		mm_pad[PAGEHDRSZ];
		MDB_meta	mm_meta;
	} mb_metabuf;
944
} MDB_metabuf;
945

Howard Chu's avatar
Howard Chu committed
946
947
948
949
950
951
952
953
954
	/** 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 */
955
	void		*md_relctx;		/**< user-provided context for md_rel */
Howard Chu's avatar
Howard Chu committed
956
} MDB_dbx;
Howard Chu's avatar
Howard Chu committed
957

Howard Chu's avatar
Howard Chu committed
958
959
960
961
	/** A database transaction.
	 *	Every operation requires a transaction handle.
	 */
struct MDB_txn {
962
963
	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
964
965
966
967
968
	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.
	 */
969
	txnid_t		mt_txnid;
Howard Chu's avatar
Howard Chu committed
970
971
972
	MDB_env		*mt_env;		/**< the DB environment */
	/** The list of pages that became unused during this transaction.
	 */
973
	MDB_IDL		mt_free_pgs;
Howard Chu's avatar
Howard Chu committed
974
	/** The list of loose pages that became unused and may be reused
975
	 *	in this transaction, linked through #NEXT_LOOSE_PAGE(page).
Howard Chu's avatar
Howard Chu committed
976
977
	 */
	MDB_page	*mt_loose_pgs;
978
979
	/* #Number of loose pages (#mt_loose_pgs) */
	int			mt_loose_count;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
980
	/** The sorted list of dirty pages we temporarily wrote to disk
981
982
	 *	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
983
984
	 */
	MDB_IDL		mt_spill_pgs;
Howard Chu's avatar
Howard Chu committed
985
	union {
Hallvard Furuseth's avatar
Hallvard Furuseth committed
986
987
988
989
		/** 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
990
991
992
993
994
	} 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;
995
996
	/** Array of sequence numbers for each DB handle */
	unsigned int	*mt_dbiseqs;
Howard Chu's avatar
Howard Chu committed
997
998
999
1000
/** @defgroup mt_dbflag	Transaction DB Flags
 *	@ingroup internal
 * @{
 */
1001
#define DB_DIRTY	0x01		/**< DB was modified or is DUPSORT data */
1002
1003
#define DB_STALE	0x02		/**< Named-DB record is older than txnID */
#define DB_NEW		0x04		/**< Named-DB handle opened in this txn */
1004
#define DB_VALID	0x08		/**< DB handle is valid, see also #MDB_VALID */
Howard Chu's avatar
Howard Chu committed
1005
/** @} */
1006
	/** In write txns, array of cursors for each DB */
Howard Chu's avatar
Howard Chu committed
1007
	MDB_cursor	**mt_cursors;
Howard Chu's avatar
Howard Chu committed
1008
1009
	/** Array of flags for each DB */
	unsigned char	*mt_dbflags;
Howard Chu's avatar
Howard Chu committed
1010
1011
1012
	/**	Number of DB records in use. This number only ever increments;
	 *	we don't decrement it when individual DB handles are closed.
	 */
1013
	MDB_dbi		mt_numdbs;
Howard Chu's avatar
Howard Chu committed
1014

Howard Chu's avatar
Howard Chu committed
1015
1016
1017
1018
/** @defgroup mdb_txn	Transaction Flags
 *	@ingroup internal
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
1019
#define MDB_TXN_RDONLY		0x01		/**< read-only transaction */
1020
#define MDB_TXN_ERROR		0x02		/**< txn is unusable after an error */
1021
#define MDB_TXN_DIRTY		0x04		/**< must write, even if dirty list is empty */
Howard Chu's avatar
Howard Chu committed
1022
#define MDB_TXN_SPILLS		0x08		/**< txn or a parent has spilled pages */
Howard Chu's avatar
Howard Chu committed
1023
1024
/** @} */
	unsigned int	mt_flags;		/**< @ref mdb_txn */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1025
	/** #dirty_list room: Array size - \#dirty pages visible to this txn.
1026
1027
1028
1029
	 *	Includes ancestor txns' dirty pages not hidden by other txns'
	 *	dirty/spilled pages. Thus commit(nested txn) has room to merge
	 *	dirty_list into mt_parent after freeing hidden mt_parent pages.
	 */
1030
	unsigned int	mt_dirty_room;
Howard Chu's avatar
Howard Chu committed
1031
};
Howard Chu's avatar
Howard Chu committed
1032

Howard Chu's avatar
Howard Chu committed
1033
/** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
1034
1035
1036
 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
 * raise this on a 64 bit machine.
 */
Howard Chu's avatar
Howard Chu committed
1037
#define CURSOR_STACK		 32
Howard Chu's avatar
Howard Chu committed
1038

Howard Chu's avatar
Howard Chu committed
1039
struct MDB_xcursor;
1040

1041
1042
1043
1044
1045
1046
1047
1048
	/** Cursors are used for all DB operations.
	 *	A cursor holds a path of (page pointer, key index) from the DB
	 *	root to a position in the DB, plus other state. #MDB_DUPSORT
	 *	cursors include an xcursor to the current data item. Write txns
	 *	track their cursors and keep them up to date when data moves.
	 *	Exception: An xcursor's pointer to a #P_SUBP page can be stale.
	 *	(A node with #F_DUPDATA but no #F_SUBDATA contains a subpage).
	 */
Howard Chu's avatar
Howard Chu committed
1049
struct MDB_cursor {
Howard Chu's avatar
Howard Chu committed
1050
1051
	/** Next cursor on this DB in this txn */
	MDB_cursor	*mc_next;
1052
1053
	/** Backup of the original cursor if this cursor is a shadow */
	MDB_cursor	*mc_backup;
Howard Chu's avatar
Howard Chu committed
1054
	/** Context used for databases with #MDB_DUPSORT, otherwise NULL */
Howard Chu's avatar
Howard Chu committed
1055
	struct MDB_xcursor	*mc_xcursor;
Howard Chu's avatar
Howard Chu committed
1056
	/** The transaction that owns this cursor */
Howard Chu's avatar
Howard Chu committed
1057
	MDB_txn		*mc_txn;
Howard Chu's avatar
Howard Chu committed
1058
	/** The database handle this cursor operates on */
Howard Chu's avatar
Howard Chu committed
1059
	MDB_dbi		mc_dbi;
1060
1061
1062
1063
	/** The database record for this cursor */
	MDB_db		*mc_db;
	/** The database auxiliary record for this cursor */
	MDB_dbx		*mc_dbx;
Howard Chu's avatar
Howard Chu committed
1064
1065
	/** The @ref mt_dbflag for this database */
	unsigned char	*mc_dbflag;
Howard Chu's avatar
Howard Chu committed
1066
	unsigned short 	mc_snum;	/**< number of pushed pages */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1067
	unsigned short	mc_top;		/**< index of top page, normally mc_snum-1 */
Howard Chu's avatar
Howard Chu committed
1068
1069
1070
1071
1072
/** @defgroup mdb_cursor	Cursor Flags
 *	@ingroup internal
 *	Cursor state flags.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
1073
1074
#define C_INITIALIZED	0x01	/**< cursor has been initialized and is valid */
#define C_EOF	0x02			/**< No more data */
Howard Chu's avatar
Howard Chu committed
1075
#define C_SUB	0x04			/**< Cursor is a sub-cursor */
1076
#define C_DEL	0x08			/**< last op was a cursor_del */
Howard Chu's avatar
Howard Chu committed
1077
#define C_SPLITTING	0x20		/**< Cursor is in page_split */