mdb.c 204 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
/*
Howard Chu's avatar
Howard Chu committed
8
 * Copyright 2011-2013 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
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
41
42
43
#ifdef _WIN32
#include <windows.h>
#else
Howard Chu's avatar
Howard Chu committed
44
45
46
47
48
#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
49
#include <fcntl.h>
Howard Chu's avatar
Howard Chu committed
50
#endif
Howard Chu's avatar
Howard Chu committed
51
52
53

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

63
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
64
#include <netinet/in.h>
65
66
67
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

68
#if defined(__APPLE__) || defined (BSD)
69
70
71
72
# define MDB_USE_POSIX_SEM	1
# define MDB_FDATASYNC		fsync
#elif defined(ANDROID)
# define MDB_FDATASYNC		fsync
73
74
#endif

75
76
#ifndef _WIN32
#include <pthread.h>
77
#ifdef MDB_USE_POSIX_SEM
Howard Chu's avatar
Howard Chu committed
78
79
80
81
#include <semaphore.h>
#endif
#endif

82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#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
97
#ifndef BYTE_ORDER
Howard Chu's avatar
Howard Chu committed
98
99
100
101
102
103
104
105
106
107
108
109
# 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
110
#endif
Howard Chu's avatar
Howard Chu committed
111

Howard Chu's avatar
Howard Chu committed
112
113
114
115
116
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
117
118
#endif

Howard Chu's avatar
Howard Chu committed
119
#if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
Howard Chu's avatar
Howard Chu committed
120
121
122
#define MISALIGNED_OK	1
#endif

Howard Chu's avatar
Howard Chu committed
123
#include "lmdb.h"
124
125
#include "midl.h"

Howard Chu's avatar
Howard Chu committed
126
127
#if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
# error "Unknown or unsupported endianness (BYTE_ORDER)"
128
129
130
131
#elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
# error "Two's complement, reasonably sized integer types, please"
#endif

132
133
134
135
/** @defgroup internal	MDB Internals
 *	@{
 */
/** @defgroup compat	Windows Compatibility Macros
Howard Chu's avatar
Howard Chu committed
136
137
138
139
 *	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.
140
141
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
142
143
144
145
146
#ifdef _WIN32
#define pthread_t	DWORD
#define pthread_mutex_t	HANDLE
#define pthread_key_t	DWORD
#define pthread_self()	GetCurrentThreadId()
147
148
#define pthread_key_create(x,y)	\
	((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
Howard Chu's avatar
Howard Chu committed
149
150
#define pthread_key_delete(x)	TlsFree(x)
#define pthread_getspecific(x)	TlsGetValue(x)
151
#define pthread_setspecific(x,y)	(TlsSetValue(x,y) ? 0 : ErrCode())
Howard Chu's avatar
Howard Chu committed
152
153
#define pthread_mutex_unlock(x)	ReleaseMutex(x)
#define pthread_mutex_lock(x)	WaitForSingleObject(x, INFINITE)
Hallvard Furuseth's avatar
Hallvard Furuseth committed
154
155
156
157
#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
158
#define getpid()	GetCurrentProcessId()
159
#define	MDB_FDATASYNC(fd)	(!FlushFileBuffers(fd))
160
#define	MDB_MSYNC(addr,len,flags)	(!FlushViewOfFile(addr,len))
Howard Chu's avatar
Howard Chu committed
161
#define	ErrCode()	GetLastError()
Hallvard Furuseth's avatar
Hallvard Furuseth committed
162
#define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
Howard Chu's avatar
Howard Chu committed
163
164
#define	close(fd)	CloseHandle(fd)
#define	munmap(ptr,len)	UnmapViewOfFile(ptr)
Howard Chu's avatar
Howard Chu committed
165
#else
166

167
#ifdef MDB_USE_POSIX_SEM
168
169

#define LOCK_MUTEX_R(env)	mdb_sem_wait((env)->me_rmutex)
Howard Chu's avatar
Howard Chu committed
170
#define UNLOCK_MUTEX_R(env)	sem_post((env)->me_rmutex)
171
#define LOCK_MUTEX_W(env)	mdb_sem_wait((env)->me_wmutex)
Howard Chu's avatar
Howard Chu committed
172
#define UNLOCK_MUTEX_W(env)	sem_post((env)->me_wmutex)
173
174
175
176
177
178
179
180
181

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

Howard Chu's avatar
Howard Chu committed
182
#else
Howard Chu's avatar
Howard Chu committed
183
184
	/** Lock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
185
#define LOCK_MUTEX_R(env)	pthread_mutex_lock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
186
187
	/** Unlock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
188
#define UNLOCK_MUTEX_R(env)	pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
189
190
191
192
193

	/** 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
194
#define LOCK_MUTEX_W(env)	pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
Howard Chu's avatar
Howard Chu committed
195
196
	/** Unlock the writer mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
197
#define UNLOCK_MUTEX_W(env)	pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
198
#endif	/* MDB_USE_POSIX_SEM */
Howard Chu's avatar
Howard Chu committed
199
200
201

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

