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