2 * @brief memory-mapped database library
4 * A Btree-based database management library modeled loosely on the
5 * BerkeleyDB API, but much simplified.
8 * Copyright 2011-2012 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.
35 #include <sys/types.h>
37 #include <sys/param.h>
43 #ifdef HAVE_SYS_FILE_H
60 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
61 #include <resolv.h> /* defines BYTE_ORDER on HPUX and Solaris */
64 #if defined(__APPLE__) || defined (BSD)
71 #include <semaphore.h>
76 #include <valgrind/memcheck.h>
77 #define VGMEMP_CREATE(h,r,z) VALGRIND_CREATE_MEMPOOL(h,r,z)
78 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
79 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
80 #define VGMEMP_DESTROY(h) VALGRIND_DESTROY_MEMPOOL(h)
81 #define VGMEMP_DEFINED(a,s) VALGRIND_MAKE_MEM_DEFINED(a,s)
83 #define VGMEMP_CREATE(h,r,z)
84 #define VGMEMP_ALLOC(h,a,s)
85 #define VGMEMP_FREE(h,a)
86 #define VGMEMP_DESTROY(h)
87 #define VGMEMP_DEFINED(a,s)
91 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
92 /* Solaris just defines one or the other */
93 # define LITTLE_ENDIAN 1234
94 # define BIG_ENDIAN 4321
95 # ifdef _LITTLE_ENDIAN
96 # define BYTE_ORDER LITTLE_ENDIAN
98 # define BYTE_ORDER BIG_ENDIAN
101 # define BYTE_ORDER __BYTE_ORDER
105 #ifndef LITTLE_ENDIAN
106 #define LITTLE_ENDIAN __LITTLE_ENDIAN
109 #define BIG_ENDIAN __BIG_ENDIAN
112 #if defined(__i386) || defined(__x86_64)
113 #define MISALIGNED_OK 1
119 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
120 # error "Unknown or unsupported endianness (BYTE_ORDER)"
121 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
122 # error "Two's complement, reasonably sized integer types, please"
125 /** @defgroup internal MDB Internals
128 /** @defgroup compat Windows Compatibility Macros
129 * A bunch of macros to minimize the amount of platform-specific ifdefs
130 * needed throughout the rest of the code. When the features this library
131 * needs are similar enough to POSIX to be hidden in a one-or-two line
132 * replacement, this macro approach is used.
136 #define pthread_t DWORD
137 #define pthread_mutex_t HANDLE
138 #define pthread_key_t DWORD
139 #define pthread_self() GetCurrentThreadId()
140 #define pthread_key_create(x,y) (*(x) = TlsAlloc())
141 #define pthread_key_delete(x) TlsFree(x)
142 #define pthread_getspecific(x) TlsGetValue(x)
143 #define pthread_setspecific(x,y) TlsSetValue(x,y)
144 #define pthread_mutex_unlock(x) ReleaseMutex(x)
145 #define pthread_mutex_lock(x) WaitForSingleObject(x, INFINITE)
146 #define LOCK_MUTEX_R(env) pthread_mutex_lock((env)->me_rmutex)
147 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock((env)->me_rmutex)
148 #define LOCK_MUTEX_W(env) pthread_mutex_lock((env)->me_wmutex)
149 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock((env)->me_wmutex)
150 #define getpid() GetCurrentProcessId()
151 #define MDB_FDATASYNC(fd) (!FlushFileBuffers(fd))
152 #define ErrCode() GetLastError()
153 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
154 #define close(fd) CloseHandle(fd)
155 #define munmap(ptr,len) UnmapViewOfFile(ptr)
158 #define LOCK_MUTEX_R(env) sem_wait((env)->me_rmutex)
159 #define UNLOCK_MUTEX_R(env) sem_post((env)->me_rmutex)
160 #define LOCK_MUTEX_W(env) sem_wait((env)->me_wmutex)
161 #define UNLOCK_MUTEX_W(env) sem_post((env)->me_wmutex)
162 #define MDB_FDATASYNC(fd) fsync(fd)
165 #define MDB_FDATASYNC(fd) fsync(fd)
167 /** Lock the reader mutex.
169 #define LOCK_MUTEX_R(env) pthread_mutex_lock(&(env)->me_txns->mti_mutex)
170 /** Unlock the reader mutex.
172 #define UNLOCK_MUTEX_R(env) pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
174 /** Lock the writer mutex.
175 * Only a single write transaction is allowed at a time. Other writers
176 * will block waiting for this mutex.
178 #define LOCK_MUTEX_W(env) pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
179 /** Unlock the writer mutex.
181 #define UNLOCK_MUTEX_W(env) pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
182 #endif /* USE_POSIX_SEM */
184 /** Get the error code for the last failed system function.
186 #define ErrCode() errno
188 /** An abstraction for a file handle.
189 * On POSIX systems file handles are small integers. On Windows
190 * they're opaque pointers.
194 /** A value for an invalid file handle.
195 * Mainly used to initialize file variables and signify that they are
198 #define INVALID_HANDLE_VALUE (-1)
200 /** Get the size of a memory page for the system.
201 * This is the basic size that the platform's memory manager uses, and is
202 * fundamental to the use of memory-mapped files.
204 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
207 #if defined(_WIN32) || defined(USE_POSIX_SEM)
210 #define MNAME_LEN (sizeof(pthread_mutex_t))
216 /** A flag for opening a file and requesting synchronous data writes.
217 * This is only used when writing a meta page. It's not strictly needed;
218 * we could just do a normal write and then immediately perform a flush.
219 * But if this flag is available it saves us an extra system call.
221 * @note If O_DSYNC is undefined but exists in /usr/include,
222 * preferably set some compiler flag to get the definition.
223 * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
226 # define MDB_DSYNC O_DSYNC
230 /** Function for flushing the data of a file. Define this to fsync
231 * if fdatasync() is not supported.
233 #ifndef MDB_FDATASYNC
234 # define MDB_FDATASYNC fdatasync
237 /** A page number in the database.
238 * Note that 64 bit page numbers are overkill, since pages themselves
239 * already represent 12-13 bits of addressable memory, and the OS will
240 * always limit applications to a maximum of 63 bits of address space.
242 * @note In the #MDB_node structure, we only store 48 bits of this value,
243 * which thus limits us to only 60 bits of addressable data.
245 typedef MDB_ID pgno_t;
247 /** A transaction ID.
248 * See struct MDB_txn.mt_txnid for details.
250 typedef MDB_ID txnid_t;
252 /** @defgroup debug Debug Macros
256 /** Enable debug output.
257 * Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
258 * read from and written to the database (used for free space management).
263 #if !(__STDC_VERSION__ >= 199901L || defined(__GNUC__))
264 # define DPRINTF (void) /* Vararg macros may be unsupported */
266 static int mdb_debug;
267 static txnid_t mdb_debug_start;
269 /** Print a debug message with printf formatting. */
270 # define DPRINTF(fmt, ...) /**< Requires 2 or more args */ \
271 ((void) ((mdb_debug) && \
272 fprintf(stderr, "%s:%d " fmt "\n", __func__, __LINE__, __VA_ARGS__)))
274 # define DPRINTF(fmt, ...) ((void) 0)
276 /** Print a debug string.
277 * The string is printed literally, with no format processing.
279 #define DPUTS(arg) DPRINTF("%s", arg)
282 /** A default memory page size.
283 * The actual size is platform-dependent, but we use this for
284 * boot-strapping. We probably should not be using this any more.
285 * The #GET_PAGESIZE() macro is used to get the actual size.
287 * Note that we don't currently support Huge pages. On Linux,
288 * regular data files cannot use Huge pages, and in general
289 * Huge pages aren't actually pageable. We rely on the OS
290 * demand-pager to read our data and page it out when memory
291 * pressure from other processes is high. So until OSs have
292 * actual paging support for Huge pages, they're not viable.
294 #define MDB_PAGESIZE 4096
296 /** The minimum number of keys required in a database page.
297 * Setting this to a larger value will place a smaller bound on the
298 * maximum size of a data item. Data items larger than this size will
299 * be pushed into overflow pages instead of being stored directly in
300 * the B-tree node. This value used to default to 4. With a page size
301 * of 4096 bytes that meant that any item larger than 1024 bytes would
302 * go into an overflow page. That also meant that on average 2-3KB of
303 * each overflow page was wasted space. The value cannot be lower than
304 * 2 because then there would no longer be a tree structure. With this
305 * value, items larger than 2KB will go into overflow pages, and on
306 * average only 1KB will be wasted.
308 #define MDB_MINKEYS 2
310 /** A stamp that identifies a file as an MDB file.
311 * There's nothing special about this value other than that it is easily
312 * recognizable, and it will reflect any byte order mismatches.
314 #define MDB_MAGIC 0xBEEFC0DE
316 /** The version number for a database's file format. */
317 #define MDB_VERSION 1
319 /** The maximum size of a key in the database.
320 * While data items have essentially unbounded size, we require that
321 * keys all fit onto a regular page. This limit could be raised a bit
322 * further if needed; to something just under #MDB_PAGESIZE / #MDB_MINKEYS.
324 #define MAXKEYSIZE 511
329 * This is used for printing a hex dump of a key's contents.
331 #define DKBUF char kbuf[(MAXKEYSIZE*2+1)]
332 /** Display a key in hex.
334 * Invoke a function to display a key in hex.
336 #define DKEY(x) mdb_dkey(x, kbuf)
338 #define DKBUF typedef int dummy_kbuf /* so we can put ';' after */
342 /** An invalid page number.
343 * Mainly used to denote an empty tree.
345 #define P_INVALID (~0UL)
347 /** Test if a flag \b f is set in a flag word \b w. */
348 #define F_ISSET(w, f) (((w) & (f)) == (f))
350 /** Used for offsets within a single page.
351 * Since memory pages are typically 4 or 8KB in size, 12-13 bits,
354 typedef uint16_t indx_t;
356 /** Default size of memory map.
357 * This is certainly too small for any actual applications. Apps should always set
358 * the size explicitly using #mdb_env_set_mapsize().
360 #define DEFAULT_MAPSIZE 1048576
362 /** @defgroup readers Reader Lock Table
363 * Readers don't acquire any locks for their data access. Instead, they
364 * simply record their transaction ID in the reader table. The reader
365 * mutex is needed just to find an empty slot in the reader table. The
366 * slot's address is saved in thread-specific data so that subsequent read
367 * transactions started by the same thread need no further locking to proceed.
369 * Since the database uses multi-version concurrency control, readers don't
370 * actually need any locking. This table is used to keep track of which
371 * readers are using data from which old transactions, so that we'll know
372 * when a particular old transaction is no longer in use. Old transactions
373 * that have discarded any data pages can then have those pages reclaimed
374 * for use by a later write transaction.
376 * The lock table is constructed such that reader slots are aligned with the
377 * processor's cache line size. Any slot is only ever used by one thread.
378 * This alignment guarantees that there will be no contention or cache
379 * thrashing as threads update their own slot info, and also eliminates
380 * any need for locking when accessing a slot.
382 * A writer thread will scan every slot in the table to determine the oldest
383 * outstanding reader transaction. Any freed pages older than this will be
384 * reclaimed by the writer. The writer doesn't use any locks when scanning
385 * this table. This means that there's no guarantee that the writer will
386 * see the most up-to-date reader info, but that's not required for correct
387 * operation - all we need is to know the upper bound on the oldest reader,
388 * we don't care at all about the newest reader. So the only consequence of
389 * reading stale information here is that old pages might hang around a
390 * while longer before being reclaimed. That's actually good anyway, because
391 * the longer we delay reclaiming old pages, the more likely it is that a
392 * string of contiguous pages can be found after coalescing old pages from
393 * many old transactions together.
395 * @todo We don't actually do such coalescing yet, we grab pages from one
396 * old transaction at a time.
399 /** Number of slots in the reader table.
400 * This value was chosen somewhat arbitrarily. 126 readers plus a
401 * couple mutexes fit exactly into 8KB on my development machine.
402 * Applications should set the table size using #mdb_env_set_maxreaders().
404 #define DEFAULT_READERS 126
406 /** The size of a CPU cache line in bytes. We want our lock structures
407 * aligned to this size to avoid false cache line sharing in the
409 * This value works for most CPUs. For Itanium this should be 128.
415 /** The information we store in a single slot of the reader table.
416 * In addition to a transaction ID, we also record the process and
417 * thread ID that owns a slot, so that we can detect stale information,
418 * e.g. threads or processes that went away without cleaning up.
419 * @note We currently don't check for stale records. We simply re-init
420 * the table when we know that we're the only process opening the
423 typedef struct MDB_rxbody {
424 /** The current Transaction ID when this transaction began.
425 * Multiple readers that start at the same time will probably have the
426 * same ID here. Again, it's not important to exclude them from
427 * anything; all we need to know is which version of the DB they
428 * started from so we can avoid overwriting any data used in that
429 * particular version.
432 /** The process ID of the process owning this reader txn. */
434 /** The thread ID of the thread owning this txn. */
438 /** The actual reader record, with cacheline padding. */
439 typedef struct MDB_reader {
442 /** shorthand for mrb_txnid */
443 #define mr_txnid mru.mrx.mrb_txnid
444 #define mr_pid mru.mrx.mrb_pid
445 #define mr_tid mru.mrx.mrb_tid
446 /** cache line alignment */
447 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
451 /** The header for the reader table.
452 * The table resides in a memory-mapped file. (This is a different file
453 * than is used for the main database.)
455 * For POSIX the actual mutexes reside in the shared memory of this
456 * mapped file. On Windows, mutexes are named objects allocated by the
457 * kernel; we store the mutex names in this mapped file so that other
458 * processes can grab them. This same approach is also used on
459 * MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
460 * process-shared POSIX mutexes. For these cases where a named object
461 * is used, the object name is derived from a 64 bit FNV hash of the
462 * environment pathname. As such, naming collisions are extremely
463 * unlikely. If a collision occurs, the results are unpredictable.
465 typedef struct MDB_txbody {
466 /** Stamp identifying this as an MDB file. It must be set
469 /** Version number of this lock file. Must be set to #MDB_VERSION. */
470 uint32_t mtb_version;
471 #if defined(_WIN32) || defined(USE_POSIX_SEM)
472 char mtb_rmname[MNAME_LEN];
474 /** Mutex protecting access to this table.
475 * This is the reader lock that #LOCK_MUTEX_R acquires.
477 pthread_mutex_t mtb_mutex;
479 /** The ID of the last transaction committed to the database.
480 * This is recorded here only for convenience; the value can always
481 * be determined by reading the main database meta pages.
484 /** The number of slots that have been used in the reader table.
485 * This always records the maximum count, it is not decremented
486 * when readers release their slots.
488 unsigned mtb_numreaders;
491 /** The actual reader table definition. */
492 typedef struct MDB_txninfo {
495 #define mti_magic mt1.mtb.mtb_magic
496 #define mti_version mt1.mtb.mtb_version
497 #define mti_mutex mt1.mtb.mtb_mutex
498 #define mti_rmname mt1.mtb.mtb_rmname
499 #define mti_txnid mt1.mtb.mtb_txnid
500 #define mti_numreaders mt1.mtb.mtb_numreaders
501 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
504 #if defined(_WIN32) || defined(USE_POSIX_SEM)
505 char mt2_wmname[MNAME_LEN];
506 #define mti_wmname mt2.mt2_wmname
508 pthread_mutex_t mt2_wmutex;
509 #define mti_wmutex mt2.mt2_wmutex
511 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
513 MDB_reader mti_readers[1];
517 /** Common header for all page types.
518 * Overflow records occupy a number of contiguous pages with no
519 * headers on any page after the first.
521 typedef struct MDB_page {
522 #define mp_pgno mp_p.p_pgno
523 #define mp_next mp_p.p_next
525 pgno_t p_pgno; /**< page number */
526 void * p_next; /**< for in-memory list of freed structs */
529 /** @defgroup mdb_page Page Flags
531 * Flags for the page headers.
534 #define P_BRANCH 0x01 /**< branch page */
535 #define P_LEAF 0x02 /**< leaf page */
536 #define P_OVERFLOW 0x04 /**< overflow page */
537 #define P_META 0x08 /**< meta page */
538 #define P_DIRTY 0x10 /**< dirty page */
539 #define P_LEAF2 0x20 /**< for #MDB_DUPFIXED records */
540 #define P_SUBP 0x40 /**< for #MDB_DUPSORT sub-pages */
542 uint16_t mp_flags; /**< @ref mdb_page */
543 #define mp_lower mp_pb.pb.pb_lower
544 #define mp_upper mp_pb.pb.pb_upper
545 #define mp_pages mp_pb.pb_pages
548 indx_t pb_lower; /**< lower bound of free space */
549 indx_t pb_upper; /**< upper bound of free space */
551 uint32_t pb_pages; /**< number of overflow pages */
553 indx_t mp_ptrs[1]; /**< dynamic size */
556 /** Size of the page header, excluding dynamic data at the end */
557 #define PAGEHDRSZ ((unsigned) offsetof(MDB_page, mp_ptrs))
559 /** Address of first usable data byte in a page, after the header */
560 #define METADATA(p) ((void *)((char *)(p) + PAGEHDRSZ))
562 /** Number of nodes on a page */
563 #define NUMKEYS(p) (((p)->mp_lower - PAGEHDRSZ) >> 1)
565 /** The amount of space remaining in the page */
566 #define SIZELEFT(p) (indx_t)((p)->mp_upper - (p)->mp_lower)
568 /** The percentage of space used in the page, in tenths of a percent. */
569 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
570 ((env)->me_psize - PAGEHDRSZ))
571 /** The minimum page fill factor, in tenths of a percent.
572 * Pages emptier than this are candidates for merging.
574 #define FILL_THRESHOLD 250
576 /** Test if a page is a leaf page */
577 #define IS_LEAF(p) F_ISSET((p)->mp_flags, P_LEAF)
578 /** Test if a page is a LEAF2 page */
579 #define IS_LEAF2(p) F_ISSET((p)->mp_flags, P_LEAF2)
580 /** Test if a page is a branch page */
581 #define IS_BRANCH(p) F_ISSET((p)->mp_flags, P_BRANCH)
582 /** Test if a page is an overflow page */
583 #define IS_OVERFLOW(p) F_ISSET((p)->mp_flags, P_OVERFLOW)
584 /** Test if a page is a sub page */
585 #define IS_SUBP(p) F_ISSET((p)->mp_flags, P_SUBP)
587 /** The number of overflow pages needed to store the given size. */
588 #define OVPAGES(size, psize) ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
590 /** Header for a single key/data pair within a page.
591 * We guarantee 2-byte alignment for nodes.
593 typedef struct MDB_node {
594 /** lo and hi are used for data size on leaf nodes and for
595 * child pgno on branch nodes. On 64 bit platforms, flags
596 * is also used for pgno. (Branch nodes have no flags).
597 * They are in host byte order in case that lets some
598 * accesses be optimized into a 32-bit word access.
600 #define mn_lo mn_offset[BYTE_ORDER!=LITTLE_ENDIAN]
601 #define mn_hi mn_offset[BYTE_ORDER==LITTLE_ENDIAN] /**< part of dsize or pgno */
602 unsigned short mn_offset[2]; /**< storage for #mn_lo and #mn_hi */
603 /** @defgroup mdb_node Node Flags
605 * Flags for node headers.
608 #define F_BIGDATA 0x01 /**< data put on overflow page */
609 #define F_SUBDATA 0x02 /**< data is a sub-database */
610 #define F_DUPDATA 0x04 /**< data has duplicates */
612 /** valid flags for #mdb_node_add() */
613 #define NODE_ADD_FLAGS (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
616 unsigned short mn_flags; /**< @ref mdb_node */
617 unsigned short mn_ksize; /**< key size */
618 char mn_data[1]; /**< key and data are appended here */
621 /** Size of the node header, excluding dynamic data at the end */
622 #define NODESIZE offsetof(MDB_node, mn_data)
624 /** Bit position of top word in page number, for shifting mn_flags */
625 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
627 /** Size of a node in a branch page with a given key.
628 * This is just the node header plus the key, there is no data.
630 #define INDXSIZE(k) (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
632 /** Size of a node in a leaf page with a given key and data.
633 * This is node header plus key plus data size.
635 #define LEAFSIZE(k, d) (NODESIZE + (k)->mv_size + (d)->mv_size)
637 /** Address of node \b i in page \b p */
638 #define NODEPTR(p, i) ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i]))
640 /** Address of the key for the node */
641 #define NODEKEY(node) (void *)((node)->mn_data)
643 /** Address of the data for a node */
644 #define NODEDATA(node) (void *)((char *)(node)->mn_data + (node)->mn_ksize)
646 /** Get the page number pointed to by a branch node */
647 #define NODEPGNO(node) \
648 ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
649 (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
650 /** Set the page number in a branch node */
651 #define SETPGNO(node,pgno) do { \
652 (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
653 if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
655 /** Get the size of the data in a leaf node */
656 #define NODEDSZ(node) ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
657 /** Set the size of the data for a leaf node */
658 #define SETDSZ(node,size) do { \
659 (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
660 /** The size of a key in a node */
661 #define NODEKSZ(node) ((node)->mn_ksize)
663 /** Copy a page number from src to dst */
665 #define COPY_PGNO(dst,src) dst = src
667 #if SIZE_MAX > 4294967295UL
668 #define COPY_PGNO(dst,src) do { \
669 unsigned short *s, *d; \
670 s = (unsigned short *)&(src); \
671 d = (unsigned short *)&(dst); \
678 #define COPY_PGNO(dst,src) do { \
679 unsigned short *s, *d; \
680 s = (unsigned short *)&(src); \
681 d = (unsigned short *)&(dst); \
687 /** The address of a key in a LEAF2 page.
688 * LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
689 * There are no node headers, keys are stored contiguously.
691 #define LEAF2KEY(p, i, ks) ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
693 /** Set the \b node's key into \b key, if requested. */
694 #define MDB_SET_KEY(node, key) { if ((key) != NULL) { \
695 (key)->mv_size = NODEKSZ(node); (key)->mv_data = NODEKEY(node); } }
697 /** Information about a single database in the environment. */
698 typedef struct MDB_db {
699 uint32_t md_pad; /**< also ksize for LEAF2 pages */
700 uint16_t md_flags; /**< @ref mdb_open */
701 uint16_t md_depth; /**< depth of this tree */
702 pgno_t md_branch_pages; /**< number of internal pages */
703 pgno_t md_leaf_pages; /**< number of leaf pages */
704 pgno_t md_overflow_pages; /**< number of overflow pages */
705 size_t md_entries; /**< number of data items */
706 pgno_t md_root; /**< the root page of this tree */
709 /** Handle for the DB used to track free pages. */
711 /** Handle for the default DB. */
714 /** Meta page content. */
715 typedef struct MDB_meta {
716 /** Stamp identifying this as an MDB file. It must be set
719 /** Version number of this lock file. Must be set to #MDB_VERSION. */
721 void *mm_address; /**< address for fixed mapping */
722 size_t mm_mapsize; /**< size of mmap region */
723 MDB_db mm_dbs[2]; /**< first is free space, 2nd is main db */
724 /** The size of pages used in this DB */
725 #define mm_psize mm_dbs[0].md_pad
726 /** Any persistent environment flags. @ref mdb_env */
727 #define mm_flags mm_dbs[0].md_flags
728 pgno_t mm_last_pg; /**< last used page in file */
729 txnid_t mm_txnid; /**< txnid that committed this page */
732 /** Buffer for a stack-allocated dirty page.
733 * The members define size and alignment, and silence type
734 * aliasing warnings. They are not used directly; that could
735 * mean incorrectly using several union members in parallel.
737 typedef union MDB_pagebuf {
738 char mb_raw[MDB_PAGESIZE];
741 char mm_pad[PAGEHDRSZ];
746 /** Auxiliary DB info.
747 * The information here is mostly static/read-only. There is
748 * only a single copy of this record in the environment.
750 typedef struct MDB_dbx {
751 MDB_val md_name; /**< name of the database */
752 MDB_cmp_func *md_cmp; /**< function for comparing keys */
753 MDB_cmp_func *md_dcmp; /**< function for comparing data items */
754 MDB_rel_func *md_rel; /**< user relocate function */
755 void *md_relctx; /**< user-provided context for md_rel */
758 /** A database transaction.
759 * Every operation requires a transaction handle.
762 MDB_txn *mt_parent; /**< parent of a nested txn */
763 MDB_txn *mt_child; /**< nested txn under this txn */
764 pgno_t mt_next_pgno; /**< next unallocated page */
765 /** The ID of this transaction. IDs are integers incrementing from 1.
766 * Only committed write transactions increment the ID. If a transaction
767 * aborts, the ID may be re-used by the next writer.
770 MDB_env *mt_env; /**< the DB environment */
771 /** The list of pages that became unused during this transaction.
775 MDB_ID2L dirty_list; /**< modified pages */
776 MDB_reader *reader; /**< this thread's slot in the reader table */
778 /** Array of records for each DB known in the environment. */
780 /** Array of MDB_db records for each known DB */
782 /** @defgroup mt_dbflag Transaction DB Flags
786 #define DB_DIRTY 0x01 /**< DB was written in this txn */
787 #define DB_STALE 0x02 /**< DB record is older than txnID */
789 /** Array of cursors for each DB */
790 MDB_cursor **mt_cursors;
791 /** Array of flags for each DB */
792 unsigned char *mt_dbflags;
793 /** Number of DB records in use. This number only ever increments;
794 * we don't decrement it when individual DB handles are closed.
798 /** @defgroup mdb_txn Transaction Flags
802 #define MDB_TXN_RDONLY 0x01 /**< read-only transaction */
803 #define MDB_TXN_ERROR 0x02 /**< an error has occurred */
805 unsigned int mt_flags; /**< @ref mdb_txn */
806 /** Tracks which of the two meta pages was used at the start
807 * of this transaction.
809 unsigned int mt_toggle;
812 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
813 * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
814 * raise this on a 64 bit machine.
816 #define CURSOR_STACK 32
820 /** Cursors are used for all DB operations */
822 /** Next cursor on this DB in this txn */
824 /** Original cursor if this is a shadow */
826 /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
827 struct MDB_xcursor *mc_xcursor;
828 /** The transaction that owns this cursor */
830 /** The database handle this cursor operates on */
832 /** The database record for this cursor */
834 /** The database auxiliary record for this cursor */
836 /** The @ref mt_dbflag for this database */
837 unsigned char *mc_dbflag;
838 unsigned short mc_snum; /**< number of pushed pages */
839 unsigned short mc_top; /**< index of top page, normally mc_snum-1 */
840 /** @defgroup mdb_cursor Cursor Flags
842 * Cursor state flags.
845 #define C_INITIALIZED 0x01 /**< cursor has been initialized and is valid */
846 #define C_EOF 0x02 /**< No more data */
847 #define C_SUB 0x04 /**< Cursor is a sub-cursor */
848 #define C_SHADOW 0x08 /**< Cursor is a dup from a parent txn */
849 #define C_ALLOCD 0x10 /**< Cursor was malloc'd */
850 #define C_SPLITTING 0x20 /**< Cursor is in page_split */
852 unsigned int mc_flags; /**< @ref mdb_cursor */
853 MDB_page *mc_pg[CURSOR_STACK]; /**< stack of pushed pages */
854 indx_t mc_ki[CURSOR_STACK]; /**< stack of page indices */
857 /** Context for sorted-dup records.
858 * We could have gone to a fully recursive design, with arbitrarily
859 * deep nesting of sub-databases. But for now we only handle these
860 * levels - main DB, optional sub-DB, sorted-duplicate DB.
862 typedef struct MDB_xcursor {
863 /** A sub-cursor for traversing the Dup DB */
864 MDB_cursor mx_cursor;
865 /** The database record for this Dup DB */
867 /** The auxiliary DB record for this Dup DB */
869 /** The @ref mt_dbflag for this Dup DB */
870 unsigned char mx_dbflag;
873 /** A set of pages freed by an earlier transaction. */
874 typedef struct MDB_oldpages {
875 /** Usually we only read one record from the FREEDB at a time, but
876 * in case we read more, this will chain them together.
878 struct MDB_oldpages *mo_next;
879 /** The ID of the transaction in which these pages were freed. */
881 /** An #MDB_IDL of the pages */
882 pgno_t mo_pages[1]; /* dynamic */
885 /** The database environment. */
887 HANDLE me_fd; /**< The main data file */
888 HANDLE me_lfd; /**< The lock file */
889 HANDLE me_mfd; /**< just for writing the meta pages */
890 /** Failed to update the meta page. Probably an I/O error. */
891 #define MDB_FATAL_ERROR 0x80000000U
892 uint32_t me_flags; /**< @ref mdb_env */
893 unsigned int me_psize; /**< size of a page, from #GET_PAGESIZE */
894 unsigned int me_maxreaders; /**< size of the reader table */
895 MDB_dbi me_numdbs; /**< number of DBs opened */
896 MDB_dbi me_maxdbs; /**< size of the DB table */
897 char *me_path; /**< path to the DB files */
898 char *me_map; /**< the memory map of the data file */
899 MDB_txninfo *me_txns; /**< the memory map of the lock file */
900 MDB_meta *me_metas[2]; /**< pointers to the two meta pages */
901 MDB_txn *me_txn; /**< current write transaction */
902 size_t me_mapsize; /**< size of the data memory map */
903 off_t me_size; /**< current file size */
904 pgno_t me_maxpg; /**< me_mapsize / me_psize */
905 txnid_t me_pgfirst; /**< ID of first old page record we used */
906 txnid_t me_pglast; /**< ID of last old page record we used */
907 MDB_dbx *me_dbxs; /**< array of static DB info */
908 uint16_t *me_dbflags; /**< array of DB flags */
909 MDB_oldpages *me_pghead; /**< list of old page records */
910 MDB_oldpages *me_pgfree; /**< list of page records to free */
911 pthread_key_t me_txkey; /**< thread-key for readers */
912 MDB_page *me_dpages; /**< list of malloc'd blocks for re-use */
913 /** IDL of pages that became unused in a write txn */
915 /** ID2L of pages that were written during a write txn */
916 MDB_ID2 me_dirty_list[MDB_IDL_UM_SIZE];
918 HANDLE me_rmutex; /* Windows mutexes don't reside in shared mem */
922 sem_t *me_rmutex; /* Apple doesn't support shared mutexes */
926 /** max number of pages to commit in one writev() call */
927 #define MDB_COMMIT_PAGES 64
928 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
929 #undef MDB_COMMIT_PAGES
930 #define MDB_COMMIT_PAGES IOV_MAX
933 static MDB_page *mdb_page_alloc(MDB_cursor *mc, int num);
934 static MDB_page *mdb_page_new(MDB_cursor *mc, uint32_t flags, int num);
935 static int mdb_page_touch(MDB_cursor *mc);
937 static int mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp);
938 static int mdb_page_search_root(MDB_cursor *mc,
939 MDB_val *key, int modify);
940 #define MDB_PS_MODIFY 1
941 #define MDB_PS_ROOTONLY 2
942 static int mdb_page_search(MDB_cursor *mc,
943 MDB_val *key, int flags);
944 static int mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
946 #define MDB_SPLIT_REPLACE MDB_APPENDDUP /**< newkey is not new */
947 static int mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
948 pgno_t newpgno, unsigned int nflags);
950 static int mdb_env_read_header(MDB_env *env, MDB_meta *meta);
951 static int mdb_env_pick_meta(const MDB_env *env);
952 static int mdb_env_write_meta(MDB_txn *txn);
954 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
955 static int mdb_node_add(MDB_cursor *mc, indx_t indx,
956 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
957 static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
958 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
959 static int mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
960 static int mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
961 static size_t mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
962 static size_t mdb_branch_size(MDB_env *env, MDB_val *key);
964 static int mdb_rebalance(MDB_cursor *mc);
965 static int mdb_update_key(MDB_page *mp, indx_t indx, MDB_val *key);
967 static void mdb_cursor_pop(MDB_cursor *mc);
968 static int mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
970 static int mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
971 static int mdb_cursor_sibling(MDB_cursor *mc, int move_right);
972 static int mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
973 static int mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
974 static int mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
976 static int mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
977 static int mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
979 static void mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
980 static void mdb_xcursor_init0(MDB_cursor *mc);
981 static void mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
983 static int mdb_drop0(MDB_cursor *mc, int subs);
984 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
987 static MDB_cmp_func mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
991 static SECURITY_DESCRIPTOR mdb_null_sd;
992 static SECURITY_ATTRIBUTES mdb_all_sa;
993 static int mdb_sec_inited;
996 /** Return the library version info. */
998 mdb_version(int *major, int *minor, int *patch)
1000 if (major) *major = MDB_VERSION_MAJOR;
1001 if (minor) *minor = MDB_VERSION_MINOR;
1002 if (patch) *patch = MDB_VERSION_PATCH;
1003 return MDB_VERSION_STRING;
1006 /** Table of descriptions for MDB @ref errors */
1007 static char *const mdb_errstr[] = {
1008 "MDB_KEYEXIST: Key/data pair already exists",
1009 "MDB_NOTFOUND: No matching key/data pair found",
1010 "MDB_PAGE_NOTFOUND: Requested page not found",
1011 "MDB_CORRUPTED: Located page was wrong type",
1012 "MDB_PANIC: Update of meta page failed",
1013 "MDB_VERSION_MISMATCH: Database environment version mismatch"
1017 mdb_strerror(int err)
1020 return ("Successful return: 0");
1022 if (err >= MDB_KEYEXIST && err <= MDB_VERSION_MISMATCH)
1023 return mdb_errstr[err - MDB_KEYEXIST];
1025 return strerror(err);
1029 /** Display a key in hexadecimal and return the address of the result.
1030 * @param[in] key the key to display
1031 * @param[in] buf the buffer to write into. Should always be #DKBUF.
1032 * @return The key in hexadecimal form.
1035 mdb_dkey(MDB_val *key, char *buf)
1038 unsigned char *c = key->mv_data;
1040 if (key->mv_size > MAXKEYSIZE)
1041 return "MAXKEYSIZE";
1042 /* may want to make this a dynamic check: if the key is mostly
1043 * printable characters, print it as-is instead of converting to hex.
1047 for (i=0; i<key->mv_size; i++)
1048 ptr += sprintf(ptr, "%02x", *c++);
1050 sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1055 /** Display all the keys in the page. */
1057 mdb_page_keys(MDB_page *mp)
1060 unsigned int i, nkeys;
1064 nkeys = NUMKEYS(mp);
1065 fprintf(stderr, "numkeys %d\n", nkeys);
1066 for (i=0; i<nkeys; i++) {
1067 node = NODEPTR(mp, i);
1068 key.mv_size = node->mn_ksize;
1069 key.mv_data = node->mn_data;
1070 fprintf(stderr, "key %d: %s\n", i, DKEY(&key));
1075 mdb_cursor_chk(MDB_cursor *mc)
1081 if (!mc->mc_snum && !(mc->mc_flags & C_INITIALIZED)) return;
1082 for (i=0; i<mc->mc_top; i++) {
1084 node = NODEPTR(mp, mc->mc_ki[i]);
1085 if (NODEPGNO(node) != mc->mc_pg[i+1]->mp_pgno)
1088 if (mc->mc_ki[i] >= NUMKEYS(mc->mc_pg[i]))
1094 /** Count all the pages in each DB and in the freelist
1095 * and make sure it matches the actual number of pages
1098 static void mdb_audit(MDB_txn *txn)
1102 MDB_ID freecount, count;
1107 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1108 while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1109 freecount += *(MDB_ID *)data.mv_data;
1110 freecount += txn->mt_dbs[0].md_branch_pages + txn->mt_dbs[0].md_leaf_pages +
1111 txn->mt_dbs[0].md_overflow_pages;
1114 for (i = 0; i<txn->mt_numdbs; i++) {
1115 count += txn->mt_dbs[i].md_branch_pages +
1116 txn->mt_dbs[i].md_leaf_pages +
1117 txn->mt_dbs[i].md_overflow_pages;
1118 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1120 mdb_cursor_init(&mc, txn, i, &mx);
1121 mdb_page_search(&mc, NULL, 0);
1125 mp = mc.mc_pg[mc.mc_top];
1126 for (j=0; j<NUMKEYS(mp); j++) {
1127 MDB_node *leaf = NODEPTR(mp, j);
1128 if (leaf->mn_flags & F_SUBDATA) {
1130 memcpy(&db, NODEDATA(leaf), sizeof(db));
1131 count += db.md_branch_pages + db.md_leaf_pages +
1132 db.md_overflow_pages;
1136 while (mdb_cursor_sibling(&mc, 1) == 0);
1139 assert(freecount + count + 2 >= txn->mt_next_pgno - 1);
1144 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1146 return txn->mt_dbxs[dbi].md_cmp(a, b);
1150 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1152 if (txn->mt_dbxs[dbi].md_dcmp)
1153 return txn->mt_dbxs[dbi].md_dcmp(a, b);
1155 return EINVAL; /* too bad you can't distinguish this from a valid result */
1158 /** Allocate a single page.
1159 * Re-use old malloc'd pages first, otherwise just malloc.
1162 mdb_page_malloc(MDB_cursor *mc) {
1164 size_t sz = mc->mc_txn->mt_env->me_psize;
1165 if ((ret = mc->mc_txn->mt_env->me_dpages) != NULL) {
1166 VGMEMP_ALLOC(mc->mc_txn->mt_env, ret, sz);
1167 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1168 mc->mc_txn->mt_env->me_dpages = ret->mp_next;
1169 } else if ((ret = malloc(sz)) != NULL) {
1170 VGMEMP_ALLOC(mc->mc_txn->mt_env, ret, sz);
1175 /** Allocate pages for writing.
1176 * If there are free pages available from older transactions, they
1177 * will be re-used first. Otherwise a new page will be allocated.
1178 * @param[in] mc cursor A cursor handle identifying the transaction and
1179 * database for which we are allocating.
1180 * @param[in] num the number of pages to allocate.
1181 * @return Address of the allocated page(s). Requests for multiple pages
1182 * will always be satisfied by a single contiguous chunk of memory.
1185 mdb_page_alloc(MDB_cursor *mc, int num)
1187 MDB_txn *txn = mc->mc_txn;
1189 pgno_t pgno = P_INVALID;
1192 /* The free list won't have any content at all until txn 2 has
1193 * committed. The pages freed by txn 2 will be unreferenced
1194 * after txn 3 commits, and so will be safe to re-use in txn 4.
1196 if (txn->mt_txnid > 3) {
1198 if (!txn->mt_env->me_pghead &&
1199 txn->mt_dbs[FREE_DBI].md_root != P_INVALID) {
1200 /* See if there's anything in the free DB */
1204 txnid_t *kptr, oldest, last;
1206 mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
1207 if (!txn->mt_env->me_pgfirst) {
1208 mdb_page_search(&m2, NULL, 0);
1209 leaf = NODEPTR(m2.mc_pg[m2.mc_top], 0);
1210 kptr = (txnid_t *)NODEKEY(leaf);
1217 last = txn->mt_env->me_pglast + 1;
1219 key.mv_data = &last;
1220 key.mv_size = sizeof(last);
1221 rc = mdb_cursor_set(&m2, &key, &data, MDB_SET, &exact);
1224 last = *(txnid_t *)key.mv_data;
1229 oldest = txn->mt_txnid - 1;
1230 for (i=0; i<txn->mt_env->me_txns->mti_numreaders; i++) {
1231 txnid_t mr = txn->mt_env->me_txns->mti_readers[i].mr_txnid;
1232 if (mr && mr < oldest)
1237 if (oldest > last) {
1238 /* It's usable, grab it.
1243 if (!txn->mt_env->me_pgfirst) {
1244 mdb_node_read(txn, leaf, &data);
1246 txn->mt_env->me_pglast = last;
1247 if (!txn->mt_env->me_pgfirst)
1248 txn->mt_env->me_pgfirst = last;
1249 idl = (MDB_ID *) data.mv_data;
1250 /* We might have a zero-length IDL due to freelist growth
1251 * during a prior commit
1253 if (!idl[0]) goto again;
1254 mop = malloc(sizeof(MDB_oldpages) + MDB_IDL_SIZEOF(idl) - sizeof(pgno_t));
1255 mop->mo_next = txn->mt_env->me_pghead;
1256 mop->mo_txnid = last;
1257 txn->mt_env->me_pghead = mop;
1258 memcpy(mop->mo_pages, idl, MDB_IDL_SIZEOF(idl));
1263 DPRINTF("IDL read txn %zu root %zu num %zu",
1264 mop->mo_txnid, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
1265 for (i=0; i<idl[0]; i++) {
1266 DPRINTF("IDL %zu", idl[i+1]);
1273 if (txn->mt_env->me_pghead) {
1274 MDB_oldpages *mop = txn->mt_env->me_pghead;
1276 /* FIXME: For now, always use fresh pages. We
1277 * really ought to search the free list for a
1282 /* peel pages off tail, so we only have to truncate the list */
1283 pgno = MDB_IDL_LAST(mop->mo_pages);
1284 if (MDB_IDL_IS_RANGE(mop->mo_pages)) {
1286 if (mop->mo_pages[2] > mop->mo_pages[1])
1287 mop->mo_pages[0] = 0;
1291 if (MDB_IDL_IS_ZERO(mop->mo_pages)) {
1292 txn->mt_env->me_pghead = mop->mo_next;
1293 if (mc->mc_dbi == FREE_DBI) {
1294 mop->mo_next = txn->mt_env->me_pgfree;
1295 txn->mt_env->me_pgfree = mop;
1304 if (pgno == P_INVALID) {
1305 /* DB size is maxed out */
1306 if (txn->mt_next_pgno + num >= txn->mt_env->me_maxpg) {
1307 DPUTS("DB size maxed out");
1311 if (txn->mt_env->me_dpages && num == 1) {
1312 np = txn->mt_env->me_dpages;
1313 VGMEMP_ALLOC(txn->mt_env, np, txn->mt_env->me_psize);
1314 VGMEMP_DEFINED(np, sizeof(np->mp_next));
1315 txn->mt_env->me_dpages = np->mp_next;
1317 size_t sz = txn->mt_env->me_psize * num;
1318 if ((np = malloc(sz)) == NULL)
1320 VGMEMP_ALLOC(txn->mt_env, np, sz);
1322 if (pgno == P_INVALID) {
1323 np->mp_pgno = txn->mt_next_pgno;
1324 txn->mt_next_pgno += num;
1328 mid.mid = np->mp_pgno;
1330 mdb_mid2l_insert(txn->mt_u.dirty_list, &mid);
1335 /** Copy a page: avoid copying unused portions of the page.
1336 * @param[in] dst page to copy into
1337 * @param[in] src page to copy from
1340 mdb_page_copy(MDB_page *dst, MDB_page *src, unsigned int psize)
1342 dst->mp_flags = src->mp_flags | P_DIRTY;
1343 dst->mp_pages = src->mp_pages;
1345 if (IS_LEAF2(src)) {
1346 memcpy(dst->mp_ptrs, src->mp_ptrs, psize - PAGEHDRSZ - SIZELEFT(src));
1348 unsigned int i, nkeys = NUMKEYS(src);
1349 for (i=0; i<nkeys; i++)
1350 dst->mp_ptrs[i] = src->mp_ptrs[i];
1351 memcpy((char *)dst+src->mp_upper, (char *)src+src->mp_upper,
1352 psize - src->mp_upper);
1356 /** Touch a page: make it dirty and re-insert into tree with updated pgno.
1357 * @param[in] mc cursor pointing to the page to be touched
1358 * @return 0 on success, non-zero on failure.
1361 mdb_page_touch(MDB_cursor *mc)
1363 MDB_page *mp = mc->mc_pg[mc->mc_top];
1366 if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
1368 if ((np = mdb_page_alloc(mc, 1)) == NULL)
1370 DPRINTF("touched db %u page %zu -> %zu", mc->mc_dbi, mp->mp_pgno, np->mp_pgno);
1371 assert(mp->mp_pgno != np->mp_pgno);
1372 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
1374 /* If page isn't full, just copy the used portion */
1375 mdb_page_copy(np, mp, mc->mc_txn->mt_env->me_psize);
1378 memcpy(np, mp, mc->mc_txn->mt_env->me_psize);
1380 np->mp_flags |= P_DIRTY;
1385 /* Adjust other cursors pointing to mp */
1386 if (mc->mc_flags & C_SUB) {
1387 MDB_cursor *m2, *m3;
1388 MDB_dbi dbi = mc->mc_dbi-1;
1390 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
1391 if (m2 == mc) continue;
1392 m3 = &m2->mc_xcursor->mx_cursor;
1393 if (m3->mc_snum < mc->mc_snum) continue;
1394 if (m3->mc_pg[mc->mc_top] == mc->mc_pg[mc->mc_top]) {
1395 m3->mc_pg[mc->mc_top] = mp;
1401 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
1402 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
1403 if (m2->mc_pg[mc->mc_top] == mc->mc_pg[mc->mc_top]) {
1404 m2->mc_pg[mc->mc_top] = mp;
1408 mc->mc_pg[mc->mc_top] = mp;
1409 /** If this page has a parent, update the parent to point to
1413 SETPGNO(NODEPTR(mc->mc_pg[mc->mc_top-1], mc->mc_ki[mc->mc_top-1]), mp->mp_pgno);
1415 mc->mc_db->md_root = mp->mp_pgno;
1416 } else if (mc->mc_txn->mt_parent) {
1419 /* If txn has a parent, make sure the page is in our
1422 if (mc->mc_txn->mt_u.dirty_list[0].mid) {
1423 unsigned x = mdb_mid2l_search(mc->mc_txn->mt_u.dirty_list, mp->mp_pgno);
1424 if (x <= mc->mc_txn->mt_u.dirty_list[0].mid &&
1425 mc->mc_txn->mt_u.dirty_list[x].mid == mp->mp_pgno) {
1426 if (mc->mc_txn->mt_u.dirty_list[x].mptr != mp) {
1427 mp = mc->mc_txn->mt_u.dirty_list[x].mptr;
1428 mc->mc_pg[mc->mc_top] = mp;
1434 np = mdb_page_malloc(mc);
1435 memcpy(np, mp, mc->mc_txn->mt_env->me_psize);
1436 mid.mid = np->mp_pgno;
1438 mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &mid);
1446 mdb_env_sync(MDB_env *env, int force)
1449 if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
1450 if (MDB_FDATASYNC(env->me_fd))
1456 /** Make shadow copies of all of parent txn's cursors */
1458 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
1460 MDB_cursor *mc, *m2;
1461 unsigned int i, j, size;
1463 for (i=0;i<src->mt_numdbs; i++) {
1464 if (src->mt_cursors[i]) {
1465 size = sizeof(MDB_cursor);
1466 if (src->mt_cursors[i]->mc_xcursor)
1467 size += sizeof(MDB_xcursor);
1468 for (m2 = src->mt_cursors[i]; m2; m2=m2->mc_next) {
1475 mc->mc_db = &dst->mt_dbs[i];
1476 mc->mc_dbx = m2->mc_dbx;
1477 mc->mc_dbflag = &dst->mt_dbflags[i];
1478 mc->mc_snum = m2->mc_snum;
1479 mc->mc_top = m2->mc_top;
1480 mc->mc_flags = m2->mc_flags | C_SHADOW;
1481 for (j=0; j<mc->mc_snum; j++) {
1482 mc->mc_pg[j] = m2->mc_pg[j];
1483 mc->mc_ki[j] = m2->mc_ki[j];
1485 if (m2->mc_xcursor) {
1486 MDB_xcursor *mx, *mx2;
1487 mx = (MDB_xcursor *)(mc+1);
1488 mc->mc_xcursor = mx;
1489 mx2 = m2->mc_xcursor;
1490 mx->mx_db = mx2->mx_db;
1491 mx->mx_dbx = mx2->mx_dbx;
1492 mx->mx_dbflag = mx2->mx_dbflag;
1493 mx->mx_cursor.mc_txn = dst;
1494 mx->mx_cursor.mc_dbi = mx2->mx_cursor.mc_dbi;
1495 mx->mx_cursor.mc_db = &mx->mx_db;
1496 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
1497 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
1498 mx->mx_cursor.mc_snum = mx2->mx_cursor.mc_snum;
1499 mx->mx_cursor.mc_top = mx2->mx_cursor.mc_top;
1500 mx->mx_cursor.mc_flags = mx2->mx_cursor.mc_flags | C_SHADOW;
1501 for (j=0; j<mx2->mx_cursor.mc_snum; j++) {
1502 mx->mx_cursor.mc_pg[j] = mx2->mx_cursor.mc_pg[j];
1503 mx->mx_cursor.mc_ki[j] = mx2->mx_cursor.mc_ki[j];
1506 mc->mc_xcursor = NULL;
1508 mc->mc_next = dst->mt_cursors[i];
1509 dst->mt_cursors[i] = mc;
1516 /** Merge shadow cursors back into parent's */
1518 mdb_cursor_merge(MDB_txn *txn)
1521 for (i=0; i<txn->mt_numdbs; i++) {
1522 if (txn->mt_cursors[i]) {
1524 while ((mc = txn->mt_cursors[i])) {
1525 txn->mt_cursors[i] = mc->mc_next;
1526 if (mc->mc_flags & C_SHADOW) {
1527 MDB_cursor *m2 = mc->mc_orig;
1529 m2->mc_snum = mc->mc_snum;
1530 m2->mc_top = mc->mc_top;
1531 for (j=0; j<mc->mc_snum; j++) {
1532 m2->mc_pg[j] = mc->mc_pg[j];
1533 m2->mc_ki[j] = mc->mc_ki[j];
1536 if (mc->mc_flags & C_ALLOCD)
1544 mdb_txn_reset0(MDB_txn *txn);
1546 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
1547 * @param[in] txn the transaction handle to initialize
1548 * @return 0 on success, non-zero on failure. This can only
1549 * fail for read-only transactions, and then only if the
1550 * reader table is full.
1553 mdb_txn_renew0(MDB_txn *txn)
1555 MDB_env *env = txn->mt_env;
1559 txn->mt_numdbs = env->me_numdbs;
1560 txn->mt_dbxs = env->me_dbxs; /* mostly static anyway */
1562 if (txn->mt_flags & MDB_TXN_RDONLY) {
1563 MDB_reader *r = pthread_getspecific(env->me_txkey);
1565 pid_t pid = getpid();
1566 pthread_t tid = pthread_self();
1569 for (i=0; i<env->me_txns->mti_numreaders; i++)
1570 if (env->me_txns->mti_readers[i].mr_pid == 0)
1572 if (i == env->me_maxreaders) {
1573 UNLOCK_MUTEX_R(env);
1576 env->me_txns->mti_readers[i].mr_pid = pid;
1577 env->me_txns->mti_readers[i].mr_tid = tid;
1578 if (i >= env->me_txns->mti_numreaders)
1579 env->me_txns->mti_numreaders = i+1;
1580 UNLOCK_MUTEX_R(env);
1581 r = &env->me_txns->mti_readers[i];
1582 pthread_setspecific(env->me_txkey, r);
1584 txn->mt_txnid = r->mr_txnid = env->me_txns->mti_txnid;
1585 txn->mt_toggle = txn->mt_txnid & 1;
1586 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1587 txn->mt_u.reader = r;
1591 txn->mt_txnid = env->me_txns->mti_txnid;
1592 txn->mt_toggle = txn->mt_txnid & 1;
1593 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1596 if (txn->mt_txnid == mdb_debug_start)
1599 txn->mt_u.dirty_list = env->me_dirty_list;
1600 txn->mt_u.dirty_list[0].mid = 0;
1601 txn->mt_free_pgs = env->me_free_pgs;
1602 txn->mt_free_pgs[0] = 0;
1606 /* Copy the DB info and flags */
1607 memcpy(txn->mt_dbs, env->me_metas[txn->mt_toggle]->mm_dbs, 2 * sizeof(MDB_db));
1608 for (i=2; i<txn->mt_numdbs; i++)
1609 txn->mt_dbs[i].md_flags = env->me_dbflags[i];
1610 txn->mt_dbflags[0] = txn->mt_dbflags[1] = 0;
1611 if (txn->mt_numdbs > 2)
1612 memset(txn->mt_dbflags+2, DB_STALE, txn->mt_numdbs-2);
1618 mdb_txn_renew(MDB_txn *txn)
1625 if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
1626 DPUTS("environment had fatal error, must shutdown!");
1630 rc = mdb_txn_renew0(txn);
1631 if (rc == MDB_SUCCESS) {
1632 DPRINTF("renew txn %zu%c %p on mdbenv %p, root page %zu",
1633 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1634 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1640 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
1645 if (env->me_flags & MDB_FATAL_ERROR) {
1646 DPUTS("environment had fatal error, must shutdown!");
1650 /* parent already has an active child txn */
1651 if (parent->mt_child) {
1655 size = sizeof(MDB_txn) + env->me_maxdbs * (sizeof(MDB_db)+1);
1656 if (!(flags & MDB_RDONLY))
1657 size += env->me_maxdbs * sizeof(MDB_cursor *);
1659 if ((txn = calloc(1, size)) == NULL) {
1660 DPRINTF("calloc: %s", strerror(ErrCode()));
1663 txn->mt_dbs = (MDB_db *)(txn+1);
1664 if (flags & MDB_RDONLY) {
1665 txn->mt_flags |= MDB_TXN_RDONLY;
1666 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
1668 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
1669 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
1674 txn->mt_free_pgs = mdb_midl_alloc();
1675 if (!txn->mt_free_pgs) {
1679 txn->mt_u.dirty_list = malloc(sizeof(MDB_ID2)*MDB_IDL_UM_SIZE);
1680 if (!txn->mt_u.dirty_list) {
1681 free(txn->mt_free_pgs);
1685 txn->mt_txnid = parent->mt_txnid;
1686 txn->mt_toggle = parent->mt_toggle;
1687 txn->mt_u.dirty_list[0].mid = 0;
1688 txn->mt_free_pgs[0] = 0;
1689 txn->mt_next_pgno = parent->mt_next_pgno;
1690 parent->mt_child = txn;
1691 txn->mt_parent = parent;
1692 txn->mt_numdbs = parent->mt_numdbs;
1693 txn->mt_dbxs = parent->mt_dbxs;
1694 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
1695 memcpy(txn->mt_dbflags, parent->mt_dbflags, txn->mt_numdbs);
1696 mdb_cursor_shadow(parent, txn);
1699 rc = mdb_txn_renew0(txn);
1705 DPRINTF("begin txn %zu%c %p on mdbenv %p, root page %zu",
1706 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1707 (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root);
1713 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
1714 * @param[in] txn the transaction handle to reset
1717 mdb_txn_reset0(MDB_txn *txn)
1719 MDB_env *env = txn->mt_env;
1721 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
1722 txn->mt_u.reader->mr_txnid = 0;
1728 /* close(free) all cursors */
1729 for (i=0; i<txn->mt_numdbs; i++) {
1730 if (txn->mt_cursors[i]) {
1732 while ((mc = txn->mt_cursors[i])) {
1733 txn->mt_cursors[i] = mc->mc_next;
1734 if (mc->mc_flags & C_ALLOCD)
1740 /* return all dirty pages to dpage list */
1741 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
1742 dp = txn->mt_u.dirty_list[i].mptr;
1743 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1744 dp->mp_next = txn->mt_env->me_dpages;
1745 VGMEMP_FREE(txn->mt_env, dp);
1746 txn->mt_env->me_dpages = dp;
1748 /* large pages just get freed directly */
1749 VGMEMP_FREE(txn->mt_env, dp);
1754 if (txn->mt_parent) {
1755 txn->mt_parent->mt_child = NULL;
1756 free(txn->mt_free_pgs);
1757 free(txn->mt_u.dirty_list);
1760 if (mdb_midl_shrink(&txn->mt_free_pgs))
1761 env->me_free_pgs = txn->mt_free_pgs;
1764 while ((mop = txn->mt_env->me_pghead)) {
1765 txn->mt_env->me_pghead = mop->mo_next;
1768 txn->mt_env->me_pgfirst = 0;
1769 txn->mt_env->me_pglast = 0;
1772 /* The writer mutex was locked in mdb_txn_begin. */
1773 UNLOCK_MUTEX_W(env);
1778 mdb_txn_reset(MDB_txn *txn)
1783 DPRINTF("reset txn %zu%c %p on mdbenv %p, root page %zu",
1784 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1785 (void *) txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1787 mdb_txn_reset0(txn);
1791 mdb_txn_abort(MDB_txn *txn)
1796 DPRINTF("abort txn %zu%c %p on mdbenv %p, root page %zu",
1797 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1798 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1801 mdb_txn_abort(txn->mt_child);
1803 mdb_txn_reset0(txn);
1808 mdb_txn_commit(MDB_txn *txn)
1816 pgno_t next, freecnt;
1819 assert(txn != NULL);
1820 assert(txn->mt_env != NULL);
1822 if (txn->mt_child) {
1823 mdb_txn_commit(txn->mt_child);
1824 txn->mt_child = NULL;
1829 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
1830 if (txn->mt_numdbs > env->me_numdbs) {
1831 /* update the DB flags */
1833 for (i = env->me_numdbs; i<txn->mt_numdbs; i++)
1834 env->me_dbflags[i] = txn->mt_dbs[i].md_flags;
1841 if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
1842 DPUTS("error flag is set, can't commit");
1844 txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
1849 /* Merge (and close) our cursors with parent's */
1850 mdb_cursor_merge(txn);
1852 if (txn->mt_parent) {
1858 /* Update parent's DB table */
1859 ip = &txn->mt_parent->mt_dbs[2];
1860 jp = &txn->mt_dbs[2];
1861 for (i = 2; i < txn->mt_numdbs; i++) {
1862 if (ip->md_root != jp->md_root)
1866 txn->mt_parent->mt_numdbs = txn->mt_numdbs;
1868 /* Append our free list to parent's */
1869 mdb_midl_append_list(&txn->mt_parent->mt_free_pgs,
1871 mdb_midl_free(txn->mt_free_pgs);
1873 /* Merge our dirty list with parent's */
1874 dst = txn->mt_parent->mt_u.dirty_list;
1875 src = txn->mt_u.dirty_list;
1876 x = mdb_mid2l_search(dst, src[1].mid);
1877 for (y=1; y<=src[0].mid; y++) {
1878 while (x <= dst[0].mid && dst[x].mid != src[y].mid) x++;
1882 dst[x].mptr = src[y].mptr;
1885 for (; y<=src[0].mid; y++) {
1886 if (++x >= MDB_IDL_UM_MAX) {
1893 free(txn->mt_u.dirty_list);
1894 txn->mt_parent->mt_child = NULL;
1899 if (txn != env->me_txn) {
1900 DPUTS("attempt to commit unknown transaction");
1905 if (!txn->mt_u.dirty_list[0].mid)
1908 DPRINTF("committing txn %zu %p on mdbenv %p, root page %zu",
1909 txn->mt_txnid, (void *)txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root);
1911 /* Update DB root pointers. Their pages have already been
1912 * touched so this is all in-place and cannot fail.
1914 if (txn->mt_numdbs > 2) {
1917 data.mv_size = sizeof(MDB_db);
1919 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
1920 for (i = 2; i < txn->mt_numdbs; i++) {
1921 if (txn->mt_dbflags[i] & DB_DIRTY) {
1922 data.mv_data = &txn->mt_dbs[i];
1923 mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
1928 mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1930 /* should only be one record now */
1931 if (env->me_pghead) {
1932 /* make sure first page of freeDB is touched and on freelist */
1933 mdb_page_search(&mc, NULL, MDB_PS_MODIFY);
1936 /* Delete IDLs we used from the free list */
1937 if (env->me_pgfirst) {
1942 key.mv_size = sizeof(cur);
1943 for (cur = env->me_pgfirst; cur <= env->me_pglast; cur++) {
1946 mdb_cursor_set(&mc, &key, NULL, MDB_SET, &exact);
1947 rc = mdb_cursor_del(&mc, 0);
1953 env->me_pgfirst = 0;
1957 /* save to free list */
1959 freecnt = txn->mt_free_pgs[0];
1960 if (!MDB_IDL_IS_ZERO(txn->mt_free_pgs)) {
1963 /* make sure last page of freeDB is touched and on freelist */
1964 key.mv_size = MAXKEYSIZE+1;
1966 mdb_page_search(&mc, &key, MDB_PS_MODIFY);
1968 mdb_midl_sort(txn->mt_free_pgs);
1972 MDB_IDL idl = txn->mt_free_pgs;
1973 DPRINTF("IDL write txn %zu root %zu num %zu",
1974 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
1975 for (i=0; i<idl[0]; i++) {
1976 DPRINTF("IDL %zu", idl[i+1]);
1980 /* write to last page of freeDB */
1981 key.mv_size = sizeof(pgno_t);
1982 key.mv_data = &txn->mt_txnid;
1983 data.mv_data = txn->mt_free_pgs;
1984 /* The free list can still grow during this call,
1985 * despite the pre-emptive touches above. So check
1986 * and make sure the entire thing got written.
1989 freecnt = txn->mt_free_pgs[0];
1990 data.mv_size = MDB_IDL_SIZEOF(txn->mt_free_pgs);
1991 rc = mdb_cursor_put(&mc, &key, &data, 0);
1996 } while (freecnt != txn->mt_free_pgs[0]);
1998 /* should only be one record now */
2000 if (env->me_pghead) {
2006 mop = env->me_pghead;
2008 key.mv_size = sizeof(id);
2010 data.mv_size = MDB_IDL_SIZEOF(mop->mo_pages);
2011 data.mv_data = mop->mo_pages;
2012 orig = mop->mo_pages[0];
2013 /* These steps may grow the freelist again
2014 * due to freed overflow pages...
2016 mdb_cursor_put(&mc, &key, &data, 0);
2017 if (mop == env->me_pghead && env->me_pghead->mo_txnid == id) {
2018 /* could have been used again here */
2019 if (mop->mo_pages[0] != orig) {
2020 data.mv_size = MDB_IDL_SIZEOF(mop->mo_pages);
2021 data.mv_data = mop->mo_pages;
2023 mdb_cursor_put(&mc, &key, &data, 0);
2025 env->me_pghead = NULL;
2028 /* was completely used up */
2029 mdb_cursor_del(&mc, 0);
2033 env->me_pgfirst = 0;
2037 while (env->me_pgfree) {
2038 MDB_oldpages *mop = env->me_pgfree;
2039 env->me_pgfree = mop->mo_next;
2043 /* Check for growth of freelist again */
2044 if (freecnt != txn->mt_free_pgs[0])
2047 if (!MDB_IDL_IS_ZERO(txn->mt_free_pgs)) {
2048 if (mdb_midl_shrink(&txn->mt_free_pgs))
2049 env->me_free_pgs = txn->mt_free_pgs;
2056 /* Commit up to MDB_COMMIT_PAGES dirty pages to disk until done.
2062 /* Windows actually supports scatter/gather I/O, but only on
2063 * unbuffered file handles. Since we're relying on the OS page
2064 * cache for all our data, that's self-defeating. So we just
2065 * write pages one at a time. We use the ov structure to set
2066 * the write offset, to at least save the overhead of a Seek
2070 memset(&ov, 0, sizeof(ov));
2071 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2073 dp = txn->mt_u.dirty_list[i].mptr;
2074 DPRINTF("committing page %zu", dp->mp_pgno);
2075 size = dp->mp_pgno * env->me_psize;
2076 ov.Offset = size & 0xffffffff;
2077 ov.OffsetHigh = size >> 16;
2078 ov.OffsetHigh >>= 16;
2079 /* clear dirty flag */
2080 dp->mp_flags &= ~P_DIRTY;
2081 wsize = env->me_psize;
2082 if (IS_OVERFLOW(dp)) wsize *= dp->mp_pages;
2083 rc = WriteFile(env->me_fd, dp, wsize, NULL, &ov);
2086 DPRINTF("WriteFile: %d", n);
2093 struct iovec iov[MDB_COMMIT_PAGES];
2097 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2098 dp = txn->mt_u.dirty_list[i].mptr;
2099 if (dp->mp_pgno != next) {
2101 rc = writev(env->me_fd, iov, n);
2105 DPUTS("short write, filesystem full?");
2107 DPRINTF("writev: %s", strerror(n));
2114 lseek(env->me_fd, dp->mp_pgno * env->me_psize, SEEK_SET);
2117 DPRINTF("committing page %zu", dp->mp_pgno);
2118 iov[n].iov_len = env->me_psize;
2119 if (IS_OVERFLOW(dp)) iov[n].iov_len *= dp->mp_pages;
2120 iov[n].iov_base = (char *)dp;
2121 size += iov[n].iov_len;
2122 next = dp->mp_pgno + (IS_OVERFLOW(dp) ? dp->mp_pages : 1);
2123 /* clear dirty flag */
2124 dp->mp_flags &= ~P_DIRTY;
2125 if (++n >= MDB_COMMIT_PAGES) {
2135 rc = writev(env->me_fd, iov, n);
2139 DPUTS("short write, filesystem full?");
2141 DPRINTF("writev: %s", strerror(n));
2148 /* Drop the dirty pages.
2150 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2151 dp = txn->mt_u.dirty_list[i].mptr;
2152 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2153 dp->mp_next = txn->mt_env->me_dpages;
2154 VGMEMP_FREE(txn->mt_env, dp);
2155 txn->mt_env->me_dpages = dp;
2157 VGMEMP_FREE(txn->mt_env, dp);
2160 txn->mt_u.dirty_list[i].mid = 0;
2162 txn->mt_u.dirty_list[0].mid = 0;
2164 if ((n = mdb_env_sync(env, 0)) != 0 ||
2165 (n = mdb_env_write_meta(txn)) != MDB_SUCCESS) {
2172 if (txn->mt_numdbs > env->me_numdbs) {
2173 /* update the DB flags */
2175 for (i = env->me_numdbs; i<txn->mt_numdbs; i++)
2176 env->me_dbflags[i] = txn->mt_dbs[i].md_flags;
2180 UNLOCK_MUTEX_W(env);
2186 /** Read the environment parameters of a DB environment before
2187 * mapping it into memory.
2188 * @param[in] env the environment handle
2189 * @param[out] meta address of where to store the meta information
2190 * @return 0 on success, non-zero on failure.
2193 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
2200 /* We don't know the page size yet, so use a minimum value.
2204 if (!ReadFile(env->me_fd, &pbuf, MDB_PAGESIZE, (DWORD *)&rc, NULL) || rc == 0)
2206 if ((rc = read(env->me_fd, &pbuf, MDB_PAGESIZE)) == 0)
2211 else if (rc != MDB_PAGESIZE) {
2215 DPRINTF("read: %s", strerror(err));
2219 p = (MDB_page *)&pbuf;
2221 if (!F_ISSET(p->mp_flags, P_META)) {
2222 DPRINTF("page %zu not a meta page", p->mp_pgno);
2227 if (m->mm_magic != MDB_MAGIC) {
2228 DPUTS("meta has invalid magic");
2232 if (m->mm_version != MDB_VERSION) {
2233 DPRINTF("database is version %u, expected version %u",
2234 m->mm_version, MDB_VERSION);
2235 return MDB_VERSION_MISMATCH;
2238 memcpy(meta, m, sizeof(*m));
2242 /** Write the environment parameters of a freshly created DB environment.
2243 * @param[in] env the environment handle
2244 * @param[out] meta address of where to store the meta information
2245 * @return 0 on success, non-zero on failure.
2248 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
2255 DPUTS("writing new meta page");
2257 GET_PAGESIZE(psize);
2259 meta->mm_magic = MDB_MAGIC;
2260 meta->mm_version = MDB_VERSION;
2261 meta->mm_psize = psize;
2262 meta->mm_last_pg = 1;
2263 meta->mm_flags = env->me_flags & 0xffff;
2264 meta->mm_flags |= MDB_INTEGERKEY;
2265 meta->mm_dbs[0].md_root = P_INVALID;
2266 meta->mm_dbs[1].md_root = P_INVALID;
2268 p = calloc(2, psize);
2270 p->mp_flags = P_META;
2273 memcpy(m, meta, sizeof(*meta));
2275 q = (MDB_page *)((char *)p + psize);
2278 q->mp_flags = P_META;
2281 memcpy(m, meta, sizeof(*meta));
2286 rc = WriteFile(env->me_fd, p, psize * 2, &len, NULL);
2287 rc = (len == psize * 2) ? MDB_SUCCESS : ErrCode();
2290 rc = write(env->me_fd, p, psize * 2);
2291 rc = (rc == (int)psize * 2) ? MDB_SUCCESS : ErrCode();
2297 /** Update the environment info to commit a transaction.
2298 * @param[in] txn the transaction that's being committed
2299 * @return 0 on success, non-zero on failure.
2302 mdb_env_write_meta(MDB_txn *txn)
2305 MDB_meta meta, metab;
2307 int rc, len, toggle;
2313 assert(txn != NULL);
2314 assert(txn->mt_env != NULL);
2316 toggle = !txn->mt_toggle;
2317 DPRINTF("writing meta page %d for root page %zu",
2318 toggle, txn->mt_dbs[MAIN_DBI].md_root);
2322 metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
2323 metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
2325 ptr = (char *)&meta;
2326 off = offsetof(MDB_meta, mm_dbs[0].md_depth);
2327 len = sizeof(MDB_meta) - off;
2330 meta.mm_dbs[0] = txn->mt_dbs[0];
2331 meta.mm_dbs[1] = txn->mt_dbs[1];
2332 meta.mm_last_pg = txn->mt_next_pgno - 1;
2333 meta.mm_txnid = txn->mt_txnid;
2336 off += env->me_psize;
2339 /* Write to the SYNC fd */
2342 memset(&ov, 0, sizeof(ov));
2344 WriteFile(env->me_mfd, ptr, len, (DWORD *)&rc, &ov);
2347 rc = pwrite(env->me_mfd, ptr, len, off);
2352 DPUTS("write failed, disk error?");
2353 /* On a failure, the pagecache still contains the new data.
2354 * Write some old data back, to prevent it from being used.
2355 * Use the non-SYNC fd; we know it will fail anyway.
2357 meta.mm_last_pg = metab.mm_last_pg;
2358 meta.mm_txnid = metab.mm_txnid;
2360 WriteFile(env->me_fd, ptr, len, NULL, &ov);
2362 r2 = pwrite(env->me_fd, ptr, len, off);
2364 env->me_flags |= MDB_FATAL_ERROR;
2367 /* Memory ordering issues are irrelevant; since the entire writer
2368 * is wrapped by wmutex, all of these changes will become visible
2369 * after the wmutex is unlocked. Since the DB is multi-version,
2370 * readers will get consistent data regardless of how fresh or
2371 * how stale their view of these values is.
2373 txn->mt_env->me_txns->mti_txnid = txn->mt_txnid;
2378 /** Check both meta pages to see which one is newer.
2379 * @param[in] env the environment handle
2380 * @return meta toggle (0 or 1).
2383 mdb_env_pick_meta(const MDB_env *env)
2385 return (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid);
2389 mdb_env_create(MDB_env **env)
2393 e = calloc(1, sizeof(MDB_env));
2397 e->me_free_pgs = mdb_midl_alloc();
2398 if (!e->me_free_pgs) {
2402 e->me_maxreaders = DEFAULT_READERS;
2404 e->me_fd = INVALID_HANDLE_VALUE;
2405 e->me_lfd = INVALID_HANDLE_VALUE;
2406 e->me_mfd = INVALID_HANDLE_VALUE;
2407 VGMEMP_CREATE(e,0,0);
2413 mdb_env_set_mapsize(MDB_env *env, size_t size)
2417 env->me_mapsize = size;
2419 env->me_maxpg = env->me_mapsize / env->me_psize;
2424 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
2428 env->me_maxdbs = dbs;
2433 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
2435 if (env->me_map || readers < 1)
2437 env->me_maxreaders = readers;
2442 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
2444 if (!env || !readers)
2446 *readers = env->me_maxreaders;
2450 /** Further setup required for opening an MDB environment
2453 mdb_env_open2(MDB_env *env, unsigned int flags)
2459 env->me_flags = flags;
2461 memset(&meta, 0, sizeof(meta));
2463 if ((i = mdb_env_read_header(env, &meta)) != 0) {
2466 DPUTS("new mdbenv");
2470 if (!env->me_mapsize) {
2471 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
2477 LONG sizelo, sizehi;
2478 sizelo = env->me_mapsize & 0xffffffff;
2479 sizehi = env->me_mapsize >> 16; /* pointless on WIN32, only needed on W64 */
2481 /* Windows won't create mappings for zero length files.
2482 * Just allocate the maxsize right now.
2485 SetFilePointer(env->me_fd, sizelo, sizehi ? &sizehi : NULL, 0);
2486 if (!SetEndOfFile(env->me_fd))
2488 SetFilePointer(env->me_fd, 0, NULL, 0);
2490 mh = CreateFileMapping(env->me_fd, NULL, PAGE_READONLY,
2491 sizehi, sizelo, NULL);
2494 env->me_map = MapViewOfFileEx(mh, FILE_MAP_READ, 0, 0, env->me_mapsize,
2502 if (meta.mm_address && (flags & MDB_FIXEDMAP))
2504 env->me_map = mmap(meta.mm_address, env->me_mapsize, PROT_READ, i,
2506 if (env->me_map == MAP_FAILED) {
2513 meta.mm_mapsize = env->me_mapsize;
2514 if (flags & MDB_FIXEDMAP)
2515 meta.mm_address = env->me_map;
2516 i = mdb_env_init_meta(env, &meta);
2517 if (i != MDB_SUCCESS) {
2518 munmap(env->me_map, env->me_mapsize);
2522 env->me_psize = meta.mm_psize;
2524 env->me_maxpg = env->me_mapsize / env->me_psize;
2526 p = (MDB_page *)env->me_map;
2527 env->me_metas[0] = METADATA(p);
2528 env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + meta.mm_psize);
2532 int toggle = mdb_env_pick_meta(env);
2533 MDB_db *db = &env->me_metas[toggle]->mm_dbs[MAIN_DBI];
2535 DPRINTF("opened database version %u, pagesize %u",
2536 env->me_metas[0]->mm_version, env->me_psize);
2537 DPRINTF("using meta page %d", toggle);
2538 DPRINTF("depth: %u", db->md_depth);
2539 DPRINTF("entries: %zu", db->md_entries);
2540 DPRINTF("branch pages: %zu", db->md_branch_pages);
2541 DPRINTF("leaf pages: %zu", db->md_leaf_pages);
2542 DPRINTF("overflow pages: %zu", db->md_overflow_pages);
2543 DPRINTF("root: %zu", db->md_root);
2551 /** Release a reader thread's slot in the reader lock table.
2552 * This function is called automatically when a thread exits.
2553 * @param[in] ptr This points to the slot in the reader lock table.
2556 mdb_env_reader_dest(void *ptr)
2558 MDB_reader *reader = ptr;
2560 reader->mr_txnid = 0;
2566 /** Junk for arranging thread-specific callbacks on Windows. This is
2567 * necessarily platform and compiler-specific. Windows supports up
2568 * to 1088 keys. Let's assume nobody opens more than 64 environments
2569 * in a single process, for now. They can override this if needed.
2571 #ifndef MAX_TLS_KEYS
2572 #define MAX_TLS_KEYS 64
2574 static pthread_key_t mdb_tls_keys[MAX_TLS_KEYS];
2575 static int mdb_tls_nkeys;
2577 static void NTAPI mdb_tls_callback(PVOID module, DWORD reason, PVOID ptr)
2581 case DLL_PROCESS_ATTACH: break;
2582 case DLL_THREAD_ATTACH: break;
2583 case DLL_THREAD_DETACH:
2584 for (i=0; i<mdb_tls_nkeys; i++) {
2585 MDB_reader *r = pthread_getspecific(mdb_tls_keys[i]);
2586 mdb_env_reader_dest(r);
2589 case DLL_PROCESS_DETACH: break;
2594 const PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
2596 PIMAGE_TLS_CALLBACK mdb_tls_cbp __attribute__((section (".CRT$XLB"))) = mdb_tls_callback;
2600 /* Force some symbol references.
2601 * _tls_used forces the linker to create the TLS directory if not already done
2602 * mdb_tls_cbp prevents whole-program-optimizer from dropping the symbol.
2604 #pragma comment(linker, "/INCLUDE:_tls_used")
2605 #pragma comment(linker, "/INCLUDE:mdb_tls_cbp")
2606 #pragma const_seg(".CRT$XLB")
2607 extern const PIMAGE_TLS_CALLBACK mdb_tls_callback;
2608 const PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
2611 #pragma comment(linker, "/INCLUDE:__tls_used")
2612 #pragma comment(linker, "/INCLUDE:_mdb_tls_cbp")
2613 #pragma data_seg(".CRT$XLB")
2614 PIMAGE_TLS_CALLBACK mdb_tls_cbp = mdb_tls_callback;
2616 #endif /* WIN 32/64 */
2617 #endif /* !__GNUC__ */
2620 /** Downgrade the exclusive lock on the region back to shared */
2622 mdb_env_share_locks(MDB_env *env)
2624 int toggle = mdb_env_pick_meta(env);
2626 env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
2631 /* First acquire a shared lock. The Unlock will
2632 * then release the existing exclusive lock.
2634 memset(&ov, 0, sizeof(ov));
2635 LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov);
2636 UnlockFile(env->me_lfd, 0, 0, 1, 0);
2640 struct flock lock_info;
2641 /* The shared lock replaces the existing lock */
2642 memset((void *)&lock_info, 0, sizeof(lock_info));
2643 lock_info.l_type = F_RDLCK;
2644 lock_info.l_whence = SEEK_SET;
2645 lock_info.l_start = 0;
2646 lock_info.l_len = 1;
2647 fcntl(env->me_lfd, F_SETLK, &lock_info);
2653 mdb_env_excl_lock(MDB_env *env, int *excl)
2656 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
2660 memset(&ov, 0, sizeof(ov));
2661 if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
2666 struct flock lock_info;
2667 memset((void *)&lock_info, 0, sizeof(lock_info));
2668 lock_info.l_type = F_WRLCK;
2669 lock_info.l_whence = SEEK_SET;
2670 lock_info.l_start = 0;
2671 lock_info.l_len = 1;
2672 if (!fcntl(env->me_lfd, F_SETLK, &lock_info)) {
2675 lock_info.l_type = F_RDLCK;
2676 if (fcntl(env->me_lfd, F_SETLKW, &lock_info)) {
2684 #if defined(_WIN32) || defined(USE_POSIX_SEM)
2686 * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
2688 * @(#) $Revision: 5.1 $
2689 * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
2690 * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
2692 * http://www.isthe.com/chongo/tech/comp/fnv/index.html
2696 * Please do not copyright this code. This code is in the public domain.
2698 * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
2699 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
2700 * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
2701 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
2702 * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
2703 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2704 * PERFORMANCE OF THIS SOFTWARE.
2707 * chongo <Landon Curt Noll> /\oo/\
2708 * http://www.isthe.com/chongo/
2710 * Share and Enjoy! :-)
2713 typedef unsigned long long mdb_hash_t;
2714 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
2716 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
2717 * @param[in] str string to hash
2718 * @param[in] hval initial value for hash
2719 * @return 64 bit hash
2721 * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
2722 * hval arg on the first call.
2725 mdb_hash_val(MDB_val *val, mdb_hash_t hval)
2727 unsigned char *s = (unsigned char *)val->mv_data; /* unsigned string */
2728 unsigned char *end = s + val->mv_size;
2730 * FNV-1a hash each octet of the string
2733 /* xor the bottom with the current octet */
2734 hval ^= (mdb_hash_t)*s++;
2736 /* multiply by the 64 bit FNV magic prime mod 2^64 */
2737 hval += (hval << 1) + (hval << 4) + (hval << 5) +
2738 (hval << 7) + (hval << 8) + (hval << 40);
2740 /* return our new hash value */
2744 /** Hash the string and output the hash in hex.
2745 * @param[in] str string to hash
2746 * @param[out] hexbuf an array of 17 chars to hold the hash
2749 mdb_hash_hex(MDB_val *val, char *hexbuf)
2752 mdb_hash_t h = mdb_hash_val(val, MDB_HASH_INIT);
2753 for (i=0; i<8; i++) {
2754 hexbuf += sprintf(hexbuf, "%02x", (unsigned int)h & 0xff);
2760 /** Open and/or initialize the lock region for the environment.
2761 * @param[in] env The MDB environment.
2762 * @param[in] lpath The pathname of the file used for the lock region.
2763 * @param[in] mode The Unix permissions for the file, if we create it.
2764 * @param[out] excl Set to true if we got an exclusive lock on the region.
2765 * @return 0 on success, non-zero on failure.
2768 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
2776 if ((env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
2777 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
2778 FILE_ATTRIBUTE_NORMAL, NULL)) == INVALID_HANDLE_VALUE) {
2782 /* Try to get exclusive lock. If we succeed, then
2783 * nobody is using the lock region and we should initialize it.
2785 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
2786 size = GetFileSize(env->me_lfd, NULL);
2792 if ((env->me_lfd = open(lpath, O_RDWR|O_CREAT, mode)) == -1)
2794 /* Lose record locks when exec*() */
2795 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
2796 fcntl(env->me_lfd, F_SETFD, fdflags);
2798 #else /* O_CLOEXEC on Linux: Open file and set FD_CLOEXEC atomically */
2799 if ((env->me_lfd = open(lpath, O_RDWR|O_CREAT|O_CLOEXEC, mode)) == -1)
2803 /* Try to get exclusive lock. If we succeed, then
2804 * nobody is using the lock region and we should initialize it.
2806 if ((rc = mdb_env_excl_lock(env, excl))) goto fail;
2808 size = lseek(env->me_lfd, 0, SEEK_END);
2810 rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
2811 if (size < rsize && *excl) {
2813 SetFilePointer(env->me_lfd, rsize, NULL, 0);
2814 if (!SetEndOfFile(env->me_lfd)) {
2819 if (ftruncate(env->me_lfd, rsize) != 0) {
2826 size = rsize - sizeof(MDB_txninfo);
2827 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
2832 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
2838 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
2840 if (!env->me_txns) {
2845 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
2847 if (m == MAP_FAILED) {
2848 env->me_txns = NULL;
2857 BY_HANDLE_FILE_INFORMATION stbuf;
2866 if (!mdb_sec_inited) {
2867 InitializeSecurityDescriptor(&mdb_null_sd,
2868 SECURITY_DESCRIPTOR_REVISION);
2869 SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
2870 mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
2871 mdb_all_sa.bInheritHandle = FALSE;
2872 mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
2875 GetFileInformationByHandle(env->me_lfd, &stbuf);
2876 idbuf.volume = stbuf.dwVolumeSerialNumber;
2877 idbuf.nhigh = stbuf.nFileIndexHigh;
2878 idbuf.nlow = stbuf.nFileIndexLow;
2879 val.mv_data = &idbuf;
2880 val.mv_size = sizeof(idbuf);
2881 mdb_hash_hex(&val, hexbuf);
2882 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", hexbuf);
2883 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
2884 if (!env->me_rmutex) {
2888 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", hexbuf);
2889 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
2890 if (!env->me_wmutex) {
2895 #ifdef USE_POSIX_SEM
2904 fstat(env->me_lfd, &stbuf);
2905 idbuf.dev = stbuf.st_dev;
2906 idbuf.ino = stbuf.st_ino;
2907 val.mv_data = &idbuf;
2908 val.mv_size = sizeof(idbuf);
2909 mdb_hash_hex(&val, hexbuf);
2910 sprintf(env->me_txns->mti_rmname, "/MDBr%s", hexbuf);
2911 if (sem_unlink(env->me_txns->mti_rmname)) {
2913 if (rc != ENOENT && rc != EINVAL)
2916 env->me_rmutex = sem_open(env->me_txns->mti_rmname, O_CREAT, mode, 1);
2917 if (!env->me_rmutex) {
2921 sprintf(env->me_txns->mti_wmname, "/MDBw%s", hexbuf);
2922 if (sem_unlink(env->me_txns->mti_wmname)) {
2924 if (rc != ENOENT && rc != EINVAL)
2927 env->me_wmutex = sem_open(env->me_txns->mti_wmname, O_CREAT, mode, 1);
2928 if (!env->me_wmutex) {
2932 #else /* USE_POSIX_SEM */
2933 pthread_mutexattr_t mattr;
2935 pthread_mutexattr_init(&mattr);
2936 rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED);
2940 pthread_mutex_init(&env->me_txns->mti_mutex, &mattr);
2941 pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr);
2942 #endif /* USE_POSIX_SEM */
2944 env->me_txns->mti_version = MDB_VERSION;
2945 env->me_txns->mti_magic = MDB_MAGIC;
2946 env->me_txns->mti_txnid = 0;
2947 env->me_txns->mti_numreaders = 0;
2950 if (env->me_txns->mti_magic != MDB_MAGIC) {
2951 DPUTS("lock region has invalid magic");
2955 if (env->me_txns->mti_version != MDB_VERSION) {
2956 DPRINTF("lock region is version %u, expected version %u",
2957 env->me_txns->mti_version, MDB_VERSION);
2958 rc = MDB_VERSION_MISMATCH;
2962 if (rc != EACCES && rc != EAGAIN) {
2966 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
2967 if (!env->me_rmutex) {
2971 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
2972 if (!env->me_wmutex) {
2977 #ifdef USE_POSIX_SEM
2978 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
2979 if (!env->me_rmutex) {
2983 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
2984 if (!env->me_wmutex) {
2994 env->me_lfd = INVALID_HANDLE_VALUE;
2999 /** The name of the lock file in the DB environment */
3000 #define LOCKNAME "/lock.mdb"
3001 /** The name of the data file in the DB environment */
3002 #define DATANAME "/data.mdb"
3003 /** The suffix of the lock file when no subdir is used */
3004 #define LOCKSUFF "-lock"
3007 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mode_t mode)
3009 int oflags, rc, len, excl;
3010 char *lpath, *dpath;
3013 if (flags & MDB_NOSUBDIR) {
3014 rc = len + sizeof(LOCKSUFF) + len + 1;
3016 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
3021 if (flags & MDB_NOSUBDIR) {
3022 dpath = lpath + len + sizeof(LOCKSUFF);
3023 sprintf(lpath, "%s" LOCKSUFF, path);
3024 strcpy(dpath, path);
3026 dpath = lpath + len + sizeof(LOCKNAME);
3027 sprintf(lpath, "%s" LOCKNAME, path);
3028 sprintf(dpath, "%s" DATANAME, path);
3031 rc = mdb_env_setup_locks(env, lpath, mode, &excl);
3036 if (F_ISSET(flags, MDB_RDONLY)) {
3037 oflags = GENERIC_READ;
3038 len = OPEN_EXISTING;
3040 oflags = GENERIC_READ|GENERIC_WRITE;
3043 mode = FILE_ATTRIBUTE_NORMAL;
3044 env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
3045 NULL, len, mode, NULL);
3047 if (F_ISSET(flags, MDB_RDONLY))
3050 oflags = O_RDWR | O_CREAT;
3052 env->me_fd = open(dpath, oflags, mode);
3054 if (env->me_fd == INVALID_HANDLE_VALUE) {
3059 if ((rc = mdb_env_open2(env, flags)) == MDB_SUCCESS) {
3060 if (flags & (MDB_RDONLY|MDB_NOSYNC|MDB_NOMETASYNC)) {
3061 env->me_mfd = env->me_fd;
3063 /* synchronous fd for meta writes */
3065 env->me_mfd = CreateFile(dpath, oflags,
3066 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
3067 mode | FILE_FLAG_WRITE_THROUGH, NULL);
3069 env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
3071 if (env->me_mfd == INVALID_HANDLE_VALUE) {
3076 env->me_path = strdup(path);
3077 DPRINTF("opened dbenv %p", (void *) env);
3078 pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
3080 /* Windows TLS callbacks need help finding their TLS info. */
3081 if (mdb_tls_nkeys < MAX_TLS_KEYS)
3082 mdb_tls_keys[mdb_tls_nkeys++] = env->me_txkey;
3089 mdb_env_share_locks(env);
3091 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
3092 env->me_dbflags = calloc(env->me_maxdbs, sizeof(uint16_t));
3093 if (!env->me_dbxs || !env->me_dbflags)
3099 if (env->me_fd != INVALID_HANDLE_VALUE) {
3101 env->me_fd = INVALID_HANDLE_VALUE;
3103 if (env->me_lfd != INVALID_HANDLE_VALUE) {
3105 env->me_lfd = INVALID_HANDLE_VALUE;
3113 mdb_env_close(MDB_env *env)
3120 VGMEMP_DESTROY(env);
3121 while (env->me_dpages) {
3122 dp = env->me_dpages;
3123 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
3124 env->me_dpages = dp->mp_next;
3128 free(env->me_dbflags);
3132 pthread_key_delete(env->me_txkey);
3134 /* Delete our key from the global list */
3136 for (i=0; i<mdb_tls_nkeys; i++)
3137 if (mdb_tls_keys[i] == env->me_txkey) {
3138 mdb_tls_keys[i] = mdb_tls_keys[mdb_tls_nkeys-1];
3146 munmap(env->me_map, env->me_mapsize);
3148 if (env->me_mfd != env->me_fd)
3152 pid_t pid = getpid();
3154 for (i=0; i<env->me_txns->mti_numreaders; i++)
3155 if (env->me_txns->mti_readers[i].mr_pid == pid)
3156 env->me_txns->mti_readers[i].mr_pid = 0;
3157 #ifdef USE_POSIX_SEM
3159 if (!mdb_env_excl_lock(env, &excl) && excl) {
3160 /* we are the only remaining user of the environment.
3161 clean up semaphores. */
3162 sem_unlink(env->me_txns->mti_rmname);
3163 sem_unlink(env->me_txns->mti_wmname);
3167 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
3170 mdb_midl_free(env->me_free_pgs);
3174 /** Compare two items pointing at aligned size_t's */
3176 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
3178 return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
3179 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
3182 /** Compare two items pointing at aligned int's */
3184 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
3186 return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
3187 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
3190 /** Compare two items pointing at ints of unknown alignment.
3191 * Nodes and keys are guaranteed to be 2-byte aligned.
3194 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
3196 #if BYTE_ORDER == LITTLE_ENDIAN
3197 unsigned short *u, *c;
3200 u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
3201 c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
3204 } while(!x && u > (unsigned short *)a->mv_data);
3207 return memcmp(a->mv_data, b->mv_data, a->mv_size);
3211 /** Compare two items lexically */
3213 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
3220 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3226 diff = memcmp(a->mv_data, b->mv_data, len);
3227 return diff ? diff : len_diff<0 ? -1 : len_diff;
3230 /** Compare two items in reverse byte order */
3232 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
3234 const unsigned char *p1, *p2, *p1_lim;
3238 p1_lim = (const unsigned char *)a->mv_data;
3239 p1 = (const unsigned char *)a->mv_data + a->mv_size;
3240 p2 = (const unsigned char *)b->mv_data + b->mv_size;
3242 len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3248 while (p1 > p1_lim) {
3249 diff = *--p1 - *--p2;
3253 return len_diff<0 ? -1 : len_diff;
3256 /** Search for key within a page, using binary search.
3257 * Returns the smallest entry larger or equal to the key.
3258 * If exactp is non-null, stores whether the found entry was an exact match
3259 * in *exactp (1 or 0).
3260 * Updates the cursor index with the index of the found entry.
3261 * If no entry larger or equal to the key is found, returns NULL.
3264 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
3266 unsigned int i = 0, nkeys;
3269 MDB_page *mp = mc->mc_pg[mc->mc_top];
3270 MDB_node *node = NULL;
3275 nkeys = NUMKEYS(mp);
3280 COPY_PGNO(pgno, mp->mp_pgno);
3281 DPRINTF("searching %u keys in %s %spage %zu",
3282 nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
3289 low = IS_LEAF(mp) ? 0 : 1;
3291 cmp = mc->mc_dbx->md_cmp;
3293 /* Branch pages have no data, so if using integer keys,
3294 * alignment is guaranteed. Use faster mdb_cmp_int.
3296 if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
3297 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
3304 nodekey.mv_size = mc->mc_db->md_pad;
3305 node = NODEPTR(mp, 0); /* fake */
3306 while (low <= high) {
3307 i = (low + high) >> 1;
3308 nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
3309 rc = cmp(key, &nodekey);
3310 DPRINTF("found leaf index %u [%s], rc = %i",
3311 i, DKEY(&nodekey), rc);
3320 while (low <= high) {
3321 i = (low + high) >> 1;
3323 node = NODEPTR(mp, i);
3324 nodekey.mv_size = NODEKSZ(node);
3325 nodekey.mv_data = NODEKEY(node);
3327 rc = cmp(key, &nodekey);
3330 DPRINTF("found leaf index %u [%s], rc = %i",
3331 i, DKEY(&nodekey), rc);
3333 DPRINTF("found branch index %u [%s -> %zu], rc = %i",
3334 i, DKEY(&nodekey), NODEPGNO(node), rc);
3345 if (rc > 0) { /* Found entry is less than the key. */
3346 i++; /* Skip to get the smallest entry larger than key. */
3348 node = NODEPTR(mp, i);
3351 *exactp = (rc == 0);
3352 /* store the key index */
3353 mc->mc_ki[mc->mc_top] = i;
3355 /* There is no entry larger or equal to the key. */
3358 /* nodeptr is fake for LEAF2 */
3364 mdb_cursor_adjust(MDB_cursor *mc, func)
3368 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
3369 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
3376 /** Pop a page off the top of the cursor's stack. */
3378 mdb_cursor_pop(MDB_cursor *mc)
3382 MDB_page *top = mc->mc_pg[mc->mc_top];
3388 DPRINTF("popped page %zu off db %u cursor %p", top->mp_pgno,
3389 mc->mc_dbi, (void *) mc);
3393 /** Push a page onto the top of the cursor's stack. */
3395 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
3397 DPRINTF("pushing page %zu on db %u cursor %p", mp->mp_pgno,
3398 mc->mc_dbi, (void *) mc);
3400 if (mc->mc_snum >= CURSOR_STACK) {
3401 assert(mc->mc_snum < CURSOR_STACK);
3405 mc->mc_top = mc->mc_snum++;
3406 mc->mc_pg[mc->mc_top] = mp;
3407 mc->mc_ki[mc->mc_top] = 0;
3412 /** Find the address of the page corresponding to a given page number.
3413 * @param[in] txn the transaction for this access.
3414 * @param[in] pgno the page number for the page to retrieve.
3415 * @param[out] ret address of a pointer where the page's address will be stored.
3416 * @return 0 on success, non-zero on failure.
3419 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret)
3423 if (!F_ISSET(txn->mt_flags, MDB_TXN_RDONLY) && txn->mt_u.dirty_list[0].mid) {
3425 x = mdb_mid2l_search(txn->mt_u.dirty_list, pgno);
3426 if (x <= txn->mt_u.dirty_list[0].mid && txn->mt_u.dirty_list[x].mid == pgno) {
3427 p = txn->mt_u.dirty_list[x].mptr;
3431 if (pgno < txn->mt_next_pgno)
3432 p = (MDB_page *)(txn->mt_env->me_map + txn->mt_env->me_psize * pgno);
3436 DPRINTF("page %zu not found", pgno);
3439 return (p != NULL) ? MDB_SUCCESS : MDB_PAGE_NOTFOUND;
3442 /** Search for the page a given key should be in.
3443 * Pushes parent pages on the cursor stack. This function continues a
3444 * search on a cursor that has already been initialized. (Usually by
3445 * #mdb_page_search() but also by #mdb_node_move().)
3446 * @param[in,out] mc the cursor for this operation.
3447 * @param[in] key the key to search for. If NULL, search for the lowest
3448 * page. (This is used by #mdb_cursor_first().)
3449 * @param[in] flags If MDB_PS_MODIFY set, visited pages are updated with new page numbers.
3450 * If MDB_PS_ROOTONLY set, just fetch root node, no further lookups.
3451 * @return 0 on success, non-zero on failure.
3454 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int modify)
3456 MDB_page *mp = mc->mc_pg[mc->mc_top];
3461 while (IS_BRANCH(mp)) {
3465 DPRINTF("branch page %zu has %u keys", mp->mp_pgno, NUMKEYS(mp));
3466 assert(NUMKEYS(mp) > 1);
3467 DPRINTF("found index 0 to page %zu", NODEPGNO(NODEPTR(mp, 0)));
3469 if (key == NULL) /* Initialize cursor to first page. */
3471 else if (key->mv_size > MAXKEYSIZE && key->mv_data == NULL) {
3472 /* cursor to last page */
3476 node = mdb_node_search(mc, key, &exact);
3478 i = NUMKEYS(mp) - 1;
3480 i = mc->mc_ki[mc->mc_top];
3489 DPRINTF("following index %u for key [%s]",
3491 assert(i < NUMKEYS(mp));
3492 node = NODEPTR(mp, i);
3494 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
3497 mc->mc_ki[mc->mc_top] = i;
3498 if ((rc = mdb_cursor_push(mc, mp)))
3502 if ((rc = mdb_page_touch(mc)) != 0)
3504 mp = mc->mc_pg[mc->mc_top];
3509 DPRINTF("internal error, index points to a %02X page!?",
3511 return MDB_CORRUPTED;
3514 DPRINTF("found leaf page %zu for key [%s]", mp->mp_pgno,
3515 key ? DKEY(key) : NULL);
3520 /** Search for the page a given key should be in.
3521 * Pushes parent pages on the cursor stack. This function just sets up
3522 * the search; it finds the root page for \b mc's database and sets this
3523 * as the root of the cursor's stack. Then #mdb_page_search_root() is
3524 * called to complete the search.
3525 * @param[in,out] mc the cursor for this operation.
3526 * @param[in] key the key to search for. If NULL, search for the lowest
3527 * page. (This is used by #mdb_cursor_first().)
3528 * @param[in] modify If true, visited pages are updated with new page numbers.
3529 * @return 0 on success, non-zero on failure.
3532 mdb_page_search(MDB_cursor *mc, MDB_val *key, int flags)
3537 /* Make sure the txn is still viable, then find the root from
3538 * the txn's db table.
3540 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
3541 DPUTS("transaction has failed, must abort");
3544 /* Make sure we're using an up-to-date root */
3545 if (mc->mc_dbi > MAIN_DBI) {
3546 if ((*mc->mc_dbflag & DB_STALE) ||
3547 ((flags & MDB_PS_MODIFY) && !(*mc->mc_dbflag & DB_DIRTY))) {
3549 unsigned char dbflag = 0;
3550 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
3551 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, flags & MDB_PS_MODIFY);
3554 if (*mc->mc_dbflag & DB_STALE) {
3557 MDB_node *leaf = mdb_node_search(&mc2,
3558 &mc->mc_dbx->md_name, &exact);
3560 return MDB_NOTFOUND;
3561 mdb_node_read(mc->mc_txn, leaf, &data);
3562 memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
3564 if (flags & MDB_PS_MODIFY)
3566 *mc->mc_dbflag = dbflag;
3569 root = mc->mc_db->md_root;
3571 if (root == P_INVALID) { /* Tree is empty. */
3572 DPUTS("tree is empty");
3573 return MDB_NOTFOUND;
3578 if (!mc->mc_pg[0] || mc->mc_pg[0]->mp_pgno != root)
3579 if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0])))
3585 DPRINTF("db %u root page %zu has flags 0x%X",
3586 mc->mc_dbi, root, mc->mc_pg[0]->mp_flags);
3588 if (flags & MDB_PS_MODIFY) {
3589 if ((rc = mdb_page_touch(mc)))
3593 if (flags & MDB_PS_ROOTONLY)
3596 return mdb_page_search_root(mc, key, flags);
3599 /** Return the data associated with a given node.
3600 * @param[in] txn The transaction for this operation.
3601 * @param[in] leaf The node being read.
3602 * @param[out] data Updated to point to the node's data.
3603 * @return 0 on success, non-zero on failure.
3606 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
3608 MDB_page *omp; /* overflow page */
3612 if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
3613 data->mv_size = NODEDSZ(leaf);
3614 data->mv_data = NODEDATA(leaf);
3618 /* Read overflow data.
3620 data->mv_size = NODEDSZ(leaf);
3621 memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
3622 if ((rc = mdb_page_get(txn, pgno, &omp))) {
3623 DPRINTF("read overflow page %zu failed", pgno);
3626 data->mv_data = METADATA(omp);
3632 mdb_get(MDB_txn *txn, MDB_dbi dbi,
3633 MDB_val *key, MDB_val *data)
3642 DPRINTF("===> get db %u key [%s]", dbi, DKEY(key));
3644 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
3647 if (key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
3651 mdb_cursor_init(&mc, txn, dbi, &mx);
3652 return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
3655 /** Find a sibling for a page.
3656 * Replaces the page at the top of the cursor's stack with the
3657 * specified sibling, if one exists.
3658 * @param[in] mc The cursor for this operation.
3659 * @param[in] move_right Non-zero if the right sibling is requested,
3660 * otherwise the left sibling.
3661 * @return 0 on success, non-zero on failure.
3664 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
3670 if (mc->mc_snum < 2) {
3671 return MDB_NOTFOUND; /* root has no siblings */
3675 DPRINTF("parent page is page %zu, index %u",
3676 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]);
3678 if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
3679 : (mc->mc_ki[mc->mc_top] == 0)) {
3680 DPRINTF("no more keys left, moving to %s sibling",
3681 move_right ? "right" : "left");
3682 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS)
3686 mc->mc_ki[mc->mc_top]++;
3688 mc->mc_ki[mc->mc_top]--;
3689 DPRINTF("just moving to %s index key %u",
3690 move_right ? "right" : "left", mc->mc_ki[mc->mc_top]);
3692 assert(IS_BRANCH(mc->mc_pg[mc->mc_top]));
3694 indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
3695 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp)))
3698 mdb_cursor_push(mc, mp);
3703 /** Move the cursor to the next data item. */
3705 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
3711 if (mc->mc_flags & C_EOF) {
3712 return MDB_NOTFOUND;
3715 assert(mc->mc_flags & C_INITIALIZED);
3717 mp = mc->mc_pg[mc->mc_top];
3719 if (mc->mc_db->md_flags & MDB_DUPSORT) {
3720 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3721 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3722 if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
3723 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
3724 if (op != MDB_NEXT || rc == MDB_SUCCESS)
3728 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
3729 if (op == MDB_NEXT_DUP)
3730 return MDB_NOTFOUND;
3734 DPRINTF("cursor_next: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
3736 if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
3737 DPUTS("=====> move to next sibling page");
3738 if (mdb_cursor_sibling(mc, 1) != MDB_SUCCESS) {
3739 mc->mc_flags |= C_EOF;
3740 mc->mc_flags &= ~C_INITIALIZED;
3741 return MDB_NOTFOUND;
3743 mp = mc->mc_pg[mc->mc_top];
3744 DPRINTF("next page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
3746 mc->mc_ki[mc->mc_top]++;
3748 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
3749 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
3752 key->mv_size = mc->mc_db->md_pad;
3753 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
3757 assert(IS_LEAF(mp));
3758 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3760 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3761 mdb_xcursor_init1(mc, leaf);
3764 if ((rc = mdb_node_read(mc->mc_txn, leaf, data) != MDB_SUCCESS))
3767 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3768 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
3769 if (rc != MDB_SUCCESS)
3774 MDB_SET_KEY(leaf, key);
3778 /** Move the cursor to the previous data item. */
3780 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
3786 assert(mc->mc_flags & C_INITIALIZED);
3788 mp = mc->mc_pg[mc->mc_top];
3790 if (mc->mc_db->md_flags & MDB_DUPSORT) {
3791 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3792 if (op == MDB_PREV || op == MDB_PREV_DUP) {
3793 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3794 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
3795 if (op != MDB_PREV || rc == MDB_SUCCESS)
3798 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
3799 if (op == MDB_PREV_DUP)
3800 return MDB_NOTFOUND;
3805 DPRINTF("cursor_prev: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
3807 if (mc->mc_ki[mc->mc_top] == 0) {
3808 DPUTS("=====> move to prev sibling page");
3809 if (mdb_cursor_sibling(mc, 0) != MDB_SUCCESS) {
3810 mc->mc_flags &= ~C_INITIALIZED;
3811 return MDB_NOTFOUND;
3813 mp = mc->mc_pg[mc->mc_top];
3814 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
3815 DPRINTF("prev page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
3817 mc->mc_ki[mc->mc_top]--;
3819 mc->mc_flags &= ~C_EOF;
3821 DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
3822 mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
3825 key->mv_size = mc->mc_db->md_pad;
3826 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
3830 assert(IS_LEAF(mp));
3831 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3833 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3834 mdb_xcursor_init1(mc, leaf);
3837 if ((rc = mdb_node_read(mc->mc_txn, leaf, data) != MDB_SUCCESS))
3840 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3841 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
3842 if (rc != MDB_SUCCESS)
3847 MDB_SET_KEY(leaf, key);
3851 /** Set the cursor on a specific data item. */
3853 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
3854 MDB_cursor_op op, int *exactp)
3858 MDB_node *leaf = NULL;
3863 assert(key->mv_size > 0);
3865 /* See if we're already on the right page */
3866 if (mc->mc_flags & C_INITIALIZED) {
3869 mp = mc->mc_pg[mc->mc_top];
3871 mc->mc_ki[mc->mc_top] = 0;
3872 return MDB_NOTFOUND;
3874 if (mp->mp_flags & P_LEAF2) {
3875 nodekey.mv_size = mc->mc_db->md_pad;
3876 nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
3878 leaf = NODEPTR(mp, 0);
3879 MDB_SET_KEY(leaf, &nodekey);
3881 rc = mc->mc_dbx->md_cmp(key, &nodekey);
3883 /* Probably happens rarely, but first node on the page
3884 * was the one we wanted.
3886 mc->mc_ki[mc->mc_top] = 0;
3893 unsigned int nkeys = NUMKEYS(mp);
3895 if (mp->mp_flags & P_LEAF2) {
3896 nodekey.mv_data = LEAF2KEY(mp,
3897 nkeys-1, nodekey.mv_size);
3899 leaf = NODEPTR(mp, nkeys-1);
3900 MDB_SET_KEY(leaf, &nodekey);
3902 rc = mc->mc_dbx->md_cmp(key, &nodekey);
3904 /* last node was the one we wanted */
3905 mc->mc_ki[mc->mc_top] = nkeys-1;
3911 if (mc->mc_ki[mc->mc_top] < NUMKEYS(mp)) {
3912 /* This is definitely the right page, skip search_page */
3913 if (mp->mp_flags & P_LEAF2) {
3914 nodekey.mv_data = LEAF2KEY(mp,
3915 mc->mc_ki[mc->mc_top], nodekey.mv_size);
3917 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3918 MDB_SET_KEY(leaf, &nodekey);
3920 rc = mc->mc_dbx->md_cmp(key, &nodekey);
3922 /* current node was the one we wanted */
3932 /* If any parents have right-sibs, search.
3933 * Otherwise, there's nothing further.
3935 for (i=0; i<mc->mc_top; i++)
3937 NUMKEYS(mc->mc_pg[i])-1)
3939 if (i == mc->mc_top) {
3940 /* There are no other pages */
3941 mc->mc_ki[mc->mc_top] = nkeys;
3942 return MDB_NOTFOUND;
3946 /* There are no other pages */
3947 mc->mc_ki[mc->mc_top] = 0;
3948 return MDB_NOTFOUND;
3952 rc = mdb_page_search(mc, key, 0);
3953 if (rc != MDB_SUCCESS)
3956 mp = mc->mc_pg[mc->mc_top];
3957 assert(IS_LEAF(mp));
3960 leaf = mdb_node_search(mc, key, exactp);
3961 if (exactp != NULL && !*exactp) {
3962 /* MDB_SET specified and not an exact match. */
3963 return MDB_NOTFOUND;
3967 DPUTS("===> inexact leaf not found, goto sibling");
3968 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
3969 return rc; /* no entries matched */
3970 mp = mc->mc_pg[mc->mc_top];
3971 assert(IS_LEAF(mp));
3972 leaf = NODEPTR(mp, 0);
3976 mc->mc_flags |= C_INITIALIZED;
3977 mc->mc_flags &= ~C_EOF;
3980 key->mv_size = mc->mc_db->md_pad;
3981 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
3985 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3986 mdb_xcursor_init1(mc, leaf);
3989 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3990 if (op == MDB_SET || op == MDB_SET_RANGE) {
3991 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
3994 if (op == MDB_GET_BOTH) {
4000 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
4001 if (rc != MDB_SUCCESS)
4004 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
4006 if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
4008 rc = mc->mc_dbx->md_dcmp(data, &d2);
4010 if (op == MDB_GET_BOTH || rc > 0)
4011 return MDB_NOTFOUND;
4016 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4017 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4022 /* The key already matches in all other cases */
4023 if (op == MDB_SET_RANGE)
4024 MDB_SET_KEY(leaf, key);
4025 DPRINTF("==> cursor placed on key [%s]", DKEY(key));
4030 /** Move the cursor to the first item in the database. */
4032 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4037 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4038 rc = mdb_page_search(mc, NULL, 0);
4039 if (rc != MDB_SUCCESS)
4042 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4044 leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
4045 mc->mc_flags |= C_INITIALIZED;
4046 mc->mc_flags &= ~C_EOF;
4048 mc->mc_ki[mc->mc_top] = 0;
4050 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4051 key->mv_size = mc->mc_db->md_pad;
4052 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
4057 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4058 mdb_xcursor_init1(mc, leaf);
4059 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4064 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4065 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4069 MDB_SET_KEY(leaf, key);
4073 /** Move the cursor to the last item in the database. */
4075 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
4080 if (!(mc->mc_flags & C_EOF)) {
4082 if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
4085 lkey.mv_size = MAXKEYSIZE+1;
4086 lkey.mv_data = NULL;
4087 rc = mdb_page_search(mc, &lkey, 0);
4088 if (rc != MDB_SUCCESS)
4091 assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
4093 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
4094 mc->mc_flags |= C_INITIALIZED|C_EOF;
4096 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4098 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4099 key->mv_size = mc->mc_db->md_pad;
4100 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
4105 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4106 mdb_xcursor_init1(mc, leaf);
4107 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4112 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4113 if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4118 MDB_SET_KEY(leaf, key);
4123 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4133 case MDB_GET_BOTH_RANGE:
4134 if (data == NULL || mc->mc_xcursor == NULL) {
4141 if (key == NULL || key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
4143 } else if (op == MDB_SET_RANGE)
4144 rc = mdb_cursor_set(mc, key, data, op, NULL);
4146 rc = mdb_cursor_set(mc, key, data, op, &exact);
4148 case MDB_GET_MULTIPLE:
4150 !(mc->mc_db->md_flags & MDB_DUPFIXED) ||
4151 !(mc->mc_flags & C_INITIALIZED)) {
4156 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
4157 (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
4160 case MDB_NEXT_MULTIPLE:
4162 !(mc->mc_db->md_flags & MDB_DUPFIXED)) {
4166 if (!(mc->mc_flags & C_INITIALIZED))
4167 rc = mdb_cursor_first(mc, key, data);
4169 rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
4170 if (rc == MDB_SUCCESS) {
4171 if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
4174 mx = &mc->mc_xcursor->mx_cursor;
4175 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
4177 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
4178 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
4186 case MDB_NEXT_NODUP:
4187 if (!(mc->mc_flags & C_INITIALIZED))
4188 rc = mdb_cursor_first(mc, key, data);
4190 rc = mdb_cursor_next(mc, key, data, op);
4194 case MDB_PREV_NODUP:
4195 if (!(mc->mc_flags & C_INITIALIZED) || (mc->mc_flags & C_EOF)) {
4196 rc = mdb_cursor_last(mc, key, data);
4197 mc->mc_flags &= ~C_EOF;
4199 rc = mdb_cursor_prev(mc, key, data, op);
4202 rc = mdb_cursor_first(mc, key, data);
4206 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4207 !(mc->mc_flags & C_INITIALIZED) ||
4208 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4212 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4215 rc = mdb_cursor_last(mc, key, data);
4219 !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4220 !(mc->mc_flags & C_INITIALIZED) ||
4221 !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4225 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4228 DPRINTF("unhandled/unimplemented cursor operation %u", op);
4236 /** Touch all the pages in the cursor stack.
4237 * Makes sure all the pages are writable, before attempting a write operation.
4238 * @param[in] mc The cursor to operate on.
4241 mdb_cursor_touch(MDB_cursor *mc)
4245 if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
4247 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
4248 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, MDB_PS_MODIFY);
4251 *mc->mc_dbflag = DB_DIRTY;
4253 for (mc->mc_top = 0; mc->mc_top < mc->mc_snum; mc->mc_top++) {
4254 rc = mdb_page_touch(mc);
4258 mc->mc_top = mc->mc_snum-1;
4263 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4266 MDB_node *leaf = NULL;
4267 MDB_val xdata, *rdata, dkey;
4270 int do_sub = 0, insert = 0;
4271 unsigned int mcount = 0;
4275 char dbuf[MAXKEYSIZE+1];
4276 unsigned int nflags;
4279 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4282 DPRINTF("==> put db %u key [%s], size %zu, data size %zu",
4283 mc->mc_dbi, DKEY(key), key ? key->mv_size:0, data->mv_size);
4287 if (flags == MDB_CURRENT) {
4288 if (!(mc->mc_flags & C_INITIALIZED))
4291 } else if (mc->mc_db->md_root == P_INVALID) {
4293 /* new database, write a root leaf page */
4294 DPUTS("allocating new root leaf page");
4295 if ((np = mdb_page_new(mc, P_LEAF, 1)) == NULL) {
4299 mdb_cursor_push(mc, np);
4300 mc->mc_db->md_root = np->mp_pgno;
4301 mc->mc_db->md_depth++;
4302 *mc->mc_dbflag = DB_DIRTY;
4303 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
4305 np->mp_flags |= P_LEAF2;
4306 mc->mc_flags |= C_INITIALIZED;
4312 if (flags & MDB_APPEND) {
4314 rc = mdb_cursor_last(mc, &k2, &d2);
4316 rc = mc->mc_dbx->md_cmp(key, &k2);
4319 mc->mc_ki[mc->mc_top]++;
4325 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
4327 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
4328 DPRINTF("duplicate key [%s]", DKEY(key));
4330 return MDB_KEYEXIST;
4332 if (rc && rc != MDB_NOTFOUND)
4336 /* Cursor is positioned, now make sure all pages are writable */
4337 rc2 = mdb_cursor_touch(mc);
4342 /* The key already exists */
4343 if (rc == MDB_SUCCESS) {
4344 /* there's only a key anyway, so this is a no-op */
4345 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4346 unsigned int ksize = mc->mc_db->md_pad;
4347 if (key->mv_size != ksize)
4349 if (flags == MDB_CURRENT) {
4350 char *ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
4351 memcpy(ptr, key->mv_data, ksize);
4356 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4359 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
4360 /* Was a single item before, must convert now */
4362 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4363 /* Just overwrite the current item */
4364 if (flags == MDB_CURRENT)
4367 dkey.mv_size = NODEDSZ(leaf);
4368 dkey.mv_data = NODEDATA(leaf);
4369 #if UINT_MAX < SIZE_MAX
4370 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && dkey.mv_size == sizeof(size_t))
4371 #ifdef MISALIGNED_OK
4372 mc->mc_dbx->md_dcmp = mdb_cmp_long;
4374 mc->mc_dbx->md_dcmp = mdb_cmp_cint;
4377 /* if data matches, ignore it */
4378 if (!mc->mc_dbx->md_dcmp(data, &dkey))
4379 return (flags == MDB_NODUPDATA) ? MDB_KEYEXIST : MDB_SUCCESS;
4381 /* create a fake page for the dup items */
4382 memcpy(dbuf, dkey.mv_data, dkey.mv_size);
4383 dkey.mv_data = dbuf;
4384 fp = (MDB_page *)&pbuf;
4385 fp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
4386 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
4387 fp->mp_lower = PAGEHDRSZ;
4388 fp->mp_upper = PAGEHDRSZ + dkey.mv_size + data->mv_size;
4389 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
4390 fp->mp_flags |= P_LEAF2;
4391 fp->mp_pad = data->mv_size;
4392 fp->mp_upper += 2 * data->mv_size; /* leave space for 2 more */
4394 fp->mp_upper += 2 * sizeof(indx_t) + 2 * NODESIZE +
4395 (dkey.mv_size & 1) + (data->mv_size & 1);
4397 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
4400 xdata.mv_size = fp->mp_upper;
4405 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
4406 /* See if we need to convert from fake page to subDB */
4408 unsigned int offset;
4411 fp = NODEDATA(leaf);
4412 if (flags == MDB_CURRENT) {
4414 fp->mp_flags |= P_DIRTY;
4415 COPY_PGNO(fp->mp_pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
4416 mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
4420 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
4421 offset = fp->mp_pad;
4422 if (SIZELEFT(fp) >= offset)
4424 offset *= 4; /* space for 4 more */
4426 offset = NODESIZE + sizeof(indx_t) + data->mv_size;
4428 offset += offset & 1;
4429 if (NODESIZE + sizeof(indx_t) + NODEKSZ(leaf) + NODEDSZ(leaf) +
4430 offset >= (mc->mc_txn->mt_env->me_psize - PAGEHDRSZ) /
4432 /* yes, convert it */
4434 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
4435 dummy.md_pad = fp->mp_pad;
4436 dummy.md_flags = MDB_DUPFIXED;
4437 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
4438 dummy.md_flags |= MDB_INTEGERKEY;
4441 dummy.md_branch_pages = 0;
4442 dummy.md_leaf_pages = 1;
4443 dummy.md_overflow_pages = 0;
4444 dummy.md_entries = NUMKEYS(fp);
4446 xdata.mv_size = sizeof(MDB_db);
4447 xdata.mv_data = &dummy;
4448 mp = mdb_page_alloc(mc, 1);
4451 offset = mc->mc_txn->mt_env->me_psize - NODEDSZ(leaf);
4452 flags |= F_DUPDATA|F_SUBDATA;
4453 dummy.md_root = mp->mp_pgno;
4455 /* no, just grow it */
4457 xdata.mv_size = NODEDSZ(leaf) + offset;
4458 xdata.mv_data = &pbuf;
4459 mp = (MDB_page *)&pbuf;
4460 mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
4463 mp->mp_flags = fp->mp_flags | P_DIRTY;
4464 mp->mp_pad = fp->mp_pad;
4465 mp->mp_lower = fp->mp_lower;
4466 mp->mp_upper = fp->mp_upper + offset;
4468 memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
4470 nsize = NODEDSZ(leaf) - fp->mp_upper;
4471 memcpy((char *)mp + mp->mp_upper, (char *)fp + fp->mp_upper, nsize);
4472 for (i=0; i<NUMKEYS(fp); i++)
4473 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
4475 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
4479 /* data is on sub-DB, just store it */
4480 flags |= F_DUPDATA|F_SUBDATA;
4484 /* overflow page overwrites need special handling */
4485 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
4488 int ovpages, dpages;
4490 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
4491 dpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
4492 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
4493 mdb_page_get(mc->mc_txn, pg, &omp);
4494 /* Is the ov page writable and large enough? */
4495 if ((omp->mp_flags & P_DIRTY) && ovpages >= dpages) {
4496 /* yes, overwrite it. Note in this case we don't
4497 * bother to try shrinking the node if the new data
4498 * is smaller than the overflow threshold.
4500 if (F_ISSET(flags, MDB_RESERVE))
4501 data->mv_data = METADATA(omp);
4503 memcpy(METADATA(omp), data->mv_data, data->mv_size);
4506 /* no, free ovpages */
4508 mc->mc_db->md_overflow_pages -= ovpages;
4509 for (i=0; i<ovpages; i++) {
4510 DPRINTF("freed ov page %zu", pg);
4511 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
4515 } else if (NODEDSZ(leaf) == data->mv_size) {
4516 /* same size, just replace it. Note that we could
4517 * also reuse this node if the new data is smaller,
4518 * but instead we opt to shrink the node in that case.
4520 if (F_ISSET(flags, MDB_RESERVE))
4521 data->mv_data = NODEDATA(leaf);
4523 memcpy(NODEDATA(leaf), data->mv_data, data->mv_size);
4526 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
4527 mc->mc_db->md_entries--;
4529 DPRINTF("inserting key at index %i", mc->mc_ki[mc->mc_top]);
4536 nflags = flags & NODE_ADD_FLAGS;
4537 nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(mc->mc_txn->mt_env, key, rdata);
4538 if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
4539 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
4540 nflags &= ~MDB_APPEND;
4542 nflags |= MDB_SPLIT_REPLACE;
4543 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
4545 /* There is room already in this leaf page. */
4546 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
4547 if (rc == 0 && !do_sub && insert) {
4548 /* Adjust other cursors pointing to mp */
4549 MDB_cursor *m2, *m3;
4550 MDB_dbi dbi = mc->mc_dbi;
4551 unsigned i = mc->mc_top;
4552 MDB_page *mp = mc->mc_pg[i];
4554 if (mc->mc_flags & C_SUB)
4557 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
4558 if (mc->mc_flags & C_SUB)
4559 m3 = &m2->mc_xcursor->mx_cursor;
4562 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
4563 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
4570 if (rc != MDB_SUCCESS)
4571 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
4573 /* Now store the actual data in the child DB. Note that we're
4574 * storing the user data in the keys field, so there are strict
4575 * size limits on dupdata. The actual data fields of the child
4576 * DB are all zero size.
4583 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4584 if (flags & MDB_CURRENT) {
4585 xflags = MDB_CURRENT;
4587 mdb_xcursor_init1(mc, leaf);
4588 xflags = (flags & MDB_NODUPDATA) ? MDB_NOOVERWRITE : 0;
4590 /* converted, write the original data first */
4592 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
4596 /* Adjust other cursors pointing to mp */
4598 unsigned i = mc->mc_top;
4599 MDB_page *mp = mc->mc_pg[i];
4601 for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
4602 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
4603 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
4604 mdb_xcursor_init1(m2, leaf);
4609 if (flags & MDB_APPENDDUP)
4610 xflags |= MDB_APPEND;
4611 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
4612 if (flags & F_SUBDATA) {
4613 void *db = NODEDATA(leaf);
4614 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
4617 /* sub-writes might have failed so check rc again.
4618 * Don't increment count if we just replaced an existing item.
4620 if (!rc && !(flags & MDB_CURRENT))
4621 mc->mc_db->md_entries++;
4622 if (flags & MDB_MULTIPLE) {
4624 if (mcount < data[1].mv_size) {
4625 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
4626 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4636 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
4641 if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4644 if (!mc->mc_flags & C_INITIALIZED)
4647 rc = mdb_cursor_touch(mc);
4651 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4653 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4654 if (flags != MDB_NODUPDATA) {
4655 if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
4656 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
4658 rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, 0);
4659 /* If sub-DB still has entries, we're done */
4660 if (mc->mc_xcursor->mx_db.md_entries) {
4661 if (leaf->mn_flags & F_SUBDATA) {
4662 /* update subDB info */
4663 void *db = NODEDATA(leaf);
4664 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
4666 /* shrink fake page */
4667 mdb_node_shrink(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4669 mc->mc_db->md_entries--;
4672 /* otherwise fall thru and delete the sub-DB */
4675 if (leaf->mn_flags & F_SUBDATA) {
4676 /* add all the child DB's pages to the free list */
4677 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
4678 if (rc == MDB_SUCCESS) {
4679 mc->mc_db->md_entries -=
4680 mc->mc_xcursor->mx_db.md_entries;
4685 return mdb_cursor_del0(mc, leaf);
4688 /** Allocate and initialize new pages for a database.
4689 * @param[in] mc a cursor on the database being added to.
4690 * @param[in] flags flags defining what type of page is being allocated.
4691 * @param[in] num the number of pages to allocate. This is usually 1,
4692 * unless allocating overflow pages for a large record.
4693 * @return Address of a page, or NULL on failure.
4696 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num)
4700 if ((np = mdb_page_alloc(mc, num)) == NULL)
4702 DPRINTF("allocated new mpage %zu, page size %u",
4703 np->mp_pgno, mc->mc_txn->mt_env->me_psize);
4704 np->mp_flags = flags | P_DIRTY;
4705 np->mp_lower = PAGEHDRSZ;
4706 np->mp_upper = mc->mc_txn->mt_env->me_psize;
4709 mc->mc_db->md_branch_pages++;
4710 else if (IS_LEAF(np))
4711 mc->mc_db->md_leaf_pages++;
4712 else if (IS_OVERFLOW(np)) {
4713 mc->mc_db->md_overflow_pages += num;
4720 /** Calculate the size of a leaf node.
4721 * The size depends on the environment's page size; if a data item
4722 * is too large it will be put onto an overflow page and the node
4723 * size will only include the key and not the data. Sizes are always
4724 * rounded up to an even number of bytes, to guarantee 2-byte alignment
4725 * of the #MDB_node headers.
4726 * @param[in] env The environment handle.
4727 * @param[in] key The key for the node.
4728 * @param[in] data The data for the node.
4729 * @return The number of bytes needed to store the node.
4732 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
4736 sz = LEAFSIZE(key, data);
4737 if (sz >= env->me_psize / MDB_MINKEYS) {
4738 /* put on overflow page */
4739 sz -= data->mv_size - sizeof(pgno_t);
4743 return sz + sizeof(indx_t);
4746 /** Calculate the size of a branch node.
4747 * The size should depend on the environment's page size but since
4748 * we currently don't support spilling large keys onto overflow
4749 * pages, it's simply the size of the #MDB_node header plus the
4750 * size of the key. Sizes are always rounded up to an even number
4751 * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
4752 * @param[in] env The environment handle.
4753 * @param[in] key The key for the node.
4754 * @return The number of bytes needed to store the node.
4757 mdb_branch_size(MDB_env *env, MDB_val *key)
4762 if (sz >= env->me_psize / MDB_MINKEYS) {
4763 /* put on overflow page */
4764 /* not implemented */
4765 /* sz -= key->size - sizeof(pgno_t); */
4768 return sz + sizeof(indx_t);
4771 /** Add a node to the page pointed to by the cursor.
4772 * @param[in] mc The cursor for this operation.
4773 * @param[in] indx The index on the page where the new node should be added.
4774 * @param[in] key The key for the new node.
4775 * @param[in] data The data for the new node, if any.
4776 * @param[in] pgno The page number, if adding a branch node.
4777 * @param[in] flags Flags for the node.
4778 * @return 0 on success, non-zero on failure. Possible errors are:
4780 * <li>ENOMEM - failed to allocate overflow pages for the node.
4781 * <li>ENOSPC - there is insufficient room in the page. This error
4782 * should never happen since all callers already calculate the
4783 * page's free space before calling this function.
4787 mdb_node_add(MDB_cursor *mc, indx_t indx,
4788 MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
4791 size_t node_size = NODESIZE;
4794 MDB_page *mp = mc->mc_pg[mc->mc_top];
4795 MDB_page *ofp = NULL; /* overflow page */
4798 assert(mp->mp_upper >= mp->mp_lower);
4800 DPRINTF("add to %s %spage %zu index %i, data size %zu key size %zu [%s]",
4801 IS_LEAF(mp) ? "leaf" : "branch",
4802 IS_SUBP(mp) ? "sub-" : "",
4803 mp->mp_pgno, indx, data ? data->mv_size : 0,
4804 key ? key->mv_size : 0, key ? DKEY(key) : NULL);
4807 /* Move higher keys up one slot. */
4808 int ksize = mc->mc_db->md_pad, dif;
4809 char *ptr = LEAF2KEY(mp, indx, ksize);
4810 dif = NUMKEYS(mp) - indx;
4812 memmove(ptr+ksize, ptr, dif*ksize);
4813 /* insert new key */
4814 memcpy(ptr, key->mv_data, ksize);
4816 /* Just using these for counting */
4817 mp->mp_lower += sizeof(indx_t);
4818 mp->mp_upper -= ksize - sizeof(indx_t);
4823 node_size += key->mv_size;
4827 if (F_ISSET(flags, F_BIGDATA)) {
4828 /* Data already on overflow page. */
4829 node_size += sizeof(pgno_t);
4830 } else if (node_size + data->mv_size >= mc->mc_txn->mt_env->me_psize / MDB_MINKEYS) {
4831 int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
4832 /* Put data on overflow page. */
4833 DPRINTF("data size is %zu, node would be %zu, put data on overflow page",
4834 data->mv_size, node_size+data->mv_size);
4835 node_size += sizeof(pgno_t);
4836 if ((ofp = mdb_page_new(mc, P_OVERFLOW, ovpages)) == NULL)
4838 DPRINTF("allocated overflow page %zu", ofp->mp_pgno);
4841 node_size += data->mv_size;
4844 node_size += node_size & 1;
4846 if (node_size + sizeof(indx_t) > SIZELEFT(mp)) {
4847 DPRINTF("not enough room in page %zu, got %u ptrs",
4848 mp->mp_pgno, NUMKEYS(mp));
4849 DPRINTF("upper - lower = %u - %u = %u", mp->mp_upper, mp->mp_lower,
4850 mp->mp_upper - mp->mp_lower);
4851 DPRINTF("node size = %zu", node_size);
4855 /* Move higher pointers up one slot. */
4856 for (i = NUMKEYS(mp); i > indx; i--)
4857 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
4859 /* Adjust free space offsets. */
4860 ofs = mp->mp_upper - node_size;
4861 assert(ofs >= mp->mp_lower + sizeof(indx_t));
4862 mp->mp_ptrs[indx] = ofs;
4864 mp->mp_lower += sizeof(indx_t);
4866 /* Write the node data. */
4867 node = NODEPTR(mp, indx);
4868 node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
4869 node->mn_flags = flags;
4871 SETDSZ(node,data->mv_size);
4876 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
4881 if (F_ISSET(flags, F_BIGDATA))
4882 memcpy(node->mn_data + key->mv_size, data->mv_data,
4884 else if (F_ISSET(flags, MDB_RESERVE))
4885 data->mv_data = node->mn_data + key->mv_size;
4887 memcpy(node->mn_data + key->mv_size, data->mv_data,
4890 memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
4892 if (F_ISSET(flags, MDB_RESERVE))
4893 data->mv_data = METADATA(ofp);
4895 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
4902 /** Delete the specified node from a page.
4903 * @param[in] mp The page to operate on.
4904 * @param[in] indx The index of the node to delete.
4905 * @param[in] ksize The size of a node. Only used if the page is
4906 * part of a #MDB_DUPFIXED database.
4909 mdb_node_del(MDB_page *mp, indx_t indx, int ksize)
4912 indx_t i, j, numkeys, ptr;
4919 COPY_PGNO(pgno, mp->mp_pgno);
4920 DPRINTF("delete node %u on %s page %zu", indx,
4921 IS_LEAF(mp) ? "leaf" : "branch", pgno);
4924 assert(indx < NUMKEYS(mp));
4927 int x = NUMKEYS(mp) - 1 - indx;
4928 base = LEAF2KEY(mp, indx, ksize);
4930 memmove(base, base + ksize, x * ksize);
4931 mp->mp_lower -= sizeof(indx_t);
4932 mp->mp_upper += ksize - sizeof(indx_t);
4936 node = NODEPTR(mp, indx);
4937 sz = NODESIZE + node->mn_ksize;
4939 if (F_ISSET(node->mn_flags, F_BIGDATA))
4940 sz += sizeof(pgno_t);
4942 sz += NODEDSZ(node);
4946 ptr = mp->mp_ptrs[indx];
4947 numkeys = NUMKEYS(mp);
4948 for (i = j = 0; i < numkeys; i++) {
4950 mp->mp_ptrs[j] = mp->mp_ptrs[i];
4951 if (mp->mp_ptrs[i] < ptr)
4952 mp->mp_ptrs[j] += sz;
4957 base = (char *)mp + mp->mp_upper;
4958 memmove(base + sz, base, ptr - mp->mp_upper);
4960 mp->mp_lower -= sizeof(indx_t);
4964 /** Compact the main page after deleting a node on a subpage.
4965 * @param[in] mp The main page to operate on.
4966 * @param[in] indx The index of the subpage on the main page.
4969 mdb_node_shrink(MDB_page *mp, indx_t indx)
4976 indx_t i, numkeys, ptr;
4978 node = NODEPTR(mp, indx);
4979 sp = (MDB_page *)NODEDATA(node);
4980 osize = NODEDSZ(node);
4982 delta = sp->mp_upper - sp->mp_lower;
4983 SETDSZ(node, osize - delta);
4984 xp = (MDB_page *)((char *)sp + delta);
4986 /* shift subpage upward */
4988 nsize = NUMKEYS(sp) * sp->mp_pad;
4989 memmove(METADATA(xp), METADATA(sp), nsize);
4992 nsize = osize - sp->mp_upper;
4993 numkeys = NUMKEYS(sp);
4994 for (i=numkeys-1; i>=0; i--)
4995 xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
4997 xp->mp_upper = sp->mp_lower;
4998 xp->mp_lower = sp->mp_lower;
4999 xp->mp_flags = sp->mp_flags;
5000 xp->mp_pad = sp->mp_pad;
5001 COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
5003 /* shift lower nodes upward */
5004 ptr = mp->mp_ptrs[indx];
5005 numkeys = NUMKEYS(mp);
5006 for (i = 0; i < numkeys; i++) {
5007 if (mp->mp_ptrs[i] <= ptr)
5008 mp->mp_ptrs[i] += delta;
5011 base = (char *)mp + mp->mp_upper;
5012 memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
5013 mp->mp_upper += delta;
5016 /** Initial setup of a sorted-dups cursor.
5017 * Sorted duplicates are implemented as a sub-database for the given key.
5018 * The duplicate data items are actually keys of the sub-database.
5019 * Operations on the duplicate data items are performed using a sub-cursor
5020 * initialized when the sub-database is first accessed. This function does
5021 * the preliminary setup of the sub-cursor, filling in the fields that
5022 * depend only on the parent DB.
5023 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5026 mdb_xcursor_init0(MDB_cursor *mc)
5028 MDB_xcursor *mx = mc->mc_xcursor;
5030 mx->mx_cursor.mc_xcursor = NULL;
5031 mx->mx_cursor.mc_txn = mc->mc_txn;
5032 mx->mx_cursor.mc_db = &mx->mx_db;
5033 mx->mx_cursor.mc_dbx = &mx->mx_dbx;
5034 mx->mx_cursor.mc_dbi = mc->mc_dbi+1;
5035 mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
5036 mx->mx_cursor.mc_snum = 0;
5037 mx->mx_cursor.mc_top = 0;
5038 mx->mx_cursor.mc_flags = C_SUB;
5039 mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
5040 mx->mx_dbx.md_dcmp = NULL;
5041 mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
5044 /** Final setup of a sorted-dups cursor.
5045 * Sets up the fields that depend on the data from the main cursor.
5046 * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
5047 * @param[in] node The data containing the #MDB_db record for the
5048 * sorted-dup database.
5051 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
5053 MDB_xcursor *mx = mc->mc_xcursor;
5055 if (node->mn_flags & F_SUBDATA) {
5056 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
5057 mx->mx_cursor.mc_pg[0] = 0;
5058 mx->mx_cursor.mc_snum = 0;
5059 mx->mx_cursor.mc_flags = C_SUB;
5061 MDB_page *fp = NODEDATA(node);
5062 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
5063 mx->mx_db.md_flags = 0;
5064 mx->mx_db.md_depth = 1;
5065 mx->mx_db.md_branch_pages = 0;
5066 mx->mx_db.md_leaf_pages = 1;
5067 mx->mx_db.md_overflow_pages = 0;
5068 mx->mx_db.md_entries = NUMKEYS(fp);
5069 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
5070 mx->mx_cursor.mc_snum = 1;
5071 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
5072 mx->mx_cursor.mc_top = 0;
5073 mx->mx_cursor.mc_pg[0] = fp;
5074 mx->mx_cursor.mc_ki[0] = 0;
5075 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
5076 mx->mx_db.md_flags = MDB_DUPFIXED;
5077 mx->mx_db.md_pad = fp->mp_pad;
5078 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
5079 mx->mx_db.md_flags |= MDB_INTEGERKEY;
5082 DPRINTF("Sub-db %u for db %u root page %zu", mx->mx_cursor.mc_dbi, mc->mc_dbi,
5084 mx->mx_dbflag = (F_ISSET(mc->mc_pg[mc->mc_top]->mp_flags, P_DIRTY)) ?
5086 mx->mx_dbx.md_name.mv_data = NODEKEY(node);
5087 mx->mx_dbx.md_name.mv_size = node->mn_ksize;
5088 #if UINT_MAX < SIZE_MAX
5089 if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
5090 #ifdef MISALIGNED_OK
5091 mx->mx_dbx.md_cmp = mdb_cmp_long;
5093 mx->mx_dbx.md_cmp = mdb_cmp_cint;
5098 /** Initialize a cursor for a given transaction and database. */
5100 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
5105 mc->mc_db = &txn->mt_dbs[dbi];
5106 mc->mc_dbx = &txn->mt_dbxs[dbi];
5107 mc->mc_dbflag = &txn->mt_dbflags[dbi];
5112 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5114 mc->mc_xcursor = mx;
5115 mdb_xcursor_init0(mc);
5117 mc->mc_xcursor = NULL;
5119 if (*mc->mc_dbflag & DB_STALE) {
5120 mdb_page_search(mc, NULL, MDB_PS_ROOTONLY);
5125 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
5128 MDB_xcursor *mx = NULL;
5129 size_t size = sizeof(MDB_cursor);
5131 if (txn == NULL || ret == NULL || dbi >= txn->mt_numdbs)
5134 /* Allow read access to the freelist */
5135 if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
5138 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
5139 size += sizeof(MDB_xcursor);
5141 if ((mc = malloc(size)) != NULL) {
5142 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5143 mx = (MDB_xcursor *)(mc + 1);
5145 mdb_cursor_init(mc, txn, dbi, mx);
5146 if (txn->mt_cursors) {
5147 mc->mc_next = txn->mt_cursors[dbi];
5148 txn->mt_cursors[dbi] = mc;
5150 mc->mc_flags |= C_ALLOCD;
5160 /* Return the count of duplicate data items for the current key */
5162 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
5166 if (mc == NULL || countp == NULL)
5169 if (!(mc->mc_db->md_flags & MDB_DUPSORT))
5172 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5173 if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5176 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
5179 *countp = mc->mc_xcursor->mx_db.md_entries;
5185 mdb_cursor_close(MDB_cursor *mc)
5188 /* remove from txn, if tracked */
5189 if (mc->mc_txn->mt_cursors) {
5190 MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
5191 while (*prev && *prev != mc) prev = &(*prev)->mc_next;
5193 *prev = mc->mc_next;
5195 if (mc->mc_flags & C_ALLOCD)
5201 mdb_cursor_txn(MDB_cursor *mc)
5203 if (!mc) return NULL;
5208 mdb_cursor_dbi(MDB_cursor *mc)
5214 /** Replace the key for a node with a new key.
5215 * @param[in] mp The page containing the node to operate on.
5216 * @param[in] indx The index of the node to operate on.
5217 * @param[in] key The new key to use.
5218 * @return 0 on success, non-zero on failure.
5221 mdb_update_key(MDB_page *mp, indx_t indx, MDB_val *key)
5227 indx_t ptr, i, numkeys;
5230 node = NODEPTR(mp, indx);
5231 ptr = mp->mp_ptrs[indx];
5235 char kbuf2[(MAXKEYSIZE*2+1)];
5236 k2.mv_data = NODEKEY(node);
5237 k2.mv_size = node->mn_ksize;
5238 DPRINTF("update key %u (ofs %u) [%s] to [%s] on page %zu",
5240 mdb_dkey(&k2, kbuf2),
5246 delta0 = delta = key->mv_size - node->mn_ksize;
5248 /* Must be 2-byte aligned. If new key is
5249 * shorter by 1, the shift will be skipped.
5251 delta += (delta & 1);
5253 if (delta > 0 && SIZELEFT(mp) < delta) {
5254 DPRINTF("OUCH! Not enough room, delta = %d", delta);
5258 numkeys = NUMKEYS(mp);
5259 for (i = 0; i < numkeys; i++) {
5260 if (mp->mp_ptrs[i] <= ptr)
5261 mp->mp_ptrs[i] -= delta;
5264 base = (char *)mp + mp->mp_upper;
5265 len = ptr - mp->mp_upper + NODESIZE;
5266 memmove(base - delta, base, len);
5267 mp->mp_upper -= delta;
5269 node = NODEPTR(mp, indx);
5272 /* But even if no shift was needed, update ksize */
5274 node->mn_ksize = key->mv_size;
5277 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
5282 /** Move a node from csrc to cdst.
5285 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
5291 unsigned short flags;
5295 /* Mark src and dst as dirty. */
5296 if ((rc = mdb_page_touch(csrc)) ||
5297 (rc = mdb_page_touch(cdst)))
5300 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5301 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0); /* fake */
5302 key.mv_size = csrc->mc_db->md_pad;
5303 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
5305 data.mv_data = NULL;
5309 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
5310 assert(!((long)srcnode&1));
5311 srcpg = NODEPGNO(srcnode);
5312 flags = srcnode->mn_flags;
5313 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
5314 unsigned int snum = csrc->mc_snum;
5316 /* must find the lowest key below src */
5317 mdb_page_search_root(csrc, NULL, 0);
5318 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5319 key.mv_size = csrc->mc_db->md_pad;
5320 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
5322 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
5323 key.mv_size = NODEKSZ(s2);
5324 key.mv_data = NODEKEY(s2);
5326 csrc->mc_snum = snum--;
5327 csrc->mc_top = snum;
5329 key.mv_size = NODEKSZ(srcnode);
5330 key.mv_data = NODEKEY(srcnode);
5332 data.mv_size = NODEDSZ(srcnode);
5333 data.mv_data = NODEDATA(srcnode);
5335 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
5336 unsigned int snum = cdst->mc_snum;
5339 /* must find the lowest key below dst */
5340 mdb_page_search_root(cdst, NULL, 0);
5341 if (IS_LEAF2(cdst->mc_pg[cdst->mc_top])) {
5342 bkey.mv_size = cdst->mc_db->md_pad;
5343 bkey.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, bkey.mv_size);
5345 s2 = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
5346 bkey.mv_size = NODEKSZ(s2);
5347 bkey.mv_data = NODEKEY(s2);
5349 cdst->mc_snum = snum--;
5350 cdst->mc_top = snum;
5351 rc = mdb_update_key(cdst->mc_pg[cdst->mc_top], 0, &bkey);
5354 DPRINTF("moving %s node %u [%s] on page %zu to node %u on page %zu",
5355 IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
5356 csrc->mc_ki[csrc->mc_top],
5358 csrc->mc_pg[csrc->mc_top]->mp_pgno,
5359 cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno);
5361 /* Add the node to the destination page.
5363 rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
5364 if (rc != MDB_SUCCESS)
5367 /* Delete the node from the source page.
5369 mdb_node_del(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
5372 /* Adjust other cursors pointing to mp */
5373 MDB_cursor *m2, *m3;
5374 MDB_dbi dbi = csrc->mc_dbi;
5375 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
5377 if (csrc->mc_flags & C_SUB)
5380 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5381 if (m2 == csrc) continue;
5382 if (csrc->mc_flags & C_SUB)
5383 m3 = &m2->mc_xcursor->mx_cursor;
5386 if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
5387 csrc->mc_ki[csrc->mc_top]) {
5388 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
5389 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
5394 /* Update the parent separators.
5396 if (csrc->mc_ki[csrc->mc_top] == 0) {
5397 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
5398 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5399 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
5401 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
5402 key.mv_size = NODEKSZ(srcnode);
5403 key.mv_data = NODEKEY(srcnode);
5405 DPRINTF("update separator for source page %zu to [%s]",
5406 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key));
5407 if ((rc = mdb_update_key(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1],
5408 &key)) != MDB_SUCCESS)
5411 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
5413 nullkey.mv_size = 0;
5414 rc = mdb_update_key(csrc->mc_pg[csrc->mc_top], 0, &nullkey);
5415 assert(rc == MDB_SUCCESS);
5419 if (cdst->mc_ki[cdst->mc_top] == 0) {
5420 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
5421 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5422 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
5424 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
5425 key.mv_size = NODEKSZ(srcnode);
5426 key.mv_data = NODEKEY(srcnode);
5428 DPRINTF("update separator for destination page %zu to [%s]",
5429 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key));
5430 if ((rc = mdb_update_key(cdst->mc_pg[cdst->mc_top-1], cdst->mc_ki[cdst->mc_top-1],
5431 &key)) != MDB_SUCCESS)
5434 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
5436 nullkey.mv_size = 0;
5437 rc = mdb_update_key(cdst->mc_pg[cdst->mc_top], 0, &nullkey);
5438 assert(rc == MDB_SUCCESS);
5445 /** Merge one page into another.
5446 * The nodes from the page pointed to by \b csrc will
5447 * be copied to the page pointed to by \b cdst and then
5448 * the \b csrc page will be freed.
5449 * @param[in] csrc Cursor pointing to the source page.
5450 * @param[in] cdst Cursor pointing to the destination page.
5453 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
5461 DPRINTF("merging page %zu into %zu", csrc->mc_pg[csrc->mc_top]->mp_pgno,
5462 cdst->mc_pg[cdst->mc_top]->mp_pgno);
5464 assert(csrc->mc_snum > 1); /* can't merge root page */
5465 assert(cdst->mc_snum > 1);
5467 /* Mark dst as dirty. */
5468 if ((rc = mdb_page_touch(cdst)))
5471 /* Move all nodes from src to dst.
5473 j = nkeys = NUMKEYS(cdst->mc_pg[cdst->mc_top]);
5474 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5475 key.mv_size = csrc->mc_db->md_pad;
5476 key.mv_data = METADATA(csrc->mc_pg[csrc->mc_top]);
5477 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
5478 rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
5479 if (rc != MDB_SUCCESS)
5481 key.mv_data = (char *)key.mv_data + key.mv_size;
5484 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
5485 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], i);
5486 if (i == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
5487 unsigned int snum = csrc->mc_snum;
5489 /* must find the lowest key below src */
5490 mdb_page_search_root(csrc, NULL, 0);
5491 if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5492 key.mv_size = csrc->mc_db->md_pad;
5493 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
5495 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
5496 key.mv_size = NODEKSZ(s2);
5497 key.mv_data = NODEKEY(s2);
5499 csrc->mc_snum = snum--;
5500 csrc->mc_top = snum;
5502 key.mv_size = srcnode->mn_ksize;
5503 key.mv_data = NODEKEY(srcnode);
5506 data.mv_size = NODEDSZ(srcnode);
5507 data.mv_data = NODEDATA(srcnode);
5508 rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
5509 if (rc != MDB_SUCCESS)
5514 DPRINTF("dst page %zu now has %u keys (%.1f%% filled)",
5515 cdst->mc_pg[cdst->mc_top]->mp_pgno, NUMKEYS(cdst->mc_pg[cdst->mc_top]), (float)PAGEFILL(cdst->mc_txn->mt_env, cdst->mc_pg[cdst->mc_top]) / 10);
5517 /* Unlink the src page from parent and add to free list.
5519 mdb_node_del(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1], 0);
5520 if (csrc->mc_ki[csrc->mc_top-1] == 0) {
5522 if ((rc = mdb_update_key(csrc->mc_pg[csrc->mc_top-1], 0, &key)) != MDB_SUCCESS)
5526 mdb_midl_append(&csrc->mc_txn->mt_free_pgs, csrc->mc_pg[csrc->mc_top]->mp_pgno);
5527 if (IS_LEAF(csrc->mc_pg[csrc->mc_top]))
5528 csrc->mc_db->md_leaf_pages--;
5530 csrc->mc_db->md_branch_pages--;
5532 /* Adjust other cursors pointing to mp */
5533 MDB_cursor *m2, *m3;
5534 MDB_dbi dbi = csrc->mc_dbi;
5535 MDB_page *mp = cdst->mc_pg[cdst->mc_top];
5537 if (csrc->mc_flags & C_SUB)
5540 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5541 if (csrc->mc_flags & C_SUB)
5542 m3 = &m2->mc_xcursor->mx_cursor;
5545 if (m3 == csrc) continue;
5546 if (m3->mc_snum < csrc->mc_snum) continue;
5547 if (m3->mc_pg[csrc->mc_top] == csrc->mc_pg[csrc->mc_top]) {
5548 m3->mc_pg[csrc->mc_top] = mp;
5549 m3->mc_ki[csrc->mc_top] += nkeys;
5553 mdb_cursor_pop(csrc);
5555 return mdb_rebalance(csrc);
5558 /** Copy the contents of a cursor.
5559 * @param[in] csrc The cursor to copy from.
5560 * @param[out] cdst The cursor to copy to.
5563 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
5567 cdst->mc_txn = csrc->mc_txn;
5568 cdst->mc_dbi = csrc->mc_dbi;
5569 cdst->mc_db = csrc->mc_db;
5570 cdst->mc_dbx = csrc->mc_dbx;
5571 cdst->mc_snum = csrc->mc_snum;
5572 cdst->mc_top = csrc->mc_top;
5573 cdst->mc_flags = csrc->mc_flags;
5575 for (i=0; i<csrc->mc_snum; i++) {
5576 cdst->mc_pg[i] = csrc->mc_pg[i];
5577 cdst->mc_ki[i] = csrc->mc_ki[i];
5581 /** Rebalance the tree after a delete operation.
5582 * @param[in] mc Cursor pointing to the page where rebalancing
5584 * @return 0 on success, non-zero on failure.
5587 mdb_rebalance(MDB_cursor *mc)
5597 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5598 DPRINTF("rebalancing %s page %zu (has %u keys, %.1f%% full)",
5599 IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
5600 pgno, NUMKEYS(mc->mc_pg[mc->mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10);
5604 if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD) {
5607 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5608 DPRINTF("no need to rebalance page %zu, above fill threshold",
5614 if (mc->mc_snum < 2) {
5615 MDB_page *mp = mc->mc_pg[0];
5616 if (NUMKEYS(mp) == 0) {
5617 DPUTS("tree is completely empty");
5618 mc->mc_db->md_root = P_INVALID;
5619 mc->mc_db->md_depth = 0;
5620 mc->mc_db->md_leaf_pages = 0;
5621 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
5625 /* Adjust other cursors pointing to mp */
5626 MDB_cursor *m2, *m3;
5627 MDB_dbi dbi = mc->mc_dbi;
5629 if (mc->mc_flags & C_SUB)
5632 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5633 if (m2 == mc) continue;
5634 if (mc->mc_flags & C_SUB)
5635 m3 = &m2->mc_xcursor->mx_cursor;
5638 if (m3->mc_snum < mc->mc_snum) continue;
5639 if (m3->mc_pg[0] == mp) {
5645 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
5646 DPUTS("collapsing root page!");
5647 mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
5648 mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
5649 if ((rc = mdb_page_get(mc->mc_txn, mc->mc_db->md_root,
5652 mc->mc_db->md_depth--;
5653 mc->mc_db->md_branch_pages--;
5655 /* Adjust other cursors pointing to mp */
5656 MDB_cursor *m2, *m3;
5657 MDB_dbi dbi = mc->mc_dbi;
5659 if (mc->mc_flags & C_SUB)
5662 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5663 if (m2 == mc) continue;
5664 if (mc->mc_flags & C_SUB)
5665 m3 = &m2->mc_xcursor->mx_cursor;
5668 if (m3->mc_snum < mc->mc_snum) continue;
5669 if (m3->mc_pg[0] == mp) {
5670 m3->mc_pg[0] = mc->mc_pg[0];
5675 DPUTS("root page doesn't need rebalancing");
5679 /* The parent (branch page) must have at least 2 pointers,
5680 * otherwise the tree is invalid.
5682 ptop = mc->mc_top-1;
5683 assert(NUMKEYS(mc->mc_pg[ptop]) > 1);
5685 /* Leaf page fill factor is below the threshold.
5686 * Try to move keys from left or right neighbor, or
5687 * merge with a neighbor page.
5692 mdb_cursor_copy(mc, &mn);
5693 mn.mc_xcursor = NULL;
5695 if (mc->mc_ki[ptop] == 0) {
5696 /* We're the leftmost leaf in our parent.
5698 DPUTS("reading right neighbor");
5700 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
5701 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
5703 mn.mc_ki[mn.mc_top] = 0;
5704 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
5706 /* There is at least one neighbor to the left.
5708 DPUTS("reading left neighbor");
5710 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
5711 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
5713 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
5714 mc->mc_ki[mc->mc_top] = 0;
5717 DPRINTF("found neighbor page %zu (%u keys, %.1f%% full)",
5718 mn.mc_pg[mn.mc_top]->mp_pgno, NUMKEYS(mn.mc_pg[mn.mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) / 10);
5720 /* If the neighbor page is above threshold and has at least two
5721 * keys, move one key from it.
5723 * Otherwise we should try to merge them.
5725 if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) >= 2)
5726 return mdb_node_move(&mn, mc);
5727 else { /* FIXME: if (has_enough_room()) */
5728 mc->mc_flags &= ~C_INITIALIZED;
5729 if (mc->mc_ki[ptop] == 0)
5730 return mdb_page_merge(&mn, mc);
5732 return mdb_page_merge(mc, &mn);
5736 /** Complete a delete operation started by #mdb_cursor_del(). */
5738 mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf)
5742 /* add overflow pages to free list */
5743 if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5747 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
5748 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
5749 mc->mc_db->md_overflow_pages -= ovpages;
5750 for (i=0; i<ovpages; i++) {
5751 DPRINTF("freed ov page %zu", pg);
5752 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
5756 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], mc->mc_db->md_pad);
5757 mc->mc_db->md_entries--;
5758 rc = mdb_rebalance(mc);
5759 if (rc != MDB_SUCCESS)
5760 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5766 mdb_del(MDB_txn *txn, MDB_dbi dbi,
5767 MDB_val *key, MDB_val *data)
5772 MDB_val rdata, *xdata;
5776 assert(key != NULL);
5778 DPRINTF("====> delete db %u key [%s]", dbi, DKEY(key));
5780 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
5783 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
5787 if (key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
5791 mdb_cursor_init(&mc, txn, dbi, &mx);
5802 rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
5804 rc = mdb_cursor_del(&mc, data ? 0 : MDB_NODUPDATA);
5808 /** Split a page and insert a new node.
5809 * @param[in,out] mc Cursor pointing to the page and desired insertion index.
5810 * The cursor will be updated to point to the actual page and index where
5811 * the node got inserted after the split.
5812 * @param[in] newkey The key for the newly inserted node.
5813 * @param[in] newdata The data for the newly inserted node.
5814 * @param[in] newpgno The page number, if the new node is a branch node.
5815 * @param[in] nflags The #NODE_ADD_FLAGS for the new node.
5816 * @return 0 on success, non-zero on failure.
5819 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
5820 unsigned int nflags)
5823 int rc = MDB_SUCCESS, ins_new = 0, new_root = 0, newpos = 1, did_split = 0;
5826 unsigned int i, j, split_indx, nkeys, pmax;
5828 MDB_val sepkey, rkey, xdata, *rdata = &xdata;
5830 MDB_page *mp, *rp, *pp;
5835 mp = mc->mc_pg[mc->mc_top];
5836 newindx = mc->mc_ki[mc->mc_top];
5838 DPRINTF("-----> splitting %s page %zu and adding [%s] at index %i",
5839 IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
5840 DKEY(newkey), mc->mc_ki[mc->mc_top]);
5842 /* Create a right sibling. */
5843 if ((rp = mdb_page_new(mc, mp->mp_flags, 1)) == NULL)
5845 DPRINTF("new right sibling: page %zu", rp->mp_pgno);
5847 if (mc->mc_snum < 2) {
5848 if ((pp = mdb_page_new(mc, P_BRANCH, 1)) == NULL)
5850 /* shift current top to make room for new parent */
5851 mc->mc_pg[1] = mc->mc_pg[0];
5852 mc->mc_ki[1] = mc->mc_ki[0];
5855 mc->mc_db->md_root = pp->mp_pgno;
5856 DPRINTF("root split! new root = %zu", pp->mp_pgno);
5857 mc->mc_db->md_depth++;
5860 /* Add left (implicit) pointer. */
5861 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
5862 /* undo the pre-push */
5863 mc->mc_pg[0] = mc->mc_pg[1];
5864 mc->mc_ki[0] = mc->mc_ki[1];
5865 mc->mc_db->md_root = mp->mp_pgno;
5866 mc->mc_db->md_depth--;
5873 ptop = mc->mc_top-1;
5874 DPRINTF("parent branch page is %zu", mc->mc_pg[ptop]->mp_pgno);
5877 mc->mc_flags |= C_SPLITTING;
5878 mdb_cursor_copy(mc, &mn);
5879 mn.mc_pg[mn.mc_top] = rp;
5880 mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
5882 if (nflags & MDB_APPEND) {
5883 mn.mc_ki[mn.mc_top] = 0;
5885 split_indx = newindx;
5890 nkeys = NUMKEYS(mp);
5891 split_indx = (nkeys + 1) / 2;
5892 if (newindx < split_indx)
5898 unsigned int lsize, rsize, ksize;
5899 /* Move half of the keys to the right sibling */
5901 x = mc->mc_ki[mc->mc_top] - split_indx;
5902 ksize = mc->mc_db->md_pad;
5903 split = LEAF2KEY(mp, split_indx, ksize);
5904 rsize = (nkeys - split_indx) * ksize;
5905 lsize = (nkeys - split_indx) * sizeof(indx_t);
5906 mp->mp_lower -= lsize;
5907 rp->mp_lower += lsize;
5908 mp->mp_upper += rsize - lsize;
5909 rp->mp_upper -= rsize - lsize;
5910 sepkey.mv_size = ksize;
5911 if (newindx == split_indx) {
5912 sepkey.mv_data = newkey->mv_data;
5914 sepkey.mv_data = split;
5917 ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
5918 memcpy(rp->mp_ptrs, split, rsize);
5919 sepkey.mv_data = rp->mp_ptrs;
5920 memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
5921 memcpy(ins, newkey->mv_data, ksize);
5922 mp->mp_lower += sizeof(indx_t);
5923 mp->mp_upper -= ksize - sizeof(indx_t);
5926 memcpy(rp->mp_ptrs, split, x * ksize);
5927 ins = LEAF2KEY(rp, x, ksize);
5928 memcpy(ins, newkey->mv_data, ksize);
5929 memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
5930 rp->mp_lower += sizeof(indx_t);
5931 rp->mp_upper -= ksize - sizeof(indx_t);
5932 mc->mc_ki[mc->mc_top] = x;
5933 mc->mc_pg[mc->mc_top] = rp;
5938 /* For leaf pages, check the split point based on what
5939 * fits where, since otherwise mdb_node_add can fail.
5941 * This check is only needed when the data items are
5942 * relatively large, such that being off by one will
5943 * make the difference between success or failure.
5944 * When the size of the data items is much smaller than
5945 * one-half of a page, this check is irrelevant.
5948 unsigned int psize, nsize;
5949 /* Maximum free space in an empty page */
5950 pmax = mc->mc_txn->mt_env->me_psize - PAGEHDRSZ;
5951 nsize = mdb_leaf_size(mc->mc_txn->mt_env, newkey, newdata);
5952 if ((nkeys < 20) || (nsize > pmax/4)) {
5953 if (newindx <= split_indx) {
5956 for (i=0; i<split_indx; i++) {
5957 node = NODEPTR(mp, i);
5958 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
5959 if (F_ISSET(node->mn_flags, F_BIGDATA))
5960 psize += sizeof(pgno_t);
5962 psize += NODEDSZ(node);
5965 if (i == split_indx - 1 && newindx == split_indx)
5974 for (i=nkeys-1; i>=split_indx; i--) {
5975 node = NODEPTR(mp, i);
5976 psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
5977 if (F_ISSET(node->mn_flags, F_BIGDATA))
5978 psize += sizeof(pgno_t);
5980 psize += NODEDSZ(node);
5991 /* First find the separating key between the split pages.
5992 * The case where newindx == split_indx is ambiguous; the
5993 * new item could go to the new page or stay on the original
5994 * page. If newpos == 1 it goes to the new page.
5996 if (newindx == split_indx && newpos) {
5997 sepkey.mv_size = newkey->mv_size;
5998 sepkey.mv_data = newkey->mv_data;
6000 node = NODEPTR(mp, split_indx);
6001 sepkey.mv_size = node->mn_ksize;
6002 sepkey.mv_data = NODEKEY(node);
6006 DPRINTF("separator is [%s]", DKEY(&sepkey));
6008 /* Copy separator key to the parent.
6010 if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(mc->mc_txn->mt_env, &sepkey)) {
6014 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
6017 if (mn.mc_snum == mc->mc_snum) {
6018 mc->mc_pg[mc->mc_snum] = mc->mc_pg[mc->mc_top];
6019 mc->mc_ki[mc->mc_snum] = mc->mc_ki[mc->mc_top];
6020 mc->mc_pg[mc->mc_top] = mc->mc_pg[ptop];
6021 mc->mc_ki[mc->mc_top] = mc->mc_ki[ptop];
6026 /* Right page might now have changed parent.
6027 * Check if left page also changed parent.
6029 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
6030 mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
6031 for (i=0; i<ptop; i++) {
6032 mc->mc_pg[i] = mn.mc_pg[i];
6033 mc->mc_ki[i] = mn.mc_ki[i];
6035 mc->mc_pg[ptop] = mn.mc_pg[ptop];
6036 mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
6040 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
6043 mc->mc_flags ^= C_SPLITTING;
6044 if (rc != MDB_SUCCESS) {
6047 if (nflags & MDB_APPEND) {
6048 mc->mc_pg[mc->mc_top] = rp;
6049 mc->mc_ki[mc->mc_top] = 0;
6050 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
6053 for (i=0; i<mc->mc_top; i++)
6054 mc->mc_ki[i] = mn.mc_ki[i];
6061 /* Move half of the keys to the right sibling. */
6063 /* grab a page to hold a temporary copy */
6064 copy = mdb_page_malloc(mc);
6068 copy->mp_pgno = mp->mp_pgno;
6069 copy->mp_flags = mp->mp_flags;
6070 copy->mp_lower = PAGEHDRSZ;
6071 copy->mp_upper = mc->mc_txn->mt_env->me_psize;
6072 mc->mc_pg[mc->mc_top] = copy;
6073 for (i = j = 0; i <= nkeys; j++) {
6074 if (i == split_indx) {
6075 /* Insert in right sibling. */
6076 /* Reset insert index for right sibling. */
6077 if (i != newindx || (newpos ^ ins_new)) {
6079 mc->mc_pg[mc->mc_top] = rp;
6083 if (i == newindx && !ins_new) {
6084 /* Insert the original entry that caused the split. */
6085 rkey.mv_data = newkey->mv_data;
6086 rkey.mv_size = newkey->mv_size;
6095 /* Update index for the new key. */
6096 mc->mc_ki[mc->mc_top] = j;
6097 } else if (i == nkeys) {
6100 node = NODEPTR(mp, i);
6101 rkey.mv_data = NODEKEY(node);
6102 rkey.mv_size = node->mn_ksize;
6104 xdata.mv_data = NODEDATA(node);
6105 xdata.mv_size = NODEDSZ(node);
6108 pgno = NODEPGNO(node);
6109 flags = node->mn_flags;
6114 if (!IS_LEAF(mp) && j == 0) {
6115 /* First branch index doesn't need key data. */
6119 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
6123 nkeys = NUMKEYS(copy);
6124 for (i=0; i<nkeys; i++)
6125 mp->mp_ptrs[i] = copy->mp_ptrs[i];
6126 mp->mp_lower = copy->mp_lower;
6127 mp->mp_upper = copy->mp_upper;
6128 memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
6129 mc->mc_txn->mt_env->me_psize - copy->mp_upper);
6131 /* reset back to original page */
6132 if (newindx < split_indx || (!newpos && newindx == split_indx)) {
6133 mc->mc_pg[mc->mc_top] = mp;
6134 if (nflags & MDB_RESERVE) {
6135 node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
6136 if (!(node->mn_flags & F_BIGDATA))
6137 newdata->mv_data = NODEDATA(node);
6143 /* return tmp page to freelist */
6144 copy->mp_next = mc->mc_txn->mt_env->me_dpages;
6145 VGMEMP_FREE(mc->mc_txn->mt_env, copy);
6146 mc->mc_txn->mt_env->me_dpages = copy;
6149 /* Adjust other cursors pointing to mp */
6150 MDB_cursor *m2, *m3;
6151 MDB_dbi dbi = mc->mc_dbi;
6152 int fixup = NUMKEYS(mp);
6154 if (mc->mc_flags & C_SUB)
6157 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
6158 if (m2 == mc) continue;
6159 if (mc->mc_flags & C_SUB)
6160 m3 = &m2->mc_xcursor->mx_cursor;
6163 if (!(m3->mc_flags & C_INITIALIZED))
6165 if (m3->mc_flags & C_SPLITTING)
6170 for (k=m3->mc_top; k>=0; k--) {
6171 m3->mc_ki[k+1] = m3->mc_ki[k];
6172 m3->mc_pg[k+1] = m3->mc_pg[k];
6174 if (m3->mc_ki[0] >= split_indx) {
6179 m3->mc_pg[0] = mc->mc_pg[0];
6183 if (m3->mc_pg[mc->mc_top] == mp) {
6184 if (m3->mc_ki[mc->mc_top] >= newindx && !(nflags & MDB_SPLIT_REPLACE))
6185 m3->mc_ki[mc->mc_top]++;
6186 if (m3->mc_ki[mc->mc_top] >= fixup) {
6187 m3->mc_pg[mc->mc_top] = rp;
6188 m3->mc_ki[mc->mc_top] -= fixup;
6189 m3->mc_ki[ptop] = mn.mc_ki[ptop];
6191 } else if (!did_split && m3->mc_pg[ptop] == mc->mc_pg[ptop] &&
6192 m3->mc_ki[ptop] >= mc->mc_ki[ptop]) {
6201 mdb_put(MDB_txn *txn, MDB_dbi dbi,
6202 MDB_val *key, MDB_val *data, unsigned int flags)
6207 assert(key != NULL);
6208 assert(data != NULL);
6210 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6213 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
6217 if (key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
6221 if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND)) != flags)
6224 mdb_cursor_init(&mc, txn, dbi, &mx);
6225 return mdb_cursor_put(&mc, key, data, flags);
6228 /** Only a subset of the @ref mdb_env flags can be changed
6229 * at runtime. Changing other flags requires closing the environment
6230 * and re-opening it with the new flags.
6232 #define CHANGEABLE (MDB_NOSYNC|MDB_NOMETASYNC)
6234 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
6236 if ((flag & CHANGEABLE) != flag)
6239 env->me_flags |= flag;
6241 env->me_flags &= ~flag;
6246 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
6251 *arg = env->me_flags;
6256 mdb_env_get_path(MDB_env *env, const char **arg)
6261 *arg = env->me_path;
6265 /** Common code for #mdb_stat() and #mdb_env_stat().
6266 * @param[in] env the environment to operate in.
6267 * @param[in] db the #MDB_db record containing the stats to return.
6268 * @param[out] arg the address of an #MDB_stat structure to receive the stats.
6269 * @return 0, this function always succeeds.
6272 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
6274 arg->ms_psize = env->me_psize;
6275 arg->ms_depth = db->md_depth;
6276 arg->ms_branch_pages = db->md_branch_pages;
6277 arg->ms_leaf_pages = db->md_leaf_pages;
6278 arg->ms_overflow_pages = db->md_overflow_pages;
6279 arg->ms_entries = db->md_entries;
6284 mdb_env_stat(MDB_env *env, MDB_stat *arg)
6288 if (env == NULL || arg == NULL)
6291 toggle = mdb_env_pick_meta(env);
6293 return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
6296 /** Set the default comparison functions for a database.
6297 * Called immediately after a database is opened to set the defaults.
6298 * The user can then override them with #mdb_set_compare() or
6299 * #mdb_set_dupsort().
6300 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
6301 * @param[in] dbi A database handle returned by #mdb_open()
6304 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
6306 uint16_t f = txn->mt_dbs[dbi].md_flags;
6308 txn->mt_dbxs[dbi].md_cmp =
6309 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
6310 (f & MDB_INTEGERKEY) ? mdb_cmp_cint : mdb_cmp_memn;
6312 txn->mt_dbxs[dbi].md_dcmp =
6313 !(f & MDB_DUPSORT) ? 0 :
6314 ((f & MDB_INTEGERDUP)
6315 ? ((f & MDB_DUPFIXED) ? mdb_cmp_int : mdb_cmp_cint)
6316 : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
6319 int mdb_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
6324 int rc, dbflag, exact;
6325 unsigned int unused = 0;
6328 if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
6329 mdb_default_cmp(txn, FREE_DBI);
6335 if (flags & (MDB_DUPSORT|MDB_REVERSEKEY|MDB_INTEGERKEY))
6336 txn->mt_dbs[MAIN_DBI].md_flags |= (flags & (MDB_DUPSORT|MDB_REVERSEKEY|MDB_INTEGERKEY));
6337 mdb_default_cmp(txn, MAIN_DBI);
6341 if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
6342 mdb_default_cmp(txn, MAIN_DBI);
6345 /* Is the DB already open? */
6347 for (i=2; i<txn->mt_numdbs; i++) {
6348 if (!txn->mt_dbxs[i].md_name.mv_size) {
6349 /* Remember this free slot */
6350 if (!unused) unused = i;
6353 if (len == txn->mt_dbxs[i].md_name.mv_size &&
6354 !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
6360 /* If no free slot and max hit, fail */
6361 if (!unused && txn->mt_numdbs >= txn->mt_env->me_maxdbs - 1)
6364 /* Find the DB info */
6368 key.mv_data = (void *)name;
6369 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
6370 rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
6371 if (rc == MDB_SUCCESS) {
6372 /* make sure this is actually a DB */
6373 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
6374 if (!(node->mn_flags & F_SUBDATA))
6376 } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
6377 /* Create if requested */
6379 data.mv_size = sizeof(MDB_db);
6380 data.mv_data = &dummy;
6381 memset(&dummy, 0, sizeof(dummy));
6382 dummy.md_root = P_INVALID;
6383 dummy.md_flags = flags & 0xffff;
6384 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
6388 /* OK, got info, add to table */
6389 if (rc == MDB_SUCCESS) {
6390 unsigned int slot = unused ? unused : txn->mt_numdbs;
6391 txn->mt_dbxs[slot].md_name.mv_data = strdup(name);
6392 txn->mt_dbxs[slot].md_name.mv_size = len;
6393 txn->mt_dbxs[slot].md_rel = NULL;
6394 txn->mt_dbflags[slot] = dbflag;
6395 memcpy(&txn->mt_dbs[slot], data.mv_data, sizeof(MDB_db));
6397 txn->mt_env->me_dbflags[slot] = txn->mt_dbs[slot].md_flags;
6398 mdb_default_cmp(txn, slot);
6401 txn->mt_env->me_numdbs++;
6408 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
6410 if (txn == NULL || arg == NULL || dbi >= txn->mt_numdbs)
6413 return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
6416 void mdb_close(MDB_env *env, MDB_dbi dbi)
6419 if (dbi <= MAIN_DBI || dbi >= env->me_numdbs)
6421 ptr = env->me_dbxs[dbi].md_name.mv_data;
6422 env->me_dbxs[dbi].md_name.mv_data = NULL;
6423 env->me_dbxs[dbi].md_name.mv_size = 0;
6427 /** Add all the DB's pages to the free list.
6428 * @param[in] mc Cursor on the DB to free.
6429 * @param[in] subs non-Zero to check for sub-DBs in this DB.
6430 * @return 0 on success, non-zero on failure.
6433 mdb_drop0(MDB_cursor *mc, int subs)
6437 rc = mdb_page_search(mc, NULL, 0);
6438 if (rc == MDB_SUCCESS) {
6443 /* LEAF2 pages have no nodes, cannot have sub-DBs */
6444 if (!subs || IS_LEAF2(mc->mc_pg[mc->mc_top]))
6447 mdb_cursor_copy(mc, &mx);
6448 while (mc->mc_snum > 0) {
6449 if (IS_LEAF(mc->mc_pg[mc->mc_top])) {
6450 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
6451 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
6452 if (ni->mn_flags & F_SUBDATA) {
6453 mdb_xcursor_init1(mc, ni);
6454 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
6460 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
6462 ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
6465 mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
6470 rc = mdb_cursor_sibling(mc, 1);
6472 /* no more siblings, go back to beginning
6473 * of previous level. (stack was already popped
6474 * by mdb_cursor_sibling)
6476 for (i=1; i<mc->mc_top; i++)
6477 mc->mc_pg[i] = mx.mc_pg[i];
6481 mdb_midl_append(&mc->mc_txn->mt_free_pgs,
6482 mc->mc_db->md_root);
6487 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
6492 if (!txn || !dbi || dbi >= txn->mt_numdbs)
6495 if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
6498 rc = mdb_cursor_open(txn, dbi, &mc);
6502 rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
6506 /* Can't delete the main DB */
6507 if (del && dbi > MAIN_DBI) {
6508 rc = mdb_del(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL);
6510 mdb_close(txn->mt_env, dbi);
6512 txn->mt_dbflags[dbi] |= DB_DIRTY;
6513 txn->mt_dbs[dbi].md_depth = 0;
6514 txn->mt_dbs[dbi].md_branch_pages = 0;
6515 txn->mt_dbs[dbi].md_leaf_pages = 0;
6516 txn->mt_dbs[dbi].md_overflow_pages = 0;
6517 txn->mt_dbs[dbi].md_entries = 0;
6518 txn->mt_dbs[dbi].md_root = P_INVALID;
6521 mdb_cursor_close(mc);
6525 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
6527 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6530 txn->mt_dbxs[dbi].md_cmp = cmp;
6534 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
6536 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6539 txn->mt_dbxs[dbi].md_dcmp = cmp;
6543 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
6545 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6548 txn->mt_dbxs[dbi].md_rel = rel;
6552 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
6554 if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6557 txn->mt_dbxs[dbi].md_relctx = ctx;
projects / openldap / blob