Add logging callback to DAC EnumMemoryRegion API (#73599)

* Add logging callback to DAC EnumMemoryRegion API

Add the ICLRDataEnumMemoryRegionsLoggingCallback interface so createdump can receive logging from the EnumMemoryRegion API.

Add logging to MethodTable EnumMemoryRegion for invalid EEClass/Canonical MT.

* Add checked build logging after waitpid for createdump to help diagnose issue #72755.

* Add more DAC logging

* Code review feedback
 
Co-authored-by: Juan Hoyos <[email protected]>

Author: Mike McLaughlin

src/coreclr/debug/createdump/crashinfo.cpp

@@ -88,6 +88,12 @@ CrashInfo::QueryInterface(
         AddRef();
         return S_OK;
     }
+    else if (InterfaceId == IID_ICLRDataLoggingCallback)
+    {
+        *Interface = (ICLRDataLoggingCallback*)this;
+        AddRef();
+        return S_OK;
+    }
     else
     {
         *Interface = nullptr;
@@ -122,6 +128,14 @@ CrashInfo::EnumMemoryRegion(
     return S_OK;
 }
 
+HRESULT STDMETHODCALLTYPE
+CrashInfo::LogMessage(
+    /* [in] */ LPCSTR message)
+{
+    Trace("%s", message);
+    return S_OK;
+}
+
 //
 // Gather all the necessary crash dump info.
 //

src/coreclr/debug/createdump/crashinfo.h

@@ -35,7 +35,7 @@ extern const std::string GetDirectory(const std::string& fileName);
 extern std::string FormatString(const char* format, ...);
 extern std::string FormatGuid(const GUID* guid);
 
-class CrashInfo : public ICLRDataEnumMemoryRegionsCallback,
+class CrashInfo : public ICLRDataEnumMemoryRegionsCallback, public ICLRDataLoggingCallback,
 #ifdef __APPLE__
     public MachOReader
 #else
@@ -135,6 +135,9 @@ class CrashInfo : public ICLRDataEnumMemoryRegionsCallback,
     // ICLRDataEnumMemoryRegionsCallback
     virtual HRESULT STDMETHODCALLTYPE EnumMemoryRegion(/* [in] */ CLRDATA_ADDRESS address, /* [in] */ ULONG32 size);
 
+    // ICLRDataLoggingCallback
+    virtual HRESULT STDMETHODCALLTYPE LogMessage( /* [in] */ LPCSTR message);
+
 private:
 #ifdef __APPLE__
     bool EnumerateMemoryRegions();

src/coreclr/debug/daccess/daccess.cpp

@@ -3155,6 +3155,7 @@ ClrDataAccess::ClrDataAccess(ICorDebugDataTarget * pTarget, ICLRDataTarget * pLe
 
     m_enumMemCb = NULL;
     m_updateMemCb = NULL;
+    m_logMessageCb = NULL;
     m_enumMemFlags = (CLRDataEnumMemoryFlags)-1;    // invalid
     m_jitNotificationTable = NULL;
     m_gcNotificationTable  = NULL;
@@ -6364,6 +6365,27 @@ bool ClrDataAccess::DacUpdateMemoryRegion(TADDR addr, TSIZE_T bufferSize, BYTE*
     return true;
 }
 
+//
+// DacLogMessage - logs a message to an external DAC client
+//
+// Parameters:
+//   message - message to log
+//
+void DacLogMessage(LPCSTR format, ...)
+{
+    SUPPORTS_DAC_HOST_ONLY;
+
+    if (g_dacImpl->IsLogMessageEnabled())
+    {
+        va_list args;
+        va_start(args, format);
+        char buffer[1024];
+        _vsnprintf_s(buffer, sizeof(buffer), _TRUNCATE, format, args);
+        g_dacImpl->LogMessage(buffer);
+        va_end(args);
+    }
+}
+
 //
 // Check whether a region of target memory is fully readable.
 //

src/coreclr/debug/daccess/dacfn.cpp

@@ -471,6 +471,7 @@ DacInstantiateTypeByAddressHelper(TADDR addr, ULONG32 size, bool throwEx, bool f
         g_dacImpl->m_instances.ReturnAlloc(inst);
         if (throwEx)
         {
+            DacLogMessage("DacReadAll(%p, %08x) FAILED %08x\n", addr, size, status);
             DacError(status);
         }
         return NULL;

src/coreclr/debug/daccess/dacimpl.h

@@ -1337,6 +1337,19 @@ class ClrDataAccess
     bool ReportMem(TADDR addr, TSIZE_T size, bool fExpectSuccess = true);
     bool DacUpdateMemoryRegion(TADDR addr, TSIZE_T bufferSize, BYTE* buffer);
 
+    inline bool IsLogMessageEnabled()
+    {
+        return m_logMessageCb != NULL;
+    }
+
+    void LogMessage(LPCSTR message)
+    {
+        if (m_logMessageCb != NULL)
+        {
+            m_logMessageCb->LogMessage(message);
+        }
+    }
+
     void ClearDumpStats();
     JITNotification* GetHostJitNotificationTable();
     GcNotification*  GetHostGcNotificationTable();
@@ -1448,6 +1461,7 @@ class ClrDataAccess
     MDImportsCache m_mdImports;
     ICLRDataEnumMemoryRegionsCallback* m_enumMemCb;
     ICLRDataEnumMemoryRegionsCallback2* m_updateMemCb;
+    ICLRDataLoggingCallback* m_logMessageCb;
     CLRDataEnumMemoryFlags m_enumMemFlags;
     JITNotification* m_jitNotificationTable;
     GcNotification*  m_gcNotificationTable;

src/coreclr/debug/daccess/enummem.cpp

@@ -1937,6 +1937,9 @@ ClrDataAccess::EnumMemoryRegions(IN ICLRDataEnumMemoryRegionsCallback* callback,
     // It is expected to fail on pre Win8 OSes.
     callback->QueryInterface(IID_ICLRDataEnumMemoryRegionsCallback2, (void **)&m_updateMemCb);
 
+    // QI for optional logging callback that createdump uses
+    callback->QueryInterface(IID_ICLRDataLoggingCallback, (void **)&m_logMessageCb);
+
     EX_TRY
     {
         ClearDumpStats();
@@ -2000,6 +2003,11 @@ ClrDataAccess::EnumMemoryRegions(IN ICLRDataEnumMemoryRegionsCallback* callback,
         m_updateMemCb->Release();
         m_updateMemCb = NULL;
     }
+    if (m_logMessageCb)
+    {
+        m_logMessageCb->Release();
+        m_logMessageCb = NULL;
+    }
     m_enumMemCb = NULL;
 
     DAC_LEAVE();

src/coreclr/inc/clrdata.idl

@@ -25,6 +25,7 @@ import "unknwn.idl";
 interface ICLRDataEnumMemoryRegions;
 interface ICLRDataEnumMemoryRegionsCallback;
 interface ICLRDataEnumMemoryRegionsCallback2;
+interface ICLRDataEnumMemoryRegionsCallback3;
 interface ICLRDataTarget;
 interface ICLRDataTarget2;
 interface ICLRMetadataLocator;
@@ -287,6 +288,20 @@ interface ICLRDataEnumMemoryRegionsCallback2 : ICLRDataEnumMemoryRegionsCallback
         [in, size_is(bufferSize)] BYTE* buffer);
 }
 
+/*
+ * Optional callback interface for logging EnumMemoryRegions operations and errors.
+ */
+[
+    object,
+    local,
+    uuid(F315248D-8B79-49DB-B184-37426559F703)
+]
+interface ICLRDataLoggingCallback : IUnknown
+{
+    HRESULT LogMessage(
+        [in] LPCSTR message);
+}
+
 /*
  * Flags for controlling which memory regions are enumerated.
  */

src/coreclr/inc/daccess.h

@@ -710,12 +710,15 @@ HRESULT DacWriteHostInstance(PVOID host, bool throwEx);
 // gathering cancelation for details see
 // code:ClrDataAccess.EnumMemoryRegionsWrapper
 
+extern void DacLogMessage(LPCSTR format, ...);
+
 // This is usable in EX_TRY exactly how RethrowTerminalExceptions et cetera
 #define RethrowCancelExceptions                                         \
     if (GET_EXCEPTION()->GetHR() == COR_E_OPERATIONCANCELED)            \
     {                                                                   \
         EX_RETHROW;                                                     \
-    }
+    }                                                                   \
+    DacLogMessage("DAC exception caught at %s:%d\n", __FILE__, __LINE__);
 
 // Occasionally it's necessary to allocate some host memory for
 // instance data that's created on the fly and so doesn't directly

src/coreclr/pal/prebuilt/idl/clrdata_i.cpp

@@ -6,11 +6,9 @@
 /* link this file in with the server and any clients */
 
 
- /* File created by MIDL compiler version 8.01.0622 */
-/* at Mon Jan 18 19:14:07 2038
- */
-/* Compiler settings for C:/ssd/runtime/src/coreclr/inc/clrdata.idl:
-    Oicf, W1, Zp8, env=Win32 (32b run), target_arch=X86 8.01.0622 
+ /* File created by MIDL compiler version 8.01.0626 */
+/* Compiler settings for clrdata.idl:
+    Oicf, W1, Zp8, env=Win64 (32b run), target_arch=AMD64 8.01.0626 
     protocol : dce , ms_ext, c_ext, robust
     error checks: allocation ref bounds_check enum stub_data 
     VC __declspec() decoration level: 
@@ -89,6 +87,9 @@ MIDL_DEFINE_GUID(IID, IID_ICLRDataEnumMemoryRegionsCallback,0xBCDD6908,0xBA2D,0x
 MIDL_DEFINE_GUID(IID, IID_ICLRDataEnumMemoryRegionsCallback2,0x3721A26F,0x8B91,0x4D98,0xA3,0x88,0xDB,0x17,0xB3,0x56,0xFA,0xDB);
 
 
+MIDL_DEFINE_GUID(IID, IID_ICLRDataLoggingCallback,0xF315248D,0x8B79,0x49DB,0xB1,0x84,0x37,0x42,0x65,0x59,0xF7,0x03);
+
+
 MIDL_DEFINE_GUID(IID, IID_ICLRDataEnumMemoryRegions,0x471c35b4,0x7c2f,0x4ef0,0xa9,0x45,0x00,0xf8,0xc3,0x80,0x56,0xf1);
 
 #undef MIDL_DEFINE_GUID