gen_su.sh 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. #!/bin/bash
  2. # 为指定源文件生成 -fstack-usage (.su) 数据,供 stack_usage.py 做线程栈深度分析。
  3. #
  4. # 用途:stack_usage.py 需要 .su 才能拿到精确的栈帧大小;gcc 默认不生成 .su,
  5. # 必须用 -fstack-usage 重新编译。本脚本复用 Debug/ 下 makefile 的真实编译参数,
  6. # 保证与正式固件完全一致的优化级别(-Os 下栈帧与 -O0 差异很大,不能随便编译)。
  7. #
  8. # 用法:
  9. # bash doc/tools/gen_su.sh # 默认重编 control/dtu_uart2/hmi/selfcheck
  10. # bash doc/tools/gen_su.sh applications/foo.c applications/bar.c
  11. # RTT_TOOLCHAIN_BIN=/path/to/bin bash doc/tools/gen_su.sh
  12. #
  13. # 之后:
  14. # python doc/tools/stack_usage.py <elf> /tmp/su <输出目录>
  15. #
  16. set -u
  17. cd "$(dirname "$0")/../.." || exit 1 # 项目根目录
  18. ROOT=$(pwd)
  19. # ---- 定位工具链(与 stack_usage.py 同一套规则)----
  20. # 注意:必须与生成该 elf 的编译器版本一致。本机同时装了 5.4.1 与 6.3.1 两套,
  21. # 实测同一份 control.c 用 5.4.1 编译,多个函数栈帧会小 8 字节(内联决策不同),
  22. # 会得出错误的栈预算结论。因此这里收集全部候选后取最高版本,并回显实际版本号。
  23. find_tc() {
  24. if [ -n "${RTT_TOOLCHAIN_BIN:-}" ] && [ -d "$RTT_TOOLCHAIN_BIN" ]; then
  25. echo "$RTT_TOOLCHAIN_BIN"; return
  26. fi
  27. for d in /d/RT-ThreadStudio /c/RT-ThreadStudio; do
  28. for p in "$d"/repo/Extract/ToolChain_Support_Packages/ARM/GNU_Tools_for_ARM_Embedded_Processors/*/bin; do
  29. [ -x "$p/arm-none-eabi-gcc.exe" ] && echo "$p"
  30. done
  31. done
  32. }
  33. TC=$(find_tc | sort -V | tail -1)
  34. if [ -z "$TC" ]; then echo "未找到 arm-none-eabi 工具链,请设置 RTT_TOOLCHAIN_BIN"; exit 1; fi
  35. echo "toolchain: $TC"
  36. echo "version: $("$TC/arm-none-eabi-gcc" --version 2>/dev/null | head -1)"
  37. # ---- 生成 .su 输出目录 ----
  38. if [ -n "${SU_OUT:-}" ]; then
  39. OUT="$SU_OUT"
  40. else
  41. OUT=/tmp/su_"$(date +%Y%m%d_%H%M%S)"
  42. fi
  43. mkdir -p "$OUT"
  44. echo "output: $OUT"
  45. # ---- 从 makefile 取真实编译参数 ----
  46. MK=Debug/applications/subdir.mk
  47. if [ ! -f "$MK" ]; then
  48. echo "缺少 $MK(需先在 RT-Thread Studio / scons 里编译过一次,以便拿到编译参数)"
  49. exit 1
  50. fi
  51. RECIPE=$(grep -m1 "^ arm-none-eabi-gcc" "$MK" | sed 's/^\t//')
  52. [ -z "$RECIPE" ] && { echo "未在 $MK 中找到编译规则"; exit 1; }
  53. # 去掉编译器名,截断到 -MMD 之前(保留 -D/-I/-include/-std 等),与正式构建参数一致
  54. BASE="${RECIPE#arm-none-eabi-gcc }"
  55. BASE="${BASE%% -MMD*}"
  56. # ---- 待处理文件:命令行参数,或默认的 4 个(10-02 改动文件)----
  57. if [ $# -gt 0 ]; then FILES=("$@"); else
  58. FILES=(applications/control.c applications/dtu_uart2.c applications/hmi.c applications/selfcheck.c)
  59. fi
  60. fail=0
  61. for SRC in "${FILES[@]}"; do
  62. [ -f "$SRC" ] || { echo "跳过(不存在): $SRC"; fail=1; continue; }
  63. base=$(basename "$SRC" .c)
  64. printf -- '--- %s ---\n' "$SRC"
  65. # eval 让引号按 Makefile 的方式被剥离(-I/-include 的路径含反斜杠,不能自己拆词)
  66. eval "\"$TC/arm-none-eabi-gcc\" $BASE -fstack-usage -c -o \"$OUT/$base.o\" \"$SRC\"" 2>&1 \
  67. | grep -E "error|警告|warning" | head -5
  68. if [ -f "$OUT/$base.su" ]; then
  69. echo " OK: $(wc -l < "$OUT/$base.su") 个函数栈帧"
  70. else
  71. echo " 失败:未生成 .su"; fail=1
  72. fi
  73. done
  74. echo
  75. echo "下一步:python doc/tools/stack_usage.py <elf> /tmp/su \"$OUT\""
  76. exit $fail