204
205
206
207
208
209
	/** 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
210
211
212
213
	/**	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
214
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
215
216
217
218
219

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

223
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
224
#define MNAME_LEN	32
225
226
#else
#define MNAME_LEN	(sizeof(pthread_mutex_t))
Howard Chu's avatar
Howard Chu committed
227
228
#endif

229
/** @} */
Howard Chu's avatar
Howard Chu committed
230

231
#ifndef _WIN32
Howard Chu's avatar
Howard Chu committed
232
233
234
235
236
237
/**	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
238
239
240
241
242
243
 * 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
244
245
246
247
248
249
250
#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
251
252
253
254
255
256
257
258
259
260
261
262
#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
263
264
#endif

Howard Chu's avatar
Howard Chu committed
265
266
267
268
269
270
271
272
	/** 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.
	 */
273
typedef MDB_ID	pgno_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
274

275
276
277
	/** A transaction ID.
	 *	See struct MDB_txn.mt_txnid for details.
	 */
278
typedef MDB_ID	txnid_t;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
279

Howard Chu's avatar
Howard Chu committed
280
281
282
/** @defgroup debug	Debug Macros
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
283
#ifndef MDB_DEBUG
Howard Chu's avatar
Howard Chu committed
284
285
286
287
	/**	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).
	 */
Howard Chu's avatar
Howard Chu committed
288
#define MDB_DEBUG 0
289
#endif
Howard Chu's avatar
Howard Chu committed
290

291
#if !(__STDC_VERSION__ >= 199901L || defined(__GNUC__))
292
293
# undef  MDB_DEBUG
# define MDB_DEBUG	0
294
# define DPRINTF	(void)	/* Vararg macros may be unsupported */
Howard Chu's avatar
Howard Chu committed
295
#elif MDB_DEBUG
296
static int mdb_debug;
297
static txnid_t mdb_debug_start;
298

Howard Chu's avatar
Howard Chu committed
299
300
	/**	Print a debug message with printf formatting. */
# define DPRINTF(fmt, ...)	/**< Requires 2 or more args */ \
301
302
	((void) ((mdb_debug) && \
	 fprintf(stderr, "%s:%d " fmt "\n", __func__, __LINE__, __VA_ARGS__)))
Howard Chu's avatar
Howard Chu committed
303
#else
304
# define DPRINTF(fmt, ...)	((void) 0)
305
# define MDB_DEBUG_SKIP
Howard Chu's avatar
Howard Chu committed
306
#endif
Howard Chu's avatar
Howard Chu committed
307
308
309
	/**	Print a debug string.
	 *	The string is printed literally, with no format processing.
	 */
310
#define DPUTS(arg)	DPRINTF("%s", arg)
Howard Chu's avatar
Howard Chu committed
311
/** @} */
Howard Chu's avatar
Howard Chu committed
312

