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