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