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