rstim 0.4.0

Stim-aligned stabilizer circuit simulator and detector error model toolkit
Documentation
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
use crate::sample_archive::dense::{pack_dense, unpack_dense};
use crate::sample_archive::format::{
    STREAM_CODEC_EMPTY, STREAM_CODEC_SYNDROME_DENSE_V1, STREAM_CODEC_SYNDROME_SPARSE_LEB128_V1,
    SampleArchiveError, SampleArchiveErrorCode, checked_dense_bit_bytes,
};
use crate::sim::bit_table::{BitTable, BitTableAllocError};
use sha2::{Digest, Sha256};
use std::cell::Cell;
use std::sync::atomic::{AtomicUsize, Ordering};

thread_local! {
    static CURRENT_MATERIALIZED_CANDIDATES: Cell<usize> = const { Cell::new(0) };
}
static MAX_MATERIALIZED_CANDIDATES: AtomicUsize = AtomicUsize::new(0);

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub struct SyndromePlan {
    pub codec_id: u16,
    pub raw_len: u64,
    pub dense_len: u64,
    pub sparse_len: u64,
}

pub struct SyndromeEncoding {
    pub codec_id: u16,
    pub raw_len: u64,
    pub raw: Vec<u8>,
    pub dense_len: u64,
    pub sparse_len: u64,
}

pub fn encode_syndrome(table: &BitTable) -> Result<SyndromeEncoding, SampleArchiveError> {
    let plan = plan_syndrome(table)?;
    let raw = materialize_syndrome(table, plan)?;

    Ok(SyndromeEncoding {
        codec_id: plan.codec_id,
        raw_len: plan.raw_len,
        raw,
        dense_len: plan.dense_len,
        sparse_len: plan.sparse_len,
    })
}

pub fn plan_syndrome(table: &BitTable) -> Result<SyndromePlan, SampleArchiveError> {
    let rows = table.num_major() as u64;
    let shots = table.num_minor() as u64;
    if rows == 0 || shots == 0 {
        return Ok(SyndromePlan {
            codec_id: STREAM_CODEC_EMPTY,
            raw_len: 0,
            dense_len: 0,
            sparse_len: 0,
        });
    }

    let dense_len = checked_dense_bit_bytes(rows, shots)?;
    let sparse_len = checked_sparse_len(table)?;
    let (codec_id, raw_len) = if dense_len <= sparse_len {
        (STREAM_CODEC_SYNDROME_DENSE_V1, dense_len)
    } else {
        (STREAM_CODEC_SYNDROME_SPARSE_LEB128_V1, sparse_len)
    };

    Ok(SyndromePlan {
        codec_id,
        raw_len,
        dense_len,
        sparse_len,
    })
}

pub fn materialize_syndrome(
    table: &BitTable,
    plan: SyndromePlan,
) -> Result<Vec<u8>, SampleArchiveError> {
    begin_materialization_window();
    let raw = match plan.codec_id {
        STREAM_CODEC_EMPTY => Vec::new(),
        STREAM_CODEC_SYNDROME_DENSE_V1 => materialize_dense(table)?,
        STREAM_CODEC_SYNDROME_SPARSE_LEB128_V1 => materialize_sparse(table, plan.raw_len)?,
        _ => return Err(malformed("unknown syndrome codec")),
    };
    let raw_len = u64::try_from(raw.len()).map_err(|_| limit("syndrome stream too large"))?;
    if raw_len != plan.raw_len {
        return Err(limit(
            "syndrome stream length changed during materialization",
        ));
    }
    Ok(raw)
}

