mdb.c 162 KB
Newer Older
1
2
3
4
5
6
/** @file mdb.c
 *	@brief memory-mapped database library
 *
 *	A Btree-based database management library modeled loosely on the
 *	BerkeleyDB API, but much simplified.
 */
Howard Chu's avatar
Howard Chu committed
7
8
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
/*
 * Copyright 2011 Howard Chu, Symas Corp.
 * 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.
 */
Howard Chu's avatar
Howard Chu committed
35
36
37
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
38
39
40
#ifdef _WIN32
#include <windows.h>
#else
Howard Chu's avatar
Howard Chu committed
41
42
43
44
45
#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
46
#include <fcntl.h>
Howard Chu's avatar
Howard Chu committed
47
#endif
Howard Chu's avatar
Howard Chu committed
48
49
50

#include <assert.h>
#include <errno.h>
51
#include <limits.h>
Howard Chu's avatar
Howard Chu committed
52
53
54
55
56
57
58
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
59
60
61

#ifndef _WIN32
#include <pthread.h>
Howard Chu's avatar
Howard Chu committed
62
63
64
65
66
67
#ifdef __APPLE__
#include <semaphore.h>
#endif
#endif

#ifndef BYTE_ORDER
Howard Chu's avatar
Howard Chu committed
68
69
70
71
72
73
74
75
76
77
78
79
# 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
80
#endif
Howard Chu's avatar
Howard Chu committed
81

Howard Chu's avatar
Howard Chu committed
82
83
84
85
86
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
87
88
#endif

Howard Chu's avatar
Howard Chu committed
89
90
91
92
#if defined(__i386) || defined(__x86_64)
#define MISALIGNED_OK	1
#endif

93
94
95
#include "mdb.h"
#include "midl.h"

Howard Chu's avatar
Howard Chu committed
96
97
#if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
# error "Unknown or unsupported endianness (BYTE_ORDER)"
98
99
100
101
#elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
# error "Two's complement, reasonably sized integer types, please"
#endif

102
103
104
105
/** @defgroup internal	MDB Internals
 *	@{
 */
/** @defgroup compat	Windows Compatibility Macros
Howard Chu's avatar
Howard Chu committed
106
107
108
109
 *	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.
110
111
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
112
113
114
115
116
#ifdef _WIN32
#define pthread_t	DWORD
#define pthread_mutex_t	HANDLE
#define pthread_key_t	DWORD
#define pthread_self()	GetCurrentThreadId()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
117
#define pthread_key_create(x,y)	(*(x) = TlsAlloc())
Howard Chu's avatar
Howard Chu committed
118
119
120
121
122
#define pthread_key_delete(x)	TlsFree(x)
#define pthread_getspecific(x)	TlsGetValue(x)
#define pthread_setspecific(x,y)	TlsSetValue(x,y)
#define pthread_mutex_unlock(x)	ReleaseMutex(x)
#define pthread_mutex_lock(x)	WaitForSingleObject(x, INFINITE)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
123
124
125
126
#define LOCK_MUTEX_R(env)	pthread_mutex_lock((env)->me_rmutex)
#define UNLOCK_MUTEX_R(env)	pthread_mutex_unlock((env)->me_rmutex)
#define LOCK_MUTEX_W(env)	pthread_mutex_lock((env)->me_wmutex)
#define UNLOCK_MUTEX_W(env)	pthread_mutex_unlock((env)->me_wmutex)
Howard Chu's avatar
Howard Chu committed
127
#define getpid()	GetCurrentProcessId()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
128
#define	fdatasync(fd)	(!FlushFileBuffers(fd))
Howard Chu's avatar
Howard Chu committed
129
#define	ErrCode()	GetLastError()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
130
#define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
Howard Chu's avatar
Howard Chu committed
131
132
#define	close(fd)	CloseHandle(fd)
#define	munmap(ptr,len)	UnmapViewOfFile(ptr)
Howard Chu's avatar
Howard Chu committed
133
134
135
136
137
138
139
#else
#ifdef __APPLE__
#define LOCK_MUTEX_R(env)	sem_wait((env)->me_rmutex)
#define UNLOCK_MUTEX_R(env)	sem_post((env)->me_rmutex)
#define LOCK_MUTEX_W(env)	sem_wait((env)->me_wmutex)
#define UNLOCK_MUTEX_W(env)	sem_post((env)->me_wmutex)
#define fdatasync(fd)	fsync(fd)
Howard Chu's avatar
Howard Chu committed
140
#else
Howard Chu's avatar
Howard Chu committed
141
142
143
#ifdef ANDROID
#define fdatasync(fd)	fsync(fd)
#endif
Howard Chu's avatar
Howard Chu committed
144
145
	/** Lock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
146
#define LOCK_MUTEX_R(env)	pthread_mutex_lock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
147
148
	/** Unlock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
149
#define UNLOCK_MUTEX_R(env)	pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
150
151
152
153
154

	/** Lock the writer mutex.
	 *	Only a single write transaction is allowed at a time. Other writers
	 *	will block waiting for this mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
155
#define LOCK_MUTEX_W(env)	pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
Howard Chu's avatar
Howard Chu committed
156
157
	/** Unlock the writer mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
158
#define UNLOCK_MUTEX_W(env)	pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
Howard Chu's avatar
Howard Chu committed
159
#endif	/* __APPLE__ */
Howard Chu's avatar
Howard Chu committed
160
161
162

	/** Get the error code for the last failed system function.
	 */
Howard Chu's avatar
Howard Chu committed
163
#define	ErrCode()	errno
Howard Chu's avatar
Howard Chu committed
164
165
166
167
168

	/** An abstraction for a file handle.
	 *	On POSIX systems file handles are small integers. On Windows
	 *	they're opaque pointers.
	 */
