Merge pull request #611 from TwilitRealm/26-05-01-heap-crash-log

Improve heap crash logging

files.cmake

@@ -1,7 +1,7 @@
 
 set(DOLZEL_FILES
         src/m_Do/m_Do_main.cpp
-        src/m_Do/m_Do_printf.cpp
+        #src/m_Do/m_Do_printf.cpp
         src/m_Do/m_Do_audio.cpp
         src/m_Do/m_Do_controller_pad.cpp
         #src/m_Do/m_Re_controller_pad.cpp
@@ -1467,6 +1467,7 @@ set(DUSK_FILES
         src/dusk/livesplit.cpp
         src/dusk/offset_ptr.cpp
         src/dusk/OSContext.cpp
+        src/dusk/OSReport.cpp
         src/dusk/OSThread.cpp
         src/dusk/OSMutex.cpp
         src/dusk/discord_presence.cpp

libs/JSystem/src/JKernel/JKRExpHeap.cpp

@@ -222,16 +222,11 @@ void* JKRExpHeap::do_alloc(u32 size, int alignment) {
         OSReport_Error("Free block list as follows:\n");
         OSReport_Error("Start    | End      | Size    \n");
 
-        int i = 0;
         for (const CMemBlock* block = mHeadFreeList; block; block = block->mNext) {
             if (block->mMagic) {
                 // Allocated, ignore.
                 continue;
             }
-            if (i++ > 10) {
-                OSReport_Error("<more>\n");
-                break;
-            }
 
             auto blockStart = (uintptr_t)block - (uintptr_t)mStart;
             auto blockEnd = (uintptr_t)block + block->size - (uintptr_t)mStart;
@@ -239,6 +234,14 @@ void* JKRExpHeap::do_alloc(u32 size, int alignment) {
             OSReport_Error("%08X | %08X | %08X\n", (u32) blockStart, (u32) blockEnd, (u32) blockSize);
         }
 
+        OSReport_Error("Child heaps as follows:\n");
+        OSReport_Error("Start    | End      | Name    \n");
+
+        const JSUTree<JKRHeap>& tree = getHeapTree();
+        for (JSUTreeIterator iter(tree.getFirstChild()); iter != tree.getEndChild(); ++iter) {
+            OSReport_Error("%08X | %08X | %s\n", iter->getStartAddr(), iter->getEndAddr(), iter->getName());
+        }
+
         CRASH("Aborting due to allocation failure!");
     }
 #else

src/dusk/OSReport.cpp

@@ -0,0 +1,91 @@
+#include "aurora/lib/logging.hpp"
+#include "os_report.h"
+
+aurora::Module Log("dusk::osReport");
+
+bool dusk::OSReportReallyForceEnable = false;
+
+u8 __OSReport_disable;
+
+void OSReportDisable() {
+    __OSReport_disable = true;
+}
+
+void OSReportEnable() {
+    __OSReport_disable = false;
+}
+
+static bool checkEnabled() {
+    return !__OSReport_disable || dusk::OSReportReallyForceEnable;
+}
+
+static std::string FormatToString(const char* msg, va_list list) {
+    int ret = vsnprintf(nullptr, 0, msg, list);
+    std::string buf(ret, '\0');
+    vsnprintf(buf.data(), buf.size(), msg, list);
+    buf.pop_back();
+    return buf;
+}
+
+void OSReport_Error(const char* fmt, ...) {
+    if (!checkEnabled()) {
+        return;
+    }
+
+    va_list args;
+    va_start(args, fmt);
+    const auto str = FormatToString(fmt, args);
+    va_end(args);
+
+    Log.error("{}", str);
+}
+
+void OSReport_FatalError(const char* fmt, ...) {
+    if (!checkEnabled()) {
+        return;
+    }
+
+    va_list args;
+    va_start(args, fmt);
+    const auto str = FormatToString(fmt, args);
+    va_end(args);
+
+    Log.fatal("{}", str);
+}
+
+void OSReport_Warning(const char* fmt, ...) {
+    if (!checkEnabled()) {
+        return;
+    }
+
+    va_list args;
+    va_start(args, fmt);
+    const auto str = FormatToString(fmt, args);
+    va_end(args);
+
+    Log.warn("{}", str);
+}
+
+void OSReport_System(const char* fmt, ...) {
+    va_list args;
+    va_start(args, fmt);
+    OSVAttention(fmt, args);
+    va_end(args);
+}
+
+void OSVAttention(const char* fmt, va_list args) {
+    if (!checkEnabled()) {
+        return;
+    }
+
+    const auto str = FormatToString(fmt, args);
+
+    Log.info("{}", str);
+}
+
+void OSAttention(const char* fmt, ...) {
+    va_list args;
+    va_start(args, fmt);
+    OSVAttention(fmt, args);
+    va_end(args);
+}

src/m_Do/m_Do_graphic.cpp

@@ -2041,11 +2041,12 @@ static void drawItem3D() {
 
 int mDoGph_Painter() {
     ZoneScoped;
+
     // Diagnostic: log windowNum to track game state machine progress
     static bool sDiagLoggedWindow = false;
     if (!sDiagLoggedWindow) {
         int wn = dComIfGp_getWindowNum();
-        DuskLog.debug("mDoGph_Painter: windowNum={}", wn);
+        // DuskLog.debug("mDoGph_Painter: windowNum={}", wn);
         if (wn != 0) sDiagLoggedWindow = true;
     }
 

src/m_Do/m_Do_machine.cpp

@@ -753,9 +753,11 @@ void myGXVerifyCallback(GXWarningLevel param_1, u32 param_2, const char* param_3
 #endif
 
 int mDoMch_Create() {
+#if !TARGET_PC // We want crash logs.
     if (mDoMain::developmentMode == 0 || !(OSGetConsoleType() & 0x10000000)) {
         OSReportDisable();
     }
+#endif
 
     JKRHeap::setDefaultDebugFill(mDoMch::mDebugFill);
     #if DEBUG