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_dbxs) /* A reset txn has mt_dbxs==NULL */
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; /* close nothing if called again */
2018 txn->mt_dbxs = NULL; /* mark txn as reset */
2022 /* close(free) all cursors */
2023 for (i=0; i<txn->mt_numdbs; i++) {
2024 if (txn->mt_cursors[i]) {
2026 while ((mc = txn->mt_cursors[i])) {
2027 txn->mt_cursors[i] = mc->mc_next;
2028 if (mc->mc_flags & C_ALLOCD)
2034 if (!(env->me_flags & MDB_WRITEMAP)) {
2035 /* return all dirty pages to dpage list */
2036 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2037 dp = txn->mt_u.dirty_list[i].mptr;
2038 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2039 mdb_page_free(txn->mt_env, dp);
2041 /* large pages just get freed directly */
2042 VGMEMP_FREE(txn->mt_env, dp);
2048 free(env->me_pgfree);
2050 if (txn->mt_parent) {
2051 txn->mt_parent->mt_child = NULL;
2052 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2053 mdb_midl_free(txn->mt_free_pgs);
2054 free(txn->mt_u.dirty_list);
2057 if (mdb_midl_shrink(&txn->mt_free_pgs))
2058 env->me_free_pgs = txn->mt_free_pgs;
2061 txn->mt_env->me_pghead = txn->mt_env->me_pgfree = NULL;
2062 txn->mt_env->me_pglast = 0;
2065 /* The writer mutex was locked in mdb_txn_begin. */
2066 UNLOCK_MUTEX_W(env);
2071 mdb_txn_reset(MDB_txn *txn)
2076 DPRINTF("reset txn %zu%c %p on mdbenv %p, root page %zu",
2077 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2078 (void *) txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
2080 /* This call is only valid for read-only txns */
2081 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2084 mdb_txn_reset0(txn);
2088 mdb_txn_abort(MDB_txn *txn)
2093 DPRINTF("abort txn %zu%c %p on mdbenv %p, root page %zu",
2094 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2095 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
2098 mdb_txn_abort(txn->mt_child);
2100 mdb_txn_reset0(txn);
2101 /* Free reader slot tied to this txn (if MDB_NOTLS && writable FS) */
2102 if ((txn->mt_flags & MDB_TXN_RDONLY) && txn->mt_u.reader)
2103 txn->mt_u.reader->mr_pid = 0;
2109 mdb_txn_commit(MDB_txn *txn)
2117 pgno_t next, freecnt;
2118 txnid_t oldpg_txnid, id;
2121 assert(txn != NULL);
2122 assert(txn->mt_env != NULL);
2124 if (txn->mt_child) {
2125 mdb_txn_commit(txn->mt_child);
2126 txn->mt_child = NULL;
2131 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2132 /* update the DB flags */
2133 for (i = 2; i<txn->mt_numdbs; i++) {
2134 if (txn->mt_dbflags[i] & DB_NEW)
2135 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2137 if (txn->mt_numdbs > env->me_numdbs)
2138 env->me_numdbs = txn->mt_numdbs;
2139 txn->mt_numdbs = 2; /* so txn_abort() doesn't close any new handles */
2144 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
2145 DPUTS("error flag is set, can't commit");
2147 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
2152 if (txn->mt_parent) {
2153 MDB_txn *parent = txn->mt_parent;
2157 /* Append our free list to parent's */
2158 if (mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs)) {
2162 mdb_midl_free(txn->mt_free_pgs);
2164 parent->mt_next_pgno = txn->mt_next_pgno;
2165 parent->mt_flags = txn->mt_flags;
2167 /* Merge (and close) our cursors with parent's */
2168 mdb_cursor_merge(txn);
2170 /* Update parent's DB table. */
2171 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2172 txn->mt_parent->mt_numdbs = txn->mt_numdbs;
2173 txn->mt_parent->mt_dbflags[0] = txn->mt_dbflags[0];
2174 txn->mt_parent->mt_dbflags[1] = txn->mt_dbflags[1];
2175 for (i=2; i<txn->mt_numdbs; i++) {
2176 /* preserve parent's DB_NEW status */
2177 x = txn->mt_parent->mt_dbflags[i] & DB_NEW;
2178 txn->mt_parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
2181 dst = txn->mt_parent->mt_u.dirty_list;
2182 src = txn->mt_u.dirty_list;
2183 /* Find len = length of merging our dirty list with parent's */
2185 dst[0].mid = 0; /* simplify loops */
2186 if (parent->mt_parent) {
2187 len = x + src[0].mid;
2188 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
2189 for (i = x; y && i; y--) {
2190 pgno_t yp = src[y].mid;
2191 while (yp < dst[i].mid)
2193 if (yp == dst[i].mid) {
2198 } else { /* Simplify the above for single-ancestor case */
2199 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
2201 /* Merge our dirty list with parent's */
2203 for (i = len; y; dst[i--] = src[y--]) {
2204 pgno_t yp = src[y].mid;
2205 while (yp < dst[x].mid)
2206 dst[i--] = dst[x--];
2207 if (yp == dst[x].mid)
2208 free(dst[x--].mptr);
2212 free(txn->mt_u.dirty_list);
2213 parent->mt_dirty_room = txn->mt_dirty_room;
2215 txn->mt_parent->mt_child = NULL;
2216 free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pgfree);
2221 if (txn != env->me_txn) {
2222 DPUTS("attempt to commit unknown transaction");
2227 if (!txn->mt_u.dirty_list[0].mid && !(txn->mt_flags & MDB_TXN_DIRTY))
2230 DPRINTF("committing txn %zu %p on mdbenv %p, root page %zu",
2231 txn->mt_txnid, (void *)txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root);
2233 /* Update DB root pointers */
2234 if (txn->mt_numdbs > 2) {
2237 data.mv_size = sizeof(MDB_db);
2239 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
2240 for (i = 2; i < txn->mt_numdbs; i++) {
2241 if (txn->mt_dbflags[i] & DB_DIRTY) {
2242 data.mv_data = &txn->mt_dbs[i];
2243 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
2250 /* Save the freelist as of this transaction to the freeDB. This
2251 * can change the freelist, so keep trying until it stabilizes.
2253 * env->me_pglast and the length of txn->mt_free_pgs cannot decrease,
2254 * except the code below can decrease env->me_pglast to split pghead.
2255 * Page numbers cannot disappear from txn->mt_free_pgs. New pages
2256 * can only appear in env->me_pghead when env->me_pglast increases.
2257 * Until then, the me_pghead pointer won't move but can become NULL.
2260 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
2261 oldpg_txnid = id = 0;
2264 /* should only be one record now */
2265 if (env->me_pghead || env->me_pglast) {
2266 /* make sure first page of freeDB is touched and on freelist */
2267 rc = mdb_page_search(&mc, NULL, MDB_PS_MODIFY);
2268 if (rc && rc != MDB_NOTFOUND) {
2275 /* Delete IDLs we used from the free list */
2276 if (env->me_pglast) {
2281 rc = mdb_cursor_first(&mc, &key, NULL);
2284 oldpg_txnid = *(txnid_t *)key.mv_data;
2286 assert(oldpg_txnid <= env->me_pglast);
2288 rc = mdb_cursor_del(&mc, 0);
2291 } while (oldpg_txnid < env->me_pglast);
2294 /* Save IDL of pages freed by this txn, to freeDB */
2296 if (freecnt != txn->mt_free_pgs[0]) {
2299 /* make sure last page of freeDB is touched and on freelist */
2300 key.mv_size = MDB_MAXKEYSIZE+1;
2302 rc = mdb_page_search(&mc, &key, MDB_PS_MODIFY);
2303 if (rc && rc != MDB_NOTFOUND)
2309 MDB_IDL idl = txn->mt_free_pgs;
2310 mdb_midl_sort(txn->mt_free_pgs);
2311 DPRINTF("IDL write txn %zu root %zu num %zu",
2312 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
2313 for (i=1; i<=idl[0]; i++) {
2314 DPRINTF("IDL %zu", idl[i]);
2318 /* write to last page of freeDB */
2319 key.mv_size = sizeof(pgno_t);
2320 key.mv_data = &txn->mt_txnid;
2321 /* The free list can still grow during this call,
2322 * despite the pre-emptive touches above. So retry
2323 * until the reserved space remains big enough.
2326 assert(freecnt < txn->mt_free_pgs[0]);
2327 freecnt = txn->mt_free_pgs[0];
2328 data.mv_size = MDB_IDL_SIZEOF(txn->mt_free_pgs);
2329 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2332 } while (freecnt != txn->mt_free_pgs[0]);
2333 mdb_midl_sort(txn->mt_free_pgs);
2334 memcpy(data.mv_data, txn->mt_free_pgs, data.mv_size);
2335 if (oldpg_txnid < env->me_pglast || (!env->me_pghead && id))
2336 goto free_pgfirst; /* used up freeDB[oldpg_txnid] */
2339 /* Put back page numbers we took from freeDB but did not use */
2340 if (env->me_pghead) {
2345 mop = env->me_pghead;
2346 id = env->me_pglast;
2347 key.mv_size = sizeof(id);
2349 /* These steps may grow the freelist again
2350 * due to freed overflow pages...
2355 if (orig > env->me_maxfree_1pg && id > 4)
2356 orig = env->me_maxfree_1pg; /* Do not use more than 1 page */
2357 data.mv_size = (orig + 1) * sizeof(pgno_t);
2358 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2361 assert(!env->me_pghead || env->me_pglast);
2362 /* mop could have been used again here */
2363 if (id != env->me_pglast || env->me_pghead == NULL)
2364 goto again; /* was completely used up */
2365 assert(mop == env->me_pghead);
2366 } while (mop[0] < orig && --i);
2367 memcpy(data.mv_data, mop, data.mv_size);
2370 *(pgno_t *)data.mv_data = orig;
2371 mop[orig] = mop[0] - orig;
2372 env->me_pghead = mop += orig;
2373 /* Save more oldpages at the previous txnid. */
2374 assert(env->me_pglast == id && id == oldpg_txnid);
2375 env->me_pglast = --oldpg_txnid;
2379 /* Check for growth of freelist again */
2380 if (freecnt != txn->mt_free_pgs[0])
2383 free(env->me_pgfree);
2384 env->me_pghead = env->me_pgfree = NULL;
2386 if (!MDB_IDL_IS_ZERO(txn->mt_free_pgs)) {
2387 if (mdb_midl_shrink(&txn->mt_free_pgs))
2388 env->me_free_pgs = txn->mt_free_pgs;
2395 if (env->me_flags & MDB_WRITEMAP) {
2396 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2397 dp = txn->mt_u.dirty_list[i].mptr;
2398 /* clear dirty flag */
2399 dp->mp_flags &= ~P_DIRTY;
2400 txn->mt_u.dirty_list[i].mid = 0;
2402 txn->mt_u.dirty_list[0].mid = 0;
2406 /* Commit up to MDB_COMMIT_PAGES dirty pages to disk until done.
2412 /* Windows actually supports scatter/gather I/O, but only on
2413 * unbuffered file handles. Since we're relying on the OS page
2414 * cache for all our data, that's self-defeating. So we just
2415 * write pages one at a time. We use the ov structure to set
2416 * the write offset, to at least save the overhead of a Seek
2420 memset(&ov, 0, sizeof(ov));
2421 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2423 dp = txn->mt_u.dirty_list[i].mptr;
2424 DPRINTF("committing page %zu", dp->mp_pgno);
2425 size = dp->mp_pgno * env->me_psize;
2426 ov.Offset = size & 0xffffffff;
2427 ov.OffsetHigh = size >> 16;
2428 ov.OffsetHigh >>= 16;
2429 /* clear dirty flag */
2430 dp->mp_flags &= ~P_DIRTY;
2431 wsize = env->me_psize;
2432 if (IS_OVERFLOW(dp)) wsize *= dp->mp_pages;
2433 rc = WriteFile(env->me_fd, dp, wsize, NULL, &ov);
2436 DPRINTF("WriteFile: %d", n);
2443 struct iovec iov[MDB_COMMIT_PAGES];
2447 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2448 dp = txn->mt_u.dirty_list[i].mptr;
2449 if (dp->mp_pgno != next) {
2451 rc = writev(env->me_fd, iov, n);
2455 DPUTS("short write, filesystem full?");
2457 DPRINTF("writev: %s", strerror(n));
2464 lseek(env->me_fd, dp->mp_pgno * env->me_psize, SEEK_SET);
2467 DPRINTF("committing page %zu", dp->mp_pgno);
2468 iov[n].iov_len = env->me_psize;
2469 if (IS_OVERFLOW(dp)) iov[n].iov_len *= dp->mp_pages;
2470 iov[n].iov_base = (char *)dp;
2471 size += iov[n].iov_len;
2472 next = dp->mp_pgno + (IS_OVERFLOW(dp) ? dp->mp_pages : 1);
2473 /* clear dirty flag */
2474 dp->mp_flags &= ~P_DIRTY;
2475 if (++n >= MDB_COMMIT_PAGES) {
2485 rc = writev(env->me_fd, iov, n);
2489 DPUTS("short write, filesystem full?");
2491 DPRINTF("writev: %s", strerror(n));
2498 /* Drop the dirty pages.
2500 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2501 dp = txn->mt_u.dirty_list[i].mptr;
2502 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2503 mdb_page_free(txn->mt_env, dp);
2505 VGMEMP_FREE(txn->mt_env, dp);
2508 txn->mt_u.dirty_list[i].mid = 0;
2510 txn->mt_u.dirty_list[0].mid = 0;
2513 if ((n = mdb_env_sync(env, 0)) != 0 ||
2514 (n = mdb_env_write_meta(txn)) != MDB_SUCCESS) {
2522 /* update the DB flags */
2523 for (i = 2; i<txn->mt_numdbs; i++) {
2524 if (txn->mt_dbflags[i] & DB_NEW)
2525 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2527 if (txn->mt_numdbs > env->me_numdbs)
2528 env->me_numdbs = txn->mt_numdbs;
2530 UNLOCK_MUTEX_W(env);
2536 /** Read the environment parameters of a DB environment before
2537 * mapping it into memory.
2538 * @param[in] env the environment handle
2539 * @param[out] meta address of where to store the meta information
2540 * @return 0 on success, non-zero on failure.
2543 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
2550 /* We don't know the page size yet, so use a minimum value.
2551 * Read both meta pages so we can use the latest one.
2554 for (i=0; i<2; i++) {
2556 if (!ReadFile(env->me_fd, &pbuf, MDB_PAGESIZE, (DWORD *)&rc, NULL) || rc == 0)
2558 if ((rc = read(env->me_fd, &pbuf, MDB_PAGESIZE)) == 0)
2563 else if (rc != MDB_PAGESIZE) {
2567 DPRINTF("read: %s", strerror(err));
2571 p = (MDB_page *)&pbuf;
2573 if (!F_ISSET(p->mp_flags, P_META)) {
2574 DPRINTF("page %zu not a meta page", p->mp_pgno);
2579 if (m->mm_magic != MDB_MAGIC) {
2580 DPUTS("meta has invalid magic");
2584 if (m->mm_version != MDB_VERSION) {
2585 DPRINTF("database is version %u, expected version %u",
2586 m->mm_version, MDB_VERSION);
2587 return MDB_VERSION_MISMATCH;
2591 if (m->mm_txnid > meta->mm_txnid)
2592 memcpy(meta, m, sizeof(*m));
2594 memcpy(meta, m, sizeof(*m));
2596 if (SetFilePointer(env->me_fd, meta->mm_psize, NULL, FILE_BEGIN) != meta->mm_psize)
2598 if (lseek(env->me_fd, meta->mm_psize, SEEK_SET) != meta->mm_psize)
2606 /** Write the environment parameters of a freshly created DB environment.
2607 * @param[in] env the environment handle
2608 * @param[out] meta address of where to store the meta information
2609 * @return 0 on success, non-zero on failure.
2612 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
2619 DPUTS("writing new meta page");
2621 GET_PAGESIZE(psize);
2623 meta->mm_magic = MDB_MAGIC;
2624 meta->mm_version = MDB_VERSION;
2625 meta->mm_mapsize = env->me_mapsize;
2626 meta->mm_psize = psize;
2627 meta->mm_last_pg = 1;
2628 meta->mm_flags = env->me_flags & 0xffff;
2629 meta->mm_flags |= MDB_INTEGERKEY;
2630 meta->mm_dbs[0].md_root = P_INVALID;
2631 meta->mm_dbs[1].md_root = P_INVALID;
2633 p = calloc(2, psize);
2635 p->mp_flags = P_META;
2638 memcpy(m, meta, sizeof(*meta));
2640 q = (MDB_page *)((char *)p + psize);
2643 q->mp_flags = P_META;
2646 memcpy(m, meta, sizeof(*meta));
2651 SetFilePointer(env->me_fd, 0, NULL, FILE_BEGIN);
2652 rc = WriteFile(env->me_fd, p, psize * 2, &len, NULL);
2653 rc = (len == psize * 2) ? MDB_SUCCESS : ErrCode();
2656 lseek(env->me_fd, 0, SEEK_SET);
2657 rc = write(env->me_fd, p, psize * 2);
2658 rc = (rc == (int)psize * 2) ? MDB_SUCCESS : ErrCode();
2664 /** Update the environment info to commit a transaction.
2665 * @param[in] txn the transaction that's being committed
2666 * @return 0 on success, non-zero on failure.
2669 mdb_env_write_meta(MDB_txn *txn)
2672 MDB_meta meta, metab, *mp;
2674 int rc, len, toggle;
2681 assert(txn != NULL);
2682 assert(txn->mt_env != NULL);
2684 toggle = !txn->mt_toggle;
2685 DPRINTF("writing meta page %d for root page %zu",
2686 toggle, txn->mt_dbs[MAIN_DBI].md_root);
2689 mp = env->me_metas[toggle];
2691 if (env->me_flags & MDB_WRITEMAP) {
2692 /* Persist any increases of mapsize config */
2693 if (env->me_mapsize > mp->mm_mapsize)
2694 mp->mm_mapsize = env->me_mapsize;
2695 mp->mm_dbs[0] = txn->mt_dbs[0];
2696 mp->mm_dbs[1] = txn->mt_dbs[1];
2697 mp->mm_last_pg = txn->mt_next_pgno - 1;
2698 mp->mm_txnid = txn->mt_txnid;
2699 if (!(env->me_flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
2700 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
2703 ptr += env->me_psize;
2704 if (MDB_MSYNC(ptr, env->me_psize, rc)) {
2711 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
2712 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
2714 ptr = (char *)&meta;
2715 if (env->me_mapsize > mp->mm_mapsize) {
2716 /* Persist any increases of mapsize config */
2717 meta.mm_mapsize = env->me_mapsize;
2718 off = offsetof(MDB_meta, mm_mapsize);
2720 off = offsetof(MDB_meta, mm_dbs[0].md_depth);
2722 len = sizeof(MDB_meta) - off;
2725 meta.mm_dbs[0] = txn->mt_dbs[0];
2726 meta.mm_dbs[1] = txn->mt_dbs[1];
2727 meta.mm_last_pg = txn->mt_next_pgno - 1;
2728 meta.mm_txnid = txn->mt_txnid;
2731 off += env->me_psize;
2734 /* Write to the SYNC fd */
2735 mfd = env->me_flags & (MDB_NOSYNC|MDB_NOMETASYNC) ?
2736 env->me_fd : env->me_mfd;
2739 memset(&ov, 0, sizeof(ov));
2741 WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov);
2744 rc = pwrite(mfd, ptr, len, off);
2749 DPUTS("write failed, disk error?");
2750 /* On a failure, the pagecache still contains the new data.
2751 * Write some old data back, to prevent it from being used.
2752 * Use the non-SYNC fd; we know it will fail anyway.
2754 meta.mm_last_pg = metab.mm_last_pg;
2755 meta.mm_txnid = metab.mm_txnid;
2757 WriteFile(env->me_fd, ptr, len, NULL, &ov);
2759 r2 = pwrite(env->me_fd, ptr, len, off);
2762 env->me_flags |= MDB_FATAL_ERROR;
2766 /* Memory ordering issues are irrelevant; since the entire writer
2767 * is wrapped by wmutex, all of these changes will become visible
2768 * after the wmutex is unlocked. Since the DB is multi-version,
2769 * readers will get consistent data regardless of how fresh or
2770 * how stale their view of these values is.
2772 txn->mt_env->me_txns->mti_txnid = txn->mt_txnid;
2777 /** Check both meta pages to see which one is newer.
2778 * @param[in] env the environment handle
2779 * @return meta toggle (0 or 1).
2782 mdb_env_pick_meta(const MDB_env *env)
2784 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
2788 mdb_env_create(MDB_env **env)
2792 e = calloc(1, sizeof(MDB_env));
2796 e->me_maxreaders = DEFAULT_READERS;
2797 e->me_maxdbs = e->me_numdbs = 2;
2798 e->me_fd = INVALID_HANDLE_VALUE;
2799 e->me_lfd = INVALID_HANDLE_VALUE;
2800 e->me_mfd = INVALID_HANDLE_VALUE;
2801 #ifdef MDB_USE_POSIX_SEM
2802 e->me_rmutex = SEM_FAILED;
2803 e->me_wmutex = SEM_FAILED;
2805 e->me_pid = getpid();
2806 VGMEMP_CREATE(e,0,0);
2812 mdb_env_set_mapsize(MDB_env *env, size_t size)
2816 env->me_mapsize = size;
2818 env->me_maxpg = env->me_mapsize / env->me_psize;
2823 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
2827 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
2832 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
2834 if (env->me_map || readers < 1)
2836 env->me_maxreaders = readers;
2841 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
2843 if (!env || !readers)
2845 *readers = env->me_maxreaders;
2849 /** Further setup required for opening an MDB environment
2852 mdb_env_open2(MDB_env *env)
2854 unsigned int flags = env->me_flags;
2855 int i, newenv = 0, prot;
2859 memset(&meta, 0, sizeof(meta));
2861 if ((i = mdb_env_read_header(env, &meta)) != 0) {
2864 DPUTS("new mdbenv");
2868 /* Was a mapsize configured? */
2869 if (!env->me_mapsize) {
2870 /* If this is a new environment, take the default,
2871 * else use the size recorded in the existing env.
2873 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
2874 } else if (env->me_mapsize < meta.mm_mapsize) {
2875 /* If the configured size is smaller, make sure it's
2876 * still big enough. Silently round up to minimum if not.
2878 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
2879 if (env->me_mapsize < minsize)
2880 env->me_mapsize = minsize;
2886 LONG sizelo, sizehi;
2887 sizelo = env->me_mapsize & 0xffffffff;
2888 sizehi = env->me_mapsize >> 16; /* pointless on WIN32, only needed on W64 */
2890 /* Windows won't create mappings for zero length files.
2891 * Just allocate the maxsize right now.
2894 SetFilePointer(env->me_fd, sizelo, sizehi ? &sizehi : NULL, 0);
2895 if (!SetEndOfFile(env->me_fd))
2897 SetFilePointer(env->me_fd, 0, NULL, 0);
2899 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
2900 PAGE_READWRITE : PAGE_READONLY,
2901 sizehi, sizelo, NULL);
2904 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
2905 FILE_MAP_WRITE : FILE_MAP_READ,
2906 0, 0, env->me_mapsize, meta.mm_address);
2914 if (flags & MDB_WRITEMAP) {
2916 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
2919 env->me_map = mmap(meta.mm_address, env->me_mapsize, prot, i,
2921 if (env->me_map == MAP_FAILED) {
2925 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
2927 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
2929 #ifdef POSIX_MADV_RANDOM
2930 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
2931 #endif /* POSIX_MADV_RANDOM */
2932 #endif /* MADV_RANDOM */
2936 if (flags & MDB_FIXEDMAP)
2937 meta.mm_address = env->me_map;
2938 i = mdb_env_init_meta(env, &meta);
2939 if (i != MDB_SUCCESS) {
2942 } else if (meta.mm_address && env->me_map != meta.mm_address) {
2943 /* Can happen because the address argument to mmap() is just a
2944 * hint. mmap() can pick another, e.g. if the range is in use.
2945 * The MAP_FIXED flag would prevent that, but then mmap could
2946 * instead unmap existing pages to make room for the new map.
2948 return EBUSY; /* TODO: Make a new MDB_* error code? */
2950 env->me_psize = meta.mm_psize;
2951 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
2952 env->me_nodemax = (env->me_psize - PAGEHDRSZ) / MDB_MINKEYS;
2954 env->me_maxpg = env->me_mapsize / env->me_psize;
2956 p = (MDB_page *)env->me_map;
2957 env->me_metas[0] = METADATA(p);
2958 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + meta.mm_psize);
2962 int toggle = mdb_env_pick_meta(env);
2963 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
2965 DPRINTF("opened database version %u, pagesize %u",
2966 env->me_metas[0]->mm_version, env->me_psize);
2967 DPRINTF("using meta page %d", toggle);
2968 DPRINTF("depth: %u", db->md_depth);
2969 DPRINTF("entries: %zu", db->md_entries);
2970 DPRINTF("branch pages: %zu", db->md_branch_pages);
2971 DPRINTF("leaf pages: %zu", db->md_leaf_pages);
2972 DPRINTF("overflow pages: %zu", db->md_overflow_pages);
2973 DPRINTF("root: %zu", db->md_root);
2981 /** Release a reader thread's slot in the reader lock table.
2982 * This function is called automatically when a thread exits.
2983 * @param[in] ptr This points to the slot in the reader lock table.
2986 mdb_env_reader_dest(void *ptr)
2988 MDB_reader *reader = ptr;
2994 /** Junk for arranging thread-specific callbacks on Windows. This is
2995 * necessarily platform and compiler-specific. Windows supports up
2996 * to 1088 keys. Let's assume nobody opens more than 64 environments
2997 * in a single process, for now. They can override this if needed.
2999 #ifndef MAX_TLS_KEYS
3000 #define MAX_TLS_KEYS 64
3002 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
3003 static int mdb_tls_nkeys;
3005 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
3009 case DLL_PROCESS_ATTACH: break;
3010 case DLL_THREAD_ATTACH: break;
3011 case DLL_THREAD_DETACH:
3012 for (i=0; i<mdb_tls_nkeys; i++) {
3013 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
3014 mdb_env_reader_dest(r);
3017 case DLL_PROCESS_DETACH: break;
3022 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3024 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3028 /* Force some symbol references.
3029 * _tls_used forces the linker to create the TLS directory if not already done
3030 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
3032 #pragma comment(linker, "/INCLUDE:_tls_used")
3033 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
3034 #pragma const_seg(".CRT$XLB")
3035 extern const PIMAGE_TLS_CALLBACK mdb_tls_callback;
3036 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3039 #pragma comment(linker, "/INCLUDE:__tls_used")
3040 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
3041 #pragma data_seg(".CRT$XLB")
3042 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3044 #endif /* WIN 32/64 */
3045 #endif /* !__GNUC__ */
3048 /** Downgrade the exclusive lock on the region back to shared */
3050 mdb_env_share_locks(MDB_env *env, int *excl)
3052 int rc = 0, toggle = mdb_env_pick_meta(env);
3054 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
3059 /* First acquire a shared lock. The Unlock will
3060 * then release the existing exclusive lock.
3062 memset(&ov, 0, sizeof(ov));
3063 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3066 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3072 struct flock lock_info;
3073 /* The shared lock replaces the existing lock */
3074 memset((void *)&lock_info, 0, sizeof(lock_info));
3075 lock_info.l_type = F_RDLCK;
3076 lock_info.l_whence = SEEK_SET;
3077 lock_info.l_start = 0;
3078 lock_info.l_len = 1;
3079 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3080 (rc = ErrCode()) == EINTR) ;
3081 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
3088 /** Try to get exlusive lock, otherwise shared.
3089 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
3092 mdb_env_excl_lock(MDB_env *env, int *excl)
3096 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
3100 memset(&ov, 0, sizeof(ov));
3101 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3108 struct flock lock_info;
3109 memset((void *)&lock_info, 0, sizeof(lock_info));
3110 lock_info.l_type = F_WRLCK;
3111 lock_info.l_whence = SEEK_SET;
3112 lock_info.l_start = 0;
3113 lock_info.l_len = 1;
3114 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3115 (rc = ErrCode()) == EINTR) ;
3119 # ifdef MDB_USE_POSIX_SEM
3120 if (*excl < 0) /* always true when !MDB_USE_POSIX_SEM */
3123 lock_info.l_type = F_RDLCK;
3124 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
3125 (rc = ErrCode()) == EINTR) ;
3133 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
3135 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
3137 * @(#) $Revision: 5.1 $
3138 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
3139 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
3141 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
3145 * Please do not copyright this code. This code is in the public domain.
3147 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
3148 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
3149 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
3150 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
3151 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
3152 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
3153 * PERFORMANCE OF THIS SOFTWARE.
3156 * chongo <Landon Curt Noll> /\oo/\
3157 * http://www.isthe.com/chongo/
3159 * Share and Enjoy! :-)
3162 typedef unsigned long long mdb_hash_t;
3163 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
3165 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
3166 * @param[in] str string to hash
3167 * @param[in] hval initial value for hash
3168 * @return 64 bit hash
3170 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
3171 * hval arg on the first call.
3174 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
3176 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
3177 unsigned char *end = s + val->mv_size;
3179 * FNV-1a hash each octet of the string
3182 /* xor the bottom with the current octet */
3183 hval ^= (mdb_hash_t)*s++;
3185 /* multiply by the 64 bit FNV magic prime mod 2^64 */
3186 hval += (hval << 1) + (hval << 4) + (hval << 5) +
3187 (hval << 7) + (hval << 8) + (hval << 40);
3189 /* return our new hash value */
3193 /** Hash the string and output the hash in hex.
3194 * @param[in] str string to hash
3195 * @param[out] hexbuf an array of 17 chars to hold the hash
3198 mdb_hash_hex(MDB_val *val, char *hexbuf)
3201 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
3202 for (i=0; i<8; i++) {
3203 hexbuf += sprintf(hexbuf, "%02x", (unsigned int)h & 0xff);
3209 /** Open and/or initialize the lock region for the environment.
3210 * @param[in] env The MDB environment.
3211 * @param[in] lpath The pathname of the file used for the lock region.
3212 * @param[in] mode The Unix permissions for the file, if we create it.
3213 * @param[out] excl Resulting file lock type: -1 none, 0 shared, 1 exclusive
3214 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
3215 * @return 0 on success, non-zero on failure.
3218 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
3221 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
3223 # define MDB_ERRCODE_ROFS EROFS
3224 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
3225 # define MDB_CLOEXEC O_CLOEXEC
3228 # define MDB_CLOEXEC 0
3235 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
3236 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
3237 FILE_ATTRIBUTE_NORMAL, NULL);
3239 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
3241 if (env->me_lfd == INVALID_HANDLE_VALUE) {
3243 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
3248 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
3249 /* Lose record locks when exec*() */
3250 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
3251 fcntl(env->me_lfd, F_SETFD, fdflags);
3254 if (!(env->me_flags & MDB_NOTLS)) {
3255 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
3258 env->me_flags |= MDB_ENV_TXKEY;
3260 /* Windows TLS callbacks need help finding their TLS info. */
3261 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
3265 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
3269 /* Try to get exclusive lock. If we succeed, then
3270 * nobody is using the lock region and we should initialize it.
3272 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
3275 size = GetFileSize(env->me_lfd, NULL);
3277 size = lseek(env->me_lfd, 0, SEEK_END);
3279 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
3280 if (size < rsize && *excl > 0) {
3282 SetFilePointer(env->me_lfd, rsize, NULL, 0);
3283 if (!SetEndOfFile(env->me_lfd)) goto fail_errno;
3285 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
3289 size = rsize - sizeof(MDB_txninfo);
3290 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
3295 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
3297 if (!mh) goto fail_errno;
3298 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
3300 if (!env->me_txns) goto fail_errno;
3302 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
3304 if (m == MAP_FAILED) goto fail_errno;
3310 BY_HANDLE_FILE_INFORMATION stbuf;
3319 if (!mdb_sec_inited) {
3320 InitializeSecurityDescriptor(&mdb_null_sd,
3321 SECURITY_DESCRIPTOR_REVISION);
3322 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
3323 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
3324 mdb_all_sa.bInheritHandle = FALSE;
3325 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
3328 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
3329 idbuf.volume = stbuf.dwVolumeSerialNumber;
3330 idbuf.nhigh = stbuf.nFileIndexHigh;
3331 idbuf.nlow = stbuf.nFileIndexLow;
3332 val.mv_data = &idbuf;
3333 val.mv_size = sizeof(idbuf);
3334 mdb_hash_hex(&val, hexbuf);
3335 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", hexbuf);
3336 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", hexbuf);
3337 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
3338 if (!env->me_rmutex) goto fail_errno;
3339 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
3340 if (!env->me_wmutex) goto fail_errno;
3341 #elif defined(MDB_USE_POSIX_SEM)
3350 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
3351 idbuf.dev = stbuf.st_dev;
3352 idbuf.ino = stbuf.st_ino;
3353 val.mv_data = &idbuf;
3354 val.mv_size = sizeof(idbuf);
3355 mdb_hash_hex(&val, hexbuf);
3356 sprintf(env->me_txns->mti_rmname, "/MDBr%s", hexbuf);
3357 sprintf(env->me_txns->mti_wmname, "/MDBw%s", hexbuf);
3358 /* Clean up after a previous run, if needed: Try to
3359 * remove both semaphores before doing anything else.
3361 sem_unlink(env->me_txns->mti_rmname);
3362 sem_unlink(env->me_txns->mti_wmname);
3363 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
3364 O_CREAT|O_EXCL, mode, 1);
3365 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3366 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
3367 O_CREAT|O_EXCL, mode, 1);
3368 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3369 #else /* MDB_USE_POSIX_SEM */
3370 pthread_mutexattr_t mattr;
3372 if ((rc = pthread_mutexattr_init(&mattr))
3373 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
3374 || (rc = pthread_mutex_init(&env->me_txns->mti_mutex, &mattr))
3375 || (rc = pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr)))
3377 pthread_mutexattr_destroy(&mattr);
3378 #endif /* _WIN32 || MDB_USE_POSIX_SEM */
3380 env->me_txns->mti_version = MDB_VERSION;
3381 env->me_txns->mti_magic = MDB_MAGIC;
3382 env->me_txns->mti_txnid = 0;
3383 env->me_txns->mti_numreaders = 0;
3386 if (env->me_txns->mti_magic != MDB_MAGIC) {
3387 DPUTS("lock region has invalid magic");
3391 if (env->me_txns->mti_version != MDB_VERSION) {
3392 DPRINTF("lock region is version %u, expected version %u",
3393 env->me_txns->mti_version, MDB_VERSION);
3394 rc = MDB_VERSION_MISMATCH;
3398 if (rc != EACCES && rc != EAGAIN) {
3402 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
3403 if (!env->me_rmutex) goto fail_errno;
3404 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
3405 if (!env->me_wmutex) goto fail_errno;
3406 #elif defined(MDB_USE_POSIX_SEM)
3407 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
3408 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3409 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
3410 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3421 /** The name of the lock file in the DB environment */
3422 #define LOCKNAME "/lock.mdb"
3423 /** The name of the data file in the DB environment */
3424 #define DATANAME "/data.mdb"
3425 /** The suffix of the lock file when no subdir is used */
3426 #define LOCKSUFF "-lock"
3427 /** Only a subset of the @ref mdb_env flags can be changed
3428 * at runtime. Changing other flags requires closing the
3429 * environment and re-opening it with the new flags.
3431 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC)
3432 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY|MDB_WRITEMAP|MDB_NOTLS)
3435 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
3437 int oflags, rc, len, excl = -1;
3438 char *lpath, *dpath;
3440 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
3444 if (flags & MDB_NOSUBDIR) {
3445 rc = len + sizeof(LOCKSUFF) + len + 1;
3447 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
3452 if (flags & MDB_NOSUBDIR) {
3453 dpath = lpath + len + sizeof(LOCKSUFF);
3454 sprintf(lpath, "%s" LOCKSUFF, path);
3455 strcpy(dpath, path);
3457 dpath = lpath + len + sizeof(LOCKNAME);
3458 sprintf(lpath, "%s" LOCKNAME, path);
3459 sprintf(dpath, "%s" DATANAME, path);
3463 flags |= env->me_flags;
3464 if (flags & MDB_RDONLY) {
3465 /* silently ignore WRITEMAP when we're only getting read access */
3466 flags &= ~MDB_WRITEMAP;
3468 if (!((env->me_free_pgs = mdb_midl_alloc()) &&
3469 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
3472 env->me_flags = flags |= MDB_ENV_ACTIVE;
3476 env->me_path = strdup(path);
3477 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
3478 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
3479 if (!(env->me_dbxs && env->me_path && env->me_dbflags)) {
3484 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
3489 if (F_ISSET(flags, MDB_RDONLY)) {
3490 oflags = GENERIC_READ;
3491 len = OPEN_EXISTING;
3493 oflags = GENERIC_READ|GENERIC_WRITE;
3496 mode = FILE_ATTRIBUTE_NORMAL;
3497 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
3498 NULL, len, mode, NULL);
3500 if (F_ISSET(flags, MDB_RDONLY))
3503 oflags = O_RDWR | O_CREAT;
3505 env->me_fd = open(dpath, oflags, mode);
3507 if (env->me_fd == INVALID_HANDLE_VALUE) {
3512 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
3513 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
3514 env->me_mfd = env->me_fd;
3516 /* Synchronous fd for meta writes. Needed even with
3517 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
3520 env->me_mfd = CreateFile(dpath, oflags,
3521 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
3522 mode | FILE_FLAG_WRITE_THROUGH, NULL);
3524 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
3526 if (env->me_mfd == INVALID_HANDLE_VALUE) {
3531 DPRINTF("opened dbenv %p", (void *) env);
3533 rc = mdb_env_share_locks(env, &excl);
3539 mdb_env_close0(env, excl);
3545 /** Destroy resources from mdb_env_open() and clear our readers */
3547 mdb_env_close0(MDB_env *env, int excl)
3551 if (!(env->me_flags & MDB_ENV_ACTIVE))
3554 free(env->me_dbflags);
3557 free(env->me_dirty_list);
3558 if (env->me_free_pgs)
3559 mdb_midl_free(env->me_free_pgs);
3561 if (env->me_flags & MDB_ENV_TXKEY) {
3562 pthread_key_delete(env->me_txkey);
3564 /* Delete our key from the global list */
3565 for (i=0; i<mdb_tls_nkeys; i++)
3566 if (mdb_tls_keys[i] == env->me_txkey) {
3567 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
3575 munmap(env->me_map, env->me_mapsize);
3577 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
3579 if (env->me_fd != INVALID_HANDLE_VALUE)
3582 pid_t pid = env->me_pid;
3583 /* Clearing readers is done in this function because
3584 * me_txkey with its destructor must be disabled first.
3586 for (i = env->me_numreaders; --i >= 0; )
3587 if (env->me_txns->mti_readers[i].mr_pid == pid)
3588 env->me_txns->mti_readers[i].mr_pid = 0;
3590 if (env->me_rmutex) {
3591 CloseHandle(env->me_rmutex);
3592 if (env->me_wmutex) CloseHandle(env->me_wmutex);
3594 /* Windows automatically destroys the mutexes when
3595 * the last handle closes.
3597 #elif defined(MDB_USE_POSIX_SEM)
3598 if (env->me_rmutex != SEM_FAILED) {
3599 sem_close(env->me_rmutex);
3600 if (env->me_wmutex != SEM_FAILED)
3601 sem_close(env->me_wmutex);
3602 /* If we have the filelock: If we are the
3603 * only remaining user, clean up semaphores.
3606 mdb_env_excl_lock(env, &excl);
3608 sem_unlink(env->me_txns->mti_rmname);
3609 sem_unlink(env->me_txns->mti_wmname);
3613 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
3615 if (env->me_lfd != INVALID_HANDLE_VALUE) {
3618 /* Unlock the lockfile. Windows would have unlocked it
3619 * after closing anyway, but not necessarily at once.
3621 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3627 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
3631 mdb_env_copy(MDB_env *env, const char *path)
3633 MDB_txn *txn = NULL;
3637 HANDLE newfd = INVALID_HANDLE_VALUE;
3639 if (env->me_flags & MDB_NOSUBDIR) {
3640 lpath = (char *)path;
3643 len += sizeof(DATANAME);
3644 lpath = malloc(len);
3647 sprintf(lpath, "%s" DATANAME, path);
3650 /* The destination path must exist, but the destination file must not.
3651 * We don't want the OS to cache the writes, since the source data is
3652 * already in the OS cache.
3655 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
3656 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
3658 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL
3664 if (!(env->me_flags & MDB_NOSUBDIR))
3666 if (newfd == INVALID_HANDLE_VALUE) {
3671 #ifdef F_NOCACHE /* __APPLE__ */
3672 rc = fcntl(newfd, F_NOCACHE, 1);
3679 /* Do the lock/unlock of the reader mutex before starting the
3680 * write txn. Otherwise other read txns could block writers.
3682 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
3687 /* We must start the actual read txn after blocking writers */
3688 mdb_txn_reset0(txn);
3690 /* Temporarily block writers until we snapshot the meta pages */
3693 rc = mdb_txn_renew0(txn);
3695 UNLOCK_MUTEX_W(env);
3700 wsize = env->me_psize * 2;
3704 rc = WriteFile(newfd, env->me_map, wsize, &len, NULL);
3705 rc = (len == wsize) ? MDB_SUCCESS : ErrCode();
3708 rc = write(newfd, env->me_map, wsize);
3709 rc = (rc == (int)wsize) ? MDB_SUCCESS : ErrCode();
3712 UNLOCK_MUTEX_W(env);
3717 ptr = env->me_map + wsize;
3718 wsize = txn->mt_next_pgno * env->me_psize - wsize;
3719 #define MAX_WRITE 2147483648U
3723 if (wsize > MAX_WRITE)
3727 rc = WriteFile(newfd, ptr, w2, &len, NULL);
3728 rc = (len == w2) ? MDB_SUCCESS : ErrCode();
3737 if (wsize > MAX_WRITE)
3741 wres = write(newfd, ptr, w2);
3742 rc = (wres > 0) ? MDB_SUCCESS : ErrCode();
3751 if (newfd != INVALID_HANDLE_VALUE)
3758 mdb_env_close(MDB_env *env)
3766 for (i = env->me_maxdbs; --i > MAIN_DBI; )
3767 free(env->me_dbxs[i].md_name.mv_data);
3769 VGMEMP_DESTROY(env);
3770 while ((dp = env->me_dpages) != NULL) {
3771 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
3772 env->me_dpages = dp->mp_next;
3776 mdb_env_close0(env, 0);
3780 /** Compare two items pointing at aligned size_t's */
3782 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
3784 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
3785 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
3788 /** Compare two items pointing at aligned int's */
3790 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
3792 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
3793 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
3796 /** Compare two items pointing at ints of unknown alignment.
3797 * Nodes and keys are guaranteed to be 2-byte aligned.
3800 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
3802 #if BYTE_ORDER == LITTLE_ENDIAN
3803 unsigned short *u, *c;
3806 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
3807 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
3810 } while(!x && u > (unsigned short *)a->mv_data);
3813 return memcmp(a->mv_data, b->mv_data, a->mv_size);
3817 /** Compare two items lexically */
3819 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
3826 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3832 diff = memcmp(a->mv_data, b->mv_data, len);
3833 return diff ? diff : len_diff<0 ? -1 : len_diff;
3836 /** Compare two items in reverse byte order */
3838 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
3840 const unsigned char *p1, *p2, *p1_lim;
3844 p1_lim = (const unsigned char *)a->mv_data;
3845 p1 = (const unsigned char *)a->mv_data + a->mv_size;
3846 p2 = (const unsigned char *)b->mv_data + b->mv_size;
3848 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3854 while (p1 > p1_lim) {
3855 diff = *--p1 - *--p2;
3859 return len_diff<0 ? -1 : len_diff;
3862 /** Search for key within a page, using binary search.
3863 * Returns the smallest entry larger or equal to the key.
3864 * If exactp is non-null, stores whether the found entry was an exact match
3865 * in *exactp (1 or 0).
3866 * Updates the cursor index with the index of the found entry.
3867 * If no entry larger or equal to the key is found, returns NULL.
3870 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
3872 unsigned int i = 0, nkeys;
3875 MDB_page *mp = mc->mc_pg[mc->mc_top];
3876 MDB_node *node = NULL;
3881 nkeys = NUMKEYS(mp);
3886 COPY_PGNO(pgno, mp->mp_pgno);
3887 DPRINTF("searching %u keys in %s %spage %zu",
3888 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
3895 low = IS_LEAF(mp) ? 0 : 1;
3897 cmp = mc->mc_dbx->md_cmp;
3899 /* Branch pages have no data, so if using integer keys,
3900 * alignment is guaranteed. Use faster mdb_cmp_int.
3902 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
3903 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
3910 nodekey.mv_size = mc->mc_db->md_pad;
3911 node = NODEPTR(mp, 0); /* fake */
3912 while (low <= high) {
3913 i = (low + high) >> 1;
3914 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
3915 rc = cmp(key, &nodekey);
3916 DPRINTF("found leaf index %u [%s], rc = %i",
3917 i, DKEY(&nodekey), rc);
3926 while (low <= high) {
3927 i = (low + high) >> 1;
3929 node = NODEPTR(mp, i);
3930 nodekey.mv_size = NODEKSZ(node);
3931 nodekey.mv_data = NODEKEY(node);
3933 rc = cmp(key, &nodekey);
3936 DPRINTF("found leaf index %u [%s], rc = %i",
3937 i, DKEY(&nodekey), rc);
3939 DPRINTF("found branch index %u [%s -> %zu], rc = %i",
3940 i, DKEY(&nodekey), NODEPGNO(node), rc);
3951 if (rc > 0) { /* Found entry is less than the key. */
3952 i++; /* Skip to get the smallest entry larger than key. */
3954 node = NODEPTR(mp, i);
3957 *exactp = (rc == 0);
3958 /* store the key index */
3959 mc->mc_ki[mc->mc_top] = i;
3961 /* There is no entry larger or equal to the key. */
3964 /* nodeptr is fake for LEAF2 */
3970 mdb_cursor_adjust(MDB_cursor *mc, func)
3974 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
3975 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
3982 /** Pop a page off the top of the cursor's stack. */
3984 mdb_cursor_pop(MDB_cursor *mc)
3987 #ifndef MDB_DEBUG_SKIP
3988 MDB_page *top = mc->mc_pg[mc->mc_top];
3994 DPRINTF("popped page %zu off db %u cursor %p", top->mp_pgno,
3995 mc->mc_dbi, (void *) mc);
3999 /** Push a page onto the top of the cursor's stack. */
4001 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
4003 DPRINTF("pushing page %zu on db %u cursor %p", mp->mp_pgno,
4004 mc->mc_dbi, (void *) mc);
4006 if (mc->mc_snum >= CURSOR_STACK) {
4007 assert(mc->mc_snum < CURSOR_STACK);
4008 return MDB_CURSOR_FULL;
4011 mc->mc_top = mc->mc_snum++;
4012 mc->mc_pg[mc->mc_top] = mp;
4013 mc->mc_ki[mc->mc_top] = 0;
4018 /** Find the address of the page corresponding to a given page number.
4019 * @param[in] txn the transaction for this access.
4020 * @param[in] pgno the page number for the page to retrieve.
4021 * @param[out] ret address of a pointer where the page's address will be stored.
4022 * @return 0 on success, non-zero on failure.
4025 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret)
4029 if (!((txn->mt_flags & MDB_TXN_RDONLY) |
4030 (txn->mt_env->me_flags & MDB_WRITEMAP)))
4034 MDB_ID2L dl = tx2->mt_u.dirty_list;
4036 unsigned x = mdb_mid2l_search(dl, pgno);
4037 if (x <= dl[0].mid && dl[x].mid == pgno) {
4042 } while ((tx2 = tx2->mt_parent) != NULL);
4045 if (pgno < txn->mt_next_pgno) {
4046 p = (MDB_page *)(txn->mt_env->me_map + txn->mt_env->me_psize * pgno);
4048 DPRINTF("page %zu not found", pgno);
4054 return (p != NULL) ? MDB_SUCCESS : MDB_PAGE_NOTFOUND;
4057 /** Search for the page a given key should be in.
4058 * Pushes parent pages on the cursor stack. This function continues a
4059 * search on a cursor that has already been initialized. (Usually by
4060 * #mdb_page_search() but also by #mdb_node_move().)
4061 * @param[in,out] mc the cursor for this operation.
4062 * @param[in] key the key to search for. If NULL, search for the lowest
4063 * page. (This is used by #mdb_cursor_first().)
4064 * @param[in] flags If MDB_PS_MODIFY set, visited pages are updated with new page numbers.
4065 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
4066 * @return 0 on success, non-zero on failure.
4069 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int modify)
4071 MDB_page *mp = mc->mc_pg[mc->mc_top];
4076 while (IS_BRANCH(mp)) {
4080 DPRINTF("branch page %zu has %u keys", mp->mp_pgno, NUMKEYS(mp));
4081 assert(NUMKEYS(mp) > 1);
4082 DPRINTF("found index 0 to page %zu", NODEPGNO(NODEPTR(mp, 0)));
4084 if (key == NULL) /* Initialize cursor to first page. */
4086 else if (key->mv_size > MDB_MAXKEYSIZE && key->mv_data == NULL) {
4087 /* cursor to last page */
4091 node = mdb_node_search(mc, key, &exact);
4093 i = NUMKEYS(mp) - 1;
4095 i = mc->mc_ki[mc->mc_top];
4104 DPRINTF("following index %u for key [%s]",
4106 assert(i < NUMKEYS(mp));
4107 node = NODEPTR(mp, i);
4109 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
4112 mc->mc_ki[mc->mc_top] = i;
4113 if ((rc = mdb_cursor_push(mc, mp)))
4117 if ((rc = mdb_page_touch(mc)) != 0)
4119 mp = mc->mc_pg[mc->mc_top];
4124 DPRINTF("internal error, index points to a %02X page!?",
4126 return MDB_CORRUPTED;
4129 DPRINTF("found leaf page %zu for key [%s]", mp->mp_pgno,
4130 key ? DKEY(key) : NULL);
4135 /** Search for the lowest key under the current branch page.
4136 * This just bypasses a NUMKEYS check in the current page
4137 * before calling mdb_page_search_root(), because the callers
4138 * are all in situations where the current page is known to
4142 mdb_page_search_lowest(MDB_cursor *mc)
4144 MDB_page *mp = mc->mc_pg[mc->mc_top];
4145 MDB_node *node = NODEPTR(mp, 0);
4148 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
4151 mc->mc_ki[mc->mc_top] = 0;
4152 if ((rc = mdb_cursor_push(mc, mp)))
4154 return mdb_page_search_root(mc, NULL, 0);
4157 /** Search for the page a given key should be in.
4158 * Pushes parent pages on the cursor stack. This function just sets up
4159 * the search; it finds the root page for \b mc's database and sets this
4160 * as the root of the cursor's stack. Then #mdb_page_search_root() is
4161 * called to complete the search.
4162 * @param[in,out] mc the cursor for this operation.
4163 * @param[in] key the key to search for. If NULL, search for the lowest
4164 * page. (This is used by #mdb_cursor_first().)
4165 * @param[in] modify If true, visited pages are updated with new page numbers.
4166 * @return 0 on success, non-zero on failure.
4169 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
4174 /* Make sure the txn is still viable, then find the root from
4175 * the txn's db table.
4177 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
4178 DPUTS("transaction has failed, must abort");
4181 /* Make sure we're using an up-to-date root */
4182 if (mc->mc_dbi > MAIN_DBI) {
4183 if ((*mc->mc_dbflag & DB_STALE) ||
4184 ((flags & MDB_PS_MODIFY) && !(*mc->mc_dbflag & DB_DIRTY))) {
4186 unsigned char dbflag = 0;
4187 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
4188 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, flags & MDB_PS_MODIFY);
4191 if (*mc->mc_dbflag & DB_STALE) {
4195 MDB_node *leaf = mdb_node_search(&mc2,
4196 &mc->mc_dbx->md_name, &exact);
4198 return MDB_NOTFOUND;
4199 mdb_node_read(mc->mc_txn, leaf, &data);
4200 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
4202 /* The txn may not know this DBI, or another process may
4203 * have dropped and recreated the DB with other flags.
4205 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
4206 return MDB_INCOMPATIBLE;
4207 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
4209 if (flags & MDB_PS_MODIFY)
4211 *mc->mc_dbflag &= ~DB_STALE;
4212 *mc->mc_dbflag |= dbflag;
4215 root = mc->mc_db->md_root;
4217 if (root == P_INVALID) { /* Tree is empty. */
4218 DPUTS("tree is empty");
4219 return MDB_NOTFOUND;
4224 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
4225 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0])))
4231 DPRINTF("db %u root page %zu has flags 0x%X",
4232 mc->mc_dbi, root, mc->mc_pg[0]->mp_flags);
4234 if (flags & MDB_PS_MODIFY) {
4235 if ((rc = mdb_page_touch(mc)))
4239 if (flags & MDB_PS_ROOTONLY)
4242 return mdb_page_search_root(mc, key, flags);
4245 /** Return the data associated with a given node.
4246 * @param[in] txn The transaction for this operation.
4247 * @param[in] leaf The node being read.
4248 * @param[out] data Updated to point to the node's data.
4249 * @return 0 on success, non-zero on failure.
4252 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
4254 MDB_page *omp; /* overflow page */
4258 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
4259 data->mv_size = NODEDSZ(leaf);
4260 data->mv_data = NODEDATA(leaf);
4264 /* Read overflow data.
4266 data->mv_size = NODEDSZ(leaf);
4267 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
4268 if ((rc = mdb_page_get(txn, pgno, &omp))) {
4269 DPRINTF("read overflow page %zu failed", pgno);
4272 data->mv_data = METADATA(omp);
4278 mdb_get(MDB_txn *txn, MDB_dbi dbi,
4279 MDB_val *key, MDB_val *data)
4288 DPRINTF("===> get db %u key [%s]", dbi, DKEY(key));
4290 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
4293 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4297 mdb_cursor_init(&mc, txn, dbi, &mx);
4298 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
4301 /** Find a sibling for a page.
4302 * Replaces the page at the top of the cursor's stack with the
4303 * specified sibling, if one exists.
4304 * @param[in] mc The cursor for this operation.
4305 * @param[in] move_right Non-zero if the right sibling is requested,
4306 * otherwise the left sibling.
4307 * @return 0 on success, non-zero on failure.
4310 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
4316 if (mc->mc_snum < 2) {
4317 return MDB_NOTFOUND; /* root has no siblings */
4321 DPRINTF("parent page is page %zu, index %u",
4322 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]);
4324 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
4325 : (mc->mc_ki[mc->mc_top] == 0)) {
4326 DPRINTF("no more keys left, moving to %s sibling",
4327 move_right ? "right" : "left");
4328 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
4329 /* undo cursor_pop before returning */
4336 mc->mc_ki[mc->mc_top]++;
4338 mc->mc_ki[mc->mc_top]--;
4339 DPRINTF("just moving to %s index key %u",
4340 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]);
4342 assert(IS_BRANCH(mc->mc_pg[mc->mc_top]));
4344 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4345 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp)))
4348 mdb_cursor_push(mc, mp);
4350 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
4355 /** Move the cursor to the next data item. */
4357 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4363 if (mc->mc_flags & C_EOF) {
4364 return MDB_NOTFOUND;
4367 assert(mc->mc_flags & C_INITIALIZED);
4369 mp = mc->mc_pg[mc->mc_top];
4371 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4372 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4373 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4374 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
4375 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
4376 if (op != MDB_NEXT || rc == MDB_SUCCESS)
4380 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4381 if (op == MDB_NEXT_DUP)
4382 return MDB_NOTFOUND;
4386 DPRINTF("cursor_next: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4388 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
4389 DPUTS("=====> move to next sibling page");
4390 if (mdb_cursor_sibling(mc, 1) != MDB_SUCCESS) {
4391 mc->mc_flags |= C_EOF;
4392 mc->mc_flags &= ~C_INITIALIZED;
4393 return MDB_NOTFOUND;
4395 mp = mc->mc_pg[mc->mc_top];
4396 DPRINTF("next page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4398 mc->mc_ki[mc->mc_top]++;
4400 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4401 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4404 key->mv_size = mc->mc_db->md_pad;
4405 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4409 assert(IS_LEAF(mp));
4410 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4412 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4413 mdb_xcursor_init1(mc, leaf);
4416 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4419 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4420 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4421 if (rc != MDB_SUCCESS)
4426 MDB_GET_KEY(leaf, key);
4430 /** Move the cursor to the previous data item. */
4432 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4438 assert(mc->mc_flags & C_INITIALIZED);
4440 mp = mc->mc_pg[mc->mc_top];
4442 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4443 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4444 if (op == MDB_PREV || op == MDB_PREV_DUP) {
4445 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4446 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
4447 if (op != MDB_PREV || rc == MDB_SUCCESS)
4450 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4451 if (op == MDB_PREV_DUP)
4452 return MDB_NOTFOUND;
4457 DPRINTF("cursor_prev: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4459 if (mc->mc_ki[mc->mc_top] == 0) {
4460 DPUTS("=====> move to prev sibling page");
4461 if (mdb_cursor_sibling(mc, 0) != MDB_SUCCESS) {
4462 mc->mc_flags &= ~C_INITIALIZED;
4463 return MDB_NOTFOUND;
4465 mp = mc->mc_pg[mc->mc_top];
4466 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
4467 DPRINTF("prev page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4469 mc->mc_ki[mc->mc_top]--;
4471 mc->mc_flags &= ~C_EOF;
4473 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4474 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4477 key->mv_size = mc->mc_db->md_pad;
4478 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4482 assert(IS_LEAF(mp));
4483 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4485 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4486 mdb_xcursor_init1(mc, leaf);
4489 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4492 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4493 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4494 if (rc != MDB_SUCCESS)
4499 MDB_GET_KEY(leaf, key);
4503 /** Set the cursor on a specific data item. */
4505 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4506 MDB_cursor_op op, int *exactp)
4510 MDB_node *leaf = NULL;
4515 assert(key->mv_size > 0);
4517 /* See if we're already on the right page */
4518 if (mc->mc_flags & C_INITIALIZED) {
4521 mp = mc->mc_pg[mc->mc_top];
4523 mc->mc_ki[mc->mc_top] = 0;
4524 return MDB_NOTFOUND;
4526 if (mp->mp_flags & P_LEAF2) {
4527 nodekey.mv_size = mc->mc_db->md_pad;
4528 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
4530 leaf = NODEPTR(mp, 0);
4531 MDB_GET_KEY(leaf, &nodekey);
4533 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4535 /* Probably happens rarely, but first node on the page
4536 * was the one we wanted.
4538 mc->mc_ki[mc->mc_top] = 0;
4545 unsigned int nkeys = NUMKEYS(mp);
4547 if (mp->mp_flags & P_LEAF2) {
4548 nodekey.mv_data = LEAF2KEY(mp,
4549 nkeys-1, nodekey.mv_size);
4551 leaf = NODEPTR(mp, nkeys-1);
4552 MDB_GET_KEY(leaf, &nodekey);
4554 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4556 /* last node was the one we wanted */
4557 mc->mc_ki[mc->mc_top] = nkeys-1;
4563 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
4564 /* This is definitely the right page, skip search_page */
4565 if (mp->mp_flags & P_LEAF2) {
4566 nodekey.mv_data = LEAF2KEY(mp,
4567 mc->mc_ki[mc->mc_top], nodekey.mv_size);
4569 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4570 MDB_GET_KEY(leaf, &nodekey);
4572 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4574 /* current node was the one we wanted */
4584 /* If any parents have right-sibs, search.
4585 * Otherwise, there's nothing further.
4587 for (i=0; i<mc->mc_top; i++)
4589 NUMKEYS(mc->mc_pg[i])-1)
4591 if (i == mc->mc_top) {
4592 /* There are no other pages */
4593 mc->mc_ki[mc->mc_top] = nkeys;
4594 return MDB_NOTFOUND;
4598 /* There are no other pages */
4599 mc->mc_ki[mc->mc_top] = 0;
4600 return MDB_NOTFOUND;
4604 rc = mdb_page_search(mc, key, 0);
4605 if (rc != MDB_SUCCESS)
4608 mp = mc->mc_pg[mc->mc_top];
4609 assert(IS_LEAF(mp));
4612 leaf = mdb_node_search(mc, key, exactp);
4613 if (exactp != NULL && !*exactp) {
4614 /* MDB_SET specified and not an exact match. */
4615 return MDB_NOTFOUND;
4619 DPUTS("===> inexact leaf not found, goto sibling");
4620 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
4621 return rc; /* no entries matched */
4622 mp = mc->mc_pg[mc->mc_top];
4623 assert(IS_LEAF(mp));
4624 leaf = NODEPTR(mp, 0);
4628 mc->mc_flags |= C_INITIALIZED;
4629 mc->mc_flags &= ~C_EOF;
4632 key->mv_size = mc->mc_db->md_pad;
4633 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4637 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4638 mdb_xcursor_init1(mc, leaf);
4641 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4642 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
4643 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4646 if (op == MDB_GET_BOTH) {
4652 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
4653 if (rc != MDB_SUCCESS)
4656 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
4658 if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
4660 rc = mc->mc_dbx->md_dcmp(data, &d2);
4662 if (op == MDB_GET_BOTH || rc > 0)
4663 return MDB_NOTFOUND;
4668 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4669 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4674 /* The key already matches in all other cases */
4675 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
4676 MDB_GET_KEY(leaf, key);
4677 DPRINTF("==> cursor placed on key [%s]", DKEY(key));
4682 /** Move the cursor to the first item in the database. */
4684 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4689 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4690 rc = mdb_page_search(mc, NULL, 0);
4691 if (rc != MDB_SUCCESS)
4694 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4696 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
4697 mc->mc_flags |= C_INITIALIZED;
4698 mc->mc_flags &= ~C_EOF;
4700 mc->mc_ki[mc->mc_top] = 0;
4702 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4703 key->mv_size = mc->mc_db->md_pad;
4704 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
4709 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4710 mdb_xcursor_init1(mc, leaf);
4711 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4716 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4717 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4721 MDB_GET_KEY(leaf, key);
4725 /** Move the cursor to the last item in the database. */
4727 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4732 if (!(mc->mc_flags & C_EOF)) {
4734 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4737 lkey.mv_size = MDB_MAXKEYSIZE+1;
4738 lkey.mv_data = NULL;
4739 rc = mdb_page_search(mc, &lkey, 0);
4740 if (rc != MDB_SUCCESS)
4743 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4746 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
4747 mc->mc_flags |= C_INITIALIZED|C_EOF;
4748 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4750 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4751 key->mv_size = mc->mc_db->md_pad;
4752 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
4757 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4758 mdb_xcursor_init1(mc, leaf);
4759 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4764 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4765 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4770 MDB_GET_KEY(leaf, key);
4775 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4784 case MDB_GET_CURRENT:
4785 if (!(mc->mc_flags & C_INITIALIZED)) {
4788 MDB_page *mp = mc->mc_pg[mc->mc_top];
4790 mc->mc_ki[mc->mc_top] = 0;
4796 key->mv_size = mc->mc_db->md_pad;
4797 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4799 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4800 MDB_GET_KEY(leaf, key);
4802 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4803 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
4805 rc = mdb_node_read(mc->mc_txn, leaf, data);
4812 case MDB_GET_BOTH_RANGE:
4813 if (data == NULL || mc->mc_xcursor == NULL) {
4821 if (key == NULL || key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4823 } else if (op == MDB_SET_RANGE)
4824 rc = mdb_cursor_set(mc, key, data, op, NULL);
4826 rc = mdb_cursor_set(mc, key, data, op, &exact);
4828 case MDB_GET_MULTIPLE:
4830 !(mc->mc_db->md_flags & MDB_DUPFIXED) ||
4831 !(mc->mc_flags & C_INITIALIZED)) {
4836 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
4837 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
4840 case MDB_NEXT_MULTIPLE:
4842 !(mc->mc_db->md_flags & MDB_DUPFIXED)) {
4846 if (!(mc->mc_flags & C_INITIALIZED))
4847 rc = mdb_cursor_first(mc, key, data);
4849 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
4850 if (rc == MDB_SUCCESS) {
4851 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
4854 mx = &mc->mc_xcursor->mx_cursor;
4855 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
4857 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
4858 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
4866 case MDB_NEXT_NODUP:
4867 if (!(mc->mc_flags & C_INITIALIZED))
4868 rc = mdb_cursor_first(mc, key, data);
4870 rc = mdb_cursor_next(mc, key, data, op);
4874 case MDB_PREV_NODUP:
4875 if (!(mc->mc_flags & C_INITIALIZED)) {
4876 rc = mdb_cursor_last(mc, key, data);
4877 mc->mc_flags |= C_INITIALIZED;
4878 mc->mc_ki[mc->mc_top]++;
4880 rc = mdb_cursor_prev(mc, key, data, op);
4883 rc = mdb_cursor_first(mc, key, data);
4887 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4888 !(mc->mc_flags & C_INITIALIZED) ||
4889 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4893 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4896 rc = mdb_cursor_last(mc, key, data);
4900 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4901 !(mc->mc_flags & C_INITIALIZED) ||
4902 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4906 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4909 DPRINTF("unhandled/unimplemented cursor operation %u", op);
4917 /** Touch all the pages in the cursor stack.
4918 * Makes sure all the pages are writable, before attempting a write operation.
4919 * @param[in] mc The cursor to operate on.
4922 mdb_cursor_touch(MDB_cursor *mc)
4926 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
4929 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI,
4930 mc->mc_txn->mt_dbs[MAIN_DBI].md_flags & MDB_DUPSORT ? &mcx : NULL);
4931 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
4934 *mc->mc_dbflag |= DB_DIRTY;
4936 for (mc->mc_top = 0; mc->mc_top < mc->mc_snum; mc->mc_top++) {
4937 rc = mdb_page_touch(mc);
4941 mc->mc_top = mc->mc_snum-1;
4946 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4949 MDB_node *leaf = NULL;
4950 MDB_val xdata, *rdata, dkey;
4953 int do_sub = 0, insert = 0;
4954 unsigned int mcount = 0;
4958 char dbuf[MDB_MAXKEYSIZE+1];
4959 unsigned int nflags;
4962 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4965 if (flags != MDB_CURRENT && (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE))
4968 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT) && data->mv_size > MDB_MAXKEYSIZE)
4971 #if SIZE_MAX > MAXDATASIZE
4972 if (data->mv_size > MAXDATASIZE)
4976 DPRINTF("==> put db %u key [%s], size %zu, data size %zu",
4977 mc->mc_dbi, DKEY(key), key ? key->mv_size:0, data->mv_size);
4981 if (flags == MDB_CURRENT) {
4982 if (!(mc->mc_flags & C_INITIALIZED))
4985 } else if (mc->mc_db->md_root == P_INVALID) {
4987 /* new database, write a root leaf page */
4988 DPUTS("allocating new root leaf page");
4989 if ((rc = mdb_page_new(mc, P_LEAF, 1, &np))) {
4993 mdb_cursor_push(mc, np);
4994 mc->mc_db->md_root = np->mp_pgno;
4995 mc->mc_db->md_depth++;
4996 *mc->mc_dbflag |= DB_DIRTY;
4997 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
4999 np->mp_flags |= P_LEAF2;
5000 mc->mc_flags |= C_INITIALIZED;
5006 if (flags & MDB_APPEND) {
5008 rc = mdb_cursor_last(mc, &k2, &d2);
5010 rc = mc->mc_dbx->md_cmp(key, &k2);
5013 mc->mc_ki[mc->mc_top]++;
5015 /* new key is <= last key */
5020 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
5022 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
5023 DPRINTF("duplicate key [%s]", DKEY(key));
5025 return MDB_KEYEXIST;
5027 if (rc && rc != MDB_NOTFOUND)
5031 /* Cursor is positioned, now make sure all pages are writable */
5032 rc2 = mdb_cursor_touch(mc);
5037 /* The key already exists */
5038 if (rc == MDB_SUCCESS) {
5039 /* there's only a key anyway, so this is a no-op */
5040 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5041 unsigned int ksize = mc->mc_db->md_pad;
5042 if (key->mv_size != ksize)
5044 if (flags == MDB_CURRENT) {
5045 char *ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
5046 memcpy(ptr, key->mv_data, ksize);
5051 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5054 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
5055 /* Was a single item before, must convert now */
5057 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5058 /* Just overwrite the current item */
5059 if (flags == MDB_CURRENT)
5062 dkey.mv_size = NODEDSZ(leaf);
5063 dkey.mv_data = NODEDATA(leaf);
5064 #if UINT_MAX < SIZE_MAX
5065 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && dkey.mv_size == sizeof(size_t))
5066 #ifdef MISALIGNED_OK
5067 mc->mc_dbx->md_dcmp = mdb_cmp_long;
5069 mc->mc_dbx->md_dcmp = mdb_cmp_cint;
5072 /* if data matches, ignore it */
5073 if (!mc->mc_dbx->md_dcmp(data, &dkey))
5074 return (flags == MDB_NODUPDATA) ? MDB_KEYEXIST : MDB_SUCCESS;
5076 /* create a fake page for the dup items */
5077 memcpy(dbuf, dkey.mv_data, dkey.mv_size);
5078 dkey.mv_data = dbuf;
5079 fp = (MDB_page *)&pbuf;
5080 fp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5081 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
5082 fp->mp_lower = PAGEHDRSZ;
5083 fp->mp_upper = PAGEHDRSZ + dkey.mv_size + data->mv_size;
5084 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5085 fp->mp_flags |= P_LEAF2;
5086 fp->mp_pad = data->mv_size;
5087 fp->mp_upper += 2 * data->mv_size; /* leave space for 2 more */
5089 fp->mp_upper += 2 * sizeof(indx_t) + 2 * NODESIZE +
5090 (dkey.mv_size & 1) + (data->mv_size & 1);
5092 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5095 xdata.mv_size = fp->mp_upper;
5100 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5101 /* See if we need to convert from fake page to subDB */
5103 unsigned int offset;
5106 fp = NODEDATA(leaf);
5107 if (flags == MDB_CURRENT) {
5109 fp->mp_flags |= P_DIRTY;
5110 COPY_PGNO(fp->mp_pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5111 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
5115 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5116 offset = fp->mp_pad;
5117 if (SIZELEFT(fp) >= offset)
5119 offset *= 4; /* space for 4 more */
5121 offset = NODESIZE + sizeof(indx_t) + data->mv_size;
5123 offset += offset & 1;
5124 if (NODESIZE + sizeof(indx_t) + NODEKSZ(leaf) + NODEDSZ(leaf) +
5125 offset >= mc->mc_txn->mt_env->me_nodemax) {
5126 /* yes, convert it */
5128 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5129 dummy.md_pad = fp->mp_pad;
5130 dummy.md_flags = MDB_DUPFIXED;
5131 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5132 dummy.md_flags |= MDB_INTEGERKEY;
5135 dummy.md_branch_pages = 0;
5136 dummy.md_leaf_pages = 1;
5137 dummy.md_overflow_pages = 0;
5138 dummy.md_entries = NUMKEYS(fp);
5140 xdata.mv_size = sizeof(MDB_db);
5141 xdata.mv_data = &dummy;
5142 if ((rc = mdb_page_alloc(mc, 1, &mp)))
5144 offset = mc->mc_txn->mt_env->me_psize - NODEDSZ(leaf);
5145 flags |= F_DUPDATA|F_SUBDATA;
5146 dummy.md_root = mp->mp_pgno;
5148 /* no, just grow it */
5150 xdata.mv_size = NODEDSZ(leaf) + offset;
5151 xdata.mv_data = &pbuf;
5152 mp = (MDB_page *)&pbuf;
5153 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5156 mp->mp_flags = fp->mp_flags | P_DIRTY;
5157 mp->mp_pad = fp->mp_pad;
5158 mp->mp_lower = fp->mp_lower;
5159 mp->mp_upper = fp->mp_upper + offset;
5161 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
5163 nsize = NODEDSZ(leaf) - fp->mp_upper;
5164 memcpy((char *)mp + mp->mp_upper, (char *)fp + fp->mp_upper, nsize);
5165 for (i=0; i<NUMKEYS(fp); i++)
5166 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
5168 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5172 /* data is on sub-DB, just store it */
5173 flags |= F_DUPDATA|F_SUBDATA;
5177 /* overflow page overwrites need special handling */
5178 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5181 int ovpages, dpages;
5183 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
5184 dpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
5185 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
5186 mdb_page_get(mc->mc_txn, pg, &omp);
5187 /* Is the ov page writable and large enough? */
5188 if ((omp->mp_flags & P_DIRTY) && ovpages >= dpages) {
5189 /* yes, overwrite it. Note in this case we don't
5190 * bother to try shrinking the node if the new data
5191 * is smaller than the overflow threshold.
5193 if (F_ISSET(flags, MDB_RESERVE))
5194 data->mv_data = METADATA(omp);
5196 memcpy(METADATA(omp), data->mv_data, data->mv_size);
5199 /* no, free ovpages */
5201 mc->mc_db->md_overflow_pages -= ovpages;
5202 for (i=0; i<ovpages; i++) {
5203 DPRINTF("freed ov page %zu", pg);
5204 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
5208 } else if (NODEDSZ(leaf) == data->mv_size) {
5209 /* same size, just replace it. Note that we could
5210 * also reuse this node if the new data is smaller,
5211 * but instead we opt to shrink the node in that case.
5213 if (F_ISSET(flags, MDB_RESERVE))
5214 data->mv_data = NODEDATA(leaf);
5215 else if (data->mv_size)
5216 memcpy(NODEDATA(leaf), data->mv_data, data->mv_size);
5218 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
5221 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5222 mc->mc_db->md_entries--;
5224 DPRINTF("inserting key at index %i", mc->mc_ki[mc->mc_top]);
5231 nflags = flags & NODE_ADD_FLAGS;
5232 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(mc->mc_txn->mt_env, key, rdata);
5233 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
5234 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
5235 nflags &= ~MDB_APPEND;
5237 nflags |= MDB_SPLIT_REPLACE;
5238 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
5240 /* There is room already in this leaf page. */
5241 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
5242 if (rc == 0 && !do_sub && insert) {
5243 /* Adjust other cursors pointing to mp */
5244 MDB_cursor *m2, *m3;
5245 MDB_dbi dbi = mc->mc_dbi;
5246 unsigned i = mc->mc_top;
5247 MDB_page *mp = mc->mc_pg[i];
5249 if (mc->mc_flags & C_SUB)
5252 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5253 if (mc->mc_flags & C_SUB)
5254 m3 = &m2->mc_xcursor->mx_cursor;
5257 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
5258 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
5265 if (rc != MDB_SUCCESS)
5266 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5268 /* Now store the actual data in the child DB. Note that we're
5269 * storing the user data in the keys field, so there are strict
5270 * size limits on dupdata. The actual data fields of the child
5271 * DB are all zero size.
5278 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5279 if (flags & MDB_CURRENT) {
5280 xflags = MDB_CURRENT;
5282 mdb_xcursor_init1(mc, leaf);
5283 xflags = (flags & MDB_NODUPDATA) ? MDB_NOOVERWRITE : 0;
5285 /* converted, write the original data first */
5287 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
5291 /* Adjust other cursors pointing to mp */
5293 unsigned i = mc->mc_top;
5294 MDB_page *mp = mc->mc_pg[i];
5296 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5297 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
5298 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
5299 mdb_xcursor_init1(m2, leaf);
5303 /* we've done our job */
5306 if (flags & MDB_APPENDDUP)
5307 xflags |= MDB_APPEND;
5308 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
5309 if (flags & F_SUBDATA) {
5310 void *db = NODEDATA(leaf);
5311 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5314 /* sub-writes might have failed so check rc again.
5315 * Don't increment count if we just replaced an existing item.
5317 if (!rc && !(flags & MDB_CURRENT))
5318 mc->mc_db->md_entries++;
5319 if (flags & MDB_MULTIPLE) {
5321 if (mcount < data[1].mv_size) {
5322 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
5323 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5329 /* If we succeeded and the key didn't exist before, make sure
5330 * the cursor is marked valid.
5333 mc->mc_flags |= C_INITIALIZED;
5338 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
5343 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
5346 if (!(mc->mc_flags & C_INITIALIZED))
5349 rc = mdb_cursor_touch(mc);
5353 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5355 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5356 if (flags != MDB_NODUPDATA) {
5357 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5358 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
5360 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, 0);
5361 /* If sub-DB still has entries, we're done */
5362 if (mc->mc_xcursor->mx_db.md_entries) {
5363 if (leaf->mn_flags & F_SUBDATA) {
5364 /* update subDB info */
5365 void *db = NODEDATA(leaf);
5366 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5368 /* shrink fake page */
5369 mdb_node_shrink(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5371 mc->mc_db->md_entries--;
5374 /* otherwise fall thru and delete the sub-DB */
5377 if (leaf->mn_flags & F_SUBDATA) {
5378 /* add all the child DB's pages to the free list */
5379 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
5380 if (rc == MDB_SUCCESS) {
5381 mc->mc_db->md_entries -=
5382 mc->mc_xcursor->mx_db.md_entries;
5387 return mdb_cursor_del0(mc, leaf);
5390 /** Allocate and initialize new pages for a database.
5391 * @param[in] mc a cursor on the database being added to.
5392 * @param[in] flags flags defining what type of page is being allocated.
5393 * @param[in] num the number of pages to allocate. This is usually 1,
5394 * unless allocating overflow pages for a large record.
5395 * @param[out] mp Address of a page, or NULL on failure.
5396 * @return 0 on success, non-zero on failure.
5399 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
5404 if ((rc = mdb_page_alloc(mc, num, &np)))
5406 DPRINTF("allocated new mpage %zu, page size %u",
5407 np->mp_pgno, mc->mc_txn->mt_env->me_psize);
5408 np->mp_flags = flags | P_DIRTY;
5409 np->mp_lower = PAGEHDRSZ;
5410 np->mp_upper = mc->mc_txn->mt_env->me_psize;
5413 mc->mc_db->md_branch_pages++;
5414 else if (IS_LEAF(np))
5415 mc->mc_db->md_leaf_pages++;
5416 else if (IS_OVERFLOW(np)) {
5417 mc->mc_db->md_overflow_pages += num;
5425 /** Calculate the size of a leaf node.
5426 * The size depends on the environment's page size; if a data item
5427 * is too large it will be put onto an overflow page and the node
5428 * size will only include the key and not the data. Sizes are always
5429 * rounded up to an even number of bytes, to guarantee 2-byte alignment
5430 * of the #MDB_node headers.
5431 * @param[in] env The environment handle.
5432 * @param[in] key The key for the node.
5433 * @param[in] data The data for the node.
5434 * @return The number of bytes needed to store the node.
5437 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
5441 sz = LEAFSIZE(key, data);
5442 if (sz >= env->me_nodemax) {
5443 /* put on overflow page */
5444 sz -= data->mv_size - sizeof(pgno_t);
5448 return sz + sizeof(indx_t);
5451 /** Calculate the size of a branch node.
5452 * The size should depend on the environment's page size but since
5453 * we currently don't support spilling large keys onto overflow
5454 * pages, it's simply the size of the #MDB_node header plus the
5455 * size of the key. Sizes are always rounded up to an even number
5456 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
5457 * @param[in] env The environment handle.
5458 * @param[in] key The key for the node.
5459 * @return The number of bytes needed to store the node.
5462 mdb_branch_size(MDB_env *env, MDB_val *key)
5467 if (sz >= env->me_nodemax) {
5468 /* put on overflow page */
5469 /* not implemented */
5470 /* sz -= key->size - sizeof(pgno_t); */
5473 return sz + sizeof(indx_t);
5476 /** Add a node to the page pointed to by the cursor.
5477 * @param[in] mc The cursor for this operation.
5478 * @param[in] indx The index on the page where the new node should be added.
5479 * @param[in] key The key for the new node.
5480 * @param[in] data The data for the new node, if any.
5481 * @param[in] pgno The page number, if adding a branch node.
5482 * @param[in] flags Flags for the node.
5483 * @return 0 on success, non-zero on failure. Possible errors are:
5485 * <li>ENOMEM - failed to allocate overflow pages for the node.
5486 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
5487 * should never happen since all callers already calculate the
5488 * page's free space before calling this function.
5492 mdb_node_add(MDB_cursor *mc, indx_t indx,
5493 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
5496 size_t node_size = NODESIZE;
5499 MDB_page *mp = mc->mc_pg[mc->mc_top];
5500 MDB_page *ofp = NULL; /* overflow page */
5503 assert(mp->mp_upper >= mp->mp_lower);
5505 DPRINTF("add to %s %spage %zu index %i, data size %zu key size %zu [%s]",
5506 IS_LEAF(mp) ? "leaf" : "branch",
5507 IS_SUBP(mp) ? "sub-" : "",
5508 mp->mp_pgno, indx, data ? data->mv_size : 0,
5509 key ? key->mv_size : 0, key ? DKEY(key) : NULL);
5512 /* Move higher keys up one slot. */
5513 int ksize = mc->mc_db->md_pad, dif;
5514 char *ptr = LEAF2KEY(mp, indx, ksize);
5515 dif = NUMKEYS(mp) - indx;
5517 memmove(ptr+ksize, ptr, dif*ksize);
5518 /* insert new key */
5519 memcpy(ptr, key->mv_data, ksize);
5521 /* Just using these for counting */
5522 mp->mp_lower += sizeof(indx_t);
5523 mp->mp_upper -= ksize - sizeof(indx_t);
5528 node_size += key->mv_size;
5532 if (F_ISSET(flags, F_BIGDATA)) {
5533 /* Data already on overflow page. */
5534 node_size += sizeof(pgno_t);
5535 } else if (node_size + data->mv_size >= mc->mc_txn->mt_env->me_nodemax) {
5536 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
5538 /* Put data on overflow page. */
5539 DPRINTF("data size is %zu, node would be %zu, put data on overflow page",
5540 data->mv_size, node_size+data->mv_size);
5541 node_size += sizeof(pgno_t);
5542 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
5544 DPRINTF("allocated overflow page %zu", ofp->mp_pgno);
5547 node_size += data->mv_size;
5550 node_size += node_size & 1;
5552 if (node_size + sizeof(indx_t) > SIZELEFT(mp)) {
5553 DPRINTF("not enough room in page %zu, got %u ptrs",
5554 mp->mp_pgno, NUMKEYS(mp));
5555 DPRINTF("upper - lower = %u - %u = %u", mp->mp_upper, mp->mp_lower,
5556 mp->mp_upper - mp->mp_lower);
5557 DPRINTF("node size = %zu", node_size);
5558 return MDB_PAGE_FULL;
5561 /* Move higher pointers up one slot. */
5562 for (i = NUMKEYS(mp); i > indx; i--)
5563 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
5565 /* Adjust free space offsets. */
5566 ofs = mp->mp_upper - node_size;
5567 assert(ofs >= mp->mp_lower + sizeof(indx_t));
5568 mp->mp_ptrs[indx] = ofs;
5570 mp->mp_lower += sizeof(indx_t);
5572 /* Write the node data. */
5573 node = NODEPTR(mp, indx);
5574 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
5575 node->mn_flags = flags;
5577 SETDSZ(node,data->mv_size);
5582 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
5587 if (F_ISSET(flags, F_BIGDATA))
5588 memcpy(node->mn_data + key->mv_size, data->mv_data,
5590 else if (F_ISSET(flags, MDB_RESERVE))
5591 data->mv_data = node->mn_data + key->mv_size;
5593 memcpy(node->mn_data + key->mv_size, data->mv_data,
5596 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
5598 if (F_ISSET(flags, MDB_RESERVE))
5599 data->mv_data = METADATA(ofp);
5601 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
5608 /** Delete the specified node from a page.
5609 * @param[in] mp The page to operate on.
5610 * @param[in] indx The index of the node to delete.
5611 * @param[in] ksize The size of a node. Only used if the page is
5612 * part of a #MDB_DUPFIXED database.
5615 mdb_node_del(MDB_page *mp, indx_t indx, int ksize)
5618 indx_t i, j, numkeys, ptr;
5625 COPY_PGNO(pgno, mp->mp_pgno);
5626 DPRINTF("delete node %u on %s page %zu", indx,
5627 IS_LEAF(mp) ? "leaf" : "branch", pgno);
5630 assert(indx < NUMKEYS(mp));
5633 int x = NUMKEYS(mp) - 1 - indx;
5634 base = LEAF2KEY(mp, indx, ksize);
5636 memmove(base, base + ksize, x * ksize);
5637 mp->mp_lower -= sizeof(indx_t);
5638 mp->mp_upper += ksize - sizeof(indx_t);
5642 node = NODEPTR(mp, indx);
5643 sz = NODESIZE + node->mn_ksize;
5645 if (F_ISSET(node->mn_flags, F_BIGDATA))
5646 sz += sizeof(pgno_t);
5648 sz += NODEDSZ(node);
5652 ptr = mp->mp_ptrs[indx];
5653 numkeys = NUMKEYS(mp);
5654 for (i = j = 0; i < numkeys; i++) {
5656 mp->mp_ptrs[j] = mp->mp_ptrs[i];
5657 if (mp->mp_ptrs[i] < ptr)
5658 mp->mp_ptrs[j] += sz;
5663 base = (char *)mp + mp->mp_upper;
5664 memmove(base + sz, base, ptr - mp->mp_upper);
5666 mp->mp_lower -= sizeof(indx_t);
5670 /** Compact the main page after deleting a node on a subpage.
5671 * @param[in] mp The main page to operate on.
5672 * @param[in] indx The index of the subpage on the main page.
5675 mdb_node_shrink(MDB_page *mp, indx_t indx)
5682 indx_t i, numkeys, ptr;
5684 node = NODEPTR(mp, indx);
5685 sp = (MDB_page *)NODEDATA(node);
5686 osize = NODEDSZ(node);
5688 delta = sp->mp_upper - sp->mp_lower;
5689 SETDSZ(node, osize - delta);
5690 xp = (MDB_page *)((char *)sp + delta);
5692 /* shift subpage upward */
5694 nsize = NUMKEYS(sp) * sp->mp_pad;
5695 memmove(METADATA(xp), METADATA(sp), nsize);
5698 nsize = osize - sp->mp_upper;
5699 numkeys = NUMKEYS(sp);
5700 for (i=numkeys-1; i>=0; i--)
5701 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
5703 xp->mp_upper = sp->mp_lower;
5704 xp->mp_lower = sp->mp_lower;
5705 xp->mp_flags = sp->mp_flags;
5706 xp->mp_pad = sp->mp_pad;
5707 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
5709 /* shift lower nodes upward */
5710 ptr = mp->mp_ptrs[indx];
5711 numkeys = NUMKEYS(mp);
5712 for (i = 0; i < numkeys; i++) {
5713 if (mp->mp_ptrs[i] <= ptr)
5714 mp->mp_ptrs[i] += delta;
5717 base = (char *)mp + mp->mp_upper;
5718 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
5719 mp->mp_upper += delta;
5722 /** Initial setup of a sorted-dups cursor.
5723 * Sorted duplicates are implemented as a sub-database for the given key.
5724 * The duplicate data items are actually keys of the sub-database.
5725 * Operations on the duplicate data items are performed using a sub-cursor
5726 * initialized when the sub-database is first accessed. This function does
5727 * the preliminary setup of the sub-cursor, filling in the fields that
5728 * depend only on the parent DB.
5729 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5732 mdb_xcursor_init0(MDB_cursor *mc)
5734 MDB_xcursor *mx = mc->mc_xcursor;
5736 mx->mx_cursor.mc_xcursor = NULL;
5737 mx->mx_cursor.mc_txn = mc->mc_txn;
5738 mx->mx_cursor.mc_db = &mx->mx_db;
5739 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
5740 mx->mx_cursor.mc_dbi = mc->mc_dbi+1;
5741 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
5742 mx->mx_cursor.mc_snum = 0;
5743 mx->mx_cursor.mc_top = 0;
5744 mx->mx_cursor.mc_flags = C_SUB;
5745 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
5746 mx->mx_dbx.md_dcmp = NULL;
5747 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
5750 /** Final setup of a sorted-dups cursor.
5751 * Sets up the fields that depend on the data from the main cursor.
5752 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5753 * @param[in] node The data containing the #MDB_db record for the
5754 * sorted-dup database.
5757 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
5759 MDB_xcursor *mx = mc->mc_xcursor;
5761 if (node->mn_flags & F_SUBDATA) {
5762 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
5763 mx->mx_cursor.mc_pg[0] = 0;
5764 mx->mx_cursor.mc_snum = 0;
5765 mx->mx_cursor.mc_flags = C_SUB;
5767 MDB_page *fp = NODEDATA(node);
5768 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
5769 mx->mx_db.md_flags = 0;
5770 mx->mx_db.md_depth = 1;
5771 mx->mx_db.md_branch_pages = 0;
5772 mx->mx_db.md_leaf_pages = 1;
5773 mx->mx_db.md_overflow_pages = 0;
5774 mx->mx_db.md_entries = NUMKEYS(fp);
5775 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
5776 mx->mx_cursor.mc_snum = 1;
5777 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
5778 mx->mx_cursor.mc_top = 0;
5779 mx->mx_cursor.mc_pg[0] = fp;
5780 mx->mx_cursor.mc_ki[0] = 0;
5781 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5782 mx->mx_db.md_flags = MDB_DUPFIXED;
5783 mx->mx_db.md_pad = fp->mp_pad;
5784 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5785 mx->mx_db.md_flags |= MDB_INTEGERKEY;
5788 DPRINTF("Sub-db %u for db %u root page %zu", mx->mx_cursor.mc_dbi, mc->mc_dbi,
5790 mx->mx_dbflag = DB_VALID | (F_ISSET(mc->mc_pg[mc->mc_top]->mp_flags, P_DIRTY) ?
5792 mx->mx_dbx.md_name.mv_data = NODEKEY(node);
5793 mx->mx_dbx.md_name.mv_size = node->mn_ksize;
5794 #if UINT_MAX < SIZE_MAX
5795 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
5796 #ifdef MISALIGNED_OK
5797 mx->mx_dbx.md_cmp = mdb_cmp_long;
5799 mx->mx_dbx.md_cmp = mdb_cmp_cint;
5804 /** Initialize a cursor for a given transaction and database. */
5806 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
5811 mc->mc_db = &txn->mt_dbs[dbi];
5812 mc->mc_dbx = &txn->mt_dbxs[dbi];
5813 mc->mc_dbflag = &txn->mt_dbflags[dbi];
5818 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5820 mc->mc_xcursor = mx;
5821 mdb_xcursor_init0(mc);
5823 mc->mc_xcursor = NULL;
5825 if (*mc->mc_dbflag & DB_STALE) {
5826 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
5831 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
5834 MDB_xcursor *mx = NULL;
5835 size_t size = sizeof(MDB_cursor);
5837 if (txn == NULL || ret == NULL || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
5840 /* Allow read access to the freelist */
5841 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
5844 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
5845 size += sizeof(MDB_xcursor);
5847 if ((mc = malloc(size)) != NULL) {
5848 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5849 mx = (MDB_xcursor *)(mc + 1);
5851 mdb_cursor_init(mc, txn, dbi, mx);
5852 if (txn->mt_cursors) {
5853 mc->mc_next = txn->mt_cursors[dbi];
5854 txn->mt_cursors[dbi] = mc;
5856 mc->mc_flags |= C_ALLOCD;
5867 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
5871 if (txn == NULL || mc == NULL || mc->mc_dbi >= txn->mt_numdbs)
5874 if (txn->mt_cursors)
5877 flags = mc->mc_flags;
5879 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
5881 mc->mc_flags |= (flags & C_ALLOCD);
5885 /* Return the count of duplicate data items for the current key */
5887 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
5891 if (mc == NULL || countp == NULL)
5894 if (!(mc->mc_db->md_flags & MDB_DUPSORT))
5897 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5898 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5901 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
5904 *countp = mc->mc_xcursor->mx_db.md_entries;
5910 mdb_cursor_close(MDB_cursor *mc)
5913 /* remove from txn, if tracked */
5914 if (mc->mc_txn->mt_cursors) {
5915 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
5916 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
5918 *prev = mc->mc_next;
5920 if (mc->mc_flags & C_ALLOCD)
5926 mdb_cursor_txn(MDB_cursor *mc)
5928 if (!mc) return NULL;
5933 mdb_cursor_dbi(MDB_cursor *mc)
5939 /** Replace the key for a node with a new key.
5940 * @param[in] mp The page containing the node to operate on.
5941 * @param[in] indx The index of the node to operate on.
5942 * @param[in] key The new key to use.
5943 * @return 0 on success, non-zero on failure.
5946 mdb_update_key(MDB_cursor *mc, MDB_val *key)
5953 indx_t ptr, i, numkeys, indx;
5956 indx = mc->mc_ki[mc->mc_top];
5957 mp = mc->mc_pg[mc->mc_top];
5958 node = NODEPTR(mp, indx);
5959 ptr = mp->mp_ptrs[indx];
5963 char kbuf2[(MDB_MAXKEYSIZE*2+1)];
5964 k2.mv_data = NODEKEY(node);
5965 k2.mv_size = node->mn_ksize;
5966 DPRINTF("update key %u (ofs %u) [%s] to [%s] on page %zu",
5968 mdb_dkey(&k2, kbuf2),
5974 delta0 = delta = key->mv_size - node->mn_ksize;
5976 /* Must be 2-byte aligned. If new key is
5977 * shorter by 1, the shift will be skipped.
5979 delta += (delta & 1);
5981 if (delta > 0 && SIZELEFT(mp) < delta) {
5983 /* not enough space left, do a delete and split */
5984 DPRINTF("Not enough room, delta = %d, splitting...", delta);
5985 pgno = NODEPGNO(node);
5986 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5987 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
5990 numkeys = NUMKEYS(mp);
5991 for (i = 0; i < numkeys; i++) {
5992 if (mp->mp_ptrs[i] <= ptr)
5993 mp->mp_ptrs[i] -= delta;
5996 base = (char *)mp + mp->mp_upper;
5997 len = ptr - mp->mp_upper + NODESIZE;
5998 memmove(base - delta, base, len);
5999 mp->mp_upper -= delta;
6001 node = NODEPTR(mp, indx);
6004 /* But even if no shift was needed, update ksize */
6006 node->mn_ksize = key->mv_size;
6009 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
6015 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
6017 /** Move a node from csrc to cdst.
6020 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
6027 unsigned short flags;
6031 /* Mark src and dst as dirty. */
6032 if ((rc = mdb_page_touch(csrc)) ||
6033 (rc = mdb_page_touch(cdst)))
6036 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6037 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0); /* fake */
6038 key.mv_size = csrc->mc_db->md_pad;
6039 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6041 data.mv_data = NULL;
6045 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
6046 assert(!((long)srcnode&1));
6047 srcpg = NODEPGNO(srcnode);
6048 flags = srcnode->mn_flags;
6049 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6050 unsigned int snum = csrc->mc_snum;
6052 /* must find the lowest key below src */
6053 mdb_page_search_lowest(csrc);
6054 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6055 key.mv_size = csrc->mc_db->md_pad;
6056 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6058 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6059 key.mv_size = NODEKSZ(s2);
6060 key.mv_data = NODEKEY(s2);
6062 csrc->mc_snum = snum--;
6063 csrc->mc_top = snum;
6065 key.mv_size = NODEKSZ(srcnode);
6066 key.mv_data = NODEKEY(srcnode);
6068 data.mv_size = NODEDSZ(srcnode);
6069 data.mv_data = NODEDATA(srcnode);
6071 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
6072 unsigned int snum = cdst->mc_snum;
6075 /* must find the lowest key below dst */
6076 mdb_page_search_lowest(cdst);
6077 if (IS_LEAF2(cdst->mc_pg[cdst->mc_top])) {
6078 bkey.mv_size = cdst->mc_db->md_pad;
6079 bkey.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, bkey.mv_size);
6081 s2 = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6082 bkey.mv_size = NODEKSZ(s2);
6083 bkey.mv_data = NODEKEY(s2);
6085 cdst->mc_snum = snum--;
6086 cdst->mc_top = snum;
6087 mdb_cursor_copy(cdst, &mn);
6089 rc = mdb_update_key(&mn, &bkey);
6094 DPRINTF("moving %s node %u [%s] on page %zu to node %u on page %zu",
6095 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
6096 csrc->mc_ki[csrc->mc_top],
6098 csrc->mc_pg[csrc->mc_top]->mp_pgno,
6099 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno);
6101 /* Add the node to the destination page.
6103 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
6104 if (rc != MDB_SUCCESS)
6107 /* Delete the node from the source page.
6109 mdb_node_del(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6112 /* Adjust other cursors pointing to mp */
6113 MDB_cursor *m2, *m3;
6114 MDB_dbi dbi = csrc->mc_dbi;
6115 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
6117 if (csrc->mc_flags & C_SUB)
6120 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6121 if (m2 == csrc) continue;
6122 if (csrc->mc_flags & C_SUB)
6123 m3 = &m2->mc_xcursor->mx_cursor;
6126 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
6127 csrc->mc_ki[csrc->mc_top]) {
6128 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
6129 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
6134 /* Update the parent separators.
6136 if (csrc->mc_ki[csrc->mc_top] == 0) {
6137 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
6138 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6139 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6141 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6142 key.mv_size = NODEKSZ(srcnode);
6143 key.mv_data = NODEKEY(srcnode);
6145 DPRINTF("update separator for source page %zu to [%s]",
6146 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key));
6147 mdb_cursor_copy(csrc, &mn);
6150 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6153 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6155 indx_t ix = csrc->mc_ki[csrc->mc_top];
6156 nullkey.mv_size = 0;
6157 csrc->mc_ki[csrc->mc_top] = 0;
6158 rc = mdb_update_key(csrc, &nullkey);
6159 csrc->mc_ki[csrc->mc_top] = ix;
6160 assert(rc == MDB_SUCCESS);
6164 if (cdst->mc_ki[cdst->mc_top] == 0) {
6165 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
6166 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6167 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
6169 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6170 key.mv_size = NODEKSZ(srcnode);
6171 key.mv_data = NODEKEY(srcnode);
6173 DPRINTF("update separator for destination page %zu to [%s]",
6174 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key));
6175 mdb_cursor_copy(cdst, &mn);
6178 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6181 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
6183 indx_t ix = cdst->mc_ki[cdst->mc_top];
6184 nullkey.mv_size = 0;
6185 cdst->mc_ki[cdst->mc_top] = 0;
6186 rc = mdb_update_key(cdst, &nullkey);
6187 cdst->mc_ki[cdst->mc_top] = ix;
6188 assert(rc == MDB_SUCCESS);
6195 /** Merge one page into another.
6196 * The nodes from the page pointed to by \b csrc will
6197 * be copied to the page pointed to by \b cdst and then
6198 * the \b csrc page will be freed.
6199 * @param[in] csrc Cursor pointing to the source page.
6200 * @param[in] cdst Cursor pointing to the destination page.
6203 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
6211 DPRINTF("merging page %zu into %zu", csrc->mc_pg[csrc->mc_top]->mp_pgno,
6212 cdst->mc_pg[cdst->mc_top]->mp_pgno);
6214 assert(csrc->mc_snum > 1); /* can't merge root page */
6215 assert(cdst->mc_snum > 1);
6217 /* Mark dst as dirty. */
6218 if ((rc = mdb_page_touch(cdst)))
6221 /* Move all nodes from src to dst.
6223 j = nkeys = NUMKEYS(cdst->mc_pg[cdst->mc_top]);
6224 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6225 key.mv_size = csrc->mc_db->md_pad;
6226 key.mv_data = METADATA(csrc->mc_pg[csrc->mc_top]);
6227 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6228 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
6229 if (rc != MDB_SUCCESS)
6231 key.mv_data = (char *)key.mv_data + key.mv_size;
6234 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6235 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], i);
6236 if (i == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6237 unsigned int snum = csrc->mc_snum;
6239 /* must find the lowest key below src */
6240 mdb_page_search_lowest(csrc);
6241 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6242 key.mv_size = csrc->mc_db->md_pad;
6243 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6245 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6246 key.mv_size = NODEKSZ(s2);
6247 key.mv_data = NODEKEY(s2);
6249 csrc->mc_snum = snum--;
6250 csrc->mc_top = snum;
6252 key.mv_size = srcnode->mn_ksize;
6253 key.mv_data = NODEKEY(srcnode);
6256 data.mv_size = NODEDSZ(srcnode);
6257 data.mv_data = NODEDATA(srcnode);
6258 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
6259 if (rc != MDB_SUCCESS)
6264 DPRINTF("dst page %zu now has %u keys (%.1f%% filled)",
6265 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);
6267 /* Unlink the src page from parent and add to free list.
6269 mdb_node_del(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1], 0);
6270 if (csrc->mc_ki[csrc->mc_top-1] == 0) {
6273 rc = mdb_update_key(csrc, &key);
6279 mdb_midl_append(&csrc->mc_txn->mt_free_pgs, csrc->mc_pg[csrc->mc_top]->mp_pgno);
6280 if (IS_LEAF(csrc->mc_pg[csrc->mc_top]))
6281 csrc->mc_db->md_leaf_pages--;
6283 csrc->mc_db->md_branch_pages--;
6285 /* Adjust other cursors pointing to mp */
6286 MDB_cursor *m2, *m3;
6287 MDB_dbi dbi = csrc->mc_dbi;
6288 MDB_page *mp = cdst->mc_pg[cdst->mc_top];
6290 if (csrc->mc_flags & C_SUB)
6293 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6294 if (csrc->mc_flags & C_SUB)
6295 m3 = &m2->mc_xcursor->mx_cursor;
6298 if (m3 == csrc) continue;
6299 if (m3->mc_snum < csrc->mc_snum) continue;
6300 if (m3->mc_pg[csrc->mc_top] == csrc->mc_pg[csrc->mc_top]) {
6301 m3->mc_pg[csrc->mc_top] = mp;
6302 m3->mc_ki[csrc->mc_top] += nkeys;
6306 mdb_cursor_pop(csrc);
6308 return mdb_rebalance(csrc);
6311 /** Copy the contents of a cursor.
6312 * @param[in] csrc The cursor to copy from.
6313 * @param[out] cdst The cursor to copy to.
6316 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
6320 cdst->mc_txn = csrc->mc_txn;
6321 cdst->mc_dbi = csrc->mc_dbi;
6322 cdst->mc_db = csrc->mc_db;
6323 cdst->mc_dbx = csrc->mc_dbx;
6324 cdst->mc_snum = csrc->mc_snum;
6325 cdst->mc_top = csrc->mc_top;
6326 cdst->mc_flags = csrc->mc_flags;
6328 for (i=0; i<csrc->mc_snum; i++) {
6329 cdst->mc_pg[i] = csrc->mc_pg[i];
6330 cdst->mc_ki[i] = csrc->mc_ki[i];
6334 /** Rebalance the tree after a delete operation.
6335 * @param[in] mc Cursor pointing to the page where rebalancing
6337 * @return 0 on success, non-zero on failure.
6340 mdb_rebalance(MDB_cursor *mc)
6344 unsigned int ptop, minkeys;
6347 minkeys = 1 + (IS_BRANCH(mc->mc_pg[mc->mc_top]));
6351 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6352 DPRINTF("rebalancing %s page %zu (has %u keys, %.1f%% full)",
6353 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
6354 pgno, NUMKEYS(mc->mc_pg[mc->mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10);
6358 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD &&
6359 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
6362 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6363 DPRINTF("no need to rebalance page %zu, above fill threshold",
6369 if (mc->mc_snum < 2) {
6370 MDB_page *mp = mc->mc_pg[0];
6372 DPUTS("Can't rebalance a subpage, ignoring");
6375 if (NUMKEYS(mp) == 0) {
6376 DPUTS("tree is completely empty");
6377 mc->mc_db->md_root = P_INVALID;
6378 mc->mc_db->md_depth = 0;
6379 mc->mc_db->md_leaf_pages = 0;
6380 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6384 /* Adjust other cursors pointing to mp */
6385 MDB_cursor *m2, *m3;
6386 MDB_dbi dbi = mc->mc_dbi;
6388 if (mc->mc_flags & C_SUB)
6391 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6392 if (m2 == mc) continue;
6393 if (mc->mc_flags & C_SUB)
6394 m3 = &m2->mc_xcursor->mx_cursor;
6397 if (m3->mc_snum < mc->mc_snum) continue;
6398 if (m3->mc_pg[0] == mp) {
6404 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
6405 DPUTS("collapsing root page!");
6406 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6407 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
6408 if ((rc = mdb_page_get(mc->mc_txn, mc->mc_db->md_root,
6411 mc->mc_db->md_depth--;
6412 mc->mc_db->md_branch_pages--;
6414 /* Adjust other cursors pointing to mp */
6415 MDB_cursor *m2, *m3;
6416 MDB_dbi dbi = mc->mc_dbi;
6418 if (mc->mc_flags & C_SUB)
6421 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6422 if (m2 == mc) continue;
6423 if (mc->mc_flags & C_SUB)
6424 m3 = &m2->mc_xcursor->mx_cursor;
6427 if (m3->mc_snum < mc->mc_snum) continue;
6428 if (m3->mc_pg[0] == mp) {
6429 m3->mc_pg[0] = mc->mc_pg[0];
6436 DPUTS("root page doesn't need rebalancing");
6440 /* The parent (branch page) must have at least 2 pointers,
6441 * otherwise the tree is invalid.
6443 ptop = mc->mc_top-1;
6444 assert(NUMKEYS(mc->mc_pg[ptop]) > 1);
6446 /* Leaf page fill factor is below the threshold.
6447 * Try to move keys from left or right neighbor, or
6448 * merge with a neighbor page.
6453 mdb_cursor_copy(mc, &mn);
6454 mn.mc_xcursor = NULL;
6456 if (mc->mc_ki[ptop] == 0) {
6457 /* We're the leftmost leaf in our parent.
6459 DPUTS("reading right neighbor");
6461 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6462 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
6464 mn.mc_ki[mn.mc_top] = 0;
6465 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
6467 /* There is at least one neighbor to the left.
6469 DPUTS("reading left neighbor");
6471 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6472 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
6474 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
6475 mc->mc_ki[mc->mc_top] = 0;
6478 DPRINTF("found neighbor page %zu (%u keys, %.1f%% full)",
6479 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);
6481 /* If the neighbor page is above threshold and has enough keys,
6482 * move one key from it. Otherwise we should try to merge them.
6483 * (A branch page must never have less than 2 keys.)
6485 minkeys = 1 + (IS_BRANCH(mn.mc_pg[mn.mc_top]));
6486 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys)
6487 return mdb_node_move(&mn, mc);
6489 if (mc->mc_ki[ptop] == 0)
6490 rc = mdb_page_merge(&mn, mc);
6492 rc = mdb_page_merge(mc, &mn);
6493 mc->mc_flags &= ~C_INITIALIZED;
6498 /** Complete a delete operation started by #mdb_cursor_del(). */
6500 mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf)
6504 /* add overflow pages to free list */
6505 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6509 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6510 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
6511 mc->mc_db->md_overflow_pages -= ovpages;
6512 for (i=0; i<ovpages; i++) {
6513 DPRINTF("freed ov page %zu", pg);
6514 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
6518 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], mc->mc_db->md_pad);
6519 mc->mc_db->md_entries--;
6520 rc = mdb_rebalance(mc);
6521 if (rc != MDB_SUCCESS)
6522 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6523 /* if mc points past last node in page, invalidate */
6524 else if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6525 mc->mc_flags &= ~C_INITIALIZED;
6531 mdb_del(MDB_txn *txn, MDB_dbi dbi,
6532 MDB_val *key, MDB_val *data)
6537 MDB_val rdata, *xdata;
6541 assert(key != NULL);
6543 DPRINTF("====> delete db %u key [%s]", dbi, DKEY(key));
6545 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
6548 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
6552 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
6556 mdb_cursor_init(&mc, txn, dbi, &mx);
6567 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
6569 /* let mdb_page_split know about this cursor if needed:
6570 * delete will trigger a rebalance; if it needs to move
6571 * a node from one page to another, it will have to
6572 * update the parent's separator key(s). If the new sepkey
6573 * is larger than the current one, the parent page may
6574 * run out of space, triggering a split. We need this
6575 * cursor to be consistent until the end of the rebalance.
6577 mc.mc_next = txn->mt_cursors[dbi];
6578 txn->mt_cursors[dbi] = &mc;
6579 rc = mdb_cursor_del(&mc, data ? 0 : MDB_NODUPDATA);
6580 txn->mt_cursors[dbi] = mc.mc_next;
6585 /** Split a page and insert a new node.
6586 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
6587 * The cursor will be updated to point to the actual page and index where
6588 * the node got inserted after the split.
6589 * @param[in] newkey The key for the newly inserted node.
6590 * @param[in] newdata The data for the newly inserted node.
6591 * @param[in] newpgno The page number, if the new node is a branch node.
6592 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
6593 * @return 0 on success, non-zero on failure.
6596 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
6597 unsigned int nflags)
6600 int rc = MDB_SUCCESS, ins_new = 0, new_root = 0, newpos = 1, did_split = 0;
6603 unsigned int i, j, split_indx, nkeys, pmax;
6605 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
6607 MDB_page *mp, *rp, *pp;
6612 mp = mc->mc_pg[mc->mc_top];
6613 newindx = mc->mc_ki[mc->mc_top];
6615 DPRINTF("-----> splitting %s page %zu and adding [%s] at index %i",
6616 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
6617 DKEY(newkey), mc->mc_ki[mc->mc_top]);
6619 /* Create a right sibling. */
6620 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
6622 DPRINTF("new right sibling: page %zu", rp->mp_pgno);
6624 if (mc->mc_snum < 2) {
6625 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
6627 /* shift current top to make room for new parent */
6628 mc->mc_pg[1] = mc->mc_pg[0];
6629 mc->mc_ki[1] = mc->mc_ki[0];
6632 mc->mc_db->md_root = pp->mp_pgno;
6633 DPRINTF("root split! new root = %zu", pp->mp_pgno);
6634 mc->mc_db->md_depth++;
6637 /* Add left (implicit) pointer. */
6638 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
6639 /* undo the pre-push */
6640 mc->mc_pg[0] = mc->mc_pg[1];
6641 mc->mc_ki[0] = mc->mc_ki[1];
6642 mc->mc_db->md_root = mp->mp_pgno;
6643 mc->mc_db->md_depth--;
6650 ptop = mc->mc_top-1;
6651 DPRINTF("parent branch page is %zu", mc->mc_pg[ptop]->mp_pgno);
6654 mc->mc_flags |= C_SPLITTING;
6655 mdb_cursor_copy(mc, &mn);
6656 mn.mc_pg[mn.mc_top] = rp;
6657 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
6659 if (nflags & MDB_APPEND) {
6660 mn.mc_ki[mn.mc_top] = 0;
6662 split_indx = newindx;
6667 nkeys = NUMKEYS(mp);
6668 split_indx = nkeys / 2;
6669 if (newindx < split_indx)
6675 unsigned int lsize, rsize, ksize;
6676 /* Move half of the keys to the right sibling */
6678 x = mc->mc_ki[mc->mc_top] - split_indx;
6679 ksize = mc->mc_db->md_pad;
6680 split = LEAF2KEY(mp, split_indx, ksize);
6681 rsize = (nkeys - split_indx) * ksize;
6682 lsize = (nkeys - split_indx) * sizeof(indx_t);
6683 mp->mp_lower -= lsize;
6684 rp->mp_lower += lsize;
6685 mp->mp_upper += rsize - lsize;
6686 rp->mp_upper -= rsize - lsize;
6687 sepkey.mv_size = ksize;
6688 if (newindx == split_indx) {
6689 sepkey.mv_data = newkey->mv_data;
6691 sepkey.mv_data = split;
6694 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
6695 memcpy(rp->mp_ptrs, split, rsize);
6696 sepkey.mv_data = rp->mp_ptrs;
6697 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
6698 memcpy(ins, newkey->mv_data, ksize);
6699 mp->mp_lower += sizeof(indx_t);
6700 mp->mp_upper -= ksize - sizeof(indx_t);
6703 memcpy(rp->mp_ptrs, split, x * ksize);
6704 ins = LEAF2KEY(rp, x, ksize);
6705 memcpy(ins, newkey->mv_data, ksize);
6706 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
6707 rp->mp_lower += sizeof(indx_t);
6708 rp->mp_upper -= ksize - sizeof(indx_t);
6709 mc->mc_ki[mc->mc_top] = x;
6710 mc->mc_pg[mc->mc_top] = rp;
6715 /* For leaf pages, check the split point based on what
6716 * fits where, since otherwise mdb_node_add can fail.
6718 * This check is only needed when the data items are
6719 * relatively large, such that being off by one will
6720 * make the difference between success or failure.
6722 * It's also relevant if a page happens to be laid out
6723 * such that one half of its nodes are all "small" and
6724 * the other half of its nodes are "large." If the new
6725 * item is also "large" and falls on the half with
6726 * "large" nodes, it also may not fit.
6729 unsigned int psize, nsize;
6730 /* Maximum free space in an empty page */
6731 pmax = mc->mc_txn->mt_env->me_psize - PAGEHDRSZ;
6732 nsize = mdb_leaf_size(mc->mc_txn->mt_env, newkey, newdata);
6733 if ((nkeys < 20) || (nsize > pmax/16)) {
6734 if (newindx <= split_indx) {
6737 for (i=0; i<split_indx; i++) {
6738 node = NODEPTR(mp, i);
6739 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6740 if (F_ISSET(node->mn_flags, F_BIGDATA))
6741 psize += sizeof(pgno_t);
6743 psize += NODEDSZ(node);
6747 split_indx = newindx;
6758 for (i=nkeys-1; i>=split_indx; i--) {
6759 node = NODEPTR(mp, i);
6760 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6761 if (F_ISSET(node->mn_flags, F_BIGDATA))
6762 psize += sizeof(pgno_t);
6764 psize += NODEDSZ(node);
6768 split_indx = newindx;
6779 /* First find the separating key between the split pages.
6780 * The case where newindx == split_indx is ambiguous; the
6781 * new item could go to the new page or stay on the original
6782 * page. If newpos == 1 it goes to the new page.
6784 if (newindx == split_indx && newpos) {
6785 sepkey.mv_size = newkey->mv_size;
6786 sepkey.mv_data = newkey->mv_data;
6788 node = NODEPTR(mp, split_indx);
6789 sepkey.mv_size = node->mn_ksize;
6790 sepkey.mv_data = NODEKEY(node);
6794 DPRINTF("separator is [%s]", DKEY(&sepkey));
6796 /* Copy separator key to the parent.
6798 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(mc->mc_txn->mt_env, &sepkey)) {
6802 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
6805 if (mn.mc_snum == mc->mc_snum) {
6806 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
6807 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
6808 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
6809 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
6814 /* Right page might now have changed parent.
6815 * Check if left page also changed parent.
6817 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
6818 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
6819 for (i=0; i<ptop; i++) {
6820 mc->mc_pg[i] = mn.mc_pg[i];
6821 mc->mc_ki[i] = mn.mc_ki[i];
6823 mc->mc_pg[ptop] = mn.mc_pg[ptop];
6824 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
6828 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
6831 mc->mc_flags ^= C_SPLITTING;
6832 if (rc != MDB_SUCCESS) {
6835 if (nflags & MDB_APPEND) {
6836 mc->mc_pg[mc->mc_top] = rp;
6837 mc->mc_ki[mc->mc_top] = 0;
6838 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
6841 for (i=0; i<mc->mc_top; i++)
6842 mc->mc_ki[i] = mn.mc_ki[i];
6849 /* Move half of the keys to the right sibling. */
6851 /* grab a page to hold a temporary copy */
6852 copy = mdb_page_malloc(mc);
6856 copy->mp_pgno = mp->mp_pgno;
6857 copy->mp_flags = mp->mp_flags;
6858 copy->mp_lower = PAGEHDRSZ;
6859 copy->mp_upper = mc->mc_txn->mt_env->me_psize;
6860 mc->mc_pg[mc->mc_top] = copy;
6861 for (i = j = 0; i <= nkeys; j++) {
6862 if (i == split_indx) {
6863 /* Insert in right sibling. */
6864 /* Reset insert index for right sibling. */
6865 if (i != newindx || (newpos ^ ins_new)) {
6867 mc->mc_pg[mc->mc_top] = rp;
6871 if (i == newindx && !ins_new) {
6872 /* Insert the original entry that caused the split. */
6873 rkey.mv_data = newkey->mv_data;
6874 rkey.mv_size = newkey->mv_size;
6883 /* Update index for the new key. */
6884 mc->mc_ki[mc->mc_top] = j;
6885 } else if (i == nkeys) {
6888 node = NODEPTR(mp, i);
6889 rkey.mv_data = NODEKEY(node);
6890 rkey.mv_size = node->mn_ksize;
6892 xdata.mv_data = NODEDATA(node);
6893 xdata.mv_size = NODEDSZ(node);
6896 pgno = NODEPGNO(node);
6897 flags = node->mn_flags;
6902 if (!IS_LEAF(mp) && j == 0) {
6903 /* First branch index doesn't need key data. */
6907 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
6911 nkeys = NUMKEYS(copy);
6912 for (i=0; i<nkeys; i++)
6913 mp->mp_ptrs[i] = copy->mp_ptrs[i];
6914 mp->mp_lower = copy->mp_lower;
6915 mp->mp_upper = copy->mp_upper;
6916 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
6917 mc->mc_txn->mt_env->me_psize - copy->mp_upper);
6919 /* reset back to original page */
6920 if (newindx < split_indx || (!newpos && newindx == split_indx)) {
6921 mc->mc_pg[mc->mc_top] = mp;
6922 if (nflags & MDB_RESERVE) {
6923 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6924 if (!(node->mn_flags & F_BIGDATA))
6925 newdata->mv_data = NODEDATA(node);
6931 /* return tmp page to freelist */
6932 mdb_page_free(mc->mc_txn->mt_env, copy);
6935 /* Adjust other cursors pointing to mp */
6936 MDB_cursor *m2, *m3;
6937 MDB_dbi dbi = mc->mc_dbi;
6938 int fixup = NUMKEYS(mp);
6940 if (mc->mc_flags & C_SUB)
6943 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6944 if (m2 == mc) continue;
6945 if (mc->mc_flags & C_SUB)
6946 m3 = &m2->mc_xcursor->mx_cursor;
6949 if (!(m3->mc_flags & C_INITIALIZED))
6951 if (m3->mc_flags & C_SPLITTING)
6956 for (k=m3->mc_top; k>=0; k--) {
6957 m3->mc_ki[k+1] = m3->mc_ki[k];
6958 m3->mc_pg[k+1] = m3->mc_pg[k];
6960 if (m3->mc_ki[0] >= split_indx) {
6965 m3->mc_pg[0] = mc->mc_pg[0];
6969 if (m3->mc_pg[mc->mc_top] == mp) {
6970 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
6971 m3->mc_ki[mc->mc_top]++;
6972 if (m3->mc_ki[mc->mc_top] >= fixup) {
6973 m3->mc_pg[mc->mc_top] = rp;
6974 m3->mc_ki[mc->mc_top] -= fixup;
6975 m3->mc_ki[ptop] = mn.mc_ki[ptop];
6977 } else if (!did_split && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
6978 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
6987 mdb_put(MDB_txn *txn, MDB_dbi dbi,
6988 MDB_val *key, MDB_val *data, unsigned int flags)
6993 assert(key != NULL);
6994 assert(data != NULL);
6996 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
6999 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
7003 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
7007 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP)) != flags)
7010 mdb_cursor_init(&mc, txn, dbi, &mx);
7011 return mdb_cursor_put(&mc, key, data, flags);
7015 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
7017 if ((flag & CHANGEABLE) != flag)
7020 env->me_flags |= flag;
7022 env->me_flags &= ~flag;
7027 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
7032 *arg = env->me_flags;
7037 mdb_env_get_path(MDB_env *env, const char **arg)
7042 *arg = env->me_path;
7046 /** Common code for #mdb_stat() and #mdb_env_stat().
7047 * @param[in] env the environment to operate in.
7048 * @param[in] db the #MDB_db record containing the stats to return.
7049 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
7050 * @return 0, this function always succeeds.
7053 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
7055 arg->ms_psize = env->me_psize;
7056 arg->ms_depth = db->md_depth;
7057 arg->ms_branch_pages = db->md_branch_pages;
7058 arg->ms_leaf_pages = db->md_leaf_pages;
7059 arg->ms_overflow_pages = db->md_overflow_pages;
7060 arg->ms_entries = db->md_entries;
7065 mdb_env_stat(MDB_env *env, MDB_stat *arg)
7069 if (env == NULL || arg == NULL)
7072 toggle = mdb_env_pick_meta(env);
7074 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
7078 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
7082 if (env == NULL || arg == NULL)
7085 toggle = mdb_env_pick_meta(env);
7086 arg->me_mapaddr = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : 0;
7087 arg->me_mapsize = env->me_mapsize;
7088 arg->me_maxreaders = env->me_maxreaders;
7089 arg->me_numreaders = env->me_numreaders;
7090 arg->me_last_pgno = env->me_metas[toggle]->mm_last_pg;
7091 arg->me_last_txnid = env->me_metas[toggle]->mm_txnid;
7095 /** Set the default comparison functions for a database.
7096 * Called immediately after a database is opened to set the defaults.
7097 * The user can then override them with #mdb_set_compare() or
7098 * #mdb_set_dupsort().
7099 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
7100 * @param[in] dbi A database handle returned by #mdb_dbi_open()
7103 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
7105 uint16_t f = txn->mt_dbs[dbi].md_flags;
7107 txn->mt_dbxs[dbi].md_cmp =
7108 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
7109 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
7111 txn->mt_dbxs[dbi].md_dcmp =
7112 !(f & MDB_DUPSORT) ? 0 :
7113 ((f & MDB_INTEGERDUP)
7114 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
7115 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
7118 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
7123 int rc, dbflag, exact;
7124 unsigned int unused = 0;
7127 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
7128 mdb_default_cmp(txn, FREE_DBI);
7131 if ((flags & VALID_FLAGS) != flags)
7137 if (flags & PERSISTENT_FLAGS) {
7138 uint16_t f2 = flags & PERSISTENT_FLAGS;
7139 /* make sure flag changes get committed */
7140 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
7141 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
7142 txn->mt_flags |= MDB_TXN_DIRTY;
7145 mdb_default_cmp(txn, MAIN_DBI);
7149 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
7150 mdb_default_cmp(txn, MAIN_DBI);
7153 /* Is the DB already open? */
7155 for (i=2; i<txn->mt_numdbs; i++) {
7156 if (!txn->mt_dbxs[i].md_name.mv_size) {
7157 /* Remember this free slot */
7158 if (!unused) unused = i;
7161 if (len == txn->mt_dbxs[i].md_name.mv_size &&
7162 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
7168 /* If no free slot and max hit, fail */
7169 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
7170 return MDB_DBS_FULL;
7172 /* Find the DB info */
7173 dbflag = DB_NEW|DB_VALID;
7176 key.mv_data = (void *)name;
7177 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
7178 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
7179 if (rc == MDB_SUCCESS) {
7180 /* make sure this is actually a DB */
7181 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
7182 if (!(node->mn_flags & F_SUBDATA))
7184 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
7185 /* Create if requested */
7187 data.mv_size = sizeof(MDB_db);
7188 data.mv_data = &dummy;
7189 memset(&dummy, 0, sizeof(dummy));
7190 dummy.md_root = P_INVALID;
7191 dummy.md_flags = flags & PERSISTENT_FLAGS;
7192 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
7196 /* OK, got info, add to table */
7197 if (rc == MDB_SUCCESS) {
7198 unsigned int slot = unused ? unused : txn->mt_numdbs;
7199 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
7200 txn->mt_dbxs[slot].md_name.mv_size = len;
7201 txn->mt_dbxs[slot].md_rel = NULL;
7202 txn->mt_dbflags[slot] = dbflag;
7203 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
7205 txn->mt_env->me_dbflags[slot] = txn->mt_dbs[slot].md_flags;
7206 mdb_default_cmp(txn, slot);
7215 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
7217 if (txn == NULL || arg == NULL || dbi >= txn->mt_numdbs)
7220 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
7223 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
7226 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
7228 ptr = env->me_dbxs[dbi].md_name.mv_data;
7229 env->me_dbxs[dbi].md_name.mv_data = NULL;
7230 env->me_dbxs[dbi].md_name.mv_size = 0;
7231 env->me_dbflags[dbi] = 0;
7235 /** Add all the DB's pages to the free list.
7236 * @param[in] mc Cursor on the DB to free.
7237 * @param[in] subs non-Zero to check for sub-DBs in this DB.
7238 * @return 0 on success, non-zero on failure.
7241 mdb_drop0(MDB_cursor *mc, int subs)
7245 rc = mdb_page_search(mc, NULL, 0);
7246 if (rc == MDB_SUCCESS) {
7251 /* LEAF2 pages have no nodes, cannot have sub-DBs */
7252 if (IS_LEAF2(mc->mc_pg[mc->mc_top]))
7255 mdb_cursor_copy(mc, &mx);
7256 while (mc->mc_snum > 0) {
7257 if (IS_LEAF(mc->mc_pg[mc->mc_top])) {
7258 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
7259 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
7260 if (ni->mn_flags & F_BIGDATA) {
7261 int j, ovpages = OVPAGES(NODEDSZ(ni), mc->mc_txn->mt_env->me_psize);
7263 memcpy(&pg, NODEDATA(ni), sizeof(pg));
7264 for (j=0; j<ovpages; j++) {
7265 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
7268 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
7269 mdb_xcursor_init1(mc, ni);
7270 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
7276 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
7278 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
7281 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
7286 mc->mc_ki[mc->mc_top] = i;
7287 rc = mdb_cursor_sibling(mc, 1);
7289 /* no more siblings, go back to beginning
7290 * of previous level.
7294 for (i=1; i<mc->mc_snum; i++) {
7296 mc->mc_pg[i] = mx.mc_pg[i];
7301 mdb_midl_append(&mc->mc_txn->mt_free_pgs,
7302 mc->mc_db->md_root);
7307 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
7312 if (!txn || !dbi || dbi >= txn->mt_numdbs || (unsigned)del > 1 || !(txn->mt_dbflags[dbi] & DB_VALID))
7315 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
7318 rc = mdb_cursor_open(txn, dbi, &mc);
7322 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
7326 /* Can't delete the main DB */
7327 if (del && dbi > MAIN_DBI) {
7328 rc = mdb_del(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL);
7330 txn->mt_dbflags[dbi] = DB_STALE;
7331 mdb_dbi_close(txn->mt_env, dbi);
7334 /* reset the DB record, mark it dirty */
7335 txn->mt_dbflags[dbi] |= DB_DIRTY;
7336 txn->mt_dbs[dbi].md_depth = 0;
7337 txn->mt_dbs[dbi].md_branch_pages = 0;
7338 txn->mt_dbs[dbi].md_leaf_pages = 0;
7339 txn->mt_dbs[dbi].md_overflow_pages = 0;
7340 txn->mt_dbs[dbi].md_entries = 0;
7341 txn->mt_dbs[dbi].md_root = P_INVALID;
7343 txn->mt_flags |= MDB_TXN_DIRTY;
7346 mdb_cursor_close(mc);
7350 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7352 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7355 txn->mt_dbxs[dbi].md_cmp = cmp;
7359 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7361 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7364 txn->mt_dbxs[dbi].md_dcmp = cmp;
7368 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
7370 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7373 txn->mt_dbxs[dbi].md_rel = rel;
7377 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
7379 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7382 txn->mt_dbxs[dbi].md_relctx = ctx;
projects / openldap / blob