fuel-vm 0.35.4

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
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

use std::ops::Range;

use super::*;
use crate::prelude::*;
use fuel_asm::op;
use test_case::test_case;

#[test]
fn memcopy() {
    let mut vm = Interpreter::with_memory_storage();
    let params = ConsensusParameters::default().with_max_gas_per_tx(Word::MAX / 2);
    let tx = TransactionBuilder::script(op::ret(0x10).to_bytes().to_vec(), vec![])
        .gas_limit(params.max_gas_per_tx)
        .add_random_fee_input()
        .finalize();

    let tx = tx
        .into_checked(Default::default(), &params, vm.gas_costs())
        .expect("default tx should produce a valid checked transaction");

    vm.init_script(tx).expect("Failed to init VM");

    let alloc = 1024;

    // r[0x10] := 1024
    vm.instruction(op::addi(0x10, RegId::ZERO, alloc)).unwrap();
    vm.instruction(op::aloc(0x10)).unwrap();

    // r[0x20] := 128
    vm.instruction(op::addi(0x20, RegId::ZERO, 128)).unwrap();

    for i in 0..alloc {
        vm.instruction(op::addi(0x21, RegId::ZERO, i)).unwrap();
        vm.instruction(op::sb(RegId::HP, 0x21, i as Immediate12))
            .unwrap();
    }

    // r[0x23] := m[$hp, 0x20] == m[$zero, 0x20]
    vm.instruction(op::meq(0x23, RegId::HP, RegId::ZERO, 0x20))
        .unwrap();

    assert_eq!(0, vm.registers()[0x23]);

    // r[0x12] := $hp + r[0x20]
    vm.instruction(op::add(0x12, RegId::HP, 0x20)).unwrap();

    // Test ownership
    vm.instruction(op::mcp(RegId::HP, 0x12, 0x20)).unwrap();

    // r[0x23] := m[0x30, 0x20] == m[0x12, 0x20]
    vm.instruction(op::meq(0x23, RegId::HP, 0x12, 0x20))
        .unwrap();

    assert_eq!(1, vm.registers()[0x23]);

    // Assert ownership
    vm.instruction(op::subi(0x24, RegId::HP, 1)).unwrap(); // TODO: look into this
    let ownership_violated = vm.instruction(op::mcp(0x24, 0x12, 0x20));

    assert!(ownership_violated.is_err());

    // Assert no panic on overlapping
    vm.instruction(op::subi(0x25, 0x12, 1)).unwrap();
    let overlapping = vm.instruction(op::mcp(RegId::HP, 0x25, 0x20));

    assert!(overlapping.is_err());
}

#[test]
fn memrange() {
    let tx = TransactionBuilder::script(vec![], vec![])
        .gas_limit(1000000)
        .add_random_fee_input()
        .finalize()
        .into_checked(Default::default(), &Default::default(), &Default::default())
        .expect("Empty script should be valid");
    let mut vm = Interpreter::with_memory_storage();
    vm.init_script(tx).expect("Failed to init VM");

    let bytes = 1024;
    vm.instruction(op::addi(0x10, RegId::ZERO, bytes as Immediate12))
        .unwrap();
    vm.instruction(op::aloc(0x10)).unwrap();

    let m = MemoryRange::new(vm.registers()[RegId::HP] - 1, bytes).unwrap();
    assert!(!vm.ownership_registers().has_ownership_range(&m));

    let m = MemoryRange::new(vm.registers()[RegId::HP], bytes).unwrap();
    assert!(vm.ownership_registers().has_ownership_range(&m));

    MemoryRange::new(vm.registers()[RegId::HP], bytes + 1).expect_err("Overflows");

    let m = MemoryRange::new(0, bytes).unwrap().to_heap(&vm);
    assert!(vm.ownership_registers().has_ownership_range(&m));
}

#[test]
fn stack_alloc_ownership() {
    let mut vm = Interpreter::with_memory_storage();

    let tx = TransactionBuilder::script(vec![], vec![])
        .gas_limit(1000000)
        .add_random_fee_input()
        .finalize()
        .into_checked(Default::default(), &Default::default(), &Default::default())
        .expect("Empty script should be valid");
    vm.init_script(tx).expect("Failed to init VM");

    vm.instruction(op::move_(0x10, RegId::SP)).unwrap();
    vm.instruction(op::cfei(2)).unwrap();

    // Assert allocated stack is writable
    vm.instruction(op::mcli(0x10, 2)).unwrap();
}

