pytest_panic.py 28 KB

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