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