mdb.c 192 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-2012 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.
 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
35
#define _GNU_SOURCE 1
Howard Chu's avatar
Howard Chu committed
36
37
38
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/param.h>
Howard Chu's avatar
Howard Chu committed
39
40
41
#ifdef _WIN32
#include <windows.h>
#else
Howard Chu's avatar
Howard Chu committed
42
43
44
45
46
#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
47
#include <fcntl.h>
Howard Chu's avatar
Howard Chu committed
48
#endif
Howard Chu's avatar
Howard Chu committed
49
50
51

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

61
62
63
64
#if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
#include <resolv.h>	/* defines BYTE_ORDER on HPUX and Solaris */
#endif

65
#if defined(__APPLE__) || defined (BSD)
66
67
68
69
# define MDB_USE_POSIX_SEM	1
# define MDB_FDATASYNC		fsync
#elif defined(ANDROID)
# define MDB_FDATASYNC		fsync
70
71
#endif

72
73
#ifndef _WIN32
#include <pthread.h>
74
#ifdef MDB_USE_POSIX_SEM
Howard Chu's avatar
Howard Chu committed
75
76
77
78
#include <semaphore.h>
#endif
#endif

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

Howard Chu's avatar
Howard Chu committed
109
110
111
112
113
#ifndef LITTLE_ENDIAN
#define LITTLE_ENDIAN	__LITTLE_ENDIAN
#endif
#ifndef BIG_ENDIAN
#define BIG_ENDIAN	__BIG_ENDIAN
114
115
#endif

Howard Chu's avatar
Howard Chu committed
116
117
118
119
#if defined(__i386) || defined(__x86_64)
#define MISALIGNED_OK	1
#endif

Howard Chu's avatar
Howard Chu committed
120
#include "lmdb.h"
121
122
#include "midl.h"

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

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

164
#ifdef MDB_USE_POSIX_SEM
165
166

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

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
179
#else
Howard Chu's avatar
Howard Chu committed
180
181
	/** Lock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
182
#define LOCK_MUTEX_R(env)	pthread_mutex_lock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
183
184
	/** Unlock the reader mutex.
	 */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
185
#define UNLOCK_MUTEX_R(env)	pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
Howard Chu's avatar
Howard Chu committed
186
187
188
189
190

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

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

	/** 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
205
#define	HANDLE	int
Howard Chu's avatar
Howard Chu committed
206
207
208
209
210

	/**	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
211
#define INVALID_HANDLE_VALUE	(-1)
Howard Chu's avatar
Howard Chu committed
212
213
214
215
216

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

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

226
/** @} */
Howard Chu's avatar
Howard Chu committed
227

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

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

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

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

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

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

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

	/** 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
334
#define MDB_MINKEYS	 2
Howard Chu's avatar
Howard Chu committed
335
336
337
338
339

	/**	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
340
#define MDB_MAGIC	 0xBEEFC0DE
Howard Chu's avatar
Howard Chu committed
341
342

	/**	The version number for a database's file format. */
Howard Chu's avatar
Howard Chu committed
343
#define MDB_VERSION	 1
Howard Chu's avatar
Howard Chu committed
344
345
346
347

	/**	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
348
	 *	further if needed; to something just under #MDB_PAGESIZE / #MDB_MINKEYS.
Howard Chu's avatar
Howard Chu committed
349
	 */
Howard Chu's avatar
Howard Chu committed
350
#define MAXKEYSIZE	 511
Howard Chu's avatar
Howard Chu committed
351

Howard Chu's avatar
Howard Chu committed
352
#if MDB_DEBUG
Howard Chu's avatar
Howard Chu committed
353
354
355
356
357
358
359
360
361
	/**	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
362
363
#define	DKEY(x)	mdb_dkey(x, kbuf)
#else
364
#define	DKBUF	typedef int dummy_kbuf	/* so we can put ';' after */
Howard Chu's avatar
Howard Chu committed
365
#define DKEY(x)	0
Howard Chu's avatar
Howard Chu committed
366
#endif
Howard Chu's avatar
Howard Chu committed
367

Howard Chu's avatar
Howard Chu committed
368
369
370
	/** An invalid page number.
	 *	Mainly used to denote an empty tree.
	 */
371
#define P_INVALID	 (~(pgno_t)0)
Howard Chu's avatar
Howard Chu committed
372

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

