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