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.
36 #include <sys/types.h>
38 #include <sys/param.h>
44 #ifdef HAVE_SYS_FILE_H
61 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
62 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
65 #if defined(__APPLE__) || defined (BSD)
66 # define MDB_USE_POSIX_SEM 1
67 # define MDB_FDATASYNC fsync
68 #elif defined(ANDROID)
69 # define MDB_FDATASYNC fsync
74 #ifdef MDB_USE_POSIX_SEM
75 #include <semaphore.h>
80 #include <valgrind/memcheck.h>
81 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
82 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
83 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
84 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
85 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
87 #define VGMEMP_CREATE(h,r,z)
88 #define VGMEMP_ALLOC(h,a,s)
89 #define VGMEMP_FREE(h,a)
90 #define VGMEMP_DESTROY(h)
91 #define VGMEMP_DEFINED(a,s)
95 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
96 /* Solaris just defines one or the other */
97 # define LITTLE_ENDIAN 1234
98 # define BIG_ENDIAN 4321
99 # ifdef _LITTLE_ENDIAN
100 # define BYTE_ORDER LITTLE_ENDIAN
102 # define BYTE_ORDER BIG_ENDIAN
105 # define BYTE_ORDER __BYTE_ORDER
109 #ifndef LITTLE_ENDIAN
110 #define LITTLE_ENDIAN __LITTLE_ENDIAN
113 #define BIG_ENDIAN __BIG_ENDIAN
116 #if defined(__i386) || defined(__x86_64)
117 #define MISALIGNED_OK 1
123 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
124 # error "Unknown or unsupported endianness (BYTE_ORDER)"
125 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
126 # error "Two's complement, reasonably sized integer types, please"
129 /** @defgroup internal MDB Internals
132 /** @defgroup compat Windows Compatibility Macros
133 * A bunch of macros to minimize the amount of platform-specific ifdefs
134 * needed throughout the rest of the code. When the features this library
135 * needs are similar enough to POSIX to be hidden in a one-or-two line
136 * replacement, this macro approach is used.
140 #define pthread_t DWORD
141 #define pthread_mutex_t HANDLE
142 #define pthread_key_t DWORD
143 #define pthread_self() GetCurrentThreadId()
144 #define pthread_key_create(x,y) \
145 ((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
146 #define pthread_key_delete(x) TlsFree(x)
147 #define pthread_getspecific(x) TlsGetValue(x)
148 #define pthread_setspecific(x,y) (TlsSetValue(x,y) ? 0 : ErrCode())
149 #define pthread_mutex_unlock(x) ReleaseMutex(x)
150 #define pthread_mutex_lock(x) WaitForSingleObject(x, INFINITE)
151 #define LOCK_MUTEX_R(env) pthread_mutex_lock((env)->me_rmutex)
152 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock((env)->me_rmutex)
153 #define LOCK_MUTEX_W(env) pthread_mutex_lock((env)->me_wmutex)
154 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock((env)->me_wmutex)
155 #define getpid() GetCurrentProcessId()
156 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
157 #define MDB_MSYNC(addr,len,flags) (!FlushViewOfFile(addr,len))
158 #define ErrCode() GetLastError()
159 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
160 #define close(fd) CloseHandle(fd)
161 #define munmap(ptr,len) UnmapViewOfFile(ptr)
164 #ifdef MDB_USE_POSIX_SEM
166 #define LOCK_MUTEX_R(env) mdb_sem_wait((env)->me_rmutex)
167 #define UNLOCK_MUTEX_R(env) sem_post((env)->me_rmutex)
168 #define LOCK_MUTEX_W(env) mdb_sem_wait((env)->me_wmutex)
169 #define UNLOCK_MUTEX_W(env) sem_post((env)->me_wmutex)
172 mdb_sem_wait(sem_t *sem)
175 while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
180 /** Lock the reader mutex.
182 #define LOCK_MUTEX_R(env) pthread_mutex_lock(&(env)->me_txns->mti_mutex)
183 /** Unlock the reader mutex.
185 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
187 /** Lock the writer mutex.
188 * Only a single write transaction is allowed at a time. Other writers
189 * will block waiting for this mutex.
191 #define LOCK_MUTEX_W(env) pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
192 /** Unlock the writer mutex.
194 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
195 #endif /* MDB_USE_POSIX_SEM */
197 /** Get the error code for the last failed system function.
199 #define ErrCode() errno
201 /** An abstraction for a file handle.
202 * On POSIX systems file handles are small integers. On Windows
203 * they're opaque pointers.
207 /** A value for an invalid file handle.
208 * Mainly used to initialize file variables and signify that they are
211 #define INVALID_HANDLE_VALUE (-1)
213 /** Get the size of a memory page for the system.
214 * This is the basic size that the platform's memory manager uses, and is
215 * fundamental to the use of memory-mapped files.
217 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
220 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
223 #define MNAME_LEN (sizeof(pthread_mutex_t))
229 /** A flag for opening a file and requesting synchronous data writes.
230 * This is only used when writing a meta page. It's not strictly needed;
231 * we could just do a normal write and then immediately perform a flush.
232 * But if this flag is available it saves us an extra system call.
234 * @note If O_DSYNC is undefined but exists in /usr/include,
235 * preferably set some compiler flag to get the definition.
236 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
239 # define MDB_DSYNC O_DSYNC
243 /** Function for flushing the data of a file. Define this to fsync
244 * if fdatasync() is not supported.
246 #ifndef MDB_FDATASYNC
247 # define MDB_FDATASYNC fdatasync
251 # define MDB_MSYNC(addr,len,flags) msync(addr,len,flags)
262 /** A page number in the database.
263 * Note that 64 bit page numbers are overkill, since pages themselves
264 * already represent 12-13 bits of addressable memory, and the OS will
265 * always limit applications to a maximum of 63 bits of address space.
267 * @note In the #MDB_node structure, we only store 48 bits of this value,
268 * which thus limits us to only 60 bits of addressable data.
270 typedef MDB_ID pgno_t;
272 /** A transaction ID.
273 * See struct MDB_txn.mt_txnid for details.
275 typedef MDB_ID txnid_t;
277 /** @defgroup debug Debug Macros
281 /** Enable debug output.
282 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
283 * read from and written to the database (used for free space management).
288 #if !(__STDC_VERSION__ >= 199901L || defined(__GNUC__))
291 # define DPRINTF (void) /* Vararg macros may be unsupported */
293 static int mdb_debug;
294 static txnid_t mdb_debug_start;
296 /** Print a debug message with printf formatting. */
297 # define DPRINTF(fmt, ...) /**< Requires 2 or more args */ \
298 ((void) ((mdb_debug) && \
299 fprintf(stderr, "%s:%d " fmt "\n", __func__, __LINE__, __VA_ARGS__)))
301 # define DPRINTF(fmt, ...) ((void) 0)
302 # define MDB_DEBUG_SKIP
304 /** Print a debug string.
305 * The string is printed literally, with no format processing.
307 #define DPUTS(arg) DPRINTF("%s", arg)
310 /** A default memory page size.
311 * The actual size is platform-dependent, but we use this for
312 * boot-strapping. We probably should not be using this any more.
313 * The #GET_PAGESIZE() macro is used to get the actual size.
315 * Note that we don't currently support Huge pages. On Linux,
316 * regular data files cannot use Huge pages, and in general
317 * Huge pages aren't actually pageable. We rely on the OS
318 * demand-pager to read our data and page it out when memory
319 * pressure from other processes is high. So until OSs have
320 * actual paging support for Huge pages, they're not viable.
322 #define MDB_PAGESIZE 4096
324 /** The minimum number of keys required in a database page.
325 * Setting this to a larger value will place a smaller bound on the
326 * maximum size of a data item. Data items larger than this size will
327 * be pushed into overflow pages instead of being stored directly in
328 * the B-tree node. This value used to default to 4. With a page size
329 * of 4096 bytes that meant that any item larger than 1024 bytes would
330 * go into an overflow page. That also meant that on average 2-3KB of
331 * each overflow page was wasted space. The value cannot be lower than
332 * 2 because then there would no longer be a tree structure. With this
333 * value, items larger than 2KB will go into overflow pages, and on
334 * average only 1KB will be wasted.
336 #define MDB_MINKEYS 2
338 /** A stamp that identifies a file as an MDB file.
339 * There's nothing special about this value other than that it is easily
340 * recognizable, and it will reflect any byte order mismatches.
342 #define MDB_MAGIC 0xBEEFC0DE
344 /** The version number for a database's file format. */
345 #define MDB_VERSION 1
347 /** @brief The maximum size of a key in the database.
349 * We require that keys all fit onto a regular page. This limit
350 * could be raised a bit further if needed; to something just
351 * under #MDB_PAGESIZE / #MDB_MINKEYS.
353 * Note that data items in an #MDB_DUPSORT database are actually keys
354 * of a subDB, so they're also limited to this size.
356 #ifndef MDB_MAXKEYSIZE
357 #define MDB_MAXKEYSIZE 511
360 /** @brief The maximum size of a data item.
362 * We only store a 32 bit value for node sizes.
364 #define MAXDATASIZE 0xffffffffUL
369 * This is used for printing a hex dump of a key's contents.
371 #define DKBUF char kbuf[(MDB_MAXKEYSIZE*2+1)]
372 /** Display a key in hex.
374 * Invoke a function to display a key in hex.
376 #define DKEY(x) mdb_dkey(x, kbuf)
378 #define DKBUF typedef int dummy_kbuf /* so we can put ';' after */
382 /** An invalid page number.
383 * Mainly used to denote an empty tree.
385 #define P_INVALID (~(pgno_t)0)
387 /** Test if the flags \b f are set in a flag word \b w. */
388 #define F_ISSET(w, f) (((w) & (f)) == (f))
390 /** Used for offsets within a single page.
391 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
394 typedef uint16_t indx_t;
396 /** Default size of memory map.
397 * This is certainly too small for any actual applications. Apps should always set
398 * the size explicitly using #mdb_env_set_mapsize().
400 #define DEFAULT_MAPSIZE 1048576
402 /** @defgroup readers Reader Lock Table
403 * Readers don't acquire any locks for their data access. Instead, they
404 * simply record their transaction ID in the reader table. The reader
405 * mutex is needed just to find an empty slot in the reader table. The
406 * slot's address is saved in thread-specific data so that subsequent read
407 * transactions started by the same thread need no further locking to proceed.
409 * If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
411 * No reader table is used if the database is on a read-only filesystem.
413 * Since the database uses multi-version concurrency control, readers don't
414 * actually need any locking. This table is used to keep track of which
415 * readers are using data from which old transactions, so that we'll know
416 * when a particular old transaction is no longer in use. Old transactions
417 * that have discarded any data pages can then have those pages reclaimed
418 * for use by a later write transaction.
420 * The lock table is constructed such that reader slots are aligned with the
421 * processor's cache line size. Any slot is only ever used by one thread.
422 * This alignment guarantees that there will be no contention or cache
423 * thrashing as threads update their own slot info, and also eliminates
424 * any need for locking when accessing a slot.
426 * A writer thread will scan every slot in the table to determine the oldest
427 * outstanding reader transaction. Any freed pages older than this will be
428 * reclaimed by the writer. The writer doesn't use any locks when scanning
429 * this table. This means that there's no guarantee that the writer will
430 * see the most up-to-date reader info, but that's not required for correct
431 * operation - all we need is to know the upper bound on the oldest reader,
432 * we don't care at all about the newest reader. So the only consequence of
433 * reading stale information here is that old pages might hang around a
434 * while longer before being reclaimed. That's actually good anyway, because
435 * the longer we delay reclaiming old pages, the more likely it is that a
436 * string of contiguous pages can be found after coalescing old pages from
437 * many old transactions together.
440 /** Number of slots in the reader table.
441 * This value was chosen somewhat arbitrarily. 126 readers plus a
442 * couple mutexes fit exactly into 8KB on my development machine.
443 * Applications should set the table size using #mdb_env_set_maxreaders().
445 #define DEFAULT_READERS 126
447 /** The size of a CPU cache line in bytes. We want our lock structures
448 * aligned to this size to avoid false cache line sharing in the
450 * This value works for most CPUs. For Itanium this should be 128.
456 /** The information we store in a single slot of the reader table.
457 * In addition to a transaction ID, we also record the process and
458 * thread ID that owns a slot, so that we can detect stale information,
459 * e.g. threads or processes that went away without cleaning up.
460 * @note We currently don't check for stale records. We simply re-init
461 * the table when we know that we're the only process opening the
464 typedef struct MDB_rxbody {
465 /** Current Transaction ID when this transaction began, or (txnid_t)-1.
466 * Multiple readers that start at the same time will probably have the
467 * same ID here. Again, it's not important to exclude them from
468 * anything; all we need to know is which version of the DB they
469 * started from so we can avoid overwriting any data used in that
470 * particular version.
473 /** The process ID of the process owning this reader txn. */
475 /** The thread ID of the thread owning this txn. */
479 /** The actual reader record, with cacheline padding. */
480 typedef struct MDB_reader {
483 /** shorthand for mrb_txnid */
484 #define mr_txnid mru.mrx.mrb_txnid
485 #define mr_pid mru.mrx.mrb_pid
486 #define mr_tid mru.mrx.mrb_tid
487 /** cache line alignment */
488 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
492 /** The header for the reader table.
493 * The table resides in a memory-mapped file. (This is a different file
494 * than is used for the main database.)
496 * For POSIX the actual mutexes reside in the shared memory of this
497 * mapped file. On Windows, mutexes are named objects allocated by the
498 * kernel; we store the mutex names in this mapped file so that other
499 * processes can grab them. This same approach is also used on
500 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
501 * process-shared POSIX mutexes. For these cases where a named object
502 * is used, the object name is derived from a 64 bit FNV hash of the
503 * environment pathname. As such, naming collisions are extremely
504 * unlikely. If a collision occurs, the results are unpredictable.
506 typedef struct MDB_txbody {
507 /** Stamp identifying this as an MDB file. It must be set
510 /** Version number of this lock file. Must be set to #MDB_VERSION. */
511 uint32_t mtb_version;
512 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
513 char mtb_rmname[MNAME_LEN];
515 /** Mutex protecting access to this table.
516 * This is the reader lock that #LOCK_MUTEX_R acquires.
518 pthread_mutex_t mtb_mutex;
520 /** The ID of the last transaction committed to the database.
521 * This is recorded here only for convenience; the value can always
522 * be determined by reading the main database meta pages.
525 /** The number of slots that have been used in the reader table.
526 * This always records the maximum count, it is not decremented
527 * when readers release their slots.
529 unsigned mtb_numreaders;
532 /** The actual reader table definition. */
533 typedef struct MDB_txninfo {
536 #define mti_magic mt1.mtb.mtb_magic
537 #define mti_version mt1.mtb.mtb_version
538 #define mti_mutex mt1.mtb.mtb_mutex
539 #define mti_rmname mt1.mtb.mtb_rmname
540 #define mti_txnid mt1.mtb.mtb_txnid
541 #define mti_numreaders mt1.mtb.mtb_numreaders
542 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
545 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
546 char mt2_wmname[MNAME_LEN];
547 #define mti_wmname mt2.mt2_wmname
549 pthread_mutex_t mt2_wmutex;
550 #define mti_wmutex mt2.mt2_wmutex
552 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
554 MDB_reader mti_readers[1];
558 /** Common header for all page types.
559 * Overflow records occupy a number of contiguous pages with no
560 * headers on any page after the first.
562 typedef struct MDB_page {
563 #define mp_pgno mp_p.p_pgno
564 #define mp_next mp_p.p_next
566 pgno_t p_pgno; /**< page number */
567 void * p_next; /**< for in-memory list of freed structs */
570 /** @defgroup mdb_page Page Flags
572 * Flags for the page headers.
575 #define P_BRANCH 0x01 /**< branch page */
576 #define P_LEAF 0x02 /**< leaf page */
577 #define P_OVERFLOW 0x04 /**< overflow page */
578 #define P_META 0x08 /**< meta page */
579 #define P_DIRTY 0x10 /**< dirty page */
580 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
581 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
583 uint16_t mp_flags; /**< @ref mdb_page */
584 #define mp_lower mp_pb.pb.pb_lower
585 #define mp_upper mp_pb.pb.pb_upper
586 #define mp_pages mp_pb.pb_pages
589 indx_t pb_lower; /**< lower bound of free space */
590 indx_t pb_upper; /**< upper bound of free space */
592 uint32_t pb_pages; /**< number of overflow pages */
594 indx_t mp_ptrs[1]; /**< dynamic size */
597 /** Size of the page header, excluding dynamic data at the end */
598 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
600 /** Address of first usable data byte in a page, after the header */
601 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
603 /** Number of nodes on a page */
604 #define NUMKEYS(p) (((p)->mp_lower - PAGEHDRSZ) >> 1)
606 /** The amount of space remaining in the page */
607 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
609 /** The percentage of space used in the page, in tenths of a percent. */
610 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
611 ((env)->me_psize - PAGEHDRSZ))
612 /** The minimum page fill factor, in tenths of a percent.
613 * Pages emptier than this are candidates for merging.
615 #define FILL_THRESHOLD 250
617 /** Test if a page is a leaf page */
618 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
619 /** Test if a page is a LEAF2 page */
620 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
621 /** Test if a page is a branch page */
622 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
623 /** Test if a page is an overflow page */
624 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
625 /** Test if a page is a sub page */
626 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
628 /** The number of overflow pages needed to store the given size. */
629 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
631 /** Header for a single key/data pair within a page.
632 * We guarantee 2-byte alignment for nodes.
634 typedef struct MDB_node {
635 /** lo and hi are used for data size on leaf nodes and for
636 * child pgno on branch nodes. On 64 bit platforms, flags
637 * is also used for pgno. (Branch nodes have no flags).
638 * They are in host byte order in case that lets some
639 * accesses be optimized into a 32-bit word access.
641 #define mn_lo mn_offset[BYTE_ORDER!=LITTLE_ENDIAN]
642 #define mn_hi mn_offset[BYTE_ORDER==LITTLE_ENDIAN] /**< part of dsize or pgno */
643 unsigned short mn_offset[2]; /**< storage for #mn_lo and #mn_hi */
644 /** @defgroup mdb_node Node Flags
646 * Flags for node headers.
649 #define F_BIGDATA 0x01 /**< data put on overflow page */
650 #define F_SUBDATA 0x02 /**< data is a sub-database */
651 #define F_DUPDATA 0x04 /**< data has duplicates */
653 /** valid flags for #mdb_node_add() */
654 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
657 unsigned short mn_flags; /**< @ref mdb_node */
658 unsigned short mn_ksize; /**< key size */
659 char mn_data[1]; /**< key and data are appended here */
662 /** Size of the node header, excluding dynamic data at the end */
663 #define NODESIZE offsetof(MDB_node, mn_data)
665 /** Bit position of top word in page number, for shifting mn_flags */
666 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
668 /** Size of a node in a branch page with a given key.
669 * This is just the node header plus the key, there is no data.
671 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
673 /** Size of a node in a leaf page with a given key and data.
674 * This is node header plus key plus data size.
676 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
678 /** Address of node \b i in page \b p */
679 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i]))
681 /** Address of the key for the node */
682 #define NODEKEY(node) (void *)((node)->mn_data)
684 /** Address of the data for a node */
685 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
687 /** Get the page number pointed to by a branch node */
688 #define NODEPGNO(node) \
689 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
690 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
691 /** Set the page number in a branch node */
692 #define SETPGNO(node,pgno) do { \
693 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
694 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
696 /** Get the size of the data in a leaf node */
697 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
698 /** Set the size of the data for a leaf node */
699 #define SETDSZ(node,size) do { \
700 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
701 /** The size of a key in a node */
702 #define NODEKSZ(node) ((node)->mn_ksize)
704 /** Copy a page number from src to dst */
706 #define COPY_PGNO(dst,src) dst = src
708 #if SIZE_MAX > 4294967295UL
709 #define COPY_PGNO(dst,src) do { \
710 unsigned short *s, *d; \
711 s = (unsigned short *)&(src); \
712 d = (unsigned short *)&(dst); \
719 #define COPY_PGNO(dst,src) do { \
720 unsigned short *s, *d; \
721 s = (unsigned short *)&(src); \
722 d = (unsigned short *)&(dst); \
728 /** The address of a key in a LEAF2 page.
729 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
730 * There are no node headers, keys are stored contiguously.
732 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
734 /** Set the \b node's key into \b key, if requested. */
735 #define MDB_GET_KEY(node, key) { if ((key) != NULL) { \
736 (key)->mv_size = NODEKSZ(node); (key)->mv_data = NODEKEY(node); } }
738 /** Information about a single database in the environment. */
739 typedef struct MDB_db {
740 uint32_t md_pad; /**< also ksize for LEAF2 pages */
741 uint16_t md_flags; /**< @ref mdb_dbi_open */
742 uint16_t md_depth; /**< depth of this tree */
743 pgno_t md_branch_pages; /**< number of internal pages */
744 pgno_t md_leaf_pages; /**< number of leaf pages */
745 pgno_t md_overflow_pages; /**< number of overflow pages */
746 size_t md_entries; /**< number of data items */
747 pgno_t md_root; /**< the root page of this tree */
750 /** mdb_dbi_open flags */
751 #define MDB_VALID 0x8000 /**< DB handle is valid, for me_dbflags */
752 #define PERSISTENT_FLAGS (0xffff & ~(MDB_VALID))
753 #define VALID_FLAGS (MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
754 MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)
756 /** Handle for the DB used to track free pages. */
758 /** Handle for the default DB. */
761 /** Meta page content. */
762 typedef struct MDB_meta {
763 /** Stamp identifying this as an MDB file. It must be set
766 /** Version number of this lock file. Must be set to #MDB_VERSION. */
768 void *mm_address; /**< address for fixed mapping */
769 size_t mm_mapsize; /**< size of mmap region */
770 MDB_db mm_dbs[2]; /**< first is free space, 2nd is main db */
771 /** The size of pages used in this DB */
772 #define mm_psize mm_dbs[0].md_pad
773 /** Any persistent environment flags. @ref mdb_env */
774 #define mm_flags mm_dbs[0].md_flags
775 pgno_t mm_last_pg; /**< last used page in file */
776 txnid_t mm_txnid; /**< txnid that committed this page */
779 /** Buffer for a stack-allocated dirty page.
780 * The members define size and alignment, and silence type
781 * aliasing warnings. They are not used directly; that could
782 * mean incorrectly using several union members in parallel.
784 typedef union MDB_pagebuf {
785 char mb_raw[MDB_PAGESIZE];
788 char mm_pad[PAGEHDRSZ];
793 /** Auxiliary DB info.
794 * The information here is mostly static/read-only. There is
795 * only a single copy of this record in the environment.
797 typedef struct MDB_dbx {
798 MDB_val md_name; /**< name of the database */
799 MDB_cmp_func *md_cmp; /**< function for comparing keys */
800 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
801 MDB_rel_func *md_rel; /**< user relocate function */
802 void *md_relctx; /**< user-provided context for md_rel */
805 /** A database transaction.
806 * Every operation requires a transaction handle.
809 MDB_txn *mt_parent; /**< parent of a nested txn */
810 MDB_txn *mt_child; /**< nested txn under this txn */
811 pgno_t mt_next_pgno; /**< next unallocated page */
812 /** The ID of this transaction. IDs are integers incrementing from 1.
813 * Only committed write transactions increment the ID. If a transaction
814 * aborts, the ID may be re-used by the next writer.
817 MDB_env *mt_env; /**< the DB environment */
818 /** The list of pages that became unused during this transaction.
822 MDB_ID2L dirty_list; /**< for write txns: modified pages */
823 MDB_reader *reader; /**< this thread's reader table slot or NULL */
825 /** Array of records for each DB known in the environment. */
827 /** Array of MDB_db records for each known DB */
829 /** @defgroup mt_dbflag Transaction DB Flags
833 #define DB_DIRTY 0x01 /**< DB was written in this txn */
834 #define DB_STALE 0x02 /**< DB record is older than txnID */
835 #define DB_NEW 0x04 /**< DB handle opened in this txn */
836 #define DB_VALID 0x08 /**< DB handle is valid, see also #MDB_VALID */
838 /** In write txns, array of cursors for each DB */
839 MDB_cursor **mt_cursors;
840 /** Array of flags for each DB */
841 unsigned char *mt_dbflags;
842 /** Number of DB records in use. This number only ever increments;
843 * we don't decrement it when individual DB handles are closed.
847 /** @defgroup mdb_txn Transaction Flags
851 #define MDB_TXN_RDONLY 0x01 /**< read-only transaction */
852 #define MDB_TXN_ERROR 0x02 /**< an error has occurred */
853 #define MDB_TXN_DIRTY 0x04 /**< must write, even if dirty list is empty */
855 unsigned int mt_flags; /**< @ref mdb_txn */
856 /** dirty_list maxsize - #allocated pages including in parent txns */
857 unsigned int mt_dirty_room;
858 /** Tracks which of the two meta pages was used at the start
859 * of this transaction.
861 unsigned int mt_toggle;
864 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
865 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
866 * raise this on a 64 bit machine.
868 #define CURSOR_STACK 32
872 /** Cursors are used for all DB operations */
874 /** Next cursor on this DB in this txn */
876 /** Original cursor if this is a shadow */
878 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
879 struct MDB_xcursor *mc_xcursor;
880 /** The transaction that owns this cursor */
882 /** The database handle this cursor operates on */
884 /** The database record for this cursor */
886 /** The database auxiliary record for this cursor */
888 /** The @ref mt_dbflag for this database */
889 unsigned char *mc_dbflag;
890 unsigned short mc_snum; /**< number of pushed pages */
891 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
892 /** @defgroup mdb_cursor Cursor Flags
894 * Cursor state flags.
897 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
898 #define C_EOF 0x02 /**< No more data */
899 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
900 #define C_SHADOW 0x08 /**< Cursor is a dup from a parent txn */
901 #define C_ALLOCD 0x10 /**< Cursor was malloc'd */
902 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
903 #define C_UNTRACK 0x40 /**< Un-track cursor when closing */
905 unsigned int mc_flags; /**< @ref mdb_cursor */
906 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
907 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
910 /** Context for sorted-dup records.
911 * We could have gone to a fully recursive design, with arbitrarily
912 * deep nesting of sub-databases. But for now we only handle these
913 * levels - main DB, optional sub-DB, sorted-duplicate DB.
915 typedef struct MDB_xcursor {
916 /** A sub-cursor for traversing the Dup DB */
917 MDB_cursor mx_cursor;
918 /** The database record for this Dup DB */
920 /** The auxiliary DB record for this Dup DB */
922 /** The @ref mt_dbflag for this Dup DB */
923 unsigned char mx_dbflag;
926 /** State of FreeDB old pages, stored in the MDB_env */
927 typedef struct MDB_pgstate {
928 txnid_t mf_pglast; /**< ID of last old page record we used */
929 pgno_t *mf_pghead; /**< old pages reclaimed from freelist */
930 pgno_t *mf_pgfree; /**< memory to free when dropping me_pghead */
933 /** The database environment. */
935 HANDLE me_fd; /**< The main data file */
936 HANDLE me_lfd; /**< The lock file */
937 HANDLE me_mfd; /**< just for writing the meta pages */
938 /** Failed to update the meta page. Probably an I/O error. */
939 #define MDB_FATAL_ERROR 0x80000000U
940 /** Some fields are initialized. */
941 #define MDB_ENV_ACTIVE 0x20000000U
942 /** me_txkey is set */
943 #define MDB_ENV_TXKEY 0x10000000U
944 uint32_t me_flags; /**< @ref mdb_env */
945 unsigned int me_psize; /**< size of a page, from #GET_PAGESIZE */
946 unsigned int me_maxreaders; /**< size of the reader table */
947 unsigned int me_numreaders; /**< max numreaders set by this env */
948 MDB_dbi me_numdbs; /**< number of DBs opened */
949 MDB_dbi me_maxdbs; /**< size of the DB table */
950 pid_t me_pid; /**< process ID of this env */
951 char *me_path; /**< path to the DB files */
952 char *me_map; /**< the memory map of the data file */
953 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
954 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
955 MDB_txn *me_txn; /**< current write transaction */
956 size_t me_mapsize; /**< size of the data memory map */
957 off_t me_size; /**< current file size */
958 pgno_t me_maxpg; /**< me_mapsize / me_psize */
959 MDB_dbx *me_dbxs; /**< array of static DB info */
960 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
961 pthread_key_t me_txkey; /**< thread-key for readers */
962 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
963 # define me_pglast me_pgstate.mf_pglast
964 # define me_pghead me_pgstate.mf_pghead
965 # define me_pgfree me_pgstate.mf_pgfree
966 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
967 /** IDL of pages that became unused in a write txn */
969 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
970 MDB_ID2L me_dirty_list;
971 /** Max number of freelist items that can fit in a single overflow page */
972 unsigned int me_maxfree_1pg;
973 /** Max size of a node on a page */
974 unsigned int me_nodemax;
976 HANDLE me_rmutex; /* Windows mutexes don't reside in shared mem */
978 #elif defined(MDB_USE_POSIX_SEM)
979 sem_t *me_rmutex; /* Shared mutexes are not supported */
984 /** Nested transaction */
985 typedef struct MDB_ntxn {
986 MDB_txn mnt_txn; /* the transaction */
987 MDB_pgstate mnt_pgstate; /* parent transaction's saved freestate */
990 /** max number of pages to commit in one writev() call */
991 #define MDB_COMMIT_PAGES 64
992 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
993 #undef MDB_COMMIT_PAGES
994 #define MDB_COMMIT_PAGES IOV_MAX
997 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
998 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
999 static int mdb_page_touch(MDB_cursor *mc);
1001 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp);
1002 static int mdb_page_search_root(MDB_cursor *mc,
1003 MDB_val *key, int modify);
1004 #define MDB_PS_MODIFY 1
1005 #define MDB_PS_ROOTONLY 2
1006 static int mdb_page_search(MDB_cursor *mc,
1007 MDB_val *key, int flags);
1008 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1010 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1011 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1012 pgno_t newpgno, unsigned int nflags);
1014 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1015 static int mdb_env_pick_meta(const MDB_env *env);
1016 static int mdb_env_write_meta(MDB_txn *txn);
1017 #if !(defined(_WIN32) || defined(MDB_USE_POSIX_SEM)) /* Drop unused excl arg */
1018 # define mdb_env_close0(env, excl) mdb_env_close1(env)
1020 static void mdb_env_close0(MDB_env *env, int excl);
1022 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1023 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1024 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1025 static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
1026 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1027 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1028 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1029 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1030 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1032 static int mdb_rebalance(MDB_cursor *mc);
1033 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1035 static void mdb_cursor_pop(MDB_cursor *mc);
1036 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1038 static int mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
1039 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1040 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1041 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1042 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1044 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1045 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1047 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1048 static void mdb_xcursor_init0(MDB_cursor *mc);
1049 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1051 static int mdb_drop0(MDB_cursor *mc, int subs);
1052 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1055 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1059 static SECURITY_DESCRIPTOR mdb_null_sd;
1060 static SECURITY_ATTRIBUTES mdb_all_sa;
1061 static int mdb_sec_inited;
1064 /** Return the library version info. */
1066 mdb_version(int *major, int *minor, int *patch)
1068 if (major) *major = MDB_VERSION_MAJOR;
1069 if (minor) *minor = MDB_VERSION_MINOR;
1070 if (patch) *patch = MDB_VERSION_PATCH;
1071 return MDB_VERSION_STRING;
1074 /** Table of descriptions for MDB @ref errors */
1075 static char *const mdb_errstr[] = {
1076 "MDB_KEYEXIST: Key/data pair already exists",
1077 "MDB_NOTFOUND: No matching key/data pair found",
1078 "MDB_PAGE_NOTFOUND: Requested page not found",
1079 "MDB_CORRUPTED: Located page was wrong type",
1080 "MDB_PANIC: Update of meta page failed",
1081 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1082 "MDB_INVALID: File is not an MDB file",
1083 "MDB_MAP_FULL: Environment mapsize limit reached",
1084 "MDB_DBS_FULL: Environment maxdbs limit reached",
1085 "MDB_READERS_FULL: Environment maxreaders limit reached",
1086 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1087 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1088 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1089 "MDB_PAGE_FULL: Internal error - page has no more space",
1090 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1091 "MDB_INCOMPATIBLE: Database flags changed or would change",
1092 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1096 mdb_strerror(int err)
1100 return ("Successful return: 0");
1102 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1103 i = err - MDB_KEYEXIST;
1104 return mdb_errstr[i];
1107 return strerror(err);
1111 /** Display a key in hexadecimal and return the address of the result.
1112 * @param[in] key the key to display
1113 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1114 * @return The key in hexadecimal form.
1117 mdb_dkey(MDB_val *key, char *buf)
1120 unsigned char *c = key->mv_data;
1126 if (key->mv_size > MDB_MAXKEYSIZE)
1127 return "MDB_MAXKEYSIZE";
1128 /* may want to make this a dynamic check: if the key is mostly
1129 * printable characters, print it as-is instead of converting to hex.
1133 for (i=0; i<key->mv_size; i++)
1134 ptr += sprintf(ptr, "%02x", *c++);
1136 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1141 /** Display all the keys in the page. */
1143 mdb_page_list(MDB_page *mp)
1146 unsigned int i, nkeys, nsize;
1150 nkeys = NUMKEYS(mp);
1151 fprintf(stderr, "Page %zu numkeys %d\n", mp->mp_pgno, nkeys);
1152 for (i=0; i<nkeys; i++) {
1153 node = NODEPTR(mp, i);
1154 key.mv_size = node->mn_ksize;
1155 key.mv_data = node->mn_data;
1156 nsize = NODESIZE + NODEKSZ(node) + sizeof(indx_t);
1157 if (IS_BRANCH(mp)) {
1158 fprintf(stderr, "key %d: page %zu, %s\n", i, NODEPGNO(node),
1161 if (F_ISSET(node->mn_flags, F_BIGDATA))
1162 nsize += sizeof(pgno_t);
1164 nsize += NODEDSZ(node);
1165 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1171 mdb_cursor_chk(MDB_cursor *mc)
1177 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1178 for (i=0; i<mc->mc_top; i++) {
1180 node = NODEPTR(mp, mc->mc_ki[i]);
1181 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1184 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1190 /** Count all the pages in each DB and in the freelist
1191 * and make sure it matches the actual number of pages
1194 static void mdb_audit(MDB_txn *txn)
1198 MDB_ID freecount, count;
1203 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1204 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1205 freecount += *(MDB_ID *)data.mv_data;
1208 for (i = 0; i<txn->mt_numdbs; i++) {
1210 mdb_cursor_init(&mc, txn, i, &mx);
1211 if (txn->mt_dbs[i].md_root == P_INVALID)
1213 count += txn->mt_dbs[i].md_branch_pages +
1214 txn->mt_dbs[i].md_leaf_pages +
1215 txn->mt_dbs[i].md_overflow_pages;
1216 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1217 mdb_page_search(&mc, NULL, 0);
1221 mp = mc.mc_pg[mc.mc_top];
1222 for (j=0; j<NUMKEYS(mp); j++) {
1223 MDB_node *leaf = NODEPTR(mp, j);
1224 if (leaf->mn_flags & F_SUBDATA) {
1226 memcpy(&db, NODEDATA(leaf), sizeof(db));
1227 count += db.md_branch_pages + db.md_leaf_pages +
1228 db.md_overflow_pages;
1232 while (mdb_cursor_sibling(&mc, 1) == 0);
1235 if (freecount + count + 2 /* metapages */ != txn->mt_next_pgno) {
1236 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1237 txn->mt_txnid, freecount, count+2, freecount+count+2, txn->mt_next_pgno);
1243 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1245 return txn->mt_dbxs[dbi].md_cmp(a, b);
1249 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1251 return txn->mt_dbxs[dbi].md_dcmp(a, b);
1254 /** Allocate a single page.
1255 * Re-use old malloc'd pages first, otherwise just malloc.
1258 mdb_page_malloc(MDB_cursor *mc) {
1260 size_t sz = mc->mc_txn->mt_env->me_psize;
1261 if ((ret = mc->mc_txn->mt_env->me_dpages) != NULL) {
1262 VGMEMP_ALLOC(mc->mc_txn->mt_env, ret, sz);
1263 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1264 mc->mc_txn->mt_env->me_dpages = ret->mp_next;
1265 } else if ((ret = malloc(sz)) != NULL) {
1266 VGMEMP_ALLOC(mc->mc_txn->mt_env, ret, sz);
1272 mdb_page_free(MDB_env *env, MDB_page *mp)
1274 mp->mp_next = env->me_dpages;
1275 VGMEMP_FREE(env, mp);
1276 env->me_dpages = mp;
1279 /** Allocate pages for writing.
1280 * If there are free pages available from older transactions, they
1281 * will be re-used first. Otherwise a new page will be allocated.
1282 * @param[in] mc cursor A cursor handle identifying the transaction and
1283 * database for which we are allocating.
1284 * @param[in] num the number of pages to allocate.
1285 * @param[out] mp Address of the allocated page(s). Requests for multiple pages
1286 * will always be satisfied by a single contiguous chunk of memory.
1287 * @return 0 on success, non-zero on failure.
1290 mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp)
1292 MDB_txn *txn = mc->mc_txn;
1294 pgno_t pgno = P_INVALID;
1296 txnid_t oldest = 0, last;
1301 /* If our dirty list is already full, we can't do anything */
1302 if (txn->mt_dirty_room == 0)
1303 return MDB_TXN_FULL;
1305 /* The free list won't have any content at all until txn 2 has
1306 * committed. The pages freed by txn 2 will be unreferenced
1307 * after txn 3 commits, and so will be safe to re-use in txn 4.
1309 if (txn->mt_txnid > 3) {
1310 if (!txn->mt_env->me_pghead &&
1311 txn->mt_dbs[FREE_DBI].md_root != P_INVALID) {
1312 /* See if there's anything in the free DB */
1319 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
1320 if (!txn->mt_env->me_pglast) {
1321 mdb_page_search(&m2, NULL, 0);
1322 leaf = NODEPTR(m2.mc_pg[m2.mc_top], 0);
1323 kptr = (txnid_t *)NODEKEY(leaf);
1328 last = txn->mt_env->me_pglast + 1;
1330 key.mv_data = &last;
1331 key.mv_size = sizeof(last);
1332 rc = mdb_cursor_set(&m2, &key, &data, MDB_SET_RANGE, NULL);
1335 last = *(txnid_t *)key.mv_data;
1341 oldest = txn->mt_txnid - 1;
1342 nr = txn->mt_env->me_txns->mti_numreaders;
1343 r = txn->mt_env->me_txns->mti_readers;
1344 for (i=0; i<nr; i++) {
1345 if (!r[i].mr_pid) continue;
1352 if (oldest > last) {
1353 /* It's usable, grab it.
1357 if (!txn->mt_env->me_pglast) {
1358 mdb_node_read(txn, leaf, &data);
1360 idl = (MDB_ID *) data.mv_data;
1361 /* We might have a zero-length IDL due to freelist growth
1362 * during a prior commit
1365 txn->mt_env->me_pglast = last;
1368 mop = malloc(MDB_IDL_SIZEOF(idl));
1371 txn->mt_env->me_pglast = last;
1372 txn->mt_env->me_pghead = txn->mt_env->me_pgfree = mop;
1373 memcpy(mop, idl, MDB_IDL_SIZEOF(idl));
1378 DPRINTF("IDL read txn %zu root %zu num %zu",
1379 last, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
1380 for (i=0; i<idl[0]; i++) {
1381 DPRINTF("IDL %zu", idl[i+1]);
1388 if (txn->mt_env->me_pghead) {
1389 pgno_t *mop = txn->mt_env->me_pghead;
1392 int retry = 1, readit = 0, n2 = num-1;
1393 unsigned int i, j, k;
1395 /* If current list is too short, must fetch more and coalesce */
1396 if (mop[0] < (unsigned)num)
1399 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
1401 #ifdef MDB_PARANOID /* Seems like we can ignore this now */
1402 /* If on freelist, don't try to read more. If what we have
1403 * right now isn't enough just use new pages.
1404 * TODO: get all of this working. Many circular dependencies...
1406 if (mc->mc_dbi == FREE_DBI) {
1415 last = txn->mt_env->me_pglast + 1;
1417 /* We haven't hit the readers list yet? */
1423 oldest = txn->mt_txnid - 1;
1424 nr = txn->mt_env->me_txns->mti_numreaders;
1425 r = txn->mt_env->me_txns->mti_readers;
1426 for (i=0; i<nr; i++) {
1427 if (!r[i].mr_pid) continue;
1434 /* There's nothing we can use on the freelist */
1435 if (oldest - last < 1)
1438 key.mv_data = &last;
1439 key.mv_size = sizeof(last);
1440 rc = mdb_cursor_set(&m2,&key,&data,MDB_SET_RANGE,NULL);
1442 if (rc == MDB_NOTFOUND)
1446 last = *(txnid_t*)key.mv_data;
1449 idl = (MDB_ID *) data.mv_data;
1450 mop2 = malloc(MDB_IDL_SIZEOF(idl) + MDB_IDL_SIZEOF(mop));
1453 /* merge in sorted order */
1454 i = idl[0]; j = mop[0]; mop2[0] = k = i+j;
1456 while (i>0 || j>0) {
1457 if (i && idl[i] < mop[j])
1458 mop2[k--] = idl[i--];
1460 mop2[k--] = mop[j--];
1462 txn->mt_env->me_pglast = last;
1463 free(txn->mt_env->me_pgfree);
1464 txn->mt_env->me_pghead = txn->mt_env->me_pgfree = mop2;
1466 /* Keep trying to read until we have enough */
1467 if (mop[0] < (unsigned)num) {
1472 /* current list has enough pages, but are they contiguous? */
1473 for (i=mop[0]; i>=(unsigned)num; i--) {
1474 if (mop[i-n2] == mop[i] + n2) {
1477 /* move any stragglers down */
1478 for (j=i+num; j<=mop[0]; j++)
1485 /* Stop if we succeeded, or no retries */
1486 if (!retry || pgno != P_INVALID)
1492 /* peel pages off tail, so we only have to truncate the list */
1493 pgno = MDB_IDL_LAST(mop);
1496 if (MDB_IDL_IS_ZERO(mop)) {
1497 free(txn->mt_env->me_pgfree);
1498 txn->mt_env->me_pghead = txn->mt_env->me_pgfree = NULL;
1503 if (pgno == P_INVALID) {
1504 /* DB size is maxed out */
1505 if (txn->mt_next_pgno + num >= txn->mt_env->me_maxpg) {
1506 DPUTS("DB size maxed out");
1507 return MDB_MAP_FULL;
1510 if (txn->mt_env->me_flags & MDB_WRITEMAP) {
1511 if (pgno == P_INVALID) {
1512 pgno = txn->mt_next_pgno;
1513 txn->mt_next_pgno += num;
1515 np = (MDB_page *)(txn->mt_env->me_map + txn->mt_env->me_psize * pgno);
1518 if (txn->mt_env->me_dpages && num == 1) {
1519 np = txn->mt_env->me_dpages;
1520 VGMEMP_ALLOC(txn->mt_env, np, txn->mt_env->me_psize);
1521 VGMEMP_DEFINED(np, sizeof(np->mp_next));
1522 txn->mt_env->me_dpages = np->mp_next;
1524 size_t sz = txn->mt_env->me_psize * num;
1525 if ((np = malloc(sz)) == NULL)
1527 VGMEMP_ALLOC(txn->mt_env, np, sz);
1529 if (pgno == P_INVALID) {
1530 np->mp_pgno = txn->mt_next_pgno;
1531 txn->mt_next_pgno += num;
1536 mid.mid = np->mp_pgno;
1538 if (txn->mt_env->me_flags & MDB_WRITEMAP) {
1539 mdb_mid2l_append(txn->mt_u.dirty_list, &mid);
1541 mdb_mid2l_insert(txn->mt_u.dirty_list, &mid);
1543 txn->mt_dirty_room--;
1549 /** Copy a page: avoid copying unused portions of the page.
1550 * @param[in] dst page to copy into
1551 * @param[in] src page to copy from
1554 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
1556 dst->mp_flags = src->mp_flags | P_DIRTY;
1557 dst->mp_pages = src->mp_pages;
1559 if (IS_LEAF2(src)) {
1560 memcpy(dst->mp_ptrs, src->mp_ptrs, psize - PAGEHDRSZ - SIZELEFT(src));
1562 unsigned int i, nkeys = NUMKEYS(src);
1563 for (i=0; i<nkeys; i++)
1564 dst->mp_ptrs[i] = src->mp_ptrs[i];
1565 memcpy((char *)dst+src->mp_upper, (char *)src+src->mp_upper,
1566 psize - src->mp_upper);
1570 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
1571 * @param[in] mc cursor pointing to the page to be touched
1572 * @return 0 on success, non-zero on failure.
1575 mdb_page_touch(MDB_cursor *mc)
1577 MDB_page *mp = mc->mc_pg[mc->mc_top];
1581 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
1583 if ((rc = mdb_page_alloc(mc, 1, &np)))
1585 DPRINTF("touched db %u page %zu -> %zu", mc->mc_dbi, mp->mp_pgno, np->mp_pgno);
1586 assert(mp->mp_pgno != np->mp_pgno);
1587 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
1589 /* If page isn't full, just copy the used portion */
1590 mdb_page_copy(np, mp, mc->mc_txn->mt_env->me_psize);
1593 memcpy(np, mp, mc->mc_txn->mt_env->me_psize);
1595 np->mp_flags |= P_DIRTY;
1600 /* Adjust other cursors pointing to mp */
1601 if (mc->mc_flags & C_SUB) {
1602 MDB_cursor *m2, *m3;
1603 MDB_dbi dbi = mc->mc_dbi-1;
1605 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
1606 if (m2 == mc) continue;
1607 m3 = &m2->mc_xcursor->mx_cursor;
1608 if (m3->mc_snum < mc->mc_snum) continue;
1609 if (m3->mc_pg[mc->mc_top] == mc->mc_pg[mc->mc_top]) {
1610 m3->mc_pg[mc->mc_top] = mp;
1616 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
1617 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
1618 if (m2->mc_pg[mc->mc_top] == mc->mc_pg[mc->mc_top]) {
1619 m2->mc_pg[mc->mc_top] = mp;
1623 mc->mc_pg[mc->mc_top] = mp;
1624 /** If this page has a parent, update the parent to point to
1628 SETPGNO(NODEPTR(mc->mc_pg[mc->mc_top-1], mc->mc_ki[mc->mc_top-1]), mp->mp_pgno);
1630 mc->mc_db->md_root = mp->mp_pgno;
1631 } else if (mc->mc_txn->mt_parent) {
1634 /* If txn has a parent, make sure the page is in our
1637 if (mc->mc_txn->mt_u.dirty_list[0].mid) {
1638 unsigned x = mdb_mid2l_search(mc->mc_txn->mt_u.dirty_list, mp->mp_pgno);
1639 if (x <= mc->mc_txn->mt_u.dirty_list[0].mid &&
1640 mc->mc_txn->mt_u.dirty_list[x].mid == mp->mp_pgno) {
1641 if (mc->mc_txn->mt_u.dirty_list[x].mptr != mp) {
1642 mp = mc->mc_txn->mt_u.dirty_list[x].mptr;
1643 mc->mc_pg[mc->mc_top] = mp;
1648 assert(mc->mc_txn->mt_u.dirty_list[0].mid < MDB_IDL_UM_MAX);
1650 np = mdb_page_malloc(mc);
1653 memcpy(np, mp, mc->mc_txn->mt_env->me_psize);
1654 mid.mid = np->mp_pgno;
1656 mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &mid);
1664 mdb_env_sync(MDB_env *env, int force)
1667 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
1668 if (env->me_flags & MDB_WRITEMAP) {
1669 int flags = ((env->me_flags & MDB_MAPASYNC) && !force)
1670 ? MS_ASYNC : MS_SYNC;
1671 if (MDB_MSYNC(env->me_map, env->me_mapsize, flags))
1674 else if (flags == MS_SYNC && MDB_FDATASYNC(env->me_fd))
1678 if (MDB_FDATASYNC(env->me_fd))
1685 /** Make shadow copies of all of parent txn's cursors */
1687 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
1689 MDB_cursor *mc, *m2;
1690 unsigned int i, j, size;
1692 for (i=0;i<src->mt_numdbs; i++) {
1693 if (src->mt_cursors[i]) {
1694 size = sizeof(MDB_cursor);
1695 if (src->mt_cursors[i]->mc_xcursor)
1696 size += sizeof(MDB_xcursor);
1697 for (m2 = src->mt_cursors[i]; m2; m2=m2->mc_next) {
1704 mc->mc_db = &dst->mt_dbs[i];
1705 mc->mc_dbx = m2->mc_dbx;
1706 mc->mc_dbflag = &dst->mt_dbflags[i];
1707 mc->mc_snum = m2->mc_snum;
1708 mc->mc_top = m2->mc_top;
1709 mc->mc_flags = m2->mc_flags | (C_SHADOW|C_ALLOCD);
1710 for (j=0; j<mc->mc_snum; j++) {
1711 mc->mc_pg[j] = m2->mc_pg[j];
1712 mc->mc_ki[j] = m2->mc_ki[j];
1714 if (m2->mc_xcursor) {
1715 MDB_xcursor *mx, *mx2;
1716 mx = (MDB_xcursor *)(mc+1);
1717 mc->mc_xcursor = mx;
1718 mx2 = m2->mc_xcursor;
1719 mx->mx_db = mx2->mx_db;
1720 mx->mx_dbx = mx2->mx_dbx;
1721 mx->mx_dbflag = mx2->mx_dbflag;
1722 mx->mx_cursor.mc_txn = dst;
1723 mx->mx_cursor.mc_dbi = mx2->mx_cursor.mc_dbi;
1724 mx->mx_cursor.mc_db = &mx->mx_db;
1725 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
1726 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
1727 mx->mx_cursor.mc_snum = mx2->mx_cursor.mc_snum;
1728 mx->mx_cursor.mc_top = mx2->mx_cursor.mc_top;
1729 mx->mx_cursor.mc_flags = mx2->mx_cursor.mc_flags | C_SHADOW;
1730 for (j=0; j<mx2->mx_cursor.mc_snum; j++) {
1731 mx->mx_cursor.mc_pg[j] = mx2->mx_cursor.mc_pg[j];
1732 mx->mx_cursor.mc_ki[j] = mx2->mx_cursor.mc_ki[j];
1735 mc->mc_xcursor = NULL;
1737 mc->mc_next = dst->mt_cursors[i];
1738 dst->mt_cursors[i] = mc;
1745 /** Close this write txn's cursors, after optionally merging its shadow
1746 * cursors back into parent's.
1747 * @param[in] txn the transaction handle.
1748 * @param[in] merge 0 to not merge cursors, C_SHADOW to merge.
1749 * @return 0 on success, non-zero on failure.
1752 mdb_cursors_close(MDB_txn *txn, unsigned merge)
1754 MDB_cursor **cursors = txn->mt_cursors, *mc, *next;
1757 for (i = txn->mt_numdbs; --i >= 0; ) {
1758 for (mc = cursors[i]; mc; mc = next) {
1760 if (mc->mc_flags & merge) {
1761 MDB_cursor *m2 = mc->mc_orig;
1762 m2->mc_snum = mc->mc_snum;
1763 m2->mc_top = mc->mc_top;
1764 for (j = mc->mc_snum; --j >= 0; ) {
1765 m2->mc_pg[j] = mc->mc_pg[j];
1766 m2->mc_ki[j] = mc->mc_ki[j];
1769 if (mc->mc_flags & C_ALLOCD)
1777 mdb_txn_reset0(MDB_txn *txn);
1779 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
1780 * @param[in] txn the transaction handle to initialize
1781 * @return 0 on success, non-zero on failure.
1784 mdb_txn_renew0(MDB_txn *txn)
1786 MDB_env *env = txn->mt_env;
1789 int rc, new_notls = 0;
1792 txn->mt_numdbs = env->me_numdbs;
1793 txn->mt_dbxs = env->me_dbxs; /* mostly static anyway */
1795 if (txn->mt_flags & MDB_TXN_RDONLY) {
1796 if (!env->me_txns) {
1797 i = mdb_env_pick_meta(env);
1798 txn->mt_txnid = env->me_metas[i]->mm_txnid;
1799 txn->mt_u.reader = NULL;
1801 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
1802 pthread_getspecific(env->me_txkey);
1804 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
1805 return MDB_BAD_RSLOT;
1807 pid_t pid = env->me_pid;
1808 pthread_t tid = pthread_self();
1811 for (i=0; i<env->me_txns->mti_numreaders; i++)
1812 if (env->me_txns->mti_readers[i].mr_pid == 0)
1814 if (i == env->me_maxreaders) {
1815 UNLOCK_MUTEX_R(env);
1816 return MDB_READERS_FULL;
1818 env->me_txns->mti_readers[i].mr_pid = pid;
1819 env->me_txns->mti_readers[i].mr_tid = tid;
1820 if (i >= env->me_txns->mti_numreaders)
1821 env->me_txns->mti_numreaders = i+1;
1822 /* Save numreaders for un-mutexed mdb_env_close() */
1823 env->me_numreaders = env->me_txns->mti_numreaders;
1824 UNLOCK_MUTEX_R(env);
1825 r = &env->me_txns->mti_readers[i];
1826 new_notls = (env->me_flags & MDB_NOTLS);
1827 if (!new_notls && (rc=pthread_setspecific(env->me_txkey, r))) {
1832 txn->mt_txnid = r->mr_txnid = env->me_txns->mti_txnid;
1833 txn->mt_u.reader = r;
1835 txn->mt_toggle = txn->mt_txnid & 1;
1836 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1840 txn->mt_txnid = env->me_txns->mti_txnid;
1841 txn->mt_toggle = txn->mt_txnid & 1;
1842 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1845 if (txn->mt_txnid == mdb_debug_start)
1848 txn->mt_dirty_room = MDB_IDL_UM_MAX;
1849 txn->mt_u.dirty_list = env->me_dirty_list;
1850 txn->mt_u.dirty_list[0].mid = 0;
1851 txn->mt_free_pgs = env->me_free_pgs;
1852 txn->mt_free_pgs[0] = 0;
1856 /* Copy the DB info and flags */
1857 memcpy(txn->mt_dbs, env->me_metas[txn->mt_toggle]->mm_dbs, 2 * sizeof(MDB_db));
1858 for (i=2; i<txn->mt_numdbs; i++) {
1859 x = env->me_dbflags[i];
1860 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
1861 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_STALE : 0;
1863 txn->mt_dbflags[0] = txn->mt_dbflags[1] = DB_VALID;
1865 if (env->me_maxpg < txn->mt_next_pgno) {
1866 mdb_txn_reset0(txn);
1868 txn->mt_u.reader->mr_pid = 0;
1869 txn->mt_u.reader = NULL;
1871 return MDB_MAP_RESIZED;
1878 mdb_txn_renew(MDB_txn *txn)
1882 if (!txn || txn->mt_dbxs) /* A reset txn has mt_dbxs==NULL */
1885 if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
1886 DPUTS("environment had fatal error, must shutdown!");
1890 rc = mdb_txn_renew0(txn);
1891 if (rc == MDB_SUCCESS) {
1892 DPRINTF("renew txn %zu%c %p on mdbenv %p, root page %zu",
1893 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1894 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1900 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
1904 int rc, size, tsize = sizeof(MDB_txn);
1906 if (env->me_flags & MDB_FATAL_ERROR) {
1907 DPUTS("environment had fatal error, must shutdown!");
1910 if ((env->me_flags & MDB_RDONLY) && !(flags & MDB_RDONLY))
1913 /* Nested transactions: Max 1 child, write txns only, no writemap */
1914 if (parent->mt_child ||
1915 (flags & MDB_RDONLY) || (parent->mt_flags & MDB_TXN_RDONLY) ||
1916 (env->me_flags & MDB_WRITEMAP))
1920 tsize = sizeof(MDB_ntxn);
1922 size = tsize + env->me_maxdbs * (sizeof(MDB_db)+1);
1923 if (!(flags & MDB_RDONLY))
1924 size += env->me_maxdbs * sizeof(MDB_cursor *);
1926 if ((txn = calloc(1, size)) == NULL) {
1927 DPRINTF("calloc: %s", strerror(ErrCode()));
1930 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
1931 if (flags & MDB_RDONLY) {
1932 txn->mt_flags |= MDB_TXN_RDONLY;
1933 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
1935 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
1936 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
1942 txn->mt_free_pgs = mdb_midl_alloc();
1943 if (!txn->mt_free_pgs) {
1947 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
1948 if (!txn->mt_u.dirty_list) {
1949 free(txn->mt_free_pgs);
1953 txn->mt_txnid = parent->mt_txnid;
1954 txn->mt_toggle = parent->mt_toggle;
1955 txn->mt_dirty_room = parent->mt_dirty_room;
1956 txn->mt_u.dirty_list[0].mid = 0;
1957 txn->mt_free_pgs[0] = 0;
1958 txn->mt_next_pgno = parent->mt_next_pgno;
1959 parent->mt_child = txn;
1960 txn->mt_parent = parent;
1961 txn->mt_numdbs = parent->mt_numdbs;
1962 txn->mt_dbxs = parent->mt_dbxs;
1963 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
1964 /* Copy parent's mt_dbflags, but clear DB_NEW */
1965 for (i=0; i<txn->mt_numdbs; i++)
1966 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
1968 ntxn = (MDB_ntxn *)txn;
1969 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
1970 if (env->me_pghead) {
1971 size = MDB_IDL_SIZEOF(env->me_pghead);
1972 env->me_pghead = malloc(size);
1974 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
1978 env->me_pgfree = env->me_pghead;
1980 rc = mdb_cursor_shadow(parent, txn);
1982 mdb_txn_reset0(txn);
1984 rc = mdb_txn_renew0(txn);
1990 DPRINTF("begin txn %zu%c %p on mdbenv %p, root page %zu",
1991 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1992 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root);
1998 /** Export or close DBI handles opened in this txn. */
2000 mdb_dbis_update(MDB_txn *txn, int keep)
2003 MDB_dbi n = txn->mt_numdbs;
2004 MDB_env *env = txn->mt_env;
2005 unsigned char *tdbflags = txn->mt_dbflags;
2007 for (i = n; --i >= 2;) {
2008 if (tdbflags[i] & DB_NEW) {
2010 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2012 char *ptr = env->me_dbxs[i].md_name.mv_data;
2013 env->me_dbxs[i].md_name.mv_data = NULL;
2014 env->me_dbxs[i].md_name.mv_size = 0;
2015 env->me_dbflags[i] = 0;
2020 if (keep && env->me_numdbs < n)
2024 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
2025 * May be called twice for readonly txns: First reset it, then abort.
2026 * @param[in] txn the transaction handle to reset
2029 mdb_txn_reset0(MDB_txn *txn)
2031 MDB_env *env = txn->mt_env;
2034 /* Close any DBI handles opened in this txn */
2035 mdb_dbis_update(txn, 0);
2037 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2038 if (txn->mt_u.reader) {
2039 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
2040 if (!(env->me_flags & MDB_NOTLS))
2041 txn->mt_u.reader = NULL; /* txn does not own reader */
2043 txn->mt_numdbs = 0; /* close nothing if called again */
2044 txn->mt_dbxs = NULL; /* mark txn as reset */
2048 mdb_cursors_close(txn, 0);
2050 if (!(env->me_flags & MDB_WRITEMAP)) {
2051 /* return all dirty pages to dpage list */
2052 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2053 dp = txn->mt_u.dirty_list[i].mptr;
2054 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2055 mdb_page_free(txn->mt_env, dp);
2057 /* large pages just get freed directly */
2058 VGMEMP_FREE(txn->mt_env, dp);
2064 free(env->me_pgfree);
2066 if (txn->mt_parent) {
2067 txn->mt_parent->mt_child = NULL;
2068 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2069 mdb_midl_free(txn->mt_free_pgs);
2070 free(txn->mt_u.dirty_list);
2073 if (mdb_midl_shrink(&txn->mt_free_pgs))
2074 env->me_free_pgs = txn->mt_free_pgs;
2077 txn->mt_env->me_pghead = txn->mt_env->me_pgfree = NULL;
2078 txn->mt_env->me_pglast = 0;
2081 /* The writer mutex was locked in mdb_txn_begin. */
2082 UNLOCK_MUTEX_W(env);
2087 mdb_txn_reset(MDB_txn *txn)
2092 DPRINTF("reset txn %zu%c %p on mdbenv %p, root page %zu",
2093 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2094 (void *) txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
2096 /* This call is only valid for read-only txns */
2097 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2100 mdb_txn_reset0(txn);
2104 mdb_txn_abort(MDB_txn *txn)
2109 DPRINTF("abort txn %zu%c %p on mdbenv %p, root page %zu",
2110 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2111 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
2114 mdb_txn_abort(txn->mt_child);
2116 mdb_txn_reset0(txn);
2117 /* Free reader slot tied to this txn (if MDB_NOTLS && writable FS) */
2118 if ((txn->mt_flags & MDB_TXN_RDONLY) && txn->mt_u.reader)
2119 txn->mt_u.reader->mr_pid = 0;
2125 mdb_txn_commit(MDB_txn *txn)
2133 pgno_t next, freecnt;
2134 txnid_t oldpg_txnid, id;
2137 assert(txn != NULL);
2138 assert(txn->mt_env != NULL);
2140 if (txn->mt_child) {
2141 mdb_txn_commit(txn->mt_child);
2142 txn->mt_child = NULL;
2147 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2148 mdb_dbis_update(txn, 1);
2149 txn->mt_numdbs = 2; /* so txn_abort() doesn't close any new handles */
2154 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
2155 DPUTS("error flag is set, can't commit");
2157 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
2162 if (txn->mt_parent) {
2163 MDB_txn *parent = txn->mt_parent;
2167 /* Append our free list to parent's */
2168 if (mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs)) {
2172 mdb_midl_free(txn->mt_free_pgs);
2174 parent->mt_next_pgno = txn->mt_next_pgno;
2175 parent->mt_flags = txn->mt_flags;
2177 /* Merge our cursors into parent's and close them */
2178 mdb_cursors_close(txn, C_SHADOW);
2180 /* Update parent's DB table. */
2181 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2182 txn->mt_parent->mt_numdbs = txn->mt_numdbs;
2183 txn->mt_parent->mt_dbflags[0] = txn->mt_dbflags[0];
2184 txn->mt_parent->mt_dbflags[1] = txn->mt_dbflags[1];
2185 for (i=2; i<txn->mt_numdbs; i++) {
2186 /* preserve parent's DB_NEW status */
2187 x = txn->mt_parent->mt_dbflags[i] & DB_NEW;
2188 txn->mt_parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
2191 dst = txn->mt_parent->mt_u.dirty_list;
2192 src = txn->mt_u.dirty_list;
2193 /* Find len = length of merging our dirty list with parent's */
2195 dst[0].mid = 0; /* simplify loops */
2196 if (parent->mt_parent) {
2197 len = x + src[0].mid;
2198 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
2199 for (i = x; y && i; y--) {
2200 pgno_t yp = src[y].mid;
2201 while (yp < dst[i].mid)
2203 if (yp == dst[i].mid) {
2208 } else { /* Simplify the above for single-ancestor case */
2209 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
2211 /* Merge our dirty list with parent's */
2213 for (i = len; y; dst[i--] = src[y--]) {
2214 pgno_t yp = src[y].mid;
2215 while (yp < dst[x].mid)
2216 dst[i--] = dst[x--];
2217 if (yp == dst[x].mid)
2218 free(dst[x--].mptr);
2222 free(txn->mt_u.dirty_list);
2223 parent->mt_dirty_room = txn->mt_dirty_room;
2225 txn->mt_parent->mt_child = NULL;
2226 free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pgfree);
2231 if (txn != env->me_txn) {
2232 DPUTS("attempt to commit unknown transaction");
2237 mdb_cursors_close(txn, 0);
2239 if (!txn->mt_u.dirty_list[0].mid && !(txn->mt_flags & MDB_TXN_DIRTY))
2242 DPRINTF("committing txn %zu %p on mdbenv %p, root page %zu",
2243 txn->mt_txnid, (void *)txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root);
2245 /* Update DB root pointers */
2246 if (txn->mt_numdbs > 2) {
2249 data.mv_size = sizeof(MDB_db);
2251 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
2252 for (i = 2; i < txn->mt_numdbs; i++) {
2253 if (txn->mt_dbflags[i] & DB_DIRTY) {
2254 data.mv_data = &txn->mt_dbs[i];
2255 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
2262 /* Save the freelist as of this transaction to the freeDB. This
2263 * can change the freelist, so keep trying until it stabilizes.
2265 * env->me_pglast and the length of txn->mt_free_pgs cannot decrease,
2266 * except the code below can decrease env->me_pglast to split pghead.
2267 * Page numbers cannot disappear from txn->mt_free_pgs. New pages
2268 * can only appear in env->me_pghead when env->me_pglast increases.
2269 * Until then, the me_pghead pointer won't move but can become NULL.
2272 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
2273 oldpg_txnid = id = 0;
2276 /* should only be one record now */
2277 if (env->me_pghead || env->me_pglast) {
2278 /* make sure first page of freeDB is touched and on freelist */
2279 rc = mdb_page_search(&mc, NULL, MDB_PS_MODIFY);
2280 if (rc && rc != MDB_NOTFOUND) {
2287 /* Delete IDLs we used from the free list */
2288 if (env->me_pglast) {
2293 rc = mdb_cursor_first(&mc, &key, NULL);
2296 oldpg_txnid = *(txnid_t *)key.mv_data;
2298 assert(oldpg_txnid <= env->me_pglast);
2300 rc = mdb_cursor_del(&mc, 0);
2303 } while (oldpg_txnid < env->me_pglast);
2306 /* Save IDL of pages freed by this txn, to freeDB */
2308 if (freecnt != txn->mt_free_pgs[0]) {
2311 /* make sure last page of freeDB is touched and on freelist */
2312 key.mv_size = MDB_MAXKEYSIZE+1;
2314 rc = mdb_page_search(&mc, &key, MDB_PS_MODIFY);
2315 if (rc && rc != MDB_NOTFOUND)
2321 MDB_IDL idl = txn->mt_free_pgs;
2322 mdb_midl_sort(txn->mt_free_pgs);
2323 DPRINTF("IDL write txn %zu root %zu num %zu",
2324 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
2325 for (i=1; i<=idl[0]; i++) {
2326 DPRINTF("IDL %zu", idl[i]);
2330 /* write to last page of freeDB */
2331 key.mv_size = sizeof(pgno_t);
2332 key.mv_data = &txn->mt_txnid;
2333 /* The free list can still grow during this call,
2334 * despite the pre-emptive touches above. So retry
2335 * until the reserved space remains big enough.
2338 assert(freecnt < txn->mt_free_pgs[0]);
2339 freecnt = txn->mt_free_pgs[0];
2340 data.mv_size = MDB_IDL_SIZEOF(txn->mt_free_pgs);
2341 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2344 } while (freecnt != txn->mt_free_pgs[0]);
2345 mdb_midl_sort(txn->mt_free_pgs);
2346 memcpy(data.mv_data, txn->mt_free_pgs, data.mv_size);
2347 if (oldpg_txnid < env->me_pglast || (!env->me_pghead && id))
2348 goto free_pgfirst; /* used up freeDB[oldpg_txnid] */
2351 /* Put back page numbers we took from freeDB but did not use */
2352 if (env->me_pghead) {
2357 mop = env->me_pghead;
2358 id = env->me_pglast;
2359 key.mv_size = sizeof(id);
2361 /* These steps may grow the freelist again
2362 * due to freed overflow pages...
2367 if (orig > env->me_maxfree_1pg && id > 4)
2368 orig = env->me_maxfree_1pg; /* Do not use more than 1 page */
2369 data.mv_size = (orig + 1) * sizeof(pgno_t);
2370 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2373 assert(!env->me_pghead || env->me_pglast);
2374 /* mop could have been used again here */
2375 if (id != env->me_pglast || env->me_pghead == NULL)
2376 goto again; /* was completely used up */
2377 assert(mop == env->me_pghead);
2378 } while (mop[0] < orig && --i);
2379 memcpy(data.mv_data, mop, data.mv_size);
2382 *(pgno_t *)data.mv_data = orig;
2383 mop[orig] = mop[0] - orig;
2384 env->me_pghead = mop += orig;
2385 /* Save more oldpages at the previous txnid. */
2386 assert(env->me_pglast == id && id == oldpg_txnid);
2387 env->me_pglast = --oldpg_txnid;
2391 /* Check for growth of freelist again */
2392 if (freecnt != txn->mt_free_pgs[0])
2395 free(env->me_pgfree);
2396 env->me_pghead = env->me_pgfree = NULL;
2398 if (!MDB_IDL_IS_ZERO(txn->mt_free_pgs)) {
2399 if (mdb_midl_shrink(&txn->mt_free_pgs))
2400 env->me_free_pgs = txn->mt_free_pgs;
2407 if (env->me_flags & MDB_WRITEMAP) {
2408 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2409 dp = txn->mt_u.dirty_list[i].mptr;
2410 /* clear dirty flag */
2411 dp->mp_flags &= ~P_DIRTY;
2412 txn->mt_u.dirty_list[i].mid = 0;
2414 txn->mt_u.dirty_list[0].mid = 0;
2418 /* Commit up to MDB_COMMIT_PAGES dirty pages to disk until done.
2424 /* Windows actually supports scatter/gather I/O, but only on
2425 * unbuffered file handles. Since we're relying on the OS page
2426 * cache for all our data, that's self-defeating. So we just
2427 * write pages one at a time. We use the ov structure to set
2428 * the write offset, to at least save the overhead of a Seek
2432 memset(&ov, 0, sizeof(ov));
2433 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2435 dp = txn->mt_u.dirty_list[i].mptr;
2436 DPRINTF("committing page %zu", dp->mp_pgno);
2437 size = dp->mp_pgno * env->me_psize;
2438 ov.Offset = size & 0xffffffff;
2439 ov.OffsetHigh = size >> 16;
2440 ov.OffsetHigh >>= 16;
2441 /* clear dirty flag */
2442 dp->mp_flags &= ~P_DIRTY;
2443 wsize = env->me_psize;
2444 if (IS_OVERFLOW(dp)) wsize *= dp->mp_pages;
2445 rc = WriteFile(env->me_fd, dp, wsize, NULL, &ov);
2448 DPRINTF("WriteFile: %d", n);
2455 struct iovec iov[MDB_COMMIT_PAGES];
2459 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2460 dp = txn->mt_u.dirty_list[i].mptr;
2461 if (dp->mp_pgno != next) {
2463 rc = writev(env->me_fd, iov, n);
2467 DPUTS("short write, filesystem full?");
2469 DPRINTF("writev: %s", strerror(n));
2476 lseek(env->me_fd, dp->mp_pgno * env->me_psize, SEEK_SET);
2479 DPRINTF("committing page %zu", dp->mp_pgno);
2480 iov[n].iov_len = env->me_psize;
2481 if (IS_OVERFLOW(dp)) iov[n].iov_len *= dp->mp_pages;
2482 iov[n].iov_base = (char *)dp;
2483 size += iov[n].iov_len;
2484 next = dp->mp_pgno + (IS_OVERFLOW(dp) ? dp->mp_pages : 1);
2485 /* clear dirty flag */
2486 dp->mp_flags &= ~P_DIRTY;
2487 if (++n >= MDB_COMMIT_PAGES) {
2497 rc = writev(env->me_fd, iov, n);
2501 DPUTS("short write, filesystem full?");
2503 DPRINTF("writev: %s", strerror(n));
2510 /* Drop the dirty pages.
2512 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2513 dp = txn->mt_u.dirty_list[i].mptr;
2514 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2515 mdb_page_free(txn->mt_env, dp);
2517 VGMEMP_FREE(txn->mt_env, dp);
2520 txn->mt_u.dirty_list[i].mid = 0;
2522 txn->mt_u.dirty_list[0].mid = 0;
2525 if ((n = mdb_env_sync(env, 0)) != 0 ||
2526 (n = mdb_env_write_meta(txn)) != MDB_SUCCESS) {
2534 mdb_dbis_update(txn, 1);
2536 UNLOCK_MUTEX_W(env);
2542 /** Read the environment parameters of a DB environment before
2543 * mapping it into memory.
2544 * @param[in] env the environment handle
2545 * @param[out] meta address of where to store the meta information
2546 * @return 0 on success, non-zero on failure.
2549 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
2556 /* We don't know the page size yet, so use a minimum value.
2557 * Read both meta pages so we can use the latest one.
2560 for (i=0; i<2; i++) {
2562 if (!ReadFile(env->me_fd, &pbuf, MDB_PAGESIZE, (DWORD *)&rc, NULL) || rc == 0)
2564 if ((rc = read(env->me_fd, &pbuf, MDB_PAGESIZE)) == 0)
2569 else if (rc != MDB_PAGESIZE) {
2573 DPRINTF("read: %s", strerror(err));
2577 p = (MDB_page *)&pbuf;
2579 if (!F_ISSET(p->mp_flags, P_META)) {
2580 DPRINTF("page %zu not a meta page", p->mp_pgno);
2585 if (m->mm_magic != MDB_MAGIC) {
2586 DPUTS("meta has invalid magic");
2590 if (m->mm_version != MDB_VERSION) {
2591 DPRINTF("database is version %u, expected version %u",
2592 m->mm_version, MDB_VERSION);
2593 return MDB_VERSION_MISMATCH;
2597 if (m->mm_txnid > meta->mm_txnid)
2598 memcpy(meta, m, sizeof(*m));
2600 memcpy(meta, m, sizeof(*m));
2602 if (SetFilePointer(env->me_fd, meta->mm_psize, NULL, FILE_BEGIN) != meta->mm_psize)
2604 if (lseek(env->me_fd, meta->mm_psize, SEEK_SET) != meta->mm_psize)
2612 /** Write the environment parameters of a freshly created DB environment.
2613 * @param[in] env the environment handle
2614 * @param[out] meta address of where to store the meta information
2615 * @return 0 on success, non-zero on failure.
2618 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
2625 DPUTS("writing new meta page");
2627 GET_PAGESIZE(psize);
2629 meta->mm_magic = MDB_MAGIC;
2630 meta->mm_version = MDB_VERSION;
2631 meta->mm_mapsize = env->me_mapsize;
2632 meta->mm_psize = psize;
2633 meta->mm_last_pg = 1;
2634 meta->mm_flags = env->me_flags & 0xffff;
2635 meta->mm_flags |= MDB_INTEGERKEY;
2636 meta->mm_dbs[0].md_root = P_INVALID;
2637 meta->mm_dbs[1].md_root = P_INVALID;
2639 p = calloc(2, psize);
2641 p->mp_flags = P_META;
2644 memcpy(m, meta, sizeof(*meta));
2646 q = (MDB_page *)((char *)p + psize);
2649 q->mp_flags = P_META;
2652 memcpy(m, meta, sizeof(*meta));
2657 SetFilePointer(env->me_fd, 0, NULL, FILE_BEGIN);
2658 rc = WriteFile(env->me_fd, p, psize * 2, &len, NULL);
2659 rc = (len == psize * 2) ? MDB_SUCCESS : ErrCode();
2662 lseek(env->me_fd, 0, SEEK_SET);
2663 rc = write(env->me_fd, p, psize * 2);
2664 rc = (rc == (int)psize * 2) ? MDB_SUCCESS : ErrCode();
2670 /** Update the environment info to commit a transaction.
2671 * @param[in] txn the transaction that's being committed
2672 * @return 0 on success, non-zero on failure.
2675 mdb_env_write_meta(MDB_txn *txn)
2678 MDB_meta meta, metab, *mp;
2680 int rc, len, toggle;
2687 assert(txn != NULL);
2688 assert(txn->mt_env != NULL);
2690 toggle = !txn->mt_toggle;
2691 DPRINTF("writing meta page %d for root page %zu",
2692 toggle, txn->mt_dbs[MAIN_DBI].md_root);
2695 mp = env->me_metas[toggle];
2697 if (env->me_flags & MDB_WRITEMAP) {
2698 /* Persist any increases of mapsize config */
2699 if (env->me_mapsize > mp->mm_mapsize)
2700 mp->mm_mapsize = env->me_mapsize;
2701 mp->mm_dbs[0] = txn->mt_dbs[0];
2702 mp->mm_dbs[1] = txn->mt_dbs[1];
2703 mp->mm_last_pg = txn->mt_next_pgno - 1;
2704 mp->mm_txnid = txn->mt_txnid;
2705 if (!(env->me_flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
2706 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
2709 ptr += env->me_psize;
2710 if (MDB_MSYNC(ptr, env->me_psize, rc)) {
2717 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
2718 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
2720 ptr = (char *)&meta;
2721 if (env->me_mapsize > mp->mm_mapsize) {
2722 /* Persist any increases of mapsize config */
2723 meta.mm_mapsize = env->me_mapsize;
2724 off = offsetof(MDB_meta, mm_mapsize);
2726 off = offsetof(MDB_meta, mm_dbs[0].md_depth);
2728 len = sizeof(MDB_meta) - off;
2731 meta.mm_dbs[0] = txn->mt_dbs[0];
2732 meta.mm_dbs[1] = txn->mt_dbs[1];
2733 meta.mm_last_pg = txn->mt_next_pgno - 1;
2734 meta.mm_txnid = txn->mt_txnid;
2737 off += env->me_psize;
2740 /* Write to the SYNC fd */
2741 mfd = env->me_flags & (MDB_NOSYNC|MDB_NOMETASYNC) ?
2742 env->me_fd : env->me_mfd;
2745 memset(&ov, 0, sizeof(ov));
2747 WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov);
2750 rc = pwrite(mfd, ptr, len, off);
2755 DPUTS("write failed, disk error?");
2756 /* On a failure, the pagecache still contains the new data.
2757 * Write some old data back, to prevent it from being used.
2758 * Use the non-SYNC fd; we know it will fail anyway.
2760 meta.mm_last_pg = metab.mm_last_pg;
2761 meta.mm_txnid = metab.mm_txnid;
2763 WriteFile(env->me_fd, ptr, len, NULL, &ov);
2765 r2 = pwrite(env->me_fd, ptr, len, off);
2768 env->me_flags |= MDB_FATAL_ERROR;
2772 /* Memory ordering issues are irrelevant; since the entire writer
2773 * is wrapped by wmutex, all of these changes will become visible
2774 * after the wmutex is unlocked. Since the DB is multi-version,
2775 * readers will get consistent data regardless of how fresh or
2776 * how stale their view of these values is.
2778 txn->mt_env->me_txns->mti_txnid = txn->mt_txnid;
2783 /** Check both meta pages to see which one is newer.
2784 * @param[in] env the environment handle
2785 * @return meta toggle (0 or 1).
2788 mdb_env_pick_meta(const MDB_env *env)
2790 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
2794 mdb_env_create(MDB_env **env)
2798 e = calloc(1, sizeof(MDB_env));
2802 e->me_maxreaders = DEFAULT_READERS;
2803 e->me_maxdbs = e->me_numdbs = 2;
2804 e->me_fd = INVALID_HANDLE_VALUE;
2805 e->me_lfd = INVALID_HANDLE_VALUE;
2806 e->me_mfd = INVALID_HANDLE_VALUE;
2807 #ifdef MDB_USE_POSIX_SEM
2808 e->me_rmutex = SEM_FAILED;
2809 e->me_wmutex = SEM_FAILED;
2811 e->me_pid = getpid();
2812 VGMEMP_CREATE(e,0,0);
2818 mdb_env_set_mapsize(MDB_env *env, size_t size)
2822 env->me_mapsize = size;
2824 env->me_maxpg = env->me_mapsize / env->me_psize;
2829 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
2833 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
2838 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
2840 if (env->me_map || readers < 1)
2842 env->me_maxreaders = readers;
2847 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
2849 if (!env || !readers)
2851 *readers = env->me_maxreaders;
2855 /** Further setup required for opening an MDB environment
2858 mdb_env_open2(MDB_env *env)
2860 unsigned int flags = env->me_flags;
2861 int i, newenv = 0, prot;
2865 memset(&meta, 0, sizeof(meta));
2867 if ((i = mdb_env_read_header(env, &meta)) != 0) {
2870 DPUTS("new mdbenv");
2874 /* Was a mapsize configured? */
2875 if (!env->me_mapsize) {
2876 /* If this is a new environment, take the default,
2877 * else use the size recorded in the existing env.
2879 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
2880 } else if (env->me_mapsize < meta.mm_mapsize) {
2881 /* If the configured size is smaller, make sure it's
2882 * still big enough. Silently round up to minimum if not.
2884 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
2885 if (env->me_mapsize < minsize)
2886 env->me_mapsize = minsize;
2892 LONG sizelo, sizehi;
2893 sizelo = env->me_mapsize & 0xffffffff;
2894 sizehi = env->me_mapsize >> 16; /* pointless on WIN32, only needed on W64 */
2896 /* Windows won't create mappings for zero length files.
2897 * Just allocate the maxsize right now.
2900 SetFilePointer(env->me_fd, sizelo, sizehi ? &sizehi : NULL, 0);
2901 if (!SetEndOfFile(env->me_fd))
2903 SetFilePointer(env->me_fd, 0, NULL, 0);
2905 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
2906 PAGE_READWRITE : PAGE_READONLY,
2907 sizehi, sizelo, NULL);
2910 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
2911 FILE_MAP_WRITE : FILE_MAP_READ,
2912 0, 0, env->me_mapsize, meta.mm_address);
2920 if (flags & MDB_WRITEMAP) {
2922 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
2925 env->me_map = mmap(meta.mm_address, env->me_mapsize, prot, i,
2927 if (env->me_map == MAP_FAILED) {
2931 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
2933 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
2935 #ifdef POSIX_MADV_RANDOM
2936 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
2937 #endif /* POSIX_MADV_RANDOM */
2938 #endif /* MADV_RANDOM */
2942 if (flags & MDB_FIXEDMAP)
2943 meta.mm_address = env->me_map;
2944 i = mdb_env_init_meta(env, &meta);
2945 if (i != MDB_SUCCESS) {
2948 } else if (meta.mm_address && env->me_map != meta.mm_address) {
2949 /* Can happen because the address argument to mmap() is just a
2950 * hint. mmap() can pick another, e.g. if the range is in use.
2951 * The MAP_FIXED flag would prevent that, but then mmap could
2952 * instead unmap existing pages to make room for the new map.
2954 return EBUSY; /* TODO: Make a new MDB_* error code? */
2956 env->me_psize = meta.mm_psize;
2957 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
2958 env->me_nodemax = (env->me_psize - PAGEHDRSZ) / MDB_MINKEYS;
2960 env->me_maxpg = env->me_mapsize / env->me_psize;
2962 p = (MDB_page *)env->me_map;
2963 env->me_metas[0] = METADATA(p);
2964 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + meta.mm_psize);
2968 int toggle = mdb_env_pick_meta(env);
2969 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
2971 DPRINTF("opened database version %u, pagesize %u",
2972 env->me_metas[0]->mm_version, env->me_psize);
2973 DPRINTF("using meta page %d", toggle);
2974 DPRINTF("depth: %u", db->md_depth);
2975 DPRINTF("entries: %zu", db->md_entries);
2976 DPRINTF("branch pages: %zu", db->md_branch_pages);
2977 DPRINTF("leaf pages: %zu", db->md_leaf_pages);
2978 DPRINTF("overflow pages: %zu", db->md_overflow_pages);
2979 DPRINTF("root: %zu", db->md_root);
2987 /** Release a reader thread's slot in the reader lock table.
2988 * This function is called automatically when a thread exits.
2989 * @param[in] ptr This points to the slot in the reader lock table.
2992 mdb_env_reader_dest(void *ptr)
2994 MDB_reader *reader = ptr;
3000 /** Junk for arranging thread-specific callbacks on Windows. This is
3001 * necessarily platform and compiler-specific. Windows supports up
3002 * to 1088 keys. Let's assume nobody opens more than 64 environments
3003 * in a single process, for now. They can override this if needed.
3005 #ifndef MAX_TLS_KEYS
3006 #define MAX_TLS_KEYS 64
3008 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
3009 static int mdb_tls_nkeys;
3011 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
3015 case DLL_PROCESS_ATTACH: break;
3016 case DLL_THREAD_ATTACH: break;
3017 case DLL_THREAD_DETACH:
3018 for (i=0; i<mdb_tls_nkeys; i++) {
3019 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
3020 mdb_env_reader_dest(r);
3023 case DLL_PROCESS_DETACH: break;
3028 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3030 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3034 /* Force some symbol references.
3035 * _tls_used forces the linker to create the TLS directory if not already done
3036 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
3038 #pragma comment(linker, "/INCLUDE:_tls_used")
3039 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
3040 #pragma const_seg(".CRT$XLB")
3041 extern const PIMAGE_TLS_CALLBACK mdb_tls_callback;
3042 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3045 #pragma comment(linker, "/INCLUDE:__tls_used")
3046 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
3047 #pragma data_seg(".CRT$XLB")
3048 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3050 #endif /* WIN 32/64 */
3051 #endif /* !__GNUC__ */
3054 /** Downgrade the exclusive lock on the region back to shared */
3056 mdb_env_share_locks(MDB_env *env, int *excl)
3058 int rc = 0, toggle = mdb_env_pick_meta(env);
3060 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
3065 /* First acquire a shared lock. The Unlock will
3066 * then release the existing exclusive lock.
3068 memset(&ov, 0, sizeof(ov));
3069 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3072 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3078 struct flock lock_info;
3079 /* The shared lock replaces the existing lock */
3080 memset((void *)&lock_info, 0, sizeof(lock_info));
3081 lock_info.l_type = F_RDLCK;
3082 lock_info.l_whence = SEEK_SET;
3083 lock_info.l_start = 0;
3084 lock_info.l_len = 1;
3085 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3086 (rc = ErrCode()) == EINTR) ;
3087 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
3094 /** Try to get exlusive lock, otherwise shared.
3095 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
3098 mdb_env_excl_lock(MDB_env *env, int *excl)
3102 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
3106 memset(&ov, 0, sizeof(ov));
3107 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3114 struct flock lock_info;
3115 memset((void *)&lock_info, 0, sizeof(lock_info));
3116 lock_info.l_type = F_WRLCK;
3117 lock_info.l_whence = SEEK_SET;
3118 lock_info.l_start = 0;
3119 lock_info.l_len = 1;
3120 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3121 (rc = ErrCode()) == EINTR) ;
3125 # ifdef MDB_USE_POSIX_SEM
3126 if (*excl < 0) /* always true when !MDB_USE_POSIX_SEM */
3129 lock_info.l_type = F_RDLCK;
3130 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
3131 (rc = ErrCode()) == EINTR) ;
3139 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
3141 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
3143 * @(#) $Revision: 5.1 $
3144 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
3145 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
3147 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
3151 * Please do not copyright this code. This code is in the public domain.
3153 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
3154 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
3155 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
3156 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
3157 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
3158 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
3159 * PERFORMANCE OF THIS SOFTWARE.
3162 * chongo <Landon Curt Noll> /\oo/\
3163 * http://www.isthe.com/chongo/
3165 * Share and Enjoy! :-)
3168 typedef unsigned long long mdb_hash_t;
3169 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
3171 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
3172 * @param[in] str string to hash
3173 * @param[in] hval initial value for hash
3174 * @return 64 bit hash
3176 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
3177 * hval arg on the first call.
3180 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
3182 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
3183 unsigned char *end = s + val->mv_size;
3185 * FNV-1a hash each octet of the string
3188 /* xor the bottom with the current octet */
3189 hval ^= (mdb_hash_t)*s++;
3191 /* multiply by the 64 bit FNV magic prime mod 2^64 */
3192 hval += (hval << 1) + (hval << 4) + (hval << 5) +
3193 (hval << 7) + (hval << 8) + (hval << 40);
3195 /* return our new hash value */
3199 /** Hash the string and output the hash in hex.
3200 * @param[in] str string to hash
3201 * @param[out] hexbuf an array of 17 chars to hold the hash
3204 mdb_hash_hex(MDB_val *val, char *hexbuf)
3207 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
3208 for (i=0; i<8; i++) {
3209 hexbuf += sprintf(hexbuf, "%02x", (unsigned int)h & 0xff);
3215 /** Open and/or initialize the lock region for the environment.
3216 * @param[in] env The MDB environment.
3217 * @param[in] lpath The pathname of the file used for the lock region.
3218 * @param[in] mode The Unix permissions for the file, if we create it.
3219 * @param[out] excl Resulting file lock type: -1 none, 0 shared, 1 exclusive
3220 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
3221 * @return 0 on success, non-zero on failure.
3224 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
3227 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
3229 # define MDB_ERRCODE_ROFS EROFS
3230 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
3231 # define MDB_CLOEXEC O_CLOEXEC
3234 # define MDB_CLOEXEC 0
3241 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
3242 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
3243 FILE_ATTRIBUTE_NORMAL, NULL);
3245 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
3247 if (env->me_lfd == INVALID_HANDLE_VALUE) {
3249 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
3254 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
3255 /* Lose record locks when exec*() */
3256 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
3257 fcntl(env->me_lfd, F_SETFD, fdflags);
3260 if (!(env->me_flags & MDB_NOTLS)) {
3261 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
3264 env->me_flags |= MDB_ENV_TXKEY;
3266 /* Windows TLS callbacks need help finding their TLS info. */
3267 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
3271 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
3275 /* Try to get exclusive lock. If we succeed, then
3276 * nobody is using the lock region and we should initialize it.
3278 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
3281 size = GetFileSize(env->me_lfd, NULL);
3283 size = lseek(env->me_lfd, 0, SEEK_END);
3285 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
3286 if (size < rsize && *excl > 0) {
3288 SetFilePointer(env->me_lfd, rsize, NULL, 0);
3289 if (!SetEndOfFile(env->me_lfd)) goto fail_errno;
3291 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
3295 size = rsize - sizeof(MDB_txninfo);
3296 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
3301 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
3303 if (!mh) goto fail_errno;
3304 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
3306 if (!env->me_txns) goto fail_errno;
3308 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
3310 if (m == MAP_FAILED) goto fail_errno;
3316 BY_HANDLE_FILE_INFORMATION stbuf;
3325 if (!mdb_sec_inited) {
3326 InitializeSecurityDescriptor(&mdb_null_sd,
3327 SECURITY_DESCRIPTOR_REVISION);
3328 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
3329 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
3330 mdb_all_sa.bInheritHandle = FALSE;
3331 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
3334 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
3335 idbuf.volume = stbuf.dwVolumeSerialNumber;
3336 idbuf.nhigh = stbuf.nFileIndexHigh;
3337 idbuf.nlow = stbuf.nFileIndexLow;
3338 val.mv_data = &idbuf;
3339 val.mv_size = sizeof(idbuf);
3340 mdb_hash_hex(&val, hexbuf);
3341 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", hexbuf);
3342 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", hexbuf);
3343 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
3344 if (!env->me_rmutex) goto fail_errno;
3345 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
3346 if (!env->me_wmutex) goto fail_errno;
3347 #elif defined(MDB_USE_POSIX_SEM)
3356 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
3357 idbuf.dev = stbuf.st_dev;
3358 idbuf.ino = stbuf.st_ino;
3359 val.mv_data = &idbuf;
3360 val.mv_size = sizeof(idbuf);
3361 mdb_hash_hex(&val, hexbuf);
3362 sprintf(env->me_txns->mti_rmname, "/MDBr%s", hexbuf);
3363 sprintf(env->me_txns->mti_wmname, "/MDBw%s", hexbuf);
3364 /* Clean up after a previous run, if needed: Try to
3365 * remove both semaphores before doing anything else.
3367 sem_unlink(env->me_txns->mti_rmname);
3368 sem_unlink(env->me_txns->mti_wmname);
3369 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
3370 O_CREAT|O_EXCL, mode, 1);
3371 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3372 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
3373 O_CREAT|O_EXCL, mode, 1);
3374 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3375 #else /* MDB_USE_POSIX_SEM */
3376 pthread_mutexattr_t mattr;
3378 if ((rc = pthread_mutexattr_init(&mattr))
3379 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
3380 || (rc = pthread_mutex_init(&env->me_txns->mti_mutex, &mattr))
3381 || (rc = pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr)))
3383 pthread_mutexattr_destroy(&mattr);
3384 #endif /* _WIN32 || MDB_USE_POSIX_SEM */
3386 env->me_txns->mti_version = MDB_VERSION;
3387 env->me_txns->mti_magic = MDB_MAGIC;
3388 env->me_txns->mti_txnid = 0;
3389 env->me_txns->mti_numreaders = 0;
3392 if (env->me_txns->mti_magic != MDB_MAGIC) {
3393 DPUTS("lock region has invalid magic");
3397 if (env->me_txns->mti_version != MDB_VERSION) {
3398 DPRINTF("lock region is version %u, expected version %u",
3399 env->me_txns->mti_version, MDB_VERSION);
3400 rc = MDB_VERSION_MISMATCH;
3404 if (rc != EACCES && rc != EAGAIN) {
3408 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
3409 if (!env->me_rmutex) goto fail_errno;
3410 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
3411 if (!env->me_wmutex) goto fail_errno;
3412 #elif defined(MDB_USE_POSIX_SEM)
3413 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
3414 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3415 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
3416 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3427 /** The name of the lock file in the DB environment */
3428 #define LOCKNAME "/lock.mdb"
3429 /** The name of the data file in the DB environment */
3430 #define DATANAME "/data.mdb"
3431 /** The suffix of the lock file when no subdir is used */
3432 #define LOCKSUFF "-lock"
3433 /** Only a subset of the @ref mdb_env flags can be changed
3434 * at runtime. Changing other flags requires closing the
3435 * environment and re-opening it with the new flags.
3437 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC)
3438 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY|MDB_WRITEMAP|MDB_NOTLS)
3441 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
3443 int oflags, rc, len, excl = -1;
3444 char *lpath, *dpath;
3446 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
3450 if (flags & MDB_NOSUBDIR) {
3451 rc = len + sizeof(LOCKSUFF) + len + 1;
3453 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
3458 if (flags & MDB_NOSUBDIR) {
3459 dpath = lpath + len + sizeof(LOCKSUFF);
3460 sprintf(lpath, "%s" LOCKSUFF, path);
3461 strcpy(dpath, path);
3463 dpath = lpath + len + sizeof(LOCKNAME);
3464 sprintf(lpath, "%s" LOCKNAME, path);
3465 sprintf(dpath, "%s" DATANAME, path);
3469 flags |= env->me_flags;
3470 if (flags & MDB_RDONLY) {
3471 /* silently ignore WRITEMAP when we're only getting read access */
3472 flags &= ~MDB_WRITEMAP;
3474 if (!((env->me_free_pgs = mdb_midl_alloc()) &&
3475 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
3478 env->me_flags = flags |= MDB_ENV_ACTIVE;
3482 env->me_path = strdup(path);
3483 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
3484 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
3485 if (!(env->me_dbxs && env->me_path && env->me_dbflags)) {
3490 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
3495 if (F_ISSET(flags, MDB_RDONLY)) {
3496 oflags = GENERIC_READ;
3497 len = OPEN_EXISTING;
3499 oflags = GENERIC_READ|GENERIC_WRITE;
3502 mode = FILE_ATTRIBUTE_NORMAL;
3503 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
3504 NULL, len, mode, NULL);
3506 if (F_ISSET(flags, MDB_RDONLY))
3509 oflags = O_RDWR | O_CREAT;
3511 env->me_fd = open(dpath, oflags, mode);
3513 if (env->me_fd == INVALID_HANDLE_VALUE) {
3518 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
3519 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
3520 env->me_mfd = env->me_fd;
3522 /* Synchronous fd for meta writes. Needed even with
3523 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
3526 env->me_mfd = CreateFile(dpath, oflags,
3527 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
3528 mode | FILE_FLAG_WRITE_THROUGH, NULL);
3530 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
3532 if (env->me_mfd == INVALID_HANDLE_VALUE) {
3537 DPRINTF("opened dbenv %p", (void *) env);
3539 rc = mdb_env_share_locks(env, &excl);
3545 mdb_env_close0(env, excl);
3551 /** Destroy resources from mdb_env_open() and clear our readers */
3553 mdb_env_close0(MDB_env *env, int excl)
3557 if (!(env->me_flags & MDB_ENV_ACTIVE))
3560 free(env->me_dbflags);
3563 free(env->me_dirty_list);
3564 if (env->me_free_pgs)
3565 mdb_midl_free(env->me_free_pgs);
3567 if (env->me_flags & MDB_ENV_TXKEY) {
3568 pthread_key_delete(env->me_txkey);
3570 /* Delete our key from the global list */
3571 for (i=0; i<mdb_tls_nkeys; i++)
3572 if (mdb_tls_keys[i] == env->me_txkey) {
3573 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
3581 munmap(env->me_map, env->me_mapsize);
3583 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
3585 if (env->me_fd != INVALID_HANDLE_VALUE)
3588 pid_t pid = env->me_pid;
3589 /* Clearing readers is done in this function because
3590 * me_txkey with its destructor must be disabled first.
3592 for (i = env->me_numreaders; --i >= 0; )
3593 if (env->me_txns->mti_readers[i].mr_pid == pid)
3594 env->me_txns->mti_readers[i].mr_pid = 0;
3596 if (env->me_rmutex) {
3597 CloseHandle(env->me_rmutex);
3598 if (env->me_wmutex) CloseHandle(env->me_wmutex);
3600 /* Windows automatically destroys the mutexes when
3601 * the last handle closes.
3603 #elif defined(MDB_USE_POSIX_SEM)
3604 if (env->me_rmutex != SEM_FAILED) {
3605 sem_close(env->me_rmutex);
3606 if (env->me_wmutex != SEM_FAILED)
3607 sem_close(env->me_wmutex);
3608 /* If we have the filelock: If we are the
3609 * only remaining user, clean up semaphores.
3612 mdb_env_excl_lock(env, &excl);
3614 sem_unlink(env->me_txns->mti_rmname);
3615 sem_unlink(env->me_txns->mti_wmname);
3619 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
3621 if (env->me_lfd != INVALID_HANDLE_VALUE) {
3624 /* Unlock the lockfile. Windows would have unlocked it
3625 * after closing anyway, but not necessarily at once.
3627 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3633 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
3637 mdb_env_copy(MDB_env *env, const char *path)
3639 MDB_txn *txn = NULL;
3643 HANDLE newfd = INVALID_HANDLE_VALUE;
3645 if (env->me_flags & MDB_NOSUBDIR) {
3646 lpath = (char *)path;
3649 len += sizeof(DATANAME);
3650 lpath = malloc(len);
3653 sprintf(lpath, "%s" DATANAME, path);
3656 /* The destination path must exist, but the destination file must not.
3657 * We don't want the OS to cache the writes, since the source data is
3658 * already in the OS cache.
3661 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
3662 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
3664 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL
3670 if (!(env->me_flags & MDB_NOSUBDIR))
3672 if (newfd == INVALID_HANDLE_VALUE) {
3677 #ifdef F_NOCACHE /* __APPLE__ */
3678 rc = fcntl(newfd, F_NOCACHE, 1);
3685 /* Do the lock/unlock of the reader mutex before starting the
3686 * write txn. Otherwise other read txns could block writers.
3688 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
3693 /* We must start the actual read txn after blocking writers */
3694 mdb_txn_reset0(txn);
3696 /* Temporarily block writers until we snapshot the meta pages */
3699 rc = mdb_txn_renew0(txn);
3701 UNLOCK_MUTEX_W(env);
3706 wsize = env->me_psize * 2;
3710 rc = WriteFile(newfd, env->me_map, wsize, &len, NULL);
3711 rc = (len == wsize) ? MDB_SUCCESS : ErrCode();
3714 rc = write(newfd, env->me_map, wsize);
3715 rc = (rc == (int)wsize) ? MDB_SUCCESS : ErrCode();
3718 UNLOCK_MUTEX_W(env);
3723 ptr = env->me_map + wsize;
3724 wsize = txn->mt_next_pgno * env->me_psize - wsize;
3725 #define MAX_WRITE 2147483648U
3729 if (wsize > MAX_WRITE)
3733 rc = WriteFile(newfd, ptr, w2, &len, NULL);
3734 rc = (len == w2) ? MDB_SUCCESS : ErrCode();
3743 if (wsize > MAX_WRITE)
3747 wres = write(newfd, ptr, w2);
3748 rc = (wres > 0) ? MDB_SUCCESS : ErrCode();
3757 if (newfd != INVALID_HANDLE_VALUE)
3764 mdb_env_close(MDB_env *env)
3772 for (i = env->me_maxdbs; --i > MAIN_DBI; )
3773 free(env->me_dbxs[i].md_name.mv_data);
3775 VGMEMP_DESTROY(env);
3776 while ((dp = env->me_dpages) != NULL) {
3777 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
3778 env->me_dpages = dp->mp_next;
3782 mdb_env_close0(env, 0);
3786 /** Compare two items pointing at aligned size_t's */
3788 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
3790 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
3791 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
3794 /** Compare two items pointing at aligned int's */
3796 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
3798 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
3799 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
3802 /** Compare two items pointing at ints of unknown alignment.
3803 * Nodes and keys are guaranteed to be 2-byte aligned.
3806 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
3808 #if BYTE_ORDER == LITTLE_ENDIAN
3809 unsigned short *u, *c;
3812 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
3813 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
3816 } while(!x && u > (unsigned short *)a->mv_data);
3819 return memcmp(a->mv_data, b->mv_data, a->mv_size);
3823 /** Compare two items lexically */
3825 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
3832 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3838 diff = memcmp(a->mv_data, b->mv_data, len);
3839 return diff ? diff : len_diff<0 ? -1 : len_diff;
3842 /** Compare two items in reverse byte order */
3844 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
3846 const unsigned char *p1, *p2, *p1_lim;
3850 p1_lim = (const unsigned char *)a->mv_data;
3851 p1 = (const unsigned char *)a->mv_data + a->mv_size;
3852 p2 = (const unsigned char *)b->mv_data + b->mv_size;
3854 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3860 while (p1 > p1_lim) {
3861 diff = *--p1 - *--p2;
3865 return len_diff<0 ? -1 : len_diff;
3868 /** Search for key within a page, using binary search.
3869 * Returns the smallest entry larger or equal to the key.
3870 * If exactp is non-null, stores whether the found entry was an exact match
3871 * in *exactp (1 or 0).
3872 * Updates the cursor index with the index of the found entry.
3873 * If no entry larger or equal to the key is found, returns NULL.
3876 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
3878 unsigned int i = 0, nkeys;
3881 MDB_page *mp = mc->mc_pg[mc->mc_top];
3882 MDB_node *node = NULL;
3887 nkeys = NUMKEYS(mp);
3892 COPY_PGNO(pgno, mp->mp_pgno);
3893 DPRINTF("searching %u keys in %s %spage %zu",
3894 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
3901 low = IS_LEAF(mp) ? 0 : 1;
3903 cmp = mc->mc_dbx->md_cmp;
3905 /* Branch pages have no data, so if using integer keys,
3906 * alignment is guaranteed. Use faster mdb_cmp_int.
3908 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
3909 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
3916 nodekey.mv_size = mc->mc_db->md_pad;
3917 node = NODEPTR(mp, 0); /* fake */
3918 while (low <= high) {
3919 i = (low + high) >> 1;
3920 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
3921 rc = cmp(key, &nodekey);
3922 DPRINTF("found leaf index %u [%s], rc = %i",
3923 i, DKEY(&nodekey), rc);
3932 while (low <= high) {
3933 i = (low + high) >> 1;
3935 node = NODEPTR(mp, i);
3936 nodekey.mv_size = NODEKSZ(node);
3937 nodekey.mv_data = NODEKEY(node);
3939 rc = cmp(key, &nodekey);
3942 DPRINTF("found leaf index %u [%s], rc = %i",
3943 i, DKEY(&nodekey), rc);
3945 DPRINTF("found branch index %u [%s -> %zu], rc = %i",
3946 i, DKEY(&nodekey), NODEPGNO(node), rc);
3957 if (rc > 0) { /* Found entry is less than the key. */
3958 i++; /* Skip to get the smallest entry larger than key. */
3960 node = NODEPTR(mp, i);
3963 *exactp = (rc == 0);
3964 /* store the key index */
3965 mc->mc_ki[mc->mc_top] = i;
3967 /* There is no entry larger or equal to the key. */
3970 /* nodeptr is fake for LEAF2 */
3976 mdb_cursor_adjust(MDB_cursor *mc, func)
3980 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
3981 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
3988 /** Pop a page off the top of the cursor's stack. */
3990 mdb_cursor_pop(MDB_cursor *mc)
3993 #ifndef MDB_DEBUG_SKIP
3994 MDB_page *top = mc->mc_pg[mc->mc_top];
4000 DPRINTF("popped page %zu off db %u cursor %p", top->mp_pgno,
4001 mc->mc_dbi, (void *) mc);
4005 /** Push a page onto the top of the cursor's stack. */
4007 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
4009 DPRINTF("pushing page %zu on db %u cursor %p", mp->mp_pgno,
4010 mc->mc_dbi, (void *) mc);
4012 if (mc->mc_snum >= CURSOR_STACK) {
4013 assert(mc->mc_snum < CURSOR_STACK);
4014 return MDB_CURSOR_FULL;
4017 mc->mc_top = mc->mc_snum++;
4018 mc->mc_pg[mc->mc_top] = mp;
4019 mc->mc_ki[mc->mc_top] = 0;
4024 /** Find the address of the page corresponding to a given page number.
4025 * @param[in] txn the transaction for this access.
4026 * @param[in] pgno the page number for the page to retrieve.
4027 * @param[out] ret address of a pointer where the page's address will be stored.
4028 * @return 0 on success, non-zero on failure.
4031 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret)
4035 if (!((txn->mt_flags & MDB_TXN_RDONLY) |
4036 (txn->mt_env->me_flags & MDB_WRITEMAP)))
4040 MDB_ID2L dl = tx2->mt_u.dirty_list;
4042 unsigned x = mdb_mid2l_search(dl, pgno);
4043 if (x <= dl[0].mid && dl[x].mid == pgno) {
4048 } while ((tx2 = tx2->mt_parent) != NULL);
4051 if (pgno < txn->mt_next_pgno) {
4052 p = (MDB_page *)(txn->mt_env->me_map + txn->mt_env->me_psize * pgno);
4054 DPRINTF("page %zu not found", pgno);
4060 return (p != NULL) ? MDB_SUCCESS : MDB_PAGE_NOTFOUND;
4063 /** Search for the page a given key should be in.
4064 * Pushes parent pages on the cursor stack. This function continues a
4065 * search on a cursor that has already been initialized. (Usually by
4066 * #mdb_page_search() but also by #mdb_node_move().)
4067 * @param[in,out] mc the cursor for this operation.
4068 * @param[in] key the key to search for. If NULL, search for the lowest
4069 * page. (This is used by #mdb_cursor_first().)
4070 * @param[in] flags If MDB_PS_MODIFY set, visited pages are updated with new page numbers.
4071 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
4072 * @return 0 on success, non-zero on failure.
4075 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int modify)
4077 MDB_page *mp = mc->mc_pg[mc->mc_top];
4082 while (IS_BRANCH(mp)) {
4086 DPRINTF("branch page %zu has %u keys", mp->mp_pgno, NUMKEYS(mp));
4087 assert(NUMKEYS(mp) > 1);
4088 DPRINTF("found index 0 to page %zu", NODEPGNO(NODEPTR(mp, 0)));
4090 if (key == NULL) /* Initialize cursor to first page. */
4092 else if (key->mv_size > MDB_MAXKEYSIZE && key->mv_data == NULL) {
4093 /* cursor to last page */
4097 node = mdb_node_search(mc, key, &exact);
4099 i = NUMKEYS(mp) - 1;
4101 i = mc->mc_ki[mc->mc_top];
4110 DPRINTF("following index %u for key [%s]",
4112 assert(i < NUMKEYS(mp));
4113 node = NODEPTR(mp, i);
4115 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
4118 mc->mc_ki[mc->mc_top] = i;
4119 if ((rc = mdb_cursor_push(mc, mp)))
4123 if ((rc = mdb_page_touch(mc)) != 0)
4125 mp = mc->mc_pg[mc->mc_top];
4130 DPRINTF("internal error, index points to a %02X page!?",
4132 return MDB_CORRUPTED;
4135 DPRINTF("found leaf page %zu for key [%s]", mp->mp_pgno,
4136 key ? DKEY(key) : NULL);
4141 /** Search for the lowest key under the current branch page.
4142 * This just bypasses a NUMKEYS check in the current page
4143 * before calling mdb_page_search_root(), because the callers
4144 * are all in situations where the current page is known to
4148 mdb_page_search_lowest(MDB_cursor *mc)
4150 MDB_page *mp = mc->mc_pg[mc->mc_top];
4151 MDB_node *node = NODEPTR(mp, 0);
4154 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
4157 mc->mc_ki[mc->mc_top] = 0;
4158 if ((rc = mdb_cursor_push(mc, mp)))
4160 return mdb_page_search_root(mc, NULL, 0);
4163 /** Search for the page a given key should be in.
4164 * Pushes parent pages on the cursor stack. This function just sets up
4165 * the search; it finds the root page for \b mc's database and sets this
4166 * as the root of the cursor's stack. Then #mdb_page_search_root() is
4167 * called to complete the search.
4168 * @param[in,out] mc the cursor for this operation.
4169 * @param[in] key the key to search for. If NULL, search for the lowest
4170 * page. (This is used by #mdb_cursor_first().)
4171 * @param[in] modify If true, visited pages are updated with new page numbers.
4172 * @return 0 on success, non-zero on failure.
4175 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
4180 /* Make sure the txn is still viable, then find the root from
4181 * the txn's db table.
4183 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
4184 DPUTS("transaction has failed, must abort");
4187 /* Make sure we're using an up-to-date root */
4188 if (mc->mc_dbi > MAIN_DBI) {
4189 if ((*mc->mc_dbflag & DB_STALE) ||
4190 ((flags & MDB_PS_MODIFY) && !(*mc->mc_dbflag & DB_DIRTY))) {
4192 unsigned char dbflag = 0;
4193 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
4194 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, flags & MDB_PS_MODIFY);
4197 if (*mc->mc_dbflag & DB_STALE) {
4201 MDB_node *leaf = mdb_node_search(&mc2,
4202 &mc->mc_dbx->md_name, &exact);
4204 return MDB_NOTFOUND;
4205 mdb_node_read(mc->mc_txn, leaf, &data);
4206 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
4208 /* The txn may not know this DBI, or another process may
4209 * have dropped and recreated the DB with other flags.
4211 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
4212 return MDB_INCOMPATIBLE;
4213 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
4215 if (flags & MDB_PS_MODIFY)
4217 *mc->mc_dbflag &= ~DB_STALE;
4218 *mc->mc_dbflag |= dbflag;
4221 root = mc->mc_db->md_root;
4223 if (root == P_INVALID) { /* Tree is empty. */
4224 DPUTS("tree is empty");
4225 return MDB_NOTFOUND;
4230 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
4231 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0])))
4237 DPRINTF("db %u root page %zu has flags 0x%X",
4238 mc->mc_dbi, root, mc->mc_pg[0]->mp_flags);
4240 if (flags & MDB_PS_MODIFY) {
4241 if ((rc = mdb_page_touch(mc)))
4245 if (flags & MDB_PS_ROOTONLY)
4248 return mdb_page_search_root(mc, key, flags);
4251 /** Return the data associated with a given node.
4252 * @param[in] txn The transaction for this operation.
4253 * @param[in] leaf The node being read.
4254 * @param[out] data Updated to point to the node's data.
4255 * @return 0 on success, non-zero on failure.
4258 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
4260 MDB_page *omp; /* overflow page */
4264 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
4265 data->mv_size = NODEDSZ(leaf);
4266 data->mv_data = NODEDATA(leaf);
4270 /* Read overflow data.
4272 data->mv_size = NODEDSZ(leaf);
4273 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
4274 if ((rc = mdb_page_get(txn, pgno, &omp))) {
4275 DPRINTF("read overflow page %zu failed", pgno);
4278 data->mv_data = METADATA(omp);
4284 mdb_get(MDB_txn *txn, MDB_dbi dbi,
4285 MDB_val *key, MDB_val *data)
4294 DPRINTF("===> get db %u key [%s]", dbi, DKEY(key));
4296 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
4299 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4303 mdb_cursor_init(&mc, txn, dbi, &mx);
4304 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
4307 /** Find a sibling for a page.
4308 * Replaces the page at the top of the cursor's stack with the
4309 * specified sibling, if one exists.
4310 * @param[in] mc The cursor for this operation.
4311 * @param[in] move_right Non-zero if the right sibling is requested,
4312 * otherwise the left sibling.
4313 * @return 0 on success, non-zero on failure.
4316 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
4322 if (mc->mc_snum < 2) {
4323 return MDB_NOTFOUND; /* root has no siblings */
4327 DPRINTF("parent page is page %zu, index %u",
4328 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]);
4330 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
4331 : (mc->mc_ki[mc->mc_top] == 0)) {
4332 DPRINTF("no more keys left, moving to %s sibling",
4333 move_right ? "right" : "left");
4334 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
4335 /* undo cursor_pop before returning */
4342 mc->mc_ki[mc->mc_top]++;
4344 mc->mc_ki[mc->mc_top]--;
4345 DPRINTF("just moving to %s index key %u",
4346 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]);
4348 assert(IS_BRANCH(mc->mc_pg[mc->mc_top]));
4350 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4351 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp)))
4354 mdb_cursor_push(mc, mp);
4356 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
4361 /** Move the cursor to the next data item. */
4363 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4369 if (mc->mc_flags & C_EOF) {
4370 return MDB_NOTFOUND;
4373 assert(mc->mc_flags & C_INITIALIZED);
4375 mp = mc->mc_pg[mc->mc_top];
4377 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4378 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4379 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4380 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
4381 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
4382 if (op != MDB_NEXT || rc == MDB_SUCCESS)
4386 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4387 if (op == MDB_NEXT_DUP)
4388 return MDB_NOTFOUND;
4392 DPRINTF("cursor_next: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4394 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
4395 DPUTS("=====> move to next sibling page");
4396 if (mdb_cursor_sibling(mc, 1) != MDB_SUCCESS) {
4397 mc->mc_flags |= C_EOF;
4398 mc->mc_flags &= ~C_INITIALIZED;
4399 return MDB_NOTFOUND;
4401 mp = mc->mc_pg[mc->mc_top];
4402 DPRINTF("next page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4404 mc->mc_ki[mc->mc_top]++;
4406 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4407 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4410 key->mv_size = mc->mc_db->md_pad;
4411 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4415 assert(IS_LEAF(mp));
4416 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4418 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4419 mdb_xcursor_init1(mc, leaf);
4422 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4425 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4426 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4427 if (rc != MDB_SUCCESS)
4432 MDB_GET_KEY(leaf, key);
4436 /** Move the cursor to the previous data item. */
4438 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4444 assert(mc->mc_flags & C_INITIALIZED);
4446 mp = mc->mc_pg[mc->mc_top];
4448 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4449 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4450 if (op == MDB_PREV || op == MDB_PREV_DUP) {
4451 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4452 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
4453 if (op != MDB_PREV || rc == MDB_SUCCESS)
4456 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4457 if (op == MDB_PREV_DUP)
4458 return MDB_NOTFOUND;
4463 DPRINTF("cursor_prev: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4465 if (mc->mc_ki[mc->mc_top] == 0) {
4466 DPUTS("=====> move to prev sibling page");
4467 if (mdb_cursor_sibling(mc, 0) != MDB_SUCCESS) {
4468 mc->mc_flags &= ~C_INITIALIZED;
4469 return MDB_NOTFOUND;
4471 mp = mc->mc_pg[mc->mc_top];
4472 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
4473 DPRINTF("prev page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4475 mc->mc_ki[mc->mc_top]--;
4477 mc->mc_flags &= ~C_EOF;
4479 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4480 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4483 key->mv_size = mc->mc_db->md_pad;
4484 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4488 assert(IS_LEAF(mp));
4489 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4491 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4492 mdb_xcursor_init1(mc, leaf);
4495 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4498 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4499 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4500 if (rc != MDB_SUCCESS)
4505 MDB_GET_KEY(leaf, key);
4509 /** Set the cursor on a specific data item. */
4511 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4512 MDB_cursor_op op, int *exactp)
4516 MDB_node *leaf = NULL;
4521 assert(key->mv_size > 0);
4523 /* See if we're already on the right page */
4524 if (mc->mc_flags & C_INITIALIZED) {
4527 mp = mc->mc_pg[mc->mc_top];
4529 mc->mc_ki[mc->mc_top] = 0;
4530 return MDB_NOTFOUND;
4532 if (mp->mp_flags & P_LEAF2) {
4533 nodekey.mv_size = mc->mc_db->md_pad;
4534 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
4536 leaf = NODEPTR(mp, 0);
4537 MDB_GET_KEY(leaf, &nodekey);
4539 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4541 /* Probably happens rarely, but first node on the page
4542 * was the one we wanted.
4544 mc->mc_ki[mc->mc_top] = 0;
4551 unsigned int nkeys = NUMKEYS(mp);
4553 if (mp->mp_flags & P_LEAF2) {
4554 nodekey.mv_data = LEAF2KEY(mp,
4555 nkeys-1, nodekey.mv_size);
4557 leaf = NODEPTR(mp, nkeys-1);
4558 MDB_GET_KEY(leaf, &nodekey);
4560 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4562 /* last node was the one we wanted */
4563 mc->mc_ki[mc->mc_top] = nkeys-1;
4569 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
4570 /* This is definitely the right page, skip search_page */
4571 if (mp->mp_flags & P_LEAF2) {
4572 nodekey.mv_data = LEAF2KEY(mp,
4573 mc->mc_ki[mc->mc_top], nodekey.mv_size);
4575 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4576 MDB_GET_KEY(leaf, &nodekey);
4578 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4580 /* current node was the one we wanted */
4590 /* If any parents have right-sibs, search.
4591 * Otherwise, there's nothing further.
4593 for (i=0; i<mc->mc_top; i++)
4595 NUMKEYS(mc->mc_pg[i])-1)
4597 if (i == mc->mc_top) {
4598 /* There are no other pages */
4599 mc->mc_ki[mc->mc_top] = nkeys;
4600 return MDB_NOTFOUND;
4604 /* There are no other pages */
4605 mc->mc_ki[mc->mc_top] = 0;
4606 return MDB_NOTFOUND;
4610 rc = mdb_page_search(mc, key, 0);
4611 if (rc != MDB_SUCCESS)
4614 mp = mc->mc_pg[mc->mc_top];
4615 assert(IS_LEAF(mp));
4618 leaf = mdb_node_search(mc, key, exactp);
4619 if (exactp != NULL && !*exactp) {
4620 /* MDB_SET specified and not an exact match. */
4621 return MDB_NOTFOUND;
4625 DPUTS("===> inexact leaf not found, goto sibling");
4626 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
4627 return rc; /* no entries matched */
4628 mp = mc->mc_pg[mc->mc_top];
4629 assert(IS_LEAF(mp));
4630 leaf = NODEPTR(mp, 0);
4634 mc->mc_flags |= C_INITIALIZED;
4635 mc->mc_flags &= ~C_EOF;
4638 key->mv_size = mc->mc_db->md_pad;
4639 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4643 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4644 mdb_xcursor_init1(mc, leaf);
4647 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4648 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
4649 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4652 if (op == MDB_GET_BOTH) {
4658 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
4659 if (rc != MDB_SUCCESS)
4662 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
4664 if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
4666 rc = mc->mc_dbx->md_dcmp(data, &d2);
4668 if (op == MDB_GET_BOTH || rc > 0)
4669 return MDB_NOTFOUND;
4674 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4675 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4680 /* The key already matches in all other cases */
4681 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
4682 MDB_GET_KEY(leaf, key);
4683 DPRINTF("==> cursor placed on key [%s]", DKEY(key));
4688 /** Move the cursor to the first item in the database. */
4690 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4695 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4696 rc = mdb_page_search(mc, NULL, 0);
4697 if (rc != MDB_SUCCESS)
4700 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4702 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
4703 mc->mc_flags |= C_INITIALIZED;
4704 mc->mc_flags &= ~C_EOF;
4706 mc->mc_ki[mc->mc_top] = 0;
4708 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4709 key->mv_size = mc->mc_db->md_pad;
4710 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
4715 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4716 mdb_xcursor_init1(mc, leaf);
4717 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4722 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4723 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4727 MDB_GET_KEY(leaf, key);
4731 /** Move the cursor to the last item in the database. */
4733 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4738 if (!(mc->mc_flags & C_EOF)) {
4740 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4743 lkey.mv_size = MDB_MAXKEYSIZE+1;
4744 lkey.mv_data = NULL;
4745 rc = mdb_page_search(mc, &lkey, 0);
4746 if (rc != MDB_SUCCESS)
4749 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4752 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
4753 mc->mc_flags |= C_INITIALIZED|C_EOF;
4754 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4756 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4757 key->mv_size = mc->mc_db->md_pad;
4758 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
4763 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4764 mdb_xcursor_init1(mc, leaf);
4765 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4770 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4771 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4776 MDB_GET_KEY(leaf, key);
4781 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4790 case MDB_GET_CURRENT:
4791 if (!(mc->mc_flags & C_INITIALIZED)) {
4794 MDB_page *mp = mc->mc_pg[mc->mc_top];
4796 mc->mc_ki[mc->mc_top] = 0;
4802 key->mv_size = mc->mc_db->md_pad;
4803 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4805 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4806 MDB_GET_KEY(leaf, key);
4808 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4809 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
4811 rc = mdb_node_read(mc->mc_txn, leaf, data);
4818 case MDB_GET_BOTH_RANGE:
4819 if (data == NULL || mc->mc_xcursor == NULL) {
4827 if (key == NULL || key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4829 } else if (op == MDB_SET_RANGE)
4830 rc = mdb_cursor_set(mc, key, data, op, NULL);
4832 rc = mdb_cursor_set(mc, key, data, op, &exact);
4834 case MDB_GET_MULTIPLE:
4836 !(mc->mc_db->md_flags & MDB_DUPFIXED) ||
4837 !(mc->mc_flags & C_INITIALIZED)) {
4842 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
4843 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
4846 case MDB_NEXT_MULTIPLE:
4848 !(mc->mc_db->md_flags & MDB_DUPFIXED)) {
4852 if (!(mc->mc_flags & C_INITIALIZED))
4853 rc = mdb_cursor_first(mc, key, data);
4855 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
4856 if (rc == MDB_SUCCESS) {
4857 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
4860 mx = &mc->mc_xcursor->mx_cursor;
4861 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
4863 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
4864 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
4872 case MDB_NEXT_NODUP:
4873 if (!(mc->mc_flags & C_INITIALIZED))
4874 rc = mdb_cursor_first(mc, key, data);
4876 rc = mdb_cursor_next(mc, key, data, op);
4880 case MDB_PREV_NODUP:
4881 if (!(mc->mc_flags & C_INITIALIZED)) {
4882 rc = mdb_cursor_last(mc, key, data);
4883 mc->mc_flags |= C_INITIALIZED;
4884 mc->mc_ki[mc->mc_top]++;
4886 rc = mdb_cursor_prev(mc, key, data, op);
4889 rc = mdb_cursor_first(mc, key, data);
4893 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4894 !(mc->mc_flags & C_INITIALIZED) ||
4895 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4899 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4902 rc = mdb_cursor_last(mc, key, data);
4906 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4907 !(mc->mc_flags & C_INITIALIZED) ||
4908 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4912 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4915 DPRINTF("unhandled/unimplemented cursor operation %u", op);
4923 /** Touch all the pages in the cursor stack.
4924 * Makes sure all the pages are writable, before attempting a write operation.
4925 * @param[in] mc The cursor to operate on.
4928 mdb_cursor_touch(MDB_cursor *mc)
4932 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
4935 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, &mcx);
4936 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
4939 *mc->mc_dbflag |= DB_DIRTY;
4941 for (mc->mc_top = 0; mc->mc_top < mc->mc_snum; mc->mc_top++) {
4942 rc = mdb_page_touch(mc);
4946 mc->mc_top = mc->mc_snum-1;
4951 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4954 MDB_node *leaf = NULL;
4955 MDB_val xdata, *rdata, dkey;
4958 int do_sub = 0, insert = 0;
4959 unsigned int mcount = 0;
4963 char dbuf[MDB_MAXKEYSIZE+1];
4964 unsigned int nflags;
4967 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4970 if (flags != MDB_CURRENT && (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE))
4973 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT) && data->mv_size > MDB_MAXKEYSIZE)
4976 #if SIZE_MAX > MAXDATASIZE
4977 if (data->mv_size > MAXDATASIZE)
4981 DPRINTF("==> put db %u key [%s], size %zu, data size %zu",
4982 mc->mc_dbi, DKEY(key), key ? key->mv_size:0, data->mv_size);
4986 if (flags == MDB_CURRENT) {
4987 if (!(mc->mc_flags & C_INITIALIZED))
4990 } else if (mc->mc_db->md_root == P_INVALID) {
4992 /* new database, write a root leaf page */
4993 DPUTS("allocating new root leaf page");
4994 if ((rc = mdb_page_new(mc, P_LEAF, 1, &np))) {
4998 mdb_cursor_push(mc, np);
4999 mc->mc_db->md_root = np->mp_pgno;
5000 mc->mc_db->md_depth++;
5001 *mc->mc_dbflag |= DB_DIRTY;
5002 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
5004 np->mp_flags |= P_LEAF2;
5005 mc->mc_flags |= C_INITIALIZED;
5011 if (flags & MDB_APPEND) {
5013 rc = mdb_cursor_last(mc, &k2, &d2);
5015 rc = mc->mc_dbx->md_cmp(key, &k2);
5018 mc->mc_ki[mc->mc_top]++;
5020 /* new key is <= last key */
5025 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
5027 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
5028 DPRINTF("duplicate key [%s]", DKEY(key));
5030 return MDB_KEYEXIST;
5032 if (rc && rc != MDB_NOTFOUND)
5036 /* Cursor is positioned, now make sure all pages are writable */
5037 rc2 = mdb_cursor_touch(mc);
5042 /* The key already exists */
5043 if (rc == MDB_SUCCESS) {
5044 /* there's only a key anyway, so this is a no-op */
5045 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5046 unsigned int ksize = mc->mc_db->md_pad;
5047 if (key->mv_size != ksize)
5049 if (flags == MDB_CURRENT) {
5050 char *ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
5051 memcpy(ptr, key->mv_data, ksize);
5056 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5059 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
5060 /* Was a single item before, must convert now */
5062 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5063 /* Just overwrite the current item */
5064 if (flags == MDB_CURRENT)
5067 dkey.mv_size = NODEDSZ(leaf);
5068 dkey.mv_data = NODEDATA(leaf);
5069 #if UINT_MAX < SIZE_MAX
5070 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && dkey.mv_size == sizeof(size_t))
5071 #ifdef MISALIGNED_OK
5072 mc->mc_dbx->md_dcmp = mdb_cmp_long;
5074 mc->mc_dbx->md_dcmp = mdb_cmp_cint;
5077 /* if data matches, ignore it */
5078 if (!mc->mc_dbx->md_dcmp(data, &dkey))
5079 return (flags == MDB_NODUPDATA) ? MDB_KEYEXIST : MDB_SUCCESS;
5081 /* create a fake page for the dup items */
5082 memcpy(dbuf, dkey.mv_data, dkey.mv_size);
5083 dkey.mv_data = dbuf;
5084 fp = (MDB_page *)&pbuf;
5085 fp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5086 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
5087 fp->mp_lower = PAGEHDRSZ;
5088 fp->mp_upper = PAGEHDRSZ + dkey.mv_size + data->mv_size;
5089 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5090 fp->mp_flags |= P_LEAF2;
5091 fp->mp_pad = data->mv_size;
5092 fp->mp_upper += 2 * data->mv_size; /* leave space for 2 more */
5094 fp->mp_upper += 2 * sizeof(indx_t) + 2 * NODESIZE +
5095 (dkey.mv_size & 1) + (data->mv_size & 1);
5097 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5100 xdata.mv_size = fp->mp_upper;
5105 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5106 /* See if we need to convert from fake page to subDB */
5108 unsigned int offset;
5111 fp = NODEDATA(leaf);
5112 if (flags == MDB_CURRENT) {
5114 fp->mp_flags |= P_DIRTY;
5115 COPY_PGNO(fp->mp_pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5116 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
5120 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5121 offset = fp->mp_pad;
5122 if (SIZELEFT(fp) >= offset)
5124 offset *= 4; /* space for 4 more */
5126 offset = NODESIZE + sizeof(indx_t) + data->mv_size;
5128 offset += offset & 1;
5129 if (NODESIZE + sizeof(indx_t) + NODEKSZ(leaf) + NODEDSZ(leaf) +
5130 offset >= mc->mc_txn->mt_env->me_nodemax) {
5131 /* yes, convert it */
5133 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5134 dummy.md_pad = fp->mp_pad;
5135 dummy.md_flags = MDB_DUPFIXED;
5136 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5137 dummy.md_flags |= MDB_INTEGERKEY;
5140 dummy.md_branch_pages = 0;
5141 dummy.md_leaf_pages = 1;
5142 dummy.md_overflow_pages = 0;
5143 dummy.md_entries = NUMKEYS(fp);
5145 xdata.mv_size = sizeof(MDB_db);
5146 xdata.mv_data = &dummy;
5147 if ((rc = mdb_page_alloc(mc, 1, &mp)))
5149 offset = mc->mc_txn->mt_env->me_psize - NODEDSZ(leaf);
5150 flags |= F_DUPDATA|F_SUBDATA;
5151 dummy.md_root = mp->mp_pgno;
5153 /* no, just grow it */
5155 xdata.mv_size = NODEDSZ(leaf) + offset;
5156 xdata.mv_data = &pbuf;
5157 mp = (MDB_page *)&pbuf;
5158 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5161 mp->mp_flags = fp->mp_flags | P_DIRTY;
5162 mp->mp_pad = fp->mp_pad;
5163 mp->mp_lower = fp->mp_lower;
5164 mp->mp_upper = fp->mp_upper + offset;
5166 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
5168 nsize = NODEDSZ(leaf) - fp->mp_upper;
5169 memcpy((char *)mp + mp->mp_upper, (char *)fp + fp->mp_upper, nsize);
5170 for (i=0; i<NUMKEYS(fp); i++)
5171 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
5173 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5177 /* data is on sub-DB, just store it */
5178 flags |= F_DUPDATA|F_SUBDATA;
5182 /* overflow page overwrites need special handling */
5183 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5186 int ovpages, dpages;
5188 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
5189 dpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
5190 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
5191 mdb_page_get(mc->mc_txn, pg, &omp);
5192 /* Is the ov page writable and large enough? */
5193 if ((omp->mp_flags & P_DIRTY) && ovpages >= dpages) {
5194 /* yes, overwrite it. Note in this case we don't
5195 * bother to try shrinking the node if the new data
5196 * is smaller than the overflow threshold.
5198 if (F_ISSET(flags, MDB_RESERVE))
5199 data->mv_data = METADATA(omp);
5201 memcpy(METADATA(omp), data->mv_data, data->mv_size);
5204 /* no, free ovpages */
5206 mc->mc_db->md_overflow_pages -= ovpages;
5207 for (i=0; i<ovpages; i++) {
5208 DPRINTF("freed ov page %zu", pg);
5209 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
5213 } else if (NODEDSZ(leaf) == data->mv_size) {
5214 /* same size, just replace it. Note that we could
5215 * also reuse this node if the new data is smaller,
5216 * but instead we opt to shrink the node in that case.
5218 if (F_ISSET(flags, MDB_RESERVE))
5219 data->mv_data = NODEDATA(leaf);
5220 else if (data->mv_size)
5221 memcpy(NODEDATA(leaf), data->mv_data, data->mv_size);
5223 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
5226 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5227 mc->mc_db->md_entries--;
5229 DPRINTF("inserting key at index %i", mc->mc_ki[mc->mc_top]);
5236 nflags = flags & NODE_ADD_FLAGS;
5237 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(mc->mc_txn->mt_env, key, rdata);
5238 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
5239 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
5240 nflags &= ~MDB_APPEND;
5242 nflags |= MDB_SPLIT_REPLACE;
5243 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
5245 /* There is room already in this leaf page. */
5246 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
5247 if (rc == 0 && !do_sub && insert) {
5248 /* Adjust other cursors pointing to mp */
5249 MDB_cursor *m2, *m3;
5250 MDB_dbi dbi = mc->mc_dbi;
5251 unsigned i = mc->mc_top;
5252 MDB_page *mp = mc->mc_pg[i];
5254 if (mc->mc_flags & C_SUB)
5257 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5258 if (mc->mc_flags & C_SUB)
5259 m3 = &m2->mc_xcursor->mx_cursor;
5262 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
5263 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
5270 if (rc != MDB_SUCCESS)
5271 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5273 /* Now store the actual data in the child DB. Note that we're
5274 * storing the user data in the keys field, so there are strict
5275 * size limits on dupdata. The actual data fields of the child
5276 * DB are all zero size.
5283 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5284 if (flags & MDB_CURRENT) {
5285 xflags = MDB_CURRENT;
5287 mdb_xcursor_init1(mc, leaf);
5288 xflags = (flags & MDB_NODUPDATA) ? MDB_NOOVERWRITE : 0;
5290 /* converted, write the original data first */
5292 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
5296 /* Adjust other cursors pointing to mp */
5298 unsigned i = mc->mc_top;
5299 MDB_page *mp = mc->mc_pg[i];
5301 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5302 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
5303 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
5304 mdb_xcursor_init1(m2, leaf);
5308 /* we've done our job */
5311 if (flags & MDB_APPENDDUP)
5312 xflags |= MDB_APPEND;
5313 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
5314 if (flags & F_SUBDATA) {
5315 void *db = NODEDATA(leaf);
5316 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5319 /* sub-writes might have failed so check rc again.
5320 * Don't increment count if we just replaced an existing item.
5322 if (!rc && !(flags & MDB_CURRENT))
5323 mc->mc_db->md_entries++;
5324 if (flags & MDB_MULTIPLE) {
5326 if (mcount < data[1].mv_size) {
5327 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
5328 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5334 /* If we succeeded and the key didn't exist before, make sure
5335 * the cursor is marked valid.
5338 mc->mc_flags |= C_INITIALIZED;
5343 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
5348 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
5351 if (!(mc->mc_flags & C_INITIALIZED))
5354 rc = mdb_cursor_touch(mc);
5358 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5360 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5361 if (flags != MDB_NODUPDATA) {
5362 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5363 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
5365 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, 0);
5366 /* If sub-DB still has entries, we're done */
5367 if (mc->mc_xcursor->mx_db.md_entries) {
5368 if (leaf->mn_flags & F_SUBDATA) {
5369 /* update subDB info */
5370 void *db = NODEDATA(leaf);
5371 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5373 /* shrink fake page */
5374 mdb_node_shrink(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5376 mc->mc_db->md_entries--;
5379 /* otherwise fall thru and delete the sub-DB */
5382 if (leaf->mn_flags & F_SUBDATA) {
5383 /* add all the child DB's pages to the free list */
5384 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
5385 if (rc == MDB_SUCCESS) {
5386 mc->mc_db->md_entries -=
5387 mc->mc_xcursor->mx_db.md_entries;
5392 return mdb_cursor_del0(mc, leaf);
5395 /** Allocate and initialize new pages for a database.
5396 * @param[in] mc a cursor on the database being added to.
5397 * @param[in] flags flags defining what type of page is being allocated.
5398 * @param[in] num the number of pages to allocate. This is usually 1,
5399 * unless allocating overflow pages for a large record.
5400 * @param[out] mp Address of a page, or NULL on failure.
5401 * @return 0 on success, non-zero on failure.
5404 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
5409 if ((rc = mdb_page_alloc(mc, num, &np)))
5411 DPRINTF("allocated new mpage %zu, page size %u",
5412 np->mp_pgno, mc->mc_txn->mt_env->me_psize);
5413 np->mp_flags = flags | P_DIRTY;
5414 np->mp_lower = PAGEHDRSZ;
5415 np->mp_upper = mc->mc_txn->mt_env->me_psize;
5418 mc->mc_db->md_branch_pages++;
5419 else if (IS_LEAF(np))
5420 mc->mc_db->md_leaf_pages++;
5421 else if (IS_OVERFLOW(np)) {
5422 mc->mc_db->md_overflow_pages += num;
5430 /** Calculate the size of a leaf node.
5431 * The size depends on the environment's page size; if a data item
5432 * is too large it will be put onto an overflow page and the node
5433 * size will only include the key and not the data. Sizes are always
5434 * rounded up to an even number of bytes, to guarantee 2-byte alignment
5435 * of the #MDB_node headers.
5436 * @param[in] env The environment handle.
5437 * @param[in] key The key for the node.
5438 * @param[in] data The data for the node.
5439 * @return The number of bytes needed to store the node.
5442 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
5446 sz = LEAFSIZE(key, data);
5447 if (sz >= env->me_nodemax) {
5448 /* put on overflow page */
5449 sz -= data->mv_size - sizeof(pgno_t);
5453 return sz + sizeof(indx_t);
5456 /** Calculate the size of a branch node.
5457 * The size should depend on the environment's page size but since
5458 * we currently don't support spilling large keys onto overflow
5459 * pages, it's simply the size of the #MDB_node header plus the
5460 * size of the key. Sizes are always rounded up to an even number
5461 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
5462 * @param[in] env The environment handle.
5463 * @param[in] key The key for the node.
5464 * @return The number of bytes needed to store the node.
5467 mdb_branch_size(MDB_env *env, MDB_val *key)
5472 if (sz >= env->me_nodemax) {
5473 /* put on overflow page */
5474 /* not implemented */
5475 /* sz -= key->size - sizeof(pgno_t); */
5478 return sz + sizeof(indx_t);
5481 /** Add a node to the page pointed to by the cursor.
5482 * @param[in] mc The cursor for this operation.
5483 * @param[in] indx The index on the page where the new node should be added.
5484 * @param[in] key The key for the new node.
5485 * @param[in] data The data for the new node, if any.
5486 * @param[in] pgno The page number, if adding a branch node.
5487 * @param[in] flags Flags for the node.
5488 * @return 0 on success, non-zero on failure. Possible errors are:
5490 * <li>ENOMEM - failed to allocate overflow pages for the node.
5491 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
5492 * should never happen since all callers already calculate the
5493 * page's free space before calling this function.
5497 mdb_node_add(MDB_cursor *mc, indx_t indx,
5498 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
5501 size_t node_size = NODESIZE;
5504 MDB_page *mp = mc->mc_pg[mc->mc_top];
5505 MDB_page *ofp = NULL; /* overflow page */
5508 assert(mp->mp_upper >= mp->mp_lower);
5510 DPRINTF("add to %s %spage %zu index %i, data size %zu key size %zu [%s]",
5511 IS_LEAF(mp) ? "leaf" : "branch",
5512 IS_SUBP(mp) ? "sub-" : "",
5513 mp->mp_pgno, indx, data ? data->mv_size : 0,
5514 key ? key->mv_size : 0, key ? DKEY(key) : NULL);
5517 /* Move higher keys up one slot. */
5518 int ksize = mc->mc_db->md_pad, dif;
5519 char *ptr = LEAF2KEY(mp, indx, ksize);
5520 dif = NUMKEYS(mp) - indx;
5522 memmove(ptr+ksize, ptr, dif*ksize);
5523 /* insert new key */
5524 memcpy(ptr, key->mv_data, ksize);
5526 /* Just using these for counting */
5527 mp->mp_lower += sizeof(indx_t);
5528 mp->mp_upper -= ksize - sizeof(indx_t);
5533 node_size += key->mv_size;
5537 if (F_ISSET(flags, F_BIGDATA)) {
5538 /* Data already on overflow page. */
5539 node_size += sizeof(pgno_t);
5540 } else if (node_size + data->mv_size >= mc->mc_txn->mt_env->me_nodemax) {
5541 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
5543 /* Put data on overflow page. */
5544 DPRINTF("data size is %zu, node would be %zu, put data on overflow page",
5545 data->mv_size, node_size+data->mv_size);
5546 node_size += sizeof(pgno_t);
5547 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
5549 DPRINTF("allocated overflow page %zu", ofp->mp_pgno);
5552 node_size += data->mv_size;
5555 node_size += node_size & 1;
5557 if (node_size + sizeof(indx_t) > SIZELEFT(mp)) {
5558 DPRINTF("not enough room in page %zu, got %u ptrs",
5559 mp->mp_pgno, NUMKEYS(mp));
5560 DPRINTF("upper - lower = %u - %u = %u", mp->mp_upper, mp->mp_lower,
5561 mp->mp_upper - mp->mp_lower);
5562 DPRINTF("node size = %zu", node_size);
5563 return MDB_PAGE_FULL;
5566 /* Move higher pointers up one slot. */
5567 for (i = NUMKEYS(mp); i > indx; i--)
5568 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
5570 /* Adjust free space offsets. */
5571 ofs = mp->mp_upper - node_size;
5572 assert(ofs >= mp->mp_lower + sizeof(indx_t));
5573 mp->mp_ptrs[indx] = ofs;
5575 mp->mp_lower += sizeof(indx_t);
5577 /* Write the node data. */
5578 node = NODEPTR(mp, indx);
5579 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
5580 node->mn_flags = flags;
5582 SETDSZ(node,data->mv_size);
5587 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
5592 if (F_ISSET(flags, F_BIGDATA))
5593 memcpy(node->mn_data + key->mv_size, data->mv_data,
5595 else if (F_ISSET(flags, MDB_RESERVE))
5596 data->mv_data = node->mn_data + key->mv_size;
5598 memcpy(node->mn_data + key->mv_size, data->mv_data,
5601 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
5603 if (F_ISSET(flags, MDB_RESERVE))
5604 data->mv_data = METADATA(ofp);
5606 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
5613 /** Delete the specified node from a page.
5614 * @param[in] mp The page to operate on.
5615 * @param[in] indx The index of the node to delete.
5616 * @param[in] ksize The size of a node. Only used if the page is
5617 * part of a #MDB_DUPFIXED database.
5620 mdb_node_del(MDB_page *mp, indx_t indx, int ksize)
5623 indx_t i, j, numkeys, ptr;
5630 COPY_PGNO(pgno, mp->mp_pgno);
5631 DPRINTF("delete node %u on %s page %zu", indx,
5632 IS_LEAF(mp) ? "leaf" : "branch", pgno);
5635 assert(indx < NUMKEYS(mp));
5638 int x = NUMKEYS(mp) - 1 - indx;
5639 base = LEAF2KEY(mp, indx, ksize);
5641 memmove(base, base + ksize, x * ksize);
5642 mp->mp_lower -= sizeof(indx_t);
5643 mp->mp_upper += ksize - sizeof(indx_t);
5647 node = NODEPTR(mp, indx);
5648 sz = NODESIZE + node->mn_ksize;
5650 if (F_ISSET(node->mn_flags, F_BIGDATA))
5651 sz += sizeof(pgno_t);
5653 sz += NODEDSZ(node);
5657 ptr = mp->mp_ptrs[indx];
5658 numkeys = NUMKEYS(mp);
5659 for (i = j = 0; i < numkeys; i++) {
5661 mp->mp_ptrs[j] = mp->mp_ptrs[i];
5662 if (mp->mp_ptrs[i] < ptr)
5663 mp->mp_ptrs[j] += sz;
5668 base = (char *)mp + mp->mp_upper;
5669 memmove(base + sz, base, ptr - mp->mp_upper);
5671 mp->mp_lower -= sizeof(indx_t);
5675 /** Compact the main page after deleting a node on a subpage.
5676 * @param[in] mp The main page to operate on.
5677 * @param[in] indx The index of the subpage on the main page.
5680 mdb_node_shrink(MDB_page *mp, indx_t indx)
5687 indx_t i, numkeys, ptr;
5689 node = NODEPTR(mp, indx);
5690 sp = (MDB_page *)NODEDATA(node);
5691 osize = NODEDSZ(node);
5693 delta = sp->mp_upper - sp->mp_lower;
5694 SETDSZ(node, osize - delta);
5695 xp = (MDB_page *)((char *)sp + delta);
5697 /* shift subpage upward */
5699 nsize = NUMKEYS(sp) * sp->mp_pad;
5700 memmove(METADATA(xp), METADATA(sp), nsize);
5703 nsize = osize - sp->mp_upper;
5704 numkeys = NUMKEYS(sp);
5705 for (i=numkeys-1; i>=0; i--)
5706 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
5708 xp->mp_upper = sp->mp_lower;
5709 xp->mp_lower = sp->mp_lower;
5710 xp->mp_flags = sp->mp_flags;
5711 xp->mp_pad = sp->mp_pad;
5712 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
5714 /* shift lower nodes upward */
5715 ptr = mp->mp_ptrs[indx];
5716 numkeys = NUMKEYS(mp);
5717 for (i = 0; i < numkeys; i++) {
5718 if (mp->mp_ptrs[i] <= ptr)
5719 mp->mp_ptrs[i] += delta;
5722 base = (char *)mp + mp->mp_upper;
5723 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
5724 mp->mp_upper += delta;
5727 /** Initial setup of a sorted-dups cursor.
5728 * Sorted duplicates are implemented as a sub-database for the given key.
5729 * The duplicate data items are actually keys of the sub-database.
5730 * Operations on the duplicate data items are performed using a sub-cursor
5731 * initialized when the sub-database is first accessed. This function does
5732 * the preliminary setup of the sub-cursor, filling in the fields that
5733 * depend only on the parent DB.
5734 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5737 mdb_xcursor_init0(MDB_cursor *mc)
5739 MDB_xcursor *mx = mc->mc_xcursor;
5741 mx->mx_cursor.mc_xcursor = NULL;
5742 mx->mx_cursor.mc_txn = mc->mc_txn;
5743 mx->mx_cursor.mc_db = &mx->mx_db;
5744 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
5745 mx->mx_cursor.mc_dbi = mc->mc_dbi+1;
5746 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
5747 mx->mx_cursor.mc_snum = 0;
5748 mx->mx_cursor.mc_top = 0;
5749 mx->mx_cursor.mc_flags = C_SUB;
5750 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
5751 mx->mx_dbx.md_dcmp = NULL;
5752 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
5755 /** Final setup of a sorted-dups cursor.
5756 * Sets up the fields that depend on the data from the main cursor.
5757 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5758 * @param[in] node The data containing the #MDB_db record for the
5759 * sorted-dup database.
5762 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
5764 MDB_xcursor *mx = mc->mc_xcursor;
5766 if (node->mn_flags & F_SUBDATA) {
5767 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
5768 mx->mx_cursor.mc_pg[0] = 0;
5769 mx->mx_cursor.mc_snum = 0;
5770 mx->mx_cursor.mc_flags = C_SUB;
5772 MDB_page *fp = NODEDATA(node);
5773 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
5774 mx->mx_db.md_flags = 0;
5775 mx->mx_db.md_depth = 1;
5776 mx->mx_db.md_branch_pages = 0;
5777 mx->mx_db.md_leaf_pages = 1;
5778 mx->mx_db.md_overflow_pages = 0;
5779 mx->mx_db.md_entries = NUMKEYS(fp);
5780 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
5781 mx->mx_cursor.mc_snum = 1;
5782 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
5783 mx->mx_cursor.mc_top = 0;
5784 mx->mx_cursor.mc_pg[0] = fp;
5785 mx->mx_cursor.mc_ki[0] = 0;
5786 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5787 mx->mx_db.md_flags = MDB_DUPFIXED;
5788 mx->mx_db.md_pad = fp->mp_pad;
5789 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5790 mx->mx_db.md_flags |= MDB_INTEGERKEY;
5793 DPRINTF("Sub-db %u for db %u root page %zu", mx->mx_cursor.mc_dbi, mc->mc_dbi,
5795 mx->mx_dbflag = DB_VALID | (F_ISSET(mc->mc_pg[mc->mc_top]->mp_flags, P_DIRTY) ?
5797 mx->mx_dbx.md_name.mv_data = NODEKEY(node);
5798 mx->mx_dbx.md_name.mv_size = node->mn_ksize;
5799 #if UINT_MAX < SIZE_MAX
5800 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
5801 #ifdef MISALIGNED_OK
5802 mx->mx_dbx.md_cmp = mdb_cmp_long;
5804 mx->mx_dbx.md_cmp = mdb_cmp_cint;
5809 /** Initialize a cursor for a given transaction and database. */
5811 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
5816 mc->mc_db = &txn->mt_dbs[dbi];
5817 mc->mc_dbx = &txn->mt_dbxs[dbi];
5818 mc->mc_dbflag = &txn->mt_dbflags[dbi];
5823 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5825 mc->mc_xcursor = mx;
5826 mdb_xcursor_init0(mc);
5828 mc->mc_xcursor = NULL;
5830 if (*mc->mc_dbflag & DB_STALE) {
5831 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
5836 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
5839 size_t size = sizeof(MDB_cursor);
5841 if (txn == NULL || ret == NULL || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
5844 /* Allow read access to the freelist */
5845 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
5848 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
5849 size += sizeof(MDB_xcursor);
5851 if ((mc = malloc(size)) != NULL) {
5852 mdb_cursor_init(mc, txn, dbi, (MDB_xcursor *)(mc + 1));
5853 if (txn->mt_cursors) {
5854 mc->mc_next = txn->mt_cursors[dbi];
5855 txn->mt_cursors[dbi] = mc;
5856 mc->mc_flags |= C_UNTRACK;
5858 mc->mc_flags |= C_ALLOCD;
5869 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
5873 if (txn == NULL || mc == NULL || mc->mc_dbi >= txn->mt_numdbs)
5876 if ((mc->mc_flags & C_UNTRACK) || txn->mt_cursors)
5879 flags = mc->mc_flags;
5881 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
5883 mc->mc_flags |= (flags & C_ALLOCD);
5887 /* Return the count of duplicate data items for the current key */
5889 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
5893 if (mc == NULL || countp == NULL)
5896 if (!(mc->mc_db->md_flags & MDB_DUPSORT))
5899 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5900 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5903 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
5906 *countp = mc->mc_xcursor->mx_db.md_entries;
5912 mdb_cursor_close(MDB_cursor *mc)
5915 /* remove from txn, if tracked */
5916 if ((mc->mc_flags & C_UNTRACK) && mc->mc_txn->mt_cursors) {
5917 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
5918 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
5920 *prev = mc->mc_next;
5922 if (mc->mc_flags & C_ALLOCD)
5928 mdb_cursor_txn(MDB_cursor *mc)
5930 if (!mc) return NULL;
5935 mdb_cursor_dbi(MDB_cursor *mc)
5941 /** Replace the key for a node with a new key.
5942 * @param[in] mp The page containing the node to operate on.
5943 * @param[in] indx The index of the node to operate on.
5944 * @param[in] key The new key to use.
5945 * @return 0 on success, non-zero on failure.
5948 mdb_update_key(MDB_cursor *mc, MDB_val *key)
5955 indx_t ptr, i, numkeys, indx;
5958 indx = mc->mc_ki[mc->mc_top];
5959 mp = mc->mc_pg[mc->mc_top];
5960 node = NODEPTR(mp, indx);
5961 ptr = mp->mp_ptrs[indx];
5965 char kbuf2[(MDB_MAXKEYSIZE*2+1)];
5966 k2.mv_data = NODEKEY(node);
5967 k2.mv_size = node->mn_ksize;
5968 DPRINTF("update key %u (ofs %u) [%s] to [%s] on page %zu",
5970 mdb_dkey(&k2, kbuf2),
5976 delta0 = delta = key->mv_size - node->mn_ksize;
5978 /* Must be 2-byte aligned. If new key is
5979 * shorter by 1, the shift will be skipped.
5981 delta += (delta & 1);
5983 if (delta > 0 && SIZELEFT(mp) < delta) {
5985 /* not enough space left, do a delete and split */
5986 DPRINTF("Not enough room, delta = %d, splitting...", delta);
5987 pgno = NODEPGNO(node);
5988 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5989 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
5992 numkeys = NUMKEYS(mp);
5993 for (i = 0; i < numkeys; i++) {
5994 if (mp->mp_ptrs[i] <= ptr)
5995 mp->mp_ptrs[i] -= delta;
5998 base = (char *)mp + mp->mp_upper;
5999 len = ptr - mp->mp_upper + NODESIZE;
6000 memmove(base - delta, base, len);
6001 mp->mp_upper -= delta;
6003 node = NODEPTR(mp, indx);
6006 /* But even if no shift was needed, update ksize */
6008 node->mn_ksize = key->mv_size;
6011 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
6017 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
6019 /** Move a node from csrc to cdst.
6022 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
6029 unsigned short flags;
6033 /* Mark src and dst as dirty. */
6034 if ((rc = mdb_page_touch(csrc)) ||
6035 (rc = mdb_page_touch(cdst)))
6038 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6039 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0); /* fake */
6040 key.mv_size = csrc->mc_db->md_pad;
6041 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6043 data.mv_data = NULL;
6047 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
6048 assert(!((long)srcnode&1));
6049 srcpg = NODEPGNO(srcnode);
6050 flags = srcnode->mn_flags;
6051 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6052 unsigned int snum = csrc->mc_snum;
6054 /* must find the lowest key below src */
6055 mdb_page_search_lowest(csrc);
6056 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6057 key.mv_size = csrc->mc_db->md_pad;
6058 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6060 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6061 key.mv_size = NODEKSZ(s2);
6062 key.mv_data = NODEKEY(s2);
6064 csrc->mc_snum = snum--;
6065 csrc->mc_top = snum;
6067 key.mv_size = NODEKSZ(srcnode);
6068 key.mv_data = NODEKEY(srcnode);
6070 data.mv_size = NODEDSZ(srcnode);
6071 data.mv_data = NODEDATA(srcnode);
6073 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
6074 unsigned int snum = cdst->mc_snum;
6077 /* must find the lowest key below dst */
6078 mdb_page_search_lowest(cdst);
6079 if (IS_LEAF2(cdst->mc_pg[cdst->mc_top])) {
6080 bkey.mv_size = cdst->mc_db->md_pad;
6081 bkey.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, bkey.mv_size);
6083 s2 = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6084 bkey.mv_size = NODEKSZ(s2);
6085 bkey.mv_data = NODEKEY(s2);
6087 cdst->mc_snum = snum--;
6088 cdst->mc_top = snum;
6089 mdb_cursor_copy(cdst, &mn);
6091 rc = mdb_update_key(&mn, &bkey);
6096 DPRINTF("moving %s node %u [%s] on page %zu to node %u on page %zu",
6097 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
6098 csrc->mc_ki[csrc->mc_top],
6100 csrc->mc_pg[csrc->mc_top]->mp_pgno,
6101 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno);
6103 /* Add the node to the destination page.
6105 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
6106 if (rc != MDB_SUCCESS)
6109 /* Delete the node from the source page.
6111 mdb_node_del(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6114 /* Adjust other cursors pointing to mp */
6115 MDB_cursor *m2, *m3;
6116 MDB_dbi dbi = csrc->mc_dbi;
6117 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
6119 if (csrc->mc_flags & C_SUB)
6122 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6123 if (m2 == csrc) continue;
6124 if (csrc->mc_flags & C_SUB)
6125 m3 = &m2->mc_xcursor->mx_cursor;
6128 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
6129 csrc->mc_ki[csrc->mc_top]) {
6130 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
6131 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
6136 /* Update the parent separators.
6138 if (csrc->mc_ki[csrc->mc_top] == 0) {
6139 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
6140 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6141 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6143 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6144 key.mv_size = NODEKSZ(srcnode);
6145 key.mv_data = NODEKEY(srcnode);
6147 DPRINTF("update separator for source page %zu to [%s]",
6148 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key));
6149 mdb_cursor_copy(csrc, &mn);
6152 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6155 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6157 indx_t ix = csrc->mc_ki[csrc->mc_top];
6158 nullkey.mv_size = 0;
6159 csrc->mc_ki[csrc->mc_top] = 0;
6160 rc = mdb_update_key(csrc, &nullkey);
6161 csrc->mc_ki[csrc->mc_top] = ix;
6162 assert(rc == MDB_SUCCESS);
6166 if (cdst->mc_ki[cdst->mc_top] == 0) {
6167 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
6168 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6169 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
6171 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6172 key.mv_size = NODEKSZ(srcnode);
6173 key.mv_data = NODEKEY(srcnode);
6175 DPRINTF("update separator for destination page %zu to [%s]",
6176 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key));
6177 mdb_cursor_copy(cdst, &mn);
6180 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6183 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
6185 indx_t ix = cdst->mc_ki[cdst->mc_top];
6186 nullkey.mv_size = 0;
6187 cdst->mc_ki[cdst->mc_top] = 0;
6188 rc = mdb_update_key(cdst, &nullkey);
6189 cdst->mc_ki[cdst->mc_top] = ix;
6190 assert(rc == MDB_SUCCESS);
6197 /** Merge one page into another.
6198 * The nodes from the page pointed to by \b csrc will
6199 * be copied to the page pointed to by \b cdst and then
6200 * the \b csrc page will be freed.
6201 * @param[in] csrc Cursor pointing to the source page.
6202 * @param[in] cdst Cursor pointing to the destination page.
6205 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
6213 DPRINTF("merging page %zu into %zu", csrc->mc_pg[csrc->mc_top]->mp_pgno,
6214 cdst->mc_pg[cdst->mc_top]->mp_pgno);
6216 assert(csrc->mc_snum > 1); /* can't merge root page */
6217 assert(cdst->mc_snum > 1);
6219 /* Mark dst as dirty. */
6220 if ((rc = mdb_page_touch(cdst)))
6223 /* Move all nodes from src to dst.
6225 j = nkeys = NUMKEYS(cdst->mc_pg[cdst->mc_top]);
6226 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6227 key.mv_size = csrc->mc_db->md_pad;
6228 key.mv_data = METADATA(csrc->mc_pg[csrc->mc_top]);
6229 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6230 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
6231 if (rc != MDB_SUCCESS)
6233 key.mv_data = (char *)key.mv_data + key.mv_size;
6236 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6237 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], i);
6238 if (i == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6239 unsigned int snum = csrc->mc_snum;
6241 /* must find the lowest key below src */
6242 mdb_page_search_lowest(csrc);
6243 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6244 key.mv_size = csrc->mc_db->md_pad;
6245 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6247 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6248 key.mv_size = NODEKSZ(s2);
6249 key.mv_data = NODEKEY(s2);
6251 csrc->mc_snum = snum--;
6252 csrc->mc_top = snum;
6254 key.mv_size = srcnode->mn_ksize;
6255 key.mv_data = NODEKEY(srcnode);
6258 data.mv_size = NODEDSZ(srcnode);
6259 data.mv_data = NODEDATA(srcnode);
6260 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
6261 if (rc != MDB_SUCCESS)
6266 DPRINTF("dst page %zu now has %u keys (%.1f%% filled)",
6267 cdst->mc_pg[cdst->mc_top]->mp_pgno, NUMKEYS(cdst->mc_pg[cdst->mc_top]), (float)PAGEFILL(cdst->mc_txn->mt_env, cdst->mc_pg[cdst->mc_top]) / 10);
6269 /* Unlink the src page from parent and add to free list.
6271 mdb_node_del(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1], 0);
6272 if (csrc->mc_ki[csrc->mc_top-1] == 0) {
6275 rc = mdb_update_key(csrc, &key);
6281 mdb_midl_append(&csrc->mc_txn->mt_free_pgs, csrc->mc_pg[csrc->mc_top]->mp_pgno);
6282 if (IS_LEAF(csrc->mc_pg[csrc->mc_top]))
6283 csrc->mc_db->md_leaf_pages--;
6285 csrc->mc_db->md_branch_pages--;
6287 /* Adjust other cursors pointing to mp */
6288 MDB_cursor *m2, *m3;
6289 MDB_dbi dbi = csrc->mc_dbi;
6290 MDB_page *mp = cdst->mc_pg[cdst->mc_top];
6292 if (csrc->mc_flags & C_SUB)
6295 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6296 if (csrc->mc_flags & C_SUB)
6297 m3 = &m2->mc_xcursor->mx_cursor;
6300 if (m3 == csrc) continue;
6301 if (m3->mc_snum < csrc->mc_snum) continue;
6302 if (m3->mc_pg[csrc->mc_top] == csrc->mc_pg[csrc->mc_top]) {
6303 m3->mc_pg[csrc->mc_top] = mp;
6304 m3->mc_ki[csrc->mc_top] += nkeys;
6308 mdb_cursor_pop(csrc);
6310 return mdb_rebalance(csrc);
6313 /** Copy the contents of a cursor.
6314 * @param[in] csrc The cursor to copy from.
6315 * @param[out] cdst The cursor to copy to.
6318 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
6322 cdst->mc_txn = csrc->mc_txn;
6323 cdst->mc_dbi = csrc->mc_dbi;
6324 cdst->mc_db = csrc->mc_db;
6325 cdst->mc_dbx = csrc->mc_dbx;
6326 cdst->mc_snum = csrc->mc_snum;
6327 cdst->mc_top = csrc->mc_top;
6328 cdst->mc_flags = csrc->mc_flags;
6330 for (i=0; i<csrc->mc_snum; i++) {
6331 cdst->mc_pg[i] = csrc->mc_pg[i];
6332 cdst->mc_ki[i] = csrc->mc_ki[i];
6336 /** Rebalance the tree after a delete operation.
6337 * @param[in] mc Cursor pointing to the page where rebalancing
6339 * @return 0 on success, non-zero on failure.
6342 mdb_rebalance(MDB_cursor *mc)
6346 unsigned int ptop, minkeys;
6349 minkeys = 1 + (IS_BRANCH(mc->mc_pg[mc->mc_top]));
6353 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6354 DPRINTF("rebalancing %s page %zu (has %u keys, %.1f%% full)",
6355 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
6356 pgno, NUMKEYS(mc->mc_pg[mc->mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10);
6360 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD &&
6361 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
6364 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6365 DPRINTF("no need to rebalance page %zu, above fill threshold",
6371 if (mc->mc_snum < 2) {
6372 MDB_page *mp = mc->mc_pg[0];
6374 DPUTS("Can't rebalance a subpage, ignoring");
6377 if (NUMKEYS(mp) == 0) {
6378 DPUTS("tree is completely empty");
6379 mc->mc_db->md_root = P_INVALID;
6380 mc->mc_db->md_depth = 0;
6381 mc->mc_db->md_leaf_pages = 0;
6382 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6386 /* Adjust other cursors pointing to mp */
6387 MDB_cursor *m2, *m3;
6388 MDB_dbi dbi = mc->mc_dbi;
6390 if (mc->mc_flags & C_SUB)
6393 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6394 if (m2 == mc) continue;
6395 if (mc->mc_flags & C_SUB)
6396 m3 = &m2->mc_xcursor->mx_cursor;
6399 if (m3->mc_snum < mc->mc_snum) continue;
6400 if (m3->mc_pg[0] == mp) {
6406 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
6407 DPUTS("collapsing root page!");
6408 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6409 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
6410 if ((rc = mdb_page_get(mc->mc_txn, mc->mc_db->md_root,
6413 mc->mc_db->md_depth--;
6414 mc->mc_db->md_branch_pages--;
6416 /* Adjust other cursors pointing to mp */
6417 MDB_cursor *m2, *m3;
6418 MDB_dbi dbi = mc->mc_dbi;
6420 if (mc->mc_flags & C_SUB)
6423 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6424 if (m2 == mc) continue;
6425 if (mc->mc_flags & C_SUB)
6426 m3 = &m2->mc_xcursor->mx_cursor;
6429 if (m3->mc_snum < mc->mc_snum) continue;
6430 if (m3->mc_pg[0] == mp) {
6431 m3->mc_pg[0] = mc->mc_pg[0];
6438 DPUTS("root page doesn't need rebalancing");
6442 /* The parent (branch page) must have at least 2 pointers,
6443 * otherwise the tree is invalid.
6445 ptop = mc->mc_top-1;
6446 assert(NUMKEYS(mc->mc_pg[ptop]) > 1);
6448 /* Leaf page fill factor is below the threshold.
6449 * Try to move keys from left or right neighbor, or
6450 * merge with a neighbor page.
6455 mdb_cursor_copy(mc, &mn);
6456 mn.mc_xcursor = NULL;
6458 if (mc->mc_ki[ptop] == 0) {
6459 /* We're the leftmost leaf in our parent.
6461 DPUTS("reading right neighbor");
6463 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6464 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
6466 mn.mc_ki[mn.mc_top] = 0;
6467 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
6469 /* There is at least one neighbor to the left.
6471 DPUTS("reading left neighbor");
6473 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6474 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
6476 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
6477 mc->mc_ki[mc->mc_top] = 0;
6480 DPRINTF("found neighbor page %zu (%u keys, %.1f%% full)",
6481 mn.mc_pg[mn.mc_top]->mp_pgno, NUMKEYS(mn.mc_pg[mn.mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) / 10);
6483 /* If the neighbor page is above threshold and has enough keys,
6484 * move one key from it. Otherwise we should try to merge them.
6485 * (A branch page must never have less than 2 keys.)
6487 minkeys = 1 + (IS_BRANCH(mn.mc_pg[mn.mc_top]));
6488 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys)
6489 return mdb_node_move(&mn, mc);
6491 if (mc->mc_ki[ptop] == 0)
6492 rc = mdb_page_merge(&mn, mc);
6494 rc = mdb_page_merge(mc, &mn);
6495 mc->mc_flags &= ~C_INITIALIZED;
6500 /** Complete a delete operation started by #mdb_cursor_del(). */
6502 mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf)
6506 /* add overflow pages to free list */
6507 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6511 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6512 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
6513 mc->mc_db->md_overflow_pages -= ovpages;
6514 for (i=0; i<ovpages; i++) {
6515 DPRINTF("freed ov page %zu", pg);
6516 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
6520 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], mc->mc_db->md_pad);
6521 mc->mc_db->md_entries--;
6522 rc = mdb_rebalance(mc);
6523 if (rc != MDB_SUCCESS)
6524 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6525 /* if mc points past last node in page, invalidate */
6526 else if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6527 mc->mc_flags &= ~C_INITIALIZED;
6533 mdb_del(MDB_txn *txn, MDB_dbi dbi,
6534 MDB_val *key, MDB_val *data)
6539 MDB_val rdata, *xdata;
6543 assert(key != NULL);
6545 DPRINTF("====> delete db %u key [%s]", dbi, DKEY(key));
6547 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
6550 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
6554 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
6558 mdb_cursor_init(&mc, txn, dbi, &mx);
6569 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
6571 /* let mdb_page_split know about this cursor if needed:
6572 * delete will trigger a rebalance; if it needs to move
6573 * a node from one page to another, it will have to
6574 * update the parent's separator key(s). If the new sepkey
6575 * is larger than the current one, the parent page may
6576 * run out of space, triggering a split. We need this
6577 * cursor to be consistent until the end of the rebalance.
6579 mc.mc_next = txn->mt_cursors[dbi];
6580 txn->mt_cursors[dbi] = &mc;
6581 rc = mdb_cursor_del(&mc, data ? 0 : MDB_NODUPDATA);
6582 txn->mt_cursors[dbi] = mc.mc_next;
6587 /** Split a page and insert a new node.
6588 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
6589 * The cursor will be updated to point to the actual page and index where
6590 * the node got inserted after the split.
6591 * @param[in] newkey The key for the newly inserted node.
6592 * @param[in] newdata The data for the newly inserted node.
6593 * @param[in] newpgno The page number, if the new node is a branch node.
6594 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
6595 * @return 0 on success, non-zero on failure.
6598 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
6599 unsigned int nflags)
6602 int rc = MDB_SUCCESS, ins_new = 0, new_root = 0, newpos = 1, did_split = 0;
6605 unsigned int i, j, split_indx, nkeys, pmax;
6607 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
6609 MDB_page *mp, *rp, *pp;
6614 mp = mc->mc_pg[mc->mc_top];
6615 newindx = mc->mc_ki[mc->mc_top];
6617 DPRINTF("-----> splitting %s page %zu and adding [%s] at index %i",
6618 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
6619 DKEY(newkey), mc->mc_ki[mc->mc_top]);
6621 /* Create a right sibling. */
6622 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
6624 DPRINTF("new right sibling: page %zu", rp->mp_pgno);
6626 if (mc->mc_snum < 2) {
6627 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
6629 /* shift current top to make room for new parent */
6630 mc->mc_pg[1] = mc->mc_pg[0];
6631 mc->mc_ki[1] = mc->mc_ki[0];
6634 mc->mc_db->md_root = pp->mp_pgno;
6635 DPRINTF("root split! new root = %zu", pp->mp_pgno);
6636 mc->mc_db->md_depth++;
6639 /* Add left (implicit) pointer. */
6640 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
6641 /* undo the pre-push */
6642 mc->mc_pg[0] = mc->mc_pg[1];
6643 mc->mc_ki[0] = mc->mc_ki[1];
6644 mc->mc_db->md_root = mp->mp_pgno;
6645 mc->mc_db->md_depth--;
6652 ptop = mc->mc_top-1;
6653 DPRINTF("parent branch page is %zu", mc->mc_pg[ptop]->mp_pgno);
6656 mc->mc_flags |= C_SPLITTING;
6657 mdb_cursor_copy(mc, &mn);
6658 mn.mc_pg[mn.mc_top] = rp;
6659 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
6661 if (nflags & MDB_APPEND) {
6662 mn.mc_ki[mn.mc_top] = 0;
6664 split_indx = newindx;
6669 nkeys = NUMKEYS(mp);
6670 split_indx = nkeys / 2;
6671 if (newindx < split_indx)
6677 unsigned int lsize, rsize, ksize;
6678 /* Move half of the keys to the right sibling */
6680 x = mc->mc_ki[mc->mc_top] - split_indx;
6681 ksize = mc->mc_db->md_pad;
6682 split = LEAF2KEY(mp, split_indx, ksize);
6683 rsize = (nkeys - split_indx) * ksize;
6684 lsize = (nkeys - split_indx) * sizeof(indx_t);
6685 mp->mp_lower -= lsize;
6686 rp->mp_lower += lsize;
6687 mp->mp_upper += rsize - lsize;
6688 rp->mp_upper -= rsize - lsize;
6689 sepkey.mv_size = ksize;
6690 if (newindx == split_indx) {
6691 sepkey.mv_data = newkey->mv_data;
6693 sepkey.mv_data = split;
6696 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
6697 memcpy(rp->mp_ptrs, split, rsize);
6698 sepkey.mv_data = rp->mp_ptrs;
6699 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
6700 memcpy(ins, newkey->mv_data, ksize);
6701 mp->mp_lower += sizeof(indx_t);
6702 mp->mp_upper -= ksize - sizeof(indx_t);
6705 memcpy(rp->mp_ptrs, split, x * ksize);
6706 ins = LEAF2KEY(rp, x, ksize);
6707 memcpy(ins, newkey->mv_data, ksize);
6708 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
6709 rp->mp_lower += sizeof(indx_t);
6710 rp->mp_upper -= ksize - sizeof(indx_t);
6711 mc->mc_ki[mc->mc_top] = x;
6712 mc->mc_pg[mc->mc_top] = rp;
6717 /* For leaf pages, check the split point based on what
6718 * fits where, since otherwise mdb_node_add can fail.
6720 * This check is only needed when the data items are
6721 * relatively large, such that being off by one will
6722 * make the difference between success or failure.
6724 * It's also relevant if a page happens to be laid out
6725 * such that one half of its nodes are all "small" and
6726 * the other half of its nodes are "large." If the new
6727 * item is also "large" and falls on the half with
6728 * "large" nodes, it also may not fit.
6731 unsigned int psize, nsize;
6732 /* Maximum free space in an empty page */
6733 pmax = mc->mc_txn->mt_env->me_psize - PAGEHDRSZ;
6734 nsize = mdb_leaf_size(mc->mc_txn->mt_env, newkey, newdata);
6735 if ((nkeys < 20) || (nsize > pmax/16)) {
6736 if (newindx <= split_indx) {
6739 for (i=0; i<split_indx; i++) {
6740 node = NODEPTR(mp, i);
6741 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6742 if (F_ISSET(node->mn_flags, F_BIGDATA))
6743 psize += sizeof(pgno_t);
6745 psize += NODEDSZ(node);
6749 split_indx = newindx;
6760 for (i=nkeys-1; i>=split_indx; i--) {
6761 node = NODEPTR(mp, i);
6762 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6763 if (F_ISSET(node->mn_flags, F_BIGDATA))
6764 psize += sizeof(pgno_t);
6766 psize += NODEDSZ(node);
6770 split_indx = newindx;
6781 /* First find the separating key between the split pages.
6782 * The case where newindx == split_indx is ambiguous; the
6783 * new item could go to the new page or stay on the original
6784 * page. If newpos == 1 it goes to the new page.
6786 if (newindx == split_indx && newpos) {
6787 sepkey.mv_size = newkey->mv_size;
6788 sepkey.mv_data = newkey->mv_data;
6790 node = NODEPTR(mp, split_indx);
6791 sepkey.mv_size = node->mn_ksize;
6792 sepkey.mv_data = NODEKEY(node);
6796 DPRINTF("separator is [%s]", DKEY(&sepkey));
6798 /* Copy separator key to the parent.
6800 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(mc->mc_txn->mt_env, &sepkey)) {
6804 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
6807 if (mn.mc_snum == mc->mc_snum) {
6808 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
6809 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
6810 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
6811 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
6816 /* Right page might now have changed parent.
6817 * Check if left page also changed parent.
6819 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
6820 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
6821 for (i=0; i<ptop; i++) {
6822 mc->mc_pg[i] = mn.mc_pg[i];
6823 mc->mc_ki[i] = mn.mc_ki[i];
6825 mc->mc_pg[ptop] = mn.mc_pg[ptop];
6826 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
6830 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
6833 mc->mc_flags ^= C_SPLITTING;
6834 if (rc != MDB_SUCCESS) {
6837 if (nflags & MDB_APPEND) {
6838 mc->mc_pg[mc->mc_top] = rp;
6839 mc->mc_ki[mc->mc_top] = 0;
6840 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
6843 for (i=0; i<mc->mc_top; i++)
6844 mc->mc_ki[i] = mn.mc_ki[i];
6851 /* Move half of the keys to the right sibling. */
6853 /* grab a page to hold a temporary copy */
6854 copy = mdb_page_malloc(mc);
6858 copy->mp_pgno = mp->mp_pgno;
6859 copy->mp_flags = mp->mp_flags;
6860 copy->mp_lower = PAGEHDRSZ;
6861 copy->mp_upper = mc->mc_txn->mt_env->me_psize;
6862 mc->mc_pg[mc->mc_top] = copy;
6863 for (i = j = 0; i <= nkeys; j++) {
6864 if (i == split_indx) {
6865 /* Insert in right sibling. */
6866 /* Reset insert index for right sibling. */
6867 if (i != newindx || (newpos ^ ins_new)) {
6869 mc->mc_pg[mc->mc_top] = rp;
6873 if (i == newindx && !ins_new) {
6874 /* Insert the original entry that caused the split. */
6875 rkey.mv_data = newkey->mv_data;
6876 rkey.mv_size = newkey->mv_size;
6885 /* Update index for the new key. */
6886 mc->mc_ki[mc->mc_top] = j;
6887 } else if (i == nkeys) {
6890 node = NODEPTR(mp, i);
6891 rkey.mv_data = NODEKEY(node);
6892 rkey.mv_size = node->mn_ksize;
6894 xdata.mv_data = NODEDATA(node);
6895 xdata.mv_size = NODEDSZ(node);
6898 pgno = NODEPGNO(node);
6899 flags = node->mn_flags;
6904 if (!IS_LEAF(mp) && j == 0) {
6905 /* First branch index doesn't need key data. */
6909 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
6913 nkeys = NUMKEYS(copy);
6914 for (i=0; i<nkeys; i++)
6915 mp->mp_ptrs[i] = copy->mp_ptrs[i];
6916 mp->mp_lower = copy->mp_lower;
6917 mp->mp_upper = copy->mp_upper;
6918 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
6919 mc->mc_txn->mt_env->me_psize - copy->mp_upper);
6921 /* reset back to original page */
6922 if (newindx < split_indx || (!newpos && newindx == split_indx)) {
6923 mc->mc_pg[mc->mc_top] = mp;
6924 if (nflags & MDB_RESERVE) {
6925 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6926 if (!(node->mn_flags & F_BIGDATA))
6927 newdata->mv_data = NODEDATA(node);
6933 /* return tmp page to freelist */
6934 mdb_page_free(mc->mc_txn->mt_env, copy);
6937 /* Adjust other cursors pointing to mp */
6938 MDB_cursor *m2, *m3;
6939 MDB_dbi dbi = mc->mc_dbi;
6940 int fixup = NUMKEYS(mp);
6942 if (mc->mc_flags & C_SUB)
6945 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6946 if (m2 == mc) continue;
6947 if (mc->mc_flags & C_SUB)
6948 m3 = &m2->mc_xcursor->mx_cursor;
6951 if (!(m3->mc_flags & C_INITIALIZED))
6953 if (m3->mc_flags & C_SPLITTING)
6958 for (k=m3->mc_top; k>=0; k--) {
6959 m3->mc_ki[k+1] = m3->mc_ki[k];
6960 m3->mc_pg[k+1] = m3->mc_pg[k];
6962 if (m3->mc_ki[0] >= split_indx) {
6967 m3->mc_pg[0] = mc->mc_pg[0];
6971 if (m3->mc_pg[mc->mc_top] == mp) {
6972 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
6973 m3->mc_ki[mc->mc_top]++;
6974 if (m3->mc_ki[mc->mc_top] >= fixup) {
6975 m3->mc_pg[mc->mc_top] = rp;
6976 m3->mc_ki[mc->mc_top] -= fixup;
6977 m3->mc_ki[ptop] = mn.mc_ki[ptop];
6979 } else if (!did_split && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
6980 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
6989 mdb_put(MDB_txn *txn, MDB_dbi dbi,
6990 MDB_val *key, MDB_val *data, unsigned int flags)
6995 assert(key != NULL);
6996 assert(data != NULL);
6998 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7001 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
7005 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
7009 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP)) != flags)
7012 mdb_cursor_init(&mc, txn, dbi, &mx);
7013 return mdb_cursor_put(&mc, key, data, flags);
7017 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
7019 if ((flag & CHANGEABLE) != flag)
7022 env->me_flags |= flag;
7024 env->me_flags &= ~flag;
7029 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
7034 *arg = env->me_flags;
7039 mdb_env_get_path(MDB_env *env, const char **arg)
7044 *arg = env->me_path;
7048 /** Common code for #mdb_stat() and #mdb_env_stat().
7049 * @param[in] env the environment to operate in.
7050 * @param[in] db the #MDB_db record containing the stats to return.
7051 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
7052 * @return 0, this function always succeeds.
7055 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
7057 arg->ms_psize = env->me_psize;
7058 arg->ms_depth = db->md_depth;
7059 arg->ms_branch_pages = db->md_branch_pages;
7060 arg->ms_leaf_pages = db->md_leaf_pages;
7061 arg->ms_overflow_pages = db->md_overflow_pages;
7062 arg->ms_entries = db->md_entries;
7067 mdb_env_stat(MDB_env *env, MDB_stat *arg)
7071 if (env == NULL || arg == NULL)
7074 toggle = mdb_env_pick_meta(env);
7076 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
7080 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
7084 if (env == NULL || arg == NULL)
7087 toggle = mdb_env_pick_meta(env);
7088 arg->me_mapaddr = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : 0;
7089 arg->me_mapsize = env->me_mapsize;
7090 arg->me_maxreaders = env->me_maxreaders;
7091 arg->me_numreaders = env->me_numreaders;
7092 arg->me_last_pgno = env->me_metas[toggle]->mm_last_pg;
7093 arg->me_last_txnid = env->me_metas[toggle]->mm_txnid;
7097 /** Set the default comparison functions for a database.
7098 * Called immediately after a database is opened to set the defaults.
7099 * The user can then override them with #mdb_set_compare() or
7100 * #mdb_set_dupsort().
7101 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
7102 * @param[in] dbi A database handle returned by #mdb_dbi_open()
7105 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
7107 uint16_t f = txn->mt_dbs[dbi].md_flags;
7109 txn->mt_dbxs[dbi].md_cmp =
7110 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
7111 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
7113 txn->mt_dbxs[dbi].md_dcmp =
7114 !(f & MDB_DUPSORT) ? 0 :
7115 ((f & MDB_INTEGERDUP)
7116 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
7117 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
7120 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
7125 int rc, dbflag, exact;
7126 unsigned int unused = 0;
7129 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
7130 mdb_default_cmp(txn, FREE_DBI);
7133 if ((flags & VALID_FLAGS) != flags)
7139 if (flags & PERSISTENT_FLAGS) {
7140 uint16_t f2 = flags & PERSISTENT_FLAGS;
7141 /* make sure flag changes get committed */
7142 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
7143 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
7144 txn->mt_flags |= MDB_TXN_DIRTY;
7147 mdb_default_cmp(txn, MAIN_DBI);
7151 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
7152 mdb_default_cmp(txn, MAIN_DBI);
7155 /* Is the DB already open? */
7157 for (i=2; i<txn->mt_numdbs; i++) {
7158 if (!txn->mt_dbxs[i].md_name.mv_size) {
7159 /* Remember this free slot */
7160 if (!unused) unused = i;
7163 if (len == txn->mt_dbxs[i].md_name.mv_size &&
7164 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
7170 /* If no free slot and max hit, fail */
7171 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
7172 return MDB_DBS_FULL;
7174 /* Find the DB info */
7175 dbflag = DB_NEW|DB_VALID;
7178 key.mv_data = (void *)name;
7179 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
7180 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
7181 if (rc == MDB_SUCCESS) {
7182 /* make sure this is actually a DB */
7183 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
7184 if (!(node->mn_flags & F_SUBDATA))
7186 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
7187 /* Create if requested */
7189 data.mv_size = sizeof(MDB_db);
7190 data.mv_data = &dummy;
7191 memset(&dummy, 0, sizeof(dummy));
7192 dummy.md_root = P_INVALID;
7193 dummy.md_flags = flags & PERSISTENT_FLAGS;
7194 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
7198 /* OK, got info, add to table */
7199 if (rc == MDB_SUCCESS) {
7200 unsigned int slot = unused ? unused : txn->mt_numdbs;
7201 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
7202 txn->mt_dbxs[slot].md_name.mv_size = len;
7203 txn->mt_dbxs[slot].md_rel = NULL;
7204 txn->mt_dbflags[slot] = dbflag;
7205 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
7207 txn->mt_env->me_dbflags[slot] = txn->mt_dbs[slot].md_flags;
7208 mdb_default_cmp(txn, slot);
7217 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
7219 if (txn == NULL || arg == NULL || dbi >= txn->mt_numdbs)
7222 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
7225 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
7228 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
7230 ptr = env->me_dbxs[dbi].md_name.mv_data;
7231 env->me_dbxs[dbi].md_name.mv_data = NULL;
7232 env->me_dbxs[dbi].md_name.mv_size = 0;
7233 env->me_dbflags[dbi] = 0;
7237 /** Add all the DB's pages to the free list.
7238 * @param[in] mc Cursor on the DB to free.
7239 * @param[in] subs non-Zero to check for sub-DBs in this DB.
7240 * @return 0 on success, non-zero on failure.
7243 mdb_drop0(MDB_cursor *mc, int subs)
7247 rc = mdb_page_search(mc, NULL, 0);
7248 if (rc == MDB_SUCCESS) {
7253 /* LEAF2 pages have no nodes, cannot have sub-DBs */
7254 if (IS_LEAF2(mc->mc_pg[mc->mc_top]))
7257 mdb_cursor_copy(mc, &mx);
7258 while (mc->mc_snum > 0) {
7259 if (IS_LEAF(mc->mc_pg[mc->mc_top])) {
7260 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
7261 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
7262 if (ni->mn_flags & F_BIGDATA) {
7263 int j, ovpages = OVPAGES(NODEDSZ(ni), mc->mc_txn->mt_env->me_psize);
7265 memcpy(&pg, NODEDATA(ni), sizeof(pg));
7266 for (j=0; j<ovpages; j++) {
7267 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
7270 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
7271 mdb_xcursor_init1(mc, ni);
7272 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
7278 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
7280 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
7283 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
7288 mc->mc_ki[mc->mc_top] = i;
7289 rc = mdb_cursor_sibling(mc, 1);
7291 /* no more siblings, go back to beginning
7292 * of previous level.
7296 for (i=1; i<mc->mc_snum; i++) {
7298 mc->mc_pg[i] = mx.mc_pg[i];
7303 mdb_midl_append(&mc->mc_txn->mt_free_pgs,
7304 mc->mc_db->md_root);
7309 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
7314 if (!txn || !dbi || dbi >= txn->mt_numdbs || (unsigned)del > 1 || !(txn->mt_dbflags[dbi] & DB_VALID))
7317 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
7320 rc = mdb_cursor_open(txn, dbi, &mc);
7324 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
7328 /* Can't delete the main DB */
7329 if (del && dbi > MAIN_DBI) {
7330 rc = mdb_del(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL);
7332 txn->mt_dbflags[dbi] = DB_STALE;
7333 mdb_dbi_close(txn->mt_env, dbi);
7336 /* reset the DB record, mark it dirty */
7337 txn->mt_dbflags[dbi] |= DB_DIRTY;
7338 txn->mt_dbs[dbi].md_depth = 0;
7339 txn->mt_dbs[dbi].md_branch_pages = 0;
7340 txn->mt_dbs[dbi].md_leaf_pages = 0;
7341 txn->mt_dbs[dbi].md_overflow_pages = 0;
7342 txn->mt_dbs[dbi].md_entries = 0;
7343 txn->mt_dbs[dbi].md_root = P_INVALID;
7345 txn->mt_flags |= MDB_TXN_DIRTY;
7348 mdb_cursor_close(mc);
7352 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7354 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7357 txn->mt_dbxs[dbi].md_cmp = cmp;
7361 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7363 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7366 txn->mt_dbxs[dbi].md_dcmp = cmp;
7370 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
7372 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7375 txn->mt_dbxs[dbi].md_rel = rel;
7379 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
7381 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7384 txn->mt_dbxs[dbi].md_relctx = ctx;
projects / openldap / blob