org.neo4j.kernel.impl.util.collection.HeapTrackingValuesMap 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.

There is a newer version: 5.25.1

Show newest version

/*
 * Copyright (c) "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.util.collection;

import org.neo4j.collection.trackable.HeapTrackingLongObjectHashMap;
import org.neo4j.memory.MemoryTracker;
import org.neo4j.values.storable.Value;

import static org.neo4j.memory.HeapEstimator.shallowSizeOfInstance;

@SuppressWarnings( "ExternalizableWithoutPublicNoArgConstructor" )
public class HeapTrackingValuesMap extends HeapTrackingLongObjectHashMap
{
    private static final long SHALLOW_SIZE = shallowSizeOfInstance( HeapTrackingValuesMap.class );
    private long valuesHeapSize;

    static HeapTrackingValuesMap createValuesMap( MemoryTracker memoryTracker )
    {
        memoryTracker.allocateHeap( SHALLOW_SIZE + arraysHeapSize( DEFAULT_INITIAL_CAPACITY ) );
        return new HeapTrackingValuesMap( memoryTracker, DEFAULT_INITIAL_CAPACITY );
    }

    private HeapTrackingValuesMap( MemoryTracker memoryTracker, int trackedCapacity )
    {
        super( memoryTracker, trackedCapacity );
    }

    @Override
    public Value put( long key, Value value )
    {
        allocate( value );
        Value old = super.put( key, value );
        if ( old != null )
        {
            release( old );
        }
        return old;
    }

    @Override
    public Value remove( long key )
    {
        Value remove = super.remove( key );
        if ( remove != null )
        {
            release( remove );
        }
        return remove;
    }

    @Override
    public void clear()
    {
        super.clear();
        memoryTracker.releaseHeap( valuesHeapSize );
        valuesHeapSize = 0;
    }

    private void allocate( Value value )
    {
        long valueHeapSize = value.estimatedHeapUsage();
        valuesHeapSize += valueHeapSize;
        memoryTracker.allocateHeap( valueHeapSize );
    }

    private void release( Value old )
    {
        long oldHeapSize = old.estimatedHeapUsage();
        valuesHeapSize -= oldHeapSize;
        memoryTracker.releaseHeap( oldHeapSize );
    }
}