pub fn decode_syndrome_raw(
    codec_id: u16,
    declared_raw_len: u64,
    raw: &[u8],
    rows: usize,
    shots: usize,
) -> Result<BitTable, SampleArchiveError> {
    validate_declared_raw_len(raw, declared_raw_len)?;
    match codec_id {
        STREAM_CODEC_EMPTY => {
            if declared_raw_len != 0 || !raw.is_empty() {
                return Err(malformed("noncanonical empty syndrome stream"));
            }
            if rows != 0 && shots != 0 {
                return Err(malformed("nonempty syndrome uses empty codec"));
            }
            BitTable::try_new(rows, shots).map_err(map_alloc)
        }
        STREAM_CODEC_SYNDROME_DENSE_V1 => {
            if rows == 0 || shots == 0 {
                return Err(malformed("empty syndrome uses nonempty codec"));
            }
            let expected = checked_dense_bit_bytes(rows as u64, shots as u64)?;
            if declared_raw_len != expected {
                return Err(malformed("dense stream length does not match shape"));
            }
            unpack_dense(raw, rows, shots)
        }
        STREAM_CODEC_SYNDROME_SPARSE_LEB128_V1 => {
            if rows == 0 || shots == 0 {
                return Err(malformed("empty syndrome uses nonempty codec"));
            }
            parse_sparse_syndrome(raw, rows as u64, shots as u64, |_, _| {})?;
            let mut table = BitTable::try_new(rows, shots).map_err(map_alloc)?;
            parse_sparse_syndrome(raw, rows as u64, shots as u64, |shot, detector| {
                table.set(detector as usize, shot as usize, true);
            })?;
            Ok(table)
        }
        _ => Err(malformed("unknown syndrome codec")),
    }
}

pub fn for_each_sparse_syndrome_hit(
    raw: &[u8],
    declared_raw_len: u64,
    rows: u64,
    shots: u64,
    mut on_hit: impl FnMut(u64, u64),
) -> Result<(), SampleArchiveError> {
    validate_declared_raw_len(raw, declared_raw_len)?;
    parse_sparse_syndrome(raw, rows, shots, |_, _| {})?;
    parse_sparse_syndrome(raw, rows, shots, |shot, detector| on_hit(shot, detector))
}

pub fn reset_materialization_telemetry() {
    CURRENT_MATERIALIZED_CANDIDATES.set(0);
    MAX_MATERIALIZED_CANDIDATES.store(0, Ordering::Relaxed);
}

pub fn max_materialized_candidates() -> usize {
    MAX_MATERIALIZED_CANDIDATES.load(Ordering::Relaxed)
}

#[allow(dead_code)] // Consumed by archive integration in the next task.
pub(crate) fn update_dense_syndrome_hash(
    table: &BitTable,
    hasher: &mut Sha256,
) -> Result<(), SampleArchiveError> {
    checked_dense_bit_bytes(table.num_major() as u64, table.num_minor() as u64)?;
    let mut byte = 0u8;
    let mut bit_in_byte = 0u8;
    for shot in 0..table.num_minor() {
        for row in 0..table.num_major() {
            if table.get(row, shot) {
                byte |= 1 << bit_in_byte;
            }
            bit_in_byte += 1;
            if bit_in_byte == 8 {
                hasher.update([byte]);
                byte = 0;
                bit_in_byte = 0;
            }
        }
    }
    if bit_in_byte != 0 {
        hasher.update([byte]);
    }
    Ok(())
}

fn checked_sparse_len(table: &BitTable) -> Result<u64, SampleArchiveError> {
    let mut len = 0u64;
    for shot in 0..table.num_minor() {
        let mut count = 0u64;
        let mut previous = 0u64;
        for row in 0..table.num_major() {
            if table.get(row, shot) {
                let row = row as u64;
                if count == 0 {
                    len = checked_add_uleb_len(len, row)?;
                } else {
                    let delta = row
                        .checked_sub(previous)
                        .and_then(|value| value.checked_sub(1))
                        .ok_or_else(|| limit("sparse detector order overflow"))?;
                    len = checked_add_uleb_len(len, delta)?;
                }
                count = count
                    .checked_add(1)
                    .ok_or_else(|| limit("sparse hit count overflow"))?;
                previous = row;
            }
        }
        len = checked_add_uleb_len(len, count)?;
    }
    Ok(len)
}

fn materialize_dense(table: &BitTable) -> Result<Vec<u8>, SampleArchiveError> {
    let raw = pack_dense(table)?;
    record_materialized_candidate();
    Ok(raw)
}

