benchmarking: improve cross compile and testing (#9)

* test: prepare cross compile automation

* build: finally fix cross compile

* test: run add and print thousands of times

To support better benchmarking, loop the `main`
function thousands of times.

* test: improve benchmarking different architectures, remove arm asms

Author: Samir-Rashid

.gitignore

@@ -26,6 +26,9 @@ Cargo.lock
 
 # temporary files
 *.bin
+*.arm.s
+*.as
+a.out
 
 .vscode/
 test_binary_translate*

run.sh

@@ -1,18 +1,34 @@
 #!/usr/bin/env bash
 
-ASM_FILE=$1
+ARCH=$1
+ASM_FILE=$2
 PLATFORM=""
 LD_FLAGS=""
-BENCHMARKING="false" # "true" to enable
+BENCHMARKING="true" # "true" to enable
+QEMU=""
 
-if [[ -z "$ASM_FILE" ]]; then
-    echo "Error: Assembly (.S) file is not passed in."
-    echo "Usage: ./run.sh test_binary_translate_add.S"
+if [[ -z "$ARCH" || -z "$ASM_FILE" ]]; then
+    echo "Error: Architecture and assembly (.S) file must be provided."
+    echo "Usage: ./run.sh [riscv|arm] <assembly_file.S>"
     exit 1
 fi
 
-if [[ "$OSTYPE" == "linux-gnu"* ]]; then
-    PLATFORM="aarch64-linux-gnu"
+if [[ "$ARCH" != "riscv" && "$ARCH" != "arm" ]]; then
+    echo "Error: Architecture must be either 'riscv' or 'arm'."
+    echo "Usage: ./run.sh [riscv|arm] <assembly_file.S>"
+    exit 1
+fi
+
+if [[ "$ARCH" == "riscv" ]]; then
+    QEMU="qemu-riscv64"
+    if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+        PLATFORM="riscv64-unknown-linux-gnu-"
+    fi
+elif [[ "$ARCH" == "arm" ]]; then
+    QEMU="qemu-aarch64"
+    if [[ "$OSTYPE" == "linux-gnu"* ]]; then
+        PLATFORM="aarch64-unknown-linux-gnu-"
+    fi
 fi
 
 if [[ "$OSTYPE" == "darwin"* ]]; then
@@ -23,9 +39,10 @@ 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
+"$QEMU" ./"$ASM_FILE".bin
 echo "$?"
 
 if [ "$BENCHMARKING" = true ]; then
-    hyperfine -r 1000 -w 100 -Ni ./"$ASM_FILE".bin
+    hyperfine -r 1000 -w 100 -Ni ""$QEMU" ./"$ASM_FILE".bin"
 fi
+

src/utils.rs

@@ -2,7 +2,68 @@ use std::fs;
 
 use crate::{instruction::RiscVInstruction, translate::translate_instrs};
 
-pub const START: &str = r#"
+/// Loop main() 10,000 times. Uses a3.
+pub const RISCV_LOOP_START: &str = r#"
+.text
+
+.global _start
+.global _main
+
+.balign 4 # not sure if these are needed for RISC-V
+_start:
+   # while i < 10,000
+    li a3, 10000
+.loop:
+    addi a3, a3, -1
+    ble a3, x0, .end
+
+    # main()
+    jal ra, main
+
+    # while loop
+    j .loop
+.end:
+    # exit(0)
+    li a7,93
+    ecall
+
+.balign 4
+_main:
+main:
+"#;
+
+/// Loop main() 10,000 times. Uses x3
+pub const ARM_LOOP_START: &str = r#"
+.text
+
+.global _start
+.global _main
+
+.balign 4
+_start:
+# i = 10,000
+mov x3, #10000
+# while i > 0
+.loop:
+sub x3, x3, 1
+
+cmp x3, xzr
+ble .end
+
+# main()
+bl main
+
+b .loop
+.end:
+mov x8, #93
+svc #0
+
+.balign 4
+_main:
+main:
+"#;
+
+pub const ARM_START: &str = r#"
 .text
 
 .global _start

tests/add/add.arm.s

@@ -1,3 +1,25 @@
+.text
+
+.global _start
+.global _main
+
+.balign 4 # not sure if these are needed for RISC-V
+_start:
+    # while i < 10,000
+    li a3, 10000
+.loop:
+    addi a3, a3, -1
+    ble a3, x0, .end
+
+    # main()
+    jal ra, main
+
+    # while loop
+    j .loop
+.end:
+    # exit(0)
+    li a7,93
+    ecall
 main:
         addi    sp,sp,-32
         sd      ra,24(sp)

tests/add/add.riscv.s

@@ -4,12 +4,14 @@ mod tests {
     use binary_room::translate::*;
     use binary_room::utils;
     use binary_room::utils::translate_to_file;
-    use binary_room::utils::START;
+    use binary_room::utils::ARM_LOOP_START;
 
     #[test]
     fn test_binary_translate() {
         let riscv_asm: Vec<RiscVInstruction> = vec![
-            RiscVInstruction::Verbatim { text: START.to_string() },
+            RiscVInstruction::Verbatim {
+                text: ARM_LOOP_START.to_string(),
+            },
             RiscVInstruction::Addi {
                 dest: RiscVRegister::SP,
                 src: RiscVRegister::SP,

tests/add/test_add.rs

@@ -19,6 +19,7 @@
         # Use the same mkShell as documented above
         packages = with pkgs; [
           gcc
+# qemu
           # pkgs.clang-tools
         ];
       };

tests/binaries/flake.nix

@@ -1,4 +1,4 @@
-#import <stdio.h>
+#include <stdio.h>
 
 int main(void) {
 	printf("hello world\n");

tests/binaries/hello_world.c

@@ -0,0 +1,9 @@
+with import <nixpkgs> {
+  crossSystem = {
+    config = "aarch64-unknown-linux-gnu";
+  };
+};
+
+mkShell {
+  buildInputs = [  ]; # your dependencies here
+}

tests/binaries/riscv/cross.arm.nix

@@ -0,0 +1,9 @@
+with import <nixpkgs> {
+  crossSystem = {
+    config = "riscv64-unknown-linux-gnu";
+  };
+};
+
+mkShell {
+  buildInputs = [  ]; # your dependencies here
+}