Howard Chu's avatar
Howard Chu committed
313
314
315
	/** 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
316
	 *	The #GET_PAGESIZE() macro is used to get the actual size.
Howard Chu's avatar
Howard Chu committed
317
318
319
320
321
322
323
324
	 *
	 *	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
325
#define MDB_PAGESIZE	 4096
Howard Chu's avatar
Howard Chu committed
326
327
328
329
330
331
332
333
334
335
336
337
338

	/** 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
339
#define MDB_MINKEYS	 2
Howard Chu's avatar
Howard Chu committed
340
341
342
343
344

	/**	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
345
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
346
347

	/**	The version number for a database's file format. */
Howard Chu's avatar
Howard Chu committed
348
#define MDB_VERSION	 1
Howard Chu's avatar
Howard Chu committed
349

350
351
	/**	@brief The maximum size of a key in the database.
	 *
352
353
354
	 *	We require that keys all fit onto a regular page. This limit
	 *	could be raised a bit further if needed; to something just
	 *	under #MDB_PAGESIZE / #MDB_MINKEYS.
355
356
357
	 *
	 *	Note that data items in an #MDB_DUPSORT database are actually keys
	 *	of a subDB, so they're also limited to this size.
Howard Chu's avatar
Howard Chu committed
358
	 */
359
360
361
#ifndef MDB_MAXKEYSIZE
#define MDB_MAXKEYSIZE	 511
#endif
Howard Chu's avatar
Howard Chu committed
362

363
364
365
366
367
368
	/**	@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
369
#if MDB_DEBUG
Howard Chu's avatar
Howard Chu committed
370
371
372
373
	/**	A key buffer.
	 *	@ingroup debug
	 *	This is used for printing a hex dump of a key's contents.
	 */
374
#define DKBUF	char kbuf[(MDB_MAXKEYSIZE*2+1)]
Howard Chu's avatar
Howard Chu committed
375
376
377
378
	/**	Display a key in hex.
	 *	@ingroup debug
	 *	Invoke a function to display a key in hex.
	 */
Howard Chu's avatar
Howard Chu committed
379
380
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
381
#define	DKBUF	typedef int dummy_kbuf	/* so we can put ';' after */
Howard Chu's avatar
Howard Chu committed
382
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
383
#endif
Howard Chu's avatar
Howard Chu committed
384

Howard Chu's avatar
Howard Chu committed
385
386
387
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
388
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
389

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

Howard Chu's avatar
Howard Chu committed
393
394
395
396
	/**	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
397
398
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
399
400
401
402
	/**	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
403
404
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
405
406
407
408
409
410
411
/**	@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
412
413
 *	If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
 *
414
415
 *	No reader table is used if the database is on a read-only filesystem.
 *
Howard Chu's avatar
Howard Chu committed
416
417
418
 *	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
419
420
 *	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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 *	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
455
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
456
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
457
458
#endif

Howard Chu's avatar
Howard Chu committed
459
460
461
462
463
464
465
466
	/**	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
467
typedef struct MDB_rxbody {
468
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
469
470
471
472
473
474
	 *	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.
	 */
475
	txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
476
	/** The process ID of the process owning this reader txn. */
Howard Chu's avatar
Howard Chu committed
477
	pid_t		mrb_pid;
Howard Chu's avatar
Howard Chu committed
478
	/** The thread ID of the thread owning this txn. */
Howard Chu's avatar
Howard Chu committed
479
480
481
	pthread_t	mrb_tid;
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
482
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
483
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
484
485
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
486
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
487
488
489
#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
490
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
491
492
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
493
494
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
495
496
497
498
499
500
501
	/** 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
502
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
503
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
504
505
506
507
	 *	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
508
	 */