Howard Chu's avatar
Howard Chu committed
169
#define	HANDLE	int
Howard Chu's avatar
Howard Chu committed
170
171
172
173
174

	/**	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
175
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
176
177
178
179
180

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

Howard Chu's avatar
Howard Chu committed
184
185
186
187
#if defined(_WIN32) || defined(__APPLE__)
#define MNAME_LEN	32
#endif

188
/** @} */
Howard Chu's avatar
Howard Chu committed
189

190
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
191
192
193
194
195
196
/**	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
197
198
199
200
201
202
 * 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
203
204
#endif

Howard Chu's avatar
Howard Chu committed
205
206
207
208
209
210
211
212
	/** 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.
	 */
213
typedef ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
214

215
216
217
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
218
typedef ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
219

Howard Chu's avatar
Howard Chu committed
220
221
222
/** @defgroup debug	Debug Macros
 *	@{
 */
223
#ifndef DEBUG
Howard Chu's avatar
Howard Chu committed
224
225
226
227
	/**	Enable debug output.
	 *	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).
	 */
228
#define DEBUG 0
229
#endif
Howard Chu's avatar
Howard Chu committed
230

231
232
233
#if !(__STDC_VERSION__ >= 199901L || defined(__GNUC__))
# define DPRINTF	(void)	/* Vararg macros may be unsupported */
#elif DEBUG
Howard Chu's avatar
Howard Chu committed
234
235
	/**	Print a debug message with printf formatting. */
# define DPRINTF(fmt, ...)	/**< Requires 2 or more args */ \
236
	fprintf(stderr, "%s:%d " fmt "\n", __func__, __LINE__, __VA_ARGS__)
Howard Chu's avatar
Howard Chu committed
237
#else
238
# define DPRINTF(fmt, ...)	((void) 0)
Howard Chu's avatar
Howard Chu committed
239
#endif
Howard Chu's avatar
Howard Chu committed
240
241
242
	/**	Print a debug string.
	 *	The string is printed literally, with no format processing.
	 */
243
#define DPUTS(arg)	DPRINTF("%s", arg)
Howard Chu's avatar
Howard Chu committed
244
/** @} */
Howard Chu's avatar
Howard Chu committed
245

Howard Chu's avatar
Howard Chu committed
246
247
248
	/** A default memory page size.
	 *	The actual size is platform-dependent, but we use this for
	 *	boot-strapping. We probably should not be using this any more.
Hallvard Furuseth's avatar
Hallvard Furuseth committed
249
	 *	The #GET_PAGESIZE() macro is used to get the actual size.
Howard Chu's avatar
Howard Chu committed
250
251
252
253
254
255
256
257
	 *
	 *	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.
	 */
Howard Chu's avatar
Howard Chu committed
258
#define MDB_PAGESIZE	 4096
Howard Chu's avatar
Howard Chu committed
259
260
261
262
263
264
265
266
267
268
269
270
271

	/** 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
272
#define MDB_MINKEYS	 2
Howard Chu's avatar
Howard Chu committed
273
274
275
276
277

	/**	A stamp that identifies a file as an MDB file.
	 *	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
278
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
279
280

	/**	The version number for a database's file format. */
Howard Chu's avatar
Howard Chu committed
281
#define MDB_VERSION	 1
Howard Chu's avatar
Howard Chu committed
282
283
284
285

	/**	The maximum size of a key in the database.
	 *	While data items have essentially unbounded size, we require that
	 *	keys all fit onto a regular page. This limit could be raised a bit
Howard Chu's avatar
Howard Chu committed
286
	 *	further if needed; to something just under #MDB_PAGESIZE / #MDB_MINKEYS.
Howard Chu's avatar
Howard Chu committed
287
	 */
Howard Chu's avatar
Howard Chu committed
288
#define MAXKEYSIZE	 511
Howard Chu's avatar
Howard Chu committed
289

Howard Chu's avatar
Howard Chu committed
290
#if DEBUG
Howard Chu's avatar
Howard Chu committed
291
292
293
294
295
296
297
298
299
	/**	A key buffer.
	 *	@ingroup debug
	 *	This is used for printing a hex dump of a key's contents.
	 */
#define DKBUF	char kbuf[(MAXKEYSIZE*2+1)]
	/**	Display a key in hex.
	 *	@ingroup debug
	 *	Invoke a function to display a key in hex.
	 */
Howard Chu's avatar
Howard Chu committed
300
301
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
302
#define	DKBUF	typedef int dummy_kbuf	/* so we can put ';' after */
Howard Chu's avatar
Howard Chu committed
303
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
304
#endif
Howard Chu's avatar
Howard Chu committed
305

Howard Chu's avatar
Howard Chu committed
306
307
308
309
310
/**	@defgroup lazylock	Lazy Locking
 *	Macros for locks that are't actually needed.
 *	The DB view is always consistent because all writes are wrapped in
 *	the wmutex. Finer-grained locks aren't necessary.
 *	@{
Howard Chu's avatar
Howard Chu committed
311
312
 */
#ifndef	LAZY_LOCKS
Howard Chu's avatar
Howard Chu committed
313
	/**	Use lazy locking. I.e., don't lock these accesses at all. */
Howard Chu's avatar
Howard Chu committed
314
315
316
#define	LAZY_LOCKS	1
#endif
#if	LAZY_LOCKS
Howard Chu's avatar
Howard Chu committed
317
	/** Grab the reader lock */
Howard Chu's avatar
Howard Chu committed
318
#define	LAZY_MUTEX_LOCK(x)
Howard Chu's avatar
Howard Chu committed
319
	/** Release the reader lock */
