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 */
904 unsigned int mc_flags; /**< @ref mdb_cursor */
905 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
906 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
909 /** Context for sorted-dup records.
910 * We could have gone to a fully recursive design, with arbitrarily
911 * deep nesting of sub-databases. But for now we only handle these
912 * levels - main DB, optional sub-DB, sorted-duplicate DB.
914 typedef struct MDB_xcursor {
915 /** A sub-cursor for traversing the Dup DB */
916 MDB_cursor mx_cursor;
917 /** The database record for this Dup DB */
919 /** The auxiliary DB record for this Dup DB */
921 /** The @ref mt_dbflag for this Dup DB */
922 unsigned char mx_dbflag;
925 /** State of FreeDB old pages, stored in the MDB_env */
926 typedef struct MDB_pgstate {
927 txnid_t mf_pglast; /**< ID of last old page record we used */
928 pgno_t *mf_pghead; /**< old pages reclaimed from freelist */
929 pgno_t *mf_pgfree; /**< memory to free when dropping me_pghead */
932 /** The database environment. */
934 HANDLE me_fd; /**< The main data file */
935 HANDLE me_lfd; /**< The lock file */
936 HANDLE me_mfd; /**< just for writing the meta pages */
937 /** Failed to update the meta page. Probably an I/O error. */
938 #define MDB_FATAL_ERROR 0x80000000U
939 /** Some fields are initialized. */
940 #define MDB_ENV_ACTIVE 0x20000000U
941 /** me_txkey is set */
942 #define MDB_ENV_TXKEY 0x10000000U
943 uint32_t me_flags; /**< @ref mdb_env */
944 unsigned int me_psize; /**< size of a page, from #GET_PAGESIZE */
945 unsigned int me_maxreaders; /**< size of the reader table */
946 unsigned int me_numreaders; /**< max numreaders set by this env */
947 MDB_dbi me_numdbs; /**< number of DBs opened */
948 MDB_dbi me_maxdbs; /**< size of the DB table */
949 pid_t me_pid; /**< process ID of this env */
950 char *me_path; /**< path to the DB files */
951 char *me_map; /**< the memory map of the data file */
952 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
953 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
954 MDB_txn *me_txn; /**< current write transaction */
955 size_t me_mapsize; /**< size of the data memory map */
956 off_t me_size; /**< current file size */
957 pgno_t me_maxpg; /**< me_mapsize / me_psize */
958 MDB_dbx *me_dbxs; /**< array of static DB info */
959 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
960 pthread_key_t me_txkey; /**< thread-key for readers */
961 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
962 # define me_pglast me_pgstate.mf_pglast
963 # define me_pghead me_pgstate.mf_pghead
964 # define me_pgfree me_pgstate.mf_pgfree
965 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
966 /** IDL of pages that became unused in a write txn */
968 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
969 MDB_ID2L me_dirty_list;
970 /** Max number of freelist items that can fit in a single overflow page */
971 unsigned int me_maxfree_1pg;
972 /** Max size of a node on a page */
973 unsigned int me_nodemax;
975 HANDLE me_rmutex; /* Windows mutexes don't reside in shared mem */
977 #elif defined(MDB_USE_POSIX_SEM)
978 sem_t *me_rmutex; /* Shared mutexes are not supported */
983 /** Nested transaction */
984 typedef struct MDB_ntxn {
985 MDB_txn mnt_txn; /* the transaction */
986 MDB_pgstate mnt_pgstate; /* parent transaction's saved freestate */
989 /** max number of pages to commit in one writev() call */
990 #define MDB_COMMIT_PAGES 64
991 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
992 #undef MDB_COMMIT_PAGES
993 #define MDB_COMMIT_PAGES IOV_MAX
996 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
997 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
998 static int mdb_page_touch(MDB_cursor *mc);
1000 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp);
1001 static int mdb_page_search_root(MDB_cursor *mc,
1002 MDB_val *key, int modify);
1003 #define MDB_PS_MODIFY 1
1004 #define MDB_PS_ROOTONLY 2
1005 static int mdb_page_search(MDB_cursor *mc,
1006 MDB_val *key, int flags);
1007 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1009 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1010 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1011 pgno_t newpgno, unsigned int nflags);
1013 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1014 static int mdb_env_pick_meta(const MDB_env *env);
1015 static int mdb_env_write_meta(MDB_txn *txn);
1016 static void mdb_env_close0(MDB_env *env, int excl);
1018 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1019 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1020 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1021 static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
1022 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1023 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1024 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1025 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1026 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1028 static int mdb_rebalance(MDB_cursor *mc);
1029 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1031 static void mdb_cursor_pop(MDB_cursor *mc);
1032 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1034 static int mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
1035 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1036 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1037 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1038 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1040 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1041 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1043 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1044 static void mdb_xcursor_init0(MDB_cursor *mc);
1045 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1047 static int mdb_drop0(MDB_cursor *mc, int subs);
1048 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1051 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1055 static SECURITY_DESCRIPTOR mdb_null_sd;
1056 static SECURITY_ATTRIBUTES mdb_all_sa;
1057 static int mdb_sec_inited;
1060 /** Return the library version info. */
1062 mdb_version(int *major, int *minor, int *patch)
1064 if (major) *major = MDB_VERSION_MAJOR;
1065 if (minor) *minor = MDB_VERSION_MINOR;
1066 if (patch) *patch = MDB_VERSION_PATCH;
1067 return MDB_VERSION_STRING;
1070 /** Table of descriptions for MDB @ref errors */
1071 static char *const mdb_errstr[] = {
1072 "MDB_KEYEXIST: Key/data pair already exists",
1073 "MDB_NOTFOUND: No matching key/data pair found",
1074 "MDB_PAGE_NOTFOUND: Requested page not found",
1075 "MDB_CORRUPTED: Located page was wrong type",
1076 "MDB_PANIC: Update of meta page failed",
1077 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1078 "MDB_INVALID: File is not an MDB file",
1079 "MDB_MAP_FULL: Environment mapsize limit reached",
1080 "MDB_DBS_FULL: Environment maxdbs limit reached",
1081 "MDB_READERS_FULL: Environment maxreaders limit reached",
1082 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1083 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1084 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1085 "MDB_PAGE_FULL: Internal error - page has no more space",
1086 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1087 "MDB_INCOMPATIBLE: Database flags changed or would change",
1088 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1092 mdb_strerror(int err)
1096 return ("Successful return: 0");
1098 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1099 i = err - MDB_KEYEXIST;
1100 return mdb_errstr[i];
1103 return strerror(err);
1107 /** Display a key in hexadecimal and return the address of the result.
1108 * @param[in] key the key to display
1109 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1110 * @return The key in hexadecimal form.
1113 mdb_dkey(MDB_val *key, char *buf)
1116 unsigned char *c = key->mv_data;
1122 if (key->mv_size > MDB_MAXKEYSIZE)
1123 return "MDB_MAXKEYSIZE";
1124 /* may want to make this a dynamic check: if the key is mostly
1125 * printable characters, print it as-is instead of converting to hex.
1129 for (i=0; i<key->mv_size; i++)
1130 ptr += sprintf(ptr, "%02x", *c++);
1132 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1137 /** Display all the keys in the page. */
1139 mdb_page_list(MDB_page *mp)
1142 unsigned int i, nkeys, nsize;
1146 nkeys = NUMKEYS(mp);
1147 fprintf(stderr, "Page %zu numkeys %d\n", mp->mp_pgno, nkeys);
1148 for (i=0; i<nkeys; i++) {
1149 node = NODEPTR(mp, i);
1150 key.mv_size = node->mn_ksize;
1151 key.mv_data = node->mn_data;
1152 nsize = NODESIZE + NODEKSZ(node) + sizeof(indx_t);
1153 if (IS_BRANCH(mp)) {
1154 fprintf(stderr, "key %d: page %zu, %s\n", i, NODEPGNO(node),
1157 if (F_ISSET(node->mn_flags, F_BIGDATA))
1158 nsize += sizeof(pgno_t);
1160 nsize += NODEDSZ(node);
1161 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1167 mdb_cursor_chk(MDB_cursor *mc)
1173 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1174 for (i=0; i<mc->mc_top; i++) {
1176 node = NODEPTR(mp, mc->mc_ki[i]);
1177 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1180 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1186 /** Count all the pages in each DB and in the freelist
1187 * and make sure it matches the actual number of pages
1190 static void mdb_audit(MDB_txn *txn)
1194 MDB_ID freecount, count;
1199 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1200 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1201 freecount += *(MDB_ID *)data.mv_data;
1204 for (i = 0; i<txn->mt_numdbs; i++) {
1205 MDB_xcursor mx, *mxp;
1206 mxp = (txn->mt_dbs[i].md_flags & MDB_DUPSORT) ? &mx : NULL;
1207 mdb_cursor_init(&mc, txn, i, mxp);
1208 if (txn->mt_dbs[i].md_root == P_INVALID)
1210 count += txn->mt_dbs[i].md_branch_pages +
1211 txn->mt_dbs[i].md_leaf_pages +
1212 txn->mt_dbs[i].md_overflow_pages;
1213 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1214 mdb_page_search(&mc, NULL, 0);
1218 mp = mc.mc_pg[mc.mc_top];
1219 for (j=0; j<NUMKEYS(mp); j++) {
1220 MDB_node *leaf = NODEPTR(mp, j);
1221 if (leaf->mn_flags & F_SUBDATA) {
1223 memcpy(&db, NODEDATA(leaf), sizeof(db));
1224 count += db.md_branch_pages + db.md_leaf_pages +
1225 db.md_overflow_pages;
1229 while (mdb_cursor_sibling(&mc, 1) == 0);
1232 if (freecount + count + 2 /* metapages */ != txn->mt_next_pgno) {
1233 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1234 txn->mt_txnid, freecount, count+2, freecount+count+2, txn->mt_next_pgno);
1240 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1242 return txn->mt_dbxs[dbi].md_cmp(a, b);
1246 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1248 if (txn->mt_dbxs[dbi].md_dcmp)
1249 return txn->mt_dbxs[dbi].md_dcmp(a, b);
1251 return EINVAL; /* too bad you can't distinguish this from a valid result */
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;
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 /** Merge shadow cursors back into parent's */
1747 mdb_cursor_merge(MDB_txn *txn)
1750 for (i=0; i<txn->mt_numdbs; i++) {
1751 if (txn->mt_cursors[i]) {
1753 while ((mc = txn->mt_cursors[i])) {
1754 txn->mt_cursors[i] = mc->mc_next;
1755 if (mc->mc_flags & C_SHADOW) {
1756 MDB_cursor *m2 = mc->mc_orig;
1758 m2->mc_snum = mc->mc_snum;
1759 m2->mc_top = mc->mc_top;
1760 for (j=0; j<mc->mc_snum; j++) {
1761 m2->mc_pg[j] = mc->mc_pg[j];
1762 m2->mc_ki[j] = mc->mc_ki[j];
1765 if (mc->mc_flags & C_ALLOCD)
1773 mdb_txn_reset0(MDB_txn *txn);
1775 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
1776 * @param[in] txn the transaction handle to initialize
1777 * @return 0 on success, non-zero on failure.
1780 mdb_txn_renew0(MDB_txn *txn)
1782 MDB_env *env = txn->mt_env;
1788 txn->mt_numdbs = env->me_numdbs;
1789 txn->mt_dbxs = env->me_dbxs; /* mostly static anyway */
1791 if (txn->mt_flags & MDB_TXN_RDONLY) {
1792 if (!env->me_txns) {
1793 i = mdb_env_pick_meta(env);
1794 txn->mt_txnid = env->me_metas[i]->mm_txnid;
1795 txn->mt_u.reader = NULL;
1797 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
1798 pthread_getspecific(env->me_txkey);
1800 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
1801 return MDB_BAD_RSLOT;
1803 pid_t pid = env->me_pid;
1804 pthread_t tid = pthread_self();
1807 for (i=0; i<env->me_txns->mti_numreaders; i++)
1808 if (env->me_txns->mti_readers[i].mr_pid == 0)
1810 if (i == env->me_maxreaders) {
1811 UNLOCK_MUTEX_R(env);
1812 return MDB_READERS_FULL;
1814 env->me_txns->mti_readers[i].mr_pid = pid;
1815 env->me_txns->mti_readers[i].mr_tid = tid;
1816 if (i >= env->me_txns->mti_numreaders)
1817 env->me_txns->mti_numreaders = i+1;
1818 /* Save numreaders for un-mutexed mdb_env_close() */
1819 env->me_numreaders = env->me_txns->mti_numreaders;
1820 UNLOCK_MUTEX_R(env);
1821 r = &env->me_txns->mti_readers[i];
1822 if (!(env->me_flags & MDB_NOTLS) &&
1823 (rc = pthread_setspecific(env->me_txkey, r)) != 0) {
1824 env->me_txns->mti_readers[i].mr_pid = 0;
1828 txn->mt_txnid = r->mr_txnid = env->me_txns->mti_txnid;
1829 txn->mt_u.reader = r;
1831 txn->mt_toggle = txn->mt_txnid & 1;
1832 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1836 txn->mt_txnid = env->me_txns->mti_txnid;
1837 txn->mt_toggle = txn->mt_txnid & 1;
1838 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1841 if (txn->mt_txnid == mdb_debug_start)
1844 txn->mt_dirty_room = MDB_IDL_UM_MAX;
1845 txn->mt_u.dirty_list = env->me_dirty_list;
1846 txn->mt_u.dirty_list[0].mid = 0;
1847 txn->mt_free_pgs = env->me_free_pgs;
1848 txn->mt_free_pgs[0] = 0;
1852 /* Copy the DB info and flags */
1853 memcpy(txn->mt_dbs, env->me_metas[txn->mt_toggle]->mm_dbs, 2 * sizeof(MDB_db));
1854 for (i=2; i<txn->mt_numdbs; i++) {
1855 x = env->me_dbflags[i];
1856 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
1857 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_STALE : 0;
1859 txn->mt_dbflags[0] = txn->mt_dbflags[1] = DB_VALID;
1861 if (env->me_maxpg < txn->mt_next_pgno) {
1862 mdb_txn_reset0(txn);
1863 return MDB_MAP_RESIZED;
1870 mdb_txn_renew(MDB_txn *txn)
1874 if (!txn || txn->mt_numdbs || !(txn->mt_flags & MDB_TXN_RDONLY))
1877 if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
1878 DPUTS("environment had fatal error, must shutdown!");
1882 rc = mdb_txn_renew0(txn);
1883 if (rc == MDB_SUCCESS) {
1884 DPRINTF("renew txn %zu%c %p on mdbenv %p, root page %zu",
1885 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1886 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1892 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
1896 int rc, size, tsize = sizeof(MDB_txn);
1898 if (env->me_flags & MDB_FATAL_ERROR) {
1899 DPUTS("environment had fatal error, must shutdown!");
1902 if ((env->me_flags & MDB_RDONLY) && !(flags & MDB_RDONLY))
1905 /* Nested transactions: Max 1 child, write txns only, no writemap */
1906 if (parent->mt_child ||
1907 (flags & MDB_RDONLY) || (parent->mt_flags & MDB_TXN_RDONLY) ||
1908 (env->me_flags & MDB_WRITEMAP))
1912 tsize = sizeof(MDB_ntxn);
1914 size = tsize + env->me_maxdbs * (sizeof(MDB_db)+1);
1915 if (!(flags & MDB_RDONLY))
1916 size += env->me_maxdbs * sizeof(MDB_cursor *);
1918 if ((txn = calloc(1, size)) == NULL) {
1919 DPRINTF("calloc: %s", strerror(ErrCode()));
1922 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
1923 if (flags & MDB_RDONLY) {
1924 txn->mt_flags |= MDB_TXN_RDONLY;
1925 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
1927 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
1928 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
1934 txn->mt_free_pgs = mdb_midl_alloc();
1935 if (!txn->mt_free_pgs) {
1939 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
1940 if (!txn->mt_u.dirty_list) {
1941 free(txn->mt_free_pgs);
1945 txn->mt_txnid = parent->mt_txnid;
1946 txn->mt_toggle = parent->mt_toggle;
1947 txn->mt_dirty_room = parent->mt_dirty_room;
1948 txn->mt_u.dirty_list[0].mid = 0;
1949 txn->mt_free_pgs[0] = 0;
1950 txn->mt_next_pgno = parent->mt_next_pgno;
1951 parent->mt_child = txn;
1952 txn->mt_parent = parent;
1953 txn->mt_numdbs = parent->mt_numdbs;
1954 txn->mt_dbxs = parent->mt_dbxs;
1955 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
1956 /* Copy parent's mt_dbflags, but clear DB_NEW */
1957 for (i=0; i<txn->mt_numdbs; i++)
1958 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
1960 ntxn = (MDB_ntxn *)txn;
1961 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
1962 if (env->me_pghead) {
1963 size = MDB_IDL_SIZEOF(env->me_pghead);
1964 env->me_pghead = malloc(size);
1966 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
1970 env->me_pgfree = env->me_pghead;
1972 rc = mdb_cursor_shadow(parent, txn);
1974 mdb_txn_reset0(txn);
1976 rc = mdb_txn_renew0(txn);
1982 DPRINTF("begin txn %zu%c %p on mdbenv %p, root page %zu",
1983 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1984 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root);
1990 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
1991 * May be called twice for readonly txns: First reset it, then abort.
1992 * @param[in] txn the transaction handle to reset
1995 mdb_txn_reset0(MDB_txn *txn)
1997 MDB_env *env = txn->mt_env;
2000 /* Close any DBI handles opened in this txn */
2001 for (i=2; i<txn->mt_numdbs; i++) {
2002 if (txn->mt_dbflags[i] & DB_NEW) {
2003 char *ptr = env->me_dbxs[i].md_name.mv_data;
2004 env->me_dbxs[i].md_name.mv_data = NULL;
2005 env->me_dbxs[i].md_name.mv_size = 0;
2006 env->me_dbflags[i] = 0;
2011 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2012 if (txn->mt_u.reader) {
2013 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
2014 if (!(env->me_flags & MDB_NOTLS))
2015 txn->mt_u.reader = NULL; /* txn does not own reader */
2017 txn->mt_numdbs = 0; /* mark txn as reset, do not close DBs again */
2021 /* close(free) all cursors */
2022 for (i=0; i<txn->mt_numdbs; i++) {
2023 if (txn->mt_cursors[i]) {
2025 while ((mc = txn->mt_cursors[i])) {
2026 txn->mt_cursors[i] = mc->mc_next;
2027 if (mc->mc_flags & C_ALLOCD)
2033 if (!(env->me_flags & MDB_WRITEMAP)) {
2034 /* return all dirty pages to dpage list */
2035 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2036 dp = txn->mt_u.dirty_list[i].mptr;
2037 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2038 mdb_page_free(txn->mt_env, dp);
2040 /* large pages just get freed directly */
2041 VGMEMP_FREE(txn->mt_env, dp);
2047 free(env->me_pgfree);
2049 if (txn->mt_parent) {
2050 txn->mt_parent->mt_child = NULL;
2051 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2052 mdb_midl_free(txn->mt_free_pgs);
2053 free(txn->mt_u.dirty_list);
2056 if (mdb_midl_shrink(&txn->mt_free_pgs))
2057 env->me_free_pgs = txn->mt_free_pgs;
2060 txn->mt_env->me_pghead = txn->mt_env->me_pgfree = NULL;
2061 txn->mt_env->me_pglast = 0;
2064 /* The writer mutex was locked in mdb_txn_begin. */
2065 UNLOCK_MUTEX_W(env);
2070 mdb_txn_reset(MDB_txn *txn)
2075 DPRINTF("reset txn %zu%c %p on mdbenv %p, root page %zu",
2076 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2077 (void *) txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
2079 /* This call is only valid for read-only txns */
2080 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2083 mdb_txn_reset0(txn);
2087 mdb_txn_abort(MDB_txn *txn)
2092 DPRINTF("abort 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);
2097 mdb_txn_abort(txn->mt_child);
2099 mdb_txn_reset0(txn);
2100 /* Free reader slot tied to this txn (if MDB_NOTLS && writable FS) */
2101 if ((txn->mt_flags & MDB_TXN_RDONLY) && txn->mt_u.reader)
2102 txn->mt_u.reader->mr_pid = 0;
2108 mdb_txn_commit(MDB_txn *txn)
2116 pgno_t next, freecnt;
2117 txnid_t oldpg_txnid, id;
2120 assert(txn != NULL);
2121 assert(txn->mt_env != NULL);
2123 if (txn->mt_child) {
2124 mdb_txn_commit(txn->mt_child);
2125 txn->mt_child = NULL;
2130 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2131 /* update the DB flags */
2132 for (i = 2; i<txn->mt_numdbs; i++) {
2133 if (txn->mt_dbflags[i] & DB_NEW)
2134 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2136 if (txn->mt_numdbs > env->me_numdbs)
2137 env->me_numdbs = txn->mt_numdbs;
2138 txn->mt_numdbs = 2; /* so txn_abort() doesn't close any new handles */
2143 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
2144 DPUTS("error flag is set, can't commit");
2146 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
2151 if (txn->mt_parent) {
2152 MDB_txn *parent = txn->mt_parent;
2156 /* Append our free list to parent's */
2157 if (mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs)) {
2161 mdb_midl_free(txn->mt_free_pgs);
2163 parent->mt_next_pgno = txn->mt_next_pgno;
2164 parent->mt_flags = txn->mt_flags;
2166 /* Merge (and close) our cursors with parent's */
2167 mdb_cursor_merge(txn);
2169 /* Update parent's DB table. */
2170 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2171 txn->mt_parent->mt_numdbs = txn->mt_numdbs;
2172 txn->mt_parent->mt_dbflags[0] = txn->mt_dbflags[0];
2173 txn->mt_parent->mt_dbflags[1] = txn->mt_dbflags[1];
2174 for (i=2; i<txn->mt_numdbs; i++) {
2175 /* preserve parent's DB_NEW status */
2176 x = txn->mt_parent->mt_dbflags[i] & DB_NEW;
2177 txn->mt_parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
2180 dst = txn->mt_parent->mt_u.dirty_list;
2181 src = txn->mt_u.dirty_list;
2182 /* Find len = length of merging our dirty list with parent's */
2184 dst[0].mid = 0; /* simplify loops */
2185 if (parent->mt_parent) {
2186 len = x + src[0].mid;
2187 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
2188 for (i = x; y && i; y--) {
2189 pgno_t yp = src[y].mid;
2190 while (yp < dst[i].mid)
2192 if (yp == dst[i].mid) {
2197 } else { /* Simplify the above for single-ancestor case */
2198 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
2200 /* Merge our dirty list with parent's */
2202 for (i = len; y; dst[i--] = src[y--]) {
2203 pgno_t yp = src[y].mid;
2204 while (yp < dst[x].mid)
2205 dst[i--] = dst[x--];
2206 if (yp == dst[x].mid)
2207 free(dst[x--].mptr);
2211 free(txn->mt_u.dirty_list);
2212 parent->mt_dirty_room = txn->mt_dirty_room;
2214 txn->mt_parent->mt_child = NULL;
2215 free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pgfree);
2220 if (txn != env->me_txn) {
2221 DPUTS("attempt to commit unknown transaction");
2226 if (!txn->mt_u.dirty_list[0].mid && !(txn->mt_flags & MDB_TXN_DIRTY))
2229 DPRINTF("committing txn %zu %p on mdbenv %p, root page %zu",
2230 txn->mt_txnid, (void *)txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root);
2232 /* Update DB root pointers */
2233 if (txn->mt_numdbs > 2) {
2236 data.mv_size = sizeof(MDB_db);
2238 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
2239 for (i = 2; i < txn->mt_numdbs; i++) {
2240 if (txn->mt_dbflags[i] & DB_DIRTY) {
2241 data.mv_data = &txn->mt_dbs[i];
2242 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
2249 /* Save the freelist as of this transaction to the freeDB. This
2250 * can change the freelist, so keep trying until it stabilizes.
2252 * env->me_pglast and the length of txn->mt_free_pgs cannot decrease,
2253 * except the code below can decrease env->me_pglast to split pghead.
2254 * Page numbers cannot disappear from txn->mt_free_pgs. New pages
2255 * can only appear in env->me_pghead when env->me_pglast increases.
2256 * Until then, the me_pghead pointer won't move but can become NULL.
2259 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
2260 oldpg_txnid = id = 0;
2263 /* should only be one record now */
2264 if (env->me_pghead || env->me_pglast) {
2265 /* make sure first page of freeDB is touched and on freelist */
2266 rc = mdb_page_search(&mc, NULL, MDB_PS_MODIFY);
2267 if (rc && rc != MDB_NOTFOUND) {
2274 /* Delete IDLs we used from the free list */
2275 if (env->me_pglast) {
2280 rc = mdb_cursor_first(&mc, &key, NULL);
2283 oldpg_txnid = *(txnid_t *)key.mv_data;
2285 assert(oldpg_txnid <= env->me_pglast);
2287 rc = mdb_cursor_del(&mc, 0);
2290 } while (oldpg_txnid < env->me_pglast);
2293 /* Save IDL of pages freed by this txn, to freeDB */
2295 if (freecnt != txn->mt_free_pgs[0]) {
2298 /* make sure last page of freeDB is touched and on freelist */
2299 key.mv_size = MDB_MAXKEYSIZE+1;
2301 rc = mdb_page_search(&mc, &key, MDB_PS_MODIFY);
2302 if (rc && rc != MDB_NOTFOUND)
2308 MDB_IDL idl = txn->mt_free_pgs;
2309 mdb_midl_sort(txn->mt_free_pgs);
2310 DPRINTF("IDL write txn %zu root %zu num %zu",
2311 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
2312 for (i=1; i<=idl[0]; i++) {
2313 DPRINTF("IDL %zu", idl[i]);
2317 /* write to last page of freeDB */
2318 key.mv_size = sizeof(pgno_t);
2319 key.mv_data = &txn->mt_txnid;
2320 /* The free list can still grow during this call,
2321 * despite the pre-emptive touches above. So retry
2322 * until the reserved space remains big enough.
2325 assert(freecnt < txn->mt_free_pgs[0]);
2326 freecnt = txn->mt_free_pgs[0];
2327 data.mv_size = MDB_IDL_SIZEOF(txn->mt_free_pgs);
2328 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2331 } while (freecnt != txn->mt_free_pgs[0]);
2332 mdb_midl_sort(txn->mt_free_pgs);
2333 memcpy(data.mv_data, txn->mt_free_pgs, data.mv_size);
2334 if (oldpg_txnid < env->me_pglast || (!env->me_pghead && id))
2335 goto free_pgfirst; /* used up freeDB[oldpg_txnid] */
2338 /* Put back page numbers we took from freeDB but did not use */
2339 if (env->me_pghead) {
2344 mop = env->me_pghead;
2345 id = env->me_pglast;
2346 key.mv_size = sizeof(id);
2348 /* These steps may grow the freelist again
2349 * due to freed overflow pages...
2354 if (orig > env->me_maxfree_1pg && id > 4)
2355 orig = env->me_maxfree_1pg; /* Do not use more than 1 page */
2356 data.mv_size = (orig + 1) * sizeof(pgno_t);
2357 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2360 assert(!env->me_pghead || env->me_pglast);
2361 /* mop could have been used again here */
2362 if (id != env->me_pglast || env->me_pghead == NULL)
2363 goto again; /* was completely used up */
2364 assert(mop == env->me_pghead);
2365 } while (mop[0] < orig && --i);
2366 memcpy(data.mv_data, mop, data.mv_size);
2369 *(pgno_t *)data.mv_data = orig;
2370 mop[orig] = mop[0] - orig;
2371 env->me_pghead = mop += orig;
2372 /* Save more oldpages at the previous txnid. */
2373 assert(env->me_pglast == id && id == oldpg_txnid);
2374 env->me_pglast = --oldpg_txnid;
2378 /* Check for growth of freelist again */
2379 if (freecnt != txn->mt_free_pgs[0])
2382 free(env->me_pgfree);
2383 env->me_pghead = env->me_pgfree = NULL;
2385 if (!MDB_IDL_IS_ZERO(txn->mt_free_pgs)) {
2386 if (mdb_midl_shrink(&txn->mt_free_pgs))
2387 env->me_free_pgs = txn->mt_free_pgs;
2394 if (env->me_flags & MDB_WRITEMAP) {
2395 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2396 dp = txn->mt_u.dirty_list[i].mptr;
2397 /* clear dirty flag */
2398 dp->mp_flags &= ~P_DIRTY;
2399 txn->mt_u.dirty_list[i].mid = 0;
2401 txn->mt_u.dirty_list[0].mid = 0;
2405 /* Commit up to MDB_COMMIT_PAGES dirty pages to disk until done.
2411 /* Windows actually supports scatter/gather I/O, but only on
2412 * unbuffered file handles. Since we're relying on the OS page
2413 * cache for all our data, that's self-defeating. So we just
2414 * write pages one at a time. We use the ov structure to set
2415 * the write offset, to at least save the overhead of a Seek
2419 memset(&ov, 0, sizeof(ov));
2420 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2422 dp = txn->mt_u.dirty_list[i].mptr;
2423 DPRINTF("committing page %zu", dp->mp_pgno);
2424 size = dp->mp_pgno * env->me_psize;
2425 ov.Offset = size & 0xffffffff;
2426 ov.OffsetHigh = size >> 16;
2427 ov.OffsetHigh >>= 16;
2428 /* clear dirty flag */
2429 dp->mp_flags &= ~P_DIRTY;
2430 wsize = env->me_psize;
2431 if (IS_OVERFLOW(dp)) wsize *= dp->mp_pages;
2432 rc = WriteFile(env->me_fd, dp, wsize, NULL, &ov);
2435 DPRINTF("WriteFile: %d", n);
2442 struct iovec iov[MDB_COMMIT_PAGES];
2446 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2447 dp = txn->mt_u.dirty_list[i].mptr;
2448 if (dp->mp_pgno != next) {
2450 rc = writev(env->me_fd, iov, n);
2454 DPUTS("short write, filesystem full?");
2456 DPRINTF("writev: %s", strerror(n));
2463 lseek(env->me_fd, dp->mp_pgno * env->me_psize, SEEK_SET);
2466 DPRINTF("committing page %zu", dp->mp_pgno);
2467 iov[n].iov_len = env->me_psize;
2468 if (IS_OVERFLOW(dp)) iov[n].iov_len *= dp->mp_pages;
2469 iov[n].iov_base = (char *)dp;
2470 size += iov[n].iov_len;
2471 next = dp->mp_pgno + (IS_OVERFLOW(dp) ? dp->mp_pages : 1);
2472 /* clear dirty flag */
2473 dp->mp_flags &= ~P_DIRTY;
2474 if (++n >= MDB_COMMIT_PAGES) {
2484 rc = writev(env->me_fd, iov, n);
2488 DPUTS("short write, filesystem full?");
2490 DPRINTF("writev: %s", strerror(n));
2497 /* Drop the dirty pages.
2499 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2500 dp = txn->mt_u.dirty_list[i].mptr;
2501 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2502 mdb_page_free(txn->mt_env, dp);
2504 VGMEMP_FREE(txn->mt_env, dp);
2507 txn->mt_u.dirty_list[i].mid = 0;
2509 txn->mt_u.dirty_list[0].mid = 0;
2512 if ((n = mdb_env_sync(env, 0)) != 0 ||
2513 (n = mdb_env_write_meta(txn)) != MDB_SUCCESS) {
2521 /* update the DB flags */
2522 for (i = 2; i<txn->mt_numdbs; i++) {
2523 if (txn->mt_dbflags[i] & DB_NEW)
2524 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2526 if (txn->mt_numdbs > env->me_numdbs)
2527 env->me_numdbs = txn->mt_numdbs;
2529 UNLOCK_MUTEX_W(env);
2535 /** Read the environment parameters of a DB environment before
2536 * mapping it into memory.
2537 * @param[in] env the environment handle
2538 * @param[out] meta address of where to store the meta information
2539 * @return 0 on success, non-zero on failure.
2542 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
2549 /* We don't know the page size yet, so use a minimum value.
2550 * Read both meta pages so we can use the latest one.
2553 for (i=0; i<2; i++) {
2555 if (!ReadFile(env->me_fd, &pbuf, MDB_PAGESIZE, (DWORD *)&rc, NULL) || rc == 0)
2557 if ((rc = read(env->me_fd, &pbuf, MDB_PAGESIZE)) == 0)
2562 else if (rc != MDB_PAGESIZE) {
2566 DPRINTF("read: %s", strerror(err));
2570 p = (MDB_page *)&pbuf;
2572 if (!F_ISSET(p->mp_flags, P_META)) {
2573 DPRINTF("page %zu not a meta page", p->mp_pgno);
2578 if (m->mm_magic != MDB_MAGIC) {
2579 DPUTS("meta has invalid magic");
2583 if (m->mm_version != MDB_VERSION) {
2584 DPRINTF("database is version %u, expected version %u",
2585 m->mm_version, MDB_VERSION);
2586 return MDB_VERSION_MISMATCH;
2590 if (m->mm_txnid > meta->mm_txnid)
2591 memcpy(meta, m, sizeof(*m));
2593 memcpy(meta, m, sizeof(*m));
2595 if (SetFilePointer(env->me_fd, meta->mm_psize, NULL, FILE_BEGIN) != meta->mm_psize)
2597 if (lseek(env->me_fd, meta->mm_psize, SEEK_SET) != meta->mm_psize)
2605 /** Write the environment parameters of a freshly created DB environment.
2606 * @param[in] env the environment handle
2607 * @param[out] meta address of where to store the meta information
2608 * @return 0 on success, non-zero on failure.
2611 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
2618 DPUTS("writing new meta page");
2620 GET_PAGESIZE(psize);
2622 meta->mm_magic = MDB_MAGIC;
2623 meta->mm_version = MDB_VERSION;
2624 meta->mm_mapsize = env->me_mapsize;
2625 meta->mm_psize = psize;
2626 meta->mm_last_pg = 1;
2627 meta->mm_flags = env->me_flags & 0xffff;
2628 meta->mm_flags |= MDB_INTEGERKEY;
2629 meta->mm_dbs[0].md_root = P_INVALID;
2630 meta->mm_dbs[1].md_root = P_INVALID;
2632 p = calloc(2, psize);
2634 p->mp_flags = P_META;
2637 memcpy(m, meta, sizeof(*meta));
2639 q = (MDB_page *)((char *)p + psize);
2642 q->mp_flags = P_META;
2645 memcpy(m, meta, sizeof(*meta));
2650 SetFilePointer(env->me_fd, 0, NULL, FILE_BEGIN);
2651 rc = WriteFile(env->me_fd, p, psize * 2, &len, NULL);
2652 rc = (len == psize * 2) ? MDB_SUCCESS : ErrCode();
2655 lseek(env->me_fd, 0, SEEK_SET);
2656 rc = write(env->me_fd, p, psize * 2);
2657 rc = (rc == (int)psize * 2) ? MDB_SUCCESS : ErrCode();
2663 /** Update the environment info to commit a transaction.
2664 * @param[in] txn the transaction that's being committed
2665 * @return 0 on success, non-zero on failure.
2668 mdb_env_write_meta(MDB_txn *txn)
2671 MDB_meta meta, metab, *mp;
2673 int rc, len, toggle;
2680 assert(txn != NULL);
2681 assert(txn->mt_env != NULL);
2683 toggle = !txn->mt_toggle;
2684 DPRINTF("writing meta page %d for root page %zu",
2685 toggle, txn->mt_dbs[MAIN_DBI].md_root);
2688 mp = env->me_metas[toggle];
2690 if (env->me_flags & MDB_WRITEMAP) {
2691 /* Persist any increases of mapsize config */
2692 if (env->me_mapsize > mp->mm_mapsize)
2693 mp->mm_mapsize = env->me_mapsize;
2694 mp->mm_dbs[0] = txn->mt_dbs[0];
2695 mp->mm_dbs[1] = txn->mt_dbs[1];
2696 mp->mm_last_pg = txn->mt_next_pgno - 1;
2697 mp->mm_txnid = txn->mt_txnid;
2698 if (!(env->me_flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
2699 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
2702 ptr += env->me_psize;
2703 if (MDB_MSYNC(ptr, env->me_psize, rc)) {
2710 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
2711 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
2713 ptr = (char *)&meta;
2714 if (env->me_mapsize > mp->mm_mapsize) {
2715 /* Persist any increases of mapsize config */
2716 meta.mm_mapsize = env->me_mapsize;
2717 off = offsetof(MDB_meta, mm_mapsize);
2719 off = offsetof(MDB_meta, mm_dbs[0].md_depth);
2721 len = sizeof(MDB_meta) - off;
2724 meta.mm_dbs[0] = txn->mt_dbs[0];
2725 meta.mm_dbs[1] = txn->mt_dbs[1];
2726 meta.mm_last_pg = txn->mt_next_pgno - 1;
2727 meta.mm_txnid = txn->mt_txnid;
2730 off += env->me_psize;
2733 /* Write to the SYNC fd */
2734 mfd = env->me_flags & (MDB_NOSYNC|MDB_NOMETASYNC) ?
2735 env->me_fd : env->me_mfd;
2738 memset(&ov, 0, sizeof(ov));
2740 WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov);
2743 rc = pwrite(mfd, ptr, len, off);
2748 DPUTS("write failed, disk error?");
2749 /* On a failure, the pagecache still contains the new data.
2750 * Write some old data back, to prevent it from being used.
2751 * Use the non-SYNC fd; we know it will fail anyway.
2753 meta.mm_last_pg = metab.mm_last_pg;
2754 meta.mm_txnid = metab.mm_txnid;
2756 WriteFile(env->me_fd, ptr, len, NULL, &ov);
2758 r2 = pwrite(env->me_fd, ptr, len, off);
2761 env->me_flags |= MDB_FATAL_ERROR;
2765 /* Memory ordering issues are irrelevant; since the entire writer
2766 * is wrapped by wmutex, all of these changes will become visible
2767 * after the wmutex is unlocked. Since the DB is multi-version,
2768 * readers will get consistent data regardless of how fresh or
2769 * how stale their view of these values is.
2771 txn->mt_env->me_txns->mti_txnid = txn->mt_txnid;
2776 /** Check both meta pages to see which one is newer.
2777 * @param[in] env the environment handle
2778 * @return meta toggle (0 or 1).
2781 mdb_env_pick_meta(const MDB_env *env)
2783 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
2787 mdb_env_create(MDB_env **env)
2791 e = calloc(1, sizeof(MDB_env));
2795 e->me_maxreaders = DEFAULT_READERS;
2796 e->me_maxdbs = e->me_numdbs = 2;
2797 e->me_fd = INVALID_HANDLE_VALUE;
2798 e->me_lfd = INVALID_HANDLE_VALUE;
2799 e->me_mfd = INVALID_HANDLE_VALUE;
2800 #ifdef MDB_USE_POSIX_SEM
2801 e->me_rmutex = SEM_FAILED;
2802 e->me_wmutex = SEM_FAILED;
2804 e->me_pid = getpid();
2805 VGMEMP_CREATE(e,0,0);
2811 mdb_env_set_mapsize(MDB_env *env, size_t size)
2815 env->me_mapsize = size;
2817 env->me_maxpg = env->me_mapsize / env->me_psize;
2822 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
2826 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
2831 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
2833 if (env->me_map || readers < 1)
2835 env->me_maxreaders = readers;
2840 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
2842 if (!env || !readers)
2844 *readers = env->me_maxreaders;
2848 /** Further setup required for opening an MDB environment
2851 mdb_env_open2(MDB_env *env)
2853 unsigned int flags = env->me_flags;
2854 int i, newenv = 0, prot;
2858 memset(&meta, 0, sizeof(meta));
2860 if ((i = mdb_env_read_header(env, &meta)) != 0) {
2863 DPUTS("new mdbenv");
2867 /* Was a mapsize configured? */
2868 if (!env->me_mapsize) {
2869 /* If this is a new environment, take the default,
2870 * else use the size recorded in the existing env.
2872 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
2873 } else if (env->me_mapsize < meta.mm_mapsize) {
2874 /* If the configured size is smaller, make sure it's
2875 * still big enough. Silently round up to minimum if not.
2877 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
2878 if (env->me_mapsize < minsize)
2879 env->me_mapsize = minsize;
2885 LONG sizelo, sizehi;
2886 sizelo = env->me_mapsize & 0xffffffff;
2887 sizehi = env->me_mapsize >> 16; /* pointless on WIN32, only needed on W64 */
2889 /* Windows won't create mappings for zero length files.
2890 * Just allocate the maxsize right now.
2893 SetFilePointer(env->me_fd, sizelo, sizehi ? &sizehi : NULL, 0);
2894 if (!SetEndOfFile(env->me_fd))
2896 SetFilePointer(env->me_fd, 0, NULL, 0);
2898 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
2899 PAGE_READWRITE : PAGE_READONLY,
2900 sizehi, sizelo, NULL);
2903 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
2904 FILE_MAP_WRITE : FILE_MAP_READ,
2905 0, 0, env->me_mapsize, meta.mm_address);
2913 if (flags & MDB_WRITEMAP) {
2915 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
2918 env->me_map = mmap(meta.mm_address, env->me_mapsize, prot, i,
2920 if (env->me_map == MAP_FAILED) {
2924 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
2926 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
2928 #ifdef POSIX_MADV_RANDOM
2929 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
2930 #endif /* POSIX_MADV_RANDOM */
2931 #endif /* MADV_RANDOM */
2935 if (flags & MDB_FIXEDMAP)
2936 meta.mm_address = env->me_map;
2937 i = mdb_env_init_meta(env, &meta);
2938 if (i != MDB_SUCCESS) {
2941 } else if (meta.mm_address && env->me_map != meta.mm_address) {
2942 /* Can happen because the address argument to mmap() is just a
2943 * hint. mmap() can pick another, e.g. if the range is in use.
2944 * The MAP_FIXED flag would prevent that, but then mmap could
2945 * instead unmap existing pages to make room for the new map.
2947 return EBUSY; /* TODO: Make a new MDB_* error code? */
2949 env->me_psize = meta.mm_psize;
2950 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
2951 env->me_nodemax = (env->me_psize - PAGEHDRSZ) / MDB_MINKEYS;
2953 env->me_maxpg = env->me_mapsize / env->me_psize;
2955 p = (MDB_page *)env->me_map;
2956 env->me_metas[0] = METADATA(p);
2957 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + meta.mm_psize);
2961 int toggle = mdb_env_pick_meta(env);
2962 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
2964 DPRINTF("opened database version %u, pagesize %u",
2965 env->me_metas[0]->mm_version, env->me_psize);
2966 DPRINTF("using meta page %d", toggle);
2967 DPRINTF("depth: %u", db->md_depth);
2968 DPRINTF("entries: %zu", db->md_entries);
2969 DPRINTF("branch pages: %zu", db->md_branch_pages);
2970 DPRINTF("leaf pages: %zu", db->md_leaf_pages);
2971 DPRINTF("overflow pages: %zu", db->md_overflow_pages);
2972 DPRINTF("root: %zu", db->md_root);
2980 /** Release a reader thread's slot in the reader lock table.
2981 * This function is called automatically when a thread exits.
2982 * @param[in] ptr This points to the slot in the reader lock table.
2985 mdb_env_reader_dest(void *ptr)
2987 MDB_reader *reader = ptr;
2993 /** Junk for arranging thread-specific callbacks on Windows. This is
2994 * necessarily platform and compiler-specific. Windows supports up
2995 * to 1088 keys. Let's assume nobody opens more than 64 environments
2996 * in a single process, for now. They can override this if needed.
2998 #ifndef MAX_TLS_KEYS
2999 #define MAX_TLS_KEYS 64
3001 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
3002 static int mdb_tls_nkeys;
3004 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
3008 case DLL_PROCESS_ATTACH: break;
3009 case DLL_THREAD_ATTACH: break;
3010 case DLL_THREAD_DETACH:
3011 for (i=0; i<mdb_tls_nkeys; i++) {
3012 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
3013 mdb_env_reader_dest(r);
3016 case DLL_PROCESS_DETACH: break;
3021 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3023 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3027 /* Force some symbol references.
3028 * _tls_used forces the linker to create the TLS directory if not already done
3029 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
3031 #pragma comment(linker, "/INCLUDE:_tls_used")
3032 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
3033 #pragma const_seg(".CRT$XLB")
3034 extern const PIMAGE_TLS_CALLBACK mdb_tls_callback;
3035 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3038 #pragma comment(linker, "/INCLUDE:__tls_used")
3039 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
3040 #pragma data_seg(".CRT$XLB")
3041 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3043 #endif /* WIN 32/64 */
3044 #endif /* !__GNUC__ */
3047 /** Downgrade the exclusive lock on the region back to shared */
3049 mdb_env_share_locks(MDB_env *env, int *excl)
3051 int rc = 0, toggle = mdb_env_pick_meta(env);
3053 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
3058 /* First acquire a shared lock. The Unlock will
3059 * then release the existing exclusive lock.
3061 memset(&ov, 0, sizeof(ov));
3062 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3065 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3071 struct flock lock_info;
3072 /* The shared lock replaces the existing lock */
3073 memset((void *)&lock_info, 0, sizeof(lock_info));
3074 lock_info.l_type = F_RDLCK;
3075 lock_info.l_whence = SEEK_SET;
3076 lock_info.l_start = 0;
3077 lock_info.l_len = 1;
3078 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3079 (rc = ErrCode()) == EINTR) ;
3080 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
3087 /** Try to get exlusive lock, otherwise shared.
3088 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
3091 mdb_env_excl_lock(MDB_env *env, int *excl)
3095 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
3099 memset(&ov, 0, sizeof(ov));
3100 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3107 struct flock lock_info;
3108 memset((void *)&lock_info, 0, sizeof(lock_info));
3109 lock_info.l_type = F_WRLCK;
3110 lock_info.l_whence = SEEK_SET;
3111 lock_info.l_start = 0;
3112 lock_info.l_len = 1;
3113 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3114 (rc = ErrCode()) == EINTR) ;
3118 # ifdef MDB_USE_POSIX_SEM
3119 if (*excl < 0) /* always true when !MDB_USE_POSIX_SEM */
3122 lock_info.l_type = F_RDLCK;
3123 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
3124 (rc = ErrCode()) == EINTR) ;
3132 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
3134 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
3136 * @(#) $Revision: 5.1 $
3137 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
3138 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
3140 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
3144 * Please do not copyright this code. This code is in the public domain.
3146 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
3147 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
3148 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
3149 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
3150 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
3151 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
3152 * PERFORMANCE OF THIS SOFTWARE.
3155 * chongo <Landon Curt Noll> /\oo/\
3156 * http://www.isthe.com/chongo/
3158 * Share and Enjoy! :-)
3161 typedef unsigned long long mdb_hash_t;
3162 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
3164 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
3165 * @param[in] str string to hash
3166 * @param[in] hval initial value for hash
3167 * @return 64 bit hash
3169 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
3170 * hval arg on the first call.
3173 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
3175 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
3176 unsigned char *end = s + val->mv_size;
3178 * FNV-1a hash each octet of the string
3181 /* xor the bottom with the current octet */
3182 hval ^= (mdb_hash_t)*s++;
3184 /* multiply by the 64 bit FNV magic prime mod 2^64 */
3185 hval += (hval << 1) + (hval << 4) + (hval << 5) +
3186 (hval << 7) + (hval << 8) + (hval << 40);
3188 /* return our new hash value */
3192 /** Hash the string and output the hash in hex.
3193 * @param[in] str string to hash
3194 * @param[out] hexbuf an array of 17 chars to hold the hash
3197 mdb_hash_hex(MDB_val *val, char *hexbuf)
3200 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
3201 for (i=0; i<8; i++) {
3202 hexbuf += sprintf(hexbuf, "%02x", (unsigned int)h & 0xff);
3208 /** Open and/or initialize the lock region for the environment.
3209 * @param[in] env The MDB environment.
3210 * @param[in] lpath The pathname of the file used for the lock region.
3211 * @param[in] mode The Unix permissions for the file, if we create it.
3212 * @param[out] excl Resulting file lock type: -1 none, 0 shared, 1 exclusive
3213 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
3214 * @return 0 on success, non-zero on failure.
3217 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
3220 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
3222 # define MDB_ERRCODE_ROFS EROFS
3223 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
3224 # define MDB_CLOEXEC O_CLOEXEC
3227 # define MDB_CLOEXEC 0
3234 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
3235 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
3236 FILE_ATTRIBUTE_NORMAL, NULL);
3238 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
3240 if (env->me_lfd == INVALID_HANDLE_VALUE) {
3242 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
3247 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
3248 /* Lose record locks when exec*() */
3249 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
3250 fcntl(env->me_lfd, F_SETFD, fdflags);
3253 if (!(env->me_flags & MDB_NOTLS)) {
3254 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
3257 env->me_flags |= MDB_ENV_TXKEY;
3259 /* Windows TLS callbacks need help finding their TLS info. */
3260 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
3264 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
3268 /* Try to get exclusive lock. If we succeed, then
3269 * nobody is using the lock region and we should initialize it.
3271 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
3274 size = GetFileSize(env->me_lfd, NULL);
3276 size = lseek(env->me_lfd, 0, SEEK_END);
3278 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
3279 if (size < rsize && *excl > 0) {
3281 SetFilePointer(env->me_lfd, rsize, NULL, 0);
3282 if (!SetEndOfFile(env->me_lfd)) goto fail_errno;
3284 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
3288 size = rsize - sizeof(MDB_txninfo);
3289 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
3294 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
3296 if (!mh) goto fail_errno;
3297 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
3299 if (!env->me_txns) goto fail_errno;
3301 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
3303 if (m == MAP_FAILED) goto fail_errno;
3309 BY_HANDLE_FILE_INFORMATION stbuf;
3318 if (!mdb_sec_inited) {
3319 InitializeSecurityDescriptor(&mdb_null_sd,
3320 SECURITY_DESCRIPTOR_REVISION);
3321 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
3322 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
3323 mdb_all_sa.bInheritHandle = FALSE;
3324 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
3327 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
3328 idbuf.volume = stbuf.dwVolumeSerialNumber;
3329 idbuf.nhigh = stbuf.nFileIndexHigh;
3330 idbuf.nlow = stbuf.nFileIndexLow;
3331 val.mv_data = &idbuf;
3332 val.mv_size = sizeof(idbuf);
3333 mdb_hash_hex(&val, hexbuf);
3334 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", hexbuf);
3335 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", hexbuf);
3336 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
3337 if (!env->me_rmutex) goto fail_errno;
3338 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
3339 if (!env->me_wmutex) goto fail_errno;
3340 #elif defined(MDB_USE_POSIX_SEM)
3349 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
3350 idbuf.dev = stbuf.st_dev;
3351 idbuf.ino = stbuf.st_ino;
3352 val.mv_data = &idbuf;
3353 val.mv_size = sizeof(idbuf);
3354 mdb_hash_hex(&val, hexbuf);
3355 sprintf(env->me_txns->mti_rmname, "/MDBr%s", hexbuf);
3356 sprintf(env->me_txns->mti_wmname, "/MDBw%s", hexbuf);
3357 /* Clean up after a previous run, if needed: Try to
3358 * remove both semaphores before doing anything else.
3360 sem_unlink(env->me_txns->mti_rmname);
3361 sem_unlink(env->me_txns->mti_wmname);
3362 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
3363 O_CREAT|O_EXCL, mode, 1);
3364 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3365 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
3366 O_CREAT|O_EXCL, mode, 1);
3367 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3368 #else /* MDB_USE_POSIX_SEM */
3369 pthread_mutexattr_t mattr;
3371 if ((rc = pthread_mutexattr_init(&mattr))
3372 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
3373 || (rc = pthread_mutex_init(&env->me_txns->mti_mutex, &mattr))
3374 || (rc = pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr)))
3376 pthread_mutexattr_destroy(&mattr);
3377 #endif /* _WIN32 || MDB_USE_POSIX_SEM */
3379 env->me_txns->mti_version = MDB_VERSION;
3380 env->me_txns->mti_magic = MDB_MAGIC;
3381 env->me_txns->mti_txnid = 0;
3382 env->me_txns->mti_numreaders = 0;
3385 if (env->me_txns->mti_magic != MDB_MAGIC) {
3386 DPUTS("lock region has invalid magic");
3390 if (env->me_txns->mti_version != MDB_VERSION) {
3391 DPRINTF("lock region is version %u, expected version %u",
3392 env->me_txns->mti_version, MDB_VERSION);
3393 rc = MDB_VERSION_MISMATCH;
3397 if (rc != EACCES && rc != EAGAIN) {
3401 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
3402 if (!env->me_rmutex) goto fail_errno;
3403 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
3404 if (!env->me_wmutex) goto fail_errno;
3405 #elif defined(MDB_USE_POSIX_SEM)
3406 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
3407 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3408 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
3409 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3420 /** The name of the lock file in the DB environment */
3421 #define LOCKNAME "/lock.mdb"
3422 /** The name of the data file in the DB environment */
3423 #define DATANAME "/data.mdb"
3424 /** The suffix of the lock file when no subdir is used */
3425 #define LOCKSUFF "-lock"
3426 /** Only a subset of the @ref mdb_env flags can be changed
3427 * at runtime. Changing other flags requires closing the
3428 * environment and re-opening it with the new flags.
3430 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC)
3431 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY|MDB_WRITEMAP|MDB_NOTLS)
3434 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
3436 int oflags, rc, len, excl = -1;
3437 char *lpath, *dpath;
3439 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
3443 if (flags & MDB_NOSUBDIR) {
3444 rc = len + sizeof(LOCKSUFF) + len + 1;
3446 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
3451 if (flags & MDB_NOSUBDIR) {
3452 dpath = lpath + len + sizeof(LOCKSUFF);
3453 sprintf(lpath, "%s" LOCKSUFF, path);
3454 strcpy(dpath, path);
3456 dpath = lpath + len + sizeof(LOCKNAME);
3457 sprintf(lpath, "%s" LOCKNAME, path);
3458 sprintf(dpath, "%s" DATANAME, path);
3462 flags |= env->me_flags;
3463 if (flags & MDB_RDONLY) {
3464 /* silently ignore WRITEMAP when we're only getting read access */
3465 flags &= ~MDB_WRITEMAP;
3467 if (!((env->me_free_pgs = mdb_midl_alloc()) &&
3468 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
3471 env->me_flags = flags |= MDB_ENV_ACTIVE;
3475 env->me_path = strdup(path);
3476 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
3477 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
3478 if (!(env->me_dbxs && env->me_path && env->me_dbflags)) {
3483 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
3488 if (F_ISSET(flags, MDB_RDONLY)) {
3489 oflags = GENERIC_READ;
3490 len = OPEN_EXISTING;
3492 oflags = GENERIC_READ|GENERIC_WRITE;
3495 mode = FILE_ATTRIBUTE_NORMAL;
3496 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
3497 NULL, len, mode, NULL);
3499 if (F_ISSET(flags, MDB_RDONLY))
3502 oflags = O_RDWR | O_CREAT;
3504 env->me_fd = open(dpath, oflags, mode);
3506 if (env->me_fd == INVALID_HANDLE_VALUE) {
3511 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
3512 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
3513 env->me_mfd = env->me_fd;
3515 /* Synchronous fd for meta writes. Needed even with
3516 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
3519 env->me_mfd = CreateFile(dpath, oflags,
3520 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
3521 mode | FILE_FLAG_WRITE_THROUGH, NULL);
3523 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
3525 if (env->me_mfd == INVALID_HANDLE_VALUE) {
3530 DPRINTF("opened dbenv %p", (void *) env);
3532 rc = mdb_env_share_locks(env, &excl);
3538 mdb_env_close0(env, excl);
3544 /** Destroy resources from mdb_env_open() and clear our readers */
3546 mdb_env_close0(MDB_env *env, int excl)
3550 if (!(env->me_flags & MDB_ENV_ACTIVE))
3553 free(env->me_dbflags);
3556 free(env->me_dirty_list);
3557 if (env->me_free_pgs)
3558 mdb_midl_free(env->me_free_pgs);
3560 if (env->me_flags & MDB_ENV_TXKEY) {
3561 pthread_key_delete(env->me_txkey);
3563 /* Delete our key from the global list */
3564 for (i=0; i<mdb_tls_nkeys; i++)
3565 if (mdb_tls_keys[i] == env->me_txkey) {
3566 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
3574 munmap(env->me_map, env->me_mapsize);
3576 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
3578 if (env->me_fd != INVALID_HANDLE_VALUE)
3581 pid_t pid = env->me_pid;
3582 /* Clearing readers is done in this function because
3583 * me_txkey with its destructor must be disabled first.
3585 for (i = env->me_numreaders; --i >= 0; )
3586 if (env->me_txns->mti_readers[i].mr_pid == pid)
3587 env->me_txns->mti_readers[i].mr_pid = 0;
3589 if (env->me_rmutex) {
3590 CloseHandle(env->me_rmutex);
3591 if (env->me_wmutex) CloseHandle(env->me_wmutex);
3593 /* Windows automatically destroys the mutexes when
3594 * the last handle closes.
3596 #elif defined(MDB_USE_POSIX_SEM)
3597 if (env->me_rmutex != SEM_FAILED) {
3598 sem_close(env->me_rmutex);
3599 if (env->me_wmutex != SEM_FAILED)
3600 sem_close(env->me_wmutex);
3601 /* If we have the filelock: If we are the
3602 * only remaining user, clean up semaphores.
3605 mdb_env_excl_lock(env, &excl);
3607 sem_unlink(env->me_txns->mti_rmname);
3608 sem_unlink(env->me_txns->mti_wmname);
3612 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
3614 if (env->me_lfd != INVALID_HANDLE_VALUE) {
3617 /* Unlock the lockfile. Windows would have unlocked it
3618 * after closing anyway, but not necessarily at once.
3620 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3626 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
3630 mdb_env_copy(MDB_env *env, const char *path)
3632 MDB_txn *txn = NULL;
3636 HANDLE newfd = INVALID_HANDLE_VALUE;
3638 if (env->me_flags & MDB_NOSUBDIR) {
3639 lpath = (char *)path;
3642 len += sizeof(DATANAME);
3643 lpath = malloc(len);
3646 sprintf(lpath, "%s" DATANAME, path);
3649 /* The destination path must exist, but the destination file must not.
3650 * We don't want the OS to cache the writes, since the source data is
3651 * already in the OS cache.
3654 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
3655 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
3657 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL
3663 if (!(env->me_flags & MDB_NOSUBDIR))
3665 if (newfd == INVALID_HANDLE_VALUE) {
3670 #ifdef F_NOCACHE /* __APPLE__ */
3671 rc = fcntl(newfd, F_NOCACHE, 1);
3678 /* Do the lock/unlock of the reader mutex before starting the
3679 * write txn. Otherwise other read txns could block writers.
3681 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
3686 /* We must start the actual read txn after blocking writers */
3687 mdb_txn_reset0(txn);
3689 /* Temporarily block writers until we snapshot the meta pages */
3692 rc = mdb_txn_renew0(txn);
3694 UNLOCK_MUTEX_W(env);
3699 wsize = env->me_psize * 2;
3703 rc = WriteFile(newfd, env->me_map, wsize, &len, NULL);
3704 rc = (len == wsize) ? MDB_SUCCESS : ErrCode();
3707 rc = write(newfd, env->me_map, wsize);
3708 rc = (rc == (int)wsize) ? MDB_SUCCESS : ErrCode();
3711 UNLOCK_MUTEX_W(env);
3716 ptr = env->me_map + wsize;
3717 wsize = txn->mt_next_pgno * env->me_psize - wsize;
3718 #define MAX_WRITE 2147483648U
3722 if (wsize > MAX_WRITE)
3726 rc = WriteFile(newfd, ptr, w2, &len, NULL);
3727 rc = (len == w2) ? MDB_SUCCESS : ErrCode();
3736 if (wsize > MAX_WRITE)
3740 wres = write(newfd, ptr, w2);
3741 rc = (wres > 0) ? MDB_SUCCESS : ErrCode();
3750 if (newfd != INVALID_HANDLE_VALUE)
3757 mdb_env_close(MDB_env *env)
3765 for (i = env->me_maxdbs; --i > MAIN_DBI; )
3766 free(env->me_dbxs[i].md_name.mv_data);
3768 VGMEMP_DESTROY(env);
3769 while ((dp = env->me_dpages) != NULL) {
3770 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
3771 env->me_dpages = dp->mp_next;
3775 mdb_env_close0(env, 0);
3779 /** Compare two items pointing at aligned size_t's */
3781 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
3783 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
3784 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
3787 /** Compare two items pointing at aligned int's */
3789 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
3791 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
3792 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
3795 /** Compare two items pointing at ints of unknown alignment.
3796 * Nodes and keys are guaranteed to be 2-byte aligned.
3799 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
3801 #if BYTE_ORDER == LITTLE_ENDIAN
3802 unsigned short *u, *c;
3805 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
3806 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
3809 } while(!x && u > (unsigned short *)a->mv_data);
3812 return memcmp(a->mv_data, b->mv_data, a->mv_size);
3816 /** Compare two items lexically */
3818 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
3825 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3831 diff = memcmp(a->mv_data, b->mv_data, len);
3832 return diff ? diff : len_diff<0 ? -1 : len_diff;
3835 /** Compare two items in reverse byte order */
3837 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
3839 const unsigned char *p1, *p2, *p1_lim;
3843 p1_lim = (const unsigned char *)a->mv_data;
3844 p1 = (const unsigned char *)a->mv_data + a->mv_size;
3845 p2 = (const unsigned char *)b->mv_data + b->mv_size;
3847 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3853 while (p1 > p1_lim) {
3854 diff = *--p1 - *--p2;
3858 return len_diff<0 ? -1 : len_diff;
3861 /** Search for key within a page, using binary search.
3862 * Returns the smallest entry larger or equal to the key.
3863 * If exactp is non-null, stores whether the found entry was an exact match
3864 * in *exactp (1 or 0).
3865 * Updates the cursor index with the index of the found entry.
3866 * If no entry larger or equal to the key is found, returns NULL.
3869 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
3871 unsigned int i = 0, nkeys;
3874 MDB_page *mp = mc->mc_pg[mc->mc_top];
3875 MDB_node *node = NULL;
3880 nkeys = NUMKEYS(mp);
3885 COPY_PGNO(pgno, mp->mp_pgno);
3886 DPRINTF("searching %u keys in %s %spage %zu",
3887 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
3894 low = IS_LEAF(mp) ? 0 : 1;
3896 cmp = mc->mc_dbx->md_cmp;
3898 /* Branch pages have no data, so if using integer keys,
3899 * alignment is guaranteed. Use faster mdb_cmp_int.
3901 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
3902 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
3909 nodekey.mv_size = mc->mc_db->md_pad;
3910 node = NODEPTR(mp, 0); /* fake */
3911 while (low <= high) {
3912 i = (low + high) >> 1;
3913 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
3914 rc = cmp(key, &nodekey);
3915 DPRINTF("found leaf index %u [%s], rc = %i",
3916 i, DKEY(&nodekey), rc);
3925 while (low <= high) {
3926 i = (low + high) >> 1;
3928 node = NODEPTR(mp, i);
3929 nodekey.mv_size = NODEKSZ(node);
3930 nodekey.mv_data = NODEKEY(node);
3932 rc = cmp(key, &nodekey);
3935 DPRINTF("found leaf index %u [%s], rc = %i",
3936 i, DKEY(&nodekey), rc);
3938 DPRINTF("found branch index %u [%s -> %zu], rc = %i",
3939 i, DKEY(&nodekey), NODEPGNO(node), rc);
3950 if (rc > 0) { /* Found entry is less than the key. */
3951 i++; /* Skip to get the smallest entry larger than key. */
3953 node = NODEPTR(mp, i);
3956 *exactp = (rc == 0);
3957 /* store the key index */
3958 mc->mc_ki[mc->mc_top] = i;
3960 /* There is no entry larger or equal to the key. */
3963 /* nodeptr is fake for LEAF2 */
3969 mdb_cursor_adjust(MDB_cursor *mc, func)
3973 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
3974 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
3981 /** Pop a page off the top of the cursor's stack. */
3983 mdb_cursor_pop(MDB_cursor *mc)
3986 #ifndef MDB_DEBUG_SKIP
3987 MDB_page *top = mc->mc_pg[mc->mc_top];
3993 DPRINTF("popped page %zu off db %u cursor %p", top->mp_pgno,
3994 mc->mc_dbi, (void *) mc);
3998 /** Push a page onto the top of the cursor's stack. */
4000 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
4002 DPRINTF("pushing page %zu on db %u cursor %p", mp->mp_pgno,
4003 mc->mc_dbi, (void *) mc);
4005 if (mc->mc_snum >= CURSOR_STACK) {
4006 assert(mc->mc_snum < CURSOR_STACK);
4007 return MDB_CURSOR_FULL;
4010 mc->mc_top = mc->mc_snum++;
4011 mc->mc_pg[mc->mc_top] = mp;
4012 mc->mc_ki[mc->mc_top] = 0;
4017 /** Find the address of the page corresponding to a given page number.
4018 * @param[in] txn the transaction for this access.
4019 * @param[in] pgno the page number for the page to retrieve.
4020 * @param[out] ret address of a pointer where the page's address will be stored.
4021 * @return 0 on success, non-zero on failure.
4024 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret)
4028 if (!((txn->mt_flags & MDB_TXN_RDONLY) |
4029 (txn->mt_env->me_flags & MDB_WRITEMAP)))
4033 MDB_ID2L dl = tx2->mt_u.dirty_list;
4035 unsigned x = mdb_mid2l_search(dl, pgno);
4036 if (x <= dl[0].mid && dl[x].mid == pgno) {
4041 } while ((tx2 = tx2->mt_parent) != NULL);
4044 if (pgno < txn->mt_next_pgno) {
4045 p = (MDB_page *)(txn->mt_env->me_map + txn->mt_env->me_psize * pgno);
4047 DPRINTF("page %zu not found", pgno);
4053 return (p != NULL) ? MDB_SUCCESS : MDB_PAGE_NOTFOUND;
4056 /** Search for the page a given key should be in.
4057 * Pushes parent pages on the cursor stack. This function continues a
4058 * search on a cursor that has already been initialized. (Usually by
4059 * #mdb_page_search() but also by #mdb_node_move().)
4060 * @param[in,out] mc the cursor for this operation.
4061 * @param[in] key the key to search for. If NULL, search for the lowest
4062 * page. (This is used by #mdb_cursor_first().)
4063 * @param[in] flags If MDB_PS_MODIFY set, visited pages are updated with new page numbers.
4064 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
4065 * @return 0 on success, non-zero on failure.
4068 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int modify)
4070 MDB_page *mp = mc->mc_pg[mc->mc_top];
4075 while (IS_BRANCH(mp)) {
4079 DPRINTF("branch page %zu has %u keys", mp->mp_pgno, NUMKEYS(mp));
4080 assert(NUMKEYS(mp) > 1);
4081 DPRINTF("found index 0 to page %zu", NODEPGNO(NODEPTR(mp, 0)));
4083 if (key == NULL) /* Initialize cursor to first page. */
4085 else if (key->mv_size > MDB_MAXKEYSIZE && key->mv_data == NULL) {
4086 /* cursor to last page */
4090 node = mdb_node_search(mc, key, &exact);
4092 i = NUMKEYS(mp) - 1;
4094 i = mc->mc_ki[mc->mc_top];
4103 DPRINTF("following index %u for key [%s]",
4105 assert(i < NUMKEYS(mp));
4106 node = NODEPTR(mp, i);
4108 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
4111 mc->mc_ki[mc->mc_top] = i;
4112 if ((rc = mdb_cursor_push(mc, mp)))
4116 if ((rc = mdb_page_touch(mc)) != 0)
4118 mp = mc->mc_pg[mc->mc_top];
4123 DPRINTF("internal error, index points to a %02X page!?",
4125 return MDB_CORRUPTED;
4128 DPRINTF("found leaf page %zu for key [%s]", mp->mp_pgno,
4129 key ? DKEY(key) : NULL);
4134 /** Search for the lowest key under the current branch page.
4135 * This just bypasses a NUMKEYS check in the current page
4136 * before calling mdb_page_search_root(), because the callers
4137 * are all in situations where the current page is known to
4141 mdb_page_search_lowest(MDB_cursor *mc)
4143 MDB_page *mp = mc->mc_pg[mc->mc_top];
4144 MDB_node *node = NODEPTR(mp, 0);
4147 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
4150 mc->mc_ki[mc->mc_top] = 0;
4151 if ((rc = mdb_cursor_push(mc, mp)))
4153 return mdb_page_search_root(mc, NULL, 0);
4156 /** Search for the page a given key should be in.
4157 * Pushes parent pages on the cursor stack. This function just sets up
4158 * the search; it finds the root page for \b mc's database and sets this
4159 * as the root of the cursor's stack. Then #mdb_page_search_root() is
4160 * called to complete the search.
4161 * @param[in,out] mc the cursor for this operation.
4162 * @param[in] key the key to search for. If NULL, search for the lowest
4163 * page. (This is used by #mdb_cursor_first().)
4164 * @param[in] modify If true, visited pages are updated with new page numbers.
4165 * @return 0 on success, non-zero on failure.
4168 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
4173 /* Make sure the txn is still viable, then find the root from
4174 * the txn's db table.
4176 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
4177 DPUTS("transaction has failed, must abort");
4180 /* Make sure we're using an up-to-date root */
4181 if (mc->mc_dbi > MAIN_DBI) {
4182 if ((*mc->mc_dbflag & DB_STALE) ||
4183 ((flags & MDB_PS_MODIFY) && !(*mc->mc_dbflag & DB_DIRTY))) {
4185 unsigned char dbflag = 0;
4186 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
4187 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, flags & MDB_PS_MODIFY);
4190 if (*mc->mc_dbflag & DB_STALE) {
4194 MDB_node *leaf = mdb_node_search(&mc2,
4195 &mc->mc_dbx->md_name, &exact);
4197 return MDB_NOTFOUND;
4198 mdb_node_read(mc->mc_txn, leaf, &data);
4199 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
4201 /* The txn may not know this DBI, or another process may
4202 * have dropped and recreated the DB with other flags.
4204 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
4205 return MDB_INCOMPATIBLE;
4206 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
4208 if (flags & MDB_PS_MODIFY)
4210 *mc->mc_dbflag &= ~DB_STALE;
4211 *mc->mc_dbflag |= dbflag;
4214 root = mc->mc_db->md_root;
4216 if (root == P_INVALID) { /* Tree is empty. */
4217 DPUTS("tree is empty");
4218 return MDB_NOTFOUND;
4223 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
4224 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0])))
4230 DPRINTF("db %u root page %zu has flags 0x%X",
4231 mc->mc_dbi, root, mc->mc_pg[0]->mp_flags);
4233 if (flags & MDB_PS_MODIFY) {
4234 if ((rc = mdb_page_touch(mc)))
4238 if (flags & MDB_PS_ROOTONLY)
4241 return mdb_page_search_root(mc, key, flags);
4244 /** Return the data associated with a given node.
4245 * @param[in] txn The transaction for this operation.
4246 * @param[in] leaf The node being read.
4247 * @param[out] data Updated to point to the node's data.
4248 * @return 0 on success, non-zero on failure.
4251 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
4253 MDB_page *omp; /* overflow page */
4257 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
4258 data->mv_size = NODEDSZ(leaf);
4259 data->mv_data = NODEDATA(leaf);
4263 /* Read overflow data.
4265 data->mv_size = NODEDSZ(leaf);
4266 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
4267 if ((rc = mdb_page_get(txn, pgno, &omp))) {
4268 DPRINTF("read overflow page %zu failed", pgno);
4271 data->mv_data = METADATA(omp);
4277 mdb_get(MDB_txn *txn, MDB_dbi dbi,
4278 MDB_val *key, MDB_val *data)
4287 DPRINTF("===> get db %u key [%s]", dbi, DKEY(key));
4289 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
4292 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4296 mdb_cursor_init(&mc, txn, dbi, &mx);
4297 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
4300 /** Find a sibling for a page.
4301 * Replaces the page at the top of the cursor's stack with the
4302 * specified sibling, if one exists.
4303 * @param[in] mc The cursor for this operation.
4304 * @param[in] move_right Non-zero if the right sibling is requested,
4305 * otherwise the left sibling.
4306 * @return 0 on success, non-zero on failure.
4309 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
4315 if (mc->mc_snum < 2) {
4316 return MDB_NOTFOUND; /* root has no siblings */
4320 DPRINTF("parent page is page %zu, index %u",
4321 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]);
4323 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
4324 : (mc->mc_ki[mc->mc_top] == 0)) {
4325 DPRINTF("no more keys left, moving to %s sibling",
4326 move_right ? "right" : "left");
4327 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
4328 /* undo cursor_pop before returning */
4335 mc->mc_ki[mc->mc_top]++;
4337 mc->mc_ki[mc->mc_top]--;
4338 DPRINTF("just moving to %s index key %u",
4339 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]);
4341 assert(IS_BRANCH(mc->mc_pg[mc->mc_top]));
4343 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4344 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp)))
4347 mdb_cursor_push(mc, mp);
4349 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
4354 /** Move the cursor to the next data item. */
4356 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4362 if (mc->mc_flags & C_EOF) {
4363 return MDB_NOTFOUND;
4366 assert(mc->mc_flags & C_INITIALIZED);
4368 mp = mc->mc_pg[mc->mc_top];
4370 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4371 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4372 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4373 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
4374 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
4375 if (op != MDB_NEXT || rc == MDB_SUCCESS)
4379 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4380 if (op == MDB_NEXT_DUP)
4381 return MDB_NOTFOUND;
4385 DPRINTF("cursor_next: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4387 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
4388 DPUTS("=====> move to next sibling page");
4389 if (mdb_cursor_sibling(mc, 1) != MDB_SUCCESS) {
4390 mc->mc_flags |= C_EOF;
4391 mc->mc_flags &= ~C_INITIALIZED;
4392 return MDB_NOTFOUND;
4394 mp = mc->mc_pg[mc->mc_top];
4395 DPRINTF("next page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4397 mc->mc_ki[mc->mc_top]++;
4399 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4400 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4403 key->mv_size = mc->mc_db->md_pad;
4404 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4408 assert(IS_LEAF(mp));
4409 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4411 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4412 mdb_xcursor_init1(mc, leaf);
4415 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4418 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4419 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4420 if (rc != MDB_SUCCESS)
4425 MDB_GET_KEY(leaf, key);
4429 /** Move the cursor to the previous data item. */
4431 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4437 assert(mc->mc_flags & C_INITIALIZED);
4439 mp = mc->mc_pg[mc->mc_top];
4441 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4442 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4443 if (op == MDB_PREV || op == MDB_PREV_DUP) {
4444 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4445 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
4446 if (op != MDB_PREV || rc == MDB_SUCCESS)
4449 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4450 if (op == MDB_PREV_DUP)
4451 return MDB_NOTFOUND;
4456 DPRINTF("cursor_prev: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4458 if (mc->mc_ki[mc->mc_top] == 0) {
4459 DPUTS("=====> move to prev sibling page");
4460 if (mdb_cursor_sibling(mc, 0) != MDB_SUCCESS) {
4461 mc->mc_flags &= ~C_INITIALIZED;
4462 return MDB_NOTFOUND;
4464 mp = mc->mc_pg[mc->mc_top];
4465 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
4466 DPRINTF("prev page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4468 mc->mc_ki[mc->mc_top]--;
4470 mc->mc_flags &= ~C_EOF;
4472 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4473 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4476 key->mv_size = mc->mc_db->md_pad;
4477 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4481 assert(IS_LEAF(mp));
4482 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4484 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4485 mdb_xcursor_init1(mc, leaf);
4488 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4491 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4492 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4493 if (rc != MDB_SUCCESS)
4498 MDB_GET_KEY(leaf, key);
4502 /** Set the cursor on a specific data item. */
4504 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4505 MDB_cursor_op op, int *exactp)
4509 MDB_node *leaf = NULL;
4514 assert(key->mv_size > 0);
4516 /* See if we're already on the right page */
4517 if (mc->mc_flags & C_INITIALIZED) {
4520 mp = mc->mc_pg[mc->mc_top];
4522 mc->mc_ki[mc->mc_top] = 0;
4523 return MDB_NOTFOUND;
4525 if (mp->mp_flags & P_LEAF2) {
4526 nodekey.mv_size = mc->mc_db->md_pad;
4527 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
4529 leaf = NODEPTR(mp, 0);
4530 MDB_GET_KEY(leaf, &nodekey);
4532 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4534 /* Probably happens rarely, but first node on the page
4535 * was the one we wanted.
4537 mc->mc_ki[mc->mc_top] = 0;
4544 unsigned int nkeys = NUMKEYS(mp);
4546 if (mp->mp_flags & P_LEAF2) {
4547 nodekey.mv_data = LEAF2KEY(mp,
4548 nkeys-1, nodekey.mv_size);
4550 leaf = NODEPTR(mp, nkeys-1);
4551 MDB_GET_KEY(leaf, &nodekey);
4553 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4555 /* last node was the one we wanted */
4556 mc->mc_ki[mc->mc_top] = nkeys-1;
4562 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
4563 /* This is definitely the right page, skip search_page */
4564 if (mp->mp_flags & P_LEAF2) {
4565 nodekey.mv_data = LEAF2KEY(mp,
4566 mc->mc_ki[mc->mc_top], nodekey.mv_size);
4568 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4569 MDB_GET_KEY(leaf, &nodekey);
4571 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4573 /* current node was the one we wanted */
4583 /* If any parents have right-sibs, search.
4584 * Otherwise, there's nothing further.
4586 for (i=0; i<mc->mc_top; i++)
4588 NUMKEYS(mc->mc_pg[i])-1)
4590 if (i == mc->mc_top) {
4591 /* There are no other pages */
4592 mc->mc_ki[mc->mc_top] = nkeys;
4593 return MDB_NOTFOUND;
4597 /* There are no other pages */
4598 mc->mc_ki[mc->mc_top] = 0;
4599 return MDB_NOTFOUND;
4603 rc = mdb_page_search(mc, key, 0);
4604 if (rc != MDB_SUCCESS)
4607 mp = mc->mc_pg[mc->mc_top];
4608 assert(IS_LEAF(mp));
4611 leaf = mdb_node_search(mc, key, exactp);
4612 if (exactp != NULL && !*exactp) {
4613 /* MDB_SET specified and not an exact match. */
4614 return MDB_NOTFOUND;
4618 DPUTS("===> inexact leaf not found, goto sibling");
4619 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
4620 return rc; /* no entries matched */
4621 mp = mc->mc_pg[mc->mc_top];
4622 assert(IS_LEAF(mp));
4623 leaf = NODEPTR(mp, 0);
4627 mc->mc_flags |= C_INITIALIZED;
4628 mc->mc_flags &= ~C_EOF;
4631 key->mv_size = mc->mc_db->md_pad;
4632 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4636 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4637 mdb_xcursor_init1(mc, leaf);
4640 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4641 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
4642 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4645 if (op == MDB_GET_BOTH) {
4651 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
4652 if (rc != MDB_SUCCESS)
4655 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
4657 if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
4659 rc = mc->mc_dbx->md_dcmp(data, &d2);
4661 if (op == MDB_GET_BOTH || rc > 0)
4662 return MDB_NOTFOUND;
4667 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4668 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4673 /* The key already matches in all other cases */
4674 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
4675 MDB_GET_KEY(leaf, key);
4676 DPRINTF("==> cursor placed on key [%s]", DKEY(key));
4681 /** Move the cursor to the first item in the database. */
4683 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4688 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4689 rc = mdb_page_search(mc, NULL, 0);
4690 if (rc != MDB_SUCCESS)
4693 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4695 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
4696 mc->mc_flags |= C_INITIALIZED;
4697 mc->mc_flags &= ~C_EOF;
4699 mc->mc_ki[mc->mc_top] = 0;
4701 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4702 key->mv_size = mc->mc_db->md_pad;
4703 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
4708 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4709 mdb_xcursor_init1(mc, leaf);
4710 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4715 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4716 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4720 MDB_GET_KEY(leaf, key);
4724 /** Move the cursor to the last item in the database. */
4726 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4731 if (!(mc->mc_flags & C_EOF)) {
4733 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4736 lkey.mv_size = MDB_MAXKEYSIZE+1;
4737 lkey.mv_data = NULL;
4738 rc = mdb_page_search(mc, &lkey, 0);
4739 if (rc != MDB_SUCCESS)
4742 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4745 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
4746 mc->mc_flags |= C_INITIALIZED|C_EOF;
4747 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4749 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4750 key->mv_size = mc->mc_db->md_pad;
4751 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
4756 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4757 mdb_xcursor_init1(mc, leaf);
4758 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4763 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4764 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4769 MDB_GET_KEY(leaf, key);
4774 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4783 case MDB_GET_CURRENT:
4784 if (!(mc->mc_flags & C_INITIALIZED)) {
4787 MDB_page *mp = mc->mc_pg[mc->mc_top];
4789 mc->mc_ki[mc->mc_top] = 0;
4795 key->mv_size = mc->mc_db->md_pad;
4796 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4798 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4799 MDB_GET_KEY(leaf, key);
4801 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4802 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
4804 rc = mdb_node_read(mc->mc_txn, leaf, data);
4811 case MDB_GET_BOTH_RANGE:
4812 if (data == NULL || mc->mc_xcursor == NULL) {
4820 if (key == NULL || key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4822 } else if (op == MDB_SET_RANGE)
4823 rc = mdb_cursor_set(mc, key, data, op, NULL);
4825 rc = mdb_cursor_set(mc, key, data, op, &exact);
4827 case MDB_GET_MULTIPLE:
4829 !(mc->mc_db->md_flags & MDB_DUPFIXED) ||
4830 !(mc->mc_flags & C_INITIALIZED)) {
4835 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
4836 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
4839 case MDB_NEXT_MULTIPLE:
4841 !(mc->mc_db->md_flags & MDB_DUPFIXED)) {
4845 if (!(mc->mc_flags & C_INITIALIZED))
4846 rc = mdb_cursor_first(mc, key, data);
4848 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
4849 if (rc == MDB_SUCCESS) {
4850 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
4853 mx = &mc->mc_xcursor->mx_cursor;
4854 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
4856 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
4857 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
4865 case MDB_NEXT_NODUP:
4866 if (!(mc->mc_flags & C_INITIALIZED))
4867 rc = mdb_cursor_first(mc, key, data);
4869 rc = mdb_cursor_next(mc, key, data, op);
4873 case MDB_PREV_NODUP:
4874 if (!(mc->mc_flags & C_INITIALIZED)) {
4875 rc = mdb_cursor_last(mc, key, data);
4876 mc->mc_flags |= C_INITIALIZED;
4877 mc->mc_ki[mc->mc_top]++;
4879 rc = mdb_cursor_prev(mc, key, data, op);
4882 rc = mdb_cursor_first(mc, key, data);
4886 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4887 !(mc->mc_flags & C_INITIALIZED) ||
4888 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4892 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4895 rc = mdb_cursor_last(mc, key, data);
4899 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4900 !(mc->mc_flags & C_INITIALIZED) ||
4901 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4905 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4908 DPRINTF("unhandled/unimplemented cursor operation %u", op);
4916 /** Touch all the pages in the cursor stack.
4917 * Makes sure all the pages are writable, before attempting a write operation.
4918 * @param[in] mc The cursor to operate on.
4921 mdb_cursor_touch(MDB_cursor *mc)
4925 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
4928 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI,
4929 mc->mc_txn->mt_dbs[MAIN_DBI].md_flags & MDB_DUPSORT ? &mcx : NULL);
4930 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
4933 *mc->mc_dbflag |= DB_DIRTY;
4935 for (mc->mc_top = 0; mc->mc_top < mc->mc_snum; mc->mc_top++) {
4936 rc = mdb_page_touch(mc);
4940 mc->mc_top = mc->mc_snum-1;
4945 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4948 MDB_node *leaf = NULL;
4949 MDB_val xdata, *rdata, dkey;
4952 int do_sub = 0, insert = 0;
4953 unsigned int mcount = 0;
4957 char dbuf[MDB_MAXKEYSIZE+1];
4958 unsigned int nflags;
4961 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4964 if (flags != MDB_CURRENT && (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE))
4967 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT) && data->mv_size > MDB_MAXKEYSIZE)
4970 #if SIZE_MAX > MAXDATASIZE
4971 if (data->mv_size > MAXDATASIZE)
4975 DPRINTF("==> put db %u key [%s], size %zu, data size %zu",
4976 mc->mc_dbi, DKEY(key), key ? key->mv_size:0, data->mv_size);
4980 if (flags == MDB_CURRENT) {
4981 if (!(mc->mc_flags & C_INITIALIZED))
4984 } else if (mc->mc_db->md_root == P_INVALID) {
4986 /* new database, write a root leaf page */
4987 DPUTS("allocating new root leaf page");
4988 if ((rc = mdb_page_new(mc, P_LEAF, 1, &np))) {
4992 mdb_cursor_push(mc, np);
4993 mc->mc_db->md_root = np->mp_pgno;
4994 mc->mc_db->md_depth++;
4995 *mc->mc_dbflag |= DB_DIRTY;
4996 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
4998 np->mp_flags |= P_LEAF2;
4999 mc->mc_flags |= C_INITIALIZED;
5005 if (flags & MDB_APPEND) {
5007 rc = mdb_cursor_last(mc, &k2, &d2);
5009 rc = mc->mc_dbx->md_cmp(key, &k2);
5012 mc->mc_ki[mc->mc_top]++;
5014 /* new key is <= last key */
5019 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
5021 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
5022 DPRINTF("duplicate key [%s]", DKEY(key));
5024 return MDB_KEYEXIST;
5026 if (rc && rc != MDB_NOTFOUND)
5030 /* Cursor is positioned, now make sure all pages are writable */
5031 rc2 = mdb_cursor_touch(mc);
5036 /* The key already exists */
5037 if (rc == MDB_SUCCESS) {
5038 /* there's only a key anyway, so this is a no-op */
5039 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5040 unsigned int ksize = mc->mc_db->md_pad;
5041 if (key->mv_size != ksize)
5043 if (flags == MDB_CURRENT) {
5044 char *ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
5045 memcpy(ptr, key->mv_data, ksize);
5050 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5053 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
5054 /* Was a single item before, must convert now */
5056 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5057 /* Just overwrite the current item */
5058 if (flags == MDB_CURRENT)
5061 dkey.mv_size = NODEDSZ(leaf);
5062 dkey.mv_data = NODEDATA(leaf);
5063 #if UINT_MAX < SIZE_MAX
5064 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && dkey.mv_size == sizeof(size_t))
5065 #ifdef MISALIGNED_OK
5066 mc->mc_dbx->md_dcmp = mdb_cmp_long;
5068 mc->mc_dbx->md_dcmp = mdb_cmp_cint;
5071 /* if data matches, ignore it */
5072 if (!mc->mc_dbx->md_dcmp(data, &dkey))
5073 return (flags == MDB_NODUPDATA) ? MDB_KEYEXIST : MDB_SUCCESS;
5075 /* create a fake page for the dup items */
5076 memcpy(dbuf, dkey.mv_data, dkey.mv_size);
5077 dkey.mv_data = dbuf;
5078 fp = (MDB_page *)&pbuf;
5079 fp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5080 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
5081 fp->mp_lower = PAGEHDRSZ;
5082 fp->mp_upper = PAGEHDRSZ + dkey.mv_size + data->mv_size;
5083 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5084 fp->mp_flags |= P_LEAF2;
5085 fp->mp_pad = data->mv_size;
5086 fp->mp_upper += 2 * data->mv_size; /* leave space for 2 more */
5088 fp->mp_upper += 2 * sizeof(indx_t) + 2 * NODESIZE +
5089 (dkey.mv_size & 1) + (data->mv_size & 1);
5091 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5094 xdata.mv_size = fp->mp_upper;
5099 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5100 /* See if we need to convert from fake page to subDB */
5102 unsigned int offset;
5105 fp = NODEDATA(leaf);
5106 if (flags == MDB_CURRENT) {
5108 fp->mp_flags |= P_DIRTY;
5109 COPY_PGNO(fp->mp_pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5110 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
5114 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5115 offset = fp->mp_pad;
5116 if (SIZELEFT(fp) >= offset)
5118 offset *= 4; /* space for 4 more */
5120 offset = NODESIZE + sizeof(indx_t) + data->mv_size;
5122 offset += offset & 1;
5123 if (NODESIZE + sizeof(indx_t) + NODEKSZ(leaf) + NODEDSZ(leaf) +
5124 offset >= mc->mc_txn->mt_env->me_nodemax) {
5125 /* yes, convert it */
5127 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5128 dummy.md_pad = fp->mp_pad;
5129 dummy.md_flags = MDB_DUPFIXED;
5130 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5131 dummy.md_flags |= MDB_INTEGERKEY;
5134 dummy.md_branch_pages = 0;
5135 dummy.md_leaf_pages = 1;
5136 dummy.md_overflow_pages = 0;
5137 dummy.md_entries = NUMKEYS(fp);
5139 xdata.mv_size = sizeof(MDB_db);
5140 xdata.mv_data = &dummy;
5141 if ((rc = mdb_page_alloc(mc, 1, &mp)))
5143 offset = mc->mc_txn->mt_env->me_psize - NODEDSZ(leaf);
5144 flags |= F_DUPDATA|F_SUBDATA;
5145 dummy.md_root = mp->mp_pgno;
5147 /* no, just grow it */
5149 xdata.mv_size = NODEDSZ(leaf) + offset;
5150 xdata.mv_data = &pbuf;
5151 mp = (MDB_page *)&pbuf;
5152 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5155 mp->mp_flags = fp->mp_flags | P_DIRTY;
5156 mp->mp_pad = fp->mp_pad;
5157 mp->mp_lower = fp->mp_lower;
5158 mp->mp_upper = fp->mp_upper + offset;
5160 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
5162 nsize = NODEDSZ(leaf) - fp->mp_upper;
5163 memcpy((char *)mp + mp->mp_upper, (char *)fp + fp->mp_upper, nsize);
5164 for (i=0; i<NUMKEYS(fp); i++)
5165 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
5167 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5171 /* data is on sub-DB, just store it */
5172 flags |= F_DUPDATA|F_SUBDATA;
5176 /* overflow page overwrites need special handling */
5177 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5180 int ovpages, dpages;
5182 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
5183 dpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
5184 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
5185 mdb_page_get(mc->mc_txn, pg, &omp);
5186 /* Is the ov page writable and large enough? */
5187 if ((omp->mp_flags & P_DIRTY) && ovpages >= dpages) {
5188 /* yes, overwrite it. Note in this case we don't
5189 * bother to try shrinking the node if the new data
5190 * is smaller than the overflow threshold.
5192 if (F_ISSET(flags, MDB_RESERVE))
5193 data->mv_data = METADATA(omp);
5195 memcpy(METADATA(omp), data->mv_data, data->mv_size);
5198 /* no, free ovpages */
5200 mc->mc_db->md_overflow_pages -= ovpages;
5201 for (i=0; i<ovpages; i++) {
5202 DPRINTF("freed ov page %zu", pg);
5203 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
5207 } else if (NODEDSZ(leaf) == data->mv_size) {
5208 /* same size, just replace it. Note that we could
5209 * also reuse this node if the new data is smaller,
5210 * but instead we opt to shrink the node in that case.
5212 if (F_ISSET(flags, MDB_RESERVE))
5213 data->mv_data = NODEDATA(leaf);
5214 else if (data->mv_size)
5215 memcpy(NODEDATA(leaf), data->mv_data, data->mv_size);
5217 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
5220 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5221 mc->mc_db->md_entries--;
5223 DPRINTF("inserting key at index %i", mc->mc_ki[mc->mc_top]);
5230 nflags = flags & NODE_ADD_FLAGS;
5231 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(mc->mc_txn->mt_env, key, rdata);
5232 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
5233 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
5234 nflags &= ~MDB_APPEND;
5236 nflags |= MDB_SPLIT_REPLACE;
5237 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
5239 /* There is room already in this leaf page. */
5240 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
5241 if (rc == 0 && !do_sub && insert) {
5242 /* Adjust other cursors pointing to mp */
5243 MDB_cursor *m2, *m3;
5244 MDB_dbi dbi = mc->mc_dbi;
5245 unsigned i = mc->mc_top;
5246 MDB_page *mp = mc->mc_pg[i];
5248 if (mc->mc_flags & C_SUB)
5251 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5252 if (mc->mc_flags & C_SUB)
5253 m3 = &m2->mc_xcursor->mx_cursor;
5256 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
5257 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
5264 if (rc != MDB_SUCCESS)
5265 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5267 /* Now store the actual data in the child DB. Note that we're
5268 * storing the user data in the keys field, so there are strict
5269 * size limits on dupdata. The actual data fields of the child
5270 * DB are all zero size.
5277 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5278 if (flags & MDB_CURRENT) {
5279 xflags = MDB_CURRENT;
5281 mdb_xcursor_init1(mc, leaf);
5282 xflags = (flags & MDB_NODUPDATA) ? MDB_NOOVERWRITE : 0;
5284 /* converted, write the original data first */
5286 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
5290 /* Adjust other cursors pointing to mp */
5292 unsigned i = mc->mc_top;
5293 MDB_page *mp = mc->mc_pg[i];
5295 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5296 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
5297 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
5298 mdb_xcursor_init1(m2, leaf);
5302 /* we've done our job */
5305 if (flags & MDB_APPENDDUP)
5306 xflags |= MDB_APPEND;
5307 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
5308 if (flags & F_SUBDATA) {
5309 void *db = NODEDATA(leaf);
5310 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5313 /* sub-writes might have failed so check rc again.
5314 * Don't increment count if we just replaced an existing item.
5316 if (!rc && !(flags & MDB_CURRENT))
5317 mc->mc_db->md_entries++;
5318 if (flags & MDB_MULTIPLE) {
5320 if (mcount < data[1].mv_size) {
5321 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
5322 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5328 /* If we succeeded and the key didn't exist before, make sure
5329 * the cursor is marked valid.
5332 mc->mc_flags |= C_INITIALIZED;
5337 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
5342 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
5345 if (!(mc->mc_flags & C_INITIALIZED))
5348 rc = mdb_cursor_touch(mc);
5352 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5354 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5355 if (flags != MDB_NODUPDATA) {
5356 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5357 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
5359 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, 0);
5360 /* If sub-DB still has entries, we're done */
5361 if (mc->mc_xcursor->mx_db.md_entries) {
5362 if (leaf->mn_flags & F_SUBDATA) {
5363 /* update subDB info */
5364 void *db = NODEDATA(leaf);
5365 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5367 /* shrink fake page */
5368 mdb_node_shrink(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5370 mc->mc_db->md_entries--;
5373 /* otherwise fall thru and delete the sub-DB */
5376 if (leaf->mn_flags & F_SUBDATA) {
5377 /* add all the child DB's pages to the free list */
5378 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
5379 if (rc == MDB_SUCCESS) {
5380 mc->mc_db->md_entries -=
5381 mc->mc_xcursor->mx_db.md_entries;
5386 return mdb_cursor_del0(mc, leaf);
5389 /** Allocate and initialize new pages for a database.
5390 * @param[in] mc a cursor on the database being added to.
5391 * @param[in] flags flags defining what type of page is being allocated.
5392 * @param[in] num the number of pages to allocate. This is usually 1,
5393 * unless allocating overflow pages for a large record.
5394 * @param[out] mp Address of a page, or NULL on failure.
5395 * @return 0 on success, non-zero on failure.
5398 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
5403 if ((rc = mdb_page_alloc(mc, num, &np)))
5405 DPRINTF("allocated new mpage %zu, page size %u",
5406 np->mp_pgno, mc->mc_txn->mt_env->me_psize);
5407 np->mp_flags = flags | P_DIRTY;
5408 np->mp_lower = PAGEHDRSZ;
5409 np->mp_upper = mc->mc_txn->mt_env->me_psize;
5412 mc->mc_db->md_branch_pages++;
5413 else if (IS_LEAF(np))
5414 mc->mc_db->md_leaf_pages++;
5415 else if (IS_OVERFLOW(np)) {
5416 mc->mc_db->md_overflow_pages += num;
5424 /** Calculate the size of a leaf node.
5425 * The size depends on the environment's page size; if a data item
5426 * is too large it will be put onto an overflow page and the node
5427 * size will only include the key and not the data. Sizes are always
5428 * rounded up to an even number of bytes, to guarantee 2-byte alignment
5429 * of the #MDB_node headers.
5430 * @param[in] env The environment handle.
5431 * @param[in] key The key for the node.
5432 * @param[in] data The data for the node.
5433 * @return The number of bytes needed to store the node.
5436 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
5440 sz = LEAFSIZE(key, data);
5441 if (sz >= env->me_nodemax) {
5442 /* put on overflow page */
5443 sz -= data->mv_size - sizeof(pgno_t);
5447 return sz + sizeof(indx_t);
5450 /** Calculate the size of a branch node.
5451 * The size should depend on the environment's page size but since
5452 * we currently don't support spilling large keys onto overflow
5453 * pages, it's simply the size of the #MDB_node header plus the
5454 * size of the key. Sizes are always rounded up to an even number
5455 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
5456 * @param[in] env The environment handle.
5457 * @param[in] key The key for the node.
5458 * @return The number of bytes needed to store the node.
5461 mdb_branch_size(MDB_env *env, MDB_val *key)
5466 if (sz >= env->me_nodemax) {
5467 /* put on overflow page */
5468 /* not implemented */
5469 /* sz -= key->size - sizeof(pgno_t); */
5472 return sz + sizeof(indx_t);
5475 /** Add a node to the page pointed to by the cursor.
5476 * @param[in] mc The cursor for this operation.
5477 * @param[in] indx The index on the page where the new node should be added.
5478 * @param[in] key The key for the new node.
5479 * @param[in] data The data for the new node, if any.
5480 * @param[in] pgno The page number, if adding a branch node.
5481 * @param[in] flags Flags for the node.
5482 * @return 0 on success, non-zero on failure. Possible errors are:
5484 * <li>ENOMEM - failed to allocate overflow pages for the node.
5485 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
5486 * should never happen since all callers already calculate the
5487 * page's free space before calling this function.
5491 mdb_node_add(MDB_cursor *mc, indx_t indx,
5492 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
5495 size_t node_size = NODESIZE;
5498 MDB_page *mp = mc->mc_pg[mc->mc_top];
5499 MDB_page *ofp = NULL; /* overflow page */
5502 assert(mp->mp_upper >= mp->mp_lower);
5504 DPRINTF("add to %s %spage %zu index %i, data size %zu key size %zu [%s]",
5505 IS_LEAF(mp) ? "leaf" : "branch",
5506 IS_SUBP(mp) ? "sub-" : "",
5507 mp->mp_pgno, indx, data ? data->mv_size : 0,
5508 key ? key->mv_size : 0, key ? DKEY(key) : NULL);
5511 /* Move higher keys up one slot. */
5512 int ksize = mc->mc_db->md_pad, dif;
5513 char *ptr = LEAF2KEY(mp, indx, ksize);
5514 dif = NUMKEYS(mp) - indx;
5516 memmove(ptr+ksize, ptr, dif*ksize);
5517 /* insert new key */
5518 memcpy(ptr, key->mv_data, ksize);
5520 /* Just using these for counting */
5521 mp->mp_lower += sizeof(indx_t);
5522 mp->mp_upper -= ksize - sizeof(indx_t);
5527 node_size += key->mv_size;
5531 if (F_ISSET(flags, F_BIGDATA)) {
5532 /* Data already on overflow page. */
5533 node_size += sizeof(pgno_t);
5534 } else if (node_size + data->mv_size >= mc->mc_txn->mt_env->me_nodemax) {
5535 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
5537 /* Put data on overflow page. */
5538 DPRINTF("data size is %zu, node would be %zu, put data on overflow page",
5539 data->mv_size, node_size+data->mv_size);
5540 node_size += sizeof(pgno_t);
5541 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
5543 DPRINTF("allocated overflow page %zu", ofp->mp_pgno);
5546 node_size += data->mv_size;
5549 node_size += node_size & 1;
5551 if (node_size + sizeof(indx_t) > SIZELEFT(mp)) {
5552 DPRINTF("not enough room in page %zu, got %u ptrs",
5553 mp->mp_pgno, NUMKEYS(mp));
5554 DPRINTF("upper - lower = %u - %u = %u", mp->mp_upper, mp->mp_lower,
5555 mp->mp_upper - mp->mp_lower);
5556 DPRINTF("node size = %zu", node_size);
5557 return MDB_PAGE_FULL;
5560 /* Move higher pointers up one slot. */
5561 for (i = NUMKEYS(mp); i > indx; i--)
5562 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
5564 /* Adjust free space offsets. */
5565 ofs = mp->mp_upper - node_size;
5566 assert(ofs >= mp->mp_lower + sizeof(indx_t));
5567 mp->mp_ptrs[indx] = ofs;
5569 mp->mp_lower += sizeof(indx_t);
5571 /* Write the node data. */
5572 node = NODEPTR(mp, indx);
5573 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
5574 node->mn_flags = flags;
5576 SETDSZ(node,data->mv_size);
5581 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
5586 if (F_ISSET(flags, F_BIGDATA))
5587 memcpy(node->mn_data + key->mv_size, data->mv_data,
5589 else if (F_ISSET(flags, MDB_RESERVE))
5590 data->mv_data = node->mn_data + key->mv_size;
5592 memcpy(node->mn_data + key->mv_size, data->mv_data,
5595 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
5597 if (F_ISSET(flags, MDB_RESERVE))
5598 data->mv_data = METADATA(ofp);
5600 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
5607 /** Delete the specified node from a page.
5608 * @param[in] mp The page to operate on.
5609 * @param[in] indx The index of the node to delete.
5610 * @param[in] ksize The size of a node. Only used if the page is
5611 * part of a #MDB_DUPFIXED database.
5614 mdb_node_del(MDB_page *mp, indx_t indx, int ksize)
5617 indx_t i, j, numkeys, ptr;
5624 COPY_PGNO(pgno, mp->mp_pgno);
5625 DPRINTF("delete node %u on %s page %zu", indx,
5626 IS_LEAF(mp) ? "leaf" : "branch", pgno);
5629 assert(indx < NUMKEYS(mp));
5632 int x = NUMKEYS(mp) - 1 - indx;
5633 base = LEAF2KEY(mp, indx, ksize);
5635 memmove(base, base + ksize, x * ksize);
5636 mp->mp_lower -= sizeof(indx_t);
5637 mp->mp_upper += ksize - sizeof(indx_t);
5641 node = NODEPTR(mp, indx);
5642 sz = NODESIZE + node->mn_ksize;
5644 if (F_ISSET(node->mn_flags, F_BIGDATA))
5645 sz += sizeof(pgno_t);
5647 sz += NODEDSZ(node);
5651 ptr = mp->mp_ptrs[indx];
5652 numkeys = NUMKEYS(mp);
5653 for (i = j = 0; i < numkeys; i++) {
5655 mp->mp_ptrs[j] = mp->mp_ptrs[i];
5656 if (mp->mp_ptrs[i] < ptr)
5657 mp->mp_ptrs[j] += sz;
5662 base = (char *)mp + mp->mp_upper;
5663 memmove(base + sz, base, ptr - mp->mp_upper);
5665 mp->mp_lower -= sizeof(indx_t);
5669 /** Compact the main page after deleting a node on a subpage.
5670 * @param[in] mp The main page to operate on.
5671 * @param[in] indx The index of the subpage on the main page.
5674 mdb_node_shrink(MDB_page *mp, indx_t indx)
5681 indx_t i, numkeys, ptr;
5683 node = NODEPTR(mp, indx);
5684 sp = (MDB_page *)NODEDATA(node);
5685 osize = NODEDSZ(node);
5687 delta = sp->mp_upper - sp->mp_lower;
5688 SETDSZ(node, osize - delta);
5689 xp = (MDB_page *)((char *)sp + delta);
5691 /* shift subpage upward */
5693 nsize = NUMKEYS(sp) * sp->mp_pad;
5694 memmove(METADATA(xp), METADATA(sp), nsize);
5697 nsize = osize - sp->mp_upper;
5698 numkeys = NUMKEYS(sp);
5699 for (i=numkeys-1; i>=0; i--)
5700 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
5702 xp->mp_upper = sp->mp_lower;
5703 xp->mp_lower = sp->mp_lower;
5704 xp->mp_flags = sp->mp_flags;
5705 xp->mp_pad = sp->mp_pad;
5706 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
5708 /* shift lower nodes upward */
5709 ptr = mp->mp_ptrs[indx];
5710 numkeys = NUMKEYS(mp);
5711 for (i = 0; i < numkeys; i++) {
5712 if (mp->mp_ptrs[i] <= ptr)
5713 mp->mp_ptrs[i] += delta;
5716 base = (char *)mp + mp->mp_upper;
5717 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
5718 mp->mp_upper += delta;
5721 /** Initial setup of a sorted-dups cursor.
5722 * Sorted duplicates are implemented as a sub-database for the given key.
5723 * The duplicate data items are actually keys of the sub-database.
5724 * Operations on the duplicate data items are performed using a sub-cursor
5725 * initialized when the sub-database is first accessed. This function does
5726 * the preliminary setup of the sub-cursor, filling in the fields that
5727 * depend only on the parent DB.
5728 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5731 mdb_xcursor_init0(MDB_cursor *mc)
5733 MDB_xcursor *mx = mc->mc_xcursor;
5735 mx->mx_cursor.mc_xcursor = NULL;
5736 mx->mx_cursor.mc_txn = mc->mc_txn;
5737 mx->mx_cursor.mc_db = &mx->mx_db;
5738 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
5739 mx->mx_cursor.mc_dbi = mc->mc_dbi+1;
5740 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
5741 mx->mx_cursor.mc_snum = 0;
5742 mx->mx_cursor.mc_top = 0;
5743 mx->mx_cursor.mc_flags = C_SUB;
5744 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
5745 mx->mx_dbx.md_dcmp = NULL;
5746 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
5749 /** Final setup of a sorted-dups cursor.
5750 * Sets up the fields that depend on the data from the main cursor.
5751 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5752 * @param[in] node The data containing the #MDB_db record for the
5753 * sorted-dup database.
5756 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
5758 MDB_xcursor *mx = mc->mc_xcursor;
5760 if (node->mn_flags & F_SUBDATA) {
5761 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
5762 mx->mx_cursor.mc_pg[0] = 0;
5763 mx->mx_cursor.mc_snum = 0;
5764 mx->mx_cursor.mc_flags = C_SUB;
5766 MDB_page *fp = NODEDATA(node);
5767 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
5768 mx->mx_db.md_flags = 0;
5769 mx->mx_db.md_depth = 1;
5770 mx->mx_db.md_branch_pages = 0;
5771 mx->mx_db.md_leaf_pages = 1;
5772 mx->mx_db.md_overflow_pages = 0;
5773 mx->mx_db.md_entries = NUMKEYS(fp);
5774 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
5775 mx->mx_cursor.mc_snum = 1;
5776 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
5777 mx->mx_cursor.mc_top = 0;
5778 mx->mx_cursor.mc_pg[0] = fp;
5779 mx->mx_cursor.mc_ki[0] = 0;
5780 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5781 mx->mx_db.md_flags = MDB_DUPFIXED;
5782 mx->mx_db.md_pad = fp->mp_pad;
5783 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5784 mx->mx_db.md_flags |= MDB_INTEGERKEY;
5787 DPRINTF("Sub-db %u for db %u root page %zu", mx->mx_cursor.mc_dbi, mc->mc_dbi,
5789 mx->mx_dbflag = DB_VALID | (F_ISSET(mc->mc_pg[mc->mc_top]->mp_flags, P_DIRTY) ?
5791 mx->mx_dbx.md_name.mv_data = NODEKEY(node);
5792 mx->mx_dbx.md_name.mv_size = node->mn_ksize;
5793 #if UINT_MAX < SIZE_MAX
5794 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
5795 #ifdef MISALIGNED_OK
5796 mx->mx_dbx.md_cmp = mdb_cmp_long;
5798 mx->mx_dbx.md_cmp = mdb_cmp_cint;
5803 /** Initialize a cursor for a given transaction and database. */
5805 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
5810 mc->mc_db = &txn->mt_dbs[dbi];
5811 mc->mc_dbx = &txn->mt_dbxs[dbi];
5812 mc->mc_dbflag = &txn->mt_dbflags[dbi];
5817 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5819 mc->mc_xcursor = mx;
5820 mdb_xcursor_init0(mc);
5822 mc->mc_xcursor = NULL;
5824 if (*mc->mc_dbflag & DB_STALE) {
5825 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
5830 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
5833 MDB_xcursor *mx = NULL;
5834 size_t size = sizeof(MDB_cursor);
5836 if (txn == NULL || ret == NULL || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
5839 /* Allow read access to the freelist */
5840 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
5843 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
5844 size += sizeof(MDB_xcursor);
5846 if ((mc = malloc(size)) != NULL) {
5847 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5848 mx = (MDB_xcursor *)(mc + 1);
5850 mdb_cursor_init(mc, txn, dbi, mx);
5851 if (txn->mt_cursors) {
5852 mc->mc_next = txn->mt_cursors[dbi];
5853 txn->mt_cursors[dbi] = mc;
5855 mc->mc_flags |= C_ALLOCD;
5866 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
5870 if (txn == NULL || mc == NULL || mc->mc_dbi >= txn->mt_numdbs)
5873 if (txn->mt_cursors)
5876 flags = mc->mc_flags;
5878 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
5880 mc->mc_flags |= (flags & C_ALLOCD);
5884 /* Return the count of duplicate data items for the current key */
5886 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
5890 if (mc == NULL || countp == NULL)
5893 if (!(mc->mc_db->md_flags & MDB_DUPSORT))
5896 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5897 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5900 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
5903 *countp = mc->mc_xcursor->mx_db.md_entries;
5909 mdb_cursor_close(MDB_cursor *mc)
5912 /* remove from txn, if tracked */
5913 if (mc->mc_txn->mt_cursors) {
5914 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
5915 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
5917 *prev = mc->mc_next;
5919 if (mc->mc_flags & C_ALLOCD)
5925 mdb_cursor_txn(MDB_cursor *mc)
5927 if (!mc) return NULL;
5932 mdb_cursor_dbi(MDB_cursor *mc)
5938 /** Replace the key for a node with a new key.
5939 * @param[in] mp The page containing the node to operate on.
5940 * @param[in] indx The index of the node to operate on.
5941 * @param[in] key The new key to use.
5942 * @return 0 on success, non-zero on failure.
5945 mdb_update_key(MDB_cursor *mc, MDB_val *key)
5952 indx_t ptr, i, numkeys, indx;
5955 indx = mc->mc_ki[mc->mc_top];
5956 mp = mc->mc_pg[mc->mc_top];
5957 node = NODEPTR(mp, indx);
5958 ptr = mp->mp_ptrs[indx];
5962 char kbuf2[(MDB_MAXKEYSIZE*2+1)];
5963 k2.mv_data = NODEKEY(node);
5964 k2.mv_size = node->mn_ksize;
5965 DPRINTF("update key %u (ofs %u) [%s] to [%s] on page %zu",
5967 mdb_dkey(&k2, kbuf2),
5973 delta0 = delta = key->mv_size - node->mn_ksize;
5975 /* Must be 2-byte aligned. If new key is
5976 * shorter by 1, the shift will be skipped.
5978 delta += (delta & 1);
5980 if (delta > 0 && SIZELEFT(mp) < delta) {
5982 /* not enough space left, do a delete and split */
5983 DPRINTF("Not enough room, delta = %d, splitting...", delta);
5984 pgno = NODEPGNO(node);
5985 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5986 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
5989 numkeys = NUMKEYS(mp);
5990 for (i = 0; i < numkeys; i++) {
5991 if (mp->mp_ptrs[i] <= ptr)
5992 mp->mp_ptrs[i] -= delta;
5995 base = (char *)mp + mp->mp_upper;
5996 len = ptr - mp->mp_upper + NODESIZE;
5997 memmove(base - delta, base, len);
5998 mp->mp_upper -= delta;
6000 node = NODEPTR(mp, indx);
6003 /* But even if no shift was needed, update ksize */
6005 node->mn_ksize = key->mv_size;
6008 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
6014 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
6016 /** Move a node from csrc to cdst.
6019 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
6026 unsigned short flags;
6030 /* Mark src and dst as dirty. */
6031 if ((rc = mdb_page_touch(csrc)) ||
6032 (rc = mdb_page_touch(cdst)))
6035 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6036 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0); /* fake */
6037 key.mv_size = csrc->mc_db->md_pad;
6038 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6040 data.mv_data = NULL;
6044 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
6045 assert(!((long)srcnode&1));
6046 srcpg = NODEPGNO(srcnode);
6047 flags = srcnode->mn_flags;
6048 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6049 unsigned int snum = csrc->mc_snum;
6051 /* must find the lowest key below src */
6052 mdb_page_search_lowest(csrc);
6053 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6054 key.mv_size = csrc->mc_db->md_pad;
6055 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6057 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6058 key.mv_size = NODEKSZ(s2);
6059 key.mv_data = NODEKEY(s2);
6061 csrc->mc_snum = snum--;
6062 csrc->mc_top = snum;
6064 key.mv_size = NODEKSZ(srcnode);
6065 key.mv_data = NODEKEY(srcnode);
6067 data.mv_size = NODEDSZ(srcnode);
6068 data.mv_data = NODEDATA(srcnode);
6070 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
6071 unsigned int snum = cdst->mc_snum;
6074 /* must find the lowest key below dst */
6075 mdb_page_search_lowest(cdst);
6076 if (IS_LEAF2(cdst->mc_pg[cdst->mc_top])) {
6077 bkey.mv_size = cdst->mc_db->md_pad;
6078 bkey.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, bkey.mv_size);
6080 s2 = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6081 bkey.mv_size = NODEKSZ(s2);
6082 bkey.mv_data = NODEKEY(s2);
6084 cdst->mc_snum = snum--;
6085 cdst->mc_top = snum;
6086 mdb_cursor_copy(cdst, &mn);
6088 rc = mdb_update_key(&mn, &bkey);
6093 DPRINTF("moving %s node %u [%s] on page %zu to node %u on page %zu",
6094 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
6095 csrc->mc_ki[csrc->mc_top],
6097 csrc->mc_pg[csrc->mc_top]->mp_pgno,
6098 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno);
6100 /* Add the node to the destination page.
6102 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
6103 if (rc != MDB_SUCCESS)
6106 /* Delete the node from the source page.
6108 mdb_node_del(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6111 /* Adjust other cursors pointing to mp */
6112 MDB_cursor *m2, *m3;
6113 MDB_dbi dbi = csrc->mc_dbi;
6114 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
6116 if (csrc->mc_flags & C_SUB)
6119 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6120 if (m2 == csrc) continue;
6121 if (csrc->mc_flags & C_SUB)
6122 m3 = &m2->mc_xcursor->mx_cursor;
6125 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
6126 csrc->mc_ki[csrc->mc_top]) {
6127 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
6128 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
6133 /* Update the parent separators.
6135 if (csrc->mc_ki[csrc->mc_top] == 0) {
6136 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
6137 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6138 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6140 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6141 key.mv_size = NODEKSZ(srcnode);
6142 key.mv_data = NODEKEY(srcnode);
6144 DPRINTF("update separator for source page %zu to [%s]",
6145 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key));
6146 mdb_cursor_copy(csrc, &mn);
6149 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6152 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6154 indx_t ix = csrc->mc_ki[csrc->mc_top];
6155 nullkey.mv_size = 0;
6156 csrc->mc_ki[csrc->mc_top] = 0;
6157 rc = mdb_update_key(csrc, &nullkey);
6158 csrc->mc_ki[csrc->mc_top] = ix;
6159 assert(rc == MDB_SUCCESS);
6163 if (cdst->mc_ki[cdst->mc_top] == 0) {
6164 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
6165 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6166 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
6168 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6169 key.mv_size = NODEKSZ(srcnode);
6170 key.mv_data = NODEKEY(srcnode);
6172 DPRINTF("update separator for destination page %zu to [%s]",
6173 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key));
6174 mdb_cursor_copy(cdst, &mn);
6177 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6180 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
6182 indx_t ix = cdst->mc_ki[cdst->mc_top];
6183 nullkey.mv_size = 0;
6184 cdst->mc_ki[cdst->mc_top] = 0;
6185 rc = mdb_update_key(cdst, &nullkey);
6186 cdst->mc_ki[cdst->mc_top] = ix;
6187 assert(rc == MDB_SUCCESS);
6194 /** Merge one page into another.
6195 * The nodes from the page pointed to by \b csrc will
6196 * be copied to the page pointed to by \b cdst and then
6197 * the \b csrc page will be freed.
6198 * @param[in] csrc Cursor pointing to the source page.
6199 * @param[in] cdst Cursor pointing to the destination page.
6202 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
6210 DPRINTF("merging page %zu into %zu", csrc->mc_pg[csrc->mc_top]->mp_pgno,
6211 cdst->mc_pg[cdst->mc_top]->mp_pgno);
6213 assert(csrc->mc_snum > 1); /* can't merge root page */
6214 assert(cdst->mc_snum > 1);
6216 /* Mark dst as dirty. */
6217 if ((rc = mdb_page_touch(cdst)))
6220 /* Move all nodes from src to dst.
6222 j = nkeys = NUMKEYS(cdst->mc_pg[cdst->mc_top]);
6223 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6224 key.mv_size = csrc->mc_db->md_pad;
6225 key.mv_data = METADATA(csrc->mc_pg[csrc->mc_top]);
6226 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6227 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
6228 if (rc != MDB_SUCCESS)
6230 key.mv_data = (char *)key.mv_data + key.mv_size;
6233 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6234 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], i);
6235 if (i == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6236 unsigned int snum = csrc->mc_snum;
6238 /* must find the lowest key below src */
6239 mdb_page_search_lowest(csrc);
6240 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6241 key.mv_size = csrc->mc_db->md_pad;
6242 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6244 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6245 key.mv_size = NODEKSZ(s2);
6246 key.mv_data = NODEKEY(s2);
6248 csrc->mc_snum = snum--;
6249 csrc->mc_top = snum;
6251 key.mv_size = srcnode->mn_ksize;
6252 key.mv_data = NODEKEY(srcnode);
6255 data.mv_size = NODEDSZ(srcnode);
6256 data.mv_data = NODEDATA(srcnode);
6257 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
6258 if (rc != MDB_SUCCESS)
6263 DPRINTF("dst page %zu now has %u keys (%.1f%% filled)",
6264 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);
6266 /* Unlink the src page from parent and add to free list.
6268 mdb_node_del(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1], 0);
6269 if (csrc->mc_ki[csrc->mc_top-1] == 0) {
6272 rc = mdb_update_key(csrc, &key);
6278 mdb_midl_append(&csrc->mc_txn->mt_free_pgs, csrc->mc_pg[csrc->mc_top]->mp_pgno);
6279 if (IS_LEAF(csrc->mc_pg[csrc->mc_top]))
6280 csrc->mc_db->md_leaf_pages--;
6282 csrc->mc_db->md_branch_pages--;
6284 /* Adjust other cursors pointing to mp */
6285 MDB_cursor *m2, *m3;
6286 MDB_dbi dbi = csrc->mc_dbi;
6287 MDB_page *mp = cdst->mc_pg[cdst->mc_top];
6289 if (csrc->mc_flags & C_SUB)
6292 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6293 if (csrc->mc_flags & C_SUB)
6294 m3 = &m2->mc_xcursor->mx_cursor;
6297 if (m3 == csrc) continue;
6298 if (m3->mc_snum < csrc->mc_snum) continue;
6299 if (m3->mc_pg[csrc->mc_top] == csrc->mc_pg[csrc->mc_top]) {
6300 m3->mc_pg[csrc->mc_top] = mp;
6301 m3->mc_ki[csrc->mc_top] += nkeys;
6305 mdb_cursor_pop(csrc);
6307 return mdb_rebalance(csrc);
6310 /** Copy the contents of a cursor.
6311 * @param[in] csrc The cursor to copy from.
6312 * @param[out] cdst The cursor to copy to.
6315 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
6319 cdst->mc_txn = csrc->mc_txn;
6320 cdst->mc_dbi = csrc->mc_dbi;
6321 cdst->mc_db = csrc->mc_db;
6322 cdst->mc_dbx = csrc->mc_dbx;
6323 cdst->mc_snum = csrc->mc_snum;
6324 cdst->mc_top = csrc->mc_top;
6325 cdst->mc_flags = csrc->mc_flags;
6327 for (i=0; i<csrc->mc_snum; i++) {
6328 cdst->mc_pg[i] = csrc->mc_pg[i];
6329 cdst->mc_ki[i] = csrc->mc_ki[i];
6333 /** Rebalance the tree after a delete operation.
6334 * @param[in] mc Cursor pointing to the page where rebalancing
6336 * @return 0 on success, non-zero on failure.
6339 mdb_rebalance(MDB_cursor *mc)
6343 unsigned int ptop, minkeys;
6346 minkeys = 1 + (IS_BRANCH(mc->mc_pg[mc->mc_top]));
6350 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6351 DPRINTF("rebalancing %s page %zu (has %u keys, %.1f%% full)",
6352 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
6353 pgno, NUMKEYS(mc->mc_pg[mc->mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10);
6357 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD &&
6358 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
6361 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6362 DPRINTF("no need to rebalance page %zu, above fill threshold",
6368 if (mc->mc_snum < 2) {
6369 MDB_page *mp = mc->mc_pg[0];
6371 DPUTS("Can't rebalance a subpage, ignoring");
6374 if (NUMKEYS(mp) == 0) {
6375 DPUTS("tree is completely empty");
6376 mc->mc_db->md_root = P_INVALID;
6377 mc->mc_db->md_depth = 0;
6378 mc->mc_db->md_leaf_pages = 0;
6379 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6383 /* Adjust other cursors pointing to mp */
6384 MDB_cursor *m2, *m3;
6385 MDB_dbi dbi = mc->mc_dbi;
6387 if (mc->mc_flags & C_SUB)
6390 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6391 if (m2 == mc) continue;
6392 if (mc->mc_flags & C_SUB)
6393 m3 = &m2->mc_xcursor->mx_cursor;
6396 if (m3->mc_snum < mc->mc_snum) continue;
6397 if (m3->mc_pg[0] == mp) {
6403 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
6404 DPUTS("collapsing root page!");
6405 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6406 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
6407 if ((rc = mdb_page_get(mc->mc_txn, mc->mc_db->md_root,
6410 mc->mc_db->md_depth--;
6411 mc->mc_db->md_branch_pages--;
6413 /* Adjust other cursors pointing to mp */
6414 MDB_cursor *m2, *m3;
6415 MDB_dbi dbi = mc->mc_dbi;
6417 if (mc->mc_flags & C_SUB)
6420 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6421 if (m2 == mc) continue;
6422 if (mc->mc_flags & C_SUB)
6423 m3 = &m2->mc_xcursor->mx_cursor;
6426 if (m3->mc_snum < mc->mc_snum) continue;
6427 if (m3->mc_pg[0] == mp) {
6428 m3->mc_pg[0] = mc->mc_pg[0];
6435 DPUTS("root page doesn't need rebalancing");
6439 /* The parent (branch page) must have at least 2 pointers,
6440 * otherwise the tree is invalid.
6442 ptop = mc->mc_top-1;
6443 assert(NUMKEYS(mc->mc_pg[ptop]) > 1);
6445 /* Leaf page fill factor is below the threshold.
6446 * Try to move keys from left or right neighbor, or
6447 * merge with a neighbor page.
6452 mdb_cursor_copy(mc, &mn);
6453 mn.mc_xcursor = NULL;
6455 if (mc->mc_ki[ptop] == 0) {
6456 /* We're the leftmost leaf in our parent.
6458 DPUTS("reading right neighbor");
6460 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6461 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
6463 mn.mc_ki[mn.mc_top] = 0;
6464 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
6466 /* There is at least one neighbor to the left.
6468 DPUTS("reading left neighbor");
6470 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6471 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
6473 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
6474 mc->mc_ki[mc->mc_top] = 0;
6477 DPRINTF("found neighbor page %zu (%u keys, %.1f%% full)",
6478 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);
6480 /* If the neighbor page is above threshold and has enough keys,
6481 * move one key from it. Otherwise we should try to merge them.
6482 * (A branch page must never have less than 2 keys.)
6484 minkeys = 1 + (IS_BRANCH(mn.mc_pg[mn.mc_top]));
6485 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys)
6486 return mdb_node_move(&mn, mc);
6488 if (mc->mc_ki[ptop] == 0)
6489 rc = mdb_page_merge(&mn, mc);
6491 rc = mdb_page_merge(mc, &mn);
6492 mc->mc_flags &= ~C_INITIALIZED;
6497 /** Complete a delete operation started by #mdb_cursor_del(). */
6499 mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf)
6503 /* add overflow pages to free list */
6504 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6508 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6509 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
6510 mc->mc_db->md_overflow_pages -= ovpages;
6511 for (i=0; i<ovpages; i++) {
6512 DPRINTF("freed ov page %zu", pg);
6513 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
6517 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], mc->mc_db->md_pad);
6518 mc->mc_db->md_entries--;
6519 rc = mdb_rebalance(mc);
6520 if (rc != MDB_SUCCESS)
6521 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6522 /* if mc points past last node in page, invalidate */
6523 else if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6524 mc->mc_flags &= ~C_INITIALIZED;
6530 mdb_del(MDB_txn *txn, MDB_dbi dbi,
6531 MDB_val *key, MDB_val *data)
6536 MDB_val rdata, *xdata;
6540 assert(key != NULL);
6542 DPRINTF("====> delete db %u key [%s]", dbi, DKEY(key));
6544 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
6547 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
6551 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
6555 mdb_cursor_init(&mc, txn, dbi, &mx);
6566 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
6568 /* let mdb_page_split know about this cursor if needed:
6569 * delete will trigger a rebalance; if it needs to move
6570 * a node from one page to another, it will have to
6571 * update the parent's separator key(s). If the new sepkey
6572 * is larger than the current one, the parent page may
6573 * run out of space, triggering a split. We need this
6574 * cursor to be consistent until the end of the rebalance.
6576 mc.mc_next = txn->mt_cursors[dbi];
6577 txn->mt_cursors[dbi] = &mc;
6578 rc = mdb_cursor_del(&mc, data ? 0 : MDB_NODUPDATA);
6579 txn->mt_cursors[dbi] = mc.mc_next;
6584 /** Split a page and insert a new node.
6585 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
6586 * The cursor will be updated to point to the actual page and index where
6587 * the node got inserted after the split.
6588 * @param[in] newkey The key for the newly inserted node.
6589 * @param[in] newdata The data for the newly inserted node.
6590 * @param[in] newpgno The page number, if the new node is a branch node.
6591 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
6592 * @return 0 on success, non-zero on failure.
6595 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
6596 unsigned int nflags)
6599 int rc = MDB_SUCCESS, ins_new = 0, new_root = 0, newpos = 1, did_split = 0;
6602 unsigned int i, j, split_indx, nkeys, pmax;
6604 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
6606 MDB_page *mp, *rp, *pp;
6611 mp = mc->mc_pg[mc->mc_top];
6612 newindx = mc->mc_ki[mc->mc_top];
6614 DPRINTF("-----> splitting %s page %zu and adding [%s] at index %i",
6615 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
6616 DKEY(newkey), mc->mc_ki[mc->mc_top]);
6618 /* Create a right sibling. */
6619 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
6621 DPRINTF("new right sibling: page %zu", rp->mp_pgno);
6623 if (mc->mc_snum < 2) {
6624 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
6626 /* shift current top to make room for new parent */
6627 mc->mc_pg[1] = mc->mc_pg[0];
6628 mc->mc_ki[1] = mc->mc_ki[0];
6631 mc->mc_db->md_root = pp->mp_pgno;
6632 DPRINTF("root split! new root = %zu", pp->mp_pgno);
6633 mc->mc_db->md_depth++;
6636 /* Add left (implicit) pointer. */
6637 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
6638 /* undo the pre-push */
6639 mc->mc_pg[0] = mc->mc_pg[1];
6640 mc->mc_ki[0] = mc->mc_ki[1];
6641 mc->mc_db->md_root = mp->mp_pgno;
6642 mc->mc_db->md_depth--;
6649 ptop = mc->mc_top-1;
6650 DPRINTF("parent branch page is %zu", mc->mc_pg[ptop]->mp_pgno);
6653 mc->mc_flags |= C_SPLITTING;
6654 mdb_cursor_copy(mc, &mn);
6655 mn.mc_pg[mn.mc_top] = rp;
6656 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
6658 if (nflags & MDB_APPEND) {
6659 mn.mc_ki[mn.mc_top] = 0;
6661 split_indx = newindx;
6666 nkeys = NUMKEYS(mp);
6667 split_indx = nkeys / 2;
6668 if (newindx < split_indx)
6674 unsigned int lsize, rsize, ksize;
6675 /* Move half of the keys to the right sibling */
6677 x = mc->mc_ki[mc->mc_top] - split_indx;
6678 ksize = mc->mc_db->md_pad;
6679 split = LEAF2KEY(mp, split_indx, ksize);
6680 rsize = (nkeys - split_indx) * ksize;
6681 lsize = (nkeys - split_indx) * sizeof(indx_t);
6682 mp->mp_lower -= lsize;
6683 rp->mp_lower += lsize;
6684 mp->mp_upper += rsize - lsize;
6685 rp->mp_upper -= rsize - lsize;
6686 sepkey.mv_size = ksize;
6687 if (newindx == split_indx) {
6688 sepkey.mv_data = newkey->mv_data;
6690 sepkey.mv_data = split;
6693 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
6694 memcpy(rp->mp_ptrs, split, rsize);
6695 sepkey.mv_data = rp->mp_ptrs;
6696 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
6697 memcpy(ins, newkey->mv_data, ksize);
6698 mp->mp_lower += sizeof(indx_t);
6699 mp->mp_upper -= ksize - sizeof(indx_t);
6702 memcpy(rp->mp_ptrs, split, x * ksize);
6703 ins = LEAF2KEY(rp, x, ksize);
6704 memcpy(ins, newkey->mv_data, ksize);
6705 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
6706 rp->mp_lower += sizeof(indx_t);
6707 rp->mp_upper -= ksize - sizeof(indx_t);
6708 mc->mc_ki[mc->mc_top] = x;
6709 mc->mc_pg[mc->mc_top] = rp;
6714 /* For leaf pages, check the split point based on what
6715 * fits where, since otherwise mdb_node_add can fail.
6717 * This check is only needed when the data items are
6718 * relatively large, such that being off by one will
6719 * make the difference between success or failure.
6721 * It's also relevant if a page happens to be laid out
6722 * such that one half of its nodes are all "small" and
6723 * the other half of its nodes are "large." If the new
6724 * item is also "large" and falls on the half with
6725 * "large" nodes, it also may not fit.
6728 unsigned int psize, nsize;
6729 /* Maximum free space in an empty page */
6730 pmax = mc->mc_txn->mt_env->me_psize - PAGEHDRSZ;
6731 nsize = mdb_leaf_size(mc->mc_txn->mt_env, newkey, newdata);
6732 if ((nkeys < 20) || (nsize > pmax/16)) {
6733 if (newindx <= split_indx) {
6736 for (i=0; i<split_indx; i++) {
6737 node = NODEPTR(mp, i);
6738 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6739 if (F_ISSET(node->mn_flags, F_BIGDATA))
6740 psize += sizeof(pgno_t);
6742 psize += NODEDSZ(node);
6746 split_indx = newindx;
6757 for (i=nkeys-1; i>=split_indx; i--) {
6758 node = NODEPTR(mp, i);
6759 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6760 if (F_ISSET(node->mn_flags, F_BIGDATA))
6761 psize += sizeof(pgno_t);
6763 psize += NODEDSZ(node);
6767 split_indx = newindx;
6778 /* First find the separating key between the split pages.
6779 * The case where newindx == split_indx is ambiguous; the
6780 * new item could go to the new page or stay on the original
6781 * page. If newpos == 1 it goes to the new page.
6783 if (newindx == split_indx && newpos) {
6784 sepkey.mv_size = newkey->mv_size;
6785 sepkey.mv_data = newkey->mv_data;
6787 node = NODEPTR(mp, split_indx);
6788 sepkey.mv_size = node->mn_ksize;
6789 sepkey.mv_data = NODEKEY(node);
6793 DPRINTF("separator is [%s]", DKEY(&sepkey));
6795 /* Copy separator key to the parent.
6797 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(mc->mc_txn->mt_env, &sepkey)) {
6801 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
6804 if (mn.mc_snum == mc->mc_snum) {
6805 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
6806 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
6807 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
6808 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
6813 /* Right page might now have changed parent.
6814 * Check if left page also changed parent.
6816 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
6817 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
6818 for (i=0; i<ptop; i++) {
6819 mc->mc_pg[i] = mn.mc_pg[i];
6820 mc->mc_ki[i] = mn.mc_ki[i];
6822 mc->mc_pg[ptop] = mn.mc_pg[ptop];
6823 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
6827 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
6830 mc->mc_flags ^= C_SPLITTING;
6831 if (rc != MDB_SUCCESS) {
6834 if (nflags & MDB_APPEND) {
6835 mc->mc_pg[mc->mc_top] = rp;
6836 mc->mc_ki[mc->mc_top] = 0;
6837 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
6840 for (i=0; i<mc->mc_top; i++)
6841 mc->mc_ki[i] = mn.mc_ki[i];
6848 /* Move half of the keys to the right sibling. */
6850 /* grab a page to hold a temporary copy */
6851 copy = mdb_page_malloc(mc);
6855 copy->mp_pgno = mp->mp_pgno;
6856 copy->mp_flags = mp->mp_flags;
6857 copy->mp_lower = PAGEHDRSZ;
6858 copy->mp_upper = mc->mc_txn->mt_env->me_psize;
6859 mc->mc_pg[mc->mc_top] = copy;
6860 for (i = j = 0; i <= nkeys; j++) {
6861 if (i == split_indx) {
6862 /* Insert in right sibling. */
6863 /* Reset insert index for right sibling. */
6864 if (i != newindx || (newpos ^ ins_new)) {
6866 mc->mc_pg[mc->mc_top] = rp;
6870 if (i == newindx && !ins_new) {
6871 /* Insert the original entry that caused the split. */
6872 rkey.mv_data = newkey->mv_data;
6873 rkey.mv_size = newkey->mv_size;
6882 /* Update index for the new key. */
6883 mc->mc_ki[mc->mc_top] = j;
6884 } else if (i == nkeys) {
6887 node = NODEPTR(mp, i);
6888 rkey.mv_data = NODEKEY(node);
6889 rkey.mv_size = node->mn_ksize;
6891 xdata.mv_data = NODEDATA(node);
6892 xdata.mv_size = NODEDSZ(node);
6895 pgno = NODEPGNO(node);
6896 flags = node->mn_flags;
6901 if (!IS_LEAF(mp) && j == 0) {
6902 /* First branch index doesn't need key data. */
6906 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
6910 nkeys = NUMKEYS(copy);
6911 for (i=0; i<nkeys; i++)
6912 mp->mp_ptrs[i] = copy->mp_ptrs[i];
6913 mp->mp_lower = copy->mp_lower;
6914 mp->mp_upper = copy->mp_upper;
6915 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
6916 mc->mc_txn->mt_env->me_psize - copy->mp_upper);
6918 /* reset back to original page */
6919 if (newindx < split_indx || (!newpos && newindx == split_indx)) {
6920 mc->mc_pg[mc->mc_top] = mp;
6921 if (nflags & MDB_RESERVE) {
6922 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6923 if (!(node->mn_flags & F_BIGDATA))
6924 newdata->mv_data = NODEDATA(node);
6930 /* return tmp page to freelist */
6931 mdb_page_free(mc->mc_txn->mt_env, copy);
6934 /* Adjust other cursors pointing to mp */
6935 MDB_cursor *m2, *m3;
6936 MDB_dbi dbi = mc->mc_dbi;
6937 int fixup = NUMKEYS(mp);
6939 if (mc->mc_flags & C_SUB)
6942 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6943 if (m2 == mc) continue;
6944 if (mc->mc_flags & C_SUB)
6945 m3 = &m2->mc_xcursor->mx_cursor;
6948 if (!(m3->mc_flags & C_INITIALIZED))
6950 if (m3->mc_flags & C_SPLITTING)
6955 for (k=m3->mc_top; k>=0; k--) {
6956 m3->mc_ki[k+1] = m3->mc_ki[k];
6957 m3->mc_pg[k+1] = m3->mc_pg[k];
6959 if (m3->mc_ki[0] >= split_indx) {
6964 m3->mc_pg[0] = mc->mc_pg[0];
6968 if (m3->mc_pg[mc->mc_top] == mp) {
6969 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
6970 m3->mc_ki[mc->mc_top]++;
6971 if (m3->mc_ki[mc->mc_top] >= fixup) {
6972 m3->mc_pg[mc->mc_top] = rp;
6973 m3->mc_ki[mc->mc_top] -= fixup;
6974 m3->mc_ki[ptop] = mn.mc_ki[ptop];
6976 } else if (!did_split && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
6977 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
6986 mdb_put(MDB_txn *txn, MDB_dbi dbi,
6987 MDB_val *key, MDB_val *data, unsigned int flags)
6992 assert(key != NULL);
6993 assert(data != NULL);
6995 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
6998 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
7002 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
7006 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP)) != flags)
7009 mdb_cursor_init(&mc, txn, dbi, &mx);
7010 return mdb_cursor_put(&mc, key, data, flags);
7014 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
7016 if ((flag & CHANGEABLE) != flag)
7019 env->me_flags |= flag;
7021 env->me_flags &= ~flag;
7026 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
7031 *arg = env->me_flags;
7036 mdb_env_get_path(MDB_env *env, const char **arg)
7041 *arg = env->me_path;
7045 /** Common code for #mdb_stat() and #mdb_env_stat().
7046 * @param[in] env the environment to operate in.
7047 * @param[in] db the #MDB_db record containing the stats to return.
7048 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
7049 * @return 0, this function always succeeds.
7052 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
7054 arg->ms_psize = env->me_psize;
7055 arg->ms_depth = db->md_depth;
7056 arg->ms_branch_pages = db->md_branch_pages;
7057 arg->ms_leaf_pages = db->md_leaf_pages;
7058 arg->ms_overflow_pages = db->md_overflow_pages;
7059 arg->ms_entries = db->md_entries;
7064 mdb_env_stat(MDB_env *env, MDB_stat *arg)
7068 if (env == NULL || arg == NULL)
7071 toggle = mdb_env_pick_meta(env);
7073 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
7077 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
7081 if (env == NULL || arg == NULL)
7084 toggle = mdb_env_pick_meta(env);
7085 arg->me_mapaddr = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : 0;
7086 arg->me_mapsize = env->me_mapsize;
7087 arg->me_maxreaders = env->me_maxreaders;
7088 arg->me_numreaders = env->me_numreaders;
7089 arg->me_last_pgno = env->me_metas[toggle]->mm_last_pg;
7090 arg->me_last_txnid = env->me_metas[toggle]->mm_txnid;
7094 /** Set the default comparison functions for a database.
7095 * Called immediately after a database is opened to set the defaults.
7096 * The user can then override them with #mdb_set_compare() or
7097 * #mdb_set_dupsort().
7098 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
7099 * @param[in] dbi A database handle returned by #mdb_dbi_open()
7102 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
7104 uint16_t f = txn->mt_dbs[dbi].md_flags;
7106 txn->mt_dbxs[dbi].md_cmp =
7107 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
7108 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
7110 txn->mt_dbxs[dbi].md_dcmp =
7111 !(f & MDB_DUPSORT) ? 0 :
7112 ((f & MDB_INTEGERDUP)
7113 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
7114 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
7117 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
7122 int rc, dbflag, exact;
7123 unsigned int unused = 0;
7126 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
7127 mdb_default_cmp(txn, FREE_DBI);
7130 if ((flags & VALID_FLAGS) != flags)
7136 if (flags & PERSISTENT_FLAGS) {
7137 uint16_t f2 = flags & PERSISTENT_FLAGS;
7138 /* make sure flag changes get committed */
7139 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
7140 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
7141 txn->mt_flags |= MDB_TXN_DIRTY;
7144 mdb_default_cmp(txn, MAIN_DBI);
7148 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
7149 mdb_default_cmp(txn, MAIN_DBI);
7152 /* Is the DB already open? */
7154 for (i=2; i<txn->mt_numdbs; i++) {
7155 if (!txn->mt_dbxs[i].md_name.mv_size) {
7156 /* Remember this free slot */
7157 if (!unused) unused = i;
7160 if (len == txn->mt_dbxs[i].md_name.mv_size &&
7161 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
7167 /* If no free slot and max hit, fail */
7168 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
7169 return MDB_DBS_FULL;
7171 /* Find the DB info */
7172 dbflag = DB_NEW|DB_VALID;
7175 key.mv_data = (void *)name;
7176 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
7177 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
7178 if (rc == MDB_SUCCESS) {
7179 /* make sure this is actually a DB */
7180 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
7181 if (!(node->mn_flags & F_SUBDATA))
7183 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
7184 /* Create if requested */
7186 data.mv_size = sizeof(MDB_db);
7187 data.mv_data = &dummy;
7188 memset(&dummy, 0, sizeof(dummy));
7189 dummy.md_root = P_INVALID;
7190 dummy.md_flags = flags & PERSISTENT_FLAGS;
7191 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
7195 /* OK, got info, add to table */
7196 if (rc == MDB_SUCCESS) {
7197 unsigned int slot = unused ? unused : txn->mt_numdbs;
7198 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
7199 txn->mt_dbxs[slot].md_name.mv_size = len;
7200 txn->mt_dbxs[slot].md_rel = NULL;
7201 txn->mt_dbflags[slot] = dbflag;
7202 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
7204 txn->mt_env->me_dbflags[slot] = txn->mt_dbs[slot].md_flags;
7205 mdb_default_cmp(txn, slot);
7214 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
7216 if (txn == NULL || arg == NULL || dbi >= txn->mt_numdbs)
7219 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
7222 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
7225 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
7227 ptr = env->me_dbxs[dbi].md_name.mv_data;
7228 env->me_dbxs[dbi].md_name.mv_data = NULL;
7229 env->me_dbxs[dbi].md_name.mv_size = 0;
7230 env->me_dbflags[dbi] = 0;
7234 /** Add all the DB's pages to the free list.
7235 * @param[in] mc Cursor on the DB to free.
7236 * @param[in] subs non-Zero to check for sub-DBs in this DB.
7237 * @return 0 on success, non-zero on failure.
7240 mdb_drop0(MDB_cursor *mc, int subs)
7244 rc = mdb_page_search(mc, NULL, 0);
7245 if (rc == MDB_SUCCESS) {
7250 /* LEAF2 pages have no nodes, cannot have sub-DBs */
7251 if (IS_LEAF2(mc->mc_pg[mc->mc_top]))
7254 mdb_cursor_copy(mc, &mx);
7255 while (mc->mc_snum > 0) {
7256 if (IS_LEAF(mc->mc_pg[mc->mc_top])) {
7257 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
7258 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
7259 if (ni->mn_flags & F_BIGDATA) {
7260 int j, ovpages = OVPAGES(NODEDSZ(ni), mc->mc_txn->mt_env->me_psize);
7262 memcpy(&pg, NODEDATA(ni), sizeof(pg));
7263 for (j=0; j<ovpages; j++) {
7264 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
7267 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
7268 mdb_xcursor_init1(mc, ni);
7269 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
7275 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
7277 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
7280 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
7285 mc->mc_ki[mc->mc_top] = i;
7286 rc = mdb_cursor_sibling(mc, 1);
7288 /* no more siblings, go back to beginning
7289 * of previous level.
7293 for (i=1; i<mc->mc_snum; i++) {
7295 mc->mc_pg[i] = mx.mc_pg[i];
7300 mdb_midl_append(&mc->mc_txn->mt_free_pgs,
7301 mc->mc_db->md_root);
7306 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
7311 if (!txn || !dbi || dbi >= txn->mt_numdbs || (unsigned)del > 1 || !(txn->mt_dbflags[dbi] & DB_VALID))
7314 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
7317 rc = mdb_cursor_open(txn, dbi, &mc);
7321 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
7325 /* Can't delete the main DB */
7326 if (del && dbi > MAIN_DBI) {
7327 rc = mdb_del(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL);
7329 txn->mt_dbflags[dbi] = DB_STALE;
7330 mdb_dbi_close(txn->mt_env, dbi);
7333 /* reset the DB record, mark it dirty */
7334 txn->mt_dbflags[dbi] |= DB_DIRTY;
7335 txn->mt_dbs[dbi].md_depth = 0;
7336 txn->mt_dbs[dbi].md_branch_pages = 0;
7337 txn->mt_dbs[dbi].md_leaf_pages = 0;
7338 txn->mt_dbs[dbi].md_overflow_pages = 0;
7339 txn->mt_dbs[dbi].md_entries = 0;
7340 txn->mt_dbs[dbi].md_root = P_INVALID;
7342 txn->mt_flags |= MDB_TXN_DIRTY;
7345 mdb_cursor_close(mc);
7349 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7351 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7354 txn->mt_dbxs[dbi].md_cmp = cmp;
7358 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7360 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7363 txn->mt_dbxs[dbi].md_dcmp = cmp;
7367 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
7369 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7372 txn->mt_dbxs[dbi].md_rel = rel;
7376 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
7378 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7381 txn->mt_dbxs[dbi].md_relctx = ctx;
projects / openldap / blob