Compliance Test and ComputeGoTo Authored-by: sammer1107

Author: xiaohan484

.gitignore

@@ -1,5 +1,6 @@
 build/DOOM1.WAD*
 shareware_doom_iwad.zip*
 build/rv32emu
+build/compliance
 *.o
 *.o.d

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "riscv-compliance"]
+	path = riscv-compliance
+	url = https://github.com/riscv/riscv-compliance.git

Makefile

@@ -25,11 +25,22 @@ LDFLAGS += `sdl2-config --libs`
 # Whether to enable computed goto in riscv.c
 ENABLE_COMPUTED_GOTO ?= 1
 ifeq ("$(ENABLE_COMPUTED_GOTO)", "1")
+<<<<<<< HEAD
+<<<<<<< HEAD
 ifneq ($(filter $(CC), gcc clang),)
+=======
+>>>>>>> Add support for clang in Makefile
+=======
+ifneq ($(filter $(CC), gcc clang),)
+>>>>>>> Improve compiler support for ENABLE_COMPUTED_GOTO
 riscv.o: CFLAGS += -D ENABLE_COMPUTED_GOTO
 	ifeq ("$(CC)", "gcc")
 riscv.o: CFLAGS += -fno-gcse -fno-crossjumping 
 	endif
+<<<<<<< HEAD
+endif
+=======
+>>>>>>> Add support for clang in Makefile
 endif
 endif
 
@@ -42,6 +53,12 @@ else
     VECHO = @printf
 endif
 
+ifeq ("$(DEBUG)","1")
+	CFLAGS += -ggdb -fno-omit-frame-pointer
+else
+	CFLAGS += -O2
+endif
+
 OUT ?= build
 BIN = $(OUT)/rv32emu
 
@@ -58,6 +75,7 @@ OBJS = \
 
 deps := $(OBJS:%.o=%.o.d)
 
+
 %.o: %.c
 	$(VECHO) "  CC\t$@\n"
 	$(Q)$(CC) -o $@ $(CFLAGS) -c -MMD -MF $@.d $<
@@ -80,6 +98,19 @@ check: $(BIN)
 	(cd $(OUT); ../$(BIN) hello.elf)
 	(cd $(OUT); ../$(BIN) puzzle.elf)
 
+# variables for compliance
+COMPLIANCE_DIR ?= ./riscv-compliance
+export RISCV_PREFIX ?= riscv32-unknown-elf-
+export RISCV_TARGET = test-rv32emu
+export TARGETDIR = $(shell pwd)
+export XLEN = 32
+export JOBS ?= -j
+export WORK = $(TARGETDIR)/build/compliance
+
+compliance: $(BIN)
+	$(Q)$(MAKE) --quiet -C $(COMPLIANCE_DIR) clean;
+	$(Q)$(MAKE) --quiet -C $(COMPLIANCE_DIR);
+		
 demo: $(BIN) $(OUT)/DOOM1.WAD
 	(cd $(OUT); ../$(BIN) doom.elf)
 

README.md

@@ -30,6 +30,17 @@ make demo
 The build script will then download data file for Doom automatically. SDL2 based window
 should appear when Doom is loaded and executed.
 
+### Run riscv-compliance test
+Once the submodule `riscv-compliance` is pulled, run all the available compliance test via command:
+```shell
+make compliance
+```
++ To run the tests for specific extension, set the environmental variable `RISCV_DEVICE` to one of `I`, `M`, `Zifencei`, `privilege`. 
++ To run a specific test case, set both `RISCV_DEVICE` and `RISCV_TEST`. For example:
+    ```shell
+    make compliance RISCV_DEVICE=M RISCV_TEST=div-01
+    ```
+
 ## Customization
 
 `rv32emu` is configurable, and you can modify `Makefile` to fit your expectations:

elf.c

@@ -34,6 +34,26 @@ enum {
     STT_TLS = 6,
 };
 
+enum {
+    SHT_NULL = 0,
+    SHT_PROGBITS = 1,
+    SHT_SYMTAB = 2,
+    SHT_STRTAB = 3,
+    SHT_RELA = 4,
+    SHT_HASH = 5,
+    SHT_DYNAMIC = 6,
+    SHT_NOTE = 7,
+    SHT_NOBITS = 8,
+    SHT_REL = 9,
+    SHT_SHLIB = 10,
+    SHT_DYNSYM = 11,
+    SHT_NUM = 12,
+    SHT_LOPROC = 0x70000000,
+    SHT_HIPROC = 0x7fffffff,
+    SHT_LOUSER = 0x80000000,
+    SHT_HIUSER = 0xffffffff
+};
+
 #define ELF_ST_TYPE(x) (((unsigned int) x) & 0xf)
 
 struct Elf32_Ehdr {
@@ -249,6 +269,15 @@ const char *elf_find_symbol(elf_t *e, uint32_t addr)
     return c_map_at_end(e->symbols, &it) ? NULL : c_map_iter_value(&it, char *);
 }
 
