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