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
102 typedef SSIZE_T ssize_t;
107 #if defined(__sun) || defined(ANDROID)
108 /* Most platforms have posix_memalign, older may only have memalign */
109 #define HAVE_MEMALIGN 1
113 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
114 #include <netinet/in.h>
115 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
118 #if defined(__APPLE__) || defined (BSD)
119 # if !(defined(MDB_USE_POSIX_MUTEX) || defined(MDB_USE_POSIX_SEM))
120 # define MDB_USE_SYSV_SEM 1
122 # define MDB_FDATASYNC fsync
123 #elif defined(ANDROID)
124 # define MDB_FDATASYNC fsync
129 #ifdef MDB_USE_POSIX_SEM
130 # define MDB_USE_HASH 1
131 #include <semaphore.h>
132 #elif defined(MDB_USE_SYSV_SEM)
135 #ifdef _SEM_SEMUN_UNDEFINED
138 struct semid_ds *buf;
139 unsigned short *array;
141 #endif /* _SEM_SEMUN_UNDEFINED */
143 #define MDB_USE_POSIX_MUTEX 1
144 #endif /* MDB_USE_POSIX_SEM */
147 #if defined(_WIN32) + defined(MDB_USE_POSIX_SEM) + defined(MDB_USE_SYSV_SEM) \
148 + defined(MDB_USE_POSIX_MUTEX) != 1
149 # error "Ambiguous shared-lock implementation"
153 #include <valgrind/memcheck.h>
154 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
155 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
156 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
157 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
158 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
160 #define VGMEMP_CREATE(h,r,z)
161 #define VGMEMP_ALLOC(h,a,s)
162 #define VGMEMP_FREE(h,a)
163 #define VGMEMP_DESTROY(h)
164 #define VGMEMP_DEFINED(a,s)
168 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
169 /* Solaris just defines one or the other */
170 # define LITTLE_ENDIAN 1234
171 # define BIG_ENDIAN 4321
172 # ifdef _LITTLE_ENDIAN
173 # define BYTE_ORDER LITTLE_ENDIAN
175 # define BYTE_ORDER BIG_ENDIAN
178 # define BYTE_ORDER __BYTE_ORDER
182 #ifndef LITTLE_ENDIAN
183 #define LITTLE_ENDIAN __LITTLE_ENDIAN
186 #define BIG_ENDIAN __BIG_ENDIAN
189 #if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
190 #define MISALIGNED_OK 1
196 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
197 # error "Unknown or unsupported endianness (BYTE_ORDER)"
198 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
199 # error "Two's complement, reasonably sized integer types, please"
203 /** Put infrequently used env functions in separate section */
205 # define ESECT __attribute__ ((section("__TEXT,text_env")))
207 # define ESECT __attribute__ ((section("text_env")))
213 /** @defgroup internal LMDB Internals
216 /** @defgroup compat Compatibility Macros
217 * A bunch of macros to minimize the amount of platform-specific ifdefs
218 * needed throughout the rest of the code. When the features this library
219 * needs are similar enough to POSIX to be hidden in a one-or-two line
220 * replacement, this macro approach is used.
224 /** Features under development */
229 /** Wrapper around __func__, which is a C99 feature */
230 #if __STDC_VERSION__ >= 199901L
231 # define mdb_func_ __func__
232 #elif __GNUC__ >= 2 || _MSC_VER >= 1300
233 # define mdb_func_ __FUNCTION__
235 /* If a debug message says <mdb_unknown>(), update the #if statements above */
236 # define mdb_func_ "<mdb_unknown>"
239 /* Internal error codes, not exposed outside liblmdb */
240 #define MDB_NO_ROOT (MDB_LAST_ERRCODE + 10)
242 #define MDB_OWNERDEAD ((int) WAIT_ABANDONED)
243 #elif defined MDB_USE_SYSV_SEM
244 #define MDB_OWNERDEAD (MDB_LAST_ERRCODE + 11)
245 #elif defined(MDB_USE_POSIX_MUTEX) && defined(EOWNERDEAD)
246 #define MDB_OWNERDEAD EOWNERDEAD /**< #LOCK_MUTEX0() result if dead owner */
250 #define MDB_ROBUST_SUPPORTED 1
254 #define MDB_USE_HASH 1
255 #define MDB_PIDLOCK 0
256 #define THREAD_RET DWORD
257 #define pthread_t HANDLE
258 #define pthread_mutex_t HANDLE
259 #define pthread_cond_t HANDLE
260 typedef HANDLE mdb_mutex_t, mdb_mutexref_t;
261 #define pthread_key_t DWORD
262 #define pthread_self() GetCurrentThreadId()
263 #define pthread_key_create(x,y) \
264 ((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
265 #define pthread_key_delete(x) TlsFree(x)
266 #define pthread_getspecific(x) TlsGetValue(x)
267 #define pthread_setspecific(x,y) (TlsSetValue(x,y) ? 0 : ErrCode())
268 #define pthread_mutex_unlock(x) ReleaseMutex(*x)
269 #define pthread_mutex_lock(x) WaitForSingleObject(*x, INFINITE)
270 #define pthread_cond_signal(x) SetEvent(*x)
271 #define pthread_cond_wait(cond,mutex) do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
272 #define THREAD_CREATE(thr,start,arg) thr=CreateThread(NULL,0,start,arg,0,NULL)
273 #define THREAD_FINISH(thr) WaitForSingleObject(thr, INFINITE)
274 #define LOCK_MUTEX0(mutex) WaitForSingleObject(mutex, INFINITE)
275 #define UNLOCK_MUTEX(mutex) ReleaseMutex(mutex)
276 #define mdb_mutex_consistent(mutex) 0
277 #define getpid() GetCurrentProcessId()
278 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
279 #define MDB_MSYNC(addr,len,flags) (!FlushViewOfFile(addr,len))
280 #define ErrCode() GetLastError()
281 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
282 #define close(fd) (CloseHandle(fd) ? 0 : -1)
283 #define munmap(ptr,len) UnmapViewOfFile(ptr)
284 #ifdef PROCESS_QUERY_LIMITED_INFORMATION
285 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
287 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
291 #define THREAD_RET void *
292 #define THREAD_CREATE(thr,start,arg) pthread_create(&thr,NULL,start,arg)
293 #define THREAD_FINISH(thr) pthread_join(thr,NULL)
294 #define Z "z" /**< printf format modifier for size_t */
296 /** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
297 #define MDB_PIDLOCK 1
299 #ifdef MDB_USE_POSIX_SEM
301 typedef sem_t *mdb_mutex_t, *mdb_mutexref_t;
302 #define LOCK_MUTEX0(mutex) mdb_sem_wait(mutex)
303 #define UNLOCK_MUTEX(mutex) sem_post(mutex)
306 mdb_sem_wait(sem_t *sem)
309 while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
313 #elif defined MDB_USE_SYSV_SEM
315 typedef struct mdb_mutex {
319 } mdb_mutex_t[1], *mdb_mutexref_t;
321 #define LOCK_MUTEX0(mutex) mdb_sem_wait(mutex)
322 #define UNLOCK_MUTEX(mutex) do { \
323 struct sembuf sb = { 0, 1, SEM_UNDO }; \
324 sb.sem_num = (mutex)->semnum; \
325 *(mutex)->locked = 0; \
326 semop((mutex)->semid, &sb, 1); \
330 mdb_sem_wait(mdb_mutexref_t sem)
332 int rc, *locked = sem->locked;
333 struct sembuf sb = { 0, -1, SEM_UNDO };
334 sb.sem_num = sem->semnum;
336 if (!semop(sem->semid, &sb, 1)) {
337 rc = *locked ? MDB_OWNERDEAD : MDB_SUCCESS;
341 } while ((rc = errno) == EINTR);
345 #define mdb_mutex_consistent(mutex) 0
347 #else /* MDB_USE_POSIX_MUTEX: */
348 /** Shared mutex/semaphore as it is stored (mdb_mutex_t), and as
349 * local variables keep it (mdb_mutexref_t).
351 * An mdb_mutex_t can be assigned to an mdb_mutexref_t. They can
352 * be the same, or an array[size 1] and a pointer.
355 typedef pthread_mutex_t mdb_mutex_t[1], *mdb_mutexref_t;
357 /** Lock the reader or writer mutex.
358 * Returns 0 or a code to give #mdb_mutex_failed(), as in #LOCK_MUTEX().
360 #define LOCK_MUTEX0(mutex) pthread_mutex_lock(mutex)
361 /** Unlock the reader or writer mutex.
363 #define UNLOCK_MUTEX(mutex) pthread_mutex_unlock(mutex)
364 /** Mark mutex-protected data as repaired, after death of previous owner.
366 #define mdb_mutex_consistent(mutex) pthread_mutex_consistent(mutex)
367 #endif /* MDB_USE_POSIX_SEM || MDB_USE_SYSV_SEM */
369 /** Get the error code for the last failed system function.
371 #define ErrCode() errno
373 /** An abstraction for a file handle.
374 * On POSIX systems file handles are small integers. On Windows
375 * they're opaque pointers.
379 /** A value for an invalid file handle.
380 * Mainly used to initialize file variables and signify that they are
383 #define INVALID_HANDLE_VALUE (-1)
385 /** Get the size of a memory page for the system.
386 * This is the basic size that the platform's memory manager uses, and is
387 * fundamental to the use of memory-mapped files.
389 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
392 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
394 #elif defined(MDB_USE_SYSV_SEM)
395 #define MNAME_LEN (sizeof(int))
397 #define MNAME_LEN (sizeof(pthread_mutex_t))
400 #ifdef MDB_USE_SYSV_SEM
401 #define SYSV_SEM_FLAG 1 /**< SysV sems in lockfile format */
403 #define SYSV_SEM_FLAG 0
408 #ifdef MDB_ROBUST_SUPPORTED
409 /** Lock mutex, handle any error, set rc = result.
410 * Return 0 on success, nonzero (not rc) on error.
412 #define LOCK_MUTEX(rc, env, mutex) \
413 (((rc) = LOCK_MUTEX0(mutex)) && \
414 ((rc) = mdb_mutex_failed(env, mutex, rc)))
415 static int mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc);
417 #define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
418 #define mdb_mutex_failed(env, mutex, rc) (rc)
422 /** A flag for opening a file and requesting synchronous data writes.
423 * This is only used when writing a meta page. It's not strictly needed;
424 * we could just do a normal write and then immediately perform a flush.
425 * But if this flag is available it saves us an extra system call.
427 * @note If O_DSYNC is undefined but exists in /usr/include,
428 * preferably set some compiler flag to get the definition.
429 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
432 # define MDB_DSYNC O_DSYNC
436 /** Function for flushing the data of a file. Define this to fsync
437 * if fdatasync() is not supported.
439 #ifndef MDB_FDATASYNC
440 # define MDB_FDATASYNC fdatasync
444 # define MDB_MSYNC(addr,len,flags) msync(addr,len,flags)
455 /** A page number in the database.
456 * Note that 64 bit page numbers are overkill, since pages themselves
457 * already represent 12-13 bits of addressable memory, and the OS will
458 * always limit applications to a maximum of 63 bits of address space.
460 * @note In the #MDB_node structure, we only store 48 bits of this value,
461 * which thus limits us to only 60 bits of addressable data.
463 typedef MDB_ID pgno_t;
465 /** A transaction ID.
466 * See struct MDB_txn.mt_txnid for details.
468 typedef MDB_ID txnid_t;
470 /** @defgroup debug Debug Macros
474 /** Enable debug output. Needs variable argument macros (a C99 feature).
475 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
476 * read from and written to the database (used for free space management).
482 static int mdb_debug;
483 static txnid_t mdb_debug_start;
485 /** Print a debug message with printf formatting.
486 * Requires double parenthesis around 2 or more args.
488 # define DPRINTF(args) ((void) ((mdb_debug) && DPRINTF0 args))
489 # define DPRINTF0(fmt, ...) \
490 fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
492 # define DPRINTF(args) ((void) 0)
494 /** Print a debug string.
495 * The string is printed literally, with no format processing.
497 #define DPUTS(arg) DPRINTF(("%s", arg))
498 /** Debuging output value of a cursor DBI: Negative in a sub-cursor. */
500 (((mc)->mc_flags & C_SUB) ? -(int)(mc)->mc_dbi : (int)(mc)->mc_dbi)
503 /** @brief The maximum size of a database page.
505 * It is 32k or 64k, since value-PAGEBASE must fit in
506 * #MDB_page.%mp_upper.
508 * LMDB will use database pages < OS pages if needed.
509 * That causes more I/O in write transactions: The OS must
510 * know (read) the whole page before writing a partial page.
512 * Note that we don't currently support Huge pages. On Linux,
513 * regular data files cannot use Huge pages, and in general
514 * Huge pages aren't actually pageable. We rely on the OS
515 * demand-pager to read our data and page it out when memory
516 * pressure from other processes is high. So until OSs have
517 * actual paging support for Huge pages, they're not viable.
519 #define MAX_PAGESIZE (PAGEBASE ? 0x10000 : 0x8000)
521 /** The minimum number of keys required in a database page.
522 * Setting this to a larger value will place a smaller bound on the
523 * maximum size of a data item. Data items larger than this size will
524 * be pushed into overflow pages instead of being stored directly in
525 * the B-tree node. This value used to default to 4. With a page size
526 * of 4096 bytes that meant that any item larger than 1024 bytes would
527 * go into an overflow page. That also meant that on average 2-3KB of
528 * each overflow page was wasted space. The value cannot be lower than
529 * 2 because then there would no longer be a tree structure. With this
530 * value, items larger than 2KB will go into overflow pages, and on
531 * average only 1KB will be wasted.
533 #define MDB_MINKEYS 2
535 /** A stamp that identifies a file as an LMDB file.
536 * There's nothing special about this value other than that it is easily
537 * recognizable, and it will reflect any byte order mismatches.
539 #define MDB_MAGIC 0xBEEFC0DE
541 /** The version number for a database's datafile format. */
542 #define MDB_DATA_VERSION ((MDB_DEVEL) ? 999 : 1)
543 /** The version number for a database's lockfile format. */
544 #define MDB_LOCK_VERSION ((MDB_DEVEL) ? 999 : 1)
546 /** @brief The max size of a key we can write, or 0 for computed max.
548 * This macro should normally be left alone or set to 0.
549 * Note that a database with big keys or dupsort data cannot be
550 * reliably modified by a liblmdb which uses a smaller max.
551 * The default is 511 for backwards compat, or 0 when #MDB_DEVEL.
553 * Other values are allowed, for backwards compat. However:
554 * A value bigger than the computed max can break if you do not
555 * know what you are doing, and liblmdb <= 0.9.10 can break when
556 * modifying a DB with keys/dupsort data bigger than its max.
558 * Data items in an #MDB_DUPSORT database are also limited to
559 * this size, since they're actually keys of a sub-DB. Keys and
560 * #MDB_DUPSORT data items must fit on a node in a regular page.
562 #ifndef MDB_MAXKEYSIZE
563 #define MDB_MAXKEYSIZE ((MDB_DEVEL) ? 0 : 511)
566 /** The maximum size of a key we can write to the environment. */
568 #define ENV_MAXKEY(env) (MDB_MAXKEYSIZE)
570 #define ENV_MAXKEY(env) ((env)->me_maxkey)
573 /** @brief The maximum size of a data item.
575 * We only store a 32 bit value for node sizes.
577 #define MAXDATASIZE 0xffffffffUL
580 /** Key size which fits in a #DKBUF.
583 #define DKBUF_MAXKEYSIZE ((MDB_MAXKEYSIZE) > 0 ? (MDB_MAXKEYSIZE) : 511)
586 * This is used for printing a hex dump of a key's contents.
588 #define DKBUF char kbuf[DKBUF_MAXKEYSIZE*2+1]
589 /** Display a key in hex.
591 * Invoke a function to display a key in hex.
593 #define DKEY(x) mdb_dkey(x, kbuf)
599 /** An invalid page number.
600 * Mainly used to denote an empty tree.
602 #define P_INVALID (~(pgno_t)0)
604 /** Test if the flags \b f are set in a flag word \b w. */
605 #define F_ISSET(w, f) (((w) & (f)) == (f))
607 /** Round \b n up to an even number. */
608 #define EVEN(n) (((n) + 1U) & -2) /* sign-extending -2 to match n+1U */
610 /** Used for offsets within a single page.
611 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
614 typedef uint16_t indx_t;
616 /** Default size of memory map.
617 * This is certainly too small for any actual applications. Apps should always set
618 * the size explicitly using #mdb_env_set_mapsize().
620 #define DEFAULT_MAPSIZE 1048576
622 /** @defgroup readers Reader Lock Table
623 * Readers don't acquire any locks for their data access. Instead, they
624 * simply record their transaction ID in the reader table. The reader
625 * mutex is needed just to find an empty slot in the reader table. The
626 * slot's address is saved in thread-specific data so that subsequent read
627 * transactions started by the same thread need no further locking to proceed.
629 * If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
631 * No reader table is used if the database is on a read-only filesystem, or
632 * if #MDB_NOLOCK is set.
634 * Since the database uses multi-version concurrency control, readers don't
635 * actually need any locking. This table is used to keep track of which
636 * readers are using data from which old transactions, so that we'll know
637 * when a particular old transaction is no longer in use. Old transactions
638 * that have discarded any data pages can then have those pages reclaimed
639 * for use by a later write transaction.
641 * The lock table is constructed such that reader slots are aligned with the
642 * processor's cache line size. Any slot is only ever used by one thread.
643 * This alignment guarantees that there will be no contention or cache
644 * thrashing as threads update their own slot info, and also eliminates
645 * any need for locking when accessing a slot.
647 * A writer thread will scan every slot in the table to determine the oldest
648 * outstanding reader transaction. Any freed pages older than this will be
649 * reclaimed by the writer. The writer doesn't use any locks when scanning
650 * this table. This means that there's no guarantee that the writer will
651 * see the most up-to-date reader info, but that's not required for correct
652 * operation - all we need is to know the upper bound on the oldest reader,
653 * we don't care at all about the newest reader. So the only consequence of
654 * reading stale information here is that old pages might hang around a
655 * while longer before being reclaimed. That's actually good anyway, because
656 * the longer we delay reclaiming old pages, the more likely it is that a
657 * string of contiguous pages can be found after coalescing old pages from
658 * many old transactions together.
661 /** Number of slots in the reader table.
662 * This value was chosen somewhat arbitrarily. 126 readers plus a
663 * couple mutexes fit exactly into 8KB on my development machine.
664 * Applications should set the table size using #mdb_env_set_maxreaders().
666 #define DEFAULT_READERS 126
668 /** The size of a CPU cache line in bytes. We want our lock structures
669 * aligned to this size to avoid false cache line sharing in the
671 * This value works for most CPUs. For Itanium this should be 128.
677 /** The information we store in a single slot of the reader table.
678 * In addition to a transaction ID, we also record the process and
679 * thread ID that owns a slot, so that we can detect stale information,
680 * e.g. threads or processes that went away without cleaning up.
681 * @note We currently don't check for stale records. We simply re-init
682 * the table when we know that we're the only process opening the
685 typedef struct MDB_rxbody {
686 /** Current Transaction ID when this transaction began, or (txnid_t)-1.
687 * Multiple readers that start at the same time will probably have the
688 * same ID here. Again, it's not important to exclude them from
689 * anything; all we need to know is which version of the DB they
690 * started from so we can avoid overwriting any data used in that
691 * particular version.
693 volatile txnid_t mrb_txnid;
694 /** The process ID of the process owning this reader txn. */
695 volatile MDB_PID_T mrb_pid;
696 /** The thread ID of the thread owning this txn. */
697 volatile MDB_THR_T mrb_tid;
700 /** The actual reader record, with cacheline padding. */
701 typedef struct MDB_reader {
704 /** shorthand for mrb_txnid */
705 #define mr_txnid mru.mrx.mrb_txnid
706 #define mr_pid mru.mrx.mrb_pid
707 #define mr_tid mru.mrx.mrb_tid
708 /** cache line alignment */
709 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
713 /** The header for the reader table.
714 * The table resides in a memory-mapped file. (This is a different file
715 * than is used for the main database.)
717 * For POSIX the actual mutexes reside in the shared memory of this
718 * mapped file. On Windows, mutexes are named objects allocated by the
719 * kernel; we store the mutex names in this mapped file so that other
720 * processes can grab them. This same approach is also used on
721 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
722 * process-shared POSIX mutexes. For these cases where a named object
723 * is used, the object name is derived from a 64 bit FNV hash of the
724 * environment pathname. As such, naming collisions are extremely
725 * unlikely. If a collision occurs, the results are unpredictable.
727 typedef struct MDB_txbody {
728 /** Stamp identifying this as an LMDB file. It must be set
731 /** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
733 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
734 char mtb_rmname[MNAME_LEN];
735 #elif defined(MDB_USE_SYSV_SEM)
739 /** Mutex protecting access to this table.
740 * This is the reader table lock used with LOCK_MUTEX().
742 mdb_mutex_t mtb_rmutex;
744 /** The ID of the last transaction committed to the database.
745 * This is recorded here only for convenience; the value can always
746 * be determined by reading the main database meta pages.
748 volatile txnid_t mtb_txnid;
749 /** The number of slots that have been used in the reader table.
750 * This always records the maximum count, it is not decremented
751 * when readers release their slots.
753 volatile unsigned mtb_numreaders;
756 /** The actual reader table definition. */
757 typedef struct MDB_txninfo {
760 #define mti_magic mt1.mtb.mtb_magic
761 #define mti_format mt1.mtb.mtb_format
762 #define mti_rmutex mt1.mtb.mtb_rmutex
763 #define mti_rmname mt1.mtb.mtb_rmname
764 #define mti_txnid mt1.mtb.mtb_txnid
765 #define mti_numreaders mt1.mtb.mtb_numreaders
766 #ifdef MDB_USE_SYSV_SEM
767 #define mti_semid mt1.mtb.mtb_semid
768 #define mti_rlocked mt1.mtb.mtb_rlocked
770 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
773 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
774 char mt2_wmname[MNAME_LEN];
775 #define mti_wmname mt2.mt2_wmname
776 #elif defined MDB_USE_SYSV_SEM
778 #define mti_wlocked mt2.mt2_wlocked
780 mdb_mutex_t mt2_wmutex;
781 #define mti_wmutex mt2.mt2_wmutex
783 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
785 MDB_reader mti_readers[1];
788 /** Lockfile format signature: version, features and field layout */
789 #define MDB_LOCK_FORMAT \
791 ((MDB_LOCK_VERSION) \
792 /* Flags which describe functionality */ \
793 + (SYSV_SEM_FLAG << 18) \
794 + (((MDB_PIDLOCK) != 0) << 16)))
797 /** Common header for all page types.
798 * Overflow records occupy a number of contiguous pages with no
799 * headers on any page after the first.
801 typedef struct MDB_page {
802 #define mp_pgno mp_p.p_pgno
803 #define mp_next mp_p.p_next
805 pgno_t p_pgno; /**< page number */
806 struct MDB_page *p_next; /**< for in-memory list of freed pages */
809 /** @defgroup mdb_page Page Flags
811 * Flags for the page headers.
814 #define P_BRANCH 0x01 /**< branch page */
815 #define P_LEAF 0x02 /**< leaf page */
816 #define P_OVERFLOW 0x04 /**< overflow page */
817 #define P_META 0x08 /**< meta page */
818 #define P_DIRTY 0x10 /**< dirty page, also set for #P_SUBP pages */
819 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
820 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
821 #define P_LOOSE 0x4000 /**< page was dirtied then freed, can be reused */
822 #define P_KEEP 0x8000 /**< leave this page alone during spill */
824 uint16_t mp_flags; /**< @ref mdb_page */
825 #define mp_lower mp_pb.pb.pb_lower
826 #define mp_upper mp_pb.pb.pb_upper
827 #define mp_pages mp_pb.pb_pages
830 indx_t pb_lower; /**< lower bound of free space */
831 indx_t pb_upper; /**< upper bound of free space */
833 uint32_t pb_pages; /**< number of overflow pages */
835 indx_t mp_ptrs[1]; /**< dynamic size */
838 /** Size of the page header, excluding dynamic data at the end */
839 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
841 /** Address of first usable data byte in a page, after the header */
842 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
844 /** ITS#7713, change PAGEBASE to handle 65536 byte pages */
845 #define PAGEBASE ((MDB_DEVEL) ? PAGEHDRSZ : 0)
847 /** Number of nodes on a page */
848 #define NUMKEYS(p) (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
850 /** The amount of space remaining in the page */
851 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
853 /** The percentage of space used in the page, in tenths of a percent. */
854 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
855 ((env)->me_psize - PAGEHDRSZ))
856 /** The minimum page fill factor, in tenths of a percent.
857 * Pages emptier than this are candidates for merging.
859 #define FILL_THRESHOLD 250
861 /** Test if a page is a leaf page */
862 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
863 /** Test if a page is a LEAF2 page */
864 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
865 /** Test if a page is a branch page */
866 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
867 /** Test if a page is an overflow page */
868 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
869 /** Test if a page is a sub page */
870 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
872 /** The number of overflow pages needed to store the given size. */
873 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
875 /** Link in #MDB_txn.%mt_loose_pgs list */
876 #define NEXT_LOOSE_PAGE(p) (*(MDB_page **)((p) + 2))
878 /** Header for a single key/data pair within a page.
879 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
880 * We guarantee 2-byte alignment for 'MDB_node's.
882 typedef struct MDB_node {
883 /** lo and hi are used for data size on leaf nodes and for
884 * child pgno on branch nodes. On 64 bit platforms, flags
885 * is also used for pgno. (Branch nodes have no flags).
886 * They are in host byte order in case that lets some
887 * accesses be optimized into a 32-bit word access.
889 #if BYTE_ORDER == LITTLE_ENDIAN
890 unsigned short mn_lo, mn_hi; /**< part of data size or pgno */
892 unsigned short mn_hi, mn_lo;
894 /** @defgroup mdb_node Node Flags
896 * Flags for node headers.
899 #define F_BIGDATA 0x01 /**< data put on overflow page */
900 #define F_SUBDATA 0x02 /**< data is a sub-database */
901 #define F_DUPDATA 0x04 /**< data has duplicates */
903 /** valid flags for #mdb_node_add() */
904 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
907 unsigned short mn_flags; /**< @ref mdb_node */
908 unsigned short mn_ksize; /**< key size */
909 char mn_data[1]; /**< key and data are appended here */
912 /** Size of the node header, excluding dynamic data at the end */
913 #define NODESIZE offsetof(MDB_node, mn_data)
915 /** Bit position of top word in page number, for shifting mn_flags */
916 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
918 /** Size of a node in a branch page with a given key.
919 * This is just the node header plus the key, there is no data.
921 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
923 /** Size of a node in a leaf page with a given key and data.
924 * This is node header plus key plus data size.
926 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
928 /** Address of node \b i in page \b p */
929 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
931 /** Address of the key for the node */
932 #define NODEKEY(node) (void *)((node)->mn_data)
934 /** Address of the data for a node */
935 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
937 /** Get the page number pointed to by a branch node */
938 #define NODEPGNO(node) \
939 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
940 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
941 /** Set the page number in a branch node */
942 #define SETPGNO(node,pgno) do { \
943 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
944 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
946 /** Get the size of the data in a leaf node */
947 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
948 /** Set the size of the data for a leaf node */
949 #define SETDSZ(node,size) do { \
950 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
951 /** The size of a key in a node */
952 #define NODEKSZ(node) ((node)->mn_ksize)
954 /** Copy a page number from src to dst */
956 #define COPY_PGNO(dst,src) dst = src
958 #if SIZE_MAX > 4294967295UL
959 #define COPY_PGNO(dst,src) do { \
960 unsigned short *s, *d; \
961 s = (unsigned short *)&(src); \
962 d = (unsigned short *)&(dst); \
969 #define COPY_PGNO(dst,src) do { \
970 unsigned short *s, *d; \
971 s = (unsigned short *)&(src); \
972 d = (unsigned short *)&(dst); \
978 /** The address of a key in a LEAF2 page.
979 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
980 * There are no node headers, keys are stored contiguously.
982 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
984 /** Set the \b node's key into \b keyptr, if requested. */
985 #define MDB_GET_KEY(node, keyptr) { if ((keyptr) != NULL) { \
986 (keyptr)->mv_size = NODEKSZ(node); (keyptr)->mv_data = NODEKEY(node); } }
988 /** Set the \b node's key into \b key. */
989 #define MDB_GET_KEY2(node, key) { key.mv_size = NODEKSZ(node); key.mv_data = NODEKEY(node); }
991 /** Information about a single database in the environment. */
992 typedef struct MDB_db {
993 uint32_t md_pad; /**< also ksize for LEAF2 pages */
994 uint16_t md_flags; /**< @ref mdb_dbi_open */
995 uint16_t md_depth; /**< depth of this tree */
996 pgno_t md_branch_pages; /**< number of internal pages */
997 pgno_t md_leaf_pages; /**< number of leaf pages */
998 pgno_t md_overflow_pages; /**< number of overflow pages */
999 size_t md_entries; /**< number of data items */
1000 pgno_t md_root; /**< the root page of this tree */
1003 /** mdb_dbi_open flags */
1004 #define MDB_VALID 0x8000 /**< DB handle is valid, for me_dbflags */
1005 #define PERSISTENT_FLAGS (0xffff & ~(MDB_VALID))
1006 #define VALID_FLAGS (MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
1007 MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)
1009 /** Handle for the DB used to track free pages. */
1011 /** Handle for the default DB. */
1013 /** Number of DBs in metapage (free and main) - also hardcoded elsewhere */
1016 /** Number of meta pages - also hardcoded elsewhere */
1019 /** Meta page content.
1020 * A meta page is the start point for accessing a database snapshot.
1021 * Pages 0-1 are meta pages. Transaction N writes meta page #(N % 2).
1023 typedef struct MDB_meta {
1024 /** Stamp identifying this as an LMDB file. It must be set
1027 /** Version number of this file. Must be set to #MDB_DATA_VERSION. */
1028 uint32_t mm_version;
1029 void *mm_address; /**< address for fixed mapping */
1030 size_t mm_mapsize; /**< size of mmap region */
1031 MDB_db mm_dbs[CORE_DBS]; /**< first is free space, 2nd is main db */
1032 /** The size of pages used in this DB */
1033 #define mm_psize mm_dbs[FREE_DBI].md_pad
1034 /** Any persistent environment flags. @ref mdb_env */
1035 #define mm_flags mm_dbs[FREE_DBI].md_flags
1036 pgno_t mm_last_pg; /**< last used page in file */
1037 volatile txnid_t mm_txnid; /**< txnid that committed this page */
1040 /** Buffer for a stack-allocated meta page.
1041 * The members define size and alignment, and silence type
1042 * aliasing warnings. They are not used directly; that could
1043 * mean incorrectly using several union members in parallel.
1045 typedef union MDB_metabuf {
1048 char mm_pad[PAGEHDRSZ];
1053 /** Auxiliary DB info.
1054 * The information here is mostly static/read-only. There is
1055 * only a single copy of this record in the environment.
1057 typedef struct MDB_dbx {
1058 MDB_val md_name; /**< name of the database */
1059 MDB_cmp_func *md_cmp; /**< function for comparing keys */
1060 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
1061 MDB_rel_func *md_rel; /**< user relocate function */
1062 void *md_relctx; /**< user-provided context for md_rel */
1065 /** A database transaction.
1066 * Every operation requires a transaction handle.
1069 MDB_txn *mt_parent; /**< parent of a nested txn */
1070 /** Nested txn under this txn, set together with flag #MDB_TXN_HAS_CHILD */
1072 pgno_t mt_next_pgno; /**< next unallocated page */
1073 /** The ID of this transaction. IDs are integers incrementing from 1.
1074 * Only committed write transactions increment the ID. If a transaction
1075 * aborts, the ID may be re-used by the next writer.
1078 MDB_env *mt_env; /**< the DB environment */
1079 /** The list of pages that became unused during this transaction.
1081 MDB_IDL mt_free_pgs;
1082 /** The list of loose pages that became unused and may be reused
1083 * in this transaction, linked through #NEXT_LOOSE_PAGE(page).
1085 MDB_page *mt_loose_pgs;
1086 /* #Number of loose pages (#mt_loose_pgs) */
1088 /** The sorted list of dirty pages we temporarily wrote to disk
1089 * because the dirty list was full. page numbers in here are
1090 * shifted left by 1, deleted slots have the LSB set.
1092 MDB_IDL mt_spill_pgs;
1094 /** For write txns: Modified pages. Sorted when not MDB_WRITEMAP. */
1095 MDB_ID2L dirty_list;
1096 /** For read txns: This thread/txn's reader table slot, or NULL. */
1099 /** Array of records for each DB known in the environment. */
1101 /** Array of MDB_db records for each known DB */
1103 /** Array of sequence numbers for each DB handle */
1104 unsigned int *mt_dbiseqs;
1105 /** @defgroup mt_dbflag Transaction DB Flags
1109 #define DB_DIRTY 0x01 /**< DB was modified or is DUPSORT data */
1110 #define DB_STALE 0x02 /**< Named-DB record is older than txnID */
1111 #define DB_NEW 0x04 /**< Named-DB handle opened in this txn */
1112 #define DB_VALID 0x08 /**< DB handle is valid, see also #MDB_VALID */
1113 #define DB_USRVALID 0x10 /**< As #DB_VALID, but not set for #FREE_DBI */
1115 /** In write txns, array of cursors for each DB */
1116 MDB_cursor **mt_cursors;
1117 /** Array of flags for each DB */
1118 unsigned char *mt_dbflags;
1119 /** Number of DB records in use, or 0 when the txn is finished.
1120 * This number only ever increments until the txn finishes; we
1121 * don't decrement it when individual DB handles are closed.
1125 /** @defgroup mdb_txn Transaction Flags
1129 /** #mdb_txn_begin() flags */
1130 #define MDB_TXN_BEGIN_FLAGS (MDB_NOMETASYNC|MDB_NOSYNC|MDB_RDONLY)
1131 #define MDB_TXN_NOMETASYNC MDB_NOMETASYNC /**< don't sync meta for this txn on commit */
1132 #define MDB_TXN_NOSYNC MDB_NOSYNC /**< don't sync this txn on commit */
1133 #define MDB_TXN_RDONLY MDB_RDONLY /**< read-only transaction */
1134 /* internal txn flags */
1135 #define MDB_TXN_WRITEMAP MDB_WRITEMAP /**< copy of #MDB_env flag in writers */
1136 #define MDB_TXN_FINISHED 0x01 /**< txn is finished or never began */
1137 #define MDB_TXN_ERROR 0x02 /**< txn is unusable after an error */
1138 #define MDB_TXN_DIRTY 0x04 /**< must write, even if dirty list is empty */
1139 #define MDB_TXN_SPILLS 0x08 /**< txn or a parent has spilled pages */
1140 #define MDB_TXN_HAS_CHILD 0x10 /**< txn has an #MDB_txn.%mt_child */
1141 /** most operations on the txn are currently illegal */
1142 #define MDB_TXN_BLOCKED (MDB_TXN_FINISHED|MDB_TXN_ERROR|MDB_TXN_HAS_CHILD)
1144 unsigned int mt_flags; /**< @ref mdb_txn */
1145 /** #dirty_list room: Array size - \#dirty pages visible to this txn.
1146 * Includes ancestor txns' dirty pages not hidden by other txns'
1147 * dirty/spilled pages. Thus commit(nested txn) has room to merge
1148 * dirty_list into mt_parent after freeing hidden mt_parent pages.
1150 unsigned int mt_dirty_room;
1153 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
1154 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
1155 * raise this on a 64 bit machine.
1157 #define CURSOR_STACK 32
1161 /** Cursors are used for all DB operations.
1162 * A cursor holds a path of (page pointer, key index) from the DB
1163 * root to a position in the DB, plus other state. #MDB_DUPSORT
1164 * cursors include an xcursor to the current data item. Write txns
1165 * track their cursors and keep them up to date when data moves.
1166 * Exception: An xcursor's pointer to a #P_SUBP page can be stale.
1167 * (A node with #F_DUPDATA but no #F_SUBDATA contains a subpage).
1170 /** Next cursor on this DB in this txn */
1171 MDB_cursor *mc_next;
1172 /** Backup of the original cursor if this cursor is a shadow */
1173 MDB_cursor *mc_backup;
1174 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
1175 struct MDB_xcursor *mc_xcursor;
1176 /** The transaction that owns this cursor */
1178 /** The database handle this cursor operates on */
1180 /** The database record for this cursor */
1182 /** The database auxiliary record for this cursor */
1184 /** The @ref mt_dbflag for this database */
1185 unsigned char *mc_dbflag;
1186 unsigned short mc_snum; /**< number of pushed pages */
1187 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
1188 /** @defgroup mdb_cursor Cursor Flags
1190 * Cursor state flags.
1193 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
1194 #define C_EOF 0x02 /**< No more data */
1195 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
1196 #define C_DEL 0x08 /**< last op was a cursor_del */
1197 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
1198 #define C_UNTRACK 0x40 /**< Un-track cursor when closing */
1200 unsigned int mc_flags; /**< @ref mdb_cursor */
1201 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
1202 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
1205 /** Context for sorted-dup records.
1206 * We could have gone to a fully recursive design, with arbitrarily
1207 * deep nesting of sub-databases. But for now we only handle these
1208 * levels - main DB, optional sub-DB, sorted-duplicate DB.
1210 typedef struct MDB_xcursor {
1211 /** A sub-cursor for traversing the Dup DB */
1212 MDB_cursor mx_cursor;
1213 /** The database record for this Dup DB */
1215 /** The auxiliary DB record for this Dup DB */
1217 /** The @ref mt_dbflag for this Dup DB */
1218 unsigned char mx_dbflag;
1221 /** State of FreeDB old pages, stored in the MDB_env */
1222 typedef struct MDB_pgstate {
1223 pgno_t *mf_pghead; /**< Reclaimed freeDB pages, or NULL before use */
1224 txnid_t mf_pglast; /**< ID of last used record, or 0 if !mf_pghead */
1227 /** The database environment. */
1229 HANDLE me_fd; /**< The main data file */
1230 HANDLE me_lfd; /**< The lock file */
1231 HANDLE me_mfd; /**< just for writing the meta pages */
1232 /** Failed to update the meta page. Probably an I/O error. */
1233 #define MDB_FATAL_ERROR 0x80000000U
1234 /** Some fields are initialized. */
1235 #define MDB_ENV_ACTIVE 0x20000000U
1236 /** me_txkey is set */
1237 #define MDB_ENV_TXKEY 0x10000000U
1238 /** fdatasync is unreliable */
1239 #define MDB_FSYNCONLY 0x08000000U
1240 uint32_t me_flags; /**< @ref mdb_env */
1241 unsigned int me_psize; /**< DB page size, inited from me_os_psize */
1242 unsigned int me_os_psize; /**< OS page size, from #GET_PAGESIZE */
1243 unsigned int me_maxreaders; /**< size of the reader table */
1244 /** Max #MDB_txninfo.%mti_numreaders of interest to #mdb_env_close() */
1245 volatile int me_close_readers;
1246 MDB_dbi me_numdbs; /**< number of DBs opened */
1247 MDB_dbi me_maxdbs; /**< size of the DB table */
1248 MDB_PID_T me_pid; /**< process ID of this env */
1249 char *me_path; /**< path to the DB files */
1250 char *me_map; /**< the memory map of the data file */
1251 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
1252 MDB_meta *me_metas[NUM_METAS]; /**< pointers to the two meta pages */
1253 void *me_pbuf; /**< scratch area for DUPSORT put() */
1254 MDB_txn *me_txn; /**< current write transaction */
1255 MDB_txn *me_txn0; /**< prealloc'd write transaction */
1256 size_t me_mapsize; /**< size of the data memory map */
1257 off_t me_size; /**< current file size */
1258 pgno_t me_maxpg; /**< me_mapsize / me_psize */
1259 MDB_dbx *me_dbxs; /**< array of static DB info */
1260 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
1261 unsigned int *me_dbiseqs; /**< array of dbi sequence numbers */
1262 pthread_key_t me_txkey; /**< thread-key for readers */
1263 txnid_t me_pgoldest; /**< ID of oldest reader last time we looked */
1264 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
1265 # define me_pglast me_pgstate.mf_pglast
1266 # define me_pghead me_pgstate.mf_pghead
1267 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
1268 /** IDL of pages that became unused in a write txn */
1269 MDB_IDL me_free_pgs;
1270 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
1271 MDB_ID2L me_dirty_list;
1272 /** Max number of freelist items that can fit in a single overflow page */
1274 /** Max size of a node on a page */
1275 unsigned int me_nodemax;
1276 #if !(MDB_MAXKEYSIZE)
1277 unsigned int me_maxkey; /**< max size of a key */
1279 int me_live_reader; /**< have liveness lock in reader table */
1281 int me_pidquery; /**< Used in OpenProcess */
1283 #ifdef MDB_USE_POSIX_MUTEX /* Posix mutexes reside in shared mem */
1284 # define me_rmutex me_txns->mti_rmutex /**< Shared reader lock */
1285 # define me_wmutex me_txns->mti_wmutex /**< Shared writer lock */
1287 mdb_mutex_t me_rmutex;
1288 mdb_mutex_t me_wmutex;
1290 void *me_userctx; /**< User-settable context */
1291 MDB_assert_func *me_assert_func; /**< Callback for assertion failures */
1294 /** Nested transaction */
1295 typedef struct MDB_ntxn {
1296 MDB_txn mnt_txn; /**< the transaction */
1297 MDB_pgstate mnt_pgstate; /**< parent transaction's saved freestate */
1300 /** max number of pages to commit in one writev() call */
1301 #define MDB_COMMIT_PAGES 64
1302 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
1303 #undef MDB_COMMIT_PAGES
1304 #define MDB_COMMIT_PAGES IOV_MAX
1307 /** max bytes to write in one call */
1308 #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4))
1310 /** Check \b txn and \b dbi arguments to a function */
1311 #define TXN_DBI_EXIST(txn, dbi, validity) \
1312 ((txn) && (dbi)<(txn)->mt_numdbs && ((txn)->mt_dbflags[dbi] & (validity)))
1314 /** Check for misused \b dbi handles */
1315 #define TXN_DBI_CHANGED(txn, dbi) \
1316 ((txn)->mt_dbiseqs[dbi] != (txn)->mt_env->me_dbiseqs[dbi])
1318 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
1319 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
1320 static int mdb_page_touch(MDB_cursor *mc);
1322 #define MDB_END_NAMES {"committed", "empty-commit", "abort", "reset", \
1323 "reset-tmp", "fail-begin", "fail-beginchild"}
1325 /* mdb_txn_end operation number, for logging */
1326 MDB_END_COMMITTED, MDB_END_EMPTY_COMMIT, MDB_END_ABORT, MDB_END_RESET,
1327 MDB_END_RESET_TMP, MDB_END_FAIL_BEGIN, MDB_END_FAIL_BEGINCHILD
1329 #define MDB_END_OPMASK 0x0F /**< mask for #mdb_txn_end() operation number */
1330 #define MDB_END_UPDATE 0x10 /**< update env state (DBIs) */
1331 #define MDB_END_FREE 0x20 /**< free txn unless it is #MDB_env.%me_txn0 */
1332 #define MDB_END_SLOT MDB_NOTLS /**< release any reader slot if #MDB_NOTLS */
1333 static void mdb_txn_end(MDB_txn *txn, unsigned mode);
1335 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp, int *lvl);
1336 static int mdb_page_search_root(MDB_cursor *mc,
1337 MDB_val *key, int modify);
1338 #define MDB_PS_MODIFY 1
1339 #define MDB_PS_ROOTONLY 2
1340 #define MDB_PS_FIRST 4
1341 #define MDB_PS_LAST 8
1342 static int mdb_page_search(MDB_cursor *mc,
1343 MDB_val *key, int flags);
1344 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1346 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1347 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1348 pgno_t newpgno, unsigned int nflags);
1350 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1351 static MDB_meta *mdb_env_pick_meta(const MDB_env *env);
1352 static int mdb_env_write_meta(MDB_txn *txn);
1353 #ifdef MDB_USE_POSIX_MUTEX /* Drop unused excl arg */
1354 # define mdb_env_close0(env, excl) mdb_env_close1(env)
1356 static void mdb_env_close0(MDB_env *env, int excl);
1358 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1359 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1360 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1361 static void mdb_node_del(MDB_cursor *mc, int ksize);
1362 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1363 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1364 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1365 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1366 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1368 static int mdb_rebalance(MDB_cursor *mc);
1369 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1371 static void mdb_cursor_pop(MDB_cursor *mc);
1372 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1374 static int mdb_cursor_del0(MDB_cursor *mc);
1375 static int mdb_del0(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data, unsigned flags);
1376 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1377 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1378 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1379 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1381 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1382 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1384 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1385 static void mdb_xcursor_init0(MDB_cursor *mc);
1386 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1388 static int mdb_drop0(MDB_cursor *mc, int subs);
1389 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1390 static int mdb_reader_check0(MDB_env *env, int rlocked, int *dead);
1393 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1396 /** Compare two items pointing at size_t's of unknown alignment. */
1397 #ifdef MISALIGNED_OK
1398 # define mdb_cmp_clong mdb_cmp_long
1400 # define mdb_cmp_clong mdb_cmp_cint
1404 static SECURITY_DESCRIPTOR mdb_null_sd;
1405 static SECURITY_ATTRIBUTES mdb_all_sa;
1406 static int mdb_sec_inited;
1409 /** Return the library version info. */
1411 mdb_version(int *major, int *minor, int *patch)
1413 if (major) *major = MDB_VERSION_MAJOR;
1414 if (minor) *minor = MDB_VERSION_MINOR;
1415 if (patch) *patch = MDB_VERSION_PATCH;
1416 return MDB_VERSION_STRING;
1419 /** Table of descriptions for LMDB @ref errors */
1420 static char *const mdb_errstr[] = {
1421 "MDB_KEYEXIST: Key/data pair already exists",
1422 "MDB_NOTFOUND: No matching key/data pair found",
1423 "MDB_PAGE_NOTFOUND: Requested page not found",
1424 "MDB_CORRUPTED: Located page was wrong type",
1425 "MDB_PANIC: Update of meta page failed or environment had fatal error",
1426 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1427 "MDB_INVALID: File is not an LMDB file",
1428 "MDB_MAP_FULL: Environment mapsize limit reached",
1429 "MDB_DBS_FULL: Environment maxdbs limit reached",
1430 "MDB_READERS_FULL: Environment maxreaders limit reached",
1431 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1432 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1433 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1434 "MDB_PAGE_FULL: Internal error - page has no more space",
1435 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1436 "MDB_INCOMPATIBLE: Operation and DB incompatible, or DB flags changed",
1437 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1438 "MDB_BAD_TXN: Transaction must abort, has a child, or is invalid",
1439 "MDB_BAD_VALSIZE: Unsupported size of key/DB name/data, or wrong DUPFIXED size",
1440 "MDB_BAD_DBI: The specified DBI handle was closed/changed unexpectedly",
1444 mdb_strerror(int err)
1447 /** HACK: pad 4KB on stack over the buf. Return system msgs in buf.
1448 * This works as long as no function between the call to mdb_strerror
1449 * and the actual use of the message uses more than 4K of stack.
1452 char buf[1024], *ptr = buf;
1456 return ("Successful return: 0");
1458 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1459 i = err - MDB_KEYEXIST;
1460 return mdb_errstr[i];
1464 /* These are the C-runtime error codes we use. The comment indicates
1465 * their numeric value, and the Win32 error they would correspond to
1466 * if the error actually came from a Win32 API. A major mess, we should
1467 * have used LMDB-specific error codes for everything.
1470 case ENOENT: /* 2, FILE_NOT_FOUND */
1471 case EIO: /* 5, ACCESS_DENIED */
1472 case ENOMEM: /* 12, INVALID_ACCESS */
1473 case EACCES: /* 13, INVALID_DATA */
1474 case EBUSY: /* 16, CURRENT_DIRECTORY */
1475 case EINVAL: /* 22, BAD_COMMAND */
1476 case ENOSPC: /* 28, OUT_OF_PAPER */
1477 return strerror(err);
1482 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM |
1483 FORMAT_MESSAGE_IGNORE_INSERTS,
1484 NULL, err, 0, ptr, sizeof(buf), (va_list *)pad);
1487 return strerror(err);
1491 /** assert(3) variant in cursor context */
1492 #define mdb_cassert(mc, expr) mdb_assert0((mc)->mc_txn->mt_env, expr, #expr)
1493 /** assert(3) variant in transaction context */
1494 #define mdb_tassert(mc, expr) mdb_assert0((txn)->mt_env, expr, #expr)
1495 /** assert(3) variant in environment context */
1496 #define mdb_eassert(env, expr) mdb_assert0(env, expr, #expr)
1499 # define mdb_assert0(env, expr, expr_txt) ((expr) ? (void)0 : \
1500 mdb_assert_fail(env, expr_txt, mdb_func_, __FILE__, __LINE__))
1503 mdb_assert_fail(MDB_env *env, const char *expr_txt,
1504 const char *func, const char *file, int line)
1507 sprintf(buf, "%.100s:%d: Assertion '%.200s' failed in %.40s()",
1508 file, line, expr_txt, func);
1509 if (env->me_assert_func)
1510 env->me_assert_func(env, buf);
1511 fprintf(stderr, "%s\n", buf);
1515 # define mdb_assert0(env, expr, expr_txt) ((void) 0)
1519 /** Return the page number of \b mp which may be sub-page, for debug output */
1521 mdb_dbg_pgno(MDB_page *mp)
1524 COPY_PGNO(ret, mp->mp_pgno);
1528 /** Display a key in hexadecimal and return the address of the result.
1529 * @param[in] key the key to display
1530 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1531 * @return The key in hexadecimal form.
1534 mdb_dkey(MDB_val *key, char *buf)
1537 unsigned char *c = key->mv_data;
1543 if (key->mv_size > DKBUF_MAXKEYSIZE)
1544 return "MDB_MAXKEYSIZE";
1545 /* may want to make this a dynamic check: if the key is mostly
1546 * printable characters, print it as-is instead of converting to hex.
1550 for (i=0; i<key->mv_size; i++)
1551 ptr += sprintf(ptr, "%02x", *c++);
1553 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1559 mdb_leafnode_type(MDB_node *n)
1561 static char *const tp[2][2] = {{"", ": DB"}, {": sub-page", ": sub-DB"}};
1562 return F_ISSET(n->mn_flags, F_BIGDATA) ? ": overflow page" :
1563 tp[F_ISSET(n->mn_flags, F_DUPDATA)][F_ISSET(n->mn_flags, F_SUBDATA)];
1566 /** Display all the keys in the page. */
1568 mdb_page_list(MDB_page *mp)
1570 pgno_t pgno = mdb_dbg_pgno(mp);
1571 const char *type, *state = (mp->mp_flags & P_DIRTY) ? ", dirty" : "";
1573 unsigned int i, nkeys, nsize, total = 0;
1577 switch (mp->mp_flags & (P_BRANCH|P_LEAF|P_LEAF2|P_META|P_OVERFLOW|P_SUBP)) {
1578 case P_BRANCH: type = "Branch page"; break;
1579 case P_LEAF: type = "Leaf page"; break;
1580 case P_LEAF|P_SUBP: type = "Sub-page"; break;
1581 case P_LEAF|P_LEAF2: type = "LEAF2 page"; break;
1582 case P_LEAF|P_LEAF2|P_SUBP: type = "LEAF2 sub-page"; break;
1584 fprintf(stderr, "Overflow page %"Z"u pages %u%s\n",
1585 pgno, mp->mp_pages, state);
1588 fprintf(stderr, "Meta-page %"Z"u txnid %"Z"u\n",
1589 pgno, ((MDB_meta *)METADATA(mp))->mm_txnid);
1592 fprintf(stderr, "Bad page %"Z"u flags 0x%u\n", pgno, mp->mp_flags);
1596 nkeys = NUMKEYS(mp);
1597 fprintf(stderr, "%s %"Z"u numkeys %d%s\n", type, pgno, nkeys, state);
1599 for (i=0; i<nkeys; i++) {
1600 if (IS_LEAF2(mp)) { /* LEAF2 pages have no mp_ptrs[] or node headers */
1601 key.mv_size = nsize = mp->mp_pad;
1602 key.mv_data = LEAF2KEY(mp, i, nsize);
1604 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1607 node = NODEPTR(mp, i);
1608 key.mv_size = node->mn_ksize;
1609 key.mv_data = node->mn_data;
1610 nsize = NODESIZE + key.mv_size;
1611 if (IS_BRANCH(mp)) {
1612 fprintf(stderr, "key %d: page %"Z"u, %s\n", i, NODEPGNO(node),
1616 if (F_ISSET(node->mn_flags, F_BIGDATA))
1617 nsize += sizeof(pgno_t);
1619 nsize += NODEDSZ(node);
1621 nsize += sizeof(indx_t);
1622 fprintf(stderr, "key %d: nsize %d, %s%s\n",
1623 i, nsize, DKEY(&key), mdb_leafnode_type(node));
1625 total = EVEN(total);
1627 fprintf(stderr, "Total: header %d + contents %d + unused %d\n",
1628 IS_LEAF2(mp) ? PAGEHDRSZ : PAGEBASE + mp->mp_lower, total, SIZELEFT(mp));
1632 mdb_cursor_chk(MDB_cursor *mc)
1638 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1639 for (i=0; i<mc->mc_top; i++) {
1641 node = NODEPTR(mp, mc->mc_ki[i]);
1642 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1645 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1651 /** Count all the pages in each DB and in the freelist
1652 * and make sure it matches the actual number of pages
1654 * All named DBs must be open for a correct count.
1656 static void mdb_audit(MDB_txn *txn)
1660 MDB_ID freecount, count;
1665 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1666 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1667 freecount += *(MDB_ID *)data.mv_data;
1668 mdb_tassert(txn, rc == MDB_NOTFOUND);
1671 for (i = 0; i<txn->mt_numdbs; i++) {
1673 if (!(txn->mt_dbflags[i] & DB_VALID))
1675 mdb_cursor_init(&mc, txn, i, &mx);
1676 if (txn->mt_dbs[i].md_root == P_INVALID)
1678 count += txn->mt_dbs[i].md_branch_pages +
1679 txn->mt_dbs[i].md_leaf_pages +
1680 txn->mt_dbs[i].md_overflow_pages;
1681 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1682 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST);
1683 for (; rc == MDB_SUCCESS; rc = mdb_cursor_sibling(&mc, 1)) {
1686 mp = mc.mc_pg[mc.mc_top];
1687 for (j=0; j<NUMKEYS(mp); j++) {
1688 MDB_node *leaf = NODEPTR(mp, j);
1689 if (leaf->mn_flags & F_SUBDATA) {
1691 memcpy(&db, NODEDATA(leaf), sizeof(db));
1692 count += db.md_branch_pages + db.md_leaf_pages +
1693 db.md_overflow_pages;
1697 mdb_tassert(txn, rc == MDB_NOTFOUND);
1700 if (freecount + count + NUM_METAS != txn->mt_next_pgno) {
1701 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1702 txn->mt_txnid, freecount, count+NUM_METAS,
1703 freecount+count+NUM_METAS, txn->mt_next_pgno);
1709 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1711 return txn->mt_dbxs[dbi].md_cmp(a, b);
1715 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1717 MDB_cmp_func *dcmp = txn->mt_dbxs[dbi].md_dcmp;
1718 #if UINT_MAX < SIZE_MAX
1719 if (dcmp == mdb_cmp_int && a->mv_size == sizeof(size_t))
1720 dcmp = mdb_cmp_clong;
1725 /** Allocate memory for a page.
1726 * Re-use old malloc'd pages first for singletons, otherwise just malloc.
1729 mdb_page_malloc(MDB_txn *txn, unsigned num)
1731 MDB_env *env = txn->mt_env;
1732 MDB_page *ret = env->me_dpages;
1733 size_t psize = env->me_psize, sz = psize, off;
1734 /* For ! #MDB_NOMEMINIT, psize counts how much to init.
1735 * For a single page alloc, we init everything after the page header.
1736 * For multi-page, we init the final page; if the caller needed that
1737 * many pages they will be filling in at least up to the last page.
1741 VGMEMP_ALLOC(env, ret, sz);
1742 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1743 env->me_dpages = ret->mp_next;
1746 psize -= off = PAGEHDRSZ;
1751 if ((ret = malloc(sz)) != NULL) {
1752 VGMEMP_ALLOC(env, ret, sz);
1753 if (!(env->me_flags & MDB_NOMEMINIT)) {
1754 memset((char *)ret + off, 0, psize);
1758 txn->mt_flags |= MDB_TXN_ERROR;
1762 /** Free a single page.
1763 * Saves single pages to a list, for future reuse.
1764 * (This is not used for multi-page overflow pages.)
1767 mdb_page_free(MDB_env *env, MDB_page *mp)
1769 mp->mp_next = env->me_dpages;
1770 VGMEMP_FREE(env, mp);
1771 env->me_dpages = mp;
1774 /** Free a dirty page */
1776 mdb_dpage_free(MDB_env *env, MDB_page *dp)
1778 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1779 mdb_page_free(env, dp);
1781 /* large pages just get freed directly */
1782 VGMEMP_FREE(env, dp);
1787 /** Return all dirty pages to dpage list */
1789 mdb_dlist_free(MDB_txn *txn)
1791 MDB_env *env = txn->mt_env;
1792 MDB_ID2L dl = txn->mt_u.dirty_list;
1793 unsigned i, n = dl[0].mid;
1795 for (i = 1; i <= n; i++) {
1796 mdb_dpage_free(env, dl[i].mptr);
1801 /** Loosen or free a single page.
1802 * Saves single pages to a list for future reuse
1803 * in this same txn. It has been pulled from the freeDB
1804 * and already resides on the dirty list, but has been
1805 * deleted. Use these pages first before pulling again
1808 * If the page wasn't dirtied in this txn, just add it
1809 * to this txn's free list.
1812 mdb_page_loose(MDB_cursor *mc, MDB_page *mp)
1815 pgno_t pgno = mp->mp_pgno;
1816 MDB_txn *txn = mc->mc_txn;
1818 if ((mp->mp_flags & P_DIRTY) && mc->mc_dbi != FREE_DBI) {
1819 if (txn->mt_parent) {
1820 MDB_ID2 *dl = txn->mt_u.dirty_list;
1821 /* If txn has a parent, make sure the page is in our
1825 unsigned x = mdb_mid2l_search(dl, pgno);
1826 if (x <= dl[0].mid && dl[x].mid == pgno) {
1827 if (mp != dl[x].mptr) { /* bad cursor? */
1828 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
1829 txn->mt_flags |= MDB_TXN_ERROR;
1830 return MDB_CORRUPTED;
1837 /* no parent txn, so it's just ours */
1842 DPRINTF(("loosen db %d page %"Z"u", DDBI(mc),
1844 NEXT_LOOSE_PAGE(mp) = txn->mt_loose_pgs;
1845 txn->mt_loose_pgs = mp;
1846 txn->mt_loose_count++;
1847 mp->mp_flags |= P_LOOSE;
1849 int rc = mdb_midl_append(&txn->mt_free_pgs, pgno);
1857 /** Set or clear P_KEEP in dirty, non-overflow, non-sub pages watched by txn.
1858 * @param[in] mc A cursor handle for the current operation.
1859 * @param[in] pflags Flags of the pages to update:
1860 * P_DIRTY to set P_KEEP, P_DIRTY|P_KEEP to clear it.
1861 * @param[in] all No shortcuts. Needed except after a full #mdb_page_flush().
1862 * @return 0 on success, non-zero on failure.
1865 mdb_pages_xkeep(MDB_cursor *mc, unsigned pflags, int all)
1867 enum { Mask = P_SUBP|P_DIRTY|P_LOOSE|P_KEEP };
1868 MDB_txn *txn = mc->mc_txn;
1874 int rc = MDB_SUCCESS, level;
1876 /* Mark pages seen by cursors */
1877 if (mc->mc_flags & C_UNTRACK)
1878 mc = NULL; /* will find mc in mt_cursors */
1879 for (i = txn->mt_numdbs;; mc = txn->mt_cursors[--i]) {
1880 for (; mc; mc=mc->mc_next) {
1881 if (!(mc->mc_flags & C_INITIALIZED))
1883 for (m3 = mc;; m3 = &mx->mx_cursor) {
1885 for (j=0; j<m3->mc_snum; j++) {
1887 if ((mp->mp_flags & Mask) == pflags)
1888 mp->mp_flags ^= P_KEEP;
1890 mx = m3->mc_xcursor;
1891 /* Proceed to mx if it is at a sub-database */
1892 if (! (mx && (mx->mx_cursor.mc_flags & C_INITIALIZED)))
1894 if (! (mp && (mp->mp_flags & P_LEAF)))
1896 leaf = NODEPTR(mp, m3->mc_ki[j-1]);
1897 if (!(leaf->mn_flags & F_SUBDATA))
1906 /* Mark dirty root pages */
1907 for (i=0; i<txn->mt_numdbs; i++) {
1908 if (txn->mt_dbflags[i] & DB_DIRTY) {
1909 pgno_t pgno = txn->mt_dbs[i].md_root;
1910 if (pgno == P_INVALID)
1912 if ((rc = mdb_page_get(txn, pgno, &dp, &level)) != MDB_SUCCESS)
1914 if ((dp->mp_flags & Mask) == pflags && level <= 1)
1915 dp->mp_flags ^= P_KEEP;
1923 static int mdb_page_flush(MDB_txn *txn, int keep);
1925 /** Spill pages from the dirty list back to disk.
1926 * This is intended to prevent running into #MDB_TXN_FULL situations,
1927 * but note that they may still occur in a few cases:
1928 * 1) our estimate of the txn size could be too small. Currently this
1929 * seems unlikely, except with a large number of #MDB_MULTIPLE items.
1930 * 2) child txns may run out of space if their parents dirtied a
1931 * lot of pages and never spilled them. TODO: we probably should do
1932 * a preemptive spill during #mdb_txn_begin() of a child txn, if
1933 * the parent's dirty_room is below a given threshold.
1935 * Otherwise, if not using nested txns, it is expected that apps will
1936 * not run into #MDB_TXN_FULL any more. The pages are flushed to disk
1937 * the same way as for a txn commit, e.g. their P_DIRTY flag is cleared.
1938 * If the txn never references them again, they can be left alone.
1939 * If the txn only reads them, they can be used without any fuss.
1940 * If the txn writes them again, they can be dirtied immediately without
1941 * going thru all of the work of #mdb_page_touch(). Such references are
1942 * handled by #mdb_page_unspill().
1944 * Also note, we never spill DB root pages, nor pages of active cursors,
1945 * because we'll need these back again soon anyway. And in nested txns,
1946 * we can't spill a page in a child txn if it was already spilled in a
1947 * parent txn. That would alter the parent txns' data even though
1948 * the child hasn't committed yet, and we'd have no way to undo it if
1949 * the child aborted.
1951 * @param[in] m0 cursor A cursor handle identifying the transaction and
1952 * database for which we are checking space.
1953 * @param[in] key For a put operation, the key being stored.
1954 * @param[in] data For a put operation, the data being stored.
1955 * @return 0 on success, non-zero on failure.
1958 mdb_page_spill(MDB_cursor *m0, MDB_val *key, MDB_val *data)
1960 MDB_txn *txn = m0->mc_txn;
1962 MDB_ID2L dl = txn->mt_u.dirty_list;
1963 unsigned int i, j, need;
1966 if (m0->mc_flags & C_SUB)
1969 /* Estimate how much space this op will take */
1970 i = m0->mc_db->md_depth;
1971 /* Named DBs also dirty the main DB */
1972 if (m0->mc_dbi >= CORE_DBS)
1973 i += txn->mt_dbs[MAIN_DBI].md_depth;
1974 /* For puts, roughly factor in the key+data size */
1976 i += (LEAFSIZE(key, data) + txn->mt_env->me_psize) / txn->mt_env->me_psize;
1977 i += i; /* double it for good measure */
1980 if (txn->mt_dirty_room > i)
1983 if (!txn->mt_spill_pgs) {
1984 txn->mt_spill_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX);
1985 if (!txn->mt_spill_pgs)
1988 /* purge deleted slots */
1989 MDB_IDL sl = txn->mt_spill_pgs;
1990 unsigned int num = sl[0];
1992 for (i=1; i<=num; i++) {
1999 /* Preserve pages which may soon be dirtied again */
2000 if ((rc = mdb_pages_xkeep(m0, P_DIRTY, 1)) != MDB_SUCCESS)
2003 /* Less aggressive spill - we originally spilled the entire dirty list,
2004 * with a few exceptions for cursor pages and DB root pages. But this
2005 * turns out to be a lot of wasted effort because in a large txn many
2006 * of those pages will need to be used again. So now we spill only 1/8th
2007 * of the dirty pages. Testing revealed this to be a good tradeoff,
2008 * better than 1/2, 1/4, or 1/10.
2010 if (need < MDB_IDL_UM_MAX / 8)
2011 need = MDB_IDL_UM_MAX / 8;
2013 /* Save the page IDs of all the pages we're flushing */
2014 /* flush from the tail forward, this saves a lot of shifting later on. */
2015 for (i=dl[0].mid; i && need; i--) {
2016 MDB_ID pn = dl[i].mid << 1;
2018 if (dp->mp_flags & (P_LOOSE|P_KEEP))
2020 /* Can't spill twice, make sure it's not already in a parent's
2023 if (txn->mt_parent) {
2025 for (tx2 = txn->mt_parent; tx2; tx2 = tx2->mt_parent) {
2026 if (tx2->mt_spill_pgs) {
2027 j = mdb_midl_search(tx2->mt_spill_pgs, pn);
2028 if (j <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[j] == pn) {
2029 dp->mp_flags |= P_KEEP;
2037 if ((rc = mdb_midl_append(&txn->mt_spill_pgs, pn)))
2041 mdb_midl_sort(txn->mt_spill_pgs);
2043 /* Flush the spilled part of dirty list */
2044 if ((rc = mdb_page_flush(txn, i)) != MDB_SUCCESS)
2047 /* Reset any dirty pages we kept that page_flush didn't see */
2048 rc = mdb_pages_xkeep(m0, P_DIRTY|P_KEEP, i);
2051 txn->mt_flags |= rc ? MDB_TXN_ERROR : MDB_TXN_SPILLS;
2055 /** Find oldest txnid still referenced. Expects txn->mt_txnid > 0. */
2057 mdb_find_oldest(MDB_txn *txn)
2060 txnid_t mr, oldest = txn->mt_txnid - 1;
2061 if (txn->mt_env->me_txns) {
2062 MDB_reader *r = txn->mt_env->me_txns->mti_readers;
2063 for (i = txn->mt_env->me_txns->mti_numreaders; --i >= 0; ) {
2074 /** Add a page to the txn's dirty list */
2076 mdb_page_dirty(MDB_txn *txn, MDB_page *mp)
2079 int rc, (*insert)(MDB_ID2L, MDB_ID2 *);
2081 if (txn->mt_flags & MDB_TXN_WRITEMAP) {
2082 insert = mdb_mid2l_append;
2084 insert = mdb_mid2l_insert;
2086 mid.mid = mp->mp_pgno;
2088 rc = insert(txn->mt_u.dirty_list, &mid);
2089 mdb_tassert(txn, rc == 0);
2090 txn->mt_dirty_room--;
2093 /** Allocate page numbers and memory for writing. Maintain me_pglast,
2094 * me_pghead and mt_next_pgno.
2096 * If there are free pages available from older transactions, they
2097 * are re-used first. Otherwise allocate a new page at mt_next_pgno.
2098 * Do not modify the freedB, just merge freeDB records into me_pghead[]
2099 * and move me_pglast to say which records were consumed. Only this
2100 * function can create me_pghead and move me_pglast/mt_next_pgno.
2101 * @param[in] mc cursor A cursor handle identifying the transaction and
2102 * database for which we are allocating.
2103 * @param[in] num the number of pages to allocate.
2104 * @param[out] mp Address of the allocated page(s). Requests for multiple pages
2105 * will always be satisfied by a single contiguous chunk of memory.
2106 * @return 0 on success, non-zero on failure.
2109 mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp)
2111 #ifdef MDB_PARANOID /* Seems like we can ignore this now */
2112 /* Get at most <Max_retries> more freeDB records once me_pghead
2113 * has enough pages. If not enough, use new pages from the map.
2114 * If <Paranoid> and mc is updating the freeDB, only get new
2115 * records if me_pghead is empty. Then the freelist cannot play
2116 * catch-up with itself by growing while trying to save it.
2118 enum { Paranoid = 1, Max_retries = 500 };
2120 enum { Paranoid = 0, Max_retries = INT_MAX /*infinite*/ };
2122 int rc, retry = num * 60;
2123 MDB_txn *txn = mc->mc_txn;
2124 MDB_env *env = txn->mt_env;
2125 pgno_t pgno, *mop = env->me_pghead;
2126 unsigned i, j, mop_len = mop ? mop[0] : 0, n2 = num-1;
2128 txnid_t oldest = 0, last;
2133 /* If there are any loose pages, just use them */
2134 if (num == 1 && txn->mt_loose_pgs) {
2135 np = txn->mt_loose_pgs;
2136 txn->mt_loose_pgs = NEXT_LOOSE_PAGE(np);
2137 txn->mt_loose_count--;
2138 DPRINTF(("db %d use loose page %"Z"u", DDBI(mc),
2146 /* If our dirty list is already full, we can't do anything */
2147 if (txn->mt_dirty_room == 0) {
2152 for (op = MDB_FIRST;; op = MDB_NEXT) {
2157 /* Seek a big enough contiguous page range. Prefer
2158 * pages at the tail, just truncating the list.
2164 if (mop[i-n2] == pgno+n2)
2171 if (op == MDB_FIRST) { /* 1st iteration */
2172 /* Prepare to fetch more and coalesce */
2173 last = env->me_pglast;
2174 oldest = env->me_pgoldest;
2175 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
2178 key.mv_data = &last; /* will look up last+1 */
2179 key.mv_size = sizeof(last);
2181 if (Paranoid && mc->mc_dbi == FREE_DBI)
2184 if (Paranoid && retry < 0 && mop_len)
2188 /* Do not fetch more if the record will be too recent */
2189 if (oldest <= last) {
2191 oldest = mdb_find_oldest(txn);
2192 env->me_pgoldest = oldest;
2198 rc = mdb_cursor_get(&m2, &key, NULL, op);
2200 if (rc == MDB_NOTFOUND)
2204 last = *(txnid_t*)key.mv_data;
2205 if (oldest <= last) {
2207 oldest = mdb_find_oldest(txn);
2208 env->me_pgoldest = oldest;
2214 np = m2.mc_pg[m2.mc_top];
2215 leaf = NODEPTR(np, m2.mc_ki[m2.mc_top]);
2216 if ((rc = mdb_node_read(txn, leaf, &data)) != MDB_SUCCESS)
2219 idl = (MDB_ID *) data.mv_data;
2222 if (!(env->me_pghead = mop = mdb_midl_alloc(i))) {
2227 if ((rc = mdb_midl_need(&env->me_pghead, i)) != 0)
2229 mop = env->me_pghead;
2231 env->me_pglast = last;
2233 DPRINTF(("IDL read txn %"Z"u root %"Z"u num %u",
2234 last, txn->mt_dbs[FREE_DBI].md_root, i));
2236 DPRINTF(("IDL %"Z"u", idl[j]));
2238 /* Merge in descending sorted order */
2239 mdb_midl_xmerge(mop, idl);
2243 /* Use new pages from the map when nothing suitable in the freeDB */
2245 pgno = txn->mt_next_pgno;
2246 if (pgno + num >= env->me_maxpg) {
2247 DPUTS("DB size maxed out");
2253 if (env->me_flags & MDB_WRITEMAP) {
2254 np = (MDB_page *)(env->me_map + env->me_psize * pgno);
2256 if (!(np = mdb_page_malloc(txn, num))) {
2262 mop[0] = mop_len -= num;
2263 /* Move any stragglers down */
2264 for (j = i-num; j < mop_len; )
2265 mop[++j] = mop[++i];
2267 txn->mt_next_pgno = pgno + num;
2270 mdb_page_dirty(txn, np);
2276 txn->mt_flags |= MDB_TXN_ERROR;
2280 /** Copy the used portions of a non-overflow page.
2281 * @param[in] dst page to copy into
2282 * @param[in] src page to copy from
2283 * @param[in] psize size of a page
2286 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
2288 enum { Align = sizeof(pgno_t) };
2289 indx_t upper = src->mp_upper, lower = src->mp_lower, unused = upper-lower;
2291 /* If page isn't full, just copy the used portion. Adjust
2292 * alignment so memcpy may copy words instead of bytes.
2294 if ((unused &= -Align) && !IS_LEAF2(src)) {
2295 upper = (upper + PAGEBASE) & -Align;
2296 memcpy(dst, src, (lower + PAGEBASE + (Align-1)) & -Align);
2297 memcpy((pgno_t *)((char *)dst+upper), (pgno_t *)((char *)src+upper),
2300 memcpy(dst, src, psize - unused);
2304 /** Pull a page off the txn's spill list, if present.
2305 * If a page being referenced was spilled to disk in this txn, bring
2306 * it back and make it dirty/writable again.
2307 * @param[in] txn the transaction handle.
2308 * @param[in] mp the page being referenced. It must not be dirty.
2309 * @param[out] ret the writable page, if any. ret is unchanged if
2310 * mp wasn't spilled.
2313 mdb_page_unspill(MDB_txn *txn, MDB_page *mp, MDB_page **ret)
2315 MDB_env *env = txn->mt_env;
2318 pgno_t pgno = mp->mp_pgno, pn = pgno << 1;
2320 for (tx2 = txn; tx2; tx2=tx2->mt_parent) {
2321 if (!tx2->mt_spill_pgs)
2323 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
2324 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
2327 if (txn->mt_dirty_room == 0)
2328 return MDB_TXN_FULL;
2329 if (IS_OVERFLOW(mp))
2333 if (env->me_flags & MDB_WRITEMAP) {
2336 np = mdb_page_malloc(txn, num);
2340 memcpy(np, mp, num * env->me_psize);
2342 mdb_page_copy(np, mp, env->me_psize);
2345 /* If in current txn, this page is no longer spilled.
2346 * If it happens to be the last page, truncate the spill list.
2347 * Otherwise mark it as deleted by setting the LSB.
2349 if (x == txn->mt_spill_pgs[0])
2350 txn->mt_spill_pgs[0]--;
2352 txn->mt_spill_pgs[x] |= 1;
2353 } /* otherwise, if belonging to a parent txn, the
2354 * page remains spilled until child commits
2357 mdb_page_dirty(txn, np);
2358 np->mp_flags |= P_DIRTY;
2366 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
2367 * @param[in] mc cursor pointing to the page to be touched
2368 * @return 0 on success, non-zero on failure.
2371 mdb_page_touch(MDB_cursor *mc)
2373 MDB_page *mp = mc->mc_pg[mc->mc_top], *np;
2374 MDB_txn *txn = mc->mc_txn;
2375 MDB_cursor *m2, *m3;
2379 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
2380 if (txn->mt_flags & MDB_TXN_SPILLS) {
2382 rc = mdb_page_unspill(txn, mp, &np);
2388 if ((rc = mdb_midl_need(&txn->mt_free_pgs, 1)) ||
2389 (rc = mdb_page_alloc(mc, 1, &np)))
2392 DPRINTF(("touched db %d page %"Z"u -> %"Z"u", DDBI(mc),
2393 mp->mp_pgno, pgno));
2394 mdb_cassert(mc, mp->mp_pgno != pgno);
2395 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
2396 /* Update the parent page, if any, to point to the new page */
2398 MDB_page *parent = mc->mc_pg[mc->mc_top-1];
2399 MDB_node *node = NODEPTR(parent, mc->mc_ki[mc->mc_top-1]);
2400 SETPGNO(node, pgno);
2402 mc->mc_db->md_root = pgno;
2404 } else if (txn->mt_parent && !IS_SUBP(mp)) {
2405 MDB_ID2 mid, *dl = txn->mt_u.dirty_list;
2407 /* If txn has a parent, make sure the page is in our
2411 unsigned x = mdb_mid2l_search(dl, pgno);
2412 if (x <= dl[0].mid && dl[x].mid == pgno) {
2413 if (mp != dl[x].mptr) { /* bad cursor? */
2414 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
2415 txn->mt_flags |= MDB_TXN_ERROR;
2416 return MDB_CORRUPTED;
2421 mdb_cassert(mc, dl[0].mid < MDB_IDL_UM_MAX);
2423 np = mdb_page_malloc(txn, 1);
2428 rc = mdb_mid2l_insert(dl, &mid);
2429 mdb_cassert(mc, rc == 0);
2434 mdb_page_copy(np, mp, txn->mt_env->me_psize);
2436 np->mp_flags |= P_DIRTY;
2439 /* Adjust cursors pointing to mp */
2440 mc->mc_pg[mc->mc_top] = np;
2441 m2 = txn->mt_cursors[mc->mc_dbi];
2442 if (mc->mc_flags & C_SUB) {
2443 for (; m2; m2=m2->mc_next) {
2444 m3 = &m2->mc_xcursor->mx_cursor;
2445 if (m3->mc_snum < mc->mc_snum) continue;
2446 if (m3->mc_pg[mc->mc_top] == mp)
2447 m3->mc_pg[mc->mc_top] = np;
2450 for (; m2; m2=m2->mc_next) {
2451 if (m2->mc_snum < mc->mc_snum) continue;
2452 if (m2->mc_pg[mc->mc_top] == mp) {
2453 m2->mc_pg[mc->mc_top] = np;
2454 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
2456 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
2458 MDB_node *leaf = NODEPTR(np, mc->mc_ki[mc->mc_top]);
2459 if (!(leaf->mn_flags & F_SUBDATA))
2460 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
2468 txn->mt_flags |= MDB_TXN_ERROR;
2473 mdb_env_sync(MDB_env *env, int force)
2476 if (env->me_flags & MDB_RDONLY)
2478 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
2479 if (env->me_flags & MDB_WRITEMAP) {
2480 int flags = ((env->me_flags & MDB_MAPASYNC) && !force)
2481 ? MS_ASYNC : MS_SYNC;
2482 if (MDB_MSYNC(env->me_map, env->me_mapsize, flags))
2485 else if (flags == MS_SYNC && MDB_FDATASYNC(env->me_fd))
2489 #ifdef BROKEN_FDATASYNC
2490 if (env->me_flags & MDB_FSYNCONLY) {
2491 if (fsync(env->me_fd))
2495 if (MDB_FDATASYNC(env->me_fd))
2502 /** Back up parent txn's cursors, then grab the originals for tracking */
2504 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
2506 MDB_cursor *mc, *bk;
2511 for (i = src->mt_numdbs; --i >= 0; ) {
2512 if ((mc = src->mt_cursors[i]) != NULL) {
2513 size = sizeof(MDB_cursor);
2515 size += sizeof(MDB_xcursor);
2516 for (; mc; mc = bk->mc_next) {
2522 mc->mc_db = &dst->mt_dbs[i];
2523 /* Kill pointers into src - and dst to reduce abuse: The
2524 * user may not use mc until dst ends. Otherwise we'd...
2526 mc->mc_txn = NULL; /* ...set this to dst */
2527 mc->mc_dbflag = NULL; /* ...and &dst->mt_dbflags[i] */
2528 if ((mx = mc->mc_xcursor) != NULL) {
2529 *(MDB_xcursor *)(bk+1) = *mx;
2530 mx->mx_cursor.mc_txn = NULL; /* ...and dst. */
2532 mc->mc_next = dst->mt_cursors[i];
2533 dst->mt_cursors[i] = mc;
2540 /** Close this write txn's cursors, give parent txn's cursors back to parent.
2541 * @param[in] txn the transaction handle.
2542 * @param[in] merge true to keep changes to parent cursors, false to revert.
2543 * @return 0 on success, non-zero on failure.
2546 mdb_cursors_close(MDB_txn *txn, unsigned merge)
2548 MDB_cursor **cursors = txn->mt_cursors, *mc, *next, *bk;
2552 for (i = txn->mt_numdbs; --i >= 0; ) {
2553 for (mc = cursors[i]; mc; mc = next) {
2555 if ((bk = mc->mc_backup) != NULL) {
2557 /* Commit changes to parent txn */
2558 mc->mc_next = bk->mc_next;
2559 mc->mc_backup = bk->mc_backup;
2560 mc->mc_txn = bk->mc_txn;
2561 mc->mc_db = bk->mc_db;
2562 mc->mc_dbflag = bk->mc_dbflag;
2563 if ((mx = mc->mc_xcursor) != NULL)
2564 mx->mx_cursor.mc_txn = bk->mc_txn;
2566 /* Abort nested txn */
2568 if ((mx = mc->mc_xcursor) != NULL)
2569 *mx = *(MDB_xcursor *)(bk+1);
2573 /* Only malloced cursors are permanently tracked. */
2580 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2586 Pidset = F_SETLK, Pidcheck = F_GETLK
2590 /** Set or check a pid lock. Set returns 0 on success.
2591 * Check returns 0 if the process is certainly dead, nonzero if it may
2592 * be alive (the lock exists or an error happened so we do not know).
2594 * On Windows Pidset is a no-op, we merely check for the existence
2595 * of the process with the given pid. On POSIX we use a single byte
2596 * lock on the lockfile, set at an offset equal to the pid.
2599 mdb_reader_pid(MDB_env *env, enum Pidlock_op op, MDB_PID_T pid)
2601 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2604 if (op == Pidcheck) {
2605 h = OpenProcess(env->me_pidquery, FALSE, pid);
2606 /* No documented "no such process" code, but other program use this: */
2608 return ErrCode() != ERROR_INVALID_PARAMETER;
2609 /* A process exists until all handles to it close. Has it exited? */
2610 ret = WaitForSingleObject(h, 0) != 0;
2617 struct flock lock_info;
2618 memset(&lock_info, 0, sizeof(lock_info));
2619 lock_info.l_type = F_WRLCK;
2620 lock_info.l_whence = SEEK_SET;
2621 lock_info.l_start = pid;
2622 lock_info.l_len = 1;
2623 if ((rc = fcntl(env->me_lfd, op, &lock_info)) == 0) {
2624 if (op == F_GETLK && lock_info.l_type != F_UNLCK)
2626 } else if ((rc = ErrCode()) == EINTR) {
2634 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
2635 * @param[in] txn the transaction handle to initialize
2636 * @return 0 on success, non-zero on failure.
2639 mdb_txn_renew0(MDB_txn *txn)
2641 MDB_env *env = txn->mt_env;
2642 MDB_txninfo *ti = env->me_txns;
2644 unsigned int i, nr, flags = txn->mt_flags;
2646 int rc, new_notls = 0;
2648 if ((flags &= MDB_TXN_RDONLY) != 0) {
2650 meta = mdb_env_pick_meta(env);
2651 txn->mt_txnid = meta->mm_txnid;
2652 txn->mt_u.reader = NULL;
2654 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
2655 pthread_getspecific(env->me_txkey);
2657 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
2658 return MDB_BAD_RSLOT;
2660 MDB_PID_T pid = env->me_pid;
2661 MDB_THR_T tid = pthread_self();
2662 mdb_mutexref_t rmutex = env->me_rmutex;
2664 if (!env->me_live_reader) {
2665 rc = mdb_reader_pid(env, Pidset, pid);
2668 env->me_live_reader = 1;
2671 if (LOCK_MUTEX(rc, env, rmutex))
2673 nr = ti->mti_numreaders;
2674 for (i=0; i<nr; i++)
2675 if (ti->mti_readers[i].mr_pid == 0)
2677 if (i == env->me_maxreaders) {
2678 UNLOCK_MUTEX(rmutex);
2679 return MDB_READERS_FULL;
2681 r = &ti->mti_readers[i];
2682 /* Claim the reader slot, carefully since other code
2683 * uses the reader table un-mutexed: First reset the
2684 * slot, next publish it in mti_numreaders. After
2685 * that, it is safe for mdb_env_close() to touch it.
2686 * When it will be closed, we can finally claim it.
2689 r->mr_txnid = (txnid_t)-1;
2692 ti->mti_numreaders = ++nr;
2693 env->me_close_readers = nr;
2695 UNLOCK_MUTEX(rmutex);
2697 new_notls = (env->me_flags & MDB_NOTLS);
2698 if (!new_notls && (rc=pthread_setspecific(env->me_txkey, r))) {
2703 do /* LY: Retry on a race, ITS#7970. */
2704 r->mr_txnid = ti->mti_txnid;
2705 while(r->mr_txnid != ti->mti_txnid);
2706 txn->mt_txnid = r->mr_txnid;
2707 txn->mt_u.reader = r;
2708 meta = env->me_metas[txn->mt_txnid & 1];
2712 /* Not yet touching txn == env->me_txn0, it may be active */
2714 if (LOCK_MUTEX(rc, env, env->me_wmutex))
2716 txn->mt_txnid = ti->mti_txnid;
2717 meta = env->me_metas[txn->mt_txnid & 1];
2719 meta = mdb_env_pick_meta(env);
2720 txn->mt_txnid = meta->mm_txnid;
2724 if (txn->mt_txnid == mdb_debug_start)
2727 txn->mt_child = NULL;
2728 txn->mt_loose_pgs = NULL;
2729 txn->mt_loose_count = 0;
2730 txn->mt_dirty_room = MDB_IDL_UM_MAX;
2731 txn->mt_u.dirty_list = env->me_dirty_list;
2732 txn->mt_u.dirty_list[0].mid = 0;
2733 txn->mt_free_pgs = env->me_free_pgs;
2734 txn->mt_free_pgs[0] = 0;
2735 txn->mt_spill_pgs = NULL;
2737 memcpy(txn->mt_dbiseqs, env->me_dbiseqs, env->me_maxdbs * sizeof(unsigned int));
2740 /* Copy the DB info and flags */
2741 memcpy(txn->mt_dbs, meta->mm_dbs, CORE_DBS * sizeof(MDB_db));
2743 /* Moved to here to avoid a data race in read TXNs */
2744 txn->mt_next_pgno = meta->mm_last_pg+1;
2746 txn->mt_flags = flags;
2749 txn->mt_numdbs = env->me_numdbs;
2750 for (i=CORE_DBS; i<txn->mt_numdbs; i++) {
2751 x = env->me_dbflags[i];
2752 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
2753 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_USRVALID|DB_STALE : 0;
2755 txn->mt_dbflags[MAIN_DBI] = DB_VALID|DB_USRVALID;
2756 txn->mt_dbflags[FREE_DBI] = DB_VALID;
2758 if (env->me_flags & MDB_FATAL_ERROR) {
2759 DPUTS("environment had fatal error, must shutdown!");
2761 } else if (env->me_maxpg < txn->mt_next_pgno) {
2762 rc = MDB_MAP_RESIZED;
2766 mdb_txn_end(txn, new_notls /*0 or MDB_END_SLOT*/ | MDB_END_FAIL_BEGIN);
2771 mdb_txn_renew(MDB_txn *txn)
2775 if (!txn || !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY|MDB_TXN_FINISHED))
2778 rc = mdb_txn_renew0(txn);
2779 if (rc == MDB_SUCCESS) {
2780 DPRINTF(("renew txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2781 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2782 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root));
2788 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
2792 int rc, size, tsize;
2794 flags &= MDB_TXN_BEGIN_FLAGS;
2795 flags |= env->me_flags & MDB_WRITEMAP;
2797 if (env->me_flags & MDB_RDONLY & ~flags) /* write txn in RDONLY env */
2801 /* Nested transactions: Max 1 child, write txns only, no writemap */
2802 flags |= parent->mt_flags;
2803 if (flags & (MDB_RDONLY|MDB_WRITEMAP|MDB_TXN_BLOCKED)) {
2804 return (parent->mt_flags & MDB_TXN_RDONLY) ? EINVAL : MDB_BAD_TXN;
2806 /* Child txns save MDB_pgstate and use own copy of cursors */
2807 size = env->me_maxdbs * (sizeof(MDB_db)+sizeof(MDB_cursor *)+1);
2808 size += tsize = sizeof(MDB_ntxn);
2809 } else if (flags & MDB_RDONLY) {
2810 size = env->me_maxdbs * (sizeof(MDB_db)+1);
2811 size += tsize = sizeof(MDB_txn);
2813 /* Reuse preallocated write txn. However, do not touch it until
2814 * mdb_txn_renew0() succeeds, since it currently may be active.
2819 if ((txn = calloc(1, size)) == NULL) {
2820 DPRINTF(("calloc: %s", strerror(errno)));
2823 txn->mt_dbxs = env->me_dbxs; /* static */
2824 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
2825 txn->mt_dbflags = (unsigned char *)txn + size - env->me_maxdbs;
2826 txn->mt_flags = flags;
2831 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
2832 txn->mt_dbiseqs = parent->mt_dbiseqs;
2833 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
2834 if (!txn->mt_u.dirty_list ||
2835 !(txn->mt_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)))
2837 free(txn->mt_u.dirty_list);
2841 txn->mt_txnid = parent->mt_txnid;
2842 txn->mt_dirty_room = parent->mt_dirty_room;
2843 txn->mt_u.dirty_list[0].mid = 0;
2844 txn->mt_spill_pgs = NULL;
2845 txn->mt_next_pgno = parent->mt_next_pgno;
2846 parent->mt_flags |= MDB_TXN_HAS_CHILD;
2847 parent->mt_child = txn;
2848 txn->mt_parent = parent;
2849 txn->mt_numdbs = parent->mt_numdbs;
2850 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2851 /* Copy parent's mt_dbflags, but clear DB_NEW */
2852 for (i=0; i<txn->mt_numdbs; i++)
2853 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
2855 ntxn = (MDB_ntxn *)txn;
2856 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
2857 if (env->me_pghead) {
2858 size = MDB_IDL_SIZEOF(env->me_pghead);
2859 env->me_pghead = mdb_midl_alloc(env->me_pghead[0]);
2861 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
2866 rc = mdb_cursor_shadow(parent, txn);
2868 mdb_txn_end(txn, MDB_END_FAIL_BEGINCHILD);
2869 } else { /* MDB_RDONLY */
2870 txn->mt_dbiseqs = env->me_dbiseqs;
2872 rc = mdb_txn_renew0(txn);
2875 if (txn != env->me_txn0)
2878 txn->mt_flags |= flags; /* could not change txn=me_txn0 earlier */
2880 DPRINTF(("begin txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2881 txn->mt_txnid, (flags & MDB_RDONLY) ? 'r' : 'w',
2882 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root));
2889 mdb_txn_env(MDB_txn *txn)
2891 if(!txn) return NULL;
2896 mdb_txn_id(MDB_txn *txn)
2899 return txn->mt_txnid;
2902 /** Export or close DBI handles opened in this txn. */
2904 mdb_dbis_update(MDB_txn *txn, int keep)
2907 MDB_dbi n = txn->mt_numdbs;
2908 MDB_env *env = txn->mt_env;
2909 unsigned char *tdbflags = txn->mt_dbflags;
2911 for (i = n; --i >= CORE_DBS;) {
2912 if (tdbflags[i] & DB_NEW) {
2914 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2916 char *ptr = env->me_dbxs[i].md_name.mv_data;
2918 env->me_dbxs[i].md_name.mv_data = NULL;
2919 env->me_dbxs[i].md_name.mv_size = 0;
2920 env->me_dbflags[i] = 0;
2921 env->me_dbiseqs[i]++;
2927 if (keep && env->me_numdbs < n)
2931 /** End a transaction, except successful commit of a nested transaction.
2932 * May be called twice for readonly txns: First reset it, then abort.
2933 * @param[in] txn the transaction handle to end
2934 * @param[in] mode why and how to end the transaction
2937 mdb_txn_end(MDB_txn *txn, unsigned mode)
2939 MDB_env *env = txn->mt_env;
2941 static const char *const names[] = MDB_END_NAMES;
2944 /* Export or close DBI handles opened in this txn */
2945 mdb_dbis_update(txn, mode & MDB_END_UPDATE);
2947 DPRINTF(("%s txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2948 names[mode & MDB_END_OPMASK],
2949 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2950 (void *) txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root));
2952 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2953 if (txn->mt_u.reader) {
2954 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
2955 if (!(env->me_flags & MDB_NOTLS)) {
2956 txn->mt_u.reader = NULL; /* txn does not own reader */
2957 } else if (mode & MDB_END_SLOT) {
2958 txn->mt_u.reader->mr_pid = 0;
2959 txn->mt_u.reader = NULL;
2960 } /* else txn owns the slot until it does MDB_END_SLOT */
2962 txn->mt_numdbs = 0; /* prevent further DBI activity */
2963 txn->mt_flags |= MDB_TXN_FINISHED;
2965 } else if (!F_ISSET(txn->mt_flags, MDB_TXN_FINISHED)) {
2966 pgno_t *pghead = env->me_pghead;
2968 if (!(mode & MDB_END_UPDATE)) /* !(already closed cursors) */
2969 mdb_cursors_close(txn, 0);
2970 if (!(env->me_flags & MDB_WRITEMAP)) {
2971 mdb_dlist_free(txn);
2975 txn->mt_flags = MDB_TXN_FINISHED;
2977 if (!txn->mt_parent) {
2978 mdb_midl_shrink(&txn->mt_free_pgs);
2979 env->me_free_pgs = txn->mt_free_pgs;
2981 env->me_pghead = NULL;
2985 mode = 0; /* txn == env->me_txn0, do not free() it */
2987 /* The writer mutex was locked in mdb_txn_begin. */
2989 UNLOCK_MUTEX(env->me_wmutex);
2991 txn->mt_parent->mt_child = NULL;
2992 txn->mt_parent->mt_flags &= ~MDB_TXN_HAS_CHILD;
2993 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2994 mdb_midl_free(txn->mt_free_pgs);
2995 mdb_midl_free(txn->mt_spill_pgs);
2996 free(txn->mt_u.dirty_list);
2999 mdb_midl_free(pghead);
3002 if (mode & MDB_END_FREE)
3007 mdb_txn_reset(MDB_txn *txn)
3012 /* This call is only valid for read-only txns */
3013 if (!(txn->mt_flags & MDB_TXN_RDONLY))
3016 mdb_txn_end(txn, MDB_END_RESET);
3020 mdb_txn_abort(MDB_txn *txn)
3026 mdb_txn_abort(txn->mt_child);
3028 mdb_txn_end(txn, MDB_END_ABORT|MDB_END_SLOT|MDB_END_FREE);
3031 /** Save the freelist as of this transaction to the freeDB.
3032 * This changes the freelist. Keep trying until it stabilizes.
3035 mdb_freelist_save(MDB_txn *txn)
3037 /* env->me_pghead[] can grow and shrink during this call.
3038 * env->me_pglast and txn->mt_free_pgs[] can only grow.
3039 * Page numbers cannot disappear from txn->mt_free_pgs[].
3042 MDB_env *env = txn->mt_env;
3043 int rc, maxfree_1pg = env->me_maxfree_1pg, more = 1;
3044 txnid_t pglast = 0, head_id = 0;
3045 pgno_t freecnt = 0, *free_pgs, *mop;
3046 ssize_t head_room = 0, total_room = 0, mop_len, clean_limit;
3048 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
3050 if (env->me_pghead) {
3051 /* Make sure first page of freeDB is touched and on freelist */
3052 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST|MDB_PS_MODIFY);
3053 if (rc && rc != MDB_NOTFOUND)
3057 if (!env->me_pghead && txn->mt_loose_pgs) {
3058 /* Put loose page numbers in mt_free_pgs, since
3059 * we may be unable to return them to me_pghead.
3061 MDB_page *mp = txn->mt_loose_pgs;
3062 if ((rc = mdb_midl_need(&txn->mt_free_pgs, txn->mt_loose_count)) != 0)
3064 for (; mp; mp = NEXT_LOOSE_PAGE(mp))
3065 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
3066 txn->mt_loose_pgs = NULL;
3067 txn->mt_loose_count = 0;
3070 /* MDB_RESERVE cancels meminit in ovpage malloc (when no WRITEMAP) */
3071 clean_limit = (env->me_flags & (MDB_NOMEMINIT|MDB_WRITEMAP))
3072 ? SSIZE_MAX : maxfree_1pg;
3075 /* Come back here after each Put() in case freelist changed */
3080 /* If using records from freeDB which we have not yet
3081 * deleted, delete them and any we reserved for me_pghead.
3083 while (pglast < env->me_pglast) {
3084 rc = mdb_cursor_first(&mc, &key, NULL);
3087 pglast = head_id = *(txnid_t *)key.mv_data;
3088 total_room = head_room = 0;
3089 mdb_tassert(txn, pglast <= env->me_pglast);
3090 rc = mdb_cursor_del(&mc, 0);
3095 /* Save the IDL of pages freed by this txn, to a single record */
3096 if (freecnt < txn->mt_free_pgs[0]) {
3098 /* Make sure last page of freeDB is touched and on freelist */
3099 rc = mdb_page_search(&mc, NULL, MDB_PS_LAST|MDB_PS_MODIFY);
3100 if (rc && rc != MDB_NOTFOUND)
3103 free_pgs = txn->mt_free_pgs;
3104 /* Write to last page of freeDB */
3105 key.mv_size = sizeof(txn->mt_txnid);
3106 key.mv_data = &txn->mt_txnid;
3108 freecnt = free_pgs[0];
3109 data.mv_size = MDB_IDL_SIZEOF(free_pgs);
3110 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
3113 /* Retry if mt_free_pgs[] grew during the Put() */
3114 free_pgs = txn->mt_free_pgs;
3115 } while (freecnt < free_pgs[0]);
3116 mdb_midl_sort(free_pgs);
3117 memcpy(data.mv_data, free_pgs, data.mv_size);
3120 unsigned int i = free_pgs[0];
3121 DPRINTF(("IDL write txn %"Z"u root %"Z"u num %u",
3122 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, i));
3124 DPRINTF(("IDL %"Z"u", free_pgs[i]));
3130 mop = env->me_pghead;
3131 mop_len = (mop ? mop[0] : 0) + txn->mt_loose_count;
3133 /* Reserve records for me_pghead[]. Split it if multi-page,
3134 * to avoid searching freeDB for a page range. Use keys in
3135 * range [1,me_pglast]: Smaller than txnid of oldest reader.
3137 if (total_room >= mop_len) {
3138 if (total_room == mop_len || --more < 0)
3140 } else if (head_room >= maxfree_1pg && head_id > 1) {
3141 /* Keep current record (overflow page), add a new one */
3145 /* (Re)write {key = head_id, IDL length = head_room} */
3146 total_room -= head_room;
3147 head_room = mop_len - total_room;
3148 if (head_room > maxfree_1pg && head_id > 1) {
3149 /* Overflow multi-page for part of me_pghead */
3150 head_room /= head_id; /* amortize page sizes */
3151 head_room += maxfree_1pg - head_room % (maxfree_1pg + 1);
3152 } else if (head_room < 0) {
3153 /* Rare case, not bothering to delete this record */
3156 key.mv_size = sizeof(head_id);
3157 key.mv_data = &head_id;
3158 data.mv_size = (head_room + 1) * sizeof(pgno_t);
3159 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
3162 /* IDL is initially empty, zero out at least the length */
3163 pgs = (pgno_t *)data.mv_data;
3164 j = head_room > clean_limit ? head_room : 0;
3168 total_room += head_room;
3171 /* Return loose page numbers to me_pghead, though usually none are
3172 * left at this point. The pages themselves remain in dirty_list.
3174 if (txn->mt_loose_pgs) {
3175 MDB_page *mp = txn->mt_loose_pgs;
3176 unsigned count = txn->mt_loose_count;
3178 /* Room for loose pages + temp IDL with same */
3179 if ((rc = mdb_midl_need(&env->me_pghead, 2*count+1)) != 0)
3181 mop = env->me_pghead;
3182 loose = mop + MDB_IDL_ALLOCLEN(mop) - count;
3183 for (count = 0; mp; mp = NEXT_LOOSE_PAGE(mp))
3184 loose[ ++count ] = mp->mp_pgno;
3186 mdb_midl_sort(loose);
3187 mdb_midl_xmerge(mop, loose);
3188 txn->mt_loose_pgs = NULL;
3189 txn->mt_loose_count = 0;
3193 /* Fill in the reserved me_pghead records */
3199 rc = mdb_cursor_first(&mc, &key, &data);
3200 for (; !rc; rc = mdb_cursor_next(&mc, &key, &data, MDB_NEXT)) {
3201 txnid_t id = *(txnid_t *)key.mv_data;
3202 ssize_t len = (ssize_t)(data.mv_size / sizeof(MDB_ID)) - 1;
3205 mdb_tassert(txn, len >= 0 && id <= env->me_pglast);
3207 if (len > mop_len) {
3209 data.mv_size = (len + 1) * sizeof(MDB_ID);
3211 data.mv_data = mop -= len;
3214 rc = mdb_cursor_put(&mc, &key, &data, MDB_CURRENT);
3216 if (rc || !(mop_len -= len))
3223 /** Flush (some) dirty pages to the map, after clearing their dirty flag.
3224 * @param[in] txn the transaction that's being committed
3225 * @param[in] keep number of initial pages in dirty_list to keep dirty.
3226 * @return 0 on success, non-zero on failure.
3229 mdb_page_flush(MDB_txn *txn, int keep)
3231 MDB_env *env = txn->mt_env;
3232 MDB_ID2L dl = txn->mt_u.dirty_list;
3233 unsigned psize = env->me_psize, j;
3234 int i, pagecount = dl[0].mid, rc;
3235 size_t size = 0, pos = 0;
3237 MDB_page *dp = NULL;
3241 struct iovec iov[MDB_COMMIT_PAGES];
3242 ssize_t wpos = 0, wsize = 0, wres;
3243 size_t next_pos = 1; /* impossible pos, so pos != next_pos */
3249 if (env->me_flags & MDB_WRITEMAP) {
3250 /* Clear dirty flags */
3251 while (++i <= pagecount) {
3253 /* Don't flush this page yet */
3254 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3255 dp->mp_flags &= ~P_KEEP;
3259 dp->mp_flags &= ~P_DIRTY;
3264 /* Write the pages */
3266 if (++i <= pagecount) {
3268 /* Don't flush this page yet */
3269 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3270 dp->mp_flags &= ~P_KEEP;
3275 /* clear dirty flag */
3276 dp->mp_flags &= ~P_DIRTY;
3279 if (IS_OVERFLOW(dp)) size *= dp->mp_pages;
3284 /* Windows actually supports scatter/gather I/O, but only on
3285 * unbuffered file handles. Since we're relying on the OS page
3286 * cache for all our data, that's self-defeating. So we just
3287 * write pages one at a time. We use the ov structure to set
3288 * the write offset, to at least save the overhead of a Seek
3291 DPRINTF(("committing page %"Z"u", pgno));
3292 memset(&ov, 0, sizeof(ov));
3293 ov.Offset = pos & 0xffffffff;
3294 ov.OffsetHigh = pos >> 16 >> 16;
3295 if (!WriteFile(env->me_fd, dp, size, NULL, &ov)) {
3297 DPRINTF(("WriteFile: %d", rc));
3301 /* Write up to MDB_COMMIT_PAGES dirty pages at a time. */
3302 if (pos!=next_pos || n==MDB_COMMIT_PAGES || wsize+size>MAX_WRITE) {
3305 /* Write previous page(s) */
3306 #ifdef MDB_USE_PWRITEV
3307 wres = pwritev(env->me_fd, iov, n, wpos);
3310 wres = pwrite(env->me_fd, iov[0].iov_base, wsize, wpos);
3313 if (lseek(env->me_fd, wpos, SEEK_SET) == -1) {
3317 DPRINTF(("lseek: %s", strerror(rc)));
3320 wres = writev(env->me_fd, iov, n);
3323 if (wres != wsize) {
3328 DPRINTF(("Write error: %s", strerror(rc)));
3330 rc = EIO; /* TODO: Use which error code? */
3331 DPUTS("short write, filesystem full?");
3342 DPRINTF(("committing page %"Z"u", pgno));
3343 next_pos = pos + size;
3344 iov[n].iov_len = size;
3345 iov[n].iov_base = (char *)dp;
3351 /* MIPS has cache coherency issues, this is a no-op everywhere else
3352 * Note: for any size >= on-chip cache size, entire on-chip cache is
3355 CACHEFLUSH(env->me_map, txn->mt_next_pgno * env->me_psize, DCACHE);
3357 for (i = keep; ++i <= pagecount; ) {
3359 /* This is a page we skipped above */
3362 dl[j].mid = dp->mp_pgno;
3365 mdb_dpage_free(env, dp);
3370 txn->mt_dirty_room += i - j;
3376 mdb_txn_commit(MDB_txn *txn)
3379 unsigned int i, end_mode;
3385 /* mdb_txn_end() mode for a commit which writes nothing */
3386 end_mode = MDB_END_EMPTY_COMMIT|MDB_END_UPDATE|MDB_END_SLOT|MDB_END_FREE;
3388 if (txn->mt_child) {
3389 rc = mdb_txn_commit(txn->mt_child);
3396 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
3400 if (txn->mt_flags & (MDB_TXN_FINISHED|MDB_TXN_ERROR)) {
3401 DPUTS("txn has failed/finished, can't commit");
3403 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
3408 if (txn->mt_parent) {
3409 MDB_txn *parent = txn->mt_parent;
3413 unsigned x, y, len, ps_len;
3415 /* Append our free list to parent's */
3416 rc = mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs);
3419 mdb_midl_free(txn->mt_free_pgs);
3420 /* Failures after this must either undo the changes
3421 * to the parent or set MDB_TXN_ERROR in the parent.
3424 parent->mt_next_pgno = txn->mt_next_pgno;
3425 parent->mt_flags = txn->mt_flags;
3427 /* Merge our cursors into parent's and close them */
3428 mdb_cursors_close(txn, 1);
3430 /* Update parent's DB table. */
3431 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
3432 parent->mt_numdbs = txn->mt_numdbs;
3433 parent->mt_dbflags[FREE_DBI] = txn->mt_dbflags[FREE_DBI];
3434 parent->mt_dbflags[MAIN_DBI] = txn->mt_dbflags[MAIN_DBI];
3435 for (i=CORE_DBS; i<txn->mt_numdbs; i++) {
3436 /* preserve parent's DB_NEW status */
3437 x = parent->mt_dbflags[i] & DB_NEW;
3438 parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
3441 dst = parent->mt_u.dirty_list;
3442 src = txn->mt_u.dirty_list;
3443 /* Remove anything in our dirty list from parent's spill list */
3444 if ((pspill = parent->mt_spill_pgs) && (ps_len = pspill[0])) {
3446 pspill[0] = (pgno_t)-1;
3447 /* Mark our dirty pages as deleted in parent spill list */
3448 for (i=0, len=src[0].mid; ++i <= len; ) {
3449 MDB_ID pn = src[i].mid << 1;
3450 while (pn > pspill[x])
3452 if (pn == pspill[x]) {
3457 /* Squash deleted pagenums if we deleted any */
3458 for (x=y; ++x <= ps_len; )
3459 if (!(pspill[x] & 1))
3460 pspill[++y] = pspill[x];
3464 /* Find len = length of merging our dirty list with parent's */
3466 dst[0].mid = 0; /* simplify loops */
3467 if (parent->mt_parent) {
3468 len = x + src[0].mid;
3469 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
3470 for (i = x; y && i; y--) {
3471 pgno_t yp = src[y].mid;
3472 while (yp < dst[i].mid)
3474 if (yp == dst[i].mid) {
3479 } else { /* Simplify the above for single-ancestor case */
3480 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
3482 /* Merge our dirty list with parent's */
3484 for (i = len; y; dst[i--] = src[y--]) {
3485 pgno_t yp = src[y].mid;
3486 while (yp < dst[x].mid)
3487 dst[i--] = dst[x--];
3488 if (yp == dst[x].mid)
3489 free(dst[x--].mptr);
3491 mdb_tassert(txn, i == x);
3493 free(txn->mt_u.dirty_list);
3494 parent->mt_dirty_room = txn->mt_dirty_room;
3495 if (txn->mt_spill_pgs) {
3496 if (parent->mt_spill_pgs) {
3497 /* TODO: Prevent failure here, so parent does not fail */
3498 rc = mdb_midl_append_list(&parent->mt_spill_pgs, txn->mt_spill_pgs);
3500 parent->mt_flags |= MDB_TXN_ERROR;
3501 mdb_midl_free(txn->mt_spill_pgs);
3502 mdb_midl_sort(parent->mt_spill_pgs);
3504 parent->mt_spill_pgs = txn->mt_spill_pgs;
3508 /* Append our loose page list to parent's */
3509 for (lp = &parent->mt_loose_pgs; *lp; lp = &NEXT_LOOSE_PAGE(lp))
3511 *lp = txn->mt_loose_pgs;
3512 parent->mt_loose_count += txn->mt_loose_count;
3514 parent->mt_child = NULL;
3515 mdb_midl_free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pghead);
3520 if (txn != env->me_txn) {
3521 DPUTS("attempt to commit unknown transaction");
3526 mdb_cursors_close(txn, 0);
3528 if (!txn->mt_u.dirty_list[0].mid &&
3529 !(txn->mt_flags & (MDB_TXN_DIRTY|MDB_TXN_SPILLS)))
3532 DPRINTF(("committing txn %"Z"u %p on mdbenv %p, root page %"Z"u",
3533 txn->mt_txnid, (void*)txn, (void*)env, txn->mt_dbs[MAIN_DBI].md_root));
3535 /* Update DB root pointers */
3536 if (txn->mt_numdbs > CORE_DBS) {
3540 data.mv_size = sizeof(MDB_db);
3542 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
3543 for (i = CORE_DBS; i < txn->mt_numdbs; i++) {
3544 if (txn->mt_dbflags[i] & DB_DIRTY) {
3545 if (TXN_DBI_CHANGED(txn, i)) {
3549 data.mv_data = &txn->mt_dbs[i];
3550 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data,
3558 rc = mdb_freelist_save(txn);
3562 mdb_midl_free(env->me_pghead);
3563 env->me_pghead = NULL;
3564 mdb_midl_shrink(&txn->mt_free_pgs);
3570 if ((rc = mdb_page_flush(txn, 0)))
3572 if (!F_ISSET(txn->mt_flags, MDB_TXN_NOSYNC) &&
3573 (rc = mdb_env_sync(env, 0)))
3575 if ((rc = mdb_env_write_meta(txn)))
3577 end_mode = MDB_END_COMMITTED|MDB_END_UPDATE;
3580 mdb_txn_end(txn, end_mode);
3588 /** Read the environment parameters of a DB environment before
3589 * mapping it into memory.
3590 * @param[in] env the environment handle
3591 * @param[out] meta address of where to store the meta information
3592 * @return 0 on success, non-zero on failure.
3595 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
3601 enum { Size = sizeof(pbuf) };
3603 /* We don't know the page size yet, so use a minimum value.
3604 * Read both meta pages so we can use the latest one.
3607 for (i=off=0; i<NUM_METAS; i++, off += meta->mm_psize) {
3611 memset(&ov, 0, sizeof(ov));
3613 rc = ReadFile(env->me_fd, &pbuf, Size, &len, &ov) ? (int)len : -1;
3614 if (rc == -1 && ErrCode() == ERROR_HANDLE_EOF)
3617 rc = pread(env->me_fd, &pbuf, Size, off);
3620 if (rc == 0 && off == 0)
3622 rc = rc < 0 ? (int) ErrCode() : MDB_INVALID;
3623 DPRINTF(("read: %s", mdb_strerror(rc)));
3627 p = (MDB_page *)&pbuf;
3629 if (!F_ISSET(p->mp_flags, P_META)) {
3630 DPRINTF(("page %"Z"u not a meta page", p->mp_pgno));
3635 if (m->mm_magic != MDB_MAGIC) {
3636 DPUTS("meta has invalid magic");
3640 if (m->mm_version != MDB_DATA_VERSION) {
3641 DPRINTF(("database is version %u, expected version %u",
3642 m->mm_version, MDB_DATA_VERSION));
3643 return MDB_VERSION_MISMATCH;
3646 if (off == 0 || m->mm_txnid > meta->mm_txnid)
3652 /** Fill in most of the zeroed #MDB_meta for an empty database environment */
3654 mdb_env_init_meta0(MDB_env *env, MDB_meta *meta)
3656 meta->mm_magic = MDB_MAGIC;
3657 meta->mm_version = MDB_DATA_VERSION;
3658 meta->mm_mapsize = env->me_mapsize;
3659 meta->mm_psize = env->me_psize;
3660 meta->mm_last_pg = NUM_METAS-1;
3661 meta->mm_flags = env->me_flags & 0xffff;
3662 meta->mm_flags |= MDB_INTEGERKEY; /* this is mm_dbs[FREE_DBI].md_flags */
3663 meta->mm_dbs[FREE_DBI].md_root = P_INVALID;
3664 meta->mm_dbs[MAIN_DBI].md_root = P_INVALID;
3667 /** Write the environment parameters of a freshly created DB environment.
3668 * @param[in] env the environment handle
3669 * @param[in] meta the #MDB_meta to write
3670 * @return 0 on success, non-zero on failure.
3673 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
3681 memset(&ov, 0, sizeof(ov));
3682 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3684 rc = WriteFile(fd, ptr, size, &len, &ov); } while(0)
3687 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3688 len = pwrite(fd, ptr, size, pos); \
3689 if (len == -1 && ErrCode() == EINTR) continue; \
3690 rc = (len >= 0); break; } while(1)
3693 DPUTS("writing new meta page");
3695 psize = env->me_psize;
3697 p = calloc(NUM_METAS, psize);
3701 p->mp_flags = P_META;
3702 *(MDB_meta *)METADATA(p) = *meta;
3704 q = (MDB_page *)((char *)p + psize);
3706 q->mp_flags = P_META;
3707 *(MDB_meta *)METADATA(q) = *meta;
3709 DO_PWRITE(rc, env->me_fd, p, psize * NUM_METAS, len, 0);
3712 else if ((unsigned) len == psize * NUM_METAS)
3720 /** Update the environment info to commit a transaction.
3721 * @param[in] txn the transaction that's being committed
3722 * @return 0 on success, non-zero on failure.
3725 mdb_env_write_meta(MDB_txn *txn)
3728 MDB_meta meta, metab, *mp;
3732 int rc, len, toggle;
3741 toggle = txn->mt_txnid & 1;
3742 DPRINTF(("writing meta page %d for root page %"Z"u",
3743 toggle, txn->mt_dbs[MAIN_DBI].md_root));
3746 flags = txn->mt_flags & env->me_flags;
3747 mp = env->me_metas[toggle];
3748 mapsize = env->me_metas[toggle ^ 1]->mm_mapsize;
3749 /* Persist any increases of mapsize config */
3750 if (mapsize < env->me_mapsize)
3751 mapsize = env->me_mapsize;
3753 if (flags & MDB_WRITEMAP) {
3754 mp->mm_mapsize = mapsize;
3755 mp->mm_dbs[FREE_DBI] = txn->mt_dbs[FREE_DBI];
3756 mp->mm_dbs[MAIN_DBI] = txn->mt_dbs[MAIN_DBI];
3757 mp->mm_last_pg = txn->mt_next_pgno - 1;
3758 #if (__GNUC__ * 100 + __GNUC_MINOR__ >= 404) && /* TODO: portability */ \
3759 !(defined(__i386__) || defined(__x86_64__))
3760 /* LY: issue a memory barrier, if not x86. ITS#7969 */
3761 __sync_synchronize();
3763 mp->mm_txnid = txn->mt_txnid;
3764 if (!(flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
3765 unsigned meta_size = env->me_psize;
3766 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
3767 ptr = (char *)mp - PAGEHDRSZ;
3768 #ifndef _WIN32 /* POSIX msync() requires ptr = start of OS page */
3769 r2 = (ptr - env->me_map) & (env->me_os_psize - 1);
3773 if (MDB_MSYNC(ptr, meta_size, rc)) {
3780 metab.mm_txnid = mp->mm_txnid;
3781 metab.mm_last_pg = mp->mm_last_pg;
3783 meta.mm_mapsize = mapsize;
3784 meta.mm_dbs[FREE_DBI] = txn->mt_dbs[FREE_DBI];
3785 meta.mm_dbs[MAIN_DBI] = txn->mt_dbs[MAIN_DBI];
3786 meta.mm_last_pg = txn->mt_next_pgno - 1;
3787 meta.mm_txnid = txn->mt_txnid;
3789 off = offsetof(MDB_meta, mm_mapsize);
3790 ptr = (char *)&meta + off;
3791 len = sizeof(MDB_meta) - off;
3792 off += (char *)mp - env->me_map;
3794 /* Write to the SYNC fd */
3795 mfd = (flags & (MDB_NOSYNC|MDB_NOMETASYNC)) ? env->me_fd : env->me_mfd;
3798 memset(&ov, 0, sizeof(ov));
3800 if (!WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov))
3805 rc = pwrite(mfd, ptr, len, off);
3808 rc = rc < 0 ? ErrCode() : EIO;
3813 DPUTS("write failed, disk error?");
3814 /* On a failure, the pagecache still contains the new data.
3815 * Write some old data back, to prevent it from being used.
3816 * Use the non-SYNC fd; we know it will fail anyway.
3818 meta.mm_last_pg = metab.mm_last_pg;
3819 meta.mm_txnid = metab.mm_txnid;
3821 memset(&ov, 0, sizeof(ov));
3823 WriteFile(env->me_fd, ptr, len, NULL, &ov);
3825 r2 = pwrite(env->me_fd, ptr, len, off);
3826 (void)r2; /* Silence warnings. We don't care about pwrite's return value */
3829 env->me_flags |= MDB_FATAL_ERROR;
3832 /* MIPS has cache coherency issues, this is a no-op everywhere else */
3833 CACHEFLUSH(env->me_map + off, len, DCACHE);
3835 /* Memory ordering issues are irrelevant; since the entire writer
3836 * is wrapped by wmutex, all of these changes will become visible
3837 * after the wmutex is unlocked. Since the DB is multi-version,
3838 * readers will get consistent data regardless of how fresh or
3839 * how stale their view of these values is.
3842 env->me_txns->mti_txnid = txn->mt_txnid;
3847 /** Check both meta pages to see which one is newer.
3848 * @param[in] env the environment handle
3849 * @return newest #MDB_meta.
3852 mdb_env_pick_meta(const MDB_env *env)
3854 MDB_meta *const *metas = env->me_metas;
3855 return metas[ metas[0]->mm_txnid < metas[1]->mm_txnid ];
3859 mdb_env_create(MDB_env **env)
3863 e = calloc(1, sizeof(MDB_env));
3867 e->me_maxreaders = DEFAULT_READERS;
3868 e->me_maxdbs = e->me_numdbs = CORE_DBS;
3869 e->me_fd = INVALID_HANDLE_VALUE;
3870 e->me_lfd = INVALID_HANDLE_VALUE;
3871 e->me_mfd = INVALID_HANDLE_VALUE;
3872 #ifdef MDB_USE_POSIX_SEM
3873 e->me_rmutex = SEM_FAILED;
3874 e->me_wmutex = SEM_FAILED;
3875 #elif defined MDB_USE_SYSV_SEM
3876 e->me_rmutex->semid = -1;
3877 e->me_wmutex->semid = -1;
3879 e->me_pid = getpid();
3880 GET_PAGESIZE(e->me_os_psize);
3881 VGMEMP_CREATE(e,0,0);
3887 mdb_env_map(MDB_env *env, void *addr)
3890 unsigned int flags = env->me_flags;
3894 LONG sizelo, sizehi;
3897 if (flags & MDB_RDONLY) {
3898 /* Don't set explicit map size, use whatever exists */
3903 msize = env->me_mapsize;
3904 sizelo = msize & 0xffffffff;
3905 sizehi = msize >> 16 >> 16; /* only needed on Win64 */
3907 /* Windows won't create mappings for zero length files.
3908 * and won't map more than the file size.
3909 * Just set the maxsize right now.
3911 if (SetFilePointer(env->me_fd, sizelo, &sizehi, 0) != (DWORD)sizelo
3912 || !SetEndOfFile(env->me_fd)
3913 || SetFilePointer(env->me_fd, 0, NULL, 0) != 0)
3917 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
3918 PAGE_READWRITE : PAGE_READONLY,
3919 sizehi, sizelo, NULL);
3922 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
3923 FILE_MAP_WRITE : FILE_MAP_READ,
3925 rc = env->me_map ? 0 : ErrCode();
3930 int prot = PROT_READ;
3931 if (flags & MDB_WRITEMAP) {
3933 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
3936 env->me_map = mmap(addr, env->me_mapsize, prot, MAP_SHARED,
3938 if (env->me_map == MAP_FAILED) {
3943 if (flags & MDB_NORDAHEAD) {
3944 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
3946 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
3948 #ifdef POSIX_MADV_RANDOM
3949 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
3950 #endif /* POSIX_MADV_RANDOM */
3951 #endif /* MADV_RANDOM */
3955 /* Can happen because the address argument to mmap() is just a
3956 * hint. mmap() can pick another, e.g. if the range is in use.
3957 * The MAP_FIXED flag would prevent that, but then mmap could
3958 * instead unmap existing pages to make room for the new map.
3960 if (addr && env->me_map != addr)
3961 return EBUSY; /* TODO: Make a new MDB_* error code? */
3963 p = (MDB_page *)env->me_map;
3964 env->me_metas[0] = METADATA(p);
3965 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + env->me_psize);
3971 mdb_env_set_mapsize(MDB_env *env, size_t size)
3973 /* If env is already open, caller is responsible for making
3974 * sure there are no active txns.
3982 meta = mdb_env_pick_meta(env);
3984 size = meta->mm_mapsize;
3986 /* Silently round up to minimum if the size is too small */
3987 size_t minsize = (meta->mm_last_pg + 1) * env->me_psize;
3991 munmap(env->me_map, env->me_mapsize);
3992 env->me_mapsize = size;
3993 old = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : NULL;
3994 rc = mdb_env_map(env, old);
3998 env->me_mapsize = size;
4000 env->me_maxpg = env->me_mapsize / env->me_psize;
4005 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
4009 env->me_maxdbs = dbs + CORE_DBS;
4014 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
4016 if (env->me_map || readers < 1)
4018 env->me_maxreaders = readers;
4023 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
4025 if (!env || !readers)
4027 *readers = env->me_maxreaders;
4032 mdb_fsize(HANDLE fd, size_t *size)
4035 LARGE_INTEGER fsize;
4037 if (!GetFileSizeEx(fd, &fsize))
4040 *size = fsize.QuadPart;
4052 #ifdef BROKEN_FDATASYNC
4053 #include <sys/utsname.h>
4054 #include <sys/vfs.h>
4057 /** Further setup required for opening an LMDB environment
4060 mdb_env_open2(MDB_env *env)
4062 unsigned int flags = env->me_flags;
4063 int i, newenv = 0, rc;
4067 /* See if we should use QueryLimited */
4069 if ((rc & 0xff) > 5)
4070 env->me_pidquery = MDB_PROCESS_QUERY_LIMITED_INFORMATION;
4072 env->me_pidquery = PROCESS_QUERY_INFORMATION;
4075 #ifdef BROKEN_FDATASYNC
4076 /* ext3/ext4 fdatasync is broken on some older Linux kernels.
4077 * https://lkml.org/lkml/2012/9/3/83
4078 * Kernels after 3.6-rc6 are known good.
4079 * https://lkml.org/lkml/2012/9/10/556
4080 * See if the DB is on ext3/ext4, then check for new enough kernel
4081 * Kernels 2.6.32.60, 2.6.34.15, 3.2.30, and 3.5.4 are also known
4086 fstatfs(env->me_fd, &st);
4087 while (st.f_type == 0xEF53) {
4091 if (uts.release[0] < '3') {
4092 if (!strncmp(uts.release, "2.6.32.", 7)) {
4093 i = atoi(uts.release+7);
4095 break; /* 2.6.32.60 and newer is OK */
4096 } else if (!strncmp(uts.release, "2.6.34.", 7)) {
4097 i = atoi(uts.release+7);
4099 break; /* 2.6.34.15 and newer is OK */
4101 } else if (uts.release[0] == '3') {
4102 i = atoi(uts.release+2);
4104 break; /* 3.6 and newer is OK */
4106 i = atoi(uts.release+4);
4108 break; /* 3.5.4 and newer is OK */
4109 } else if (i == 2) {
4110 i = atoi(uts.release+4);
4112 break; /* 3.2.30 and newer is OK */
4114 } else { /* 4.x and newer is OK */
4117 env->me_flags |= MDB_FSYNCONLY;
4123 if ((i = mdb_env_read_header(env, &meta)) != 0) {
4126 DPUTS("new mdbenv");
4128 env->me_psize = env->me_os_psize;
4129 if (env->me_psize > MAX_PAGESIZE)
4130 env->me_psize = MAX_PAGESIZE;
4131 memset(&meta, 0, sizeof(meta));
4132 mdb_env_init_meta0(env, &meta);
4133 meta.mm_mapsize = DEFAULT_MAPSIZE;
4135 env->me_psize = meta.mm_psize;
4138 /* Was a mapsize configured? */
4139 if (!env->me_mapsize) {
4140 env->me_mapsize = meta.mm_mapsize;
4143 /* Make sure mapsize >= committed data size. Even when using
4144 * mm_mapsize, which could be broken in old files (ITS#7789).
4146 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
4147 if (env->me_mapsize < minsize)
4148 env->me_mapsize = minsize;
4150 meta.mm_mapsize = env->me_mapsize;
4152 if (newenv && !(flags & MDB_FIXEDMAP)) {
4153 /* mdb_env_map() may grow the datafile. Write the metapages
4154 * first, so the file will be valid if initialization fails.
4155 * Except with FIXEDMAP, since we do not yet know mm_address.
4156 * We could fill in mm_address later, but then a different
4157 * program might end up doing that - one with a memory layout
4158 * and map address which does not suit the main program.
4160 rc = mdb_env_init_meta(env, &meta);
4166 rc = mdb_env_map(env, (flags & MDB_FIXEDMAP) ? meta.mm_address : NULL);
4171 if (flags & MDB_FIXEDMAP)
4172 meta.mm_address = env->me_map;
4173 i = mdb_env_init_meta(env, &meta);
4174 if (i != MDB_SUCCESS) {
4179 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
4180 env->me_nodemax = (((env->me_psize - PAGEHDRSZ) / MDB_MINKEYS) & -2)
4182 #if !(MDB_MAXKEYSIZE)
4183 env->me_maxkey = env->me_nodemax - (NODESIZE + sizeof(MDB_db));
4185 env->me_maxpg = env->me_mapsize / env->me_psize;
4189 MDB_meta *meta = mdb_env_pick_meta(env);
4190 MDB_db *db = &meta->mm_dbs[MAIN_DBI];
4192 DPRINTF(("opened database version %u, pagesize %u",
4193 meta->mm_version, env->me_psize));
4194 DPRINTF(("using meta page %d", (int) (meta->mm_txnid & 1)));
4195 DPRINTF(("depth: %u", db->md_depth));
4196 DPRINTF(("entries: %"Z"u", db->md_entries));
4197 DPRINTF(("branch pages: %"Z"u", db->md_branch_pages));
4198 DPRINTF(("leaf pages: %"Z"u", db->md_leaf_pages));
4199 DPRINTF(("overflow pages: %"Z"u", db->md_overflow_pages));
4200 DPRINTF(("root: %"Z"u", db->md_root));
4208 /** Release a reader thread's slot in the reader lock table.
4209 * This function is called automatically when a thread exits.
4210 * @param[in] ptr This points to the slot in the reader lock table.
4213 mdb_env_reader_dest(void *ptr)
4215 MDB_reader *reader = ptr;
4221 /** Junk for arranging thread-specific callbacks on Windows. This is
4222 * necessarily platform and compiler-specific. Windows supports up
4223 * to 1088 keys. Let's assume nobody opens more than 64 environments
4224 * in a single process, for now. They can override this if needed.
4226 #ifndef MAX_TLS_KEYS
4227 #define MAX_TLS_KEYS 64
4229 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
4230 static int mdb_tls_nkeys;
4232 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
4236 case DLL_PROCESS_ATTACH: break;
4237 case DLL_THREAD_ATTACH: break;
4238 case DLL_THREAD_DETACH:
4239 for (i=0; i<mdb_tls_nkeys; i++) {
4240 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
4242 mdb_env_reader_dest(r);
4246 case DLL_PROCESS_DETACH: break;
4251 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
4253 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
4257 /* Force some symbol references.
4258 * _tls_used forces the linker to create the TLS directory if not already done
4259 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
4261 #pragma comment(linker, "/INCLUDE:_tls_used")
4262 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
4263 #pragma const_seg(".CRT$XLB")
4264 extern const PIMAGE_TLS_CALLBACK mdb_tls_cbp;
4265 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
4268 #pragma comment(linker, "/INCLUDE:__tls_used")
4269 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
4270 #pragma data_seg(".CRT$XLB")
4271 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
4273 #endif /* WIN 32/64 */
4274 #endif /* !__GNUC__ */
4277 /** Downgrade the exclusive lock on the region back to shared */
4279 mdb_env_share_locks(MDB_env *env, int *excl)
4282 MDB_meta *meta = mdb_env_pick_meta(env);
4284 env->me_txns->mti_txnid = meta->mm_txnid;
4289 /* First acquire a shared lock. The Unlock will
4290 * then release the existing exclusive lock.
4292 memset(&ov, 0, sizeof(ov));
4293 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
4296 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4302 struct flock lock_info;
4303 /* The shared lock replaces the existing lock */
4304 memset((void *)&lock_info, 0, sizeof(lock_info));
4305 lock_info.l_type = F_RDLCK;
4306 lock_info.l_whence = SEEK_SET;
4307 lock_info.l_start = 0;
4308 lock_info.l_len = 1;
4309 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
4310 (rc = ErrCode()) == EINTR) ;
4311 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
4318 /** Try to get exclusive lock, otherwise shared.
4319 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
4322 mdb_env_excl_lock(MDB_env *env, int *excl)
4326 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
4330 memset(&ov, 0, sizeof(ov));
4331 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
4338 struct flock lock_info;
4339 memset((void *)&lock_info, 0, sizeof(lock_info));
4340 lock_info.l_type = F_WRLCK;
4341 lock_info.l_whence = SEEK_SET;
4342 lock_info.l_start = 0;
4343 lock_info.l_len = 1;
4344 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
4345 (rc = ErrCode()) == EINTR) ;
4349 # ifndef MDB_USE_POSIX_MUTEX
4350 if (*excl < 0) /* always true when MDB_USE_POSIX_MUTEX */
4353 lock_info.l_type = F_RDLCK;
4354 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
4355 (rc = ErrCode()) == EINTR) ;
4365 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
4367 * @(#) $Revision: 5.1 $
4368 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
4369 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
4371 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
4375 * Please do not copyright this code. This code is in the public domain.
4377 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
4378 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
4379 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
4380 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
4381 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
4382 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4383 * PERFORMANCE OF THIS SOFTWARE.
4386 * chongo <Landon Curt Noll> /\oo/\
4387 * http://www.isthe.com/chongo/
4389 * Share and Enjoy! :-)
4392 typedef unsigned long long mdb_hash_t;
4393 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
4395 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
4396 * @param[in] val value to hash
4397 * @param[in] hval initial value for hash
4398 * @return 64 bit hash
4400 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
4401 * hval arg on the first call.
4404 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
4406 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
4407 unsigned char *end = s + val->mv_size;
4409 * FNV-1a hash each octet of the string
4412 /* xor the bottom with the current octet */
4413 hval ^= (mdb_hash_t)*s++;
4415 /* multiply by the 64 bit FNV magic prime mod 2^64 */
4416 hval += (hval << 1) + (hval << 4) + (hval << 5) +
4417 (hval << 7) + (hval << 8) + (hval << 40);
4419 /* return our new hash value */
4423 /** Hash the string and output the encoded hash.
4424 * This uses modified RFC1924 Ascii85 encoding to accommodate systems with
4425 * very short name limits. We don't care about the encoding being reversible,
4426 * we just want to preserve as many bits of the input as possible in a
4427 * small printable string.
4428 * @param[in] str string to hash
4429 * @param[out] encbuf an array of 11 chars to hold the hash
4431 static const char mdb_a85[]= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!#$%&()*+-;<=>?@^_`{|}~";
4434 mdb_pack85(unsigned long l, char *out)
4438 for (i=0; i<5; i++) {
4439 *out++ = mdb_a85[l % 85];
4445 mdb_hash_enc(MDB_val *val, char *encbuf)
4447 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
4449 mdb_pack85(h, encbuf);
4450 mdb_pack85(h>>32, encbuf+5);
4455 /** Open and/or initialize the lock region for the environment.
4456 * @param[in] env The LMDB environment.
4457 * @param[in] lpath The pathname of the file used for the lock region.
4458 * @param[in] mode The Unix permissions for the file, if we create it.
4459 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
4460 * @return 0 on success, non-zero on failure.
4463 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
4466 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
4468 # define MDB_ERRCODE_ROFS EROFS
4469 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
4470 # define MDB_CLOEXEC O_CLOEXEC
4473 # define MDB_CLOEXEC 0
4476 #ifdef MDB_USE_SYSV_SEM
4484 env->me_lfd = CreateFileA(lpath, GENERIC_READ|GENERIC_WRITE,
4485 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
4486 FILE_ATTRIBUTE_NORMAL, NULL);
4488 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
4490 if (env->me_lfd == INVALID_HANDLE_VALUE) {
4492 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
4497 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
4498 /* Lose record locks when exec*() */
4499 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
4500 fcntl(env->me_lfd, F_SETFD, fdflags);
4503 if (!(env->me_flags & MDB_NOTLS)) {
4504 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
4507 env->me_flags |= MDB_ENV_TXKEY;
4509 /* Windows TLS callbacks need help finding their TLS info. */
4510 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
4514 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
4518 /* Try to get exclusive lock. If we succeed, then
4519 * nobody is using the lock region and we should initialize it.
4521 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
4524 size = GetFileSize(env->me_lfd, NULL);
4526 size = lseek(env->me_lfd, 0, SEEK_END);
4527 if (size == -1) goto fail_errno;
4529 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
4530 if (size < rsize && *excl > 0) {
4532 if (SetFilePointer(env->me_lfd, rsize, NULL, FILE_BEGIN) != (DWORD)rsize
4533 || !SetEndOfFile(env->me_lfd))
4536 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
4540 size = rsize - sizeof(MDB_txninfo);
4541 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
4546 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
4548 if (!mh) goto fail_errno;
4549 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
4551 if (!env->me_txns) goto fail_errno;
4553 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
4555 if (m == MAP_FAILED) goto fail_errno;
4561 BY_HANDLE_FILE_INFORMATION stbuf;
4570 if (!mdb_sec_inited) {
4571 InitializeSecurityDescriptor(&mdb_null_sd,
4572 SECURITY_DESCRIPTOR_REVISION);
4573 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
4574 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
4575 mdb_all_sa.bInheritHandle = FALSE;
4576 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
4579 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
4580 idbuf.volume = stbuf.dwVolumeSerialNumber;
4581 idbuf.nhigh = stbuf.nFileIndexHigh;
4582 idbuf.nlow = stbuf.nFileIndexLow;
4583 val.mv_data = &idbuf;
4584 val.mv_size = sizeof(idbuf);
4585 mdb_hash_enc(&val, encbuf);
4586 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", encbuf);
4587 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", encbuf);
4588 env->me_rmutex = CreateMutexA(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
4589 if (!env->me_rmutex) goto fail_errno;
4590 env->me_wmutex = CreateMutexA(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
4591 if (!env->me_wmutex) goto fail_errno;
4592 #elif defined(MDB_USE_POSIX_SEM)
4601 #if defined(__NetBSD__)
4602 #define MDB_SHORT_SEMNAMES 1 /* limited to 14 chars */
4604 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
4605 idbuf.dev = stbuf.st_dev;
4606 idbuf.ino = stbuf.st_ino;
4607 val.mv_data = &idbuf;
4608 val.mv_size = sizeof(idbuf);
4609 mdb_hash_enc(&val, encbuf);
4610 #ifdef MDB_SHORT_SEMNAMES
4611 encbuf[9] = '\0'; /* drop name from 15 chars to 14 chars */
4613 sprintf(env->me_txns->mti_rmname, "/MDBr%s", encbuf);
4614 sprintf(env->me_txns->mti_wmname, "/MDBw%s", encbuf);
4615 /* Clean up after a previous run, if needed: Try to
4616 * remove both semaphores before doing anything else.
4618 sem_unlink(env->me_txns->mti_rmname);
4619 sem_unlink(env->me_txns->mti_wmname);
4620 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
4621 O_CREAT|O_EXCL, mode, 1);
4622 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4623 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
4624 O_CREAT|O_EXCL, mode, 1);
4625 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4626 #elif defined(MDB_USE_SYSV_SEM)
4627 unsigned short vals[2] = {1, 1};
4628 key_t key = ftok(lpath, 'M');
4631 semid = semget(key, 2, (mode & 0777) | IPC_CREAT);
4635 if (semctl(semid, 0, SETALL, semu) < 0)
4637 env->me_txns->mti_semid = semid;
4638 #else /* MDB_USE_POSIX_MUTEX: */
4639 pthread_mutexattr_t mattr;
4641 if ((rc = pthread_mutexattr_init(&mattr))
4642 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
4643 #ifdef MDB_ROBUST_SUPPORTED
4644 || (rc = pthread_mutexattr_setrobust(&mattr, PTHREAD_MUTEX_ROBUST))
4646 || (rc = pthread_mutex_init(env->me_txns->mti_rmutex, &mattr))
4647 || (rc = pthread_mutex_init(env->me_txns->mti_wmutex, &mattr)))
4649 pthread_mutexattr_destroy(&mattr);
4650 #endif /* _WIN32 || ... */
4652 env->me_txns->mti_magic = MDB_MAGIC;
4653 env->me_txns->mti_format = MDB_LOCK_FORMAT;
4654 env->me_txns->mti_txnid = 0;
4655 env->me_txns->mti_numreaders = 0;
4658 #ifdef MDB_USE_SYSV_SEM
4659 struct semid_ds buf;
4661 if (env->me_txns->mti_magic != MDB_MAGIC) {
4662 DPUTS("lock region has invalid magic");
4666 if (env->me_txns->mti_format != MDB_LOCK_FORMAT) {
4667 DPRINTF(("lock region has format+version 0x%x, expected 0x%x",
4668 env->me_txns->mti_format, MDB_LOCK_FORMAT));
4669 rc = MDB_VERSION_MISMATCH;
4673 if (rc && rc != EACCES && rc != EAGAIN) {
4677 env->me_rmutex = OpenMutexA(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
4678 if (!env->me_rmutex) goto fail_errno;
4679 env->me_wmutex = OpenMutexA(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
4680 if (!env->me_wmutex) goto fail_errno;
4681 #elif defined(MDB_USE_POSIX_SEM)
4682 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
4683 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4684 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
4685 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4686 #elif defined(MDB_USE_SYSV_SEM)
4687 semid = env->me_txns->mti_semid;
4689 /* check for read access */
4690 if (semctl(semid, 0, IPC_STAT, semu) < 0)
4692 /* check for write access */
4693 if (semctl(semid, 0, IPC_SET, semu) < 0)
4697 #ifdef MDB_USE_SYSV_SEM
4698 env->me_rmutex->semid = semid;
4699 env->me_wmutex->semid = semid;
4700 env->me_rmutex->semnum = 0;
4701 env->me_wmutex->semnum = 1;
4702 env->me_rmutex->locked = &env->me_txns->mti_rlocked;
4703 env->me_wmutex->locked = &env->me_txns->mti_wlocked;
4714 /** The name of the lock file in the DB environment */
4715 #define LOCKNAME "/lock.mdb"
4716 /** The name of the data file in the DB environment */
4717 #define DATANAME "/data.mdb"
4718 /** The suffix of the lock file when no subdir is used */
4719 #define LOCKSUFF "-lock"
4720 /** Only a subset of the @ref mdb_env flags can be changed
4721 * at runtime. Changing other flags requires closing the
4722 * environment and re-opening it with the new flags.
4724 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC|MDB_NOMEMINIT)
4725 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY| \
4726 MDB_WRITEMAP|MDB_NOTLS|MDB_NOLOCK|MDB_NORDAHEAD)
4728 #if VALID_FLAGS & PERSISTENT_FLAGS & (CHANGEABLE|CHANGELESS)
4729 # error "Persistent DB flags & env flags overlap, but both go in mm_flags"
4733 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
4735 int oflags, rc, len, excl = -1;
4736 char *lpath, *dpath;
4738 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
4742 if (flags & MDB_NOSUBDIR) {
4743 rc = len + sizeof(LOCKSUFF) + len + 1;
4745 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
4750 if (flags & MDB_NOSUBDIR) {
4751 dpath = lpath + len + sizeof(LOCKSUFF);
4752 sprintf(lpath, "%s" LOCKSUFF, path);
4753 strcpy(dpath, path);
4755 dpath = lpath + len + sizeof(LOCKNAME);
4756 sprintf(lpath, "%s" LOCKNAME, path);
4757 sprintf(dpath, "%s" DATANAME, path);
4761 flags |= env->me_flags;
4762 if (flags & MDB_RDONLY) {
4763 /* silently ignore WRITEMAP when we're only getting read access */
4764 flags &= ~MDB_WRITEMAP;
4766 if (!((env->me_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)) &&
4767 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
4770 env->me_flags = flags |= MDB_ENV_ACTIVE;
4774 env->me_path = strdup(path);
4775 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
4776 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
4777 env->me_dbiseqs = calloc(env->me_maxdbs, sizeof(unsigned int));
4778 if (!(env->me_dbxs && env->me_path && env->me_dbflags && env->me_dbiseqs)) {
4782 env->me_dbxs[FREE_DBI].md_cmp = mdb_cmp_long; /* aligned MDB_INTEGERKEY */
4784 /* For RDONLY, get lockfile after we know datafile exists */
4785 if (!(flags & (MDB_RDONLY|MDB_NOLOCK))) {
4786 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4792 if (F_ISSET(flags, MDB_RDONLY)) {
4793 oflags = GENERIC_READ;
4794 len = OPEN_EXISTING;
4796 oflags = GENERIC_READ|GENERIC_WRITE;
4799 mode = FILE_ATTRIBUTE_NORMAL;
4800 env->me_fd = CreateFileA(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
4801 NULL, len, mode, NULL);
4803 if (F_ISSET(flags, MDB_RDONLY))
4806 oflags = O_RDWR | O_CREAT;
4808 env->me_fd = open(dpath, oflags, mode);
4810 if (env->me_fd == INVALID_HANDLE_VALUE) {
4815 if ((flags & (MDB_RDONLY|MDB_NOLOCK)) == MDB_RDONLY) {
4816 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4821 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
4822 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
4823 env->me_mfd = env->me_fd;
4825 /* Synchronous fd for meta writes. Needed even with
4826 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
4829 len = OPEN_EXISTING;
4830 env->me_mfd = CreateFileA(dpath, oflags,
4831 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
4832 mode | FILE_FLAG_WRITE_THROUGH, NULL);
4835 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
4837 if (env->me_mfd == INVALID_HANDLE_VALUE) {
4842 DPRINTF(("opened dbenv %p", (void *) env));
4844 rc = mdb_env_share_locks(env, &excl);
4848 if (!(flags & MDB_RDONLY)) {
4850 int tsize = sizeof(MDB_txn), size = tsize + env->me_maxdbs *
4851 (sizeof(MDB_db)+sizeof(MDB_cursor *)+sizeof(unsigned int)+1);
4852 if ((env->me_pbuf = calloc(1, env->me_psize)) &&
4853 (txn = calloc(1, size)))
4855 txn->mt_dbs = (MDB_db *)((char *)txn + tsize);
4856 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
4857 txn->mt_dbiseqs = (unsigned int *)(txn->mt_cursors + env->me_maxdbs);
4858 txn->mt_dbflags = (unsigned char *)(txn->mt_dbiseqs + env->me_maxdbs);
4860 txn->mt_dbxs = env->me_dbxs;
4861 txn->mt_flags = MDB_TXN_FINISHED;
4871 mdb_env_close0(env, excl);
4877 /** Destroy resources from mdb_env_open(), clear our readers & DBIs */
4879 mdb_env_close0(MDB_env *env, int excl)
4883 if (!(env->me_flags & MDB_ENV_ACTIVE))
4886 /* Doing this here since me_dbxs may not exist during mdb_env_close */
4888 for (i = env->me_maxdbs; --i >= CORE_DBS; )
4889 free(env->me_dbxs[i].md_name.mv_data);
4894 free(env->me_dbiseqs);
4895 free(env->me_dbflags);
4897 free(env->me_dirty_list);
4899 mdb_midl_free(env->me_free_pgs);
4901 if (env->me_flags & MDB_ENV_TXKEY) {
4902 pthread_key_delete(env->me_txkey);
4904 /* Delete our key from the global list */
4905 for (i=0; i<mdb_tls_nkeys; i++)
4906 if (mdb_tls_keys[i] == env->me_txkey) {
4907 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
4915 munmap(env->me_map, env->me_mapsize);
4917 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
4918 (void) close(env->me_mfd);
4919 if (env->me_fd != INVALID_HANDLE_VALUE)
4920 (void) close(env->me_fd);
4922 MDB_PID_T pid = env->me_pid;
4923 /* Clearing readers is done in this function because
4924 * me_txkey with its destructor must be disabled first.
4926 * We skip the the reader mutex, so we touch only
4927 * data owned by this process (me_close_readers and
4928 * our readers), and clear each reader atomically.
4930 for (i = env->me_close_readers; --i >= 0; )
4931 if (env->me_txns->mti_readers[i].mr_pid == pid)
4932 env->me_txns->mti_readers[i].mr_pid = 0;
4934 if (env->me_rmutex) {
4935 CloseHandle(env->me_rmutex);
4936 if (env->me_wmutex) CloseHandle(env->me_wmutex);
4938 /* Windows automatically destroys the mutexes when
4939 * the last handle closes.
4941 #elif defined(MDB_USE_POSIX_SEM)
4942 if (env->me_rmutex != SEM_FAILED) {
4943 sem_close(env->me_rmutex);
4944 if (env->me_wmutex != SEM_FAILED)
4945 sem_close(env->me_wmutex);
4946 /* If we have the filelock: If we are the
4947 * only remaining user, clean up semaphores.
4950 mdb_env_excl_lock(env, &excl);
4952 sem_unlink(env->me_txns->mti_rmname);
4953 sem_unlink(env->me_txns->mti_wmname);
4956 #elif defined(MDB_USE_SYSV_SEM)
4957 if (env->me_rmutex->semid != -1) {
4958 /* If we have the filelock: If we are the
4959 * only remaining user, clean up semaphores.
4962 mdb_env_excl_lock(env, &excl);
4964 semctl(env->me_rmutex->semid, 0, IPC_RMID);
4967 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
4969 if (env->me_lfd != INVALID_HANDLE_VALUE) {
4972 /* Unlock the lockfile. Windows would have unlocked it
4973 * after closing anyway, but not necessarily at once.
4975 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4978 (void) close(env->me_lfd);
4981 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
4985 mdb_env_close(MDB_env *env)
4992 VGMEMP_DESTROY(env);
4993 while ((dp = env->me_dpages) != NULL) {
4994 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
4995 env->me_dpages = dp->mp_next;
4999 mdb_env_close0(env, 0);
5003 /** Compare two items pointing at aligned size_t's */
5005 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
5007 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
5008 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
5011 /** Compare two items pointing at aligned unsigned int's.
5013 * This is also set as #MDB_INTEGERDUP|#MDB_DUPFIXED's #MDB_dbx.%md_dcmp,
5014 * but #mdb_cmp_clong() is called instead if the data type is size_t.
5017 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
5019 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
5020 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
5023 /** Compare two items pointing at unsigned ints of unknown alignment.
5024 * Nodes and keys are guaranteed to be 2-byte aligned.
5027 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
5029 #if BYTE_ORDER == LITTLE_ENDIAN
5030 unsigned short *u, *c;
5033 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
5034 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
5037 } while(!x && u > (unsigned short *)a->mv_data);
5040 unsigned short *u, *c, *end;
5043 end = (unsigned short *) ((char *) a->mv_data + a->mv_size);
5044 u = (unsigned short *)a->mv_data;
5045 c = (unsigned short *)b->mv_data;
5048 } while(!x && u < end);
5053 /** Compare two items lexically */
5055 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
5062 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
5068 diff = memcmp(a->mv_data, b->mv_data, len);
5069 return diff ? diff : len_diff<0 ? -1 : len_diff;
5072 /** Compare two items in reverse byte order */
5074 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
5076 const unsigned char *p1, *p2, *p1_lim;
5080 p1_lim = (const unsigned char *)a->mv_data;
5081 p1 = (const unsigned char *)a->mv_data + a->mv_size;
5082 p2 = (const unsigned char *)b->mv_data + b->mv_size;
5084 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
5090 while (p1 > p1_lim) {
5091 diff = *--p1 - *--p2;
5095 return len_diff<0 ? -1 : len_diff;
5098 /** Search for key within a page, using binary search.
5099 * Returns the smallest entry larger or equal to the key.
5100 * If exactp is non-null, stores whether the found entry was an exact match
5101 * in *exactp (1 or 0).
5102 * Updates the cursor index with the index of the found entry.
5103 * If no entry larger or equal to the key is found, returns NULL.
5106 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
5108 unsigned int i = 0, nkeys;
5111 MDB_page *mp = mc->mc_pg[mc->mc_top];
5112 MDB_node *node = NULL;
5117 nkeys = NUMKEYS(mp);
5119 DPRINTF(("searching %u keys in %s %spage %"Z"u",
5120 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
5123 low = IS_LEAF(mp) ? 0 : 1;
5125 cmp = mc->mc_dbx->md_cmp;
5127 /* Branch pages have no data, so if using integer keys,
5128 * alignment is guaranteed. Use faster mdb_cmp_int.
5130 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
5131 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
5138 nodekey.mv_size = mc->mc_db->md_pad;
5139 node = NODEPTR(mp, 0); /* fake */
5140 while (low <= high) {
5141 i = (low + high) >> 1;
5142 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
5143 rc = cmp(key, &nodekey);
5144 DPRINTF(("found leaf index %u [%s], rc = %i",
5145 i, DKEY(&nodekey), rc));
5154 while (low <= high) {
5155 i = (low + high) >> 1;
5157 node = NODEPTR(mp, i);
5158 nodekey.mv_size = NODEKSZ(node);
5159 nodekey.mv_data = NODEKEY(node);
5161 rc = cmp(key, &nodekey);
5164 DPRINTF(("found leaf index %u [%s], rc = %i",
5165 i, DKEY(&nodekey), rc));
5167 DPRINTF(("found branch index %u [%s -> %"Z"u], rc = %i",
5168 i, DKEY(&nodekey), NODEPGNO(node), rc));
5179 if (rc > 0) { /* Found entry is less than the key. */
5180 i++; /* Skip to get the smallest entry larger than key. */
5182 node = NODEPTR(mp, i);
5185 *exactp = (rc == 0 && nkeys > 0);
5186 /* store the key index */
5187 mc->mc_ki[mc->mc_top] = i;
5189 /* There is no entry larger or equal to the key. */
5192 /* nodeptr is fake for LEAF2 */
5198 mdb_cursor_adjust(MDB_cursor *mc, func)
5202 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5203 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
5210 /** Pop a page off the top of the cursor's stack. */
5212 mdb_cursor_pop(MDB_cursor *mc)
5215 DPRINTF(("popping page %"Z"u off db %d cursor %p",
5216 mc->mc_pg[mc->mc_top]->mp_pgno, DDBI(mc), (void *) mc));
5224 /** Push a page onto the top of the cursor's stack. */
5226 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
5228 DPRINTF(("pushing page %"Z"u on db %d cursor %p", mp->mp_pgno,
5229 DDBI(mc), (void *) mc));
5231 if (mc->mc_snum >= CURSOR_STACK) {
5232 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5233 return MDB_CURSOR_FULL;
5236 mc->mc_top = mc->mc_snum++;
5237 mc->mc_pg[mc->mc_top] = mp;
5238 mc->mc_ki[mc->mc_top] = 0;
5243 /** Find the address of the page corresponding to a given page number.
5244 * @param[in] txn the transaction for this access.
5245 * @param[in] pgno the page number for the page to retrieve.
5246 * @param[out] ret address of a pointer where the page's address will be stored.
5247 * @param[out] lvl dirty_list inheritance level of found page. 1=current txn, 0=mapped page.
5248 * @return 0 on success, non-zero on failure.
5251 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret, int *lvl)
5253 MDB_env *env = txn->mt_env;
5257 if (! (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_WRITEMAP))) {
5261 MDB_ID2L dl = tx2->mt_u.dirty_list;
5263 /* Spilled pages were dirtied in this txn and flushed
5264 * because the dirty list got full. Bring this page
5265 * back in from the map (but don't unspill it here,
5266 * leave that unless page_touch happens again).
5268 if (tx2->mt_spill_pgs) {
5269 MDB_ID pn = pgno << 1;
5270 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
5271 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
5272 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
5277 unsigned x = mdb_mid2l_search(dl, pgno);
5278 if (x <= dl[0].mid && dl[x].mid == pgno) {
5284 } while ((tx2 = tx2->mt_parent) != NULL);
5287 if (pgno < txn->mt_next_pgno) {
5289 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
5291 DPRINTF(("page %"Z"u not found", pgno));
5292 txn->mt_flags |= MDB_TXN_ERROR;
5293 return MDB_PAGE_NOTFOUND;
5303 /** Finish #mdb_page_search() / #mdb_page_search_lowest().
5304 * The cursor is at the root page, set up the rest of it.
5307 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int flags)
5309 MDB_page *mp = mc->mc_pg[mc->mc_top];
5313 while (IS_BRANCH(mp)) {
5317 DPRINTF(("branch page %"Z"u has %u keys", mp->mp_pgno, NUMKEYS(mp)));
5318 mdb_cassert(mc, NUMKEYS(mp) > 1);
5319 DPRINTF(("found index 0 to page %"Z"u", NODEPGNO(NODEPTR(mp, 0))));
5321 if (flags & (MDB_PS_FIRST|MDB_PS_LAST)) {
5323 if (flags & MDB_PS_LAST)
5324 i = NUMKEYS(mp) - 1;
5327 node = mdb_node_search(mc, key, &exact);
5329 i = NUMKEYS(mp) - 1;
5331 i = mc->mc_ki[mc->mc_top];
5333 mdb_cassert(mc, i > 0);
5337 DPRINTF(("following index %u for key [%s]", i, DKEY(key)));
5340 mdb_cassert(mc, i < NUMKEYS(mp));
5341 node = NODEPTR(mp, i);
5343 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
5346 mc->mc_ki[mc->mc_top] = i;
5347 if ((rc = mdb_cursor_push(mc, mp)))
5350 if (flags & MDB_PS_MODIFY) {
5351 if ((rc = mdb_page_touch(mc)) != 0)
5353 mp = mc->mc_pg[mc->mc_top];
5358 DPRINTF(("internal error, index points to a %02X page!?",
5360 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5361 return MDB_CORRUPTED;
5364 DPRINTF(("found leaf page %"Z"u for key [%s]", mp->mp_pgno,
5365 key ? DKEY(key) : "null"));
5366 mc->mc_flags |= C_INITIALIZED;
5367 mc->mc_flags &= ~C_EOF;
5372 /** Search for the lowest key under the current branch page.
5373 * This just bypasses a NUMKEYS check in the current page
5374 * before calling mdb_page_search_root(), because the callers
5375 * are all in situations where the current page is known to
5379 mdb_page_search_lowest(MDB_cursor *mc)
5381 MDB_page *mp = mc->mc_pg[mc->mc_top];
5382 MDB_node *node = NODEPTR(mp, 0);
5385 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
5388 mc->mc_ki[mc->mc_top] = 0;
5389 if ((rc = mdb_cursor_push(mc, mp)))
5391 return mdb_page_search_root(mc, NULL, MDB_PS_FIRST);
5394 /** Search for the page a given key should be in.
5395 * Push it and its parent pages on the cursor stack.
5396 * @param[in,out] mc the cursor for this operation.
5397 * @param[in] key the key to search for, or NULL for first/last page.
5398 * @param[in] flags If MDB_PS_MODIFY is set, visited pages in the DB
5399 * are touched (updated with new page numbers).
5400 * If MDB_PS_FIRST or MDB_PS_LAST is set, find first or last leaf.
5401 * This is used by #mdb_cursor_first() and #mdb_cursor_last().
5402 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
5403 * @return 0 on success, non-zero on failure.
5406 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
5411 /* Make sure the txn is still viable, then find the root from
5412 * the txn's db table and set it as the root of the cursor's stack.
5414 if (mc->mc_txn->mt_flags & MDB_TXN_BLOCKED) {
5415 DPUTS("transaction may not be used now");
5418 /* Make sure we're using an up-to-date root */
5419 if (*mc->mc_dbflag & DB_STALE) {
5421 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
5423 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
5424 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, 0);
5431 MDB_node *leaf = mdb_node_search(&mc2,
5432 &mc->mc_dbx->md_name, &exact);
5434 return MDB_NOTFOUND;
5435 if ((leaf->mn_flags & (F_DUPDATA|F_SUBDATA)) != F_SUBDATA)
5436 return MDB_INCOMPATIBLE; /* not a named DB */
5437 rc = mdb_node_read(mc->mc_txn, leaf, &data);
5440 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
5442 /* The txn may not know this DBI, or another process may
5443 * have dropped and recreated the DB with other flags.
5445 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
5446 return MDB_INCOMPATIBLE;
5447 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
5449 *mc->mc_dbflag &= ~DB_STALE;
5451 root = mc->mc_db->md_root;
5453 if (root == P_INVALID) { /* Tree is empty. */
5454 DPUTS("tree is empty");
5455 return MDB_NOTFOUND;
5459 mdb_cassert(mc, root > 1);
5460 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
5461 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0], NULL)) != 0)
5467 DPRINTF(("db %d root page %"Z"u has flags 0x%X",
5468 DDBI(mc), root, mc->mc_pg[0]->mp_flags));
5470 if (flags & MDB_PS_MODIFY) {
5471 if ((rc = mdb_page_touch(mc)))
5475 if (flags & MDB_PS_ROOTONLY)
5478 return mdb_page_search_root(mc, key, flags);
5482 mdb_ovpage_free(MDB_cursor *mc, MDB_page *mp)
5484 MDB_txn *txn = mc->mc_txn;
5485 pgno_t pg = mp->mp_pgno;
5486 unsigned x = 0, ovpages = mp->mp_pages;
5487 MDB_env *env = txn->mt_env;
5488 MDB_IDL sl = txn->mt_spill_pgs;
5489 MDB_ID pn = pg << 1;
5492 DPRINTF(("free ov page %"Z"u (%d)", pg, ovpages));
5493 /* If the page is dirty or on the spill list we just acquired it,
5494 * so we should give it back to our current free list, if any.
5495 * Otherwise put it onto the list of pages we freed in this txn.
5497 * Won't create me_pghead: me_pglast must be inited along with it.
5498 * Unsupported in nested txns: They would need to hide the page
5499 * range in ancestor txns' dirty and spilled lists.
5501 if (env->me_pghead &&
5503 ((mp->mp_flags & P_DIRTY) ||
5504 (sl && (x = mdb_midl_search(sl, pn)) <= sl[0] && sl[x] == pn)))
5508 MDB_ID2 *dl, ix, iy;
5509 rc = mdb_midl_need(&env->me_pghead, ovpages);
5512 if (!(mp->mp_flags & P_DIRTY)) {
5513 /* This page is no longer spilled */
5520 /* Remove from dirty list */
5521 dl = txn->mt_u.dirty_list;
5523 for (ix = dl[x]; ix.mptr != mp; ix = iy) {
5529 mdb_cassert(mc, x > 1);
5531 dl[j] = ix; /* Unsorted. OK when MDB_TXN_ERROR. */
5532 txn->mt_flags |= MDB_TXN_ERROR;
5533 return MDB_CORRUPTED;
5536 if (!(env->me_flags & MDB_WRITEMAP))
5537 mdb_dpage_free(env, mp);
5539 /* Insert in me_pghead */
5540 mop = env->me_pghead;
5541 j = mop[0] + ovpages;
5542 for (i = mop[0]; i && mop[i] < pg; i--)
5548 rc = mdb_midl_append_range(&txn->mt_free_pgs, pg, ovpages);
5552 mc->mc_db->md_overflow_pages -= ovpages;
5556 /** Return the data associated with a given node.
5557 * @param[in] txn The transaction for this operation.
5558 * @param[in] leaf The node being read.
5559 * @param[out] data Updated to point to the node's data.
5560 * @return 0 on success, non-zero on failure.
5563 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
5565 MDB_page *omp; /* overflow page */
5569 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5570 data->mv_size = NODEDSZ(leaf);
5571 data->mv_data = NODEDATA(leaf);
5575 /* Read overflow data.
5577 data->mv_size = NODEDSZ(leaf);
5578 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
5579 if ((rc = mdb_page_get(txn, pgno, &omp, NULL)) != 0) {
5580 DPRINTF(("read overflow page %"Z"u failed", pgno));
5583 data->mv_data = METADATA(omp);
5589 mdb_get(MDB_txn *txn, MDB_dbi dbi,
5590 MDB_val *key, MDB_val *data)
5597 DPRINTF(("===> get db %u key [%s]", dbi, DKEY(key)));
5599 if (!key || !data || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
5602 if (txn->mt_flags & MDB_TXN_BLOCKED)
5605 mdb_cursor_init(&mc, txn, dbi, &mx);
5606 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
5609 /** Find a sibling for a page.
5610 * Replaces the page at the top of the cursor's stack with the
5611 * specified sibling, if one exists.
5612 * @param[in] mc The cursor for this operation.
5613 * @param[in] move_right Non-zero if the right sibling is requested,
5614 * otherwise the left sibling.
5615 * @return 0 on success, non-zero on failure.
5618 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
5624 if (mc->mc_snum < 2) {
5625 return MDB_NOTFOUND; /* root has no siblings */
5629 DPRINTF(("parent page is page %"Z"u, index %u",
5630 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]));
5632 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
5633 : (mc->mc_ki[mc->mc_top] == 0)) {
5634 DPRINTF(("no more keys left, moving to %s sibling",
5635 move_right ? "right" : "left"));
5636 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
5637 /* undo cursor_pop before returning */
5644 mc->mc_ki[mc->mc_top]++;
5646 mc->mc_ki[mc->mc_top]--;
5647 DPRINTF(("just moving to %s index key %u",
5648 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]));
5650 mdb_cassert(mc, IS_BRANCH(mc->mc_pg[mc->mc_top]));
5652 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5653 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp, NULL)) != 0) {
5654 /* mc will be inconsistent if caller does mc_snum++ as above */
5655 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
5659 mdb_cursor_push(mc, mp);
5661 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
5666 /** Move the cursor to the next data item. */
5668 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5674 if (mc->mc_flags & C_EOF) {
5675 return MDB_NOTFOUND;
5678 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5680 mp = mc->mc_pg[mc->mc_top];
5682 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5683 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5684 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5685 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
5686 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
5687 if (op != MDB_NEXT || rc != MDB_NOTFOUND) {
5688 if (rc == MDB_SUCCESS)
5689 MDB_GET_KEY(leaf, key);
5694 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5695 if (op == MDB_NEXT_DUP)
5696 return MDB_NOTFOUND;
5700 DPRINTF(("cursor_next: top page is %"Z"u in cursor %p",
5701 mdb_dbg_pgno(mp), (void *) mc));
5702 if (mc->mc_flags & C_DEL)
5705 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
5706 DPUTS("=====> move to next sibling page");
5707 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
5708 mc->mc_flags |= C_EOF;
5711 mp = mc->mc_pg[mc->mc_top];
5712 DPRINTF(("next page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5714 mc->mc_ki[mc->mc_top]++;
5717 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5718 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5721 key->mv_size = mc->mc_db->md_pad;
5722 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5726 mdb_cassert(mc, IS_LEAF(mp));
5727 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5729 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5730 mdb_xcursor_init1(mc, leaf);
5733 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5736 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5737 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5738 if (rc != MDB_SUCCESS)
5743 MDB_GET_KEY(leaf, key);
5747 /** Move the cursor to the previous data item. */
5749 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5755 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5757 mp = mc->mc_pg[mc->mc_top];
5759 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5760 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5761 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5762 if (op == MDB_PREV || op == MDB_PREV_DUP) {
5763 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
5764 if (op != MDB_PREV || rc != MDB_NOTFOUND) {
5765 if (rc == MDB_SUCCESS) {
5766 MDB_GET_KEY(leaf, key);
5767 mc->mc_flags &= ~C_EOF;
5773 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5774 if (op == MDB_PREV_DUP)
5775 return MDB_NOTFOUND;
5779 DPRINTF(("cursor_prev: top page is %"Z"u in cursor %p",
5780 mdb_dbg_pgno(mp), (void *) mc));
5782 if (mc->mc_ki[mc->mc_top] == 0) {
5783 DPUTS("=====> move to prev sibling page");
5784 if ((rc = mdb_cursor_sibling(mc, 0)) != MDB_SUCCESS) {
5787 mp = mc->mc_pg[mc->mc_top];
5788 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
5789 DPRINTF(("prev page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5791 mc->mc_ki[mc->mc_top]--;
5793 mc->mc_flags &= ~C_EOF;
5795 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5796 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5799 key->mv_size = mc->mc_db->md_pad;
5800 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5804 mdb_cassert(mc, IS_LEAF(mp));
5805 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5807 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5808 mdb_xcursor_init1(mc, leaf);
5811 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5814 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5815 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5816 if (rc != MDB_SUCCESS)
5821 MDB_GET_KEY(leaf, key);
5825 /** Set the cursor on a specific data item. */
5827 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5828 MDB_cursor_op op, int *exactp)
5832 MDB_node *leaf = NULL;
5835 if (key->mv_size == 0)
5836 return MDB_BAD_VALSIZE;
5839 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5841 /* See if we're already on the right page */
5842 if (mc->mc_flags & C_INITIALIZED) {
5845 mp = mc->mc_pg[mc->mc_top];
5847 mc->mc_ki[mc->mc_top] = 0;
5848 return MDB_NOTFOUND;
5850 if (mp->mp_flags & P_LEAF2) {
5851 nodekey.mv_size = mc->mc_db->md_pad;
5852 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
5854 leaf = NODEPTR(mp, 0);
5855 MDB_GET_KEY2(leaf, nodekey);
5857 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5859 /* Probably happens rarely, but first node on the page
5860 * was the one we wanted.
5862 mc->mc_ki[mc->mc_top] = 0;
5869 unsigned int nkeys = NUMKEYS(mp);
5871 if (mp->mp_flags & P_LEAF2) {
5872 nodekey.mv_data = LEAF2KEY(mp,
5873 nkeys-1, nodekey.mv_size);
5875 leaf = NODEPTR(mp, nkeys-1);
5876 MDB_GET_KEY2(leaf, nodekey);
5878 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5880 /* last node was the one we wanted */
5881 mc->mc_ki[mc->mc_top] = nkeys-1;
5887 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
5888 /* This is definitely the right page, skip search_page */
5889 if (mp->mp_flags & P_LEAF2) {
5890 nodekey.mv_data = LEAF2KEY(mp,
5891 mc->mc_ki[mc->mc_top], nodekey.mv_size);
5893 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5894 MDB_GET_KEY2(leaf, nodekey);
5896 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5898 /* current node was the one we wanted */
5908 /* If any parents have right-sibs, search.
5909 * Otherwise, there's nothing further.
5911 for (i=0; i<mc->mc_top; i++)
5913 NUMKEYS(mc->mc_pg[i])-1)
5915 if (i == mc->mc_top) {
5916 /* There are no other pages */
5917 mc->mc_ki[mc->mc_top] = nkeys;
5918 return MDB_NOTFOUND;
5922 /* There are no other pages */
5923 mc->mc_ki[mc->mc_top] = 0;
5924 if (op == MDB_SET_RANGE && !exactp) {
5928 return MDB_NOTFOUND;
5932 rc = mdb_page_search(mc, key, 0);
5933 if (rc != MDB_SUCCESS)
5936 mp = mc->mc_pg[mc->mc_top];
5937 mdb_cassert(mc, IS_LEAF(mp));
5940 leaf = mdb_node_search(mc, key, exactp);
5941 if (exactp != NULL && !*exactp) {
5942 /* MDB_SET specified and not an exact match. */
5943 return MDB_NOTFOUND;
5947 DPUTS("===> inexact leaf not found, goto sibling");
5948 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
5949 mc->mc_flags |= C_EOF;
5950 return rc; /* no entries matched */
5952 mp = mc->mc_pg[mc->mc_top];
5953 mdb_cassert(mc, IS_LEAF(mp));
5954 leaf = NODEPTR(mp, 0);
5958 mc->mc_flags |= C_INITIALIZED;
5959 mc->mc_flags &= ~C_EOF;
5962 if (op == MDB_SET_RANGE || op == MDB_SET_KEY) {
5963 key->mv_size = mc->mc_db->md_pad;
5964 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5969 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5970 mdb_xcursor_init1(mc, leaf);
5973 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5974 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
5975 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5978 if (op == MDB_GET_BOTH) {
5984 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
5985 if (rc != MDB_SUCCESS)
5988 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
5991 if ((rc = mdb_node_read(mc->mc_txn, leaf, &olddata)) != MDB_SUCCESS)
5993 dcmp = mc->mc_dbx->md_dcmp;
5994 #if UINT_MAX < SIZE_MAX
5995 if (dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
5996 dcmp = mdb_cmp_clong;
5998 rc = dcmp(data, &olddata);
6000 if (op == MDB_GET_BOTH || rc > 0)
6001 return MDB_NOTFOUND;
6008 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
6009 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
6014 /* The key already matches in all other cases */
6015 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
6016 MDB_GET_KEY(leaf, key);
6017 DPRINTF(("==> cursor placed on key [%s]", DKEY(key)));
6022 /** Move the cursor to the first item in the database. */
6024 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
6030 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
6032 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
6033 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
6034 if (rc != MDB_SUCCESS)
6037 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
6039 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
6040 mc->mc_flags |= C_INITIALIZED;
6041 mc->mc_flags &= ~C_EOF;
6043 mc->mc_ki[mc->mc_top] = 0;
6045 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6046 key->mv_size = mc->mc_db->md_pad;
6047 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
6052 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6053 mdb_xcursor_init1(mc, leaf);
6054 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
6058 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
6062 MDB_GET_KEY(leaf, key);
6066 /** Move the cursor to the last item in the database. */
6068 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
6074 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
6076 if (!(mc->mc_flags & C_EOF)) {
6078 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
6079 rc = mdb_page_search(mc, NULL, MDB_PS_LAST);
6080 if (rc != MDB_SUCCESS)
6083 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
6086 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
6087 mc->mc_flags |= C_INITIALIZED|C_EOF;
6088 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6090 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6091 key->mv_size = mc->mc_db->md_pad;
6092 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
6097 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6098 mdb_xcursor_init1(mc, leaf);
6099 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
6103 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
6108 MDB_GET_KEY(leaf, key);
6113 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
6118 int (*mfunc)(MDB_cursor *mc, MDB_val *key, MDB_val *data);
6123 if (mc->mc_txn->mt_flags & MDB_TXN_BLOCKED)
6127 case MDB_GET_CURRENT:
6128 if (!(mc->mc_flags & C_INITIALIZED)) {
6131 MDB_page *mp = mc->mc_pg[mc->mc_top];
6132 int nkeys = NUMKEYS(mp);
6133 if (!nkeys || mc->mc_ki[mc->mc_top] >= nkeys) {
6134 mc->mc_ki[mc->mc_top] = nkeys;
6140 key->mv_size = mc->mc_db->md_pad;
6141 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
6143 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6144 MDB_GET_KEY(leaf, key);
6146 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6147 if (mc->mc_flags & C_DEL)
6148 mdb_xcursor_init1(mc, leaf);
6149 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
6151 rc = mdb_node_read(mc->mc_txn, leaf, data);
6158 case MDB_GET_BOTH_RANGE:
6163 if (mc->mc_xcursor == NULL) {
6164 rc = MDB_INCOMPATIBLE;
6174 rc = mdb_cursor_set(mc, key, data, op,
6175 op == MDB_SET_RANGE ? NULL : &exact);
6178 case MDB_GET_MULTIPLE:
6179 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
6183 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6184 rc = MDB_INCOMPATIBLE;
6188 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
6189 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
6192 case MDB_NEXT_MULTIPLE:
6197 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6198 rc = MDB_INCOMPATIBLE;
6201 if (!(mc->mc_flags & C_INITIALIZED))
6202 rc = mdb_cursor_first(mc, key, data);
6204 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
6205 if (rc == MDB_SUCCESS) {
6206 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
6209 mx = &mc->mc_xcursor->mx_cursor;
6210 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
6212 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
6213 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
6221 case MDB_NEXT_NODUP:
6222 if (!(mc->mc_flags & C_INITIALIZED))
6223 rc = mdb_cursor_first(mc, key, data);
6225 rc = mdb_cursor_next(mc, key, data, op);
6229 case MDB_PREV_NODUP:
6230 if (!(mc->mc_flags & C_INITIALIZED)) {
6231 rc = mdb_cursor_last(mc, key, data);
6234 mc->mc_flags |= C_INITIALIZED;
6235 mc->mc_ki[mc->mc_top]++;
6237 rc = mdb_cursor_prev(mc, key, data, op);
6240 rc = mdb_cursor_first(mc, key, data);
6243 mfunc = mdb_cursor_first;
6245 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
6249 if (mc->mc_xcursor == NULL) {
6250 rc = MDB_INCOMPATIBLE;
6254 MDB_node *leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6255 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6256 MDB_GET_KEY(leaf, key);
6257 rc = mdb_node_read(mc->mc_txn, leaf, data);
6261 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
6265 rc = mfunc(&mc->mc_xcursor->mx_cursor, data, NULL);
6268 rc = mdb_cursor_last(mc, key, data);
6271 mfunc = mdb_cursor_last;
6274 DPRINTF(("unhandled/unimplemented cursor operation %u", op));
6279 if (mc->mc_flags & C_DEL)
6280 mc->mc_flags ^= C_DEL;
6285 /** Touch all the pages in the cursor stack. Set mc_top.
6286 * Makes sure all the pages are writable, before attempting a write operation.
6287 * @param[in] mc The cursor to operate on.
6290 mdb_cursor_touch(MDB_cursor *mc)
6292 int rc = MDB_SUCCESS;
6294 if (mc->mc_dbi >= CORE_DBS && !(*mc->mc_dbflag & DB_DIRTY)) {
6297 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
6299 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, &mcx);
6300 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
6303 *mc->mc_dbflag |= DB_DIRTY;
6308 rc = mdb_page_touch(mc);
6309 } while (!rc && ++(mc->mc_top) < mc->mc_snum);
6310 mc->mc_top = mc->mc_snum-1;
6315 /** Do not spill pages to disk if txn is getting full, may fail instead */
6316 #define MDB_NOSPILL 0x8000
6319 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
6323 MDB_node *leaf = NULL;
6326 MDB_val xdata, *rdata, dkey, olddata;
6328 int do_sub = 0, insert_key, insert_data;
6329 unsigned int mcount = 0, dcount = 0, nospill;
6332 unsigned int nflags;
6335 if (mc == NULL || key == NULL)
6338 env = mc->mc_txn->mt_env;
6340 /* Check this first so counter will always be zero on any
6343 if (flags & MDB_MULTIPLE) {
6344 dcount = data[1].mv_size;
6345 data[1].mv_size = 0;
6346 if (!F_ISSET(mc->mc_db->md_flags, MDB_DUPFIXED))
6347 return MDB_INCOMPATIBLE;
6350 nospill = flags & MDB_NOSPILL;
6351 flags &= ~MDB_NOSPILL;
6353 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_BLOCKED))
6354 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6356 if (key->mv_size-1 >= ENV_MAXKEY(env))
6357 return MDB_BAD_VALSIZE;
6359 #if SIZE_MAX > MAXDATASIZE
6360 if (data->mv_size > ((mc->mc_db->md_flags & MDB_DUPSORT) ? ENV_MAXKEY(env) : MAXDATASIZE))
6361 return MDB_BAD_VALSIZE;
6363 if ((mc->mc_db->md_flags & MDB_DUPSORT) && data->mv_size > ENV_MAXKEY(env))
6364 return MDB_BAD_VALSIZE;
6367 DPRINTF(("==> put db %d key [%s], size %"Z"u, data size %"Z"u",
6368 DDBI(mc), DKEY(key), key ? key->mv_size : 0, data->mv_size));
6372 if (flags == MDB_CURRENT) {
6373 if (!(mc->mc_flags & C_INITIALIZED))
6376 } else if (mc->mc_db->md_root == P_INVALID) {
6377 /* new database, cursor has nothing to point to */
6380 mc->mc_flags &= ~C_INITIALIZED;
6385 if (flags & MDB_APPEND) {
6387 rc = mdb_cursor_last(mc, &k2, &d2);
6389 rc = mc->mc_dbx->md_cmp(key, &k2);
6392 mc->mc_ki[mc->mc_top]++;
6394 /* new key is <= last key */
6399 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
6401 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
6402 DPRINTF(("duplicate key [%s]", DKEY(key)));
6404 return MDB_KEYEXIST;
6406 if (rc && rc != MDB_NOTFOUND)
6410 if (mc->mc_flags & C_DEL)
6411 mc->mc_flags ^= C_DEL;
6413 /* Cursor is positioned, check for room in the dirty list */
6415 if (flags & MDB_MULTIPLE) {
6417 xdata.mv_size = data->mv_size * dcount;
6421 if ((rc2 = mdb_page_spill(mc, key, rdata)))
6425 if (rc == MDB_NO_ROOT) {
6427 /* new database, write a root leaf page */
6428 DPUTS("allocating new root leaf page");
6429 if ((rc2 = mdb_page_new(mc, P_LEAF, 1, &np))) {
6432 mdb_cursor_push(mc, np);
6433 mc->mc_db->md_root = np->mp_pgno;
6434 mc->mc_db->md_depth++;
6435 *mc->mc_dbflag |= DB_DIRTY;
6436 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
6438 np->mp_flags |= P_LEAF2;
6439 mc->mc_flags |= C_INITIALIZED;
6441 /* make sure all cursor pages are writable */
6442 rc2 = mdb_cursor_touch(mc);
6447 insert_key = insert_data = rc;
6449 /* The key does not exist */
6450 DPRINTF(("inserting key at index %i", mc->mc_ki[mc->mc_top]));
6451 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
6452 LEAFSIZE(key, data) > env->me_nodemax)
6454 /* Too big for a node, insert in sub-DB. Set up an empty
6455 * "old sub-page" for prep_subDB to expand to a full page.
6457 fp_flags = P_LEAF|P_DIRTY;
6459 fp->mp_pad = data->mv_size; /* used if MDB_DUPFIXED */
6460 fp->mp_lower = fp->mp_upper = (PAGEHDRSZ-PAGEBASE);
6461 olddata.mv_size = PAGEHDRSZ;
6465 /* there's only a key anyway, so this is a no-op */
6466 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6468 unsigned int ksize = mc->mc_db->md_pad;
6469 if (key->mv_size != ksize)
6470 return MDB_BAD_VALSIZE;
6471 ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
6472 memcpy(ptr, key->mv_data, ksize);
6474 /* if overwriting slot 0 of leaf, need to
6475 * update branch key if there is a parent page
6477 if (mc->mc_top && !mc->mc_ki[mc->mc_top]) {
6478 unsigned short top = mc->mc_top;
6480 /* slot 0 is always an empty key, find real slot */
6481 while (mc->mc_top && !mc->mc_ki[mc->mc_top])
6483 if (mc->mc_ki[mc->mc_top])
6484 rc2 = mdb_update_key(mc, key);
6495 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6496 olddata.mv_size = NODEDSZ(leaf);
6497 olddata.mv_data = NODEDATA(leaf);
6500 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
6501 /* Prepare (sub-)page/sub-DB to accept the new item,
6502 * if needed. fp: old sub-page or a header faking
6503 * it. mp: new (sub-)page. offset: growth in page
6504 * size. xdata: node data with new page or DB.
6506 unsigned i, offset = 0;
6507 mp = fp = xdata.mv_data = env->me_pbuf;
6508 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
6510 /* Was a single item before, must convert now */
6511 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6513 /* Just overwrite the current item */
6514 if (flags == MDB_CURRENT)
6516 dcmp = mc->mc_dbx->md_dcmp;
6517 #if UINT_MAX < SIZE_MAX
6518 if (dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
6519 dcmp = mdb_cmp_clong;
6521 /* does data match? */
6522 if (!dcmp(data, &olddata)) {
6523 if (flags & MDB_NODUPDATA)
6524 return MDB_KEYEXIST;
6529 /* Back up original data item */
6530 dkey.mv_size = olddata.mv_size;
6531 dkey.mv_data = memcpy(fp+1, olddata.mv_data, olddata.mv_size);
6533 /* Make sub-page header for the dup items, with dummy body */
6534 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
6535 fp->mp_lower = (PAGEHDRSZ-PAGEBASE);
6536 xdata.mv_size = PAGEHDRSZ + dkey.mv_size + data->mv_size;
6537 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6538 fp->mp_flags |= P_LEAF2;
6539 fp->mp_pad = data->mv_size;
6540 xdata.mv_size += 2 * data->mv_size; /* leave space for 2 more */
6542 xdata.mv_size += 2 * (sizeof(indx_t) + NODESIZE) +
6543 (dkey.mv_size & 1) + (data->mv_size & 1);
6545 fp->mp_upper = xdata.mv_size - PAGEBASE;
6546 olddata.mv_size = xdata.mv_size; /* pretend olddata is fp */
6547 } else if (leaf->mn_flags & F_SUBDATA) {
6548 /* Data is on sub-DB, just store it */
6549 flags |= F_DUPDATA|F_SUBDATA;
6552 /* Data is on sub-page */
6553 fp = olddata.mv_data;
6556 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6557 offset = EVEN(NODESIZE + sizeof(indx_t) +
6561 offset = fp->mp_pad;
6562 if (SIZELEFT(fp) < offset) {
6563 offset *= 4; /* space for 4 more */
6566 /* FALLTHRU: Big enough MDB_DUPFIXED sub-page */
6568 fp->mp_flags |= P_DIRTY;
6569 COPY_PGNO(fp->mp_pgno, mp->mp_pgno);
6570 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
6574 xdata.mv_size = olddata.mv_size + offset;
6577 fp_flags = fp->mp_flags;
6578 if (NODESIZE + NODEKSZ(leaf) + xdata.mv_size > env->me_nodemax) {
6579 /* Too big for a sub-page, convert to sub-DB */
6580 fp_flags &= ~P_SUBP;
6582 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6583 fp_flags |= P_LEAF2;
6584 dummy.md_pad = fp->mp_pad;
6585 dummy.md_flags = MDB_DUPFIXED;
6586 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
6587 dummy.md_flags |= MDB_INTEGERKEY;
6593 dummy.md_branch_pages = 0;
6594 dummy.md_leaf_pages = 1;
6595 dummy.md_overflow_pages = 0;
6596 dummy.md_entries = NUMKEYS(fp);
6597 xdata.mv_size = sizeof(MDB_db);
6598 xdata.mv_data = &dummy;
6599 if ((rc = mdb_page_alloc(mc, 1, &mp)))
6601 offset = env->me_psize - olddata.mv_size;
6602 flags |= F_DUPDATA|F_SUBDATA;
6603 dummy.md_root = mp->mp_pgno;
6606 mp->mp_flags = fp_flags | P_DIRTY;
6607 mp->mp_pad = fp->mp_pad;
6608 mp->mp_lower = fp->mp_lower;
6609 mp->mp_upper = fp->mp_upper + offset;
6610 if (fp_flags & P_LEAF2) {
6611 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
6613 memcpy((char *)mp + mp->mp_upper + PAGEBASE, (char *)fp + fp->mp_upper + PAGEBASE,
6614 olddata.mv_size - fp->mp_upper - PAGEBASE);
6615 for (i=0; i<NUMKEYS(fp); i++)
6616 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
6624 mdb_node_del(mc, 0);
6628 /* LMDB passes F_SUBDATA in 'flags' to write a DB record */
6629 if ((leaf->mn_flags ^ flags) & F_SUBDATA)
6630 return MDB_INCOMPATIBLE;
6631 /* overflow page overwrites need special handling */
6632 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6635 int level, ovpages, dpages = OVPAGES(data->mv_size, env->me_psize);
6637 memcpy(&pg, olddata.mv_data, sizeof(pg));
6638 if ((rc2 = mdb_page_get(mc->mc_txn, pg, &omp, &level)) != 0)
6640 ovpages = omp->mp_pages;
6642 /* Is the ov page large enough? */
6643 if (ovpages >= dpages) {
6644 if (!(omp->mp_flags & P_DIRTY) &&
6645 (level || (env->me_flags & MDB_WRITEMAP)))
6647 rc = mdb_page_unspill(mc->mc_txn, omp, &omp);
6650 level = 0; /* dirty in this txn or clean */
6653 if (omp->mp_flags & P_DIRTY) {
6654 /* yes, overwrite it. Note in this case we don't
6655 * bother to try shrinking the page if the new data
6656 * is smaller than the overflow threshold.
6659 /* It is writable only in a parent txn */
6660 size_t sz = (size_t) env->me_psize * ovpages, off;
6661 MDB_page *np = mdb_page_malloc(mc->mc_txn, ovpages);
6667 rc2 = mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &id2);
6668 mdb_cassert(mc, rc2 == 0);
6669 if (!(flags & MDB_RESERVE)) {
6670 /* Copy end of page, adjusting alignment so
6671 * compiler may copy words instead of bytes.
6673 off = (PAGEHDRSZ + data->mv_size) & -sizeof(size_t);
6674 memcpy((size_t *)((char *)np + off),
6675 (size_t *)((char *)omp + off), sz - off);
6678 memcpy(np, omp, sz); /* Copy beginning of page */
6681 SETDSZ(leaf, data->mv_size);
6682 if (F_ISSET(flags, MDB_RESERVE))
6683 data->mv_data = METADATA(omp);
6685 memcpy(METADATA(omp), data->mv_data, data->mv_size);
6689 if ((rc2 = mdb_ovpage_free(mc, omp)) != MDB_SUCCESS)
6691 } else if (data->mv_size == olddata.mv_size) {
6692 /* same size, just replace it. Note that we could
6693 * also reuse this node if the new data is smaller,
6694 * but instead we opt to shrink the node in that case.
6696 if (F_ISSET(flags, MDB_RESERVE))
6697 data->mv_data = olddata.mv_data;
6698 else if (!(mc->mc_flags & C_SUB))
6699 memcpy(olddata.mv_data, data->mv_data, data->mv_size);
6701 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
6706 mdb_node_del(mc, 0);
6712 nflags = flags & NODE_ADD_FLAGS;
6713 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(env, key, rdata);
6714 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
6715 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
6716 nflags &= ~MDB_APPEND; /* sub-page may need room to grow */
6718 nflags |= MDB_SPLIT_REPLACE;
6719 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
6721 /* There is room already in this leaf page. */
6722 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
6723 if (rc == 0 && insert_key) {
6724 /* Adjust other cursors pointing to mp */
6725 MDB_cursor *m2, *m3;
6726 MDB_dbi dbi = mc->mc_dbi;
6727 unsigned i = mc->mc_top;
6728 MDB_page *mp = mc->mc_pg[i];
6730 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6731 if (mc->mc_flags & C_SUB)
6732 m3 = &m2->mc_xcursor->mx_cursor;
6735 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
6736 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
6743 if (rc == MDB_SUCCESS) {
6744 /* Now store the actual data in the child DB. Note that we're
6745 * storing the user data in the keys field, so there are strict
6746 * size limits on dupdata. The actual data fields of the child
6747 * DB are all zero size.
6755 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6756 if (flags & MDB_CURRENT) {
6757 xflags = MDB_CURRENT|MDB_NOSPILL;
6759 mdb_xcursor_init1(mc, leaf);
6760 xflags = (flags & MDB_NODUPDATA) ?
6761 MDB_NOOVERWRITE|MDB_NOSPILL : MDB_NOSPILL;
6763 /* converted, write the original data first */
6765 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
6769 /* Adjust other cursors pointing to mp */
6771 unsigned i = mc->mc_top;
6772 MDB_page *mp = mc->mc_pg[i];
6774 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6775 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6776 if (!(m2->mc_flags & C_INITIALIZED)) continue;
6777 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
6778 mdb_xcursor_init1(m2, leaf);
6782 /* we've done our job */
6785 ecount = mc->mc_xcursor->mx_db.md_entries;
6786 if (flags & MDB_APPENDDUP)
6787 xflags |= MDB_APPEND;
6788 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
6789 if (flags & F_SUBDATA) {
6790 void *db = NODEDATA(leaf);
6791 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6793 insert_data = mc->mc_xcursor->mx_db.md_entries - ecount;
6795 /* Increment count unless we just replaced an existing item. */
6797 mc->mc_db->md_entries++;
6799 /* Invalidate txn if we created an empty sub-DB */
6802 /* If we succeeded and the key didn't exist before,
6803 * make sure the cursor is marked valid.
6805 mc->mc_flags |= C_INITIALIZED;
6807 if (flags & MDB_MULTIPLE) {
6810 /* let caller know how many succeeded, if any */
6811 data[1].mv_size = mcount;
6812 if (mcount < dcount) {
6813 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
6814 insert_key = insert_data = 0;
6821 if (rc == MDB_KEYEXIST) /* should not happen, we deleted that item */
6824 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6829 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
6835 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_BLOCKED))
6836 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6838 if (!(mc->mc_flags & C_INITIALIZED))
6841 if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6842 return MDB_NOTFOUND;
6844 if (!(flags & MDB_NOSPILL) && (rc = mdb_page_spill(mc, NULL, NULL)))
6847 rc = mdb_cursor_touch(mc);
6851 mp = mc->mc_pg[mc->mc_top];
6854 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6856 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6857 if (flags & MDB_NODUPDATA) {
6858 /* mdb_cursor_del0() will subtract the final entry */
6859 mc->mc_db->md_entries -= mc->mc_xcursor->mx_db.md_entries - 1;
6861 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
6862 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6864 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, MDB_NOSPILL);
6867 /* If sub-DB still has entries, we're done */
6868 if (mc->mc_xcursor->mx_db.md_entries) {
6869 if (leaf->mn_flags & F_SUBDATA) {
6870 /* update subDB info */
6871 void *db = NODEDATA(leaf);
6872 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6875 /* shrink fake page */
6876 mdb_node_shrink(mp, mc->mc_ki[mc->mc_top]);
6877 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6878 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6879 /* fix other sub-DB cursors pointed at this fake page */
6880 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6881 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6882 if (m2->mc_pg[mc->mc_top] == mp &&
6883 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
6884 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6887 mc->mc_db->md_entries--;
6888 mc->mc_flags |= C_DEL;
6891 /* otherwise fall thru and delete the sub-DB */
6894 if (leaf->mn_flags & F_SUBDATA) {
6895 /* add all the child DB's pages to the free list */
6896 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
6901 /* LMDB passes F_SUBDATA in 'flags' to delete a DB record */
6902 else if ((leaf->mn_flags ^ flags) & F_SUBDATA) {
6903 rc = MDB_INCOMPATIBLE;
6907 /* add overflow pages to free list */
6908 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6912 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6913 if ((rc = mdb_page_get(mc->mc_txn, pg, &omp, NULL)) ||
6914 (rc = mdb_ovpage_free(mc, omp)))
6919 return mdb_cursor_del0(mc);
6922 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6926 /** Allocate and initialize new pages for a database.
6927 * @param[in] mc a cursor on the database being added to.
6928 * @param[in] flags flags defining what type of page is being allocated.
6929 * @param[in] num the number of pages to allocate. This is usually 1,
6930 * unless allocating overflow pages for a large record.
6931 * @param[out] mp Address of a page, or NULL on failure.
6932 * @return 0 on success, non-zero on failure.
6935 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
6940 if ((rc = mdb_page_alloc(mc, num, &np)))
6942 DPRINTF(("allocated new mpage %"Z"u, page size %u",
6943 np->mp_pgno, mc->mc_txn->mt_env->me_psize));
6944 np->mp_flags = flags | P_DIRTY;
6945 np->mp_lower = (PAGEHDRSZ-PAGEBASE);
6946 np->mp_upper = mc->mc_txn->mt_env->me_psize - PAGEBASE;
6949 mc->mc_db->md_branch_pages++;
6950 else if (IS_LEAF(np))
6951 mc->mc_db->md_leaf_pages++;
6952 else if (IS_OVERFLOW(np)) {
6953 mc->mc_db->md_overflow_pages += num;
6961 /** Calculate the size of a leaf node.
6962 * The size depends on the environment's page size; if a data item
6963 * is too large it will be put onto an overflow page and the node
6964 * size will only include the key and not the data. Sizes are always
6965 * rounded up to an even number of bytes, to guarantee 2-byte alignment
6966 * of the #MDB_node headers.
6967 * @param[in] env The environment handle.
6968 * @param[in] key The key for the node.
6969 * @param[in] data The data for the node.
6970 * @return The number of bytes needed to store the node.
6973 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
6977 sz = LEAFSIZE(key, data);
6978 if (sz > env->me_nodemax) {
6979 /* put on overflow page */
6980 sz -= data->mv_size - sizeof(pgno_t);
6983 return EVEN(sz + sizeof(indx_t));
6986 /** Calculate the size of a branch node.
6987 * The size should depend on the environment's page size but since
6988 * we currently don't support spilling large keys onto overflow
6989 * pages, it's simply the size of the #MDB_node header plus the
6990 * size of the key. Sizes are always rounded up to an even number
6991 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
6992 * @param[in] env The environment handle.
6993 * @param[in] key The key for the node.
6994 * @return The number of bytes needed to store the node.
6997 mdb_branch_size(MDB_env *env, MDB_val *key)
7002 if (sz > env->me_nodemax) {
7003 /* put on overflow page */
7004 /* not implemented */
7005 /* sz -= key->size - sizeof(pgno_t); */
7008 return sz + sizeof(indx_t);
7011 /** Add a node to the page pointed to by the cursor.
7012 * @param[in] mc The cursor for this operation.
7013 * @param[in] indx The index on the page where the new node should be added.
7014 * @param[in] key The key for the new node.
7015 * @param[in] data The data for the new node, if any.
7016 * @param[in] pgno The page number, if adding a branch node.
7017 * @param[in] flags Flags for the node.
7018 * @return 0 on success, non-zero on failure. Possible errors are:
7020 * <li>ENOMEM - failed to allocate overflow pages for the node.
7021 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
7022 * should never happen since all callers already calculate the
7023 * page's free space before calling this function.
7027 mdb_node_add(MDB_cursor *mc, indx_t indx,
7028 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
7031 size_t node_size = NODESIZE;
7035 MDB_page *mp = mc->mc_pg[mc->mc_top];
7036 MDB_page *ofp = NULL; /* overflow page */
7040 mdb_cassert(mc, mp->mp_upper >= mp->mp_lower);
7042 DPRINTF(("add to %s %spage %"Z"u index %i, data size %"Z"u key size %"Z"u [%s]",
7043 IS_LEAF(mp) ? "leaf" : "branch",
7044 IS_SUBP(mp) ? "sub-" : "",
7045 mdb_dbg_pgno(mp), indx, data ? data->mv_size : 0,
7046 key ? key->mv_size : 0, key ? DKEY(key) : "null"));
7049 /* Move higher keys up one slot. */
7050 int ksize = mc->mc_db->md_pad, dif;
7051 char *ptr = LEAF2KEY(mp, indx, ksize);
7052 dif = NUMKEYS(mp) - indx;
7054 memmove(ptr+ksize, ptr, dif*ksize);
7055 /* insert new key */
7056 memcpy(ptr, key->mv_data, ksize);
7058 /* Just using these for counting */
7059 mp->mp_lower += sizeof(indx_t);
7060 mp->mp_upper -= ksize - sizeof(indx_t);
7064 room = (ssize_t)SIZELEFT(mp) - (ssize_t)sizeof(indx_t);
7066 node_size += key->mv_size;
7068 mdb_cassert(mc, key && data);
7069 if (F_ISSET(flags, F_BIGDATA)) {
7070 /* Data already on overflow page. */
7071 node_size += sizeof(pgno_t);
7072 } else if (node_size + data->mv_size > mc->mc_txn->mt_env->me_nodemax) {
7073 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
7075 /* Put data on overflow page. */
7076 DPRINTF(("data size is %"Z"u, node would be %"Z"u, put data on overflow page",
7077 data->mv_size, node_size+data->mv_size));
7078 node_size = EVEN(node_size + sizeof(pgno_t));
7079 if ((ssize_t)node_size > room)
7081 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
7083 DPRINTF(("allocated overflow page %"Z"u", ofp->mp_pgno));
7087 node_size += data->mv_size;
7090 node_size = EVEN(node_size);
7091 if ((ssize_t)node_size > room)
7095 /* Move higher pointers up one slot. */
7096 for (i = NUMKEYS(mp); i > indx; i--)
7097 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
7099 /* Adjust free space offsets. */
7100 ofs = mp->mp_upper - node_size;
7101 mdb_cassert(mc, ofs >= mp->mp_lower + sizeof(indx_t));
7102 mp->mp_ptrs[indx] = ofs;
7104 mp->mp_lower += sizeof(indx_t);
7106 /* Write the node data. */
7107 node = NODEPTR(mp, indx);
7108 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
7109 node->mn_flags = flags;
7111 SETDSZ(node,data->mv_size);
7116 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
7119 ndata = NODEDATA(node);
7121 if (F_ISSET(flags, F_BIGDATA))
7122 memcpy(ndata, data->mv_data, sizeof(pgno_t));
7123 else if (F_ISSET(flags, MDB_RESERVE))
7124 data->mv_data = ndata;
7126 memcpy(ndata, data->mv_data, data->mv_size);
7128 memcpy(ndata, &ofp->mp_pgno, sizeof(pgno_t));
7129 ndata = METADATA(ofp);
7130 if (F_ISSET(flags, MDB_RESERVE))
7131 data->mv_data = ndata;
7133 memcpy(ndata, data->mv_data, data->mv_size);
7140 DPRINTF(("not enough room in page %"Z"u, got %u ptrs",
7141 mdb_dbg_pgno(mp), NUMKEYS(mp)));
7142 DPRINTF(("upper-lower = %u - %u = %"Z"d", mp->mp_upper,mp->mp_lower,room));
7143 DPRINTF(("node size = %"Z"u", node_size));
7144 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
7145 return MDB_PAGE_FULL;
7148 /** Delete the specified node from a page.
7149 * @param[in] mc Cursor pointing to the node to delete.
7150 * @param[in] ksize The size of a node. Only used if the page is
7151 * part of a #MDB_DUPFIXED database.
7154 mdb_node_del(MDB_cursor *mc, int ksize)
7156 MDB_page *mp = mc->mc_pg[mc->mc_top];
7157 indx_t indx = mc->mc_ki[mc->mc_top];
7159 indx_t i, j, numkeys, ptr;
7163 DPRINTF(("delete node %u on %s page %"Z"u", indx,
7164 IS_LEAF(mp) ? "leaf" : "branch", mdb_dbg_pgno(mp)));
7165 numkeys = NUMKEYS(mp);
7166 mdb_cassert(mc, indx < numkeys);
7169 int x = numkeys - 1 - indx;
7170 base = LEAF2KEY(mp, indx, ksize);
7172 memmove(base, base + ksize, x * ksize);
7173 mp->mp_lower -= sizeof(indx_t);
7174 mp->mp_upper += ksize - sizeof(indx_t);
7178 node = NODEPTR(mp, indx);
7179 sz = NODESIZE + node->mn_ksize;
7181 if (F_ISSET(node->mn_flags, F_BIGDATA))
7182 sz += sizeof(pgno_t);
7184 sz += NODEDSZ(node);
7188 ptr = mp->mp_ptrs[indx];
7189 for (i = j = 0; i < numkeys; i++) {
7191 mp->mp_ptrs[j] = mp->mp_ptrs[i];
7192 if (mp->mp_ptrs[i] < ptr)
7193 mp->mp_ptrs[j] += sz;
7198 base = (char *)mp + mp->mp_upper + PAGEBASE;
7199 memmove(base + sz, base, ptr - mp->mp_upper);
7201 mp->mp_lower -= sizeof(indx_t);
7205 /** Compact the main page after deleting a node on a subpage.
7206 * @param[in] mp The main page to operate on.
7207 * @param[in] indx The index of the subpage on the main page.
7210 mdb_node_shrink(MDB_page *mp, indx_t indx)
7215 indx_t delta, nsize, len, ptr;
7218 node = NODEPTR(mp, indx);
7219 sp = (MDB_page *)NODEDATA(node);
7220 delta = SIZELEFT(sp);
7221 nsize = NODEDSZ(node) - delta;
7223 /* Prepare to shift upward, set len = length(subpage part to shift) */
7227 return; /* do not make the node uneven-sized */
7229 xp = (MDB_page *)((char *)sp + delta); /* destination subpage */
7230 for (i = NUMKEYS(sp); --i >= 0; )
7231 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
7234 sp->mp_upper = sp->mp_lower;
7235 COPY_PGNO(sp->mp_pgno, mp->mp_pgno);
7236 SETDSZ(node, nsize);
7238 /* Shift <lower nodes...initial part of subpage> upward */
7239 base = (char *)mp + mp->mp_upper + PAGEBASE;
7240 memmove(base + delta, base, (char *)sp + len - base);
7242 ptr = mp->mp_ptrs[indx];
7243 for (i = NUMKEYS(mp); --i >= 0; ) {
7244 if (mp->mp_ptrs[i] <= ptr)
7245 mp->mp_ptrs[i] += delta;
7247 mp->mp_upper += delta;
7250 /** Initial setup of a sorted-dups cursor.
7251 * Sorted duplicates are implemented as a sub-database for the given key.
7252 * The duplicate data items are actually keys of the sub-database.
7253 * Operations on the duplicate data items are performed using a sub-cursor
7254 * initialized when the sub-database is first accessed. This function does
7255 * the preliminary setup of the sub-cursor, filling in the fields that
7256 * depend only on the parent DB.
7257 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
7260 mdb_xcursor_init0(MDB_cursor *mc)
7262 MDB_xcursor *mx = mc->mc_xcursor;
7264 mx->mx_cursor.mc_xcursor = NULL;
7265 mx->mx_cursor.mc_txn = mc->mc_txn;
7266 mx->mx_cursor.mc_db = &mx->mx_db;
7267 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
7268 mx->mx_cursor.mc_dbi = mc->mc_dbi;
7269 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
7270 mx->mx_cursor.mc_snum = 0;
7271 mx->mx_cursor.mc_top = 0;
7272 mx->mx_cursor.mc_flags = C_SUB;
7273 mx->mx_dbx.md_name.mv_size = 0;
7274 mx->mx_dbx.md_name.mv_data = NULL;
7275 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
7276 mx->mx_dbx.md_dcmp = NULL;
7277 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
7280 /** Final setup of a sorted-dups cursor.
7281 * Sets up the fields that depend on the data from the main cursor.
7282 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
7283 * @param[in] node The data containing the #MDB_db record for the
7284 * sorted-dup database.
7287 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
7289 MDB_xcursor *mx = mc->mc_xcursor;
7291 if (node->mn_flags & F_SUBDATA) {
7292 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
7293 mx->mx_cursor.mc_pg[0] = 0;
7294 mx->mx_cursor.mc_snum = 0;
7295 mx->mx_cursor.mc_top = 0;
7296 mx->mx_cursor.mc_flags = C_SUB;
7298 MDB_page *fp = NODEDATA(node);
7299 mx->mx_db.md_pad = 0;
7300 mx->mx_db.md_flags = 0;
7301 mx->mx_db.md_depth = 1;
7302 mx->mx_db.md_branch_pages = 0;
7303 mx->mx_db.md_leaf_pages = 1;
7304 mx->mx_db.md_overflow_pages = 0;
7305 mx->mx_db.md_entries = NUMKEYS(fp);
7306 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
7307 mx->mx_cursor.mc_snum = 1;
7308 mx->mx_cursor.mc_top = 0;
7309 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
7310 mx->mx_cursor.mc_pg[0] = fp;
7311 mx->mx_cursor.mc_ki[0] = 0;
7312 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
7313 mx->mx_db.md_flags = MDB_DUPFIXED;
7314 mx->mx_db.md_pad = fp->mp_pad;
7315 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
7316 mx->mx_db.md_flags |= MDB_INTEGERKEY;
7319 DPRINTF(("Sub-db -%u root page %"Z"u", mx->mx_cursor.mc_dbi,
7320 mx->mx_db.md_root));
7321 mx->mx_dbflag = DB_VALID|DB_USRVALID|DB_DIRTY; /* DB_DIRTY guides mdb_cursor_touch */
7322 #if UINT_MAX < SIZE_MAX
7323 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
7324 mx->mx_dbx.md_cmp = mdb_cmp_clong;
7328 /** Initialize a cursor for a given transaction and database. */
7330 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
7333 mc->mc_backup = NULL;
7336 mc->mc_db = &txn->mt_dbs[dbi];
7337 mc->mc_dbx = &txn->mt_dbxs[dbi];
7338 mc->mc_dbflag = &txn->mt_dbflags[dbi];
7344 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
7345 mdb_tassert(txn, mx != NULL);
7346 mc->mc_xcursor = mx;
7347 mdb_xcursor_init0(mc);
7349 mc->mc_xcursor = NULL;
7351 if (*mc->mc_dbflag & DB_STALE) {
7352 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
7357 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
7360 size_t size = sizeof(MDB_cursor);
7362 if (!ret || !TXN_DBI_EXIST(txn, dbi, DB_VALID))
7365 if (txn->mt_flags & MDB_TXN_BLOCKED)
7368 if (dbi == FREE_DBI && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
7371 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
7372 size += sizeof(MDB_xcursor);
7374 if ((mc = malloc(size)) != NULL) {
7375 mdb_cursor_init(mc, txn, dbi, (MDB_xcursor *)(mc + 1));
7376 if (txn->mt_cursors) {
7377 mc->mc_next = txn->mt_cursors[dbi];
7378 txn->mt_cursors[dbi] = mc;
7379 mc->mc_flags |= C_UNTRACK;
7391 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
7393 if (!mc || !TXN_DBI_EXIST(txn, mc->mc_dbi, DB_VALID))
7396 if ((mc->mc_flags & C_UNTRACK) || txn->mt_cursors)
7399 if (txn->mt_flags & MDB_TXN_BLOCKED)
7402 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
7406 /* Return the count of duplicate data items for the current key */
7408 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
7412 if (mc == NULL || countp == NULL)
7415 if (mc->mc_xcursor == NULL)
7416 return MDB_INCOMPATIBLE;
7418 if (mc->mc_txn->mt_flags & MDB_TXN_BLOCKED)
7421 if (!(mc->mc_flags & C_INITIALIZED))
7424 if (!mc->mc_snum || (mc->mc_flags & C_EOF))
7425 return MDB_NOTFOUND;
7427 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
7428 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
7431 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
7434 *countp = mc->mc_xcursor->mx_db.md_entries;
7440 mdb_cursor_close(MDB_cursor *mc)
7442 if (mc && !mc->mc_backup) {
7443 /* remove from txn, if tracked */
7444 if ((mc->mc_flags & C_UNTRACK) && mc->mc_txn->mt_cursors) {
7445 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
7446 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
7448 *prev = mc->mc_next;
7455 mdb_cursor_txn(MDB_cursor *mc)
7457 if (!mc) return NULL;
7462 mdb_cursor_dbi(MDB_cursor *mc)
7467 /** Replace the key for a branch node with a new key.
7468 * @param[in] mc Cursor pointing to the node to operate on.
7469 * @param[in] key The new key to use.
7470 * @return 0 on success, non-zero on failure.
7473 mdb_update_key(MDB_cursor *mc, MDB_val *key)
7479 int delta, ksize, oksize;
7480 indx_t ptr, i, numkeys, indx;
7483 indx = mc->mc_ki[mc->mc_top];
7484 mp = mc->mc_pg[mc->mc_top];
7485 node = NODEPTR(mp, indx);
7486 ptr = mp->mp_ptrs[indx];
7490 char kbuf2[DKBUF_MAXKEYSIZE*2+1];
7491 k2.mv_data = NODEKEY(node);
7492 k2.mv_size = node->mn_ksize;
7493 DPRINTF(("update key %u (ofs %u) [%s] to [%s] on page %"Z"u",
7495 mdb_dkey(&k2, kbuf2),
7501 /* Sizes must be 2-byte aligned. */
7502 ksize = EVEN(key->mv_size);
7503 oksize = EVEN(node->mn_ksize);
7504 delta = ksize - oksize;
7506 /* Shift node contents if EVEN(key length) changed. */
7508 if (delta > 0 && SIZELEFT(mp) < delta) {
7510 /* not enough space left, do a delete and split */
7511 DPRINTF(("Not enough room, delta = %d, splitting...", delta));
7512 pgno = NODEPGNO(node);
7513 mdb_node_del(mc, 0);
7514 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
7517 numkeys = NUMKEYS(mp);
7518 for (i = 0; i < numkeys; i++) {
7519 if (mp->mp_ptrs[i] <= ptr)
7520 mp->mp_ptrs[i] -= delta;
7523 base = (char *)mp + mp->mp_upper + PAGEBASE;
7524 len = ptr - mp->mp_upper + NODESIZE;
7525 memmove(base - delta, base, len);
7526 mp->mp_upper -= delta;
7528 node = NODEPTR(mp, indx);
7531 /* But even if no shift was needed, update ksize */
7532 if (node->mn_ksize != key->mv_size)
7533 node->mn_ksize = key->mv_size;
7536 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
7542 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
7544 /** Move a node from csrc to cdst.
7547 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
7554 unsigned short flags;
7558 /* Mark src and dst as dirty. */
7559 if ((rc = mdb_page_touch(csrc)) ||
7560 (rc = mdb_page_touch(cdst)))
7563 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7564 key.mv_size = csrc->mc_db->md_pad;
7565 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
7567 data.mv_data = NULL;
7571 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
7572 mdb_cassert(csrc, !((size_t)srcnode & 1));
7573 srcpg = NODEPGNO(srcnode);
7574 flags = srcnode->mn_flags;
7575 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7576 unsigned int snum = csrc->mc_snum;
7578 /* must find the lowest key below src */
7579 rc = mdb_page_search_lowest(csrc);
7582 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7583 key.mv_size = csrc->mc_db->md_pad;
7584 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7586 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7587 key.mv_size = NODEKSZ(s2);
7588 key.mv_data = NODEKEY(s2);
7590 csrc->mc_snum = snum--;
7591 csrc->mc_top = snum;
7593 key.mv_size = NODEKSZ(srcnode);
7594 key.mv_data = NODEKEY(srcnode);
7596 data.mv_size = NODEDSZ(srcnode);
7597 data.mv_data = NODEDATA(srcnode);
7599 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
7600 unsigned int snum = cdst->mc_snum;
7603 /* must find the lowest key below dst */
7604 mdb_cursor_copy(cdst, &mn);
7605 rc = mdb_page_search_lowest(&mn);
7608 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7609 bkey.mv_size = mn.mc_db->md_pad;
7610 bkey.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, bkey.mv_size);
7612 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7613 bkey.mv_size = NODEKSZ(s2);
7614 bkey.mv_data = NODEKEY(s2);
7616 mn.mc_snum = snum--;
7619 rc = mdb_update_key(&mn, &bkey);
7624 DPRINTF(("moving %s node %u [%s] on page %"Z"u to node %u on page %"Z"u",
7625 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
7626 csrc->mc_ki[csrc->mc_top],
7628 csrc->mc_pg[csrc->mc_top]->mp_pgno,
7629 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno));
7631 /* Add the node to the destination page.
7633 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
7634 if (rc != MDB_SUCCESS)
7637 /* Delete the node from the source page.
7639 mdb_node_del(csrc, key.mv_size);
7642 /* Adjust other cursors pointing to mp */
7643 MDB_cursor *m2, *m3;
7644 MDB_dbi dbi = csrc->mc_dbi;
7645 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
7647 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7648 if (csrc->mc_flags & C_SUB)
7649 m3 = &m2->mc_xcursor->mx_cursor;
7652 if (m3 == csrc) continue;
7653 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
7654 csrc->mc_ki[csrc->mc_top]) {
7655 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
7656 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
7661 /* Update the parent separators.
7663 if (csrc->mc_ki[csrc->mc_top] == 0) {
7664 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
7665 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7666 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7668 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7669 key.mv_size = NODEKSZ(srcnode);
7670 key.mv_data = NODEKEY(srcnode);
7672 DPRINTF(("update separator for source page %"Z"u to [%s]",
7673 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key)));
7674 mdb_cursor_copy(csrc, &mn);
7677 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7680 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7682 indx_t ix = csrc->mc_ki[csrc->mc_top];
7683 nullkey.mv_size = 0;
7684 csrc->mc_ki[csrc->mc_top] = 0;
7685 rc = mdb_update_key(csrc, &nullkey);
7686 csrc->mc_ki[csrc->mc_top] = ix;
7687 mdb_cassert(csrc, rc == MDB_SUCCESS);
7691 if (cdst->mc_ki[cdst->mc_top] == 0) {
7692 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
7693 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7694 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
7696 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
7697 key.mv_size = NODEKSZ(srcnode);
7698 key.mv_data = NODEKEY(srcnode);
7700 DPRINTF(("update separator for destination page %"Z"u to [%s]",
7701 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key)));
7702 mdb_cursor_copy(cdst, &mn);
7705 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7708 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
7710 indx_t ix = cdst->mc_ki[cdst->mc_top];
7711 nullkey.mv_size = 0;
7712 cdst->mc_ki[cdst->mc_top] = 0;
7713 rc = mdb_update_key(cdst, &nullkey);
7714 cdst->mc_ki[cdst->mc_top] = ix;
7715 mdb_cassert(cdst, rc == MDB_SUCCESS);
7722 /** Merge one page into another.
7723 * The nodes from the page pointed to by \b csrc will
7724 * be copied to the page pointed to by \b cdst and then
7725 * the \b csrc page will be freed.
7726 * @param[in] csrc Cursor pointing to the source page.
7727 * @param[in] cdst Cursor pointing to the destination page.
7728 * @return 0 on success, non-zero on failure.
7731 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
7733 MDB_page *psrc, *pdst;
7740 psrc = csrc->mc_pg[csrc->mc_top];
7741 pdst = cdst->mc_pg[cdst->mc_top];
7743 DPRINTF(("merging page %"Z"u into %"Z"u", psrc->mp_pgno, pdst->mp_pgno));
7745 mdb_cassert(csrc, csrc->mc_snum > 1); /* can't merge root page */
7746 mdb_cassert(csrc, cdst->mc_snum > 1);
7748 /* Mark dst as dirty. */
7749 if ((rc = mdb_page_touch(cdst)))
7752 /* Move all nodes from src to dst.
7754 j = nkeys = NUMKEYS(pdst);
7755 if (IS_LEAF2(psrc)) {
7756 key.mv_size = csrc->mc_db->md_pad;
7757 key.mv_data = METADATA(psrc);
7758 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7759 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
7760 if (rc != MDB_SUCCESS)
7762 key.mv_data = (char *)key.mv_data + key.mv_size;
7765 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7766 srcnode = NODEPTR(psrc, i);
7767 if (i == 0 && IS_BRANCH(psrc)) {
7770 mdb_cursor_copy(csrc, &mn);
7771 /* must find the lowest key below src */
7772 rc = mdb_page_search_lowest(&mn);
7775 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7776 key.mv_size = mn.mc_db->md_pad;
7777 key.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, key.mv_size);
7779 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7780 key.mv_size = NODEKSZ(s2);
7781 key.mv_data = NODEKEY(s2);
7784 key.mv_size = srcnode->mn_ksize;
7785 key.mv_data = NODEKEY(srcnode);
7788 data.mv_size = NODEDSZ(srcnode);
7789 data.mv_data = NODEDATA(srcnode);
7790 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
7791 if (rc != MDB_SUCCESS)
7796 DPRINTF(("dst page %"Z"u now has %u keys (%.1f%% filled)",
7797 pdst->mp_pgno, NUMKEYS(pdst),
7798 (float)PAGEFILL(cdst->mc_txn->mt_env, pdst) / 10));
7800 /* Unlink the src page from parent and add to free list.
7803 mdb_node_del(csrc, 0);
7804 if (csrc->mc_ki[csrc->mc_top] == 0) {
7806 rc = mdb_update_key(csrc, &key);
7814 psrc = csrc->mc_pg[csrc->mc_top];
7815 /* If not operating on FreeDB, allow this page to be reused
7816 * in this txn. Otherwise just add to free list.
7818 rc = mdb_page_loose(csrc, psrc);
7822 csrc->mc_db->md_leaf_pages--;
7824 csrc->mc_db->md_branch_pages--;
7826 /* Adjust other cursors pointing to mp */
7827 MDB_cursor *m2, *m3;
7828 MDB_dbi dbi = csrc->mc_dbi;
7830 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7831 if (csrc->mc_flags & C_SUB)
7832 m3 = &m2->mc_xcursor->mx_cursor;
7835 if (m3 == csrc) continue;
7836 if (m3->mc_snum < csrc->mc_snum) continue;
7837 if (m3->mc_pg[csrc->mc_top] == psrc) {
7838 m3->mc_pg[csrc->mc_top] = pdst;
7839 m3->mc_ki[csrc->mc_top] += nkeys;
7844 unsigned int snum = cdst->mc_snum;
7845 uint16_t depth = cdst->mc_db->md_depth;
7846 mdb_cursor_pop(cdst);
7847 rc = mdb_rebalance(cdst);
7848 /* Did the tree shrink? */
7849 if (depth > cdst->mc_db->md_depth)
7851 cdst->mc_snum = snum;
7852 cdst->mc_top = snum-1;
7857 /** Copy the contents of a cursor.
7858 * @param[in] csrc The cursor to copy from.
7859 * @param[out] cdst The cursor to copy to.
7862 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
7866 cdst->mc_txn = csrc->mc_txn;
7867 cdst->mc_dbi = csrc->mc_dbi;
7868 cdst->mc_db = csrc->mc_db;
7869 cdst->mc_dbx = csrc->mc_dbx;
7870 cdst->mc_snum = csrc->mc_snum;
7871 cdst->mc_top = csrc->mc_top;
7872 cdst->mc_flags = csrc->mc_flags;
7874 for (i=0; i<csrc->mc_snum; i++) {
7875 cdst->mc_pg[i] = csrc->mc_pg[i];
7876 cdst->mc_ki[i] = csrc->mc_ki[i];
7880 /** Rebalance the tree after a delete operation.
7881 * @param[in] mc Cursor pointing to the page where rebalancing
7883 * @return 0 on success, non-zero on failure.
7886 mdb_rebalance(MDB_cursor *mc)
7890 unsigned int ptop, minkeys, thresh;
7894 if (IS_BRANCH(mc->mc_pg[mc->mc_top])) {
7899 thresh = FILL_THRESHOLD;
7901 DPRINTF(("rebalancing %s page %"Z"u (has %u keys, %.1f%% full)",
7902 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
7903 mdb_dbg_pgno(mc->mc_pg[mc->mc_top]), NUMKEYS(mc->mc_pg[mc->mc_top]),
7904 (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10));
7906 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= thresh &&
7907 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
7908 DPRINTF(("no need to rebalance page %"Z"u, above fill threshold",
7909 mdb_dbg_pgno(mc->mc_pg[mc->mc_top])));
7913 if (mc->mc_snum < 2) {
7914 MDB_page *mp = mc->mc_pg[0];
7916 DPUTS("Can't rebalance a subpage, ignoring");
7919 if (NUMKEYS(mp) == 0) {
7920 DPUTS("tree is completely empty");
7921 mc->mc_db->md_root = P_INVALID;
7922 mc->mc_db->md_depth = 0;
7923 mc->mc_db->md_leaf_pages = 0;
7924 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7927 /* Adjust cursors pointing to mp */
7930 mc->mc_flags &= ~C_INITIALIZED;
7932 MDB_cursor *m2, *m3;
7933 MDB_dbi dbi = mc->mc_dbi;
7935 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7936 if (mc->mc_flags & C_SUB)
7937 m3 = &m2->mc_xcursor->mx_cursor;
7940 if (m3->mc_snum < mc->mc_snum) continue;
7941 if (m3->mc_pg[0] == mp) {
7944 m3->mc_flags &= ~C_INITIALIZED;
7948 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
7950 DPUTS("collapsing root page!");
7951 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7954 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
7955 rc = mdb_page_get(mc->mc_txn,mc->mc_db->md_root,&mc->mc_pg[0],NULL);
7958 mc->mc_db->md_depth--;
7959 mc->mc_db->md_branch_pages--;
7960 mc->mc_ki[0] = mc->mc_ki[1];
7961 for (i = 1; i<mc->mc_db->md_depth; i++) {
7962 mc->mc_pg[i] = mc->mc_pg[i+1];
7963 mc->mc_ki[i] = mc->mc_ki[i+1];
7966 /* Adjust other cursors pointing to mp */
7967 MDB_cursor *m2, *m3;
7968 MDB_dbi dbi = mc->mc_dbi;
7970 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7971 if (mc->mc_flags & C_SUB)
7972 m3 = &m2->mc_xcursor->mx_cursor;
7975 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
7976 if (m3->mc_pg[0] == mp) {
7977 for (i=0; i<m3->mc_snum; i++) {
7978 m3->mc_pg[i] = m3->mc_pg[i+1];
7979 m3->mc_ki[i] = m3->mc_ki[i+1];
7987 DPUTS("root page doesn't need rebalancing");
7991 /* The parent (branch page) must have at least 2 pointers,
7992 * otherwise the tree is invalid.
7994 ptop = mc->mc_top-1;
7995 mdb_cassert(mc, NUMKEYS(mc->mc_pg[ptop]) > 1);
7997 /* Leaf page fill factor is below the threshold.
7998 * Try to move keys from left or right neighbor, or
7999 * merge with a neighbor page.
8004 mdb_cursor_copy(mc, &mn);
8005 mn.mc_xcursor = NULL;
8007 oldki = mc->mc_ki[mc->mc_top];
8008 if (mc->mc_ki[ptop] == 0) {
8009 /* We're the leftmost leaf in our parent.
8011 DPUTS("reading right neighbor");
8013 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
8014 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
8017 mn.mc_ki[mn.mc_top] = 0;
8018 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
8020 /* There is at least one neighbor to the left.
8022 DPUTS("reading left neighbor");
8024 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
8025 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
8028 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
8029 mc->mc_ki[mc->mc_top] = 0;
8032 DPRINTF(("found neighbor page %"Z"u (%u keys, %.1f%% full)",
8033 mn.mc_pg[mn.mc_top]->mp_pgno, NUMKEYS(mn.mc_pg[mn.mc_top]),
8034 (float)PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) / 10));
8036 /* If the neighbor page is above threshold and has enough keys,
8037 * move one key from it. Otherwise we should try to merge them.
8038 * (A branch page must never have less than 2 keys.)
8040 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= thresh && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys) {
8041 rc = mdb_node_move(&mn, mc);
8042 if (mc->mc_ki[ptop]) {
8046 if (mc->mc_ki[ptop] == 0) {
8047 rc = mdb_page_merge(&mn, mc);
8050 oldki += NUMKEYS(mn.mc_pg[mn.mc_top]);
8051 mn.mc_ki[mn.mc_top] += mc->mc_ki[mn.mc_top] + 1;
8052 /* We want mdb_rebalance to find mn when doing fixups */
8053 if (mc->mc_flags & C_SUB) {
8054 dummy.mc_next = mc->mc_txn->mt_cursors[mc->mc_dbi];
8055 mc->mc_txn->mt_cursors[mc->mc_dbi] = &dummy;
8056 dummy.mc_xcursor = (MDB_xcursor *)&mn;
8058 mn.mc_next = mc->mc_txn->mt_cursors[mc->mc_dbi];
8059 mc->mc_txn->mt_cursors[mc->mc_dbi] = &mn;
8061 rc = mdb_page_merge(mc, &mn);
8062 if (mc->mc_flags & C_SUB)
8063 mc->mc_txn->mt_cursors[mc->mc_dbi] = dummy.mc_next;
8065 mc->mc_txn->mt_cursors[mc->mc_dbi] = mn.mc_next;
8066 mdb_cursor_copy(&mn, mc);
8068 mc->mc_flags &= ~C_EOF;
8070 mc->mc_ki[mc->mc_top] = oldki;
8074 /** Complete a delete operation started by #mdb_cursor_del(). */
8076 mdb_cursor_del0(MDB_cursor *mc)
8083 ki = mc->mc_ki[mc->mc_top];
8084 mdb_node_del(mc, mc->mc_db->md_pad);
8085 mc->mc_db->md_entries--;
8086 rc = mdb_rebalance(mc);
8088 if (rc == MDB_SUCCESS) {
8089 MDB_cursor *m2, *m3;
8090 MDB_dbi dbi = mc->mc_dbi;
8092 /* DB is totally empty now, just bail out.
8093 * Other cursors adjustments were already done
8094 * by mdb_rebalance and aren't needed here.
8099 mp = mc->mc_pg[mc->mc_top];
8100 nkeys = NUMKEYS(mp);
8102 /* if mc points past last node in page, find next sibling */
8103 if (mc->mc_ki[mc->mc_top] >= nkeys) {
8104 rc = mdb_cursor_sibling(mc, 1);
8105 if (rc == MDB_NOTFOUND) {
8106 mc->mc_flags |= C_EOF;
8111 /* Adjust other cursors pointing to mp */
8112 for (m2 = mc->mc_txn->mt_cursors[dbi]; !rc && m2; m2=m2->mc_next) {
8113 m3 = (mc->mc_flags & C_SUB) ? &m2->mc_xcursor->mx_cursor : m2;
8114 if (! (m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8116 if (m3 == mc || m3->mc_snum < mc->mc_snum)
8118 if (m3->mc_pg[mc->mc_top] == mp) {
8119 if (m3->mc_ki[mc->mc_top] >= ki) {
8120 m3->mc_flags |= C_DEL;
8121 if (m3->mc_ki[mc->mc_top] > ki)
8122 m3->mc_ki[mc->mc_top]--;
8123 else if (mc->mc_db->md_flags & MDB_DUPSORT)
8124 m3->mc_xcursor->mx_cursor.mc_flags |= C_EOF;
8126 if (m3->mc_ki[mc->mc_top] >= nkeys) {
8127 rc = mdb_cursor_sibling(m3, 1);
8128 if (rc == MDB_NOTFOUND) {
8129 m3->mc_flags |= C_EOF;
8135 mc->mc_flags |= C_DEL;
8139 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
8144 mdb_del(MDB_txn *txn, MDB_dbi dbi,
8145 MDB_val *key, MDB_val *data)
8147 if (!key || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
8150 if (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_BLOCKED))
8151 return (txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
8153 if (!F_ISSET(txn->mt_dbs[dbi].md_flags, MDB_DUPSORT)) {
8154 /* must ignore any data */
8158 return mdb_del0(txn, dbi, key, data, 0);
8162 mdb_del0(MDB_txn *txn, MDB_dbi dbi,
8163 MDB_val *key, MDB_val *data, unsigned flags)
8168 MDB_val rdata, *xdata;
8172 DPRINTF(("====> delete db %u key [%s]", dbi, DKEY(key)));
8174 mdb_cursor_init(&mc, txn, dbi, &mx);
8183 flags |= MDB_NODUPDATA;
8185 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
8187 /* let mdb_page_split know about this cursor if needed:
8188 * delete will trigger a rebalance; if it needs to move
8189 * a node from one page to another, it will have to
8190 * update the parent's separator key(s). If the new sepkey
8191 * is larger than the current one, the parent page may
8192 * run out of space, triggering a split. We need this
8193 * cursor to be consistent until the end of the rebalance.
8195 mc.mc_flags |= C_UNTRACK;
8196 mc.mc_next = txn->mt_cursors[dbi];
8197 txn->mt_cursors[dbi] = &mc;
8198 rc = mdb_cursor_del(&mc, flags);
8199 txn->mt_cursors[dbi] = mc.mc_next;
8204 /** Split a page and insert a new node.
8205 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
8206 * The cursor will be updated to point to the actual page and index where
8207 * the node got inserted after the split.
8208 * @param[in] newkey The key for the newly inserted node.
8209 * @param[in] newdata The data for the newly inserted node.
8210 * @param[in] newpgno The page number, if the new node is a branch node.
8211 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
8212 * @return 0 on success, non-zero on failure.
8215 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
8216 unsigned int nflags)
8219 int rc = MDB_SUCCESS, new_root = 0, did_split = 0;
8222 int i, j, split_indx, nkeys, pmax;
8223 MDB_env *env = mc->mc_txn->mt_env;
8225 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
8226 MDB_page *copy = NULL;
8227 MDB_page *mp, *rp, *pp;
8232 mp = mc->mc_pg[mc->mc_top];
8233 newindx = mc->mc_ki[mc->mc_top];
8234 nkeys = NUMKEYS(mp);
8236 DPRINTF(("-----> splitting %s page %"Z"u and adding [%s] at index %i/%i",
8237 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
8238 DKEY(newkey), mc->mc_ki[mc->mc_top], nkeys));
8240 /* Create a right sibling. */
8241 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
8243 rp->mp_pad = mp->mp_pad;
8244 DPRINTF(("new right sibling: page %"Z"u", rp->mp_pgno));
8246 if (mc->mc_snum < 2) {
8247 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
8249 /* shift current top to make room for new parent */
8250 mc->mc_pg[1] = mc->mc_pg[0];
8251 mc->mc_ki[1] = mc->mc_ki[0];
8254 mc->mc_db->md_root = pp->mp_pgno;
8255 DPRINTF(("root split! new root = %"Z"u", pp->mp_pgno));
8256 mc->mc_db->md_depth++;
8259 /* Add left (implicit) pointer. */
8260 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
8261 /* undo the pre-push */
8262 mc->mc_pg[0] = mc->mc_pg[1];
8263 mc->mc_ki[0] = mc->mc_ki[1];
8264 mc->mc_db->md_root = mp->mp_pgno;
8265 mc->mc_db->md_depth--;
8272 ptop = mc->mc_top-1;
8273 DPRINTF(("parent branch page is %"Z"u", mc->mc_pg[ptop]->mp_pgno));
8276 mc->mc_flags |= C_SPLITTING;
8277 mdb_cursor_copy(mc, &mn);
8278 mn.mc_pg[mn.mc_top] = rp;
8279 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
8281 if (nflags & MDB_APPEND) {
8282 mn.mc_ki[mn.mc_top] = 0;
8284 split_indx = newindx;
8288 split_indx = (nkeys+1) / 2;
8293 unsigned int lsize, rsize, ksize;
8294 /* Move half of the keys to the right sibling */
8295 x = mc->mc_ki[mc->mc_top] - split_indx;
8296 ksize = mc->mc_db->md_pad;
8297 split = LEAF2KEY(mp, split_indx, ksize);
8298 rsize = (nkeys - split_indx) * ksize;
8299 lsize = (nkeys - split_indx) * sizeof(indx_t);
8300 mp->mp_lower -= lsize;
8301 rp->mp_lower += lsize;
8302 mp->mp_upper += rsize - lsize;
8303 rp->mp_upper -= rsize - lsize;
8304 sepkey.mv_size = ksize;
8305 if (newindx == split_indx) {
8306 sepkey.mv_data = newkey->mv_data;
8308 sepkey.mv_data = split;
8311 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
8312 memcpy(rp->mp_ptrs, split, rsize);
8313 sepkey.mv_data = rp->mp_ptrs;
8314 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
8315 memcpy(ins, newkey->mv_data, ksize);
8316 mp->mp_lower += sizeof(indx_t);
8317 mp->mp_upper -= ksize - sizeof(indx_t);
8320 memcpy(rp->mp_ptrs, split, x * ksize);
8321 ins = LEAF2KEY(rp, x, ksize);
8322 memcpy(ins, newkey->mv_data, ksize);
8323 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
8324 rp->mp_lower += sizeof(indx_t);
8325 rp->mp_upper -= ksize - sizeof(indx_t);
8326 mc->mc_ki[mc->mc_top] = x;
8327 mc->mc_pg[mc->mc_top] = rp;
8330 int psize, nsize, k;
8331 /* Maximum free space in an empty page */
8332 pmax = env->me_psize - PAGEHDRSZ;
8334 nsize = mdb_leaf_size(env, newkey, newdata);
8336 nsize = mdb_branch_size(env, newkey);
8337 nsize = EVEN(nsize);
8339 /* grab a page to hold a temporary copy */
8340 copy = mdb_page_malloc(mc->mc_txn, 1);
8345 copy->mp_pgno = mp->mp_pgno;
8346 copy->mp_flags = mp->mp_flags;
8347 copy->mp_lower = (PAGEHDRSZ-PAGEBASE);
8348 copy->mp_upper = env->me_psize - PAGEBASE;
8350 /* prepare to insert */
8351 for (i=0, j=0; i<nkeys; i++) {
8353 copy->mp_ptrs[j++] = 0;
8355 copy->mp_ptrs[j++] = mp->mp_ptrs[i];
8358 /* When items are relatively large the split point needs
8359 * to be checked, because being off-by-one will make the
8360 * difference between success or failure in mdb_node_add.
8362 * It's also relevant if a page happens to be laid out
8363 * such that one half of its nodes are all "small" and
8364 * the other half of its nodes are "large." If the new
8365 * item is also "large" and falls on the half with
8366 * "large" nodes, it also may not fit.
8368 * As a final tweak, if the new item goes on the last
8369 * spot on the page (and thus, onto the new page), bias
8370 * the split so the new page is emptier than the old page.
8371 * This yields better packing during sequential inserts.
8373 if (nkeys < 20 || nsize > pmax/16 || newindx >= nkeys) {
8374 /* Find split point */
8376 if (newindx <= split_indx || newindx >= nkeys) {
8378 k = newindx >= nkeys ? nkeys : split_indx+1+IS_LEAF(mp);
8383 for (; i!=k; i+=j) {
8388 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
8389 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
8391 if (F_ISSET(node->mn_flags, F_BIGDATA))
8392 psize += sizeof(pgno_t);
8394 psize += NODEDSZ(node);
8396 psize = EVEN(psize);
8398 if (psize > pmax || i == k-j) {
8399 split_indx = i + (j<0);
8404 if (split_indx == newindx) {
8405 sepkey.mv_size = newkey->mv_size;
8406 sepkey.mv_data = newkey->mv_data;
8408 node = (MDB_node *)((char *)mp + copy->mp_ptrs[split_indx] + PAGEBASE);
8409 sepkey.mv_size = node->mn_ksize;
8410 sepkey.mv_data = NODEKEY(node);
8415 DPRINTF(("separator is %d [%s]", split_indx, DKEY(&sepkey)));
8417 /* Copy separator key to the parent.
8419 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(env, &sepkey)) {
8423 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
8428 if (mn.mc_snum == mc->mc_snum) {
8429 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
8430 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
8431 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
8432 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
8437 /* Right page might now have changed parent.
8438 * Check if left page also changed parent.
8440 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
8441 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
8442 for (i=0; i<ptop; i++) {
8443 mc->mc_pg[i] = mn.mc_pg[i];
8444 mc->mc_ki[i] = mn.mc_ki[i];
8446 mc->mc_pg[ptop] = mn.mc_pg[ptop];
8447 if (mn.mc_ki[ptop]) {
8448 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
8450 /* find right page's left sibling */
8451 mc->mc_ki[ptop] = mn.mc_ki[ptop];
8452 mdb_cursor_sibling(mc, 0);
8457 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
8460 mc->mc_flags ^= C_SPLITTING;
8461 if (rc != MDB_SUCCESS) {
8464 if (nflags & MDB_APPEND) {
8465 mc->mc_pg[mc->mc_top] = rp;
8466 mc->mc_ki[mc->mc_top] = 0;
8467 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
8470 for (i=0; i<mc->mc_top; i++)
8471 mc->mc_ki[i] = mn.mc_ki[i];
8472 } else if (!IS_LEAF2(mp)) {
8474 mc->mc_pg[mc->mc_top] = rp;
8479 rkey.mv_data = newkey->mv_data;
8480 rkey.mv_size = newkey->mv_size;
8486 /* Update index for the new key. */
8487 mc->mc_ki[mc->mc_top] = j;
8489 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
8490 rkey.mv_data = NODEKEY(node);
8491 rkey.mv_size = node->mn_ksize;
8493 xdata.mv_data = NODEDATA(node);
8494 xdata.mv_size = NODEDSZ(node);
8497 pgno = NODEPGNO(node);
8498 flags = node->mn_flags;
8501 if (!IS_LEAF(mp) && j == 0) {
8502 /* First branch index doesn't need key data. */
8506 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
8512 mc->mc_pg[mc->mc_top] = copy;
8517 } while (i != split_indx);
8519 nkeys = NUMKEYS(copy);
8520 for (i=0; i<nkeys; i++)
8521 mp->mp_ptrs[i] = copy->mp_ptrs[i];
8522 mp->mp_lower = copy->mp_lower;
8523 mp->mp_upper = copy->mp_upper;
8524 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
8525 env->me_psize - copy->mp_upper - PAGEBASE);
8527 /* reset back to original page */
8528 if (newindx < split_indx) {
8529 mc->mc_pg[mc->mc_top] = mp;
8530 if (nflags & MDB_RESERVE) {
8531 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
8532 if (!(node->mn_flags & F_BIGDATA))
8533 newdata->mv_data = NODEDATA(node);
8536 mc->mc_pg[mc->mc_top] = rp;
8538 /* Make sure mc_ki is still valid.
8540 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
8541 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
8542 for (i=0; i<=ptop; i++) {
8543 mc->mc_pg[i] = mn.mc_pg[i];
8544 mc->mc_ki[i] = mn.mc_ki[i];
8551 /* Adjust other cursors pointing to mp */
8552 MDB_cursor *m2, *m3;
8553 MDB_dbi dbi = mc->mc_dbi;
8554 int fixup = NUMKEYS(mp);
8556 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
8557 if (mc->mc_flags & C_SUB)
8558 m3 = &m2->mc_xcursor->mx_cursor;
8563 if (!(m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8565 if (m3->mc_flags & C_SPLITTING)
8570 for (k=m3->mc_top; k>=0; k--) {
8571 m3->mc_ki[k+1] = m3->mc_ki[k];
8572 m3->mc_pg[k+1] = m3->mc_pg[k];
8574 if (m3->mc_ki[0] >= split_indx) {
8579 m3->mc_pg[0] = mc->mc_pg[0];
8583 if (m3->mc_top >= mc->mc_top && m3->mc_pg[mc->mc_top] == mp) {
8584 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
8585 m3->mc_ki[mc->mc_top]++;
8586 if (m3->mc_ki[mc->mc_top] >= fixup) {
8587 m3->mc_pg[mc->mc_top] = rp;
8588 m3->mc_ki[mc->mc_top] -= fixup;
8589 m3->mc_ki[ptop] = mn.mc_ki[ptop];
8591 } else if (!did_split && m3->mc_top >= ptop && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
8592 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
8597 DPRINTF(("mp left: %d, rp left: %d", SIZELEFT(mp), SIZELEFT(rp)));
8600 if (copy) /* tmp page */
8601 mdb_page_free(env, copy);
8603 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
8608 mdb_put(MDB_txn *txn, MDB_dbi dbi,
8609 MDB_val *key, MDB_val *data, unsigned int flags)
8614 if (!key || !data || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
8617 if (flags & ~(MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP))
8620 if (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_BLOCKED))
8621 return (txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
8623 mdb_cursor_init(&mc, txn, dbi, &mx);
8624 return mdb_cursor_put(&mc, key, data, flags);
8628 #define MDB_WBUF (1024*1024)
8631 /** State needed for a compacting copy. */
8632 typedef struct mdb_copy {
8633 pthread_mutex_t mc_mutex;
8634 pthread_cond_t mc_cond;
8641 pgno_t mc_next_pgno;
8644 volatile int mc_new;
8649 /** Dedicated writer thread for compacting copy. */
8650 static THREAD_RET ESECT
8651 mdb_env_copythr(void *arg)
8655 int toggle = 0, wsize, rc;
8658 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
8661 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
8664 pthread_mutex_lock(&my->mc_mutex);
8666 pthread_cond_signal(&my->mc_cond);
8669 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8670 if (my->mc_new < 0) {
8675 wsize = my->mc_wlen[toggle];
8676 ptr = my->mc_wbuf[toggle];
8679 DO_WRITE(rc, my->mc_fd, ptr, wsize, len);
8683 } else if (len > 0) {
8697 /* If there's an overflow page tail, write it too */
8698 if (my->mc_olen[toggle]) {
8699 wsize = my->mc_olen[toggle];
8700 ptr = my->mc_over[toggle];
8701 my->mc_olen[toggle] = 0;
8704 my->mc_wlen[toggle] = 0;
8706 pthread_cond_signal(&my->mc_cond);
8708 pthread_cond_signal(&my->mc_cond);
8709 pthread_mutex_unlock(&my->mc_mutex);
8710 return (THREAD_RET)0;
8714 /** Tell the writer thread there's a buffer ready to write */
8716 mdb_env_cthr_toggle(mdb_copy *my, int st)
8718 int toggle = my->mc_toggle ^ 1;
8719 pthread_mutex_lock(&my->mc_mutex);
8720 if (my->mc_status) {
8721 pthread_mutex_unlock(&my->mc_mutex);
8722 return my->mc_status;
8724 while (my->mc_new == 1)
8725 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8727 my->mc_toggle = toggle;
8728 pthread_cond_signal(&my->mc_cond);
8729 pthread_mutex_unlock(&my->mc_mutex);
8733 /** Depth-first tree traversal for compacting copy. */
8735 mdb_env_cwalk(mdb_copy *my, pgno_t *pg, int flags)
8738 MDB_txn *txn = my->mc_txn;
8740 MDB_page *mo, *mp, *leaf;
8745 /* Empty DB, nothing to do */
8746 if (*pg == P_INVALID)
8753 rc = mdb_page_get(my->mc_txn, *pg, &mc.mc_pg[0], NULL);
8756 rc = mdb_page_search_root(&mc, NULL, MDB_PS_FIRST);
8760 /* Make cursor pages writable */
8761 buf = ptr = malloc(my->mc_env->me_psize * mc.mc_snum);
8765 for (i=0; i<mc.mc_top; i++) {
8766 mdb_page_copy((MDB_page *)ptr, mc.mc_pg[i], my->mc_env->me_psize);
8767 mc.mc_pg[i] = (MDB_page *)ptr;
8768 ptr += my->mc_env->me_psize;
8771 /* This is writable space for a leaf page. Usually not needed. */
8772 leaf = (MDB_page *)ptr;
8774 toggle = my->mc_toggle;
8775 while (mc.mc_snum > 0) {
8777 mp = mc.mc_pg[mc.mc_top];
8781 if (!IS_LEAF2(mp) && !(flags & F_DUPDATA)) {
8782 for (i=0; i<n; i++) {
8783 ni = NODEPTR(mp, i);
8784 if (ni->mn_flags & F_BIGDATA) {
8788 /* Need writable leaf */
8790 mc.mc_pg[mc.mc_top] = leaf;
8791 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8793 ni = NODEPTR(mp, i);
8796 memcpy(&pg, NODEDATA(ni), sizeof(pg));
8797 rc = mdb_page_get(txn, pg, &omp, NULL);
8800 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8801 rc = mdb_env_cthr_toggle(my, 1);
8804 toggle = my->mc_toggle;
8806 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8807 memcpy(mo, omp, my->mc_env->me_psize);
8808 mo->mp_pgno = my->mc_next_pgno;
8809 my->mc_next_pgno += omp->mp_pages;
8810 my->mc_wlen[toggle] += my->mc_env->me_psize;
8811 if (omp->mp_pages > 1) {
8812 my->mc_olen[toggle] = my->mc_env->me_psize * (omp->mp_pages - 1);
8813 my->mc_over[toggle] = (char *)omp + my->mc_env->me_psize;
8814 rc = mdb_env_cthr_toggle(my, 1);
8817 toggle = my->mc_toggle;
8819 memcpy(NODEDATA(ni), &mo->mp_pgno, sizeof(pgno_t));
8820 } else if (ni->mn_flags & F_SUBDATA) {
8823 /* Need writable leaf */
8825 mc.mc_pg[mc.mc_top] = leaf;
8826 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8828 ni = NODEPTR(mp, i);
8831 memcpy(&db, NODEDATA(ni), sizeof(db));
8832 my->mc_toggle = toggle;
8833 rc = mdb_env_cwalk(my, &db.md_root, ni->mn_flags & F_DUPDATA);
8836 toggle = my->mc_toggle;
8837 memcpy(NODEDATA(ni), &db, sizeof(db));
8842 mc.mc_ki[mc.mc_top]++;
8843 if (mc.mc_ki[mc.mc_top] < n) {
8846 ni = NODEPTR(mp, mc.mc_ki[mc.mc_top]);
8848 rc = mdb_page_get(txn, pg, &mp, NULL);
8853 mc.mc_ki[mc.mc_top] = 0;
8854 if (IS_BRANCH(mp)) {
8855 /* Whenever we advance to a sibling branch page,
8856 * we must proceed all the way down to its first leaf.
8858 mdb_page_copy(mc.mc_pg[mc.mc_top], mp, my->mc_env->me_psize);
8861 mc.mc_pg[mc.mc_top] = mp;
8865 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8866 rc = mdb_env_cthr_toggle(my, 1);
8869 toggle = my->mc_toggle;
8871 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8872 mdb_page_copy(mo, mp, my->mc_env->me_psize);
8873 mo->mp_pgno = my->mc_next_pgno++;
8874 my->mc_wlen[toggle] += my->mc_env->me_psize;
8876 /* Update parent if there is one */
8877 ni = NODEPTR(mc.mc_pg[mc.mc_top-1], mc.mc_ki[mc.mc_top-1]);
8878 SETPGNO(ni, mo->mp_pgno);
8879 mdb_cursor_pop(&mc);
8881 /* Otherwise we're done */
8891 /** Copy environment with compaction. */
8893 mdb_env_copyfd1(MDB_env *env, HANDLE fd)
8898 MDB_txn *txn = NULL;
8903 my.mc_mutex = CreateMutex(NULL, FALSE, NULL);
8904 my.mc_cond = CreateEvent(NULL, FALSE, FALSE, NULL);
8905 my.mc_wbuf[0] = _aligned_malloc(MDB_WBUF*2, env->me_os_psize);
8906 if (my.mc_wbuf[0] == NULL)
8909 pthread_mutex_init(&my.mc_mutex, NULL);
8910 pthread_cond_init(&my.mc_cond, NULL);
8911 #ifdef HAVE_MEMALIGN
8912 my.mc_wbuf[0] = memalign(env->me_os_psize, MDB_WBUF*2);
8913 if (my.mc_wbuf[0] == NULL)
8916 rc = posix_memalign((void **)&my.mc_wbuf[0], env->me_os_psize, MDB_WBUF*2);
8921 memset(my.mc_wbuf[0], 0, MDB_WBUF*2);
8922 my.mc_wbuf[1] = my.mc_wbuf[0] + MDB_WBUF;
8927 my.mc_next_pgno = NUM_METAS;
8933 THREAD_CREATE(thr, mdb_env_copythr, &my);
8935 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
8939 mp = (MDB_page *)my.mc_wbuf[0];
8940 memset(mp, 0, NUM_METAS * env->me_psize);
8942 mp->mp_flags = P_META;
8943 mm = (MDB_meta *)METADATA(mp);
8944 mdb_env_init_meta0(env, mm);
8945 mm->mm_address = env->me_metas[0]->mm_address;
8947 mp = (MDB_page *)(my.mc_wbuf[0] + env->me_psize);
8949 mp->mp_flags = P_META;
8950 *(MDB_meta *)METADATA(mp) = *mm;
8951 mm = (MDB_meta *)METADATA(mp);
8953 /* Count the number of free pages, subtract from lastpg to find
8954 * number of active pages
8957 MDB_ID freecount = 0;
8960 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
8961 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
8962 freecount += *(MDB_ID *)data.mv_data;
8963 freecount += txn->mt_dbs[FREE_DBI].md_branch_pages +
8964 txn->mt_dbs[FREE_DBI].md_leaf_pages +
8965 txn->mt_dbs[FREE_DBI].md_overflow_pages;
8967 /* Set metapage 1 */
8968 mm->mm_last_pg = txn->mt_next_pgno - freecount - 1;
8969 mm->mm_dbs[MAIN_DBI] = txn->mt_dbs[MAIN_DBI];
8970 if (mm->mm_last_pg > NUM_METAS-1) {
8971 mm->mm_dbs[MAIN_DBI].md_root = mm->mm_last_pg;
8974 mm->mm_dbs[MAIN_DBI].md_root = P_INVALID;
8977 my.mc_wlen[0] = env->me_psize * NUM_METAS;
8979 pthread_mutex_lock(&my.mc_mutex);
8981 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8982 pthread_mutex_unlock(&my.mc_mutex);
8983 rc = mdb_env_cwalk(&my, &txn->mt_dbs[MAIN_DBI].md_root, 0);
8984 if (rc == MDB_SUCCESS && my.mc_wlen[my.mc_toggle])
8985 rc = mdb_env_cthr_toggle(&my, 1);
8986 mdb_env_cthr_toggle(&my, -1);
8987 pthread_mutex_lock(&my.mc_mutex);
8989 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8990 pthread_mutex_unlock(&my.mc_mutex);
8995 CloseHandle(my.mc_cond);
8996 CloseHandle(my.mc_mutex);
8997 _aligned_free(my.mc_wbuf[0]);
8999 pthread_cond_destroy(&my.mc_cond);
9000 pthread_mutex_destroy(&my.mc_mutex);
9001 free(my.mc_wbuf[0]);
9006 /** Copy environment as-is. */
9008 mdb_env_copyfd0(MDB_env *env, HANDLE fd)
9010 MDB_txn *txn = NULL;
9011 mdb_mutexref_t wmutex = NULL;
9017 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
9021 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
9024 /* Do the lock/unlock of the reader mutex before starting the
9025 * write txn. Otherwise other read txns could block writers.
9027 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
9032 /* We must start the actual read txn after blocking writers */
9033 mdb_txn_end(txn, MDB_END_RESET_TMP);
9035 /* Temporarily block writers until we snapshot the meta pages */
9036 wmutex = env->me_wmutex;
9037 if (LOCK_MUTEX(rc, env, wmutex))
9040 rc = mdb_txn_renew0(txn);
9042 UNLOCK_MUTEX(wmutex);
9047 wsize = env->me_psize * NUM_METAS;
9051 DO_WRITE(rc, fd, ptr, w2, len);
9055 } else if (len > 0) {
9061 /* Non-blocking or async handles are not supported */
9067 UNLOCK_MUTEX(wmutex);
9072 w2 = txn->mt_next_pgno * env->me_psize;
9075 if ((rc = mdb_fsize(env->me_fd, &fsize)))
9082 if (wsize > MAX_WRITE)
9086 DO_WRITE(rc, fd, ptr, w2, len);
9090 } else if (len > 0) {
9107 mdb_env_copyfd2(MDB_env *env, HANDLE fd, unsigned int flags)
9109 if (flags & MDB_CP_COMPACT)
9110 return mdb_env_copyfd1(env, fd);
9112 return mdb_env_copyfd0(env, fd);
9116 mdb_env_copyfd(MDB_env *env, HANDLE fd)
9118 return mdb_env_copyfd2(env, fd, 0);
9122 mdb_env_copy2(MDB_env *env, const char *path, unsigned int flags)
9126 HANDLE newfd = INVALID_HANDLE_VALUE;
9128 if (env->me_flags & MDB_NOSUBDIR) {
9129 lpath = (char *)path;
9132 len += sizeof(DATANAME);
9133 lpath = malloc(len);
9136 sprintf(lpath, "%s" DATANAME, path);
9139 /* The destination path must exist, but the destination file must not.
9140 * We don't want the OS to cache the writes, since the source data is
9141 * already in the OS cache.
9144 newfd = CreateFileA(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
9145 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
9147 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL, 0666);
9149 if (newfd == INVALID_HANDLE_VALUE) {
9154 if (env->me_psize >= env->me_os_psize) {
9156 /* Set O_DIRECT if the file system supports it */
9157 if ((rc = fcntl(newfd, F_GETFL)) != -1)
9158 (void) fcntl(newfd, F_SETFL, rc | O_DIRECT);
9160 #ifdef F_NOCACHE /* __APPLE__ */
9161 rc = fcntl(newfd, F_NOCACHE, 1);
9169 rc = mdb_env_copyfd2(env, newfd, flags);
9172 if (!(env->me_flags & MDB_NOSUBDIR))
9174 if (newfd != INVALID_HANDLE_VALUE)
9175 if (close(newfd) < 0 && rc == MDB_SUCCESS)
9182 mdb_env_copy(MDB_env *env, const char *path)
9184 return mdb_env_copy2(env, path, 0);
9188 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
9190 if (flag & ~CHANGEABLE)
9193 env->me_flags |= flag;
9195 env->me_flags &= ~flag;
9200 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
9205 *arg = env->me_flags & (CHANGEABLE|CHANGELESS);
9210 mdb_env_set_userctx(MDB_env *env, void *ctx)
9214 env->me_userctx = ctx;
9219 mdb_env_get_userctx(MDB_env *env)
9221 return env ? env->me_userctx : NULL;
9225 mdb_env_set_assert(MDB_env *env, MDB_assert_func *func)
9230 env->me_assert_func = func;
9236 mdb_env_get_path(MDB_env *env, const char **arg)
9241 *arg = env->me_path;
9246 mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *arg)
9255 /** Common code for #mdb_stat() and #mdb_env_stat().
9256 * @param[in] env the environment to operate in.
9257 * @param[in] db the #MDB_db record containing the stats to return.
9258 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
9259 * @return 0, this function always succeeds.
9262 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
9264 arg->ms_psize = env->me_psize;
9265 arg->ms_depth = db->md_depth;
9266 arg->ms_branch_pages = db->md_branch_pages;
9267 arg->ms_leaf_pages = db->md_leaf_pages;
9268 arg->ms_overflow_pages = db->md_overflow_pages;
9269 arg->ms_entries = db->md_entries;
9275 mdb_env_stat(MDB_env *env, MDB_stat *arg)
9279 if (env == NULL || arg == NULL)
9282 meta = mdb_env_pick_meta(env);
9284 return mdb_stat0(env, &meta->mm_dbs[MAIN_DBI], arg);
9288 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
9292 if (env == NULL || arg == NULL)
9295 meta = mdb_env_pick_meta(env);
9296 arg->me_mapaddr = meta->mm_address;
9297 arg->me_last_pgno = meta->mm_last_pg;
9298 arg->me_last_txnid = meta->mm_txnid;
9300 arg->me_mapsize = env->me_mapsize;
9301 arg->me_maxreaders = env->me_maxreaders;
9302 arg->me_numreaders = env->me_txns ? env->me_txns->mti_numreaders : 0;
9306 /** Set the default comparison functions for a database.
9307 * Called immediately after a database is opened to set the defaults.
9308 * The user can then override them with #mdb_set_compare() or
9309 * #mdb_set_dupsort().
9310 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
9311 * @param[in] dbi A database handle returned by #mdb_dbi_open()
9314 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
9316 uint16_t f = txn->mt_dbs[dbi].md_flags;
9318 txn->mt_dbxs[dbi].md_cmp =
9319 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
9320 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
9322 txn->mt_dbxs[dbi].md_dcmp =
9323 !(f & MDB_DUPSORT) ? 0 :
9324 ((f & MDB_INTEGERDUP)
9325 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
9326 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
9329 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
9335 int rc, dbflag, exact;
9336 unsigned int unused = 0, seq;
9339 if (flags & ~VALID_FLAGS)
9341 if (txn->mt_flags & MDB_TXN_BLOCKED)
9347 if (flags & PERSISTENT_FLAGS) {
9348 uint16_t f2 = flags & PERSISTENT_FLAGS;
9349 /* make sure flag changes get committed */
9350 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
9351 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
9352 txn->mt_flags |= MDB_TXN_DIRTY;
9355 mdb_default_cmp(txn, MAIN_DBI);
9359 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
9360 mdb_default_cmp(txn, MAIN_DBI);
9363 /* Is the DB already open? */
9365 for (i=CORE_DBS; i<txn->mt_numdbs; i++) {
9366 if (!txn->mt_dbxs[i].md_name.mv_size) {
9367 /* Remember this free slot */
9368 if (!unused) unused = i;
9371 if (len == txn->mt_dbxs[i].md_name.mv_size &&
9372 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
9378 /* If no free slot and max hit, fail */
9379 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
9380 return MDB_DBS_FULL;
9382 /* Cannot mix named databases with some mainDB flags */
9383 if (txn->mt_dbs[MAIN_DBI].md_flags & (MDB_DUPSORT|MDB_INTEGERKEY))
9384 return (flags & MDB_CREATE) ? MDB_INCOMPATIBLE : MDB_NOTFOUND;
9386 /* Find the DB info */
9387 dbflag = DB_NEW|DB_VALID|DB_USRVALID;
9390 key.mv_data = (void *)name;
9391 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
9392 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
9393 if (rc == MDB_SUCCESS) {
9394 /* make sure this is actually a DB */
9395 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
9396 if ((node->mn_flags & (F_DUPDATA|F_SUBDATA)) != F_SUBDATA)
9397 return MDB_INCOMPATIBLE;
9398 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
9399 /* Create if requested */
9400 data.mv_size = sizeof(MDB_db);
9401 data.mv_data = &dummy;
9402 memset(&dummy, 0, sizeof(dummy));
9403 dummy.md_root = P_INVALID;
9404 dummy.md_flags = flags & PERSISTENT_FLAGS;
9405 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
9409 /* OK, got info, add to table */
9410 if (rc == MDB_SUCCESS) {
9411 unsigned int slot = unused ? unused : txn->mt_numdbs;
9412 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
9413 txn->mt_dbxs[slot].md_name.mv_size = len;
9414 txn->mt_dbxs[slot].md_rel = NULL;
9415 txn->mt_dbflags[slot] = dbflag;
9416 /* txn-> and env-> are the same in read txns, use
9417 * tmp variable to avoid undefined assignment
9419 seq = ++txn->mt_env->me_dbiseqs[slot];
9420 txn->mt_dbiseqs[slot] = seq;
9422 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
9424 mdb_default_cmp(txn, slot);
9434 mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
9436 if (!arg || !TXN_DBI_EXIST(txn, dbi, DB_VALID))
9439 if (txn->mt_flags & MDB_TXN_BLOCKED)
9442 if (txn->mt_dbflags[dbi] & DB_STALE) {
9445 /* Stale, must read the DB's root. cursor_init does it for us. */
9446 mdb_cursor_init(&mc, txn, dbi, &mx);
9448 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
9451 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
9454 if (dbi < CORE_DBS || dbi >= env->me_maxdbs)
9456 ptr = env->me_dbxs[dbi].md_name.mv_data;
9457 /* If there was no name, this was already closed */
9459 env->me_dbxs[dbi].md_name.mv_data = NULL;
9460 env->me_dbxs[dbi].md_name.mv_size = 0;
9461 env->me_dbflags[dbi] = 0;
9462 env->me_dbiseqs[dbi]++;
9467 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags)
9469 /* We could return the flags for the FREE_DBI too but what's the point? */
9470 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9472 *flags = txn->mt_dbs[dbi].md_flags & PERSISTENT_FLAGS;
9476 /** Add all the DB's pages to the free list.
9477 * @param[in] mc Cursor on the DB to free.
9478 * @param[in] subs non-Zero to check for sub-DBs in this DB.
9479 * @return 0 on success, non-zero on failure.
9482 mdb_drop0(MDB_cursor *mc, int subs)
9486 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
9487 if (rc == MDB_SUCCESS) {
9488 MDB_txn *txn = mc->mc_txn;
9493 /* DUPSORT sub-DBs have no ovpages/DBs. Omit scanning leaves.
9494 * This also avoids any P_LEAF2 pages, which have no nodes.
9496 if (mc->mc_flags & C_SUB)
9499 mdb_cursor_copy(mc, &mx);
9500 while (mc->mc_snum > 0) {
9501 MDB_page *mp = mc->mc_pg[mc->mc_top];
9502 unsigned n = NUMKEYS(mp);
9504 for (i=0; i<n; i++) {
9505 ni = NODEPTR(mp, i);
9506 if (ni->mn_flags & F_BIGDATA) {
9509 memcpy(&pg, NODEDATA(ni), sizeof(pg));
9510 rc = mdb_page_get(txn, pg, &omp, NULL);
9513 mdb_cassert(mc, IS_OVERFLOW(omp));
9514 rc = mdb_midl_append_range(&txn->mt_free_pgs,
9518 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
9519 mdb_xcursor_init1(mc, ni);
9520 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
9526 if ((rc = mdb_midl_need(&txn->mt_free_pgs, n)) != 0)
9528 for (i=0; i<n; i++) {
9530 ni = NODEPTR(mp, i);
9533 mdb_midl_xappend(txn->mt_free_pgs, pg);
9538 mc->mc_ki[mc->mc_top] = i;
9539 rc = mdb_cursor_sibling(mc, 1);
9541 if (rc != MDB_NOTFOUND)
9543 /* no more siblings, go back to beginning
9544 * of previous level.
9548 for (i=1; i<mc->mc_snum; i++) {
9550 mc->mc_pg[i] = mx.mc_pg[i];
9555 rc = mdb_midl_append(&txn->mt_free_pgs, mc->mc_db->md_root);
9558 txn->mt_flags |= MDB_TXN_ERROR;
9559 } else if (rc == MDB_NOTFOUND) {
9565 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
9567 MDB_cursor *mc, *m2;
9570 if ((unsigned)del > 1 || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9573 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
9576 if (TXN_DBI_CHANGED(txn, dbi))
9579 rc = mdb_cursor_open(txn, dbi, &mc);
9583 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
9584 /* Invalidate the dropped DB's cursors */
9585 for (m2 = txn->mt_cursors[dbi]; m2; m2 = m2->mc_next)
9586 m2->mc_flags &= ~(C_INITIALIZED|C_EOF);
9590 /* Can't delete the main DB */
9591 if (del && dbi >= CORE_DBS) {
9592 rc = mdb_del0(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL, F_SUBDATA);
9594 txn->mt_dbflags[dbi] = DB_STALE;
9595 mdb_dbi_close(txn->mt_env, dbi);
9597 txn->mt_flags |= MDB_TXN_ERROR;
9600 /* reset the DB record, mark it dirty */
9601 txn->mt_dbflags[dbi] |= DB_DIRTY;
9602 txn->mt_dbs[dbi].md_depth = 0;
9603 txn->mt_dbs[dbi].md_branch_pages = 0;
9604 txn->mt_dbs[dbi].md_leaf_pages = 0;
9605 txn->mt_dbs[dbi].md_overflow_pages = 0;
9606 txn->mt_dbs[dbi].md_entries = 0;
9607 txn->mt_dbs[dbi].md_root = P_INVALID;
9609 txn->mt_flags |= MDB_TXN_DIRTY;
9612 mdb_cursor_close(mc);
9616 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9618 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9621 txn->mt_dbxs[dbi].md_cmp = cmp;
9625 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9627 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9630 txn->mt_dbxs[dbi].md_dcmp = cmp;
9634 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
9636 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9639 txn->mt_dbxs[dbi].md_rel = rel;
9643 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
9645 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9648 txn->mt_dbxs[dbi].md_relctx = ctx;
9653 mdb_env_get_maxkeysize(MDB_env *env)
9655 return ENV_MAXKEY(env);
9659 mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx)
9661 unsigned int i, rdrs;
9664 int rc = 0, first = 1;
9668 if (!env->me_txns) {
9669 return func("(no reader locks)\n", ctx);
9671 rdrs = env->me_txns->mti_numreaders;
9672 mr = env->me_txns->mti_readers;
9673 for (i=0; i<rdrs; i++) {
9675 txnid_t txnid = mr[i].mr_txnid;
9676 sprintf(buf, txnid == (txnid_t)-1 ?
9677 "%10d %"Z"x -\n" : "%10d %"Z"x %"Z"u\n",
9678 (int)mr[i].mr_pid, (size_t)mr[i].mr_tid, txnid);
9681 rc = func(" pid thread txnid\n", ctx);
9685 rc = func(buf, ctx);
9691 rc = func("(no active readers)\n", ctx);
9696 /** Insert pid into list if not already present.
9697 * return -1 if already present.
9700 mdb_pid_insert(MDB_PID_T *ids, MDB_PID_T pid)
9702 /* binary search of pid in list */
9704 unsigned cursor = 1;
9706 unsigned n = ids[0];
9709 unsigned pivot = n >> 1;
9710 cursor = base + pivot + 1;
9711 val = pid - ids[cursor];
9716 } else if ( val > 0 ) {
9721 /* found, so it's a duplicate */
9730 for (n = ids[0]; n > cursor; n--)
9737 mdb_reader_check(MDB_env *env, int *dead)
9743 return env->me_txns ? mdb_reader_check0(env, 0, dead) : MDB_SUCCESS;
9746 /** As #mdb_reader_check(). rlocked = <caller locked the reader mutex>. */
9748 mdb_reader_check0(MDB_env *env, int rlocked, int *dead)
9750 mdb_mutexref_t rmutex = rlocked ? NULL : env->me_rmutex;
9751 unsigned int i, j, rdrs;
9753 MDB_PID_T *pids, pid;
9754 int rc = MDB_SUCCESS, count = 0;
9756 rdrs = env->me_txns->mti_numreaders;
9757 pids = malloc((rdrs+1) * sizeof(MDB_PID_T));
9761 mr = env->me_txns->mti_readers;
9762 for (i=0; i<rdrs; i++) {
9764 if (pid && pid != env->me_pid) {
9765 if (mdb_pid_insert(pids, pid) == 0) {
9766 if (!mdb_reader_pid(env, Pidcheck, pid)) {
9767 /* Stale reader found */
9770 if ((rc = LOCK_MUTEX0(rmutex)) != 0) {
9771 if ((rc = mdb_mutex_failed(env, rmutex, rc)))
9773 rdrs = 0; /* the above checked all readers */
9775 /* Recheck, a new process may have reused pid */
9776 if (mdb_reader_pid(env, Pidcheck, pid))
9781 if (mr[j].mr_pid == pid) {
9782 DPRINTF(("clear stale reader pid %u txn %"Z"d",
9783 (unsigned) pid, mr[j].mr_txnid));
9788 UNLOCK_MUTEX(rmutex);
9799 #ifdef MDB_ROBUST_SUPPORTED
9800 /** Handle #LOCK_MUTEX0() failure.
9801 * Try to repair the lock file if the mutex owner died.
9802 * @param[in] env the environment handle
9803 * @param[in] mutex LOCK_MUTEX0() mutex
9804 * @param[in] rc LOCK_MUTEX0() error (nonzero)
9805 * @return 0 on success with the mutex locked, or an error code on failure.
9808 mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc)
9813 if (rc == MDB_OWNERDEAD) {
9814 /* We own the mutex. Clean up after dead previous owner. */
9816 rlocked = (mutex == env->me_rmutex);
9818 /* Keep mti_txnid updated, otherwise next writer can
9819 * overwrite data which latest meta page refers to.
9821 meta = mdb_env_pick_meta(env);
9822 env->me_txns->mti_txnid = meta->mm_txnid;
9823 /* env is hosed if the dead thread was ours */
9825 env->me_flags |= MDB_FATAL_ERROR;
9830 DPRINTF(("%cmutex owner died, %s", (rlocked ? 'r' : 'w'),
9831 (rc ? "this process' env is hosed" : "recovering")));
9832 rc2 = mdb_reader_check0(env, rlocked, NULL);
9834 rc2 = mdb_mutex_consistent(mutex);
9835 if (rc || (rc = rc2)) {
9836 DPRINTF(("LOCK_MUTEX recovery failed, %s", mdb_strerror(rc)));
9837 UNLOCK_MUTEX(mutex);
9843 DPRINTF(("LOCK_MUTEX failed, %s", mdb_strerror(rc)));
9848 #endif /* MDB_ROBUST_SUPPORTED */
projects / openldap / blob