+bool elf_get_data_section_range(elf_t *e, uint32_t *start, uint32_t *end) {                                
+    const struct Elf32_Shdr *shdr = get_section_header(e, ".data");
+    if (!shdr) return false;
+    if (shdr->sh_type == SHT_NOBITS) return false;
+    *start = shdr->sh_addr;
+    *end = *start + shdr->sh_size;
+    return true;
+ }
+
 bool elf_load(elf_t *e, struct riscv_t *rv, memory_t *mem)
 {
     rv_set_pc(rv, e->hdr->e_entry); /* set the entry point */

elf.h

@@ -47,8 +47,11 @@ bool elf_open(elf_t *e, const char *path);
 /* Find a symbol entry */
 const struct Elf32_Sym *elf_get_symbol(elf_t *e, const char *name);
 
-/* Find symbole from a specified ELF file */
+/* Find symbol from a specified ELF file */
 const char *elf_find_symbol(elf_t *e, uint32_t addr);
 
+/* get the range of .data section from the ELF file */
+bool elf_get_data_section_range(elf_t *e, uint32_t *start, uint32_t *end);
+
 /* Load the ELF file into a memory abstraction */
 bool elf_load(elf_t *e, struct riscv_t *rv, memory_t *mem);

main.c

@@ -8,6 +8,10 @@
 /* enable program trace mode */
 static bool opt_trace = false;
 
+/* RISCV compliance test mode */
+static bool opt_compliance = false;
+static char *signature_out_file;
+
 /* target executable */
 static const char *opt_prog_name = "a.out";
 
@@ -101,7 +105,8 @@ static void print_usage(const char *filename)
             "RV32I[MA] Emulator which loads an ELF file to execute.\n"
             "Usage: %s [options] [filename]\n"
             "Options:\n"
-            "  --trace : print executable trace\n",
+            "  --trace : print executable trace\n"
+            "  --compliance [signature filename] : dump signature to the given file for compliance test\n",
             filename);
 }
 
@@ -118,6 +123,16 @@ static bool parse_args(int argc, char **args)
                 opt_trace = true;
                 continue;
             }
+            if (!strcmp(arg, "--compliance")) {
+                opt_compliance = true;
+                if (i + 1 >= argc) {
+                    fprintf(stderr,
+                            "Filename for signature output required in compliance mode.\n");
+                    return false;
+                }
+                signature_out_file = args[++i];
+                continue;
+            }
             /* otherwise, error */
             fprintf(stderr, "Unknown argument '%s'\n", arg);
             return false;
@@ -129,6 +144,35 @@ static bool parse_args(int argc, char **args)
     return true;
 }
 
+void dump_test_signature(struct riscv_t *rv, elf_t *elf)
+{
+    uint32_t start = 0, end = 0;
+    const struct Elf32_Sym *sym;
+    FILE *f = fopen(signature_out_file, "w");
+    if (!f) {
+        fprintf(stderr, "Cannot open signature output file.\n");
+        return;
+    }
+
+    /* use the entire .data section as a fallback */
+    elf_get_data_section_range(elf, &start, &end);
+    /* try and access the exact signature range */
+    if ((sym = elf_get_symbol(elf, "begin_signature")))
+        start = sym->st_value;
+    if ((sym = elf_get_symbol(elf, "end_signature")))
+        end = sym->st_value;
+
+    state_t *s = rv_userdata(rv);
+
+    /* dump it word by word */
+    for (uint32_t addr = start; addr < end; addr += 4) {
+        fprintf(f, "%08x\n", memory_read_w(s->mem, addr));
+    }
+
+    fclose(f);
+}
+
+
 int main(int argc, char **args)
 {
     if (!parse_args(argc, args)) {
@@ -177,6 +221,11 @@ int main(int argc, char **args)
         run(rv);
     }
 
+    /* dump test result in test mode */
+    if (opt_compliance) {
+        dump_test_signature(rv, elf);
+    }
+
     /* finalize the RISC-V runtime */
     elf_delete(elf);
     rv_delete(rv);

riscv-compliance

@@ -785,7 +785,7 @@ void rv_step(struct riscv_t *rv, int32_t cycles)
     assert(rv);
     const uint64_t cycles_target = rv->csr_cycle + cycles;
     uint32_t inst, index;
-
+// clang-format off
 #define OP_UNIMP op_unimp
 #ifdef ENABLE_COMPUTED_GOTO
 #define OP(instr) &&op_##instr
@@ -795,7 +795,6 @@ void rv_step(struct riscv_t *rv, int32_t cycles)
 #define TABLE_TYPE const opcode_t
 #endif
 
-    // clang-format off
     TABLE_TYPE jump_table[] = {
     //  000         001           010        011           100         101        110   111
         OP(load),   OP(load_fp),  OP(unimp), OP(misc_mem), OP(op_imm), OP(auipc), OP(unimp), OP(unimp), // 00
@@ -830,10 +829,11 @@ void rv_step(struct riscv_t *rv, int32_t cycles)
         /* increment the cycles csr*/ \
         rv->csr_cycle++;              \
     }
-
+// clang-format off
 #define TARGET(instr)         \
     op_##instr : EXEC(instr); \
     DISPATCH();
+    // clang-format on
 
     DISPATCH();
 

riscv.c

@@ -0,0 +1,23 @@
+RUN_TARGET= $(TARGETDIR)/build/rv32emu $(<) \
+    $(RISCV_TARGET_FLAGS) \
+    --compliance $(*).signature.output \
+    1>$(@) 2>&1
+
+RISCV_PREFIX   ?= riscv32-unknown-elf-
+RISCV_GCC      ?= $(RISCV_PREFIX)gcc
+RISCV_GCC_OPTS ?= \
+    -march=rv32g \
+    -mabi=ilp32 \
+    -static \
+    -mcmodel=medany \
+    -fvisibility=hidden \
+    $(RVTEST_DEFINES) \
+    -nostdlib \
+    -nostartfiles
+
+COMPILE_TARGET=\
+    $$(RISCV_GCC) $(1) $$(RISCV_GCC_OPTS) \
+        -I$(ROOTDIR)/riscv-test-suite/env/ \
+        -I$(TARGETDIR)/$(RISCV_TARGET)/ \
+        -T$(TARGETDIR)/$(RISCV_TARGET)/link.ld \
+        $$(<) -o $$(@);