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

//! Arithmetic functions for the Fuel VM

use fuel_asm::{
    PanicReason,
    Word,
};

use crate::error::RuntimeError;

/// Add two unchecked words, returning an error if overflow
#[inline(always)]
pub fn checked_add_word(a: Word, b: Word) -> Result<Word, PanicReason> {
    a.checked_add(b).ok_or(PanicReason::ArithmeticOverflow)
}

/// Subtract two unchecked words, returning an error if overflow
#[inline(always)]
pub fn checked_sub_word(a: Word, b: Word) -> Result<Word, PanicReason> {
    a.checked_sub(b).ok_or(PanicReason::ArithmeticOverflow)
}

/// Add two unchecked numbers, returning an error if overflow
#[inline(always)]
pub fn checked_add_usize(a: usize, b: usize) -> Result<usize, PanicReason> {
    a.checked_add(b).ok_or(PanicReason::ArithmeticOverflow)
}

/// Subtract two unchecked numbers, returning an error if overflow
#[inline(always)]
pub fn checked_sub_usize(a: usize, b: usize) -> Result<usize, PanicReason> {
    a.checked_sub(b).ok_or(PanicReason::ArithmeticOverflow)
}

/// Add two checked words. Might wrap if overflow
///
/// The function is inlined so it will be optimized to `a + b` if `optimized` feature is
/// enabled so the operation is unchecked.
///
/// This should be used in contexts that are checked and guaranteed by the protocol to
/// never overflow, but then they might due to some bug in the code.
#[inline(always)]
pub fn add_word(a: Word, b: Word) -> Result<Word, RuntimeError> {
    #[cfg(feature = "optimized")]
    #[allow(clippy::arithmetic_side_effects)]
    {
        Ok(a + b)
    }

    #[cfg(not(feature = "optimized"))]
    {
        a.checked_add(b)
            .ok_or_else(|| RuntimeError::unexpected_behavior("unexpected overflow"))
    }
}

/// Subtract two checked words. Might wrap if overflow
///
/// The function is inlined so it will be optimized to `a + b` if `optimized` feature is
/// enabled so the operation is unchecked.
///
/// This should be used in contexts that are checked and guaranteed by the protocol to
/// never overflow, but then they might due to some bug in the code.
#[inline(always)]
#[allow(clippy::arithmetic_side_effects)]
pub fn sub_word(a: Word, b: Word) -> Result<Word, RuntimeError> {
    #[cfg(feature = "optimized")]
    {
        Ok(a - b)
    }

    #[cfg(not(feature = "optimized"))]
    {
        a.checked_sub(b)
            .ok_or_else(|| RuntimeError::unexpected_behavior("unexpected underflow"))
    }
}

/// Add two numbers. Should be used only in compile-time evaluations so the code won't
/// compile in case of unexpected overflow.
#[inline(always)]
#[allow(clippy::arithmetic_side_effects)]
pub const fn add_usize(a: usize, b: usize) -> usize {
    a + b
}