org.neo4j.memory.HighWaterMarkMemoryPool 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.

There is a newer version: 2025.03.0

/*
 * 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 java.util.concurrent.atomic.LongAccumulator;

/**
 * Specialized memory pool used in parallel runtime that keeps track of the maximum reserved heap.
 */
public class HighWaterMarkMemoryPool extends DelegatingMemoryPool {

    public static HighWaterMarkMemoryPool NO_TRACKING = new HighWaterMarkMemoryPool(MemoryPools.NO_TRACKING);

    LongAccumulator highWaterMark = new LongAccumulator(Long::max, 0L);

    public HighWaterMarkMemoryPool(MemoryPool delegate) {
        super(delegate);
    }

    @Override
    public void reserveHeap(long bytes) {
        super.reserveHeap(bytes);
        highWaterMark.accumulate(usedHeap());
    }

    public long heapHighWaterMark() {
        return highWaterMark.get();
    }

    public void reset() {
        highWaterMark.reset();
    }
}