Howard Chu's avatar
Howard Chu committed
320
#define	LAZY_MUTEX_UNLOCK(x)
Howard Chu's avatar
Howard Chu committed
321
	/** Release the DB table reader/writer lock */
Howard Chu's avatar
Howard Chu committed
322
#define	LAZY_RWLOCK_UNLOCK(x)
Howard Chu's avatar
Howard Chu committed
323
	/** Grab the DB table write lock */
Howard Chu's avatar
Howard Chu committed
324
#define	LAZY_RWLOCK_WRLOCK(x)
Howard Chu's avatar
Howard Chu committed
325
	/** Grab the DB table read lock */
Howard Chu's avatar
Howard Chu committed
326
#define	LAZY_RWLOCK_RDLOCK(x)
327
	/** Declare the DB table rwlock.  Should not be followed by ';'. */
Howard Chu's avatar
Howard Chu committed
328
#define	LAZY_RWLOCK_DEF(x)
Howard Chu's avatar
Howard Chu committed
329
	/** Initialize the DB table rwlock */
Howard Chu's avatar
Howard Chu committed
330
#define	LAZY_RWLOCK_INIT(x,y)
Howard Chu's avatar
Howard Chu committed
331
	/**	Destroy the DB table rwlock */
Howard Chu's avatar
Howard Chu committed
332
333
334
335
336
337
338
#define	LAZY_RWLOCK_DESTROY(x)
#else
#define	LAZY_MUTEX_LOCK(x)		pthread_mutex_lock(x)
#define	LAZY_MUTEX_UNLOCK(x)	pthread_mutex_unlock(x)
#define	LAZY_RWLOCK_UNLOCK(x)	pthread_rwlock_unlock(x)
#define	LAZY_RWLOCK_WRLOCK(x)	pthread_rwlock_wrlock(x)
#define	LAZY_RWLOCK_RDLOCK(x)	pthread_rwlock_rdlock(x)
339
#define	LAZY_RWLOCK_DEF(x)		pthread_rwlock_t	x;
Howard Chu's avatar
Howard Chu committed
340
341
342
#define	LAZY_RWLOCK_INIT(x,y)	pthread_rwlock_init(x,y)
#define	LAZY_RWLOCK_DESTROY(x)	pthread_rwlock_destroy(x)
#endif
Howard Chu's avatar
Howard Chu committed
343
/** @} */
Howard Chu's avatar
Howard Chu committed
344

Howard Chu's avatar
Howard Chu committed
345
346
347
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
348
#define P_INVALID	 (~0UL)
Howard Chu's avatar
Howard Chu committed
349

Howard Chu's avatar
Howard Chu committed
350
	/** Test if a flag \b f is set in a flag word \b w. */
Howard Chu's avatar
Howard Chu committed
351
352
#define F_ISSET(w, f)	 (((w) & (f)) == (f))

Howard Chu's avatar
Howard Chu committed
353
354
355
356
	/**	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
357
358
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
359
360
361
362
	/**	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
363
364
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
365
366
367
368
369
370
371
372
373
374
/**	@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.
 *
 *	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
375
376
 *	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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 *	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.
 *
 *	@todo We don't actually do such coalescing yet, we grab pages from one
 *	old transaction at a time.
 *	@{
 */
	/**	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
414
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
415
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
416
417
#endif

Howard Chu's avatar
Howard Chu committed
418
419
420
421
422
423
424
425
	/**	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
426
typedef struct MDB_rxbody {
Howard Chu's avatar
Howard Chu committed
427
428
429
430
431
432
433
	/**	The current Transaction ID when this transaction began.
	 *	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.
	 */
434
	txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
435
	/** The process ID of the process owning this reader txn. */
Howard Chu's avatar
Howard Chu committed
436
	pid_t		mrb_pid;
Howard Chu's avatar
Howard Chu committed
437
	/** The thread ID of the thread owning this txn. */
Howard Chu's avatar
Howard Chu committed
438
439
440
	pthread_t	mrb_tid;
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
441
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
442
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
443
444
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
445
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
446
447
448
#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
449
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
450
451
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
452
453
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
454
455
456
457
458
459
460
	/** 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
461
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
462
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
463
464
465
466
	 *	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
467
	 */
