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
use crate::traversal;
use calyx_ir as ir;
use calyx_utils::{CalyxResult, Error};
use std::collections::{HashMap, HashSet};
use std::fmt::Write as _;
use std::time::Instant;
pub type PassClosure = Box<dyn Fn(&mut ir::Context) -> CalyxResult<()>>;
#[derive(Default)]
pub struct PassManager {
passes: HashMap<String, PassClosure>,
aliases: HashMap<String, Vec<String>>,
help: HashMap<String, String>,
}
impl PassManager {
pub fn register_pass<Pass>(&mut self) -> CalyxResult<()>
where
Pass:
traversal::Visitor + traversal::ConstructVisitor + traversal::Named,
{
let name = Pass::name().to_string();
if self.passes.contains_key(&name) {
return Err(Error::misc(format!(
"Pass with name '{}' is already registered.",
name
)));
}
let pass_closure: PassClosure = Box::new(|ir| {
Pass::do_pass_default(ir)?;
Ok(())
});
self.passes.insert(name.clone(), pass_closure);
let mut help = format!("- {}: {}", name, Pass::description());
for opt in Pass::opts() {
write!(
&mut help,
"\n * {}: {} (default: {})",
opt.name(),
opt.description(),
opt.default()
)
.unwrap();
}
self.help.insert(name, help);
Ok(())
}
pub fn add_alias(
&mut self,
name: String,
passes: Vec<String>,
) -> CalyxResult<()> {
if self.aliases.contains_key(&name) {
return Err(Error::misc(format!(
"Alias with name '{}' already registered.",
name
)));
}
let all_passes = passes
.into_iter()
.flat_map(|pass| {
if self.aliases.contains_key(&pass) {
self.aliases[&pass].clone()
} else if self.passes.contains_key(&pass) {
vec![pass]
} else {
panic!("No pass or alias named: {}", pass)
}
})
.collect();
self.aliases.insert(name, all_passes);
Ok(())
}
pub fn specific_help(&self, pass: &str) -> Option<String> {
self.help.get(pass).cloned().or_else(|| {
self.aliases.get(pass).map(|passes| {
let pass_str = passes
.iter()
.map(|p| format!("- {p}"))
.collect::<Vec<String>>()
.join("\n");
format!("`{pass}' is an alias for pass pipeline:\n{}", pass_str)
})
})
}
pub fn complete_help(&self) -> String {
let mut ret = String::with_capacity(1000);
let mut pass_names = self.passes.keys().collect::<Vec<_>>();
pass_names.sort();
ret.push_str("Passes:\n");
pass_names.iter().for_each(|&pass| {
writeln!(ret, "{}", self.help[pass]).unwrap();
});
let mut aliases = self.aliases.iter().collect::<Vec<_>>();
aliases.sort_by(|kv1, kv2| kv1.0.cmp(kv2.0));
ret.push_str("\nAliases:\n");
aliases.iter().for_each(|(alias, passes)| {
let pass_str = passes
.iter()
.map(|p| p.to_string())
.collect::<Vec<String>>()
.join(", ");
writeln!(ret, "- {}: {}", alias, pass_str).unwrap();
});
ret
}
fn resolve_alias(&self, maybe_alias: &str) -> Vec<String> {
self.aliases
.get(maybe_alias)
.cloned()
.unwrap_or_else(|| vec![maybe_alias.to_string()])
}
fn create_plan(
&self,
incls: &[String],
excls: &[String],
) -> CalyxResult<(Vec<String>, HashSet<String>)> {
let passes = incls
.iter()
.flat_map(|maybe_alias| self.resolve_alias(maybe_alias))
.collect::<Vec<_>>();
let excl_set = excls
.iter()
.flat_map(|maybe_alias| self.resolve_alias(maybe_alias))
.collect::<HashSet<String>>();
passes.iter().chain(excl_set.iter()).try_for_each(|pass| {
if !self.passes.contains_key(pass) {
Err(Error::misc(format!(
"Unknown pass: {pass}. Run compiler with pass-help subcommand to view registered passes."
)))
} else {
Ok(())
}
})?;
Ok((passes, excl_set))
}
pub fn execute_plan(
&self,
ctx: &mut ir::Context,
incl: &[String],
excl: &[String],
dump_ir: bool,
) -> CalyxResult<()> {
let (passes, excl_set) = self.create_plan(incl, excl)?;
for name in passes {
let pass = &self.passes[&name];
if cfg!(not(target_family = "wasm")) {
if !excl_set.contains(&name) {
let start = Instant::now();
pass(ctx)?;
if dump_ir {
ir::Printer::write_context(
ctx,
true,
&mut std::io::stdout(),
)?;
}
let elapsed = start.elapsed();
if elapsed.as_secs() > 5 {
log::warn!("{name}: {}ms", elapsed.as_millis());
} else {
log::info!("{name}: {}ms", start.elapsed().as_millis());
}
} else {
log::info!("{name}: Ignored")
}
} else if !excl_set.contains(&name) {
pass(ctx)?;
}
}
Ok(())
}
}
#[macro_export]
macro_rules! register_alias {
(@unwrap_name $pass:ident) => {
$pass::name().to_string()
};
(@unwrap_name $pass:literal) => {
$pass.to_string()
};
($manager:expr, $alias:literal, [ $($pass:tt),* $(,)? ]) => {
$manager.add_alias($alias.to_string(), vec![
$(register_alias!(@unwrap_name $pass)),*
])?;
};
}