use std::hash::Hasher;
use std::mem::size_of;
use std::sync::Arc;
use kernel::PARENT_KERNELS;
use vortex_buffer::Buffer;
use vortex_error::VortexResult;
use vortex_error::vortex_bail;
use vortex_error::vortex_ensure;
use vortex_error::vortex_err;
use vortex_error::vortex_panic;
use vortex_session::VortexSession;
use crate::ArrayRef;
use crate::ExecutionCtx;
use crate::ExecutionResult;
use crate::Precision;
use crate::array::Array;
use crate::array::ArrayId;
use crate::array::ArrayView;
use crate::array::VTable;
use crate::arrays::varbinview::BinaryView;
use crate::arrays::varbinview::VarBinViewData;
use crate::arrays::varbinview::array::NUM_SLOTS;
use crate::arrays::varbinview::array::SLOT_NAMES;
use crate::arrays::varbinview::compute::rules::PARENT_RULES;
use crate::buffer::BufferHandle;
use crate::dtype::DType;
use crate::hash::ArrayEq;
use crate::hash::ArrayHash;
use crate::serde::ArrayChildren;
use crate::validity::Validity;
mod kernel;
mod operations;
mod validity;
pub type VarBinViewArray = Array<VarBinView>;
#[derive(Clone, Debug)]
pub struct VarBinView;
impl VarBinView {
pub const ID: ArrayId = ArrayId::new_ref("vortex.varbinview");
}
impl ArrayHash for VarBinViewData {
fn array_hash<H: Hasher>(&self, state: &mut H, precision: Precision) {
for buffer in self.buffers.iter() {
buffer.array_hash(state, precision);
}
self.views.array_hash(state, precision);
}
}
impl ArrayEq for VarBinViewData {
fn array_eq(&self, other: &Self, precision: Precision) -> bool {
self.buffers.len() == other.buffers.len()
&& self
.buffers
.iter()
.zip(other.buffers.iter())
.all(|(a, b)| a.array_eq(b, precision))
&& self.views.array_eq(&other.views, precision)
}
}
impl VTable for VarBinView {
type ArrayData = VarBinViewData;
type OperationsVTable = Self;
type ValidityVTable = Self;
fn id(&self) -> ArrayId {
Self::ID
}
fn nbuffers(array: ArrayView<'_, Self>) -> usize {
array.data_buffers().len() + 1
}
fn validate(
&self,
data: &VarBinViewData,
dtype: &DType,
len: usize,
slots: &[Option<ArrayRef>],
) -> VortexResult<()> {
vortex_ensure!(
slots.len() == NUM_SLOTS,
"VarBinViewArray expected {NUM_SLOTS} slots, found {}",
slots.len()
);
vortex_ensure!(
data.len() == len,
"VarBinViewArray length {} does not match outer length {}",
data.len(),
len
);
vortex_ensure!(
matches!(dtype, DType::Binary(_) | DType::Utf8(_)),
"VarBinViewArray dtype must be binary or utf8, got {dtype}"
);
Ok(())
}
fn buffer(array: ArrayView<'_, Self>, idx: usize) -> BufferHandle {
let ndata = array.data_buffers().len();
if idx < ndata {
array.data_buffers()[idx].clone()
} else if idx == ndata {
array.views_handle().clone()
} else {
vortex_panic!("VarBinViewArray buffer index {idx} out of bounds")
}
}
fn buffer_name(array: ArrayView<'_, Self>, idx: usize) -> Option<String> {
let ndata = array.data_buffers().len();
if idx < ndata {
Some(format!("buffer_{idx}"))
} else if idx == ndata {
Some("views".to_string())
} else {
vortex_panic!("VarBinViewArray buffer_name index {idx} out of bounds")
}
}
fn serialize(
_array: ArrayView<'_, Self>,
_session: &VortexSession,
) -> VortexResult<Option<Vec<u8>>> {
Ok(Some(vec![]))
}
fn deserialize(
&self,
dtype: &DType,
len: usize,
metadata: &[u8],
buffers: &[BufferHandle],
children: &dyn ArrayChildren,
_session: &VortexSession,
) -> VortexResult<crate::array::ArrayParts<Self>> {
if !metadata.is_empty() {
vortex_bail!(
"VarBinViewArray expects empty metadata, got {} bytes",
metadata.len()
);
}
let Some((views_handle, data_handles)) = buffers.split_last() else {
vortex_bail!("Expected at least 1 buffer, got 0");
};
let validity = if children.is_empty() {
Validity::from(dtype.nullability())
} else if children.len() == 1 {
let validity = children.get(0, &Validity::DTYPE, len)?;
Validity::Array(validity)
} else {
vortex_bail!("Expected 0 or 1 children, got {}", children.len());
};
let views_nbytes = views_handle.len();
let expected_views_nbytes = len
.checked_mul(size_of::<BinaryView>())
.ok_or_else(|| vortex_err!("views byte length overflow for len={len}"))?;
if views_nbytes != expected_views_nbytes {
vortex_bail!(
"Expected views buffer length {} bytes, got {} bytes",
expected_views_nbytes,
views_nbytes
);
}
if buffers.iter().any(|b| b.is_on_device()) {
let data = VarBinViewData::try_new_handle(
views_handle.clone(),
Arc::from(data_handles.to_vec()),
dtype.clone(),
validity.clone(),
)?;
let slots = VarBinViewData::make_slots(&validity, len);
return Ok(
crate::array::ArrayParts::new(self.clone(), dtype.clone(), len, data)
.with_slots(slots),
);
}
let data_buffers = data_handles
.iter()
.map(|b| b.as_host().clone())
.collect::<Vec<_>>();
let views = Buffer::<BinaryView>::from_byte_buffer(views_handle.clone().as_host().clone());
let data = VarBinViewData::try_new(
views,
Arc::from(data_buffers),
dtype.clone(),
validity.clone(),
)?;
let slots = VarBinViewData::make_slots(&validity, len);
Ok(crate::array::ArrayParts::new(self.clone(), dtype.clone(), len, data).with_slots(slots))
}
fn slot_name(_array: ArrayView<'_, Self>, idx: usize) -> String {
SLOT_NAMES[idx].to_string()
}
fn reduce_parent(
array: ArrayView<'_, Self>,
parent: &ArrayRef,
child_idx: usize,
) -> VortexResult<Option<ArrayRef>> {
PARENT_RULES.evaluate(array, parent, child_idx)
}
fn execute_parent(
array: ArrayView<'_, Self>,
parent: &ArrayRef,
child_idx: usize,
ctx: &mut ExecutionCtx,
) -> VortexResult<Option<ArrayRef>> {
PARENT_KERNELS.execute(array, parent, child_idx, ctx)
}
fn execute(array: Array<Self>, _ctx: &mut ExecutionCtx) -> VortexResult<ExecutionResult> {
Ok(ExecutionResult::done(array))
}
}
#[cfg(test)]
mod tests {
use vortex_buffer::ByteBufferMut;
use vortex_session::registry::ReadContext;
use super::*;
use crate::ArrayContext;
use crate::IntoArray;
use crate::LEGACY_SESSION;
use crate::assert_arrays_eq;
use crate::serde::SerializeOptions;
use crate::serde::SerializedArray;
#[test]
fn test_nullable_varbinview_serde_roundtrip() {
let array = VarBinViewArray::from_iter_nullable_str([
Some("hello"),
None,
Some("world"),
None,
Some("a moderately long string for testing"),
]);
let dtype = array.dtype().clone();
let len = array.len();
let ctx = ArrayContext::empty();
let serialized = array
.clone()
.into_array()
.serialize(&ctx, &LEGACY_SESSION, &SerializeOptions::default())
.unwrap();
let mut concat = ByteBufferMut::empty();
for buf in serialized {
concat.extend_from_slice(buf.as_ref());
}
let parts = SerializedArray::try_from(concat.freeze()).unwrap();
let decoded = parts
.decode(
&dtype,
len,
&ReadContext::new(ctx.to_ids()),
&LEGACY_SESSION,
)
.unwrap();
assert_arrays_eq!(decoded, array);
}
}