Howard Chu's avatar
Howard Chu committed
509
typedef struct MDB_txbody {
Hallvard Furuseth's avatar
Hallvard Furuseth committed
510
		/** Stamp identifying this as an MDB file. It must be set
Howard Chu's avatar
Howard Chu committed
511
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
512
	uint32_t	mtb_magic;
Howard Chu's avatar
Howard Chu committed
513
		/** Version number of this lock file. Must be set to #MDB_VERSION. */
Howard Chu's avatar
Howard Chu committed
514
	uint32_t	mtb_version;
515
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
516
	char	mtb_rmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
517
#else
Howard Chu's avatar
Howard Chu committed
518
519
520
		/** Mutex protecting access to this table.
		 *	This is the reader lock that #LOCK_MUTEX_R acquires.
		 */
Howard Chu's avatar
Howard Chu committed
521
	pthread_mutex_t	mtb_mutex;
Howard Chu's avatar
Howard Chu committed
522
#endif
Howard Chu's avatar
Howard Chu committed
523
524
525
526
		/**	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.
		 */
527
	txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
528
529
530
531
		/** 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.
		 */
532
	unsigned	mtb_numreaders;
Howard Chu's avatar
Howard Chu committed
533
534
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
535
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
536
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
537
538
539
540
541
	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
542
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
543
544
545
546
547
#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 {
548
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
549
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
550
551
#define	mti_wmname	mt2.mt2_wmname
#else
Howard Chu's avatar
Howard Chu committed
552
553
		pthread_mutex_t	mt2_wmutex;
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
554
#endif
555
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
556
557
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
558
} MDB_txninfo;
Howard Chu's avatar
Howard Chu committed
559
/** @} */
Howard Chu's avatar
Howard Chu committed
560

Howard Chu's avatar
Howard Chu committed
561
/** Common header for all page types.
Howard Chu's avatar
Howard Chu committed
562
 * Overflow records occupy a number of contiguous pages with no
Howard Chu's avatar
Howard Chu committed
563
564
 * headers on any page after the first.
 */
Howard Chu's avatar
Howard Chu committed
565
typedef struct MDB_page {
566
567
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
568
	union {
569
570
571
		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
572
	uint16_t	mp_pad;
Howard Chu's avatar
Howard Chu committed
573
574
575
576
577
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
578
579
580
581
582
583
#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
584
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
585
/** @} */
Howard Chu's avatar
Howard Chu committed
586
	uint16_t	mp_flags;		/**< @ref mdb_page */
587
588
589
#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
590
	union {
Howard Chu's avatar
Howard Chu committed
591
		struct {
592
593
594
595
596
			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
597
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
598
599
} MDB_page;

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

Howard Chu's avatar
Howard Chu committed
603
604
605
606
	/** 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
607
#define NUMKEYS(p)	 (((p)->mp_lower - PAGEHDRSZ) >> 1)
Howard Chu's avatar
Howard Chu committed
608
609

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
613
614
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
615
616
617
618
619
620
	/** 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
621
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
622
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
623
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
624
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
625
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
626
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
627
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
628
629
	/** 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
630

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

Howard Chu's avatar
Howard Chu committed
634
635
636
637
638
639
	/** 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
640
	 * is also used for pgno. (Branch nodes have no flags).
Howard Chu's avatar
Howard Chu committed
641
	 * They are in host byte order in case that lets some
642
	 * accesses be optimized into a 32-bit word access.
Howard Chu's avatar
Howard Chu committed
643
	 */
Howard Chu's avatar
Howard Chu committed
644
645
#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
646
647
648
649
650
651
	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
652
653
654
#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
655
656

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

Howard Chu's avatar
Howard Chu committed
659
660
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
661
662
663
664
665
666
667
	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)

668
669
670
	/** 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
671
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
672
673
674
675
	 *	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
676
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
677
678
679
680
	 *	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
681
	/** Address of node \b i in page \b p */
Howard Chu's avatar
Howard Chu committed
682
683
684
685
686
687
688
689
690
#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 */
691
692
693
#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
694
695
696
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
697
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
698
699
700
701
702
703
704
705
706

	/** 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
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
	/** 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
731
732
733
734
735
736
737
	/** 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. */
Howard Chu's avatar
Howard Chu committed
738
#define MDB_GET_KEY(node, key)	{ if ((key) != NULL) { \
Hallvard Furuseth's avatar
Hallvard Furuseth committed
739
	(key)->mv_size = NODEKSZ(node); (key)->mv_data = NODEKEY(node); } }
Howard Chu's avatar
Howard Chu committed
740
741

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
742
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
743
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
744
	uint16_t	md_flags;	/**< @ref mdb_dbi_open */