Howard Chu's avatar
Howard Chu committed
468
typedef struct MDB_txbody {
Howard Chu's avatar
Howard Chu committed
469
470
		/** Stamp identifying this as an MDB lock file. It must be set
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
471
	uint32_t	mtb_magic;
Howard Chu's avatar
Howard Chu committed
472
		/** Version number of this lock file. Must be set to #MDB_VERSION. */
Howard Chu's avatar
Howard Chu committed
473
	uint32_t	mtb_version;
Howard Chu's avatar
Howard Chu committed
474
475
#if defined(_WIN32) || defined(__APPLE__)
	char	mtb_rmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
476
#else
Howard Chu's avatar
Howard Chu committed
477
478
479
		/** Mutex protecting access to this table.
		 *	This is the reader lock that #LOCK_MUTEX_R acquires.
		 */
Howard Chu's avatar
Howard Chu committed
480
	pthread_mutex_t	mtb_mutex;
Howard Chu's avatar
Howard Chu committed
481
#endif
Howard Chu's avatar
Howard Chu committed
482
483
484
485
		/**	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.
		 */
486
	txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
487
488
489
490
		/** 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.
		 */
491
	unsigned	mtb_numreaders;
Howard Chu's avatar
Howard Chu committed
492
493
494
495
		/**	The ID of the most recent meta page in the database.
		 *	This is recorded here only for convenience; the value can always
		 *	be determined by reading the main database meta pages.
		 */
Howard Chu's avatar
Howard Chu committed
496
	uint32_t	mtb_me_toggle;
Howard Chu's avatar
Howard Chu committed
497
498
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
499
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
500
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
501
502
503
504
505
	union {
		MDB_txbody mtb;
#define mti_magic	mt1.mtb.mtb_magic
#define mti_version	mt1.mtb.mtb_version
#define mti_mutex	mt1.mtb.mtb_mutex
Howard Chu's avatar
Howard Chu committed
506
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
507
508
#define mti_txnid	mt1.mtb.mtb_txnid
#define mti_numreaders	mt1.mtb.mtb_numreaders
Howard Chu's avatar
Howard Chu committed
509
#define mti_me_toggle	mt1.mtb.mtb_me_toggle
Howard Chu's avatar
Howard Chu committed
510
511
512
		char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mt1;
	union {
Howard Chu's avatar
Howard Chu committed
513
514
#if defined(_WIN32) || defined(__APPLE__)
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
515
516
#define	mti_wmname	mt2.mt2_wmname
#else
Howard Chu's avatar
Howard Chu committed
517
518
		pthread_mutex_t	mt2_wmutex;
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
519
#endif
Howard Chu's avatar
Howard Chu committed
520
521
522
		char pad[(sizeof(pthread_mutex_t)+CACHELINE-1) & ~(CACHELINE-1)];
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
523
} MDB_txninfo;
Howard Chu's avatar
Howard Chu committed
524
/** @} */
Howard Chu's avatar
Howard Chu committed
525

Howard Chu's avatar
Howard Chu committed
526
/** Common header for all page types.
Howard Chu's avatar
Howard Chu committed
527
 * Overflow records occupy a number of contiguous pages with no
Howard Chu's avatar
Howard Chu committed
528
529
 * headers on any page after the first.
 */
Howard Chu's avatar
Howard Chu committed
530
typedef struct MDB_page {
531
532
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
533
	union {
534
535
536
		pgno_t		p_pgno;	/**< page number */
		void *		p_next;	/**< for in-memory list of freed structs */
	} mp_p;
Howard Chu's avatar
Howard Chu committed
537
	uint16_t	mp_pad;
Howard Chu's avatar
Howard Chu committed
538
539
540
541
542
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
543
544
545
546
547
548
#define	P_BRANCH	 0x01		/**< branch page */
#define	P_LEAF		 0x02		/**< leaf page */
#define	P_OVERFLOW	 0x04		/**< overflow page */
#define	P_META		 0x08		/**< meta page */
#define	P_DIRTY		 0x10		/**< dirty page */
#define	P_LEAF2		 0x20		/**< for #MDB_DUPFIXED records */
Howard Chu's avatar
Howard Chu committed
549
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
550
/** @} */
Howard Chu's avatar
Howard Chu committed
551
	uint16_t	mp_flags;		/**< @ref mdb_page */
552
553
554
#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
555
	union {
Howard Chu's avatar
Howard Chu committed
556
		struct {
557
558
559
560
561
			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
562
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
563
564
} MDB_page;

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

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

	/** Number of nodes on a page */
Howard Chu's avatar
Howard Chu committed
572
#define NUMKEYS(p)	 (((p)->mp_lower - PAGEHDRSZ) >> 1)
Howard Chu's avatar
Howard Chu committed
573
574

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
578
579
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
580
581
582
583
584
585
	/** 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
586
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
587
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
588
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
589
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
590
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
591
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
592
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
593
594
	/** 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
595

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

Howard Chu's avatar
Howard Chu committed
599
600
601
602
603
604
	/** Header for a single key/data pair within a page.
	 * We guarantee 2-byte alignment for nodes.
	 */
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
605
	 * is also used for pgno. (Branch nodes have no flags).
Howard Chu's avatar
Howard Chu committed
606
	 * They are in host byte order in case that lets some
607
	 * accesses be optimized into a 32-bit word access.
Howard Chu's avatar
Howard Chu committed
608
	 */
Howard Chu's avatar
Howard Chu committed
609
610
#define mn_lo mn_offset[BYTE_ORDER!=LITTLE_ENDIAN]
#define mn_hi mn_offset[BYTE_ORDER==LITTLE_ENDIAN] /**< part of dsize or pgno */
Howard Chu's avatar
Howard Chu committed
611
612
613
614
615
616
	unsigned short	mn_offset[2];	/**< storage for #mn_lo and #mn_hi */
/** @defgroup mdb_node Node Flags
 *	@ingroup internal
 *	Flags for node headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
617
618
619
#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
620
621

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

Howard Chu's avatar
Howard Chu committed
624
625
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
626
627
628
629
630
631
632
	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)

633
634
635
	/** 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
636
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
637
638
639
640
	 *	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
641
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
642
643
644
645
	 *	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
646
	/** Address of node \b i in page \b p */
Howard Chu's avatar
Howard Chu committed
647
648
649
650
651
652
653
654
655
#define NODEPTR(p, i)	 ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i]))

	/** 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 */
656
657
658
#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
659
660
661
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
662
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
663
664
665
666
667
668
669
670
671

	/** 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
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
	/** 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
696
697
698
699
700
701
702
	/** 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)))

	/** Set the \b node's key into \b key, if requested. */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
703
704
#define MDB_SET_KEY(node, key)	{ if ((key) != NULL) { \
	(key)->mv_size = NODEKSZ(node); (key)->mv_data = NODEKEY(node); } }
Howard Chu's avatar
Howard Chu committed
705
706

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
707
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
708
709
710
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
	uint16_t	md_flags;	/**< @ref mdb_open */
	uint16_t	md_depth;	/**< depth of this tree */
711
712
713
714
	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
715
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
716
717
} MDB_db;

Howard Chu's avatar
Howard Chu committed
718
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
719
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
720
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
721
722
#define	MAIN_DBI	1

Howard Chu's avatar
Howard Chu committed
723
724
725
726
	/** Meta page content. */
typedef struct MDB_meta {
		/** Stamp identifying this as an MDB data file. It must be set
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
727
	uint32_t	mm_magic;
Howard Chu's avatar
Howard Chu committed
728
		/** Version number of this lock file. Must be set to #MDB_VERSION. */
Howard Chu's avatar
Howard Chu committed
729
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
730
731
732
733
	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
734
#define	mm_psize	mm_dbs[0].md_pad
Howard Chu's avatar
Howard Chu committed
735
	/** Any persistent environment flags. @ref mdb_env */
Howard Chu's avatar
Howard Chu committed
736
#define	mm_flags	mm_dbs[0].md_flags
Howard Chu's avatar
Howard Chu committed
737
	pgno_t		mm_last_pg;			/**< last used page in file */
738
	txnid_t		mm_txnid;			/**< txnid that committed this page */
Howard Chu's avatar
Howard Chu committed
739
740
} MDB_meta;

Howard Chu's avatar
Howard Chu committed
741
742
743
744
745
746
747
748
749
	/** 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 */
750
	void		*md_relctx;		/**< user-provided context for md_rel */
Howard Chu's avatar
Howard Chu committed
751
} MDB_dbx;
Howard Chu's avatar
Howard Chu committed
752