#[test_case(
    OwnershipRegisters::test(0..0, 0..0, Context::Call{ block_height: Default::default()}), 0..0
    => true ; "empty mem range"
)]
#[test_case(
    OwnershipRegisters::test(0..0, 0..0, Context::Script{ block_height: Default::default()}), 0..0
    => true ; "empty mem range (external)"
)]
#[test_case(
    OwnershipRegisters::test(0..0, 0..0, Context::Call{ block_height: Default::default()}), 0..1
    => false ; "empty stack and heap"
)]
#[test_case(
    OwnershipRegisters::test(0..0, VM_MAX_RAM..VM_MAX_RAM, Context::Script{ block_height: Default::default() }), 0..1
    => false ; "empty stack and heap (external)"
)]
#[test_case(
    OwnershipRegisters::test(0..1, 0..0, Context::Call{ block_height: Default::default()}), 0..1
    => true ; "in range for stack"
)]
#[test_case(
    OwnershipRegisters::test(0..1, 0..0, Context::Call{ block_height: Default::default()}), 0..2
    => false; "above stack range"
)]
#[test_case(
    OwnershipRegisters::test(0..0, 0..2, Context::Call{ block_height: Default::default()}), 1..2
    => true ; "in range for heap"
)]
#[test_case(
    OwnershipRegisters::test(0..2, 1..2, Context::Call{ block_height: Default::default()}), 0..2
    => true ; "crosses stack and heap"
)]
#[test_case(
    OwnershipRegisters::test(0..0, 0..0, Context::Script{ block_height: Default::default()}), 1..2
    => true ; "in heap range (external)"
)]
#[test_case(
    OwnershipRegisters::test(0..19, 31..100, Context::Script{ block_height: Default::default()}), 20..30
    => false; "between ranges (external)"
)]
#[test_case(
    OwnershipRegisters::test(0..19, 31..100, Context::Script{ block_height: Default::default() }), 0..1
    => true; "in stack range (external)"
)]
#[test_case(
    OwnershipRegisters::test(0..0, 9..10, Context::Script { block_height: 10.into() }), 1..9
    => false; "not owned in Script context"
)]
#[test_case(
    OwnershipRegisters::test(0..0, 9..10, Context::Call { block_height: 15.into() }), 1..9
    => false; "not owned in Call context"
)]
#[test_case(
    OwnershipRegisters::test(1_000_000..1_100_000, 5_900_000..6_300_000, Context::Script { block_height: 0.into() }),
    999_000..7_100_200 => false; "crosses heap and stack range"
)]
#[test_case(
    OwnershipRegisters::test(0..20, 40..50, Context::Script { block_height: 0.into() }),
    0..20 => true; "start inclusive and end exclusive"
)]
#[test_case(
    OwnershipRegisters::test(0..20, 40..50, Context::Script { block_height: 0.into() }),
    20..41 => false; "start exclusive and end inclusive"
)]
fn test_ownership(reg: OwnershipRegisters, range: Range<u64>) -> bool {
    let range =
        MemoryRange::new(range.start, range.end - range.start).expect("Invalid range");
    reg.has_ownership_range(&range)
}

fn set_index(index: usize, val: u8, mut array: [u8; 100]) -> [u8; 100] {
    array[index] = val;
    array
}