Howard Chu's avatar
Howard Chu committed
376
377
378
379
	/**	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
380
381
typedef uint16_t	 indx_t;

Howard Chu's avatar
Howard Chu committed
382
383
384
385
	/**	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
386
387
#define DEFAULT_MAPSIZE	1048576

Howard Chu's avatar
Howard Chu committed
388
389
390
391
392
393
394
395
396
397
/**	@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
398
399
 *	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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 *	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
437
#ifndef CACHELINE
Howard Chu's avatar
Howard Chu committed
438
#define CACHELINE	64
Howard Chu's avatar
Howard Chu committed
439
440
#endif

Howard Chu's avatar
Howard Chu committed
441
442
443
444
445
446
447
448
	/**	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
449
typedef struct MDB_rxbody {
450
	/**	Current Transaction ID when this transaction began, or (txnid_t)-1.
Howard Chu's avatar
Howard Chu committed
451
452
453
454
455
456
	 *	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.
	 */
457
	txnid_t		mrb_txnid;
Howard Chu's avatar
Howard Chu committed
458
	/** The process ID of the process owning this reader txn. */
Howard Chu's avatar
Howard Chu committed
459
	pid_t		mrb_pid;
Howard Chu's avatar
Howard Chu committed
460
	/** The thread ID of the thread owning this txn. */
Howard Chu's avatar
Howard Chu committed
461
462
463
	pthread_t	mrb_tid;
} MDB_rxbody;

Howard Chu's avatar
Howard Chu committed
464
	/** The actual reader record, with cacheline padding. */
Howard Chu's avatar
Howard Chu committed
465
typedef struct MDB_reader {
Howard Chu's avatar
Howard Chu committed
466
467
	union {
		MDB_rxbody mrx;
Howard Chu's avatar
Howard Chu committed
468
		/** shorthand for mrb_txnid */
Howard Chu's avatar
Howard Chu committed
469
470
471
#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
472
		/** cache line alignment */
Howard Chu's avatar
Howard Chu committed
473
474
		char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
	} mru;
Howard Chu's avatar
Howard Chu committed
475
476
} MDB_reader;

Howard Chu's avatar
Howard Chu committed
477
478
479
480
481
482
483
	/** 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
484
	 *	processes can grab them. This same approach is also used on
Howard Chu's avatar
Howard Chu committed
485
	 *	MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
Howard Chu's avatar
Howard Chu committed
486
487
488
489
	 *	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
490
	 */
Howard Chu's avatar
Howard Chu committed
491
typedef struct MDB_txbody {
Hallvard Furuseth's avatar
Hallvard Furuseth committed
492
		/** Stamp identifying this as an MDB file. It must be set
Howard Chu's avatar
Howard Chu committed
493
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
494
	uint32_t	mtb_magic;
Howard Chu's avatar
Howard Chu committed
495
		/** Version number of this lock file. Must be set to #MDB_VERSION. */
Howard Chu's avatar
Howard Chu committed
496
	uint32_t	mtb_version;
497
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
498
	char	mtb_rmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
499
#else
Howard Chu's avatar
Howard Chu committed
500
501
502
		/** Mutex protecting access to this table.
		 *	This is the reader lock that #LOCK_MUTEX_R acquires.
		 */
Howard Chu's avatar
Howard Chu committed
503
	pthread_mutex_t	mtb_mutex;
Howard Chu's avatar
Howard Chu committed
504
#endif
Howard Chu's avatar
Howard Chu committed
505
506
507
508
		/**	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.
		 */
509
	txnid_t		mtb_txnid;
Howard Chu's avatar
Howard Chu committed
510
511
512
513
		/** 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.
		 */
514
	unsigned	mtb_numreaders;
Howard Chu's avatar
Howard Chu committed
515
516
} MDB_txbody;

Howard Chu's avatar
Howard Chu committed
517
	/** The actual reader table definition. */
Howard Chu's avatar
Howard Chu committed
518
typedef struct MDB_txninfo {
Howard Chu's avatar
Howard Chu committed
519
520
521
522
523
	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
524
#define mti_rmname	mt1.mtb.mtb_rmname
Howard Chu's avatar
Howard Chu committed
525
526
527
528
529
#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 {
530
#if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
Howard Chu's avatar
Howard Chu committed
531
		char mt2_wmname[MNAME_LEN];
Howard Chu's avatar
Howard Chu committed
532
533
#define	mti_wmname	mt2.mt2_wmname
#else
Howard Chu's avatar
Howard Chu committed
534
535
		pthread_mutex_t	mt2_wmutex;
#define mti_wmutex	mt2.mt2_wmutex
Howard Chu's avatar
Howard Chu committed
536
#endif
537
		char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
Howard Chu's avatar
Howard Chu committed
538
539
	} mt2;
	MDB_reader	mti_readers[1];
