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
use arrow_array::ArrayRef;
use arrow_schema::DataType;
use futures::{future::BoxFuture, FutureExt};
use lance_arrow::DataTypeExt;
use log::trace;

use crate::{
    decoder::{PhysicalPageDecoder, PhysicalPageScheduler},
    encoder::{ArrayEncoder, BufferEncoder, EncodedBuffer, EncodedPage},
    format::pb,
    EncodingsIo,
};

use lance_core::Result;

use super::{bitmap::BitmapEncoder, value::ValueEncoder};

enum DataValidity {
    NoNull,
    SomeNull(Box<dyn PhysicalPageDecoder>),
}

/// A physical scheduler for "basic" fields.  These are fields that have an optional
/// validity bitmap and some kind of values buffer.
///
/// No actual decoding happens here, we are simply aggregating the two buffers.
///
/// If everything is null then there are no data buffers at all.
// TODO: Add support/tests for primitive nulls
// TODO: Add tests for the all-null case
//
// Right now this is always present on primitive fields.  In the future we may use a
// sentinel encoding instead.
#[derive(Debug)]
pub struct BasicPageScheduler {
    validity_decoder: PageValidity,
    values_decoder: Box<dyn PhysicalPageScheduler>,
}

impl BasicPageScheduler {
    /// Creates a new instance that expects a validity bitmap
    pub fn new_nullable(
        validity_decoder: Box<dyn PhysicalPageScheduler>,
        values_decoder: Box<dyn PhysicalPageScheduler>,
    ) -> Self {
        Self {
            validity_decoder: PageValidity::SomeNull(validity_decoder),
            values_decoder,
        }
    }

    /// Create a new instance that does not need a validity bitmap because no item is null
    pub fn new_non_nullable(values_decoder: Box<dyn PhysicalPageScheduler>) -> Self {
        Self {
            validity_decoder: PageValidity::NoNull,
            values_decoder,
        }
    }
}

impl PhysicalPageScheduler for BasicPageScheduler {
    fn schedule_ranges(
        &self,
        ranges: &[std::ops::Range<u32>],
        scheduler: &dyn EncodingsIo,
    ) -> BoxFuture<'static, Result<Box<dyn PhysicalPageDecoder>>> {
        let validity_future = match &self.validity_decoder {
            PageValidity::NoNull => None,
            PageValidity::SomeNull(validity_decoder) => {
                trace!("Scheduling ranges {:?} from validity", ranges);
                Some(validity_decoder.schedule_ranges(ranges, scheduler))
            }
        };

        trace!("Scheduling range {:?} from values", ranges);
        let values_future = self.values_decoder.schedule_ranges(ranges, scheduler);

        async move {
            let validity = match validity_future {
                None => DataValidity::NoNull,
                Some(fut) => DataValidity::SomeNull(fut.await?),
            };
            let values = values_future.await?;
            Ok(Box::new(BasicPageDecoder { validity, values }) as Box<dyn PhysicalPageDecoder>)
        }
        .boxed()
    }
}

struct BasicPageDecoder {
    validity: DataValidity,
    values: Box<dyn PhysicalPageDecoder>,
}

impl PhysicalPageDecoder for BasicPageDecoder {
    fn update_capacity(&self, rows_to_skip: u32, num_rows: u32, buffers: &mut [(u64, bool)]) {
        // No need to look at the validity decoder to know the dest buffer size since it is boolean
        buffers[0].0 = arrow_buffer::bit_util::ceil(num_rows as usize, 8) as u64;
        // The validity buffer is only required if we have some nulls
        buffers[0].1 = match self.validity {
            DataValidity::NoNull => false,
            DataValidity::SomeNull(_) => true,
        };
        self.values
            .update_capacity(rows_to_skip, num_rows, &mut buffers[1..]);
    }

    fn decode_into(&self, rows_to_skip: u32, num_rows: u32, dest_buffers: &mut [bytes::BytesMut]) {
        if let DataValidity::SomeNull(validity_decoder) = &self.validity {
            validity_decoder.decode_into(rows_to_skip, num_rows, &mut dest_buffers[..1]);
        }
        self.values
            .decode_into(rows_to_skip, num_rows, &mut dest_buffers[1..]);
    }
}

#[derive(Debug)]
enum PageValidity {
    NoNull,
    SomeNull(Box<dyn PhysicalPageScheduler>),
}

#[derive(Debug)]
pub struct BasicEncoder {
    column_index: u32,
}

impl BasicEncoder {
    pub fn new(column_index: u32) -> Self {
        Self { column_index }
    }

    fn encode_values(
        arrays: &[ArrayRef],
        buffer_index: u32,
    ) -> Result<(EncodedBuffer, pb::BufferEncoding)> {
        if *arrays[0].data_type() == DataType::Boolean {
            let values = BitmapEncoder::default().encode(arrays)?;
            Ok((
                values,
                pb::BufferEncoding {
                    buffer_encoding: Some(pb::buffer_encoding::BufferEncoding::Bitmap(
                        pb::Bitmap {
                            buffer: Some(pb::Buffer {
                                buffer_index,
                                buffer_type: pb::buffer::BufferType::Page as i32,
                            }),
                        },
                    )),
                },
            ))
        } else {
            let bytes_per_value = arrays[0].data_type().byte_width() as u64;
            debug_assert!(bytes_per_value > 0);
            let values = ValueEncoder::default().encode(arrays)?;
            Ok((
                values,
                pb::BufferEncoding {
                    buffer_encoding: Some(pb::buffer_encoding::BufferEncoding::Value(pb::Value {
                        buffer: Some(pb::Buffer {
                            buffer_index,
                            buffer_type: pb::buffer::BufferType::Page as i32,
                        }),
                        bytes_per_value,
                    })),
                },
            ))
        }
    }
}

impl ArrayEncoder for BasicEncoder {
    fn encode(&self, arrays: &[ArrayRef]) -> Result<EncodedPage> {
        let (null_count, row_count) = arrays
            .iter()
            .map(|arr| (arr.null_count() as u32, arr.len() as u32))
            .fold((0, 0), |acc, val| (acc.0 + val.0, acc.1 + val.1));
        let (buffers, nullability) = if null_count == 0 {
            let (values_buffer, values_encoding) = Self::encode_values(arrays, 0)?;
            let encoding = pb::basic::Nullability::NoNulls(pb::basic::NoNull {
                values: Some(values_encoding),
            });
            (vec![values_buffer], encoding)
        } else if null_count == row_count {
            let encoding = pb::basic::Nullability::AllNulls(pb::basic::AllNull {});
            (vec![], encoding)
        } else {
            let validity_encoding = pb::BufferEncoding {
                buffer_encoding: Some(pb::buffer_encoding::BufferEncoding::Bitmap(pb::Bitmap {
                    buffer: Some(pb::Buffer {
                        buffer_index: 0,
                        buffer_type: pb::buffer::BufferType::Page as i32,
                    }),
                })),
            };
            let (values_buffer, values_encoding) = Self::encode_values(arrays, 1)?;
            let encoding = pb::basic::Nullability::SomeNulls(pb::basic::SomeNull {
                validity: Some(validity_encoding),
                values: Some(values_encoding),
            });
            let validity = BitmapEncoder::default().encode(arrays)?;
            (vec![validity, values_buffer], encoding)
        };

        Ok(EncodedPage {
            buffers,
            encoding: pb::ArrayEncoding {
                array_encoding: Some(pb::array_encoding::ArrayEncoding::Basic(pb::Basic {
                    nullability: Some(nullability),
                })),
            },
            num_rows: row_count,
            column_idx: self.column_index,
        })
    }
}