merge main

Author: trdavidt

.gitignore

@@ -26,3 +26,6 @@ Cargo.lock
 
 # temporary files
 *.bin
+
+.vscode/
+test_binary_translate*

README.md

@@ -1,2 +1,14 @@
 # binary-room
+
+[![Tests](https://github.com/Samir-Rashid/binary-room/actions/workflows/cargo_test.yml/badge.svg)](https://github.com/Samir-Rashid/binary-room/actions/workflows/cargo_test.yml)
+
 Binary translator from RISC-V to ARM written in Rust
+
+
+## Testing
+
+To get all the cross-compiling dependencies, enter the nix shell using `nix develop`.
+
+`cargo test -- --nocapture`
+
+Then run `./run.sh filename` to assemble and run the file.

flake.nix

@@ -1,3 +1,5 @@
+# dual cross compile toolchain
+# https://github.com/noteed/riscv-hello-asm/blob/main/shell.nix
 {
   description = "binary-room";
 
@@ -35,6 +37,8 @@
             ];
             packages = with pkgs; [
               rust-analyzer-nightly
+              clang-tools
+              hyperfine # benchmarking tool
             ];
           };
         }

run.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+ASM_FILE=$1
+PLATFORM=""
+LD_FLAGS=""
+BENCHMARKING="false" # "true" to enable
+
+if [[ -z "$ASM_FILE" ]]; then
+    echo "Error: Assembly (.S) file is not passed in."
+    echo "Usage: ./run.sh test_binary_translate_add.S"
+    exit 1
+fi
+
+if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+    PLATFORM="aarch64-linux-gnu"
+fi
+
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    LD_FLAGS="-lSystem -macosx_version_min 11.3 -L/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib"
+fi
+
+
+"$PLATFORM"as "$ASM_FILE" -o "$ASM_FILE".as || { echo "Assembly compilation failed"; exit 1; }
+"$PLATFORM"ld "$ASM_FILE".as -o "$ASM_FILE".bin $LD_FLAGS || { echo "Linking failed"; exit 1; }
+
+./"$ASM_FILE".bin
+echo "$?"
+
+if [ "$BENCHMARKING" = true ]; then
+    hyperfine -r 1000 -w 100 -Ni ./"$ASM_FILE".bin
+fi