2 * @brief Lightning memory-mapped database library
4 * A Btree-based database management library modeled loosely on the
5 * BerkeleyDB API, but much simplified.
8 * Copyright 2011-2015 Howard Chu, Symas Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted only as authorized by the OpenLDAP
15 * A copy of this license is available in the file LICENSE in the
16 * top-level directory of the distribution or, alternatively, at
17 * <http://www.OpenLDAP.org/license.html>.
19 * This code is derived from btree.c written by Martin Hedenfalk.
21 * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
23 * Permission to use, copy, modify, and distribute this software for any
24 * purpose with or without fee is hereby granted, provided that the above
25 * copyright notice and this permission notice appear in all copies.
27 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
28 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
29 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
30 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
31 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
32 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
33 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
41 /** getpid() returns int; MinGW defines pid_t but MinGW64 typedefs it
42 * as int64 which is wrong. MSVC doesn't define it at all, so just
46 #define MDB_THR_T DWORD
47 #include <sys/types.h>
50 # include <sys/param.h>
52 # define LITTLE_ENDIAN 1234
53 # define BIG_ENDIAN 4321
54 # define BYTE_ORDER LITTLE_ENDIAN
56 # define SSIZE_MAX INT_MAX
60 #include <sys/types.h>
62 #define MDB_PID_T pid_t
63 #define MDB_THR_T pthread_t
64 #include <sys/param.h>
67 #ifdef HAVE_SYS_FILE_H
73 #if defined(__mips) && defined(__linux)
74 /* MIPS has cache coherency issues, requires explicit cache control */
75 #include <asm/cachectl.h>
76 extern int cacheflush(char *addr, int nbytes, int cache);
77 #define CACHEFLUSH(addr, bytes, cache) cacheflush(addr, bytes, cache)
79 #define CACHEFLUSH(addr, bytes, cache)
82 #if defined(__linux) && !defined(MDB_FDATASYNC_WORKS)
83 /** fdatasync is broken on ext3/ext4fs on older kernels, see
84 * description in #mdb_env_open2 comments. You can safely
85 * define MDB_FDATASYNC_WORKS if this code will only be run
86 * on kernels 3.6 and newer.
88 #define BROKEN_FDATASYNC
101 #if defined(__sun) || defined(ANDROID)
102 /* Most platforms have posix_memalign, older may only have memalign */
103 #define HAVE_MEMALIGN 1
107 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
108 #include <netinet/in.h>
109 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
112 #if defined(__APPLE__) || defined (BSD)
113 # define MDB_USE_POSIX_SEM 1
114 # define MDB_FDATASYNC fsync
115 #elif defined(ANDROID)
116 # define MDB_FDATASYNC fsync
121 #ifdef MDB_USE_POSIX_SEM
122 # define MDB_USE_HASH 1
123 #include <semaphore.h>
125 #define MDB_USE_POSIX_MUTEX 1
129 #if defined(_WIN32) + defined(MDB_USE_POSIX_SEM) \
130 + defined(MDB_USE_POSIX_MUTEX) != 1
131 # error "Ambiguous shared-lock implementation"
135 #include <valgrind/memcheck.h>
136 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
137 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
138 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
139 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
140 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
142 #define VGMEMP_CREATE(h,r,z)
143 #define VGMEMP_ALLOC(h,a,s)
144 #define VGMEMP_FREE(h,a)
145 #define VGMEMP_DESTROY(h)
146 #define VGMEMP_DEFINED(a,s)
150 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
151 /* Solaris just defines one or the other */
152 # define LITTLE_ENDIAN 1234
153 # define BIG_ENDIAN 4321
154 # ifdef _LITTLE_ENDIAN
155 # define BYTE_ORDER LITTLE_ENDIAN
157 # define BYTE_ORDER BIG_ENDIAN
160 # define BYTE_ORDER __BYTE_ORDER
164 #ifndef LITTLE_ENDIAN
165 #define LITTLE_ENDIAN __LITTLE_ENDIAN
168 #define BIG_ENDIAN __BIG_ENDIAN
171 #if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
172 #define MISALIGNED_OK 1
178 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
179 # error "Unknown or unsupported endianness (BYTE_ORDER)"
180 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
181 # error "Two's complement, reasonably sized integer types, please"
185 /** Put infrequently used env functions in separate section */
187 # define ESECT __attribute__ ((section("__TEXT,text_env")))
189 # define ESECT __attribute__ ((section("text_env")))
196 #define CALL_CONV WINAPI
201 /** @defgroup internal LMDB Internals
204 /** @defgroup compat Compatibility Macros
205 * A bunch of macros to minimize the amount of platform-specific ifdefs
206 * needed throughout the rest of the code. When the features this library
207 * needs are similar enough to POSIX to be hidden in a one-or-two line
208 * replacement, this macro approach is used.
212 /** Features under development */
217 /** Wrapper around __func__, which is a C99 feature */
218 #if __STDC_VERSION__ >= 199901L
219 # define mdb_func_ __func__
220 #elif __GNUC__ >= 2 || _MSC_VER >= 1300
221 # define mdb_func_ __FUNCTION__
223 /* If a debug message says <mdb_unknown>(), update the #if statements above */
224 # define mdb_func_ "<mdb_unknown>"
227 /* Internal error codes, not exposed outside liblmdb */
228 #define MDB_NO_ROOT (MDB_LAST_ERRCODE + 10)
230 #define MDB_OWNERDEAD ((int) WAIT_ABANDONED)
231 #elif defined(MDB_USE_POSIX_MUTEX) && defined(EOWNERDEAD)
232 #define MDB_OWNERDEAD EOWNERDEAD /**< #LOCK_MUTEX0() result if dead owner */
236 #define MDB_ROBUST_SUPPORTED 1
240 #define MDB_USE_HASH 1
241 #define MDB_PIDLOCK 0
242 #define THREAD_RET DWORD
243 #define pthread_t HANDLE
244 #define pthread_mutex_t HANDLE
245 #define pthread_cond_t HANDLE
246 typedef HANDLE mdb_mutex_t, mdb_mutexref_t;
247 #define pthread_key_t DWORD
248 #define pthread_self() GetCurrentThreadId()
249 #define pthread_key_create(x,y) \
250 ((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
251 #define pthread_key_delete(x) TlsFree(x)
252 #define pthread_getspecific(x) TlsGetValue(x)
253 #define pthread_setspecific(x,y) (TlsSetValue(x,y) ? 0 : ErrCode())
254 #define pthread_mutex_unlock(x) ReleaseMutex(*x)
255 #define pthread_mutex_lock(x) WaitForSingleObject(*x, INFINITE)
256 #define pthread_cond_signal(x) SetEvent(*x)
257 #define pthread_cond_wait(cond,mutex) do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
258 #define THREAD_CREATE(thr,start,arg) thr=CreateThread(NULL,0,start,arg,0,NULL)
259 #define THREAD_FINISH(thr) WaitForSingleObject(thr, INFINITE)
260 #define LOCK_MUTEX0(mutex) WaitForSingleObject(mutex, INFINITE)
261 #define UNLOCK_MUTEX(mutex) ReleaseMutex(mutex)
262 #define mdb_mutex_consistent(mutex) 0
263 #define getpid() GetCurrentProcessId()
264 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
265 #define MDB_MSYNC(addr,len,flags) (!FlushViewOfFile(addr,len))
266 #define ErrCode() GetLastError()
267 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
268 #define close(fd) (CloseHandle(fd) ? 0 : -1)
269 #define munmap(ptr,len) UnmapViewOfFile(ptr)
270 #ifdef PROCESS_QUERY_LIMITED_INFORMATION
271 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
273 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
277 #define THREAD_RET void *
278 #define THREAD_CREATE(thr,start,arg) pthread_create(&thr,NULL,start,arg)
279 #define THREAD_FINISH(thr) pthread_join(thr,NULL)
280 #define Z "z" /**< printf format modifier for size_t */
282 /** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
283 #define MDB_PIDLOCK 1
285 #ifdef MDB_USE_POSIX_SEM
287 typedef sem_t *mdb_mutex_t, *mdb_mutexref_t;
288 #define LOCK_MUTEX0(mutex) mdb_sem_wait(mutex)
289 #define UNLOCK_MUTEX(mutex) sem_post(mutex)
292 mdb_sem_wait(sem_t *sem)
295 while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
299 #else /* MDB_USE_POSIX_MUTEX: */
300 /** Shared mutex/semaphore as it is stored (mdb_mutex_t), and as
301 * local variables keep it (mdb_mutexref_t).
303 * When #mdb_mutexref_t is a pointer declaration and #mdb_mutex_t is
304 * not, then it is array[size 1] so it can be assigned to a pointer.
307 typedef pthread_mutex_t mdb_mutex_t[1], *mdb_mutexref_t;
309 /** Lock the reader or writer mutex.
310 * Returns 0 or a code to give #mdb_mutex_failed(), as in #LOCK_MUTEX().
312 #define LOCK_MUTEX0(mutex) pthread_mutex_lock(mutex)
313 /** Unlock the reader or writer mutex.
315 #define UNLOCK_MUTEX(mutex) pthread_mutex_unlock(mutex)
316 /** Mark mutex-protected data as repaired, after death of previous owner.
318 #define mdb_mutex_consistent(mutex) pthread_mutex_consistent(mutex)
319 #endif /* MDB_USE_POSIX_SEM */
321 /** Get the error code for the last failed system function.
323 #define ErrCode() errno
325 /** An abstraction for a file handle.
326 * On POSIX systems file handles are small integers. On Windows
327 * they're opaque pointers.
331 /** A value for an invalid file handle.
332 * Mainly used to initialize file variables and signify that they are
335 #define INVALID_HANDLE_VALUE (-1)
337 /** Get the size of a memory page for the system.
338 * This is the basic size that the platform's memory manager uses, and is
339 * fundamental to the use of memory-mapped files.
341 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
344 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
347 #define MNAME_LEN (sizeof(pthread_mutex_t))
352 #ifdef MDB_ROBUST_SUPPORTED
353 /** Lock mutex, handle any error, set rc = result.
354 * Return 0 on success, nonzero (not rc) on error.
356 #define LOCK_MUTEX(rc, env, mutex) \
357 (((rc) = LOCK_MUTEX0(mutex)) && \
358 ((rc) = mdb_mutex_failed(env, mutex, rc)))
359 static int mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc);
361 #define LOCK_MUTEX(rc, env, mutex) ((rc) = LOCK_MUTEX0(mutex))
362 #define mdb_mutex_failed(env, mutex, rc) (rc)
366 /** A flag for opening a file and requesting synchronous data writes.
367 * This is only used when writing a meta page. It's not strictly needed;
368 * we could just do a normal write and then immediately perform a flush.
369 * But if this flag is available it saves us an extra system call.
371 * @note If O_DSYNC is undefined but exists in /usr/include,
372 * preferably set some compiler flag to get the definition.
373 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
376 # define MDB_DSYNC O_DSYNC
380 /** Function for flushing the data of a file. Define this to fsync
381 * if fdatasync() is not supported.
383 #ifndef MDB_FDATASYNC
384 # define MDB_FDATASYNC fdatasync
388 # define MDB_MSYNC(addr,len,flags) msync(addr,len,flags)
399 /** A page number in the database.
400 * Note that 64 bit page numbers are overkill, since pages themselves
401 * already represent 12-13 bits of addressable memory, and the OS will
402 * always limit applications to a maximum of 63 bits of address space.
404 * @note In the #MDB_node structure, we only store 48 bits of this value,
405 * which thus limits us to only 60 bits of addressable data.
407 typedef MDB_ID pgno_t;
409 /** A transaction ID.
410 * See struct MDB_txn.mt_txnid for details.
412 typedef MDB_ID txnid_t;
414 /** @defgroup debug Debug Macros
418 /** Enable debug output. Needs variable argument macros (a C99 feature).
419 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
420 * read from and written to the database (used for free space management).
426 static int mdb_debug;
427 static txnid_t mdb_debug_start;
429 /** Print a debug message with printf formatting.
430 * Requires double parenthesis around 2 or more args.
432 # define DPRINTF(args) ((void) ((mdb_debug) && DPRINTF0 args))
433 # define DPRINTF0(fmt, ...) \
434 fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
436 # define DPRINTF(args) ((void) 0)
438 /** Print a debug string.
439 * The string is printed literally, with no format processing.
441 #define DPUTS(arg) DPRINTF(("%s", arg))
442 /** Debuging output value of a cursor DBI: Negative in a sub-cursor. */
444 (((mc)->mc_flags & C_SUB) ? -(int)(mc)->mc_dbi : (int)(mc)->mc_dbi)
447 /** @brief The maximum size of a database page.
449 * It is 32k or 64k, since value-PAGEBASE must fit in
450 * #MDB_page.%mp_upper.
452 * LMDB will use database pages < OS pages if needed.
453 * That causes more I/O in write transactions: The OS must
454 * know (read) the whole page before writing a partial page.
456 * Note that we don't currently support Huge pages. On Linux,
457 * regular data files cannot use Huge pages, and in general
458 * Huge pages aren't actually pageable. We rely on the OS
459 * demand-pager to read our data and page it out when memory
460 * pressure from other processes is high. So until OSs have
461 * actual paging support for Huge pages, they're not viable.
463 #define MAX_PAGESIZE (PAGEBASE ? 0x10000 : 0x8000)
465 /** The minimum number of keys required in a database page.
466 * Setting this to a larger value will place a smaller bound on the
467 * maximum size of a data item. Data items larger than this size will
468 * be pushed into overflow pages instead of being stored directly in
469 * the B-tree node. This value used to default to 4. With a page size
470 * of 4096 bytes that meant that any item larger than 1024 bytes would
471 * go into an overflow page. That also meant that on average 2-3KB of
472 * each overflow page was wasted space. The value cannot be lower than
473 * 2 because then there would no longer be a tree structure. With this
474 * value, items larger than 2KB will go into overflow pages, and on
475 * average only 1KB will be wasted.
477 #define MDB_MINKEYS 2
479 /** A stamp that identifies a file as an LMDB file.
480 * There's nothing special about this value other than that it is easily
481 * recognizable, and it will reflect any byte order mismatches.
483 #define MDB_MAGIC 0xBEEFC0DE
485 /** The version number for a database's datafile format. */
486 #define MDB_DATA_VERSION ((MDB_DEVEL) ? 999 : 1)
487 /** The version number for a database's lockfile format. */
488 #define MDB_LOCK_VERSION 1
490 /** @brief The max size of a key we can write, or 0 for computed max.
492 * This macro should normally be left alone or set to 0.
493 * Note that a database with big keys or dupsort data cannot be
494 * reliably modified by a liblmdb which uses a smaller max.
495 * The default is 511 for backwards compat, or 0 when #MDB_DEVEL.
497 * Other values are allowed, for backwards compat. However:
498 * A value bigger than the computed max can break if you do not
499 * know what you are doing, and liblmdb <= 0.9.10 can break when
500 * modifying a DB with keys/dupsort data bigger than its max.
502 * Data items in an #MDB_DUPSORT database are also limited to
503 * this size, since they're actually keys of a sub-DB. Keys and
504 * #MDB_DUPSORT data items must fit on a node in a regular page.
506 #ifndef MDB_MAXKEYSIZE
507 #define MDB_MAXKEYSIZE ((MDB_DEVEL) ? 0 : 511)
510 /** The maximum size of a key we can write to the environment. */
512 #define ENV_MAXKEY(env) (MDB_MAXKEYSIZE)
514 #define ENV_MAXKEY(env) ((env)->me_maxkey)
517 /** @brief The maximum size of a data item.
519 * We only store a 32 bit value for node sizes.
521 #define MAXDATASIZE 0xffffffffUL
524 /** Key size which fits in a #DKBUF.
527 #define DKBUF_MAXKEYSIZE ((MDB_MAXKEYSIZE) > 0 ? (MDB_MAXKEYSIZE) : 511)
530 * This is used for printing a hex dump of a key's contents.
532 #define DKBUF char kbuf[DKBUF_MAXKEYSIZE*2+1]
533 /** Display a key in hex.
535 * Invoke a function to display a key in hex.
537 #define DKEY(x) mdb_dkey(x, kbuf)
543 /** An invalid page number.
544 * Mainly used to denote an empty tree.
546 #define P_INVALID (~(pgno_t)0)
548 /** Test if the flags \b f are set in a flag word \b w. */
549 #define F_ISSET(w, f) (((w) & (f)) == (f))
551 /** Round \b n up to an even number. */
552 #define EVEN(n) (((n) + 1U) & -2) /* sign-extending -2 to match n+1U */
554 /** Used for offsets within a single page.
555 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
558 typedef uint16_t indx_t;
560 /** Default size of memory map.
561 * This is certainly too small for any actual applications. Apps should always set
562 * the size explicitly using #mdb_env_set_mapsize().
564 #define DEFAULT_MAPSIZE 1048576
566 /** @defgroup readers Reader Lock Table
567 * Readers don't acquire any locks for their data access. Instead, they
568 * simply record their transaction ID in the reader table. The reader
569 * mutex is needed just to find an empty slot in the reader table. The
570 * slot's address is saved in thread-specific data so that subsequent read
571 * transactions started by the same thread need no further locking to proceed.
573 * If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
575 * No reader table is used if the database is on a read-only filesystem, or
576 * if #MDB_NOLOCK is set.
578 * Since the database uses multi-version concurrency control, readers don't
579 * actually need any locking. This table is used to keep track of which
580 * readers are using data from which old transactions, so that we'll know
581 * when a particular old transaction is no longer in use. Old transactions
582 * that have discarded any data pages can then have those pages reclaimed
583 * for use by a later write transaction.
585 * The lock table is constructed such that reader slots are aligned with the
586 * processor's cache line size. Any slot is only ever used by one thread.
587 * This alignment guarantees that there will be no contention or cache
588 * thrashing as threads update their own slot info, and also eliminates
589 * any need for locking when accessing a slot.
591 * A writer thread will scan every slot in the table to determine the oldest
592 * outstanding reader transaction. Any freed pages older than this will be
593 * reclaimed by the writer. The writer doesn't use any locks when scanning
594 * this table. This means that there's no guarantee that the writer will
595 * see the most up-to-date reader info, but that's not required for correct
596 * operation - all we need is to know the upper bound on the oldest reader,
597 * we don't care at all about the newest reader. So the only consequence of
598 * reading stale information here is that old pages might hang around a
599 * while longer before being reclaimed. That's actually good anyway, because
600 * the longer we delay reclaiming old pages, the more likely it is that a
601 * string of contiguous pages can be found after coalescing old pages from
602 * many old transactions together.
605 /** Number of slots in the reader table.
606 * This value was chosen somewhat arbitrarily. 126 readers plus a
607 * couple mutexes fit exactly into 8KB on my development machine.
608 * Applications should set the table size using #mdb_env_set_maxreaders().
610 #define DEFAULT_READERS 126
612 /** The size of a CPU cache line in bytes. We want our lock structures
613 * aligned to this size to avoid false cache line sharing in the
615 * This value works for most CPUs. For Itanium this should be 128.
621 /** The information we store in a single slot of the reader table.
622 * In addition to a transaction ID, we also record the process and
623 * thread ID that owns a slot, so that we can detect stale information,
624 * e.g. threads or processes that went away without cleaning up.
625 * @note We currently don't check for stale records. We simply re-init
626 * the table when we know that we're the only process opening the
629 typedef struct MDB_rxbody {
630 /** Current Transaction ID when this transaction began, or (txnid_t)-1.
631 * Multiple readers that start at the same time will probably have the
632 * same ID here. Again, it's not important to exclude them from
633 * anything; all we need to know is which version of the DB they
634 * started from so we can avoid overwriting any data used in that
635 * particular version.
637 volatile txnid_t mrb_txnid;
638 /** The process ID of the process owning this reader txn. */
639 volatile MDB_PID_T mrb_pid;
640 /** The thread ID of the thread owning this txn. */
641 volatile MDB_THR_T mrb_tid;
644 /** The actual reader record, with cacheline padding. */
645 typedef struct MDB_reader {
648 /** shorthand for mrb_txnid */
649 #define mr_txnid mru.mrx.mrb_txnid
650 #define mr_pid mru.mrx.mrb_pid
651 #define mr_tid mru.mrx.mrb_tid
652 /** cache line alignment */
653 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
657 /** The header for the reader table.
658 * The table resides in a memory-mapped file. (This is a different file
659 * than is used for the main database.)
661 * For POSIX the actual mutexes reside in the shared memory of this
662 * mapped file. On Windows, mutexes are named objects allocated by the
663 * kernel; we store the mutex names in this mapped file so that other
664 * processes can grab them. This same approach is also used on
665 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
666 * process-shared POSIX mutexes. For these cases where a named object
667 * is used, the object name is derived from a 64 bit FNV hash of the
668 * environment pathname. As such, naming collisions are extremely
669 * unlikely. If a collision occurs, the results are unpredictable.
671 typedef struct MDB_txbody {
672 /** Stamp identifying this as an LMDB file. It must be set
675 /** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
677 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
678 char mtb_rmname[MNAME_LEN];
680 /** Mutex protecting access to this table.
681 * This is the reader table lock used with LOCK_MUTEX().
683 mdb_mutex_t mtb_rmutex;
685 /** The ID of the last transaction committed to the database.
686 * This is recorded here only for convenience; the value can always
687 * be determined by reading the main database meta pages.
689 volatile txnid_t mtb_txnid;
690 /** The number of slots that have been used in the reader table.
691 * This always records the maximum count, it is not decremented
692 * when readers release their slots.
694 volatile unsigned mtb_numreaders;
697 /** The actual reader table definition. */
698 typedef struct MDB_txninfo {
701 #define mti_magic mt1.mtb.mtb_magic
702 #define mti_format mt1.mtb.mtb_format
703 #define mti_rmutex mt1.mtb.mtb_rmutex
704 #define mti_rmname mt1.mtb.mtb_rmname
705 #define mti_txnid mt1.mtb.mtb_txnid
706 #define mti_numreaders mt1.mtb.mtb_numreaders
707 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
710 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
711 char mt2_wmname[MNAME_LEN];
712 #define mti_wmname mt2.mt2_wmname
714 mdb_mutex_t mt2_wmutex;
715 #define mti_wmutex mt2.mt2_wmutex
717 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
719 MDB_reader mti_readers[1];
722 /** Lockfile format signature: version, features and field layout */
723 #define MDB_LOCK_FORMAT \
725 ((MDB_LOCK_VERSION) \
726 /* Flags which describe functionality */ \
727 + (((MDB_PIDLOCK) != 0) << 16)))
730 /** Common header for all page types.
731 * Overflow records occupy a number of contiguous pages with no
732 * headers on any page after the first.
734 typedef struct MDB_page {
735 #define mp_pgno mp_p.p_pgno
736 #define mp_next mp_p.p_next
738 pgno_t p_pgno; /**< page number */
739 struct MDB_page *p_next; /**< for in-memory list of freed pages */
742 /** @defgroup mdb_page Page Flags
744 * Flags for the page headers.
747 #define P_BRANCH 0x01 /**< branch page */
748 #define P_LEAF 0x02 /**< leaf page */
749 #define P_OVERFLOW 0x04 /**< overflow page */
750 #define P_META 0x08 /**< meta page */
751 #define P_DIRTY 0x10 /**< dirty page, also set for #P_SUBP pages */
752 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
753 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
754 #define P_LOOSE 0x4000 /**< page was dirtied then freed, can be reused */
755 #define P_KEEP 0x8000 /**< leave this page alone during spill */
757 uint16_t mp_flags; /**< @ref mdb_page */
758 #define mp_lower mp_pb.pb.pb_lower
759 #define mp_upper mp_pb.pb.pb_upper
760 #define mp_pages mp_pb.pb_pages
763 indx_t pb_lower; /**< lower bound of free space */
764 indx_t pb_upper; /**< upper bound of free space */
766 uint32_t pb_pages; /**< number of overflow pages */
768 indx_t mp_ptrs[1]; /**< dynamic size */
771 /** Size of the page header, excluding dynamic data at the end */
772 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
774 /** Address of first usable data byte in a page, after the header */
775 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
777 /** ITS#7713, change PAGEBASE to handle 65536 byte pages */
778 #define PAGEBASE ((MDB_DEVEL) ? PAGEHDRSZ : 0)
780 /** Number of nodes on a page */
781 #define NUMKEYS(p) (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
783 /** The amount of space remaining in the page */
784 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
786 /** The percentage of space used in the page, in tenths of a percent. */
787 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
788 ((env)->me_psize - PAGEHDRSZ))
789 /** The minimum page fill factor, in tenths of a percent.
790 * Pages emptier than this are candidates for merging.
792 #define FILL_THRESHOLD 250
794 /** Test if a page is a leaf page */
795 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
796 /** Test if a page is a LEAF2 page */
797 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
798 /** Test if a page is a branch page */
799 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
800 /** Test if a page is an overflow page */
801 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
802 /** Test if a page is a sub page */
803 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
805 /** The number of overflow pages needed to store the given size. */
806 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
808 /** Link in #MDB_txn.%mt_loose_pgs list */
809 #define NEXT_LOOSE_PAGE(p) (*(MDB_page **)((p) + 2))
811 /** Header for a single key/data pair within a page.
812 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
813 * We guarantee 2-byte alignment for 'MDB_node's.
815 typedef struct MDB_node {
816 /** lo and hi are used for data size on leaf nodes and for
817 * child pgno on branch nodes. On 64 bit platforms, flags
818 * is also used for pgno. (Branch nodes have no flags).
819 * They are in host byte order in case that lets some
820 * accesses be optimized into a 32-bit word access.
822 #if BYTE_ORDER == LITTLE_ENDIAN
823 unsigned short mn_lo, mn_hi; /**< part of data size or pgno */
825 unsigned short mn_hi, mn_lo;
827 /** @defgroup mdb_node Node Flags
829 * Flags for node headers.
832 #define F_BIGDATA 0x01 /**< data put on overflow page */
833 #define F_SUBDATA 0x02 /**< data is a sub-database */
834 #define F_DUPDATA 0x04 /**< data has duplicates */
836 /** valid flags for #mdb_node_add() */
837 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
840 unsigned short mn_flags; /**< @ref mdb_node */
841 unsigned short mn_ksize; /**< key size */
842 char mn_data[1]; /**< key and data are appended here */
845 /** Size of the node header, excluding dynamic data at the end */
846 #define NODESIZE offsetof(MDB_node, mn_data)
848 /** Bit position of top word in page number, for shifting mn_flags */
849 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
851 /** Size of a node in a branch page with a given key.
852 * This is just the node header plus the key, there is no data.
854 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
856 /** Size of a node in a leaf page with a given key and data.
857 * This is node header plus key plus data size.
859 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
861 /** Address of node \b i in page \b p */
862 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
864 /** Address of the key for the node */
865 #define NODEKEY(node) (void *)((node)->mn_data)
867 /** Address of the data for a node */
868 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
870 /** Get the page number pointed to by a branch node */
871 #define NODEPGNO(node) \
872 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
873 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
874 /** Set the page number in a branch node */
875 #define SETPGNO(node,pgno) do { \
876 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
877 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
879 /** Get the size of the data in a leaf node */
880 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
881 /** Set the size of the data for a leaf node */
882 #define SETDSZ(node,size) do { \
883 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
884 /** The size of a key in a node */
885 #define NODEKSZ(node) ((node)->mn_ksize)
887 /** Copy a page number from src to dst */
889 #define COPY_PGNO(dst,src) dst = src
891 #if SIZE_MAX > 4294967295UL
892 #define COPY_PGNO(dst,src) do { \
893 unsigned short *s, *d; \
894 s = (unsigned short *)&(src); \
895 d = (unsigned short *)&(dst); \
902 #define COPY_PGNO(dst,src) do { \
903 unsigned short *s, *d; \
904 s = (unsigned short *)&(src); \
905 d = (unsigned short *)&(dst); \
911 /** The address of a key in a LEAF2 page.
912 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
913 * There are no node headers, keys are stored contiguously.
915 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
917 /** Set the \b node's key into \b keyptr, if requested. */
918 #define MDB_GET_KEY(node, keyptr) { if ((keyptr) != NULL) { \
919 (keyptr)->mv_size = NODEKSZ(node); (keyptr)->mv_data = NODEKEY(node); } }
921 /** Set the \b node's key into \b key. */
922 #define MDB_GET_KEY2(node, key) { key.mv_size = NODEKSZ(node); key.mv_data = NODEKEY(node); }
924 /** Information about a single database in the environment. */
925 typedef struct MDB_db {
926 uint32_t md_pad; /**< also ksize for LEAF2 pages */
927 uint16_t md_flags; /**< @ref mdb_dbi_open */
928 uint16_t md_depth; /**< depth of this tree */
929 pgno_t md_branch_pages; /**< number of internal pages */
930 pgno_t md_leaf_pages; /**< number of leaf pages */
931 pgno_t md_overflow_pages; /**< number of overflow pages */
932 size_t md_entries; /**< number of data items */
933 pgno_t md_root; /**< the root page of this tree */
936 /** mdb_dbi_open flags */
937 #define MDB_VALID 0x8000 /**< DB handle is valid, for me_dbflags */
938 #define PERSISTENT_FLAGS (0xffff & ~(MDB_VALID))
939 #define VALID_FLAGS (MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
940 MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)
942 /** Handle for the DB used to track free pages. */
944 /** Handle for the default DB. */
947 /** Meta page content.
948 * A meta page is the start point for accessing a database snapshot.
949 * Pages 0-1 are meta pages. Transaction N writes meta page #(N % 2).
951 typedef struct MDB_meta {
952 /** Stamp identifying this as an LMDB file. It must be set
955 /** Version number of this file. Must be set to #MDB_DATA_VERSION. */
957 void *mm_address; /**< address for fixed mapping */
958 size_t mm_mapsize; /**< size of mmap region */
959 MDB_db mm_dbs[2]; /**< first is free space, 2nd is main db */
960 /** The size of pages used in this DB */
961 #define mm_psize mm_dbs[0].md_pad
962 /** Any persistent environment flags. @ref mdb_env */
963 #define mm_flags mm_dbs[0].md_flags
964 pgno_t mm_last_pg; /**< last used page in file */
965 volatile txnid_t mm_txnid; /**< txnid that committed this page */
968 /** Buffer for a stack-allocated meta page.
969 * The members define size and alignment, and silence type
970 * aliasing warnings. They are not used directly; that could
971 * mean incorrectly using several union members in parallel.
973 typedef union MDB_metabuf {
976 char mm_pad[PAGEHDRSZ];
981 /** Auxiliary DB info.
982 * The information here is mostly static/read-only. There is
983 * only a single copy of this record in the environment.
985 typedef struct MDB_dbx {
986 MDB_val md_name; /**< name of the database */
987 MDB_cmp_func *md_cmp; /**< function for comparing keys */
988 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
989 MDB_rel_func *md_rel; /**< user relocate function */
990 void *md_relctx; /**< user-provided context for md_rel */
993 /** A database transaction.
994 * Every operation requires a transaction handle.
997 MDB_txn *mt_parent; /**< parent of a nested txn */
998 /** Nested txn under this txn, set together with flag #MDB_TXN_HAS_CHILD */
1000 pgno_t mt_next_pgno; /**< next unallocated page */
1001 /** The ID of this transaction. IDs are integers incrementing from 1.
1002 * Only committed write transactions increment the ID. If a transaction
1003 * aborts, the ID may be re-used by the next writer.
1006 MDB_env *mt_env; /**< the DB environment */
1007 /** The list of pages that became unused during this transaction.
1009 MDB_IDL mt_free_pgs;
1010 /** The list of loose pages that became unused and may be reused
1011 * in this transaction, linked through #NEXT_LOOSE_PAGE(page).
1013 MDB_page *mt_loose_pgs;
1014 /* #Number of loose pages (#mt_loose_pgs) */
1016 /** The sorted list of dirty pages we temporarily wrote to disk
1017 * because the dirty list was full. page numbers in here are
1018 * shifted left by 1, deleted slots have the LSB set.
1020 MDB_IDL mt_spill_pgs;
1022 /** For write txns: Modified pages. Sorted when not MDB_WRITEMAP. */
1023 MDB_ID2L dirty_list;
1024 /** For read txns: This thread/txn's reader table slot, or NULL. */
1027 /** Array of records for each DB known in the environment. */
1029 /** Array of MDB_db records for each known DB */
1031 /** Array of sequence numbers for each DB handle */
1032 unsigned int *mt_dbiseqs;
1033 /** @defgroup mt_dbflag Transaction DB Flags
1037 #define DB_DIRTY 0x01 /**< DB was modified or is DUPSORT data */
1038 #define DB_STALE 0x02 /**< Named-DB record is older than txnID */
1039 #define DB_NEW 0x04 /**< Named-DB handle opened in this txn */
1040 #define DB_VALID 0x08 /**< DB handle is valid, see also #MDB_VALID */
1041 #define DB_USRVALID 0x10 /**< As #DB_VALID, but not set for #FREE_DBI */
1043 /** In write txns, array of cursors for each DB */
1044 MDB_cursor **mt_cursors;
1045 /** Array of flags for each DB */
1046 unsigned char *mt_dbflags;
1047 /** Number of DB records in use, or 0 when the txn is finished.
1048 * This number only ever increments until the txn finishes; we
1049 * don't decrement it when individual DB handles are closed.
1053 /** @defgroup mdb_txn Transaction Flags
1057 /** #mdb_txn_begin() flags */
1058 #define MDB_TXN_BEGIN_FLAGS MDB_RDONLY
1059 #define MDB_TXN_RDONLY MDB_RDONLY /**< read-only transaction */
1060 /* internal txn flags */
1061 #define MDB_TXN_WRITEMAP MDB_WRITEMAP /**< copy of #MDB_env flag in writers */
1062 #define MDB_TXN_FINISHED 0x01 /**< txn is finished or never began */
1063 #define MDB_TXN_ERROR 0x02 /**< txn is unusable after an error */
1064 #define MDB_TXN_DIRTY 0x04 /**< must write, even if dirty list is empty */
1065 #define MDB_TXN_SPILLS 0x08 /**< txn or a parent has spilled pages */
1066 #define MDB_TXN_HAS_CHILD 0x10 /**< txn has an #MDB_txn.%mt_child */
1067 /** most operations on the txn are currently illegal */
1068 #define MDB_TXN_BLOCKED (MDB_TXN_FINISHED|MDB_TXN_ERROR|MDB_TXN_HAS_CHILD)
1070 unsigned int mt_flags; /**< @ref mdb_txn */
1071 /** #dirty_list room: Array size - \#dirty pages visible to this txn.
1072 * Includes ancestor txns' dirty pages not hidden by other txns'
1073 * dirty/spilled pages. Thus commit(nested txn) has room to merge
1074 * dirty_list into mt_parent after freeing hidden mt_parent pages.
1076 unsigned int mt_dirty_room;
1079 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
1080 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
1081 * raise this on a 64 bit machine.
1083 #define CURSOR_STACK 32
1087 /** Cursors are used for all DB operations.
1088 * A cursor holds a path of (page pointer, key index) from the DB
1089 * root to a position in the DB, plus other state. #MDB_DUPSORT
1090 * cursors include an xcursor to the current data item. Write txns
1091 * track their cursors and keep them up to date when data moves.
1092 * Exception: An xcursor's pointer to a #P_SUBP page can be stale.
1093 * (A node with #F_DUPDATA but no #F_SUBDATA contains a subpage).
1096 /** Next cursor on this DB in this txn */
1097 MDB_cursor *mc_next;
1098 /** Backup of the original cursor if this cursor is a shadow */
1099 MDB_cursor *mc_backup;
1100 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
1101 struct MDB_xcursor *mc_xcursor;
1102 /** The transaction that owns this cursor */
1104 /** The database handle this cursor operates on */
1106 /** The database record for this cursor */
1108 /** The database auxiliary record for this cursor */
1110 /** The @ref mt_dbflag for this database */
1111 unsigned char *mc_dbflag;
1112 unsigned short mc_snum; /**< number of pushed pages */
1113 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
1114 /** @defgroup mdb_cursor Cursor Flags
1116 * Cursor state flags.
1119 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
1120 #define C_EOF 0x02 /**< No more data */
1121 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
1122 #define C_DEL 0x08 /**< last op was a cursor_del */
1123 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
1124 #define C_UNTRACK 0x40 /**< Un-track cursor when closing */
1126 unsigned int mc_flags; /**< @ref mdb_cursor */
1127 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
1128 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
1131 /** Context for sorted-dup records.
1132 * We could have gone to a fully recursive design, with arbitrarily
1133 * deep nesting of sub-databases. But for now we only handle these
1134 * levels - main DB, optional sub-DB, sorted-duplicate DB.
1136 typedef struct MDB_xcursor {
1137 /** A sub-cursor for traversing the Dup DB */
1138 MDB_cursor mx_cursor;
1139 /** The database record for this Dup DB */
1141 /** The auxiliary DB record for this Dup DB */
1143 /** The @ref mt_dbflag for this Dup DB */
1144 unsigned char mx_dbflag;
1147 /** State of FreeDB old pages, stored in the MDB_env */
1148 typedef struct MDB_pgstate {
1149 pgno_t *mf_pghead; /**< Reclaimed freeDB pages, or NULL before use */
1150 txnid_t mf_pglast; /**< ID of last used record, or 0 if !mf_pghead */
1153 /** The database environment. */
1155 HANDLE me_fd; /**< The main data file */
1156 HANDLE me_lfd; /**< The lock file */
1157 HANDLE me_mfd; /**< just for writing the meta pages */
1158 /** Failed to update the meta page. Probably an I/O error. */
1159 #define MDB_FATAL_ERROR 0x80000000U
1160 /** Some fields are initialized. */
1161 #define MDB_ENV_ACTIVE 0x20000000U
1162 /** me_txkey is set */
1163 #define MDB_ENV_TXKEY 0x10000000U
1164 /** fdatasync is unreliable */
1165 #define MDB_FSYNCONLY 0x08000000U
1166 uint32_t me_flags; /**< @ref mdb_env */
1167 unsigned int me_psize; /**< DB page size, inited from me_os_psize */
1168 unsigned int me_os_psize; /**< OS page size, from #GET_PAGESIZE */
1169 unsigned int me_maxreaders; /**< size of the reader table */
1170 /** Max #MDB_txninfo.%mti_numreaders of interest to #mdb_env_close() */
1171 volatile int me_close_readers;
1172 MDB_dbi me_numdbs; /**< number of DBs opened */
1173 MDB_dbi me_maxdbs; /**< size of the DB table */
1174 MDB_PID_T me_pid; /**< process ID of this env */
1175 char *me_path; /**< path to the DB files */
1176 char *me_map; /**< the memory map of the data file */
1177 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
1178 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
1179 void *me_pbuf; /**< scratch area for DUPSORT put() */
1180 MDB_txn *me_txn; /**< current write transaction */
1181 MDB_txn *me_txn0; /**< prealloc'd write transaction */
1182 size_t me_mapsize; /**< size of the data memory map */
1183 off_t me_size; /**< current file size */
1184 pgno_t me_maxpg; /**< me_mapsize / me_psize */
1185 MDB_dbx *me_dbxs; /**< array of static DB info */
1186 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
1187 unsigned int *me_dbiseqs; /**< array of dbi sequence numbers */
1188 pthread_key_t me_txkey; /**< thread-key for readers */
1189 txnid_t me_pgoldest; /**< ID of oldest reader last time we looked */
1190 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
1191 # define me_pglast me_pgstate.mf_pglast
1192 # define me_pghead me_pgstate.mf_pghead
1193 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
1194 /** IDL of pages that became unused in a write txn */
1195 MDB_IDL me_free_pgs;
1196 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
1197 MDB_ID2L me_dirty_list;
1198 /** Max number of freelist items that can fit in a single overflow page */
1200 /** Max size of a node on a page */
1201 unsigned int me_nodemax;
1202 #if !(MDB_MAXKEYSIZE)
1203 unsigned int me_maxkey; /**< max size of a key */
1205 int me_live_reader; /**< have liveness lock in reader table */
1207 int me_pidquery; /**< Used in OpenProcess */
1209 #ifdef MDB_USE_POSIX_MUTEX /* Posix mutexes reside in shared mem */
1210 # define me_rmutex me_txns->mti_rmutex /**< Shared reader lock */
1211 # define me_wmutex me_txns->mti_wmutex /**< Shared writer lock */
1213 mdb_mutex_t me_rmutex;
1214 mdb_mutex_t me_wmutex;
1216 void *me_userctx; /**< User-settable context */
1217 MDB_assert_func *me_assert_func; /**< Callback for assertion failures */
1220 /** Nested transaction */
1221 typedef struct MDB_ntxn {
1222 MDB_txn mnt_txn; /**< the transaction */
1223 MDB_pgstate mnt_pgstate; /**< parent transaction's saved freestate */
1226 /** max number of pages to commit in one writev() call */
1227 #define MDB_COMMIT_PAGES 64
1228 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
1229 #undef MDB_COMMIT_PAGES
1230 #define MDB_COMMIT_PAGES IOV_MAX
1233 /** max bytes to write in one call */
1234 #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4))
1236 /** Check \b txn and \b dbi arguments to a function */
1237 #define TXN_DBI_EXIST(txn, dbi, validity) \
1238 ((txn) && (dbi)<(txn)->mt_numdbs && ((txn)->mt_dbflags[dbi] & (validity)))
1240 /** Check for misused \b dbi handles */
1241 #define TXN_DBI_CHANGED(txn, dbi) \
1242 ((txn)->mt_dbiseqs[dbi] != (txn)->mt_env->me_dbiseqs[dbi])
1244 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
1245 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
1246 static int mdb_page_touch(MDB_cursor *mc);
1248 #define MDB_END_NAMES {"committed", "empty-commit", "abort", "reset", \
1249 "reset-tmp", "fail-begin", "fail-beginchild"}
1251 /* mdb_txn_end operation number, for logging */
1252 MDB_END_COMMITTED, MDB_END_EMPTY_COMMIT, MDB_END_ABORT, MDB_END_RESET,
1253 MDB_END_RESET_TMP, MDB_END_FAIL_BEGIN, MDB_END_FAIL_BEGINCHILD
1255 #define MDB_END_OPMASK 0x0F /**< mask for #mdb_txn_end() operation number */
1256 #define MDB_END_UPDATE 0x10 /**< update env state (DBIs) */
1257 #define MDB_END_FREE 0x20 /**< free txn unless it is #MDB_env.%me_txn0 */
1258 #define MDB_END_SLOT MDB_NOTLS /**< release any reader slot if #MDB_NOTLS */
1259 static void mdb_txn_end(MDB_txn *txn, unsigned mode);
1261 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp, int *lvl);
1262 static int mdb_page_search_root(MDB_cursor *mc,
1263 MDB_val *key, int modify);
1264 #define MDB_PS_MODIFY 1
1265 #define MDB_PS_ROOTONLY 2
1266 #define MDB_PS_FIRST 4
1267 #define MDB_PS_LAST 8
1268 static int mdb_page_search(MDB_cursor *mc,
1269 MDB_val *key, int flags);
1270 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1272 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1273 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1274 pgno_t newpgno, unsigned int nflags);
1276 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1277 static MDB_meta *mdb_env_pick_meta(const MDB_env *env);
1278 static int mdb_env_write_meta(MDB_txn *txn);
1279 #ifdef MDB_USE_POSIX_MUTEX /* Drop unused excl arg */
1280 # define mdb_env_close0(env, excl) mdb_env_close1(env)
1282 static void mdb_env_close0(MDB_env *env, int excl);
1284 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1285 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1286 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1287 static void mdb_node_del(MDB_cursor *mc, int ksize);
1288 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1289 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1290 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1291 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1292 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1294 static int mdb_rebalance(MDB_cursor *mc);
1295 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1297 static void mdb_cursor_pop(MDB_cursor *mc);
1298 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1300 static int mdb_cursor_del0(MDB_cursor *mc);
1301 static int mdb_del0(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data, unsigned flags);
1302 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1303 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1304 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1305 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1307 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1308 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1310 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1311 static void mdb_xcursor_init0(MDB_cursor *mc);
1312 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1313 static void mdb_xcursor_init2(MDB_cursor *mc, MDB_xcursor *src_mx, int force);
1315 static int mdb_drop0(MDB_cursor *mc, int subs);
1316 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1317 static int mdb_reader_check0(MDB_env *env, int rlocked, int *dead);
1320 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1323 /** Compare two items pointing at size_t's of unknown alignment. */
1324 #ifdef MISALIGNED_OK
1325 # define mdb_cmp_clong mdb_cmp_long
1327 # define mdb_cmp_clong mdb_cmp_cint
1331 static SECURITY_DESCRIPTOR mdb_null_sd;
1332 static SECURITY_ATTRIBUTES mdb_all_sa;
1333 static int mdb_sec_inited;
1336 /** Return the library version info. */
1338 mdb_version(int *major, int *minor, int *patch)
1340 if (major) *major = MDB_VERSION_MAJOR;
1341 if (minor) *minor = MDB_VERSION_MINOR;
1342 if (patch) *patch = MDB_VERSION_PATCH;
1343 return MDB_VERSION_STRING;
1346 /** Table of descriptions for LMDB @ref errors */
1347 static char *const mdb_errstr[] = {
1348 "MDB_KEYEXIST: Key/data pair already exists",
1349 "MDB_NOTFOUND: No matching key/data pair found",
1350 "MDB_PAGE_NOTFOUND: Requested page not found",
1351 "MDB_CORRUPTED: Located page was wrong type",
1352 "MDB_PANIC: Update of meta page failed or environment had fatal error",
1353 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1354 "MDB_INVALID: File is not an LMDB file",
1355 "MDB_MAP_FULL: Environment mapsize limit reached",
1356 "MDB_DBS_FULL: Environment maxdbs limit reached",
1357 "MDB_READERS_FULL: Environment maxreaders limit reached",
1358 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1359 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1360 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1361 "MDB_PAGE_FULL: Internal error - page has no more space",
1362 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1363 "MDB_INCOMPATIBLE: Operation and DB incompatible, or DB flags changed",
1364 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1365 "MDB_BAD_TXN: Transaction must abort, has a child, or is invalid",
1366 "MDB_BAD_VALSIZE: Unsupported size of key/DB name/data, or wrong DUPFIXED size",
1367 "MDB_BAD_DBI: The specified DBI handle was closed/changed unexpectedly",
1371 mdb_strerror(int err)
1374 /** HACK: pad 4KB on stack over the buf. Return system msgs in buf.
1375 * This works as long as no function between the call to mdb_strerror
1376 * and the actual use of the message uses more than 4K of stack.
1379 char buf[1024], *ptr = buf;
1383 return ("Successful return: 0");
1385 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1386 i = err - MDB_KEYEXIST;
1387 return mdb_errstr[i];
1391 /* These are the C-runtime error codes we use. The comment indicates
1392 * their numeric value, and the Win32 error they would correspond to
1393 * if the error actually came from a Win32 API. A major mess, we should
1394 * have used LMDB-specific error codes for everything.
1397 case ENOENT: /* 2, FILE_NOT_FOUND */
1398 case EIO: /* 5, ACCESS_DENIED */
1399 case ENOMEM: /* 12, INVALID_ACCESS */
1400 case EACCES: /* 13, INVALID_DATA */
1401 case EBUSY: /* 16, CURRENT_DIRECTORY */
1402 case EINVAL: /* 22, BAD_COMMAND */
1403 case ENOSPC: /* 28, OUT_OF_PAPER */
1404 return strerror(err);
1409 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM |
1410 FORMAT_MESSAGE_IGNORE_INSERTS,
1411 NULL, err, 0, ptr, sizeof(buf), (va_list *)pad);
1414 return strerror(err);
1418 /** assert(3) variant in cursor context */
1419 #define mdb_cassert(mc, expr) mdb_assert0((mc)->mc_txn->mt_env, expr, #expr)
1420 /** assert(3) variant in transaction context */
1421 #define mdb_tassert(mc, expr) mdb_assert0((txn)->mt_env, expr, #expr)
1422 /** assert(3) variant in environment context */
1423 #define mdb_eassert(env, expr) mdb_assert0(env, expr, #expr)
1426 # define mdb_assert0(env, expr, expr_txt) ((expr) ? (void)0 : \
1427 mdb_assert_fail(env, expr_txt, mdb_func_, __FILE__, __LINE__))
1430 mdb_assert_fail(MDB_env *env, const char *expr_txt,
1431 const char *func, const char *file, int line)
1434 sprintf(buf, "%.100s:%d: Assertion '%.200s' failed in %.40s()",
1435 file, line, expr_txt, func);
1436 if (env->me_assert_func)
1437 env->me_assert_func(env, buf);
1438 fprintf(stderr, "%s\n", buf);
1442 # define mdb_assert0(env, expr, expr_txt) ((void) 0)
1446 /** Return the page number of \b mp which may be sub-page, for debug output */
1448 mdb_dbg_pgno(MDB_page *mp)
1451 COPY_PGNO(ret, mp->mp_pgno);
1455 /** Display a key in hexadecimal and return the address of the result.
1456 * @param[in] key the key to display
1457 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1458 * @return The key in hexadecimal form.
1461 mdb_dkey(MDB_val *key, char *buf)
1464 unsigned char *c = key->mv_data;
1470 if (key->mv_size > DKBUF_MAXKEYSIZE)
1471 return "MDB_MAXKEYSIZE";
1472 /* may want to make this a dynamic check: if the key is mostly
1473 * printable characters, print it as-is instead of converting to hex.
1477 for (i=0; i<key->mv_size; i++)
1478 ptr += sprintf(ptr, "%02x", *c++);
1480 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1486 mdb_leafnode_type(MDB_node *n)
1488 static char *const tp[2][2] = {{"", ": DB"}, {": sub-page", ": sub-DB"}};
1489 return F_ISSET(n->mn_flags, F_BIGDATA) ? ": overflow page" :
1490 tp[F_ISSET(n->mn_flags, F_DUPDATA)][F_ISSET(n->mn_flags, F_SUBDATA)];
1493 /** Display all the keys in the page. */
1495 mdb_page_list(MDB_page *mp)
1497 pgno_t pgno = mdb_dbg_pgno(mp);
1498 const char *type, *state = (mp->mp_flags & P_DIRTY) ? ", dirty" : "";
1500 unsigned int i, nkeys, nsize, total = 0;
1504 switch (mp->mp_flags & (P_BRANCH|P_LEAF|P_LEAF2|P_META|P_OVERFLOW|P_SUBP)) {
1505 case P_BRANCH: type = "Branch page"; break;
1506 case P_LEAF: type = "Leaf page"; break;
1507 case P_LEAF|P_SUBP: type = "Sub-page"; break;
1508 case P_LEAF|P_LEAF2: type = "LEAF2 page"; break;
1509 case P_LEAF|P_LEAF2|P_SUBP: type = "LEAF2 sub-page"; break;
1511 fprintf(stderr, "Overflow page %"Z"u pages %u%s\n",
1512 pgno, mp->mp_pages, state);
1515 fprintf(stderr, "Meta-page %"Z"u txnid %"Z"u\n",
1516 pgno, ((MDB_meta *)METADATA(mp))->mm_txnid);
1519 fprintf(stderr, "Bad page %"Z"u flags 0x%u\n", pgno, mp->mp_flags);
1523 nkeys = NUMKEYS(mp);
1524 fprintf(stderr, "%s %"Z"u numkeys %d%s\n", type, pgno, nkeys, state);
1526 for (i=0; i<nkeys; i++) {
1527 if (IS_LEAF2(mp)) { /* LEAF2 pages have no mp_ptrs[] or node headers */
1528 key.mv_size = nsize = mp->mp_pad;
1529 key.mv_data = LEAF2KEY(mp, i, nsize);
1531 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1534 node = NODEPTR(mp, i);
1535 key.mv_size = node->mn_ksize;
1536 key.mv_data = node->mn_data;
1537 nsize = NODESIZE + key.mv_size;
1538 if (IS_BRANCH(mp)) {
1539 fprintf(stderr, "key %d: page %"Z"u, %s\n", i, NODEPGNO(node),
1543 if (F_ISSET(node->mn_flags, F_BIGDATA))
1544 nsize += sizeof(pgno_t);
1546 nsize += NODEDSZ(node);
1548 nsize += sizeof(indx_t);
1549 fprintf(stderr, "key %d: nsize %d, %s%s\n",
1550 i, nsize, DKEY(&key), mdb_leafnode_type(node));
1552 total = EVEN(total);
1554 fprintf(stderr, "Total: header %d + contents %d + unused %d\n",
1555 IS_LEAF2(mp) ? PAGEHDRSZ : PAGEBASE + mp->mp_lower, total, SIZELEFT(mp));
1559 mdb_cursor_chk(MDB_cursor *mc)
1565 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1566 for (i=0; i<mc->mc_top; i++) {
1568 node = NODEPTR(mp, mc->mc_ki[i]);
1569 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1572 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1578 /** Count all the pages in each DB and in the freelist
1579 * and make sure it matches the actual number of pages
1581 * All named DBs must be open for a correct count.
1583 static void mdb_audit(MDB_txn *txn)
1587 MDB_ID freecount, count;
1592 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1593 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1594 freecount += *(MDB_ID *)data.mv_data;
1595 mdb_tassert(txn, rc == MDB_NOTFOUND);
1598 for (i = 0; i<txn->mt_numdbs; i++) {
1600 if (!(txn->mt_dbflags[i] & DB_VALID))
1602 mdb_cursor_init(&mc, txn, i, &mx);
1603 if (txn->mt_dbs[i].md_root == P_INVALID)
1605 count += txn->mt_dbs[i].md_branch_pages +
1606 txn->mt_dbs[i].md_leaf_pages +
1607 txn->mt_dbs[i].md_overflow_pages;
1608 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1609 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST);
1610 for (; rc == MDB_SUCCESS; rc = mdb_cursor_sibling(&mc, 1)) {
1613 mp = mc.mc_pg[mc.mc_top];
1614 for (j=0; j<NUMKEYS(mp); j++) {
1615 MDB_node *leaf = NODEPTR(mp, j);
1616 if (leaf->mn_flags & F_SUBDATA) {
1618 memcpy(&db, NODEDATA(leaf), sizeof(db));
1619 count += db.md_branch_pages + db.md_leaf_pages +
1620 db.md_overflow_pages;
1624 mdb_tassert(txn, rc == MDB_NOTFOUND);
1627 if (freecount + count + 2 /* metapages */ != txn->mt_next_pgno) {
1628 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1629 txn->mt_txnid, freecount, count+2, freecount+count+2, txn->mt_next_pgno);
1635 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1637 return txn->mt_dbxs[dbi].md_cmp(a, b);
1641 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1643 MDB_cmp_func *dcmp = txn->mt_dbxs[dbi].md_dcmp;
1644 #if UINT_MAX < SIZE_MAX
1645 if (dcmp == mdb_cmp_int && a->mv_size == sizeof(size_t))
1646 dcmp = mdb_cmp_clong;
1651 /** Allocate memory for a page.
1652 * Re-use old malloc'd pages first for singletons, otherwise just malloc.
1655 mdb_page_malloc(MDB_txn *txn, unsigned num)
1657 MDB_env *env = txn->mt_env;
1658 MDB_page *ret = env->me_dpages;
1659 size_t psize = env->me_psize, sz = psize, off;
1660 /* For ! #MDB_NOMEMINIT, psize counts how much to init.
1661 * For a single page alloc, we init everything after the page header.
1662 * For multi-page, we init the final page; if the caller needed that
1663 * many pages they will be filling in at least up to the last page.
1667 VGMEMP_ALLOC(env, ret, sz);
1668 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1669 env->me_dpages = ret->mp_next;
1672 psize -= off = PAGEHDRSZ;
1677 if ((ret = malloc(sz)) != NULL) {
1678 VGMEMP_ALLOC(env, ret, sz);
1679 if (!(env->me_flags & MDB_NOMEMINIT)) {
1680 memset((char *)ret + off, 0, psize);
1684 txn->mt_flags |= MDB_TXN_ERROR;
1688 /** Free a single page.
1689 * Saves single pages to a list, for future reuse.
1690 * (This is not used for multi-page overflow pages.)
1693 mdb_page_free(MDB_env *env, MDB_page *mp)
1695 mp->mp_next = env->me_dpages;
1696 VGMEMP_FREE(env, mp);
1697 env->me_dpages = mp;
1700 /** Free a dirty page */
1702 mdb_dpage_free(MDB_env *env, MDB_page *dp)
1704 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1705 mdb_page_free(env, dp);
1707 /* large pages just get freed directly */
1708 VGMEMP_FREE(env, dp);
1713 /** Return all dirty pages to dpage list */
1715 mdb_dlist_free(MDB_txn *txn)
1717 MDB_env *env = txn->mt_env;
1718 MDB_ID2L dl = txn->mt_u.dirty_list;
1719 unsigned i, n = dl[0].mid;
1721 for (i = 1; i <= n; i++) {
1722 mdb_dpage_free(env, dl[i].mptr);
1727 /** Loosen or free a single page.
1728 * Saves single pages to a list for future reuse
1729 * in this same txn. It has been pulled from the freeDB
1730 * and already resides on the dirty list, but has been
1731 * deleted. Use these pages first before pulling again
1734 * If the page wasn't dirtied in this txn, just add it
1735 * to this txn's free list.
1738 mdb_page_loose(MDB_cursor *mc, MDB_page *mp)
1741 pgno_t pgno = mp->mp_pgno;
1742 MDB_txn *txn = mc->mc_txn;
1744 if ((mp->mp_flags & P_DIRTY) && mc->mc_dbi != FREE_DBI) {
1745 if (txn->mt_parent) {
1746 MDB_ID2 *dl = txn->mt_u.dirty_list;
1747 /* If txn has a parent, make sure the page is in our
1751 unsigned x = mdb_mid2l_search(dl, pgno);
1752 if (x <= dl[0].mid && dl[x].mid == pgno) {
1753 if (mp != dl[x].mptr) { /* bad cursor? */
1754 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
1755 txn->mt_flags |= MDB_TXN_ERROR;
1756 return MDB_CORRUPTED;
1763 /* no parent txn, so it's just ours */
1768 DPRINTF(("loosen db %d page %"Z"u", DDBI(mc),
1770 NEXT_LOOSE_PAGE(mp) = txn->mt_loose_pgs;
1771 txn->mt_loose_pgs = mp;
1772 txn->mt_loose_count++;
1773 mp->mp_flags |= P_LOOSE;
1775 int rc = mdb_midl_append(&txn->mt_free_pgs, pgno);
1783 /** Set or clear P_KEEP in dirty, non-overflow, non-sub pages watched by txn.
1784 * @param[in] mc A cursor handle for the current operation.
1785 * @param[in] pflags Flags of the pages to update:
1786 * P_DIRTY to set P_KEEP, P_DIRTY|P_KEEP to clear it.
1787 * @param[in] all No shortcuts. Needed except after a full #mdb_page_flush().
1788 * @return 0 on success, non-zero on failure.
1791 mdb_pages_xkeep(MDB_cursor *mc, unsigned pflags, int all)
1793 enum { Mask = P_SUBP|P_DIRTY|P_LOOSE|P_KEEP };
1794 MDB_txn *txn = mc->mc_txn;
1800 int rc = MDB_SUCCESS, level;
1802 /* Mark pages seen by cursors */
1803 if (mc->mc_flags & C_UNTRACK)
1804 mc = NULL; /* will find mc in mt_cursors */
1805 for (i = txn->mt_numdbs;; mc = txn->mt_cursors[--i]) {
1806 for (; mc; mc=mc->mc_next) {
1807 if (!(mc->mc_flags & C_INITIALIZED))
1809 for (m3 = mc;; m3 = &mx->mx_cursor) {
1811 for (j=0; j<m3->mc_snum; j++) {
1813 if ((mp->mp_flags & Mask) == pflags)
1814 mp->mp_flags ^= P_KEEP;
1816 mx = m3->mc_xcursor;
1817 /* Proceed to mx if it is at a sub-database */
1818 if (! (mx && (mx->mx_cursor.mc_flags & C_INITIALIZED)))
1820 if (! (mp && (mp->mp_flags & P_LEAF)))
1822 leaf = NODEPTR(mp, m3->mc_ki[j-1]);
1823 if (!(leaf->mn_flags & F_SUBDATA))
1832 /* Mark dirty root pages */
1833 for (i=0; i<txn->mt_numdbs; i++) {
1834 if (txn->mt_dbflags[i] & DB_DIRTY) {
1835 pgno_t pgno = txn->mt_dbs[i].md_root;
1836 if (pgno == P_INVALID)
1838 if ((rc = mdb_page_get(txn, pgno, &dp, &level)) != MDB_SUCCESS)
1840 if ((dp->mp_flags & Mask) == pflags && level <= 1)
1841 dp->mp_flags ^= P_KEEP;
1849 static int mdb_page_flush(MDB_txn *txn, int keep);
1851 /** Spill pages from the dirty list back to disk.
1852 * This is intended to prevent running into #MDB_TXN_FULL situations,
1853 * but note that they may still occur in a few cases:
1854 * 1) our estimate of the txn size could be too small. Currently this
1855 * seems unlikely, except with a large number of #MDB_MULTIPLE items.
1856 * 2) child txns may run out of space if their parents dirtied a
1857 * lot of pages and never spilled them. TODO: we probably should do
1858 * a preemptive spill during #mdb_txn_begin() of a child txn, if
1859 * the parent's dirty_room is below a given threshold.
1861 * Otherwise, if not using nested txns, it is expected that apps will
1862 * not run into #MDB_TXN_FULL any more. The pages are flushed to disk
1863 * the same way as for a txn commit, e.g. their P_DIRTY flag is cleared.
1864 * If the txn never references them again, they can be left alone.
1865 * If the txn only reads them, they can be used without any fuss.
1866 * If the txn writes them again, they can be dirtied immediately without
1867 * going thru all of the work of #mdb_page_touch(). Such references are
1868 * handled by #mdb_page_unspill().
1870 * Also note, we never spill DB root pages, nor pages of active cursors,
1871 * because we'll need these back again soon anyway. And in nested txns,
1872 * we can't spill a page in a child txn if it was already spilled in a
1873 * parent txn. That would alter the parent txns' data even though
1874 * the child hasn't committed yet, and we'd have no way to undo it if
1875 * the child aborted.
1877 * @param[in] m0 cursor A cursor handle identifying the transaction and
1878 * database for which we are checking space.
1879 * @param[in] key For a put operation, the key being stored.
1880 * @param[in] data For a put operation, the data being stored.
1881 * @return 0 on success, non-zero on failure.
1884 mdb_page_spill(MDB_cursor *m0, MDB_val *key, MDB_val *data)
1886 MDB_txn *txn = m0->mc_txn;
1888 MDB_ID2L dl = txn->mt_u.dirty_list;
1889 unsigned int i, j, need;
1892 if (m0->mc_flags & C_SUB)
1895 /* Estimate how much space this op will take */
1896 i = m0->mc_db->md_depth;
1897 /* Named DBs also dirty the main DB */
1898 if (m0->mc_dbi > MAIN_DBI)
1899 i += txn->mt_dbs[MAIN_DBI].md_depth;
1900 /* For puts, roughly factor in the key+data size */
1902 i += (LEAFSIZE(key, data) + txn->mt_env->me_psize) / txn->mt_env->me_psize;
1903 i += i; /* double it for good measure */
1906 if (txn->mt_dirty_room > i)
1909 if (!txn->mt_spill_pgs) {
1910 txn->mt_spill_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX);
1911 if (!txn->mt_spill_pgs)
1914 /* purge deleted slots */
1915 MDB_IDL sl = txn->mt_spill_pgs;
1916 unsigned int num = sl[0];
1918 for (i=1; i<=num; i++) {
1925 /* Preserve pages which may soon be dirtied again */
1926 if ((rc = mdb_pages_xkeep(m0, P_DIRTY, 1)) != MDB_SUCCESS)
1929 /* Less aggressive spill - we originally spilled the entire dirty list,
1930 * with a few exceptions for cursor pages and DB root pages. But this
1931 * turns out to be a lot of wasted effort because in a large txn many
1932 * of those pages will need to be used again. So now we spill only 1/8th
1933 * of the dirty pages. Testing revealed this to be a good tradeoff,
1934 * better than 1/2, 1/4, or 1/10.
1936 if (need < MDB_IDL_UM_MAX / 8)
1937 need = MDB_IDL_UM_MAX / 8;
1939 /* Save the page IDs of all the pages we're flushing */
1940 /* flush from the tail forward, this saves a lot of shifting later on. */
1941 for (i=dl[0].mid; i && need; i--) {
1942 MDB_ID pn = dl[i].mid << 1;
1944 if (dp->mp_flags & (P_LOOSE|P_KEEP))
1946 /* Can't spill twice, make sure it's not already in a parent's
1949 if (txn->mt_parent) {
1951 for (tx2 = txn->mt_parent; tx2; tx2 = tx2->mt_parent) {
1952 if (tx2->mt_spill_pgs) {
1953 j = mdb_midl_search(tx2->mt_spill_pgs, pn);
1954 if (j <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[j] == pn) {
1955 dp->mp_flags |= P_KEEP;
1963 if ((rc = mdb_midl_append(&txn->mt_spill_pgs, pn)))
1967 mdb_midl_sort(txn->mt_spill_pgs);
1969 /* Flush the spilled part of dirty list */
1970 if ((rc = mdb_page_flush(txn, i)) != MDB_SUCCESS)
1973 /* Reset any dirty pages we kept that page_flush didn't see */
1974 rc = mdb_pages_xkeep(m0, P_DIRTY|P_KEEP, i);
1977 txn->mt_flags |= rc ? MDB_TXN_ERROR : MDB_TXN_SPILLS;
1981 /** Find oldest txnid still referenced. Expects txn->mt_txnid > 0. */
1983 mdb_find_oldest(MDB_txn *txn)
1986 txnid_t mr, oldest = txn->mt_txnid - 1;
1987 if (txn->mt_env->me_txns) {
1988 MDB_reader *r = txn->mt_env->me_txns->mti_readers;
1989 for (i = txn->mt_env->me_txns->mti_numreaders; --i >= 0; ) {
2000 /** Add a page to the txn's dirty list */
2002 mdb_page_dirty(MDB_txn *txn, MDB_page *mp)
2005 int rc, (*insert)(MDB_ID2L, MDB_ID2 *);
2007 if (txn->mt_flags & MDB_TXN_WRITEMAP) {
2008 insert = mdb_mid2l_append;
2010 insert = mdb_mid2l_insert;
2012 mid.mid = mp->mp_pgno;
2014 rc = insert(txn->mt_u.dirty_list, &mid);
2015 mdb_tassert(txn, rc == 0);
2016 txn->mt_dirty_room--;
2019 /** Allocate page numbers and memory for writing. Maintain me_pglast,
2020 * me_pghead and mt_next_pgno.
2022 * If there are free pages available from older transactions, they
2023 * are re-used first. Otherwise allocate a new page at mt_next_pgno.
2024 * Do not modify the freedB, just merge freeDB records into me_pghead[]
2025 * and move me_pglast to say which records were consumed. Only this
2026 * function can create me_pghead and move me_pglast/mt_next_pgno.
2027 * @param[in] mc cursor A cursor handle identifying the transaction and
2028 * database for which we are allocating.
2029 * @param[in] num the number of pages to allocate.
2030 * @param[out] mp Address of the allocated page(s). Requests for multiple pages
2031 * will always be satisfied by a single contiguous chunk of memory.
2032 * @return 0 on success, non-zero on failure.
2035 mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp)
2037 #ifdef MDB_PARANOID /* Seems like we can ignore this now */
2038 /* Get at most <Max_retries> more freeDB records once me_pghead
2039 * has enough pages. If not enough, use new pages from the map.
2040 * If <Paranoid> and mc is updating the freeDB, only get new
2041 * records if me_pghead is empty. Then the freelist cannot play
2042 * catch-up with itself by growing while trying to save it.
2044 enum { Paranoid = 1, Max_retries = 500 };
2046 enum { Paranoid = 0, Max_retries = INT_MAX /*infinite*/ };
2048 int rc, retry = num * 60;
2049 MDB_txn *txn = mc->mc_txn;
2050 MDB_env *env = txn->mt_env;
2051 pgno_t pgno, *mop = env->me_pghead;
2052 unsigned i, j, mop_len = mop ? mop[0] : 0, n2 = num-1;
2054 txnid_t oldest = 0, last;
2059 /* If there are any loose pages, just use them */
2060 if (num == 1 && txn->mt_loose_pgs) {
2061 np = txn->mt_loose_pgs;
2062 txn->mt_loose_pgs = NEXT_LOOSE_PAGE(np);
2063 txn->mt_loose_count--;
2064 DPRINTF(("db %d use loose page %"Z"u", DDBI(mc),
2072 /* If our dirty list is already full, we can't do anything */
2073 if (txn->mt_dirty_room == 0) {
2078 for (op = MDB_FIRST;; op = MDB_NEXT) {
2083 /* Seek a big enough contiguous page range. Prefer
2084 * pages at the tail, just truncating the list.
2090 if (mop[i-n2] == pgno+n2)
2097 if (op == MDB_FIRST) { /* 1st iteration */
2098 /* Prepare to fetch more and coalesce */
2099 last = env->me_pglast;
2100 oldest = env->me_pgoldest;
2101 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
2104 key.mv_data = &last; /* will look up last+1 */
2105 key.mv_size = sizeof(last);
2107 if (Paranoid && mc->mc_dbi == FREE_DBI)
2110 if (Paranoid && retry < 0 && mop_len)
2114 /* Do not fetch more if the record will be too recent */
2115 if (oldest <= last) {
2117 oldest = mdb_find_oldest(txn);
2118 env->me_pgoldest = oldest;
2124 rc = mdb_cursor_get(&m2, &key, NULL, op);
2126 if (rc == MDB_NOTFOUND)
2130 last = *(txnid_t*)key.mv_data;
2131 if (oldest <= last) {
2133 oldest = mdb_find_oldest(txn);
2134 env->me_pgoldest = oldest;
2140 np = m2.mc_pg[m2.mc_top];
2141 leaf = NODEPTR(np, m2.mc_ki[m2.mc_top]);
2142 if ((rc = mdb_node_read(txn, leaf, &data)) != MDB_SUCCESS)
2145 idl = (MDB_ID *) data.mv_data;
2148 if (!(env->me_pghead = mop = mdb_midl_alloc(i))) {
2153 if ((rc = mdb_midl_need(&env->me_pghead, i)) != 0)
2155 mop = env->me_pghead;
2157 env->me_pglast = last;
2159 DPRINTF(("IDL read txn %"Z"u root %"Z"u num %u",
2160 last, txn->mt_dbs[FREE_DBI].md_root, i));
2162 DPRINTF(("IDL %"Z"u", idl[j]));
2164 /* Merge in descending sorted order */
2165 mdb_midl_xmerge(mop, idl);
2169 /* Use new pages from the map when nothing suitable in the freeDB */
2171 pgno = txn->mt_next_pgno;
2172 if (pgno + num >= env->me_maxpg) {
2173 DPUTS("DB size maxed out");
2179 if (env->me_flags & MDB_WRITEMAP) {
2180 np = (MDB_page *)(env->me_map + env->me_psize * pgno);
2182 if (!(np = mdb_page_malloc(txn, num))) {
2188 mop[0] = mop_len -= num;
2189 /* Move any stragglers down */
2190 for (j = i-num; j < mop_len; )
2191 mop[++j] = mop[++i];
2193 txn->mt_next_pgno = pgno + num;
2196 mdb_page_dirty(txn, np);
2202 txn->mt_flags |= MDB_TXN_ERROR;
2206 /** Copy the used portions of a non-overflow page.
2207 * @param[in] dst page to copy into
2208 * @param[in] src page to copy from
2209 * @param[in] psize size of a page
2212 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
2214 enum { Align = sizeof(pgno_t) };
2215 indx_t upper = src->mp_upper, lower = src->mp_lower, unused = upper-lower;
2217 /* If page isn't full, just copy the used portion. Adjust
2218 * alignment so memcpy may copy words instead of bytes.
2220 if ((unused &= -Align) && !IS_LEAF2(src)) {
2221 upper = (upper + PAGEBASE) & -Align;
2222 memcpy(dst, src, (lower + PAGEBASE + (Align-1)) & -Align);
2223 memcpy((pgno_t *)((char *)dst+upper), (pgno_t *)((char *)src+upper),
2226 memcpy(dst, src, psize - unused);
2230 /** Pull a page off the txn's spill list, if present.
2231 * If a page being referenced was spilled to disk in this txn, bring
2232 * it back and make it dirty/writable again.
2233 * @param[in] txn the transaction handle.
2234 * @param[in] mp the page being referenced. It must not be dirty.
2235 * @param[out] ret the writable page, if any. ret is unchanged if
2236 * mp wasn't spilled.
2239 mdb_page_unspill(MDB_txn *txn, MDB_page *mp, MDB_page **ret)
2241 MDB_env *env = txn->mt_env;
2244 pgno_t pgno = mp->mp_pgno, pn = pgno << 1;
2246 for (tx2 = txn; tx2; tx2=tx2->mt_parent) {
2247 if (!tx2->mt_spill_pgs)
2249 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
2250 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
2253 if (txn->mt_dirty_room == 0)
2254 return MDB_TXN_FULL;
2255 if (IS_OVERFLOW(mp))
2259 if (env->me_flags & MDB_WRITEMAP) {
2262 np = mdb_page_malloc(txn, num);
2266 memcpy(np, mp, num * env->me_psize);
2268 mdb_page_copy(np, mp, env->me_psize);
2271 /* If in current txn, this page is no longer spilled.
2272 * If it happens to be the last page, truncate the spill list.
2273 * Otherwise mark it as deleted by setting the LSB.
2275 if (x == txn->mt_spill_pgs[0])
2276 txn->mt_spill_pgs[0]--;
2278 txn->mt_spill_pgs[x] |= 1;
2279 } /* otherwise, if belonging to a parent txn, the
2280 * page remains spilled until child commits
2283 mdb_page_dirty(txn, np);
2284 np->mp_flags |= P_DIRTY;
2292 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
2293 * @param[in] mc cursor pointing to the page to be touched
2294 * @return 0 on success, non-zero on failure.
2297 mdb_page_touch(MDB_cursor *mc)
2299 MDB_page *mp = mc->mc_pg[mc->mc_top], *np;
2300 MDB_txn *txn = mc->mc_txn;
2301 MDB_cursor *m2, *m3;
2305 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
2306 if (txn->mt_flags & MDB_TXN_SPILLS) {
2308 rc = mdb_page_unspill(txn, mp, &np);
2314 if ((rc = mdb_midl_need(&txn->mt_free_pgs, 1)) ||
2315 (rc = mdb_page_alloc(mc, 1, &np)))
2318 DPRINTF(("touched db %d page %"Z"u -> %"Z"u", DDBI(mc),
2319 mp->mp_pgno, pgno));
2320 mdb_cassert(mc, mp->mp_pgno != pgno);
2321 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
2322 /* Update the parent page, if any, to point to the new page */
2324 MDB_page *parent = mc->mc_pg[mc->mc_top-1];
2325 MDB_node *node = NODEPTR(parent, mc->mc_ki[mc->mc_top-1]);
2326 SETPGNO(node, pgno);
2328 mc->mc_db->md_root = pgno;
2330 } else if (txn->mt_parent && !IS_SUBP(mp)) {
2331 MDB_ID2 mid, *dl = txn->mt_u.dirty_list;
2333 /* If txn has a parent, make sure the page is in our
2337 unsigned x = mdb_mid2l_search(dl, pgno);
2338 if (x <= dl[0].mid && dl[x].mid == pgno) {
2339 if (mp != dl[x].mptr) { /* bad cursor? */
2340 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
2341 txn->mt_flags |= MDB_TXN_ERROR;
2342 return MDB_CORRUPTED;
2347 mdb_cassert(mc, dl[0].mid < MDB_IDL_UM_MAX);
2349 np = mdb_page_malloc(txn, 1);
2354 rc = mdb_mid2l_insert(dl, &mid);
2355 mdb_cassert(mc, rc == 0);
2360 mdb_page_copy(np, mp, txn->mt_env->me_psize);
2362 np->mp_flags |= P_DIRTY;
2365 /* Adjust cursors pointing to mp */
2366 mc->mc_pg[mc->mc_top] = np;
2367 m2 = txn->mt_cursors[mc->mc_dbi];
2368 if (mc->mc_flags & C_SUB) {
2369 for (; m2; m2=m2->mc_next) {
2370 m3 = &m2->mc_xcursor->mx_cursor;
2371 if (m3->mc_snum < mc->mc_snum) continue;
2372 if (m3->mc_pg[mc->mc_top] == mp)
2373 m3->mc_pg[mc->mc_top] = np;
2376 for (; m2; m2=m2->mc_next) {
2377 if (m2->mc_snum < mc->mc_snum) continue;
2378 if (m2->mc_pg[mc->mc_top] == mp) {
2379 m2->mc_pg[mc->mc_top] = np;
2380 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
2382 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
2384 MDB_node *leaf = NODEPTR(np, mc->mc_ki[mc->mc_top]);
2385 if (!(leaf->mn_flags & F_SUBDATA))
2386 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
2394 txn->mt_flags |= MDB_TXN_ERROR;
2399 mdb_env_sync(MDB_env *env, int force)
2402 if (env->me_flags & MDB_RDONLY)
2404 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
2405 if (env->me_flags & MDB_WRITEMAP) {
2406 int flags = ((env->me_flags & MDB_MAPASYNC) && !force)
2407 ? MS_ASYNC : MS_SYNC;
2408 if (MDB_MSYNC(env->me_map, env->me_mapsize, flags))
2411 else if (flags == MS_SYNC && MDB_FDATASYNC(env->me_fd))
2415 #ifdef BROKEN_FDATASYNC
2416 if (env->me_flags & MDB_FSYNCONLY) {
2417 if (fsync(env->me_fd))
2421 if (MDB_FDATASYNC(env->me_fd))
2428 /** Back up parent txn's cursors, then grab the originals for tracking */
2430 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
2432 MDB_cursor *mc, *bk;
2437 for (i = src->mt_numdbs; --i >= 0; ) {
2438 if ((mc = src->mt_cursors[i]) != NULL) {
2439 size = sizeof(MDB_cursor);
2441 size += sizeof(MDB_xcursor);
2442 for (; mc; mc = bk->mc_next) {
2448 mc->mc_db = &dst->mt_dbs[i];
2449 /* Kill pointers into src - and dst to reduce abuse: The
2450 * user may not use mc until dst ends. Otherwise we'd...
2452 mc->mc_txn = NULL; /* ...set this to dst */
2453 mc->mc_dbflag = NULL; /* ...and &dst->mt_dbflags[i] */
2454 if ((mx = mc->mc_xcursor) != NULL) {
2455 *(MDB_xcursor *)(bk+1) = *mx;
2456 mx->mx_cursor.mc_txn = NULL; /* ...and dst. */
2458 mc->mc_next = dst->mt_cursors[i];
2459 dst->mt_cursors[i] = mc;
2466 /** Close this write txn's cursors, give parent txn's cursors back to parent.
2467 * @param[in] txn the transaction handle.
2468 * @param[in] merge true to keep changes to parent cursors, false to revert.
2469 * @return 0 on success, non-zero on failure.
2472 mdb_cursors_close(MDB_txn *txn, unsigned merge)
2474 MDB_cursor **cursors = txn->mt_cursors, *mc, *next, *bk;
2478 for (i = txn->mt_numdbs; --i >= 0; ) {
2479 for (mc = cursors[i]; mc; mc = next) {
2481 if ((bk = mc->mc_backup) != NULL) {
2483 /* Commit changes to parent txn */
2484 mc->mc_next = bk->mc_next;
2485 mc->mc_backup = bk->mc_backup;
2486 mc->mc_txn = bk->mc_txn;
2487 mc->mc_db = bk->mc_db;
2488 mc->mc_dbflag = bk->mc_dbflag;
2489 if ((mx = mc->mc_xcursor) != NULL)
2490 mx->mx_cursor.mc_txn = bk->mc_txn;
2492 /* Abort nested txn */
2494 if ((mx = mc->mc_xcursor) != NULL)
2495 *mx = *(MDB_xcursor *)(bk+1);
2499 /* Only malloced cursors are permanently tracked. */
2506 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2512 Pidset = F_SETLK, Pidcheck = F_GETLK
2516 /** Set or check a pid lock. Set returns 0 on success.
2517 * Check returns 0 if the process is certainly dead, nonzero if it may
2518 * be alive (the lock exists or an error happened so we do not know).
2520 * On Windows Pidset is a no-op, we merely check for the existence
2521 * of the process with the given pid. On POSIX we use a single byte
2522 * lock on the lockfile, set at an offset equal to the pid.
2525 mdb_reader_pid(MDB_env *env, enum Pidlock_op op, MDB_PID_T pid)
2527 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2530 if (op == Pidcheck) {
2531 h = OpenProcess(env->me_pidquery, FALSE, pid);
2532 /* No documented "no such process" code, but other program use this: */
2534 return ErrCode() != ERROR_INVALID_PARAMETER;
2535 /* A process exists until all handles to it close. Has it exited? */
2536 ret = WaitForSingleObject(h, 0) != 0;
2543 struct flock lock_info;
2544 memset(&lock_info, 0, sizeof(lock_info));
2545 lock_info.l_type = F_WRLCK;
2546 lock_info.l_whence = SEEK_SET;
2547 lock_info.l_start = pid;
2548 lock_info.l_len = 1;
2549 if ((rc = fcntl(env->me_lfd, op, &lock_info)) == 0) {
2550 if (op == F_GETLK && lock_info.l_type != F_UNLCK)
2552 } else if ((rc = ErrCode()) == EINTR) {
2560 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
2561 * @param[in] txn the transaction handle to initialize
2562 * @return 0 on success, non-zero on failure.
2565 mdb_txn_renew0(MDB_txn *txn)
2567 MDB_env *env = txn->mt_env;
2568 MDB_txninfo *ti = env->me_txns;
2570 unsigned int i, nr, flags = txn->mt_flags;
2572 int rc, new_notls = 0;
2574 if ((flags &= MDB_TXN_RDONLY) != 0) {
2576 meta = mdb_env_pick_meta(env);
2577 txn->mt_txnid = meta->mm_txnid;
2578 txn->mt_u.reader = NULL;
2580 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
2581 pthread_getspecific(env->me_txkey);
2583 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
2584 return MDB_BAD_RSLOT;
2586 MDB_PID_T pid = env->me_pid;
2587 MDB_THR_T tid = pthread_self();
2588 mdb_mutexref_t rmutex = env->me_rmutex;
2590 if (!env->me_live_reader) {
2591 rc = mdb_reader_pid(env, Pidset, pid);
2594 env->me_live_reader = 1;
2597 if (LOCK_MUTEX(rc, env, rmutex))
2599 nr = ti->mti_numreaders;
2600 for (i=0; i<nr; i++)
2601 if (ti->mti_readers[i].mr_pid == 0)
2603 if (i == env->me_maxreaders) {
2604 UNLOCK_MUTEX(rmutex);
2605 return MDB_READERS_FULL;
2607 r = &ti->mti_readers[i];
2608 /* Claim the reader slot, carefully since other code
2609 * uses the reader table un-mutexed: First reset the
2610 * slot, next publish it in mti_numreaders. After
2611 * that, it is safe for mdb_env_close() to touch it.
2612 * When it will be closed, we can finally claim it.
2615 r->mr_txnid = (txnid_t)-1;
2618 ti->mti_numreaders = ++nr;
2619 env->me_close_readers = nr;
2621 UNLOCK_MUTEX(rmutex);
2623 new_notls = (env->me_flags & MDB_NOTLS);
2624 if (!new_notls && (rc=pthread_setspecific(env->me_txkey, r))) {
2629 do /* LY: Retry on a race, ITS#7970. */
2630 r->mr_txnid = ti->mti_txnid;
2631 while(r->mr_txnid != ti->mti_txnid);
2632 txn->mt_txnid = r->mr_txnid;
2633 txn->mt_u.reader = r;
2634 meta = env->me_metas[txn->mt_txnid & 1];
2638 /* Not yet touching txn == env->me_txn0, it may be active */
2640 if (LOCK_MUTEX(rc, env, env->me_wmutex))
2642 txn->mt_txnid = ti->mti_txnid;
2643 meta = env->me_metas[txn->mt_txnid & 1];
2645 meta = mdb_env_pick_meta(env);
2646 txn->mt_txnid = meta->mm_txnid;
2650 if (txn->mt_txnid == mdb_debug_start)
2653 txn->mt_child = NULL;
2654 txn->mt_loose_pgs = NULL;
2655 txn->mt_loose_count = 0;
2656 txn->mt_dirty_room = MDB_IDL_UM_MAX;
2657 txn->mt_u.dirty_list = env->me_dirty_list;
2658 txn->mt_u.dirty_list[0].mid = 0;
2659 txn->mt_free_pgs = env->me_free_pgs;
2660 txn->mt_free_pgs[0] = 0;
2661 txn->mt_spill_pgs = NULL;
2663 memcpy(txn->mt_dbiseqs, env->me_dbiseqs, env->me_maxdbs * sizeof(unsigned int));
2666 /* Copy the DB info and flags */
2667 memcpy(txn->mt_dbs, meta->mm_dbs, 2 * sizeof(MDB_db));
2669 /* Moved to here to avoid a data race in read TXNs */
2670 txn->mt_next_pgno = meta->mm_last_pg+1;
2672 txn->mt_flags = flags;
2675 txn->mt_numdbs = env->me_numdbs;
2676 for (i=2; i<txn->mt_numdbs; i++) {
2677 x = env->me_dbflags[i];
2678 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
2679 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_USRVALID|DB_STALE : 0;
2681 txn->mt_dbflags[MAIN_DBI] = DB_VALID|DB_USRVALID;
2682 txn->mt_dbflags[FREE_DBI] = DB_VALID;
2684 if (env->me_flags & MDB_FATAL_ERROR) {
2685 DPUTS("environment had fatal error, must shutdown!");
2687 } else if (env->me_maxpg < txn->mt_next_pgno) {
2688 rc = MDB_MAP_RESIZED;
2692 mdb_txn_end(txn, new_notls /*0 or MDB_END_SLOT*/ | MDB_END_FAIL_BEGIN);
2697 mdb_txn_renew(MDB_txn *txn)
2701 if (!txn || !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY|MDB_TXN_FINISHED))
2704 rc = mdb_txn_renew0(txn);
2705 if (rc == MDB_SUCCESS) {
2706 DPRINTF(("renew txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2707 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2708 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root));
2714 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
2718 int rc, size, tsize;
2720 flags &= MDB_TXN_BEGIN_FLAGS;
2721 flags |= env->me_flags & MDB_WRITEMAP;
2723 if (env->me_flags & MDB_RDONLY & ~flags) /* write txn in RDONLY env */
2727 /* Nested transactions: Max 1 child, write txns only, no writemap */
2728 flags |= parent->mt_flags;
2729 if (flags & (MDB_RDONLY|MDB_WRITEMAP|MDB_TXN_BLOCKED)) {
2730 return (parent->mt_flags & MDB_TXN_RDONLY) ? EINVAL : MDB_BAD_TXN;
2732 /* Child txns save MDB_pgstate and use own copy of cursors */
2733 size = env->me_maxdbs * (sizeof(MDB_db)+sizeof(MDB_cursor *)+1);
2734 size += tsize = sizeof(MDB_ntxn);
2735 } else if (flags & MDB_RDONLY) {
2736 size = env->me_maxdbs * (sizeof(MDB_db)+1);
2737 size += tsize = sizeof(MDB_txn);
2739 /* Reuse preallocated write txn. However, do not touch it until
2740 * mdb_txn_renew0() succeeds, since it currently may be active.
2745 if ((txn = calloc(1, size)) == NULL) {
2746 DPRINTF(("calloc: %s", strerror(errno)));
2749 txn->mt_dbxs = env->me_dbxs; /* static */
2750 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
2751 txn->mt_dbflags = (unsigned char *)txn + size - env->me_maxdbs;
2752 txn->mt_flags = flags;
2757 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
2758 txn->mt_dbiseqs = parent->mt_dbiseqs;
2759 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
2760 if (!txn->mt_u.dirty_list ||
2761 !(txn->mt_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)))
2763 free(txn->mt_u.dirty_list);
2767 txn->mt_txnid = parent->mt_txnid;
2768 txn->mt_dirty_room = parent->mt_dirty_room;
2769 txn->mt_u.dirty_list[0].mid = 0;
2770 txn->mt_spill_pgs = NULL;
2771 txn->mt_next_pgno = parent->mt_next_pgno;
2772 parent->mt_flags |= MDB_TXN_HAS_CHILD;
2773 parent->mt_child = txn;
2774 txn->mt_parent = parent;
2775 txn->mt_numdbs = parent->mt_numdbs;
2776 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2777 /* Copy parent's mt_dbflags, but clear DB_NEW */
2778 for (i=0; i<txn->mt_numdbs; i++)
2779 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
2781 ntxn = (MDB_ntxn *)txn;
2782 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
2783 if (env->me_pghead) {
2784 size = MDB_IDL_SIZEOF(env->me_pghead);
2785 env->me_pghead = mdb_midl_alloc(env->me_pghead[0]);
2787 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
2792 rc = mdb_cursor_shadow(parent, txn);
2794 mdb_txn_end(txn, MDB_END_FAIL_BEGINCHILD);
2795 } else { /* MDB_RDONLY */
2796 txn->mt_dbiseqs = env->me_dbiseqs;
2798 rc = mdb_txn_renew0(txn);
2801 if (txn != env->me_txn0)
2804 txn->mt_flags |= flags; /* could not change txn=me_txn0 earlier */
2806 DPRINTF(("begin txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2807 txn->mt_txnid, (flags & MDB_RDONLY) ? 'r' : 'w',
2808 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root));
2815 mdb_txn_env(MDB_txn *txn)
2817 if(!txn) return NULL;
2822 mdb_txn_id(MDB_txn *txn)
2825 return txn->mt_txnid;
2828 /** Export or close DBI handles opened in this txn. */
2830 mdb_dbis_update(MDB_txn *txn, int keep)
2833 MDB_dbi n = txn->mt_numdbs;
2834 MDB_env *env = txn->mt_env;
2835 unsigned char *tdbflags = txn->mt_dbflags;
2837 for (i = n; --i >= 2;) {
2838 if (tdbflags[i] & DB_NEW) {
2840 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2842 char *ptr = env->me_dbxs[i].md_name.mv_data;
2844 env->me_dbxs[i].md_name.mv_data = NULL;
2845 env->me_dbxs[i].md_name.mv_size = 0;
2846 env->me_dbflags[i] = 0;
2847 env->me_dbiseqs[i]++;
2853 if (keep && env->me_numdbs < n)
2857 /** End a transaction, except successful commit of a nested transaction.
2858 * May be called twice for readonly txns: First reset it, then abort.
2859 * @param[in] txn the transaction handle to end
2860 * @param[in] mode why and how to end the transaction
2863 mdb_txn_end(MDB_txn *txn, unsigned mode)
2865 MDB_env *env = txn->mt_env;
2867 static const char *const names[] = MDB_END_NAMES;
2870 /* Export or close DBI handles opened in this txn */
2871 mdb_dbis_update(txn, mode & MDB_END_UPDATE);
2873 DPRINTF(("%s txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2874 names[mode & MDB_END_OPMASK],
2875 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2876 (void *) txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root));
2878 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2879 if (txn->mt_u.reader) {
2880 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
2881 if (!(env->me_flags & MDB_NOTLS)) {
2882 txn->mt_u.reader = NULL; /* txn does not own reader */
2883 } else if (mode & MDB_END_SLOT) {
2884 txn->mt_u.reader->mr_pid = 0;
2885 txn->mt_u.reader = NULL;
2886 } /* else txn owns the slot until it does MDB_END_SLOT */
2888 txn->mt_numdbs = 0; /* prevent further DBI activity */
2889 txn->mt_flags |= MDB_TXN_FINISHED;
2891 } else if (!F_ISSET(txn->mt_flags, MDB_TXN_FINISHED)) {
2892 pgno_t *pghead = env->me_pghead;
2894 if (!(mode & MDB_END_UPDATE)) /* !(already closed cursors) */
2895 mdb_cursors_close(txn, 0);
2896 if (!(env->me_flags & MDB_WRITEMAP)) {
2897 mdb_dlist_free(txn);
2901 txn->mt_flags = MDB_TXN_FINISHED;
2903 if (!txn->mt_parent) {
2904 mdb_midl_shrink(&txn->mt_free_pgs);
2905 env->me_free_pgs = txn->mt_free_pgs;
2907 env->me_pghead = NULL;
2911 mode = 0; /* txn == env->me_txn0, do not free() it */
2913 /* The writer mutex was locked in mdb_txn_begin. */
2915 UNLOCK_MUTEX(env->me_wmutex);
2917 txn->mt_parent->mt_child = NULL;
2918 txn->mt_parent->mt_flags &= ~MDB_TXN_HAS_CHILD;
2919 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2920 mdb_midl_free(txn->mt_free_pgs);
2921 mdb_midl_free(txn->mt_spill_pgs);
2922 free(txn->mt_u.dirty_list);
2925 mdb_midl_free(pghead);
2928 if (mode & MDB_END_FREE)
2933 mdb_txn_reset(MDB_txn *txn)
2938 /* This call is only valid for read-only txns */
2939 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2942 mdb_txn_end(txn, MDB_END_RESET);
2946 mdb_txn_abort(MDB_txn *txn)
2952 mdb_txn_abort(txn->mt_child);
2954 mdb_txn_end(txn, MDB_END_ABORT|MDB_END_SLOT|MDB_END_FREE);
2957 /** Save the freelist as of this transaction to the freeDB.
2958 * This changes the freelist. Keep trying until it stabilizes.
2961 mdb_freelist_save(MDB_txn *txn)
2963 /* env->me_pghead[] can grow and shrink during this call.
2964 * env->me_pglast and txn->mt_free_pgs[] can only grow.
2965 * Page numbers cannot disappear from txn->mt_free_pgs[].
2968 MDB_env *env = txn->mt_env;
2969 int rc, maxfree_1pg = env->me_maxfree_1pg, more = 1;
2970 txnid_t pglast = 0, head_id = 0;
2971 pgno_t freecnt = 0, *free_pgs, *mop;
2972 ssize_t head_room = 0, total_room = 0, mop_len, clean_limit;
2974 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
2976 if (env->me_pghead) {
2977 /* Make sure first page of freeDB is touched and on freelist */
2978 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST|MDB_PS_MODIFY);
2979 if (rc && rc != MDB_NOTFOUND)
2983 if (!env->me_pghead && txn->mt_loose_pgs) {
2984 /* Put loose page numbers in mt_free_pgs, since
2985 * we may be unable to return them to me_pghead.
2987 MDB_page *mp = txn->mt_loose_pgs;
2988 if ((rc = mdb_midl_need(&txn->mt_free_pgs, txn->mt_loose_count)) != 0)
2990 for (; mp; mp = NEXT_LOOSE_PAGE(mp))
2991 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
2992 txn->mt_loose_pgs = NULL;
2993 txn->mt_loose_count = 0;
2996 /* MDB_RESERVE cancels meminit in ovpage malloc (when no WRITEMAP) */
2997 clean_limit = (env->me_flags & (MDB_NOMEMINIT|MDB_WRITEMAP))
2998 ? SSIZE_MAX : maxfree_1pg;
3001 /* Come back here after each Put() in case freelist changed */
3006 /* If using records from freeDB which we have not yet
3007 * deleted, delete them and any we reserved for me_pghead.
3009 while (pglast < env->me_pglast) {
3010 rc = mdb_cursor_first(&mc, &key, NULL);
3013 pglast = head_id = *(txnid_t *)key.mv_data;
3014 total_room = head_room = 0;
3015 mdb_tassert(txn, pglast <= env->me_pglast);
3016 rc = mdb_cursor_del(&mc, 0);
3021 /* Save the IDL of pages freed by this txn, to a single record */
3022 if (freecnt < txn->mt_free_pgs[0]) {
3024 /* Make sure last page of freeDB is touched and on freelist */
3025 rc = mdb_page_search(&mc, NULL, MDB_PS_LAST|MDB_PS_MODIFY);
3026 if (rc && rc != MDB_NOTFOUND)
3029 free_pgs = txn->mt_free_pgs;
3030 /* Write to last page of freeDB */
3031 key.mv_size = sizeof(txn->mt_txnid);
3032 key.mv_data = &txn->mt_txnid;
3034 freecnt = free_pgs[0];
3035 data.mv_size = MDB_IDL_SIZEOF(free_pgs);
3036 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
3039 /* Retry if mt_free_pgs[] grew during the Put() */
3040 free_pgs = txn->mt_free_pgs;
3041 } while (freecnt < free_pgs[0]);
3042 mdb_midl_sort(free_pgs);
3043 memcpy(data.mv_data, free_pgs, data.mv_size);
3046 unsigned int i = free_pgs[0];
3047 DPRINTF(("IDL write txn %"Z"u root %"Z"u num %u",
3048 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, i));
3050 DPRINTF(("IDL %"Z"u", free_pgs[i]));
3056 mop = env->me_pghead;
3057 mop_len = (mop ? mop[0] : 0) + txn->mt_loose_count;
3059 /* Reserve records for me_pghead[]. Split it if multi-page,
3060 * to avoid searching freeDB for a page range. Use keys in
3061 * range [1,me_pglast]: Smaller than txnid of oldest reader.
3063 if (total_room >= mop_len) {
3064 if (total_room == mop_len || --more < 0)
3066 } else if (head_room >= maxfree_1pg && head_id > 1) {
3067 /* Keep current record (overflow page), add a new one */
3071 /* (Re)write {key = head_id, IDL length = head_room} */
3072 total_room -= head_room;
3073 head_room = mop_len - total_room;
3074 if (head_room > maxfree_1pg && head_id > 1) {
3075 /* Overflow multi-page for part of me_pghead */
3076 head_room /= head_id; /* amortize page sizes */
3077 head_room += maxfree_1pg - head_room % (maxfree_1pg + 1);
3078 } else if (head_room < 0) {
3079 /* Rare case, not bothering to delete this record */
3082 key.mv_size = sizeof(head_id);
3083 key.mv_data = &head_id;
3084 data.mv_size = (head_room + 1) * sizeof(pgno_t);
3085 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
3088 /* IDL is initially empty, zero out at least the length */
3089 pgs = (pgno_t *)data.mv_data;
3090 j = head_room > clean_limit ? head_room : 0;
3094 total_room += head_room;
3097 /* Return loose page numbers to me_pghead, though usually none are
3098 * left at this point. The pages themselves remain in dirty_list.
3100 if (txn->mt_loose_pgs) {
3101 MDB_page *mp = txn->mt_loose_pgs;
3102 unsigned count = txn->mt_loose_count;
3104 /* Room for loose pages + temp IDL with same */
3105 if ((rc = mdb_midl_need(&env->me_pghead, 2*count+1)) != 0)
3107 mop = env->me_pghead;
3108 loose = mop + MDB_IDL_ALLOCLEN(mop) - count;
3109 for (count = 0; mp; mp = NEXT_LOOSE_PAGE(mp))
3110 loose[ ++count ] = mp->mp_pgno;
3112 mdb_midl_sort(loose);
3113 mdb_midl_xmerge(mop, loose);
3114 txn->mt_loose_pgs = NULL;
3115 txn->mt_loose_count = 0;
3119 /* Fill in the reserved me_pghead records */
3125 rc = mdb_cursor_first(&mc, &key, &data);
3126 for (; !rc; rc = mdb_cursor_next(&mc, &key, &data, MDB_NEXT)) {
3127 txnid_t id = *(txnid_t *)key.mv_data;
3128 ssize_t len = (ssize_t)(data.mv_size / sizeof(MDB_ID)) - 1;
3131 mdb_tassert(txn, len >= 0 && id <= env->me_pglast);
3133 if (len > mop_len) {
3135 data.mv_size = (len + 1) * sizeof(MDB_ID);
3137 data.mv_data = mop -= len;
3140 rc = mdb_cursor_put(&mc, &key, &data, MDB_CURRENT);
3142 if (rc || !(mop_len -= len))
3149 /** Flush (some) dirty pages to the map, after clearing their dirty flag.
3150 * @param[in] txn the transaction that's being committed
3151 * @param[in] keep number of initial pages in dirty_list to keep dirty.
3152 * @return 0 on success, non-zero on failure.
3155 mdb_page_flush(MDB_txn *txn, int keep)
3157 MDB_env *env = txn->mt_env;
3158 MDB_ID2L dl = txn->mt_u.dirty_list;
3159 unsigned psize = env->me_psize, j;
3160 int i, pagecount = dl[0].mid, rc;
3161 size_t size = 0, pos = 0;
3163 MDB_page *dp = NULL;
3167 struct iovec iov[MDB_COMMIT_PAGES];
3168 ssize_t wpos = 0, wsize = 0, wres;
3169 size_t next_pos = 1; /* impossible pos, so pos != next_pos */
3175 if (env->me_flags & MDB_WRITEMAP) {
3176 /* Clear dirty flags */
3177 while (++i <= pagecount) {
3179 /* Don't flush this page yet */
3180 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3181 dp->mp_flags &= ~P_KEEP;
3185 dp->mp_flags &= ~P_DIRTY;
3190 /* Write the pages */
3192 if (++i <= pagecount) {
3194 /* Don't flush this page yet */
3195 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3196 dp->mp_flags &= ~P_KEEP;
3201 /* clear dirty flag */
3202 dp->mp_flags &= ~P_DIRTY;
3205 if (IS_OVERFLOW(dp)) size *= dp->mp_pages;
3210 /* Windows actually supports scatter/gather I/O, but only on
3211 * unbuffered file handles. Since we're relying on the OS page
3212 * cache for all our data, that's self-defeating. So we just
3213 * write pages one at a time. We use the ov structure to set
3214 * the write offset, to at least save the overhead of a Seek
3217 DPRINTF(("committing page %"Z"u", pgno));
3218 memset(&ov, 0, sizeof(ov));
3219 ov.Offset = pos & 0xffffffff;
3220 ov.OffsetHigh = pos >> 16 >> 16;
3221 if (!WriteFile(env->me_fd, dp, size, NULL, &ov)) {
3223 DPRINTF(("WriteFile: %d", rc));
3227 /* Write up to MDB_COMMIT_PAGES dirty pages at a time. */
3228 if (pos!=next_pos || n==MDB_COMMIT_PAGES || wsize+size>MAX_WRITE) {
3231 /* Write previous page(s) */
3232 #ifdef MDB_USE_PWRITEV
3233 wres = pwritev(env->me_fd, iov, n, wpos);
3236 wres = pwrite(env->me_fd, iov[0].iov_base, wsize, wpos);
3239 if (lseek(env->me_fd, wpos, SEEK_SET) == -1) {
3243 DPRINTF(("lseek: %s", strerror(rc)));
3246 wres = writev(env->me_fd, iov, n);
3249 if (wres != wsize) {
3254 DPRINTF(("Write error: %s", strerror(rc)));
3256 rc = EIO; /* TODO: Use which error code? */
3257 DPUTS("short write, filesystem full?");
3268 DPRINTF(("committing page %"Z"u", pgno));
3269 next_pos = pos + size;
3270 iov[n].iov_len = size;
3271 iov[n].iov_base = (char *)dp;
3277 /* MIPS has cache coherency issues, this is a no-op everywhere else
3278 * Note: for any size >= on-chip cache size, entire on-chip cache is
3281 CACHEFLUSH(env->me_map, txn->mt_next_pgno * env->me_psize, DCACHE);
3283 for (i = keep; ++i <= pagecount; ) {
3285 /* This is a page we skipped above */
3288 dl[j].mid = dp->mp_pgno;
3291 mdb_dpage_free(env, dp);
3296 txn->mt_dirty_room += i - j;
3302 mdb_txn_commit(MDB_txn *txn)
3305 unsigned int i, end_mode;
3311 /* mdb_txn_end() mode for a commit which writes nothing */
3312 end_mode = MDB_END_EMPTY_COMMIT|MDB_END_UPDATE|MDB_END_SLOT|MDB_END_FREE;
3314 if (txn->mt_child) {
3315 rc = mdb_txn_commit(txn->mt_child);
3322 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
3326 if (txn->mt_flags & (MDB_TXN_FINISHED|MDB_TXN_ERROR)) {
3327 DPUTS("txn has failed/finished, can't commit");
3329 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
3334 if (txn->mt_parent) {
3335 MDB_txn *parent = txn->mt_parent;
3339 unsigned x, y, len, ps_len;
3341 /* Append our free list to parent's */
3342 rc = mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs);
3345 mdb_midl_free(txn->mt_free_pgs);
3346 /* Failures after this must either undo the changes
3347 * to the parent or set MDB_TXN_ERROR in the parent.
3350 parent->mt_next_pgno = txn->mt_next_pgno;
3351 parent->mt_flags = txn->mt_flags;
3353 /* Merge our cursors into parent's and close them */
3354 mdb_cursors_close(txn, 1);
3356 /* Update parent's DB table. */
3357 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
3358 parent->mt_numdbs = txn->mt_numdbs;
3359 parent->mt_dbflags[0] = txn->mt_dbflags[0];
3360 parent->mt_dbflags[1] = txn->mt_dbflags[1];
3361 for (i=2; i<txn->mt_numdbs; i++) {
3362 /* preserve parent's DB_NEW status */
3363 x = parent->mt_dbflags[i] & DB_NEW;
3364 parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
3367 dst = parent->mt_u.dirty_list;
3368 src = txn->mt_u.dirty_list;
3369 /* Remove anything in our dirty list from parent's spill list */
3370 if ((pspill = parent->mt_spill_pgs) && (ps_len = pspill[0])) {
3372 pspill[0] = (pgno_t)-1;
3373 /* Mark our dirty pages as deleted in parent spill list */
3374 for (i=0, len=src[0].mid; ++i <= len; ) {
3375 MDB_ID pn = src[i].mid << 1;
3376 while (pn > pspill[x])
3378 if (pn == pspill[x]) {
3383 /* Squash deleted pagenums if we deleted any */
3384 for (x=y; ++x <= ps_len; )
3385 if (!(pspill[x] & 1))
3386 pspill[++y] = pspill[x];
3390 /* Find len = length of merging our dirty list with parent's */
3392 dst[0].mid = 0; /* simplify loops */
3393 if (parent->mt_parent) {
3394 len = x + src[0].mid;
3395 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
3396 for (i = x; y && i; y--) {
3397 pgno_t yp = src[y].mid;
3398 while (yp < dst[i].mid)
3400 if (yp == dst[i].mid) {
3405 } else { /* Simplify the above for single-ancestor case */
3406 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
3408 /* Merge our dirty list with parent's */
3410 for (i = len; y; dst[i--] = src[y--]) {
3411 pgno_t yp = src[y].mid;
3412 while (yp < dst[x].mid)
3413 dst[i--] = dst[x--];
3414 if (yp == dst[x].mid)
3415 free(dst[x--].mptr);
3417 mdb_tassert(txn, i == x);
3419 free(txn->mt_u.dirty_list);
3420 parent->mt_dirty_room = txn->mt_dirty_room;
3421 if (txn->mt_spill_pgs) {
3422 if (parent->mt_spill_pgs) {
3423 /* TODO: Prevent failure here, so parent does not fail */
3424 rc = mdb_midl_append_list(&parent->mt_spill_pgs, txn->mt_spill_pgs);
3426 parent->mt_flags |= MDB_TXN_ERROR;
3427 mdb_midl_free(txn->mt_spill_pgs);
3428 mdb_midl_sort(parent->mt_spill_pgs);
3430 parent->mt_spill_pgs = txn->mt_spill_pgs;
3434 /* Append our loose page list to parent's */
3435 for (lp = &parent->mt_loose_pgs; *lp; lp = &NEXT_LOOSE_PAGE(lp))
3437 *lp = txn->mt_loose_pgs;
3438 parent->mt_loose_count += txn->mt_loose_count;
3440 parent->mt_child = NULL;
3441 mdb_midl_free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pghead);
3446 if (txn != env->me_txn) {
3447 DPUTS("attempt to commit unknown transaction");
3452 mdb_cursors_close(txn, 0);
3454 if (!txn->mt_u.dirty_list[0].mid &&
3455 !(txn->mt_flags & (MDB_TXN_DIRTY|MDB_TXN_SPILLS)))
3458 DPRINTF(("committing txn %"Z"u %p on mdbenv %p, root page %"Z"u",
3459 txn->mt_txnid, (void*)txn, (void*)env, txn->mt_dbs[MAIN_DBI].md_root));
3461 /* Update DB root pointers */
3462 if (txn->mt_numdbs > 2) {
3466 data.mv_size = sizeof(MDB_db);
3468 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
3469 for (i = 2; i < txn->mt_numdbs; i++) {
3470 if (txn->mt_dbflags[i] & DB_DIRTY) {
3471 if (TXN_DBI_CHANGED(txn, i)) {
3475 data.mv_data = &txn->mt_dbs[i];
3476 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data,
3484 rc = mdb_freelist_save(txn);
3488 mdb_midl_free(env->me_pghead);
3489 env->me_pghead = NULL;
3490 mdb_midl_shrink(&txn->mt_free_pgs);
3496 if ((rc = mdb_page_flush(txn, 0)) ||
3497 (rc = mdb_env_sync(env, 0)) ||
3498 (rc = mdb_env_write_meta(txn)))
3500 end_mode = MDB_END_COMMITTED|MDB_END_UPDATE;
3503 mdb_txn_end(txn, end_mode);
3511 /** Read the environment parameters of a DB environment before
3512 * mapping it into memory.
3513 * @param[in] env the environment handle
3514 * @param[out] meta address of where to store the meta information
3515 * @return 0 on success, non-zero on failure.
3518 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
3524 enum { Size = sizeof(pbuf) };
3526 /* We don't know the page size yet, so use a minimum value.
3527 * Read both meta pages so we can use the latest one.
3530 for (i=off=0; i<2; i++, off = meta->mm_psize) {
3534 memset(&ov, 0, sizeof(ov));
3536 rc = ReadFile(env->me_fd, &pbuf, Size, &len, &ov) ? (int)len : -1;
3537 if (rc == -1 && ErrCode() == ERROR_HANDLE_EOF)
3540 rc = pread(env->me_fd, &pbuf, Size, off);
3543 if (rc == 0 && off == 0)
3545 rc = rc < 0 ? (int) ErrCode() : MDB_INVALID;
3546 DPRINTF(("read: %s", mdb_strerror(rc)));
3550 p = (MDB_page *)&pbuf;
3552 if (!F_ISSET(p->mp_flags, P_META)) {
3553 DPRINTF(("page %"Z"u not a meta page", p->mp_pgno));
3558 if (m->mm_magic != MDB_MAGIC) {
3559 DPUTS("meta has invalid magic");
3563 if (m->mm_version != MDB_DATA_VERSION) {
3564 DPRINTF(("database is version %u, expected version %u",
3565 m->mm_version, MDB_DATA_VERSION));
3566 return MDB_VERSION_MISMATCH;
3569 if (off == 0 || m->mm_txnid > meta->mm_txnid)
3575 /** Fill in most of the zeroed #MDB_meta for an empty database environment */
3577 mdb_env_init_meta0(MDB_env *env, MDB_meta *meta)
3579 meta->mm_magic = MDB_MAGIC;
3580 meta->mm_version = MDB_DATA_VERSION;
3581 meta->mm_mapsize = env->me_mapsize;
3582 meta->mm_psize = env->me_psize;
3583 meta->mm_last_pg = 1;
3584 meta->mm_flags = env->me_flags & 0xffff;
3585 meta->mm_flags |= MDB_INTEGERKEY;
3586 meta->mm_dbs[0].md_root = P_INVALID;
3587 meta->mm_dbs[1].md_root = P_INVALID;
3590 /** Write the environment parameters of a freshly created DB environment.
3591 * @param[in] env the environment handle
3592 * @param[in] meta the #MDB_meta to write
3593 * @return 0 on success, non-zero on failure.
3596 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
3604 memset(&ov, 0, sizeof(ov));
3605 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3607 rc = WriteFile(fd, ptr, size, &len, &ov); } while(0)
3610 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3611 len = pwrite(fd, ptr, size, pos); \
3612 if (len == -1 && ErrCode() == EINTR) continue; \
3613 rc = (len >= 0); break; } while(1)
3616 DPUTS("writing new meta page");
3618 psize = env->me_psize;
3620 p = calloc(2, psize);
3625 p->mp_flags = P_META;
3626 *(MDB_meta *)METADATA(p) = *meta;
3628 q = (MDB_page *)((char *)p + psize);
3630 q->mp_flags = P_META;
3631 *(MDB_meta *)METADATA(q) = *meta;
3633 DO_PWRITE(rc, env->me_fd, p, psize * 2, len, 0);
3636 else if ((unsigned) len == psize * 2)
3644 /** Update the environment info to commit a transaction.
3645 * @param[in] txn the transaction that's being committed
3646 * @return 0 on success, non-zero on failure.
3649 mdb_env_write_meta(MDB_txn *txn)
3652 MDB_meta meta, metab, *mp;
3656 int rc, len, toggle;
3665 toggle = txn->mt_txnid & 1;
3666 DPRINTF(("writing meta page %d for root page %"Z"u",
3667 toggle, txn->mt_dbs[MAIN_DBI].md_root));
3670 flags = env->me_flags;
3671 mp = env->me_metas[toggle];
3672 mapsize = env->me_metas[toggle ^ 1]->mm_mapsize;
3673 /* Persist any increases of mapsize config */
3674 if (mapsize < env->me_mapsize)
3675 mapsize = env->me_mapsize;
3677 if (flags & MDB_WRITEMAP) {
3678 mp->mm_mapsize = mapsize;
3679 mp->mm_dbs[0] = txn->mt_dbs[0];
3680 mp->mm_dbs[1] = txn->mt_dbs[1];
3681 mp->mm_last_pg = txn->mt_next_pgno - 1;
3682 #if (__GNUC__ * 100 + __GNUC_MINOR__ >= 404) && /* TODO: portability */ \
3683 !(defined(__i386__) || defined(__x86_64__))
3684 /* LY: issue a memory barrier, if not x86. ITS#7969 */
3685 __sync_synchronize();
3687 mp->mm_txnid = txn->mt_txnid;
3688 if (!(flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
3689 unsigned meta_size = env->me_psize;
3690 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
3693 #ifndef _WIN32 /* POSIX msync() requires ptr = start of OS page */
3694 if (meta_size < env->me_os_psize)
3695 meta_size += meta_size;
3700 if (MDB_MSYNC(ptr, meta_size, rc)) {
3707 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
3708 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
3710 meta.mm_mapsize = mapsize;
3711 meta.mm_dbs[0] = txn->mt_dbs[0];
3712 meta.mm_dbs[1] = txn->mt_dbs[1];
3713 meta.mm_last_pg = txn->mt_next_pgno - 1;
3714 meta.mm_txnid = txn->mt_txnid;
3716 off = offsetof(MDB_meta, mm_mapsize);
3717 ptr = (char *)&meta + off;
3718 len = sizeof(MDB_meta) - off;
3720 off += env->me_psize;
3723 /* Write to the SYNC fd */
3724 mfd = (flags & (MDB_NOSYNC|MDB_NOMETASYNC)) ? env->me_fd : env->me_mfd;
3727 memset(&ov, 0, sizeof(ov));
3729 if (!WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov))
3734 rc = pwrite(mfd, ptr, len, off);
3737 rc = rc < 0 ? ErrCode() : EIO;
3742 DPUTS("write failed, disk error?");
3743 /* On a failure, the pagecache still contains the new data.
3744 * Write some old data back, to prevent it from being used.
3745 * Use the non-SYNC fd; we know it will fail anyway.
3747 meta.mm_last_pg = metab.mm_last_pg;
3748 meta.mm_txnid = metab.mm_txnid;
3750 memset(&ov, 0, sizeof(ov));
3752 WriteFile(env->me_fd, ptr, len, NULL, &ov);
3754 r2 = pwrite(env->me_fd, ptr, len, off);
3755 (void)r2; /* Silence warnings. We don't care about pwrite's return value */
3758 env->me_flags |= MDB_FATAL_ERROR;
3761 /* MIPS has cache coherency issues, this is a no-op everywhere else */
3762 CACHEFLUSH(env->me_map + off, len, DCACHE);
3764 /* Memory ordering issues are irrelevant; since the entire writer
3765 * is wrapped by wmutex, all of these changes will become visible
3766 * after the wmutex is unlocked. Since the DB is multi-version,
3767 * readers will get consistent data regardless of how fresh or
3768 * how stale their view of these values is.
3771 env->me_txns->mti_txnid = txn->mt_txnid;
3776 /** Check both meta pages to see which one is newer.
3777 * @param[in] env the environment handle
3778 * @return newest #MDB_meta.
3781 mdb_env_pick_meta(const MDB_env *env)
3783 MDB_meta *const *metas = env->me_metas;
3784 return metas[ metas[0]->mm_txnid < metas[1]->mm_txnid ];
3788 mdb_env_create(MDB_env **env)
3792 e = calloc(1, sizeof(MDB_env));
3796 e->me_maxreaders = DEFAULT_READERS;
3797 e->me_maxdbs = e->me_numdbs = 2;
3798 e->me_fd = INVALID_HANDLE_VALUE;
3799 e->me_lfd = INVALID_HANDLE_VALUE;
3800 e->me_mfd = INVALID_HANDLE_VALUE;
3801 #ifdef MDB_USE_POSIX_SEM
3802 e->me_rmutex = SEM_FAILED;
3803 e->me_wmutex = SEM_FAILED;
3805 e->me_pid = getpid();
3806 GET_PAGESIZE(e->me_os_psize);
3807 VGMEMP_CREATE(e,0,0);
3813 mdb_env_map(MDB_env *env, void *addr)
3816 unsigned int flags = env->me_flags;
3820 LONG sizelo, sizehi;
3823 if (flags & MDB_RDONLY) {
3824 /* Don't set explicit map size, use whatever exists */
3829 msize = env->me_mapsize;
3830 sizelo = msize & 0xffffffff;
3831 sizehi = msize >> 16 >> 16; /* only needed on Win64 */
3833 /* Windows won't create mappings for zero length files.
3834 * and won't map more than the file size.
3835 * Just set the maxsize right now.
3837 if (SetFilePointer(env->me_fd, sizelo, &sizehi, 0) != (DWORD)sizelo
3838 || !SetEndOfFile(env->me_fd)
3839 || SetFilePointer(env->me_fd, 0, NULL, 0) != 0)
3843 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
3844 PAGE_READWRITE : PAGE_READONLY,
3845 sizehi, sizelo, NULL);
3848 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
3849 FILE_MAP_WRITE : FILE_MAP_READ,
3851 rc = env->me_map ? 0 : ErrCode();
3856 int prot = PROT_READ;
3857 if (flags & MDB_WRITEMAP) {
3859 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
3862 env->me_map = mmap(addr, env->me_mapsize, prot, MAP_SHARED,
3864 if (env->me_map == MAP_FAILED) {
3869 if (flags & MDB_NORDAHEAD) {
3870 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
3872 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
3874 #ifdef POSIX_MADV_RANDOM
3875 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
3876 #endif /* POSIX_MADV_RANDOM */
3877 #endif /* MADV_RANDOM */
3881 /* Can happen because the address argument to mmap() is just a
3882 * hint. mmap() can pick another, e.g. if the range is in use.
3883 * The MAP_FIXED flag would prevent that, but then mmap could
3884 * instead unmap existing pages to make room for the new map.
3886 if (addr && env->me_map != addr)
3887 return EBUSY; /* TODO: Make a new MDB_* error code? */
3889 p = (MDB_page *)env->me_map;
3890 env->me_metas[0] = METADATA(p);
3891 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + env->me_psize);
3897 mdb_env_set_mapsize(MDB_env *env, size_t size)
3899 /* If env is already open, caller is responsible for making
3900 * sure there are no active txns.
3908 meta = mdb_env_pick_meta(env);
3910 size = meta->mm_mapsize;
3912 /* Silently round up to minimum if the size is too small */
3913 size_t minsize = (meta->mm_last_pg + 1) * env->me_psize;
3917 munmap(env->me_map, env->me_mapsize);
3918 env->me_mapsize = size;
3919 old = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : NULL;
3920 rc = mdb_env_map(env, old);
3924 env->me_mapsize = size;
3926 env->me_maxpg = env->me_mapsize / env->me_psize;
3931 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
3935 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
3940 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
3942 if (env->me_map || readers < 1)
3944 env->me_maxreaders = readers;
3949 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
3951 if (!env || !readers)
3953 *readers = env->me_maxreaders;
3958 mdb_fsize(HANDLE fd, size_t *size)
3961 LARGE_INTEGER fsize;
3963 if (!GetFileSizeEx(fd, &fsize))
3966 *size = fsize.QuadPart;
3978 #ifdef BROKEN_FDATASYNC
3979 #include <sys/utsname.h>
3980 #include <sys/vfs.h>
3983 /** Further setup required for opening an LMDB environment
3986 mdb_env_open2(MDB_env *env)
3988 unsigned int flags = env->me_flags;
3989 int i, newenv = 0, rc;
3993 /* See if we should use QueryLimited */
3995 if ((rc & 0xff) > 5)
3996 env->me_pidquery = MDB_PROCESS_QUERY_LIMITED_INFORMATION;
3998 env->me_pidquery = PROCESS_QUERY_INFORMATION;
4001 #ifdef BROKEN_FDATASYNC
4002 /* ext3/ext4 fdatasync is broken on some older Linux kernels.
4003 * https://lkml.org/lkml/2012/9/3/83
4004 * Kernels after 3.6-rc6 are known good.
4005 * https://lkml.org/lkml/2012/9/10/556
4006 * See if the DB is on ext3/ext4, then check for new enough kernel
4007 * Kernels 2.6.32.60, 2.6.34.15, 3.2.30, and 3.5.4 are also known
4012 fstatfs(env->me_fd, &st);
4013 while (st.f_type == 0xEF53) {
4017 if (uts.release[0] < '3') {
4018 if (!strncmp(uts.release, "2.6.32.", 7)) {
4019 i = atoi(uts.release+7);
4021 break; /* 2.6.32.60 and newer is OK */
4022 } else if (!strncmp(uts.release, "2.6.34.", 7)) {
4023 i = atoi(uts.release+7);
4025 break; /* 2.6.34.15 and newer is OK */
4027 } else if (uts.release[0] == '3') {
4028 i = atoi(uts.release+2);
4030 break; /* 3.6 and newer is OK */
4032 i = atoi(uts.release+4);
4034 break; /* 3.5.4 and newer is OK */
4035 } else if (i == 2) {
4036 i = atoi(uts.release+4);
4038 break; /* 3.2.30 and newer is OK */
4040 } else { /* 4.x and newer is OK */
4043 env->me_flags |= MDB_FSYNCONLY;
4049 if ((i = mdb_env_read_header(env, &meta)) != 0) {
4052 DPUTS("new mdbenv");
4054 env->me_psize = env->me_os_psize;
4055 if (env->me_psize > MAX_PAGESIZE)
4056 env->me_psize = MAX_PAGESIZE;
4057 memset(&meta, 0, sizeof(meta));
4058 mdb_env_init_meta0(env, &meta);
4059 meta.mm_mapsize = DEFAULT_MAPSIZE;
4061 env->me_psize = meta.mm_psize;
4064 /* Was a mapsize configured? */
4065 if (!env->me_mapsize) {
4066 env->me_mapsize = meta.mm_mapsize;
4069 /* Make sure mapsize >= committed data size. Even when using
4070 * mm_mapsize, which could be broken in old files (ITS#7789).
4072 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
4073 if (env->me_mapsize < minsize)
4074 env->me_mapsize = minsize;
4076 meta.mm_mapsize = env->me_mapsize;
4078 if (newenv && !(flags & MDB_FIXEDMAP)) {
4079 /* mdb_env_map() may grow the datafile. Write the metapages
4080 * first, so the file will be valid if initialization fails.
4081 * Except with FIXEDMAP, since we do not yet know mm_address.
4082 * We could fill in mm_address later, but then a different
4083 * program might end up doing that - one with a memory layout
4084 * and map address which does not suit the main program.
4086 rc = mdb_env_init_meta(env, &meta);
4092 rc = mdb_env_map(env, (flags & MDB_FIXEDMAP) ? meta.mm_address : NULL);
4097 if (flags & MDB_FIXEDMAP)
4098 meta.mm_address = env->me_map;
4099 i = mdb_env_init_meta(env, &meta);
4100 if (i != MDB_SUCCESS) {
4105 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
4106 env->me_nodemax = (((env->me_psize - PAGEHDRSZ) / MDB_MINKEYS) & -2)
4108 #if !(MDB_MAXKEYSIZE)
4109 env->me_maxkey = env->me_nodemax - (NODESIZE + sizeof(MDB_db));
4111 env->me_maxpg = env->me_mapsize / env->me_psize;
4115 MDB_meta *meta = mdb_env_pick_meta(env);
4116 MDB_db *db = &meta->mm_dbs[MAIN_DBI];
4118 DPRINTF(("opened database version %u, pagesize %u",
4119 meta->mm_version, env->me_psize));
4120 DPRINTF(("using meta page %d", (int) (meta->mm_txnid & 1)));
4121 DPRINTF(("depth: %u", db->md_depth));
4122 DPRINTF(("entries: %"Z"u", db->md_entries));
4123 DPRINTF(("branch pages: %"Z"u", db->md_branch_pages));
4124 DPRINTF(("leaf pages: %"Z"u", db->md_leaf_pages));
4125 DPRINTF(("overflow pages: %"Z"u", db->md_overflow_pages));
4126 DPRINTF(("root: %"Z"u", db->md_root));
4134 /** Release a reader thread's slot in the reader lock table.
4135 * This function is called automatically when a thread exits.
4136 * @param[in] ptr This points to the slot in the reader lock table.
4139 mdb_env_reader_dest(void *ptr)
4141 MDB_reader *reader = ptr;
4147 /** Junk for arranging thread-specific callbacks on Windows. This is
4148 * necessarily platform and compiler-specific. Windows supports up
4149 * to 1088 keys. Let's assume nobody opens more than 64 environments
4150 * in a single process, for now. They can override this if needed.
4152 #ifndef MAX_TLS_KEYS
4153 #define MAX_TLS_KEYS 64
4155 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
4156 static int mdb_tls_nkeys;
4158 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
4162 case DLL_PROCESS_ATTACH: break;
4163 case DLL_THREAD_ATTACH: break;
4164 case DLL_THREAD_DETACH:
4165 for (i=0; i<mdb_tls_nkeys; i++) {
4166 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
4168 mdb_env_reader_dest(r);
4172 case DLL_PROCESS_DETACH: break;
4177 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
4179 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
4183 /* Force some symbol references.
4184 * _tls_used forces the linker to create the TLS directory if not already done
4185 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
4187 #pragma comment(linker, "/INCLUDE:_tls_used")
4188 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
4189 #pragma const_seg(".CRT$XLB")
4190 extern const PIMAGE_TLS_CALLBACK mdb_tls_cbp;
4191 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
4194 #pragma comment(linker, "/INCLUDE:__tls_used")
4195 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
4196 #pragma data_seg(".CRT$XLB")
4197 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
4199 #endif /* WIN 32/64 */
4200 #endif /* !__GNUC__ */
4203 /** Downgrade the exclusive lock on the region back to shared */
4205 mdb_env_share_locks(MDB_env *env, int *excl)
4208 MDB_meta *meta = mdb_env_pick_meta(env);
4210 env->me_txns->mti_txnid = meta->mm_txnid;
4215 /* First acquire a shared lock. The Unlock will
4216 * then release the existing exclusive lock.
4218 memset(&ov, 0, sizeof(ov));
4219 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
4222 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4228 struct flock lock_info;
4229 /* The shared lock replaces the existing lock */
4230 memset((void *)&lock_info, 0, sizeof(lock_info));
4231 lock_info.l_type = F_RDLCK;
4232 lock_info.l_whence = SEEK_SET;
4233 lock_info.l_start = 0;
4234 lock_info.l_len = 1;
4235 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
4236 (rc = ErrCode()) == EINTR) ;
4237 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
4244 /** Try to get exclusive lock, otherwise shared.
4245 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
4248 mdb_env_excl_lock(MDB_env *env, int *excl)
4252 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
4256 memset(&ov, 0, sizeof(ov));
4257 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
4264 struct flock lock_info;
4265 memset((void *)&lock_info, 0, sizeof(lock_info));
4266 lock_info.l_type = F_WRLCK;
4267 lock_info.l_whence = SEEK_SET;
4268 lock_info.l_start = 0;
4269 lock_info.l_len = 1;
4270 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
4271 (rc = ErrCode()) == EINTR) ;
4275 # ifndef MDB_USE_POSIX_MUTEX
4276 if (*excl < 0) /* always true when MDB_USE_POSIX_MUTEX */
4279 lock_info.l_type = F_RDLCK;
4280 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
4281 (rc = ErrCode()) == EINTR) ;
4291 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
4293 * @(#) $Revision: 5.1 $
4294 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
4295 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
4297 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
4301 * Please do not copyright this code. This code is in the public domain.
4303 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
4304 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
4305 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
4306 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
4307 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
4308 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4309 * PERFORMANCE OF THIS SOFTWARE.
4312 * chongo <Landon Curt Noll> /\oo/\
4313 * http://www.isthe.com/chongo/
4315 * Share and Enjoy! :-)
4318 typedef unsigned long long mdb_hash_t;
4319 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
4321 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
4322 * @param[in] val value to hash
4323 * @param[in] hval initial value for hash
4324 * @return 64 bit hash
4326 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
4327 * hval arg on the first call.
4330 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
4332 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
4333 unsigned char *end = s + val->mv_size;
4335 * FNV-1a hash each octet of the string
4338 /* xor the bottom with the current octet */
4339 hval ^= (mdb_hash_t)*s++;
4341 /* multiply by the 64 bit FNV magic prime mod 2^64 */
4342 hval += (hval << 1) + (hval << 4) + (hval << 5) +
4343 (hval << 7) + (hval << 8) + (hval << 40);
4345 /* return our new hash value */
4349 /** Hash the string and output the encoded hash.
4350 * This uses modified RFC1924 Ascii85 encoding to accommodate systems with
4351 * very short name limits. We don't care about the encoding being reversible,
4352 * we just want to preserve as many bits of the input as possible in a
4353 * small printable string.
4354 * @param[in] str string to hash
4355 * @param[out] encbuf an array of 11 chars to hold the hash
4357 static const char mdb_a85[]= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!#$%&()*+-;<=>?@^_`{|}~";
4360 mdb_pack85(unsigned long l, char *out)
4364 for (i=0; i<5; i++) {
4365 *out++ = mdb_a85[l % 85];
4371 mdb_hash_enc(MDB_val *val, char *encbuf)
4373 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
4375 mdb_pack85(h, encbuf);
4376 mdb_pack85(h>>32, encbuf+5);
4381 /** Open and/or initialize the lock region for the environment.
4382 * @param[in] env The LMDB environment.
4383 * @param[in] lpath The pathname of the file used for the lock region.
4384 * @param[in] mode The Unix permissions for the file, if we create it.
4385 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
4386 * @return 0 on success, non-zero on failure.
4389 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
4392 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
4394 # define MDB_ERRCODE_ROFS EROFS
4395 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
4396 # define MDB_CLOEXEC O_CLOEXEC
4399 # define MDB_CLOEXEC 0
4406 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
4407 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
4408 FILE_ATTRIBUTE_NORMAL, NULL);
4410 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
4412 if (env->me_lfd == INVALID_HANDLE_VALUE) {
4414 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
4419 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
4420 /* Lose record locks when exec*() */
4421 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
4422 fcntl(env->me_lfd, F_SETFD, fdflags);
4425 if (!(env->me_flags & MDB_NOTLS)) {
4426 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
4429 env->me_flags |= MDB_ENV_TXKEY;
4431 /* Windows TLS callbacks need help finding their TLS info. */
4432 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
4436 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
4440 /* Try to get exclusive lock. If we succeed, then
4441 * nobody is using the lock region and we should initialize it.
4443 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
4446 size = GetFileSize(env->me_lfd, NULL);
4448 size = lseek(env->me_lfd, 0, SEEK_END);
4449 if (size == -1) goto fail_errno;
4451 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
4452 if (size < rsize && *excl > 0) {
4454 if (SetFilePointer(env->me_lfd, rsize, NULL, FILE_BEGIN) != (DWORD)rsize
4455 || !SetEndOfFile(env->me_lfd))
4458 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
4462 size = rsize - sizeof(MDB_txninfo);
4463 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
4468 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
4470 if (!mh) goto fail_errno;
4471 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
4473 if (!env->me_txns) goto fail_errno;
4475 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
4477 if (m == MAP_FAILED) goto fail_errno;
4483 BY_HANDLE_FILE_INFORMATION stbuf;
4492 if (!mdb_sec_inited) {
4493 InitializeSecurityDescriptor(&mdb_null_sd,
4494 SECURITY_DESCRIPTOR_REVISION);
4495 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
4496 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
4497 mdb_all_sa.bInheritHandle = FALSE;
4498 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
4501 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
4502 idbuf.volume = stbuf.dwVolumeSerialNumber;
4503 idbuf.nhigh = stbuf.nFileIndexHigh;
4504 idbuf.nlow = stbuf.nFileIndexLow;
4505 val.mv_data = &idbuf;
4506 val.mv_size = sizeof(idbuf);
4507 mdb_hash_enc(&val, encbuf);
4508 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", encbuf);
4509 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", encbuf);
4510 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
4511 if (!env->me_rmutex) goto fail_errno;
4512 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
4513 if (!env->me_wmutex) goto fail_errno;
4514 #elif defined(MDB_USE_POSIX_SEM)
4523 #if defined(__NetBSD__)
4524 #define MDB_SHORT_SEMNAMES 1 /* limited to 14 chars */
4526 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
4527 idbuf.dev = stbuf.st_dev;
4528 idbuf.ino = stbuf.st_ino;
4529 val.mv_data = &idbuf;
4530 val.mv_size = sizeof(idbuf);
4531 mdb_hash_enc(&val, encbuf);
4532 #ifdef MDB_SHORT_SEMNAMES
4533 encbuf[9] = '\0'; /* drop name from 15 chars to 14 chars */
4535 sprintf(env->me_txns->mti_rmname, "/MDBr%s", encbuf);
4536 sprintf(env->me_txns->mti_wmname, "/MDBw%s", encbuf);
4537 /* Clean up after a previous run, if needed: Try to
4538 * remove both semaphores before doing anything else.
4540 sem_unlink(env->me_txns->mti_rmname);
4541 sem_unlink(env->me_txns->mti_wmname);
4542 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
4543 O_CREAT|O_EXCL, mode, 1);
4544 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4545 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
4546 O_CREAT|O_EXCL, mode, 1);
4547 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4548 #else /* MDB_USE_POSIX_MUTEX: */
4549 pthread_mutexattr_t mattr;
4551 if ((rc = pthread_mutexattr_init(&mattr))
4552 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
4553 #ifdef MDB_ROBUST_SUPPORTED
4554 || (rc = pthread_mutexattr_setrobust(&mattr, PTHREAD_MUTEX_ROBUST))
4556 || (rc = pthread_mutex_init(env->me_txns->mti_rmutex, &mattr))
4557 || (rc = pthread_mutex_init(env->me_txns->mti_wmutex, &mattr)))
4559 pthread_mutexattr_destroy(&mattr);
4560 #endif /* _WIN32 || MDB_USE_POSIX_SEM */
4562 env->me_txns->mti_magic = MDB_MAGIC;
4563 env->me_txns->mti_format = MDB_LOCK_FORMAT;
4564 env->me_txns->mti_txnid = 0;
4565 env->me_txns->mti_numreaders = 0;
4568 if (env->me_txns->mti_magic != MDB_MAGIC) {
4569 DPUTS("lock region has invalid magic");
4573 if (env->me_txns->mti_format != MDB_LOCK_FORMAT) {
4574 DPRINTF(("lock region has format+version 0x%x, expected 0x%x",
4575 env->me_txns->mti_format, MDB_LOCK_FORMAT));
4576 rc = MDB_VERSION_MISMATCH;
4580 if (rc && rc != EACCES && rc != EAGAIN) {
4584 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
4585 if (!env->me_rmutex) goto fail_errno;
4586 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
4587 if (!env->me_wmutex) goto fail_errno;
4588 #elif defined(MDB_USE_POSIX_SEM)
4589 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
4590 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4591 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
4592 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4603 /** The name of the lock file in the DB environment */
4604 #define LOCKNAME "/lock.mdb"
4605 /** The name of the data file in the DB environment */
4606 #define DATANAME "/data.mdb"
4607 /** The suffix of the lock file when no subdir is used */
4608 #define LOCKSUFF "-lock"
4609 /** Only a subset of the @ref mdb_env flags can be changed
4610 * at runtime. Changing other flags requires closing the
4611 * environment and re-opening it with the new flags.
4613 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC|MDB_NOMEMINIT)
4614 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY| \
4615 MDB_WRITEMAP|MDB_NOTLS|MDB_NOLOCK|MDB_NORDAHEAD)
4617 #if VALID_FLAGS & PERSISTENT_FLAGS & (CHANGEABLE|CHANGELESS)
4618 # error "Persistent DB flags & env flags overlap, but both go in mm_flags"
4622 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
4624 int oflags, rc, len, excl = -1;
4625 char *lpath, *dpath;
4627 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
4631 if (flags & MDB_NOSUBDIR) {
4632 rc = len + sizeof(LOCKSUFF) + len + 1;
4634 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
4639 if (flags & MDB_NOSUBDIR) {
4640 dpath = lpath + len + sizeof(LOCKSUFF);
4641 sprintf(lpath, "%s" LOCKSUFF, path);
4642 strcpy(dpath, path);
4644 dpath = lpath + len + sizeof(LOCKNAME);
4645 sprintf(lpath, "%s" LOCKNAME, path);
4646 sprintf(dpath, "%s" DATANAME, path);
4650 flags |= env->me_flags;
4651 if (flags & MDB_RDONLY) {
4652 /* silently ignore WRITEMAP when we're only getting read access */
4653 flags &= ~MDB_WRITEMAP;
4655 if (!((env->me_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)) &&
4656 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
4659 env->me_flags = flags |= MDB_ENV_ACTIVE;
4663 env->me_path = strdup(path);
4664 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
4665 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
4666 env->me_dbiseqs = calloc(env->me_maxdbs, sizeof(unsigned int));
4667 if (!(env->me_dbxs && env->me_path && env->me_dbflags && env->me_dbiseqs)) {
4671 env->me_dbxs[FREE_DBI].md_cmp = mdb_cmp_long; /* aligned MDB_INTEGERKEY */
4673 /* For RDONLY, get lockfile after we know datafile exists */
4674 if (!(flags & (MDB_RDONLY|MDB_NOLOCK))) {
4675 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4681 if (F_ISSET(flags, MDB_RDONLY)) {
4682 oflags = GENERIC_READ;
4683 len = OPEN_EXISTING;
4685 oflags = GENERIC_READ|GENERIC_WRITE;
4688 mode = FILE_ATTRIBUTE_NORMAL;
4689 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
4690 NULL, len, mode, NULL);
4692 if (F_ISSET(flags, MDB_RDONLY))
4695 oflags = O_RDWR | O_CREAT;
4697 env->me_fd = open(dpath, oflags, mode);
4699 if (env->me_fd == INVALID_HANDLE_VALUE) {
4704 if ((flags & (MDB_RDONLY|MDB_NOLOCK)) == MDB_RDONLY) {
4705 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4710 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
4711 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
4712 env->me_mfd = env->me_fd;
4714 /* Synchronous fd for meta writes. Needed even with
4715 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
4718 len = OPEN_EXISTING;
4719 env->me_mfd = CreateFile(dpath, oflags,
4720 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
4721 mode | FILE_FLAG_WRITE_THROUGH, NULL);
4724 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
4726 if (env->me_mfd == INVALID_HANDLE_VALUE) {
4731 DPRINTF(("opened dbenv %p", (void *) env));
4733 rc = mdb_env_share_locks(env, &excl);
4737 if (!(flags & MDB_RDONLY)) {
4739 int tsize = sizeof(MDB_txn), size = tsize + env->me_maxdbs *
4740 (sizeof(MDB_db)+sizeof(MDB_cursor *)+sizeof(unsigned int)+1);
4741 if ((env->me_pbuf = calloc(1, env->me_psize)) &&
4742 (txn = calloc(1, size)))
4744 txn->mt_dbs = (MDB_db *)((char *)txn + tsize);
4745 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
4746 txn->mt_dbiseqs = (unsigned int *)(txn->mt_cursors + env->me_maxdbs);
4747 txn->mt_dbflags = (unsigned char *)(txn->mt_dbiseqs + env->me_maxdbs);
4749 txn->mt_dbxs = env->me_dbxs;
4750 txn->mt_flags = MDB_TXN_FINISHED;
4760 mdb_env_close0(env, excl);
4766 /** Destroy resources from mdb_env_open(), clear our readers & DBIs */
4768 mdb_env_close0(MDB_env *env, int excl)
4772 if (!(env->me_flags & MDB_ENV_ACTIVE))
4775 /* Doing this here since me_dbxs may not exist during mdb_env_close */
4777 for (i = env->me_maxdbs; --i > MAIN_DBI; )
4778 free(env->me_dbxs[i].md_name.mv_data);
4783 free(env->me_dbiseqs);
4784 free(env->me_dbflags);
4786 free(env->me_dirty_list);
4788 mdb_midl_free(env->me_free_pgs);
4790 if (env->me_flags & MDB_ENV_TXKEY) {
4791 pthread_key_delete(env->me_txkey);
4793 /* Delete our key from the global list */
4794 for (i=0; i<mdb_tls_nkeys; i++)
4795 if (mdb_tls_keys[i] == env->me_txkey) {
4796 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
4804 munmap(env->me_map, env->me_mapsize);
4806 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
4807 (void) close(env->me_mfd);
4808 if (env->me_fd != INVALID_HANDLE_VALUE)
4809 (void) close(env->me_fd);
4811 MDB_PID_T pid = env->me_pid;
4812 /* Clearing readers is done in this function because
4813 * me_txkey with its destructor must be disabled first.
4815 * We skip the the reader mutex, so we touch only
4816 * data owned by this process (me_close_readers and
4817 * our readers), and clear each reader atomically.
4819 for (i = env->me_close_readers; --i >= 0; )
4820 if (env->me_txns->mti_readers[i].mr_pid == pid)
4821 env->me_txns->mti_readers[i].mr_pid = 0;
4823 if (env->me_rmutex) {
4824 CloseHandle(env->me_rmutex);
4825 if (env->me_wmutex) CloseHandle(env->me_wmutex);
4827 /* Windows automatically destroys the mutexes when
4828 * the last handle closes.
4830 #elif defined(MDB_USE_POSIX_SEM)
4831 if (env->me_rmutex != SEM_FAILED) {
4832 sem_close(env->me_rmutex);
4833 if (env->me_wmutex != SEM_FAILED)
4834 sem_close(env->me_wmutex);
4835 /* If we have the filelock: If we are the
4836 * only remaining user, clean up semaphores.
4839 mdb_env_excl_lock(env, &excl);
4841 sem_unlink(env->me_txns->mti_rmname);
4842 sem_unlink(env->me_txns->mti_wmname);
4846 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
4848 if (env->me_lfd != INVALID_HANDLE_VALUE) {
4851 /* Unlock the lockfile. Windows would have unlocked it
4852 * after closing anyway, but not necessarily at once.
4854 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4857 (void) close(env->me_lfd);
4860 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
4864 mdb_env_close(MDB_env *env)
4871 VGMEMP_DESTROY(env);
4872 while ((dp = env->me_dpages) != NULL) {
4873 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
4874 env->me_dpages = dp->mp_next;
4878 mdb_env_close0(env, 0);
4882 /** Compare two items pointing at aligned size_t's */
4884 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
4886 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
4887 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
4890 /** Compare two items pointing at aligned unsigned int's.
4892 * This is also set as #MDB_INTEGERDUP|#MDB_DUPFIXED's #MDB_dbx.%md_dcmp,
4893 * but #mdb_cmp_clong() is called instead if the data type is size_t.
4896 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
4898 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
4899 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
4902 /** Compare two items pointing at unsigned ints of unknown alignment.
4903 * Nodes and keys are guaranteed to be 2-byte aligned.
4906 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
4908 #if BYTE_ORDER == LITTLE_ENDIAN
4909 unsigned short *u, *c;
4912 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
4913 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
4916 } while(!x && u > (unsigned short *)a->mv_data);
4919 unsigned short *u, *c, *end;
4922 end = (unsigned short *) ((char *) a->mv_data + a->mv_size);
4923 u = (unsigned short *)a->mv_data;
4924 c = (unsigned short *)b->mv_data;
4927 } while(!x && u < end);
4932 /** Compare two items lexically */
4934 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
4941 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
4947 diff = memcmp(a->mv_data, b->mv_data, len);
4948 return diff ? diff : len_diff<0 ? -1 : len_diff;
4951 /** Compare two items in reverse byte order */
4953 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
4955 const unsigned char *p1, *p2, *p1_lim;
4959 p1_lim = (const unsigned char *)a->mv_data;
4960 p1 = (const unsigned char *)a->mv_data + a->mv_size;
4961 p2 = (const unsigned char *)b->mv_data + b->mv_size;
4963 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
4969 while (p1 > p1_lim) {
4970 diff = *--p1 - *--p2;
4974 return len_diff<0 ? -1 : len_diff;
4977 /** Search for key within a page, using binary search.
4978 * Returns the smallest entry larger or equal to the key.
4979 * If exactp is non-null, stores whether the found entry was an exact match
4980 * in *exactp (1 or 0).
4981 * Updates the cursor index with the index of the found entry.
4982 * If no entry larger or equal to the key is found, returns NULL.
4985 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
4987 unsigned int i = 0, nkeys;
4990 MDB_page *mp = mc->mc_pg[mc->mc_top];
4991 MDB_node *node = NULL;
4996 nkeys = NUMKEYS(mp);
4998 DPRINTF(("searching %u keys in %s %spage %"Z"u",
4999 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
5002 low = IS_LEAF(mp) ? 0 : 1;
5004 cmp = mc->mc_dbx->md_cmp;
5006 /* Branch pages have no data, so if using integer keys,
5007 * alignment is guaranteed. Use faster mdb_cmp_int.
5009 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
5010 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
5017 nodekey.mv_size = mc->mc_db->md_pad;
5018 node = NODEPTR(mp, 0); /* fake */
5019 while (low <= high) {
5020 i = (low + high) >> 1;
5021 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
5022 rc = cmp(key, &nodekey);
5023 DPRINTF(("found leaf index %u [%s], rc = %i",
5024 i, DKEY(&nodekey), rc));
5033 while (low <= high) {
5034 i = (low + high) >> 1;
5036 node = NODEPTR(mp, i);
5037 nodekey.mv_size = NODEKSZ(node);
5038 nodekey.mv_data = NODEKEY(node);
5040 rc = cmp(key, &nodekey);
5043 DPRINTF(("found leaf index %u [%s], rc = %i",
5044 i, DKEY(&nodekey), rc));
5046 DPRINTF(("found branch index %u [%s -> %"Z"u], rc = %i",
5047 i, DKEY(&nodekey), NODEPGNO(node), rc));
5058 if (rc > 0) { /* Found entry is less than the key. */
5059 i++; /* Skip to get the smallest entry larger than key. */
5061 node = NODEPTR(mp, i);
5064 *exactp = (rc == 0 && nkeys > 0);
5065 /* store the key index */
5066 mc->mc_ki[mc->mc_top] = i;
5068 /* There is no entry larger or equal to the key. */
5071 /* nodeptr is fake for LEAF2 */
5077 mdb_cursor_adjust(MDB_cursor *mc, func)
5081 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5082 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
5089 /** Pop a page off the top of the cursor's stack. */
5091 mdb_cursor_pop(MDB_cursor *mc)
5094 DPRINTF(("popping page %"Z"u off db %d cursor %p",
5095 mc->mc_pg[mc->mc_top]->mp_pgno, DDBI(mc), (void *) mc));
5103 /** Push a page onto the top of the cursor's stack. */
5105 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
5107 DPRINTF(("pushing page %"Z"u on db %d cursor %p", mp->mp_pgno,
5108 DDBI(mc), (void *) mc));
5110 if (mc->mc_snum >= CURSOR_STACK) {
5111 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5112 return MDB_CURSOR_FULL;
5115 mc->mc_top = mc->mc_snum++;
5116 mc->mc_pg[mc->mc_top] = mp;
5117 mc->mc_ki[mc->mc_top] = 0;
5122 /** Find the address of the page corresponding to a given page number.
5123 * @param[in] txn the transaction for this access.
5124 * @param[in] pgno the page number for the page to retrieve.
5125 * @param[out] ret address of a pointer where the page's address will be stored.
5126 * @param[out] lvl dirty_list inheritance level of found page. 1=current txn, 0=mapped page.
5127 * @return 0 on success, non-zero on failure.
5130 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret, int *lvl)
5132 MDB_env *env = txn->mt_env;
5136 if (! (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_WRITEMAP))) {
5140 MDB_ID2L dl = tx2->mt_u.dirty_list;
5142 /* Spilled pages were dirtied in this txn and flushed
5143 * because the dirty list got full. Bring this page
5144 * back in from the map (but don't unspill it here,
5145 * leave that unless page_touch happens again).
5147 if (tx2->mt_spill_pgs) {
5148 MDB_ID pn = pgno << 1;
5149 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
5150 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
5151 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
5156 unsigned x = mdb_mid2l_search(dl, pgno);
5157 if (x <= dl[0].mid && dl[x].mid == pgno) {
5163 } while ((tx2 = tx2->mt_parent) != NULL);
5166 if (pgno < txn->mt_next_pgno) {
5168 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
5170 DPRINTF(("page %"Z"u not found", pgno));
5171 txn->mt_flags |= MDB_TXN_ERROR;
5172 return MDB_PAGE_NOTFOUND;
5182 /** Finish #mdb_page_search() / #mdb_page_search_lowest().
5183 * The cursor is at the root page, set up the rest of it.
5186 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int flags)
5188 MDB_page *mp = mc->mc_pg[mc->mc_top];
5192 while (IS_BRANCH(mp)) {
5196 DPRINTF(("branch page %"Z"u has %u keys", mp->mp_pgno, NUMKEYS(mp)));
5197 mdb_cassert(mc, NUMKEYS(mp) > 1);
5198 DPRINTF(("found index 0 to page %"Z"u", NODEPGNO(NODEPTR(mp, 0))));
5200 if (flags & (MDB_PS_FIRST|MDB_PS_LAST)) {
5202 if (flags & MDB_PS_LAST)
5203 i = NUMKEYS(mp) - 1;
5206 node = mdb_node_search(mc, key, &exact);
5208 i = NUMKEYS(mp) - 1;
5210 i = mc->mc_ki[mc->mc_top];
5212 mdb_cassert(mc, i > 0);
5216 DPRINTF(("following index %u for key [%s]", i, DKEY(key)));
5219 mdb_cassert(mc, i < NUMKEYS(mp));
5220 node = NODEPTR(mp, i);
5222 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
5225 mc->mc_ki[mc->mc_top] = i;
5226 if ((rc = mdb_cursor_push(mc, mp)))
5229 if (flags & MDB_PS_MODIFY) {
5230 if ((rc = mdb_page_touch(mc)) != 0)
5232 mp = mc->mc_pg[mc->mc_top];
5237 DPRINTF(("internal error, index points to a %02X page!?",
5239 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5240 return MDB_CORRUPTED;
5243 DPRINTF(("found leaf page %"Z"u for key [%s]", mp->mp_pgno,
5244 key ? DKEY(key) : "null"));
5245 mc->mc_flags |= C_INITIALIZED;
5246 mc->mc_flags &= ~C_EOF;
5251 /** Search for the lowest key under the current branch page.
5252 * This just bypasses a NUMKEYS check in the current page
5253 * before calling mdb_page_search_root(), because the callers
5254 * are all in situations where the current page is known to
5258 mdb_page_search_lowest(MDB_cursor *mc)
5260 MDB_page *mp = mc->mc_pg[mc->mc_top];
5261 MDB_node *node = NODEPTR(mp, 0);
5264 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
5267 mc->mc_ki[mc->mc_top] = 0;
5268 if ((rc = mdb_cursor_push(mc, mp)))
5270 return mdb_page_search_root(mc, NULL, MDB_PS_FIRST);
5273 /** Search for the page a given key should be in.
5274 * Push it and its parent pages on the cursor stack.
5275 * @param[in,out] mc the cursor for this operation.
5276 * @param[in] key the key to search for, or NULL for first/last page.
5277 * @param[in] flags If MDB_PS_MODIFY is set, visited pages in the DB
5278 * are touched (updated with new page numbers).
5279 * If MDB_PS_FIRST or MDB_PS_LAST is set, find first or last leaf.
5280 * This is used by #mdb_cursor_first() and #mdb_cursor_last().
5281 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
5282 * @return 0 on success, non-zero on failure.
5285 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
5290 /* Make sure the txn is still viable, then find the root from
5291 * the txn's db table and set it as the root of the cursor's stack.
5293 if (mc->mc_txn->mt_flags & MDB_TXN_BLOCKED) {
5294 DPUTS("transaction may not be used now");
5297 /* Make sure we're using an up-to-date root */
5298 if (*mc->mc_dbflag & DB_STALE) {
5300 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
5302 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
5303 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, 0);
5310 MDB_node *leaf = mdb_node_search(&mc2,
5311 &mc->mc_dbx->md_name, &exact);
5313 return MDB_NOTFOUND;
5314 if ((leaf->mn_flags & (F_DUPDATA|F_SUBDATA)) != F_SUBDATA)
5315 return MDB_INCOMPATIBLE; /* not a named DB */
5316 rc = mdb_node_read(mc->mc_txn, leaf, &data);
5319 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
5321 /* The txn may not know this DBI, or another process may
5322 * have dropped and recreated the DB with other flags.
5324 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
5325 return MDB_INCOMPATIBLE;
5326 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
5328 *mc->mc_dbflag &= ~DB_STALE;
5330 root = mc->mc_db->md_root;
5332 if (root == P_INVALID) { /* Tree is empty. */
5333 DPUTS("tree is empty");
5334 return MDB_NOTFOUND;
5338 mdb_cassert(mc, root > 1);
5339 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
5340 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0], NULL)) != 0)
5346 DPRINTF(("db %d root page %"Z"u has flags 0x%X",
5347 DDBI(mc), root, mc->mc_pg[0]->mp_flags));
5349 if (flags & MDB_PS_MODIFY) {
5350 if ((rc = mdb_page_touch(mc)))
5354 if (flags & MDB_PS_ROOTONLY)
5357 return mdb_page_search_root(mc, key, flags);
5361 mdb_ovpage_free(MDB_cursor *mc, MDB_page *mp)
5363 MDB_txn *txn = mc->mc_txn;
5364 pgno_t pg = mp->mp_pgno;
5365 unsigned x = 0, ovpages = mp->mp_pages;
5366 MDB_env *env = txn->mt_env;
5367 MDB_IDL sl = txn->mt_spill_pgs;
5368 MDB_ID pn = pg << 1;
5371 DPRINTF(("free ov page %"Z"u (%d)", pg, ovpages));
5372 /* If the page is dirty or on the spill list we just acquired it,
5373 * so we should give it back to our current free list, if any.
5374 * Otherwise put it onto the list of pages we freed in this txn.
5376 * Won't create me_pghead: me_pglast must be inited along with it.
5377 * Unsupported in nested txns: They would need to hide the page
5378 * range in ancestor txns' dirty and spilled lists.
5380 if (env->me_pghead &&
5382 ((mp->mp_flags & P_DIRTY) ||
5383 (sl && (x = mdb_midl_search(sl, pn)) <= sl[0] && sl[x] == pn)))
5387 MDB_ID2 *dl, ix, iy;
5388 rc = mdb_midl_need(&env->me_pghead, ovpages);
5391 if (!(mp->mp_flags & P_DIRTY)) {
5392 /* This page is no longer spilled */
5399 /* Remove from dirty list */
5400 dl = txn->mt_u.dirty_list;
5402 for (ix = dl[x]; ix.mptr != mp; ix = iy) {
5408 mdb_cassert(mc, x > 1);
5410 dl[j] = ix; /* Unsorted. OK when MDB_TXN_ERROR. */
5411 txn->mt_flags |= MDB_TXN_ERROR;
5412 return MDB_CORRUPTED;
5415 if (!(env->me_flags & MDB_WRITEMAP))
5416 mdb_dpage_free(env, mp);
5418 /* Insert in me_pghead */
5419 mop = env->me_pghead;
5420 j = mop[0] + ovpages;
5421 for (i = mop[0]; i && mop[i] < pg; i--)
5427 rc = mdb_midl_append_range(&txn->mt_free_pgs, pg, ovpages);
5431 mc->mc_db->md_overflow_pages -= ovpages;
5435 /** Return the data associated with a given node.
5436 * @param[in] txn The transaction for this operation.
5437 * @param[in] leaf The node being read.
5438 * @param[out] data Updated to point to the node's data.
5439 * @return 0 on success, non-zero on failure.
5442 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
5444 MDB_page *omp; /* overflow page */
5448 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5449 data->mv_size = NODEDSZ(leaf);
5450 data->mv_data = NODEDATA(leaf);
5454 /* Read overflow data.
5456 data->mv_size = NODEDSZ(leaf);
5457 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
5458 if ((rc = mdb_page_get(txn, pgno, &omp, NULL)) != 0) {
5459 DPRINTF(("read overflow page %"Z"u failed", pgno));
5462 data->mv_data = METADATA(omp);
5468 mdb_get(MDB_txn *txn, MDB_dbi dbi,
5469 MDB_val *key, MDB_val *data)
5476 DPRINTF(("===> get db %u key [%s]", dbi, DKEY(key)));
5478 if (!key || !data || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
5481 if (txn->mt_flags & MDB_TXN_BLOCKED)
5484 mdb_cursor_init(&mc, txn, dbi, &mx);
5485 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
5488 /** Find a sibling for a page.
5489 * Replaces the page at the top of the cursor's stack with the
5490 * specified sibling, if one exists.
5491 * @param[in] mc The cursor for this operation.
5492 * @param[in] move_right Non-zero if the right sibling is requested,
5493 * otherwise the left sibling.
5494 * @return 0 on success, non-zero on failure.
5497 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
5503 if (mc->mc_snum < 2) {
5504 return MDB_NOTFOUND; /* root has no siblings */
5508 DPRINTF(("parent page is page %"Z"u, index %u",
5509 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]));
5511 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
5512 : (mc->mc_ki[mc->mc_top] == 0)) {
5513 DPRINTF(("no more keys left, moving to %s sibling",
5514 move_right ? "right" : "left"));
5515 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
5516 /* undo cursor_pop before returning */
5523 mc->mc_ki[mc->mc_top]++;
5525 mc->mc_ki[mc->mc_top]--;
5526 DPRINTF(("just moving to %s index key %u",
5527 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]));
5529 mdb_cassert(mc, IS_BRANCH(mc->mc_pg[mc->mc_top]));
5531 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5532 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp, NULL)) != 0) {
5533 /* mc will be inconsistent if caller does mc_snum++ as above */
5534 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
5538 mdb_cursor_push(mc, mp);
5540 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
5545 /** Move the cursor to the next data item. */
5547 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5553 if (mc->mc_flags & C_EOF) {
5554 return MDB_NOTFOUND;
5557 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5559 mp = mc->mc_pg[mc->mc_top];
5561 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5562 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5563 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5564 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
5565 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
5566 if (op != MDB_NEXT || rc != MDB_NOTFOUND) {
5567 if (rc == MDB_SUCCESS)
5568 MDB_GET_KEY(leaf, key);
5573 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5574 if (op == MDB_NEXT_DUP)
5575 return MDB_NOTFOUND;
5579 DPRINTF(("cursor_next: top page is %"Z"u in cursor %p",
5580 mdb_dbg_pgno(mp), (void *) mc));
5581 if (mc->mc_flags & C_DEL)
5584 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
5585 DPUTS("=====> move to next sibling page");
5586 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
5587 mc->mc_flags |= C_EOF;
5590 mp = mc->mc_pg[mc->mc_top];
5591 DPRINTF(("next page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5593 mc->mc_ki[mc->mc_top]++;
5596 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5597 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5600 key->mv_size = mc->mc_db->md_pad;
5601 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5605 mdb_cassert(mc, IS_LEAF(mp));
5606 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5608 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5609 mdb_xcursor_init1(mc, leaf);
5612 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5615 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5616 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5617 if (rc != MDB_SUCCESS)
5622 MDB_GET_KEY(leaf, key);
5626 /** Move the cursor to the previous data item. */
5628 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5634 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5636 mp = mc->mc_pg[mc->mc_top];
5638 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5639 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5640 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5641 if (op == MDB_PREV || op == MDB_PREV_DUP) {
5642 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
5643 if (op != MDB_PREV || rc != MDB_NOTFOUND) {
5644 if (rc == MDB_SUCCESS) {
5645 MDB_GET_KEY(leaf, key);
5646 mc->mc_flags &= ~C_EOF;
5652 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5653 if (op == MDB_PREV_DUP)
5654 return MDB_NOTFOUND;
5658 DPRINTF(("cursor_prev: top page is %"Z"u in cursor %p",
5659 mdb_dbg_pgno(mp), (void *) mc));
5661 if (mc->mc_ki[mc->mc_top] == 0) {
5662 DPUTS("=====> move to prev sibling page");
5663 if ((rc = mdb_cursor_sibling(mc, 0)) != MDB_SUCCESS) {
5666 mp = mc->mc_pg[mc->mc_top];
5667 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
5668 DPRINTF(("prev page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5670 mc->mc_ki[mc->mc_top]--;
5672 mc->mc_flags &= ~C_EOF;
5674 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5675 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5678 key->mv_size = mc->mc_db->md_pad;
5679 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5683 mdb_cassert(mc, IS_LEAF(mp));
5684 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5686 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5687 mdb_xcursor_init1(mc, leaf);
5690 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5693 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5694 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5695 if (rc != MDB_SUCCESS)
5700 MDB_GET_KEY(leaf, key);
5704 /** Set the cursor on a specific data item. */
5706 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5707 MDB_cursor_op op, int *exactp)
5711 MDB_node *leaf = NULL;
5714 if (key->mv_size == 0)
5715 return MDB_BAD_VALSIZE;
5718 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5720 /* See if we're already on the right page */
5721 if (mc->mc_flags & C_INITIALIZED) {
5724 mp = mc->mc_pg[mc->mc_top];
5726 mc->mc_ki[mc->mc_top] = 0;
5727 return MDB_NOTFOUND;
5729 if (mp->mp_flags & P_LEAF2) {
5730 nodekey.mv_size = mc->mc_db->md_pad;
5731 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
5733 leaf = NODEPTR(mp, 0);
5734 MDB_GET_KEY2(leaf, nodekey);
5736 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5738 /* Probably happens rarely, but first node on the page
5739 * was the one we wanted.
5741 mc->mc_ki[mc->mc_top] = 0;
5748 unsigned int nkeys = NUMKEYS(mp);
5750 if (mp->mp_flags & P_LEAF2) {
5751 nodekey.mv_data = LEAF2KEY(mp,
5752 nkeys-1, nodekey.mv_size);
5754 leaf = NODEPTR(mp, nkeys-1);
5755 MDB_GET_KEY2(leaf, nodekey);
5757 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5759 /* last node was the one we wanted */
5760 mc->mc_ki[mc->mc_top] = nkeys-1;
5766 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
5767 /* This is definitely the right page, skip search_page */
5768 if (mp->mp_flags & P_LEAF2) {
5769 nodekey.mv_data = LEAF2KEY(mp,
5770 mc->mc_ki[mc->mc_top], nodekey.mv_size);
5772 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5773 MDB_GET_KEY2(leaf, nodekey);
5775 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5777 /* current node was the one we wanted */
5787 /* If any parents have right-sibs, search.
5788 * Otherwise, there's nothing further.
5790 for (i=0; i<mc->mc_top; i++)
5792 NUMKEYS(mc->mc_pg[i])-1)
5794 if (i == mc->mc_top) {
5795 /* There are no other pages */
5796 mc->mc_ki[mc->mc_top] = nkeys;
5797 return MDB_NOTFOUND;
5801 /* There are no other pages */
5802 mc->mc_ki[mc->mc_top] = 0;
5803 if (op == MDB_SET_RANGE && !exactp) {
5807 return MDB_NOTFOUND;
5811 rc = mdb_page_search(mc, key, 0);
5812 if (rc != MDB_SUCCESS)
5815 mp = mc->mc_pg[mc->mc_top];
5816 mdb_cassert(mc, IS_LEAF(mp));
5819 leaf = mdb_node_search(mc, key, exactp);
5820 if (exactp != NULL && !*exactp) {
5821 /* MDB_SET specified and not an exact match. */
5822 return MDB_NOTFOUND;
5826 DPUTS("===> inexact leaf not found, goto sibling");
5827 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
5828 mc->mc_flags |= C_EOF;
5829 return rc; /* no entries matched */
5831 mp = mc->mc_pg[mc->mc_top];
5832 mdb_cassert(mc, IS_LEAF(mp));
5833 leaf = NODEPTR(mp, 0);
5837 mc->mc_flags |= C_INITIALIZED;
5838 mc->mc_flags &= ~C_EOF;
5841 if (op == MDB_SET_RANGE || op == MDB_SET_KEY) {
5842 key->mv_size = mc->mc_db->md_pad;
5843 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5848 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5849 mdb_xcursor_init1(mc, leaf);
5852 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5853 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
5854 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5857 if (op == MDB_GET_BOTH) {
5863 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
5864 if (rc != MDB_SUCCESS)
5867 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
5870 if ((rc = mdb_node_read(mc->mc_txn, leaf, &olddata)) != MDB_SUCCESS)
5872 dcmp = mc->mc_dbx->md_dcmp;
5873 #if UINT_MAX < SIZE_MAX
5874 if (dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
5875 dcmp = mdb_cmp_clong;
5877 rc = dcmp(data, &olddata);
5879 if (op == MDB_GET_BOTH || rc > 0)
5880 return MDB_NOTFOUND;
5887 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5888 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5893 /* The key already matches in all other cases */
5894 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
5895 MDB_GET_KEY(leaf, key);
5896 DPRINTF(("==> cursor placed on key [%s]", DKEY(key)));
5901 /** Move the cursor to the first item in the database. */
5903 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
5909 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5911 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
5912 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
5913 if (rc != MDB_SUCCESS)
5916 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
5918 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
5919 mc->mc_flags |= C_INITIALIZED;
5920 mc->mc_flags &= ~C_EOF;
5922 mc->mc_ki[mc->mc_top] = 0;
5924 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5925 key->mv_size = mc->mc_db->md_pad;
5926 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
5931 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5932 mdb_xcursor_init1(mc, leaf);
5933 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5937 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5941 MDB_GET_KEY(leaf, key);
5945 /** Move the cursor to the last item in the database. */
5947 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
5953 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5955 if (!(mc->mc_flags & C_EOF)) {
5957 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
5958 rc = mdb_page_search(mc, NULL, MDB_PS_LAST);
5959 if (rc != MDB_SUCCESS)
5962 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
5965 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
5966 mc->mc_flags |= C_INITIALIZED|C_EOF;
5967 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5969 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5970 key->mv_size = mc->mc_db->md_pad;
5971 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
5976 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5977 mdb_xcursor_init1(mc, leaf);
5978 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5982 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5987 MDB_GET_KEY(leaf, key);
5992 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5997 int (*mfunc)(MDB_cursor *mc, MDB_val *key, MDB_val *data);
6002 if (mc->mc_txn->mt_flags & MDB_TXN_BLOCKED)
6006 case MDB_GET_CURRENT:
6007 if (!(mc->mc_flags & C_INITIALIZED)) {
6010 MDB_page *mp = mc->mc_pg[mc->mc_top];
6011 int nkeys = NUMKEYS(mp);
6012 if (!nkeys || mc->mc_ki[mc->mc_top] >= nkeys) {
6013 mc->mc_ki[mc->mc_top] = nkeys;
6019 key->mv_size = mc->mc_db->md_pad;
6020 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
6022 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6023 MDB_GET_KEY(leaf, key);
6025 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6026 if (mc->mc_flags & C_DEL)
6027 mdb_xcursor_init1(mc, leaf);
6028 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
6030 rc = mdb_node_read(mc->mc_txn, leaf, data);
6037 case MDB_GET_BOTH_RANGE:
6042 if (mc->mc_xcursor == NULL) {
6043 rc = MDB_INCOMPATIBLE;
6053 rc = mdb_cursor_set(mc, key, data, op,
6054 op == MDB_SET_RANGE ? NULL : &exact);
6057 case MDB_GET_MULTIPLE:
6058 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
6062 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6063 rc = MDB_INCOMPATIBLE;
6067 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
6068 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
6071 case MDB_NEXT_MULTIPLE:
6076 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6077 rc = MDB_INCOMPATIBLE;
6080 if (!(mc->mc_flags & C_INITIALIZED))
6081 rc = mdb_cursor_first(mc, key, data);
6083 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
6084 if (rc == MDB_SUCCESS) {
6085 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
6088 mx = &mc->mc_xcursor->mx_cursor;
6089 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
6091 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
6092 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
6100 case MDB_NEXT_NODUP:
6101 if (!(mc->mc_flags & C_INITIALIZED))
6102 rc = mdb_cursor_first(mc, key, data);
6104 rc = mdb_cursor_next(mc, key, data, op);
6108 case MDB_PREV_NODUP:
6109 if (!(mc->mc_flags & C_INITIALIZED)) {
6110 rc = mdb_cursor_last(mc, key, data);
6113 mc->mc_flags |= C_INITIALIZED;
6114 mc->mc_ki[mc->mc_top]++;
6116 rc = mdb_cursor_prev(mc, key, data, op);
6119 rc = mdb_cursor_first(mc, key, data);
6122 mfunc = mdb_cursor_first;
6124 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
6128 if (mc->mc_xcursor == NULL) {
6129 rc = MDB_INCOMPATIBLE;
6133 MDB_node *leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6134 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6135 MDB_GET_KEY(leaf, key);
6136 rc = mdb_node_read(mc->mc_txn, leaf, data);
6140 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
6144 rc = mfunc(&mc->mc_xcursor->mx_cursor, data, NULL);
6147 rc = mdb_cursor_last(mc, key, data);
6150 mfunc = mdb_cursor_last;
6153 DPRINTF(("unhandled/unimplemented cursor operation %u", op));
6158 if (mc->mc_flags & C_DEL)
6159 mc->mc_flags ^= C_DEL;
6164 /** Touch all the pages in the cursor stack. Set mc_top.
6165 * Makes sure all the pages are writable, before attempting a write operation.
6166 * @param[in] mc The cursor to operate on.
6169 mdb_cursor_touch(MDB_cursor *mc)
6171 int rc = MDB_SUCCESS;
6173 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
6176 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
6178 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, &mcx);
6179 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
6182 *mc->mc_dbflag |= DB_DIRTY;
6187 rc = mdb_page_touch(mc);
6188 } while (!rc && ++(mc->mc_top) < mc->mc_snum);
6189 mc->mc_top = mc->mc_snum-1;
6194 /** Do not spill pages to disk if txn is getting full, may fail instead */
6195 #define MDB_NOSPILL 0x8000
6198 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
6202 MDB_node *leaf = NULL;
6203 MDB_page *fp, *mp, *sub_root = NULL;
6205 MDB_val xdata, *rdata, dkey, olddata;
6207 int do_sub = 0, insert_key, insert_data;
6208 unsigned int mcount = 0, dcount = 0, nospill;
6211 unsigned int nflags;
6214 if (mc == NULL || key == NULL)
6217 env = mc->mc_txn->mt_env;
6219 /* Check this first so counter will always be zero on any
6222 if (flags & MDB_MULTIPLE) {
6223 dcount = data[1].mv_size;
6224 data[1].mv_size = 0;
6225 if (!F_ISSET(mc->mc_db->md_flags, MDB_DUPFIXED))
6226 return MDB_INCOMPATIBLE;
6229 nospill = flags & MDB_NOSPILL;
6230 flags &= ~MDB_NOSPILL;
6232 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_BLOCKED))
6233 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6235 if (key->mv_size-1 >= ENV_MAXKEY(env))
6236 return MDB_BAD_VALSIZE;
6238 #if SIZE_MAX > MAXDATASIZE
6239 if (data->mv_size > ((mc->mc_db->md_flags & MDB_DUPSORT) ? ENV_MAXKEY(env) : MAXDATASIZE))
6240 return MDB_BAD_VALSIZE;
6242 if ((mc->mc_db->md_flags & MDB_DUPSORT) && data->mv_size > ENV_MAXKEY(env))
6243 return MDB_BAD_VALSIZE;
6246 DPRINTF(("==> put db %d key [%s], size %"Z"u, data size %"Z"u",
6247 DDBI(mc), DKEY(key), key ? key->mv_size : 0, data->mv_size));
6251 if (flags == MDB_CURRENT) {
6252 if (!(mc->mc_flags & C_INITIALIZED))
6255 } else if (mc->mc_db->md_root == P_INVALID) {
6256 /* new database, cursor has nothing to point to */
6259 mc->mc_flags &= ~C_INITIALIZED;
6264 if (flags & MDB_APPEND) {
6266 rc = mdb_cursor_last(mc, &k2, &d2);
6268 rc = mc->mc_dbx->md_cmp(key, &k2);
6271 mc->mc_ki[mc->mc_top]++;
6273 /* new key is <= last key */
6278 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
6280 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
6281 DPRINTF(("duplicate key [%s]", DKEY(key)));
6283 return MDB_KEYEXIST;
6285 if (rc && rc != MDB_NOTFOUND)
6289 if (mc->mc_flags & C_DEL)
6290 mc->mc_flags ^= C_DEL;
6292 /* Cursor is positioned, check for room in the dirty list */
6294 if (flags & MDB_MULTIPLE) {
6296 xdata.mv_size = data->mv_size * dcount;
6300 if ((rc2 = mdb_page_spill(mc, key, rdata)))
6304 if (rc == MDB_NO_ROOT) {
6306 /* new database, write a root leaf page */
6307 DPUTS("allocating new root leaf page");
6308 if ((rc2 = mdb_page_new(mc, P_LEAF, 1, &np))) {
6311 mdb_cursor_push(mc, np);
6312 mc->mc_db->md_root = np->mp_pgno;
6313 mc->mc_db->md_depth++;
6314 *mc->mc_dbflag |= DB_DIRTY;
6315 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
6317 np->mp_flags |= P_LEAF2;
6318 mc->mc_flags |= C_INITIALIZED;
6320 /* make sure all cursor pages are writable */
6321 rc2 = mdb_cursor_touch(mc);
6326 insert_key = insert_data = rc;
6328 /* The key does not exist */
6329 DPRINTF(("inserting key at index %i", mc->mc_ki[mc->mc_top]));
6330 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
6331 LEAFSIZE(key, data) > env->me_nodemax)
6333 /* Too big for a node, insert in sub-DB. Set up an empty
6334 * "old sub-page" for prep_subDB to expand to a full page.
6336 fp_flags = P_LEAF|P_DIRTY;
6338 fp->mp_pad = data->mv_size; /* used if MDB_DUPFIXED */
6339 fp->mp_lower = fp->mp_upper = (PAGEHDRSZ-PAGEBASE);
6340 olddata.mv_size = PAGEHDRSZ;
6344 /* there's only a key anyway, so this is a no-op */
6345 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6347 unsigned int ksize = mc->mc_db->md_pad;
6348 if (key->mv_size != ksize)
6349 return MDB_BAD_VALSIZE;
6350 ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
6351 memcpy(ptr, key->mv_data, ksize);
6353 /* if overwriting slot 0 of leaf, need to
6354 * update branch key if there is a parent page
6356 if (mc->mc_top && !mc->mc_ki[mc->mc_top]) {
6357 unsigned short top = mc->mc_top;
6359 /* slot 0 is always an empty key, find real slot */
6360 while (mc->mc_top && !mc->mc_ki[mc->mc_top])
6362 if (mc->mc_ki[mc->mc_top])
6363 rc2 = mdb_update_key(mc, key);
6374 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6375 olddata.mv_size = NODEDSZ(leaf);
6376 olddata.mv_data = NODEDATA(leaf);
6379 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
6380 /* Prepare (sub-)page/sub-DB to accept the new item,
6381 * if needed. fp: old sub-page or a header faking
6382 * it. mp: new (sub-)page. offset: growth in page
6383 * size. xdata: node data with new page or DB.
6385 unsigned i, offset = 0;
6386 mp = fp = xdata.mv_data = env->me_pbuf;
6387 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
6389 /* Was a single item before, must convert now */
6390 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6392 /* Just overwrite the current item */
6393 if (flags == MDB_CURRENT)
6395 dcmp = mc->mc_dbx->md_dcmp;
6396 #if UINT_MAX < SIZE_MAX
6397 if (dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
6398 dcmp = mdb_cmp_clong;
6400 /* does data match? */
6401 if (!dcmp(data, &olddata)) {
6402 if (flags & MDB_NODUPDATA)
6403 return MDB_KEYEXIST;
6408 /* Back up original data item */
6409 dkey.mv_size = olddata.mv_size;
6410 dkey.mv_data = memcpy(fp+1, olddata.mv_data, olddata.mv_size);
6412 /* Make sub-page header for the dup items, with dummy body */
6413 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
6414 fp->mp_lower = (PAGEHDRSZ-PAGEBASE);
6415 xdata.mv_size = PAGEHDRSZ + dkey.mv_size + data->mv_size;
6416 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6417 fp->mp_flags |= P_LEAF2;
6418 fp->mp_pad = data->mv_size;
6419 xdata.mv_size += 2 * data->mv_size; /* leave space for 2 more */
6421 xdata.mv_size += 2 * (sizeof(indx_t) + NODESIZE) +
6422 (dkey.mv_size & 1) + (data->mv_size & 1);
6424 fp->mp_upper = xdata.mv_size - PAGEBASE;
6425 olddata.mv_size = xdata.mv_size; /* pretend olddata is fp */
6426 } else if (leaf->mn_flags & F_SUBDATA) {
6427 /* Data is on sub-DB, just store it */
6428 flags |= F_DUPDATA|F_SUBDATA;
6431 /* Data is on sub-page */
6432 fp = olddata.mv_data;
6435 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6436 offset = EVEN(NODESIZE + sizeof(indx_t) +
6440 offset = fp->mp_pad;
6441 if (SIZELEFT(fp) < offset) {
6442 offset *= 4; /* space for 4 more */
6445 /* FALLTHRU: Big enough MDB_DUPFIXED sub-page */
6447 fp->mp_flags |= P_DIRTY;
6448 COPY_PGNO(fp->mp_pgno, mp->mp_pgno);
6449 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
6453 xdata.mv_size = olddata.mv_size + offset;
6456 fp_flags = fp->mp_flags;
6457 if (NODESIZE + NODEKSZ(leaf) + xdata.mv_size > env->me_nodemax) {
6458 /* Too big for a sub-page, convert to sub-DB */
6459 fp_flags &= ~P_SUBP;
6461 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6462 fp_flags |= P_LEAF2;
6463 dummy.md_pad = fp->mp_pad;
6464 dummy.md_flags = MDB_DUPFIXED;
6465 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
6466 dummy.md_flags |= MDB_INTEGERKEY;
6472 dummy.md_branch_pages = 0;
6473 dummy.md_leaf_pages = 1;
6474 dummy.md_overflow_pages = 0;
6475 dummy.md_entries = NUMKEYS(fp);
6476 xdata.mv_size = sizeof(MDB_db);
6477 xdata.mv_data = &dummy;
6478 if ((rc = mdb_page_alloc(mc, 1, &mp)))
6480 offset = env->me_psize - olddata.mv_size;
6481 flags |= F_DUPDATA|F_SUBDATA;
6482 dummy.md_root = mp->mp_pgno;
6486 mp->mp_flags = fp_flags | P_DIRTY;
6487 mp->mp_pad = fp->mp_pad;
6488 mp->mp_lower = fp->mp_lower;
6489 mp->mp_upper = fp->mp_upper + offset;
6490 if (fp_flags & P_LEAF2) {
6491 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
6493 memcpy((char *)mp + mp->mp_upper + PAGEBASE, (char *)fp + fp->mp_upper + PAGEBASE,
6494 olddata.mv_size - fp->mp_upper - PAGEBASE);
6495 for (i=0; i<NUMKEYS(fp); i++)
6496 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
6504 mdb_node_del(mc, 0);
6508 /* LMDB passes F_SUBDATA in 'flags' to write a DB record */
6509 if ((leaf->mn_flags ^ flags) & F_SUBDATA)
6510 return MDB_INCOMPATIBLE;
6511 /* overflow page overwrites need special handling */
6512 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6515 int level, ovpages, dpages = OVPAGES(data->mv_size, env->me_psize);
6517 memcpy(&pg, olddata.mv_data, sizeof(pg));
6518 if ((rc2 = mdb_page_get(mc->mc_txn, pg, &omp, &level)) != 0)
6520 ovpages = omp->mp_pages;
6522 /* Is the ov page large enough? */
6523 if (ovpages >= dpages) {
6524 if (!(omp->mp_flags & P_DIRTY) &&
6525 (level || (env->me_flags & MDB_WRITEMAP)))
6527 rc = mdb_page_unspill(mc->mc_txn, omp, &omp);
6530 level = 0; /* dirty in this txn or clean */
6533 if (omp->mp_flags & P_DIRTY) {
6534 /* yes, overwrite it. Note in this case we don't
6535 * bother to try shrinking the page if the new data
6536 * is smaller than the overflow threshold.
6539 /* It is writable only in a parent txn */
6540 size_t sz = (size_t) env->me_psize * ovpages, off;
6541 MDB_page *np = mdb_page_malloc(mc->mc_txn, ovpages);
6547 rc2 = mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &id2);
6548 mdb_cassert(mc, rc2 == 0);
6549 if (!(flags & MDB_RESERVE)) {
6550 /* Copy end of page, adjusting alignment so
6551 * compiler may copy words instead of bytes.
6553 off = (PAGEHDRSZ + data->mv_size) & -sizeof(size_t);
6554 memcpy((size_t *)((char *)np + off),
6555 (size_t *)((char *)omp + off), sz - off);
6558 memcpy(np, omp, sz); /* Copy beginning of page */
6561 SETDSZ(leaf, data->mv_size);
6562 if (F_ISSET(flags, MDB_RESERVE))
6563 data->mv_data = METADATA(omp);
6565 memcpy(METADATA(omp), data->mv_data, data->mv_size);
6569 if ((rc2 = mdb_ovpage_free(mc, omp)) != MDB_SUCCESS)
6571 } else if (data->mv_size == olddata.mv_size) {
6572 /* same size, just replace it. Note that we could
6573 * also reuse this node if the new data is smaller,
6574 * but instead we opt to shrink the node in that case.
6576 if (F_ISSET(flags, MDB_RESERVE))
6577 data->mv_data = olddata.mv_data;
6578 else if (!(mc->mc_flags & C_SUB))
6579 memcpy(olddata.mv_data, data->mv_data, data->mv_size);
6581 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
6586 mdb_node_del(mc, 0);
6592 nflags = flags & NODE_ADD_FLAGS;
6593 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(env, key, rdata);
6594 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
6595 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
6596 nflags &= ~MDB_APPEND; /* sub-page may need room to grow */
6598 nflags |= MDB_SPLIT_REPLACE;
6599 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
6601 /* There is room already in this leaf page. */
6602 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
6603 if (rc == 0 && insert_key) {
6604 /* Adjust other cursors pointing to mp */
6605 MDB_cursor *m2, *m3;
6606 MDB_dbi dbi = mc->mc_dbi;
6607 unsigned i = mc->mc_top;
6608 MDB_page *mp = mc->mc_pg[i];
6610 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6611 if (mc->mc_flags & C_SUB)
6612 m3 = &m2->mc_xcursor->mx_cursor;
6615 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
6616 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
6623 if (rc == MDB_SUCCESS) {
6624 /* Now store the actual data in the child DB. Note that we're
6625 * storing the user data in the keys field, so there are strict
6626 * size limits on dupdata. The actual data fields of the child
6627 * DB are all zero size.
6630 int xflags, new_dupdata;
6635 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6636 if (flags & MDB_CURRENT) {
6637 xflags = MDB_CURRENT|MDB_NOSPILL;
6639 mdb_xcursor_init1(mc, leaf);
6640 xflags = (flags & MDB_NODUPDATA) ?
6641 MDB_NOOVERWRITE|MDB_NOSPILL : MDB_NOSPILL;
6644 mc->mc_xcursor->mx_cursor.mc_pg[0] = sub_root;
6645 new_dupdata = (int)dkey.mv_size;
6646 /* converted, write the original data first */
6648 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
6651 /* we've done our job */
6654 if (!(leaf->mn_flags & F_SUBDATA) || sub_root) {
6655 /* Adjust other cursors pointing to mp */
6657 MDB_xcursor *mx = mc->mc_xcursor;
6658 unsigned i = mc->mc_top;
6659 MDB_page *mp = mc->mc_pg[i];
6661 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6662 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6663 if (!(m2->mc_flags & C_INITIALIZED)) continue;
6664 if (m2->mc_pg[i] == mp) {
6665 if (m2->mc_ki[i] == mc->mc_ki[i]) {
6666 mdb_xcursor_init2(m2, mx, new_dupdata);
6667 } else if (!insert_key) {
6668 MDB_node *n2 = NODEPTR(mp, m2->mc_ki[i]);
6669 if (!(n2->mn_flags & F_SUBDATA))
6670 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(n2);
6675 ecount = mc->mc_xcursor->mx_db.md_entries;
6676 if (flags & MDB_APPENDDUP)
6677 xflags |= MDB_APPEND;
6678 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
6679 if (flags & F_SUBDATA) {
6680 void *db = NODEDATA(leaf);
6681 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6683 insert_data = mc->mc_xcursor->mx_db.md_entries - ecount;
6685 /* Increment count unless we just replaced an existing item. */
6687 mc->mc_db->md_entries++;
6689 /* Invalidate txn if we created an empty sub-DB */
6692 /* If we succeeded and the key didn't exist before,
6693 * make sure the cursor is marked valid.
6695 mc->mc_flags |= C_INITIALIZED;
6697 if (flags & MDB_MULTIPLE) {
6700 /* let caller know how many succeeded, if any */
6701 data[1].mv_size = mcount;
6702 if (mcount < dcount) {
6703 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
6704 insert_key = insert_data = 0;
6711 if (rc == MDB_KEYEXIST) /* should not happen, we deleted that item */
6714 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6719 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
6725 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_BLOCKED))
6726 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6728 if (!(mc->mc_flags & C_INITIALIZED))
6731 if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6732 return MDB_NOTFOUND;
6734 if (!(flags & MDB_NOSPILL) && (rc = mdb_page_spill(mc, NULL, NULL)))
6737 rc = mdb_cursor_touch(mc);
6741 mp = mc->mc_pg[mc->mc_top];
6744 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6746 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6747 if (flags & MDB_NODUPDATA) {
6748 /* mdb_cursor_del0() will subtract the final entry */
6749 mc->mc_db->md_entries -= mc->mc_xcursor->mx_db.md_entries - 1;
6751 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
6752 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6754 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, MDB_NOSPILL);
6757 /* If sub-DB still has entries, we're done */
6758 if (mc->mc_xcursor->mx_db.md_entries) {
6759 if (leaf->mn_flags & F_SUBDATA) {
6760 /* update subDB info */
6761 void *db = NODEDATA(leaf);
6762 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6765 /* shrink fake page */
6766 mdb_node_shrink(mp, mc->mc_ki[mc->mc_top]);
6767 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6768 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6769 /* fix other sub-DB cursors pointed at fake pages on this page */
6770 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6771 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6772 if (!(m2->mc_flags & C_INITIALIZED)) continue;
6773 if (m2->mc_pg[mc->mc_top] == mp) {
6774 if (m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top]) {
6775 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6777 MDB_node *n2 = NODEPTR(mp, m2->mc_ki[mc->mc_top]);
6778 if (!(n2->mn_flags & F_SUBDATA))
6779 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(n2);
6784 mc->mc_db->md_entries--;
6785 mc->mc_flags |= C_DEL;
6788 /* otherwise fall thru and delete the sub-DB */
6791 if (leaf->mn_flags & F_SUBDATA) {
6792 /* add all the child DB's pages to the free list */
6793 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
6798 /* LMDB passes F_SUBDATA in 'flags' to delete a DB record */
6799 else if ((leaf->mn_flags ^ flags) & F_SUBDATA) {
6800 rc = MDB_INCOMPATIBLE;
6804 /* add overflow pages to free list */
6805 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6809 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6810 if ((rc = mdb_page_get(mc->mc_txn, pg, &omp, NULL)) ||
6811 (rc = mdb_ovpage_free(mc, omp)))
6816 return mdb_cursor_del0(mc);
6819 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6823 /** Allocate and initialize new pages for a database.
6824 * @param[in] mc a cursor on the database being added to.
6825 * @param[in] flags flags defining what type of page is being allocated.
6826 * @param[in] num the number of pages to allocate. This is usually 1,
6827 * unless allocating overflow pages for a large record.
6828 * @param[out] mp Address of a page, or NULL on failure.
6829 * @return 0 on success, non-zero on failure.
6832 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
6837 if ((rc = mdb_page_alloc(mc, num, &np)))
6839 DPRINTF(("allocated new mpage %"Z"u, page size %u",
6840 np->mp_pgno, mc->mc_txn->mt_env->me_psize));
6841 np->mp_flags = flags | P_DIRTY;
6842 np->mp_lower = (PAGEHDRSZ-PAGEBASE);
6843 np->mp_upper = mc->mc_txn->mt_env->me_psize - PAGEBASE;
6846 mc->mc_db->md_branch_pages++;
6847 else if (IS_LEAF(np))
6848 mc->mc_db->md_leaf_pages++;
6849 else if (IS_OVERFLOW(np)) {
6850 mc->mc_db->md_overflow_pages += num;
6858 /** Calculate the size of a leaf node.
6859 * The size depends on the environment's page size; if a data item
6860 * is too large it will be put onto an overflow page and the node
6861 * size will only include the key and not the data. Sizes are always
6862 * rounded up to an even number of bytes, to guarantee 2-byte alignment
6863 * of the #MDB_node headers.
6864 * @param[in] env The environment handle.
6865 * @param[in] key The key for the node.
6866 * @param[in] data The data for the node.
6867 * @return The number of bytes needed to store the node.
6870 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
6874 sz = LEAFSIZE(key, data);
6875 if (sz > env->me_nodemax) {
6876 /* put on overflow page */
6877 sz -= data->mv_size - sizeof(pgno_t);
6880 return EVEN(sz + sizeof(indx_t));
6883 /** Calculate the size of a branch node.
6884 * The size should depend on the environment's page size but since
6885 * we currently don't support spilling large keys onto overflow
6886 * pages, it's simply the size of the #MDB_node header plus the
6887 * size of the key. Sizes are always rounded up to an even number
6888 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
6889 * @param[in] env The environment handle.
6890 * @param[in] key The key for the node.
6891 * @return The number of bytes needed to store the node.
6894 mdb_branch_size(MDB_env *env, MDB_val *key)
6899 if (sz > env->me_nodemax) {
6900 /* put on overflow page */
6901 /* not implemented */
6902 /* sz -= key->size - sizeof(pgno_t); */
6905 return sz + sizeof(indx_t);
6908 /** Add a node to the page pointed to by the cursor.
6909 * @param[in] mc The cursor for this operation.
6910 * @param[in] indx The index on the page where the new node should be added.
6911 * @param[in] key The key for the new node.
6912 * @param[in] data The data for the new node, if any.
6913 * @param[in] pgno The page number, if adding a branch node.
6914 * @param[in] flags Flags for the node.
6915 * @return 0 on success, non-zero on failure. Possible errors are:
6917 * <li>ENOMEM - failed to allocate overflow pages for the node.
6918 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
6919 * should never happen since all callers already calculate the
6920 * page's free space before calling this function.
6924 mdb_node_add(MDB_cursor *mc, indx_t indx,
6925 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
6928 size_t node_size = NODESIZE;
6932 MDB_page *mp = mc->mc_pg[mc->mc_top];
6933 MDB_page *ofp = NULL; /* overflow page */
6937 mdb_cassert(mc, mp->mp_upper >= mp->mp_lower);
6939 DPRINTF(("add to %s %spage %"Z"u index %i, data size %"Z"u key size %"Z"u [%s]",
6940 IS_LEAF(mp) ? "leaf" : "branch",
6941 IS_SUBP(mp) ? "sub-" : "",
6942 mdb_dbg_pgno(mp), indx, data ? data->mv_size : 0,
6943 key ? key->mv_size : 0, key ? DKEY(key) : "null"));
6946 /* Move higher keys up one slot. */
6947 int ksize = mc->mc_db->md_pad, dif;
6948 char *ptr = LEAF2KEY(mp, indx, ksize);
6949 dif = NUMKEYS(mp) - indx;
6951 memmove(ptr+ksize, ptr, dif*ksize);
6952 /* insert new key */
6953 memcpy(ptr, key->mv_data, ksize);
6955 /* Just using these for counting */
6956 mp->mp_lower += sizeof(indx_t);
6957 mp->mp_upper -= ksize - sizeof(indx_t);
6961 room = (ssize_t)SIZELEFT(mp) - (ssize_t)sizeof(indx_t);
6963 node_size += key->mv_size;
6965 mdb_cassert(mc, key && data);
6966 if (F_ISSET(flags, F_BIGDATA)) {
6967 /* Data already on overflow page. */
6968 node_size += sizeof(pgno_t);
6969 } else if (node_size + data->mv_size > mc->mc_txn->mt_env->me_nodemax) {
6970 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
6972 /* Put data on overflow page. */
6973 DPRINTF(("data size is %"Z"u, node would be %"Z"u, put data on overflow page",
6974 data->mv_size, node_size+data->mv_size));
6975 node_size = EVEN(node_size + sizeof(pgno_t));
6976 if ((ssize_t)node_size > room)
6978 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
6980 DPRINTF(("allocated overflow page %"Z"u", ofp->mp_pgno));
6984 node_size += data->mv_size;
6987 node_size = EVEN(node_size);
6988 if ((ssize_t)node_size > room)
6992 /* Move higher pointers up one slot. */
6993 for (i = NUMKEYS(mp); i > indx; i--)
6994 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
6996 /* Adjust free space offsets. */
6997 ofs = mp->mp_upper - node_size;
6998 mdb_cassert(mc, ofs >= mp->mp_lower + sizeof(indx_t));
6999 mp->mp_ptrs[indx] = ofs;
7001 mp->mp_lower += sizeof(indx_t);
7003 /* Write the node data. */
7004 node = NODEPTR(mp, indx);
7005 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
7006 node->mn_flags = flags;
7008 SETDSZ(node,data->mv_size);
7013 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
7016 ndata = NODEDATA(node);
7018 if (F_ISSET(flags, F_BIGDATA))
7019 memcpy(ndata, data->mv_data, sizeof(pgno_t));
7020 else if (F_ISSET(flags, MDB_RESERVE))
7021 data->mv_data = ndata;
7023 memcpy(ndata, data->mv_data, data->mv_size);
7025 memcpy(ndata, &ofp->mp_pgno, sizeof(pgno_t));
7026 ndata = METADATA(ofp);
7027 if (F_ISSET(flags, MDB_RESERVE))
7028 data->mv_data = ndata;
7030 memcpy(ndata, data->mv_data, data->mv_size);
7037 DPRINTF(("not enough room in page %"Z"u, got %u ptrs",
7038 mdb_dbg_pgno(mp), NUMKEYS(mp)));
7039 DPRINTF(("upper-lower = %u - %u = %"Z"d", mp->mp_upper,mp->mp_lower,room));
7040 DPRINTF(("node size = %"Z"u", node_size));
7041 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
7042 return MDB_PAGE_FULL;
7045 /** Delete the specified node from a page.
7046 * @param[in] mc Cursor pointing to the node to delete.
7047 * @param[in] ksize The size of a node. Only used if the page is
7048 * part of a #MDB_DUPFIXED database.
7051 mdb_node_del(MDB_cursor *mc, int ksize)
7053 MDB_page *mp = mc->mc_pg[mc->mc_top];
7054 indx_t indx = mc->mc_ki[mc->mc_top];
7056 indx_t i, j, numkeys, ptr;
7060 DPRINTF(("delete node %u on %s page %"Z"u", indx,
7061 IS_LEAF(mp) ? "leaf" : "branch", mdb_dbg_pgno(mp)));
7062 numkeys = NUMKEYS(mp);
7063 mdb_cassert(mc, indx < numkeys);
7066 int x = numkeys - 1 - indx;
7067 base = LEAF2KEY(mp, indx, ksize);
7069 memmove(base, base + ksize, x * ksize);
7070 mp->mp_lower -= sizeof(indx_t);
7071 mp->mp_upper += ksize - sizeof(indx_t);
7075 node = NODEPTR(mp, indx);
7076 sz = NODESIZE + node->mn_ksize;
7078 if (F_ISSET(node->mn_flags, F_BIGDATA))
7079 sz += sizeof(pgno_t);
7081 sz += NODEDSZ(node);
7085 ptr = mp->mp_ptrs[indx];
7086 for (i = j = 0; i < numkeys; i++) {
7088 mp->mp_ptrs[j] = mp->mp_ptrs[i];
7089 if (mp->mp_ptrs[i] < ptr)
7090 mp->mp_ptrs[j] += sz;
7095 base = (char *)mp + mp->mp_upper + PAGEBASE;
7096 memmove(base + sz, base, ptr - mp->mp_upper);
7098 mp->mp_lower -= sizeof(indx_t);
7102 /** Compact the main page after deleting a node on a subpage.
7103 * @param[in] mp The main page to operate on.
7104 * @param[in] indx The index of the subpage on the main page.
7107 mdb_node_shrink(MDB_page *mp, indx_t indx)
7112 indx_t delta, nsize, len, ptr;
7115 node = NODEPTR(mp, indx);
7116 sp = (MDB_page *)NODEDATA(node);
7117 delta = SIZELEFT(sp);
7118 nsize = NODEDSZ(node) - delta;
7120 /* Prepare to shift upward, set len = length(subpage part to shift) */
7124 return; /* do not make the node uneven-sized */
7126 xp = (MDB_page *)((char *)sp + delta); /* destination subpage */
7127 for (i = NUMKEYS(sp); --i >= 0; )
7128 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
7131 sp->mp_upper = sp->mp_lower;
7132 COPY_PGNO(sp->mp_pgno, mp->mp_pgno);
7133 SETDSZ(node, nsize);
7135 /* Shift <lower nodes...initial part of subpage> upward */
7136 base = (char *)mp + mp->mp_upper + PAGEBASE;
7137 memmove(base + delta, base, (char *)sp + len - base);
7139 ptr = mp->mp_ptrs[indx];
7140 for (i = NUMKEYS(mp); --i >= 0; ) {
7141 if (mp->mp_ptrs[i] <= ptr)
7142 mp->mp_ptrs[i] += delta;
7144 mp->mp_upper += delta;
7147 /** Initial setup of a sorted-dups cursor.
7148 * Sorted duplicates are implemented as a sub-database for the given key.
7149 * The duplicate data items are actually keys of the sub-database.
7150 * Operations on the duplicate data items are performed using a sub-cursor
7151 * initialized when the sub-database is first accessed. This function does
7152 * the preliminary setup of the sub-cursor, filling in the fields that
7153 * depend only on the parent DB.
7154 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
7157 mdb_xcursor_init0(MDB_cursor *mc)
7159 MDB_xcursor *mx = mc->mc_xcursor;
7161 mx->mx_cursor.mc_xcursor = NULL;
7162 mx->mx_cursor.mc_txn = mc->mc_txn;
7163 mx->mx_cursor.mc_db = &mx->mx_db;
7164 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
7165 mx->mx_cursor.mc_dbi = mc->mc_dbi;
7166 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
7167 mx->mx_cursor.mc_snum = 0;
7168 mx->mx_cursor.mc_top = 0;
7169 mx->mx_cursor.mc_flags = C_SUB;
7170 mx->mx_dbx.md_name.mv_size = 0;
7171 mx->mx_dbx.md_name.mv_data = NULL;
7172 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
7173 mx->mx_dbx.md_dcmp = NULL;
7174 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
7177 /** Final setup of a sorted-dups cursor.
7178 * Sets up the fields that depend on the data from the main cursor.
7179 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
7180 * @param[in] node The data containing the #MDB_db record for the
7181 * sorted-dup database.
7184 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
7186 MDB_xcursor *mx = mc->mc_xcursor;
7188 if (node->mn_flags & F_SUBDATA) {
7189 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
7190 mx->mx_cursor.mc_pg[0] = 0;
7191 mx->mx_cursor.mc_snum = 0;
7192 mx->mx_cursor.mc_top = 0;
7193 mx->mx_cursor.mc_flags = C_SUB;
7195 MDB_page *fp = NODEDATA(node);
7196 mx->mx_db.md_pad = 0;
7197 mx->mx_db.md_flags = 0;
7198 mx->mx_db.md_depth = 1;
7199 mx->mx_db.md_branch_pages = 0;
7200 mx->mx_db.md_leaf_pages = 1;
7201 mx->mx_db.md_overflow_pages = 0;
7202 mx->mx_db.md_entries = NUMKEYS(fp);
7203 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
7204 mx->mx_cursor.mc_snum = 1;
7205 mx->mx_cursor.mc_top = 0;
7206 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
7207 mx->mx_cursor.mc_pg[0] = fp;
7208 mx->mx_cursor.mc_ki[0] = 0;
7209 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
7210 mx->mx_db.md_flags = MDB_DUPFIXED;
7211 mx->mx_db.md_pad = fp->mp_pad;
7212 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
7213 mx->mx_db.md_flags |= MDB_INTEGERKEY;
7216 DPRINTF(("Sub-db -%u root page %"Z"u", mx->mx_cursor.mc_dbi,
7217 mx->mx_db.md_root));
7218 mx->mx_dbflag = DB_VALID|DB_USRVALID|DB_DIRTY; /* DB_DIRTY guides mdb_cursor_touch */
7219 #if UINT_MAX < SIZE_MAX
7220 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
7221 mx->mx_dbx.md_cmp = mdb_cmp_clong;
7226 /** Fixup a sorted-dups cursor due to underlying update.
7227 * Sets up some fields that depend on the data from the main cursor.
7228 * Almost the same as init1, but skips initialization steps if the
7229 * xcursor had already been used.
7230 * @param[in] mc The main cursor whose sorted-dups cursor is to be fixed up.
7231 * @param[in] src_mx The xcursor of an up-to-date cursor.
7232 * @param[in] new_dupdata True if converting from a non-#F_DUPDATA item.
7235 mdb_xcursor_init2(MDB_cursor *mc, MDB_xcursor *src_mx, int new_dupdata)
7237 MDB_xcursor *mx = mc->mc_xcursor;
7240 mx->mx_cursor.mc_snum = 1;
7241 mx->mx_cursor.mc_top = 0;
7242 mx->mx_cursor.mc_flags |= C_INITIALIZED;
7243 mx->mx_cursor.mc_ki[0] = 0;
7244 mx->mx_dbflag = DB_VALID|DB_USRVALID|DB_DIRTY; /* DB_DIRTY guides mdb_cursor_touch */
7245 #if UINT_MAX < SIZE_MAX
7246 mx->mx_dbx.md_cmp = src_mx->mx_dbx.md_cmp;
7248 } else if (!(mx->mx_cursor.mc_flags & C_INITIALIZED)) {
7251 mx->mx_db = src_mx->mx_db;
7252 mx->mx_cursor.mc_pg[0] = src_mx->mx_cursor.mc_pg[0];
7253 DPRINTF(("Sub-db -%u root page %"Z"u", mx->mx_cursor.mc_dbi,
7254 mx->mx_db.md_root));
7257 /** Initialize a cursor for a given transaction and database. */
7259 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
7262 mc->mc_backup = NULL;
7265 mc->mc_db = &txn->mt_dbs[dbi];
7266 mc->mc_dbx = &txn->mt_dbxs[dbi];
7267 mc->mc_dbflag = &txn->mt_dbflags[dbi];
7273 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
7274 mdb_tassert(txn, mx != NULL);
7275 mc->mc_xcursor = mx;
7276 mdb_xcursor_init0(mc);
7278 mc->mc_xcursor = NULL;
7280 if (*mc->mc_dbflag & DB_STALE) {
7281 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
7286 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
7289 size_t size = sizeof(MDB_cursor);
7291 if (!ret || !TXN_DBI_EXIST(txn, dbi, DB_VALID))
7294 if (txn->mt_flags & MDB_TXN_BLOCKED)
7297 /* Allow read access to the freelist */
7298 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
7301 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
7302 size += sizeof(MDB_xcursor);
7304 if ((mc = malloc(size)) != NULL) {
7305 mdb_cursor_init(mc, txn, dbi, (MDB_xcursor *)(mc + 1));
7306 if (txn->mt_cursors) {
7307 mc->mc_next = txn->mt_cursors[dbi];
7308 txn->mt_cursors[dbi] = mc;
7309 mc->mc_flags |= C_UNTRACK;
7321 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
7323 if (!mc || !TXN_DBI_EXIST(txn, mc->mc_dbi, DB_VALID))
7326 if ((mc->mc_flags & C_UNTRACK) || txn->mt_cursors)
7329 if (txn->mt_flags & MDB_TXN_BLOCKED)
7332 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
7336 /* Return the count of duplicate data items for the current key */
7338 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
7342 if (mc == NULL || countp == NULL)
7345 if (mc->mc_xcursor == NULL)
7346 return MDB_INCOMPATIBLE;
7348 if (mc->mc_txn->mt_flags & MDB_TXN_BLOCKED)
7351 if (!(mc->mc_flags & C_INITIALIZED))
7354 if (!mc->mc_snum || (mc->mc_flags & C_EOF))
7355 return MDB_NOTFOUND;
7357 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
7358 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
7361 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
7364 *countp = mc->mc_xcursor->mx_db.md_entries;
7370 mdb_cursor_close(MDB_cursor *mc)
7372 if (mc && !mc->mc_backup) {
7373 /* remove from txn, if tracked */
7374 if ((mc->mc_flags & C_UNTRACK) && mc->mc_txn->mt_cursors) {
7375 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
7376 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
7378 *prev = mc->mc_next;
7385 mdb_cursor_txn(MDB_cursor *mc)
7387 if (!mc) return NULL;
7392 mdb_cursor_dbi(MDB_cursor *mc)
7397 /** Replace the key for a branch node with a new key.
7398 * @param[in] mc Cursor pointing to the node to operate on.
7399 * @param[in] key The new key to use.
7400 * @return 0 on success, non-zero on failure.
7403 mdb_update_key(MDB_cursor *mc, MDB_val *key)
7409 int delta, ksize, oksize;
7410 indx_t ptr, i, numkeys, indx;
7413 indx = mc->mc_ki[mc->mc_top];
7414 mp = mc->mc_pg[mc->mc_top];
7415 node = NODEPTR(mp, indx);
7416 ptr = mp->mp_ptrs[indx];
7420 char kbuf2[DKBUF_MAXKEYSIZE*2+1];
7421 k2.mv_data = NODEKEY(node);
7422 k2.mv_size = node->mn_ksize;
7423 DPRINTF(("update key %u (ofs %u) [%s] to [%s] on page %"Z"u",
7425 mdb_dkey(&k2, kbuf2),
7431 /* Sizes must be 2-byte aligned. */
7432 ksize = EVEN(key->mv_size);
7433 oksize = EVEN(node->mn_ksize);
7434 delta = ksize - oksize;
7436 /* Shift node contents if EVEN(key length) changed. */
7438 if (delta > 0 && SIZELEFT(mp) < delta) {
7440 /* not enough space left, do a delete and split */
7441 DPRINTF(("Not enough room, delta = %d, splitting...", delta));
7442 pgno = NODEPGNO(node);
7443 mdb_node_del(mc, 0);
7444 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
7447 numkeys = NUMKEYS(mp);
7448 for (i = 0; i < numkeys; i++) {
7449 if (mp->mp_ptrs[i] <= ptr)
7450 mp->mp_ptrs[i] -= delta;
7453 base = (char *)mp + mp->mp_upper + PAGEBASE;
7454 len = ptr - mp->mp_upper + NODESIZE;
7455 memmove(base - delta, base, len);
7456 mp->mp_upper -= delta;
7458 node = NODEPTR(mp, indx);
7461 /* But even if no shift was needed, update ksize */
7462 if (node->mn_ksize != key->mv_size)
7463 node->mn_ksize = key->mv_size;
7466 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
7472 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
7474 /** Move a node from csrc to cdst.
7477 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
7484 unsigned short flags;
7488 /* Mark src and dst as dirty. */
7489 if ((rc = mdb_page_touch(csrc)) ||
7490 (rc = mdb_page_touch(cdst)))
7493 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7494 key.mv_size = csrc->mc_db->md_pad;
7495 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
7497 data.mv_data = NULL;
7501 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
7502 mdb_cassert(csrc, !((size_t)srcnode & 1));
7503 srcpg = NODEPGNO(srcnode);
7504 flags = srcnode->mn_flags;
7505 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7506 unsigned int snum = csrc->mc_snum;
7508 /* must find the lowest key below src */
7509 rc = mdb_page_search_lowest(csrc);
7512 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7513 key.mv_size = csrc->mc_db->md_pad;
7514 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7516 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7517 key.mv_size = NODEKSZ(s2);
7518 key.mv_data = NODEKEY(s2);
7520 csrc->mc_snum = snum--;
7521 csrc->mc_top = snum;
7523 key.mv_size = NODEKSZ(srcnode);
7524 key.mv_data = NODEKEY(srcnode);
7526 data.mv_size = NODEDSZ(srcnode);
7527 data.mv_data = NODEDATA(srcnode);
7529 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
7530 unsigned int snum = cdst->mc_snum;
7533 /* must find the lowest key below dst */
7534 mdb_cursor_copy(cdst, &mn);
7535 rc = mdb_page_search_lowest(&mn);
7538 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7539 bkey.mv_size = mn.mc_db->md_pad;
7540 bkey.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, bkey.mv_size);
7542 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7543 bkey.mv_size = NODEKSZ(s2);
7544 bkey.mv_data = NODEKEY(s2);
7546 mn.mc_snum = snum--;
7549 rc = mdb_update_key(&mn, &bkey);
7554 DPRINTF(("moving %s node %u [%s] on page %"Z"u to node %u on page %"Z"u",
7555 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
7556 csrc->mc_ki[csrc->mc_top],
7558 csrc->mc_pg[csrc->mc_top]->mp_pgno,
7559 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno));
7561 /* Add the node to the destination page.
7563 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
7564 if (rc != MDB_SUCCESS)
7567 /* Delete the node from the source page.
7569 mdb_node_del(csrc, key.mv_size);
7572 /* Adjust other cursors pointing to mp */
7573 MDB_cursor *m2, *m3;
7574 MDB_dbi dbi = csrc->mc_dbi;
7577 mp = cdst->mc_pg[csrc->mc_top];
7578 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7579 if (csrc->mc_flags & C_SUB)
7580 m3 = &m2->mc_xcursor->mx_cursor;
7583 if (m3 == cdst) continue;
7584 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] >=
7585 cdst->mc_ki[csrc->mc_top]) {
7586 m3->mc_ki[csrc->mc_top]++;
7590 mp = csrc->mc_pg[csrc->mc_top];
7591 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7592 if (csrc->mc_flags & C_SUB)
7593 m3 = &m2->mc_xcursor->mx_cursor;
7596 if (m3 == csrc) continue;
7597 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
7598 csrc->mc_ki[csrc->mc_top]) {
7599 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
7600 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
7605 /* Update the parent separators.
7607 if (csrc->mc_ki[csrc->mc_top] == 0) {
7608 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
7609 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7610 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7612 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7613 key.mv_size = NODEKSZ(srcnode);
7614 key.mv_data = NODEKEY(srcnode);
7616 DPRINTF(("update separator for source page %"Z"u to [%s]",
7617 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key)));
7618 mdb_cursor_copy(csrc, &mn);
7621 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7624 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7626 indx_t ix = csrc->mc_ki[csrc->mc_top];
7627 nullkey.mv_size = 0;
7628 csrc->mc_ki[csrc->mc_top] = 0;
7629 rc = mdb_update_key(csrc, &nullkey);
7630 csrc->mc_ki[csrc->mc_top] = ix;
7631 mdb_cassert(csrc, rc == MDB_SUCCESS);
7635 if (cdst->mc_ki[cdst->mc_top] == 0) {
7636 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
7637 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7638 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
7640 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
7641 key.mv_size = NODEKSZ(srcnode);
7642 key.mv_data = NODEKEY(srcnode);
7644 DPRINTF(("update separator for destination page %"Z"u to [%s]",
7645 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key)));
7646 mdb_cursor_copy(cdst, &mn);
7649 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7652 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
7654 indx_t ix = cdst->mc_ki[cdst->mc_top];
7655 nullkey.mv_size = 0;
7656 cdst->mc_ki[cdst->mc_top] = 0;
7657 rc = mdb_update_key(cdst, &nullkey);
7658 cdst->mc_ki[cdst->mc_top] = ix;
7659 mdb_cassert(cdst, rc == MDB_SUCCESS);
7666 /** Merge one page into another.
7667 * The nodes from the page pointed to by \b csrc will
7668 * be copied to the page pointed to by \b cdst and then
7669 * the \b csrc page will be freed.
7670 * @param[in] csrc Cursor pointing to the source page.
7671 * @param[in] cdst Cursor pointing to the destination page.
7672 * @return 0 on success, non-zero on failure.
7675 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
7677 MDB_page *psrc, *pdst;
7684 psrc = csrc->mc_pg[csrc->mc_top];
7685 pdst = cdst->mc_pg[cdst->mc_top];
7687 DPRINTF(("merging page %"Z"u into %"Z"u", psrc->mp_pgno, pdst->mp_pgno));
7689 mdb_cassert(csrc, csrc->mc_snum > 1); /* can't merge root page */
7690 mdb_cassert(csrc, cdst->mc_snum > 1);
7692 /* Mark dst as dirty. */
7693 if ((rc = mdb_page_touch(cdst)))
7696 /* Move all nodes from src to dst.
7698 j = nkeys = NUMKEYS(pdst);
7699 if (IS_LEAF2(psrc)) {
7700 key.mv_size = csrc->mc_db->md_pad;
7701 key.mv_data = METADATA(psrc);
7702 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7703 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
7704 if (rc != MDB_SUCCESS)
7706 key.mv_data = (char *)key.mv_data + key.mv_size;
7709 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7710 srcnode = NODEPTR(psrc, i);
7711 if (i == 0 && IS_BRANCH(psrc)) {
7714 mdb_cursor_copy(csrc, &mn);
7715 /* must find the lowest key below src */
7716 rc = mdb_page_search_lowest(&mn);
7719 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7720 key.mv_size = mn.mc_db->md_pad;
7721 key.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, key.mv_size);
7723 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7724 key.mv_size = NODEKSZ(s2);
7725 key.mv_data = NODEKEY(s2);
7728 key.mv_size = srcnode->mn_ksize;
7729 key.mv_data = NODEKEY(srcnode);
7732 data.mv_size = NODEDSZ(srcnode);
7733 data.mv_data = NODEDATA(srcnode);
7734 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
7735 if (rc != MDB_SUCCESS)
7740 DPRINTF(("dst page %"Z"u now has %u keys (%.1f%% filled)",
7741 pdst->mp_pgno, NUMKEYS(pdst),
7742 (float)PAGEFILL(cdst->mc_txn->mt_env, pdst) / 10));
7744 /* Unlink the src page from parent and add to free list.
7747 mdb_node_del(csrc, 0);
7748 if (csrc->mc_ki[csrc->mc_top] == 0) {
7750 rc = mdb_update_key(csrc, &key);
7758 psrc = csrc->mc_pg[csrc->mc_top];
7759 /* If not operating on FreeDB, allow this page to be reused
7760 * in this txn. Otherwise just add to free list.
7762 rc = mdb_page_loose(csrc, psrc);
7766 csrc->mc_db->md_leaf_pages--;
7768 csrc->mc_db->md_branch_pages--;
7770 /* Adjust other cursors pointing to mp */
7771 MDB_cursor *m2, *m3;
7772 MDB_dbi dbi = csrc->mc_dbi;
7774 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7775 if (csrc->mc_flags & C_SUB)
7776 m3 = &m2->mc_xcursor->mx_cursor;
7779 if (m3 == csrc) continue;
7780 if (m3->mc_snum < csrc->mc_snum) continue;
7781 if (m3->mc_pg[csrc->mc_top] == psrc) {
7782 m3->mc_pg[csrc->mc_top] = pdst;
7783 m3->mc_ki[csrc->mc_top] += nkeys;
7788 unsigned int snum = cdst->mc_snum;
7789 uint16_t depth = cdst->mc_db->md_depth;
7790 mdb_cursor_pop(cdst);
7791 rc = mdb_rebalance(cdst);
7792 /* Did the tree height change? */
7793 if (depth != cdst->mc_db->md_depth)
7794 snum += cdst->mc_db->md_depth - depth;
7795 cdst->mc_snum = snum;
7796 cdst->mc_top = snum-1;
7801 /** Copy the contents of a cursor.
7802 * @param[in] csrc The cursor to copy from.
7803 * @param[out] cdst The cursor to copy to.
7806 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
7810 cdst->mc_txn = csrc->mc_txn;
7811 cdst->mc_dbi = csrc->mc_dbi;
7812 cdst->mc_db = csrc->mc_db;
7813 cdst->mc_dbx = csrc->mc_dbx;
7814 cdst->mc_snum = csrc->mc_snum;
7815 cdst->mc_top = csrc->mc_top;
7816 cdst->mc_flags = csrc->mc_flags;
7818 for (i=0; i<csrc->mc_snum; i++) {
7819 cdst->mc_pg[i] = csrc->mc_pg[i];
7820 cdst->mc_ki[i] = csrc->mc_ki[i];
7824 /** Rebalance the tree after a delete operation.
7825 * @param[in] mc Cursor pointing to the page where rebalancing
7827 * @return 0 on success, non-zero on failure.
7830 mdb_rebalance(MDB_cursor *mc)
7834 unsigned int ptop, minkeys, thresh;
7838 if (IS_BRANCH(mc->mc_pg[mc->mc_top])) {
7843 thresh = FILL_THRESHOLD;
7845 DPRINTF(("rebalancing %s page %"Z"u (has %u keys, %.1f%% full)",
7846 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
7847 mdb_dbg_pgno(mc->mc_pg[mc->mc_top]), NUMKEYS(mc->mc_pg[mc->mc_top]),
7848 (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10));
7850 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= thresh &&
7851 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
7852 DPRINTF(("no need to rebalance page %"Z"u, above fill threshold",
7853 mdb_dbg_pgno(mc->mc_pg[mc->mc_top])));
7857 if (mc->mc_snum < 2) {
7858 MDB_page *mp = mc->mc_pg[0];
7860 DPUTS("Can't rebalance a subpage, ignoring");
7863 if (NUMKEYS(mp) == 0) {
7864 DPUTS("tree is completely empty");
7865 mc->mc_db->md_root = P_INVALID;
7866 mc->mc_db->md_depth = 0;
7867 mc->mc_db->md_leaf_pages = 0;
7868 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7871 /* Adjust cursors pointing to mp */
7874 mc->mc_flags &= ~C_INITIALIZED;
7876 MDB_cursor *m2, *m3;
7877 MDB_dbi dbi = mc->mc_dbi;
7879 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7880 if (mc->mc_flags & C_SUB)
7881 m3 = &m2->mc_xcursor->mx_cursor;
7884 if (m3->mc_snum < mc->mc_snum) continue;
7885 if (m3->mc_pg[0] == mp) {
7888 m3->mc_flags &= ~C_INITIALIZED;
7892 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
7894 DPUTS("collapsing root page!");
7895 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7898 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
7899 rc = mdb_page_get(mc->mc_txn,mc->mc_db->md_root,&mc->mc_pg[0],NULL);
7902 mc->mc_db->md_depth--;
7903 mc->mc_db->md_branch_pages--;
7904 mc->mc_ki[0] = mc->mc_ki[1];
7905 for (i = 1; i<mc->mc_db->md_depth; i++) {
7906 mc->mc_pg[i] = mc->mc_pg[i+1];
7907 mc->mc_ki[i] = mc->mc_ki[i+1];
7910 /* Adjust other cursors pointing to mp */
7911 MDB_cursor *m2, *m3;
7912 MDB_dbi dbi = mc->mc_dbi;
7914 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7915 if (mc->mc_flags & C_SUB)
7916 m3 = &m2->mc_xcursor->mx_cursor;
7919 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
7920 if (m3->mc_pg[0] == mp) {
7921 for (i=0; i<m3->mc_snum; i++) {
7922 m3->mc_pg[i] = m3->mc_pg[i+1];
7923 m3->mc_ki[i] = m3->mc_ki[i+1];
7931 DPUTS("root page doesn't need rebalancing");
7935 /* The parent (branch page) must have at least 2 pointers,
7936 * otherwise the tree is invalid.
7938 ptop = mc->mc_top-1;
7939 mdb_cassert(mc, NUMKEYS(mc->mc_pg[ptop]) > 1);
7941 /* Leaf page fill factor is below the threshold.
7942 * Try to move keys from left or right neighbor, or
7943 * merge with a neighbor page.
7948 mdb_cursor_copy(mc, &mn);
7949 mn.mc_xcursor = NULL;
7951 oldki = mc->mc_ki[mc->mc_top];
7952 if (mc->mc_ki[ptop] == 0) {
7953 /* We're the leftmost leaf in our parent.
7955 DPUTS("reading right neighbor");
7957 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
7958 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
7961 mn.mc_ki[mn.mc_top] = 0;
7962 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
7964 /* There is at least one neighbor to the left.
7966 DPUTS("reading left neighbor");
7968 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
7969 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
7972 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
7973 mc->mc_ki[mc->mc_top] = 0;
7976 DPRINTF(("found neighbor page %"Z"u (%u keys, %.1f%% full)",
7977 mn.mc_pg[mn.mc_top]->mp_pgno, NUMKEYS(mn.mc_pg[mn.mc_top]),
7978 (float)PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) / 10));
7980 /* If the neighbor page is above threshold and has enough keys,
7981 * move one key from it. Otherwise we should try to merge them.
7982 * (A branch page must never have less than 2 keys.)
7984 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= thresh && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys) {
7985 rc = mdb_node_move(&mn, mc);
7986 if (mc->mc_ki[mc->mc_top-1]) {
7990 if (mc->mc_ki[ptop] == 0) {
7991 rc = mdb_page_merge(&mn, mc);
7994 oldki += NUMKEYS(mn.mc_pg[mn.mc_top]);
7995 mn.mc_ki[mn.mc_top] += mc->mc_ki[mn.mc_top] + 1;
7996 /* We want mdb_rebalance to find mn when doing fixups */
7997 if (mc->mc_flags & C_SUB) {
7998 dummy.mc_next = mc->mc_txn->mt_cursors[mc->mc_dbi];
7999 mc->mc_txn->mt_cursors[mc->mc_dbi] = &dummy;
8000 dummy.mc_xcursor = (MDB_xcursor *)&mn;
8002 mn.mc_next = mc->mc_txn->mt_cursors[mc->mc_dbi];
8003 mc->mc_txn->mt_cursors[mc->mc_dbi] = &mn;
8005 rc = mdb_page_merge(mc, &mn);
8006 if (mc->mc_flags & C_SUB)
8007 mc->mc_txn->mt_cursors[mc->mc_dbi] = dummy.mc_next;
8009 mc->mc_txn->mt_cursors[mc->mc_dbi] = mn.mc_next;
8010 mdb_cursor_copy(&mn, mc);
8012 mc->mc_flags &= ~C_EOF;
8014 mc->mc_ki[mc->mc_top] = oldki;
8018 /** Complete a delete operation started by #mdb_cursor_del(). */
8020 mdb_cursor_del0(MDB_cursor *mc)
8026 MDB_cursor *m2, *m3;
8027 MDB_dbi dbi = mc->mc_dbi;
8029 ki = mc->mc_ki[mc->mc_top];
8030 mp = mc->mc_pg[mc->mc_top];
8031 mdb_node_del(mc, mc->mc_db->md_pad);
8032 mc->mc_db->md_entries--;
8034 /* Adjust other cursors pointing to mp */
8035 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
8036 m3 = (mc->mc_flags & C_SUB) ? &m2->mc_xcursor->mx_cursor : m2;
8037 if (! (m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8039 if (m3 == mc || m3->mc_snum < mc->mc_snum)
8041 if (m3->mc_pg[mc->mc_top] == mp) {
8042 if (m3->mc_ki[mc->mc_top] >= ki) {
8043 m3->mc_flags |= C_DEL;
8044 if (m3->mc_ki[mc->mc_top] > ki)
8045 m3->mc_ki[mc->mc_top]--;
8046 else if (mc->mc_db->md_flags & MDB_DUPSORT)
8047 m3->mc_xcursor->mx_cursor.mc_flags |= C_EOF;
8052 rc = mdb_rebalance(mc);
8054 if (rc == MDB_SUCCESS) {
8055 /* DB is totally empty now, just bail out.
8056 * Other cursors adjustments were already done
8057 * by mdb_rebalance and aren't needed here.
8062 mp = mc->mc_pg[mc->mc_top];
8063 nkeys = NUMKEYS(mp);
8065 /* Adjust other cursors pointing to mp */
8066 for (m2 = mc->mc_txn->mt_cursors[dbi]; !rc && m2; m2=m2->mc_next) {
8067 m3 = (mc->mc_flags & C_SUB) ? &m2->mc_xcursor->mx_cursor : m2;
8068 if (! (m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8070 if (m3->mc_snum < mc->mc_snum)
8072 if (m3->mc_pg[mc->mc_top] == mp) {
8073 /* if m3 points past last node in page, find next sibling */
8074 if (m3->mc_ki[mc->mc_top] >= nkeys) {
8075 rc = mdb_cursor_sibling(m3, 1);
8076 if (rc == MDB_NOTFOUND) {
8077 m3->mc_flags |= C_EOF;
8083 mc->mc_flags |= C_DEL;
8087 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
8092 mdb_del(MDB_txn *txn, MDB_dbi dbi,
8093 MDB_val *key, MDB_val *data)
8095 if (!key || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
8098 if (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_BLOCKED))
8099 return (txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
8101 if (!F_ISSET(txn->mt_dbs[dbi].md_flags, MDB_DUPSORT)) {
8102 /* must ignore any data */
8106 return mdb_del0(txn, dbi, key, data, 0);
8110 mdb_del0(MDB_txn *txn, MDB_dbi dbi,
8111 MDB_val *key, MDB_val *data, unsigned flags)
8116 MDB_val rdata, *xdata;
8120 DPRINTF(("====> delete db %u key [%s]", dbi, DKEY(key)));
8122 mdb_cursor_init(&mc, txn, dbi, &mx);
8131 flags |= MDB_NODUPDATA;
8133 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
8135 /* let mdb_page_split know about this cursor if needed:
8136 * delete will trigger a rebalance; if it needs to move
8137 * a node from one page to another, it will have to
8138 * update the parent's separator key(s). If the new sepkey
8139 * is larger than the current one, the parent page may
8140 * run out of space, triggering a split. We need this
8141 * cursor to be consistent until the end of the rebalance.
8143 mc.mc_flags |= C_UNTRACK;
8144 mc.mc_next = txn->mt_cursors[dbi];
8145 txn->mt_cursors[dbi] = &mc;
8146 rc = mdb_cursor_del(&mc, flags);
8147 txn->mt_cursors[dbi] = mc.mc_next;
8152 /** Split a page and insert a new node.
8153 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
8154 * The cursor will be updated to point to the actual page and index where
8155 * the node got inserted after the split.
8156 * @param[in] newkey The key for the newly inserted node.
8157 * @param[in] newdata The data for the newly inserted node.
8158 * @param[in] newpgno The page number, if the new node is a branch node.
8159 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
8160 * @return 0 on success, non-zero on failure.
8163 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
8164 unsigned int nflags)
8167 int rc = MDB_SUCCESS, new_root = 0, did_split = 0;
8170 int i, j, split_indx, nkeys, pmax;
8171 MDB_env *env = mc->mc_txn->mt_env;
8173 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
8174 MDB_page *copy = NULL;
8175 MDB_page *mp, *rp, *pp;
8180 mp = mc->mc_pg[mc->mc_top];
8181 newindx = mc->mc_ki[mc->mc_top];
8182 nkeys = NUMKEYS(mp);
8184 DPRINTF(("-----> splitting %s page %"Z"u and adding [%s] at index %i/%i",
8185 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
8186 DKEY(newkey), mc->mc_ki[mc->mc_top], nkeys));
8188 /* Create a right sibling. */
8189 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
8191 rp->mp_pad = mp->mp_pad;
8192 DPRINTF(("new right sibling: page %"Z"u", rp->mp_pgno));
8194 if (mc->mc_snum < 2) {
8195 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
8197 /* shift current top to make room for new parent */
8198 mc->mc_pg[1] = mc->mc_pg[0];
8199 mc->mc_ki[1] = mc->mc_ki[0];
8202 mc->mc_db->md_root = pp->mp_pgno;
8203 DPRINTF(("root split! new root = %"Z"u", pp->mp_pgno));
8204 new_root = mc->mc_db->md_depth++;
8206 /* Add left (implicit) pointer. */
8207 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
8208 /* undo the pre-push */
8209 mc->mc_pg[0] = mc->mc_pg[1];
8210 mc->mc_ki[0] = mc->mc_ki[1];
8211 mc->mc_db->md_root = mp->mp_pgno;
8212 mc->mc_db->md_depth--;
8219 ptop = mc->mc_top-1;
8220 DPRINTF(("parent branch page is %"Z"u", mc->mc_pg[ptop]->mp_pgno));
8223 mc->mc_flags |= C_SPLITTING;
8224 mdb_cursor_copy(mc, &mn);
8225 mn.mc_pg[mn.mc_top] = rp;
8226 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
8228 if (nflags & MDB_APPEND) {
8229 mn.mc_ki[mn.mc_top] = 0;
8231 split_indx = newindx;
8235 split_indx = (nkeys+1) / 2;
8240 unsigned int lsize, rsize, ksize;
8241 /* Move half of the keys to the right sibling */
8242 x = mc->mc_ki[mc->mc_top] - split_indx;
8243 ksize = mc->mc_db->md_pad;
8244 split = LEAF2KEY(mp, split_indx, ksize);
8245 rsize = (nkeys - split_indx) * ksize;
8246 lsize = (nkeys - split_indx) * sizeof(indx_t);
8247 mp->mp_lower -= lsize;
8248 rp->mp_lower += lsize;
8249 mp->mp_upper += rsize - lsize;
8250 rp->mp_upper -= rsize - lsize;
8251 sepkey.mv_size = ksize;
8252 if (newindx == split_indx) {
8253 sepkey.mv_data = newkey->mv_data;
8255 sepkey.mv_data = split;
8258 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
8259 memcpy(rp->mp_ptrs, split, rsize);
8260 sepkey.mv_data = rp->mp_ptrs;
8261 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
8262 memcpy(ins, newkey->mv_data, ksize);
8263 mp->mp_lower += sizeof(indx_t);
8264 mp->mp_upper -= ksize - sizeof(indx_t);
8267 memcpy(rp->mp_ptrs, split, x * ksize);
8268 ins = LEAF2KEY(rp, x, ksize);
8269 memcpy(ins, newkey->mv_data, ksize);
8270 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
8271 rp->mp_lower += sizeof(indx_t);
8272 rp->mp_upper -= ksize - sizeof(indx_t);
8273 mc->mc_ki[mc->mc_top] = x;
8274 mc->mc_pg[mc->mc_top] = rp;
8277 int psize, nsize, k;
8278 /* Maximum free space in an empty page */
8279 pmax = env->me_psize - PAGEHDRSZ;
8281 nsize = mdb_leaf_size(env, newkey, newdata);
8283 nsize = mdb_branch_size(env, newkey);
8284 nsize = EVEN(nsize);
8286 /* grab a page to hold a temporary copy */
8287 copy = mdb_page_malloc(mc->mc_txn, 1);
8292 copy->mp_pgno = mp->mp_pgno;
8293 copy->mp_flags = mp->mp_flags;
8294 copy->mp_lower = (PAGEHDRSZ-PAGEBASE);
8295 copy->mp_upper = env->me_psize - PAGEBASE;
8297 /* prepare to insert */
8298 for (i=0, j=0; i<nkeys; i++) {
8300 copy->mp_ptrs[j++] = 0;
8302 copy->mp_ptrs[j++] = mp->mp_ptrs[i];
8305 /* When items are relatively large the split point needs
8306 * to be checked, because being off-by-one will make the
8307 * difference between success or failure in mdb_node_add.
8309 * It's also relevant if a page happens to be laid out
8310 * such that one half of its nodes are all "small" and
8311 * the other half of its nodes are "large." If the new
8312 * item is also "large" and falls on the half with
8313 * "large" nodes, it also may not fit.
8315 * As a final tweak, if the new item goes on the last
8316 * spot on the page (and thus, onto the new page), bias
8317 * the split so the new page is emptier than the old page.
8318 * This yields better packing during sequential inserts.
8320 if (nkeys < 20 || nsize > pmax/16 || newindx >= nkeys) {
8321 /* Find split point */
8323 if (newindx <= split_indx || newindx >= nkeys) {
8325 k = newindx >= nkeys ? nkeys : split_indx+1+IS_LEAF(mp);
8330 for (; i!=k; i+=j) {
8335 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
8336 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
8338 if (F_ISSET(node->mn_flags, F_BIGDATA))
8339 psize += sizeof(pgno_t);
8341 psize += NODEDSZ(node);
8343 psize = EVEN(psize);
8345 if (psize > pmax || i == k-j) {
8346 split_indx = i + (j<0);
8351 if (split_indx == newindx) {
8352 sepkey.mv_size = newkey->mv_size;
8353 sepkey.mv_data = newkey->mv_data;
8355 node = (MDB_node *)((char *)mp + copy->mp_ptrs[split_indx] + PAGEBASE);
8356 sepkey.mv_size = node->mn_ksize;
8357 sepkey.mv_data = NODEKEY(node);
8362 DPRINTF(("separator is %d [%s]", split_indx, DKEY(&sepkey)));
8364 /* Copy separator key to the parent.
8366 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(env, &sepkey)) {
8370 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
8375 if (mn.mc_snum == mc->mc_snum) {
8376 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
8377 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
8378 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
8379 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
8384 /* Right page might now have changed parent.
8385 * Check if left page also changed parent.
8387 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
8388 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
8389 for (i=0; i<ptop; i++) {
8390 mc->mc_pg[i] = mn.mc_pg[i];
8391 mc->mc_ki[i] = mn.mc_ki[i];
8393 mc->mc_pg[ptop] = mn.mc_pg[ptop];
8394 if (mn.mc_ki[ptop]) {
8395 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
8397 /* find right page's left sibling */
8398 mc->mc_ki[ptop] = mn.mc_ki[ptop];
8399 mdb_cursor_sibling(mc, 0);
8404 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
8407 mc->mc_flags ^= C_SPLITTING;
8408 if (rc != MDB_SUCCESS) {
8411 if (nflags & MDB_APPEND) {
8412 mc->mc_pg[mc->mc_top] = rp;
8413 mc->mc_ki[mc->mc_top] = 0;
8414 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
8417 for (i=0; i<mc->mc_top; i++)
8418 mc->mc_ki[i] = mn.mc_ki[i];
8419 } else if (!IS_LEAF2(mp)) {
8421 mc->mc_pg[mc->mc_top] = rp;
8426 rkey.mv_data = newkey->mv_data;
8427 rkey.mv_size = newkey->mv_size;
8433 /* Update index for the new key. */
8434 mc->mc_ki[mc->mc_top] = j;
8436 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
8437 rkey.mv_data = NODEKEY(node);
8438 rkey.mv_size = node->mn_ksize;
8440 xdata.mv_data = NODEDATA(node);
8441 xdata.mv_size = NODEDSZ(node);
8444 pgno = NODEPGNO(node);
8445 flags = node->mn_flags;
8448 if (!IS_LEAF(mp) && j == 0) {
8449 /* First branch index doesn't need key data. */
8453 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
8459 mc->mc_pg[mc->mc_top] = copy;
8464 } while (i != split_indx);
8466 nkeys = NUMKEYS(copy);
8467 for (i=0; i<nkeys; i++)
8468 mp->mp_ptrs[i] = copy->mp_ptrs[i];
8469 mp->mp_lower = copy->mp_lower;
8470 mp->mp_upper = copy->mp_upper;
8471 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
8472 env->me_psize - copy->mp_upper - PAGEBASE);
8474 /* reset back to original page */
8475 if (newindx < split_indx) {
8476 mc->mc_pg[mc->mc_top] = mp;
8477 if (nflags & MDB_RESERVE) {
8478 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
8479 if (!(node->mn_flags & F_BIGDATA))
8480 newdata->mv_data = NODEDATA(node);
8483 mc->mc_pg[mc->mc_top] = rp;
8485 /* Make sure mc_ki is still valid.
8487 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
8488 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
8489 for (i=0; i<=ptop; i++) {
8490 mc->mc_pg[i] = mn.mc_pg[i];
8491 mc->mc_ki[i] = mn.mc_ki[i];
8498 /* Adjust other cursors pointing to mp */
8499 MDB_cursor *m2, *m3;
8500 MDB_dbi dbi = mc->mc_dbi;
8501 int fixup = NUMKEYS(mp);
8503 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
8504 if (mc->mc_flags & C_SUB)
8505 m3 = &m2->mc_xcursor->mx_cursor;
8510 if (!(m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8512 if (m3->mc_flags & C_SPLITTING)
8517 for (k=new_root; k>=0; k--) {
8518 m3->mc_ki[k+1] = m3->mc_ki[k];
8519 m3->mc_pg[k+1] = m3->mc_pg[k];
8521 if (m3->mc_ki[0] >= split_indx) {
8526 m3->mc_pg[0] = mc->mc_pg[0];
8530 if (m3->mc_top >= mc->mc_top && m3->mc_pg[mc->mc_top] == mp) {
8531 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
8532 m3->mc_ki[mc->mc_top]++;
8533 if (m3->mc_ki[mc->mc_top] >= fixup) {
8534 m3->mc_pg[mc->mc_top] = rp;
8535 m3->mc_ki[mc->mc_top] -= fixup;
8536 m3->mc_ki[ptop] = mn.mc_ki[ptop];
8538 } else if (!did_split && m3->mc_top >= ptop && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
8539 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
8544 DPRINTF(("mp left: %d, rp left: %d", SIZELEFT(mp), SIZELEFT(rp)));
8547 if (copy) /* tmp page */
8548 mdb_page_free(env, copy);
8550 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
8555 mdb_put(MDB_txn *txn, MDB_dbi dbi,
8556 MDB_val *key, MDB_val *data, unsigned int flags)
8561 if (!key || !data || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
8564 if (flags & ~(MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP))
8567 mdb_cursor_init(&mc, txn, dbi, &mx);
8568 return mdb_cursor_put(&mc, key, data, flags);
8572 #define MDB_WBUF (1024*1024)
8575 /** State needed for a compacting copy. */
8576 typedef struct mdb_copy {
8577 pthread_mutex_t mc_mutex;
8578 pthread_cond_t mc_cond;
8585 pgno_t mc_next_pgno;
8588 volatile int mc_new;
8593 /** Dedicated writer thread for compacting copy. */
8594 static THREAD_RET ESECT CALL_CONV
8595 mdb_env_copythr(void *arg)
8599 int toggle = 0, wsize, rc;
8602 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
8605 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
8608 pthread_mutex_lock(&my->mc_mutex);
8610 pthread_cond_signal(&my->mc_cond);
8613 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8614 if (my->mc_new < 0) {
8619 wsize = my->mc_wlen[toggle];
8620 ptr = my->mc_wbuf[toggle];
8623 DO_WRITE(rc, my->mc_fd, ptr, wsize, len);
8627 } else if (len > 0) {
8641 /* If there's an overflow page tail, write it too */
8642 if (my->mc_olen[toggle]) {
8643 wsize = my->mc_olen[toggle];
8644 ptr = my->mc_over[toggle];
8645 my->mc_olen[toggle] = 0;
8648 my->mc_wlen[toggle] = 0;
8650 pthread_cond_signal(&my->mc_cond);
8652 pthread_cond_signal(&my->mc_cond);
8653 pthread_mutex_unlock(&my->mc_mutex);
8654 return (THREAD_RET)0;
8658 /** Tell the writer thread there's a buffer ready to write */
8660 mdb_env_cthr_toggle(mdb_copy *my, int st)
8662 int toggle = my->mc_toggle ^ 1;
8663 pthread_mutex_lock(&my->mc_mutex);
8664 if (my->mc_status) {
8665 pthread_mutex_unlock(&my->mc_mutex);
8666 return my->mc_status;
8668 while (my->mc_new == 1)
8669 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8671 my->mc_toggle = toggle;
8672 pthread_cond_signal(&my->mc_cond);
8673 pthread_mutex_unlock(&my->mc_mutex);
8677 /** Depth-first tree traversal for compacting copy. */
8679 mdb_env_cwalk(mdb_copy *my, pgno_t *pg, int flags)
8682 MDB_txn *txn = my->mc_txn;
8684 MDB_page *mo, *mp, *leaf;
8689 /* Empty DB, nothing to do */
8690 if (*pg == P_INVALID)
8697 rc = mdb_page_get(my->mc_txn, *pg, &mc.mc_pg[0], NULL);
8700 rc = mdb_page_search_root(&mc, NULL, MDB_PS_FIRST);
8704 /* Make cursor pages writable */
8705 buf = ptr = malloc(my->mc_env->me_psize * mc.mc_snum);
8709 for (i=0; i<mc.mc_top; i++) {
8710 mdb_page_copy((MDB_page *)ptr, mc.mc_pg[i], my->mc_env->me_psize);
8711 mc.mc_pg[i] = (MDB_page *)ptr;
8712 ptr += my->mc_env->me_psize;
8715 /* This is writable space for a leaf page. Usually not needed. */
8716 leaf = (MDB_page *)ptr;
8718 toggle = my->mc_toggle;
8719 while (mc.mc_snum > 0) {
8721 mp = mc.mc_pg[mc.mc_top];
8725 if (!IS_LEAF2(mp) && !(flags & F_DUPDATA)) {
8726 for (i=0; i<n; i++) {
8727 ni = NODEPTR(mp, i);
8728 if (ni->mn_flags & F_BIGDATA) {
8732 /* Need writable leaf */
8734 mc.mc_pg[mc.mc_top] = leaf;
8735 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8737 ni = NODEPTR(mp, i);
8740 memcpy(&pg, NODEDATA(ni), sizeof(pg));
8741 rc = mdb_page_get(txn, pg, &omp, NULL);
8744 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8745 rc = mdb_env_cthr_toggle(my, 1);
8748 toggle = my->mc_toggle;
8750 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8751 memcpy(mo, omp, my->mc_env->me_psize);
8752 mo->mp_pgno = my->mc_next_pgno;
8753 my->mc_next_pgno += omp->mp_pages;
8754 my->mc_wlen[toggle] += my->mc_env->me_psize;
8755 if (omp->mp_pages > 1) {
8756 my->mc_olen[toggle] = my->mc_env->me_psize * (omp->mp_pages - 1);
8757 my->mc_over[toggle] = (char *)omp + my->mc_env->me_psize;
8758 rc = mdb_env_cthr_toggle(my, 1);
8761 toggle = my->mc_toggle;
8763 memcpy(NODEDATA(ni), &mo->mp_pgno, sizeof(pgno_t));
8764 } else if (ni->mn_flags & F_SUBDATA) {
8767 /* Need writable leaf */
8769 mc.mc_pg[mc.mc_top] = leaf;
8770 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8772 ni = NODEPTR(mp, i);
8775 memcpy(&db, NODEDATA(ni), sizeof(db));
8776 my->mc_toggle = toggle;
8777 rc = mdb_env_cwalk(my, &db.md_root, ni->mn_flags & F_DUPDATA);
8780 toggle = my->mc_toggle;
8781 memcpy(NODEDATA(ni), &db, sizeof(db));
8786 mc.mc_ki[mc.mc_top]++;
8787 if (mc.mc_ki[mc.mc_top] < n) {
8790 ni = NODEPTR(mp, mc.mc_ki[mc.mc_top]);
8792 rc = mdb_page_get(txn, pg, &mp, NULL);
8797 mc.mc_ki[mc.mc_top] = 0;
8798 if (IS_BRANCH(mp)) {
8799 /* Whenever we advance to a sibling branch page,
8800 * we must proceed all the way down to its first leaf.
8802 mdb_page_copy(mc.mc_pg[mc.mc_top], mp, my->mc_env->me_psize);
8805 mc.mc_pg[mc.mc_top] = mp;
8809 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8810 rc = mdb_env_cthr_toggle(my, 1);
8813 toggle = my->mc_toggle;
8815 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8816 mdb_page_copy(mo, mp, my->mc_env->me_psize);
8817 mo->mp_pgno = my->mc_next_pgno++;
8818 my->mc_wlen[toggle] += my->mc_env->me_psize;
8820 /* Update parent if there is one */
8821 ni = NODEPTR(mc.mc_pg[mc.mc_top-1], mc.mc_ki[mc.mc_top-1]);
8822 SETPGNO(ni, mo->mp_pgno);
8823 mdb_cursor_pop(&mc);
8825 /* Otherwise we're done */
8835 /** Copy environment with compaction. */
8837 mdb_env_copyfd1(MDB_env *env, HANDLE fd)
8842 MDB_txn *txn = NULL;
8847 my.mc_mutex = CreateMutex(NULL, FALSE, NULL);
8848 my.mc_cond = CreateEvent(NULL, FALSE, FALSE, NULL);
8849 my.mc_wbuf[0] = _aligned_malloc(MDB_WBUF*2, env->me_os_psize);
8850 if (my.mc_wbuf[0] == NULL)
8853 pthread_mutex_init(&my.mc_mutex, NULL);
8854 pthread_cond_init(&my.mc_cond, NULL);
8855 #ifdef HAVE_MEMALIGN
8856 my.mc_wbuf[0] = memalign(env->me_os_psize, MDB_WBUF*2);
8857 if (my.mc_wbuf[0] == NULL)
8860 rc = posix_memalign((void **)&my.mc_wbuf[0], env->me_os_psize, MDB_WBUF*2);
8865 memset(my.mc_wbuf[0], 0, MDB_WBUF*2);
8866 my.mc_wbuf[1] = my.mc_wbuf[0] + MDB_WBUF;
8871 my.mc_next_pgno = 2;
8877 THREAD_CREATE(thr, mdb_env_copythr, &my);
8879 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
8883 mp = (MDB_page *)my.mc_wbuf[0];
8884 memset(mp, 0, 2*env->me_psize);
8886 mp->mp_flags = P_META;
8887 mm = (MDB_meta *)METADATA(mp);
8888 mdb_env_init_meta0(env, mm);
8889 mm->mm_address = env->me_metas[0]->mm_address;
8891 mp = (MDB_page *)(my.mc_wbuf[0] + env->me_psize);
8893 mp->mp_flags = P_META;
8894 *(MDB_meta *)METADATA(mp) = *mm;
8895 mm = (MDB_meta *)METADATA(mp);
8897 /* Count the number of free pages, subtract from lastpg to find
8898 * number of active pages
8901 MDB_ID freecount = 0;
8904 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
8905 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
8906 freecount += *(MDB_ID *)data.mv_data;
8907 freecount += txn->mt_dbs[0].md_branch_pages +
8908 txn->mt_dbs[0].md_leaf_pages +
8909 txn->mt_dbs[0].md_overflow_pages;
8911 /* Set metapage 1 */
8912 mm->mm_last_pg = txn->mt_next_pgno - freecount - 1;
8913 mm->mm_dbs[1] = txn->mt_dbs[1];
8914 if (mm->mm_last_pg > 1) {
8915 mm->mm_dbs[1].md_root = mm->mm_last_pg;
8918 mm->mm_dbs[1].md_root = P_INVALID;
8921 my.mc_wlen[0] = env->me_psize * 2;
8923 pthread_mutex_lock(&my.mc_mutex);
8925 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8926 pthread_mutex_unlock(&my.mc_mutex);
8927 rc = mdb_env_cwalk(&my, &txn->mt_dbs[1].md_root, 0);
8928 if (rc == MDB_SUCCESS && my.mc_wlen[my.mc_toggle])
8929 rc = mdb_env_cthr_toggle(&my, 1);
8930 mdb_env_cthr_toggle(&my, -1);
8931 pthread_mutex_lock(&my.mc_mutex);
8933 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8934 pthread_mutex_unlock(&my.mc_mutex);
8939 CloseHandle(my.mc_cond);
8940 CloseHandle(my.mc_mutex);
8941 _aligned_free(my.mc_wbuf[0]);
8943 pthread_cond_destroy(&my.mc_cond);
8944 pthread_mutex_destroy(&my.mc_mutex);
8945 free(my.mc_wbuf[0]);
8950 /** Copy environment as-is. */
8952 mdb_env_copyfd0(MDB_env *env, HANDLE fd)
8954 MDB_txn *txn = NULL;
8955 mdb_mutexref_t wmutex = NULL;
8961 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
8965 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
8968 /* Do the lock/unlock of the reader mutex before starting the
8969 * write txn. Otherwise other read txns could block writers.
8971 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
8976 /* We must start the actual read txn after blocking writers */
8977 mdb_txn_end(txn, MDB_END_RESET_TMP);
8979 /* Temporarily block writers until we snapshot the meta pages */
8980 wmutex = env->me_wmutex;
8981 if (LOCK_MUTEX(rc, env, wmutex))
8984 rc = mdb_txn_renew0(txn);
8986 UNLOCK_MUTEX(wmutex);
8991 wsize = env->me_psize * 2;
8995 DO_WRITE(rc, fd, ptr, w2, len);
8999 } else if (len > 0) {
9005 /* Non-blocking or async handles are not supported */
9011 UNLOCK_MUTEX(wmutex);
9016 w2 = txn->mt_next_pgno * env->me_psize;
9019 if ((rc = mdb_fsize(env->me_fd, &fsize)))
9026 if (wsize > MAX_WRITE)
9030 DO_WRITE(rc, fd, ptr, w2, len);
9034 } else if (len > 0) {
9051 mdb_env_copyfd2(MDB_env *env, HANDLE fd, unsigned int flags)
9053 if (flags & MDB_CP_COMPACT)
9054 return mdb_env_copyfd1(env, fd);
9056 return mdb_env_copyfd0(env, fd);
9060 mdb_env_copyfd(MDB_env *env, HANDLE fd)
9062 return mdb_env_copyfd2(env, fd, 0);
9066 mdb_env_copy2(MDB_env *env, const char *path, unsigned int flags)
9070 HANDLE newfd = INVALID_HANDLE_VALUE;
9072 if (env->me_flags & MDB_NOSUBDIR) {
9073 lpath = (char *)path;
9076 len += sizeof(DATANAME);
9077 lpath = malloc(len);
9080 sprintf(lpath, "%s" DATANAME, path);
9083 /* The destination path must exist, but the destination file must not.
9084 * We don't want the OS to cache the writes, since the source data is
9085 * already in the OS cache.
9088 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
9089 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
9091 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL, 0666);
9093 if (newfd == INVALID_HANDLE_VALUE) {
9098 if (env->me_psize >= env->me_os_psize) {
9100 /* Set O_DIRECT if the file system supports it */
9101 if ((rc = fcntl(newfd, F_GETFL)) != -1)
9102 (void) fcntl(newfd, F_SETFL, rc | O_DIRECT);
9104 #ifdef F_NOCACHE /* __APPLE__ */
9105 rc = fcntl(newfd, F_NOCACHE, 1);
9113 rc = mdb_env_copyfd2(env, newfd, flags);
9116 if (!(env->me_flags & MDB_NOSUBDIR))
9118 if (newfd != INVALID_HANDLE_VALUE)
9119 if (close(newfd) < 0 && rc == MDB_SUCCESS)
9126 mdb_env_copy(MDB_env *env, const char *path)
9128 return mdb_env_copy2(env, path, 0);
9132 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
9134 if (flag & ~CHANGEABLE)
9137 env->me_flags |= flag;
9139 env->me_flags &= ~flag;
9144 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
9149 *arg = env->me_flags & (CHANGEABLE|CHANGELESS);
9154 mdb_env_set_userctx(MDB_env *env, void *ctx)
9158 env->me_userctx = ctx;
9163 mdb_env_get_userctx(MDB_env *env)
9165 return env ? env->me_userctx : NULL;
9169 mdb_env_set_assert(MDB_env *env, MDB_assert_func *func)
9174 env->me_assert_func = func;
9180 mdb_env_get_path(MDB_env *env, const char **arg)
9185 *arg = env->me_path;
9190 mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *arg)
9199 /** Common code for #mdb_stat() and #mdb_env_stat().
9200 * @param[in] env the environment to operate in.
9201 * @param[in] db the #MDB_db record containing the stats to return.
9202 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
9203 * @return 0, this function always succeeds.
9206 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
9208 arg->ms_psize = env->me_psize;
9209 arg->ms_depth = db->md_depth;
9210 arg->ms_branch_pages = db->md_branch_pages;
9211 arg->ms_leaf_pages = db->md_leaf_pages;
9212 arg->ms_overflow_pages = db->md_overflow_pages;
9213 arg->ms_entries = db->md_entries;
9219 mdb_env_stat(MDB_env *env, MDB_stat *arg)
9223 if (env == NULL || arg == NULL)
9226 meta = mdb_env_pick_meta(env);
9228 return mdb_stat0(env, &meta->mm_dbs[MAIN_DBI], arg);
9232 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
9236 if (env == NULL || arg == NULL)
9239 meta = mdb_env_pick_meta(env);
9240 arg->me_mapaddr = meta->mm_address;
9241 arg->me_last_pgno = meta->mm_last_pg;
9242 arg->me_last_txnid = meta->mm_txnid;
9244 arg->me_mapsize = env->me_mapsize;
9245 arg->me_maxreaders = env->me_maxreaders;
9246 arg->me_numreaders = env->me_txns ? env->me_txns->mti_numreaders : 0;
9250 /** Set the default comparison functions for a database.
9251 * Called immediately after a database is opened to set the defaults.
9252 * The user can then override them with #mdb_set_compare() or
9253 * #mdb_set_dupsort().
9254 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
9255 * @param[in] dbi A database handle returned by #mdb_dbi_open()
9258 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
9260 uint16_t f = txn->mt_dbs[dbi].md_flags;
9262 txn->mt_dbxs[dbi].md_cmp =
9263 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
9264 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
9266 txn->mt_dbxs[dbi].md_dcmp =
9267 !(f & MDB_DUPSORT) ? 0 :
9268 ((f & MDB_INTEGERDUP)
9269 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
9270 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
9273 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
9279 int rc, dbflag, exact;
9280 unsigned int unused = 0, seq;
9283 if (flags & ~VALID_FLAGS)
9285 if (txn->mt_flags & MDB_TXN_BLOCKED)
9291 if (flags & PERSISTENT_FLAGS) {
9292 uint16_t f2 = flags & PERSISTENT_FLAGS;
9293 /* make sure flag changes get committed */
9294 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
9295 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
9296 txn->mt_flags |= MDB_TXN_DIRTY;
9299 mdb_default_cmp(txn, MAIN_DBI);
9303 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
9304 mdb_default_cmp(txn, MAIN_DBI);
9307 /* Is the DB already open? */
9309 for (i=2; i<txn->mt_numdbs; i++) {
9310 if (!txn->mt_dbxs[i].md_name.mv_size) {
9311 /* Remember this free slot */
9312 if (!unused) unused = i;
9315 if (len == txn->mt_dbxs[i].md_name.mv_size &&
9316 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
9322 /* If no free slot and max hit, fail */
9323 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
9324 return MDB_DBS_FULL;
9326 /* Cannot mix named databases with some mainDB flags */
9327 if (txn->mt_dbs[MAIN_DBI].md_flags & (MDB_DUPSORT|MDB_INTEGERKEY))
9328 return (flags & MDB_CREATE) ? MDB_INCOMPATIBLE : MDB_NOTFOUND;
9330 /* Find the DB info */
9331 dbflag = DB_NEW|DB_VALID|DB_USRVALID;
9334 key.mv_data = (void *)name;
9335 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
9336 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
9337 if (rc == MDB_SUCCESS) {
9338 /* make sure this is actually a DB */
9339 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
9340 if ((node->mn_flags & (F_DUPDATA|F_SUBDATA)) != F_SUBDATA)
9341 return MDB_INCOMPATIBLE;
9342 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
9343 /* Create if requested */
9344 data.mv_size = sizeof(MDB_db);
9345 data.mv_data = &dummy;
9346 memset(&dummy, 0, sizeof(dummy));
9347 dummy.md_root = P_INVALID;
9348 dummy.md_flags = flags & PERSISTENT_FLAGS;
9349 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
9353 /* OK, got info, add to table */
9354 if (rc == MDB_SUCCESS) {
9355 unsigned int slot = unused ? unused : txn->mt_numdbs;
9356 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
9357 txn->mt_dbxs[slot].md_name.mv_size = len;
9358 txn->mt_dbxs[slot].md_rel = NULL;
9359 txn->mt_dbflags[slot] = dbflag;
9360 /* txn-> and env-> are the same in read txns, use
9361 * tmp variable to avoid undefined assignment
9363 seq = ++txn->mt_env->me_dbiseqs[slot];
9364 txn->mt_dbiseqs[slot] = seq;
9366 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
9368 mdb_default_cmp(txn, slot);
9378 mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
9380 if (!arg || !TXN_DBI_EXIST(txn, dbi, DB_VALID))
9383 if (txn->mt_flags & MDB_TXN_BLOCKED)
9386 if (txn->mt_dbflags[dbi] & DB_STALE) {
9389 /* Stale, must read the DB's root. cursor_init does it for us. */
9390 mdb_cursor_init(&mc, txn, dbi, &mx);
9392 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
9395 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
9398 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
9400 ptr = env->me_dbxs[dbi].md_name.mv_data;
9401 /* If there was no name, this was already closed */
9403 env->me_dbxs[dbi].md_name.mv_data = NULL;
9404 env->me_dbxs[dbi].md_name.mv_size = 0;
9405 env->me_dbflags[dbi] = 0;
9406 env->me_dbiseqs[dbi]++;
9411 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags)
9413 /* We could return the flags for the FREE_DBI too but what's the point? */
9414 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9416 *flags = txn->mt_dbs[dbi].md_flags & PERSISTENT_FLAGS;
9420 /** Add all the DB's pages to the free list.
9421 * @param[in] mc Cursor on the DB to free.
9422 * @param[in] subs non-Zero to check for sub-DBs in this DB.
9423 * @return 0 on success, non-zero on failure.
9426 mdb_drop0(MDB_cursor *mc, int subs)
9430 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
9431 if (rc == MDB_SUCCESS) {
9432 MDB_txn *txn = mc->mc_txn;
9437 /* DUPSORT sub-DBs have no ovpages/DBs. Omit scanning leaves.
9438 * This also avoids any P_LEAF2 pages, which have no nodes.
9440 if (mc->mc_flags & C_SUB)
9443 mdb_cursor_copy(mc, &mx);
9444 while (mc->mc_snum > 0) {
9445 MDB_page *mp = mc->mc_pg[mc->mc_top];
9446 unsigned n = NUMKEYS(mp);
9448 for (i=0; i<n; i++) {
9449 ni = NODEPTR(mp, i);
9450 if (ni->mn_flags & F_BIGDATA) {
9453 memcpy(&pg, NODEDATA(ni), sizeof(pg));
9454 rc = mdb_page_get(txn, pg, &omp, NULL);
9457 mdb_cassert(mc, IS_OVERFLOW(omp));
9458 rc = mdb_midl_append_range(&txn->mt_free_pgs,
9462 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
9463 mdb_xcursor_init1(mc, ni);
9464 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
9470 if ((rc = mdb_midl_need(&txn->mt_free_pgs, n)) != 0)
9472 for (i=0; i<n; i++) {
9474 ni = NODEPTR(mp, i);
9477 mdb_midl_xappend(txn->mt_free_pgs, pg);
9482 mc->mc_ki[mc->mc_top] = i;
9483 rc = mdb_cursor_sibling(mc, 1);
9485 if (rc != MDB_NOTFOUND)
9487 /* no more siblings, go back to beginning
9488 * of previous level.
9492 for (i=1; i<mc->mc_snum; i++) {
9494 mc->mc_pg[i] = mx.mc_pg[i];
9499 rc = mdb_midl_append(&txn->mt_free_pgs, mc->mc_db->md_root);
9502 txn->mt_flags |= MDB_TXN_ERROR;
9503 } else if (rc == MDB_NOTFOUND) {
9509 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
9511 MDB_cursor *mc, *m2;
9514 if ((unsigned)del > 1 || !TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9517 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
9520 if (TXN_DBI_CHANGED(txn, dbi))
9523 rc = mdb_cursor_open(txn, dbi, &mc);
9527 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
9528 /* Invalidate the dropped DB's cursors */
9529 for (m2 = txn->mt_cursors[dbi]; m2; m2 = m2->mc_next)
9530 m2->mc_flags &= ~(C_INITIALIZED|C_EOF);
9534 /* Can't delete the main DB */
9535 if (del && dbi > MAIN_DBI) {
9536 rc = mdb_del0(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL, F_SUBDATA);
9538 txn->mt_dbflags[dbi] = DB_STALE;
9539 mdb_dbi_close(txn->mt_env, dbi);
9541 txn->mt_flags |= MDB_TXN_ERROR;
9544 /* reset the DB record, mark it dirty */
9545 txn->mt_dbflags[dbi] |= DB_DIRTY;
9546 txn->mt_dbs[dbi].md_depth = 0;
9547 txn->mt_dbs[dbi].md_branch_pages = 0;
9548 txn->mt_dbs[dbi].md_leaf_pages = 0;
9549 txn->mt_dbs[dbi].md_overflow_pages = 0;
9550 txn->mt_dbs[dbi].md_entries = 0;
9551 txn->mt_dbs[dbi].md_root = P_INVALID;
9553 txn->mt_flags |= MDB_TXN_DIRTY;
9556 mdb_cursor_close(mc);
9560 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9562 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9565 txn->mt_dbxs[dbi].md_cmp = cmp;
9569 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9571 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9574 txn->mt_dbxs[dbi].md_dcmp = cmp;
9578 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
9580 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9583 txn->mt_dbxs[dbi].md_rel = rel;
9587 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
9589 if (!TXN_DBI_EXIST(txn, dbi, DB_USRVALID))
9592 txn->mt_dbxs[dbi].md_relctx = ctx;
9597 mdb_env_get_maxkeysize(MDB_env *env)
9599 return ENV_MAXKEY(env);
9603 mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx)
9605 unsigned int i, rdrs;
9608 int rc = 0, first = 1;
9612 if (!env->me_txns) {
9613 return func("(no reader locks)\n", ctx);
9615 rdrs = env->me_txns->mti_numreaders;
9616 mr = env->me_txns->mti_readers;
9617 for (i=0; i<rdrs; i++) {
9619 txnid_t txnid = mr[i].mr_txnid;
9620 sprintf(buf, txnid == (txnid_t)-1 ?
9621 "%10d %"Z"x -\n" : "%10d %"Z"x %"Z"u\n",
9622 (int)mr[i].mr_pid, (size_t)mr[i].mr_tid, txnid);
9625 rc = func(" pid thread txnid\n", ctx);
9629 rc = func(buf, ctx);
9635 rc = func("(no active readers)\n", ctx);
9640 /** Insert pid into list if not already present.
9641 * return -1 if already present.
9644 mdb_pid_insert(MDB_PID_T *ids, MDB_PID_T pid)
9646 /* binary search of pid in list */
9648 unsigned cursor = 1;
9650 unsigned n = ids[0];
9653 unsigned pivot = n >> 1;
9654 cursor = base + pivot + 1;
9655 val = pid - ids[cursor];
9660 } else if ( val > 0 ) {
9665 /* found, so it's a duplicate */
9674 for (n = ids[0]; n > cursor; n--)
9681 mdb_reader_check(MDB_env *env, int *dead)
9687 return env->me_txns ? mdb_reader_check0(env, 0, dead) : MDB_SUCCESS;
9690 /** As #mdb_reader_check(). rlocked = <caller locked the reader mutex>. */
9692 mdb_reader_check0(MDB_env *env, int rlocked, int *dead)
9694 mdb_mutexref_t rmutex = rlocked ? NULL : env->me_rmutex;
9695 unsigned int i, j, rdrs;
9697 MDB_PID_T *pids, pid;
9698 int rc = MDB_SUCCESS, count = 0;
9700 rdrs = env->me_txns->mti_numreaders;
9701 pids = malloc((rdrs+1) * sizeof(MDB_PID_T));
9705 mr = env->me_txns->mti_readers;
9706 for (i=0; i<rdrs; i++) {
9708 if (pid && pid != env->me_pid) {
9709 if (mdb_pid_insert(pids, pid) == 0) {
9710 if (!mdb_reader_pid(env, Pidcheck, pid)) {
9711 /* Stale reader found */
9714 if ((rc = LOCK_MUTEX0(rmutex)) != 0) {
9715 if ((rc = mdb_mutex_failed(env, rmutex, rc)))
9717 rdrs = 0; /* the above checked all readers */
9719 /* Recheck, a new process may have reused pid */
9720 if (mdb_reader_pid(env, Pidcheck, pid))
9725 if (mr[j].mr_pid == pid) {
9726 DPRINTF(("clear stale reader pid %u txn %"Z"d",
9727 (unsigned) pid, mr[j].mr_txnid));
9732 UNLOCK_MUTEX(rmutex);
9743 #ifdef MDB_ROBUST_SUPPORTED
9744 /** Handle #LOCK_MUTEX0() failure.
9745 * Try to repair the lock file if the mutex owner died.
9746 * @param[in] env the environment handle
9747 * @param[in] mutex LOCK_MUTEX0() mutex
9748 * @param[in] rc LOCK_MUTEX0() error (nonzero)
9749 * @return 0 on success with the mutex locked, or an error code on failure.
9752 mdb_mutex_failed(MDB_env *env, mdb_mutexref_t mutex, int rc)
9757 if (rc == MDB_OWNERDEAD) {
9758 /* We own the mutex. Clean up after dead previous owner. */
9760 rlocked = (mutex == env->me_rmutex);
9762 /* Keep mti_txnid updated, otherwise next writer can
9763 * overwrite data which latest meta page refers to.
9765 meta = mdb_env_pick_meta(env);
9766 env->me_txns->mti_txnid = meta->mm_txnid;
9767 /* env is hosed if the dead thread was ours */
9769 env->me_flags |= MDB_FATAL_ERROR;
9774 DPRINTF(("%cmutex owner died, %s", (rlocked ? 'r' : 'w'),
9775 (rc ? "this process' env is hosed" : "recovering")));
9776 rc2 = mdb_reader_check0(env, rlocked, NULL);
9778 rc2 = mdb_mutex_consistent(mutex);
9779 if (rc || (rc = rc2)) {
9780 DPRINTF(("LOCK_MUTEX recovery failed, %s", mdb_strerror(rc)));
9781 UNLOCK_MUTEX(mutex);
9787 DPRINTF(("LOCK_MUTEX failed, %s", mdb_strerror(rc)));
9792 #endif /* MDB_ROBUST_SUPPORTED */
projects / openldap / blob