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