org.elasticsearch.compute.data.BlockRamUsageEstimator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of x-pack-esql-compute Show documentation

Elasticsearch subproject :x-pack:plugin:esql:compute

There is a newer version: 8.16.1

/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0; you may not use this file except in compliance with the Elastic License
 * 2.0.
 */

package org.elasticsearch.compute.data;

import org.apache.lucene.util.RamUsageEstimator;
import org.elasticsearch.core.Nullable;

import java.util.BitSet;

public final class BlockRamUsageEstimator {

    private static final long BITSET_BASE_RAM_USAGE = RamUsageEstimator.shallowSizeOfInstance(BitSet.class);

    /** Returns the size in bytes of the int[] object. Otherwise, returns 0 if null. */
    public static long sizeOf(@Nullable int[] arr) {
        return arr == null ? 0 : RamUsageEstimator.sizeOf(arr);
    }

    /** Returns the size in bytes used by the bitset. Otherwise, returns 0 if null. Not exact, but good enough */
    public static long sizeOfBitSet(@Nullable BitSet bitset) {
        return bitset == null ? 0 : sizeOfBitSet(bitset.size());
    }

    public static long sizeOfBitSet(long size) {
        // BitSet is normally made up of words, represented by longs. So we need to divide and round up.
        long wordCount = (size + Long.SIZE - 1) / Long.SIZE;
        return BITSET_BASE_RAM_USAGE + wordCount * Long.BYTES;
    }
}