Add script to compile and generete debug files (#1350)

* add script to compile and generete debug files

* fmt

* add cleaning

* save everything and delete the shared library generated

* simplify

* remove contract-utils folder and add the binaries directly

* review changes in script

* remove unused varriable

* use the > operator instead of >> to avoid appending duplicates

* extract class hash name without any extension

Author: FrancoGiachetta

Cargo.lock

@@ -186,7 +186,7 @@ name = "libfuncs"
 harness = false
 
 [workspace]
-members = ["debug_utils/sierra-emu", "debug_utils/casm-data-flow"]
+members = ["debug_utils", "debug_utils/sierra-emu", "debug_utils/casm-data-flow"]
 
 [workspace.dependencies]
 sierra-emu = { path = "debug_utils/sierra-emu", version = "0.6.0" }

Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "debug_utils"
+version.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+
+[dependencies]
+clap = { version = "4.5.26", features = ["derive"] }
+cairo-lang-starknet-classes.workspace = true
+serde_json = "1.0.135"

debug_utils/Cargo.toml

@@ -0,0 +1,27 @@
+use std::fs::File;
+
+use cairo_lang_starknet_classes::contract_class::ContractClass;
+use clap::{command, Parser};
+
+/// Extracts sierra program from contract
+#[derive(Parser, Debug)]
+#[command(version, about, long_about = None)]
+struct Args {
+    // Path to cairo contract
+    contract_path: String,
+}
+
+fn main() {
+    let args = Args::parse();
+
+    let contract_file = File::open(args.contract_path).expect("failed to open contract file");
+
+    let contract: ContractClass =
+        serde_json::from_reader(contract_file).expect("failed to parse contract");
+
+    let sierra = contract
+        .extract_sierra_program()
+        .expect("failed to extract sierra program");
+
+    print!("{}", sierra);
+}

debug_utils/src/bin/contract-to-sierra.rs

@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+set -e
+
+print_usage() {
+cat <<EOF 
+Expected 3 arguments, received $1.
+
+Usage: $0 <contract_class_path> <opt_lvl> <output_directory>
+
+Compiles a Sierra Contract Class, generates the MLIR and LLVMIR files 
+and saves then along with the Sierra and CASM files in <output_directory>/.
+
+EOF
+}
+
+if ! [ "$#" -ge "3" ]; then
+    print_usage $#
+    exit 1
+fi
+
+if ! [ -d "cairo2/" ]; then
+    echo "cairo2/ directory is not present, please run make deps"
+    exit 1
+fi
+
+if [[ -z "${LLVM_SYS_191_PREFIX}" || -z "${MLIR_SYS_190_PREFIX}" || -z "${TABLEGEN_190_PREFIX}" ]]; then
+    echo "Could not find a suitable LLVM 19 toolchain, please the following env vars pointing to the LLVM 19 dir:
+        - LLVM_SYS_191_PREFIX
+        - MLIR_SYS_190_PREFIX
+        - TABLEGEN_190_PREFIX"
+    exit 1
+fi
+
+CONTRACT_PATH=$1
+OPT_LVL=$2 
+DEST_DIR=$3
+CONTRACT_CLASS_FILE=$(basename $CONTRACT_PATH)
+CLASS_HASH=${CONTRACT_CLASS_FILE%.*.*}
+SIERRA_PATH=$CLASS_HASH.sierra
+CASM_PATH=$CLASS_HASH.casm
+
+# Extract the sierra from the contract class.
+cargo run -p debug_utils --bin contract-to-sierra $CONTRACT_PATH > $SIERRA_PATH
+
+# Lower sierra to casm
+./cairo2/bin/sierra-compile $SIERRA_PATH $CASM_PATH
+
+echo "Compiling contract class..."
+# Set NATIVE_DEBUG_DUMP to generate mlir files.
+NATIVE_DEBUG_DUMP=true cargo run --release --bin starknet-native-compile -- -O $OPT_LVL $CONTRACT_PATH output
+
+echo "Converting optimized mlir into llvmir unoptimized..."
+$LLVM_SYS_191_PREFIX/bin/mlir-translate -mlir-to-llvmir dump.mlir > dump-prepass.ll
+
+echo "Optimizing llvmir..."
+$LLVM_SYS_191_PREFIX/bin/opt dump-prepass.ll -passes="default<O$OPT_LVL>" -S -o dump-opt.ll
+
+echo "Saving generated files"
+mkdir $DEST_DIR
+mv $SIERRA_PATH $CASM_PATH $DEST_DIR 
+mv dump.mlir dump-debug-pretty.mlir dump-prepass-debug-pretty.mlir dump-prepass.ll dump-opt.ll dump-debug.mlir dump-prepass.mlir dump-prepass-debug-valid.mlir $DEST_DIR 
+
+echo "Cleaning..."
+rm output.json
+rm output