-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
NativeIndexPopulator.java
341 lines (306 loc) · 11.1 KB
/
NativeIndexPopulator.java
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
/*
* Copyright (c) 2002-2019 "Neo4j,"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.impl.index.schema;
import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.NoSuchFileException;
import java.util.Collection;
import java.util.function.Consumer;
import org.neo4j.index.internal.gbptree.GBPTree;
import org.neo4j.index.internal.gbptree.RecoveryCleanupWorkCollector;
import org.neo4j.index.internal.gbptree.Writer;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.pagecache.IOLimiter;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.io.pagecache.PageCursor;
import org.neo4j.kernel.api.exceptions.index.IndexEntryConflictException;
import org.neo4j.kernel.api.index.IndexEntryUpdate;
import org.neo4j.kernel.api.index.IndexPopulator;
import org.neo4j.kernel.api.index.IndexProvider;
import org.neo4j.kernel.api.index.IndexUpdater;
import org.neo4j.kernel.impl.api.index.sampling.UniqueIndexSampler;
import org.neo4j.storageengine.api.NodePropertyAccessor;
import org.neo4j.storageengine.api.schema.IndexSample;
import org.neo4j.storageengine.api.schema.StoreIndexDescriptor;
import org.neo4j.util.Preconditions;
import org.neo4j.values.storable.Value;
import static org.neo4j.index.internal.gbptree.GBPTree.NO_HEADER_WRITER;
import static org.neo4j.storageengine.api.schema.IndexDescriptor.Type.GENERAL;
import static org.neo4j.storageengine.api.schema.IndexDescriptor.Type.UNIQUE;
/**
* {@link IndexPopulator} backed by a {@link GBPTree}.
*
* @param <KEY> type of {@link NativeIndexSingleValueKey}.
* @param <VALUE> type of {@link NativeIndexValue}.
*/
public abstract class NativeIndexPopulator<KEY extends NativeIndexKey<KEY>, VALUE extends NativeIndexValue>
extends NativeIndex<KEY,VALUE> implements IndexPopulator, ConsistencyCheckableIndexPopulator
{
public static final byte BYTE_FAILED = 0;
static final byte BYTE_ONLINE = 1;
static final byte BYTE_POPULATING = 2;
private final KEY treeKey;
private final VALUE treeValue;
private final UniqueIndexSampler uniqueSampler;
private final Consumer<PageCursor> additionalHeaderWriter;
private ConflictDetectingValueMerger<KEY,VALUE,Value[]> mainConflictDetector;
private ConflictDetectingValueMerger<KEY,VALUE,Value[]> updatesConflictDetector;
private byte[] failureBytes;
private boolean dropped;
private boolean closed;
NativeIndexPopulator( PageCache pageCache, FileSystemAbstraction fs, File storeFile, IndexLayout<KEY,VALUE> layout, IndexProvider.Monitor monitor,
StoreIndexDescriptor descriptor, Consumer<PageCursor> additionalHeaderWriter )
{
super( pageCache, fs, storeFile, layout, monitor, descriptor );
this.treeKey = layout.newKey();
this.treeValue = layout.newValue();
this.additionalHeaderWriter = additionalHeaderWriter;
switch ( descriptor.type() )
{
case GENERAL:
uniqueSampler = null;
break;
case UNIQUE:
uniqueSampler = new UniqueIndexSampler();
break;
default:
throw new IllegalArgumentException( "Unexpected index type " + descriptor.type() );
}
}
public void clear()
{
deleteFileIfPresent( fileSystem, storeFile );
}
@Override
public synchronized void create()
{
create( new NativeIndexHeaderWriter( BYTE_POPULATING, additionalHeaderWriter ) );
}
protected synchronized void create( Consumer<PageCursor> headerWriter )
{
assertNotDropped();
assertNotClosed();
deleteFileIfPresent( fileSystem, storeFile );
instantiateTree( RecoveryCleanupWorkCollector.immediate(), headerWriter );
// true: tree uniqueness is (value,entityId)
// false: tree uniqueness is (value) <-- i.e. more strict
mainConflictDetector = getMainConflictDetector();
// for updates we have to have uniqueness on (value,entityId) to allow for intermediary violating updates.
// there are added conflict checks after updates have been applied.
updatesConflictDetector = new ThrowingConflictDetector<>( true );
}
ConflictDetectingValueMerger<KEY,VALUE,Value[]> getMainConflictDetector()
{
return new ThrowingConflictDetector<>( descriptor.type() == GENERAL );
}
@Override
public synchronized void drop()
{
try
{
closeTree();
deleteFileIfPresent( fileSystem, storeFile );
}
finally
{
dropped = true;
closed = true;
}
}
@Override
public void add( Collection<? extends IndexEntryUpdate<?>> updates ) throws IndexEntryConflictException
{
processUpdates( updates, mainConflictDetector );
}
@Override
public void verifyDeferredConstraints( NodePropertyAccessor nodePropertyAccessor ) throws IndexEntryConflictException
{
// No-op, uniqueness is checked for each update in add(IndexEntryUpdate)
}
@Override
public IndexUpdater newPopulatingUpdater( NodePropertyAccessor accessor )
{
return newPopulatingUpdater();
}
IndexUpdater newPopulatingUpdater()
{
IndexUpdater updater = new CollectingIndexUpdater( updates -> processUpdates( updates, updatesConflictDetector ) );
if ( descriptor.type() == UNIQUE && canCheckConflictsWithoutStoreAccess() )
{
// The index population detects conflicts on the fly, however for updates coming in we're in a position
// where we cannot detect conflicts while applying, but instead afterwards.
updater = new DeferredConflictCheckingIndexUpdater( updater, this::newReader, descriptor );
}
return updater;
}
boolean canCheckConflictsWithoutStoreAccess()
{
return true;
}
abstract NativeIndexReader<KEY,VALUE> newReader();
@Override
public synchronized void close( boolean populationCompletedSuccessfully )
{
if ( populationCompletedSuccessfully && failureBytes != null )
{
throw new IllegalStateException( "Can't mark index as online after it has been marked as failure" );
}
try
{
assertNotDropped();
if ( populationCompletedSuccessfully )
{
// Successful and completed population
assertPopulatorOpen();
markTreeAsOnline();
}
else if ( failureBytes != null )
{
// Failed population
ensureTreeInstantiated();
markTreeAsFailed();
}
// else cancelled population. Here we simply close the tree w/o checkpointing it and it will look like POPULATING state on next open
}
finally
{
closeTree();
closed = true;
}
}
private void assertNotDropped()
{
if ( dropped )
{
throw new IllegalStateException( "Populator has already been dropped." );
}
}
private void assertNotClosed()
{
if ( closed )
{
throw new IllegalStateException( "Populator has already been closed." );
}
}
@Override
public void markAsFailed( String failure )
{
failureBytes = failure.getBytes( StandardCharsets.UTF_8 );
}
private void ensureTreeInstantiated()
{
if ( tree == null )
{
instantiateTree( RecoveryCleanupWorkCollector.ignore(), NO_HEADER_WRITER );
}
}
private void assertPopulatorOpen()
{
if ( tree == null )
{
throw new IllegalStateException( "Populator has already been closed." );
}
}
private void markTreeAsFailed()
{
Preconditions.checkState( failureBytes != null, "markAsFailed hasn't been called, populator not actually failed?" );
tree.checkpoint( IOLimiter.UNLIMITED, new FailureHeaderWriter( failureBytes ) );
}
void markTreeAsOnline()
{
tree.checkpoint( IOLimiter.UNLIMITED, new NativeIndexHeaderWriter( BYTE_ONLINE, additionalHeaderWriter ) );
}
private void processUpdates( Iterable<? extends IndexEntryUpdate<?>> indexEntryUpdates, ConflictDetectingValueMerger<KEY,VALUE,Value[]> conflictDetector )
throws IndexEntryConflictException
{
try ( Writer<KEY,VALUE> writer = tree.writer() )
{
for ( IndexEntryUpdate<?> indexEntryUpdate : indexEntryUpdates )
{
NativeIndexUpdater.processUpdate( treeKey, treeValue, indexEntryUpdate, writer, conflictDetector );
}
}
catch ( IOException e )
{
throw new UncheckedIOException( e );
}
}
@Override
public void includeSample( IndexEntryUpdate<?> update )
{
switch ( descriptor.type() )
{
case GENERAL:
// Don't do anything here, we'll do a scan in the end instead
break;
case UNIQUE:
updateUniqueSample( update );
break;
default:
throw new IllegalArgumentException( "Unexpected index type " + descriptor.type() );
}
}
private void updateUniqueSample( IndexEntryUpdate<?> update )
{
switch ( update.updateMode() )
{
case ADDED:
uniqueSampler.increment( 1 );
break;
case REMOVED:
uniqueSampler.increment( -1 );
break;
case CHANGED:
break;
default:
throw new IllegalArgumentException( "Unsupported update mode type:" + update.updateMode() );
}
}
@Override
public IndexSample sampleResult()
{
switch ( descriptor.type() )
{
case GENERAL:
return new FullScanNonUniqueIndexSampler<>( tree, layout ).result();
case UNIQUE:
return uniqueSampler.result();
default:
throw new IllegalArgumentException( "Unexpected index type " + descriptor.type() );
}
}
private static void deleteFileIfPresent( FileSystemAbstraction fs, File storeFile )
{
try
{
fs.deleteFileOrThrow( storeFile );
}
catch ( NoSuchFileException e )
{
// File does not exist, we don't need to delete
}
catch ( IOException e )
{
throw new UncheckedIOException( e );
}
}
}