org.neo4j.kernel.impl.pagecache.ConfigurableStandalonePageCacheFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.
The newest version!
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://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.pagecache;

import static org.neo4j.configuration.GraphDatabaseSettings.memory_tracking;

import org.neo4j.configuration.Config;
import org.neo4j.configuration.GraphDatabaseSettings;
import org.neo4j.io.ByteUnit;
import org.neo4j.io.fs.FileSystemAbstraction;
import org.neo4j.io.pagecache.PageCache;
import org.neo4j.io.pagecache.tracing.PageCacheTracer;
import org.neo4j.logging.Level;
import org.neo4j.logging.log4j.Log4jLogProvider;
import org.neo4j.logging.log4j.LogConfig;
import org.neo4j.logging.log4j.Neo4jLoggerContext;
import org.neo4j.memory.MemoryPools;
import org.neo4j.scheduler.JobScheduler;
import org.neo4j.time.Clocks;

/*
 * This class is an helper to allow to construct properly a page cache in the few places we need it without all
 * the graph database stuff, e.g., various store dump programs.
 *
 * All other places where a "proper" page cache is available, e.g. in store migration, should have that one injected.
 * And tests should use the ConfigurablePageCacheRule.
 */
public final class ConfigurableStandalonePageCacheFactory {
    private ConfigurableStandalonePageCacheFactory() {}

    public static PageCache createPageCache(
            FileSystemAbstraction fileSystem, JobScheduler jobScheduler, PageCacheTracer pageCacheTracer) {
        var config = Config.defaults();
        return createPageCache(
                fileSystem, pageCacheTracer, config, jobScheduler, new MemoryPools(config.get(memory_tracking)));
    }

    public static PageCache createPageCache(
            FileSystemAbstraction fileSystem,
            Config config,
            JobScheduler jobScheduler,
            PageCacheTracer pageCacheTracer) {
        return createPageCache(
                fileSystem, pageCacheTracer, config, jobScheduler, new MemoryPools(config.get(memory_tracking)));
    }

    /**
     * Create page cache
     * @param fileSystem file system that page cache will be based on
     * @param pageCacheTracer global page cache tracer
     * @param config page cache configuration
     * @param jobScheduler page cache job scheduler
     * @return created page cache instance
     */
    public static PageCache createPageCache(
            FileSystemAbstraction fileSystem,
            PageCacheTracer pageCacheTracer,
            Config config,
            JobScheduler jobScheduler,
            MemoryPools memoryPools) {
        config.setIfNotSet(GraphDatabaseSettings.pagecache_memory, ByteUnit.mebiBytes(8));
        Neo4jLoggerContext loggerContext =
                LogConfig.createBuilderToOutputStream(System.err, Level.INFO).build();

        try (Log4jLogProvider logProvider = new Log4jLogProvider(loggerContext)) {
            ConfiguringPageCacheFactory pageCacheFactory = new ConfiguringPageCacheFactory(
                    fileSystem,
                    config,
                    pageCacheTracer,
                    logProvider.getLog(PageCache.class),
                    jobScheduler,
                    Clocks.nanoClock(),
                    memoryPools);
            return pageCacheFactory.getOrCreatePageCache();
        }
    }
}