-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
NativeSchemaNumberIndexProvider.java
197 lines (181 loc) · 8.05 KB
/
NativeSchemaNumberIndexProvider.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
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.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 org.neo4j.index.internal.gbptree.GBPTree;
import org.neo4j.index.internal.gbptree.Layout;
import org.neo4j.index.internal.gbptree.RecoveryCleanupWorkCollector;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.kernel.api.index.IndexAccessor;
import org.neo4j.kernel.api.index.IndexDirectoryStructure;
import org.neo4j.kernel.api.index.IndexPopulator;
import org.neo4j.kernel.api.index.InternalIndexState;
import org.neo4j.kernel.api.index.SchemaIndexProvider;
import org.neo4j.kernel.api.schema.index.IndexDescriptor;
import org.neo4j.kernel.impl.api.index.sampling.IndexSamplingConfig;
import org.neo4j.kernel.impl.storemigration.StoreMigrationParticipant;
import org.neo4j.logging.Log;
import org.neo4j.logging.LogProvider;
import static org.neo4j.kernel.impl.index.schema.NativeSchemaNumberIndexPopulator.BYTE_FAILED;
import static org.neo4j.kernel.impl.index.schema.NativeSchemaNumberIndexPopulator.BYTE_ONLINE;
import static org.neo4j.kernel.impl.index.schema.NativeSchemaNumberIndexPopulator.BYTE_POPULATING;
/**
* Schema index provider for native indexes backed by e.g. {@link GBPTree}.
*/
public class NativeSchemaNumberIndexProvider extends SchemaIndexProvider
{
public static final String KEY = "native";
public static final Descriptor NATIVE_PROVIDER_DESCRIPTOR = new Descriptor( KEY, "1.0" );
private static final String INDEX_FILE_NAME = "index";
private final PageCache pageCache;
private final FileSystemAbstraction fs;
private final Log log;
private final RecoveryCleanupWorkCollector recoveryCleanupWorkCollector;
private final boolean readOnly;
public NativeSchemaNumberIndexProvider( PageCache pageCache, FileSystemAbstraction fs, File storeDir, LogProvider logging,
RecoveryCleanupWorkCollector recoveryCleanupWorkCollector, boolean readOnly )
{
this( pageCache, fs, IndexDirectoryStructure.directoriesByProvider( storeDir ), logging,
recoveryCleanupWorkCollector, readOnly );
}
public NativeSchemaNumberIndexProvider( PageCache pageCache, FileSystemAbstraction fs, IndexDirectoryStructure.Factory directoryStructure,
LogProvider logging, RecoveryCleanupWorkCollector recoveryCleanupWorkCollector, boolean readOnly )
{
super( NATIVE_PROVIDER_DESCRIPTOR, 0, directoryStructure );
this.pageCache = pageCache;
this.fs = fs;
this.log = logging.getLog( getClass() );
this.recoveryCleanupWorkCollector = recoveryCleanupWorkCollector;
this.readOnly = readOnly;
}
@Override
public IndexPopulator getPopulator( long indexId, IndexDescriptor descriptor, IndexSamplingConfig samplingConfig )
{
if ( readOnly )
{
throw new UnsupportedOperationException( "Can't create populator for read only index" );
}
File storeFile = nativeIndexFileFromIndexId( indexId );
switch ( descriptor.type() )
{
case GENERAL:
return new NativeNonUniqueSchemaNumberIndexPopulator<>( pageCache, fs, storeFile, new NonUniqueNumberLayout(), samplingConfig );
case UNIQUE:
return new NativeUniqueSchemaNumberIndexPopulator<>( pageCache, fs, storeFile, new UniqueNumberLayout() );
default:
throw new UnsupportedOperationException( "Can not create index populator of type " + descriptor.type() );
}
}
@Override
public IndexAccessor getOnlineAccessor( long indexId, IndexDescriptor descriptor, IndexSamplingConfig samplingConfig )
throws IOException
{
File storeFile = nativeIndexFileFromIndexId( indexId );
NumberLayout layout;
switch ( descriptor.type() )
{
case GENERAL:
layout = new NonUniqueNumberLayout();
break;
case UNIQUE:
layout = new UniqueNumberLayout();
break;
default:
throw new UnsupportedOperationException( "Can not create index accessor of type " + descriptor.type() );
}
return new NativeSchemaNumberIndexAccessor<>( pageCache, fs, storeFile, layout, recoveryCleanupWorkCollector );
}
@Override
public String getPopulationFailure( long indexId ) throws IllegalStateException
{
try
{
String failureMessage = readPopulationFailure( indexId );
if ( failureMessage == null )
{
throw new IllegalStateException( "Index " + indexId + " isn't failed" );
}
return failureMessage;
}
catch ( IOException e )
{
throw new RuntimeException( e );
}
}
private String readPopulationFailure( long indexId ) throws IOException
{
NativeSchemaIndexHeaderReader headerReader = new NativeSchemaIndexHeaderReader();
GBPTree.readHeader( pageCache, nativeIndexFileFromIndexId( indexId ), new ReadOnlyMetaNumberLayout(),
headerReader );
return headerReader.failureMessage;
}
@Override
public InternalIndexState getInitialState( long indexId, IndexDescriptor descriptor )
{
try
{
NativeSchemaIndexHeaderReader headerReader = new NativeSchemaIndexHeaderReader();
GBPTree.readHeader( pageCache, nativeIndexFileFromIndexId( indexId ), new ReadOnlyMetaNumberLayout(),
headerReader );
switch ( headerReader.state )
{
case BYTE_FAILED:
return InternalIndexState.FAILED;
case BYTE_ONLINE:
return InternalIndexState.ONLINE;
case BYTE_POPULATING:
return InternalIndexState.POPULATING;
default:
throw new IllegalStateException( "Unexpected initial state byte value " + headerReader.state );
}
}
catch ( IOException e )
{
log.error( "Failed to open index:" + indexId + ", requesting re-population.", e );
return InternalIndexState.POPULATING;
}
}
@Override
public StoreMigrationParticipant storeMigrationParticipant( FileSystemAbstraction fs, PageCache pageCache )
{
// Since this native provider is a new one, there's no need for migration on this level.
// Migration should happen in the combined layer for the time being.
return StoreMigrationParticipant.NOT_PARTICIPATING;
}
private File nativeIndexFileFromIndexId( long indexId )
{
return new File( directoryStructure().directoryForIndex( indexId ), INDEX_FILE_NAME );
}
private class ReadOnlyMetaNumberLayout extends Layout.ReadOnlyMetaLayout
{
@Override
public boolean compatibleWith( long layoutIdentifier, int majorVersion, int minorVersion )
{
return (layoutIdentifier == UniqueNumberLayout.IDENTIFIER &&
majorVersion == UniqueNumberLayout.MAJOR_VERSION &&
minorVersion == UniqueNumberLayout.MINOR_VERSION) ||
(layoutIdentifier == NonUniqueNumberLayout.IDENTIFIER &&
majorVersion == NonUniqueNumberLayout.MAJOR_VERSION &&
minorVersion == NonUniqueNumberLayout.MINOR_VERSION);
}
}
}