Howard Chu's avatar
Howard Chu committed
745
	uint16_t	md_depth;	/**< depth of this tree */
746
747
748
749
	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
750
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
751
752
} MDB_db;

753
	/** mdb_dbi_open flags */
754
755
#define MDB_VALID	0x8000		/**< DB handle is valid, for me_dbflags */
#define PERSISTENT_FLAGS	(0xffff & ~(MDB_VALID))
756
757
758
#define VALID_FLAGS	(MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
	MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)

Howard Chu's avatar
Howard Chu committed
759
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
760
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
761
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
762
763
#define	MAIN_DBI	1

Howard Chu's avatar
Howard Chu committed
764
765
	/** Meta page content. */
typedef struct MDB_meta {
Hallvard Furuseth's avatar
Hallvard Furuseth committed
766
		/** Stamp identifying this as an MDB file. It must be set
Howard Chu's avatar
Howard Chu committed
767
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
768
	uint32_t	mm_magic;
Howard Chu's avatar
Howard Chu committed
769
		/** Version number of this lock file. Must be set to #MDB_VERSION. */
Howard Chu's avatar
Howard Chu committed
770
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
771
772
773
774
	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
775
#define	mm_psize	mm_dbs[0].md_pad
Howard Chu's avatar
Howard Chu committed
776
	/** Any persistent environment flags. @ref mdb_env */
Howard Chu's avatar
Howard Chu committed
777
#define	mm_flags	mm_dbs[0].md_flags
Howard Chu's avatar
Howard Chu committed
778
	pgno_t		mm_last_pg;			/**< last used page in file */
779
	txnid_t		mm_txnid;			/**< txnid that committed this page */
Howard Chu's avatar
Howard Chu committed
780
781
} MDB_meta;

782
783
784
785
786
787
788
789
790
791
792
793
794
795
	/** Buffer for a stack-allocated dirty page.
	 *	The members define size and alignment, and silence type
	 *	aliasing warnings.  They are not used directly; that could
	 *	mean incorrectly using several union members in parallel.
	 */
typedef union MDB_pagebuf {
	char		mb_raw[MDB_PAGESIZE];
	MDB_page	mb_page;
	struct {
		char		mm_pad[PAGEHDRSZ];
		MDB_meta	mm_meta;
	} mb_metabuf;
} MDB_pagebuf;

Howard Chu's avatar
Howard Chu committed
796
797
798
799
800
801
802
803
804
	/** 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 */
805
	void		*md_relctx;		/**< user-provided context for md_rel */
Howard Chu's avatar
Howard Chu committed
806
} MDB_dbx;
Howard Chu's avatar
Howard Chu committed
807

Howard Chu's avatar
Howard Chu committed
808
809
810
811
	/** A database transaction.
	 *	Every operation requires a transaction handle.
	 */
