spacewasm 0.3.3

A no_std WebAssembly 1.0 decoder, validator, and interpreter for on-board spacecraft use
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
use crate::ValidationError;
use crate::alloc::AllocError;
use core::mem::MaybeUninit;
use core::ops::{Deref, DerefMut};

pub struct StaticVec<T: Sized, const N: usize> {
    data: [MaybeUninit<T>; N],
    len: u32,
}

impl<T: Sized + Clone, const N: usize> Clone for StaticVec<T, N> {
    fn clone(&self) -> Self {
        // Create uninitialized array
        let mut new_vec = StaticVec::<T, N>::default();

        // Clone only the initialized elements
        for i in 0..(self.len as usize) {
            unsafe {
                new_vec.data[i].write(self.data[i].assume_init_ref().clone());
            }
        }

        // Set length after initialization
        new_vec.len = self.len;

        new_vec
    }
}

impl<T: Sized, const N: usize> StaticVec<T, N> {
    pub(crate) fn truncate(&mut self, new_len: usize) {
        assert!(new_len <= self.len as usize);
        // Drop the discarded suffix [new_len..len) before shrinking, otherwise
        // elements owning heap memory would leak. Mirrors the `Drop` impl.
        for i in new_len..(self.len as usize) {
            // SAFETY: elements [new_len..len) are initialized.
            unsafe { self.data[i].assume_init_drop() };
        }
        self.len = new_len as u32;
    }
}

impl<T: Sized, const N: usize> Drop for StaticVec<T, N> {
    fn drop(&mut self) {
        // Drop the initialized elements [0..len). Consuming iterators wrap the
        // vec in `ManuallyDrop`, so this does not run there (no double-drop);
        // `pop` decrements `len` before reading, so popped elements are skipped.
        for i in 0..(self.len as usize) {
            // SAFETY: elements [0..len) are initialized.
            unsafe { self.data[i].assume_init_drop() };
        }
    }
}

impl<T: Sized, const N: usize> Default for StaticVec<T, N> {
    fn default() -> Self {
        Self {
            data: [const { MaybeUninit::uninit() }; N],
            len: 0,
        }
    }
}

impl<'a, const N: usize> TryInto<&'a str> for &'a StaticVec<u8, N> {
    type Error = ValidationError;

    fn try_into(self) -> Result<&'a str, Self::Error> {
        core::str::from_utf8(&self[0..(self.len as usize)])
            .map_err(|_| ValidationError::MalformedUtf8)
    }
}

impl<T, const N: usize> StaticVec<T, N> {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn push(&mut self, value: T) -> Result<(), AllocError> {
        if (self.len as usize) >= N {
            return Err(AllocError::OutOfMemory);
        }

        self.data[self.len as usize].write(value);

        self.len += 1;
        Ok(())
    }

    pub fn len(&self) -> usize {
        self.len as usize
    }

    pub fn pop(&mut self) -> Option<T> {
        if self.len == 0 {
            None
        } else {
            self.len -= 1;
            unsafe { Some(self.data[self.len as usize].assume_init_read()) }
        }
    }
}

impl<T: core::fmt::Debug, const N: usize> core::fmt::Debug for StaticVec<T, N> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        f.debug_list().entries(self.iter()).finish()
    }
}

impl<T, const N: usize> Deref for StaticVec<T, N> {
    type Target = [T];
    fn deref(&self) -> &[T] {
        unsafe {
            // SAFETY: elements [0..len) are initialized
            core::slice::from_raw_parts(self.data.as_ptr() as *const T, self.len as usize)
        }
    }
}

impl<T, const N: usize> DerefMut for StaticVec<T, N> {
    fn deref_mut(&mut self) -> &mut [T] {
        unsafe {
            // SAFETY: elements [0..len) are initialized
            core::slice::from_raw_parts_mut(self.data.as_mut_ptr() as *mut T, self.len as usize)
        }
    }
}

pub struct StaticVecIntoIter<T, const N: usize> {
    vec: core::mem::ManuallyDrop<StaticVec<T, N>>,
    pos: usize,
}

impl<T, const N: usize> Iterator for StaticVecIntoIter<T, N> {
    type Item = T;

    fn next(&mut self) -> Option<Self::Item> {
        if self.pos < (self.vec.len as usize) {
            let item = unsafe { self.vec.data[self.pos].assume_init_read() };
            self.pos += 1;
            Some(item)
        } else {
            None
        }
    }
}

