-
Notifications
You must be signed in to change notification settings - Fork 126
Expand file tree
/
Copy pathEnvFlags.java
More file actions
175 lines (164 loc) · 7.59 KB
/
EnvFlags.java
File metadata and controls
175 lines (164 loc) · 7.59 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
* Copyright © 2016-2025 The LmdbJava Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.lmdbjava;
import java.util.EnumSet;
import java.util.Set;
/** Flags for use when opening the {@link Env}. */
public enum EnvFlags implements MaskedFlag, EnvFlagSet {
/**
* Mmap at a fixed address (experimental).
*
* <p>Use a fixed address for the mmap region. This flag must be specified when creating the
* environment, and is stored persistently in the environment. If successful, the memory map will
* always reside at the same virtual address and pointers used to reference data items in the
* database will be constant across multiple invocations. This option may not always work,
* depending on how the operating system has allocated memory to shared libraries and other uses.
* The feature is highly experimental.
*/
MDB_FIXEDMAP(0x01),
/**
* No environment directory.
*
* <p>By default, LMDB creates its environment in a directory whose pathname is given in path, and
* creates its data and lock files under that directory. With this option, path is used as-is for
* the database main data file. The database lock file is the path with "-lock" appended.
*/
MDB_NOSUBDIR(0x4000),
/**
* Open the environment in read-only mode.
*
* <p>No write operations will be allowed. LMDB will still modify the lock file - except on
* read-only filesystems, where LMDB does not use locks.
*/
MDB_RDONLY_ENV(0x2_0000),
/**
* Use a writeable memory map unless {@link #MDB_RDONLY_ENV} is set.
*
* <p>This is faster and uses fewer mallocs, but loses protection from application bugs like wild
* pointer writes and other bad updates into the database. Incompatible with nested transactions.
* Do not mix processes with and without {@link #MDB_WRITEMAP} on the same environment. This can
* defeat durability ({@link Env#sync(boolean)} etc).
*/
MDB_WRITEMAP(0x8_0000),
/**
* Don't fsync metapage after commit.
*
* <p>Flush system buffers to disk only once per transaction, omit the metadata flush. Defer that
* until the system flushes files to disk, or next non-{@link #MDB_RDONLY_ENV} commit or {@link
* Env#sync(boolean)}. This optimization* maintains database integrity, but a system crash may
* undo the last* committed transaction. I.e. it preserves the ACI (atomicity, consistency,
* isolation) but not D (durability) database property.
*/
MDB_NOMETASYNC(0x4_0000),
/**
* Don't fsync after commit.
*
* <p>Don't flush system buffers to disk when committing a transaction. This optimization means a
* system crash can corrupt the database or lose the last transactions if buffers are not yet
* flushed to disk. The risk is governed by how often the system flushes dirty buffers to disk and
* how often {@link Env#sync(boolean)} is called. However, if the filesystem preserves write order
* and the {@link #MDB_WRITEMAP} flag is not used, transactions exhibit ACI (atomicity,
* consistency, isolation) properties and only lose D (durability). I.e. database integrity is
* maintained, but a system crash may undo the final transactions. Note that ({@link #MDB_NOSYNC}
* | {@link #MDB_WRITEMAP}) leaves the system with no hint for when to write transactions to disk,
* unless {@link Env#sync(boolean)} is called. ({@link #MDB_MAPASYNC} | {@link #MDB_WRITEMAP}) may
* be preferable.
*/
MDB_NOSYNC(0x1_0000),
/**
* Use asynchronous msync when {@link #MDB_WRITEMAP} is used.
*
* <p>When using {@link #MDB_WRITEMAP}, use asynchronous flushes to disk. As with {@link
* #MDB_NOSYNC}, a system crash can then corrupt the database or lose the last transactions.
* Calling {@link Env#sync(boolean)} ensures on-disk database integrity until next commit.
*/
MDB_MAPASYNC(0x10_0000),
/**
* Tie reader locktable slots to {@link Txn} objects instead of to threads.
*
* <p>Don't use Thread-Local Storage. Tie reader locktable slots to {@link Txn} objects instead of
* to threads. I.e. {@link Txn#reset()} keeps the slot reseved for the {@link Txn} object. A
* thread may use parallel read-only transactions. A read-only transaction may span threads if the
* user synchronizes its use. Applications that multiplex many user threads over individual OS
* threads need this option. Such an application must also serialize the write transactions in an
* OS thread, since LMDB's write locking is unaware of the user threads.
*/
MDB_NOTLS(0x20_0000),
/**
* Don't do any locking, caller must manage their own locks.
*
* <p>Don't do any locking. If concurrent access is anticipated, the caller must manage all
* concurrency itself. For proper operation the caller must enforce single-writer semantics, and
* must ensure that no readers are using old transactions while a writer is active. The simplest
* approach is to use an exclusive lock so that no readers may be active at all when a writer
* begins.
*/
MDB_NOLOCK(0x40_0000),
/**
* Don't do readahead (no effect on Windows).
*
* <p>Turn off readahead. Most operating systems perform readahead on read requests by default.
* This option turns it off if the OS supports it. Turning it off may help random read performance
* when the DB is larger than RAM and system RAM is full. The option is not implemented on
* Windows.
*/
MDB_NORDAHEAD(0x80_0000),
/**
* Don't initialize malloc'd memory before writing to datafile.
*
* <p>Don't initialize malloc'd memory before writing to unused spaces in the data file. By
* default, memory for pages written to the data file is obtained using malloc. While these pages
* may be reused in subsequent transactions, freshly malloc'd pages will be initialized to zeroes
* before use. This avoids persisting leftover data from other code (that used the heap and
* subsequently freed the memory) into the data file. Note that many other system libraries may
* allocate and free memory from the heap for arbitrary uses. E.g., stdio may use the heap for
* file I/O buffers. This initialization step has a modest performance cost so some applications
* may want to disable it using this flag. This option can be a problem for applications which
* handle sensitive data like passwords, and it makes memory checkers like Valgrind noisy. This
* flag is not needed with {@link #MDB_WRITEMAP}, which writes directly to the mmap instead of
* using malloc for pages. The initialization is also skipped if {@link PutFlags#MDB_RESERVE} is
* used; the caller is expected to overwrite all of the memory that was reserved in that case.
*/
MDB_NOMEMINIT(0x100_0000);
private final int mask;
EnvFlags(final int mask) {
this.mask = mask;
}
@Override
public int getMask() {
return mask;
}
@Override
public Set<EnvFlags> getFlags() {
return EnumSet.of(this);
}
@Override
public boolean isSet(final EnvFlags flag) {
return this == flag;
}
@Override
public int size() {
return 1;
}
@Override
public boolean isEmpty() {
return false;
}
@Override
public String toString() {
return FlagSet.asString(this);
}
}