org.neo4j.kernel.impl.util.collection.ConcurrentProbeTable 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 [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.util.collection;

import static java.util.Collections.emptyIterator;
import static org.neo4j.memory.HeapEstimator.SCOPED_MEMORY_TRACKER_SHALLOW_SIZE;
import static org.neo4j.memory.HeapEstimator.shallowSizeOfInstance;

import java.util.Iterator;
import java.util.Set;
import org.apache.commons.lang3.mutable.MutableLong;
import org.neo4j.collection.trackable.HeapTrackingConcurrentHashMap;
import org.neo4j.internal.kernel.api.DefaultCloseListenable;
import org.neo4j.memory.Measurable;
import org.neo4j.memory.MemoryTracker;

/**
 * A specialized table used during hash joins.
 * @param  key type
 * @param  value type
 */
public class ConcurrentProbeTable extends DefaultCloseListenable {
    private static final long SHALLOW_SIZE = shallowSizeOfInstance(ConcurrentProbeTable.class);
    private final MemoryTracker scopedMemoryTracker;
    private HeapTrackingConcurrentHashMap> map;

    public static  ConcurrentProbeTable createProbeTable(
            MemoryTracker memoryTracker) {
        MemoryTracker scopedMemoryTracker = memoryTracker.getScopedMemoryTracker();
        scopedMemoryTracker.allocateHeap(SHALLOW_SIZE + SCOPED_MEMORY_TRACKER_SHALLOW_SIZE);
        return new ConcurrentProbeTable<>(scopedMemoryTracker);
    }

    private ConcurrentProbeTable(MemoryTracker scopedMemoryTracker) {
        this.scopedMemoryTracker = scopedMemoryTracker;
        this.map = HeapTrackingConcurrentHashMap.newMap(scopedMemoryTracker);
    }

    public void put(K key, V value) {
        MutableLong heapUsage = new MutableLong(value.estimatedHeapUsage() + ConcurrentBag.SIZE_OF_NODE);
        var newBag = new ConcurrentBag();
        ConcurrentBag oldBag = map.putIfAbsent(key, newBag);
        if (oldBag == null) {
            heapUsage.add(key.estimatedHeapUsage() + map.sizeOfWrapperObject() + ConcurrentBag.SIZE_OF_BAG);
            oldBag = newBag;
        }
        oldBag.add(value);
        scopedMemoryTracker.allocateHeap(heapUsage.longValue());
    }

    public Iterator get(K key) {
        var entry = map.get(key);
        if (entry == null) {
            return emptyIterator();
        }
        return entry.iterator();
    }

    public boolean isEmpty() {
        return map.isEmpty();
    }

    public Set keySet() {
        return map.keySet();
    }

    @Override
    public void closeInternal() {
        if (map != null) {
            scopedMemoryTracker.close();
            map = null;
        }
    }

    @Override
    public boolean isClosed() {
        return map == null;
    }
}