#[test_case(
    1, &[],
    OwnershipRegisters::test(0..1, 100..100, Context::Script{ block_height: Default::default()})
    => (false, [0u8; 100]); "External errors when write is empty"
)]
#[test_case(
    1, &[],
    OwnershipRegisters::test(0..1, 100..100, Context::Call{ block_height: Default::default()})
    => (false, [0u8; 100]); "Internal errors when write is empty"
)]
#[test_case(
    1, &[2],
    OwnershipRegisters::test(0..2, 100..100, Context::Script{ block_height: Default::default()})
    => (true, set_index(1, 2, [0u8; 100])); "External writes to stack"
)]
#[test_case(
    98, &[2],
    OwnershipRegisters::test(0..2, 97..100, Context::Script{ block_height: Default::default()})
    => (true, set_index(98, 2, [0u8; 100])); "External writes to heap"
)]
#[test_case(
    1, &[2],
    OwnershipRegisters::test(0..2, 100..100, Context::Call { block_height: Default::default()})
    => (true, set_index(1, 2, [0u8; 100])); "Internal writes to stack"
)]
#[test_case(
    98, &[2],
    OwnershipRegisters::test(0..2, 97..100, Context::Call { block_height: Default::default()})
    => (true, set_index(98, 2, [0u8; 100])); "Internal writes to heap"
)]
#[test_case(
    1, &[2; 50],
    OwnershipRegisters::test(0..40, 100..100, Context::Script{ block_height: Default::default()})
    => (false, [0u8; 100]); "External too large for stack"
)]
#[test_case(
    1, &[2; 50],
    OwnershipRegisters::test(0..40, 100..100, Context::Call{ block_height: Default::default()})
    => (false, [0u8; 100]); "Internal too large for stack"
)]
#[test_case(
    61, &[2; 50],
    OwnershipRegisters::test(0..0, 60..100, Context::Call{ block_height: Default::default()})
    => (false, [0u8; 100]); "Internal too large for heap"
)]
fn test_mem_write(
    addr: usize,
    data: &[u8],
    registers: OwnershipRegisters,
) -> (bool, [u8; 100]) {
    let mut memory: Memory<MEM_SIZE> = vec![0u8; MEM_SIZE].try_into().unwrap();
    let r = try_mem_write(addr, data, registers, &mut memory).is_ok();
    let memory: [u8; 100] = memory[..100].try_into().unwrap();
    (r, memory)
}

#[test_case(
    1, 0,
    OwnershipRegisters::test(0..1, 100..100, Context::Script{ block_height: Default::default()})
    => (false, [1u8; 100]); "External errors when write is empty"
)]
#[test_case(
    1, 0,
    OwnershipRegisters::test(0..1, 100..100, Context::Call{ block_height: Default::default()})
    => (false, [1u8; 100]); "Internal errors when write is empty"
)]
#[test_case(
    1, 1,
    OwnershipRegisters::test(0..2, 100..100, Context::Script{ block_height: Default::default()})
    => (true, set_index(1, 0, [1u8; 100])); "External writes to stack"
)]
#[test_case(
    98, 1,
    OwnershipRegisters::test(0..2, 97..100, Context::Script{ block_height: Default::default()})
    => (true, set_index(98, 0, [1u8; 100])); "External writes to heap"
)]
#[test_case(
    1, 1,
    OwnershipRegisters::test(0..2, 100..100, Context::Call { block_height: Default::default()})
    => (true, set_index(1, 0, [1u8; 100])); "Internal writes to stack"
)]
#[test_case(
    98, 1,
    OwnershipRegisters::test(0..2, 97..100, Context::Call { block_height: Default::default()})
    => (true, set_index(98, 0, [1u8; 100])); "Internal writes to heap"
)]
#[test_case(
    1, 50,
    OwnershipRegisters::test(0..40, 100..100, Context::Script{ block_height: Default::default()})
    => (false, [1u8; 100]); "External too large for stack"
)]
#[test_case(
    1, 50,
    OwnershipRegisters::test(0..40, 100..100, Context::Call{ block_height: Default::default()})
    => (false, [1u8; 100]); "Internal too large for stack"
)]
#[test_case(
    61, 50,
    OwnershipRegisters::test(0..0, 60..100, Context::Call{ block_height: Default::default()})
    => (false, [1u8; 100]); "Internal too large for heap"
)]
fn test_try_zeroize(
    addr: usize,
    len: usize,
    registers: OwnershipRegisters,
) -> (bool, [u8; 100]) {
    let mut memory: Memory<MEM_SIZE> = vec![1u8; MEM_SIZE].try_into().unwrap();
    let r = try_zeroize(addr, len, registers, &mut memory).is_ok();
    let memory: [u8; 100] = memory[..100].try_into().unwrap();
    (r, memory)
}