Howard Chu's avatar
Howard Chu committed
753
754
755
756
	/** A database transaction.
	 *	Every operation requires a transaction handle.
	 */
struct MDB_txn {
757
758
	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
759
760
761
762
763
	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.
	 */
764
	txnid_t		mt_txnid;
Howard Chu's avatar
Howard Chu committed
765
766
767
	MDB_env		*mt_env;		/**< the DB environment */
	/** The list of pages that became unused during this transaction.
	 */
Howard Chu's avatar
Howard Chu committed
768
	IDL			mt_free_pgs;
Howard Chu's avatar
Howard Chu committed
769
770
771
772
773
774
775
776
	union {
		ID2L	dirty_list;	/**< modified pages */
		MDB_reader	*reader;	/**< this thread's slot in the reader table */
	} 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;
Howard Chu's avatar
Howard Chu committed
777
778
779
780
781
782
783
/** @defgroup mt_dbflag	Transaction DB Flags
 *	@ingroup internal
 * @{
 */
#define DB_DIRTY	0x01		/**< DB was written in this txn */
#define DB_STALE	0x02		/**< DB record is older than txnID */
/** @} */
Howard Chu's avatar
Howard Chu committed
784
785
	/** Array of cursors for each DB */
	MDB_cursor	**mt_cursors;
Howard Chu's avatar
Howard Chu committed
786
787
	/** Array of flags for each DB */
	unsigned char	*mt_dbflags;
Howard Chu's avatar
Howard Chu committed
788
789
790
	/**	Number of DB records in use. This number only ever increments;
	 *	we don't decrement it when individual DB handles are closed.
	 */
791
	MDB_dbi		mt_numdbs;
Howard Chu's avatar
Howard Chu committed
792

Howard Chu's avatar
Howard Chu committed
793
794
795
796
/** @defgroup mdb_txn	Transaction Flags
 *	@ingroup internal
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
797
798
#define MDB_TXN_RDONLY		0x01		/**< read-only transaction */
#define MDB_TXN_ERROR		0x02		/**< an error has occurred */
Howard Chu's avatar
Howard Chu committed
799
800
/** @} */
	unsigned int	mt_flags;		/**< @ref mdb_txn */
Howard Chu's avatar
Howard Chu committed
801
802
803
804
805
	/** Tracks which of the two meta pages was used at the start
	 * 	of this transaction.
	 */
	unsigned int	mt_toggle;
};
Howard Chu's avatar
Howard Chu committed
806

Howard Chu's avatar
Howard Chu committed
807
/** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
808
809
810
 * 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
811
#define CURSOR_STACK		 32
Howard Chu's avatar
Howard Chu committed
812

Howard Chu's avatar
Howard Chu committed
813
struct MDB_xcursor;
814

Howard Chu's avatar
Howard Chu committed
815
	/** Cursors are used for all DB operations */
Howard Chu's avatar
Howard Chu committed
816
struct MDB_cursor {
Howard Chu's avatar
Howard Chu committed
817
818
819
820
	/** Next cursor on this DB in this txn */
	MDB_cursor	*mc_next;
	/** Original cursor if this is a shadow */
	MDB_cursor	*mc_orig;
Howard Chu's avatar
Howard Chu committed
821
	/** Context used for databases with #MDB_DUPSORT, otherwise NULL */
Howard Chu's avatar
Howard Chu committed
822
	struct MDB_xcursor	*mc_xcursor;
Howard Chu's avatar
Howard Chu committed
823
	/** The transaction that owns this cursor */
Howard Chu's avatar
Howard Chu committed
824
	MDB_txn		*mc_txn;
Howard Chu's avatar
Howard Chu committed
825
	/** The database handle this cursor operates on */
Howard Chu's avatar
Howard Chu committed
826
	MDB_dbi		mc_dbi;
827
828
829
830
	/** 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
831
832
	/** The @ref mt_dbflag for this database */
	unsigned char	*mc_dbflag;
Howard Chu's avatar
Howard Chu committed
833
834
	unsigned short 	mc_snum;	/**< number of pushed pages */
	unsigned short	mc_top;		/**< index of top page, mc_snum-1 */
Howard Chu's avatar
Howard Chu committed
835
836
837
838
839
/** @defgroup mdb_cursor	Cursor Flags
 *	@ingroup internal
 *	Cursor state flags.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
840
841
#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
842
#define C_SUB	0x04			/**< Cursor is a sub-cursor */
Howard Chu's avatar
Howard Chu committed
843
844
#define C_SHADOW	0x08		/**< Cursor is a dup from a parent txn */
#define C_ALLOCD	0x10		/**< Cursor was malloc'd */
Howard Chu's avatar
Howard Chu committed
845
846
/** @} */
	unsigned int	mc_flags;	/**< @ref mdb_cursor */
Howard Chu's avatar
Howard Chu committed
847
848
	MDB_page	*mc_pg[CURSOR_STACK];	/**< stack of pushed pages */
	indx_t		mc_ki[CURSOR_STACK];	/**< stack of page indices */
Howard Chu's avatar
Howard Chu committed
849
850
};

