feat(core): log GC info in case of OOM

Enabled on debug firmware and non-frozen emulator.

[no changelog]

Author: romanz

core/SConscript.firmware

@@ -395,9 +395,17 @@ ui.init_ui(TREZOR_MODEL, "firmware", RUST_UI_FEATURES)
 
 SOURCE_QSTR = SOURCE_MOD + SOURCE_MICROPYTHON + SOURCE_MICROPYTHON_SPEED
 
+if PYOPT == '0':
+    DEBUG_FLAGS = "-DMICROPY_OOM_CALLBACK=1"
+else:
+    DEBUG_FLAGS = "-DMICROPY_OOM_CALLBACK=0"
+
 env = Environment(
     ENV=os.environ,
-    CFLAGS=f"{ARGUMENTS.get('CFLAGS', '')} -DPRODUCTION={int(PRODUCTION)} -DPYOPT={PYOPT} -DBOOTLOADER_QA={int(BOOTLOADER_QA)} -DBITCOIN_ONLY={BITCOIN_ONLY}",
+    CFLAGS=(
+        f"{ARGUMENTS.get('CFLAGS', '')} -DPRODUCTION={int(PRODUCTION)} -DPYOPT={PYOPT} "
+        f"-DBOOTLOADER_QA={int(BOOTLOADER_QA)} -DBITCOIN_ONLY={BITCOIN_ONLY} {DEBUG_FLAGS}"
+    ),
     CPPDEFINES_IMPLICIT=[],
     CPPDEFPREFIX="-D'",
     CPPDEFSUFFIX="'",

core/SConscript.unix

@@ -422,13 +422,13 @@ ui.init_ui(TREZOR_MODEL, "firmware", RUST_UI_FEATURES)
 SOURCE_QSTR = SOURCE_MOD + SOURCE_MICROPYTHON + SOURCE_UNIX
 
 if PYOPT == '0' or not FROZEN:
-    STATIC="-DSTATIC="
+    DEBUG_FLAGS = "-DMICROPY_OOM_CALLBACK=1 -DSTATIC="
 else:
-    STATIC=""
+    DEBUG_FLAGS = "-DMICROPY_OOM_CALLBACK=0"
 
 env = Environment(
     ENV=os.environ,
-    CFLAGS=ARGUMENTS.get("CFLAGS", "") + f" -DCONFIDENTIAL= -DPYOPT={PYOPT} -DBITCOIN_ONLY={BITCOIN_ONLY} {STATIC}",
+    CFLAGS=ARGUMENTS.get("CFLAGS", "") + f" -DCONFIDENTIAL= -DPYOPT={PYOPT} -DBITCOIN_ONLY={BITCOIN_ONLY} {DEBUG_FLAGS}",
     CPPDEFPREFIX="-D'",
     CPPDEFSUFFIX="'",
 )

core/embed/upymod/modtrezorutils/modtrezorutils.c

@@ -20,6 +20,9 @@
 #include <trezor_model.h>
 #include <trezor_rtl.h>
 
+#if MICROPY_OOM_CALLBACK
+#include <py/gc.h>
+#endif
 #include "py/objstr.h"
 #include "py/runtime.h"
 
@@ -243,7 +246,8 @@ STATIC mp_obj_t mod_trezorutils_sd_hotswap_enabled(void) {
 STATIC MP_DEFINE_CONST_FUN_OBJ_0(mod_trezorutils_sd_hotswap_enabled_obj,
                                  mod_trezorutils_sd_hotswap_enabled);
 
-#if !PYOPT && LOG_STACK_USAGE
+#if !PYOPT
+#if LOG_STACK_USAGE
 /// def zero_unused_stack() -> None:
 ///     """
 ///     Zero unused stack memory.
@@ -275,7 +279,27 @@ STATIC mp_obj_t mod_trezorutils_estimate_unused_stack(void) {
 STATIC MP_DEFINE_CONST_FUN_OBJ_0(mod_trezorutils_estimate_unused_stack_obj,
                                  mod_trezorutils_estimate_unused_stack);
 
-#endif  // !PYOPT && LOG_STACK_USAGE
+#endif  // LOG_STACK_USAGE
+
+#if MICROPY_OOM_CALLBACK
+static void gc_oom_callback(void) {
+  gc_dump_info();
+}
+
+/// if __debug__:
+///     def enable_oom_dump() -> None:
+///         """
+///         Dump GC info in case of an OOM.
+///         """
+STATIC mp_obj_t mod_trezorutils_enable_oom_dump(void) {
+  gc_set_oom_callback(gc_oom_callback);
+  return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_0(mod_trezorutils_enable_oom_dump_obj,
+                                 mod_trezorutils_enable_oom_dump);
+#endif  // MICROPY_OOM_CALLBACK
+
+#endif  // !PYOPT
 
 /// def reboot_to_bootloader(
 ///     boot_command : int = 0,
@@ -482,11 +506,17 @@ STATIC const mp_rom_map_elem_t mp_module_trezorutils_globals_table[] = {
      MP_ROM_PTR(&mod_trezorutils_unit_packaging_obj)},
     {MP_ROM_QSTR(MP_QSTR_unit_btconly),
      MP_ROM_PTR(&mod_trezorutils_unit_btconly_obj)},
-#if !PYOPT && LOG_STACK_USAGE
+#if !PYOPT
+#if LOG_STACK_USAGE
     {MP_ROM_QSTR(MP_QSTR_zero_unused_stack),
      MP_ROM_PTR(&mod_trezorutils_zero_unused_stack_obj)},
     {MP_ROM_QSTR(MP_QSTR_estimate_unused_stack),
      MP_ROM_PTR(&mod_trezorutils_estimate_unused_stack_obj)},
+#endif
+#if MICROPY_OOM_CALLBACK
+    {MP_ROM_QSTR(MP_QSTR_enable_oom_dump),
+     MP_ROM_PTR(&mod_trezorutils_enable_oom_dump_obj)},
+#endif
 #endif
     {MP_ROM_QSTR(MP_QSTR_sd_hotswap_enabled),
      MP_ROM_PTR(&mod_trezorutils_sd_hotswap_enabled_obj)},

core/mocks/generated/trezorutils.pyi

@@ -100,6 +100,11 @@ def estimate_unused_stack() -> int:
     """
     Estimate unused stack size.
     """
+if __debug__:
+    def enable_oom_dump() -> None:
+        """
+        Dump GC info in case of an OOM.
+        """
 
 
 # upymod/modtrezorutils/modtrezorutils.c

core/src/trezor/utils.py

@@ -125,6 +125,13 @@ def presize_module(modname: str, size: int) -> None:
 if __debug__:
     from ubinascii import hexlify
 
+    try:
+        from trezorutils import enable_oom_dump
+
+        enable_oom_dump()
+    except ImportError:
+        pass
+
     def mem_dump(filename: str) -> None:
         from micropython import mem_info