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

Howard Chu's avatar
Howard Chu committed
46
47
48
49
50
/** 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
51
52
53
#define MDB_THR_T	DWORD
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
54
55
#ifdef __GNUC__
# include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
56
#else
Howard Chu's avatar
Howard Chu committed
57
58
59
60
61
62
63
64
# 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
65
66
#include <sys/types.h>
#include <sys/stat.h>
Howard Chu's avatar
Howard Chu committed
67
#define MDB_PID_T	pid_t
Howard Chu's avatar
Howard Chu committed
68
#define MDB_THR_T	pthread_t
Howard Chu's avatar
Howard Chu committed
69
#include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
70
71
72
73
74
#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
75
#include <fcntl.h>
Howard Chu's avatar
Howard Chu committed
76
#endif
Howard Chu's avatar
Howard Chu committed
77

Howard Chu's avatar
Howard Chu committed
78
79
80
81
82
83
84
85
86
#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

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

Howard Chu's avatar
Howard Chu committed
96
#include <errno.h>
97
#include <limits.h>
Howard Chu's avatar
Howard Chu committed
98
#include <stddef.h>
99
#include <inttypes.h>
Howard Chu's avatar
Howard Chu committed
100
101
102
103
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
104
105
106
107
108

#ifdef _MSC_VER
#include <io.h>
typedef SSIZE_T	ssize_t;
#else
Howard Chu's avatar
Howard Chu committed
109
#include <unistd.h>
110
#endif
111

Howard Chu's avatar
Howard Chu committed
112
#if defined(__sun) || defined(ANDROID)
113
114
115
/* Most platforms have posix_memalign, older may only have memalign */
#define HAVE_MEMALIGN	1
#include <malloc.h>
116
117
118
119
/* On Solaris, we need the POSIX sigwait function */
#if defined (__sun)
# define _POSIX_PTHREAD_SEMANTICS	1
#endif
120
121
#endif

122
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
123
#include <netinet/in.h>
124
125
126
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

127
128
129
130
#if defined(__FreeBSD__) && defined(__FreeBSD_version) && __FreeBSD_version >= 1100110
# define MDB_USE_POSIX_MUTEX	1
# define MDB_USE_ROBUST	1
#elif defined(__APPLE__) || defined (BSD) || defined(__FreeBSD_kernel__)
131
132
133
134
# define MDB_USE_POSIX_SEM	1
# define MDB_FDATASYNC		fsync
#elif defined(ANDROID)
# define MDB_FDATASYNC		fsync
135
136
#endif

137
138
#ifndef _WIN32
#include <pthread.h>
139
#include <signal.h>
140
#ifdef MDB_USE_POSIX_SEM
141
# define MDB_USE_HASH		1
Howard Chu's avatar
Howard Chu committed
142
#include <semaphore.h>
Hallvard Furuseth's avatar
Hallvard Furuseth committed
143
144
145
#else
#define MDB_USE_POSIX_MUTEX	1
#endif
Howard Chu's avatar
Howard Chu committed
146
#endif
Hallvard Furuseth's avatar
Hallvard Furuseth committed
147
148
149
150

#if defined(_WIN32) + defined(MDB_USE_POSIX_SEM) \
	+ defined(MDB_USE_POSIX_MUTEX) != 1
# error "Ambiguous shared-lock implementation"
Howard Chu's avatar
Howard Chu committed
151
152
#endif

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

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

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

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

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

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

214
#ifdef _WIN32
215
216
217
218
219
#define CALL_CONV WINAPI
#else
#define CALL_CONV
#endif

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

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

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

246
247
248
249
250
251
252
253
/* Internal error codes, not exposed outside liblmdb */
#define	MDB_NO_ROOT		(MDB_LAST_ERRCODE + 10)
#ifdef _WIN32
#define MDB_OWNERDEAD	((int) WAIT_ABANDONED)
#elif defined(MDB_USE_POSIX_MUTEX) && defined(EOWNERDEAD)
#define MDB_OWNERDEAD	EOWNERDEAD	/**< #LOCK_MUTEX0() result if dead owner */
#endif

254
255
256
#ifdef __GLIBC__
#define	GLIBC_VER	((__GLIBC__ << 16 )| __GLIBC_MINOR__)
#endif
257
258
/** Some platforms define the EOWNERDEAD error code
 * even though they don't support Robust Mutexes.
259
 * Compile with -DMDB_USE_ROBUST=0, or use some other
260
261
262
 * mechanism like -DMDB_USE_POSIX_SEM instead of
 * -DMDB_USE_POSIX_MUTEX.
 * (Posix semaphores are not robust.)
263
 */
