Merge pull request #1 from git-bruh/main

Use a docker image for cross compilation

Author: skudlur

Makefile

@@ -0,0 +1,20 @@
+# RISCulator Makefile
+
+DOCKER_IMAGE = dockcross/linux-riscv32
+
+DISASSEMBLY = target/out.txt
+DOCKER_DISASM_SCRIPT = src/scripts/docker_disasm.sh
+
+all: risculator $(DISASSEMBLY) run
+
+$(DISASSEMBLY): src/test/main.c $(DOCKER_DISASM_SCRIPT)
+	$(DOCKER_DISASM_SCRIPT)
+
+risculator: $(DISASSEMBLY)
+	cargo build
+
+run: risculator $(DISASSEMBLY)
+	cargo run -- $(DISASSEMBLY)
+
+clean:
+	rm -rf target

README.md

@@ -7,16 +7,6 @@ To be updated. WIP.
 
 ## Installation
 
-### RISC-V GCC Compiler installation
-
-#### Option 1:
-- Head to https://github.com/riscv-collab/riscv-gnu-toolchain and build the compiler.
-
-#### Option 2:
-- Head to https://www.embecosm.com/resources/tool-chain-downloads/ and install a pre-built distro-specific compiler image and add the bin directory to PATH.
-
-**Note:** Make sure you install both 32-bit and 64-bit compilers. RISCulator will support both instruction length emulation. 
-
 ### RISCulator installation
 - Install the Rust compiler 'rustc' using rustup.
 
@@ -28,11 +18,11 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```bash
 git clone https://github.com/skudlur/RISCulator.git
 ```
-- Change directory to RISCulator/src and run the following
+- Change directory to RISCulator and run the following
 
 ```bash
-cd RISCulator/src
-make all
+cd RISCulator
+make
 ```
 
 ### Checklist

src/Makefile

@@ -16,6 +16,7 @@ use std::thread::spawn;
 use std::fmt::Binary;
 use colored::*;
 use std::mem::MaybeUninit;
+use std::env;
 
 // Utilities and other imports here
 mod utils;
@@ -317,7 +318,13 @@ impl Vproc {
 
 // RISCulator main function
 fn main() {
-    let mut path: String = "test/main.c".to_string();
+    let args: Vec<String> = env::args().collect();
+
+    if args.len() < 2 {
+      println!("Not enough arguments! Must pass the path of the disassembly as the first argument");
+      return
+    }
+
     utils::logo_display();
     println!("{}", "|----------------- A lightweight RISC-V emulator -----------------|".red());
     utils::boot_seq(XLEN, EXTENSION, REG_SIZE, RAM_SIZE);
@@ -385,7 +392,7 @@ fn main() {
     ", "Fetch".green());
     log::info!("Stage 1: Fetch stage starting");
     log::info!("Prepping for fetch operations");
-    let program_parsed = utils::program_parser("test/out.txt", &mut proc.ram_module);
+    let program_parsed = utils::program_parser(&args[1], &mut proc.ram_module);
     log::info!("Program loaded to main memory!");
     proc.ram_module.print_dirty();
     println!("

src/main.rs

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+set -eu
+
+TRIPLET=riscv32-unknown-linux-gnu
+
+docker run \
+  -v ./src:/src \
+  -v ./target:/artifact \
+  --rm -i dockcross/linux-riscv32 \
+  sh - <<EOF
+cd /artifact
+${TRIPLET}-cc -march=rv32id -c /src/test/main.c -o main.o
+${TRIPLET}-objcopy -O binary -j .text main.o binfile
+${TRIPLET}-objdump -d main.o > out.txt
+
+# Hack to make the created files and dirs rw by all users
+# since docker creates files in mounted volumes as root...
+chmod 777 -R /artifact
+EOF

src/scripts/docker_disasm.sh

@@ -34,7 +34,7 @@ static mut PC: isize = 0x0000;
 // Logo displaying function
 pub fn logo_display() {
     /* RISCulator logo */
-    let filename = "assets/logo.txt";
+    let filename = "src/assets/logo.txt";
     let logo_con = fs::read_to_string(filename)
         .expect("Failed to read the file");
     println!("{}", logo_con.yellow());