Howard Chu's avatar
Howard Chu committed
851
852
853
854
	/** Context for sorted-dup records.
	 *	We could have gone to a fully recursive design, with arbitrarily
	 *	deep nesting of sub-databases. But for now we only handle these
	 *	levels - main DB, optional sub-DB, sorted-duplicate DB.
855
	 */
Howard Chu's avatar
Howard Chu committed
856
typedef struct MDB_xcursor {
Howard Chu's avatar
Howard Chu committed
857
	/** A sub-cursor for traversing the Dup DB */
Howard Chu's avatar
Howard Chu committed
858
	MDB_cursor mx_cursor;
859
860
861
862
	/** The database record for this Dup DB */
	MDB_db	mx_db;
	/**	The auxiliary DB record for this Dup DB */
	MDB_dbx	mx_dbx;
Howard Chu's avatar
Howard Chu committed
863
864
	/** The @ref mt_dbflag for this Dup DB */
	unsigned char mx_dbflag;
Howard Chu's avatar
Howard Chu committed
865
866
} MDB_xcursor;

Howard Chu's avatar
Howard Chu committed
867
868
869
870
871
872
873
	/** A set of pages freed by an earlier transaction. */
typedef struct MDB_oldpages {
	/** Usually we only read one record from the FREEDB at a time, but
	 *	in case we read more, this will chain them together.
	 */
	struct MDB_oldpages *mo_next;
	/**	The ID of the transaction in which these pages were freed. */
874
	txnid_t		mo_txnid;
Howard Chu's avatar
Howard Chu committed
875
876
877
878
879
	/** An #IDL of the pages */
	pgno_t		mo_pages[1];	/* dynamic */
} MDB_oldpages;

	/** The database environment. */
Howard Chu's avatar
Howard Chu committed
880
struct MDB_env {
Howard Chu's avatar
Howard Chu committed
881
882
883
	HANDLE		me_fd;		/**< The main data file */
	HANDLE		me_lfd;		/**< The lock file */
	HANDLE		me_mfd;			/**< just for writing the meta pages */
Howard Chu's avatar
Howard Chu committed
884
	/** Failed to update the meta page. Probably an I/O error. */
Howard Chu's avatar
Howard Chu committed
885
#define	MDB_FATAL_ERROR	0x80000000U
Howard Chu's avatar
Howard Chu committed
886
	uint32_t 	me_flags;		/**< @ref mdb_env */
Howard Chu's avatar
Howard Chu committed
887
888
	uint32_t	me_extrapad;	/**< unused for now */
	unsigned int	me_maxreaders;	/**< size of the reader table */
889
890
	MDB_dbi		me_numdbs;		/**< number of DBs opened */
	MDB_dbi		me_maxdbs;		/**< size of the DB table */
Howard Chu's avatar
Howard Chu committed
891
892
893
894
895
896
897
898
	char		*me_path;		/**< path to the DB files */
	char		*me_map;		/**< the memory map of the data file */
	MDB_txninfo	*me_txns;		/**< the memory map of the lock file */
	MDB_meta	*me_metas[2];	/**< pointers to the two meta pages */
	MDB_txn		*me_txn;		/**< current write transaction */
	size_t		me_mapsize;		/**< size of the data memory map */
	off_t		me_size;		/**< current file size */
	pgno_t		me_maxpg;		/**< me_mapsize / me_psize */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
899
	unsigned int	me_psize;	/**< size of a page, from #GET_PAGESIZE */
Howard Chu's avatar
Howard Chu committed
900
	unsigned int	me_db_toggle;	/**< which DB table is current */
Howard Chu's avatar
Howard Chu committed
901
	txnid_t		me_wtxnid;		/**< ID of last txn we committed */
Howard Chu's avatar
Howard Chu committed
902
903
904
905
906
907
	MDB_dbx		*me_dbxs;		/**< array of static DB info */
	MDB_db		*me_dbs[2];		/**< two arrays of MDB_db info */
	MDB_oldpages *me_pghead;	/**< list of old page records */
	pthread_key_t	me_txkey;	/**< thread-key for readers */
	MDB_page	*me_dpages;		/**< list of malloc'd blocks for re-use */
	/** IDL of pages that became unused in a write txn */
Howard Chu's avatar
Howard Chu committed
908
	IDL			me_free_pgs;
Howard Chu's avatar
Howard Chu committed
909
	/** ID2L of pages that were written during a write txn */
Howard Chu's avatar
Howard Chu committed
910
	ID2			me_dirty_list[MDB_IDL_UM_SIZE];
Howard Chu's avatar
Howard Chu committed
911
	/** rwlock for the DB tables, if #LAZY_LOCKS is false */
912
	LAZY_RWLOCK_DEF(me_dblock)
Howard Chu's avatar
Howard Chu committed
913
914
915
916
#ifdef _WIN32
	HANDLE		me_rmutex;		/* Windows mutexes don't reside in shared mem */
	HANDLE		me_wmutex;
#endif
Howard Chu's avatar
Howard Chu committed
917
918
919
920
#ifdef __APPLE__
	sem_t		*me_rmutex;		/* Apple doesn't support shared mutexes */
	sem_t		*me_wmutex;
#endif
Howard Chu's avatar
Howard Chu committed
921
};
Howard Chu's avatar
Howard Chu committed
922
923
	/** max number of pages to commit in one writev() call */