264
#ifndef MDB_USE_ROBUST
265
266
267
268
269
270
/* Android currently lacks Robust Mutex support. So does glibc < 2.4. */
# if defined(MDB_USE_POSIX_MUTEX) && (defined(ANDROID) || \
	(defined(__GLIBC__) && GLIBC_VER < 0x020004))
#  define MDB_USE_ROBUST	0
# else
#  define MDB_USE_ROBUST	1
271
272
273
274
# endif
#endif /* !MDB_USE_ROBUST */

#if defined(MDB_USE_POSIX_MUTEX) && (MDB_USE_ROBUST)
275
/* glibc < 2.12 only provided _np API */
276
277
#  if (defined(__GLIBC__) && GLIBC_VER < 0x02000c) || \
	(defined(PTHREAD_MUTEX_ROBUST_NP) && !defined(PTHREAD_MUTEX_ROBUST))
278
279
280
281
#   define PTHREAD_MUTEX_ROBUST	PTHREAD_MUTEX_ROBUST_NP
#   define pthread_mutexattr_setrobust(attr, flag)	pthread_mutexattr_setrobust_np(attr, flag)
#   define pthread_mutex_consistent(mutex)	pthread_mutex_consistent_np(mutex)
#  endif
282
#endif /* MDB_USE_POSIX_MUTEX && MDB_USE_ROBUST */
283

284
#if defined(MDB_OWNERDEAD) && (MDB_USE_ROBUST)
285
286
287
#define MDB_ROBUST_SUPPORTED	1
#endif

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

333
334
335
	/** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
#define MDB_PIDLOCK			1

336
#ifdef MDB_USE_POSIX_SEM
337

338
339
340
typedef sem_t *mdb_mutex_t, *mdb_mutexref_t;
#define LOCK_MUTEX0(mutex)		mdb_sem_wait(mutex)
#define UNLOCK_MUTEX(mutex)		sem_post(mutex)
341
342
343
344
345
346
347
348
349

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

Hallvard Furuseth's avatar
Hallvard Furuseth committed
350
#else	/* MDB_USE_POSIX_MUTEX: */
351
	/** Shared mutex/semaphore as the original is stored.
352
	 *
353
354
355
	 *	Not for copies.  Instead it can be assigned to an #mdb_mutexref_t.
	 *	When mdb_mutexref_t is a pointer and mdb_mutex_t is not, then it
	 *	is array[size 1] so it can be assigned to the pointer.
Howard Chu's avatar
Howard Chu committed
356
	 */
357
358
359
typedef pthread_mutex_t mdb_mutex_t[1];
	/** Reference to an #mdb_mutex_t */
typedef pthread_mutex_t *mdb_mutexref_t;
360
361
	/** 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
362
	 */
363
364
#define LOCK_MUTEX0(mutex)	pthread_mutex_lock(mutex)
	/** Unlock the reader or writer mutex.
Howard Chu's avatar
Howard Chu committed
365
	 */
366
367
#define UNLOCK_MUTEX(mutex)	pthread_mutex_unlock(mutex)
	/** Mark mutex-protected data as repaired, after death of previous owner.
Howard Chu's avatar
Howard Chu committed
368
	 */
369
#define mdb_mutex_consistent(mutex)	pthread_mutex_consistent(mutex)
370
#endif	/* MDB_USE_POSIX_SEM */
Howard Chu's avatar
Howard Chu committed
371
372
373

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

376
377
378
379
380
381
	/** 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
382
383
384
385
	/**	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
386
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
387
388
389
390
391

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

395
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
396
#define MNAME_LEN	32
397
398
#else
#define MNAME_LEN	(sizeof(pthread_mutex_t))
Howard Chu's avatar
Howard Chu committed
399
400
#endif

401
/** @} */
Howard Chu's avatar
Howard Chu committed
402

403
404
405
406
407
408
409
410
411
412
413
414
415
#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_mutexref_t mutex, int rc);
#else
#define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
#define mdb_mutex_failed(env, mutex, rc) (rc)
#endif

416
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
417
418
419
420
421
422
/**	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
423
424
425
 * preferably set some compiler flag to get the definition.
 */