Howard Chu's avatar
Howard Chu committed
540
} MDB_txninfo;
Howard Chu's avatar
Howard Chu committed
541
/** @} */
Howard Chu's avatar
Howard Chu committed
542

Howard Chu's avatar
Howard Chu committed
543
/** Common header for all page types.
Howard Chu's avatar
Howard Chu committed
544
 * Overflow records occupy a number of contiguous pages with no
Howard Chu's avatar
Howard Chu committed
545
546
 * headers on any page after the first.
 */
Howard Chu's avatar
Howard Chu committed
547
typedef struct MDB_page {
548
549
#define	mp_pgno	mp_p.p_pgno
#define	mp_next	mp_p.p_next
Howard Chu's avatar
Howard Chu committed
550
	union {
551
552
553
		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
554
	uint16_t	mp_pad;
Howard Chu's avatar
Howard Chu committed
555
556
557
558
559
/**	@defgroup mdb_page	Page Flags
 *	@ingroup internal
 *	Flags for the page headers.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
560
561
562
563
564
565
#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
566
#define	P_SUBP		 0x40		/**< for #MDB_DUPSORT sub-pages */
Howard Chu's avatar
Howard Chu committed
567
/** @} */
Howard Chu's avatar
Howard Chu committed
568
	uint16_t	mp_flags;		/**< @ref mdb_page */
569
570
571
#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
572
	union {
Howard Chu's avatar
Howard Chu committed
573
		struct {
574
575
576
577
578
			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
579
	indx_t		mp_ptrs[1];		/**< dynamic size */
Howard Chu's avatar
Howard Chu committed
580
581
} MDB_page;

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

Howard Chu's avatar
Howard Chu committed
585
586
587
588
	/** 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
589
#define NUMKEYS(p)	 (((p)->mp_lower - PAGEHDRSZ) >> 1)
Howard Chu's avatar
Howard Chu committed
590
591

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

	/** The percentage of space used in the page, in tenths of a percent. */
Howard Chu's avatar
Howard Chu committed
595
596
#define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
				((env)->me_psize - PAGEHDRSZ))
Howard Chu's avatar
Howard Chu committed
597
598
599
600
601
602
	/** 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
603
#define IS_LEAF(p)	 F_ISSET((p)->mp_flags, P_LEAF)
Howard Chu's avatar
Howard Chu committed
604
	/** Test if a page is a LEAF2 page */
Howard Chu's avatar
Howard Chu committed
605
#define IS_LEAF2(p)	 F_ISSET((p)->mp_flags, P_LEAF2)
Howard Chu's avatar
Howard Chu committed
606
	/** Test if a page is a branch page */
Howard Chu's avatar
Howard Chu committed
607
#define IS_BRANCH(p)	 F_ISSET((p)->mp_flags, P_BRANCH)
Howard Chu's avatar
Howard Chu committed
608
	/** Test if a page is an overflow page */
Howard Chu's avatar
Howard Chu committed
609
#define IS_OVERFLOW(p)	 F_ISSET((p)->mp_flags, P_OVERFLOW)
Howard Chu's avatar
Howard Chu committed
610
611
	/** 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
612

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

Howard Chu's avatar
Howard Chu committed
616
617
618
619
620
621
	/** 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
622
	 * is also used for pgno. (Branch nodes have no flags).
Howard Chu's avatar
Howard Chu committed
623
	 * They are in host byte order in case that lets some
624
	 * accesses be optimized into a 32-bit word access.
Howard Chu's avatar
Howard Chu committed
625
	 */
Howard Chu's avatar
Howard Chu committed
626
627
#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
628
629
630
631
632
633
	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
634
635
636
#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
637
638

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

Howard Chu's avatar
Howard Chu committed
641
642
/** @} */
	unsigned short	mn_flags;		/**< @ref mdb_node */
Howard Chu's avatar
Howard Chu committed
643
644
645
646
647
648
649
	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)

650
651
652
	/** 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
653
	/** Size of a node in a branch page with a given key.
Howard Chu's avatar
Howard Chu committed
654
655
656
657
	 *	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
658
	/** Size of a node in a leaf page with a given key and data.
Howard Chu's avatar
Howard Chu committed
659
660
661
662
	 *	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
663
	/** Address of node \b i in page \b p */
Howard Chu's avatar
Howard Chu committed
664
665
666
667
668
669
670
671
672
#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 */
673
674
675
#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
676
677
678
	/** Set the page number in a branch node */
#define SETPGNO(node,pgno)	do { \
	(node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
679
	if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
Howard Chu's avatar
Howard Chu committed
680
681
682
683
684
685
686
687
688

	/** 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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
	/** 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
713
714
715
716
717
718
719
	/** 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
720
#define MDB_GET_KEY(node, key)	{ if ((key) != NULL) { \
Hallvard Furuseth's avatar
Hallvard Furuseth committed
721
	(key)->mv_size = NODEKSZ(node); (key)->mv_data = NODEKEY(node); } }
Howard Chu's avatar
Howard Chu committed
722
723

	/** Information about a single database in the environment. */
Howard Chu's avatar
Howard Chu committed
724
typedef struct MDB_db {
Howard Chu's avatar
Howard Chu committed
725
726
727
	uint32_t	md_pad;		/**< also ksize for LEAF2 pages */
	uint16_t	md_flags;	/**< @ref mdb_open */
	uint16_t	md_depth;	/**< depth of this tree */
728
729
730
731
	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
732
	pgno_t		md_root;		/**< the root page of this tree */
Howard Chu's avatar
Howard Chu committed
733
734
} MDB_db;

Howard Chu's avatar
Howard Chu committed
735
	/** Handle for the DB used to track free pages. */
Howard Chu's avatar
Howard Chu committed
736
#define	FREE_DBI	0
Howard Chu's avatar
Howard Chu committed
737
	/** Handle for the default DB. */
Howard Chu's avatar
Howard Chu committed
738
739
#define	MAIN_DBI	1

Howard Chu's avatar
Howard Chu committed
740
741
	/** Meta page content. */
typedef struct MDB_meta {
Hallvard Furuseth's avatar
Hallvard Furuseth committed
742
		/** Stamp identifying this as an MDB file. It must be set
Howard Chu's avatar
Howard Chu committed
743
		 *	to #MDB_MAGIC. */
Howard Chu's avatar
Howard Chu committed
744
	uint32_t	mm_magic;
Howard Chu's avatar
Howard Chu committed
745
		/** Version number of this lock file. Must be set to #MDB_VERSION. */
Howard Chu's avatar
Howard Chu committed
746
	uint32_t	mm_version;
Howard Chu's avatar
Howard Chu committed
747
748
749
750
	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
751
#define	mm_psize	mm_dbs[0].md_pad
Howard Chu's avatar
Howard Chu committed
752
	/** Any persistent environment flags. @ref mdb_env */
Howard Chu's avatar
Howard Chu committed
753
#define	mm_flags	mm_dbs[0].md_flags
Howard Chu's avatar
Howard Chu committed
754
	pgno_t		mm_last_pg;			/**< last used page in file */
755
	txnid_t		mm_txnid;			/**< txnid that committed this page */
Howard Chu's avatar
Howard Chu committed
756
757
} MDB_meta;

758
759
760
761
762
763
764
765
766
767
768
769
770
771
	/** 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
772
773
774
775
776
777
778
779
780
	/** 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 */
781
	void		*md_relctx;		/**< user-provided context for md_rel */
Howard Chu's avatar
Howard Chu committed
782
} MDB_dbx;
Howard Chu's avatar
Howard Chu committed
783

Howard Chu's avatar
Howard Chu committed
784
785
786
787
	/** A database transaction.
	 *	Every operation requires a transaction handle.
	 */
struct MDB_txn {
788
789
	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
790
791
792
793
794
	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.
	 */
795
	txnid_t		mt_txnid;
Howard Chu's avatar
Howard Chu committed
796
797
798
	MDB_env		*mt_env;		/**< the DB environment */
	/** The list of pages that became unused during this transaction.
	 */
799
	MDB_IDL		mt_free_pgs;
Howard Chu's avatar
Howard Chu committed
800
	union {
801
		MDB_ID2L	dirty_list;	/**< modified pages */
Howard Chu's avatar
Howard Chu committed
802
803
804
805
806
807
		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
808
809
810
811
812
813
814
/** @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
815
816
	/** Array of cursors for each DB */
	MDB_cursor	**mt_cursors;
Howard Chu's avatar
Howard Chu committed
817
818
	/** Array of flags for each DB */
	unsigned char	*mt_dbflags;
Howard Chu's avatar
Howard Chu committed
819
820
821
	/**	Number of DB records in use. This number only ever increments;
	 *	we don't decrement it when individual DB handles are closed.
	 */
822
	MDB_dbi		mt_numdbs;
Howard Chu's avatar
Howard Chu committed
823

Howard Chu's avatar
Howard Chu committed
824
825
826
827
/** @defgroup mdb_txn	Transaction Flags
 *	@ingroup internal
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
828
829
#define MDB_TXN_RDONLY		0x01		/**< read-only transaction */
#define MDB_TXN_ERROR		0x02		/**< an error has occurred */
830
#define MDB_TXN_DIRTY		0x04		/**< must write, even if dirty list is empty */
Howard Chu's avatar
Howard Chu committed
831
832
/** @} */
	unsigned int	mt_flags;		/**< @ref mdb_txn */
Howard Chu's avatar
Howard Chu committed
833
834
835
836
837
	/** 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
838

Howard Chu's avatar
Howard Chu committed
839
/** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
840
841
842
 * 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
843
#define CURSOR_STACK		 32
Howard Chu's avatar
Howard Chu committed
844

Howard Chu's avatar
Howard Chu committed
845
struct MDB_xcursor;
846

Howard Chu's avatar
Howard Chu committed
847
	/** Cursors are used for all DB operations */
Howard Chu's avatar
Howard Chu committed
848
struct MDB_cursor {
Howard Chu's avatar
Howard Chu committed
849
850
851
852
	/** 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
853
	/** Context used for databases with #MDB_DUPSORT, otherwise NULL */
Howard Chu's avatar
Howard Chu committed
854
	struct MDB_xcursor	*mc_xcursor;
Howard Chu's avatar
Howard Chu committed
855
	/** The transaction that owns this cursor */
Howard Chu's avatar
Howard Chu committed
856
	MDB_txn		*mc_txn;
Howard Chu's avatar
Howard Chu committed
857
	/** The database handle this cursor operates on */
Howard Chu's avatar
Howard Chu committed
858
	MDB_dbi		mc_dbi;
859
860
861
862
	/** 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
863
864
	/** The @ref mt_dbflag for this database */
	unsigned char	*mc_dbflag;
Howard Chu's avatar
Howard Chu committed
865
	unsigned short 	mc_snum;	/**< number of pushed pages */
Hallvard Furuseth's avatar
Hallvard Furuseth committed
866
	unsigned short	mc_top;		/**< index of top page, normally mc_snum-1 */
Howard Chu's avatar
Howard Chu committed
867
868
869
870
871
/** @defgroup mdb_cursor	Cursor Flags
 *	@ingroup internal
 *	Cursor state flags.
 *	@{
 */
Howard Chu's avatar
Howard Chu committed
872
873
#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
874
#define C_SUB	0x04			/**< Cursor is a sub-cursor */
Howard Chu's avatar
Howard Chu committed
875
876
#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
877
#define C_SPLITTING	0x20		/**< Cursor is in page_split */
Howard Chu's avatar
Howard Chu committed
878
879
/** @} */
	unsigned int	mc_flags;	/**< @ref mdb_cursor */
Howard Chu's avatar
Howard Chu committed
880
881
	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
882
883
};

Howard Chu's avatar
Howard Chu committed
884
885
886
887
	/** 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.
888
	 */
Howard Chu's avatar
Howard Chu committed
889
typedef struct MDB_xcursor {
Howard Chu's avatar
Howard Chu committed
890
	/** A sub-cursor for traversing the Dup DB */
Howard Chu's avatar
Howard Chu committed
891
	MDB_cursor mx_cursor;
892
893
894
895
	/** 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
896
897
	/** The @ref mt_dbflag for this Dup DB */
	unsigned char mx_dbflag;
Howard Chu's avatar
Howard Chu committed
898
899
} MDB_xcursor;

Howard Chu's avatar
Howard Chu committed
900
901
902
903
904
905
906
	/** 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. */
907
	txnid_t		mo_txnid;
908
	/** An #MDB_IDL of the pages */
Howard Chu's avatar
Howard Chu committed
909
910
911
912
	pgno_t		mo_pages[1];	/* dynamic */
} MDB_oldpages;

	/** The database environment. */
Howard Chu's avatar
Howard Chu committed
913
struct MDB_env {
Howard Chu's avatar
Howard Chu committed
914
915
916
	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
917
	/** Failed to update the meta page. Probably an I/O error. */
Howard Chu's avatar
Howard Chu committed
918
#define	MDB_FATAL_ERROR	0x80000000U
919
920
	/** Read-only Filesystem. Allow read access, no locking. */
#define	MDB_ROFS	0x40000000U
Hallvard Furuseth's avatar
Hallvard Furuseth committed
921
922
	/** Some fields are initialized. */
#define	MDB_ENV_ACTIVE	0x20000000U
Howard Chu's avatar
Howard Chu committed
923
	uint32_t 	me_flags;		/**< @ref mdb_env */
924
	unsigned int	me_psize;	/**< size of a page, from #GET_PAGESIZE */
Howard Chu's avatar
Howard Chu committed
925
	unsigned int	me_maxreaders;	/**< size of the reader table */
926
	unsigned int	me_numreaders;	/**< max numreaders set by this env */
927
928
	MDB_dbi		me_numdbs;		/**< number of DBs opened */
	MDB_dbi		me_maxdbs;		/**< size of the DB table */
929
	pid_t		me_pid;		/**< process ID of this env */
Howard Chu's avatar
Howard Chu committed
930
931
932
933
934
935
936
937
	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 */
Howard Chu's avatar
Howard Chu committed
938
939
	txnid_t		me_pgfirst;		/**< ID of first old page record we used */
	txnid_t		me_pglast;		/**< ID of last old page record we used */
Howard Chu's avatar
Howard Chu committed
940
	MDB_dbx		*me_dbxs;		/**< array of static DB info */
941
	uint16_t	*me_dbflags;	/**< array of DB flags */
Howard Chu's avatar
Howard Chu committed
942
	MDB_oldpages *me_pghead;	/**< list of old page records */
943
	MDB_oldpages *me_pgfree;	/**< list of page records to free */
Howard Chu's avatar
Howard Chu committed
944
945
946
	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 */
947
	MDB_IDL		me_free_pgs;
Howard Chu's avatar
Howard Chu committed
948
	/** ID2L of pages that were written during a write txn */
949
	MDB_ID2		me_dirty_list[MDB_IDL_UM_SIZE];
Howard Chu's avatar
Howard Chu committed
950
951
952
#ifdef _WIN32
	HANDLE		me_rmutex;		/* Windows mutexes don't reside in shared mem */
	HANDLE		me_wmutex;
953
954
#elif defined(MDB_USE_POSIX_SEM)
	sem_t		*me_rmutex;		/* Shared mutexes are not supported */
Howard Chu's avatar
Howard Chu committed
955
956
	sem_t		*me_wmutex;
#endif
Howard Chu's avatar
Howard Chu committed
957
};
Howard Chu's avatar
Howard Chu committed
958
959
	/** max number of pages to commit in one writev() call */
#define MDB_COMMIT_PAGES	 64
960
961
962
963
#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
964

965
966
967
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
968

Howard Chu's avatar
Howard Chu committed
969
static int  mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp);
Howard Chu's avatar
Howard Chu committed
970
static int  mdb_page_search_root(MDB_cursor *mc,
971
			    MDB_val *key, int modify);
972
973
#define MDB_PS_MODIFY	1
#define MDB_PS_ROOTONLY	2
Howard Chu's avatar
Howard Chu committed
974
static int  mdb_page_search(MDB_cursor *mc,
975
			    MDB_val *key, int flags);
Howard Chu's avatar
Howard Chu committed
976
static int	mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
Howard Chu's avatar
Howard Chu committed
977
978

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

Howard Chu's avatar
Howard Chu committed
982
static int  mdb_env_read_header(MDB_env *env, MDB_meta *meta);
983
static int  mdb_env_pick_meta(const MDB_env *env);
Howard Chu's avatar
Howard Chu committed
984
static int  mdb_env_write_meta(MDB_txn *txn);
985
static void mdb_env_close0(MDB_env *env, int excl);
Howard Chu's avatar
Howard Chu committed
986

Howard Chu's avatar
Howard Chu committed
987
988
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
989
			    MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
Howard Chu's avatar
Howard Chu committed
990
static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
Howard Chu's avatar
Howard Chu committed
991
static void mdb_node_shrink(MDB_page *mp, indx_t indx);
Howard Chu's avatar
Howard Chu committed
992
static int	mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
Howard Chu's avatar
Howard Chu committed
993
static int  mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
Howard Chu's avatar
Howard Chu committed
994
995
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
996

997
static int	mdb_rebalance(MDB_cursor *mc);
Howard Chu's avatar
Howard Chu committed
998
static int	mdb_update_key(MDB_page *mp, indx_t indx, MDB_val *key);
999

Howard Chu's avatar
Howard Chu committed
1000
1001
static void	mdb_cursor_pop(MDB_cursor *mc);
static int	mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1002

Howard Chu's avatar
Howard Chu committed
1003
static int	mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
Howard Chu's avatar
Howard Chu committed
1004
static int	mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1005
1006
1007
1008
1009
1010
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
1011

Howard Chu's avatar
Howard Chu committed
1012
static void	mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
Howard Chu's avatar
Howard Chu committed
1013
static void	mdb_xcursor_init0(MDB_cursor *mc);
1014
static void	mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
Howard Chu's avatar
Howard Chu committed
1015

Howard Chu's avatar
Howard Chu committed
1016
static int	mdb_drop0(MDB_cursor *mc, int subs);
Howard Chu's avatar
Howard Chu committed
1017
1018
static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);

