sp1-core-executor 6.1.0

RISC-V executor 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use crate::{
    events::{MemoryReadRecord, MemoryWriteRecord},
    Register,
};

pub struct LoadResult {
    pub a: u64,
    pub b: u64,
    pub c: u64,
    pub addr: u64,
    pub rs1: Register,
    pub mr_record: MemoryReadRecord,
    pub rd: Register,
    pub rr_record: MemoryReadRecord,
    pub rw_record: MemoryWriteRecord,
}

pub struct StoreResult {
    pub a: u64,
    pub b: u64,
    pub c: u64,
    pub addr: u64,
    pub rs1: Register,
    pub rs1_record: MemoryReadRecord,
    pub rs2: Register,
    pub rs2_record: MemoryReadRecord,
    pub mw_record: MemoryWriteRecord,
}

pub struct AluResult {
    pub rd: Register,
    pub rw_record: MemoryWriteRecord,
    pub a: u64,
    pub b: u64,
    pub c: u64,
    pub rs1: MaybeImmediate,
    pub rs2: MaybeImmediate,
}

pub enum MaybeImmediate {
    Register(Register, MemoryReadRecord),
    Immediate(u64),
}

impl MaybeImmediate {
    pub fn record(&self) -> Option<&MemoryReadRecord> {
        match self {
            MaybeImmediate::Register(_, record) => Some(record),
            MaybeImmediate::Immediate(_) => None,
        }
    }
}

pub struct JumpResult {
    pub a: u64,
    pub b: u64,
    pub c: u64,
    pub rd: Register,
    pub rd_record: MemoryWriteRecord,
    pub rs1: MaybeImmediate,
}

pub struct BranchResult {
    pub a: u64,
    pub rs1: Register,
    pub a_record: MemoryReadRecord,
    pub b: u64,
    pub rs2: Register,
    pub b_record: MemoryReadRecord,
    pub c: u64,
}

pub struct UTypeResult {
    pub a: u64,
    pub b: u64,
    pub c: u64,
    pub rd: Register,
    pub rw_record: MemoryWriteRecord,
}

pub struct EcallResult {
    pub a: u64,
    pub a_record: MemoryWriteRecord,
    pub b: u64,
    pub b_record: MemoryReadRecord,
    pub c: u64,
    pub c_record: MemoryReadRecord,
}

/// The result of a cycle.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CycleResult {
    /// The cycle has completed, and may or may not have halted.
    Done(bool),
    /// The trace has ended at this cycle.
    TraceEnd,
    /// The shard has overflowed at this cycle.
    ShardBoundary,
}

impl CycleResult {
    /// Returns true if the program has halted.
    #[must_use]
    pub fn is_done(self) -> bool {
        matches!(self, CycleResult::Done(true))
    }

    /// Returns true if the program has hit a shard boundary.
    #[must_use]
    pub fn is_shard_boundry(self) -> bool {
        matches!(self, CycleResult::ShardBoundary)
    }

    /// Returns true if the trace has ended at this cycle.
    #[must_use]
    pub fn is_trace_end(self) -> bool {
        matches!(self, CycleResult::TraceEnd)
    }
}