#ifndef MDB_DSYNC
426
# ifdef O_DSYNC
Hallvard Furuseth's avatar
Hallvard Furuseth committed
427
# define MDB_DSYNC	O_DSYNC
428
429
430
# else
# define MDB_DSYNC	O_SYNC
# endif
Hallvard Furuseth's avatar
Hallvard Furuseth committed
431
#endif
432
433
434
435
436
437
438
#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
439
440
441
442
443
444
445
446
447
448
449
450
#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
451
452
#endif

Howard Chu's avatar
Howard Chu committed
453
454
455
456
457
458
459
460
	/** 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.
	 */
461
typedef MDB_ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
462

463
464
465
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
466
typedef MDB_ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
467

Howard Chu's avatar
Howard Chu committed
468
469
470
/** @defgroup debug	Debug Macros
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
471
#ifndef MDB_DEBUG
472
	/**	Enable debug output.  Needs variable argument macros (a C99 feature).
Howard Chu's avatar
Howard Chu committed
473
474
475
	 *	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
476
#define MDB_DEBUG 0
477
#endif
Howard Chu's avatar
Howard Chu committed
478

479
#if MDB_DEBUG
480
static int mdb_debug;
481
static txnid_t mdb_debug_start;
482

483
484
485
486
487
	/**	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
488
	fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
Howard Chu's avatar
Howard Chu committed
489
#else
490
# define DPRINTF(args)	((void) 0)
Howard Chu's avatar
Howard Chu committed
491
#endif
Howard Chu's avatar
Howard Chu committed
492
493
494
	/**	Print a debug string.
	 *	The string is printed literally, with no format processing.
	 */
495
#define DPUTS(arg)	DPRINTF(("%s", arg))
496
497
498
	/** 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
499
/** @} */
Howard Chu's avatar
Howard Chu committed
500

501
502
	/**	@brief The maximum size of a database page.
	 *
Hallvard Furuseth's avatar
Hallvard Furuseth committed
503
504
	 *	It is 32k or 64k, since value-PAGEBASE must fit in
	 *	#MDB_page.%mp_upper.
505
506
507
508
	 *
	 *	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
509
510
511
512
513
514
515
516
	 *
	 *	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
517
#define MAX_PAGESIZE	 (PAGEBASE ? 0x10000 : 0x8000)
Howard Chu's avatar
Howard Chu committed
518
519
520
521
522
523
524
525
526
527
528
529
530

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

Howard Chu's avatar
Howard Chu committed
533
	/**	A stamp that identifies a file as an LMDB file.
Howard Chu's avatar
Howard Chu committed
534
535
536
	 *	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
537
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
538

539
	/**	The version number for a database's datafile format. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
540
#define MDB_DATA_VERSION	 ((MDB_DEVEL) ? 999 : 1)
541
542
	/**	The version number for a database's lockfile format. */
#define MDB_LOCK_VERSION	 1
Howard Chu's avatar
Howard Chu committed
543

544
	/**	@brief The max size of a key we can write, or 0 for computed max.
545
	 *
546
547
548
549
550
551
552
553
554
	 *	This macro should normally be left alone or set to 0.
	 *	Note that a database with big keys or dupsort data cannot be
	 *	reliably modified by a liblmdb which uses a smaller max.
	 *	The default is 511 for backwards compat, or 0 when #MDB_DEVEL.
	 *
	 *	Other values are allowed, for backwards compat.  However:
	 *	A value bigger than the computed max can break if you do not
	 *	know what you are doing, and liblmdb <= 0.9.10 can break when
	 *	modifying a DB with keys/dupsort data bigger than its max.
555
	 *
556
557
558
	 *	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
559
	 */
560
#ifndef MDB_MAXKEYSIZE
561
#define MDB_MAXKEYSIZE	 ((MDB_DEVEL) ? 0 : 511)
562
563
564
565
566
567
568
#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)
569
#endif
Howard Chu's avatar
Howard Chu committed
570

571
572
573
574
575
576
	/**	@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
577
#if MDB_DEBUG
578
579
580
581
	/**	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
582
583
584
585
	/**	A key buffer.
	 *	@ingroup debug
	 *	This is used for printing a hex dump of a key's contents.
	 */
586
#define DKBUF	char kbuf[DKBUF_MAXKEYSIZE*2+1]
Howard Chu's avatar
Howard Chu committed
587
588
589
590
	/**	Display a key in hex.
	 *	@ingroup debug
	 *	Invoke a function to display a key in hex.
	 */
Howard Chu's avatar
Howard Chu committed
591
592
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
Howard Chu's avatar
Howard Chu committed
593
#define	DKBUF
Howard Chu's avatar
Howard Chu committed
594
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
595
#endif
Howard Chu's avatar
Howard Chu committed
596

