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