2 * @brief memory-mapped database library
4 * A Btree-based database management library modeled loosely on the
5 * BerkeleyDB API, but much simplified.
8 * Copyright 2011-2013 Howard Chu, Symas Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted only as authorized by the OpenLDAP
15 * A copy of this license is available in the file LICENSE in the
16 * top-level directory of the distribution or, alternatively, at
17 * <http://www.OpenLDAP.org/license.html>.
19 * This code is derived from btree.c written by Martin Hedenfalk.
21 * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
23 * Permission to use, copy, modify, and distribute this software for any
24 * purpose with or without fee is hereby granted, provided that the above
25 * copyright notice and this permission notice appear in all copies.
27 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
28 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
29 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
30 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
31 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
32 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
33 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
38 #include <sys/types.h>
40 #include <sys/param.h>
46 #ifdef HAVE_SYS_FILE_H
63 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
64 #include <netinet/in.h>
65 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
68 #if defined(__APPLE__) || defined (BSD)
69 # define MDB_USE_POSIX_SEM 1
70 # define MDB_FDATASYNC fsync
71 #elif defined(ANDROID)
72 # define MDB_FDATASYNC fsync
77 #ifdef MDB_USE_POSIX_SEM
78 #include <semaphore.h>
83 #include <valgrind/memcheck.h>
84 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
85 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
86 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
87 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
88 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
90 #define VGMEMP_CREATE(h,r,z)
91 #define VGMEMP_ALLOC(h,a,s)
92 #define VGMEMP_FREE(h,a)
93 #define VGMEMP_DESTROY(h)
94 #define VGMEMP_DEFINED(a,s)
98 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
99 /* Solaris just defines one or the other */
100 # define LITTLE_ENDIAN 1234
101 # define BIG_ENDIAN 4321
102 # ifdef _LITTLE_ENDIAN
103 # define BYTE_ORDER LITTLE_ENDIAN
105 # define BYTE_ORDER BIG_ENDIAN
108 # define BYTE_ORDER __BYTE_ORDER
112 #ifndef LITTLE_ENDIAN
113 #define LITTLE_ENDIAN __LITTLE_ENDIAN
116 #define BIG_ENDIAN __BIG_ENDIAN
119 #if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
120 #define MISALIGNED_OK 1
126 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
127 # error "Unknown or unsupported endianness (BYTE_ORDER)"
128 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
129 # error "Two's complement, reasonably sized integer types, please"
132 /** @defgroup internal MDB Internals
135 /** @defgroup compat Windows Compatibility Macros
136 * A bunch of macros to minimize the amount of platform-specific ifdefs
137 * needed throughout the rest of the code. When the features this library
138 * needs are similar enough to POSIX to be hidden in a one-or-two line
139 * replacement, this macro approach is used.
143 #define pthread_t DWORD
144 #define pthread_mutex_t HANDLE
145 #define pthread_key_t DWORD
146 #define pthread_self() GetCurrentThreadId()
147 #define pthread_key_create(x,y) \
148 ((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
149 #define pthread_key_delete(x) TlsFree(x)
150 #define pthread_getspecific(x) TlsGetValue(x)
151 #define pthread_setspecific(x,y) (TlsSetValue(x,y) ? 0 : ErrCode())
152 #define pthread_mutex_unlock(x) ReleaseMutex(x)
153 #define pthread_mutex_lock(x) WaitForSingleObject(x, INFINITE)
154 #define LOCK_MUTEX_R(env) pthread_mutex_lock((env)->me_rmutex)
155 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock((env)->me_rmutex)
156 #define LOCK_MUTEX_W(env) pthread_mutex_lock((env)->me_wmutex)
157 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock((env)->me_wmutex)
158 #define getpid() GetCurrentProcessId()
159 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
160 #define MDB_MSYNC(addr,len,flags) (!FlushViewOfFile(addr,len))
161 #define ErrCode() GetLastError()
162 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
163 #define close(fd) (CloseHandle(fd) ? 0 : -1)
164 #define munmap(ptr,len) UnmapViewOfFile(ptr)
167 #ifdef MDB_USE_POSIX_SEM
169 #define LOCK_MUTEX_R(env) mdb_sem_wait((env)->me_rmutex)
170 #define UNLOCK_MUTEX_R(env) sem_post((env)->me_rmutex)
171 #define LOCK_MUTEX_W(env) mdb_sem_wait((env)->me_wmutex)
172 #define UNLOCK_MUTEX_W(env) sem_post((env)->me_wmutex)
175 mdb_sem_wait(sem_t *sem)
178 while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
183 /** Lock the reader mutex.
185 #define LOCK_MUTEX_R(env) pthread_mutex_lock(&(env)->me_txns->mti_mutex)
186 /** Unlock the reader mutex.
188 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
190 /** Lock the writer mutex.
191 * Only a single write transaction is allowed at a time. Other writers
192 * will block waiting for this mutex.
194 #define LOCK_MUTEX_W(env) pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
195 /** Unlock the writer mutex.
197 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
198 #endif /* MDB_USE_POSIX_SEM */
200 /** Get the error code for the last failed system function.
202 #define ErrCode() errno
204 /** An abstraction for a file handle.
205 * On POSIX systems file handles are small integers. On Windows
206 * they're opaque pointers.
210 /** A value for an invalid file handle.
211 * Mainly used to initialize file variables and signify that they are
214 #define INVALID_HANDLE_VALUE (-1)
216 /** Get the size of a memory page for the system.
217 * This is the basic size that the platform's memory manager uses, and is
218 * fundamental to the use of memory-mapped files.
220 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
223 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
226 #define MNAME_LEN (sizeof(pthread_mutex_t))
232 /** A flag for opening a file and requesting synchronous data writes.
233 * This is only used when writing a meta page. It's not strictly needed;
234 * we could just do a normal write and then immediately perform a flush.
235 * But if this flag is available it saves us an extra system call.
237 * @note If O_DSYNC is undefined but exists in /usr/include,
238 * preferably set some compiler flag to get the definition.
239 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
242 # define MDB_DSYNC O_DSYNC
246 /** Function for flushing the data of a file. Define this to fsync
247 * if fdatasync() is not supported.
249 #ifndef MDB_FDATASYNC
250 # define MDB_FDATASYNC fdatasync
254 # define MDB_MSYNC(addr,len,flags) msync(addr,len,flags)
265 /** A page number in the database.
266 * Note that 64 bit page numbers are overkill, since pages themselves
267 * already represent 12-13 bits of addressable memory, and the OS will
268 * always limit applications to a maximum of 63 bits of address space.
270 * @note In the #MDB_node structure, we only store 48 bits of this value,
271 * which thus limits us to only 60 bits of addressable data.
273 typedef MDB_ID pgno_t;
275 /** A transaction ID.
276 * See struct MDB_txn.mt_txnid for details.
278 typedef MDB_ID txnid_t;
280 /** @defgroup debug Debug Macros
284 /** Enable debug output.
285 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
286 * read from and written to the database (used for free space management).
291 #if !(__STDC_VERSION__ >= 199901L || defined(__GNUC__))
294 # define DPRINTF (void) /* Vararg macros may be unsupported */
296 static int mdb_debug;
297 static txnid_t mdb_debug_start;
299 /** Print a debug message with printf formatting. */
300 # define DPRINTF(fmt, ...) /**< Requires 2 or more args */ \
301 ((void) ((mdb_debug) && \
302 fprintf(stderr, "%s:%d " fmt "\n", __func__, __LINE__, __VA_ARGS__)))
304 # define DPRINTF(fmt, ...) ((void) 0)
305 # define MDB_DEBUG_SKIP
307 /** Print a debug string.
308 * The string is printed literally, with no format processing.
310 #define DPUTS(arg) DPRINTF("%s", arg)
313 /** A default memory page size.
314 * The actual size is platform-dependent, but we use this for
315 * boot-strapping. We probably should not be using this any more.
316 * The #GET_PAGESIZE() macro is used to get the actual size.
318 * Note that we don't currently support Huge pages. On Linux,
319 * regular data files cannot use Huge pages, and in general
320 * Huge pages aren't actually pageable. We rely on the OS
321 * demand-pager to read our data and page it out when memory
322 * pressure from other processes is high. So until OSs have
323 * actual paging support for Huge pages, they're not viable.
325 #define MDB_PAGESIZE 4096
327 /** The minimum number of keys required in a database page.
328 * Setting this to a larger value will place a smaller bound on the
329 * maximum size of a data item. Data items larger than this size will
330 * be pushed into overflow pages instead of being stored directly in
331 * the B-tree node. This value used to default to 4. With a page size
332 * of 4096 bytes that meant that any item larger than 1024 bytes would
333 * go into an overflow page. That also meant that on average 2-3KB of
334 * each overflow page was wasted space. The value cannot be lower than
335 * 2 because then there would no longer be a tree structure. With this
336 * value, items larger than 2KB will go into overflow pages, and on
337 * average only 1KB will be wasted.
339 #define MDB_MINKEYS 2
341 /** A stamp that identifies a file as an MDB file.
342 * There's nothing special about this value other than that it is easily
343 * recognizable, and it will reflect any byte order mismatches.
345 #define MDB_MAGIC 0xBEEFC0DE
347 /** The version number for a database's file format. */
348 #define MDB_VERSION 1
350 /** @brief The maximum size of a key in the database.
352 * The library rejects bigger keys, and cannot deal with records
353 * with bigger keys stored by a library with bigger max keysize.
355 * We require that keys all fit onto a regular page. This limit
356 * could be raised a bit further if needed; to something just
357 * under #MDB_PAGESIZE / #MDB_MINKEYS.
359 * Note that data items in an #MDB_DUPSORT database are actually keys
360 * of a subDB, so they're also limited to this size.
362 #ifndef MDB_MAXKEYSIZE
363 #define MDB_MAXKEYSIZE 511
366 /** @brief The maximum size of a data item.
368 * We only store a 32 bit value for node sizes.
370 #define MAXDATASIZE 0xffffffffUL
375 * This is used for printing a hex dump of a key's contents.
377 #define DKBUF char kbuf[(MDB_MAXKEYSIZE*2+1)]
378 /** Display a key in hex.
380 * Invoke a function to display a key in hex.
382 #define DKEY(x) mdb_dkey(x, kbuf)
384 #define DKBUF typedef int dummy_kbuf /* so we can put ';' after */
388 /** An invalid page number.
389 * Mainly used to denote an empty tree.
391 #define P_INVALID (~(pgno_t)0)
393 /** Test if the flags \b f are set in a flag word \b w. */
394 #define F_ISSET(w, f) (((w) & (f)) == (f))
396 /** Used for offsets within a single page.
397 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
400 typedef uint16_t indx_t;
402 /** Default size of memory map.
403 * This is certainly too small for any actual applications. Apps should always set
404 * the size explicitly using #mdb_env_set_mapsize().
406 #define DEFAULT_MAPSIZE 1048576
408 /** @defgroup readers Reader Lock Table
409 * Readers don't acquire any locks for their data access. Instead, they
410 * simply record their transaction ID in the reader table. The reader
411 * mutex is needed just to find an empty slot in the reader table. The
412 * slot's address is saved in thread-specific data so that subsequent read
413 * transactions started by the same thread need no further locking to proceed.
415 * If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
417 * No reader table is used if the database is on a read-only filesystem.
419 * Since the database uses multi-version concurrency control, readers don't
420 * actually need any locking. This table is used to keep track of which
421 * readers are using data from which old transactions, so that we'll know
422 * when a particular old transaction is no longer in use. Old transactions
423 * that have discarded any data pages can then have those pages reclaimed
424 * for use by a later write transaction.
426 * The lock table is constructed such that reader slots are aligned with the
427 * processor's cache line size. Any slot is only ever used by one thread.
428 * This alignment guarantees that there will be no contention or cache
429 * thrashing as threads update their own slot info, and also eliminates
430 * any need for locking when accessing a slot.
432 * A writer thread will scan every slot in the table to determine the oldest
433 * outstanding reader transaction. Any freed pages older than this will be
434 * reclaimed by the writer. The writer doesn't use any locks when scanning
435 * this table. This means that there's no guarantee that the writer will
436 * see the most up-to-date reader info, but that's not required for correct
437 * operation - all we need is to know the upper bound on the oldest reader,
438 * we don't care at all about the newest reader. So the only consequence of
439 * reading stale information here is that old pages might hang around a
440 * while longer before being reclaimed. That's actually good anyway, because
441 * the longer we delay reclaiming old pages, the more likely it is that a
442 * string of contiguous pages can be found after coalescing old pages from
443 * many old transactions together.
446 /** Number of slots in the reader table.
447 * This value was chosen somewhat arbitrarily. 126 readers plus a
448 * couple mutexes fit exactly into 8KB on my development machine.
449 * Applications should set the table size using #mdb_env_set_maxreaders().
451 #define DEFAULT_READERS 126
453 /** The size of a CPU cache line in bytes. We want our lock structures
454 * aligned to this size to avoid false cache line sharing in the
456 * This value works for most CPUs. For Itanium this should be 128.
462 /** The information we store in a single slot of the reader table.
463 * In addition to a transaction ID, we also record the process and
464 * thread ID that owns a slot, so that we can detect stale information,
465 * e.g. threads or processes that went away without cleaning up.
466 * @note We currently don't check for stale records. We simply re-init
467 * the table when we know that we're the only process opening the
470 typedef struct MDB_rxbody {
471 /** Current Transaction ID when this transaction began, or (txnid_t)-1.
472 * Multiple readers that start at the same time will probably have the
473 * same ID here. Again, it's not important to exclude them from
474 * anything; all we need to know is which version of the DB they
475 * started from so we can avoid overwriting any data used in that
476 * particular version.
479 /** The process ID of the process owning this reader txn. */
481 /** The thread ID of the thread owning this txn. */
485 /** The actual reader record, with cacheline padding. */
486 typedef struct MDB_reader {
489 /** shorthand for mrb_txnid */
490 #define mr_txnid mru.mrx.mrb_txnid
491 #define mr_pid mru.mrx.mrb_pid
492 #define mr_tid mru.mrx.mrb_tid
493 /** cache line alignment */
494 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
498 /** The header for the reader table.
499 * The table resides in a memory-mapped file. (This is a different file
500 * than is used for the main database.)
502 * For POSIX the actual mutexes reside in the shared memory of this
503 * mapped file. On Windows, mutexes are named objects allocated by the
504 * kernel; we store the mutex names in this mapped file so that other
505 * processes can grab them. This same approach is also used on
506 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
507 * process-shared POSIX mutexes. For these cases where a named object
508 * is used, the object name is derived from a 64 bit FNV hash of the
509 * environment pathname. As such, naming collisions are extremely
510 * unlikely. If a collision occurs, the results are unpredictable.
512 typedef struct MDB_txbody {
513 /** Stamp identifying this as an MDB file. It must be set
516 /** Version number of this lock file. Must be set to #MDB_VERSION. */
517 uint32_t mtb_version;
518 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
519 char mtb_rmname[MNAME_LEN];
521 /** Mutex protecting access to this table.
522 * This is the reader lock that #LOCK_MUTEX_R acquires.
524 pthread_mutex_t mtb_mutex;
526 /** The ID of the last transaction committed to the database.
527 * This is recorded here only for convenience; the value can always
528 * be determined by reading the main database meta pages.
531 /** The number of slots that have been used in the reader table.
532 * This always records the maximum count, it is not decremented
533 * when readers release their slots.
535 unsigned mtb_numreaders;
538 /** The actual reader table definition. */
539 typedef struct MDB_txninfo {
542 #define mti_magic mt1.mtb.mtb_magic
543 #define mti_version mt1.mtb.mtb_version
544 #define mti_mutex mt1.mtb.mtb_mutex
545 #define mti_rmname mt1.mtb.mtb_rmname
546 #define mti_txnid mt1.mtb.mtb_txnid
547 #define mti_numreaders mt1.mtb.mtb_numreaders
548 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
551 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
552 char mt2_wmname[MNAME_LEN];
553 #define mti_wmname mt2.mt2_wmname
555 pthread_mutex_t mt2_wmutex;
556 #define mti_wmutex mt2.mt2_wmutex
558 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
560 MDB_reader mti_readers[1];
564 /** Common header for all page types.
565 * Overflow records occupy a number of contiguous pages with no
566 * headers on any page after the first.
568 typedef struct MDB_page {
569 #define mp_pgno mp_p.p_pgno
570 #define mp_next mp_p.p_next
572 pgno_t p_pgno; /**< page number */
573 void * p_next; /**< for in-memory list of freed structs */
576 /** @defgroup mdb_page Page Flags
578 * Flags for the page headers.
581 #define P_BRANCH 0x01 /**< branch page */
582 #define P_LEAF 0x02 /**< leaf page */
583 #define P_OVERFLOW 0x04 /**< overflow page */
584 #define P_META 0x08 /**< meta page */
585 #define P_DIRTY 0x10 /**< dirty page */
586 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
587 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
589 uint16_t mp_flags; /**< @ref mdb_page */
590 #define mp_lower mp_pb.pb.pb_lower
591 #define mp_upper mp_pb.pb.pb_upper
592 #define mp_pages mp_pb.pb_pages
595 indx_t pb_lower; /**< lower bound of free space */
596 indx_t pb_upper; /**< upper bound of free space */
598 uint32_t pb_pages; /**< number of overflow pages */
600 indx_t mp_ptrs[1]; /**< dynamic size */
603 /** Size of the page header, excluding dynamic data at the end */
604 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
606 /** Address of first usable data byte in a page, after the header */
607 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
609 /** Number of nodes on a page */
610 #define NUMKEYS(p) (((p)->mp_lower - PAGEHDRSZ) >> 1)
612 /** The amount of space remaining in the page */
613 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
615 /** The percentage of space used in the page, in tenths of a percent. */
616 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
617 ((env)->me_psize - PAGEHDRSZ))
618 /** The minimum page fill factor, in tenths of a percent.
619 * Pages emptier than this are candidates for merging.
621 #define FILL_THRESHOLD 250
623 /** Test if a page is a leaf page */
624 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
625 /** Test if a page is a LEAF2 page */
626 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
627 /** Test if a page is a branch page */
628 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
629 /** Test if a page is an overflow page */
630 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
631 /** Test if a page is a sub page */
632 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
634 /** The number of overflow pages needed to store the given size. */
635 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
637 /** Header for a single key/data pair within a page.
638 * We guarantee 2-byte alignment for nodes.
640 typedef struct MDB_node {
641 /** lo and hi are used for data size on leaf nodes and for
642 * child pgno on branch nodes. On 64 bit platforms, flags
643 * is also used for pgno. (Branch nodes have no flags).
644 * They are in host byte order in case that lets some
645 * accesses be optimized into a 32-bit word access.
647 #define mn_lo mn_offset[BYTE_ORDER!=LITTLE_ENDIAN]
648 #define mn_hi mn_offset[BYTE_ORDER==LITTLE_ENDIAN] /**< part of dsize or pgno */
649 unsigned short mn_offset[2]; /**< storage for #mn_lo and #mn_hi */
650 /** @defgroup mdb_node Node Flags
652 * Flags for node headers.
655 #define F_BIGDATA 0x01 /**< data put on overflow page */
656 #define F_SUBDATA 0x02 /**< data is a sub-database */
657 #define F_DUPDATA 0x04 /**< data has duplicates */
659 /** valid flags for #mdb_node_add() */
660 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
663 unsigned short mn_flags; /**< @ref mdb_node */
664 unsigned short mn_ksize; /**< key size */
665 char mn_data[1]; /**< key and data are appended here */
668 /** Size of the node header, excluding dynamic data at the end */
669 #define NODESIZE offsetof(MDB_node, mn_data)
671 /** Bit position of top word in page number, for shifting mn_flags */
672 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
674 /** Size of a node in a branch page with a given key.
675 * This is just the node header plus the key, there is no data.
677 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
679 /** Size of a node in a leaf page with a given key and data.
680 * This is node header plus key plus data size.
682 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
684 /** Address of node \b i in page \b p */
685 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i]))
687 /** Address of the key for the node */
688 #define NODEKEY(node) (void *)((node)->mn_data)
690 /** Address of the data for a node */
691 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
693 /** Get the page number pointed to by a branch node */
694 #define NODEPGNO(node) \
695 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
696 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
697 /** Set the page number in a branch node */
698 #define SETPGNO(node,pgno) do { \
699 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
700 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
702 /** Get the size of the data in a leaf node */
703 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
704 /** Set the size of the data for a leaf node */
705 #define SETDSZ(node,size) do { \
706 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
707 /** The size of a key in a node */
708 #define NODEKSZ(node) ((node)->mn_ksize)
710 /** Copy a page number from src to dst */
712 #define COPY_PGNO(dst,src) dst = src
714 #if SIZE_MAX > 4294967295UL
715 #define COPY_PGNO(dst,src) do { \
716 unsigned short *s, *d; \
717 s = (unsigned short *)&(src); \
718 d = (unsigned short *)&(dst); \
725 #define COPY_PGNO(dst,src) do { \
726 unsigned short *s, *d; \
727 s = (unsigned short *)&(src); \
728 d = (unsigned short *)&(dst); \
734 /** The address of a key in a LEAF2 page.
735 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
736 * There are no node headers, keys are stored contiguously.
738 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
740 /** Set the \b node's key into \b key, if requested. */
741 #define MDB_GET_KEY(node, key) { if ((key) != NULL) { \
742 (key)->mv_size = NODEKSZ(node); (key)->mv_data = NODEKEY(node); } }
744 /** Information about a single database in the environment. */
745 typedef struct MDB_db {
746 uint32_t md_pad; /**< also ksize for LEAF2 pages */
747 uint16_t md_flags; /**< @ref mdb_dbi_open */
748 uint16_t md_depth; /**< depth of this tree */
749 pgno_t md_branch_pages; /**< number of internal pages */
750 pgno_t md_leaf_pages; /**< number of leaf pages */
751 pgno_t md_overflow_pages; /**< number of overflow pages */
752 size_t md_entries; /**< number of data items */
753 pgno_t md_root; /**< the root page of this tree */
756 /** mdb_dbi_open flags */
757 #define MDB_VALID 0x8000 /**< DB handle is valid, for me_dbflags */
758 #define PERSISTENT_FLAGS (0xffff & ~(MDB_VALID))
759 #define VALID_FLAGS (MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
760 MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)
762 /** Handle for the DB used to track free pages. */
764 /** Handle for the default DB. */
767 /** Meta page content. */
768 typedef struct MDB_meta {
769 /** Stamp identifying this as an MDB file. It must be set
772 /** Version number of this lock file. Must be set to #MDB_VERSION. */
774 void *mm_address; /**< address for fixed mapping */
775 size_t mm_mapsize; /**< size of mmap region */
776 MDB_db mm_dbs[2]; /**< first is free space, 2nd is main db */
777 /** The size of pages used in this DB */
778 #define mm_psize mm_dbs[0].md_pad
779 /** Any persistent environment flags. @ref mdb_env */
780 #define mm_flags mm_dbs[0].md_flags
781 pgno_t mm_last_pg; /**< last used page in file */
782 txnid_t mm_txnid; /**< txnid that committed this page */
785 /** Buffer for a stack-allocated dirty page.
786 * The members define size and alignment, and silence type
787 * aliasing warnings. They are not used directly; that could
788 * mean incorrectly using several union members in parallel.
790 typedef union MDB_pagebuf {
791 char mb_raw[MDB_PAGESIZE];
794 char mm_pad[PAGEHDRSZ];
799 /** Auxiliary DB info.
800 * The information here is mostly static/read-only. There is
801 * only a single copy of this record in the environment.
803 typedef struct MDB_dbx {
804 MDB_val md_name; /**< name of the database */
805 MDB_cmp_func *md_cmp; /**< function for comparing keys */
806 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
807 MDB_rel_func *md_rel; /**< user relocate function */
808 void *md_relctx; /**< user-provided context for md_rel */
811 /** A database transaction.
812 * Every operation requires a transaction handle.
815 MDB_txn *mt_parent; /**< parent of a nested txn */
816 MDB_txn *mt_child; /**< nested txn under this txn */
817 pgno_t mt_next_pgno; /**< next unallocated page */
818 /** The ID of this transaction. IDs are integers incrementing from 1.
819 * Only committed write transactions increment the ID. If a transaction
820 * aborts, the ID may be re-used by the next writer.
823 MDB_env *mt_env; /**< the DB environment */
824 /** The list of pages that became unused during this transaction.
828 MDB_ID2L dirty_list; /**< for write txns: modified pages */
829 MDB_reader *reader; /**< this thread's reader table slot or NULL */
831 /** Array of records for each DB known in the environment. */
833 /** Array of MDB_db records for each known DB */
835 /** @defgroup mt_dbflag Transaction DB Flags
839 #define DB_DIRTY 0x01 /**< DB was written in this txn */
840 #define DB_STALE 0x02 /**< DB record is older than txnID */
841 #define DB_NEW 0x04 /**< DB handle opened in this txn */
842 #define DB_VALID 0x08 /**< DB handle is valid, see also #MDB_VALID */
844 /** In write txns, array of cursors for each DB */
845 MDB_cursor **mt_cursors;
846 /** Array of flags for each DB */
847 unsigned char *mt_dbflags;
848 /** Number of DB records in use. This number only ever increments;
849 * we don't decrement it when individual DB handles are closed.
853 /** @defgroup mdb_txn Transaction Flags
857 #define MDB_TXN_RDONLY 0x01 /**< read-only transaction */
858 #define MDB_TXN_ERROR 0x02 /**< an error has occurred */
859 #define MDB_TXN_DIRTY 0x04 /**< must write, even if dirty list is empty */
861 unsigned int mt_flags; /**< @ref mdb_txn */
862 /** dirty_list maxsize - # of allocated pages allowed, including in parent txns */
863 unsigned int mt_dirty_room;
864 /** Tracks which of the two meta pages was used at the start
865 * of this transaction.
867 unsigned int mt_toggle;
870 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
871 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
872 * raise this on a 64 bit machine.
874 #define CURSOR_STACK 32
878 /** Cursors are used for all DB operations */
880 /** Next cursor on this DB in this txn */
882 /** Backup of the original cursor if this cursor is a shadow */
883 MDB_cursor *mc_backup;
884 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
885 struct MDB_xcursor *mc_xcursor;
886 /** The transaction that owns this cursor */
888 /** The database handle this cursor operates on */
890 /** The database record for this cursor */
892 /** The database auxiliary record for this cursor */
894 /** The @ref mt_dbflag for this database */
895 unsigned char *mc_dbflag;
896 unsigned short mc_snum; /**< number of pushed pages */
897 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
898 /** @defgroup mdb_cursor Cursor Flags
900 * Cursor state flags.
903 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
904 #define C_EOF 0x02 /**< No more data */
905 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
906 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
907 #define C_UNTRACK 0x40 /**< Un-track cursor when closing */
909 unsigned int mc_flags; /**< @ref mdb_cursor */
910 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
911 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
914 /** Context for sorted-dup records.
915 * We could have gone to a fully recursive design, with arbitrarily
916 * deep nesting of sub-databases. But for now we only handle these
917 * levels - main DB, optional sub-DB, sorted-duplicate DB.
919 typedef struct MDB_xcursor {
920 /** A sub-cursor for traversing the Dup DB */
921 MDB_cursor mx_cursor;
922 /** The database record for this Dup DB */
924 /** The auxiliary DB record for this Dup DB */
926 /** The @ref mt_dbflag for this Dup DB */
927 unsigned char mx_dbflag;
930 /** State of FreeDB old pages, stored in the MDB_env */
931 typedef struct MDB_pgstate {
932 pgno_t *mf_pghead; /**< Reclaimed freeDB pages, or NULL before use */
933 txnid_t mf_pglast; /**< ID of last used record, or 0 if !mf_pghead */
936 /** The database environment. */
938 HANDLE me_fd; /**< The main data file */
939 HANDLE me_lfd; /**< The lock file */
940 HANDLE me_mfd; /**< just for writing the meta pages */
941 /** Failed to update the meta page. Probably an I/O error. */
942 #define MDB_FATAL_ERROR 0x80000000U
943 /** Some fields are initialized. */
944 #define MDB_ENV_ACTIVE 0x20000000U
945 /** me_txkey is set */
946 #define MDB_ENV_TXKEY 0x10000000U
947 uint32_t me_flags; /**< @ref mdb_env */
948 unsigned int me_psize; /**< size of a page, from #GET_PAGESIZE */
949 unsigned int me_maxreaders; /**< size of the reader table */
950 unsigned int me_numreaders; /**< max numreaders set by this env */
951 MDB_dbi me_numdbs; /**< number of DBs opened */
952 MDB_dbi me_maxdbs; /**< size of the DB table */
953 pid_t me_pid; /**< process ID of this env */
954 char *me_path; /**< path to the DB files */
955 char *me_map; /**< the memory map of the data file */
956 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
957 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
958 MDB_txn *me_txn; /**< current write transaction */
959 size_t me_mapsize; /**< size of the data memory map */
960 off_t me_size; /**< current file size */
961 pgno_t me_maxpg; /**< me_mapsize / me_psize */
962 MDB_dbx *me_dbxs; /**< array of static DB info */
963 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
964 pthread_key_t me_txkey; /**< thread-key for readers */
965 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
966 # define me_pglast me_pgstate.mf_pglast
967 # define me_pghead me_pgstate.mf_pghead
968 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
969 /** IDL of pages that became unused in a write txn */
971 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
972 MDB_ID2L me_dirty_list;
973 /** Max number of freelist items that can fit in a single overflow page */
975 /** Max size of a node on a page */
976 unsigned int me_nodemax;
978 HANDLE me_rmutex; /* Windows mutexes don't reside in shared mem */
980 #elif defined(MDB_USE_POSIX_SEM)
981 sem_t *me_rmutex; /* Shared mutexes are not supported */
986 /** Nested transaction */
987 typedef struct MDB_ntxn {
988 MDB_txn mnt_txn; /* the transaction */
989 MDB_pgstate mnt_pgstate; /* parent transaction's saved freestate */
992 /** max number of pages to commit in one writev() call */
993 #define MDB_COMMIT_PAGES 64
994 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
995 #undef MDB_COMMIT_PAGES
996 #define MDB_COMMIT_PAGES IOV_MAX
999 /* max bytes to write in one call */
1000 #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4))
1002 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
1003 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
1004 static int mdb_page_touch(MDB_cursor *mc);
1006 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp, int *lvl);
1007 static int mdb_page_search_root(MDB_cursor *mc,
1008 MDB_val *key, int modify);
1009 #define MDB_PS_MODIFY 1
1010 #define MDB_PS_ROOTONLY 2
1011 static int mdb_page_search(MDB_cursor *mc,
1012 MDB_val *key, int flags);
1013 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1015 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1016 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1017 pgno_t newpgno, unsigned int nflags);
1019 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1020 static int mdb_env_pick_meta(const MDB_env *env);
1021 static int mdb_env_write_meta(MDB_txn *txn);
1022 #if !(defined(_WIN32) || defined(MDB_USE_POSIX_SEM)) /* Drop unused excl arg */
1023 # define mdb_env_close0(env, excl) mdb_env_close1(env)
1025 static void mdb_env_close0(MDB_env *env, int excl);
1027 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1028 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1029 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1030 static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
1031 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1032 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1033 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1034 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1035 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1037 static int mdb_rebalance(MDB_cursor *mc);
1038 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1040 static void mdb_cursor_pop(MDB_cursor *mc);
1041 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1043 static int mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
1044 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1045 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1046 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1047 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1049 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1050 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1052 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1053 static void mdb_xcursor_init0(MDB_cursor *mc);
1054 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1056 static int mdb_drop0(MDB_cursor *mc, int subs);
1057 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1060 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1064 static SECURITY_DESCRIPTOR mdb_null_sd;
1065 static SECURITY_ATTRIBUTES mdb_all_sa;
1066 static int mdb_sec_inited;
1069 /** Return the library version info. */
1071 mdb_version(int *major, int *minor, int *patch)
1073 if (major) *major = MDB_VERSION_MAJOR;
1074 if (minor) *minor = MDB_VERSION_MINOR;
1075 if (patch) *patch = MDB_VERSION_PATCH;
1076 return MDB_VERSION_STRING;
1079 /** Table of descriptions for MDB @ref errors */
1080 static char *const mdb_errstr[] = {
1081 "MDB_KEYEXIST: Key/data pair already exists",
1082 "MDB_NOTFOUND: No matching key/data pair found",
1083 "MDB_PAGE_NOTFOUND: Requested page not found",
1084 "MDB_CORRUPTED: Located page was wrong type",
1085 "MDB_PANIC: Update of meta page failed",
1086 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1087 "MDB_INVALID: File is not an MDB file",
1088 "MDB_MAP_FULL: Environment mapsize limit reached",
1089 "MDB_DBS_FULL: Environment maxdbs limit reached",
1090 "MDB_READERS_FULL: Environment maxreaders limit reached",
1091 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1092 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1093 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1094 "MDB_PAGE_FULL: Internal error - page has no more space",
1095 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1096 "MDB_INCOMPATIBLE: Database flags changed or would change",
1097 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1101 mdb_strerror(int err)
1105 return ("Successful return: 0");
1107 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1108 i = err - MDB_KEYEXIST;
1109 return mdb_errstr[i];
1112 return strerror(err);
1116 /** Display a key in hexadecimal and return the address of the result.
1117 * @param[in] key the key to display
1118 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1119 * @return The key in hexadecimal form.
1122 mdb_dkey(MDB_val *key, char *buf)
1125 unsigned char *c = key->mv_data;
1131 if (key->mv_size > MDB_MAXKEYSIZE)
1132 return "MDB_MAXKEYSIZE";
1133 /* may want to make this a dynamic check: if the key is mostly
1134 * printable characters, print it as-is instead of converting to hex.
1138 for (i=0; i<key->mv_size; i++)
1139 ptr += sprintf(ptr, "%02x", *c++);
1141 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1146 /** Display all the keys in the page. */
1148 mdb_page_list(MDB_page *mp)
1151 unsigned int i, nkeys, nsize;
1155 nkeys = NUMKEYS(mp);
1156 fprintf(stderr, "Page %zu numkeys %d\n", mp->mp_pgno, nkeys);
1157 for (i=0; i<nkeys; i++) {
1158 node = NODEPTR(mp, i);
1159 key.mv_size = node->mn_ksize;
1160 key.mv_data = node->mn_data;
1161 nsize = NODESIZE + NODEKSZ(node) + sizeof(indx_t);
1162 if (IS_BRANCH(mp)) {
1163 fprintf(stderr, "key %d: page %zu, %s\n", i, NODEPGNO(node),
1166 if (F_ISSET(node->mn_flags, F_BIGDATA))
1167 nsize += sizeof(pgno_t);
1169 nsize += NODEDSZ(node);
1170 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1176 mdb_cursor_chk(MDB_cursor *mc)
1182 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1183 for (i=0; i<mc->mc_top; i++) {
1185 node = NODEPTR(mp, mc->mc_ki[i]);
1186 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1189 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1195 /** Count all the pages in each DB and in the freelist
1196 * and make sure it matches the actual number of pages
1199 static void mdb_audit(MDB_txn *txn)
1203 MDB_ID freecount, count;
1208 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1209 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1210 freecount += *(MDB_ID *)data.mv_data;
1213 for (i = 0; i<txn->mt_numdbs; i++) {
1215 mdb_cursor_init(&mc, txn, i, &mx);
1216 if (txn->mt_dbs[i].md_root == P_INVALID)
1218 count += txn->mt_dbs[i].md_branch_pages +
1219 txn->mt_dbs[i].md_leaf_pages +
1220 txn->mt_dbs[i].md_overflow_pages;
1221 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1222 mdb_page_search(&mc, NULL, 0);
1226 mp = mc.mc_pg[mc.mc_top];
1227 for (j=0; j<NUMKEYS(mp); j++) {
1228 MDB_node *leaf = NODEPTR(mp, j);
1229 if (leaf->mn_flags & F_SUBDATA) {
1231 memcpy(&db, NODEDATA(leaf), sizeof(db));
1232 count += db.md_branch_pages + db.md_leaf_pages +
1233 db.md_overflow_pages;
1237 while (mdb_cursor_sibling(&mc, 1) == 0);
1240 if (freecount + count + 2 /* metapages */ != txn->mt_next_pgno) {
1241 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1242 txn->mt_txnid, freecount, count+2, freecount+count+2, txn->mt_next_pgno);
1248 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1250 return txn->mt_dbxs[dbi].md_cmp(a, b);
1254 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1256 return txn->mt_dbxs[dbi].md_dcmp(a, b);
1259 /** Allocate a page.
1260 * Re-use old malloc'd pages first for singletons, otherwise just malloc.
1263 mdb_page_malloc(MDB_txn *txn, unsigned num)
1265 MDB_env *env = txn->mt_env;
1266 MDB_page *ret = env->me_dpages;
1267 size_t sz = env->me_psize;
1270 VGMEMP_ALLOC(env, ret, sz);
1271 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1272 env->me_dpages = ret->mp_next;
1278 if ((ret = malloc(sz)) != NULL) {
1279 VGMEMP_ALLOC(env, ret, sz);
1284 /** Free a single page.
1285 * Saves single pages to a list, for future reuse.
1286 * (This is not used for multi-page overflow pages.)
1289 mdb_page_free(MDB_env *env, MDB_page *mp)
1291 mp->mp_next = env->me_dpages;
1292 VGMEMP_FREE(env, mp);
1293 env->me_dpages = mp;
1296 /* Free a dirty page */
1298 mdb_dpage_free(MDB_env *env, MDB_page *dp)
1300 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1301 mdb_page_free(env, dp);
1303 /* large pages just get freed directly */
1304 VGMEMP_FREE(env, dp);
1309 /* Return all dirty pages to dpage list */
1311 mdb_dlist_free(MDB_txn *txn)
1313 MDB_env *env = txn->mt_env;
1314 MDB_ID2L dl = txn->mt_u.dirty_list;
1315 unsigned i, n = dl[0].mid;
1317 for (i = 1; i <= n; i++) {
1318 mdb_dpage_free(env, dl[i].mptr);
1323 /** Find oldest txnid still referenced. Expects txn->mt_txnid > 0. */
1325 mdb_find_oldest(MDB_txn *txn)
1328 txnid_t mr, oldest = txn->mt_txnid - 1;
1329 MDB_reader *r = txn->mt_env->me_txns->mti_readers;
1330 for (i = txn->mt_env->me_txns->mti_numreaders; --i >= 0; ) {
1340 /** Allocate pages for writing.
1341 * If there are free pages available from older transactions, they
1342 * will be re-used first. Otherwise a new page will be allocated.
1343 * @param[in] mc cursor A cursor handle identifying the transaction and
1344 * database for which we are allocating.
1345 * @param[in] num the number of pages to allocate.
1346 * @param[out] mp Address of the allocated page(s). Requests for multiple pages
1347 * will always be satisfied by a single contiguous chunk of memory.
1348 * @return 0 on success, non-zero on failure.
1351 mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp)
1353 #ifdef MDB_PARANOID /* Seems like we can ignore this now */
1354 /* Get at most <Max_retries> more freeDB records once me_pghead
1355 * has enough pages. If not enough, use new pages from the map.
1356 * If <Paranoid> and mc is updating the freeDB, only get new
1357 * records if me_pghead is empty. Then the freelist cannot play
1358 * catch-up with itself by growing while trying to save it.
1360 enum { Paranoid = 1, Max_retries = 500 };
1362 enum { Paranoid = 0, Max_retries = INT_MAX /*infinite*/ };
1364 int rc, n2 = num-1, retry = Max_retries;
1365 MDB_txn *txn = mc->mc_txn;
1366 MDB_env *env = txn->mt_env;
1367 pgno_t pgno, *mop = env->me_pghead;
1368 unsigned i, j, k, mop_len = mop ? mop[0] : 0;
1371 txnid_t oldest = 0, last;
1374 int (*insert)(MDB_ID2L, MDB_ID2 *);
1378 /* If our dirty list is already full, we can't do anything */
1379 if (txn->mt_dirty_room == 0)
1380 return MDB_TXN_FULL;
1382 for (op = MDB_FIRST;; op = MDB_NEXT) {
1385 pgno_t *idl, old_id, new_id;
1387 /* Seek a big enough contiguous page range. Prefer
1388 * pages at the tail, just truncating the list.
1390 if (mop_len >= (unsigned)num) {
1394 if (mop[i-n2] == pgno+n2)
1396 } while (--i >= (unsigned)num);
1397 if (Max_retries < INT_MAX && --retry < 0)
1401 if (op == MDB_FIRST) { /* 1st iteration */
1402 /* Prepare to fetch more and coalesce */
1403 oldest = mdb_find_oldest(txn);
1404 last = env->me_pglast;
1405 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
1408 key.mv_data = &last; /* will loop up last+1 */
1409 key.mv_size = sizeof(last);
1411 if (Paranoid && mc->mc_dbi == FREE_DBI)
1414 if (Paranoid && retry < 0 && mop_len)
1418 /* Do not fetch more if the record will be too recent */
1421 rc = mdb_cursor_get(&m2, &key, NULL, op);
1423 if (rc == MDB_NOTFOUND)
1427 last = *(txnid_t*)key.mv_data;
1430 np = m2.mc_pg[m2.mc_top];
1431 leaf = NODEPTR(np, m2.mc_ki[m2.mc_top]);
1432 if ((rc = mdb_node_read(txn, leaf, &data)) != MDB_SUCCESS)
1435 idl = (MDB_ID *) data.mv_data;
1438 if (!(env->me_pghead = mop = mdb_midl_alloc(i)))
1441 if ((rc = mdb_midl_need(&env->me_pghead, i)) != 0)
1443 mop = env->me_pghead;
1445 env->me_pglast = last;
1447 DPRINTF("IDL read txn %zu root %zu num %u",
1448 last, txn->mt_dbs[FREE_DBI].md_root, i);
1450 DPRINTF("IDL %zu", idl[k]);
1452 /* Merge in descending sorted order */
1455 mop[0] = (pgno_t)-1;
1459 for (; old_id < new_id; old_id = mop[--j])
1466 /* Use new pages from the map when nothing suitable in the freeDB */
1468 pgno = txn->mt_next_pgno;
1469 if (pgno + num >= env->me_maxpg) {
1470 DPUTS("DB size maxed out");
1471 return MDB_MAP_FULL;
1475 if (env->me_flags & MDB_WRITEMAP) {
1476 np = (MDB_page *)(env->me_map + env->me_psize * pgno);
1477 insert = mdb_mid2l_append;
1479 if (!(np = mdb_page_malloc(txn, num)))
1481 insert = mdb_mid2l_insert;
1484 mop[0] = mop_len -= num;
1485 /* Move any stragglers down */
1486 for (j = i-num; j < mop_len; )
1487 mop[++j] = mop[++i];
1489 txn->mt_next_pgno = pgno + num;
1491 mid.mid = np->mp_pgno = pgno;
1493 insert(txn->mt_u.dirty_list, &mid);
1494 txn->mt_dirty_room--;
1500 /** Copy the used portions of a non-overflow page.
1501 * @param[in] dst page to copy into
1502 * @param[in] src page to copy from
1503 * @param[in] psize size of a page
1506 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
1508 enum { Align = sizeof(pgno_t) };
1509 indx_t upper = src->mp_upper, lower = src->mp_lower, unused = upper-lower;
1511 /* If page isn't full, just copy the used portion. Adjust
1512 * alignment so memcpy may copy words instead of bytes.
1514 if ((unused &= -Align) && !IS_LEAF2(src)) {
1516 memcpy(dst, src, (lower + (Align-1)) & -Align);
1517 memcpy((pgno_t *)((char *)dst+upper), (pgno_t *)((char *)src+upper),
1520 memcpy(dst, src, psize - unused);
1524 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
1525 * @param[in] mc cursor pointing to the page to be touched
1526 * @return 0 on success, non-zero on failure.
1529 mdb_page_touch(MDB_cursor *mc)
1531 MDB_page *mp = mc->mc_pg[mc->mc_top], *np;
1532 MDB_txn *txn = mc->mc_txn;
1533 MDB_cursor *m2, *m3;
1538 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
1539 if ((rc = mdb_midl_need(&txn->mt_free_pgs, 1)) ||
1540 (rc = mdb_page_alloc(mc, 1, &np)))
1543 DPRINTF("touched db %u page %zu -> %zu", mc->mc_dbi,mp->mp_pgno,pgno);
1544 assert(mp->mp_pgno != pgno);
1545 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
1546 /* Update the parent page, if any, to point to the new page */
1548 MDB_page *parent = mc->mc_pg[mc->mc_top-1];
1549 MDB_node *node = NODEPTR(parent, mc->mc_ki[mc->mc_top-1]);
1550 SETPGNO(node, pgno);
1552 mc->mc_db->md_root = pgno;
1554 } else if (txn->mt_parent && !IS_SUBP(mp)) {
1555 MDB_ID2 mid, *dl = txn->mt_u.dirty_list;
1557 /* If txn has a parent, make sure the page is in our
1561 unsigned x = mdb_mid2l_search(dl, pgno);
1562 if (x <= dl[0].mid && dl[x].mid == pgno) {
1563 if (mp != dl[x].mptr) { /* bad cursor? */
1564 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
1565 return MDB_CORRUPTED;
1570 assert(dl[0].mid < MDB_IDL_UM_MAX);
1572 np = mdb_page_malloc(txn, 1);
1577 mdb_mid2l_insert(dl, &mid);
1582 mdb_page_copy(np, mp, txn->mt_env->me_psize);
1584 np->mp_flags |= P_DIRTY;
1586 /* Adjust cursors pointing to mp */
1587 mc->mc_pg[mc->mc_top] = np;
1589 if (mc->mc_flags & C_SUB) {
1591 for (m2 = txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
1592 m3 = &m2->mc_xcursor->mx_cursor;
1593 if (m3->mc_snum < mc->mc_snum) continue;
1594 if (m3->mc_pg[mc->mc_top] == mp)
1595 m3->mc_pg[mc->mc_top] = np;
1598 for (m2 = txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
1599 if (m2->mc_snum < mc->mc_snum) continue;
1600 if (m2->mc_pg[mc->mc_top] == mp) {
1601 m2->mc_pg[mc->mc_top] = np;
1602 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
1603 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
1605 MDB_node *leaf = NODEPTR(np, mc->mc_ki[mc->mc_top]);
1606 if (!(leaf->mn_flags & F_SUBDATA))
1607 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
1616 mdb_env_sync(MDB_env *env, int force)
1619 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
1620 if (env->me_flags & MDB_WRITEMAP) {
1621 int flags = ((env->me_flags & MDB_MAPASYNC) && !force)
1622 ? MS_ASYNC : MS_SYNC;
1623 if (MDB_MSYNC(env->me_map, env->me_mapsize, flags))
1626 else if (flags == MS_SYNC && MDB_FDATASYNC(env->me_fd))
1630 if (MDB_FDATASYNC(env->me_fd))
1637 /** Back up parent txn's cursors, then grab the originals for tracking */
1639 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
1641 MDB_cursor *mc, *bk;
1646 for (i = src->mt_numdbs; --i >= 0; ) {
1647 if ((mc = src->mt_cursors[i]) != NULL) {
1648 size = sizeof(MDB_cursor);
1650 size += sizeof(MDB_xcursor);
1651 for (; mc; mc = bk->mc_next) {
1657 mc->mc_db = &dst->mt_dbs[i];
1658 /* Kill pointers into src - and dst to reduce abuse: The
1659 * user may not use mc until dst ends. Otherwise we'd...
1661 mc->mc_txn = NULL; /* ...set this to dst */
1662 mc->mc_dbflag = NULL; /* ...and &dst->mt_dbflags[i] */
1663 if ((mx = mc->mc_xcursor) != NULL) {
1664 *(MDB_xcursor *)(bk+1) = *mx;
1665 mx->mx_cursor.mc_txn = NULL; /* ...and dst. */
1667 mc->mc_next = dst->mt_cursors[i];
1668 dst->mt_cursors[i] = mc;
1675 /** Close this write txn's cursors, give parent txn's cursors back to parent.
1676 * @param[in] txn the transaction handle.
1677 * @param[in] merge true to keep changes to parent cursors, false to revert.
1678 * @return 0 on success, non-zero on failure.
1681 mdb_cursors_close(MDB_txn *txn, unsigned merge)
1683 MDB_cursor **cursors = txn->mt_cursors, *mc, *next, *bk;
1687 for (i = txn->mt_numdbs; --i >= 0; ) {
1688 for (mc = cursors[i]; mc; mc = next) {
1690 if ((bk = mc->mc_backup) != NULL) {
1692 /* Commit changes to parent txn */
1693 mc->mc_next = bk->mc_next;
1694 mc->mc_backup = bk->mc_backup;
1695 mc->mc_txn = bk->mc_txn;
1696 mc->mc_db = bk->mc_db;
1697 mc->mc_dbflag = bk->mc_dbflag;
1698 if ((mx = mc->mc_xcursor) != NULL)
1699 mx->mx_cursor.mc_txn = bk->mc_txn;
1701 /* Abort nested txn */
1703 if ((mx = mc->mc_xcursor) != NULL)
1704 *mx = *(MDB_xcursor *)(bk+1);
1714 #ifdef MDB_DEBUG_SKIP
1715 #define mdb_txn_reset0(txn, act) mdb_txn_reset0(txn)
1718 mdb_txn_reset0(MDB_txn *txn, const char *act);
1720 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
1721 * @param[in] txn the transaction handle to initialize
1722 * @return 0 on success, non-zero on failure.
1725 mdb_txn_renew0(MDB_txn *txn)
1727 MDB_env *env = txn->mt_env;
1730 int rc, new_notls = 0;
1733 txn->mt_numdbs = env->me_numdbs;
1734 txn->mt_dbxs = env->me_dbxs; /* mostly static anyway */
1736 if (txn->mt_flags & MDB_TXN_RDONLY) {
1737 if (!env->me_txns) {
1738 i = mdb_env_pick_meta(env);
1739 txn->mt_txnid = env->me_metas[i]->mm_txnid;
1740 txn->mt_u.reader = NULL;
1742 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
1743 pthread_getspecific(env->me_txkey);
1745 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
1746 return MDB_BAD_RSLOT;
1748 pid_t pid = env->me_pid;
1749 pthread_t tid = pthread_self();
1752 for (i=0; i<env->me_txns->mti_numreaders; i++)
1753 if (env->me_txns->mti_readers[i].mr_pid == 0)
1755 if (i == env->me_maxreaders) {
1756 UNLOCK_MUTEX_R(env);
1757 return MDB_READERS_FULL;
1759 env->me_txns->mti_readers[i].mr_pid = pid;
1760 env->me_txns->mti_readers[i].mr_tid = tid;
1761 if (i >= env->me_txns->mti_numreaders)
1762 env->me_txns->mti_numreaders = i+1;
1763 /* Save numreaders for un-mutexed mdb_env_close() */
1764 env->me_numreaders = env->me_txns->mti_numreaders;
1765 UNLOCK_MUTEX_R(env);
1766 r = &env->me_txns->mti_readers[i];
1767 new_notls = (env->me_flags & MDB_NOTLS);
1768 if (!new_notls && (rc=pthread_setspecific(env->me_txkey, r))) {
1773 txn->mt_txnid = r->mr_txnid = env->me_txns->mti_txnid;
1774 txn->mt_u.reader = r;
1776 txn->mt_toggle = txn->mt_txnid & 1;
1780 txn->mt_txnid = env->me_txns->mti_txnid;
1781 txn->mt_toggle = txn->mt_txnid & 1;
1784 if (txn->mt_txnid == mdb_debug_start)
1787 txn->mt_dirty_room = MDB_IDL_UM_MAX;
1788 txn->mt_u.dirty_list = env->me_dirty_list;
1789 txn->mt_u.dirty_list[0].mid = 0;
1790 txn->mt_free_pgs = env->me_free_pgs;
1791 txn->mt_free_pgs[0] = 0;
1795 /* Copy the DB info and flags */
1796 memcpy(txn->mt_dbs, env->me_metas[txn->mt_toggle]->mm_dbs, 2 * sizeof(MDB_db));
1798 /* Moved to here to avoid a data race in read TXNs */
1799 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1801 for (i=2; i<txn->mt_numdbs; i++) {
1802 x = env->me_dbflags[i];
1803 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
1804 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_STALE : 0;
1806 txn->mt_dbflags[0] = txn->mt_dbflags[1] = DB_VALID;
1808 if (env->me_maxpg < txn->mt_next_pgno) {
1809 mdb_txn_reset0(txn, "renew0-mapfail");
1811 txn->mt_u.reader->mr_pid = 0;
1812 txn->mt_u.reader = NULL;
1814 return MDB_MAP_RESIZED;
1821 mdb_txn_renew(MDB_txn *txn)
1825 if (!txn || txn->mt_dbxs) /* A reset txn has mt_dbxs==NULL */
1828 if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
1829 DPUTS("environment had fatal error, must shutdown!");
1833 rc = mdb_txn_renew0(txn);
1834 if (rc == MDB_SUCCESS) {
1835 DPRINTF("renew txn %zu%c %p on mdbenv %p, root page %zu",
1836 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1837 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1843 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
1847 int rc, size, tsize = sizeof(MDB_txn);
1849 if (env->me_flags & MDB_FATAL_ERROR) {
1850 DPUTS("environment had fatal error, must shutdown!");
1853 if ((env->me_flags & MDB_RDONLY) && !(flags & MDB_RDONLY))
1856 /* Nested transactions: Max 1 child, write txns only, no writemap */
1857 if (parent->mt_child ||
1858 (flags & MDB_RDONLY) || (parent->mt_flags & MDB_TXN_RDONLY) ||
1859 (env->me_flags & MDB_WRITEMAP))
1863 tsize = sizeof(MDB_ntxn);
1865 size = tsize + env->me_maxdbs * (sizeof(MDB_db)+1);
1866 if (!(flags & MDB_RDONLY))
1867 size += env->me_maxdbs * sizeof(MDB_cursor *);
1869 if ((txn = calloc(1, size)) == NULL) {
1870 DPRINTF("calloc: %s", strerror(ErrCode()));
1873 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
1874 if (flags & MDB_RDONLY) {
1875 txn->mt_flags |= MDB_TXN_RDONLY;
1876 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
1878 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
1879 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
1885 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
1886 if (!txn->mt_u.dirty_list ||
1887 !(txn->mt_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)))
1889 free(txn->mt_u.dirty_list);
1893 txn->mt_txnid = parent->mt_txnid;
1894 txn->mt_toggle = parent->mt_toggle;
1895 txn->mt_dirty_room = parent->mt_dirty_room;
1896 txn->mt_u.dirty_list[0].mid = 0;
1897 txn->mt_next_pgno = parent->mt_next_pgno;
1898 parent->mt_child = txn;
1899 txn->mt_parent = parent;
1900 txn->mt_numdbs = parent->mt_numdbs;
1901 txn->mt_flags = parent->mt_flags;
1902 txn->mt_dbxs = parent->mt_dbxs;
1903 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
1904 /* Copy parent's mt_dbflags, but clear DB_NEW */
1905 for (i=0; i<txn->mt_numdbs; i++)
1906 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
1908 ntxn = (MDB_ntxn *)txn;
1909 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
1910 if (env->me_pghead) {
1911 size = MDB_IDL_SIZEOF(env->me_pghead);
1912 env->me_pghead = mdb_midl_alloc(env->me_pghead[0]);
1914 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
1919 rc = mdb_cursor_shadow(parent, txn);
1921 mdb_txn_reset0(txn, "beginchild-fail");
1923 rc = mdb_txn_renew0(txn);
1929 DPRINTF("begin txn %zu%c %p on mdbenv %p, root page %zu",
1930 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1931 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root);
1937 /** Export or close DBI handles opened in this txn. */
1939 mdb_dbis_update(MDB_txn *txn, int keep)
1942 MDB_dbi n = txn->mt_numdbs;
1943 MDB_env *env = txn->mt_env;
1944 unsigned char *tdbflags = txn->mt_dbflags;
1946 for (i = n; --i >= 2;) {
1947 if (tdbflags[i] & DB_NEW) {
1949 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
1951 char *ptr = env->me_dbxs[i].md_name.mv_data;
1952 env->me_dbxs[i].md_name.mv_data = NULL;
1953 env->me_dbxs[i].md_name.mv_size = 0;
1954 env->me_dbflags[i] = 0;
1959 if (keep && env->me_numdbs < n)
1963 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
1964 * May be called twice for readonly txns: First reset it, then abort.
1965 * @param[in] txn the transaction handle to reset
1968 mdb_txn_reset0(MDB_txn *txn, const char *act)
1970 MDB_env *env = txn->mt_env;
1972 /* Close any DBI handles opened in this txn */
1973 mdb_dbis_update(txn, 0);
1975 DPRINTF("%s txn %zu%c %p on mdbenv %p, root page %zu",
1976 act, txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1977 (void *) txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root);
1979 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
1980 if (txn->mt_u.reader) {
1981 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
1982 if (!(env->me_flags & MDB_NOTLS))
1983 txn->mt_u.reader = NULL; /* txn does not own reader */
1985 txn->mt_numdbs = 0; /* close nothing if called again */
1986 txn->mt_dbxs = NULL; /* mark txn as reset */
1988 mdb_cursors_close(txn, 0);
1990 if (!(env->me_flags & MDB_WRITEMAP)) {
1991 mdb_dlist_free(txn);
1993 mdb_midl_free(env->me_pghead);
1995 if (txn->mt_parent) {
1996 txn->mt_parent->mt_child = NULL;
1997 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
1998 mdb_midl_free(txn->mt_free_pgs);
1999 free(txn->mt_u.dirty_list);
2003 if (mdb_midl_shrink(&txn->mt_free_pgs))
2004 env->me_free_pgs = txn->mt_free_pgs;
2005 env->me_pghead = NULL;
2009 /* The writer mutex was locked in mdb_txn_begin. */
2010 UNLOCK_MUTEX_W(env);
2015 mdb_txn_reset(MDB_txn *txn)
2020 /* This call is only valid for read-only txns */
2021 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2024 mdb_txn_reset0(txn, "reset");
2028 mdb_txn_abort(MDB_txn *txn)
2034 mdb_txn_abort(txn->mt_child);
2036 mdb_txn_reset0(txn, "abort");
2037 /* Free reader slot tied to this txn (if MDB_NOTLS && writable FS) */
2038 if ((txn->mt_flags & MDB_TXN_RDONLY) && txn->mt_u.reader)
2039 txn->mt_u.reader->mr_pid = 0;
2044 /** Save the freelist as of this transaction to the freeDB.
2045 * This changes the freelist. Keep trying until it stabilizes.
2048 mdb_freelist_save(MDB_txn *txn)
2050 /* env->me_pghead[] can grow and shrink during this call.
2051 * env->me_pglast and txn->mt_free_pgs[] can only grow.
2052 * Page numbers cannot disappear from txn->mt_free_pgs[].
2055 MDB_env *env = txn->mt_env;
2056 int rc, maxfree_1pg = env->me_maxfree_1pg, more = 1;
2057 txnid_t pglast = 0, head_id = 0;
2058 pgno_t freecnt = 0, *free_pgs, *mop;
2059 ssize_t head_room = 0, total_room = 0, mop_len;
2061 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
2063 if (env->me_pghead) {
2064 /* Make sure first page of freeDB is touched and on freelist */
2065 rc = mdb_page_search(&mc, NULL, MDB_PS_MODIFY);
2066 if (rc && rc != MDB_NOTFOUND)
2071 /* Come back here after each Put() in case freelist changed */
2074 /* If using records from freeDB which we have not yet
2075 * deleted, delete them and any we reserved for me_pghead.
2077 while (pglast < env->me_pglast) {
2078 rc = mdb_cursor_first(&mc, &key, NULL);
2081 pglast = head_id = *(txnid_t *)key.mv_data;
2082 total_room = head_room = 0;
2083 assert(pglast <= env->me_pglast);
2084 rc = mdb_cursor_del(&mc, 0);
2089 /* Save the IDL of pages freed by this txn, to a single record */
2090 if (freecnt < txn->mt_free_pgs[0]) {
2092 /* Make sure last page of freeDB is touched and on freelist */
2093 key.mv_size = MDB_MAXKEYSIZE+1;
2095 rc = mdb_page_search(&mc, &key, MDB_PS_MODIFY);
2096 if (rc && rc != MDB_NOTFOUND)
2099 free_pgs = txn->mt_free_pgs;
2100 /* Write to last page of freeDB */
2101 key.mv_size = sizeof(txn->mt_txnid);
2102 key.mv_data = &txn->mt_txnid;
2104 freecnt = free_pgs[0];
2105 data.mv_size = MDB_IDL_SIZEOF(free_pgs);
2106 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2109 /* Retry if mt_free_pgs[] grew during the Put() */
2110 free_pgs = txn->mt_free_pgs;
2111 } while (freecnt < free_pgs[0]);
2112 mdb_midl_sort(free_pgs);
2113 memcpy(data.mv_data, free_pgs, data.mv_size);
2116 unsigned int i = free_pgs[0];
2117 DPRINTF("IDL write txn %zu root %zu num %u",
2118 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, i);
2120 DPRINTF("IDL %zu", free_pgs[i]);
2126 mop = env->me_pghead;
2127 mop_len = mop ? mop[0] : 0;
2129 /* Reserve records for me_pghead[]. Split it if multi-page,
2130 * to avoid searching freeDB for a page range. Use keys in
2131 * range [1,me_pglast]: Smaller than txnid of oldest reader.
2133 if (total_room >= mop_len) {
2134 if (total_room == mop_len || --more < 0)
2136 } else if (head_room >= maxfree_1pg && head_id > 1) {
2137 /* Keep current record (overflow page), add a new one */
2141 /* (Re)write {key = head_id, IDL length = head_room} */
2142 total_room -= head_room;
2143 head_room = mop_len - total_room;
2144 if (head_room > maxfree_1pg && head_id > 1) {
2145 /* Overflow multi-page for part of me_pghead */
2146 head_room /= head_id; /* amortize page sizes */
2147 head_room += maxfree_1pg - head_room % (maxfree_1pg + 1);
2148 } else if (head_room < 0) {
2149 /* Rare case, not bothering to delete this record */
2152 key.mv_size = sizeof(head_id);
2153 key.mv_data = &head_id;
2154 data.mv_size = (head_room + 1) * sizeof(pgno_t);
2155 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2158 *(MDB_ID *)data.mv_data = 0; /* IDL is initially empty */
2159 total_room += head_room;
2162 /* Fill in the reserved, touched me_pghead records. Avoid write ops
2163 * so they cannot rearrange anything, just read the destinations.
2170 rc = mdb_cursor_first(&mc, &key, &data);
2171 for (; !rc; rc = mdb_cursor_next(&mc, &key, &data, MDB_NEXT)) {
2172 MDB_IDL dest = data.mv_data;
2173 ssize_t len = (ssize_t)(data.mv_size / sizeof(MDB_ID)) - 1;
2175 assert(len >= 0 && *(txnid_t*)key.mv_data <= env->me_pglast);
2179 memcpy(dest, mop -= len, len * sizeof(MDB_ID));
2180 if (! (mop_len -= len))
2187 /** Flush dirty pages to the map, after clearing their dirty flag.
2190 mdb_page_flush(MDB_txn *txn)
2192 MDB_env *env = txn->mt_env;
2193 MDB_ID2L dl = txn->mt_u.dirty_list;
2194 unsigned psize = env->me_psize;
2195 int i, pagecount = dl[0].mid, rc;
2196 size_t size = 0, pos = 0;
2198 MDB_page *dp = NULL;
2202 struct iovec iov[MDB_COMMIT_PAGES];
2203 ssize_t wpos = 0, wsize = 0, wres;
2204 size_t next_pos = 1; /* impossible pos, so pos != next_pos */
2208 if (env->me_flags & MDB_WRITEMAP) {
2209 /* Clear dirty flags */
2210 for (i = pagecount; i; i--) {
2212 dp->mp_flags &= ~P_DIRTY;
2218 /* Write the pages */
2220 if (i <= pagecount) {
2223 /* clear dirty flag */
2224 dp->mp_flags &= ~P_DIRTY;
2227 if (IS_OVERFLOW(dp)) size *= dp->mp_pages;
2232 /* Windows actually supports scatter/gather I/O, but only on
2233 * unbuffered file handles. Since we're relying on the OS page
2234 * cache for all our data, that's self-defeating. So we just
2235 * write pages one at a time. We use the ov structure to set
2236 * the write offset, to at least save the overhead of a Seek
2239 DPRINTF("committing page %zu", pgno);
2240 memset(&ov, 0, sizeof(ov));
2241 ov.Offset = pos & 0xffffffff;
2242 ov.OffsetHigh = pos >> 16 >> 16;
2243 if (!WriteFile(env->me_fd, dp, size, NULL, &ov)) {
2245 DPRINTF("WriteFile: %d", rc);
2249 /* Write up to MDB_COMMIT_PAGES dirty pages at a time. */
2250 if (pos!=next_pos || n==MDB_COMMIT_PAGES || wsize+size>MAX_WRITE) {
2252 /* Write previous page(s) */
2253 #ifdef MDB_USE_PWRITEV
2254 wres = pwritev(env->me_fd, iov, n, wpos);
2257 wres = pwrite(env->me_fd, iov[0].iov_base, wsize, wpos);
2259 if (lseek(env->me_fd, wpos, SEEK_SET) == -1) {
2261 DPRINTF("lseek: %s", strerror(rc));
2264 wres = writev(env->me_fd, iov, n);
2267 if (wres != wsize) {
2270 DPRINTF("Write error: %s", strerror(rc));
2272 rc = EIO; /* TODO: Use which error code? */
2273 DPUTS("short write, filesystem full?");
2284 DPRINTF("committing page %zu", pgno);
2285 next_pos = pos + size;
2286 iov[n].iov_len = size;
2287 iov[n].iov_base = (char *)dp;
2293 mdb_dlist_free(txn);
2299 mdb_txn_commit(MDB_txn *txn)
2305 assert(txn != NULL);
2306 assert(txn->mt_env != NULL);
2308 if (txn->mt_child) {
2309 rc = mdb_txn_commit(txn->mt_child);
2310 txn->mt_child = NULL;
2317 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2318 mdb_dbis_update(txn, 1);
2319 txn->mt_numdbs = 2; /* so txn_abort() doesn't close any new handles */
2324 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
2325 DPUTS("error flag is set, can't commit");
2327 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
2332 if (txn->mt_parent) {
2333 MDB_txn *parent = txn->mt_parent;
2337 /* Append our free list to parent's */
2338 rc = mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs);
2341 mdb_midl_free(txn->mt_free_pgs);
2343 parent->mt_next_pgno = txn->mt_next_pgno;
2344 parent->mt_flags = txn->mt_flags;
2346 /* Merge our cursors into parent's and close them */
2347 mdb_cursors_close(txn, 1);
2349 /* Update parent's DB table. */
2350 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2351 txn->mt_parent->mt_numdbs = txn->mt_numdbs;
2352 txn->mt_parent->mt_dbflags[0] = txn->mt_dbflags[0];
2353 txn->mt_parent->mt_dbflags[1] = txn->mt_dbflags[1];
2354 for (i=2; i<txn->mt_numdbs; i++) {
2355 /* preserve parent's DB_NEW status */
2356 x = txn->mt_parent->mt_dbflags[i] & DB_NEW;
2357 txn->mt_parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
2360 dst = txn->mt_parent->mt_u.dirty_list;
2361 src = txn->mt_u.dirty_list;
2362 /* Find len = length of merging our dirty list with parent's */
2364 dst[0].mid = 0; /* simplify loops */
2365 if (parent->mt_parent) {
2366 len = x + src[0].mid;
2367 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
2368 for (i = x; y && i; y--) {
2369 pgno_t yp = src[y].mid;
2370 while (yp < dst[i].mid)
2372 if (yp == dst[i].mid) {
2377 } else { /* Simplify the above for single-ancestor case */
2378 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
2380 /* Merge our dirty list with parent's */
2382 for (i = len; y; dst[i--] = src[y--]) {
2383 pgno_t yp = src[y].mid;
2384 while (yp < dst[x].mid)
2385 dst[i--] = dst[x--];
2386 if (yp == dst[x].mid)
2387 free(dst[x--].mptr);
2391 free(txn->mt_u.dirty_list);
2392 parent->mt_dirty_room = txn->mt_dirty_room;
2394 txn->mt_parent->mt_child = NULL;
2395 mdb_midl_free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pghead);
2400 if (txn != env->me_txn) {
2401 DPUTS("attempt to commit unknown transaction");
2406 mdb_cursors_close(txn, 0);
2408 if (!txn->mt_u.dirty_list[0].mid && !(txn->mt_flags & MDB_TXN_DIRTY))
2411 DPRINTF("committing txn %zu %p on mdbenv %p, root page %zu",
2412 txn->mt_txnid, (void *)txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root);
2414 /* Update DB root pointers */
2415 if (txn->mt_numdbs > 2) {
2419 data.mv_size = sizeof(MDB_db);
2421 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
2422 for (i = 2; i < txn->mt_numdbs; i++) {
2423 if (txn->mt_dbflags[i] & DB_DIRTY) {
2424 data.mv_data = &txn->mt_dbs[i];
2425 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
2432 rc = mdb_freelist_save(txn);
2436 mdb_midl_free(env->me_pghead);
2437 env->me_pghead = NULL;
2438 if (mdb_midl_shrink(&txn->mt_free_pgs))
2439 env->me_free_pgs = txn->mt_free_pgs;
2445 if ((rc = mdb_page_flush(txn)) ||
2446 (rc = mdb_env_sync(env, 0)) ||
2447 (rc = mdb_env_write_meta(txn)))
2453 mdb_dbis_update(txn, 1);
2455 UNLOCK_MUTEX_W(env);
2465 /** Read the environment parameters of a DB environment before
2466 * mapping it into memory.
2467 * @param[in] env the environment handle
2468 * @param[out] meta address of where to store the meta information
2469 * @return 0 on success, non-zero on failure.
2472 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
2479 /* We don't know the page size yet, so use a minimum value.
2480 * Read both meta pages so we can use the latest one.
2483 for (i=off=0; i<2; i++, off = meta->mm_psize) {
2487 memset(&ov, 0, sizeof(ov));
2489 rc = ReadFile(env->me_fd,&pbuf,MDB_PAGESIZE,&len,&ov) ? (int)len : -1;
2491 rc = pread(env->me_fd, &pbuf, MDB_PAGESIZE, off);
2493 if (rc != MDB_PAGESIZE) {
2494 if (rc == 0 && off == 0)
2496 rc = rc < 0 ? (int) ErrCode() : MDB_INVALID;
2497 DPRINTF("read: %s", mdb_strerror(rc));
2501 p = (MDB_page *)&pbuf;
2503 if (!F_ISSET(p->mp_flags, P_META)) {
2504 DPRINTF("page %zu not a meta page", p->mp_pgno);
2509 if (m->mm_magic != MDB_MAGIC) {
2510 DPUTS("meta has invalid magic");
2514 if (m->mm_version != MDB_VERSION) {
2515 DPRINTF("database is version %u, expected version %u",
2516 m->mm_version, MDB_VERSION);
2517 return MDB_VERSION_MISMATCH;
2520 if (off == 0 || m->mm_txnid > meta->mm_txnid)
2526 /** Write the environment parameters of a freshly created DB environment.
2527 * @param[in] env the environment handle
2528 * @param[out] meta address of where to store the meta information
2529 * @return 0 on success, non-zero on failure.
2532 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
2538 DPUTS("writing new meta page");
2540 GET_PAGESIZE(psize);
2542 meta->mm_magic = MDB_MAGIC;
2543 meta->mm_version = MDB_VERSION;
2544 meta->mm_mapsize = env->me_mapsize;
2545 meta->mm_psize = psize;
2546 meta->mm_last_pg = 1;
2547 meta->mm_flags = env->me_flags & 0xffff;
2548 meta->mm_flags |= MDB_INTEGERKEY;
2549 meta->mm_dbs[0].md_root = P_INVALID;
2550 meta->mm_dbs[1].md_root = P_INVALID;
2552 p = calloc(2, psize);
2554 p->mp_flags = P_META;
2555 *(MDB_meta *)METADATA(p) = *meta;
2557 q = (MDB_page *)((char *)p + psize);
2559 q->mp_flags = P_META;
2560 *(MDB_meta *)METADATA(q) = *meta;
2566 memset(&ov, 0, sizeof(ov));
2567 rc = WriteFile(env->me_fd, p, psize * 2, &len, &ov);
2568 rc = rc ? (len == psize * 2 ? MDB_SUCCESS : EIO) : ErrCode();
2571 rc = pwrite(env->me_fd, p, psize * 2, 0);
2572 rc = (rc == (int)psize * 2) ? MDB_SUCCESS : rc < 0 ? ErrCode() : EIO;
2578 /** Update the environment info to commit a transaction.
2579 * @param[in] txn the transaction that's being committed
2580 * @return 0 on success, non-zero on failure.
2583 mdb_env_write_meta(MDB_txn *txn)
2586 MDB_meta meta, metab, *mp;
2588 int rc, len, toggle;
2597 assert(txn != NULL);
2598 assert(txn->mt_env != NULL);
2600 toggle = !txn->mt_toggle;
2601 DPRINTF("writing meta page %d for root page %zu",
2602 toggle, txn->mt_dbs[MAIN_DBI].md_root);
2605 mp = env->me_metas[toggle];
2607 if (env->me_flags & MDB_WRITEMAP) {
2608 /* Persist any increases of mapsize config */
2609 if (env->me_mapsize > mp->mm_mapsize)
2610 mp->mm_mapsize = env->me_mapsize;
2611 mp->mm_dbs[0] = txn->mt_dbs[0];
2612 mp->mm_dbs[1] = txn->mt_dbs[1];
2613 mp->mm_last_pg = txn->mt_next_pgno - 1;
2614 mp->mm_txnid = txn->mt_txnid;
2615 if (!(env->me_flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
2616 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
2619 ptr += env->me_psize;
2620 if (MDB_MSYNC(ptr, env->me_psize, rc)) {
2627 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
2628 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
2630 ptr = (char *)&meta;
2631 if (env->me_mapsize > mp->mm_mapsize) {
2632 /* Persist any increases of mapsize config */
2633 meta.mm_mapsize = env->me_mapsize;
2634 off = offsetof(MDB_meta, mm_mapsize);
2636 off = offsetof(MDB_meta, mm_dbs[0].md_depth);
2638 len = sizeof(MDB_meta) - off;
2641 meta.mm_dbs[0] = txn->mt_dbs[0];
2642 meta.mm_dbs[1] = txn->mt_dbs[1];
2643 meta.mm_last_pg = txn->mt_next_pgno - 1;
2644 meta.mm_txnid = txn->mt_txnid;
2647 off += env->me_psize;
2650 /* Write to the SYNC fd */
2651 mfd = env->me_flags & (MDB_NOSYNC|MDB_NOMETASYNC) ?
2652 env->me_fd : env->me_mfd;
2655 memset(&ov, 0, sizeof(ov));
2657 if (!WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov))
2661 rc = pwrite(mfd, ptr, len, off);
2664 rc = rc < 0 ? ErrCode() : EIO;
2665 DPUTS("write failed, disk error?");
2666 /* On a failure, the pagecache still contains the new data.
2667 * Write some old data back, to prevent it from being used.
2668 * Use the non-SYNC fd; we know it will fail anyway.
2670 meta.mm_last_pg = metab.mm_last_pg;
2671 meta.mm_txnid = metab.mm_txnid;
2673 memset(&ov, 0, sizeof(ov));
2675 WriteFile(env->me_fd, ptr, len, NULL, &ov);
2677 r2 = pwrite(env->me_fd, ptr, len, off);
2680 env->me_flags |= MDB_FATAL_ERROR;
2684 /* Memory ordering issues are irrelevant; since the entire writer
2685 * is wrapped by wmutex, all of these changes will become visible
2686 * after the wmutex is unlocked. Since the DB is multi-version,
2687 * readers will get consistent data regardless of how fresh or
2688 * how stale their view of these values is.
2690 env->me_txns->mti_txnid = txn->mt_txnid;
2695 /** Check both meta pages to see which one is newer.
2696 * @param[in] env the environment handle
2697 * @return meta toggle (0 or 1).
2700 mdb_env_pick_meta(const MDB_env *env)
2702 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
2706 mdb_env_create(MDB_env **env)
2710 e = calloc(1, sizeof(MDB_env));
2714 e->me_maxreaders = DEFAULT_READERS;
2715 e->me_maxdbs = e->me_numdbs = 2;
2716 e->me_fd = INVALID_HANDLE_VALUE;
2717 e->me_lfd = INVALID_HANDLE_VALUE;
2718 e->me_mfd = INVALID_HANDLE_VALUE;
2719 #ifdef MDB_USE_POSIX_SEM
2720 e->me_rmutex = SEM_FAILED;
2721 e->me_wmutex = SEM_FAILED;
2723 e->me_pid = getpid();
2724 VGMEMP_CREATE(e,0,0);
2730 mdb_env_set_mapsize(MDB_env *env, size_t size)
2734 env->me_mapsize = size;
2736 env->me_maxpg = env->me_mapsize / env->me_psize;
2741 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
2745 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
2750 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
2752 if (env->me_map || readers < 1)
2754 env->me_maxreaders = readers;
2759 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
2761 if (!env || !readers)
2763 *readers = env->me_maxreaders;
2767 /** Further setup required for opening an MDB environment
2770 mdb_env_open2(MDB_env *env)
2772 unsigned int flags = env->me_flags;
2780 memset(&meta, 0, sizeof(meta));
2782 if ((i = mdb_env_read_header(env, &meta)) != 0) {
2785 DPUTS("new mdbenv");
2789 /* Was a mapsize configured? */
2790 if (!env->me_mapsize) {
2791 /* If this is a new environment, take the default,
2792 * else use the size recorded in the existing env.
2794 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
2795 } else if (env->me_mapsize < meta.mm_mapsize) {
2796 /* If the configured size is smaller, make sure it's
2797 * still big enough. Silently round up to minimum if not.
2799 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
2800 if (env->me_mapsize < minsize)
2801 env->me_mapsize = minsize;
2808 LONG sizelo, sizehi;
2809 sizelo = env->me_mapsize & 0xffffffff;
2810 sizehi = env->me_mapsize >> 16 >> 16; /* only needed on Win64 */
2811 /* Windows won't create mappings for zero length files.
2812 * Just allocate the maxsize right now.
2815 if (SetFilePointer(env->me_fd, sizelo, &sizehi, 0) != (DWORD)sizelo
2816 || !SetEndOfFile(env->me_fd)
2817 || SetFilePointer(env->me_fd, 0, NULL, 0) != 0)
2820 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
2821 PAGE_READWRITE : PAGE_READONLY,
2822 sizehi, sizelo, NULL);
2825 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
2826 FILE_MAP_WRITE : FILE_MAP_READ,
2827 0, 0, env->me_mapsize, meta.mm_address);
2828 rc = env->me_map ? 0 : ErrCode();
2836 if (flags & MDB_WRITEMAP) {
2838 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
2841 env->me_map = mmap(meta.mm_address, env->me_mapsize, prot, i,
2843 if (env->me_map == MAP_FAILED) {
2847 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
2849 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
2851 #ifdef POSIX_MADV_RANDOM
2852 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
2853 #endif /* POSIX_MADV_RANDOM */
2854 #endif /* MADV_RANDOM */
2858 if (flags & MDB_FIXEDMAP)
2859 meta.mm_address = env->me_map;
2860 i = mdb_env_init_meta(env, &meta);
2861 if (i != MDB_SUCCESS) {
2864 } else if (meta.mm_address && env->me_map != meta.mm_address) {
2865 /* Can happen because the address argument to mmap() is just a
2866 * hint. mmap() can pick another, e.g. if the range is in use.
2867 * The MAP_FIXED flag would prevent that, but then mmap could
2868 * instead unmap existing pages to make room for the new map.
2870 return EBUSY; /* TODO: Make a new MDB_* error code? */
2872 env->me_psize = meta.mm_psize;
2873 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
2874 env->me_nodemax = (env->me_psize - PAGEHDRSZ) / MDB_MINKEYS;
2876 env->me_maxpg = env->me_mapsize / env->me_psize;
2878 p = (MDB_page *)env->me_map;
2879 env->me_metas[0] = METADATA(p);
2880 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + meta.mm_psize);
2884 int toggle = mdb_env_pick_meta(env);
2885 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
2887 DPRINTF("opened database version %u, pagesize %u",
2888 env->me_metas[0]->mm_version, env->me_psize);
2889 DPRINTF("using meta page %d", toggle);
2890 DPRINTF("depth: %u", db->md_depth);
2891 DPRINTF("entries: %zu", db->md_entries);
2892 DPRINTF("branch pages: %zu", db->md_branch_pages);
2893 DPRINTF("leaf pages: %zu", db->md_leaf_pages);
2894 DPRINTF("overflow pages: %zu", db->md_overflow_pages);
2895 DPRINTF("root: %zu", db->md_root);
2903 /** Release a reader thread's slot in the reader lock table.
2904 * This function is called automatically when a thread exits.
2905 * @param[in] ptr This points to the slot in the reader lock table.
2908 mdb_env_reader_dest(void *ptr)
2910 MDB_reader *reader = ptr;
2916 /** Junk for arranging thread-specific callbacks on Windows. This is
2917 * necessarily platform and compiler-specific. Windows supports up
2918 * to 1088 keys. Let's assume nobody opens more than 64 environments
2919 * in a single process, for now. They can override this if needed.
2921 #ifndef MAX_TLS_KEYS
2922 #define MAX_TLS_KEYS 64
2924 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
2925 static int mdb_tls_nkeys;
2927 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
2931 case DLL_PROCESS_ATTACH: break;
2932 case DLL_THREAD_ATTACH: break;
2933 case DLL_THREAD_DETACH:
2934 for (i=0; i<mdb_tls_nkeys; i++) {
2935 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
2936 mdb_env_reader_dest(r);
2939 case DLL_PROCESS_DETACH: break;
2944 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
2946 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
2950 /* Force some symbol references.
2951 * _tls_used forces the linker to create the TLS directory if not already done
2952 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
2954 #pragma comment(linker, "/INCLUDE:_tls_used")
2955 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
2956 #pragma const_seg(".CRT$XLB")
2957 extern const PIMAGE_TLS_CALLBACK mdb_tls_callback;
2958 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
2961 #pragma comment(linker, "/INCLUDE:__tls_used")
2962 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
2963 #pragma data_seg(".CRT$XLB")
2964 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
2966 #endif /* WIN 32/64 */
2967 #endif /* !__GNUC__ */
2970 /** Downgrade the exclusive lock on the region back to shared */
2972 mdb_env_share_locks(MDB_env *env, int *excl)
2974 int rc = 0, toggle = mdb_env_pick_meta(env);
2976 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
2981 /* First acquire a shared lock. The Unlock will
2982 * then release the existing exclusive lock.
2984 memset(&ov, 0, sizeof(ov));
2985 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
2988 UnlockFile(env->me_lfd, 0, 0, 1, 0);
2994 struct flock lock_info;
2995 /* The shared lock replaces the existing lock */
2996 memset((void *)&lock_info, 0, sizeof(lock_info));
2997 lock_info.l_type = F_RDLCK;
2998 lock_info.l_whence = SEEK_SET;
2999 lock_info.l_start = 0;
3000 lock_info.l_len = 1;
3001 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3002 (rc = ErrCode()) == EINTR) ;
3003 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
3010 /** Try to get exlusive lock, otherwise shared.
3011 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
3014 mdb_env_excl_lock(MDB_env *env, int *excl)
3018 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
3022 memset(&ov, 0, sizeof(ov));
3023 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3030 struct flock lock_info;
3031 memset((void *)&lock_info, 0, sizeof(lock_info));
3032 lock_info.l_type = F_WRLCK;
3033 lock_info.l_whence = SEEK_SET;
3034 lock_info.l_start = 0;
3035 lock_info.l_len = 1;
3036 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3037 (rc = ErrCode()) == EINTR) ;
3041 # ifdef MDB_USE_POSIX_SEM
3042 if (*excl < 0) /* always true when !MDB_USE_POSIX_SEM */
3045 lock_info.l_type = F_RDLCK;
3046 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
3047 (rc = ErrCode()) == EINTR) ;
3055 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
3057 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
3059 * @(#) $Revision: 5.1 $
3060 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
3061 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
3063 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
3067 * Please do not copyright this code. This code is in the public domain.
3069 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
3070 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
3071 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
3072 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
3073 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
3074 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
3075 * PERFORMANCE OF THIS SOFTWARE.
3078 * chongo <Landon Curt Noll> /\oo/\
3079 * http://www.isthe.com/chongo/
3081 * Share and Enjoy! :-)
3084 typedef unsigned long long mdb_hash_t;
3085 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
3087 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
3088 * @param[in] str string to hash
3089 * @param[in] hval initial value for hash
3090 * @return 64 bit hash
3092 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
3093 * hval arg on the first call.
3096 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
3098 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
3099 unsigned char *end = s + val->mv_size;
3101 * FNV-1a hash each octet of the string
3104 /* xor the bottom with the current octet */
3105 hval ^= (mdb_hash_t)*s++;
3107 /* multiply by the 64 bit FNV magic prime mod 2^64 */
3108 hval += (hval << 1) + (hval << 4) + (hval << 5) +
3109 (hval << 7) + (hval << 8) + (hval << 40);
3111 /* return our new hash value */
3115 /** Hash the string and output the hash in hex.
3116 * @param[in] str string to hash
3117 * @param[out] hexbuf an array of 17 chars to hold the hash
3120 mdb_hash_hex(MDB_val *val, char *hexbuf)
3123 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
3124 for (i=0; i<8; i++) {
3125 hexbuf += sprintf(hexbuf, "%02x", (unsigned int)h & 0xff);
3131 /** Open and/or initialize the lock region for the environment.
3132 * @param[in] env The MDB environment.
3133 * @param[in] lpath The pathname of the file used for the lock region.
3134 * @param[in] mode The Unix permissions for the file, if we create it.
3135 * @param[out] excl Resulting file lock type: -1 none, 0 shared, 1 exclusive
3136 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
3137 * @return 0 on success, non-zero on failure.
3140 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
3143 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
3145 # define MDB_ERRCODE_ROFS EROFS
3146 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
3147 # define MDB_CLOEXEC O_CLOEXEC
3150 # define MDB_CLOEXEC 0
3157 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
3158 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
3159 FILE_ATTRIBUTE_NORMAL, NULL);
3161 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
3163 if (env->me_lfd == INVALID_HANDLE_VALUE) {
3165 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
3170 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
3171 /* Lose record locks when exec*() */
3172 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
3173 fcntl(env->me_lfd, F_SETFD, fdflags);
3176 if (!(env->me_flags & MDB_NOTLS)) {
3177 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
3180 env->me_flags |= MDB_ENV_TXKEY;
3182 /* Windows TLS callbacks need help finding their TLS info. */
3183 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
3187 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
3191 /* Try to get exclusive lock. If we succeed, then
3192 * nobody is using the lock region and we should initialize it.
3194 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
3197 size = GetFileSize(env->me_lfd, NULL);
3199 size = lseek(env->me_lfd, 0, SEEK_END);
3200 if (size == -1) goto fail_errno;
3202 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
3203 if (size < rsize && *excl > 0) {
3205 if (SetFilePointer(env->me_lfd, rsize, NULL, FILE_BEGIN) != rsize
3206 || !SetEndOfFile(env->me_lfd))
3209 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
3213 size = rsize - sizeof(MDB_txninfo);
3214 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
3219 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
3221 if (!mh) goto fail_errno;
3222 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
3224 if (!env->me_txns) goto fail_errno;
3226 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
3228 if (m == MAP_FAILED) goto fail_errno;
3234 BY_HANDLE_FILE_INFORMATION stbuf;
3243 if (!mdb_sec_inited) {
3244 InitializeSecurityDescriptor(&mdb_null_sd,
3245 SECURITY_DESCRIPTOR_REVISION);
3246 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
3247 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
3248 mdb_all_sa.bInheritHandle = FALSE;
3249 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
3252 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
3253 idbuf.volume = stbuf.dwVolumeSerialNumber;
3254 idbuf.nhigh = stbuf.nFileIndexHigh;
3255 idbuf.nlow = stbuf.nFileIndexLow;
3256 val.mv_data = &idbuf;
3257 val.mv_size = sizeof(idbuf);
3258 mdb_hash_hex(&val, hexbuf);
3259 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", hexbuf);
3260 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", hexbuf);
3261 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
3262 if (!env->me_rmutex) goto fail_errno;
3263 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
3264 if (!env->me_wmutex) goto fail_errno;
3265 #elif defined(MDB_USE_POSIX_SEM)
3274 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
3275 idbuf.dev = stbuf.st_dev;
3276 idbuf.ino = stbuf.st_ino;
3277 val.mv_data = &idbuf;
3278 val.mv_size = sizeof(idbuf);
3279 mdb_hash_hex(&val, hexbuf);
3280 sprintf(env->me_txns->mti_rmname, "/MDBr%s", hexbuf);
3281 sprintf(env->me_txns->mti_wmname, "/MDBw%s", hexbuf);
3282 /* Clean up after a previous run, if needed: Try to
3283 * remove both semaphores before doing anything else.
3285 sem_unlink(env->me_txns->mti_rmname);
3286 sem_unlink(env->me_txns->mti_wmname);
3287 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
3288 O_CREAT|O_EXCL, mode, 1);
3289 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3290 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
3291 O_CREAT|O_EXCL, mode, 1);
3292 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3293 #else /* MDB_USE_POSIX_SEM */
3294 pthread_mutexattr_t mattr;
3296 if ((rc = pthread_mutexattr_init(&mattr))
3297 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
3298 || (rc = pthread_mutex_init(&env->me_txns->mti_mutex, &mattr))
3299 || (rc = pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr)))
3301 pthread_mutexattr_destroy(&mattr);
3302 #endif /* _WIN32 || MDB_USE_POSIX_SEM */
3304 env->me_txns->mti_version = MDB_VERSION;
3305 env->me_txns->mti_magic = MDB_MAGIC;
3306 env->me_txns->mti_txnid = 0;
3307 env->me_txns->mti_numreaders = 0;
3310 if (env->me_txns->mti_magic != MDB_MAGIC) {
3311 DPUTS("lock region has invalid magic");
3315 if (env->me_txns->mti_version != MDB_VERSION) {
3316 DPRINTF("lock region is version %u, expected version %u",
3317 env->me_txns->mti_version, MDB_VERSION);
3318 rc = MDB_VERSION_MISMATCH;
3322 if (rc && rc != EACCES && rc != EAGAIN) {
3326 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
3327 if (!env->me_rmutex) goto fail_errno;
3328 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
3329 if (!env->me_wmutex) goto fail_errno;
3330 #elif defined(MDB_USE_POSIX_SEM)
3331 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
3332 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
3333 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
3334 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
3345 /** The name of the lock file in the DB environment */
3346 #define LOCKNAME "/lock.mdb"
3347 /** The name of the data file in the DB environment */
3348 #define DATANAME "/data.mdb"
3349 /** The suffix of the lock file when no subdir is used */
3350 #define LOCKSUFF "-lock"
3351 /** Only a subset of the @ref mdb_env flags can be changed
3352 * at runtime. Changing other flags requires closing the
3353 * environment and re-opening it with the new flags.
3355 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC)
3356 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY|MDB_WRITEMAP|MDB_NOTLS)
3359 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
3361 int oflags, rc, len, excl = -1;
3362 char *lpath, *dpath;
3364 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
3368 if (flags & MDB_NOSUBDIR) {
3369 rc = len + sizeof(LOCKSUFF) + len + 1;
3371 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
3376 if (flags & MDB_NOSUBDIR) {
3377 dpath = lpath + len + sizeof(LOCKSUFF);
3378 sprintf(lpath, "%s" LOCKSUFF, path);
3379 strcpy(dpath, path);
3381 dpath = lpath + len + sizeof(LOCKNAME);
3382 sprintf(lpath, "%s" LOCKNAME, path);
3383 sprintf(dpath, "%s" DATANAME, path);
3387 flags |= env->me_flags;
3388 if (flags & MDB_RDONLY) {
3389 /* silently ignore WRITEMAP when we're only getting read access */
3390 flags &= ~MDB_WRITEMAP;
3392 if (!((env->me_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)) &&
3393 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
3396 env->me_flags = flags |= MDB_ENV_ACTIVE;
3400 env->me_path = strdup(path);
3401 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
3402 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
3403 if (!(env->me_dbxs && env->me_path && env->me_dbflags)) {
3408 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
3413 if (F_ISSET(flags, MDB_RDONLY)) {
3414 oflags = GENERIC_READ;
3415 len = OPEN_EXISTING;
3417 oflags = GENERIC_READ|GENERIC_WRITE;
3420 mode = FILE_ATTRIBUTE_NORMAL;
3421 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
3422 NULL, len, mode, NULL);
3424 if (F_ISSET(flags, MDB_RDONLY))
3427 oflags = O_RDWR | O_CREAT;
3429 env->me_fd = open(dpath, oflags, mode);
3431 if (env->me_fd == INVALID_HANDLE_VALUE) {
3436 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
3437 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
3438 env->me_mfd = env->me_fd;
3440 /* Synchronous fd for meta writes. Needed even with
3441 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
3444 env->me_mfd = CreateFile(dpath, oflags,
3445 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
3446 mode | FILE_FLAG_WRITE_THROUGH, NULL);
3448 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
3450 if (env->me_mfd == INVALID_HANDLE_VALUE) {
3455 DPRINTF("opened dbenv %p", (void *) env);
3457 rc = mdb_env_share_locks(env, &excl);
3463 mdb_env_close0(env, excl);
3469 /** Destroy resources from mdb_env_open(), clear our readers & DBIs */
3471 mdb_env_close0(MDB_env *env, int excl)
3475 if (!(env->me_flags & MDB_ENV_ACTIVE))
3478 /* Doing this here since me_dbxs may not exist during mdb_env_close */
3479 for (i = env->me_maxdbs; --i > MAIN_DBI; )
3480 free(env->me_dbxs[i].md_name.mv_data);
3482 free(env->me_dbflags);
3485 free(env->me_dirty_list);
3486 mdb_midl_free(env->me_free_pgs);
3488 if (env->me_flags & MDB_ENV_TXKEY) {
3489 pthread_key_delete(env->me_txkey);
3491 /* Delete our key from the global list */
3492 for (i=0; i<mdb_tls_nkeys; i++)
3493 if (mdb_tls_keys[i] == env->me_txkey) {
3494 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
3502 munmap(env->me_map, env->me_mapsize);
3504 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
3505 (void) close(env->me_mfd);
3506 if (env->me_fd != INVALID_HANDLE_VALUE)
3507 (void) close(env->me_fd);
3509 pid_t pid = env->me_pid;
3510 /* Clearing readers is done in this function because
3511 * me_txkey with its destructor must be disabled first.
3513 for (i = env->me_numreaders; --i >= 0; )
3514 if (env->me_txns->mti_readers[i].mr_pid == pid)
3515 env->me_txns->mti_readers[i].mr_pid = 0;
3517 if (env->me_rmutex) {
3518 CloseHandle(env->me_rmutex);
3519 if (env->me_wmutex) CloseHandle(env->me_wmutex);
3521 /* Windows automatically destroys the mutexes when
3522 * the last handle closes.
3524 #elif defined(MDB_USE_POSIX_SEM)
3525 if (env->me_rmutex != SEM_FAILED) {
3526 sem_close(env->me_rmutex);
3527 if (env->me_wmutex != SEM_FAILED)
3528 sem_close(env->me_wmutex);
3529 /* If we have the filelock: If we are the
3530 * only remaining user, clean up semaphores.
3533 mdb_env_excl_lock(env, &excl);
3535 sem_unlink(env->me_txns->mti_rmname);
3536 sem_unlink(env->me_txns->mti_wmname);
3540 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
3542 if (env->me_lfd != INVALID_HANDLE_VALUE) {
3545 /* Unlock the lockfile. Windows would have unlocked it
3546 * after closing anyway, but not necessarily at once.
3548 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3551 (void) close(env->me_lfd);
3554 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
3558 mdb_env_copyfd(MDB_env *env, HANDLE fd)
3560 MDB_txn *txn = NULL;
3565 /* Do the lock/unlock of the reader mutex before starting the
3566 * write txn. Otherwise other read txns could block writers.
3568 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
3573 /* We must start the actual read txn after blocking writers */
3574 mdb_txn_reset0(txn, "reset-stage1");
3576 /* Temporarily block writers until we snapshot the meta pages */
3579 rc = mdb_txn_renew0(txn);
3581 UNLOCK_MUTEX_W(env);
3586 wsize = env->me_psize * 2;
3590 rc = WriteFile(fd, env->me_map, wsize, &len, NULL);
3591 rc = rc ? (len == wsize ? MDB_SUCCESS : EIO) : ErrCode();
3594 rc = write(fd, env->me_map, wsize);
3595 rc = rc == (int)wsize ? MDB_SUCCESS : rc < 0 ? ErrCode() : EIO;
3598 UNLOCK_MUTEX_W(env);
3603 ptr = env->me_map + wsize;
3604 wsize = txn->mt_next_pgno * env->me_psize - wsize;
3608 if (wsize > MAX_WRITE)
3612 rc = WriteFile(fd, ptr, w2, &len, NULL);
3613 rc = rc ? (len == w2 ? MDB_SUCCESS : EIO) : ErrCode();
3622 if (wsize > MAX_WRITE)
3626 wres = write(fd, ptr, w2);
3627 rc = wres == (ssize_t)w2 ? MDB_SUCCESS : wres < 0 ? ErrCode() : EIO;
3640 mdb_env_copy(MDB_env *env, const char *path)
3644 HANDLE newfd = INVALID_HANDLE_VALUE;
3646 if (env->me_flags & MDB_NOSUBDIR) {
3647 lpath = (char *)path;
3650 len += sizeof(DATANAME);
3651 lpath = malloc(len);
3654 sprintf(lpath, "%s" DATANAME, path);
3657 /* The destination path must exist, but the destination file must not.
3658 * We don't want the OS to cache the writes, since the source data is
3659 * already in the OS cache.
3662 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
3663 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
3665 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL
3671 if (newfd == INVALID_HANDLE_VALUE) {
3676 #ifdef F_NOCACHE /* __APPLE__ */
3677 rc = fcntl(newfd, F_NOCACHE, 1);
3684 rc = mdb_env_copyfd(env, newfd);
3687 if (!(env->me_flags & MDB_NOSUBDIR))
3689 if (newfd != INVALID_HANDLE_VALUE)
3690 if (close(newfd) < 0 && rc == MDB_SUCCESS)
3697 mdb_env_close(MDB_env *env)
3704 VGMEMP_DESTROY(env);
3705 while ((dp = env->me_dpages) != NULL) {
3706 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
3707 env->me_dpages = dp->mp_next;
3711 mdb_env_close0(env, 0);
3715 /** Compare two items pointing at aligned size_t's */
3717 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
3719 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
3720 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
3723 /** Compare two items pointing at aligned int's */
3725 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
3727 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
3728 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
3731 /** Compare two items pointing at ints of unknown alignment.
3732 * Nodes and keys are guaranteed to be 2-byte aligned.
3735 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
3737 #if BYTE_ORDER == LITTLE_ENDIAN
3738 unsigned short *u, *c;
3741 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
3742 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
3745 } while(!x && u > (unsigned short *)a->mv_data);
3748 return memcmp(a->mv_data, b->mv_data, a->mv_size);
3752 /** Compare two items lexically */
3754 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
3761 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3767 diff = memcmp(a->mv_data, b->mv_data, len);
3768 return diff ? diff : len_diff<0 ? -1 : len_diff;
3771 /** Compare two items in reverse byte order */
3773 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
3775 const unsigned char *p1, *p2, *p1_lim;
3779 p1_lim = (const unsigned char *)a->mv_data;
3780 p1 = (const unsigned char *)a->mv_data + a->mv_size;
3781 p2 = (const unsigned char *)b->mv_data + b->mv_size;
3783 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3789 while (p1 > p1_lim) {
3790 diff = *--p1 - *--p2;
3794 return len_diff<0 ? -1 : len_diff;
3797 /** Search for key within a page, using binary search.
3798 * Returns the smallest entry larger or equal to the key.
3799 * If exactp is non-null, stores whether the found entry was an exact match
3800 * in *exactp (1 or 0).
3801 * Updates the cursor index with the index of the found entry.
3802 * If no entry larger or equal to the key is found, returns NULL.
3805 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
3807 unsigned int i = 0, nkeys;
3810 MDB_page *mp = mc->mc_pg[mc->mc_top];
3811 MDB_node *node = NULL;
3816 nkeys = NUMKEYS(mp);
3821 COPY_PGNO(pgno, mp->mp_pgno);
3822 DPRINTF("searching %u keys in %s %spage %zu",
3823 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
3830 low = IS_LEAF(mp) ? 0 : 1;
3832 cmp = mc->mc_dbx->md_cmp;
3834 /* Branch pages have no data, so if using integer keys,
3835 * alignment is guaranteed. Use faster mdb_cmp_int.
3837 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
3838 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
3845 nodekey.mv_size = mc->mc_db->md_pad;
3846 node = NODEPTR(mp, 0); /* fake */
3847 while (low <= high) {
3848 i = (low + high) >> 1;
3849 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
3850 rc = cmp(key, &nodekey);
3851 DPRINTF("found leaf index %u [%s], rc = %i",
3852 i, DKEY(&nodekey), rc);
3861 while (low <= high) {
3862 i = (low + high) >> 1;
3864 node = NODEPTR(mp, i);
3865 nodekey.mv_size = NODEKSZ(node);
3866 nodekey.mv_data = NODEKEY(node);
3868 rc = cmp(key, &nodekey);
3871 DPRINTF("found leaf index %u [%s], rc = %i",
3872 i, DKEY(&nodekey), rc);
3874 DPRINTF("found branch index %u [%s -> %zu], rc = %i",
3875 i, DKEY(&nodekey), NODEPGNO(node), rc);
3886 if (rc > 0) { /* Found entry is less than the key. */
3887 i++; /* Skip to get the smallest entry larger than key. */
3889 node = NODEPTR(mp, i);
3892 *exactp = (rc == 0);
3893 /* store the key index */
3894 mc->mc_ki[mc->mc_top] = i;
3896 /* There is no entry larger or equal to the key. */
3899 /* nodeptr is fake for LEAF2 */
3905 mdb_cursor_adjust(MDB_cursor *mc, func)
3909 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
3910 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
3917 /** Pop a page off the top of the cursor's stack. */
3919 mdb_cursor_pop(MDB_cursor *mc)
3922 #ifndef MDB_DEBUG_SKIP
3923 MDB_page *top = mc->mc_pg[mc->mc_top];
3929 DPRINTF("popped page %zu off db %u cursor %p", top->mp_pgno,
3930 mc->mc_dbi, (void *) mc);
3934 /** Push a page onto the top of the cursor's stack. */
3936 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
3938 DPRINTF("pushing page %zu on db %u cursor %p", mp->mp_pgno,
3939 mc->mc_dbi, (void *) mc);
3941 if (mc->mc_snum >= CURSOR_STACK) {
3942 assert(mc->mc_snum < CURSOR_STACK);
3943 return MDB_CURSOR_FULL;
3946 mc->mc_top = mc->mc_snum++;
3947 mc->mc_pg[mc->mc_top] = mp;
3948 mc->mc_ki[mc->mc_top] = 0;
3953 /** Find the address of the page corresponding to a given page number.
3954 * @param[in] txn the transaction for this access.
3955 * @param[in] pgno the page number for the page to retrieve.
3956 * @param[out] ret address of a pointer where the page's address will be stored.
3957 * @param[out] lvl dirty_list inheritance level of found page. 1=current txn, 0=mapped page.
3958 * @return 0 on success, non-zero on failure.
3961 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret, int *lvl)
3966 if (!((txn->mt_flags & MDB_TXN_RDONLY) |
3967 (txn->mt_env->me_flags & MDB_WRITEMAP)))
3972 MDB_ID2L dl = tx2->mt_u.dirty_list;
3974 unsigned x = mdb_mid2l_search(dl, pgno);
3975 if (x <= dl[0].mid && dl[x].mid == pgno) {
3981 } while ((tx2 = tx2->mt_parent) != NULL);
3984 if (pgno < txn->mt_next_pgno) {
3986 p = (MDB_page *)(txn->mt_env->me_map + txn->mt_env->me_psize * pgno);
3988 DPRINTF("page %zu not found", pgno);
3990 return MDB_PAGE_NOTFOUND;
4000 /** Search for the page a given key should be in.
4001 * Pushes parent pages on the cursor stack. This function continues a
4002 * search on a cursor that has already been initialized. (Usually by
4003 * #mdb_page_search() but also by #mdb_node_move().)
4004 * @param[in,out] mc the cursor for this operation.
4005 * @param[in] key the key to search for. If NULL, search for the lowest
4006 * page. (This is used by #mdb_cursor_first().)
4007 * @param[in] modify If true, visited pages are updated with new page numbers.
4008 * @return 0 on success, non-zero on failure.
4011 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int modify)
4013 MDB_page *mp = mc->mc_pg[mc->mc_top];
4018 while (IS_BRANCH(mp)) {
4022 DPRINTF("branch page %zu has %u keys", mp->mp_pgno, NUMKEYS(mp));
4023 assert(NUMKEYS(mp) > 1);
4024 DPRINTF("found index 0 to page %zu", NODEPGNO(NODEPTR(mp, 0)));
4026 if (key == NULL) /* Initialize cursor to first page. */
4028 else if (key->mv_size > MDB_MAXKEYSIZE && key->mv_data == NULL) {
4029 /* cursor to last page */
4033 node = mdb_node_search(mc, key, &exact);
4035 i = NUMKEYS(mp) - 1;
4037 i = mc->mc_ki[mc->mc_top];
4046 DPRINTF("following index %u for key [%s]",
4048 assert(i < NUMKEYS(mp));
4049 node = NODEPTR(mp, i);
4051 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
4054 mc->mc_ki[mc->mc_top] = i;
4055 if ((rc = mdb_cursor_push(mc, mp)))
4059 if ((rc = mdb_page_touch(mc)) != 0)
4061 mp = mc->mc_pg[mc->mc_top];
4066 DPRINTF("internal error, index points to a %02X page!?",
4068 return MDB_CORRUPTED;
4071 DPRINTF("found leaf page %zu for key [%s]", mp->mp_pgno,
4072 key ? DKEY(key) : NULL);
4077 /** Search for the lowest key under the current branch page.
4078 * This just bypasses a NUMKEYS check in the current page
4079 * before calling mdb_page_search_root(), because the callers
4080 * are all in situations where the current page is known to
4084 mdb_page_search_lowest(MDB_cursor *mc)
4086 MDB_page *mp = mc->mc_pg[mc->mc_top];
4087 MDB_node *node = NODEPTR(mp, 0);
4090 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
4093 mc->mc_ki[mc->mc_top] = 0;
4094 if ((rc = mdb_cursor_push(mc, mp)))
4096 return mdb_page_search_root(mc, NULL, 0);
4099 /** Search for the page a given key should be in.
4100 * Pushes parent pages on the cursor stack. This function just sets up
4101 * the search; it finds the root page for \b mc's database and sets this
4102 * as the root of the cursor's stack. Then #mdb_page_search_root() is
4103 * called to complete the search.
4104 * @param[in,out] mc the cursor for this operation.
4105 * @param[in] key the key to search for. If NULL, search for the lowest
4106 * page. (This is used by #mdb_cursor_first().)
4107 * @param[in] flags If MDB_PS_MODIFY set, visited pages are updated with new page numbers.
4108 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
4109 * @return 0 on success, non-zero on failure.
4112 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
4117 /* Make sure the txn is still viable, then find the root from
4118 * the txn's db table.
4120 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
4121 DPUTS("transaction has failed, must abort");
4124 /* Make sure we're using an up-to-date root */
4125 if (mc->mc_dbi > MAIN_DBI) {
4126 if ((*mc->mc_dbflag & DB_STALE) ||
4127 ((flags & MDB_PS_MODIFY) && !(*mc->mc_dbflag & DB_DIRTY))) {
4129 unsigned char dbflag = 0;
4130 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
4131 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, flags & MDB_PS_MODIFY);
4134 if (*mc->mc_dbflag & DB_STALE) {
4138 MDB_node *leaf = mdb_node_search(&mc2,
4139 &mc->mc_dbx->md_name, &exact);
4141 return MDB_NOTFOUND;
4142 rc = mdb_node_read(mc->mc_txn, leaf, &data);
4145 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
4147 /* The txn may not know this DBI, or another process may
4148 * have dropped and recreated the DB with other flags.
4150 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
4151 return MDB_INCOMPATIBLE;
4152 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
4154 if (flags & MDB_PS_MODIFY)
4156 *mc->mc_dbflag &= ~DB_STALE;
4157 *mc->mc_dbflag |= dbflag;
4160 root = mc->mc_db->md_root;
4162 if (root == P_INVALID) { /* Tree is empty. */
4163 DPUTS("tree is empty");
4164 return MDB_NOTFOUND;
4169 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
4170 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0], NULL)) != 0)
4176 DPRINTF("db %u root page %zu has flags 0x%X",
4177 mc->mc_dbi, root, mc->mc_pg[0]->mp_flags);
4179 if (flags & MDB_PS_MODIFY) {
4180 if ((rc = mdb_page_touch(mc)))
4184 if (flags & MDB_PS_ROOTONLY)
4187 return mdb_page_search_root(mc, key, flags);
4191 mdb_ovpage_free(MDB_cursor *mc, MDB_page *mp)
4193 MDB_txn *txn = mc->mc_txn;
4194 pgno_t pg = mp->mp_pgno;
4195 unsigned i, ovpages = mp->mp_pages;
4196 MDB_env *env = txn->mt_env;
4199 DPRINTF("free ov page %zu (%d)", pg, ovpages);
4200 /* If the page is dirty we just acquired it, so we should
4201 * give it back to our current free list, if any.
4202 * Not currently supported in nested txns.
4203 * Otherwise put it onto the list of pages we freed in this txn.
4205 if ((mp->mp_flags & P_DIRTY) && !txn->mt_parent && env->me_pghead) {
4208 MDB_ID2 *dl, ix, iy;
4209 rc = mdb_midl_need(&env->me_pghead, ovpages);
4212 /* Remove from dirty list */
4213 dl = txn->mt_u.dirty_list;
4215 for (ix = dl[x]; ix.mptr != mp; ix = iy) {
4223 dl[j] = ix; /* Unsorted. OK when MDB_TXN_ERROR. */
4224 txn->mt_flags |= MDB_TXN_ERROR;
4225 return MDB_CORRUPTED;
4228 if (!(env->me_flags & MDB_WRITEMAP))
4229 mdb_dpage_free(env, mp);
4230 /* Insert in me_pghead */
4231 mop = env->me_pghead;
4232 j = mop[0] + ovpages;
4233 for (i = mop[0]; i && mop[i] < pg; i--)
4239 rc = mdb_midl_append_range(&txn->mt_free_pgs, pg, ovpages);
4243 mc->mc_db->md_overflow_pages -= ovpages;
4247 /** Return the data associated with a given node.
4248 * @param[in] txn The transaction for this operation.
4249 * @param[in] leaf The node being read.
4250 * @param[out] data Updated to point to the node's data.
4251 * @return 0 on success, non-zero on failure.
4254 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
4256 MDB_page *omp; /* overflow page */
4260 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
4261 data->mv_size = NODEDSZ(leaf);
4262 data->mv_data = NODEDATA(leaf);
4266 /* Read overflow data.
4268 data->mv_size = NODEDSZ(leaf);
4269 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
4270 if ((rc = mdb_page_get(txn, pgno, &omp, NULL)) != 0) {
4271 DPRINTF("read overflow page %zu failed", pgno);
4274 data->mv_data = METADATA(omp);
4280 mdb_get(MDB_txn *txn, MDB_dbi dbi,
4281 MDB_val *key, MDB_val *data)
4290 DPRINTF("===> get db %u key [%s]", dbi, DKEY(key));
4292 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
4295 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4299 mdb_cursor_init(&mc, txn, dbi, &mx);
4300 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
4303 /** Find a sibling for a page.
4304 * Replaces the page at the top of the cursor's stack with the
4305 * specified sibling, if one exists.
4306 * @param[in] mc The cursor for this operation.
4307 * @param[in] move_right Non-zero if the right sibling is requested,
4308 * otherwise the left sibling.
4309 * @return 0 on success, non-zero on failure.
4312 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
4318 if (mc->mc_snum < 2) {
4319 return MDB_NOTFOUND; /* root has no siblings */
4323 DPRINTF("parent page is page %zu, index %u",
4324 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]);
4326 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
4327 : (mc->mc_ki[mc->mc_top] == 0)) {
4328 DPRINTF("no more keys left, moving to %s sibling",
4329 move_right ? "right" : "left");
4330 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
4331 /* undo cursor_pop before returning */
4338 mc->mc_ki[mc->mc_top]++;
4340 mc->mc_ki[mc->mc_top]--;
4341 DPRINTF("just moving to %s index key %u",
4342 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]);
4344 assert(IS_BRANCH(mc->mc_pg[mc->mc_top]));
4346 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4347 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp, NULL) != 0))
4350 mdb_cursor_push(mc, mp);
4352 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
4357 /** Move the cursor to the next data item. */
4359 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4365 if (mc->mc_flags & C_EOF) {
4366 return MDB_NOTFOUND;
4369 assert(mc->mc_flags & C_INITIALIZED);
4371 mp = mc->mc_pg[mc->mc_top];
4373 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4374 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4375 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4376 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
4377 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
4378 if (op != MDB_NEXT || rc != MDB_NOTFOUND)
4382 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4383 if (op == MDB_NEXT_DUP)
4384 return MDB_NOTFOUND;
4388 DPRINTF("cursor_next: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4390 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
4391 DPUTS("=====> move to next sibling page");
4392 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
4393 mc->mc_flags |= C_EOF;
4394 mc->mc_flags &= ~C_INITIALIZED;
4397 mp = mc->mc_pg[mc->mc_top];
4398 DPRINTF("next page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4400 mc->mc_ki[mc->mc_top]++;
4402 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4403 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4406 key->mv_size = mc->mc_db->md_pad;
4407 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4411 assert(IS_LEAF(mp));
4412 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4414 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4415 mdb_xcursor_init1(mc, leaf);
4418 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4421 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4422 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4423 if (rc != MDB_SUCCESS)
4428 MDB_GET_KEY(leaf, key);
4432 /** Move the cursor to the previous data item. */
4434 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
4440 assert(mc->mc_flags & C_INITIALIZED);
4442 mp = mc->mc_pg[mc->mc_top];
4444 if (mc->mc_db->md_flags & MDB_DUPSORT) {
4445 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4446 if (op == MDB_PREV || op == MDB_PREV_DUP) {
4447 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4448 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
4449 if (op != MDB_PREV || rc != MDB_NOTFOUND)
4452 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4453 if (op == MDB_PREV_DUP)
4454 return MDB_NOTFOUND;
4459 DPRINTF("cursor_prev: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
4461 if (mc->mc_ki[mc->mc_top] == 0) {
4462 DPUTS("=====> move to prev sibling page");
4463 if ((rc = mdb_cursor_sibling(mc, 0)) != MDB_SUCCESS) {
4464 mc->mc_flags &= ~C_INITIALIZED;
4467 mp = mc->mc_pg[mc->mc_top];
4468 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
4469 DPRINTF("prev page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
4471 mc->mc_ki[mc->mc_top]--;
4473 mc->mc_flags &= ~C_EOF;
4475 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
4476 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
4479 key->mv_size = mc->mc_db->md_pad;
4480 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4484 assert(IS_LEAF(mp));
4485 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4487 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4488 mdb_xcursor_init1(mc, leaf);
4491 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4494 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4495 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4496 if (rc != MDB_SUCCESS)
4501 MDB_GET_KEY(leaf, key);
4505 /** Set the cursor on a specific data item. */
4507 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4508 MDB_cursor_op op, int *exactp)
4512 MDB_node *leaf = NULL;
4517 assert(key->mv_size > 0);
4519 /* See if we're already on the right page */
4520 if (mc->mc_flags & C_INITIALIZED) {
4523 mp = mc->mc_pg[mc->mc_top];
4525 mc->mc_ki[mc->mc_top] = 0;
4526 return MDB_NOTFOUND;
4528 if (mp->mp_flags & P_LEAF2) {
4529 nodekey.mv_size = mc->mc_db->md_pad;
4530 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
4532 leaf = NODEPTR(mp, 0);
4533 MDB_GET_KEY(leaf, &nodekey);
4535 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4537 /* Probably happens rarely, but first node on the page
4538 * was the one we wanted.
4540 mc->mc_ki[mc->mc_top] = 0;
4547 unsigned int nkeys = NUMKEYS(mp);
4549 if (mp->mp_flags & P_LEAF2) {
4550 nodekey.mv_data = LEAF2KEY(mp,
4551 nkeys-1, nodekey.mv_size);
4553 leaf = NODEPTR(mp, nkeys-1);
4554 MDB_GET_KEY(leaf, &nodekey);
4556 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4558 /* last node was the one we wanted */
4559 mc->mc_ki[mc->mc_top] = nkeys-1;
4565 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
4566 /* This is definitely the right page, skip search_page */
4567 if (mp->mp_flags & P_LEAF2) {
4568 nodekey.mv_data = LEAF2KEY(mp,
4569 mc->mc_ki[mc->mc_top], nodekey.mv_size);
4571 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4572 MDB_GET_KEY(leaf, &nodekey);
4574 rc = mc->mc_dbx->md_cmp(key, &nodekey);
4576 /* current node was the one we wanted */
4586 /* If any parents have right-sibs, search.
4587 * Otherwise, there's nothing further.
4589 for (i=0; i<mc->mc_top; i++)
4591 NUMKEYS(mc->mc_pg[i])-1)
4593 if (i == mc->mc_top) {
4594 /* There are no other pages */
4595 mc->mc_ki[mc->mc_top] = nkeys;
4596 return MDB_NOTFOUND;
4600 /* There are no other pages */
4601 mc->mc_ki[mc->mc_top] = 0;
4602 return MDB_NOTFOUND;
4606 rc = mdb_page_search(mc, key, 0);
4607 if (rc != MDB_SUCCESS)
4610 mp = mc->mc_pg[mc->mc_top];
4611 assert(IS_LEAF(mp));
4614 leaf = mdb_node_search(mc, key, exactp);
4615 if (exactp != NULL && !*exactp) {
4616 /* MDB_SET specified and not an exact match. */
4617 return MDB_NOTFOUND;
4621 DPUTS("===> inexact leaf not found, goto sibling");
4622 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
4623 return rc; /* no entries matched */
4624 mp = mc->mc_pg[mc->mc_top];
4625 assert(IS_LEAF(mp));
4626 leaf = NODEPTR(mp, 0);
4630 mc->mc_flags |= C_INITIALIZED;
4631 mc->mc_flags &= ~C_EOF;
4634 key->mv_size = mc->mc_db->md_pad;
4635 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4639 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4640 mdb_xcursor_init1(mc, leaf);
4643 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4644 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
4645 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4648 if (op == MDB_GET_BOTH) {
4654 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
4655 if (rc != MDB_SUCCESS)
4658 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
4660 if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
4662 rc = mc->mc_dbx->md_dcmp(data, &d2);
4664 if (op == MDB_GET_BOTH || rc > 0)
4665 return MDB_NOTFOUND;
4670 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4671 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4676 /* The key already matches in all other cases */
4677 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
4678 MDB_GET_KEY(leaf, key);
4679 DPRINTF("==> cursor placed on key [%s]", DKEY(key));
4684 /** Move the cursor to the first item in the database. */
4686 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4691 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4692 rc = mdb_page_search(mc, NULL, 0);
4693 if (rc != MDB_SUCCESS)
4696 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4698 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
4699 mc->mc_flags |= C_INITIALIZED;
4700 mc->mc_flags &= ~C_EOF;
4702 mc->mc_ki[mc->mc_top] = 0;
4704 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4705 key->mv_size = mc->mc_db->md_pad;
4706 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
4711 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4712 mdb_xcursor_init1(mc, leaf);
4713 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4718 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4719 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4723 MDB_GET_KEY(leaf, key);
4727 /** Move the cursor to the last item in the database. */
4729 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4734 if (!(mc->mc_flags & C_EOF)) {
4736 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4739 lkey.mv_size = MDB_MAXKEYSIZE+1;
4740 lkey.mv_data = NULL;
4741 rc = mdb_page_search(mc, &lkey, 0);
4742 if (rc != MDB_SUCCESS)
4745 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4748 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
4749 mc->mc_flags |= C_INITIALIZED|C_EOF;
4750 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4752 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4753 key->mv_size = mc->mc_db->md_pad;
4754 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
4759 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4760 mdb_xcursor_init1(mc, leaf);
4761 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4766 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4767 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4772 MDB_GET_KEY(leaf, key);
4777 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4786 case MDB_GET_CURRENT:
4787 if (!(mc->mc_flags & C_INITIALIZED)) {
4790 MDB_page *mp = mc->mc_pg[mc->mc_top];
4792 mc->mc_ki[mc->mc_top] = 0;
4798 key->mv_size = mc->mc_db->md_pad;
4799 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
4801 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
4802 MDB_GET_KEY(leaf, key);
4804 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4805 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
4807 rc = mdb_node_read(mc->mc_txn, leaf, data);
4814 case MDB_GET_BOTH_RANGE:
4815 if (data == NULL || mc->mc_xcursor == NULL) {
4823 if (key == NULL || key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
4825 } else if (op == MDB_SET_RANGE)
4826 rc = mdb_cursor_set(mc, key, data, op, NULL);
4828 rc = mdb_cursor_set(mc, key, data, op, &exact);
4830 case MDB_GET_MULTIPLE:
4832 !(mc->mc_db->md_flags & MDB_DUPFIXED) ||
4833 !(mc->mc_flags & C_INITIALIZED)) {
4838 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
4839 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
4842 case MDB_NEXT_MULTIPLE:
4844 !(mc->mc_db->md_flags & MDB_DUPFIXED)) {
4848 if (!(mc->mc_flags & C_INITIALIZED))
4849 rc = mdb_cursor_first(mc, key, data);
4851 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
4852 if (rc == MDB_SUCCESS) {
4853 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
4856 mx = &mc->mc_xcursor->mx_cursor;
4857 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
4859 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
4860 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
4868 case MDB_NEXT_NODUP:
4869 if (!(mc->mc_flags & C_INITIALIZED))
4870 rc = mdb_cursor_first(mc, key, data);
4872 rc = mdb_cursor_next(mc, key, data, op);
4876 case MDB_PREV_NODUP:
4877 if (!(mc->mc_flags & C_INITIALIZED)) {
4878 rc = mdb_cursor_last(mc, key, data);
4881 mc->mc_flags |= C_INITIALIZED;
4882 mc->mc_ki[mc->mc_top]++;
4884 rc = mdb_cursor_prev(mc, key, data, op);
4887 rc = mdb_cursor_first(mc, key, data);
4891 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4892 !(mc->mc_flags & C_INITIALIZED) ||
4893 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4897 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4900 rc = mdb_cursor_last(mc, key, data);
4904 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4905 !(mc->mc_flags & C_INITIALIZED) ||
4906 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4910 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4913 DPRINTF("unhandled/unimplemented cursor operation %u", op);
4921 /** Touch all the pages in the cursor stack.
4922 * Makes sure all the pages are writable, before attempting a write operation.
4923 * @param[in] mc The cursor to operate on.
4926 mdb_cursor_touch(MDB_cursor *mc)
4930 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
4933 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, &mcx);
4934 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
4937 *mc->mc_dbflag |= DB_DIRTY;
4939 for (mc->mc_top = 0; mc->mc_top < mc->mc_snum; mc->mc_top++) {
4940 rc = mdb_page_touch(mc);
4944 mc->mc_top = mc->mc_snum-1;
4949 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4952 MDB_node *leaf = NULL;
4953 MDB_val xdata, *rdata, dkey;
4956 int do_sub = 0, insert = 0;
4957 unsigned int mcount = 0, dcount = 0;
4961 char dbuf[MDB_MAXKEYSIZE+1];
4962 unsigned int nflags;
4965 /* Check this first so counter will always be zero on any
4968 if (flags & MDB_MULTIPLE) {
4969 dcount = data[1].mv_size;
4970 data[1].mv_size = 0;
4971 if (!F_ISSET(mc->mc_db->md_flags, MDB_DUPFIXED))
4975 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4978 if (flags != MDB_CURRENT && (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE))
4981 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT) && data->mv_size > MDB_MAXKEYSIZE)
4984 #if SIZE_MAX > MAXDATASIZE
4985 if (data->mv_size > MAXDATASIZE)
4989 DPRINTF("==> put db %u key [%s], size %zu, data size %zu",
4990 mc->mc_dbi, DKEY(key), key ? key->mv_size:0, data->mv_size);
4994 if (flags == MDB_CURRENT) {
4995 if (!(mc->mc_flags & C_INITIALIZED))
4998 } else if (mc->mc_db->md_root == P_INVALID) {
5000 /* new database, write a root leaf page */
5001 DPUTS("allocating new root leaf page");
5002 if ((rc = mdb_page_new(mc, P_LEAF, 1, &np))) {
5006 mdb_cursor_push(mc, np);
5007 mc->mc_db->md_root = np->mp_pgno;
5008 mc->mc_db->md_depth++;
5009 *mc->mc_dbflag |= DB_DIRTY;
5010 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
5012 np->mp_flags |= P_LEAF2;
5013 mc->mc_flags |= C_INITIALIZED;
5019 if (flags & MDB_APPEND) {
5021 rc = mdb_cursor_last(mc, &k2, &d2);
5023 rc = mc->mc_dbx->md_cmp(key, &k2);
5026 mc->mc_ki[mc->mc_top]++;
5028 /* new key is <= last key */
5033 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
5035 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
5036 DPRINTF("duplicate key [%s]", DKEY(key));
5038 return MDB_KEYEXIST;
5040 if (rc && rc != MDB_NOTFOUND)
5044 /* Cursor is positioned, now make sure all pages are writable */
5045 rc2 = mdb_cursor_touch(mc);
5050 /* The key already exists */
5051 if (rc == MDB_SUCCESS) {
5052 /* there's only a key anyway, so this is a no-op */
5053 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5054 unsigned int ksize = mc->mc_db->md_pad;
5055 if (key->mv_size != ksize)
5057 if (flags == MDB_CURRENT) {
5058 char *ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
5059 memcpy(ptr, key->mv_data, ksize);
5064 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5067 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
5068 /* Was a single item before, must convert now */
5070 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5071 /* Just overwrite the current item */
5072 if (flags == MDB_CURRENT)
5075 dkey.mv_size = NODEDSZ(leaf);
5076 dkey.mv_data = NODEDATA(leaf);
5077 #if UINT_MAX < SIZE_MAX
5078 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && dkey.mv_size == sizeof(size_t))
5079 #ifdef MISALIGNED_OK
5080 mc->mc_dbx->md_dcmp = mdb_cmp_long;
5082 mc->mc_dbx->md_dcmp = mdb_cmp_cint;
5085 /* if data matches, ignore it */
5086 if (!mc->mc_dbx->md_dcmp(data, &dkey))
5087 return (flags == MDB_NODUPDATA) ? MDB_KEYEXIST : MDB_SUCCESS;
5089 /* create a fake page for the dup items */
5090 memcpy(dbuf, dkey.mv_data, dkey.mv_size);
5091 dkey.mv_data = dbuf;
5092 fp = (MDB_page *)&pbuf;
5093 fp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5094 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
5095 fp->mp_lower = PAGEHDRSZ;
5096 fp->mp_upper = PAGEHDRSZ + dkey.mv_size + data->mv_size;
5097 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5098 fp->mp_flags |= P_LEAF2;
5099 fp->mp_pad = data->mv_size;
5100 fp->mp_upper += 2 * data->mv_size; /* leave space for 2 more */
5102 fp->mp_upper += 2 * sizeof(indx_t) + 2 * NODESIZE +
5103 (dkey.mv_size & 1) + (data->mv_size & 1);
5105 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5108 xdata.mv_size = fp->mp_upper;
5113 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5114 /* See if we need to convert from fake page to subDB */
5116 unsigned int offset;
5120 fp = NODEDATA(leaf);
5121 if (flags == MDB_CURRENT) {
5123 fp->mp_flags |= P_DIRTY;
5124 COPY_PGNO(fp->mp_pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5125 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
5129 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5130 offset = fp->mp_pad;
5131 if (SIZELEFT(fp) >= offset)
5133 offset *= 4; /* space for 4 more */
5135 offset = NODESIZE + sizeof(indx_t) + data->mv_size;
5137 offset += offset & 1;
5138 fp_flags = fp->mp_flags;
5139 if (NODESIZE + sizeof(indx_t) + NODEKSZ(leaf) + NODEDSZ(leaf) +
5140 offset >= mc->mc_txn->mt_env->me_nodemax) {
5141 /* yes, convert it */
5143 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5144 dummy.md_pad = fp->mp_pad;
5145 dummy.md_flags = MDB_DUPFIXED;
5146 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5147 dummy.md_flags |= MDB_INTEGERKEY;
5150 dummy.md_branch_pages = 0;
5151 dummy.md_leaf_pages = 1;
5152 dummy.md_overflow_pages = 0;
5153 dummy.md_entries = NUMKEYS(fp);
5155 xdata.mv_size = sizeof(MDB_db);
5156 xdata.mv_data = &dummy;
5157 if ((rc = mdb_page_alloc(mc, 1, &mp)))
5159 offset = mc->mc_txn->mt_env->me_psize - NODEDSZ(leaf);
5160 flags |= F_DUPDATA|F_SUBDATA;
5161 dummy.md_root = mp->mp_pgno;
5162 fp_flags &= ~P_SUBP;
5164 /* no, just grow it */
5166 xdata.mv_size = NODEDSZ(leaf) + offset;
5167 xdata.mv_data = &pbuf;
5168 mp = (MDB_page *)&pbuf;
5169 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
5172 mp->mp_flags = fp_flags | P_DIRTY;
5173 mp->mp_pad = fp->mp_pad;
5174 mp->mp_lower = fp->mp_lower;
5175 mp->mp_upper = fp->mp_upper + offset;
5177 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
5179 nsize = NODEDSZ(leaf) - fp->mp_upper;
5180 memcpy((char *)mp + mp->mp_upper, (char *)fp + fp->mp_upper, nsize);
5181 for (i=0; i<NUMKEYS(fp); i++)
5182 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
5184 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5188 /* data is on sub-DB, just store it */
5189 flags |= F_DUPDATA|F_SUBDATA;
5193 /* overflow page overwrites need special handling */
5194 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5197 unsigned psize = mc->mc_txn->mt_env->me_psize;
5198 int level, ovpages, dpages = OVPAGES(data->mv_size, psize);
5200 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
5201 if ((rc2 = mdb_page_get(mc->mc_txn, pg, &omp, &level)) != 0)
5203 ovpages = omp->mp_pages;
5205 /* Is the ov page writable and large enough? */
5206 if ((omp->mp_flags & P_DIRTY) && ovpages >= dpages) {
5207 /* yes, overwrite it. Note in this case we don't
5208 * bother to try shrinking the page if the new data
5209 * is smaller than the overflow threshold.
5212 /* It is writable only in a parent txn */
5213 size_t sz = (size_t) psize * ovpages, off;
5214 MDB_page *np = mdb_page_malloc(mc->mc_txn, ovpages);
5220 mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &id2);
5221 if (!(flags & MDB_RESERVE)) {
5222 /* Copy end of page, adjusting alignment so
5223 * compiler may copy words instead of bytes.
5225 off = (PAGEHDRSZ + data->mv_size) & -sizeof(size_t);
5226 memcpy((size_t *)((char *)np + off),
5227 (size_t *)((char *)omp + off), sz - off);
5230 memcpy(np, omp, sz); /* Copy beginning of page */
5233 SETDSZ(leaf, data->mv_size);
5234 if (F_ISSET(flags, MDB_RESERVE))
5235 data->mv_data = METADATA(omp);
5237 memcpy(METADATA(omp), data->mv_data, data->mv_size);
5240 if ((rc2 = mdb_ovpage_free(mc, omp)) != MDB_SUCCESS)
5243 } else if (NODEDSZ(leaf) == data->mv_size) {
5244 /* same size, just replace it. Note that we could
5245 * also reuse this node if the new data is smaller,
5246 * but instead we opt to shrink the node in that case.
5248 if (F_ISSET(flags, MDB_RESERVE))
5249 data->mv_data = NODEDATA(leaf);
5250 else if (data->mv_size)
5251 memcpy(NODEDATA(leaf), data->mv_data, data->mv_size);
5253 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
5256 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
5257 mc->mc_db->md_entries--;
5259 DPRINTF("inserting key at index %i", mc->mc_ki[mc->mc_top]);
5266 nflags = flags & NODE_ADD_FLAGS;
5267 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(mc->mc_txn->mt_env, key, rdata);
5268 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
5269 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
5270 nflags &= ~MDB_APPEND;
5272 nflags |= MDB_SPLIT_REPLACE;
5273 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
5275 /* There is room already in this leaf page. */
5276 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
5277 if (rc == 0 && !do_sub && insert) {
5278 /* Adjust other cursors pointing to mp */
5279 MDB_cursor *m2, *m3;
5280 MDB_dbi dbi = mc->mc_dbi;
5281 unsigned i = mc->mc_top;
5282 MDB_page *mp = mc->mc_pg[i];
5284 if (mc->mc_flags & C_SUB)
5287 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5288 if (mc->mc_flags & C_SUB)
5289 m3 = &m2->mc_xcursor->mx_cursor;
5292 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
5293 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
5300 if (rc != MDB_SUCCESS)
5301 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5303 /* Now store the actual data in the child DB. Note that we're
5304 * storing the user data in the keys field, so there are strict
5305 * size limits on dupdata. The actual data fields of the child
5306 * DB are all zero size.
5313 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5314 if (flags & MDB_CURRENT) {
5315 xflags = MDB_CURRENT;
5317 mdb_xcursor_init1(mc, leaf);
5318 xflags = (flags & MDB_NODUPDATA) ? MDB_NOOVERWRITE : 0;
5320 /* converted, write the original data first */
5322 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
5326 /* Adjust other cursors pointing to mp */
5328 unsigned i = mc->mc_top;
5329 MDB_page *mp = mc->mc_pg[i];
5331 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5332 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
5333 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
5334 mdb_xcursor_init1(m2, leaf);
5338 /* we've done our job */
5341 if (flags & MDB_APPENDDUP)
5342 xflags |= MDB_APPEND;
5343 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
5344 if (flags & F_SUBDATA) {
5345 void *db = NODEDATA(leaf);
5346 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5349 /* sub-writes might have failed so check rc again.
5350 * Don't increment count if we just replaced an existing item.
5352 if (!rc && !(flags & MDB_CURRENT))
5353 mc->mc_db->md_entries++;
5354 if (flags & MDB_MULTIPLE) {
5357 if (mcount < dcount) {
5358 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
5359 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5363 /* let caller know how many succeeded, if any */
5364 data[1].mv_size = mcount;
5368 /* If we succeeded and the key didn't exist before, make sure
5369 * the cursor is marked valid.
5372 mc->mc_flags |= C_INITIALIZED;
5377 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
5382 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
5385 if (!(mc->mc_flags & C_INITIALIZED))
5388 rc = mdb_cursor_touch(mc);
5392 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5394 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5395 if (flags != MDB_NODUPDATA) {
5396 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
5397 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
5399 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, 0);
5400 /* If sub-DB still has entries, we're done */
5401 if (mc->mc_xcursor->mx_db.md_entries) {
5402 if (leaf->mn_flags & F_SUBDATA) {
5403 /* update subDB info */
5404 void *db = NODEDATA(leaf);
5405 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
5408 /* shrink fake page */
5409 mdb_node_shrink(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5410 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5411 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
5412 /* fix other sub-DB cursors pointed at this fake page */
5413 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
5414 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
5415 if (m2->mc_pg[mc->mc_top] == mc->mc_pg[mc->mc_top] &&
5416 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
5417 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
5420 mc->mc_db->md_entries--;
5423 /* otherwise fall thru and delete the sub-DB */
5426 if (leaf->mn_flags & F_SUBDATA) {
5427 /* add all the child DB's pages to the free list */
5428 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
5429 if (rc == MDB_SUCCESS) {
5430 mc->mc_db->md_entries -=
5431 mc->mc_xcursor->mx_db.md_entries;
5436 return mdb_cursor_del0(mc, leaf);
5439 /** Allocate and initialize new pages for a database.
5440 * @param[in] mc a cursor on the database being added to.
5441 * @param[in] flags flags defining what type of page is being allocated.
5442 * @param[in] num the number of pages to allocate. This is usually 1,
5443 * unless allocating overflow pages for a large record.
5444 * @param[out] mp Address of a page, or NULL on failure.
5445 * @return 0 on success, non-zero on failure.
5448 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
5453 if ((rc = mdb_page_alloc(mc, num, &np)))
5455 DPRINTF("allocated new mpage %zu, page size %u",
5456 np->mp_pgno, mc->mc_txn->mt_env->me_psize);
5457 np->mp_flags = flags | P_DIRTY;
5458 np->mp_lower = PAGEHDRSZ;
5459 np->mp_upper = mc->mc_txn->mt_env->me_psize;
5462 mc->mc_db->md_branch_pages++;
5463 else if (IS_LEAF(np))
5464 mc->mc_db->md_leaf_pages++;
5465 else if (IS_OVERFLOW(np)) {
5466 mc->mc_db->md_overflow_pages += num;
5474 /** Calculate the size of a leaf node.
5475 * The size depends on the environment's page size; if a data item
5476 * is too large it will be put onto an overflow page and the node
5477 * size will only include the key and not the data. Sizes are always
5478 * rounded up to an even number of bytes, to guarantee 2-byte alignment
5479 * of the #MDB_node headers.
5480 * @param[in] env The environment handle.
5481 * @param[in] key The key for the node.
5482 * @param[in] data The data for the node.
5483 * @return The number of bytes needed to store the node.
5486 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
5490 sz = LEAFSIZE(key, data);
5491 if (sz >= env->me_nodemax) {
5492 /* put on overflow page */
5493 sz -= data->mv_size - sizeof(pgno_t);
5497 return sz + sizeof(indx_t);
5500 /** Calculate the size of a branch node.
5501 * The size should depend on the environment's page size but since
5502 * we currently don't support spilling large keys onto overflow
5503 * pages, it's simply the size of the #MDB_node header plus the
5504 * size of the key. Sizes are always rounded up to an even number
5505 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
5506 * @param[in] env The environment handle.
5507 * @param[in] key The key for the node.
5508 * @return The number of bytes needed to store the node.
5511 mdb_branch_size(MDB_env *env, MDB_val *key)
5516 if (sz >= env->me_nodemax) {
5517 /* put on overflow page */
5518 /* not implemented */
5519 /* sz -= key->size - sizeof(pgno_t); */
5522 return sz + sizeof(indx_t);
5525 /** Add a node to the page pointed to by the cursor.
5526 * @param[in] mc The cursor for this operation.
5527 * @param[in] indx The index on the page where the new node should be added.
5528 * @param[in] key The key for the new node.
5529 * @param[in] data The data for the new node, if any.
5530 * @param[in] pgno The page number, if adding a branch node.
5531 * @param[in] flags Flags for the node.
5532 * @return 0 on success, non-zero on failure. Possible errors are:
5534 * <li>ENOMEM - failed to allocate overflow pages for the node.
5535 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
5536 * should never happen since all callers already calculate the
5537 * page's free space before calling this function.
5541 mdb_node_add(MDB_cursor *mc, indx_t indx,
5542 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
5545 size_t node_size = NODESIZE;
5548 MDB_page *mp = mc->mc_pg[mc->mc_top];
5549 MDB_page *ofp = NULL; /* overflow page */
5552 assert(mp->mp_upper >= mp->mp_lower);
5554 DPRINTF("add to %s %spage %zu index %i, data size %zu key size %zu [%s]",
5555 IS_LEAF(mp) ? "leaf" : "branch",
5556 IS_SUBP(mp) ? "sub-" : "",
5557 mp->mp_pgno, indx, data ? data->mv_size : 0,
5558 key ? key->mv_size : 0, key ? DKEY(key) : NULL);
5561 /* Move higher keys up one slot. */
5562 int ksize = mc->mc_db->md_pad, dif;
5563 char *ptr = LEAF2KEY(mp, indx, ksize);
5564 dif = NUMKEYS(mp) - indx;
5566 memmove(ptr+ksize, ptr, dif*ksize);
5567 /* insert new key */
5568 memcpy(ptr, key->mv_data, ksize);
5570 /* Just using these for counting */
5571 mp->mp_lower += sizeof(indx_t);
5572 mp->mp_upper -= ksize - sizeof(indx_t);
5577 node_size += key->mv_size;
5581 if (F_ISSET(flags, F_BIGDATA)) {
5582 /* Data already on overflow page. */
5583 node_size += sizeof(pgno_t);
5584 } else if (node_size + data->mv_size >= mc->mc_txn->mt_env->me_nodemax) {
5585 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
5587 /* Put data on overflow page. */
5588 DPRINTF("data size is %zu, node would be %zu, put data on overflow page",
5589 data->mv_size, node_size+data->mv_size);
5590 node_size += sizeof(pgno_t);
5591 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
5593 DPRINTF("allocated overflow page %zu", ofp->mp_pgno);
5596 node_size += data->mv_size;
5599 node_size += node_size & 1;
5601 if (node_size + sizeof(indx_t) > SIZELEFT(mp)) {
5602 DPRINTF("not enough room in page %zu, got %u ptrs",
5603 mp->mp_pgno, NUMKEYS(mp));
5604 DPRINTF("upper - lower = %u - %u = %u", mp->mp_upper, mp->mp_lower,
5605 mp->mp_upper - mp->mp_lower);
5606 DPRINTF("node size = %zu", node_size);
5607 return MDB_PAGE_FULL;
5610 /* Move higher pointers up one slot. */
5611 for (i = NUMKEYS(mp); i > indx; i--)
5612 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
5614 /* Adjust free space offsets. */
5615 ofs = mp->mp_upper - node_size;
5616 assert(ofs >= mp->mp_lower + sizeof(indx_t));
5617 mp->mp_ptrs[indx] = ofs;
5619 mp->mp_lower += sizeof(indx_t);
5621 /* Write the node data. */
5622 node = NODEPTR(mp, indx);
5623 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
5624 node->mn_flags = flags;
5626 SETDSZ(node,data->mv_size);
5631 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
5636 if (F_ISSET(flags, F_BIGDATA))
5637 memcpy(node->mn_data + key->mv_size, data->mv_data,
5639 else if (F_ISSET(flags, MDB_RESERVE))
5640 data->mv_data = node->mn_data + key->mv_size;
5642 memcpy(node->mn_data + key->mv_size, data->mv_data,
5645 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
5647 if (F_ISSET(flags, MDB_RESERVE))
5648 data->mv_data = METADATA(ofp);
5650 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
5657 /** Delete the specified node from a page.
5658 * @param[in] mp The page to operate on.
5659 * @param[in] indx The index of the node to delete.
5660 * @param[in] ksize The size of a node. Only used if the page is
5661 * part of a #MDB_DUPFIXED database.
5664 mdb_node_del(MDB_page *mp, indx_t indx, int ksize)
5667 indx_t i, j, numkeys, ptr;
5674 COPY_PGNO(pgno, mp->mp_pgno);
5675 DPRINTF("delete node %u on %s page %zu", indx,
5676 IS_LEAF(mp) ? "leaf" : "branch", pgno);
5679 assert(indx < NUMKEYS(mp));
5682 int x = NUMKEYS(mp) - 1 - indx;
5683 base = LEAF2KEY(mp, indx, ksize);
5685 memmove(base, base + ksize, x * ksize);
5686 mp->mp_lower -= sizeof(indx_t);
5687 mp->mp_upper += ksize - sizeof(indx_t);
5691 node = NODEPTR(mp, indx);
5692 sz = NODESIZE + node->mn_ksize;
5694 if (F_ISSET(node->mn_flags, F_BIGDATA))
5695 sz += sizeof(pgno_t);
5697 sz += NODEDSZ(node);
5701 ptr = mp->mp_ptrs[indx];
5702 numkeys = NUMKEYS(mp);
5703 for (i = j = 0; i < numkeys; i++) {
5705 mp->mp_ptrs[j] = mp->mp_ptrs[i];
5706 if (mp->mp_ptrs[i] < ptr)
5707 mp->mp_ptrs[j] += sz;
5712 base = (char *)mp + mp->mp_upper;
5713 memmove(base + sz, base, ptr - mp->mp_upper);
5715 mp->mp_lower -= sizeof(indx_t);
5719 /** Compact the main page after deleting a node on a subpage.
5720 * @param[in] mp The main page to operate on.
5721 * @param[in] indx The index of the subpage on the main page.
5724 mdb_node_shrink(MDB_page *mp, indx_t indx)
5731 indx_t i, numkeys, ptr;
5733 node = NODEPTR(mp, indx);
5734 sp = (MDB_page *)NODEDATA(node);
5735 osize = NODEDSZ(node);
5737 delta = sp->mp_upper - sp->mp_lower;
5738 SETDSZ(node, osize - delta);
5739 xp = (MDB_page *)((char *)sp + delta);
5741 /* shift subpage upward */
5743 nsize = NUMKEYS(sp) * sp->mp_pad;
5744 memmove(METADATA(xp), METADATA(sp), nsize);
5747 nsize = osize - sp->mp_upper;
5748 numkeys = NUMKEYS(sp);
5749 for (i=numkeys-1; i>=0; i--)
5750 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
5752 xp->mp_upper = sp->mp_lower;
5753 xp->mp_lower = sp->mp_lower;
5754 xp->mp_flags = sp->mp_flags;
5755 xp->mp_pad = sp->mp_pad;
5756 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
5758 /* shift lower nodes upward */
5759 ptr = mp->mp_ptrs[indx];
5760 numkeys = NUMKEYS(mp);
5761 for (i = 0; i < numkeys; i++) {
5762 if (mp->mp_ptrs[i] <= ptr)
5763 mp->mp_ptrs[i] += delta;
5766 base = (char *)mp + mp->mp_upper;
5767 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
5768 mp->mp_upper += delta;
5771 /** Initial setup of a sorted-dups cursor.
5772 * Sorted duplicates are implemented as a sub-database for the given key.
5773 * The duplicate data items are actually keys of the sub-database.
5774 * Operations on the duplicate data items are performed using a sub-cursor
5775 * initialized when the sub-database is first accessed. This function does
5776 * the preliminary setup of the sub-cursor, filling in the fields that
5777 * depend only on the parent DB.
5778 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5781 mdb_xcursor_init0(MDB_cursor *mc)
5783 MDB_xcursor *mx = mc->mc_xcursor;
5785 mx->mx_cursor.mc_xcursor = NULL;
5786 mx->mx_cursor.mc_txn = mc->mc_txn;
5787 mx->mx_cursor.mc_db = &mx->mx_db;
5788 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
5789 mx->mx_cursor.mc_dbi = mc->mc_dbi+1;
5790 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
5791 mx->mx_cursor.mc_snum = 0;
5792 mx->mx_cursor.mc_top = 0;
5793 mx->mx_cursor.mc_flags = C_SUB;
5794 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
5795 mx->mx_dbx.md_dcmp = NULL;
5796 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
5799 /** Final setup of a sorted-dups cursor.
5800 * Sets up the fields that depend on the data from the main cursor.
5801 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5802 * @param[in] node The data containing the #MDB_db record for the
5803 * sorted-dup database.
5806 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
5808 MDB_xcursor *mx = mc->mc_xcursor;
5810 if (node->mn_flags & F_SUBDATA) {
5811 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
5812 mx->mx_cursor.mc_pg[0] = 0;
5813 mx->mx_cursor.mc_snum = 0;
5814 mx->mx_cursor.mc_flags = C_SUB;
5816 MDB_page *fp = NODEDATA(node);
5817 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
5818 mx->mx_db.md_flags = 0;
5819 mx->mx_db.md_depth = 1;
5820 mx->mx_db.md_branch_pages = 0;
5821 mx->mx_db.md_leaf_pages = 1;
5822 mx->mx_db.md_overflow_pages = 0;
5823 mx->mx_db.md_entries = NUMKEYS(fp);
5824 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
5825 mx->mx_cursor.mc_snum = 1;
5826 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
5827 mx->mx_cursor.mc_top = 0;
5828 mx->mx_cursor.mc_pg[0] = fp;
5829 mx->mx_cursor.mc_ki[0] = 0;
5830 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5831 mx->mx_db.md_flags = MDB_DUPFIXED;
5832 mx->mx_db.md_pad = fp->mp_pad;
5833 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5834 mx->mx_db.md_flags |= MDB_INTEGERKEY;
5837 DPRINTF("Sub-db %u for db %u root page %zu", mx->mx_cursor.mc_dbi, mc->mc_dbi,
5839 mx->mx_dbflag = DB_VALID | (F_ISSET(mc->mc_pg[mc->mc_top]->mp_flags, P_DIRTY) ?
5841 mx->mx_dbx.md_name.mv_data = NODEKEY(node);
5842 mx->mx_dbx.md_name.mv_size = node->mn_ksize;
5843 #if UINT_MAX < SIZE_MAX
5844 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
5845 #ifdef MISALIGNED_OK
5846 mx->mx_dbx.md_cmp = mdb_cmp_long;
5848 mx->mx_dbx.md_cmp = mdb_cmp_cint;
5853 /** Initialize a cursor for a given transaction and database. */
5855 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
5857 mc->mc_backup = NULL;
5860 mc->mc_db = &txn->mt_dbs[dbi];
5861 mc->mc_dbx = &txn->mt_dbxs[dbi];
5862 mc->mc_dbflag = &txn->mt_dbflags[dbi];
5867 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5869 mc->mc_xcursor = mx;
5870 mdb_xcursor_init0(mc);
5872 mc->mc_xcursor = NULL;
5874 if (*mc->mc_dbflag & DB_STALE) {
5875 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
5880 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
5883 size_t size = sizeof(MDB_cursor);
5885 if (txn == NULL || ret == NULL || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
5888 /* Allow read access to the freelist */
5889 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
5892 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
5893 size += sizeof(MDB_xcursor);
5895 if ((mc = malloc(size)) != NULL) {
5896 mdb_cursor_init(mc, txn, dbi, (MDB_xcursor *)(mc + 1));
5897 if (txn->mt_cursors) {
5898 mc->mc_next = txn->mt_cursors[dbi];
5899 txn->mt_cursors[dbi] = mc;
5900 mc->mc_flags |= C_UNTRACK;
5912 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
5914 if (txn == NULL || mc == NULL || mc->mc_dbi >= txn->mt_numdbs)
5917 if ((mc->mc_flags & C_UNTRACK) || txn->mt_cursors)
5920 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
5924 /* Return the count of duplicate data items for the current key */
5926 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
5930 if (mc == NULL || countp == NULL)
5933 if (!(mc->mc_db->md_flags & MDB_DUPSORT))
5936 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5937 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5940 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
5943 *countp = mc->mc_xcursor->mx_db.md_entries;
5949 mdb_cursor_close(MDB_cursor *mc)
5951 if (mc && !mc->mc_backup) {
5952 /* remove from txn, if tracked */
5953 if ((mc->mc_flags & C_UNTRACK) && mc->mc_txn->mt_cursors) {
5954 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
5955 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
5957 *prev = mc->mc_next;
5964 mdb_cursor_txn(MDB_cursor *mc)
5966 if (!mc) return NULL;
5971 mdb_cursor_dbi(MDB_cursor *mc)
5977 /** Replace the key for a node with a new key.
5978 * @param[in] mc Cursor pointing to the node to operate on.
5979 * @param[in] key The new key to use.
5980 * @return 0 on success, non-zero on failure.
5983 mdb_update_key(MDB_cursor *mc, MDB_val *key)
5990 indx_t ptr, i, numkeys, indx;
5993 indx = mc->mc_ki[mc->mc_top];
5994 mp = mc->mc_pg[mc->mc_top];
5995 node = NODEPTR(mp, indx);
5996 ptr = mp->mp_ptrs[indx];
6000 char kbuf2[(MDB_MAXKEYSIZE*2+1)];
6001 k2.mv_data = NODEKEY(node);
6002 k2.mv_size = node->mn_ksize;
6003 DPRINTF("update key %u (ofs %u) [%s] to [%s] on page %zu",
6005 mdb_dkey(&k2, kbuf2),
6011 delta0 = delta = key->mv_size - node->mn_ksize;
6013 /* Must be 2-byte aligned. If new key is
6014 * shorter by 1, the shift will be skipped.
6016 delta += (delta & 1);
6018 if (delta > 0 && SIZELEFT(mp) < delta) {
6020 /* not enough space left, do a delete and split */
6021 DPRINTF("Not enough room, delta = %d, splitting...", delta);
6022 pgno = NODEPGNO(node);
6023 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
6024 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
6027 numkeys = NUMKEYS(mp);
6028 for (i = 0; i < numkeys; i++) {
6029 if (mp->mp_ptrs[i] <= ptr)
6030 mp->mp_ptrs[i] -= delta;
6033 base = (char *)mp + mp->mp_upper;
6034 len = ptr - mp->mp_upper + NODESIZE;
6035 memmove(base - delta, base, len);
6036 mp->mp_upper -= delta;
6038 node = NODEPTR(mp, indx);
6041 /* But even if no shift was needed, update ksize */
6043 node->mn_ksize = key->mv_size;
6046 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
6052 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
6054 /** Move a node from csrc to cdst.
6057 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
6064 unsigned short flags;
6068 /* Mark src and dst as dirty. */
6069 if ((rc = mdb_page_touch(csrc)) ||
6070 (rc = mdb_page_touch(cdst)))
6073 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6074 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0); /* fake */
6075 key.mv_size = csrc->mc_db->md_pad;
6076 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6078 data.mv_data = NULL;
6082 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
6083 assert(!((long)srcnode&1));
6084 srcpg = NODEPGNO(srcnode);
6085 flags = srcnode->mn_flags;
6086 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6087 unsigned int snum = csrc->mc_snum;
6089 /* must find the lowest key below src */
6090 mdb_page_search_lowest(csrc);
6091 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6092 key.mv_size = csrc->mc_db->md_pad;
6093 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6095 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6096 key.mv_size = NODEKSZ(s2);
6097 key.mv_data = NODEKEY(s2);
6099 csrc->mc_snum = snum--;
6100 csrc->mc_top = snum;
6102 key.mv_size = NODEKSZ(srcnode);
6103 key.mv_data = NODEKEY(srcnode);
6105 data.mv_size = NODEDSZ(srcnode);
6106 data.mv_data = NODEDATA(srcnode);
6108 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
6109 unsigned int snum = cdst->mc_snum;
6112 /* must find the lowest key below dst */
6113 mdb_page_search_lowest(cdst);
6114 if (IS_LEAF2(cdst->mc_pg[cdst->mc_top])) {
6115 bkey.mv_size = cdst->mc_db->md_pad;
6116 bkey.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, bkey.mv_size);
6118 s2 = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6119 bkey.mv_size = NODEKSZ(s2);
6120 bkey.mv_data = NODEKEY(s2);
6122 cdst->mc_snum = snum--;
6123 cdst->mc_top = snum;
6124 mdb_cursor_copy(cdst, &mn);
6126 rc = mdb_update_key(&mn, &bkey);
6131 DPRINTF("moving %s node %u [%s] on page %zu to node %u on page %zu",
6132 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
6133 csrc->mc_ki[csrc->mc_top],
6135 csrc->mc_pg[csrc->mc_top]->mp_pgno,
6136 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno);
6138 /* Add the node to the destination page.
6140 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
6141 if (rc != MDB_SUCCESS)
6144 /* Delete the node from the source page.
6146 mdb_node_del(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
6149 /* Adjust other cursors pointing to mp */
6150 MDB_cursor *m2, *m3;
6151 MDB_dbi dbi = csrc->mc_dbi;
6152 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
6154 if (csrc->mc_flags & C_SUB)
6157 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6158 if (csrc->mc_flags & C_SUB)
6159 m3 = &m2->mc_xcursor->mx_cursor;
6162 if (m3 == csrc) continue;
6163 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
6164 csrc->mc_ki[csrc->mc_top]) {
6165 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
6166 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
6171 /* Update the parent separators.
6173 if (csrc->mc_ki[csrc->mc_top] == 0) {
6174 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
6175 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6176 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6178 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6179 key.mv_size = NODEKSZ(srcnode);
6180 key.mv_data = NODEKEY(srcnode);
6182 DPRINTF("update separator for source page %zu to [%s]",
6183 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key));
6184 mdb_cursor_copy(csrc, &mn);
6187 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6190 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6192 indx_t ix = csrc->mc_ki[csrc->mc_top];
6193 nullkey.mv_size = 0;
6194 csrc->mc_ki[csrc->mc_top] = 0;
6195 rc = mdb_update_key(csrc, &nullkey);
6196 csrc->mc_ki[csrc->mc_top] = ix;
6197 assert(rc == MDB_SUCCESS);
6201 if (cdst->mc_ki[cdst->mc_top] == 0) {
6202 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
6203 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6204 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
6206 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
6207 key.mv_size = NODEKSZ(srcnode);
6208 key.mv_data = NODEKEY(srcnode);
6210 DPRINTF("update separator for destination page %zu to [%s]",
6211 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key));
6212 mdb_cursor_copy(cdst, &mn);
6215 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
6218 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
6220 indx_t ix = cdst->mc_ki[cdst->mc_top];
6221 nullkey.mv_size = 0;
6222 cdst->mc_ki[cdst->mc_top] = 0;
6223 rc = mdb_update_key(cdst, &nullkey);
6224 cdst->mc_ki[cdst->mc_top] = ix;
6225 assert(rc == MDB_SUCCESS);
6232 /** Merge one page into another.
6233 * The nodes from the page pointed to by \b csrc will
6234 * be copied to the page pointed to by \b cdst and then
6235 * the \b csrc page will be freed.
6236 * @param[in] csrc Cursor pointing to the source page.
6237 * @param[in] cdst Cursor pointing to the destination page.
6240 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
6248 DPRINTF("merging page %zu into %zu", csrc->mc_pg[csrc->mc_top]->mp_pgno,
6249 cdst->mc_pg[cdst->mc_top]->mp_pgno);
6251 assert(csrc->mc_snum > 1); /* can't merge root page */
6252 assert(cdst->mc_snum > 1);
6254 /* Mark dst as dirty. */
6255 if ((rc = mdb_page_touch(cdst)))
6258 /* Move all nodes from src to dst.
6260 j = nkeys = NUMKEYS(cdst->mc_pg[cdst->mc_top]);
6261 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6262 key.mv_size = csrc->mc_db->md_pad;
6263 key.mv_data = METADATA(csrc->mc_pg[csrc->mc_top]);
6264 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6265 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
6266 if (rc != MDB_SUCCESS)
6268 key.mv_data = (char *)key.mv_data + key.mv_size;
6271 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
6272 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], i);
6273 if (i == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
6274 unsigned int snum = csrc->mc_snum;
6276 /* must find the lowest key below src */
6277 mdb_page_search_lowest(csrc);
6278 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
6279 key.mv_size = csrc->mc_db->md_pad;
6280 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
6282 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
6283 key.mv_size = NODEKSZ(s2);
6284 key.mv_data = NODEKEY(s2);
6286 csrc->mc_snum = snum--;
6287 csrc->mc_top = snum;
6289 key.mv_size = srcnode->mn_ksize;
6290 key.mv_data = NODEKEY(srcnode);
6293 data.mv_size = NODEDSZ(srcnode);
6294 data.mv_data = NODEDATA(srcnode);
6295 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
6296 if (rc != MDB_SUCCESS)
6301 DPRINTF("dst page %zu now has %u keys (%.1f%% filled)",
6302 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);
6304 /* Unlink the src page from parent and add to free list.
6306 mdb_node_del(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1], 0);
6307 if (csrc->mc_ki[csrc->mc_top-1] == 0) {
6310 rc = mdb_update_key(csrc, &key);
6316 rc = mdb_midl_append(&csrc->mc_txn->mt_free_pgs,
6317 csrc->mc_pg[csrc->mc_top]->mp_pgno);
6320 if (IS_LEAF(csrc->mc_pg[csrc->mc_top]))
6321 csrc->mc_db->md_leaf_pages--;
6323 csrc->mc_db->md_branch_pages--;
6325 /* Adjust other cursors pointing to mp */
6326 MDB_cursor *m2, *m3;
6327 MDB_dbi dbi = csrc->mc_dbi;
6328 MDB_page *mp = cdst->mc_pg[cdst->mc_top];
6330 if (csrc->mc_flags & C_SUB)
6333 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6334 if (csrc->mc_flags & C_SUB)
6335 m3 = &m2->mc_xcursor->mx_cursor;
6338 if (m3 == csrc) continue;
6339 if (m3->mc_snum < csrc->mc_snum) continue;
6340 if (m3->mc_pg[csrc->mc_top] == csrc->mc_pg[csrc->mc_top]) {
6341 m3->mc_pg[csrc->mc_top] = mp;
6342 m3->mc_ki[csrc->mc_top] += nkeys;
6346 mdb_cursor_pop(csrc);
6348 return mdb_rebalance(csrc);
6351 /** Copy the contents of a cursor.
6352 * @param[in] csrc The cursor to copy from.
6353 * @param[out] cdst The cursor to copy to.
6356 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
6360 cdst->mc_txn = csrc->mc_txn;
6361 cdst->mc_dbi = csrc->mc_dbi;
6362 cdst->mc_db = csrc->mc_db;
6363 cdst->mc_dbx = csrc->mc_dbx;
6364 cdst->mc_snum = csrc->mc_snum;
6365 cdst->mc_top = csrc->mc_top;
6366 cdst->mc_flags = csrc->mc_flags;
6368 for (i=0; i<csrc->mc_snum; i++) {
6369 cdst->mc_pg[i] = csrc->mc_pg[i];
6370 cdst->mc_ki[i] = csrc->mc_ki[i];
6374 /** Rebalance the tree after a delete operation.
6375 * @param[in] mc Cursor pointing to the page where rebalancing
6377 * @return 0 on success, non-zero on failure.
6380 mdb_rebalance(MDB_cursor *mc)
6384 unsigned int ptop, minkeys;
6387 minkeys = 1 + (IS_BRANCH(mc->mc_pg[mc->mc_top]));
6391 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6392 DPRINTF("rebalancing %s page %zu (has %u keys, %.1f%% full)",
6393 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
6394 pgno, NUMKEYS(mc->mc_pg[mc->mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10);
6398 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD &&
6399 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
6402 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
6403 DPRINTF("no need to rebalance page %zu, above fill threshold",
6409 if (mc->mc_snum < 2) {
6410 MDB_page *mp = mc->mc_pg[0];
6412 DPUTS("Can't rebalance a subpage, ignoring");
6415 if (NUMKEYS(mp) == 0) {
6416 DPUTS("tree is completely empty");
6417 mc->mc_db->md_root = P_INVALID;
6418 mc->mc_db->md_depth = 0;
6419 mc->mc_db->md_leaf_pages = 0;
6420 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6423 /* Adjust cursors pointing to mp */
6427 MDB_cursor *m2, *m3;
6428 MDB_dbi dbi = mc->mc_dbi;
6430 if (mc->mc_flags & C_SUB)
6433 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6434 if (mc->mc_flags & C_SUB)
6435 m3 = &m2->mc_xcursor->mx_cursor;
6438 if (m3->mc_snum < mc->mc_snum) continue;
6439 if (m3->mc_pg[0] == mp) {
6445 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
6446 DPUTS("collapsing root page!");
6447 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
6450 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
6451 rc = mdb_page_get(mc->mc_txn,mc->mc_db->md_root,&mc->mc_pg[0],NULL);
6454 mc->mc_db->md_depth--;
6455 mc->mc_db->md_branch_pages--;
6457 /* Adjust other cursors pointing to mp */
6458 MDB_cursor *m2, *m3;
6459 MDB_dbi dbi = mc->mc_dbi;
6461 if (mc->mc_flags & C_SUB)
6464 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6465 if (mc->mc_flags & C_SUB)
6466 m3 = &m2->mc_xcursor->mx_cursor;
6469 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
6470 if (m3->mc_pg[0] == mp) {
6471 m3->mc_pg[0] = mc->mc_pg[0];
6478 DPUTS("root page doesn't need rebalancing");
6482 /* The parent (branch page) must have at least 2 pointers,
6483 * otherwise the tree is invalid.
6485 ptop = mc->mc_top-1;
6486 assert(NUMKEYS(mc->mc_pg[ptop]) > 1);
6488 /* Leaf page fill factor is below the threshold.
6489 * Try to move keys from left or right neighbor, or
6490 * merge with a neighbor page.
6495 mdb_cursor_copy(mc, &mn);
6496 mn.mc_xcursor = NULL;
6498 if (mc->mc_ki[ptop] == 0) {
6499 /* We're the leftmost leaf in our parent.
6501 DPUTS("reading right neighbor");
6503 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6504 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
6507 mn.mc_ki[mn.mc_top] = 0;
6508 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
6510 /* There is at least one neighbor to the left.
6512 DPUTS("reading left neighbor");
6514 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
6515 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
6518 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
6519 mc->mc_ki[mc->mc_top] = 0;
6522 DPRINTF("found neighbor page %zu (%u keys, %.1f%% full)",
6523 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);
6525 /* If the neighbor page is above threshold and has enough keys,
6526 * move one key from it. Otherwise we should try to merge them.
6527 * (A branch page must never have less than 2 keys.)
6529 minkeys = 1 + (IS_BRANCH(mn.mc_pg[mn.mc_top]));
6530 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys)
6531 return mdb_node_move(&mn, mc);
6533 if (mc->mc_ki[ptop] == 0)
6534 rc = mdb_page_merge(&mn, mc);
6536 rc = mdb_page_merge(mc, &mn);
6537 mc->mc_flags &= ~C_INITIALIZED;
6542 /** Complete a delete operation started by #mdb_cursor_del(). */
6544 mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf)
6550 mp = mc->mc_pg[mc->mc_top];
6551 ki = mc->mc_ki[mc->mc_top];
6553 /* add overflow pages to free list */
6554 if (!IS_LEAF2(mp) && F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6558 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6559 if ((rc = mdb_page_get(mc->mc_txn, pg, &omp, NULL)) ||
6560 (rc = mdb_ovpage_free(mc, omp)))
6563 mdb_node_del(mp, ki, mc->mc_db->md_pad);
6564 mc->mc_db->md_entries--;
6565 rc = mdb_rebalance(mc);
6566 if (rc != MDB_SUCCESS)
6567 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6568 /* if mc points past last node in page, invalidate */
6569 else if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6570 mc->mc_flags &= ~C_INITIALIZED;
6573 /* Adjust other cursors pointing to mp */
6576 MDB_dbi dbi = mc->mc_dbi;
6578 mp = mc->mc_pg[mc->mc_top];
6579 nkeys = NUMKEYS(mp);
6580 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6583 if (!(m2->mc_flags & C_INITIALIZED))
6585 if (m2->mc_pg[mc->mc_top] == mp) {
6586 if (m2->mc_ki[mc->mc_top] > ki)
6587 m2->mc_ki[mc->mc_top]--;
6588 if (m2->mc_ki[mc->mc_top] >= nkeys)
6589 m2->mc_flags &= ~C_INITIALIZED;
6598 mdb_del(MDB_txn *txn, MDB_dbi dbi,
6599 MDB_val *key, MDB_val *data)
6604 MDB_val rdata, *xdata;
6608 assert(key != NULL);
6610 DPRINTF("====> delete db %u key [%s]", dbi, DKEY(key));
6612 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
6615 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
6619 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
6623 mdb_cursor_init(&mc, txn, dbi, &mx);
6634 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
6636 /* let mdb_page_split know about this cursor if needed:
6637 * delete will trigger a rebalance; if it needs to move
6638 * a node from one page to another, it will have to
6639 * update the parent's separator key(s). If the new sepkey
6640 * is larger than the current one, the parent page may
6641 * run out of space, triggering a split. We need this
6642 * cursor to be consistent until the end of the rebalance.
6644 mc.mc_next = txn->mt_cursors[dbi];
6645 txn->mt_cursors[dbi] = &mc;
6646 rc = mdb_cursor_del(&mc, data ? 0 : MDB_NODUPDATA);
6647 txn->mt_cursors[dbi] = mc.mc_next;
6652 /** Split a page and insert a new node.
6653 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
6654 * The cursor will be updated to point to the actual page and index where
6655 * the node got inserted after the split.
6656 * @param[in] newkey The key for the newly inserted node.
6657 * @param[in] newdata The data for the newly inserted node.
6658 * @param[in] newpgno The page number, if the new node is a branch node.
6659 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
6660 * @return 0 on success, non-zero on failure.
6663 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
6664 unsigned int nflags)
6667 int rc = MDB_SUCCESS, ins_new = 0, new_root = 0, newpos = 1, did_split = 0;
6670 unsigned int i, j, split_indx, nkeys, pmax;
6672 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
6674 MDB_page *mp, *rp, *pp;
6679 mp = mc->mc_pg[mc->mc_top];
6680 newindx = mc->mc_ki[mc->mc_top];
6682 DPRINTF("-----> splitting %s page %zu and adding [%s] at index %i",
6683 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
6684 DKEY(newkey), mc->mc_ki[mc->mc_top]);
6686 /* Create a right sibling. */
6687 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
6689 DPRINTF("new right sibling: page %zu", rp->mp_pgno);
6691 if (mc->mc_snum < 2) {
6692 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
6694 /* shift current top to make room for new parent */
6695 mc->mc_pg[1] = mc->mc_pg[0];
6696 mc->mc_ki[1] = mc->mc_ki[0];
6699 mc->mc_db->md_root = pp->mp_pgno;
6700 DPRINTF("root split! new root = %zu", pp->mp_pgno);
6701 mc->mc_db->md_depth++;
6704 /* Add left (implicit) pointer. */
6705 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
6706 /* undo the pre-push */
6707 mc->mc_pg[0] = mc->mc_pg[1];
6708 mc->mc_ki[0] = mc->mc_ki[1];
6709 mc->mc_db->md_root = mp->mp_pgno;
6710 mc->mc_db->md_depth--;
6717 ptop = mc->mc_top-1;
6718 DPRINTF("parent branch page is %zu", mc->mc_pg[ptop]->mp_pgno);
6721 mc->mc_flags |= C_SPLITTING;
6722 mdb_cursor_copy(mc, &mn);
6723 mn.mc_pg[mn.mc_top] = rp;
6724 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
6726 if (nflags & MDB_APPEND) {
6727 mn.mc_ki[mn.mc_top] = 0;
6729 split_indx = newindx;
6734 nkeys = NUMKEYS(mp);
6735 split_indx = nkeys / 2;
6736 if (newindx < split_indx)
6742 unsigned int lsize, rsize, ksize;
6743 /* Move half of the keys to the right sibling */
6745 x = mc->mc_ki[mc->mc_top] - split_indx;
6746 ksize = mc->mc_db->md_pad;
6747 split = LEAF2KEY(mp, split_indx, ksize);
6748 rsize = (nkeys - split_indx) * ksize;
6749 lsize = (nkeys - split_indx) * sizeof(indx_t);
6750 mp->mp_lower -= lsize;
6751 rp->mp_lower += lsize;
6752 mp->mp_upper += rsize - lsize;
6753 rp->mp_upper -= rsize - lsize;
6754 sepkey.mv_size = ksize;
6755 if (newindx == split_indx) {
6756 sepkey.mv_data = newkey->mv_data;
6758 sepkey.mv_data = split;
6761 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
6762 memcpy(rp->mp_ptrs, split, rsize);
6763 sepkey.mv_data = rp->mp_ptrs;
6764 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
6765 memcpy(ins, newkey->mv_data, ksize);
6766 mp->mp_lower += sizeof(indx_t);
6767 mp->mp_upper -= ksize - sizeof(indx_t);
6770 memcpy(rp->mp_ptrs, split, x * ksize);
6771 ins = LEAF2KEY(rp, x, ksize);
6772 memcpy(ins, newkey->mv_data, ksize);
6773 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
6774 rp->mp_lower += sizeof(indx_t);
6775 rp->mp_upper -= ksize - sizeof(indx_t);
6776 mc->mc_ki[mc->mc_top] = x;
6777 mc->mc_pg[mc->mc_top] = rp;
6782 /* For leaf pages, check the split point based on what
6783 * fits where, since otherwise mdb_node_add can fail.
6785 * This check is only needed when the data items are
6786 * relatively large, such that being off by one will
6787 * make the difference between success or failure.
6789 * It's also relevant if a page happens to be laid out
6790 * such that one half of its nodes are all "small" and
6791 * the other half of its nodes are "large." If the new
6792 * item is also "large" and falls on the half with
6793 * "large" nodes, it also may not fit.
6796 unsigned int psize, nsize;
6797 /* Maximum free space in an empty page */
6798 pmax = mc->mc_txn->mt_env->me_psize - PAGEHDRSZ;
6799 nsize = mdb_leaf_size(mc->mc_txn->mt_env, newkey, newdata);
6800 if ((nkeys < 20) || (nsize > pmax/16)) {
6801 if (newindx <= split_indx) {
6804 for (i=0; i<split_indx; i++) {
6805 node = NODEPTR(mp, i);
6806 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6807 if (F_ISSET(node->mn_flags, F_BIGDATA))
6808 psize += sizeof(pgno_t);
6810 psize += NODEDSZ(node);
6814 split_indx = newindx;
6825 for (i=nkeys-1; i>=split_indx; i--) {
6826 node = NODEPTR(mp, i);
6827 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
6828 if (F_ISSET(node->mn_flags, F_BIGDATA))
6829 psize += sizeof(pgno_t);
6831 psize += NODEDSZ(node);
6835 split_indx = newindx;
6846 /* First find the separating key between the split pages.
6847 * The case where newindx == split_indx is ambiguous; the
6848 * new item could go to the new page or stay on the original
6849 * page. If newpos == 1 it goes to the new page.
6851 if (newindx == split_indx && newpos) {
6852 sepkey.mv_size = newkey->mv_size;
6853 sepkey.mv_data = newkey->mv_data;
6855 node = NODEPTR(mp, split_indx);
6856 sepkey.mv_size = node->mn_ksize;
6857 sepkey.mv_data = NODEKEY(node);
6861 DPRINTF("separator is [%s]", DKEY(&sepkey));
6863 /* Copy separator key to the parent.
6865 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(mc->mc_txn->mt_env, &sepkey)) {
6869 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
6872 if (mn.mc_snum == mc->mc_snum) {
6873 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
6874 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
6875 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
6876 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
6881 /* Right page might now have changed parent.
6882 * Check if left page also changed parent.
6884 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
6885 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
6886 for (i=0; i<ptop; i++) {
6887 mc->mc_pg[i] = mn.mc_pg[i];
6888 mc->mc_ki[i] = mn.mc_ki[i];
6890 mc->mc_pg[ptop] = mn.mc_pg[ptop];
6891 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
6895 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
6898 mc->mc_flags ^= C_SPLITTING;
6899 if (rc != MDB_SUCCESS) {
6902 if (nflags & MDB_APPEND) {
6903 mc->mc_pg[mc->mc_top] = rp;
6904 mc->mc_ki[mc->mc_top] = 0;
6905 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
6908 for (i=0; i<mc->mc_top; i++)
6909 mc->mc_ki[i] = mn.mc_ki[i];
6916 /* Move half of the keys to the right sibling. */
6918 /* grab a page to hold a temporary copy */
6919 copy = mdb_page_malloc(mc->mc_txn, 1);
6923 copy->mp_pgno = mp->mp_pgno;
6924 copy->mp_flags = mp->mp_flags;
6925 copy->mp_lower = PAGEHDRSZ;
6926 copy->mp_upper = mc->mc_txn->mt_env->me_psize;
6927 mc->mc_pg[mc->mc_top] = copy;
6928 for (i = j = 0; i <= nkeys; j++) {
6929 if (i == split_indx) {
6930 /* Insert in right sibling. */
6931 /* Reset insert index for right sibling. */
6932 if (i != newindx || (newpos ^ ins_new)) {
6934 mc->mc_pg[mc->mc_top] = rp;
6938 if (i == newindx && !ins_new) {
6939 /* Insert the original entry that caused the split. */
6940 rkey.mv_data = newkey->mv_data;
6941 rkey.mv_size = newkey->mv_size;
6950 /* Update index for the new key. */
6951 mc->mc_ki[mc->mc_top] = j;
6952 } else if (i == nkeys) {
6955 node = NODEPTR(mp, i);
6956 rkey.mv_data = NODEKEY(node);
6957 rkey.mv_size = node->mn_ksize;
6959 xdata.mv_data = NODEDATA(node);
6960 xdata.mv_size = NODEDSZ(node);
6963 pgno = NODEPGNO(node);
6964 flags = node->mn_flags;
6969 if (!IS_LEAF(mp) && j == 0) {
6970 /* First branch index doesn't need key data. */
6974 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
6978 nkeys = NUMKEYS(copy);
6979 for (i=0; i<nkeys; i++)
6980 mp->mp_ptrs[i] = copy->mp_ptrs[i];
6981 mp->mp_lower = copy->mp_lower;
6982 mp->mp_upper = copy->mp_upper;
6983 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
6984 mc->mc_txn->mt_env->me_psize - copy->mp_upper);
6986 /* reset back to original page */
6987 if (newindx < split_indx || (!newpos && newindx == split_indx)) {
6988 mc->mc_pg[mc->mc_top] = mp;
6989 if (nflags & MDB_RESERVE) {
6990 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6991 if (!(node->mn_flags & F_BIGDATA))
6992 newdata->mv_data = NODEDATA(node);
6996 /* Make sure mc_ki is still valid.
6998 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
6999 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
7000 for (i=0; i<ptop; i++) {
7001 mc->mc_pg[i] = mn.mc_pg[i];
7002 mc->mc_ki[i] = mn.mc_ki[i];
7004 mc->mc_pg[ptop] = mn.mc_pg[ptop];
7005 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
7009 /* return tmp page to freelist */
7010 mdb_page_free(mc->mc_txn->mt_env, copy);
7013 /* Adjust other cursors pointing to mp */
7014 MDB_cursor *m2, *m3;
7015 MDB_dbi dbi = mc->mc_dbi;
7016 int fixup = NUMKEYS(mp);
7018 if (mc->mc_flags & C_SUB)
7021 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7022 if (mc->mc_flags & C_SUB)
7023 m3 = &m2->mc_xcursor->mx_cursor;
7028 if (!(m3->mc_flags & C_INITIALIZED))
7030 if (m3->mc_flags & C_SPLITTING)
7035 for (k=m3->mc_top; k>=0; k--) {
7036 m3->mc_ki[k+1] = m3->mc_ki[k];
7037 m3->mc_pg[k+1] = m3->mc_pg[k];
7039 if (m3->mc_ki[0] >= split_indx) {
7044 m3->mc_pg[0] = mc->mc_pg[0];
7048 if (m3->mc_pg[mc->mc_top] == mp) {
7049 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
7050 m3->mc_ki[mc->mc_top]++;
7051 if (m3->mc_ki[mc->mc_top] >= fixup) {
7052 m3->mc_pg[mc->mc_top] = rp;
7053 m3->mc_ki[mc->mc_top] -= fixup;
7054 m3->mc_ki[ptop] = mn.mc_ki[ptop];
7056 } else if (!did_split && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
7057 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
7066 mdb_put(MDB_txn *txn, MDB_dbi dbi,
7067 MDB_val *key, MDB_val *data, unsigned int flags)
7072 assert(key != NULL);
7073 assert(data != NULL);
7075 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7078 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
7082 if (key->mv_size == 0 || key->mv_size > MDB_MAXKEYSIZE) {
7086 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP)) != flags)
7089 mdb_cursor_init(&mc, txn, dbi, &mx);
7090 return mdb_cursor_put(&mc, key, data, flags);
7094 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
7096 if ((flag & CHANGEABLE) != flag)
7099 env->me_flags |= flag;
7101 env->me_flags &= ~flag;
7106 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
7111 *arg = env->me_flags;
7116 mdb_env_get_path(MDB_env *env, const char **arg)
7121 *arg = env->me_path;
7125 /** Common code for #mdb_stat() and #mdb_env_stat().
7126 * @param[in] env the environment to operate in.
7127 * @param[in] db the #MDB_db record containing the stats to return.
7128 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
7129 * @return 0, this function always succeeds.
7132 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
7134 arg->ms_psize = env->me_psize;
7135 arg->ms_depth = db->md_depth;
7136 arg->ms_branch_pages = db->md_branch_pages;
7137 arg->ms_leaf_pages = db->md_leaf_pages;
7138 arg->ms_overflow_pages = db->md_overflow_pages;
7139 arg->ms_entries = db->md_entries;
7144 mdb_env_stat(MDB_env *env, MDB_stat *arg)
7148 if (env == NULL || arg == NULL)
7151 toggle = mdb_env_pick_meta(env);
7153 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
7157 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
7161 if (env == NULL || arg == NULL)
7164 toggle = mdb_env_pick_meta(env);
7165 arg->me_mapaddr = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : 0;
7166 arg->me_mapsize = env->me_mapsize;
7167 arg->me_maxreaders = env->me_maxreaders;
7168 arg->me_numreaders = env->me_numreaders;
7169 arg->me_last_pgno = env->me_metas[toggle]->mm_last_pg;
7170 arg->me_last_txnid = env->me_metas[toggle]->mm_txnid;
7174 /** Set the default comparison functions for a database.
7175 * Called immediately after a database is opened to set the defaults.
7176 * The user can then override them with #mdb_set_compare() or
7177 * #mdb_set_dupsort().
7178 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
7179 * @param[in] dbi A database handle returned by #mdb_dbi_open()
7182 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
7184 uint16_t f = txn->mt_dbs[dbi].md_flags;
7186 txn->mt_dbxs[dbi].md_cmp =
7187 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
7188 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
7190 txn->mt_dbxs[dbi].md_dcmp =
7191 !(f & MDB_DUPSORT) ? 0 :
7192 ((f & MDB_INTEGERDUP)
7193 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
7194 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
7197 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
7202 int rc, dbflag, exact;
7203 unsigned int unused = 0;
7206 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
7207 mdb_default_cmp(txn, FREE_DBI);
7210 if ((flags & VALID_FLAGS) != flags)
7216 if (flags & PERSISTENT_FLAGS) {
7217 uint16_t f2 = flags & PERSISTENT_FLAGS;
7218 /* make sure flag changes get committed */
7219 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
7220 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
7221 txn->mt_flags |= MDB_TXN_DIRTY;
7224 mdb_default_cmp(txn, MAIN_DBI);
7228 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
7229 mdb_default_cmp(txn, MAIN_DBI);
7232 /* Is the DB already open? */
7234 for (i=2; i<txn->mt_numdbs; i++) {
7235 if (!txn->mt_dbxs[i].md_name.mv_size) {
7236 /* Remember this free slot */
7237 if (!unused) unused = i;
7240 if (len == txn->mt_dbxs[i].md_name.mv_size &&
7241 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
7247 /* If no free slot and max hit, fail */
7248 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
7249 return MDB_DBS_FULL;
7251 /* Cannot mix named databases with some mainDB flags */
7252 if (txn->mt_dbs[MAIN_DBI].md_flags & (MDB_DUPSORT|MDB_INTEGERKEY))
7253 return (flags & MDB_CREATE) ? MDB_INCOMPATIBLE : MDB_NOTFOUND;
7255 /* Find the DB info */
7256 dbflag = DB_NEW|DB_VALID;
7259 key.mv_data = (void *)name;
7260 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
7261 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
7262 if (rc == MDB_SUCCESS) {
7263 /* make sure this is actually a DB */
7264 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
7265 if (!(node->mn_flags & F_SUBDATA))
7267 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
7268 /* Create if requested */
7270 data.mv_size = sizeof(MDB_db);
7271 data.mv_data = &dummy;
7272 memset(&dummy, 0, sizeof(dummy));
7273 dummy.md_root = P_INVALID;
7274 dummy.md_flags = flags & PERSISTENT_FLAGS;
7275 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
7279 /* OK, got info, add to table */
7280 if (rc == MDB_SUCCESS) {
7281 unsigned int slot = unused ? unused : txn->mt_numdbs;
7282 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
7283 txn->mt_dbxs[slot].md_name.mv_size = len;
7284 txn->mt_dbxs[slot].md_rel = NULL;
7285 txn->mt_dbflags[slot] = dbflag;
7286 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
7288 txn->mt_env->me_dbflags[slot] = txn->mt_dbs[slot].md_flags;
7289 mdb_default_cmp(txn, slot);
7298 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
7300 if (txn == NULL || arg == NULL || dbi >= txn->mt_numdbs)
7303 if (txn->mt_dbflags[dbi] & DB_STALE) {
7306 /* Stale, must read the DB's root. cursor_init does it for us. */
7307 mdb_cursor_init(&mc, txn, dbi, &mx);
7309 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
7312 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
7315 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
7317 ptr = env->me_dbxs[dbi].md_name.mv_data;
7318 env->me_dbxs[dbi].md_name.mv_data = NULL;
7319 env->me_dbxs[dbi].md_name.mv_size = 0;
7320 env->me_dbflags[dbi] = 0;
7324 /** Add all the DB's pages to the free list.
7325 * @param[in] mc Cursor on the DB to free.
7326 * @param[in] subs non-Zero to check for sub-DBs in this DB.
7327 * @return 0 on success, non-zero on failure.
7330 mdb_drop0(MDB_cursor *mc, int subs)
7334 rc = mdb_page_search(mc, NULL, 0);
7335 if (rc == MDB_SUCCESS) {
7336 MDB_txn *txn = mc->mc_txn;
7341 /* LEAF2 pages have no nodes, cannot have sub-DBs */
7342 if (IS_LEAF2(mc->mc_pg[mc->mc_top]))
7345 mdb_cursor_copy(mc, &mx);
7346 while (mc->mc_snum > 0) {
7347 MDB_page *mp = mc->mc_pg[mc->mc_top];
7348 unsigned n = NUMKEYS(mp);
7350 for (i=0; i<n; i++) {
7351 ni = NODEPTR(mp, i);
7352 if (ni->mn_flags & F_BIGDATA) {
7355 memcpy(&pg, NODEDATA(ni), sizeof(pg));
7356 rc = mdb_page_get(txn, pg, &omp, NULL);
7359 assert(IS_OVERFLOW(omp));
7360 rc = mdb_midl_append_range(&txn->mt_free_pgs,
7364 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
7365 mdb_xcursor_init1(mc, ni);
7366 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
7372 if ((rc = mdb_midl_need(&txn->mt_free_pgs, n)) != 0)
7374 for (i=0; i<n; i++) {
7376 ni = NODEPTR(mp, i);
7379 mdb_midl_xappend(txn->mt_free_pgs, pg);
7384 mc->mc_ki[mc->mc_top] = i;
7385 rc = mdb_cursor_sibling(mc, 1);
7387 /* no more siblings, go back to beginning
7388 * of previous level.
7392 for (i=1; i<mc->mc_snum; i++) {
7394 mc->mc_pg[i] = mx.mc_pg[i];
7399 rc = mdb_midl_append(&txn->mt_free_pgs, mc->mc_db->md_root);
7400 } else if (rc == MDB_NOTFOUND) {
7406 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
7408 MDB_cursor *mc, *m2;
7411 if (!txn || !dbi || dbi >= txn->mt_numdbs || (unsigned)del > 1 || !(txn->mt_dbflags[dbi] & DB_VALID))
7414 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
7417 rc = mdb_cursor_open(txn, dbi, &mc);
7421 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
7422 /* Invalidate the dropped DB's cursors */
7423 for (m2 = txn->mt_cursors[dbi]; m2; m2 = m2->mc_next)
7424 m2->mc_flags &= ~C_INITIALIZED;
7428 /* Can't delete the main DB */
7429 if (del && dbi > MAIN_DBI) {
7430 rc = mdb_del(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL);
7432 txn->mt_dbflags[dbi] = DB_STALE;
7433 mdb_dbi_close(txn->mt_env, dbi);
7436 /* reset the DB record, mark it dirty */
7437 txn->mt_dbflags[dbi] |= DB_DIRTY;
7438 txn->mt_dbs[dbi].md_depth = 0;
7439 txn->mt_dbs[dbi].md_branch_pages = 0;
7440 txn->mt_dbs[dbi].md_leaf_pages = 0;
7441 txn->mt_dbs[dbi].md_overflow_pages = 0;
7442 txn->mt_dbs[dbi].md_entries = 0;
7443 txn->mt_dbs[dbi].md_root = P_INVALID;
7445 txn->mt_flags |= MDB_TXN_DIRTY;
7448 mdb_cursor_close(mc);
7452 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7454 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7457 txn->mt_dbxs[dbi].md_cmp = cmp;
7461 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
7463 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7466 txn->mt_dbxs[dbi].md_dcmp = cmp;
7470 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
7472 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7475 txn->mt_dbxs[dbi].md_rel = rel;
7479 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
7481 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs || !(txn->mt_dbflags[dbi] & DB_VALID))
7484 txn->mt_dbxs[dbi].md_relctx = ctx;
projects / openldap / blob