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
250
251
252
253
254
255
256
257
258
use crate::core::dut::Dut;
use crate::core::file_handler::File;
use crate::core::model::pins::StateTracker;
use crate::generator::ast::{Attrs, Node};
use crate::generator::processor::{Processor, Return};
use crate::STATUS;
use crate::{Result, DUT};
use std::collections::HashMap;
use std::path::PathBuf;

use crate::generator::processors::{
    CycleCombiner, FlattenText, PinActionCombiner, TargetTester, UnpackCaptures,
};

pub trait RendererAPI: std::fmt::Debug + crate::core::tester::TesterAPI {
    fn file_ext(&self) -> &str;
    fn comment_str(&self) -> &str;
    fn print_vector(
        &self,
        renderer: &mut Renderer,
        repeat: u32,
        compressable: bool,
    ) -> Option<Result<String>>;
    fn print_pinlist(&self, renderer: &mut Renderer) -> Option<Result<String>>;

    fn override_node(&self, _renderer: &mut Renderer, _node: &Node) -> Option<Result<Return>> {
        None
    }

    fn print_pattern_end(&self, _renderer: &mut Renderer) -> Option<Result<String>> {
        None
    }

    fn to_overlay(&self, _renderer: &mut Renderer, overlay: &str) -> Result<String> {
        Ok(format!("Overlay: {}", overlay))
    }
}

#[derive(Debug, Clone)]
pub struct Renderer<'a> {
    pub tester: &'a dyn RendererAPI,
    pub current_timeset_id: Option<usize>,
    pub path: Option<PathBuf>,
    pub output_file: Option<File>,
    pub states: Option<StateTracker>,
    pub pin_header_printed: bool,
    pub pin_header_id: Option<usize>,
    pub least_cycles_remaining: usize,
    pub capturing: HashMap<Option<usize>, Option<String>>,
    // pub overlaying: HashMap<usize, (usize, Option<String>)>
}

impl<'a> Renderer<'a> {
    pub fn run(tester: &'a dyn RendererAPI, ast: &Node) -> Result<Vec<PathBuf>> {
        // Screen out nodes not relevant to this renderer
        let mut n = TargetTester::run(ast, tester.id())?;

        // Optimize the vectors
        n = PinActionCombiner::run(&n)?;
        n = CycleCombiner::run(&n)?;
        n = UnpackCaptures::run(&n)?;

        // Generate comments
        n = FlattenText::run(&n)?;

        // Finally, generate the output
        let mut p = Self::new(tester);
        if crate::LOGGER.has_keyword("vector_based_dump_final_ast") {
            crate::LOGGER.info("Vector Based Tester- Printing Final AST");
            crate::LOGGER.info(&format!("{}", n));
        }
        n.process(&mut p)?;
        Ok(vec![p.path.unwrap()])
    }

    fn new(tester: &'a dyn RendererAPI) -> Self {
        Self {
            tester: tester,
            current_timeset_id: None,
            path: None,
            output_file: None,
            states: None,
            pin_header_printed: false,
            pin_header_id: None,
            least_cycles_remaining: std::usize::MAX,
            capturing: HashMap::new(),
            // overlaying: HashMap::new()
        }
    }

    pub fn states(&mut self, dut: &Dut) -> &mut StateTracker {
        if self.states.is_none() {
            let model_id;
            if let Some(id) = self.pin_header_id {
                model_id = dut.pin_headers[id].model_id;
            } else {
                model_id = 0;
            }
            self.states = Some(StateTracker::new(model_id, self.pin_header_id, dut));
        }
        self.states.as_mut().unwrap()
    }

    pub fn update_states(
        &mut self,
        grp_id: usize,
        actions: &Vec<String>,
        dut: &Dut,
    ) -> Result<Return> {
        let s = self.states(dut);
        s.update(grp_id, actions, dut)?;
        Ok(Return::Unmodified)
    }

    pub fn render_states(&self) -> Result<String> {
        let dut = DUT.lock().unwrap();
        let t = &dut.timesets[self.current_timeset_id.unwrap()];
        let mut ppin_overrides: HashMap<usize, String> = HashMap::new();
        for (ppin, symbol) in self.capturing.iter() {
            if ppin.is_some() && symbol.is_some() {
                ppin_overrides.insert(ppin.unwrap(), symbol.as_ref().unwrap().to_string());
            }
        }
        Ok(self
            .states
            .as_ref()
            .unwrap()
            .to_symbols(self.tester.name(), &dut, &t, Some(&ppin_overrides))
            .unwrap()
            .join(" "))
    }

