org.neo4j.kernel.impl.index.schema.NativeSchemaIndex Maven / Gradle / Ivy
/*
* Copyright (c) 2018-2020 "Graph Foundation,"
* Graph Foundation, Inc. [https://graphfoundation.org]
*
* This file is part of ONgDB.
*
* ONgDB 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 .
*/
/*
* Copyright (c) 2002-2020 "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 .
*/
package org.neo4j.kernel.impl.index.schema;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.util.function.Consumer;
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.io.pagecache.PageCursor;
import org.neo4j.kernel.api.index.IndexProvider;
import org.neo4j.kernel.api.schema.index.SchemaIndexDescriptor;
import org.neo4j.kernel.impl.index.GBPTreeFileUtil;
import static org.neo4j.index.internal.gbptree.GBPTree.NO_HEADER_READER;
abstract class NativeSchemaIndex, VALUE extends NativeSchemaValue>
{
final PageCache pageCache;
final File storeFile;
final Layout layout;
final GBPTreeFileUtil gbpTreeFileUtil;
final SchemaIndexDescriptor descriptor;
private final long indexId;
private final IndexProvider.Monitor monitor;
protected GBPTree tree;
NativeSchemaIndex( PageCache pageCache, FileSystemAbstraction fs, File storeFile, Layout layout,
IndexProvider.Monitor monitor, SchemaIndexDescriptor descriptor, long indexId )
{
this.pageCache = pageCache;
this.storeFile = storeFile;
this.layout = layout;
this.gbpTreeFileUtil = new GBPTreeFileSystemFileUtil( fs );
this.descriptor = descriptor;
this.indexId = indexId;
this.monitor = monitor;
}
void instantiateTree( RecoveryCleanupWorkCollector recoveryCleanupWorkCollector, Consumer headerWriter )
throws IOException
{
ensureDirectoryExist();
GBPTree.Monitor monitor = treeMonitor();
tree = new GBPTree<>( pageCache, storeFile, layout, 0, monitor, NO_HEADER_READER, headerWriter, recoveryCleanupWorkCollector );
afterTreeInstantiation( tree );
}
protected void afterTreeInstantiation( GBPTree tree )
{ // no-op per default
}
private GBPTree.Monitor treeMonitor( )
{
return new NativeIndexTreeMonitor();
}
private void ensureDirectoryExist() throws IOException
{
// This will create the directory on the "normal" file system.
// When native index is put on blockdevice, page cache file system should be used instead.
gbpTreeFileUtil.mkdirs( storeFile.getParentFile() );
}
void closeTree() throws IOException
{
tree = closeIfPresent( tree );
}
T closeIfPresent( T closeable ) throws IOException
{
if ( closeable != null )
{
closeable.close();
}
return null;
}
void assertOpen()
{
if ( tree == null )
{
throw new IllegalStateException( "Index has been closed" );
}
}
private class NativeIndexTreeMonitor extends GBPTree.Monitor.Adaptor
{
@Override
public void cleanupRegistered()
{
monitor.recoveryCleanupRegistered( storeFile, descriptor );
}
@Override
public void cleanupStarted()
{
monitor.recoveryCleanupStarted( storeFile, descriptor );
}
@Override
public void cleanupFinished( long numberOfPagesVisited, long numberOfCleanedCrashPointers, long durationMillis )
{
monitor.recoveryCleanupFinished( storeFile, descriptor, numberOfPagesVisited, numberOfCleanedCrashPointers, durationMillis );
}
@Override
public void cleanupClosed()
{
monitor.recoveryCleanupClosed( storeFile, descriptor );
}
@Override
public void cleanupFailed( Throwable throwable )
{
monitor.recoveryCleanupFailed( storeFile, descriptor, throwable );
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy