vortex_array/arrays/varbinview/vtable/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::hash::Hasher;
5use std::mem::size_of;
6use std::sync::Arc;
7
8use vortex_buffer::Buffer;
9use vortex_error::VortexResult;
10use vortex_error::vortex_bail;
11use vortex_error::vortex_ensure;
12use vortex_error::vortex_err;
13use vortex_error::vortex_panic;
14use vortex_session::VortexSession;
15use vortex_session::registry::CachedId;
16
17use crate::ArrayParts;
18use crate::ArrayRef;
19use crate::EqMode;
20use crate::ExecutionCtx;
21use crate::ExecutionResult;
22use crate::array::Array;
23use crate::array::ArrayId;
24use crate::array::ArrayView;
25use crate::array::VTable;
26use crate::arrays::varbinview::BinaryView;
27use crate::arrays::varbinview::VarBinViewData;
28use crate::arrays::varbinview::array::NUM_SLOTS;
29use crate::arrays::varbinview::array::SLOT_NAMES;
30use crate::arrays::varbinview::compute::rules::PARENT_RULES;
31use crate::buffer::BufferHandle;
32use crate::builders::ArrayBuilder;
33use crate::builders::VarBinViewBuilder;
34use crate::dtype::DType;
35use crate::hash::ArrayEq;
36use crate::hash::ArrayHash;
37use crate::serde::ArrayChildren;
38use crate::validity::Validity;
39mod kernel;
40mod operations;
41mod validity;
42/// A [`VarBinView`]-encoded Vortex array.
43pub type VarBinViewArray = Array<VarBinView>;
44
45pub(crate) fn initialize(session: &VortexSession) {
46    kernel::initialize(session);
47}
48
49#[derive(Clone, Debug)]
50pub struct VarBinView;
51
52impl ArrayHash for VarBinViewData {
53    fn array_hash<H: Hasher>(&self, state: &mut H, accuracy: EqMode) {
54        for buffer in self.buffers.iter() {
55            buffer.array_hash(state, accuracy);
56        }
57        self.views.array_hash(state, accuracy);
58    }
59}
60
61impl ArrayEq for VarBinViewData {
62    fn array_eq(&self, other: &Self, accuracy: EqMode) -> bool {
63        self.buffers.len() == other.buffers.len()
64            && self
65                .buffers
66                .iter()
67                .zip(other.buffers.iter())
68                .all(|(a, b)| a.array_eq(b, accuracy))
69            && self.views.array_eq(&other.views, accuracy)
70    }
71}
72
73impl VTable for VarBinView {
74    type TypedArrayData = VarBinViewData;
75
76    type OperationsVTable = Self;
77    type ValidityVTable = Self;
78
79    fn id(&self) -> ArrayId {
80        static ID: CachedId = CachedId::new("vortex.varbinview");
81        *ID
82    }
83
84    fn nbuffers(array: ArrayView<'_, Self>) -> usize {
85        array.data_buffers().len() + 1
86    }
87
88    fn validate(
89        &self,
90        data: &VarBinViewData,
91        dtype: &DType,
92        len: usize,
93        slots: &[Option<ArrayRef>],
94    ) -> VortexResult<()> {
95        vortex_ensure!(
96            slots.len() == NUM_SLOTS,
97            "VarBinViewArray expected {NUM_SLOTS} slots, found {}",
98            slots.len()
99        );
100        vortex_ensure!(
101            data.len() == len,
102            "VarBinViewArray length {} does not match outer length {}",
103            data.len(),
104            len
105        );
106        vortex_ensure!(
107            matches!(dtype, DType::Binary(_) | DType::Utf8(_)),
108            "VarBinViewArray dtype must be binary or utf8, got {dtype}"
109        );
110        Ok(())
111    }
112
113    fn buffer(array: ArrayView<'_, Self>, idx: usize) -> BufferHandle {
114        let ndata = array.data_buffers().len();
115        if idx < ndata {
116            array.data_buffers()[idx].clone()
117        } else if idx == ndata {
118            array.views_handle().clone()
119        } else {
120            vortex_panic!("VarBinViewArray buffer index {idx} out of bounds")
121        }
122    }
123
124    fn buffer_name(array: ArrayView<'_, Self>, idx: usize) -> Option<String> {
125        let ndata = array.data_buffers().len();
126        if idx < ndata {
127            Some(format!("buffer_{idx}"))
128        } else if idx == ndata {
129            Some("views".to_string())
130        } else {
131            vortex_panic!("VarBinViewArray buffer_name index {idx} out of bounds")
132        }
133    }
134
135    fn with_buffers(
136        &self,
137        array: ArrayView<'_, Self>,
138        buffers: &[BufferHandle],
139    ) -> VortexResult<ArrayParts<Self>> {
140        let Some((views, data_buffers)) = buffers.split_last() else {
141            vortex_bail!("Expected at least 1 buffer, got 0");
142        };
143        let data = VarBinViewData::try_new_handle(
144            views.clone(),
145            Arc::from(data_buffers.to_vec()),
146            array.dtype().clone(),
147            array.validity()?,
148        )?;
149        Ok(
150            ArrayParts::new(self.clone(), array.dtype().clone(), array.len(), data)
151                .with_slots(array.slots().iter().cloned().collect()),
152        )
153    }
154
155    fn serialize(
156        _array: ArrayView<'_, Self>,
157        _session: &VortexSession,
158    ) -> VortexResult<Option<Vec<u8>>> {
159        Ok(Some(vec![]))
160    }
161
162    fn deserialize(
163        &self,
164        dtype: &DType,
165        len: usize,
166        metadata: &[u8],
167
168        buffers: &[BufferHandle],
169        children: &dyn ArrayChildren,
170        _session: &VortexSession,
171    ) -> VortexResult<ArrayParts<Self>> {
172        if !metadata.is_empty() {
173            vortex_bail!(
174                "VarBinViewArray expects empty metadata, got {} bytes",
175                metadata.len()
176            );
177        }
178        let Some((views_handle, data_handles)) = buffers.split_last() else {
179            vortex_bail!("Expected at least 1 buffer, got 0");
180        };
181
182        let validity = if children.is_empty() {
183            Validity::from(dtype.nullability())
184        } else if children.len() == 1 {
185            let validity = children.get(0, &Validity::DTYPE, len)?;
186            Validity::Array(validity)
187        } else {
188            vortex_bail!("Expected 0 or 1 children, got {}", children.len());
189        };
190
191        let views_nbytes = views_handle.len();
192        let expected_views_nbytes = len
193            .checked_mul(size_of::<BinaryView>())
194            .ok_or_else(|| vortex_err!("views byte length overflow for len={len}"))?;
195        if views_nbytes != expected_views_nbytes {
196            vortex_bail!(
197                "Expected views buffer length {} bytes, got {} bytes",
198                expected_views_nbytes,
199                views_nbytes
200            );
201        }
202
203        // If any buffer is on device, skip host validation and use try_new_handle.
204        if buffers.iter().any(|b| b.is_on_device()) {
205            let data = VarBinViewData::try_new_handle(
206                views_handle.clone(),
207                Arc::from(data_handles.to_vec()),
208                dtype.clone(),
209                validity.clone(),
210            )?;
211            let slots = VarBinViewData::make_slots(&validity, len);
212            return Ok(ArrayParts::new(self.clone(), dtype.clone(), len, data).with_slots(slots));
213        }
214
215        let data_buffers = data_handles
216            .iter()
217            .map(|b| b.as_host().clone())
218            .collect::<Vec<_>>();
219        let views = Buffer::<BinaryView>::from_byte_buffer(views_handle.clone().as_host().clone());
220
221        let data = VarBinViewData::try_new(
222            views,
223            Arc::from(data_buffers),
224            dtype.clone(),
225            validity.clone(),
226        )?;
227        let slots = VarBinViewData::make_slots(&validity, len);
228        Ok(ArrayParts::new(self.clone(), dtype.clone(), len, data).with_slots(slots))
229    }
230
231    fn slot_name(_array: ArrayView<'_, Self>, idx: usize) -> String {
232        SLOT_NAMES[idx].to_string()
233    }
234
235    fn reduce_parent(
236        array: ArrayView<'_, Self>,
237        parent: &ArrayRef,
238        child_idx: usize,
239    ) -> VortexResult<Option<ArrayRef>> {
240        PARENT_RULES.evaluate(array, parent, child_idx)
241    }
242
243    fn append_to_builder(
244        array: ArrayView<'_, Self>,
245        builder: &mut dyn ArrayBuilder,
246        ctx: &mut ExecutionCtx,
247    ) -> VortexResult<()> {
248        if let Some(builder) = builder.as_any_mut().downcast_mut::<VarBinViewBuilder>() {
249            return builder.append_varbinview_array(&array.into_owned(), ctx);
250        }
251
252        builder.extend_from_array(array.as_ref());
253        Ok(())
254    }
255
256    fn execute(array: Array<Self>, _ctx: &mut ExecutionCtx) -> VortexResult<ExecutionResult> {
257        Ok(ExecutionResult::done(array))
258    }
259}
260
261#[cfg(test)]
262mod tests {
263    use vortex_buffer::ByteBufferMut;
264    use vortex_session::registry::ReadContext;
265
266    use super::*;
267    use crate::ArrayContext;
268    use crate::IntoArray;
269    use crate::VortexSessionExecute;
270    use crate::array_session;
271    use crate::assert_arrays_eq;
272    use crate::serde::SerializeOptions;
273    use crate::serde::SerializedArray;
274
275    #[test]
276    fn test_nullable_varbinview_serde_roundtrip() {
277        let array = VarBinViewArray::from_iter_nullable_str([
278            Some("hello"),
279            None,
280            Some("world"),
281            None,
282            Some("a moderately long string for testing"),
283        ]);
284        let dtype = array.dtype().clone();
285        let len = array.len();
286
287        let session = array_session();
288        let mut ctx = session.create_execution_ctx();
289        let array_ctx = ArrayContext::empty();
290        let serialized = array
291            .clone()
292            .into_array()
293            .serialize(&array_ctx, &session, &SerializeOptions::default())
294            .unwrap();
295
296        let mut concat = ByteBufferMut::empty();
297        for buf in serialized {
298            concat.extend_from_slice(buf.as_ref());
299        }
300        let parts = SerializedArray::try_from(concat.freeze()).unwrap();
301        let decoded = parts
302            .decode(&dtype, len, &ReadContext::new(array_ctx.to_ids()), &session)
303            .unwrap();
304
305        assert_arrays_eq!(decoded, array, &mut ctx);
306    }
307}
vortex_array/arrays/varbinview/vtable/mod.rs

vortex_array/arrays/varbinview/vtable/
mod.rs
