reifydb_core/metrics/

heap.rs

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 ReifyDB

use std::{
	collections::{BTreeMap, BTreeSet, HashMap, HashSet, VecDeque},
	mem,
	ops::Add,
	sync::Arc,
};

use reifydb_codec::{
	key::encoded::EncodedKey,
	row::{bytes::EncodedBytes, shape::fingerprint::RowShapeFingerprint},
};
pub use reifydb_macro::HeapSize;
use reifydb_value::{
	byte_size::ByteSize,
	count::Count,
	util::hash::Hash128,
	value::{
		Value,
		column_view::{ColumnView, ViewData},
		container::{
			bool_array, decimal_array::DecimalView, digest_array, fixed_array, primitive, varlen_array,
		},
		date::Date,
		datetime::DateTime,
		decimal::Decimal,
		dictionary::DictionaryEntryId,
		digest::Digest,
		duration::Duration,
		identity::IdentityId,
		ordered_f32::OrderedF32,
		ordered_f64::OrderedF64,
		partition::Partition,
		row_number::RowNumber,
		time::Time,
		uuid::{Uuid4, Uuid7},
	},
};

use crate::{
	key::any::TaggedKey,
	state::{join::ContentVersion, timer::TimerKind},
	value::index::encoded::EncodedIndexKey,
};

pub trait HeapSize {
	fn heap_size(&self) -> usize;
}

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct StateMemory {
	pub entries: Count,
	pub bytes: ByteSize,
}

impl StateMemory {
	pub const ZERO: Self = Self {
		entries: Count::ZERO,
		bytes: ByteSize::ZERO,
	};

	pub fn new(entries: Count, bytes: ByteSize) -> Self {
		Self {
			entries,
			bytes,
		}
	}
}

impl Add for StateMemory {
	type Output = Self;

	fn add(self, rhs: Self) -> Self {
		Self {
			entries: self.entries + rhs.entries,
			bytes: self.bytes + rhs.bytes,
		}
	}
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct StateCompleteness {
	pub values_complete: bool,
	pub membership_complete: bool,
	pub absences_served: Count,
	pub false_positives: Count,
	pub revocations: Count,
}

impl StateCompleteness {
	pub fn merge(self, rhs: Self) -> Self {
		Self {
			values_complete: self.values_complete && rhs.values_complete,
			membership_complete: self.membership_complete && rhs.membership_complete,
			absences_served: self.absences_served + rhs.absences_served,
			false_positives: self.false_positives + rhs.false_positives,
			revocations: self.revocations + rhs.revocations,
		}
	}
}

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub struct OperatorSample {
	pub memory: Option<StateMemory>,
	pub row_number_cache: Option<StateMemory>,
}

impl OperatorSample {
	pub fn with_memory(memory: StateMemory) -> Self {
		Self {
			memory: Some(memory),
			..Self::default()
		}
	}

