beamr 0.4.5

A Rust runtime with the BEAM's execution model, targeting Gleam
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

use crate::error::LoadError;

/// Maximum recursion depth for the External Term Format literal decoder.
pub(crate) const MAX_ETF_DEPTH: usize = 256;

/// Hard ceiling on any length-prefixed table/collection count read from untrusted bytes.
pub(crate) const MAX_TABLE_ENTRIES: usize = 16_777_216;

/// Maximum newly interned atoms allowed while loading one module.
pub(crate) const MAX_ATOMS_PER_MODULE: usize = 65_536;

/// Default decoded-node budget for one module load.
pub(crate) const DEFAULT_DECODE_NODE_BUDGET: usize = 1_000_000;

/// Default decoded/allocation byte budget for one module load.
pub(crate) const DEFAULT_DECODE_BYTE_BUDGET: usize = 64 * 1024 * 1024;

#[derive(Debug, Clone)]
pub(crate) struct DecodeBudget {
    pub(crate) depth_remaining: usize,
    pub(crate) nodes_remaining: usize,
    pub(crate) bytes_remaining: usize,
    pub(crate) atoms_remaining: usize,
}

impl DecodeBudget {
    pub(crate) fn new(
        depth_remaining: usize,
        nodes_remaining: usize,
        bytes_remaining: usize,
        atoms_remaining: usize,
    ) -> Self {
        Self {
            depth_remaining,
            nodes_remaining,
            bytes_remaining,
            atoms_remaining,
        }
    }

    pub(crate) fn charge_node(&mut self) -> Result<(), LoadError> {
        if self.nodes_remaining == 0 {
            return Err(LoadError::DecodeError(
                "decode node budget exhausted".into(),
            ));
        }
        self.nodes_remaining -= 1;
        Ok(())
    }

    pub(crate) fn charge_bytes(&mut self, n: usize) -> Result<(), LoadError> {
        if n > self.bytes_remaining {
            return Err(LoadError::DecodeError(
                "decode byte budget exhausted".into(),
            ));
        }
        self.bytes_remaining -= n;
        Ok(())
    }

    pub(crate) fn charge_atom(&mut self) -> Result<(), LoadError> {
        if self.atoms_remaining == 0 {
            return Err(LoadError::DecodeError(
                "decode atom budget exhausted".into(),
            ));
        }
        self.atoms_remaining -= 1;
        Ok(())
    }

    pub(crate) fn descend(&mut self) -> Result<(), LoadError> {
        if self.depth_remaining == 0 {
            return Err(LoadError::DecodeError("ETF nesting exceeds limit".into()));
        }
        self.depth_remaining -= 1;
        Ok(())
    }

    pub(crate) fn ascend(&mut self) {
        self.depth_remaining = self.depth_remaining.saturating_add(1);
    }
}

impl Default for DecodeBudget {
    fn default() -> Self {
        Self::new(
            MAX_ETF_DEPTH,
            DEFAULT_DECODE_NODE_BUDGET,
            DEFAULT_DECODE_BYTE_BUDGET,
            MAX_ATOMS_PER_MODULE,
        )
    }
}