fastmash 0.7.0

Fast command-line statistics on text data, compatible with GNU datamash
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
//! Overlap native sorted emission with calculation through reusable buffers.
//! Only selected fields need text again. A `_` in each unselected field
//! preserves selector positions, field-count diagnostics and where a blank
//! field's number would stop. Numeric crossings use the
//! serial collector instead, since their original neighbours must be retained.
#![forbid(unsafe_code)]
use super::command_output::CommandOutput;
use super::grouping::GroupRecord;
use super::operation_set::Fields;
use super::{
    Failure, Intake, Selector, failure, grouping, intake, numerics, operation_set, records, spill,
    unsupported,
};
use std::io::{self, Write};
use std::sync::{Condvar, Mutex};

const BUFFER: usize = 16 << 10;
pub(super) const MEMORY: usize = 192 << 10;

#[derive(Clone, Copy)]
struct Entry {
    end: usize,
    numbers: [Option<numerics::Value>; 2],
    complete: bool,
}
// Small selected Records fill metadata before text. Split the unchanged
// allowance between two byte buffers and two metadata arrays.
// This bounds a batch, not the number or size of Records in the Command.
const ENTRIES: usize = (MEMORY / 2 - BUFFER) / std::mem::size_of::<Entry>();
#[derive(Default)]
struct Batch {
    bytes: Vec<u8>,
    entries: Vec<Entry>,
}
impl Batch {
    fn new() -> Option<Self> {
        let mut batch = Self::default();
        batch.bytes.try_reserve_exact(BUFFER).ok()?;
        batch.entries.try_reserve_exact(ENTRIES).ok()?;
        Some(batch)
    }
}
// Two checked batches circulate between the threads. Numbers retain their
// admitted type, and Record boundaries need no second delimiter scan.
// Long Records span batches without growing the transfer buffers.
struct Transfer {
    ready: Option<Batch>,
    free: [Option<Batch>; 2],
    reader_closed: bool,
    writer_closed: bool,
}
struct Handoff {
    state: Mutex<Transfer>,
    changed: Condvar,
}
impl Handoff {
    // Linux's Mutex and Condvar keep their futex state inline. Constructing
    // this owner needs no allocation after the checked batch reservations.
    const fn new(second: Batch) -> Self {
        Self {
            state: Mutex::new(Transfer {
                ready: None,
                free: [Some(second), None],
                reader_closed: false,
                writer_closed: false,
            }),
            changed: Condvar::new(),
        }
    }
    fn pair(&self, first: Batch) -> (Reader<'_>, Writer<'_>) {
        (
            Reader {
                handoff: self,
                buffer: Batch::default(),
                at: 0,
                byte_at: 0,
            },
            Writer {
                handoff: self,
                buffer: first,
                numbers: [None; 2],
            },
        )
    }
}
struct Reader<'a> {
    handoff: &'a Handoff,
    buffer: Batch,
    at: usize,
    byte_at: usize,
}
struct Writer<'a> {
    handoff: &'a Handoff,
    buffer: Batch,
    numbers: [Option<numerics::Value>; 2],
}
fn disconnected() -> io::Error {
    io::Error::from(io::ErrorKind::BrokenPipe)
}
fn buffers() -> Option<(Batch, Handoff)> {
    let first = Batch::new()?;
    let second = Batch::new()?;
    Some((first, Handoff::new(second)))
}
impl Reader<'_> {
    #[cold]
    #[inline(never)]
    fn refill(&mut self) {
        let mut state = self.handoff.state.lock().unwrap_or_else(|e| e.into_inner());
        if self.buffer.bytes.capacity() != 0 {
            // Both batches can be returned before a woken writer runs.
            let free = state
                .free
                .iter_mut()
                .find(|slot| slot.is_none())
                .expect("two batches have at most two free owners");
            *free = Some(std::mem::take(&mut self.buffer));
        }
        while state.ready.is_none() && !state.writer_closed {
            // A waiting writer may need the returned storage to publish.
            self.handoff.changed.notify_one();
            state = self
                .handoff
                .changed
                .wait(state)
                .unwrap_or_else(|e| e.into_inner());
        }
        self.buffer = state.ready.take().unwrap_or_default();
        self.handoff.changed.notify_one();
        self.at = 0;
        self.byte_at = 0;
    }
    fn record(
        &mut self,
        bytes: &mut Vec<u8>,
    ) -> Result<Option<[Option<numerics::Value>; 2]>, Failure> {
        bytes.clear();
        let mut partial = false;
        loop {
            if self.at == self.buffer.entries.len() {
                self.refill();
                if self.buffer.entries.is_empty() {
                    return if partial {
                        Err(pipe_error(io::Error::from(io::ErrorKind::UnexpectedEof)))
                    } else {
                        Ok(None)
                    };
                }
            }
            let entry = self.buffer.entries[self.at];
            let part = &self.buffer.bytes[self.byte_at..entry.end];
            bytes
                .try_reserve(part.len())
                .map_err(|_| unsupported("record memory allocation failed"))?;
            bytes.extend_from_slice(part);
            self.at += 1;
            self.byte_at = entry.end;
            if entry.complete {
                return Ok(Some(entry.numbers));
            }
            partial = true;
        }
    }
}
impl Drop for Reader<'_> {
    fn drop(&mut self) {
        self.handoff
            .state
            .lock()
            .unwrap_or_else(|e| e.into_inner())
            .reader_closed = true;
        self.handoff.changed.notify_one();
    }
}
impl Drop for Writer<'_> {
    fn drop(&mut self) {
        self.handoff
            .state
            .lock()
            .unwrap_or_else(|e| e.into_inner())
            .writer_closed = true;
        self.handoff.changed.notify_one();
    }
}
impl Writer<'_> {
    fn begin(&mut self, numbers: [Option<numerics::Value>; 2]) -> io::Result<()> {
        if self.buffer.entries.len() == ENTRIES || self.buffer.bytes.len() == BUFFER {
            self.flush()?;
        }
        self.numbers = numbers;
        Ok(())
    }
    fn end(&mut self, complete: bool) {
        self.buffer.entries.push(Entry {
            end: self.buffer.bytes.len(),
            numbers: self.numbers,
            complete,
        });
    }
    #[cold]
    #[inline(never)]
    fn write_all_cold(&mut self, mut bytes: &[u8]) -> io::Result<()> {
        while !bytes.is_empty() {
            let count = bytes.len().min(BUFFER - self.buffer.bytes.len());
            self.buffer.bytes.extend_from_slice(&bytes[..count]);
            bytes = &bytes[count..];
            if !bytes.is_empty() {
                self.end(false);
                self.flush()?;
            }
        }
        Ok(())
    }
    #[inline]
    fn write_all(&mut self, bytes: &[u8]) -> io::Result<()> {
        if bytes.len()
            <= self
                .buffer
                .bytes
                .capacity()
                .min(BUFFER)
                .wrapping_sub(self.buffer.bytes.len())
        {
            self.buffer.bytes.extend_from_slice(bytes);
            Ok(())
        } else {
            self.write_all_cold(bytes)
        }
    }
    fn flush(&mut self) -> io::Result<()> {
        if !self.buffer.entries.is_empty() {
            let mut state = self.handoff.state.lock().unwrap_or_else(|e| e.into_inner());
            while state.ready.is_some() && !state.reader_closed {
                state = self
                    .handoff
                    .changed
                    .wait(state)
                    .unwrap_or_else(|e| e.into_inner());
            }
            if state.reader_closed {
                return Err(disconnected());
            }
            state.ready = Some(std::mem::take(&mut self.buffer));
            self.handoff.changed.notify_one();
            loop {
                if state.reader_closed {
                    return Err(disconnected());
                }
                if let Some(batch) = state.free.iter_mut().find_map(Option::take) {
                    self.buffer = batch;
                    self.buffer.bytes.clear();
                    self.buffer.entries.clear();
                    break;
                }
                state = self
                    .handoff
                    .changed
                    .wait(state)
                    .unwrap_or_else(|e| e.into_inner());
            }
        }
        Ok(())
    }
}

