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