]> git.sur5r.net Git - openldap/blob - libraries/libmdb/mdb.c
344144aadd68b44fb6487a9bb012a7971494d13a
[openldap] / libraries / libmdb / mdb.c
1 /** @file mdb.c
2  *      @brief memory-mapped database library
3  *
4  *      A Btree-based database management library modeled loosely on the
5  *      BerkeleyDB API, but much simplified.
6  */
7 /*
8  * Copyright 2011-2012 Howard Chu, Symas Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted only as authorized by the OpenLDAP
13  * Public License.
14  *
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>.
18  *
19  * This code is derived from btree.c written by Martin Hedenfalk.
20  *
21  * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
22  *
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.
26  *
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.
34  */
35 #include <sys/types.h>
36 #include <sys/stat.h>
37 #include <sys/param.h>
38 #ifdef _WIN32
39 #include <windows.h>
40 #else
41 #include <sys/uio.h>
42 #include <sys/mman.h>
43 #ifdef HAVE_SYS_FILE_H
44 #include <sys/file.h>
45 #endif
46 #include <fcntl.h>
47 #endif
48
49 #include <assert.h>
50 #include <errno.h>
51 #include <limits.h>
52 #include <stddef.h>
53 #include <inttypes.h>
54 #include <stdio.h>
55 #include <stdlib.h>
56 #include <string.h>
57 #include <time.h>
58 #include <unistd.h>
59
60 #if !(defined(BYTE_ORDER) || defined(__BYTE_ORDER))
61 #include <resolv.h>     /* defines BYTE_ORDER on HPUX and Solaris */
62 #endif
63
64 #ifndef _WIN32
65 #include <pthread.h>
66 #ifdef __APPLE__
67 #include <semaphore.h>
68 #endif
69 #endif
70
71 #ifdef USE_VALGRIND
72 #include <valgrind/memcheck.h>
73 #define VGMEMP_CREATE(h,r,z)    VALGRIND_CREATE_MEMPOOL(h,r,z)
74 #define VGMEMP_ALLOC(h,a,s) VALGRIND_MEMPOOL_ALLOC(h,a,s)
75 #define VGMEMP_FREE(h,a) VALGRIND_MEMPOOL_FREE(h,a)
76 #define VGMEMP_DESTROY(h)       VALGRIND_DESTROY_MEMPOOL(h)
77 #define VGMEMP_DEFINED(a,s)     VALGRIND_MAKE_MEM_DEFINED(a,s)
78 #else
79 #define VGMEMP_CREATE(h,r,z)
80 #define VGMEMP_ALLOC(h,a,s)
81 #define VGMEMP_FREE(h,a)
82 #define VGMEMP_DESTROY(h)
83 #define VGMEMP_DEFINED(a,s)
84 #endif
85
86 #ifndef BYTE_ORDER
87 # if (defined(_LITTLE_ENDIAN) || defined(_BIG_ENDIAN)) && !(defined(_LITTLE_ENDIAN) && defined(_BIG_ENDIAN))
88 /* Solaris just defines one or the other */
89 #  define LITTLE_ENDIAN 1234
90 #  define BIG_ENDIAN    4321
91 #  ifdef _LITTLE_ENDIAN
92 #   define BYTE_ORDER  LITTLE_ENDIAN
93 #  else
94 #   define BYTE_ORDER  BIG_ENDIAN
95 #  endif
96 # else
97 #  define BYTE_ORDER   __BYTE_ORDER
98 # endif
99 #endif
100
101 #ifndef LITTLE_ENDIAN
102 #define LITTLE_ENDIAN   __LITTLE_ENDIAN
103 #endif
104 #ifndef BIG_ENDIAN
105 #define BIG_ENDIAN      __BIG_ENDIAN
106 #endif
107
108 #if defined(__i386) || defined(__x86_64)
109 #define MISALIGNED_OK   1
110 #endif
111
112 #include "mdb.h"
113 #include "midl.h"
114
115 #if (BYTE_ORDER == LITTLE_ENDIAN) == (BYTE_ORDER == BIG_ENDIAN)
116 # error "Unknown or unsupported endianness (BYTE_ORDER)"
117 #elif (-6 & 5) || CHAR_BIT != 8 || UINT_MAX < 0xffffffff || ULONG_MAX % 0xFFFF
118 # error "Two's complement, reasonably sized integer types, please"
119 #endif
120
121 /** @defgroup internal  MDB Internals
122  *      @{
123  */
124 /** @defgroup compat    Windows Compatibility Macros
125  *      A bunch of macros to minimize the amount of platform-specific ifdefs
126  *      needed throughout the rest of the code. When the features this library
127  *      needs are similar enough to POSIX to be hidden in a one-or-two line
128  *      replacement, this macro approach is used.
129  *      @{
130  */
131 #ifdef _WIN32
132 #define pthread_t       DWORD
133 #define pthread_mutex_t HANDLE
134 #define pthread_key_t   DWORD
135 #define pthread_self()  GetCurrentThreadId()
136 #define pthread_key_create(x,y) (*(x) = TlsAlloc())
137 #define pthread_key_delete(x)   TlsFree(x)
138 #define pthread_getspecific(x)  TlsGetValue(x)
139 #define pthread_setspecific(x,y)        TlsSetValue(x,y)
140 #define pthread_mutex_unlock(x) ReleaseMutex(x)
141 #define pthread_mutex_lock(x)   WaitForSingleObject(x, INFINITE)
142 #define LOCK_MUTEX_R(env)       pthread_mutex_lock((env)->me_rmutex)
143 #define UNLOCK_MUTEX_R(env)     pthread_mutex_unlock((env)->me_rmutex)
144 #define LOCK_MUTEX_W(env)       pthread_mutex_lock((env)->me_wmutex)
145 #define UNLOCK_MUTEX_W(env)     pthread_mutex_unlock((env)->me_wmutex)
146 #define getpid()        GetCurrentProcessId()
147 #define MDB_FDATASYNC(fd)       (!FlushFileBuffers(fd))
148 #define ErrCode()       GetLastError()
149 #define GET_PAGESIZE(x) {SYSTEM_INFO si; GetSystemInfo(&si); (x) = si.dwPageSize;}
150 #define close(fd)       CloseHandle(fd)
151 #define munmap(ptr,len) UnmapViewOfFile(ptr)
152 #else
153 #ifdef __APPLE__
154 #define LOCK_MUTEX_R(env)       sem_wait((env)->me_rmutex)
155 #define UNLOCK_MUTEX_R(env)     sem_post((env)->me_rmutex)
156 #define LOCK_MUTEX_W(env)       sem_wait((env)->me_wmutex)
157 #define UNLOCK_MUTEX_W(env)     sem_post((env)->me_wmutex)
158 #define MDB_FDATASYNC(fd)       fsync(fd)
159 #else
160 #ifdef ANDROID
161 #define MDB_FDATASYNC(fd)       fsync(fd)
162 #endif
163         /** Lock the reader mutex.
164          */
165 #define LOCK_MUTEX_R(env)       pthread_mutex_lock(&(env)->me_txns->mti_mutex)
166         /** Unlock the reader mutex.
167          */
168 #define UNLOCK_MUTEX_R(env)     pthread_mutex_unlock(&(env)->me_txns->mti_mutex)
169
170         /** Lock the writer mutex.
171          *      Only a single write transaction is allowed at a time. Other writers
172          *      will block waiting for this mutex.
173          */
174 #define LOCK_MUTEX_W(env)       pthread_mutex_lock(&(env)->me_txns->mti_wmutex)
175         /** Unlock the writer mutex.
176          */
177 #define UNLOCK_MUTEX_W(env)     pthread_mutex_unlock(&(env)->me_txns->mti_wmutex)
178 #endif  /* __APPLE__ */
179
180         /** Get the error code for the last failed system function.
181          */
182 #define ErrCode()       errno
183
184         /** An abstraction for a file handle.
185          *      On POSIX systems file handles are small integers. On Windows
186          *      they're opaque pointers.
187          */
188 #define HANDLE  int
189
190         /**     A value for an invalid file handle.
191          *      Mainly used to initialize file variables and signify that they are
192          *      unused.
193          */
194 #define INVALID_HANDLE_VALUE    (-1)
195
196         /** Get the size of a memory page for the system.
197          *      This is the basic size that the platform's memory manager uses, and is
198          *      fundamental to the use of memory-mapped files.
199          */
200 #define GET_PAGESIZE(x) ((x) = sysconf(_SC_PAGE_SIZE))
201 #endif
202
203 #if defined(_WIN32) || defined(__APPLE__)
204 #define MNAME_LEN       32
205 #else
206 #define MNAME_LEN       (sizeof(pthread_mutex_t))
207 #endif
208
209 /** @} */
210
211 #ifndef _WIN32
212 /**     A flag for opening a file and requesting synchronous data writes.
213  *      This is only used when writing a meta page. It's not strictly needed;
214  *      we could just do a normal write and then immediately perform a flush.
215  *      But if this flag is available it saves us an extra system call.
216  *
217  *      @note If O_DSYNC is undefined but exists in /usr/include,
218  * preferably set some compiler flag to get the definition.
219  * Otherwise compile with the less efficient -DMDB_DSYNC=O_SYNC.
220  */
221 #ifndef MDB_DSYNC
222 # define MDB_DSYNC      O_DSYNC
223 #endif
224 #endif
225
226 /** Function for flushing the data of a file. Define this to fsync
227  *      if fdatasync() is not supported.
228  */
229 #ifndef MDB_FDATASYNC
230 # define MDB_FDATASYNC  fdatasync
231 #endif
232
233         /** A page number in the database.
234          *      Note that 64 bit page numbers are overkill, since pages themselves
235          *      already represent 12-13 bits of addressable memory, and the OS will
236          *      always limit applications to a maximum of 63 bits of address space.
237          *
238          *      @note In the #MDB_node structure, we only store 48 bits of this value,
239          *      which thus limits us to only 60 bits of addressable data.
240          */
241 typedef ID      pgno_t;
242
243         /** A transaction ID.
244          *      See struct MDB_txn.mt_txnid for details.
245          */
246 typedef ID      txnid_t;
247
248 /** @defgroup debug     Debug Macros
249  *      @{
250  */
251 #ifndef MDB_DEBUG
252         /**     Enable debug output.
253          *      Set this to 1 for copious tracing. Set to 2 to add dumps of all IDLs
254          *      read from and written to the database (used for free space management).
255          */
256 #define MDB_DEBUG 0
257 #endif
258
259 #if !(__STDC_VERSION__ >= 199901L || defined(__GNUC__))
260 # define DPRINTF        (void)  /* Vararg macros may be unsupported */
261 #elif MDB_DEBUG
262 static int mdb_debug;
263 static txnid_t mdb_debug_start;
264
265         /**     Print a debug message with printf formatting. */
266 # define DPRINTF(fmt, ...)      /**< Requires 2 or more args */ \
267         ((void) ((mdb_debug) && \
268          fprintf(stderr, "%s:%d " fmt "\n", __func__, __LINE__, __VA_ARGS__)))
269 #else
270 # define DPRINTF(fmt, ...)      ((void) 0)
271 #endif
272         /**     Print a debug string.
273          *      The string is printed literally, with no format processing.
274          */
275 #define DPUTS(arg)      DPRINTF("%s", arg)
276 /** @} */
277
278         /** A default memory page size.
279          *      The actual size is platform-dependent, but we use this for
280          *      boot-strapping. We probably should not be using this any more.
281          *      The #GET_PAGESIZE() macro is used to get the actual size.
282          *
283          *      Note that we don't currently support Huge pages. On Linux,
284          *      regular data files cannot use Huge pages, and in general
285          *      Huge pages aren't actually pageable. We rely on the OS
286          *      demand-pager to read our data and page it out when memory
287          *      pressure from other processes is high. So until OSs have
288          *      actual paging support for Huge pages, they're not viable.
289          */
290 #define MDB_PAGESIZE     4096
291
292         /** The minimum number of keys required in a database page.
293          *      Setting this to a larger value will place a smaller bound on the
294          *      maximum size of a data item. Data items larger than this size will
295          *      be pushed into overflow pages instead of being stored directly in
296          *      the B-tree node. This value used to default to 4. With a page size
297          *      of 4096 bytes that meant that any item larger than 1024 bytes would
298          *      go into an overflow page. That also meant that on average 2-3KB of
299          *      each overflow page was wasted space. The value cannot be lower than
300          *      2 because then there would no longer be a tree structure. With this
301          *      value, items larger than 2KB will go into overflow pages, and on
302          *      average only 1KB will be wasted.
303          */
304 #define MDB_MINKEYS      2
305
306         /**     A stamp that identifies a file as an MDB file.
307          *      There's nothing special about this value other than that it is easily
308          *      recognizable, and it will reflect any byte order mismatches.
309          */
310 #define MDB_MAGIC        0xBEEFC0DE
311
312         /**     The version number for a database's file format. */
313 #define MDB_VERSION      1
314
315         /**     The maximum size of a key in the database.
316          *      While data items have essentially unbounded size, we require that
317          *      keys all fit onto a regular page. This limit could be raised a bit
318          *      further if needed; to something just under #MDB_PAGESIZE / #MDB_MINKEYS.
319          */
320 #define MAXKEYSIZE       511
321
322 #if MDB_DEBUG
323         /**     A key buffer.
324          *      @ingroup debug
325          *      This is used for printing a hex dump of a key's contents.
326          */
327 #define DKBUF   char kbuf[(MAXKEYSIZE*2+1)]
328         /**     Display a key in hex.
329          *      @ingroup debug
330          *      Invoke a function to display a key in hex.
331          */
332 #define DKEY(x) mdb_dkey(x, kbuf)
333 #else
334 #define DKBUF   typedef int dummy_kbuf  /* so we can put ';' after */
335 #define DKEY(x) 0
336 #endif
337
338 /**     @defgroup lazylock      Lazy Locking
339  *      Macros for locks that aren't actually needed.
340  *      The DB view is always consistent because all writes are wrapped in
341  *      the wmutex. Finer-grained locks aren't necessary.
342  *      @{
343  */
344 #ifndef LAZY_LOCKS
345         /**     Use lazy locking. I.e., don't lock these accesses at all. */
346 #define LAZY_LOCKS      1
347 #endif
348 #if     LAZY_LOCKS
349         /** Grab the reader lock */
350 #define LAZY_MUTEX_LOCK(x)
351         /** Release the reader lock */
352 #define LAZY_MUTEX_UNLOCK(x)
353         /** Release the DB table reader/writer lock */
354 #define LAZY_RWLOCK_UNLOCK(x)
355         /** Grab the DB table write lock */
356 #define LAZY_RWLOCK_WRLOCK(x)
357         /** Grab the DB table read lock */
358 #define LAZY_RWLOCK_RDLOCK(x)
359         /** Declare the DB table rwlock.  Should not be followed by ';'. */
360 #define LAZY_RWLOCK_DEF(x)
361         /** Initialize the DB table rwlock */
362 #define LAZY_RWLOCK_INIT(x,y)
363         /**     Destroy the DB table rwlock */
364 #define LAZY_RWLOCK_DESTROY(x)
365 #else
366 #define LAZY_MUTEX_LOCK(x)              pthread_mutex_lock(x)
367 #define LAZY_MUTEX_UNLOCK(x)    pthread_mutex_unlock(x)
368 #define LAZY_RWLOCK_UNLOCK(x)   pthread_rwlock_unlock(x)
369 #define LAZY_RWLOCK_WRLOCK(x)   pthread_rwlock_wrlock(x)
370 #define LAZY_RWLOCK_RDLOCK(x)   pthread_rwlock_rdlock(x)
371 #define LAZY_RWLOCK_DEF(x)              pthread_rwlock_t        x;
372 #define LAZY_RWLOCK_INIT(x,y)   pthread_rwlock_init(x,y)
373 #define LAZY_RWLOCK_DESTROY(x)  pthread_rwlock_destroy(x)
374 #endif
375 /** @} */
376
377         /** An invalid page number.
378          *      Mainly used to denote an empty tree.
379          */
380 #define P_INVALID        (~0UL)
381
382         /** Test if a flag \b f is set in a flag word \b w. */
383 #define F_ISSET(w, f)    (((w) & (f)) == (f))
384
385         /**     Used for offsets within a single page.
386          *      Since memory pages are typically 4 or 8KB in size, 12-13 bits,
387          *      this is plenty.
388          */
389 typedef uint16_t         indx_t;
390
391         /**     Default size of memory map.
392          *      This is certainly too small for any actual applications. Apps should always set
393          *      the size explicitly using #mdb_env_set_mapsize().
394          */
395 #define DEFAULT_MAPSIZE 1048576
396
397 /**     @defgroup readers       Reader Lock Table
398  *      Readers don't acquire any locks for their data access. Instead, they
399  *      simply record their transaction ID in the reader table. The reader
400  *      mutex is needed just to find an empty slot in the reader table. The
401  *      slot's address is saved in thread-specific data so that subsequent read
402  *      transactions started by the same thread need no further locking to proceed.
403  *
404  *      Since the database uses multi-version concurrency control, readers don't
405  *      actually need any locking. This table is used to keep track of which
406  *      readers are using data from which old transactions, so that we'll know
407  *      when a particular old transaction is no longer in use. Old transactions
408  *      that have discarded any data pages can then have those pages reclaimed
409  *      for use by a later write transaction.
410  *
411  *      The lock table is constructed such that reader slots are aligned with the
412  *      processor's cache line size. Any slot is only ever used by one thread.
413  *      This alignment guarantees that there will be no contention or cache
414  *      thrashing as threads update their own slot info, and also eliminates
415  *      any need for locking when accessing a slot.
416  *
417  *      A writer thread will scan every slot in the table to determine the oldest
418  *      outstanding reader transaction. Any freed pages older than this will be
419  *      reclaimed by the writer. The writer doesn't use any locks when scanning
420  *      this table. This means that there's no guarantee that the writer will
421  *      see the most up-to-date reader info, but that's not required for correct
422  *      operation - all we need is to know the upper bound on the oldest reader,
423  *      we don't care at all about the newest reader. So the only consequence of
424  *      reading stale information here is that old pages might hang around a
425  *      while longer before being reclaimed. That's actually good anyway, because
426  *      the longer we delay reclaiming old pages, the more likely it is that a
427  *      string of contiguous pages can be found after coalescing old pages from
428  *      many old transactions together.
429  *
430  *      @todo We don't actually do such coalescing yet, we grab pages from one
431  *      old transaction at a time.
432  *      @{
433  */
434         /**     Number of slots in the reader table.
435          *      This value was chosen somewhat arbitrarily. 126 readers plus a
436          *      couple mutexes fit exactly into 8KB on my development machine.
437          *      Applications should set the table size using #mdb_env_set_maxreaders().
438          */
439 #define DEFAULT_READERS 126
440
441         /**     The size of a CPU cache line in bytes. We want our lock structures
442          *      aligned to this size to avoid false cache line sharing in the
443          *      lock table.
444          *      This value works for most CPUs. For Itanium this should be 128.
445          */
446 #ifndef CACHELINE
447 #define CACHELINE       64
448 #endif
449
450         /**     The information we store in a single slot of the reader table.
451          *      In addition to a transaction ID, we also record the process and
452          *      thread ID that owns a slot, so that we can detect stale information,
453          *      e.g. threads or processes that went away without cleaning up.
454          *      @note We currently don't check for stale records. We simply re-init
455          *      the table when we know that we're the only process opening the
456          *      lock file.
457          */
458 typedef struct MDB_rxbody {
459         /**     The current Transaction ID when this transaction began.
460          *      Multiple readers that start at the same time will probably have the
461          *      same ID here. Again, it's not important to exclude them from
462          *      anything; all we need to know is which version of the DB they
463          *      started from so we can avoid overwriting any data used in that
464          *      particular version.
465          */
466         txnid_t         mrb_txnid;
467         /** The process ID of the process owning this reader txn. */
468         pid_t           mrb_pid;
469         /** The thread ID of the thread owning this txn. */
470         pthread_t       mrb_tid;
471 } MDB_rxbody;
472
473         /** The actual reader record, with cacheline padding. */
474 typedef struct MDB_reader {
475         union {
476                 MDB_rxbody mrx;
477                 /** shorthand for mrb_txnid */
478 #define mr_txnid        mru.mrx.mrb_txnid
479 #define mr_pid  mru.mrx.mrb_pid
480 #define mr_tid  mru.mrx.mrb_tid
481                 /** cache line alignment */
482                 char pad[(sizeof(MDB_rxbody)+CACHELINE-1) & ~(CACHELINE-1)];
483         } mru;
484 } MDB_reader;
485
486         /** The header for the reader table.
487          *      The table resides in a memory-mapped file. (This is a different file
488          *      than is used for the main database.)
489          *
490          *      For POSIX the actual mutexes reside in the shared memory of this
491          *      mapped file. On Windows, mutexes are named objects allocated by the
492          *      kernel; we store the mutex names in this mapped file so that other
493          *      processes can grab them. This same approach is also used on
494          *      MacOSX/Darwin (using named semaphores) since MacOSX doesn't support
495          *      process-shared POSIX mutexes. For these cases where a named object
496          *      is used, the object name is derived from a 64 bit FNV hash of the
497          *      environment pathname. As such, naming collisions are extremely
498          *      unlikely. If a collision occurs, the results are unpredictable.
499          */
500 typedef struct MDB_txbody {
501                 /** Stamp identifying this as an MDB file. It must be set
502                  *      to #MDB_MAGIC. */
503         uint32_t        mtb_magic;
504                 /** Version number of this lock file. Must be set to #MDB_VERSION. */
505         uint32_t        mtb_version;
506 #if defined(_WIN32) || defined(__APPLE__)
507         char    mtb_rmname[MNAME_LEN];
508 #else
509                 /** Mutex protecting access to this table.
510                  *      This is the reader lock that #LOCK_MUTEX_R acquires.
511                  */
512         pthread_mutex_t mtb_mutex;
513 #endif
514 #if MDB_VERSION == 1
515                 /**     The ID of the last transaction committed to the database.
516                  *      This is recorded here only for convenience; the value can always
517                  *      be determined by reading the main database meta pages.
518                  *
519                  *      Value is unused, but maintained for backwards compatibility.
520                  *      Drop this or mtb_me_toggle when changing MDB_VERSION.
521                  *      (Reading both should have been done atomically.)
522                  */
523         txnid_t         mtb_txnid;
524 #endif
525                 /** The number of slots that have been used in the reader table.
526                  *      This always records the maximum count, it is not decremented
527                  *      when readers release their slots.
528                  */
529         unsigned        mtb_numreaders;
530                 /**     The ID of the most recent meta page in the database.
531                  *      This is recorded here only for convenience; the value can always
532                  *      be determined by reading the main database meta pages.
533                  */
534         uint32_t        mtb_me_toggle;
535 } MDB_txbody;
536
537         /** The actual reader table definition. */
538 typedef struct MDB_txninfo {
539         union {
540                 MDB_txbody mtb;
541 #define mti_magic       mt1.mtb.mtb_magic
542 #define mti_version     mt1.mtb.mtb_version
543 #define mti_mutex       mt1.mtb.mtb_mutex
544 #define mti_rmname      mt1.mtb.mtb_rmname
545 #if MDB_VERSION == 1
546 #define mti_txnid       mt1.mtb.mtb_txnid
547 #endif
548 #define mti_numreaders  mt1.mtb.mtb_numreaders
549 #define mti_me_toggle   mt1.mtb.mtb_me_toggle
550                 char pad[(sizeof(MDB_txbody)+CACHELINE-1) & ~(CACHELINE-1)];
551         } mt1;
552         union {
553 #if defined(_WIN32) || defined(__APPLE__)
554                 char mt2_wmname[MNAME_LEN];
555 #define mti_wmname      mt2.mt2_wmname
556 #else
557                 pthread_mutex_t mt2_wmutex;
558 #define mti_wmutex      mt2.mt2_wmutex
559 #endif
560                 char pad[(MNAME_LEN+CACHELINE-1) & ~(CACHELINE-1)];
561         } mt2;
562         MDB_reader      mti_readers[1];
563 } MDB_txninfo;
564 /** @} */
565
566 /** Common header for all page types.
567  * Overflow records occupy a number of contiguous pages with no
568  * headers on any page after the first.
569  */
570 typedef struct MDB_page {
571 #define mp_pgno mp_p.p_pgno
572 #define mp_next mp_p.p_next
573         union {
574                 pgno_t          p_pgno; /**< page number */
575                 void *          p_next; /**< for in-memory list of freed structs */
576         } mp_p;
577         uint16_t        mp_pad;
578 /**     @defgroup mdb_page      Page Flags
579  *      @ingroup internal
580  *      Flags for the page headers.
581  *      @{
582  */
583 #define P_BRANCH         0x01           /**< branch page */
584 #define P_LEAF           0x02           /**< leaf page */
585 #define P_OVERFLOW       0x04           /**< overflow page */
586 #define P_META           0x08           /**< meta page */
587 #define P_DIRTY          0x10           /**< dirty page */
588 #define P_LEAF2          0x20           /**< for #MDB_DUPFIXED records */
589 #define P_SUBP           0x40           /**< for #MDB_DUPSORT sub-pages */
590 /** @} */
591         uint16_t        mp_flags;               /**< @ref mdb_page */
592 #define mp_lower        mp_pb.pb.pb_lower
593 #define mp_upper        mp_pb.pb.pb_upper
594 #define mp_pages        mp_pb.pb_pages
595         union {
596                 struct {
597                         indx_t          pb_lower;               /**< lower bound of free space */
598                         indx_t          pb_upper;               /**< upper bound of free space */
599                 } pb;
600                 uint32_t        pb_pages;       /**< number of overflow pages */
601         } mp_pb;
602         indx_t          mp_ptrs[1];             /**< dynamic size */
603 } MDB_page;
604
605         /** Size of the page header, excluding dynamic data at the end */
606 #define PAGEHDRSZ        ((unsigned) offsetof(MDB_page, mp_ptrs))
607
608         /** Address of first usable data byte in a page, after the header */
609 #define METADATA(p)      ((void *)((char *)(p) + PAGEHDRSZ))
610
611         /** Number of nodes on a page */
612 #define NUMKEYS(p)       (((p)->mp_lower - PAGEHDRSZ) >> 1)
613
614         /** The amount of space remaining in the page */
615 #define SIZELEFT(p)      (indx_t)((p)->mp_upper - (p)->mp_lower)
616
617         /** The percentage of space used in the page, in tenths of a percent. */
618 #define PAGEFILL(env, p) (1000L * ((env)->me_psize - PAGEHDRSZ - SIZELEFT(p)) / \
619                                 ((env)->me_psize - PAGEHDRSZ))
620         /** The minimum page fill factor, in tenths of a percent.
621          *      Pages emptier than this are candidates for merging.
622          */
623 #define FILL_THRESHOLD   250
624
625         /** Test if a page is a leaf page */
626 #define IS_LEAF(p)       F_ISSET((p)->mp_flags, P_LEAF)
627         /** Test if a page is a LEAF2 page */
628 #define IS_LEAF2(p)      F_ISSET((p)->mp_flags, P_LEAF2)
629         /** Test if a page is a branch page */
630 #define IS_BRANCH(p)     F_ISSET((p)->mp_flags, P_BRANCH)
631         /** Test if a page is an overflow page */
632 #define IS_OVERFLOW(p)   F_ISSET((p)->mp_flags, P_OVERFLOW)
633         /** Test if a page is a sub page */
634 #define IS_SUBP(p)       F_ISSET((p)->mp_flags, P_SUBP)
635
636         /** The number of overflow pages needed to store the given size. */
637 #define OVPAGES(size, psize)    ((PAGEHDRSZ-1 + (size)) / (psize) + 1)
638
639         /** Header for a single key/data pair within a page.
640          * We guarantee 2-byte alignment for nodes.
641          */
642 typedef struct MDB_node {
643         /** lo and hi are used for data size on leaf nodes and for
644          * child pgno on branch nodes. On 64 bit platforms, flags
645          * is also used for pgno. (Branch nodes have no flags).
646          * They are in host byte order in case that lets some
647          * accesses be optimized into a 32-bit word access.
648          */
649 #define mn_lo mn_offset[BYTE_ORDER!=LITTLE_ENDIAN]
650 #define mn_hi mn_offset[BYTE_ORDER==LITTLE_ENDIAN] /**< part of dsize or pgno */
651         unsigned short  mn_offset[2];   /**< storage for #mn_lo and #mn_hi */
652 /** @defgroup mdb_node Node Flags
653  *      @ingroup internal
654  *      Flags for node headers.
655  *      @{
656  */
657 #define F_BIGDATA        0x01                   /**< data put on overflow page */
658 #define F_SUBDATA        0x02                   /**< data is a sub-database */
659 #define F_DUPDATA        0x04                   /**< data has duplicates */
660
661 /** valid flags for #mdb_node_add() */
662 #define NODE_ADD_FLAGS  (F_DUPDATA|F_SUBDATA|MDB_RESERVE|MDB_APPEND)
663
664 /** @} */
665         unsigned short  mn_flags;               /**< @ref mdb_node */
666         unsigned short  mn_ksize;               /**< key size */
667         char            mn_data[1];                     /**< key and data are appended here */
668 } MDB_node;
669
670         /** Size of the node header, excluding dynamic data at the end */
671 #define NODESIZE         offsetof(MDB_node, mn_data)
672
673         /** Bit position of top word in page number, for shifting mn_flags */
674 #define PGNO_TOPWORD ((pgno_t)-1 > 0xffffffffu ? 32 : 0)
675
676         /** Size of a node in a branch page with a given key.
677          *      This is just the node header plus the key, there is no data.
678          */
679 #define INDXSIZE(k)      (NODESIZE + ((k) == NULL ? 0 : (k)->mv_size))
680
681         /** Size of a node in a leaf page with a given key and data.
682          *      This is node header plus key plus data size.
683          */
684 #define LEAFSIZE(k, d)   (NODESIZE + (k)->mv_size + (d)->mv_size)
685
686         /** Address of node \b i in page \b p */
687 #define NODEPTR(p, i)    ((MDB_node *)((char *)(p) + (p)->mp_ptrs[i]))
688
689         /** Address of the key for the node */
690 #define NODEKEY(node)    (void *)((node)->mn_data)
691
692         /** Address of the data for a node */
693 #define NODEDATA(node)   (void *)((char *)(node)->mn_data + (node)->mn_ksize)
694
695         /** Get the page number pointed to by a branch node */
696 #define NODEPGNO(node) \
697         ((node)->mn_lo | ((pgno_t) (node)->mn_hi << 16) | \
698          (PGNO_TOPWORD ? ((pgno_t) (node)->mn_flags << PGNO_TOPWORD) : 0))
699         /** Set the page number in a branch node */
700 #define SETPGNO(node,pgno)      do { \
701         (node)->mn_lo = (pgno) & 0xffff; (node)->mn_hi = (pgno) >> 16; \
702         if (PGNO_TOPWORD) (node)->mn_flags = (pgno) >> PGNO_TOPWORD; } while(0)
703
704         /** Get the size of the data in a leaf node */
705 #define NODEDSZ(node)    ((node)->mn_lo | ((unsigned)(node)->mn_hi << 16))
706         /** Set the size of the data for a leaf node */
707 #define SETDSZ(node,size)       do { \
708         (node)->mn_lo = (size) & 0xffff; (node)->mn_hi = (size) >> 16;} while(0)
709         /** The size of a key in a node */
710 #define NODEKSZ(node)    ((node)->mn_ksize)
711
712         /** Copy a page number from src to dst */
713 #ifdef MISALIGNED_OK
714 #define COPY_PGNO(dst,src)      dst = src
715 #else
716 #if SIZE_MAX > 4294967295UL
717 #define COPY_PGNO(dst,src)      do { \
718         unsigned short *s, *d;  \
719         s = (unsigned short *)&(src);   \
720         d = (unsigned short *)&(dst);   \
721         *d++ = *s++;    \
722         *d++ = *s++;    \
723         *d++ = *s++;    \
724         *d = *s;        \
725 } while (0)
726 #else
727 #define COPY_PGNO(dst,src)      do { \
728         unsigned short *s, *d;  \
729         s = (unsigned short *)&(src);   \
730         d = (unsigned short *)&(dst);   \
731         *d++ = *s++;    \
732         *d = *s;        \
733 } while (0)
734 #endif
735 #endif
736         /** The address of a key in a LEAF2 page.
737          *      LEAF2 pages are used for #MDB_DUPFIXED sorted-duplicate sub-DBs.
738          *      There are no node headers, keys are stored contiguously.
739          */
740 #define LEAF2KEY(p, i, ks)      ((char *)(p) + PAGEHDRSZ + ((i)*(ks)))
741
742         /** Set the \b node's key into \b key, if requested. */
743 #define MDB_SET_KEY(node, key)  { if ((key) != NULL) { \
744         (key)->mv_size = NODEKSZ(node); (key)->mv_data = NODEKEY(node); } }
745
746         /** Information about a single database in the environment. */
747 typedef struct MDB_db {
748         uint32_t        md_pad;         /**< also ksize for LEAF2 pages */
749         uint16_t        md_flags;       /**< @ref mdb_open */
750         uint16_t        md_depth;       /**< depth of this tree */
751         pgno_t          md_branch_pages;        /**< number of internal pages */
752         pgno_t          md_leaf_pages;          /**< number of leaf pages */
753         pgno_t          md_overflow_pages;      /**< number of overflow pages */
754         size_t          md_entries;             /**< number of data items */
755         pgno_t          md_root;                /**< the root page of this tree */
756 } MDB_db;
757
758         /** Handle for the DB used to track free pages. */
759 #define FREE_DBI        0
760         /** Handle for the default DB. */
761 #define MAIN_DBI        1
762
763         /** Meta page content. */
764 typedef struct MDB_meta {
765                 /** Stamp identifying this as an MDB file. It must be set
766                  *      to #MDB_MAGIC. */
767         uint32_t        mm_magic;
768                 /** Version number of this lock file. Must be set to #MDB_VERSION. */
769         uint32_t        mm_version;
770         void            *mm_address;            /**< address for fixed mapping */
771         size_t          mm_mapsize;                     /**< size of mmap region */
772         MDB_db          mm_dbs[2];                      /**< first is free space, 2nd is main db */
773         /** The size of pages used in this DB */
774 #define mm_psize        mm_dbs[0].md_pad
775         /** Any persistent environment flags. @ref mdb_env */
776 #define mm_flags        mm_dbs[0].md_flags
777         pgno_t          mm_last_pg;                     /**< last used page in file */
778         txnid_t         mm_txnid;                       /**< txnid that committed this page */
779 } MDB_meta;
780
781         /** Buffer for a stack-allocated dirty page.
782          *      The members define size and alignment, and silence type
783          *      aliasing warnings.  They are not used directly; that could
784          *      mean incorrectly using several union members in parallel.
785          */
786 typedef union MDB_pagebuf {
787         char            mb_raw[MDB_PAGESIZE];
788         MDB_page        mb_page;
789         struct {
790                 char            mm_pad[PAGEHDRSZ];
791                 MDB_meta        mm_meta;
792         } mb_metabuf;
793 } MDB_pagebuf;
794
795         /** Auxiliary DB info.
796          *      The information here is mostly static/read-only. There is
797          *      only a single copy of this record in the environment.
798          */
799 typedef struct MDB_dbx {
800         MDB_val         md_name;                /**< name of the database */
801         MDB_cmp_func    *md_cmp;        /**< function for comparing keys */
802         MDB_cmp_func    *md_dcmp;       /**< function for comparing data items */
803         MDB_rel_func    *md_rel;        /**< user relocate function */
804         void            *md_relctx;             /**< user-provided context for md_rel */
805 } MDB_dbx;
806
807         /** A database transaction.
808          *      Every operation requires a transaction handle.
809          */
810 struct MDB_txn {
811         MDB_txn         *mt_parent;             /**< parent of a nested txn */
812         MDB_txn         *mt_child;              /**< nested txn under this txn */
813         pgno_t          mt_next_pgno;   /**< next unallocated page */
814         /** The ID of this transaction. IDs are integers incrementing from 1.
815          *      Only committed write transactions increment the ID. If a transaction
816          *      aborts, the ID may be re-used by the next writer.
817          */
818         txnid_t         mt_txnid;
819         MDB_env         *mt_env;                /**< the DB environment */
820         /** The list of pages that became unused during this transaction.
821          */
822         IDL                     mt_free_pgs;
823         union {
824                 ID2L    dirty_list;     /**< modified pages */
825                 MDB_reader      *reader;        /**< this thread's slot in the reader table */
826         } mt_u;
827         /** Array of records for each DB known in the environment. */
828         MDB_dbx         *mt_dbxs;
829         /** Array of MDB_db records for each known DB */
830         MDB_db          *mt_dbs;
831 /** @defgroup mt_dbflag Transaction DB Flags
832  *      @ingroup internal
833  * @{
834  */
835 #define DB_DIRTY        0x01            /**< DB was written in this txn */
836 #define DB_STALE        0x02            /**< DB record is older than txnID */
837 /** @} */
838         /** Array of cursors for each DB */
839         MDB_cursor      **mt_cursors;
840         /** Array of flags for each DB */
841         unsigned char   *mt_dbflags;
842         /**     Number of DB records in use. This number only ever increments;
843          *      we don't decrement it when individual DB handles are closed.
844          */
845         MDB_dbi         mt_numdbs;
846
847 /** @defgroup mdb_txn   Transaction Flags
848  *      @ingroup internal
849  *      @{
850  */
851 #define MDB_TXN_RDONLY          0x01            /**< read-only transaction */
852 #define MDB_TXN_ERROR           0x02            /**< an error has occurred */
853 /** @} */
854         unsigned int    mt_flags;               /**< @ref mdb_txn */
855         /** Tracks which of the two meta pages was used at the start
856          *      of this transaction.
857          */
858         unsigned int    mt_toggle;
859 };
860
861 /** Enough space for 2^32 nodes with minimum of 2 keys per node. I.e., plenty.
862  * At 4 keys per node, enough for 2^64 nodes, so there's probably no need to
863  * raise this on a 64 bit machine.
864  */
865 #define CURSOR_STACK             32
866
867 struct MDB_xcursor;
868
869         /** Cursors are used for all DB operations */
870 struct MDB_cursor {
871         /** Next cursor on this DB in this txn */
872         MDB_cursor      *mc_next;
873         /** Original cursor if this is a shadow */
874         MDB_cursor      *mc_orig;
875         /** Context used for databases with #MDB_DUPSORT, otherwise NULL */
876         struct MDB_xcursor      *mc_xcursor;
877         /** The transaction that owns this cursor */
878         MDB_txn         *mc_txn;
879         /** The database handle this cursor operates on */
880         MDB_dbi         mc_dbi;
881         /** The database record for this cursor */
882         MDB_db          *mc_db;
883         /** The database auxiliary record for this cursor */
884         MDB_dbx         *mc_dbx;
885         /** The @ref mt_dbflag for this database */
886         unsigned char   *mc_dbflag;
887         unsigned short  mc_snum;        /**< number of pushed pages */
888         unsigned short  mc_top;         /**< index of top page, normally mc_snum-1 */
889 /** @defgroup mdb_cursor        Cursor Flags
890  *      @ingroup internal
891  *      Cursor state flags.
892  *      @{
893  */
894 #define C_INITIALIZED   0x01    /**< cursor has been initialized and is valid */
895 #define C_EOF   0x02                    /**< No more data */
896 #define C_SUB   0x04                    /**< Cursor is a sub-cursor */
897 #define C_SHADOW        0x08            /**< Cursor is a dup from a parent txn */
898 #define C_ALLOCD        0x10            /**< Cursor was malloc'd */
899 /** @} */
900         unsigned int    mc_flags;       /**< @ref mdb_cursor */
901         MDB_page        *mc_pg[CURSOR_STACK];   /**< stack of pushed pages */
902         indx_t          mc_ki[CURSOR_STACK];    /**< stack of page indices */
903 };
904
905         /** Context for sorted-dup records.
906          *      We could have gone to a fully recursive design, with arbitrarily
907          *      deep nesting of sub-databases. But for now we only handle these
908          *      levels - main DB, optional sub-DB, sorted-duplicate DB.
909          */
910 typedef struct MDB_xcursor {
911         /** A sub-cursor for traversing the Dup DB */
912         MDB_cursor mx_cursor;
913         /** The database record for this Dup DB */
914         MDB_db  mx_db;
915         /**     The auxiliary DB record for this Dup DB */
916         MDB_dbx mx_dbx;
917         /** The @ref mt_dbflag for this Dup DB */
918         unsigned char mx_dbflag;
919 } MDB_xcursor;
920
921         /** A set of pages freed by an earlier transaction. */
922 typedef struct MDB_oldpages {
923         /** Usually we only read one record from the FREEDB at a time, but
924          *      in case we read more, this will chain them together.
925          */
926         struct MDB_oldpages *mo_next;
927         /**     The ID of the transaction in which these pages were freed. */
928         txnid_t         mo_txnid;
929         /** An #IDL of the pages */
930         pgno_t          mo_pages[1];    /* dynamic */
931 } MDB_oldpages;
932
933         /** The database environment. */
934 struct MDB_env {
935         HANDLE          me_fd;          /**< The main data file */
936         HANDLE          me_lfd;         /**< The lock file */
937         HANDLE          me_mfd;                 /**< just for writing the meta pages */
938         /** Failed to update the meta page. Probably an I/O error. */
939 #define MDB_FATAL_ERROR 0x80000000U
940         uint32_t        me_flags;               /**< @ref mdb_env */
941         uint32_t        me_extrapad;    /**< unused for now */
942         unsigned int    me_maxreaders;  /**< size of the reader table */
943         MDB_dbi         me_numdbs;              /**< number of DBs opened */
944         MDB_dbi         me_maxdbs;              /**< size of the DB table */
945         char            *me_path;               /**< path to the DB files */
946         char            *me_map;                /**< the memory map of the data file */
947         MDB_txninfo     *me_txns;               /**< the memory map of the lock file */
948         MDB_meta        *me_metas[2];   /**< pointers to the two meta pages */
949         MDB_txn         *me_txn;                /**< current write transaction */
950         size_t          me_mapsize;             /**< size of the data memory map */
951         off_t           me_size;                /**< current file size */
952         pgno_t          me_maxpg;               /**< me_mapsize / me_psize */
953         unsigned int    me_psize;       /**< size of a page, from #GET_PAGESIZE */
954         unsigned int    me_db_toggle;   /**< which DB table is current */
955         txnid_t         me_wtxnid;              /**< ID of last txn we committed */
956         txnid_t         me_pgfirst;             /**< ID of first old page record we used */
957         txnid_t         me_pglast;              /**< ID of last old page record we used */
958         MDB_dbx         *me_dbxs;               /**< array of static DB info */
959         MDB_db          *me_dbs[2];             /**< two arrays of MDB_db info */
960         MDB_oldpages *me_pghead;        /**< list of old page records */
961         pthread_key_t   me_txkey;       /**< thread-key for readers */
962         MDB_page        *me_dpages;             /**< list of malloc'd blocks for re-use */
963         /** IDL of pages that became unused in a write txn */
964         IDL                     me_free_pgs;
965         /** ID2L of pages that were written during a write txn */
966         ID2                     me_dirty_list[MDB_IDL_UM_SIZE];
967         /** rwlock for the DB tables, if #LAZY_LOCKS is false */
968         LAZY_RWLOCK_DEF(me_dblock)
969 #ifdef _WIN32
970         HANDLE          me_rmutex;              /* Windows mutexes don't reside in shared mem */
971         HANDLE          me_wmutex;
972 #endif
973 #ifdef __APPLE__
974         sem_t           *me_rmutex;             /* Apple doesn't support shared mutexes */
975         sem_t           *me_wmutex;
976 #endif
977 };
978         /** max number of pages to commit in one writev() call */
979 #define MDB_COMMIT_PAGES         64
980 #if defined(IOV_MAX) && IOV_MAX < MDB_COMMIT_PAGES
981 #undef MDB_COMMIT_PAGES
982 #define MDB_COMMIT_PAGES        IOV_MAX
983 #endif
984
985 static MDB_page *mdb_page_alloc(MDB_cursor *mc, int num);
986 static MDB_page *mdb_page_new(MDB_cursor *mc, uint32_t flags, int num);
987 static int              mdb_page_touch(MDB_cursor *mc);
988
989 static int  mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **mp);
990 static int  mdb_page_search_root(MDB_cursor *mc,
991                             MDB_val *key, int modify);
992 static int  mdb_page_search(MDB_cursor *mc,
993                             MDB_val *key, int modify);
994 static int      mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst);
995 static int      mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata,
996                                 pgno_t newpgno, unsigned int nflags);
997
998 static int  mdb_env_read_header(MDB_env *env, MDB_meta *meta);
999 static int  mdb_env_read_meta(MDB_env *env, int *which);
1000 static int  mdb_env_write_meta(MDB_txn *txn);
1001
1002 static MDB_node *mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp);
1003 static int  mdb_node_add(MDB_cursor *mc, indx_t indx,
1004                             MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags);
1005 static void mdb_node_del(MDB_page *mp, indx_t indx, int ksize);
1006 static void mdb_node_shrink(MDB_page *mp, indx_t indx);
1007 static int      mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst);
1008 static int  mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data);
1009 static size_t   mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data);
1010 static size_t   mdb_branch_size(MDB_env *env, MDB_val *key);
1011
1012 static int      mdb_rebalance(MDB_cursor *mc);
1013 static int      mdb_update_key(MDB_page *mp, indx_t indx, MDB_val *key);
1014
1015 static void     mdb_cursor_pop(MDB_cursor *mc);
1016 static int      mdb_cursor_push(MDB_cursor *mc, MDB_page *mp);
1017
1018 static int      mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf);
1019 static int      mdb_cursor_sibling(MDB_cursor *mc, int move_right);
1020 static int      mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1021 static int      mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op);
1022 static int      mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op,
1023                                 int *exactp);
1024 static int      mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1025 static int      mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data);
1026
1027 static void     mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx);
1028 static void     mdb_xcursor_init0(MDB_cursor *mc);
1029 static void     mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node);
1030
1031 static int      mdb_drop0(MDB_cursor *mc, int subs);
1032 static void mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi);
1033
1034 /** @cond */
1035 static MDB_cmp_func     mdb_cmp_memn, mdb_cmp_memnr, mdb_cmp_int, mdb_cmp_cint, mdb_cmp_long;
1036 /** @endcond */
1037
1038 #ifdef _WIN32
1039 static SECURITY_DESCRIPTOR mdb_null_sd;
1040 static SECURITY_ATTRIBUTES mdb_all_sa;
1041 static int mdb_sec_inited;
1042 #endif
1043
1044 /** Return the library version info. */
1045 char *
1046 mdb_version(int *major, int *minor, int *patch)
1047 {
1048         if (major) *major = MDB_VERSION_MAJOR;
1049         if (minor) *minor = MDB_VERSION_MINOR;
1050         if (patch) *patch = MDB_VERSION_PATCH;
1051         return MDB_VERSION_STRING;
1052 }
1053
1054 /** Table of descriptions for MDB @ref errors */
1055 static char *const mdb_errstr[] = {
1056         "MDB_KEYEXIST: Key/data pair already exists",
1057         "MDB_NOTFOUND: No matching key/data pair found",
1058         "MDB_PAGE_NOTFOUND: Requested page not found",
1059         "MDB_CORRUPTED: Located page was wrong type",
1060         "MDB_PANIC: Update of meta page failed",
1061         "MDB_VERSION_MISMATCH: Database environment version mismatch"
1062 };
1063
1064 char *
1065 mdb_strerror(int err)
1066 {
1067         if (!err)
1068                 return ("Successful return: 0");
1069
1070         if (err >= MDB_KEYEXIST && err <= MDB_VERSION_MISMATCH)
1071                 return mdb_errstr[err - MDB_KEYEXIST];
1072
1073         return strerror(err);
1074 }
1075
1076 #if MDB_DEBUG
1077 /** Display a key in hexadecimal and return the address of the result.
1078  * @param[in] key the key to display
1079  * @param[in] buf the buffer to write into. Should always be #DKBUF.
1080  * @return The key in hexadecimal form.
1081  */
1082 char *
1083 mdb_dkey(MDB_val *key, char *buf)
1084 {
1085         char *ptr = buf;
1086         unsigned char *c = key->mv_data;
1087         unsigned int i;
1088         if (key->mv_size > MAXKEYSIZE)
1089                 return "MAXKEYSIZE";
1090         /* may want to make this a dynamic check: if the key is mostly
1091          * printable characters, print it as-is instead of converting to hex.
1092          */
1093 #if 1
1094         buf[0] = '\0';
1095         for (i=0; i<key->mv_size; i++)
1096                 ptr += sprintf(ptr, "%02x", *c++);
1097 #else
1098         sprintf(buf, "%.*s", key->mv_size, key->mv_data);
1099 #endif
1100         return buf;
1101 }
1102
1103 /** Display all the keys in the page. */
1104 static void
1105 mdb_page_keys(MDB_page *mp)
1106 {
1107         MDB_node *node;
1108         unsigned int i, nkeys;
1109         MDB_val key;
1110         DKBUF;
1111
1112         nkeys = NUMKEYS(mp);
1113         DPRINTF("numkeys %d", nkeys);
1114         for (i=0; i<nkeys; i++) {
1115                 node = NODEPTR(mp, i);
1116                 key.mv_size = node->mn_ksize;
1117                 key.mv_data = node->mn_data;
1118                 DPRINTF("key %d: %s", i, DKEY(&key));
1119         }
1120 }
1121 #endif
1122
1123 #if MDB_DEBUG > 2
1124 /** Count all the pages in each DB and in the freelist
1125  *  and make sure it matches the actual number of pages
1126  *  being used.
1127  */
1128 static void mdb_audit(MDB_txn *txn)
1129 {
1130         MDB_cursor mc;
1131         MDB_val key, data;
1132         MDB_dbi i;
1133         int rc;
1134         ID freecount, count;
1135
1136         freecount = 0;
1137         mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1138         while ((rc = mdb_cursor_get(&mc, &key, &data, MDB_NEXT)) == 0)
1139                 freecount += *(ID *)data.mv_data;
1140         freecount += txn->mt_dbs[0].md_branch_pages + txn->mt_dbs[0].md_leaf_pages +
1141                 txn->mt_dbs[0].md_overflow_pages;
1142
1143         count = 0;
1144         for (i = 0; i<txn->mt_numdbs; i++) {
1145                 count += txn->mt_dbs[i].md_branch_pages +
1146                         txn->mt_dbs[i].md_leaf_pages +
1147                         txn->mt_dbs[i].md_overflow_pages;
1148                 if (txn->mt_dbs[i].md_flags & MDB_DUPSORT) {
1149                         MDB_xcursor mx;
1150                         mdb_cursor_init(&mc, txn, i, &mx);
1151                         mdb_page_search(&mc, NULL, 0);
1152                         do {
1153                                 unsigned j;
1154                                 MDB_page *mp;
1155                                 mp = mc.mc_pg[mc.mc_top];
1156                                 for (j=0; j<NUMKEYS(mp); j++) {
1157                                         MDB_node *leaf = NODEPTR(mp, j);
1158                                         if (leaf->mn_flags & F_SUBDATA) {
1159                                                 MDB_db db;
1160                                                 memcpy(&db, NODEDATA(leaf), sizeof(db));
1161                                                 count += db.md_branch_pages + db.md_leaf_pages +
1162                                                         db.md_overflow_pages;
1163                                         }
1164                                 }
1165                         }
1166                         while (mdb_cursor_sibling(&mc, 1) == 0);
1167                 }
1168         }
1169         assert(freecount + count + 2 >= txn->mt_next_pgno - 1);
1170 }
1171 #endif
1172
1173 int
1174 mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1175 {
1176         return txn->mt_dbxs[dbi].md_cmp(a, b);
1177 }
1178
1179 int
1180 mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
1181 {
1182         if (txn->mt_dbxs[dbi].md_dcmp)
1183                 return txn->mt_dbxs[dbi].md_dcmp(a, b);
1184         else
1185                 return EINVAL;  /* too bad you can't distinguish this from a valid result */
1186 }
1187
1188 /** Allocate a single page.
1189  * Re-use old malloc'd pages first, otherwise just malloc.
1190  */
1191 static MDB_page *
1192 mdb_page_malloc(MDB_cursor *mc) {
1193         MDB_page *ret;
1194         size_t sz = mc->mc_txn->mt_env->me_psize;
1195         if ((ret = mc->mc_txn->mt_env->me_dpages) != NULL) {
1196                 VGMEMP_ALLOC(mc->mc_txn->mt_env, ret, sz);
1197                 VGMEMP_DEFINED(ret, sizeof(ret->mp_next));
1198                 mc->mc_txn->mt_env->me_dpages = ret->mp_next;
1199         } else if ((ret = malloc(sz)) != NULL) {
1200                 VGMEMP_ALLOC(mc->mc_txn->mt_env, ret, sz);
1201         }
1202         return ret;
1203 }
1204
1205 /** Allocate pages for writing.
1206  * If there are free pages available from older transactions, they
1207  * will be re-used first. Otherwise a new page will be allocated.
1208  * @param[in] mc cursor A cursor handle identifying the transaction and
1209  *      database for which we are allocating.
1210  * @param[in] num the number of pages to allocate.
1211  * @return Address of the allocated page(s). Requests for multiple pages
1212  *  will always be satisfied by a single contiguous chunk of memory.
1213  */
1214 static MDB_page *
1215 mdb_page_alloc(MDB_cursor *mc, int num)
1216 {
1217         MDB_txn *txn = mc->mc_txn;
1218         MDB_page *np;
1219         pgno_t pgno = P_INVALID;
1220         ID2 mid;
1221
1222         if (txn->mt_txnid > 2) {
1223
1224                 if (!txn->mt_env->me_pghead &&
1225                         txn->mt_dbs[FREE_DBI].md_root != P_INVALID) {
1226                         /* See if there's anything in the free DB */
1227                         MDB_cursor m2;
1228                         MDB_node *leaf;
1229                         MDB_val data;
1230                         txnid_t *kptr, oldest, last;
1231
1232                         mdb_cursor_init(&m2, txn, FREE_DBI, NULL);
1233                         if (!txn->mt_env->me_pgfirst) {
1234                                 mdb_page_search(&m2, NULL, 0);
1235                                 leaf = NODEPTR(m2.mc_pg[m2.mc_top], 0);
1236                                 kptr = (txnid_t *)NODEKEY(leaf);
1237                                 last = *kptr;
1238                         } else {
1239                                 MDB_val key;
1240                                 int rc, exact;
1241 again:
1242                                 exact = 0;
1243                                 last = txn->mt_env->me_pglast + 1;
1244                                 leaf = NULL;
1245                                 key.mv_data = &last;
1246                                 key.mv_size = sizeof(last);
1247                                 rc = mdb_cursor_set(&m2, &key, &data, MDB_SET, &exact);
1248                                 if (rc)
1249                                         goto none;
1250                                 last = *(txnid_t *)key.mv_data;
1251                         }
1252
1253                         {
1254                                 unsigned int i;
1255                                 oldest = txn->mt_txnid - 1;
1256                                 for (i=0; i<txn->mt_env->me_txns->mti_numreaders; i++) {
1257                                         txnid_t mr = txn->mt_env->me_txns->mti_readers[i].mr_txnid;
1258                                         if (mr && mr < oldest)
1259                                                 oldest = mr;
1260                                 }
1261                         }
1262
1263                         if (oldest > last) {
1264                                 /* It's usable, grab it.
1265                                  */
1266                                 MDB_oldpages *mop;
1267                                 pgno_t *idl;
1268
1269                                 if (!txn->mt_env->me_pgfirst) {
1270                                         mdb_node_read(txn, leaf, &data);
1271                                 }
1272                                 txn->mt_env->me_pglast = last;
1273                                 if (!txn->mt_env->me_pgfirst)
1274                                         txn->mt_env->me_pgfirst = last;
1275                                 idl = (ID *) data.mv_data;
1276                                 /* We might have a zero-length IDL due to freelist growth
1277                                  * during a prior commit
1278                                  */
1279                                 if (!idl[0]) goto again;
1280                                 mop = malloc(sizeof(MDB_oldpages) + MDB_IDL_SIZEOF(idl) - sizeof(pgno_t));
1281                                 mop->mo_next = txn->mt_env->me_pghead;
1282                                 mop->mo_txnid = last;
1283                                 txn->mt_env->me_pghead = mop;
1284                                 memcpy(mop->mo_pages, idl, MDB_IDL_SIZEOF(idl));
1285
1286 #if MDB_DEBUG > 1
1287                                 {
1288                                         unsigned int i;
1289                                         DPRINTF("IDL read txn %zu root %zu num %zu",
1290                                                 mop->mo_txnid, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
1291                                         for (i=0; i<idl[0]; i++) {
1292                                                 DPRINTF("IDL %zu", idl[i+1]);
1293                                         }
1294                                 }
1295 #endif
1296                         }
1297                 }
1298 none:
1299                 if (txn->mt_env->me_pghead) {
1300                         MDB_oldpages *mop = txn->mt_env->me_pghead;
1301                         if (num > 1) {
1302                                 /* FIXME: For now, always use fresh pages. We
1303                                  * really ought to search the free list for a
1304                                  * contiguous range.
1305                                  */
1306                                 ;
1307                         } else {
1308                                 /* peel pages off tail, so we only have to truncate the list */
1309                                 pgno = MDB_IDL_LAST(mop->mo_pages);
1310                                 if (MDB_IDL_IS_RANGE(mop->mo_pages)) {
1311                                         mop->mo_pages[2]++;
1312                                         if (mop->mo_pages[2] > mop->mo_pages[1])
1313                                                 mop->mo_pages[0] = 0;
1314                                 } else {
1315                                         mop->mo_pages[0]--;
1316                                 }
1317                                 if (MDB_IDL_IS_ZERO(mop->mo_pages)) {
1318                                         txn->mt_env->me_pghead = mop->mo_next;
1319                                         free(mop);
1320                                 }
1321                         }
1322                 }
1323         }
1324
1325         if (pgno == P_INVALID) {
1326                 /* DB size is maxed out */
1327                 if (txn->mt_next_pgno + num >= txn->mt_env->me_maxpg) {
1328                         DPUTS("DB size maxed out");
1329                         return NULL;
1330                 }
1331         }
1332         if (txn->mt_env->me_dpages && num == 1) {
1333                 np = txn->mt_env->me_dpages;
1334                 VGMEMP_ALLOC(txn->mt_env, np, txn->mt_env->me_psize);
1335                 VGMEMP_DEFINED(np, sizeof(np->mp_next));
1336                 txn->mt_env->me_dpages = np->mp_next;
1337         } else {
1338                 size_t sz = txn->mt_env->me_psize * num;
1339                 if ((np = malloc(sz)) == NULL)
1340                         return NULL;
1341                 VGMEMP_ALLOC(txn->mt_env, np, sz);
1342         }
1343         if (pgno == P_INVALID) {
1344                 np->mp_pgno = txn->mt_next_pgno;
1345                 txn->mt_next_pgno += num;
1346         } else {
1347                 np->mp_pgno = pgno;
1348         }
1349         mid.mid = np->mp_pgno;
1350         mid.mptr = np;
1351         mdb_mid2l_insert(txn->mt_u.dirty_list, &mid);
1352
1353         return np;
1354 }
1355
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.
1359  */
1360 static int
1361 mdb_page_touch(MDB_cursor *mc)
1362 {
1363         MDB_page *mp = mc->mc_pg[mc->mc_top];
1364         pgno_t  pgno;
1365
1366         if (!F_ISSET(mp->mp_flags, P_DIRTY)) {
1367                 MDB_page *np;
1368                 if ((np = mdb_page_alloc(mc, 1)) == NULL)
1369                         return ENOMEM;
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);
1373                 pgno = np->mp_pgno;
1374                 memcpy(np, mp, mc->mc_txn->mt_env->me_psize);
1375                 mp = np;
1376                 mp->mp_pgno = pgno;
1377                 mp->mp_flags |= P_DIRTY;
1378
1379 finish:
1380                 /* Adjust other cursors pointing to mp */
1381                 if (mc->mc_flags & C_SUB) {
1382                         MDB_cursor *m2, *m3;
1383                         MDB_dbi dbi = mc->mc_dbi-1;
1384
1385                         for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
1386                                 if (m2 == mc) continue;
1387                                 m3 = &m2->mc_xcursor->mx_cursor;
1388                                 if (m3->mc_snum < mc->mc_snum) continue;
1389                                 if (m3->mc_pg[mc->mc_top] == mc->mc_pg[mc->mc_top]) {
1390                                         m3->mc_pg[mc->mc_top] = mp;
1391                                 }
1392                         }
1393                 } else {
1394                         MDB_cursor *m2;
1395
1396                         for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
1397                                 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
1398                                 if (m2->mc_pg[mc->mc_top] == mc->mc_pg[mc->mc_top]) {
1399                                         m2->mc_pg[mc->mc_top] = mp;
1400                                 }
1401                         }
1402                 }
1403                 mc->mc_pg[mc->mc_top] = mp;
1404                 /** If this page has a parent, update the parent to point to
1405                  * this new page.
1406                  */
1407                 if (mc->mc_top)
1408                         SETPGNO(NODEPTR(mc->mc_pg[mc->mc_top-1], mc->mc_ki[mc->mc_top-1]), mp->mp_pgno);
1409                 else
1410                         mc->mc_db->md_root = mp->mp_pgno;
1411         } else if (mc->mc_txn->mt_parent) {
1412                 MDB_page *np;
1413                 ID2 mid;
1414                 /* If txn has a parent, make sure the page is in our
1415                  * dirty list.
1416                  */
1417                 if (mc->mc_txn->mt_u.dirty_list[0].mid) {
1418                         unsigned x = mdb_mid2l_search(mc->mc_txn->mt_u.dirty_list, mp->mp_pgno);
1419                         if (x <= mc->mc_txn->mt_u.dirty_list[0].mid &&
1420                                 mc->mc_txn->mt_u.dirty_list[x].mid == mp->mp_pgno) {
1421                                 if (mc->mc_txn->mt_u.dirty_list[x].mptr != mp) {
1422                                         mp = mc->mc_txn->mt_u.dirty_list[x].mptr;
1423                                         mc->mc_pg[mc->mc_top] = mp;
1424                                 }
1425                                 return 0;
1426                         }
1427                 }
1428                 /* No - copy it */
1429                 np = mdb_page_malloc(mc);
1430                 memcpy(np, mp, mc->mc_txn->mt_env->me_psize);
1431                 mid.mid = np->mp_pgno;
1432                 mid.mptr = np;
1433                 mdb_mid2l_insert(mc->mc_txn->mt_u.dirty_list, &mid);
1434                 mp = np;
1435                 goto finish;
1436         }
1437         return 0;
1438 }
1439
1440 int
1441 mdb_env_sync(MDB_env *env, int force)
1442 {
1443         int rc = 0;
1444         if (force || !F_ISSET(env->me_flags, MDB_NOSYNC)) {
1445                 if (MDB_FDATASYNC(env->me_fd))
1446                         rc = ErrCode();
1447         }
1448         return rc;
1449 }
1450
1451 /** Make shadow copies of all of parent txn's cursors */
1452 static int
1453 mdb_cursor_shadow(MDB_txn *src, MDB_txn *dst)
1454 {
1455         MDB_cursor *mc, *m2;
1456         unsigned int i, j, size;
1457
1458         for (i=0;i<src->mt_numdbs; i++) {
1459                 if (src->mt_cursors[i]) {
1460                         size = sizeof(MDB_cursor);
1461                         if (src->mt_cursors[i]->mc_xcursor)
1462                                 size += sizeof(MDB_xcursor);
1463                         for (m2 = src->mt_cursors[i]; m2; m2=m2->mc_next) {
1464                                 mc = malloc(size);
1465                                 if (!mc)
1466                                         return ENOMEM;
1467                                 mc->mc_orig = m2;
1468                                 mc->mc_txn = dst;
1469                                 mc->mc_dbi = i;
1470                                 mc->mc_db = &dst->mt_dbs[i];
1471                                 mc->mc_dbx = m2->mc_dbx;
1472                                 mc->mc_dbflag = &dst->mt_dbflags[i];
1473                                 mc->mc_snum = m2->mc_snum;
1474                                 mc->mc_top = m2->mc_top;
1475                                 mc->mc_flags = m2->mc_flags | C_SHADOW;
1476                                 for (j=0; j<mc->mc_snum; j++) {
1477                                         mc->mc_pg[j] = m2->mc_pg[j];
1478                                         mc->mc_ki[j] = m2->mc_ki[j];
1479                                 }
1480                                 if (m2->mc_xcursor) {
1481                                         MDB_xcursor *mx, *mx2;
1482                                         mx = (MDB_xcursor *)(mc+1);
1483                                         mc->mc_xcursor = mx;
1484                                         mx2 = m2->mc_xcursor;
1485                                         mx->mx_db = mx2->mx_db;
1486                                         mx->mx_dbx = mx2->mx_dbx;
1487                                         mx->mx_dbflag = mx2->mx_dbflag;
1488                                         mx->mx_cursor.mc_txn = dst;
1489                                         mx->mx_cursor.mc_dbi = mx2->mx_cursor.mc_dbi;
1490                                         mx->mx_cursor.mc_db = &mx->mx_db;
1491                                         mx->mx_cursor.mc_dbx = &mx->mx_dbx;
1492                                         mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
1493                                         mx->mx_cursor.mc_snum = mx2->mx_cursor.mc_snum;
1494                                         mx->mx_cursor.mc_top = mx2->mx_cursor.mc_top;
1495                                         mx->mx_cursor.mc_flags = mx2->mx_cursor.mc_flags | C_SHADOW;
1496                                         for (j=0; j<mx2->mx_cursor.mc_snum; j++) {
1497                                                 mx->mx_cursor.mc_pg[j] = mx2->mx_cursor.mc_pg[j];
1498                                                 mx->mx_cursor.mc_ki[j] = mx2->mx_cursor.mc_ki[j];
1499                                         }
1500                                 } else {
1501                                         mc->mc_xcursor = NULL;
1502                                 }
1503                                 mc->mc_next = dst->mt_cursors[i];
1504                                 dst->mt_cursors[i] = mc;
1505                         }
1506                 }
1507         }
1508         return MDB_SUCCESS;
1509 }
1510
1511 /** Merge shadow cursors back into parent's */
1512 static void
1513 mdb_cursor_merge(MDB_txn *txn)
1514 {
1515         MDB_dbi i;
1516         for (i=0; i<txn->mt_numdbs; i++) {
1517                 if (txn->mt_cursors[i]) {
1518                         MDB_cursor *mc;
1519                         while ((mc = txn->mt_cursors[i])) {
1520                                 txn->mt_cursors[i] = mc->mc_next;
1521                                 if (mc->mc_flags & C_SHADOW) {
1522                                         MDB_cursor *m2 = mc->mc_orig;
1523                                         unsigned int j;
1524                                         m2->mc_snum = mc->mc_snum;
1525                                         m2->mc_top = mc->mc_top;
1526                                         for (j=0; j<mc->mc_snum; j++) {
1527                                                 m2->mc_pg[j] = mc->mc_pg[j];
1528                                                 m2->mc_ki[j] = mc->mc_ki[j];
1529                                         }
1530                                 }
1531                                 if (mc->mc_flags & C_ALLOCD)
1532                                         free(mc);
1533                         }
1534                 }
1535         }
1536 }
1537
1538 static void
1539 mdb_txn_reset0(MDB_txn *txn);
1540
1541 /** Common code for #mdb_txn_begin() and #mdb_txn_renew().
1542  * @param[in] txn the transaction handle to initialize
1543  * @return 0 on success, non-zero on failure. This can only
1544  * fail for read-only transactions, and then only if the
1545  * reader table is full.
1546  */
1547 static int
1548 mdb_txn_renew0(MDB_txn *txn)
1549 {
1550         MDB_env *env = txn->mt_env;
1551         char mt_dbflag = 0;
1552
1553         if (txn->mt_flags & MDB_TXN_RDONLY) {
1554                 MDB_reader *r = pthread_getspecific(env->me_txkey);
1555                 if (!r) {
1556                         unsigned int i;
1557                         pid_t pid = getpid();
1558                         pthread_t tid = pthread_self();
1559
1560                         LOCK_MUTEX_R(env);
1561                         for (i=0; i<env->me_txns->mti_numreaders; i++)
1562                                 if (env->me_txns->mti_readers[i].mr_pid == 0)
1563                                         break;
1564                         if (i == env->me_maxreaders) {
1565                                 UNLOCK_MUTEX_R(env);
1566                                 return ENOMEM;
1567                         }
1568                         env->me_txns->mti_readers[i].mr_pid = pid;
1569                         env->me_txns->mti_readers[i].mr_tid = tid;
1570                         if (i >= env->me_txns->mti_numreaders)
1571                                 env->me_txns->mti_numreaders = i+1;
1572                         UNLOCK_MUTEX_R(env);
1573                         r = &env->me_txns->mti_readers[i];
1574                         pthread_setspecific(env->me_txkey, r);
1575                 }
1576                 txn->mt_toggle = env->me_txns->mti_me_toggle;
1577                 txn->mt_txnid = r->mr_txnid = env->me_metas[txn->mt_toggle]->mm_txnid;
1578
1579                 /* This happens if a different process was the
1580                  * last writer to the DB.
1581                  */
1582                 if (env->me_wtxnid < txn->mt_txnid)
1583                         mt_dbflag = DB_STALE;
1584                 txn->mt_u.reader = r;
1585         } else {
1586                 LOCK_MUTEX_W(env);
1587
1588                 txn->mt_toggle = env->me_txns->mti_me_toggle;
1589                 txn->mt_txnid = env->me_metas[txn->mt_toggle]->mm_txnid;
1590                 if (env->me_wtxnid < txn->mt_txnid)
1591                         mt_dbflag = DB_STALE;
1592                 txn->mt_txnid++;
1593 #if MDB_DEBUG
1594                 if (txn->mt_txnid == mdb_debug_start)
1595                         mdb_debug = 1;
1596 #endif
1597                 txn->mt_u.dirty_list = env->me_dirty_list;
1598                 txn->mt_u.dirty_list[0].mid = 0;
1599                 txn->mt_free_pgs = env->me_free_pgs;
1600                 txn->mt_free_pgs[0] = 0;
1601                 txn->mt_next_pgno = env->me_metas[txn->mt_toggle]->mm_last_pg+1;
1602                 env->me_txn = txn;
1603         }
1604
1605         /* Copy the DB arrays */
1606         LAZY_RWLOCK_RDLOCK(&env->me_dblock);
1607         txn->mt_numdbs = env->me_numdbs;
1608         txn->mt_dbxs = env->me_dbxs;    /* mostly static anyway */
1609         memcpy(txn->mt_dbs, env->me_metas[txn->mt_toggle]->mm_dbs, 2 * sizeof(MDB_db));
1610         if (txn->mt_numdbs > 2)
1611                 memcpy(txn->mt_dbs+2, env->me_dbs[env->me_db_toggle]+2,
1612                         (txn->mt_numdbs - 2) * sizeof(MDB_db));
1613         LAZY_RWLOCK_UNLOCK(&env->me_dblock);
1614
1615         memset(txn->mt_dbflags, mt_dbflag, env->me_numdbs);
1616
1617         return MDB_SUCCESS;
1618 }
1619
1620 int
1621 mdb_txn_renew(MDB_txn *txn)
1622 {
1623         int rc;
1624
1625         if (!txn)
1626                 return EINVAL;
1627
1628         if (txn->mt_env->me_flags & MDB_FATAL_ERROR) {
1629                 DPUTS("environment had fatal error, must shutdown!");
1630                 return MDB_PANIC;
1631         }
1632
1633         rc = mdb_txn_renew0(txn);
1634         if (rc == MDB_SUCCESS) {
1635                 DPRINTF("renew txn %zu%c %p on mdbenv %p, root page %zu",
1636                         txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1637                         (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1638         }
1639         return rc;
1640 }
1641
1642 int
1643 mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **ret)
1644 {
1645         MDB_txn *txn;
1646         int rc, size;
1647
1648         if (env->me_flags & MDB_FATAL_ERROR) {
1649                 DPUTS("environment had fatal error, must shutdown!");
1650                 return MDB_PANIC;
1651         }
1652         if (parent) {
1653                 /* parent already has an active child txn */
1654                 if (parent->mt_child) {
1655                         return EINVAL;
1656                 }
1657         }
1658         size = sizeof(MDB_txn) + env->me_maxdbs * (sizeof(MDB_db)+1);
1659         if (!(flags & MDB_RDONLY))
1660                 size += env->me_maxdbs * sizeof(MDB_cursor *);
1661
1662         if ((txn = calloc(1, size)) == NULL) {
1663                 DPRINTF("calloc: %s", strerror(ErrCode()));
1664                 return ENOMEM;
1665         }
1666         txn->mt_dbs = (MDB_db *)(txn+1);
1667         if (flags & MDB_RDONLY) {
1668                 txn->mt_flags |= MDB_TXN_RDONLY;
1669                 txn->mt_dbflags = (unsigned char *)(txn->mt_dbs + env->me_maxdbs);
1670         } else {
1671                 txn->mt_cursors = (MDB_cursor **)(txn->mt_dbs + env->me_maxdbs);
1672                 txn->mt_dbflags = (unsigned char *)(txn->mt_cursors + env->me_maxdbs);
1673         }
1674         txn->mt_env = env;
1675
1676         if (parent) {
1677                 txn->mt_free_pgs = mdb_midl_alloc();
1678                 if (!txn->mt_free_pgs) {
1679                         free(txn);
1680                         return ENOMEM;
1681                 }
1682                 txn->mt_u.dirty_list = malloc(sizeof(ID2)*MDB_IDL_UM_SIZE);
1683                 if (!txn->mt_u.dirty_list) {
1684                         free(txn->mt_free_pgs);
1685                         free(txn);
1686                         return ENOMEM;
1687                 }
1688                 txn->mt_txnid = parent->mt_txnid;
1689                 txn->mt_toggle = parent->mt_toggle;
1690                 txn->mt_u.dirty_list[0].mid = 0;
1691                 txn->mt_free_pgs[0] = 0;
1692                 txn->mt_next_pgno = parent->mt_next_pgno;
1693                 parent->mt_child = txn;
1694                 txn->mt_parent = parent;
1695                 txn->mt_numdbs = parent->mt_numdbs;
1696                 txn->mt_dbxs = parent->mt_dbxs;
1697                 memcpy(txn->mt_dbs, parent->mt_dbs, txn->mt_numdbs * sizeof(MDB_db));
1698                 memcpy(txn->mt_dbflags, parent->mt_dbflags, txn->mt_numdbs);
1699                 mdb_cursor_shadow(parent, txn);
1700                 rc = 0;
1701         } else {
1702                 rc = mdb_txn_renew0(txn);
1703         }
1704         if (rc)
1705                 free(txn);
1706         else {
1707                 *ret = txn;
1708                 DPRINTF("begin txn %zu%c %p on mdbenv %p, root page %zu",
1709                         txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1710                         (void *) txn, (void *) env, txn->mt_dbs[MAIN_DBI].md_root);
1711         }
1712
1713         return rc;
1714 }
1715
1716 /** Common code for #mdb_txn_reset() and #mdb_txn_abort().
1717  * @param[in] txn the transaction handle to reset
1718  */
1719 static void
1720 mdb_txn_reset0(MDB_txn *txn)
1721 {
1722         MDB_env *env = txn->mt_env;
1723
1724         if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
1725                 txn->mt_u.reader->mr_txnid = 0;
1726         } else {
1727                 MDB_oldpages *mop;
1728                 MDB_page *dp;
1729                 unsigned int i;
1730
1731                 /* close(free) all cursors */
1732                 for (i=0; i<txn->mt_numdbs; i++) {
1733                         if (txn->mt_cursors[i]) {
1734                                 MDB_cursor *mc;
1735                                 while ((mc = txn->mt_cursors[i])) {
1736                                         txn->mt_cursors[i] = mc->mc_next;
1737                                         if (mc->mc_flags & C_ALLOCD)
1738                                                 free(mc);
1739                                 }
1740                         }
1741                 }
1742
1743                 /* return all dirty pages to dpage list */
1744                 for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
1745                         dp = txn->mt_u.dirty_list[i].mptr;
1746                         if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
1747                                 dp->mp_next = txn->mt_env->me_dpages;
1748                                 VGMEMP_FREE(txn->mt_env, dp);
1749                                 txn->mt_env->me_dpages = dp;
1750                         } else {
1751                                 /* large pages just get freed directly */
1752                                 VGMEMP_FREE(txn->mt_env, dp);
1753                                 free(dp);
1754                         }
1755                 }
1756
1757                 if (txn->mt_parent) {
1758                         txn->mt_parent->mt_child = NULL;
1759                         free(txn->mt_free_pgs);
1760                         free(txn->mt_u.dirty_list);
1761                         return;
1762                 } else {
1763                         if (mdb_midl_shrink(&txn->mt_free_pgs))
1764                                 env->me_free_pgs = txn->mt_free_pgs;
1765                 }
1766
1767                 while ((mop = txn->mt_env->me_pghead)) {
1768                         txn->mt_env->me_pghead = mop->mo_next;
1769                         free(mop);
1770                 }
1771                 txn->mt_env->me_pgfirst = 0;
1772                 txn->mt_env->me_pglast = 0;
1773
1774                 env->me_txn = NULL;
1775                 /* The writer mutex was locked in mdb_txn_begin. */
1776                 UNLOCK_MUTEX_W(env);
1777         }
1778 }
1779
1780 void
1781 mdb_txn_reset(MDB_txn *txn)
1782 {
1783         if (txn == NULL)
1784                 return;
1785
1786         DPRINTF("reset txn %zu%c %p on mdbenv %p, root page %zu",
1787                 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1788                 (void *) txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1789
1790         mdb_txn_reset0(txn);
1791 }
1792
1793 void
1794 mdb_txn_abort(MDB_txn *txn)
1795 {
1796         if (txn == NULL)
1797                 return;
1798
1799         DPRINTF("abort txn %zu%c %p on mdbenv %p, root page %zu",
1800                 txn->mt_txnid, (txn->mt_flags & MDB_TXN_RDONLY) ? 'r' : 'w',
1801                 (void *)txn, (void *)txn->mt_env, txn->mt_dbs[MAIN_DBI].md_root);
1802
1803         if (txn->mt_child)
1804                 mdb_txn_abort(txn->mt_child);
1805
1806         mdb_txn_reset0(txn);
1807         free(txn);
1808 }
1809
1810 int
1811 mdb_txn_commit(MDB_txn *txn)
1812 {
1813         int              n, done;
1814         unsigned int i;
1815         ssize_t          rc;
1816         off_t            size;
1817         MDB_page        *dp;
1818         MDB_env *env;
1819         pgno_t  next, freecnt;
1820         MDB_cursor mc;
1821
1822         assert(txn != NULL);
1823         assert(txn->mt_env != NULL);
1824
1825         if (txn->mt_child) {
1826                 mdb_txn_commit(txn->mt_child);
1827                 txn->mt_child = NULL;
1828         }
1829
1830         env = txn->mt_env;
1831
1832         if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
1833                 if (txn->mt_numdbs > env->me_numdbs) {
1834                         /* update the DB tables */
1835                         int toggle = !env->me_db_toggle;
1836                         MDB_db *ip, *jp;
1837                         MDB_dbi i;
1838
1839                         ip = &env->me_dbs[toggle][env->me_numdbs];
1840                         jp = &txn->mt_dbs[env->me_numdbs];
1841                         LAZY_RWLOCK_WRLOCK(&env->me_dblock);
1842                         for (i = env->me_numdbs; i < txn->mt_numdbs; i++) {
1843                                 *ip++ = *jp++;
1844                         }
1845
1846                         env->me_db_toggle = toggle;
1847                         env->me_numdbs = txn->mt_numdbs;
1848                         LAZY_RWLOCK_UNLOCK(&env->me_dblock);
1849                 }
1850                 mdb_txn_abort(txn);
1851                 return MDB_SUCCESS;
1852         }
1853
1854         if (F_ISSET(txn->mt_flags, MDB_TXN_ERROR)) {
1855                 DPUTS("error flag is set, can't commit");
1856                 if (txn->mt_parent)
1857                         txn->mt_parent->mt_flags |= MDB_TXN_ERROR;
1858                 mdb_txn_abort(txn);
1859                 return EINVAL;
1860         }
1861
1862         /* Merge (and close) our cursors with parent's */
1863         mdb_cursor_merge(txn);
1864
1865         if (txn->mt_parent) {
1866                 MDB_db *ip, *jp;
1867                 MDB_dbi i;
1868                 unsigned x, y;
1869                 ID2L dst, src;
1870
1871                 /* Update parent's DB table */
1872                 ip = &txn->mt_parent->mt_dbs[2];
1873                 jp = &txn->mt_dbs[2];
1874                 for (i = 2; i < txn->mt_numdbs; i++) {
1875                         if (ip->md_root != jp->md_root)
1876                                 *ip = *jp;
1877                         ip++; jp++;
1878                 }
1879                 txn->mt_parent->mt_numdbs = txn->mt_numdbs;
1880
1881                 /* Append our free list to parent's */
1882                 mdb_midl_append_list(&txn->mt_parent->mt_free_pgs,
1883                         txn->mt_free_pgs);
1884                 mdb_midl_free(txn->mt_free_pgs);
1885
1886                 /* Merge our dirty list with parent's */
1887                 dst = txn->mt_parent->mt_u.dirty_list;
1888                 src = txn->mt_u.dirty_list;
1889                 x = mdb_mid2l_search(dst, src[1].mid);
1890                 for (y=1; y<=src[0].mid; y++) {
1891                         while (x <= dst[0].mid && dst[x].mid != src[y].mid) x++;
1892                         if (x > dst[0].mid)
1893                                 break;
1894                         free(dst[x].mptr);
1895                         dst[x].mptr = src[y].mptr;
1896                 }
1897                 x = dst[0].mid;
1898                 for (; y<=src[0].mid; y++) {
1899                         if (++x >= MDB_IDL_UM_MAX) {
1900                                 mdb_txn_abort(txn);
1901                                 return ENOMEM;
1902                         }
1903                         dst[x] = src[y];
1904                 }
1905                 dst[0].mid = x;
1906                 free(txn->mt_u.dirty_list);
1907                 txn->mt_parent->mt_child = NULL;
1908                 free(txn);
1909                 return MDB_SUCCESS;
1910         }
1911
1912         if (txn != env->me_txn) {
1913                 DPUTS("attempt to commit unknown transaction");
1914                 mdb_txn_abort(txn);
1915                 return EINVAL;
1916         }
1917
1918         if (!txn->mt_u.dirty_list[0].mid)
1919                 goto done;
1920
1921         DPRINTF("committing txn %zu %p on mdbenv %p, root page %zu",
1922             txn->mt_txnid, (void *)txn, (void *)env, txn->mt_dbs[MAIN_DBI].md_root);
1923
1924         mdb_cursor_init(&mc, txn, FREE_DBI, NULL);
1925
1926         /* should only be one record now */
1927         if (env->me_pghead) {
1928                 /* make sure first page of freeDB is touched and on freelist */
1929                 mdb_page_search(&mc, NULL, 1);
1930         }
1931
1932         /* Delete IDLs we used from the free list */
1933         if (env->me_pgfirst) {
1934                 txnid_t cur;
1935                 MDB_val key;
1936                 int exact = 0;
1937
1938                 key.mv_size = sizeof(cur);
1939                 for (cur = env->me_pgfirst; cur <= env->me_pglast; cur++) {
1940                         key.mv_data = &cur;
1941
1942                         mdb_cursor_set(&mc, &key, NULL, MDB_SET, &exact);
1943                         mdb_cursor_del(&mc, 0);
1944                 }
1945                 env->me_pgfirst = 0;
1946                 env->me_pglast = 0;
1947         }
1948
1949         /* save to free list */
1950 free2:
1951         freecnt = txn->mt_free_pgs[0];
1952         if (!MDB_IDL_IS_ZERO(txn->mt_free_pgs)) {
1953                 MDB_val key, data;
1954
1955                 /* make sure last page of freeDB is touched and on freelist */
1956                 key.mv_size = MAXKEYSIZE+1;
1957                 key.mv_data = NULL;
1958                 mdb_page_search(&mc, &key, 1);
1959
1960                 mdb_midl_sort(txn->mt_free_pgs);
1961 #if MDB_DEBUG > 1
1962                 {
1963                         unsigned int i;
1964                         ID *idl = txn->mt_free_pgs;
1965                         DPRINTF("IDL write txn %zu root %zu num %zu",
1966                                 txn->mt_txnid, txn->mt_dbs[FREE_DBI].md_root, idl[0]);
1967                         for (i=0; i<idl[0]; i++) {
1968                                 DPRINTF("IDL %zu", idl[i+1]);
1969                         }
1970                 }
1971 #endif
1972                 /* write to last page of freeDB */
1973                 key.mv_size = sizeof(pgno_t);
1974                 key.mv_data = &txn->mt_txnid;
1975                 data.mv_data = txn->mt_free_pgs;
1976                 /* The free list can still grow during this call,
1977                  * despite the pre-emptive touches above. So check
1978                  * and make sure the entire thing got written.
1979                  */
1980                 do {
1981                         freecnt = txn->mt_free_pgs[0];
1982                         data.mv_size = MDB_IDL_SIZEOF(txn->mt_free_pgs);
1983                         rc = mdb_cursor_put(&mc, &key, &data, 0);
1984                         if (rc) {
1985                                 mdb_txn_abort(txn);
1986                                 return rc;
1987                         }
1988                 } while (freecnt != txn->mt_free_pgs[0]);
1989         }
1990         /* should only be one record now */
1991 again:
1992         if (env->me_pghead) {
1993                 MDB_val key, data;
1994                 MDB_oldpages *mop;
1995                 pgno_t orig;
1996                 txnid_t id;
1997
1998                 mop = env->me_pghead;
1999                 id = mop->mo_txnid;
2000                 key.mv_size = sizeof(id);
2001                 key.mv_data = &id;
2002                 data.mv_size = MDB_IDL_SIZEOF(mop->mo_pages);
2003                 data.mv_data = mop->mo_pages;
2004                 orig = mop->mo_pages[0];
2005                 /* These steps may grow the freelist again
2006                  * due to freed overflow pages...
2007                  */
2008                 mdb_cursor_put(&mc, &key, &data, 0);
2009                 if (mop == env->me_pghead && env->me_pghead->mo_txnid == id) {
2010                         /* could have been used again here */
2011                         if (mop->mo_pages[0] != orig) {
2012                                 data.mv_size = MDB_IDL_SIZEOF(mop->mo_pages);
2013                                 data.mv_data = mop->mo_pages;
2014                                 id = mop->mo_txnid;
2015                                 mdb_cursor_put(&mc, &key, &data, 0);
2016                         }
2017                         env->me_pghead = NULL;
2018                         free(mop);
2019                 } else {
2020                         /* was completely used up */
2021                         mdb_cursor_del(&mc, 0);
2022                         if (env->me_pghead)
2023                                 goto again;
2024                 }
2025                 env->me_pgfirst = 0;
2026                 env->me_pglast = 0;
2027         }
2028         /* Check for growth of freelist again */
2029         if (freecnt != txn->mt_free_pgs[0])
2030                 goto free2;
2031
2032         if (!MDB_IDL_IS_ZERO(txn->mt_free_pgs)) {
2033                 if (mdb_midl_shrink(&txn->mt_free_pgs))
2034                         env->me_free_pgs = txn->mt_free_pgs;
2035         }
2036
2037         /* Update DB root pointers. Their pages have already been
2038          * touched so this is all in-place and cannot fail.
2039          */
2040         {
2041                 MDB_dbi i;
2042                 MDB_val data;
2043                 data.mv_size = sizeof(MDB_db);
2044
2045                 mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
2046                 for (i = 2; i < txn->mt_numdbs; i++) {
2047                         if (txn->mt_dbflags[i] & DB_DIRTY) {
2048                                 data.mv_data = &txn->mt_dbs[i];
2049                                 mdb_cursor_put(&mc, &txn->mt_dbxs[i].md_name, &data, 0);
2050                         }
2051                 }
2052         }
2053 #if MDB_DEBUG > 2
2054         mdb_audit(txn);
2055 #endif
2056
2057         /* Commit up to MDB_COMMIT_PAGES dirty pages to disk until done.
2058          */
2059         next = 0;
2060         i = 1;
2061         do {
2062 #ifdef _WIN32
2063                 /* Windows actually supports scatter/gather I/O, but only on
2064                  * unbuffered file handles. Since we're relying on the OS page
2065                  * cache for all our data, that's self-defeating. So we just
2066                  * write pages one at a time. We use the ov structure to set
2067                  * the write offset, to at least save the overhead of a Seek
2068                  * system call.
2069                  */
2070                 OVERLAPPED ov;
2071                 memset(&ov, 0, sizeof(ov));
2072                 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2073                         size_t wsize;
2074                         dp = txn->mt_u.dirty_list[i].mptr;
2075                         DPRINTF("committing page %zu", dp->mp_pgno);
2076                         size = dp->mp_pgno * env->me_psize;
2077                         ov.Offset = size & 0xffffffff;
2078                         ov.OffsetHigh = size >> 16;
2079                         ov.OffsetHigh >>= 16;
2080                         /* clear dirty flag */
2081                         dp->mp_flags &= ~P_DIRTY;
2082                         wsize = env->me_psize;
2083                         if (IS_OVERFLOW(dp)) wsize *= dp->mp_pages;
2084                         rc = WriteFile(env->me_fd, dp, wsize, NULL, &ov);
2085                         if (!rc) {
2086                                 n = ErrCode();
2087                                 DPRINTF("WriteFile: %d", n);
2088                                 mdb_txn_abort(txn);
2089                                 return n;
2090                         }
2091                 }
2092                 done = 1;
2093 #else
2094                 struct iovec     iov[MDB_COMMIT_PAGES];
2095                 n = 0;
2096                 done = 1;
2097                 size = 0;
2098                 for (; i<=txn->mt_u.dirty_list[0].mid; i++) {
2099                         dp = txn->mt_u.dirty_list[i].mptr;
2100                         if (dp->mp_pgno != next) {
2101                                 if (n) {
2102                                         rc = writev(env->me_fd, iov, n);
2103                                         if (rc != size) {
2104                                                 n = ErrCode();
2105                                                 if (rc > 0)
2106                                                         DPUTS("short write, filesystem full?");
2107                                                 else
2108                                                         DPRINTF("writev: %s", strerror(n));
2109                                                 mdb_txn_abort(txn);
2110                                                 return n;
2111                                         }
2112                                         n = 0;
2113                                         size = 0;
2114                                 }
2115                                 lseek(env->me_fd, dp->mp_pgno * env->me_psize, SEEK_SET);
2116                                 next = dp->mp_pgno;
2117                         }
2118                         DPRINTF("committing page %zu", dp->mp_pgno);
2119                         iov[n].iov_len = env->me_psize;
2120                         if (IS_OVERFLOW(dp)) iov[n].iov_len *= dp->mp_pages;
2121                         iov[n].iov_base = (char *)dp;
2122                         size += iov[n].iov_len;
2123                         next = dp->mp_pgno + (IS_OVERFLOW(dp) ? dp->mp_pages : 1);
2124                         /* clear dirty flag */
2125                         dp->mp_flags &= ~P_DIRTY;
2126                         if (++n >= MDB_COMMIT_PAGES) {
2127                                 done = 0;
2128                                 i++;
2129                                 break;
2130                         }
2131                 }
2132
2133                 if (n == 0)
2134                         break;
2135
2136                 rc = writev(env->me_fd, iov, n);
2137                 if (rc != size) {
2138                         n = ErrCode();
2139                         if (rc > 0)
2140                                 DPUTS("short write, filesystem full?");
2141                         else
2142                                 DPRINTF("writev: %s", strerror(n));
2143                         mdb_txn_abort(txn);
2144                         return n;
2145                 }
2146 #endif
2147         } while (!done);
2148
2149         /* Drop the dirty pages.
2150          */
2151         for (i=1; i<=txn->mt_u.dirty_list[0].mid; i++) {
2152                 dp = txn->mt_u.dirty_list[i].mptr;
2153                 if (!IS_OVERFLOW(dp) || dp->mp_pages == 1) {
2154                         dp->mp_next = txn->mt_env->me_dpages;
2155                         VGMEMP_FREE(txn->mt_env, dp);
2156                         txn->mt_env->me_dpages = dp;
2157                 } else {
2158                         VGMEMP_FREE(txn->mt_env, dp);
2159                         free(dp);
2160                 }
2161                 txn->mt_u.dirty_list[i].mid = 0;
2162         }
2163         txn->mt_u.dirty_list[0].mid = 0;
2164
2165         if ((n = mdb_env_sync(env, 0)) != 0 ||
2166             (n = mdb_env_write_meta(txn)) != MDB_SUCCESS) {
2167                 mdb_txn_abort(txn);
2168                 return n;
2169         }
2170         env->me_wtxnid = txn->mt_txnid;
2171
2172 done:
2173         env->me_txn = NULL;
2174         /* update the DB tables */
2175         {
2176                 int toggle = !env->me_db_toggle;
2177                 MDB_db *ip, *jp;
2178                 MDB_dbi i;
2179
2180                 ip = &env->me_dbs[toggle][2];
2181                 jp = &txn->mt_dbs[2];
2182                 LAZY_RWLOCK_WRLOCK(&env->me_dblock);
2183                 for (i = 2; i < txn->mt_numdbs; i++) {
2184                         if (ip->md_root != jp->md_root)
2185                                 *ip = *jp;
2186                         ip++; jp++;
2187                 }
2188
2189                 env->me_db_toggle = toggle;
2190                 env->me_numdbs = txn->mt_numdbs;
2191                 LAZY_RWLOCK_UNLOCK(&env->me_dblock);
2192         }
2193
2194         UNLOCK_MUTEX_W(env);
2195         free(txn);
2196
2197         return MDB_SUCCESS;
2198 }
2199
2200 /** Read the environment parameters of a DB environment before
2201  * mapping it into memory.
2202  * @param[in] env the environment handle
2203  * @param[out] meta address of where to store the meta information
2204  * @return 0 on success, non-zero on failure.
2205  */
2206 static int
2207 mdb_env_read_header(MDB_env *env, MDB_meta *meta)
2208 {
2209         MDB_pagebuf     pbuf;
2210         MDB_page        *p;
2211         MDB_meta        *m;
2212         int              rc, err;
2213
2214         /* We don't know the page size yet, so use a minimum value.
2215          */
2216
2217 #ifdef _WIN32
2218         if (!ReadFile(env->me_fd, &pbuf, MDB_PAGESIZE, (DWORD *)&rc, NULL) || rc == 0)
2219 #else
2220         if ((rc = read(env->me_fd, &pbuf, MDB_PAGESIZE)) == 0)
2221 #endif
2222         {
2223                 return ENOENT;
2224         }
2225         else if (rc != MDB_PAGESIZE) {
2226                 err = ErrCode();
2227                 if (rc > 0)
2228                         err = EINVAL;
2229                 DPRINTF("read: %s", strerror(err));
2230                 return err;
2231         }
2232
2233         p = (MDB_page *)&pbuf;
2234
2235         if (!F_ISSET(p->mp_flags, P_META)) {
2236                 DPRINTF("page %zu not a meta page", p->mp_pgno);
2237                 return EINVAL;
2238         }
2239
2240         m = METADATA(p);
2241         if (m->mm_magic != MDB_MAGIC) {
2242                 DPUTS("meta has invalid magic");
2243                 return EINVAL;
2244         }
2245
2246         if (m->mm_version != MDB_VERSION) {
2247                 DPRINTF("database is version %u, expected version %u",
2248                     m->mm_version, MDB_VERSION);
2249                 return MDB_VERSION_MISMATCH;
2250         }
2251
2252         memcpy(meta, m, sizeof(*m));
2253         return 0;
2254 }
2255
2256 /** Write the environment parameters of a freshly created DB environment.
2257  * @param[in] env the environment handle
2258  * @param[out] meta address of where to store the meta information
2259  * @return 0 on success, non-zero on failure.
2260  */
2261 static int
2262 mdb_env_init_meta(MDB_env *env, MDB_meta *meta)
2263 {
2264         MDB_page *p, *q;
2265         MDB_meta *m;
2266         int rc;
2267         unsigned int     psize;
2268
2269         DPUTS("writing new meta page");
2270
2271         GET_PAGESIZE(psize);
2272
2273         meta->mm_magic = MDB_MAGIC;
2274         meta->mm_version = MDB_VERSION;
2275         meta->mm_psize = psize;
2276         meta->mm_last_pg = 1;
2277         meta->mm_flags = env->me_flags & 0xffff;
2278         meta->mm_flags |= MDB_INTEGERKEY;
2279         meta->mm_dbs[0].md_root = P_INVALID;
2280         meta->mm_dbs[1].md_root = P_INVALID;
2281
2282         p = calloc(2, psize);
2283         p->mp_pgno = 0;
2284         p->mp_flags = P_META;
2285
2286         m = METADATA(p);
2287         memcpy(m, meta, sizeof(*meta));
2288
2289         q = (MDB_page *)((char *)p + psize);
2290
2291         q->mp_pgno = 1;
2292         q->mp_flags = P_META;
2293
2294         m = METADATA(q);
2295         memcpy(m, meta, sizeof(*meta));
2296
2297 #ifdef _WIN32
2298         {
2299                 DWORD len;
2300                 rc = WriteFile(env->me_fd, p, psize * 2, &len, NULL);
2301                 rc = (len == psize * 2) ? MDB_SUCCESS : ErrCode();
2302         }
2303 #else
2304         rc = write(env->me_fd, p, psize * 2);
2305         rc = (rc == (int)psize * 2) ? MDB_SUCCESS : ErrCode();
2306 #endif
2307         free(p);
2308         return rc;
2309 }
2310
2311 /** Update the environment info to commit a transaction.
2312  * @param[in] txn the transaction that's being committed
2313  * @return 0 on success, non-zero on failure.
2314  */
2315 static int
2316 mdb_env_write_meta(MDB_txn *txn)
2317 {
2318         MDB_env *env;
2319         MDB_meta        meta, metab;
2320         off_t off;
2321         int rc, len, toggle;
2322         char *ptr;
2323 #ifdef _WIN32
2324         OVERLAPPED ov;
2325 #endif
2326
2327         assert(txn != NULL);
2328         assert(txn->mt_env != NULL);
2329
2330         toggle = !txn->mt_toggle;
2331         DPRINTF("writing meta page %d for root page %zu",
2332                 toggle, txn->mt_dbs[MAIN_DBI].md_root);
2333
2334         env = txn->mt_env;
2335
2336         metab.mm_txnid = env->me_metas[toggle]->mm_txnid;
2337         metab.mm_last_pg = env->me_metas[toggle]->mm_last_pg;
2338
2339         ptr = (char *)&meta;
2340         off = offsetof(MDB_meta, mm_dbs[0].md_depth);
2341         len = sizeof(MDB_meta) - off;
2342
2343         ptr += off;
2344         meta.mm_dbs[0] = txn->mt_dbs[0];
2345         meta.mm_dbs[1] = txn->mt_dbs[1];
2346         meta.mm_last_pg = txn->mt_next_pgno - 1;
2347         meta.mm_txnid = txn->mt_txnid;
2348
2349         if (toggle)
2350                 off += env->me_psize;
2351         off += PAGEHDRSZ;
2352
2353         /* Write to the SYNC fd */
2354 #ifdef _WIN32
2355         {
2356                 memset(&ov, 0, sizeof(ov));
2357                 ov.Offset = off;
2358                 WriteFile(env->me_mfd, ptr, len, (DWORD *)&rc, &ov);
2359         }
2360 #else
2361         rc = pwrite(env->me_mfd, ptr, len, off);
2362 #endif
2363         if (rc != len) {
2364                 int r2;
2365                 rc = ErrCode();
2366                 DPUTS("write failed, disk error?");
2367                 /* On a failure, the pagecache still contains the new data.
2368                  * Write some old data back, to prevent it from being used.
2369                  * Use the non-SYNC fd; we know it will fail anyway.
2370                  */
2371                 meta.mm_last_pg = metab.mm_last_pg;
2372                 meta.mm_txnid = metab.mm_txnid;
2373 #ifdef _WIN32
2374                 WriteFile(env->me_fd, ptr, len, NULL, &ov);
2375 #else
2376                 r2 = pwrite(env->me_fd, ptr, len, off);
2377 #endif
2378                 env->me_flags |= MDB_FATAL_ERROR;
2379                 return rc;
2380         }
2381         /* Memory ordering issues are irrelevant; since the entire writer
2382          * is wrapped by wmutex, all of these changes will become visible
2383          * after the wmutex is unlocked. Since the DB is multi-version,
2384          * readers will get consistent data regardless of how fresh or
2385          * how stale their view of these values is.
2386          */
2387         LAZY_MUTEX_LOCK(&env->me_txns->mti_mutex);
2388         txn->mt_env->me_txns->mti_me_toggle = toggle;
2389         txn->mt_env->me_txns->mti_txnid = txn->mt_txnid;
2390         LAZY_MUTEX_UNLOCK(&env->me_txns->mti_mutex);
2391
2392         return MDB_SUCCESS;
2393 }
2394
2395 /** Check both meta pages to see which one is newer.
2396  * @param[in] env the environment handle
2397  * @param[out] which address of where to store the meta toggle ID
2398  * @return 0 on success, non-zero on failure.
2399  */
2400 static int
2401 mdb_env_read_meta(MDB_env *env, int *which)
2402 {
2403         int toggle = 0;
2404
2405         assert(env != NULL);
2406
2407         if (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid)
2408                 toggle = 1;
2409
2410         DPRINTF("Using meta page %d", toggle);
2411         *which = toggle;
2412
2413         return MDB_SUCCESS;
2414 }
2415
2416 int
2417 mdb_env_create(MDB_env **env)
2418 {
2419         MDB_env *e;
2420
2421         e = calloc(1, sizeof(MDB_env));
2422         if (!e)
2423                 return ENOMEM;
2424
2425         e->me_free_pgs = mdb_midl_alloc();
2426         if (!e->me_free_pgs) {
2427                 free(e);
2428                 return ENOMEM;
2429         }
2430         e->me_maxreaders = DEFAULT_READERS;
2431         e->me_maxdbs = 2;
2432         e->me_fd = INVALID_HANDLE_VALUE;
2433         e->me_lfd = INVALID_HANDLE_VALUE;
2434         e->me_mfd = INVALID_HANDLE_VALUE;
2435         VGMEMP_CREATE(e,0,0);
2436         *env = e;
2437         return MDB_SUCCESS;
2438 }
2439
2440 int
2441 mdb_env_set_mapsize(MDB_env *env, size_t size)
2442 {
2443         if (env->me_map)
2444                 return EINVAL;
2445         env->me_mapsize = size;
2446         if (env->me_psize)
2447                 env->me_maxpg = env->me_mapsize / env->me_psize;
2448         return MDB_SUCCESS;
2449 }
2450
2451 int
2452 mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
2453 {
2454         if (env->me_map)
2455                 return EINVAL;
2456         env->me_maxdbs = dbs;
2457         return MDB_SUCCESS;
2458 }
2459
2460 int
2461 mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
2462 {
2463         if (env->me_map || readers < 1)
2464                 return EINVAL;
2465         env->me_maxreaders = readers;
2466         return MDB_SUCCESS;
2467 }
2468
2469 int
2470 mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
2471 {
2472         if (!env || !readers)
2473                 return EINVAL;
2474         *readers = env->me_maxreaders;
2475         return MDB_SUCCESS;
2476 }
2477
2478 /** Further setup required for opening an MDB environment
2479  */
2480 static int
2481 mdb_env_open2(MDB_env *env, unsigned int flags)
2482 {
2483         int i, newenv = 0, toggle;
2484         MDB_meta meta;
2485         MDB_page *p;
2486
2487         env->me_flags = flags;
2488
2489         memset(&meta, 0, sizeof(meta));
2490
2491         if ((i = mdb_env_read_header(env, &meta)) != 0) {
2492                 if (i != ENOENT)
2493                         return i;
2494                 DPUTS("new mdbenv");
2495                 newenv = 1;
2496         }
2497
2498         if (!env->me_mapsize) {
2499                 env->me_mapsize = newenv ? DEFAULT_MAPSIZE : meta.mm_mapsize;
2500         }
2501
2502 #ifdef _WIN32
2503         {
2504                 HANDLE mh;
2505                 LONG sizelo, sizehi;
2506                 sizelo = env->me_mapsize & 0xffffffff;
2507                 sizehi = env->me_mapsize >> 16;         /* pointless on WIN32, only needed on W64 */
2508                 sizehi >>= 16;
2509                 /* Windows won't create mappings for zero length files.
2510                  * Just allocate the maxsize right now.
2511                  */
2512                 if (newenv) {
2513                         SetFilePointer(env->me_fd, sizelo, sizehi ? &sizehi : NULL, 0);
2514                         if (!SetEndOfFile(env->me_fd))
2515                                 return ErrCode();
2516                         SetFilePointer(env->me_fd, 0, NULL, 0);
2517                 }
2518                 mh = CreateFileMapping(env->me_fd, NULL, PAGE_READONLY,
2519                         sizehi, sizelo, NULL);
2520                 if (!mh)
2521                         return ErrCode();
2522                 env->me_map = MapViewOfFileEx(mh, FILE_MAP_READ, 0, 0, env->me_mapsize,
2523                         meta.mm_address);
2524                 CloseHandle(mh);
2525                 if (!env->me_map)
2526                         return ErrCode();
2527         }
2528 #else
2529         i = MAP_SHARED;
2530         if (meta.mm_address && (flags & MDB_FIXEDMAP))
2531                 i |= MAP_FIXED;
2532         env->me_map = mmap(meta.mm_address, env->me_mapsize, PROT_READ, i,
2533                 env->me_fd, 0);
2534         if (env->me_map == MAP_FAILED) {
2535                 env->me_map = NULL;
2536                 return ErrCode();
2537         }
2538 #endif
2539
2540         if (newenv) {
2541                 meta.mm_mapsize = env->me_mapsize;
2542                 if (flags & MDB_FIXEDMAP)
2543                         meta.mm_address = env->me_map;
2544                 i = mdb_env_init_meta(env, &meta);
2545                 if (i != MDB_SUCCESS) {
2546                         munmap(env->me_map, env->me_mapsize);
2547                         return i;
2548                 }
2549         }
2550         env->me_psize = meta.mm_psize;
2551
2552         env->me_maxpg = env->me_mapsize / env->me_psize;
2553
2554         p = (MDB_page *)env->me_map;
2555         env->me_metas[0] = METADATA(p);
2556         env->me_metas[1] = (MDB_meta *)((char *)env->me_metas[0] + meta.mm_psize);
2557
2558         if ((i = mdb_env_read_meta(env, &toggle)) != 0)
2559                 return i;
2560
2561         DPRINTF("opened database version %u, pagesize %u",
2562             env->me_metas[toggle]->mm_version, env->me_psize);
2563         DPRINTF("depth: %u", env->me_metas[toggle]->mm_dbs[MAIN_DBI].md_depth);
2564         DPRINTF("entries: %zu", env->me_metas[toggle]->mm_dbs[MAIN_DBI].md_entries);
2565         DPRINTF("branch pages: %zu", env->me_metas[toggle]->mm_dbs[MAIN_DBI].md_branch_pages);
2566         DPRINTF("leaf pages: %zu", env->me_metas[toggle]->mm_dbs[MAIN_DBI].md_leaf_pages);
2567         DPRINTF("overflow pages: %zu", env->me_metas[toggle]->mm_dbs[MAIN_DBI].md_overflow_pages);
2568         DPRINTF("root: %zu", env->me_metas[toggle]->mm_dbs[MAIN_DBI].md_root);
2569
2570         return MDB_SUCCESS;
2571 }
2572
2573 #ifndef _WIN32
2574 /** Release a reader thread's slot in the reader lock table.
2575  *      This function is called automatically when a thread exits.
2576  *      Windows doesn't support destructor callbacks for thread-specific storage,
2577  *      so this function is not compiled there.
2578  * @param[in] ptr This points to the slot in the reader lock table.
2579  */
2580 static void
2581 mdb_env_reader_dest(void *ptr)
2582 {
2583         MDB_reader *reader = ptr;
2584
2585         reader->mr_txnid = 0;
2586         reader->mr_pid = 0;
2587         reader->mr_tid = 0;
2588 }
2589 #endif
2590
2591 /** Downgrade the exclusive lock on the region back to shared */
2592 static void
2593 mdb_env_share_locks(MDB_env *env)
2594 {
2595         int toggle = 0;
2596
2597         if (env->me_metas[0]->mm_txnid < env->me_metas[1]->mm_txnid)
2598                 toggle = 1;
2599         env->me_txns->mti_me_toggle = toggle;
2600         env->me_txns->mti_txnid = env->me_metas[toggle]->mm_txnid;
2601
2602 #ifdef _WIN32
2603         {
2604                 OVERLAPPED ov;
2605                 /* First acquire a shared lock. The Unlock will
2606                  * then release the existing exclusive lock.
2607                  */
2608                 memset(&ov, 0, sizeof(ov));
2609                 LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov);
2610                 UnlockFile(env->me_lfd, 0, 0, 1, 0);
2611         }
2612 #else
2613         {
2614                 struct flock lock_info;
2615                 /* The shared lock replaces the existing lock */
2616                 memset((void *)&lock_info, 0, sizeof(lock_info));
2617                 lock_info.l_type = F_RDLCK;
2618                 lock_info.l_whence = SEEK_SET;
2619                 lock_info.l_start = 0;
2620                 lock_info.l_len = 1;
2621                 fcntl(env->me_lfd, F_SETLK, &lock_info);
2622         }
2623 #endif
2624 }
2625 #if defined(_WIN32) || defined(__APPLE__)
2626 /*
2627  * hash_64 - 64 bit Fowler/Noll/Vo-0 FNV-1a hash code
2628  *
2629  * @(#) $Revision: 5.1 $
2630  * @(#) $Id: hash_64a.c,v 5.1 2009/06/30 09:01:38 chongo Exp $
2631  * @(#) $Source: /usr/local/src/cmd/fnv/RCS/hash_64a.c,v $
2632  *
2633  *        http://www.isthe.com/chongo/tech/comp/fnv/index.html
2634  *
2635  ***
2636  *
2637  * Please do not copyright this code.  This code is in the public domain.
2638  *
2639  * LANDON CURT NOLL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
2640  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
2641  * EVENT SHALL LANDON CURT NOLL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
2642  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
2643  * USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
2644  * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2645  * PERFORMANCE OF THIS SOFTWARE.
2646  *
2647  * By:
2648  *      chongo <Landon Curt Noll> /\oo/\
2649  *        http://www.isthe.com/chongo/
2650  *
2651  * Share and Enjoy!     :-)
2652  */
2653
2654 typedef unsigned long long      mdb_hash_t;
2655 #define MDB_HASH_INIT ((mdb_hash_t)0xcbf29ce484222325ULL)
2656
2657 /** perform a 64 bit Fowler/Noll/Vo FNV-1a hash on a buffer
2658  * @param[in] str string to hash
2659  * @param[in] hval      initial value for hash
2660  * @return 64 bit hash
2661  *
2662  * NOTE: To use the recommended 64 bit FNV-1a hash, use MDB_HASH_INIT as the
2663  *       hval arg on the first call.
2664  */
2665 static mdb_hash_t
2666 mdb_hash_str(char *str, mdb_hash_t hval)
2667 {
2668         unsigned char *s = (unsigned char *)str;        /* unsigned string */
2669         /*
2670          * FNV-1a hash each octet of the string
2671          */
2672         while (*s) {
2673                 /* xor the bottom with the current octet */
2674                 hval ^= (mdb_hash_t)*s++;
2675
2676                 /* multiply by the 64 bit FNV magic prime mod 2^64 */
2677                 hval += (hval << 1) + (hval << 4) + (hval << 5) +
2678                         (hval << 7) + (hval << 8) + (hval << 40);
2679         }
2680         /* return our new hash value */
2681         return hval;
2682 }
2683
2684 /** Hash the string and output the hash in hex.
2685  * @param[in] str string to hash
2686  * @param[out] hexbuf an array of 17 chars to hold the hash
2687  */
2688 static void
2689 mdb_hash_hex(char *str, char *hexbuf)
2690 {
2691         int i;
2692         mdb_hash_t h = mdb_hash_str(str, MDB_HASH_INIT);
2693         for (i=0; i<8; i++) {
2694                 hexbuf += sprintf(hexbuf, "%02x", (unsigned int)h & 0xff);
2695                 h >>= 8;
2696         }
2697 }
2698 #endif
2699
2700 /** Open and/or initialize the lock region for the environment.
2701  * @param[in] env The MDB environment.
2702  * @param[in] lpath The pathname of the file used for the lock region.
2703  * @param[in] mode The Unix permissions for the file, if we create it.
2704  * @param[out] excl Set to true if we got an exclusive lock on the region.
2705  * @return 0 on success, non-zero on failure.
2706  */
2707 static int
2708 mdb_env_setup_locks(MDB_env *env, char *lpath, int mode, int *excl)
2709 {
2710         int rc;
2711         off_t size, rsize;
2712
2713         *excl = 0;
2714
2715 #ifdef _WIN32
2716         if ((env->me_lfd = CreateFile(lpath, GENERIC_READ|GENERIC_WRITE,
2717                 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, OPEN_ALWAYS,
2718                 FILE_ATTRIBUTE_NORMAL, NULL)) == INVALID_HANDLE_VALUE) {
2719                 rc = ErrCode();
2720                 return rc;
2721         }
2722         /* Try to get exclusive lock. If we succeed, then
2723          * nobody is using the lock region and we should initialize it.
2724          */
2725         {
2726                 if (LockFile(env->me_lfd, 0, 0, 1, 0)) {
2727                         *excl = 1;
2728                 } else {
2729                         OVERLAPPED ov;
2730                         memset(&ov, 0, sizeof(ov));
2731                         if (!LockFileEx(env->me_lfd, 0, 0, 1, 0, &ov)) {
2732                                 rc = ErrCode();
2733                                 goto fail;
2734                         }
2735                 }
2736         }
2737         size = GetFileSize(env->me_lfd, NULL);
2738
2739 #else
2740 #if !(O_CLOEXEC)
2741         {
2742                 int fdflags;
2743                 if ((env->me_lfd = open(lpath, O_RDWR|O_CREAT, mode)) == -1)
2744                         return ErrCode();
2745                 /* Lose record locks when exec*() */
2746                 if ((fdflags = fcntl(env->me_lfd, F_GETFD) | FD_CLOEXEC) >= 0)
2747                         fcntl(env->me_lfd, F_SETFD, fdflags);
2748         }
2749 #else /* O_CLOEXEC on Linux: Open file and set FD_CLOEXEC atomically */
2750         if ((env->me_lfd = open(lpath, O_RDWR|O_CREAT|O_CLOEXEC, mode)) == -1)
2751                 return ErrCode();
2752 #endif
2753
2754         /* Try to get exclusive lock. If we succeed, then
2755          * nobody is using the lock region and we should initialize it.
2756          */
2757         {
2758                 struct flock lock_info;
2759                 memset((void *)&lock_info, 0, sizeof(lock_info));
2760                 lock_info.l_type = F_WRLCK;
2761                 lock_info.l_whence = SEEK_SET;
2762                 lock_info.l_start = 0;
2763                 lock_info.l_len = 1;
2764                 rc = fcntl(env->me_lfd, F_SETLK, &lock_info);
2765                 if (rc == 0) {
2766                         *excl = 1;
2767                 } else {
2768                         lock_info.l_type = F_RDLCK;
2769                         rc = fcntl(env->me_lfd, F_SETLKW, &lock_info);
2770                         if (rc) {
2771                                 rc = ErrCode();
2772                                 goto fail;
2773                         }
2774                 }
2775         }
2776         size = lseek(env->me_lfd, 0, SEEK_END);
2777 #endif
2778         rsize = (env->me_maxreaders-1) * sizeof(MDB_reader) + sizeof(MDB_txninfo);
2779         if (size < rsize && *excl) {
2780 #ifdef _WIN32
2781                 SetFilePointer(env->me_lfd, rsize, NULL, 0);
2782                 if (!SetEndOfFile(env->me_lfd)) {
2783                         rc = ErrCode();
2784                         goto fail;
2785                 }
2786 #else
2787                 if (ftruncate(env->me_lfd, rsize) != 0) {
2788                         rc = ErrCode();
2789                         goto fail;
2790                 }
2791 #endif
2792         } else {
2793                 rsize = size;
2794                 size = rsize - sizeof(MDB_txninfo);
2795                 env->me_maxreaders = size/sizeof(MDB_reader) + 1;
2796         }
2797         {
2798 #ifdef _WIN32
2799                 HANDLE mh;
2800                 mh = CreateFileMapping(env->me_lfd, NULL, PAGE_READWRITE,
2801                         0, 0, NULL);
2802                 if (!mh) {
2803                         rc = ErrCode();
2804                         goto fail;
2805                 }
2806                 env->me_txns = MapViewOfFileEx(mh, FILE_MAP_WRITE, 0, 0, rsize, NULL);
2807                 CloseHandle(mh);
2808                 if (!env->me_txns) {
2809                         rc = ErrCode();
2810                         goto fail;
2811                 }
2812 #else
2813                 void *m = mmap(NULL, rsize, PROT_READ|PROT_WRITE, MAP_SHARED,
2814                         env->me_lfd, 0);
2815                 if (m == MAP_FAILED) {
2816                         env->me_txns = NULL;
2817                         rc = ErrCode();
2818                         goto fail;
2819                 }
2820                 env->me_txns = m;
2821 #endif
2822         }
2823         if (*excl) {
2824 #ifdef _WIN32
2825                 char hexbuf[17];
2826                 if (!mdb_sec_inited) {
2827                         InitializeSecurityDescriptor(&mdb_null_sd,
2828                                 SECURITY_DESCRIPTOR_REVISION);
2829                         SetSecurityDescriptorDacl(&mdb_null_sd, TRUE, 0, FALSE);
2830                         mdb_all_sa.nLength = sizeof(SECURITY_ATTRIBUTES);
2831                         mdb_all_sa.bInheritHandle = FALSE;
2832                         mdb_all_sa.lpSecurityDescriptor = &mdb_null_sd;
2833                         mdb_sec_inited = 1;
2834                 }
2835                 mdb_hash_hex(lpath, hexbuf);
2836                 sprintf(env->me_txns->mti_rmname, "Global\\MDBr%s", hexbuf);
2837                 env->me_rmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_rmname);
2838                 if (!env->me_rmutex) {
2839                         rc = ErrCode();
2840                         goto fail;
2841                 }
2842                 sprintf(env->me_txns->mti_wmname, "Global\\MDBw%s", hexbuf);
2843                 env->me_wmutex = CreateMutex(&mdb_all_sa, FALSE, env->me_txns->mti_wmname);
2844                 if (!env->me_wmutex) {
2845                         rc = ErrCode();
2846                         goto fail;
2847                 }
2848 #else   /* _WIN32 */
2849 #ifdef __APPLE__
2850                 char hexbuf[17];
2851                 mdb_hash_hex(lpath, hexbuf);
2852                 sprintf(env->me_txns->mti_rmname, "MDBr%s", hexbuf);
2853                 if (sem_unlink(env->me_txns->mti_rmname)) {
2854                         rc = ErrCode();
2855                         if (rc != ENOENT && rc != EINVAL)
2856                                 goto fail;
2857                 }
2858                 env->me_rmutex = sem_open(env->me_txns->mti_rmname, O_CREAT, mode, 1);
2859                 if (!env->me_rmutex) {
2860                         rc = ErrCode();
2861                         goto fail;
2862                 }
2863                 sprintf(env->me_txns->mti_wmname, "MDBw%s", hexbuf);
2864                 if (sem_unlink(env->me_txns->mti_wmname)) {
2865                         rc = ErrCode();
2866                         if (rc != ENOENT && rc != EINVAL)
2867                                 goto fail;
2868                 }
2869                 env->me_wmutex = sem_open(env->me_txns->mti_wmname, O_CREAT, mode, 1);
2870                 if (!env->me_wmutex) {
2871                         rc = ErrCode();
2872                         goto fail;
2873                 }
2874 #else   /* __APPLE__ */
2875                 pthread_mutexattr_t mattr;
2876
2877                 pthread_mutexattr_init(&mattr);
2878                 rc = pthread_mutexattr_setpshared(&mattr, PTHREAD_PROCESS_SHARED);
2879                 if (rc) {
2880                         goto fail;
2881                 }
2882                 pthread_mutex_init(&env->me_txns->mti_mutex, &mattr);
2883                 pthread_mutex_init(&env->me_txns->mti_wmutex, &mattr);
2884 #endif  /* __APPLE__ */
2885 #endif  /* _WIN32 */
2886                 env->me_txns->mti_version = MDB_VERSION;
2887                 env->me_txns->mti_magic = MDB_MAGIC;
2888                 env->me_txns->mti_txnid = 0;
2889                 env->me_txns->mti_numreaders = 0;
2890                 env->me_txns->mti_me_toggle = 0;
2891
2892         } else {
2893                 if (env->me_txns->mti_magic != MDB_MAGIC) {
2894                         DPUTS("lock region has invalid magic");
2895                         rc = EINVAL;
2896                         goto fail;
2897                 }
2898                 if (env->me_txns->mti_version != MDB_VERSION) {
2899                         DPRINTF("lock region is version %u, expected version %u",
2900                                 env->me_txns->mti_version, MDB_VERSION);
2901                         rc = MDB_VERSION_MISMATCH;
2902                         goto fail;
2903                 }
2904                 rc = ErrCode();
2905                 if (rc != EACCES && rc != EAGAIN) {
2906                         goto fail;
2907                 }
2908 #ifdef _WIN32
2909                 env->me_rmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_rmname);
2910                 if (!env->me_rmutex) {
2911                         rc = ErrCode();
2912                         goto fail;
2913                 }
2914                 env->me_wmutex = OpenMutex(SYNCHRONIZE, FALSE, env->me_txns->mti_wmname);
2915                 if (!env->me_wmutex) {
2916                         rc = ErrCode();
2917                         goto fail;
2918                 }
2919 #endif
2920 #ifdef __APPLE__
2921                 env->me_rmutex = sem_open(env->me_txns->mti_rmname, 0);
2922                 if (!env->me_rmutex) {
2923                         rc = ErrCode();
2924                         goto fail;
2925                 }
2926                 env->me_wmutex = sem_open(env->me_txns->mti_wmname, 0);
2927                 if (!env->me_wmutex) {
2928                         rc = ErrCode();
2929                         goto fail;
2930                 }
2931 #endif
2932         }
2933         return MDB_SUCCESS;
2934
2935 fail:
2936         close(env->me_lfd);
2937         env->me_lfd = INVALID_HANDLE_VALUE;
2938         return rc;
2939
2940 }
2941
2942         /** The name of the lock file in the DB environment */
2943 #define LOCKNAME        "/lock.mdb"
2944         /** The name of the data file in the DB environment */
2945 #define DATANAME        "/data.mdb"
2946         /** The suffix of the lock file when no subdir is used */
2947 #define LOCKSUFF        "-lock"
2948
2949 int
2950 mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mode_t mode)
2951 {
2952         int             oflags, rc, len, excl;
2953         char *lpath, *dpath;
2954
2955         len = strlen(path);
2956         if (flags & MDB_NOSUBDIR) {
2957                 rc = len + sizeof(LOCKSUFF) + len + 1;
2958         } else {
2959                 rc = len + sizeof(LOCKNAME) + len + sizeof(DATANAME);
2960         }
2961         lpath = malloc(rc);
2962         if (!lpath)
2963                 return ENOMEM;
2964         if (flags & MDB_NOSUBDIR) {
2965                 dpath = lpath + len + sizeof(LOCKSUFF);
2966                 sprintf(lpath, "%s" LOCKSUFF, path);
2967                 strcpy(dpath, path);
2968         } else {
2969                 dpath = lpath + len + sizeof(LOCKNAME);
2970                 sprintf(lpath, "%s" LOCKNAME, path);
2971                 sprintf(dpath, "%s" DATANAME, path);
2972         }
2973
2974         rc = mdb_env_setup_locks(env, lpath, mode, &excl);
2975         if (rc)
2976                 goto leave;
2977
2978 #ifdef _WIN32
2979         if (F_ISSET(flags, MDB_RDONLY)) {
2980                 oflags = GENERIC_READ;
2981                 len = OPEN_EXISTING;
2982         } else {
2983                 oflags = GENERIC_READ|GENERIC_WRITE;
2984                 len = OPEN_ALWAYS;
2985         }
2986         mode = FILE_ATTRIBUTE_NORMAL;
2987         env->me_fd = CreateFile(dpath, oflags, FILE_SHARE_READ|FILE_SHARE_WRITE,
2988                 NULL, len, mode, NULL);
2989 #else
2990         if (F_ISSET(flags, MDB_RDONLY))
2991                 oflags = O_RDONLY;
2992         else
2993                 oflags = O_RDWR | O_CREAT;
2994
2995         env->me_fd = open(dpath, oflags, mode);
2996 #endif
2997         if (env->me_fd == INVALID_HANDLE_VALUE) {
2998                 rc = ErrCode();
2999                 goto leave;
3000         }
3001
3002         if ((rc = mdb_env_open2(env, flags)) == MDB_SUCCESS) {
3003                 if (flags & (MDB_RDONLY|MDB_NOSYNC)) {
3004                         env->me_mfd = env->me_fd;
3005                 } else {
3006                         /* synchronous fd for meta writes */
3007 #ifdef _WIN32
3008                         env->me_mfd = CreateFile(dpath, oflags,
3009                                 FILE_SHARE_READ|FILE_SHARE_WRITE, NULL, len,
3010                                 mode | FILE_FLAG_WRITE_THROUGH, NULL);
3011 #else
3012                         env->me_mfd = open(dpath, oflags | MDB_DSYNC, mode);
3013 #endif
3014                         if (env->me_mfd == INVALID_HANDLE_VALUE) {
3015                                 rc = ErrCode();
3016                                 goto leave;
3017                         }
3018                 }
3019                 env->me_path = strdup(path);
3020                 DPRINTF("opened dbenv %p", (void *) env);
3021                 pthread_key_create(&env->me_txkey, mdb_env_reader_dest);
3022                 LAZY_RWLOCK_INIT(&env->me_dblock, NULL);
3023                 if (excl)
3024                         mdb_env_share_locks(env);
3025                 env->me_dbxs = calloc(env->me_maxdbs, sizeof(MDB_dbx));
3026                 env->me_dbs[0] = calloc(env->me_maxdbs, sizeof(MDB_db));
3027                 env->me_dbs[1] = calloc(env->me_maxdbs, sizeof(MDB_db));
3028                 env->me_numdbs = 2;
3029         }
3030
3031 leave:
3032         if (rc) {
3033                 if (env->me_fd != INVALID_HANDLE_VALUE) {
3034                         close(env->me_fd);
3035                         env->me_fd = INVALID_HANDLE_VALUE;
3036                 }
3037                 if (env->me_lfd != INVALID_HANDLE_VALUE) {
3038                         close(env->me_lfd);
3039                         env->me_lfd = INVALID_HANDLE_VALUE;
3040                 }
3041         }
3042         free(lpath);
3043         return rc;
3044 }
3045
3046 void
3047 mdb_env_close(MDB_env *env)
3048 {
3049         MDB_page *dp;
3050
3051         if (env == NULL)
3052                 return;
3053
3054         VGMEMP_DESTROY(env);
3055         while (env->me_dpages) {
3056                 dp = env->me_dpages;
3057                 VGMEMP_DEFINED(&dp->mp_next, sizeof(dp->mp_next));
3058                 env->me_dpages = dp->mp_next;
3059                 free(dp);
3060         }
3061
3062         free(env->me_dbs[1]);
3063         free(env->me_dbs[0]);
3064         free(env->me_dbxs);
3065         free(env->me_path);
3066
3067         LAZY_RWLOCK_DESTROY(&env->me_dblock);
3068         pthread_key_delete(env->me_txkey);
3069
3070         if (env->me_map) {
3071                 munmap(env->me_map, env->me_mapsize);
3072         }
3073         if (env->me_mfd != env->me_fd)
3074                 close(env->me_mfd);
3075         close(env->me_fd);
3076         if (env->me_txns) {
3077                 pid_t pid = getpid();
3078                 unsigned int i;
3079                 for (i=0; i<env->me_txns->mti_numreaders; i++)
3080                         if (env->me_txns->mti_readers[i].mr_pid == pid)
3081                                 env->me_txns->mti_readers[i].mr_pid = 0;
3082                 munmap((void *)env->me_txns, (env->me_maxreaders-1)*sizeof(MDB_reader)+sizeof(MDB_txninfo));
3083         }
3084         close(env->me_lfd);
3085         mdb_midl_free(env->me_free_pgs);
3086         free(env);
3087 }
3088
3089 /** Compare two items pointing at aligned size_t's */
3090 static int
3091 mdb_cmp_long(const MDB_val *a, const MDB_val *b)
3092 {
3093         return (*(size_t *)a->mv_data < *(size_t *)b->mv_data) ? -1 :
3094                 *(size_t *)a->mv_data > *(size_t *)b->mv_data;
3095 }
3096
3097 /** Compare two items pointing at aligned int's */
3098 static int
3099 mdb_cmp_int(const MDB_val *a, const MDB_val *b)
3100 {
3101         return (*(unsigned int *)a->mv_data < *(unsigned int *)b->mv_data) ? -1 :
3102                 *(unsigned int *)a->mv_data > *(unsigned int *)b->mv_data;
3103 }
3104
3105 /** Compare two items pointing at ints of unknown alignment.
3106  *      Nodes and keys are guaranteed to be 2-byte aligned.
3107  */
3108 static int
3109 mdb_cmp_cint(const MDB_val *a, const MDB_val *b)
3110 {
3111 #if BYTE_ORDER == LITTLE_ENDIAN
3112         unsigned short *u, *c;
3113         int x;
3114
3115         u = (unsigned short *) ((char *) a->mv_data + a->mv_size);
3116         c = (unsigned short *) ((char *) b->mv_data + a->mv_size);
3117         do {
3118                 x = *--u - *--c;
3119         } while(!x && u > (unsigned short *)a->mv_data);
3120         return x;
3121 #else
3122         return memcmp(a->mv_data, b->mv_data, a->mv_size);
3123 #endif
3124 }
3125
3126 /** Compare two items lexically */
3127 static int
3128 mdb_cmp_memn(const MDB_val *a, const MDB_val *b)
3129 {
3130         int diff;
3131         ssize_t len_diff;
3132         unsigned int len;
3133
3134         len = a->mv_size;
3135         len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3136         if (len_diff > 0) {
3137                 len = b->mv_size;
3138                 len_diff = 1;
3139         }
3140
3141         diff = memcmp(a->mv_data, b->mv_data, len);
3142         return diff ? diff : len_diff<0 ? -1 : len_diff;
3143 }
3144
3145 /** Compare two items in reverse byte order */
3146 static int
3147 mdb_cmp_memnr(const MDB_val *a, const MDB_val *b)
3148 {
3149         const unsigned char     *p1, *p2, *p1_lim;
3150         ssize_t len_diff;
3151         int diff;
3152
3153         p1_lim = (const unsigned char *)a->mv_data;
3154         p1 = (const unsigned char *)a->mv_data + a->mv_size;
3155         p2 = (const unsigned char *)b->mv_data + b->mv_size;
3156
3157         len_diff = (ssize_t) a->mv_size - (ssize_t) b->mv_size;
3158         if (len_diff > 0) {
3159                 p1_lim += len_diff;
3160                 len_diff = 1;
3161         }
3162
3163         while (p1 > p1_lim) {
3164                 diff = *--p1 - *--p2;
3165                 if (diff)
3166                         return diff;
3167         }
3168         return len_diff<0 ? -1 : len_diff;
3169 }
3170
3171 /** Search for key within a page, using binary search.
3172  * Returns the smallest entry larger or equal to the key.
3173  * If exactp is non-null, stores whether the found entry was an exact match
3174  * in *exactp (1 or 0).
3175  * Updates the cursor index with the index of the found entry.
3176  * If no entry larger or equal to the key is found, returns NULL.
3177  */
3178 static MDB_node *
3179 mdb_node_search(MDB_cursor *mc, MDB_val *key, int *exactp)
3180 {
3181         unsigned int     i = 0, nkeys;
3182         int              low, high;
3183         int              rc = 0;
3184         MDB_page *mp = mc->mc_pg[mc->mc_top];
3185         MDB_node        *node = NULL;
3186         MDB_val  nodekey;
3187         MDB_cmp_func *cmp;
3188         DKBUF;
3189
3190         nkeys = NUMKEYS(mp);
3191
3192 #if MDB_DEBUG
3193         {
3194         pgno_t pgno;
3195         COPY_PGNO(pgno, mp->mp_pgno);
3196         DPRINTF("searching %u keys in %s %spage %zu",
3197             nkeys, IS_LEAF(mp) ? "leaf" : "branch", IS_SUBP(mp) ? "sub-" : "",
3198             pgno);
3199         }
3200 #endif
3201
3202         assert(nkeys > 0);
3203
3204         low = IS_LEAF(mp) ? 0 : 1;
3205         high = nkeys - 1;
3206         cmp = mc->mc_dbx->md_cmp;
3207
3208         /* Branch pages have no data, so if using integer keys,
3209          * alignment is guaranteed. Use faster mdb_cmp_int.
3210          */
3211         if (cmp == mdb_cmp_cint && IS_BRANCH(mp)) {
3212                 if (NODEPTR(mp, 1)->mn_ksize == sizeof(size_t))
3213                         cmp = mdb_cmp_long;
3214                 else
3215                         cmp = mdb_cmp_int;
3216         }
3217
3218         if (IS_LEAF2(mp)) {
3219                 nodekey.mv_size = mc->mc_db->md_pad;
3220                 node = NODEPTR(mp, 0);  /* fake */
3221                 while (low <= high) {
3222                         i = (low + high) >> 1;
3223                         nodekey.mv_data = LEAF2KEY(mp, i, nodekey.mv_size);
3224                         rc = cmp(key, &nodekey);
3225                         DPRINTF("found leaf index %u [%s], rc = %i",
3226                             i, DKEY(&nodekey), rc);
3227                         if (rc == 0)
3228                                 break;
3229                         if (rc > 0)
3230                                 low = i + 1;
3231                         else
3232                                 high = i - 1;
3233                 }
3234         } else {
3235                 while (low <= high) {
3236                         i = (low + high) >> 1;
3237
3238                         node = NODEPTR(mp, i);
3239                         nodekey.mv_size = NODEKSZ(node);
3240                         nodekey.mv_data = NODEKEY(node);
3241
3242                         rc = cmp(key, &nodekey);
3243 #if MDB_DEBUG
3244                         if (IS_LEAF(mp))
3245                                 DPRINTF("found leaf index %u [%s], rc = %i",
3246                                     i, DKEY(&nodekey), rc);
3247                         else
3248                                 DPRINTF("found branch index %u [%s -> %zu], rc = %i",
3249                                     i, DKEY(&nodekey), NODEPGNO(node), rc);
3250 #endif
3251                         if (rc == 0)
3252                                 break;
3253                         if (rc > 0)
3254                                 low = i + 1;
3255                         else
3256                                 high = i - 1;
3257                 }
3258         }
3259
3260         if (rc > 0) {   /* Found entry is less than the key. */
3261                 i++;    /* Skip to get the smallest entry larger than key. */
3262                 if (!IS_LEAF2(mp))
3263                         node = NODEPTR(mp, i);
3264         }
3265         if (exactp)
3266                 *exactp = (rc == 0);
3267         /* store the key index */
3268         mc->mc_ki[mc->mc_top] = i;
3269         if (i >= nkeys)
3270                 /* There is no entry larger or equal to the key. */
3271                 return NULL;
3272
3273         /* nodeptr is fake for LEAF2 */
3274         return node;
3275 }
3276
3277 #if 0
3278 static void
3279 mdb_cursor_adjust(MDB_cursor *mc, func)
3280 {
3281         MDB_cursor *m2;
3282
3283         for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
3284                 if (m2->mc_pg[m2->mc_top] == mc->mc_pg[mc->mc_top]) {
3285                         func(mc, m2);
3286                 }
3287         }
3288 }
3289 #endif
3290
3291 /** Pop a page off the top of the cursor's stack. */
3292 static void
3293 mdb_cursor_pop(MDB_cursor *mc)
3294 {
3295         MDB_page        *top;
3296
3297         if (mc->mc_snum) {
3298                 top = mc->mc_pg[mc->mc_top];
3299                 mc->mc_snum--;
3300                 if (mc->mc_snum)
3301                         mc->mc_top--;
3302
3303                 DPRINTF("popped page %zu off db %u cursor %p", top->mp_pgno,
3304                         mc->mc_dbi, (void *) mc);
3305         }
3306 }
3307
3308 /** Push a page onto the top of the cursor's stack. */
3309 static int
3310 mdb_cursor_push(MDB_cursor *mc, MDB_page *mp)
3311 {
3312         DPRINTF("pushing page %zu on db %u cursor %p", mp->mp_pgno,
3313                 mc->mc_dbi, (void *) mc);
3314
3315         if (mc->mc_snum >= CURSOR_STACK) {
3316                 assert(mc->mc_snum < CURSOR_STACK);
3317                 return ENOMEM;
3318         }
3319
3320         mc->mc_top = mc->mc_snum++;
3321         mc->mc_pg[mc->mc_top] = mp;
3322         mc->mc_ki[mc->mc_top] = 0;
3323
3324         return MDB_SUCCESS;
3325 }
3326
3327 /** Find the address of the page corresponding to a given page number.
3328  * @param[in] txn the transaction for this access.
3329  * @param[in] pgno the page number for the page to retrieve.
3330  * @param[out] ret address of a pointer where the page's address will be stored.
3331  * @return 0 on success, non-zero on failure.
3332  */
3333 static int
3334 mdb_page_get(MDB_txn *txn, pgno_t pgno, MDB_page **ret)
3335 {
3336         MDB_page *p = NULL;
3337
3338         if (!F_ISSET(txn->mt_flags, MDB_TXN_RDONLY) && txn->mt_u.dirty_list[0].mid) {
3339                 unsigned x;
3340                 x = mdb_mid2l_search(txn->mt_u.dirty_list, pgno);
3341                 if (x <= txn->mt_u.dirty_list[0].mid && txn->mt_u.dirty_list[x].mid == pgno) {
3342                         p = txn->mt_u.dirty_list[x].mptr;
3343                 }
3344         }
3345         if (!p) {
3346                 if (pgno <= txn->mt_env->me_metas[txn->mt_toggle]->mm_last_pg)
3347                         p = (MDB_page *)(txn->mt_env->me_map + txn->mt_env->me_psize * pgno);
3348         }
3349         *ret = p;
3350         if (!p) {
3351                 DPRINTF("page %zu not found", pgno);
3352                 assert(p != NULL);
3353         }
3354         return (p != NULL) ? MDB_SUCCESS : MDB_PAGE_NOTFOUND;
3355 }
3356
3357 /** Search for the page a given key should be in.
3358  * Pushes parent pages on the cursor stack. This function continues a
3359  * search on a cursor that has already been initialized. (Usually by
3360  * #mdb_page_search() but also by #mdb_node_move().)
3361  * @param[in,out] mc the cursor for this operation.
3362  * @param[in] key the key to search for. If NULL, search for the lowest
3363  * page. (This is used by #mdb_cursor_first().)
3364  * @param[in] modify If true, visited pages are updated with new page numbers.
3365  * @return 0 on success, non-zero on failure.
3366  */
3367 static int
3368 mdb_page_search_root(MDB_cursor *mc, MDB_val *key, int modify)
3369 {
3370         MDB_page        *mp = mc->mc_pg[mc->mc_top];
3371         DKBUF;
3372         int rc;
3373
3374
3375         while (IS_BRANCH(mp)) {
3376                 MDB_node        *node;
3377                 indx_t          i;
3378
3379                 DPRINTF("branch page %zu has %u keys", mp->mp_pgno, NUMKEYS(mp));
3380                 assert(NUMKEYS(mp) > 1);
3381                 DPRINTF("found index 0 to page %zu", NODEPGNO(NODEPTR(mp, 0)));
3382
3383                 if (key == NULL)        /* Initialize cursor to first page. */
3384                         i = 0;
3385                 else if (key->mv_size > MAXKEYSIZE && key->mv_data == NULL) {
3386                                                         /* cursor to last page */
3387                         i = NUMKEYS(mp)-1;
3388                 } else {
3389                         int      exact;
3390                         node = mdb_node_search(mc, key, &exact);
3391                         if (node == NULL)
3392                                 i = NUMKEYS(mp) - 1;
3393                         else {
3394                                 i = mc->mc_ki[mc->mc_top];
3395                                 if (!exact) {
3396                                         assert(i > 0);
3397                                         i--;
3398                                 }
3399                         }
3400                 }
3401
3402                 if (key)
3403                         DPRINTF("following index %u for key [%s]",
3404                             i, DKEY(key));
3405                 assert(i < NUMKEYS(mp));
3406                 node = NODEPTR(mp, i);
3407
3408                 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mp)))
3409                         return rc;
3410
3411                 mc->mc_ki[mc->mc_top] = i;
3412                 if ((rc = mdb_cursor_push(mc, mp)))
3413                         return rc;
3414
3415                 if (modify) {
3416                         if ((rc = mdb_page_touch(mc)) != 0)
3417                                 return rc;
3418                         mp = mc->mc_pg[mc->mc_top];
3419                 }
3420         }
3421
3422         if (!IS_LEAF(mp)) {
3423                 DPRINTF("internal error, index points to a %02X page!?",
3424                     mp->mp_flags);
3425                 return MDB_CORRUPTED;
3426         }
3427
3428         DPRINTF("found leaf page %zu for key [%s]", mp->mp_pgno,
3429             key ? DKEY(key) : NULL);
3430
3431         return MDB_SUCCESS;
3432 }
3433
3434 /** Search for the page a given key should be in.
3435  * Pushes parent pages on the cursor stack. This function just sets up
3436  * the search; it finds the root page for \b mc's database and sets this
3437  * as the root of the cursor's stack. Then #mdb_page_search_root() is
3438  * called to complete the search.
3439  * @param[in,out] mc the cursor for this operation.
3440  * @param[in] key the key to search for. If NULL, search for the lowest
3441  * page. (This is used by #mdb_cursor_first().)
3442  * @param[in] modify If true, visited pages are updated with new page numbers.
3443  * @return 0 on success, non-zero on failure.
3444  */
3445 static int
3446 mdb_page_search(MDB_cursor *mc, MDB_val *key, int modify)
3447 {
3448         int              rc;
3449         pgno_t           root;
3450
3451         /* Make sure the txn is still viable, then find the root from
3452          * the txn's db table.
3453          */
3454         if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_ERROR)) {
3455                 DPUTS("transaction has failed, must abort");
3456                 return EINVAL;
3457         } else {
3458                 /* Make sure we're using an up-to-date root */
3459                 if (mc->mc_dbi > MAIN_DBI) {
3460                         if ((*mc->mc_dbflag & DB_STALE) ||
3461                         (modify && !(*mc->mc_dbflag & DB_DIRTY))) {
3462                                 MDB_cursor mc2;
3463                                 unsigned char dbflag = 0;
3464                                 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
3465                                 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, modify);
3466                                 if (rc)
3467                                         return rc;
3468                                 if (*mc->mc_dbflag & DB_STALE) {
3469                                         MDB_val data;
3470                                         int exact = 0;
3471                                         MDB_node *leaf = mdb_node_search(&mc2,
3472                                                 &mc->mc_dbx->md_name, &exact);
3473                                         if (!exact)
3474                                                 return MDB_NOTFOUND;
3475                                         mdb_node_read(mc->mc_txn, leaf, &data);
3476                                         memcpy(mc->mc_db, data.mv_data, sizeof(MDB_db));
3477                                 }
3478                                 if (modify)
3479                                         dbflag = DB_DIRTY;
3480                                 *mc->mc_dbflag = dbflag;
3481                         }
3482                 }
3483                 root = mc->mc_db->md_root;
3484
3485                 if (root == P_INVALID) {                /* Tree is empty. */
3486                         DPUTS("tree is empty");
3487                         return MDB_NOTFOUND;
3488                 }
3489         }
3490
3491         assert(root > 1);
3492         if ((rc = mdb_page_get(mc->mc_txn, root, &mc->mc_pg[0])))
3493                 return rc;
3494
3495         mc->mc_snum = 1;
3496         mc->mc_top = 0;
3497
3498         DPRINTF("db %u root page %zu has flags 0x%X",
3499                 mc->mc_dbi, root, mc->mc_pg[0]->mp_flags);
3500
3501         if (modify) {
3502                 if ((rc = mdb_page_touch(mc)))
3503                         return rc;
3504         }
3505
3506         return mdb_page_search_root(mc, key, modify);
3507 }
3508
3509 /** Return the data associated with a given node.
3510  * @param[in] txn The transaction for this operation.
3511  * @param[in] leaf The node being read.
3512  * @param[out] data Updated to point to the node's data.
3513  * @return 0 on success, non-zero on failure.
3514  */
3515 static int
3516 mdb_node_read(MDB_txn *txn, MDB_node *leaf, MDB_val *data)
3517 {
3518         MDB_page        *omp;           /* overflow page */
3519         pgno_t           pgno;
3520         int rc;
3521
3522         if (!F_ISSET(leaf->mn_flags, F_BIGDATA)) {
3523                 data->mv_size = NODEDSZ(leaf);
3524                 data->mv_data = NODEDATA(leaf);
3525                 return MDB_SUCCESS;
3526         }
3527
3528         /* Read overflow data.
3529          */
3530         data->mv_size = NODEDSZ(leaf);
3531         memcpy(&pgno, NODEDATA(leaf), sizeof(pgno));
3532         if ((rc = mdb_page_get(txn, pgno, &omp))) {
3533                 DPRINTF("read overflow page %zu failed", pgno);
3534                 return rc;
3535         }
3536         data->mv_data = METADATA(omp);
3537
3538         return MDB_SUCCESS;
3539 }
3540
3541 int
3542 mdb_get(MDB_txn *txn, MDB_dbi dbi,
3543     MDB_val *key, MDB_val *data)
3544 {
3545         MDB_cursor      mc;
3546         MDB_xcursor     mx;
3547         int exact = 0;
3548         DKBUF;
3549
3550         assert(key);
3551         assert(data);
3552         DPRINTF("===> get db %u key [%s]", dbi, DKEY(key));
3553
3554         if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
3555                 return EINVAL;
3556
3557         if (key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
3558                 return EINVAL;
3559         }
3560
3561         mdb_cursor_init(&mc, txn, dbi, &mx);
3562         return mdb_cursor_set(&mc, key, data, MDB_SET, &exact);
3563 }
3564
3565 /** Find a sibling for a page.
3566  * Replaces the page at the top of the cursor's stack with the
3567  * specified sibling, if one exists.
3568  * @param[in] mc The cursor for this operation.
3569  * @param[in] move_right Non-zero if the right sibling is requested,
3570  * otherwise the left sibling.
3571  * @return 0 on success, non-zero on failure.
3572  */
3573 static int
3574 mdb_cursor_sibling(MDB_cursor *mc, int move_right)
3575 {
3576         int              rc;
3577         MDB_node        *indx;
3578         MDB_page        *mp;
3579
3580         if (mc->mc_snum < 2) {
3581                 return MDB_NOTFOUND;            /* root has no siblings */
3582         }
3583
3584         mdb_cursor_pop(mc);
3585         DPRINTF("parent page is page %zu, index %u",
3586                 mc->mc_pg[mc->mc_top]->mp_pgno, mc->mc_ki[mc->mc_top]);
3587
3588         if (move_right ? (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mc->mc_pg[mc->mc_top]))
3589                        : (mc->mc_ki[mc->mc_top] == 0)) {
3590                 DPRINTF("no more keys left, moving to %s sibling",
3591                     move_right ? "right" : "left");
3592                 if ((rc = mdb_cursor_sibling(mc, move_right)) != MDB_SUCCESS)
3593                         return rc;
3594         } else {
3595                 if (move_right)
3596                         mc->mc_ki[mc->mc_top]++;
3597                 else
3598                         mc->mc_ki[mc->mc_top]--;
3599                 DPRINTF("just moving to %s index key %u",
3600                     move_right ? "right" : "left", mc->mc_ki[mc->mc_top]);
3601         }
3602         assert(IS_BRANCH(mc->mc_pg[mc->mc_top]));
3603
3604         indx = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
3605         if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(indx), &mp)))
3606                 return rc;;
3607
3608         mdb_cursor_push(mc, mp);
3609
3610         return MDB_SUCCESS;
3611 }
3612
3613 /** Move the cursor to the next data item. */
3614 static int
3615 mdb_cursor_next(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
3616 {
3617         MDB_page        *mp;
3618         MDB_node        *leaf;
3619         int rc;
3620
3621         if (mc->mc_flags & C_EOF) {
3622                 return MDB_NOTFOUND;
3623         }
3624
3625         assert(mc->mc_flags & C_INITIALIZED);
3626
3627         mp = mc->mc_pg[mc->mc_top];
3628
3629         if (mc->mc_db->md_flags & MDB_DUPSORT) {
3630                 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3631                 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3632                         if (op == MDB_NEXT || op == MDB_NEXT_DUP) {
3633                                 rc = mdb_cursor_next(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_NEXT);
3634                                 if (op != MDB_NEXT || rc == MDB_SUCCESS)
3635                                         return rc;
3636                         }
3637                 } else {
3638                         mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
3639                         if (op == MDB_NEXT_DUP)
3640                                 return MDB_NOTFOUND;
3641                 }
3642         }
3643
3644         DPRINTF("cursor_next: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
3645
3646         if (mc->mc_ki[mc->mc_top] + 1u >= NUMKEYS(mp)) {
3647                 DPUTS("=====> move to next sibling page");
3648                 if (mdb_cursor_sibling(mc, 1) != MDB_SUCCESS) {
3649                         mc->mc_flags |= C_EOF;
3650                         mc->mc_flags &= ~C_INITIALIZED;
3651                         return MDB_NOTFOUND;
3652                 }
3653                 mp = mc->mc_pg[mc->mc_top];
3654                 DPRINTF("next page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
3655         } else
3656                 mc->mc_ki[mc->mc_top]++;
3657
3658         DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
3659             mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
3660
3661         if (IS_LEAF2(mp)) {
3662                 key->mv_size = mc->mc_db->md_pad;
3663                 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
3664                 return MDB_SUCCESS;
3665         }
3666
3667         assert(IS_LEAF(mp));
3668         leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3669
3670         if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3671                 mdb_xcursor_init1(mc, leaf);
3672         }
3673         if (data) {
3674                 if ((rc = mdb_node_read(mc->mc_txn, leaf, data) != MDB_SUCCESS))
3675                         return rc;
3676
3677                 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3678                         rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
3679                         if (rc != MDB_SUCCESS)
3680                                 return rc;
3681                 }
3682         }
3683
3684         MDB_SET_KEY(leaf, key);
3685         return MDB_SUCCESS;
3686 }
3687
3688 /** Move the cursor to the previous data item. */
3689 static int
3690 mdb_cursor_prev(MDB_cursor *mc, MDB_val *key, MDB_val *data, MDB_cursor_op op)
3691 {
3692         MDB_page        *mp;
3693         MDB_node        *leaf;
3694         int rc;
3695
3696         assert(mc->mc_flags & C_INITIALIZED);
3697
3698         mp = mc->mc_pg[mc->mc_top];
3699
3700         if (mc->mc_db->md_flags & MDB_DUPSORT) {
3701                 leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3702                 if (op == MDB_PREV || op == MDB_PREV_DUP) {
3703                         if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3704                                 rc = mdb_cursor_prev(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_PREV);
3705                                 if (op != MDB_PREV || rc == MDB_SUCCESS)
3706                                         return rc;
3707                         } else {
3708                                 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
3709                                 if (op == MDB_PREV_DUP)
3710                                         return MDB_NOTFOUND;
3711                         }
3712                 }
3713         }
3714
3715         DPRINTF("cursor_prev: top page is %zu in cursor %p", mp->mp_pgno, (void *) mc);
3716
3717         if (mc->mc_ki[mc->mc_top] == 0)  {
3718                 DPUTS("=====> move to prev sibling page");
3719                 if (mdb_cursor_sibling(mc, 0) != MDB_SUCCESS) {
3720                         mc->mc_flags &= ~C_INITIALIZED;
3721                         return MDB_NOTFOUND;
3722                 }
3723                 mp = mc->mc_pg[mc->mc_top];
3724                 mc->mc_ki[mc->mc_top] = NUMKEYS(mp) - 1;
3725                 DPRINTF("prev page is %zu, key index %u", mp->mp_pgno, mc->mc_ki[mc->mc_top]);
3726         } else
3727                 mc->mc_ki[mc->mc_top]--;
3728
3729         mc->mc_flags &= ~C_EOF;
3730
3731         DPRINTF("==> cursor points to page %zu with %u keys, key index %u",
3732             mp->mp_pgno, NUMKEYS(mp), mc->mc_ki[mc->mc_top]);
3733
3734         if (IS_LEAF2(mp)) {
3735                 key->mv_size = mc->mc_db->md_pad;
3736                 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
3737                 return MDB_SUCCESS;
3738         }
3739
3740         assert(IS_LEAF(mp));
3741         leaf = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
3742
3743         if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3744                 mdb_xcursor_init1(mc, leaf);
3745         }
3746         if (data) {
3747                 if ((rc = mdb_node_read(mc->mc_txn, leaf, data) != MDB_SUCCESS))
3748                         return rc;
3749
3750                 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3751                         rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
3752                         if (rc != MDB_SUCCESS)
3753                                 return rc;
3754                 }
3755         }
3756
3757         MDB_SET_KEY(leaf, key);
3758         return MDB_SUCCESS;
3759 }
3760
3761 /** Set the cursor on a specific data item. */
3762 static int
3763 mdb_cursor_set(MDB_cursor *mc, MDB_val *key, MDB_val *data,
3764     MDB_cursor_op op, int *exactp)
3765 {
3766         int              rc;
3767         MDB_page        *mp;
3768         MDB_node        *leaf;
3769         DKBUF;
3770
3771         assert(mc);
3772         assert(key);
3773         assert(key->mv_size > 0);
3774
3775         /* See if we're already on the right page */
3776         if (mc->mc_flags & C_INITIALIZED) {
3777                 MDB_val nodekey;
3778
3779                 mp = mc->mc_pg[mc->mc_top];
3780                 if (!NUMKEYS(mp)) {
3781                         mc->mc_ki[mc->mc_top] = 0;
3782                         return MDB_NOTFOUND;
3783                 }
3784                 if (mp->mp_flags & P_LEAF2) {
3785                         nodekey.mv_size = mc->mc_db->md_pad;
3786                         nodekey.mv_data = LEAF2KEY(mp, 0, nodekey.mv_size);
3787                 } else {
3788                         leaf = NODEPTR(mp, 0);
3789                         MDB_SET_KEY(leaf, &nodekey);
3790                 }
3791                 rc = mc->mc_dbx->md_cmp(key, &nodekey);
3792                 if (rc == 0) {
3793                         /* Probably happens rarely, but first node on the page
3794                          * was the one we wanted.
3795                          */
3796                         mc->mc_ki[mc->mc_top] = 0;
3797                         leaf = NODEPTR(mp, 0);
3798                         if (exactp)
3799                                 *exactp = 1;
3800                         goto set1;
3801                 }
3802                 if (rc > 0) {
3803                         unsigned int i;
3804                         unsigned int nkeys = NUMKEYS(mp);
3805                         if (nkeys > 1) {
3806                                 if (mp->mp_flags & P_LEAF2) {
3807                                         nodekey.mv_data = LEAF2KEY(mp,
3808                                                  nkeys-1, nodekey.mv_size);
3809                                 } else {
3810                                         leaf = NODEPTR(mp, nkeys-1);
3811                                         MDB_SET_KEY(leaf, &nodekey);
3812                                 }
3813                                 rc = mc->mc_dbx->md_cmp(key, &nodekey);
3814                                 if (rc == 0) {
3815                                         /* last node was the one we wanted */
3816                                         mc->mc_ki[mc->mc_top] = nkeys-1;
3817                                         leaf = NODEPTR(mp, nkeys-1);
3818                                         if (exactp)
3819                                                 *exactp = 1;
3820                                         goto set1;
3821                                 }
3822                                 if (rc < 0) {
3823                                         /* This is definitely the right page, skip search_page */
3824                                         rc = 0;
3825                                         goto set2;
3826                                 }
3827                         }
3828                         /* If any parents have right-sibs, search.
3829                          * Otherwise, there's nothing further.
3830                          */
3831                         for (i=0; i<mc->mc_top; i++)
3832                                 if (mc->mc_ki[i] <
3833                                         NUMKEYS(mc->mc_pg[i])-1)
3834                                         break;
3835                         if (i == mc->mc_top) {
3836                                 /* There are no other pages */
3837                                 mc->mc_ki[mc->mc_top] = nkeys;
3838                                 return MDB_NOTFOUND;
3839                         }
3840                 }
3841                 if (!mc->mc_top) {
3842                         /* There are no other pages */
3843                         mc->mc_ki[mc->mc_top] = 0;
3844                         return MDB_NOTFOUND;
3845                 }
3846         }
3847
3848         rc = mdb_page_search(mc, key, 0);
3849         if (rc != MDB_SUCCESS)
3850                 return rc;
3851
3852         mp = mc->mc_pg[mc->mc_top];
3853         assert(IS_LEAF(mp));
3854
3855 set2:
3856         leaf = mdb_node_search(mc, key, exactp);
3857         if (exactp != NULL && !*exactp) {
3858                 /* MDB_SET specified and not an exact match. */
3859                 return MDB_NOTFOUND;
3860         }
3861
3862         if (leaf == NULL) {
3863                 DPUTS("===> inexact leaf not found, goto sibling");
3864                 if ((rc = mdb_cursor_sibling(mc, 1)) != MDB_SUCCESS)
3865                         return rc;              /* no entries matched */
3866                 mp = mc->mc_pg[mc->mc_top];
3867                 assert(IS_LEAF(mp));
3868                 leaf = NODEPTR(mp, 0);
3869         }
3870
3871 set1:
3872         mc->mc_flags |= C_INITIALIZED;
3873         mc->mc_flags &= ~C_EOF;
3874
3875         if (IS_LEAF2(mp)) {
3876                 key->mv_size = mc->mc_db->md_pad;
3877                 key->mv_data = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], key->mv_size);
3878                 return MDB_SUCCESS;
3879         }
3880
3881         if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3882                 mdb_xcursor_init1(mc, leaf);
3883         }
3884         if (data) {
3885                 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3886                         if (op == MDB_SET || op == MDB_SET_RANGE) {
3887                                 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
3888                         } else {
3889                                 int ex2, *ex2p;
3890                                 if (op == MDB_GET_BOTH) {
3891                                         ex2p = &ex2;
3892                                         ex2 = 0;
3893                                 } else {
3894                                         ex2p = NULL;
3895                                 }
3896                                 rc = mdb_cursor_set(&mc->mc_xcursor->mx_cursor, data, NULL, MDB_SET_RANGE, ex2p);
3897                                 if (rc != MDB_SUCCESS)
3898                                         return rc;
3899                         }
3900                 } else if (op == MDB_GET_BOTH || op == MDB_GET_BOTH_RANGE) {
3901                         MDB_val d2;
3902                         if ((rc = mdb_node_read(mc->mc_txn, leaf, &d2)) != MDB_SUCCESS)
3903                                 return rc;
3904                         rc = mc->mc_dbx->md_dcmp(data, &d2);
3905                         if (rc) {
3906                                 if (op == MDB_GET_BOTH || rc > 0)
3907                                         return MDB_NOTFOUND;
3908                         }
3909
3910                 } else {
3911                         if (mc->mc_xcursor)
3912                                 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
3913                         if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
3914                                 return rc;
3915                 }
3916         }
3917
3918         /* The key already matches in all other cases */
3919         if (op == MDB_SET_RANGE)
3920                 MDB_SET_KEY(leaf, key);
3921         DPRINTF("==> cursor placed on key [%s]", DKEY(key));
3922
3923         return rc;
3924 }
3925
3926 /** Move the cursor to the first item in the database. */
3927 static int
3928 mdb_cursor_first(MDB_cursor *mc, MDB_val *key, MDB_val *data)
3929 {
3930         int              rc;
3931         MDB_node        *leaf;
3932
3933         if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
3934                 rc = mdb_page_search(mc, NULL, 0);
3935                 if (rc != MDB_SUCCESS)
3936                         return rc;
3937         }
3938         assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
3939
3940         leaf = NODEPTR(mc->mc_pg[mc->mc_top], 0);
3941         mc->mc_flags |= C_INITIALIZED;
3942         mc->mc_flags &= ~C_EOF;
3943
3944         mc->mc_ki[mc->mc_top] = 0;
3945
3946         if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
3947                 key->mv_size = mc->mc_db->md_pad;
3948                 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], 0, key->mv_size);
3949                 return MDB_SUCCESS;
3950         }
3951
3952         if (data) {
3953                 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
3954                         mdb_xcursor_init1(mc, leaf);
3955                         rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
3956                         if (rc)
3957                                 return rc;
3958                 } else {
3959                         if (mc->mc_xcursor)
3960                                 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
3961                         if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
3962                                 return rc;
3963                 }
3964         }
3965         MDB_SET_KEY(leaf, key);
3966         return MDB_SUCCESS;
3967 }
3968
3969 /** Move the cursor to the last item in the database. */
3970 static int
3971 mdb_cursor_last(MDB_cursor *mc, MDB_val *key, MDB_val *data)
3972 {
3973         int              rc;
3974         MDB_node        *leaf;
3975         MDB_val lkey;
3976
3977         lkey.mv_size = MAXKEYSIZE+1;
3978         lkey.mv_data = NULL;
3979
3980         if (!(mc->mc_flags & C_INITIALIZED) || mc->mc_top) {
3981                 rc = mdb_page_search(mc, &lkey, 0);
3982                 if (rc != MDB_SUCCESS)
3983                         return rc;
3984         }
3985         assert(IS_LEAF(mc->mc_pg[mc->mc_top]));
3986
3987         leaf = NODEPTR(mc->mc_pg[mc->mc_top], NUMKEYS(mc->mc_pg[mc->mc_top])-1);
3988         mc->mc_flags |= C_INITIALIZED;
3989         mc->mc_flags &= ~C_EOF;
3990
3991         mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]) - 1;
3992
3993         if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
3994                 key->mv_size = mc->mc_db->md_pad;
3995                 key->mv_data = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], key->mv_size);
3996                 return MDB_SUCCESS;
3997         }
3998
3999         if (data) {
4000                 if (F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4001                         mdb_xcursor_init1(mc, leaf);
4002                         rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4003                         if (rc)
4004                                 return rc;
4005                 } else {
4006                         if (mc->mc_xcursor)
4007                                 mc->mc_xcursor->mx_cursor.mc_flags &= ~C_INITIALIZED;
4008                         if ((rc = mdb_node_read(mc->mc_txn, leaf, data)) != MDB_SUCCESS)
4009                                 return rc;
4010                 }
4011         }
4012
4013         MDB_SET_KEY(leaf, key);
4014         return MDB_SUCCESS;
4015 }
4016
4017 int
4018 mdb_cursor_get(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4019     MDB_cursor_op op)
4020 {
4021         int              rc;
4022         int              exact = 0;
4023
4024         assert(mc);
4025
4026         switch (op) {
4027         case MDB_GET_BOTH:
4028         case MDB_GET_BOTH_RANGE:
4029                 if (data == NULL || mc->mc_xcursor == NULL) {
4030                         rc = EINVAL;
4031                         break;
4032                 }
4033                 /* FALLTHRU */
4034         case MDB_SET:
4035         case MDB_SET_RANGE:
4036                 if (key == NULL || key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
4037                         rc = EINVAL;
4038                 } else if (op == MDB_SET_RANGE)
4039                         rc = mdb_cursor_set(mc, key, data, op, NULL);
4040                 else
4041                         rc = mdb_cursor_set(mc, key, data, op, &exact);
4042                 break;
4043         case MDB_GET_MULTIPLE:
4044                 if (data == NULL ||
4045                         !(mc->mc_db->md_flags & MDB_DUPFIXED) ||
4046                         !(mc->mc_flags & C_INITIALIZED)) {
4047                         rc = EINVAL;
4048                         break;
4049                 }
4050                 rc = MDB_SUCCESS;
4051                 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) ||
4052                         (mc->mc_xcursor->mx_cursor.mc_flags & C_EOF))
4053                         break;
4054                 goto fetchm;
4055         case MDB_NEXT_MULTIPLE:
4056                 if (data == NULL ||
4057                         !(mc->mc_db->md_flags & MDB_DUPFIXED)) {
4058                         rc = EINVAL;
4059                         break;
4060                 }
4061                 if (!(mc->mc_flags & C_INITIALIZED))
4062                         rc = mdb_cursor_first(mc, key, data);
4063                 else
4064                         rc = mdb_cursor_next(mc, key, data, MDB_NEXT_DUP);
4065                 if (rc == MDB_SUCCESS) {
4066                         if (mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED) {
4067                                 MDB_cursor *mx;
4068 fetchm:
4069                                 mx = &mc->mc_xcursor->mx_cursor;
4070                                 data->mv_size = NUMKEYS(mx->mc_pg[mx->mc_top]) *
4071                                         mx->mc_db->md_pad;
4072                                 data->mv_data = METADATA(mx->mc_pg[mx->mc_top]);
4073                                 mx->mc_ki[mx->mc_top] = NUMKEYS(mx->mc_pg[mx->mc_top])-1;
4074                         } else {
4075                                 rc = MDB_NOTFOUND;
4076                         }
4077                 }
4078                 break;
4079         case MDB_NEXT:
4080         case MDB_NEXT_DUP:
4081         case MDB_NEXT_NODUP:
4082                 if (!(mc->mc_flags & C_INITIALIZED))
4083                         rc = mdb_cursor_first(mc, key, data);
4084                 else
4085                         rc = mdb_cursor_next(mc, key, data, op);
4086                 break;
4087         case MDB_PREV:
4088         case MDB_PREV_DUP:
4089         case MDB_PREV_NODUP:
4090                 if (!(mc->mc_flags & C_INITIALIZED) || (mc->mc_flags & C_EOF))
4091                         rc = mdb_cursor_last(mc, key, data);
4092                 else
4093                         rc = mdb_cursor_prev(mc, key, data, op);
4094                 break;
4095         case MDB_FIRST:
4096                 rc = mdb_cursor_first(mc, key, data);
4097                 break;
4098         case MDB_FIRST_DUP:
4099                 if (data == NULL ||
4100                         !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4101                         !(mc->mc_flags & C_INITIALIZED) ||
4102                         !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4103                         rc = EINVAL;
4104                         break;
4105                 }
4106                 rc = mdb_cursor_first(&mc->mc_xcursor->mx_cursor, data, NULL);
4107                 break;
4108         case MDB_LAST:
4109                 rc = mdb_cursor_last(mc, key, data);
4110                 break;
4111         case MDB_LAST_DUP:
4112                 if (data == NULL ||
4113                         !(mc->mc_db->md_flags & MDB_DUPSORT) ||
4114                         !(mc->mc_flags & C_INITIALIZED) ||
4115                         !(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED)) {
4116                         rc = EINVAL;
4117                         break;
4118                 }
4119                 rc = mdb_cursor_last(&mc->mc_xcursor->mx_cursor, data, NULL);
4120                 break;
4121         default:
4122                 DPRINTF("unhandled/unimplemented cursor operation %u", op);
4123                 rc = EINVAL;
4124                 break;
4125         }
4126
4127         return rc;
4128 }
4129
4130 /** Touch all the pages in the cursor stack.
4131  *      Makes sure all the pages are writable, before attempting a write operation.
4132  * @param[in] mc The cursor to operate on.
4133  */
4134 static int
4135 mdb_cursor_touch(MDB_cursor *mc)
4136 {
4137         int rc;
4138
4139         if (mc->mc_dbi > MAIN_DBI && !(*mc->mc_dbflag & DB_DIRTY)) {
4140                 MDB_cursor mc2;
4141                 mdb_cursor_init(&mc2, mc->mc_txn, MAIN_DBI, NULL);
4142                 rc = mdb_page_search(&mc2, &mc->mc_dbx->md_name, 1);
4143                 if (rc)
4144                          return rc;
4145                 *mc->mc_dbflag = DB_DIRTY;
4146         }
4147         for (mc->mc_top = 0; mc->mc_top < mc->mc_snum; mc->mc_top++) {
4148                 rc = mdb_page_touch(mc);
4149                 if (rc)
4150                         return rc;
4151         }
4152         mc->mc_top = mc->mc_snum-1;
4153         return MDB_SUCCESS;
4154 }
4155
4156 int
4157 mdb_cursor_put(MDB_cursor *mc, MDB_val *key, MDB_val *data,
4158     unsigned int flags)
4159 {
4160         MDB_node        *leaf = NULL;
4161         MDB_val xdata, *rdata, dkey;
4162         MDB_page        *fp;
4163         MDB_db dummy;
4164         int do_sub = 0;
4165         unsigned int mcount = 0;
4166         size_t nsize;
4167         int rc, rc2;
4168         MDB_pagebuf pbuf;
4169         char dbuf[MAXKEYSIZE+1];
4170         unsigned int nflags;
4171         DKBUF;
4172
4173         if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4174                 return EACCES;
4175
4176         DPRINTF("==> put db %u key [%s], size %zu, data size %zu",
4177                 mc->mc_dbi, DKEY(key), key ? key->mv_size:0, data->mv_size);
4178
4179         dkey.mv_size = 0;
4180
4181         if (flags == MDB_CURRENT) {
4182                 if (!(mc->mc_flags & C_INITIALIZED))
4183                         return EINVAL;
4184                 rc = MDB_SUCCESS;
4185         } else if (mc->mc_db->md_root == P_INVALID) {
4186                 MDB_page *np;
4187                 /* new database, write a root leaf page */
4188                 DPUTS("allocating new root leaf page");
4189                 if ((np = mdb_page_new(mc, P_LEAF, 1)) == NULL) {
4190                         return ENOMEM;
4191                 }
4192                 mc->mc_snum = 0;
4193                 mdb_cursor_push(mc, np);
4194                 mc->mc_db->md_root = np->mp_pgno;
4195                 mc->mc_db->md_depth++;
4196                 *mc->mc_dbflag = DB_DIRTY;
4197                 if ((mc->mc_db->md_flags & (MDB_DUPSORT|MDB_DUPFIXED))
4198                         == MDB_DUPFIXED)
4199                         np->mp_flags |= P_LEAF2;
4200                 mc->mc_flags |= C_INITIALIZED;
4201                 rc = MDB_NOTFOUND;
4202                 goto top;
4203         } else {
4204                 int exact = 0;
4205                 MDB_val d2;
4206                 rc = mdb_cursor_set(mc, key, &d2, MDB_SET, &exact);
4207                 if ((flags & MDB_NOOVERWRITE) && rc == 0) {
4208                         DPRINTF("duplicate key [%s]", DKEY(key));
4209                         *data = d2;
4210                         return MDB_KEYEXIST;
4211                 }
4212                 if (rc && rc != MDB_NOTFOUND)
4213                         return rc;
4214         }
4215
4216         /* Cursor is positioned, now make sure all pages are writable */
4217         rc2 = mdb_cursor_touch(mc);
4218         if (rc2)
4219                 return rc2;
4220
4221 top:
4222         /* The key already exists */
4223         if (rc == MDB_SUCCESS) {
4224                 /* there's only a key anyway, so this is a no-op */
4225                 if (IS_LEAF2(mc->mc_pg[mc->mc_top])) {
4226                         unsigned int ksize = mc->mc_db->md_pad;
4227                         if (key->mv_size != ksize)
4228                                 return EINVAL;
4229                         if (flags == MDB_CURRENT) {
4230                                 char *ptr = LEAF2KEY(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], ksize);
4231                                 memcpy(ptr, key->mv_data, ksize);
4232                         }
4233                         return MDB_SUCCESS;
4234                 }
4235
4236                 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4237
4238                 /* DB has dups? */
4239                 if (F_ISSET(mc->mc_db->md_flags, MDB_DUPSORT)) {
4240                         /* Was a single item before, must convert now */
4241 more:
4242                         if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4243                                 /* Just overwrite the current item */
4244                                 if (flags == MDB_CURRENT)
4245                                         goto current;
4246
4247                                 dkey.mv_size = NODEDSZ(leaf);
4248                                 dkey.mv_data = NODEDATA(leaf);
4249 #if UINT_MAX < SIZE_MAX
4250                                 if (mc->mc_dbx->md_dcmp == mdb_cmp_int && dkey.mv_size == sizeof(size_t))
4251 #ifdef MISALIGNED_OK
4252                                         mc->mc_dbx->md_dcmp = mdb_cmp_long;
4253 #else
4254                                         mc->mc_dbx->md_dcmp = mdb_cmp_cint;
4255 #endif
4256 #endif
4257                                 /* if data matches, ignore it */
4258                                 if (!mc->mc_dbx->md_dcmp(data, &dkey))
4259                                         return (flags == MDB_NODUPDATA) ? MDB_KEYEXIST : MDB_SUCCESS;
4260
4261                                 /* create a fake page for the dup items */
4262                                 memcpy(dbuf, dkey.mv_data, dkey.mv_size);
4263                                 dkey.mv_data = dbuf;
4264                                 fp = (MDB_page *)&pbuf;
4265                                 fp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
4266                                 fp->mp_flags = P_LEAF|P_DIRTY|P_SUBP;
4267                                 fp->mp_lower = PAGEHDRSZ;
4268                                 fp->mp_upper = PAGEHDRSZ + dkey.mv_size + data->mv_size;
4269                                 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
4270                                         fp->mp_flags |= P_LEAF2;
4271                                         fp->mp_pad = data->mv_size;
4272                                 } else {
4273                                         fp->mp_upper += 2 * sizeof(indx_t) + 2 * NODESIZE +
4274                                                 (dkey.mv_size & 1) + (data->mv_size & 1);
4275                                 }
4276                                 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
4277                                 do_sub = 1;
4278                                 rdata = &xdata;
4279                                 xdata.mv_size = fp->mp_upper;
4280                                 xdata.mv_data = fp;
4281                                 flags |= F_DUPDATA;
4282                                 goto new_sub;
4283                         }
4284                         if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
4285                                 /* See if we need to convert from fake page to subDB */
4286                                 MDB_page *mp;
4287                                 unsigned int offset;
4288                                 unsigned int i;
4289
4290                                 fp = NODEDATA(leaf);
4291                                 if (flags == MDB_CURRENT) {
4292                                         fp->mp_flags |= P_DIRTY;
4293                                         COPY_PGNO(fp->mp_pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
4294                                         mc->mc_xcursor->mx_cursor.mc_pg[0] = fp;
4295                                         flags |= F_DUPDATA;
4296                                         goto put_sub;
4297                                 }
4298                                 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
4299                                         offset = fp->mp_pad;
4300                                 } else {
4301                                         offset = NODESIZE + sizeof(indx_t) + data->mv_size;
4302                                 }
4303                                 offset += offset & 1;
4304                                 if (NODESIZE + sizeof(indx_t) + NODEKSZ(leaf) + NODEDSZ(leaf) +
4305                                         offset >= (mc->mc_txn->mt_env->me_psize - PAGEHDRSZ) /
4306                                                 MDB_MINKEYS) {
4307                                         /* yes, convert it */
4308                                         dummy.md_flags = 0;
4309                                         if (mc->mc_db->md_flags & MDB_DUPFIXED) {
4310                                                 dummy.md_pad = fp->mp_pad;
4311                                                 dummy.md_flags = MDB_DUPFIXED;
4312                                                 if (mc->mc_db->md_flags & MDB_INTEGERDUP)
4313                                                         dummy.md_flags |= MDB_INTEGERKEY;
4314                                         }
4315                                         dummy.md_depth = 1;
4316                                         dummy.md_branch_pages = 0;
4317                                         dummy.md_leaf_pages = 1;
4318                                         dummy.md_overflow_pages = 0;
4319                                         dummy.md_entries = NUMKEYS(fp);
4320                                         rdata = &xdata;
4321                                         xdata.mv_size = sizeof(MDB_db);
4322                                         xdata.mv_data = &dummy;
4323                                         mp = mdb_page_alloc(mc, 1);
4324                                         if (!mp)
4325                                                 return ENOMEM;
4326                                         offset = mc->mc_txn->mt_env->me_psize - NODEDSZ(leaf);
4327                                         flags |= F_DUPDATA|F_SUBDATA;
4328                                         dummy.md_root = mp->mp_pgno;
4329                                 } else {
4330                                         /* no, just grow it */
4331                                         rdata = &xdata;
4332                                         xdata.mv_size = NODEDSZ(leaf) + offset;
4333                                         xdata.mv_data = &pbuf;
4334                                         mp = (MDB_page *)&pbuf;
4335                                         mp->mp_pgno = mc->mc_pg[mc->mc_top]->mp_pgno;
4336                                         flags |= F_DUPDATA;
4337                                 }
4338                                 mp->mp_flags = fp->mp_flags | P_DIRTY;
4339                                 mp->mp_pad   = fp->mp_pad;
4340                                 mp->mp_lower = fp->mp_lower;
4341                                 mp->mp_upper = fp->mp_upper + offset;
4342                                 if (IS_LEAF2(fp)) {
4343                                         memcpy(METADATA(mp), METADATA(fp), NUMKEYS(fp) * fp->mp_pad);
4344                                 } else {
4345                                         nsize = NODEDSZ(leaf) - fp->mp_upper;
4346                                         memcpy((char *)mp + mp->mp_upper, (char *)fp + fp->mp_upper, nsize);
4347                                         for (i=0; i<NUMKEYS(fp); i++)
4348                                                 mp->mp_ptrs[i] = fp->mp_ptrs[i] + offset;
4349                                 }
4350                                 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
4351                                 do_sub = 1;
4352                                 goto new_sub;
4353                         }
4354                         /* data is on sub-DB, just store it */
4355                         flags |= F_DUPDATA|F_SUBDATA;
4356                         goto put_sub;
4357                 }
4358 current:
4359                 /* overflow page overwrites need special handling */
4360                 if (F_ISSET(leaf->mn_flags, F_BIGDATA)) {
4361                         MDB_page *omp;
4362                         pgno_t pg;
4363                         int ovpages, dpages;
4364
4365                         ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
4366                         dpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
4367                         memcpy(&pg, NODEDATA(leaf), sizeof(pg));
4368                         mdb_page_get(mc->mc_txn, pg, &omp);
4369                         /* Is the ov page writable and large enough? */
4370                         if ((omp->mp_flags & P_DIRTY) && ovpages >= dpages) {
4371                                 /* yes, overwrite it. Note in this case we don't
4372                                  * bother to try shrinking the node if the new data
4373                                  * is smaller than the overflow threshold.
4374                                  */
4375                                 if (F_ISSET(flags, MDB_RESERVE))
4376                                         data->mv_data = METADATA(omp);
4377                                 else
4378                                         memcpy(METADATA(omp), data->mv_data, data->mv_size);
4379                                 goto done;
4380                         } else {
4381                                 /* no, free ovpages */
4382                                 int i;
4383                                 mc->mc_db->md_overflow_pages -= ovpages;
4384                                 for (i=0; i<ovpages; i++) {
4385                                         DPRINTF("freed ov page %zu", pg);
4386                                         mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
4387                                         pg++;
4388                                 }
4389                         }
4390                 } else if (NODEDSZ(leaf) == data->mv_size) {
4391                         /* same size, just replace it. Note that we could
4392                          * also reuse this node if the new data is smaller,
4393                          * but instead we opt to shrink the node in that case.
4394                          */
4395                         if (F_ISSET(flags, MDB_RESERVE))
4396                                 data->mv_data = NODEDATA(leaf);
4397                         else
4398                                 memcpy(NODEDATA(leaf), data->mv_data, data->mv_size);
4399                         goto done;
4400                 }
4401                 mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], 0);
4402                 mc->mc_db->md_entries--;
4403         } else {
4404                 DPRINTF("inserting key at index %i", mc->mc_ki[mc->mc_top]);
4405         }
4406
4407         rdata = data;
4408
4409 new_sub:
4410         nflags = flags & NODE_ADD_FLAGS;
4411         nsize = IS_LEAF2(mc->mc_pg[mc->mc_top]) ? key->mv_size : mdb_leaf_size(mc->mc_txn->mt_env, key, rdata);
4412         if (SIZELEFT(mc->mc_pg[mc->mc_top]) < nsize) {
4413                 if (( flags & (F_DUPDATA|F_SUBDATA)) == F_DUPDATA )
4414                         nflags &= ~MDB_APPEND;
4415                 rc = mdb_page_split(mc, key, rdata, P_INVALID, nflags);
4416         } else {
4417                 /* There is room already in this leaf page. */
4418                 rc = mdb_node_add(mc, mc->mc_ki[mc->mc_top], key, rdata, 0, nflags);
4419                 if (rc == 0 && !do_sub) {
4420                         /* Adjust other cursors pointing to mp */
4421                         MDB_cursor *m2, *m3;
4422                         MDB_dbi dbi = mc->mc_dbi;
4423                         unsigned i = mc->mc_top;
4424                         MDB_page *mp = mc->mc_pg[i];
4425
4426                         if (mc->mc_flags & C_SUB)
4427                                 dbi--;
4428
4429                         for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
4430                                 if (mc->mc_flags & C_SUB)
4431                                         m3 = &m2->mc_xcursor->mx_cursor;
4432                                 else
4433                                         m3 = m2;
4434                                 if (m3 == mc || m3->mc_snum < mc->mc_snum) continue;
4435                                 if (m3->mc_pg[i] == mp && m3->mc_ki[i] >= mc->mc_ki[i]) {
4436                                         m3->mc_ki[i]++;
4437                                 }
4438                         }
4439                 }
4440         }
4441
4442         if (rc != MDB_SUCCESS)
4443                 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
4444         else {
4445                 /* Now store the actual data in the child DB. Note that we're
4446                  * storing the user data in the keys field, so there are strict
4447                  * size limits on dupdata. The actual data fields of the child
4448                  * DB are all zero size.
4449                  */
4450                 if (do_sub) {
4451                         int xflags;
4452 put_sub:
4453                         xdata.mv_size = 0;
4454                         xdata.mv_data = "";
4455                         leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4456                         if (flags & MDB_CURRENT) {
4457                                 xflags = MDB_CURRENT;
4458                         } else {
4459                                 mdb_xcursor_init1(mc, leaf);
4460                                 xflags = (flags & MDB_NODUPDATA) ? MDB_NOOVERWRITE : 0;
4461                         }
4462                         /* converted, write the original data first */
4463                         if (dkey.mv_size) {
4464                                 rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, &dkey, &xdata, xflags);
4465                                 if (rc)
4466                                         return rc;
4467                                 {
4468                                         /* Adjust other cursors pointing to mp */
4469                                         MDB_cursor *m2;
4470                                         unsigned i = mc->mc_top;
4471                                         MDB_page *mp = mc->mc_pg[i];
4472
4473                                         for (m2 = mc->mc_txn->mt_cursors[mc->mc_dbi]; m2; m2=m2->mc_next) {
4474                                                 if (m2 == mc || m2->mc_snum < mc->mc_snum) continue;
4475                                                 if (m2->mc_pg[i] == mp && m2->mc_ki[i] == mc->mc_ki[i]) {
4476                                                         mdb_xcursor_init1(m2, leaf);
4477                                                 }
4478                                         }
4479                                 }
4480                         }
4481                         xflags |= (flags & MDB_APPEND);
4482                         rc = mdb_cursor_put(&mc->mc_xcursor->mx_cursor, data, &xdata, xflags);
4483                         if (flags & F_SUBDATA) {
4484                                 void *db = NODEDATA(leaf);
4485                                 memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
4486                         }
4487                 }
4488                 /* sub-writes might have failed so check rc again.
4489                  * Don't increment count if we just replaced an existing item.
4490                  */
4491                 if (!rc && !(flags & MDB_CURRENT))
4492                         mc->mc_db->md_entries++;
4493                 if (flags & MDB_MULTIPLE) {
4494                         mcount++;
4495                         if (mcount < data[1].mv_size) {
4496                                 data[0].mv_data = (char *)data[0].mv_data + data[0].mv_size;
4497                                 leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4498                                 goto more;
4499                         }
4500                 }
4501         }
4502 done:
4503         return rc;
4504 }
4505
4506 int
4507 mdb_cursor_del(MDB_cursor *mc, unsigned int flags)
4508 {
4509         MDB_node        *leaf;
4510         int rc;
4511
4512         if (F_ISSET(mc->mc_txn->mt_flags, MDB_TXN_RDONLY))
4513                 return EACCES;
4514
4515         if (!mc->mc_flags & C_INITIALIZED)
4516                 return EINVAL;
4517
4518         rc = mdb_cursor_touch(mc);
4519         if (rc)
4520                 return rc;
4521
4522         leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4523
4524         if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_DUPDATA)) {
4525                 if (flags != MDB_NODUPDATA) {
4526                         if (!F_ISSET(leaf->mn_flags, F_SUBDATA)) {
4527                                 mc->mc_xcursor->mx_cursor.mc_pg[0] = NODEDATA(leaf);
4528                         }
4529                         rc = mdb_cursor_del(&mc->mc_xcursor->mx_cursor, 0);
4530                         /* If sub-DB still has entries, we're done */
4531                         if (mc->mc_xcursor->mx_db.md_entries) {
4532                                 if (leaf->mn_flags & F_SUBDATA) {
4533                                         /* update subDB info */
4534                                         void *db = NODEDATA(leaf);
4535                                         memcpy(db, &mc->mc_xcursor->mx_db, sizeof(MDB_db));
4536                                 } else {
4537                                         /* shrink fake page */
4538                                         mdb_node_shrink(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
4539                                 }
4540                                 mc->mc_db->md_entries--;
4541                                 return rc;
4542                         }
4543                         /* otherwise fall thru and delete the sub-DB */
4544                 }
4545
4546                 if (leaf->mn_flags & F_SUBDATA) {
4547                         /* add all the child DB's pages to the free list */
4548                         rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
4549                         if (rc == MDB_SUCCESS) {
4550                                 mc->mc_db->md_entries -=
4551                                         mc->mc_xcursor->mx_db.md_entries;
4552                         }
4553                 }
4554         }
4555
4556         return mdb_cursor_del0(mc, leaf);
4557 }
4558
4559 /** Allocate and initialize new pages for a database.
4560  * @param[in] mc a cursor on the database being added to.
4561  * @param[in] flags flags defining what type of page is being allocated.
4562  * @param[in] num the number of pages to allocate. This is usually 1,
4563  * unless allocating overflow pages for a large record.
4564  * @return Address of a page, or NULL on failure.
4565  */
4566 static MDB_page *
4567 mdb_page_new(MDB_cursor *mc, uint32_t flags, int num)
4568 {
4569         MDB_page        *np;
4570
4571         if ((np = mdb_page_alloc(mc, num)) == NULL)
4572                 return NULL;
4573         DPRINTF("allocated new mpage %zu, page size %u",
4574             np->mp_pgno, mc->mc_txn->mt_env->me_psize);
4575         np->mp_flags = flags | P_DIRTY;
4576         np->mp_lower = PAGEHDRSZ;
4577         np->mp_upper = mc->mc_txn->mt_env->me_psize;
4578
4579         if (IS_BRANCH(np))
4580                 mc->mc_db->md_branch_pages++;
4581         else if (IS_LEAF(np))
4582                 mc->mc_db->md_leaf_pages++;
4583         else if (IS_OVERFLOW(np)) {
4584                 mc->mc_db->md_overflow_pages += num;
4585                 np->mp_pages = num;
4586         }
4587
4588         return np;
4589 }
4590
4591 /** Calculate the size of a leaf node.
4592  * The size depends on the environment's page size; if a data item
4593  * is too large it will be put onto an overflow page and the node
4594  * size will only include the key and not the data. Sizes are always
4595  * rounded up to an even number of bytes, to guarantee 2-byte alignment
4596  * of the #MDB_node headers.
4597  * @param[in] env The environment handle.
4598  * @param[in] key The key for the node.
4599  * @param[in] data The data for the node.
4600  * @return The number of bytes needed to store the node.
4601  */
4602 static size_t
4603 mdb_leaf_size(MDB_env *env, MDB_val *key, MDB_val *data)
4604 {
4605         size_t           sz;
4606
4607         sz = LEAFSIZE(key, data);
4608         if (sz >= env->me_psize / MDB_MINKEYS) {
4609                 /* put on overflow page */
4610                 sz -= data->mv_size - sizeof(pgno_t);
4611         }
4612         sz += sz & 1;
4613
4614         return sz + sizeof(indx_t);
4615 }
4616
4617 /** Calculate the size of a branch node.
4618  * The size should depend on the environment's page size but since
4619  * we currently don't support spilling large keys onto overflow
4620  * pages, it's simply the size of the #MDB_node header plus the
4621  * size of the key. Sizes are always rounded up to an even number
4622  * of bytes, to guarantee 2-byte alignment of the #MDB_node headers.
4623  * @param[in] env The environment handle.
4624  * @param[in] key The key for the node.
4625  * @return The number of bytes needed to store the node.
4626  */
4627 static size_t
4628 mdb_branch_size(MDB_env *env, MDB_val *key)
4629 {
4630         size_t           sz;
4631
4632         sz = INDXSIZE(key);
4633         if (sz >= env->me_psize / MDB_MINKEYS) {
4634                 /* put on overflow page */
4635                 /* not implemented */
4636                 /* sz -= key->size - sizeof(pgno_t); */
4637         }
4638
4639         return sz + sizeof(indx_t);
4640 }
4641
4642 /** Add a node to the page pointed to by the cursor.
4643  * @param[in] mc The cursor for this operation.
4644  * @param[in] indx The index on the page where the new node should be added.
4645  * @param[in] key The key for the new node.
4646  * @param[in] data The data for the new node, if any.
4647  * @param[in] pgno The page number, if adding a branch node.
4648  * @param[in] flags Flags for the node.
4649  * @return 0 on success, non-zero on failure. Possible errors are:
4650  * <ul>
4651  *      <li>ENOMEM - failed to allocate overflow pages for the node.
4652  *      <li>ENOSPC - there is insufficient room in the page. This error
4653  *      should never happen since all callers already calculate the
4654  *      page's free space before calling this function.
4655  * </ul>
4656  */
4657 static int
4658 mdb_node_add(MDB_cursor *mc, indx_t indx,
4659     MDB_val *key, MDB_val *data, pgno_t pgno, unsigned int flags)
4660 {
4661         unsigned int     i;
4662         size_t           node_size = NODESIZE;
4663         indx_t           ofs;
4664         MDB_node        *node;
4665         MDB_page        *mp = mc->mc_pg[mc->mc_top];
4666         MDB_page        *ofp = NULL;            /* overflow page */
4667         DKBUF;
4668
4669         assert(mp->mp_upper >= mp->mp_lower);
4670
4671         DPRINTF("add to %s %spage %zu index %i, data size %zu key size %zu [%s]",
4672             IS_LEAF(mp) ? "leaf" : "branch",
4673                 IS_SUBP(mp) ? "sub-" : "",
4674             mp->mp_pgno, indx, data ? data->mv_size : 0,
4675                 key ? key->mv_size : 0, key ? DKEY(key) : NULL);
4676
4677         if (IS_LEAF2(mp)) {
4678                 /* Move higher keys up one slot. */
4679                 int ksize = mc->mc_db->md_pad, dif;
4680                 char *ptr = LEAF2KEY(mp, indx, ksize);
4681                 dif = NUMKEYS(mp) - indx;
4682                 if (dif > 0)
4683                         memmove(ptr+ksize, ptr, dif*ksize);
4684                 /* insert new key */
4685                 memcpy(ptr, key->mv_data, ksize);
4686
4687                 /* Just using these for counting */
4688                 mp->mp_lower += sizeof(indx_t);
4689                 mp->mp_upper -= ksize - sizeof(indx_t);
4690                 return MDB_SUCCESS;
4691         }
4692
4693         if (key != NULL)
4694                 node_size += key->mv_size;
4695
4696         if (IS_LEAF(mp)) {
4697                 assert(data);
4698                 if (F_ISSET(flags, F_BIGDATA)) {
4699                         /* Data already on overflow page. */
4700                         node_size += sizeof(pgno_t);
4701                 } else if (node_size + data->mv_size >= mc->mc_txn->mt_env->me_psize / MDB_MINKEYS) {
4702                         int ovpages = OVPAGES(data->mv_size, mc->mc_txn->mt_env->me_psize);
4703                         /* Put data on overflow page. */
4704                         DPRINTF("data size is %zu, node would be %zu, put data on overflow page",
4705                             data->mv_size, node_size+data->mv_size);
4706                         node_size += sizeof(pgno_t);
4707                         if ((ofp = mdb_page_new(mc, P_OVERFLOW, ovpages)) == NULL)
4708                                 return ENOMEM;
4709                         DPRINTF("allocated overflow page %zu", ofp->mp_pgno);
4710                         flags |= F_BIGDATA;
4711                 } else {
4712                         node_size += data->mv_size;
4713                 }
4714         }
4715         node_size += node_size & 1;
4716
4717         if (node_size + sizeof(indx_t) > SIZELEFT(mp)) {
4718                 DPRINTF("not enough room in page %zu, got %u ptrs",
4719                     mp->mp_pgno, NUMKEYS(mp));
4720                 DPRINTF("upper - lower = %u - %u = %u", mp->mp_upper, mp->mp_lower,
4721                     mp->mp_upper - mp->mp_lower);
4722                 DPRINTF("node size = %zu", node_size);
4723                 return ENOSPC;
4724         }
4725
4726         /* Move higher pointers up one slot. */
4727         for (i = NUMKEYS(mp); i > indx; i--)
4728                 mp->mp_ptrs[i] = mp->mp_ptrs[i - 1];
4729
4730         /* Adjust free space offsets. */
4731         ofs = mp->mp_upper - node_size;
4732         assert(ofs >= mp->mp_lower + sizeof(indx_t));
4733         mp->mp_ptrs[indx] = ofs;
4734         mp->mp_upper = ofs;
4735         mp->mp_lower += sizeof(indx_t);
4736
4737         /* Write the node data. */
4738         node = NODEPTR(mp, indx);
4739         node->mn_ksize = (key == NULL) ? 0 : key->mv_size;
4740         node->mn_flags = flags;
4741         if (IS_LEAF(mp))
4742                 SETDSZ(node,data->mv_size);
4743         else
4744                 SETPGNO(node,pgno);
4745
4746         if (key)
4747                 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
4748
4749         if (IS_LEAF(mp)) {
4750                 assert(key);
4751                 if (ofp == NULL) {
4752                         if (F_ISSET(flags, F_BIGDATA))
4753                                 memcpy(node->mn_data + key->mv_size, data->mv_data,
4754                                     sizeof(pgno_t));
4755                         else if (F_ISSET(flags, MDB_RESERVE))
4756                                 data->mv_data = node->mn_data + key->mv_size;
4757                         else
4758                                 memcpy(node->mn_data + key->mv_size, data->mv_data,
4759                                     data->mv_size);
4760                 } else {
4761                         memcpy(node->mn_data + key->mv_size, &ofp->mp_pgno,
4762                             sizeof(pgno_t));
4763                         if (F_ISSET(flags, MDB_RESERVE))
4764                                 data->mv_data = METADATA(ofp);
4765                         else
4766                                 memcpy(METADATA(ofp), data->mv_data, data->mv_size);
4767                 }
4768         }
4769
4770         return MDB_SUCCESS;
4771 }
4772
4773 /** Delete the specified node from a page.
4774  * @param[in] mp The page to operate on.
4775  * @param[in] indx The index of the node to delete.
4776  * @param[in] ksize The size of a node. Only used if the page is
4777  * part of a #MDB_DUPFIXED database.
4778  */
4779 static void
4780 mdb_node_del(MDB_page *mp, indx_t indx, int ksize)
4781 {
4782         unsigned int     sz;
4783         indx_t           i, j, numkeys, ptr;
4784         MDB_node        *node;
4785         char            *base;
4786
4787 #if MDB_DEBUG
4788         {
4789         pgno_t pgno;
4790         COPY_PGNO(pgno, mp->mp_pgno);
4791         DPRINTF("delete node %u on %s page %zu", indx,
4792             IS_LEAF(mp) ? "leaf" : "branch", pgno);
4793         }
4794 #endif
4795         assert(indx < NUMKEYS(mp));
4796
4797         if (IS_LEAF2(mp)) {
4798                 int x = NUMKEYS(mp) - 1 - indx;
4799                 base = LEAF2KEY(mp, indx, ksize);
4800                 if (x)
4801                         memmove(base, base + ksize, x * ksize);
4802                 mp->mp_lower -= sizeof(indx_t);
4803                 mp->mp_upper += ksize - sizeof(indx_t);
4804                 return;
4805         }
4806
4807         node = NODEPTR(mp, indx);
4808         sz = NODESIZE + node->mn_ksize;
4809         if (IS_LEAF(mp)) {
4810                 if (F_ISSET(node->mn_flags, F_BIGDATA))
4811                         sz += sizeof(pgno_t);
4812                 else
4813                         sz += NODEDSZ(node);
4814         }
4815         sz += sz & 1;
4816
4817         ptr = mp->mp_ptrs[indx];
4818         numkeys = NUMKEYS(mp);
4819         for (i = j = 0; i < numkeys; i++) {
4820                 if (i != indx) {
4821                         mp->mp_ptrs[j] = mp->mp_ptrs[i];
4822                         if (mp->mp_ptrs[i] < ptr)
4823                                 mp->mp_ptrs[j] += sz;
4824                         j++;
4825                 }
4826         }
4827
4828         base = (char *)mp + mp->mp_upper;
4829         memmove(base + sz, base, ptr - mp->mp_upper);
4830
4831         mp->mp_lower -= sizeof(indx_t);
4832         mp->mp_upper += sz;
4833 }
4834
4835 /** Compact the main page after deleting a node on a subpage.
4836  * @param[in] mp The main page to operate on.
4837  * @param[in] indx The index of the subpage on the main page.
4838  */
4839 static void
4840 mdb_node_shrink(MDB_page *mp, indx_t indx)
4841 {
4842         MDB_node *node;
4843         MDB_page *sp, *xp;
4844         char *base;
4845         int osize, nsize;
4846         int delta;
4847         indx_t           i, numkeys, ptr;
4848
4849         node = NODEPTR(mp, indx);
4850         sp = (MDB_page *)NODEDATA(node);
4851         osize = NODEDSZ(node);
4852
4853         delta = sp->mp_upper - sp->mp_lower;
4854         SETDSZ(node, osize - delta);
4855         xp = (MDB_page *)((char *)sp + delta);
4856
4857         /* shift subpage upward */
4858         if (IS_LEAF2(sp)) {
4859                 nsize = NUMKEYS(sp) * sp->mp_pad;
4860                 memmove(METADATA(xp), METADATA(sp), nsize);
4861         } else {
4862                 int i;
4863                 nsize = osize - sp->mp_upper;
4864                 numkeys = NUMKEYS(sp);
4865                 for (i=numkeys-1; i>=0; i--)
4866                         xp->mp_ptrs[i] = sp->mp_ptrs[i] - delta;
4867         }
4868         xp->mp_upper = sp->mp_lower;
4869         xp->mp_lower = sp->mp_lower;
4870         xp->mp_flags = sp->mp_flags;
4871         xp->mp_pad = sp->mp_pad;
4872         COPY_PGNO(xp->mp_pgno, mp->mp_pgno);
4873
4874         /* shift lower nodes upward */
4875         ptr = mp->mp_ptrs[indx];
4876         numkeys = NUMKEYS(mp);
4877         for (i = 0; i < numkeys; i++) {
4878                 if (mp->mp_ptrs[i] <= ptr)
4879                         mp->mp_ptrs[i] += delta;
4880         }
4881
4882         base = (char *)mp + mp->mp_upper;
4883         memmove(base + delta, base, ptr - mp->mp_upper + NODESIZE + NODEKSZ(node));
4884         mp->mp_upper += delta;
4885 }
4886
4887 /** Initial setup of a sorted-dups cursor.
4888  * Sorted duplicates are implemented as a sub-database for the given key.
4889  * The duplicate data items are actually keys of the sub-database.
4890  * Operations on the duplicate data items are performed using a sub-cursor
4891  * initialized when the sub-database is first accessed. This function does
4892  * the preliminary setup of the sub-cursor, filling in the fields that
4893  * depend only on the parent DB.
4894  * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
4895  */
4896 static void
4897 mdb_xcursor_init0(MDB_cursor *mc)
4898 {
4899         MDB_xcursor *mx = mc->mc_xcursor;
4900
4901         mx->mx_cursor.mc_xcursor = NULL;
4902         mx->mx_cursor.mc_txn = mc->mc_txn;
4903         mx->mx_cursor.mc_db = &mx->mx_db;
4904         mx->mx_cursor.mc_dbx = &mx->mx_dbx;
4905         mx->mx_cursor.mc_dbi = mc->mc_dbi+1;
4906         mx->mx_cursor.mc_dbflag = &mx->mx_dbflag;
4907         mx->mx_cursor.mc_snum = 0;
4908         mx->mx_cursor.mc_top = 0;
4909         mx->mx_cursor.mc_flags = C_SUB;
4910         mx->mx_dbx.md_cmp = mc->mc_dbx->md_dcmp;
4911         mx->mx_dbx.md_dcmp = NULL;
4912         mx->mx_dbx.md_rel = mc->mc_dbx->md_rel;
4913 }
4914
4915 /** Final setup of a sorted-dups cursor.
4916  *      Sets up the fields that depend on the data from the main cursor.
4917  * @param[in] mc The main cursor whose sorted-dups cursor is to be initialized.
4918  * @param[in] node The data containing the #MDB_db record for the
4919  * sorted-dup database.
4920  */
4921 static void
4922 mdb_xcursor_init1(MDB_cursor *mc, MDB_node *node)
4923 {
4924         MDB_xcursor *mx = mc->mc_xcursor;
4925
4926         if (node->mn_flags & F_SUBDATA) {
4927                 memcpy(&mx->mx_db, NODEDATA(node), sizeof(MDB_db));
4928                 mx->mx_cursor.mc_snum = 0;
4929                 mx->mx_cursor.mc_flags = C_SUB;
4930         } else {
4931                 MDB_page *fp = NODEDATA(node);
4932                 mx->mx_db.md_pad = mc->mc_pg[mc->mc_top]->mp_pad;
4933                 mx->mx_db.md_flags = 0;
4934                 mx->mx_db.md_depth = 1;
4935                 mx->mx_db.md_branch_pages = 0;
4936                 mx->mx_db.md_leaf_pages = 1;
4937                 mx->mx_db.md_overflow_pages = 0;
4938                 mx->mx_db.md_entries = NUMKEYS(fp);
4939                 COPY_PGNO(mx->mx_db.md_root, fp->mp_pgno);
4940                 mx->mx_cursor.mc_snum = 1;
4941                 mx->mx_cursor.mc_flags = C_INITIALIZED|C_SUB;
4942                 mx->mx_cursor.mc_top = 0;
4943                 mx->mx_cursor.mc_pg[0] = fp;
4944                 mx->mx_cursor.mc_ki[0] = 0;
4945                 if (mc->mc_db->md_flags & MDB_DUPFIXED) {
4946                         mx->mx_db.md_flags = MDB_DUPFIXED;
4947                         mx->mx_db.md_pad = fp->mp_pad;
4948                         if (mc->mc_db->md_flags & MDB_INTEGERDUP)
4949                                 mx->mx_db.md_flags |= MDB_INTEGERKEY;
4950                 }
4951         }
4952         DPRINTF("Sub-db %u for db %u root page %zu", mx->mx_cursor.mc_dbi, mc->mc_dbi,
4953                 mx->mx_db.md_root);
4954         mx->mx_dbflag = (F_ISSET(mc->mc_pg[mc->mc_top]->mp_flags, P_DIRTY)) ?
4955                 DB_DIRTY : 0;
4956         mx->mx_dbx.md_name.mv_data = NODEKEY(node);
4957         mx->mx_dbx.md_name.mv_size = node->mn_ksize;
4958 #if UINT_MAX < SIZE_MAX
4959         if (mx->mx_dbx.md_cmp == mdb_cmp_int && mx->mx_db.md_pad == sizeof(size_t))
4960 #ifdef MISALIGNED_OK
4961                 mx->mx_dbx.md_cmp = mdb_cmp_long;
4962 #else
4963                 mx->mx_dbx.md_cmp = mdb_cmp_cint;
4964 #endif
4965 #endif
4966 }
4967
4968 /** Initialize a cursor for a given transaction and database. */
4969 static void
4970 mdb_cursor_init(MDB_cursor *mc, MDB_txn *txn, MDB_dbi dbi, MDB_xcursor *mx)
4971 {
4972         mc->mc_orig = NULL;
4973         mc->mc_dbi = dbi;
4974         mc->mc_txn = txn;
4975         mc->mc_db = &txn->mt_dbs[dbi];
4976         mc->mc_dbx = &txn->mt_dbxs[dbi];
4977         mc->mc_dbflag = &txn->mt_dbflags[dbi];
4978         mc->mc_snum = 0;
4979         mc->mc_top = 0;
4980         mc->mc_flags = 0;
4981         if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
4982                 assert(mx != NULL);
4983                 mc->mc_xcursor = mx;
4984                 mdb_xcursor_init0(mc);
4985         } else {
4986                 mc->mc_xcursor = NULL;
4987         }
4988 }
4989
4990 int
4991 mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **ret)
4992 {
4993         MDB_cursor      *mc;
4994         MDB_xcursor     *mx = NULL;
4995         size_t size = sizeof(MDB_cursor);
4996
4997         if (txn == NULL || ret == NULL || dbi >= txn->mt_numdbs)
4998                 return EINVAL;
4999
5000         /* Allow read access to the freelist */
5001         if (!dbi && !F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
5002                 return EINVAL;
5003
5004         if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT)
5005                 size += sizeof(MDB_xcursor);
5006
5007         if ((mc = malloc(size)) != NULL) {
5008                 if (txn->mt_dbs[dbi].md_flags & MDB_DUPSORT) {
5009                         mx = (MDB_xcursor *)(mc + 1);
5010                 }
5011                 mdb_cursor_init(mc, txn, dbi, mx);
5012                 if (txn->mt_cursors) {
5013                         mc->mc_next = txn->mt_cursors[dbi];
5014                         txn->mt_cursors[dbi] = mc;
5015                 }
5016                 mc->mc_flags |= C_ALLOCD;
5017         } else {
5018                 return ENOMEM;
5019         }
5020
5021         *ret = mc;
5022
5023         return MDB_SUCCESS;
5024 }
5025
5026 /* Return the count of duplicate data items for the current key */
5027 int
5028 mdb_cursor_count(MDB_cursor *mc, size_t *countp)
5029 {
5030         MDB_node        *leaf;
5031
5032         if (mc == NULL || countp == NULL)
5033                 return EINVAL;
5034
5035         if (!(mc->mc_db->md_flags & MDB_DUPSORT))
5036                 return EINVAL;
5037
5038         leaf = NODEPTR(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top]);
5039         if (!F_ISSET(leaf->mn_flags, F_DUPDATA)) {
5040                 *countp = 1;
5041         } else {
5042                 if (!(mc->mc_xcursor->mx_cursor.mc_flags & C_INITIALIZED))
5043                         return EINVAL;
5044
5045                 *countp = mc->mc_xcursor->mx_db.md_entries;
5046         }
5047         return MDB_SUCCESS;
5048 }
5049
5050 void
5051 mdb_cursor_close(MDB_cursor *mc)
5052 {
5053         if (mc != NULL) {
5054                 /* remove from txn, if tracked */
5055                 if (mc->mc_txn->mt_cursors) {
5056                         MDB_cursor **prev = &mc->mc_txn->mt_cursors[mc->mc_dbi];
5057                         while (*prev && *prev != mc) prev = &(*prev)->mc_next;
5058                         if (*prev == mc)
5059                                 *prev = mc->mc_next;
5060                 }
5061                 if (mc->mc_flags & C_ALLOCD)
5062                         free(mc);
5063         }
5064 }
5065
5066 MDB_txn *
5067 mdb_cursor_txn(MDB_cursor *mc)
5068 {
5069         if (!mc) return NULL;
5070         return mc->mc_txn;
5071 }
5072
5073 MDB_dbi
5074 mdb_cursor_dbi(MDB_cursor *mc)
5075 {
5076         if (!mc) return 0;
5077         return mc->mc_dbi;
5078 }
5079
5080 /** Replace the key for a node with a new key.
5081  * @param[in] mp The page containing the node to operate on.
5082  * @param[in] indx The index of the node to operate on.
5083  * @param[in] key The new key to use.
5084  * @return 0 on success, non-zero on failure.
5085  */
5086 static int
5087 mdb_update_key(MDB_page *mp, indx_t indx, MDB_val *key)
5088 {
5089         MDB_node                *node;
5090         char                    *base;
5091         size_t                   len;
5092         int                      delta, delta0;
5093         indx_t                   ptr, i, numkeys;
5094         DKBUF;
5095
5096         node = NODEPTR(mp, indx);
5097         ptr = mp->mp_ptrs[indx];
5098 #if MDB_DEBUG
5099         {
5100                 MDB_val k2;
5101                 char kbuf2[(MAXKEYSIZE*2+1)];
5102                 k2.mv_data = NODEKEY(node);
5103                 k2.mv_size = node->mn_ksize;
5104                 DPRINTF("update key %u (ofs %u) [%s] to [%s] on page %zu",
5105                         indx, ptr,
5106                         mdb_dkey(&k2, kbuf2),
5107                         DKEY(key),
5108                         mp->mp_pgno);
5109         }
5110 #endif
5111
5112         delta0 = delta = key->mv_size - node->mn_ksize;
5113
5114         /* Must be 2-byte aligned. If new key is
5115          * shorter by 1, the shift will be skipped.
5116          */
5117         delta += (delta & 1);
5118         if (delta) {
5119                 if (delta > 0 && SIZELEFT(mp) < delta) {
5120                         DPRINTF("OUCH! Not enough room, delta = %d", delta);
5121                         return ENOSPC;
5122                 }
5123
5124                 numkeys = NUMKEYS(mp);
5125                 for (i = 0; i < numkeys; i++) {
5126                         if (mp->mp_ptrs[i] <= ptr)
5127                                 mp->mp_ptrs[i] -= delta;
5128                 }
5129
5130                 base = (char *)mp + mp->mp_upper;
5131                 len = ptr - mp->mp_upper + NODESIZE;
5132                 memmove(base - delta, base, len);
5133                 mp->mp_upper -= delta;
5134
5135                 node = NODEPTR(mp, indx);
5136         }
5137
5138         /* But even if no shift was needed, update ksize */
5139         if (delta0)
5140                 node->mn_ksize = key->mv_size;
5141
5142         if (key->mv_size)
5143                 memcpy(NODEKEY(node), key->mv_data, key->mv_size);
5144
5145         return MDB_SUCCESS;
5146 }
5147
5148 /** Move a node from csrc to cdst.
5149  */
5150 static int
5151 mdb_node_move(MDB_cursor *csrc, MDB_cursor *cdst)
5152 {
5153         int                      rc;
5154         MDB_node                *srcnode;
5155         MDB_val          key, data;
5156         pgno_t  srcpg;
5157         unsigned short flags;
5158
5159         DKBUF;
5160
5161         /* Mark src and dst as dirty. */
5162         if ((rc = mdb_page_touch(csrc)) ||
5163             (rc = mdb_page_touch(cdst)))
5164                 return rc;
5165
5166         if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5167                 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);        /* fake */
5168                 key.mv_size = csrc->mc_db->md_pad;
5169                 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
5170                 data.mv_size = 0;
5171                 data.mv_data = NULL;
5172                 srcpg = 0;
5173                 flags = 0;
5174         } else {
5175                 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top]);
5176                 assert(!((long)srcnode&1));
5177                 srcpg = NODEPGNO(srcnode);
5178                 flags = srcnode->mn_flags;
5179                 if (csrc->mc_ki[csrc->mc_top] == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
5180                         unsigned int snum = csrc->mc_snum;
5181                         MDB_node *s2;
5182                         /* must find the lowest key below src */
5183                         mdb_page_search_root(csrc, NULL, 0);
5184                         s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
5185                         key.mv_size = NODEKSZ(s2);
5186                         key.mv_data = NODEKEY(s2);
5187                         csrc->mc_snum = snum--;
5188                         csrc->mc_top = snum;
5189                 } else {
5190                         key.mv_size = NODEKSZ(srcnode);
5191                         key.mv_data = NODEKEY(srcnode);
5192                 }
5193                 data.mv_size = NODEDSZ(srcnode);
5194                 data.mv_data = NODEDATA(srcnode);
5195         }
5196         if (IS_BRANCH(cdst->mc_pg[cdst->mc_top]) && cdst->mc_ki[cdst->mc_top] == 0) {
5197                 unsigned int snum = cdst->mc_snum;
5198                 MDB_node *s2;
5199                 MDB_val bkey;
5200                 /* must find the lowest key below dst */
5201                 mdb_page_search_root(cdst, NULL, 0);
5202                 s2 = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
5203                 bkey.mv_size = NODEKSZ(s2);
5204                 bkey.mv_data = NODEKEY(s2);
5205                 cdst->mc_snum = snum--;
5206                 cdst->mc_top = snum;
5207                 rc = mdb_update_key(cdst->mc_pg[cdst->mc_top], 0, &bkey);
5208         }
5209
5210         DPRINTF("moving %s node %u [%s] on page %zu to node %u on page %zu",
5211             IS_LEAF(csrc->mc_pg[csrc->mc_top]) ? "leaf" : "branch",
5212             csrc->mc_ki[csrc->mc_top],
5213                 DKEY(&key),
5214             csrc->mc_pg[csrc->mc_top]->mp_pgno,
5215             cdst->mc_ki[cdst->mc_top], cdst->mc_pg[cdst->mc_top]->mp_pgno);
5216
5217         /* Add the node to the destination page.
5218          */
5219         rc = mdb_node_add(cdst, cdst->mc_ki[cdst->mc_top], &key, &data, srcpg, flags);
5220         if (rc != MDB_SUCCESS)
5221                 return rc;
5222
5223         /* Delete the node from the source page.
5224          */
5225         mdb_node_del(csrc->mc_pg[csrc->mc_top], csrc->mc_ki[csrc->mc_top], key.mv_size);
5226
5227         {
5228                 /* Adjust other cursors pointing to mp */
5229                 MDB_cursor *m2, *m3;
5230                 MDB_dbi dbi = csrc->mc_dbi;
5231                 MDB_page *mp = csrc->mc_pg[csrc->mc_top];
5232
5233                 if (csrc->mc_flags & C_SUB)
5234                         dbi--;
5235
5236                 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5237                         if (m2 == csrc) continue;
5238                         if (csrc->mc_flags & C_SUB)
5239                                 m3 = &m2->mc_xcursor->mx_cursor;
5240                         else
5241                                 m3 = m2;
5242                         if (m3->mc_pg[csrc->mc_top] == mp && m3->mc_ki[csrc->mc_top] ==
5243                                 csrc->mc_ki[csrc->mc_top]) {
5244                                 m3->mc_pg[csrc->mc_top] = cdst->mc_pg[cdst->mc_top];
5245                                 m3->mc_ki[csrc->mc_top] = cdst->mc_ki[cdst->mc_top];
5246                         }
5247                 }
5248         }
5249
5250         /* Update the parent separators.
5251          */
5252         if (csrc->mc_ki[csrc->mc_top] == 0) {
5253                 if (csrc->mc_ki[csrc->mc_top-1] != 0) {
5254                         if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5255                                 key.mv_data = LEAF2KEY(csrc->mc_pg[csrc->mc_top], 0, key.mv_size);
5256                         } else {
5257                                 srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
5258                                 key.mv_size = NODEKSZ(srcnode);
5259                                 key.mv_data = NODEKEY(srcnode);
5260                         }
5261                         DPRINTF("update separator for source page %zu to [%s]",
5262                                 csrc->mc_pg[csrc->mc_top]->mp_pgno, DKEY(&key));
5263                         if ((rc = mdb_update_key(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1],
5264                                 &key)) != MDB_SUCCESS)
5265                                 return rc;
5266                 }
5267                 if (IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
5268                         MDB_val  nullkey;
5269                         nullkey.mv_size = 0;
5270                         rc = mdb_update_key(csrc->mc_pg[csrc->mc_top], 0, &nullkey);
5271                         assert(rc == MDB_SUCCESS);
5272                 }
5273         }
5274
5275         if (cdst->mc_ki[cdst->mc_top] == 0) {
5276                 if (cdst->mc_ki[cdst->mc_top-1] != 0) {
5277                         if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5278                                 key.mv_data = LEAF2KEY(cdst->mc_pg[cdst->mc_top], 0, key.mv_size);
5279                         } else {
5280                                 srcnode = NODEPTR(cdst->mc_pg[cdst->mc_top], 0);
5281                                 key.mv_size = NODEKSZ(srcnode);
5282                                 key.mv_data = NODEKEY(srcnode);
5283                         }
5284                         DPRINTF("update separator for destination page %zu to [%s]",
5285                                 cdst->mc_pg[cdst->mc_top]->mp_pgno, DKEY(&key));
5286                         if ((rc = mdb_update_key(cdst->mc_pg[cdst->mc_top-1], cdst->mc_ki[cdst->mc_top-1],
5287                                 &key)) != MDB_SUCCESS)
5288                                 return rc;
5289                 }
5290                 if (IS_BRANCH(cdst->mc_pg[cdst->mc_top])) {
5291                         MDB_val  nullkey;
5292                         nullkey.mv_size = 0;
5293                         rc = mdb_update_key(cdst->mc_pg[cdst->mc_top], 0, &nullkey);
5294                         assert(rc == MDB_SUCCESS);
5295                 }
5296         }
5297
5298         return MDB_SUCCESS;
5299 }
5300
5301 /** Merge one page into another.
5302  *  The nodes from the page pointed to by \b csrc will
5303  *      be copied to the page pointed to by \b cdst and then
5304  *      the \b csrc page will be freed.
5305  * @param[in] csrc Cursor pointing to the source page.
5306  * @param[in] cdst Cursor pointing to the destination page.
5307  */
5308 static int
5309 mdb_page_merge(MDB_cursor *csrc, MDB_cursor *cdst)
5310 {
5311         int                      rc;
5312         indx_t                   i, j;
5313         MDB_node                *srcnode;
5314         MDB_val          key, data;
5315         unsigned        nkeys;
5316
5317         DPRINTF("merging page %zu into %zu", csrc->mc_pg[csrc->mc_top]->mp_pgno,
5318                 cdst->mc_pg[cdst->mc_top]->mp_pgno);
5319
5320         assert(csrc->mc_snum > 1);      /* can't merge root page */
5321         assert(cdst->mc_snum > 1);
5322
5323         /* Mark dst as dirty. */
5324         if ((rc = mdb_page_touch(cdst)))
5325                 return rc;
5326
5327         /* Move all nodes from src to dst.
5328          */
5329         j = nkeys = NUMKEYS(cdst->mc_pg[cdst->mc_top]);
5330         if (IS_LEAF2(csrc->mc_pg[csrc->mc_top])) {
5331                 key.mv_size = csrc->mc_db->md_pad;
5332                 key.mv_data = METADATA(csrc->mc_pg[csrc->mc_top]);
5333                 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
5334                         rc = mdb_node_add(cdst, j, &key, NULL, 0, 0);
5335                         if (rc != MDB_SUCCESS)
5336                                 return rc;
5337                         key.mv_data = (char *)key.mv_data + key.mv_size;
5338                 }
5339         } else {
5340                 for (i = 0; i < NUMKEYS(csrc->mc_pg[csrc->mc_top]); i++, j++) {
5341                         srcnode = NODEPTR(csrc->mc_pg[csrc->mc_top], i);
5342                         if (i == 0 && IS_BRANCH(csrc->mc_pg[csrc->mc_top])) {
5343                                 unsigned int snum = csrc->mc_snum;
5344                                 MDB_node *s2;
5345                                 /* must find the lowest key below src */
5346                                 mdb_page_search_root(csrc, NULL, 0);
5347                                 s2 = NODEPTR(csrc->mc_pg[csrc->mc_top], 0);
5348                                 key.mv_size = NODEKSZ(s2);
5349                                 key.mv_data = NODEKEY(s2);
5350                                 csrc->mc_snum = snum--;
5351                                 csrc->mc_top = snum;
5352                         } else {
5353                                 key.mv_size = srcnode->mn_ksize;
5354                                 key.mv_data = NODEKEY(srcnode);
5355                         }
5356
5357                         data.mv_size = NODEDSZ(srcnode);
5358                         data.mv_data = NODEDATA(srcnode);
5359                         rc = mdb_node_add(cdst, j, &key, &data, NODEPGNO(srcnode), srcnode->mn_flags);
5360                         if (rc != MDB_SUCCESS)
5361                                 return rc;
5362                 }
5363         }
5364
5365         DPRINTF("dst page %zu now has %u keys (%.1f%% filled)",
5366             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);
5367
5368         /* Unlink the src page from parent and add to free list.
5369          */
5370         mdb_node_del(csrc->mc_pg[csrc->mc_top-1], csrc->mc_ki[csrc->mc_top-1], 0);
5371         if (csrc->mc_ki[csrc->mc_top-1] == 0) {
5372                 key.mv_size = 0;
5373                 if ((rc = mdb_update_key(csrc->mc_pg[csrc->mc_top-1], 0, &key)) != MDB_SUCCESS)
5374                         return rc;
5375         }
5376
5377         mdb_midl_append(&csrc->mc_txn->mt_free_pgs, csrc->mc_pg[csrc->mc_top]->mp_pgno);
5378         if (IS_LEAF(csrc->mc_pg[csrc->mc_top]))
5379                 csrc->mc_db->md_leaf_pages--;
5380         else
5381                 csrc->mc_db->md_branch_pages--;
5382         {
5383                 /* Adjust other cursors pointing to mp */
5384                 MDB_cursor *m2, *m3;
5385                 MDB_dbi dbi = csrc->mc_dbi;
5386                 MDB_page *mp = cdst->mc_pg[cdst->mc_top];
5387
5388                 if (csrc->mc_flags & C_SUB)
5389                         dbi--;
5390
5391                 for (m2 = csrc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5392                         if (csrc->mc_flags & C_SUB)
5393                                 m3 = &m2->mc_xcursor->mx_cursor;
5394                         else
5395                                 m3 = m2;
5396                         if (m3 == csrc) continue;
5397                         if (m3->mc_snum < csrc->mc_snum) continue;
5398                         if (m3->mc_pg[csrc->mc_top] == csrc->mc_pg[csrc->mc_top]) {
5399                                 m3->mc_pg[csrc->mc_top] = mp;
5400                                 m3->mc_ki[csrc->mc_top] += nkeys;
5401                         }
5402                 }
5403         }
5404         mdb_cursor_pop(csrc);
5405
5406         return mdb_rebalance(csrc);
5407 }
5408
5409 /** Copy the contents of a cursor.
5410  * @param[in] csrc The cursor to copy from.
5411  * @param[out] cdst The cursor to copy to.
5412  */
5413 static void
5414 mdb_cursor_copy(const MDB_cursor *csrc, MDB_cursor *cdst)
5415 {
5416         unsigned int i;
5417
5418         cdst->mc_txn = csrc->mc_txn;
5419         cdst->mc_dbi = csrc->mc_dbi;
5420         cdst->mc_db  = csrc->mc_db;
5421         cdst->mc_dbx = csrc->mc_dbx;
5422         cdst->mc_snum = csrc->mc_snum;
5423         cdst->mc_top = csrc->mc_top;
5424         cdst->mc_flags = csrc->mc_flags;
5425
5426         for (i=0; i<csrc->mc_snum; i++) {
5427                 cdst->mc_pg[i] = csrc->mc_pg[i];
5428                 cdst->mc_ki[i] = csrc->mc_ki[i];
5429         }
5430 }
5431
5432 /** Rebalance the tree after a delete operation.
5433  * @param[in] mc Cursor pointing to the page where rebalancing
5434  * should begin.
5435  * @return 0 on success, non-zero on failure.
5436  */
5437 static int
5438 mdb_rebalance(MDB_cursor *mc)
5439 {
5440         MDB_node        *node;
5441         int rc;
5442         unsigned int ptop;
5443         MDB_cursor      mn;
5444
5445 #if MDB_DEBUG
5446         {
5447         pgno_t pgno;
5448         COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5449         DPRINTF("rebalancing %s page %zu (has %u keys, %.1f%% full)",
5450             IS_LEAF(mc->mc_pg[mc->mc_top]) ? "leaf" : "branch",
5451             pgno, NUMKEYS(mc->mc_pg[mc->mc_top]), (float)PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) / 10);
5452         }
5453 #endif
5454
5455         if (PAGEFILL(mc->mc_txn->mt_env, mc->mc_pg[mc->mc_top]) >= FILL_THRESHOLD) {
5456 #if MDB_DEBUG
5457                 pgno_t pgno;
5458                 COPY_PGNO(pgno, mc->mc_pg[mc->mc_top]->mp_pgno);
5459                 DPRINTF("no need to rebalance page %zu, above fill threshold",
5460                     pgno);
5461 #endif
5462                 return MDB_SUCCESS;
5463         }
5464
5465         if (mc->mc_snum < 2) {
5466                 MDB_page *mp = mc->mc_pg[0];
5467                 if (NUMKEYS(mp) == 0) {
5468                         DPUTS("tree is completely empty");
5469                         mc->mc_db->md_root = P_INVALID;
5470                         mc->mc_db->md_depth = 0;
5471                         mc->mc_db->md_leaf_pages = 0;
5472                         mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
5473                         mc->mc_snum = 0;
5474                         mc->mc_top = 0;
5475                         {
5476                                 /* Adjust other cursors pointing to mp */
5477                                 MDB_cursor *m2, *m3;
5478                                 MDB_dbi dbi = mc->mc_dbi;
5479
5480                                 if (mc->mc_flags & C_SUB)
5481                                         dbi--;
5482
5483                                 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5484                                         if (m2 == mc) continue;
5485                                         if (mc->mc_flags & C_SUB)
5486                                                 m3 = &m2->mc_xcursor->mx_cursor;
5487                                         else
5488                                                 m3 = m2;
5489                                         if (m3->mc_snum < mc->mc_snum) continue;
5490                                         if (m3->mc_pg[0] == mp) {
5491                                                 m3->mc_snum = 0;
5492                                                 m3->mc_top = 0;
5493                                         }
5494                                 }
5495                         }
5496                 } else if (IS_BRANCH(mp) && NUMKEYS(mp) == 1) {
5497                         DPUTS("collapsing root page!");
5498                         mdb_midl_append(&mc->mc_txn->mt_free_pgs, mp->mp_pgno);
5499                         mc->mc_db->md_root = NODEPGNO(NODEPTR(mp, 0));
5500                         if ((rc = mdb_page_get(mc->mc_txn, mc->mc_db->md_root,
5501                                 &mc->mc_pg[0])))
5502                                 return rc;
5503                         mc->mc_db->md_depth--;
5504                         mc->mc_db->md_branch_pages--;
5505                         {
5506                                 /* Adjust other cursors pointing to mp */
5507                                 MDB_cursor *m2, *m3;
5508                                 MDB_dbi dbi = mc->mc_dbi;
5509
5510                                 if (mc->mc_flags & C_SUB)
5511                                         dbi--;
5512
5513                                 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5514                                         if (m2 == mc) continue;
5515                                         if (mc->mc_flags & C_SUB)
5516                                                 m3 = &m2->mc_xcursor->mx_cursor;
5517                                         else
5518                                                 m3 = m2;
5519                                         if (m3->mc_snum < mc->mc_snum) continue;
5520                                         if (m3->mc_pg[0] == mp) {
5521                                                 m3->mc_pg[0] = mc->mc_pg[0];
5522                                         }
5523                                 }
5524                         }
5525                 } else
5526                         DPUTS("root page doesn't need rebalancing");
5527                 return MDB_SUCCESS;
5528         }
5529
5530         /* The parent (branch page) must have at least 2 pointers,
5531          * otherwise the tree is invalid.
5532          */
5533         ptop = mc->mc_top-1;
5534         assert(NUMKEYS(mc->mc_pg[ptop]) > 1);
5535
5536         /* Leaf page fill factor is below the threshold.
5537          * Try to move keys from left or right neighbor, or
5538          * merge with a neighbor page.
5539          */
5540
5541         /* Find neighbors.
5542          */
5543         mdb_cursor_copy(mc, &mn);
5544         mn.mc_xcursor = NULL;
5545
5546         if (mc->mc_ki[ptop] == 0) {
5547                 /* We're the leftmost leaf in our parent.
5548                  */
5549                 DPUTS("reading right neighbor");
5550                 mn.mc_ki[ptop]++;
5551                 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
5552                 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
5553                         return rc;
5554                 mn.mc_ki[mn.mc_top] = 0;
5555                 mc->mc_ki[mc->mc_top] = NUMKEYS(mc->mc_pg[mc->mc_top]);
5556         } else {
5557                 /* There is at least one neighbor to the left.
5558                  */
5559                 DPUTS("reading left neighbor");
5560                 mn.mc_ki[ptop]--;
5561                 node = NODEPTR(mc->mc_pg[ptop], mn.mc_ki[ptop]);
5562                 if ((rc = mdb_page_get(mc->mc_txn, NODEPGNO(node), &mn.mc_pg[mn.mc_top])))
5563                         return rc;
5564                 mn.mc_ki[mn.mc_top] = NUMKEYS(mn.mc_pg[mn.mc_top]) - 1;
5565                 mc->mc_ki[mc->mc_top] = 0;
5566         }
5567
5568         DPRINTF("found neighbor page %zu (%u keys, %.1f%% full)",
5569             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);
5570
5571         /* If the neighbor page is above threshold and has at least two
5572          * keys, move one key from it.
5573          *
5574          * Otherwise we should try to merge them.
5575          */
5576         if (PAGEFILL(mc->mc_txn->mt_env, mn.mc_pg[mn.mc_top]) >= FILL_THRESHOLD && NUMKEYS(mn.mc_pg[mn.mc_top]) >= 2)
5577                 return mdb_node_move(&mn, mc);
5578         else { /* FIXME: if (has_enough_room()) */
5579                 mc->mc_flags &= ~C_INITIALIZED;
5580                 if (mc->mc_ki[ptop] == 0)
5581                         return mdb_page_merge(&mn, mc);
5582                 else
5583                         return mdb_page_merge(mc, &mn);
5584         }
5585 }
5586
5587 /** Complete a delete operation started by #mdb_cursor_del(). */
5588 static int
5589 mdb_cursor_del0(MDB_cursor *mc, MDB_node *leaf)
5590 {
5591         int rc;
5592
5593         /* add overflow pages to free list */
5594         if (!IS_LEAF2(mc->mc_pg[mc->mc_top]) && F_ISSET(leaf->mn_flags, F_BIGDATA)) {
5595                 int i, ovpages;
5596                 pgno_t pg;
5597
5598                 memcpy(&pg, NODEDATA(leaf), sizeof(pg));
5599                 ovpages = OVPAGES(NODEDSZ(leaf), mc->mc_txn->mt_env->me_psize);
5600                 mc->mc_db->md_overflow_pages -= ovpages;
5601                 for (i=0; i<ovpages; i++) {
5602                         DPRINTF("freed ov page %zu", pg);
5603                         mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
5604                         pg++;
5605                 }
5606         }
5607         mdb_node_del(mc->mc_pg[mc->mc_top], mc->mc_ki[mc->mc_top], mc->mc_db->md_pad);
5608         mc->mc_db->md_entries--;
5609         rc = mdb_rebalance(mc);
5610         if (rc != MDB_SUCCESS)
5611                 mc->mc_txn->mt_flags |= MDB_TXN_ERROR;
5612
5613         return rc;
5614 }
5615
5616 int
5617 mdb_del(MDB_txn *txn, MDB_dbi dbi,
5618     MDB_val *key, MDB_val *data)
5619 {
5620         MDB_cursor mc;
5621         MDB_xcursor mx;
5622         MDB_cursor_op op;
5623         MDB_val rdata, *xdata;
5624         int              rc, exact;
5625         DKBUF;
5626
5627         assert(key != NULL);
5628
5629         DPRINTF("====> delete db %u key [%s]", dbi, DKEY(key));
5630
5631         if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
5632                 return EINVAL;
5633
5634         if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
5635                 return EACCES;
5636         }
5637
5638         if (key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
5639                 return EINVAL;
5640         }
5641
5642         mdb_cursor_init(&mc, txn, dbi, &mx);
5643
5644         exact = 0;
5645         if (data) {
5646                 op = MDB_GET_BOTH;
5647                 rdata = *data;
5648                 xdata = &rdata;
5649         } else {
5650                 op = MDB_SET;
5651                 xdata = NULL;
5652         }
5653         rc = mdb_cursor_set(&mc, key, xdata, op, &exact);
5654         if (rc == 0)
5655                 rc = mdb_cursor_del(&mc, data ? 0 : MDB_NODUPDATA);
5656         return rc;
5657 }
5658
5659 /** Split a page and insert a new node.
5660  * @param[in,out] mc Cursor pointing to the page and desired insertion index.
5661  * The cursor will be updated to point to the actual page and index where
5662  * the node got inserted after the split.
5663  * @param[in] newkey The key for the newly inserted node.
5664  * @param[in] newdata The data for the newly inserted node.
5665  * @param[in] newpgno The page number, if the new node is a branch node.
5666  * @return 0 on success, non-zero on failure.
5667  */
5668 static int
5669 mdb_page_split(MDB_cursor *mc, MDB_val *newkey, MDB_val *newdata, pgno_t newpgno,
5670         unsigned int nflags)
5671 {
5672         unsigned int flags;
5673         int              rc = MDB_SUCCESS, ins_new = 0, new_root = 0, newpos = 1;
5674         indx_t           newindx;
5675         pgno_t           pgno = 0;
5676         unsigned int     i, j, split_indx, nkeys, pmax;
5677         MDB_node        *node;
5678         MDB_val  sepkey, rkey, xdata, *rdata = &xdata;
5679         MDB_page        *copy;
5680         MDB_page        *mp, *rp, *pp;
5681         unsigned int ptop;
5682         MDB_cursor      mn;
5683         DKBUF;
5684
5685         mp = mc->mc_pg[mc->mc_top];
5686         newindx = mc->mc_ki[mc->mc_top];
5687
5688         DPRINTF("-----> splitting %s page %zu and adding [%s] at index %i",
5689             IS_LEAF(mp) ? "leaf" : "branch", mp->mp_pgno,
5690             DKEY(newkey), mc->mc_ki[mc->mc_top]);
5691
5692         /* Create a right sibling. */
5693         if ((rp = mdb_page_new(mc, mp->mp_flags, 1)) == NULL)
5694                 return ENOMEM;
5695         DPRINTF("new right sibling: page %zu", rp->mp_pgno);
5696
5697         if (mc->mc_snum < 2) {
5698                 if ((pp = mdb_page_new(mc, P_BRANCH, 1)) == NULL)
5699                         return ENOMEM;
5700                 /* shift current top to make room for new parent */
5701                 mc->mc_pg[1] = mc->mc_pg[0];
5702                 mc->mc_ki[1] = mc->mc_ki[0];
5703                 mc->mc_pg[0] = pp;
5704                 mc->mc_ki[0] = 0;
5705                 mc->mc_db->md_root = pp->mp_pgno;
5706                 DPRINTF("root split! new root = %zu", pp->mp_pgno);
5707                 mc->mc_db->md_depth++;
5708                 new_root = 1;
5709
5710                 /* Add left (implicit) pointer. */
5711                 if ((rc = mdb_node_add(mc, 0, NULL, NULL, mp->mp_pgno, 0)) != MDB_SUCCESS) {
5712                         /* undo the pre-push */
5713                         mc->mc_pg[0] = mc->mc_pg[1];
5714                         mc->mc_ki[0] = mc->mc_ki[1];
5715                         mc->mc_db->md_root = mp->mp_pgno;
5716                         mc->mc_db->md_depth--;
5717                         return rc;
5718                 }
5719                 mc->mc_snum = 2;
5720                 mc->mc_top = 1;
5721                 ptop = 0;
5722         } else {
5723                 ptop = mc->mc_top-1;
5724                 DPRINTF("parent branch page is %zu", mc->mc_pg[ptop]->mp_pgno);
5725         }
5726
5727         mdb_cursor_copy(mc, &mn);
5728         mn.mc_pg[mn.mc_top] = rp;
5729         mn.mc_ki[ptop] = mc->mc_ki[ptop]+1;
5730
5731         if (nflags & MDB_APPEND) {
5732                 mn.mc_ki[mn.mc_top] = 0;
5733                 sepkey = *newkey;
5734                 nkeys = 0;
5735                 split_indx = 0;
5736                 goto newsep;
5737         }
5738
5739         nkeys = NUMKEYS(mp);
5740         split_indx = (nkeys + 1) / 2;
5741
5742         if (IS_LEAF2(rp)) {
5743                 char *split, *ins;
5744                 int x;
5745                 unsigned int lsize, rsize, ksize;
5746                 /* Move half of the keys to the right sibling */
5747                 copy = NULL;
5748                 x = mc->mc_ki[mc->mc_top] - split_indx;
5749                 ksize = mc->mc_db->md_pad;
5750                 split = LEAF2KEY(mp, split_indx, ksize);
5751                 rsize = (nkeys - split_indx) * ksize;
5752                 lsize = (nkeys - split_indx) * sizeof(indx_t);
5753                 mp->mp_lower -= lsize;
5754                 rp->mp_lower += lsize;
5755                 mp->mp_upper += rsize - lsize;
5756                 rp->mp_upper -= rsize - lsize;
5757                 sepkey.mv_size = ksize;
5758                 if (newindx == split_indx) {
5759                         sepkey.mv_data = newkey->mv_data;
5760                 } else {
5761                         sepkey.mv_data = split;
5762                 }
5763                 if (x<0) {
5764                         ins = LEAF2KEY(mp, mc->mc_ki[mc->mc_top], ksize);
5765                         memcpy(rp->mp_ptrs, split, rsize);
5766                         sepkey.mv_data = rp->mp_ptrs;
5767                         memmove(ins+ksize, ins, (split_indx - mc->mc_ki[mc->mc_top]) * ksize);
5768                         memcpy(ins, newkey->mv_data, ksize);
5769                         mp->mp_lower += sizeof(indx_t);
5770                         mp->mp_upper -= ksize - sizeof(indx_t);
5771                 } else {
5772                         if (x)
5773                                 memcpy(rp->mp_ptrs, split, x * ksize);
5774                         ins = LEAF2KEY(rp, x, ksize);
5775                         memcpy(ins, newkey->mv_data, ksize);
5776                         memcpy(ins+ksize, split + x * ksize, rsize - x * ksize);
5777                         rp->mp_lower += sizeof(indx_t);
5778                         rp->mp_upper -= ksize - sizeof(indx_t);
5779                         mc->mc_ki[mc->mc_top] = x;
5780                         mc->mc_pg[mc->mc_top] = rp;
5781                 }
5782                 goto newsep;
5783         }
5784
5785         /* For leaf pages, check the split point based on what
5786          * fits where, since otherwise mdb_node_add can fail.
5787          *
5788          * This check is only needed when the data items are
5789          * relatively large, such that being off by one will
5790          * make the difference between success or failure.
5791          * When the size of the data items is much smaller than
5792          * one-half of a page, this check is irrelevant.
5793          */
5794         if (IS_LEAF(mp)) {
5795                 unsigned int psize, nsize;
5796                 /* Maximum free space in an empty page */
5797                 pmax = mc->mc_txn->mt_env->me_psize - PAGEHDRSZ;
5798                 nsize = mdb_leaf_size(mc->mc_txn->mt_env, newkey, newdata);
5799                 if ((nkeys < 20) || (nsize > pmax/4)) {
5800                         if (newindx <= split_indx) {
5801                                 psize = nsize;
5802                                 newpos = 0;
5803                                 for (i=0; i<split_indx; i++) {
5804                                         node = NODEPTR(mp, i);
5805                                         psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
5806                                         if (F_ISSET(node->mn_flags, F_BIGDATA))
5807                                                 psize += sizeof(pgno_t);
5808                                         else
5809                                                 psize += NODEDSZ(node);
5810                                         psize += psize & 1;
5811                                         if (psize > pmax) {
5812                                                 if (i == split_indx - 1 && newindx == split_indx)
5813                                                         newpos = 1;
5814                                                 else
5815                                                         split_indx = i;
5816                                                 break;
5817                                         }
5818                                 }
5819                         } else {
5820                                 psize = nsize;
5821                                 for (i=nkeys-1; i>=split_indx; i--) {
5822                                         node = NODEPTR(mp, i);
5823                                         psize += NODESIZE + NODEKSZ(node) + sizeof(indx_t);
5824                                         if (F_ISSET(node->mn_flags, F_BIGDATA))
5825                                                 psize += sizeof(pgno_t);
5826                                         else
5827                                                 psize += NODEDSZ(node);
5828                                         psize += psize & 1;
5829                                         if (psize > pmax) {
5830                                                 split_indx = i+1;
5831                                                 break;
5832                                         }
5833                                 }
5834                         }
5835                 }
5836         }
5837
5838         /* First find the separating key between the split pages.
5839          * The case where newindx == split_indx is ambiguous; the
5840          * new item could go to the new page or stay on the original
5841          * page. If newpos == 1 it goes to the new page.
5842          */
5843         if (newindx == split_indx && newpos) {
5844                 sepkey.mv_size = newkey->mv_size;
5845                 sepkey.mv_data = newkey->mv_data;
5846         } else {
5847                 node = NODEPTR(mp, split_indx);
5848                 sepkey.mv_size = node->mn_ksize;
5849                 sepkey.mv_data = NODEKEY(node);
5850         }
5851
5852 newsep:
5853         DPRINTF("separator is [%s]", DKEY(&sepkey));
5854
5855         /* Copy separator key to the parent.
5856          */
5857         if (SIZELEFT(mn.mc_pg[ptop]) < mdb_branch_size(mc->mc_txn->mt_env, &sepkey)) {
5858                 mn.mc_snum--;
5859                 mn.mc_top--;
5860                 rc = mdb_page_split(&mn, &sepkey, NULL, rp->mp_pgno, 0);
5861
5862                 /* Right page might now have changed parent.
5863                  * Check if left page also changed parent.
5864                  */
5865                 if (mn.mc_pg[ptop] != mc->mc_pg[ptop] &&
5866                     mc->mc_ki[ptop] >= NUMKEYS(mc->mc_pg[ptop])) {
5867                         mc->mc_pg[ptop] = mn.mc_pg[ptop];
5868                         mc->mc_ki[ptop] = mn.mc_ki[ptop] - 1;
5869                 }
5870         } else {
5871                 mn.mc_top--;
5872                 rc = mdb_node_add(&mn, mn.mc_ki[ptop], &sepkey, NULL, rp->mp_pgno, 0);
5873                 mn.mc_top++;
5874         }
5875         if (rc != MDB_SUCCESS) {
5876                 return rc;
5877         }
5878         if (nflags & MDB_APPEND) {
5879                 mc->mc_pg[mc->mc_top] = rp;
5880                 mc->mc_ki[mc->mc_top] = 0;
5881                 rc = mdb_node_add(mc, 0, newkey, newdata, newpgno, nflags);
5882                 if (rc)
5883                         return rc;
5884                 goto done;
5885         }
5886         if (IS_LEAF2(rp)) {
5887                 goto done;
5888         }
5889
5890         /* Move half of the keys to the right sibling. */
5891
5892         /* grab a page to hold a temporary copy */
5893         copy = mdb_page_malloc(mc);
5894         if (copy == NULL)
5895                 return ENOMEM;
5896
5897         copy->mp_pgno  = mp->mp_pgno;
5898         copy->mp_flags = mp->mp_flags;
5899         copy->mp_lower = PAGEHDRSZ;
5900         copy->mp_upper = mc->mc_txn->mt_env->me_psize;
5901         mc->mc_pg[mc->mc_top] = copy;
5902         for (i = j = 0; i <= nkeys; j++) {
5903                 if (i == split_indx) {
5904                 /* Insert in right sibling. */
5905                 /* Reset insert index for right sibling. */
5906                         if (i != newindx || (newpos ^ ins_new)) {
5907                                 j = 0;
5908                                 mc->mc_pg[mc->mc_top] = rp;
5909                         }
5910                 }
5911
5912                 if (i == newindx && !ins_new) {
5913                         /* Insert the original entry that caused the split. */
5914                         rkey.mv_data = newkey->mv_data;
5915                         rkey.mv_size = newkey->mv_size;
5916                         if (IS_LEAF(mp)) {
5917                                 rdata = newdata;
5918                         } else
5919                                 pgno = newpgno;
5920                         flags = nflags;
5921
5922                         ins_new = 1;
5923
5924                         /* Update index for the new key. */
5925                         mc->mc_ki[mc->mc_top] = j;
5926                 } else if (i == nkeys) {
5927                         break;
5928                 } else {
5929                         node = NODEPTR(mp, i);
5930                         rkey.mv_data = NODEKEY(node);
5931                         rkey.mv_size = node->mn_ksize;
5932                         if (IS_LEAF(mp)) {
5933                                 xdata.mv_data = NODEDATA(node);
5934                                 xdata.mv_size = NODEDSZ(node);
5935                                 rdata = &xdata;
5936                         } else
5937                                 pgno = NODEPGNO(node);
5938                         flags = node->mn_flags;
5939
5940                         i++;
5941                 }
5942
5943                 if (!IS_LEAF(mp) && j == 0) {
5944                         /* First branch index doesn't need key data. */
5945                         rkey.mv_size = 0;
5946                 }
5947
5948                 rc = mdb_node_add(mc, j, &rkey, rdata, pgno, flags);
5949                 if (rc) break;
5950         }
5951
5952         nkeys = NUMKEYS(copy);
5953         for (i=0; i<nkeys; i++)
5954                 mp->mp_ptrs[i] = copy->mp_ptrs[i];
5955         mp->mp_lower = copy->mp_lower;
5956         mp->mp_upper = copy->mp_upper;
5957         memcpy(NODEPTR(mp, nkeys-1), NODEPTR(copy, nkeys-1),
5958                 mc->mc_txn->mt_env->me_psize - copy->mp_upper);
5959
5960         /* reset back to original page */
5961         if (newindx < split_indx || (!newpos && newindx == split_indx)) {
5962                 mc->mc_pg[mc->mc_top] = mp;
5963                 if (nflags & MDB_RESERVE) {
5964                         node = NODEPTR(mp, mc->mc_ki[mc->mc_top]);
5965                         if (!(node->mn_flags & F_BIGDATA))
5966                                 newdata->mv_data = NODEDATA(node);
5967                 }
5968         }
5969
5970         /* return tmp page to freelist */
5971         copy->mp_next = mc->mc_txn->mt_env->me_dpages;
5972         VGMEMP_FREE(mc->mc_txn->mt_env, copy);
5973         mc->mc_txn->mt_env->me_dpages = copy;
5974 done:
5975         {
5976                 /* Adjust other cursors pointing to mp */
5977                 MDB_cursor *m2, *m3;
5978                 MDB_dbi dbi = mc->mc_dbi;
5979
5980                 if (mc->mc_flags & C_SUB)
5981                         dbi--;
5982
5983                 for (m2 = mc->mc_txn->mt_cursors[dbi]; m2; m2=m2->mc_next) {
5984                         if (m2 == mc) continue;
5985                         if (mc->mc_flags & C_SUB)
5986                                 m3 = &m2->mc_xcursor->mx_cursor;
5987                         else
5988                                 m3 = m2;
5989                         if (!(m3->mc_flags & C_INITIALIZED))
5990                                 continue;
5991                         if (new_root) {
5992                                 int k;
5993                                 /* root split */
5994                                 for (k=m3->mc_top; k>=0; k--) {
5995                                         m3->mc_ki[k+1] = m3->mc_ki[k];
5996                                         m3->mc_pg[k+1] = m3->mc_pg[k];
5997                                 }
5998                                 m3->mc_ki[0] = mc->mc_ki[0];
5999                                 m3->mc_pg[0] = mc->mc_pg[0];
6000                                 m3->mc_snum++;
6001                                 m3->mc_top++;
6002                         }
6003                         if (m3->mc_pg[mc->mc_top] == mp) {
6004                                 if (m3->mc_ki[m3->mc_top] >= split_indx) {
6005                                         m3->mc_pg[m3->mc_top] = rp;
6006                                         m3->mc_ki[m3->mc_top] -= split_indx;
6007                                 }
6008                         }
6009                 }
6010         }
6011         return rc;
6012 }
6013
6014 int
6015 mdb_put(MDB_txn *txn, MDB_dbi dbi,
6016     MDB_val *key, MDB_val *data, unsigned int flags)
6017 {
6018         MDB_cursor mc;
6019         MDB_xcursor mx;
6020
6021         assert(key != NULL);
6022         assert(data != NULL);
6023
6024         if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6025                 return EINVAL;
6026
6027         if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY)) {
6028                 return EACCES;
6029         }
6030
6031         if (key->mv_size == 0 || key->mv_size > MAXKEYSIZE) {
6032                 return EINVAL;
6033         }
6034
6035         if ((flags & (MDB_NOOVERWRITE|MDB_NODUPDATA|MDB_RESERVE|MDB_APPEND)) != flags)
6036                 return EINVAL;
6037
6038         mdb_cursor_init(&mc, txn, dbi, &mx);
6039         return mdb_cursor_put(&mc, key, data, flags);
6040 }
6041
6042 /** Only a subset of the @ref mdb_env flags can be changed
6043  *      at runtime. Changing other flags requires closing the environment
6044  *      and re-opening it with the new flags.
6045  */
6046 #define CHANGEABLE      (MDB_NOSYNC)
6047 int
6048 mdb_env_set_flags(MDB_env *env, unsigned int flag, int onoff)
6049 {
6050         if ((flag & CHANGEABLE) != flag)
6051                 return EINVAL;
6052         if (onoff)
6053                 env->me_flags |= flag;
6054         else
6055                 env->me_flags &= ~flag;
6056         return MDB_SUCCESS;
6057 }
6058
6059 int
6060 mdb_env_get_flags(MDB_env *env, unsigned int *arg)
6061 {
6062         if (!env || !arg)
6063                 return EINVAL;
6064
6065         *arg = env->me_flags;
6066         return MDB_SUCCESS;
6067 }
6068
6069 int
6070 mdb_env_get_path(MDB_env *env, const char **arg)
6071 {
6072         if (!env || !arg)
6073                 return EINVAL;
6074
6075         *arg = env->me_path;
6076         return MDB_SUCCESS;
6077 }
6078
6079 /** Common code for #mdb_stat() and #mdb_env_stat().
6080  * @param[in] env the environment to operate in.
6081  * @param[in] db the #MDB_db record containing the stats to return.
6082  * @param[out] arg the address of an #MDB_stat structure to receive the stats.
6083  * @return 0, this function always succeeds.
6084  */
6085 static int
6086 mdb_stat0(MDB_env *env, MDB_db *db, MDB_stat *arg)
6087 {
6088         arg->ms_psize = env->me_psize;
6089         arg->ms_depth = db->md_depth;
6090         arg->ms_branch_pages = db->md_branch_pages;
6091         arg->ms_leaf_pages = db->md_leaf_pages;
6092         arg->ms_overflow_pages = db->md_overflow_pages;
6093         arg->ms_entries = db->md_entries;
6094
6095         return MDB_SUCCESS;
6096 }
6097 int
6098 mdb_env_stat(MDB_env *env, MDB_stat *arg)
6099 {
6100         int toggle;
6101
6102         if (env == NULL || arg == NULL)
6103                 return EINVAL;
6104
6105         mdb_env_read_meta(env, &toggle);
6106
6107         return mdb_stat0(env, &env->me_metas[toggle]->mm_dbs[MAIN_DBI], arg);
6108 }
6109
6110 /** Set the default comparison functions for a database.
6111  * Called immediately after a database is opened to set the defaults.
6112  * The user can then override them with #mdb_set_compare() or
6113  * #mdb_set_dupsort().
6114  * @param[in] txn A transaction handle returned by #mdb_txn_begin()
6115  * @param[in] dbi A database handle returned by #mdb_open()
6116  */
6117 static void
6118 mdb_default_cmp(MDB_txn *txn, MDB_dbi dbi)
6119 {
6120         uint16_t f = txn->mt_dbs[dbi].md_flags;
6121
6122         txn->mt_dbxs[dbi].md_cmp =
6123                 (f & MDB_REVERSEKEY) ? mdb_cmp_memnr :
6124                 (f & MDB_INTEGERKEY) ? mdb_cmp_cint  : mdb_cmp_memn;
6125
6126         txn->mt_dbxs[dbi].md_dcmp =
6127                 !(f & MDB_DUPSORT) ? 0 :
6128                 ((f & MDB_INTEGERDUP)
6129                  ? ((f & MDB_DUPFIXED)   ? mdb_cmp_int   : mdb_cmp_cint)
6130                  : ((f & MDB_REVERSEDUP) ? mdb_cmp_memnr : mdb_cmp_memn));
6131 }
6132
6133 int mdb_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
6134 {
6135         MDB_val key, data;
6136         MDB_dbi i;
6137         MDB_cursor mc;
6138         int rc, dbflag, exact;
6139         size_t len;
6140
6141         if (txn->mt_dbxs[FREE_DBI].md_cmp == NULL) {
6142                 mdb_default_cmp(txn, FREE_DBI);
6143         }
6144
6145         /* main DB? */
6146         if (!name) {
6147                 *dbi = MAIN_DBI;
6148                 if (flags & (MDB_DUPSORT|MDB_REVERSEKEY|MDB_INTEGERKEY))
6149                         txn->mt_dbs[MAIN_DBI].md_flags |= (flags & (MDB_DUPSORT|MDB_REVERSEKEY|MDB_INTEGERKEY));
6150                 mdb_default_cmp(txn, MAIN_DBI);
6151                 return MDB_SUCCESS;
6152         }
6153
6154         if (txn->mt_dbxs[MAIN_DBI].md_cmp == NULL) {
6155                 mdb_default_cmp(txn, MAIN_DBI);
6156         }
6157
6158         /* Is the DB already open? */
6159         len = strlen(name);
6160         for (i=2; i<txn->mt_numdbs; i++) {
6161                 if (len == txn->mt_dbxs[i].md_name.mv_size &&
6162                         !strncmp(name, txn->mt_dbxs[i].md_name.mv_data, len)) {
6163                         *dbi = i;
6164                         return MDB_SUCCESS;
6165                 }
6166         }
6167
6168         if (txn->mt_numdbs >= txn->mt_env->me_maxdbs - 1)
6169                 return ENFILE;
6170
6171         /* Find the DB info */
6172         dbflag = 0;
6173         exact = 0;
6174         key.mv_size = len;
6175         key.mv_data = (void *)name;
6176         mdb_cursor_init(&mc, txn, MAIN_DBI, NULL);
6177         rc = mdb_cursor_set(&mc, &key, &data, MDB_SET, &exact);
6178         if (rc == MDB_SUCCESS) {
6179                 /* make sure this is actually a DB */
6180                 MDB_node *node = NODEPTR(mc.mc_pg[mc.mc_top], mc.mc_ki[mc.mc_top]);
6181                 if (!(node->mn_flags & F_SUBDATA))
6182                         return EINVAL;
6183         } else if (rc == MDB_NOTFOUND && (flags & MDB_CREATE)) {
6184                 /* Create if requested */
6185                 MDB_db dummy;
6186                 data.mv_size = sizeof(MDB_db);
6187                 data.mv_data = &dummy;
6188                 memset(&dummy, 0, sizeof(dummy));
6189                 dummy.md_root = P_INVALID;
6190                 dummy.md_flags = flags & 0xffff;
6191                 rc = mdb_cursor_put(&mc, &key, &data, F_SUBDATA);
6192                 dbflag = DB_DIRTY;
6193         }
6194
6195         /* OK, got info, add to table */
6196         if (rc == MDB_SUCCESS) {
6197                 txn->mt_dbxs[txn->mt_numdbs].md_name.mv_data = strdup(name);
6198                 txn->mt_dbxs[txn->mt_numdbs].md_name.mv_size = len;
6199                 txn->mt_dbxs[txn->mt_numdbs].md_rel = NULL;
6200                 txn->mt_dbflags[txn->mt_numdbs] = dbflag;
6201                 memcpy(&txn->mt_dbs[txn->mt_numdbs], data.mv_data, sizeof(MDB_db));
6202                 *dbi = txn->mt_numdbs;
6203                 txn->mt_env->me_dbs[0][txn->mt_numdbs] = txn->mt_dbs[txn->mt_numdbs];
6204                 txn->mt_env->me_dbs[1][txn->mt_numdbs] = txn->mt_dbs[txn->mt_numdbs];
6205                 mdb_default_cmp(txn, txn->mt_numdbs);
6206                 txn->mt_numdbs++;
6207         }
6208
6209         return rc;
6210 }
6211
6212 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *arg)
6213 {
6214         if (txn == NULL || arg == NULL || dbi >= txn->mt_numdbs)
6215                 return EINVAL;
6216
6217         return mdb_stat0(txn->mt_env, &txn->mt_dbs[dbi], arg);
6218 }
6219
6220 void mdb_close(MDB_env *env, MDB_dbi dbi)
6221 {
6222         char *ptr;
6223         if (dbi <= MAIN_DBI || dbi >= env->me_numdbs)
6224                 return;
6225         ptr = env->me_dbxs[dbi].md_name.mv_data;
6226         env->me_dbxs[dbi].md_name.mv_data = NULL;
6227         env->me_dbxs[dbi].md_name.mv_size = 0;
6228         free(ptr);
6229 }
6230
6231 /** Add all the DB's pages to the free list.
6232  * @param[in] mc Cursor on the DB to free.
6233  * @param[in] subs non-Zero to check for sub-DBs in this DB.
6234  * @return 0 on success, non-zero on failure.
6235  */
6236 static int
6237 mdb_drop0(MDB_cursor *mc, int subs)
6238 {
6239         int rc;
6240
6241         rc = mdb_page_search(mc, NULL, 0);
6242         if (rc == MDB_SUCCESS) {
6243                 MDB_node *ni;
6244                 MDB_cursor mx;
6245                 unsigned int i;
6246
6247                 /* LEAF2 pages have no nodes, cannot have sub-DBs */
6248                 if (!subs || IS_LEAF2(mc->mc_pg[mc->mc_top]))
6249                         mdb_cursor_pop(mc);
6250
6251                 mdb_cursor_copy(mc, &mx);
6252                 while (mc->mc_snum > 0) {
6253                         if (IS_LEAF(mc->mc_pg[mc->mc_top])) {
6254                                 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
6255                                         ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
6256                                         if (ni->mn_flags & F_SUBDATA) {
6257                                                 mdb_xcursor_init1(mc, ni);
6258                                                 rc = mdb_drop0(&mc->mc_xcursor->mx_cursor, 0);
6259                                                 if (rc)
6260                                                         return rc;
6261                                         }
6262                                 }
6263                         } else {
6264                                 for (i=0; i<NUMKEYS(mc->mc_pg[mc->mc_top]); i++) {
6265                                         pgno_t pg;
6266                                         ni = NODEPTR(mc->mc_pg[mc->mc_top], i);
6267                                         pg = NODEPGNO(ni);
6268                                         /* free it */
6269                                         mdb_midl_append(&mc->mc_txn->mt_free_pgs, pg);
6270                                 }
6271                         }
6272                         if (!mc->mc_top)
6273                                 break;
6274                         rc = mdb_cursor_sibling(mc, 1);
6275                         if (rc) {
6276                                 /* no more siblings, go back to beginning
6277                                  * of previous level. (stack was already popped
6278                                  * by mdb_cursor_sibling)
6279                                  */
6280                                 for (i=1; i<mc->mc_top; i++)
6281                                         mc->mc_pg[i] = mx.mc_pg[i];
6282                         }
6283                 }
6284                 /* free it */
6285                 mdb_midl_append(&mc->mc_txn->mt_free_pgs,
6286                         mc->mc_db->md_root);
6287         }
6288         return 0;
6289 }
6290
6291 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
6292 {
6293         MDB_cursor *mc;
6294         int rc;
6295
6296         if (!txn || !dbi || dbi >= txn->mt_numdbs)
6297                 return EINVAL;
6298
6299         if (F_ISSET(txn->mt_flags, MDB_TXN_RDONLY))
6300                 return EACCES;
6301
6302         rc = mdb_cursor_open(txn, dbi, &mc);
6303         if (rc)
6304                 return rc;
6305
6306         rc = mdb_drop0(mc, mc->mc_db->md_flags & MDB_DUPSORT);
6307         if (rc)
6308                 goto leave;
6309
6310         /* Can't delete the main DB */
6311         if (del && dbi > MAIN_DBI) {
6312                 rc = mdb_del(txn, MAIN_DBI, &mc->mc_dbx->md_name, NULL);
6313                 if (!rc)
6314                         mdb_close(txn->mt_env, dbi);
6315         } else {
6316                 txn->mt_dbflags[dbi] |= DB_DIRTY;
6317                 txn->mt_dbs[dbi].md_depth = 0;
6318                 txn->mt_dbs[dbi].md_branch_pages = 0;
6319                 txn->mt_dbs[dbi].md_leaf_pages = 0;
6320                 txn->mt_dbs[dbi].md_overflow_pages = 0;
6321                 txn->mt_dbs[dbi].md_entries = 0;
6322                 txn->mt_dbs[dbi].md_root = P_INVALID;
6323         }
6324 leave:
6325         mdb_cursor_close(mc);
6326         return rc;
6327 }
6328
6329 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
6330 {
6331         if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6332                 return EINVAL;
6333
6334         txn->mt_dbxs[dbi].md_cmp = cmp;
6335         return MDB_SUCCESS;
6336 }
6337
6338 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
6339 {
6340         if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6341                 return EINVAL;
6342
6343         txn->mt_dbxs[dbi].md_dcmp = cmp;
6344         return MDB_SUCCESS;
6345 }
6346
6347 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
6348 {
6349         if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6350                 return EINVAL;
6351
6352         txn->mt_dbxs[dbi].md_rel = rel;
6353         return MDB_SUCCESS;
6354 }
6355
6356 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
6357 {
6358         if (txn == NULL || !dbi || dbi >= txn->mt_numdbs)
6359                 return EINVAL;
6360
6361         txn->mt_dbxs[dbi].md_relctx = ctx;
6362         return MDB_SUCCESS;
6363 }
6364
6365 /** @} */