pytest_panic.py 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838
  1. # SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
  2. # SPDX-License-Identifier: CC0-1.0
  3. import re
  4. from typing import List, Optional, Union
  5. import pexpect
  6. import pytest
  7. from test_panic_util import PanicTestDut
  8. # Markers for all the targets this test currently runs on
  9. TARGETS_TESTED = [
  10. pytest.mark.esp32,
  11. pytest.mark.esp32s2,
  12. pytest.mark.esp32c3,
  13. pytest.mark.esp32s3,
  14. pytest.mark.esp32c2,
  15. pytest.mark.esp32c6,
  16. pytest.mark.esp32h2
  17. ]
  18. # Most tests run on all targets and with all configs.
  19. # This list is passed to @pytest.mark.parametrize for each of the test cases.
  20. # It creates an outer product of the sets: [configs] x [targets],
  21. # with some exceptions.
  22. CONFIGS = [
  23. pytest.param('coredump_flash_bin_crc', marks=TARGETS_TESTED),
  24. pytest.param('coredump_flash_elf_sha', marks=[pytest.mark.esp32]), # sha256 only supported on esp32, IDF-1820
  25. pytest.param('coredump_uart_bin_crc', marks=TARGETS_TESTED),
  26. pytest.param('coredump_uart_elf_crc', marks=TARGETS_TESTED),
  27. pytest.param('gdbstub', marks=TARGETS_TESTED),
  28. pytest.param('panic', marks=TARGETS_TESTED),
  29. ]
  30. # Some tests only run on dual-core targets, they use the config below.
  31. TARGETS_DUAL_CORE = [pytest.mark.esp32, pytest.mark.esp32s3]
  32. CONFIGS_DUAL_CORE = [
  33. pytest.param('coredump_flash_bin_crc', marks=TARGETS_DUAL_CORE),
  34. pytest.param('coredump_flash_elf_sha', marks=[pytest.mark.esp32]), # sha256 only supported on esp32, IDF-1820
  35. pytest.param('coredump_uart_bin_crc', marks=TARGETS_DUAL_CORE),
  36. pytest.param('coredump_uart_elf_crc', marks=TARGETS_DUAL_CORE),
  37. pytest.param('gdbstub', marks=TARGETS_DUAL_CORE),
  38. pytest.param('panic', marks=TARGETS_DUAL_CORE),
  39. ]
  40. # Some tests run on all targets but need to behave differently on the dual-core ones.
  41. # This list is used to check if the target is a dual-core one.
  42. TARGETS_DUAL_CORE_NAMES = [x.mark.name for x in TARGETS_DUAL_CORE]
  43. # The tests which panic on external stack require PSRAM capable runners
  44. CONFIGS_EXTRAM_STACK = [
  45. pytest.param('coredump_extram_stack', marks=[pytest.mark.esp32, pytest.mark.esp32s2, pytest.mark.psram, pytest.mark.esp32s3, pytest.mark.quad_psram])
  46. ]
  47. TARGETS_HW_STACK_GUARD = [
  48. pytest.mark.esp32c2,
  49. pytest.mark.esp32c3,
  50. pytest.mark.esp32c6,
  51. pytest.mark.esp32h2,
  52. ]
  53. CONFIGS_HW_STACK_GUARD = [
  54. pytest.param('coredump_flash_bin_crc', marks=TARGETS_HW_STACK_GUARD),
  55. pytest.param('coredump_uart_bin_crc', marks=TARGETS_HW_STACK_GUARD),
  56. pytest.param('coredump_uart_elf_crc', marks=TARGETS_HW_STACK_GUARD),
  57. pytest.param('gdbstub', marks=TARGETS_HW_STACK_GUARD),
  58. pytest.param('panic', marks=TARGETS_HW_STACK_GUARD),
  59. ]
  60. # Panic abort information will start with this string.
  61. PANIC_ABORT_PREFIX = 'Panic reason: '
  62. def get_default_backtrace(config: str) -> List[str]:
  63. return [config, 'app_main', 'main_task', 'vPortTaskWrapper']
  64. def common_test(dut: PanicTestDut, config: str, expected_backtrace: Optional[List[str]] = None, check_cpu_reset: Optional[bool] = True,
  65. expected_coredump: Optional[List[Union[str, re.Pattern]]] = None) -> None:
  66. if 'gdbstub' in config:
  67. dut.expect_exact('Entering gdb stub now.')
  68. dut.start_gdb()
  69. frames = dut.gdb_backtrace()
  70. if expected_backtrace is not None:
  71. dut.verify_gdb_backtrace(frames, expected_backtrace)
  72. dut.revert_log_level()
  73. return # don't expect "Rebooting" output below
  74. # We will only perform comparisons for ELF files, as we are not introducing any new fields to the binary file format.
  75. if 'bin' in config:
  76. expected_coredump = None
  77. if 'uart' in config:
  78. dut.process_coredump_uart(expected_coredump)
  79. elif 'flash' in config:
  80. dut.process_coredump_flash(expected_coredump)
  81. elif 'panic' in config:
  82. pass
  83. dut.expect('Rebooting...')
  84. if check_cpu_reset:
  85. dut.expect_cpu_reset()
  86. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  87. @pytest.mark.generic
  88. def test_task_wdt_cpu0(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  89. dut.run_test_func(test_func_name)
  90. dut.expect_exact(
  91. 'Task watchdog got triggered. The following tasks/users did not reset the watchdog in time:'
  92. )
  93. dut.expect_exact('CPU 0: main')
  94. if dut.is_xtensa:
  95. # on Xtensa, dumping registers on abort is not necessary, we only need to dump the backtrace
  96. dut.expect_none('register dump:')
  97. dut.expect_exact('Print CPU 0 (current core) backtrace')
  98. dut.expect_backtrace()
  99. else:
  100. # on RISC-V, need to dump both registers and stack memory to reconstruct the backtrace
  101. dut.expect_reg_dump(core=0)
  102. dut.expect_stack_dump()
  103. dut.expect_elf_sha256()
  104. dut.expect_none('Guru Meditation')
  105. common_test(
  106. dut,
  107. config,
  108. expected_backtrace=get_default_backtrace(test_func_name),
  109. )
  110. @pytest.mark.parametrize('config', CONFIGS_DUAL_CORE, indirect=True)
  111. @pytest.mark.generic
  112. def test_task_wdt_cpu1(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  113. dut.run_test_func(test_func_name)
  114. dut.expect_exact(
  115. 'Task watchdog got triggered. The following tasks/users did not reset the watchdog in time:'
  116. )
  117. dut.expect_exact('CPU 1: Infinite loop')
  118. if dut.is_xtensa:
  119. # see comment in test_task_wdt_cpu0
  120. dut.expect_none('register dump:')
  121. dut.expect_exact('Print CPU 1 backtrace')
  122. dut.expect_backtrace()
  123. # On Xtensa, we get incorrect backtrace from GDB in this test
  124. expected_backtrace = ['infinite_loop', 'vPortTaskWrapper']
  125. else:
  126. assert False, 'No dual-core RISC-V chips yet, check this test case later'
  127. dut.expect_elf_sha256()
  128. dut.expect_none('Guru Meditation')
  129. common_test(
  130. dut,
  131. config,
  132. expected_backtrace=expected_backtrace,
  133. )
  134. @pytest.mark.parametrize('config', CONFIGS_DUAL_CORE, indirect=True)
  135. @pytest.mark.generic
  136. def test_task_wdt_both_cpus(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  137. if dut.target == 'esp32s3':
  138. pytest.xfail(reason='Only prints "Print CPU 1 backtrace", IDF-6560')
  139. dut.run_test_func(test_func_name)
  140. dut.expect_exact(
  141. 'Task watchdog got triggered. The following tasks/users did not reset the watchdog in time:'
  142. )
  143. dut.expect_exact('CPU 0: Infinite loop')
  144. dut.expect_exact('CPU 1: Infinite loop')
  145. if dut.is_xtensa:
  146. # see comment in test_task_wdt_cpu0
  147. dut.expect_none('register dump:')
  148. dut.expect_exact('Print CPU 0 (current core) backtrace')
  149. dut.expect_backtrace()
  150. dut.expect_exact('Print CPU 1 backtrace')
  151. dut.expect_backtrace()
  152. # On Xtensa, we get incorrect backtrace from GDB in this test
  153. expected_backtrace = ['infinite_loop', 'vPortTaskWrapper']
  154. else:
  155. assert False, 'No dual-core RISC-V chips yet, check this test case later'
  156. dut.expect_elf_sha256()
  157. dut.expect_none('Guru Meditation')
  158. common_test(
  159. dut,
  160. config,
  161. expected_backtrace=expected_backtrace,
  162. )
  163. @pytest.mark.parametrize('config', CONFIGS_EXTRAM_STACK, indirect=True)
  164. def test_panic_extram_stack(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  165. dut.run_test_func(test_func_name)
  166. dut.expect_none('Allocated stack is not in external RAM')
  167. dut.expect_none('Guru Meditation')
  168. dut.expect_backtrace()
  169. dut.expect_elf_sha256()
  170. # Check that coredump is getting written to flash
  171. dut.expect_exact('Save core dump to flash...')
  172. # And that the stack is replaced and restored
  173. dut.expect_exact('Backing up stack @')
  174. dut.expect_exact('Restoring stack')
  175. # The caller must be accessible after restoring the stack
  176. dut.expect_exact('Core dump has been saved to flash.')
  177. common_test(dut, config)
  178. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  179. @pytest.mark.generic
  180. def test_int_wdt(
  181. dut: PanicTestDut, target: str, config: str, test_func_name: str
  182. ) -> None:
  183. dut.run_test_func(test_func_name)
  184. dut.expect_gme('Interrupt wdt timeout on CPU0')
  185. dut.expect_reg_dump(0)
  186. if dut.is_xtensa:
  187. dut.expect_backtrace()
  188. else:
  189. dut.expect_stack_dump()
  190. if target in TARGETS_DUAL_CORE_NAMES:
  191. assert dut.is_xtensa, 'No dual-core RISC-V chips yet, check the test case'
  192. dut.expect_reg_dump(1)
  193. dut.expect_backtrace()
  194. dut.expect_elf_sha256()
  195. dut.expect_none('Guru Meditation')
  196. common_test(dut, config, expected_backtrace=get_default_backtrace(test_func_name))
  197. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  198. @pytest.mark.generic
  199. def test_int_wdt_cache_disabled(
  200. dut: PanicTestDut, target: str, config: str, test_func_name: str
  201. ) -> None:
  202. dut.run_test_func(test_func_name)
  203. dut.expect_gme('Interrupt wdt timeout on CPU0')
  204. dut.expect_reg_dump(0)
  205. if dut.is_xtensa:
  206. dut.expect_backtrace()
  207. else:
  208. dut.expect_stack_dump()
  209. if target in TARGETS_DUAL_CORE_NAMES:
  210. assert dut.is_xtensa, 'No dual-core RISC-V chips yet, check the test case'
  211. dut.expect_reg_dump(1)
  212. dut.expect_backtrace()
  213. dut.expect_elf_sha256()
  214. dut.expect_none('Guru Meditation')
  215. common_test(dut, config, expected_backtrace=get_default_backtrace(test_func_name))
  216. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  217. @pytest.mark.generic
  218. def test_cache_error(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  219. dut.run_test_func(test_func_name)
  220. if dut.target in ['esp32c3', 'esp32c2', 'esp32c6', 'esp32h2']:
  221. # Cache error interrupt is not raised, IDF-6398
  222. dut.expect_gme('Illegal instruction')
  223. elif dut.target in ['esp32s2']:
  224. # Cache error interrupt is not enabled, IDF-1558
  225. dut.expect_gme('IllegalInstruction')
  226. else:
  227. dut.expect_gme('Cache disabled but cached memory region accessed')
  228. dut.expect_reg_dump(0)
  229. if dut.is_xtensa:
  230. dut.expect_backtrace()
  231. else:
  232. dut.expect_stack_dump()
  233. dut.expect_elf_sha256()
  234. dut.expect_none('Guru Meditation')
  235. expected_backtrace = ['die'] + get_default_backtrace(test_func_name)
  236. if dut.target in ['esp32s2', 'esp32s3']:
  237. # 'test_cache_error' missing from GDB backtrace on ESP32-S2 and ESP-S3, IDF-6561
  238. expected_backtrace = ['die', 'app_main', 'main_task', 'vPortTaskWrapper']
  239. common_test(
  240. dut, config, expected_backtrace=expected_backtrace, check_cpu_reset=(dut.target != 'esp32')
  241. )
  242. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  243. @pytest.mark.generic
  244. def test_stack_overflow(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  245. dut.run_test_func(test_func_name)
  246. if dut.is_xtensa:
  247. dut.expect_gme('Unhandled debug exception')
  248. dut.expect_exact('Stack canary watchpoint triggered (main)')
  249. else:
  250. # Stack watchpoint handling missing on RISC-V, IDF-6397
  251. dut.expect_gme('Breakpoint')
  252. dut.expect_reg_dump(0)
  253. if dut.is_xtensa:
  254. dut.expect_backtrace()
  255. else:
  256. dut.expect_stack_dump()
  257. dut.expect_elf_sha256()
  258. dut.expect_none('Guru Meditation')
  259. common_test(dut, config, expected_backtrace=get_default_backtrace(test_func_name))
  260. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  261. @pytest.mark.generic
  262. def test_instr_fetch_prohibited(
  263. dut: PanicTestDut, config: str, test_func_name: str
  264. ) -> None:
  265. dut.run_test_func(test_func_name)
  266. if dut.is_xtensa:
  267. dut.expect_gme('InstrFetchProhibited')
  268. dut.expect_reg_dump(0)
  269. dut.expect_backtrace()
  270. expected_backtrace = ['_init'] + get_default_backtrace(test_func_name)
  271. else:
  272. dut.expect_gme('Instruction access fault')
  273. dut.expect_reg_dump(0)
  274. dut.expect_stack_dump()
  275. # On RISC-V, GDB is not able to determine the correct backtrace after
  276. # a jump to an invalid address.
  277. expected_backtrace = ['??']
  278. dut.expect_elf_sha256()
  279. dut.expect_none('Guru Meditation')
  280. common_test(
  281. dut,
  282. config,
  283. expected_backtrace=expected_backtrace,
  284. )
  285. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  286. @pytest.mark.generic
  287. def test_illegal_instruction(
  288. dut: PanicTestDut, config: str, test_func_name: str
  289. ) -> None:
  290. dut.run_test_func(test_func_name)
  291. if dut.is_xtensa:
  292. dut.expect_gme('IllegalInstruction')
  293. else:
  294. dut.expect_gme('Illegal instruction')
  295. dut.expect_reg_dump(0)
  296. if dut.is_xtensa:
  297. dut.expect_backtrace()
  298. else:
  299. dut.expect_stack_dump()
  300. dut.expect_elf_sha256()
  301. dut.expect_none('Guru Meditation')
  302. common_test(dut, config, expected_backtrace=get_default_backtrace(test_func_name))
  303. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  304. @pytest.mark.generic
  305. def test_storeprohibited(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  306. dut.run_test_func(test_func_name)
  307. if dut.is_xtensa:
  308. dut.expect_gme('StoreProhibited')
  309. else:
  310. dut.expect_gme('Store access fault')
  311. dut.expect_reg_dump(0)
  312. if dut.is_xtensa:
  313. dut.expect_backtrace()
  314. else:
  315. dut.expect_stack_dump()
  316. dut.expect_elf_sha256()
  317. dut.expect_none('Guru Meditation')
  318. common_test(dut, config, expected_backtrace=get_default_backtrace(test_func_name))
  319. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  320. @pytest.mark.generic
  321. def test_abort(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  322. dut.run_test_func(test_func_name)
  323. regex_pattern = rb'abort\(\) was called at PC [0-9xa-f]+ on core 0'
  324. dut.expect(regex_pattern)
  325. if dut.is_xtensa:
  326. dut.expect_backtrace()
  327. else:
  328. dut.expect_stack_dump()
  329. dut.expect_elf_sha256()
  330. dut.expect_none(['Guru Meditation', 'Re-entered core dump'])
  331. coredump_pattern = re.compile(PANIC_ABORT_PREFIX + regex_pattern.decode('utf-8'))
  332. common_test(
  333. dut,
  334. config,
  335. expected_backtrace=[
  336. 'panic_abort',
  337. 'esp_system_abort',
  338. 'abort'
  339. ] + get_default_backtrace(test_func_name),
  340. expected_coredump=[coredump_pattern]
  341. )
  342. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  343. @pytest.mark.generic
  344. def test_ub(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  345. dut.run_test_func(test_func_name)
  346. regex_pattern = rb'Undefined behavior of type out_of_bounds'
  347. dut.expect(regex_pattern)
  348. if dut.is_xtensa:
  349. dut.expect_backtrace()
  350. else:
  351. dut.expect_stack_dump()
  352. dut.expect_elf_sha256()
  353. dut.expect_none(['Guru Meditation', 'Re-entered core dump'])
  354. coredump_pattern = re.compile(PANIC_ABORT_PREFIX + regex_pattern.decode('utf-8'))
  355. common_test(
  356. dut,
  357. config,
  358. expected_backtrace=[
  359. 'panic_abort',
  360. 'esp_system_abort',
  361. '__ubsan_default_handler',
  362. '__ubsan_handle_out_of_bounds'
  363. ] + get_default_backtrace(test_func_name),
  364. expected_coredump=[coredump_pattern]
  365. )
  366. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  367. @pytest.mark.generic
  368. def test_abort_cache_disabled(
  369. dut: PanicTestDut, config: str, test_func_name: str
  370. ) -> None:
  371. if dut.target == 'esp32s2':
  372. pytest.xfail(reason='Crashes in itoa which is not in ROM, IDF-3572')
  373. dut.run_test_func(test_func_name)
  374. regex_pattern = rb'abort\(\) was called at PC [0-9xa-f]+ on core 0'
  375. dut.expect(regex_pattern)
  376. if dut.is_xtensa:
  377. dut.expect_backtrace()
  378. else:
  379. dut.expect_stack_dump()
  380. dut.expect_elf_sha256()
  381. dut.expect_none(['Guru Meditation', 'Re-entered core dump'])
  382. coredump_pattern = re.compile(PANIC_ABORT_PREFIX + regex_pattern.decode('utf-8'))
  383. common_test(
  384. dut,
  385. config,
  386. expected_backtrace=[
  387. 'panic_abort',
  388. 'esp_system_abort',
  389. 'abort'
  390. ] + get_default_backtrace(test_func_name),
  391. expected_coredump=[coredump_pattern]
  392. )
  393. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  394. @pytest.mark.generic
  395. def test_assert(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  396. dut.run_test_func(test_func_name)
  397. regex_pattern = rb'assert failed:[\s\w()]*?\s[.\w/]*\.(?:c|cpp|h|hpp):\d.*$'
  398. dut.expect(re.compile(regex_pattern, re.MULTILINE))
  399. if dut.is_xtensa:
  400. dut.expect_backtrace()
  401. else:
  402. dut.expect_stack_dump()
  403. dut.expect_elf_sha256()
  404. dut.expect_none(['Guru Meditation', 'Re-entered core dump'])
  405. coredump_pattern = re.compile(PANIC_ABORT_PREFIX + regex_pattern.decode('utf-8'), re.MULTILINE)
  406. common_test(
  407. dut,
  408. config,
  409. expected_backtrace=[
  410. 'panic_abort',
  411. 'esp_system_abort',
  412. '__assert_func'
  413. ] + get_default_backtrace(test_func_name),
  414. expected_coredump=[coredump_pattern]
  415. )
  416. @pytest.mark.parametrize('config', CONFIGS, indirect=True)
  417. @pytest.mark.generic
  418. def test_assert_cache_disabled(
  419. dut: PanicTestDut, config: str, test_func_name: str
  420. ) -> None:
  421. if dut.target == 'esp32s2':
  422. pytest.xfail(reason='Crashes in itoa which is not in ROM, IDF-3572')
  423. dut.run_test_func(test_func_name)
  424. regex_pattern = rb'assert failed: [0-9xa-fA-F]+.*$'
  425. dut.expect(re.compile(regex_pattern, re.MULTILINE))
  426. if dut.is_xtensa:
  427. dut.expect_backtrace()
  428. else:
  429. dut.expect_stack_dump()
  430. dut.expect_elf_sha256()
  431. dut.expect_none(['Guru Meditation', 'Re-entered core dump'])
  432. coredump_pattern = re.compile(PANIC_ABORT_PREFIX + regex_pattern.decode('utf-8'), re.MULTILINE)
  433. common_test(
  434. dut,
  435. config,
  436. expected_backtrace=[
  437. 'panic_abort',
  438. 'esp_system_abort',
  439. '__assert_func'
  440. ] + get_default_backtrace(test_func_name),
  441. expected_coredump=[coredump_pattern]
  442. )
  443. @pytest.mark.esp32
  444. @pytest.mark.parametrize('config', ['panic_delay'], indirect=True)
  445. def test_panic_delay(dut: PanicTestDut) -> None:
  446. dut.run_test_func('test_storeprohibited')
  447. try:
  448. dut.expect_exact('Rebooting...', timeout=4)
  449. except pexpect.TIMEOUT:
  450. # We are supposed to NOT find the output for the specified time
  451. pass
  452. else:
  453. # If we actually match the output within the timeout, it means the delay didn't work
  454. raise AssertionError('Rebooted too early, delay is too short')
  455. dut.expect_exact('Rebooting...', timeout=3)
  456. dut.expect_exact('rst:0xc (SW_CPU_RESET)')
  457. #########################
  458. # for memprot test only #
  459. #########################
  460. # Memprot-related tests are supported only on targets with PMS/PMA peripheral;
  461. # currently ESP32-S2, ESP32-C3, ESP32-C2, ESP32-H2 and ESP32-C6 are supported
  462. CONFIGS_MEMPROT_IDRAM = [
  463. pytest.param('memprot_esp32s2', marks=[pytest.mark.esp32s2]),
  464. pytest.param('memprot_esp32c3', marks=[pytest.mark.esp32c3]),
  465. pytest.param('memprot_esp32c2', marks=[pytest.mark.esp32c2]),
  466. pytest.param('memprot_esp32c6', marks=[pytest.mark.esp32c6]),
  467. pytest.param('memprot_esp32h2', marks=[pytest.mark.esp32h2])
  468. ]
  469. CONFIGS_MEMPROT_DCACHE = [
  470. pytest.param('memprot_esp32s2', marks=pytest.mark.esp32s2),
  471. ]
  472. CONFIGS_MEMPROT_RTC_FAST_MEM = [
  473. pytest.param('memprot_esp32s2', marks=[pytest.mark.esp32s2]),
  474. pytest.param('memprot_esp32c3', marks=[pytest.mark.esp32c3]),
  475. pytest.param('memprot_esp32c6', marks=[pytest.mark.esp32c6]),
  476. pytest.param('memprot_esp32h2', marks=[pytest.mark.esp32h2])
  477. ]
  478. CONFIGS_MEMPROT_RTC_SLOW_MEM = [
  479. pytest.param('memprot_esp32s2', marks=[pytest.mark.esp32s2]),
  480. ]
  481. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_DCACHE, indirect=True)
  482. @pytest.mark.generic
  483. def test_dcache_read_violation(dut: PanicTestDut, test_func_name: str) -> None:
  484. dut.run_test_func(test_func_name)
  485. dut.expect_exact(r'Test error: Test function has returned')
  486. dut.expect_cpu_reset()
  487. # TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs
  488. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_DCACHE, indirect=True)
  489. @pytest.mark.generic
  490. @pytest.mark.xfail('config.getvalue("target") == "esp32s2"', reason='Incorrect panic reason may be observed', run=False)
  491. def test_dcache_write_violation(dut: PanicTestDut, test_func_name: str) -> None:
  492. dut.run_test_func(test_func_name)
  493. dut.expect_gme('Memory protection fault')
  494. dut.expect(r'Write operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  495. dut.expect_reg_dump(0)
  496. dut.expect_backtrace()
  497. dut.expect_cpu_reset()
  498. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_IDRAM, indirect=True)
  499. @pytest.mark.generic
  500. def test_iram_reg1_write_violation(dut: PanicTestDut, test_func_name: str) -> None:
  501. dut.run_test_func(test_func_name)
  502. if dut.target == 'esp32s2':
  503. dut.expect_gme('Memory protection fault')
  504. dut.expect(r'Write operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  505. dut.expect_reg_dump(0)
  506. dut.expect_backtrace()
  507. elif dut.target == 'esp32c3':
  508. dut.expect_exact(r'Test error: Test function has returned')
  509. elif dut.target in ['esp32c2', 'esp32c6', 'esp32h2']:
  510. dut.expect_gme('Store access fault')
  511. dut.expect_reg_dump(0)
  512. dut.expect_stack_dump()
  513. dut.expect_cpu_reset()
  514. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_IDRAM, indirect=True)
  515. @pytest.mark.generic
  516. def test_iram_reg2_write_violation(dut: PanicTestDut, test_func_name: str) -> None:
  517. dut.run_test_func(test_func_name)
  518. if dut.target == 'esp32s2':
  519. dut.expect_gme('Memory protection fault')
  520. dut.expect(r'Write operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  521. dut.expect_reg_dump(0)
  522. dut.expect_backtrace()
  523. elif dut.target == 'esp32c3':
  524. dut.expect_gme('Memory protection fault')
  525. dut.expect(r' memory type: (\S+)')
  526. dut.expect(r' faulting address: [0-9xa-f]+')
  527. dut.expect(r' operation type: (\S+)')
  528. dut.expect_reg_dump(0)
  529. dut.expect_stack_dump()
  530. elif dut.target in ['esp32c2', 'esp32c6', 'esp32h2']:
  531. dut.expect_gme('Store access fault')
  532. dut.expect_reg_dump(0)
  533. dut.expect_stack_dump()
  534. dut.expect_cpu_reset()
  535. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_IDRAM, indirect=True)
  536. @pytest.mark.generic
  537. def test_iram_reg3_write_violation(dut: PanicTestDut, test_func_name: str) -> None:
  538. dut.run_test_func(test_func_name)
  539. if dut.target == 'esp32s2':
  540. dut.expect_gme('Memory protection fault')
  541. dut.expect(r'Write operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  542. dut.expect_reg_dump(0)
  543. dut.expect_backtrace()
  544. elif dut.target == 'esp32c3':
  545. dut.expect_gme('Memory protection fault')
  546. dut.expect(r' memory type: (\S+)')
  547. dut.expect(r' faulting address: [0-9xa-f]+')
  548. dut.expect(r' operation type: (\S+)')
  549. dut.expect_reg_dump(0)
  550. dut.expect_stack_dump()
  551. elif dut.target in ['esp32c2', 'esp32c6', 'esp32h2']:
  552. dut.expect_gme('Store access fault')
  553. dut.expect_reg_dump(0)
  554. dut.expect_stack_dump()
  555. dut.expect_cpu_reset()
  556. # TODO: IDF-6820: ESP32-S2 -> Fix incorrect panic reason: Unhandled debug exception
  557. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_IDRAM, indirect=True)
  558. @pytest.mark.generic
  559. @pytest.mark.xfail('config.getvalue("target") == "esp32s2"', reason='Incorrect panic reason may be observed', run=False)
  560. def test_iram_reg4_write_violation(dut: PanicTestDut, test_func_name: str) -> None:
  561. dut.run_test_func(test_func_name)
  562. if dut.target == 'esp32s2':
  563. dut.expect_gme('Memory protection fault')
  564. dut.expect(r'Write operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  565. dut.expect_reg_dump(0)
  566. dut.expect_backtrace()
  567. elif dut.target == 'esp32c3':
  568. dut.expect_gme('Memory protection fault')
  569. dut.expect(r' memory type: (\S+)')
  570. dut.expect(r' faulting address: [0-9xa-f]+')
  571. dut.expect(r' operation type: (\S+)')
  572. dut.expect_reg_dump(0)
  573. dut.expect_stack_dump()
  574. elif dut.target in ['esp32c2', 'esp32c6', 'eps32h2']:
  575. dut.expect_gme('Store access fault')
  576. dut.expect_reg_dump(0)
  577. dut.expect_stack_dump()
  578. dut.expect_cpu_reset()
  579. # TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs
  580. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_IDRAM, indirect=True)
  581. @pytest.mark.generic
  582. @pytest.mark.xfail('config.getvalue("target") == "esp32s2"', reason='Multiple panic reasons for the same test may surface', run=False)
  583. def test_dram_reg1_execute_violation(dut: PanicTestDut, test_func_name: str) -> None:
  584. dut.run_test_func(test_func_name)
  585. if dut.target == 'esp32s2':
  586. dut.expect_gme('Memory protection fault')
  587. dut.expect(r'Unknown operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  588. dut.expect_reg_dump(0)
  589. dut.expect_corrupted_backtrace()
  590. elif dut.target in ['esp32c3', 'esp32c2', 'esp32c6', 'esp32h2']:
  591. dut.expect_gme('Instruction access fault')
  592. dut.expect_reg_dump(0)
  593. dut.expect_stack_dump()
  594. dut.expect_cpu_reset()
  595. # TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs
  596. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_IDRAM, indirect=True)
  597. @pytest.mark.generic
  598. @pytest.mark.xfail('config.getvalue("target") == "esp32s2"', reason='Multiple panic reasons for the same test may surface', run=False)
  599. def test_dram_reg2_execute_violation(dut: PanicTestDut, test_func_name: str) -> None:
  600. dut.run_test_func(test_func_name)
  601. if dut.target == 'esp32s2':
  602. dut.expect_gme('InstructionFetchError')
  603. dut.expect_reg_dump(0)
  604. dut.expect_corrupted_backtrace()
  605. elif dut.target in ['esp32c3', 'esp32c2', 'esp32c6', 'esp32h2']:
  606. dut.expect_gme('Instruction access fault')
  607. dut.expect_reg_dump(0)
  608. dut.expect_stack_dump()
  609. dut.expect_cpu_reset()
  610. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_RTC_FAST_MEM, indirect=True)
  611. @pytest.mark.generic
  612. def test_rtc_fast_reg1_execute_violation(dut: PanicTestDut, test_func_name: str) -> None:
  613. dut.run_test_func(test_func_name)
  614. dut.expect_exact(r'Test error: Test function has returned')
  615. dut.expect_cpu_reset()
  616. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_RTC_FAST_MEM, indirect=True)
  617. @pytest.mark.generic
  618. @pytest.mark.skipif('config.getvalue("target") in ["esp32c6", "esp32h2"]', reason='Not a violation condition because it does not have PMS peripheral')
  619. def test_rtc_fast_reg2_execute_violation(dut: PanicTestDut, test_func_name: str) -> None:
  620. dut.run_test_func(test_func_name)
  621. dut.expect_gme('Memory protection fault')
  622. if dut.target == 'esp32s2':
  623. dut.expect(r'Read operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  624. dut.expect_reg_dump(0)
  625. dut.expect_backtrace()
  626. elif dut.target == 'esp32c3':
  627. dut.expect(r' memory type: (\S+)')
  628. dut.expect(r' faulting address: [0-9xa-f]+')
  629. dut.expect(r' operation type: (\S+)')
  630. dut.expect_reg_dump(0)
  631. dut.expect_stack_dump()
  632. dut.expect_cpu_reset()
  633. # TODO: IDF-6820: ESP32-S2 -> Fix multiple panic reasons in different runs
  634. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_RTC_FAST_MEM, indirect=True)
  635. @pytest.mark.generic
  636. @pytest.mark.xfail('config.getvalue("target") == "esp32s2"', reason='Multiple panic reasons for the same test may surface', run=False)
  637. def test_rtc_fast_reg3_execute_violation(dut: PanicTestDut, test_func_name: str) -> None:
  638. dut.run_test_func(test_func_name)
  639. if dut.target == 'esp32s2':
  640. dut.expect_gme('Memory protection fault')
  641. dut.expect(r'Unknown operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  642. dut.expect_reg_dump(0)
  643. dut.expect_backtrace()
  644. elif dut.target == 'esp32c3':
  645. dut.expect_gme('Memory protection fault')
  646. dut.expect(r' memory type: (\S+)')
  647. dut.expect(r' faulting address: [0-9xa-f]+')
  648. dut.expect(r' operation type: (\S+)')
  649. dut.expect_reg_dump(0)
  650. dut.expect_stack_dump()
  651. elif dut.target in ['esp32c6', 'esp32h2']:
  652. dut.expect_gme('Instruction access fault')
  653. dut.expect_reg_dump(0)
  654. dut.expect_stack_dump()
  655. dut.expect_cpu_reset()
  656. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_RTC_SLOW_MEM, indirect=True)
  657. @pytest.mark.generic
  658. def test_rtc_slow_reg1_execute_violation(dut: PanicTestDut, test_func_name: str) -> None:
  659. dut.run_test_func(test_func_name)
  660. dut.expect_gme('Memory protection fault')
  661. dut.expect(r'Read operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  662. dut.expect_reg_dump(0)
  663. dut.expect_corrupted_backtrace()
  664. dut.expect_cpu_reset()
  665. @pytest.mark.parametrize('config', CONFIGS_MEMPROT_RTC_SLOW_MEM, indirect=True)
  666. @pytest.mark.generic
  667. def test_rtc_slow_reg2_execute_violation(dut: PanicTestDut, test_func_name: str) -> None:
  668. dut.run_test_func(test_func_name)
  669. dut.expect_gme('Memory protection fault')
  670. dut.expect(r'Read operation at address [0-9xa-f]+ not permitted \((\S+)\)')
  671. dut.expect_reg_dump(0)
  672. dut.expect_corrupted_backtrace()
  673. dut.expect_cpu_reset()
  674. @pytest.mark.esp32
  675. @pytest.mark.parametrize('config', ['gdbstub_coredump'], indirect=True)
  676. def test_gdbstub_coredump(dut: PanicTestDut) -> None:
  677. test_func_name = 'test_storeprohibited'
  678. dut.run_test_func(test_func_name)
  679. dut.process_coredump_uart()
  680. dut.expect_exact('Entering gdb stub now.')
  681. dut.start_gdb()
  682. frames = dut.gdb_backtrace()
  683. dut.verify_gdb_backtrace(frames, get_default_backtrace(test_func_name))
  684. dut.revert_log_level()
  685. return # don't expect "Rebooting" output below
  686. @pytest.mark.parametrize('config', CONFIGS_HW_STACK_GUARD, indirect=True)
  687. @pytest.mark.generic
  688. def test_hw_stack_guard_cpu0(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  689. dut.run_test_func(test_func_name)
  690. dut.expect_exact('Guru Meditation Error: Core 0 panic\'ed (Stack protection fault).')
  691. dut.expect_none('ASSIST_DEBUG is not triggered BUT interrupt occured!')
  692. dut.expect(r'Detected in task(.*)at 0x')
  693. dut.expect_exact('Stack pointer: 0x')
  694. dut.expect(r'Stack bounds: 0x(.*) - 0x')
  695. common_test(dut, config)
  696. @pytest.mark.esp32
  697. @pytest.mark.parametrize('config', ['panic'], indirect=True)
  698. @pytest.mark.generic
  699. def test_illegal_access(dut: PanicTestDut, config: str, test_func_name: str) -> None:
  700. dut.run_test_func(test_func_name)
  701. if dut.is_xtensa:
  702. dut.expect(r'\[1\] val: (-?\d+) at 0x80000000', timeout=30)
  703. dut.expect_gme('LoadProhibited')
  704. dut.expect_reg_dump(0)
  705. dut.expect_backtrace()
  706. dut.expect_elf_sha256()
  707. dut.expect_none('Guru Meditation')