// At most two numeric fields can be parsed on the merge worker. Other
// fields and all failed conversions still use the ordinary collector.
struct Prepared {
    raw: grouping::Raw,
    numbers: [(u64, Option<numerics::Value>); 2],
}
impl Prepared {
    fn new(keys: usize, index: records::FieldIndex, fields: [u64; 2]) -> Result<Self, Failure> {
        Ok(Self {
            raw: grouping::Raw::for_keys(keys, index)?,
            numbers: fields.map(|field| (field, None)),
        })
    }
}
struct Cached<'r, 'i> {
    whole: operation_set::Whole<'r, 'i>,
    numbers: &'i [(u64, Option<numerics::Value>); 2],
}
impl<'r> Fields<'r> for Cached<'r, '_> {
    fn text(
        &mut self,
        field: u64,
        line: u64,
        options: &super::options::Options,
    ) -> Result<&'r [u8], Failure> {
        self.whole.text(field, line, options)
    }
    fn number(
        &mut self,
        field: u64,
        line: u64,
        options: &super::options::Options,
    ) -> Result<Option<numerics::Value>, Failure> {
        if let Some(value) = self
            .numbers
            .iter()
            .find(|(number, _)| *number == field)
            .and_then(|(_, value)| *value)
        {
            return Ok(Some(value));
        }
        self.whole.number(field, line, options)
    }
}
impl GroupRecord for Prepared {
    fn field(
        &mut self,
        field: u64,
        line: u64,
        options: &super::options::Options,
    ) -> Result<&[u8], Failure> {
        self.raw.field(field, line, options)
    }
    fn field_pair(
        &mut self,
        a: u64,
        b: u64,
        line: u64,
        options: &super::options::Options,
    ) -> Result<(&[u8], &[u8]), Failure> {
        self.raw.field_pair(a, b, line, options)
    }
    fn same_group(
        &mut self,
        previous: &mut Self,
        keys: &[u64],
        line: u64,
        options: &super::options::Options,
    ) -> Result<bool, Failure> {
        self.raw.same_group(&mut previous.raw, keys, line, options)
    }
    fn original(&self) -> Option<&[u8]> {
        self.raw.original()
    }
    fn collect(
        &mut self,
        operations: &mut super::OperationSet,
        line: u64,
        options: &super::options::Options,
        arithmetic: &mut numerics::Numerics,
        random: Option<&mut super::random::RandomState>,
    ) -> Result<bool, Failure> {
        operations.collect_fields(
            &mut Cached {
                whole: self.raw.whole(),
                numbers: &self.numbers,
            },
            false,
            line,
            options,
            arithmetic,
            random,
        )
    }
}