#define MDB_COMMIT_PAGES	 64
Howard Chu's avatar
Howard Chu committed
924

Howard Chu's avatar
Howard Chu committed
925
static MDB_page *mdb_page_alloc(MDB_cursor *mc, int num);
Howard Chu's avatar
Howard Chu committed
926
static MDB_page *mdb_page_new(MDB_cursor *mc, uint32_t flags, int num);
Howard Chu's avatar
Howard Chu committed
927
static int 		mdb_page_touch(MDB_cursor *mc);
Howard Chu's avatar
Howard Chu committed
928

Howard Chu's avatar
Howard Chu committed
929
static int  mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp);
Howard Chu's avatar
Howard Chu committed
930
static int  mdb_page_search_root(MDB_cursor *mc,
931
			    MDB_val *key, int modify);
Howard Chu's avatar
Howard Chu committed
932
static int  mdb_page_search(MDB_cursor *mc,
933
			    MDB_val *key, int modify);
Howard Chu's avatar
Howard Chu committed
934
935
static int	mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
static int	mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
Howard Chu's avatar
Howard Chu committed
936
				pgno_t newpgno, unsigned int nflags);
Howard Chu's avatar
Howard Chu committed
937

Howard Chu's avatar
Howard Chu committed
938
939
940
static int  mdb_env_read_header(MDB_env *env, MDB_meta *meta);
static int  mdb_env_read_meta(MDB_env *env, int *which);
static int  mdb_env_write_meta(MDB_txn *txn);
Howard Chu's avatar
Howard Chu committed
941

Howard Chu's avatar
Howard Chu committed
942
943
static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
static int  mdb_node_add(MDB_cursor *mc, indx_t indx,
Howard Chu's avatar
Howard Chu committed
944
			    MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
Howard Chu's avatar
Howard Chu committed
945
static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
Howard Chu's avatar
Howard Chu committed
946
static void mdb_node_shrink(MDB_page *mp, indx_t indx);
Howard Chu's avatar
Howard Chu committed
947
static int	mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
Howard Chu's avatar
Howard Chu committed
948
static int  mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
Howard Chu's avatar
Howard Chu committed
949
950
static size_t	mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
static size_t	mdb_branch_size(MDB_env *env, MDB_val *key);
Howard Chu's avatar
Howard Chu committed
951

952
static int	mdb_rebalance(MDB_cursor *mc);
Howard Chu's avatar
Howard Chu committed
953
static int	mdb_update_key(MDB_page *mp, indx_t indx, MDB_val *key);
954

Howard Chu's avatar
Howard Chu committed
955
956
static void	mdb_cursor_pop(MDB_cursor *mc);
static int	mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
957

Howard Chu's avatar
Howard Chu committed
958
static int	mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
Howard Chu's avatar
Howard Chu committed
959
static int	mdb_cursor_sibling(MDB_cursor *mc, int move_right);
960
961
962
963
964
965
static int	mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
static int	mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
static int	mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
				int *exactp);
static int	mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
static int	mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
Howard Chu's avatar
Howard Chu committed
966

Howard Chu's avatar
Howard Chu committed
967
static void	mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
Howard Chu's avatar
Howard Chu committed
968
static void	mdb_xcursor_init0(MDB_cursor *mc);
969
static void	mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
Howard Chu's avatar
Howard Chu committed
970

Howard Chu's avatar
Howard Chu committed
971
static int	mdb_drop0(MDB_cursor *mc, int subs);
Howard Chu's avatar
Howard Chu committed
972
973
static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);

Howard Chu's avatar
Howard Chu committed
974
/** @cond */
Howard Chu's avatar
Howard Chu committed
975
static MDB_cmp_func	mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
Howard Chu's avatar
Howard Chu committed
976
/** @endcond */
Howard Chu's avatar
Howard Chu committed
977

Howard Chu's avatar
Howard Chu committed
978
979
980
981
982
983
#ifdef _WIN32
static SECURITY_DESCRIPTOR mdb_null_sd;
static SECURITY_ATTRIBUTES mdb_all_sa;
static int mdb_sec_inited;
#endif

Howard Chu's avatar
Howard Chu committed
984
/** Return the library version info. */
Howard Chu's avatar
Howard Chu committed
985
char *
Howard Chu's avatar
Howard Chu committed
986
mdb_version(int *major, int *minor, int *patch)
Howard Chu's avatar
Howard Chu committed
987
{
Howard Chu's avatar
Howard Chu committed
988
989
990
	if (major) *major = MDB_VERSION_MAJOR;
	if (minor) *minor = MDB_VERSION_MINOR;
	if (patch) *patch = MDB_VERSION_PATCH;
Howard Chu's avatar
Howard Chu committed
991
992
993
	return MDB_VERSION_STRING;
}

Howard Chu's avatar
Howard Chu committed
994
/** Table of descriptions for MDB @ref errors */
Howard Chu's avatar
Howard Chu committed
995
static char *const mdb_errstr[] = {
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
	"MDB_KEYEXIST: Key/data pair already exists",
	"MDB_NOTFOUND: No matching key/data pair found",
	"MDB_PAGE_NOTFOUND: Requested page not found",
	"MDB_CORRUPTED: Located page was wrong type",
	"MDB_PANIC: Update of meta page failed",
	"MDB_VERSION_MISMATCH: Database environment version mismatch"
};

