ionic/ion/encoder/utilities/
output.rs1#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
2use std::{
3 fs::{self, File, OpenOptions},
4 io::{BufWriter, Read, Seek, SeekFrom},
5 path::{Path, PathBuf},
6 sync::atomic::{AtomicU64, Ordering},
7};
8
9#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
10use cosmoz::StreamWriter;
11
12#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
13use crate::ion::encoder::encode::get_supported_compression_level;
14use crate::ion::{IonError, IonResult};
15
16pub trait WriteBytes {
17 fn write(&mut self, bytes: &[u8]) -> IonResult<()>;
18 fn patch(&mut self, at: u64, bytes: &[u8]) -> IonResult<()>;
19 fn position(&mut self) -> IonResult<u64>;
20}
21
22#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
23pub struct FileWriter {
24 writer: BufWriter<File>,
25}
26
27#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
28impl FileWriter {
29 pub fn open(path: &str) -> IonResult<Self> {
30 Self::open_path(Path::new(path))
31 }
32
33 pub fn open_path(path: &Path) -> IonResult<Self> {
34 let file = File::create(path).map_err(|err| {
35 IonError::from(format!(
36 "cannot create output file '{}': {err}",
37 path.display()
38 ))
39 })?;
40 Ok(Self {
41 writer: BufWriter::with_capacity(8 * 1024 * 1024, file),
42 })
43 }
44
45 pub fn flush(&mut self) -> IonResult<()> {
46 use std::io::Write as StdWrite;
47 self.writer
48 .flush()
49 .map_err(|err| IonError::from(format!("flush error: {err}")))
50 }
51}
52
53#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
54impl WriteBytes for FileWriter {
55 fn write(&mut self, bytes: &[u8]) -> IonResult<()> {
56 std::io::Write::write_all(&mut self.writer, bytes)
57 .map_err(|err| IonError::from(format!("write error: {err}")))
58 }
59
60 fn patch(&mut self, at: u64, bytes: &[u8]) -> IonResult<()> {
61 use std::io::Write as StdWrite;
62 self.writer
63 .flush()
64 .map_err(|err| IonError::from(format!("flush error: {err}")))?;
65 let resume_position = self
66 .writer
67 .stream_position()
68 .map_err(|err| IonError::from(format!("position error: {err}")))?;
69 self.writer
70 .seek(SeekFrom::Start(at))
71 .map_err(|err| IonError::from(format!("seek error: {err}")))?;
72 std::io::Write::write_all(&mut self.writer, bytes)
73 .map_err(|err| IonError::from(format!("patch write error: {err}")))?;
74 self.writer
75 .seek(SeekFrom::Start(resume_position))
76 .map_err(|err| IonError::from(format!("seek-resume error: {err}")))?;
77 Ok(())
78 }
79
80 fn position(&mut self) -> IonResult<u64> {
81 use std::io::Write as StdWrite;
82 self.writer
83 .flush()
84 .map_err(|err| IonError::from(format!("flush error: {err}")))?;
85 self.writer
86 .stream_position()
87 .map_err(|err| IonError::from(format!("position error: {err}")))
88 }
89}
90
91#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
92static NEXT_SECTION_ID: AtomicU64 = AtomicU64::new(0);
93
94#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
95pub(crate) struct SpilledSection {
96 packer: Option<StreamWriter<BufWriter<File>>>,
97 path: PathBuf,
98 len: u64,
99}
100
101#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
102impl Drop for SpilledSection {
103 fn drop(&mut self) {
104 let _ = fs::remove_file(&self.path);
105 }
106}
107
108#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
109pub(crate) struct RawSpill {
110 file: File,
111 path: PathBuf,
112 len: u64,
113}
114
115#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
116impl Drop for RawSpill {
117 fn drop(&mut self) {
118 let _ = fs::remove_file(&self.path);
119 }
120}
121
122#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
123impl RawSpill {
124 pub(crate) fn create() -> IonResult<Self> {
125 let path = std::env::temp_dir().join(format!(
126 ".ionic-blocks.{}.{}",
127 std::process::id(),
128 NEXT_SECTION_ID.fetch_add(1, Ordering::Relaxed)
129 ));
130 let file = OpenOptions::new()
131 .read(true)
132 .write(true)
133 .create_new(true)
134 .open(&path)
135 .map_err(|err| IonError::from(format!("cannot create '{}': {err}", path.display())))?;
136 Ok(Self { file, path, len: 0 })
137 }
138
139 pub(crate) fn append(&mut self, bytes: &[u8]) -> IonResult<u64> {
140 let start = self.len;
141 std::io::Write::write_all(&mut self.file, bytes).map_err(|err| {
142 IonError::from(format!(
143 "cannot stage blocks in '{}': {err}",
144 self.path.display()
145 ))
146 })?;
147 self.len += bytes.len() as u64;
148 Ok(start)
149 }
150
151 pub(crate) fn read_at(&mut self, offset: u64, buffer: &mut [u8]) -> IonResult<()> {
152 self.file.seek(SeekFrom::Start(offset)).map_err(|err| {
153 IonError::from(format!(
154 "cannot seek staged blocks in '{}': {err}",
155 self.path.display()
156 ))
157 })?;
158 self.file.read_exact(buffer).map_err(|err| {
159 IonError::from(format!(
160 "cannot read staged blocks from '{}': {err}",
161 self.path.display()
162 ))
163 })
164 }
165
166 #[cfg(test)]
167 pub(crate) fn path(&self) -> &Path {
168 &self.path
169 }
170}
171
172#[derive(Debug, Clone, Copy, PartialEq, Eq)]
173pub enum SectionStorage {
174 Memory,
175 Disk,
176}
177
178pub(crate) enum SectionChunk {
179 Memory(Vec<u8>),
180 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
181 Spilled(SpilledSection),
182}
183
184impl SectionChunk {
185 pub(crate) fn memory(capacity: usize) -> Self {
186 SectionChunk::Memory(Vec::with_capacity(capacity))
187 }
188
189 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
190 pub(crate) fn spilled(level: u8) -> IonResult<Self> {
191 let path = std::env::temp_dir().join(format!(
192 ".ionic-section.{}.{}",
193 std::process::id(),
194 NEXT_SECTION_ID.fetch_add(1, Ordering::Relaxed)
195 ));
196 let file = OpenOptions::new()
197 .read(true)
198 .write(true)
199 .create_new(true)
200 .open(&path)
201 .map_err(|err| IonError::from(format!("cannot create '{}': {err}", path.display())))?;
202 let packer = StreamWriter::new(
203 BufWriter::with_capacity(1 << 20, file),
204 get_supported_compression_level(level),
205 )
206 .map_err(|err| IonError::from(format!("zstd start error: {err}")))?;
207 Ok(SectionChunk::Spilled(SpilledSection {
208 packer: Some(packer),
209 path,
210 len: 0,
211 }))
212 }
213
214 pub(crate) fn write(&mut self, bytes: &[u8]) -> IonResult<()> {
215 match self {
216 SectionChunk::Memory(buffer) => buffer.extend_from_slice(bytes),
217 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
218 SectionChunk::Spilled(section) => {
219 let packer = section
220 .packer
221 .as_mut()
222 .ok_or_else(|| IonError::from("section is already closed"))?;
223 std::io::Write::write_all(packer, bytes)
224 .map_err(|err| IonError::from(format!("section write error: {err}")))?;
225 section.len += bytes.len() as u64;
226 }
227 }
228 Ok(())
229 }
230
231 pub(crate) fn len(&self) -> u64 {
232 match self {
233 SectionChunk::Memory(buffer) => buffer.len() as u64,
234 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
235 SectionChunk::Spilled(section) => section.len,
236 }
237 }
238
239 pub(crate) fn is_spilled(&self) -> bool {
240 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
241 return matches!(self, SectionChunk::Spilled(_));
242 #[cfg(all(target_arch = "wasm32", not(target_os = "wasi")))]
243 return false;
244 }
245
246 #[cfg(test)]
247 pub(crate) fn as_slice(&self) -> &[u8] {
248 match self {
249 SectionChunk::Memory(buffer) => buffer,
250 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
251 SectionChunk::Spilled(_) => &[],
252 }
253 }
254
255 pub(crate) fn into_vec(self) -> IonResult<Vec<u8>> {
256 match self {
257 SectionChunk::Memory(buffer) => Ok(buffer),
258 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
259 SectionChunk::Spilled(_) => Err(IonError::from(
260 "a spilled section cannot be read into memory",
261 )),
262 }
263 }
264
265 #[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
266 pub(crate) fn copy_into(self, output: &mut dyn WriteBytes) -> IonResult<(u64, u64, u32)> {
267 let SectionChunk::Spilled(mut section) = self else {
268 return Err(IonError::from("copy_into needs a spilled section"));
269 };
270 if section.len == 0 {
271 let start = pad_to_alignment(output)?;
272 return Ok((start, 0, crc32fast::hash(&[])));
273 }
274 let mut file = section
275 .packer
276 .take()
277 .ok_or_else(|| IonError::from("section is already closed"))?
278 .finish()
279 .map_err(|err| IonError::from(format!("zstd finish error: {err}")))?
280 .into_inner()
281 .map_err(|err| IonError::from(format!("section flush error: {err}")))?;
282 file.seek(SeekFrom::Start(0))
283 .map_err(|err| IonError::from(format!("section seek error: {err}")))?;
284
285 let start = pad_to_alignment(output)?;
286 let mut hasher = crc32fast::Hasher::new();
287 let mut stored = 0u64;
288 let mut buffer = vec![0u8; 1 << 20];
289 loop {
290 let filled = file
291 .read(&mut buffer)
292 .map_err(|err| IonError::from(format!("section read error: {err}")))?;
293 if filled == 0 {
294 break;
295 }
296 hasher.update(&buffer[..filled]);
297 output.write(&buffer[..filled])?;
298 stored += filled as u64;
299 }
300 Ok((start, stored, hasher.finalize()))
301 }
302}
303
304#[cfg(not(all(target_arch = "wasm32", not(target_os = "wasi"))))]
305fn pad_to_alignment(output: &mut dyn WriteBytes) -> IonResult<u64> {
306 static PAD: [u8; 7] = [0u8; 7];
307 let position = output.position()?;
308 let aligned = (position + 7) & !7;
309 if aligned > position {
310 output.write(&PAD[..(aligned - position) as usize])?;
311 }
312 Ok(aligned)
313}
314
315#[cfg(all(test, not(all(target_arch = "wasm32", not(target_os = "wasi")))))]
316mod tests {
317 use cosmoz::{DecodeWorkspace, decompress};
318
319 use super::*;
320
321 fn row(seed: u64) -> [u8; 64] {
322 let mut record = [0u8; 64];
323 for (slot, part) in record.chunks_mut(8).enumerate() {
324 part.copy_from_slice(&(seed + slot as u64).to_le_bytes());
325 }
326 record
327 }
328
329 #[test]
330 fn raw_spill_roundtrips_appended_blocks() {
331 let mut spill = RawSpill::create().unwrap();
332 let staged_path = spill.path().to_path_buf();
333 assert!(staged_path.exists());
334
335 let blocks: Vec<Vec<u8>> = (0..8u8)
336 .map(|seed| vec![seed; 100 + seed as usize * 37])
337 .collect();
338 let mut offsets = Vec::new();
339 for block in &blocks {
340 offsets.push(spill.append(block).unwrap());
341 }
342
343 let mut running = 0u64;
344 for (block, offset) in blocks.iter().zip(&offsets) {
345 assert_eq!(*offset, running);
346 running += block.len() as u64;
347 }
348
349 for (block, offset) in blocks.iter().zip(&offsets).rev() {
350 let mut read_back = vec![0u8; block.len()];
351 spill.read_at(*offset, &mut read_back).unwrap();
352 assert_eq!(&read_back, block);
353 }
354
355 drop(spill);
356 assert!(
357 !staged_path.exists(),
358 "the temp file must be deleted on drop"
359 );
360 }
361
362 #[test]
363 fn a_memory_section_never_touches_disk() {
364 let mut chunk = SectionChunk::memory(0);
365 chunk.write(&row(1)).unwrap();
366 assert!(!chunk.is_spilled());
367 assert_eq!(chunk.len(), 64);
368 }
369
370 #[test]
371 fn a_disk_section_keeps_every_byte() {
372 let mut chunk = SectionChunk::spilled(3).unwrap();
373 let rows = 64 * 1024;
374 let mut written = Vec::with_capacity(rows * 64);
375 for seed in 0..rows as u64 {
376 let record = row(seed);
377 chunk.write(&record).unwrap();
378 written.extend_from_slice(&record);
379 }
380
381 assert!(chunk.is_spilled());
382 assert_eq!(chunk.len(), written.len() as u64);
383
384 let mut output: Vec<u8> = Vec::new();
385 let (offset, stored, crc32) = chunk.copy_into(&mut output).unwrap();
386 assert_eq!(offset, 0);
387 assert_eq!(stored, output.len() as u64);
388 assert!(stored < written.len() as u64);
389 assert_eq!(crc32, crc32fast::hash(&output));
390
391 let mut restored = vec![0u8; written.len()];
392 let mut workspace = DecodeWorkspace::new_boxed();
393 let restored_length = decompress(&output, &mut restored, &mut workspace).unwrap();
394 assert_eq!(restored_length, written.len());
395 assert_eq!(restored, written);
396 }
397
398 #[test]
399 fn two_sections_never_share_a_file() {
400 let first = SectionChunk::spilled(3).unwrap();
401 let second = SectionChunk::spilled(3).unwrap();
402 let (SectionChunk::Spilled(first), SectionChunk::Spilled(second)) = (first, second) else {
403 panic!("both must be spilled");
404 };
405 assert_ne!(first.path, second.path);
406 }
407}
408
409impl WriteBytes for Vec<u8> {
410 fn write(&mut self, bytes: &[u8]) -> IonResult<()> {
411 self.extend_from_slice(bytes);
412 Ok(())
413 }
414
415 fn patch(&mut self, at: u64, bytes: &[u8]) -> IonResult<()> {
416 let start = at as usize;
417 let end = start + bytes.len();
418 self.get_mut(start..end)
419 .ok_or_else(|| IonError::from(format!("patch: range {start}..{end} out of bounds")))?
420 .copy_from_slice(bytes);
421 Ok(())
422 }
423
424 fn position(&mut self) -> IonResult<u64> {
425 Ok(self.len() as u64)
426 }
427}