Howard Chu's avatar
Howard Chu committed
597
598
599
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
600
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
601

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

605
606
607
	/** 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
608
609
610
611
	/**	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
612
613
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
614
615
616
617
	/**	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
618
619
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
620
621
622
623
624
625
626
/**	@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
627
628
 *	If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
 *
Howard Chu's avatar
Howard Chu committed
629
630
 *	No reader table is used if the database is on a read-only filesystem, or
 *	if #MDB_NOLOCK is set.
631
 *
Howard Chu's avatar
Howard Chu committed
632
633
634
 *	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
635
636
 *	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
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 *	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
671
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
672
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
673
674
#endif

Howard Chu's avatar
Howard Chu committed
675
676
677
678
679
680
681
682
	/**	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
683
typedef struct MDB_rxbody {
684
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
685
686
687
688
689
690
	 *	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
691
	volatile txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
692
	/** The process ID of the process owning this reader txn. */
Leonid Yuriev's avatar
Leonid Yuriev committed
693
	volatile MDB_PID_T	mrb_pid;
Howard Chu's avatar
Howard Chu committed
694
	/** The thread ID of the thread owning this txn. */
Leonid Yuriev's avatar
Leonid Yuriev committed
695
	volatile MDB_THR_T	mrb_tid;
Howard Chu's avatar
Howard Chu committed
696
697
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
698
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
699
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
700
701
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
702
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
703
704
705
#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
706
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
707
708
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
709
710
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
711
712
713
714
715
716
717
	/** 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
718
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
719
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
720
721
722
723
	 *	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
724
	 */
