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

//! Defines the default passes available to [PassManager].
use crate::passes::{
    AddGuard, Canonicalize, CellShare, ClkInsertion, CollapseControl, CombProp,
    CompileInvoke, CompileRepeat, CompileStatic, CompileSync,
    CompileSyncWithoutSyncReg, ComponentInliner, DataPathInfer,
    DeadAssignmentRemoval, DeadCellRemoval, DeadGroupRemoval, DefaultAssigns,
    DiscoverExternal, ExternalToRef, Externalize, GoInsertion, GroupToInvoke,
    GroupToSeq, HoleInliner, InferShare, LowerGuards, MergeAssign, Papercut,
    ParToSeq, RegisterUnsharing, RemoveIds, ResetInsertion,
    SimplifyStaticGuards, SimplifyWithControl, StaticInference, StaticInliner,
    StaticPromotion, SynthesisPapercut, TopDownCompileControl, UnrollBounded,
    WellFormed, WireInliner, WrapMain,
};
use crate::traversal::Named;
use crate::{pass_manager::PassManager, register_alias};
use calyx_utils::CalyxResult;

impl PassManager {
    pub fn default_passes() -> CalyxResult<Self> {
        // Construct the pass manager and register all passes.
        let mut pm = PassManager::default();

        // Validation passes
        pm.register_pass::<WellFormed>()?;
        pm.register_pass::<Papercut>()?;
        pm.register_pass::<Canonicalize>()?;

        // Optimization passes
        pm.register_pass::<CombProp>()?;
        pm.register_pass::<ComponentInliner>()?;
        pm.register_pass::<CollapseControl>()?;
        pm.register_pass::<DeadAssignmentRemoval>()?;
        pm.register_pass::<DeadCellRemoval>()?;
        pm.register_pass::<DeadGroupRemoval>()?;
        pm.register_pass::<GroupToSeq>()?;
        pm.register_pass::<InferShare>()?;
        pm.register_pass::<CellShare>()?;
        pm.register_pass::<StaticInference>()?;
        pm.register_pass::<StaticPromotion>()?;
        pm.register_pass::<SimplifyStaticGuards>()?;
        pm.register_pass::<DataPathInfer>()?;

        // Compilation passes
        pm.register_pass::<StaticInliner>()?;
        pm.register_pass::<CompileStatic>()?;
        pm.register_pass::<CompileInvoke>()?;
        pm.register_pass::<CompileRepeat>()?;
        pm.register_pass::<SimplifyWithControl>()?;
        pm.register_pass::<TopDownCompileControl>()?;
        pm.register_pass::<CompileSync>()?;
        pm.register_pass::<CompileSyncWithoutSyncReg>()?;
        pm.register_pass::<AddGuard>()?;

        // Lowering passes
        pm.register_pass::<GoInsertion>()?;
        pm.register_pass::<WireInliner>()?;
        pm.register_pass::<ClkInsertion>()?;
        pm.register_pass::<ResetInsertion>()?;
        pm.register_pass::<MergeAssign>()?;
        pm.register_pass::<WrapMain>()?;
        pm.register_pass::<DefaultAssigns>()?;

        // Enabled in the synthesis compilation flow
        pm.register_pass::<SynthesisPapercut>()?;
        pm.register_pass::<Externalize>()?;

        // Disabled by default
        pm.register_pass::<DiscoverExternal>()?;
        pm.register_pass::<UnrollBounded>()?;
        pm.register_pass::<RegisterUnsharing>()?;
        pm.register_pass::<GroupToInvoke>()?;
        pm.register_pass::<ParToSeq>()?;
        pm.register_pass::<LowerGuards>()?;
        pm.register_pass::<HoleInliner>()?;
        pm.register_pass::<RemoveIds>()?;
        pm.register_pass::<ExternalToRef>()?;

        register_alias!(pm, "validate", [WellFormed, Papercut, Canonicalize]);
        register_alias!(
            pm,
            "pre-opt",
            [
                DataPathInfer,
                CollapseControl, // Run it twice: once at beginning of pre-opt, once at end.
                CompileSyncWithoutSyncReg,
                GroupToSeq,
                DeadAssignmentRemoval,
                GroupToInvoke, // Creates Dead Groups potentially
                InferShare,
                ComponentInliner,
                CombProp,
                DeadCellRemoval, // Clean up dead wires left by CombProp
                CellShare,       // LiveRangeAnalaysis should handle comb groups
                SimplifyWithControl, // Must run before compile-invoke
                CompileInvoke,   // creates dead comb groups
                StaticInference,
                StaticPromotion,
                CompileRepeat,
                DeadGroupRemoval, // Since previous passes potentially create dead groups
                CollapseControl,
            ]
        );
        register_alias!(
            pm,
            "compile",
            [
                StaticInliner,
                MergeAssign, // Static inliner generates lots of assigns
                DeadGroupRemoval, // Static inliner generates lots of dead groups
                SimplifyStaticGuards,
                AddGuard,
                CompileStatic,
                DeadGroupRemoval,
                TopDownCompileControl
            ]
        );
        register_alias!(
            pm,
            "post-opt",
            [
                DeadGroupRemoval,
                CombProp,
                DeadAssignmentRemoval,
                DeadCellRemoval
            ]
        );
        register_alias!(
            pm,
            "lower",
            [
                WrapMain,
                GoInsertion,
                WireInliner,
                ClkInsertion,
                ResetInsertion,
                MergeAssign,
                DefaultAssigns,
            ]
        );

        // Default flow
        register_alias!(
            pm,
            "all",
            ["validate", "pre-opt", "compile", "post-opt", "lower",]
        );

        // Compilation flow with no optimizations enables
        register_alias!(
            pm,
            "no-opt",
            [
                "validate",
                CompileSync,
                SimplifyWithControl,
                CompileInvoke,
                "compile",
                "lower"
            ]
        );

        register_alias!(
            pm,
            "external",
            [
                "validate",
                SynthesisPapercut,
                "pre-opt",
                "compile",
                "post-opt",
                "lower",
                Externalize,
            ]
        );

        register_alias!(pm, "none", []);

        Ok(pm)
    }
}