feat(trace): implement itrace

Author: EmbroiderSnow

Makefile

@@ -7,15 +7,23 @@ all:
 	@echo "-------Build Test-------"
 	@$(MAKE) -C test T=$(T)
 	@echo "-------Start Simulation-------"
-	@$(SIM) $(TARGET) -b
+	@$(SIM) $(TARGET) --batch
 
 debug: 
 	@echo "-------Build Simulator-------"
 	@$(MAKE) -C sim
 	@echo "-------Build Test-------"
 	@$(MAKE) -C test T=$(T)
 	@echo "-------Start Debugging-------"
-	@$(SIM) $(TARGET) -d
+	@$(SIM) $(TARGET) --debug
+
+itrace: 
+	@echo "-------Build Simulator-------"
+	@$(MAKE) -C sim
+	@echo "-------Build Test-------"
+	@$(MAKE) -C test T=$(T)
+	@echo "-------Start Debugging-------"
+	@$(SIM) $(TARGET) --itrace
 
 unit_test:
 	@echo "------- Building and Running Simulator Unit Tests -------"

sim/include/disasm.h

@@ -0,0 +1,17 @@
+#ifndef DISASM_H
+#define DISASM_H
+
+#include <llvm-c/Target.h>
+#include <llvm-c/Disassembler.h>
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+
+LLVMDisasmContextRef init_disasm(const char *triple);
+void disassemble_inst(LLVMDisasmContextRef disasm_ctx, uint8_t *bytes, int len, uint64_t pc, char *out, size_t out_len);
+void cleanup_disasm(LLVMDisasmContextRef disasm_ctx);
+
+void init_llvm_disassembler();
+void cleanup_llvm_disassembler();
+
+#endif

sim/src/cpu.c

@@ -1,7 +1,10 @@
 #include <common.h>
 #include <decode.h>
 #include <memory.h>
+#include <disasm.h>
 
+extern int itrace_enabled;
+extern LLVMDisasmContextRef disasm_ctx;
 CPU_state cpu = {};
 static int running = 1;
 
@@ -17,6 +20,16 @@ void exec_once(){
     s.pc   = cpu.pc;
     s.inst = inst_fetch(s.pc);
     s.snpc = s.pc + 4;
+    if (itrace_enabled && disasm_ctx) {
+        char asm_buf[128];
+        uint8_t bytes[4];
+        bytes[0] = s.inst & 0xFF;
+        bytes[1] = (s.inst >> 8) & 0xFF;
+        bytes[2] = (s.inst >> 16) & 0xFF;
+        bytes[3] = (s.inst >> 24) & 0xFF;
+        disassemble_inst(disasm_ctx, bytes, 4, s.pc, asm_buf, sizeof(asm_buf));
+        printf("\33[1;34m0x%016lx\33[1;0m: %08x          %s\n", s.pc, s.inst, asm_buf);
+    }
     decode_exec(&s);
     cpu.pc = s.dnpc;
 }

sim/src/dbg.c

@@ -3,21 +3,9 @@
 #include <common.h>
 #include <dbg.h>
 #include <decode.h>
-#include <llvm-c/Disassembler.h>
+#include <disasm.h>
 
-LLVMDisasmContextRef init_disasm(const char *triple);
-void disassemble_inst(LLVMDisasmContextRef disasm_ctx, uint8_t *bytes, int len, uint64_t pc, char *out, size_t out_len);
-void cleanup_disasm(LLVMDisasmContextRef disasm_ctx);
-
-static LLVMDisasmContextRef disasm_ctx;
-
-void init_llvm_disassembler() {
-    disasm_ctx = init_disasm("riscv64-unknown-elf");
-}
-
-void cleanup_llvm_disassembler() {
-    cleanup_disasm(disasm_ctx);
-}
+extern LLVMDisasmContextRef disasm_ctx;
 
 static void cmd_help() {
     printf("Available commands:\n");

sim/src/disasm.c

@@ -4,6 +4,8 @@
 #include <string.h>
 #include <stdlib.h>
 
+extern LLVMDisasmContextRef disasm_ctx;
+
 LLVMDisasmContextRef init_disasm(const char *triple) {
     LLVMInitializeAllTargetInfos();
     LLVMInitializeAllTargetMCs();
@@ -40,4 +42,12 @@ void cleanup_disasm(LLVMDisasmContextRef disasm_ctx) {
     if (disasm_ctx) {
         LLVMDisasmDispose(disasm_ctx);
     }
+}
+
+void init_llvm_disassembler() {
+    disasm_ctx = init_disasm("riscv64-unknown-elf");
+}
+
+void cleanup_llvm_disassembler() {
+    cleanup_disasm(disasm_ctx);
 }

sim/src/main.c

@@ -1,8 +1,11 @@
 #include <common.h>
 #include <memory.h>
 #include <cpu.h>
+#include <disasm.h>
 
 uint8_t *mem = NULL;
+int itrace_enabled = 0;
+LLVMDisasmContextRef disasm_ctx;
 
 const char *help_string = "Usage: Simulator <img_file> [-d|-b]\n"
                                   "Options:\n"
@@ -15,10 +18,15 @@ int main(int argc, char *argv[]){
     memset(mem, 0, MEM_SIZE);
     load_image(argv[1]);
     init_cpu();
-    if (argc > 2 && strcmp(argv[2], "-d") == 0) {
+    if (argc > 2 && strcmp(argv[2], "--debug") == 0) {
         debug_loop();
     }
-    else if (argc > 2 && strcmp(argv[2], "-b") == 0) {
+    else if (argc > 2 && strcmp(argv[2], "--batch") == 0) {
+        cpu_exec();
+    }
+    else if (argc > 2 && strcmp(argv[2], "--itrace") == 0) {
+        itrace_enabled = 1;
+        init_llvm_disassembler();
         cpu_exec();
     }
     else {