struct MDB_txn {
812
813
	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
814
815
816
817
818
	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.
	 */
819
	txnid_t		mt_txnid;
Howard Chu's avatar
Howard Chu committed
820
821
822
	MDB_env		*mt_env;		/**< the DB environment */
	/** The list of pages that became unused during this transaction.
	 */
823
	MDB_IDL		mt_free_pgs;
Howard Chu's avatar
Howard Chu committed
824
	union {
825
826
		MDB_ID2L	dirty_list;	/**< for write txns: modified pages */
		MDB_reader	*reader;	/**< this thread's reader table slot or NULL */
Howard Chu's avatar
Howard Chu committed
827
828
829
830
831
	} 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
832
833
834
835
836
837
/** @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 */
838
#define DB_NEW		0x04		/**< DB handle opened in this txn */
839
#define DB_VALID	0x08		/**< DB handle is valid, see also #MDB_VALID */
Howard Chu's avatar
Howard Chu committed
840
/** @} */
841
	/** In write txns, array of cursors for each DB */
Howard Chu's avatar
Howard Chu committed
842
	MDB_cursor	**mt_cursors;
Howard Chu's avatar
Howard Chu committed
843
844
	/** Array of flags for each DB */
	unsigned char	*mt_dbflags;
Howard Chu's avatar
Howard Chu committed
845
846
847
	/**	Number of DB records in use. This number only ever increments;
	 *	we don't decrement it when individual DB handles are closed.
	 */
848
	MDB_dbi		mt_numdbs;
Howard Chu's avatar
Howard Chu committed
849

Howard Chu's avatar
Howard Chu committed
850
851
852
853
/** @defgroup mdb_txn	Transaction Flags
 *	@ingroup internal
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
854
855
#define MDB_TXN_RDONLY		0x01		/**< read-only transaction */
#define MDB_TXN_ERROR		0x02		/**< an error has occurred */
856
#define MDB_TXN_DIRTY		0x04		/**< must write, even if dirty list is empty */
Howard Chu's avatar
Howard Chu committed
857
858
/** @} */
	unsigned int	mt_flags;		/**< @ref mdb_txn */
Howard Chu's avatar
Howard Chu committed
859
	/** dirty_list maxsize - # of allocated pages allowed, including in parent txns */
860
	unsigned int	mt_dirty_room;
Howard Chu's avatar
Howard Chu committed
861
862
863
864
865
	/** 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
866

Howard Chu's avatar
Howard Chu committed
867
/** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
868
869
870
 * 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
871
#define CURSOR_STACK		 32
Howard Chu's avatar
Howard Chu committed
872

Howard Chu's avatar
Howard Chu committed
873
struct MDB_xcursor;
874

Howard Chu's avatar
Howard Chu committed
875
	/** Cursors are used for all DB operations */
Howard Chu's avatar
Howard Chu committed
876
struct MDB_cursor {
Howard Chu's avatar
Howard Chu committed
877
878
879
880
	/** 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
881
	/** Context used for databases with #MDB_DUPSORT, otherwise NULL */
Howard Chu's avatar
Howard Chu committed
882
	struct MDB_xcursor	*mc_xcursor;
Howard Chu's avatar
Howard Chu committed
883
	/** The transaction that owns this cursor */
Howard Chu's avatar
Howard Chu committed
884
	MDB_txn		*mc_txn;
Howard Chu's avatar
Howard Chu committed
885
	/** The database handle this cursor operates on */
Howard Chu's avatar
Howard Chu committed
886
	MDB_dbi		mc_dbi;
887
888
889
890
	/** 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
891
892
	/** The @ref mt_dbflag for this database */
	unsigned char	*mc_dbflag;
Howard Chu's avatar
Howard Chu committed
893
	unsigned short 	mc_snum;	/**< number of pushed pages */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
894
	unsigned short	mc_top;		/**< index of top page, normally mc_snum-1 */
Howard Chu's avatar
Howard Chu committed
895
896
897
898
899
/** @defgroup mdb_cursor	Cursor Flags
 *	@ingroup internal
 *	Cursor state flags.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
900
901
#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
902
#define C_SUB	0x04			/**< Cursor is a sub-cursor */
Howard Chu's avatar
Howard Chu committed
903
904
#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
905
#define C_SPLITTING	0x20		/**< Cursor is in page_split */
906
#define C_UNTRACK	0x40		/**< Un-track cursor when closing */
Howard Chu's avatar
Howard Chu committed
907
908
/** @} */
	unsigned int	mc_flags;	/**< @ref mdb_cursor */
Howard Chu's avatar
Howard Chu committed
909
910
	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
911
912
};

Howard Chu's avatar
Howard Chu committed
913
914
915
916
	/** 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.
917
	 */
Howard Chu's avatar
Howard Chu committed
918
typedef struct MDB_xcursor {
Howard Chu's avatar
Howard Chu committed
919
	/** A sub-cursor for traversing the Dup DB */
Howard Chu's avatar
Howard Chu committed
920
	MDB_cursor mx_cursor;
921
922
923
924
	/** 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
925
926
	/** The @ref mt_dbflag for this Dup DB */
	unsigned char mx_dbflag;
Howard Chu's avatar
Howard Chu committed
927
928
} MDB_xcursor;

929
930
931
932
933
934
	/** State of FreeDB old pages, stored in the MDB_env */
typedef struct MDB_pgstate {
	txnid_t		mf_pglast;	/**< ID of last old page record we used */
	pgno_t		*mf_pghead;	/**< old pages reclaimed from freelist */
} MDB_pgstate;

Howard Chu's avatar
Howard Chu committed
935
	/** The database environment. */
Howard Chu's avatar
Howard Chu committed
936
struct MDB_env {
Howard Chu's avatar
Howard Chu committed
937
938
939
	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
940
	/** Failed to update the meta page. Probably an I/O error. */
Howard Chu's avatar
Howard Chu committed
941
#define	MDB_FATAL_ERROR	0x80000000U
Hallvard Furuseth's avatar
Hallvard Furuseth committed
942
943
	/** Some fields are initialized. */
#define	MDB_ENV_ACTIVE	0x20000000U
944
945
	/** me_txkey is set */
#define	MDB_ENV_TXKEY	0x10000000U
Howard Chu's avatar
Howard Chu committed
946
	uint32_t 	me_flags;		/**< @ref mdb_env */
947
	unsigned int	me_psize;	/**< size of a page, from #GET_PAGESIZE */
Howard Chu's avatar
Howard Chu committed
948
	unsigned int	me_maxreaders;	/**< size of the reader table */
949
	unsigned int	me_numreaders;	/**< max numreaders set by this env */
950
951
	MDB_dbi		me_numdbs;		/**< number of DBs opened */
	MDB_dbi		me_maxdbs;		/**< size of the DB table */
952
	pid_t		me_pid;		/**< process ID of this env */
Howard Chu's avatar
Howard Chu committed
953
954
	char		*me_path;		/**< path to the DB files */
	char		*me_map;		/**< the memory map of the data file */
955
	MDB_txninfo	*me_txns;		/**< the memory map of the lock file or NULL */
Howard Chu's avatar
Howard Chu committed
956
957
958
959
960
961
	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 */
	MDB_dbx		*me_dbxs;		/**< array of static DB info */
962
	uint16_t	*me_dbflags;	/**< array of flags from MDB_db.md_flags */
Howard Chu's avatar
Howard Chu committed
963
	pthread_key_t	me_txkey;	/**< thread-key for readers */
964
965
966
	MDB_pgstate	me_pgstate;		/**< state of old pages from freeDB */
#	define		me_pglast	me_pgstate.mf_pglast
#	define		me_pghead	me_pgstate.mf_pghead
Howard Chu's avatar
Howard Chu committed
967
968
	MDB_page	*me_dpages;		/**< list of malloc'd blocks for re-use */
	/** IDL of pages that became unused in a write txn */
969
	MDB_IDL		me_free_pgs;
Hallvard Furuseth's avatar
Hallvard Furuseth committed
970
971
	/** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
	MDB_ID2L	me_dirty_list;
972
	/** Max number of freelist items that can fit in a single overflow page */
973
	int			me_maxfree_1pg;
Howard Chu's avatar
Howard Chu committed
974
975
	/** Max size of a node on a page */
	unsigned int	me_nodemax;
Howard Chu's avatar
Howard Chu committed
976
977
978
#ifdef _WIN32
	HANDLE		me_rmutex;		/* Windows mutexes don't reside in shared mem */
	HANDLE		me_wmutex;
979
980
#elif defined(MDB_USE_POSIX_SEM)
	sem_t		*me_rmutex;		/* Shared mutexes are not supported */
Howard Chu's avatar
Howard Chu committed
981
982
	sem_t		*me_wmutex;
#endif
Howard Chu's avatar
Howard Chu committed
983
};
984
985
986
987
988
989
990

