Struct mcircuit::VcdDumper

pub struct VcdDumper { /* private fields */ }

Implementations

impl VcdDumper

pub fn for_circuit(
    writer: BufWriter<File>,
    circuit: &[CombineOperation],
    bool_hasher: &WireHasher,
    arith_hasher: &WireHasher
) -> Self

Uses WireHasher.backref to recover scope information from hashed wires in a circuit. With our circuit pipeline, this is ONLY RELIABLE FOR TOP-LEVEL INPUTS & OUTPUTS because the flattener translates & minimizes all other wires after hashing occurs. Still, it can be useful for diagnosing whether you’re seeing the output you expect when crossing from the boolean to the arithmetic bound, and with changes to the flattener it could be made to work for all wires.

pub fn dump_bool(&mut self, dst: usize, val: bool)

Write a formatted boolean value into the VCD file. Can only be one bit.

pub fn dump_arith(&mut self, dst: usize, val: u64)

Write a 64-bit integer into the VCD file.

pub fn finish(&mut self)

Write the end of the data dump section with some extra timing entries to make gtkwave show a wider display.