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