	/** Nested transaction */
typedef struct MDB_ntxn {
	MDB_txn		mnt_txn;		/* the transaction */
	MDB_pgstate	mnt_pgstate;	/* parent transaction's saved freestate */
} MDB_ntxn;

Howard Chu's avatar
Howard Chu committed
991
992
	/** max number of pages to commit in one writev() call */
#define MDB_COMMIT_PAGES	 64
993
994
995
996
#if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
#undef MDB_COMMIT_PAGES
#define MDB_COMMIT_PAGES	IOV_MAX
#endif
Howard Chu's avatar
Howard Chu committed
997

998
999
1000
static int  mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
static int  mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
static int  mdb_page_touch(MDB_cursor *mc);
Howard Chu's avatar
Howard Chu committed
1001

1002
static int  mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp, int *lvl);
Howard Chu's avatar
Howard Chu committed
1003
static int  mdb_page_search_root(MDB_cursor *mc,
1004
			    MDB_val *key, int modify);
1005
1006
#define MDB_PS_MODIFY	1
#define MDB_PS_ROOTONLY	2
Howard Chu's avatar
Howard Chu committed
1007
static int  mdb_page_search(MDB_cursor *mc,
1008
			    MDB_val *key, int flags);
Howard Chu's avatar
Howard Chu committed
1009
static int	mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
Howard Chu's avatar
Howard Chu committed
1010
1011

