sp1-primitives 6.1.0

Core primitive types for SP1
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

use serde::{de::DeserializeOwned, Deserialize, Serialize};

#[derive(Debug, Clone, Copy)]
pub enum RecursionProgramType {
    Core,
    Deferred,
    Compress,
    Shrink,
    Wrap,
}

/// A buffer of serializable/deserializable objects.                                              
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Buffer {
    pub data: Vec<u8>,
    #[serde(skip)]
    pub ptr: usize,
}

impl Buffer {
    pub const fn new() -> Self {
        Self { data: Vec::new(), ptr: 0 }
    }

    pub fn from(data: &[u8]) -> Self {
        Self { data: data.to_vec(), ptr: 0 }
    }

    /// Set the position ptr to the beginning of the buffer.                                      
    pub fn head(&mut self) {
        self.ptr = 0;
    }

    /// Read the serializable object from the buffer.                                             
    pub fn read<T: Serialize + DeserializeOwned>(&mut self) -> T {
        let result: T =
            bincode::deserialize(&self.data[self.ptr..]).expect("failed to deserialize");
        let nb_bytes = bincode::serialized_size(&result).expect("failed to get serialized size");
        self.ptr += nb_bytes as usize;
        result
    }

    pub fn read_slice(&mut self, slice: &mut [u8]) {
        slice.copy_from_slice(&self.data[self.ptr..self.ptr + slice.len()]);
        self.ptr += slice.len();
    }

    /// Write the serializable object from the buffer.                                            
    pub fn write<T: Serialize>(&mut self, data: &T) {
        let mut tmp = Vec::new();
        bincode::serialize_into(&mut tmp, data).expect("serialization failed");
        self.data.extend(tmp);
    }

    /// Write the slice of bytes to the buffer.                                                   
    pub fn write_slice(&mut self, slice: &[u8]) {
        self.data.extend_from_slice(slice);
    }
}

impl Default for Buffer {
    fn default() -> Self {
        Self::new()
    }
}

/// A type that represents an ELF binary, always cheap to clone.
#[derive(Debug, Clone)]
pub enum Elf {
    /// The ELF binary for the program.
    Static(&'static [u8]),
    /// The ELF binary for the test program.
    Dynamic(std::sync::Arc<[u8]>),
}

// todo!(n): implement serde for the ELF type.

impl From<std::sync::Arc<[u8]>> for Elf {
    fn from(elf: std::sync::Arc<[u8]>) -> Self {
        Self::Dynamic(elf)
    }
}

impl From<Vec<u8>> for Elf {
    fn from(elf: Vec<u8>) -> Self {
        Self::Dynamic(elf.into())
    }
}

impl From<&[u8]> for Elf {
    fn from(elf: &[u8]) -> Self {
        Self::Dynamic(elf.into())
    }
}

impl std::ops::Deref for Elf {
    type Target = [u8];

    fn deref(&self) -> &Self::Target {
        match self {
            Self::Static(elf) => elf,
            Self::Dynamic(elf) => elf.as_ref(),
        }
    }
}