Howard Chu's avatar
Howard Chu committed
725
typedef struct MDB_txbody {
Howard Chu's avatar
Howard Chu committed
726
		/** Stamp identifying this as an LMDB file. It must be set
Howard Chu's avatar
Howard Chu committed
727
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
728
	uint32_t	mtb_magic;
729
730
		/** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
	uint32_t	mtb_format;
731
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
732
	char	mtb_rmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
733
#else
Howard Chu's avatar
Howard Chu committed
734
		/** Mutex protecting access to this table.
735
		 *	This is the reader table lock used with LOCK_MUTEX().
Howard Chu's avatar
Howard Chu committed
736
		 */
737
	mdb_mutex_t	mtb_rmutex;
Howard Chu's avatar
Howard Chu committed
738
#endif
Howard Chu's avatar
Howard Chu committed
739
740
741
742
		/**	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
743
	volatile txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
744
745
746
747
		/** 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
748
	volatile unsigned	mtb_numreaders;
Howard Chu's avatar
Howard Chu committed
749
750
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
751
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
752
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
753
754
755
	union {
		MDB_txbody mtb;
#define mti_magic	mt1.mtb.mtb_magic
756
#define mti_format	mt1.mtb.mtb_format
757
#define mti_rmutex	mt1.mtb.mtb_rmutex
Howard Chu's avatar
Howard Chu committed
758
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
759
760
761
762
763
#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 {
764
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
765
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
766
767
#define	mti_wmname	mt2.mt2_wmname
#else
768
		mdb_mutex_t	mt2_wmutex;
Howard Chu's avatar
Howard Chu committed
769
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
770
#endif
771
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
772
773
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
774
} MDB_txninfo;
775
776
777
778
779
780
781

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

Hallvard Furuseth's avatar
Hallvard Furuseth committed
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
/** Common header for all page types. The page type depends on #mp_flags.
 *
 * #P_BRANCH and #P_LEAF pages have unsorted '#MDB_node's at the end, with
 * sorted #mp_ptrs[] entries referring to them. Exception: #P_LEAF2 pages
 * omit mp_ptrs and pack sorted #MDB_DUPFIXED values after the page header.
 *
 * #P_OVERFLOW records occupy one or more contiguous pages where only the
 * first has a page header. They hold the real data of #F_BIGDATA nodes.
 *
 * #P_SUBP sub-pages are small leaf "pages" with duplicate data.
 * A node with flag #F_DUPDATA but not #F_SUBDATA contains a sub-page.
 * (Duplicate data can also go in sub-databases, which use normal pages.)
 *
 * #P_META pages contain #MDB_meta, the start point of an LMDB snapshot.
 *
 * Each non-metapage up to #MDB_meta.%mm_last_pg is reachable exactly once
 * in the snapshot: Either used by a database or listed in a freeDB record.
Howard Chu's avatar
Howard Chu committed
801
 */
Howard Chu's avatar
Howard Chu committed
802
typedef struct MDB_page {
803
804
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
805
	union {
806
		pgno_t		p_pgno;	/**< page number */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
807
		struct MDB_page *p_next; /**< for in-memory list of freed pages */
808
	} mp_p;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
809
	uint16_t	mp_pad;			/**< key size if this is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
810
811
812
813
814
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
815
816
817
818
#define	P_BRANCH	 0x01		/**< branch page */
#define	P_LEAF		 0x02		/**< leaf page */
#define	P_OVERFLOW	 0x04		/**< overflow page */
#define	P_META		 0x08		/**< meta page */
819
#define	P_DIRTY		 0x10		/**< dirty page, also set for #P_SUBP pages */
Howard Chu's avatar
Howard Chu committed
820
#define	P_LEAF2		 0x20		/**< for #MDB_DUPFIXED records */
Howard Chu's avatar
Howard Chu committed
821
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
822
#define	P_LOOSE		 0x4000		/**< page was dirtied then freed, can be reused */
Howard Chu's avatar
Howard Chu committed
823
#define	P_KEEP		 0x8000		/**< leave this page alone during spill */
Howard Chu's avatar
Howard Chu committed
824
/** @} */
Howard Chu's avatar
Howard Chu committed
825
	uint16_t	mp_flags;		/**< @ref mdb_page */
826
827
828
#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
829
	union {
Howard Chu's avatar
Howard Chu committed
830
		struct {
831
832
833
834
835
			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
836
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
837
838
} MDB_page;

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

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

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

Howard Chu's avatar
Howard Chu committed
848
	/** Number of nodes on a page */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
849
#define NUMKEYS(p)	 (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
Howard Chu's avatar
Howard Chu committed
850
851

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
855
856
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
857
858
859
860
861
862
	/** 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
863
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
864
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
865
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
866
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
867
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
868
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
869
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
870
871
	/** 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
872

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

Hallvard Furuseth's avatar
Hallvard Furuseth committed
876
877
878
	/** Link in #MDB_txn.%mt_loose_pgs list.
	 *  Kept outside the page header, which is needed when reusing the page.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
879
#define NEXT_LOOSE_PAGE(p)		(*(MDB_page **)((p) + 2))
880

Howard Chu's avatar
Howard Chu committed
881
	/** Header for a single key/data pair within a page.
882
883
	 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
	 * We guarantee 2-byte alignment for 'MDB_node's.
884
885
886
887
888
	 *
	 * #mn_lo and #mn_hi are used for data size on leaf nodes, and for child
	 * pgno on branch nodes.  On 64 bit platforms, #mn_flags is also used
	 * for pgno.  (Branch nodes have no flags).  Lo and hi are in host byte
	 * order in case some accesses can be optimized to 32-bit word access.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
889
890
891
892
893
	 *
	 * Leaf node flags describe node contents.  #F_BIGDATA says the node's
	 * data part is the page number of an overflow page with actual data.
	 * #F_DUPDATA and #F_SUBDATA can be combined giving duplicate data in
	 * a sub-page/sub-database, and named databases (just #F_SUBDATA).
Howard Chu's avatar
Howard Chu committed
894
895
	 */
typedef struct MDB_node {
896
897
	/** part of data size or pgno
	 *	@{ */
898
#if BYTE_ORDER == LITTLE_ENDIAN
899
	unsigned short	mn_lo, mn_hi;
900
901
902
#else
	unsigned short	mn_hi, mn_lo;
#endif
903
	/** @} */
Howard Chu's avatar
Howard Chu committed
904
905
906
907
908
/** @defgroup mdb_node Node Flags
 *	@ingroup internal
 *	Flags for node headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
909
910
911
#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
912
913

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

Howard Chu's avatar
Howard Chu committed
916
917
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
918
919
920
921
922
923
924
	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)

925
926
927
	/** 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
928
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
929
930
931
932
	 *	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
933
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
934
935
936
937
	 *	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
938
	/** Address of node \b i in page \b p */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
939
#define NODEPTR(p, i)	 ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
Howard Chu's avatar
Howard Chu committed
940
941
942
943
944
945
946
947

	/** 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 */
948
949
950
#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
951
952
953
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
954
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
955
956
957
958
959
960
961
962
963

	/** 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
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
	/** 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
988
989
990
991
992
993
	/** 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
994
995
996
997
998
999
	/** 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
1000

For faster browsing, not all history is shown. View entire blame