[feature] own-program support

Author: rijuyuezhu

.gitignore

@@ -10,6 +10,7 @@
 !*.sh
 !.gitignore
 !*.png
+!*.mk
 !README.md
 build
 

Makefile

@@ -1,9 +1,11 @@
 app:
-	$(MAKE) -C am-cpu-tests
-	$(MAKE) -C rv-tests
+	$(MAKE) -s -C am-cpu-tests
+	$(MAKE) -s -C rv-tests
+	$(MAKE) -s -C own-program
 
 clean:
-	$(MAKE) -C am-cpu-tests clean
-	$(MAKE) -C rv-tests clean
+	$(MAKE) -s -C am-cpu-tests clean
+	$(MAKE) -s -C rv-tests clean
+	$(MAKE) -s -C own-program clean
 
 .PHONY: app clean

README.md

@@ -1,14 +1,14 @@
 # riscvui-test
 
-This project helps the automatic testing for RV32I cpus. It contains two parts: am-cpu-tests and rv-tests.
+This project helps the automatic testing for RV32I cpus. It contains three parts: am-cpu-tests, own-program and rv-tests.
 
 To start your testing, pull this repo first.
 
 ## am-cpu-tests
 
 This part uses the `cpu-tests` of [NJU-ProjectN/abstract-machine](https://github.com/NJU-ProjectN/abstract-machine) & [NJU-ProjectN/am-kernels](https://github.com/NJU-ProjectN/am-kernels) for testing.
 
-Before building the tests, make sure that you pull the components of abstract-machine and am-kernels correctly, and `$NEMU_HOME/../am-kernels/` is exactly your root directory of am-kernels.
+Before building the tests, make sure that you pull the components of abstract-machine and am-kernels correctly, and `$AM_HOME/../am-kernels/` is exactly your root directory of am-kernels.
 
 ### Usage
 
@@ -17,6 +17,10 @@ Before building the tests, make sure that you pull the components of abstract-ma
 - Then use `$readmemh(<MN>.txt, ...)` to load the content of the instructions and data into your memory in verilog, or use `$readmemh(<MN>0/1/2/3.txt, ...)` to load the content of specific bytes of each word of instructions and data in verilog.
 - Start your testing! Note that the am-kernels/cpu-tests has RV32M instructions in some of its testcases. And the program ends when it meets `ebreak`(`0x00100073`), with `a0(R[10])` being the returning value. It's wise to identify these cases.
 
+## own-program
+
+This part allows you to add your own programs. The usage is the same as am-cpu-tests, just changing the directory name from `am-cpu-tests` to `own-program`. (In fact, the latter is implemented by this part).
+
 ## rv-tests
 
 This part uses the RV official testing set. Some functionalities are added to help with automatic testing.

am-cpu-tests/Makefile

@@ -1,38 +1,6 @@
-CPUTEST_DIR = $(NEMU_HOME)/../am-kernels/tests/cpu-tests
-CPUTEST_TESTS_DIR = $(CPUTEST_DIR)/tests
-CPUTEST_BUILD_DIR = $(CPUTEST_DIR)/build
-BUILD_DIR  = $(abspath ./build)
-TXT_DIR  = $(BUILD_DIR)/generate
+CPUTEST_TEST = $(AM_HOME)/../am-kernels/tests/cpu-tests/tests
+CPUTEST_INCLUDE = $(AM_HOME)/../am-kernels/tests/cpu-tests/include
+$(shell ln -sf -T $(CPUTEST_TEST) $(abspath ./src))
+$(shell ln -sf -T $(CPUTEST_INCLUDE) $(abspath ./include))
 
-C_SRC = $(notdir $(shell find $(CPUTEST_TESTS_DIR) -name "*.c"))
-C_FILE = $(addprefix $(CPUTEST_TESTS_DIR)/,$(C_SRC))
-BIN_FILE = $(addprefix $(CPUTEST_BUILD_DIR)/,$(foreach file,$(basename $(C_SRC)),$(file)-riscv32-nemu.bin))
-TXT_FILE = $(addprefix $(TXT_DIR)/,$(C_SRC:.c=.txt))
-NAME_FILE = $(BUILD_DIR)/NAMES.txt
-CONVERTER = $(BUILD_DIR)/converter
-
-$(shell mkdir -p $(TXT_DIR))
-
-.DEFAULT_GOAL = app
-
-$(CONVERTER): scripts/converter.c
-	@$(CC) -o $@ $<
-
-$(CPUTEST_BUILD_DIR)/%-riscv32-nemu.bin: $(CPUTEST_TESTS_DIR)/%.c
-	@echo build $(notdir $@)
-	@$(MAKE) -s -C $(CPUTEST_DIR) ARCH=riscv32-nemu ALL=$(notdir $(basename $<))
-
-$(TXT_FILE): $(CONVERTER)
-
-$(TXT_DIR)/%.txt: $(CPUTEST_BUILD_DIR)/%-riscv32-nemu.bin
-	@echo convert $(notdir $@) from $(notdir $<)
-	@$(CONVERTER) $< $@
-
-	
-app: $(TXT_FILE)
-	@echo $(basename $(TXT_FILE)) | tr ' ' '\n' > $(NAME_FILE)
-
-clean:
-	@-rm -rf $(BUILD_DIR)
-
-.PHONY: app clean
+include ../own-program/Makefile

own-program/Makefile

@@ -0,0 +1,48 @@
+SRC_DIR = $(abspath ./src)
+BUILD_DIR = $(abspath ./build)
+AM_ORIGIN_DIR = $(BUILD_DIR)/am-origin
+AM_BUILD_DIR = $(AM_ORIGIN_DIR)/build
+TXT_DIR  = $(BUILD_DIR)/generate
+
+C_SRC = $(notdir $(shell find -L $(SRC_DIR) -name "*.c"))
+C_FILE = $(addprefix $(SRC_DIR)/,$(C_SRC))
+BIN_FILE = $(foreach file,$(basename $(C_SRC)),$(AM_BUILD_DIR)/$(file)-riscv32-nemu.bin)
+TXT_FILE = $(foreach file,$(basename $(C_SRC)),$(TXT_DIR)/$(file).txt)
+NAME_FILE = $(BUILD_DIR)/NAMES.txt
+CONVERTER = $(BUILD_DIR)/converter
+
+$(shell mkdir -p $(AM_BUILD_DIR))
+$(shell mkdir -p $(TXT_DIR))
+$(shell ln -sf -T $(AM_HOME)/Makefile $(AM_ORIGIN_DIR)/Makefile)
+$(shell ln -sf -T $(abspath ./include) $(AM_ORIGIN_DIR)/include)
+$(shell ln -sf -T $(abspath ./src) $(AM_ORIGIN_DIR)/src)
+
+.SECONDARY:
+.DEFAULT_GOAL = app
+
+$(CONVERTER): scripts/converter.c
+	@echo + build $(CONVERTER)
+	@$(CC) -o $@ $<
+
+$(TXT_FILE): $(CONVERTER)
+
+$(AM_BUILD_DIR)/%-riscv32-nemu.bin: $(SRC_DIR)/%.c
+	@echo + build $(notdir $@)
+	@NAME=$(basename $(notdir $<)) SRCS=src/$(notdir $<) $(MAKE) -s -C $(AM_ORIGIN_DIR) ARCH=riscv32-nemu image > /dev/null
+
+$(TXT_DIR)/%.txt: $(AM_BUILD_DIR)/%-riscv32-nemu.bin
+	@echo + convert $(notdir $@) from $(notdir $<)
+	@$(CONVERTER) $< $@
+
+$(NAME_FILE): $(TXT_FILE)
+	@echo $(basename $(TXT_FILE)) | tr ' ' '\n' > $(NAME_FILE)
+	@echo + generate main names in $(NAME_FILE)
+
+app: $(NAME_FILE)
+	@echo BUILD DONE.
+
+clean:
+	@-rm -rf $(BUILD_DIR)
+
+
+.PHONY: clean app

own-program/include/dummy.h

@@ -0,0 +1,54 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <assert.h>
+#include <stdint.h>
+
+int main(int argc, char *argv[]) {
+  assert(argc == 3);
+  const char *from = argv[1]; // hex
+  const char *to = argv[2];   // text
+
+  FILE *fp = fopen(from, "rb");
+  assert(fp);
+  size_t siz = 0;
+  assert(fseek(fp, 0, SEEK_END) != -1);
+  siz = ftell(fp);
+  uint8_t *content = (uint8_t *)malloc(sizeof(uint8_t) * (siz + 4));
+  rewind(fp);
+  assert(fread(content, sizeof(uint8_t) * siz, 1, fp) == 1);
+  fclose(fp);
+
+  int nowsiz = 4 * ((siz + 3) / 4);
+  for (int i = siz; i < nowsiz; i++)
+    content[i] = 0;
+
+  fp = fopen(to, "w");
+  assert(fp);
+  fprintf(fp, "@0\n");
+  FILE *fdis[4];
+  char *tmp = (char *)malloc(sizeof(char) * (strlen(to) + 2));
+  assert(tmp);
+  strcpy(tmp, to);
+  char *num = tmp + strlen(to);
+  *num = *(num-1); num--;
+  *num = *(num-1); num--;
+  *num = *(num-1); num--;
+  *num = *(num-1); num--;
+  for (int j = 0; j < 4; j++) {
+    *num = j + '0';
+    fdis[j] = fopen(tmp, "w");
+    fprintf(fdis[j], "@0\n");
+  }
+  free(tmp);
+  for (int i = 0; i < nowsiz; i += 4) {
+    fprintf(fp, "%02x%02x%02x%02x\n", content[i+3], content[i+2], content[i+1], content[i]);
+    for (int j = 0; j < 4; j++)
+      fprintf(fdis[j], "%02x\n", content[i+j]);
+  }
+  free(content);
+  for (int j = 0; j < 4; j++)
+    fclose(fdis[j]);
+  fclose(fp);
+  return 0;
+}

own-program/scripts/converter.c

@@ -0,0 +1,13 @@
+#include <stdio.h>
+#include "dummy.h"
+#define N 20
+
+int f[N+1];
+
+int main() {
+  f[0] = 0;
+  f[1] = 1;
+  for (int i = 2; i <= N; i++)
+    f[i] = f[i-1] + f[i-2];
+  return f[N];
+}

own-program/src/fib.c

@@ -5,10 +5,12 @@ TRANSFER = $(BUILD_DIR)/transfer
 .DEFAULT_GOAL = app
 
 $(TRANSFER): scripts/transfer.c
-	$(CC) -o $@ $<
+	@echo + build $(TRANSFER)
+	@$(CC) -o $@ $<
 
 app: $(TRANSFER)
 	@bash scripts/gen.sh
+	@echo BUILD DONE.
 
 clean:
 	@rm -rf $(TRANSFER) $(BUILD_DIR)

rv-tests/Makefile

@@ -3,6 +3,8 @@ cp data/* build/generate
 NAMES=$(realpath $(find build/generate | grep -E "rv32ui-p-\w+_d.hex"))
 rm -rf build/NAMES.txt
 for i in ${NAMES[@]}; do
+  echo + transfer $(basename $i)
   build/transfer "$i"
   echo "$i" | sed -E "s/_d\.hex//" >> build/NAMES.txt
 done
+echo + generate main names in $(realpath build/NAMES.txt)