2 * @brief Lightning memory-mapped database library
4 * A Btree-based database management library modeled loosely on the
5 * BerkeleyDB API, but much simplified.
8 * Copyright 2011-2014 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.
41 /** getpid() returns int; MinGW defines pid_t but MinGW64 typedefs it
42 * as int64 which is wrong. MSVC doesn't define it at all, so just
46 #define MDB_THR_T DWORD
47 #include <sys/types.h>
50 # include <sys/param.h>
52 # define LITTLE_ENDIAN 1234
53 # define BIG_ENDIAN 4321
54 # define BYTE_ORDER LITTLE_ENDIAN
56 # define SSIZE_MAX INT_MAX
60 #include <sys/types.h>
62 #define MDB_PID_T pid_t
63 #define MDB_THR_T pthread_t
64 #include <sys/param.h>
67 #ifdef HAVE_SYS_FILE_H
83 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
84 #include <netinet/in.h>
85 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
88 #if defined(__APPLE__) || defined (BSD)
89 # define MDB_USE_POSIX_SEM 1
90 # define MDB_FDATASYNC fsync
91 #elif defined(ANDROID)
92 # define MDB_FDATASYNC fsync
97 #ifdef MDB_USE_POSIX_SEM
98 # define MDB_USE_HASH 1
99 #include <semaphore.h>
104 #include <valgrind/memcheck.h>
105 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
106 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
107 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
108 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
109 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
111 #define VGMEMP_CREATE(h,r,z)
112 #define VGMEMP_ALLOC(h,a,s)
113 #define VGMEMP_FREE(h,a)
114 #define VGMEMP_DESTROY(h)
115 #define VGMEMP_DEFINED(a,s)
119 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
120 /* Solaris just defines one or the other */
121 # define LITTLE_ENDIAN 1234
122 # define BIG_ENDIAN 4321
123 # ifdef _LITTLE_ENDIAN
124 # define BYTE_ORDER LITTLE_ENDIAN
126 # define BYTE_ORDER BIG_ENDIAN
129 # define BYTE_ORDER __BYTE_ORDER
133 #ifndef LITTLE_ENDIAN
134 #define LITTLE_ENDIAN __LITTLE_ENDIAN
137 #define BIG_ENDIAN __BIG_ENDIAN
140 #if defined(__i386) || defined(__x86_64) || defined(_M_IX86)
141 #define MISALIGNED_OK 1
147 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
148 # error "Unknown or unsupported endianness (BYTE_ORDER)"
149 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
150 # error "Two's complement, reasonably sized integer types, please"
154 /** Put infrequently used env functions in separate section */
156 # define ESECT __attribute__ ((section("__TEXT,text_env")))
158 # define ESECT __attribute__ ((section("text_env")))
164 /** @defgroup internal LMDB Internals
167 /** @defgroup compat Compatibility Macros
168 * A bunch of macros to minimize the amount of platform-specific ifdefs
169 * needed throughout the rest of the code. When the features this library
170 * needs are similar enough to POSIX to be hidden in a one-or-two line
171 * replacement, this macro approach is used.
175 /* Features under development */
180 /** Wrapper around __func__, which is a C99 feature */
181 #if __STDC_VERSION__ >= 199901L
182 # define mdb_func_ __func__
183 #elif __GNUC__ >= 2 || _MSC_VER >= 1300
184 # define mdb_func_ __FUNCTION__
186 /* If a debug message says <mdb_unknown>(), update the #if statements above */
187 # define mdb_func_ "<mdb_unknown>"
191 #define MDB_USE_HASH 1
192 #define MDB_PIDLOCK 0
193 #define THREAD_RET DWORD
194 #define pthread_t HANDLE
195 #define pthread_mutex_t HANDLE
196 #define pthread_cond_t HANDLE
197 #define pthread_key_t DWORD
198 #define pthread_self() GetCurrentThreadId()
199 #define pthread_key_create(x,y) \
200 ((*(x) = TlsAlloc()) == TLS_OUT_OF_INDEXES ? ErrCode() : 0)
201 #define pthread_key_delete(x) TlsFree(x)
202 #define pthread_getspecific(x) TlsGetValue(x)
203 #define pthread_setspecific(x,y) (TlsSetValue(x,y) ? 0 : ErrCode())
204 #define pthread_mutex_unlock(x) ReleaseMutex(*x)
205 #define pthread_mutex_lock(x) WaitForSingleObject(*x, INFINITE)
206 #define pthread_cond_signal(x) SetEvent(*x)
207 #define pthread_cond_wait(cond,mutex) do{SignalObjectAndWait(*mutex, *cond, INFINITE, FALSE); WaitForSingleObject(*mutex, INFINITE);}while(0)
208 #define THREAD_CREATE(thr,start,arg) thr=CreateThread(NULL,0,start,arg,0,NULL)
209 #define THREAD_FINISH(thr) WaitForSingleObject(thr, INFINITE)
210 #define LOCK_MUTEX_R(env) pthread_mutex_lock(&(env)->me_rmutex)
211 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock(&(env)->me_rmutex)
212 #define LOCK_MUTEX_W(env) pthread_mutex_lock(&(env)->me_wmutex)
213 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock(&(env)->me_wmutex)
214 #define getpid() GetCurrentProcessId()
215 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
216 #define MDB_MSYNC(addr,len,flags) (!FlushViewOfFile(addr,len))
217 #define ErrCode() GetLastError()
218 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
219 #define close(fd) (CloseHandle(fd) ? 0 : -1)
220 #define munmap(ptr,len) UnmapViewOfFile(ptr)
221 #ifdef PROCESS_QUERY_LIMITED_INFORMATION
222 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION PROCESS_QUERY_LIMITED_INFORMATION
224 #define MDB_PROCESS_QUERY_LIMITED_INFORMATION 0x1000
228 #define THREAD_RET void *
229 #define THREAD_CREATE(thr,start,arg) pthread_create(&thr,NULL,start,arg)
230 #define THREAD_FINISH(thr) pthread_join(thr,NULL)
231 #define Z "z" /**< printf format modifier for size_t */
233 /** For MDB_LOCK_FORMAT: True if readers take a pid lock in the lockfile */
234 #define MDB_PIDLOCK 1
236 #ifdef MDB_USE_POSIX_SEM
238 #define LOCK_MUTEX_R(env) mdb_sem_wait((env)->me_rmutex)
239 #define UNLOCK_MUTEX_R(env) sem_post((env)->me_rmutex)
240 #define LOCK_MUTEX_W(env) mdb_sem_wait((env)->me_wmutex)
241 #define UNLOCK_MUTEX_W(env) sem_post((env)->me_wmutex)
244 mdb_sem_wait(sem_t *sem)
247 while ((rc = sem_wait(sem)) && (rc = errno) == EINTR) ;
252 /** Lock the reader mutex.
254 #define LOCK_MUTEX_R(env) pthread_mutex_lock(&(env)->me_txns->mti_mutex)
255 /** Unlock the reader mutex.
257 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
259 /** Lock the writer mutex.
260 * Only a single write transaction is allowed at a time. Other writers
261 * will block waiting for this mutex.
263 #define LOCK_MUTEX_W(env) pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
264 /** Unlock the writer mutex.
266 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
267 #endif /* MDB_USE_POSIX_SEM */
269 /** Get the error code for the last failed system function.
271 #define ErrCode() errno
273 /** An abstraction for a file handle.
274 * On POSIX systems file handles are small integers. On Windows
275 * they're opaque pointers.
279 /** A value for an invalid file handle.
280 * Mainly used to initialize file variables and signify that they are
283 #define INVALID_HANDLE_VALUE (-1)
285 /** Get the size of a memory page for the system.
286 * This is the basic size that the platform's memory manager uses, and is
287 * fundamental to the use of memory-mapped files.
289 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
292 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
295 #define MNAME_LEN (sizeof(pthread_mutex_t))
301 /** A flag for opening a file and requesting synchronous data writes.
302 * This is only used when writing a meta page. It's not strictly needed;
303 * we could just do a normal write and then immediately perform a flush.
304 * But if this flag is available it saves us an extra system call.
306 * @note If O_DSYNC is undefined but exists in /usr/include,
307 * preferably set some compiler flag to get the definition.
308 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
311 # define MDB_DSYNC O_DSYNC
315 /** Function for flushing the data of a file. Define this to fsync
316 * if fdatasync() is not supported.
318 #ifndef MDB_FDATASYNC
319 # define MDB_FDATASYNC fdatasync
323 # define MDB_MSYNC(addr,len,flags) msync(addr,len,flags)
334 /** A page number in the database.
335 * Note that 64 bit page numbers are overkill, since pages themselves
336 * already represent 12-13 bits of addressable memory, and the OS will
337 * always limit applications to a maximum of 63 bits of address space.
339 * @note In the #MDB_node structure, we only store 48 bits of this value,
340 * which thus limits us to only 60 bits of addressable data.
342 typedef MDB_ID pgno_t;
344 /** A transaction ID.
345 * See struct MDB_txn.mt_txnid for details.
347 typedef MDB_ID txnid_t;
349 /** @defgroup debug Debug Macros
353 /** Enable debug output. Needs variable argument macros (a C99 feature).
354 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
355 * read from and written to the database (used for free space management).
361 static int mdb_debug;
362 static txnid_t mdb_debug_start;
364 /** Print a debug message with printf formatting.
365 * Requires double parenthesis around 2 or more args.
367 # define DPRINTF(args) ((void) ((mdb_debug) && DPRINTF0 args))
368 # define DPRINTF0(fmt, ...) \
369 fprintf(stderr, "%s:%d " fmt "\n", mdb_func_, __LINE__, __VA_ARGS__)
371 # define DPRINTF(args) ((void) 0)
373 /** Print a debug string.
374 * The string is printed literally, with no format processing.
376 #define DPUTS(arg) DPRINTF(("%s", arg))
377 /** Debuging output value of a cursor DBI: Negative in a sub-cursor. */
379 (((mc)->mc_flags & C_SUB) ? -(int)(mc)->mc_dbi : (int)(mc)->mc_dbi)
382 /** @brief The maximum size of a database page.
384 * It is 32k or 64k, since value-PAGEBASE must fit in
385 * #MDB_page.%mp_upper.
387 * LMDB will use database pages < OS pages if needed.
388 * That causes more I/O in write transactions: The OS must
389 * know (read) the whole page before writing a partial page.
391 * Note that we don't currently support Huge pages. On Linux,
392 * regular data files cannot use Huge pages, and in general
393 * Huge pages aren't actually pageable. We rely on the OS
394 * demand-pager to read our data and page it out when memory
395 * pressure from other processes is high. So until OSs have
396 * actual paging support for Huge pages, they're not viable.
398 #define MAX_PAGESIZE (PAGEBASE ? 0x10000 : 0x8000)
400 /** The minimum number of keys required in a database page.
401 * Setting this to a larger value will place a smaller bound on the
402 * maximum size of a data item. Data items larger than this size will
403 * be pushed into overflow pages instead of being stored directly in
404 * the B-tree node. This value used to default to 4. With a page size
405 * of 4096 bytes that meant that any item larger than 1024 bytes would
406 * go into an overflow page. That also meant that on average 2-3KB of
407 * each overflow page was wasted space. The value cannot be lower than
408 * 2 because then there would no longer be a tree structure. With this
409 * value, items larger than 2KB will go into overflow pages, and on
410 * average only 1KB will be wasted.
412 #define MDB_MINKEYS 2
414 /** A stamp that identifies a file as an LMDB file.
415 * There's nothing special about this value other than that it is easily
416 * recognizable, and it will reflect any byte order mismatches.
418 #define MDB_MAGIC 0xBEEFC0DE
420 /** The version number for a database's datafile format. */
421 #define MDB_DATA_VERSION ((MDB_DEVEL) ? 999 : 1)
422 /** The version number for a database's lockfile format. */
423 #define MDB_LOCK_VERSION 1
425 /** @brief The max size of a key we can write, or 0 for dynamic max.
427 * Define this as 0 to compute the max from the page size. 511
428 * is default for backwards compat: liblmdb <= 0.9.10 can break
429 * when modifying a DB with keys/dupsort data bigger than its max.
431 * Data items in an #MDB_DUPSORT database are also limited to
432 * this size, since they're actually keys of a sub-DB. Keys and
433 * #MDB_DUPSORT data items must fit on a node in a regular page.
435 #ifndef MDB_MAXKEYSIZE
436 #define MDB_MAXKEYSIZE 511
439 /** The maximum size of a key we can write to the environment. */
441 #define ENV_MAXKEY(env) (MDB_MAXKEYSIZE)
443 #define ENV_MAXKEY(env) ((env)->me_maxkey)
446 /** @brief The maximum size of a data item.
448 * We only store a 32 bit value for node sizes.
450 #define MAXDATASIZE 0xffffffffUL
453 /** Key size which fits in a #DKBUF.
456 #define DKBUF_MAXKEYSIZE ((MDB_MAXKEYSIZE) > 0 ? (MDB_MAXKEYSIZE) : 511)
459 * This is used for printing a hex dump of a key's contents.
461 #define DKBUF char kbuf[DKBUF_MAXKEYSIZE*2+1]
462 /** Display a key in hex.
464 * Invoke a function to display a key in hex.
466 #define DKEY(x) mdb_dkey(x, kbuf)
472 /** An invalid page number.
473 * Mainly used to denote an empty tree.
475 #define P_INVALID (~(pgno_t)0)
477 /** Test if the flags \b f are set in a flag word \b w. */
478 #define F_ISSET(w, f) (((w) & (f)) == (f))
480 /** Round \b n up to an even number. */
481 #define EVEN(n) (((n) + 1U) & -2) /* sign-extending -2 to match n+1U */
483 /** Used for offsets within a single page.
484 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
487 typedef uint16_t indx_t;
489 /** Default size of memory map.
490 * This is certainly too small for any actual applications. Apps should always set
491 * the size explicitly using #mdb_env_set_mapsize().
493 #define DEFAULT_MAPSIZE 1048576
495 /** @defgroup readers Reader Lock Table
496 * Readers don't acquire any locks for their data access. Instead, they
497 * simply record their transaction ID in the reader table. The reader
498 * mutex is needed just to find an empty slot in the reader table. The
499 * slot's address is saved in thread-specific data so that subsequent read
500 * transactions started by the same thread need no further locking to proceed.
502 * If #MDB_NOTLS is set, the slot address is not saved in thread-specific data.
504 * No reader table is used if the database is on a read-only filesystem, or
505 * if #MDB_NOLOCK is set.
507 * Since the database uses multi-version concurrency control, readers don't
508 * actually need any locking. This table is used to keep track of which
509 * readers are using data from which old transactions, so that we'll know
510 * when a particular old transaction is no longer in use. Old transactions
511 * that have discarded any data pages can then have those pages reclaimed
512 * for use by a later write transaction.
514 * The lock table is constructed such that reader slots are aligned with the
515 * processor's cache line size. Any slot is only ever used by one thread.
516 * This alignment guarantees that there will be no contention or cache
517 * thrashing as threads update their own slot info, and also eliminates
518 * any need for locking when accessing a slot.
520 * A writer thread will scan every slot in the table to determine the oldest
521 * outstanding reader transaction. Any freed pages older than this will be
522 * reclaimed by the writer. The writer doesn't use any locks when scanning
523 * this table. This means that there's no guarantee that the writer will
524 * see the most up-to-date reader info, but that's not required for correct
525 * operation - all we need is to know the upper bound on the oldest reader,
526 * we don't care at all about the newest reader. So the only consequence of
527 * reading stale information here is that old pages might hang around a
528 * while longer before being reclaimed. That's actually good anyway, because
529 * the longer we delay reclaiming old pages, the more likely it is that a
530 * string of contiguous pages can be found after coalescing old pages from
531 * many old transactions together.
534 /** Number of slots in the reader table.
535 * This value was chosen somewhat arbitrarily. 126 readers plus a
536 * couple mutexes fit exactly into 8KB on my development machine.
537 * Applications should set the table size using #mdb_env_set_maxreaders().
539 #define DEFAULT_READERS 126
541 /** The size of a CPU cache line in bytes. We want our lock structures
542 * aligned to this size to avoid false cache line sharing in the
544 * This value works for most CPUs. For Itanium this should be 128.
550 /** The information we store in a single slot of the reader table.
551 * In addition to a transaction ID, we also record the process and
552 * thread ID that owns a slot, so that we can detect stale information,
553 * e.g. threads or processes that went away without cleaning up.
554 * @note We currently don't check for stale records. We simply re-init
555 * the table when we know that we're the only process opening the
558 typedef struct MDB_rxbody {
559 /** Current Transaction ID when this transaction began, or (txnid_t)-1.
560 * Multiple readers that start at the same time will probably have the
561 * same ID here. Again, it's not important to exclude them from
562 * anything; all we need to know is which version of the DB they
563 * started from so we can avoid overwriting any data used in that
564 * particular version.
567 /** The process ID of the process owning this reader txn. */
569 /** The thread ID of the thread owning this txn. */
573 /** The actual reader record, with cacheline padding. */
574 typedef struct MDB_reader {
577 /** shorthand for mrb_txnid */
578 #define mr_txnid mru.mrx.mrb_txnid
579 #define mr_pid mru.mrx.mrb_pid
580 #define mr_tid mru.mrx.mrb_tid
581 /** cache line alignment */
582 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
586 /** The header for the reader table.
587 * The table resides in a memory-mapped file. (This is a different file
588 * than is used for the main database.)
590 * For POSIX the actual mutexes reside in the shared memory of this
591 * mapped file. On Windows, mutexes are named objects allocated by the
592 * kernel; we store the mutex names in this mapped file so that other
593 * processes can grab them. This same approach is also used on
594 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
595 * process-shared POSIX mutexes. For these cases where a named object
596 * is used, the object name is derived from a 64 bit FNV hash of the
597 * environment pathname. As such, naming collisions are extremely
598 * unlikely. If a collision occurs, the results are unpredictable.
600 typedef struct MDB_txbody {
601 /** Stamp identifying this as an LMDB file. It must be set
604 /** Format of this lock file. Must be set to #MDB_LOCK_FORMAT. */
606 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
607 char mtb_rmname[MNAME_LEN];
609 /** Mutex protecting access to this table.
610 * This is the reader lock that #LOCK_MUTEX_R acquires.
612 pthread_mutex_t mtb_mutex;
614 /** The ID of the last transaction committed to the database.
615 * This is recorded here only for convenience; the value can always
616 * be determined by reading the main database meta pages.
619 /** The number of slots that have been used in the reader table.
620 * This always records the maximum count, it is not decremented
621 * when readers release their slots.
623 unsigned mtb_numreaders;
626 /** The actual reader table definition. */
627 typedef struct MDB_txninfo {
630 #define mti_magic mt1.mtb.mtb_magic
631 #define mti_format mt1.mtb.mtb_format
632 #define mti_mutex mt1.mtb.mtb_mutex
633 #define mti_rmname mt1.mtb.mtb_rmname
634 #define mti_txnid mt1.mtb.mtb_txnid
635 #define mti_numreaders mt1.mtb.mtb_numreaders
636 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
639 #if defined(_WIN32) || defined(MDB_USE_POSIX_SEM)
640 char mt2_wmname[MNAME_LEN];
641 #define mti_wmname mt2.mt2_wmname
643 pthread_mutex_t mt2_wmutex;
644 #define mti_wmutex mt2.mt2_wmutex
646 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
648 MDB_reader mti_readers[1];
651 /** Lockfile format signature: version, features and field layout */
652 #define MDB_LOCK_FORMAT \
654 ((MDB_LOCK_VERSION) \
655 /* Flags which describe functionality */ \
656 + (((MDB_PIDLOCK) != 0) << 16)))
659 /** Common header for all page types.
660 * Overflow records occupy a number of contiguous pages with no
661 * headers on any page after the first.
663 typedef struct MDB_page {
664 #define mp_pgno mp_p.p_pgno
665 #define mp_next mp_p.p_next
667 pgno_t p_pgno; /**< page number */
668 struct MDB_page *p_next; /**< for in-memory list of freed pages */
671 /** @defgroup mdb_page Page Flags
673 * Flags for the page headers.
676 #define P_BRANCH 0x01 /**< branch page */
677 #define P_LEAF 0x02 /**< leaf page */
678 #define P_OVERFLOW 0x04 /**< overflow page */
679 #define P_META 0x08 /**< meta page */
680 #define P_DIRTY 0x10 /**< dirty page, also set for #P_SUBP pages */
681 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
682 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
683 #define P_LOOSE 0x4000 /**< page was dirtied then freed, can be reused */
684 #define P_KEEP 0x8000 /**< leave this page alone during spill */
686 uint16_t mp_flags; /**< @ref mdb_page */
687 #define mp_lower mp_pb.pb.pb_lower
688 #define mp_upper mp_pb.pb.pb_upper
689 #define mp_pages mp_pb.pb_pages
692 indx_t pb_lower; /**< lower bound of free space */
693 indx_t pb_upper; /**< upper bound of free space */
695 uint32_t pb_pages; /**< number of overflow pages */
697 indx_t mp_ptrs[1]; /**< dynamic size */
700 /** Size of the page header, excluding dynamic data at the end */
701 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
703 /** Address of first usable data byte in a page, after the header */
704 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
706 /** ITS#7713, change PAGEBASE to handle 65536 byte pages */
707 #define PAGEBASE ((MDB_DEVEL) ? PAGEHDRSZ : 0)
709 /** Number of nodes on a page */
710 #define NUMKEYS(p) (((p)->mp_lower - (PAGEHDRSZ-PAGEBASE)) >> 1)
712 /** The amount of space remaining in the page */
713 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
715 /** The percentage of space used in the page, in tenths of a percent. */
716 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
717 ((env)->me_psize - PAGEHDRSZ))
718 /** The minimum page fill factor, in tenths of a percent.
719 * Pages emptier than this are candidates for merging.
721 #define FILL_THRESHOLD 250
723 /** Test if a page is a leaf page */
724 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
725 /** Test if a page is a LEAF2 page */
726 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
727 /** Test if a page is a branch page */
728 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
729 /** Test if a page is an overflow page */
730 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
731 /** Test if a page is a sub page */
732 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
734 /** The number of overflow pages needed to store the given size. */
735 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
737 /** Link in #MDB_txn.%mt_loose_pages list */
738 #define NEXT_LOOSE_PAGE(p) (*(MDB_page **)((p) + 2))
740 /** Header for a single key/data pair within a page.
741 * Used in pages of type #P_BRANCH and #P_LEAF without #P_LEAF2.
742 * We guarantee 2-byte alignment for 'MDB_node's.
744 typedef struct MDB_node {
745 /** lo and hi are used for data size on leaf nodes and for
746 * child pgno on branch nodes. On 64 bit platforms, flags
747 * is also used for pgno. (Branch nodes have no flags).
748 * They are in host byte order in case that lets some
749 * accesses be optimized into a 32-bit word access.
751 #if BYTE_ORDER == LITTLE_ENDIAN
752 unsigned short mn_lo, mn_hi; /**< part of data size or pgno */
754 unsigned short mn_hi, mn_lo;
756 /** @defgroup mdb_node Node Flags
758 * Flags for node headers.
761 #define F_BIGDATA 0x01 /**< data put on overflow page */
762 #define F_SUBDATA 0x02 /**< data is a sub-database */
763 #define F_DUPDATA 0x04 /**< data has duplicates */
765 /** valid flags for #mdb_node_add() */
766 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
769 unsigned short mn_flags; /**< @ref mdb_node */
770 unsigned short mn_ksize; /**< key size */
771 char mn_data[1]; /**< key and data are appended here */
774 /** Size of the node header, excluding dynamic data at the end */
775 #define NODESIZE offsetof(MDB_node, mn_data)
777 /** Bit position of top word in page number, for shifting mn_flags */
778 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
780 /** Size of a node in a branch page with a given key.
781 * This is just the node header plus the key, there is no data.
783 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
785 /** Size of a node in a leaf page with a given key and data.
786 * This is node header plus key plus data size.
788 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
790 /** Address of node \b i in page \b p */
791 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i] + PAGEBASE))
793 /** Address of the key for the node */
794 #define NODEKEY(node) (void *)((node)->mn_data)
796 /** Address of the data for a node */
797 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
799 /** Get the page number pointed to by a branch node */
800 #define NODEPGNO(node) \
801 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
802 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
803 /** Set the page number in a branch node */
804 #define SETPGNO(node,pgno) do { \
805 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
806 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
808 /** Get the size of the data in a leaf node */
809 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
810 /** Set the size of the data for a leaf node */
811 #define SETDSZ(node,size) do { \
812 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
813 /** The size of a key in a node */
814 #define NODEKSZ(node) ((node)->mn_ksize)
816 /** Copy a page number from src to dst */
818 #define COPY_PGNO(dst,src) dst = src
820 #if SIZE_MAX > 4294967295UL
821 #define COPY_PGNO(dst,src) do { \
822 unsigned short *s, *d; \
823 s = (unsigned short *)&(src); \
824 d = (unsigned short *)&(dst); \
831 #define COPY_PGNO(dst,src) do { \
832 unsigned short *s, *d; \
833 s = (unsigned short *)&(src); \
834 d = (unsigned short *)&(dst); \
840 /** The address of a key in a LEAF2 page.
841 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
842 * There are no node headers, keys are stored contiguously.
844 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
846 /** Set the \b node's key into \b keyptr, if requested. */
847 #define MDB_GET_KEY(node, keyptr) { if ((keyptr) != NULL) { \
848 (keyptr)->mv_size = NODEKSZ(node); (keyptr)->mv_data = NODEKEY(node); } }
850 /** Set the \b node's key into \b key. */
851 #define MDB_GET_KEY2(node, key) { key.mv_size = NODEKSZ(node); key.mv_data = NODEKEY(node); }
853 /** Information about a single database in the environment. */
854 typedef struct MDB_db {
855 uint32_t md_pad; /**< also ksize for LEAF2 pages */
856 uint16_t md_flags; /**< @ref mdb_dbi_open */
857 uint16_t md_depth; /**< depth of this tree */
858 pgno_t md_branch_pages; /**< number of internal pages */
859 pgno_t md_leaf_pages; /**< number of leaf pages */
860 pgno_t md_overflow_pages; /**< number of overflow pages */
861 size_t md_entries; /**< number of data items */
862 pgno_t md_root; /**< the root page of this tree */
865 /** mdb_dbi_open flags */
866 #define MDB_VALID 0x8000 /**< DB handle is valid, for me_dbflags */
867 #define PERSISTENT_FLAGS (0xffff & ~(MDB_VALID))
868 #define VALID_FLAGS (MDB_REVERSEKEY|MDB_DUPSORT|MDB_INTEGERKEY|MDB_DUPFIXED|\
869 MDB_INTEGERDUP|MDB_REVERSEDUP|MDB_CREATE)
871 /** Handle for the DB used to track free pages. */
873 /** Handle for the default DB. */
876 /** Meta page content.
877 * A meta page is the start point for accessing a database snapshot.
878 * Pages 0-1 are meta pages. Transaction N writes meta page #(N % 2).
880 typedef struct MDB_meta {
881 /** Stamp identifying this as an LMDB file. It must be set
884 /** Version number of this lock file. Must be set to #MDB_DATA_VERSION. */
886 void *mm_address; /**< address for fixed mapping */
887 size_t mm_mapsize; /**< size of mmap region */
888 MDB_db mm_dbs[2]; /**< first is free space, 2nd is main db */
889 /** The size of pages used in this DB */
890 #define mm_psize mm_dbs[0].md_pad
891 /** Any persistent environment flags. @ref mdb_env */
892 #define mm_flags mm_dbs[0].md_flags
893 pgno_t mm_last_pg; /**< last used page in file */
894 txnid_t mm_txnid; /**< txnid that committed this page */
897 /** Buffer for a stack-allocated meta page.
898 * The members define size and alignment, and silence type
899 * aliasing warnings. They are not used directly; that could
900 * mean incorrectly using several union members in parallel.
902 typedef union MDB_metabuf {
905 char mm_pad[PAGEHDRSZ];
910 /** Auxiliary DB info.
911 * The information here is mostly static/read-only. There is
912 * only a single copy of this record in the environment.
914 typedef struct MDB_dbx {
915 MDB_val md_name; /**< name of the database */
916 MDB_cmp_func *md_cmp; /**< function for comparing keys */
917 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
918 MDB_rel_func *md_rel; /**< user relocate function */
919 void *md_relctx; /**< user-provided context for md_rel */
922 /** A database transaction.
923 * Every operation requires a transaction handle.
926 MDB_txn *mt_parent; /**< parent of a nested txn */
927 MDB_txn *mt_child; /**< nested txn under this txn */
928 pgno_t mt_next_pgno; /**< next unallocated page */
929 /** The ID of this transaction. IDs are integers incrementing from 1.
930 * Only committed write transactions increment the ID. If a transaction
931 * aborts, the ID may be re-used by the next writer.
934 MDB_env *mt_env; /**< the DB environment */
935 /** The list of pages that became unused during this transaction.
938 /** The list of loose pages that became unused and may be reused
939 * in this transaction, linked through #NEXT_LOOSE_PAGE(page).
941 MDB_page *mt_loose_pgs;
942 /** The sorted list of dirty pages we temporarily wrote to disk
943 * because the dirty list was full. page numbers in here are
944 * shifted left by 1, deleted slots have the LSB set.
946 MDB_IDL mt_spill_pgs;
948 /** For write txns: Modified pages. Sorted when not MDB_WRITEMAP. */
950 /** For read txns: This thread/txn's reader table slot, or NULL. */
953 /** Array of records for each DB known in the environment. */
955 /** Array of MDB_db records for each known DB */
957 /** Array of sequence numbers for each DB handle */
958 unsigned int *mt_dbiseqs;
959 /** @defgroup mt_dbflag Transaction DB Flags
963 #define DB_DIRTY 0x01 /**< DB was modified or is DUPSORT data */
964 #define DB_STALE 0x02 /**< Named-DB record is older than txnID */
965 #define DB_NEW 0x04 /**< Named-DB handle opened in this txn */
966 #define DB_VALID 0x08 /**< DB handle is valid, see also #MDB_VALID */
968 /** In write txns, array of cursors for each DB */
969 MDB_cursor **mt_cursors;
970 /** Array of flags for each DB */
971 unsigned char *mt_dbflags;
972 /** Number of DB records in use. This number only ever increments;
973 * we don't decrement it when individual DB handles are closed.
977 /** @defgroup mdb_txn Transaction Flags
981 #define MDB_TXN_RDONLY 0x01 /**< read-only transaction */
982 #define MDB_TXN_ERROR 0x02 /**< txn is unusable after an error */
983 #define MDB_TXN_DIRTY 0x04 /**< must write, even if dirty list is empty */
984 #define MDB_TXN_SPILLS 0x08 /**< txn or a parent has spilled pages */
986 unsigned int mt_flags; /**< @ref mdb_txn */
987 /** #dirty_list room: Array size - \#dirty pages visible to this txn.
988 * Includes ancestor txns' dirty pages not hidden by other txns'
989 * dirty/spilled pages. Thus commit(nested txn) has room to merge
990 * dirty_list into mt_parent after freeing hidden mt_parent pages.
992 unsigned int mt_dirty_room;
995 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
996 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
997 * raise this on a 64 bit machine.
999 #define CURSOR_STACK 32
1003 /** Cursors are used for all DB operations.
1004 * A cursor holds a path of (page pointer, key index) from the DB
1005 * root to a position in the DB, plus other state. #MDB_DUPSORT
1006 * cursors include an xcursor to the current data item. Write txns
1007 * track their cursors and keep them up to date when data moves.
1008 * Exception: An xcursor's pointer to a #P_SUBP page can be stale.
1009 * (A node with #F_DUPDATA but no #F_SUBDATA contains a subpage).
1012 /** Next cursor on this DB in this txn */
1013 MDB_cursor *mc_next;
1014 /** Backup of the original cursor if this cursor is a shadow */
1015 MDB_cursor *mc_backup;
1016 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
1017 struct MDB_xcursor *mc_xcursor;
1018 /** The transaction that owns this cursor */
1020 /** The database handle this cursor operates on */
1022 /** The database record for this cursor */
1024 /** The database auxiliary record for this cursor */
1026 /** The @ref mt_dbflag for this database */
1027 unsigned char *mc_dbflag;
1028 unsigned short mc_snum; /**< number of pushed pages */
1029 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
1030 /** @defgroup mdb_cursor Cursor Flags
1032 * Cursor state flags.
1035 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
1036 #define C_EOF 0x02 /**< No more data */
1037 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
1038 #define C_DEL 0x08 /**< last op was a cursor_del */
1039 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
1040 #define C_UNTRACK 0x40 /**< Un-track cursor when closing */
1042 unsigned int mc_flags; /**< @ref mdb_cursor */
1043 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
1044 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
1047 /** Context for sorted-dup records.
1048 * We could have gone to a fully recursive design, with arbitrarily
1049 * deep nesting of sub-databases. But for now we only handle these
1050 * levels - main DB, optional sub-DB, sorted-duplicate DB.
1052 typedef struct MDB_xcursor {
1053 /** A sub-cursor for traversing the Dup DB */
1054 MDB_cursor mx_cursor;
1055 /** The database record for this Dup DB */
1057 /** The auxiliary DB record for this Dup DB */
1059 /** The @ref mt_dbflag for this Dup DB */
1060 unsigned char mx_dbflag;
1063 /** State of FreeDB old pages, stored in the MDB_env */
1064 typedef struct MDB_pgstate {
1065 pgno_t *mf_pghead; /**< Reclaimed freeDB pages, or NULL before use */
1066 txnid_t mf_pglast; /**< ID of last used record, or 0 if !mf_pghead */
1069 /** The database environment. */
1071 HANDLE me_fd; /**< The main data file */
1072 HANDLE me_lfd; /**< The lock file */
1073 HANDLE me_mfd; /**< just for writing the meta pages */
1074 /** Failed to update the meta page. Probably an I/O error. */
1075 #define MDB_FATAL_ERROR 0x80000000U
1076 /** We're explicitly changing the mapsize. */
1077 #define MDB_RESIZING 0x40000000U
1078 /** Some fields are initialized. */
1079 #define MDB_ENV_ACTIVE 0x20000000U
1080 /** me_txkey is set */
1081 #define MDB_ENV_TXKEY 0x10000000U
1082 uint32_t me_flags; /**< @ref mdb_env */
1083 unsigned int me_psize; /**< DB page size, inited from me_os_psize */
1084 unsigned int me_os_psize; /**< OS page size, from #GET_PAGESIZE */
1085 unsigned int me_maxreaders; /**< size of the reader table */
1086 unsigned int me_numreaders; /**< max numreaders set by this env */
1087 MDB_dbi me_numdbs; /**< number of DBs opened */
1088 MDB_dbi me_maxdbs; /**< size of the DB table */
1089 MDB_PID_T me_pid; /**< process ID of this env */
1090 char *me_path; /**< path to the DB files */
1091 char *me_map; /**< the memory map of the data file */
1092 MDB_txninfo *me_txns; /**< the memory map of the lock file or NULL */
1093 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
1094 void *me_pbuf; /**< scratch area for DUPSORT put() */
1095 MDB_txn *me_txn; /**< current write transaction */
1096 size_t me_mapsize; /**< size of the data memory map */
1097 off_t me_size; /**< current file size */
1098 pgno_t me_maxpg; /**< me_mapsize / me_psize */
1099 MDB_dbx *me_dbxs; /**< array of static DB info */
1100 uint16_t *me_dbflags; /**< array of flags from MDB_db.md_flags */
1101 unsigned int *me_dbiseqs; /**< array of dbi sequence numbers */
1102 pthread_key_t me_txkey; /**< thread-key for readers */
1103 MDB_pgstate me_pgstate; /**< state of old pages from freeDB */
1104 # define me_pglast me_pgstate.mf_pglast
1105 # define me_pghead me_pgstate.mf_pghead
1106 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
1107 /** IDL of pages that became unused in a write txn */
1108 MDB_IDL me_free_pgs;
1109 /** ID2L of pages written during a write txn. Length MDB_IDL_UM_SIZE. */
1110 MDB_ID2L me_dirty_list;
1111 /** Max number of freelist items that can fit in a single overflow page */
1113 /** Max size of a node on a page */
1114 unsigned int me_nodemax;
1115 #if !(MDB_MAXKEYSIZE)
1116 unsigned int me_maxkey; /**< max size of a key */
1118 int me_live_reader; /**< have liveness lock in reader table */
1120 int me_pidquery; /**< Used in OpenProcess */
1121 HANDLE me_rmutex; /* Windows mutexes don't reside in shared mem */
1123 #elif defined(MDB_USE_POSIX_SEM)
1124 sem_t *me_rmutex; /* Shared mutexes are not supported */
1127 void *me_userctx; /**< User-settable context */
1128 MDB_assert_func *me_assert_func; /**< Callback for assertion failures */
1131 /** Nested transaction */
1132 typedef struct MDB_ntxn {
1133 MDB_txn mnt_txn; /**< the transaction */
1134 MDB_pgstate mnt_pgstate; /**< parent transaction's saved freestate */
1137 /** max number of pages to commit in one writev() call */
1138 #define MDB_COMMIT_PAGES 64
1139 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
1140 #undef MDB_COMMIT_PAGES
1141 #define MDB_COMMIT_PAGES IOV_MAX
1144 /** max bytes to write in one call */
1145 #define MAX_WRITE (0x80000000U >> (sizeof(ssize_t) == 4))
1147 /** Check \b txn and \b dbi arguments to a function */
1148 #define TXN_DBI_EXIST(txn, dbi) \
1149 ((txn) && (dbi) < (txn)->mt_numdbs && ((txn)->mt_dbflags[dbi] & DB_VALID))
1151 /** Check for misused \b dbi handles */
1152 #define TXN_DBI_CHANGED(txn, dbi) \
1153 ((txn)->mt_dbiseqs[dbi] != (txn)->mt_env->me_dbiseqs[dbi])
1155 static int mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp);
1156 static int mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp);
1157 static int mdb_page_touch(MDB_cursor *mc);
1159 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp, int *lvl);
1160 static int mdb_page_search_root(MDB_cursor *mc,
1161 MDB_val *key, int modify);
1162 #define MDB_PS_MODIFY 1
1163 #define MDB_PS_ROOTONLY 2
1164 #define MDB_PS_FIRST 4
1165 #define MDB_PS_LAST 8
1166 static int mdb_page_search(MDB_cursor *mc,
1167 MDB_val *key, int flags);
1168 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
1170 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
1171 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
1172 pgno_t newpgno, unsigned int nflags);
1174 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
1175 static int mdb_env_pick_meta(const MDB_env *env);
1176 static int mdb_env_write_meta(MDB_txn *txn);
1177 #if !(defined(_WIN32) || defined(MDB_USE_POSIX_SEM)) /* Drop unused excl arg */
1178 # define mdb_env_close0(env, excl) mdb_env_close1(env)
1180 static void mdb_env_close0(MDB_env *env, int excl);
1182 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1183 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
1184 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1185 static void mdb_node_del(MDB_cursor *mc, int ksize);
1186 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1187 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1188 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1189 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1190 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
1192 static int mdb_rebalance(MDB_cursor *mc);
1193 static int mdb_update_key(MDB_cursor *mc, MDB_val *key);
1195 static void mdb_cursor_pop(MDB_cursor *mc);
1196 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1198 static int mdb_cursor_del0(MDB_cursor *mc);
1199 static int mdb_del0(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data, unsigned flags);
1200 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1201 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1202 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1203 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1205 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1206 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1208 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1209 static void mdb_xcursor_init0(MDB_cursor *mc);
1210 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1212 static int mdb_drop0(MDB_cursor *mc, int subs);
1213 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1216 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1220 static SECURITY_DESCRIPTOR mdb_null_sd;
1221 static SECURITY_ATTRIBUTES mdb_all_sa;
1222 static int mdb_sec_inited;
1225 /** Return the library version info. */
1227 mdb_version(int *major, int *minor, int *patch)
1229 if (major) *major = MDB_VERSION_MAJOR;
1230 if (minor) *minor = MDB_VERSION_MINOR;
1231 if (patch) *patch = MDB_VERSION_PATCH;
1232 return MDB_VERSION_STRING;
1235 /** Table of descriptions for LMDB @ref errors */
1236 static char *const mdb_errstr[] = {
1237 "MDB_KEYEXIST: Key/data pair already exists",
1238 "MDB_NOTFOUND: No matching key/data pair found",
1239 "MDB_PAGE_NOTFOUND: Requested page not found",
1240 "MDB_CORRUPTED: Located page was wrong type",
1241 "MDB_PANIC: Update of meta page failed",
1242 "MDB_VERSION_MISMATCH: Database environment version mismatch",
1243 "MDB_INVALID: File is not an LMDB file",
1244 "MDB_MAP_FULL: Environment mapsize limit reached",
1245 "MDB_DBS_FULL: Environment maxdbs limit reached",
1246 "MDB_READERS_FULL: Environment maxreaders limit reached",
1247 "MDB_TLS_FULL: Thread-local storage keys full - too many environments open",
1248 "MDB_TXN_FULL: Transaction has too many dirty pages - transaction too big",
1249 "MDB_CURSOR_FULL: Internal error - cursor stack limit reached",
1250 "MDB_PAGE_FULL: Internal error - page has no more space",
1251 "MDB_MAP_RESIZED: Database contents grew beyond environment mapsize",
1252 "MDB_INCOMPATIBLE: Operation and DB incompatible, or DB flags changed",
1253 "MDB_BAD_RSLOT: Invalid reuse of reader locktable slot",
1254 "MDB_BAD_TXN: Transaction cannot recover - it must be aborted",
1255 "MDB_BAD_VALSIZE: Unsupported size of key/DB name/data, or wrong DUPFIXED size",
1256 "MDB_BAD_DBI: The specified DBI handle was closed/changed unexpectedly",
1260 mdb_strerror(int err)
1263 /** HACK: pad 4KB on stack over the buf. Return system msgs in buf.
1264 * This works as long as no function between the call to mdb_strerror
1265 * and the actual use of the message uses more than 4K of stack.
1268 char buf[1024], *ptr = buf;
1272 return ("Successful return: 0");
1274 if (err >= MDB_KEYEXIST && err <= MDB_LAST_ERRCODE) {
1275 i = err - MDB_KEYEXIST;
1276 return mdb_errstr[i];
1280 /* These are the C-runtime error codes we use. The comment indicates
1281 * their numeric value, and the Win32 error they would correspond to
1282 * if the error actually came from a Win32 API. A major mess, we should
1283 * have used LMDB-specific error codes for everything.
1286 case ENOENT: /* 2, FILE_NOT_FOUND */
1287 case EIO: /* 5, ACCESS_DENIED */
1288 case ENOMEM: /* 12, INVALID_ACCESS */
1289 case EACCES: /* 13, INVALID_DATA */
1290 case EBUSY: /* 16, CURRENT_DIRECTORY */
1291 case EINVAL: /* 22, BAD_COMMAND */
1292 case ENOSPC: /* 28, OUT_OF_PAPER */
1293 return strerror(err);
1298 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM |
1299 FORMAT_MESSAGE_IGNORE_INSERTS,
1300 NULL, err, 0, ptr, sizeof(buf), pad);
1303 return strerror(err);
1307 /** assert(3) variant in cursor context */
1308 #define mdb_cassert(mc, expr) mdb_assert0((mc)->mc_txn->mt_env, expr, #expr)
1309 /** assert(3) variant in transaction context */
1310 #define mdb_tassert(mc, expr) mdb_assert0((txn)->mt_env, expr, #expr)
1311 /** assert(3) variant in environment context */
1312 #define mdb_eassert(env, expr) mdb_assert0(env, expr, #expr)
1315 # define mdb_assert0(env, expr, expr_txt) ((expr) ? (void)0 : \
1316 mdb_assert_fail(env, expr_txt, mdb_func_, __FILE__, __LINE__))
1319 mdb_assert_fail(MDB_env *env, const char *expr_txt,
1320 const char *func, const char *file, int line)
1323 sprintf(buf, "%.100s:%d: Assertion '%.200s' failed in %.40s()",
1324 file, line, expr_txt, func);
1325 if (env->me_assert_func)
1326 env->me_assert_func(env, buf);
1327 fprintf(stderr, "%s\n", buf);
1331 # define mdb_assert0(env, expr, expr_txt) ((void) 0)
1335 /** Return the page number of \b mp which may be sub-page, for debug output */
1337 mdb_dbg_pgno(MDB_page *mp)
1340 COPY_PGNO(ret, mp->mp_pgno);
1344 /** Display a key in hexadecimal and return the address of the result.
1345 * @param[in] key the key to display
1346 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1347 * @return The key in hexadecimal form.
1350 mdb_dkey(MDB_val *key, char *buf)
1353 unsigned char *c = key->mv_data;
1359 if (key->mv_size > DKBUF_MAXKEYSIZE)
1360 return "MDB_MAXKEYSIZE";
1361 /* may want to make this a dynamic check: if the key is mostly
1362 * printable characters, print it as-is instead of converting to hex.
1366 for (i=0; i<key->mv_size; i++)
1367 ptr += sprintf(ptr, "%02x", *c++);
1369 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1375 mdb_leafnode_type(MDB_node *n)
1377 static char *const tp[2][2] = {{"", ": DB"}, {": sub-page", ": sub-DB"}};
1378 return F_ISSET(n->mn_flags, F_BIGDATA) ? ": overflow page" :
1379 tp[F_ISSET(n->mn_flags, F_DUPDATA)][F_ISSET(n->mn_flags, F_SUBDATA)];
1382 /** Display all the keys in the page. */
1384 mdb_page_list(MDB_page *mp)
1386 pgno_t pgno = mdb_dbg_pgno(mp);
1387 const char *type, *state = (mp->mp_flags & P_DIRTY) ? ", dirty" : "";
1389 unsigned int i, nkeys, nsize, total = 0;
1393 switch (mp->mp_flags & (P_BRANCH|P_LEAF|P_LEAF2|P_META|P_OVERFLOW|P_SUBP)) {
1394 case P_BRANCH: type = "Branch page"; break;
1395 case P_LEAF: type = "Leaf page"; break;
1396 case P_LEAF|P_SUBP: type = "Sub-page"; break;
1397 case P_LEAF|P_LEAF2: type = "LEAF2 page"; break;
1398 case P_LEAF|P_LEAF2|P_SUBP: type = "LEAF2 sub-page"; break;
1400 fprintf(stderr, "Overflow page %"Z"u pages %u%s\n",
1401 pgno, mp->mp_pages, state);
1404 fprintf(stderr, "Meta-page %"Z"u txnid %"Z"u\n",
1405 pgno, ((MDB_meta *)METADATA(mp))->mm_txnid);
1408 fprintf(stderr, "Bad page %"Z"u flags 0x%u\n", pgno, mp->mp_flags);
1412 nkeys = NUMKEYS(mp);
1413 fprintf(stderr, "%s %"Z"u numkeys %d%s\n", type, pgno, nkeys, state);
1415 for (i=0; i<nkeys; i++) {
1416 if (IS_LEAF2(mp)) { /* LEAF2 pages have no mp_ptrs[] or node headers */
1417 key.mv_size = nsize = mp->mp_pad;
1418 key.mv_data = LEAF2KEY(mp, i, nsize);
1420 fprintf(stderr, "key %d: nsize %d, %s\n", i, nsize, DKEY(&key));
1423 node = NODEPTR(mp, i);
1424 key.mv_size = node->mn_ksize;
1425 key.mv_data = node->mn_data;
1426 nsize = NODESIZE + key.mv_size;
1427 if (IS_BRANCH(mp)) {
1428 fprintf(stderr, "key %d: page %"Z"u, %s\n", i, NODEPGNO(node),
1432 if (F_ISSET(node->mn_flags, F_BIGDATA))
1433 nsize += sizeof(pgno_t);
1435 nsize += NODEDSZ(node);
1437 nsize += sizeof(indx_t);
1438 fprintf(stderr, "key %d: nsize %d, %s%s\n",
1439 i, nsize, DKEY(&key), mdb_leafnode_type(node));
1441 total = EVEN(total);
1443 fprintf(stderr, "Total: header %d + contents %d + unused %d\n",
1444 IS_LEAF2(mp) ? PAGEHDRSZ : PAGEBASE + mp->mp_lower, total, SIZELEFT(mp));
1448 mdb_cursor_chk(MDB_cursor *mc)
1454 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1455 for (i=0; i<mc->mc_top; i++) {
1457 node = NODEPTR(mp, mc->mc_ki[i]);
1458 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1461 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1467 /** Count all the pages in each DB and in the freelist
1468 * and make sure it matches the actual number of pages
1470 * All named DBs must be open for a correct count.
1472 static void mdb_audit(MDB_txn *txn)
1476 MDB_ID freecount, count;
1481 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1482 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1483 freecount += *(MDB_ID *)data.mv_data;
1484 mdb_tassert(txn, rc == MDB_NOTFOUND);
1487 for (i = 0; i<txn->mt_numdbs; i++) {
1489 if (!(txn->mt_dbflags[i] & DB_VALID))
1491 mdb_cursor_init(&mc, txn, i, &mx);
1492 if (txn->mt_dbs[i].md_root == P_INVALID)
1494 count += txn->mt_dbs[i].md_branch_pages +
1495 txn->mt_dbs[i].md_leaf_pages +
1496 txn->mt_dbs[i].md_overflow_pages;
1497 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1498 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST);
1499 for (; rc == MDB_SUCCESS; rc = mdb_cursor_sibling(&mc, 1)) {
1502 mp = mc.mc_pg[mc.mc_top];
1503 for (j=0; j<NUMKEYS(mp); j++) {
1504 MDB_node *leaf = NODEPTR(mp, j);
1505 if (leaf->mn_flags & F_SUBDATA) {
1507 memcpy(&db, NODEDATA(leaf), sizeof(db));
1508 count += db.md_branch_pages + db.md_leaf_pages +
1509 db.md_overflow_pages;
1513 mdb_tassert(txn, rc == MDB_NOTFOUND);
1516 if (freecount + count + 2 /* metapages */ != txn->mt_next_pgno) {
1517 fprintf(stderr, "audit: %lu freecount: %lu count: %lu total: %lu next_pgno: %lu\n",
1518 txn->mt_txnid, freecount, count+2, freecount+count+2, txn->mt_next_pgno);
1524 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1526 return txn->mt_dbxs[dbi].md_cmp(a, b);
1530 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1532 return txn->mt_dbxs[dbi].md_dcmp(a, b);
1535 /** Allocate memory for a page.
1536 * Re-use old malloc'd pages first for singletons, otherwise just malloc.
1539 mdb_page_malloc(MDB_txn *txn, unsigned num)
1541 MDB_env *env = txn->mt_env;
1542 MDB_page *ret = env->me_dpages;
1543 size_t psize = env->me_psize, sz = psize, off;
1544 /* For ! #MDB_NOMEMINIT, psize counts how much to init.
1545 * For a single page alloc, we init everything after the page header.
1546 * For multi-page, we init the final page; if the caller needed that
1547 * many pages they will be filling in at least up to the last page.
1551 VGMEMP_ALLOC(env, ret, sz);
1552 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1553 env->me_dpages = ret->mp_next;
1556 psize -= off = PAGEHDRSZ;
1561 if ((ret = malloc(sz)) != NULL) {
1562 VGMEMP_ALLOC(env, ret, sz);
1563 if (!(env->me_flags & MDB_NOMEMINIT)) {
1564 memset((char *)ret + off, 0, psize);
1568 txn->mt_flags |= MDB_TXN_ERROR;
1572 /** Free a single page.
1573 * Saves single pages to a list, for future reuse.
1574 * (This is not used for multi-page overflow pages.)
1577 mdb_page_free(MDB_env *env, MDB_page *mp)
1579 mp->mp_next = env->me_dpages;
1580 VGMEMP_FREE(env, mp);
1581 env->me_dpages = mp;
1584 /** Free a dirty page */
1586 mdb_dpage_free(MDB_env *env, MDB_page *dp)
1588 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1589 mdb_page_free(env, dp);
1591 /* large pages just get freed directly */
1592 VGMEMP_FREE(env, dp);
1597 /** Return all dirty pages to dpage list */
1599 mdb_dlist_free(MDB_txn *txn)
1601 MDB_env *env = txn->mt_env;
1602 MDB_ID2L dl = txn->mt_u.dirty_list;
1603 unsigned i, n = dl[0].mid;
1605 for (i = 1; i <= n; i++) {
1606 mdb_dpage_free(env, dl[i].mptr);
1611 /** Loosen or free a single page.
1612 * Saves single pages to a list for future reuse
1613 * in this same txn. It has been pulled from the freeDB
1614 * and already resides on the dirty list, but has been
1615 * deleted. Use these pages first before pulling again
1618 * If the page wasn't dirtied in this txn, just add it
1619 * to this txn's free list.
1622 mdb_page_loose(MDB_cursor *mc, MDB_page *mp)
1625 pgno_t pgno = mp->mp_pgno;
1627 if ((mp->mp_flags & P_DIRTY) && mc->mc_dbi != FREE_DBI) {
1628 if (mc->mc_txn->mt_parent) {
1629 MDB_ID2 *dl = mc->mc_txn->mt_u.dirty_list;
1630 /* If txn has a parent, make sure the page is in our
1634 unsigned x = mdb_mid2l_search(dl, pgno);
1635 if (x <= dl[0].mid && dl[x].mid == pgno) {
1636 if (mp != dl[x].mptr) { /* bad cursor? */
1637 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
1638 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
1639 return MDB_CORRUPTED;
1646 /* no parent txn, so it's just ours */
1651 DPRINTF(("loosen db %d page %"Z"u", DDBI(mc),
1653 NEXT_LOOSE_PAGE(mp) = mc->mc_txn->mt_loose_pgs;
1654 mc->mc_txn->mt_loose_pgs = mp;
1655 mp->mp_flags |= P_LOOSE;
1657 int rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, pgno);
1665 /** Set or clear P_KEEP in dirty, non-overflow, non-sub pages watched by txn.
1666 * @param[in] mc A cursor handle for the current operation.
1667 * @param[in] pflags Flags of the pages to update:
1668 * P_DIRTY to set P_KEEP, P_DIRTY|P_KEEP to clear it.
1669 * @param[in] all No shortcuts. Needed except after a full #mdb_page_flush().
1670 * @return 0 on success, non-zero on failure.
1673 mdb_pages_xkeep(MDB_cursor *mc, unsigned pflags, int all)
1675 enum { Mask = P_SUBP|P_DIRTY|P_LOOSE|P_KEEP };
1676 MDB_txn *txn = mc->mc_txn;
1682 int rc = MDB_SUCCESS, level;
1684 /* Mark pages seen by cursors */
1685 if (mc->mc_flags & C_UNTRACK)
1686 mc = NULL; /* will find mc in mt_cursors */
1687 for (i = txn->mt_numdbs;; mc = txn->mt_cursors[--i]) {
1688 for (; mc; mc=mc->mc_next) {
1689 if (!(mc->mc_flags & C_INITIALIZED))
1691 for (m3 = mc;; m3 = &mx->mx_cursor) {
1693 for (j=0; j<m3->mc_snum; j++) {
1695 if ((mp->mp_flags & Mask) == pflags)
1696 mp->mp_flags ^= P_KEEP;
1698 mx = m3->mc_xcursor;
1699 /* Proceed to mx if it is at a sub-database */
1700 if (! (mx && (mx->mx_cursor.mc_flags & C_INITIALIZED)))
1702 if (! (mp && (mp->mp_flags & P_LEAF)))
1704 leaf = NODEPTR(mp, m3->mc_ki[j-1]);
1705 if (!(leaf->mn_flags & F_SUBDATA))
1714 /* Mark dirty root pages */
1715 for (i=0; i<txn->mt_numdbs; i++) {
1716 if (txn->mt_dbflags[i] & DB_DIRTY) {
1717 pgno_t pgno = txn->mt_dbs[i].md_root;
1718 if (pgno == P_INVALID)
1720 if ((rc = mdb_page_get(txn, pgno, &dp, &level)) != MDB_SUCCESS)
1722 if ((dp->mp_flags & Mask) == pflags && level <= 1)
1723 dp->mp_flags ^= P_KEEP;
1731 static int mdb_page_flush(MDB_txn *txn, int keep);
1733 /** Spill pages from the dirty list back to disk.
1734 * This is intended to prevent running into #MDB_TXN_FULL situations,
1735 * but note that they may still occur in a few cases:
1736 * 1) our estimate of the txn size could be too small. Currently this
1737 * seems unlikely, except with a large number of #MDB_MULTIPLE items.
1738 * 2) child txns may run out of space if their parents dirtied a
1739 * lot of pages and never spilled them. TODO: we probably should do
1740 * a preemptive spill during #mdb_txn_begin() of a child txn, if
1741 * the parent's dirty_room is below a given threshold.
1743 * Otherwise, if not using nested txns, it is expected that apps will
1744 * not run into #MDB_TXN_FULL any more. The pages are flushed to disk
1745 * the same way as for a txn commit, e.g. their P_DIRTY flag is cleared.
1746 * If the txn never references them again, they can be left alone.
1747 * If the txn only reads them, they can be used without any fuss.
1748 * If the txn writes them again, they can be dirtied immediately without
1749 * going thru all of the work of #mdb_page_touch(). Such references are
1750 * handled by #mdb_page_unspill().
1752 * Also note, we never spill DB root pages, nor pages of active cursors,
1753 * because we'll need these back again soon anyway. And in nested txns,
1754 * we can't spill a page in a child txn if it was already spilled in a
1755 * parent txn. That would alter the parent txns' data even though
1756 * the child hasn't committed yet, and we'd have no way to undo it if
1757 * the child aborted.
1759 * @param[in] m0 cursor A cursor handle identifying the transaction and
1760 * database for which we are checking space.
1761 * @param[in] key For a put operation, the key being stored.
1762 * @param[in] data For a put operation, the data being stored.
1763 * @return 0 on success, non-zero on failure.
1766 mdb_page_spill(MDB_cursor *m0, MDB_val *key, MDB_val *data)
1768 MDB_txn *txn = m0->mc_txn;
1770 MDB_ID2L dl = txn->mt_u.dirty_list;
1771 unsigned int i, j, need;
1774 if (m0->mc_flags & C_SUB)
1777 /* Estimate how much space this op will take */
1778 i = m0->mc_db->md_depth;
1779 /* Named DBs also dirty the main DB */
1780 if (m0->mc_dbi > MAIN_DBI)
1781 i += txn->mt_dbs[MAIN_DBI].md_depth;
1782 /* For puts, roughly factor in the key+data size */
1784 i += (LEAFSIZE(key, data) + txn->mt_env->me_psize) / txn->mt_env->me_psize;
1785 i += i; /* double it for good measure */
1788 if (txn->mt_dirty_room > i)
1791 if (!txn->mt_spill_pgs) {
1792 txn->mt_spill_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX);
1793 if (!txn->mt_spill_pgs)
1796 /* purge deleted slots */
1797 MDB_IDL sl = txn->mt_spill_pgs;
1798 unsigned int num = sl[0];
1800 for (i=1; i<=num; i++) {
1807 /* Preserve pages which may soon be dirtied again */
1808 if ((rc = mdb_pages_xkeep(m0, P_DIRTY, 1)) != MDB_SUCCESS)
1811 /* Less aggressive spill - we originally spilled the entire dirty list,
1812 * with a few exceptions for cursor pages and DB root pages. But this
1813 * turns out to be a lot of wasted effort because in a large txn many
1814 * of those pages will need to be used again. So now we spill only 1/8th
1815 * of the dirty pages. Testing revealed this to be a good tradeoff,
1816 * better than 1/2, 1/4, or 1/10.
1818 if (need < MDB_IDL_UM_MAX / 8)
1819 need = MDB_IDL_UM_MAX / 8;
1821 /* Save the page IDs of all the pages we're flushing */
1822 /* flush from the tail forward, this saves a lot of shifting later on. */
1823 for (i=dl[0].mid; i && need; i--) {
1824 MDB_ID pn = dl[i].mid << 1;
1826 if (dp->mp_flags & (P_LOOSE|P_KEEP))
1828 /* Can't spill twice, make sure it's not already in a parent's
1831 if (txn->mt_parent) {
1833 for (tx2 = txn->mt_parent; tx2; tx2 = tx2->mt_parent) {
1834 if (tx2->mt_spill_pgs) {
1835 j = mdb_midl_search(tx2->mt_spill_pgs, pn);
1836 if (j <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[j] == pn) {
1837 dp->mp_flags |= P_KEEP;
1845 if ((rc = mdb_midl_append(&txn->mt_spill_pgs, pn)))
1849 mdb_midl_sort(txn->mt_spill_pgs);
1851 /* Flush the spilled part of dirty list */
1852 if ((rc = mdb_page_flush(txn, i)) != MDB_SUCCESS)
1855 /* Reset any dirty pages we kept that page_flush didn't see */
1856 rc = mdb_pages_xkeep(m0, P_DIRTY|P_KEEP, i);
1859 txn->mt_flags |= rc ? MDB_TXN_ERROR : MDB_TXN_SPILLS;
1863 /** Find oldest txnid still referenced. Expects txn->mt_txnid > 0. */
1865 mdb_find_oldest(MDB_txn *txn)
1868 txnid_t mr, oldest = txn->mt_txnid - 1;
1869 if (txn->mt_env->me_txns) {
1870 MDB_reader *r = txn->mt_env->me_txns->mti_readers;
1871 for (i = txn->mt_env->me_txns->mti_numreaders; --i >= 0; ) {
1882 /** Add a page to the txn's dirty list */
1884 mdb_page_dirty(MDB_txn *txn, MDB_page *mp)
1887 int rc, (*insert)(MDB_ID2L, MDB_ID2 *);
1889 if (txn->mt_env->me_flags & MDB_WRITEMAP) {
1890 insert = mdb_mid2l_append;
1892 insert = mdb_mid2l_insert;
1894 mid.mid = mp->mp_pgno;
1896 rc = insert(txn->mt_u.dirty_list, &mid);
1897 mdb_tassert(txn, rc == 0);
1898 txn->mt_dirty_room--;
1901 /** Allocate page numbers and memory for writing. Maintain me_pglast,
1902 * me_pghead and mt_next_pgno.
1904 * If there are free pages available from older transactions, they
1905 * are re-used first. Otherwise allocate a new page at mt_next_pgno.
1906 * Do not modify the freedB, just merge freeDB records into me_pghead[]
1907 * and move me_pglast to say which records were consumed. Only this
1908 * function can create me_pghead and move me_pglast/mt_next_pgno.
1909 * @param[in] mc cursor A cursor handle identifying the transaction and
1910 * database for which we are allocating.
1911 * @param[in] num the number of pages to allocate.
1912 * @param[out] mp Address of the allocated page(s). Requests for multiple pages
1913 * will always be satisfied by a single contiguous chunk of memory.
1914 * @return 0 on success, non-zero on failure.
1917 mdb_page_alloc(MDB_cursor *mc, int num, MDB_page **mp)
1919 #ifdef MDB_PARANOID /* Seems like we can ignore this now */
1920 /* Get at most <Max_retries> more freeDB records once me_pghead
1921 * has enough pages. If not enough, use new pages from the map.
1922 * If <Paranoid> and mc is updating the freeDB, only get new
1923 * records if me_pghead is empty. Then the freelist cannot play
1924 * catch-up with itself by growing while trying to save it.
1926 enum { Paranoid = 1, Max_retries = 500 };
1928 enum { Paranoid = 0, Max_retries = INT_MAX /*infinite*/ };
1930 int rc, retry = num * 20;
1931 MDB_txn *txn = mc->mc_txn;
1932 MDB_env *env = txn->mt_env;
1933 pgno_t pgno, *mop = env->me_pghead;
1934 unsigned i, j, k, mop_len = mop ? mop[0] : 0, n2 = num-1;
1936 txnid_t oldest = 0, last;
1940 /* If there are any loose pages, just use them */
1941 if (num == 1 && txn->mt_loose_pgs) {
1942 np = txn->mt_loose_pgs;
1943 txn->mt_loose_pgs = NEXT_LOOSE_PAGE(np);
1944 DPRINTF(("db %d use loose page %"Z"u", DDBI(mc),
1952 /* If our dirty list is already full, we can't do anything */
1953 if (txn->mt_dirty_room == 0) {
1958 for (op = MDB_FIRST;; op = MDB_NEXT) {
1961 pgno_t *idl, old_id, new_id;
1963 /* Seek a big enough contiguous page range. Prefer
1964 * pages at the tail, just truncating the list.
1970 if (mop[i-n2] == pgno+n2)
1977 if (op == MDB_FIRST) { /* 1st iteration */
1978 /* Prepare to fetch more and coalesce */
1979 oldest = mdb_find_oldest(txn);
1980 last = env->me_pglast;
1981 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
1984 key.mv_data = &last; /* will look up last+1 */
1985 key.mv_size = sizeof(last);
1987 if (Paranoid && mc->mc_dbi == FREE_DBI)
1990 if (Paranoid && retry < 0 && mop_len)
1994 /* Do not fetch more if the record will be too recent */
1997 rc = mdb_cursor_get(&m2, &key, NULL, op);
1999 if (rc == MDB_NOTFOUND)
2003 last = *(txnid_t*)key.mv_data;
2006 np = m2.mc_pg[m2.mc_top];
2007 leaf = NODEPTR(np, m2.mc_ki[m2.mc_top]);
2008 if ((rc = mdb_node_read(txn, leaf, &data)) != MDB_SUCCESS)
2011 idl = (MDB_ID *) data.mv_data;
2014 if (!(env->me_pghead = mop = mdb_midl_alloc(i))) {
2019 if ((rc = mdb_midl_need(&env->me_pghead, i)) != 0)
2021 mop = env->me_pghead;
2023 env->me_pglast = last;
2025 DPRINTF(("IDL read txn %"Z"u root %"Z"u num %u",
2026 last, txn->mt_dbs[FREE_DBI].md_root, i));
2028 DPRINTF(("IDL %"Z"u", idl[k]));
2030 /* Merge in descending sorted order */
2033 mop[0] = (pgno_t)-1;
2037 for (; old_id < new_id; old_id = mop[--j])
2044 /* Use new pages from the map when nothing suitable in the freeDB */
2046 pgno = txn->mt_next_pgno;
2047 if (pgno + num >= env->me_maxpg) {
2048 DPUTS("DB size maxed out");
2054 if (env->me_flags & MDB_WRITEMAP) {
2055 np = (MDB_page *)(env->me_map + env->me_psize * pgno);
2057 if (!(np = mdb_page_malloc(txn, num))) {
2063 mop[0] = mop_len -= num;
2064 /* Move any stragglers down */
2065 for (j = i-num; j < mop_len; )
2066 mop[++j] = mop[++i];
2068 txn->mt_next_pgno = pgno + num;
2071 mdb_page_dirty(txn, np);
2077 txn->mt_flags |= MDB_TXN_ERROR;
2081 /** Copy the used portions of a non-overflow page.
2082 * @param[in] dst page to copy into
2083 * @param[in] src page to copy from
2084 * @param[in] psize size of a page
2087 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
2089 enum { Align = sizeof(pgno_t) };
2090 indx_t upper = src->mp_upper, lower = src->mp_lower, unused = upper-lower;
2092 /* If page isn't full, just copy the used portion. Adjust
2093 * alignment so memcpy may copy words instead of bytes.
2095 if ((unused &= -Align) && !IS_LEAF2(src)) {
2096 upper = (upper + PAGEBASE) & -Align;
2097 memcpy(dst, src, (lower + PAGEBASE + (Align-1)) & -Align);
2098 memcpy((pgno_t *)((char *)dst+upper), (pgno_t *)((char *)src+upper),
2101 memcpy(dst, src, psize - unused);
2105 /** Pull a page off the txn's spill list, if present.
2106 * If a page being referenced was spilled to disk in this txn, bring
2107 * it back and make it dirty/writable again.
2108 * @param[in] txn the transaction handle.
2109 * @param[in] mp the page being referenced. It must not be dirty.
2110 * @param[out] ret the writable page, if any. ret is unchanged if
2111 * mp wasn't spilled.
2114 mdb_page_unspill(MDB_txn *txn, MDB_page *mp, MDB_page **ret)
2116 MDB_env *env = txn->mt_env;
2119 pgno_t pgno = mp->mp_pgno, pn = pgno << 1;
2121 for (tx2 = txn; tx2; tx2=tx2->mt_parent) {
2122 if (!tx2->mt_spill_pgs)
2124 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
2125 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
2128 if (txn->mt_dirty_room == 0)
2129 return MDB_TXN_FULL;
2130 if (IS_OVERFLOW(mp))
2134 if (env->me_flags & MDB_WRITEMAP) {
2137 np = mdb_page_malloc(txn, num);
2141 memcpy(np, mp, num * env->me_psize);
2143 mdb_page_copy(np, mp, env->me_psize);
2146 /* If in current txn, this page is no longer spilled.
2147 * If it happens to be the last page, truncate the spill list.
2148 * Otherwise mark it as deleted by setting the LSB.
2150 if (x == txn->mt_spill_pgs[0])
2151 txn->mt_spill_pgs[0]--;
2153 txn->mt_spill_pgs[x] |= 1;
2154 } /* otherwise, if belonging to a parent txn, the
2155 * page remains spilled until child commits
2158 mdb_page_dirty(txn, np);
2159 np->mp_flags |= P_DIRTY;
2167 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
2168 * @param[in] mc cursor pointing to the page to be touched
2169 * @return 0 on success, non-zero on failure.
2172 mdb_page_touch(MDB_cursor *mc)
2174 MDB_page *mp = mc->mc_pg[mc->mc_top], *np;
2175 MDB_txn *txn = mc->mc_txn;
2176 MDB_cursor *m2, *m3;
2180 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
2181 if (txn->mt_flags & MDB_TXN_SPILLS) {
2183 rc = mdb_page_unspill(txn, mp, &np);
2189 if ((rc = mdb_midl_need(&txn->mt_free_pgs, 1)) ||
2190 (rc = mdb_page_alloc(mc, 1, &np)))
2193 DPRINTF(("touched db %d page %"Z"u -> %"Z"u", DDBI(mc),
2194 mp->mp_pgno, pgno));
2195 mdb_cassert(mc, mp->mp_pgno != pgno);
2196 mdb_midl_xappend(txn->mt_free_pgs, mp->mp_pgno);
2197 /* Update the parent page, if any, to point to the new page */
2199 MDB_page *parent = mc->mc_pg[mc->mc_top-1];
2200 MDB_node *node = NODEPTR(parent, mc->mc_ki[mc->mc_top-1]);
2201 SETPGNO(node, pgno);
2203 mc->mc_db->md_root = pgno;
2205 } else if (txn->mt_parent && !IS_SUBP(mp)) {
2206 MDB_ID2 mid, *dl = txn->mt_u.dirty_list;
2208 /* If txn has a parent, make sure the page is in our
2212 unsigned x = mdb_mid2l_search(dl, pgno);
2213 if (x <= dl[0].mid && dl[x].mid == pgno) {
2214 if (mp != dl[x].mptr) { /* bad cursor? */
2215 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
2216 txn->mt_flags |= MDB_TXN_ERROR;
2217 return MDB_CORRUPTED;
2222 mdb_cassert(mc, dl[0].mid < MDB_IDL_UM_MAX);
2224 np = mdb_page_malloc(txn, 1);
2229 rc = mdb_mid2l_insert(dl, &mid);
2230 mdb_cassert(mc, rc == 0);
2235 mdb_page_copy(np, mp, txn->mt_env->me_psize);
2237 np->mp_flags |= P_DIRTY;
2240 /* Adjust cursors pointing to mp */
2241 mc->mc_pg[mc->mc_top] = np;
2242 m2 = txn->mt_cursors[mc->mc_dbi];
2243 if (mc->mc_flags & C_SUB) {
2244 for (; m2; m2=m2->mc_next) {
2245 m3 = &m2->mc_xcursor->mx_cursor;
2246 if (m3->mc_snum < mc->mc_snum) continue;
2247 if (m3->mc_pg[mc->mc_top] == mp)
2248 m3->mc_pg[mc->mc_top] = np;
2251 for (; m2; m2=m2->mc_next) {
2252 if (m2->mc_snum < mc->mc_snum) continue;
2253 if (m2->mc_pg[mc->mc_top] == mp) {
2254 m2->mc_pg[mc->mc_top] = np;
2255 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
2257 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
2259 MDB_node *leaf = NODEPTR(np, mc->mc_ki[mc->mc_top]);
2260 if (!(leaf->mn_flags & F_SUBDATA))
2261 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
2269 txn->mt_flags |= MDB_TXN_ERROR;
2274 mdb_env_sync(MDB_env *env, int force)
2277 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
2278 if (env->me_flags & MDB_WRITEMAP) {
2279 int flags = ((env->me_flags & MDB_MAPASYNC) && !force)
2280 ? MS_ASYNC : MS_SYNC;
2281 if (MDB_MSYNC(env->me_map, env->me_mapsize, flags))
2284 else if (flags == MS_SYNC && MDB_FDATASYNC(env->me_fd))
2288 if (MDB_FDATASYNC(env->me_fd))
2295 /** Back up parent txn's cursors, then grab the originals for tracking */
2297 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
2299 MDB_cursor *mc, *bk;
2304 for (i = src->mt_numdbs; --i >= 0; ) {
2305 if ((mc = src->mt_cursors[i]) != NULL) {
2306 size = sizeof(MDB_cursor);
2308 size += sizeof(MDB_xcursor);
2309 for (; mc; mc = bk->mc_next) {
2315 mc->mc_db = &dst->mt_dbs[i];
2316 /* Kill pointers into src - and dst to reduce abuse: The
2317 * user may not use mc until dst ends. Otherwise we'd...
2319 mc->mc_txn = NULL; /* ...set this to dst */
2320 mc->mc_dbflag = NULL; /* ...and &dst->mt_dbflags[i] */
2321 if ((mx = mc->mc_xcursor) != NULL) {
2322 *(MDB_xcursor *)(bk+1) = *mx;
2323 mx->mx_cursor.mc_txn = NULL; /* ...and dst. */
2325 mc->mc_next = dst->mt_cursors[i];
2326 dst->mt_cursors[i] = mc;
2333 /** Close this write txn's cursors, give parent txn's cursors back to parent.
2334 * @param[in] txn the transaction handle.
2335 * @param[in] merge true to keep changes to parent cursors, false to revert.
2336 * @return 0 on success, non-zero on failure.
2339 mdb_cursors_close(MDB_txn *txn, unsigned merge)
2341 MDB_cursor **cursors = txn->mt_cursors, *mc, *next, *bk;
2345 for (i = txn->mt_numdbs; --i >= 0; ) {
2346 for (mc = cursors[i]; mc; mc = next) {
2348 if ((bk = mc->mc_backup) != NULL) {
2350 /* Commit changes to parent txn */
2351 mc->mc_next = bk->mc_next;
2352 mc->mc_backup = bk->mc_backup;
2353 mc->mc_txn = bk->mc_txn;
2354 mc->mc_db = bk->mc_db;
2355 mc->mc_dbflag = bk->mc_dbflag;
2356 if ((mx = mc->mc_xcursor) != NULL)
2357 mx->mx_cursor.mc_txn = bk->mc_txn;
2359 /* Abort nested txn */
2361 if ((mx = mc->mc_xcursor) != NULL)
2362 *mx = *(MDB_xcursor *)(bk+1);
2366 /* Only malloced cursors are permanently tracked. */
2374 #define mdb_txn_reset0(txn, act) mdb_txn_reset0(txn)
2377 mdb_txn_reset0(MDB_txn *txn, const char *act);
2379 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2385 Pidset = F_SETLK, Pidcheck = F_GETLK
2389 /** Set or check a pid lock. Set returns 0 on success.
2390 * Check returns 0 if the process is certainly dead, nonzero if it may
2391 * be alive (the lock exists or an error happened so we do not know).
2393 * On Windows Pidset is a no-op, we merely check for the existence
2394 * of the process with the given pid. On POSIX we use a single byte
2395 * lock on the lockfile, set at an offset equal to the pid.
2398 mdb_reader_pid(MDB_env *env, enum Pidlock_op op, MDB_PID_T pid)
2400 #if !(MDB_PIDLOCK) /* Currently the same as defined(_WIN32) */
2403 if (op == Pidcheck) {
2404 h = OpenProcess(env->me_pidquery, FALSE, pid);
2405 /* No documented "no such process" code, but other program use this: */
2407 return ErrCode() != ERROR_INVALID_PARAMETER;
2408 /* A process exists until all handles to it close. Has it exited? */
2409 ret = WaitForSingleObject(h, 0) != 0;
2416 struct flock lock_info;
2417 memset(&lock_info, 0, sizeof(lock_info));
2418 lock_info.l_type = F_WRLCK;
2419 lock_info.l_whence = SEEK_SET;
2420 lock_info.l_start = pid;
2421 lock_info.l_len = 1;
2422 if ((rc = fcntl(env->me_lfd, op, &lock_info)) == 0) {
2423 if (op == F_GETLK && lock_info.l_type != F_UNLCK)
2425 } else if ((rc = ErrCode()) == EINTR) {
2433 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
2434 * @param[in] txn the transaction handle to initialize
2435 * @return 0 on success, non-zero on failure.
2438 mdb_txn_renew0(MDB_txn *txn)
2440 MDB_env *env = txn->mt_env;
2441 MDB_txninfo *ti = env->me_txns;
2445 int rc, new_notls = 0;
2448 txn->mt_numdbs = env->me_numdbs;
2449 txn->mt_dbxs = env->me_dbxs; /* mostly static anyway */
2451 if (txn->mt_flags & MDB_TXN_RDONLY) {
2453 meta = env->me_metas[ mdb_env_pick_meta(env) ];
2454 txn->mt_txnid = meta->mm_txnid;
2455 txn->mt_u.reader = NULL;
2457 MDB_reader *r = (env->me_flags & MDB_NOTLS) ? txn->mt_u.reader :
2458 pthread_getspecific(env->me_txkey);
2460 if (r->mr_pid != env->me_pid || r->mr_txnid != (txnid_t)-1)
2461 return MDB_BAD_RSLOT;
2463 MDB_PID_T pid = env->me_pid;
2464 MDB_THR_T tid = pthread_self();
2466 if (!env->me_live_reader) {
2467 rc = mdb_reader_pid(env, Pidset, pid);
2470 env->me_live_reader = 1;
2474 nr = ti->mti_numreaders;
2475 for (i=0; i<nr; i++)
2476 if (ti->mti_readers[i].mr_pid == 0)
2478 if (i == env->me_maxreaders) {
2479 UNLOCK_MUTEX_R(env);
2480 return MDB_READERS_FULL;
2482 ti->mti_readers[i].mr_pid = pid;
2483 ti->mti_readers[i].mr_tid = tid;
2485 ti->mti_numreaders = ++nr;
2486 /* Save numreaders for un-mutexed mdb_env_close() */
2487 env->me_numreaders = nr;
2488 UNLOCK_MUTEX_R(env);
2490 r = &ti->mti_readers[i];
2491 new_notls = (env->me_flags & MDB_NOTLS);
2492 if (!new_notls && (rc=pthread_setspecific(env->me_txkey, r))) {
2497 txn->mt_txnid = r->mr_txnid = ti->mti_txnid;
2498 txn->mt_u.reader = r;
2499 meta = env->me_metas[txn->mt_txnid & 1];
2505 txn->mt_txnid = ti->mti_txnid;
2506 meta = env->me_metas[txn->mt_txnid & 1];
2508 meta = env->me_metas[ mdb_env_pick_meta(env) ];
2509 txn->mt_txnid = meta->mm_txnid;
2513 if (txn->mt_txnid == mdb_debug_start)
2516 txn->mt_dirty_room = MDB_IDL_UM_MAX;
2517 txn->mt_u.dirty_list = env->me_dirty_list;
2518 txn->mt_u.dirty_list[0].mid = 0;
2519 txn->mt_free_pgs = env->me_free_pgs;
2520 txn->mt_free_pgs[0] = 0;
2521 txn->mt_spill_pgs = NULL;
2523 memcpy(txn->mt_dbiseqs, env->me_dbiseqs, env->me_maxdbs * sizeof(unsigned int));
2526 /* Copy the DB info and flags */
2527 memcpy(txn->mt_dbs, meta->mm_dbs, 2 * sizeof(MDB_db));
2529 /* Moved to here to avoid a data race in read TXNs */
2530 txn->mt_next_pgno = meta->mm_last_pg+1;
2532 for (i=2; i<txn->mt_numdbs; i++) {
2533 x = env->me_dbflags[i];
2534 txn->mt_dbs[i].md_flags = x & PERSISTENT_FLAGS;
2535 txn->mt_dbflags[i] = (x & MDB_VALID) ? DB_VALID|DB_STALE : 0;
2537 txn->mt_dbflags[0] = txn->mt_dbflags[1] = DB_VALID;
2539 /* If we didn't ask for a resize, but the size grew, fail */
2540 if (!(env->me_flags & MDB_RESIZING)
2541 && env->me_mapsize < meta->mm_mapsize) {
2542 mdb_txn_reset0(txn, "renew0-mapfail");
2544 txn->mt_u.reader->mr_pid = 0;
2545 txn->mt_u.reader = NULL;
2547 return MDB_MAP_RESIZED;
2554 mdb_txn_renew(MDB_txn *txn)
2558 if (!txn || txn->mt_dbxs) /* A reset txn has mt_dbxs==NULL */
2561 if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
2562 DPUTS("environment had fatal error, must shutdown!");
2566 rc = mdb_txn_renew0(txn);
2567 if (rc == MDB_SUCCESS) {
2568 DPRINTF(("renew txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2569 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2570 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root));
2576 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
2580 int rc, size, tsize = sizeof(MDB_txn);
2582 if (env->me_flags & MDB_FATAL_ERROR) {
2583 DPUTS("environment had fatal error, must shutdown!");
2586 if ((env->me_flags & MDB_RDONLY) && !(flags & MDB_RDONLY))
2589 /* Nested transactions: Max 1 child, write txns only, no writemap */
2590 if (parent->mt_child ||
2591 (flags & MDB_RDONLY) ||
2592 (parent->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR)) ||
2593 (env->me_flags & MDB_WRITEMAP))
2595 return (parent->mt_flags & MDB_TXN_RDONLY) ? EINVAL : MDB_BAD_TXN;
2597 tsize = sizeof(MDB_ntxn);
2599 size = tsize + env->me_maxdbs * (sizeof(MDB_db)+1);
2600 if (!(flags & MDB_RDONLY)) {
2601 size += env->me_maxdbs * sizeof(MDB_cursor *);
2602 /* child txns use parent's dbiseqs */
2604 size += env->me_maxdbs * sizeof(unsigned int);
2607 if ((txn = calloc(1, size)) == NULL) {
2608 DPRINTF(("calloc: %s", strerror(errno)));
2611 txn->mt_dbs = (MDB_db *) ((char *)txn + tsize);
2612 if (flags & MDB_RDONLY) {
2613 txn->mt_flags |= MDB_TXN_RDONLY;
2614 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
2615 txn->mt_dbiseqs = env->me_dbiseqs;
2617 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
2619 txn->mt_dbiseqs = parent->mt_dbiseqs;
2620 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
2622 txn->mt_dbiseqs = (unsigned int *)(txn->mt_cursors + env->me_maxdbs);
2623 txn->mt_dbflags = (unsigned char *)(txn->mt_dbiseqs + env->me_maxdbs);
2630 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
2631 if (!txn->mt_u.dirty_list ||
2632 !(txn->mt_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)))
2634 free(txn->mt_u.dirty_list);
2638 txn->mt_txnid = parent->mt_txnid;
2639 txn->mt_dirty_room = parent->mt_dirty_room;
2640 txn->mt_u.dirty_list[0].mid = 0;
2641 txn->mt_spill_pgs = NULL;
2642 txn->mt_next_pgno = parent->mt_next_pgno;
2643 parent->mt_child = txn;
2644 txn->mt_parent = parent;
2645 txn->mt_numdbs = parent->mt_numdbs;
2646 txn->mt_flags = parent->mt_flags;
2647 txn->mt_dbxs = parent->mt_dbxs;
2648 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
2649 /* Copy parent's mt_dbflags, but clear DB_NEW */
2650 for (i=0; i<txn->mt_numdbs; i++)
2651 txn->mt_dbflags[i] = parent->mt_dbflags[i] & ~DB_NEW;
2653 ntxn = (MDB_ntxn *)txn;
2654 ntxn->mnt_pgstate = env->me_pgstate; /* save parent me_pghead & co */
2655 if (env->me_pghead) {
2656 size = MDB_IDL_SIZEOF(env->me_pghead);
2657 env->me_pghead = mdb_midl_alloc(env->me_pghead[0]);
2659 memcpy(env->me_pghead, ntxn->mnt_pgstate.mf_pghead, size);
2664 rc = mdb_cursor_shadow(parent, txn);
2666 mdb_txn_reset0(txn, "beginchild-fail");
2668 rc = mdb_txn_renew0(txn);
2674 DPRINTF(("begin txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2675 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2676 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root));
2683 mdb_txn_env(MDB_txn *txn)
2685 if(!txn) return NULL;
2689 /** Export or close DBI handles opened in this txn. */
2691 mdb_dbis_update(MDB_txn *txn, int keep)
2694 MDB_dbi n = txn->mt_numdbs;
2695 MDB_env *env = txn->mt_env;
2696 unsigned char *tdbflags = txn->mt_dbflags;
2698 for (i = n; --i >= 2;) {
2699 if (tdbflags[i] & DB_NEW) {
2701 env->me_dbflags[i] = txn->mt_dbs[i].md_flags | MDB_VALID;
2703 char *ptr = env->me_dbxs[i].md_name.mv_data;
2705 env->me_dbxs[i].md_name.mv_data = NULL;
2706 env->me_dbxs[i].md_name.mv_size = 0;
2707 env->me_dbflags[i] = 0;
2708 env->me_dbiseqs[i]++;
2714 if (keep && env->me_numdbs < n)
2718 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
2719 * May be called twice for readonly txns: First reset it, then abort.
2720 * @param[in] txn the transaction handle to reset
2721 * @param[in] act why the transaction is being reset
2724 mdb_txn_reset0(MDB_txn *txn, const char *act)
2726 MDB_env *env = txn->mt_env;
2728 /* Close any DBI handles opened in this txn */
2729 mdb_dbis_update(txn, 0);
2731 DPRINTF(("%s txn %"Z"u%c %p on mdbenv %p, root page %"Z"u",
2732 act, txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
2733 (void *) txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root));
2735 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
2736 if (txn->mt_u.reader) {
2737 txn->mt_u.reader->mr_txnid = (txnid_t)-1;
2738 if (!(env->me_flags & MDB_NOTLS))
2739 txn->mt_u.reader = NULL; /* txn does not own reader */
2741 txn->mt_numdbs = 0; /* close nothing if called again */
2742 txn->mt_dbxs = NULL; /* mark txn as reset */
2744 mdb_cursors_close(txn, 0);
2746 if (!(env->me_flags & MDB_WRITEMAP)) {
2747 mdb_dlist_free(txn);
2749 mdb_midl_free(env->me_pghead);
2751 if (txn->mt_parent) {
2752 txn->mt_parent->mt_child = NULL;
2753 env->me_pgstate = ((MDB_ntxn *)txn)->mnt_pgstate;
2754 mdb_midl_free(txn->mt_free_pgs);
2755 mdb_midl_free(txn->mt_spill_pgs);
2756 free(txn->mt_u.dirty_list);
2760 if (mdb_midl_shrink(&txn->mt_free_pgs))
2761 env->me_free_pgs = txn->mt_free_pgs;
2762 env->me_pghead = NULL;
2766 /* The writer mutex was locked in mdb_txn_begin. */
2768 UNLOCK_MUTEX_W(env);
2773 mdb_txn_reset(MDB_txn *txn)
2778 /* This call is only valid for read-only txns */
2779 if (!(txn->mt_flags & MDB_TXN_RDONLY))
2782 mdb_txn_reset0(txn, "reset");
2786 mdb_txn_abort(MDB_txn *txn)
2792 mdb_txn_abort(txn->mt_child);
2794 mdb_txn_reset0(txn, "abort");
2795 /* Free reader slot tied to this txn (if MDB_NOTLS && writable FS) */
2796 if ((txn->mt_flags & MDB_TXN_RDONLY) && txn->mt_u.reader)
2797 txn->mt_u.reader->mr_pid = 0;
2802 /** Save the freelist as of this transaction to the freeDB.
2803 * This changes the freelist. Keep trying until it stabilizes.
2806 mdb_freelist_save(MDB_txn *txn)
2808 /* env->me_pghead[] can grow and shrink during this call.
2809 * env->me_pglast and txn->mt_free_pgs[] can only grow.
2810 * Page numbers cannot disappear from txn->mt_free_pgs[].
2813 MDB_env *env = txn->mt_env;
2814 int rc, maxfree_1pg = env->me_maxfree_1pg, more = 1;
2815 txnid_t pglast = 0, head_id = 0;
2816 pgno_t freecnt = 0, *free_pgs, *mop;
2817 ssize_t head_room = 0, total_room = 0, mop_len, clean_limit;
2819 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
2821 if (env->me_pghead) {
2822 /* Make sure first page of freeDB is touched and on freelist */
2823 rc = mdb_page_search(&mc, NULL, MDB_PS_FIRST|MDB_PS_MODIFY);
2824 if (rc && rc != MDB_NOTFOUND)
2828 /* Dispose of loose pages. Usually they will have all
2829 * been used up by the time we get here.
2831 if (txn->mt_loose_pgs) {
2832 MDB_page *mp = txn->mt_loose_pgs;
2833 /* Just return them to freeDB */
2834 if (env->me_pghead) {
2836 mop = env->me_pghead;
2837 for (; mp; mp = NEXT_LOOSE_PAGE(mp)) {
2838 pgno_t pg = mp->mp_pgno;
2840 for (i = mop[0]; i && mop[i] < pg; i--)
2846 /* Oh well, they were wasted. Put on freelist */
2847 for (; mp; mp = NEXT_LOOSE_PAGE(mp)) {
2848 mdb_midl_append(&txn->mt_free_pgs, mp->mp_pgno);
2851 txn->mt_loose_pgs = NULL;
2854 /* MDB_RESERVE cancels meminit in ovpage malloc (when no WRITEMAP) */
2855 clean_limit = (env->me_flags & (MDB_NOMEMINIT|MDB_WRITEMAP))
2856 ? SSIZE_MAX : maxfree_1pg;
2859 /* Come back here after each Put() in case freelist changed */
2864 /* If using records from freeDB which we have not yet
2865 * deleted, delete them and any we reserved for me_pghead.
2867 while (pglast < env->me_pglast) {
2868 rc = mdb_cursor_first(&mc, &key, NULL);
2871 pglast = head_id = *(txnid_t *)key.mv_data;
2872 total_room = head_room = 0;
2873 mdb_tassert(txn, pglast <= env->me_pglast);
2874 rc = mdb_cursor_del(&mc, 0);
2879 /* Save the IDL of pages freed by this txn, to a single record */
2880 if (freecnt < txn->mt_free_pgs[0]) {
2882 /* Make sure last page of freeDB is touched and on freelist */
2883 rc = mdb_page_search(&mc, NULL, MDB_PS_LAST|MDB_PS_MODIFY);
2884 if (rc && rc != MDB_NOTFOUND)
2887 free_pgs = txn->mt_free_pgs;
2888 /* Write to last page of freeDB */
2889 key.mv_size = sizeof(txn->mt_txnid);
2890 key.mv_data = &txn->mt_txnid;
2892 freecnt = free_pgs[0];
2893 data.mv_size = MDB_IDL_SIZEOF(free_pgs);
2894 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2897 /* Retry if mt_free_pgs[] grew during the Put() */
2898 free_pgs = txn->mt_free_pgs;
2899 } while (freecnt < free_pgs[0]);
2900 mdb_midl_sort(free_pgs);
2901 memcpy(data.mv_data, free_pgs, data.mv_size);
2904 unsigned int i = free_pgs[0];
2905 DPRINTF(("IDL write txn %"Z"u root %"Z"u num %u",
2906 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, i));
2908 DPRINTF(("IDL %"Z"u", free_pgs[i]));
2914 mop = env->me_pghead;
2915 mop_len = mop ? mop[0] : 0;
2917 /* Reserve records for me_pghead[]. Split it if multi-page,
2918 * to avoid searching freeDB for a page range. Use keys in
2919 * range [1,me_pglast]: Smaller than txnid of oldest reader.
2921 if (total_room >= mop_len) {
2922 if (total_room == mop_len || --more < 0)
2924 } else if (head_room >= maxfree_1pg && head_id > 1) {
2925 /* Keep current record (overflow page), add a new one */
2929 /* (Re)write {key = head_id, IDL length = head_room} */
2930 total_room -= head_room;
2931 head_room = mop_len - total_room;
2932 if (head_room > maxfree_1pg && head_id > 1) {
2933 /* Overflow multi-page for part of me_pghead */
2934 head_room /= head_id; /* amortize page sizes */
2935 head_room += maxfree_1pg - head_room % (maxfree_1pg + 1);
2936 } else if (head_room < 0) {
2937 /* Rare case, not bothering to delete this record */
2940 key.mv_size = sizeof(head_id);
2941 key.mv_data = &head_id;
2942 data.mv_size = (head_room + 1) * sizeof(pgno_t);
2943 rc = mdb_cursor_put(&mc, &key, &data, MDB_RESERVE);
2946 /* IDL is initially empty, zero out at least the length */
2947 pgs = (pgno_t *)data.mv_data;
2948 j = head_room > clean_limit ? head_room : 0;
2952 total_room += head_room;
2955 /* Fill in the reserved me_pghead records */
2961 rc = mdb_cursor_first(&mc, &key, &data);
2962 for (; !rc; rc = mdb_cursor_next(&mc, &key, &data, MDB_NEXT)) {
2963 txnid_t id = *(txnid_t *)key.mv_data;
2964 ssize_t len = (ssize_t)(data.mv_size / sizeof(MDB_ID)) - 1;
2967 mdb_tassert(txn, len >= 0 && id <= env->me_pglast);
2969 if (len > mop_len) {
2971 data.mv_size = (len + 1) * sizeof(MDB_ID);
2973 data.mv_data = mop -= len;
2976 rc = mdb_cursor_put(&mc, &key, &data, MDB_CURRENT);
2978 if (rc || !(mop_len -= len))
2985 /** Flush (some) dirty pages to the map, after clearing their dirty flag.
2986 * @param[in] txn the transaction that's being committed
2987 * @param[in] keep number of initial pages in dirty_list to keep dirty.
2988 * @return 0 on success, non-zero on failure.
2991 mdb_page_flush(MDB_txn *txn, int keep)
2993 MDB_env *env = txn->mt_env;
2994 MDB_ID2L dl = txn->mt_u.dirty_list;
2995 unsigned psize = env->me_psize, j;
2996 int i, pagecount = dl[0].mid, rc;
2997 size_t size = 0, pos = 0;
2999 MDB_page *dp = NULL;
3003 struct iovec iov[MDB_COMMIT_PAGES];
3004 ssize_t wpos = 0, wsize = 0, wres;
3005 size_t next_pos = 1; /* impossible pos, so pos != next_pos */
3011 if (env->me_flags & MDB_WRITEMAP) {
3012 /* Clear dirty flags */
3013 while (++i <= pagecount) {
3015 /* Don't flush this page yet */
3016 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3017 dp->mp_flags &= ~P_KEEP;
3021 dp->mp_flags &= ~P_DIRTY;
3026 /* Write the pages */
3028 if (++i <= pagecount) {
3030 /* Don't flush this page yet */
3031 if (dp->mp_flags & (P_LOOSE|P_KEEP)) {
3032 dp->mp_flags &= ~P_KEEP;
3037 /* clear dirty flag */
3038 dp->mp_flags &= ~P_DIRTY;
3041 if (IS_OVERFLOW(dp)) size *= dp->mp_pages;
3046 /* Windows actually supports scatter/gather I/O, but only on
3047 * unbuffered file handles. Since we're relying on the OS page
3048 * cache for all our data, that's self-defeating. So we just
3049 * write pages one at a time. We use the ov structure to set
3050 * the write offset, to at least save the overhead of a Seek
3053 DPRINTF(("committing page %"Z"u", pgno));
3054 memset(&ov, 0, sizeof(ov));
3055 ov.Offset = pos & 0xffffffff;
3056 ov.OffsetHigh = pos >> 16 >> 16;
3057 if (!WriteFile(env->me_fd, dp, size, NULL, &ov)) {
3059 DPRINTF(("WriteFile: %d", rc));
3063 /* Write up to MDB_COMMIT_PAGES dirty pages at a time. */
3064 if (pos!=next_pos || n==MDB_COMMIT_PAGES || wsize+size>MAX_WRITE) {
3066 /* Write previous page(s) */
3067 #ifdef MDB_USE_PWRITEV
3068 wres = pwritev(env->me_fd, iov, n, wpos);
3071 wres = pwrite(env->me_fd, iov[0].iov_base, wsize, wpos);
3073 if (lseek(env->me_fd, wpos, SEEK_SET) == -1) {
3075 DPRINTF(("lseek: %s", strerror(rc)));
3078 wres = writev(env->me_fd, iov, n);
3081 if (wres != wsize) {
3084 DPRINTF(("Write error: %s", strerror(rc)));
3086 rc = EIO; /* TODO: Use which error code? */
3087 DPUTS("short write, filesystem full?");
3098 DPRINTF(("committing page %"Z"u", pgno));
3099 next_pos = pos + size;
3100 iov[n].iov_len = size;
3101 iov[n].iov_base = (char *)dp;
3107 for (i = keep; ++i <= pagecount; ) {
3109 /* This is a page we skipped above */
3112 dl[j].mid = dp->mp_pgno;
3115 mdb_dpage_free(env, dp);
3120 txn->mt_dirty_room += i - j;
3126 mdb_txn_commit(MDB_txn *txn)
3132 if (txn == NULL || txn->mt_env == NULL)
3135 if (txn->mt_child) {
3136 rc = mdb_txn_commit(txn->mt_child);
3137 txn->mt_child = NULL;
3144 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
3145 mdb_dbis_update(txn, 1);
3146 txn->mt_numdbs = 2; /* so txn_abort() doesn't close any new handles */
3151 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
3152 DPUTS("error flag is set, can't commit");
3154 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
3159 if (txn->mt_parent) {
3160 MDB_txn *parent = txn->mt_parent;
3164 unsigned x, y, len, ps_len;
3166 /* Append our free list to parent's */
3167 rc = mdb_midl_append_list(&parent->mt_free_pgs, txn->mt_free_pgs);
3170 mdb_midl_free(txn->mt_free_pgs);
3171 /* Failures after this must either undo the changes
3172 * to the parent or set MDB_TXN_ERROR in the parent.
3175 parent->mt_next_pgno = txn->mt_next_pgno;
3176 parent->mt_flags = txn->mt_flags;
3178 /* Merge our cursors into parent's and close them */
3179 mdb_cursors_close(txn, 1);
3181 /* Update parent's DB table. */
3182 memcpy(parent->mt_dbs, txn->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
3183 parent->mt_numdbs = txn->mt_numdbs;
3184 parent->mt_dbflags[0] = txn->mt_dbflags[0];
3185 parent->mt_dbflags[1] = txn->mt_dbflags[1];
3186 for (i=2; i<txn->mt_numdbs; i++) {
3187 /* preserve parent's DB_NEW status */
3188 x = parent->mt_dbflags[i] & DB_NEW;
3189 parent->mt_dbflags[i] = txn->mt_dbflags[i] | x;
3192 dst = parent->mt_u.dirty_list;
3193 src = txn->mt_u.dirty_list;
3194 /* Remove anything in our dirty list from parent's spill list */
3195 if ((pspill = parent->mt_spill_pgs) && (ps_len = pspill[0])) {
3197 pspill[0] = (pgno_t)-1;
3198 /* Mark our dirty pages as deleted in parent spill list */
3199 for (i=0, len=src[0].mid; ++i <= len; ) {
3200 MDB_ID pn = src[i].mid << 1;
3201 while (pn > pspill[x])
3203 if (pn == pspill[x]) {
3208 /* Squash deleted pagenums if we deleted any */
3209 for (x=y; ++x <= ps_len; )
3210 if (!(pspill[x] & 1))
3211 pspill[++y] = pspill[x];
3215 /* Find len = length of merging our dirty list with parent's */
3217 dst[0].mid = 0; /* simplify loops */
3218 if (parent->mt_parent) {
3219 len = x + src[0].mid;
3220 y = mdb_mid2l_search(src, dst[x].mid + 1) - 1;
3221 for (i = x; y && i; y--) {
3222 pgno_t yp = src[y].mid;
3223 while (yp < dst[i].mid)
3225 if (yp == dst[i].mid) {
3230 } else { /* Simplify the above for single-ancestor case */
3231 len = MDB_IDL_UM_MAX - txn->mt_dirty_room;
3233 /* Merge our dirty list with parent's */
3235 for (i = len; y; dst[i--] = src[y--]) {
3236 pgno_t yp = src[y].mid;
3237 while (yp < dst[x].mid)
3238 dst[i--] = dst[x--];
3239 if (yp == dst[x].mid)
3240 free(dst[x--].mptr);
3242 mdb_tassert(txn, i == x);
3244 free(txn->mt_u.dirty_list);
3245 parent->mt_dirty_room = txn->mt_dirty_room;
3246 if (txn->mt_spill_pgs) {
3247 if (parent->mt_spill_pgs) {
3248 /* TODO: Prevent failure here, so parent does not fail */
3249 rc = mdb_midl_append_list(&parent->mt_spill_pgs, txn->mt_spill_pgs);
3251 parent->mt_flags |= MDB_TXN_ERROR;
3252 mdb_midl_free(txn->mt_spill_pgs);
3253 mdb_midl_sort(parent->mt_spill_pgs);
3255 parent->mt_spill_pgs = txn->mt_spill_pgs;
3259 /* Append our loose page list to parent's */
3260 for (lp = &parent->mt_loose_pgs; *lp; lp = &NEXT_LOOSE_PAGE(lp))
3262 *lp = txn->mt_loose_pgs;
3264 parent->mt_child = NULL;
3265 mdb_midl_free(((MDB_ntxn *)txn)->mnt_pgstate.mf_pghead);
3270 if (txn != env->me_txn) {
3271 DPUTS("attempt to commit unknown transaction");
3276 mdb_cursors_close(txn, 0);
3278 if (!txn->mt_u.dirty_list[0].mid &&
3279 !(txn->mt_flags & (MDB_TXN_DIRTY|MDB_TXN_SPILLS))) {
3280 if ((env->me_flags & MDB_RESIZING)
3281 && (rc = mdb_env_write_meta(txn))) {
3287 DPRINTF(("committing txn %"Z"u %p on mdbenv %p, root page %"Z"u",
3288 txn->mt_txnid, (void*)txn, (void*)env, txn->mt_dbs[MAIN_DBI].md_root));
3290 /* Update DB root pointers */
3291 if (txn->mt_numdbs > 2) {
3295 data.mv_size = sizeof(MDB_db);
3297 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
3298 for (i = 2; i < txn->mt_numdbs; i++) {
3299 if (txn->mt_dbflags[i] & DB_DIRTY) {
3300 if (TXN_DBI_CHANGED(txn, i)) {
3304 data.mv_data = &txn->mt_dbs[i];
3305 rc = mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
3312 rc = mdb_freelist_save(txn);
3316 mdb_midl_free(env->me_pghead);
3317 env->me_pghead = NULL;
3318 if (mdb_midl_shrink(&txn->mt_free_pgs))
3319 env->me_free_pgs = txn->mt_free_pgs;
3325 if ((rc = mdb_page_flush(txn, 0)) ||
3326 (rc = mdb_env_sync(env, 0)) ||
3327 (rc = mdb_env_write_meta(txn)))
3333 mdb_dbis_update(txn, 1);
3336 UNLOCK_MUTEX_W(env);
3346 /** Read the environment parameters of a DB environment before
3347 * mapping it into memory.
3348 * @param[in] env the environment handle
3349 * @param[out] meta address of where to store the meta information
3350 * @return 0 on success, non-zero on failure.
3353 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
3359 enum { Size = sizeof(pbuf) };
3361 /* We don't know the page size yet, so use a minimum value.
3362 * Read both meta pages so we can use the latest one.
3365 for (i=off=0; i<2; i++, off = meta->mm_psize) {
3369 memset(&ov, 0, sizeof(ov));
3371 rc = ReadFile(env->me_fd, &pbuf, Size, &len, &ov) ? (int)len : -1;
3372 if (rc == -1 && ErrCode() == ERROR_HANDLE_EOF)
3375 rc = pread(env->me_fd, &pbuf, Size, off);
3378 if (rc == 0 && off == 0)
3380 rc = rc < 0 ? (int) ErrCode() : MDB_INVALID;
3381 DPRINTF(("read: %s", mdb_strerror(rc)));
3385 p = (MDB_page *)&pbuf;
3387 if (!F_ISSET(p->mp_flags, P_META)) {
3388 DPRINTF(("page %"Z"u not a meta page", p->mp_pgno));
3393 if (m->mm_magic != MDB_MAGIC) {
3394 DPUTS("meta has invalid magic");
3398 if (m->mm_version != MDB_DATA_VERSION) {
3399 DPRINTF(("database is version %u, expected version %u",
3400 m->mm_version, MDB_DATA_VERSION));
3401 return MDB_VERSION_MISMATCH;
3404 if (off == 0 || m->mm_txnid > meta->mm_txnid)
3411 mdb_env_init_meta0(MDB_env *env, MDB_meta *meta)
3413 meta->mm_magic = MDB_MAGIC;
3414 meta->mm_version = MDB_DATA_VERSION;
3415 meta->mm_mapsize = env->me_mapsize;
3416 meta->mm_psize = env->me_psize;
3417 meta->mm_last_pg = 1;
3418 meta->mm_flags = env->me_flags & 0xffff;
3419 meta->mm_flags |= MDB_INTEGERKEY;
3420 meta->mm_dbs[0].md_root = P_INVALID;
3421 meta->mm_dbs[1].md_root = P_INVALID;
3424 /** Write the environment parameters of a freshly created DB environment.
3425 * @param[in] env the environment handle
3426 * @param[out] meta address of where to store the meta information
3427 * @return 0 on success, non-zero on failure.
3430 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
3438 memset(&ov, 0, sizeof(ov));
3439 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3441 rc = WriteFile(fd, ptr, size, &len, &ov); } while(0)
3444 #define DO_PWRITE(rc, fd, ptr, size, len, pos) do { \
3445 len = pwrite(fd, ptr, size, pos); \
3446 rc = (len >= 0); } while(0)
3449 DPUTS("writing new meta page");
3451 psize = env->me_psize;
3453 mdb_env_init_meta0(env, meta);
3455 p = calloc(2, psize);
3457 p->mp_flags = P_META;
3458 *(MDB_meta *)METADATA(p) = *meta;
3460 q = (MDB_page *)((char *)p + psize);
3462 q->mp_flags = P_META;
3463 *(MDB_meta *)METADATA(q) = *meta;
3465 DO_PWRITE(rc, env->me_fd, p, psize * 2, len, 0);
3468 else if ((unsigned) len == psize * 2)
3476 /** Update the environment info to commit a transaction.
3477 * @param[in] txn the transaction that's being committed
3478 * @return 0 on success, non-zero on failure.
3481 mdb_env_write_meta(MDB_txn *txn)
3484 MDB_meta meta, metab, *mp;
3486 int rc, len, toggle;
3495 toggle = txn->mt_txnid & 1;
3496 DPRINTF(("writing meta page %d for root page %"Z"u",
3497 toggle, txn->mt_dbs[MAIN_DBI].md_root));
3500 mp = env->me_metas[toggle];
3502 if (env->me_flags & MDB_WRITEMAP) {
3503 /* Persist any changes of mapsize config */
3504 if (env->me_flags & MDB_RESIZING) {
3505 mp->mm_mapsize = env->me_mapsize;
3506 env->me_flags ^= MDB_RESIZING;
3508 mp->mm_dbs[0] = txn->mt_dbs[0];
3509 mp->mm_dbs[1] = txn->mt_dbs[1];
3510 mp->mm_last_pg = txn->mt_next_pgno - 1;
3511 mp->mm_txnid = txn->mt_txnid;
3512 if (!(env->me_flags & (MDB_NOMETASYNC|MDB_NOSYNC))) {
3513 unsigned meta_size = env->me_psize;
3514 rc = (env->me_flags & MDB_MAPASYNC) ? MS_ASYNC : MS_SYNC;
3517 #ifndef _WIN32 /* POSIX msync() requires ptr = start of OS page */
3518 if (meta_size < env->me_os_psize)
3519 meta_size += meta_size;
3524 if (MDB_MSYNC(ptr, meta_size, rc)) {
3531 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
3532 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
3534 ptr = (char *)&meta;
3535 if (env->me_flags & MDB_RESIZING) {
3536 /* Persist any changes of mapsize config */
3537 meta.mm_mapsize = env->me_mapsize;
3538 off = offsetof(MDB_meta, mm_mapsize);
3539 env->me_flags ^= MDB_RESIZING;
3541 off = offsetof(MDB_meta, mm_dbs[0].md_depth);
3543 len = sizeof(MDB_meta) - off;
3546 meta.mm_dbs[0] = txn->mt_dbs[0];
3547 meta.mm_dbs[1] = txn->mt_dbs[1];
3548 meta.mm_last_pg = txn->mt_next_pgno - 1;
3549 meta.mm_txnid = txn->mt_txnid;
3552 off += env->me_psize;
3555 /* Write to the SYNC fd */
3556 mfd = env->me_flags & (MDB_NOSYNC|MDB_NOMETASYNC) ?
3557 env->me_fd : env->me_mfd;
3560 memset(&ov, 0, sizeof(ov));
3562 if (!WriteFile(mfd, ptr, len, (DWORD *)&rc, &ov))
3566 rc = pwrite(mfd, ptr, len, off);
3569 rc = rc < 0 ? ErrCode() : EIO;
3570 DPUTS("write failed, disk error?");
3571 /* On a failure, the pagecache still contains the new data.
3572 * Write some old data back, to prevent it from being used.
3573 * Use the non-SYNC fd; we know it will fail anyway.
3575 meta.mm_last_pg = metab.mm_last_pg;
3576 meta.mm_txnid = metab.mm_txnid;
3578 memset(&ov, 0, sizeof(ov));
3580 WriteFile(env->me_fd, ptr, len, NULL, &ov);
3582 r2 = pwrite(env->me_fd, ptr, len, off);
3583 (void)r2; /* Silence warnings. We don't care about pwrite's return value */
3586 env->me_flags |= MDB_FATAL_ERROR;
3590 /* Memory ordering issues are irrelevant; since the entire writer
3591 * is wrapped by wmutex, all of these changes will become visible
3592 * after the wmutex is unlocked. Since the DB is multi-version,
3593 * readers will get consistent data regardless of how fresh or
3594 * how stale their view of these values is.
3597 env->me_txns->mti_txnid = txn->mt_txnid;
3602 /** Check both meta pages to see which one is newer.
3603 * @param[in] env the environment handle
3604 * @return meta toggle (0 or 1).
3607 mdb_env_pick_meta(const MDB_env *env)
3609 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
3613 mdb_env_create(MDB_env **env)
3617 e = calloc(1, sizeof(MDB_env));
3621 e->me_maxreaders = DEFAULT_READERS;
3622 e->me_maxdbs = e->me_numdbs = 2;
3623 e->me_fd = INVALID_HANDLE_VALUE;
3624 e->me_lfd = INVALID_HANDLE_VALUE;
3625 e->me_mfd = INVALID_HANDLE_VALUE;
3626 #ifdef MDB_USE_POSIX_SEM
3627 e->me_rmutex = SEM_FAILED;
3628 e->me_wmutex = SEM_FAILED;
3630 e->me_pid = getpid();
3631 GET_PAGESIZE(e->me_os_psize);
3632 VGMEMP_CREATE(e,0,0);
3638 mdb_env_map(MDB_env *env, void *addr, int newsize)
3641 unsigned int flags = env->me_flags;
3645 LONG sizelo, sizehi;
3648 if (flags & MDB_RDONLY) {
3653 msize = env->me_mapsize;
3654 sizelo = msize & 0xffffffff;
3655 sizehi = msize >> 16 >> 16; /* only needed on Win64 */
3658 /* Windows won't create mappings for zero length files.
3659 * Just allocate the maxsize right now.
3662 if (SetFilePointer(env->me_fd, sizelo, &sizehi, 0) != (DWORD)sizelo
3663 || !SetEndOfFile(env->me_fd)
3664 || SetFilePointer(env->me_fd, 0, NULL, 0) != 0)
3667 mh = CreateFileMapping(env->me_fd, NULL, flags & MDB_WRITEMAP ?
3668 PAGE_READWRITE : PAGE_READONLY,
3669 sizehi, sizelo, NULL);
3672 env->me_map = MapViewOfFileEx(mh, flags & MDB_WRITEMAP ?
3673 FILE_MAP_WRITE : FILE_MAP_READ,
3675 rc = env->me_map ? 0 : ErrCode();
3680 int prot = PROT_READ;
3681 if (flags & MDB_WRITEMAP) {
3683 if (ftruncate(env->me_fd, env->me_mapsize) < 0)
3686 env->me_map = mmap(addr, env->me_mapsize, prot, MAP_SHARED,
3688 if (env->me_map == MAP_FAILED) {
3693 if (flags & MDB_NORDAHEAD) {
3694 /* Turn off readahead. It's harmful when the DB is larger than RAM. */
3696 madvise(env->me_map, env->me_mapsize, MADV_RANDOM);
3698 #ifdef POSIX_MADV_RANDOM
3699 posix_madvise(env->me_map, env->me_mapsize, POSIX_MADV_RANDOM);
3700 #endif /* POSIX_MADV_RANDOM */
3701 #endif /* MADV_RANDOM */
3705 /* Can happen because the address argument to mmap() is just a
3706 * hint. mmap() can pick another, e.g. if the range is in use.
3707 * The MAP_FIXED flag would prevent that, but then mmap could
3708 * instead unmap existing pages to make room for the new map.
3710 if (addr && env->me_map != addr)
3711 return EBUSY; /* TODO: Make a new MDB_* error code? */
3713 p = (MDB_page *)env->me_map;
3714 env->me_metas[0] = METADATA(p);
3715 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + env->me_psize);
3721 mdb_env_set_mapsize(MDB_env *env, size_t size)
3723 /* If env is already open, caller is responsible for making
3724 * sure there are no active txns.
3732 size = env->me_metas[mdb_env_pick_meta(env)]->mm_mapsize;
3734 if (size < env->me_mapsize) {
3735 /* If the configured size is smaller, make sure it's
3736 * still big enough. Silently round up to minimum if not.
3738 size_t minsize = (env->me_metas[mdb_env_pick_meta(env)]->mm_last_pg + 1) * env->me_psize;
3742 /* nothing actually changed */
3743 if (size == env->me_mapsize)
3747 munmap(env->me_map, env->me_mapsize);
3748 env->me_mapsize = size;
3749 old = (env->me_flags & MDB_FIXEDMAP) ? env->me_map : NULL;
3750 rc = mdb_env_map(env, old, 1);
3754 env->me_flags |= MDB_RESIZING;
3756 env->me_mapsize = size;
3758 env->me_maxpg = env->me_mapsize / env->me_psize;
3763 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
3767 env->me_maxdbs = dbs + 2; /* Named databases + main and free DB */
3772 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
3774 if (env->me_map || readers < 1)
3776 env->me_maxreaders = readers;
3781 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
3783 if (!env || !readers)
3785 *readers = env->me_maxreaders;
3789 /** Further setup required for opening an LMDB environment
3792 mdb_env_open2(MDB_env *env)
3794 unsigned int flags = env->me_flags;
3795 int i, newenv = 0, rc;
3799 /* See if we should use QueryLimited */
3801 if ((rc & 0xff) > 5)
3802 env->me_pidquery = MDB_PROCESS_QUERY_LIMITED_INFORMATION;
3804 env->me_pidquery = PROCESS_QUERY_INFORMATION;
3807 memset(&meta, 0, sizeof(meta));
3809 if ((i = mdb_env_read_header(env, &meta)) != 0) {
3812 DPUTS("new mdbenv");
3814 env->me_psize = env->me_os_psize;
3815 if (env->me_psize > MAX_PAGESIZE)
3816 env->me_psize = MAX_PAGESIZE;
3818 env->me_psize = meta.mm_psize;
3821 /* Was a mapsize configured? */
3822 if (!env->me_mapsize) {
3823 /* If this is a new environment, take the default,
3824 * else use the size recorded in the existing env.
3826 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
3828 if (env->me_mapsize < meta.mm_mapsize) {
3829 /* If the configured size is smaller, make sure it's
3830 * still big enough. Silently round up to minimum if not.
3832 size_t minsize = (meta.mm_last_pg + 1) * meta.mm_psize;
3833 if (env->me_mapsize < minsize)
3834 env->me_mapsize = minsize;
3836 if (env->me_mapsize != meta.mm_mapsize)
3837 env->me_flags |= MDB_RESIZING;
3840 rc = mdb_env_map(env, meta.mm_address, newenv || env->me_mapsize != meta.mm_mapsize);
3845 if (flags & MDB_FIXEDMAP)
3846 meta.mm_address = env->me_map;
3847 i = mdb_env_init_meta(env, &meta);
3848 if (i != MDB_SUCCESS) {
3853 env->me_maxfree_1pg = (env->me_psize - PAGEHDRSZ) / sizeof(pgno_t) - 1;
3854 env->me_nodemax = (((env->me_psize - PAGEHDRSZ) / MDB_MINKEYS) & -2)
3856 #if !(MDB_MAXKEYSIZE)
3857 env->me_maxkey = env->me_nodemax - (NODESIZE + sizeof(MDB_db));
3859 env->me_maxpg = env->me_mapsize / env->me_psize;
3863 int toggle = mdb_env_pick_meta(env);
3864 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
3866 DPRINTF(("opened database version %u, pagesize %u",
3867 env->me_metas[0]->mm_version, env->me_psize));
3868 DPRINTF(("using meta page %d", toggle));
3869 DPRINTF(("depth: %u", db->md_depth));
3870 DPRINTF(("entries: %"Z"u", db->md_entries));
3871 DPRINTF(("branch pages: %"Z"u", db->md_branch_pages));
3872 DPRINTF(("leaf pages: %"Z"u", db->md_leaf_pages));
3873 DPRINTF(("overflow pages: %"Z"u", db->md_overflow_pages));
3874 DPRINTF(("root: %"Z"u", db->md_root));
3882 /** Release a reader thread's slot in the reader lock table.
3883 * This function is called automatically when a thread exits.
3884 * @param[in] ptr This points to the slot in the reader lock table.
3887 mdb_env_reader_dest(void *ptr)
3889 MDB_reader *reader = ptr;
3895 /** Junk for arranging thread-specific callbacks on Windows. This is
3896 * necessarily platform and compiler-specific. Windows supports up
3897 * to 1088 keys. Let's assume nobody opens more than 64 environments
3898 * in a single process, for now. They can override this if needed.
3900 #ifndef MAX_TLS_KEYS
3901 #define MAX_TLS_KEYS 64
3903 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
3904 static int mdb_tls_nkeys;
3906 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
3910 case DLL_PROCESS_ATTACH: break;
3911 case DLL_THREAD_ATTACH: break;
3912 case DLL_THREAD_DETACH:
3913 for (i=0; i<mdb_tls_nkeys; i++) {
3914 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
3916 mdb_env_reader_dest(r);
3920 case DLL_PROCESS_DETACH: break;
3925 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3927 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
3931 /* Force some symbol references.
3932 * _tls_used forces the linker to create the TLS directory if not already done
3933 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
3935 #pragma comment(linker, "/INCLUDE:_tls_used")
3936 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
3937 #pragma const_seg(".CRT$XLB")
3938 extern const PIMAGE_TLS_CALLBACK mdb_tls_cbp;
3939 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3942 #pragma comment(linker, "/INCLUDE:__tls_used")
3943 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
3944 #pragma data_seg(".CRT$XLB")
3945 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
3947 #endif /* WIN 32/64 */
3948 #endif /* !__GNUC__ */
3951 /** Downgrade the exclusive lock on the region back to shared */
3953 mdb_env_share_locks(MDB_env *env, int *excl)
3955 int rc = 0, toggle = mdb_env_pick_meta(env);
3957 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
3962 /* First acquire a shared lock. The Unlock will
3963 * then release the existing exclusive lock.
3965 memset(&ov, 0, sizeof(ov));
3966 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
3969 UnlockFile(env->me_lfd, 0, 0, 1, 0);
3975 struct flock lock_info;
3976 /* The shared lock replaces the existing lock */
3977 memset((void *)&lock_info, 0, sizeof(lock_info));
3978 lock_info.l_type = F_RDLCK;
3979 lock_info.l_whence = SEEK_SET;
3980 lock_info.l_start = 0;
3981 lock_info.l_len = 1;
3982 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
3983 (rc = ErrCode()) == EINTR) ;
3984 *excl = rc ? -1 : 0; /* error may mean we lost the lock */
3991 /** Try to get exlusive lock, otherwise shared.
3992 * Maintain *excl = -1: no/unknown lock, 0: shared, 1: exclusive.
3995 mdb_env_excl_lock(MDB_env *env, int *excl)
3999 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
4003 memset(&ov, 0, sizeof(ov));
4004 if (LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
4011 struct flock lock_info;
4012 memset((void *)&lock_info, 0, sizeof(lock_info));
4013 lock_info.l_type = F_WRLCK;
4014 lock_info.l_whence = SEEK_SET;
4015 lock_info.l_start = 0;
4016 lock_info.l_len = 1;
4017 while ((rc = fcntl(env->me_lfd, F_SETLK, &lock_info)) &&
4018 (rc = ErrCode()) == EINTR) ;
4022 # ifdef MDB_USE_POSIX_SEM
4023 if (*excl < 0) /* always true when !MDB_USE_POSIX_SEM */
4026 lock_info.l_type = F_RDLCK;
4027 while ((rc = fcntl(env->me_lfd, F_SETLKW, &lock_info)) &&
4028 (rc = ErrCode()) == EINTR) ;
4038 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
4040 * @(#) $Revision: 5.1 $
4041 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
4042 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
4044 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
4048 * Please do not copyright this code. This code is in the public domain.
4050 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
4051 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
4052 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
4053 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
4054 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
4055 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
4056 * PERFORMANCE OF THIS SOFTWARE.
4059 * chongo <Landon Curt Noll> /\oo/\
4060 * http://www.isthe.com/chongo/
4062 * Share and Enjoy! :-)
4065 typedef unsigned long long mdb_hash_t;
4066 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
4068 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
4069 * @param[in] val value to hash
4070 * @param[in] hval initial value for hash
4071 * @return 64 bit hash
4073 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
4074 * hval arg on the first call.
4077 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
4079 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
4080 unsigned char *end = s + val->mv_size;
4082 * FNV-1a hash each octet of the string
4085 /* xor the bottom with the current octet */
4086 hval ^= (mdb_hash_t)*s++;
4088 /* multiply by the 64 bit FNV magic prime mod 2^64 */
4089 hval += (hval << 1) + (hval << 4) + (hval << 5) +
4090 (hval << 7) + (hval << 8) + (hval << 40);
4092 /* return our new hash value */
4096 /** Hash the string and output the encoded hash.
4097 * This uses modified RFC1924 Ascii85 encoding to accommodate systems with
4098 * very short name limits. We don't care about the encoding being reversible,
4099 * we just want to preserve as many bits of the input as possible in a
4100 * small printable string.
4101 * @param[in] str string to hash
4102 * @param[out] encbuf an array of 11 chars to hold the hash
4104 static const char mdb_a85[]= "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!#$%&()*+-;<=>?@^_`{|}~";
4107 mdb_pack85(unsigned long l, char *out)
4111 for (i=0; i<5; i++) {
4112 *out++ = mdb_a85[l % 85];
4118 mdb_hash_enc(MDB_val *val, char *encbuf)
4120 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
4122 mdb_pack85(h, encbuf);
4123 mdb_pack85(h>>32, encbuf+5);
4128 /** Open and/or initialize the lock region for the environment.
4129 * @param[in] env The LMDB environment.
4130 * @param[in] lpath The pathname of the file used for the lock region.
4131 * @param[in] mode The Unix permissions for the file, if we create it.
4132 * @param[out] excl Resulting file lock type: -1 none, 0 shared, 1 exclusive
4133 * @param[in,out] excl In -1, out lock type: -1 none, 0 shared, 1 exclusive
4134 * @return 0 on success, non-zero on failure.
4137 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
4140 # define MDB_ERRCODE_ROFS ERROR_WRITE_PROTECT
4142 # define MDB_ERRCODE_ROFS EROFS
4143 #ifdef O_CLOEXEC /* Linux: Open file and set FD_CLOEXEC atomically */
4144 # define MDB_CLOEXEC O_CLOEXEC
4147 # define MDB_CLOEXEC 0
4154 env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
4155 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
4156 FILE_ATTRIBUTE_NORMAL, NULL);
4158 env->me_lfd = open(lpath, O_RDWR|O_CREAT|MDB_CLOEXEC, mode);
4160 if (env->me_lfd == INVALID_HANDLE_VALUE) {
4162 if (rc == MDB_ERRCODE_ROFS && (env->me_flags & MDB_RDONLY)) {
4167 #if ! ((MDB_CLOEXEC) || defined(_WIN32))
4168 /* Lose record locks when exec*() */
4169 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
4170 fcntl(env->me_lfd, F_SETFD, fdflags);
4173 if (!(env->me_flags & MDB_NOTLS)) {
4174 rc = pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
4177 env->me_flags |= MDB_ENV_TXKEY;
4179 /* Windows TLS callbacks need help finding their TLS info. */
4180 if (mdb_tls_nkeys >= MAX_TLS_KEYS) {
4184 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
4188 /* Try to get exclusive lock. If we succeed, then
4189 * nobody is using the lock region and we should initialize it.
4191 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
4194 size = GetFileSize(env->me_lfd, NULL);
4196 size = lseek(env->me_lfd, 0, SEEK_END);
4197 if (size == -1) goto fail_errno;
4199 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
4200 if (size < rsize && *excl > 0) {
4202 if (SetFilePointer(env->me_lfd, rsize, NULL, FILE_BEGIN) != (DWORD)rsize
4203 || !SetEndOfFile(env->me_lfd))
4206 if (ftruncate(env->me_lfd, rsize) != 0) goto fail_errno;
4210 size = rsize - sizeof(MDB_txninfo);
4211 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
4216 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
4218 if (!mh) goto fail_errno;
4219 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
4221 if (!env->me_txns) goto fail_errno;
4223 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
4225 if (m == MAP_FAILED) goto fail_errno;
4231 BY_HANDLE_FILE_INFORMATION stbuf;
4240 if (!mdb_sec_inited) {
4241 InitializeSecurityDescriptor(&mdb_null_sd,
4242 SECURITY_DESCRIPTOR_REVISION);
4243 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
4244 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
4245 mdb_all_sa.bInheritHandle = FALSE;
4246 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
4249 if (!GetFileInformationByHandle(env->me_lfd, &stbuf)) goto fail_errno;
4250 idbuf.volume = stbuf.dwVolumeSerialNumber;
4251 idbuf.nhigh = stbuf.nFileIndexHigh;
4252 idbuf.nlow = stbuf.nFileIndexLow;
4253 val.mv_data = &idbuf;
4254 val.mv_size = sizeof(idbuf);
4255 mdb_hash_enc(&val, encbuf);
4256 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", encbuf);
4257 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", encbuf);
4258 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
4259 if (!env->me_rmutex) goto fail_errno;
4260 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
4261 if (!env->me_wmutex) goto fail_errno;
4262 #elif defined(MDB_USE_POSIX_SEM)
4271 #if defined(__NetBSD__)
4272 #define MDB_SHORT_SEMNAMES 1 /* limited to 14 chars */
4274 if (fstat(env->me_lfd, &stbuf)) goto fail_errno;
4275 idbuf.dev = stbuf.st_dev;
4276 idbuf.ino = stbuf.st_ino;
4277 val.mv_data = &idbuf;
4278 val.mv_size = sizeof(idbuf);
4279 mdb_hash_enc(&val, encbuf);
4280 #ifdef MDB_SHORT_SEMNAMES
4281 encbuf[9] = '\0'; /* drop name from 15 chars to 14 chars */
4283 sprintf(env->me_txns->mti_rmname, "/MDBr%s", encbuf);
4284 sprintf(env->me_txns->mti_wmname, "/MDBw%s", encbuf);
4285 /* Clean up after a previous run, if needed: Try to
4286 * remove both semaphores before doing anything else.
4288 sem_unlink(env->me_txns->mti_rmname);
4289 sem_unlink(env->me_txns->mti_wmname);
4290 env->me_rmutex = sem_open(env->me_txns->mti_rmname,
4291 O_CREAT|O_EXCL, mode, 1);
4292 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4293 env->me_wmutex = sem_open(env->me_txns->mti_wmname,
4294 O_CREAT|O_EXCL, mode, 1);
4295 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4296 #else /* MDB_USE_POSIX_SEM */
4297 pthread_mutexattr_t mattr;
4299 if ((rc = pthread_mutexattr_init(&mattr))
4300 || (rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED))
4301 || (rc = pthread_mutex_init(&env->me_txns->mti_mutex, &mattr))
4302 || (rc = pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr)))
4304 pthread_mutexattr_destroy(&mattr);
4305 #endif /* _WIN32 || MDB_USE_POSIX_SEM */
4307 env->me_txns->mti_magic = MDB_MAGIC;
4308 env->me_txns->mti_format = MDB_LOCK_FORMAT;
4309 env->me_txns->mti_txnid = 0;
4310 env->me_txns->mti_numreaders = 0;
4313 if (env->me_txns->mti_magic != MDB_MAGIC) {
4314 DPUTS("lock region has invalid magic");
4318 if (env->me_txns->mti_format != MDB_LOCK_FORMAT) {
4319 DPRINTF(("lock region has format+version 0x%x, expected 0x%x",
4320 env->me_txns->mti_format, MDB_LOCK_FORMAT));
4321 rc = MDB_VERSION_MISMATCH;
4325 if (rc && rc != EACCES && rc != EAGAIN) {
4329 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
4330 if (!env->me_rmutex) goto fail_errno;
4331 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
4332 if (!env->me_wmutex) goto fail_errno;
4333 #elif defined(MDB_USE_POSIX_SEM)
4334 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
4335 if (env->me_rmutex == SEM_FAILED) goto fail_errno;
4336 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
4337 if (env->me_wmutex == SEM_FAILED) goto fail_errno;
4348 /** The name of the lock file in the DB environment */
4349 #define LOCKNAME "/lock.mdb"
4350 /** The name of the data file in the DB environment */
4351 #define DATANAME "/data.mdb"
4352 /** The suffix of the lock file when no subdir is used */
4353 #define LOCKSUFF "-lock"
4354 /** Only a subset of the @ref mdb_env flags can be changed
4355 * at runtime. Changing other flags requires closing the
4356 * environment and re-opening it with the new flags.
4358 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC|MDB_MAPASYNC|MDB_NOMEMINIT)
4359 #define CHANGELESS (MDB_FIXEDMAP|MDB_NOSUBDIR|MDB_RDONLY|MDB_WRITEMAP| \
4360 MDB_NOTLS|MDB_NOLOCK|MDB_NORDAHEAD)
4362 #if VALID_FLAGS & PERSISTENT_FLAGS & (CHANGEABLE|CHANGELESS)
4363 # error "Persistent DB flags & env flags overlap, but both go in mm_flags"
4367 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
4369 int oflags, rc, len, excl = -1;
4370 char *lpath, *dpath;
4372 if (env->me_fd!=INVALID_HANDLE_VALUE || (flags & ~(CHANGEABLE|CHANGELESS)))
4376 if (flags & MDB_NOSUBDIR) {
4377 rc = len + sizeof(LOCKSUFF) + len + 1;
4379 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
4384 if (flags & MDB_NOSUBDIR) {
4385 dpath = lpath + len + sizeof(LOCKSUFF);
4386 sprintf(lpath, "%s" LOCKSUFF, path);
4387 strcpy(dpath, path);
4389 dpath = lpath + len + sizeof(LOCKNAME);
4390 sprintf(lpath, "%s" LOCKNAME, path);
4391 sprintf(dpath, "%s" DATANAME, path);
4395 flags |= env->me_flags;
4396 if (flags & MDB_RDONLY) {
4397 /* silently ignore WRITEMAP when we're only getting read access */
4398 flags &= ~MDB_WRITEMAP;
4400 if (!((env->me_free_pgs = mdb_midl_alloc(MDB_IDL_UM_MAX)) &&
4401 (env->me_dirty_list = calloc(MDB_IDL_UM_SIZE, sizeof(MDB_ID2)))))
4404 env->me_flags = flags |= MDB_ENV_ACTIVE;
4408 env->me_path = strdup(path);
4409 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
4410 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
4411 env->me_dbiseqs = calloc(env->me_maxdbs, sizeof(unsigned int));
4412 if (!(env->me_dbxs && env->me_path && env->me_dbflags && env->me_dbiseqs)) {
4417 /* For RDONLY, get lockfile after we know datafile exists */
4418 if (!(flags & (MDB_RDONLY|MDB_NOLOCK))) {
4419 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4425 if (F_ISSET(flags, MDB_RDONLY)) {
4426 oflags = GENERIC_READ;
4427 len = OPEN_EXISTING;
4429 oflags = GENERIC_READ|GENERIC_WRITE;
4432 mode = FILE_ATTRIBUTE_NORMAL;
4433 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
4434 NULL, len, mode, NULL);
4436 if (F_ISSET(flags, MDB_RDONLY))
4439 oflags = O_RDWR | O_CREAT;
4441 env->me_fd = open(dpath, oflags, mode);
4443 if (env->me_fd == INVALID_HANDLE_VALUE) {
4448 if ((flags & (MDB_RDONLY|MDB_NOLOCK)) == MDB_RDONLY) {
4449 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
4454 if ((rc = mdb_env_open2(env)) == MDB_SUCCESS) {
4455 if (flags & (MDB_RDONLY|MDB_WRITEMAP)) {
4456 env->me_mfd = env->me_fd;
4458 /* Synchronous fd for meta writes. Needed even with
4459 * MDB_NOSYNC/MDB_NOMETASYNC, in case these get reset.
4462 len = OPEN_EXISTING;
4463 env->me_mfd = CreateFile(dpath, oflags,
4464 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
4465 mode | FILE_FLAG_WRITE_THROUGH, NULL);
4468 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
4470 if (env->me_mfd == INVALID_HANDLE_VALUE) {
4475 DPRINTF(("opened dbenv %p", (void *) env));
4477 rc = mdb_env_share_locks(env, &excl);
4481 if (!((flags & MDB_RDONLY) ||
4482 (env->me_pbuf = calloc(1, env->me_psize))))
4488 mdb_env_close0(env, excl);
4494 /** Destroy resources from mdb_env_open(), clear our readers & DBIs */
4496 mdb_env_close0(MDB_env *env, int excl)
4500 if (!(env->me_flags & MDB_ENV_ACTIVE))
4503 /* Doing this here since me_dbxs may not exist during mdb_env_close */
4504 for (i = env->me_maxdbs; --i > MAIN_DBI; )
4505 free(env->me_dbxs[i].md_name.mv_data);
4508 free(env->me_dbiseqs);
4509 free(env->me_dbflags);
4512 free(env->me_dirty_list);
4513 mdb_midl_free(env->me_free_pgs);
4515 if (env->me_flags & MDB_ENV_TXKEY) {
4516 pthread_key_delete(env->me_txkey);
4518 /* Delete our key from the global list */
4519 for (i=0; i<mdb_tls_nkeys; i++)
4520 if (mdb_tls_keys[i] == env->me_txkey) {
4521 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
4529 munmap(env->me_map, env->me_mapsize);
4531 if (env->me_mfd != env->me_fd && env->me_mfd != INVALID_HANDLE_VALUE)
4532 (void) close(env->me_mfd);
4533 if (env->me_fd != INVALID_HANDLE_VALUE)
4534 (void) close(env->me_fd);
4536 MDB_PID_T pid = env->me_pid;
4537 /* Clearing readers is done in this function because
4538 * me_txkey with its destructor must be disabled first.
4540 for (i = env->me_numreaders; --i >= 0; )
4541 if (env->me_txns->mti_readers[i].mr_pid == pid)
4542 env->me_txns->mti_readers[i].mr_pid = 0;
4544 if (env->me_rmutex) {
4545 CloseHandle(env->me_rmutex);
4546 if (env->me_wmutex) CloseHandle(env->me_wmutex);
4548 /* Windows automatically destroys the mutexes when
4549 * the last handle closes.
4551 #elif defined(MDB_USE_POSIX_SEM)
4552 if (env->me_rmutex != SEM_FAILED) {
4553 sem_close(env->me_rmutex);
4554 if (env->me_wmutex != SEM_FAILED)
4555 sem_close(env->me_wmutex);
4556 /* If we have the filelock: If we are the
4557 * only remaining user, clean up semaphores.
4560 mdb_env_excl_lock(env, &excl);
4562 sem_unlink(env->me_txns->mti_rmname);
4563 sem_unlink(env->me_txns->mti_wmname);
4567 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
4569 if (env->me_lfd != INVALID_HANDLE_VALUE) {
4572 /* Unlock the lockfile. Windows would have unlocked it
4573 * after closing anyway, but not necessarily at once.
4575 UnlockFile(env->me_lfd, 0, 0, 1, 0);
4578 (void) close(env->me_lfd);
4581 env->me_flags &= ~(MDB_ENV_ACTIVE|MDB_ENV_TXKEY);
4586 mdb_env_close(MDB_env *env)
4593 VGMEMP_DESTROY(env);
4594 while ((dp = env->me_dpages) != NULL) {
4595 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
4596 env->me_dpages = dp->mp_next;
4600 mdb_env_close0(env, 0);
4604 /** Compare two items pointing at aligned size_t's */
4606 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
4608 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
4609 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
4612 /** Compare two items pointing at aligned unsigned int's */
4614 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
4616 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
4617 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
4620 /** Compare two items pointing at unsigned ints of unknown alignment.
4621 * Nodes and keys are guaranteed to be 2-byte aligned.
4624 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
4626 #if BYTE_ORDER == LITTLE_ENDIAN
4627 unsigned short *u, *c;
4630 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
4631 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
4634 } while(!x && u > (unsigned short *)a->mv_data);
4637 unsigned short *u, *c, *end;
4640 end = (unsigned short *) ((char *) a->mv_data + a->mv_size);
4641 u = (unsigned short *)a->mv_data;
4642 c = (unsigned short *)b->mv_data;
4645 } while(!x && u < end);
4650 /** Compare two items pointing at size_t's of unknown alignment. */
4651 #ifdef MISALIGNED_OK
4652 # define mdb_cmp_clong mdb_cmp_long
4654 # define mdb_cmp_clong mdb_cmp_cint
4657 /** Compare two items lexically */
4659 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
4666 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
4672 diff = memcmp(a->mv_data, b->mv_data, len);
4673 return diff ? diff : len_diff<0 ? -1 : len_diff;
4676 /** Compare two items in reverse byte order */
4678 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
4680 const unsigned char *p1, *p2, *p1_lim;
4684 p1_lim = (const unsigned char *)a->mv_data;
4685 p1 = (const unsigned char *)a->mv_data + a->mv_size;
4686 p2 = (const unsigned char *)b->mv_data + b->mv_size;
4688 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
4694 while (p1 > p1_lim) {
4695 diff = *--p1 - *--p2;
4699 return len_diff<0 ? -1 : len_diff;
4702 /** Search for key within a page, using binary search.
4703 * Returns the smallest entry larger or equal to the key.
4704 * If exactp is non-null, stores whether the found entry was an exact match
4705 * in *exactp (1 or 0).
4706 * Updates the cursor index with the index of the found entry.
4707 * If no entry larger or equal to the key is found, returns NULL.
4710 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
4712 unsigned int i = 0, nkeys;
4715 MDB_page *mp = mc->mc_pg[mc->mc_top];
4716 MDB_node *node = NULL;
4721 nkeys = NUMKEYS(mp);
4723 DPRINTF(("searching %u keys in %s %spage %"Z"u",
4724 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
4727 low = IS_LEAF(mp) ? 0 : 1;
4729 cmp = mc->mc_dbx->md_cmp;
4731 /* Branch pages have no data, so if using integer keys,
4732 * alignment is guaranteed. Use faster mdb_cmp_int.
4734 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
4735 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
4742 nodekey.mv_size = mc->mc_db->md_pad;
4743 node = NODEPTR(mp, 0); /* fake */
4744 while (low <= high) {
4745 i = (low + high) >> 1;
4746 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
4747 rc = cmp(key, &nodekey);
4748 DPRINTF(("found leaf index %u [%s], rc = %i",
4749 i, DKEY(&nodekey), rc));
4758 while (low <= high) {
4759 i = (low + high) >> 1;
4761 node = NODEPTR(mp, i);
4762 nodekey.mv_size = NODEKSZ(node);
4763 nodekey.mv_data = NODEKEY(node);
4765 rc = cmp(key, &nodekey);
4768 DPRINTF(("found leaf index %u [%s], rc = %i",
4769 i, DKEY(&nodekey), rc));
4771 DPRINTF(("found branch index %u [%s -> %"Z"u], rc = %i",
4772 i, DKEY(&nodekey), NODEPGNO(node), rc));
4783 if (rc > 0) { /* Found entry is less than the key. */
4784 i++; /* Skip to get the smallest entry larger than key. */
4786 node = NODEPTR(mp, i);
4789 *exactp = (rc == 0 && nkeys > 0);
4790 /* store the key index */
4791 mc->mc_ki[mc->mc_top] = i;
4793 /* There is no entry larger or equal to the key. */
4796 /* nodeptr is fake for LEAF2 */
4802 mdb_cursor_adjust(MDB_cursor *mc, func)
4806 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
4807 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
4814 /** Pop a page off the top of the cursor's stack. */
4816 mdb_cursor_pop(MDB_cursor *mc)
4820 MDB_page *top = mc->mc_pg[mc->mc_top];
4826 DPRINTF(("popped page %"Z"u off db %d cursor %p", top->mp_pgno,
4827 DDBI(mc), (void *) mc));
4831 /** Push a page onto the top of the cursor's stack. */
4833 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
4835 DPRINTF(("pushing page %"Z"u on db %d cursor %p", mp->mp_pgno,
4836 DDBI(mc), (void *) mc));
4838 if (mc->mc_snum >= CURSOR_STACK) {
4839 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
4840 return MDB_CURSOR_FULL;
4843 mc->mc_top = mc->mc_snum++;
4844 mc->mc_pg[mc->mc_top] = mp;
4845 mc->mc_ki[mc->mc_top] = 0;
4850 /** Find the address of the page corresponding to a given page number.
4851 * @param[in] txn the transaction for this access.
4852 * @param[in] pgno the page number for the page to retrieve.
4853 * @param[out] ret address of a pointer where the page's address will be stored.
4854 * @param[out] lvl dirty_list inheritance level of found page. 1=current txn, 0=mapped page.
4855 * @return 0 on success, non-zero on failure.
4858 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret, int *lvl)
4860 MDB_env *env = txn->mt_env;
4864 if (!((txn->mt_flags & MDB_TXN_RDONLY) | (env->me_flags & MDB_WRITEMAP))) {
4868 MDB_ID2L dl = tx2->mt_u.dirty_list;
4870 /* Spilled pages were dirtied in this txn and flushed
4871 * because the dirty list got full. Bring this page
4872 * back in from the map (but don't unspill it here,
4873 * leave that unless page_touch happens again).
4875 if (tx2->mt_spill_pgs) {
4876 MDB_ID pn = pgno << 1;
4877 x = mdb_midl_search(tx2->mt_spill_pgs, pn);
4878 if (x <= tx2->mt_spill_pgs[0] && tx2->mt_spill_pgs[x] == pn) {
4879 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
4884 unsigned x = mdb_mid2l_search(dl, pgno);
4885 if (x <= dl[0].mid && dl[x].mid == pgno) {
4891 } while ((tx2 = tx2->mt_parent) != NULL);
4894 if (pgno < txn->mt_next_pgno) {
4896 p = (MDB_page *)(env->me_map + env->me_psize * pgno);
4898 DPRINTF(("page %"Z"u not found", pgno));
4899 txn->mt_flags |= MDB_TXN_ERROR;
4900 return MDB_PAGE_NOTFOUND;
4910 /** Finish #mdb_page_search() / #mdb_page_search_lowest().
4911 * The cursor is at the root page, set up the rest of it.
4914 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int flags)
4916 MDB_page *mp = mc->mc_pg[mc->mc_top];
4920 while (IS_BRANCH(mp)) {
4924 DPRINTF(("branch page %"Z"u has %u keys", mp->mp_pgno, NUMKEYS(mp)));
4925 mdb_cassert(mc, NUMKEYS(mp) > 1);
4926 DPRINTF(("found index 0 to page %"Z"u", NODEPGNO(NODEPTR(mp, 0))));
4928 if (flags & (MDB_PS_FIRST|MDB_PS_LAST)) {
4930 if (flags & MDB_PS_LAST)
4931 i = NUMKEYS(mp) - 1;
4934 node = mdb_node_search(mc, key, &exact);
4936 i = NUMKEYS(mp) - 1;
4938 i = mc->mc_ki[mc->mc_top];
4940 mdb_cassert(mc, i > 0);
4944 DPRINTF(("following index %u for key [%s]", i, DKEY(key)));
4947 mdb_cassert(mc, i < NUMKEYS(mp));
4948 node = NODEPTR(mp, i);
4950 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
4953 mc->mc_ki[mc->mc_top] = i;
4954 if ((rc = mdb_cursor_push(mc, mp)))
4957 if (flags & MDB_PS_MODIFY) {
4958 if ((rc = mdb_page_touch(mc)) != 0)
4960 mp = mc->mc_pg[mc->mc_top];
4965 DPRINTF(("internal error, index points to a %02X page!?",
4967 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
4968 return MDB_CORRUPTED;
4971 DPRINTF(("found leaf page %"Z"u for key [%s]", mp->mp_pgno,
4972 key ? DKEY(key) : "null"));
4973 mc->mc_flags |= C_INITIALIZED;
4974 mc->mc_flags &= ~C_EOF;
4979 /** Search for the lowest key under the current branch page.
4980 * This just bypasses a NUMKEYS check in the current page
4981 * before calling mdb_page_search_root(), because the callers
4982 * are all in situations where the current page is known to
4986 mdb_page_search_lowest(MDB_cursor *mc)
4988 MDB_page *mp = mc->mc_pg[mc->mc_top];
4989 MDB_node *node = NODEPTR(mp, 0);
4992 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp, NULL)) != 0)
4995 mc->mc_ki[mc->mc_top] = 0;
4996 if ((rc = mdb_cursor_push(mc, mp)))
4998 return mdb_page_search_root(mc, NULL, MDB_PS_FIRST);
5001 /** Search for the page a given key should be in.
5002 * Push it and its parent pages on the cursor stack.
5003 * @param[in,out] mc the cursor for this operation.
5004 * @param[in] key the key to search for, or NULL for first/last page.
5005 * @param[in] flags If MDB_PS_MODIFY is set, visited pages in the DB
5006 * are touched (updated with new page numbers).
5007 * If MDB_PS_FIRST or MDB_PS_LAST is set, find first or last leaf.
5008 * This is used by #mdb_cursor_first() and #mdb_cursor_last().
5009 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
5010 * @return 0 on success, non-zero on failure.
5013 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
5018 /* Make sure the txn is still viable, then find the root from
5019 * the txn's db table and set it as the root of the cursor's stack.
5021 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
5022 DPUTS("transaction has failed, must abort");
5025 /* Make sure we're using an up-to-date root */
5026 if (*mc->mc_dbflag & DB_STALE) {
5028 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
5030 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
5031 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, 0);
5038 MDB_node *leaf = mdb_node_search(&mc2,
5039 &mc->mc_dbx->md_name, &exact);
5041 return MDB_NOTFOUND;
5042 rc = mdb_node_read(mc->mc_txn, leaf, &data);
5045 memcpy(&flags, ((char *) data.mv_data + offsetof(MDB_db, md_flags)),
5047 /* The txn may not know this DBI, or another process may
5048 * have dropped and recreated the DB with other flags.
5050 if ((mc->mc_db->md_flags & PERSISTENT_FLAGS) != flags)
5051 return MDB_INCOMPATIBLE;
5052 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
5054 *mc->mc_dbflag &= ~DB_STALE;
5056 root = mc->mc_db->md_root;
5058 if (root == P_INVALID) { /* Tree is empty. */
5059 DPUTS("tree is empty");
5060 return MDB_NOTFOUND;
5064 mdb_cassert(mc, root > 1);
5065 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
5066 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0], NULL)) != 0)
5072 DPRINTF(("db %d root page %"Z"u has flags 0x%X",
5073 DDBI(mc), root, mc->mc_pg[0]->mp_flags));
5075 if (flags & MDB_PS_MODIFY) {
5076 if ((rc = mdb_page_touch(mc)))
5080 if (flags & MDB_PS_ROOTONLY)
5083 return mdb_page_search_root(mc, key, flags);
5087 mdb_ovpage_free(MDB_cursor *mc, MDB_page *mp)
5089 MDB_txn *txn = mc->mc_txn;
5090 pgno_t pg = mp->mp_pgno;
5091 unsigned x = 0, ovpages = mp->mp_pages;
5092 MDB_env *env = txn->mt_env;
5093 MDB_IDL sl = txn->mt_spill_pgs;
5094 MDB_ID pn = pg << 1;
5097 DPRINTF(("free ov page %"Z"u (%d)", pg, ovpages));
5098 /* If the page is dirty or on the spill list we just acquired it,
5099 * so we should give it back to our current free list, if any.
5100 * Otherwise put it onto the list of pages we freed in this txn.
5102 * Won't create me_pghead: me_pglast must be inited along with it.
5103 * Unsupported in nested txns: They would need to hide the page
5104 * range in ancestor txns' dirty and spilled lists.
5106 if (env->me_pghead &&
5108 ((mp->mp_flags & P_DIRTY) ||
5109 (sl && (x = mdb_midl_search(sl, pn)) <= sl[0] && sl[x] == pn)))
5113 MDB_ID2 *dl, ix, iy;
5114 rc = mdb_midl_need(&env->me_pghead, ovpages);
5117 if (!(mp->mp_flags & P_DIRTY)) {
5118 /* This page is no longer spilled */
5125 /* Remove from dirty list */
5126 dl = txn->mt_u.dirty_list;
5128 for (ix = dl[x]; ix.mptr != mp; ix = iy) {
5134 mdb_cassert(mc, x > 1);
5136 dl[j] = ix; /* Unsorted. OK when MDB_TXN_ERROR. */
5137 txn->mt_flags |= MDB_TXN_ERROR;
5138 return MDB_CORRUPTED;
5141 if (!(env->me_flags & MDB_WRITEMAP))
5142 mdb_dpage_free(env, mp);
5144 /* Insert in me_pghead */
5145 mop = env->me_pghead;
5146 j = mop[0] + ovpages;
5147 for (i = mop[0]; i && mop[i] < pg; i--)
5153 rc = mdb_midl_append_range(&txn->mt_free_pgs, pg, ovpages);
5157 mc->mc_db->md_overflow_pages -= ovpages;
5161 /** Return the data associated with a given node.
5162 * @param[in] txn The transaction for this operation.
5163 * @param[in] leaf The node being read.
5164 * @param[out] data Updated to point to the node's data.
5165 * @return 0 on success, non-zero on failure.
5168 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
5170 MDB_page *omp; /* overflow page */
5174 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5175 data->mv_size = NODEDSZ(leaf);
5176 data->mv_data = NODEDATA(leaf);
5180 /* Read overflow data.
5182 data->mv_size = NODEDSZ(leaf);
5183 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
5184 if ((rc = mdb_page_get(txn, pgno, &omp, NULL)) != 0) {
5185 DPRINTF(("read overflow page %"Z"u failed", pgno));
5188 data->mv_data = METADATA(omp);
5194 mdb_get(MDB_txn *txn, MDB_dbi dbi,
5195 MDB_val *key, MDB_val *data)
5202 DPRINTF(("===> get db %u key [%s]", dbi, DKEY(key)));
5204 if (!key || !data || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
5207 if (txn->mt_flags & MDB_TXN_ERROR)
5210 mdb_cursor_init(&mc, txn, dbi, &mx);
5211 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
5214 /** Find a sibling for a page.
5215 * Replaces the page at the top of the cursor's stack with the
5216 * specified sibling, if one exists.
5217 * @param[in] mc The cursor for this operation.
5218 * @param[in] move_right Non-zero if the right sibling is requested,
5219 * otherwise the left sibling.
5220 * @return 0 on success, non-zero on failure.
5223 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
5229 if (mc->mc_snum < 2) {
5230 return MDB_NOTFOUND; /* root has no siblings */
5234 DPRINTF(("parent page is page %"Z"u, index %u",
5235 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]));
5237 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
5238 : (mc->mc_ki[mc->mc_top] == 0)) {
5239 DPRINTF(("no more keys left, moving to %s sibling",
5240 move_right ? "right" : "left"));
5241 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS) {
5242 /* undo cursor_pop before returning */
5249 mc->mc_ki[mc->mc_top]++;
5251 mc->mc_ki[mc->mc_top]--;
5252 DPRINTF(("just moving to %s index key %u",
5253 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]));
5255 mdb_cassert(mc, IS_BRANCH(mc->mc_pg[mc->mc_top]));
5257 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5258 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp, NULL)) != 0) {
5259 /* mc will be inconsistent if caller does mc_snum++ as above */
5260 mc->mc_flags &= ~(C_INITIALIZED|C_EOF);
5264 mdb_cursor_push(mc, mp);
5266 mc->mc_ki[mc->mc_top] = NUMKEYS(mp)-1;
5271 /** Move the cursor to the next data item. */
5273 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5279 if (mc->mc_flags & C_EOF) {
5280 return MDB_NOTFOUND;
5283 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5285 mp = mc->mc_pg[mc->mc_top];
5287 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5288 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5289 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5290 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
5291 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
5292 if (op != MDB_NEXT || rc != MDB_NOTFOUND) {
5293 if (rc == MDB_SUCCESS)
5294 MDB_GET_KEY(leaf, key);
5299 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5300 if (op == MDB_NEXT_DUP)
5301 return MDB_NOTFOUND;
5305 DPRINTF(("cursor_next: top page is %"Z"u in cursor %p",
5306 mdb_dbg_pgno(mp), (void *) mc));
5307 if (mc->mc_flags & C_DEL)
5310 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
5311 DPUTS("=====> move to next sibling page");
5312 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS) {
5313 mc->mc_flags |= C_EOF;
5316 mp = mc->mc_pg[mc->mc_top];
5317 DPRINTF(("next page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5319 mc->mc_ki[mc->mc_top]++;
5322 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5323 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5326 key->mv_size = mc->mc_db->md_pad;
5327 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5331 mdb_cassert(mc, IS_LEAF(mp));
5332 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5334 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5335 mdb_xcursor_init1(mc, leaf);
5338 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5341 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5342 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5343 if (rc != MDB_SUCCESS)
5348 MDB_GET_KEY(leaf, key);
5352 /** Move the cursor to the previous data item. */
5354 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
5360 mdb_cassert(mc, mc->mc_flags & C_INITIALIZED);
5362 mp = mc->mc_pg[mc->mc_top];
5364 if (mc->mc_db->md_flags & MDB_DUPSORT) {
5365 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5366 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5367 if (op == MDB_PREV || op == MDB_PREV_DUP) {
5368 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
5369 if (op != MDB_PREV || rc != MDB_NOTFOUND) {
5370 if (rc == MDB_SUCCESS)
5371 MDB_GET_KEY(leaf, key);
5375 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5376 if (op == MDB_PREV_DUP)
5377 return MDB_NOTFOUND;
5382 DPRINTF(("cursor_prev: top page is %"Z"u in cursor %p",
5383 mdb_dbg_pgno(mp), (void *) mc));
5385 if (mc->mc_ki[mc->mc_top] == 0) {
5386 DPUTS("=====> move to prev sibling page");
5387 if ((rc = mdb_cursor_sibling(mc, 0)) != MDB_SUCCESS) {
5390 mp = mc->mc_pg[mc->mc_top];
5391 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
5392 DPRINTF(("prev page is %"Z"u, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]));
5394 mc->mc_ki[mc->mc_top]--;
5396 mc->mc_flags &= ~C_EOF;
5398 DPRINTF(("==> cursor points to page %"Z"u with %u keys, key index %u",
5399 mdb_dbg_pgno(mp), NUMKEYS(mp), mc->mc_ki[mc->mc_top]));
5402 key->mv_size = mc->mc_db->md_pad;
5403 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5407 mdb_cassert(mc, IS_LEAF(mp));
5408 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5410 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5411 mdb_xcursor_init1(mc, leaf);
5414 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5417 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5418 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5419 if (rc != MDB_SUCCESS)
5424 MDB_GET_KEY(leaf, key);
5428 /** Set the cursor on a specific data item. */
5430 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5431 MDB_cursor_op op, int *exactp)
5435 MDB_node *leaf = NULL;
5438 if (key->mv_size == 0)
5439 return MDB_BAD_VALSIZE;
5442 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5444 /* See if we're already on the right page */
5445 if (mc->mc_flags & C_INITIALIZED) {
5448 mp = mc->mc_pg[mc->mc_top];
5450 mc->mc_ki[mc->mc_top] = 0;
5451 return MDB_NOTFOUND;
5453 if (mp->mp_flags & P_LEAF2) {
5454 nodekey.mv_size = mc->mc_db->md_pad;
5455 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
5457 leaf = NODEPTR(mp, 0);
5458 MDB_GET_KEY2(leaf, nodekey);
5460 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5462 /* Probably happens rarely, but first node on the page
5463 * was the one we wanted.
5465 mc->mc_ki[mc->mc_top] = 0;
5472 unsigned int nkeys = NUMKEYS(mp);
5474 if (mp->mp_flags & P_LEAF2) {
5475 nodekey.mv_data = LEAF2KEY(mp,
5476 nkeys-1, nodekey.mv_size);
5478 leaf = NODEPTR(mp, nkeys-1);
5479 MDB_GET_KEY2(leaf, nodekey);
5481 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5483 /* last node was the one we wanted */
5484 mc->mc_ki[mc->mc_top] = nkeys-1;
5490 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
5491 /* This is definitely the right page, skip search_page */
5492 if (mp->mp_flags & P_LEAF2) {
5493 nodekey.mv_data = LEAF2KEY(mp,
5494 mc->mc_ki[mc->mc_top], nodekey.mv_size);
5496 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5497 MDB_GET_KEY2(leaf, nodekey);
5499 rc = mc->mc_dbx->md_cmp(key, &nodekey);
5501 /* current node was the one we wanted */
5511 /* If any parents have right-sibs, search.
5512 * Otherwise, there's nothing further.
5514 for (i=0; i<mc->mc_top; i++)
5516 NUMKEYS(mc->mc_pg[i])-1)
5518 if (i == mc->mc_top) {
5519 /* There are no other pages */
5520 mc->mc_ki[mc->mc_top] = nkeys;
5521 return MDB_NOTFOUND;
5525 /* There are no other pages */
5526 mc->mc_ki[mc->mc_top] = 0;
5527 if (op == MDB_SET_RANGE && !exactp) {
5531 return MDB_NOTFOUND;
5535 rc = mdb_page_search(mc, key, 0);
5536 if (rc != MDB_SUCCESS)
5539 mp = mc->mc_pg[mc->mc_top];
5540 mdb_cassert(mc, IS_LEAF(mp));
5543 leaf = mdb_node_search(mc, key, exactp);
5544 if (exactp != NULL && !*exactp) {
5545 /* MDB_SET specified and not an exact match. */
5546 return MDB_NOTFOUND;
5550 DPUTS("===> inexact leaf not found, goto sibling");
5551 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
5552 return rc; /* no entries matched */
5553 mp = mc->mc_pg[mc->mc_top];
5554 mdb_cassert(mc, IS_LEAF(mp));
5555 leaf = NODEPTR(mp, 0);
5559 mc->mc_flags |= C_INITIALIZED;
5560 mc->mc_flags &= ~C_EOF;
5563 if (op == MDB_SET_RANGE || op == MDB_SET_KEY) {
5564 key->mv_size = mc->mc_db->md_pad;
5565 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5570 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5571 mdb_xcursor_init1(mc, leaf);
5574 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5575 if (op == MDB_SET || op == MDB_SET_KEY || op == MDB_SET_RANGE) {
5576 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5579 if (op == MDB_GET_BOTH) {
5585 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
5586 if (rc != MDB_SUCCESS)
5589 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
5591 if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
5593 rc = mc->mc_dbx->md_dcmp(data, &d2);
5595 if (op == MDB_GET_BOTH || rc > 0)
5596 return MDB_NOTFOUND;
5603 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5604 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5609 /* The key already matches in all other cases */
5610 if (op == MDB_SET_RANGE || op == MDB_SET_KEY)
5611 MDB_GET_KEY(leaf, key);
5612 DPRINTF(("==> cursor placed on key [%s]", DKEY(key)));
5617 /** Move the cursor to the first item in the database. */
5619 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
5625 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5627 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
5628 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
5629 if (rc != MDB_SUCCESS)
5632 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
5634 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
5635 mc->mc_flags |= C_INITIALIZED;
5636 mc->mc_flags &= ~C_EOF;
5638 mc->mc_ki[mc->mc_top] = 0;
5640 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5641 key->mv_size = mc->mc_db->md_pad;
5642 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
5647 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5648 mdb_xcursor_init1(mc, leaf);
5649 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
5653 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5657 MDB_GET_KEY(leaf, key);
5661 /** Move the cursor to the last item in the database. */
5663 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
5669 mc->mc_xcursor->mx_cursor.mc_flags &= ~(C_INITIALIZED|C_EOF);
5671 if (!(mc->mc_flags & C_EOF)) {
5673 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
5674 rc = mdb_page_search(mc, NULL, MDB_PS_LAST);
5675 if (rc != MDB_SUCCESS)
5678 mdb_cassert(mc, IS_LEAF(mc->mc_pg[mc->mc_top]));
5681 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
5682 mc->mc_flags |= C_INITIALIZED|C_EOF;
5683 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5685 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
5686 key->mv_size = mc->mc_db->md_pad;
5687 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
5692 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5693 mdb_xcursor_init1(mc, leaf);
5694 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
5698 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
5703 MDB_GET_KEY(leaf, key);
5708 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5713 int (*mfunc)(MDB_cursor *mc, MDB_val *key, MDB_val *data);
5718 if (mc->mc_txn->mt_flags & MDB_TXN_ERROR)
5722 case MDB_GET_CURRENT:
5723 if (!(mc->mc_flags & C_INITIALIZED)) {
5726 MDB_page *mp = mc->mc_pg[mc->mc_top];
5727 int nkeys = NUMKEYS(mp);
5728 if (!nkeys || mc->mc_ki[mc->mc_top] >= nkeys) {
5729 mc->mc_ki[mc->mc_top] = nkeys;
5735 key->mv_size = mc->mc_db->md_pad;
5736 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
5738 MDB_node *leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5739 MDB_GET_KEY(leaf, key);
5741 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5742 if (mc->mc_flags & C_DEL)
5743 mdb_xcursor_init1(mc, leaf);
5744 rc = mdb_cursor_get(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_GET_CURRENT);
5746 rc = mdb_node_read(mc->mc_txn, leaf, data);
5753 case MDB_GET_BOTH_RANGE:
5758 if (mc->mc_xcursor == NULL) {
5759 rc = MDB_INCOMPATIBLE;
5769 rc = mdb_cursor_set(mc, key, data, op,
5770 op == MDB_SET_RANGE ? NULL : &exact);
5773 case MDB_GET_MULTIPLE:
5774 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
5778 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
5779 rc = MDB_INCOMPATIBLE;
5783 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
5784 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
5787 case MDB_NEXT_MULTIPLE:
5792 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
5793 rc = MDB_INCOMPATIBLE;
5796 if (!(mc->mc_flags & C_INITIALIZED))
5797 rc = mdb_cursor_first(mc, key, data);
5799 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
5800 if (rc == MDB_SUCCESS) {
5801 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
5804 mx = &mc->mc_xcursor->mx_cursor;
5805 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
5807 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
5808 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
5816 case MDB_NEXT_NODUP:
5817 if (!(mc->mc_flags & C_INITIALIZED))
5818 rc = mdb_cursor_first(mc, key, data);
5820 rc = mdb_cursor_next(mc, key, data, op);
5824 case MDB_PREV_NODUP:
5825 if (!(mc->mc_flags & C_INITIALIZED)) {
5826 rc = mdb_cursor_last(mc, key, data);
5829 mc->mc_flags |= C_INITIALIZED;
5830 mc->mc_ki[mc->mc_top]++;
5832 rc = mdb_cursor_prev(mc, key, data, op);
5835 rc = mdb_cursor_first(mc, key, data);
5838 mfunc = mdb_cursor_first;
5840 if (data == NULL || !(mc->mc_flags & C_INITIALIZED)) {
5844 if (mc->mc_xcursor == NULL) {
5845 rc = MDB_INCOMPATIBLE;
5848 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
5852 rc = mfunc(&mc->mc_xcursor->mx_cursor, data, NULL);
5855 rc = mdb_cursor_last(mc, key, data);
5858 mfunc = mdb_cursor_last;
5861 DPRINTF(("unhandled/unimplemented cursor operation %u", op));
5866 if (mc->mc_flags & C_DEL)
5867 mc->mc_flags ^= C_DEL;
5872 /** Touch all the pages in the cursor stack. Set mc_top.
5873 * Makes sure all the pages are writable, before attempting a write operation.
5874 * @param[in] mc The cursor to operate on.
5877 mdb_cursor_touch(MDB_cursor *mc)
5879 int rc = MDB_SUCCESS;
5881 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
5884 if (TXN_DBI_CHANGED(mc->mc_txn, mc->mc_dbi))
5886 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, &mcx);
5887 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
5890 *mc->mc_dbflag |= DB_DIRTY;
5895 rc = mdb_page_touch(mc);
5896 } while (!rc && ++(mc->mc_top) < mc->mc_snum);
5897 mc->mc_top = mc->mc_snum-1;
5902 /** Do not spill pages to disk if txn is getting full, may fail instead */
5903 #define MDB_NOSPILL 0x8000
5906 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
5909 enum { MDB_NO_ROOT = MDB_LAST_ERRCODE+10 }; /* internal code */
5911 MDB_node *leaf = NULL;
5914 MDB_val xdata, *rdata, dkey, olddata;
5916 int do_sub = 0, insert_key, insert_data;
5917 unsigned int mcount = 0, dcount = 0, nospill;
5920 unsigned int nflags;
5923 if (mc == NULL || key == NULL)
5926 env = mc->mc_txn->mt_env;
5928 /* Check this first so counter will always be zero on any
5931 if (flags & MDB_MULTIPLE) {
5932 dcount = data[1].mv_size;
5933 data[1].mv_size = 0;
5934 if (!F_ISSET(mc->mc_db->md_flags, MDB_DUPFIXED))
5935 return MDB_INCOMPATIBLE;
5938 nospill = flags & MDB_NOSPILL;
5939 flags &= ~MDB_NOSPILL;
5941 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
5942 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
5944 if (key->mv_size-1 >= ENV_MAXKEY(env))
5945 return MDB_BAD_VALSIZE;
5947 #if SIZE_MAX > MAXDATASIZE
5948 if (data->mv_size > ((mc->mc_db->md_flags & MDB_DUPSORT) ? ENV_MAXKEY(env) : MAXDATASIZE))
5949 return MDB_BAD_VALSIZE;
5951 if ((mc->mc_db->md_flags & MDB_DUPSORT) && data->mv_size > ENV_MAXKEY(env))
5952 return MDB_BAD_VALSIZE;
5955 DPRINTF(("==> put db %d key [%s], size %"Z"u, data size %"Z"u",
5956 DDBI(mc), DKEY(key), key ? key->mv_size : 0, data->mv_size));
5960 if (flags == MDB_CURRENT) {
5961 if (!(mc->mc_flags & C_INITIALIZED))
5964 } else if (mc->mc_db->md_root == P_INVALID) {
5965 /* new database, cursor has nothing to point to */
5968 mc->mc_flags &= ~C_INITIALIZED;
5973 if (flags & MDB_APPEND) {
5975 rc = mdb_cursor_last(mc, &k2, &d2);
5977 rc = mc->mc_dbx->md_cmp(key, &k2);
5980 mc->mc_ki[mc->mc_top]++;
5982 /* new key is <= last key */
5987 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
5989 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
5990 DPRINTF(("duplicate key [%s]", DKEY(key)));
5992 return MDB_KEYEXIST;
5994 if (rc && rc != MDB_NOTFOUND)
5998 if (mc->mc_flags & C_DEL)
5999 mc->mc_flags ^= C_DEL;
6001 /* Cursor is positioned, check for room in the dirty list */
6003 if (flags & MDB_MULTIPLE) {
6005 xdata.mv_size = data->mv_size * dcount;
6009 if ((rc2 = mdb_page_spill(mc, key, rdata)))
6013 if (rc == MDB_NO_ROOT) {
6015 /* new database, write a root leaf page */
6016 DPUTS("allocating new root leaf page");
6017 if ((rc2 = mdb_page_new(mc, P_LEAF, 1, &np))) {
6020 mdb_cursor_push(mc, np);
6021 mc->mc_db->md_root = np->mp_pgno;
6022 mc->mc_db->md_depth++;
6023 *mc->mc_dbflag |= DB_DIRTY;
6024 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
6026 np->mp_flags |= P_LEAF2;
6027 mc->mc_flags |= C_INITIALIZED;
6029 /* make sure all cursor pages are writable */
6030 rc2 = mdb_cursor_touch(mc);
6035 insert_key = insert_data = rc;
6037 /* The key does not exist */
6038 DPRINTF(("inserting key at index %i", mc->mc_ki[mc->mc_top]));
6039 if ((mc->mc_db->md_flags & MDB_DUPSORT) &&
6040 LEAFSIZE(key, data) > env->me_nodemax)
6042 /* Too big for a node, insert in sub-DB. Set up an empty
6043 * "old sub-page" for prep_subDB to expand to a full page.
6045 fp_flags = P_LEAF|P_DIRTY;
6047 fp->mp_pad = data->mv_size; /* used if MDB_DUPFIXED */
6048 fp->mp_lower = fp->mp_upper = (PAGEHDRSZ-PAGEBASE);
6049 olddata.mv_size = PAGEHDRSZ;
6053 /* there's only a key anyway, so this is a no-op */
6054 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
6056 unsigned int ksize = mc->mc_db->md_pad;
6057 if (key->mv_size != ksize)
6058 return MDB_BAD_VALSIZE;
6059 ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
6060 memcpy(ptr, key->mv_data, ksize);
6065 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6066 olddata.mv_size = NODEDSZ(leaf);
6067 olddata.mv_data = NODEDATA(leaf);
6070 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
6071 /* Prepare (sub-)page/sub-DB to accept the new item,
6072 * if needed. fp: old sub-page or a header faking
6073 * it. mp: new (sub-)page. offset: growth in page
6074 * size. xdata: node data with new page or DB.
6076 unsigned i, offset = 0;
6077 mp = fp = xdata.mv_data = env->me_pbuf;
6078 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
6080 /* Was a single item before, must convert now */
6081 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6082 /* Just overwrite the current item */
6083 if (flags == MDB_CURRENT)
6086 #if UINT_MAX < SIZE_MAX
6087 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && olddata.mv_size == sizeof(size_t))
6088 mc->mc_dbx->md_dcmp = mdb_cmp_clong;
6090 /* does data match? */
6091 if (!mc->mc_dbx->md_dcmp(data, &olddata)) {
6092 if (flags & MDB_NODUPDATA)
6093 return MDB_KEYEXIST;
6098 /* Back up original data item */
6099 dkey.mv_size = olddata.mv_size;
6100 dkey.mv_data = memcpy(fp+1, olddata.mv_data, olddata.mv_size);
6102 /* Make sub-page header for the dup items, with dummy body */
6103 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
6104 fp->mp_lower = (PAGEHDRSZ-PAGEBASE);
6105 xdata.mv_size = PAGEHDRSZ + dkey.mv_size + data->mv_size;
6106 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6107 fp->mp_flags |= P_LEAF2;
6108 fp->mp_pad = data->mv_size;
6109 xdata.mv_size += 2 * data->mv_size; /* leave space for 2 more */
6111 xdata.mv_size += 2 * (sizeof(indx_t) + NODESIZE) +
6112 (dkey.mv_size & 1) + (data->mv_size & 1);
6114 fp->mp_upper = xdata.mv_size - PAGEBASE;
6115 olddata.mv_size = xdata.mv_size; /* pretend olddata is fp */
6116 } else if (leaf->mn_flags & F_SUBDATA) {
6117 /* Data is on sub-DB, just store it */
6118 flags |= F_DUPDATA|F_SUBDATA;
6121 /* Data is on sub-page */
6122 fp = olddata.mv_data;
6125 if (!(mc->mc_db->md_flags & MDB_DUPFIXED)) {
6126 offset = EVEN(NODESIZE + sizeof(indx_t) +
6130 offset = fp->mp_pad;
6131 if (SIZELEFT(fp) < offset) {
6132 offset *= 4; /* space for 4 more */
6135 /* FALLTHRU: Big enough MDB_DUPFIXED sub-page */
6137 fp->mp_flags |= P_DIRTY;
6138 COPY_PGNO(fp->mp_pgno, mp->mp_pgno);
6139 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
6143 xdata.mv_size = olddata.mv_size + offset;
6146 fp_flags = fp->mp_flags;
6147 if (NODESIZE + NODEKSZ(leaf) + xdata.mv_size > env->me_nodemax) {
6148 /* Too big for a sub-page, convert to sub-DB */
6149 fp_flags &= ~P_SUBP;
6151 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6152 fp_flags |= P_LEAF2;
6153 dummy.md_pad = fp->mp_pad;
6154 dummy.md_flags = MDB_DUPFIXED;
6155 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
6156 dummy.md_flags |= MDB_INTEGERKEY;
6162 dummy.md_branch_pages = 0;
6163 dummy.md_leaf_pages = 1;
6164 dummy.md_overflow_pages = 0;
6165 dummy.md_entries = NUMKEYS(fp);
6166 xdata.mv_size = sizeof(MDB_db);
6167 xdata.mv_data = &dummy;
6168 if ((rc = mdb_page_alloc(mc, 1, &mp)))
6170 offset = env->me_psize - olddata.mv_size;
6171 flags |= F_DUPDATA|F_SUBDATA;
6172 dummy.md_root = mp->mp_pgno;
6175 mp->mp_flags = fp_flags | P_DIRTY;
6176 mp->mp_pad = fp->mp_pad;
6177 mp->mp_lower = fp->mp_lower;
6178 mp->mp_upper = fp->mp_upper + offset;
6179 if (fp_flags & P_LEAF2) {
6180 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
6182 memcpy((char *)mp + mp->mp_upper + PAGEBASE, (char *)fp + fp->mp_upper + PAGEBASE,
6183 olddata.mv_size - fp->mp_upper - PAGEBASE);
6184 for (i=0; i<NUMKEYS(fp); i++)
6185 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
6193 mdb_node_del(mc, 0);
6197 /* overflow page overwrites need special handling */
6198 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6201 int level, ovpages, dpages = OVPAGES(data->mv_size, env->me_psize);
6203 memcpy(&pg, olddata.mv_data, sizeof(pg));
6204 if ((rc2 = mdb_page_get(mc->mc_txn, pg, &omp, &level)) != 0)
6206 ovpages = omp->mp_pages;
6208 /* Is the ov page large enough? */
6209 if (ovpages >= dpages) {
6210 if (!(omp->mp_flags & P_DIRTY) &&
6211 (level || (env->me_flags & MDB_WRITEMAP)))
6213 rc = mdb_page_unspill(mc->mc_txn, omp, &omp);
6216 level = 0; /* dirty in this txn or clean */
6219 if (omp->mp_flags & P_DIRTY) {
6220 /* yes, overwrite it. Note in this case we don't
6221 * bother to try shrinking the page if the new data
6222 * is smaller than the overflow threshold.
6225 /* It is writable only in a parent txn */
6226 size_t sz = (size_t) env->me_psize * ovpages, off;
6227 MDB_page *np = mdb_page_malloc(mc->mc_txn, ovpages);
6233 rc2 = mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &id2);
6234 mdb_cassert(mc, rc2 == 0);
6235 if (!(flags & MDB_RESERVE)) {
6236 /* Copy end of page, adjusting alignment so
6237 * compiler may copy words instead of bytes.
6239 off = (PAGEHDRSZ + data->mv_size) & -sizeof(size_t);
6240 memcpy((size_t *)((char *)np + off),
6241 (size_t *)((char *)omp + off), sz - off);
6244 memcpy(np, omp, sz); /* Copy beginning of page */
6247 SETDSZ(leaf, data->mv_size);
6248 if (F_ISSET(flags, MDB_RESERVE))
6249 data->mv_data = METADATA(omp);
6251 memcpy(METADATA(omp), data->mv_data, data->mv_size);
6255 if ((rc2 = mdb_ovpage_free(mc, omp)) != MDB_SUCCESS)
6257 } else if (data->mv_size == olddata.mv_size) {
6258 /* same size, just replace it. Note that we could
6259 * also reuse this node if the new data is smaller,
6260 * but instead we opt to shrink the node in that case.
6262 if (F_ISSET(flags, MDB_RESERVE))
6263 data->mv_data = olddata.mv_data;
6264 else if (!(mc->mc_flags & C_SUB))
6265 memcpy(olddata.mv_data, data->mv_data, data->mv_size);
6267 memcpy(NODEKEY(leaf), key->mv_data, key->mv_size);
6270 mdb_node_del(mc, 0);
6276 nflags = flags & NODE_ADD_FLAGS;
6277 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(env, key, rdata);
6278 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
6279 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
6280 nflags &= ~MDB_APPEND; /* sub-page may need room to grow */
6282 nflags |= MDB_SPLIT_REPLACE;
6283 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
6285 /* There is room already in this leaf page. */
6286 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
6287 if (rc == 0 && insert_key) {
6288 /* Adjust other cursors pointing to mp */
6289 MDB_cursor *m2, *m3;
6290 MDB_dbi dbi = mc->mc_dbi;
6291 unsigned i = mc->mc_top;
6292 MDB_page *mp = mc->mc_pg[i];
6294 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6295 if (mc->mc_flags & C_SUB)
6296 m3 = &m2->mc_xcursor->mx_cursor;
6299 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
6300 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
6307 if (rc == MDB_SUCCESS) {
6308 /* Now store the actual data in the child DB. Note that we're
6309 * storing the user data in the keys field, so there are strict
6310 * size limits on dupdata. The actual data fields of the child
6311 * DB are all zero size.
6319 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6320 if (flags & MDB_CURRENT) {
6321 xflags = MDB_CURRENT|MDB_NOSPILL;
6323 mdb_xcursor_init1(mc, leaf);
6324 xflags = (flags & MDB_NODUPDATA) ?
6325 MDB_NOOVERWRITE|MDB_NOSPILL : MDB_NOSPILL;
6327 /* converted, write the original data first */
6329 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
6333 /* Adjust other cursors pointing to mp */
6335 unsigned i = mc->mc_top;
6336 MDB_page *mp = mc->mc_pg[i];
6338 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6339 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6340 if (!(m2->mc_flags & C_INITIALIZED)) continue;
6341 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
6342 mdb_xcursor_init1(m2, leaf);
6346 /* we've done our job */
6349 ecount = mc->mc_xcursor->mx_db.md_entries;
6350 if (flags & MDB_APPENDDUP)
6351 xflags |= MDB_APPEND;
6352 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
6353 if (flags & F_SUBDATA) {
6354 void *db = NODEDATA(leaf);
6355 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6357 insert_data = mc->mc_xcursor->mx_db.md_entries - ecount;
6359 /* Increment count unless we just replaced an existing item. */
6361 mc->mc_db->md_entries++;
6363 /* Invalidate txn if we created an empty sub-DB */
6366 /* If we succeeded and the key didn't exist before,
6367 * make sure the cursor is marked valid.
6369 mc->mc_flags |= C_INITIALIZED;
6371 if (flags & MDB_MULTIPLE) {
6374 /* let caller know how many succeeded, if any */
6375 data[1].mv_size = mcount;
6376 if (mcount < dcount) {
6377 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
6378 insert_key = insert_data = 0;
6385 if (rc == MDB_KEYEXIST) /* should not happen, we deleted that item */
6388 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6393 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
6399 if (mc->mc_txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
6400 return (mc->mc_txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
6402 if (!(mc->mc_flags & C_INITIALIZED))
6405 if (mc->mc_ki[mc->mc_top] >= NUMKEYS(mc->mc_pg[mc->mc_top]))
6406 return MDB_NOTFOUND;
6408 if (!(flags & MDB_NOSPILL) && (rc = mdb_page_spill(mc, NULL, NULL)))
6411 rc = mdb_cursor_touch(mc);
6415 mp = mc->mc_pg[mc->mc_top];
6418 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6420 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6421 if (flags & MDB_NODUPDATA) {
6422 /* mdb_cursor_del0() will subtract the final entry */
6423 mc->mc_db->md_entries -= mc->mc_xcursor->mx_db.md_entries - 1;
6425 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
6426 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6428 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, MDB_NOSPILL);
6431 /* If sub-DB still has entries, we're done */
6432 if (mc->mc_xcursor->mx_db.md_entries) {
6433 if (leaf->mn_flags & F_SUBDATA) {
6434 /* update subDB info */
6435 void *db = NODEDATA(leaf);
6436 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
6439 /* shrink fake page */
6440 mdb_node_shrink(mp, mc->mc_ki[mc->mc_top]);
6441 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6442 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6443 /* fix other sub-DB cursors pointed at this fake page */
6444 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
6445 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
6446 if (m2->mc_pg[mc->mc_top] == mp &&
6447 m2->mc_ki[mc->mc_top] == mc->mc_ki[mc->mc_top])
6448 m2->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
6451 mc->mc_db->md_entries--;
6452 mc->mc_flags |= C_DEL;
6455 /* otherwise fall thru and delete the sub-DB */
6458 if (leaf->mn_flags & F_SUBDATA) {
6459 /* add all the child DB's pages to the free list */
6460 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
6466 /* add overflow pages to free list */
6467 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
6471 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
6472 if ((rc = mdb_page_get(mc->mc_txn, pg, &omp, NULL)) ||
6473 (rc = mdb_ovpage_free(mc, omp)))
6478 return mdb_cursor_del0(mc);
6481 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6485 /** Allocate and initialize new pages for a database.
6486 * @param[in] mc a cursor on the database being added to.
6487 * @param[in] flags flags defining what type of page is being allocated.
6488 * @param[in] num the number of pages to allocate. This is usually 1,
6489 * unless allocating overflow pages for a large record.
6490 * @param[out] mp Address of a page, or NULL on failure.
6491 * @return 0 on success, non-zero on failure.
6494 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num, MDB_page **mp)
6499 if ((rc = mdb_page_alloc(mc, num, &np)))
6501 DPRINTF(("allocated new mpage %"Z"u, page size %u",
6502 np->mp_pgno, mc->mc_txn->mt_env->me_psize));
6503 np->mp_flags = flags | P_DIRTY;
6504 np->mp_lower = (PAGEHDRSZ-PAGEBASE);
6505 np->mp_upper = mc->mc_txn->mt_env->me_psize - PAGEBASE;
6508 mc->mc_db->md_branch_pages++;
6509 else if (IS_LEAF(np))
6510 mc->mc_db->md_leaf_pages++;
6511 else if (IS_OVERFLOW(np)) {
6512 mc->mc_db->md_overflow_pages += num;
6520 /** Calculate the size of a leaf node.
6521 * The size depends on the environment's page size; if a data item
6522 * is too large it will be put onto an overflow page and the node
6523 * size will only include the key and not the data. Sizes are always
6524 * rounded up to an even number of bytes, to guarantee 2-byte alignment
6525 * of the #MDB_node headers.
6526 * @param[in] env The environment handle.
6527 * @param[in] key The key for the node.
6528 * @param[in] data The data for the node.
6529 * @return The number of bytes needed to store the node.
6532 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
6536 sz = LEAFSIZE(key, data);
6537 if (sz > env->me_nodemax) {
6538 /* put on overflow page */
6539 sz -= data->mv_size - sizeof(pgno_t);
6542 return EVEN(sz + sizeof(indx_t));
6545 /** Calculate the size of a branch node.
6546 * The size should depend on the environment's page size but since
6547 * we currently don't support spilling large keys onto overflow
6548 * pages, it's simply the size of the #MDB_node header plus the
6549 * size of the key. Sizes are always rounded up to an even number
6550 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
6551 * @param[in] env The environment handle.
6552 * @param[in] key The key for the node.
6553 * @return The number of bytes needed to store the node.
6556 mdb_branch_size(MDB_env *env, MDB_val *key)
6561 if (sz > env->me_nodemax) {
6562 /* put on overflow page */
6563 /* not implemented */
6564 /* sz -= key->size - sizeof(pgno_t); */
6567 return sz + sizeof(indx_t);
6570 /** Add a node to the page pointed to by the cursor.
6571 * @param[in] mc The cursor for this operation.
6572 * @param[in] indx The index on the page where the new node should be added.
6573 * @param[in] key The key for the new node.
6574 * @param[in] data The data for the new node, if any.
6575 * @param[in] pgno The page number, if adding a branch node.
6576 * @param[in] flags Flags for the node.
6577 * @return 0 on success, non-zero on failure. Possible errors are:
6579 * <li>ENOMEM - failed to allocate overflow pages for the node.
6580 * <li>MDB_PAGE_FULL - there is insufficient room in the page. This error
6581 * should never happen since all callers already calculate the
6582 * page's free space before calling this function.
6586 mdb_node_add(MDB_cursor *mc, indx_t indx,
6587 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
6590 size_t node_size = NODESIZE;
6594 MDB_page *mp = mc->mc_pg[mc->mc_top];
6595 MDB_page *ofp = NULL; /* overflow page */
6598 mdb_cassert(mc, mp->mp_upper >= mp->mp_lower);
6600 DPRINTF(("add to %s %spage %"Z"u index %i, data size %"Z"u key size %"Z"u [%s]",
6601 IS_LEAF(mp) ? "leaf" : "branch",
6602 IS_SUBP(mp) ? "sub-" : "",
6603 mdb_dbg_pgno(mp), indx, data ? data->mv_size : 0,
6604 key ? key->mv_size : 0, key ? DKEY(key) : "null"));
6607 /* Move higher keys up one slot. */
6608 int ksize = mc->mc_db->md_pad, dif;
6609 char *ptr = LEAF2KEY(mp, indx, ksize);
6610 dif = NUMKEYS(mp) - indx;
6612 memmove(ptr+ksize, ptr, dif*ksize);
6613 /* insert new key */
6614 memcpy(ptr, key->mv_data, ksize);
6616 /* Just using these for counting */
6617 mp->mp_lower += sizeof(indx_t);
6618 mp->mp_upper -= ksize - sizeof(indx_t);
6622 room = (ssize_t)SIZELEFT(mp) - (ssize_t)sizeof(indx_t);
6624 node_size += key->mv_size;
6626 mdb_cassert(mc, data);
6627 if (F_ISSET(flags, F_BIGDATA)) {
6628 /* Data already on overflow page. */
6629 node_size += sizeof(pgno_t);
6630 } else if (node_size + data->mv_size > mc->mc_txn->mt_env->me_nodemax) {
6631 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
6633 /* Put data on overflow page. */
6634 DPRINTF(("data size is %"Z"u, node would be %"Z"u, put data on overflow page",
6635 data->mv_size, node_size+data->mv_size));
6636 node_size = EVEN(node_size + sizeof(pgno_t));
6637 if ((ssize_t)node_size > room)
6639 if ((rc = mdb_page_new(mc, P_OVERFLOW, ovpages, &ofp)))
6641 DPRINTF(("allocated overflow page %"Z"u", ofp->mp_pgno));
6645 node_size += data->mv_size;
6648 node_size = EVEN(node_size);
6649 if ((ssize_t)node_size > room)
6653 /* Move higher pointers up one slot. */
6654 for (i = NUMKEYS(mp); i > indx; i--)
6655 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
6657 /* Adjust free space offsets. */
6658 ofs = mp->mp_upper - node_size;
6659 mdb_cassert(mc, ofs >= mp->mp_lower + sizeof(indx_t));
6660 mp->mp_ptrs[indx] = ofs;
6662 mp->mp_lower += sizeof(indx_t);
6664 /* Write the node data. */
6665 node = NODEPTR(mp, indx);
6666 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
6667 node->mn_flags = flags;
6669 SETDSZ(node,data->mv_size);
6674 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
6677 mdb_cassert(mc, key);
6679 if (F_ISSET(flags, F_BIGDATA))
6680 memcpy(node->mn_data + key->mv_size, data->mv_data,
6682 else if (F_ISSET(flags, MDB_RESERVE))
6683 data->mv_data = node->mn_data + key->mv_size;
6685 memcpy(node->mn_data + key->mv_size, data->mv_data,
6688 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
6690 if (F_ISSET(flags, MDB_RESERVE))
6691 data->mv_data = METADATA(ofp);
6693 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
6700 DPRINTF(("not enough room in page %"Z"u, got %u ptrs",
6701 mdb_dbg_pgno(mp), NUMKEYS(mp)));
6702 DPRINTF(("upper-lower = %u - %u = %"Z"d", mp->mp_upper,mp->mp_lower,room));
6703 DPRINTF(("node size = %"Z"u", node_size));
6704 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
6705 return MDB_PAGE_FULL;
6708 /** Delete the specified node from a page.
6709 * @param[in] mc Cursor pointing to the node to delete.
6710 * @param[in] ksize The size of a node. Only used if the page is
6711 * part of a #MDB_DUPFIXED database.
6714 mdb_node_del(MDB_cursor *mc, int ksize)
6716 MDB_page *mp = mc->mc_pg[mc->mc_top];
6717 indx_t indx = mc->mc_ki[mc->mc_top];
6719 indx_t i, j, numkeys, ptr;
6723 DPRINTF(("delete node %u on %s page %"Z"u", indx,
6724 IS_LEAF(mp) ? "leaf" : "branch", mdb_dbg_pgno(mp)));
6725 numkeys = NUMKEYS(mp);
6726 mdb_cassert(mc, indx < numkeys);
6729 int x = numkeys - 1 - indx;
6730 base = LEAF2KEY(mp, indx, ksize);
6732 memmove(base, base + ksize, x * ksize);
6733 mp->mp_lower -= sizeof(indx_t);
6734 mp->mp_upper += ksize - sizeof(indx_t);
6738 node = NODEPTR(mp, indx);
6739 sz = NODESIZE + node->mn_ksize;
6741 if (F_ISSET(node->mn_flags, F_BIGDATA))
6742 sz += sizeof(pgno_t);
6744 sz += NODEDSZ(node);
6748 ptr = mp->mp_ptrs[indx];
6749 for (i = j = 0; i < numkeys; i++) {
6751 mp->mp_ptrs[j] = mp->mp_ptrs[i];
6752 if (mp->mp_ptrs[i] < ptr)
6753 mp->mp_ptrs[j] += sz;
6758 base = (char *)mp + mp->mp_upper + PAGEBASE;
6759 memmove(base + sz, base, ptr - mp->mp_upper);
6761 mp->mp_lower -= sizeof(indx_t);
6765 /** Compact the main page after deleting a node on a subpage.
6766 * @param[in] mp The main page to operate on.
6767 * @param[in] indx The index of the subpage on the main page.
6770 mdb_node_shrink(MDB_page *mp, indx_t indx)
6776 indx_t i, numkeys, ptr;
6778 node = NODEPTR(mp, indx);
6779 sp = (MDB_page *)NODEDATA(node);
6780 delta = SIZELEFT(sp);
6781 xp = (MDB_page *)((char *)sp + delta);
6783 /* shift subpage upward */
6785 nsize = NUMKEYS(sp) * sp->mp_pad;
6787 return; /* do not make the node uneven-sized */
6788 memmove(METADATA(xp), METADATA(sp), nsize);
6791 numkeys = NUMKEYS(sp);
6792 for (i=numkeys-1; i>=0; i--)
6793 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
6795 xp->mp_upper = sp->mp_lower;
6796 xp->mp_lower = sp->mp_lower;
6797 xp->mp_flags = sp->mp_flags;
6798 xp->mp_pad = sp->mp_pad;
6799 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
6801 nsize = NODEDSZ(node) - delta;
6802 SETDSZ(node, nsize);
6804 /* shift lower nodes upward */
6805 ptr = mp->mp_ptrs[indx];
6806 numkeys = NUMKEYS(mp);
6807 for (i = 0; i < numkeys; i++) {
6808 if (mp->mp_ptrs[i] <= ptr)
6809 mp->mp_ptrs[i] += delta;
6812 base = (char *)mp + mp->mp_upper + PAGEBASE;
6813 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
6814 mp->mp_upper += delta;
6817 /** Initial setup of a sorted-dups cursor.
6818 * Sorted duplicates are implemented as a sub-database for the given key.
6819 * The duplicate data items are actually keys of the sub-database.
6820 * Operations on the duplicate data items are performed using a sub-cursor
6821 * initialized when the sub-database is first accessed. This function does
6822 * the preliminary setup of the sub-cursor, filling in the fields that
6823 * depend only on the parent DB.
6824 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
6827 mdb_xcursor_init0(MDB_cursor *mc)
6829 MDB_xcursor *mx = mc->mc_xcursor;
6831 mx->mx_cursor.mc_xcursor = NULL;
6832 mx->mx_cursor.mc_txn = mc->mc_txn;
6833 mx->mx_cursor.mc_db = &mx->mx_db;
6834 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
6835 mx->mx_cursor.mc_dbi = mc->mc_dbi;
6836 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
6837 mx->mx_cursor.mc_snum = 0;
6838 mx->mx_cursor.mc_top = 0;
6839 mx->mx_cursor.mc_flags = C_SUB;
6840 mx->mx_dbx.md_name.mv_size = 0;
6841 mx->mx_dbx.md_name.mv_data = NULL;
6842 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
6843 mx->mx_dbx.md_dcmp = NULL;
6844 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
6847 /** Final setup of a sorted-dups cursor.
6848 * Sets up the fields that depend on the data from the main cursor.
6849 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
6850 * @param[in] node The data containing the #MDB_db record for the
6851 * sorted-dup database.
6854 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
6856 MDB_xcursor *mx = mc->mc_xcursor;
6858 if (node->mn_flags & F_SUBDATA) {
6859 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
6860 mx->mx_cursor.mc_pg[0] = 0;
6861 mx->mx_cursor.mc_snum = 0;
6862 mx->mx_cursor.mc_top = 0;
6863 mx->mx_cursor.mc_flags = C_SUB;
6865 MDB_page *fp = NODEDATA(node);
6866 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
6867 mx->mx_db.md_flags = 0;
6868 mx->mx_db.md_depth = 1;
6869 mx->mx_db.md_branch_pages = 0;
6870 mx->mx_db.md_leaf_pages = 1;
6871 mx->mx_db.md_overflow_pages = 0;
6872 mx->mx_db.md_entries = NUMKEYS(fp);
6873 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
6874 mx->mx_cursor.mc_snum = 1;
6875 mx->mx_cursor.mc_top = 0;
6876 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
6877 mx->mx_cursor.mc_pg[0] = fp;
6878 mx->mx_cursor.mc_ki[0] = 0;
6879 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
6880 mx->mx_db.md_flags = MDB_DUPFIXED;
6881 mx->mx_db.md_pad = fp->mp_pad;
6882 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
6883 mx->mx_db.md_flags |= MDB_INTEGERKEY;
6886 DPRINTF(("Sub-db -%u root page %"Z"u", mx->mx_cursor.mc_dbi,
6887 mx->mx_db.md_root));
6888 mx->mx_dbflag = DB_VALID|DB_DIRTY; /* DB_DIRTY guides mdb_cursor_touch */
6889 #if UINT_MAX < SIZE_MAX
6890 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
6891 mx->mx_dbx.md_cmp = mdb_cmp_clong;
6895 /** Initialize a cursor for a given transaction and database. */
6897 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
6900 mc->mc_backup = NULL;
6903 mc->mc_db = &txn->mt_dbs[dbi];
6904 mc->mc_dbx = &txn->mt_dbxs[dbi];
6905 mc->mc_dbflag = &txn->mt_dbflags[dbi];
6910 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
6911 mdb_tassert(txn, mx != NULL);
6912 mc->mc_xcursor = mx;
6913 mdb_xcursor_init0(mc);
6915 mc->mc_xcursor = NULL;
6917 if (*mc->mc_dbflag & DB_STALE) {
6918 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
6923 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
6926 size_t size = sizeof(MDB_cursor);
6928 if (!ret || !TXN_DBI_EXIST(txn, dbi))
6931 if (txn->mt_flags & MDB_TXN_ERROR)
6934 /* Allow read access to the freelist */
6935 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
6938 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
6939 size += sizeof(MDB_xcursor);
6941 if ((mc = malloc(size)) != NULL) {
6942 mdb_cursor_init(mc, txn, dbi, (MDB_xcursor *)(mc + 1));
6943 if (txn->mt_cursors) {
6944 mc->mc_next = txn->mt_cursors[dbi];
6945 txn->mt_cursors[dbi] = mc;
6946 mc->mc_flags |= C_UNTRACK;
6958 mdb_cursor_renew(MDB_txn *txn, MDB_cursor *mc)
6960 if (!mc || !TXN_DBI_EXIST(txn, mc->mc_dbi))
6963 if ((mc->mc_flags & C_UNTRACK) || txn->mt_cursors)
6966 if (txn->mt_flags & MDB_TXN_ERROR)
6969 mdb_cursor_init(mc, txn, mc->mc_dbi, mc->mc_xcursor);
6973 /* Return the count of duplicate data items for the current key */
6975 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
6979 if (mc == NULL || countp == NULL)
6982 if (mc->mc_xcursor == NULL)
6983 return MDB_INCOMPATIBLE;
6985 if (mc->mc_txn->mt_flags & MDB_TXN_ERROR)
6988 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
6989 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
6992 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
6995 *countp = mc->mc_xcursor->mx_db.md_entries;
7001 mdb_cursor_close(MDB_cursor *mc)
7003 if (mc && !mc->mc_backup) {
7004 /* remove from txn, if tracked */
7005 if ((mc->mc_flags & C_UNTRACK) && mc->mc_txn->mt_cursors) {
7006 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
7007 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
7009 *prev = mc->mc_next;
7016 mdb_cursor_txn(MDB_cursor *mc)
7018 if (!mc) return NULL;
7023 mdb_cursor_dbi(MDB_cursor *mc)
7028 /** Replace the key for a branch node with a new key.
7029 * @param[in] mc Cursor pointing to the node to operate on.
7030 * @param[in] key The new key to use.
7031 * @return 0 on success, non-zero on failure.
7034 mdb_update_key(MDB_cursor *mc, MDB_val *key)
7040 int delta, ksize, oksize;
7041 indx_t ptr, i, numkeys, indx;
7044 indx = mc->mc_ki[mc->mc_top];
7045 mp = mc->mc_pg[mc->mc_top];
7046 node = NODEPTR(mp, indx);
7047 ptr = mp->mp_ptrs[indx];
7051 char kbuf2[DKBUF_MAXKEYSIZE*2+1];
7052 k2.mv_data = NODEKEY(node);
7053 k2.mv_size = node->mn_ksize;
7054 DPRINTF(("update key %u (ofs %u) [%s] to [%s] on page %"Z"u",
7056 mdb_dkey(&k2, kbuf2),
7062 /* Sizes must be 2-byte aligned. */
7063 ksize = EVEN(key->mv_size);
7064 oksize = EVEN(node->mn_ksize);
7065 delta = ksize - oksize;
7067 /* Shift node contents if EVEN(key length) changed. */
7069 if (delta > 0 && SIZELEFT(mp) < delta) {
7071 /* not enough space left, do a delete and split */
7072 DPRINTF(("Not enough room, delta = %d, splitting...", delta));
7073 pgno = NODEPGNO(node);
7074 mdb_node_del(mc, 0);
7075 return mdb_page_split(mc, key, NULL, pgno, MDB_SPLIT_REPLACE);
7078 numkeys = NUMKEYS(mp);
7079 for (i = 0; i < numkeys; i++) {
7080 if (mp->mp_ptrs[i] <= ptr)
7081 mp->mp_ptrs[i] -= delta;
7084 base = (char *)mp + mp->mp_upper + PAGEBASE;
7085 len = ptr - mp->mp_upper + NODESIZE;
7086 memmove(base - delta, base, len);
7087 mp->mp_upper -= delta;
7089 node = NODEPTR(mp, indx);
7092 /* But even if no shift was needed, update ksize */
7093 if (node->mn_ksize != key->mv_size)
7094 node->mn_ksize = key->mv_size;
7097 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
7103 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst);
7105 /** Move a node from csrc to cdst.
7108 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
7115 unsigned short flags;
7119 /* Mark src and dst as dirty. */
7120 if ((rc = mdb_page_touch(csrc)) ||
7121 (rc = mdb_page_touch(cdst)))
7124 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7125 key.mv_size = csrc->mc_db->md_pad;
7126 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
7128 data.mv_data = NULL;
7132 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
7133 mdb_cassert(csrc, !((size_t)srcnode & 1));
7134 srcpg = NODEPGNO(srcnode);
7135 flags = srcnode->mn_flags;
7136 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7137 unsigned int snum = csrc->mc_snum;
7139 /* must find the lowest key below src */
7140 rc = mdb_page_search_lowest(csrc);
7143 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7144 key.mv_size = csrc->mc_db->md_pad;
7145 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7147 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7148 key.mv_size = NODEKSZ(s2);
7149 key.mv_data = NODEKEY(s2);
7151 csrc->mc_snum = snum--;
7152 csrc->mc_top = snum;
7154 key.mv_size = NODEKSZ(srcnode);
7155 key.mv_data = NODEKEY(srcnode);
7157 data.mv_size = NODEDSZ(srcnode);
7158 data.mv_data = NODEDATA(srcnode);
7160 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
7161 unsigned int snum = cdst->mc_snum;
7164 /* must find the lowest key below dst */
7165 mdb_cursor_copy(cdst, &mn);
7166 rc = mdb_page_search_lowest(&mn);
7169 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7170 bkey.mv_size = mn.mc_db->md_pad;
7171 bkey.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, bkey.mv_size);
7173 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7174 bkey.mv_size = NODEKSZ(s2);
7175 bkey.mv_data = NODEKEY(s2);
7177 mn.mc_snum = snum--;
7180 rc = mdb_update_key(&mn, &bkey);
7185 DPRINTF(("moving %s node %u [%s] on page %"Z"u to node %u on page %"Z"u",
7186 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
7187 csrc->mc_ki[csrc->mc_top],
7189 csrc->mc_pg[csrc->mc_top]->mp_pgno,
7190 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno));
7192 /* Add the node to the destination page.
7194 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
7195 if (rc != MDB_SUCCESS)
7198 /* Delete the node from the source page.
7200 mdb_node_del(csrc, key.mv_size);
7203 /* Adjust other cursors pointing to mp */
7204 MDB_cursor *m2, *m3;
7205 MDB_dbi dbi = csrc->mc_dbi;
7206 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
7208 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7209 if (csrc->mc_flags & C_SUB)
7210 m3 = &m2->mc_xcursor->mx_cursor;
7213 if (m3 == csrc) continue;
7214 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
7215 csrc->mc_ki[csrc->mc_top]) {
7216 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
7217 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
7222 /* Update the parent separators.
7224 if (csrc->mc_ki[csrc->mc_top] == 0) {
7225 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
7226 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7227 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
7229 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
7230 key.mv_size = NODEKSZ(srcnode);
7231 key.mv_data = NODEKEY(srcnode);
7233 DPRINTF(("update separator for source page %"Z"u to [%s]",
7234 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key)));
7235 mdb_cursor_copy(csrc, &mn);
7238 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7241 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
7243 indx_t ix = csrc->mc_ki[csrc->mc_top];
7244 nullkey.mv_size = 0;
7245 csrc->mc_ki[csrc->mc_top] = 0;
7246 rc = mdb_update_key(csrc, &nullkey);
7247 csrc->mc_ki[csrc->mc_top] = ix;
7248 mdb_cassert(csrc, rc == MDB_SUCCESS);
7252 if (cdst->mc_ki[cdst->mc_top] == 0) {
7253 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
7254 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
7255 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
7257 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
7258 key.mv_size = NODEKSZ(srcnode);
7259 key.mv_data = NODEKEY(srcnode);
7261 DPRINTF(("update separator for destination page %"Z"u to [%s]",
7262 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key)));
7263 mdb_cursor_copy(cdst, &mn);
7266 if ((rc = mdb_update_key(&mn, &key)) != MDB_SUCCESS)
7269 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
7271 indx_t ix = cdst->mc_ki[cdst->mc_top];
7272 nullkey.mv_size = 0;
7273 cdst->mc_ki[cdst->mc_top] = 0;
7274 rc = mdb_update_key(cdst, &nullkey);
7275 cdst->mc_ki[cdst->mc_top] = ix;
7276 mdb_cassert(csrc, rc == MDB_SUCCESS);
7283 /** Merge one page into another.
7284 * The nodes from the page pointed to by \b csrc will
7285 * be copied to the page pointed to by \b cdst and then
7286 * the \b csrc page will be freed.
7287 * @param[in] csrc Cursor pointing to the source page.
7288 * @param[in] cdst Cursor pointing to the destination page.
7289 * @return 0 on success, non-zero on failure.
7292 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
7294 MDB_page *psrc, *pdst;
7301 psrc = csrc->mc_pg[csrc->mc_top];
7302 pdst = cdst->mc_pg[cdst->mc_top];
7304 DPRINTF(("merging page %"Z"u into %"Z"u", psrc->mp_pgno, pdst->mp_pgno));
7306 mdb_cassert(csrc, csrc->mc_snum > 1); /* can't merge root page */
7307 mdb_cassert(csrc, cdst->mc_snum > 1);
7309 /* Mark dst as dirty. */
7310 if ((rc = mdb_page_touch(cdst)))
7313 /* Move all nodes from src to dst.
7315 j = nkeys = NUMKEYS(pdst);
7316 if (IS_LEAF2(psrc)) {
7317 key.mv_size = csrc->mc_db->md_pad;
7318 key.mv_data = METADATA(psrc);
7319 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7320 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
7321 if (rc != MDB_SUCCESS)
7323 key.mv_data = (char *)key.mv_data + key.mv_size;
7326 for (i = 0; i < NUMKEYS(psrc); i++, j++) {
7327 srcnode = NODEPTR(psrc, i);
7328 if (i == 0 && IS_BRANCH(psrc)) {
7331 mdb_cursor_copy(csrc, &mn);
7332 /* must find the lowest key below src */
7333 rc = mdb_page_search_lowest(&mn);
7336 if (IS_LEAF2(mn.mc_pg[mn.mc_top])) {
7337 key.mv_size = mn.mc_db->md_pad;
7338 key.mv_data = LEAF2KEY(mn.mc_pg[mn.mc_top], 0, key.mv_size);
7340 s2 = NODEPTR(mn.mc_pg[mn.mc_top], 0);
7341 key.mv_size = NODEKSZ(s2);
7342 key.mv_data = NODEKEY(s2);
7345 key.mv_size = srcnode->mn_ksize;
7346 key.mv_data = NODEKEY(srcnode);
7349 data.mv_size = NODEDSZ(srcnode);
7350 data.mv_data = NODEDATA(srcnode);
7351 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
7352 if (rc != MDB_SUCCESS)
7357 DPRINTF(("dst page %"Z"u now has %u keys (%.1f%% filled)",
7358 pdst->mp_pgno, NUMKEYS(pdst),
7359 (float)PAGEFILL(cdst->mc_txn->mt_env, pdst) / 10));
7361 /* Unlink the src page from parent and add to free list.
7364 mdb_node_del(csrc, 0);
7365 if (csrc->mc_ki[csrc->mc_top] == 0) {
7367 rc = mdb_update_key(csrc, &key);
7375 psrc = csrc->mc_pg[csrc->mc_top];
7376 /* If not operating on FreeDB, allow this page to be reused
7377 * in this txn. Otherwise just add to free list.
7379 rc = mdb_page_loose(csrc, psrc);
7383 csrc->mc_db->md_leaf_pages--;
7385 csrc->mc_db->md_branch_pages--;
7387 /* Adjust other cursors pointing to mp */
7388 MDB_cursor *m2, *m3;
7389 MDB_dbi dbi = csrc->mc_dbi;
7391 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7392 if (csrc->mc_flags & C_SUB)
7393 m3 = &m2->mc_xcursor->mx_cursor;
7396 if (m3 == csrc) continue;
7397 if (m3->mc_snum < csrc->mc_snum) continue;
7398 if (m3->mc_pg[csrc->mc_top] == psrc) {
7399 m3->mc_pg[csrc->mc_top] = pdst;
7400 m3->mc_ki[csrc->mc_top] += nkeys;
7405 unsigned int snum = cdst->mc_snum;
7406 uint16_t depth = cdst->mc_db->md_depth;
7407 mdb_cursor_pop(cdst);
7408 rc = mdb_rebalance(cdst);
7409 /* Did the tree shrink? */
7410 if (depth > cdst->mc_db->md_depth)
7412 cdst->mc_snum = snum;
7413 cdst->mc_top = snum-1;
7418 /** Copy the contents of a cursor.
7419 * @param[in] csrc The cursor to copy from.
7420 * @param[out] cdst The cursor to copy to.
7423 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
7427 cdst->mc_txn = csrc->mc_txn;
7428 cdst->mc_dbi = csrc->mc_dbi;
7429 cdst->mc_db = csrc->mc_db;
7430 cdst->mc_dbx = csrc->mc_dbx;
7431 cdst->mc_snum = csrc->mc_snum;
7432 cdst->mc_top = csrc->mc_top;
7433 cdst->mc_flags = csrc->mc_flags;
7435 for (i=0; i<csrc->mc_snum; i++) {
7436 cdst->mc_pg[i] = csrc->mc_pg[i];
7437 cdst->mc_ki[i] = csrc->mc_ki[i];
7441 /** Rebalance the tree after a delete operation.
7442 * @param[in] mc Cursor pointing to the page where rebalancing
7444 * @return 0 on success, non-zero on failure.
7447 mdb_rebalance(MDB_cursor *mc)
7451 unsigned int ptop, minkeys;
7455 minkeys = 1 + (IS_BRANCH(mc->mc_pg[mc->mc_top]));
7456 DPRINTF(("rebalancing %s page %"Z"u (has %u keys, %.1f%% full)",
7457 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
7458 mdb_dbg_pgno(mc->mc_pg[mc->mc_top]), NUMKEYS(mc->mc_pg[mc->mc_top]),
7459 (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10));
7461 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD &&
7462 NUMKEYS(mc->mc_pg[mc->mc_top]) >= minkeys) {
7463 DPRINTF(("no need to rebalance page %"Z"u, above fill threshold",
7464 mdb_dbg_pgno(mc->mc_pg[mc->mc_top])));
7468 if (mc->mc_snum < 2) {
7469 MDB_page *mp = mc->mc_pg[0];
7471 DPUTS("Can't rebalance a subpage, ignoring");
7474 if (NUMKEYS(mp) == 0) {
7475 DPUTS("tree is completely empty");
7476 mc->mc_db->md_root = P_INVALID;
7477 mc->mc_db->md_depth = 0;
7478 mc->mc_db->md_leaf_pages = 0;
7479 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7482 /* Adjust cursors pointing to mp */
7485 mc->mc_flags &= ~C_INITIALIZED;
7487 MDB_cursor *m2, *m3;
7488 MDB_dbi dbi = mc->mc_dbi;
7490 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7491 if (mc->mc_flags & C_SUB)
7492 m3 = &m2->mc_xcursor->mx_cursor;
7495 if (m3->mc_snum < mc->mc_snum) continue;
7496 if (m3->mc_pg[0] == mp) {
7499 m3->mc_flags &= ~C_INITIALIZED;
7503 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
7505 DPUTS("collapsing root page!");
7506 rc = mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
7509 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
7510 rc = mdb_page_get(mc->mc_txn,mc->mc_db->md_root,&mc->mc_pg[0],NULL);
7513 mc->mc_db->md_depth--;
7514 mc->mc_db->md_branch_pages--;
7515 mc->mc_ki[0] = mc->mc_ki[1];
7516 for (i = 1; i<mc->mc_db->md_depth; i++) {
7517 mc->mc_pg[i] = mc->mc_pg[i+1];
7518 mc->mc_ki[i] = mc->mc_ki[i+1];
7521 /* Adjust other cursors pointing to mp */
7522 MDB_cursor *m2, *m3;
7523 MDB_dbi dbi = mc->mc_dbi;
7525 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
7526 if (mc->mc_flags & C_SUB)
7527 m3 = &m2->mc_xcursor->mx_cursor;
7530 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
7531 if (m3->mc_pg[0] == mp) {
7534 for (i=0; i<m3->mc_snum; i++) {
7535 m3->mc_pg[i] = m3->mc_pg[i+1];
7536 m3->mc_ki[i] = m3->mc_ki[i+1];
7542 DPUTS("root page doesn't need rebalancing");
7546 /* The parent (branch page) must have at least 2 pointers,
7547 * otherwise the tree is invalid.
7549 ptop = mc->mc_top-1;
7550 mdb_cassert(mc, NUMKEYS(mc->mc_pg[ptop]) > 1);
7552 /* Leaf page fill factor is below the threshold.
7553 * Try to move keys from left or right neighbor, or
7554 * merge with a neighbor page.
7559 mdb_cursor_copy(mc, &mn);
7560 mn.mc_xcursor = NULL;
7562 oldki = mc->mc_ki[mc->mc_top];
7563 if (mc->mc_ki[ptop] == 0) {
7564 /* We're the leftmost leaf in our parent.
7566 DPUTS("reading right neighbor");
7568 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
7569 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
7572 mn.mc_ki[mn.mc_top] = 0;
7573 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
7575 /* There is at least one neighbor to the left.
7577 DPUTS("reading left neighbor");
7579 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
7580 rc = mdb_page_get(mc->mc_txn,NODEPGNO(node),&mn.mc_pg[mn.mc_top],NULL);
7583 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
7584 mc->mc_ki[mc->mc_top] = 0;
7587 DPRINTF(("found neighbor page %"Z"u (%u keys, %.1f%% full)",
7588 mn.mc_pg[mn.mc_top]->mp_pgno, NUMKEYS(mn.mc_pg[mn.mc_top]),
7589 (float)PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) / 10));
7591 /* If the neighbor page is above threshold and has enough keys,
7592 * move one key from it. Otherwise we should try to merge them.
7593 * (A branch page must never have less than 2 keys.)
7595 minkeys = 1 + (IS_BRANCH(mn.mc_pg[mn.mc_top]));
7596 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) > minkeys) {
7597 rc = mdb_node_move(&mn, mc);
7598 if (mc->mc_ki[ptop]) {
7602 if (mc->mc_ki[ptop] == 0) {
7603 rc = mdb_page_merge(&mn, mc);
7605 oldki += NUMKEYS(mn.mc_pg[mn.mc_top]);
7606 mn.mc_ki[mn.mc_top] += mc->mc_ki[mn.mc_top] + 1;
7607 rc = mdb_page_merge(mc, &mn);
7608 mdb_cursor_copy(&mn, mc);
7610 mc->mc_flags &= ~C_EOF;
7612 mc->mc_ki[mc->mc_top] = oldki;
7616 /** Complete a delete operation started by #mdb_cursor_del(). */
7618 mdb_cursor_del0(MDB_cursor *mc)
7625 ki = mc->mc_ki[mc->mc_top];
7626 mdb_node_del(mc, mc->mc_db->md_pad);
7627 mc->mc_db->md_entries--;
7628 rc = mdb_rebalance(mc);
7630 if (rc == MDB_SUCCESS) {
7631 MDB_cursor *m2, *m3;
7632 MDB_dbi dbi = mc->mc_dbi;
7634 mp = mc->mc_pg[mc->mc_top];
7635 nkeys = NUMKEYS(mp);
7637 /* if mc points past last node in page, find next sibling */
7638 if (mc->mc_ki[mc->mc_top] >= nkeys) {
7639 rc = mdb_cursor_sibling(mc, 1);
7640 if (rc == MDB_NOTFOUND) {
7641 mc->mc_flags |= C_EOF;
7646 /* Adjust other cursors pointing to mp */
7647 for (m2 = mc->mc_txn->mt_cursors[dbi]; !rc && m2; m2=m2->mc_next) {
7648 m3 = (mc->mc_flags & C_SUB) ? &m2->mc_xcursor->mx_cursor : m2;
7649 if (! (m2->mc_flags & m3->mc_flags & C_INITIALIZED))
7651 if (m3 == mc || m3->mc_snum < mc->mc_snum)
7653 if (m3->mc_pg[mc->mc_top] == mp) {
7654 if (m3->mc_ki[mc->mc_top] >= ki) {
7655 m3->mc_flags |= C_DEL;
7656 if (m3->mc_ki[mc->mc_top] > ki)
7657 m3->mc_ki[mc->mc_top]--;
7659 if (m3->mc_ki[mc->mc_top] >= nkeys) {
7660 rc = mdb_cursor_sibling(m3, 1);
7661 if (rc == MDB_NOTFOUND) {
7662 m3->mc_flags |= C_EOF;
7668 mc->mc_flags |= C_DEL;
7672 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
7677 mdb_del(MDB_txn *txn, MDB_dbi dbi,
7678 MDB_val *key, MDB_val *data)
7680 if (!key || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
7683 if (txn->mt_flags & (MDB_TXN_RDONLY|MDB_TXN_ERROR))
7684 return (txn->mt_flags & MDB_TXN_RDONLY) ? EACCES : MDB_BAD_TXN;
7686 if (!F_ISSET(txn->mt_dbs[dbi].md_flags, MDB_DUPSORT)) {
7687 /* must ignore any data */
7691 return mdb_del0(txn, dbi, key, data, 0);
7695 mdb_del0(MDB_txn *txn, MDB_dbi dbi,
7696 MDB_val *key, MDB_val *data, unsigned flags)
7701 MDB_val rdata, *xdata;
7705 DPRINTF(("====> delete db %u key [%s]", dbi, DKEY(key)));
7707 mdb_cursor_init(&mc, txn, dbi, &mx);
7716 flags |= MDB_NODUPDATA;
7718 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
7720 /* let mdb_page_split know about this cursor if needed:
7721 * delete will trigger a rebalance; if it needs to move
7722 * a node from one page to another, it will have to
7723 * update the parent's separator key(s). If the new sepkey
7724 * is larger than the current one, the parent page may
7725 * run out of space, triggering a split. We need this
7726 * cursor to be consistent until the end of the rebalance.
7728 mc.mc_flags |= C_UNTRACK;
7729 mc.mc_next = txn->mt_cursors[dbi];
7730 txn->mt_cursors[dbi] = &mc;
7731 rc = mdb_cursor_del(&mc, flags);
7732 txn->mt_cursors[dbi] = mc.mc_next;
7737 /** Split a page and insert a new node.
7738 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
7739 * The cursor will be updated to point to the actual page and index where
7740 * the node got inserted after the split.
7741 * @param[in] newkey The key for the newly inserted node.
7742 * @param[in] newdata The data for the newly inserted node.
7743 * @param[in] newpgno The page number, if the new node is a branch node.
7744 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
7745 * @return 0 on success, non-zero on failure.
7748 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
7749 unsigned int nflags)
7752 int rc = MDB_SUCCESS, new_root = 0, did_split = 0;
7755 int i, j, split_indx, nkeys, pmax;
7756 MDB_env *env = mc->mc_txn->mt_env;
7758 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
7759 MDB_page *copy = NULL;
7760 MDB_page *mp, *rp, *pp;
7765 mp = mc->mc_pg[mc->mc_top];
7766 newindx = mc->mc_ki[mc->mc_top];
7767 nkeys = NUMKEYS(mp);
7769 DPRINTF(("-----> splitting %s page %"Z"u and adding [%s] at index %i/%i",
7770 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
7771 DKEY(newkey), mc->mc_ki[mc->mc_top], nkeys));
7773 /* Create a right sibling. */
7774 if ((rc = mdb_page_new(mc, mp->mp_flags, 1, &rp)))
7776 DPRINTF(("new right sibling: page %"Z"u", rp->mp_pgno));
7778 if (mc->mc_snum < 2) {
7779 if ((rc = mdb_page_new(mc, P_BRANCH, 1, &pp)))
7781 /* shift current top to make room for new parent */
7782 mc->mc_pg[1] = mc->mc_pg[0];
7783 mc->mc_ki[1] = mc->mc_ki[0];
7786 mc->mc_db->md_root = pp->mp_pgno;
7787 DPRINTF(("root split! new root = %"Z"u", pp->mp_pgno));
7788 mc->mc_db->md_depth++;
7791 /* Add left (implicit) pointer. */
7792 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
7793 /* undo the pre-push */
7794 mc->mc_pg[0] = mc->mc_pg[1];
7795 mc->mc_ki[0] = mc->mc_ki[1];
7796 mc->mc_db->md_root = mp->mp_pgno;
7797 mc->mc_db->md_depth--;
7804 ptop = mc->mc_top-1;
7805 DPRINTF(("parent branch page is %"Z"u", mc->mc_pg[ptop]->mp_pgno));
7808 mc->mc_flags |= C_SPLITTING;
7809 mdb_cursor_copy(mc, &mn);
7810 mn.mc_pg[mn.mc_top] = rp;
7811 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
7813 if (nflags & MDB_APPEND) {
7814 mn.mc_ki[mn.mc_top] = 0;
7816 split_indx = newindx;
7820 split_indx = (nkeys+1) / 2;
7825 unsigned int lsize, rsize, ksize;
7826 /* Move half of the keys to the right sibling */
7827 x = mc->mc_ki[mc->mc_top] - split_indx;
7828 ksize = mc->mc_db->md_pad;
7829 split = LEAF2KEY(mp, split_indx, ksize);
7830 rsize = (nkeys - split_indx) * ksize;
7831 lsize = (nkeys - split_indx) * sizeof(indx_t);
7832 mp->mp_lower -= lsize;
7833 rp->mp_lower += lsize;
7834 mp->mp_upper += rsize - lsize;
7835 rp->mp_upper -= rsize - lsize;
7836 sepkey.mv_size = ksize;
7837 if (newindx == split_indx) {
7838 sepkey.mv_data = newkey->mv_data;
7840 sepkey.mv_data = split;
7843 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
7844 memcpy(rp->mp_ptrs, split, rsize);
7845 sepkey.mv_data = rp->mp_ptrs;
7846 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
7847 memcpy(ins, newkey->mv_data, ksize);
7848 mp->mp_lower += sizeof(indx_t);
7849 mp->mp_upper -= ksize - sizeof(indx_t);
7852 memcpy(rp->mp_ptrs, split, x * ksize);
7853 ins = LEAF2KEY(rp, x, ksize);
7854 memcpy(ins, newkey->mv_data, ksize);
7855 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
7856 rp->mp_lower += sizeof(indx_t);
7857 rp->mp_upper -= ksize - sizeof(indx_t);
7858 mc->mc_ki[mc->mc_top] = x;
7859 mc->mc_pg[mc->mc_top] = rp;
7862 int psize, nsize, k;
7863 /* Maximum free space in an empty page */
7864 pmax = env->me_psize - PAGEHDRSZ;
7866 nsize = mdb_leaf_size(env, newkey, newdata);
7868 nsize = mdb_branch_size(env, newkey);
7869 nsize = EVEN(nsize);
7871 /* grab a page to hold a temporary copy */
7872 copy = mdb_page_malloc(mc->mc_txn, 1);
7877 copy->mp_pgno = mp->mp_pgno;
7878 copy->mp_flags = mp->mp_flags;
7879 copy->mp_lower = (PAGEHDRSZ-PAGEBASE);
7880 copy->mp_upper = env->me_psize - PAGEBASE;
7882 /* prepare to insert */
7883 for (i=0, j=0; i<nkeys; i++) {
7885 copy->mp_ptrs[j++] = 0;
7887 copy->mp_ptrs[j++] = mp->mp_ptrs[i];
7890 /* When items are relatively large the split point needs
7891 * to be checked, because being off-by-one will make the
7892 * difference between success or failure in mdb_node_add.
7894 * It's also relevant if a page happens to be laid out
7895 * such that one half of its nodes are all "small" and
7896 * the other half of its nodes are "large." If the new
7897 * item is also "large" and falls on the half with
7898 * "large" nodes, it also may not fit.
7900 * As a final tweak, if the new item goes on the last
7901 * spot on the page (and thus, onto the new page), bias
7902 * the split so the new page is emptier than the old page.
7903 * This yields better packing during sequential inserts.
7905 if (nkeys < 20 || nsize > pmax/16 || newindx >= nkeys) {
7906 /* Find split point */
7908 if (newindx <= split_indx || newindx >= nkeys) {
7910 k = newindx >= nkeys ? nkeys : split_indx+2;
7915 for (; i!=k; i+=j) {
7920 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
7921 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
7923 if (F_ISSET(node->mn_flags, F_BIGDATA))
7924 psize += sizeof(pgno_t);
7926 psize += NODEDSZ(node);
7928 psize = EVEN(psize);
7930 if (psize > pmax || i == k-j) {
7931 split_indx = i + (j<0);
7936 if (split_indx == newindx) {
7937 sepkey.mv_size = newkey->mv_size;
7938 sepkey.mv_data = newkey->mv_data;
7940 node = (MDB_node *)((char *)mp + copy->mp_ptrs[split_indx] + PAGEBASE);
7941 sepkey.mv_size = node->mn_ksize;
7942 sepkey.mv_data = NODEKEY(node);
7947 DPRINTF(("separator is %d [%s]", split_indx, DKEY(&sepkey)));
7949 /* Copy separator key to the parent.
7951 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(env, &sepkey)) {
7955 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
7960 if (mn.mc_snum == mc->mc_snum) {
7961 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
7962 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
7963 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
7964 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
7969 /* Right page might now have changed parent.
7970 * Check if left page also changed parent.
7972 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
7973 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
7974 for (i=0; i<ptop; i++) {
7975 mc->mc_pg[i] = mn.mc_pg[i];
7976 mc->mc_ki[i] = mn.mc_ki[i];
7978 mc->mc_pg[ptop] = mn.mc_pg[ptop];
7979 if (mn.mc_ki[ptop]) {
7980 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
7982 /* find right page's left sibling */
7983 mc->mc_ki[ptop] = mn.mc_ki[ptop];
7984 mdb_cursor_sibling(mc, 0);
7989 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
7992 mc->mc_flags ^= C_SPLITTING;
7993 if (rc != MDB_SUCCESS) {
7996 if (nflags & MDB_APPEND) {
7997 mc->mc_pg[mc->mc_top] = rp;
7998 mc->mc_ki[mc->mc_top] = 0;
7999 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
8002 for (i=0; i<mc->mc_top; i++)
8003 mc->mc_ki[i] = mn.mc_ki[i];
8004 } else if (!IS_LEAF2(mp)) {
8006 mc->mc_pg[mc->mc_top] = rp;
8011 rkey.mv_data = newkey->mv_data;
8012 rkey.mv_size = newkey->mv_size;
8018 /* Update index for the new key. */
8019 mc->mc_ki[mc->mc_top] = j;
8021 node = (MDB_node *)((char *)mp + copy->mp_ptrs[i] + PAGEBASE);
8022 rkey.mv_data = NODEKEY(node);
8023 rkey.mv_size = node->mn_ksize;
8025 xdata.mv_data = NODEDATA(node);
8026 xdata.mv_size = NODEDSZ(node);
8029 pgno = NODEPGNO(node);
8030 flags = node->mn_flags;
8033 if (!IS_LEAF(mp) && j == 0) {
8034 /* First branch index doesn't need key data. */
8038 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
8044 mc->mc_pg[mc->mc_top] = copy;
8049 } while (i != split_indx);
8051 nkeys = NUMKEYS(copy);
8052 for (i=0; i<nkeys; i++)
8053 mp->mp_ptrs[i] = copy->mp_ptrs[i];
8054 mp->mp_lower = copy->mp_lower;
8055 mp->mp_upper = copy->mp_upper;
8056 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
8057 env->me_psize - copy->mp_upper - PAGEBASE);
8059 /* reset back to original page */
8060 if (newindx < split_indx) {
8061 mc->mc_pg[mc->mc_top] = mp;
8062 if (nflags & MDB_RESERVE) {
8063 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
8064 if (!(node->mn_flags & F_BIGDATA))
8065 newdata->mv_data = NODEDATA(node);
8068 mc->mc_pg[mc->mc_top] = rp;
8070 /* Make sure mc_ki is still valid.
8072 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
8073 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
8074 for (i=0; i<=ptop; i++) {
8075 mc->mc_pg[i] = mn.mc_pg[i];
8076 mc->mc_ki[i] = mn.mc_ki[i];
8083 /* Adjust other cursors pointing to mp */
8084 MDB_cursor *m2, *m3;
8085 MDB_dbi dbi = mc->mc_dbi;
8086 int fixup = NUMKEYS(mp);
8088 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
8089 if (mc->mc_flags & C_SUB)
8090 m3 = &m2->mc_xcursor->mx_cursor;
8095 if (!(m2->mc_flags & m3->mc_flags & C_INITIALIZED))
8097 if (m3->mc_flags & C_SPLITTING)
8102 for (k=m3->mc_top; k>=0; k--) {
8103 m3->mc_ki[k+1] = m3->mc_ki[k];
8104 m3->mc_pg[k+1] = m3->mc_pg[k];
8106 if (m3->mc_ki[0] >= split_indx) {
8111 m3->mc_pg[0] = mc->mc_pg[0];
8115 if (m3->mc_top >= mc->mc_top && m3->mc_pg[mc->mc_top] == mp) {
8116 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
8117 m3->mc_ki[mc->mc_top]++;
8118 if (m3->mc_ki[mc->mc_top] >= fixup) {
8119 m3->mc_pg[mc->mc_top] = rp;
8120 m3->mc_ki[mc->mc_top] -= fixup;
8121 m3->mc_ki[ptop] = mn.mc_ki[ptop];
8123 } else if (!did_split && m3->mc_top >= ptop && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
8124 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
8129 DPRINTF(("mp left: %d, rp left: %d", SIZELEFT(mp), SIZELEFT(rp)));
8132 if (copy) /* tmp page */
8133 mdb_page_free(env, copy);
8135 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
8140 mdb_put(MDB_txn *txn, MDB_dbi dbi,
8141 MDB_val *key, MDB_val *data, unsigned int flags)
8146 if (!key || !data || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
8149 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND|MDB_APPENDDUP)) != flags)
8152 mdb_cursor_init(&mc, txn, dbi, &mx);
8153 return mdb_cursor_put(&mc, key, data, flags);
8157 #define MDB_WBUF (1024*1024)
8160 /** State needed for a compacting copy. */
8161 typedef struct mdb_copy {
8162 pthread_mutex_t mc_mutex;
8163 pthread_cond_t mc_cond;
8170 pgno_t mc_next_pgno;
8173 volatile int mc_new;
8178 /** Dedicated writer thread for compacting copy. */
8179 static THREAD_RET ESECT
8180 mdb_env_copythr(void *arg)
8184 int toggle = 0, wsize, rc;
8187 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
8190 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
8193 pthread_mutex_lock(&my->mc_mutex);
8195 pthread_cond_signal(&my->mc_cond);
8198 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8199 if (my->mc_new < 0) {
8204 wsize = my->mc_wlen[toggle];
8205 ptr = my->mc_wbuf[toggle];
8208 DO_WRITE(rc, my->mc_fd, ptr, wsize, len);
8212 } else if (len > 0) {
8226 /* If there's an overflow page tail, write it too */
8227 if (my->mc_olen[toggle]) {
8228 wsize = my->mc_olen[toggle];
8229 ptr = my->mc_over[toggle];
8230 my->mc_olen[toggle] = 0;
8233 my->mc_wlen[toggle] = 0;
8235 pthread_cond_signal(&my->mc_cond);
8237 pthread_cond_signal(&my->mc_cond);
8238 pthread_mutex_unlock(&my->mc_mutex);
8239 return (THREAD_RET)0;
8243 /** Tell the writer thread there's a buffer ready to write */
8245 mdb_env_cthr_toggle(mdb_copy *my, int st)
8247 int toggle = my->mc_toggle ^ 1;
8248 pthread_mutex_lock(&my->mc_mutex);
8249 if (my->mc_status) {
8250 pthread_mutex_unlock(&my->mc_mutex);
8251 return my->mc_status;
8253 while (my->mc_new == 1)
8254 pthread_cond_wait(&my->mc_cond, &my->mc_mutex);
8256 my->mc_toggle = toggle;
8257 pthread_cond_signal(&my->mc_cond);
8258 pthread_mutex_unlock(&my->mc_mutex);
8262 /** Depth-first tree traversal for compacting copy. */
8264 mdb_env_cwalk(mdb_copy *my, pgno_t *pg, int flags)
8267 MDB_txn *txn = my->mc_txn;
8269 MDB_page *mo, *mp, *leaf;
8274 /* Empty DB, nothing to do */
8275 if (*pg == P_INVALID)
8282 rc = mdb_page_get(my->mc_txn, *pg, &mc.mc_pg[0], NULL);
8285 rc = mdb_page_search_root(&mc, NULL, MDB_PS_FIRST);
8289 /* Make cursor pages writable */
8290 buf = ptr = malloc(my->mc_env->me_psize * mc.mc_snum);
8294 for (i=0; i<mc.mc_top; i++) {
8295 mdb_page_copy((MDB_page *)ptr, mc.mc_pg[i], my->mc_env->me_psize);
8296 mc.mc_pg[i] = (MDB_page *)ptr;
8297 ptr += my->mc_env->me_psize;
8300 /* This is writable space for a leaf page. Usually not needed. */
8301 leaf = (MDB_page *)ptr;
8303 toggle = my->mc_toggle;
8304 while (mc.mc_snum > 0) {
8306 mp = mc.mc_pg[mc.mc_top];
8310 if (!IS_LEAF2(mp) && !(flags & F_DUPDATA)) {
8311 for (i=0; i<n; i++) {
8312 ni = NODEPTR(mp, i);
8313 if (ni->mn_flags & F_BIGDATA) {
8317 /* Need writable leaf */
8319 mc.mc_pg[mc.mc_top] = leaf;
8320 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8322 ni = NODEPTR(mp, i);
8325 memcpy(&pg, NODEDATA(ni), sizeof(pg));
8326 rc = mdb_page_get(txn, pg, &omp, NULL);
8329 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8330 rc = mdb_env_cthr_toggle(my, 1);
8333 toggle = my->mc_toggle;
8335 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8336 memcpy(mo, omp, my->mc_env->me_psize);
8337 mo->mp_pgno = my->mc_next_pgno;
8338 my->mc_next_pgno += omp->mp_pages;
8339 my->mc_wlen[toggle] += my->mc_env->me_psize;
8340 if (omp->mp_pages > 1) {
8341 my->mc_olen[toggle] = my->mc_env->me_psize * (omp->mp_pages - 1);
8342 my->mc_over[toggle] = (char *)omp + my->mc_env->me_psize;
8343 rc = mdb_env_cthr_toggle(my, 1);
8346 toggle = my->mc_toggle;
8348 memcpy(NODEDATA(ni), &mo->mp_pgno, sizeof(pgno_t));
8349 } else if (ni->mn_flags & F_SUBDATA) {
8352 /* Need writable leaf */
8354 mc.mc_pg[mc.mc_top] = leaf;
8355 mdb_page_copy(leaf, mp, my->mc_env->me_psize);
8357 ni = NODEPTR(mp, i);
8360 memcpy(&db, NODEDATA(ni), sizeof(db));
8361 my->mc_toggle = toggle;
8362 rc = mdb_env_cwalk(my, &db.md_root, ni->mn_flags & F_DUPDATA);
8365 toggle = my->mc_toggle;
8366 memcpy(NODEDATA(ni), &db, sizeof(db));
8371 mc.mc_ki[mc.mc_top]++;
8372 if (mc.mc_ki[mc.mc_top] < n) {
8375 ni = NODEPTR(mp, mc.mc_ki[mc.mc_top]);
8377 rc = mdb_page_get(txn, pg, &mp, NULL);
8382 mc.mc_ki[mc.mc_top] = 0;
8383 if (IS_BRANCH(mp)) {
8384 /* Whenever we advance to a sibling branch page,
8385 * we must proceed all the way down to its first leaf.
8387 mdb_page_copy(mc.mc_pg[mc.mc_top], mp, my->mc_env->me_psize);
8390 mc.mc_pg[mc.mc_top] = mp;
8394 if (my->mc_wlen[toggle] >= MDB_WBUF) {
8395 rc = mdb_env_cthr_toggle(my, 1);
8398 toggle = my->mc_toggle;
8400 mo = (MDB_page *)(my->mc_wbuf[toggle] + my->mc_wlen[toggle]);
8401 mdb_page_copy(mo, mp, my->mc_env->me_psize);
8402 mo->mp_pgno = my->mc_next_pgno++;
8403 my->mc_wlen[toggle] += my->mc_env->me_psize;
8405 /* Update parent if there is one */
8406 ni = NODEPTR(mc.mc_pg[mc.mc_top-1], mc.mc_ki[mc.mc_top-1]);
8407 SETPGNO(ni, mo->mp_pgno);
8408 mdb_cursor_pop(&mc);
8410 /* Otherwise we're done */
8420 /** Copy environment with compaction. */
8422 mdb_env_copyfd1(MDB_env *env, HANDLE fd)
8427 MDB_txn *txn = NULL;
8432 my.mc_mutex = CreateMutex(NULL, FALSE, NULL);
8433 my.mc_cond = CreateEvent(NULL, FALSE, FALSE, NULL);
8434 my.mc_wbuf[0] = _aligned_malloc(MDB_WBUF*2, env->me_psize);
8435 if (my.mc_wbuf[0] == NULL)
8438 pthread_mutex_init(&my.mc_mutex, NULL);
8439 pthread_cond_init(&my.mc_cond, NULL);
8440 rc = posix_memalign((void **)&my.mc_wbuf[0], env->me_psize, MDB_WBUF*2);
8444 my.mc_wbuf[1] = my.mc_wbuf[0] + MDB_WBUF;
8449 my.mc_next_pgno = 2;
8455 THREAD_CREATE(thr, mdb_env_copythr, &my);
8457 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
8461 mp = (MDB_page *)my.mc_wbuf[0];
8462 memset(mp, 0, 2*env->me_psize);
8464 mp->mp_flags = P_META;
8465 mm = (MDB_meta *)METADATA(mp);
8466 mdb_env_init_meta0(env, mm);
8467 mm->mm_address = env->me_metas[0]->mm_address;
8469 mp = (MDB_page *)(my.mc_wbuf[0] + env->me_psize);
8471 mp->mp_flags = P_META;
8472 *(MDB_meta *)METADATA(mp) = *mm;
8473 mm = (MDB_meta *)METADATA(mp);
8475 /* Count the number of free pages, subtract from lastpg to find
8476 * number of active pages
8479 MDB_ID freecount = 0;
8482 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
8483 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
8484 freecount += *(MDB_ID *)data.mv_data;
8485 freecount += txn->mt_dbs[0].md_branch_pages +
8486 txn->mt_dbs[0].md_leaf_pages +
8487 txn->mt_dbs[0].md_overflow_pages;
8489 /* Set metapage 1 */
8490 mm->mm_last_pg = txn->mt_next_pgno - freecount - 1;
8491 mm->mm_dbs[1] = txn->mt_dbs[1];
8492 mm->mm_dbs[1].md_root = mm->mm_last_pg;
8495 my.mc_wlen[0] = env->me_psize * 2;
8497 pthread_mutex_lock(&my.mc_mutex);
8499 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8500 pthread_mutex_unlock(&my.mc_mutex);
8501 rc = mdb_env_cwalk(&my, &txn->mt_dbs[1].md_root, 0);
8502 if (rc == MDB_SUCCESS && my.mc_wlen[my.mc_toggle])
8503 rc = mdb_env_cthr_toggle(&my, 1);
8504 mdb_env_cthr_toggle(&my, -1);
8505 pthread_mutex_lock(&my.mc_mutex);
8507 pthread_cond_wait(&my.mc_cond, &my.mc_mutex);
8508 pthread_mutex_unlock(&my.mc_mutex);
8513 CloseHandle(my.mc_cond);
8514 CloseHandle(my.mc_mutex);
8515 _aligned_free(my.mc_wbuf[0]);
8517 pthread_cond_destroy(&my.mc_cond);
8518 pthread_mutex_destroy(&my.mc_mutex);
8519 free(my.mc_wbuf[0]);
8524 /** Copy environment as-is. */
8526 mdb_env_copyfd0(MDB_env *env, HANDLE fd)
8528 MDB_txn *txn = NULL;
8534 #define DO_WRITE(rc, fd, ptr, w2, len) rc = WriteFile(fd, ptr, w2, &len, NULL)
8538 #define DO_WRITE(rc, fd, ptr, w2, len) len = write(fd, ptr, w2); rc = (len >= 0)
8541 /* Do the lock/unlock of the reader mutex before starting the
8542 * write txn. Otherwise other read txns could block writers.
8544 rc = mdb_txn_begin(env, NULL, MDB_RDONLY, &txn);
8549 /* We must start the actual read txn after blocking writers */
8550 mdb_txn_reset0(txn, "reset-stage1");
8552 /* Temporarily block writers until we snapshot the meta pages */
8555 rc = mdb_txn_renew0(txn);
8557 UNLOCK_MUTEX_W(env);
8562 wsize = env->me_psize * 2;
8566 DO_WRITE(rc, fd, ptr, w2, len);
8570 } else if (len > 0) {
8576 /* Non-blocking or async handles are not supported */
8582 UNLOCK_MUTEX_W(env);
8587 w2 = txn->mt_next_pgno * env->me_psize;
8590 LARGE_INTEGER fsize;
8591 GetFileSizeEx(env->me_fd, &fsize);
8592 if (w2 > fsize.QuadPart)
8593 w2 = fsize.QuadPart;
8598 fstat(env->me_fd, &st);
8599 if (w2 > (size_t)st.st_size)
8605 if (wsize > MAX_WRITE)
8609 DO_WRITE(rc, fd, ptr, w2, len);
8613 } else if (len > 0) {
8630 mdb_env_copyfd2(MDB_env *env, HANDLE fd, unsigned int flags)
8632 if (flags & MDB_CP_COMPACT)
8633 return mdb_env_copyfd1(env, fd);
8635 return mdb_env_copyfd0(env, fd);
8639 mdb_env_copyfd(MDB_env *env, HANDLE fd)
8641 return mdb_env_copyfd2(env, fd, 0);
8645 mdb_env_copy2(MDB_env *env, const char *path, unsigned int flags)
8649 HANDLE newfd = INVALID_HANDLE_VALUE;
8651 if (env->me_flags & MDB_NOSUBDIR) {
8652 lpath = (char *)path;
8655 len += sizeof(DATANAME);
8656 lpath = malloc(len);
8659 sprintf(lpath, "%s" DATANAME, path);
8662 /* The destination path must exist, but the destination file must not.
8663 * We don't want the OS to cache the writes, since the source data is
8664 * already in the OS cache.
8667 newfd = CreateFile(lpath, GENERIC_WRITE, 0, NULL, CREATE_NEW,
8668 FILE_FLAG_NO_BUFFERING|FILE_FLAG_WRITE_THROUGH, NULL);
8670 newfd = open(lpath, O_WRONLY|O_CREAT|O_EXCL, 0666);
8672 if (newfd == INVALID_HANDLE_VALUE) {
8678 /* Set O_DIRECT if the file system supports it */
8679 if ((rc = fcntl(newfd, F_GETFL)) != -1)
8680 (void) fcntl(newfd, F_SETFL, rc | O_DIRECT);
8682 #ifdef F_NOCACHE /* __APPLE__ */
8683 rc = fcntl(newfd, F_NOCACHE, 1);
8690 rc = mdb_env_copyfd2(env, newfd, flags);
8693 if (!(env->me_flags & MDB_NOSUBDIR))
8695 if (newfd != INVALID_HANDLE_VALUE)
8696 if (close(newfd) < 0 && rc == MDB_SUCCESS)
8703 mdb_env_copy(MDB_env *env, const char *path)
8705 return mdb_env_copy2(env, path, 0);
8709 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
8711 if ((flag & CHANGEABLE) != flag)
8714 env->me_flags |= flag;
8716 env->me_flags &= ~flag;
8721 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
8726 *arg = env->me_flags;
8731 mdb_env_set_userctx(MDB_env *env, void *ctx)
8735 env->me_userctx = ctx;
8740 mdb_env_get_userctx(MDB_env *env)
8742 return env ? env->me_userctx : NULL;
8746 mdb_env_set_assert(MDB_env *env, MDB_assert_func *func)
8751 env->me_assert_func = func;
8757 mdb_env_get_path(MDB_env *env, const char **arg)
8762 *arg = env->me_path;
8767 mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *arg)
8776 /** Common code for #mdb_stat() and #mdb_env_stat().
8777 * @param[in] env the environment to operate in.
8778 * @param[in] db the #MDB_db record containing the stats to return.
8779 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
8780 * @return 0, this function always succeeds.
8783 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
8785 arg->ms_psize = env->me_psize;
8786 arg->ms_depth = db->md_depth;
8787 arg->ms_branch_pages = db->md_branch_pages;
8788 arg->ms_leaf_pages = db->md_leaf_pages;
8789 arg->ms_overflow_pages = db->md_overflow_pages;
8790 arg->ms_entries = db->md_entries;
8796 mdb_env_stat(MDB_env *env, MDB_stat *arg)
8800 if (env == NULL || arg == NULL)
8803 toggle = mdb_env_pick_meta(env);
8805 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
8809 mdb_env_info(MDB_env *env, MDB_envinfo *arg)
8813 if (env == NULL || arg == NULL)
8816 toggle = mdb_env_pick_meta(env);
8817 arg->me_mapaddr = env->me_metas[toggle]->mm_address;
8818 arg->me_mapsize = env->me_mapsize;
8819 arg->me_maxreaders = env->me_maxreaders;
8821 /* me_numreaders may be zero if this process never used any readers. Use
8822 * the shared numreader count if it exists.
8824 arg->me_numreaders = env->me_txns ? env->me_txns->mti_numreaders : env->me_numreaders;
8826 arg->me_last_pgno = env->me_metas[toggle]->mm_last_pg;
8827 arg->me_last_txnid = env->me_metas[toggle]->mm_txnid;
8831 /** Set the default comparison functions for a database.
8832 * Called immediately after a database is opened to set the defaults.
8833 * The user can then override them with #mdb_set_compare() or
8834 * #mdb_set_dupsort().
8835 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
8836 * @param[in] dbi A database handle returned by #mdb_dbi_open()
8839 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
8841 uint16_t f = txn->mt_dbs[dbi].md_flags;
8843 txn->mt_dbxs[dbi].md_cmp =
8844 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
8845 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
8847 txn->mt_dbxs[dbi].md_dcmp =
8848 !(f & MDB_DUPSORT) ? 0 :
8849 ((f & MDB_INTEGERDUP)
8850 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
8851 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
8854 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
8859 int rc, dbflag, exact;
8860 unsigned int unused = 0, seq;
8863 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
8864 mdb_default_cmp(txn, FREE_DBI);
8867 if ((flags & VALID_FLAGS) != flags)
8869 if (txn->mt_flags & MDB_TXN_ERROR)
8875 if (flags & PERSISTENT_FLAGS) {
8876 uint16_t f2 = flags & PERSISTENT_FLAGS;
8877 /* make sure flag changes get committed */
8878 if ((txn->mt_dbs[MAIN_DBI].md_flags | f2) != txn->mt_dbs[MAIN_DBI].md_flags) {
8879 txn->mt_dbs[MAIN_DBI].md_flags |= f2;
8880 txn->mt_flags |= MDB_TXN_DIRTY;
8883 mdb_default_cmp(txn, MAIN_DBI);
8887 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
8888 mdb_default_cmp(txn, MAIN_DBI);
8891 /* Is the DB already open? */
8893 for (i=2; i<txn->mt_numdbs; i++) {
8894 if (!txn->mt_dbxs[i].md_name.mv_size) {
8895 /* Remember this free slot */
8896 if (!unused) unused = i;
8899 if (len == txn->mt_dbxs[i].md_name.mv_size &&
8900 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
8906 /* If no free slot and max hit, fail */
8907 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs)
8908 return MDB_DBS_FULL;
8910 /* Cannot mix named databases with some mainDB flags */
8911 if (txn->mt_dbs[MAIN_DBI].md_flags & (MDB_DUPSORT|MDB_INTEGERKEY))
8912 return (flags & MDB_CREATE) ? MDB_INCOMPATIBLE : MDB_NOTFOUND;
8914 /* Find the DB info */
8915 dbflag = DB_NEW|DB_VALID;
8918 key.mv_data = (void *)name;
8919 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
8920 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
8921 if (rc == MDB_SUCCESS) {
8922 /* make sure this is actually a DB */
8923 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
8924 if (!(node->mn_flags & F_SUBDATA))
8925 return MDB_INCOMPATIBLE;
8926 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
8927 /* Create if requested */
8929 data.mv_size = sizeof(MDB_db);
8930 data.mv_data = &dummy;
8931 memset(&dummy, 0, sizeof(dummy));
8932 dummy.md_root = P_INVALID;
8933 dummy.md_flags = flags & PERSISTENT_FLAGS;
8934 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
8938 /* OK, got info, add to table */
8939 if (rc == MDB_SUCCESS) {
8940 unsigned int slot = unused ? unused : txn->mt_numdbs;
8941 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
8942 txn->mt_dbxs[slot].md_name.mv_size = len;
8943 txn->mt_dbxs[slot].md_rel = NULL;
8944 txn->mt_dbflags[slot] = dbflag;
8945 /* txn-> and env-> are the same in read txns, use
8946 * tmp variable to avoid undefined assignment
8948 seq = ++txn->mt_env->me_dbiseqs[slot];
8949 txn->mt_dbiseqs[slot] = seq;
8951 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
8953 mdb_default_cmp(txn, slot);
8962 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
8964 if (!arg || !TXN_DBI_EXIST(txn, dbi))
8967 if (txn->mt_flags & MDB_TXN_ERROR)
8970 if (txn->mt_dbflags[dbi] & DB_STALE) {
8973 /* Stale, must read the DB's root. cursor_init does it for us. */
8974 mdb_cursor_init(&mc, txn, dbi, &mx);
8976 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
8979 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
8982 if (dbi <= MAIN_DBI || dbi >= env->me_maxdbs)
8984 ptr = env->me_dbxs[dbi].md_name.mv_data;
8985 /* If there was no name, this was already closed */
8987 env->me_dbxs[dbi].md_name.mv_data = NULL;
8988 env->me_dbxs[dbi].md_name.mv_size = 0;
8989 env->me_dbflags[dbi] = 0;
8990 env->me_dbiseqs[dbi]++;
8995 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags)
8997 /* We could return the flags for the FREE_DBI too but what's the point? */
8998 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9000 *flags = txn->mt_dbs[dbi].md_flags & PERSISTENT_FLAGS;
9004 /** Add all the DB's pages to the free list.
9005 * @param[in] mc Cursor on the DB to free.
9006 * @param[in] subs non-Zero to check for sub-DBs in this DB.
9007 * @return 0 on success, non-zero on failure.
9010 mdb_drop0(MDB_cursor *mc, int subs)
9014 rc = mdb_page_search(mc, NULL, MDB_PS_FIRST);
9015 if (rc == MDB_SUCCESS) {
9016 MDB_txn *txn = mc->mc_txn;
9021 /* LEAF2 pages have no nodes, cannot have sub-DBs */
9022 if (IS_LEAF2(mc->mc_pg[mc->mc_top]))
9025 mdb_cursor_copy(mc, &mx);
9026 while (mc->mc_snum > 0) {
9027 MDB_page *mp = mc->mc_pg[mc->mc_top];
9028 unsigned n = NUMKEYS(mp);
9030 for (i=0; i<n; i++) {
9031 ni = NODEPTR(mp, i);
9032 if (ni->mn_flags & F_BIGDATA) {
9035 memcpy(&pg, NODEDATA(ni), sizeof(pg));
9036 rc = mdb_page_get(txn, pg, &omp, NULL);
9039 mdb_cassert(mc, IS_OVERFLOW(omp));
9040 rc = mdb_midl_append_range(&txn->mt_free_pgs,
9044 } else if (subs && (ni->mn_flags & F_SUBDATA)) {
9045 mdb_xcursor_init1(mc, ni);
9046 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
9052 if ((rc = mdb_midl_need(&txn->mt_free_pgs, n)) != 0)
9054 for (i=0; i<n; i++) {
9056 ni = NODEPTR(mp, i);
9059 mdb_midl_xappend(txn->mt_free_pgs, pg);
9064 mc->mc_ki[mc->mc_top] = i;
9065 rc = mdb_cursor_sibling(mc, 1);
9067 if (rc != MDB_NOTFOUND)
9069 /* no more siblings, go back to beginning
9070 * of previous level.
9074 for (i=1; i<mc->mc_snum; i++) {
9076 mc->mc_pg[i] = mx.mc_pg[i];
9081 rc = mdb_midl_append(&txn->mt_free_pgs, mc->mc_db->md_root);
9084 txn->mt_flags |= MDB_TXN_ERROR;
9085 } else if (rc == MDB_NOTFOUND) {
9091 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
9093 MDB_cursor *mc, *m2;
9096 if ((unsigned)del > 1 || dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9099 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
9102 if (dbi > MAIN_DBI && TXN_DBI_CHANGED(txn, dbi))
9105 rc = mdb_cursor_open(txn, dbi, &mc);
9109 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
9110 /* Invalidate the dropped DB's cursors */
9111 for (m2 = txn->mt_cursors[dbi]; m2; m2 = m2->mc_next)
9112 m2->mc_flags &= ~(C_INITIALIZED|C_EOF);
9116 /* Can't delete the main DB */
9117 if (del && dbi > MAIN_DBI) {
9118 rc = mdb_del0(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL, 0);
9120 txn->mt_dbflags[dbi] = DB_STALE;
9121 mdb_dbi_close(txn->mt_env, dbi);
9123 txn->mt_flags |= MDB_TXN_ERROR;
9126 /* reset the DB record, mark it dirty */
9127 txn->mt_dbflags[dbi] |= DB_DIRTY;
9128 txn->mt_dbs[dbi].md_depth = 0;
9129 txn->mt_dbs[dbi].md_branch_pages = 0;
9130 txn->mt_dbs[dbi].md_leaf_pages = 0;
9131 txn->mt_dbs[dbi].md_overflow_pages = 0;
9132 txn->mt_dbs[dbi].md_entries = 0;
9133 txn->mt_dbs[dbi].md_root = P_INVALID;
9135 txn->mt_flags |= MDB_TXN_DIRTY;
9138 mdb_cursor_close(mc);
9142 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9144 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9147 txn->mt_dbxs[dbi].md_cmp = cmp;
9151 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
9153 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9156 txn->mt_dbxs[dbi].md_dcmp = cmp;
9160 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
9162 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9165 txn->mt_dbxs[dbi].md_rel = rel;
9169 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
9171 if (dbi == FREE_DBI || !TXN_DBI_EXIST(txn, dbi))
9174 txn->mt_dbxs[dbi].md_relctx = ctx;
9179 mdb_env_get_maxkeysize(MDB_env *env)
9181 return ENV_MAXKEY(env);
9185 mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx)
9187 unsigned int i, rdrs;
9190 int rc = 0, first = 1;
9194 if (!env->me_txns) {
9195 return func("(no reader locks)\n", ctx);
9197 rdrs = env->me_txns->mti_numreaders;
9198 mr = env->me_txns->mti_readers;
9199 for (i=0; i<rdrs; i++) {
9201 txnid_t txnid = mr[i].mr_txnid;
9202 sprintf(buf, txnid == (txnid_t)-1 ?
9203 "%10d %"Z"x -\n" : "%10d %"Z"x %"Z"u\n",
9204 (int)mr[i].mr_pid, (size_t)mr[i].mr_tid, txnid);
9207 rc = func(" pid thread txnid\n", ctx);
9211 rc = func(buf, ctx);
9217 rc = func("(no active readers)\n", ctx);
9222 /** Insert pid into list if not already present.
9223 * return -1 if already present.
9226 mdb_pid_insert(MDB_PID_T *ids, MDB_PID_T pid)
9228 /* binary search of pid in list */
9230 unsigned cursor = 1;
9232 unsigned n = ids[0];
9235 unsigned pivot = n >> 1;
9236 cursor = base + pivot + 1;
9237 val = pid - ids[cursor];
9242 } else if ( val > 0 ) {
9247 /* found, so it's a duplicate */
9256 for (n = ids[0]; n > cursor; n--)
9263 mdb_reader_check(MDB_env *env, int *dead)
9265 unsigned int i, j, rdrs;
9267 MDB_PID_T *pids, pid;
9276 rdrs = env->me_txns->mti_numreaders;
9277 pids = malloc((rdrs+1) * sizeof(MDB_PID_T));
9281 mr = env->me_txns->mti_readers;
9282 for (i=0; i<rdrs; i++) {
9283 if (mr[i].mr_pid && mr[i].mr_pid != env->me_pid) {
9285 if (mdb_pid_insert(pids, pid) == 0) {
9286 if (!mdb_reader_pid(env, Pidcheck, pid)) {
9288 /* Recheck, a new process may have reused pid */
9289 if (!mdb_reader_pid(env, Pidcheck, pid)) {
9290 for (j=i; j<rdrs; j++)
9291 if (mr[j].mr_pid == pid) {
9292 DPRINTF(("clear stale reader pid %u txn %"Z"d",
9293 (unsigned) pid, mr[j].mr_txnid));
9298 UNLOCK_MUTEX_R(env);
projects / openldap / blob