-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
PlatformModule.java
359 lines (285 loc) · 14.4 KB
/
PlatformModule.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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/*
* Copyright (c) 2002-2018 "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.graphdb.factory.module;
import java.io.File;
import java.io.IOException;
import org.neo4j.graphdb.facade.GraphDatabaseFacadeFactory;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.graphdb.security.URLAccessRule;
import org.neo4j.index.internal.gbptree.GroupingRecoveryCleanupWorkCollector;
import org.neo4j.index.internal.gbptree.RecoveryCleanupWorkCollector;
import org.neo4j.io.fs.DefaultFileSystemAbstraction;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.fs.FileSystemLifecycleAdapter;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.io.pagecache.tracing.cursor.context.EmptyVersionContextSupplier;
import org.neo4j.io.pagecache.tracing.cursor.context.VersionContextSupplier;
import org.neo4j.kernel.AvailabilityGuard;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.configuration.ConnectorPortRegister;
import org.neo4j.kernel.extension.KernelExtensions;
import org.neo4j.kernel.extension.UnsatisfiedDependencyStrategies;
import org.neo4j.kernel.impl.api.LogRotationMonitor;
import org.neo4j.kernel.impl.context.TransactionVersionContextSupplier;
import org.neo4j.kernel.impl.factory.DatabaseInfo;
import org.neo4j.kernel.impl.factory.GraphDatabaseFacade;
import org.neo4j.kernel.impl.logging.LogService;
import org.neo4j.kernel.impl.logging.StoreLogService;
import org.neo4j.kernel.impl.pagecache.ConfiguringPageCacheFactory;
import org.neo4j.kernel.impl.pagecache.PageCacheLifecycle;
import org.neo4j.kernel.impl.scheduler.CentralJobScheduler;
import org.neo4j.kernel.impl.security.URLAccessRules;
import org.neo4j.kernel.impl.spi.SimpleKernelContext;
import org.neo4j.kernel.impl.transaction.TransactionStats;
import org.neo4j.kernel.impl.transaction.log.checkpoint.CheckPointerMonitor;
import org.neo4j.kernel.impl.transaction.log.checkpoint.StoreCopyCheckPointMutex;
import org.neo4j.kernel.impl.transaction.state.DataSourceManager;
import org.neo4j.kernel.impl.util.collection.CollectionsFactorySupplier;
import org.neo4j.kernel.info.DiagnosticsManager;
import org.neo4j.kernel.info.JvmChecker;
import org.neo4j.kernel.info.JvmMetadataRepository;
import org.neo4j.kernel.internal.KernelEventHandlers;
import org.neo4j.kernel.internal.Version;
import org.neo4j.kernel.internal.locker.GlobalStoreLocker;
import org.neo4j.kernel.internal.locker.StoreLocker;
import org.neo4j.kernel.internal.locker.StoreLockerLifecycleAdapter;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.kernel.monitoring.Monitors;
import org.neo4j.kernel.monitoring.tracing.Tracers;
import org.neo4j.logging.Level;
import org.neo4j.logging.Log;
import org.neo4j.logging.LogProvider;
import org.neo4j.scheduler.JobScheduler;
import org.neo4j.time.Clocks;
import org.neo4j.time.SystemNanoClock;
import org.neo4j.udc.UsageData;
import org.neo4j.udc.UsageDataKeys;
import static org.neo4j.graphdb.factory.GraphDatabaseSettings.store_internal_log_path;
/**
* Platform module for {@link GraphDatabaseFacadeFactory}. This creates
* all the services needed by {@link EditionModule} implementations.
*/
public class PlatformModule
{
public final PageCache pageCache;
public final Monitors monitors;
public final GraphDatabaseFacade graphDatabaseFacade;
public final org.neo4j.kernel.impl.util.Dependencies dependencies;
public final LogService logging;
public final LifeSupport life;
public final File storeDir;
public final DatabaseInfo databaseInfo;
public final DiagnosticsManager diagnosticsManager;
public final KernelEventHandlers eventHandlers;
public final Tracers tracers;
public final Config config;
public final FileSystemAbstraction fileSystem;
public final DataSourceManager dataSourceManager;
public final KernelExtensions kernelExtensions;
public final URLAccessRule urlAccessRule;
public final JobScheduler jobScheduler;
public final AvailabilityGuard availabilityGuard;
public final TransactionStats transactionMonitor;
public final SystemNanoClock clock;
public final StoreCopyCheckPointMutex storeCopyCheckPointMutex;
public final VersionContextSupplier versionContextSupplier;
public final RecoveryCleanupWorkCollector recoveryCleanupWorkCollector;
public final CollectionsFactorySupplier collectionsFactorySupplier;
public final UsageData usageData;
public final ConnectorPortRegister connectorPortRegister;
public PlatformModule( File providedStoreDir, Config config, DatabaseInfo databaseInfo,
GraphDatabaseFacadeFactory.Dependencies externalDependencies, GraphDatabaseFacade graphDatabaseFacade )
{
this.databaseInfo = databaseInfo;
this.dataSourceManager = new DataSourceManager();
dependencies = new org.neo4j.kernel.impl.util.Dependencies(
new DataSourceManager.DependencyResolverSupplier( dataSourceManager ) );
dependencies.satisfyDependency( databaseInfo );
clock = dependencies.satisfyDependency( createClock() );
life = dependencies.satisfyDependency( createLife() );
this.graphDatabaseFacade = dependencies.satisfyDependency( graphDatabaseFacade );
// SPI - provided services
config.augmentDefaults( GraphDatabaseSettings.neo4j_home, providedStoreDir.getAbsolutePath() );
this.config = dependencies.satisfyDependency( config );
this.storeDir = providedStoreDir.getAbsoluteFile();
fileSystem = dependencies.satisfyDependency( createFileSystemAbstraction() );
life.add( new FileSystemLifecycleAdapter( fileSystem ) );
// Component monitoring
monitors = externalDependencies.monitors() == null ? new Monitors() : externalDependencies.monitors();
dependencies.satisfyDependency( monitors );
jobScheduler = life.add( dependencies.satisfyDependency( createJobScheduler() ) );
// Cleanup after recovery, used by GBPTree, added to life in NeoStoreDataSource
recoveryCleanupWorkCollector = new GroupingRecoveryCleanupWorkCollector( jobScheduler );
dependencies.satisfyDependency( recoveryCleanupWorkCollector );
// Database system information, used by UDC
usageData = new UsageData( jobScheduler );
dependencies.satisfyDependency( life.add( usageData ) );
// If no logging was passed in from the outside then create logging and register
// with this life
logging = dependencies.satisfyDependency( createLogService( externalDependencies.userLogProvider() ) );
config.setLogger( logging.getInternalLog( Config.class ) );
life.add( dependencies
.satisfyDependency( new StoreLockerLifecycleAdapter( createStoreLocker() ) ) );
new JvmChecker( logging.getInternalLog( JvmChecker.class ),
new JvmMetadataRepository() ).checkJvmCompatibilityAndIssueWarning();
String desiredImplementationName = config.get( GraphDatabaseSettings.tracer );
tracers = dependencies.satisfyDependency( new Tracers( desiredImplementationName,
logging.getInternalLog( Tracers.class ), monitors, jobScheduler, clock ) );
dependencies.satisfyDependency( tracers.pageCacheTracer );
dependencies.satisfyDependency( firstImplementor(
LogRotationMonitor.class, tracers.transactionTracer, LogRotationMonitor.NULL ) );
dependencies.satisfyDependency( firstImplementor(
CheckPointerMonitor.class, tracers.checkPointTracer, CheckPointerMonitor.NULL ) );
versionContextSupplier = createCursorContextSupplier( config );
collectionsFactorySupplier = createCollectionsFactorySupplier( config );
dependencies.satisfyDependency( versionContextSupplier );
pageCache = dependencies.satisfyDependency( createPageCache( fileSystem, config, logging, tracers,
versionContextSupplier ) );
life.add( new PageCacheLifecycle( pageCache ) );
diagnosticsManager = life.add( dependencies
.satisfyDependency( new DiagnosticsManager( logging.getInternalLog( DiagnosticsManager.class ) ) ) );
dependencies.satisfyDependency( dataSourceManager );
availabilityGuard = dependencies.satisfyDependency( createAvailabilityGuard() );
transactionMonitor = dependencies.satisfyDependency( createTransactionStats() );
kernelExtensions = dependencies.satisfyDependency( new KernelExtensions(
new SimpleKernelContext( storeDir, databaseInfo, dependencies ),
externalDependencies.kernelExtensions(), dependencies, UnsatisfiedDependencyStrategies.fail() ) );
urlAccessRule = dependencies.satisfyDependency( URLAccessRules.combined( externalDependencies.urlAccessRules() ) );
storeCopyCheckPointMutex = new StoreCopyCheckPointMutex();
dependencies.satisfyDependency( storeCopyCheckPointMutex );
connectorPortRegister = new ConnectorPortRegister();
dependencies.satisfyDependency( connectorPortRegister );
eventHandlers = new KernelEventHandlers( logging.getInternalLog( KernelEventHandlers.class ) );
publishPlatformInfo( dependencies.resolveDependency( UsageData.class ) );
}
protected VersionContextSupplier createCursorContextSupplier( Config config )
{
return config.get( GraphDatabaseSettings.snapshot_query ) ? new TransactionVersionContextSupplier()
: EmptyVersionContextSupplier.EMPTY;
}
protected AvailabilityGuard createAvailabilityGuard()
{
return new AvailabilityGuard( clock, logging.getInternalLog( AvailabilityGuard.class ) );
}
protected StoreLocker createStoreLocker()
{
return new GlobalStoreLocker( fileSystem, storeDir );
}
protected SystemNanoClock createClock()
{
return Clocks.nanoClock();
}
@SuppressWarnings( "unchecked" )
private <T> T firstImplementor( Class<T> type, Object... candidates )
{
for ( Object candidate : candidates )
{
if ( type.isInstance( candidate ) )
{
return (T) candidate;
}
}
return null;
}
private void publishPlatformInfo( UsageData sysInfo )
{
sysInfo.set( UsageDataKeys.version, Version.getNeo4jVersion() );
sysInfo.set( UsageDataKeys.revision, Version.getKernelVersion() );
}
public LifeSupport createLife()
{
return new LifeSupport();
}
protected FileSystemAbstraction createFileSystemAbstraction()
{
return new DefaultFileSystemAbstraction();
}
protected LogService createLogService( LogProvider userLogProvider )
{
long internalLogRotationThreshold = config.get( GraphDatabaseSettings.store_internal_log_rotation_threshold );
long internalLogRotationDelay = config.get( GraphDatabaseSettings.store_internal_log_rotation_delay ).toMillis();
int internalLogMaxArchives = config.get( GraphDatabaseSettings.store_internal_log_max_archives );
final StoreLogService.Builder builder =
StoreLogService.withRotation( internalLogRotationThreshold, internalLogRotationDelay,
internalLogMaxArchives, jobScheduler );
if ( userLogProvider != null )
{
builder.withUserLogProvider( userLogProvider );
}
builder.withRotationListener(
logProvider -> diagnosticsManager.dumpAll( logProvider.getLog( DiagnosticsManager.class ) ) );
for ( String debugContext : config.get( GraphDatabaseSettings.store_internal_debug_contexts ) )
{
builder.withLevel( debugContext, Level.DEBUG );
}
builder.withDefaultLevel( config.get( GraphDatabaseSettings.store_internal_log_level ) )
.withTimeZone( config.get( GraphDatabaseSettings.db_timezone ).getZoneId() );
File logFile = config.get( store_internal_log_path );
if ( !logFile.getParentFile().exists() )
{
logFile.getParentFile().mkdirs();
}
StoreLogService logService;
try
{
logService = builder.withInternalLog( logFile ).build( fileSystem );
}
catch ( IOException ex )
{
throw new RuntimeException( ex );
}
return life.add( logService );
}
protected JobScheduler createJobScheduler()
{
return new CentralJobScheduler();
}
protected PageCache createPageCache( FileSystemAbstraction fileSystem, Config config, LogService logging,
Tracers tracers, VersionContextSupplier versionContextSupplier )
{
Log pageCacheLog = logging.getInternalLog( PageCache.class );
ConfiguringPageCacheFactory pageCacheFactory = new ConfiguringPageCacheFactory(
fileSystem, config, tracers.pageCacheTracer, tracers.pageCursorTracerSupplier, pageCacheLog,
versionContextSupplier );
PageCache pageCache = pageCacheFactory.getOrCreatePageCache();
if ( config.get( GraphDatabaseSettings.dump_configuration ) )
{
pageCacheFactory.dumpConfiguration();
}
return pageCache;
}
private CollectionsFactorySupplier createCollectionsFactorySupplier( Config config )
{
final GraphDatabaseSettings.TransactionStateMemoryAllocation allocation = config.get( GraphDatabaseSettings.tx_state_memory_allocation );
switch ( allocation )
{
case ON_HEAP:
return CollectionsFactorySupplier.ON_HEAP;
case OFF_HEAP:
return CollectionsFactorySupplier.OFF_HEAP;
default:
throw new IllegalArgumentException( "Unknown transaction state memory allocation value: " + allocation );
}
}
protected TransactionStats createTransactionStats()
{
return new TransactionStats();
}
}