celox 0.4.3

Celox HDL Simulator
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

use crate::HashMap;
use crate::ir::{ModuleId, SimModule, SourceAddr, SourceVarId};
use celox_design::RegionedAbsoluteAddrBase;
use celox_slt::{LogicPath, SLTNodeArena};
mod output;

/// One native JIT block selected by an external profile.
///
/// Function names are the names used in the JIT perf map (for example
/// `eval_comb_apply_ff`), not just a block number.  Block numbers are only
/// unique within one emitted function.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct NativeProfileBlock {
    pub function: String,
    pub block: u32,
    pub samples: u64,
}

#[derive(Debug, Clone, Default)]
pub struct TraceOptions {
    pub sim_modules: bool,
    pub pre_atomized_comb_blocks: bool,
    pub atomized_comb_blocks: bool,
    pub flattened_comb_blocks: bool,
    pub scheduled_units: bool,
    pub pre_optimized_sir: bool,
    pub post_optimized_sir: bool,
    pub analyzer_ir: bool,
    pub pre_optimized_clif: bool,
    pub post_optimized_clif: bool,
    pub native: bool,
    pub mir: bool,
    pub native_profile_blocks: Vec<NativeProfileBlock>,
    pub output_to_stdout: bool,
}

#[derive(Debug, Clone, Default)]
pub struct CompilationTrace {
    pub sim_modules: Option<HashMap<ModuleId, SimModule>>,
    pub pre_atomized_comb_blocks: Option<(Vec<LogicPath<SourceAddr>>, SLTNodeArena<SourceAddr>)>,
    pub atomized_comb_blocks: Option<(Vec<LogicPath<SourceAddr>>, SLTNodeArena<SourceAddr>)>,
    pub flattened_comb_blocks: Option<(Vec<LogicPath<SourceAddr>>, SLTNodeArena<SourceAddr>)>,
    pub scheduled_units:
        Option<Vec<celox_sir::ExecutionUnit<RegionedAbsoluteAddrBase<SourceVarId>>>>,
    pub pre_optimized_sir: Option<crate::ir::UnoptimizedSir>,
    pub post_optimized_sir: Option<crate::ir::OptimizedSir>,
    /// SIR after native EU merging, StateSSA promotion, and merged-chain
    /// cleanup, captured from the exact functions passed to instruction
    /// selection.
    pub native_optimized_sir: Option<String>,
    pub analyzer_ir: Option<String>,
    pub pre_optimized_clif: Option<String>,
    pub post_optimized_clif: Option<String>,
    pub native: Option<String>,
    pub mir: Option<String>,
    /// Sparse FF/comb dependency projection captured before merged-chain
    /// rewrites, with exact source-EU and StateSSA provenance.
    pub reactive_event_graph: Option<String>,
    /// Analysis of profile-selected native state accesses captured from the
    /// exact merged SIR used by instruction selection.
    pub native_state_layout: Option<String>,
}

impl TraceOptions {
    pub(crate) fn frontend(
        &self,
        diagnostics: &crate::RuntimeDiagnostics,
    ) -> celox_frontend_core::FrontendTraceOptions {
        celox_frontend_core::FrontendTraceOptions {
            phase_timing: diagnostics.phase_timing,
            sim_modules: self.sim_modules,
            pre_atomized_comb_blocks: self.pre_atomized_comb_blocks,
            atomized_comb_blocks: self.atomized_comb_blocks,
            flattened_comb_blocks: self.flattened_comb_blocks,
            scheduled_units: self.scheduled_units,
        }
    }
}

impl CompilationTrace {
    pub(crate) fn absorb_frontend(&mut self, trace: celox_frontend_core::FrontendTrace) {
        self.sim_modules = trace.sim_modules;
        self.pre_atomized_comb_blocks = trace.pre_atomized_comb_blocks;
        self.atomized_comb_blocks = trace.atomized_comb_blocks;
        self.flattened_comb_blocks = trace.flattened_comb_blocks;
        self.scheduled_units = trace.scheduled_units;
    }
}

#[cfg(feature = "host-runtime")]
pub struct CompilationTraceResult {
    pub res: Result<crate::simulator::Simulator, crate::simulator::SimulatorError>,
    pub trace: CompilationTrace,
}

#[cfg(feature = "host-runtime")]
impl CompilationTraceResult {
    pub fn expect(self, msg: &str) -> crate::simulator::Simulator {
        match self.res {
            Ok(sim) => sim,
            Err(err) => {
                self.trace.print();
                panic!("{}: {:?}", msg, err);
            }
        }
    }

    pub fn unwrap(self) -> crate::simulator::Simulator {
        match self.res {
            Ok(sim) => sim,
            Err(err) => {
                self.trace.print();
                panic!("{:?}", err);
            }
        }
    }
}