orca_wasm/subiterator/
component_subiterator.rs

1//! SubIterator for a Component
2
3use crate::ir::id::{FunctionID, ModuleID};
4use crate::ir::types::Location;
5use crate::subiterator::module_subiterator::ModuleSubIterator;
6use std::collections::HashMap;
7
8/// Sub-iterator for a Component. Keeps track of current location in a Component.
9pub struct ComponentSubIterator {
10    /// The current module the SubIterator is at.
11    curr_mod: ModuleID,
12    /// The total number of modules in the component.
13    num_mods: usize,
14    /// The module iterator used to keep track of the location in the module.
15    pub(crate) mod_iterator: ModuleSubIterator,
16    /// Metadata that maps Module Index -> Vec<(Function Index, Instruction Index)>
17    metadata: HashMap<ModuleID, Vec<(FunctionID, usize)>>,
18    /// Map of Module -> Functions to skip in that module. Provide an empty HashMap if no functions are to be skipped.
19    skip_funcs: HashMap<ModuleID, Vec<FunctionID>>,
20}
21
22impl ComponentSubIterator {
23    /// Creates a new ComponentSubIterator
24    pub fn new(
25        curr_mod: ModuleID,
26        num_mods: usize,
27        metadata: HashMap<ModuleID, Vec<(FunctionID, usize)>>,
28        skip_funcs: HashMap<ModuleID, Vec<FunctionID>>,
29    ) -> Self {
30        // Get current skip func
31        // initializes to the first module
32        ComponentSubIterator {
33            curr_mod,
34            num_mods,
35            metadata: metadata.clone(),
36            mod_iterator: ModuleSubIterator::new(
37                (*metadata.get(&curr_mod).unwrap()).clone(),
38                match skip_funcs.contains_key(&curr_mod) {
39                    true => skip_funcs.get(&curr_mod).unwrap().clone(),
40                    false => vec![],
41                },
42            ),
43            skip_funcs,
44        }
45    }
46
47    /// Resets the ComponentSubIterator and all child SubIterators
48    pub fn reset(&mut self) {
49        *self.curr_mod = 0;
50        self.mod_iterator
51            .reset_from_comp_iterator((*self.metadata.get(&self.curr_mod).unwrap()).clone());
52    }
53
54    /// Goes to the next module enclosed by the component
55    fn next_module(&mut self) -> bool {
56        *self.curr_mod += 1;
57        if *self.curr_mod < self.num_mods as u32 {
58            let met = self.metadata.get(&self.curr_mod).unwrap().clone();
59            // If we're defining a new module, we have to reset function
60            self.mod_iterator = ModuleSubIterator::new(
61                met,
62                match self.skip_funcs.contains_key(&self.curr_mod) {
63                    true => self.skip_funcs.get(&self.curr_mod).unwrap().clone(),
64                    false => vec![],
65                },
66            );
67            true
68        } else {
69            false
70        }
71    }
72
73    /// Gets the index of the current module in the component
74    pub fn curr_mod_idx(&self) -> ModuleID {
75        self.curr_mod
76    }
77
78    /// Gets the index of the current function in the current module
79    pub fn curr_func_idx(&self) -> FunctionID {
80        self.mod_iterator.get_curr_func().0
81    }
82
83    /// Gets the index of the current instruction in the current function
84    pub fn curr_instr_idx(&self) -> usize {
85        self.mod_iterator.func_iterator.curr_instr
86    }
87
88    /// Checks if the SubIterator has finished traversing all the modules
89    pub fn end(&self) -> bool {
90        *self.curr_mod as usize == self.num_mods
91    }
92
93    /// Returns the Current Location as a Location and a bool value that
94    /// says whether the location is at the end of the function.
95    pub fn curr_loc(&self) -> (Location, bool) {
96        if let (
97            Location::Module {
98                func_idx,
99                instr_idx,
100            },
101            is_end,
102        ) = self.mod_iterator.curr_loc()
103        {
104            (
105                Location::Component {
106                    mod_idx: self.curr_mod,
107                    func_idx,
108                    instr_idx,
109                },
110                is_end,
111            )
112        } else {
113            panic!("Should have gotten Module Location from Module Iterator and not Component Location!");
114        }
115    }
116
117    #[allow(clippy::should_implement_trait)]
118    /// Goes to the next instruction in the component
119    pub fn next(&mut self) -> bool {
120        if self.mod_iterator.has_next() {
121            self.mod_iterator.next()
122        } else {
123            self.next_module()
124        }
125    }
126}
orca_wasm/subiterator/component_subiterator.rs

orca_wasm/subiterator/
component_subiterator.rs
