2 * @brief memory-mapped database library
4 * A Btree-based database management library modeled loosely on the
5 * BerkeleyDB API, but much simplified.
8 * Copyright 2011-2013 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.
38 #include <sys/types.h>
42 /** getpid() returns int; MinGW defines pid_t but MinGW64 typedefs it
43 * as int64 which is wrong. MSVC doesn't define it at all, so just
48 # include <sys/param.h>
50 # define LITTLE_ENDIAN 1234
51 # define BIG_ENDIAN 4321
52 # define BYTE_ORDER LITTLE_ENDIAN
54 # define SSIZE_MAX INT_MAX
58 #define MDB_PID_T pid_t
59 #include <sys/param.h>
62 #ifdef HAVE_SYS_FILE_H
79 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
80 #include <netinet/in.h>
81 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
84 #if defined(__APPLE__) || defined (BSD)
85 # define MDB_USE_POSIX_SEM 1
86 # define MDB_FDATASYNC fsync
87 #elif defined(ANDROID)
88 # define MDB_FDATASYNC fsync
93 #ifdef MDB_USE_POSIX_SEM
94 # define MDB_USE_HASH 1
95 #include <semaphore.h>
100 #include <valgrind/memcheck.h>
101 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
102 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
103 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
104 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
105 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
107 #define VGMEMP_CREATE(h,r,z)
108 #define VGMEMP_ALLOC(h,a,s)
109 #define VGMEMP_FREE(h,a)
110 #define VGMEMP_DESTROY(h)
111 #define VGMEMP_DEFINED(a,s)
115 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
116 /* Solaris just defines one or the other */
117 # define LITTLE_ENDIAN 1234
118 # define BIG_ENDIAN 4321
119 # ifdef _LITTLE_ENDIAN
120 # define BYTE_ORDER LITTLE_ENDIAN
122 # define BYTE_ORDER BIG_ENDIAN
125 # define BYTE_ORDER __BYTE_ORDER
129 #ifndef LITTLE_ENDIAN
130 #define LITTLE_ENDIAN __LITTLE_ENDIAN
133 #define BIG_ENDIAN __BIG_ENDIAN
136 #if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
137 #define MISALIGNED_OK 1
143 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
144 # error "Unknown or unsupported endianness (BYTE_ORDER)"
145 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
146 # error "Two's complement, reasonably sized integer types, please"
149 /** @defgroup internal MDB Internals
152 /** @defgroup compat Windows Compatibility Macros
153 * A bunch of macros to minimize the amount of platform-specific ifdefs
154 * needed throughout the rest of the code. When the features this library
155 * needs are similar enough to POSIX to be hidden in a one-or-two line
156 * replacement, this macro approach is used.
160 #define MDB_USE_HASH 1
161 #define MDB_PIDLOCK 0
162 #define pthread_t DWORD
163 #define pthread_mutex_t HANDLE
164 #define pthread_key_t DWORD
165 #define pthread_self() GetCurrentThreadId()
166 #define pthread_key_create(x,y) \
167 ((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
168 #define pthread_key_delete(x) TlsFree(x)
169 #define pthread_getspecific(x) TlsGetValue(x)
170 #define pthread_setspecific(x,y) (TlsSetValue(x,y) ? 0 : ErrCode())
171 #define pthread_mutex_unlock(x) ReleaseMutex(x)
172 #define pthread_mutex_lock(x) WaitForSingleObject(x, INFINITE)
173 #define LOCK_MUTEX_R(env) pthread_mutex_lock((env)->me_rmutex)
174 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock((env)->me_rmutex)
175 #define LOCK_MUTEX_W(env) pthread_mutex_lock((env)->me_wmutex)
176 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock((env)->me_wmutex)
177 #define getpid() GetCurrentProcessId()
178 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
179 #define MDB_MSYNC(addr,len,flags) (!FlushViewOfFile(addr,len))
180 #define ErrCode() GetLastError()
181 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
182 #define close(fd) (CloseHandle(fd) ? 0 : -1)
183 #define munmap(ptr,len) UnmapViewOfFile(ptr)
184 #ifdef PROCESS_QUERY_LIMITED_INFORMATION
185 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
187 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
192 #define Z "z" /**< printf format modifier for size_t */
194 /** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
195 #define MDB_PIDLOCK 1
197 #ifdef MDB_USE_POSIX_SEM
199 #define LOCK_MUTEX_R(env) mdb_sem_wait((env)->me_rmutex)
200 #define UNLOCK_MUTEX_R(env) sem_post((env)->me_rmutex)
201 #define LOCK_MUTEX_W(env) mdb_sem_wait((env)->me_wmutex)
202 #define UNLOCK_MUTEX_W(env) sem_post((env)->me_wmutex)
205 mdb_sem_wait(sem_t *sem)
208 while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
213 /** Lock the reader mutex.
215 #define LOCK_MUTEX_R(env) pthread_mutex_lock(&(env)->me_txns->mti_mutex)
216 /** Unlock the reader mutex.
218 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
220 /** Lock the writer mutex.
221 * Only a single write transaction is allowed at a time. Other writers
222 * will block waiting for this mutex.
224 #define LOCK_MUTEX_W(env) pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
225 /** Unlock the writer mutex.
227 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
228 #endif /* MDB_USE_POSIX_SEM */
230 /** Get the error code for the last failed system function.
232 #define ErrCode() errno
234 /** An abstraction for a file handle.
235 * On POSIX systems file handles are small integers. On Windows
236 * they're opaque pointers.
240 /** A value for an invalid file handle.
241 * Mainly used to initialize file variables and signify that they are
244 #define INVALID_HANDLE_VALUE (-1)
246 /** Get the size of a memory page for the system.
247 * This is the basic size that the platform's memory manager uses, and is
248 * fundamental to the use of memory-mapped files.
250 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
253 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
256 #define MNAME_LEN (sizeof(pthread_mutex_t))
262 /** A flag for opening a file and requesting synchronous data writes.
263 * This is only used when writing a meta page. It's not strictly needed;
264 * we could just do a normal write and then immediately perform a flush.
265 * But if this flag is available it saves us an extra system call.
267 * @note If O_DSYNC is undefined but exists in /usr/include,
268 * preferably set some compiler flag to get the definition.
269 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
272 # define MDB_DSYNC O_DSYNC
276 /** Function for flushing the data of a file. Define this to fsync
277 * if fdatasync() is not supported.
279 #ifndef MDB_FDATASYNC
280 # define MDB_FDATASYNC fdatasync
284 # define MDB_MSYNC(addr,len,flags) msync(addr,len,flags)
295 /** A page number in the database.
296 * Note that 64 bit page numbers are overkill, since pages themselves
297 * already represent 12-13 bits of addressable memory, and the OS will
298 * always limit applications to a maximum of 63 bits of address space.
300 * @note In the #MDB_node structure, we only store 48 bits of this value,
301 * which thus limits us to only 60 bits of addressable data.
303 typedef MDB_ID pgno_t;
305 /** A transaction ID.
306 * See struct MDB_txn.mt_txnid for details.
308 typedef MDB_ID txnid_t;
310 /** @defgroup debug Debug Macros
314 /** Enable debug output. Needs variable argument macros (a C99 feature).
315 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
316 * read from and written to the database (used for free space management).
322 static int mdb_debug;
323 static txnid_t mdb_debug_start;
325 /** Print a debug message with printf formatting.
326 * Requires double parenthesis around 2 or more args.
328 # define DPRINTF(args) ((void) ((mdb_debug) && DPRINTF0 args))
329 # define DPRINTF0(fmt, ...) \
330 fprintf(stderr, "%s:%d " fmt "\n", __func__, __LINE__, __VA_ARGS__)
332 # define DPRINTF(args) ((void) 0)
334 /** Print a debug string.
335 * The string is printed literally, with no format processing.
337 #define DPUTS(arg) DPRINTF(("%s", arg))
338 /** Debuging output value of a cursor DBI: Negative in a sub-cursor. */
340 (((mc)->mc_flags & C_SUB) ? -(int)(mc)->mc_dbi : (int)(mc)->mc_dbi)
343 /** @brief The maximum size of a database page.
345 * This is 32k, since it must fit in #MDB_page.#mp_upper.
347 * LMDB will use database pages < OS pages if needed.
348 * That causes more I/O in write transactions: The OS must
349 * know (read) the whole page before writing a partial page.
351 * Note that we don't currently support Huge pages. On Linux,
352 * regular data files cannot use Huge pages, and in general
353 * Huge pages aren't actually pageable. We rely on the OS
354 * demand-pager to read our data and page it out when memory
355 * pressure from other processes is high. So until OSs have
356 * actual paging support for Huge pages, they're not viable.
358 #define MAX_PAGESIZE 0x8000
360 /** The minimum number of keys required in a database page.
361 * Setting this to a larger value will place a smaller bound on the
362 * maximum size of a data item. Data items larger than this size will
363 * be pushed into overflow pages instead of being stored directly in
364 * the B-tree node. This value used to default to 4. With a page size
365 * of 4096 bytes that meant that any item larger than 1024 bytes would
366 * go into an overflow page. That also meant that on average 2-3KB of
367 * each overflow page was wasted space. The value cannot be lower than
368 * 2 because then there would no longer be a tree structure. With this
369 * value, items larger than 2KB will go into overflow pages, and on
370 * average only 1KB will be wasted.
372 #define MDB_MINKEYS 2
374 /** A stamp that identifies a file as an MDB file.
375 * There's nothing special about this value other than that it is easily
376 * recognizable, and it will reflect any byte order mismatches.
378 #define MDB_MAGIC 0xBEEFC0DE
380 /** The version number for a database's datafile format. */
381 #define MDB_DATA_VERSION 1
382 /** The version number for a database's lockfile format. */
383 #define MDB_LOCK_VERSION 1
385 /** @brief The max size of a key we can write, or 0 for dynamic max.
387 * Define this as 0 to compute the max from the page size. 511
388 * is default for backwards compat: liblmdb <= 0.9.10 can break
389 * when modifying a DB with keys/dupsort data bigger than its max.
391 * Data items in an #MDB_DUPSORT database are also limited to
392 * this size, since they're actually keys of a sub-DB. Keys and
393 * #MDB_DUPSORT data items must fit on a node in a regular page.
395 #ifndef MDB_MAXKEYSIZE
396 #define MDB_MAXKEYSIZE 511
399 /** The maximum size of a key we can write to the environment. */
401 #define ENV_MAXKEY(env) (MDB_MAXKEYSIZE)
403 #define ENV_MAXKEY(env) ((env)->me_maxkey)
406 /** @brief The maximum size of a data item.
408 * We only store a 32 bit value for node sizes.
410 #define MAXDATASIZE 0xffffffffUL
413 /** Key size which fits in a #DKBUF.
416 #define DKBUF_MAXKEYSIZE ((MDB_MAXKEYSIZE) > 0 ? (MDB_MAXKEYSIZE) : 511)
419 * This is used for printing a hex dump of a key's contents.
421 #define DKBUF char kbuf[DKBUF_MAXKEYSIZE*2+1]
422 /** Display a key in hex.
424 * Invoke a function to display a key in hex.
426 #define DKEY(x) mdb_dkey(x, kbuf)
432 /** An invalid page number.
433 * Mainly used to denote an empty tree.
435 #define P_INVALID (~(pgno_t)0)
437 /** Test if the flags \b f are set in a flag word \b w. */
438 #define F_ISSET(w, f) (((w) & (f)) == (f))
440 /** Round \b n up to an even number. */
441 #define EVEN(n) (((n) + 1U) & -2) /* sign-extending -2 to match n+1U */
443 /** Used for offsets within a single page.
444 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
447 typedef uint16_t indx_t;
449 /** Default size of memory map.
450 * This is certainly too small for any actual applications. Apps should always set
451 * the size explicitly using #mdb_env_set_mapsize().
453 #define DEFAULT_MAPSIZE 1048576
455 /** @defgroup readers Reader Lock Table
456 * Readers don't acquire any locks for their data access. Instead, they
457 * simply record their transaction ID in the reader table. The reader
458 * mutex is needed just to find an empty slot in the reader table. The
459 * slot's address is saved in thread-specific data so that subsequent read
460 * transactions started by the same thread need no further locking to proceed.
462 * If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
464 * No reader table is used if the database is on a read-only filesystem, or
465 * if #MDB_NOLOCK is set.
467 * Since the database uses multi-version concurrency control, readers don't
468 * actually need any locking. This table is used to keep track of which
469 * readers are using data from which old transactions, so that we'll know
470 * when a particular old transaction is no longer in use. Old transactions
471 * that have discarded any data pages can then have those pages reclaimed
472 * for use by a later write transaction.
474 * The lock table is constructed such that reader slots are aligned with the
475 * processor's cache line size. Any slot is only ever used by one thread.
476 * This alignment guarantees that there will be no contention or cache
477 * thrashing as threads update their own slot info, and also eliminates
478 * any need for locking when accessing a slot.
480 * A writer thread will scan every slot in the table to determine the oldest
481 * outstanding reader transaction. Any freed pages older than this will be
482 * reclaimed by the writer. The writer doesn't use any locks when scanning
483 * this table. This means that there's no guarantee that the writer will
484 * see the most up-to-date reader info, but that's not required for correct
485 * operation - all we need is to know the upper bound on the oldest reader,
486 * we don't care at all about the newest reader. So the only consequence of
487 * reading stale information here is that old pages might hang around a
488 * while longer before being reclaimed. That's actually good anyway, because
489 * the longer we delay reclaiming old pages, the more likely it is that a
490 * string of contiguous pages can be found after coalescing old pages from
491 * many old transactions together.
494 /** Number of slots in the reader table.
495 * This value was chosen somewhat arbitrarily. 126 readers plus a
496 * couple mutexes fit exactly into 8KB on my development machine.
497 * Applications should set the table size using #mdb_env_set_maxreaders().
499 #define DEFAULT_READERS 126
501 /** The size of a CPU cache line in bytes. We want our lock structures
502 * aligned to this size to avoid false cache line sharing in the
504 * This value works for most CPUs. For Itanium this should be 128.
510 /** The information we store in a single slot of the reader table.
511 * In addition to a transaction ID, we also record the process and
512 * thread ID that owns a slot, so that we can detect stale information,
513 * e.g. threads or processes that went away without cleaning up.
514 * @note We currently don't check for stale records. We simply re-init
515 * the table when we know that we're the only process opening the
518 typedef struct MDB_rxbody {
519 /** Current Transaction ID when this transaction began, or (txnid_t)-1.
520 * Multiple readers that start at the same time will probably have the
521 * same ID here. Again, it's not important to exclude them from
522 * anything; all we need to know is which version of the DB they
523 * started from so we can avoid overwriting any data used in that
524 * particular version.
527 /** The process ID of the process owning this reader txn. */
529 /** The thread ID of the thread owning this txn. */
533 /** The actual reader record, with cacheline padding. */
534 typedef struct MDB_reader {
537 /** shorthand for mrb_txnid */
538 #define mr_txnid mru.mrx.mrb_txnid
539 #define mr_pid mru.mrx.mrb_pid
540 #define mr_tid mru.mrx.mrb_tid
541 /** cache line alignment */
542 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
546 /** The header for the reader table.
547 * The table resides in a memory-mapped file. (This is a different file
548 * than is used for the main database.)
550 * For POSIX the actual mutexes reside in the shared memory of this
551 * mapped file. On Windows, mutexes are named objects allocated by the
552 * kernel; we store the mutex names in this mapped file so that other
553 * processes can grab them. This same approach is also used on
554 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
555 * process-shared POSIX mutexes. For these cases where a named object
556 * is used, the object name is derived from a 64 bit FNV hash of the
557 * environment pathname. As such, naming collisions are extremely
558 * unlikely. If a collision occurs, the results are unpredictable.
560 typedef struct MDB_txbody {
561 /** Stamp identifying this as an MDB file. It must be set
564 /** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
566 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
567 char mtb_rmname[MNAME_LEN];
569 /** Mutex protecting access to this table.
570 * This is the reader lock that #LOCK_MUTEX_R acquires.
572 pthread_mutex_t mtb_mutex;
574 /** The ID of the last transaction committed to the database.
575 * This is recorded here only for convenience; the value can always
576 * be determined by reading the main database meta pages.
579 /** The number of slots that have been used in the reader table.
580 * This always records the maximum count, it is not decremented
581 * when readers release their slots.
583 unsigned mtb_numreaders;
586 /** The actual reader table definition. */
587 typedef struct MDB_txninfo {
590 #define mti_magic mt1.mtb.mtb_magic
591 #define mti_format mt1.mtb.mtb_format
592 #define mti_mutex mt1.mtb.mtb_mutex
593 #define mti_rmname mt1.mtb.mtb_rmname
594 #define mti_txnid mt1.mtb.mtb_txnid
595 #define mti_numreaders mt1.mtb.mtb_numreaders
596 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
599 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
600 char mt2_wmname[MNAME_LEN];
601 #define mti_wmname mt2.mt2_wmname
603 pthread_mutex_t mt2_wmutex;
604 #define mti_wmutex mt2.mt2_wmutex
606 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
608 MDB_reader mti_readers[1];
611 /** Lockfile format signature: version, features and field layout */
612 #define MDB_LOCK_FORMAT \
614 ((MDB_LOCK_VERSION) \
615 /* Flags which describe functionality */ \
616 + (((MDB_PIDLOCK) != 0) << 16)))
619 /** Common header for all page types.
620 * Overflow records occupy a number of contiguous pages with no
621 * headers on any page after the first.
623 typedef struct MDB_page {
624 #define mp_pgno mp_p.p_pgno
625 #define mp_next mp_p.p_next
627 pgno_t p_pgno; /**< page number */
628 void * p_next; /**< for in-memory list of freed structs */
631 /** @defgroup mdb_page Page Flags
633 * Flags for the page headers.
636 #define P_BRANCH 0x01 /**< branch page */
637 #define P_LEAF 0x02 /**< leaf page */
638 #define P_OVERFLOW 0x04 /**< overflow page */
639 #define P_META 0x08 /**< meta page */
640 #define P_DIRTY 0x10 /**< dirty page, also set for #P_SUBP pages */
641 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
642 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
643 #define P_KEEP 0x8000 /**< leave this page alone during spill */
645 uint16_t mp_flags; /**< @ref mdb_page */
646 #define mp_lower mp_pb.pb.pb_lower
647 #define mp_upper mp_pb.pb.pb_upper
648 #define mp_pages mp_pb.pb_pages
651 indx_t pb_lower; /**< lower bound of free space */
652 indx_t pb_upper; /**< upper bound of free space */
654 uint32_t pb_pages; /**< number of overflow pages */
656 indx_t mp_ptrs[1]; /**< dynamic size */
659 /** Size of the page header, excluding dynamic data at the end */
660 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
662 /** Address of first usable data byte in a page, after the header */
663 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
665 /** Number of nodes on a page */
666 #define NUMKEYS(p) (((p)->mp_lower - PAGEHDRSZ) >> 1)
668 /** The amount of space remaining in the page */
669 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
671 /** The percentage of space used in the page, in tenths of a percent. */
672 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
673 ((env)->me_psize - PAGEHDRSZ))
674 /** The minimum page fill factor, in tenths of a percent.
675 * Pages emptier than this are candidates for merging.
677 #define FILL_THRESHOLD 250
679 /** Test if a page is a leaf page */
680 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
681 /** Test if a page is a LEAF2 page */
682 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
683 /** Test if a page is a branch page */
684 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
685 /** Test if a page is an overflow page */
686 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
687 /** Test if a page is a sub page */
688 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
690 /** The number of overflow pages needed to store the given size. */
691 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
693 /** Header for a single key/data pair within a page.
694 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
695 * We guarantee 2-byte alignment for 'MDB_node's.
697 typedef struct MDB_node {
698 /** lo and hi are used for data size on leaf nodes and for
699 * child pgno on branch nodes. On 64 bit platforms, flags
700 * is also used for pgno. (Branch nodes have no flags).
701 * They are in host byte order in case that lets some
702 * accesses be optimized into a 32-bit word access.
704 #if BYTE_ORDER == LITTLE_ENDIAN
705 unsigned short mn_lo, mn_hi; /**< part of data size or pgno */
707 unsigned short mn_hi, mn_lo;
709 /** @defgroup mdb_node Node Flags
711 * Flags for node headers.
714 #define F_BIGDATA 0x01 /**< data put on overflow page */
715 #define F_SUBDATA 0x02 /**< data is a sub-database */
716 #define F_DUPDATA 0x04 /**< data has duplicates */
718 /** valid flags for #mdb_node_add() */
719 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
722 unsigned short mn_flags; /**< @ref mdb_node */
723 unsigned short mn_ksize; /**< key size */
724 char mn_data[1]; /**< key and data are appended here */
727 /** Size of the node header, excluding dynamic data at the end */
728 #define NODESIZE offsetof(MDB_node, mn_data)
730 /** Bit position of top word in page number, for shifting mn_flags */
731 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
733 /** Size of a node in a branch page with a given key.
734 * This is just the node header plus the key, there is no data.
736 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
738 /** Size of a node in a leaf page with a given key and data.
739 * This is node header plus key plus data size.
741 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
743 /** Address of node \b i in page \b p */
744 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i]))
746 /** Address of the key for the node */
747 #define NODEKEY(node) (void *)((node)->mn_data)
749 /** Address of the data for a node */
750 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
752 /** Get the page number pointed to by a branch node */
753 #define NODEPGNO(node) \
754 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
755 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
756 /** Set the page number in a branch node */
757 #define SETPGNO(node,pgno) do { \
758 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
759 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
761 /** Get the size of the data in a leaf node */
762 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
763 /** Set the size of the data for a leaf node */
764 #define SETDSZ(node,size) do { \
765 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
766 /** The size of a key in a node */
767 #define NODEKSZ(node) ((node)->mn_ksize)
769 /** Copy a page number from src to dst */
771 #define COPY_PGNO(dst,src) dst = src
773 #if SIZE_MAX > 4294967295UL
774 #define COPY_PGNO(dst,src) do { \
775 unsigned short *s, *d; \
776 s = (unsigned short *)&(src); \
777 d = (unsigned short *)&(dst); \
784 #define COPY_PGNO(dst,src) do { \
785 unsigned short *s, *d; \
786 s = (unsigned short *)&(src); \
787 d = (unsigned short *)&(dst); \
793 /** The address of a key in a LEAF2 page.
794 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
795 * There are no node headers, keys are stored contiguously.
797 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
799 /** Set the \b node's key into \b keyptr, if requested. */
800 #define MDB_GET_KEY(node, keyptr) { if ((keyptr) != NULL) { \
801 (keyptr)->mv_size = NODEKSZ(node); (keyptr)->mv_data = NODEKEY(node); } }
803 /** Set the \b node's key into \b key. */
804 #define MDB_GET_KEY2(node, key) { key.mv_size = NODEKSZ(node); key.mv_data = NODEKEY(node); }
806 /** Information about a single database in the environment. */
807 typedef struct MDB_db {
808 uint32_t md_pad; /**< also ksize for LEAF2 pages */
809 uint16_t md_flags; /**< @ref mdb_dbi_open */
810 uint16_t md_depth; /**< depth of this tree */
811 pgno_t md_branch_pages; /**< number of internal pages */
812 pgno_t md_leaf_pages; /**< number of leaf pages */
813 pgno_t md_overflow_pages; /**< number of overflow pages */
814 size_t md_entries; /**< number of data items */
815 pgno_t md_root; /**< the root page of this tree */
818 /** mdb_dbi_open flags */
819 #define MDB_VALID 0x8000 /**< DB handle is valid, for me_dbflags */
820 #define PERSISTENT_FLAGS (0xffff & ~(MDB_VALID))
821 #define VALID_FLAGS (MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
822 MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)
824 /** Handle for the DB used to track free pages. */
826 /** Handle for the default DB. */
829 /** Meta page content.
830 * A meta page is the start point for accessing a database snapshot.
831 * Pages 0-1 are meta pages. Transaction N writes meta page #(N % 2).
833 typedef struct MDB_meta {
834 /** Stamp identifying this as an MDB file. It must be set
837 /** Version number of this lock file. Must be set to #MDB_DATA_VERSION. */
839 void *mm_address; /**< address for fixed mapping */
840 size_t mm_mapsize; /**< size of mmap region */
841 MDB_db mm_dbs[2]; /**< first is free space, 2nd is main db */
842 /** The size of pages used in this DB */
843 #define mm_psize mm_dbs[0].md_pad
844 /** Any persistent environment flags. @ref mdb_env */
845 #define mm_flags mm_dbs[0].md_flags
846 pgno_t mm_last_pg; /**< last used page in file */
847 txnid_t mm_txnid; /**< txnid that committed this page */
850 /** Buffer for a stack-allocated meta page.
851 * The members define size and alignment, and silence type
852 * aliasing warnings. They are not used directly; that could
853 * mean incorrectly using several union members in parallel.
855 typedef union MDB_metabuf {
858 char mm_pad[PAGEHDRSZ];
863 /** Auxiliary DB info.
864 * The information here is mostly static/read-only. There is
865 * only a single copy of this record in the environment.
867 typedef struct MDB_dbx {
868 MDB_val md_name; /**< name of the database */
869 MDB_cmp_func *md_cmp; /**< function for comparing keys */
870 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
871 MDB_rel_func *md_rel; /**< user relocate function */
872 void *md_relctx; /**< user-provided context for md_rel */
875 /** A database transaction.
876 * Every operation requires a transaction handle.
879 MDB_txn *mt_parent; /**< parent of a nested txn */
880 MDB_txn *mt_child; /**< nested txn under this txn */
881 pgno_t mt_next_pgno; /**< next unallocated page */
882 /** The ID of this transaction. IDs are integers incrementing from 1.
883 * Only committed write transactions increment the ID. If a transaction
884 * aborts, the ID may be re-used by the next writer.
887 MDB_env *mt_env; /**< the DB environment */
888 /** The list of pages that became unused during this transaction.
891 /** The sorted list of dirty pages we temporarily wrote to disk
892 * because the dirty list was full. page numbers in here are
893 * shifted left by 1, deleted slots have the LSB set.
895 MDB_IDL mt_spill_pgs;
897 /** For write txns: Modified pages. Sorted when not MDB_WRITEMAP. */
899 /** For read txns: This thread/txn's reader table slot, or NULL. */
902 /** Array of records for each DB known in the environment. */
904 /** Array of MDB_db records for each known DB */
906 /** @defgroup mt_dbflag Transaction DB Flags
910 #define DB_DIRTY 0x01 /**< DB was modified or is DUPSORT data */
911 #define DB_STALE 0x02 /**< Named-DB record is older than txnID */
912 #define DB_NEW 0x04 /**< Named-DB handle opened in this txn */
913 #define DB_VALID 0x08 /**< DB handle is valid, see also #MDB_VALID */
915 /** In write txns, array of cursors for each DB */
916 MDB_cursor **mt_cursors;
917 /** Array of flags for each DB */
918 unsigned char *mt_dbflags;
919 /** Number of DB records in use. This number only ever increments;
920 * we don't decrement it when individual DB handles are closed.
924 /** @defgroup mdb_txn Transaction Flags
928 #define MDB_TXN_RDONLY 0x01 /**< read-only transaction */
929 #define MDB_TXN_ERROR 0x02 /**< an error has occurred */
930 #define MDB_TXN_DIRTY 0x04 /**< must write, even if dirty list is empty */
931 #define MDB_TXN_SPILLS 0x08 /**< txn or a parent has spilled pages */
933 unsigned int mt_flags; /**< @ref mdb_txn */
934 /** dirty_list room: Array size - #dirty pages visible to this txn.
935 * Includes ancestor txns' dirty pages not hidden by other txns'
936 * dirty/spilled pages. Thus commit(nested txn) has room to merge
937 * dirty_list into mt_parent after freeing hidden mt_parent pages.
939 unsigned int mt_dirty_room;
942 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
943 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
944 * raise this on a 64 bit machine.
946 #define CURSOR_STACK 32
950 /** Cursors are used for all DB operations.
951 * A cursor holds a path of (page pointer, key index) from the DB
952 * root to a position in the DB, plus other state. #MDB_DUPSORT
953 * cursors include an xcursor to the current data item. Write txns
954 * track their cursors and keep them up to date when data moves.
955 * Exception: An xcursor's pointer to a #P_SUBP page can be stale.
956 * (A node with #F_DUPDATA but no #F_SUBDATA contains a subpage).
959 /** Next cursor on this DB in this txn */
961 /** Backup of the original cursor if this cursor is a shadow */
962 MDB_cursor *mc_backup;
963 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
964 struct MDB_xcursor *mc_xcursor;
965 /** The transaction that owns this cursor */
967 /** The database handle this cursor operates on */
969 /** The database record for this cursor */
971 /** The database auxiliary record for this cursor */
973 /** The @ref mt_dbflag for this database */
974 unsigned char *mc_dbflag;
975 unsigned short mc_snum; /**< number of pushed pages */
976 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
977 /** @defgroup mdb_cursor Cursor Flags
979 * Cursor state flags.
982 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
983 #define C_EOF 0x02 /**< No more data */
984 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
985 #define C_DEL 0x08 /**< last op was a cursor_del */
986 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
987 #define C_UNTRACK 0x40 /**< Un-track cursor when closing */
989 unsigned int mc_flags; /**< @ref mdb_cursor */
990 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
991 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
994 /** Context for sorted-dup records.
995 * We could have gone to a fully recursive design, with arbitrarily
996 * deep nesting of sub-databases. But for now we only handle these
997 * levels - main DB, optional sub-DB, sorted-duplicate DB.
999 typedef struct MDB_xcursor {
1000 /** A sub-cursor for traversing the Dup DB */
1001 MDB_cursor mx_cursor;
1002 /** The database record for this Dup DB */
1004 /** The auxiliary DB record for this Dup DB */
1006 /** The @ref mt_dbflag for this Dup DB */
1007 unsigned char mx_dbflag;
1010 /** State of FreeDB old pages, stored in the MDB_env */
1011 typedef struct MDB_pgstate {
1012 pgno_t *mf_pghead; /**< Reclaimed freeDB pages, or NULL before use */
1013 txnid_t mf_pglast; /**< ID of last used record, or 0 if !mf_pghead */
1016 /** The database environment. */
1018 HANDLE me_fd; /**< The main data file */
1019 HANDLE me_lfd; /**< The lock file */
1020 HANDLE me_mfd; /**< just for writing the meta pages */
1021 /** Failed to update the meta page. Probably an I/O error. */
1022 #define MDB_FATAL_ERROR 0x80000000U
1023 /** Some fields are initialized. */
1024 #define MDB_ENV_ACTIVE 0x20000000U
1025 /** me_txkey is set */
1026 #define MDB_ENV_TXKEY 0x10000000U
1027 /** Have liveness lock in reader table */
1028 #define MDB_LIVE_READER 0x08000000U
1029 uint32_t me_flags; /**< @ref mdb_env */
1030 unsigned int me_psize; /**< DB page size, inited from me_os_psize */
1031 unsigned int me_os_psize; /**< OS page size, from #GET_PAGESIZE */
1032 unsigned int me_maxreaders; /**< size of the reader table */
1033 unsigned int me_numreaders; /**< max numreaders set by this env */
1034 MDB_dbi me_numdbs; /**< number of DBs opened */
1035 MDB_dbi me_maxdbs; /**< size of the DB table */
1036 MDB_PID_T me_pid; /**< process ID of this env */
1037 char *me_path; /**< path to the DB files */
1038 char *me_map; /**< the memory map of the data file */
1039 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
1040 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
1041 void *me_pbuf; /**< scratch area for DUPSORT put() */
1042 MDB_txn *me_txn; /**< current write transaction */
1043 size_t me_mapsize; /**< size of the data memory map */
1044 off_t me_size; /**< current file size */
1045 pgno_t me_maxpg; /**< me_mapsize / me_psize */
1046 MDB_dbx *me_dbxs; /**< array of static DB info */
1047 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
1048 pthread_key_t me_txkey; /**< thread-key for readers */
1049 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
1050 # define me_pglast me_pgstate.mf_pglast
1051 # define me_pghead me_pgstate.mf_pghead
1052 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
1053 /** IDL of pages that became unused in a write txn */
1054 MDB_IDL me_free_pgs;
1055 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
1056 MDB_ID2L me_dirty_list;
1057 /** Max number of freelist items that can fit in a single overflow page */
1059 /** Max size of a node on a page */
1060 unsigned int me_nodemax;
1061 #if !(MDB_MAXKEYSIZE)
1062 unsigned int me_maxkey; /**< max size of a key */
1065 int me_pidquery; /**< Used in OpenProcess */
1066 HANDLE me_rmutex; /* Windows mutexes don't reside in shared mem */
1068 #elif defined(MDB_USE_POSIX_SEM)
1069 sem_t *me_rmutex; /* Shared mutexes are not supported */
1074 /** Nested transaction */
1075 typedef struct MDB_ntxn {
1076 MDB_txn mnt_txn; /**< the transaction */
1077 MDB_pgstate mnt_pgstate; /**< parent transaction's saved freestate */
1080 /** max number of pages to commit in one writev() call */
1081 #define MDB_COMMIT_PAGES 64
1082 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
1083 #undef MDB_COMMIT_PAGES
1084 #define MDB_COMMIT_PAGES IOV_MAX
1087 /* max bytes to write in one call */
1088 #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4))
1090 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
1091 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
1092 static int mdb_page_touch(MDB_cursor *mc);
1094 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp, int *lvl);
1095 static int mdb_page_search_root(MDB_cursor *mc,
1096 MDB_val *key, int modify);
1097 #define MDB_PS_MODIFY 1
1098 #define MDB_PS_ROOTONLY 2
1099 #define MDB_PS_FIRST 4
1100 #define MDB_PS_LAST 8
1101 static int mdb_page_search(MDB_cursor *mc,
1102 MDB_val *key, int flags);
1103 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1105 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1106 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1107 pgno_t newpgno, unsigned int nflags);
1109 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1110 static int mdb_env_pick_meta(const MDB_env *env);
1111 static int mdb_env_write_meta(MDB_txn *txn);
1112 #if !(defined(_WIN32) || defined(MDB_USE_POSIX_SEM)) /* Drop unused excl arg */
1113 # define mdb_env_close0(env, excl) mdb_env_close1(env)
1115 static void mdb_env_close0(MDB_env *env, int excl);
1117 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1118 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1119 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1120 static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
1121 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1122 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1123 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1124 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1125 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1127 static int mdb_rebalance(MDB_cursor *mc);
1128 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1130 static void mdb_cursor_pop(MDB_cursor *mc);
1131 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1133 static int mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
1134 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1135 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1136 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1137 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1139 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1140 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1142 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1143 static void mdb_xcursor_init0(MDB_cursor *mc);
1144 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1146 static int mdb_drop0(MDB_cursor *mc, int subs);
1147 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1150 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1154 static SECURITY_DESCRIPTOR mdb_null_sd;
1155 static SECURITY_ATTRIBUTES mdb_all_sa;
1156 static int mdb_sec_inited;
1159 /** Return the library version info. */
1161 mdb_version(int *major, int *minor, int *patch)
1163 if (major) *major = MDB_VERSION_MAJOR;
1164 if (minor) *minor = MDB_VERSION_MINOR;
1165 if (patch) *patch = MDB_VERSION_PATCH;
1166 return MDB_VERSION_STRING;
1169 /** Table of descriptions for MDB @ref errors */
1170 static char *const mdb_errstr[] = {
1171 "MDB_KEYEXIST: Key/data pair already exists",
1172 "MDB_NOTFOUND: No matching key/data pair found",
1173 "MDB_PAGE_NOTFOUND: Requested page not found",
1174 "MDB_CORRUPTED: Located page was wrong type",
1175 "MDB_PANIC: Update of meta page failed",
1176 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1177 "MDB_INVALID: File is not an MDB file",
1178 "MDB_MAP_FULL: Environment mapsize limit reached",
1179 "MDB_DBS_FULL: Environment maxdbs limit reached",
1180 "MDB_READERS_FULL: Environment maxreaders limit reached",
1181 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1182 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1183 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1184 "MDB_PAGE_FULL: Internal error - page has no more space",
1185 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1186 "MDB_INCOMPATIBLE: Operation and DB incompatible, or DB flags changed",
1187 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1188 "MDB_BAD_TXN: Transaction cannot recover - it must be aborted",
1189 "MDB_BAD_VALSIZE: Too big key/data, key is empty, or wrong DUPFIXED size",
1193 mdb_strerror(int err)
1197 return ("Successful return: 0");
1199 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1200 i = err - MDB_KEYEXIST;
1201 return mdb_errstr[i];
1204 return strerror(err);
1208 /** Display a key in hexadecimal and return the address of the result.
1209 * @param[in] key the key to display
1210 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1211 * @return The key in hexadecimal form.
1214 mdb_dkey(MDB_val *key, char *buf)
1217 unsigned char *c = key->mv_data;
1223 if (key->mv_size > DKBUF_MAXKEYSIZE)
1224 return "MDB_MAXKEYSIZE";
1225 /* may want to make this a dynamic check: if the key is mostly
1226 * printable characters, print it as-is instead of converting to hex.
1230 for (i=0; i<key->mv_size; i++)
1231 ptr += sprintf(ptr, "%02x", *c++);
1233 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1238 /** Display all the keys in the page. */
1240 mdb_page_list(MDB_page *mp)
1243 unsigned int i, nkeys, nsize, total = 0;
1247 nkeys = NUMKEYS(mp);
1248 fprintf(stderr, "Page %"Z"u numkeys %d\n", mp->mp_pgno, nkeys);
1249 for (i=0; i<nkeys; i++) {
1250 node = NODEPTR(mp, i);
1251 key.mv_size = node->mn_ksize;
1252 key.mv_data = node->mn_data;
1253 nsize = NODESIZE + key.mv_size;
1254 if (IS_BRANCH(mp)) {
1255 fprintf(stderr, "key %d: page %"Z"u, %s\n", i, NODEPGNO(node),
1259 if (F_ISSET(node->mn_flags, F_BIGDATA))
1260 nsize += sizeof(pgno_t);
1262 nsize += NODEDSZ(node);
1264 nsize += sizeof(indx_t);
1265 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1267 total = EVEN(total);
1269 fprintf(stderr, "Total: %d\n", total);
1273 mdb_cursor_chk(MDB_cursor *mc)
1279 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1280 for (i=0; i<mc->mc_top; i++) {
1282 node = NODEPTR(mp, mc->mc_ki[i]);
1283 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1286 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1292 /** Count all the pages in each DB and in the freelist
1293 * and make sure it matches the actual number of pages
1296 static void mdb_audit(MDB_txn *txn)
1300 MDB_ID freecount, count;
1305 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1306 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1307 freecount += *(MDB_ID *)data.mv_data;
1310 for (i = 0; i<txn->mt_numdbs; i++) {
1312 mdb_cursor_init(&mc, txn, i, &mx);
1313 if (txn->mt_dbs[i].md_root == P_INVALID)
1315 count += txn->mt_dbs[i].md_branch_pages +
1316 txn->mt_dbs[i].md_leaf_pages +
1317 txn->mt_dbs[i].md_overflow_pages;
1318 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1319 mdb_page_search(&mc, NULL, MDB_PS_FIRST);
1323 mp = mc.mc_pg[mc.mc_top];
1324 for (j=0; j<NUMKEYS(mp); j++) {
1325 MDB_node *leaf = NODEPTR(mp, j);
1326 if (leaf->mn_flags & F_SUBDATA) {
1328 memcpy(&db, NODEDATA(leaf), sizeof(db));
1329 count += db.md_branch_pages + db.md_leaf_pages +
1330 db.md_overflow_pages;
1334 while (mdb_cursor_sibling(&mc, 1) == 0);
1337 if (freecount + count + 2 /* metapages */ != txn->mt_next_pgno) {
1338 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1339 txn->mt_txnid, freecount, count+2, freecount+count+2, txn->mt_next_pgno);
1345 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1347 return txn->mt_dbxs[dbi].md_cmp(a, b);
1351 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1353 return txn->mt_dbxs[dbi].md_dcmp(a, b);
1356 /** Allocate memory for a page.
1357 * Re-use old malloc'd pages first for singletons, otherwise just malloc.
1360 mdb_page_malloc(MDB_txn *txn, unsigned num)
1362 MDB_env *env = txn->mt_env;
1363 MDB_page *ret = env->me_dpages;
1364 size_t psize = env->me_psize, sz = psize, off;
1365 /* For ! #MDB_NOMEMINIT, psize counts how much to init.
1366 * For a single page alloc, we init everything after the page header.
1367 * For multi-page, we init the final page; if the caller needed that
1368 * many pages they will be filling in at least up to the last page.
1372 VGMEMP_ALLOC(env, ret, sz);
1373 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1374 env->me_dpages = ret->mp_next;
1377 psize -= off = PAGEHDRSZ;
1382 if ((ret = malloc(sz)) != NULL) {
1383 if (!(env->me_flags & MDB_NOMEMINIT)) {
1384 memset((char *)ret + off, 0, psize);
1387 VGMEMP_ALLOC(env, ret, sz);
1392 /** Free a single page.
1393 * Saves single pages to a list, for future reuse.
1394 * (This is not used for multi-page overflow pages.)
1397 mdb_page_free(MDB_env *env, MDB_page *mp)
1399 mp->mp_next = env->me_dpages;
1400 VGMEMP_FREE(env, mp);
1401 env->me_dpages = mp;
1404 /** Free a dirty page */
1406 mdb_dpage_free(MDB_env *env, MDB_page *dp)
1408 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1409 mdb_page_free(env, dp);
1411 /* large pages just get freed directly */
1412 VGMEMP_FREE(env, dp);
1417 /** Return all dirty pages to dpage list */
1419 mdb_dlist_free(MDB_txn *txn)
1421 MDB_env *env = txn->mt_env;
1422 MDB_ID2L dl = txn->mt_u.dirty_list;
1423 unsigned i, n = dl[0].mid;
1425 for (i = 1; i <= n; i++) {
1426 mdb_dpage_free(env, dl[i].mptr);
1431 /** Set or clear P_KEEP in dirty, non-overflow, non-sub pages watched by txn.
1432 * @param[in] mc A cursor handle for the current operation.
1433 * @param[in] pflags Flags of the pages to update:
1434 * P_DIRTY to set P_KEEP, P_DIRTY|P_KEEP to clear it.
1435 * @param[in] all No shortcuts. Needed except after a full #mdb_page_flush().
1436 * @return 0 on success, non-zero on failure.
1439 mdb_pages_xkeep(MDB_cursor *mc, unsigned pflags, int all)
1441 enum { Mask = P_SUBP|P_DIRTY|P_KEEP };
1442 MDB_txn *txn = mc->mc_txn;
1448 int rc = MDB_SUCCESS, level;
1450 /* Mark pages seen by cursors */
1451 if (mc->mc_flags & C_UNTRACK)
1452 mc = NULL; /* will find mc in mt_cursors */
1453 for (i = txn->mt_numdbs;; mc = txn->mt_cursors[--i]) {
1454 for (; mc; mc=mc->mc_next) {
1455 if (!(mc->mc_flags & C_INITIALIZED))
1457 for (m3 = mc;; m3 = &mx->mx_cursor) {
1459 for (j=0; j<m3->mc_snum; j++) {
1461 if ((mp->mp_flags & Mask) == pflags)
1462 mp->mp_flags ^= P_KEEP;
1464 mx = m3->mc_xcursor;
1465 /* Proceed to mx if it is at a sub-database */
1466 if (! (mx && (mx->mx_cursor.mc_flags & C_INITIALIZED)))
1468 if (! (mp && (mp->mp_flags & P_LEAF)))
1470 leaf = NODEPTR(mp, m3->mc_ki[j-1]);
1471 if (!(leaf->mn_flags & F_SUBDATA))
1480 /* Mark dirty root pages */
1481 for (i=0; i<txn->mt_numdbs; i++) {
1482 if (txn->mt_dbflags[i] & DB_DIRTY) {
1483 pgno_t pgno = txn->mt_dbs[i].md_root;
1484 if (pgno == P_INVALID)
1486 if ((rc = mdb_page_get(txn, pgno, &dp, &level)) != MDB_SUCCESS)
1488 if ((dp->mp_flags & Mask) == pflags && level <= 1)
1489 dp->mp_flags ^= P_KEEP;
1497 static int mdb_page_flush(MDB_txn *txn, int keep);
1499 /** Spill pages from the dirty list back to disk.
1500 * This is intended to prevent running into #MDB_TXN_FULL situations,
1501 * but note that they may still occur in a few cases:
1502 * 1) our estimate of the txn size could be too small. Currently this
1503 * seems unlikely, except with a large number of #MDB_MULTIPLE items.
1504 * 2) child txns may run out of space if their parents dirtied a
1505 * lot of pages and never spilled them. TODO: we probably should do
1506 * a preemptive spill during #mdb_txn_begin() of a child txn, if
1507 * the parent's dirty_room is below a given threshold.
1509 * Otherwise, if not using nested txns, it is expected that apps will
1510 * not run into #MDB_TXN_FULL any more. The pages are flushed to disk
1511 * the same way as for a txn commit, e.g. their P_DIRTY flag is cleared.
1512 * If the txn never references them again, they can be left alone.
1513 * If the txn only reads them, they can be used without any fuss.
1514 * If the txn writes them again, they can be dirtied immediately without
1515 * going thru all of the work of #mdb_page_touch(). Such references are
1516 * handled by #mdb_page_unspill().
1518 * Also note, we never spill DB root pages, nor pages of active cursors,
1519 * because we'll need these back again soon anyway. And in nested txns,
1520 * we can't spill a page in a child txn if it was already spilled in a
1521 * parent txn. That would alter the parent txns' data even though
1522 * the child hasn't committed yet, and we'd have no way to undo it if
1523 * the child aborted.
1525 * @param[in] m0 cursor A cursor handle identifying the transaction and
1526 * database for which we are checking space.
1527 * @param[in] key For a put operation, the key being stored.
1528 * @param[in] data For a put operation, the data being stored.
1529 * @return 0 on success, non-zero on failure.
1532 mdb_page_spill(MDB_cursor *m0, MDB_val *key, MDB_val *data)
1534 MDB_txn *txn = m0->mc_txn;
1536 MDB_ID2L dl = txn->mt_u.dirty_list;
1537 unsigned int i, j, need;
1540 if (m0->mc_flags & C_SUB)
1543 /* Estimate how much space this op will take */
1544 i = m0->mc_db->md_depth;
1545 /* Named DBs also dirty the main DB */
1546 if (m0->mc_dbi > MAIN_DBI)
1547 i += txn->mt_dbs[MAIN_DBI].md_depth;
1548 /* For puts, roughly factor in the key+data size */
1550 i += (LEAFSIZE(key, data) + txn->mt_env->me_psize) / txn->mt_env->me_psize;
1551 i += i; /* double it for good measure */
1554 if (txn->mt_dirty_room > i)
1557 if (!txn->mt_spill_pgs) {
1558 txn->mt_spill_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX);
1559 if (!txn->mt_spill_pgs)
1562 /* purge deleted slots */
1563 MDB_IDL sl = txn->mt_spill_pgs;
1564 unsigned int num = sl[0];
1566 for (i=1; i<=num; i++) {
1573 /* Preserve pages which may soon be dirtied again */
1574 if ((rc = mdb_pages_xkeep(m0, P_DIRTY, 1)) != MDB_SUCCESS)
1577 /* Less aggressive spill - we originally spilled the entire dirty list,
1578 * with a few exceptions for cursor pages and DB root pages. But this
1579 * turns out to be a lot of wasted effort because in a large txn many
1580 * of those pages will need to be used again. So now we spill only 1/8th
1581 * of the dirty pages. Testing revealed this to be a good tradeoff,
1582 * better than 1/2, 1/4, or 1/10.
1584 if (need < MDB_IDL_UM_MAX / 8)
1585 need = MDB_IDL_UM_MAX / 8;
1587 /* Save the page IDs of all the pages we're flushing */
1588 /* flush from the tail forward, this saves a lot of shifting later on. */
1589 for (i=dl[0].mid; i && need; i--) {
1590 MDB_ID pn = dl[i].mid << 1;
1592 if (dp->mp_flags & P_KEEP)
1594 /* Can't spill twice, make sure it's not already in a parent's
1597 if (txn->mt_parent) {
1599 for (tx2 = txn->mt_parent; tx2; tx2 = tx2->mt_parent) {
1600 if (tx2->mt_spill_pgs) {
1601 j = mdb_midl_search(tx2->mt_spill_pgs, pn);
1602 if (j <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[j] == pn) {
1603 dp->mp_flags |= P_KEEP;
1611 if ((rc = mdb_midl_append(&txn->mt_spill_pgs, pn)))
1615 mdb_midl_sort(txn->mt_spill_pgs);
1617 /* Flush the spilled part of dirty list */
1618 if ((rc = mdb_page_flush(txn, i)) != MDB_SUCCESS)
1621 /* Reset any dirty pages we kept that page_flush didn't see */
1622 rc = mdb_pages_xkeep(m0, P_DIRTY|P_KEEP, i);
1625 txn->mt_flags |= rc ? MDB_TXN_ERROR : MDB_TXN_SPILLS;
1629 /** Find oldest txnid still referenced. Expects txn->mt_txnid > 0. */
1631 mdb_find_oldest(MDB_txn *txn)
1634 txnid_t mr, oldest = txn->mt_txnid - 1;
1635 if (txn->mt_env->me_txns) {
1636 MDB_reader *r = txn->mt_env->me_txns->mti_readers;
1637 for (i = txn->mt_env->me_txns->mti_numreaders; --i >= 0; ) {
1648 /** Add a page to the txn's dirty list */
1650 mdb_page_dirty(MDB_txn *txn, MDB_page *mp)
1653 int (*insert)(MDB_ID2L, MDB_ID2 *);
1655 if (txn->mt_env->me_flags & MDB_WRITEMAP) {
1656 insert = mdb_mid2l_append;
1658 insert = mdb_mid2l_insert;
1660 mid.mid = mp->mp_pgno;
1662 insert(txn->mt_u.dirty_list, &mid);
1663 txn->mt_dirty_room--;
1666 /** Allocate page numbers and memory for writing. Maintain me_pglast,
1667 * me_pghead and mt_next_pgno.
1669 * If there are free pages available from older transactions, they
1670 * are re-used first. Otherwise allocate a new page at mt_next_pgno.
1671 * Do not modify the freedB, just merge freeDB records into me_pghead[]
1672 * and move me_pglast to say which records were consumed. Only this
1673 * function can create me_pghead and move me_pglast/mt_next_pgno.
1674 * @param[in] mc cursor A cursor handle identifying the transaction and
1675 * database for which we are allocating.
1676 * @param[in] num the number of pages to allocate.
1677 * @param[out] mp Address of the allocated page(s). Requests for multiple pages
1678 * will always be satisfied by a single contiguous chunk of memory.
1679 * @return 0 on success, non-zero on failure.
1682 mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp)
1684 #ifdef MDB_PARANOID /* Seems like we can ignore this now */
1685 /* Get at most <Max_retries> more freeDB records once me_pghead
1686 * has enough pages. If not enough, use new pages from the map.
1687 * If <Paranoid> and mc is updating the freeDB, only get new
1688 * records if me_pghead is empty. Then the freelist cannot play
1689 * catch-up with itself by growing while trying to save it.
1691 enum { Paranoid = 1, Max_retries = 500 };
1693 enum { Paranoid = 0, Max_retries = INT_MAX /*infinite*/ };
1695 int rc, retry = Max_retries;
1696 MDB_txn *txn = mc->mc_txn;
1697 MDB_env *env = txn->mt_env;
1698 pgno_t pgno, *mop = env->me_pghead;
1699 unsigned i, j, k, mop_len = mop ? mop[0] : 0, n2 = num-1;
1701 txnid_t oldest = 0, last;
1707 /* If our dirty list is already full, we can't do anything */
1708 if (txn->mt_dirty_room == 0)
1709 return MDB_TXN_FULL;
1711 for (op = MDB_FIRST;; op = MDB_NEXT) {
1714 pgno_t *idl, old_id, new_id;
1716 /* Seek a big enough contiguous page range. Prefer
1717 * pages at the tail, just truncating the list.
1723 if (mop[i-n2] == pgno+n2)
1726 if (Max_retries < INT_MAX && --retry < 0)
1730 if (op == MDB_FIRST) { /* 1st iteration */
1731 /* Prepare to fetch more and coalesce */
1732 oldest = mdb_find_oldest(txn);
1733 last = env->me_pglast;
1734 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
1737 key.mv_data = &last; /* will look up last+1 */
1738 key.mv_size = sizeof(last);
1740 if (Paranoid && mc->mc_dbi == FREE_DBI)
1743 if (Paranoid && retry < 0 && mop_len)
1747 /* Do not fetch more if the record will be too recent */
1750 rc = mdb_cursor_get(&m2, &key, NULL, op);
1752 if (rc == MDB_NOTFOUND)
1756 last = *(txnid_t*)key.mv_data;
1759 np = m2.mc_pg[m2.mc_top];
1760 leaf = NODEPTR(np, m2.mc_ki[m2.mc_top]);
1761 if ((rc = mdb_node_read(txn, leaf, &data)) != MDB_SUCCESS)
1764 idl = (MDB_ID *) data.mv_data;
1767 if (!(env->me_pghead = mop = mdb_midl_alloc(i)))
1770 if ((rc = mdb_midl_need(&env->me_pghead, i)) != 0)
1772 mop = env->me_pghead;
1774 env->me_pglast = last;
1776 DPRINTF(("IDL read txn %"Z"u root %"Z"u num %u",
1777 last, txn->mt_dbs[FREE_DBI].md_root, i));
1779 DPRINTF(("IDL %"Z"u", idl[k]));
1781 /* Merge in descending sorted order */
1784 mop[0] = (pgno_t)-1;
1788 for (; old_id < new_id; old_id = mop[--j])
1795 /* Use new pages from the map when nothing suitable in the freeDB */
1797 pgno = txn->mt_next_pgno;
1798 if (pgno + num >= env->me_maxpg) {
1799 DPUTS("DB size maxed out");
1800 return MDB_MAP_FULL;
1804 if (env->me_flags & MDB_WRITEMAP) {
1805 np = (MDB_page *)(env->me_map + env->me_psize * pgno);
1807 if (!(np = mdb_page_malloc(txn, num)))
1811 mop[0] = mop_len -= num;
1812 /* Move any stragglers down */
1813 for (j = i-num; j < mop_len; )
1814 mop[++j] = mop[++i];
1816 txn->mt_next_pgno = pgno + num;
1819 mdb_page_dirty(txn, np);
1825 /** Copy the used portions of a non-overflow page.
1826 * @param[in] dst page to copy into
1827 * @param[in] src page to copy from
1828 * @param[in] psize size of a page
1831 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
1833 enum { Align = sizeof(pgno_t) };
1834 indx_t upper = src->mp_upper, lower = src->mp_lower, unused = upper-lower;
1836 /* If page isn't full, just copy the used portion. Adjust
1837 * alignment so memcpy may copy words instead of bytes.
1839 if ((unused &= -Align) && !IS_LEAF2(src)) {
1841 memcpy(dst, src, (lower + (Align-1)) & -Align);
1842 memcpy((pgno_t *)((char *)dst+upper), (pgno_t *)((char *)src+upper),
1845 memcpy(dst, src, psize - unused);
1849 /** Pull a page off the txn's spill list, if present.
1850 * If a page being referenced was spilled to disk in this txn, bring
1851 * it back and make it dirty/writable again.
1852 * @param[in] txn the transaction handle.
1853 * @param[in] mp the page being referenced. It must not be dirty.
1854 * @param[out] ret the writable page, if any. ret is unchanged if
1855 * mp wasn't spilled.
1858 mdb_page_unspill(MDB_txn *txn, MDB_page *mp, MDB_page **ret)
1860 MDB_env *env = txn->mt_env;
1863 pgno_t pgno = mp->mp_pgno, pn = pgno << 1;
1865 for (tx2 = txn; tx2; tx2=tx2->mt_parent) {
1866 if (!tx2->mt_spill_pgs)
1868 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
1869 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
1872 if (txn->mt_dirty_room == 0)
1873 return MDB_TXN_FULL;
1874 if (IS_OVERFLOW(mp))
1878 if (env->me_flags & MDB_WRITEMAP) {
1881 np = mdb_page_malloc(txn, num);
1885 memcpy(np, mp, num * env->me_psize);
1887 mdb_page_copy(np, mp, env->me_psize);
1890 /* If in current txn, this page is no longer spilled.
1891 * If it happens to be the last page, truncate the spill list.
1892 * Otherwise mark it as deleted by setting the LSB.
1894 if (x == txn->mt_spill_pgs[0])
1895 txn->mt_spill_pgs[0]--;
1897 txn->mt_spill_pgs[x] |= 1;
1898 } /* otherwise, if belonging to a parent txn, the
1899 * page remains spilled until child commits
1902 mdb_page_dirty(txn, np);
1903 np->mp_flags |= P_DIRTY;
1911 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
1912 * @param[in] mc cursor pointing to the page to be touched
1913 * @return 0 on success, non-zero on failure.
1916 mdb_page_touch(MDB_cursor *mc)
1918 MDB_page *mp = mc->mc_pg[mc->mc_top], *np;
1919 MDB_txn *txn = mc->mc_txn;
1920 MDB_cursor *m2, *m3;
1924 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
1925 if (txn->mt_flags & MDB_TXN_SPILLS) {
1927 rc = mdb_page_unspill(txn, mp, &np);
1933 if ((rc = mdb_midl_need(&txn->mt_free_pgs, 1)) ||
1934 (rc = mdb_page_alloc(mc, 1, &np)))
1937 DPRINTF(("touched db %d page %"Z"u -> %"Z"u", DDBI(mc),
1938 mp->mp_pgno, pgno));
1939 assert(mp->mp_pgno != pgno);
1940 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
1941 /* Update the parent page, if any, to point to the new page */
1943 MDB_page *parent = mc->mc_pg[mc->mc_top-1];
1944 MDB_node *node = NODEPTR(parent, mc->mc_ki[mc->mc_top-1]);
1945 SETPGNO(node, pgno);
1947 mc->mc_db->md_root = pgno;
1949 } else if (txn->mt_parent && !IS_SUBP(mp)) {
1950 MDB_ID2 mid, *dl = txn->mt_u.dirty_list;
1952 /* If txn has a parent, make sure the page is in our
1956 unsigned x = mdb_mid2l_search(dl, pgno);
1957 if (x <= dl[0].mid && dl[x].mid == pgno) {
1958 if (mp != dl[x].mptr) { /* bad cursor? */
1959 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
1960 return MDB_CORRUPTED;
1965 assert(dl[0].mid < MDB_IDL_UM_MAX);
1967 np = mdb_page_malloc(txn, 1);
1972 mdb_mid2l_insert(dl, &mid);
1977 mdb_page_copy(np, mp, txn->mt_env->me_psize);
1979 np->mp_flags |= P_DIRTY;
1982 /* Adjust cursors pointing to mp */
1983 mc->mc_pg[mc->mc_top] = np;
1984 m2 = txn->mt_cursors[mc->mc_dbi];
1985 if (mc->mc_flags & C_SUB) {
1986 for (; m2; m2=m2->mc_next) {
1987 m3 = &m2->mc_xcursor->mx_cursor;
1988 if (m3->mc_snum < mc->mc_snum) continue;
1989 if (m3->mc_pg[mc->mc_top] == mp)
1990 m3->mc_pg[mc->mc_top] = np;
1993 for (; m2; m2=m2->mc_next) {
1994 if (m2->mc_snum < mc->mc_snum) continue;
1995 if (m2->mc_pg[mc->mc_top] == mp) {
1996 m2->mc_pg[mc->mc_top] = np;
1997 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
1998 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
2000 MDB_node *leaf = NODEPTR(np, mc->mc_ki[mc->mc_top]);
2001 if (!(leaf->mn_flags & F_SUBDATA))
2002 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
2011 mdb_env_sync(MDB_env *env, int force)
2014 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
2015 if (env->me_flags & MDB_WRITEMAP) {
2016 int flags = ((env->me_flags & MDB_MAPASYNC) && !force)
2017 ? MS_ASYNC : MS_SYNC;
2018 if (MDB_MSYNC(env->me_map, env->me_mapsize, flags))
2021 else if (flags == MS_SYNC && MDB_FDATASYNC(env->me_fd))
2025 if (MDB_FDATASYNC(env->me_fd))
2032 /** Back up parent txn's cursors, then grab the originals for tracking */
2034 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
2036 MDB_cursor *mc, *bk;
2041 for (i = src->mt_numdbs; --i >= 0; ) {
2042 if ((mc = src->mt_cursors[i]) != NULL) {
2043 size = sizeof(MDB_cursor);
2045 size += sizeof(MDB_xcursor);
2046 for (; mc; mc = bk->mc_next) {
2052 mc->mc_db = &dst->mt_dbs[i];
2053 /* Kill pointers into src - and dst to reduce abuse: The
2054 * user may not use mc until dst ends. Otherwise we'd...
2056 mc->mc_txn = NULL; /* ...set this to dst */
2057 mc->mc_dbflag = NULL; /* ...and &dst->mt_dbflags[i] */
2058 if ((mx = mc->mc_xcursor) != NULL) {
2059 *(MDB_xcursor *)(bk+1) = *mx;
2060 mx->mx_cursor.mc_txn = NULL; /* ...and dst. */
2062 mc->mc_next = dst->mt_cursors[i];
2063 dst->mt_cursors[i] = mc;
2070 /** Close this write txn's cursors, give parent txn's cursors back to parent.
2071 * @param[in] txn the transaction handle.
2072 * @param[in] merge true to keep changes to parent cursors, false to revert.
2073 * @return 0 on success, non-zero on failure.
2076 mdb_cursors_close(MDB_txn *txn, unsigned merge)
2078 MDB_cursor **cursors = txn->mt_cursors, *mc, *next, *bk;
2082 for (i = txn->mt_numdbs; --i >= 0; ) {
2083 for (mc = cursors[i]; mc; mc = next) {
2085 if ((bk = mc->mc_backup) != NULL) {
2087 /* Commit changes to parent txn */
2088 mc->mc_next = bk->mc_next;
2089 mc->mc_backup = bk->mc_backup;
2090 mc->mc_txn = bk->mc_txn;
2091 mc->mc_db = bk->mc_db;
2092 mc->mc_dbflag = bk->mc_dbflag;
2093 if ((mx = mc->mc_xcursor) != NULL)
2094 mx->mx_cursor.mc_txn = bk->mc_txn;
2096 /* Abort nested txn */
2098 if ((mx = mc->mc_xcursor) != NULL)
2099 *mx = *(MDB_xcursor *)(bk+1);
2103 /* Only malloced cursors are permanently tracked. */
2111 #define mdb_txn_reset0(txn, act) mdb_txn_reset0(txn)
2114 mdb_txn_reset0(MDB_txn *txn, const char *act);
2116 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2122 Pidset = F_SETLK, Pidcheck = F_GETLK
2126 /** Set or check a pid lock. Set returns 0 on success.
2127 * Check returns 0 if the process is certainly dead, nonzero if it may
2128 * be alive (the lock exists or an error happened so we do not know).
2130 * On Windows Pidset is a no-op, we merely check for the existence
2131 * of the process with the given pid. On POSIX we use a single byte
2132 * lock on the lockfile, set at an offset equal to the pid.
2135 mdb_reader_pid(MDB_env *env, enum Pidlock_op op, MDB_PID_T pid)
2137 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2140 if (op == Pidcheck) {
2141 h = OpenProcess(env->me_pidquery, FALSE, pid);
2142 /* No documented "no such process" code, but other program use this: */
2144 return ErrCode() != ERROR_INVALID_PARAMETER;
2145 /* A process exists until all handles to it close. Has it exited? */
2146 ret = WaitForSingleObject(h, 0) != 0;
2153 struct flock lock_info;
2154 memset(&lock_info, 0, sizeof(lock_info));
2155 lock_info.l_type = F_WRLCK;
2156 lock_info.l_whence = SEEK_SET;
2157 lock_info.l_start = pid;
2158 lock_info.l_len = 1;
2159 if ((rc = fcntl(env->me_lfd, op, &lock_info)) == 0) {
2160 if (op == F_GETLK && lock_info.l_type != F_UNLCK)
2162 } else if ((rc = ErrCode()) == EINTR) {
2170 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
2171 * @param[in] txn the transaction handle to initialize
2172 * @return 0 on success, non-zero on failure.
2175 mdb_txn_renew0(MDB_txn *txn)
2177 MDB_env *env = txn->mt_env;
2178 MDB_txninfo *ti = env->me_txns;
2182 int rc, new_notls = 0;
2185 txn->mt_numdbs = env->me_numdbs;
2186 txn->mt_dbxs = env->me_dbxs; /* mostly static anyway */
2188 if (txn->mt_flags & MDB_TXN_RDONLY) {
2190 meta = env->me_metas[ mdb_env_pick_meta(env) ];
2191 txn->mt_txnid = meta->mm_txnid;
2192 txn->mt_u.reader = NULL;
2194 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
2195 pthread_getspecific(env->me_txkey);
2197 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
2198 return MDB_BAD_RSLOT;
2200 MDB_PID_T pid = env->me_pid;
2201 pthread_t tid = pthread_self();
2203 if (!(env->me_flags & MDB_LIVE_READER)) {
2204 rc = mdb_reader_pid(env, Pidset, pid);
2207 env->me_flags |= MDB_LIVE_READER;
2211 nr = ti->mti_numreaders;
2212 for (i=0; i<nr; i++)
2213 if (ti->mti_readers[i].mr_pid == 0)
2215 if (i == env->me_maxreaders) {
2216 UNLOCK_MUTEX_R(env);
2217 return MDB_READERS_FULL;
2219 ti->mti_readers[i].mr_pid = pid;
2220 ti->mti_readers[i].mr_tid = tid;
2222 ti->mti_numreaders = ++nr;
2223 /* Save numreaders for un-mutexed mdb_env_close() */
2224 env->me_numreaders = nr;
2225 UNLOCK_MUTEX_R(env);
2227 r = &ti->mti_readers[i];
2228 new_notls = (env->me_flags & MDB_NOTLS);
2229 if (!new_notls && (rc=pthread_setspecific(env->me_txkey, r))) {
2234 txn->mt_txnid = r->mr_txnid = ti->mti_txnid;
2235 txn->mt_u.reader = r;
2236 meta = env->me_metas[txn->mt_txnid & 1];
2242 txn->mt_txnid = ti->mti_txnid;
2243 meta = env->me_metas[txn->mt_txnid & 1];
2245 meta = env->me_metas[ mdb_env_pick_meta(env) ];
2246 txn->mt_txnid = meta->mm_txnid;
2250 if (txn->mt_txnid == mdb_debug_start)
2253 txn->mt_dirty_room = MDB_IDL_UM_MAX;
2254 txn->mt_u.dirty_list = env->me_dirty_list;
2255 txn->mt_u.dirty_list[0].mid = 0;
2256 txn->mt_free_pgs = env->me_free_pgs;
2257 txn->mt_free_pgs[0] = 0;
2258 txn->mt_spill_pgs = NULL;
2262 /* Copy the DB info and flags */
2263 memcpy(txn->mt_dbs, meta->mm_dbs, 2 * sizeof(MDB_db));
2265 /* Moved to here to avoid a data race in read TXNs */
2266 txn->mt_next_pgno = meta->mm_last_pg+1;
2268 for (i=2; i<txn->mt_numdbs; i++) {
2269 x = env->me_dbflags[i];
2270 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
2271 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_STALE : 0;
2273 txn->mt_dbflags[0] = txn->mt_dbflags[1] = DB_VALID;
2275 if (env->me_maxpg < txn->mt_next_pgno) {
2276 mdb_txn_reset0(txn, "renew0-mapfail");
2278 txn->mt_u.reader->mr_pid = 0;
2279 txn->mt_u.reader = NULL;
2281 return MDB_MAP_RESIZED;
2288 mdb_txn_renew(MDB_txn *txn)
2292 if (!txn || txn->mt_dbxs) /* A reset txn has mt_dbxs==NULL */
2295 if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
2296 DPUTS("environment had fatal error, must shutdown!");
2300 rc = mdb_txn_renew0(txn);
2301 if (rc == MDB_SUCCESS) {
2302 DPRINTF(("renew txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2303 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2304 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root));
2310 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
2314 int rc, size, tsize = sizeof(MDB_txn);
2316 if (env->me_flags & MDB_FATAL_ERROR) {
2317 DPUTS("environment had fatal error, must shutdown!");
2320 if ((env->me_flags & MDB_RDONLY) && !(flags & MDB_RDONLY))
2323 /* Nested transactions: Max 1 child, write txns only, no writemap */
2324 if (parent->mt_child ||
2325 (flags & MDB_RDONLY) ||
2326 (parent->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR)) ||
2327 (env->me_flags & MDB_WRITEMAP))
2329 return (parent->mt_flags & MDB_TXN_RDONLY) ? EINVAL : MDB_BAD_TXN;
2331 tsize = sizeof(MDB_ntxn);
2333 size = tsize + env->me_maxdbs * (sizeof(MDB_db)+1);
2334 if (!(flags & MDB_RDONLY))
2335 size += env->me_maxdbs * sizeof(MDB_cursor *);
2337 if ((txn = calloc(1, size)) == NULL) {
2338 DPRINTF(("calloc: %s", strerror(ErrCode())));
2341 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
2342 if (flags & MDB_RDONLY) {
2343 txn->mt_flags |= MDB_TXN_RDONLY;
2344 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
2346 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
2347 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
2353 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
2354 if (!txn->mt_u.dirty_list ||
2355 !(txn->mt_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)))
2357 free(txn->mt_u.dirty_list);
2361 txn->mt_txnid = parent->mt_txnid;
2362 txn->mt_dirty_room = parent->mt_dirty_room;
2363 txn->mt_u.dirty_list[0].mid = 0;
2364 txn->mt_spill_pgs = NULL;
2365 txn->mt_next_pgno = parent->mt_next_pgno;
2366 parent->mt_child = txn;
2367 txn->mt_parent = parent;
2368 txn->mt_numdbs = parent->mt_numdbs;
2369 txn->mt_flags = parent->mt_flags;
2370 txn->mt_dbxs = parent->mt_dbxs;
2371 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2372 /* Copy parent's mt_dbflags, but clear DB_NEW */
2373 for (i=0; i<txn->mt_numdbs; i++)
2374 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
2376 ntxn = (MDB_ntxn *)txn;
2377 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
2378 if (env->me_pghead) {
2379 size = MDB_IDL_SIZEOF(env->me_pghead);
2380 env->me_pghead = mdb_midl_alloc(env->me_pghead[0]);
2382 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
2387 rc = mdb_cursor_shadow(parent, txn);
2389 mdb_txn_reset0(txn, "beginchild-fail");
2391 rc = mdb_txn_renew0(txn);
2397 DPRINTF(("begin txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2398 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2399 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root));
2406 mdb_txn_env(MDB_txn *txn)
2408 if(!txn) return NULL;
2412 /** Export or close DBI handles opened in this txn. */
2414 mdb_dbis_update(MDB_txn *txn, int keep)
2417 MDB_dbi n = txn->mt_numdbs;
2418 MDB_env *env = txn->mt_env;
2419 unsigned char *tdbflags = txn->mt_dbflags;
2421 for (i = n; --i >= 2;) {
2422 if (tdbflags[i] & DB_NEW) {
2424 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2426 char *ptr = env->me_dbxs[i].md_name.mv_data;
2427 env->me_dbxs[i].md_name.mv_data = NULL;
2428 env->me_dbxs[i].md_name.mv_size = 0;
2429 env->me_dbflags[i] = 0;
2434 if (keep && env->me_numdbs < n)
2438 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
2439 * May be called twice for readonly txns: First reset it, then abort.
2440 * @param[in] txn the transaction handle to reset
2441 * @param[in] act why the transaction is being reset
2444 mdb_txn_reset0(MDB_txn *txn, const char *act)
2446 MDB_env *env = txn->mt_env;
2448 /* Close any DBI handles opened in this txn */
2449 mdb_dbis_update(txn, 0);
2451 DPRINTF(("%s txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2452 act, txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2453 (void *) txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root));
2455 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2456 if (txn->mt_u.reader) {
2457 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
2458 if (!(env->me_flags & MDB_NOTLS))
2459 txn->mt_u.reader = NULL; /* txn does not own reader */
2461 txn->mt_numdbs = 0; /* close nothing if called again */
2462 txn->mt_dbxs = NULL; /* mark txn as reset */
2464 mdb_cursors_close(txn, 0);
2466 if (!(env->me_flags & MDB_WRITEMAP)) {
2467 mdb_dlist_free(txn);
2469 mdb_midl_free(env->me_pghead);
2471 if (txn->mt_parent) {
2472 txn->mt_parent->mt_child = NULL;
2473 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2474 mdb_midl_free(txn->mt_free_pgs);
2475 mdb_midl_free(txn->mt_spill_pgs);
2476 free(txn->mt_u.dirty_list);
2480 if (mdb_midl_shrink(&txn->mt_free_pgs))
2481 env->me_free_pgs = txn->mt_free_pgs;
2482 env->me_pghead = NULL;
2486 /* The writer mutex was locked in mdb_txn_begin. */
2488 UNLOCK_MUTEX_W(env);
2493 mdb_txn_reset(MDB_txn *txn)
2498 /* This call is only valid for read-only txns */
2499 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2502 mdb_txn_reset0(txn, "reset");
2506 mdb_txn_abort(MDB_txn *txn)
2512 mdb_txn_abort(txn->mt_child);
2514 mdb_txn_reset0(txn, "abort");
2515 /* Free reader slot tied to this txn (if MDB_NOTLS && writable FS) */
2516 if ((txn->mt_flags & MDB_TXN_RDONLY) && txn->mt_u.reader)
2517 txn->mt_u.reader->mr_pid = 0;
2522 /** Save the freelist as of this transaction to the freeDB.
2523 * This changes the freelist. Keep trying until it stabilizes.
2526 mdb_freelist_save(MDB_txn *txn)
2528 /* env->me_pghead[] can grow and shrink during this call.
2529 * env->me_pglast and txn->mt_free_pgs[] can only grow.
2530 * Page numbers cannot disappear from txn->mt_free_pgs[].
2533 MDB_env *env = txn->mt_env;
2534 int rc, maxfree_1pg = env->me_maxfree_1pg, more = 1;
2535 txnid_t pglast = 0, head_id = 0;
2536 pgno_t freecnt = 0, *free_pgs, *mop;
2537 ssize_t head_room = 0, total_room = 0, mop_len, clean_limit;
2539 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
2541 if (env->me_pghead) {
2542 /* Make sure first page of freeDB is touched and on freelist */
2543 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST|MDB_PS_MODIFY);
2544 if (rc && rc != MDB_NOTFOUND)
2548 /* MDB_RESERVE cancels meminit in ovpage malloc (when no WRITEMAP) */
2549 clean_limit = (env->me_flags & (MDB_NOMEMINIT|MDB_WRITEMAP))
2550 ? SSIZE_MAX : maxfree_1pg;
2553 /* Come back here after each Put() in case freelist changed */
2558 /* If using records from freeDB which we have not yet
2559 * deleted, delete them and any we reserved for me_pghead.
2561 while (pglast < env->me_pglast) {
2562 rc = mdb_cursor_first(&mc, &key, NULL);
2565 pglast = head_id = *(txnid_t *)key.mv_data;
2566 total_room = head_room = 0;
2567 assert(pglast <= env->me_pglast);
2568 rc = mdb_cursor_del(&mc, 0);
2573 /* Save the IDL of pages freed by this txn, to a single record */
2574 if (freecnt < txn->mt_free_pgs[0]) {
2576 /* Make sure last page of freeDB is touched and on freelist */
2577 rc = mdb_page_search(&mc, NULL, MDB_PS_LAST|MDB_PS_MODIFY);
2578 if (rc && rc != MDB_NOTFOUND)
2581 free_pgs = txn->mt_free_pgs;
2582 /* Write to last page of freeDB */
2583 key.mv_size = sizeof(txn->mt_txnid);
2584 key.mv_data = &txn->mt_txnid;
2586 freecnt = free_pgs[0];
2587 data.mv_size = MDB_IDL_SIZEOF(free_pgs);
2588 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2591 /* Retry if mt_free_pgs[] grew during the Put() */
2592 free_pgs = txn->mt_free_pgs;
2593 } while (freecnt < free_pgs[0]);
2594 mdb_midl_sort(free_pgs);
2595 memcpy(data.mv_data, free_pgs, data.mv_size);
2598 unsigned int i = free_pgs[0];
2599 DPRINTF(("IDL write txn %"Z"u root %"Z"u num %u",
2600 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, i));
2602 DPRINTF(("IDL %"Z"u", free_pgs[i]));
2608 mop = env->me_pghead;
2609 mop_len = mop ? mop[0] : 0;
2611 /* Reserve records for me_pghead[]. Split it if multi-page,
2612 * to avoid searching freeDB for a page range. Use keys in
2613 * range [1,me_pglast]: Smaller than txnid of oldest reader.
2615 if (total_room >= mop_len) {
2616 if (total_room == mop_len || --more < 0)
2618 } else if (head_room >= maxfree_1pg && head_id > 1) {
2619 /* Keep current record (overflow page), add a new one */
2623 /* (Re)write {key = head_id, IDL length = head_room} */
2624 total_room -= head_room;
2625 head_room = mop_len - total_room;
2626 if (head_room > maxfree_1pg && head_id > 1) {
2627 /* Overflow multi-page for part of me_pghead */
2628 head_room /= head_id; /* amortize page sizes */
2629 head_room += maxfree_1pg - head_room % (maxfree_1pg + 1);
2630 } else if (head_room < 0) {
2631 /* Rare case, not bothering to delete this record */
2634 key.mv_size = sizeof(head_id);
2635 key.mv_data = &head_id;
2636 data.mv_size = (head_room + 1) * sizeof(pgno_t);
2637 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2640 /* IDL is initially empty, zero out at least the length */
2641 pgs = (pgno_t *)data.mv_data;
2642 j = head_room > clean_limit ? head_room : 0;
2646 total_room += head_room;
2649 /* Fill in the reserved me_pghead records */
2655 rc = mdb_cursor_first(&mc, &key, &data);
2656 for (; !rc; rc = mdb_cursor_next(&mc, &key, &data, MDB_NEXT)) {
2657 unsigned flags = MDB_CURRENT;
2658 txnid_t id = *(txnid_t *)key.mv_data;
2659 ssize_t len = (ssize_t)(data.mv_size / sizeof(MDB_ID)) - 1;
2662 assert(len >= 0 && id <= env->me_pglast);
2664 if (len > mop_len) {
2666 data.mv_size = (len + 1) * sizeof(MDB_ID);
2669 data.mv_data = mop -= len;
2672 rc = mdb_cursor_put(&mc, &key, &data, flags);
2674 if (rc || !(mop_len -= len))
2681 /** Flush (some) dirty pages to the map, after clearing their dirty flag.
2682 * @param[in] txn the transaction that's being committed
2683 * @param[in] keep number of initial pages in dirty_list to keep dirty.
2684 * @return 0 on success, non-zero on failure.
2687 mdb_page_flush(MDB_txn *txn, int keep)
2689 MDB_env *env = txn->mt_env;
2690 MDB_ID2L dl = txn->mt_u.dirty_list;
2691 unsigned psize = env->me_psize, j;
2692 int i, pagecount = dl[0].mid, rc;
2693 size_t size = 0, pos = 0;
2695 MDB_page *dp = NULL;
2699 struct iovec iov[MDB_COMMIT_PAGES];
2700 ssize_t wpos = 0, wsize = 0, wres;
2701 size_t next_pos = 1; /* impossible pos, so pos != next_pos */
2707 if (env->me_flags & MDB_WRITEMAP) {
2708 /* Clear dirty flags */
2709 while (++i <= pagecount) {
2711 /* Don't flush this page yet */
2712 if (dp->mp_flags & P_KEEP) {
2713 dp->mp_flags ^= P_KEEP;
2717 dp->mp_flags &= ~P_DIRTY;
2722 /* Write the pages */
2724 if (++i <= pagecount) {
2726 /* Don't flush this page yet */
2727 if (dp->mp_flags & P_KEEP) {
2728 dp->mp_flags ^= P_KEEP;
2733 /* clear dirty flag */
2734 dp->mp_flags &= ~P_DIRTY;
2737 if (IS_OVERFLOW(dp)) size *= dp->mp_pages;
2742 /* Windows actually supports scatter/gather I/O, but only on
2743 * unbuffered file handles. Since we're relying on the OS page
2744 * cache for all our data, that's self-defeating. So we just
2745 * write pages one at a time. We use the ov structure to set
2746 * the write offset, to at least save the overhead of a Seek
2749 DPRINTF(("committing page %"Z"u", pgno));
2750 memset(&ov, 0, sizeof(ov));
2751 ov.Offset = pos & 0xffffffff;
2752 ov.OffsetHigh = pos >> 16 >> 16;
2753 if (!WriteFile(env->me_fd, dp, size, NULL, &ov)) {
2755 DPRINTF(("WriteFile: %d", rc));
2759 /* Write up to MDB_COMMIT_PAGES dirty pages at a time. */
2760 if (pos!=next_pos || n==MDB_COMMIT_PAGES || wsize+size>MAX_WRITE) {
2762 /* Write previous page(s) */
2763 #ifdef MDB_USE_PWRITEV
2764 wres = pwritev(env->me_fd, iov, n, wpos);
2767 wres = pwrite(env->me_fd, iov[0].iov_base, wsize, wpos);
2769 if (lseek(env->me_fd, wpos, SEEK_SET) == -1) {
2771 DPRINTF(("lseek: %s", strerror(rc)));
2774 wres = writev(env->me_fd, iov, n);
2777 if (wres != wsize) {
2780 DPRINTF(("Write error: %s", strerror(rc)));
2782 rc = EIO; /* TODO: Use which error code? */
2783 DPUTS("short write, filesystem full?");
2794 DPRINTF(("committing page %"Z"u", pgno));
2795 next_pos = pos + size;
2796 iov[n].iov_len = size;
2797 iov[n].iov_base = (char *)dp;
2803 for (i = keep; ++i <= pagecount; ) {
2805 /* This is a page we skipped above */
2808 dl[j].mid = dp->mp_pgno;
2811 mdb_dpage_free(env, dp);
2816 txn->mt_dirty_room += i - j;
2822 mdb_txn_commit(MDB_txn *txn)
2828 assert(txn != NULL);
2829 assert(txn->mt_env != NULL);
2831 if (txn->mt_child) {
2832 rc = mdb_txn_commit(txn->mt_child);
2833 txn->mt_child = NULL;
2840 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2841 mdb_dbis_update(txn, 1);
2842 txn->mt_numdbs = 2; /* so txn_abort() doesn't close any new handles */
2847 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
2848 DPUTS("error flag is set, can't commit");
2850 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
2855 if (txn->mt_parent) {
2856 MDB_txn *parent = txn->mt_parent;
2859 unsigned x, y, len, ps_len;
2861 /* Append our free list to parent's */
2862 rc = mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs);
2865 mdb_midl_free(txn->mt_free_pgs);
2866 /* Failures after this must either undo the changes
2867 * to the parent or set MDB_TXN_ERROR in the parent.
2870 parent->mt_next_pgno = txn->mt_next_pgno;
2871 parent->mt_flags = txn->mt_flags;
2873 /* Merge our cursors into parent's and close them */
2874 mdb_cursors_close(txn, 1);
2876 /* Update parent's DB table. */
2877 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2878 parent->mt_numdbs = txn->mt_numdbs;
2879 parent->mt_dbflags[0] = txn->mt_dbflags[0];
2880 parent->mt_dbflags[1] = txn->mt_dbflags[1];
2881 for (i=2; i<txn->mt_numdbs; i++) {
2882 /* preserve parent's DB_NEW status */
2883 x = parent->mt_dbflags[i] & DB_NEW;
2884 parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
2887 dst = parent->mt_u.dirty_list;
2888 src = txn->mt_u.dirty_list;
2889 /* Remove anything in our dirty list from parent's spill list */
2890 if ((pspill = parent->mt_spill_pgs) && (ps_len = pspill[0])) {
2892 pspill[0] = (pgno_t)-1;
2893 /* Mark our dirty pages as deleted in parent spill list */
2894 for (i=0, len=src[0].mid; ++i <= len; ) {
2895 MDB_ID pn = src[i].mid << 1;
2896 while (pn > pspill[x])
2898 if (pn == pspill[x]) {
2903 /* Squash deleted pagenums if we deleted any */
2904 for (x=y; ++x <= ps_len; )
2905 if (!(pspill[x] & 1))
2906 pspill[++y] = pspill[x];
2910 /* Find len = length of merging our dirty list with parent's */
2912 dst[0].mid = 0; /* simplify loops */
2913 if (parent->mt_parent) {
2914 len = x + src[0].mid;
2915 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
2916 for (i = x; y && i; y--) {
2917 pgno_t yp = src[y].mid;
2918 while (yp < dst[i].mid)
2920 if (yp == dst[i].mid) {
2925 } else { /* Simplify the above for single-ancestor case */
2926 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
2928 /* Merge our dirty list with parent's */
2930 for (i = len; y; dst[i--] = src[y--]) {
2931 pgno_t yp = src[y].mid;
2932 while (yp < dst[x].mid)
2933 dst[i--] = dst[x--];
2934 if (yp == dst[x].mid)
2935 free(dst[x--].mptr);
2939 free(txn->mt_u.dirty_list);
2940 parent->mt_dirty_room = txn->mt_dirty_room;
2941 if (txn->mt_spill_pgs) {
2942 if (parent->mt_spill_pgs) {
2943 /* TODO: Prevent failure here, so parent does not fail */
2944 rc = mdb_midl_append_list(&parent->mt_spill_pgs, txn->mt_spill_pgs);
2946 parent->mt_flags |= MDB_TXN_ERROR;
2947 mdb_midl_free(txn->mt_spill_pgs);
2948 mdb_midl_sort(parent->mt_spill_pgs);
2950 parent->mt_spill_pgs = txn->mt_spill_pgs;
2954 parent->mt_child = NULL;
2955 mdb_midl_free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pghead);
2960 if (txn != env->me_txn) {
2961 DPUTS("attempt to commit unknown transaction");
2966 mdb_cursors_close(txn, 0);
2968 if (!txn->mt_u.dirty_list[0].mid &&
2969 !(txn->mt_flags & (MDB_TXN_DIRTY|MDB_TXN_SPILLS)))
2972 DPRINTF(("committing txn %"Z"u %p on mdbenv %p, root page %"Z"u",
2973 txn->mt_txnid, (void*)txn, (void*)env, txn->mt_dbs[MAIN_DBI].md_root));
2975 /* Update DB root pointers */
2976 if (txn->mt_numdbs > 2) {
2980 data.mv_size = sizeof(MDB_db);
2982 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
2983 for (i = 2; i < txn->mt_numdbs; i++) {
2984 if (txn->mt_dbflags[i] & DB_DIRTY) {
2985 data.mv_data = &txn->mt_dbs[i];
2986 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
2993 rc = mdb_freelist_save(txn);
2997 mdb_midl_free(env->me_pghead);
2998 env->me_pghead = NULL;
2999 if (mdb_midl_shrink(&txn->mt_free_pgs))
3000 env->me_free_pgs = txn->mt_free_pgs;
3006 if ((rc = mdb_page_flush(txn, 0)) ||
3007 (rc = mdb_env_sync(env, 0)) ||
3008 (rc = mdb_env_write_meta(txn)))
3014 mdb_dbis_update(txn, 1);
3017 UNLOCK_MUTEX_W(env);
3027 /** Read the environment parameters of a DB environment before
3028 * mapping it into memory.
3029 * @param[in] env the environment handle
3030 * @param[out] meta address of where to store the meta information
3031 * @return 0 on success, non-zero on failure.
3034 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
3040 enum { Size = sizeof(pbuf) };
3042 /* We don't know the page size yet, so use a minimum value.
3043 * Read both meta pages so we can use the latest one.
3046 for (i=off=0; i<2; i++, off = meta->mm_psize) {
3050 memset(&ov, 0, sizeof(ov));
3052 rc = ReadFile(env->me_fd, &pbuf, Size, &len, &ov) ? (int)len : -1;
3053 if (rc == -1 && ErrCode() == ERROR_HANDLE_EOF)
3056 rc = pread(env->me_fd, &pbuf, Size, off);
3059 if (rc == 0 && off == 0)
3061 rc = rc < 0 ? (int) ErrCode() : MDB_INVALID;
3062 DPRINTF(("read: %s", mdb_strerror(rc)));
3066 p = (MDB_page *)&pbuf;
3068 if (!F_ISSET(p->mp_flags, P_META)) {
3069 DPRINTF(("page %"Z"u not a meta page", p->mp_pgno));
3074 if (m->mm_magic != MDB_MAGIC) {
3075 DPUTS("meta has invalid magic");
3079 if (m->mm_version != MDB_DATA_VERSION) {
3080 DPRINTF(("database is version %u, expected version %u",
3081 m->mm_version, MDB_DATA_VERSION));
3082 return MDB_VERSION_MISMATCH;
3085 if (off == 0 || m->mm_txnid > meta->mm_txnid)
3091 /** Write the environment parameters of a freshly created DB environment.
3092 * @param[in] env the environment handle
3093 * @param[out] meta address of where to store the meta information
3094 * @return 0 on success, non-zero on failure.
3097 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
3105 memset(&ov, 0, sizeof(ov));
3106 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3108 rc = WriteFile(fd, ptr, size, &len, &ov); } while(0)
3111 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3112 len = pwrite(fd, ptr, size, pos); \
3113 rc = (len >= 0); } while(0)
3116 DPUTS("writing new meta page");
3118 psize = env->me_psize;
3120 meta->mm_magic = MDB_MAGIC;
3121 meta->mm_version = MDB_DATA_VERSION;
3122 meta->mm_mapsize = env->me_mapsize;
3123 meta->mm_psize = psize;
3124 meta->mm_last_pg = 1;
3125 meta->mm_flags = env->me_flags & 0xffff;
3126 meta->mm_flags |= MDB_INTEGERKEY;
3127 meta->mm_dbs[0].md_root = P_INVALID;
3128 meta->mm_dbs[1].md_root = P_INVALID;
3130 p = calloc(2, psize);
3132 p->mp_flags = P_META;
3133 *(MDB_meta *)METADATA(p) = *meta;
3135 q = (MDB_page *)((char *)p + psize);
3137 q->mp_flags = P_META;
3138 *(MDB_meta *)METADATA(q) = *meta;
3140 DO_PWRITE(rc, env->me_fd, p, psize * 2, len, 0);
3143 else if ((unsigned) len == psize * 2)
3151 /** Update the environment info to commit a transaction.
3152 * @param[in] txn the transaction that's being committed
3153 * @return 0 on success, non-zero on failure.
3156 mdb_env_write_meta(MDB_txn *txn)
3159 MDB_meta meta, metab, *mp;
3161 int rc, len, toggle;
3170 assert(txn != NULL);
3171 assert(txn->mt_env != NULL);
3173 toggle = txn->mt_txnid & 1;
3174 DPRINTF(("writing meta page %d for root page %"Z"u",
3175 toggle, txn->mt_dbs[MAIN_DBI].md_root));
3178 mp = env->me_metas[toggle];
3180 if (env->me_flags & MDB_WRITEMAP) {
3181 /* Persist any increases of mapsize config */
3182 if (env->me_mapsize > mp->mm_mapsize)
3183 mp->mm_mapsize = env->me_mapsize;
3184 mp->mm_dbs[0] = txn->mt_dbs[0];
3185 mp->mm_dbs[1] = txn->mt_dbs[1];
3186 mp->mm_last_pg = txn->mt_next_pgno - 1;
3187 mp->mm_txnid = txn->mt_txnid;
3188 if (!(env->me_flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
3189 unsigned meta_size = env->me_psize;
3190 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
3193 #ifndef _WIN32 /* POSIX msync() requires ptr = start of OS page */
3194 if (meta_size < env->me_os_psize)
3195 meta_size += meta_size;
3200 if (MDB_MSYNC(ptr, meta_size, rc)) {
3207 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
3208 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
3210 ptr = (char *)&meta;
3211 if (env->me_mapsize > mp->mm_mapsize) {
3212 /* Persist any increases of mapsize config */
3213 meta.mm_mapsize = env->me_mapsize;
3214 off = offsetof(MDB_meta, mm_mapsize);
3216 off = offsetof(MDB_meta, mm_dbs[0].md_depth);
3218 len = sizeof(MDB_meta) - off;
3221 meta.mm_dbs[0] = txn->mt_dbs[0];
3222 meta.mm_dbs[1] = txn->mt_dbs[1];
3223 meta.mm_last_pg = txn->mt_next_pgno - 1;
3224 meta.mm_txnid = txn->mt_txnid;
3227 off += env->me_psize;
3230 /* Write to the SYNC fd */
3231 mfd = env->me_flags & (MDB_NOSYNC|MDB_NOMETASYNC) ?
3232 env->me_fd : env->me_mfd;
3235 memset(&ov, 0, sizeof(ov));
3237 if (!WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov))
3241 rc = pwrite(mfd, ptr, len, off);
3244 rc = rc < 0 ? ErrCode() : EIO;
3245 DPUTS("write failed, disk error?");
3246 /* On a failure, the pagecache still contains the new data.
3247 * Write some old data back, to prevent it from being used.
3248 * Use the non-SYNC fd; we know it will fail anyway.
3250 meta.mm_last_pg = metab.mm_last_pg;
3251 meta.mm_txnid = metab.mm_txnid;
3253 memset(&ov, 0, sizeof(ov));
3255 WriteFile(env->me_fd, ptr, len, NULL, &ov);
3257 r2 = pwrite(env->me_fd, ptr, len, off);
3258 (void)r2; /* Silence warnings. We don't care about pwrite's return value */
3261 env->me_flags |= MDB_FATAL_ERROR;
3265 /* Memory ordering issues are irrelevant; since the entire writer
3266 * is wrapped by wmutex, all of these changes will become visible
3267 * after the wmutex is unlocked. Since the DB is multi-version,
3268 * readers will get consistent data regardless of how fresh or
3269 * how stale their view of these values is.
3272 env->me_txns->mti_txnid = txn->mt_txnid;
3277 /** Check both meta pages to see which one is newer.
3278 * @param[in] env the environment handle
3279 * @return meta toggle (0 or 1).
3282 mdb_env_pick_meta(const MDB_env *env)
3284 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
3288 mdb_env_create(MDB_env **env)
3292 e = calloc(1, sizeof(MDB_env));
3296 e->me_maxreaders = DEFAULT_READERS;
3297 e->me_maxdbs = e->me_numdbs = 2;
3298 e->me_fd = INVALID_HANDLE_VALUE;
3299 e->me_lfd = INVALID_HANDLE_VALUE;
3300 e->me_mfd = INVALID_HANDLE_VALUE;
3301 #ifdef MDB_USE_POSIX_SEM
3302 e->me_rmutex = SEM_FAILED;
3303 e->me_wmutex = SEM_FAILED;
3305 e->me_pid = getpid();
3306 GET_PAGESIZE(e->me_os_psize);
3307 VGMEMP_CREATE(e,0,0);
3313 mdb_env_map(MDB_env *env, void *addr, int newsize)
3316 unsigned int flags = env->me_flags;
3320 LONG sizelo, sizehi;
3321 sizelo = env->me_mapsize & 0xffffffff;
3322 sizehi = env->me_mapsize >> 16 >> 16; /* only needed on Win64 */
3324 /* Windows won't create mappings for zero length files.
3325 * Just allocate the maxsize right now.
3328 if (SetFilePointer(env->me_fd, sizelo, &sizehi, 0) != (DWORD)sizelo
3329 || !SetEndOfFile(env->me_fd)
3330 || SetFilePointer(env->me_fd, 0, NULL, 0) != 0)
3333 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
3334 PAGE_READWRITE : PAGE_READONLY,
3335 sizehi, sizelo, NULL);
3338 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
3339 FILE_MAP_WRITE : FILE_MAP_READ,
3340 0, 0, env->me_mapsize, addr);
3341 rc = env->me_map ? 0 : ErrCode();
3346 int prot = PROT_READ;
3347 if (flags & MDB_WRITEMAP) {
3349 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
3352 env->me_map = mmap(addr, env->me_mapsize, prot, MAP_SHARED,
3354 if (env->me_map == MAP_FAILED) {
3359 if (flags & MDB_NORDAHEAD) {
3360 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
3362 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
3364 #ifdef POSIX_MADV_RANDOM
3365 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
3366 #endif /* POSIX_MADV_RANDOM */
3367 #endif /* MADV_RANDOM */
3371 /* Can happen because the address argument to mmap() is just a
3372 * hint. mmap() can pick another, e.g. if the range is in use.
3373 * The MAP_FIXED flag would prevent that, but then mmap could
3374 * instead unmap existing pages to make room for the new map.
3376 if (addr && env->me_map != addr)
3377 return EBUSY; /* TODO: Make a new MDB_* error code? */
3379 p = (MDB_page *)env->me_map;
3380 env->me_metas[0] = METADATA(p);
3381 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + env->me_psize);
3387 mdb_env_set_mapsize(MDB_env *env, size_t size)
3389 /* If env is already open, caller is responsible for making
3390 * sure there are no active txns.
3398 size = env->me_metas[mdb_env_pick_meta(env)]->mm_mapsize;
3399 else if (size < env->me_mapsize) {
3400 /* If the configured size is smaller, make sure it's
3401 * still big enough. Silently round up to minimum if not.
3403 size_t minsize = (env->me_metas[mdb_env_pick_meta(env)]->mm_last_pg + 1) * env->me_psize;
3407 munmap(env->me_map, env->me_mapsize);
3408 env->me_mapsize = size;
3409 old = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : NULL;
3410 rc = mdb_env_map(env, old, 1);
3414 env->me_mapsize = size;
3416 env->me_maxpg = env->me_mapsize / env->me_psize;
3421 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
3425 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
3430 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
3432 if (env->me_map || readers < 1)
3434 env->me_maxreaders = readers;
3439 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
3441 if (!env || !readers)
3443 *readers = env->me_maxreaders;
3447 /** Further setup required for opening an MDB environment
3450 mdb_env_open2(MDB_env *env)
3452 unsigned int flags = env->me_flags;
3453 int i, newenv = 0, rc;
3457 /* See if we should use QueryLimited */
3459 if ((rc & 0xff) > 5)
3460 env->me_pidquery = MDB_PROCESS_QUERY_LIMITED_INFORMATION;
3462 env->me_pidquery = PROCESS_QUERY_INFORMATION;
3465 memset(&meta, 0, sizeof(meta));
3467 if ((i = mdb_env_read_header(env, &meta)) != 0) {
3470 DPUTS("new mdbenv");
3472 env->me_psize = env->me_os_psize;
3473 if (env->me_psize > MAX_PAGESIZE)
3474 env->me_psize = MAX_PAGESIZE;
3476 env->me_psize = meta.mm_psize;
3479 /* Was a mapsize configured? */
3480 if (!env->me_mapsize) {
3481 /* If this is a new environment, take the default,
3482 * else use the size recorded in the existing env.
3484 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
3485 } else if (env->me_mapsize < meta.mm_mapsize) {
3486 /* If the configured size is smaller, make sure it's
3487 * still big enough. Silently round up to minimum if not.
3489 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
3490 if (env->me_mapsize < minsize)
3491 env->me_mapsize = minsize;
3494 rc = mdb_env_map(env, meta.mm_address, newenv);
3499 if (flags & MDB_FIXEDMAP)
3500 meta.mm_address = env->me_map;
3501 i = mdb_env_init_meta(env, &meta);
3502 if (i != MDB_SUCCESS) {
3507 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
3508 env->me_nodemax = (((env->me_psize - PAGEHDRSZ) / MDB_MINKEYS) & -2)
3510 #if !(MDB_MAXKEYSIZE)
3511 env->me_maxkey = env->me_nodemax - (NODESIZE + sizeof(MDB_db));
3513 env->me_maxpg = env->me_mapsize / env->me_psize;
3517 int toggle = mdb_env_pick_meta(env);
3518 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
3520 DPRINTF(("opened database version %u, pagesize %u",
3521 env->me_metas[0]->mm_version, env->me_psize));
3522 DPRINTF(("using meta page %d", toggle));
3523 DPRINTF(("depth: %u", db->md_depth));
3524 DPRINTF(("entries: %"Z"u", db->md_entries));
3525 DPRINTF(("branch pages: %"Z"u", db->md_branch_pages));
3526 DPRINTF(("leaf pages: %"Z"u", db->md_leaf_pages));
3527 DPRINTF(("overflow pages: %"Z"u", db->md_overflow_pages));
3528 DPRINTF(("root: %"Z"u", db->md_root));
3536 /** Release a reader thread's slot in the reader lock table.
3537 * This function is called automatically when a thread exits.
3538 * @param[in] ptr This points to the slot in the reader lock table.
3541 mdb_env_reader_dest(void *ptr)
3543 MDB_reader *reader = ptr;
3549 /** Junk for arranging thread-specific callbacks on Windows. This is
3550 * necessarily platform and compiler-specific. Windows supports up
3551 * to 1088 keys. Let's assume nobody opens more than 64 environments
3552 * in a single process, for now. They can override this if needed.
3554 #ifndef MAX_TLS_KEYS
3555 #define MAX_TLS_KEYS 64
3557 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
3558 static int mdb_tls_nkeys;
3560 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
3564 case DLL_PROCESS_ATTACH: break;
3565 case DLL_THREAD_ATTACH: break;
3566 case DLL_THREAD_DETACH:
3567 for (i=0; i<mdb_tls_nkeys; i++) {
3568 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
3569 mdb_env_reader_dest(r);
3572 case DLL_PROCESS_DETACH: break;
3577 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3579 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3583 /* Force some symbol references.
3584 * _tls_used forces the linker to create the TLS directory if not already done
3585 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
3587 #pragma comment(linker, "/INCLUDE:_tls_used")
3588 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
3589 #pragma const_seg(".CRT$XLB")
3590 extern const PIMAGE_TLS_CALLBACK mdb_tls_cbp;
3591 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3594 #pragma comment(linker, "/INCLUDE:__tls_used")
3595 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
3596 #pragma data_seg(".CRT$XLB")
3597 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3599 #endif /* WIN 32/64 */
3600 #endif /* !__GNUC__ */
3603 /** Downgrade the exclusive lock on the region back to shared */
3605 mdb_env_share_locks(MDB_env *env, int *excl)
3607 int rc = 0, toggle = mdb_env_pick_meta(env);
3609 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
3614 /* First acquire a shared lock. The Unlock will
3615 * then release the existing exclusive lock.
3617 memset(&ov, 0, sizeof(ov));
3618 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3621 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3627 struct flock lock_info;
3628 /* The shared lock replaces the existing lock */
3629 memset((void *)&lock_info, 0, sizeof(lock_info));
3630 lock_info.l_type = F_RDLCK;
3631 lock_info.l_whence = SEEK_SET;
3632 lock_info.l_start = 0;
3633 lock_info.l_len = 1;
3634 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3635 (rc = ErrCode()) == EINTR) ;
3636 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
3643 /** Try to get exlusive lock, otherwise shared.
3644 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
3647 mdb_env_excl_lock(MDB_env *env, int *excl)
3651 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
3655 memset(&ov, 0, sizeof(ov));
3656 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3663 struct flock lock_info;
3664 memset((void *)&lock_info, 0, sizeof(lock_info));
3665 lock_info.l_type = F_WRLCK;
3666 lock_info.l_whence = SEEK_SET;
3667 lock_info.l_start = 0;
3668 lock_info.l_len = 1;
3669 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3670 (rc = ErrCode()) == EINTR) ;
3674 # ifdef MDB_USE_POSIX_SEM
3675 if (*excl < 0) /* always true when !MDB_USE_POSIX_SEM */
3678 lock_info.l_type = F_RDLCK;
3679 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
3680 (rc = ErrCode()) == EINTR) ;
3690 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
3692 * @(#) $Revision: 5.1 $
3693 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
3694 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
3696 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
3700 * Please do not copyright this code. This code is in the public domain.
3702 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
3703 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
3704 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
3705 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
3706 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
3707 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
3708 * PERFORMANCE OF THIS SOFTWARE.
3711 * chongo <Landon Curt Noll> /\oo/\
3712 * http://www.isthe.com/chongo/
3714 * Share and Enjoy! :-)
3717 typedef unsigned long long mdb_hash_t;
3718 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
3720 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
3721 * @param[in] val value to hash
3722 * @param[in] hval initial value for hash
3723 * @return 64 bit hash
3725 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
3726 * hval arg on the first call.
3729 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
3731 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
3732 unsigned char *end = s + val->mv_size;
3734 * FNV-1a hash each octet of the string
3737 /* xor the bottom with the current octet */
3738 hval ^= (mdb_hash_t)*s++;
3740 /* multiply by the 64 bit FNV magic prime mod 2^64 */
3741 hval += (hval << 1) + (hval << 4) + (hval << 5) +
3742 (hval << 7) + (hval << 8) + (hval << 40);
3744 /* return our new hash value */
3748 /** Hash the string and output the encoded hash.
3749 * This uses modified RFC1924 Ascii85 encoding to accommodate systems with
3750 * very short name limits. We don't care about the encoding being reversible,
3751 * we just want to preserve as many bits of the input as possible in a
3752 * small printable string.
3753 * @param[in] str string to hash
3754 * @param[out] encbuf an array of 11 chars to hold the hash
3756 static const char mdb_a85[]= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!#$%&()*+-;<=>?@^_`{|}~";
3759 mdb_pack85(unsigned long l, char *out)
3763 for (i=0; i<5; i++) {
3764 *out++ = mdb_a85[l % 85];
3770 mdb_hash_enc(MDB_val *val, char *encbuf)
3772 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
3774 mdb_pack85(h, encbuf);
3775 mdb_pack85(h>>32, encbuf+5);
3780 /** Open and/or initialize the lock region for the environment.
3781 * @param[in] env The MDB environment.
3782 * @param[in] lpath The pathname of the file used for the lock region.
3783 * @param[in] mode The Unix permissions for the file, if we create it.
3784 * @param[out] excl Resulting file lock type: -1 none, 0 shared, 1 exclusive
3785 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
3786 * @return 0 on success, non-zero on failure.
3789 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
3792 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
3794 # define MDB_ERRCODE_ROFS EROFS
3795 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
3796 # define MDB_CLOEXEC O_CLOEXEC
3799 # define MDB_CLOEXEC 0
3806 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
3807 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
3808 FILE_ATTRIBUTE_NORMAL, NULL);
3810 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
3812 if (env->me_lfd == INVALID_HANDLE_VALUE) {
3814 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
3819 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
3820 /* Lose record locks when exec*() */
3821 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
3822 fcntl(env->me_lfd, F_SETFD, fdflags);
3825 if (!(env->me_flags & MDB_NOTLS)) {
3826 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
3829 env->me_flags |= MDB_ENV_TXKEY;
3831 /* Windows TLS callbacks need help finding their TLS info. */
3832 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
3836 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
3840 /* Try to get exclusive lock. If we succeed, then
3841 * nobody is using the lock region and we should initialize it.
3843 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
3846 size = GetFileSize(env->me_lfd, NULL);
3848 size = lseek(env->me_lfd, 0, SEEK_END);
3849 if (size == -1) goto fail_errno;
3851 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
3852 if (size < rsize && *excl > 0) {
3854 if (SetFilePointer(env->me_lfd, rsize, NULL, FILE_BEGIN) != (DWORD)rsize
3855 || !SetEndOfFile(env->me_lfd))
3858 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
3862 size = rsize - sizeof(MDB_txninfo);
3863 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
3868 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
3870 if (!mh) goto fail_errno;
3871 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
3873 if (!env->me_txns) goto fail_errno;
3875 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
3877 if (m == MAP_FAILED) goto fail_errno;
3883 BY_HANDLE_FILE_INFORMATION stbuf;
3892 if (!mdb_sec_inited) {
3893 InitializeSecurityDescriptor(&mdb_null_sd,
3894 SECURITY_DESCRIPTOR_REVISION);
3895 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
3896 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
3897 mdb_all_sa.bInheritHandle = FALSE;
3898 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
3901 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
3902 idbuf.volume = stbuf.dwVolumeSerialNumber;
3903 idbuf.nhigh = stbuf.nFileIndexHigh;
3904 idbuf.nlow = stbuf.nFileIndexLow;
3905 val.mv_data = &idbuf;
3906 val.mv_size = sizeof(idbuf);
3907 mdb_hash_enc(&val, encbuf);
3908 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", encbuf);
3909 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", encbuf);
3910 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
3911 if (!env->me_rmutex) goto fail_errno;
3912 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
3913 if (!env->me_wmutex) goto fail_errno;
3914 #elif defined(MDB_USE_POSIX_SEM)
3923 #if defined(__NetBSD__)
3924 #define MDB_SHORT_SEMNAMES 1 /* limited to 14 chars */
3926 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
3927 idbuf.dev = stbuf.st_dev;
3928 idbuf.ino = stbuf.st_ino;
3929 val.mv_data = &idbuf;
3930 val.mv_size = sizeof(idbuf);
3931 mdb_hash_enc(&val, encbuf);
3932 #ifdef MDB_SHORT_SEMNAMES
3933 encbuf[9] = '\0'; /* drop name from 15 chars to 14 chars */
3935 sprintf(env->me_txns->mti_rmname, "/MDBr%s", encbuf);
3936 sprintf(env->me_txns->mti_wmname, "/MDBw%s", encbuf);
3937 /* Clean up after a previous run, if needed: Try to
3938 * remove both semaphores before doing anything else.
3940 sem_unlink(env->me_txns->mti_rmname);
3941 sem_unlink(env->me_txns->mti_wmname);
3942 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
3943 O_CREAT|O_EXCL, mode, 1);
3944 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3945 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
3946 O_CREAT|O_EXCL, mode, 1);
3947 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3948 #else /* MDB_USE_POSIX_SEM */
3949 pthread_mutexattr_t mattr;
3951 if ((rc = pthread_mutexattr_init(&mattr))
3952 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
3953 || (rc = pthread_mutex_init(&env->me_txns->mti_mutex, &mattr))
3954 || (rc = pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr)))
3956 pthread_mutexattr_destroy(&mattr);
3957 #endif /* _WIN32 || MDB_USE_POSIX_SEM */
3959 env->me_txns->mti_magic = MDB_MAGIC;
3960 env->me_txns->mti_format = MDB_LOCK_FORMAT;
3961 env->me_txns->mti_txnid = 0;
3962 env->me_txns->mti_numreaders = 0;
3965 if (env->me_txns->mti_magic != MDB_MAGIC) {
3966 DPUTS("lock region has invalid magic");
3970 if (env->me_txns->mti_format != MDB_LOCK_FORMAT) {
3971 DPRINTF(("lock region has format+version 0x%x, expected 0x%x",
3972 env->me_txns->mti_format, MDB_LOCK_FORMAT));
3973 rc = MDB_VERSION_MISMATCH;
3977 if (rc && rc != EACCES && rc != EAGAIN) {
3981 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
3982 if (!env->me_rmutex) goto fail_errno;
3983 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
3984 if (!env->me_wmutex) goto fail_errno;
3985 #elif defined(MDB_USE_POSIX_SEM)
3986 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
3987 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3988 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
3989 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4000 /** The name of the lock file in the DB environment */
4001 #define LOCKNAME "/lock.mdb"
4002 /** The name of the data file in the DB environment */
4003 #define DATANAME "/data.mdb"
4004 /** The suffix of the lock file when no subdir is used */
4005 #define LOCKSUFF "-lock"
4006 /** Only a subset of the @ref mdb_env flags can be changed
4007 * at runtime. Changing other flags requires closing the
4008 * environment and re-opening it with the new flags.
4010 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC|MDB_NOMEMINIT)
4011 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY|MDB_WRITEMAP| \
4012 MDB_NOTLS|MDB_NOLOCK|MDB_NORDAHEAD)
4015 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
4017 int oflags, rc, len, excl = -1;
4018 char *lpath, *dpath;
4020 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
4024 if (flags & MDB_NOSUBDIR) {
4025 rc = len + sizeof(LOCKSUFF) + len + 1;
4027 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
4032 if (flags & MDB_NOSUBDIR) {
4033 dpath = lpath + len + sizeof(LOCKSUFF);
4034 sprintf(lpath, "%s" LOCKSUFF, path);
4035 strcpy(dpath, path);
4037 dpath = lpath + len + sizeof(LOCKNAME);
4038 sprintf(lpath, "%s" LOCKNAME, path);
4039 sprintf(dpath, "%s" DATANAME, path);
4043 flags |= env->me_flags;
4044 if (flags & MDB_RDONLY) {
4045 /* silently ignore WRITEMAP when we're only getting read access */
4046 flags &= ~MDB_WRITEMAP;
4048 if (!((env->me_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)) &&
4049 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
4052 env->me_flags = flags |= MDB_ENV_ACTIVE;
4056 env->me_path = strdup(path);
4057 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
4058 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
4059 if (!(env->me_dbxs && env->me_path && env->me_dbflags)) {
4064 /* For RDONLY, get lockfile after we know datafile exists */
4065 if (!(flags & (MDB_RDONLY|MDB_NOLOCK))) {
4066 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4072 if (F_ISSET(flags, MDB_RDONLY)) {
4073 oflags = GENERIC_READ;
4074 len = OPEN_EXISTING;
4076 oflags = GENERIC_READ|GENERIC_WRITE;
4079 mode = FILE_ATTRIBUTE_NORMAL;
4080 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
4081 NULL, len, mode, NULL);
4083 if (F_ISSET(flags, MDB_RDONLY))
4086 oflags = O_RDWR | O_CREAT;
4088 env->me_fd = open(dpath, oflags, mode);
4090 if (env->me_fd == INVALID_HANDLE_VALUE) {
4095 if ((flags & (MDB_RDONLY|MDB_NOLOCK)) == MDB_RDONLY) {
4096 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4101 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
4102 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
4103 env->me_mfd = env->me_fd;
4105 /* Synchronous fd for meta writes. Needed even with
4106 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
4109 len = OPEN_EXISTING;
4110 env->me_mfd = CreateFile(dpath, oflags,
4111 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
4112 mode | FILE_FLAG_WRITE_THROUGH, NULL);
4115 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
4117 if (env->me_mfd == INVALID_HANDLE_VALUE) {
4122 DPRINTF(("opened dbenv %p", (void *) env));
4124 rc = mdb_env_share_locks(env, &excl);
4128 if (!((flags & MDB_RDONLY) ||
4129 (env->me_pbuf = calloc(1, env->me_psize))))
4135 mdb_env_close0(env, excl);
4141 /** Destroy resources from mdb_env_open(), clear our readers & DBIs */
4143 mdb_env_close0(MDB_env *env, int excl)
4147 if (!(env->me_flags & MDB_ENV_ACTIVE))
4150 /* Doing this here since me_dbxs may not exist during mdb_env_close */
4151 for (i = env->me_maxdbs; --i > MAIN_DBI; )
4152 free(env->me_dbxs[i].md_name.mv_data);
4155 free(env->me_dbflags);
4158 free(env->me_dirty_list);
4159 mdb_midl_free(env->me_free_pgs);
4161 if (env->me_flags & MDB_ENV_TXKEY) {
4162 pthread_key_delete(env->me_txkey);
4164 /* Delete our key from the global list */
4165 for (i=0; i<mdb_tls_nkeys; i++)
4166 if (mdb_tls_keys[i] == env->me_txkey) {
4167 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
4175 munmap(env->me_map, env->me_mapsize);
4177 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
4178 (void) close(env->me_mfd);
4179 if (env->me_fd != INVALID_HANDLE_VALUE)
4180 (void) close(env->me_fd);
4182 MDB_PID_T pid = env->me_pid;
4183 /* Clearing readers is done in this function because
4184 * me_txkey with its destructor must be disabled first.
4186 for (i = env->me_numreaders; --i >= 0; )
4187 if (env->me_txns->mti_readers[i].mr_pid == pid)
4188 env->me_txns->mti_readers[i].mr_pid = 0;
4190 if (env->me_rmutex) {
4191 CloseHandle(env->me_rmutex);
4192 if (env->me_wmutex) CloseHandle(env->me_wmutex);
4194 /* Windows automatically destroys the mutexes when
4195 * the last handle closes.
4197 #elif defined(MDB_USE_POSIX_SEM)
4198 if (env->me_rmutex != SEM_FAILED) {
4199 sem_close(env->me_rmutex);
4200 if (env->me_wmutex != SEM_FAILED)
4201 sem_close(env->me_wmutex);
4202 /* If we have the filelock: If we are the
4203 * only remaining user, clean up semaphores.
4206 mdb_env_excl_lock(env, &excl);
4208 sem_unlink(env->me_txns->mti_rmname);
4209 sem_unlink(env->me_txns->mti_wmname);
4213 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
4215 if (env->me_lfd != INVALID_HANDLE_VALUE) {
4218 /* Unlock the lockfile. Windows would have unlocked it
4219 * after closing anyway, but not necessarily at once.
4221 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4224 (void) close(env->me_lfd);
4227 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
4231 mdb_env_copyfd(MDB_env *env, HANDLE fd)
4233 MDB_txn *txn = NULL;
4239 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
4243 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
4246 /* Do the lock/unlock of the reader mutex before starting the
4247 * write txn. Otherwise other read txns could block writers.
4249 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
4254 /* We must start the actual read txn after blocking writers */
4255 mdb_txn_reset0(txn, "reset-stage1");
4257 /* Temporarily block writers until we snapshot the meta pages */
4260 rc = mdb_txn_renew0(txn);
4262 UNLOCK_MUTEX_W(env);
4267 wsize = env->me_psize * 2;
4271 DO_WRITE(rc, fd, ptr, w2, len);
4275 } else if (len > 0) {
4281 /* Non-blocking or async handles are not supported */
4287 UNLOCK_MUTEX_W(env);
4292 wsize = txn->mt_next_pgno * env->me_psize - wsize;
4294 if (wsize > MAX_WRITE)
4298 DO_WRITE(rc, fd, ptr, w2, len);
4302 } else if (len > 0) {
4319 mdb_env_copy(MDB_env *env, const char *path)
4323 HANDLE newfd = INVALID_HANDLE_VALUE;
4325 if (env->me_flags & MDB_NOSUBDIR) {
4326 lpath = (char *)path;
4329 len += sizeof(DATANAME);
4330 lpath = malloc(len);
4333 sprintf(lpath, "%s" DATANAME, path);
4336 /* The destination path must exist, but the destination file must not.
4337 * We don't want the OS to cache the writes, since the source data is
4338 * already in the OS cache.
4341 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
4342 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
4344 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL, 0666);
4346 if (newfd == INVALID_HANDLE_VALUE) {
4352 /* Set O_DIRECT if the file system supports it */
4353 if ((rc = fcntl(newfd, F_GETFL)) != -1)
4354 (void) fcntl(newfd, F_SETFL, rc | O_DIRECT);
4356 #ifdef F_NOCACHE /* __APPLE__ */
4357 rc = fcntl(newfd, F_NOCACHE, 1);
4364 rc = mdb_env_copyfd(env, newfd);
4367 if (!(env->me_flags & MDB_NOSUBDIR))
4369 if (newfd != INVALID_HANDLE_VALUE)
4370 if (close(newfd) < 0 && rc == MDB_SUCCESS)
4377 mdb_env_close(MDB_env *env)
4384 VGMEMP_DESTROY(env);
4385 while ((dp = env->me_dpages) != NULL) {
4386 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
4387 env->me_dpages = dp->mp_next;
4391 mdb_env_close0(env, 0);
4395 /** Compare two items pointing at aligned size_t's */
4397 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
4399 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
4400 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
4403 /** Compare two items pointing at aligned unsigned int's */
4405 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
4407 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
4408 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
4411 /** Compare two items pointing at unsigned ints of unknown alignment.
4412 * Nodes and keys are guaranteed to be 2-byte aligned.
4415 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
4417 #if BYTE_ORDER == LITTLE_ENDIAN
4418 unsigned short *u, *c;
4421 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
4422 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
4425 } while(!x && u > (unsigned short *)a->mv_data);
4428 return memcmp(a->mv_data, b->mv_data, a->mv_size);
4432 /** Compare two items lexically */
4434 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
4441 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
4447 diff = memcmp(a->mv_data, b->mv_data, len);
4448 return diff ? diff : len_diff<0 ? -1 : len_diff;
4451 /** Compare two items in reverse byte order */
4453 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
4455 const unsigned char *p1, *p2, *p1_lim;
4459 p1_lim = (const unsigned char *)a->mv_data;
4460 p1 = (const unsigned char *)a->mv_data + a->mv_size;
4461 p2 = (const unsigned char *)b->mv_data + b->mv_size;
4463 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
4469 while (p1 > p1_lim) {
4470 diff = *--p1 - *--p2;
4474 return len_diff<0 ? -1 : len_diff;
4477 /** Search for key within a page, using binary search.
4478 * Returns the smallest entry larger or equal to the key.
4479 * If exactp is non-null, stores whether the found entry was an exact match
4480 * in *exactp (1 or 0).
4481 * Updates the cursor index with the index of the found entry.
4482 * If no entry larger or equal to the key is found, returns NULL.
4485 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
4487 unsigned int i = 0, nkeys;
4490 MDB_page *mp = mc->mc_pg[mc->mc_top];
4491 MDB_node *node = NULL;
4496 nkeys = NUMKEYS(mp);
4501 COPY_PGNO(pgno, mp->mp_pgno);
4502 DPRINTF(("searching %u keys in %s %spage %"Z"u",
4503 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
4508 low = IS_LEAF(mp) ? 0 : 1;
4510 cmp = mc->mc_dbx->md_cmp;
4512 /* Branch pages have no data, so if using integer keys,
4513 * alignment is guaranteed. Use faster mdb_cmp_int.
4515 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
4516 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
4523 nodekey.mv_size = mc->mc_db->md_pad;
4524 node = NODEPTR(mp, 0); /* fake */
4525 while (low <= high) {
4526 i = (low + high) >> 1;
4527 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
4528 rc = cmp(key, &nodekey);
4529 DPRINTF(("found leaf index %u [%s], rc = %i",
4530 i, DKEY(&nodekey), rc));
4539 while (low <= high) {
4540 i = (low + high) >> 1;
4542 node = NODEPTR(mp, i);
4543 nodekey.mv_size = NODEKSZ(node);
4544 nodekey.mv_data = NODEKEY(node);
4546 rc = cmp(key, &nodekey);
4549 DPRINTF(("found leaf index %u [%s], rc = %i",
4550 i, DKEY(&nodekey), rc));
4552 DPRINTF(("found branch index %u [%s -> %"Z"u], rc = %i",
4553 i, DKEY(&nodekey), NODEPGNO(node), rc));
4564 if (rc > 0) { /* Found entry is less than the key. */
4565 i++; /* Skip to get the smallest entry larger than key. */
4567 node = NODEPTR(mp, i);
4570 *exactp = (rc == 0 && nkeys > 0);
4571 /* store the key index */
4572 mc->mc_ki[mc->mc_top] = i;
4574 /* There is no entry larger or equal to the key. */
4577 /* nodeptr is fake for LEAF2 */
4583 mdb_cursor_adjust(MDB_cursor *mc, func)
4587 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
4588 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
4595 /** Pop a page off the top of the cursor's stack. */
4597 mdb_cursor_pop(MDB_cursor *mc)
4601 MDB_page *top = mc->mc_pg[mc->mc_top];
4607 DPRINTF(("popped page %"Z"u off db %d cursor %p", top->mp_pgno,
4608 DDBI(mc), (void *) mc));
4612 /** Push a page onto the top of the cursor's stack. */
4614 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
4616 DPRINTF(("pushing page %"Z"u on db %d cursor %p", mp->mp_pgno,
4617 DDBI(mc), (void *) mc));
4619 if (mc->mc_snum >= CURSOR_STACK) {
4620 assert(mc->mc_snum < CURSOR_STACK);
4621 return MDB_CURSOR_FULL;
4624 mc->mc_top = mc->mc_snum++;
4625 mc->mc_pg[mc->mc_top] = mp;
4626 mc->mc_ki[mc->mc_top] = 0;
4631 /** Find the address of the page corresponding to a given page number.
4632 * @param[in] txn the transaction for this access.
4633 * @param[in] pgno the page number for the page to retrieve.
4634 * @param[out] ret address of a pointer where the page's address will be stored.
4635 * @param[out] lvl dirty_list inheritance level of found page. 1=current txn, 0=mapped page.
4636 * @return 0 on success, non-zero on failure.
4639 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret, int *lvl)
4641 MDB_env *env = txn->mt_env;
4645 if (!((txn->mt_flags & MDB_TXN_RDONLY) | (env->me_flags & MDB_WRITEMAP))) {
4649 MDB_ID2L dl = tx2->mt_u.dirty_list;
4651 /* Spilled pages were dirtied in this txn and flushed
4652 * because the dirty list got full. Bring this page
4653 * back in from the map (but don't unspill it here,
4654 * leave that unless page_touch happens again).
4656 if (tx2->mt_spill_pgs) {
4657 MDB_ID pn = pgno << 1;
4658 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
4659 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
4660 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
4665 unsigned x = mdb_mid2l_search(dl, pgno);
4666 if (x <= dl[0].mid && dl[x].mid == pgno) {
4672 } while ((tx2 = tx2->mt_parent) != NULL);
4675 if (pgno < txn->mt_next_pgno) {
4677 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
4679 DPRINTF(("page %"Z"u not found", pgno));
4681 return MDB_PAGE_NOTFOUND;
4691 /** Finish #mdb_page_search() / #mdb_page_search_lowest().
4692 * The cursor is at the root page, set up the rest of it.
4695 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int flags)
4697 MDB_page *mp = mc->mc_pg[mc->mc_top];
4701 while (IS_BRANCH(mp)) {
4705 DPRINTF(("branch page %"Z"u has %u keys", mp->mp_pgno, NUMKEYS(mp)));
4706 assert(NUMKEYS(mp) > 1);
4707 DPRINTF(("found index 0 to page %"Z"u", NODEPGNO(NODEPTR(mp, 0))));
4709 if (flags & (MDB_PS_FIRST|MDB_PS_LAST)) {
4711 if (flags & MDB_PS_LAST)
4712 i = NUMKEYS(mp) - 1;
4715 node = mdb_node_search(mc, key, &exact);
4717 i = NUMKEYS(mp) - 1;
4719 i = mc->mc_ki[mc->mc_top];
4725 DPRINTF(("following index %u for key [%s]", i, DKEY(key)));
4728 assert(i < NUMKEYS(mp));
4729 node = NODEPTR(mp, i);
4731 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
4734 mc->mc_ki[mc->mc_top] = i;
4735 if ((rc = mdb_cursor_push(mc, mp)))
4738 if (flags & MDB_PS_MODIFY) {
4739 if ((rc = mdb_page_touch(mc)) != 0)
4741 mp = mc->mc_pg[mc->mc_top];
4746 DPRINTF(("internal error, index points to a %02X page!?",
4748 return MDB_CORRUPTED;
4751 DPRINTF(("found leaf page %"Z"u for key [%s]", mp->mp_pgno,
4752 key ? DKEY(key) : "null"));
4753 mc->mc_flags |= C_INITIALIZED;
4754 mc->mc_flags &= ~C_EOF;
4759 /** Search for the lowest key under the current branch page.
4760 * This just bypasses a NUMKEYS check in the current page
4761 * before calling mdb_page_search_root(), because the callers
4762 * are all in situations where the current page is known to
4766 mdb_page_search_lowest(MDB_cursor *mc)
4768 MDB_page *mp = mc->mc_pg[mc->mc_top];
4769 MDB_node *node = NODEPTR(mp, 0);
4772 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
4775 mc->mc_ki[mc->mc_top] = 0;
4776 if ((rc = mdb_cursor_push(mc, mp)))
4778 return mdb_page_search_root(mc, NULL, MDB_PS_FIRST);
4781 /** Search for the page a given key should be in.
4782 * Push it and its parent pages on the cursor stack.
4783 * @param[in,out] mc the cursor for this operation.
4784 * @param[in] key the key to search for, or NULL for first/last page.
4785 * @param[in] flags If MDB_PS_MODIFY is set, visited pages in the DB
4786 * are touched (updated with new page numbers).
4787 * If MDB_PS_FIRST or MDB_PS_LAST is set, find first or last leaf.
4788 * This is used by #mdb_cursor_first() and #mdb_cursor_last().
4789 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
4790 * @return 0 on success, non-zero on failure.
4793 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
4798 /* Make sure the txn is still viable, then find the root from
4799 * the txn's db table and set it as the root of the cursor's stack.
4801 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
4802 DPUTS("transaction has failed, must abort");
4805 /* Make sure we're using an up-to-date root */
4806 if (*mc->mc_dbflag & DB_STALE) {
4808 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
4809 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, 0);
4816 MDB_node *leaf = mdb_node_search(&mc2,
4817 &mc->mc_dbx->md_name, &exact);
4819 return MDB_NOTFOUND;
4820 rc = mdb_node_read(mc->mc_txn, leaf, &data);
4823 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
4825 /* The txn may not know this DBI, or another process may
4826 * have dropped and recreated the DB with other flags.
4828 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
4829 return MDB_INCOMPATIBLE;
4830 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
4832 *mc->mc_dbflag &= ~DB_STALE;
4834 root = mc->mc_db->md_root;
4836 if (root == P_INVALID) { /* Tree is empty. */
4837 DPUTS("tree is empty");
4838 return MDB_NOTFOUND;
4843 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
4844 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0], NULL)) != 0)
4850 DPRINTF(("db %d root page %"Z"u has flags 0x%X",
4851 DDBI(mc), root, mc->mc_pg[0]->mp_flags));
4853 if (flags & MDB_PS_MODIFY) {
4854 if ((rc = mdb_page_touch(mc)))
4858 if (flags & MDB_PS_ROOTONLY)
4861 return mdb_page_search_root(mc, key, flags);
4865 mdb_ovpage_free(MDB_cursor *mc, MDB_page *mp)
4867 MDB_txn *txn = mc->mc_txn;
4868 pgno_t pg = mp->mp_pgno;
4869 unsigned x = 0, ovpages = mp->mp_pages;
4870 MDB_env *env = txn->mt_env;
4871 MDB_IDL sl = txn->mt_spill_pgs;
4872 MDB_ID pn = pg << 1;
4875 DPRINTF(("free ov page %"Z"u (%d)", pg, ovpages));
4876 /* If the page is dirty or on the spill list we just acquired it,
4877 * so we should give it back to our current free list, if any.
4878 * Otherwise put it onto the list of pages we freed in this txn.
4880 * Won't create me_pghead: me_pglast must be inited along with it.
4881 * Unsupported in nested txns: They would need to hide the page
4882 * range in ancestor txns' dirty and spilled lists.
4884 if (env->me_pghead &&
4886 ((mp->mp_flags & P_DIRTY) ||
4887 (sl && (x = mdb_midl_search(sl, pn)) <= sl[0] && sl[x] == pn)))
4891 MDB_ID2 *dl, ix, iy;
4892 rc = mdb_midl_need(&env->me_pghead, ovpages);
4895 if (!(mp->mp_flags & P_DIRTY)) {
4896 /* This page is no longer spilled */
4903 /* Remove from dirty list */
4904 dl = txn->mt_u.dirty_list;
4906 for (ix = dl[x]; ix.mptr != mp; ix = iy) {
4914 dl[j] = ix; /* Unsorted. OK when MDB_TXN_ERROR. */
4915 txn->mt_flags |= MDB_TXN_ERROR;
4916 return MDB_CORRUPTED;
4919 if (!(env->me_flags & MDB_WRITEMAP))
4920 mdb_dpage_free(env, mp);
4922 /* Insert in me_pghead */
4923 mop = env->me_pghead;
4924 j = mop[0] + ovpages;
4925 for (i = mop[0]; i && mop[i] < pg; i--)
4931 rc = mdb_midl_append_range(&txn->mt_free_pgs, pg, ovpages);
4935 mc->mc_db->md_overflow_pages -= ovpages;
4939 /** Return the data associated with a given node.
4940 * @param[in] txn The transaction for this operation.
4941 * @param[in] leaf The node being read.
4942 * @param[out] data Updated to point to the node's data.
4943 * @return 0 on success, non-zero on failure.
4946 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
4948 MDB_page *omp; /* overflow page */
4952 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
4953 data->mv_size = NODEDSZ(leaf);
4954 data->mv_data = NODEDATA(leaf);
4958 /* Read overflow data.
4960 data->mv_size = NODEDSZ(leaf);
4961 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
4962 if ((rc = mdb_page_get(txn, pgno, &omp, NULL)) != 0) {
4963 DPRINTF(("read overflow page %"Z"u failed", pgno));
4966 data->mv_data = METADATA(omp);
4972 mdb_get(MDB_txn *txn, MDB_dbi dbi,
4973 MDB_val *key, MDB_val *data)
4982 DPRINTF(("===> get db %u key [%s]", dbi, DKEY(key)));
4984 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
4987 if (txn->mt_flags & MDB_TXN_ERROR)
4990 mdb_cursor_init(&mc, txn, dbi, &mx);
4991 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
4994 /** Find a sibling for a page.
4995 * Replaces the page at the top of the cursor's stack with the
4996 * specified sibling, if one exists.
4997 * @param[in] mc The cursor for this operation.
4998 * @param[in] move_right Non-zero if the right sibling is requested,
4999 * otherwise the left sibling.
5000 * @return 0 on success, non-zero on failure.
5003 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
5009 if (mc->mc_snum < 2) {
5010 return MDB_NOTFOUND; /* root has no siblings */
5014 DPRINTF(("parent page is page %"Z"u, index %u",
5015 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]));
5017 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
5018 : (mc->mc_ki[mc->mc_top] == 0)) {
5019 DPRINTF(("no more keys left, moving to %s sibling",
5020 move_right ? "right" : "left"));
5021 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
5022 /* undo cursor_pop before returning */
5029 mc->mc_ki[mc->mc_top]++;
5031 mc->mc_ki[mc->mc_top]--;
5032 DPRINTF(("just moving to %s index key %u",
5033 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]));
5035 assert(IS_BRANCH(mc->mc_pg[mc->mc_top]));
5037 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5038 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp, NULL)) != 0) {
5039 /* mc will be inconsistent if caller does mc_snum++ as above */
5040 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
5044 mdb_cursor_push(mc, mp);
5046 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
5051 /** Move the cursor to the next data item. */
5053 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5059 if (mc->mc_flags & C_EOF) {
5060 return MDB_NOTFOUND;
5063 assert(mc->mc_flags & C_INITIALIZED);
5065 mp = mc->mc_pg[mc->mc_top];
5067 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5068 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5069 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5070 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
5071 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
5072 if (op != MDB_NEXT || rc != MDB_NOTFOUND) {
5073 if (rc == MDB_SUCCESS)
5074 MDB_GET_KEY(leaf, key);
5079 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5080 if (op == MDB_NEXT_DUP)
5081 return MDB_NOTFOUND;
5085 DPRINTF(("cursor_next: top page is %"Z"u in cursor %p", mp->mp_pgno, (void *) mc));
5086 if (mc->mc_flags & C_DEL)
5089 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
5090 DPUTS("=====> move to next sibling page");
5091 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
5092 mc->mc_flags |= C_EOF;
5095 mp = mc->mc_pg[mc->mc_top];
5096 DPRINTF(("next page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5098 mc->mc_ki[mc->mc_top]++;
5101 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5102 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5105 key->mv_size = mc->mc_db->md_pad;
5106 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5110 assert(IS_LEAF(mp));
5111 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5113 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5114 mdb_xcursor_init1(mc, leaf);
5117 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5120 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5121 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5122 if (rc != MDB_SUCCESS)
5127 MDB_GET_KEY(leaf, key);
5131 /** Move the cursor to the previous data item. */
5133 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5139 assert(mc->mc_flags & C_INITIALIZED);
5141 mp = mc->mc_pg[mc->mc_top];
5143 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5144 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5145 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5146 if (op == MDB_PREV || op == MDB_PREV_DUP) {
5147 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
5148 if (op != MDB_PREV || rc != MDB_NOTFOUND) {
5149 if (rc == MDB_SUCCESS)
5150 MDB_GET_KEY(leaf, key);
5154 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5155 if (op == MDB_PREV_DUP)
5156 return MDB_NOTFOUND;
5161 DPRINTF(("cursor_prev: top page is %"Z"u in cursor %p", mp->mp_pgno, (void *) mc));
5163 if (mc->mc_ki[mc->mc_top] == 0) {
5164 DPUTS("=====> move to prev sibling page");
5165 if ((rc = mdb_cursor_sibling(mc, 0)) != MDB_SUCCESS) {
5168 mp = mc->mc_pg[mc->mc_top];
5169 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
5170 DPRINTF(("prev page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5172 mc->mc_ki[mc->mc_top]--;
5174 mc->mc_flags &= ~C_EOF;
5176 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5177 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5180 key->mv_size = mc->mc_db->md_pad;
5181 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5185 assert(IS_LEAF(mp));
5186 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5188 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5189 mdb_xcursor_init1(mc, leaf);
5192 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5195 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5196 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5197 if (rc != MDB_SUCCESS)
5202 MDB_GET_KEY(leaf, key);
5206 /** Set the cursor on a specific data item. */
5208 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5209 MDB_cursor_op op, int *exactp)
5213 MDB_node *leaf = NULL;
5218 if (key->mv_size == 0)
5219 return MDB_BAD_VALSIZE;
5222 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5224 /* See if we're already on the right page */
5225 if (mc->mc_flags & C_INITIALIZED) {
5228 mp = mc->mc_pg[mc->mc_top];
5230 mc->mc_ki[mc->mc_top] = 0;
5231 return MDB_NOTFOUND;
5233 if (mp->mp_flags & P_LEAF2) {
5234 nodekey.mv_size = mc->mc_db->md_pad;
5235 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
5237 leaf = NODEPTR(mp, 0);
5238 MDB_GET_KEY2(leaf, nodekey);
5240 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5242 /* Probably happens rarely, but first node on the page
5243 * was the one we wanted.
5245 mc->mc_ki[mc->mc_top] = 0;
5252 unsigned int nkeys = NUMKEYS(mp);
5254 if (mp->mp_flags & P_LEAF2) {
5255 nodekey.mv_data = LEAF2KEY(mp,
5256 nkeys-1, nodekey.mv_size);
5258 leaf = NODEPTR(mp, nkeys-1);
5259 MDB_GET_KEY2(leaf, nodekey);
5261 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5263 /* last node was the one we wanted */
5264 mc->mc_ki[mc->mc_top] = nkeys-1;
5270 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
5271 /* This is definitely the right page, skip search_page */
5272 if (mp->mp_flags & P_LEAF2) {
5273 nodekey.mv_data = LEAF2KEY(mp,
5274 mc->mc_ki[mc->mc_top], nodekey.mv_size);
5276 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5277 MDB_GET_KEY2(leaf, nodekey);
5279 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5281 /* current node was the one we wanted */
5291 /* If any parents have right-sibs, search.
5292 * Otherwise, there's nothing further.
5294 for (i=0; i<mc->mc_top; i++)
5296 NUMKEYS(mc->mc_pg[i])-1)
5298 if (i == mc->mc_top) {
5299 /* There are no other pages */
5300 mc->mc_ki[mc->mc_top] = nkeys;
5301 return MDB_NOTFOUND;
5305 /* There are no other pages */
5306 mc->mc_ki[mc->mc_top] = 0;
5307 if (op == MDB_SET_RANGE) {
5311 return MDB_NOTFOUND;
5315 rc = mdb_page_search(mc, key, 0);
5316 if (rc != MDB_SUCCESS)
5319 mp = mc->mc_pg[mc->mc_top];
5320 assert(IS_LEAF(mp));
5323 leaf = mdb_node_search(mc, key, exactp);
5324 if (exactp != NULL && !*exactp) {
5325 /* MDB_SET specified and not an exact match. */
5326 return MDB_NOTFOUND;
5330 DPUTS("===> inexact leaf not found, goto sibling");
5331 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
5332 return rc; /* no entries matched */
5333 mp = mc->mc_pg[mc->mc_top];
5334 assert(IS_LEAF(mp));
5335 leaf = NODEPTR(mp, 0);
5339 mc->mc_flags |= C_INITIALIZED;
5340 mc->mc_flags &= ~C_EOF;
5343 key->mv_size = mc->mc_db->md_pad;
5344 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5348 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5349 mdb_xcursor_init1(mc, leaf);
5352 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5353 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
5354 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5357 if (op == MDB_GET_BOTH) {
5363 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
5364 if (rc != MDB_SUCCESS)
5367 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
5369 if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
5371 rc = mc->mc_dbx->md_dcmp(data, &d2);
5373 if (op == MDB_GET_BOTH || rc > 0)
5374 return MDB_NOTFOUND;
5381 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5382 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5387 /* The key already matches in all other cases */
5388 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
5389 MDB_GET_KEY(leaf, key);
5390 DPRINTF(("==> cursor placed on key [%s]", DKEY(key)));
5395 /** Move the cursor to the first item in the database. */
5397 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
5403 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5405 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
5406 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
5407 if (rc != MDB_SUCCESS)
5410 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
5412 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
5413 mc->mc_flags |= C_INITIALIZED;
5414 mc->mc_flags &= ~C_EOF;
5416 mc->mc_ki[mc->mc_top] = 0;
5418 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5419 key->mv_size = mc->mc_db->md_pad;
5420 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
5425 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5426 mdb_xcursor_init1(mc, leaf);
5427 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5431 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5435 MDB_GET_KEY(leaf, key);
5439 /** Move the cursor to the last item in the database. */
5441 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
5447 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5449 if (!(mc->mc_flags & C_EOF)) {
5451 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
5452 rc = mdb_page_search(mc, NULL, MDB_PS_LAST);
5453 if (rc != MDB_SUCCESS)
5456 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
5459 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
5460 mc->mc_flags |= C_INITIALIZED|C_EOF;
5461 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5463 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5464 key->mv_size = mc->mc_db->md_pad;
5465 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
5470 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5471 mdb_xcursor_init1(mc, leaf);
5472 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5476 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5481 MDB_GET_KEY(leaf, key);
5486 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5491 int (*mfunc)(MDB_cursor *mc, MDB_val *key, MDB_val *data);
5495 if (mc->mc_txn->mt_flags & MDB_TXN_ERROR)
5499 case MDB_GET_CURRENT:
5500 if (!(mc->mc_flags & C_INITIALIZED)) {
5503 MDB_page *mp = mc->mc_pg[mc->mc_top];
5504 int nkeys = NUMKEYS(mp);
5505 if (!nkeys || mc->mc_ki[mc->mc_top] >= nkeys) {
5506 mc->mc_ki[mc->mc_top] = nkeys;
5512 key->mv_size = mc->mc_db->md_pad;
5513 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5515 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5516 MDB_GET_KEY(leaf, key);
5518 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5519 if (mc->mc_flags & C_DEL)
5520 mdb_xcursor_init1(mc, leaf);
5521 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
5523 rc = mdb_node_read(mc->mc_txn, leaf, data);
5530 case MDB_GET_BOTH_RANGE:
5535 if (mc->mc_xcursor == NULL) {
5536 rc = MDB_INCOMPATIBLE;
5546 rc = mdb_cursor_set(mc, key, data, op,
5547 op == MDB_SET_RANGE ? NULL : &exact);
5550 case MDB_GET_MULTIPLE:
5551 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
5555 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
5556 rc = MDB_INCOMPATIBLE;
5560 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
5561 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
5564 case MDB_NEXT_MULTIPLE:
5569 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
5570 rc = MDB_INCOMPATIBLE;
5573 if (!(mc->mc_flags & C_INITIALIZED))
5574 rc = mdb_cursor_first(mc, key, data);
5576 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
5577 if (rc == MDB_SUCCESS) {
5578 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
5581 mx = &mc->mc_xcursor->mx_cursor;
5582 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
5584 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
5585 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
5593 case MDB_NEXT_NODUP:
5594 if (!(mc->mc_flags & C_INITIALIZED))
5595 rc = mdb_cursor_first(mc, key, data);
5597 rc = mdb_cursor_next(mc, key, data, op);
5601 case MDB_PREV_NODUP:
5602 if (!(mc->mc_flags & C_INITIALIZED)) {
5603 rc = mdb_cursor_last(mc, key, data);
5606 mc->mc_flags |= C_INITIALIZED;
5607 mc->mc_ki[mc->mc_top]++;
5609 rc = mdb_cursor_prev(mc, key, data, op);
5612 rc = mdb_cursor_first(mc, key, data);
5615 mfunc = mdb_cursor_first;
5617 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
5621 if (mc->mc_xcursor == NULL) {
5622 rc = MDB_INCOMPATIBLE;
5625 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
5629 rc = mfunc(&mc->mc_xcursor->mx_cursor, data, NULL);
5632 rc = mdb_cursor_last(mc, key, data);
5635 mfunc = mdb_cursor_last;
5638 DPRINTF(("unhandled/unimplemented cursor operation %u", op));
5643 if (mc->mc_flags & C_DEL)
5644 mc->mc_flags ^= C_DEL;
5649 /** Touch all the pages in the cursor stack. Set mc_top.
5650 * Makes sure all the pages are writable, before attempting a write operation.
5651 * @param[in] mc The cursor to operate on.
5654 mdb_cursor_touch(MDB_cursor *mc)
5656 int rc = MDB_SUCCESS;
5658 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
5661 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, &mcx);
5662 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
5665 *mc->mc_dbflag |= DB_DIRTY;
5670 rc = mdb_page_touch(mc);
5671 } while (!rc && ++(mc->mc_top) < mc->mc_snum);
5672 mc->mc_top = mc->mc_snum-1;
5677 /** Do not spill pages to disk if txn is getting full, may fail instead */
5678 #define MDB_NOSPILL 0x8000
5681 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5684 enum { MDB_NO_ROOT = MDB_LAST_ERRCODE+10 }; /* internal code */
5685 MDB_env *env = mc->mc_txn->mt_env;
5686 MDB_node *leaf = NULL;
5689 MDB_val xdata, *rdata, dkey, olddata;
5691 int do_sub = 0, insert;
5692 unsigned int mcount = 0, dcount = 0, nospill;
5695 unsigned int nflags;
5698 /* Check this first so counter will always be zero on any
5701 if (flags & MDB_MULTIPLE) {
5702 dcount = data[1].mv_size;
5703 data[1].mv_size = 0;
5704 if (!F_ISSET(mc->mc_db->md_flags, MDB_DUPFIXED))
5705 return MDB_INCOMPATIBLE;
5708 nospill = flags & MDB_NOSPILL;
5709 flags &= ~MDB_NOSPILL;
5711 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
5712 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
5714 if (flags != MDB_CURRENT && key->mv_size-1 >= ENV_MAXKEY(env))
5715 return MDB_BAD_VALSIZE;
5717 #if SIZE_MAX > MAXDATASIZE
5718 if (data->mv_size > ((mc->mc_db->md_flags & MDB_DUPSORT) ? ENV_MAXKEY(env) : MAXDATASIZE))
5719 return MDB_BAD_VALSIZE;
5721 if ((mc->mc_db->md_flags & MDB_DUPSORT) && data->mv_size > ENV_MAXKEY(env))
5722 return MDB_BAD_VALSIZE;
5725 DPRINTF(("==> put db %d key [%s], size %"Z"u, data size %"Z"u",
5726 DDBI(mc), DKEY(key), key ? key->mv_size : 0, data->mv_size));
5730 if (flags == MDB_CURRENT) {
5731 if (!(mc->mc_flags & C_INITIALIZED))
5734 } else if (mc->mc_db->md_root == P_INVALID) {
5735 /* new database, cursor has nothing to point to */
5738 mc->mc_flags &= ~C_INITIALIZED;
5743 if (flags & MDB_APPEND) {
5745 rc = mdb_cursor_last(mc, &k2, &d2);
5747 rc = mc->mc_dbx->md_cmp(key, &k2);
5750 mc->mc_ki[mc->mc_top]++;
5752 /* new key is <= last key */
5757 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
5759 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
5760 DPRINTF(("duplicate key [%s]", DKEY(key)));
5762 return MDB_KEYEXIST;
5764 if (rc && rc != MDB_NOTFOUND)
5768 if (mc->mc_flags & C_DEL)
5769 mc->mc_flags ^= C_DEL;
5771 /* Cursor is positioned, check for room in the dirty list */
5773 if (flags & MDB_MULTIPLE) {
5775 xdata.mv_size = data->mv_size * dcount;
5779 if ((rc2 = mdb_page_spill(mc, key, rdata)))
5783 if (rc == MDB_NO_ROOT) {
5785 /* new database, write a root leaf page */
5786 DPUTS("allocating new root leaf page");
5787 if ((rc2 = mdb_page_new(mc, P_LEAF, 1, &np))) {
5790 mdb_cursor_push(mc, np);
5791 mc->mc_db->md_root = np->mp_pgno;
5792 mc->mc_db->md_depth++;
5793 *mc->mc_dbflag |= DB_DIRTY;
5794 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
5796 np->mp_flags |= P_LEAF2;
5797 mc->mc_flags |= C_INITIALIZED;
5799 /* make sure all cursor pages are writable */
5800 rc2 = mdb_cursor_touch(mc);
5807 /* The key does not exist */
5808 DPRINTF(("inserting key at index %i", mc->mc_ki[mc->mc_top]));
5809 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
5810 LEAFSIZE(key, data) > env->me_nodemax)
5812 /* Too big for a node, insert in sub-DB */
5813 fp_flags = P_LEAF|P_DIRTY;
5815 fp->mp_pad = data->mv_size; /* used if MDB_DUPFIXED */
5816 fp->mp_lower = fp->mp_upper = olddata.mv_size = PAGEHDRSZ;
5820 /* there's only a key anyway, so this is a no-op */
5821 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5822 unsigned int ksize = mc->mc_db->md_pad;
5823 if (key->mv_size != ksize)
5824 return MDB_BAD_VALSIZE;
5825 if (flags == MDB_CURRENT) {
5826 char *ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
5827 memcpy(ptr, key->mv_data, ksize);
5833 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5834 olddata.mv_size = NODEDSZ(leaf);
5835 olddata.mv_data = NODEDATA(leaf);
5838 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
5839 /* Prepare (sub-)page/sub-DB to accept the new item,
5840 * if needed. fp: old sub-page or a header faking
5841 * it. mp: new (sub-)page. offset: growth in page
5842 * size. xdata: node data with new page or DB.
5844 unsigned i, offset = 0;
5845 mp = fp = xdata.mv_data = env->me_pbuf;
5846 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5848 /* Was a single item before, must convert now */
5849 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5850 /* Just overwrite the current item */
5851 if (flags == MDB_CURRENT)
5854 #if UINT_MAX < SIZE_MAX
5855 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
5856 #ifdef MISALIGNED_OK
5857 mc->mc_dbx->md_dcmp = mdb_cmp_long;
5859 mc->mc_dbx->md_dcmp = mdb_cmp_cint;
5862 /* if data matches, skip it */
5863 if (!mc->mc_dbx->md_dcmp(data, &olddata)) {
5864 if (flags & MDB_NODUPDATA)
5866 else if (flags & MDB_MULTIPLE)
5873 /* Back up original data item */
5874 dkey.mv_size = olddata.mv_size;
5875 dkey.mv_data = memcpy(fp+1, olddata.mv_data, olddata.mv_size);
5877 /* Make sub-page header for the dup items, with dummy body */
5878 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
5879 fp->mp_lower = PAGEHDRSZ;
5880 xdata.mv_size = PAGEHDRSZ + dkey.mv_size + data->mv_size;
5881 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5882 fp->mp_flags |= P_LEAF2;
5883 fp->mp_pad = data->mv_size;
5884 xdata.mv_size += 2 * data->mv_size; /* leave space for 2 more */
5886 xdata.mv_size += 2 * (sizeof(indx_t) + NODESIZE) +
5887 (dkey.mv_size & 1) + (data->mv_size & 1);
5889 fp->mp_upper = xdata.mv_size;
5890 olddata.mv_size = fp->mp_upper; /* pretend olddata is fp */
5891 } else if (leaf->mn_flags & F_SUBDATA) {
5892 /* Data is on sub-DB, just store it */
5893 flags |= F_DUPDATA|F_SUBDATA;
5896 /* Data is on sub-page */
5897 fp = olddata.mv_data;
5900 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
5901 offset = EVEN(NODESIZE + sizeof(indx_t) +
5905 offset = fp->mp_pad;
5906 if (SIZELEFT(fp) < offset) {
5907 offset *= 4; /* space for 4 more */
5910 /* FALLTHRU: Big enough MDB_DUPFIXED sub-page */
5912 fp->mp_flags |= P_DIRTY;
5913 COPY_PGNO(fp->mp_pgno, mp->mp_pgno);
5914 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
5918 xdata.mv_size = olddata.mv_size + offset;
5921 fp_flags = fp->mp_flags;
5922 if (NODESIZE + NODEKSZ(leaf) + xdata.mv_size > env->me_nodemax) {
5923 /* Too big for a sub-page, convert to sub-DB */
5924 fp_flags &= ~P_SUBP;
5926 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5927 fp_flags |= P_LEAF2;
5928 dummy.md_pad = fp->mp_pad;
5929 dummy.md_flags = MDB_DUPFIXED;
5930 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5931 dummy.md_flags |= MDB_INTEGERKEY;
5937 dummy.md_branch_pages = 0;
5938 dummy.md_leaf_pages = 1;
5939 dummy.md_overflow_pages = 0;
5940 dummy.md_entries = NUMKEYS(fp);
5941 xdata.mv_size = sizeof(MDB_db);
5942 xdata.mv_data = &dummy;
5943 if ((rc = mdb_page_alloc(mc, 1, &mp)))
5945 offset = env->me_psize - olddata.mv_size;
5946 flags |= F_DUPDATA|F_SUBDATA;
5947 dummy.md_root = mp->mp_pgno;
5950 mp->mp_flags = fp_flags | P_DIRTY;
5951 mp->mp_pad = fp->mp_pad;
5952 mp->mp_lower = fp->mp_lower;
5953 mp->mp_upper = fp->mp_upper + offset;
5954 if (fp_flags & P_LEAF2) {
5955 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
5957 memcpy((char *)mp + mp->mp_upper, (char *)fp + fp->mp_upper,
5958 olddata.mv_size - fp->mp_upper);
5959 for (i=0; i<NUMKEYS(fp); i++)
5960 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
5968 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5972 /* overflow page overwrites need special handling */
5973 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5976 int level, ovpages, dpages = OVPAGES(data->mv_size, env->me_psize);
5978 memcpy(&pg, olddata.mv_data, sizeof(pg));
5979 if ((rc2 = mdb_page_get(mc->mc_txn, pg, &omp, &level)) != 0)
5981 ovpages = omp->mp_pages;
5983 /* Is the ov page large enough? */
5984 if (ovpages >= dpages) {
5985 if (!(omp->mp_flags & P_DIRTY) &&
5986 (level || (env->me_flags & MDB_WRITEMAP)))
5988 rc = mdb_page_unspill(mc->mc_txn, omp, &omp);
5991 level = 0; /* dirty in this txn or clean */
5994 if (omp->mp_flags & P_DIRTY) {
5995 /* yes, overwrite it. Note in this case we don't
5996 * bother to try shrinking the page if the new data
5997 * is smaller than the overflow threshold.
6000 /* It is writable only in a parent txn */
6001 size_t sz = (size_t) env->me_psize * ovpages, off;
6002 MDB_page *np = mdb_page_malloc(mc->mc_txn, ovpages);
6008 mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &id2);
6009 if (!(flags & MDB_RESERVE)) {
6010 /* Copy end of page, adjusting alignment so
6011 * compiler may copy words instead of bytes.
6013 off = (PAGEHDRSZ + data->mv_size) & -sizeof(size_t);
6014 memcpy((size_t *)((char *)np + off),
6015 (size_t *)((char *)omp + off), sz - off);
6018 memcpy(np, omp, sz); /* Copy beginning of page */
6021 SETDSZ(leaf, data->mv_size);
6022 if (F_ISSET(flags, MDB_RESERVE))
6023 data->mv_data = METADATA(omp);
6025 memcpy(METADATA(omp), data->mv_data, data->mv_size);
6029 if ((rc2 = mdb_ovpage_free(mc, omp)) != MDB_SUCCESS)
6031 } else if (data->mv_size == olddata.mv_size) {
6032 /* same size, just replace it. Note that we could
6033 * also reuse this node if the new data is smaller,
6034 * but instead we opt to shrink the node in that case.
6036 if (F_ISSET(flags, MDB_RESERVE))
6037 data->mv_data = olddata.mv_data;
6038 else if (data->mv_size)
6039 memcpy(olddata.mv_data, data->mv_data, data->mv_size);
6041 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
6044 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
6045 mc->mc_db->md_entries--;
6051 nflags = flags & NODE_ADD_FLAGS;
6052 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(env, key, rdata);
6053 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
6054 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
6055 nflags &= ~MDB_APPEND;
6057 nflags |= MDB_SPLIT_REPLACE;
6058 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
6060 /* There is room already in this leaf page. */
6061 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
6062 if (rc == 0 && !do_sub && insert) {
6063 /* Adjust other cursors pointing to mp */
6064 MDB_cursor *m2, *m3;
6065 MDB_dbi dbi = mc->mc_dbi;
6066 unsigned i = mc->mc_top;
6067 MDB_page *mp = mc->mc_pg[i];
6069 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6070 if (mc->mc_flags & C_SUB)
6071 m3 = &m2->mc_xcursor->mx_cursor;
6074 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
6075 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
6082 if (rc != MDB_SUCCESS)
6083 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6085 /* Now store the actual data in the child DB. Note that we're
6086 * storing the user data in the keys field, so there are strict
6087 * size limits on dupdata. The actual data fields of the child
6088 * DB are all zero size.
6095 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6096 if (flags & MDB_CURRENT) {
6097 xflags = MDB_CURRENT|MDB_NOSPILL;
6099 mdb_xcursor_init1(mc, leaf);
6100 xflags = (flags & MDB_NODUPDATA) ?
6101 MDB_NOOVERWRITE|MDB_NOSPILL : MDB_NOSPILL;
6103 /* converted, write the original data first */
6105 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
6109 /* Adjust other cursors pointing to mp */
6111 unsigned i = mc->mc_top;
6112 MDB_page *mp = mc->mc_pg[i];
6114 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6115 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6116 if (!(m2->mc_flags & C_INITIALIZED)) continue;
6117 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
6118 mdb_xcursor_init1(m2, leaf);
6122 /* we've done our job */
6125 if (flags & MDB_APPENDDUP)
6126 xflags |= MDB_APPEND;
6127 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
6128 if (flags & F_SUBDATA) {
6129 void *db = NODEDATA(leaf);
6130 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6133 /* sub-writes might have failed so check rc again.
6134 * Don't increment count if we just replaced an existing item.
6136 if (!rc && !(flags & MDB_CURRENT))
6137 mc->mc_db->md_entries++;
6138 if (flags & MDB_MULTIPLE) {
6142 /* let caller know how many succeeded, if any */
6143 data[1].mv_size = mcount;
6144 if (mcount < dcount) {
6145 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
6152 /* If we succeeded and the key didn't exist before, make sure
6153 * the cursor is marked valid.
6156 mc->mc_flags |= C_INITIALIZED;
6161 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
6167 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
6168 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6170 if (!(mc->mc_flags & C_INITIALIZED))
6173 if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6174 return MDB_NOTFOUND;
6176 if (!(flags & MDB_NOSPILL) && (rc = mdb_page_spill(mc, NULL, NULL)))
6179 rc = mdb_cursor_touch(mc);
6183 mp = mc->mc_pg[mc->mc_top];
6184 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6186 if (!IS_LEAF2(mp) && F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6187 if (!(flags & MDB_NODUPDATA)) {
6188 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
6189 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6191 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, MDB_NOSPILL);
6192 /* If sub-DB still has entries, we're done */
6193 if (mc->mc_xcursor->mx_db.md_entries) {
6194 if (leaf->mn_flags & F_SUBDATA) {
6195 /* update subDB info */
6196 void *db = NODEDATA(leaf);
6197 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6200 /* shrink fake page */
6201 mdb_node_shrink(mp, mc->mc_ki[mc->mc_top]);
6202 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6203 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6204 /* fix other sub-DB cursors pointed at this fake page */
6205 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6206 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6207 if (m2->mc_pg[mc->mc_top] == mp &&
6208 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
6209 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6212 mc->mc_db->md_entries--;
6213 mc->mc_flags |= C_DEL;
6216 /* otherwise fall thru and delete the sub-DB */
6219 if (leaf->mn_flags & F_SUBDATA) {
6220 /* add all the child DB's pages to the free list */
6221 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
6222 if (rc == MDB_SUCCESS) {
6223 mc->mc_db->md_entries -=
6224 mc->mc_xcursor->mx_db.md_entries;
6229 return mdb_cursor_del0(mc, leaf);
6232 /** Allocate and initialize new pages for a database.
6233 * @param[in] mc a cursor on the database being added to.
6234 * @param[in] flags flags defining what type of page is being allocated.
6235 * @param[in] num the number of pages to allocate. This is usually 1,
6236 * unless allocating overflow pages for a large record.
6237 * @param[out] mp Address of a page, or NULL on failure.
6238 * @return 0 on success, non-zero on failure.
6241 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
6246 if ((rc = mdb_page_alloc(mc, num, &np)))
6248 DPRINTF(("allocated new mpage %"Z"u, page size %u",
6249 np->mp_pgno, mc->mc_txn->mt_env->me_psize));
6250 np->mp_flags = flags | P_DIRTY;
6251 np->mp_lower = PAGEHDRSZ;
6252 np->mp_upper = mc->mc_txn->mt_env->me_psize;
6255 mc->mc_db->md_branch_pages++;
6256 else if (IS_LEAF(np))
6257 mc->mc_db->md_leaf_pages++;
6258 else if (IS_OVERFLOW(np)) {
6259 mc->mc_db->md_overflow_pages += num;
6267 /** Calculate the size of a leaf node.
6268 * The size depends on the environment's page size; if a data item
6269 * is too large it will be put onto an overflow page and the node
6270 * size will only include the key and not the data. Sizes are always
6271 * rounded up to an even number of bytes, to guarantee 2-byte alignment
6272 * of the #MDB_node headers.
6273 * @param[in] env The environment handle.
6274 * @param[in] key The key for the node.
6275 * @param[in] data The data for the node.
6276 * @return The number of bytes needed to store the node.
6279 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
6283 sz = LEAFSIZE(key, data);
6284 if (sz > env->me_nodemax) {
6285 /* put on overflow page */
6286 sz -= data->mv_size - sizeof(pgno_t);
6289 return EVEN(sz + sizeof(indx_t));
6292 /** Calculate the size of a branch node.
6293 * The size should depend on the environment's page size but since
6294 * we currently don't support spilling large keys onto overflow
6295 * pages, it's simply the size of the #MDB_node header plus the
6296 * size of the key. Sizes are always rounded up to an even number
6297 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
6298 * @param[in] env The environment handle.
6299 * @param[in] key The key for the node.
6300 * @return The number of bytes needed to store the node.
6303 mdb_branch_size(MDB_env *env, MDB_val *key)
6308 if (sz > env->me_nodemax) {
6309 /* put on overflow page */
6310 /* not implemented */
6311 /* sz -= key->size - sizeof(pgno_t); */
6314 return sz + sizeof(indx_t);
6317 /** Add a node to the page pointed to by the cursor.
6318 * @param[in] mc The cursor for this operation.
6319 * @param[in] indx The index on the page where the new node should be added.
6320 * @param[in] key The key for the new node.
6321 * @param[in] data The data for the new node, if any.
6322 * @param[in] pgno The page number, if adding a branch node.
6323 * @param[in] flags Flags for the node.
6324 * @return 0 on success, non-zero on failure. Possible errors are:
6326 * <li>ENOMEM - failed to allocate overflow pages for the node.
6327 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
6328 * should never happen since all callers already calculate the
6329 * page's free space before calling this function.
6333 mdb_node_add(MDB_cursor *mc, indx_t indx,
6334 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
6337 size_t node_size = NODESIZE;
6341 MDB_page *mp = mc->mc_pg[mc->mc_top];
6342 MDB_page *ofp = NULL; /* overflow page */
6345 assert(mp->mp_upper >= mp->mp_lower);
6347 DPRINTF(("add to %s %spage %"Z"u index %i, data size %"Z"u key size %"Z"u [%s]",
6348 IS_LEAF(mp) ? "leaf" : "branch",
6349 IS_SUBP(mp) ? "sub-" : "",
6350 mp->mp_pgno, indx, data ? data->mv_size : 0,
6351 key ? key->mv_size : 0, key ? DKEY(key) : "null"));
6354 /* Move higher keys up one slot. */
6355 int ksize = mc->mc_db->md_pad, dif;
6356 char *ptr = LEAF2KEY(mp, indx, ksize);
6357 dif = NUMKEYS(mp) - indx;
6359 memmove(ptr+ksize, ptr, dif*ksize);
6360 /* insert new key */
6361 memcpy(ptr, key->mv_data, ksize);
6363 /* Just using these for counting */
6364 mp->mp_lower += sizeof(indx_t);
6365 mp->mp_upper -= ksize - sizeof(indx_t);
6369 room = (ssize_t)SIZELEFT(mp) - (ssize_t)sizeof(indx_t);
6371 node_size += key->mv_size;
6374 if (F_ISSET(flags, F_BIGDATA)) {
6375 /* Data already on overflow page. */
6376 node_size += sizeof(pgno_t);
6377 } else if (node_size + data->mv_size > mc->mc_txn->mt_env->me_nodemax) {
6378 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
6380 /* Put data on overflow page. */
6381 DPRINTF(("data size is %"Z"u, node would be %"Z"u, put data on overflow page",
6382 data->mv_size, node_size+data->mv_size));
6383 node_size = EVEN(node_size + sizeof(pgno_t));
6384 if ((ssize_t)node_size > room)
6386 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
6388 DPRINTF(("allocated overflow page %"Z"u", ofp->mp_pgno));
6392 node_size += data->mv_size;
6395 node_size = EVEN(node_size);
6396 if ((ssize_t)node_size > room)
6400 /* Move higher pointers up one slot. */
6401 for (i = NUMKEYS(mp); i > indx; i--)
6402 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
6404 /* Adjust free space offsets. */
6405 ofs = mp->mp_upper - node_size;
6406 assert(ofs >= mp->mp_lower + sizeof(indx_t));
6407 mp->mp_ptrs[indx] = ofs;
6409 mp->mp_lower += sizeof(indx_t);
6411 /* Write the node data. */
6412 node = NODEPTR(mp, indx);
6413 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
6414 node->mn_flags = flags;
6416 SETDSZ(node,data->mv_size);
6421 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
6426 if (F_ISSET(flags, F_BIGDATA))
6427 memcpy(node->mn_data + key->mv_size, data->mv_data,
6429 else if (F_ISSET(flags, MDB_RESERVE))
6430 data->mv_data = node->mn_data + key->mv_size;
6432 memcpy(node->mn_data + key->mv_size, data->mv_data,
6435 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
6437 if (F_ISSET(flags, MDB_RESERVE))
6438 data->mv_data = METADATA(ofp);
6440 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
6447 DPRINTF(("not enough room in page %"Z"u, got %u ptrs",
6448 mp->mp_pgno, NUMKEYS(mp)));
6449 DPRINTF(("upper-lower = %u - %u = %"Z"d", mp->mp_upper,mp->mp_lower,room));
6450 DPRINTF(("node size = %"Z"u", node_size));
6451 return MDB_PAGE_FULL;
6454 /** Delete the specified node from a page.
6455 * @param[in] mp The page to operate on.
6456 * @param[in] indx The index of the node to delete.
6457 * @param[in] ksize The size of a node. Only used if the page is
6458 * part of a #MDB_DUPFIXED database.
6461 mdb_node_del(MDB_page *mp, indx_t indx, int ksize)
6464 indx_t i, j, numkeys, ptr;
6471 COPY_PGNO(pgno, mp->mp_pgno);
6472 DPRINTF(("delete node %u on %s page %"Z"u", indx,
6473 IS_LEAF(mp) ? "leaf" : "branch", pgno));
6476 assert(indx < NUMKEYS(mp));
6479 int x = NUMKEYS(mp) - 1 - indx;
6480 base = LEAF2KEY(mp, indx, ksize);
6482 memmove(base, base + ksize, x * ksize);
6483 mp->mp_lower -= sizeof(indx_t);
6484 mp->mp_upper += ksize - sizeof(indx_t);
6488 node = NODEPTR(mp, indx);
6489 sz = NODESIZE + node->mn_ksize;
6491 if (F_ISSET(node->mn_flags, F_BIGDATA))
6492 sz += sizeof(pgno_t);
6494 sz += NODEDSZ(node);
6498 ptr = mp->mp_ptrs[indx];
6499 numkeys = NUMKEYS(mp);
6500 for (i = j = 0; i < numkeys; i++) {
6502 mp->mp_ptrs[j] = mp->mp_ptrs[i];
6503 if (mp->mp_ptrs[i] < ptr)
6504 mp->mp_ptrs[j] += sz;
6509 base = (char *)mp + mp->mp_upper;
6510 memmove(base + sz, base, ptr - mp->mp_upper);
6512 mp->mp_lower -= sizeof(indx_t);
6516 /** Compact the main page after deleting a node on a subpage.
6517 * @param[in] mp The main page to operate on.
6518 * @param[in] indx The index of the subpage on the main page.
6521 mdb_node_shrink(MDB_page *mp, indx_t indx)
6527 indx_t i, numkeys, ptr;
6529 node = NODEPTR(mp, indx);
6530 sp = (MDB_page *)NODEDATA(node);
6531 delta = SIZELEFT(sp);
6532 xp = (MDB_page *)((char *)sp + delta);
6534 /* shift subpage upward */
6536 nsize = NUMKEYS(sp) * sp->mp_pad;
6538 return; /* do not make the node uneven-sized */
6539 memmove(METADATA(xp), METADATA(sp), nsize);
6542 numkeys = NUMKEYS(sp);
6543 for (i=numkeys-1; i>=0; i--)
6544 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
6546 xp->mp_upper = sp->mp_lower;
6547 xp->mp_lower = sp->mp_lower;
6548 xp->mp_flags = sp->mp_flags;
6549 xp->mp_pad = sp->mp_pad;
6550 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
6552 nsize = NODEDSZ(node) - delta;
6553 SETDSZ(node, nsize);
6555 /* shift lower nodes upward */
6556 ptr = mp->mp_ptrs[indx];
6557 numkeys = NUMKEYS(mp);
6558 for (i = 0; i < numkeys; i++) {
6559 if (mp->mp_ptrs[i] <= ptr)
6560 mp->mp_ptrs[i] += delta;
6563 base = (char *)mp + mp->mp_upper;
6564 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
6565 mp->mp_upper += delta;
6568 /** Initial setup of a sorted-dups cursor.
6569 * Sorted duplicates are implemented as a sub-database for the given key.
6570 * The duplicate data items are actually keys of the sub-database.
6571 * Operations on the duplicate data items are performed using a sub-cursor
6572 * initialized when the sub-database is first accessed. This function does
6573 * the preliminary setup of the sub-cursor, filling in the fields that
6574 * depend only on the parent DB.
6575 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
6578 mdb_xcursor_init0(MDB_cursor *mc)
6580 MDB_xcursor *mx = mc->mc_xcursor;
6582 mx->mx_cursor.mc_xcursor = NULL;
6583 mx->mx_cursor.mc_txn = mc->mc_txn;
6584 mx->mx_cursor.mc_db = &mx->mx_db;
6585 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
6586 mx->mx_cursor.mc_dbi = mc->mc_dbi;
6587 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
6588 mx->mx_cursor.mc_snum = 0;
6589 mx->mx_cursor.mc_top = 0;
6590 mx->mx_cursor.mc_flags = C_SUB;
6591 mx->mx_dbx.md_name.mv_size = 0;
6592 mx->mx_dbx.md_name.mv_data = NULL;
6593 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
6594 mx->mx_dbx.md_dcmp = NULL;
6595 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
6598 /** Final setup of a sorted-dups cursor.
6599 * Sets up the fields that depend on the data from the main cursor.
6600 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
6601 * @param[in] node The data containing the #MDB_db record for the
6602 * sorted-dup database.
6605 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
6607 MDB_xcursor *mx = mc->mc_xcursor;
6609 if (node->mn_flags & F_SUBDATA) {
6610 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
6611 mx->mx_cursor.mc_pg[0] = 0;
6612 mx->mx_cursor.mc_snum = 0;
6613 mx->mx_cursor.mc_top = 0;
6614 mx->mx_cursor.mc_flags = C_SUB;
6616 MDB_page *fp = NODEDATA(node);
6617 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
6618 mx->mx_db.md_flags = 0;
6619 mx->mx_db.md_depth = 1;
6620 mx->mx_db.md_branch_pages = 0;
6621 mx->mx_db.md_leaf_pages = 1;
6622 mx->mx_db.md_overflow_pages = 0;
6623 mx->mx_db.md_entries = NUMKEYS(fp);
6624 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
6625 mx->mx_cursor.mc_snum = 1;
6626 mx->mx_cursor.mc_top = 0;
6627 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
6628 mx->mx_cursor.mc_pg[0] = fp;
6629 mx->mx_cursor.mc_ki[0] = 0;
6630 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6631 mx->mx_db.md_flags = MDB_DUPFIXED;
6632 mx->mx_db.md_pad = fp->mp_pad;
6633 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
6634 mx->mx_db.md_flags |= MDB_INTEGERKEY;
6637 DPRINTF(("Sub-db -%u root page %"Z"u", mx->mx_cursor.mc_dbi,
6638 mx->mx_db.md_root));
6639 mx->mx_dbflag = DB_VALID|DB_DIRTY; /* DB_DIRTY guides mdb_cursor_touch */
6640 #if UINT_MAX < SIZE_MAX
6641 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
6642 #ifdef MISALIGNED_OK
6643 mx->mx_dbx.md_cmp = mdb_cmp_long;
6645 mx->mx_dbx.md_cmp = mdb_cmp_cint;
6650 /** Initialize a cursor for a given transaction and database. */
6652 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
6655 mc->mc_backup = NULL;
6658 mc->mc_db = &txn->mt_dbs[dbi];
6659 mc->mc_dbx = &txn->mt_dbxs[dbi];
6660 mc->mc_dbflag = &txn->mt_dbflags[dbi];
6665 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
6667 mc->mc_xcursor = mx;
6668 mdb_xcursor_init0(mc);
6670 mc->mc_xcursor = NULL;
6672 if (*mc->mc_dbflag & DB_STALE) {
6673 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
6678 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
6681 size_t size = sizeof(MDB_cursor);
6683 if (txn == NULL || ret == NULL || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
6686 if (txn->mt_flags & MDB_TXN_ERROR)
6689 /* Allow read access to the freelist */
6690 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
6693 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
6694 size += sizeof(MDB_xcursor);
6696 if ((mc = malloc(size)) != NULL) {
6697 mdb_cursor_init(mc, txn, dbi, (MDB_xcursor *)(mc + 1));
6698 if (txn->mt_cursors) {
6699 mc->mc_next = txn->mt_cursors[dbi];
6700 txn->mt_cursors[dbi] = mc;
6701 mc->mc_flags |= C_UNTRACK;
6713 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
6715 if (txn == NULL || mc == NULL || mc->mc_dbi >= txn->mt_numdbs)
6718 if ((mc->mc_flags & C_UNTRACK) || txn->mt_cursors)
6721 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
6725 /* Return the count of duplicate data items for the current key */
6727 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
6731 if (mc == NULL || countp == NULL)
6734 if (mc->mc_xcursor == NULL)
6735 return MDB_INCOMPATIBLE;
6737 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6738 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6741 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
6744 *countp = mc->mc_xcursor->mx_db.md_entries;
6750 mdb_cursor_close(MDB_cursor *mc)
6752 if (mc && !mc->mc_backup) {
6753 /* remove from txn, if tracked */
6754 if ((mc->mc_flags & C_UNTRACK) && mc->mc_txn->mt_cursors) {
6755 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
6756 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
6758 *prev = mc->mc_next;
6765 mdb_cursor_txn(MDB_cursor *mc)
6767 if (!mc) return NULL;
6772 mdb_cursor_dbi(MDB_cursor *mc)
6778 /** Replace the key for a branch node with a new key.
6779 * @param[in] mc Cursor pointing to the node to operate on.
6780 * @param[in] key The new key to use.
6781 * @return 0 on success, non-zero on failure.
6784 mdb_update_key(MDB_cursor *mc, MDB_val *key)
6790 int delta, ksize, oksize;
6791 indx_t ptr, i, numkeys, indx;
6794 indx = mc->mc_ki[mc->mc_top];
6795 mp = mc->mc_pg[mc->mc_top];
6796 node = NODEPTR(mp, indx);
6797 ptr = mp->mp_ptrs[indx];
6801 char kbuf2[DKBUF_MAXKEYSIZE*2+1];
6802 k2.mv_data = NODEKEY(node);
6803 k2.mv_size = node->mn_ksize;
6804 DPRINTF(("update key %u (ofs %u) [%s] to [%s] on page %"Z"u",
6806 mdb_dkey(&k2, kbuf2),
6812 /* Sizes must be 2-byte aligned. */
6813 ksize = EVEN(key->mv_size);
6814 oksize = EVEN(node->mn_ksize);
6815 delta = ksize - oksize;
6817 /* Shift node contents if EVEN(key length) changed. */
6819 if (delta > 0 && SIZELEFT(mp) < delta) {
6821 /* not enough space left, do a delete and split */
6822 DPRINTF(("Not enough room, delta = %d, splitting...", delta));
6823 pgno = NODEPGNO(node);
6824 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
6825 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
6828 numkeys = NUMKEYS(mp);
6829 for (i = 0; i < numkeys; i++) {
6830 if (mp->mp_ptrs[i] <= ptr)
6831 mp->mp_ptrs[i] -= delta;
6834 base = (char *)mp + mp->mp_upper;
6835 len = ptr - mp->mp_upper + NODESIZE;
6836 memmove(base - delta, base, len);
6837 mp->mp_upper -= delta;
6839 node = NODEPTR(mp, indx);
6842 /* But even if no shift was needed, update ksize */
6843 if (node->mn_ksize != key->mv_size)
6844 node->mn_ksize = key->mv_size;
6847 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
6853 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
6855 /** Move a node from csrc to cdst.
6858 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
6865 unsigned short flags;
6869 /* Mark src and dst as dirty. */
6870 if ((rc = mdb_page_touch(csrc)) ||
6871 (rc = mdb_page_touch(cdst)))
6874 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6875 key.mv_size = csrc->mc_db->md_pad;
6876 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6878 data.mv_data = NULL;
6882 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
6883 assert(!((size_t)srcnode&1));
6884 srcpg = NODEPGNO(srcnode);
6885 flags = srcnode->mn_flags;
6886 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6887 unsigned int snum = csrc->mc_snum;
6889 /* must find the lowest key below src */
6890 mdb_page_search_lowest(csrc);
6891 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6892 key.mv_size = csrc->mc_db->md_pad;
6893 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6895 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6896 key.mv_size = NODEKSZ(s2);
6897 key.mv_data = NODEKEY(s2);
6899 csrc->mc_snum = snum--;
6900 csrc->mc_top = snum;
6902 key.mv_size = NODEKSZ(srcnode);
6903 key.mv_data = NODEKEY(srcnode);
6905 data.mv_size = NODEDSZ(srcnode);
6906 data.mv_data = NODEDATA(srcnode);
6908 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
6909 unsigned int snum = cdst->mc_snum;
6912 /* must find the lowest key below dst */
6913 mdb_page_search_lowest(cdst);
6914 if (IS_LEAF2(cdst->mc_pg[cdst->mc_top])) {
6915 bkey.mv_size = cdst->mc_db->md_pad;
6916 bkey.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, bkey.mv_size);
6918 s2 = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6919 bkey.mv_size = NODEKSZ(s2);
6920 bkey.mv_data = NODEKEY(s2);
6922 cdst->mc_snum = snum--;
6923 cdst->mc_top = snum;
6924 mdb_cursor_copy(cdst, &mn);
6926 rc = mdb_update_key(&mn, &bkey);
6931 DPRINTF(("moving %s node %u [%s] on page %"Z"u to node %u on page %"Z"u",
6932 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
6933 csrc->mc_ki[csrc->mc_top],
6935 csrc->mc_pg[csrc->mc_top]->mp_pgno,
6936 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno));
6938 /* Add the node to the destination page.
6940 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
6941 if (rc != MDB_SUCCESS)
6944 /* Delete the node from the source page.
6946 mdb_node_del(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6949 /* Adjust other cursors pointing to mp */
6950 MDB_cursor *m2, *m3;
6951 MDB_dbi dbi = csrc->mc_dbi;
6952 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
6954 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6955 if (csrc->mc_flags & C_SUB)
6956 m3 = &m2->mc_xcursor->mx_cursor;
6959 if (m3 == csrc) continue;
6960 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
6961 csrc->mc_ki[csrc->mc_top]) {
6962 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
6963 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
6968 /* Update the parent separators.
6970 if (csrc->mc_ki[csrc->mc_top] == 0) {
6971 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
6972 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6973 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6975 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6976 key.mv_size = NODEKSZ(srcnode);
6977 key.mv_data = NODEKEY(srcnode);
6979 DPRINTF(("update separator for source page %"Z"u to [%s]",
6980 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key)));
6981 mdb_cursor_copy(csrc, &mn);
6984 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6987 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6989 indx_t ix = csrc->mc_ki[csrc->mc_top];
6990 nullkey.mv_size = 0;
6991 csrc->mc_ki[csrc->mc_top] = 0;
6992 rc = mdb_update_key(csrc, &nullkey);
6993 csrc->mc_ki[csrc->mc_top] = ix;
6994 assert(rc == MDB_SUCCESS);
6998 if (cdst->mc_ki[cdst->mc_top] == 0) {
6999 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
7000 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7001 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
7003 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
7004 key.mv_size = NODEKSZ(srcnode);
7005 key.mv_data = NODEKEY(srcnode);
7007 DPRINTF(("update separator for destination page %"Z"u to [%s]",
7008 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key)));
7009 mdb_cursor_copy(cdst, &mn);
7012 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7015 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
7017 indx_t ix = cdst->mc_ki[cdst->mc_top];
7018 nullkey.mv_size = 0;
7019 cdst->mc_ki[cdst->mc_top] = 0;
7020 rc = mdb_update_key(cdst, &nullkey);
7021 cdst->mc_ki[cdst->mc_top] = ix;
7022 assert(rc == MDB_SUCCESS);
7029 /** Merge one page into another.
7030 * The nodes from the page pointed to by \b csrc will
7031 * be copied to the page pointed to by \b cdst and then
7032 * the \b csrc page will be freed.
7033 * @param[in] csrc Cursor pointing to the source page.
7034 * @param[in] cdst Cursor pointing to the destination page.
7037 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
7045 DPRINTF(("merging page %"Z"u into %"Z"u", csrc->mc_pg[csrc->mc_top]->mp_pgno,
7046 cdst->mc_pg[cdst->mc_top]->mp_pgno));
7048 assert(csrc->mc_snum > 1); /* can't merge root page */
7049 assert(cdst->mc_snum > 1);
7051 /* Mark dst as dirty. */
7052 if ((rc = mdb_page_touch(cdst)))
7055 /* Move all nodes from src to dst.
7057 j = nkeys = NUMKEYS(cdst->mc_pg[cdst->mc_top]);
7058 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7059 key.mv_size = csrc->mc_db->md_pad;
7060 key.mv_data = METADATA(csrc->mc_pg[csrc->mc_top]);
7061 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
7062 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
7063 if (rc != MDB_SUCCESS)
7065 key.mv_data = (char *)key.mv_data + key.mv_size;
7068 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
7069 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], i);
7070 if (i == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7071 unsigned int snum = csrc->mc_snum;
7073 /* must find the lowest key below src */
7074 mdb_page_search_lowest(csrc);
7075 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7076 key.mv_size = csrc->mc_db->md_pad;
7077 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7079 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7080 key.mv_size = NODEKSZ(s2);
7081 key.mv_data = NODEKEY(s2);
7083 csrc->mc_snum = snum--;
7084 csrc->mc_top = snum;
7086 key.mv_size = srcnode->mn_ksize;
7087 key.mv_data = NODEKEY(srcnode);
7090 data.mv_size = NODEDSZ(srcnode);
7091 data.mv_data = NODEDATA(srcnode);
7092 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
7093 if (rc != MDB_SUCCESS)
7098 DPRINTF(("dst page %"Z"u now has %u keys (%.1f%% filled)",
7099 cdst->mc_pg[cdst->mc_top]->mp_pgno, NUMKEYS(cdst->mc_pg[cdst->mc_top]),
7100 (float)PAGEFILL(cdst->mc_txn->mt_env, cdst->mc_pg[cdst->mc_top]) / 10));
7102 /* Unlink the src page from parent and add to free list.
7104 mdb_node_del(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1], 0);
7105 if (csrc->mc_ki[csrc->mc_top-1] == 0) {
7108 rc = mdb_update_key(csrc, &key);
7114 rc = mdb_midl_append(&csrc->mc_txn->mt_free_pgs,
7115 csrc->mc_pg[csrc->mc_top]->mp_pgno);
7118 if (IS_LEAF(csrc->mc_pg[csrc->mc_top]))
7119 csrc->mc_db->md_leaf_pages--;
7121 csrc->mc_db->md_branch_pages--;
7123 /* Adjust other cursors pointing to mp */
7124 MDB_cursor *m2, *m3;
7125 MDB_dbi dbi = csrc->mc_dbi;
7126 MDB_page *mp = cdst->mc_pg[cdst->mc_top];
7128 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7129 if (csrc->mc_flags & C_SUB)
7130 m3 = &m2->mc_xcursor->mx_cursor;
7133 if (m3 == csrc) continue;
7134 if (m3->mc_snum < csrc->mc_snum) continue;
7135 if (m3->mc_pg[csrc->mc_top] == csrc->mc_pg[csrc->mc_top]) {
7136 m3->mc_pg[csrc->mc_top] = mp;
7137 m3->mc_ki[csrc->mc_top] += nkeys;
7141 mdb_cursor_pop(csrc);
7143 return mdb_rebalance(csrc);
7146 /** Copy the contents of a cursor.
7147 * @param[in] csrc The cursor to copy from.
7148 * @param[out] cdst The cursor to copy to.
7151 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
7155 cdst->mc_txn = csrc->mc_txn;
7156 cdst->mc_dbi = csrc->mc_dbi;
7157 cdst->mc_db = csrc->mc_db;
7158 cdst->mc_dbx = csrc->mc_dbx;
7159 cdst->mc_snum = csrc->mc_snum;
7160 cdst->mc_top = csrc->mc_top;
7161 cdst->mc_flags = csrc->mc_flags;
7163 for (i=0; i<csrc->mc_snum; i++) {
7164 cdst->mc_pg[i] = csrc->mc_pg[i];
7165 cdst->mc_ki[i] = csrc->mc_ki[i];
7169 /** Rebalance the tree after a delete operation.
7170 * @param[in] mc Cursor pointing to the page where rebalancing
7172 * @return 0 on success, non-zero on failure.
7175 mdb_rebalance(MDB_cursor *mc)
7179 unsigned int ptop, minkeys;
7182 minkeys = 1 + (IS_BRANCH(mc->mc_pg[mc->mc_top]));
7186 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
7187 DPRINTF(("rebalancing %s page %"Z"u (has %u keys, %.1f%% full)",
7188 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
7189 pgno, NUMKEYS(mc->mc_pg[mc->mc_top]),
7190 (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10));
7194 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD &&
7195 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
7198 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
7199 DPRINTF(("no need to rebalance page %"Z"u, above fill threshold",
7205 if (mc->mc_snum < 2) {
7206 MDB_page *mp = mc->mc_pg[0];
7208 DPUTS("Can't rebalance a subpage, ignoring");
7211 if (NUMKEYS(mp) == 0) {
7212 DPUTS("tree is completely empty");
7213 mc->mc_db->md_root = P_INVALID;
7214 mc->mc_db->md_depth = 0;
7215 mc->mc_db->md_leaf_pages = 0;
7216 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7219 /* Adjust cursors pointing to mp */
7222 mc->mc_flags &= ~C_INITIALIZED;
7224 MDB_cursor *m2, *m3;
7225 MDB_dbi dbi = mc->mc_dbi;
7227 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7228 if (mc->mc_flags & C_SUB)
7229 m3 = &m2->mc_xcursor->mx_cursor;
7232 if (m3->mc_snum < mc->mc_snum) continue;
7233 if (m3->mc_pg[0] == mp) {
7236 m3->mc_flags &= ~C_INITIALIZED;
7240 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
7241 DPUTS("collapsing root page!");
7242 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7245 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
7246 rc = mdb_page_get(mc->mc_txn,mc->mc_db->md_root,&mc->mc_pg[0],NULL);
7249 mc->mc_db->md_depth--;
7250 mc->mc_db->md_branch_pages--;
7251 mc->mc_ki[0] = mc->mc_ki[1];
7253 /* Adjust other cursors pointing to mp */
7254 MDB_cursor *m2, *m3;
7255 MDB_dbi dbi = mc->mc_dbi;
7257 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7258 if (mc->mc_flags & C_SUB)
7259 m3 = &m2->mc_xcursor->mx_cursor;
7262 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
7263 if (m3->mc_pg[0] == mp) {
7267 for (i=0; i<m3->mc_snum; i++) {
7268 m3->mc_pg[i] = m3->mc_pg[i+1];
7269 m3->mc_ki[i] = m3->mc_ki[i+1];
7275 DPUTS("root page doesn't need rebalancing");
7279 /* The parent (branch page) must have at least 2 pointers,
7280 * otherwise the tree is invalid.
7282 ptop = mc->mc_top-1;
7283 assert(NUMKEYS(mc->mc_pg[ptop]) > 1);
7285 /* Leaf page fill factor is below the threshold.
7286 * Try to move keys from left or right neighbor, or
7287 * merge with a neighbor page.
7292 mdb_cursor_copy(mc, &mn);
7293 mn.mc_xcursor = NULL;
7295 if (mc->mc_ki[ptop] == 0) {
7296 /* We're the leftmost leaf in our parent.
7298 DPUTS("reading right neighbor");
7300 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
7301 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
7304 mn.mc_ki[mn.mc_top] = 0;
7305 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
7307 /* There is at least one neighbor to the left.
7309 DPUTS("reading left neighbor");
7311 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
7312 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
7315 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
7316 mc->mc_ki[mc->mc_top] = 0;
7319 DPRINTF(("found neighbor page %"Z"u (%u keys, %.1f%% full)",
7320 mn.mc_pg[mn.mc_top]->mp_pgno, NUMKEYS(mn.mc_pg[mn.mc_top]),
7321 (float)PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) / 10));
7323 /* If the neighbor page is above threshold and has enough keys,
7324 * move one key from it. Otherwise we should try to merge them.
7325 * (A branch page must never have less than 2 keys.)
7327 minkeys = 1 + (IS_BRANCH(mn.mc_pg[mn.mc_top]));
7328 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys)
7329 return mdb_node_move(&mn, mc);
7331 if (mc->mc_ki[ptop] == 0)
7332 rc = mdb_page_merge(&mn, mc);
7334 mn.mc_ki[mn.mc_top] += mc->mc_ki[mn.mc_top] + 1;
7335 rc = mdb_page_merge(mc, &mn);
7336 mdb_cursor_copy(&mn, mc);
7338 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
7343 /** Complete a delete operation started by #mdb_cursor_del(). */
7345 mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf)
7352 mp = mc->mc_pg[mc->mc_top];
7353 ki = mc->mc_ki[mc->mc_top];
7355 /* add overflow pages to free list */
7356 if (!IS_LEAF2(mp) && F_ISSET(leaf->mn_flags, F_BIGDATA)) {
7360 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
7361 if ((rc = mdb_page_get(mc->mc_txn, pg, &omp, NULL)) ||
7362 (rc = mdb_ovpage_free(mc, omp)))
7365 mdb_node_del(mp, ki, mc->mc_db->md_pad);
7366 mc->mc_db->md_entries--;
7367 rc = mdb_rebalance(mc);
7368 if (rc != MDB_SUCCESS)
7369 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
7372 MDB_dbi dbi = mc->mc_dbi;
7374 mp = mc->mc_pg[mc->mc_top];
7375 nkeys = NUMKEYS(mp);
7377 /* if mc points past last node in page, find next sibling */
7378 if (mc->mc_ki[mc->mc_top] >= nkeys)
7379 mdb_cursor_sibling(mc, 1);
7381 /* Adjust other cursors pointing to mp */
7382 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7383 if (m2 == mc || m2->mc_snum < mc->mc_snum)
7385 if (!(m2->mc_flags & C_INITIALIZED))
7387 if (m2->mc_pg[mc->mc_top] == mp) {
7388 if (m2->mc_ki[mc->mc_top] >= ki) {
7389 m2->mc_flags |= C_DEL;
7390 if (m2->mc_ki[mc->mc_top] > ki)
7391 m2->mc_ki[mc->mc_top]--;
7393 if (m2->mc_ki[mc->mc_top] >= nkeys)
7394 mdb_cursor_sibling(m2, 1);
7397 mc->mc_flags |= C_DEL;
7404 mdb_del(MDB_txn *txn, MDB_dbi dbi,
7405 MDB_val *key, MDB_val *data)
7410 MDB_val rdata, *xdata;
7414 assert(key != NULL);
7416 DPRINTF(("====> delete db %u key [%s]", dbi, DKEY(key)));
7418 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7421 if (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
7422 return (txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
7424 mdb_cursor_init(&mc, txn, dbi, &mx);
7427 if (!F_ISSET(txn->mt_dbs[dbi].md_flags, MDB_DUPSORT)) {
7428 /* must ignore any data */
7439 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
7441 /* let mdb_page_split know about this cursor if needed:
7442 * delete will trigger a rebalance; if it needs to move
7443 * a node from one page to another, it will have to
7444 * update the parent's separator key(s). If the new sepkey
7445 * is larger than the current one, the parent page may
7446 * run out of space, triggering a split. We need this
7447 * cursor to be consistent until the end of the rebalance.
7449 mc.mc_flags |= C_UNTRACK;
7450 mc.mc_next = txn->mt_cursors[dbi];
7451 txn->mt_cursors[dbi] = &mc;
7452 rc = mdb_cursor_del(&mc, data ? 0 : MDB_NODUPDATA);
7453 txn->mt_cursors[dbi] = mc.mc_next;
7458 /** Split a page and insert a new node.
7459 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
7460 * The cursor will be updated to point to the actual page and index where
7461 * the node got inserted after the split.
7462 * @param[in] newkey The key for the newly inserted node.
7463 * @param[in] newdata The data for the newly inserted node.
7464 * @param[in] newpgno The page number, if the new node is a branch node.
7465 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
7466 * @return 0 on success, non-zero on failure.
7469 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
7470 unsigned int nflags)
7473 int rc = MDB_SUCCESS, new_root = 0, did_split = 0;
7476 int i, j, split_indx, nkeys, pmax;
7477 MDB_env *env = mc->mc_txn->mt_env;
7479 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
7480 MDB_page *copy = NULL;
7481 MDB_page *mp, *rp, *pp;
7486 mp = mc->mc_pg[mc->mc_top];
7487 newindx = mc->mc_ki[mc->mc_top];
7488 nkeys = NUMKEYS(mp);
7490 DPRINTF(("-----> splitting %s page %"Z"u and adding [%s] at index %i/%i",
7491 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
7492 DKEY(newkey), mc->mc_ki[mc->mc_top], nkeys));
7494 /* Create a right sibling. */
7495 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
7497 DPRINTF(("new right sibling: page %"Z"u", rp->mp_pgno));
7499 if (mc->mc_snum < 2) {
7500 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
7502 /* shift current top to make room for new parent */
7503 mc->mc_pg[1] = mc->mc_pg[0];
7504 mc->mc_ki[1] = mc->mc_ki[0];
7507 mc->mc_db->md_root = pp->mp_pgno;
7508 DPRINTF(("root split! new root = %"Z"u", pp->mp_pgno));
7509 mc->mc_db->md_depth++;
7512 /* Add left (implicit) pointer. */
7513 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
7514 /* undo the pre-push */
7515 mc->mc_pg[0] = mc->mc_pg[1];
7516 mc->mc_ki[0] = mc->mc_ki[1];
7517 mc->mc_db->md_root = mp->mp_pgno;
7518 mc->mc_db->md_depth--;
7525 ptop = mc->mc_top-1;
7526 DPRINTF(("parent branch page is %"Z"u", mc->mc_pg[ptop]->mp_pgno));
7529 mc->mc_flags |= C_SPLITTING;
7530 mdb_cursor_copy(mc, &mn);
7531 mn.mc_pg[mn.mc_top] = rp;
7532 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
7534 if (nflags & MDB_APPEND) {
7535 mn.mc_ki[mn.mc_top] = 0;
7537 split_indx = newindx;
7541 split_indx = (nkeys+1) / 2;
7546 unsigned int lsize, rsize, ksize;
7547 /* Move half of the keys to the right sibling */
7549 x = mc->mc_ki[mc->mc_top] - split_indx;
7550 ksize = mc->mc_db->md_pad;
7551 split = LEAF2KEY(mp, split_indx, ksize);
7552 rsize = (nkeys - split_indx) * ksize;
7553 lsize = (nkeys - split_indx) * sizeof(indx_t);
7554 mp->mp_lower -= lsize;
7555 rp->mp_lower += lsize;
7556 mp->mp_upper += rsize - lsize;
7557 rp->mp_upper -= rsize - lsize;
7558 sepkey.mv_size = ksize;
7559 if (newindx == split_indx) {
7560 sepkey.mv_data = newkey->mv_data;
7562 sepkey.mv_data = split;
7565 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
7566 memcpy(rp->mp_ptrs, split, rsize);
7567 sepkey.mv_data = rp->mp_ptrs;
7568 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
7569 memcpy(ins, newkey->mv_data, ksize);
7570 mp->mp_lower += sizeof(indx_t);
7571 mp->mp_upper -= ksize - sizeof(indx_t);
7574 memcpy(rp->mp_ptrs, split, x * ksize);
7575 ins = LEAF2KEY(rp, x, ksize);
7576 memcpy(ins, newkey->mv_data, ksize);
7577 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
7578 rp->mp_lower += sizeof(indx_t);
7579 rp->mp_upper -= ksize - sizeof(indx_t);
7580 mc->mc_ki[mc->mc_top] = x;
7581 mc->mc_pg[mc->mc_top] = rp;
7584 int psize, nsize, k;
7585 /* Maximum free space in an empty page */
7586 pmax = env->me_psize - PAGEHDRSZ;
7588 nsize = mdb_leaf_size(env, newkey, newdata);
7590 nsize = mdb_branch_size(env, newkey);
7591 nsize = EVEN(nsize);
7593 /* grab a page to hold a temporary copy */
7594 copy = mdb_page_malloc(mc->mc_txn, 1);
7597 copy->mp_pgno = mp->mp_pgno;
7598 copy->mp_flags = mp->mp_flags;
7599 copy->mp_lower = PAGEHDRSZ;
7600 copy->mp_upper = env->me_psize;
7602 /* prepare to insert */
7603 for (i=0, j=0; i<nkeys; i++) {
7605 copy->mp_ptrs[j++] = 0;
7607 copy->mp_ptrs[j++] = mp->mp_ptrs[i];
7610 /* When items are relatively large the split point needs
7611 * to be checked, because being off-by-one will make the
7612 * difference between success or failure in mdb_node_add.
7614 * It's also relevant if a page happens to be laid out
7615 * such that one half of its nodes are all "small" and
7616 * the other half of its nodes are "large." If the new
7617 * item is also "large" and falls on the half with
7618 * "large" nodes, it also may not fit.
7620 * As a final tweak, if the new item goes on the last
7621 * spot on the page (and thus, onto the new page), bias
7622 * the split so the new page is emptier than the old page.
7623 * This yields better packing during sequential inserts.
7625 if (nkeys < 20 || nsize > pmax/16 || newindx >= nkeys) {
7626 /* Find split point */
7628 if (newindx <= split_indx || newindx >= nkeys) {
7630 k = newindx >= nkeys ? nkeys : split_indx+2;
7635 for (; i!=k; i+=j) {
7640 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i]);
7641 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
7643 if (F_ISSET(node->mn_flags, F_BIGDATA))
7644 psize += sizeof(pgno_t);
7646 psize += NODEDSZ(node);
7648 psize = EVEN(psize);
7650 if (psize > pmax || i == k-j) {
7651 split_indx = i + (j<0);
7656 if (split_indx == newindx) {
7657 sepkey.mv_size = newkey->mv_size;
7658 sepkey.mv_data = newkey->mv_data;
7660 node = (MDB_node *)((char *)mp + copy->mp_ptrs[split_indx]);
7661 sepkey.mv_size = node->mn_ksize;
7662 sepkey.mv_data = NODEKEY(node);
7667 DPRINTF(("separator is %d [%s]", split_indx, DKEY(&sepkey)));
7669 /* Copy separator key to the parent.
7671 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(env, &sepkey)) {
7675 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
7678 if (mn.mc_snum == mc->mc_snum) {
7679 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
7680 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
7681 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
7682 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
7687 /* Right page might now have changed parent.
7688 * Check if left page also changed parent.
7690 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
7691 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
7692 for (i=0; i<ptop; i++) {
7693 mc->mc_pg[i] = mn.mc_pg[i];
7694 mc->mc_ki[i] = mn.mc_ki[i];
7696 mc->mc_pg[ptop] = mn.mc_pg[ptop];
7697 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
7701 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
7704 mc->mc_flags ^= C_SPLITTING;
7705 if (rc != MDB_SUCCESS) {
7708 if (nflags & MDB_APPEND) {
7709 mc->mc_pg[mc->mc_top] = rp;
7710 mc->mc_ki[mc->mc_top] = 0;
7711 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
7714 for (i=0; i<mc->mc_top; i++)
7715 mc->mc_ki[i] = mn.mc_ki[i];
7716 } else if (!IS_LEAF2(mp)) {
7718 mc->mc_pg[mc->mc_top] = rp;
7723 rkey.mv_data = newkey->mv_data;
7724 rkey.mv_size = newkey->mv_size;
7730 /* Update index for the new key. */
7731 mc->mc_ki[mc->mc_top] = j;
7733 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i]);
7734 rkey.mv_data = NODEKEY(node);
7735 rkey.mv_size = node->mn_ksize;
7737 xdata.mv_data = NODEDATA(node);
7738 xdata.mv_size = NODEDSZ(node);
7741 pgno = NODEPGNO(node);
7742 flags = node->mn_flags;
7745 if (!IS_LEAF(mp) && j == 0) {
7746 /* First branch index doesn't need key data. */
7750 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
7752 /* return tmp page to freelist */
7753 mdb_page_free(env, copy);
7759 mc->mc_pg[mc->mc_top] = copy;
7764 } while (i != split_indx);
7766 nkeys = NUMKEYS(copy);
7767 for (i=0; i<nkeys; i++)
7768 mp->mp_ptrs[i] = copy->mp_ptrs[i];
7769 mp->mp_lower = copy->mp_lower;
7770 mp->mp_upper = copy->mp_upper;
7771 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
7772 env->me_psize - copy->mp_upper);
7774 /* reset back to original page */
7775 if (newindx < split_indx) {
7776 mc->mc_pg[mc->mc_top] = mp;
7777 if (nflags & MDB_RESERVE) {
7778 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
7779 if (!(node->mn_flags & F_BIGDATA))
7780 newdata->mv_data = NODEDATA(node);
7783 mc->mc_pg[mc->mc_top] = rp;
7785 /* Make sure mc_ki is still valid.
7787 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
7788 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
7789 for (i=0; i<ptop; i++) {
7790 mc->mc_pg[i] = mn.mc_pg[i];
7791 mc->mc_ki[i] = mn.mc_ki[i];
7793 mc->mc_pg[ptop] = mn.mc_pg[ptop];
7794 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
7797 /* return tmp page to freelist */
7798 mdb_page_free(env, copy);
7802 /* Adjust other cursors pointing to mp */
7803 MDB_cursor *m2, *m3;
7804 MDB_dbi dbi = mc->mc_dbi;
7805 int fixup = NUMKEYS(mp);
7807 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7808 if (mc->mc_flags & C_SUB)
7809 m3 = &m2->mc_xcursor->mx_cursor;
7814 if (!(m2->mc_flags & m3->mc_flags & C_INITIALIZED))
7816 if (m3->mc_flags & C_SPLITTING)
7821 for (k=m3->mc_top; k>=0; k--) {
7822 m3->mc_ki[k+1] = m3->mc_ki[k];
7823 m3->mc_pg[k+1] = m3->mc_pg[k];
7825 if (m3->mc_ki[0] >= split_indx) {
7830 m3->mc_pg[0] = mc->mc_pg[0];
7834 if (m3->mc_top >= mc->mc_top && m3->mc_pg[mc->mc_top] == mp) {
7835 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
7836 m3->mc_ki[mc->mc_top]++;
7837 if (m3->mc_ki[mc->mc_top] >= fixup) {
7838 m3->mc_pg[mc->mc_top] = rp;
7839 m3->mc_ki[mc->mc_top] -= fixup;
7840 m3->mc_ki[ptop] = mn.mc_ki[ptop];
7842 } else if (!did_split && m3->mc_top >= ptop && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
7843 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
7848 DPRINTF(("mp left: %d, rp left: %d", SIZELEFT(mp), SIZELEFT(rp)));
7853 mdb_put(MDB_txn *txn, MDB_dbi dbi,
7854 MDB_val *key, MDB_val *data, unsigned int flags)
7859 assert(key != NULL);
7860 assert(data != NULL);
7862 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7865 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP)) != flags)
7868 mdb_cursor_init(&mc, txn, dbi, &mx);
7869 return mdb_cursor_put(&mc, key, data, flags);
7873 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
7875 if ((flag & CHANGEABLE) != flag)
7878 env->me_flags |= flag;
7880 env->me_flags &= ~flag;
7885 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
7890 *arg = env->me_flags;
7895 mdb_env_get_path(MDB_env *env, const char **arg)
7900 *arg = env->me_path;
7905 mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *arg)
7914 /** Common code for #mdb_stat() and #mdb_env_stat().
7915 * @param[in] env the environment to operate in.
7916 * @param[in] db the #MDB_db record containing the stats to return.
7917 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
7918 * @return 0, this function always succeeds.
7921 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
7923 arg->ms_psize = env->me_psize;
7924 arg->ms_depth = db->md_depth;
7925 arg->ms_branch_pages = db->md_branch_pages;
7926 arg->ms_leaf_pages = db->md_leaf_pages;
7927 arg->ms_overflow_pages = db->md_overflow_pages;
7928 arg->ms_entries = db->md_entries;
7933 mdb_env_stat(MDB_env *env, MDB_stat *arg)
7937 if (env == NULL || arg == NULL)
7940 toggle = mdb_env_pick_meta(env);
7942 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
7946 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
7950 if (env == NULL || arg == NULL)
7953 toggle = mdb_env_pick_meta(env);
7954 arg->me_mapaddr = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : 0;
7955 arg->me_mapsize = env->me_mapsize;
7956 arg->me_maxreaders = env->me_maxreaders;
7958 /* me_numreaders may be zero if this process never used any readers. Use
7959 * the shared numreader count if it exists.
7961 arg->me_numreaders = env->me_txns ? env->me_txns->mti_numreaders : env->me_numreaders;
7963 arg->me_last_pgno = env->me_metas[toggle]->mm_last_pg;
7964 arg->me_last_txnid = env->me_metas[toggle]->mm_txnid;
7968 /** Set the default comparison functions for a database.
7969 * Called immediately after a database is opened to set the defaults.
7970 * The user can then override them with #mdb_set_compare() or
7971 * #mdb_set_dupsort().
7972 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
7973 * @param[in] dbi A database handle returned by #mdb_dbi_open()
7976 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
7978 uint16_t f = txn->mt_dbs[dbi].md_flags;
7980 txn->mt_dbxs[dbi].md_cmp =
7981 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
7982 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
7984 txn->mt_dbxs[dbi].md_dcmp =
7985 !(f & MDB_DUPSORT) ? 0 :
7986 ((f & MDB_INTEGERDUP)
7987 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
7988 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
7991 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
7996 int rc, dbflag, exact;
7997 unsigned int unused = 0;
8000 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
8001 mdb_default_cmp(txn, FREE_DBI);
8004 if ((flags & VALID_FLAGS) != flags)
8006 if (txn->mt_flags & MDB_TXN_ERROR)
8012 if (flags & PERSISTENT_FLAGS) {
8013 uint16_t f2 = flags & PERSISTENT_FLAGS;
8014 /* make sure flag changes get committed */
8015 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
8016 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
8017 txn->mt_flags |= MDB_TXN_DIRTY;
8020 mdb_default_cmp(txn, MAIN_DBI);
8024 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
8025 mdb_default_cmp(txn, MAIN_DBI);
8028 /* Is the DB already open? */
8030 for (i=2; i<txn->mt_numdbs; i++) {
8031 if (!txn->mt_dbxs[i].md_name.mv_size) {
8032 /* Remember this free slot */
8033 if (!unused) unused = i;
8036 if (len == txn->mt_dbxs[i].md_name.mv_size &&
8037 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
8043 /* If no free slot and max hit, fail */
8044 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
8045 return MDB_DBS_FULL;
8047 /* Cannot mix named databases with some mainDB flags */
8048 if (txn->mt_dbs[MAIN_DBI].md_flags & (MDB_DUPSORT|MDB_INTEGERKEY))
8049 return (flags & MDB_CREATE) ? MDB_INCOMPATIBLE : MDB_NOTFOUND;
8051 /* Find the DB info */
8052 dbflag = DB_NEW|DB_VALID;
8055 key.mv_data = (void *)name;
8056 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
8057 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
8058 if (rc == MDB_SUCCESS) {
8059 /* make sure this is actually a DB */
8060 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
8061 if (!(node->mn_flags & F_SUBDATA))
8062 return MDB_INCOMPATIBLE;
8063 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
8064 /* Create if requested */
8066 data.mv_size = sizeof(MDB_db);
8067 data.mv_data = &dummy;
8068 memset(&dummy, 0, sizeof(dummy));
8069 dummy.md_root = P_INVALID;
8070 dummy.md_flags = flags & PERSISTENT_FLAGS;
8071 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
8075 /* OK, got info, add to table */
8076 if (rc == MDB_SUCCESS) {
8077 unsigned int slot = unused ? unused : txn->mt_numdbs;
8078 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
8079 txn->mt_dbxs[slot].md_name.mv_size = len;
8080 txn->mt_dbxs[slot].md_rel = NULL;
8081 txn->mt_dbflags[slot] = dbflag;
8082 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
8084 mdb_default_cmp(txn, slot);
8093 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
8095 if (txn == NULL || arg == NULL || dbi >= txn->mt_numdbs)
8098 if (txn->mt_dbflags[dbi] & DB_STALE) {
8101 /* Stale, must read the DB's root. cursor_init does it for us. */
8102 mdb_cursor_init(&mc, txn, dbi, &mx);
8104 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
8107 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
8110 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
8112 ptr = env->me_dbxs[dbi].md_name.mv_data;
8113 env->me_dbxs[dbi].md_name.mv_data = NULL;
8114 env->me_dbxs[dbi].md_name.mv_size = 0;
8115 env->me_dbflags[dbi] = 0;
8119 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags)
8121 /* We could return the flags for the FREE_DBI too but what's the point? */
8122 if (txn == NULL || dbi < MAIN_DBI || dbi >= txn->mt_numdbs)
8124 *flags = txn->mt_dbs[dbi].md_flags & PERSISTENT_FLAGS;
8128 /** Add all the DB's pages to the free list.
8129 * @param[in] mc Cursor on the DB to free.
8130 * @param[in] subs non-Zero to check for sub-DBs in this DB.
8131 * @return 0 on success, non-zero on failure.
8134 mdb_drop0(MDB_cursor *mc, int subs)
8138 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
8139 if (rc == MDB_SUCCESS) {
8140 MDB_txn *txn = mc->mc_txn;
8145 /* LEAF2 pages have no nodes, cannot have sub-DBs */
8146 if (IS_LEAF2(mc->mc_pg[mc->mc_top]))
8149 mdb_cursor_copy(mc, &mx);
8150 while (mc->mc_snum > 0) {
8151 MDB_page *mp = mc->mc_pg[mc->mc_top];
8152 unsigned n = NUMKEYS(mp);
8154 for (i=0; i<n; i++) {
8155 ni = NODEPTR(mp, i);
8156 if (ni->mn_flags & F_BIGDATA) {
8159 memcpy(&pg, NODEDATA(ni), sizeof(pg));
8160 rc = mdb_page_get(txn, pg, &omp, NULL);
8163 assert(IS_OVERFLOW(omp));
8164 rc = mdb_midl_append_range(&txn->mt_free_pgs,
8168 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
8169 mdb_xcursor_init1(mc, ni);
8170 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
8176 if ((rc = mdb_midl_need(&txn->mt_free_pgs, n)) != 0)
8178 for (i=0; i<n; i++) {
8180 ni = NODEPTR(mp, i);
8183 mdb_midl_xappend(txn->mt_free_pgs, pg);
8188 mc->mc_ki[mc->mc_top] = i;
8189 rc = mdb_cursor_sibling(mc, 1);
8191 /* no more siblings, go back to beginning
8192 * of previous level.
8196 for (i=1; i<mc->mc_snum; i++) {
8198 mc->mc_pg[i] = mx.mc_pg[i];
8203 rc = mdb_midl_append(&txn->mt_free_pgs, mc->mc_db->md_root);
8204 } else if (rc == MDB_NOTFOUND) {
8210 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
8212 MDB_cursor *mc, *m2;
8215 if (!txn || !dbi || dbi >= txn->mt_numdbs || (unsigned)del > 1 || !(txn->mt_dbflags[dbi] & DB_VALID))
8218 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
8221 rc = mdb_cursor_open(txn, dbi, &mc);
8225 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
8226 /* Invalidate the dropped DB's cursors */
8227 for (m2 = txn->mt_cursors[dbi]; m2; m2 = m2->mc_next)
8228 m2->mc_flags &= ~(C_INITIALIZED|C_EOF);
8232 /* Can't delete the main DB */
8233 if (del && dbi > MAIN_DBI) {
8234 rc = mdb_del(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL);
8236 txn->mt_dbflags[dbi] = DB_STALE;
8237 mdb_dbi_close(txn->mt_env, dbi);
8240 /* reset the DB record, mark it dirty */
8241 txn->mt_dbflags[dbi] |= DB_DIRTY;
8242 txn->mt_dbs[dbi].md_depth = 0;
8243 txn->mt_dbs[dbi].md_branch_pages = 0;
8244 txn->mt_dbs[dbi].md_leaf_pages = 0;
8245 txn->mt_dbs[dbi].md_overflow_pages = 0;
8246 txn->mt_dbs[dbi].md_entries = 0;
8247 txn->mt_dbs[dbi].md_root = P_INVALID;
8249 txn->mt_flags |= MDB_TXN_DIRTY;
8252 mdb_cursor_close(mc);
8256 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
8258 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
8261 txn->mt_dbxs[dbi].md_cmp = cmp;
8265 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
8267 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
8270 txn->mt_dbxs[dbi].md_dcmp = cmp;
8274 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
8276 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
8279 txn->mt_dbxs[dbi].md_rel = rel;
8283 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
8285 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
8288 txn->mt_dbxs[dbi].md_relctx = ctx;
8292 int mdb_env_get_maxkeysize(MDB_env *env)
8294 return ENV_MAXKEY(env);
8297 int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx)
8299 unsigned int i, rdrs;
8302 int rc = 0, first = 1;
8306 if (!env->me_txns) {
8307 return func("(no reader locks)\n", ctx);
8309 rdrs = env->me_txns->mti_numreaders;
8310 mr = env->me_txns->mti_readers;
8311 for (i=0; i<rdrs; i++) {
8315 if (mr[i].mr_txnid == (txnid_t)-1) {
8316 sprintf(buf, "%10d %"Z"x -\n", mr[i].mr_pid, tid);
8318 sprintf(buf, "%10d %"Z"x %"Z"u\n", mr[i].mr_pid, tid, mr[i].mr_txnid);
8322 rc = func(" pid thread txnid\n", ctx);
8326 rc = func(buf, ctx);
8332 rc = func("(no active readers)\n", ctx);
8337 /** Insert pid into list if not already present.
8338 * return -1 if already present.
8340 static int mdb_pid_insert(MDB_PID_T *ids, MDB_PID_T pid)
8342 /* binary search of pid in list */
8344 unsigned cursor = 1;
8346 unsigned n = ids[0];
8349 unsigned pivot = n >> 1;
8350 cursor = base + pivot + 1;
8351 val = pid - ids[cursor];
8356 } else if ( val > 0 ) {
8361 /* found, so it's a duplicate */
8370 for (n = ids[0]; n > cursor; n--)
8376 int mdb_reader_check(MDB_env *env, int *dead)
8378 unsigned int i, j, rdrs;
8380 MDB_PID_T *pids, pid;
8389 rdrs = env->me_txns->mti_numreaders;
8390 pids = malloc((rdrs+1) * sizeof(MDB_PID_T));
8394 mr = env->me_txns->mti_readers;
8395 for (i=0; i<rdrs; i++) {
8396 if (mr[i].mr_pid && mr[i].mr_pid != env->me_pid) {
8398 if (mdb_pid_insert(pids, pid) == 0) {
8399 if (!mdb_reader_pid(env, Pidcheck, pid)) {
8401 /* Recheck, a new process may have reused pid */
8402 if (!mdb_reader_pid(env, Pidcheck, pid)) {
8403 for (j=i; j<rdrs; j++)
8404 if (mr[j].mr_pid == pid) {
8405 DPRINTF(("clear stale reader pid %u txn %"Z"d",
8406 (unsigned) pid, mr[j].mr_txnid));
8411 UNLOCK_MUTEX_R(env);
projects / openldap / blob