ic-memory 0.56.0

Durable stable-memory allocation governance for Internet Computer canisters
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
//! Ledger recovery contracts.

use super::*;

#[test]
fn repeated_commits_keep_metadata_bounded() {
    let mut store = LedgerCommitStore::default();
    store
        .commit(&AllocationLedger::new(65_530, Vec::new()).unwrap())
        .unwrap();
    let mut largest_payload = 0;
    for version in 1_u32..=1024 {
        let snapshot = DeclarationSnapshot::for_test(vec![declaration("app.users.v1", 100)]);
        let recovered = store.recover().unwrap();
        let (next, _) =
            stage_generation(recovered, snapshot, &crate::GenericAllocationPolicy).unwrap();
        store.commit_generation(&next).unwrap();
        assert_eq!(next.current_generation(), 65_530 + u64::from(version));
        let recovered = store.recover().unwrap();
        assert_eq!(recovered.ledger().records().len(), 1);
        largest_payload = largest_payload.max(store.authoritative().unwrap().payload().len());
    }
    // Wire integer widths may grow; the number of records and metadata do not.
    assert!(largest_payload < 200);
    assert!(
        crate::stable_cell::EncodedLedgerRecord::new(&store)
            .unwrap()
            .len()
            < 600
    );
}

#[test]
fn largest_current_record_set_fits_writer_and_reader_bounds() {
    let records = (0..255_u8)
        .map(|id| {
            let key = format!("app.store{id:03}.{}.v1", "x".repeat(112));
            assert_eq!(key.len(), 128);
            let declaration = declaration(&key, id);
            AllocationRecord::from_declaration(&declaration)
        })
        .collect();
    let ledger = AllocationLedger::new(u64::MAX - 1, records).unwrap();
    let payload = encoded_payload(&ledger);
    assert!(payload.len() <= crate::constants::MAX_COMMITTED_PAYLOAD_BYTES);
    let mut store = LedgerCommitStore::default();
    store.commit(&ledger).unwrap();
    let next = AllocationLedger::new(u64::MAX, ledger.records().to_vec()).unwrap();
    store.commit(&next).unwrap();
    let record = store;
    let bytes = crate::stable_cell::EncodedLedgerRecord::new(&record)
        .unwrap()
        .into_bytes();
    assert!(bytes.len() <= crate::constants::MAX_LEDGER_RECORD_BYTES);
    let decoded = crate::decode_stable_cell_commit_store(&bytes).unwrap();
    assert_eq!(decoded.recover().unwrap().ledger(), &next);
}

#[test]
fn validated_counter_overflow_rejects_without_commit_mutation() {
    let mut store = LedgerCommitStore::default();
    store
        .commit(&AllocationLedger::new(u64::MAX, Vec::new()).unwrap())
        .unwrap();
    let before = store.clone();
    let recovered = store.recover().unwrap();
    let result = stage_generation(
        recovered,
        DeclarationSnapshot::for_test(Vec::new()),
        &crate::GenericAllocationPolicy,
    );
    assert!(matches!(
        result,
        Err(crate::RuntimeBootstrapError::Staging(
            AllocationStageError::GenerationOverflow {
                generation: u64::MAX
            }
        ))
    ));
    assert_eq!(store, before);
}

#[test]
fn recovery_rejects_invalid_stable_key_during_ledger_decode() {
    let mut ledger = committed_ledger(1);
    ledger.records.push(allocation_record("app.users.v1", 100));
    let mut bytes = codec::encode_ledger(&ledger).expect("encode ledger");
    let key_start = bytes
        .windows(b"app.users.v1".len())
        .position(|window| window == b"app.users.v1")
        .expect("encoded stable key");
    bytes[key_start] = b'A';
    assert!(decode_ledger(&bytes, 1).is_err());
    let payload = bytes;
    let mut physical = LedgerCommitStore::default();
    physical.commit_payload_at_generation(1, payload).unwrap();
    let store = physical;
    let before = store.clone();
    assert!(matches!(store.recover(), Err(LedgerCommitError::Codec(_))));
    assert_eq!(store, before, "malformed-key recovery must preserve slots");
}

#[test]
fn ledger_decode_rejects_unusable_memory_manager_slot() {
    let bytes = crate::test_wire::to_vec(&vec![("app.users.v1", 255_u8)]).unwrap();
    assert!(decode_ledger(&bytes, 1).is_err());
}

#[test]
fn integrity_rejects_nonempty_genesis_before_commit() {
    let invalid = AllocationLedger {
        current_generation: 0,
        records: vec![allocation_record("app.users.v1", 100)],
    };
    assert_eq!(
        invalid.validate_integrity(),
        Err(LedgerIntegrityError::NonemptyGenesis)
    );
    let mut store = LedgerCommitStore::default();
    let before = store.clone();
    assert_eq!(
        store.commit(&invalid),
        Err(LedgerCommitError::Integrity(
            LedgerIntegrityError::NonemptyGenesis
        ))
    );
    assert_eq!(store, before);
}