impl<T, const N: usize> Drop for StaticVecIntoIter<T, N> {
    fn drop(&mut self) {
        // Drop remaining elements that haven't been yielded yet
        while self.pos < (self.vec.len as usize) {
            unsafe { self.vec.data[self.pos].assume_init_drop() };
            self.pos += 1;
        }
    }
}

impl<T, const N: usize> IntoIterator for StaticVec<T, N> {
    type Item = T;
    type IntoIter = StaticVecIntoIter<T, N>;

    fn into_iter(self) -> Self::IntoIter {
        StaticVecIntoIter {
            vec: core::mem::ManuallyDrop::new(self),
            pos: 0,
        }
    }
}

#[cfg(kani)]
mod kani_proofs {
    use super::*;

    /// Verify StaticVec push and pop operations maintain LIFO ordering, length invariants,
    /// correctly enforce capacity limits, and deref returns correct slice view.
    #[kani::proof]
    #[kani::unwind(6)]
    fn proof_push_pop_correctness() {
        let mut vec: StaticVec<u32, 3> = StaticVec::new();

        assert_eq!(vec.len(), 0, "new vector should be empty");

        // Generate arbitrary values to push
        let v1: u32 = kani::any();
        let v2: u32 = kani::any();
        let v3: u32 = kani::any();
        let v4: u32 = kani::any();

        // Push values up to capacity and verify length increases
        assert!(vec.push(v1).is_ok(), "first push should succeed");
        assert_eq!(vec.len(), 1, "length should be 1 after first push");

        assert!(vec.push(v2).is_ok(), "second push should succeed");
        assert_eq!(vec.len(), 2, "length should be 2 after second push");

        // Verify deref returns correct slice view
        let slice: &[u32] = &*vec;
        assert_eq!(
            slice.len(),
            2,
            "deref slice length should match vector length"
        );
        assert_eq!(
            slice[0], v1,
            "first element should match first pushed value"
        );
        assert_eq!(
            slice[1], v2,
            "second element should match second pushed value"
        );

        assert!(vec.push(v3).is_ok(), "third push should succeed");
        assert_eq!(vec.len(), 3, "length should be 3 after third push");

        // Test capacity limit: push beyond capacity should fail
        let result = vec.push(v4);
        assert!(result.is_err(), "push beyond capacity should fail");
        assert!(
            matches!(result, Err(AllocError::OutOfMemory)),
            "push beyond capacity should return OutOfMemory"
        );
        assert_eq!(
            vec.len(),
            3,
            "length should remain at capacity after failed push"
        );

        // Pop values and verify LIFO ordering
        assert_eq!(vec.pop(), Some(v3), "should pop third value first");
        assert_eq!(vec.len(), 2, "length should be 2 after first pop");

        assert_eq!(vec.pop(), Some(v2), "should pop second value");
        assert_eq!(vec.len(), 1, "length should be 1 after second pop");

        assert_eq!(vec.pop(), Some(v1), "should pop first value last");
        assert_eq!(
            vec.len(),
            0,
            "vector should be empty after popping all elements"
        );

        assert_eq!(vec.pop(), None, "popping empty vector should return None");
    }

    /// Verify StaticVec IntoIterator yields values in correct order and drops properly.
    #[kani::proof]
    #[kani::unwind(5)]
    fn proof_into_iter_correctness() {
        let mut vec: StaticVec<u32, 4> = StaticVec::new();

        let v1: u32 = kani::any();
        let v2: u32 = kani::any();
        let v3: u32 = kani::any();

        vec.push(v1).unwrap();
        vec.push(v2).unwrap();
        vec.push(v3).unwrap();

        let mut iter = vec.into_iter();

        assert_eq!(iter.next(), Some(v1), "first next should yield first value");
        assert_eq!(
            iter.next(),
            Some(v2),
            "second next should yield second value"
        );
        assert_eq!(iter.next(), Some(v3), "third next should yield third value");
        assert_eq!(
            iter.next(),
            None,
            "next on exhausted iterator should return None"
        );
    }