Howard Chu's avatar
Howard Chu committed
1019
/** @cond */
Howard Chu's avatar
Howard Chu committed
1020
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
1021
/** @endcond */
Howard Chu's avatar
Howard Chu committed
1022

Howard Chu's avatar
Howard Chu committed
1023
1024
1025
1026
1027
1028
#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
1029
/** Return the library version info. */
Howard Chu's avatar
Howard Chu committed
1030
char *
Howard Chu's avatar
Howard Chu committed
1031
mdb_version(int *major, int *minor, int *patch)
Howard Chu's avatar
Howard Chu committed
1032
{
Howard Chu's avatar
Howard Chu committed
1033
1034
1035
	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
1036
1037
1038
	return MDB_VERSION_STRING;
}

Howard Chu's avatar
Howard Chu committed
1039
/** Table of descriptions for MDB @ref errors */
Howard Chu's avatar
Howard Chu committed
1040
static char *const mdb_errstr[] = {
1041
1042
1043
1044
1045
	"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",
1046
	"MDB_VERSION_MISMATCH: Database environment version mismatch",
1047
	"MDB_INVALID: File is not an MDB file",
1048
1049
1050
1051
1052
1053
	"MDB_MAP_FULL: Environment mapsize limit reached",
	"MDB_DBS_FULL: Environment maxdbs limit reached",
	"MDB_READERS_FULL: Environment maxreaders limit reached",
	"MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
	"MDB_TXN_FULL: Nested transaction has too many dirty pages - transaction too big",
	"MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1054
	"MDB_PAGE_FULL: Internal error - page has no more space"
1055
1056
1057
1058
1059
};

char *
mdb_strerror(int err)
{
1060
	int i;
1061
1062
1063
	if (!err)
		return ("Successful return: 0");

1064
1065
1066
1067
	if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
		i = err - MDB_KEYEXIST;
		return mdb_errstr[i];
	}
1068
1069
1070
1071

	return strerror(err);
}

Howard Chu's avatar
Howard Chu committed
1072
#if MDB_DEBUG
Howard Chu's avatar
Howard Chu committed
1073
1074
1075
1076
1077
/** 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.
 */
1078
char *
Howard Chu's avatar
Howard Chu committed
1079
1080
1081
1082
1083
1084
1085
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
1086
1087
1088
	/* may want to make this a dynamic check: if the key is mostly
	 * printable characters, print it as-is instead of converting to hex.
	 */
1089
#if 1
1090
	buf[0] = '\0';
Howard Chu's avatar
Howard Chu committed
1091
1092
	for (i=0; i<key->mv_size; i++)
		ptr += sprintf(ptr, "%02x", *c++);