#[test]
fn ledger_commit_store_rejects_invalid_ledger_before_write() {
    let mut store = LedgerCommitStore::default();
    let mut invalid = ledger();
    invalid.records = vec![
        allocation_record("app.users.v1", 100),
        allocation_record("app.orders.v1", 100),
    ];

    let err = store.commit(&invalid).expect_err("invalid ledger");

    assert!(matches!(
        err,
        LedgerCommitError::Integrity(LedgerIntegrityError::DuplicateSlot { .. })
    ));
    assert!(store.current().is_none());
}

#[test]
fn ledger_commit_store_recovers_latest_committed_ledger() {
    let mut store = LedgerCommitStore::default();
    let first = committed_ledger(1);
    let second = committed_ledger(2);

    store.commit(&first).expect("first commit");
    store.commit(&second).expect("second commit");
    let recovered = store.recover().expect("recovered ledger");

    assert_eq!(recovered.current_generation(), 2);
}

#[test]
fn ledger_commit_store_encodes_direct_logical_wire() {
    let mut store = LedgerCommitStore::default();
    let ledger = committed_ledger(1);

    store.commit(&ledger).expect("commit");

    let committed = store.authoritative().expect("authoritative");
    assert_eq!(
        committed.payload(),
        crate::test_wire::to_vec(&ledger.records()).unwrap(),
        "commit payload matches canonical record-array Wire"
    );
}

#[test]
fn ledger_commit_store_rejects_malformed_logical_wire() {
    let committed = CommittedGenerationBytes::new(1, vec![b'X'; 28]);
    let store = LedgerCommitStore {
        current: Some(committed),
    };

    let err = store.recover().expect_err("bad logical Wire");

    assert!(matches!(err, LedgerCommitError::Codec(_)));
}

#[test]
fn recovery_and_initialization_preserve_physical_diagnostics_and_logical_failures() {
    let genesis = encoded_payload(&committed_ledger(0));
    let committed = CommittedGenerationBytes::new(0, genesis.clone());
    let mut corrupt = committed.clone();
    corrupt.checksum ^= 1;
    let mut unsupported = committed.clone();
    unsupported.commit_marker = u64::MAX;
    let cases = [
        ("empty", None),
        ("current", Some(committed)),
        ("corrupt", Some(corrupt)),
        ("unsupported format", Some(unsupported)),
        (
            "invalid Wire",
            Some(CommittedGenerationBytes::new(0, vec![255])),
        ),
        (
            "checked nonzero generation with empty records",
            Some(CommittedGenerationBytes::new(1, genesis)),
        ),
        (
            "invalid committed integrity",
            Some(CommittedGenerationBytes::new(
                0,
                encoded_payload(&committed_fixture_ledger()),
            )),
        ),
    ];

    for (label, current) in cases {
        let empty = current.is_none();
        let store = LedgerCommitStore { current };
        let before = store.clone();
        let (recovered, diagnostic) = store.recover_with_diagnostic();
        assert_eq!(recovered, store.recover(), "{label}");
        assert_eq!(diagnostic, store.diagnostic(), "{label}");
        assert_eq!(store, before, "{label}");

        let initializing = store.clone();
        let initialized = initializing.recover_or_genesis();
        if empty {
            let initialized = initialized.expect("empty store accepts genesis");
            assert_eq!(initialized.current_generation(), 0);
            assert_eq!(initialized.ledger().records(), []);
        } else {
            assert_eq!(initialized, recovered, "{label}");
        }
        assert_eq!(initializing, before, "{label}");

        if let Err(LedgerCommitError::Recovery(error)) = recovered {
            let expected = match error {
                CommitRecoveryError::NoValidGeneration => crate::CommitSnapshotDiagnostic::Empty,
                CommitRecoveryError::InvalidSnapshot { generation } => {
                    crate::CommitSnapshotDiagnostic::Invalid { generation }
                }
                CommitRecoveryError::UnsupportedFormat { .. } => {
                    crate::CommitSnapshotDiagnostic::Invalid {
                        generation: before.current().unwrap().generation(),
                    }
                }
                _ => panic!("unexpected physical recovery failure: {error}"),
            };
            assert_eq!(diagnostic, expected, "{label}");
        } else {
            assert!(
                matches!(diagnostic, crate::CommitSnapshotDiagnostic::Valid { .. }),
                "{label}"
            );
        }
    }
}