    pub fn timeset_name(&self) -> Result<String> {
        let dut = DUT.lock().unwrap();

        let t = &dut.timesets[self
            .current_timeset_id
            .expect("Attempted to retrieve the current timeset name but no timeset has been set")];
        Ok(t.name.clone())
    }
}

impl<'a> Processor for Renderer<'a> {
    fn on_node(&mut self, node: &Node) -> Result<Return> {
        match self.tester.override_node(self, &node) {
            Some(retn) => return retn,
            None => {}
        }

        match &node.attrs {
            Attrs::Test(name) => {
                let _ = STATUS.with_output_dir(false, |dir| {
                    let mut p = dir.to_path_buf();
                    p.push(self.tester.name().to_lowercase());
                    p.push(name);
                    p.set_extension(self.tester.file_ext());
                    self.path = Some(p.clone());
                    self.output_file = Some(File::create(p));
                    Ok(())
                });
                Ok(Return::ProcessChildren)
            }
            Attrs::Comment(_level, msg) => {
                self.output_file.as_mut().unwrap().write_ln(&format!(
                    "{} {}",
                    self.tester.comment_str(),
                    msg
                ));
                Ok(Return::Unmodified)
            }
            Attrs::Text(text) => {
                self.output_file.as_mut().unwrap().write_ln(&format!(
                    "{} {}",
                    self.tester.comment_str(),
                    text
                ));
                Ok(Return::Unmodified)
            }
            Attrs::PatternHeader => Ok(Return::ProcessChildren),
            // Attrs::PinGroupAction(grp_id, actions, _metadata) => {
            //     let dut = DUT.lock().unwrap();
            //     return self.update_states(*grp_id, actions, &dut);
            // },
            Attrs::PinAction(pin_id, action, _metadata) => {
                let dut = DUT.lock().unwrap();
                let pin = &dut.pins[*pin_id];
                let grp_id = dut.get_pin_group(pin.model_id, &pin.name).unwrap().id;
                return self.update_states(grp_id, &vec![action.clone()], &dut);
            }
            Attrs::Capture(capture, _metadata) => {
                if capture.pin_ids.is_some() {
                    for pin in capture.enabled_capture_pins()? {
                        self.capturing.insert(Some(pin), capture.symbol.clone());
                    }
                } else {
                    self.capturing.insert(None, capture.symbol.clone());
                }
                Ok(Return::Unmodified)
            }
            // Attrs::Overlay(overlay, pin_id, action, _) => {
            //     if let Some(o) = overlay {
            //         let ovl = self.tester.to_overlay(self, o)?;
            //         self.output_file.as_mut().unwrap().write_ln(&format!(
            //             "{} {}",
            //             self.tester.comment_str(),
            //             ovl
            //         ));
            //     }
            //     Ok(Return::Unmodified)
            // }
            Attrs::Cycle(repeat, compressable) => {
                if !self.pin_header_printed {
                    match self.tester.print_pinlist(self) {
                        Some(pinlist) => {
                            self.output_file.as_mut().unwrap().write_ln(&pinlist?);
                        }
                        None => {}
                    }
                    self.pin_header_printed = true;
                }

                match self.tester.print_vector(self, *repeat, *compressable) {
                    Some(vector) => {
                        self.output_file.as_mut().unwrap().write_ln(&vector?);
                    }
                    None => {}
                }
                Ok(Return::Unmodified)
            }
            Attrs::SetTimeset(timeset_id) => {
                self.current_timeset_id = Some(*timeset_id);
                Ok(Return::Unmodified)
            }
            Attrs::SetPinHeader(pin_header_id) => {
                self.pin_header_id = Some(*pin_header_id);
                Ok(Return::Unmodified)
            }
            Attrs::EndCapture(pin_id) => {
                self.capturing.remove(&pin_id);
                Ok(Return::Unmodified)
            }
            Attrs::PatternEnd => {
                // Raise an error is any leftover captures remain
                if !self.capturing.is_empty() {
                    return error!("Pattern end reached but requested captures still remain");
                }
                match self.tester.print_pattern_end(self) {
                    Some(end) => {
                        self.output_file.as_mut().unwrap().write_ln(&end?);
                    }
                    None => {}
                }
                Ok(Return::Unmodified)
            }
            _ => Ok(Return::ProcessChildren),
        }
    }
}