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