fn pipe_error(error: impl std::fmt::Display) -> Failure {
    failure(format!("native sort pipe I/O error: {error}\n").into_bytes())
}

/// Two circulating batches fit within the otherwise unused final-merge
/// writer allowance, including for an in-memory sort. Accumulation, random
/// draws and output stay on the caller.
/// `None` leaves sort emission and calculation untouched for the serial route.
#[cfg_attr(feature = "hotpath", hotpath::measure)]
pub(super) fn calculate<S: spill::Codec, O: CommandOutput>(
    sorted: &mut spill::Finished<S>,
    layout: super::FieldLayout<'_>,
    context: &mut grouping::Context<'_, O>,
) -> Result<Option<()>, Failure> {
    let (options, keys) = (context.options, context.keys);
    // In-memory emission leaves time for both conversions. A Spill merge
    // already does more work: leave one conversion on the caller for a lone
    // paired Operation, caching its later field for a shorter caller scan.
    let width = if sorted.in_memory() {
        2
    } else {
        context
            .operations
            .requests()
            .filter(|(kind, selector)| {
                kind.converts_numeric_field() || matches!(selector, Selector::Pair { .. })
            })
            .take(2)
            .count()
            .max(1)
    };
    let mut fields = [0; 2];
    let mut count = 0;
    'fields: for (kind, selector) in context.operations.requests() {
        if !kind.converts_numeric_field() && !matches!(selector, Selector::Pair { .. }) {
            continue;
        }
        let selected = match selector {
            Selector::Single(field) => [Some(field), None],
            Selector::Pair { left, right } if width == 1 => [Some(left.max(right)), None],
            Selector::Pair { left, right } => [Some(left), Some(right)],
        };
        for field in selected.into_iter().flatten() {
            if !fields[..count].contains(&field) {
                fields[count] = field;
                count += 1;
                if count == width {
                    break 'fields;
                }
            }
        }
    }
    // Successful cached numbers need no second text copy unless a key or a
    // text Operation also reads that Field. Failed/skipped conversions keep
    // their original bytes for the ordinary collector and its diagnostics.
    let omit_text = fields.map(|field| {
        !keys.contains(&field)
            && !context.operations.requests().any(|(kind, selector)| {
                matches!(selector, Selector::Single(number) if number == field)
                    && !kind.converts_numeric_field()
            })
    });
    let Some((first, handoff)) = buffers() else {
        return Ok(None);
    };
    let (mut reader, mut writer) = handoff.pair(first);
    let index = records::FieldIndex::selecting(layout.selected.iter().copied());
    let mut spare = Prepared::new(keys.len(), index.fresh(), fields)?;
    std::thread::scope(|scope| {
        let merge = std::thread::Builder::new()
            .name("sort-merge".into())
            .spawn_scoped(scope, move || {
                let crossings = super::Crossings::default();
                sorted.emit(|record| {
                    let mut whole_index = records::FieldIndex::default();
                    let mut projected = super::Projected {
                        record: &record,
                        layout,
                        crossings: &crossings,
                        separator: Some(b'\t'),
                    };
                    // Cache only successful values, preserving their binary80 bits.
                    // The caller retains conversion errors and their request order.
                    let numbers = fields.map(|field| {
                        (field != 0)
                            .then(|| {
                                if let Some(bytes) = record.original() {
                                    operation_set::Whole {
                                        record: bytes,
                                        index: &mut whole_index,
                                    }
                                    .number(field, 0, options)
                                } else {
                                    projected.number(field, 0, options)
                                }
                                .ok()
                                .flatten()
                            })
                            .flatten()
                    });
                    writer.begin(numbers).map_err(pipe_error)?;
                    if let Some(bytes) = record.original() {
                        writer.write_all(bytes).map_err(pipe_error)?;
                    } else {
                        let mut selected = layout.selected.iter().peekable();
                        for field in 1..=record.fields {
                            if field > 1 {
                                writer.write_all(b"\t").map_err(pipe_error)?;
                            }
                            if selected.peek().is_some_and(|number| **number == field) {
                                selected.next();
                                let cached = fields.iter().enumerate().any(|(at, &number)| {
                                    number == field && omit_text[at] && numbers[at].is_some()
                                });
                                let bytes = if cached {
                                    b"_".as_slice()
                                } else {
                                    record.segment(layout.segment(field, record.key_count()))
                                };
                                writer.write_all(bytes).map_err(pipe_error)?;
                            } else {
                                // A non-blank stand-in keeps the field present
                                // and stops a blank selected field before it
                                // from reading on into a later number.
                                writer.write_all(b"_").map_err(pipe_error)?;
                            }
                        }
                    }
                    writer.end(true);
                    Ok(())
                })?;
                writer.flush().map_err(pipe_error)?;
                Ok(())
            });
        let Ok(merge) = merge else {
            return Ok(None);
        };
        if std::env::var_os("FASTMASH_SORT_TRACE").is_some() {
            let _ = crate::standard_io::Stderr.write_all(b"sort calculation: native merge pipe\n");
        }
        let mut intake = Intake::new(options, intake::Header::None)
            .with_filter(intake::Filter::None)
            .after(u64::from(options.header_in));
        let mut calculation = grouping::Calculation::new(keys, options);
        let mut transport_error = None;
        let result = (|| {
            loop {
                let numbers = match reader.record(spare.raw.bytes_mut()) {
                    Ok(Some(numbers)) => numbers,
                    Ok(None) => break,
                    Err(error) if error.status == 77 => return Err(error),
                    Err(error) => {
                        transport_error = Some(error);
                        break;
                    }
                };
                intake.accept(spare.raw.bytes_mut())?;
                for (slot, value) in spare.numbers.iter_mut().zip(numbers) {
                    slot.1 = value;
                }
                let line = intake.line();
                if line == 1 && options.header_out && !options.header_in {
                    context
                        .output
                        .first(spare.raw.bytes(), context.operations, keys)?;
                }
                calculation.push_in_place(
                    &mut spare,
                    || Prepared::new(keys.len(), index.fresh(), fields),
                    line,
                    context,
                )?;
            }
            let line = intake.line();
            intake.finish().map(|()| line)
        })();
        // A calculation error must unblock and join the merge before returning.
        drop(reader);
        let merged = merge
            .join()
            .map_err(|_| unsupported("native sort merge thread failed"))?;
        let line = result?;
        merged?;
        if let Some(error) = transport_error {
            return Err(error);
        }
        context.random = None;
        calculation.finish(line, context).map(Some)
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn synchronization_is_const_constructible() {
        static EMPTY: Handoff = Handoff::new(Batch {
            bytes: Vec::new(),
            entries: Vec::new(),
        });
        let handoff = &EMPTY;
        let (mut reader, writer) = handoff.pair(Batch::default());
        drop(writer);
        assert!(reader.record(&mut Vec::new()).ok().unwrap().is_none());
    }

    #[test]
    fn recycled_buffers_preserve_long_writes_short_tails_and_eof() {
        let expected: Vec<_> = (0..BUFFER * 3 + 29).map(|at| (at % 251) as u8).collect();
        let (first, handoff) = buffers().unwrap();
        let (mut reader, mut writer) = handoff.pair(first);
        std::thread::scope(|scope| {
            let expected = &expected;
            let producer = scope.spawn(move || {
                writer.begin([None; 2]).unwrap();
                writer.write_all(expected).unwrap();
                writer.end(true);
                for at in 0..ENTRIES * 3 {
                    writer.begin([None; 2]).unwrap();
                    writer.write_all(&[at as u8]).unwrap();
                    writer.end(true);
                }
                writer.begin([None; 2]).unwrap();
                writer.end(true);
                writer.flush().unwrap();
            });
            let mut actual = Vec::new();
            assert!(reader.record(&mut actual).ok().unwrap().is_some());
            assert_eq!(&actual, expected);
            for at in 0..ENTRIES * 3 {
                assert!(reader.record(&mut actual).ok().unwrap().is_some());
                assert_eq!(actual, [at as u8]);
            }
            assert!(reader.record(&mut actual).ok().unwrap().is_some());
            assert!(actual.is_empty());
            assert!(reader.record(&mut actual).ok().unwrap().is_none());
            producer.join().unwrap();
        });
    }

    #[test]
    fn dropping_the_reader_unblocks_a_buffered_writer() {
        let (first, handoff) = buffers().unwrap();
        let (mut reader, mut writer) = handoff.pair(first);
        std::thread::scope(|scope| {
            let producer = scope.spawn(move || {
                writer.begin([None; 2])?;
                writer.write_all(&vec![b'x'; BUFFER * 8])
            });
            reader.refill();
            assert!(!reader.buffer.entries.is_empty());
            drop(reader);
            assert_eq!(
                producer.join().unwrap().unwrap_err().kind(),
                io::ErrorKind::BrokenPipe
            );
        });
    }
    #[test]
    fn cached_numbers_keep_every_binary80_bit() {
        let patterns = [
            0,
            1u128 << 79,
            1,
            (1u128 << 63) - 1,
            (1u128 << 64) | (1u128 << 63),
            0x3fff8000000000000000,
            0x7ffeffffffffffffffff,
            0x7fff8000000000000000,
            0xffff8000000000000000,
            0x7fffc000000000000001,
            0xffffd23456789abcdef0,
        ];
        for mask in 0..4u8 {
            for bits in patterns {
                let expected = crate::numeric_contract::Value80::try_from_bits(bits).unwrap();
                let mut numbers = [None; 2];
                for (at, number) in numbers.iter_mut().enumerate() {
                    if mask & (1 << at) != 0 {
                        *number = Some(numerics::Numerics::admit(expected).unwrap());
                    }
                }
                let (first, handoff) = buffers().unwrap();
                let (mut reader, mut writer) = handoff.pair(first);
                writer.begin(numbers).unwrap();
                writer.end(true);
                writer.flush().unwrap();
                drop(writer);
                let mut bytes = Vec::new();
                let values = reader.record(&mut bytes).ok().unwrap().unwrap();
                for (at, value) in values.into_iter().enumerate() {
                    assert_eq!(value.is_some(), mask & (1 << at) != 0);
                    if let Some(value) = value {
                        assert!(numerics::Numerics::value80(value).same_bits(expected));
                    }
                }
                assert!(reader.record(&mut bytes).ok().unwrap().is_none());
            }
        }
    }
    #[test]
    fn incomplete_record_is_rejected() {
        let (first, handoff) = buffers().unwrap();
        let (mut reader, mut writer) = handoff.pair(first);
        writer.begin([None; 2]).unwrap();
        writer.write_all(&vec![b'x'; BUFFER + 1]).unwrap();
        drop(writer);
        let error = reader.record(&mut Vec::new()).err().unwrap();
        assert_eq!(error.status, 1);
    }
}