fuel-vm 0.66.3

FuelVM interpreter.
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

#![allow(clippy::arithmetic_side_effects, clippy::cast_possible_truncation)]

use alloc::vec;

use fuel_asm::{
    Imm24,
    PanicReason,
};

use crate::{
    constraints::reg_key::*,
    consts::*,
    error::PanicOrBug,
    interpreter::memory::{
        MemoryInstance,
        pop_selected_registers,
        push_selected_registers,
    },
};

#[rstest::rstest]
fn test_push_pop(
    #[values(ProgramRegistersSegment::Low, ProgramRegistersSegment::High)]
    segment: ProgramRegistersSegment,
    #[values(
        0,
        0b01,
        0b10,
        0b11,
        0b_100000_000000_000000_000000,
        0b_111100_011101_101011_001100,
        0b_111100_011101_101011_001101,
        Imm24::MAX.into(),
    )]
    bitmask: u32,
) {
    let mut memory: MemoryInstance = vec![1u8; MEM_SIZE].try_into().unwrap();
    let mut pc = 0;
    let mut sp = 0;

    let orig_regs = [2; VM_REGISTER_PROGRAM_COUNT];
    let mut reg_values = orig_regs;
    let mut regs = ProgramRegisters(&mut reg_values);

    let popcnt = bitmask.count_ones() as u64;
    let bitmask = Imm24::new_checked(bitmask).unwrap();

    // Save registers to stack
    push_selected_registers(
        &mut memory,
        RegMut::new(&mut sp),
        Reg::new(&0),
        Reg::new(&VM_MAX_RAM),
        RegMut::new(&mut pc),
        &regs,
        segment,
        bitmask,
    )
    .expect("Push failed unexpectedly");

    assert_eq!(sp, popcnt * 8);
    assert_eq!(pc, 4);

    // Clear registers
    regs.0.fill(0);

    // Restore registers
    pop_selected_registers(
        &mut memory,
        RegMut::new(&mut sp),
        Reg::new(&0),
        Reg::new(&VM_MAX_RAM),
        RegMut::new(&mut pc),
        &mut regs,
        segment,
        bitmask,
    )
    .expect("Pop failed unexpectedly");

    assert_eq!(sp, 0);
    assert_eq!(pc, 8);

    // Make sure that the correct number of registers were restored
    assert_eq!(
        orig_regs
            .iter()
            .zip(reg_values.iter())
            .filter(|(a, b)| a == b)
            .count() as u64,
        popcnt
    );
}

#[test]
fn test_push_stack_overflow() {
    let mut memory: MemoryInstance = vec![1u8; MEM_SIZE].try_into().unwrap();
    let mut pc = 0;
    let mut sp = 10;
    let hp = 14;

    let mut reg_values = [0; VM_REGISTER_PROGRAM_COUNT];
    let regs = ProgramRegisters(&mut reg_values);

    let result = push_selected_registers(
        &mut memory,
        RegMut::new(&mut sp),
        Reg::new(&10),
        Reg::new(&hp),
        RegMut::new(&mut pc),
        &regs,
        ProgramRegistersSegment::Low,
        Imm24::new(1),
    );

    assert_eq!(
        result,
        Err(PanicOrBug::Panic(PanicReason::MemoryGrowthOverlap))
    );
}

#[test]
fn test_pop_from_empty_stack() {
    let mut memory: MemoryInstance = vec![1u8; MEM_SIZE].try_into().unwrap();
    let mut pc = 0;
    let mut sp = 32;
    let ssp = 16;

    let mut reg_values = [0; VM_REGISTER_PROGRAM_COUNT];
    let mut regs = ProgramRegisters(&mut reg_values);

    let result = pop_selected_registers(
        &mut memory,
        RegMut::new(&mut sp),
        Reg::new(&ssp),
        Reg::new(&VM_MAX_RAM),
        RegMut::new(&mut pc),
        &mut regs,
        ProgramRegistersSegment::Low,
        Imm24::new(0b111),
    );

    assert_eq!(result, Err(PanicOrBug::Panic(PanicReason::MemoryOverflow)));
}

#[test]
fn test_pop_sp_overflow() {
    let mut memory: MemoryInstance = vec![1u8; MEM_SIZE].try_into().unwrap();
    let mut pc = 0;
    let mut sp = 16;
    let ssp = 0;

    let mut reg_values = [0; VM_REGISTER_PROGRAM_COUNT];
    let mut regs = ProgramRegisters(&mut reg_values);

    let result = pop_selected_registers(
        &mut memory,
        RegMut::new(&mut sp),
        Reg::new(&ssp),
        Reg::new(&VM_MAX_RAM),
        RegMut::new(&mut pc),
        &mut regs,
        ProgramRegistersSegment::Low,
        Imm24::new(0b111),
    );

    assert_eq!(result, Err(PanicOrBug::Panic(PanicReason::MemoryOverflow)));
}