Make yxi a standalone tool (#2125)

* create yxi tool * remove yxi feature * change fud2 and runt to use new yxi tool * new runt tests for yxi ref mems * formatting and remove unused mod * more yxi tests and organization * update fud2 snapshot * remove --features yxi from github actions --------- Co-authored-by: Nathaniel Navarro <[email protected]>
calyxir · Jun 11, 2024 · 9a9ddb2 · 9a9ddb2
1 parent be274e6
commit 9a9ddb2
Show file tree

Hide file tree

Showing 32 changed files with 285 additions and 130 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -174,7 +174,7 @@ jobs:
       uses: actions-rs/cargo@v1
       with:
         command: build
-        args: --workspace --features yxi --manifest-path /home/calyx/Cargo.toml
+        args: --workspace --manifest-path /home/calyx/Cargo.toml
 
 #    - name: Source code doc tests
 #      uses: actions-rs/cargo@v1

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -17,6 +17,7 @@ members = [
     "data-conversion",
     "tools/btor2/btor2i",
     "tools/cider-data-converter",
+    "tools/yxi",
 ]
 exclude = ["site"]
 
@@ -92,7 +93,6 @@ path = "src/main.rs"
 [features]
 default = []
 serialize = ["calyx-ir/serialize", "serde/rc", "calyx-backend/sexp"]
-yxi = ["serialize", "calyx-backend/yxi", "calyx-ir/yxi"]
 
 [build-dependencies]
 calyx-stdlib = { path = "calyx-stdlib", version = "0.7.1" }

diff --git a/calyx-backend/Cargo.toml b/calyx-backend/Cargo.toml
@@ -42,4 +42,3 @@ mlir = []
 xilinx = ["dep:quick-xml"]
 resources = ["dep:csv"]
 sexp = ["dep:serde_with", "dep:serde_sexpr", "serde/rc", "calyx-ir/serialize"]
-yxi = ["calyx-ir/yxi"]
diff --git a/calyx-backend/src/backend_opt.rs b/calyx-backend/src/backend_opt.rs
@@ -12,8 +12,6 @@ pub enum BackendOpt {
     Mlir,
     Resources,
     Sexp,
-    #[cfg(feature = "yxi")]
-    Yxi,
     Firrtl,
     PrimitiveUses,
     None,
@@ -30,8 +28,6 @@ fn backends() -> Vec<(&'static str, BackendOpt)> {
         ("mlir", BackendOpt::Mlir),
         ("resources", BackendOpt::Resources),
         ("sexp", BackendOpt::Sexp),
-        #[cfg(feature = "yxi")]
-        ("yxi", BackendOpt::Yxi),
         ("firrtl", BackendOpt::Firrtl),
         ("primitive-uses", BackendOpt::PrimitiveUses),
         ("none", BackendOpt::None),
@@ -75,8 +71,6 @@ impl ToString for BackendOpt {
             Self::Verilog => "verilog",
             Self::Xilinx => "xilinx",
             Self::XilinxXml => "xilinx-xml",
-            #[cfg(feature = "yxi")]
-            Self::Yxi => "yxi",
             Self::Calyx => "calyx",
             Self::Firrtl => "firrtl",
             Self::PrimitiveUses => "primitive-uses",

diff --git a/calyx-backend/src/lib.rs b/calyx-backend/src/lib.rs
@@ -11,11 +11,6 @@ pub use primitive_uses::PrimitiveUsesBackend;
 pub use traits::Backend;
 pub use verilog::VerilogBackend;
 
-#[cfg(feature = "yxi")]
-mod yxi;
-#[cfg(feature = "yxi")]
-pub use yxi::YxiBackend;
-
 #[cfg(feature = "mlir")]
 mod mlir;
 #[cfg(feature = "mlir")]

diff --git a/calyx-backend/src/yxi.rs b/calyx-backend/src/yxi.rs
diff --git a/calyx-ir/src/utils.rs b/calyx-ir/src/utils.rs
@@ -1,7 +1,7 @@
 //! Helpers used to examine calyx programs. Used in Xilinx and Yxi backends among others.
 use super::{BoolAttr, Cell, Component, RRC};
 use calyx_utils::Id;
-#[cfg(feature = "yxi")]
+#[cfg(feature = "serialize")]
 use serde::Serialize;
 
 // Returns Vec<String> of `@external` or `ref` memory names
@@ -25,7 +25,7 @@ pub fn external_and_ref_memories_cells(comp: &Component) -> Vec<RRC<Cell>> {
         .collect()
 }
 
-#[cfg_attr(feature = "yxi", derive(Serialize))]
+#[cfg_attr(feature = "serialize", derive(Serialize))]
 #[derive(Clone, Copy)]
 pub enum MemoryType {
     Combinational,

diff --git a/fud2/src/lib.rs b/fud2/src/lib.rs
@@ -282,8 +282,7 @@ pub fn build_driver(bld: &mut DriverBuilder) {
         e.build_cmd(&[only_refs_calyx], "external-to-ref", &[input], &[])?;
 
         // Get YXI to generate JSON for testbench generation
-        e.build_cmd(&[memories_json], "calyx", &[only_externals_calyx], &[])?;
-        e.arg("backend", "yxi")?;
+        e.build_cmd(&[memories_json], "yxi", &[only_externals_calyx], &[])?;
         // generate custom testbench
         e.build_cmd(
             &[testbench],
@@ -740,15 +739,20 @@ pub fn build_driver(bld: &mut DriverBuilder) {
         },
     );
 
+    let yxi_setup = bld.setup("YXI setup", |e| {
+        e.config_var_or("yxi", "yxi", "$calyx-base/target/debug/yxi")?;
+        e.rule("yxi", "$yxi -l $calyx-base $in > $out")?;
+        Ok(())
+    });
+
     let yxi = bld.state("yxi", &["yxi"]);
     bld.op(
         "calyx-to-yxi",
-        &[calyx_setup],
+        &[calyx_setup, yxi_setup],
         calyx,
         yxi,
         |e, input, output| {
-            e.build_cmd(&[output], "calyx", &[input], &[])?;
-            e.arg("backend", "yxi")?;
+            e.build_cmd(&[output], "yxi", &[input], &[])?;
             Ok(())
         },
     );
@@ -762,6 +766,7 @@ pub fn build_driver(bld: &mut DriverBuilder) {
             "$calyx-base/yxi/axi-calyx/axi-generator.py",
         )?;
         e.config_var_or("python", "python", "python3")?;
+
         e.rule("gen-axi", "$python $axi-generator $in > $out")?;
 
         // Define a simple `combine` rule that just concatenates any numer of files.
@@ -775,7 +780,7 @@ pub fn build_driver(bld: &mut DriverBuilder) {
     });
     bld.op(
         "axi-wrapped",
-        &[calyx_setup, wrapper_setup],
+        &[calyx_setup, yxi_setup, wrapper_setup],
         calyx,
         calyx,
         |e, input, output| {
@@ -790,11 +795,8 @@ pub fn build_driver(bld: &mut DriverBuilder) {
                 .0;
 
             // Get yxi file from main compute program.
-            // TODO(nate): Eventually (#1952) This will be able to use the `yxi` operation
-            // instead of hardcoding the build cmd calyx rule with arguments
             let tmp_yxi = format!("{}.yxi", file_name);
-            e.build_cmd(&[&tmp_yxi], "calyx", &[input], &[])?;
-            e.arg("backend", "yxi")?;
+            e.build_cmd(&[&tmp_yxi], "yxi", &[input], &[])?;
 
             // Generate the AXI wrapper.
             let refified_calyx = format!("refified_{}.futil", file_name);

diff --git a/fud2/tests/snapshots/tests__emit@calyx_firrtl_verilog-refmem.snap b/fud2/tests/snapshots/tests__emit@calyx_firrtl_verilog-refmem.snap
@@ -38,8 +38,7 @@ rule add-verilog-primitives
 # build targets
 build external.futil: ref-to-external stdin
 build ref.futil: external-to-ref stdin
-build memory-info.json: calyx external.futil
-  backend = yxi
+build memory-info.json: yxi external.futil
 build tb.sv: generate-refmem-testbench memory-info.json
 build tmp-out.fir: calyx ref.futil
   backend = firrtl

diff --git a/runt.toml b/runt.toml
@@ -58,12 +58,18 @@ flags=$(head -n 1 {} | cut -c 3-)
 ./target/debug/calyx {} $flags -l .
 """
 
-#yxi is not part of [core]
 [[tests]]
-name = "yxi backend"
-paths = ["yxi/tests/backend/*.futil"]
+name = "yxi tool"
+paths = ["yxi/tests/yxi-tool/*.futil"]
 cmd = """
-./target/debug/calyx {} -b yxi
+./target/debug/yxi {}
+"""
+
+[[tests]]
+name = "fud2 yxi"
+paths = ["yxi/tests/ref-mems-vec-add.futil"]
+cmd = """
+fud2 {} --from calyx --to yxi
 """
 
 ##### Frontend Tests #####
@@ -549,31 +555,31 @@ fud e {} -s verilog.cycle_limit 500 \
 ##### Calyx AXI tests #####
 [[tests]]
 name = "calyx-py AXI wrapper generation"
-paths = ["yxi/tests/*.yxi"]
+paths = ["yxi/tests/axi/*.yxi"]
 cmd = """
 python3 yxi/axi-calyx/axi-generator.py {}
 """
 
 #Ignore fud2 stderr for now due to ninja nondeterminism
 [[tests]]
 name = "fud2 AXI wrapper invocation"
-paths = ["yxi/tests/fud2/seq-mem-vec-add.futil"]
+paths = ["yxi/tests/axi/seq-mem-vec-add.futil"]
 cmd = """
 fud2 {} --to calyx --through axi-wrapped 2> /dev/null
 """
 
 [[tests]]
 name = "fud2 AXI-wrapped to verilog"
-paths = ["yxi/tests/fud2/seq-mem-vec-add-axi-wrapped.futil"]
+paths = ["yxi/tests/axi/seq-mem-vec-add-axi-wrapped.futil"]
 cmd = """
 fud2 {} --from calyx --to verilog-noverify 2> /dev/null
 """
 
 [[tests]]
 name = "fud2 cocotb execution"
-paths = ["yxi/tests/fud2/seq-mem-vec-add-verilog.v"]
+paths = ["yxi/tests/axi/seq-mem-vec-add-verilog.v"]
 cmd = """
-fud2 {} --from verilog-noverify --to cocotb-axi --set sim.data=yxi/tests/fud2/vectorized-add.data 2> /dev/null
+fud2 {} --from verilog-noverify --to cocotb-axi --set sim.data=yxi/tests/axi/vectorized-add.data 2> /dev/null
 """
 
 ##### Xilinx Tests ######

diff --git a/src/cmdline.rs b/src/cmdline.rs
@@ -2,8 +2,6 @@
 use argh::FromArgs;
 #[cfg(feature = "serialize")]
 use calyx_backend::SexpBackend;
-#[cfg(feature = "yxi")]
-use calyx_backend::YxiBackend;
 use calyx_backend::{
     xilinx::{XilinxInterfaceBackend, XilinxXmlBackend},
     Backend, BackendOpt, FirrtlBackend, MlirBackend, PrimitiveUsesBackend,
@@ -173,11 +171,6 @@ impl Opts {
                 let backend = XilinxXmlBackend;
                 backend.run(context, self.output)
             }
-            #[cfg(feature = "yxi")]
-            BackendOpt::Yxi => {
-                let backend = YxiBackend;
-                backend.run(context, self.output)
-            }
             BackendOpt::Firrtl => {
                 let backend = FirrtlBackend;
                 backend.run(context, self.output)

diff --git a/tools/data_gen/src/main.rs b/tools/data_gen/src/main.rs
@@ -77,11 +77,7 @@ fn main() -> CalyxResult<()> {
     let ws = frontend::Workspace::construct(&p.file_path, &p.lib_path)?;
     let ctx: ir::Context = ir::from_ast::ast_to_ir(ws)?;
 
-    let comp = ctx
-        .components
-        .into_iter()
-        .find(|comp| comp.name == ctx.entrypoint)
-        .expect("No top-level component found.");
+    let comp = ctx.entrypoint();
 
     let data_vec: Vec<CellData> =
         comp.cells.iter().filter_map(get_data).collect();

diff --git a/tools/yxi/Cargo.toml b/tools/yxi/Cargo.toml
@@ -0,0 +1,28 @@
+[package]
+name = "yxi"
+authors.workspace = true
+license-file.workspace = true
+keywords.workspace = true
+repository.workspace = true
+readme.workspace = true
+description.workspace = true
+categories.workspace = true
+homepage.workspace = true
+edition.workspace = true
+version.workspace = true
+rust-version.workspace = true
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+serde.workspace = true
+argh.workspace = true
+serde_json = "1.0.79"
+
+calyx-utils = { path = "../../calyx-utils" }
+calyx-frontend = { path = "../../calyx-frontend" }
+calyx-opt = { path = "../../calyx-opt" }
+
+[dependencies.calyx-ir]
+path = "../../calyx-ir"
+features = ["serialize"]