sway-ir 0.71.0

Sway intermediate representation.
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

//! The main handle to an IR instance.
//!
//! [`Context`] contains several
//! [slotmap](https://github.com/orlp/slotmap) collections to maintain the
//! IR ECS.
//!
//! It is passed around as a mutable reference to many of the Sway-IR APIs.

use rustc_hash::FxHashMap;
use slotmap::{DefaultKey, SlotMap};
use sway_features::ExperimentalFeatures;
use sway_types::SourceEngine;

use crate::{
    block::BlockContent,
    function::FunctionContent,
    metadata::Metadatum,
    module::{Kind, ModuleContent, ModuleIterator},
    value::ValueContent,
    variable::LocalVarContent,
    Constant, ConstantContent, GlobalVarContent, StorageKeyContent, Type, TypeContent,
};

// Copy of `sway_core::build_config::Backtrace`, which cannot
// be used here directly due to circular dependency.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum Backtrace {
    All,
    #[default]
    AllExceptNever,
    OnlyAlways,
    None,
}

/// The main IR context handle.
///
/// Every module, function, block and value is stored here.  Some aggregate metadata is also
/// managed by the context.
pub struct Context<'eng> {
    pub source_engine: &'eng SourceEngine,

    pub(crate) modules: SlotMap<DefaultKey, ModuleContent>,
    pub(crate) functions: SlotMap<DefaultKey, FunctionContent>,
    pub(crate) blocks: SlotMap<DefaultKey, BlockContent>,
    pub(crate) values: SlotMap<DefaultKey, ValueContent>,
    pub(crate) local_vars: SlotMap<DefaultKey, LocalVarContent>,
    pub(crate) global_vars: SlotMap<DefaultKey, GlobalVarContent>,
    pub(crate) storage_keys: SlotMap<DefaultKey, StorageKeyContent>,
    pub(crate) types: SlotMap<DefaultKey, TypeContent>,
    pub(crate) type_map: FxHashMap<TypeContent, Type>,
    pub(crate) constants: SlotMap<DefaultKey, ConstantContent>,
    // Maps the hash of a ConstantContent to the list of constants with that hash.
    pub(crate) constants_map: FxHashMap<u64, Vec<Constant>>,

    pub(crate) metadata: SlotMap<DefaultKey, Metadatum>,

    pub program_kind: Kind,

    pub experimental: ExperimentalFeatures,
    pub backtrace: Backtrace,

    next_unique_sym_tag: u64,
    next_unique_panic_error_code: u64,
    next_unique_panicking_call_id: u64,
}

impl<'eng> Context<'eng> {
    pub fn new(
        source_engine: &'eng SourceEngine,
        experimental: ExperimentalFeatures,
        backtrace: Backtrace,
    ) -> Self {
        let mut def = Self {
            source_engine,
            modules: Default::default(),
            functions: Default::default(),
            blocks: Default::default(),
            values: Default::default(),
            local_vars: Default::default(),
            global_vars: Default::default(),
            storage_keys: Default::default(),
            types: Default::default(),
            type_map: Default::default(),
            constants: Default::default(),
            constants_map: Default::default(),
            metadata: Default::default(),
            next_unique_sym_tag: 0,
            next_unique_panic_error_code: 0,
            // The next unique panicking call ID starts at 1, as 0 is reserved
            // for the "there was no panicking call" case.
            next_unique_panicking_call_id: 1,
            program_kind: Kind::Contract,
            experimental,
            backtrace,
        };
        Type::create_basic_types(&mut def);
        def
    }

    pub fn source_engine(&self) -> &'eng SourceEngine {
        self.source_engine
    }

    /// Return an iterator for every module in this context.
    pub fn module_iter(&self) -> ModuleIterator {
        ModuleIterator::new(self)
    }

    /// Get a globally unique symbol.
    ///
    /// The name will be in the form `"anon_N"`, where `N` is an incrementing decimal.
    pub fn get_unique_name(&mut self) -> String {
        format!("anon_{}", self.get_unique_symbol_id())
    }

    /// Get a globally unique symbol id.
    pub fn get_unique_symbol_id(&mut self) -> u64 {
        let sym = self.next_unique_sym_tag;
        self.next_unique_sym_tag += 1;
        sym
    }

    /// Get the next, unique, panic error code.
    pub fn get_unique_panic_error_code(&mut self) -> u64 {
        let code = self.next_unique_panic_error_code;
        self.next_unique_panic_error_code += 1;
        code
    }

    /// Get the next, unique, panicking call ID.
    pub fn get_unique_panicking_call_id(&mut self) -> u64 {
        let id = self.next_unique_panicking_call_id;
        self.next_unique_panicking_call_id += 1;
        id
    }
}

use std::fmt::{Display, Error, Formatter};

impl Display for Context<'_> {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
        write!(f, "{}", crate::printer::to_string(self))
    }
}

impl From<Context<'_>> for String {
    fn from(context: Context) -> Self {
        crate::printer::to_string(&context)
    }
}