From 34ffa39b8a799d20163744933c6491cd38595fc7 Mon Sep 17 00:00:00 2001 From: Lixuanwang Date: Wed, 25 Jun 2025 20:59:40 +0800 Subject: [PATCH] [backend] modified some comments and created a shell srcipt for test inside riscv64-vms --- src/RISCv64Backend.cpp | 4 +- src/SysYIROptPre.cpp | 8 -- test_script/runit-riscv64.sh | 208 +++++++++++++++++++++++++++++++++++ 3 files changed, 210 insertions(+), 10 deletions(-) create mode 100644 test_script/runit-riscv64.sh diff --git a/src/RISCv64Backend.cpp b/src/RISCv64Backend.cpp index 5f3e868..b6a987f 100644 --- a/src/RISCv64Backend.cpp +++ b/src/RISCv64Backend.cpp @@ -6,7 +6,7 @@ #include #include -#define DEBUG 1 +#define DEBUG 0 #define DEEPDEBUG 0 namespace sysy { @@ -491,7 +491,7 @@ std::vector> RISCv64CodeGen::build_dag( arg_node->users.push_back(call_node); } } else if (auto ret = dynamic_cast(inst)) { - std::cout << "处理 RETURN 指令: " << ret->getName() << "\n"; // 调试输出 + if (DEBUG) std::cerr << "处理 RETURN 指令: " << ret->getName() << "\n"; // 调试输出 auto ret_node = create_node(DAGNode::RETURN, ret, value_to_node, nodes_storage); // 传递参数 if (ret->hasReturnValue()) { auto val_ir = ret->getReturnValue(); diff --git a/src/SysYIROptPre.cpp b/src/SysYIROptPre.cpp index 90ff3fd..41af234 100644 --- a/src/SysYIROptPre.cpp +++ b/src/SysYIROptPre.cpp @@ -1,11 +1,3 @@ -/** - * @file: Sysyoptimization.cpp - * @brief CFG优化 - * @Author : Ixeux email:you@domain.com - * @Version : 1.0 - * @Creat Date : 2024-08-10 - * - */ #include "SysYIROptPre.h" #include #include diff --git a/test_script/runit-riscv64.sh b/test_script/runit-riscv64.sh new file mode 100644 index 0000000..18a3898 --- /dev/null +++ b/test_script/runit-riscv64.sh @@ -0,0 +1,208 @@ +#!/bin/bash + +# run_vm_tests.sh - 用于在 RISC-V 虚拟机内部汇编、链接和测试 SysY 程序的脚本 +# 此脚本应该在Riscv64架构的机器上运行，依赖：gcc。 +# 脚本的目录结构应该为： +# . +# ├── runit.sh +# ├── lib +# │ └── libsysy_riscv.a +# └── testdata +# ├── functional +# └── performance + +# 定义相对于脚本位置的目录 +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" &>/dev/null && pwd)" +TMP_DIR="${SCRIPT_DIR}/tmp" +LIB_DIR="${SCRIPT_DIR}/lib" +TESTDATA_DIR="${SCRIPT_DIR}/testdata" + +# 定义编译器 +GCC_NATIVE="gcc" # VM 内部的 gcc + +# 显示帮助信息的函数 +show_help() { + echo "用法: $0 [选项]" + echo "此脚本用于在 RISC-V 虚拟机内部，对之前生成的 .s 汇编文件进行汇编、链接和测试。" + echo "假设当前运行环境已经是 RISC-V 64 位架构，可以直接执行编译后的程序。" + echo "" + echo "选项:" + echo " -c, --clean 清理 'tmp' 目录下的所有生成文件。" + echo " -h, --help 显示此帮助信息并退出。" + echo "" + echo "执行步骤:" + echo "1. 遍历 'tmp/' 目录下的所有 .s 汇编文件。" + echo "2. 使用 VM 内部的 gcc 将 .s 文件汇编并链接为可执行文件 (链接 -L./lib -lsysy_riscv -static)。" + echo "3. 直接运行编译后的可执行文件 (使用 ./ 方式)。" + echo "4. 根据对应的 testdata/*.out 文件内容（最后一行是否为整数）决定是进行返回值比较、标准输出比较，或两者都进行。" + echo "5. 如果没有对应的 .in/.out 文件，则打印可执行文件的返回值。" + echo "6. 输出比较时会忽略行尾多余的换行符。" +} + +# 清理临时文件的函数 +clean_tmp() { + echo "正在清理临时目录: ${TMP_DIR}" + # 清理所有由本脚本和 runit.sh 生成的文件 + rm -rf "${TMP_DIR}"/*.s \ + "${TMP_DIR}"/*_sysyc_riscv64 \ + "${TMP_DIR}"/*_sysyc_riscv64.actual_out \ + "${TMP_DIR}"/*_sysyc_riscv64.expected_stdout \ + "${TMP_DIR}"/*_sysyc_riscv64.o # 以防生成了 .o 文件 + echo "清理完成。" +} + +# 如果临时目录不存在，则创建它 (尽管 runit.sh 应该已经创建了) +mkdir -p "${TMP_DIR}" + +# 解析命令行参数 +while [[ "$#" -gt 0 ]]; do + case "$1" in + -c|--clean) + clean_tmp + exit 0 + ;; + -h|--help) + show_help + exit 0 + ;; + *) + echo "未知选项: $1" + show_help + exit 1 + ;; + esac +done + +echo "SysY VM 内部测试运行器启动..." +echo "汇编文件目录: ${TMP_DIR}" +echo "库文件目录: ${LIB_DIR}" +echo "测试数据目录: ${TESTDATA_DIR}" +echo "" + +# 查找 tmp 目录下的所有 .s 汇编文件 +# 遍历找到的每个 .s 文件 +find "${TMP_DIR}" -maxdepth 1 -name "*.s" | while read s_file; do + # 从 .s 文件名中提取原始的测试用例名称部分 + # 例如：从 functional_21_if_test2_sysyc_riscv64.s 提取 functional_21_if_test2 + base_name_from_s_file=$(basename "$s_file" .s) + original_test_name_underscored=$(echo "$base_name_from_s_file" | sed 's/_sysyc_riscv64$//') + + # 将下划线转换回斜杠，以构建原始的相对路径（例如：functional/21_if_test2） + original_relative_path=$(echo "$original_test_name_underscored" | tr '_' '/') + + # 定义可执行文件、输入文件、参考输出文件和实际输出文件的路径 + executable_file="${TMP_DIR}/${base_name_from_s_file}" + input_file="${TESTDATA_DIR}/${original_relative_path}.in" + output_reference_file="${TESTDATA_DIR}/${original_relative_path}.out" + output_actual_file="${TMP_DIR}/${base_name_from_s_file}.actual_out" + + echo "正在处理汇编文件: $(basename "$s_file")" + echo " 对应的测试用例路径: ${original_relative_path}" + + # 步骤 1: 使用 VM 内部的 gcc 编译 .s 到可执行文件 + # 注意：这里假设 gcc 在 VM 环境中可用，且 ./lib 是相对于当前脚本运行目录 + echo " 使用 gcc 汇编并链接: ${GCC_NATIVE} \"${s_file}\" -o \"${executable_file}\" -L\"${LIB_DIR}\" -lsysy_riscv -static -g" + "${GCC_NATIVE}" "${s_file}" -o "${executable_file}" -L"${LIB_DIR}" -lsysy_riscv -static -g + if [ $? -ne 0 ]; then + echo -e "\e[31m错误: GCC 汇编/链接 ${s_file} 失败\e[0m" + continue + fi + echo " 生成的可执行文件: ${executable_file}" + + # 步骤 2: 执行编译后的文件并比较/报告结果 + # 直接执行可执行文件，不再通过 qemu-riscv64 + echo " 正在执行: ./\"${executable_file}\"" + + # 检查是否存在 .out 文件 + if [ -f "${output_reference_file}" ]; then + # 尝试从 .out 文件中提取期望的返回码和期望的标准输出 + # 获取 .out 文件的最后一行，去除空白字符 + LAST_LINE_TRIMMED=$(tail -n 1 "${output_reference_file}" | tr -d '[:space:]') + + # 检查最后一行是否为纯整数 (允许正负号) + if [[ "$LAST_LINE_TRIMMED" =~ ^[-+]?[0-9]+$ ]]; then + # 假设最后一行是期望的返回码 + EXPECTED_RETURN_CODE="$LAST_LINE_TRIMMED" + + # 创建一个只包含期望标准输出的临时文件 (所有行除了最后一行) + EXPECTED_STDOUT_FILE="${TMP_DIR}/${base_name_from_s_file}.expected_stdout" + # 使用 head -n -1 来获取除了最后一行之外的所有行。如果文件只有一行，则生成一个空文件。 + head -n -1 "${output_reference_file}" > "${EXPECTED_STDOUT_FILE}" + + echo " 检测到 .out 文件同时包含标准输出和期望的返回码。" + echo " 期望返回码: ${EXPECTED_RETURN_CODE}" + if [ -s "${EXPECTED_STDOUT_FILE}" ]; then # -s 检查文件是否非空 + echo " 期望标准输出文件: ${EXPECTED_STDOUT_FILE}" + else + echo " 期望标准输出为空。" + fi + + # 执行程序，捕获实际返回码和实际标准输出 + if [ -f "${input_file}" ]; then + echo " 使用输入文件: ${input_file}" + "./${executable_file}" < "${input_file}" > "${output_actual_file}" + else + "./${executable_file}" > "${output_actual_file}" + fi + ACTUAL_RETURN_CODE=$? # 捕获执行状态 + + # 比较实际返回码与期望返回码 + if [ "$ACTUAL_RETURN_CODE" -eq "$EXPECTED_RETURN_CODE" ]; then + echo -e "\e[32m 返回码测试成功: ${original_relative_path}.sy 的返回码 (${ACTUAL_RETURN_CODE}) 与期望值 (${EXPECTED_RETURN_CODE}) 匹配\e[0m" + else + echo -e "\e[31m 返回码测试失败: ${original_relative_path}.sy 的返回码不匹配。期望: ${EXPECTED_RETURN_CODE}, 实际: ${ACTUAL_RETURN_CODE}\e[0m" + fi + + # 比较实际标准输出与期望标准输出，忽略文件末尾的换行符差异 + if diff -q <(sed ':a;N;$!ba;s/\n*$//' "${output_actual_file}") <(sed ':a;N;$!ba;s/\n*$//' "${EXPECTED_STDOUT_FILE}") >/dev/null 2>&1; then + echo -e "\e[32m 标准输出测试成功: 输出与 ${original_relative_path}.sy 的参考输出匹配 (忽略行尾换行符差异)\e[0m" + else + echo -e "\e[31m 标准输出测试失败: ${original_relative_path}.sy 的输出不匹配\e[0m" + echo " 差异 (可能包含行尾换行符差异):" + diff "${output_actual_file}" "${EXPECTED_STDOUT_FILE}" # 显示原始差异以便调试 + fi + + else + # 最后一行不是纯整数，将整个 .out 文件视为纯标准输出 + echo " 检测到 .out 文件为纯标准输出参考。正在与输出文件比较: ${output_reference_file}" + + # 执行程序，并将输出重定向到临时文件 + if [ -f "${input_file}" ]; then + echo " 使用输入文件: ${input_file}" + "./${executable_file}" < "${input_file}" > "${output_actual_file}" + else + "./${executable_file}" > "${output_actual_file}" + fi + EXEC_STATUS=$? # 捕获执行状态 + + if [ $EXEC_STATUS -ne 0 ]; then + echo -e "\e[33m警告: 可执行文件 ${original_relative_path}.sy 以非零状态 ${EXEC_STATUS} 退出 (纯输出比较模式)。请检查程序逻辑或其是否应返回此状态。\e[0m" + fi + + # 比较实际输出与参考输出，忽略文件末尾的换行符差异 + if diff -q <(sed ':a;N;$!ba;s/\n*$//' "${output_actual_file}") <(sed ':a;N;$!ba;s/\n*$//' "${output_reference_file}") >/dev/null 2>&1; then + echo -e "\e[32m 成功: 输出与 ${original_relative_path}.sy 的参考输出匹配 (忽略行尾换行符差异)\e[0m" + else + echo -e "\e[31m 失败: ${original_relative_path}.sy 的输出不匹配\e[0m" + echo " 差异 (可能包含行尾换行符差异):" + diff "${output_actual_file}" "${output_reference_file}" # 显示原始差异以便调试 + fi + fi + elif [ -f "${input_file}" ]; then + # 只有 .in 文件存在，使用输入运行并报告退出码（无参考输出） + echo " 使用输入文件: ${input_file}" + echo " 没有 .out 文件进行比较。正在运行并报告返回码。" + "./${executable_file}" < "${input_file}" + EXEC_STATUS=$? + echo " ${original_relative_path}.sy 的返回码: ${EXEC_STATUS}" + else + # .in 和 .out 文件都不存在，只运行并报告退出码 + echo " 未找到 .in 或 .out 文件。正在运行并报告返回码。" + "./${executable_file}" + EXEC_STATUS=$? + echo " ${original_relative_path}.sy 的返回码: ${EXEC_STATUS}" + fi + echo "" # 为测试用例之间添加一个空行，以提高可读性 +done + +echo "脚本完成。"