1#![forbid(unsafe_code)]
34
35use std::cmp::Ordering;
36use std::collections::{HashMap, VecDeque};
37use std::fs::{File, OpenOptions};
38use std::io::{Read, Seek, SeekFrom};
39use std::mem::{size_of, size_of_val};
40use std::path::Path;
41use std::slice;
42use std::sync::atomic::{AtomicUsize, Ordering as Atomic};
43use std::sync::{Arc, Mutex, OnceLock};
44
45use rudb_common::bounds::{Bound, Op, scaled_as};
46use rudb_common::{Error, Field, LogicalType, PhysicalType, Result, Value};
47use rudb_encoding::{bitpack, chooser, integer, string};
48use rudb_storage::sieve::Sieve;
49use rudb_storage::{Probe, Range, Zone};
50use rudb_vector::string::StringColumn;
51use rudb_vector::validity::Validity;
52use rudb_vector::{Buffer, Chunk, Data, Packed, TextSource, Vector, search_below};
53
54mod zones;
55
56pub use zones::{Common, Stripes, distincts};
57
58const MAGIC: &[u8; 8] = b"RUDBNV10";
59const DIRECTORY: &[u8; 8] = b"RUDBDI10";
60const CATALOG: &[u8; 8] = b"RUDBCA10";
61const FORMAT: u32 = 22;
62const HEADER: u64 = 80;
63const SLOT_BYTES: usize = 28;
64const MAX_PAGE: usize = 256 * 1024 * 1024;
65const MAX_DIRECTORY: usize = 128 * 1024 * 1024;
66const FREQUENCIES: &[u8; 8] = b"RUDBFQ2\0";
67const FREQUENCY_CANDIDATES: usize = 32_768;
68const FREQUENCY_ENTRIES: usize = 512;
69const FREQUENCY_BUILD_RANK: usize = 10;
70const FREQUENCY_ORDINALS: usize = 65_536;
71const MAX_FREQUENCY_WORKERS: usize = 32;
78
79const MAX_ENCODE_WORKERS: usize = 32;
86
87const SIEVE_BUDGET: usize = 8 * 1024;
95
96const PART_BOUND_BYTES: usize = 24;
105
106fn io(error: std::io::Error) -> Error {
107 Error::io(error.to_string())
108}
109
110fn invalid(message: &str) -> Error {
111 Error::invalid_input(format!("invalid rudb native file: {message}"))
112}
113
114fn sum(counts: impl Iterator<Item = u64>) -> u64 {
116 counts.fold(0, u64::saturating_add)
117}
118
119fn span_bytes(spans: &[Span], at: usize) -> u64 {
121 spans.get(at).map_or(0, |span| u64::from(span.length))
122}
123
124fn page_bytes(pages: &[Option<Page>], at: usize) -> u64 {
126 pages.get(at).and_then(Option::as_ref).map_or(0, Page::bytes)
127}
128
129fn checksum(bytes: &[u8]) -> u64 {
130 const P1: u64 = 11_400_714_785_074_694_791;
131 const P2: u64 = 14_029_467_366_897_019_727;
132 const P3: u64 = 1_609_587_929_392_839_161;
133 const P4: u64 = 9_650_029_242_287_828_579;
134 const P5: u64 = 2_870_177_450_012_600_261;
135 let round = |state: u64, word: u64| {
136 state.wrapping_add(word.wrapping_mul(P2)).rotate_left(31).wrapping_mul(P1)
137 };
138 let merge = |state: u64, lane: u64| (state ^ round(0, lane)).wrapping_mul(P1).wrapping_add(P4);
139 let word =
140 |at: usize| u64::from_le_bytes(bytes[at..at + 8].try_into().expect("eight checksum bytes"));
141
142 let mut at = 0;
143 let mut hash = if bytes.len() >= 32 {
144 let mut one = P1.wrapping_add(P2);
145 let mut two = P2;
146 let mut three = 0;
147 let mut four = 0_u64.wrapping_sub(P1);
148 while at + 32 <= bytes.len() {
149 one = round(one, word(at));
150 two = round(two, word(at + 8));
151 three = round(three, word(at + 16));
152 four = round(four, word(at + 24));
153 at += 32;
154 }
155 let combined = one
156 .rotate_left(1)
157 .wrapping_add(two.rotate_left(7))
158 .wrapping_add(three.rotate_left(12))
159 .wrapping_add(four.rotate_left(18));
160 merge(merge(merge(merge(combined, one), two), three), four)
161 } else {
162 P5
163 };
164 hash = hash.wrapping_add(bytes.len() as u64);
165 while at + 8 <= bytes.len() {
166 hash ^= round(0, word(at));
167 hash = hash.rotate_left(27).wrapping_mul(P1).wrapping_add(P4);
168 at += 8;
169 }
170 if at + 4 <= bytes.len() {
171 let tail = u32::from_le_bytes(bytes[at..at + 4].try_into().expect("four checksum bytes"));
172 hash ^= u64::from(tail).wrapping_mul(P1);
173 hash = hash.rotate_left(23).wrapping_mul(P2).wrapping_add(P3);
174 at += 4;
175 }
176 while at < bytes.len() {
177 hash ^= u64::from(bytes[at]).wrapping_mul(P5);
178 hash = hash.rotate_left(11).wrapping_mul(P1);
179 at += 1;
180 }
181 hash ^= hash >> 33;
182 hash = hash.wrapping_mul(P2);
183 hash ^= hash >> 29;
184 hash = hash.wrapping_mul(P3);
185 hash ^ (hash >> 32)
186}
187
188#[derive(Debug, Clone, Copy)]
189struct Slot {
190 offset: u64,
191 length: u32,
192 generation: u64,
193 hash: u64,
194}
195
196impl Slot {
197 fn bytes(self) -> [u8; SLOT_BYTES] {
198 let mut result = [0; SLOT_BYTES];
199 result[..8].copy_from_slice(&self.offset.to_le_bytes());
200 result[8..12].copy_from_slice(&self.length.to_le_bytes());
201 result[12..20].copy_from_slice(&self.generation.to_le_bytes());
202 result[20..28].copy_from_slice(&self.hash.to_le_bytes());
203 result
204 }
205
206 fn read(bytes: &[u8]) -> Self {
207 Self {
208 offset: u64::from_le_bytes(bytes[..8].try_into().expect("eight bytes")),
209 length: u32::from_le_bytes(bytes[8..12].try_into().expect("four bytes")),
210 generation: u64::from_le_bytes(bytes[12..20].try_into().expect("eight bytes")),
211 hash: u64::from_le_bytes(bytes[20..28].try_into().expect("eight bytes")),
212 }
213 }
214}
215
216#[derive(Debug, Clone, Copy)]
217struct Page {
218 offset: u64,
219 length: u32,
220 hash: u64,
221}
222
223impl Page {
224 fn bytes(&self) -> u64 {
226 u64::from(self.length)
227 }
228}
229
230#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
231enum FrequencyValue {
232 Null,
233 Integer(i128),
234 Code(u32),
235}
236
237#[derive(Debug, Clone)]
238struct FrequencyEntry {
239 value: FrequencyValue,
240 count: u64,
241}
242
243#[derive(Debug, Clone)]
248struct FrequencySummary {
249 entries: Vec<FrequencyEntry>,
250 omitted_max: u64,
251 ordinals: Vec<u64>,
252}
253
254#[derive(Debug, Clone, PartialEq, Eq)]
256pub struct FrequencyOccurrences {
257 pub omitted_max: u64,
259 pub ordinals: Vec<u64>,
261}
262
263#[derive(Debug, Clone, Copy, Default)]
270struct Span {
271 offset: u64,
272 length: u32,
273}
274
275#[derive(Debug, Clone)]
277pub struct Stripe {
278 rows: usize,
279 parts: Vec<u32>,
282 index: Span,
286 pages: Vec<Span>,
287 memberships: Vec<Option<Page>>,
288 sieves: Vec<Option<Page>>,
291 part_ranges: Vec<Option<Page>>,
302 zone: Zone,
303}
304
305impl Stripe {
306 #[must_use]
308 pub fn rows(&self) -> usize {
309 self.rows
310 }
311
312 #[must_use]
314 pub fn parts(&self) -> usize {
315 self.parts.len()
316 }
317
318 #[must_use]
324 pub fn zone(&self) -> &Zone {
325 &self.zone
326 }
327}
328
329#[derive(Debug, Clone)]
331pub struct Table {
332 name: String,
333 fields: Vec<Field>,
334 stripes: Vec<Stripe>,
335 rows: usize,
336 dictionaries: Vec<Option<Page>>,
337 frequencies: Vec<Option<FrequencySummary>>,
338 distincts: Vec<Option<u64>>,
348}
349
350impl Table {
351 #[must_use]
353 pub fn name(&self) -> &str {
354 &self.name
355 }
356
357 #[must_use]
359 pub fn fields(&self) -> &[Field] {
360 &self.fields
361 }
362
363 #[must_use]
365 pub fn rows(&self) -> usize {
366 self.rows
367 }
368
369 #[must_use]
371 pub fn stripes(&self) -> &[Stripe] {
372 &self.stripes
373 }
374}
375
376#[derive(Debug, Clone)]
388struct Entry {
389 name: String,
390 fields: Vec<Field>,
391 rows: usize,
392 directory: Page,
394}
395
396#[derive(Debug, Clone)]
398pub struct ColumnLayout {
399 pub name: String,
401 pub kind: String,
403 pub pages: u64,
405 pub memberships: u64,
407 pub sieves: u64,
409 pub part_ranges: u64,
411 pub dictionary: u64,
413}
414
415impl ColumnLayout {
416 #[must_use]
418 pub fn total(&self) -> u64 {
419 self.pages
420 .saturating_add(self.memberships)
421 .saturating_add(self.sieves)
422 .saturating_add(self.part_ranges)
423 .saturating_add(self.dictionary)
424 }
425}
426
427#[derive(Debug, Clone)]
438pub struct Layout {
439 pub file: u64,
441 pub rows: usize,
443 pub stripes: usize,
445 pub parts: usize,
447 pub columns: Vec<ColumnLayout>,
449 pub indexes: u64,
452 pub directory: u64,
454 pub header: u64,
456}
457
458impl Layout {
459 #[must_use]
461 pub fn columns_total(&self) -> u64 {
462 self.columns.iter().map(ColumnLayout::total).fold(0, u64::saturating_add)
463 }
464
465 #[must_use]
471 pub fn unaccounted(&self) -> u64 {
472 self.file
473 .saturating_sub(self.columns_total())
474 .saturating_sub(self.indexes)
475 .saturating_sub(self.directory)
476 .saturating_sub(self.header)
477 }
478}
479
480#[derive(Debug)]
482struct GlobalDictionary {
483 primary: HashMap<u64, u32>,
484 collisions: HashMap<u64, Vec<u32>>,
485 offsets: Vec<u32>,
486 payload: Vec<u8>,
487 counts: Vec<u64>,
488 nulls: u64,
489}
490
491impl GlobalDictionary {
492 fn new() -> Self {
493 Self {
494 primary: HashMap::new(),
495 collisions: HashMap::new(),
496 offsets: vec![0],
497 payload: Vec::new(),
498 counts: Vec::new(),
499 nulls: 0,
500 }
501 }
502
503 fn bytes(&self, code: u32) -> Option<&[u8]> {
504 let start = *self.offsets.get(code as usize)? as usize;
505 let end = *self.offsets.get(code as usize + 1)? as usize;
506 self.payload.get(start..end)
507 }
508
509 fn code(&mut self, text: &str) -> Result<u32> {
510 let hash = checksum(text.as_bytes());
511 if let Some(&code) = self.primary.get(&hash) {
512 if self.bytes(code) == Some(text.as_bytes()) {
513 return Ok(code);
514 }
515 if let Some(codes) = self.collisions.get(&hash) {
516 if let Some(code) =
517 codes.iter().copied().find(|&code| self.bytes(code) == Some(text.as_bytes()))
518 {
519 return Ok(code);
520 }
521 }
522 let code = self.insert(text)?;
523 self.collisions.entry(hash).or_default().push(code);
524 return Ok(code);
525 }
526 let code = self.insert(text)?;
527 self.primary.insert(hash, code);
528 Ok(code)
529 }
530
531 fn insert(&mut self, text: &str) -> Result<u32> {
532 let code = u32::try_from(self.offsets.len() - 1)
533 .map_err(|_| invalid("global dictionary has too many values"))?;
534 self.payload.extend_from_slice(text.as_bytes());
535 self.offsets.push(
536 u32::try_from(self.payload.len())
537 .map_err(|_| invalid("global dictionary payload exceeds 4 GiB"))?,
538 );
539 self.counts.push(0);
540 Ok(code)
541 }
542
543 fn ranked(&self) -> Vec<(u64, u32)> {
563 let count = self.offsets.len() - 1;
564 let mut ranked = (0..count)
565 .map(|code| {
566 let code = code as u32;
567 (head(self.bytes(code).unwrap_or_default()), code)
568 })
569 .collect::<Vec<_>>();
570 ranked.sort_unstable_by(|left, right| {
571 left.0.cmp(&right.0).then_with(|| self.bytes(left.1).cmp(&self.bytes(right.1)))
572 });
573 ranked
574 }
575
576 fn observe(&mut self, code: u32, null: bool) -> Result<()> {
577 if null {
578 self.nulls = self.nulls.saturating_add(1);
579 return Ok(());
580 }
581 let count = self
582 .counts
583 .get_mut(code as usize)
584 .ok_or_else(|| invalid("global dictionary count code is out of range"))?;
585 *count = count.saturating_add(1);
586 Ok(())
587 }
588}
589
590#[derive(Debug)]
598pub struct Writer {
599 file: File,
600 at: u64,
608 table: Table,
609 generation: u64,
610 order: Vec<((u64, u64), (u64, u64))>,
613 next_order: u64,
614 dictionaries: Vec<Option<GlobalDictionary>>,
615 pending: Vec<PendingChunk>,
616 closed: Vec<Entry>,
618}
619
620#[derive(Debug)]
628struct PendingChunk {
629 order: (u64, u64),
630 chunk: Chunk,
631}
632
633#[derive(Debug)]
639struct ColumnStripe {
640 pages: Vec<Vec<u8>>,
641 codes: Vec<Option<Vec<u32>>>,
642 sieves: Vec<Option<Sieve>>,
643 ranges: Vec<Range>,
644}
645
646fn weight(ty: &LogicalType) -> usize {
654 match ty {
655 LogicalType::Varchar | LogicalType::Blob => 64,
656 LogicalType::BigInt
657 | LogicalType::UBigInt
658 | LogicalType::Timestamp
659 | LogicalType::Double
660 | LogicalType::Decimal { .. } => 8,
661 LogicalType::Integer | LogicalType::UInteger | LogicalType::Date | LogicalType::Float => 4,
662 LogicalType::SmallInt | LogicalType::USmallInt => 2,
663 _ => 1,
664 }
665}
666
667pub const STRIPE_PARTS: usize = 64;
674
675const INDEX_ENTRY: usize = size_of::<u32>() + size_of::<u64>();
677
678fn index_section(parts: usize) -> Result<usize> {
680 parts
681 .checked_mul(INDEX_ENTRY)
682 .and_then(|bytes| bytes.checked_add(size_of::<u64>()))
683 .ok_or_else(|| invalid("index page length overflow"))
684}
685
686impl Writer {
687 pub fn create(
693 path: impl AsRef<Path>,
694 name: impl Into<String>,
695 fields: Vec<Field>,
696 ) -> Result<Self> {
697 for field in &fields {
698 type_tag(&field.ty)?;
699 }
700 let file =
701 OpenOptions::new().write(true).read(true).create_new(true).open(path).map_err(io)?;
702 let mut header = [0; HEADER as usize];
703 header[..8].copy_from_slice(MAGIC);
704 header[8..12].copy_from_slice(&FORMAT.to_le_bytes());
705 write_at(&file, 0, &header)?;
706 Ok(Self {
707 file,
708 at: HEADER,
709 dictionaries: fields
710 .iter()
711 .map(|field| (field.ty == LogicalType::Varchar).then(GlobalDictionary::new))
712 .collect(),
713 table: Table {
714 name: name.into(),
715 dictionaries: vec![None; fields.len()],
716 distincts: vec![None; fields.len()],
717 fields,
718 stripes: Vec::new(),
719 rows: 0,
720 frequencies: Vec::new(),
721 },
722 generation: 1,
723 order: Vec::new(),
724 next_order: 0,
725 pending: Vec::with_capacity(STRIPE_PARTS),
726 closed: Vec::new(),
727 })
728 }
729
730 pub fn next(mut self, name: impl Into<String>, fields: Vec<Field>) -> Result<Self> {
741 for field in &fields {
742 type_tag(&field.ty)?;
743 }
744 let name = name.into();
745 let entry = self.close()?;
746 if self.closed.iter().chain(std::iter::once(&entry)).any(|held| held.name == name) {
747 return Err(invalid("two tables in one native file have the same name"));
748 }
749 let Self { file, at, generation, mut closed, .. } = self;
750 closed.push(entry);
751 Ok(Self {
752 file,
753 at,
754 generation,
755 closed,
756 dictionaries: fields
757 .iter()
758 .map(|field| (field.ty == LogicalType::Varchar).then(GlobalDictionary::new))
759 .collect(),
760 table: Table {
761 name,
762 dictionaries: vec![None; fields.len()],
763 distincts: vec![None; fields.len()],
764 fields,
765 stripes: Vec::new(),
766 rows: 0,
767 frequencies: Vec::new(),
768 },
769 order: Vec::new(),
770 next_order: 0,
771 pending: Vec::with_capacity(STRIPE_PARTS),
772 })
773 }
774
775 fn put(&mut self, bytes: &[u8]) -> Result<()> {
780 write_at(&self.file, self.at, bytes)?;
781 self.at = self
782 .at
783 .checked_add(bytes.len() as u64)
784 .ok_or_else(|| invalid("native file length overflow"))?;
785 Ok(())
786 }
787
788 pub fn append(&mut self, chunk: &Chunk) -> Result<()> {
794 let order = (self.next_order, 0);
795 self.next_order = self.next_order.saturating_add(1);
796 self.append_at(order, chunk)
797 }
798
799 pub fn append_at(&mut self, order: (u64, u64), chunk: &Chunk) -> Result<()> {
810 if chunk.is_empty() {
811 return Ok(());
812 }
813 self.admit(chunk)?;
814 if self.pending.last().is_some_and(|last| last.order > order) {
815 self.flush_pending()?;
816 }
817 self.pending.push(PendingChunk { order, chunk: chunk.clone() });
822 if self.pending.len() == STRIPE_PARTS {
823 self.flush_pending()?;
824 }
825 Ok(())
826 }
827
828 pub fn append_stripe(&mut self, parts: Vec<((u64, u64), Chunk)>) -> Result<()> {
844 if parts.len() > STRIPE_PARTS {
845 return Err(invalid("a stripe was handed more parts than it holds"));
846 }
847 self.flush_pending()?;
850 for (order, chunk) in parts {
851 if chunk.is_empty() {
852 continue;
853 }
854 self.admit(&chunk)?;
855 self.pending.push(PendingChunk { order, chunk });
856 }
857 self.flush_pending()
858 }
859
860 fn admit(&mut self, chunk: &Chunk) -> Result<()> {
862 if chunk.width() != self.table.fields.len() {
863 return Err(invalid("chunk width differs from table schema"));
864 }
865 for (index, field) in self.table.fields.iter().enumerate() {
866 if chunk.column(index)?.logical_type() != &field.ty {
867 return Err(invalid("chunk type differs from table schema"));
868 }
869 }
870 self.table.rows = self
871 .table
872 .rows
873 .checked_add(chunk.len())
874 .ok_or_else(|| invalid("row count overflow"))?;
875 Ok(())
876 }
877
878 fn encode_column(
886 index: usize,
887 held: &[PendingChunk],
888 mut dictionary: Option<&mut GlobalDictionary>,
889 ) -> Result<ColumnStripe> {
890 let mut stripe = ColumnStripe {
891 pages: Vec::with_capacity(held.len()),
892 codes: Vec::with_capacity(held.len()),
893 sieves: Vec::with_capacity(held.len()),
894 ranges: Vec::with_capacity(held.len()),
895 };
896 for pending in held {
897 let column = pending.chunk.column(index)?;
898 let (bytes, unique) = encode(column, dictionary.as_deref_mut())?;
899 if bytes.len() > MAX_PAGE {
900 return Err(invalid("column page exceeds the configured bound"));
901 }
902 let range = Range::of(column);
905 let sieve = match dictionary {
918 Some(_) => None,
919 None => Sieve::of(column, &range, SIEVE_BUDGET)
920 .filter(|sieve| sieve.len() < bytes.len()),
921 };
922 stripe.pages.push(bytes);
923 stripe.codes.push(unique);
924 stripe.sieves.push(sieve);
925 stripe.ranges.push(range);
926 }
927 Ok(stripe)
928 }
929
930 fn encode_columns(&mut self, held: &[PendingChunk]) -> Result<Vec<ColumnStripe>> {
939 let width = self.table.fields.len();
940 let workers = std::thread::available_parallelism()
941 .map_or(1, usize::from)
942 .min(MAX_ENCODE_WORKERS)
943 .min(width);
944 if workers <= 1 || held.len() <= 1 {
945 return self
946 .dictionaries
947 .iter_mut()
948 .enumerate()
949 .map(|(index, dictionary)| Self::encode_column(index, held, dictionary.as_mut()))
950 .collect();
951 }
952 let mut jobs: Vec<(usize, Option<GlobalDictionary>)> =
955 std::mem::take(&mut self.dictionaries).into_iter().enumerate().collect();
956 jobs.sort_by_key(|(index, _)| weight(&self.table.fields[*index].ty));
958 let queue = Mutex::new(jobs);
959 let pieces = std::thread::scope(|scope| {
960 (0..workers)
961 .map(|_| {
962 scope.spawn(|| {
963 let mut mine = Vec::new();
964 loop {
965 let taken = queue
966 .lock()
967 .map_err(|_| Error::internal("a native encode worker panicked"))?
968 .pop();
969 let Some((index, mut dictionary)) = taken else { break };
970 let encoded = Self::encode_column(index, held, dictionary.as_mut())?;
971 mine.push((index, dictionary, encoded));
972 }
973 Ok(mine)
974 })
975 })
976 .collect::<Vec<_>>()
977 .into_iter()
978 .map(|handle| {
979 handle.join().map_err(|_| Error::internal("a native encode worker panicked"))?
980 })
981 .collect::<Result<Vec<_>>>()
982 })?;
983 let mut dictionaries: Vec<Option<GlobalDictionary>> = (0..width).map(|_| None).collect();
984 let mut encoded: Vec<Option<ColumnStripe>> = (0..width).map(|_| None).collect();
985 for piece in pieces {
986 for (index, dictionary, stripe) in piece {
987 dictionaries[index] = dictionary;
988 encoded[index] = Some(stripe);
989 }
990 }
991 self.dictionaries = dictionaries;
992 encoded
993 .into_iter()
994 .map(|stripe| stripe.ok_or_else(|| Error::internal("a column was never encoded")))
995 .collect()
996 }
997
998 fn flush_pending(&mut self) -> Result<()> {
1000 if self.pending.is_empty() {
1001 return Ok(());
1002 }
1003 let width = self.table.fields.len();
1004 let mut held = std::mem::take(&mut self.pending);
1007 let parts = held.len();
1008 let encoded = self.encode_columns(&held)?;
1009 let mut pages = Vec::with_capacity(width);
1010 let mut memberships = vec![None; width];
1011 let mut ranges = Vec::with_capacity(width);
1012 let mut index = Vec::with_capacity(width.saturating_mul(index_section(parts)?));
1013 for stripe in &encoded {
1014 let offset = self.at;
1015 let section = index.len();
1016 let mut length = 0_usize;
1017 for bytes in &stripe.pages {
1018 write_at(&self.file, self.at + length as u64, bytes)?;
1019 put_u32(
1020 &mut index,
1021 u32::try_from(bytes.len()).map_err(|_| invalid("part length overflow"))?,
1022 );
1023 put_u64(&mut index, checksum(bytes));
1024 length = length
1025 .checked_add(bytes.len())
1026 .ok_or_else(|| invalid("column page length overflow"))?;
1027 }
1028 let hash = checksum(&index[section..]);
1029 put_u64(&mut index, hash);
1030 if length > MAX_PAGE {
1031 return Err(invalid("column page exceeds the configured bound"));
1032 }
1033 self.at = self
1034 .at
1035 .checked_add(length as u64)
1036 .ok_or_else(|| invalid("native file length overflow"))?;
1037 pages.push(Span {
1038 offset,
1039 length: u32::try_from(length).map_err(|_| invalid("page length overflow"))?,
1040 });
1041 ranges.push(merged_range(stripe.ranges.iter().cloned()));
1042 }
1043 for (membership, stripe) in memberships.iter_mut().zip(&encoded) {
1044 if stripe.codes.iter().all(Option::is_none) {
1045 continue;
1046 }
1047 let lists = stripe
1048 .codes
1049 .iter()
1050 .map(|codes| codes.clone().unwrap_or_default())
1051 .collect::<Vec<_>>();
1052 let bytes = encode_membership(&merged_codes(lists));
1053 let offset = self.at;
1054 self.put(&bytes)?;
1055 *membership = Some(Page {
1056 offset,
1057 length: u32::try_from(bytes.len())
1058 .map_err(|_| invalid("membership page length overflow"))?,
1059 hash: checksum(&bytes),
1060 });
1061 }
1062 let mut sieves = vec![None; width];
1063 for (page, stripe) in sieves.iter_mut().zip(&encoded) {
1064 if stripe.sieves.iter().all(Option::is_none) {
1065 continue;
1066 }
1067 let bytes = encode_sieves(stripe.sieves.iter())?;
1068 let offset = self.at;
1069 self.put(&bytes)?;
1070 *page = Some(Page {
1071 offset,
1072 length: u32::try_from(bytes.len())
1073 .map_err(|_| invalid("sieve page length overflow"))?,
1074 hash: checksum(&bytes),
1075 });
1076 }
1077 let mut part_ranges = vec![None; width];
1083 if parts > 1 {
1084 for ((page, stripe), span) in part_ranges.iter_mut().zip(&encoded).zip(&pages) {
1085 let bytes = encode_part_ranges(&stripe.ranges)?;
1086 if bytes.len() >= span.length as usize {
1087 continue;
1088 }
1089 let offset = self.at;
1090 self.put(&bytes)?;
1091 *page = Some(Page {
1092 offset,
1093 length: u32::try_from(bytes.len())
1094 .map_err(|_| invalid("part range page length overflow"))?,
1095 hash: checksum(&bytes),
1096 });
1097 }
1098 }
1099 let offset = self.at;
1100 self.put(&index)?;
1101 let index = Span {
1102 offset,
1103 length: u32::try_from(index.len())
1104 .map_err(|_| invalid("index page length overflow"))?,
1105 };
1106 let mut rows = 0_usize;
1107 let mut lengths = Vec::with_capacity(parts);
1108 let mut span = None;
1109 for pending in held.drain(..) {
1110 let part = pending.chunk.len();
1111 rows = rows.checked_add(part).ok_or_else(|| invalid("row count overflow"))?;
1112 lengths.push(u32::try_from(part).map_err(|_| invalid("part row count overflow"))?);
1113 span = Some(
1114 span.map_or((pending.order, pending.order), |(first, _)| (first, pending.order)),
1115 );
1116 }
1117 self.order.push(span.ok_or_else(|| invalid("a stripe was flushed with no parts"))?);
1118 self.table.stripes.push(Stripe {
1119 rows,
1120 parts: lengths,
1121 index,
1122 pages,
1123 memberships,
1124 sieves,
1125 part_ranges,
1126 zone: Zone::from_ranges(ranges),
1127 });
1128 self.pending = held;
1130 Ok(())
1131 }
1132
1133 fn numeric_frequency(&self, column: usize) -> Result<Option<FrequencySummary>> {
1137 let ty = &self.table.fields[column].ty;
1138 if !matches!(
1139 ty,
1140 LogicalType::TinyInt
1141 | LogicalType::SmallInt
1142 | LogicalType::Integer
1143 | LogicalType::BigInt
1144 | LogicalType::UTinyInt
1145 | LogicalType::USmallInt
1146 | LogicalType::UInteger
1147 | LogicalType::UBigInt
1148 | LogicalType::Date
1149 | LogicalType::Timestamp
1150 ) {
1151 return Ok(None);
1152 }
1153 let mut candidates: HashMap<FrequencyValue, u32> = HashMap::new();
1154 let mut decrements = 0_u64;
1155 self.visit_numeric(column, |_, value| {
1156 if let Some(count) = candidates.get_mut(&value) {
1157 *count = count.saturating_add(1);
1158 } else if candidates.len() < FREQUENCY_CANDIDATES {
1159 candidates.insert(value, 1);
1160 } else {
1161 candidates.retain(|_, count| {
1162 *count -= 1;
1163 *count != 0
1164 });
1165 decrements = decrements.saturating_add(1);
1166 }
1167 })?;
1168 let (exact, ordinals) = if decrements == 0 {
1169 (
1170 candidates
1171 .into_iter()
1172 .map(|(value, count)| (value, u64::from(count)))
1173 .collect::<HashMap<_, _>>(),
1174 Vec::new(),
1175 )
1176 } else {
1177 let mut lower = candidates.values().copied().collect::<Vec<_>>();
1178 lower.sort_unstable_by(|left, right| right.cmp(left));
1179 if lower.len() < FREQUENCY_BUILD_RANK
1180 || u64::from(lower[FREQUENCY_BUILD_RANK - 1]) <= decrements
1181 {
1182 return Ok(None);
1183 }
1184 let mut exact =
1185 candidates.into_keys().map(|value| (value, 0_u64)).collect::<HashMap<_, _>>();
1186 let mut ordinals = Vec::new();
1187 let mut exceeded = false;
1188 self.visit_numeric(column, |ordinal, value| {
1189 if let Some(count) = exact.get_mut(&value) {
1190 *count = count.saturating_add(1);
1191 if !exceeded {
1192 if ordinals.len() < FREQUENCY_ORDINALS {
1193 ordinals.push(ordinal);
1194 } else {
1195 ordinals.clear();
1196 exceeded = true;
1197 }
1198 }
1199 }
1200 })?;
1201 (exact, ordinals)
1202 };
1203 let mut entries = exact
1204 .into_iter()
1205 .map(|(value, count)| FrequencyEntry { value, count })
1206 .collect::<Vec<_>>();
1207 entries.sort_unstable_by(|left, right| {
1208 right.count.cmp(&left.count).then_with(|| frequency_order(left.value, right.value))
1209 });
1210 let omitted_max =
1211 entries.get(FREQUENCY_ENTRIES).map_or(decrements, |entry| decrements.max(entry.count));
1212 entries.truncate(FREQUENCY_ENTRIES);
1213 Ok(Some(FrequencySummary { entries, omitted_max, ordinals }))
1214 }
1215
1216 fn visit_numeric(
1217 &self,
1218 column: usize,
1219 mut visit: impl FnMut(u64, FrequencyValue),
1220 ) -> Result<()> {
1221 let ty = &self.table.fields[column].ty;
1222 let mut start = 0_u64;
1223 for stripe in &self.table.stripes {
1224 let spans = read_index(&self.file, stripe, column)?;
1225 let page = stripe.pages[column];
1226 let mut bytes = vec![0; page.length as usize];
1227 read_at(&self.file, page.offset, &mut bytes)?;
1228 for (span, &rows) in spans.iter().zip(&stripe.parts) {
1229 let part = part_bytes(&bytes, *span)?;
1230 if checksum(part) != span.hash {
1231 return Err(invalid("column page checksum differs while building frequencies"));
1232 }
1233 let rows = rows as usize;
1234 let vector = decode(ty, rows, part, None)?;
1235 for row in 0..rows {
1237 let value = if vector.is_null_at(row) {
1238 FrequencyValue::Null
1239 } else {
1240 let widened = match vector.signed_at(row) {
1244 Some(value) => Some(value),
1245 None => match vector.value_at(row) {
1246 Value::UTinyInt(value) => Some(i128::from(value)),
1247 Value::USmallInt(value) => Some(i128::from(value)),
1248 Value::UInteger(value) => Some(i128::from(value)),
1249 Value::UBigInt(value) => Some(i128::from(value)),
1250 _ => None,
1251 },
1252 };
1253 FrequencyValue::Integer(widened.ok_or_else(|| {
1254 invalid("numeric frequency page did not contain an integer value")
1255 })?)
1256 };
1257 visit(start.saturating_add(row as u64), value);
1258 }
1259 start = start.saturating_add(rows as u64);
1260 }
1261 }
1262 Ok(())
1263 }
1264
1265 fn numeric_frequencies(&self) -> Result<Vec<Option<FrequencySummary>>> {
1273 let mut columns = self
1274 .table
1275 .fields
1276 .iter()
1277 .enumerate()
1278 .filter_map(|(column, field)| {
1279 matches!(
1280 field.ty,
1281 LogicalType::TinyInt
1282 | LogicalType::SmallInt
1283 | LogicalType::Integer
1284 | LogicalType::BigInt
1285 | LogicalType::UTinyInt
1286 | LogicalType::USmallInt
1287 | LogicalType::UInteger
1288 | LogicalType::UBigInt
1289 | LogicalType::Date
1290 | LogicalType::Timestamp
1291 )
1292 .then_some(column)
1293 })
1294 .collect::<Vec<_>>();
1295 let workers = std::thread::available_parallelism()
1296 .map_or(1, usize::from)
1297 .min(MAX_FREQUENCY_WORKERS)
1298 .min(columns.len());
1299 if workers <= 1 {
1300 let mut frequencies = vec![None; self.table.fields.len()];
1301 for column in columns {
1302 frequencies[column] = self.numeric_frequency(column)?;
1303 }
1304 return Ok(frequencies);
1305 }
1306 columns.sort_by_key(|&column| weight(&self.table.fields[column].ty));
1309 let queue = Mutex::new(columns);
1310 let pieces = std::thread::scope(|scope| {
1311 (0..workers)
1312 .map(|_| {
1313 scope.spawn(|| {
1314 let mut mine = Vec::new();
1315 loop {
1316 let taken = queue
1317 .lock()
1318 .map_err(|_| Error::internal("a native frequency worker panicked"))?
1319 .pop();
1320 let Some(column) = taken else { break };
1321 mine.push((column, self.numeric_frequency(column)?));
1322 }
1323 Ok(mine)
1324 })
1325 })
1326 .collect::<Vec<_>>()
1327 .into_iter()
1328 .map(|handle| {
1329 handle
1330 .join()
1331 .map_err(|_| Error::internal("a native frequency worker panicked"))?
1332 })
1333 .collect::<Result<Vec<_>>>()
1334 })?;
1335 let mut frequencies = vec![None; self.table.fields.len()];
1336 for piece in pieces {
1337 for (column, summary) in piece {
1338 frequencies[column] = summary;
1339 }
1340 }
1341 Ok(frequencies)
1342 }
1343
1344 fn close(&mut self) -> Result<Entry> {
1355 self.flush_pending()?;
1356 let mut stripes = std::mem::take(&mut self.order)
1357 .into_iter()
1358 .zip(std::mem::take(&mut self.table.stripes))
1359 .collect::<Vec<_>>();
1360 stripes.sort_by_key(|(order, _)| order.0);
1361 let mut previous: Option<(u64, u64)> = None;
1362 for ((first, last), _) in &stripes {
1363 if previous.is_some_and(|previous| previous >= *first) {
1364 return Err(invalid("chunks did not arrive in source order"));
1365 }
1366 previous = Some(*last);
1367 }
1368 self.table.stripes = stripes.into_iter().map(|(_, stripe)| stripe).collect();
1369 self.table.frequencies = self.numeric_frequencies()?;
1370 let dictionaries = std::mem::take(&mut self.dictionaries);
1371 let orders = rankings(&dictionaries)?;
1372 for (index, (dictionary, order)) in dictionaries.into_iter().zip(orders).enumerate() {
1373 let Some(dictionary) = dictionary else { continue };
1374 self.table.distincts[index] =
1378 Some(dictionary.counts.iter().filter(|count| **count != 0).count() as u64);
1379 self.table.frequencies[index] = Some(code_frequency(&dictionary));
1380 let encoded = encode_global_dictionary(dictionary, &order)?;
1381 let offset = self.at;
1382 self.put(&encoded.index)?;
1383 self.put(&encoded.ranks)?;
1384 for block in &encoded.payload {
1385 self.put(block)?;
1386 }
1387 let payload_len =
1388 encoded.payload.iter().try_fold(0_usize, |len, block| len.checked_add(block.len()));
1389 let length = payload_len
1390 .and_then(|len| len.checked_add(encoded.index.len()))
1391 .and_then(|len| len.checked_add(encoded.ranks.len()))
1392 .ok_or_else(|| invalid("dictionary page length overflow"))?;
1393 self.table.dictionaries[index] = Some(Page {
1394 offset,
1395 length: u32::try_from(length)
1396 .map_err(|_| invalid("dictionary page length overflow"))?,
1397 hash: checksum(&encoded.index),
1398 });
1399 }
1400 let directory = encode_directory(&self.table)?;
1401 if directory.len() > MAX_DIRECTORY {
1402 return Err(invalid("directory exceeds the configured bound"));
1403 }
1404 let offset = self.at;
1405 self.put(&directory)?;
1406 Ok(Entry {
1407 name: self.table.name.clone(),
1408 fields: self.table.fields.clone(),
1409 rows: self.table.rows,
1410 directory: Page {
1411 offset,
1412 length: u32::try_from(directory.len())
1413 .map_err(|_| invalid("directory length overflow"))?,
1414 hash: checksum(&directory),
1415 },
1416 })
1417 }
1418
1419 pub fn finish(mut self) -> Result<Table> {
1429 let entry = self.close()?;
1430 let mut tables = std::mem::take(&mut self.closed);
1431 tables.push(entry);
1432 let catalog = encode_catalog(&tables)?;
1433 if catalog.len() > MAX_DIRECTORY {
1434 return Err(invalid("catalog exceeds the configured bound"));
1435 }
1436 let offset = self.at;
1437 self.put(&catalog)?;
1438 self.file.sync_all().map_err(io)?;
1442 let slot = Slot {
1443 offset,
1444 length: u32::try_from(catalog.len()).map_err(|_| invalid("catalog length overflow"))?,
1445 generation: self.generation,
1446 hash: checksum(&catalog),
1447 };
1448 write_at(&self.file, 16, &slot.bytes())?;
1451 self.file.sync_all().map_err(io)?;
1452 Ok(self.table)
1453 }
1454}
1455
1456#[derive(Debug, Clone)]
1458pub struct Reader {
1459 file: Arc<File>,
1460 table: Arc<Table>,
1461 dictionaries: Arc<Vec<OnceLock<Arc<Vector>>>>,
1462 loading: Arc<Vec<Mutex<()>>>,
1471 opened: Arc<AtomicUsize>,
1475 sieves: Arc<Vec<Vec<SieveSlot>>>,
1479 part_ranges: Arc<Vec<Vec<RangeSlot>>>,
1482 places: Arc<Vec<Place>>,
1484 cache: Arc<Vec<Mutex<Cached>>>,
1485 pages: Arc<AtomicUsize>,
1488 indexes: Arc<AtomicUsize>,
1491 kept: Arc<AtomicUsize>,
1494 size: u64,
1496 directory: u64,
1498 opening: Opening,
1500}
1501
1502#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
1514pub struct Opening {
1515 pub reads: u32,
1518 pub bytes: u64,
1520}
1521
1522#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
1524pub struct Reads {
1525 pub opening: Opening,
1527 pub pages: usize,
1529 pub indexes: usize,
1531 pub dictionaries: usize,
1534}
1535
1536#[derive(Debug, Clone, Copy)]
1538struct Place {
1539 stripe: u32,
1540 part: u32,
1541 rows: u32,
1542}
1543
1544#[derive(Debug, Clone, Copy)]
1546struct PartSpan {
1547 start: usize,
1548 length: usize,
1549 hash: u64,
1550}
1551
1552#[derive(Debug, Clone)]
1558struct CachedColumn {
1559 stripe: usize,
1560 index: Arc<Vec<PartSpan>>,
1561 page: Option<Arc<Vec<u8>>>,
1562}
1563
1564#[derive(Debug, Default)]
1584struct Cached {
1585 pages: Vec<Option<Arc<Vec<u8>>>>,
1586 order: VecDeque<usize>,
1587 loading: Vec<usize>,
1588 index: Vec<Option<Arc<Vec<PartSpan>>>>,
1589}
1590
1591const CACHED_STRIPES_PER_COLUMN: usize = 4;
1603
1604type SieveSlot = OnceLock<Arc<Vec<Option<Sieve>>>>;
1606
1607type RangeSlot = OnceLock<Arc<Vec<Range>>>;
1608
1609#[derive(Debug)]
1610struct NativeText {
1611 file: Arc<File>,
1612 values: usize,
1614 offsets: Vec<u8>,
1623 offset_bits: usize,
1626 ranks: usize,
1628 rank_at: u64,
1632 rank_ends: Vec<u64>,
1636 rank_hashes: Vec<u64>,
1637 rank_blocks: Vec<OnceLock<Result<Vec<u8>>>>,
1638 code_bits: usize,
1641 code_ranks: OnceLock<Option<Vec<u32>>>,
1648 payload: u64,
1649 ends: Vec<u64>,
1652 hashes: Vec<u64>,
1653 blocks: Vec<OnceLock<Result<Vec<u8>>>>,
1655 keep_budget: usize,
1658 payload_kept: AtomicUsize,
1666 searched: Mutex<HashMap<Vec<u8>, (usize, bool)>>,
1683}
1684
1685const TEXT_SEARCH_MEMO: usize = 64;
1690
1691const TEXT_PAYLOAD_VALUES: usize = 1024;
1707
1708const TEXT_KEEP_BUDGET: usize = 256 * 1024 * 1024;
1729
1730const TEXT_OFFSET_RUN: usize = 512;
1737
1738const DICTIONARY_HEADER: usize = 16;
1741
1742const TEXT_RANK_BLOCK: usize = 512;
1753
1754const RANK_BLOCK_HEADER: usize = size_of::<u64>() + 1;
1768
1769impl NativeText {
1770 fn payload_block(&self, block: usize) -> Result<Option<&[u8]>> {
1777 let Some(slot) = self.blocks.get(block) else { return Ok(None) };
1778 let bytes = slot.get_or_init(|| self.decode_block(block)).as_ref().map_err(Clone::clone)?;
1779 Ok(Some(bytes.as_slice()))
1780 }
1781
1782 fn decode_block(&self, block: usize) -> Result<Vec<u8>> {
1787 let start = if block == 0 { 0 } else { self.ends[block - 1] };
1788 let end = self.ends[block];
1789 let len = end
1790 .checked_sub(start)
1791 .ok_or_else(|| invalid("global dictionary block ends before it starts"))?;
1792 let mut stored = vec![
1793 0;
1794 usize::try_from(len).map_err(|_| invalid(
1795 "global dictionary block does not fit in memory"
1796 ))?
1797 ];
1798 read_at(&self.file, self.payload + start, &mut stored)?;
1799 if checksum(&stored) != self.hashes[block] {
1800 return Err(invalid("global dictionary payload checksum differs"));
1801 }
1802 let first = block * TEXT_PAYLOAD_VALUES;
1803 let last = (first + TEXT_PAYLOAD_VALUES).min(self.values);
1804 let want = self.end_within(last - 1)? as usize;
1805 let values = string::decode_flat(&stored)?;
1806 if values.len() != last - first {
1807 return Err(invalid("global dictionary block holds the wrong value count"));
1808 }
1809 let bytes = values.into_bytes();
1810 if bytes.len() != want {
1811 return Err(invalid("global dictionary block decodes to the wrong length"));
1812 }
1813 Ok(bytes)
1814 }
1815
1816 fn end_within(&self, index: usize) -> Result<u32> {
1818 let run = index / TEXT_OFFSET_RUN;
1819 let bytes = self
1820 .offsets
1821 .get(run * TEXT_OFFSET_RUN / 8 * self.offset_bits..)
1822 .ok_or_else(|| invalid("global dictionary offsets are short"))?;
1823 let end = bitpack::tail_at(bytes, self.offset_bits, index % TEXT_OFFSET_RUN)
1824 .map_err(|_| invalid("global dictionary offsets are short"))?;
1825 u32::try_from(end).map_err(|_| invalid("global dictionary offset is past the payload"))
1826 }
1827
1828 fn ends_within(&self, first: usize, last: usize) -> Result<Vec<u64>> {
1841 let mut ends = Vec::with_capacity(last.saturating_sub(first));
1842 let mut at = first;
1843 while at < last {
1844 let run = at / TEXT_OFFSET_RUN;
1845 let stop = ((run + 1) * TEXT_OFFSET_RUN).min(last);
1846 let held = self.values.saturating_sub(run * TEXT_OFFSET_RUN).min(TEXT_OFFSET_RUN);
1847 let bytes = self
1848 .offsets
1849 .get(run * TEXT_OFFSET_RUN / 8 * self.offset_bits..)
1850 .ok_or_else(|| invalid("global dictionary offsets are short"))?;
1851 let run_ends = bitpack::unpack_tail(bytes, self.offset_bits, held)
1852 .map_err(|_| invalid("global dictionary offsets are short"))?;
1853 let within = run_ends
1854 .get(at % TEXT_OFFSET_RUN..stop - run * TEXT_OFFSET_RUN)
1855 .ok_or_else(|| invalid("global dictionary offsets are short"))?;
1856 ends.extend_from_slice(within);
1857 at = stop;
1858 }
1859 Ok(ends)
1860 }
1861
1862 fn start_within(&self, index: usize) -> Result<u32> {
1865 if index % TEXT_PAYLOAD_VALUES == 0 { Ok(0) } else { self.end_within(index - 1) }
1866 }
1867
1868 fn span_within(&self, index: usize) -> Result<(u32, u32)> {
1876 let within = index % TEXT_OFFSET_RUN;
1877 let (start, end) = if within == 0 {
1878 (self.start_within(index)?, self.end_within(index)?)
1879 } else {
1880 let run = index / TEXT_OFFSET_RUN;
1881 let bytes = self
1882 .offsets
1883 .get(run * TEXT_OFFSET_RUN / 8 * self.offset_bits..)
1884 .ok_or_else(|| invalid("global dictionary offsets are short"))?;
1885 let (start, end) = bitpack::tail_pair(bytes, self.offset_bits, within)
1886 .map_err(|_| invalid("global dictionary offsets are short"))?;
1887 let ends = u32::try_from(end)
1888 .map_err(|_| invalid("global dictionary offset is past the payload"))?;
1889 let starts = u32::try_from(start)
1890 .map_err(|_| invalid("global dictionary offset is past the payload"))?;
1891 (starts, ends)
1892 };
1893 if start > end {
1894 return Err(invalid("global dictionary value ends before it starts"));
1895 }
1896 Ok((start, end))
1897 }
1898
1899 fn rank_parts(&self, rank: usize) -> Result<(&[u8], usize)> {
1906 let slot = self
1907 .rank_blocks
1908 .get(rank / TEXT_RANK_BLOCK)
1909 .ok_or_else(|| invalid("global dictionary rank is past the order"))?;
1910 let block = slot
1911 .get_or_init(|| {
1912 let which = rank / TEXT_RANK_BLOCK;
1913 let start = if which == 0 { 0 } else { self.rank_ends[which - 1] };
1914 let end = self.rank_ends[which];
1915 let mut bytes = vec![0; (end - start) as usize];
1916 read_at(&self.file, self.rank_at + start, &mut bytes)?;
1917 if checksum(&bytes)
1918 != *self
1919 .rank_hashes
1920 .get(rank / TEXT_RANK_BLOCK)
1921 .ok_or_else(|| invalid("global dictionary rank block has no checksum"))?
1922 {
1923 return Err(invalid("global dictionary rank checksum differs"));
1924 }
1925 Ok(bytes)
1926 })
1927 .as_ref()
1928 .map_err(Clone::clone)?;
1929 Ok((block.as_slice(), rank % TEXT_RANK_BLOCK))
1930 }
1931
1932 fn head_at(&self, rank: usize) -> Result<u64> {
1934 let (block, within) = self.rank_parts(rank)?;
1935 let (base, width, packed) = rank_heads(block)?;
1936 let above = bitpack::tail_at(packed, width, within)
1937 .map_err(|_| invalid("global dictionary rank block is short of heads"))?;
1938 Ok(base.wrapping_add(above))
1939 }
1940
1941 fn rank_codes<'block>(&self, block: &'block [u8], count: usize) -> Result<&'block [u8]> {
1943 let (_, width, packed) = rank_heads(block)?;
1944 packed
1945 .get(bitpack::tail_len(count, width)..)
1946 .ok_or_else(|| invalid("global dictionary rank block is short of codes"))
1947 }
1948
1949 fn rank_block_len(&self, rank: usize) -> usize {
1951 let first = rank / TEXT_RANK_BLOCK * TEXT_RANK_BLOCK;
1952 TEXT_RANK_BLOCK.min(self.ranks - first)
1953 }
1954}
1955
1956fn rank_heads(block: &[u8]) -> Result<(u64, usize, &[u8])> {
1958 let header = block
1959 .get(..RANK_BLOCK_HEADER)
1960 .ok_or_else(|| invalid("global dictionary rank block is short"))?;
1961 let base = u64::from_le_bytes(header[..8].try_into().expect("eight bytes"));
1962 let width = header[8] as usize;
1963 if width > 64 {
1964 return Err(invalid("global dictionary rank block packs heads past a word"));
1965 }
1966 Ok((base, width, &block[RANK_BLOCK_HEADER..]))
1967}
1968
1969fn offset_width(offsets: &[u32]) -> usize {
1976 let values = offsets.len() - 1;
1977 let mut span = 0;
1978 for first in (0..values).step_by(TEXT_PAYLOAD_VALUES) {
1979 let last = (first + TEXT_PAYLOAD_VALUES).min(values);
1980 span = span.max(offsets[last] - offsets[first]);
1981 }
1982 (u32::BITS - span.leading_zeros()) as usize
1983}
1984
1985fn offset_bytes(values: usize, bits: usize) -> usize {
1988 let full = values / TEXT_OFFSET_RUN;
1989 let rest = values % TEXT_OFFSET_RUN;
1990 full * TEXT_OFFSET_RUN / 8 * bits + bitpack::tail_len(rest, bits)
1991}
1992
1993fn encode_offsets(offsets: &[u32], bits: usize, out: &mut Vec<u8>) -> Result<()> {
1995 let values = offsets.len() - 1;
1996 let mut run = Vec::with_capacity(TEXT_OFFSET_RUN);
1997 for first in (0..values).step_by(TEXT_OFFSET_RUN) {
1998 let last = (first + TEXT_OFFSET_RUN).min(values);
1999 let base = offsets[first / TEXT_PAYLOAD_VALUES * TEXT_PAYLOAD_VALUES];
2000 run.clear();
2001 run.extend((first..last).map(|value| u64::from(offsets[value + 1] - base)));
2002 bitpack::pack_tail(&run, bits, out)
2003 .map_err(|_| invalid("global dictionary offsets do not pack"))?;
2004 }
2005 Ok(())
2006}
2007
2008fn code_width(values: usize) -> usize {
2010 match u64::try_from(values).unwrap_or(u64::MAX) {
2011 0 | 1 => 0,
2012 last => (u64::BITS - (last - 1).leading_zeros()) as usize,
2013 }
2014}
2015
2016impl TextSource for NativeText {
2017 fn len(&self) -> usize {
2018 self.values
2019 }
2020
2021 fn bytes_at(&self, index: usize) -> Result<Option<&[u8]>> {
2022 if index >= self.values {
2023 return Ok(None);
2024 }
2025 let (start, end) = self.span_within(index)?;
2026 if start == end {
2027 return Ok(Some(&[]));
2028 }
2029 let block = index / TEXT_PAYLOAD_VALUES;
2032 let Some(bytes) = self.payload_block(block)? else { return Ok(None) };
2033 Ok(bytes.get(start as usize..end as usize))
2034 }
2035
2036 fn bytes_len_at(&self, index: usize) -> Result<Option<usize>> {
2037 if index >= self.values {
2038 return Ok(None);
2039 }
2040 let (start, end) = self.span_within(index)?;
2041 Ok(Some((end - start) as usize))
2042 }
2043
2044 fn sweep(
2057 &self,
2058 first: usize,
2059 limit: usize,
2060 body: &mut dyn FnMut(usize, &[u8]) -> Result<()>,
2061 ) -> Result<usize> {
2062 let limit = limit.min(self.values);
2063 if first >= limit {
2064 return Ok(first);
2065 }
2066 let block = first / TEXT_PAYLOAD_VALUES;
2067 let last = ((block + 1) * TEXT_PAYLOAD_VALUES).min(limit);
2068 let decoded;
2069 let bytes: &[u8] = match self.blocks.get(block).and_then(OnceLock::get) {
2070 Some(Ok(kept)) => kept,
2071 _ if self.payload_kept.load(Atomic::Relaxed) < self.keep_budget => {
2072 let kept = self
2073 .payload_block(block)?
2074 .ok_or_else(|| invalid("global dictionary block is past the payload"))?;
2075 self.payload_kept.fetch_add(kept.len(), Atomic::Relaxed);
2076 kept
2077 }
2078 _ => {
2079 decoded = self.decode_block(block)?;
2080 &decoded
2081 }
2082 };
2083 let ends = self.ends_within(first, last)?;
2084 if ends.len() != last - first {
2085 return Err(invalid("global dictionary offsets are short"));
2086 }
2087 let mut start = u64::from(self.start_within(first)?);
2088 for (index, &end) in (first..last).zip(&ends) {
2091 let value = usize::try_from(start)
2092 .ok()
2093 .zip(usize::try_from(end).ok())
2094 .and_then(|(from, to)| bytes.get(from..to))
2095 .ok_or_else(|| invalid("global dictionary value is past its block"))?;
2096 body(index, value)?;
2097 start = end;
2098 }
2099 Ok(last)
2100 }
2101
2102 fn ranks(&self) -> Option<usize> {
2103 (self.ranks > 0).then_some(self.ranks)
2104 }
2105
2106 fn below(&self, ranks: usize, wanted: &[u8]) -> Result<(usize, bool)> {
2114 let mut memo = self.searched.lock().map_err(|_| invalid("a poisoned dictionary search"))?;
2115 if let Some(&answer) = memo.get(wanted) {
2116 return Ok(answer);
2117 }
2118 let answer = search_below(self, ranks, wanted)?;
2119 if memo.len() >= TEXT_SEARCH_MEMO {
2120 memo.clear();
2121 }
2122 memo.insert(wanted.to_vec(), answer);
2123 Ok(answer)
2124 }
2125
2126 fn compare_rank(&self, rank: usize, wanted: &[u8]) -> Result<Ordering> {
2127 let settled = self.head_at(rank)?.cmp(&head(wanted));
2131 if settled != Ordering::Equal {
2132 return Ok(settled);
2133 }
2134 let code = self.code_at_rank(rank)?;
2135 let bytes = self
2136 .bytes_at(code as usize)?
2137 .ok_or_else(|| invalid("global dictionary order names a code it does not have"))?;
2138 Ok(bytes.cmp(wanted))
2139 }
2140
2141 fn code_at_rank(&self, rank: usize) -> Result<u32> {
2142 let (block, within) = self.rank_parts(rank)?;
2143 let codes = self.rank_codes(block, self.rank_block_len(rank))?;
2144 let code = bitpack::tail_at(codes, self.code_bits, within)
2145 .map_err(|_| invalid("global dictionary rank block is short of codes"))?;
2146 let code = u32::try_from(code)
2147 .map_err(|_| invalid("global dictionary order names a code it does not have"))?;
2148 if code as usize >= self.len() {
2149 return Err(invalid("global dictionary order names a code it does not have"));
2150 }
2151 Ok(code)
2152 }
2153
2154 fn code_ranks(&self) -> Option<&[u32]> {
2155 if self.ranks == 0 || self.ranks != self.len() {
2159 return None;
2160 }
2161 self.code_ranks
2162 .get_or_init(|| {
2163 let mut ranks = vec![u32::MAX; self.ranks];
2164 for first in (0..self.ranks).step_by(TEXT_RANK_BLOCK) {
2167 let (block, _) = self.rank_parts(first).ok()?;
2168 let count = self.rank_block_len(first);
2169 let codes = self.rank_codes(block, count).ok()?;
2170 for (within, code) in bitpack::unpack_tail(codes, self.code_bits, count)
2171 .ok()?
2172 .into_iter()
2173 .enumerate()
2174 {
2175 let code = usize::try_from(code).ok()?;
2176 *ranks.get_mut(code)? = u32::try_from(first + within).ok()?;
2177 }
2178 }
2179 if ranks.contains(&u32::MAX) {
2180 return None;
2181 }
2182 Some(ranks)
2183 })
2184 .as_deref()
2185 }
2186
2187 fn footprint(&self) -> usize {
2188 self.offsets.capacity()
2189 + self
2190 .code_ranks
2191 .get()
2192 .and_then(Option::as_ref)
2193 .map_or(0, |ranks| ranks.capacity() * size_of::<u32>())
2194 + self.rank_hashes.capacity() * size_of::<u64>()
2195 + self.rank_ends.capacity() * size_of::<u64>()
2196 + self.rank_blocks.capacity() * size_of::<OnceLock<Result<Vec<u8>>>>()
2197 + self
2198 .rank_blocks
2199 .iter()
2200 .filter_map(OnceLock::get)
2201 .filter_map(|result| result.as_ref().ok())
2202 .map(Vec::capacity)
2203 .sum::<usize>()
2204 + self.blocks.capacity() * size_of::<OnceLock<Result<Vec<u8>>>>()
2205 + self.hashes.capacity() * size_of::<u64>()
2206 + self.ends.capacity() * size_of::<u64>()
2207 + self
2208 .blocks
2209 .iter()
2210 .filter_map(OnceLock::get)
2211 .filter_map(|result| result.as_ref().ok())
2212 .map(Vec::capacity)
2213 .sum::<usize>()
2214 }
2215}
2216
2217fn places(table: &Table) -> Result<Vec<Place>> {
2219 let mut places = Vec::with_capacity(table.stripes.len().saturating_mul(STRIPE_PARTS));
2220 for (at, stripe) in table.stripes.iter().enumerate() {
2221 let index = u32::try_from(at).map_err(|_| invalid("too many stripes"))?;
2222 for (part, &rows) in stripe.parts.iter().enumerate() {
2223 places.push(Place {
2224 stripe: index,
2225 part: u32::try_from(part).map_err(|_| invalid("too many parts in a stripe"))?,
2226 rows,
2227 });
2228 }
2229 }
2230 Ok(places)
2231}
2232
2233fn read_index(file: &File, stripe: &Stripe, column: usize) -> Result<Vec<PartSpan>> {
2238 let parts = stripe.parts.len();
2239 let section = index_section(parts)?;
2240 let at = column.checked_mul(section).ok_or_else(|| invalid("index page offset overflow"))?;
2241 let end = at.checked_add(section).ok_or_else(|| invalid("index page offset overflow"))?;
2242 if end > stripe.index.length as usize {
2243 return Err(invalid("index page is shorter than its columns"));
2244 }
2245 let page = stripe.pages.get(column).ok_or_else(|| invalid("stripe page is missing"))?;
2246 let mut bytes = vec![0; section];
2247 let offset = stripe
2248 .index
2249 .offset
2250 .checked_add(at as u64)
2251 .ok_or_else(|| invalid("index page offset overflow"))?;
2252 read_at(file, offset, &mut bytes)?;
2253 let entries = section - size_of::<u64>();
2254 let stored = u64::from_le_bytes(bytes[entries..].try_into().expect("eight bytes"));
2255 if checksum(&bytes[..entries]) != stored {
2256 return Err(invalid(&format!(
2259 "index page section checksum differs, column {column} of {parts} parts at {offset}, \
2260 wanted {stored:016x} and got {:016x}",
2261 checksum(&bytes[..entries]),
2262 )));
2263 }
2264 let mut spans = Vec::with_capacity(parts);
2265 let mut start = 0_usize;
2266 for part in 0..parts {
2267 let at = part * INDEX_ENTRY;
2268 let length = u32::from_le_bytes(bytes[at..at + 4].try_into().expect("four bytes")) as usize;
2269 let hash = u64::from_le_bytes(bytes[at + 4..at + 12].try_into().expect("eight bytes"));
2270 spans.push(PartSpan { start, length, hash });
2271 start = start.checked_add(length).ok_or_else(|| invalid("column page length overflow"))?;
2272 }
2273 if start != page.length as usize {
2274 return Err(invalid("column page length differs from its index"));
2275 }
2276 Ok(spans)
2277}
2278
2279fn part_bytes(page: &[u8], span: PartSpan) -> Result<&[u8]> {
2281 let end = span.start.checked_add(span.length).ok_or_else(|| invalid("part range overflow"))?;
2282 page.get(span.start..end).ok_or_else(|| invalid("part exceeds its column page"))
2283}
2284
2285fn remember(cached: &mut Cached, held: &CachedColumn, kept: usize) {
2290 if let Some(slot) = cached.index.get_mut(held.stripe) {
2291 if slot.is_none() {
2292 *slot = Some(Arc::clone(&held.index));
2293 }
2294 }
2295 let Some(page) = held.page.clone() else { return };
2296 let Some(slot) = cached.pages.get_mut(held.stripe) else { return };
2297 if slot.is_none() {
2298 cached.order.push_back(held.stripe);
2299 }
2300 *slot = Some(page);
2301 while cached.order.len() > kept.max(1) {
2302 let Some(oldest) = cached.order.pop_front() else { break };
2303 if let Some(slot) = cached.pages.get_mut(oldest) {
2304 *slot = None;
2305 }
2306 }
2307}
2308
2309#[derive(Debug, Clone)]
2318pub struct Catalog {
2319 file: Arc<File>,
2320 size: u64,
2321 entries: Arc<Vec<Entry>>,
2322 opening: Opening,
2323}
2324
2325impl Catalog {
2326 pub fn open(path: impl AsRef<Path>) -> Result<Self> {
2332 let (file, size, bytes, opening) = slot_bytes(path)?;
2333 let entries = decode_catalog(&bytes, size)?;
2334 Ok(Self { file: Arc::new(file), size, entries: Arc::new(entries), opening })
2335 }
2336
2337 pub fn names(&self) -> impl ExactSizeIterator<Item = &str> {
2339 self.entries.iter().map(|entry| entry.name.as_str())
2340 }
2341
2342 #[must_use]
2344 pub fn len(&self) -> usize {
2345 self.entries.len()
2346 }
2347
2348 #[must_use]
2350 pub fn is_empty(&self) -> bool {
2351 self.entries.is_empty()
2352 }
2353
2354 pub fn table(&self, name: &str) -> Result<Reader> {
2360 let entry = self
2361 .entries
2362 .iter()
2363 .find(|entry| entry.name == name)
2364 .ok_or_else(|| invalid(&format!("the file holds no table called {name}")))?;
2365 let mut bytes = vec![0; entry.directory.length as usize];
2366 read_at(&self.file, entry.directory.offset, &mut bytes)?;
2367 if checksum(&bytes) != entry.directory.hash {
2368 return Err(invalid(&format!("the directory of table {name} does not checksum")));
2369 }
2370 let mut opening = self.opening;
2371 opening.reads += 1;
2372 opening.bytes += u64::from(entry.directory.length);
2373 Reader::build(
2374 Arc::clone(&self.file),
2375 self.size,
2376 decode_directory(&bytes, self.size)?,
2377 u64::from(entry.directory.length),
2378 opening,
2379 )
2380 }
2381}
2382
2383fn slot_bytes(path: impl AsRef<Path>) -> Result<(File, u64, Vec<u8>, Opening)> {
2388 let mut file = File::open(path).map_err(io)?;
2389 let size = file.metadata().map_err(io)?.len();
2390 if size < HEADER {
2391 return Err(invalid("file is shorter than its header"));
2392 }
2393 let mut header = [0; HEADER as usize];
2394 file.read_exact(&mut header).map_err(io)?;
2395 let mut opening = Opening { reads: 1, bytes: HEADER };
2396 let version = u32::from_le_bytes([header[8], header[9], header[10], header[11]]);
2397 if &header[..8] != MAGIC {
2402 return Err(invalid("the header does not begin with a rudb native magic"));
2403 }
2404 if version != FORMAT {
2405 return Err(invalid(&format!(
2406 "the file is format {version} and this build reads format {FORMAT}, so it has to \
2407 be written again"
2408 )));
2409 }
2410 let mut selected = None;
2411 for start in [16, 16 + SLOT_BYTES] {
2412 let slot = Slot::read(&header[start..start + SLOT_BYTES]);
2413 if slot.generation == 0 || slot.length == 0 || slot.length as usize > MAX_DIRECTORY {
2414 continue;
2415 }
2416 let Some(end) = slot.offset.checked_add(u64::from(slot.length)) else { continue };
2417 if slot.offset < HEADER || end > size {
2418 continue;
2419 }
2420 let mut bytes = vec![0; slot.length as usize];
2421 file.seek(SeekFrom::Start(slot.offset)).map_err(io)?;
2422 file.read_exact(&mut bytes).map_err(io)?;
2423 opening.reads += 1;
2424 opening.bytes += u64::from(slot.length);
2425 if checksum(&bytes) == slot.hash
2426 && selected
2427 .as_ref()
2428 .is_none_or(|(old, _): &(Slot, Vec<u8>)| old.generation < slot.generation)
2429 {
2430 selected = Some((slot, bytes));
2431 }
2432 }
2433 let (_, bytes) = selected.ok_or_else(|| invalid("no committed directory slot is valid"))?;
2434 Ok((file, size, bytes, opening))
2435}
2436
2437impl Reader {
2438 pub fn open(path: impl AsRef<Path>) -> Result<Self> {
2445 let catalog = Catalog::open(path)?;
2446 let mut names = catalog.names();
2447 let name = names.next().ok_or_else(|| invalid("the file holds no table"))?.to_string();
2448 if names.next().is_some() {
2449 return Err(invalid(
2450 "the file holds more than one table, so it has to be opened by name",
2451 ));
2452 }
2453 catalog.table(&name)
2454 }
2455
2456 fn build(
2458 file: Arc<File>,
2459 size: u64,
2460 table: Table,
2461 directory: u64,
2462 opening: Opening,
2463 ) -> Result<Self> {
2464 let places = places(&table)?;
2465 let dictionaries = (0..table.fields.len()).map(|_| OnceLock::new()).collect();
2466 let table_fields = table.fields.len();
2467 let stripes = table.stripes.len();
2468 let cache = (0..table.fields.len())
2469 .map(|_| {
2470 Mutex::new(Cached {
2471 pages: (0..stripes).map(|_| None).collect(),
2472 index: (0..stripes).map(|_| None).collect(),
2473 ..Cached::default()
2474 })
2475 })
2476 .collect::<Vec<_>>();
2477 let sieves: Vec<Vec<SieveSlot>> = (0..table.fields.len())
2478 .map(|_| table.stripes.iter().map(|_| OnceLock::new()).collect())
2479 .collect();
2480 let part_ranges: Vec<Vec<RangeSlot>> = (0..table.fields.len())
2481 .map(|_| table.stripes.iter().map(|_| OnceLock::new()).collect())
2482 .collect();
2483 Ok(Self {
2484 file,
2485 table: Arc::new(table),
2486 dictionaries: Arc::new(dictionaries),
2487 loading: Arc::new((0..table_fields).map(|_| Mutex::new(())).collect()),
2488 opened: Arc::new(AtomicUsize::new(0)),
2489 sieves: Arc::new(sieves),
2490 part_ranges: Arc::new(part_ranges),
2491 places: Arc::new(places),
2492 cache: Arc::new(cache),
2493 pages: Arc::new(AtomicUsize::new(0)),
2494 indexes: Arc::new(AtomicUsize::new(0)),
2495 kept: Arc::new(AtomicUsize::new(CACHED_STRIPES_PER_COLUMN)),
2496 size,
2497 directory,
2498 opening,
2499 })
2500 }
2501
2502 #[must_use]
2509 pub fn reads(&self) -> Reads {
2510 Reads {
2511 opening: self.opening,
2512 pages: self.pages.load(Atomic::Relaxed),
2513 indexes: self.indexes.load(Atomic::Relaxed),
2514 dictionaries: self.opened.load(Atomic::Relaxed),
2515 }
2516 }
2517
2518 #[must_use]
2523 pub fn layout(&self) -> Layout {
2524 let table = &self.table;
2525 let stripes = table.stripes.as_slice();
2526 let columns = table
2527 .fields
2528 .iter()
2529 .enumerate()
2530 .map(|(at, field)| ColumnLayout {
2531 name: field.name.clone(),
2532 kind: field.ty.to_string(),
2533 pages: sum(stripes.iter().map(|stripe| span_bytes(&stripe.pages, at))),
2534 memberships: sum(stripes.iter().map(|stripe| page_bytes(&stripe.memberships, at))),
2535 sieves: sum(stripes.iter().map(|stripe| page_bytes(&stripe.sieves, at))),
2536 part_ranges: sum(stripes.iter().map(|stripe| page_bytes(&stripe.part_ranges, at))),
2537 dictionary: page_bytes(&table.dictionaries, at),
2538 })
2539 .collect();
2540 Layout {
2541 file: self.size,
2542 rows: table.rows,
2543 stripes: stripes.len(),
2544 parts: self.places.len(),
2545 columns,
2546 indexes: sum(stripes.iter().map(|stripe| u64::from(stripe.index.length))),
2547 directory: self.directory,
2548 header: HEADER,
2549 }
2550 }
2551
2552 #[must_use]
2554 pub fn parts(&self) -> usize {
2555 self.places.len()
2556 }
2557
2558 #[must_use]
2565 pub fn stripe_parts(&self) -> Vec<std::ops::Range<usize>> {
2566 let mut runs = Vec::with_capacity(self.table.stripes.len());
2567 let mut start = 0;
2568 for stripe in &self.table.stripes {
2569 let end = start + stripe.parts.len();
2570 runs.push(start..end);
2571 start = end;
2572 }
2573 runs
2574 }
2575
2576 #[must_use]
2581 pub fn stripe_rows(&self, stripe: usize) -> usize {
2582 self.table.stripes.get(stripe).map_or(0, |held| held.rows)
2583 }
2584
2585 pub fn keep_stripes(&self, stripes: usize) {
2592 self.kept.fetch_max(stripes, Atomic::Relaxed);
2593 }
2594
2595 #[must_use]
2597 pub fn part_rows(&self, at: usize) -> usize {
2598 self.places.get(at).map_or(0, |place| place.rows as usize)
2599 }
2600
2601 #[must_use]
2603 pub fn table(&self) -> &Table {
2604 &self.table
2605 }
2606
2607 pub fn top_frequencies(&self, column: usize, top: usize) -> Result<Option<Vec<(Value, u64)>>> {
2616 let field = self
2617 .table
2618 .fields
2619 .get(column)
2620 .ok_or_else(|| invalid("frequency column index out of range"))?;
2621 let Some(summary) = self.table.frequencies.get(column).and_then(Option::as_ref) else {
2622 return Ok(None);
2623 };
2624 if top == 0 || summary.entries.len() < top {
2625 return Ok(None);
2626 }
2627 let boundary = summary.entries[top - 1].count;
2628 if boundary <= summary.omitted_max {
2629 return Ok(None);
2630 }
2631 self.decode_frequencies(column, &field.ty, &summary.entries).map(Some)
2632 }
2633
2634 pub fn exact_frequencies(&self, column: usize) -> Result<Option<Vec<(Value, u64)>>> {
2654 let field = self
2655 .table
2656 .fields
2657 .get(column)
2658 .ok_or_else(|| invalid("frequency column index out of range"))?;
2659 let Some(summary) = self.table.frequencies.get(column).and_then(Option::as_ref) else {
2660 return Ok(None);
2661 };
2662 if summary.omitted_max > 0 {
2663 return Ok(None);
2664 }
2665 self.decode_frequencies(column, &field.ty, &summary.entries).map(Some)
2666 }
2667
2668 fn decode_frequencies(
2670 &self,
2671 column: usize,
2672 ty: &LogicalType,
2673 entries: &[FrequencyEntry],
2674 ) -> Result<Vec<(Value, u64)>> {
2675 let dictionary = if *ty == LogicalType::Varchar { self.dictionary(column)? } else { None };
2676 let mut out = Vec::with_capacity(entries.len());
2677 for entry in entries {
2678 let value = match entry.value {
2679 FrequencyValue::Null => Value::Null,
2680 FrequencyValue::Integer(value) => match *ty {
2681 LogicalType::TinyInt => Value::TinyInt(
2682 i8::try_from(value)
2683 .map_err(|_| invalid("frequency TINYINT is out of range"))?,
2684 ),
2685 LogicalType::UTinyInt => Value::UTinyInt(
2686 u8::try_from(value)
2687 .map_err(|_| invalid("frequency UTINYINT is out of range"))?,
2688 ),
2689 LogicalType::USmallInt => Value::USmallInt(
2690 u16::try_from(value)
2691 .map_err(|_| invalid("frequency USMALLINT is out of range"))?,
2692 ),
2693 LogicalType::UInteger => Value::UInteger(
2694 u32::try_from(value)
2695 .map_err(|_| invalid("frequency UINTEGER is out of range"))?,
2696 ),
2697 LogicalType::UBigInt => Value::UBigInt(
2698 u64::try_from(value)
2699 .map_err(|_| invalid("frequency UBIGINT is out of range"))?,
2700 ),
2701 LogicalType::SmallInt => Value::SmallInt(
2702 i16::try_from(value)
2703 .map_err(|_| invalid("frequency SMALLINT is out of range"))?,
2704 ),
2705 LogicalType::Integer => Value::Integer(
2706 i32::try_from(value)
2707 .map_err(|_| invalid("frequency INTEGER is out of range"))?,
2708 ),
2709 LogicalType::BigInt => Value::BigInt(
2710 i64::try_from(value)
2711 .map_err(|_| invalid("frequency BIGINT is out of range"))?,
2712 ),
2713 LogicalType::Date => Value::Date(
2714 i32::try_from(value)
2715 .map_err(|_| invalid("frequency DATE is out of range"))?,
2716 ),
2717 LogicalType::Timestamp => Value::Timestamp(
2718 i64::try_from(value)
2719 .map_err(|_| invalid("frequency TIMESTAMP is out of range"))?,
2720 ),
2721 _ => return Err(invalid("integer frequency belongs to another type")),
2722 },
2723 FrequencyValue::Code(code) => dictionary
2724 .as_ref()
2725 .ok_or_else(|| invalid("frequency code has no dictionary"))?
2726 .try_value_at(code as usize)?,
2727 };
2728 out.push((value, entry.count));
2729 }
2730 Ok(out)
2731 }
2732
2733 pub fn frequency_occurrences(&self, column: usize) -> Result<Option<FrequencyOccurrences>> {
2743 self.table
2744 .fields
2745 .get(column)
2746 .ok_or_else(|| invalid("frequency column index out of range"))?;
2747 let Some(summary) = self.table.frequencies.get(column).and_then(Option::as_ref) else {
2748 return Ok(None);
2749 };
2750 if summary.ordinals.is_empty() {
2751 return Ok(None);
2752 }
2753 Ok(Some(FrequencyOccurrences {
2754 omitted_max: summary.omitted_max,
2755 ordinals: summary.ordinals.clone(),
2756 }))
2757 }
2758
2759 pub fn distinct_values(&self, column: usize) -> Result<Option<u64>> {
2783 self.table
2784 .distincts
2785 .get(column)
2786 .copied()
2787 .ok_or_else(|| invalid("distinct column index out of range"))
2788 }
2789
2790 pub fn null_count(&self, column: usize) -> Result<u64> {
2801 if column >= self.table.fields.len() {
2802 return Err(invalid("null count column index out of range"));
2803 }
2804 let mut nulls = 0_u64;
2805 for stripe in &self.table.stripes {
2806 let range = stripe
2807 .zone
2808 .column(column)
2809 .ok_or_else(|| invalid("stripe zone is narrower than the schema"))?;
2810 nulls = nulls
2811 .checked_add(range.nulls as u64)
2812 .ok_or_else(|| invalid("null count overflow"))?;
2813 }
2814 Ok(nulls)
2815 }
2816
2817 pub fn text_extremes(&self, column: usize) -> Result<Option<(Value, Value)>> {
2832 if self.null_count(column)? > 0 {
2833 return Ok(None);
2834 }
2835 let Some(dictionary) = self.dictionary(column)? else { return Ok(None) };
2836 let Some(ranks) = dictionary.ranks() else { return Ok(None) };
2837 if ranks == 0 {
2838 return Ok(None);
2839 }
2840 let low = text_at_rank(&dictionary, 0)?;
2841 let high = text_at_rank(&dictionary, ranks - 1)?;
2842 Ok(Some((low, high)))
2843 }
2844
2845 pub fn exact_extremes(&self, column: usize) -> Result<Option<(Bound, Bound)>> {
2868 if column >= self.table.fields.len() {
2869 return Err(invalid("extremes column index out of range"));
2870 }
2871 let mut low: Option<Bound> = None;
2872 let mut high: Option<Bound> = None;
2873 for stripe in &self.table.stripes {
2874 let range = stripe
2875 .zone
2876 .column(column)
2877 .ok_or_else(|| invalid("stripe zone is narrower than the schema"))?;
2878 if !range.exact {
2879 return Ok(None);
2880 }
2881 let (Some(small), Some(large)) = (range.low.as_ref(), range.high.as_ref()) else {
2886 if stripe.rows > range.nulls {
2887 return Ok(None);
2888 }
2889 continue;
2890 };
2891 low = Some(low.map_or_else(|| small.clone(), |held| held.smaller(small.clone())));
2892 high = Some(high.map_or_else(|| large.clone(), |held| held.larger(large.clone())));
2893 }
2894 Ok(low.zip(high))
2895 }
2896
2897 pub fn exact_sum(&self, column: usize) -> Result<Option<(i128, u64)>> {
2910 if column >= self.table.fields.len() {
2911 return Err(invalid("sum column index out of range"));
2912 }
2913 let mut total = 0_i128;
2914 let mut rows = 0_u64;
2915 for stripe in &self.table.stripes {
2916 let range = stripe
2917 .zone
2918 .column(column)
2919 .ok_or_else(|| invalid("stripe zone is narrower than the schema"))?;
2920 let Some(part) = range.sum else { return Ok(None) };
2921 let Some(sum) = total.checked_add(part) else { return Ok(None) };
2922 total = sum;
2923 rows = rows.saturating_add(stripe.rows as u64 - range.nulls as u64);
2924 }
2925 Ok(Some((total, rows)))
2926 }
2927
2928 fn dictionary(&self, column: usize) -> Result<Option<Arc<Vector>>> {
2937 let Some(page) = self.table.dictionaries[column] else { return Ok(None) };
2938 if let Some(dictionary) = self.dictionaries[column].get() {
2939 return Ok(Some(Arc::clone(dictionary)));
2940 }
2941 let _queued = self.loading[column].lock().map_err(|_| invalid("a poisoned dictionary"))?;
2942 if let Some(dictionary) = self.dictionaries[column].get() {
2943 return Ok(Some(Arc::clone(dictionary)));
2944 }
2945 self.opened.fetch_add(1, Atomic::Relaxed);
2946 let dictionary = Arc::new(open_global_dictionary(
2947 Arc::clone(&self.file),
2948 page,
2949 &self.table.fields[column].ty,
2950 TEXT_KEEP_BUDGET,
2951 )?);
2952 let _ = self.dictionaries[column].set(Arc::clone(&dictionary));
2953 Ok(Some(dictionary))
2954 }
2955
2956 pub fn read(&self, part: usize, columns: &[usize]) -> Result<Chunk> {
2965 self.read_impl(part, columns, true)
2966 }
2967
2968 pub fn read_sparse(&self, part: usize, columns: &[usize]) -> Result<Chunk> {
2978 self.read_impl(part, columns, false)
2979 }
2980
2981 pub fn skips_codes(&self, part: usize, column: usize, candidates: &[u32]) -> Result<bool> {
2988 if candidates.is_empty() {
2989 return Ok(true);
2990 }
2991 if candidates.windows(2).any(|pair| pair[0] >= pair[1]) {
2992 return Err(Error::internal("native code candidates are not sorted and unique"));
2993 }
2994 let stripe = self.stripe_of(part)?;
2995 let Some(page) = stripe.memberships.get(column).copied().flatten() else {
2996 return Ok(false);
2997 };
2998 let mut bytes = vec![0; page.length as usize];
2999 read_at(&self.file, page.offset, &mut bytes)?;
3000 if checksum(&bytes) != page.hash {
3001 return Err(invalid("membership page checksum differs"));
3002 }
3003 let codes = decode_membership(&bytes)?;
3004 let mut left = 0;
3005 let mut right = 0;
3006 while left < codes.len() && right < candidates.len() {
3007 match codes[left].cmp(&candidates[right]) {
3008 Ordering::Less => left += 1,
3009 Ordering::Greater => right += 1,
3010 Ordering::Equal => return Ok(false),
3011 }
3012 }
3013 Ok(true)
3014 }
3015
3016 fn stripe_of(&self, part: usize) -> Result<&Stripe> {
3017 let place = self.places.get(part).ok_or_else(|| invalid("part index out of range"))?;
3018 self.table
3019 .stripes
3020 .get(place.stripe as usize)
3021 .ok_or_else(|| invalid("stripe index out of range"))
3022 }
3023
3024 fn held(&self, at: usize, stripe: &Stripe, column: usize, whole: bool) -> Result<CachedColumn> {
3041 let cache = self.cache.get(column).ok_or_else(|| invalid("column index out of range"))?;
3042 let mut cached = cache.lock().map_err(|_| invalid("column page cache is poisoned"))?;
3043 let known = cached.index.get(at).and_then(Clone::clone);
3044 let page = cached.pages.get(at).and_then(Clone::clone);
3045 if let Some(index) = known.clone() {
3046 if !whole || page.is_some() {
3047 return Ok(CachedColumn { stripe: at, index, page });
3048 }
3049 }
3050 if cached.loading.contains(&at) {
3051 drop(cached);
3052 if let Some(index) = known {
3056 return Ok(CachedColumn { stripe: at, index, page: None });
3057 }
3058 let held = self.page_of(stripe, column, at, false, None)?;
3059 let mut cached = cache.lock().map_err(|_| invalid("column page cache is poisoned"))?;
3060 remember(&mut cached, &held, self.kept.load(Atomic::Relaxed));
3061 return Ok(held);
3062 }
3063 cached.loading.push(at);
3064 drop(cached);
3065
3066 let read = self.page_of(stripe, column, at, whole, known);
3067
3068 let mut cached = cache.lock().map_err(|_| invalid("column page cache is poisoned"))?;
3072 if let Some(position) = cached.loading.iter().position(|loading| *loading == at) {
3073 cached.loading.remove(position);
3074 }
3075 let held = read?;
3076 remember(&mut cached, &held, self.kept.load(Atomic::Relaxed));
3077 Ok(held)
3078 }
3079
3080 fn page_of(
3086 &self,
3087 stripe: &Stripe,
3088 column: usize,
3089 at: usize,
3090 whole: bool,
3091 known: Option<Arc<Vec<PartSpan>>>,
3092 ) -> Result<CachedColumn> {
3093 let index = match known {
3094 Some(index) => index,
3095 None => {
3096 self.indexes.fetch_add(1, Atomic::Relaxed);
3097 Arc::new(read_index(&self.file, stripe, column)?)
3098 }
3099 };
3100 let page = if whole {
3101 self.pages.fetch_add(1, Atomic::Relaxed);
3102 let span = stripe.pages.get(column).ok_or_else(|| invalid("stripe page is missing"))?;
3103 let mut bytes = vec![0; span.length as usize];
3104 read_at(&self.file, span.offset, &mut bytes)?;
3105 Some(Arc::new(bytes))
3106 } else {
3107 None
3108 };
3109 Ok(CachedColumn { stripe: at, index, page })
3110 }
3111
3112 fn read_impl(&self, at: usize, columns: &[usize], whole: bool) -> Result<Chunk> {
3113 let place = *self.places.get(at).ok_or_else(|| invalid("part index out of range"))?;
3114 let index = place.stripe as usize;
3115 let stripe =
3116 self.table.stripes.get(index).ok_or_else(|| invalid("stripe index out of range"))?;
3117 let rows = place.rows as usize;
3118 let mut picked = Vec::with_capacity(columns.len());
3119 for &column in columns {
3120 let field = self
3121 .table
3122 .fields
3123 .get(column)
3124 .ok_or_else(|| invalid("column index out of range"))?;
3125 let page = stripe.pages.get(column).ok_or_else(|| invalid("stripe page is missing"))?;
3126 let held = self.held(index, stripe, column, whole)?;
3127 let span = *held
3128 .index
3129 .get(place.part as usize)
3130 .ok_or_else(|| invalid("part index out of range"))?;
3131 let owned;
3132 let bytes = match &held.page {
3133 Some(held) => part_bytes(held, span)?,
3134 None => {
3135 let offset = page
3136 .offset
3137 .checked_add(span.start as u64)
3138 .ok_or_else(|| invalid("part range overflow"))?;
3139 let mut bytes = vec![0; span.length];
3140 read_at(&self.file, offset, &mut bytes)?;
3141 owned = bytes;
3142 &owned
3143 }
3144 };
3145 if checksum(bytes) != span.hash {
3146 return Err(invalid(&format!(
3147 "column page checksum differs, column {column} part {} at {}+{} of {} bytes, \
3148 wanted {:016x} and got {:016x}",
3149 place.part,
3150 page.offset,
3151 span.start,
3152 span.length,
3153 span.hash,
3154 checksum(bytes),
3155 )));
3156 }
3157 let dictionary = self.dictionary(column)?;
3158 picked.push(decode(&field.ty, rows, bytes, dictionary)?);
3159 }
3160 Chunk::with_rows(picked, rows)
3161 }
3162
3163 #[must_use]
3179 pub fn skips(&self, part: usize, probes: &[Probe]) -> bool {
3180 let Some(place) = self.places.get(part).copied() else { return false };
3181 let Some(stripe) = self.table.stripes.get(place.stripe as usize) else { return false };
3182 if stripe.zone.skips(probes) {
3183 return true;
3184 }
3185 probes.iter().any(|probe| self.outside(place, probe) || self.sifted(place, probe))
3186 }
3187
3188 fn outside(&self, place: Place, probe: &Probe) -> bool {
3194 match self.stripe_part_ranges(place.stripe as usize, probe.column) {
3195 Some(ranges) => ranges
3196 .get(place.part as usize)
3197 .is_some_and(|range| range.excludes(probe.op, &probe.value)),
3198 None => false,
3199 }
3200 }
3201
3202 fn stripe_part_ranges(&self, stripe: usize, column: usize) -> Option<&[Range]> {
3208 let slot = self.part_ranges.get(column)?.get(stripe)?;
3209 if let Some(held) = slot.get() {
3210 return Some(held);
3211 }
3212 let page = self.table.stripes.get(stripe)?.part_ranges.get(column).copied().flatten()?;
3213 let mut bytes = vec![0; page.length as usize];
3214 read_at(&self.file, page.offset, &mut bytes).ok()?;
3215 if checksum(&bytes) != page.hash {
3216 return None;
3217 }
3218 let ranges = Arc::new(decode_part_ranges(&bytes).ok()?);
3219 let _ = slot.set(ranges);
3220 slot.get().map(|held| held.as_slice())
3221 }
3222
3223 #[must_use]
3240 pub fn certain(&self, part: usize, probes: &[Probe]) -> bool {
3241 let Some(place) = self.places.get(part).copied() else { return false };
3242 let Some(stripe) = self.table.stripes.get(place.stripe as usize) else { return false };
3243 if stripe.zone.certain(probes) {
3244 return true;
3245 }
3246 probes
3247 .iter()
3248 .all(|probe| stripe.zone.certain(slice::from_ref(probe)) || self.inside(place, probe))
3249 }
3250
3251 fn inside(&self, place: Place, probe: &Probe) -> bool {
3257 match self.stripe_part_ranges(place.stripe as usize, probe.column) {
3258 Some(ranges) => ranges
3259 .get(place.part as usize)
3260 .is_some_and(|range| range.certain(probe.op, &probe.value)),
3261 None => false,
3262 }
3263 }
3264
3265 #[must_use]
3276 pub fn stripe_skips(&self, stripe: usize, probes: &[Probe]) -> bool {
3277 self.table.stripes.get(stripe).is_some_and(|held| held.zone.skips(probes))
3278 }
3279
3280 fn sifted(&self, place: Place, probe: &Probe) -> bool {
3286 if probe.op != Op::Equal {
3287 return false;
3288 }
3289 match self.stripe_sieves(place.stripe as usize, probe.column) {
3290 Some(sieves) => sieves
3291 .get(place.part as usize)
3292 .and_then(Option::as_ref)
3293 .is_some_and(|sieve| sieve.excludes(&probe.value)),
3294 None => false,
3295 }
3296 }
3297
3298 fn stripe_sieves(&self, stripe: usize, column: usize) -> Option<&[Option<Sieve>]> {
3305 let slot = self.sieves.get(column)?.get(stripe)?;
3306 if let Some(held) = slot.get() {
3307 return Some(held);
3308 }
3309 let page = self.table.stripes.get(stripe)?.sieves.get(column).copied().flatten()?;
3310 let mut bytes = vec![0; page.length as usize];
3311 read_at(&self.file, page.offset, &mut bytes).ok()?;
3312 if checksum(&bytes) != page.hash {
3313 return None;
3314 }
3315 let sieves = Arc::new(decode_sieves(&bytes).ok()?);
3316 let _ = slot.set(sieves);
3317 slot.get().map(|held| held.as_slice())
3318 }
3319}
3320
3321fn text_at_rank(dictionary: &Vector, rank: usize) -> Result<Value> {
3323 let code = dictionary.code_at_rank(rank)? as usize;
3324 let text = dictionary
3325 .try_text_at(code)?
3326 .ok_or_else(|| invalid("global dictionary order names a code it does not have"))?;
3327 Ok(Value::Varchar(text.into()))
3328}
3329
3330#[cfg(unix)]
3335fn write_at(file: &File, mut offset: u64, mut bytes: &[u8]) -> Result<()> {
3336 use std::os::unix::fs::FileExt;
3337 while !bytes.is_empty() {
3338 let written = file.write_at(bytes, offset).map_err(io)?;
3339 if written == 0 {
3340 return Err(invalid("a write to the native file wrote nothing"));
3341 }
3342 offset += written as u64;
3343 bytes = &bytes[written..];
3344 }
3345 Ok(())
3346}
3347
3348#[cfg(windows)]
3350fn write_at(file: &File, mut offset: u64, mut bytes: &[u8]) -> Result<()> {
3351 use std::os::windows::fs::FileExt;
3352 while !bytes.is_empty() {
3353 let written = file.seek_write(bytes, offset).map_err(io)?;
3354 if written == 0 {
3355 return Err(invalid("a write to the native file wrote nothing"));
3356 }
3357 offset += written as u64;
3358 bytes = &bytes[written..];
3359 }
3360 Ok(())
3361}
3362
3363#[cfg(not(any(unix, windows)))]
3365fn write_at(file: &File, offset: u64, bytes: &[u8]) -> Result<()> {
3366 use std::io::Write;
3367 let mut file = file.try_clone().map_err(io)?;
3368 file.seek(SeekFrom::Start(offset)).map_err(io)?;
3369 file.write_all(bytes).map_err(io)
3370}
3371
3372#[cfg(unix)]
3382fn read_at(file: &File, mut offset: u64, mut bytes: &mut [u8]) -> Result<()> {
3383 use std::os::unix::fs::FileExt;
3384 while !bytes.is_empty() {
3385 let read = file.read_at(bytes, offset).map_err(io)?;
3386 if read == 0 {
3387 return Err(invalid("column page ends before its declared length"));
3388 }
3389 offset += read as u64;
3390 bytes = &mut bytes[read..];
3391 }
3392 Ok(())
3393}
3394
3395#[cfg(windows)]
3401fn read_at(file: &File, mut offset: u64, mut bytes: &mut [u8]) -> Result<()> {
3402 use std::os::windows::fs::FileExt;
3403 while !bytes.is_empty() {
3404 let read = file.seek_read(bytes, offset).map_err(io)?;
3405 if read == 0 {
3406 return Err(invalid("column page ends before its declared length"));
3407 }
3408 offset += read as u64;
3409 bytes = &mut bytes[read..];
3410 }
3411 Ok(())
3412}
3413
3414#[cfg(not(any(unix, windows)))]
3419fn read_at(file: &File, offset: u64, bytes: &mut [u8]) -> Result<()> {
3420 let mut file = file.try_clone().map_err(io)?;
3421 file.seek(SeekFrom::Start(offset)).map_err(io)?;
3422 file.read_exact(bytes).map_err(io)
3423}
3424
3425fn type_tag(ty: &LogicalType) -> Result<u8> {
3426 match ty {
3427 LogicalType::SmallInt => Ok(1),
3428 LogicalType::Integer => Ok(2),
3429 LogicalType::BigInt => Ok(3),
3430 LogicalType::Varchar => Ok(4),
3431 LogicalType::Date => Ok(5),
3432 LogicalType::Timestamp => Ok(6),
3433 LogicalType::Boolean => Ok(7),
3434 LogicalType::TinyInt => Ok(8),
3435 LogicalType::UTinyInt => Ok(9),
3436 LogicalType::USmallInt => Ok(10),
3437 LogicalType::UInteger => Ok(11),
3438 LogicalType::UBigInt => Ok(12),
3439 LogicalType::Decimal { .. } => Ok(13),
3440 _ => Err(Error::not_implemented(format!("native storage for {ty}"))),
3441 }
3442}
3443
3444fn put_type(out: &mut Vec<u8>, ty: &LogicalType) -> Result<()> {
3450 out.push(type_tag(ty)?);
3451 if let LogicalType::Decimal { width, scale } = ty {
3452 out.push(*width);
3453 out.push(*scale);
3454 }
3455 Ok(())
3456}
3457
3458fn read_type(cur: &mut Cursor<'_>) -> Result<LogicalType> {
3460 let tag = cur.u8()?;
3461 if tag == 13 {
3462 let width = cur.u8()?;
3463 let scale = cur.u8()?;
3464 return LogicalType::decimal(width, scale)
3465 .map_err(|_| invalid("decimal column width and scale are not a decimal"));
3466 }
3467 tag_type(tag)
3468}
3469
3470fn tag_type(tag: u8) -> Result<LogicalType> {
3471 match tag {
3472 1 => Ok(LogicalType::SmallInt),
3473 2 => Ok(LogicalType::Integer),
3474 3 => Ok(LogicalType::BigInt),
3475 4 => Ok(LogicalType::Varchar),
3476 5 => Ok(LogicalType::Date),
3477 6 => Ok(LogicalType::Timestamp),
3478 7 => Ok(LogicalType::Boolean),
3479 8 => Ok(LogicalType::TinyInt),
3480 9 => Ok(LogicalType::UTinyInt),
3481 10 => Ok(LogicalType::USmallInt),
3482 11 => Ok(LogicalType::UInteger),
3483 12 => Ok(LogicalType::UBigInt),
3484 _ => Err(invalid("column type tag is unknown")),
3485 }
3486}
3487
3488fn put_u16(out: &mut Vec<u8>, value: u16) {
3489 out.extend_from_slice(&value.to_le_bytes());
3490}
3491fn put_u32(out: &mut Vec<u8>, value: u32) {
3492 out.extend_from_slice(&value.to_le_bytes());
3493}
3494fn put_u64(out: &mut Vec<u8>, value: u64) {
3495 out.extend_from_slice(&value.to_le_bytes());
3496}
3497fn put_var_u64(out: &mut Vec<u8>, mut value: u64) {
3498 while value >= 0x80 {
3499 out.push((value as u8 & 0x7f) | 0x80);
3500 value >>= 7;
3501 }
3502 out.push(value as u8);
3503}
3504
3505fn frequency_order(left: FrequencyValue, right: FrequencyValue) -> Ordering {
3506 match (left, right) {
3507 (FrequencyValue::Null, FrequencyValue::Null) => Ordering::Equal,
3508 (FrequencyValue::Null, _) => Ordering::Less,
3509 (_, FrequencyValue::Null) => Ordering::Greater,
3510 (FrequencyValue::Integer(left), FrequencyValue::Integer(right)) => left.cmp(&right),
3511 (FrequencyValue::Code(left), FrequencyValue::Code(right)) => left.cmp(&right),
3512 (FrequencyValue::Integer(_), FrequencyValue::Code(_)) => Ordering::Less,
3513 (FrequencyValue::Code(_), FrequencyValue::Integer(_)) => Ordering::Greater,
3514 }
3515}
3516
3517fn code_frequency(dictionary: &GlobalDictionary) -> FrequencySummary {
3518 let mut entries = dictionary
3519 .counts
3520 .iter()
3521 .enumerate()
3522 .filter(|(_, count)| **count != 0)
3523 .map(|(code, &count)| FrequencyEntry { value: FrequencyValue::Code(code as u32), count })
3524 .collect::<Vec<_>>();
3525 if dictionary.nulls != 0 {
3526 entries.push(FrequencyEntry { value: FrequencyValue::Null, count: dictionary.nulls });
3527 }
3528 entries.sort_unstable_by(|left, right| {
3529 right.count.cmp(&left.count).then_with(|| frequency_order(left.value, right.value))
3530 });
3531 let omitted_max = entries.get(FREQUENCY_ENTRIES).map_or(0, |entry| entry.count);
3532 entries.truncate(FREQUENCY_ENTRIES);
3533 FrequencySummary { entries, omitted_max, ordinals: Vec::new() }
3534}
3535
3536fn encode_directory(table: &Table) -> Result<Vec<u8>> {
3537 let mut out = DIRECTORY.to_vec();
3538 let name = table.name.as_bytes();
3539 put_u16(&mut out, u16::try_from(name.len()).map_err(|_| invalid("table name too long"))?);
3540 out.extend_from_slice(name);
3541 put_u16(&mut out, u16::try_from(table.fields.len()).map_err(|_| invalid("too many columns"))?);
3542 for field in &table.fields {
3543 let name = field.name.as_bytes();
3544 put_u16(&mut out, u16::try_from(name.len()).map_err(|_| invalid("column name too long"))?);
3545 out.extend_from_slice(name);
3546 put_type(&mut out, &field.ty)?;
3547 out.push(u8::from(field.not_null));
3548 }
3549 for dictionary in &table.dictionaries {
3550 match dictionary {
3551 None => out.push(0),
3552 Some(page) => {
3553 out.push(1);
3554 put_u64(&mut out, page.offset);
3555 put_u32(&mut out, page.length);
3556 put_u64(&mut out, page.hash);
3557 }
3558 }
3559 }
3560 for distinct in &table.distincts {
3561 match distinct {
3562 None => out.push(0),
3563 Some(count) => {
3564 out.push(1);
3565 put_u64(&mut out, *count);
3566 }
3567 }
3568 }
3569 put_u64(&mut out, u64::try_from(table.rows).map_err(|_| invalid("row count overflow"))?);
3570 put_u32(&mut out, u32::try_from(table.stripes.len()).map_err(|_| invalid("too many stripes"))?);
3571 for stripe in &table.stripes {
3572 put_u32(
3573 &mut out,
3574 u32::try_from(stripe.parts.len()).map_err(|_| invalid("too many parts in a stripe"))?,
3575 );
3576 for &rows in &stripe.parts {
3577 put_u32(&mut out, rows);
3578 }
3579 put_u64(&mut out, stripe.index.offset);
3580 put_u32(&mut out, stripe.index.length);
3581 for page in &stripe.pages {
3582 put_u64(&mut out, page.offset);
3583 put_u32(&mut out, page.length);
3584 }
3585 for (field, membership) in table.fields.iter().zip(&stripe.memberships) {
3586 if field.ty != LogicalType::Varchar {
3587 continue;
3588 }
3589 let page =
3590 membership.ok_or_else(|| invalid("string page has no code membership index"))?;
3591 put_u64(&mut out, page.offset);
3592 put_u32(&mut out, page.length);
3593 put_u64(&mut out, page.hash);
3594 }
3595 for sieve in &stripe.sieves {
3596 match sieve {
3597 None => out.push(0),
3598 Some(page) => {
3599 out.push(1);
3600 put_u64(&mut out, page.offset);
3601 put_u32(&mut out, page.length);
3602 put_u64(&mut out, page.hash);
3603 }
3604 }
3605 }
3606 for held in &stripe.part_ranges {
3607 match held {
3608 None => out.push(0),
3609 Some(page) => {
3610 out.push(1);
3611 put_u64(&mut out, page.offset);
3612 put_u32(&mut out, page.length);
3613 put_u64(&mut out, page.hash);
3614 }
3615 }
3616 }
3617 for range in stripe.zone.columns() {
3618 put_bound(&mut out, range.low.as_ref())?;
3619 put_bound(&mut out, range.high.as_ref())?;
3620 put_u32(
3621 &mut out,
3622 u32::try_from(range.nulls).map_err(|_| invalid("null count overflow"))?,
3623 );
3624 out.push(u8::from(range.exact));
3625 match range.sum {
3626 None => out.push(0),
3627 Some(total) => {
3628 out.push(1);
3629 out.extend_from_slice(&total.to_le_bytes());
3630 }
3631 }
3632 }
3633 }
3634 out.extend_from_slice(FREQUENCIES);
3635 put_u16(
3636 &mut out,
3637 u16::try_from(table.frequencies.len())
3638 .map_err(|_| invalid("too many frequency columns"))?,
3639 );
3640 for summary in &table.frequencies {
3641 let Some(summary) = summary else {
3642 out.push(0);
3643 continue;
3644 };
3645 out.push(1);
3646 put_u64(&mut out, summary.omitted_max);
3647 put_u32(
3648 &mut out,
3649 u32::try_from(summary.entries.len())
3650 .map_err(|_| invalid("too many frequency entries"))?,
3651 );
3652 for entry in &summary.entries {
3653 match entry.value {
3654 FrequencyValue::Null => out.push(0),
3655 FrequencyValue::Integer(value) => {
3656 out.push(1);
3657 out.extend_from_slice(&value.to_le_bytes());
3658 }
3659 FrequencyValue::Code(value) => {
3660 out.push(2);
3661 put_u32(&mut out, value);
3662 }
3663 }
3664 put_u64(&mut out, entry.count);
3665 }
3666 put_u32(
3667 &mut out,
3668 u32::try_from(summary.ordinals.len())
3669 .map_err(|_| invalid("too many frequency ordinals"))?,
3670 );
3671 let mut previous = 0_u64;
3672 for (at, &ordinal) in summary.ordinals.iter().enumerate() {
3673 let delta = if at == 0 {
3674 ordinal
3675 } else {
3676 ordinal
3677 .checked_sub(previous)
3678 .ok_or_else(|| invalid("frequency ordinals are not ordered"))?
3679 };
3680 if at != 0 && delta == 0 {
3681 return Err(invalid("frequency ordinals are not unique"));
3682 }
3683 put_var_u64(&mut out, delta);
3684 previous = ordinal;
3685 }
3686 }
3687 Ok(out)
3688}
3689
3690fn encode_catalog(entries: &[Entry]) -> Result<Vec<u8>> {
3696 let mut out = CATALOG.to_vec();
3697 put_u32(&mut out, u32::try_from(entries.len()).map_err(|_| invalid("too many tables"))?);
3698 for entry in entries {
3699 let name = entry.name.as_bytes();
3700 put_u16(&mut out, u16::try_from(name.len()).map_err(|_| invalid("table name too long"))?);
3701 out.extend_from_slice(name);
3702 put_u64(&mut out, u64::try_from(entry.rows).map_err(|_| invalid("row count overflow"))?);
3703 put_u16(
3704 &mut out,
3705 u16::try_from(entry.fields.len()).map_err(|_| invalid("too many columns"))?,
3706 );
3707 for field in &entry.fields {
3708 let name = field.name.as_bytes();
3709 put_u16(
3710 &mut out,
3711 u16::try_from(name.len()).map_err(|_| invalid("column name too long"))?,
3712 );
3713 out.extend_from_slice(name);
3714 put_type(&mut out, &field.ty)?;
3715 out.push(u8::from(field.not_null));
3716 }
3717 put_u64(&mut out, entry.directory.offset);
3718 put_u32(&mut out, entry.directory.length);
3719 put_u64(&mut out, entry.directory.hash);
3720 }
3721 Ok(out)
3722}
3723
3724fn decode_catalog(bytes: &[u8], size: u64) -> Result<Vec<Entry>> {
3727 let mut cur = Cursor { bytes, at: 0 };
3728 if cur.take(8)? != CATALOG {
3729 return Err(invalid("catalog magic differs"));
3730 }
3731 let count = cur.u32()? as usize;
3732 let mut entries: Vec<Entry> = Vec::with_capacity(count.min(1024));
3733 for _ in 0..count {
3734 let name = cur.text()?;
3735 let rows = usize::try_from(cur.u64()?).map_err(|_| invalid("row count does not fit"))?;
3736 let width = cur.u16()? as usize;
3737 let mut fields = Vec::with_capacity(width);
3738 for _ in 0..width {
3739 let name = cur.text()?;
3740 let ty = read_type(&mut cur)?;
3741 let not_null = match cur.u8()? {
3742 0 => false,
3743 1 => true,
3744 _ => return Err(invalid("nullability flag differs")),
3745 };
3746 fields.push(Field { name, ty, not_null });
3747 }
3748 let directory = Page { offset: cur.u64()?, length: cur.u32()?, hash: cur.u64()? };
3749 let end = directory
3750 .offset
3751 .checked_add(u64::from(directory.length))
3752 .ok_or_else(|| invalid("table directory offset overflow"))?;
3753 if directory.offset < HEADER
3754 || end > size
3755 || directory.length as usize > MAX_DIRECTORY
3756 || directory.length == 0
3757 {
3758 return Err(invalid("table directory range is outside the file"));
3759 }
3760 if entries.iter().any(|held| held.name == name) {
3761 return Err(invalid("two tables in the catalog have the same name"));
3762 }
3763 entries.push(Entry { name, fields, rows, directory });
3764 }
3765 Ok(entries)
3766}
3767
3768struct Cursor<'a> {
3769 bytes: &'a [u8],
3770 at: usize,
3771}
3772impl<'a> Cursor<'a> {
3773 fn take(&mut self, len: usize) -> Result<&'a [u8]> {
3774 let end = self.at.checked_add(len).ok_or_else(|| invalid("directory offset overflow"))?;
3775 let bytes =
3776 self.bytes.get(self.at..end).ok_or_else(|| invalid("directory is truncated"))?;
3777 self.at = end;
3778 Ok(bytes)
3779 }
3780 fn u8(&mut self) -> Result<u8> {
3781 Ok(self.take(1)?[0])
3782 }
3783 fn u16(&mut self) -> Result<u16> {
3784 Ok(u16::from_le_bytes(self.take(2)?.try_into().expect("two bytes")))
3785 }
3786 fn u32(&mut self) -> Result<u32> {
3787 Ok(u32::from_le_bytes(self.take(4)?.try_into().expect("four bytes")))
3788 }
3789 fn u64(&mut self) -> Result<u64> {
3790 Ok(u64::from_le_bytes(self.take(8)?.try_into().expect("eight bytes")))
3791 }
3792 fn var_u64(&mut self) -> Result<u64> {
3793 let mut value = 0_u64;
3794 for shift in (0..=63).step_by(7) {
3795 let byte = self.u8()?;
3796 let part = u64::from(byte & 0x7f);
3797 if shift == 63 && part > 1 {
3798 return Err(invalid("frequency ordinal varint overflows"));
3799 }
3800 value |= part << shift;
3801 if byte & 0x80 == 0 {
3802 return Ok(value);
3803 }
3804 }
3805 Err(invalid("frequency ordinal varint is too long"))
3806 }
3807 fn bound(&mut self) -> Result<Option<Bound>> {
3808 Ok(match self.u8()? {
3809 0 => None,
3810 1 => Some(Bound::Int(i128::from_le_bytes(
3811 self.take(16)?.try_into().expect("sixteen bytes"),
3812 ))),
3813 2 => Some(Bound::Real(f64::from_le_bytes(
3814 self.take(8)?.try_into().expect("eight bytes"),
3815 ))),
3816 3 => {
3817 let length = self.u32()? as usize;
3818 Some(Bound::Bytes(self.take(length)?.to_vec()))
3819 }
3820 4 => {
3821 let unscaled =
3822 i128::from_le_bytes(self.take(16)?.try_into().expect("sixteen bytes"));
3823 Some(Bound::Scaled { unscaled, scale: self.u8()? })
3824 }
3825 _ => return Err(invalid("bound tag differs")),
3826 })
3827 }
3828 fn text(&mut self) -> Result<String> {
3829 let len = self.u16()? as usize;
3830 String::from_utf8(self.take(len)?.to_vec()).map_err(|_| invalid("name is not UTF-8"))
3831 }
3832}
3833
3834fn decode_directory(bytes: &[u8], size: u64) -> Result<Table> {
3835 let mut cur = Cursor { bytes, at: 0 };
3836 if cur.take(8)? != DIRECTORY {
3837 return Err(invalid("directory magic differs"));
3838 }
3839 let name = cur.text()?;
3840 let width = cur.u16()? as usize;
3841 let mut fields = Vec::with_capacity(width);
3842 for _ in 0..width {
3843 let name = cur.text()?;
3844 let ty = read_type(&mut cur)?;
3845 let not_null = match cur.u8()? {
3846 0 => false,
3847 1 => true,
3848 _ => return Err(invalid("nullability flag differs")),
3849 };
3850 fields.push(Field { name, ty, not_null });
3851 }
3852 let mut dictionaries = Vec::with_capacity(width);
3853 for _ in 0..width {
3854 dictionaries.push(match cur.u8()? {
3855 0 => None,
3856 1 => {
3857 let page = Page { offset: cur.u64()?, length: cur.u32()?, hash: cur.u64()? };
3858 let end = page
3859 .offset
3860 .checked_add(u64::from(page.length))
3861 .ok_or_else(|| invalid("dictionary page offset overflow"))?;
3862 if page.offset < HEADER || end > size {
3867 return Err(invalid("dictionary page range is outside the file"));
3868 }
3869 Some(page)
3870 }
3871 _ => return Err(invalid("dictionary page tag differs")),
3872 });
3873 }
3874 let mut distincts = Vec::with_capacity(width);
3875 for _ in 0..width {
3876 distincts.push(match cur.u8()? {
3877 0 => None,
3878 1 => Some(cur.u64()?),
3879 _ => return Err(invalid("distinct count tag differs")),
3880 });
3881 }
3882 let rows = usize::try_from(cur.u64()?).map_err(|_| invalid("row count does not fit"))?;
3883 let count = cur.u32()? as usize;
3884 let mut stripes = Vec::with_capacity(count);
3885 let mut total = 0_usize;
3886 for _ in 0..count {
3887 let count = cur.u32()? as usize;
3888 if count == 0 || count > STRIPE_PARTS {
3889 return Err(invalid("stripe part count is outside its bound"));
3890 }
3891 let mut parts = Vec::with_capacity(count);
3892 let mut stripe_rows = 0_usize;
3893 for _ in 0..count {
3894 let rows = cur.u32()?;
3895 if rows == 0 {
3896 return Err(invalid("empty part"));
3897 }
3898 parts.push(rows);
3899 stripe_rows = stripe_rows
3900 .checked_add(rows as usize)
3901 .ok_or_else(|| invalid("stripe row count overflow"))?;
3902 }
3903 total =
3904 total.checked_add(stripe_rows).ok_or_else(|| invalid("stripe row count overflow"))?;
3905 let index = Span { offset: cur.u64()?, length: cur.u32()? };
3906 let section = index_section(count)?;
3907 let wanted = section
3908 .checked_mul(width)
3909 .and_then(|bytes| u32::try_from(bytes).ok())
3910 .ok_or_else(|| invalid("index page length overflow"))?;
3911 let end = index
3912 .offset
3913 .checked_add(u64::from(index.length))
3914 .ok_or_else(|| invalid("index page offset overflow"))?;
3915 if index.offset < HEADER || end > size || index.length != wanted {
3916 return Err(invalid("index page range is outside the file"));
3917 }
3918 let mut pages = Vec::with_capacity(width);
3919 for _ in 0..width {
3920 let offset = cur.u64()?;
3921 let length = cur.u32()?;
3922 let end = offset
3923 .checked_add(u64::from(length))
3924 .ok_or_else(|| invalid("page offset overflow"))?;
3925 if offset < HEADER || end > size || length as usize > MAX_PAGE {
3926 return Err(invalid("page range is outside the file"));
3927 }
3928 pages.push(Span { offset, length });
3929 }
3930 let mut memberships = vec![None; width];
3931 for (column, field) in fields.iter().enumerate() {
3932 if field.ty != LogicalType::Varchar {
3933 continue;
3934 }
3935 let page = Page { offset: cur.u64()?, length: cur.u32()?, hash: cur.u64()? };
3936 let end = page
3937 .offset
3938 .checked_add(u64::from(page.length))
3939 .ok_or_else(|| invalid("membership page offset overflow"))?;
3940 if page.offset < HEADER || end > size || page.length as usize > MAX_PAGE {
3941 return Err(invalid("membership page range is outside the file"));
3942 }
3943 memberships[column] = Some(page);
3944 }
3945 let mut sieves = vec![None; width];
3946 for sieve in sieves.iter_mut().take(width) {
3947 match cur.u8()? {
3948 0 => continue,
3949 1 => {}
3950 _ => return Err(invalid("a sieve page has an unknown tag")),
3951 }
3952 let page = Page { offset: cur.u64()?, length: cur.u32()?, hash: cur.u64()? };
3953 let end = page
3954 .offset
3955 .checked_add(u64::from(page.length))
3956 .ok_or_else(|| invalid("sieve page offset overflow"))?;
3957 if page.offset < HEADER || end > size || page.length as usize > MAX_PAGE {
3958 return Err(invalid("sieve page range is outside the file"));
3959 }
3960 *sieve = Some(page);
3961 }
3962 let mut part_ranges = vec![None; width];
3963 for held in part_ranges.iter_mut().take(width) {
3964 match cur.u8()? {
3965 0 => continue,
3966 1 => {}
3967 _ => return Err(invalid("a part range page has an unknown tag")),
3968 }
3969 let page = Page { offset: cur.u64()?, length: cur.u32()?, hash: cur.u64()? };
3970 let end = page
3971 .offset
3972 .checked_add(u64::from(page.length))
3973 .ok_or_else(|| invalid("part range page offset overflow"))?;
3974 if page.offset < HEADER || end > size || page.length as usize > MAX_PAGE {
3975 return Err(invalid("part range page range is outside the file"));
3976 }
3977 *held = Some(page);
3978 }
3979 let mut ranges = Vec::with_capacity(width);
3980 for column in 0..width {
3981 let low = cur.bound()?;
3982 let high = cur.bound()?;
3983 let nulls = cur.u32()? as usize;
3984 if nulls > stripe_rows {
3985 return Err(invalid("null count exceeds stripe rows"));
3986 }
3987 let exact = cur.u8()? != 0;
3988 let sum = match cur.u8()? {
3989 0 => None,
3990 1 => Some(i128::from_le_bytes(
3991 cur.take(16)?.try_into().map_err(|_| invalid("a stripe sum is truncated"))?,
3992 )),
3993 _ => return Err(invalid("a stripe sum has an unknown tag")),
3994 };
3995 let ty = &fields.get(column).ok_or_else(|| invalid("a stripe range has no column"))?.ty;
4001 let low = low.map(|bound| scaled_as(bound, ty));
4002 let high = high.map(|bound| scaled_as(bound, ty));
4003 ranges.push(Range { low, high, nulls, exact, sum });
4004 }
4005 stripes.push(Stripe {
4006 rows: stripe_rows,
4007 parts,
4008 index,
4009 pages,
4010 memberships,
4011 sieves,
4012 part_ranges,
4013 zone: Zone::from_ranges(ranges),
4014 });
4015 }
4016 if total != rows {
4017 return Err(invalid("table row count differs from stripes"));
4018 }
4019 let frequencies = if cur.at == bytes.len() {
4020 vec![None; width]
4021 } else {
4022 if cur.take(8)? != FREQUENCIES {
4023 return Err(invalid("directory extension magic differs"));
4024 }
4025 if cur.u16()? as usize != width {
4026 return Err(invalid("frequency column count differs"));
4027 }
4028 let mut frequencies = Vec::with_capacity(width);
4029 for field in &fields {
4030 let summary = match cur.u8()? {
4031 0 => None,
4032 1 => {
4033 let omitted_max = cur.u64()?;
4034 let count = cur.u32()? as usize;
4035 if count > FREQUENCY_ENTRIES {
4036 return Err(invalid("frequency entry count exceeds its bound"));
4037 }
4038 let mut entries = Vec::with_capacity(count);
4039 for _ in 0..count {
4041 let value = match cur.u8()? {
4042 0 => FrequencyValue::Null,
4043 1 => FrequencyValue::Integer(i128::from_le_bytes(
4044 cur.take(16)?.try_into().expect("sixteen bytes"),
4045 )),
4046 2 => FrequencyValue::Code(cur.u32()?),
4047 _ => return Err(invalid("frequency value tag differs")),
4048 };
4049 let valid = matches!(
4050 (&field.ty, value),
4051 (_, FrequencyValue::Null)
4052 | (LogicalType::Varchar, FrequencyValue::Code(_))
4053 | (
4054 LogicalType::TinyInt
4055 | LogicalType::SmallInt
4056 | LogicalType::Integer
4057 | LogicalType::BigInt
4058 | LogicalType::UTinyInt
4059 | LogicalType::USmallInt
4060 | LogicalType::UInteger
4061 | LogicalType::UBigInt
4062 | LogicalType::Date
4063 | LogicalType::Timestamp,
4064 FrequencyValue::Integer(_),
4065 )
4066 );
4067 if !valid {
4068 return Err(invalid("frequency value does not match its column"));
4069 }
4070 let count = cur.u64()?;
4071 if count == 0 || count > rows as u64 {
4072 return Err(invalid("frequency count is outside the table"));
4073 }
4074 entries.push(FrequencyEntry { value, count });
4075 }
4076 if entries.windows(2).any(|pair| pair[0].count < pair[1].count) {
4077 return Err(invalid("frequency entries are not descending"));
4078 }
4079 let ordinals = {
4080 let ordinal_count = cur.u32()? as usize;
4081 if ordinal_count > FREQUENCY_ORDINALS || ordinal_count > rows {
4082 return Err(invalid("frequency ordinal count exceeds its bound"));
4083 }
4084 let mut ordinals = Vec::with_capacity(ordinal_count);
4085 let mut previous = 0_u64;
4086 for at in 0..ordinal_count {
4087 let delta = cur.var_u64()?;
4088 if at != 0 && delta == 0 {
4089 return Err(invalid("frequency ordinals are not increasing"));
4090 }
4091 let ordinal = if at == 0 {
4092 delta
4093 } else {
4094 previous
4095 .checked_add(delta)
4096 .ok_or_else(|| invalid("frequency ordinal overflows"))?
4097 };
4098 if ordinal >= rows as u64 {
4099 return Err(invalid("frequency ordinal is outside the table"));
4100 }
4101 ordinals.push(ordinal);
4102 previous = ordinal;
4103 }
4104 ordinals
4105 };
4106 Some(FrequencySummary { entries, omitted_max, ordinals })
4107 }
4108 _ => return Err(invalid("frequency summary tag differs")),
4109 };
4110 frequencies.push(summary);
4111 }
4112 frequencies
4113 };
4114 if cur.at != bytes.len() {
4115 return Err(invalid("directory has trailing bytes"));
4116 }
4117 Ok(Table { name, fields, stripes, rows, dictionaries, distincts, frequencies })
4118}
4119
4120fn put_bound(out: &mut Vec<u8>, bound: Option<&Bound>) -> Result<()> {
4121 match bound {
4122 None => out.push(0),
4123 Some(Bound::Int(value)) => {
4124 out.push(1);
4125 out.extend_from_slice(&value.to_le_bytes());
4126 }
4127 Some(Bound::Real(value)) => {
4128 out.push(2);
4129 out.extend_from_slice(&value.to_le_bytes());
4130 }
4131 Some(Bound::Bytes(value)) => {
4132 out.push(3);
4133 put_u32(out, u32::try_from(value.len()).map_err(|_| invalid("bound length overflow"))?);
4134 out.extend_from_slice(value);
4135 }
4136 Some(Bound::Scaled { unscaled, scale }) => {
4137 out.push(4);
4138 out.extend_from_slice(&unscaled.to_le_bytes());
4139 out.push(*scale);
4140 }
4141 }
4142 Ok(())
4143}
4144
4145#[derive(Debug)]
4162struct Codes;
4163
4164impl chooser::Chooser for Codes {
4165 fn name(&self) -> &'static str {
4166 "codes"
4167 }
4168
4169 fn narrow_strings(
4170 &self,
4171 _values: &[&[u8]],
4172 offered: &[string::Kind],
4173 _depth: u8,
4174 ) -> Vec<string::Kind> {
4175 offered.to_vec()
4178 }
4179
4180 fn narrow_integers(
4181 &self,
4182 _values: &[i64],
4183 offered: &[integer::Kind],
4184 depth: u8,
4185 ) -> Vec<integer::Kind> {
4186 let keep: &[integer::Kind] = if depth == 0 {
4187 &[integer::Kind::Constant, integer::Kind::Packed, integer::Kind::Rle]
4188 } else {
4189 &[integer::Kind::Constant, integer::Kind::Packed]
4190 };
4191 let narrowed: Vec<integer::Kind> =
4192 offered.iter().copied().filter(|kind| keep.contains(kind)).collect();
4193 if narrowed.is_empty() { offered.to_vec() } else { narrowed }
4196 }
4197}
4198
4199#[derive(Debug)]
4211struct Fixed;
4212
4213impl chooser::Chooser for Fixed {
4214 fn name(&self) -> &'static str {
4215 "fixed"
4216 }
4217
4218 fn narrow_strings(
4219 &self,
4220 _values: &[&[u8]],
4221 offered: &[string::Kind],
4222 _depth: u8,
4223 ) -> Vec<string::Kind> {
4224 offered.to_vec()
4225 }
4226
4227 fn narrow_integers(
4228 &self,
4229 _values: &[i64],
4230 offered: &[integer::Kind],
4231 depth: u8,
4232 ) -> Vec<integer::Kind> {
4233 let keep: &[integer::Kind] = if depth == 0 {
4234 &[
4235 integer::Kind::Constant,
4236 integer::Kind::Packed,
4237 integer::Kind::Delta,
4238 integer::Kind::Rle,
4239 integer::Kind::Sparse,
4240 integer::Kind::Strided,
4241 ]
4242 } else {
4243 &[integer::Kind::Constant, integer::Kind::Packed, integer::Kind::Delta]
4244 };
4245 let narrowed: Vec<integer::Kind> =
4246 offered.iter().copied().filter(|kind| keep.contains(kind)).collect();
4247 if narrowed.is_empty() { offered.to_vec() } else { narrowed }
4248 }
4249}
4250
4251fn widened(data: &Data) -> Option<Vec<i64>> {
4258 match data {
4259 Data::Int8(values) => Some(values.iter().map(|value| i64::from(*value)).collect()),
4260 Data::UInt8(values) => Some(values.iter().map(|value| i64::from(*value)).collect()),
4261 Data::Int16(values) => Some(values.iter().map(|value| i64::from(*value)).collect()),
4262 Data::UInt16(values) => Some(values.iter().map(|value| i64::from(*value)).collect()),
4263 Data::Int32(values) => Some(values.iter().map(|value| i64::from(*value)).collect()),
4264 Data::UInt32(values) => Some(values.iter().map(|value| i64::from(*value)).collect()),
4265 Data::Int64(values) => Some(values.to_vec()),
4266 _ => None,
4267 }
4268}
4269
4270trait Narrow: Copy {
4277 const BIASED: (u32, u64);
4282
4283 fn narrow(value: i64) -> Self;
4285}
4286
4287#[allow(clippy::cast_sign_loss, reason = "a residue is a bit pattern and not a number")]
4304fn residue<T: Narrow>(value: i64) -> u64 {
4305 let (bits, bias) = T::BIASED;
4306 (value as u64).wrapping_add(bias) >> bits
4307}
4308
4309macro_rules! narrows {
4314 ($($ty:ty => $bias:expr),* $(,)?) => {$(
4315 impl Narrow for $ty {
4316 const BIASED: (u32, u64) = (<$ty>::BITS, $bias);
4317
4318 #[allow(
4319 clippy::cast_possible_truncation,
4320 clippy::cast_sign_loss,
4321 reason = "the caller has checked the bits this truncates away"
4322 )]
4323 fn narrow(value: i64) -> Self {
4324 value as Self
4325 }
4326 }
4327 )*};
4328}
4329
4330narrows! {
4331 i8 => 1 << 7,
4332 u8 => 0,
4333 i16 => 1 << 15,
4334 u16 => 0,
4335 i32 => 1 << 31,
4336 u32 => 0,
4337}
4338
4339fn fit<T: Narrow>(values: &[i64]) -> Result<Vec<T>> {
4352 let mut spilled = 0u64;
4353 for value in values {
4354 spilled |= residue::<T>(*value);
4355 }
4356 if spilled != 0 {
4357 return Err(invalid("page value is not of its type"));
4358 }
4359 Ok(values.iter().map(|value| T::narrow(*value)).collect())
4360}
4361
4362fn narrowed(ty: &LogicalType, values: Vec<i64>) -> Result<Data> {
4367 Ok(match ty {
4368 LogicalType::TinyInt => Data::Int8(fit::<i8>(&values)?.into()),
4369 LogicalType::UTinyInt => Data::UInt8(fit::<u8>(&values)?.into()),
4370 LogicalType::SmallInt => Data::Int16(fit::<i16>(&values)?.into()),
4371 LogicalType::USmallInt => Data::UInt16(fit::<u16>(&values)?.into()),
4372 LogicalType::Integer | LogicalType::Date => Data::Int32(fit::<i32>(&values)?.into()),
4373 LogicalType::UInteger => Data::UInt32(fit::<u32>(&values)?.into()),
4374 LogicalType::BigInt | LogicalType::Timestamp => Data::Int64(values.into()),
4375 LogicalType::Decimal { .. } => match ty.physical() {
4378 PhysicalType::Int16 => Data::Int16(fit::<i16>(&values)?.into()),
4379 PhysicalType::Int32 => Data::Int32(fit::<i32>(&values)?.into()),
4380 PhysicalType::Int64 => Data::Int64(values.into()),
4381 _ => return Err(invalid("cascade codec belongs to a decimal that is not an integer")),
4382 },
4383 _ => return Err(invalid("cascade codec belongs to a page that is not integers")),
4384 })
4385}
4386
4387fn plain_width(ty: &LogicalType) -> Option<usize> {
4390 Some(match ty {
4391 LogicalType::TinyInt | LogicalType::UTinyInt => 1,
4392 LogicalType::SmallInt | LogicalType::USmallInt => 2,
4393 LogicalType::Integer | LogicalType::UInteger | LogicalType::Date => 4,
4394 LogicalType::BigInt | LogicalType::Timestamp => 8,
4395 LogicalType::Decimal { .. } => match ty.physical() {
4396 PhysicalType::Int16 => 2,
4397 PhysicalType::Int32 => 4,
4398 PhysicalType::Int64 => 8,
4399 _ => return None,
4402 },
4403 _ => return None,
4404 })
4405}
4406
4407fn cascaded(
4413 flat: &Vector,
4414 ty: &LogicalType,
4415 packed: Option<&Packed<'_>>,
4416) -> Result<Option<Vec<u8>>> {
4417 let (Some(width), Some(data)) = (plain_width(ty), flat.data()) else { return Ok(None) };
4418 let Some(values) = widened(data) else { return Ok(None) };
4419 let plain = values.len().saturating_mul(width);
4420 let best = match packed {
4421 Some(packed) => plain.min(21 + size_of_val(packed.words())),
4423 None => plain,
4424 };
4425 let out = integer::encode_with(&values, &Fixed)?;
4426 Ok((out.len() < best).then_some(out))
4427}
4428
4429fn encoded_codes(codes: &[u32]) -> Result<Option<Vec<u8>>> {
4441 let wide: Vec<i64> = codes.iter().map(|code| i64::from(*code)).collect();
4442 let coded = integer::encode_with(&wide, &Codes)?;
4443 let plain = codes.len().saturating_mul(size_of::<u32>());
4444 Ok((coded.len() < plain).then_some(coded))
4445}
4446
4447fn encode(
4448 vector: &Vector,
4449 global: Option<&mut GlobalDictionary>,
4450) -> Result<(Vec<u8>, Option<Vec<u32>>)> {
4451 let ty = vector.logical_type();
4452 let flat = vector.flatten()?;
4454 let mut out = Vec::new();
4455 let mut global_codes = None;
4456 if let Some(global) = global {
4457 let mut codes = Vec::with_capacity(flat.len());
4458 for row in 0..flat.len() {
4459 let text = flat.text_at(row).unwrap_or("");
4460 let code = global.code(text)?;
4461 global.observe(code, flat.is_null_at(row))?;
4462 codes.push(code);
4463 }
4464 global_codes = Some(codes);
4465 }
4466 let membership = global_codes.as_deref().map(unique_codes);
4467 let dictionary = if global_codes.is_none() && ty == &LogicalType::Varchar {
4468 string_dictionary(&flat)?
4469 } else {
4470 None
4471 };
4472 let packed_vector = if dictionary.is_none() && global_codes.is_none() {
4473 Some(flat.bit_packed()?)
4474 } else {
4475 None
4476 };
4477 let packed = packed_vector.as_ref().and_then(Vector::packed_parts);
4478 let coded = match global_codes.as_deref() {
4479 Some(codes) => encoded_codes(codes)?,
4480 None => None,
4481 };
4482 let cascade = if dictionary.is_none() && global_codes.is_none() {
4486 cascaded(&flat, ty, packed.as_ref())?
4487 } else {
4488 None
4489 };
4490 out.push(if coded.is_some() {
4491 4
4492 } else if cascade.is_some() {
4493 5
4494 } else if global_codes.is_some() {
4495 3
4496 } else if dictionary.is_some() {
4497 1
4498 } else if packed.is_some() {
4499 2
4500 } else {
4501 0
4502 });
4503 let nulls = flat.validity();
4504 let flag = match nulls {
4505 Validity::AllValid => 0,
4506 Validity::AllInvalid => 1,
4507 Validity::Mask(_) => 2,
4508 };
4509 out.push(flag);
4510 if flag == 2 {
4511 for group in (0..vector.len()).step_by(8) {
4512 let mut bits = 0_u8;
4513 for bit in 0..8 {
4514 if group + bit < vector.len() && !flat.is_null_at(group + bit) {
4515 bits |= 1 << bit;
4516 }
4517 }
4518 out.push(bits);
4519 }
4520 }
4521 if let Some(coded) = coded {
4522 out.extend_from_slice(&coded);
4523 return Ok((out, membership));
4524 }
4525 if let Some(cascade) = cascade {
4526 out.extend_from_slice(&cascade);
4527 return Ok((out, membership));
4528 }
4529 if let Some(codes) = global_codes {
4530 for code in codes {
4531 put_u32(&mut out, code);
4532 }
4533 return Ok((out, membership));
4534 }
4535 if let Some(dictionary) = dictionary {
4536 out.extend_from_slice(&dictionary);
4537 return Ok((out, membership));
4538 }
4539 if let Some(packed) = packed {
4540 if packed.offset() != 0 {
4541 return Err(invalid("writer received a sliced packed vector"));
4542 }
4543 out.push(u8::try_from(packed.width()).map_err(|_| invalid("packed width overflow"))?);
4544 out.extend_from_slice(&packed.base().to_le_bytes());
4545 put_u32(
4546 &mut out,
4547 u32::try_from(packed.words().len()).map_err(|_| invalid("too many packed words"))?,
4548 );
4549 for word in packed.words() {
4550 put_u64(&mut out, *word);
4551 }
4552 return Ok((out, membership));
4553 }
4554 let data = flat.data().ok_or_else(|| invalid("scalar column did not flatten"))?;
4555 match (ty, data) {
4556 (LogicalType::TinyInt, Data::Int8(values)) => {
4557 for value in &**values {
4558 out.extend_from_slice(&value.to_le_bytes());
4559 }
4560 }
4561 (LogicalType::UTinyInt, Data::UInt8(values)) => {
4562 for value in &**values {
4563 out.extend_from_slice(&value.to_le_bytes());
4564 }
4565 }
4566 (LogicalType::SmallInt, Data::Int16(values)) => {
4567 for value in &**values {
4568 out.extend_from_slice(&value.to_le_bytes());
4569 }
4570 }
4571 (LogicalType::USmallInt, Data::UInt16(values)) => {
4572 for value in &**values {
4573 out.extend_from_slice(&value.to_le_bytes());
4574 }
4575 }
4576 (LogicalType::UInteger, Data::UInt32(values)) => {
4577 for value in &**values {
4578 out.extend_from_slice(&value.to_le_bytes());
4579 }
4580 }
4581 (LogicalType::UBigInt, Data::UInt64(values)) => {
4582 for value in &**values {
4583 out.extend_from_slice(&value.to_le_bytes());
4584 }
4585 }
4586 (LogicalType::Integer | LogicalType::Date, Data::Int32(values)) => {
4587 for value in &**values {
4588 out.extend_from_slice(&value.to_le_bytes());
4589 }
4590 }
4591 (LogicalType::BigInt | LogicalType::Timestamp, Data::Int64(values)) => {
4592 for value in &**values {
4593 out.extend_from_slice(&value.to_le_bytes());
4594 }
4595 }
4596 (LogicalType::Boolean, Data::Bool(values)) => {
4597 for value in &**values {
4598 out.push(u8::from(*value));
4599 }
4600 }
4601 (LogicalType::Decimal { .. }, Data::Int16(values)) => {
4604 for value in &**values {
4605 out.extend_from_slice(&value.to_le_bytes());
4606 }
4607 }
4608 (LogicalType::Decimal { .. }, Data::Int32(values)) => {
4609 for value in &**values {
4610 out.extend_from_slice(&value.to_le_bytes());
4611 }
4612 }
4613 (LogicalType::Decimal { .. }, Data::Int64(values)) => {
4614 for value in &**values {
4615 out.extend_from_slice(&value.to_le_bytes());
4616 }
4617 }
4618 (LogicalType::Decimal { .. }, Data::Int128(values)) => {
4619 for value in &**values {
4620 out.extend_from_slice(&value.to_le_bytes());
4621 }
4622 }
4623 (LogicalType::Varchar, Data::Varlen(values)) => {
4624 let mut bytes = Vec::new();
4625 put_u32(&mut out, 0);
4626 for row in 0..vector.len() {
4627 let value = values.bytes(row).ok_or_else(|| invalid("string view is invalid"))?;
4628 bytes.extend_from_slice(value);
4629 put_u32(
4630 &mut out,
4631 u32::try_from(bytes.len())
4632 .map_err(|_| invalid("string payload exceeds 4GiB"))?,
4633 );
4634 }
4635 out.extend_from_slice(&bytes);
4636 }
4637 _ => return Err(Error::not_implemented(format!("native page for {ty}"))),
4638 }
4639 Ok((out, membership))
4640}
4641
4642fn put_varint(out: &mut Vec<u8>, mut value: u32) {
4643 while value >= 0x80 {
4644 out.push((value as u8 & 0x7f) | 0x80);
4645 value >>= 7;
4646 }
4647 out.push(value as u8);
4648}
4649
4650fn unique_codes(codes: &[u32]) -> Vec<u32> {
4652 let mut unique = codes.to_vec();
4653 unique.sort_unstable();
4654 unique.dedup();
4655 unique
4656}
4657
4658fn merged_codes(lists: Vec<Vec<u32>>) -> Vec<u32> {
4664 let mut lists = lists;
4665 while lists.len() > 1 {
4666 let mut next = Vec::with_capacity(lists.len().div_ceil(2));
4667 for pair in lists.chunks(2) {
4668 match pair {
4669 [left, right] => next.push(merged_pair(left, right)),
4670 [only] => next.push(only.clone()),
4671 _ => {}
4672 }
4673 }
4674 lists = next;
4675 }
4676 lists.pop().unwrap_or_default()
4677}
4678
4679fn merged_pair(left: &[u32], right: &[u32]) -> Vec<u32> {
4680 let mut out = Vec::with_capacity(left.len().saturating_add(right.len()));
4681 let mut at = 0;
4682 let mut to = 0;
4683 while at < left.len() && to < right.len() {
4684 match left[at].cmp(&right[to]) {
4685 Ordering::Less => {
4686 out.push(left[at]);
4687 at += 1;
4688 }
4689 Ordering::Greater => {
4690 out.push(right[to]);
4691 to += 1;
4692 }
4693 Ordering::Equal => {
4694 out.push(left[at]);
4695 at += 1;
4696 to += 1;
4697 }
4698 }
4699 }
4700 out.extend_from_slice(&left[at..]);
4701 out.extend_from_slice(&right[to..]);
4702 out
4703}
4704
4705fn merged_range(ranges: impl Iterator<Item = Range>) -> Range {
4710 let mut merged = Range::default();
4711 let mut first = true;
4712 for range in ranges {
4713 merged.nulls = merged.nulls.saturating_add(range.nulls);
4714 merged.sum = match (merged.sum.take(), range.sum) {
4718 (Some(held), Some(next)) if !first => held.checked_add(next),
4719 (_, next) if first => next,
4720 _ => None,
4721 };
4722 merged.exact = if first { range.exact } else { merged.exact && range.exact };
4723 if first {
4724 merged.low = range.low;
4725 merged.high = range.high;
4726 first = false;
4727 continue;
4728 }
4729 merged.low = match (merged.low.take(), range.low) {
4730 (Some(held), Some(next)) => Some(held.smaller(next)),
4731 _ => None,
4732 };
4733 merged.high = match (merged.high.take(), range.high) {
4734 (Some(held), Some(next)) => Some(held.larger(next)),
4735 _ => None,
4736 };
4737 }
4738 merged
4739}
4740
4741fn shortened(bound: Option<Bound>, high: bool) -> Option<Bound> {
4754 match bound {
4755 Some(Bound::Bytes(mut value)) if value.len() > PART_BOUND_BYTES => {
4756 value.truncate(PART_BOUND_BYTES);
4757 if !high {
4758 return Some(Bound::Bytes(value));
4759 }
4760 while let Some(last) = value.pop() {
4761 if last < u8::MAX {
4762 value.push(last + 1);
4763 return Some(Bound::Bytes(value));
4764 }
4765 }
4766 None
4767 }
4768 other => other,
4769 }
4770}
4771
4772fn encode_part_ranges(ranges: &[Range]) -> Result<Vec<u8>> {
4780 let mut out = Vec::new();
4781 put_u32(
4782 &mut out,
4783 u32::try_from(ranges.len()).map_err(|_| invalid("too many parts in a stripe"))?,
4784 );
4785 for range in ranges {
4786 put_bound(&mut out, shortened(range.low.clone(), false).as_ref())?;
4787 put_bound(&mut out, shortened(range.high.clone(), true).as_ref())?;
4788 put_u32(&mut out, u32::try_from(range.nulls).map_err(|_| invalid("null count overflow"))?);
4789 }
4790 Ok(out)
4791}
4792
4793fn decode_part_ranges(bytes: &[u8]) -> Result<Vec<Range>> {
4795 let mut cur = Cursor { bytes, at: 0 };
4796 let parts = cur.u32()? as usize;
4797 let mut out = Vec::new();
4798 for _ in 0..parts {
4799 let low = cur.bound()?;
4800 let high = cur.bound()?;
4801 let nulls = cur.u32()? as usize;
4802 out.push(Range { low, high, nulls, exact: false, sum: None });
4803 }
4804 Ok(out)
4805}
4806
4807fn encode_sieves<'a>(sieves: impl Iterator<Item = &'a Option<Sieve>>) -> Result<Vec<u8>> {
4808 let held: Vec<&Option<Sieve>> = sieves.collect();
4809 let mut out = Vec::new();
4810 put_u32(
4811 &mut out,
4812 u32::try_from(held.len()).map_err(|_| invalid("too many parts in a stripe"))?,
4813 );
4814 for sieve in &held {
4815 let length = sieve.as_ref().map_or(0, Sieve::len);
4816 put_u32(&mut out, u32::try_from(length).map_err(|_| invalid("sieve length overflow"))?);
4817 }
4818 for sieve in held.into_iter().flatten() {
4820 out.extend_from_slice(&sieve.to_bytes());
4821 }
4822 Ok(out)
4823}
4824
4825fn decode_sieves(bytes: &[u8]) -> Result<Vec<Option<Sieve>>> {
4831 let parts = u32::from_le_bytes(
4832 bytes
4833 .get(..4)
4834 .ok_or_else(|| invalid("sieve page is truncated"))?
4835 .try_into()
4836 .map_err(|_| invalid("sieve page is truncated"))?,
4837 ) as usize;
4838 let mut lengths = Vec::with_capacity(parts);
4839 for part in 0..parts {
4840 let at = 4 + part * 4;
4841 let field = bytes.get(at..at + 4).ok_or_else(|| invalid("sieve page is truncated"))?;
4842 lengths.push(u32::from_le_bytes(
4843 field.try_into().map_err(|_| invalid("sieve page is truncated"))?,
4844 ) as usize);
4845 }
4846 let mut at = 4 + parts * 4;
4847 let mut out = Vec::with_capacity(parts);
4848 for length in lengths {
4849 if length == 0 {
4850 out.push(None);
4851 continue;
4852 }
4853 let end = at.checked_add(length).ok_or_else(|| invalid("sieve page is truncated"))?;
4854 let field = bytes.get(at..end).ok_or_else(|| invalid("sieve page is truncated"))?;
4855 out.push(Sieve::from_bytes(field));
4856 at = end;
4857 }
4858 if at != bytes.len() {
4859 return Err(invalid("sieve page has trailing bytes"));
4860 }
4861 Ok(out)
4862}
4863
4864fn encode_membership(unique: &[u32]) -> Vec<u8> {
4870 let mut out = Vec::with_capacity(unique.len().saturating_mul(2).saturating_add(5));
4871 put_varint(&mut out, u32::try_from(unique.len()).unwrap_or(u32::MAX));
4872 let mut previous = 0;
4873 for (at, &code) in unique.iter().enumerate() {
4874 put_varint(&mut out, if at == 0 { code } else { code - previous });
4875 previous = code;
4876 }
4877 out
4878}
4879
4880fn take_varint(bytes: &[u8], at: &mut usize) -> Result<u32> {
4881 let mut value = 0_u32;
4882 for shift in (0..35).step_by(7) {
4883 let byte = *bytes.get(*at).ok_or_else(|| invalid("membership varint is truncated"))?;
4884 *at += 1;
4885 let part = u32::from(byte & 0x7f);
4886 if shift == 28 && part > 0x0f {
4887 return Err(invalid("membership varint overflow"));
4888 }
4889 value = value
4890 .checked_add(
4891 part.checked_shl(shift).ok_or_else(|| invalid("membership varint overflow"))?,
4892 )
4893 .ok_or_else(|| invalid("membership varint overflow"))?;
4894 if byte & 0x80 == 0 {
4895 return Ok(value);
4896 }
4897 }
4898 Err(invalid("membership varint is too long"))
4899}
4900
4901fn decode_membership(bytes: &[u8]) -> Result<Vec<u32>> {
4902 let mut at = 0;
4903 let count = take_varint(bytes, &mut at)? as usize;
4904 let mut codes = Vec::with_capacity(count);
4905 let mut previous = 0_u32;
4906 for index in 0..count {
4907 let delta = take_varint(bytes, &mut at)?;
4908 let code = if index == 0 {
4909 delta
4910 } else {
4911 previous.checked_add(delta).ok_or_else(|| invalid("membership code overflow"))?
4912 };
4913 if index > 0 && code <= previous {
4914 return Err(invalid("membership codes are not increasing"));
4915 }
4916 codes.push(code);
4917 previous = code;
4918 }
4919 if at != bytes.len() {
4920 return Err(invalid("membership page has trailing bytes"));
4921 }
4922 Ok(codes)
4923}
4924
4925fn string_dictionary(vector: &Vector) -> Result<Option<Vec<u8>>> {
4926 let mut by_text = HashMap::new();
4927 let mut values = Vec::new();
4928 let mut codes = Vec::with_capacity(vector.len());
4929 let mut plain_bytes = 0_usize;
4930 for row in 0..vector.len() {
4931 let text = vector.text_at(row).unwrap_or("");
4932 plain_bytes = plain_bytes.saturating_add(text.len());
4933 let code = match by_text.get(text) {
4934 Some(&code) => code,
4935 None => {
4936 let code = u32::try_from(values.len())
4937 .map_err(|_| invalid("too many dictionary values"))?;
4938 by_text.insert(text, code);
4939 values.push(text);
4940 code
4941 }
4942 };
4943 codes.push(code);
4944 }
4945 let dictionary_bytes = values.iter().map(|value| value.len()).sum::<usize>();
4946 let encoded = 8_usize
4947 .saturating_add((values.len() + 1).saturating_mul(4))
4948 .saturating_add(dictionary_bytes)
4949 .saturating_add(codes.len().saturating_mul(4));
4950 let plain = (vector.len() + 1).saturating_mul(4).saturating_add(plain_bytes);
4951 if encoded >= plain {
4952 return Ok(None);
4953 }
4954 let mut out = Vec::with_capacity(encoded);
4955 put_u32(
4956 &mut out,
4957 u32::try_from(values.len()).map_err(|_| invalid("too many dictionary values"))?,
4958 );
4959 put_u32(
4960 &mut out,
4961 u32::try_from(dictionary_bytes).map_err(|_| invalid("dictionary payload exceeds 4GiB"))?,
4962 );
4963 let mut offset = 0_u32;
4964 put_u32(&mut out, offset);
4965 for value in &values {
4966 offset = offset
4967 .checked_add(
4968 u32::try_from(value.len()).map_err(|_| invalid("dictionary value is too long"))?,
4969 )
4970 .ok_or_else(|| invalid("dictionary payload exceeds 4GiB"))?;
4971 put_u32(&mut out, offset);
4972 }
4973 for value in values {
4974 out.extend_from_slice(value.as_bytes());
4975 }
4976 for code in codes {
4977 put_u32(&mut out, code);
4978 }
4979 Ok(Some(out))
4980}
4981
4982struct EncodedDictionary {
4983 index: Vec<u8>,
4984 ranks: Vec<u8>,
4985 payload: Vec<Vec<u8>>,
4988}
4989
4990fn head(bytes: &[u8]) -> u64 {
4992 let mut word = [0; 8];
4993 let take = bytes.len().min(8);
4994 word[..take].copy_from_slice(&bytes[..take]);
4995 u64::from_be_bytes(word)
4996}
4997
4998fn rankings(dictionaries: &[Option<GlobalDictionary>]) -> Result<Vec<Vec<(u64, u32)>>> {
5006 let present =
5007 dictionaries.iter().enumerate().filter(|(_, held)| held.is_some()).map(|(at, _)| at);
5008 let present = present.collect::<Vec<_>>();
5009 let mut orders = vec![Vec::new(); dictionaries.len()];
5010 let workers = std::thread::available_parallelism()
5011 .map_or(1, usize::from)
5012 .min(MAX_FREQUENCY_WORKERS)
5013 .min(present.len());
5014 if workers <= 1 {
5015 for at in present {
5016 if let Some(dictionary) = &dictionaries[at] {
5017 orders[at] = dictionary.ranked();
5018 }
5019 }
5020 return Ok(orders);
5021 }
5022 let width = present.len().div_ceil(workers);
5023 let pieces = std::thread::scope(|scope| {
5024 present
5025 .chunks(width)
5026 .map(|columns| {
5027 scope.spawn(|| {
5028 columns
5029 .iter()
5030 .filter_map(|&at| dictionaries[at].as_ref().map(|held| (at, held.ranked())))
5031 .collect::<Vec<_>>()
5032 })
5033 })
5034 .collect::<Vec<_>>()
5035 .into_iter()
5036 .map(|handle| {
5037 handle.join().map_err(|_| Error::internal("a dictionary sort worker panicked"))
5038 })
5039 .collect::<Result<Vec<_>>>()
5040 })?;
5041 for piece in pieces {
5042 for (at, order) in piece {
5043 orders[at] = order;
5044 }
5045 }
5046 Ok(orders)
5047}
5048
5049fn encode_global_dictionary(
5050 dictionary: GlobalDictionary,
5051 order: &[(u64, u32)],
5052) -> Result<EncodedDictionary> {
5053 let values = dictionary.offsets.len() - 1;
5054 if order.len() != values {
5055 return Err(invalid("global dictionary order does not cover its values"));
5056 }
5057 let blocks = values.div_ceil(TEXT_PAYLOAD_VALUES);
5058 let payload = encode_payload(&dictionary)?;
5059 if payload.len() != blocks {
5060 return Err(invalid("global dictionary payload is not the blocks it says it is"));
5061 }
5062 let (ranks, rank_ends) = encode_ranks(order, code_width(values))?;
5063 let rank_blocks = values.div_ceil(TEXT_RANK_BLOCK);
5064 let offset_bits = offset_width(&dictionary.offsets);
5065 let mut index = Vec::with_capacity(
5066 DICTIONARY_HEADER + offset_bytes(values, offset_bits) + (blocks + rank_blocks) * 16,
5067 );
5068 put_u32(
5069 &mut index,
5070 u32::try_from(values).map_err(|_| invalid("global dictionary has too many values"))?,
5071 );
5072 put_u32(&mut index, TEXT_PAYLOAD_VALUES as u32);
5073 put_u32(
5074 &mut index,
5075 u32::try_from(blocks).map_err(|_| invalid("global dictionary has too many blocks"))?,
5076 );
5077 put_u32(&mut index, offset_bits as u32);
5078 encode_offsets(&dictionary.offsets, offset_bits, &mut index)?;
5079 let mut at = 0_u64;
5083 for block in &payload {
5084 at = at
5085 .checked_add(block.len() as u64)
5086 .ok_or_else(|| invalid("global dictionary payload overflow"))?;
5087 put_u64(&mut index, at);
5088 }
5089 for block in &payload {
5090 put_u64(&mut index, checksum(block));
5091 }
5092 if rank_ends.len() != rank_blocks {
5095 return Err(invalid("global dictionary order is not the blocks it says it is"));
5096 }
5097 for end in &rank_ends {
5098 put_u64(&mut index, *end);
5099 }
5100 let mut at = 0_usize;
5101 for end in &rank_ends {
5102 let end = usize::try_from(*end).map_err(|_| invalid("global dictionary order overflow"))?;
5103 put_u64(&mut index, checksum(&ranks[at..end]));
5104 at = end;
5105 }
5106 Ok(EncodedDictionary { index, ranks, payload })
5107}
5108
5109const PAYLOAD_SAMPLE_BLOCKS: usize = 8;
5116
5117fn payload_shapes() -> Vec<chooser::Settled> {
5143 let integers = vec![integer::Kind::Packed];
5144 [
5145 vec![string::Kind::Front, string::Kind::Lz],
5146 vec![string::Kind::Lz, string::Kind::Fsst],
5147 vec![string::Kind::Lz, string::Kind::Plain],
5148 vec![string::Kind::Fsst],
5149 vec![string::Kind::Plain],
5150 ]
5151 .into_iter()
5152 .map(|strings| chooser::Settled::new(strings, integers.clone()))
5153 .collect()
5154}
5155
5156fn encode_payload(dictionary: &GlobalDictionary) -> Result<Vec<Vec<u8>>> {
5162 let values = dictionary.offsets.len() - 1;
5163 let blocks = values.div_ceil(TEXT_PAYLOAD_VALUES);
5164 let run = |block: usize| {
5165 let first = block * TEXT_PAYLOAD_VALUES;
5166 let last = (first + TEXT_PAYLOAD_VALUES).min(values);
5167 (first..last)
5168 .map(|value| {
5169 let from = dictionary.offsets[value] as usize;
5170 let to = dictionary.offsets[value + 1] as usize;
5171 &dictionary.payload[from..to]
5172 })
5173 .collect::<Vec<_>>()
5174 };
5175 let shape = (blocks > PAYLOAD_SAMPLE_BLOCKS).then(|| settle_shape(&run, blocks)).transpose()?;
5178 let one = |block: usize| match &shape {
5179 Some(shape) => string::encode_with(&run(block), shape),
5180 None => string::encode(&run(block)),
5181 };
5182 let workers = std::thread::available_parallelism()
5183 .map_or(1, usize::from)
5184 .min(MAX_FREQUENCY_WORKERS)
5185 .min(blocks);
5186 if workers <= 1 {
5187 return (0..blocks).map(one).collect();
5188 }
5189 let next = AtomicUsize::new(0);
5190 let pieces = std::thread::scope(|scope| {
5191 (0..workers)
5192 .map(|_| {
5193 scope.spawn(|| {
5194 let mut mine = Vec::new();
5195 loop {
5196 let block = next.fetch_add(1, Atomic::Relaxed);
5197 if block >= blocks {
5198 break;
5199 }
5200 mine.push((block, one(block)?));
5201 }
5202 Ok(mine)
5203 })
5204 })
5205 .collect::<Vec<_>>()
5206 .into_iter()
5207 .map(|handle| {
5208 handle.join().map_err(|_| Error::internal("a dictionary encode worker panicked"))?
5209 })
5210 .collect::<Result<Vec<_>>>()
5211 })?;
5212 let mut payload = vec![Vec::new(); blocks];
5213 for piece in pieces {
5214 for (block, bytes) in piece {
5215 payload[block] = bytes;
5216 }
5217 }
5218 Ok(payload)
5219}
5220
5221fn settle_shape<'a>(
5229 run: &dyn Fn(usize) -> Vec<&'a [u8]>,
5230 blocks: usize,
5231) -> Result<chooser::Settled> {
5232 let last = blocks - 1;
5233 let sample = (0..PAYLOAD_SAMPLE_BLOCKS)
5234 .map(|region| run(region * last / (PAYLOAD_SAMPLE_BLOCKS - 1)))
5235 .collect::<Vec<_>>();
5236 let mut best: Option<(chooser::Settled, usize)> = None;
5237 for shape in payload_shapes() {
5238 let mut size = 0;
5239 for block in &sample {
5240 size += string::encode_with(block, &shape)?.len();
5241 }
5242 if best.as_ref().is_none_or(|(_, smallest)| size < *smallest) {
5243 best = Some((shape, size));
5244 }
5245 }
5246 best.map(|(shape, _)| shape)
5247 .ok_or_else(|| invalid("no shape applies to a global dictionary payload"))
5248}
5249
5250fn encode_ranks(order: &[(u64, u32)], code_bits: usize) -> Result<(Vec<u8>, Vec<u64>)> {
5257 let mut out = Vec::with_capacity(order.len() * 4);
5258 let mut ends = Vec::with_capacity(order.len().div_ceil(TEXT_RANK_BLOCK));
5259 let mut heads = Vec::with_capacity(TEXT_RANK_BLOCK);
5260 let mut codes = Vec::with_capacity(TEXT_RANK_BLOCK);
5261 for block in order.chunks(TEXT_RANK_BLOCK) {
5262 let base = block.first().map_or(0, |&(head, _)| head);
5265 let span = block.last().map_or(0, |&(head, _)| head.wrapping_sub(base));
5266 let width = (u64::BITS - span.leading_zeros()) as usize;
5267 heads.clear();
5268 codes.clear();
5269 for &(head, code) in block {
5270 heads.push(head.wrapping_sub(base));
5271 codes.push(u64::from(code));
5272 }
5273 put_u64(&mut out, base);
5274 out.push(width as u8);
5275 bitpack::pack_tail(&heads, width, &mut out)
5276 .map_err(|_| invalid("global dictionary heads do not pack"))?;
5277 bitpack::pack_tail(&codes, code_bits, &mut out)
5278 .map_err(|_| invalid("global dictionary codes do not pack"))?;
5279 ends.push(out.len() as u64);
5280 }
5281 Ok((out, ends))
5282}
5283
5284fn open_global_dictionary(
5291 file: Arc<File>,
5292 page: Page,
5293 ty: &LogicalType,
5294 keep_budget: usize,
5295) -> Result<Vector> {
5296 if ty != &LogicalType::Varchar {
5297 return Err(invalid("global dictionary belongs to a non-string column"));
5298 }
5299 let mut header = [0; DICTIONARY_HEADER];
5300 read_at(&file, page.offset, &mut header)?;
5301 let count = u32::from_le_bytes(header[0..4].try_into().expect("four bytes")) as usize;
5302 let per_block = u32::from_le_bytes(header[4..8].try_into().expect("four bytes")) as usize;
5303 let blocks = u32::from_le_bytes(header[8..12].try_into().expect("four bytes")) as usize;
5304 let offset_bits = u32::from_le_bytes(header[12..16].try_into().expect("four bytes")) as usize;
5305 if per_block != TEXT_PAYLOAD_VALUES {
5306 return Err(invalid("global dictionary block width differs"));
5307 }
5308 if blocks != count.div_ceil(TEXT_PAYLOAD_VALUES) {
5309 return Err(invalid("global dictionary block count differs from its value count"));
5310 }
5311 if offset_bits > u32::BITS as usize {
5312 return Err(invalid("global dictionary packs offsets past a payload"));
5313 }
5314 let offset_len = offset_bytes(count, offset_bits);
5315 let ranks = count;
5320 let rank_blocks = ranks.div_ceil(TEXT_RANK_BLOCK);
5321 let hash_len = blocks
5324 .checked_add(rank_blocks)
5325 .and_then(|words| words.checked_mul(16))
5326 .ok_or_else(|| invalid("global dictionary block count overflow"))?;
5327 let index_len = DICTIONARY_HEADER
5328 .checked_add(offset_len)
5329 .and_then(|len| len.checked_add(hash_len))
5330 .ok_or_else(|| invalid("global dictionary header overflow"))?;
5331 if index_len > page.length as usize {
5332 return Err(invalid("global dictionary offset index exceeds its page"));
5333 }
5334 let mut index = vec![0; index_len];
5335 index[..DICTIONARY_HEADER].copy_from_slice(&header);
5336 read_at(&file, page.offset + DICTIONARY_HEADER as u64, &mut index[DICTIONARY_HEADER..])?;
5337 if checksum(&index) != page.hash {
5338 return Err(invalid("global dictionary index checksum differs"));
5339 }
5340 let offsets = index[DICTIONARY_HEADER..DICTIONARY_HEADER + offset_len].to_vec();
5341 let mut words = index[DICTIONARY_HEADER + offset_len..]
5342 .chunks_exact(8)
5343 .map(|part| u64::from_le_bytes(part.try_into().expect("eight bytes")))
5344 .collect::<Vec<_>>();
5345 let mut hashes = words.split_off(blocks);
5346 let mut rank_ends = hashes.split_off(blocks);
5347 let rank_hashes = rank_ends.split_off(rank_blocks);
5348 let ends = words;
5349 if rank_ends.windows(2).any(|pair| pair[0] >= pair[1]) {
5352 return Err(invalid("global dictionary order blocks do not rise"));
5353 }
5354 let rank_len = usize::try_from(rank_ends.last().copied().unwrap_or_default())
5355 .map_err(|_| invalid("global dictionary rank overflow"))?;
5356 let body_len = index_len
5357 .checked_add(rank_len)
5358 .ok_or_else(|| invalid("global dictionary header overflow"))?;
5359 if body_len > page.length as usize {
5360 return Err(invalid("global dictionary order exceeds its page"));
5361 }
5362 let stored_len = page.length as usize - body_len;
5365 if ends.last().copied().unwrap_or_default() as usize != stored_len
5366 || ends.windows(2).any(|pair| pair[0] > pair[1])
5367 {
5368 return Err(invalid("global dictionary blocks do not bound the payload"));
5369 }
5370 Vector::external_text(
5371 LogicalType::Varchar,
5372 Arc::new(NativeText {
5373 file,
5374 values: count,
5375 offsets,
5376 offset_bits,
5377 ranks,
5378 rank_at: page.offset + index_len as u64,
5379 rank_ends,
5380 rank_hashes,
5381 rank_blocks: (0..rank_blocks).map(|_| OnceLock::new()).collect(),
5382 code_bits: code_width(count),
5383 code_ranks: OnceLock::new(),
5384 payload: page.offset + body_len as u64,
5385 ends,
5386 hashes,
5387 blocks: (0..blocks).map(|_| OnceLock::new()).collect(),
5388 keep_budget,
5389 payload_kept: AtomicUsize::new(0),
5390 searched: Mutex::new(HashMap::new()),
5391 }),
5392 )
5393}
5394
5395fn decode(
5396 ty: &LogicalType,
5397 rows: usize,
5398 bytes: &[u8],
5399 global: Option<Arc<Vector>>,
5400) -> Result<Vector> {
5401 let mut cur = Cursor { bytes, at: 0 };
5402 let codec = cur.u8()?;
5403 let flag = cur.u8()?;
5404 let validity = match flag {
5405 0 => Validity::AllValid,
5406 1 => Validity::AllInvalid,
5407 2 => {
5408 let mask = cur.take(rows.div_ceil(8))?;
5409 Validity::from_iter(rows, |row| mask[row / 8] >> (row % 8) & 1 == 1)
5410 }
5411 _ => return Err(invalid("page validity tag differs")),
5412 };
5413 if codec == 1 {
5414 if ty != &LogicalType::Varchar {
5415 return Err(invalid("dictionary codec belongs to a non-string page"));
5416 }
5417 let count = cur.u32()? as usize;
5418 let payload_len = cur.u32()? as usize;
5419 let offset_bytes = cur.take(
5420 (count + 1)
5421 .checked_mul(4)
5422 .ok_or_else(|| invalid("dictionary offset count overflow"))?,
5423 )?;
5424 let offsets = offset_bytes
5425 .chunks_exact(4)
5426 .map(|part| u32::from_le_bytes(part.try_into().expect("four bytes")))
5427 .collect::<Vec<_>>();
5428 let payload = cur.take(payload_len)?.to_vec();
5429 if offsets.first() != Some(&0)
5430 || offsets.last().copied().map(|last| last as usize) != Some(payload.len())
5431 || offsets.windows(2).any(|pair| pair[0] > pair[1])
5432 {
5433 return Err(invalid("dictionary offsets do not bound the payload"));
5434 }
5435 let mut strings = StringColumn::over(Buffer::from_vec(payload));
5436 for pair in offsets.windows(2) {
5437 strings.push_in_place(pair[0] as usize, (pair[1] - pair[0]) as usize)?;
5438 }
5439 let mut codes = Vec::with_capacity(rows);
5440 for _ in 0..rows {
5441 codes.push(cur.u32()?);
5442 }
5443 if codes.iter().any(|code| *code as usize >= count) {
5444 return Err(invalid("dictionary code is out of range"));
5445 }
5446 if cur.at != bytes.len() {
5447 return Err(invalid("dictionary page has trailing bytes"));
5448 }
5449 let dictionary = Vector::flat(LogicalType::Varchar, Data::Varlen(strings))?;
5450 return Ok(Vector::dictionary(codes, dictionary)?.with_validity(validity));
5451 }
5452 if codec == 3 || codec == 4 {
5453 let dictionary = global.ok_or_else(|| invalid("global code page has no dictionary"))?;
5454 let codes = if codec == 4 {
5455 let wide = integer::decode(&bytes[cur.at..])?;
5458 if wide.len() != rows {
5459 return Err(invalid("encoded code page holds the wrong number of rows"));
5460 }
5461 let mut codes = Vec::with_capacity(wide.len());
5468 let mut seen = 0_i64;
5469 for &code in &wide {
5470 seen |= code;
5471 codes.push(code as u32);
5472 }
5473 if seen < 0 || seen > i64::from(u32::MAX) {
5474 return Err(invalid("code is not a code"));
5475 }
5476 codes
5477 } else {
5478 let mut codes = Vec::with_capacity(rows);
5479 for _ in 0..rows {
5480 codes.push(cur.u32()?);
5481 }
5482 if cur.at != bytes.len() {
5483 return Err(invalid("global code page has trailing bytes"));
5484 }
5485 codes
5486 };
5487 let highest = codes.iter().copied().max();
5488 return Ok(Vector::stable_dictionary_validated(codes, dictionary, highest)?
5489 .with_validity(validity));
5490 }
5491 if codec == 5 {
5492 let values = integer::decode(&bytes[cur.at..])?;
5494 if values.len() != rows {
5495 return Err(invalid("cascade page holds the wrong number of rows"));
5496 }
5497 let data = narrowed(ty, values)?;
5498 return Ok(Vector::flat(ty.clone(), data)?.with_validity(validity));
5499 }
5500 if codec == 2 {
5501 let width = u32::from(cur.u8()?);
5502 let base = i128::from_le_bytes(cur.take(16)?.try_into().expect("sixteen bytes"));
5503 let count = cur.u32()? as usize;
5504 let mut words = Vec::with_capacity(count);
5505 for _ in 0..count {
5506 words.push(cur.u64()?);
5507 }
5508 if cur.at != bytes.len() {
5509 return Err(invalid("packed page has trailing bytes"));
5510 }
5511 return Ok(Vector::packed(ty.clone(), words, width, base, rows)?.with_validity(validity));
5512 }
5513 if codec != 0 {
5514 return Err(invalid("page codec is unknown"));
5515 }
5516 let data = match ty {
5517 LogicalType::TinyInt => {
5518 let values = cur.take(rows)?;
5519 Data::Int8(values.iter().map(|item| *item as i8).collect::<Vec<_>>().into())
5520 }
5521 LogicalType::UTinyInt => Data::UInt8(cur.take(rows)?.to_vec().into()),
5522 LogicalType::SmallInt => {
5523 let values =
5524 cur.take(rows.checked_mul(2).ok_or_else(|| invalid("page size overflow"))?)?;
5525 Data::Int16(
5526 values
5527 .chunks_exact(2)
5528 .map(|item| i16::from_le_bytes(item.try_into().expect("two bytes")))
5529 .collect::<Vec<_>>()
5530 .into(),
5531 )
5532 }
5533 LogicalType::USmallInt => {
5534 let values =
5535 cur.take(rows.checked_mul(2).ok_or_else(|| invalid("page size overflow"))?)?;
5536 Data::UInt16(
5537 values
5538 .chunks_exact(2)
5539 .map(|item| u16::from_le_bytes(item.try_into().expect("two bytes")))
5540 .collect::<Vec<_>>()
5541 .into(),
5542 )
5543 }
5544 LogicalType::UInteger => {
5545 let values =
5546 cur.take(rows.checked_mul(4).ok_or_else(|| invalid("page size overflow"))?)?;
5547 Data::UInt32(
5548 values
5549 .chunks_exact(4)
5550 .map(|item| u32::from_le_bytes(item.try_into().expect("four bytes")))
5551 .collect::<Vec<_>>()
5552 .into(),
5553 )
5554 }
5555 LogicalType::UBigInt => {
5556 let values =
5557 cur.take(rows.checked_mul(8).ok_or_else(|| invalid("page size overflow"))?)?;
5558 Data::UInt64(
5559 values
5560 .chunks_exact(8)
5561 .map(|item| u64::from_le_bytes(item.try_into().expect("eight bytes")))
5562 .collect::<Vec<_>>()
5563 .into(),
5564 )
5565 }
5566 LogicalType::Integer | LogicalType::Date => {
5567 let values =
5568 cur.take(rows.checked_mul(4).ok_or_else(|| invalid("page size overflow"))?)?;
5569 Data::Int32(
5570 values
5571 .chunks_exact(4)
5572 .map(|item| i32::from_le_bytes(item.try_into().expect("four bytes")))
5573 .collect::<Vec<_>>()
5574 .into(),
5575 )
5576 }
5577 LogicalType::BigInt | LogicalType::Timestamp => {
5578 let values =
5579 cur.take(rows.checked_mul(8).ok_or_else(|| invalid("page size overflow"))?)?;
5580 Data::Int64(
5581 values
5582 .chunks_exact(8)
5583 .map(|item| i64::from_le_bytes(item.try_into().expect("eight bytes")))
5584 .collect::<Vec<_>>()
5585 .into(),
5586 )
5587 }
5588 LogicalType::Boolean => {
5589 let values = cur.take(rows)?;
5590 if values.iter().any(|value| *value > 1) {
5591 return Err(invalid("boolean page has another value"));
5592 }
5593 Data::Bool(values.iter().map(|value| *value == 1).collect::<Vec<_>>().into())
5594 }
5595 LogicalType::Decimal { .. } => match ty.physical() {
5598 PhysicalType::Int16 => {
5599 let values =
5600 cur.take(rows.checked_mul(2).ok_or_else(|| invalid("page size overflow"))?)?;
5601 Data::Int16(
5602 values
5603 .chunks_exact(2)
5604 .map(|item| i16::from_le_bytes(item.try_into().expect("two bytes")))
5605 .collect::<Vec<_>>()
5606 .into(),
5607 )
5608 }
5609 PhysicalType::Int32 => {
5610 let values =
5611 cur.take(rows.checked_mul(4).ok_or_else(|| invalid("page size overflow"))?)?;
5612 Data::Int32(
5613 values
5614 .chunks_exact(4)
5615 .map(|item| i32::from_le_bytes(item.try_into().expect("four bytes")))
5616 .collect::<Vec<_>>()
5617 .into(),
5618 )
5619 }
5620 PhysicalType::Int64 => {
5621 let values =
5622 cur.take(rows.checked_mul(8).ok_or_else(|| invalid("page size overflow"))?)?;
5623 Data::Int64(
5624 values
5625 .chunks_exact(8)
5626 .map(|item| i64::from_le_bytes(item.try_into().expect("eight bytes")))
5627 .collect::<Vec<_>>()
5628 .into(),
5629 )
5630 }
5631 _ => {
5632 let values =
5633 cur.take(rows.checked_mul(16).ok_or_else(|| invalid("page size overflow"))?)?;
5634 Data::Int128(
5635 values
5636 .chunks_exact(16)
5637 .map(|item| i128::from_le_bytes(item.try_into().expect("sixteen bytes")))
5638 .collect::<Vec<_>>()
5639 .into(),
5640 )
5641 }
5642 },
5643 LogicalType::Varchar => {
5644 let offset_bytes = cur
5645 .take((rows + 1).checked_mul(4).ok_or_else(|| invalid("offset count overflow"))?)?;
5646 let offsets = offset_bytes
5647 .chunks_exact(4)
5648 .map(|part| u32::from_le_bytes(part.try_into().expect("four bytes")))
5649 .collect::<Vec<_>>();
5650 let payload = cur.take(bytes.len() - cur.at)?.to_vec();
5651 if offsets.first() != Some(&0)
5652 || offsets.last().copied().map(|last| last as usize) != Some(payload.len())
5653 || offsets.windows(2).any(|pair| pair[0] > pair[1])
5654 {
5655 return Err(invalid("string offsets do not bound the payload"));
5656 }
5657 let mut values = StringColumn::over(Buffer::from_vec(payload));
5658 for pair in offsets.windows(2) {
5659 values.push_in_place(pair[0] as usize, (pair[1] - pair[0]) as usize)?;
5660 }
5661 Data::Varlen(values)
5662 }
5663 _ => return Err(Error::not_implemented(format!("native page for {ty}"))),
5664 };
5665 if cur.at != bytes.len() {
5666 return Err(invalid("page has trailing bytes"));
5667 }
5668 Ok(Vector::flat(ty.clone(), data)?.with_validity(validity))
5669}
5670
5671#[cfg(test)]
5672mod tests {
5673 use std::fs;
5674 use std::io::{Seek, SeekFrom, Write};
5675 use std::path::PathBuf;
5676 use std::time::{SystemTime, UNIX_EPOCH};
5677
5678 use rudb_common::Stat;
5679 use rudb_common::Value;
5680 use rudb_common::bounds::{Frequencies, Op};
5681 use rudb_common::stat::Provenance;
5682
5683 use super::*;
5684
5685 #[test]
5686 fn checksum_matches_fixed_vectors() {
5687 assert_eq!(checksum(b""), 0xef46_db37_51d8_e999);
5688 assert_eq!(checksum(b"a"), 0xd24e_c4f1_a98c_6e5b);
5689 assert_eq!(checksum(b"abc"), 0x44bc_2cf5_ad77_0999);
5690 }
5691
5692 fn path(label: &str) -> PathBuf {
5693 let stamp = SystemTime::now().duration_since(UNIX_EPOCH).expect("time advances").as_nanos();
5694 std::env::temp_dir().join(format!("rudb-native-{label}-{}-{stamp}.rdb", std::process::id()))
5695 }
5696
5697 #[test]
5699 fn a_read_at_an_offset_ignores_where_another_thread_left_the_cursor() {
5700 const SPANS: usize = 64;
5701 const SPAN: usize = 512;
5702 let path = path("positional");
5703 let content: Vec<u8> =
5704 (0..SPANS).flat_map(|span| std::iter::repeat_n(span as u8, SPAN)).collect();
5705 fs::write(&path, &content).expect("the file is written");
5706 let file = Arc::new(File::open(&path).expect("the file opens"));
5707 std::thread::scope(|scope| {
5708 for _ in 0..8 {
5709 let file = Arc::clone(&file);
5710 scope.spawn(move || {
5711 for _ in 0..64 {
5712 for span in 0..SPANS {
5713 let mut bytes = [0_u8; SPAN];
5714 read_at(&file, (span * SPAN) as u64, &mut bytes)
5715 .expect("the span reads");
5716 assert!(
5717 bytes.iter().all(|byte| *byte == span as u8),
5718 "span {span} came back as {}",
5719 bytes[0],
5720 );
5721 }
5722 }
5723 });
5724 }
5725 });
5726 let mut past = [0_u8; SPAN];
5727 let end = (SPANS * SPAN) as u64;
5728 let error = read_at(&file, end, &mut past).expect_err("a read past the end is refused");
5729 assert!(error.message().contains("ends before its declared length"), "{error}");
5730 drop(file);
5731 let _ = fs::remove_file(&path);
5732 }
5733
5734 #[test]
5740 fn a_writer_puts_a_page_where_it_said_it_did_wherever_the_cursor_has_got_to() {
5741 let path = path("cursor");
5742 let mut writer = Writer::create(
5743 &path,
5744 "items",
5745 vec![
5746 Field::required("id", LogicalType::Integer),
5747 Field::new("text", LogicalType::Varchar),
5748 ],
5749 )
5750 .expect("new file");
5751 writer.append(&sample()).expect("first part");
5752 writer.file.seek(SeekFrom::Start(0)).expect("the cursor goes back to the header");
5753 writer.append(&sample()).expect("second part");
5754 writer.file.seek(SeekFrom::Start(1)).expect("and somewhere useless again");
5755 writer.finish().expect("commit");
5756 let reader = Reader::open(&path).expect("reopen from disk");
5757 assert_eq!(reader.table().rows(), 6);
5758 let ids = reader.read(0, &[0]).expect("the integer page reads back");
5759 assert_eq!(ids.value_at(0, 0), Value::Integer(4));
5760 assert_eq!(ids.value_at(2, 0), Value::Integer(-2));
5761 let text = reader.read(1, &[1]).expect("the text page reads back");
5762 assert_eq!(text.value_at(1, 0), Value::Null);
5763 assert_eq!(text.value_at(2, 0), Value::Varchar("long text after a slash".into()));
5764 let end = reader.table().stripes().iter().flat_map(|stripe| {
5767 stripe
5768 .pages
5769 .iter()
5770 .map(|page| page.offset + u64::from(page.length))
5771 .chain(std::iter::once(stripe.index.offset + u64::from(stripe.index.length)))
5772 });
5773 let last = end.fold(HEADER, u64::max);
5774 let directory = fs::metadata(&path).expect("the file is there").len();
5775 assert!(last <= directory, "a page runs to {last} in a file of {directory} bytes");
5776 fs::remove_file(path).expect("remove scratch file");
5777 }
5778
5779 fn dictionary_index_len(header: &[u8; DICTIONARY_HEADER]) -> u64 {
5785 let count = u64::from(u32::from_le_bytes(header[0..4].try_into().expect("four bytes")));
5786 let blocks = u64::from(u32::from_le_bytes(header[8..12].try_into().expect("four bytes")));
5787 let bits = u32::from_le_bytes(header[12..16].try_into().expect("four bytes")) as usize;
5788 let rank_blocks = count.div_ceil(TEXT_RANK_BLOCK as u64);
5789 DICTIONARY_HEADER as u64
5790 + offset_bytes(count as usize, bits) as u64
5791 + (blocks + rank_blocks) * 16
5792 }
5793
5794 fn last_rank_end(file: &File, offset: u64, header: &[u8; DICTIONARY_HEADER]) -> u64 {
5796 let count = u64::from(u32::from_le_bytes(header[0..4].try_into().expect("four bytes")));
5797 let blocks = u64::from(u32::from_le_bytes(header[8..12].try_into().expect("four bytes")));
5798 let bits = u32::from_le_bytes(header[12..16].try_into().expect("four bytes")) as usize;
5799 let rank_blocks = count.div_ceil(TEXT_RANK_BLOCK as u64);
5800 let at = offset
5801 + DICTIONARY_HEADER as u64
5802 + offset_bytes(count as usize, bits) as u64
5803 + blocks * 16
5804 + (rank_blocks - 1) * 8;
5805 let mut end = [0; 8];
5806 read_at(file, at, &mut end).expect("the last rank block end");
5807 u64::from_le_bytes(end)
5808 }
5809
5810 fn sample() -> Chunk {
5811 Chunk::new(vec![
5812 Vector::from_values(
5813 LogicalType::Integer,
5814 &[Value::Integer(4), Value::Integer(9), Value::Integer(-2)],
5815 )
5816 .expect("integers"),
5817 Vector::from_values(
5818 LogicalType::Varchar,
5819 &[
5820 Value::Varchar("alpha".into()),
5821 Value::Null,
5822 Value::Varchar("long text after a slash".into()),
5823 ],
5824 )
5825 .expect("strings"),
5826 ])
5827 .expect("matching rows")
5828 }
5829
5830 fn sample_ids() -> Chunk {
5831 Chunk::new(vec![
5832 Vector::flat(LogicalType::Integer, Data::Int32(vec![7, 8, 9].into()))
5833 .expect("integers"),
5834 ])
5835 .expect("one column")
5836 }
5837
5838 #[test]
5839 fn the_planner_gets_a_row_count_per_value_off_a_complete_synopsis() {
5840 let path = path("frequencies_for_the_planner");
5845 let mut writer =
5846 Writer::create(&path, "items", vec![Field::required("id", LogicalType::Integer)])
5847 .expect("new file");
5848 let rows = Chunk::new(vec![
5849 Vector::from_values(
5850 LogicalType::Integer,
5851 &[
5852 Value::Integer(4),
5853 Value::Integer(4),
5854 Value::Integer(4),
5855 Value::Integer(9),
5856 Value::Integer(9),
5857 Value::Integer(1),
5858 ],
5859 )
5860 .expect("integers"),
5861 ])
5862 .expect("one column");
5863 writer.append(&rows).expect("the only part");
5864 writer.finish().expect("commit");
5865 let reader = Reader::open(&path).expect("reopen from disk");
5866 let common = Common::new(reader);
5867 assert_eq!(common.rows(), 6);
5868 let column = common.column("id").expect("the file has that column");
5869 assert_eq!(common.column("nothing"), None);
5870 assert_eq!(
5871 common.rows_with(column, &Bound::Int(4)),
5872 Stat::exact(3, Provenance::FrequencySynopsis)
5873 );
5874 assert_eq!(
5876 common.rows_with(column, &Bound::Int(7)),
5877 Stat::exact(0, Provenance::FrequencySynopsis)
5878 );
5879 assert_eq!(common.rows_with(column, &Bound::Bytes(b"four".to_vec())), Stat::Unknown);
5882 fs::remove_file(&path).expect("clean up");
5883 }
5884
5885 #[test]
5886 fn committed_file_reopens_and_reads_only_requested_columns() {
5887 let path = path("reopen");
5888 let mut writer = Writer::create(
5889 &path,
5890 "items",
5891 vec![
5892 Field::required("id", LogicalType::Integer),
5893 Field::new("text", LogicalType::Varchar),
5894 ],
5895 )
5896 .expect("new file");
5897 writer.append(&sample()).expect("first part");
5898 writer.append(&sample()).expect("second part");
5899 writer.finish().expect("commit");
5900 let reader = Reader::open(&path).expect("reopen from disk");
5901 assert_eq!(reader.table().rows(), 6);
5902 assert_eq!(reader.table().stripes().len(), 1);
5905 assert_eq!(reader.parts(), 2);
5906 assert_eq!(reader.part_rows(0), 3);
5907 assert_eq!(reader.part_rows(1), 3);
5908 let text = reader.read(1, &[1]).expect("only text page");
5909 assert_eq!(text.width(), 1);
5910 assert_eq!(text.value_at(1, 0), Value::Null);
5911 assert_eq!(text.value_at(2, 0), Value::Varchar("long text after a slash".into()));
5912 let sparse = reader.read_sparse(1, &[1]).expect("one part without its whole page");
5913 assert_eq!(sparse.width(), 1);
5914 assert_eq!(sparse.value_at(1, 0), Value::Null);
5915 assert_eq!(sparse.value_at(2, 0), Value::Varchar("long text after a slash".into()));
5916 assert!(!reader.skips_codes(0, 1, &[0]).expect("alpha is in the stripe"));
5917 assert!(!reader.skips_codes(0, 1, &[2]).expect("long text is in the stripe"));
5918 assert!(reader.skips_codes(0, 1, &[3]).expect("unknown code is absent"));
5919 let count = reader.read(0, &[]).expect("no page is needed for count");
5920 assert_eq!(count.len(), 3);
5921 assert!(reader.skips(0, &[Probe { column: 0, op: Op::Greater, value: Bound::Int(100) }]));
5922 assert!(!reader.skips(0, &[Probe { column: 0, op: Op::Greater, value: Bound::Int(0) }]));
5923 let integers = reader.top_frequencies(0, 1).expect("valid integer synopsis").expect("kept");
5924 assert_eq!(
5925 integers,
5926 vec![(Value::Integer(-2), 2), (Value::Integer(4), 2), (Value::Integer(9), 2),]
5927 );
5928 let strings = reader.top_frequencies(1, 1).expect("valid string synopsis").expect("kept");
5929 assert_eq!(strings.len(), 3);
5930 assert!(strings.contains(&(Value::Null, 2)));
5931 assert!(strings.contains(&(Value::Varchar("alpha".into()), 2)));
5932 assert!(strings.contains(&(Value::Varchar("long text after a slash".into()), 2)));
5933 fs::remove_file(path).expect("remove scratch file");
5934 }
5935
5936 #[test]
5944 fn runs_handed_over_out_of_order_still_read_back_in_source_order() {
5945 let path = path("interleaved-runs");
5946 let mut writer =
5947 Writer::create(&path, "interleaved", vec![Field::new("v", LogicalType::BigInt)])
5948 .expect("new file");
5949 for morsel in [2_u64, 0, 3, 1] {
5950 let parts = (0..4_u64)
5951 .map(|chunk| {
5952 let first = i64::try_from(morsel * 32 + chunk * 8).expect("small");
5953 let values =
5954 (0..8_i64).map(|row| Value::BigInt(first + row)).collect::<Vec<_>>();
5955 let column =
5956 Vector::from_values(LogicalType::BigInt, &values).expect("a column");
5957 ((morsel, chunk), Chunk::new(vec![column]).expect("one column"))
5958 })
5959 .collect::<Vec<_>>();
5960 writer.append_stripe(parts).expect("a stripe");
5961 }
5962 writer.finish().expect("commit");
5963
5964 let reader = Reader::open(&path).expect("valid directory");
5965 assert_eq!(reader.table().stripes().len(), 4, "a run is a stripe of its own");
5966 assert_eq!(reader.table().rows(), 128);
5967 for part in 0..16_usize {
5968 let read = reader.read(part, &[0]).expect("a part back");
5969 for row in 0..8_usize {
5970 let want = i64::try_from(part * 8 + row).expect("small");
5971 assert_eq!(read.value_at(row, 0), Value::BigInt(want), "part {part} row {row}");
5972 }
5973 }
5974 fs::remove_file(path).expect("remove scratch file");
5975 }
5976
5977 #[test]
5980 fn runs_that_overlap_each_other_are_refused_at_commit() {
5981 let path = path("overlapping-runs");
5982 let mut writer =
5983 Writer::create(&path, "overlapping", vec![Field::new("v", LogicalType::BigInt)])
5984 .expect("new file");
5985 let one = |order: (u64, u64)| {
5986 let column =
5987 Vector::from_values(LogicalType::BigInt, &[Value::BigInt(1)]).expect("a column");
5988 (order, Chunk::new(vec![column]).expect("one column"))
5989 };
5990 writer.append_stripe(vec![one((0, 0)), one((0, 2))]).expect("a stripe");
5993 writer.append_stripe(vec![one((0, 1))]).expect("a stripe");
5994 let error = writer.finish().expect_err("the runs overlap");
5995 assert!(error.message().contains("source order"), "{error}");
5996 fs::remove_file(path).expect("remove scratch file");
5997 }
5998
5999 #[test]
6002 fn a_run_longer_than_a_stripe_is_refused() {
6003 let path = path("overlong-run");
6004 let mut writer =
6005 Writer::create(&path, "overlong", vec![Field::new("v", LogicalType::BigInt)])
6006 .expect("new file");
6007 let parts = (0..=STRIPE_PARTS)
6008 .map(|at| {
6009 let column = Vector::from_values(LogicalType::BigInt, &[Value::BigInt(1)])
6010 .expect("a column");
6011 let chunk = Chunk::new(vec![column]).expect("one column");
6012 ((0, u64::try_from(at).expect("small")), chunk)
6013 })
6014 .collect::<Vec<_>>();
6015 let error = writer.append_stripe(parts).expect_err("one part too many");
6016 assert!(error.message().contains("more parts than it holds"), "{error}");
6017 fs::remove_file(path).expect("remove scratch file");
6018 }
6019
6020 #[test]
6026 fn parts_past_the_stripe_bound_start_a_new_stripe() {
6027 let path = path("stripe-bound");
6028 let mut writer = Writer::create(
6029 &path,
6030 "items",
6031 vec![
6032 Field::required("id", LogicalType::Integer),
6033 Field::new("text", LogicalType::Varchar),
6034 ],
6035 )
6036 .expect("new file");
6037 let parts = STRIPE_PARTS * 2 + 3;
6038 for part in 0..parts {
6039 let id = part as i32;
6040 let chunk = Chunk::new(vec![
6041 Vector::from_values(
6042 LogicalType::Integer,
6043 &[Value::Integer(id), Value::Integer(-id)],
6044 )
6045 .expect("integers"),
6046 Vector::from_values(
6047 LogicalType::Varchar,
6048 &[Value::Varchar(format!("value {part}")), Value::Null],
6049 )
6050 .expect("strings"),
6051 ])
6052 .expect("matching rows");
6053 writer.append(&chunk).expect("one part");
6054 }
6055 writer.finish().expect("commit");
6056
6057 let reader = Reader::open(&path).expect("reopen from disk");
6058 assert_eq!(reader.parts(), parts);
6059 assert_eq!(reader.table().rows(), parts * 2);
6060 assert_eq!(reader.table().stripes().len(), parts.div_ceil(STRIPE_PARTS));
6061 assert_eq!(reader.table().stripes()[0].parts(), STRIPE_PARTS);
6062 assert_eq!(reader.table().stripes()[0].rows(), STRIPE_PARTS * 2);
6063 assert_eq!(reader.table().stripes()[2].parts(), 3);
6064 for part in (0..parts).rev() {
6067 let dense = reader.read(part, &[0, 1]).expect("a whole page read");
6068 let sparse = reader.read_sparse(part, &[0, 1]).expect("one part read");
6069 for chunk in [&dense, &sparse] {
6070 assert_eq!(chunk.len(), 2, "part {part} has its own row count");
6071 assert_eq!(chunk.value_at(0, 0), Value::Integer(part as i32));
6072 assert_eq!(chunk.value_at(1, 0), Value::Integer(-(part as i32)));
6073 assert_eq!(chunk.value_at(0, 1), Value::Varchar(format!("value {part}")));
6074 assert_eq!(chunk.value_at(1, 1), Value::Null);
6075 }
6076 }
6077 let above = [Probe { column: 0, op: Op::Greater, value: Bound::Int(100) }];
6080 assert!(reader.skips(0, &above), "the first stripe stops at 63");
6081 assert!(!reader.skips(STRIPE_PARTS * 2, &above), "the third stripe reaches 130");
6082 fs::remove_file(path).expect("remove scratch file");
6083 }
6084
6085 fn scattered(n: i64) -> i64 {
6087 n.wrapping_mul(-7_046_029_254_386_353_131)
6088 }
6089
6090 #[test]
6096 fn a_part_is_skipped_when_its_sieve_does_not_hold_the_constant() {
6097 let path = path("sieve-skip");
6098 let mut writer =
6099 Writer::create(&path, "hits", vec![Field::required("id", LogicalType::BigInt)])
6100 .expect("new file");
6101 let parts = STRIPE_PARTS + 3;
6102 let per_part = 128;
6106 for part in 0..parts {
6107 let held: Vec<Value> = (0..per_part)
6108 .map(|row| Value::BigInt(scattered((part * per_part + row) as i64)))
6109 .collect();
6110 let chunk =
6111 Chunk::new(vec![Vector::from_values(LogicalType::BigInt, &held).expect("numbers")])
6112 .expect("one column");
6113 writer.append(&chunk).expect("one part");
6114 }
6115 writer.finish().expect("commit");
6116
6117 let reader = Reader::open(&path).expect("reopen from disk");
6118 let probe = |value: i64| Probe {
6119 column: 0,
6120 op: Op::Equal,
6121 value: Bound::Int(i128::from(scattered(value))),
6122 };
6123 for wanted in [0_i64, (per_part + 1) as i64, (parts * per_part - 1) as i64] {
6124 let tests = [probe(wanted)];
6125 let kept: Vec<usize> = (0..parts).filter(|&part| !reader.skips(part, &tests)).collect();
6126 let home = wanted as usize / per_part;
6127 assert!(kept.contains(&home), "the part holding {wanted} is read");
6128 assert!(kept.len() <= 2, "{wanted} keeps {kept:?}, which is more than one stray part");
6132 }
6133 let absent = [probe((parts * per_part) as i64 + 1)];
6134 let kept = (0..parts).filter(|&part| !reader.skips(part, &absent)).count();
6135 assert!(kept <= 1, "{kept} parts of {parts} kept a value no part holds");
6136 let tests = [probe(0)];
6139 assert!(
6140 reader.table().stripes().iter().all(|stripe| !stripe.zone.skips(&tests)),
6141 "the bounds rule out no stripe at all"
6142 );
6143 fs::remove_file(path).expect("remove scratch file");
6144 }
6145
6146 #[test]
6152 fn a_part_is_skipped_when_its_own_bounds_rule_out_a_comparison_the_stripe_keeps() {
6153 let path = path("part-range-skip");
6154 let mut writer =
6155 Writer::create(&path, "hits", vec![Field::required("at", LogicalType::BigInt)])
6156 .expect("new file");
6157 let parts = STRIPE_PARTS + 3;
6158 let per_part = 128;
6159 for part in 0..parts {
6160 let held: Vec<Value> = (0..per_part)
6164 .map(|row| {
6165 Value::BigInt((part * 1_000) as i64 + (scattered(row as i64).rem_euclid(900)))
6166 })
6167 .collect();
6168 let chunk =
6169 Chunk::new(vec![Vector::from_values(LogicalType::BigInt, &held).expect("numbers")])
6170 .expect("one column");
6171 writer.append(&chunk).expect("one part");
6172 }
6173 writer.finish().expect("commit");
6174
6175 let reader = Reader::open(&path).expect("reopen from disk");
6176 let under = [Probe { column: 0, op: Op::Less, value: Bound::Int(3_000) }];
6177 let kept: Vec<usize> = (0..parts).filter(|&part| !reader.skips(part, &under)).collect();
6178 assert_eq!(kept, vec![0, 1, 2], "only the three parts that start under three thousand");
6179 assert!(!reader.stripe_skips(0, &under), "the stripe reaches from zero and keeps itself");
6181 fs::remove_file(path).expect("remove scratch file");
6182 }
6183
6184 #[test]
6188 fn a_part_is_waved_through_when_its_own_bounds_pass_a_comparison_the_stripe_cannot() {
6189 let path = path("part-range-certain");
6190 let mut writer =
6191 Writer::create(&path, "hits", vec![Field::required("at", LogicalType::BigInt)])
6192 .expect("new file");
6193 let parts = STRIPE_PARTS + 3;
6194 let per_part = 128;
6195 for part in 0..parts {
6196 let held: Vec<Value> = (0..per_part)
6197 .map(|row| {
6198 Value::BigInt((part * 1_000) as i64 + (scattered(row as i64).rem_euclid(900)))
6199 })
6200 .collect();
6201 let chunk =
6202 Chunk::new(vec![Vector::from_values(LogicalType::BigInt, &held).expect("numbers")])
6203 .expect("one column");
6204 writer.append(&chunk).expect("one part");
6205 }
6206 writer.finish().expect("commit");
6207
6208 let reader = Reader::open(&path).expect("reopen from disk");
6209 let under = [Probe { column: 0, op: Op::Less, value: Bound::Int(3_000) }];
6210 let waved: Vec<usize> = (0..parts).filter(|&part| reader.certain(part, &under)).collect();
6211 assert_eq!(waved, vec![0, 1, 2], "the three parts that end under three thousand");
6212 assert!(!reader.stripe_skips(0, &under), "the stripe straddles the comparison");
6215 fs::remove_file(path).expect("remove scratch file");
6216 }
6217
6218 #[test]
6221 fn a_stripe_of_one_part_writes_no_range_page_and_a_stripe_of_many_does() {
6222 for (parts, wanted) in [(1_usize, false), (STRIPE_PARTS, true)] {
6223 let path = path("part-range-page");
6224 let mut writer =
6225 Writer::create(&path, "hits", vec![Field::required("at", LogicalType::BigInt)])
6226 .expect("new file");
6227 for part in 0..parts {
6228 let held: Vec<Value> = (0..128)
6229 .map(|row| {
6230 Value::BigInt((part * 1_000) as i64 + scattered(row as i64).rem_euclid(900))
6231 })
6232 .collect();
6233 let chunk = Chunk::new(vec![
6234 Vector::from_values(LogicalType::BigInt, &held).expect("numbers"),
6235 ])
6236 .expect("one column");
6237 writer.append(&chunk).expect("one part");
6238 }
6239 writer.finish().expect("commit");
6240 let reader = Reader::open(&path).expect("reopen from disk");
6241 let bytes = reader.layout().columns[0].part_ranges;
6242 assert_eq!(bytes > 0, wanted, "{parts} parts wrote {bytes} bytes of ranges");
6243 fs::remove_file(path).expect("remove scratch file");
6244 }
6245 }
6246
6247 #[test]
6250 fn a_string_end_that_is_cut_down_still_covers_the_value_it_came_from() {
6251 let long = vec![b'a'; PART_BOUND_BYTES * 2];
6252 let low = shortened(Some(Bound::Bytes(long.clone())), false).expect("a low end");
6253 let high = shortened(Some(Bound::Bytes(long.clone())), true).expect("a high end");
6254 let Bound::Bytes(low) = low else { panic!("a string stays a string") };
6255 let Bound::Bytes(high) = high else { panic!("a string stays a string") };
6256 assert!(low.len() <= PART_BOUND_BYTES && high.len() <= PART_BOUND_BYTES);
6257 assert!(low.as_slice() <= long.as_slice(), "the low end is at or under the value");
6258 assert!(high.as_slice() >= long.as_slice(), "the high end is at or over the value");
6259 }
6260
6261 #[test]
6264 fn a_string_end_with_no_room_to_step_up_gives_up_the_bound() {
6265 let long = vec![u8::MAX; PART_BOUND_BYTES * 2];
6266 assert_eq!(shortened(Some(Bound::Bytes(long.clone())), true), None);
6267 let low = shortened(Some(Bound::Bytes(long)), false).expect("a low end is still a prefix");
6268 assert_eq!(low, Bound::Bytes(vec![u8::MAX; PART_BOUND_BYTES]));
6269 }
6270
6271 #[test]
6281 fn a_sieve_larger_than_the_part_it_indexes_is_not_written() {
6282 let path = path("sieve-pays");
6283 let fields = vec![
6284 Field::required("spread", LogicalType::BigInt),
6285 Field::required("repeated", LogicalType::BigInt),
6286 ];
6287 let mut writer = Writer::create(&path, "hits", fields).expect("new file");
6288 let parts = 3;
6289 let per_part = 1024;
6290 for part in 0..parts {
6291 let base = (part * per_part) as i64;
6292 let spread: Vec<Value> =
6293 (0..per_part).map(|row| Value::BigInt(scattered(base + row as i64))).collect();
6294 let repeated: Vec<Value> =
6295 (0..per_part).map(|row| Value::BigInt(scattered((row / 256) as i64))).collect();
6296 let chunk = Chunk::new(vec![
6297 Vector::from_values(LogicalType::BigInt, &spread).expect("numbers"),
6298 Vector::from_values(LogicalType::BigInt, &repeated).expect("numbers"),
6299 ])
6300 .expect("two columns");
6301 writer.append(&chunk).expect("one part");
6302 }
6303 writer.finish().expect("commit");
6304
6305 let reader = Reader::open(&path).expect("reopen from disk");
6306 let layout = reader.layout();
6307 let spread = &layout.columns[0];
6308 let repeated = &layout.columns[1];
6309 assert!(spread.sieves > 0, "a column whose parts are worth a filter keeps one");
6310 assert_eq!(
6311 repeated.sieves, 0,
6312 "a column whose filter costs more than its parts keeps none"
6313 );
6314 for column in &layout.columns {
6317 assert!(
6318 column.sieves < column.pages,
6319 "{} spends {} on sieves over {} of data",
6320 column.name,
6321 column.sieves,
6322 column.pages
6323 );
6324 }
6325 let absent = [Probe {
6327 column: 0,
6328 op: Op::Equal,
6329 value: Bound::Int(i128::from(scattered((parts * per_part) as i64 + 1))),
6330 }];
6331 assert!((0..parts).all(|part| reader.skips(part, &absent)), "no part holds it");
6332 fs::remove_file(path).expect("remove scratch file");
6333 }
6334
6335 #[test]
6341 fn a_damaged_sieve_page_is_read_through_rather_than_refused() {
6342 let path = path("sieve-damaged");
6343 let mut writer =
6344 Writer::create(&path, "hits", vec![Field::required("id", LogicalType::BigInt)])
6345 .expect("new file");
6346 let rows = 128;
6347 let held: Vec<Value> = (0..rows).map(|row| Value::BigInt(scattered(row))).collect();
6348 let chunk =
6349 Chunk::new(vec![Vector::from_values(LogicalType::BigInt, &held).expect("numbers")])
6350 .expect("one column");
6351 writer.append(&chunk).expect("one part");
6352 writer.finish().expect("commit");
6353
6354 let page =
6355 Reader::open(&path).expect("reopen").table.stripes[0].sieves[0].expect("a sieve page");
6356 let mut file = OpenOptions::new().write(true).open(&path).expect("open the sieve page");
6357 file.seek(SeekFrom::Start(page.offset + u64::from(page.length) - 1)).expect("seek");
6358 file.write_all(&[0xff]).expect("damage one byte");
6359 drop(file);
6360
6361 let reader = Reader::open(&path).expect("reopen the damaged file");
6362 let absent =
6363 [Probe { column: 0, op: Op::Equal, value: Bound::Int(i128::from(scattered(99))) }];
6364 assert!(!reader.skips(0, &absent), "a sieve that cannot be read skips nothing");
6365 assert_eq!(
6366 reader.read(0, &[0]).expect("the rows are untouched").len(),
6367 usize::try_from(rows).expect("a small count")
6368 );
6369 fs::remove_file(path).expect("remove scratch file");
6370 }
6371
6372 #[test]
6383 fn workers_that_want_the_same_stripe_read_it_once() {
6384 let path = path("single-flight");
6385 let mut writer =
6386 Writer::create(&path, "items", vec![Field::required("id", LogicalType::Integer)])
6387 .expect("new file");
6388 for part in 0..STRIPE_PARTS {
6389 let id = part as i32;
6390 let chunk = Chunk::new(vec![
6391 Vector::from_values(
6392 LogicalType::Integer,
6393 &[Value::Integer(id), Value::Integer(-id)],
6394 )
6395 .expect("integers"),
6396 ])
6397 .expect("matching rows");
6398 writer.append(&chunk).expect("one part");
6399 }
6400 writer.finish().expect("commit");
6401
6402 let reader = Reader::open(&path).expect("reopen from disk");
6403 assert_eq!(reader.table().stripes().len(), 1, "one stripe is the point of the test");
6404 let barrier = std::sync::Barrier::new(8);
6405 std::thread::scope(|scope| {
6406 for worker in 0..8 {
6407 let reader = &reader;
6408 let barrier = &barrier;
6409 scope.spawn(move || {
6410 barrier.wait();
6411 for part in (worker..STRIPE_PARTS).step_by(8) {
6412 let chunk = reader.read(part, &[0]).expect("a whole page read");
6413 assert_eq!(chunk.value_at(0, 0), Value::Integer(part as i32));
6414 assert_eq!(chunk.value_at(1, 0), Value::Integer(-(part as i32)));
6415 }
6416 });
6417 }
6418 });
6419 assert_eq!(reader.pages.load(Atomic::Relaxed), 1, "one stripe, one page read, whoever won");
6420 fs::remove_file(path).expect("remove scratch file");
6421 }
6422
6423 #[test]
6436 fn opening_costs_the_same_over_a_thousand_times_the_rows() {
6437 let opened = |label: &str, rows_per_part: i32| {
6438 let path = path(label);
6439 let mut writer =
6440 Writer::create(&path, "items", vec![Field::required("id", LogicalType::Integer)])
6441 .expect("new file");
6442 for part in 0..STRIPE_PARTS * 3 {
6443 let values = (0..rows_per_part)
6447 .map(|row| {
6448 Value::Integer((part as i32 * rows_per_part + row).wrapping_mul(2_654_435))
6449 })
6450 .collect::<Vec<_>>();
6451 let chunk = Chunk::new(vec![
6452 Vector::from_values(LogicalType::Integer, &values).expect("integers"),
6453 ])
6454 .expect("matching rows");
6455 writer.append(&chunk).expect("one part");
6456 }
6457 writer.finish().expect("commit");
6458 let reader = Reader::open(&path).expect("reopen from disk");
6459 let size = fs::metadata(&path).expect("the file is there").len();
6460 let out = (reader.reads(), reader.table().stripes().len(), size);
6461 fs::remove_file(path).expect("remove scratch file");
6462 out
6463 };
6464
6465 let (thin, thin_stripes, thin_size) = opened("open-thin", 1);
6466 let (fat, fat_stripes, fat_size) = opened("open-fat", 1000);
6467 assert_eq!(
6468 thin_stripes, fat_stripes,
6469 "the same stripe count is what makes this a fair ask"
6470 );
6471 assert!(
6472 fat_size > thin_size * 50,
6473 "the fat file has to actually be larger, and it is {fat_size} against {thin_size}"
6474 );
6475
6476 assert_eq!(thin.opening.reads, fat.opening.reads, "the same reads either way");
6477 assert_eq!(thin.pages, 0, "opening read a page");
6478 assert_eq!(fat.pages, 0, "opening read a page");
6479 assert_eq!(thin.indexes, 0, "opening read an index");
6480 assert_eq!(fat.indexes, 0, "opening read an index");
6481 assert!(
6484 fat.opening.bytes < thin.opening.bytes * 2,
6485 "opening the thin file read {} bytes and the fat one read {}",
6486 thin.opening.bytes,
6487 fat.opening.bytes
6488 );
6489 }
6490
6491 #[test]
6499 fn two_opens_of_one_file_cost_the_same_and_the_second_is_not_cheaper() {
6500 let path = path("open-twice");
6501 let mut writer =
6502 Writer::create(&path, "items", vec![Field::required("id", LogicalType::Integer)])
6503 .expect("new file");
6504 for part in 0..STRIPE_PARTS * 3 {
6505 let chunk = Chunk::new(vec![
6506 Vector::from_values(LogicalType::Integer, &[Value::Integer(part as i32)])
6507 .expect("integers"),
6508 ])
6509 .expect("matching rows");
6510 writer.append(&chunk).expect("one part");
6511 }
6512 writer.finish().expect("commit");
6513
6514 let first = Reader::open(&path).expect("open");
6515 for part in 0..first.parts() {
6518 first.read(part, &[0]).expect("a part");
6519 }
6520 assert!(first.reads().pages > 0, "the scan has to have read something");
6521 let second = Reader::open(&path).expect("open again");
6522
6523 assert_eq!(first.reads().opening, second.reads().opening);
6524 assert_eq!(
6525 second.reads().pages,
6526 0,
6527 "the second open read a page off the back of the first"
6528 );
6529 assert_eq!(second.reads().indexes, 0, "the second open read an index it inherited");
6530 fs::remove_file(path).expect("remove scratch file");
6531 }
6532
6533 #[test]
6541 fn an_index_is_read_once_per_stripe_however_often_the_page_is_evicted() {
6542 let path = path("index-cache");
6543 let mut writer =
6544 Writer::create(&path, "items", vec![Field::required("id", LogicalType::Integer)])
6545 .expect("new file");
6546 let parts = STRIPE_PARTS * (CACHED_STRIPES_PER_COLUMN + 2);
6547 for part in 0..parts {
6548 let id = part as i32;
6549 let chunk = Chunk::new(vec![
6550 Vector::from_values(LogicalType::Integer, &[Value::Integer(id)]).expect("integers"),
6551 ])
6552 .expect("matching rows");
6553 writer.append(&chunk).expect("one part");
6554 }
6555 writer.finish().expect("commit");
6556
6557 let reader = Reader::open(&path).expect("reopen from disk");
6558 let stripes = reader.table().stripes().len();
6559 assert!(stripes > CACHED_STRIPES_PER_COLUMN, "the page cache has to be too small for this");
6560 for _ in 0..2 {
6562 for part in 0..parts {
6563 let chunk = reader.read(part, &[0]).expect("a part");
6564 assert_eq!(chunk.value_at(0, 0), Value::Integer(part as i32));
6565 }
6566 }
6567 assert_eq!(reader.indexes.load(Atomic::Relaxed), stripes, "one index read per stripe");
6568 assert!(
6569 reader.pages.load(Atomic::Relaxed) > stripes,
6570 "the pages are the ones that get read again, which is what makes the index count mean \
6571 something"
6572 );
6573 fs::remove_file(path).expect("remove scratch file");
6574 }
6575
6576 #[test]
6585 fn a_worker_per_stripe_reads_its_page_once_when_the_cache_was_told_to_expect_it() {
6586 let workers = CACHED_STRIPES_PER_COLUMN + 4;
6587 let path = path("stripe-per-worker");
6588 let mut writer =
6589 Writer::create(&path, "items", vec![Field::required("id", LogicalType::Integer)])
6590 .expect("new file");
6591 for part in 0..STRIPE_PARTS * workers {
6592 let chunk = Chunk::new(vec![
6593 Vector::from_values(LogicalType::Integer, &[Value::Integer(part as i32)])
6594 .expect("integers"),
6595 ])
6596 .expect("matching rows");
6597 writer.append(&chunk).expect("one part");
6598 }
6599 writer.finish().expect("commit");
6600
6601 let read = |told: bool| {
6602 let reader = Reader::open(&path).expect("reopen from disk");
6603 assert_eq!(reader.table().stripes().len(), workers, "a stripe per worker");
6604 if told {
6605 reader.keep_stripes(workers);
6606 }
6607 let barrier = std::sync::Barrier::new(workers);
6608 std::thread::scope(|scope| {
6609 for (worker, run) in reader.stripe_parts().into_iter().enumerate() {
6610 let reader = &reader;
6611 let barrier = &barrier;
6612 scope.spawn(move || {
6613 for part in run {
6614 barrier.wait();
6615 let chunk = reader.read(part, &[0]).expect("a part of my own stripe");
6616 assert_eq!(chunk.value_at(0, 0), Value::Integer(part as i32));
6617 }
6618 assert!(worker < workers);
6619 });
6620 }
6621 });
6622 reader.pages.load(Atomic::Relaxed)
6623 };
6624
6625 assert_eq!(read(true), workers, "one page read per stripe and no more");
6626 assert!(read(false) > workers, "a cache that small is read again on every part");
6627 fs::remove_file(path).expect("remove scratch file");
6628 }
6629
6630 #[test]
6635 fn a_damaged_index_page_is_an_error() {
6636 let path = path("damaged-index");
6637 let mut writer =
6638 Writer::create(&path, "items", vec![Field::required("id", LogicalType::Integer)])
6639 .expect("new file");
6640 writer.append(&sample_ids()).expect("first part");
6641 writer.append(&sample_ids()).expect("second part");
6642 writer.finish().expect("commit");
6643
6644 let reader = Reader::open(&path).expect("valid directory");
6645 let index = reader.table.stripes[0].index;
6646 let mut byte = [0; 1];
6647 read_at(&reader.file, index.offset, &mut byte).expect("the first part length");
6648 let mut file = OpenOptions::new().write(true).open(&path).expect("open index page");
6649 file.seek(SeekFrom::Start(index.offset)).expect("index start");
6650 file.write_all(&[!byte[0]]).expect("damage the first part length");
6651 let error = reader.read(1, &[0]).expect_err("a damaged index must not be used");
6652 assert!(error.message().contains("index page section checksum differs"), "{error}");
6653 fs::remove_file(path).expect("remove scratch file");
6654 }
6655
6656 #[test]
6663 fn every_integer_width_round_trips_through_a_page() {
6664 let path = path("integer-widths");
6665 let columns = [
6666 (LogicalType::TinyInt, vec![Value::TinyInt(i8::MIN), Value::TinyInt(i8::MAX)]),
6667 (LogicalType::UTinyInt, vec![Value::UTinyInt(0), Value::UTinyInt(u8::MAX)]),
6668 (LogicalType::SmallInt, vec![Value::SmallInt(i16::MIN), Value::SmallInt(i16::MAX)]),
6669 (LogicalType::USmallInt, vec![Value::USmallInt(0), Value::USmallInt(u16::MAX)]),
6670 (LogicalType::Integer, vec![Value::Integer(i32::MIN), Value::Integer(i32::MAX)]),
6671 (LogicalType::UInteger, vec![Value::UInteger(0), Value::UInteger(u32::MAX)]),
6672 (LogicalType::BigInt, vec![Value::BigInt(i64::MIN), Value::BigInt(i64::MAX)]),
6673 (LogicalType::UBigInt, vec![Value::UBigInt(0), Value::UBigInt(u64::MAX)]),
6674 ];
6675 let fields = columns
6676 .iter()
6677 .enumerate()
6678 .map(|(at, (ty, _))| Field::required(format!("c{at}"), ty.clone()))
6679 .collect::<Vec<_>>();
6680 let vectors = columns
6681 .iter()
6682 .map(|(ty, values)| Vector::from_values(ty.clone(), values).expect("a vector"))
6683 .collect::<Vec<_>>();
6684 let mut writer = Writer::create(&path, "widths", fields).expect("new file");
6685 writer.append(&Chunk::new(vectors).expect("matching rows")).expect("one stripe");
6686 writer.finish().expect("commit");
6687
6688 let reader = Reader::open(&path).expect("reopen from disk");
6689 let wanted = (0..columns.len()).collect::<Vec<_>>();
6690 let read = reader.read(0, &wanted).expect("every column");
6691 assert_eq!(read.len(), 2);
6692 for (at, (ty, values)) in columns.iter().enumerate() {
6694 assert_eq!(read.value_at(0, at), values[0], "the low end of {ty}");
6695 assert_eq!(read.value_at(1, at), values[1], "the high end of {ty}");
6696 }
6697 fs::remove_file(path).expect("remove scratch file");
6698 }
6699
6700 #[test]
6701 fn numeric_frequency_candidates_keep_bounded_row_ordinals() {
6702 let path = path("frequency-ordinals");
6703 let mut writer =
6704 Writer::create(&path, "items", vec![Field::required("id", LogicalType::BigInt)])
6705 .expect("new file");
6706 let mut values = Vec::new();
6707 for leader in 0..10_i64 {
6708 values.extend(std::iter::repeat_n(leader, 100));
6709 }
6710 values.extend(1_000_i64..41_000);
6711 for part in values.chunks(1_024) {
6712 let vector = Vector::flat(LogicalType::BigInt, Data::Int64(part.to_vec().into()))
6713 .expect("big integers");
6714 writer.append(&Chunk::new(vec![vector]).expect("one column")).expect("one stripe");
6715 }
6716 writer.finish().expect("commit");
6717
6718 let reader = Reader::open(&path).expect("reopen from disk");
6719 let occurrences =
6720 reader.frequency_occurrences(0).expect("valid metadata").expect("bounded ordinals");
6721 assert!(occurrences.omitted_max < 100);
6722 assert!(occurrences.ordinals.len() <= FREQUENCY_ORDINALS);
6723 assert!(occurrences.ordinals.windows(2).all(|pair| pair[0] < pair[1]));
6724 assert_eq!(&occurrences.ordinals[..1_000], &(0_u64..1_000).collect::<Vec<_>>());
6725 fs::remove_file(path).expect("remove scratch file");
6726 }
6727
6728 #[test]
6734 fn a_file_from_another_format_says_which_format_it_is() {
6735 let older = path("older-format");
6736 let mut writer =
6737 Writer::create(&older, "items", vec![Field::new("id", LogicalType::Integer)])
6738 .expect("new file");
6739 let chunk = Chunk::new(vec![
6740 Vector::flat(LogicalType::Integer, Data::Int32(vec![1, 2, 3].into()))
6741 .expect("integers"),
6742 ])
6743 .expect("chunk");
6744 writer.append(&chunk).expect("page written");
6745 writer.finish().expect("commit");
6746
6747 let mut file = OpenOptions::new().write(true).open(&older).expect("open for the header");
6748 file.seek(SeekFrom::Start(8)).expect("the version follows the magic");
6749 file.write_all(&(FORMAT - 1).to_le_bytes()).expect("write an older version");
6750 drop(file);
6751 let complaint = Reader::open(&older).expect_err("an older format is refused").to_string();
6752 assert!(complaint.contains(&format!("format {}", FORMAT - 1)), "{complaint}");
6753 assert!(complaint.contains(&format!("format {FORMAT}")), "{complaint}");
6754
6755 let mut file = OpenOptions::new().write(true).open(&older).expect("open for the header");
6756 file.seek(SeekFrom::Start(0)).expect("the magic is first");
6757 file.write_all(b"NOTRUDB!").expect("write another engine's magic");
6758 drop(file);
6759 let complaint = Reader::open(&older).expect_err("a foreign file is refused").to_string();
6760 assert!(complaint.contains("magic"), "{complaint}");
6761 assert!(!complaint.contains("format"), "a version has nothing to do with it: {complaint}");
6762 fs::remove_file(older).expect("remove scratch file");
6763 }
6764
6765 #[test]
6766 fn an_unfinished_or_damaged_file_does_not_answer_with_partial_rows() {
6767 let unfinished = path("unfinished");
6768 let mut writer =
6769 Writer::create(&unfinished, "items", vec![Field::new("id", LogicalType::Integer)])
6770 .expect("new file");
6771 let chunk = Chunk::new(vec![
6772 Vector::flat(LogicalType::Integer, Data::Int32(vec![1, 2, 3].into()))
6773 .expect("integers"),
6774 ])
6775 .expect("chunk");
6776 writer.append(&chunk).expect("page written");
6777 drop(writer);
6778 assert!(Reader::open(&unfinished).is_err(), "no directory was committed");
6779 fs::remove_file(unfinished).expect("remove scratch file");
6780
6781 let damaged = path("damaged");
6782 let mut writer =
6783 Writer::create(&damaged, "items", vec![Field::new("id", LogicalType::Integer)])
6784 .expect("new file");
6785 writer.append(&chunk).expect("page written");
6786 writer.finish().expect("commit");
6787 let reader = Reader::open(&damaged).expect("valid directory");
6788 let mut file =
6789 OpenOptions::new().write(true).open(&damaged).expect("open for a damaged page");
6790 file.seek(SeekFrom::Start(HEADER + 1)).expect("inside first page");
6791 file.write_all(&[255]).expect("damage one byte");
6792 assert!(reader.read(0, &[0]).is_err(), "page checksum rejects corruption");
6793 fs::remove_file(damaged).expect("remove scratch file");
6794 }
6795
6796 #[test]
6797 fn damaged_lazy_dictionary_payload_is_an_error() {
6798 let path = path("damaged-dictionary");
6799 let mut writer = Writer::create(
6800 &path,
6801 "items",
6802 vec![
6803 Field::required("id", LogicalType::Integer),
6804 Field::new("text", LogicalType::Varchar),
6805 ],
6806 )
6807 .expect("new file");
6808 writer.append(&sample()).expect("stripe written");
6809 writer.finish().expect("commit");
6810
6811 let reader = Reader::open(&path).expect("valid directory");
6812 let dictionary = reader.table.dictionaries[1].expect("string dictionary page");
6813 let mut header = [0; DICTIONARY_HEADER];
6816 read_at(&reader.file, dictionary.offset, &mut header).expect("dictionary header");
6817 let index_len = dictionary_index_len(&header);
6818 let rank_len = last_rank_end(&reader.file, dictionary.offset, &header);
6819 let mut file = OpenOptions::new().write(true).open(&path).expect("open dictionary page");
6820 file.seek(SeekFrom::Start(dictionary.offset + index_len + rank_len))
6821 .expect("inside dictionary payload");
6822 file.write_all(&[255]).expect("damage dictionary payload");
6823
6824 let chunk = reader.read(0, &[1]).expect("code page and dictionary index remain valid");
6825 let error =
6826 chunk.validate_external().expect_err("payload corruption must reach the caller");
6827 assert!(error.message().contains("payload checksum differs"), "{error}");
6828 fs::remove_file(path).expect("remove scratch file");
6829 }
6830
6831 #[test]
6838 fn a_dictionary_over_many_blocks_checks_every_block_of_it() {
6839 let path = path("dictionary-blocks");
6840 let value =
6841 |row: usize| format!("{row:07} a value long enough to be worth a payload block");
6842 let parts = 30;
6843 let per_part = 1000;
6844 let mut writer =
6845 Writer::create(&path, "items", vec![Field::required("text", LogicalType::Varchar)])
6846 .expect("new file");
6847 for part in 0..parts {
6848 let values = (0..per_part)
6849 .map(|row| Value::Varchar(value(part * per_part + row)))
6850 .collect::<Vec<_>>();
6851 let chunk = Chunk::new(vec![
6852 Vector::from_values(LogicalType::Varchar, &values).expect("strings"),
6853 ])
6854 .expect("matching rows");
6855 writer.append(&chunk).expect("a part");
6856 }
6857 writer.finish().expect("commit");
6858
6859 let reader = Reader::open(&path).expect("reopen from disk");
6860 let dictionary = reader.table.dictionaries[0].expect("string dictionary page");
6861 assert!(
6862 parts * per_part > TEXT_PAYLOAD_VALUES * 4,
6863 "the dictionary has to be several blocks for this to be testing anything"
6864 );
6865 for part in [0, parts - 1] {
6866 let chunk = reader.read(part, &[0]).expect("a part");
6867 chunk.validate_external().expect("every payload block checks out");
6868 assert_eq!(chunk.value_at(0, 0), Value::Varchar(value(part * per_part)));
6869 }
6870
6871 let mut file = OpenOptions::new().write(true).open(&path).expect("open dictionary page");
6872 file.seek(SeekFrom::Start(dictionary.offset + u64::from(dictionary.length) - 4))
6873 .expect("the last bytes of the page are payload");
6874 file.write_all(&[255]).expect("damage the last payload block");
6875 let reader = Reader::open(&path).expect("the directory and the index are untouched");
6876 let chunk = reader.read(parts - 1, &[0]).expect("the code page remains valid");
6877 let error = chunk.validate_external().expect_err("the damage must reach the caller");
6878 assert!(error.message().contains("payload checksum differs"), "{error}");
6879 fs::remove_file(path).expect("remove scratch file");
6880 }
6881
6882 #[test]
6892 fn values_of_different_lengths_read_back_out_of_packed_offsets() {
6893 let path = path("dictionary-offsets");
6894 let value = |row: usize| {
6895 if row % 511 == 3 { String::new() } else { "x".repeat(row % 97) + &format!("{row:05}") }
6896 };
6897 let rows = 5_000;
6898 let mut writer =
6899 Writer::create(&path, "items", vec![Field::required("text", LogicalType::Varchar)])
6900 .expect("new file");
6901 let values = (0..rows).map(|row| Value::Varchar(value(row))).collect::<Vec<_>>();
6902 for part in values.chunks(1_000) {
6903 let chunk =
6904 Chunk::new(vec![Vector::from_values(LogicalType::Varchar, part).expect("strings")])
6905 .expect("matching rows");
6906 writer.append(&chunk).expect("a part");
6907 }
6908 writer.finish().expect("commit");
6909
6910 let reader = Reader::open(&path).expect("reopen from disk");
6911 assert!(
6912 rows > TEXT_PAYLOAD_VALUES * 4,
6913 "the dictionary has to be several blocks for this to be testing anything"
6914 );
6915 for part in 0..rows / 1_000 {
6916 let chunk = reader.read(part, &[0]).expect("a part");
6917 for row in 0..1_000 {
6918 let row = part * 1_000 + row;
6919 assert_eq!(
6920 chunk.value_at(row % 1_000, 0),
6921 Value::Varchar(value(row)),
6922 "value {row}"
6923 );
6924 }
6925 }
6926 fs::remove_file(path).expect("remove scratch file");
6927 }
6928
6929 #[test]
6941 fn a_global_dictionary_is_opened_once_however_many_workers_ask_at_once() {
6942 let path = path("dictionary-once");
6943 let parts = 8;
6944 let per_part = 500;
6945 let value =
6946 |row: usize| format!("{row:07} a value long enough to be worth a payload block");
6947 let mut writer =
6948 Writer::create(&path, "items", vec![Field::required("text", LogicalType::Varchar)])
6949 .expect("new file");
6950 for part in 0..parts {
6951 let values = (0..per_part)
6952 .map(|row| Value::Varchar(value(part * per_part + row)))
6953 .collect::<Vec<_>>();
6954 let chunk = Chunk::new(vec![
6955 Vector::from_values(LogicalType::Varchar, &values).expect("strings"),
6956 ])
6957 .expect("matching rows");
6958 writer.append(&chunk).expect("a part");
6959 }
6960 writer.finish().expect("commit");
6961
6962 let reader = Reader::open(&path).expect("reopen from disk");
6963 assert!(reader.table.dictionaries[0].is_some(), "the column has to have one to share");
6964 assert_eq!(reader.reads().dictionaries, 0, "opening the file does not open a dictionary");
6965
6966 let workers = 16;
6967 let gate = std::sync::Barrier::new(workers);
6968 std::thread::scope(|scope| {
6969 for worker in 0..workers {
6970 let reader = reader.clone();
6971 let gate = &gate;
6972 scope.spawn(move || {
6973 gate.wait();
6974 let chunk = reader.read(worker % parts, &[0]).expect("a part");
6975 assert_eq!(
6976 chunk.value_at(0, 0),
6977 Value::Varchar(value((worker % parts) * per_part))
6978 );
6979 });
6980 }
6981 });
6982
6983 assert_eq!(reader.reads().dictionaries, 1, "sixteen workers, one dictionary, one open");
6984 fs::remove_file(path).expect("remove scratch file");
6985 }
6986
6987 #[test]
6992 fn a_damaged_sorted_order_is_an_error() {
6993 let path = path("damaged-order");
6994 let mut writer = Writer::create(
6995 &path,
6996 "items",
6997 vec![
6998 Field::required("id", LogicalType::Integer),
6999 Field::new("text", LogicalType::Varchar),
7000 ],
7001 )
7002 .expect("new file");
7003 writer.append(&sample()).expect("stripe written");
7004 writer.finish().expect("commit");
7005
7006 let reader = Reader::open(&path).expect("valid directory");
7007 let page = reader.table.dictionaries[1].expect("string dictionary page");
7008 let mut header = [0; DICTIONARY_HEADER];
7009 read_at(&reader.file, page.offset, &mut header).expect("dictionary header");
7010 let index_len = dictionary_index_len(&header);
7011 let mut file = OpenOptions::new().write(true).open(&path).expect("open dictionary page");
7012 file.seek(SeekFrom::Start(page.offset + index_len)).expect("the first head");
7013 file.write_all(&[255]).expect("damage the order");
7014
7015 let dictionary = reader.dictionary(1).expect("read").expect("a string column has one");
7016 let error = dictionary.compare_rank(0, b"anything").expect_err("a damaged order is caught");
7017 assert!(error.message().contains("rank checksum differs"), "{error}");
7018 fs::remove_file(path).expect("remove scratch file");
7019 }
7020
7021 #[test]
7025 fn a_global_dictionary_carries_the_sorted_order_of_its_values() {
7026 let spellings = ["overlong1z", "b", "", "overlong1a", "overlong", "ab", "a", "overlong1"];
7029 let path = path("dictionary-order");
7030 let mut writer =
7031 Writer::create(&path, "items", vec![Field::new("text", LogicalType::Varchar)])
7032 .expect("new file");
7033 writer
7034 .append(
7035 &Chunk::new(vec![
7036 Vector::from_values(
7037 LogicalType::Varchar,
7038 &spellings.map(|text| Value::Varchar(text.into())),
7039 )
7040 .expect("strings"),
7041 ])
7042 .expect("one column"),
7043 )
7044 .expect("stripe written");
7045 writer.finish().expect("commit");
7046
7047 let reader = Reader::open(&path).expect("valid directory");
7048 let dictionary = reader.dictionary(0).expect("read").expect("a string column has one");
7049 let count = dictionary.ranks().expect("a v10 file stores one");
7050 assert_eq!(count, spellings.len(), "every distinct value has a rank");
7051 let order = (0..count)
7052 .map(|rank| dictionary.code_at_rank(rank).expect("a code"))
7053 .collect::<Vec<_>>();
7054 let mut seen = order.clone();
7055 seen.sort_unstable();
7056 assert_eq!(seen, (0..spellings.len() as u32).collect::<Vec<_>>(), "a permutation of codes");
7057
7058 let ranked = order
7059 .iter()
7060 .map(|&code| {
7061 dictionary.try_bytes_at(code as usize).expect("read").expect("a value").to_vec()
7062 })
7063 .collect::<Vec<_>>();
7064 let mut expected = spellings.map(|text| text.as_bytes().to_vec()).to_vec();
7065 expected.sort();
7066 assert_eq!(ranked, expected, "rank order is value order");
7067
7068 for (rank, value) in expected.iter().enumerate() {
7071 assert_eq!(
7072 dictionary.compare_rank(rank, value).expect("compare"),
7073 Ordering::Equal,
7074 "rank {rank} is its own value"
7075 );
7076 if rank > 0 {
7077 assert_eq!(
7078 dictionary.compare_rank(rank - 1, value).expect("compare"),
7079 Ordering::Less,
7080 "rank {rank} follows the one before it"
7081 );
7082 }
7083 }
7084 fs::remove_file(path).expect("remove scratch file");
7085 }
7086
7087 #[test]
7095 fn a_dictionary_sweep_reads_every_value_and_keeps_it_under_the_budget() {
7096 let path = path("dictionary-sweep");
7097 let spellings = (0..2_500)
7100 .map(|index| Value::Varchar(format!("value {index:08} {}", "x".repeat(index % 40))))
7101 .collect::<Vec<_>>();
7102 let mut writer =
7103 Writer::create(&path, "items", vec![Field::new("text", LogicalType::Varchar)])
7104 .expect("new file");
7105 for part in spellings.chunks(1_024) {
7108 writer
7109 .append(
7110 &Chunk::new(vec![
7111 Vector::from_values(LogicalType::Varchar, part).expect("strings"),
7112 ])
7113 .expect("one column"),
7114 )
7115 .expect("stripe written");
7116 }
7117 writer.finish().expect("commit");
7118
7119 let reader = Reader::open(&path).expect("valid directory");
7120 let dictionary = reader.dictionary(0).expect("read").expect("a string column has one");
7121 assert_eq!(dictionary.len(), spellings.len(), "every value is distinct");
7122
7123 let resting = dictionary.footprint();
7124 let mut swept: Vec<Vec<u8>> = Vec::new();
7125 let mut at = 0;
7126 let mut calls = 0;
7127 while at < dictionary.len() {
7128 let stopped = dictionary
7129 .sweep_text(at, dictionary.len(), &mut |index: usize, text: &[u8]| {
7130 assert_eq!(index, swept.len(), "a sweep hands its values over in order");
7131 swept.push(text.to_vec());
7132 Ok(())
7133 })
7134 .expect("a sweep reads");
7135 assert!(stopped > at, "a sweep moves");
7136 at = stopped;
7137 calls += 1;
7138 }
7139 assert_eq!(calls, 3, "a sweep hands over one block at a time");
7140 let after = dictionary.footprint();
7141 assert!(after > resting, "a sweep under the budget keeps what it decoded");
7142
7143 let read = (0..dictionary.len())
7144 .map(|code| dictionary.try_bytes_at(code).expect("read").expect("a value").to_vec())
7145 .collect::<Vec<_>>();
7146 assert_eq!(swept, read, "a sweep answers what a point read answers");
7147 assert_eq!(dictionary.footprint(), after, "a point read of a kept block decodes nothing");
7148 fs::remove_file(path).expect("remove scratch file");
7149 }
7150
7151 #[test]
7162 fn a_sweep_over_a_block_with_a_short_second_run_reads_what_a_point_read_reads() {
7163 let path = path("dictionary-sweep-short-run");
7164 let spellings = (0..2_800)
7165 .map(|index| Value::Varchar(format!("value {index:08} {}", "x".repeat(index % 40))))
7166 .collect::<Vec<_>>();
7167 let mut writer =
7168 Writer::create(&path, "items", vec![Field::new("text", LogicalType::Varchar)])
7169 .expect("new file");
7170 for part in spellings.chunks(1_024) {
7171 writer
7172 .append(
7173 &Chunk::new(vec![
7174 Vector::from_values(LogicalType::Varchar, part).expect("strings"),
7175 ])
7176 .expect("one column"),
7177 )
7178 .expect("stripe written");
7179 }
7180 writer.finish().expect("commit");
7181
7182 let reader = Reader::open(&path).expect("valid directory");
7183 let dictionary = reader.dictionary(0).expect("read").expect("a string column has one");
7184 assert_eq!(dictionary.len(), spellings.len(), "every value is distinct");
7185 let last = dictionary.len() % TEXT_PAYLOAD_VALUES;
7186 assert!(last > TEXT_OFFSET_RUN, "the last block has to reach into a second run of offsets");
7187 assert!(last < TEXT_PAYLOAD_VALUES, "and that second run has to be short of a whole one");
7188
7189 let mut swept: Vec<Vec<u8>> = Vec::new();
7190 let mut at = 0;
7191 while at < dictionary.len() {
7192 let stopped = dictionary
7193 .sweep_text(at, dictionary.len(), &mut |index: usize, text: &[u8]| {
7194 assert_eq!(index, swept.len(), "a sweep hands its values over in order");
7195 swept.push(text.to_vec());
7196 Ok(())
7197 })
7198 .expect("a sweep reads");
7199 assert!(stopped > at, "a sweep moves");
7200 at = stopped;
7201 }
7202 let read = (0..dictionary.len())
7203 .map(|code| dictionary.try_bytes_at(code).expect("read").expect("a value").to_vec())
7204 .collect::<Vec<_>>();
7205 assert_eq!(swept, read, "a sweep answers what a point read answers");
7206 fs::remove_file(path).expect("remove scratch file");
7207 }
7208
7209 #[test]
7219 fn narrowing_a_page_takes_what_fits_and_refuses_what_does_not() {
7220 assert_eq!(fit::<i8>(&[]).expect("an empty page fits anything"), Vec::<i8>::new());
7221 assert_eq!(fit::<i8>(&[-128, 0, 127]).expect("the edges fit"), vec![-128_i8, 0, 127]);
7222 fit::<i8>(&[128]).expect_err("one past the top does not fit");
7223 fit::<i8>(&[-129]).expect_err("one past the bottom does not fit");
7224 assert_eq!(fit::<u8>(&[0, 255]).expect("the edges fit"), vec![0_u8, 255]);
7225 fit::<u8>(&[256]).expect_err("one past the top does not fit");
7226 fit::<u8>(&[-1]).expect_err("a negative does not fit an unsigned page");
7227 assert_eq!(
7228 fit::<i16>(&[-32_768, 0, 32_767]).expect("the edges fit"),
7229 vec![-32_768_i16, 0, 32_767]
7230 );
7231 fit::<i16>(&[32_768]).expect_err("one past the top does not fit");
7232 fit::<i16>(&[-32_769]).expect_err("one past the bottom does not fit");
7233 assert_eq!(fit::<u16>(&[0, 65_535]).expect("the edges fit"), vec![0_u16, 65_535]);
7234 fit::<u16>(&[65_536]).expect_err("one past the top does not fit");
7235 fit::<u16>(&[-1]).expect_err("a negative does not fit an unsigned page");
7236 assert_eq!(
7237 fit::<i32>(&[i64::from(i32::MIN), 0, i64::from(i32::MAX)]).expect("the edges fit"),
7238 vec![i32::MIN, 0, i32::MAX]
7239 );
7240 fit::<i32>(&[i64::from(i32::MAX) + 1]).expect_err("one past the top does not fit");
7241 fit::<i32>(&[i64::from(i32::MIN) - 1]).expect_err("one past the bottom does not fit");
7242 assert_eq!(
7243 fit::<u32>(&[0, 4_294_967_295]).expect("the edges fit"),
7244 vec![0_u32, 4_294_967_295]
7245 );
7246 fit::<u32>(&[4_294_967_296]).expect_err("one past the top does not fit");
7247 fit::<u32>(&[-1]).expect_err("a negative does not fit an unsigned page");
7248
7249 fit::<i8>(&[0, 1, 2, 128, 3]).expect_err("one bad value spoils the page");
7252 }
7253
7254 #[test]
7261 fn the_residue_agrees_with_a_checked_conversion_everywhere() {
7262 for value in -70_000_i64..70_000 {
7263 assert_eq!(fit::<i8>(&[value]).is_ok(), i8::try_from(value).is_ok(), "{value} as i8");
7264 assert_eq!(fit::<u8>(&[value]).is_ok(), u8::try_from(value).is_ok(), "{value} as u8");
7265 assert_eq!(fit::<i16>(&[value]).is_ok(), i16::try_from(value).is_ok(), "{value} i16");
7266 assert_eq!(fit::<u16>(&[value]).is_ok(), u16::try_from(value).is_ok(), "{value} u16");
7267 }
7268 let wide = [i64::MIN, i64::MIN + 1, i64::from(i32::MIN), 0, i64::from(u32::MAX), i64::MAX];
7269 for edge in wide {
7270 for step in -2_i64..=2 {
7271 let value = edge.saturating_add(step);
7272 assert_eq!(
7273 fit::<i32>(&[value]).is_ok(),
7274 i32::try_from(value).is_ok(),
7275 "{value} as i32"
7276 );
7277 assert_eq!(
7278 fit::<u32>(&[value]).is_ok(),
7279 u32::try_from(value).is_ok(),
7280 "{value} as u32"
7281 );
7282 }
7283 }
7284 }
7285
7286 #[test]
7294 fn a_dictionary_at_its_budget_sweeps_without_keeping() {
7295 let path = path("dictionary-budget");
7296 let spellings = (0..2_500)
7297 .map(|index| Value::Varchar(format!("value {index:08} {}", "y".repeat(index % 40))))
7298 .collect::<Vec<_>>();
7299 let mut writer =
7300 Writer::create(&path, "items", vec![Field::new("text", LogicalType::Varchar)])
7301 .expect("new file");
7302 for part in spellings.chunks(1_024) {
7303 writer
7304 .append(
7305 &Chunk::new(vec![
7306 Vector::from_values(LogicalType::Varchar, part).expect("strings"),
7307 ])
7308 .expect("one column"),
7309 )
7310 .expect("stripe written");
7311 }
7312 writer.finish().expect("commit");
7313
7314 let reader = Reader::open(&path).expect("valid directory");
7315 let page = reader.table.dictionaries[0].expect("a string column has one");
7316 let file = Arc::clone(&reader.file);
7317 let starved = open_global_dictionary(file, page, &LogicalType::Varchar, 0)
7318 .expect("a dictionary opens whatever it may keep");
7319
7320 let resting = starved.footprint();
7321 let mut swept: Vec<Vec<u8>> = Vec::new();
7322 let mut at = 0;
7323 while at < starved.len() {
7324 at = starved
7325 .sweep_text(at, starved.len(), &mut |_index: usize, text: &[u8]| {
7326 swept.push(text.to_vec());
7327 Ok(())
7328 })
7329 .expect("a sweep reads");
7330 }
7331 assert_eq!(swept.len(), spellings.len(), "a starved sweep still reads every value");
7332 assert_eq!(starved.footprint(), resting, "and keeps no block it decoded");
7333
7334 let generous = reader.dictionary(0).expect("read").expect("a string column has one");
7335 let read = (0..generous.len())
7336 .map(|code| generous.try_bytes_at(code).expect("read").expect("a value").to_vec())
7337 .collect::<Vec<_>>();
7338 assert_eq!(swept, read, "a starved sweep answers what a point read answers");
7339 fs::remove_file(path).expect("remove scratch file");
7340 }
7341
7342 #[test]
7343 fn damaged_membership_cannot_skip_a_string_page() {
7344 let path = path("damaged-membership");
7345 let mut writer = Writer::create(
7346 &path,
7347 "items",
7348 vec![
7349 Field::required("id", LogicalType::Integer),
7350 Field::new("text", LogicalType::Varchar),
7351 ],
7352 )
7353 .expect("new file");
7354 writer.append(&sample()).expect("stripe written");
7355 writer.finish().expect("commit");
7356
7357 let reader = Reader::open(&path).expect("valid directory");
7358 let membership = reader.table.stripes[0].memberships[1].expect("string membership");
7359 let mut file = OpenOptions::new().write(true).open(&path).expect("open membership page");
7360 file.seek(SeekFrom::Start(membership.offset)).expect("membership start");
7361 file.write_all(&[255]).expect("damage membership");
7362 let error = reader.skips_codes(0, 1, &[3]).expect_err("corruption must not skip rows");
7363 assert!(error.message().contains("membership page checksum differs"), "{error}");
7364 fs::remove_file(path).expect("remove scratch file");
7365 }
7366
7367 #[test]
7368 fn membership_delta_stream_is_sorted_exact_and_bounded() {
7369 let unique = unique_codes(&[900, 4, 4, 72, 9, u32::MAX]);
7370 assert_eq!(unique, [4, 9, 72, 900, u32::MAX]);
7371 let encoded = encode_membership(&unique);
7372 assert_eq!(
7373 decode_membership(&encoded).expect("valid membership"),
7374 [4, 9, 72, 900, u32::MAX]
7375 );
7376 let merged = merged_codes(vec![vec![4, 900], vec![9, 900, u32::MAX], vec![72]]);
7379 assert_eq!(merged, [4, 9, 72, 900, u32::MAX]);
7380 assert_eq!(
7381 decode_membership(&encode_membership(&merged)).expect("valid membership"),
7382 unique
7383 );
7384 assert!(decode_membership(&[1, 0x80]).is_err(), "a truncated varint is invalid");
7385 assert!(
7386 decode_membership(&[1, 0xff, 0xff, 0xff, 0xff, 0x10]).is_err(),
7387 "a value past u32 is invalid"
7388 );
7389 }
7390
7391 #[test]
7392 fn a_global_dictionary_may_be_larger_than_one_column_page() {
7393 let dictionary = Page {
7394 offset: HEADER,
7395 length: u32::try_from(MAX_PAGE + 1).expect("the page bound fits on disk"),
7396 hash: 0,
7397 };
7398 let table = Table {
7399 name: "items".to_owned(),
7400 fields: vec![Field::new("text", LogicalType::Varchar)],
7401 stripes: Vec::new(),
7402 rows: 0,
7403 dictionaries: vec![Some(dictionary)],
7404 distincts: vec![None],
7405 frequencies: vec![None],
7406 };
7407 let directory = encode_directory(&table).expect("directory");
7408 let file_size = dictionary.offset + u64::from(dictionary.length) + 1;
7409
7410 let decoded = decode_directory(&directory, file_size).expect("large lazy dictionary");
7411 assert_eq!(decoded.dictionaries[0].expect("dictionary").length, dictionary.length);
7412 }
7413
7414 #[test]
7415 fn a_column_with_one_value_everywhere_costs_almost_nothing_a_row() {
7416 let path = path("constant-codes");
7417 let mut writer =
7418 Writer::create(&path, "items", vec![Field::new("text", LogicalType::Varchar)])
7419 .expect("new file");
7420 let empty = vec![Value::Varchar(String::new()); 1024];
7421 for _ in 0..4 {
7422 let column = Vector::from_values(LogicalType::Varchar, &empty).expect("strings");
7423 writer.append(&Chunk::new(vec![column]).expect("one column")).expect("a part");
7424 }
7425 writer.finish().expect("commit");
7426
7427 let reader = Reader::open(&path).expect("valid directory");
7428 let pages = reader.layout().columns.first().expect("one column").pages;
7429 assert!(pages < 256, "{pages} bytes of pages for 4,096 rows of one value");
7433 let read = reader.read(3, &[0]).expect("the last part back");
7434 assert_eq!(read.value_at(0, 0), Value::Varchar(String::new()));
7435 assert_eq!(read.value_at(1023, 0), Value::Varchar(String::new()));
7436 fs::remove_file(path).expect("remove scratch file");
7437 }
7438
7439 #[test]
7440 fn a_cascade_value_too_wide_for_its_column_is_refused_rather_than_cut() {
7441 let over = vec![i64::from(i32::MAX) + 1];
7444 let error = narrowed(&LogicalType::Integer, over).expect_err("a page that disagrees");
7445 assert!(format!("{error}").contains("not of its type"), "{error}");
7446 assert!(narrowed(&LogicalType::BigInt, vec![i64::MIN]).is_ok(), "bigint holds all of i64");
7447 assert!(narrowed(&LogicalType::Varchar, vec![0]).is_err(), "strings are not integers");
7448 }
7449
7450 #[test]
7451 fn a_code_stream_the_cascade_cannot_shrink_is_left_alone() {
7452 let mut state: u32 = 0x9e37_79b9;
7456 let spread: Vec<u32> = (0..1024)
7457 .map(|_| {
7458 state ^= state << 13;
7459 state ^= state >> 17;
7460 state ^= state << 5;
7461 state
7462 })
7463 .collect();
7464 assert_eq!(encoded_codes(&spread).expect("no failure"), None);
7465 let near: Vec<u32> = (0..1024).collect();
7466 let coded = encoded_codes(&near).expect("no failure").expect("counting up is packable");
7467 assert!(coded.len() < near.len() * 4, "{} bytes for a run of 1,024", coded.len());
7468 }
7469
7470 #[test]
7476 fn two_writes_of_the_same_rows_give_the_same_bytes() {
7477 fn written(path: &PathBuf) {
7478 let fields = (0..40)
7479 .map(|column| {
7480 let ty =
7481 if column % 4 == 0 { LogicalType::Varchar } else { LogicalType::BigInt };
7482 Field::new(format!("c{column}"), ty)
7483 })
7484 .collect::<Vec<_>>();
7485 let mut writer = Writer::create(path, "wide", fields).expect("new file");
7486 for part in 0..70_u64 {
7487 let columns = (0..40)
7488 .map(|column| {
7489 let values = (0..64_u64)
7490 .map(|row| {
7491 let seed = part.wrapping_mul(31).wrapping_add(row);
7492 if column % 4 == 0 {
7493 Value::Varchar(format!("v{}", seed % 17))
7494 } else {
7495 Value::BigInt(i64::try_from(seed % 97).expect("small"))
7496 }
7497 })
7498 .collect::<Vec<_>>();
7499 let ty = if column % 4 == 0 {
7500 LogicalType::Varchar
7501 } else {
7502 LogicalType::BigInt
7503 };
7504 Vector::from_values(ty, &values).expect("a column")
7505 })
7506 .collect::<Vec<_>>();
7507 writer.append(&Chunk::new(columns).expect("forty columns")).expect("a part");
7508 }
7509 writer.finish().expect("commit");
7510 }
7511
7512 let first = path("repeatable-one");
7513 let second = path("repeatable-two");
7514 written(&first);
7515 written(&second);
7516 let left = fs::read(&first).expect("the first file");
7517 let right = fs::read(&second).expect("the second file");
7518 assert_eq!(left.len(), right.len(), "two writes of the same rows differ in length");
7519 assert!(left == right, "two writes of the same rows differ in their bytes");
7520
7521 let reader = Reader::open(&first).expect("valid directory");
7524 assert_eq!(reader.table().rows(), 70 * 64);
7525 let read = reader.read(0, &[0, 1]).expect("the first part back");
7526 assert_eq!(read.value_at(0, 0), Value::Varchar("v0".to_owned()));
7527 assert_eq!(read.value_at(0, 1), Value::BigInt(0));
7528 fs::remove_file(first).expect("remove scratch file");
7529 fs::remove_file(second).expect("remove scratch file");
7530 }
7531
7532 fn three_tables(path: &PathBuf) {
7534 let writer = Writer::create(
7535 path,
7536 "region",
7537 vec![
7538 Field::new("r_key", LogicalType::Integer),
7539 Field::new("r_name", LogicalType::Varchar),
7540 ],
7541 )
7542 .expect("new file");
7543 let mut writer = writer;
7544 writer
7545 .append(
7546 &Chunk::new(vec![
7547 Vector::from_values(
7548 LogicalType::Integer,
7549 &[Value::Integer(0), Value::Integer(1)],
7550 )
7551 .expect("keys"),
7552 Vector::from_values(
7553 LogicalType::Varchar,
7554 &[Value::Varchar("AFRICA".to_owned()), Value::Varchar("ASIA".to_owned())],
7555 )
7556 .expect("names"),
7557 ])
7558 .expect("two columns"),
7559 )
7560 .expect("a part");
7561 let mut writer = writer
7562 .next("empty", vec![Field::new("nothing", LogicalType::BigInt)])
7563 .expect("a second table");
7564 writer
7565 .append(
7566 &Chunk::new(vec![
7567 Vector::from_values(LogicalType::BigInt, &[Value::BigInt(7)]).expect("a row"),
7568 ])
7569 .expect("one column"),
7570 )
7571 .expect("a part");
7572 let mut writer =
7573 writer.next("wide", vec![Field::new("n", LogicalType::BigInt)]).expect("a third table");
7574 for part in 0..70_i64 {
7575 let values = (0..64).map(|row| Value::BigInt(part * 64 + row)).collect::<Vec<_>>();
7576 writer
7577 .append(
7578 &Chunk::new(vec![
7579 Vector::from_values(LogicalType::BigInt, &values).expect("a column"),
7580 ])
7581 .expect("one column"),
7582 )
7583 .expect("a part");
7584 }
7585 writer.finish().expect("commit");
7586 }
7587
7588 #[test]
7589 fn three_tables_in_one_file_read_back_by_name() {
7590 let file = path("three-tables");
7591 three_tables(&file);
7592 let catalog = Catalog::open(&file).expect("a committed catalog");
7593 assert_eq!(catalog.names().collect::<Vec<_>>(), ["region", "empty", "wide"]);
7594
7595 let region = catalog.table("region").expect("the first table");
7596 assert_eq!(region.table().rows(), 2);
7597 assert_eq!(
7598 region.read(0, &[1]).expect("names").value_at(1, 0),
7599 Value::Varchar("ASIA".to_owned())
7600 );
7601
7602 let wide = catalog.table("wide").expect("the third table");
7603 assert_eq!(wide.table().rows(), 70 * 64);
7604 assert_eq!(wide.read(0, &[0]).expect("the first part").value_at(0, 0), Value::BigInt(0));
7605
7606 let empty = catalog.table("empty").expect("the second table");
7609 assert_eq!(empty.table().rows(), 1);
7610 assert_eq!(empty.read(0, &[0]).expect("the row").value_at(0, 0), Value::BigInt(7));
7611
7612 fs::remove_file(file).expect("remove scratch file");
7613 }
7614
7615 #[test]
7616 fn a_name_the_file_does_not_hold_is_an_error_rather_than_the_first_table() {
7617 let file = path("three-tables-missing");
7618 three_tables(&file);
7619 let catalog = Catalog::open(&file).expect("a committed catalog");
7620 let error = catalog.table("nation").expect_err("no such table");
7621 assert!(error.message().contains("nation"), "{}", error.message());
7622 fs::remove_file(file).expect("remove scratch file");
7623 }
7624
7625 #[test]
7626 fn a_file_of_three_tables_will_not_open_as_one() {
7627 let file = path("three-tables-unnamed");
7628 three_tables(&file);
7629 let error = Reader::open(&file).expect_err("more than one table");
7630 assert!(error.message().contains("more than one table"), "{}", error.message());
7631 fs::remove_file(file).expect("remove scratch file");
7632 }
7633
7634 #[test]
7636 fn decimals_of_every_storage_width_round_trip() {
7637 let file = path("decimals");
7638 let widths = [(4_u8, 2_u8), (9, 2), (18, 4), (38, 6)];
7639 let fields = widths
7640 .iter()
7641 .enumerate()
7642 .map(|(index, (width, scale))| {
7643 Field::new(
7644 format!("d{index}"),
7645 LogicalType::decimal(*width, *scale).expect("a decimal type"),
7646 )
7647 })
7648 .collect::<Vec<_>>();
7649 let mut writer = Writer::create(&file, "money", fields).expect("new file");
7650 let rows: [i128; 3] = [-1234, 0, 999];
7651 let columns = widths
7652 .iter()
7653 .map(|(width, scale)| {
7654 let values = rows
7655 .iter()
7656 .map(|unscaled| Value::Decimal {
7657 unscaled: *unscaled,
7658 width: *width,
7659 scale: *scale,
7660 })
7661 .collect::<Vec<_>>();
7662 Vector::from_values(
7663 LogicalType::decimal(*width, *scale).expect("a decimal type"),
7664 &values,
7665 )
7666 .expect("a decimal column")
7667 })
7668 .collect::<Vec<_>>();
7669 writer.append(&Chunk::new(columns).expect("four columns")).expect("a part");
7670 writer.finish().expect("commit");
7671
7672 let reader = Reader::open(&file).expect("a committed file");
7673 for (index, (width, scale)) in widths.iter().enumerate() {
7674 assert_eq!(
7675 reader.table().fields()[index].ty,
7676 LogicalType::decimal(*width, *scale).expect("a decimal type"),
7677 "column {index} came back as another type"
7678 );
7679 let column = reader.read(0, &[index]).expect("the column");
7680 for (row, unscaled) in rows.iter().enumerate() {
7681 assert_eq!(
7682 column.value_at(row, 0),
7683 Value::Decimal { unscaled: *unscaled, width: *width, scale: *scale },
7684 "column {index} row {row}"
7685 );
7686 }
7687 }
7688 fs::remove_file(file).expect("remove scratch file");
7689 }
7690
7691 #[test]
7692 fn two_tables_of_one_name_are_refused_before_anything_is_committed() {
7693 let file = path("two-of-a-name");
7694 let writer = Writer::create(&file, "t", vec![Field::new("a", LogicalType::BigInt)])
7695 .expect("new file");
7696 let error = writer
7697 .next("t", vec![Field::new("a", LogicalType::BigInt)])
7698 .expect_err("the same name twice");
7699 assert!(error.message().contains("same name"), "{}", error.message());
7700 fs::remove_file(file).expect("remove scratch file");
7701 }
7702
7703 #[test]
7704 fn opening_the_catalog_reads_no_table_directory() {
7705 let file = path("catalog-only");
7706 three_tables(&file);
7707 let catalog = Catalog::open(&file).expect("a committed catalog");
7708 assert_eq!(catalog.opening.reads, 2, "opening the catalog read more than the slot");
7711 assert_eq!(catalog.names().len(), 3);
7712 fs::remove_file(file).expect("remove scratch file");
7713 }
7714}