char *
mdb_strerror(int err)
{
	if (!err)
		return ("Successful return: 0");

	if (err >= MDB_KEYEXIST && err <= MDB_VERSION_MISMATCH)
Howard Chu's avatar
Howard Chu committed
1011
		return mdb_errstr[err - MDB_KEYEXIST];
1012
1013
1014
1015

	return strerror(err);
}

1016
#if DEBUG
Howard Chu's avatar
Howard Chu committed
1017
1018
1019
1020
1021
/** Display a key in hexadecimal and return the address of the result.
 * @param[in] key the key to display
 * @param[in] buf the buffer to write into. Should always be #DKBUF.
 * @return The key in hexadecimal form.
 */
1022
char *
Howard Chu's avatar
Howard Chu committed
1023
1024
1025
1026
1027
1028
1029
mdb_dkey(MDB_val *key, char *buf)
{
	char *ptr = buf;
	unsigned char *c = key->mv_data;
	unsigned int i;
	if (key->mv_size > MAXKEYSIZE)
		return "MAXKEYSIZE";
Howard Chu's avatar
Howard Chu committed
1030
1031
1032
	/* may want to make this a dynamic check: if the key is mostly
	 * printable characters, print it as-is instead of converting to hex.
	 */
1033
#if 1
Howard Chu's avatar
Howard Chu committed
1034
1035
	for (i=0; i<key->mv_size; i++)
		ptr += sprintf(ptr, "%02x", *c++);
Howard Chu's avatar
Howard Chu committed
1036
1037
1038
#else
	sprintf(buf, "%.*s", key->mv_size, key->mv_data);
#endif
Howard Chu's avatar
Howard Chu committed
1039
1040
	return buf;
}
1041
#endif
Howard Chu's avatar
Howard Chu committed
1042

Howard Chu's avatar
Howard Chu committed
1043
int
Howard Chu's avatar
Howard Chu committed
1044
mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
Howard Chu's avatar
Howard Chu committed
1045
{
Howard Chu's avatar
Howard Chu committed
1046
	return txn->mt_dbxs[dbi].md_cmp(a, b);
Howard Chu's avatar
Howard Chu committed
1047
1048
1049
1050
1051
1052
1053
}

int
mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
{
	if (txn->mt_dbxs[dbi].md_dcmp)
		return txn->mt_dbxs[dbi].md_dcmp(a, b);
Howard Chu's avatar
Howard Chu committed
1054
	else
Howard Chu's avatar
Howard Chu committed
1055
		return EINVAL;	/* too bad you can't distinguish this from a valid result */
Howard Chu's avatar
Howard Chu committed
1056
1057
}

1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
/** Allocate a single page.
 * Re-use old malloc'd pages first, otherwise just malloc.
 */
static MDB_page *
mdb_page_malloc(MDB_cursor *mc) {
	MDB_page *ret;
	if (mc->mc_txn->mt_env->me_dpages) {
		ret = mc->mc_txn->mt_env->me_dpages;
		mc->mc_txn->mt_env->me_dpages = ret->mp_next;
	} else {
		ret = malloc(mc->mc_txn->mt_env->me_psize);
	}
	return ret;
}

Howard Chu's avatar
Howard Chu committed
1073
1074
1075
1076
1077
1078
1079
1080
1081
/** Allocate pages for writing.
 * If there are free pages available from older transactions, they
 * will be re-used first. Otherwise a new page will be allocated.
 * @param[in] mc cursor A cursor handle identifying the transaction and
 *	database for which we are allocating.
 * @param[in] num the number of pages to allocate.
 * @return Address of the allocated page(s). Requests for multiple pages
 *  will always be satisfied by a single contiguous chunk of memory.
 */
1082
static MDB_page *
Howard Chu's avatar
Howard Chu committed
1083
mdb_page_alloc(MDB_cursor *mc, int num)
Howard Chu's avatar
Howard Chu committed
1084
{
1085
1086
	MDB_txn *txn = mc->mc_txn;
	MDB_page *np;
Howard Chu's avatar
Howard Chu committed
1087
	pgno_t pgno = P_INVALID;
1088
	ID2 mid;
Howard Chu's avatar
Howard Chu committed
1089

Howard Chu's avatar
Howard Chu committed
1090
1091
	if (txn->mt_txnid > 2) {

1092
		if (!txn->mt_env->me_pghead && mc->mc_dbi != FREE_DBI &&
Howard Chu's avatar
Howard Chu committed
1093
1094
			txn->mt_dbs[FREE_DBI].md_root != P_INVALID) {
			/* See if there's anything in the free DB */
1095
			MDB_cursor m2;
Howard Chu's avatar
Howard Chu committed
1096
			MDB_node *leaf;
1097
			txnid_t *kptr, oldest;
Howard Chu's avatar
Howard Chu committed
1098

Howard Chu's avatar
Howard Chu committed
1099
			mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
Howard Chu's avatar
Howard Chu committed
1100
			mdb_page_search(&m2, NULL, 0);
1101
			leaf = NODEPTR(m2.mc_pg[m2.mc_top], 0);
1102
			kptr = (txnid_t *)NODEKEY(leaf);
Howard Chu's avatar
Howard Chu committed
1103

Howard Chu's avatar
Howard Chu committed
1104
1105
			{
				unsigned int i;
Howard Chu's avatar
Howard Chu committed
1106
1107
				oldest = txn->mt_txnid - 1;
				for (i=0; i<txn->mt_env->me_txns->mti_numreaders; i++) {
1108
					txnid_t mr = txn->mt_env->me_txns->mti_readers[i].mr_txnid;
Howard Chu's avatar
Howard Chu committed
1109
1110
					if (mr && mr < oldest)