#define MDB_SPLIT_REPLACE	MDB_APPENDDUP	/**< newkey is not new */
Howard Chu's avatar
Howard Chu committed
1012
static int	mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
Howard Chu's avatar
Howard Chu committed
1013
				pgno_t newpgno, unsigned int nflags);
Howard Chu's avatar
Howard Chu committed
1014

Howard Chu's avatar
Howard Chu committed
1015
static int  mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1016
static int  mdb_env_pick_meta(const MDB_env *env);
Howard Chu's avatar
Howard Chu committed
1017
static int  mdb_env_write_meta(MDB_txn *txn);
Hallvard Furuseth's avatar
Hallvard Furuseth committed
1018
1019
1020
#if !(defined(_WIN32) || defined(MDB_USE_POSIX_SEM)) /* Drop unused excl arg */
# define mdb_env_close0(env, excl) mdb_env_close1(env)
#endif
1021
static void mdb_env_close0(MDB_env *env, int excl);
Howard Chu's avatar
Howard Chu committed
1022

Howard Chu's avatar
Howard Chu committed
1023
1024
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
1025
			    MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
Howard Chu's avatar
Howard Chu committed
1026
static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
Howard Chu's avatar
Howard Chu committed
1027
static void mdb_node_shrink(MDB_page *mp, indx_t indx);
Howard Chu's avatar
Howard Chu committed
1028
static int	mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
Howard Chu's avatar
Howard Chu committed
1029
static int  mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
Howard Chu's avatar
Howard Chu committed
1030
1031
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
1032

1033
static int	mdb_rebalance(MDB_cursor *mc);
1034
static int	mdb_update_key(MDB_cursor *mc, MDB_val *key);
1035

Howard Chu's avatar
Howard Chu committed
1036
1037
static void	mdb_cursor_pop(MDB_cursor *mc);
static int	mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1038

Howard Chu's avatar
Howard Chu committed
1039
static int	mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
Howard Chu's avatar
Howard Chu committed
1040
static int	mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1041
1042
1043
1044
1045
1046
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
1047

Howard Chu's avatar
Howard Chu committed
1048
static void	mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
Howard Chu's avatar
Howard Chu committed
1049
static void	mdb_xcursor_init0(MDB_cursor *mc);
1050
static void	mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
Howard Chu's avatar
Howard Chu committed
1051

Howard Chu's avatar
Howard Chu committed
1052
static int	mdb_drop0(MDB_cursor *mc, int subs);
Howard Chu's avatar
Howard Chu committed
1053
1054
static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);

Howard Chu's avatar
Howard Chu committed
1055
/** @cond */
Howard Chu's avatar
Howard Chu committed
1056
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
1057
/** @endcond */
Howard Chu's avatar
Howard Chu committed
1058

Howard Chu's avatar
Howard Chu committed
1059
1060
1061
1062
1063
1064
#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
1065
/** Return the library version info. */
Howard Chu's avatar
Howard Chu committed
1066
char *
Howard Chu's avatar
Howard Chu committed
1067
mdb_version(int *major, int *minor, int *patch)
Howard Chu's avatar
Howard Chu committed
1068
{
Howard Chu's avatar
Howard Chu committed