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