2 * @brief Lightning memory-mapped database library
4 * A Btree-based database management library modeled loosely on the
5 * BerkeleyDB API, but much simplified.
8 * Copyright 2011-2015 Howard Chu, Symas Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted only as authorized by the OpenLDAP
15 * A copy of this license is available in the file LICENSE in the
16 * top-level directory of the distribution or, alternatively, at
17 * <http://www.OpenLDAP.org/license.html>.
19 * This code is derived from btree.c written by Martin Hedenfalk.
21 * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
23 * Permission to use, copy, modify, and distribute this software for any
24 * purpose with or without fee is hereby granted, provided that the above
25 * copyright notice and this permission notice appear in all copies.
27 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
28 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
29 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
30 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
31 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
32 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
33 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
41 /** getpid() returns int; MinGW defines pid_t but MinGW64 typedefs it
42 * as int64 which is wrong. MSVC doesn't define it at all, so just
46 #define MDB_THR_T DWORD
47 #include <sys/types.h>
50 # include <sys/param.h>
52 # define LITTLE_ENDIAN 1234
53 # define BIG_ENDIAN 4321
54 # define BYTE_ORDER LITTLE_ENDIAN
56 # define SSIZE_MAX INT_MAX
60 #include <sys/types.h>
62 #define MDB_PID_T pid_t
63 #define MDB_THR_T pthread_t
64 #include <sys/param.h>
67 #ifdef HAVE_SYS_FILE_H
73 #if defined(__mips) && defined(__linux)
74 /* MIPS has cache coherency issues, requires explicit cache control */
75 #include <asm/cachectl.h>
76 extern int cacheflush(char *addr, int nbytes, int cache);
77 #define CACHEFLUSH(addr, bytes, cache) cacheflush(addr, bytes, cache)
79 #define CACHEFLUSH(addr, bytes, cache)
82 #if defined(__linux) && !defined(MDB_FDATASYNC_WORKS)
83 /** fdatasync is broken on ext3/ext4fs on older kernels, see
84 * description in #mdb_env_open2 comments. You can safely
85 * define MDB_FDATASYNC_WORKS if this code will only be run
86 * on kernels 3.6 and newer.
88 #define BROKEN_FDATASYNC
101 #if defined(__sun) || defined(ANDROID)
102 /* Most platforms have posix_memalign, older may only have memalign */
103 #define HAVE_MEMALIGN 1
107 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
108 #include <netinet/in.h>
109 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
112 #if defined(__APPLE__) || defined (BSD)
113 # if !(defined(MDB_USE_POSIX_MUTEX) || defined(MDB_USE_POSIX_SEM))
114 # define MDB_USE_SYSV_SEM 1
116 # define MDB_FDATASYNC fsync
117 #elif defined(ANDROID)
118 # define MDB_FDATASYNC fsync
123 #ifdef MDB_USE_POSIX_SEM
124 # define MDB_USE_HASH 1
125 #include <semaphore.h>
126 #elif defined(MDB_USE_SYSV_SEM)
129 #ifdef _SEM_SEMUN_UNDEFINED
132 struct semid_ds *buf;
133 unsigned short *array;
135 #endif /* _SEM_SEMUN_UNDEFINED */
137 #define MDB_USE_POSIX_MUTEX 1
138 #endif /* MDB_USE_POSIX_SEM */
141 #if defined(_WIN32) + defined(MDB_USE_POSIX_SEM) + defined(MDB_USE_SYSV_SEM) \
142 + defined(MDB_USE_POSIX_MUTEX) != 1
143 # error "Ambiguous shared-lock implementation"
147 #include <valgrind/memcheck.h>
148 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
149 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
150 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
151 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
152 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
154 #define VGMEMP_CREATE(h,r,z)
155 #define VGMEMP_ALLOC(h,a,s)
156 #define VGMEMP_FREE(h,a)
157 #define VGMEMP_DESTROY(h)
158 #define VGMEMP_DEFINED(a,s)
162 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
163 /* Solaris just defines one or the other */
164 # define LITTLE_ENDIAN 1234
165 # define BIG_ENDIAN 4321
166 # ifdef _LITTLE_ENDIAN
167 # define BYTE_ORDER LITTLE_ENDIAN
169 # define BYTE_ORDER BIG_ENDIAN
172 # define BYTE_ORDER __BYTE_ORDER
176 #ifndef LITTLE_ENDIAN
177 #define LITTLE_ENDIAN __LITTLE_ENDIAN
180 #define BIG_ENDIAN __BIG_ENDIAN
183 #if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
184 #define MISALIGNED_OK 1
190 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
191 # error "Unknown or unsupported endianness (BYTE_ORDER)"
192 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
193 # error "Two's complement, reasonably sized integer types, please"
197 /** Put infrequently used env functions in separate section */
199 # define ESECT __attribute__ ((section("__TEXT,text_env")))
201 # define ESECT __attribute__ ((section("text_env")))
207 /** @defgroup internal LMDB Internals
210 /** @defgroup compat Compatibility Macros
211 * A bunch of macros to minimize the amount of platform-specific ifdefs
212 * needed throughout the rest of the code. When the features this library
213 * needs are similar enough to POSIX to be hidden in a one-or-two line
214 * replacement, this macro approach is used.
218 /** Features under development */
223 /** Wrapper around __func__, which is a C99 feature */
224 #if __STDC_VERSION__ >= 199901L
225 # define mdb_func_ __func__
226 #elif __GNUC__ >= 2 || _MSC_VER >= 1300
227 # define mdb_func_ __FUNCTION__
229 /* If a debug message says <mdb_unknown>(), update the #if statements above */
230 # define mdb_func_ "<mdb_unknown>"
233 /* Internal error codes, not exposed outside liblmdb */
234 #define MDB_NO_ROOT (MDB_LAST_ERRCODE + 10)
236 #define MDB_OWNERDEAD ((int) WAIT_ABANDONED)
237 #elif defined MDB_USE_SYSV_SEM
238 #define MDB_OWNERDEAD (MDB_LAST_ERRCODE + 11)
239 #elif defined(MDB_USE_POSIX_MUTEX) && defined(EOWNERDEAD)
240 #define MDB_OWNERDEAD EOWNERDEAD /**< #LOCK_MUTEX0() result if dead owner */
244 #define MDB_ROBUST_SUPPORTED 1
248 #define MDB_USE_HASH 1
249 #define MDB_PIDLOCK 0
250 #define THREAD_RET DWORD
251 #define pthread_t HANDLE
252 #define pthread_mutex_t HANDLE
253 #define pthread_cond_t HANDLE
254 typedef HANDLE mdb_mutex_t, mdb_mutexref_t;
255 #define pthread_key_t DWORD
256 #define pthread_self() GetCurrentThreadId()
257 #define pthread_key_create(x,y) \
258 ((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
259 #define pthread_key_delete(x) TlsFree(x)
260 #define pthread_getspecific(x) TlsGetValue(x)
261 #define pthread_setspecific(x,y) (TlsSetValue(x,y) ? 0 : ErrCode())
262 #define pthread_mutex_unlock(x) ReleaseMutex(*x)
263 #define pthread_mutex_lock(x) WaitForSingleObject(*x, INFINITE)
264 #define pthread_cond_signal(x) SetEvent(*x)
265 #define pthread_cond_wait(cond,mutex) do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
266 #define THREAD_CREATE(thr,start,arg) thr=CreateThread(NULL,0,start,arg,0,NULL)
267 #define THREAD_FINISH(thr) WaitForSingleObject(thr, INFINITE)
268 #define LOCK_MUTEX0(mutex) WaitForSingleObject(mutex, INFINITE)
269 #define UNLOCK_MUTEX(mutex) ReleaseMutex(mutex)
270 #define mdb_mutex_consistent(mutex) 0
271 #define getpid() GetCurrentProcessId()
272 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
273 #define MDB_MSYNC(addr,len,flags) (!FlushViewOfFile(addr,len))
274 #define ErrCode() GetLastError()
275 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
276 #define close(fd) (CloseHandle(fd) ? 0 : -1)
277 #define munmap(ptr,len) UnmapViewOfFile(ptr)
278 #ifdef PROCESS_QUERY_LIMITED_INFORMATION
279 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
281 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
285 #define THREAD_RET void *
286 #define THREAD_CREATE(thr,start,arg) pthread_create(&thr,NULL,start,arg)
287 #define THREAD_FINISH(thr) pthread_join(thr,NULL)
288 #define Z "z" /**< printf format modifier for size_t */
290 /** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
291 #define MDB_PIDLOCK 1
293 #ifdef MDB_USE_POSIX_SEM
295 typedef sem_t *mdb_mutex_t, *mdb_mutexref_t;
296 #define LOCK_MUTEX0(mutex) mdb_sem_wait(mutex)
297 #define UNLOCK_MUTEX(mutex) sem_post(mutex)
300 mdb_sem_wait(sem_t *sem)
303 while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
307 #elif defined MDB_USE_SYSV_SEM
309 typedef struct mdb_mutex {
313 } mdb_mutex_t[1], *mdb_mutexref_t;
315 #define LOCK_MUTEX0(mutex) mdb_sem_wait(mutex)
316 #define UNLOCK_MUTEX(mutex) do { \
317 struct sembuf sb = { 0, 1, SEM_UNDO }; \
318 sb.sem_num = (mutex)->semnum; \
319 *(mutex)->locked = 0; \
320 semop((mutex)->semid, &sb, 1); \
324 mdb_sem_wait(mdb_mutexref_t sem)
326 int rc, *locked = sem->locked;
327 struct sembuf sb = { 0, -1, SEM_UNDO };
328 sb.sem_num = sem->semnum;
330 if (!semop(sem->semid, &sb, 1)) {
331 rc = *locked ? MDB_OWNERDEAD : MDB_SUCCESS;
335 } while ((rc = errno) == EINTR);
339 #define mdb_mutex_consistent(mutex) 0
341 #else /* MDB_USE_POSIX_MUTEX: */
342 /** Shared mutex/semaphore as it is stored (mdb_mutex_t), and as
343 * local variables keep it (mdb_mutexref_t).
345 * An mdb_mutex_t can be assigned to an mdb_mutexref_t. They can
346 * be the same, or an array[size 1] and a pointer.
349 typedef pthread_mutex_t mdb_mutex_t[1], *mdb_mutexref_t;
351 /** Lock the reader or writer mutex.
352 * Returns 0 or a code to give #mdb_mutex_failed(), as in #LOCK_MUTEX().
354 #define LOCK_MUTEX0(mutex) pthread_mutex_lock(mutex)
355 /** Unlock the reader or writer mutex.
357 #define UNLOCK_MUTEX(mutex) pthread_mutex_unlock(mutex)
358 /** Mark mutex-protected data as repaired, after death of previous owner.
360 #define mdb_mutex_consistent(mutex) pthread_mutex_consistent(mutex)
361 #endif /* MDB_USE_POSIX_SEM || MDB_USE_SYSV_SEM */
363 /** Get the error code for the last failed system function.
365 #define ErrCode() errno
367 /** An abstraction for a file handle.
368 * On POSIX systems file handles are small integers. On Windows
369 * they're opaque pointers.
373 /** A value for an invalid file handle.
374 * Mainly used to initialize file variables and signify that they are
377 #define INVALID_HANDLE_VALUE (-1)
379 /** Get the size of a memory page for the system.
380 * This is the basic size that the platform's memory manager uses, and is
381 * fundamental to the use of memory-mapped files.
383 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
386 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
388 #elif defined(MDB_USE_SYSV_SEM)
389 #define MNAME_LEN (sizeof(int))
391 #define MNAME_LEN (sizeof(pthread_mutex_t))
394 #ifdef MDB_USE_SYSV_SEM
395 #define SYSV_SEM_FLAG 1 /**< SysV sems in lockfile format */
397 #define SYSV_SEM_FLAG 0
402 #ifdef MDB_ROBUST_SUPPORTED
403 /** Lock mutex, handle any error, set rc = result.
404 * Return 0 on success, nonzero (not rc) on error.
406 #define LOCK_MUTEX(rc, env, mutex) \
407 (((rc) = LOCK_MUTEX0(mutex)) && \
408 ((rc) = mdb_mutex_failed(env, mutex, rc)))
409 static int mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc);
411 #define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
412 #define mdb_mutex_failed(env, mutex, rc) (rc)
416 /** A flag for opening a file and requesting synchronous data writes.
417 * This is only used when writing a meta page. It's not strictly needed;
418 * we could just do a normal write and then immediately perform a flush.
419 * But if this flag is available it saves us an extra system call.
421 * @note If O_DSYNC is undefined but exists in /usr/include,
422 * preferably set some compiler flag to get the definition.
423 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
426 # define MDB_DSYNC O_DSYNC
430 /** Function for flushing the data of a file. Define this to fsync
431 * if fdatasync() is not supported.
433 #ifndef MDB_FDATASYNC
434 # define MDB_FDATASYNC fdatasync
438 # define MDB_MSYNC(addr,len,flags) msync(addr,len,flags)
449 /** A page number in the database.
450 * Note that 64 bit page numbers are overkill, since pages themselves
451 * already represent 12-13 bits of addressable memory, and the OS will
452 * always limit applications to a maximum of 63 bits of address space.
454 * @note In the #MDB_node structure, we only store 48 bits of this value,
455 * which thus limits us to only 60 bits of addressable data.
457 typedef MDB_ID pgno_t;
459 /** A transaction ID.
460 * See struct MDB_txn.mt_txnid for details.
462 typedef MDB_ID txnid_t;
464 /** @defgroup debug Debug Macros
468 /** Enable debug output. Needs variable argument macros (a C99 feature).
469 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
470 * read from and written to the database (used for free space management).
476 static int mdb_debug;
477 static txnid_t mdb_debug_start;
479 /** Print a debug message with printf formatting.
480 * Requires double parenthesis around 2 or more args.
482 # define DPRINTF(args) ((void) ((mdb_debug) && DPRINTF0 args))
483 # define DPRINTF0(fmt, ...) \
484 fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
486 # define DPRINTF(args) ((void) 0)
488 /** Print a debug string.
489 * The string is printed literally, with no format processing.
491 #define DPUTS(arg) DPRINTF(("%s", arg))
492 /** Debuging output value of a cursor DBI: Negative in a sub-cursor. */
494 (((mc)->mc_flags & C_SUB) ? -(int)(mc)->mc_dbi : (int)(mc)->mc_dbi)
497 /** @brief The maximum size of a database page.
499 * It is 32k or 64k, since value-PAGEBASE must fit in
500 * #MDB_page.%mp_upper.
502 * LMDB will use database pages < OS pages if needed.
503 * That causes more I/O in write transactions: The OS must
504 * know (read) the whole page before writing a partial page.
506 * Note that we don't currently support Huge pages. On Linux,
507 * regular data files cannot use Huge pages, and in general
508 * Huge pages aren't actually pageable. We rely on the OS
509 * demand-pager to read our data and page it out when memory
510 * pressure from other processes is high. So until OSs have
511 * actual paging support for Huge pages, they're not viable.
513 #define MAX_PAGESIZE (PAGEBASE ? 0x10000 : 0x8000)
515 /** The minimum number of keys required in a database page.
516 * Setting this to a larger value will place a smaller bound on the
517 * maximum size of a data item. Data items larger than this size will
518 * be pushed into overflow pages instead of being stored directly in
519 * the B-tree node. This value used to default to 4. With a page size
520 * of 4096 bytes that meant that any item larger than 1024 bytes would
521 * go into an overflow page. That also meant that on average 2-3KB of
522 * each overflow page was wasted space. The value cannot be lower than
523 * 2 because then there would no longer be a tree structure. With this
524 * value, items larger than 2KB will go into overflow pages, and on
525 * average only 1KB will be wasted.
527 #define MDB_MINKEYS 2
529 /** A stamp that identifies a file as an LMDB file.
530 * There's nothing special about this value other than that it is easily
531 * recognizable, and it will reflect any byte order mismatches.
533 #define MDB_MAGIC 0xBEEFC0DE
535 /** The version number for a database's datafile format. */
536 #define MDB_DATA_VERSION ((MDB_DEVEL) ? 999 : 1)
537 /** The version number for a database's lockfile format. */
538 #define MDB_LOCK_VERSION ((MDB_DEVEL) ? 999 : 1)
540 /** @brief The max size of a key we can write, or 0 for computed max.
542 * This macro should normally be left alone or set to 0.
543 * Note that a database with big keys or dupsort data cannot be
544 * reliably modified by a liblmdb which uses a smaller max.
545 * The default is 511 for backwards compat, or 0 when #MDB_DEVEL.
547 * Other values are allowed, for backwards compat. However:
548 * A value bigger than the computed max can break if you do not
549 * know what you are doing, and liblmdb <= 0.9.10 can break when
550 * modifying a DB with keys/dupsort data bigger than its max.
552 * Data items in an #MDB_DUPSORT database are also limited to
553 * this size, since they're actually keys of a sub-DB. Keys and
554 * #MDB_DUPSORT data items must fit on a node in a regular page.
556 #ifndef MDB_MAXKEYSIZE
557 #define MDB_MAXKEYSIZE ((MDB_DEVEL) ? 0 : 511)
560 /** The maximum size of a key we can write to the environment. */
562 #define ENV_MAXKEY(env) (MDB_MAXKEYSIZE)
564 #define ENV_MAXKEY(env) ((env)->me_maxkey)
567 /** @brief The maximum size of a data item.
569 * We only store a 32 bit value for node sizes.
571 #define MAXDATASIZE 0xffffffffUL
574 /** Key size which fits in a #DKBUF.
577 #define DKBUF_MAXKEYSIZE ((MDB_MAXKEYSIZE) > 0 ? (MDB_MAXKEYSIZE) : 511)
580 * This is used for printing a hex dump of a key's contents.
582 #define DKBUF char kbuf[DKBUF_MAXKEYSIZE*2+1]
583 /** Display a key in hex.
585 * Invoke a function to display a key in hex.
587 #define DKEY(x) mdb_dkey(x, kbuf)
593 /** An invalid page number.
594 * Mainly used to denote an empty tree.
596 #define P_INVALID (~(pgno_t)0)
598 /** Test if the flags \b f are set in a flag word \b w. */
599 #define F_ISSET(w, f) (((w) & (f)) == (f))
601 /** Round \b n up to an even number. */
602 #define EVEN(n) (((n) + 1U) & -2) /* sign-extending -2 to match n+1U */
604 /** Used for offsets within a single page.
605 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
608 typedef uint16_t indx_t;
610 /** Default size of memory map.
611 * This is certainly too small for any actual applications. Apps should always set
612 * the size explicitly using #mdb_env_set_mapsize().
614 #define DEFAULT_MAPSIZE 1048576
616 /** @defgroup readers Reader Lock Table
617 * Readers don't acquire any locks for their data access. Instead, they
618 * simply record their transaction ID in the reader table. The reader
619 * mutex is needed just to find an empty slot in the reader table. The
620 * slot's address is saved in thread-specific data so that subsequent read
621 * transactions started by the same thread need no further locking to proceed.
623 * If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
625 * No reader table is used if the database is on a read-only filesystem, or
626 * if #MDB_NOLOCK is set.
628 * Since the database uses multi-version concurrency control, readers don't
629 * actually need any locking. This table is used to keep track of which
630 * readers are using data from which old transactions, so that we'll know
631 * when a particular old transaction is no longer in use. Old transactions
632 * that have discarded any data pages can then have those pages reclaimed
633 * for use by a later write transaction.
635 * The lock table is constructed such that reader slots are aligned with the
636 * processor's cache line size. Any slot is only ever used by one thread.
637 * This alignment guarantees that there will be no contention or cache
638 * thrashing as threads update their own slot info, and also eliminates
639 * any need for locking when accessing a slot.
641 * A writer thread will scan every slot in the table to determine the oldest
642 * outstanding reader transaction. Any freed pages older than this will be
643 * reclaimed by the writer. The writer doesn't use any locks when scanning
644 * this table. This means that there's no guarantee that the writer will
645 * see the most up-to-date reader info, but that's not required for correct
646 * operation - all we need is to know the upper bound on the oldest reader,
647 * we don't care at all about the newest reader. So the only consequence of
648 * reading stale information here is that old pages might hang around a
649 * while longer before being reclaimed. That's actually good anyway, because
650 * the longer we delay reclaiming old pages, the more likely it is that a
651 * string of contiguous pages can be found after coalescing old pages from
652 * many old transactions together.
655 /** Number of slots in the reader table.
656 * This value was chosen somewhat arbitrarily. 126 readers plus a
657 * couple mutexes fit exactly into 8KB on my development machine.
658 * Applications should set the table size using #mdb_env_set_maxreaders().
660 #define DEFAULT_READERS 126
662 /** The size of a CPU cache line in bytes. We want our lock structures
663 * aligned to this size to avoid false cache line sharing in the
665 * This value works for most CPUs. For Itanium this should be 128.
671 /** The information we store in a single slot of the reader table.
672 * In addition to a transaction ID, we also record the process and
673 * thread ID that owns a slot, so that we can detect stale information,
674 * e.g. threads or processes that went away without cleaning up.
675 * @note We currently don't check for stale records. We simply re-init
676 * the table when we know that we're the only process opening the
679 typedef struct MDB_rxbody {
680 /** Current Transaction ID when this transaction began, or (txnid_t)-1.
681 * Multiple readers that start at the same time will probably have the
682 * same ID here. Again, it's not important to exclude them from
683 * anything; all we need to know is which version of the DB they
684 * started from so we can avoid overwriting any data used in that
685 * particular version.
687 volatile txnid_t mrb_txnid;
688 /** The process ID of the process owning this reader txn. */
689 volatile MDB_PID_T mrb_pid;
690 /** The thread ID of the thread owning this txn. */
691 volatile MDB_THR_T mrb_tid;
694 /** The actual reader record, with cacheline padding. */
695 typedef struct MDB_reader {
698 /** shorthand for mrb_txnid */
699 #define mr_txnid mru.mrx.mrb_txnid
700 #define mr_pid mru.mrx.mrb_pid
701 #define mr_tid mru.mrx.mrb_tid
702 /** cache line alignment */
703 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
707 /** The header for the reader table.
708 * The table resides in a memory-mapped file. (This is a different file
709 * than is used for the main database.)
711 * For POSIX the actual mutexes reside in the shared memory of this
712 * mapped file. On Windows, mutexes are named objects allocated by the
713 * kernel; we store the mutex names in this mapped file so that other
714 * processes can grab them. This same approach is also used on
715 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
716 * process-shared POSIX mutexes. For these cases where a named object
717 * is used, the object name is derived from a 64 bit FNV hash of the
718 * environment pathname. As such, naming collisions are extremely
719 * unlikely. If a collision occurs, the results are unpredictable.
721 typedef struct MDB_txbody {
722 /** Stamp identifying this as an LMDB file. It must be set
725 /** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
727 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
728 char mtb_rmname[MNAME_LEN];
729 #elif defined(MDB_USE_SYSV_SEM)
733 /** Mutex protecting access to this table.
734 * This is the reader table lock used with LOCK_MUTEX().
736 mdb_mutex_t mtb_rmutex;
738 /** The ID of the last transaction committed to the database.
739 * This is recorded here only for convenience; the value can always
740 * be determined by reading the main database meta pages.
742 volatile txnid_t mtb_txnid;
743 /** The number of slots that have been used in the reader table.
744 * This always records the maximum count, it is not decremented
745 * when readers release their slots.
747 volatile unsigned mtb_numreaders;
750 /** The actual reader table definition. */
751 typedef struct MDB_txninfo {
754 #define mti_magic mt1.mtb.mtb_magic
755 #define mti_format mt1.mtb.mtb_format
756 #define mti_rmutex mt1.mtb.mtb_rmutex
757 #define mti_rmname mt1.mtb.mtb_rmname
758 #define mti_txnid mt1.mtb.mtb_txnid
759 #define mti_numreaders mt1.mtb.mtb_numreaders
760 #ifdef MDB_USE_SYSV_SEM
761 #define mti_semid mt1.mtb.mtb_semid
762 #define mti_rlocked mt1.mtb.mtb_rlocked
764 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
767 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
768 char mt2_wmname[MNAME_LEN];
769 #define mti_wmname mt2.mt2_wmname
770 #elif defined MDB_USE_SYSV_SEM
772 #define mti_wlocked mt2.mt2_wlocked
774 mdb_mutex_t mt2_wmutex;
775 #define mti_wmutex mt2.mt2_wmutex
777 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
779 MDB_reader mti_readers[1];
782 /** Lockfile format signature: version, features and field layout */
783 #define MDB_LOCK_FORMAT \
785 ((MDB_LOCK_VERSION) \
786 /* Flags which describe functionality */ \
787 + (SYSV_SEM_FLAG << 18) \
788 + (((MDB_PIDLOCK) != 0) << 16)))
791 /** Common header for all page types.
792 * Overflow records occupy a number of contiguous pages with no
793 * headers on any page after the first.
795 typedef struct MDB_page {
796 #define mp_pgno mp_p.p_pgno
797 #define mp_next mp_p.p_next
799 pgno_t p_pgno; /**< page number */
800 struct MDB_page *p_next; /**< for in-memory list of freed pages */
803 /** @defgroup mdb_page Page Flags
805 * Flags for the page headers.
808 #define P_BRANCH 0x01 /**< branch page */
809 #define P_LEAF 0x02 /**< leaf page */
810 #define P_OVERFLOW 0x04 /**< overflow page */
811 #define P_META 0x08 /**< meta page */
812 #define P_DIRTY 0x10 /**< dirty page, also set for #P_SUBP pages */
813 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
814 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
815 #define P_LOOSE 0x4000 /**< page was dirtied then freed, can be reused */
816 #define P_KEEP 0x8000 /**< leave this page alone during spill */
818 uint16_t mp_flags; /**< @ref mdb_page */
819 #define mp_lower mp_pb.pb.pb_lower
820 #define mp_upper mp_pb.pb.pb_upper
821 #define mp_pages mp_pb.pb_pages
824 indx_t pb_lower; /**< lower bound of free space */
825 indx_t pb_upper; /**< upper bound of free space */
827 uint32_t pb_pages; /**< number of overflow pages */
829 indx_t mp_ptrs[1]; /**< dynamic size */
832 /** Size of the page header, excluding dynamic data at the end */
833 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
835 /** Address of first usable data byte in a page, after the header */
836 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
838 /** ITS#7713, change PAGEBASE to handle 65536 byte pages */
839 #define PAGEBASE ((MDB_DEVEL) ? PAGEHDRSZ : 0)
841 /** Number of nodes on a page */
842 #define NUMKEYS(p) (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
844 /** The amount of space remaining in the page */
845 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
847 /** The percentage of space used in the page, in tenths of a percent. */
848 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
849 ((env)->me_psize - PAGEHDRSZ))
850 /** The minimum page fill factor, in tenths of a percent.
851 * Pages emptier than this are candidates for merging.
853 #define FILL_THRESHOLD 250
855 /** Test if a page is a leaf page */
856 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
857 /** Test if a page is a LEAF2 page */
858 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
859 /** Test if a page is a branch page */
860 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
861 /** Test if a page is an overflow page */
862 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
863 /** Test if a page is a sub page */
864 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
866 /** The number of overflow pages needed to store the given size. */
867 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
869 /** Link in #MDB_txn.%mt_loose_pgs list */
870 #define NEXT_LOOSE_PAGE(p) (*(MDB_page **)((p) + 2))
872 /** Header for a single key/data pair within a page.
873 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
874 * We guarantee 2-byte alignment for 'MDB_node's.
876 typedef struct MDB_node {
877 /** lo and hi are used for data size on leaf nodes and for
878 * child pgno on branch nodes. On 64 bit platforms, flags
879 * is also used for pgno. (Branch nodes have no flags).
880 * They are in host byte order in case that lets some
881 * accesses be optimized into a 32-bit word access.
883 #if BYTE_ORDER == LITTLE_ENDIAN
884 unsigned short mn_lo, mn_hi; /**< part of data size or pgno */
886 unsigned short mn_hi, mn_lo;
888 /** @defgroup mdb_node Node Flags
890 * Flags for node headers.
893 #define F_BIGDATA 0x01 /**< data put on overflow page */
894 #define F_SUBDATA 0x02 /**< data is a sub-database */
895 #define F_DUPDATA 0x04 /**< data has duplicates */
897 /** valid flags for #mdb_node_add() */
898 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
901 unsigned short mn_flags; /**< @ref mdb_node */
902 unsigned short mn_ksize; /**< key size */
903 char mn_data[1]; /**< key and data are appended here */
906 /** Size of the node header, excluding dynamic data at the end */
907 #define NODESIZE offsetof(MDB_node, mn_data)
909 /** Bit position of top word in page number, for shifting mn_flags */
910 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
912 /** Size of a node in a branch page with a given key.
913 * This is just the node header plus the key, there is no data.
915 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
917 /** Size of a node in a leaf page with a given key and data.
918 * This is node header plus key plus data size.
920 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
922 /** Address of node \b i in page \b p */
923 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
925 /** Address of the key for the node */
926 #define NODEKEY(node) (void *)((node)->mn_data)
928 /** Address of the data for a node */
929 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
931 /** Get the page number pointed to by a branch node */
932 #define NODEPGNO(node) \
933 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
934 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
935 /** Set the page number in a branch node */
936 #define SETPGNO(node,pgno) do { \
937 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
938 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
940 /** Get the size of the data in a leaf node */
941 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
942 /** Set the size of the data for a leaf node */
943 #define SETDSZ(node,size) do { \
944 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
945 /** The size of a key in a node */
946 #define NODEKSZ(node) ((node)->mn_ksize)
948 /** Copy a page number from src to dst */
950 #define COPY_PGNO(dst,src) dst = src
952 #if SIZE_MAX > 4294967295UL
953 #define COPY_PGNO(dst,src) do { \
954 unsigned short *s, *d; \
955 s = (unsigned short *)&(src); \
956 d = (unsigned short *)&(dst); \
963 #define COPY_PGNO(dst,src) do { \
964 unsigned short *s, *d; \
965 s = (unsigned short *)&(src); \
966 d = (unsigned short *)&(dst); \
972 /** The address of a key in a LEAF2 page.
973 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
974 * There are no node headers, keys are stored contiguously.
976 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
978 /** Set the \b node's key into \b keyptr, if requested. */
979 #define MDB_GET_KEY(node, keyptr) { if ((keyptr) != NULL) { \
980 (keyptr)->mv_size = NODEKSZ(node); (keyptr)->mv_data = NODEKEY(node); } }
982 /** Set the \b node's key into \b key. */
983 #define MDB_GET_KEY2(node, key) { key.mv_size = NODEKSZ(node); key.mv_data = NODEKEY(node); }
985 /** Information about a single database in the environment. */
986 typedef struct MDB_db {
987 uint32_t md_pad; /**< also ksize for LEAF2 pages */
988 uint16_t md_flags; /**< @ref mdb_dbi_open */
989 uint16_t md_depth; /**< depth of this tree */
990 pgno_t md_branch_pages; /**< number of internal pages */
991 pgno_t md_leaf_pages; /**< number of leaf pages */
992 pgno_t md_overflow_pages; /**< number of overflow pages */
993 size_t md_entries; /**< number of data items */
994 pgno_t md_root; /**< the root page of this tree */
997 /** mdb_dbi_open flags */
998 #define MDB_VALID 0x8000 /**< DB handle is valid, for me_dbflags */
999 #define PERSISTENT_FLAGS (0xffff & ~(MDB_VALID))
1000 #define VALID_FLAGS (MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
1001 MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)
1003 /** Handle for the DB used to track free pages. */
1005 /** Handle for the default DB. */
1008 /** Meta page content.
1009 * A meta page is the start point for accessing a database snapshot.
1010 * Pages 0-1 are meta pages. Transaction N writes meta page #(N % 2).
1012 typedef struct MDB_meta {
1013 /** Stamp identifying this as an LMDB file. It must be set
1016 /** Version number of this file. Must be set to #MDB_DATA_VERSION. */
1017 uint32_t mm_version;
1018 void *mm_address; /**< address for fixed mapping */
1019 size_t mm_mapsize; /**< size of mmap region */
1020 MDB_db mm_dbs[2]; /**< first is free space, 2nd is main db */
1021 /** The size of pages used in this DB */
1022 #define mm_psize mm_dbs[0].md_pad
1023 /** Any persistent environment flags. @ref mdb_env */
1024 #define mm_flags mm_dbs[0].md_flags
1025 pgno_t mm_last_pg; /**< last used page in file */
1026 volatile txnid_t mm_txnid; /**< txnid that committed this page */
1029 /** Buffer for a stack-allocated meta page.
1030 * The members define size and alignment, and silence type
1031 * aliasing warnings. They are not used directly; that could
1032 * mean incorrectly using several union members in parallel.
1034 typedef union MDB_metabuf {
1037 char mm_pad[PAGEHDRSZ];
1042 /** Auxiliary DB info.
1043 * The information here is mostly static/read-only. There is
1044 * only a single copy of this record in the environment.
1046 typedef struct MDB_dbx {
1047 MDB_val md_name; /**< name of the database */
1048 MDB_cmp_func *md_cmp; /**< function for comparing keys */
1049 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
1050 MDB_rel_func *md_rel; /**< user relocate function */
1051 void *md_relctx; /**< user-provided context for md_rel */
1054 /** A database transaction.
1055 * Every operation requires a transaction handle.
1058 MDB_txn *mt_parent; /**< parent of a nested txn */
1059 MDB_txn *mt_child; /**< nested txn under this txn */
1060 pgno_t mt_next_pgno; /**< next unallocated page */
1061 /** The ID of this transaction. IDs are integers incrementing from 1.
1062 * Only committed write transactions increment the ID. If a transaction
1063 * aborts, the ID may be re-used by the next writer.
1066 MDB_env *mt_env; /**< the DB environment */
1067 /** The list of pages that became unused during this transaction.
1069 MDB_IDL mt_free_pgs;
1070 /** The list of loose pages that became unused and may be reused
1071 * in this transaction, linked through #NEXT_LOOSE_PAGE(page).
1073 MDB_page *mt_loose_pgs;
1074 /* #Number of loose pages (#mt_loose_pgs) */
1076 /** The sorted list of dirty pages we temporarily wrote to disk
1077 * because the dirty list was full. page numbers in here are
1078 * shifted left by 1, deleted slots have the LSB set.
1080 MDB_IDL mt_spill_pgs;
1082 /** For write txns: Modified pages. Sorted when not MDB_WRITEMAP. */
1083 MDB_ID2L dirty_list;
1084 /** For read txns: This thread/txn's reader table slot, or NULL. */
1087 /** Array of records for each DB known in the environment. */
1089 /** Array of MDB_db records for each known DB */
1091 /** Array of sequence numbers for each DB handle */
1092 unsigned int *mt_dbiseqs;
1093 /** @defgroup mt_dbflag Transaction DB Flags
1097 #define DB_DIRTY 0x01 /**< DB was modified or is DUPSORT data */
1098 #define DB_STALE 0x02 /**< Named-DB record is older than txnID */
1099 #define DB_NEW 0x04 /**< Named-DB handle opened in this txn */
1100 #define DB_VALID 0x08 /**< DB handle is valid, see also #MDB_VALID */
1102 /** In write txns, array of cursors for each DB */
1103 MDB_cursor **mt_cursors;
1104 /** Array of flags for each DB */
1105 unsigned char *mt_dbflags;
1106 /** Number of DB records in use. This number only ever increments;
1107 * we don't decrement it when individual DB handles are closed.
1111 /** @defgroup mdb_txn Transaction Flags
1115 /** #mdb_txn_begin() flags */
1116 #define MDB_TXN_BEGIN_FLAGS (MDB_NOMETASYNC|MDB_NOSYNC|MDB_RDONLY)
1117 #define MDB_TXN_NOMETASYNC MDB_NOMETASYNC /**< don't sync meta for this txn on commit */
1118 #define MDB_TXN_NOSYNC MDB_NOSYNC /**< don't sync this txn on commit */
1119 #define MDB_TXN_RDONLY MDB_RDONLY /**< read-only transaction */
1120 /* internal txn flags */
1121 #define MDB_TXN_WRITEMAP MDB_WRITEMAP /**< copy of #MDB_env flag in writers */
1122 #define MDB_TXN_ERROR 0x02 /**< txn is unusable after an error */
1123 #define MDB_TXN_DIRTY 0x04 /**< must write, even if dirty list is empty */
1124 #define MDB_TXN_SPILLS 0x08 /**< txn or a parent has spilled pages */
1126 unsigned int mt_flags; /**< @ref mdb_txn */
1127 /** #dirty_list room: Array size - \#dirty pages visible to this txn.
1128 * Includes ancestor txns' dirty pages not hidden by other txns'
1129 * dirty/spilled pages. Thus commit(nested txn) has room to merge
1130 * dirty_list into mt_parent after freeing hidden mt_parent pages.
1132 unsigned int mt_dirty_room;
1135 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
1136 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
1137 * raise this on a 64 bit machine.
1139 #define CURSOR_STACK 32
1143 /** Cursors are used for all DB operations.
1144 * A cursor holds a path of (page pointer, key index) from the DB
1145 * root to a position in the DB, plus other state. #MDB_DUPSORT
1146 * cursors include an xcursor to the current data item. Write txns
1147 * track their cursors and keep them up to date when data moves.
1148 * Exception: An xcursor's pointer to a #P_SUBP page can be stale.
1149 * (A node with #F_DUPDATA but no #F_SUBDATA contains a subpage).
1152 /** Next cursor on this DB in this txn */
1153 MDB_cursor *mc_next;
1154 /** Backup of the original cursor if this cursor is a shadow */
1155 MDB_cursor *mc_backup;
1156 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
1157 struct MDB_xcursor *mc_xcursor;
1158 /** The transaction that owns this cursor */
1160 /** The database handle this cursor operates on */
1162 /** The database record for this cursor */
1164 /** The database auxiliary record for this cursor */
1166 /** The @ref mt_dbflag for this database */
1167 unsigned char *mc_dbflag;
1168 unsigned short mc_snum; /**< number of pushed pages */
1169 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
1170 /** @defgroup mdb_cursor Cursor Flags
1172 * Cursor state flags.
1175 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
1176 #define C_EOF 0x02 /**< No more data */
1177 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
1178 #define C_DEL 0x08 /**< last op was a cursor_del */
1179 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
1180 #define C_UNTRACK 0x40 /**< Un-track cursor when closing */
1182 unsigned int mc_flags; /**< @ref mdb_cursor */
1183 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
1184 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
1187 /** Context for sorted-dup records.
1188 * We could have gone to a fully recursive design, with arbitrarily
1189 * deep nesting of sub-databases. But for now we only handle these
1190 * levels - main DB, optional sub-DB, sorted-duplicate DB.
1192 typedef struct MDB_xcursor {
1193 /** A sub-cursor for traversing the Dup DB */
1194 MDB_cursor mx_cursor;
1195 /** The database record for this Dup DB */
1197 /** The auxiliary DB record for this Dup DB */
1199 /** The @ref mt_dbflag for this Dup DB */
1200 unsigned char mx_dbflag;
1203 /** State of FreeDB old pages, stored in the MDB_env */
1204 typedef struct MDB_pgstate {
1205 pgno_t *mf_pghead; /**< Reclaimed freeDB pages, or NULL before use */
1206 txnid_t mf_pglast; /**< ID of last used record, or 0 if !mf_pghead */
1209 /** The database environment. */
1211 HANDLE me_fd; /**< The main data file */
1212 HANDLE me_lfd; /**< The lock file */
1213 HANDLE me_mfd; /**< just for writing the meta pages */
1214 /** Failed to update the meta page. Probably an I/O error. */
1215 #define MDB_FATAL_ERROR 0x80000000U
1216 /** Some fields are initialized. */
1217 #define MDB_ENV_ACTIVE 0x20000000U
1218 /** me_txkey is set */
1219 #define MDB_ENV_TXKEY 0x10000000U
1220 /** fdatasync is unreliable */
1221 #define MDB_FSYNCONLY 0x08000000U
1222 uint32_t me_flags; /**< @ref mdb_env */
1223 unsigned int me_psize; /**< DB page size, inited from me_os_psize */
1224 unsigned int me_os_psize; /**< OS page size, from #GET_PAGESIZE */
1225 unsigned int me_maxreaders; /**< size of the reader table */
1226 /** Max #MDB_txninfo.%mti_numreaders of interest to #mdb_env_close() */
1227 volatile int me_close_readers;
1228 MDB_dbi me_numdbs; /**< number of DBs opened */
1229 MDB_dbi me_maxdbs; /**< size of the DB table */
1230 MDB_PID_T me_pid; /**< process ID of this env */
1231 char *me_path; /**< path to the DB files */
1232 char *me_map; /**< the memory map of the data file */
1233 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
1234 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
1235 void *me_pbuf; /**< scratch area for DUPSORT put() */
1236 MDB_txn *me_txn; /**< current write transaction */
1237 MDB_txn *me_txn0; /**< prealloc'd write transaction */
1238 size_t me_mapsize; /**< size of the data memory map */
1239 off_t me_size; /**< current file size */
1240 pgno_t me_maxpg; /**< me_mapsize / me_psize */
1241 MDB_dbx *me_dbxs; /**< array of static DB info */
1242 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
1243 unsigned int *me_dbiseqs; /**< array of dbi sequence numbers */
1244 pthread_key_t me_txkey; /**< thread-key for readers */
1245 txnid_t me_pgoldest; /**< ID of oldest reader last time we looked */
1246 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
1247 # define me_pglast me_pgstate.mf_pglast
1248 # define me_pghead me_pgstate.mf_pghead
1249 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
1250 /** IDL of pages that became unused in a write txn */
1251 MDB_IDL me_free_pgs;
1252 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
1253 MDB_ID2L me_dirty_list;
1254 /** Max number of freelist items that can fit in a single overflow page */
1256 /** Max size of a node on a page */
1257 unsigned int me_nodemax;
1258 #if !(MDB_MAXKEYSIZE)
1259 unsigned int me_maxkey; /**< max size of a key */
1261 int me_live_reader; /**< have liveness lock in reader table */
1263 int me_pidquery; /**< Used in OpenProcess */
1265 #ifdef MDB_USE_POSIX_MUTEX /* Posix mutexes reside in shared mem */
1266 # define me_rmutex me_txns->mti_rmutex /**< Shared reader lock */
1267 # define me_wmutex me_txns->mti_wmutex /**< Shared writer lock */
1269 mdb_mutex_t me_rmutex;
1270 mdb_mutex_t me_wmutex;
1272 void *me_userctx; /**< User-settable context */
1273 MDB_assert_func *me_assert_func; /**< Callback for assertion failures */
1276 /** Nested transaction */
1277 typedef struct MDB_ntxn {
1278 MDB_txn mnt_txn; /**< the transaction */
1279 MDB_pgstate mnt_pgstate; /**< parent transaction's saved freestate */
1282 /** max number of pages to commit in one writev() call */
1283 #define MDB_COMMIT_PAGES 64
1284 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
1285 #undef MDB_COMMIT_PAGES
1286 #define MDB_COMMIT_PAGES IOV_MAX
1289 /** max bytes to write in one call */
1290 #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4))
1292 /** Check \b txn and \b dbi arguments to a function */
1293 #define TXN_DBI_EXIST(txn, dbi) \
1294 ((txn) && (dbi) < (txn)->mt_numdbs && ((txn)->mt_dbflags[dbi] & DB_VALID))
1296 /** Check for misused \b dbi handles */
1297 #define TXN_DBI_CHANGED(txn, dbi) \
1298 ((txn)->mt_dbiseqs[dbi] != (txn)->mt_env->me_dbiseqs[dbi])
1300 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
1301 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
1302 static int mdb_page_touch(MDB_cursor *mc);
1304 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp, int *lvl);
1305 static int mdb_page_search_root(MDB_cursor *mc,
1306 MDB_val *key, int modify);
1307 #define MDB_PS_MODIFY 1
1308 #define MDB_PS_ROOTONLY 2
1309 #define MDB_PS_FIRST 4
1310 #define MDB_PS_LAST 8
1311 static int mdb_page_search(MDB_cursor *mc,
1312 MDB_val *key, int flags);
1313 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1315 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1316 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1317 pgno_t newpgno, unsigned int nflags);
1319 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1320 static int mdb_env_pick_meta(const MDB_env *env);
1321 static int mdb_env_write_meta(MDB_txn *txn);
1322 #ifdef MDB_USE_POSIX_MUTEX /* Drop unused excl arg */
1323 # define mdb_env_close0(env, excl) mdb_env_close1(env)
1325 static void mdb_env_close0(MDB_env *env, int excl);
1327 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1328 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1329 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1330 static void mdb_node_del(MDB_cursor *mc, int ksize);
1331 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1332 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1333 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1334 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1335 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1337 static int mdb_rebalance(MDB_cursor *mc);
1338 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1340 static void mdb_cursor_pop(MDB_cursor *mc);
1341 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1343 static int mdb_cursor_del0(MDB_cursor *mc);
1344 static int mdb_del0(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data, unsigned flags);
1345 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1346 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1347 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1348 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1350 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1351 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1353 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1354 static void mdb_xcursor_init0(MDB_cursor *mc);
1355 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1357 static int mdb_drop0(MDB_cursor *mc, int subs);
1358 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1359 static int mdb_reader_check0(MDB_env *env, int rlocked, int *dead);
1362 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1365 /** Compare two items pointing at size_t's of unknown alignment. */
1366 #ifdef MISALIGNED_OK
1367 # define mdb_cmp_clong mdb_cmp_long
1369 # define mdb_cmp_clong mdb_cmp_cint
1373 static SECURITY_DESCRIPTOR mdb_null_sd;
1374 static SECURITY_ATTRIBUTES mdb_all_sa;
1375 static int mdb_sec_inited;
1378 /** Return the library version info. */
1380 mdb_version(int *major, int *minor, int *patch)
1382 if (major) *major = MDB_VERSION_MAJOR;
1383 if (minor) *minor = MDB_VERSION_MINOR;
1384 if (patch) *patch = MDB_VERSION_PATCH;
1385 return MDB_VERSION_STRING;
1388 /** Table of descriptions for LMDB @ref errors */
1389 static char *const mdb_errstr[] = {
1390 "MDB_KEYEXIST: Key/data pair already exists",
1391 "MDB_NOTFOUND: No matching key/data pair found",
1392 "MDB_PAGE_NOTFOUND: Requested page not found",
1393 "MDB_CORRUPTED: Located page was wrong type",
1394 "MDB_PANIC: Update of meta page failed or environment had fatal error",
1395 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1396 "MDB_INVALID: File is not an LMDB file",
1397 "MDB_MAP_FULL: Environment mapsize limit reached",
1398 "MDB_DBS_FULL: Environment maxdbs limit reached",
1399 "MDB_READERS_FULL: Environment maxreaders limit reached",
1400 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1401 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1402 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1403 "MDB_PAGE_FULL: Internal error - page has no more space",
1404 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1405 "MDB_INCOMPATIBLE: Operation and DB incompatible, or DB flags changed",
1406 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1407 "MDB_BAD_TXN: Transaction cannot recover - it must be aborted",
1408 "MDB_BAD_VALSIZE: Unsupported size of key/DB name/data, or wrong DUPFIXED size",
1409 "MDB_BAD_DBI: The specified DBI handle was closed/changed unexpectedly",
1413 mdb_strerror(int err)
1416 /** HACK: pad 4KB on stack over the buf. Return system msgs in buf.
1417 * This works as long as no function between the call to mdb_strerror
1418 * and the actual use of the message uses more than 4K of stack.
1421 char buf[1024], *ptr = buf;
1425 return ("Successful return: 0");
1427 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1428 i = err - MDB_KEYEXIST;
1429 return mdb_errstr[i];
1433 /* These are the C-runtime error codes we use. The comment indicates
1434 * their numeric value, and the Win32 error they would correspond to
1435 * if the error actually came from a Win32 API. A major mess, we should
1436 * have used LMDB-specific error codes for everything.
1439 case ENOENT: /* 2, FILE_NOT_FOUND */
1440 case EIO: /* 5, ACCESS_DENIED */
1441 case ENOMEM: /* 12, INVALID_ACCESS */
1442 case EACCES: /* 13, INVALID_DATA */
1443 case EBUSY: /* 16, CURRENT_DIRECTORY */
1444 case EINVAL: /* 22, BAD_COMMAND */
1445 case ENOSPC: /* 28, OUT_OF_PAPER */
1446 return strerror(err);
1451 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM |
1452 FORMAT_MESSAGE_IGNORE_INSERTS,
1453 NULL, err, 0, ptr, sizeof(buf), (va_list *)pad);
1456 return strerror(err);
1460 /** assert(3) variant in cursor context */
1461 #define mdb_cassert(mc, expr) mdb_assert0((mc)->mc_txn->mt_env, expr, #expr)
1462 /** assert(3) variant in transaction context */
1463 #define mdb_tassert(mc, expr) mdb_assert0((txn)->mt_env, expr, #expr)
1464 /** assert(3) variant in environment context */
1465 #define mdb_eassert(env, expr) mdb_assert0(env, expr, #expr)
1468 # define mdb_assert0(env, expr, expr_txt) ((expr) ? (void)0 : \
1469 mdb_assert_fail(env, expr_txt, mdb_func_, __FILE__, __LINE__))
1472 mdb_assert_fail(MDB_env *env, const char *expr_txt,
1473 const char *func, const char *file, int line)
1476 sprintf(buf, "%.100s:%d: Assertion '%.200s' failed in %.40s()",
1477 file, line, expr_txt, func);
1478 if (env->me_assert_func)
1479 env->me_assert_func(env, buf);
1480 fprintf(stderr, "%s\n", buf);
1484 # define mdb_assert0(env, expr, expr_txt) ((void) 0)
1488 /** Return the page number of \b mp which may be sub-page, for debug output */
1490 mdb_dbg_pgno(MDB_page *mp)
1493 COPY_PGNO(ret, mp->mp_pgno);
1497 /** Display a key in hexadecimal and return the address of the result.
1498 * @param[in] key the key to display
1499 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1500 * @return The key in hexadecimal form.
1503 mdb_dkey(MDB_val *key, char *buf)
1506 unsigned char *c = key->mv_data;
1512 if (key->mv_size > DKBUF_MAXKEYSIZE)
1513 return "MDB_MAXKEYSIZE";
1514 /* may want to make this a dynamic check: if the key is mostly
1515 * printable characters, print it as-is instead of converting to hex.
1519 for (i=0; i<key->mv_size; i++)
1520 ptr += sprintf(ptr, "%02x", *c++);
1522 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1528 mdb_leafnode_type(MDB_node *n)
1530 static char *const tp[2][2] = {{"", ": DB"}, {": sub-page", ": sub-DB"}};
1531 return F_ISSET(n->mn_flags, F_BIGDATA) ? ": overflow page" :
1532 tp[F_ISSET(n->mn_flags, F_DUPDATA)][F_ISSET(n->mn_flags, F_SUBDATA)];
1535 /** Display all the keys in the page. */
1537 mdb_page_list(MDB_page *mp)
1539 pgno_t pgno = mdb_dbg_pgno(mp);
1540 const char *type, *state = (mp->mp_flags & P_DIRTY) ? ", dirty" : "";
1542 unsigned int i, nkeys, nsize, total = 0;
1546 switch (mp->mp_flags & (P_BRANCH|P_LEAF|P_LEAF2|P_META|P_OVERFLOW|P_SUBP)) {
1547 case P_BRANCH: type = "Branch page"; break;
1548 case P_LEAF: type = "Leaf page"; break;
1549 case P_LEAF|P_SUBP: type = "Sub-page"; break;
1550 case P_LEAF|P_LEAF2: type = "LEAF2 page"; break;
1551 case P_LEAF|P_LEAF2|P_SUBP: type = "LEAF2 sub-page"; break;
1553 fprintf(stderr, "Overflow page %"Z"u pages %u%s\n",
1554 pgno, mp->mp_pages, state);
1557 fprintf(stderr, "Meta-page %"Z"u txnid %"Z"u\n",
1558 pgno, ((MDB_meta *)METADATA(mp))->mm_txnid);
1561 fprintf(stderr, "Bad page %"Z"u flags 0x%u\n", pgno, mp->mp_flags);
1565 nkeys = NUMKEYS(mp);
1566 fprintf(stderr, "%s %"Z"u numkeys %d%s\n", type, pgno, nkeys, state);
1568 for (i=0; i<nkeys; i++) {
1569 if (IS_LEAF2(mp)) { /* LEAF2 pages have no mp_ptrs[] or node headers */
1570 key.mv_size = nsize = mp->mp_pad;
1571 key.mv_data = LEAF2KEY(mp, i, nsize);
1573 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1576 node = NODEPTR(mp, i);
1577 key.mv_size = node->mn_ksize;
1578 key.mv_data = node->mn_data;
1579 nsize = NODESIZE + key.mv_size;
1580 if (IS_BRANCH(mp)) {
1581 fprintf(stderr, "key %d: page %"Z"u, %s\n", i, NODEPGNO(node),
1585 if (F_ISSET(node->mn_flags, F_BIGDATA))
1586 nsize += sizeof(pgno_t);
1588 nsize += NODEDSZ(node);
1590 nsize += sizeof(indx_t);
1591 fprintf(stderr, "key %d: nsize %d, %s%s\n",
1592 i, nsize, DKEY(&key), mdb_leafnode_type(node));
1594 total = EVEN(total);
1596 fprintf(stderr, "Total: header %d + contents %d + unused %d\n",
1597 IS_LEAF2(mp) ? PAGEHDRSZ : PAGEBASE + mp->mp_lower, total, SIZELEFT(mp));
1601 mdb_cursor_chk(MDB_cursor *mc)
1607 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1608 for (i=0; i<mc->mc_top; i++) {
1610 node = NODEPTR(mp, mc->mc_ki[i]);
1611 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1614 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1620 /** Count all the pages in each DB and in the freelist
1621 * and make sure it matches the actual number of pages
1623 * All named DBs must be open for a correct count.
1625 static void mdb_audit(MDB_txn *txn)
1629 MDB_ID freecount, count;
1634 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1635 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1636 freecount += *(MDB_ID *)data.mv_data;
1637 mdb_tassert(txn, rc == MDB_NOTFOUND);
1640 for (i = 0; i<txn->mt_numdbs; i++) {
1642 if (!(txn->mt_dbflags[i] & DB_VALID))
1644 mdb_cursor_init(&mc, txn, i, &mx);
1645 if (txn->mt_dbs[i].md_root == P_INVALID)
1647 count += txn->mt_dbs[i].md_branch_pages +
1648 txn->mt_dbs[i].md_leaf_pages +
1649 txn->mt_dbs[i].md_overflow_pages;
1650 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1651 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST);
1652 for (; rc == MDB_SUCCESS; rc = mdb_cursor_sibling(&mc, 1)) {
1655 mp = mc.mc_pg[mc.mc_top];
1656 for (j=0; j<NUMKEYS(mp); j++) {
1657 MDB_node *leaf = NODEPTR(mp, j);
1658 if (leaf->mn_flags & F_SUBDATA) {
1660 memcpy(&db, NODEDATA(leaf), sizeof(db));
1661 count += db.md_branch_pages + db.md_leaf_pages +
1662 db.md_overflow_pages;
1666 mdb_tassert(txn, rc == MDB_NOTFOUND);
1669 if (freecount + count + 2 /* metapages */ != txn->mt_next_pgno) {
1670 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1671 txn->mt_txnid, freecount, count+2, freecount+count+2, txn->mt_next_pgno);
1677 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1679 return txn->mt_dbxs[dbi].md_cmp(a, b);
1683 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1685 MDB_cmp_func *dcmp = txn->mt_dbxs[dbi].md_dcmp;
1686 #if UINT_MAX < SIZE_MAX
1687 if (dcmp == mdb_cmp_int && a->mv_size == sizeof(size_t))
1688 dcmp = mdb_cmp_clong;
1693 /** Allocate memory for a page.
1694 * Re-use old malloc'd pages first for singletons, otherwise just malloc.
1697 mdb_page_malloc(MDB_txn *txn, unsigned num)
1699 MDB_env *env = txn->mt_env;
1700 MDB_page *ret = env->me_dpages;
1701 size_t psize = env->me_psize, sz = psize, off;
1702 /* For ! #MDB_NOMEMINIT, psize counts how much to init.
1703 * For a single page alloc, we init everything after the page header.
1704 * For multi-page, we init the final page; if the caller needed that
1705 * many pages they will be filling in at least up to the last page.
1709 VGMEMP_ALLOC(env, ret, sz);
1710 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1711 env->me_dpages = ret->mp_next;
1714 psize -= off = PAGEHDRSZ;
1719 if ((ret = malloc(sz)) != NULL) {
1720 VGMEMP_ALLOC(env, ret, sz);
1721 if (!(env->me_flags & MDB_NOMEMINIT)) {
1722 memset((char *)ret + off, 0, psize);
1726 txn->mt_flags |= MDB_TXN_ERROR;
1730 /** Free a single page.
1731 * Saves single pages to a list, for future reuse.
1732 * (This is not used for multi-page overflow pages.)
1735 mdb_page_free(MDB_env *env, MDB_page *mp)
1737 mp->mp_next = env->me_dpages;
1738 VGMEMP_FREE(env, mp);
1739 env->me_dpages = mp;
1742 /** Free a dirty page */
1744 mdb_dpage_free(MDB_env *env, MDB_page *dp)
1746 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1747 mdb_page_free(env, dp);
1749 /* large pages just get freed directly */
1750 VGMEMP_FREE(env, dp);
1755 /** Return all dirty pages to dpage list */
1757 mdb_dlist_free(MDB_txn *txn)
1759 MDB_env *env = txn->mt_env;
1760 MDB_ID2L dl = txn->mt_u.dirty_list;
1761 unsigned i, n = dl[0].mid;
1763 for (i = 1; i <= n; i++) {
1764 mdb_dpage_free(env, dl[i].mptr);
1769 /** Loosen or free a single page.
1770 * Saves single pages to a list for future reuse
1771 * in this same txn. It has been pulled from the freeDB
1772 * and already resides on the dirty list, but has been
1773 * deleted. Use these pages first before pulling again
1776 * If the page wasn't dirtied in this txn, just add it
1777 * to this txn's free list.
1780 mdb_page_loose(MDB_cursor *mc, MDB_page *mp)
1783 pgno_t pgno = mp->mp_pgno;
1784 MDB_txn *txn = mc->mc_txn;
1786 if ((mp->mp_flags & P_DIRTY) && mc->mc_dbi != FREE_DBI) {
1787 if (txn->mt_parent) {
1788 MDB_ID2 *dl = txn->mt_u.dirty_list;
1789 /* If txn has a parent, make sure the page is in our
1793 unsigned x = mdb_mid2l_search(dl, pgno);
1794 if (x <= dl[0].mid && dl[x].mid == pgno) {
1795 if (mp != dl[x].mptr) { /* bad cursor? */
1796 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
1797 txn->mt_flags |= MDB_TXN_ERROR;
1798 return MDB_CORRUPTED;
1805 /* no parent txn, so it's just ours */
1810 DPRINTF(("loosen db %d page %"Z"u", DDBI(mc),
1812 NEXT_LOOSE_PAGE(mp) = txn->mt_loose_pgs;
1813 txn->mt_loose_pgs = mp;
1814 txn->mt_loose_count++;
1815 mp->mp_flags |= P_LOOSE;
1817 int rc = mdb_midl_append(&txn->mt_free_pgs, pgno);
1825 /** Set or clear P_KEEP in dirty, non-overflow, non-sub pages watched by txn.
1826 * @param[in] mc A cursor handle for the current operation.
1827 * @param[in] pflags Flags of the pages to update:
1828 * P_DIRTY to set P_KEEP, P_DIRTY|P_KEEP to clear it.
1829 * @param[in] all No shortcuts. Needed except after a full #mdb_page_flush().
1830 * @return 0 on success, non-zero on failure.
1833 mdb_pages_xkeep(MDB_cursor *mc, unsigned pflags, int all)
1835 enum { Mask = P_SUBP|P_DIRTY|P_LOOSE|P_KEEP };
1836 MDB_txn *txn = mc->mc_txn;
1842 int rc = MDB_SUCCESS, level;
1844 /* Mark pages seen by cursors */
1845 if (mc->mc_flags & C_UNTRACK)
1846 mc = NULL; /* will find mc in mt_cursors */
1847 for (i = txn->mt_numdbs;; mc = txn->mt_cursors[--i]) {
1848 for (; mc; mc=mc->mc_next) {
1849 if (!(mc->mc_flags & C_INITIALIZED))
1851 for (m3 = mc;; m3 = &mx->mx_cursor) {
1853 for (j=0; j<m3->mc_snum; j++) {
1855 if ((mp->mp_flags & Mask) == pflags)
1856 mp->mp_flags ^= P_KEEP;
1858 mx = m3->mc_xcursor;
1859 /* Proceed to mx if it is at a sub-database */
1860 if (! (mx && (mx->mx_cursor.mc_flags & C_INITIALIZED)))
1862 if (! (mp && (mp->mp_flags & P_LEAF)))
1864 leaf = NODEPTR(mp, m3->mc_ki[j-1]);
1865 if (!(leaf->mn_flags & F_SUBDATA))
1874 /* Mark dirty root pages */
1875 for (i=0; i<txn->mt_numdbs; i++) {
1876 if (txn->mt_dbflags[i] & DB_DIRTY) {
1877 pgno_t pgno = txn->mt_dbs[i].md_root;
1878 if (pgno == P_INVALID)
1880 if ((rc = mdb_page_get(txn, pgno, &dp, &level)) != MDB_SUCCESS)
1882 if ((dp->mp_flags & Mask) == pflags && level <= 1)
1883 dp->mp_flags ^= P_KEEP;
1891 static int mdb_page_flush(MDB_txn *txn, int keep);
1893 /** Spill pages from the dirty list back to disk.
1894 * This is intended to prevent running into #MDB_TXN_FULL situations,
1895 * but note that they may still occur in a few cases:
1896 * 1) our estimate of the txn size could be too small. Currently this
1897 * seems unlikely, except with a large number of #MDB_MULTIPLE items.
1898 * 2) child txns may run out of space if their parents dirtied a
1899 * lot of pages and never spilled them. TODO: we probably should do
1900 * a preemptive spill during #mdb_txn_begin() of a child txn, if
1901 * the parent's dirty_room is below a given threshold.
1903 * Otherwise, if not using nested txns, it is expected that apps will
1904 * not run into #MDB_TXN_FULL any more. The pages are flushed to disk
1905 * the same way as for a txn commit, e.g. their P_DIRTY flag is cleared.
1906 * If the txn never references them again, they can be left alone.
1907 * If the txn only reads them, they can be used without any fuss.
1908 * If the txn writes them again, they can be dirtied immediately without
1909 * going thru all of the work of #mdb_page_touch(). Such references are
1910 * handled by #mdb_page_unspill().
1912 * Also note, we never spill DB root pages, nor pages of active cursors,
1913 * because we'll need these back again soon anyway. And in nested txns,
1914 * we can't spill a page in a child txn if it was already spilled in a
1915 * parent txn. That would alter the parent txns' data even though
1916 * the child hasn't committed yet, and we'd have no way to undo it if
1917 * the child aborted.
1919 * @param[in] m0 cursor A cursor handle identifying the transaction and
1920 * database for which we are checking space.
1921 * @param[in] key For a put operation, the key being stored.
1922 * @param[in] data For a put operation, the data being stored.
1923 * @return 0 on success, non-zero on failure.
1926 mdb_page_spill(MDB_cursor *m0, MDB_val *key, MDB_val *data)
1928 MDB_txn *txn = m0->mc_txn;
1930 MDB_ID2L dl = txn->mt_u.dirty_list;
1931 unsigned int i, j, need;
1934 if (m0->mc_flags & C_SUB)
1937 /* Estimate how much space this op will take */
1938 i = m0->mc_db->md_depth;
1939 /* Named DBs also dirty the main DB */
1940 if (m0->mc_dbi > MAIN_DBI)
1941 i += txn->mt_dbs[MAIN_DBI].md_depth;
1942 /* For puts, roughly factor in the key+data size */
1944 i += (LEAFSIZE(key, data) + txn->mt_env->me_psize) / txn->mt_env->me_psize;
1945 i += i; /* double it for good measure */
1948 if (txn->mt_dirty_room > i)
1951 if (!txn->mt_spill_pgs) {
1952 txn->mt_spill_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX);
1953 if (!txn->mt_spill_pgs)
1956 /* purge deleted slots */
1957 MDB_IDL sl = txn->mt_spill_pgs;
1958 unsigned int num = sl[0];
1960 for (i=1; i<=num; i++) {
1967 /* Preserve pages which may soon be dirtied again */
1968 if ((rc = mdb_pages_xkeep(m0, P_DIRTY, 1)) != MDB_SUCCESS)
1971 /* Less aggressive spill - we originally spilled the entire dirty list,
1972 * with a few exceptions for cursor pages and DB root pages. But this
1973 * turns out to be a lot of wasted effort because in a large txn many
1974 * of those pages will need to be used again. So now we spill only 1/8th
1975 * of the dirty pages. Testing revealed this to be a good tradeoff,
1976 * better than 1/2, 1/4, or 1/10.
1978 if (need < MDB_IDL_UM_MAX / 8)
1979 need = MDB_IDL_UM_MAX / 8;
1981 /* Save the page IDs of all the pages we're flushing */
1982 /* flush from the tail forward, this saves a lot of shifting later on. */
1983 for (i=dl[0].mid; i && need; i--) {
1984 MDB_ID pn = dl[i].mid << 1;
1986 if (dp->mp_flags & (P_LOOSE|P_KEEP))
1988 /* Can't spill twice, make sure it's not already in a parent's
1991 if (txn->mt_parent) {
1993 for (tx2 = txn->mt_parent; tx2; tx2 = tx2->mt_parent) {
1994 if (tx2->mt_spill_pgs) {
1995 j = mdb_midl_search(tx2->mt_spill_pgs, pn);
1996 if (j <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[j] == pn) {
1997 dp->mp_flags |= P_KEEP;
2005 if ((rc = mdb_midl_append(&txn->mt_spill_pgs, pn)))
2009 mdb_midl_sort(txn->mt_spill_pgs);
2011 /* Flush the spilled part of dirty list */
2012 if ((rc = mdb_page_flush(txn, i)) != MDB_SUCCESS)
2015 /* Reset any dirty pages we kept that page_flush didn't see */
2016 rc = mdb_pages_xkeep(m0, P_DIRTY|P_KEEP, i);
2019 txn->mt_flags |= rc ? MDB_TXN_ERROR : MDB_TXN_SPILLS;
2023 /** Find oldest txnid still referenced. Expects txn->mt_txnid > 0. */
2025 mdb_find_oldest(MDB_txn *txn)
2028 txnid_t mr, oldest = txn->mt_txnid - 1;
2029 if (txn->mt_env->me_txns) {
2030 MDB_reader *r = txn->mt_env->me_txns->mti_readers;
2031 for (i = txn->mt_env->me_txns->mti_numreaders; --i >= 0; ) {
2042 /** Add a page to the txn's dirty list */
2044 mdb_page_dirty(MDB_txn *txn, MDB_page *mp)
2047 int rc, (*insert)(MDB_ID2L, MDB_ID2 *);
2049 if (txn->mt_flags & MDB_TXN_WRITEMAP) {
2050 insert = mdb_mid2l_append;
2052 insert = mdb_mid2l_insert;
2054 mid.mid = mp->mp_pgno;
2056 rc = insert(txn->mt_u.dirty_list, &mid);
2057 mdb_tassert(txn, rc == 0);
2058 txn->mt_dirty_room--;
2061 /** Allocate page numbers and memory for writing. Maintain me_pglast,
2062 * me_pghead and mt_next_pgno.
2064 * If there are free pages available from older transactions, they
2065 * are re-used first. Otherwise allocate a new page at mt_next_pgno.
2066 * Do not modify the freedB, just merge freeDB records into me_pghead[]
2067 * and move me_pglast to say which records were consumed. Only this
2068 * function can create me_pghead and move me_pglast/mt_next_pgno.
2069 * @param[in] mc cursor A cursor handle identifying the transaction and
2070 * database for which we are allocating.
2071 * @param[in] num the number of pages to allocate.
2072 * @param[out] mp Address of the allocated page(s). Requests for multiple pages
2073 * will always be satisfied by a single contiguous chunk of memory.
2074 * @return 0 on success, non-zero on failure.
2077 mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp)
2079 #ifdef MDB_PARANOID /* Seems like we can ignore this now */
2080 /* Get at most <Max_retries> more freeDB records once me_pghead
2081 * has enough pages. If not enough, use new pages from the map.
2082 * If <Paranoid> and mc is updating the freeDB, only get new
2083 * records if me_pghead is empty. Then the freelist cannot play
2084 * catch-up with itself by growing while trying to save it.
2086 enum { Paranoid = 1, Max_retries = 500 };
2088 enum { Paranoid = 0, Max_retries = INT_MAX /*infinite*/ };
2090 int rc, retry = num * 60;
2091 MDB_txn *txn = mc->mc_txn;
2092 MDB_env *env = txn->mt_env;
2093 pgno_t pgno, *mop = env->me_pghead;
2094 unsigned i, j, mop_len = mop ? mop[0] : 0, n2 = num-1;
2096 txnid_t oldest = 0, last;
2101 /* If there are any loose pages, just use them */
2102 if (num == 1 && txn->mt_loose_pgs) {
2103 np = txn->mt_loose_pgs;
2104 txn->mt_loose_pgs = NEXT_LOOSE_PAGE(np);
2105 txn->mt_loose_count--;
2106 DPRINTF(("db %d use loose page %"Z"u", DDBI(mc),
2114 /* If our dirty list is already full, we can't do anything */
2115 if (txn->mt_dirty_room == 0) {
2120 for (op = MDB_FIRST;; op = MDB_NEXT) {
2125 /* Seek a big enough contiguous page range. Prefer
2126 * pages at the tail, just truncating the list.
2132 if (mop[i-n2] == pgno+n2)
2139 if (op == MDB_FIRST) { /* 1st iteration */
2140 /* Prepare to fetch more and coalesce */
2141 last = env->me_pglast;
2142 oldest = env->me_pgoldest;
2143 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
2146 key.mv_data = &last; /* will look up last+1 */
2147 key.mv_size = sizeof(last);
2149 if (Paranoid && mc->mc_dbi == FREE_DBI)
2152 if (Paranoid && retry < 0 && mop_len)
2156 /* Do not fetch more if the record will be too recent */
2157 if (oldest <= last) {
2159 oldest = mdb_find_oldest(txn);
2160 env->me_pgoldest = oldest;
2166 rc = mdb_cursor_get(&m2, &key, NULL, op);
2168 if (rc == MDB_NOTFOUND)
2172 last = *(txnid_t*)key.mv_data;
2173 if (oldest <= last) {
2175 oldest = mdb_find_oldest(txn);
2176 env->me_pgoldest = oldest;
2182 np = m2.mc_pg[m2.mc_top];
2183 leaf = NODEPTR(np, m2.mc_ki[m2.mc_top]);
2184 if ((rc = mdb_node_read(txn, leaf, &data)) != MDB_SUCCESS)
2187 idl = (MDB_ID *) data.mv_data;
2190 if (!(env->me_pghead = mop = mdb_midl_alloc(i))) {
2195 if ((rc = mdb_midl_need(&env->me_pghead, i)) != 0)
2197 mop = env->me_pghead;
2199 env->me_pglast = last;
2201 DPRINTF(("IDL read txn %"Z"u root %"Z"u num %u",
2202 last, txn->mt_dbs[FREE_DBI].md_root, i));
2204 DPRINTF(("IDL %"Z"u", idl[j]));
2206 /* Merge in descending sorted order */
2207 mdb_midl_xmerge(mop, idl);
2211 /* Use new pages from the map when nothing suitable in the freeDB */
2213 pgno = txn->mt_next_pgno;
2214 if (pgno + num >= env->me_maxpg) {
2215 DPUTS("DB size maxed out");
2221 if (env->me_flags & MDB_WRITEMAP) {
2222 np = (MDB_page *)(env->me_map + env->me_psize * pgno);
2224 if (!(np = mdb_page_malloc(txn, num))) {
2230 mop[0] = mop_len -= num;
2231 /* Move any stragglers down */
2232 for (j = i-num; j < mop_len; )
2233 mop[++j] = mop[++i];
2235 txn->mt_next_pgno = pgno + num;
2238 mdb_page_dirty(txn, np);
2244 txn->mt_flags |= MDB_TXN_ERROR;
2248 /** Copy the used portions of a non-overflow page.
2249 * @param[in] dst page to copy into
2250 * @param[in] src page to copy from
2251 * @param[in] psize size of a page
2254 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
2256 enum { Align = sizeof(pgno_t) };
2257 indx_t upper = src->mp_upper, lower = src->mp_lower, unused = upper-lower;
2259 /* If page isn't full, just copy the used portion. Adjust
2260 * alignment so memcpy may copy words instead of bytes.
2262 if ((unused &= -Align) && !IS_LEAF2(src)) {
2263 upper = (upper + PAGEBASE) & -Align;
2264 memcpy(dst, src, (lower + PAGEBASE + (Align-1)) & -Align);
2265 memcpy((pgno_t *)((char *)dst+upper), (pgno_t *)((char *)src+upper),
2268 memcpy(dst, src, psize - unused);
2272 /** Pull a page off the txn's spill list, if present.
2273 * If a page being referenced was spilled to disk in this txn, bring
2274 * it back and make it dirty/writable again.
2275 * @param[in] txn the transaction handle.
2276 * @param[in] mp the page being referenced. It must not be dirty.
2277 * @param[out] ret the writable page, if any. ret is unchanged if
2278 * mp wasn't spilled.
2281 mdb_page_unspill(MDB_txn *txn, MDB_page *mp, MDB_page **ret)
2283 MDB_env *env = txn->mt_env;
2286 pgno_t pgno = mp->mp_pgno, pn = pgno << 1;
2288 for (tx2 = txn; tx2; tx2=tx2->mt_parent) {
2289 if (!tx2->mt_spill_pgs)
2291 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
2292 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
2295 if (txn->mt_dirty_room == 0)
2296 return MDB_TXN_FULL;
2297 if (IS_OVERFLOW(mp))
2301 if (env->me_flags & MDB_WRITEMAP) {
2304 np = mdb_page_malloc(txn, num);
2308 memcpy(np, mp, num * env->me_psize);
2310 mdb_page_copy(np, mp, env->me_psize);
2313 /* If in current txn, this page is no longer spilled.
2314 * If it happens to be the last page, truncate the spill list.
2315 * Otherwise mark it as deleted by setting the LSB.
2317 if (x == txn->mt_spill_pgs[0])
2318 txn->mt_spill_pgs[0]--;
2320 txn->mt_spill_pgs[x] |= 1;
2321 } /* otherwise, if belonging to a parent txn, the
2322 * page remains spilled until child commits
2325 mdb_page_dirty(txn, np);
2326 np->mp_flags |= P_DIRTY;
2334 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
2335 * @param[in] mc cursor pointing to the page to be touched
2336 * @return 0 on success, non-zero on failure.
2339 mdb_page_touch(MDB_cursor *mc)
2341 MDB_page *mp = mc->mc_pg[mc->mc_top], *np;
2342 MDB_txn *txn = mc->mc_txn;
2343 MDB_cursor *m2, *m3;
2347 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
2348 if (txn->mt_flags & MDB_TXN_SPILLS) {
2350 rc = mdb_page_unspill(txn, mp, &np);
2356 if ((rc = mdb_midl_need(&txn->mt_free_pgs, 1)) ||
2357 (rc = mdb_page_alloc(mc, 1, &np)))
2360 DPRINTF(("touched db %d page %"Z"u -> %"Z"u", DDBI(mc),
2361 mp->mp_pgno, pgno));
2362 mdb_cassert(mc, mp->mp_pgno != pgno);
2363 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
2364 /* Update the parent page, if any, to point to the new page */
2366 MDB_page *parent = mc->mc_pg[mc->mc_top-1];
2367 MDB_node *node = NODEPTR(parent, mc->mc_ki[mc->mc_top-1]);
2368 SETPGNO(node, pgno);
2370 mc->mc_db->md_root = pgno;
2372 } else if (txn->mt_parent && !IS_SUBP(mp)) {
2373 MDB_ID2 mid, *dl = txn->mt_u.dirty_list;
2375 /* If txn has a parent, make sure the page is in our
2379 unsigned x = mdb_mid2l_search(dl, pgno);
2380 if (x <= dl[0].mid && dl[x].mid == pgno) {
2381 if (mp != dl[x].mptr) { /* bad cursor? */
2382 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
2383 txn->mt_flags |= MDB_TXN_ERROR;
2384 return MDB_CORRUPTED;
2389 mdb_cassert(mc, dl[0].mid < MDB_IDL_UM_MAX);
2391 np = mdb_page_malloc(txn, 1);
2396 rc = mdb_mid2l_insert(dl, &mid);
2397 mdb_cassert(mc, rc == 0);
2402 mdb_page_copy(np, mp, txn->mt_env->me_psize);
2404 np->mp_flags |= P_DIRTY;
2407 /* Adjust cursors pointing to mp */
2408 mc->mc_pg[mc->mc_top] = np;
2409 m2 = txn->mt_cursors[mc->mc_dbi];
2410 if (mc->mc_flags & C_SUB) {
2411 for (; m2; m2=m2->mc_next) {
2412 m3 = &m2->mc_xcursor->mx_cursor;
2413 if (m3->mc_snum < mc->mc_snum) continue;
2414 if (m3->mc_pg[mc->mc_top] == mp)
2415 m3->mc_pg[mc->mc_top] = np;
2418 for (; m2; m2=m2->mc_next) {
2419 if (m2->mc_snum < mc->mc_snum) continue;
2420 if (m2->mc_pg[mc->mc_top] == mp) {
2421 m2->mc_pg[mc->mc_top] = np;
2422 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
2424 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
2426 MDB_node *leaf = NODEPTR(np, mc->mc_ki[mc->mc_top]);
2427 if (!(leaf->mn_flags & F_SUBDATA))
2428 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
2436 txn->mt_flags |= MDB_TXN_ERROR;
2441 mdb_env_sync(MDB_env *env, int force)
2444 if (env->me_flags & MDB_RDONLY)
2446 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
2447 if (env->me_flags & MDB_WRITEMAP) {
2448 int flags = ((env->me_flags & MDB_MAPASYNC) && !force)
2449 ? MS_ASYNC : MS_SYNC;
2450 if (MDB_MSYNC(env->me_map, env->me_mapsize, flags))
2453 else if (flags == MS_SYNC && MDB_FDATASYNC(env->me_fd))
2457 #ifdef BROKEN_FDATASYNC
2458 if (env->me_flags & MDB_FSYNCONLY) {
2459 if (fsync(env->me_fd))
2463 if (MDB_FDATASYNC(env->me_fd))
2470 /** Back up parent txn's cursors, then grab the originals for tracking */
2472 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
2474 MDB_cursor *mc, *bk;
2479 for (i = src->mt_numdbs; --i >= 0; ) {
2480 if ((mc = src->mt_cursors[i]) != NULL) {
2481 size = sizeof(MDB_cursor);
2483 size += sizeof(MDB_xcursor);
2484 for (; mc; mc = bk->mc_next) {
2490 mc->mc_db = &dst->mt_dbs[i];
2491 /* Kill pointers into src - and dst to reduce abuse: The
2492 * user may not use mc until dst ends. Otherwise we'd...
2494 mc->mc_txn = NULL; /* ...set this to dst */
2495 mc->mc_dbflag = NULL; /* ...and &dst->mt_dbflags[i] */
2496 if ((mx = mc->mc_xcursor) != NULL) {
2497 *(MDB_xcursor *)(bk+1) = *mx;
2498 mx->mx_cursor.mc_txn = NULL; /* ...and dst. */
2500 mc->mc_next = dst->mt_cursors[i];
2501 dst->mt_cursors[i] = mc;
2508 /** Close this write txn's cursors, give parent txn's cursors back to parent.
2509 * @param[in] txn the transaction handle.
2510 * @param[in] merge true to keep changes to parent cursors, false to revert.
2511 * @return 0 on success, non-zero on failure.
2514 mdb_cursors_close(MDB_txn *txn, unsigned merge)
2516 MDB_cursor **cursors = txn->mt_cursors, *mc, *next, *bk;
2520 for (i = txn->mt_numdbs; --i >= 0; ) {
2521 for (mc = cursors[i]; mc; mc = next) {
2523 if ((bk = mc->mc_backup) != NULL) {
2525 /* Commit changes to parent txn */
2526 mc->mc_next = bk->mc_next;
2527 mc->mc_backup = bk->mc_backup;
2528 mc->mc_txn = bk->mc_txn;
2529 mc->mc_db = bk->mc_db;
2530 mc->mc_dbflag = bk->mc_dbflag;
2531 if ((mx = mc->mc_xcursor) != NULL)
2532 mx->mx_cursor.mc_txn = bk->mc_txn;
2534 /* Abort nested txn */
2536 if ((mx = mc->mc_xcursor) != NULL)
2537 *mx = *(MDB_xcursor *)(bk+1);
2541 /* Only malloced cursors are permanently tracked. */
2549 #define mdb_txn_reset0(txn, act) mdb_txn_reset0(txn)
2552 mdb_txn_reset0(MDB_txn *txn, const char *act);
2554 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2560 Pidset = F_SETLK, Pidcheck = F_GETLK
2564 /** Set or check a pid lock. Set returns 0 on success.
2565 * Check returns 0 if the process is certainly dead, nonzero if it may
2566 * be alive (the lock exists or an error happened so we do not know).
2568 * On Windows Pidset is a no-op, we merely check for the existence
2569 * of the process with the given pid. On POSIX we use a single byte
2570 * lock on the lockfile, set at an offset equal to the pid.
2573 mdb_reader_pid(MDB_env *env, enum Pidlock_op op, MDB_PID_T pid)
2575 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2578 if (op == Pidcheck) {
2579 h = OpenProcess(env->me_pidquery, FALSE, pid);
2580 /* No documented "no such process" code, but other program use this: */
2582 return ErrCode() != ERROR_INVALID_PARAMETER;
2583 /* A process exists until all handles to it close. Has it exited? */
2584 ret = WaitForSingleObject(h, 0) != 0;
2591 struct flock lock_info;
2592 memset(&lock_info, 0, sizeof(lock_info));
2593 lock_info.l_type = F_WRLCK;
2594 lock_info.l_whence = SEEK_SET;
2595 lock_info.l_start = pid;
2596 lock_info.l_len = 1;
2597 if ((rc = fcntl(env->me_lfd, op, &lock_info)) == 0) {
2598 if (op == F_GETLK && lock_info.l_type != F_UNLCK)
2600 } else if ((rc = ErrCode()) == EINTR) {
2608 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
2609 * @param[in] txn the transaction handle to initialize
2610 * @return 0 on success, non-zero on failure.
2613 mdb_txn_renew0(MDB_txn *txn)
2615 MDB_env *env = txn->mt_env;
2616 MDB_txninfo *ti = env->me_txns;
2618 unsigned int i, nr, flags = txn->mt_flags;
2620 int rc, new_notls = 0;
2622 if ((flags &= MDB_TXN_RDONLY) != 0) {
2624 meta = env->me_metas[ mdb_env_pick_meta(env) ];
2625 txn->mt_txnid = meta->mm_txnid;
2626 txn->mt_u.reader = NULL;
2628 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
2629 pthread_getspecific(env->me_txkey);
2631 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
2632 return MDB_BAD_RSLOT;
2634 MDB_PID_T pid = env->me_pid;
2635 MDB_THR_T tid = pthread_self();
2636 mdb_mutexref_t rmutex = env->me_rmutex;
2638 if (!env->me_live_reader) {
2639 rc = mdb_reader_pid(env, Pidset, pid);
2642 env->me_live_reader = 1;
2645 if (LOCK_MUTEX(rc, env, rmutex))
2647 nr = ti->mti_numreaders;
2648 for (i=0; i<nr; i++)
2649 if (ti->mti_readers[i].mr_pid == 0)
2651 if (i == env->me_maxreaders) {
2652 UNLOCK_MUTEX(rmutex);
2653 return MDB_READERS_FULL;
2655 r = &ti->mti_readers[i];
2656 /* Claim the reader slot, carefully since other code
2657 * uses the reader table un-mutexed: First reset the
2658 * slot, next publish it in mti_numreaders. After
2659 * that, it is safe for mdb_env_close() to touch it.
2660 * When it will be closed, we can finally claim it.
2663 r->mr_txnid = (txnid_t)-1;
2666 ti->mti_numreaders = ++nr;
2667 env->me_close_readers = nr;
2669 UNLOCK_MUTEX(rmutex);
2671 new_notls = (env->me_flags & MDB_NOTLS);
2672 if (!new_notls && (rc=pthread_setspecific(env->me_txkey, r))) {
2677 do /* LY: Retry on a race, ITS#7970. */
2678 r->mr_txnid = ti->mti_txnid;
2679 while(r->mr_txnid != ti->mti_txnid);
2680 txn->mt_txnid = r->mr_txnid;
2681 txn->mt_u.reader = r;
2682 meta = env->me_metas[txn->mt_txnid & 1];
2684 txn->mt_dbxs = env->me_dbxs; /* mostly static anyway */
2686 /* Not yet touching txn == env->me_txn0, it may be active */
2688 if (LOCK_MUTEX(rc, env, env->me_wmutex))
2690 txn->mt_txnid = ti->mti_txnid;
2691 meta = env->me_metas[txn->mt_txnid & 1];
2693 meta = env->me_metas[ mdb_env_pick_meta(env) ];
2694 txn->mt_txnid = meta->mm_txnid;
2698 if (txn->mt_txnid == mdb_debug_start)
2701 txn->mt_child = NULL;
2702 txn->mt_loose_pgs = NULL;
2703 txn->mt_loose_count = 0;
2704 txn->mt_dirty_room = MDB_IDL_UM_MAX;
2705 txn->mt_u.dirty_list = env->me_dirty_list;
2706 txn->mt_u.dirty_list[0].mid = 0;
2707 txn->mt_free_pgs = env->me_free_pgs;
2708 txn->mt_free_pgs[0] = 0;
2709 txn->mt_spill_pgs = NULL;
2711 memcpy(txn->mt_dbiseqs, env->me_dbiseqs, env->me_maxdbs * sizeof(unsigned int));
2714 /* Copy the DB info and flags */
2715 memcpy(txn->mt_dbs, meta->mm_dbs, 2 * sizeof(MDB_db));
2717 /* Moved to here to avoid a data race in read TXNs */
2718 txn->mt_next_pgno = meta->mm_last_pg+1;
2720 txn->mt_flags = flags;
2723 txn->mt_numdbs = env->me_numdbs;
2724 for (i=2; i<txn->mt_numdbs; i++) {
2725 x = env->me_dbflags[i];
2726 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
2727 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_STALE : 0;
2729 txn->mt_dbflags[0] = txn->mt_dbflags[1] = DB_VALID;
2731 if (env->me_maxpg < txn->mt_next_pgno) {
2732 mdb_txn_reset0(txn, "renew0-mapfail");
2734 txn->mt_u.reader->mr_pid = 0;
2735 txn->mt_u.reader = NULL;
2737 return MDB_MAP_RESIZED;
2744 mdb_txn_renew(MDB_txn *txn)
2748 if (!txn || txn->mt_dbxs) /* A reset txn has mt_dbxs==NULL */
2751 if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
2752 DPUTS("environment had fatal error, must shutdown!");
2756 rc = mdb_txn_renew0(txn);
2757 if (rc == MDB_SUCCESS) {
2758 DPRINTF(("renew txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2759 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2760 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root));
2766 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
2770 int rc, size, tsize;
2772 flags &= MDB_TXN_BEGIN_FLAGS;
2773 flags |= env->me_flags & MDB_WRITEMAP;
2775 if (env->me_flags & MDB_FATAL_ERROR) {
2776 DPUTS("environment had fatal error, must shutdown!");
2779 if (env->me_flags & MDB_RDONLY & ~flags) /* write txn in RDONLY env */
2782 size = tsize = sizeof(MDB_txn);
2784 /* Nested transactions: Max 1 child, write txns only, no writemap */
2785 flags |= parent->mt_flags;
2786 if (parent->mt_child ||
2787 (flags & (MDB_RDONLY|MDB_WRITEMAP|MDB_TXN_ERROR)))
2789 return (parent->mt_flags & MDB_TXN_RDONLY) ? EINVAL : MDB_BAD_TXN;
2791 /* Child txns save MDB_pgstate and use own copy of cursors */
2792 size = tsize = sizeof(MDB_ntxn);
2793 size += env->me_maxdbs * sizeof(MDB_cursor *);
2794 } else if (!(flags & MDB_RDONLY)) {
2795 /* Reuse preallocated write txn. However, do not touch it until
2796 * mdb_txn_renew0() succeeds, since it currently may be active.
2801 size += env->me_maxdbs * (sizeof(MDB_db)+1);
2803 if ((txn = calloc(1, size)) == NULL) {
2804 DPRINTF(("calloc: %s", strerror(errno)));
2807 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
2808 if (flags & MDB_RDONLY) {
2809 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
2810 txn->mt_dbiseqs = env->me_dbiseqs;
2812 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
2814 txn->mt_dbiseqs = parent->mt_dbiseqs;
2815 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
2817 txn->mt_dbiseqs = (unsigned int *)(txn->mt_cursors + env->me_maxdbs);
2818 txn->mt_dbflags = (unsigned char *)(txn->mt_dbiseqs + env->me_maxdbs);
2821 txn->mt_flags = flags;
2826 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
2827 if (!txn->mt_u.dirty_list ||
2828 !(txn->mt_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)))
2830 free(txn->mt_u.dirty_list);
2834 txn->mt_txnid = parent->mt_txnid;
2835 txn->mt_dirty_room = parent->mt_dirty_room;
2836 txn->mt_u.dirty_list[0].mid = 0;
2837 txn->mt_spill_pgs = NULL;
2838 txn->mt_next_pgno = parent->mt_next_pgno;
2839 parent->mt_child = txn;
2840 txn->mt_parent = parent;
2841 txn->mt_numdbs = parent->mt_numdbs;
2842 txn->mt_dbxs = parent->mt_dbxs;
2843 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2844 /* Copy parent's mt_dbflags, but clear DB_NEW */
2845 for (i=0; i<txn->mt_numdbs; i++)
2846 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
2848 ntxn = (MDB_ntxn *)txn;
2849 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
2850 if (env->me_pghead) {
2851 size = MDB_IDL_SIZEOF(env->me_pghead);
2852 env->me_pghead = mdb_midl_alloc(env->me_pghead[0]);
2854 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
2859 rc = mdb_cursor_shadow(parent, txn);
2861 mdb_txn_reset0(txn, "beginchild-fail");
2864 rc = mdb_txn_renew0(txn);
2867 if (txn != env->me_txn0)
2870 txn->mt_flags |= flags; /* for txn==me_txn0, no effect otherwise */
2872 DPRINTF(("begin txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2873 txn->mt_txnid, (flags & MDB_RDONLY) ? 'r' : 'w',
2874 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root));
2881 mdb_txn_env(MDB_txn *txn)
2883 if(!txn) return NULL;
2888 mdb_txn_id(MDB_txn *txn)
2891 return txn->mt_txnid;
2894 /** Export or close DBI handles opened in this txn. */
2896 mdb_dbis_update(MDB_txn *txn, int keep)
2899 MDB_dbi n = txn->mt_numdbs;
2900 MDB_env *env = txn->mt_env;
2901 unsigned char *tdbflags = txn->mt_dbflags;
2903 for (i = n; --i >= 2;) {
2904 if (tdbflags[i] & DB_NEW) {
2906 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2908 char *ptr = env->me_dbxs[i].md_name.mv_data;
2910 env->me_dbxs[i].md_name.mv_data = NULL;
2911 env->me_dbxs[i].md_name.mv_size = 0;
2912 env->me_dbflags[i] = 0;
2913 env->me_dbiseqs[i]++;
2919 if (keep && env->me_numdbs < n)
2923 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
2924 * May be called twice for readonly txns: First reset it, then abort.
2925 * @param[in] txn the transaction handle to reset
2926 * @param[in] act why the transaction is being reset
2929 mdb_txn_reset0(MDB_txn *txn, const char *act)
2931 MDB_env *env = txn->mt_env;
2933 /* Close any DBI handles opened in this txn */
2934 mdb_dbis_update(txn, 0);
2936 DPRINTF(("%s txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2937 act, txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2938 (void *) txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root));
2940 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2941 if (txn->mt_u.reader) {
2942 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
2943 if (!(env->me_flags & MDB_NOTLS))
2944 txn->mt_u.reader = NULL; /* txn does not own reader */
2946 txn->mt_numdbs = 0; /* close nothing if called again */
2947 txn->mt_dbxs = NULL; /* mark txn as reset */
2949 pgno_t *pghead = env->me_pghead;
2951 mdb_cursors_close(txn, 0);
2952 if (!(env->me_flags & MDB_WRITEMAP)) {
2953 mdb_dlist_free(txn);
2956 if (!txn->mt_parent) {
2957 if (mdb_midl_shrink(&txn->mt_free_pgs))
2958 env->me_free_pgs = txn->mt_free_pgs;
2960 env->me_pghead = NULL;
2964 /* The writer mutex was locked in mdb_txn_begin. */
2966 UNLOCK_MUTEX(env->me_wmutex);
2968 txn->mt_parent->mt_child = NULL;
2969 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2970 mdb_midl_free(txn->mt_free_pgs);
2971 mdb_midl_free(txn->mt_spill_pgs);
2972 free(txn->mt_u.dirty_list);
2975 mdb_midl_free(pghead);
2980 mdb_txn_reset(MDB_txn *txn)
2985 /* This call is only valid for read-only txns */
2986 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2989 mdb_txn_reset0(txn, "reset");
2993 mdb_txn_abort(MDB_txn *txn)
2999 mdb_txn_abort(txn->mt_child);
3001 mdb_txn_reset0(txn, "abort");
3002 /* Free reader slot tied to this txn (if MDB_NOTLS && writable FS) */
3003 if ((txn->mt_flags & MDB_TXN_RDONLY) && txn->mt_u.reader)
3004 txn->mt_u.reader->mr_pid = 0;
3006 if (txn != txn->mt_env->me_txn0)
3010 /** Save the freelist as of this transaction to the freeDB.
3011 * This changes the freelist. Keep trying until it stabilizes.
3014 mdb_freelist_save(MDB_txn *txn)
3016 /* env->me_pghead[] can grow and shrink during this call.
3017 * env->me_pglast and txn->mt_free_pgs[] can only grow.
3018 * Page numbers cannot disappear from txn->mt_free_pgs[].
3021 MDB_env *env = txn->mt_env;
3022 int rc, maxfree_1pg = env->me_maxfree_1pg, more = 1;
3023 txnid_t pglast = 0, head_id = 0;
3024 pgno_t freecnt = 0, *free_pgs, *mop;
3025 ssize_t head_room = 0, total_room = 0, mop_len, clean_limit;
3027 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
3029 if (env->me_pghead) {
3030 /* Make sure first page of freeDB is touched and on freelist */
3031 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST|MDB_PS_MODIFY);
3032 if (rc && rc != MDB_NOTFOUND)
3036 if (!env->me_pghead && txn->mt_loose_pgs) {
3037 /* Put loose page numbers in mt_free_pgs, since
3038 * we may be unable to return them to me_pghead.
3040 MDB_page *mp = txn->mt_loose_pgs;
3041 if ((rc = mdb_midl_need(&txn->mt_free_pgs, txn->mt_loose_count)) != 0)
3043 for (; mp; mp = NEXT_LOOSE_PAGE(mp))
3044 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
3045 txn->mt_loose_pgs = NULL;
3046 txn->mt_loose_count = 0;
3049 /* MDB_RESERVE cancels meminit in ovpage malloc (when no WRITEMAP) */
3050 clean_limit = (env->me_flags & (MDB_NOMEMINIT|MDB_WRITEMAP))
3051 ? SSIZE_MAX : maxfree_1pg;
3054 /* Come back here after each Put() in case freelist changed */
3059 /* If using records from freeDB which we have not yet
3060 * deleted, delete them and any we reserved for me_pghead.
3062 while (pglast < env->me_pglast) {
3063 rc = mdb_cursor_first(&mc, &key, NULL);
3066 pglast = head_id = *(txnid_t *)key.mv_data;
3067 total_room = head_room = 0;
3068 mdb_tassert(txn, pglast <= env->me_pglast);
3069 rc = mdb_cursor_del(&mc, 0);
3074 /* Save the IDL of pages freed by this txn, to a single record */
3075 if (freecnt < txn->mt_free_pgs[0]) {
3077 /* Make sure last page of freeDB is touched and on freelist */
3078 rc = mdb_page_search(&mc, NULL, MDB_PS_LAST|MDB_PS_MODIFY);
3079 if (rc && rc != MDB_NOTFOUND)
3082 free_pgs = txn->mt_free_pgs;
3083 /* Write to last page of freeDB */
3084 key.mv_size = sizeof(txn->mt_txnid);
3085 key.mv_data = &txn->mt_txnid;
3087 freecnt = free_pgs[0];
3088 data.mv_size = MDB_IDL_SIZEOF(free_pgs);
3089 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
3092 /* Retry if mt_free_pgs[] grew during the Put() */
3093 free_pgs = txn->mt_free_pgs;
3094 } while (freecnt < free_pgs[0]);
3095 mdb_midl_sort(free_pgs);
3096 memcpy(data.mv_data, free_pgs, data.mv_size);
3099 unsigned int i = free_pgs[0];
3100 DPRINTF(("IDL write txn %"Z"u root %"Z"u num %u",
3101 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, i));
3103 DPRINTF(("IDL %"Z"u", free_pgs[i]));
3109 mop = env->me_pghead;
3110 mop_len = (mop ? mop[0] : 0) + txn->mt_loose_count;
3112 /* Reserve records for me_pghead[]. Split it if multi-page,
3113 * to avoid searching freeDB for a page range. Use keys in
3114 * range [1,me_pglast]: Smaller than txnid of oldest reader.
3116 if (total_room >= mop_len) {
3117 if (total_room == mop_len || --more < 0)
3119 } else if (head_room >= maxfree_1pg && head_id > 1) {
3120 /* Keep current record (overflow page), add a new one */
3124 /* (Re)write {key = head_id, IDL length = head_room} */
3125 total_room -= head_room;
3126 head_room = mop_len - total_room;
3127 if (head_room > maxfree_1pg && head_id > 1) {
3128 /* Overflow multi-page for part of me_pghead */
3129 head_room /= head_id; /* amortize page sizes */
3130 head_room += maxfree_1pg - head_room % (maxfree_1pg + 1);
3131 } else if (head_room < 0) {
3132 /* Rare case, not bothering to delete this record */
3135 key.mv_size = sizeof(head_id);
3136 key.mv_data = &head_id;
3137 data.mv_size = (head_room + 1) * sizeof(pgno_t);
3138 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
3141 /* IDL is initially empty, zero out at least the length */
3142 pgs = (pgno_t *)data.mv_data;
3143 j = head_room > clean_limit ? head_room : 0;
3147 total_room += head_room;
3150 /* Return loose page numbers to me_pghead, though usually none are
3151 * left at this point. The pages themselves remain in dirty_list.
3153 if (txn->mt_loose_pgs) {
3154 MDB_page *mp = txn->mt_loose_pgs;
3155 unsigned count = txn->mt_loose_count;
3157 /* Room for loose pages + temp IDL with same */
3158 if ((rc = mdb_midl_need(&env->me_pghead, 2*count+1)) != 0)
3160 mop = env->me_pghead;
3161 loose = mop + MDB_IDL_ALLOCLEN(mop) - count;
3162 for (count = 0; mp; mp = NEXT_LOOSE_PAGE(mp))
3163 loose[ ++count ] = mp->mp_pgno;
3165 mdb_midl_sort(loose);
3166 mdb_midl_xmerge(mop, loose);
3167 txn->mt_loose_pgs = NULL;
3168 txn->mt_loose_count = 0;
3172 /* Fill in the reserved me_pghead records */
3178 rc = mdb_cursor_first(&mc, &key, &data);
3179 for (; !rc; rc = mdb_cursor_next(&mc, &key, &data, MDB_NEXT)) {
3180 txnid_t id = *(txnid_t *)key.mv_data;
3181 ssize_t len = (ssize_t)(data.mv_size / sizeof(MDB_ID)) - 1;
3184 mdb_tassert(txn, len >= 0 && id <= env->me_pglast);
3186 if (len > mop_len) {
3188 data.mv_size = (len + 1) * sizeof(MDB_ID);
3190 data.mv_data = mop -= len;
3193 rc = mdb_cursor_put(&mc, &key, &data, MDB_CURRENT);
3195 if (rc || !(mop_len -= len))
3202 /** Flush (some) dirty pages to the map, after clearing their dirty flag.
3203 * @param[in] txn the transaction that's being committed
3204 * @param[in] keep number of initial pages in dirty_list to keep dirty.
3205 * @return 0 on success, non-zero on failure.
3208 mdb_page_flush(MDB_txn *txn, int keep)
3210 MDB_env *env = txn->mt_env;
3211 MDB_ID2L dl = txn->mt_u.dirty_list;
3212 unsigned psize = env->me_psize, j;
3213 int i, pagecount = dl[0].mid, rc;
3214 size_t size = 0, pos = 0;
3216 MDB_page *dp = NULL;
3220 struct iovec iov[MDB_COMMIT_PAGES];
3221 ssize_t wpos = 0, wsize = 0, wres;
3222 size_t next_pos = 1; /* impossible pos, so pos != next_pos */
3228 if (env->me_flags & MDB_WRITEMAP) {
3229 /* Clear dirty flags */
3230 while (++i <= pagecount) {
3232 /* Don't flush this page yet */
3233 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3234 dp->mp_flags &= ~P_KEEP;
3238 dp->mp_flags &= ~P_DIRTY;
3243 /* Write the pages */
3245 if (++i <= pagecount) {
3247 /* Don't flush this page yet */
3248 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3249 dp->mp_flags &= ~P_KEEP;
3254 /* clear dirty flag */
3255 dp->mp_flags &= ~P_DIRTY;
3258 if (IS_OVERFLOW(dp)) size *= dp->mp_pages;
3263 /* Windows actually supports scatter/gather I/O, but only on
3264 * unbuffered file handles. Since we're relying on the OS page
3265 * cache for all our data, that's self-defeating. So we just
3266 * write pages one at a time. We use the ov structure to set
3267 * the write offset, to at least save the overhead of a Seek
3270 DPRINTF(("committing page %"Z"u", pgno));
3271 memset(&ov, 0, sizeof(ov));
3272 ov.Offset = pos & 0xffffffff;
3273 ov.OffsetHigh = pos >> 16 >> 16;
3274 if (!WriteFile(env->me_fd, dp, size, NULL, &ov)) {
3276 DPRINTF(("WriteFile: %d", rc));
3280 /* Write up to MDB_COMMIT_PAGES dirty pages at a time. */
3281 if (pos!=next_pos || n==MDB_COMMIT_PAGES || wsize+size>MAX_WRITE) {
3284 /* Write previous page(s) */
3285 #ifdef MDB_USE_PWRITEV
3286 wres = pwritev(env->me_fd, iov, n, wpos);
3289 wres = pwrite(env->me_fd, iov[0].iov_base, wsize, wpos);
3292 if (lseek(env->me_fd, wpos, SEEK_SET) == -1) {
3296 DPRINTF(("lseek: %s", strerror(rc)));
3299 wres = writev(env->me_fd, iov, n);
3302 if (wres != wsize) {
3307 DPRINTF(("Write error: %s", strerror(rc)));
3309 rc = EIO; /* TODO: Use which error code? */
3310 DPUTS("short write, filesystem full?");
3321 DPRINTF(("committing page %"Z"u", pgno));
3322 next_pos = pos + size;
3323 iov[n].iov_len = size;
3324 iov[n].iov_base = (char *)dp;
3330 /* MIPS has cache coherency issues, this is a no-op everywhere else
3331 * Note: for any size >= on-chip cache size, entire on-chip cache is
3334 CACHEFLUSH(env->me_map, txn->mt_next_pgno * env->me_psize, DCACHE);
3336 for (i = keep; ++i <= pagecount; ) {
3338 /* This is a page we skipped above */
3341 dl[j].mid = dp->mp_pgno;
3344 mdb_dpage_free(env, dp);
3349 txn->mt_dirty_room += i - j;
3355 mdb_txn_commit(MDB_txn *txn)
3361 if (txn == NULL || txn->mt_env == NULL)
3364 if (txn->mt_child) {
3365 rc = mdb_txn_commit(txn->mt_child);
3366 txn->mt_child = NULL;
3373 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
3374 mdb_dbis_update(txn, 1);
3375 txn->mt_numdbs = 2; /* so txn_abort() doesn't close any new handles */
3380 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
3381 DPUTS("error flag is set, can't commit");
3383 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
3388 if (txn->mt_parent) {
3389 MDB_txn *parent = txn->mt_parent;
3393 unsigned x, y, len, ps_len;
3395 /* Append our free list to parent's */
3396 rc = mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs);
3399 mdb_midl_free(txn->mt_free_pgs);
3400 /* Failures after this must either undo the changes
3401 * to the parent or set MDB_TXN_ERROR in the parent.
3404 parent->mt_next_pgno = txn->mt_next_pgno;
3405 parent->mt_flags = txn->mt_flags;
3407 /* Merge our cursors into parent's and close them */
3408 mdb_cursors_close(txn, 1);
3410 /* Update parent's DB table. */
3411 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
3412 parent->mt_numdbs = txn->mt_numdbs;
3413 parent->mt_dbflags[0] = txn->mt_dbflags[0];
3414 parent->mt_dbflags[1] = txn->mt_dbflags[1];
3415 for (i=2; i<txn->mt_numdbs; i++) {
3416 /* preserve parent's DB_NEW status */
3417 x = parent->mt_dbflags[i] & DB_NEW;
3418 parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
3421 dst = parent->mt_u.dirty_list;
3422 src = txn->mt_u.dirty_list;
3423 /* Remove anything in our dirty list from parent's spill list */
3424 if ((pspill = parent->mt_spill_pgs) && (ps_len = pspill[0])) {
3426 pspill[0] = (pgno_t)-1;
3427 /* Mark our dirty pages as deleted in parent spill list */
3428 for (i=0, len=src[0].mid; ++i <= len; ) {
3429 MDB_ID pn = src[i].mid << 1;
3430 while (pn > pspill[x])
3432 if (pn == pspill[x]) {
3437 /* Squash deleted pagenums if we deleted any */
3438 for (x=y; ++x <= ps_len; )
3439 if (!(pspill[x] & 1))
3440 pspill[++y] = pspill[x];
3444 /* Find len = length of merging our dirty list with parent's */
3446 dst[0].mid = 0; /* simplify loops */
3447 if (parent->mt_parent) {
3448 len = x + src[0].mid;
3449 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
3450 for (i = x; y && i; y--) {
3451 pgno_t yp = src[y].mid;
3452 while (yp < dst[i].mid)
3454 if (yp == dst[i].mid) {
3459 } else { /* Simplify the above for single-ancestor case */
3460 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
3462 /* Merge our dirty list with parent's */
3464 for (i = len; y; dst[i--] = src[y--]) {
3465 pgno_t yp = src[y].mid;
3466 while (yp < dst[x].mid)
3467 dst[i--] = dst[x--];
3468 if (yp == dst[x].mid)
3469 free(dst[x--].mptr);
3471 mdb_tassert(txn, i == x);
3473 free(txn->mt_u.dirty_list);
3474 parent->mt_dirty_room = txn->mt_dirty_room;
3475 if (txn->mt_spill_pgs) {
3476 if (parent->mt_spill_pgs) {
3477 /* TODO: Prevent failure here, so parent does not fail */
3478 rc = mdb_midl_append_list(&parent->mt_spill_pgs, txn->mt_spill_pgs);
3480 parent->mt_flags |= MDB_TXN_ERROR;
3481 mdb_midl_free(txn->mt_spill_pgs);
3482 mdb_midl_sort(parent->mt_spill_pgs);
3484 parent->mt_spill_pgs = txn->mt_spill_pgs;
3488 /* Append our loose page list to parent's */
3489 for (lp = &parent->mt_loose_pgs; *lp; lp = &NEXT_LOOSE_PAGE(lp))
3491 *lp = txn->mt_loose_pgs;
3492 parent->mt_loose_count += txn->mt_loose_count;
3494 parent->mt_child = NULL;
3495 mdb_midl_free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pghead);
3500 if (txn != env->me_txn) {
3501 DPUTS("attempt to commit unknown transaction");
3506 mdb_cursors_close(txn, 0);
3508 if (!txn->mt_u.dirty_list[0].mid &&
3509 !(txn->mt_flags & (MDB_TXN_DIRTY|MDB_TXN_SPILLS)))
3512 DPRINTF(("committing txn %"Z"u %p on mdbenv %p, root page %"Z"u",
3513 txn->mt_txnid, (void*)txn, (void*)env, txn->mt_dbs[MAIN_DBI].md_root));
3515 /* Update DB root pointers */
3516 if (txn->mt_numdbs > 2) {
3520 data.mv_size = sizeof(MDB_db);
3522 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
3523 for (i = 2; i < txn->mt_numdbs; i++) {
3524 if (txn->mt_dbflags[i] & DB_DIRTY) {
3525 if (TXN_DBI_CHANGED(txn, i)) {
3529 data.mv_data = &txn->mt_dbs[i];
3530 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
3537 rc = mdb_freelist_save(txn);
3541 mdb_midl_free(env->me_pghead);
3542 env->me_pghead = NULL;
3543 if (mdb_midl_shrink(&txn->mt_free_pgs))
3544 env->me_free_pgs = txn->mt_free_pgs;
3550 if ((rc = mdb_page_flush(txn, 0)))
3552 if (!F_ISSET(txn->mt_flags, MDB_TXN_NOSYNC) &&
3553 (rc = mdb_env_sync(env, 0)))
3555 if ((rc = mdb_env_write_meta(txn)))
3558 /* Free P_LOOSE pages left behind in dirty_list */
3559 if (!(env->me_flags & MDB_WRITEMAP))
3560 mdb_dlist_free(txn);
3565 mdb_dbis_update(txn, 1);
3568 UNLOCK_MUTEX(env->me_wmutex);
3569 if (txn != env->me_txn0)
3579 /** Read the environment parameters of a DB environment before
3580 * mapping it into memory.
3581 * @param[in] env the environment handle
3582 * @param[out] meta address of where to store the meta information
3583 * @return 0 on success, non-zero on failure.
3586 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
3592 enum { Size = sizeof(pbuf) };
3594 /* We don't know the page size yet, so use a minimum value.
3595 * Read both meta pages so we can use the latest one.
3598 for (i=off=0; i<2; i++, off = meta->mm_psize) {
3602 memset(&ov, 0, sizeof(ov));
3604 rc = ReadFile(env->me_fd, &pbuf, Size, &len, &ov) ? (int)len : -1;
3605 if (rc == -1 && ErrCode() == ERROR_HANDLE_EOF)
3608 rc = pread(env->me_fd, &pbuf, Size, off);
3611 if (rc == 0 && off == 0)
3613 rc = rc < 0 ? (int) ErrCode() : MDB_INVALID;
3614 DPRINTF(("read: %s", mdb_strerror(rc)));
3618 p = (MDB_page *)&pbuf;
3620 if (!F_ISSET(p->mp_flags, P_META)) {
3621 DPRINTF(("page %"Z"u not a meta page", p->mp_pgno));
3626 if (m->mm_magic != MDB_MAGIC) {
3627 DPUTS("meta has invalid magic");
3631 if (m->mm_version != MDB_DATA_VERSION) {
3632 DPRINTF(("database is version %u, expected version %u",
3633 m->mm_version, MDB_DATA_VERSION));
3634 return MDB_VERSION_MISMATCH;
3637 if (off == 0 || m->mm_txnid > meta->mm_txnid)
3643 /** Fill in most of the zeroed #MDB_meta for an empty database environment */
3645 mdb_env_init_meta0(MDB_env *env, MDB_meta *meta)
3647 meta->mm_magic = MDB_MAGIC;
3648 meta->mm_version = MDB_DATA_VERSION;
3649 meta->mm_mapsize = env->me_mapsize;
3650 meta->mm_psize = env->me_psize;
3651 meta->mm_last_pg = 1;
3652 meta->mm_flags = env->me_flags & 0xffff;
3653 meta->mm_flags |= MDB_INTEGERKEY;
3654 meta->mm_dbs[0].md_root = P_INVALID;
3655 meta->mm_dbs[1].md_root = P_INVALID;
3658 /** Write the environment parameters of a freshly created DB environment.
3659 * @param[in] env the environment handle
3660 * @param[in] meta the #MDB_meta to write
3661 * @return 0 on success, non-zero on failure.
3664 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
3672 memset(&ov, 0, sizeof(ov));
3673 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3675 rc = WriteFile(fd, ptr, size, &len, &ov); } while(0)
3678 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3679 len = pwrite(fd, ptr, size, pos); \
3680 if (len == -1 && ErrCode() == EINTR) continue; \
3681 rc = (len >= 0); break; } while(1)
3684 DPUTS("writing new meta page");
3686 psize = env->me_psize;
3688 p = calloc(2, psize);
3690 p->mp_flags = P_META;
3691 *(MDB_meta *)METADATA(p) = *meta;
3693 q = (MDB_page *)((char *)p + psize);
3695 q->mp_flags = P_META;
3696 *(MDB_meta *)METADATA(q) = *meta;
3698 DO_PWRITE(rc, env->me_fd, p, psize * 2, len, 0);
3701 else if ((unsigned) len == psize * 2)
3709 /** Update the environment info to commit a transaction.
3710 * @param[in] txn the transaction that's being committed
3711 * @return 0 on success, non-zero on failure.
3714 mdb_env_write_meta(MDB_txn *txn)
3717 MDB_meta meta, metab, *mp;
3721 int rc, len, toggle;
3730 toggle = txn->mt_txnid & 1;
3731 DPRINTF(("writing meta page %d for root page %"Z"u",
3732 toggle, txn->mt_dbs[MAIN_DBI].md_root));
3735 flags = txn->mt_flags & env->me_flags;
3736 mp = env->me_metas[toggle];
3737 mapsize = env->me_metas[toggle ^ 1]->mm_mapsize;
3738 /* Persist any increases of mapsize config */
3739 if (mapsize < env->me_mapsize)
3740 mapsize = env->me_mapsize;
3742 if (flags & MDB_WRITEMAP) {
3743 mp->mm_mapsize = mapsize;
3744 mp->mm_dbs[0] = txn->mt_dbs[0];
3745 mp->mm_dbs[1] = txn->mt_dbs[1];
3746 mp->mm_last_pg = txn->mt_next_pgno - 1;
3747 #if !(defined(_MSC_VER) || defined(__i386__) || defined(__x86_64__))
3748 /* LY: issue a memory barrier, if not x86. ITS#7969 */
3749 __sync_synchronize();
3751 mp->mm_txnid = txn->mt_txnid;
3752 if (!(flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
3753 unsigned meta_size = env->me_psize;
3754 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
3757 #ifndef _WIN32 /* POSIX msync() requires ptr = start of OS page */
3758 if (meta_size < env->me_os_psize)
3759 meta_size += meta_size;
3764 if (MDB_MSYNC(ptr, meta_size, rc)) {
3771 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
3772 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
3774 meta.mm_mapsize = mapsize;
3775 meta.mm_dbs[0] = txn->mt_dbs[0];
3776 meta.mm_dbs[1] = txn->mt_dbs[1];
3777 meta.mm_last_pg = txn->mt_next_pgno - 1;
3778 meta.mm_txnid = txn->mt_txnid;
3780 off = offsetof(MDB_meta, mm_mapsize);
3781 ptr = (char *)&meta + off;
3782 len = sizeof(MDB_meta) - off;
3784 off += env->me_psize;
3787 /* Write to the SYNC fd */
3788 mfd = (flags & (MDB_NOSYNC|MDB_NOMETASYNC)) ? env->me_fd : env->me_mfd;
3792 memset(&ov, 0, sizeof(ov));
3794 if (!WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov))
3798 rc = pwrite(mfd, ptr, len, off);
3801 rc = rc < 0 ? ErrCode() : EIO;
3804 DPUTS("write failed, disk error?");
3805 /* On a failure, the pagecache still contains the new data.
3806 * Write some old data back, to prevent it from being used.
3807 * Use the non-SYNC fd; we know it will fail anyway.
3809 meta.mm_last_pg = metab.mm_last_pg;
3810 meta.mm_txnid = metab.mm_txnid;
3812 memset(&ov, 0, sizeof(ov));
3814 WriteFile(env->me_fd, ptr, len, NULL, &ov);
3816 r2 = pwrite(env->me_fd, ptr, len, off);
3817 (void)r2; /* Silence warnings. We don't care about pwrite's return value */
3820 env->me_flags |= MDB_FATAL_ERROR;
3823 /* MIPS has cache coherency issues, this is a no-op everywhere else */
3824 CACHEFLUSH(env->me_map + off, len, DCACHE);
3826 /* Memory ordering issues are irrelevant; since the entire writer
3827 * is wrapped by wmutex, all of these changes will become visible
3828 * after the wmutex is unlocked. Since the DB is multi-version,
3829 * readers will get consistent data regardless of how fresh or
3830 * how stale their view of these values is.
3833 env->me_txns->mti_txnid = txn->mt_txnid;
3838 /** Check both meta pages to see which one is newer.
3839 * @param[in] env the environment handle
3840 * @return meta toggle (0 or 1).
3843 mdb_env_pick_meta(const MDB_env *env)
3845 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
3849 mdb_env_create(MDB_env **env)
3853 e = calloc(1, sizeof(MDB_env));
3857 e->me_maxreaders = DEFAULT_READERS;
3858 e->me_maxdbs = e->me_numdbs = 2;
3859 e->me_fd = INVALID_HANDLE_VALUE;
3860 e->me_lfd = INVALID_HANDLE_VALUE;
3861 e->me_mfd = INVALID_HANDLE_VALUE;
3862 #ifdef MDB_USE_POSIX_SEM
3863 e->me_rmutex = SEM_FAILED;
3864 e->me_wmutex = SEM_FAILED;
3865 #elif defined MDB_USE_SYSV_SEM
3866 e->me_rmutex->semid = -1;
3867 e->me_wmutex->semid = -1;
3869 e->me_pid = getpid();
3870 GET_PAGESIZE(e->me_os_psize);
3871 VGMEMP_CREATE(e,0,0);
3877 mdb_env_map(MDB_env *env, void *addr)
3880 unsigned int flags = env->me_flags;
3884 LONG sizelo, sizehi;
3887 if (flags & MDB_RDONLY) {
3888 /* Don't set explicit map size, use whatever exists */
3893 msize = env->me_mapsize;
3894 sizelo = msize & 0xffffffff;
3895 sizehi = msize >> 16 >> 16; /* only needed on Win64 */
3897 /* Windows won't create mappings for zero length files.
3898 * and won't map more than the file size.
3899 * Just set the maxsize right now.
3901 if (SetFilePointer(env->me_fd, sizelo, &sizehi, 0) != (DWORD)sizelo
3902 || !SetEndOfFile(env->me_fd)
3903 || SetFilePointer(env->me_fd, 0, NULL, 0) != 0)
3907 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
3908 PAGE_READWRITE : PAGE_READONLY,
3909 sizehi, sizelo, NULL);
3912 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
3913 FILE_MAP_WRITE : FILE_MAP_READ,
3915 rc = env->me_map ? 0 : ErrCode();
3920 int prot = PROT_READ;
3921 if (flags & MDB_WRITEMAP) {
3923 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
3926 env->me_map = mmap(addr, env->me_mapsize, prot, MAP_SHARED,
3928 if (env->me_map == MAP_FAILED) {
3933 if (flags & MDB_NORDAHEAD) {
3934 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
3936 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
3938 #ifdef POSIX_MADV_RANDOM
3939 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
3940 #endif /* POSIX_MADV_RANDOM */
3941 #endif /* MADV_RANDOM */
3945 /* Can happen because the address argument to mmap() is just a
3946 * hint. mmap() can pick another, e.g. if the range is in use.
3947 * The MAP_FIXED flag would prevent that, but then mmap could
3948 * instead unmap existing pages to make room for the new map.
3950 if (addr && env->me_map != addr)
3951 return EBUSY; /* TODO: Make a new MDB_* error code? */
3953 p = (MDB_page *)env->me_map;
3954 env->me_metas[0] = METADATA(p);
3955 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + env->me_psize);
3961 mdb_env_set_mapsize(MDB_env *env, size_t size)
3963 /* If env is already open, caller is responsible for making
3964 * sure there are no active txns.
3972 meta = env->me_metas[mdb_env_pick_meta(env)];
3974 size = meta->mm_mapsize;
3976 /* Silently round up to minimum if the size is too small */
3977 size_t minsize = (meta->mm_last_pg + 1) * env->me_psize;
3981 munmap(env->me_map, env->me_mapsize);
3982 env->me_mapsize = size;
3983 old = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : NULL;
3984 rc = mdb_env_map(env, old);
3988 env->me_mapsize = size;
3990 env->me_maxpg = env->me_mapsize / env->me_psize;
3995 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
3999 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
4004 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
4006 if (env->me_map || readers < 1)
4008 env->me_maxreaders = readers;
4013 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
4015 if (!env || !readers)
4017 *readers = env->me_maxreaders;
4022 mdb_fsize(HANDLE fd, size_t *size)
4025 LARGE_INTEGER fsize;
4027 if (!GetFileSizeEx(fd, &fsize))
4030 *size = fsize.QuadPart;
4042 #ifdef BROKEN_FDATASYNC
4043 #include <sys/utsname.h>
4044 #include <sys/vfs.h>
4047 /** Further setup required for opening an LMDB environment
4050 mdb_env_open2(MDB_env *env)
4052 unsigned int flags = env->me_flags;
4053 int i, newenv = 0, rc;
4057 /* See if we should use QueryLimited */
4059 if ((rc & 0xff) > 5)
4060 env->me_pidquery = MDB_PROCESS_QUERY_LIMITED_INFORMATION;
4062 env->me_pidquery = PROCESS_QUERY_INFORMATION;
4065 #ifdef BROKEN_FDATASYNC
4066 /* ext3/ext4 fdatasync is broken on some older Linux kernels.
4067 * https://lkml.org/lkml/2012/9/3/83
4068 * Kernels after 3.6-rc6 are known good.
4069 * https://lkml.org/lkml/2012/9/10/556
4070 * See if the DB is on ext3/ext4, then check for new enough kernel
4071 * Kernels 2.6.32.60, 2.6.34.15, 3.2.30, and 3.5.4 are also known
4076 fstatfs(env->me_fd, &st);
4077 while (st.f_type == 0xEF53) {
4081 if (uts.release[0] < '3') {
4082 if (!strncmp(uts.release, "2.6.32.", 7)) {
4083 i = atoi(uts.release+7);
4085 break; /* 2.6.32.60 and newer is OK */
4086 } else if (!strncmp(uts.release, "2.6.34.", 7)) {
4087 i = atoi(uts.release+7);
4089 break; /* 2.6.34.15 and newer is OK */
4091 } else if (uts.release[0] == '3') {
4092 i = atoi(uts.release+2);
4094 break; /* 3.6 and newer is OK */
4096 i = atoi(uts.release+4);
4098 break; /* 3.5.4 and newer is OK */
4099 } else if (i == 2) {
4100 i = atoi(uts.release+4);
4102 break; /* 3.2.30 and newer is OK */
4104 } else { /* 4.x and newer is OK */
4107 env->me_flags |= MDB_FSYNCONLY;
4113 if ((i = mdb_env_read_header(env, &meta)) != 0) {
4116 DPUTS("new mdbenv");
4118 env->me_psize = env->me_os_psize;
4119 if (env->me_psize > MAX_PAGESIZE)
4120 env->me_psize = MAX_PAGESIZE;
4121 memset(&meta, 0, sizeof(meta));
4122 mdb_env_init_meta0(env, &meta);
4123 meta.mm_mapsize = DEFAULT_MAPSIZE;
4125 env->me_psize = meta.mm_psize;
4128 /* Was a mapsize configured? */
4129 if (!env->me_mapsize) {
4130 env->me_mapsize = meta.mm_mapsize;
4133 /* Make sure mapsize >= committed data size. Even when using
4134 * mm_mapsize, which could be broken in old files (ITS#7789).
4136 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
4137 if (env->me_mapsize < minsize)
4138 env->me_mapsize = minsize;
4140 meta.mm_mapsize = env->me_mapsize;
4142 if (newenv && !(flags & MDB_FIXEDMAP)) {
4143 /* mdb_env_map() may grow the datafile. Write the metapages
4144 * first, so the file will be valid if initialization fails.
4145 * Except with FIXEDMAP, since we do not yet know mm_address.
4146 * We could fill in mm_address later, but then a different
4147 * program might end up doing that - one with a memory layout
4148 * and map address which does not suit the main program.
4150 rc = mdb_env_init_meta(env, &meta);
4156 rc = mdb_env_map(env, (flags & MDB_FIXEDMAP) ? meta.mm_address : NULL);
4161 if (flags & MDB_FIXEDMAP)
4162 meta.mm_address = env->me_map;
4163 i = mdb_env_init_meta(env, &meta);
4164 if (i != MDB_SUCCESS) {
4169 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
4170 env->me_nodemax = (((env->me_psize - PAGEHDRSZ) / MDB_MINKEYS) & -2)
4172 #if !(MDB_MAXKEYSIZE)
4173 env->me_maxkey = env->me_nodemax - (NODESIZE + sizeof(MDB_db));
4175 env->me_maxpg = env->me_mapsize / env->me_psize;
4179 int toggle = mdb_env_pick_meta(env);
4180 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
4182 DPRINTF(("opened database version %u, pagesize %u",
4183 env->me_metas[0]->mm_version, env->me_psize));
4184 DPRINTF(("using meta page %d", toggle));
4185 DPRINTF(("depth: %u", db->md_depth));
4186 DPRINTF(("entries: %"Z"u", db->md_entries));
4187 DPRINTF(("branch pages: %"Z"u", db->md_branch_pages));
4188 DPRINTF(("leaf pages: %"Z"u", db->md_leaf_pages));
4189 DPRINTF(("overflow pages: %"Z"u", db->md_overflow_pages));
4190 DPRINTF(("root: %"Z"u", db->md_root));
4198 /** Release a reader thread's slot in the reader lock table.
4199 * This function is called automatically when a thread exits.
4200 * @param[in] ptr This points to the slot in the reader lock table.
4203 mdb_env_reader_dest(void *ptr)
4205 MDB_reader *reader = ptr;
4211 /** Junk for arranging thread-specific callbacks on Windows. This is
4212 * necessarily platform and compiler-specific. Windows supports up
4213 * to 1088 keys. Let's assume nobody opens more than 64 environments
4214 * in a single process, for now. They can override this if needed.
4216 #ifndef MAX_TLS_KEYS
4217 #define MAX_TLS_KEYS 64
4219 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
4220 static int mdb_tls_nkeys;
4222 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
4226 case DLL_PROCESS_ATTACH: break;
4227 case DLL_THREAD_ATTACH: break;
4228 case DLL_THREAD_DETACH:
4229 for (i=0; i<mdb_tls_nkeys; i++) {
4230 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
4232 mdb_env_reader_dest(r);
4236 case DLL_PROCESS_DETACH: break;
4241 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
4243 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
4247 /* Force some symbol references.
4248 * _tls_used forces the linker to create the TLS directory if not already done
4249 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
4251 #pragma comment(linker, "/INCLUDE:_tls_used")
4252 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
4253 #pragma const_seg(".CRT$XLB")
4254 extern const PIMAGE_TLS_CALLBACK mdb_tls_cbp;
4255 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
4258 #pragma comment(linker, "/INCLUDE:__tls_used")
4259 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
4260 #pragma data_seg(".CRT$XLB")
4261 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
4263 #endif /* WIN 32/64 */
4264 #endif /* !__GNUC__ */
4267 /** Downgrade the exclusive lock on the region back to shared */
4269 mdb_env_share_locks(MDB_env *env, int *excl)
4271 int rc = 0, toggle = mdb_env_pick_meta(env);
4273 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
4278 /* First acquire a shared lock. The Unlock will
4279 * then release the existing exclusive lock.
4281 memset(&ov, 0, sizeof(ov));
4282 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
4285 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4291 struct flock lock_info;
4292 /* The shared lock replaces the existing lock */
4293 memset((void *)&lock_info, 0, sizeof(lock_info));
4294 lock_info.l_type = F_RDLCK;
4295 lock_info.l_whence = SEEK_SET;
4296 lock_info.l_start = 0;
4297 lock_info.l_len = 1;
4298 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
4299 (rc = ErrCode()) == EINTR) ;
4300 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
4307 /** Try to get exclusive lock, otherwise shared.
4308 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
4311 mdb_env_excl_lock(MDB_env *env, int *excl)
4315 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
4319 memset(&ov, 0, sizeof(ov));
4320 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
4327 struct flock lock_info;
4328 memset((void *)&lock_info, 0, sizeof(lock_info));
4329 lock_info.l_type = F_WRLCK;
4330 lock_info.l_whence = SEEK_SET;
4331 lock_info.l_start = 0;
4332 lock_info.l_len = 1;
4333 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
4334 (rc = ErrCode()) == EINTR) ;
4338 # ifndef MDB_USE_POSIX_MUTEX
4339 if (*excl < 0) /* always true when MDB_USE_POSIX_MUTEX */
4342 lock_info.l_type = F_RDLCK;
4343 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
4344 (rc = ErrCode()) == EINTR) ;
4354 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
4356 * @(#) $Revision: 5.1 $
4357 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
4358 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
4360 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
4364 * Please do not copyright this code. This code is in the public domain.
4366 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
4367 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
4368 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
4369 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
4370 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
4371 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4372 * PERFORMANCE OF THIS SOFTWARE.
4375 * chongo <Landon Curt Noll> /\oo/\
4376 * http://www.isthe.com/chongo/
4378 * Share and Enjoy! :-)
4381 typedef unsigned long long mdb_hash_t;
4382 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
4384 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
4385 * @param[in] val value to hash
4386 * @param[in] hval initial value for hash
4387 * @return 64 bit hash
4389 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
4390 * hval arg on the first call.
4393 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
4395 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
4396 unsigned char *end = s + val->mv_size;
4398 * FNV-1a hash each octet of the string
4401 /* xor the bottom with the current octet */
4402 hval ^= (mdb_hash_t)*s++;
4404 /* multiply by the 64 bit FNV magic prime mod 2^64 */
4405 hval += (hval << 1) + (hval << 4) + (hval << 5) +
4406 (hval << 7) + (hval << 8) + (hval << 40);
4408 /* return our new hash value */
4412 /** Hash the string and output the encoded hash.
4413 * This uses modified RFC1924 Ascii85 encoding to accommodate systems with
4414 * very short name limits. We don't care about the encoding being reversible,
4415 * we just want to preserve as many bits of the input as possible in a
4416 * small printable string.
4417 * @param[in] str string to hash
4418 * @param[out] encbuf an array of 11 chars to hold the hash
4420 static const char mdb_a85[]= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!#$%&()*+-;<=>?@^_`{|}~";
4423 mdb_pack85(unsigned long l, char *out)
4427 for (i=0; i<5; i++) {
4428 *out++ = mdb_a85[l % 85];
4434 mdb_hash_enc(MDB_val *val, char *encbuf)
4436 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
4438 mdb_pack85(h, encbuf);
4439 mdb_pack85(h>>32, encbuf+5);
4444 /** Open and/or initialize the lock region for the environment.
4445 * @param[in] env The LMDB environment.
4446 * @param[in] lpath The pathname of the file used for the lock region.
4447 * @param[in] mode The Unix permissions for the file, if we create it.
4448 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
4449 * @return 0 on success, non-zero on failure.
4452 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
4455 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
4457 # define MDB_ERRCODE_ROFS EROFS
4458 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
4459 # define MDB_CLOEXEC O_CLOEXEC
4462 # define MDB_CLOEXEC 0
4465 #ifdef MDB_USE_SYSV_SEM
4473 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
4474 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
4475 FILE_ATTRIBUTE_NORMAL, NULL);
4477 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
4479 if (env->me_lfd == INVALID_HANDLE_VALUE) {
4481 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
4486 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
4487 /* Lose record locks when exec*() */
4488 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
4489 fcntl(env->me_lfd, F_SETFD, fdflags);
4492 if (!(env->me_flags & MDB_NOTLS)) {
4493 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
4496 env->me_flags |= MDB_ENV_TXKEY;
4498 /* Windows TLS callbacks need help finding their TLS info. */
4499 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
4503 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
4507 /* Try to get exclusive lock. If we succeed, then
4508 * nobody is using the lock region and we should initialize it.
4510 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
4513 size = GetFileSize(env->me_lfd, NULL);
4515 size = lseek(env->me_lfd, 0, SEEK_END);
4516 if (size == -1) goto fail_errno;
4518 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
4519 if (size < rsize && *excl > 0) {
4521 if (SetFilePointer(env->me_lfd, rsize, NULL, FILE_BEGIN) != (DWORD)rsize
4522 || !SetEndOfFile(env->me_lfd))
4525 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
4529 size = rsize - sizeof(MDB_txninfo);
4530 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
4535 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
4537 if (!mh) goto fail_errno;
4538 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
4540 if (!env->me_txns) goto fail_errno;
4542 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
4544 if (m == MAP_FAILED) goto fail_errno;
4550 BY_HANDLE_FILE_INFORMATION stbuf;
4559 if (!mdb_sec_inited) {
4560 InitializeSecurityDescriptor(&mdb_null_sd,
4561 SECURITY_DESCRIPTOR_REVISION);
4562 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
4563 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
4564 mdb_all_sa.bInheritHandle = FALSE;
4565 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
4568 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
4569 idbuf.volume = stbuf.dwVolumeSerialNumber;
4570 idbuf.nhigh = stbuf.nFileIndexHigh;
4571 idbuf.nlow = stbuf.nFileIndexLow;
4572 val.mv_data = &idbuf;
4573 val.mv_size = sizeof(idbuf);
4574 mdb_hash_enc(&val, encbuf);
4575 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", encbuf);
4576 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", encbuf);
4577 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
4578 if (!env->me_rmutex) goto fail_errno;
4579 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
4580 if (!env->me_wmutex) goto fail_errno;
4581 #elif defined(MDB_USE_POSIX_SEM)
4590 #if defined(__NetBSD__)
4591 #define MDB_SHORT_SEMNAMES 1 /* limited to 14 chars */
4593 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
4594 idbuf.dev = stbuf.st_dev;
4595 idbuf.ino = stbuf.st_ino;
4596 val.mv_data = &idbuf;
4597 val.mv_size = sizeof(idbuf);
4598 mdb_hash_enc(&val, encbuf);
4599 #ifdef MDB_SHORT_SEMNAMES
4600 encbuf[9] = '\0'; /* drop name from 15 chars to 14 chars */
4602 sprintf(env->me_txns->mti_rmname, "/MDBr%s", encbuf);
4603 sprintf(env->me_txns->mti_wmname, "/MDBw%s", encbuf);
4604 /* Clean up after a previous run, if needed: Try to
4605 * remove both semaphores before doing anything else.
4607 sem_unlink(env->me_txns->mti_rmname);
4608 sem_unlink(env->me_txns->mti_wmname);
4609 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
4610 O_CREAT|O_EXCL, mode, 1);
4611 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4612 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
4613 O_CREAT|O_EXCL, mode, 1);
4614 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4615 #elif defined(MDB_USE_SYSV_SEM)
4616 unsigned short vals[2] = {1, 1};
4617 key_t key = ftok(lpath, 'M');
4620 semid = semget(key, 2, (mode & 0777) | IPC_CREAT);
4624 if (semctl(semid, 0, SETALL, semu) < 0)
4626 env->me_txns->mti_semid = semid;
4627 #else /* MDB_USE_POSIX_MUTEX: */
4628 pthread_mutexattr_t mattr;
4630 if ((rc = pthread_mutexattr_init(&mattr))
4631 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
4632 #ifdef MDB_ROBUST_SUPPORTED
4633 || (rc = pthread_mutexattr_setrobust(&mattr, PTHREAD_MUTEX_ROBUST))
4635 || (rc = pthread_mutex_init(env->me_txns->mti_rmutex, &mattr))
4636 || (rc = pthread_mutex_init(env->me_txns->mti_wmutex, &mattr)))
4638 pthread_mutexattr_destroy(&mattr);
4639 #endif /* _WIN32 || ... */
4641 env->me_txns->mti_magic = MDB_MAGIC;
4642 env->me_txns->mti_format = MDB_LOCK_FORMAT;
4643 env->me_txns->mti_txnid = 0;
4644 env->me_txns->mti_numreaders = 0;
4647 #ifdef MDB_USE_SYSV_SEM
4648 struct semid_ds buf;
4650 if (env->me_txns->mti_magic != MDB_MAGIC) {
4651 DPUTS("lock region has invalid magic");
4655 if (env->me_txns->mti_format != MDB_LOCK_FORMAT) {
4656 DPRINTF(("lock region has format+version 0x%x, expected 0x%x",
4657 env->me_txns->mti_format, MDB_LOCK_FORMAT));
4658 rc = MDB_VERSION_MISMATCH;
4662 if (rc && rc != EACCES && rc != EAGAIN) {
4666 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
4667 if (!env->me_rmutex) goto fail_errno;
4668 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
4669 if (!env->me_wmutex) goto fail_errno;
4670 #elif defined(MDB_USE_POSIX_SEM)
4671 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
4672 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4673 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
4674 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4675 #elif defined(MDB_USE_SYSV_SEM)
4676 semid = env->me_txns->mti_semid;
4678 /* check for read access */
4679 if (semctl(semid, 0, IPC_STAT, semu) < 0)
4681 /* check for write access */
4682 if (semctl(semid, 0, IPC_SET, semu) < 0)
4686 #ifdef MDB_USE_SYSV_SEM
4687 env->me_rmutex->semid = semid;
4688 env->me_wmutex->semid = semid;
4689 env->me_rmutex->semnum = 0;
4690 env->me_wmutex->semnum = 1;
4691 env->me_rmutex->locked = &env->me_txns->mti_rlocked;
4692 env->me_wmutex->locked = &env->me_txns->mti_wlocked;
4703 /** The name of the lock file in the DB environment */
4704 #define LOCKNAME "/lock.mdb"
4705 /** The name of the data file in the DB environment */
4706 #define DATANAME "/data.mdb"
4707 /** The suffix of the lock file when no subdir is used */
4708 #define LOCKSUFF "-lock"
4709 /** Only a subset of the @ref mdb_env flags can be changed
4710 * at runtime. Changing other flags requires closing the
4711 * environment and re-opening it with the new flags.
4713 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC|MDB_NOMEMINIT)
4714 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY| \
4715 MDB_WRITEMAP|MDB_NOTLS|MDB_NOLOCK|MDB_NORDAHEAD)
4717 #if VALID_FLAGS & PERSISTENT_FLAGS & (CHANGEABLE|CHANGELESS)
4718 # error "Persistent DB flags & env flags overlap, but both go in mm_flags"
4722 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
4724 int oflags, rc, len, excl = -1;
4725 char *lpath, *dpath;
4727 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
4731 if (flags & MDB_NOSUBDIR) {
4732 rc = len + sizeof(LOCKSUFF) + len + 1;
4734 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
4739 if (flags & MDB_NOSUBDIR) {
4740 dpath = lpath + len + sizeof(LOCKSUFF);
4741 sprintf(lpath, "%s" LOCKSUFF, path);
4742 strcpy(dpath, path);
4744 dpath = lpath + len + sizeof(LOCKNAME);
4745 sprintf(lpath, "%s" LOCKNAME, path);
4746 sprintf(dpath, "%s" DATANAME, path);
4750 flags |= env->me_flags;
4751 if (flags & MDB_RDONLY) {
4752 /* silently ignore WRITEMAP when we're only getting read access */
4753 flags &= ~MDB_WRITEMAP;
4755 if (!((env->me_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)) &&
4756 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
4759 env->me_flags = flags |= MDB_ENV_ACTIVE;
4763 env->me_path = strdup(path);
4764 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
4765 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
4766 env->me_dbiseqs = calloc(env->me_maxdbs, sizeof(unsigned int));
4767 if (!(env->me_dbxs && env->me_path && env->me_dbflags && env->me_dbiseqs)) {
4772 /* For RDONLY, get lockfile after we know datafile exists */
4773 if (!(flags & (MDB_RDONLY|MDB_NOLOCK))) {
4774 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4780 if (F_ISSET(flags, MDB_RDONLY)) {
4781 oflags = GENERIC_READ;
4782 len = OPEN_EXISTING;
4784 oflags = GENERIC_READ|GENERIC_WRITE;
4787 mode = FILE_ATTRIBUTE_NORMAL;
4788 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
4789 NULL, len, mode, NULL);
4791 if (F_ISSET(flags, MDB_RDONLY))
4794 oflags = O_RDWR | O_CREAT;
4796 env->me_fd = open(dpath, oflags, mode);
4798 if (env->me_fd == INVALID_HANDLE_VALUE) {
4803 if ((flags & (MDB_RDONLY|MDB_NOLOCK)) == MDB_RDONLY) {
4804 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4809 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
4810 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
4811 env->me_mfd = env->me_fd;
4813 /* Synchronous fd for meta writes. Needed even with
4814 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
4817 len = OPEN_EXISTING;
4818 env->me_mfd = CreateFile(dpath, oflags,
4819 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
4820 mode | FILE_FLAG_WRITE_THROUGH, NULL);
4823 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
4825 if (env->me_mfd == INVALID_HANDLE_VALUE) {
4830 DPRINTF(("opened dbenv %p", (void *) env));
4832 rc = mdb_env_share_locks(env, &excl);
4836 if (!(flags & MDB_RDONLY)) {
4838 int tsize = sizeof(MDB_txn), size = tsize + env->me_maxdbs *
4839 (sizeof(MDB_db)+sizeof(MDB_cursor *)+sizeof(unsigned int)+1);
4840 if ((env->me_pbuf = calloc(1, env->me_psize)) &&
4841 (txn = calloc(1, size)))
4843 txn->mt_dbs = (MDB_db *)((char *)txn + tsize);
4844 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
4845 txn->mt_dbiseqs = (unsigned int *)(txn->mt_cursors + env->me_maxdbs);
4846 txn->mt_dbflags = (unsigned char *)(txn->mt_dbiseqs + env->me_maxdbs);
4848 txn->mt_dbxs = env->me_dbxs;
4858 mdb_env_close0(env, excl);
4864 /** Destroy resources from mdb_env_open(), clear our readers & DBIs */
4866 mdb_env_close0(MDB_env *env, int excl)
4870 if (!(env->me_flags & MDB_ENV_ACTIVE))
4873 /* Doing this here since me_dbxs may not exist during mdb_env_close */
4875 for (i = env->me_maxdbs; --i > MAIN_DBI; )
4876 free(env->me_dbxs[i].md_name.mv_data);
4881 free(env->me_dbiseqs);
4882 free(env->me_dbflags);
4884 free(env->me_dirty_list);
4886 mdb_midl_free(env->me_free_pgs);
4888 if (env->me_flags & MDB_ENV_TXKEY) {
4889 pthread_key_delete(env->me_txkey);
4891 /* Delete our key from the global list */
4892 for (i=0; i<mdb_tls_nkeys; i++)
4893 if (mdb_tls_keys[i] == env->me_txkey) {
4894 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
4902 munmap(env->me_map, env->me_mapsize);
4904 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
4905 (void) close(env->me_mfd);
4906 if (env->me_fd != INVALID_HANDLE_VALUE)
4907 (void) close(env->me_fd);
4909 MDB_PID_T pid = env->me_pid;
4910 /* Clearing readers is done in this function because
4911 * me_txkey with its destructor must be disabled first.
4913 * We skip the the reader mutex, so we touch only
4914 * data owned by this process (me_close_readers and
4915 * our readers), and clear each reader atomically.
4917 for (i = env->me_close_readers; --i >= 0; )
4918 if (env->me_txns->mti_readers[i].mr_pid == pid)
4919 env->me_txns->mti_readers[i].mr_pid = 0;
4921 if (env->me_rmutex) {
4922 CloseHandle(env->me_rmutex);
4923 if (env->me_wmutex) CloseHandle(env->me_wmutex);
4925 /* Windows automatically destroys the mutexes when
4926 * the last handle closes.
4928 #elif defined(MDB_USE_POSIX_SEM)
4929 if (env->me_rmutex != SEM_FAILED) {
4930 sem_close(env->me_rmutex);
4931 if (env->me_wmutex != SEM_FAILED)
4932 sem_close(env->me_wmutex);
4933 /* If we have the filelock: If we are the
4934 * only remaining user, clean up semaphores.
4937 mdb_env_excl_lock(env, &excl);
4939 sem_unlink(env->me_txns->mti_rmname);
4940 sem_unlink(env->me_txns->mti_wmname);
4943 #elif defined(MDB_USE_SYSV_SEM)
4944 if (env->me_rmutex->semid != -1) {
4945 /* If we have the filelock: If we are the
4946 * only remaining user, clean up semaphores.
4949 mdb_env_excl_lock(env, &excl);
4951 semctl(env->me_rmutex->semid, 0, IPC_RMID);
4954 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
4956 if (env->me_lfd != INVALID_HANDLE_VALUE) {
4959 /* Unlock the lockfile. Windows would have unlocked it
4960 * after closing anyway, but not necessarily at once.
4962 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4965 (void) close(env->me_lfd);
4968 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
4972 mdb_env_close(MDB_env *env)
4979 VGMEMP_DESTROY(env);
4980 while ((dp = env->me_dpages) != NULL) {
4981 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
4982 env->me_dpages = dp->mp_next;
4986 mdb_env_close0(env, 0);
4990 /** Compare two items pointing at aligned size_t's */
4992 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
4994 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
4995 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
4998 /** Compare two items pointing at aligned unsigned int's.
5000 * This is also set as #MDB_INTEGERDUP|#MDB_DUPFIXED's #MDB_dbx.%md_dcmp,
5001 * but #mdb_cmp_clong() is called instead if the data type is size_t.
5004 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
5006 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
5007 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
5010 /** Compare two items pointing at unsigned ints of unknown alignment.
5011 * Nodes and keys are guaranteed to be 2-byte aligned.
5014 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
5016 #if BYTE_ORDER == LITTLE_ENDIAN
5017 unsigned short *u, *c;
5020 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
5021 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
5024 } while(!x && u > (unsigned short *)a->mv_data);
5027 unsigned short *u, *c, *end;
5030 end = (unsigned short *) ((char *) a->mv_data + a->mv_size);
5031 u = (unsigned short *)a->mv_data;
5032 c = (unsigned short *)b->mv_data;
5035 } while(!x && u < end);
5040 /** Compare two items lexically */
5042 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
5049 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
5055 diff = memcmp(a->mv_data, b->mv_data, len);
5056 return diff ? diff : len_diff<0 ? -1 : len_diff;
5059 /** Compare two items in reverse byte order */
5061 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
5063 const unsigned char *p1, *p2, *p1_lim;
5067 p1_lim = (const unsigned char *)a->mv_data;
5068 p1 = (const unsigned char *)a->mv_data + a->mv_size;
5069 p2 = (const unsigned char *)b->mv_data + b->mv_size;
5071 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
5077 while (p1 > p1_lim) {
5078 diff = *--p1 - *--p2;
5082 return len_diff<0 ? -1 : len_diff;
5085 /** Search for key within a page, using binary search.
5086 * Returns the smallest entry larger or equal to the key.
5087 * If exactp is non-null, stores whether the found entry was an exact match
5088 * in *exactp (1 or 0).
5089 * Updates the cursor index with the index of the found entry.
5090 * If no entry larger or equal to the key is found, returns NULL.
5093 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
5095 unsigned int i = 0, nkeys;
5098 MDB_page *mp = mc->mc_pg[mc->mc_top];
5099 MDB_node *node = NULL;
5104 nkeys = NUMKEYS(mp);
5106 DPRINTF(("searching %u keys in %s %spage %"Z"u",
5107 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
5110 low = IS_LEAF(mp) ? 0 : 1;
5112 cmp = mc->mc_dbx->md_cmp;
5114 /* Branch pages have no data, so if using integer keys,
5115 * alignment is guaranteed. Use faster mdb_cmp_int.
5117 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
5118 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
5125 nodekey.mv_size = mc->mc_db->md_pad;
5126 node = NODEPTR(mp, 0); /* fake */
5127 while (low <= high) {
5128 i = (low + high) >> 1;
5129 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
5130 rc = cmp(key, &nodekey);
5131 DPRINTF(("found leaf index %u [%s], rc = %i",
5132 i, DKEY(&nodekey), rc));
5141 while (low <= high) {
5142 i = (low + high) >> 1;
5144 node = NODEPTR(mp, i);
5145 nodekey.mv_size = NODEKSZ(node);
5146 nodekey.mv_data = NODEKEY(node);
5148 rc = cmp(key, &nodekey);
5151 DPRINTF(("found leaf index %u [%s], rc = %i",
5152 i, DKEY(&nodekey), rc));
5154 DPRINTF(("found branch index %u [%s -> %"Z"u], rc = %i",
5155 i, DKEY(&nodekey), NODEPGNO(node), rc));
5166 if (rc > 0) { /* Found entry is less than the key. */
5167 i++; /* Skip to get the smallest entry larger than key. */
5169 node = NODEPTR(mp, i);
5172 *exactp = (rc == 0 && nkeys > 0);
5173 /* store the key index */
5174 mc->mc_ki[mc->mc_top] = i;
5176 /* There is no entry larger or equal to the key. */
5179 /* nodeptr is fake for LEAF2 */
5185 mdb_cursor_adjust(MDB_cursor *mc, func)
5189 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5190 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
5197 /** Pop a page off the top of the cursor's stack. */
5199 mdb_cursor_pop(MDB_cursor *mc)
5203 MDB_page *top = mc->mc_pg[mc->mc_top];
5209 DPRINTF(("popped page %"Z"u off db %d cursor %p", top->mp_pgno,
5210 DDBI(mc), (void *) mc));
5214 /** Push a page onto the top of the cursor's stack. */
5216 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
5218 DPRINTF(("pushing page %"Z"u on db %d cursor %p", mp->mp_pgno,
5219 DDBI(mc), (void *) mc));
5221 if (mc->mc_snum >= CURSOR_STACK) {
5222 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5223 return MDB_CURSOR_FULL;
5226 mc->mc_top = mc->mc_snum++;
5227 mc->mc_pg[mc->mc_top] = mp;
5228 mc->mc_ki[mc->mc_top] = 0;
5233 /** Find the address of the page corresponding to a given page number.
5234 * @param[in] txn the transaction for this access.
5235 * @param[in] pgno the page number for the page to retrieve.
5236 * @param[out] ret address of a pointer where the page's address will be stored.
5237 * @param[out] lvl dirty_list inheritance level of found page. 1=current txn, 0=mapped page.
5238 * @return 0 on success, non-zero on failure.
5241 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret, int *lvl)
5243 MDB_env *env = txn->mt_env;
5247 if (! (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_WRITEMAP))) {
5251 MDB_ID2L dl = tx2->mt_u.dirty_list;
5253 /* Spilled pages were dirtied in this txn and flushed
5254 * because the dirty list got full. Bring this page
5255 * back in from the map (but don't unspill it here,
5256 * leave that unless page_touch happens again).
5258 if (tx2->mt_spill_pgs) {
5259 MDB_ID pn = pgno << 1;
5260 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
5261 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
5262 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
5267 unsigned x = mdb_mid2l_search(dl, pgno);
5268 if (x <= dl[0].mid && dl[x].mid == pgno) {
5274 } while ((tx2 = tx2->mt_parent) != NULL);
5277 if (pgno < txn->mt_next_pgno) {
5279 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
5281 DPRINTF(("page %"Z"u not found", pgno));
5282 txn->mt_flags |= MDB_TXN_ERROR;
5283 return MDB_PAGE_NOTFOUND;
5293 /** Finish #mdb_page_search() / #mdb_page_search_lowest().
5294 * The cursor is at the root page, set up the rest of it.
5297 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int flags)
5299 MDB_page *mp = mc->mc_pg[mc->mc_top];
5303 while (IS_BRANCH(mp)) {
5307 DPRINTF(("branch page %"Z"u has %u keys", mp->mp_pgno, NUMKEYS(mp)));
5308 mdb_cassert(mc, NUMKEYS(mp) > 1);
5309 DPRINTF(("found index 0 to page %"Z"u", NODEPGNO(NODEPTR(mp, 0))));
5311 if (flags & (MDB_PS_FIRST|MDB_PS_LAST)) {
5313 if (flags & MDB_PS_LAST)
5314 i = NUMKEYS(mp) - 1;
5317 node = mdb_node_search(mc, key, &exact);
5319 i = NUMKEYS(mp) - 1;
5321 i = mc->mc_ki[mc->mc_top];
5323 mdb_cassert(mc, i > 0);
5327 DPRINTF(("following index %u for key [%s]", i, DKEY(key)));
5330 mdb_cassert(mc, i < NUMKEYS(mp));
5331 node = NODEPTR(mp, i);
5333 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
5336 mc->mc_ki[mc->mc_top] = i;
5337 if ((rc = mdb_cursor_push(mc, mp)))
5340 if (flags & MDB_PS_MODIFY) {
5341 if ((rc = mdb_page_touch(mc)) != 0)
5343 mp = mc->mc_pg[mc->mc_top];
5348 DPRINTF(("internal error, index points to a %02X page!?",
5350 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5351 return MDB_CORRUPTED;
5354 DPRINTF(("found leaf page %"Z"u for key [%s]", mp->mp_pgno,
5355 key ? DKEY(key) : "null"));
5356 mc->mc_flags |= C_INITIALIZED;
5357 mc->mc_flags &= ~C_EOF;
5362 /** Search for the lowest key under the current branch page.
5363 * This just bypasses a NUMKEYS check in the current page
5364 * before calling mdb_page_search_root(), because the callers
5365 * are all in situations where the current page is known to
5369 mdb_page_search_lowest(MDB_cursor *mc)
5371 MDB_page *mp = mc->mc_pg[mc->mc_top];
5372 MDB_node *node = NODEPTR(mp, 0);
5375 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
5378 mc->mc_ki[mc->mc_top] = 0;
5379 if ((rc = mdb_cursor_push(mc, mp)))
5381 return mdb_page_search_root(mc, NULL, MDB_PS_FIRST);
5384 /** Search for the page a given key should be in.
5385 * Push it and its parent pages on the cursor stack.
5386 * @param[in,out] mc the cursor for this operation.
5387 * @param[in] key the key to search for, or NULL for first/last page.
5388 * @param[in] flags If MDB_PS_MODIFY is set, visited pages in the DB
5389 * are touched (updated with new page numbers).
5390 * If MDB_PS_FIRST or MDB_PS_LAST is set, find first or last leaf.
5391 * This is used by #mdb_cursor_first() and #mdb_cursor_last().
5392 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
5393 * @return 0 on success, non-zero on failure.
5396 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
5401 /* Make sure the txn is still viable, then find the root from
5402 * the txn's db table and set it as the root of the cursor's stack.
5404 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
5405 DPUTS("transaction has failed, must abort");
5408 /* Make sure we're using an up-to-date root */
5409 if (*mc->mc_dbflag & DB_STALE) {
5411 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
5413 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
5414 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, 0);
5421 MDB_node *leaf = mdb_node_search(&mc2,
5422 &mc->mc_dbx->md_name, &exact);
5424 return MDB_NOTFOUND;
5425 rc = mdb_node_read(mc->mc_txn, leaf, &data);
5428 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
5430 /* The txn may not know this DBI, or another process may
5431 * have dropped and recreated the DB with other flags.
5433 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
5434 return MDB_INCOMPATIBLE;
5435 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
5437 *mc->mc_dbflag &= ~DB_STALE;
5439 root = mc->mc_db->md_root;
5441 if (root == P_INVALID) { /* Tree is empty. */
5442 DPUTS("tree is empty");
5443 return MDB_NOTFOUND;
5447 mdb_cassert(mc, root > 1);
5448 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
5449 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0], NULL)) != 0)
5455 DPRINTF(("db %d root page %"Z"u has flags 0x%X",
5456 DDBI(mc), root, mc->mc_pg[0]->mp_flags));
5458 if (flags & MDB_PS_MODIFY) {
5459 if ((rc = mdb_page_touch(mc)))
5463 if (flags & MDB_PS_ROOTONLY)
5466 return mdb_page_search_root(mc, key, flags);
5470 mdb_ovpage_free(MDB_cursor *mc, MDB_page *mp)
5472 MDB_txn *txn = mc->mc_txn;
5473 pgno_t pg = mp->mp_pgno;
5474 unsigned x = 0, ovpages = mp->mp_pages;
5475 MDB_env *env = txn->mt_env;
5476 MDB_IDL sl = txn->mt_spill_pgs;
5477 MDB_ID pn = pg << 1;
5480 DPRINTF(("free ov page %"Z"u (%d)", pg, ovpages));
5481 /* If the page is dirty or on the spill list we just acquired it,
5482 * so we should give it back to our current free list, if any.
5483 * Otherwise put it onto the list of pages we freed in this txn.
5485 * Won't create me_pghead: me_pglast must be inited along with it.
5486 * Unsupported in nested txns: They would need to hide the page
5487 * range in ancestor txns' dirty and spilled lists.
5489 if (env->me_pghead &&
5491 ((mp->mp_flags & P_DIRTY) ||
5492 (sl && (x = mdb_midl_search(sl, pn)) <= sl[0] && sl[x] == pn)))
5496 MDB_ID2 *dl, ix, iy;
5497 rc = mdb_midl_need(&env->me_pghead, ovpages);
5500 if (!(mp->mp_flags & P_DIRTY)) {
5501 /* This page is no longer spilled */
5508 /* Remove from dirty list */
5509 dl = txn->mt_u.dirty_list;
5511 for (ix = dl[x]; ix.mptr != mp; ix = iy) {
5517 mdb_cassert(mc, x > 1);
5519 dl[j] = ix; /* Unsorted. OK when MDB_TXN_ERROR. */
5520 txn->mt_flags |= MDB_TXN_ERROR;
5521 return MDB_CORRUPTED;
5524 if (!(env->me_flags & MDB_WRITEMAP))
5525 mdb_dpage_free(env, mp);
5527 /* Insert in me_pghead */
5528 mop = env->me_pghead;
5529 j = mop[0] + ovpages;
5530 for (i = mop[0]; i && mop[i] < pg; i--)
5536 rc = mdb_midl_append_range(&txn->mt_free_pgs, pg, ovpages);
5540 mc->mc_db->md_overflow_pages -= ovpages;
5544 /** Return the data associated with a given node.
5545 * @param[in] txn The transaction for this operation.
5546 * @param[in] leaf The node being read.
5547 * @param[out] data Updated to point to the node's data.
5548 * @return 0 on success, non-zero on failure.
5551 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
5553 MDB_page *omp; /* overflow page */
5557 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5558 data->mv_size = NODEDSZ(leaf);
5559 data->mv_data = NODEDATA(leaf);
5563 /* Read overflow data.
5565 data->mv_size = NODEDSZ(leaf);
5566 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
5567 if ((rc = mdb_page_get(txn, pgno, &omp, NULL)) != 0) {
5568 DPRINTF(("read overflow page %"Z"u failed", pgno));
5571 data->mv_data = METADATA(omp);
5577 mdb_get(MDB_txn *txn, MDB_dbi dbi,
5578 MDB_val *key, MDB_val *data)
5585 DPRINTF(("===> get db %u key [%s]", dbi, DKEY(key)));
5587 if (!key || !data || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
5590 if (txn->mt_flags & MDB_TXN_ERROR)
5593 mdb_cursor_init(&mc, txn, dbi, &mx);
5594 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
5597 /** Find a sibling for a page.
5598 * Replaces the page at the top of the cursor's stack with the
5599 * specified sibling, if one exists.
5600 * @param[in] mc The cursor for this operation.
5601 * @param[in] move_right Non-zero if the right sibling is requested,
5602 * otherwise the left sibling.
5603 * @return 0 on success, non-zero on failure.
5606 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
5612 if (mc->mc_snum < 2) {
5613 return MDB_NOTFOUND; /* root has no siblings */
5617 DPRINTF(("parent page is page %"Z"u, index %u",
5618 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]));
5620 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
5621 : (mc->mc_ki[mc->mc_top] == 0)) {
5622 DPRINTF(("no more keys left, moving to %s sibling",
5623 move_right ? "right" : "left"));
5624 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
5625 /* undo cursor_pop before returning */
5632 mc->mc_ki[mc->mc_top]++;
5634 mc->mc_ki[mc->mc_top]--;
5635 DPRINTF(("just moving to %s index key %u",
5636 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]));
5638 mdb_cassert(mc, IS_BRANCH(mc->mc_pg[mc->mc_top]));
5640 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5641 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp, NULL)) != 0) {
5642 /* mc will be inconsistent if caller does mc_snum++ as above */
5643 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
5647 mdb_cursor_push(mc, mp);
5649 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
5654 /** Move the cursor to the next data item. */
5656 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5662 if (mc->mc_flags & C_EOF) {
5663 return MDB_NOTFOUND;
5666 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5668 mp = mc->mc_pg[mc->mc_top];
5670 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5671 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5672 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5673 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
5674 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
5675 if (op != MDB_NEXT || rc != MDB_NOTFOUND) {
5676 if (rc == MDB_SUCCESS)
5677 MDB_GET_KEY(leaf, key);
5682 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5683 if (op == MDB_NEXT_DUP)
5684 return MDB_NOTFOUND;
5688 DPRINTF(("cursor_next: top page is %"Z"u in cursor %p",
5689 mdb_dbg_pgno(mp), (void *) mc));
5690 if (mc->mc_flags & C_DEL)
5693 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
5694 DPUTS("=====> move to next sibling page");
5695 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
5696 mc->mc_flags |= C_EOF;
5699 mp = mc->mc_pg[mc->mc_top];
5700 DPRINTF(("next page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5702 mc->mc_ki[mc->mc_top]++;
5705 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5706 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5709 key->mv_size = mc->mc_db->md_pad;
5710 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5714 mdb_cassert(mc, IS_LEAF(mp));
5715 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5717 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5718 mdb_xcursor_init1(mc, leaf);
5721 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5724 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5725 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5726 if (rc != MDB_SUCCESS)
5731 MDB_GET_KEY(leaf, key);
5735 /** Move the cursor to the previous data item. */
5737 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5743 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5745 mp = mc->mc_pg[mc->mc_top];
5747 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5748 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5749 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5750 if (op == MDB_PREV || op == MDB_PREV_DUP) {
5751 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
5752 if (op != MDB_PREV || rc != MDB_NOTFOUND) {
5753 if (rc == MDB_SUCCESS) {
5754 MDB_GET_KEY(leaf, key);
5755 mc->mc_flags &= ~C_EOF;
5761 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5762 if (op == MDB_PREV_DUP)
5763 return MDB_NOTFOUND;
5767 DPRINTF(("cursor_prev: top page is %"Z"u in cursor %p",
5768 mdb_dbg_pgno(mp), (void *) mc));
5770 if (mc->mc_ki[mc->mc_top] == 0) {
5771 DPUTS("=====> move to prev sibling page");
5772 if ((rc = mdb_cursor_sibling(mc, 0)) != MDB_SUCCESS) {
5775 mp = mc->mc_pg[mc->mc_top];
5776 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
5777 DPRINTF(("prev page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5779 mc->mc_ki[mc->mc_top]--;
5781 mc->mc_flags &= ~C_EOF;
5783 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5784 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5787 key->mv_size = mc->mc_db->md_pad;
5788 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5792 mdb_cassert(mc, IS_LEAF(mp));
5793 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5795 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5796 mdb_xcursor_init1(mc, leaf);
5799 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5802 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5803 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5804 if (rc != MDB_SUCCESS)
5809 MDB_GET_KEY(leaf, key);
5813 /** Set the cursor on a specific data item. */
5815 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5816 MDB_cursor_op op, int *exactp)
5820 MDB_node *leaf = NULL;
5823 if (key->mv_size == 0)
5824 return MDB_BAD_VALSIZE;
5827 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5829 /* See if we're already on the right page */
5830 if (mc->mc_flags & C_INITIALIZED) {
5833 mp = mc->mc_pg[mc->mc_top];
5835 mc->mc_ki[mc->mc_top] = 0;
5836 return MDB_NOTFOUND;
5838 if (mp->mp_flags & P_LEAF2) {
5839 nodekey.mv_size = mc->mc_db->md_pad;
5840 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
5842 leaf = NODEPTR(mp, 0);
5843 MDB_GET_KEY2(leaf, nodekey);
5845 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5847 /* Probably happens rarely, but first node on the page
5848 * was the one we wanted.
5850 mc->mc_ki[mc->mc_top] = 0;
5857 unsigned int nkeys = NUMKEYS(mp);
5859 if (mp->mp_flags & P_LEAF2) {
5860 nodekey.mv_data = LEAF2KEY(mp,
5861 nkeys-1, nodekey.mv_size);
5863 leaf = NODEPTR(mp, nkeys-1);
5864 MDB_GET_KEY2(leaf, nodekey);
5866 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5868 /* last node was the one we wanted */
5869 mc->mc_ki[mc->mc_top] = nkeys-1;
5875 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
5876 /* This is definitely the right page, skip search_page */
5877 if (mp->mp_flags & P_LEAF2) {
5878 nodekey.mv_data = LEAF2KEY(mp,
5879 mc->mc_ki[mc->mc_top], nodekey.mv_size);
5881 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5882 MDB_GET_KEY2(leaf, nodekey);
5884 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5886 /* current node was the one we wanted */
5896 /* If any parents have right-sibs, search.
5897 * Otherwise, there's nothing further.
5899 for (i=0; i<mc->mc_top; i++)
5901 NUMKEYS(mc->mc_pg[i])-1)
5903 if (i == mc->mc_top) {
5904 /* There are no other pages */
5905 mc->mc_ki[mc->mc_top] = nkeys;
5906 return MDB_NOTFOUND;
5910 /* There are no other pages */
5911 mc->mc_ki[mc->mc_top] = 0;
5912 if (op == MDB_SET_RANGE && !exactp) {
5916 return MDB_NOTFOUND;
5920 rc = mdb_page_search(mc, key, 0);
5921 if (rc != MDB_SUCCESS)
5924 mp = mc->mc_pg[mc->mc_top];
5925 mdb_cassert(mc, IS_LEAF(mp));
5928 leaf = mdb_node_search(mc, key, exactp);
5929 if (exactp != NULL && !*exactp) {
5930 /* MDB_SET specified and not an exact match. */
5931 return MDB_NOTFOUND;
5935 DPUTS("===> inexact leaf not found, goto sibling");
5936 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
5937 return rc; /* no entries matched */
5938 mp = mc->mc_pg[mc->mc_top];
5939 mdb_cassert(mc, IS_LEAF(mp));
5940 leaf = NODEPTR(mp, 0);
5944 mc->mc_flags |= C_INITIALIZED;
5945 mc->mc_flags &= ~C_EOF;
5948 if (op == MDB_SET_RANGE || op == MDB_SET_KEY) {
5949 key->mv_size = mc->mc_db->md_pad;
5950 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5955 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5956 mdb_xcursor_init1(mc, leaf);
5959 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5960 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
5961 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5964 if (op == MDB_GET_BOTH) {
5970 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
5971 if (rc != MDB_SUCCESS)
5974 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
5977 if ((rc = mdb_node_read(mc->mc_txn, leaf, &olddata)) != MDB_SUCCESS)
5979 dcmp = mc->mc_dbx->md_dcmp;
5980 #if UINT_MAX < SIZE_MAX
5981 if (dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
5982 dcmp = mdb_cmp_clong;
5984 rc = dcmp(data, &olddata);
5986 if (op == MDB_GET_BOTH || rc > 0)
5987 return MDB_NOTFOUND;
5994 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5995 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
6000 /* The key already matches in all other cases */
6001 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
6002 MDB_GET_KEY(leaf, key);
6003 DPRINTF(("==> cursor placed on key [%s]", DKEY(key)));
6008 /** Move the cursor to the first item in the database. */
6010 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
6016 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
6018 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
6019 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
6020 if (rc != MDB_SUCCESS)
6023 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
6025 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
6026 mc->mc_flags |= C_INITIALIZED;
6027 mc->mc_flags &= ~C_EOF;
6029 mc->mc_ki[mc->mc_top] = 0;
6031 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6032 key->mv_size = mc->mc_db->md_pad;
6033 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
6038 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6039 mdb_xcursor_init1(mc, leaf);
6040 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
6044 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
6048 MDB_GET_KEY(leaf, key);
6052 /** Move the cursor to the last item in the database. */
6054 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
6060 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
6062 if (!(mc->mc_flags & C_EOF)) {
6064 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
6065 rc = mdb_page_search(mc, NULL, MDB_PS_LAST);
6066 if (rc != MDB_SUCCESS)
6069 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
6072 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
6073 mc->mc_flags |= C_INITIALIZED|C_EOF;
6074 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6076 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6077 key->mv_size = mc->mc_db->md_pad;
6078 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
6083 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6084 mdb_xcursor_init1(mc, leaf);
6085 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
6089 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
6094 MDB_GET_KEY(leaf, key);
6099 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
6104 int (*mfunc)(MDB_cursor *mc, MDB_val *key, MDB_val *data);
6109 if (mc->mc_txn->mt_flags & MDB_TXN_ERROR)
6113 case MDB_GET_CURRENT:
6114 if (!(mc->mc_flags & C_INITIALIZED)) {
6117 MDB_page *mp = mc->mc_pg[mc->mc_top];
6118 int nkeys = NUMKEYS(mp);
6119 if (!nkeys || mc->mc_ki[mc->mc_top] >= nkeys) {
6120 mc->mc_ki[mc->mc_top] = nkeys;
6126 key->mv_size = mc->mc_db->md_pad;
6127 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
6129 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6130 MDB_GET_KEY(leaf, key);
6132 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6133 if (mc->mc_flags & C_DEL)
6134 mdb_xcursor_init1(mc, leaf);
6135 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
6137 rc = mdb_node_read(mc->mc_txn, leaf, data);
6144 case MDB_GET_BOTH_RANGE:
6149 if (mc->mc_xcursor == NULL) {
6150 rc = MDB_INCOMPATIBLE;
6160 rc = mdb_cursor_set(mc, key, data, op,
6161 op == MDB_SET_RANGE ? NULL : &exact);
6164 case MDB_GET_MULTIPLE:
6165 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
6169 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6170 rc = MDB_INCOMPATIBLE;
6174 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
6175 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
6178 case MDB_NEXT_MULTIPLE:
6183 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6184 rc = MDB_INCOMPATIBLE;
6187 if (!(mc->mc_flags & C_INITIALIZED))
6188 rc = mdb_cursor_first(mc, key, data);
6190 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
6191 if (rc == MDB_SUCCESS) {
6192 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
6195 mx = &mc->mc_xcursor->mx_cursor;
6196 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
6198 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
6199 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
6207 case MDB_NEXT_NODUP:
6208 if (!(mc->mc_flags & C_INITIALIZED))
6209 rc = mdb_cursor_first(mc, key, data);
6211 rc = mdb_cursor_next(mc, key, data, op);
6215 case MDB_PREV_NODUP:
6216 if (!(mc->mc_flags & C_INITIALIZED)) {
6217 rc = mdb_cursor_last(mc, key, data);
6220 mc->mc_flags |= C_INITIALIZED;
6221 mc->mc_ki[mc->mc_top]++;
6223 rc = mdb_cursor_prev(mc, key, data, op);
6226 rc = mdb_cursor_first(mc, key, data);
6229 mfunc = mdb_cursor_first;
6231 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
6235 if (mc->mc_xcursor == NULL) {
6236 rc = MDB_INCOMPATIBLE;
6240 MDB_node *leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6241 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6242 MDB_GET_KEY(leaf, key);
6243 rc = mdb_node_read(mc->mc_txn, leaf, data);
6247 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
6251 rc = mfunc(&mc->mc_xcursor->mx_cursor, data, NULL);
6254 rc = mdb_cursor_last(mc, key, data);
6257 mfunc = mdb_cursor_last;
6260 DPRINTF(("unhandled/unimplemented cursor operation %u", op));
6265 if (mc->mc_flags & C_DEL)
6266 mc->mc_flags ^= C_DEL;
6271 /** Touch all the pages in the cursor stack. Set mc_top.
6272 * Makes sure all the pages are writable, before attempting a write operation.
6273 * @param[in] mc The cursor to operate on.
6276 mdb_cursor_touch(MDB_cursor *mc)
6278 int rc = MDB_SUCCESS;
6280 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
6283 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
6285 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, &mcx);
6286 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
6289 *mc->mc_dbflag |= DB_DIRTY;
6294 rc = mdb_page_touch(mc);
6295 } while (!rc && ++(mc->mc_top) < mc->mc_snum);
6296 mc->mc_top = mc->mc_snum-1;
6301 /** Do not spill pages to disk if txn is getting full, may fail instead */
6302 #define MDB_NOSPILL 0x8000
6305 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
6309 MDB_node *leaf = NULL;
6312 MDB_val xdata, *rdata, dkey, olddata;
6314 int do_sub = 0, insert_key, insert_data;
6315 unsigned int mcount = 0, dcount = 0, nospill;
6318 unsigned int nflags;
6321 if (mc == NULL || key == NULL)
6324 env = mc->mc_txn->mt_env;
6326 /* Check this first so counter will always be zero on any
6329 if (flags & MDB_MULTIPLE) {
6330 dcount = data[1].mv_size;
6331 data[1].mv_size = 0;
6332 if (!F_ISSET(mc->mc_db->md_flags, MDB_DUPFIXED))
6333 return MDB_INCOMPATIBLE;
6336 nospill = flags & MDB_NOSPILL;
6337 flags &= ~MDB_NOSPILL;
6339 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
6340 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6342 if (key->mv_size-1 >= ENV_MAXKEY(env))
6343 return MDB_BAD_VALSIZE;
6345 #if SIZE_MAX > MAXDATASIZE
6346 if (data->mv_size > ((mc->mc_db->md_flags & MDB_DUPSORT) ? ENV_MAXKEY(env) : MAXDATASIZE))
6347 return MDB_BAD_VALSIZE;
6349 if ((mc->mc_db->md_flags & MDB_DUPSORT) && data->mv_size > ENV_MAXKEY(env))
6350 return MDB_BAD_VALSIZE;
6353 DPRINTF(("==> put db %d key [%s], size %"Z"u, data size %"Z"u",
6354 DDBI(mc), DKEY(key), key ? key->mv_size : 0, data->mv_size));
6358 if (flags == MDB_CURRENT) {
6359 if (!(mc->mc_flags & C_INITIALIZED))
6362 } else if (mc->mc_db->md_root == P_INVALID) {
6363 /* new database, cursor has nothing to point to */
6366 mc->mc_flags &= ~C_INITIALIZED;
6371 if (flags & MDB_APPEND) {
6373 rc = mdb_cursor_last(mc, &k2, &d2);
6375 rc = mc->mc_dbx->md_cmp(key, &k2);
6378 mc->mc_ki[mc->mc_top]++;
6380 /* new key is <= last key */
6385 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
6387 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
6388 DPRINTF(("duplicate key [%s]", DKEY(key)));
6390 return MDB_KEYEXIST;
6392 if (rc && rc != MDB_NOTFOUND)
6396 if (mc->mc_flags & C_DEL)
6397 mc->mc_flags ^= C_DEL;
6399 /* Cursor is positioned, check for room in the dirty list */
6401 if (flags & MDB_MULTIPLE) {
6403 xdata.mv_size = data->mv_size * dcount;
6407 if ((rc2 = mdb_page_spill(mc, key, rdata)))
6411 if (rc == MDB_NO_ROOT) {
6413 /* new database, write a root leaf page */
6414 DPUTS("allocating new root leaf page");
6415 if ((rc2 = mdb_page_new(mc, P_LEAF, 1, &np))) {
6418 mdb_cursor_push(mc, np);
6419 mc->mc_db->md_root = np->mp_pgno;
6420 mc->mc_db->md_depth++;
6421 *mc->mc_dbflag |= DB_DIRTY;
6422 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
6424 np->mp_flags |= P_LEAF2;
6425 mc->mc_flags |= C_INITIALIZED;
6427 /* make sure all cursor pages are writable */
6428 rc2 = mdb_cursor_touch(mc);
6433 insert_key = insert_data = rc;
6435 /* The key does not exist */
6436 DPRINTF(("inserting key at index %i", mc->mc_ki[mc->mc_top]));
6437 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
6438 LEAFSIZE(key, data) > env->me_nodemax)
6440 /* Too big for a node, insert in sub-DB. Set up an empty
6441 * "old sub-page" for prep_subDB to expand to a full page.
6443 fp_flags = P_LEAF|P_DIRTY;
6445 fp->mp_pad = data->mv_size; /* used if MDB_DUPFIXED */
6446 fp->mp_lower = fp->mp_upper = (PAGEHDRSZ-PAGEBASE);
6447 olddata.mv_size = PAGEHDRSZ;
6451 /* there's only a key anyway, so this is a no-op */
6452 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6454 unsigned int ksize = mc->mc_db->md_pad;
6455 if (key->mv_size != ksize)
6456 return MDB_BAD_VALSIZE;
6457 ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
6458 memcpy(ptr, key->mv_data, ksize);
6460 /* if overwriting slot 0 of leaf, need to
6461 * update branch key if there is a parent page
6463 if (mc->mc_top && !mc->mc_ki[mc->mc_top]) {
6464 unsigned short top = mc->mc_top;
6466 /* slot 0 is always an empty key, find real slot */
6467 while (mc->mc_top && !mc->mc_ki[mc->mc_top])
6469 if (mc->mc_ki[mc->mc_top])
6470 rc2 = mdb_update_key(mc, key);
6481 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6482 olddata.mv_size = NODEDSZ(leaf);
6483 olddata.mv_data = NODEDATA(leaf);
6486 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
6487 /* Prepare (sub-)page/sub-DB to accept the new item,
6488 * if needed. fp: old sub-page or a header faking
6489 * it. mp: new (sub-)page. offset: growth in page
6490 * size. xdata: node data with new page or DB.
6492 unsigned i, offset = 0;
6493 mp = fp = xdata.mv_data = env->me_pbuf;
6494 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
6496 /* Was a single item before, must convert now */
6497 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6499 /* Just overwrite the current item */
6500 if (flags == MDB_CURRENT)
6502 dcmp = mc->mc_dbx->md_dcmp;
6503 #if UINT_MAX < SIZE_MAX
6504 if (dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
6505 dcmp = mdb_cmp_clong;
6507 /* does data match? */
6508 if (!dcmp(data, &olddata)) {
6509 if (flags & MDB_NODUPDATA)
6510 return MDB_KEYEXIST;
6515 /* Back up original data item */
6516 dkey.mv_size = olddata.mv_size;
6517 dkey.mv_data = memcpy(fp+1, olddata.mv_data, olddata.mv_size);
6519 /* Make sub-page header for the dup items, with dummy body */
6520 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
6521 fp->mp_lower = (PAGEHDRSZ-PAGEBASE);
6522 xdata.mv_size = PAGEHDRSZ + dkey.mv_size + data->mv_size;
6523 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6524 fp->mp_flags |= P_LEAF2;
6525 fp->mp_pad = data->mv_size;
6526 xdata.mv_size += 2 * data->mv_size; /* leave space for 2 more */
6528 xdata.mv_size += 2 * (sizeof(indx_t) + NODESIZE) +
6529 (dkey.mv_size & 1) + (data->mv_size & 1);
6531 fp->mp_upper = xdata.mv_size - PAGEBASE;
6532 olddata.mv_size = xdata.mv_size; /* pretend olddata is fp */
6533 } else if (leaf->mn_flags & F_SUBDATA) {
6534 /* Data is on sub-DB, just store it */
6535 flags |= F_DUPDATA|F_SUBDATA;
6538 /* Data is on sub-page */
6539 fp = olddata.mv_data;
6542 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6543 offset = EVEN(NODESIZE + sizeof(indx_t) +
6547 offset = fp->mp_pad;
6548 if (SIZELEFT(fp) < offset) {
6549 offset *= 4; /* space for 4 more */
6552 /* FALLTHRU: Big enough MDB_DUPFIXED sub-page */
6554 fp->mp_flags |= P_DIRTY;
6555 COPY_PGNO(fp->mp_pgno, mp->mp_pgno);
6556 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
6560 xdata.mv_size = olddata.mv_size + offset;
6563 fp_flags = fp->mp_flags;
6564 if (NODESIZE + NODEKSZ(leaf) + xdata.mv_size > env->me_nodemax) {
6565 /* Too big for a sub-page, convert to sub-DB */
6566 fp_flags &= ~P_SUBP;
6568 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6569 fp_flags |= P_LEAF2;
6570 dummy.md_pad = fp->mp_pad;
6571 dummy.md_flags = MDB_DUPFIXED;
6572 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
6573 dummy.md_flags |= MDB_INTEGERKEY;
6579 dummy.md_branch_pages = 0;
6580 dummy.md_leaf_pages = 1;
6581 dummy.md_overflow_pages = 0;
6582 dummy.md_entries = NUMKEYS(fp);
6583 xdata.mv_size = sizeof(MDB_db);
6584 xdata.mv_data = &dummy;
6585 if ((rc = mdb_page_alloc(mc, 1, &mp)))
6587 offset = env->me_psize - olddata.mv_size;
6588 flags |= F_DUPDATA|F_SUBDATA;
6589 dummy.md_root = mp->mp_pgno;
6592 mp->mp_flags = fp_flags | P_DIRTY;
6593 mp->mp_pad = fp->mp_pad;
6594 mp->mp_lower = fp->mp_lower;
6595 mp->mp_upper = fp->mp_upper + offset;
6596 if (fp_flags & P_LEAF2) {
6597 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
6599 memcpy((char *)mp + mp->mp_upper + PAGEBASE, (char *)fp + fp->mp_upper + PAGEBASE,
6600 olddata.mv_size - fp->mp_upper - PAGEBASE);
6601 for (i=0; i<NUMKEYS(fp); i++)
6602 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
6610 mdb_node_del(mc, 0);
6614 /* overflow page overwrites need special handling */
6615 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6618 int level, ovpages, dpages = OVPAGES(data->mv_size, env->me_psize);
6620 memcpy(&pg, olddata.mv_data, sizeof(pg));
6621 if ((rc2 = mdb_page_get(mc->mc_txn, pg, &omp, &level)) != 0)
6623 ovpages = omp->mp_pages;
6625 /* Is the ov page large enough? */
6626 if (ovpages >= dpages) {
6627 if (!(omp->mp_flags & P_DIRTY) &&
6628 (level || (env->me_flags & MDB_WRITEMAP)))
6630 rc = mdb_page_unspill(mc->mc_txn, omp, &omp);
6633 level = 0; /* dirty in this txn or clean */
6636 if (omp->mp_flags & P_DIRTY) {
6637 /* yes, overwrite it. Note in this case we don't
6638 * bother to try shrinking the page if the new data
6639 * is smaller than the overflow threshold.
6642 /* It is writable only in a parent txn */
6643 size_t sz = (size_t) env->me_psize * ovpages, off;
6644 MDB_page *np = mdb_page_malloc(mc->mc_txn, ovpages);
6650 rc2 = mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &id2);
6651 mdb_cassert(mc, rc2 == 0);
6652 if (!(flags & MDB_RESERVE)) {
6653 /* Copy end of page, adjusting alignment so
6654 * compiler may copy words instead of bytes.
6656 off = (PAGEHDRSZ + data->mv_size) & -sizeof(size_t);
6657 memcpy((size_t *)((char *)np + off),
6658 (size_t *)((char *)omp + off), sz - off);
6661 memcpy(np, omp, sz); /* Copy beginning of page */
6664 SETDSZ(leaf, data->mv_size);
6665 if (F_ISSET(flags, MDB_RESERVE))
6666 data->mv_data = METADATA(omp);
6668 memcpy(METADATA(omp), data->mv_data, data->mv_size);
6672 if ((rc2 = mdb_ovpage_free(mc, omp)) != MDB_SUCCESS)
6674 } else if (data->mv_size == olddata.mv_size) {
6675 /* same size, just replace it. Note that we could
6676 * also reuse this node if the new data is smaller,
6677 * but instead we opt to shrink the node in that case.
6679 if (F_ISSET(flags, MDB_RESERVE))
6680 data->mv_data = olddata.mv_data;
6681 else if (!(mc->mc_flags & C_SUB))
6682 memcpy(olddata.mv_data, data->mv_data, data->mv_size);
6684 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
6689 mdb_node_del(mc, 0);
6695 nflags = flags & NODE_ADD_FLAGS;
6696 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(env, key, rdata);
6697 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
6698 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
6699 nflags &= ~MDB_APPEND; /* sub-page may need room to grow */
6701 nflags |= MDB_SPLIT_REPLACE;
6702 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
6704 /* There is room already in this leaf page. */
6705 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
6706 if (rc == 0 && insert_key) {
6707 /* Adjust other cursors pointing to mp */
6708 MDB_cursor *m2, *m3;
6709 MDB_dbi dbi = mc->mc_dbi;
6710 unsigned i = mc->mc_top;
6711 MDB_page *mp = mc->mc_pg[i];
6713 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6714 if (mc->mc_flags & C_SUB)
6715 m3 = &m2->mc_xcursor->mx_cursor;
6718 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
6719 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
6726 if (rc == MDB_SUCCESS) {
6727 /* Now store the actual data in the child DB. Note that we're
6728 * storing the user data in the keys field, so there are strict
6729 * size limits on dupdata. The actual data fields of the child
6730 * DB are all zero size.
6738 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6739 if (flags & MDB_CURRENT) {
6740 xflags = MDB_CURRENT|MDB_NOSPILL;
6742 mdb_xcursor_init1(mc, leaf);
6743 xflags = (flags & MDB_NODUPDATA) ?
6744 MDB_NOOVERWRITE|MDB_NOSPILL : MDB_NOSPILL;
6746 /* converted, write the original data first */
6748 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
6752 /* Adjust other cursors pointing to mp */
6754 unsigned i = mc->mc_top;
6755 MDB_page *mp = mc->mc_pg[i];
6757 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6758 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6759 if (!(m2->mc_flags & C_INITIALIZED)) continue;
6760 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
6761 mdb_xcursor_init1(m2, leaf);
6765 /* we've done our job */
6768 ecount = mc->mc_xcursor->mx_db.md_entries;
6769 if (flags & MDB_APPENDDUP)
6770 xflags |= MDB_APPEND;
6771 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
6772 if (flags & F_SUBDATA) {
6773 void *db = NODEDATA(leaf);
6774 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6776 insert_data = mc->mc_xcursor->mx_db.md_entries - ecount;
6778 /* Increment count unless we just replaced an existing item. */
6780 mc->mc_db->md_entries++;
6782 /* Invalidate txn if we created an empty sub-DB */
6785 /* If we succeeded and the key didn't exist before,
6786 * make sure the cursor is marked valid.
6788 mc->mc_flags |= C_INITIALIZED;
6790 if (flags & MDB_MULTIPLE) {
6793 /* let caller know how many succeeded, if any */
6794 data[1].mv_size = mcount;
6795 if (mcount < dcount) {
6796 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
6797 insert_key = insert_data = 0;
6804 if (rc == MDB_KEYEXIST) /* should not happen, we deleted that item */
6807 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6812 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
6818 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
6819 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6821 if (!(mc->mc_flags & C_INITIALIZED))
6824 if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6825 return MDB_NOTFOUND;
6827 if (!(flags & MDB_NOSPILL) && (rc = mdb_page_spill(mc, NULL, NULL)))
6830 rc = mdb_cursor_touch(mc);
6834 mp = mc->mc_pg[mc->mc_top];
6837 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6839 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6840 if (flags & MDB_NODUPDATA) {
6841 /* mdb_cursor_del0() will subtract the final entry */
6842 mc->mc_db->md_entries -= mc->mc_xcursor->mx_db.md_entries - 1;
6844 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
6845 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6847 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, MDB_NOSPILL);
6850 /* If sub-DB still has entries, we're done */
6851 if (mc->mc_xcursor->mx_db.md_entries) {
6852 if (leaf->mn_flags & F_SUBDATA) {
6853 /* update subDB info */
6854 void *db = NODEDATA(leaf);
6855 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6858 /* shrink fake page */
6859 mdb_node_shrink(mp, mc->mc_ki[mc->mc_top]);
6860 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6861 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6862 /* fix other sub-DB cursors pointed at this fake page */
6863 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6864 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6865 if (m2->mc_pg[mc->mc_top] == mp &&
6866 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
6867 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6870 mc->mc_db->md_entries--;
6871 mc->mc_flags |= C_DEL;
6874 /* otherwise fall thru and delete the sub-DB */
6877 if (leaf->mn_flags & F_SUBDATA) {
6878 /* add all the child DB's pages to the free list */
6879 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
6885 /* add overflow pages to free list */
6886 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6890 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6891 if ((rc = mdb_page_get(mc->mc_txn, pg, &omp, NULL)) ||
6892 (rc = mdb_ovpage_free(mc, omp)))
6897 return mdb_cursor_del0(mc);
6900 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6904 /** Allocate and initialize new pages for a database.
6905 * @param[in] mc a cursor on the database being added to.
6906 * @param[in] flags flags defining what type of page is being allocated.
6907 * @param[in] num the number of pages to allocate. This is usually 1,
6908 * unless allocating overflow pages for a large record.
6909 * @param[out] mp Address of a page, or NULL on failure.
6910 * @return 0 on success, non-zero on failure.
6913 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
6918 if ((rc = mdb_page_alloc(mc, num, &np)))
6920 DPRINTF(("allocated new mpage %"Z"u, page size %u",
6921 np->mp_pgno, mc->mc_txn->mt_env->me_psize));
6922 np->mp_flags = flags | P_DIRTY;
6923 np->mp_lower = (PAGEHDRSZ-PAGEBASE);
6924 np->mp_upper = mc->mc_txn->mt_env->me_psize - PAGEBASE;
6927 mc->mc_db->md_branch_pages++;
6928 else if (IS_LEAF(np))
6929 mc->mc_db->md_leaf_pages++;
6930 else if (IS_OVERFLOW(np)) {
6931 mc->mc_db->md_overflow_pages += num;
6939 /** Calculate the size of a leaf node.
6940 * The size depends on the environment's page size; if a data item
6941 * is too large it will be put onto an overflow page and the node
6942 * size will only include the key and not the data. Sizes are always
6943 * rounded up to an even number of bytes, to guarantee 2-byte alignment
6944 * of the #MDB_node headers.
6945 * @param[in] env The environment handle.
6946 * @param[in] key The key for the node.
6947 * @param[in] data The data for the node.
6948 * @return The number of bytes needed to store the node.
6951 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
6955 sz = LEAFSIZE(key, data);
6956 if (sz > env->me_nodemax) {
6957 /* put on overflow page */
6958 sz -= data->mv_size - sizeof(pgno_t);
6961 return EVEN(sz + sizeof(indx_t));
6964 /** Calculate the size of a branch node.
6965 * The size should depend on the environment's page size but since
6966 * we currently don't support spilling large keys onto overflow
6967 * pages, it's simply the size of the #MDB_node header plus the
6968 * size of the key. Sizes are always rounded up to an even number
6969 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
6970 * @param[in] env The environment handle.
6971 * @param[in] key The key for the node.
6972 * @return The number of bytes needed to store the node.
6975 mdb_branch_size(MDB_env *env, MDB_val *key)
6980 if (sz > env->me_nodemax) {
6981 /* put on overflow page */
6982 /* not implemented */
6983 /* sz -= key->size - sizeof(pgno_t); */
6986 return sz + sizeof(indx_t);
6989 /** Add a node to the page pointed to by the cursor.
6990 * @param[in] mc The cursor for this operation.
6991 * @param[in] indx The index on the page where the new node should be added.
6992 * @param[in] key The key for the new node.
6993 * @param[in] data The data for the new node, if any.
6994 * @param[in] pgno The page number, if adding a branch node.
6995 * @param[in] flags Flags for the node.
6996 * @return 0 on success, non-zero on failure. Possible errors are:
6998 * <li>ENOMEM - failed to allocate overflow pages for the node.
6999 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
7000 * should never happen since all callers already calculate the
7001 * page's free space before calling this function.
7005 mdb_node_add(MDB_cursor *mc, indx_t indx,
7006 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
7009 size_t node_size = NODESIZE;
7013 MDB_page *mp = mc->mc_pg[mc->mc_top];
7014 MDB_page *ofp = NULL; /* overflow page */
7017 mdb_cassert(mc, mp->mp_upper >= mp->mp_lower);
7019 DPRINTF(("add to %s %spage %"Z"u index %i, data size %"Z"u key size %"Z"u [%s]",
7020 IS_LEAF(mp) ? "leaf" : "branch",
7021 IS_SUBP(mp) ? "sub-" : "",
7022 mdb_dbg_pgno(mp), indx, data ? data->mv_size : 0,
7023 key ? key->mv_size : 0, key ? DKEY(key) : "null"));
7026 /* Move higher keys up one slot. */
7027 int ksize = mc->mc_db->md_pad, dif;
7028 char *ptr = LEAF2KEY(mp, indx, ksize);
7029 dif = NUMKEYS(mp) - indx;
7031 memmove(ptr+ksize, ptr, dif*ksize);
7032 /* insert new key */
7033 memcpy(ptr, key->mv_data, ksize);
7035 /* Just using these for counting */
7036 mp->mp_lower += sizeof(indx_t);
7037 mp->mp_upper -= ksize - sizeof(indx_t);
7041 room = (ssize_t)SIZELEFT(mp) - (ssize_t)sizeof(indx_t);
7043 node_size += key->mv_size;
7045 mdb_cassert(mc, data);
7046 if (F_ISSET(flags, F_BIGDATA)) {
7047 /* Data already on overflow page. */
7048 node_size += sizeof(pgno_t);
7049 } else if (node_size + data->mv_size > mc->mc_txn->mt_env->me_nodemax) {
7050 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
7052 /* Put data on overflow page. */
7053 DPRINTF(("data size is %"Z"u, node would be %"Z"u, put data on overflow page",
7054 data->mv_size, node_size+data->mv_size));
7055 node_size = EVEN(node_size + sizeof(pgno_t));
7056 if ((ssize_t)node_size > room)
7058 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
7060 DPRINTF(("allocated overflow page %"Z"u", ofp->mp_pgno));
7064 node_size += data->mv_size;
7067 node_size = EVEN(node_size);
7068 if ((ssize_t)node_size > room)
7072 /* Move higher pointers up one slot. */
7073 for (i = NUMKEYS(mp); i > indx; i--)
7074 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
7076 /* Adjust free space offsets. */
7077 ofs = mp->mp_upper - node_size;
7078 mdb_cassert(mc, ofs >= mp->mp_lower + sizeof(indx_t));
7079 mp->mp_ptrs[indx] = ofs;
7081 mp->mp_lower += sizeof(indx_t);
7083 /* Write the node data. */
7084 node = NODEPTR(mp, indx);
7085 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
7086 node->mn_flags = flags;
7088 SETDSZ(node,data->mv_size);
7093 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
7096 mdb_cassert(mc, key);
7098 if (F_ISSET(flags, F_BIGDATA))
7099 memcpy(node->mn_data + key->mv_size, data->mv_data,
7101 else if (F_ISSET(flags, MDB_RESERVE))
7102 data->mv_data = node->mn_data + key->mv_size;
7104 memcpy(node->mn_data + key->mv_size, data->mv_data,
7107 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
7109 if (F_ISSET(flags, MDB_RESERVE))
7110 data->mv_data = METADATA(ofp);
7112 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
7119 DPRINTF(("not enough room in page %"Z"u, got %u ptrs",
7120 mdb_dbg_pgno(mp), NUMKEYS(mp)));
7121 DPRINTF(("upper-lower = %u - %u = %"Z"d", mp->mp_upper,mp->mp_lower,room));
7122 DPRINTF(("node size = %"Z"u", node_size));
7123 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
7124 return MDB_PAGE_FULL;
7127 /** Delete the specified node from a page.
7128 * @param[in] mc Cursor pointing to the node to delete.
7129 * @param[in] ksize The size of a node. Only used if the page is
7130 * part of a #MDB_DUPFIXED database.
7133 mdb_node_del(MDB_cursor *mc, int ksize)
7135 MDB_page *mp = mc->mc_pg[mc->mc_top];
7136 indx_t indx = mc->mc_ki[mc->mc_top];
7138 indx_t i, j, numkeys, ptr;
7142 DPRINTF(("delete node %u on %s page %"Z"u", indx,
7143 IS_LEAF(mp) ? "leaf" : "branch", mdb_dbg_pgno(mp)));
7144 numkeys = NUMKEYS(mp);
7145 mdb_cassert(mc, indx < numkeys);
7148 int x = numkeys - 1 - indx;
7149 base = LEAF2KEY(mp, indx, ksize);
7151 memmove(base, base + ksize, x * ksize);
7152 mp->mp_lower -= sizeof(indx_t);
7153 mp->mp_upper += ksize - sizeof(indx_t);
7157 node = NODEPTR(mp, indx);
7158 sz = NODESIZE + node->mn_ksize;
7160 if (F_ISSET(node->mn_flags, F_BIGDATA))
7161 sz += sizeof(pgno_t);
7163 sz += NODEDSZ(node);
7167 ptr = mp->mp_ptrs[indx];
7168 for (i = j = 0; i < numkeys; i++) {
7170 mp->mp_ptrs[j] = mp->mp_ptrs[i];
7171 if (mp->mp_ptrs[i] < ptr)
7172 mp->mp_ptrs[j] += sz;
7177 base = (char *)mp + mp->mp_upper + PAGEBASE;
7178 memmove(base + sz, base, ptr - mp->mp_upper);
7180 mp->mp_lower -= sizeof(indx_t);
7184 /** Compact the main page after deleting a node on a subpage.
7185 * @param[in] mp The main page to operate on.
7186 * @param[in] indx The index of the subpage on the main page.
7189 mdb_node_shrink(MDB_page *mp, indx_t indx)
7195 indx_t i, numkeys, ptr;
7197 node = NODEPTR(mp, indx);
7198 sp = (MDB_page *)NODEDATA(node);
7199 delta = SIZELEFT(sp);
7200 xp = (MDB_page *)((char *)sp + delta);
7202 /* shift subpage upward */
7204 nsize = NUMKEYS(sp) * sp->mp_pad;
7206 return; /* do not make the node uneven-sized */
7207 memmove(METADATA(xp), METADATA(sp), nsize);
7210 numkeys = NUMKEYS(sp);
7211 for (i=numkeys-1; i>=0; i--)
7212 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
7214 xp->mp_upper = sp->mp_lower;
7215 xp->mp_lower = sp->mp_lower;
7216 xp->mp_flags = sp->mp_flags;
7217 xp->mp_pad = sp->mp_pad;
7218 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
7220 nsize = NODEDSZ(node) - delta;
7221 SETDSZ(node, nsize);
7223 /* shift lower nodes upward */
7224 ptr = mp->mp_ptrs[indx];
7225 numkeys = NUMKEYS(mp);
7226 for (i = 0; i < numkeys; i++) {
7227 if (mp->mp_ptrs[i] <= ptr)
7228 mp->mp_ptrs[i] += delta;
7231 base = (char *)mp + mp->mp_upper + PAGEBASE;
7232 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
7233 mp->mp_upper += delta;
7236 /** Initial setup of a sorted-dups cursor.
7237 * Sorted duplicates are implemented as a sub-database for the given key.
7238 * The duplicate data items are actually keys of the sub-database.
7239 * Operations on the duplicate data items are performed using a sub-cursor
7240 * initialized when the sub-database is first accessed. This function does
7241 * the preliminary setup of the sub-cursor, filling in the fields that
7242 * depend only on the parent DB.
7243 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
7246 mdb_xcursor_init0(MDB_cursor *mc)
7248 MDB_xcursor *mx = mc->mc_xcursor;
7250 mx->mx_cursor.mc_xcursor = NULL;
7251 mx->mx_cursor.mc_txn = mc->mc_txn;
7252 mx->mx_cursor.mc_db = &mx->mx_db;
7253 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
7254 mx->mx_cursor.mc_dbi = mc->mc_dbi;
7255 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
7256 mx->mx_cursor.mc_snum = 0;
7257 mx->mx_cursor.mc_top = 0;
7258 mx->mx_cursor.mc_flags = C_SUB;
7259 mx->mx_dbx.md_name.mv_size = 0;
7260 mx->mx_dbx.md_name.mv_data = NULL;
7261 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
7262 mx->mx_dbx.md_dcmp = NULL;
7263 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
7266 /** Final setup of a sorted-dups cursor.
7267 * Sets up the fields that depend on the data from the main cursor.
7268 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
7269 * @param[in] node The data containing the #MDB_db record for the
7270 * sorted-dup database.
7273 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
7275 MDB_xcursor *mx = mc->mc_xcursor;
7277 if (node->mn_flags & F_SUBDATA) {
7278 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
7279 mx->mx_cursor.mc_pg[0] = 0;
7280 mx->mx_cursor.mc_snum = 0;
7281 mx->mx_cursor.mc_top = 0;
7282 mx->mx_cursor.mc_flags = C_SUB;
7284 MDB_page *fp = NODEDATA(node);
7285 mx->mx_db.md_pad = 0;
7286 mx->mx_db.md_flags = 0;
7287 mx->mx_db.md_depth = 1;
7288 mx->mx_db.md_branch_pages = 0;
7289 mx->mx_db.md_leaf_pages = 1;
7290 mx->mx_db.md_overflow_pages = 0;
7291 mx->mx_db.md_entries = NUMKEYS(fp);
7292 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
7293 mx->mx_cursor.mc_snum = 1;
7294 mx->mx_cursor.mc_top = 0;
7295 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
7296 mx->mx_cursor.mc_pg[0] = fp;
7297 mx->mx_cursor.mc_ki[0] = 0;
7298 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
7299 mx->mx_db.md_flags = MDB_DUPFIXED;
7300 mx->mx_db.md_pad = fp->mp_pad;
7301 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
7302 mx->mx_db.md_flags |= MDB_INTEGERKEY;
7305 DPRINTF(("Sub-db -%u root page %"Z"u", mx->mx_cursor.mc_dbi,
7306 mx->mx_db.md_root));
7307 mx->mx_dbflag = DB_VALID|DB_DIRTY; /* DB_DIRTY guides mdb_cursor_touch */
7308 #if UINT_MAX < SIZE_MAX
7309 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
7310 mx->mx_dbx.md_cmp = mdb_cmp_clong;
7314 /** Initialize a cursor for a given transaction and database. */
7316 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
7319 mc->mc_backup = NULL;
7322 mc->mc_db = &txn->mt_dbs[dbi];
7323 mc->mc_dbx = &txn->mt_dbxs[dbi];
7324 mc->mc_dbflag = &txn->mt_dbflags[dbi];
7330 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
7331 mdb_tassert(txn, mx != NULL);
7332 mc->mc_xcursor = mx;
7333 mdb_xcursor_init0(mc);
7335 mc->mc_xcursor = NULL;
7337 if (*mc->mc_dbflag & DB_STALE) {
7338 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
7343 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
7346 size_t size = sizeof(MDB_cursor);
7348 if (!ret || !TXN_DBI_EXIST(txn, dbi))
7351 if (txn->mt_flags & MDB_TXN_ERROR)
7354 /* Allow read access to the freelist */
7355 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
7358 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
7359 size += sizeof(MDB_xcursor);
7361 if ((mc = malloc(size)) != NULL) {
7362 mdb_cursor_init(mc, txn, dbi, (MDB_xcursor *)(mc + 1));
7363 if (txn->mt_cursors) {
7364 mc->mc_next = txn->mt_cursors[dbi];
7365 txn->mt_cursors[dbi] = mc;
7366 mc->mc_flags |= C_UNTRACK;
7378 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
7380 if (!mc || !TXN_DBI_EXIST(txn, mc->mc_dbi))
7383 if ((mc->mc_flags & C_UNTRACK) || txn->mt_cursors)
7386 if (txn->mt_flags & MDB_TXN_ERROR)
7389 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
7393 /* Return the count of duplicate data items for the current key */
7395 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
7399 if (mc == NULL || countp == NULL)
7402 if (mc->mc_xcursor == NULL)
7403 return MDB_INCOMPATIBLE;
7405 if (mc->mc_txn->mt_flags & MDB_TXN_ERROR)
7408 if (!(mc->mc_flags & C_INITIALIZED))
7411 if (!mc->mc_snum || (mc->mc_flags & C_EOF))
7412 return MDB_NOTFOUND;
7414 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
7415 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
7418 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
7421 *countp = mc->mc_xcursor->mx_db.md_entries;
7427 mdb_cursor_close(MDB_cursor *mc)
7429 if (mc && !mc->mc_backup) {
7430 /* remove from txn, if tracked */
7431 if ((mc->mc_flags & C_UNTRACK) && mc->mc_txn->mt_cursors) {
7432 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
7433 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
7435 *prev = mc->mc_next;
7442 mdb_cursor_txn(MDB_cursor *mc)
7444 if (!mc) return NULL;
7449 mdb_cursor_dbi(MDB_cursor *mc)
7454 /** Replace the key for a branch node with a new key.
7455 * @param[in] mc Cursor pointing to the node to operate on.
7456 * @param[in] key The new key to use.
7457 * @return 0 on success, non-zero on failure.
7460 mdb_update_key(MDB_cursor *mc, MDB_val *key)
7466 int delta, ksize, oksize;
7467 indx_t ptr, i, numkeys, indx;
7470 indx = mc->mc_ki[mc->mc_top];
7471 mp = mc->mc_pg[mc->mc_top];
7472 node = NODEPTR(mp, indx);
7473 ptr = mp->mp_ptrs[indx];
7477 char kbuf2[DKBUF_MAXKEYSIZE*2+1];
7478 k2.mv_data = NODEKEY(node);
7479 k2.mv_size = node->mn_ksize;
7480 DPRINTF(("update key %u (ofs %u) [%s] to [%s] on page %"Z"u",
7482 mdb_dkey(&k2, kbuf2),
7488 /* Sizes must be 2-byte aligned. */
7489 ksize = EVEN(key->mv_size);
7490 oksize = EVEN(node->mn_ksize);
7491 delta = ksize - oksize;
7493 /* Shift node contents if EVEN(key length) changed. */
7495 if (delta > 0 && SIZELEFT(mp) < delta) {
7497 /* not enough space left, do a delete and split */
7498 DPRINTF(("Not enough room, delta = %d, splitting...", delta));
7499 pgno = NODEPGNO(node);
7500 mdb_node_del(mc, 0);
7501 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
7504 numkeys = NUMKEYS(mp);
7505 for (i = 0; i < numkeys; i++) {
7506 if (mp->mp_ptrs[i] <= ptr)
7507 mp->mp_ptrs[i] -= delta;
7510 base = (char *)mp + mp->mp_upper + PAGEBASE;
7511 len = ptr - mp->mp_upper + NODESIZE;
7512 memmove(base - delta, base, len);
7513 mp->mp_upper -= delta;
7515 node = NODEPTR(mp, indx);
7518 /* But even if no shift was needed, update ksize */
7519 if (node->mn_ksize != key->mv_size)
7520 node->mn_ksize = key->mv_size;
7523 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
7529 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
7531 /** Move a node from csrc to cdst.
7534 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
7541 unsigned short flags;
7545 /* Mark src and dst as dirty. */
7546 if ((rc = mdb_page_touch(csrc)) ||
7547 (rc = mdb_page_touch(cdst)))
7550 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7551 key.mv_size = csrc->mc_db->md_pad;
7552 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
7554 data.mv_data = NULL;
7558 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
7559 mdb_cassert(csrc, !((size_t)srcnode & 1));
7560 srcpg = NODEPGNO(srcnode);
7561 flags = srcnode->mn_flags;
7562 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7563 unsigned int snum = csrc->mc_snum;
7565 /* must find the lowest key below src */
7566 rc = mdb_page_search_lowest(csrc);
7569 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7570 key.mv_size = csrc->mc_db->md_pad;
7571 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7573 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7574 key.mv_size = NODEKSZ(s2);
7575 key.mv_data = NODEKEY(s2);
7577 csrc->mc_snum = snum--;
7578 csrc->mc_top = snum;
7580 key.mv_size = NODEKSZ(srcnode);
7581 key.mv_data = NODEKEY(srcnode);
7583 data.mv_size = NODEDSZ(srcnode);
7584 data.mv_data = NODEDATA(srcnode);
7586 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
7587 unsigned int snum = cdst->mc_snum;
7590 /* must find the lowest key below dst */
7591 mdb_cursor_copy(cdst, &mn);
7592 rc = mdb_page_search_lowest(&mn);
7595 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7596 bkey.mv_size = mn.mc_db->md_pad;
7597 bkey.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, bkey.mv_size);
7599 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7600 bkey.mv_size = NODEKSZ(s2);
7601 bkey.mv_data = NODEKEY(s2);
7603 mn.mc_snum = snum--;
7606 rc = mdb_update_key(&mn, &bkey);
7611 DPRINTF(("moving %s node %u [%s] on page %"Z"u to node %u on page %"Z"u",
7612 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
7613 csrc->mc_ki[csrc->mc_top],
7615 csrc->mc_pg[csrc->mc_top]->mp_pgno,
7616 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno));
7618 /* Add the node to the destination page.
7620 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
7621 if (rc != MDB_SUCCESS)
7624 /* Delete the node from the source page.
7626 mdb_node_del(csrc, key.mv_size);
7629 /* Adjust other cursors pointing to mp */
7630 MDB_cursor *m2, *m3;
7631 MDB_dbi dbi = csrc->mc_dbi;
7632 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
7634 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7635 if (csrc->mc_flags & C_SUB)
7636 m3 = &m2->mc_xcursor->mx_cursor;
7639 if (m3 == csrc) continue;
7640 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
7641 csrc->mc_ki[csrc->mc_top]) {
7642 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
7643 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
7648 /* Update the parent separators.
7650 if (csrc->mc_ki[csrc->mc_top] == 0) {
7651 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
7652 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7653 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7655 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7656 key.mv_size = NODEKSZ(srcnode);
7657 key.mv_data = NODEKEY(srcnode);
7659 DPRINTF(("update separator for source page %"Z"u to [%s]",
7660 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key)));
7661 mdb_cursor_copy(csrc, &mn);
7664 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7667 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7669 indx_t ix = csrc->mc_ki[csrc->mc_top];
7670 nullkey.mv_size = 0;
7671 csrc->mc_ki[csrc->mc_top] = 0;
7672 rc = mdb_update_key(csrc, &nullkey);
7673 csrc->mc_ki[csrc->mc_top] = ix;
7674 mdb_cassert(csrc, rc == MDB_SUCCESS);
7678 if (cdst->mc_ki[cdst->mc_top] == 0) {
7679 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
7680 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7681 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
7683 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
7684 key.mv_size = NODEKSZ(srcnode);
7685 key.mv_data = NODEKEY(srcnode);
7687 DPRINTF(("update separator for destination page %"Z"u to [%s]",
7688 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key)));
7689 mdb_cursor_copy(cdst, &mn);
7692 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7695 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
7697 indx_t ix = cdst->mc_ki[cdst->mc_top];
7698 nullkey.mv_size = 0;
7699 cdst->mc_ki[cdst->mc_top] = 0;
7700 rc = mdb_update_key(cdst, &nullkey);
7701 cdst->mc_ki[cdst->mc_top] = ix;
7702 mdb_cassert(cdst, rc == MDB_SUCCESS);
7709 /** Merge one page into another.
7710 * The nodes from the page pointed to by \b csrc will
7711 * be copied to the page pointed to by \b cdst and then
7712 * the \b csrc page will be freed.
7713 * @param[in] csrc Cursor pointing to the source page.
7714 * @param[in] cdst Cursor pointing to the destination page.
7715 * @return 0 on success, non-zero on failure.
7718 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
7720 MDB_page *psrc, *pdst;
7727 psrc = csrc->mc_pg[csrc->mc_top];
7728 pdst = cdst->mc_pg[cdst->mc_top];
7730 DPRINTF(("merging page %"Z"u into %"Z"u", psrc->mp_pgno, pdst->mp_pgno));
7732 mdb_cassert(csrc, csrc->mc_snum > 1); /* can't merge root page */
7733 mdb_cassert(csrc, cdst->mc_snum > 1);
7735 /* Mark dst as dirty. */
7736 if ((rc = mdb_page_touch(cdst)))
7739 /* Move all nodes from src to dst.
7741 j = nkeys = NUMKEYS(pdst);
7742 if (IS_LEAF2(psrc)) {
7743 key.mv_size = csrc->mc_db->md_pad;
7744 key.mv_data = METADATA(psrc);
7745 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7746 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
7747 if (rc != MDB_SUCCESS)
7749 key.mv_data = (char *)key.mv_data + key.mv_size;
7752 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7753 srcnode = NODEPTR(psrc, i);
7754 if (i == 0 && IS_BRANCH(psrc)) {
7757 mdb_cursor_copy(csrc, &mn);
7758 /* must find the lowest key below src */
7759 rc = mdb_page_search_lowest(&mn);
7762 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7763 key.mv_size = mn.mc_db->md_pad;
7764 key.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, key.mv_size);
7766 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7767 key.mv_size = NODEKSZ(s2);
7768 key.mv_data = NODEKEY(s2);
7771 key.mv_size = srcnode->mn_ksize;
7772 key.mv_data = NODEKEY(srcnode);
7775 data.mv_size = NODEDSZ(srcnode);
7776 data.mv_data = NODEDATA(srcnode);
7777 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
7778 if (rc != MDB_SUCCESS)
7783 DPRINTF(("dst page %"Z"u now has %u keys (%.1f%% filled)",
7784 pdst->mp_pgno, NUMKEYS(pdst),
7785 (float)PAGEFILL(cdst->mc_txn->mt_env, pdst) / 10));
7787 /* Unlink the src page from parent and add to free list.
7790 mdb_node_del(csrc, 0);
7791 if (csrc->mc_ki[csrc->mc_top] == 0) {
7793 rc = mdb_update_key(csrc, &key);
7801 psrc = csrc->mc_pg[csrc->mc_top];
7802 /* If not operating on FreeDB, allow this page to be reused
7803 * in this txn. Otherwise just add to free list.
7805 rc = mdb_page_loose(csrc, psrc);
7809 csrc->mc_db->md_leaf_pages--;
7811 csrc->mc_db->md_branch_pages--;
7813 /* Adjust other cursors pointing to mp */
7814 MDB_cursor *m2, *m3;
7815 MDB_dbi dbi = csrc->mc_dbi;
7817 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7818 if (csrc->mc_flags & C_SUB)
7819 m3 = &m2->mc_xcursor->mx_cursor;
7822 if (m3 == csrc) continue;
7823 if (m3->mc_snum < csrc->mc_snum) continue;
7824 if (m3->mc_pg[csrc->mc_top] == psrc) {
7825 m3->mc_pg[csrc->mc_top] = pdst;
7826 m3->mc_ki[csrc->mc_top] += nkeys;
7831 unsigned int snum = cdst->mc_snum;
7832 uint16_t depth = cdst->mc_db->md_depth;
7833 mdb_cursor_pop(cdst);
7834 rc = mdb_rebalance(cdst);
7835 /* Did the tree shrink? */
7836 if (depth > cdst->mc_db->md_depth)
7838 cdst->mc_snum = snum;
7839 cdst->mc_top = snum-1;
7844 /** Copy the contents of a cursor.
7845 * @param[in] csrc The cursor to copy from.
7846 * @param[out] cdst The cursor to copy to.
7849 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
7853 cdst->mc_txn = csrc->mc_txn;
7854 cdst->mc_dbi = csrc->mc_dbi;
7855 cdst->mc_db = csrc->mc_db;
7856 cdst->mc_dbx = csrc->mc_dbx;
7857 cdst->mc_snum = csrc->mc_snum;
7858 cdst->mc_top = csrc->mc_top;
7859 cdst->mc_flags = csrc->mc_flags;
7861 for (i=0; i<csrc->mc_snum; i++) {
7862 cdst->mc_pg[i] = csrc->mc_pg[i];
7863 cdst->mc_ki[i] = csrc->mc_ki[i];
7867 /** Rebalance the tree after a delete operation.
7868 * @param[in] mc Cursor pointing to the page where rebalancing
7870 * @return 0 on success, non-zero on failure.
7873 mdb_rebalance(MDB_cursor *mc)
7877 unsigned int ptop, minkeys;
7881 minkeys = 1 + (IS_BRANCH(mc->mc_pg[mc->mc_top]));
7882 DPRINTF(("rebalancing %s page %"Z"u (has %u keys, %.1f%% full)",
7883 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
7884 mdb_dbg_pgno(mc->mc_pg[mc->mc_top]), NUMKEYS(mc->mc_pg[mc->mc_top]),
7885 (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10));
7887 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD &&
7888 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
7889 DPRINTF(("no need to rebalance page %"Z"u, above fill threshold",
7890 mdb_dbg_pgno(mc->mc_pg[mc->mc_top])));
7894 if (mc->mc_snum < 2) {
7895 MDB_page *mp = mc->mc_pg[0];
7897 DPUTS("Can't rebalance a subpage, ignoring");
7900 if (NUMKEYS(mp) == 0) {
7901 DPUTS("tree is completely empty");
7902 mc->mc_db->md_root = P_INVALID;
7903 mc->mc_db->md_depth = 0;
7904 mc->mc_db->md_leaf_pages = 0;
7905 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7908 /* Adjust cursors pointing to mp */
7911 mc->mc_flags &= ~C_INITIALIZED;
7913 MDB_cursor *m2, *m3;
7914 MDB_dbi dbi = mc->mc_dbi;
7916 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7917 if (mc->mc_flags & C_SUB)
7918 m3 = &m2->mc_xcursor->mx_cursor;
7921 if (m3->mc_snum < mc->mc_snum) continue;
7922 if (m3->mc_pg[0] == mp) {
7925 m3->mc_flags &= ~C_INITIALIZED;
7929 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
7931 DPUTS("collapsing root page!");
7932 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7935 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
7936 rc = mdb_page_get(mc->mc_txn,mc->mc_db->md_root,&mc->mc_pg[0],NULL);
7939 mc->mc_db->md_depth--;
7940 mc->mc_db->md_branch_pages--;
7941 mc->mc_ki[0] = mc->mc_ki[1];
7942 for (i = 1; i<mc->mc_db->md_depth; i++) {
7943 mc->mc_pg[i] = mc->mc_pg[i+1];
7944 mc->mc_ki[i] = mc->mc_ki[i+1];
7947 /* Adjust other cursors pointing to mp */
7948 MDB_cursor *m2, *m3;
7949 MDB_dbi dbi = mc->mc_dbi;
7951 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7952 if (mc->mc_flags & C_SUB)
7953 m3 = &m2->mc_xcursor->mx_cursor;
7956 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
7957 if (m3->mc_pg[0] == mp) {
7958 for (i=0; i<m3->mc_snum; i++) {
7959 m3->mc_pg[i] = m3->mc_pg[i+1];
7960 m3->mc_ki[i] = m3->mc_ki[i+1];
7968 DPUTS("root page doesn't need rebalancing");
7972 /* The parent (branch page) must have at least 2 pointers,
7973 * otherwise the tree is invalid.
7975 ptop = mc->mc_top-1;
7976 mdb_cassert(mc, NUMKEYS(mc->mc_pg[ptop]) > 1);
7978 /* Leaf page fill factor is below the threshold.
7979 * Try to move keys from left or right neighbor, or
7980 * merge with a neighbor page.
7985 mdb_cursor_copy(mc, &mn);
7986 mn.mc_xcursor = NULL;
7988 oldki = mc->mc_ki[mc->mc_top];
7989 if (mc->mc_ki[ptop] == 0) {
7990 /* We're the leftmost leaf in our parent.
7992 DPUTS("reading right neighbor");
7994 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
7995 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
7998 mn.mc_ki[mn.mc_top] = 0;
7999 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
8001 /* There is at least one neighbor to the left.
8003 DPUTS("reading left neighbor");
8005 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
8006 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
8009 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
8010 mc->mc_ki[mc->mc_top] = 0;
8013 DPRINTF(("found neighbor page %"Z"u (%u keys, %.1f%% full)",
8014 mn.mc_pg[mn.mc_top]->mp_pgno, NUMKEYS(mn.mc_pg[mn.mc_top]),
8015 (float)PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) / 10));
8017 /* If the neighbor page is above threshold and has enough keys,
8018 * move one key from it. Otherwise we should try to merge them.
8019 * (A branch page must never have less than 2 keys.)
8021 minkeys = 1 + (IS_BRANCH(mn.mc_pg[mn.mc_top]));
8022 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys) {
8023 rc = mdb_node_move(&mn, mc);
8024 if (mc->mc_ki[ptop]) {
8028 if (mc->mc_ki[ptop] == 0) {
8029 rc = mdb_page_merge(&mn, mc);
8032 oldki += NUMKEYS(mn.mc_pg[mn.mc_top]);
8033 mn.mc_ki[mn.mc_top] += mc->mc_ki[mn.mc_top] + 1;
8034 /* We want mdb_rebalance to find mn when doing fixups */
8035 if (mc->mc_flags & C_SUB) {
8036 dummy.mc_next = mc->mc_txn->mt_cursors[mc->mc_dbi];
8037 mc->mc_txn->mt_cursors[mc->mc_dbi] = &dummy;
8038 dummy.mc_xcursor = (MDB_xcursor *)&mn;
8040 mn.mc_next = mc->mc_txn->mt_cursors[mc->mc_dbi];
8041 mc->mc_txn->mt_cursors[mc->mc_dbi] = &mn;
8043 rc = mdb_page_merge(mc, &mn);
8044 if (mc->mc_flags & C_SUB)
8045 mc->mc_txn->mt_cursors[mc->mc_dbi] = dummy.mc_next;
8047 mc->mc_txn->mt_cursors[mc->mc_dbi] = mn.mc_next;
8048 mdb_cursor_copy(&mn, mc);
8050 mc->mc_flags &= ~C_EOF;
8052 mc->mc_ki[mc->mc_top] = oldki;
8056 /** Complete a delete operation started by #mdb_cursor_del(). */
8058 mdb_cursor_del0(MDB_cursor *mc)
8065 ki = mc->mc_ki[mc->mc_top];
8066 mdb_node_del(mc, mc->mc_db->md_pad);
8067 mc->mc_db->md_entries--;
8068 rc = mdb_rebalance(mc);
8070 if (rc == MDB_SUCCESS) {
8071 MDB_cursor *m2, *m3;
8072 MDB_dbi dbi = mc->mc_dbi;
8074 /* DB is totally empty now, just bail out.
8075 * Other cursors adjustments were already done
8076 * by mdb_rebalance and aren't needed here.
8081 mp = mc->mc_pg[mc->mc_top];
8082 nkeys = NUMKEYS(mp);
8084 /* if mc points past last node in page, find next sibling */
8085 if (mc->mc_ki[mc->mc_top] >= nkeys) {
8086 rc = mdb_cursor_sibling(mc, 1);
8087 if (rc == MDB_NOTFOUND) {
8088 mc->mc_flags |= C_EOF;
8093 /* Adjust other cursors pointing to mp */
8094 for (m2 = mc->mc_txn->mt_cursors[dbi]; !rc && m2; m2=m2->mc_next) {
8095 m3 = (mc->mc_flags & C_SUB) ? &m2->mc_xcursor->mx_cursor : m2;
8096 if (! (m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8098 if (m3 == mc || m3->mc_snum < mc->mc_snum)
8100 if (m3->mc_pg[mc->mc_top] == mp) {
8101 if (m3->mc_ki[mc->mc_top] >= ki) {
8102 m3->mc_flags |= C_DEL;
8103 if (m3->mc_ki[mc->mc_top] > ki)
8104 m3->mc_ki[mc->mc_top]--;
8105 else if (mc->mc_db->md_flags & MDB_DUPSORT)
8106 m3->mc_xcursor->mx_cursor.mc_flags |= C_EOF;
8108 if (m3->mc_ki[mc->mc_top] >= nkeys) {
8109 rc = mdb_cursor_sibling(m3, 1);
8110 if (rc == MDB_NOTFOUND) {
8111 m3->mc_flags |= C_EOF;
8117 mc->mc_flags |= C_DEL;
8121 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
8126 mdb_del(MDB_txn *txn, MDB_dbi dbi,
8127 MDB_val *key, MDB_val *data)
8129 if (!key || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
8132 if (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
8133 return (txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
8135 if (!F_ISSET(txn->mt_dbs[dbi].md_flags, MDB_DUPSORT)) {
8136 /* must ignore any data */
8140 return mdb_del0(txn, dbi, key, data, 0);
8144 mdb_del0(MDB_txn *txn, MDB_dbi dbi,
8145 MDB_val *key, MDB_val *data, unsigned flags)
8150 MDB_val rdata, *xdata;
8154 DPRINTF(("====> delete db %u key [%s]", dbi, DKEY(key)));
8156 mdb_cursor_init(&mc, txn, dbi, &mx);
8165 flags |= MDB_NODUPDATA;
8167 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
8169 /* let mdb_page_split know about this cursor if needed:
8170 * delete will trigger a rebalance; if it needs to move
8171 * a node from one page to another, it will have to
8172 * update the parent's separator key(s). If the new sepkey
8173 * is larger than the current one, the parent page may
8174 * run out of space, triggering a split. We need this
8175 * cursor to be consistent until the end of the rebalance.
8177 mc.mc_flags |= C_UNTRACK;
8178 mc.mc_next = txn->mt_cursors[dbi];
8179 txn->mt_cursors[dbi] = &mc;
8180 rc = mdb_cursor_del(&mc, flags);
8181 txn->mt_cursors[dbi] = mc.mc_next;
8186 /** Split a page and insert a new node.
8187 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
8188 * The cursor will be updated to point to the actual page and index where
8189 * the node got inserted after the split.
8190 * @param[in] newkey The key for the newly inserted node.
8191 * @param[in] newdata The data for the newly inserted node.
8192 * @param[in] newpgno The page number, if the new node is a branch node.
8193 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
8194 * @return 0 on success, non-zero on failure.
8197 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
8198 unsigned int nflags)
8201 int rc = MDB_SUCCESS, new_root = 0, did_split = 0;
8204 int i, j, split_indx, nkeys, pmax;
8205 MDB_env *env = mc->mc_txn->mt_env;
8207 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
8208 MDB_page *copy = NULL;
8209 MDB_page *mp, *rp, *pp;
8214 mp = mc->mc_pg[mc->mc_top];
8215 newindx = mc->mc_ki[mc->mc_top];
8216 nkeys = NUMKEYS(mp);
8218 DPRINTF(("-----> splitting %s page %"Z"u and adding [%s] at index %i/%i",
8219 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
8220 DKEY(newkey), mc->mc_ki[mc->mc_top], nkeys));
8222 /* Create a right sibling. */
8223 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
8225 rp->mp_pad = mp->mp_pad;
8226 DPRINTF(("new right sibling: page %"Z"u", rp->mp_pgno));
8228 if (mc->mc_snum < 2) {
8229 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
8231 /* shift current top to make room for new parent */
8232 mc->mc_pg[1] = mc->mc_pg[0];
8233 mc->mc_ki[1] = mc->mc_ki[0];
8236 mc->mc_db->md_root = pp->mp_pgno;
8237 DPRINTF(("root split! new root = %"Z"u", pp->mp_pgno));
8238 mc->mc_db->md_depth++;
8241 /* Add left (implicit) pointer. */
8242 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
8243 /* undo the pre-push */
8244 mc->mc_pg[0] = mc->mc_pg[1];
8245 mc->mc_ki[0] = mc->mc_ki[1];
8246 mc->mc_db->md_root = mp->mp_pgno;
8247 mc->mc_db->md_depth--;
8254 ptop = mc->mc_top-1;
8255 DPRINTF(("parent branch page is %"Z"u", mc->mc_pg[ptop]->mp_pgno));
8258 mc->mc_flags |= C_SPLITTING;
8259 mdb_cursor_copy(mc, &mn);
8260 mn.mc_pg[mn.mc_top] = rp;
8261 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
8263 if (nflags & MDB_APPEND) {
8264 mn.mc_ki[mn.mc_top] = 0;
8266 split_indx = newindx;
8270 split_indx = (nkeys+1) / 2;
8275 unsigned int lsize, rsize, ksize;
8276 /* Move half of the keys to the right sibling */
8277 x = mc->mc_ki[mc->mc_top] - split_indx;
8278 ksize = mc->mc_db->md_pad;
8279 split = LEAF2KEY(mp, split_indx, ksize);
8280 rsize = (nkeys - split_indx) * ksize;
8281 lsize = (nkeys - split_indx) * sizeof(indx_t);
8282 mp->mp_lower -= lsize;
8283 rp->mp_lower += lsize;
8284 mp->mp_upper += rsize - lsize;
8285 rp->mp_upper -= rsize - lsize;
8286 sepkey.mv_size = ksize;
8287 if (newindx == split_indx) {
8288 sepkey.mv_data = newkey->mv_data;
8290 sepkey.mv_data = split;
8293 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
8294 memcpy(rp->mp_ptrs, split, rsize);
8295 sepkey.mv_data = rp->mp_ptrs;
8296 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
8297 memcpy(ins, newkey->mv_data, ksize);
8298 mp->mp_lower += sizeof(indx_t);
8299 mp->mp_upper -= ksize - sizeof(indx_t);
8302 memcpy(rp->mp_ptrs, split, x * ksize);
8303 ins = LEAF2KEY(rp, x, ksize);
8304 memcpy(ins, newkey->mv_data, ksize);
8305 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
8306 rp->mp_lower += sizeof(indx_t);
8307 rp->mp_upper -= ksize - sizeof(indx_t);
8308 mc->mc_ki[mc->mc_top] = x;
8309 mc->mc_pg[mc->mc_top] = rp;
8312 int psize, nsize, k;
8313 /* Maximum free space in an empty page */
8314 pmax = env->me_psize - PAGEHDRSZ;
8316 nsize = mdb_leaf_size(env, newkey, newdata);
8318 nsize = mdb_branch_size(env, newkey);
8319 nsize = EVEN(nsize);
8321 /* grab a page to hold a temporary copy */
8322 copy = mdb_page_malloc(mc->mc_txn, 1);
8327 copy->mp_pgno = mp->mp_pgno;
8328 copy->mp_flags = mp->mp_flags;
8329 copy->mp_lower = (PAGEHDRSZ-PAGEBASE);
8330 copy->mp_upper = env->me_psize - PAGEBASE;
8332 /* prepare to insert */
8333 for (i=0, j=0; i<nkeys; i++) {
8335 copy->mp_ptrs[j++] = 0;
8337 copy->mp_ptrs[j++] = mp->mp_ptrs[i];
8340 /* When items are relatively large the split point needs
8341 * to be checked, because being off-by-one will make the
8342 * difference between success or failure in mdb_node_add.
8344 * It's also relevant if a page happens to be laid out
8345 * such that one half of its nodes are all "small" and
8346 * the other half of its nodes are "large." If the new
8347 * item is also "large" and falls on the half with
8348 * "large" nodes, it also may not fit.
8350 * As a final tweak, if the new item goes on the last
8351 * spot on the page (and thus, onto the new page), bias
8352 * the split so the new page is emptier than the old page.
8353 * This yields better packing during sequential inserts.
8355 if (nkeys < 20 || nsize > pmax/16 || newindx >= nkeys) {
8356 /* Find split point */
8358 if (newindx <= split_indx || newindx >= nkeys) {
8360 k = newindx >= nkeys ? nkeys : split_indx+2;
8365 for (; i!=k; i+=j) {
8370 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
8371 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
8373 if (F_ISSET(node->mn_flags, F_BIGDATA))
8374 psize += sizeof(pgno_t);
8376 psize += NODEDSZ(node);
8378 psize = EVEN(psize);
8380 if (psize > pmax || i == k-j) {
8381 split_indx = i + (j<0);
8386 if (split_indx == newindx) {
8387 sepkey.mv_size = newkey->mv_size;
8388 sepkey.mv_data = newkey->mv_data;
8390 node = (MDB_node *)((char *)mp + copy->mp_ptrs[split_indx] + PAGEBASE);
8391 sepkey.mv_size = node->mn_ksize;
8392 sepkey.mv_data = NODEKEY(node);
8397 DPRINTF(("separator is %d [%s]", split_indx, DKEY(&sepkey)));
8399 /* Copy separator key to the parent.
8401 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(env, &sepkey)) {
8405 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
8410 if (mn.mc_snum == mc->mc_snum) {
8411 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
8412 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
8413 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
8414 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
8419 /* Right page might now have changed parent.
8420 * Check if left page also changed parent.
8422 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
8423 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
8424 for (i=0; i<ptop; i++) {
8425 mc->mc_pg[i] = mn.mc_pg[i];
8426 mc->mc_ki[i] = mn.mc_ki[i];
8428 mc->mc_pg[ptop] = mn.mc_pg[ptop];
8429 if (mn.mc_ki[ptop]) {
8430 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
8432 /* find right page's left sibling */
8433 mc->mc_ki[ptop] = mn.mc_ki[ptop];
8434 mdb_cursor_sibling(mc, 0);
8439 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
8442 mc->mc_flags ^= C_SPLITTING;
8443 if (rc != MDB_SUCCESS) {
8446 if (nflags & MDB_APPEND) {
8447 mc->mc_pg[mc->mc_top] = rp;
8448 mc->mc_ki[mc->mc_top] = 0;
8449 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
8452 for (i=0; i<mc->mc_top; i++)
8453 mc->mc_ki[i] = mn.mc_ki[i];
8454 } else if (!IS_LEAF2(mp)) {
8456 mc->mc_pg[mc->mc_top] = rp;
8461 rkey.mv_data = newkey->mv_data;
8462 rkey.mv_size = newkey->mv_size;
8468 /* Update index for the new key. */
8469 mc->mc_ki[mc->mc_top] = j;
8471 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
8472 rkey.mv_data = NODEKEY(node);
8473 rkey.mv_size = node->mn_ksize;
8475 xdata.mv_data = NODEDATA(node);
8476 xdata.mv_size = NODEDSZ(node);
8479 pgno = NODEPGNO(node);
8480 flags = node->mn_flags;
8483 if (!IS_LEAF(mp) && j == 0) {
8484 /* First branch index doesn't need key data. */
8488 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
8494 mc->mc_pg[mc->mc_top] = copy;
8499 } while (i != split_indx);
8501 nkeys = NUMKEYS(copy);
8502 for (i=0; i<nkeys; i++)
8503 mp->mp_ptrs[i] = copy->mp_ptrs[i];
8504 mp->mp_lower = copy->mp_lower;
8505 mp->mp_upper = copy->mp_upper;
8506 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
8507 env->me_psize - copy->mp_upper - PAGEBASE);
8509 /* reset back to original page */
8510 if (newindx < split_indx) {
8511 mc->mc_pg[mc->mc_top] = mp;
8512 if (nflags & MDB_RESERVE) {
8513 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
8514 if (!(node->mn_flags & F_BIGDATA))
8515 newdata->mv_data = NODEDATA(node);
8518 mc->mc_pg[mc->mc_top] = rp;
8520 /* Make sure mc_ki is still valid.
8522 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
8523 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
8524 for (i=0; i<=ptop; i++) {
8525 mc->mc_pg[i] = mn.mc_pg[i];
8526 mc->mc_ki[i] = mn.mc_ki[i];
8533 /* Adjust other cursors pointing to mp */
8534 MDB_cursor *m2, *m3;
8535 MDB_dbi dbi = mc->mc_dbi;
8536 int fixup = NUMKEYS(mp);
8538 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
8539 if (mc->mc_flags & C_SUB)
8540 m3 = &m2->mc_xcursor->mx_cursor;
8545 if (!(m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8547 if (m3->mc_flags & C_SPLITTING)
8552 for (k=m3->mc_top; k>=0; k--) {
8553 m3->mc_ki[k+1] = m3->mc_ki[k];
8554 m3->mc_pg[k+1] = m3->mc_pg[k];
8556 if (m3->mc_ki[0] >= split_indx) {
8561 m3->mc_pg[0] = mc->mc_pg[0];
8565 if (m3->mc_top >= mc->mc_top && m3->mc_pg[mc->mc_top] == mp) {
8566 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
8567 m3->mc_ki[mc->mc_top]++;
8568 if (m3->mc_ki[mc->mc_top] >= fixup) {
8569 m3->mc_pg[mc->mc_top] = rp;
8570 m3->mc_ki[mc->mc_top] -= fixup;
8571 m3->mc_ki[ptop] = mn.mc_ki[ptop];
8573 } else if (!did_split && m3->mc_top >= ptop && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
8574 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
8579 DPRINTF(("mp left: %d, rp left: %d", SIZELEFT(mp), SIZELEFT(rp)));
8582 if (copy) /* tmp page */
8583 mdb_page_free(env, copy);
8585 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
8590 mdb_put(MDB_txn *txn, MDB_dbi dbi,
8591 MDB_val *key, MDB_val *data, unsigned int flags)
8596 if (!key || !data || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
8599 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP)) != flags)
8602 mdb_cursor_init(&mc, txn, dbi, &mx);
8603 return mdb_cursor_put(&mc, key, data, flags);
8607 #define MDB_WBUF (1024*1024)
8610 /** State needed for a compacting copy. */
8611 typedef struct mdb_copy {
8612 pthread_mutex_t mc_mutex;
8613 pthread_cond_t mc_cond;
8620 pgno_t mc_next_pgno;
8623 volatile int mc_new;
8628 /** Dedicated writer thread for compacting copy. */
8629 static THREAD_RET ESECT
8630 mdb_env_copythr(void *arg)
8634 int toggle = 0, wsize, rc;
8637 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
8640 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
8643 pthread_mutex_lock(&my->mc_mutex);
8645 pthread_cond_signal(&my->mc_cond);
8648 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8649 if (my->mc_new < 0) {
8654 wsize = my->mc_wlen[toggle];
8655 ptr = my->mc_wbuf[toggle];
8658 DO_WRITE(rc, my->mc_fd, ptr, wsize, len);
8662 } else if (len > 0) {
8676 /* If there's an overflow page tail, write it too */
8677 if (my->mc_olen[toggle]) {
8678 wsize = my->mc_olen[toggle];
8679 ptr = my->mc_over[toggle];
8680 my->mc_olen[toggle] = 0;
8683 my->mc_wlen[toggle] = 0;
8685 pthread_cond_signal(&my->mc_cond);
8687 pthread_cond_signal(&my->mc_cond);
8688 pthread_mutex_unlock(&my->mc_mutex);
8689 return (THREAD_RET)0;
8693 /** Tell the writer thread there's a buffer ready to write */
8695 mdb_env_cthr_toggle(mdb_copy *my, int st)
8697 int toggle = my->mc_toggle ^ 1;
8698 pthread_mutex_lock(&my->mc_mutex);
8699 if (my->mc_status) {
8700 pthread_mutex_unlock(&my->mc_mutex);
8701 return my->mc_status;
8703 while (my->mc_new == 1)
8704 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8706 my->mc_toggle = toggle;
8707 pthread_cond_signal(&my->mc_cond);
8708 pthread_mutex_unlock(&my->mc_mutex);
8712 /** Depth-first tree traversal for compacting copy. */
8714 mdb_env_cwalk(mdb_copy *my, pgno_t *pg, int flags)
8717 MDB_txn *txn = my->mc_txn;
8719 MDB_page *mo, *mp, *leaf;
8724 /* Empty DB, nothing to do */
8725 if (*pg == P_INVALID)
8732 rc = mdb_page_get(my->mc_txn, *pg, &mc.mc_pg[0], NULL);
8735 rc = mdb_page_search_root(&mc, NULL, MDB_PS_FIRST);
8739 /* Make cursor pages writable */
8740 buf = ptr = malloc(my->mc_env->me_psize * mc.mc_snum);
8744 for (i=0; i<mc.mc_top; i++) {
8745 mdb_page_copy((MDB_page *)ptr, mc.mc_pg[i], my->mc_env->me_psize);
8746 mc.mc_pg[i] = (MDB_page *)ptr;
8747 ptr += my->mc_env->me_psize;
8750 /* This is writable space for a leaf page. Usually not needed. */
8751 leaf = (MDB_page *)ptr;
8753 toggle = my->mc_toggle;
8754 while (mc.mc_snum > 0) {
8756 mp = mc.mc_pg[mc.mc_top];
8760 if (!IS_LEAF2(mp) && !(flags & F_DUPDATA)) {
8761 for (i=0; i<n; i++) {
8762 ni = NODEPTR(mp, i);
8763 if (ni->mn_flags & F_BIGDATA) {
8767 /* Need writable leaf */
8769 mc.mc_pg[mc.mc_top] = leaf;
8770 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8772 ni = NODEPTR(mp, i);
8775 memcpy(&pg, NODEDATA(ni), sizeof(pg));
8776 rc = mdb_page_get(txn, pg, &omp, NULL);
8779 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8780 rc = mdb_env_cthr_toggle(my, 1);
8783 toggle = my->mc_toggle;
8785 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8786 memcpy(mo, omp, my->mc_env->me_psize);
8787 mo->mp_pgno = my->mc_next_pgno;
8788 my->mc_next_pgno += omp->mp_pages;
8789 my->mc_wlen[toggle] += my->mc_env->me_psize;
8790 if (omp->mp_pages > 1) {
8791 my->mc_olen[toggle] = my->mc_env->me_psize * (omp->mp_pages - 1);
8792 my->mc_over[toggle] = (char *)omp + my->mc_env->me_psize;
8793 rc = mdb_env_cthr_toggle(my, 1);
8796 toggle = my->mc_toggle;
8798 memcpy(NODEDATA(ni), &mo->mp_pgno, sizeof(pgno_t));
8799 } else if (ni->mn_flags & F_SUBDATA) {
8802 /* Need writable leaf */
8804 mc.mc_pg[mc.mc_top] = leaf;
8805 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8807 ni = NODEPTR(mp, i);
8810 memcpy(&db, NODEDATA(ni), sizeof(db));
8811 my->mc_toggle = toggle;
8812 rc = mdb_env_cwalk(my, &db.md_root, ni->mn_flags & F_DUPDATA);
8815 toggle = my->mc_toggle;
8816 memcpy(NODEDATA(ni), &db, sizeof(db));
8821 mc.mc_ki[mc.mc_top]++;
8822 if (mc.mc_ki[mc.mc_top] < n) {
8825 ni = NODEPTR(mp, mc.mc_ki[mc.mc_top]);
8827 rc = mdb_page_get(txn, pg, &mp, NULL);
8832 mc.mc_ki[mc.mc_top] = 0;
8833 if (IS_BRANCH(mp)) {
8834 /* Whenever we advance to a sibling branch page,
8835 * we must proceed all the way down to its first leaf.
8837 mdb_page_copy(mc.mc_pg[mc.mc_top], mp, my->mc_env->me_psize);
8840 mc.mc_pg[mc.mc_top] = mp;
8844 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8845 rc = mdb_env_cthr_toggle(my, 1);
8848 toggle = my->mc_toggle;
8850 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8851 mdb_page_copy(mo, mp, my->mc_env->me_psize);
8852 mo->mp_pgno = my->mc_next_pgno++;
8853 my->mc_wlen[toggle] += my->mc_env->me_psize;
8855 /* Update parent if there is one */
8856 ni = NODEPTR(mc.mc_pg[mc.mc_top-1], mc.mc_ki[mc.mc_top-1]);
8857 SETPGNO(ni, mo->mp_pgno);
8858 mdb_cursor_pop(&mc);
8860 /* Otherwise we're done */
8870 /** Copy environment with compaction. */
8872 mdb_env_copyfd1(MDB_env *env, HANDLE fd)
8877 MDB_txn *txn = NULL;
8882 my.mc_mutex = CreateMutex(NULL, FALSE, NULL);
8883 my.mc_cond = CreateEvent(NULL, FALSE, FALSE, NULL);
8884 my.mc_wbuf[0] = _aligned_malloc(MDB_WBUF*2, env->me_os_psize);
8885 if (my.mc_wbuf[0] == NULL)
8888 pthread_mutex_init(&my.mc_mutex, NULL);
8889 pthread_cond_init(&my.mc_cond, NULL);
8890 #ifdef HAVE_MEMALIGN
8891 my.mc_wbuf[0] = memalign(env->me_os_psize, MDB_WBUF*2);
8892 if (my.mc_wbuf[0] == NULL)
8895 rc = posix_memalign((void **)&my.mc_wbuf[0], env->me_os_psize, MDB_WBUF*2);
8900 memset(my.mc_wbuf[0], 0, MDB_WBUF*2);
8901 my.mc_wbuf[1] = my.mc_wbuf[0] + MDB_WBUF;
8906 my.mc_next_pgno = 2;
8912 THREAD_CREATE(thr, mdb_env_copythr, &my);
8914 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
8918 mp = (MDB_page *)my.mc_wbuf[0];
8919 memset(mp, 0, 2*env->me_psize);
8921 mp->mp_flags = P_META;
8922 mm = (MDB_meta *)METADATA(mp);
8923 mdb_env_init_meta0(env, mm);
8924 mm->mm_address = env->me_metas[0]->mm_address;
8926 mp = (MDB_page *)(my.mc_wbuf[0] + env->me_psize);
8928 mp->mp_flags = P_META;
8929 *(MDB_meta *)METADATA(mp) = *mm;
8930 mm = (MDB_meta *)METADATA(mp);
8932 /* Count the number of free pages, subtract from lastpg to find
8933 * number of active pages
8936 MDB_ID freecount = 0;
8939 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
8940 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
8941 freecount += *(MDB_ID *)data.mv_data;
8942 freecount += txn->mt_dbs[0].md_branch_pages +
8943 txn->mt_dbs[0].md_leaf_pages +
8944 txn->mt_dbs[0].md_overflow_pages;
8946 /* Set metapage 1 */
8947 mm->mm_last_pg = txn->mt_next_pgno - freecount - 1;
8948 mm->mm_dbs[1] = txn->mt_dbs[1];
8949 if (mm->mm_last_pg > 1) {
8950 mm->mm_dbs[1].md_root = mm->mm_last_pg;
8953 mm->mm_dbs[1].md_root = P_INVALID;
8956 my.mc_wlen[0] = env->me_psize * 2;
8958 pthread_mutex_lock(&my.mc_mutex);
8960 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8961 pthread_mutex_unlock(&my.mc_mutex);
8962 rc = mdb_env_cwalk(&my, &txn->mt_dbs[1].md_root, 0);
8963 if (rc == MDB_SUCCESS && my.mc_wlen[my.mc_toggle])
8964 rc = mdb_env_cthr_toggle(&my, 1);
8965 mdb_env_cthr_toggle(&my, -1);
8966 pthread_mutex_lock(&my.mc_mutex);
8968 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8969 pthread_mutex_unlock(&my.mc_mutex);
8974 CloseHandle(my.mc_cond);
8975 CloseHandle(my.mc_mutex);
8976 _aligned_free(my.mc_wbuf[0]);
8978 pthread_cond_destroy(&my.mc_cond);
8979 pthread_mutex_destroy(&my.mc_mutex);
8980 free(my.mc_wbuf[0]);
8985 /** Copy environment as-is. */
8987 mdb_env_copyfd0(MDB_env *env, HANDLE fd)
8989 MDB_txn *txn = NULL;
8990 mdb_mutexref_t wmutex = NULL;
8996 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
9000 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
9003 /* Do the lock/unlock of the reader mutex before starting the
9004 * write txn. Otherwise other read txns could block writers.
9006 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
9011 /* We must start the actual read txn after blocking writers */
9012 mdb_txn_reset0(txn, "reset-stage1");
9014 /* Temporarily block writers until we snapshot the meta pages */
9015 wmutex = env->me_wmutex;
9016 if (LOCK_MUTEX(rc, env, wmutex))
9019 rc = mdb_txn_renew0(txn);
9021 UNLOCK_MUTEX(wmutex);
9026 wsize = env->me_psize * 2;
9030 DO_WRITE(rc, fd, ptr, w2, len);
9034 } else if (len > 0) {
9040 /* Non-blocking or async handles are not supported */
9046 UNLOCK_MUTEX(wmutex);
9051 w2 = txn->mt_next_pgno * env->me_psize;
9054 if ((rc = mdb_fsize(env->me_fd, &fsize)))
9061 if (wsize > MAX_WRITE)
9065 DO_WRITE(rc, fd, ptr, w2, len);
9069 } else if (len > 0) {
9086 mdb_env_copyfd2(MDB_env *env, HANDLE fd, unsigned int flags)
9088 if (flags & MDB_CP_COMPACT)
9089 return mdb_env_copyfd1(env, fd);
9091 return mdb_env_copyfd0(env, fd);
9095 mdb_env_copyfd(MDB_env *env, HANDLE fd)
9097 return mdb_env_copyfd2(env, fd, 0);
9101 mdb_env_copy2(MDB_env *env, const char *path, unsigned int flags)
9105 HANDLE newfd = INVALID_HANDLE_VALUE;
9107 if (env->me_flags & MDB_NOSUBDIR) {
9108 lpath = (char *)path;
9111 len += sizeof(DATANAME);
9112 lpath = malloc(len);
9115 sprintf(lpath, "%s" DATANAME, path);
9118 /* The destination path must exist, but the destination file must not.
9119 * We don't want the OS to cache the writes, since the source data is
9120 * already in the OS cache.
9123 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
9124 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
9126 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL, 0666);
9128 if (newfd == INVALID_HANDLE_VALUE) {
9133 if (env->me_psize >= env->me_os_psize) {
9135 /* Set O_DIRECT if the file system supports it */
9136 if ((rc = fcntl(newfd, F_GETFL)) != -1)
9137 (void) fcntl(newfd, F_SETFL, rc | O_DIRECT);
9139 #ifdef F_NOCACHE /* __APPLE__ */
9140 rc = fcntl(newfd, F_NOCACHE, 1);
9148 rc = mdb_env_copyfd2(env, newfd, flags);
9151 if (!(env->me_flags & MDB_NOSUBDIR))
9153 if (newfd != INVALID_HANDLE_VALUE)
9154 if (close(newfd) < 0 && rc == MDB_SUCCESS)
9161 mdb_env_copy(MDB_env *env, const char *path)
9163 return mdb_env_copy2(env, path, 0);
9167 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
9169 if ((flag & CHANGEABLE) != flag)
9172 env->me_flags |= flag;
9174 env->me_flags &= ~flag;
9179 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
9184 *arg = env->me_flags;
9189 mdb_env_set_userctx(MDB_env *env, void *ctx)
9193 env->me_userctx = ctx;
9198 mdb_env_get_userctx(MDB_env *env)
9200 return env ? env->me_userctx : NULL;
9204 mdb_env_set_assert(MDB_env *env, MDB_assert_func *func)
9209 env->me_assert_func = func;
9215 mdb_env_get_path(MDB_env *env, const char **arg)
9220 *arg = env->me_path;
9225 mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *arg)
9234 /** Common code for #mdb_stat() and #mdb_env_stat().
9235 * @param[in] env the environment to operate in.
9236 * @param[in] db the #MDB_db record containing the stats to return.
9237 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
9238 * @return 0, this function always succeeds.
9241 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
9243 arg->ms_psize = env->me_psize;
9244 arg->ms_depth = db->md_depth;
9245 arg->ms_branch_pages = db->md_branch_pages;
9246 arg->ms_leaf_pages = db->md_leaf_pages;
9247 arg->ms_overflow_pages = db->md_overflow_pages;
9248 arg->ms_entries = db->md_entries;
9254 mdb_env_stat(MDB_env *env, MDB_stat *arg)
9258 if (env == NULL || arg == NULL)
9261 toggle = mdb_env_pick_meta(env);
9263 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
9267 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
9271 if (env == NULL || arg == NULL)
9274 toggle = mdb_env_pick_meta(env);
9275 arg->me_mapaddr = env->me_metas[toggle]->mm_address;
9276 arg->me_mapsize = env->me_mapsize;
9277 arg->me_maxreaders = env->me_maxreaders;
9278 arg->me_numreaders = env->me_txns ? env->me_txns->mti_numreaders : 0;
9280 arg->me_last_pgno = env->me_metas[toggle]->mm_last_pg;
9281 arg->me_last_txnid = env->me_metas[toggle]->mm_txnid;
9285 /** Set the default comparison functions for a database.
9286 * Called immediately after a database is opened to set the defaults.
9287 * The user can then override them with #mdb_set_compare() or
9288 * #mdb_set_dupsort().
9289 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
9290 * @param[in] dbi A database handle returned by #mdb_dbi_open()
9293 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
9295 uint16_t f = txn->mt_dbs[dbi].md_flags;
9297 txn->mt_dbxs[dbi].md_cmp =
9298 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
9299 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
9301 txn->mt_dbxs[dbi].md_dcmp =
9302 !(f & MDB_DUPSORT) ? 0 :
9303 ((f & MDB_INTEGERDUP)
9304 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
9305 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
9308 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
9314 int rc, dbflag, exact;
9315 unsigned int unused = 0, seq;
9318 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
9319 mdb_default_cmp(txn, FREE_DBI);
9322 if ((flags & VALID_FLAGS) != flags)
9324 if (txn->mt_flags & MDB_TXN_ERROR)
9330 if (flags & PERSISTENT_FLAGS) {
9331 uint16_t f2 = flags & PERSISTENT_FLAGS;
9332 /* make sure flag changes get committed */
9333 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
9334 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
9335 txn->mt_flags |= MDB_TXN_DIRTY;
9338 mdb_default_cmp(txn, MAIN_DBI);
9342 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
9343 mdb_default_cmp(txn, MAIN_DBI);
9346 /* Is the DB already open? */
9348 for (i=2; i<txn->mt_numdbs; i++) {
9349 if (!txn->mt_dbxs[i].md_name.mv_size) {
9350 /* Remember this free slot */
9351 if (!unused) unused = i;
9354 if (len == txn->mt_dbxs[i].md_name.mv_size &&
9355 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
9361 /* If no free slot and max hit, fail */
9362 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
9363 return MDB_DBS_FULL;
9365 /* Cannot mix named databases with some mainDB flags */
9366 if (txn->mt_dbs[MAIN_DBI].md_flags & (MDB_DUPSORT|MDB_INTEGERKEY))
9367 return (flags & MDB_CREATE) ? MDB_INCOMPATIBLE : MDB_NOTFOUND;
9369 /* Find the DB info */
9370 dbflag = DB_NEW|DB_VALID;
9373 key.mv_data = (void *)name;
9374 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
9375 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
9376 if (rc == MDB_SUCCESS) {
9377 /* make sure this is actually a DB */
9378 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
9379 if (!(node->mn_flags & F_SUBDATA))
9380 return MDB_INCOMPATIBLE;
9381 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
9382 /* Create if requested */
9383 data.mv_size = sizeof(MDB_db);
9384 data.mv_data = &dummy;
9385 memset(&dummy, 0, sizeof(dummy));
9386 dummy.md_root = P_INVALID;
9387 dummy.md_flags = flags & PERSISTENT_FLAGS;
9388 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
9392 /* OK, got info, add to table */
9393 if (rc == MDB_SUCCESS) {
9394 unsigned int slot = unused ? unused : txn->mt_numdbs;
9395 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
9396 txn->mt_dbxs[slot].md_name.mv_size = len;
9397 txn->mt_dbxs[slot].md_rel = NULL;
9398 txn->mt_dbflags[slot] = dbflag;
9399 /* txn-> and env-> are the same in read txns, use
9400 * tmp variable to avoid undefined assignment
9402 seq = ++txn->mt_env->me_dbiseqs[slot];
9403 txn->mt_dbiseqs[slot] = seq;
9405 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
9407 mdb_default_cmp(txn, slot);
9416 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
9418 if (!arg || !TXN_DBI_EXIST(txn, dbi))
9421 if (txn->mt_flags & MDB_TXN_ERROR)
9424 if (txn->mt_dbflags[dbi] & DB_STALE) {
9427 /* Stale, must read the DB's root. cursor_init does it for us. */
9428 mdb_cursor_init(&mc, txn, dbi, &mx);
9430 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
9433 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
9436 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
9438 ptr = env->me_dbxs[dbi].md_name.mv_data;
9439 /* If there was no name, this was already closed */
9441 env->me_dbxs[dbi].md_name.mv_data = NULL;
9442 env->me_dbxs[dbi].md_name.mv_size = 0;
9443 env->me_dbflags[dbi] = 0;
9444 env->me_dbiseqs[dbi]++;
9449 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags)
9451 /* We could return the flags for the FREE_DBI too but what's the point? */
9452 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9454 *flags = txn->mt_dbs[dbi].md_flags & PERSISTENT_FLAGS;
9458 /** Add all the DB's pages to the free list.
9459 * @param[in] mc Cursor on the DB to free.
9460 * @param[in] subs non-Zero to check for sub-DBs in this DB.
9461 * @return 0 on success, non-zero on failure.
9464 mdb_drop0(MDB_cursor *mc, int subs)
9468 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
9469 if (rc == MDB_SUCCESS) {
9470 MDB_txn *txn = mc->mc_txn;
9475 /* LEAF2 pages have no nodes, cannot have sub-DBs */
9476 if (IS_LEAF2(mc->mc_pg[mc->mc_top]))
9479 mdb_cursor_copy(mc, &mx);
9480 while (mc->mc_snum > 0) {
9481 MDB_page *mp = mc->mc_pg[mc->mc_top];
9482 unsigned n = NUMKEYS(mp);
9484 for (i=0; i<n; i++) {
9485 ni = NODEPTR(mp, i);
9486 if (ni->mn_flags & F_BIGDATA) {
9489 memcpy(&pg, NODEDATA(ni), sizeof(pg));
9490 rc = mdb_page_get(txn, pg, &omp, NULL);
9493 mdb_cassert(mc, IS_OVERFLOW(omp));
9494 rc = mdb_midl_append_range(&txn->mt_free_pgs,
9498 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
9499 mdb_xcursor_init1(mc, ni);
9500 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
9506 if ((rc = mdb_midl_need(&txn->mt_free_pgs, n)) != 0)
9508 for (i=0; i<n; i++) {
9510 ni = NODEPTR(mp, i);
9513 mdb_midl_xappend(txn->mt_free_pgs, pg);
9518 mc->mc_ki[mc->mc_top] = i;
9519 rc = mdb_cursor_sibling(mc, 1);
9521 if (rc != MDB_NOTFOUND)
9523 /* no more siblings, go back to beginning
9524 * of previous level.
9528 for (i=1; i<mc->mc_snum; i++) {
9530 mc->mc_pg[i] = mx.mc_pg[i];
9535 rc = mdb_midl_append(&txn->mt_free_pgs, mc->mc_db->md_root);
9538 txn->mt_flags |= MDB_TXN_ERROR;
9539 } else if (rc == MDB_NOTFOUND) {
9545 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
9547 MDB_cursor *mc, *m2;
9550 if ((unsigned)del > 1 || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9553 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
9556 if (dbi > MAIN_DBI && TXN_DBI_CHANGED(txn, dbi))
9559 rc = mdb_cursor_open(txn, dbi, &mc);
9563 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
9564 /* Invalidate the dropped DB's cursors */
9565 for (m2 = txn->mt_cursors[dbi]; m2; m2 = m2->mc_next)
9566 m2->mc_flags &= ~(C_INITIALIZED|C_EOF);
9570 /* Can't delete the main DB */
9571 if (del && dbi > MAIN_DBI) {
9572 rc = mdb_del0(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL, 0);
9574 txn->mt_dbflags[dbi] = DB_STALE;
9575 mdb_dbi_close(txn->mt_env, dbi);
9577 txn->mt_flags |= MDB_TXN_ERROR;
9580 /* reset the DB record, mark it dirty */
9581 txn->mt_dbflags[dbi] |= DB_DIRTY;
9582 txn->mt_dbs[dbi].md_depth = 0;
9583 txn->mt_dbs[dbi].md_branch_pages = 0;
9584 txn->mt_dbs[dbi].md_leaf_pages = 0;
9585 txn->mt_dbs[dbi].md_overflow_pages = 0;
9586 txn->mt_dbs[dbi].md_entries = 0;
9587 txn->mt_dbs[dbi].md_root = P_INVALID;
9589 txn->mt_flags |= MDB_TXN_DIRTY;
9592 mdb_cursor_close(mc);
9596 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9598 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9601 txn->mt_dbxs[dbi].md_cmp = cmp;
9605 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9607 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9610 txn->mt_dbxs[dbi].md_dcmp = cmp;
9614 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
9616 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9619 txn->mt_dbxs[dbi].md_rel = rel;
9623 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
9625 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9628 txn->mt_dbxs[dbi].md_relctx = ctx;
9633 mdb_env_get_maxkeysize(MDB_env *env)
9635 return ENV_MAXKEY(env);
9639 mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx)
9641 unsigned int i, rdrs;
9644 int rc = 0, first = 1;
9648 if (!env->me_txns) {
9649 return func("(no reader locks)\n", ctx);
9651 rdrs = env->me_txns->mti_numreaders;
9652 mr = env->me_txns->mti_readers;
9653 for (i=0; i<rdrs; i++) {
9655 txnid_t txnid = mr[i].mr_txnid;
9656 sprintf(buf, txnid == (txnid_t)-1 ?
9657 "%10d %"Z"x -\n" : "%10d %"Z"x %"Z"u\n",
9658 (int)mr[i].mr_pid, (size_t)mr[i].mr_tid, txnid);
9661 rc = func(" pid thread txnid\n", ctx);
9665 rc = func(buf, ctx);
9671 rc = func("(no active readers)\n", ctx);
9676 /** Insert pid into list if not already present.
9677 * return -1 if already present.
9680 mdb_pid_insert(MDB_PID_T *ids, MDB_PID_T pid)
9682 /* binary search of pid in list */
9684 unsigned cursor = 1;
9686 unsigned n = ids[0];
9689 unsigned pivot = n >> 1;
9690 cursor = base + pivot + 1;
9691 val = pid - ids[cursor];
9696 } else if ( val > 0 ) {
9701 /* found, so it's a duplicate */
9710 for (n = ids[0]; n > cursor; n--)
9717 mdb_reader_check(MDB_env *env, int *dead)
9723 return env->me_txns ? mdb_reader_check0(env, 0, dead) : MDB_SUCCESS;
9726 /** As #mdb_reader_check(). rlocked = <caller locked the reader mutex>. */
9727 static int mdb_reader_check0(MDB_env *env, int rlocked, int *dead)
9729 mdb_mutexref_t rmutex = rlocked ? NULL : env->me_rmutex;
9730 unsigned int i, j, rdrs;
9732 MDB_PID_T *pids, pid;
9733 int rc = MDB_SUCCESS, count = 0;
9735 rdrs = env->me_txns->mti_numreaders;
9736 pids = malloc((rdrs+1) * sizeof(MDB_PID_T));
9740 mr = env->me_txns->mti_readers;
9741 for (i=0; i<rdrs; i++) {
9743 if (pid && pid != env->me_pid) {
9744 if (mdb_pid_insert(pids, pid) == 0) {
9745 if (!mdb_reader_pid(env, Pidcheck, pid)) {
9746 /* Stale reader found */
9749 if ((rc = LOCK_MUTEX0(rmutex)) != 0) {
9750 if ((rc = mdb_mutex_failed(env, rmutex, rc)))
9752 rdrs = 0; /* the above checked all readers */
9754 /* Recheck, a new process may have reused pid */
9755 if (mdb_reader_pid(env, Pidcheck, pid))
9760 if (mr[j].mr_pid == pid) {
9761 DPRINTF(("clear stale reader pid %u txn %"Z"d",
9762 (unsigned) pid, mr[j].mr_txnid));
9767 UNLOCK_MUTEX(rmutex);
9778 #ifdef MDB_ROBUST_SUPPORTED
9779 /** Handle #LOCK_MUTEX0() failure.
9780 * Try to repair the lock file if the mutex owner died.
9781 * @param[in] env the environment handle
9782 * @param[in] mutex LOCK_MUTEX0() mutex
9783 * @param[in] rc LOCK_MUTEX0() error (nonzero)
9784 * @return 0 on success with the mutex locked, or an error code on failure.
9786 static int mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc)
9788 int toggle, rlocked, rc2;
9790 if (rc == MDB_OWNERDEAD) {
9791 /* We own the mutex. Clean up after dead previous owner. */
9793 rlocked = (mutex == env->me_rmutex);
9795 /* Keep mti_txnid updated, otherwise next writer can
9796 * overwrite data which latest meta page refers to.
9798 toggle = mdb_env_pick_meta(env);
9799 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
9800 /* env is hosed if the dead thread was ours */
9802 env->me_flags |= MDB_FATAL_ERROR;
9807 DPRINTF(("%cmutex owner died, %s", (rlocked ? 'r' : 'w'),
9808 (rc ? "this process' env is hosed" : "recovering")));
9809 rc2 = mdb_reader_check0(env, rlocked, NULL);
9811 rc2 = mdb_mutex_consistent(mutex);
9812 if (rc || (rc = rc2)) {
9813 DPRINTF(("LOCK_MUTEX recovery failed, %s", mdb_strerror(rc)));
9814 UNLOCK_MUTEX(mutex);
9820 DPRINTF(("LOCK_MUTEX failed, %s", mdb_strerror(rc)));
9825 #endif /* MDB_ROBUST_SUPPORTED */
projects / openldap / blob