1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The Lance Authors

use std::sync::Arc;

use arrow_array::{
    cast::AsArray,
    types::{BinaryType, ByteArrayType, LargeBinaryType, LargeUtf8Type, UInt8Type, Utf8Type},
    Array, ArrayRef, GenericByteArray, GenericListArray, LargeListArray, ListArray, UInt8Array,
};

use arrow_buffer::ScalarBuffer;
use arrow_schema::{DataType, Field};
use futures::future::BoxFuture;
use lance_core::Result;
use log::trace;

use crate::{
    decoder::{
        DecodeArrayTask, LogicalPageDecoder, LogicalPageScheduler, NextDecodeTask, SchedulerContext,
    },
    encoder::{CoreArrayEncodingStrategy, EncodeTask, FieldEncoder},
};

use super::{list::ListFieldEncoder, primitive::PrimitiveFieldEncoder};

// TODO: Support large string, binary, large binary

/// A logical scheduler for utf8/binary pages which assumes the data are encoded as List<u8>
#[derive(Debug)]
pub struct BinaryPageScheduler {
    varbin_scheduler: Arc<dyn LogicalPageScheduler>,
    data_type: DataType,
}

impl BinaryPageScheduler {
    // Create a new ListPageScheduler
    pub fn new(varbin_scheduler: Arc<dyn LogicalPageScheduler>, data_type: DataType) -> Self {
        Self {
            varbin_scheduler,
            data_type,
        }
    }
}

impl LogicalPageScheduler for BinaryPageScheduler {
    fn schedule_ranges(
        &self,
        ranges: &[std::ops::Range<u32>],
        context: &mut SchedulerContext,
        top_level_row: u64,
    ) -> Result<()> {
        trace!("Scheduling binary for {} ranges", ranges.len());
        let mut temp_context = context.temporary(None);
        self.varbin_scheduler
            .schedule_ranges(ranges, &mut temp_context, top_level_row)?;

        for decoder in temp_context.into_decoders() {
            let decoder = Box::new(BinaryPageDecoder {
                inner: decoder,
                data_type: self.data_type.clone(),
            });
            context.emit(decoder);
        }

        Ok(())
    }

    fn schedule_take(
        &self,
        indices: &[u32],
        context: &mut SchedulerContext,
        top_level_row: u64,
    ) -> Result<()> {
        trace!("Scheduling binary for {} indices", indices.len());
        self.schedule_ranges(
            &indices
                .iter()
                .map(|&idx| idx..(idx + 1))
                .collect::<Vec<_>>(),
            context,
            top_level_row,
        )
    }

    fn num_rows(&self) -> u32 {
        self.varbin_scheduler.num_rows()
    }
}

#[derive(Debug)]
pub struct BinaryPageDecoder {
    inner: Box<dyn LogicalPageDecoder>,
    data_type: DataType,
}

impl LogicalPageDecoder for BinaryPageDecoder {
    fn wait(&mut self, num_rows: u32) -> BoxFuture<Result<()>> {
        self.inner.wait(num_rows)
    }

    fn drain(&mut self, num_rows: u32) -> Result<NextDecodeTask> {
        let inner_task = self.inner.drain(num_rows)?;
        Ok(NextDecodeTask {
            has_more: inner_task.has_more,
            num_rows: inner_task.num_rows,
            task: Box::new(BinaryArrayDecoder {
                inner: inner_task.task,
                data_type: self.data_type.clone(),
            }),
        })
    }

    fn unawaited(&self) -> u32 {
        self.inner.unawaited()
    }

    fn avail(&self) -> u32 {
        self.inner.avail()
    }

    fn data_type(&self) -> &DataType {
        &self.data_type
    }
}

pub struct BinaryArrayDecoder {
    inner: Box<dyn DecodeArrayTask>,
    data_type: DataType,
}

impl BinaryArrayDecoder {
    fn from_list_array<T: ByteArrayType>(array: &GenericListArray<T::Offset>) -> ArrayRef {
        let values = array
            .values()
            .as_primitive::<UInt8Type>()
            .values()
            .inner()
            .clone();
        let offsets = array.offsets().clone();
        Arc::new(GenericByteArray::<T>::new(
            offsets,
            values,
            array.nulls().cloned(),
        ))
    }
}