#[test]
fn ledger_commit_store_recovers_current_format_genesis_and_first_real_commit() {
    let mut store = LedgerCommitStore::default();
    let recovered = store
        .recover_or_genesis()
        .expect("current-format genesis ledger");
    assert_eq!(recovered.current_generation(), 0);

    assert!(store.current().is_none());
    assert!(matches!(
        store.recover(),
        Err(LedgerCommitError::Recovery(
            CommitRecoveryError::NoValidGeneration
        ))
    ));

    let first = stage(
        recovered.ledger().clone(),
        &snapshot_from(vec![declaration("app.users.v1", 100)]),
    )
    .expect("first real generation");
    let recovered = store.commit(&first).expect("first commit");

    assert_eq!(recovered, store.recover().unwrap());
    assert_eq!(recovered.current_generation(), 1);
}

#[test]
fn ledger_commit_store_rejects_corrupt_current_snapshot() {
    let mut store = LedgerCommitStore::default();
    let genesis = committed_ledger(0);
    store.commit(&genesis).expect("genesis commit");
    let first = stage(
        genesis,
        &snapshot_from(vec![declaration("app.users.v1", 100)]),
    )
    .expect("first generation");
    let first = store.commit(&first).expect("first commit");
    let second = stage(
        first.ledger().clone(),
        &snapshot_from(vec![declaration("app.users.v1", 100)]),
    )
    .expect("second generation");

    store.commit(&second).expect("second commit");
    store.current.as_mut().expect("latest slot").checksum ^= 1;

    let err = store
        .recover()
        .expect_err("corrupt latest must not roll back");

    assert_eq!(
        err,
        LedgerCommitError::Recovery(CommitRecoveryError::InvalidSnapshot { generation: 2 })
    );
}

#[test]
fn ledger_commit_store_rejects_corrupt_current_ledger() {
    let mut store = LedgerCommitStore::default();
    let first = committed_ledger(1);
    let second = committed_ledger(2);

    store.commit(&first).expect("first commit");
    store.write_corrupt_ledger(&second).expect("corrupt write");
    let err = store.recover().expect_err("corrupt slot");

    assert_eq!(
        err,
        LedgerCommitError::Recovery(CommitRecoveryError::InvalidSnapshot { generation: 2 })
    );
}

#[test]
fn ledger_commit_store_recovers_generation_from_protected_header() {
    let payload = encoded_payload(&committed_fixture_ledger());
    for generation in [1, 7, u64::MAX] {
        let store = LedgerCommitStore {
            current: Some(CommittedGenerationBytes::new(generation, payload.clone())),
        };
        let recovered = store.recover().unwrap();
        assert_eq!(recovered.current_generation(), generation);
        assert_eq!(
            recovered.ledger().records(),
            committed_fixture_ledger().records()
        );
    }
}

#[test]
fn ledger_commit_store_rejects_non_next_logical_generation() {
    let mut store = LedgerCommitStore::default();
    store.commit(&committed_ledger(1)).expect("first commit");

    let err = store
        .commit(&committed_ledger(3))
        .expect_err("skipped generation");

    assert_eq!(
        err,
        LedgerCommitError::Recovery(CommitRecoveryError::UnexpectedGeneration {
            expected: 2,
            actual: 3
        })
    );
}

#[test]
fn ledger_commit_store_rejects_corrupt_store_even_with_genesis() {
    let mut store = LedgerCommitStore::default();
    store
        .write_corrupt_ledger(&ledger())
        .expect("corrupt write");

    let err = store.recover_or_genesis().expect_err("corrupt state");

    assert!(matches!(
        err,
        LedgerCommitError::Recovery(CommitRecoveryError::InvalidSnapshot { generation: 3 })
    ));
}

#[test]
fn record_count_boundary_and_malicious_count_reject_on_recovery() {
    let mut ledger = committed_ledger(1);
    ledger.records = (0..255_u8)
        .map(|id| allocation_record(&format!("app.slot{id}.v1"), id))
        .collect();
    let mut store = LedgerCommitStore::default();
    store.commit(&ledger).unwrap();
    assert_eq!(store.recover().unwrap().ledger().records().len(), 255);
    ledger.records.push(allocation_record("app.extra.v1", 254));
    assert!(matches!(
        store.commit(&ledger),
        Err(LedgerCommitError::Integrity(
            LedgerIntegrityError::LimitExceeded { .. }
        ))
    ));
    let payload = crate::test_wire::to_vec(ledger.records()).unwrap();
    let invalid = LedgerCommitStore {
        current: Some(CommittedGenerationBytes::new(1, payload)),
    };
    assert!(invalid.recover().is_err());
    assert!(invalid.recover_or_genesis().is_err());
    for bytes in [vec![255; 10], vec![128, 2], vec![1]] {
        let payload = bytes;
        let invalid = LedgerCommitStore {
            current: Some(CommittedGenerationBytes::new(1, payload)),
        };
        assert!(matches!(
            invalid.recover(),
            Err(LedgerCommitError::Codec(_))
        ));
    }
}