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