stack_usage.py 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. """
  4. 静态栈深度分析工具(RT-Thread / Cortex-M 固件)
  5. 用途:从编译产物(.elf) + -fstack-usage 结果(.su) 反推每个线程入口的最坏栈深度,
  6. 用于定位"栈溢出"类 HardFault(如 rt_thread_stack_check 误报/真溢出)。
  7. 用法:
  8. python stack_usage.py <elf> <su_dir...> [--entry func ...]
  9. """
  10. import re
  11. import sys
  12. import os
  13. import glob
  14. import shutil
  15. import subprocess
  16. from collections import defaultdict
  17. def _find_toolchain():
  18. """定位 arm-none-eabi-* 所在目录。
  19. 顺序:环境变量 RTT_TOOLCHAIN_BIN > RT-Thread Studio 安装目录 > PATH。
  20. 工具链不在 PATH 时若直接调用会静默返回空输出,导致"无入口函数"的假象。
  21. """
  22. env = os.environ.get("RTT_TOOLCHAIN_BIN")
  23. if env and os.path.isdir(env):
  24. return env
  25. pats = [
  26. r"D:/RT-ThreadStudio/repo/Extract/ToolChain_Support_Packages/ARM/"
  27. r"GNU_Tools_for_ARM_Embedded_Processors/*/bin",
  28. r"C:/RT-ThreadStudio/repo/Extract/ToolChain_Support_Packages/ARM/"
  29. r"GNU_Tools_for_ARM_Embedded_Processors/*/bin",
  30. r"D:/RT-ThreadStudio/**/GNU_Tools_for_ARM_Embedded_Processors/*/bin",
  31. ]
  32. cands = []
  33. for p in pats:
  34. cands += glob.glob(p, recursive=True)
  35. cands.sort(reverse=True) # 取版本号较大的
  36. for c in cands:
  37. if os.path.isfile(os.path.join(c, "arm-none-eabi-objdump.exe")) or \
  38. os.path.isfile(os.path.join(c, "arm-none-eabi-objdump")):
  39. return c
  40. return None
  41. _TC = _find_toolchain()
  42. _EXE = ".exe" if os.name == "nt" else ""
  43. def _tool(name):
  44. """优先用定位到的工具链,否则回退到 PATH"""
  45. if _TC:
  46. p = os.path.join(_TC, name + _EXE)
  47. if os.path.isfile(p):
  48. return '"%s"' % p
  49. return name
  50. OBJDUMP = _tool("arm-none-eabi-objdump")
  51. NM = _tool("arm-none-eabi-nm")
  52. def run(cmd):
  53. # errors="replace":objdump/nm 输出中可能混入非 UTF-8 字节(调试信息里的中文路径等),
  54. # Windows 下默认按 locale 解码会直接抛 UnicodeDecodeError
  55. return subprocess.run(cmd, shell=True, capture_output=True,
  56. text=True, errors="replace").stdout
  57. def load_symbols(elf):
  58. """地址 -> (名字, 大小)"""
  59. out = run(f'{NM} -S --defined-only "{elf}"')
  60. syms = []
  61. for line in out.splitlines():
  62. p = line.split()
  63. if len(p) < 3:
  64. continue
  65. try:
  66. addr = int(p[0], 16)
  67. except ValueError:
  68. continue
  69. size = 0
  70. name = p[2]
  71. if len(p) >= 4:
  72. try:
  73. size = int(p[1], 16)
  74. name = p[3]
  75. except ValueError:
  76. name = p[2]
  77. syms.append((addr, size, name))
  78. syms.sort()
  79. return syms
  80. def addr_to_sym(syms, addr):
  81. lo, hi = 0, len(syms) - 1
  82. best = None
  83. while lo <= hi:
  84. mid = (lo + hi) // 2
  85. if syms[mid][0] <= addr:
  86. best = mid
  87. lo = mid + 1
  88. else:
  89. hi = mid - 1
  90. if best is None:
  91. return None
  92. a, s, n = syms[best]
  93. if s and addr >= a + s:
  94. return None
  95. return n
  96. def load_frames(su_dirs):
  97. """函数名 -> 栈帧字节数,来自 -fstack-usage (.su)"""
  98. frames = {}
  99. for d in su_dirs:
  100. if not os.path.isdir(d):
  101. continue
  102. for fn in os.listdir(d):
  103. if not fn.endswith(".su"):
  104. continue
  105. with open(os.path.join(d, fn), errors="ignore") as f:
  106. for line in f:
  107. parts = line.split("\t")
  108. if len(parts) < 2:
  109. continue
  110. m = re.match(r".*?:(\d+):(\d+):(\w+)", parts[0])
  111. if not m:
  112. continue
  113. name = m.group(3)
  114. try:
  115. frames[name] = int(parts[1])
  116. except ValueError:
  117. pass
  118. return frames
  119. def parse_disasm(elf):
  120. """函数名 -> (自身帧估算, [被调用函数名])"""
  121. out = run(f'{OBJDUMP} -d "{elf}"')
  122. funcs = {}
  123. cur = None
  124. for line in out.splitlines():
  125. m = re.match(r"^([0-9a-f]{8}) <([^>]+)>:", line)
  126. if m:
  127. cur = m.group(2)
  128. funcs[cur] = {"push": 0, "sub": 0, "calls": []}
  129. continue
  130. if cur is None:
  131. continue
  132. if re.search(r"\tbl\t", line) or re.search(r"\tbl\.w\t", line):
  133. t = re.search(r"<([^>+]+)(\+0x[0-9a-f]+)?>", line)
  134. if t:
  135. funcs[cur]["calls"].append(t.group(1))
  136. else:
  137. m2 = re.search(r"\tpush\t\{([^}]*)\}", line)
  138. if m2:
  139. funcs[cur]["push"] = max(funcs[cur]["push"], 4 * (m2.group(1).count(",") + 1))
  140. m3 = re.search(r"\tsub\tsp, #(\d+)", line)
  141. if m3:
  142. funcs[cur]["sub"] = max(funcs[cur]["sub"], int(m3.group(1)))
  143. return funcs
  144. EXCLUDES = {"list_thread", "rt_hw_hard_fault_exception", "object_split", "object_split.constprop.1", "list_get_next"}
  145. def main():
  146. elf = sys.argv[1]
  147. su_dirs = []
  148. entries = []
  149. i = 2
  150. while i < len(sys.argv):
  151. if sys.argv[i] == "--entry":
  152. entries = sys.argv[i + 1:]
  153. break
  154. su_dirs.append(sys.argv[i])
  155. i += 1
  156. frames = load_frames(su_dirs)
  157. funcs = parse_disasm(elf)
  158. def frame_of(name):
  159. if name in frames:
  160. return frames[name]
  161. if name in funcs:
  162. return funcs[name]["push"] + funcs[name]["sub"]
  163. return 0
  164. global EXCLUDES
  165. if not entries:
  166. entries = [n for n in funcs if n.endswith("_entry")]
  167. INF = 1 << 30
  168. def worst(name, path, memo):
  169. """返回 (最坏栈深度, 最深路径)"""
  170. if name in path:
  171. return (0, [])
  172. if name in memo:
  173. return memo[name]
  174. f = frame_of(name)
  175. best = (0, [])
  176. for c in funcs.get(name, {}).get("calls", []):
  177. if c not in funcs or c in EXCLUDES:
  178. continue
  179. d, p = worst(c, path | {name}, memo)
  180. if d > best[0]:
  181. best = (d, p)
  182. res = (f + best[0], [name] + best[1])
  183. memo[name] = res
  184. return res
  185. print(f"{'entry':34s} {'deepest-path-bytes':>18s} path")
  186. print("-" * 110)
  187. rows = []
  188. for e in entries:
  189. if e not in funcs:
  190. continue
  191. memo = {}
  192. d, p = worst(e, set(), memo)
  193. rows.append((d, e, p))
  194. for d, e, p in sorted(rows, reverse=True):
  195. chain = " -> ".join(p[:8]) + (" -> ..." if len(p) > 8 else "")
  196. print(f"{e:34s} {d:18d} {chain}")
  197. if __name__ == "__main__":
  198. main()