Add --print-ir-before-all command line argument

.gitattributes

@@ -0,0 +1 @@
+xrcf/script/* linguist-vendored

.github/workflows/Release.yml

@@ -1,4 +1,4 @@
-name: Release
+name: release
 
 # The build always runs, but only releases on tag, see the last step.
 on:
@@ -76,7 +76,8 @@ jobs:
         id: release
         shell: bash
 
-      - uses: softprops/action-gh-release@v2
+        # Hardcoded commit hash to mitigate supply chain attacks.
+      - uses: softprops/action-gh-release@01570a1f39cb168c169c802c3bceb9e93fb10974 # v2.1.0
         if: startsWith(github.ref, 'refs/tags/')
         with:
           fail_on_unmatched_files: true

.github/workflows/ci.yml → .github/workflows/check.yml

@@ -1,4 +1,4 @@
-name: ci
+name: check
 
 on:
   push:

arnoldc/src/main.rs

@@ -11,6 +11,7 @@ use std::io::Read;
 use xrcf::convert::RewriteResult;
 use xrcf::init_subscriber;
 use xrcf::Passes;
+use xrcf::TransformOptions;
 
 use crate::transform::parse_and_transform;
 
@@ -33,7 +34,7 @@ struct ArnoldcArgs {
 }
 
 fn cli() -> Command {
-    let cli = Command::new("arnoldc").args(xrcf::default_passes());
+    let cli = Command::new("arnoldc").args(xrcf::default_arguments());
     let cli = ArnoldcArgs::augment_args(cli);
     cli
 }
@@ -74,6 +75,7 @@ fn main() {
         init_tracing(tracing::Level::INFO);
     }
     let passes = passes_from_args(args, matches.clone());
+    let options = TransformOptions::from_args(matches.clone(), passes.clone());
 
     let input = matches.get_one::<String>("input").unwrap();
 
@@ -85,7 +87,7 @@ fn main() {
         std::fs::read_to_string(input).unwrap()
     };
 
-    let result = parse_and_transform(&input_text, &passes).unwrap();
+    let result = parse_and_transform(&input_text, &options).unwrap();
     let result = match result {
         RewriteResult::Changed(op) => op.op.try_read().unwrap().to_string(),
         RewriteResult::Unchanged => input_text.to_string(),
@@ -98,22 +100,36 @@ mod tests {
     use super::*;
     use anyhow::Result;
     use indoc::indoc;
+    use std::panic::Location;
+    use std::sync::Arc;
+    use std::sync::RwLock;
     use xrcf::convert::RewriteResult;
     use xrcf::tester::Tester;
 
-    fn run_app(args: Vec<&str>, input_text: &str) -> Result<RewriteResult> {
+    fn run_app(
+        out: Option<Arc<RwLock<dyn std::io::Write + Send>>>,
+        args: Vec<&str>,
+        input_text: &str,
+    ) -> Result<RewriteResult> {
         let cli = cli();
         let args_owned: Vec<String> = args.iter().map(|&s| s.to_string()).collect();
         let _matches = cli.try_get_matches_from(args_owned)?;
-        let passes = Passes::from_convert_vec(args);
-        let result = parse_and_transform(input_text, &passes)?;
+        let passes = Passes::from_convert_vec(args.clone());
+        let mut options = TransformOptions::from_passes(passes.clone());
+        if args.contains(&"--print-ir-before-all") {
+            options.set_print_ir_before_all(true);
+        }
+        if let Some(out) = out {
+            options.set_writer(out);
+        }
+        let result = parse_and_transform(input_text, &options)?;
         Ok(result)
     }
 
     #[test]
     fn test_help() {
         let args = vec!["xr-example", "--help"];
-        let result = run_app(args, "");
+        let result = run_app(None, args, "");
         let err = match result {
             Ok(_) => panic!("Expected an error"),
             Err(e) => e,
@@ -126,7 +142,8 @@ mod tests {
 
     #[test]
     fn test_invalid_args() {
-        let result = run_app(vec!["xr-example", "--invalid-flag"], "");
+        let args = vec!["xr-example", "--invalid-flag"];
+        let result = run_app(None, args, "");
         assert!(result.is_err());
     }
 
@@ -141,9 +158,14 @@ mod tests {
         "#
         };
         // The order of these passes is important.
-        let args = vec!["--convert-func-to-llvm", "--convert-mlir-to-llvmir"];
+        let args = vec![
+            "--convert-func-to-llvm",
+            "--convert-mlir-to-llvmir",
+            "--print-ir-before-all",
+        ];
         tracing::info!("\nBefore {args:?}:\n{src}");
-        let result = run_app(args.clone(), src);
+        let out: Arc<RwLock<Vec<u8>>> = Arc::new(RwLock::new(Vec::new()));
+        let result = run_app(Some(out.clone()), args.clone(), &src);
         assert!(result.is_ok());
         let actual = match result.unwrap() {
             RewriteResult::Changed(op) => {
@@ -154,5 +176,13 @@ mod tests {
         };
         tracing::info!("\nAfter {args:?}:\n{actual}");
         assert!(actual.contains("define i32 @main"));
+
+        let printed = out.try_read().unwrap();
+        let printed = String::from_utf8(printed.clone()).unwrap();
+        let expected = indoc! {r#"
+        // ----- // IR Dump before convert-func-to-llvm //----- //
+        // ----- // IR Dump before convert-mlir-to-llvmir //----- //
+        "#};
+        Tester::check_lines_contain(&printed, expected, Location::caller());
     }
 }

arnoldc/src/transform.rs

@@ -16,10 +16,9 @@ use xrcf::parser::ParserDispatch;
 use xrcf::parser::TokenKind;
 use xrcf::transform;
 use xrcf::DefaultTransformDispatch;
-use xrcf::Passes;
 use xrcf::SinglePass;
 use xrcf::TransformDispatch;
-
+use xrcf::TransformOptions;
 pub struct ArnoldParserDispatch;
 
 fn is_function_call<T: ParserDispatch>(parser: &Parser<T>) -> bool {
@@ -123,10 +122,10 @@ fn preprocess(src: &str) -> String {
     result
 }
 
-pub fn parse_and_transform(src: &str, passes: &Passes) -> Result<RewriteResult> {
+pub fn parse_and_transform(src: &str, options: &TransformOptions) -> Result<RewriteResult> {
     let src = preprocess(src);
     let op = Parser::<ArnoldParserDispatch>::parse(&src)?;
-    let result = transform::<ArnoldTransformDispatch>(op, passes)?;
+    let result = transform::<ArnoldTransformDispatch>(op, options)?;
     Ok(result)
 }
 
@@ -138,6 +137,7 @@ mod tests {
     use std::panic::Location;
     use tracing;
     use xrcf::tester::Tester;
+    use xrcf::Passes;
 
     fn flags() -> Vec<&'static str> {
         vec!["--convert-arnold-to-mlir"]
@@ -195,12 +195,14 @@ mod tests {
     fn print_heading(msg: &str, src: &str, passes: &Passes) {
         tracing::info!("{msg} ({passes}):\n```\n{src}\n```\n");
     }
+
     fn test_transform(src: &str, passes: Vec<&str>) -> (Arc<RwLock<dyn Op>>, String) {
         Tester::init_tracing();
         let src = src.trim();
         let passes = Passes::from_vec(passes);
         print_heading("Before", src, &passes);
-        let result = parse_and_transform(src, &passes).unwrap();
+        let options = TransformOptions::from_passes(passes.clone());
+        let result = parse_and_transform(src, &options).unwrap();
         let new_root_op = match result {
             RewriteResult::Changed(changed_op) => changed_op.op,
             RewriteResult::Unchanged => {

xrcf-bin/src/main.rs

@@ -9,6 +9,7 @@ use xrcf::parser::Parser;
 use xrcf::transform;
 use xrcf::DefaultTransformDispatch;
 use xrcf::Passes;
+use xrcf::TransformOptions;
 
 /// An example XRCF compiler that contains all default passes
 #[derive(Args, Debug)]
@@ -23,7 +24,7 @@ struct XRCFArgs {
 }
 
 fn cli() -> Command {
-    let cli = Command::new("xrcf").args(xrcf::default_passes());
+    let cli = Command::new("xrcf").args(xrcf::default_arguments());
     let cli = XRCFArgs::augment_args(cli);
     cli
 }
@@ -32,10 +33,10 @@ fn remove_comments(src: &str) -> String {
     src.lines().filter(|line| !line.starts_with("//")).collect()
 }
 
-fn parse_and_transform(src: &str, passes: &Passes) -> String {
+fn parse_and_transform(src: &str, options: &TransformOptions) -> String {
     let src = remove_comments(src);
     let module = Parser::<DefaultParserDispatch>::parse(&src).unwrap();
-    let result = transform::<DefaultTransformDispatch>(module, &passes).unwrap();
+    let result = transform::<DefaultTransformDispatch>(module, options).unwrap();
     let result = match result {
         RewriteResult::Changed(op) => op.op.try_read().unwrap().to_string(),
         RewriteResult::Unchanged => src.to_string(),
@@ -55,6 +56,7 @@ fn main() {
     let args = std::env::args_os();
     let passes = Passes::from_convert_args(args);
     let matches = cli.get_matches();
+    let options = TransformOptions::from_args(matches.clone(), passes.clone());
     if matches.get_flag("debug") {
         init_tracing(tracing::Level::DEBUG);
     } else {
@@ -71,7 +73,7 @@ fn main() {
         std::fs::read_to_string(input).unwrap()
     };
 
-    let result = parse_and_transform(&input_text, &passes);
+    let result = parse_and_transform(&input_text, &options);
     println!("{result}");
 }
 
@@ -85,7 +87,8 @@ mod tests {
         let args_owned: Vec<String> = args.iter().map(|&s| s.to_string()).collect();
         let _matches = cli.try_get_matches_from(args_owned)?;
         let passes = Passes::from_convert_vec(args);
-        let result = parse_and_transform(input_text, &passes);
+        let options = TransformOptions::from_args(_matches.clone(), passes.clone());
+        let result = parse_and_transform(input_text, &options);
         Ok(result)
     }
 

xrcf/script/release.sh

@@ -4,7 +4,7 @@
 # Trigger a release
 #
 
-set -e
+set -e -u -o pipefail
 
 # We have to run this locally because tags created from workflows do not
 # trigger new workflows.
@@ -28,7 +28,11 @@ echo ""
 echo "ENSURE 'cargo publish' SUCCEEDED"
 echo ""
 
-NOTES="See [CHANGELOG.md](https://github.com/rikhuijzer/xrcf/blob/main/CHANGELOG.md) for more information."
+NOTES="\`xrcf-bin\` is a compiler that can compile basic MLIR programs to LLVM IR, and can be used for testing the xrcf package. This binary contains all the default passes such as \`--convert-func-to-llvm\`.
+
+\`arnoldc\` is a compiler that can compile basic ArnoldC programs to LLVM IR. Next to the default passes, this binary contains the pass \`--convert-arnold-to-mlir\` which can lower ArnoldC programs to MLIR. From there, the default passes such as \`--convert-func-to-llvm\` can be used to lower ArnoldC to LLVM IR.
+
+See [CHANGELOG.md](https://github.com/rikhuijzer/xrcf/blob/main/CHANGELOG.md) for more information about changes since the last release."
 
 echo "Ready to create a new tag, which WILL TRIGGER A RELEASE with the following release notes:"
 echo "\"$NOTES\""

xrcf/src/lib.rs

@@ -48,13 +48,14 @@ pub mod targ3t;
 pub mod tester;
 mod transform;
 
-pub use transform::default_passes;
+pub use transform::default_arguments;
 pub use transform::init_subscriber;
 pub use transform::transform;
 pub use transform::DefaultTransformDispatch;
 pub use transform::Passes;
 pub use transform::SinglePass;
 pub use transform::TransformDispatch;
+pub use transform::TransformOptions;
 
 /// Dialects can define new operations, attributes, and types.
 /// Each dialect is given an unique namespace that is prefixed.

xrcf/src/tester.rs

@@ -9,6 +9,7 @@ use crate::parser::Parser;
 use crate::transform;
 use crate::DefaultTransformDispatch;
 use crate::Passes;
+use crate::TransformOptions;
 use std::cmp::max;
 use std::panic::Location;
 use std::sync::Arc;
@@ -122,7 +123,8 @@ impl Tester {
             }
         }
         let passes = Passes::from_convert_vec(arguments.clone());
-        let result = transform::<DefaultTransformDispatch>(module.clone(), &passes).unwrap();
+        let options = TransformOptions::from_passes(passes);
+        let result = transform::<DefaultTransformDispatch>(module.clone(), &options).unwrap();
         let new_root_op = match result {
             RewriteResult::Changed(changed_op) => changed_op.op,
             RewriteResult::Unchanged => {