org.neo4j.memory.MemoryPools Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-common Show documentation
Non-domain infrastructure code that is common to many Neo4j components.
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.memory;

import static org.neo4j.memory.EmptyMemoryTracker.INSTANCE;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

public final class MemoryPools {
    public static final ScopedMemoryPool NO_TRACKING = new NoTrackingMemoryPool();
    private final List pools = new CopyOnWriteArrayList<>();
    private final boolean trackingEnabled;

    public MemoryPools() {
        this(true);
    }

    public MemoryPools(boolean trackingEnabled) {
        this.trackingEnabled = trackingEnabled;
    }

    public GlobalMemoryGroupTracker pool(MemoryGroup group, long limit, String limitSettingName) {
        return this.pool(group, limit, true, limitSettingName);
    }

    public GlobalMemoryGroupTracker pool(MemoryGroup group, long limit, boolean strict, String limitSettingName) {
        var pool = new GlobalMemoryGroupTracker(this, group, limit, strict, trackingEnabled, limitSettingName);
        pools.add(pool);
        return pool;
    }

    public void registerPool(GlobalMemoryGroupTracker pool) {
        pools.add(pool);
    }

    public boolean unregisterPool(GlobalMemoryGroupTracker pool) {
        return pools.remove(pool);
    }

    public List getPools() {
        return new ArrayList<>(pools);
    }

    void releasePool(GlobalMemoryGroupTracker globalMemoryGroupTracker) {
        pools.remove(globalMemoryGroupTracker);
    }

    private static class NoTrackingMemoryPool implements ScopedMemoryPool {
        @Override
        public MemoryGroup group() {
            return MemoryGroup.NO_TRACKING;
        }

        @Override
        public void reserveHeap(long bytes) {}

        @Override
        public void reserveNative(long bytes) {}

        @Override
        public void releaseHeap(long bytes) {}

        @Override
        public void releaseNative(long bytes) {}

        @Override
        public long totalSize() {
            return Long.MAX_VALUE;
        }

        @Override
        public long usedHeap() {
            return 0;
        }

        @Override
        public long usedNative() {
            return 0;
        }

        @Override
        public long totalUsed() {
            return 0;
        }

        @Override
        public long free() {
            return Long.MAX_VALUE;
        }

        @Override
        public void close() {}

        @Override
        public MemoryTracker getPoolMemoryTracker() {
            return INSTANCE;
        }

        @Override
        public void setSize(long size) {}
    }
}