impl DecodeArrayTask for BinaryArrayDecoder {
    fn decode(self: Box<Self>) -> Result<ArrayRef> {
        let data_type = self.data_type;
        let arr = self.inner.decode()?;
        match data_type {
            DataType::Binary => Ok(Self::from_list_array::<BinaryType>(arr.as_list::<i32>())),
            DataType::LargeBinary => Ok(Self::from_list_array::<LargeBinaryType>(
                arr.as_list::<i64>(),
            )),
            DataType::Utf8 => Ok(Self::from_list_array::<Utf8Type>(arr.as_list::<i32>())),
            DataType::LargeUtf8 => Ok(Self::from_list_array::<LargeUtf8Type>(arr.as_list::<i64>())),
            _ => panic!("Binary decoder does not support this data type"),
        }
    }
}

/// An encoder which encodes string arrays as List<u8>
pub struct BinaryFieldEncoder {
    varbin_encoder: Box<dyn FieldEncoder>,
}

impl BinaryFieldEncoder {
    pub fn new(cache_bytes_per_column: u64, keep_original_array: bool, column_index: u32) -> Self {
        let items_encoder = Box::new(
            PrimitiveFieldEncoder::try_new(
                cache_bytes_per_column,
                keep_original_array,
                Arc::new(CoreArrayEncodingStrategy),
                column_index + 1,
            )
            .unwrap(),
        );
        Self {
            varbin_encoder: Box::new(ListFieldEncoder::new(
                items_encoder,
                cache_bytes_per_column,
                keep_original_array,
                column_index,
            )),
        }
    }

    fn byte_to_list_array<T: ByteArrayType<Offset = i32>>(
        array: &GenericByteArray<T>,
    ) -> ListArray {
        let values = UInt8Array::new(
            ScalarBuffer::<u8>::new(array.values().clone(), 0, array.values().len()),
            None,
        );
        let list_field = Field::new("item", DataType::UInt8, true);
        ListArray::new(
            Arc::new(list_field),
            array.offsets().clone(),
            Arc::new(values),
            array.nulls().cloned(),
        )
    }

    fn byte_to_large_list_array<T: ByteArrayType<Offset = i64>>(
        array: &GenericByteArray<T>,
    ) -> LargeListArray {
        let values = UInt8Array::new(
            ScalarBuffer::<u8>::new(array.values().clone(), 0, array.values().len()),
            None,
        );
        let list_field = Field::new("item", DataType::UInt8, true);
        LargeListArray::new(
            Arc::new(list_field),
            array.offsets().clone(),
            Arc::new(values),
            array.nulls().cloned(),
        )
    }

    fn to_list_array(array: ArrayRef) -> ArrayRef {
        match array.data_type() {
            DataType::Utf8 => Arc::new(Self::byte_to_list_array(array.as_string::<i32>())),
            DataType::LargeUtf8 => {
                Arc::new(Self::byte_to_large_list_array(array.as_string::<i64>()))
            }
            DataType::Binary => Arc::new(Self::byte_to_list_array(array.as_binary::<i32>())),
            DataType::LargeBinary => {
                Arc::new(Self::byte_to_large_list_array(array.as_binary::<i64>()))
            }
            _ => panic!("Binary encoder does not support {}", array.data_type()),
        }
    }
}

impl FieldEncoder for BinaryFieldEncoder {
    fn maybe_encode(&mut self, array: ArrayRef) -> Result<Vec<EncodeTask>> {
        let list_array = Self::to_list_array(array);
        self.varbin_encoder.maybe_encode(Arc::new(list_array))
    }

    fn flush(&mut self) -> Result<Vec<EncodeTask>> {
        self.varbin_encoder.flush()
    }

    fn num_columns(&self) -> u32 {
        2
    }
}

#[cfg(test)]
mod tests {
    use arrow_schema::{DataType, Field};

    use crate::testing::check_round_trip_encoding_random;

    #[test_log::test(tokio::test)]
    async fn test_utf8() {
        let field = Field::new("", DataType::Utf8, false);
        check_round_trip_encoding_random(field).await;
    }

    #[test_log::test(tokio::test)]
    async fn test_binary() {
        let field = Field::new("", DataType::Binary, false);
        check_round_trip_encoding_random(field).await;
    }

    #[test_log::test(tokio::test)]
    async fn test_large_binary() {
        let field = Field::new("", DataType::LargeBinary, true);
        check_round_trip_encoding_random(field).await;
    }

    #[test_log::test(tokio::test)]
    async fn test_large_utf8() {
        let field = Field::new("", DataType::LargeUtf8, true);
        check_round_trip_encoding_random(field).await;
    }
}