	pub fn with_row_number_cache(mut self, memory: StateMemory) -> Self {
		self.row_number_cache = Some(memory);
		self
	}
}

macro_rules! zero_heap {
	($($ty:ty),* $(,)?) => {
		$(impl HeapSize for $ty {
			fn heap_size(&self) -> usize {
				0
			}
		})*
	};
}

zero_heap!(u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize, f32, f64, bool, char, ());
zero_heap!(OrderedF32, OrderedF64, Date, DateTime, Time, Duration, IdentityId, Uuid4, Uuid7, RowNumber, Hash128);
zero_heap!(Partition, RowShapeFingerprint, TimerKind, ContentVersion, DictionaryEntryId);

const BIGNUM_APPROX_HEAP: usize = 32;

impl HeapSize for Decimal {
	fn heap_size(&self) -> usize {
		BIGNUM_APPROX_HEAP
	}
}

impl HeapSize for String {
	fn heap_size(&self) -> usize {
		self.capacity()
	}
}

impl HeapSize for EncodedBytes {
	fn heap_size(&self) -> usize {
		self.as_slice().len()
	}
}

impl HeapSize for EncodedKey {
	fn heap_size(&self) -> usize {
		match self {
			EncodedKey::Inline {
				..
			} => 0,
			EncodedKey::Shared(bytes) => bytes.len() + 2 * mem::size_of::<usize>(),
		}
	}
}

impl HeapSize for TaggedKey {
	fn heap_size(&self) -> usize {
		match self {
			TaggedKey::SortedViewRow(key) => key.run.len(),
			TaggedKey::PartitionedSortedViewRow(key) => key.run.len(),
			TaggedKey::RingBufferMetadata(key) => key.encoded_partition.capacity(),
			TaggedKey::QueueDeduplication(key) => key.tail.heap_size(),
			TaggedKey::IndexEntry(key) => key.key.heap_size(),
			TaggedKey::OperatorState(key) => key.suffix.capacity(),
			_ => 0,
		}
	}
}

impl HeapSize for EncodedIndexKey {
	fn heap_size(&self) -> usize {
		match self {
			EncodedIndexKey::Inline {
				..
			} => 0,
			EncodedIndexKey::Heap(bytes) => bytes.capacity(),
		}
	}
}

impl<T: HeapSize> HeapSize for Option<T> {
	fn heap_size(&self) -> usize {
		self.as_ref().map_or(0, HeapSize::heap_size)
	}
}

impl<T: HeapSize> HeapSize for Vec<T> {
	fn heap_size(&self) -> usize {
		self.capacity() * mem::size_of::<T>() + self.iter().map(HeapSize::heap_size).sum::<usize>()
	}
}

impl<T: HeapSize, const N: usize> HeapSize for [T; N] {
	fn heap_size(&self) -> usize {
		self.iter().map(HeapSize::heap_size).sum::<usize>()
	}
}

impl<T: HeapSize> HeapSize for VecDeque<T> {
	fn heap_size(&self) -> usize {
		self.capacity() * mem::size_of::<T>() + self.iter().map(HeapSize::heap_size).sum::<usize>()
	}
}

impl HeapSize for Digest {
	fn heap_size(&self) -> usize {
		self.bucket_count() * (mem::size_of::<i32>() + mem::size_of::<u64>())
	}
}

impl<T: HeapSize> HeapSize for Box<T> {
	fn heap_size(&self) -> usize {
		mem::size_of::<T>() + (**self).heap_size()
	}
}

impl<T: HeapSize> HeapSize for Arc<T> {
	fn heap_size(&self) -> usize {
		mem::size_of::<usize>() * 2 + mem::size_of::<T>() + (**self).heap_size()
	}
}

impl HeapSize for Arc<str> {
	fn heap_size(&self) -> usize {
		mem::size_of::<usize>() * 2 + self.len()
	}
}

impl<T: HeapSize> HeapSize for Arc<[T]> {
	fn heap_size(&self) -> usize {
		mem::size_of::<usize>() * 2
			+ self.len() * mem::size_of::<T>()
			+ self.iter().map(HeapSize::heap_size).sum::<usize>()
	}
}

impl<T: HeapSize> HeapSize for Box<[T]> {
	fn heap_size(&self) -> usize {
		self.len() * mem::size_of::<T>() + self.iter().map(HeapSize::heap_size).sum::<usize>()
	}
}

impl HeapSize for Box<str> {
	fn heap_size(&self) -> usize {
		self.len()
	}
}

impl<K: HeapSize, V: HeapSize> HeapSize for BTreeMap<K, V> {
	fn heap_size(&self) -> usize {
		self.len() * (mem::size_of::<K>() + mem::size_of::<V>())
			+ self.iter().map(|(k, v)| k.heap_size() + v.heap_size()).sum::<usize>()
	}
}

impl<T: HeapSize> HeapSize for BTreeSet<T> {
	fn heap_size(&self) -> usize {
		self.len() * mem::size_of::<T>() + self.iter().map(HeapSize::heap_size).sum::<usize>()
	}
}

impl<K: HeapSize, V: HeapSize, S> HeapSize for HashMap<K, V, S> {
	fn heap_size(&self) -> usize {
		self.capacity() * (mem::size_of::<K>() + mem::size_of::<V>() + 1)
			+ self.iter().map(|(k, v)| k.heap_size() + v.heap_size()).sum::<usize>()
	}
}

impl<T: HeapSize, S> HeapSize for HashSet<T, S> {
	fn heap_size(&self) -> usize {
		self.capacity() * (mem::size_of::<T>() + 1) + self.iter().map(HeapSize::heap_size).sum::<usize>()
	}
}

impl<A: HeapSize, B: HeapSize> HeapSize for (A, B) {
	fn heap_size(&self) -> usize {
		self.0.heap_size() + self.1.heap_size()
	}
}

impl<A: HeapSize, B: HeapSize, C: HeapSize> HeapSize for (A, B, C) {
	fn heap_size(&self) -> usize {
		self.0.heap_size() + self.1.heap_size() + self.2.heap_size()
	}
}

impl HeapSize for Value {
	fn heap_size(&self) -> usize {
		match self {
			Value::Utf8(text) => text.capacity(),
			Value::Blob(blob) => blob.as_bytes().len(),
			Value::Decimal(_) => BIGNUM_APPROX_HEAP,
			Value::Any(inner) => mem::size_of::<Value>() + inner.heap_size(),
			Value::Digest(digest) => digest.heap_size(),
			Value::List(items) | Value::Tuple(items) => items.heap_size(),
			Value::Record(fields) => {
				fields.capacity() * mem::size_of::<(String, Value)>()
					+ fields.iter()
						.map(|(name, value)| name.capacity() + value.heap_size())
						.sum::<usize>()
			}
			_ => 0,
		}
	}
}

impl HeapSize for ColumnView<'_> {
	fn heap_size(&self) -> usize {
		let nulls = self.logical_nulls().map_or(0, |nulls| nulls.len().div_ceil(8));
		nulls + match &self.data {
			ViewData::Digest {
				container,
				..
			} => {
				varlen_array::heap_size(*container)
					+ digest_array::iter(container)
						.flatten()
						.map(|digest| mem::size_of::<Digest>() + digest.heap_size())
						.sum::<usize>()
			}
			ViewData::Bool(a) => bool_array::heap_size(a),
			ViewData::Decimal(DecimalView::Decimal128(d)) => primitive::heap_size(*d),
			ViewData::Decimal(DecimalView::Decimal256(d)) => primitive::heap_size(*d),
			ViewData::None {
				..
			} => 0,
			ViewData::Float4(a) => primitive::heap_size(*a),
			ViewData::Float8(a) => primitive::heap_size(*a),
			ViewData::Int1(a) => primitive::heap_size(*a),
			ViewData::Int2(a) => primitive::heap_size(*a),
			ViewData::Int4(a) => primitive::heap_size(*a),
			ViewData::Int8(a) => primitive::heap_size(*a),
			ViewData::Uint1(a) => primitive::heap_size(*a),
			ViewData::Uint2(a) => primitive::heap_size(*a),
			ViewData::Uint4(a) => primitive::heap_size(*a),
			ViewData::Uint8(a) => primitive::heap_size(*a),
			ViewData::Date(t) => primitive::heap_size(*t),
			ViewData::DateTime(t) => primitive::heap_size(*t),
			ViewData::Time(t) => primitive::heap_size(*t),
			ViewData::Duration(t) => primitive::heap_size(*t),
			ViewData::IdentityId(u)
			| ViewData::Uuid4(u)
			| ViewData::Uuid7(u)
			| ViewData::Int16(u)
			| ViewData::Uint16(u)
			| ViewData::DictionaryId {
				container: u,
				..
			} => fixed_array::heap_size(u),
			ViewData::Utf8 {
				container: v,
				..
			} => varlen_array::heap_size(*v),
			ViewData::Blob {
				container: v,
				..
			}
			| ViewData::Any {
				container: v,
				..
			} => varlen_array::heap_size(*v),
		}
	}
}

#[cfg(test)]
mod tests {
	use super::HeapSize;

	#[derive(HeapSize)]
	struct DerivedSample {
		name: String,
		values: Vec<u64>,
		count: u64,
	}

	#[test]
	fn derived_heap_size_sums_all_fields() {
		// The derive must sum every field so a heap-owning field added later is picked up
		// automatically, and scalar fields must contribute zero.
		let sample = DerivedSample {
			name: String::with_capacity(32),
			values: Vec::with_capacity(4),
			count: 7,
		};
		assert_eq!(sample.count, 7);
		assert_eq!(sample.heap_size(), 32 + 4 * 8);
	}
}