/
EnterpriseCoreEditionModule.java
331 lines (282 loc) · 15.3 KB
/
EnterpriseCoreEditionModule.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
/*
* 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 Affero 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.causalclustering.core;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.PrintWriter;
import java.util.function.Supplier;
import org.neo4j.causalclustering.ReplicationModule;
import org.neo4j.causalclustering.catchup.storecopy.LocalDatabase;
import org.neo4j.causalclustering.catchup.storecopy.StoreFiles;
import org.neo4j.causalclustering.core.consensus.ConsensusModule;
import org.neo4j.causalclustering.core.consensus.RaftMachine;
import org.neo4j.causalclustering.core.consensus.RaftMessages;
import org.neo4j.causalclustering.core.consensus.roles.Role;
import org.neo4j.causalclustering.core.server.CoreServerModule;
import org.neo4j.causalclustering.core.state.ClusterStateDirectory;
import org.neo4j.causalclustering.core.state.ClusterStateException;
import org.neo4j.causalclustering.core.state.ClusteringModule;
import org.neo4j.causalclustering.core.state.machines.CoreStateMachinesModule;
import org.neo4j.causalclustering.discovery.CoreTopologyService;
import org.neo4j.causalclustering.discovery.DiscoveryServiceFactory;
import org.neo4j.causalclustering.discovery.procedures.ClusterOverviewProcedure;
import org.neo4j.causalclustering.discovery.procedures.CoreRoleProcedure;
import org.neo4j.causalclustering.identity.MemberId;
import org.neo4j.causalclustering.load_balancing.LoadBalancingStrategy;
import org.neo4j.causalclustering.load_balancing.procedure.GetServersProcedureV1;
import org.neo4j.causalclustering.load_balancing.procedure.GetServersProcedureV2;
import org.neo4j.causalclustering.load_balancing.strategy.AllServersStrategy;
import org.neo4j.causalclustering.load_balancing.strategy.ServerShufflingStrategy;
import org.neo4j.causalclustering.logging.BetterMessageLogger;
import org.neo4j.causalclustering.logging.MessageLogger;
import org.neo4j.causalclustering.logging.NullMessageLogger;
import org.neo4j.causalclustering.messaging.CoreReplicatedContentMarshal;
import org.neo4j.causalclustering.messaging.LoggingOutbound;
import org.neo4j.causalclustering.messaging.Outbound;
import org.neo4j.causalclustering.messaging.RaftChannelInitializer;
import org.neo4j.causalclustering.messaging.RaftOutbound;
import org.neo4j.causalclustering.messaging.SenderService;
import org.neo4j.dbms.DatabaseManagementSystemSettings;
import org.neo4j.graphdb.DependencyResolver;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.kernel.DatabaseAvailability;
import org.neo4j.kernel.NeoStoreDataSource;
import org.neo4j.kernel.api.bolt.BoltConnectionTracker;
import org.neo4j.kernel.api.exceptions.KernelException;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.enterprise.builtinprocs.EnterpriseBuiltInDbmsProcedures;
import org.neo4j.kernel.impl.api.SchemaWriteGuard;
import org.neo4j.kernel.impl.api.TransactionHeaderInformation;
import org.neo4j.kernel.impl.api.index.RemoveOrphanConstraintIndexesOnStartup;
import org.neo4j.kernel.impl.coreapi.CoreAPIAvailabilityGuard;
import org.neo4j.kernel.impl.enterprise.EnterpriseConstraintSemantics;
import org.neo4j.kernel.impl.enterprise.EnterpriseEditionModule;
import org.neo4j.kernel.impl.enterprise.StandardBoltConnectionTracker;
import org.neo4j.kernel.impl.enterprise.transaction.log.checkpoint.ConfigurableIOLimiter;
import org.neo4j.kernel.impl.factory.DatabaseInfo;
import org.neo4j.kernel.impl.factory.EditionModule;
import org.neo4j.kernel.impl.factory.PlatformModule;
import org.neo4j.kernel.impl.factory.StatementLocksFactorySelector;
import org.neo4j.kernel.impl.logging.LogService;
import org.neo4j.kernel.impl.proc.Procedures;
import org.neo4j.kernel.impl.store.id.IdReuseEligibility;
import org.neo4j.kernel.impl.transaction.TransactionHeaderInformationFactory;
import org.neo4j.kernel.impl.util.Dependencies;
import org.neo4j.kernel.internal.DatabaseHealth;
import org.neo4j.kernel.internal.DefaultKernelData;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.kernel.internal.KernelData;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.kernel.lifecycle.LifecycleStatus;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.logging.LogProvider;
import org.neo4j.udc.UsageData;
/**
* This implementation of {@link org.neo4j.kernel.impl.factory.EditionModule} creates the implementations of services
* that are specific to the Enterprise Core edition that provides a core cluster.
*/
public class EnterpriseCoreEditionModule extends EditionModule
{
private final ConsensusModule consensusModule;
private final CoreTopologyService topologyService;
private final LogProvider logProvider;
private final Config config;
public enum RaftLogImplementation
{
IN_MEMORY, SEGMENTED
}
@Override
public void registerEditionSpecificProcedures( Procedures procedures ) throws KernelException
{
LoadBalancingStrategy loadBalancingStrategy = new ServerShufflingStrategy(
new AllServersStrategy( topologyService, consensusModule.raftMachine(), config ) );
procedures.registerProcedure( EnterpriseBuiltInDbmsProcedures.class, true );
procedures.register(
new GetServersProcedureV1( topologyService, consensusModule.raftMachine(), config, logProvider ) );
procedures.register(
new GetServersProcedureV2( loadBalancingStrategy ) );
procedures.register(
new ClusterOverviewProcedure( topologyService, consensusModule.raftMachine(), logProvider ) );
procedures.register( new CoreRoleProcedure( consensusModule.raftMachine() ) );
}
EnterpriseCoreEditionModule( final PlatformModule platformModule,
final DiscoveryServiceFactory discoveryServiceFactory )
{
final Dependencies dependencies = platformModule.dependencies;
config = platformModule.config;
final LogService logging = platformModule.logging;
final FileSystemAbstraction fileSystem = platformModule.fileSystem;
final File storeDir = platformModule.storeDir;
final LifeSupport life = platformModule.life;
final Monitors monitors = platformModule.monitors;
final File dataDir = config.get( DatabaseManagementSystemSettings.data_directory );
final ClusterStateDirectory clusterStateDirectory = new ClusterStateDirectory( dataDir, storeDir, false );
try
{
clusterStateDirectory.initialize( fileSystem );
}
catch ( ClusterStateException e )
{
throw new RuntimeException( e );
}
eligibleForIdReuse = IdReuseEligibility.ALWAYS;
logProvider = logging.getInternalLogProvider();
final Supplier<DatabaseHealth> databaseHealthSupplier = dependencies.provideDependency( DatabaseHealth.class );
LocalDatabase localDatabase = new LocalDatabase( platformModule.storeDir,
new StoreFiles( fileSystem, platformModule.pageCache ),
platformModule.dataSourceManager,
databaseHealthSupplier,
logProvider );
IdentityModule identityModule = new IdentityModule( platformModule, clusterStateDirectory.get() );
ClusteringModule clusteringModule = new ClusteringModule( discoveryServiceFactory, identityModule.myself(),
platformModule, clusterStateDirectory.get() );
topologyService = clusteringModule.topologyService();
long logThresholdMillis = config.get( CausalClusteringSettings.unknown_address_logging_throttle );
int maxQueueSize = config.get( CausalClusteringSettings.outgoing_queue_size );
final SenderService raftSender = new SenderService(
new RaftChannelInitializer( new CoreReplicatedContentMarshal(), logProvider, monitors ),
logProvider, platformModule.monitors, maxQueueSize );
life.add( raftSender );
final MessageLogger<MemberId> messageLogger = createMessageLogger( config, life, identityModule.myself() );
RaftOutbound raftOutbound = new RaftOutbound( topologyService, raftSender, clusteringModule.clusterIdentity(),
logProvider, logThresholdMillis );
Outbound<MemberId,RaftMessages.RaftMessage> loggingOutbound = new LoggingOutbound<>( raftOutbound,
identityModule.myself(), messageLogger );
consensusModule = new ConsensusModule( identityModule.myself(), platformModule, loggingOutbound,
clusterStateDirectory.get(), topologyService );
dependencies.satisfyDependency( consensusModule.raftMachine() );
ReplicationModule replicationModule = new ReplicationModule( identityModule.myself(), platformModule, config, consensusModule,
loggingOutbound, clusterStateDirectory.get(), fileSystem, logProvider );
CoreStateMachinesModule coreStateMachinesModule = new CoreStateMachinesModule( identityModule.myself(), platformModule, clusterStateDirectory.get(),
config, replicationModule.getReplicator(), consensusModule.raftMachine(), dependencies, localDatabase );
this.idGeneratorFactory = coreStateMachinesModule.idGeneratorFactory;
this.idTypeConfigurationProvider = coreStateMachinesModule.idTypeConfigurationProvider;
this.labelTokenHolder = coreStateMachinesModule.labelTokenHolder;
this.propertyKeyTokenHolder = coreStateMachinesModule.propertyKeyTokenHolder;
this.relationshipTypeTokenHolder = coreStateMachinesModule.relationshipTypeTokenHolder;
this.lockManager = coreStateMachinesModule.lockManager;
this.commitProcessFactory = coreStateMachinesModule.commitProcessFactory;
this.accessCapability = new LeaderCanWrite( consensusModule.raftMachine() );
CoreServerModule coreServerModule = new CoreServerModule( identityModule, platformModule, consensusModule,
coreStateMachinesModule, replicationModule, clusterStateDirectory.get(), clusteringModule, localDatabase,
messageLogger, databaseHealthSupplier );
editionInvariants( platformModule, dependencies, config, logging, life );
dependencies.satisfyDependency( lockManager );
life.add( consensusModule.raftTimeoutService() );
life.add( coreServerModule.membershipWaiterLifecycle );
}
private MessageLogger<MemberId> createMessageLogger( Config config, LifeSupport life, MemberId myself )
{
final MessageLogger<MemberId> messageLogger;
if ( config.get( CausalClusteringSettings.raft_messages_log_enable ) )
{
File logsDir = config.get( GraphDatabaseSettings.logs_directory );
messageLogger = life.add( new BetterMessageLogger<>( myself, raftMessagesLog( logsDir ) ) );
}
else
{
messageLogger = new NullMessageLogger<>();
}
return messageLogger;
}
private void editionInvariants( PlatformModule platformModule, Dependencies dependencies, Config config,
LogService logging, LifeSupport life )
{
statementLocksFactory = new StatementLocksFactorySelector( lockManager, config, logging ).select();
dependencies.satisfyDependency(
createKernelData( platformModule.fileSystem, platformModule.pageCache, platformModule.storeDir,
config, platformModule.graphDatabaseFacade, life ) );
ioLimiter = new ConfigurableIOLimiter( platformModule.config );
headerInformationFactory = createHeaderInformationFactory();
schemaWriteGuard = createSchemaWriteGuard();
transactionStartTimeout = config.get( GraphDatabaseSettings.transaction_start_timeout );
constraintSemantics = new EnterpriseConstraintSemantics();
coreAPIAvailabilityGuard =
new CoreAPIAvailabilityGuard( platformModule.availabilityGuard, transactionStartTimeout );
registerRecovery( platformModule.databaseInfo, life, dependencies );
publishEditionInfo( dependencies.resolveDependency( UsageData.class ), platformModule.databaseInfo, config );
dependencies.satisfyDependency( createSessionTracker() );
}
public boolean isLeader()
{
return consensusModule.raftMachine().currentRole() == Role.LEADER;
}
private static PrintWriter raftMessagesLog( File logsDir )
{
//noinspection ResultOfMethodCallIgnored
logsDir.mkdirs();
try
{
return new PrintWriter( new FileOutputStream( new File( logsDir, "raft-messages.log" ), true ) );
}
catch ( FileNotFoundException e )
{
throw new RuntimeException( e );
}
}
private SchemaWriteGuard createSchemaWriteGuard()
{
return () -> {};
}
private KernelData createKernelData( FileSystemAbstraction fileSystem, PageCache pageCache, File storeDir,
Config config, GraphDatabaseAPI graphAPI, LifeSupport life )
{
DefaultKernelData kernelData = new DefaultKernelData( fileSystem, pageCache, storeDir, config, graphAPI );
return life.add( kernelData );
}
private TransactionHeaderInformationFactory createHeaderInformationFactory()
{
return () -> new TransactionHeaderInformation( -1, -1, new byte[0] );
}
private void registerRecovery( final DatabaseInfo databaseInfo, LifeSupport life,
final DependencyResolver dependencyResolver )
{
life.addLifecycleListener( ( instance, from, to ) -> {
if ( instance instanceof DatabaseAvailability && LifecycleStatus.STARTED.equals( to ) )
{
doAfterRecoveryAndStartup( databaseInfo, dependencyResolver );
}
} );
}
@Override
protected void doAfterRecoveryAndStartup( DatabaseInfo databaseInfo, DependencyResolver dependencyResolver )
{
super.doAfterRecoveryAndStartup( databaseInfo, dependencyResolver );
if ( dependencyResolver.resolveDependency( RaftMachine.class ).isLeader() )
{
new RemoveOrphanConstraintIndexesOnStartup(
dependencyResolver.resolveDependency( NeoStoreDataSource.class ).getKernel(),
dependencyResolver.resolveDependency( LogService.class ).getInternalLogProvider() ).perform();
}
}
@Override
protected BoltConnectionTracker createSessionTracker()
{
return new StandardBoltConnectionTracker();
}
@Override
public void setupSecurityModule( PlatformModule platformModule, Procedures procedures )
{
EnterpriseEditionModule.setupEnterpriseSecurityModule( platformModule, procedures );
}
}