fn materialize_sparse(table: &BitTable, len: u64) -> Result<Vec<u8>, SampleArchiveError> {
    let len = usize::try_from(len).map_err(|_| limit("sparse stream too large"))?;
    let mut raw = Vec::new();
    raw.try_reserve_exact(len)
        .map_err(|_| limit("sparse stream reservation failed"))?;

    for shot in 0..table.num_minor() {
        let mut count = 0u64;
        for row in 0..table.num_major() {
            if table.get(row, shot) {
                count = count
                    .checked_add(1)
                    .ok_or_else(|| limit("sparse hit count overflow"))?;
            }
        }
        encode_uleb(count, &mut raw);

        let mut previous = 0u64;
        let mut first = true;
        for row in 0..table.num_major() {
            if table.get(row, shot) {
                let row = row as u64;
                let value = if first {
                    first = false;
                    row
                } else {
                    row.checked_sub(previous)
                        .and_then(|value| value.checked_sub(1))
                        .ok_or_else(|| limit("sparse detector order overflow"))?
                };
                encode_uleb(value, &mut raw);
                previous = row;
            }
        }
    }
    debug_assert_eq!(raw.len(), len);
    record_materialized_candidate();
    Ok(raw)
}

fn parse_sparse_syndrome(
    raw: &[u8],
    rows: u64,
    shots: u64,
    mut on_hit: impl FnMut(u64, u64),
) -> Result<(), SampleArchiveError> {
    let mut offset = 0usize;
    for shot in 0..shots {
        let count = decode_uleb(raw, &mut offset)?;
        if count > rows {
            return Err(malformed("sparse hit count exceeds detector count"));
        }

        let mut previous = 0u64;
        for hit in 0..count {
            let delta = decode_uleb(raw, &mut offset)?;
            let detector = if hit == 0 {
                delta
            } else {
                previous
                    .checked_add(delta)
                    .and_then(|value| value.checked_add(1))
                    .ok_or_else(|| malformed("sparse detector delta overflows"))?
            };
            if detector >= rows {
                return Err(malformed("sparse detector index exceeds shape"));
            }
            on_hit(shot, detector);
            previous = detector;
        }
    }
    if offset != raw.len() {
        return Err(malformed("bytes after sparse shot records"));
    }
    Ok(())
}

fn encode_uleb(mut value: u64, raw: &mut Vec<u8>) {
    loop {
        let mut byte = (value & 0x7f) as u8;
        value >>= 7;
        if value != 0 {
            byte |= 0x80;
        }
        raw.push(byte);
        if value == 0 {
            return;
        }
    }
}

fn decode_uleb(raw: &[u8], offset: &mut usize) -> Result<u64, SampleArchiveError> {
    let mut value = 0u64;
    for index in 0..10 {
        let byte = *raw
            .get(*offset)
            .ok_or_else(|| malformed("unterminated ULEB128 value"))?;
        *offset += 1;
        let payload = u64::from(byte & 0x7f);
        if index == 9 && (payload > 1 || byte & 0x80 != 0) {
            return Err(malformed("ULEB128 value overflows u64"));
        }
        value |= payload << (index * 7);
        if byte & 0x80 == 0 {
            if uleb_len(value) != index + 1 {
                return Err(malformed("noncanonical ULEB128 value"));
            }
            return Ok(value);
        }
    }
    Err(malformed("ULEB128 value overflows u64"))
}

fn checked_add_uleb_len(len: u64, value: u64) -> Result<u64, SampleArchiveError> {
    len.checked_add(uleb_len(value) as u64)
        .ok_or_else(|| limit("sparse stream length overflow"))
}

fn uleb_len(mut value: u64) -> usize {
    let mut len = 1;
    while value >= 0x80 {
        value >>= 7;
        len += 1;
    }
    len
}

fn validate_declared_raw_len(raw: &[u8], declared_raw_len: u64) -> Result<(), SampleArchiveError> {
    let actual = u64::try_from(raw.len()).map_err(|_| malformed("raw stream length too large"))?;
    if actual == declared_raw_len {
        Ok(())
    } else {
        Err(malformed("declared raw length does not match stream"))
    }
}

fn begin_materialization_window() {
    CURRENT_MATERIALIZED_CANDIDATES.set(0);
}

fn record_materialized_candidate() {
    let current = CURRENT_MATERIALIZED_CANDIDATES.get() + 1;
    CURRENT_MATERIALIZED_CANDIDATES.set(current);
    let mut observed = MAX_MATERIALIZED_CANDIDATES.load(Ordering::Relaxed);
    while observed < current {
        match MAX_MATERIALIZED_CANDIDATES.compare_exchange_weak(
            observed,
            current,
            Ordering::Relaxed,
            Ordering::Relaxed,
        ) {
            Ok(_) => return,
            Err(current) => observed = current,
        }
    }
}