    /// Verify StaticVec IntoIterator drop handles partially consumed iterator.
    #[kani::proof]
    #[kani::unwind(4)]
    fn proof_into_iter_partial_drop() {
        let mut vec: StaticVec<u32, 4> = StaticVec::new();

        let v1: u32 = kani::any();
        let v2: u32 = kani::any();
        let v3: u32 = kani::any();

        vec.push(v1).unwrap();
        vec.push(v2).unwrap();
        vec.push(v3).unwrap();

        let mut iter = vec.into_iter();

        // Consume only first element
        assert_eq!(iter.next(), Some(v1), "should yield first value");

        // Drop iterator with remaining elements - this tests the Drop impl
        // which should properly drop remaining elements v2 and v3
    }

    /// Verify StaticVec truncate operation.
    #[kani::proof]
    #[kani::unwind(4)]
    fn proof_truncate_correctness() {
        let mut vec: StaticVec<u32, 4> = StaticVec::new();

        let v1: u32 = kani::any();
        let v2: u32 = kani::any();
        let v3: u32 = kani::any();

        vec.push(v1).unwrap();
        vec.push(v2).unwrap();
        vec.push(v3).unwrap();

        assert_eq!(vec.len(), 3, "vector should have 3 elements");

        vec.truncate(2);
        assert_eq!(vec.len(), 2, "vector should have 2 elements after truncate");

        let slice: &[u32] = &*vec;
        assert_eq!(slice[0], v1, "first element should remain");
        assert_eq!(slice[1], v2, "second element should remain");
    }
}

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

    #[test]
    fn test_new() {
        let vec: StaticVec<i32, 10> = StaticVec::new();
        assert_eq!(vec.len, 0);
    }

    #[test]
    fn test_push_pop() {
        let mut vec: StaticVec<i32, 5> = StaticVec::new();

        assert!(vec.push(1).is_ok());
        assert!(vec.push(2).is_ok());
        assert!(vec.push(3).is_ok());
        assert_eq!(vec.len, 3);

        assert_eq!(vec.pop(), Some(3));
        assert_eq!(vec.pop(), Some(2));
        assert_eq!(vec.pop(), Some(1));
        assert_eq!(vec.pop(), None);
    }

    #[test]
    fn test_capacity_exceeded() {
        let mut vec: StaticVec<i32, 2> = StaticVec::new();

        assert!(vec.push(1).is_ok());
        assert!(vec.push(2).is_ok());
        assert!(matches!(vec.push(3), Err(AllocError::OutOfMemory)));
    }

    #[test]
    fn test_deref() {
        let mut vec: StaticVec<i32, 5> = StaticVec::new();
        vec.push(10).unwrap();
        vec.push(20).unwrap();
        vec.push(30).unwrap();

        let slice: &[i32] = &vec;
        assert_eq!(slice.len(), 3);
    }

    #[test]
    fn test_into_iter() {
        let mut vec: StaticVec<i32, 5> = StaticVec::new();
        vec.push(10).unwrap();
        vec.push(20).unwrap();
        vec.push(30).unwrap();

        let mut iter = vec.into_iter();
        assert_eq!(iter.next(), Some(10));
        assert_eq!(iter.next(), Some(20));
        assert_eq!(iter.next(), Some(30));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn test_truncate_drops_suffix() {
        use core::cell::Cell;

        struct DropCounter<'a>(&'a Cell<u32>);
        impl Drop for DropCounter<'_> {
            fn drop(&mut self) {
                self.0.set(self.0.get() + 1);
            }
        }

        let drops = Cell::new(0);
        let mut vec: StaticVec<DropCounter, 4> = StaticVec::new();
        vec.push(DropCounter(&drops)).unwrap();
        vec.push(DropCounter(&drops)).unwrap();
        vec.push(DropCounter(&drops)).unwrap();

        // Truncating from 3 to 1 must drop the two discarded elements.
        vec.truncate(1);
        assert_eq!(drops.get(), 2, "truncate should drop the discarded suffix");
        assert_eq!(vec.len(), 1);

        // Dropping the vec drops the one remaining element.
        drop(vec);
        assert_eq!(drops.get(), 3, "remaining element should drop with the vec");
    }

    #[test]
    fn test_clone() {
        let mut vec: StaticVec<i32, 5> = StaticVec::new();
        vec.push(1).unwrap();
        vec.push(2).unwrap();
        vec.push(3).unwrap();

        let cloned = vec.clone();
        assert_eq!(cloned.len(), 3);
        assert_eq!(&cloned[..], &[1, 2, 3]);
        assert_eq!(&vec[..], &[1, 2, 3]);
    }
}