fn map_alloc(_err: BitTableAllocError) -> SampleArchiveError {
    limit("bit table allocation failed")
}

fn malformed(detail: &'static str) -> SampleArchiveError {
    SampleArchiveError::with_code(SampleArchiveErrorCode::MalformedArchive, detail)
}

fn limit(detail: &'static str) -> SampleArchiveError {
    SampleArchiveError::with_code(SampleArchiveErrorCode::LimitExceeded, detail)
}

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

    fn assert_code<T: std::fmt::Debug>(
        result: Result<T, SampleArchiveError>,
        code: SampleArchiveErrorCode,
    ) {
        assert_eq!(result.unwrap_err().code(), code);
    }

    #[test]
    fn codec_edge_cases_cover_rejected_shapes_and_valid_sparse_replay() {
        let empty = BitTable::new(0, 0);

        assert_code(
            materialize_syndrome(
                &empty,
                SyndromePlan {
                    codec_id: 999,
                    raw_len: 0,
                    dense_len: 0,
                    sparse_len: 0,
                },
            ),
            SampleArchiveErrorCode::MalformedArchive,
        );
        assert_code(
            materialize_syndrome(
                &empty,
                SyndromePlan {
                    codec_id: STREAM_CODEC_EMPTY,
                    raw_len: 1,
                    dense_len: 0,
                    sparse_len: 0,
                },
            ),
            SampleArchiveErrorCode::LimitExceeded,
        );
        assert_code(
            decode_syndrome_raw(STREAM_CODEC_EMPTY, 0, &[], 1, 1),
            SampleArchiveErrorCode::MalformedArchive,
        );
        assert_code(
            decode_syndrome_raw(STREAM_CODEC_SYNDROME_DENSE_V1, 0, &[], 0, 1),
            SampleArchiveErrorCode::MalformedArchive,
        );
        assert_code(
            decode_syndrome_raw(STREAM_CODEC_SYNDROME_DENSE_V1, 2, &[0, 0], 8, 1),
            SampleArchiveErrorCode::MalformedArchive,
        );
        assert_code(
            decode_syndrome_raw(STREAM_CODEC_SYNDROME_SPARSE_LEB128_V1, 0, &[], 0, 1),
            SampleArchiveErrorCode::MalformedArchive,
        );
        assert_code(
            decode_syndrome_raw(999, 0, &[], 1, 1),
            SampleArchiveErrorCode::MalformedArchive,
        );

        let mut hits = Vec::new();
        for_each_sparse_syndrome_hit(&[0x02, 0x00, 0x01, 0x00], 4, 3, 2, |shot, detector| {
            hits.push((shot, detector));
        })
        .expect("valid sparse replay");
        assert_eq!(hits, [(0, 0), (0, 2)]);
    }

    #[test]
    fn dense_syndrome_hash_uses_canonical_shot_major_bytes() {
        let mut table = BitTable::new(3, 3);
        let hits_by_shot: &[&[usize]] = &[&[0, 2], &[1], &[0, 1]];
        for (shot, rows) in hits_by_shot.iter().enumerate() {
            for &row in *rows {
                table.set(row, shot, true);
            }
        }

        let mut hasher = Sha256::new();
        update_dense_syndrome_hash(&table, &mut hasher).expect("hash dense syndrome");
        let digest: [u8; 32] = hasher.finalize().into();
        let expected: [u8; 32] = Sha256::digest([0xd5, 0x00]).into();
        assert_eq!(digest, expected);
    }

    #[test]
    fn private_error_mappers_preserve_codes() {
        assert_eq!(
            map_alloc(BitTableAllocError::SizeOverflow).code(),
            SampleArchiveErrorCode::LimitExceeded
        );
        assert_eq!(
            limit("test limit").code(),
            SampleArchiveErrorCode::LimitExceeded
        );
    }

    #[test]
    fn materialization_telemetry_tracks_multiple_candidates_in_one_window() {
        reset_materialization_telemetry();
        begin_materialization_window();
        record_materialized_candidate();
        std::thread::spawn(begin_materialization_window)
            .join()
            .expect("interfering materialization thread");
        record_materialized_candidate();
        assert_eq!(max_materialized_candidates(), 2);
    }
}