Support getting thread id in GC (#108207)

Author: cshung

src/coreclr/gc/env/gcenv.ee.h

@@ -96,6 +96,8 @@ class GCToEEInterface
     static void DiagAddNewRegion(int generation, uint8_t* rangeStart, uint8_t* rangeEnd, uint8_t* rangeEndReserved);
 
     static void LogErrorToHost(const char *message);
+
+    static uint64_t GetThreadOSThreadId(Thread* thread);
 };
 
 #endif // __GCENV_EE_H__

src/coreclr/gc/env/gctoeeinterface.standalone.inl

@@ -258,5 +258,10 @@ namespace standalone
         {
             ::GCToEEInterface::LogErrorToHost(message);
         }
+
+        uint64_t GetThreadOSThreadId(Thread* thread)
+        {
+            return ::GCToEEInterface::GetThreadOSThreadId(thread);
+        }
     };
 }

src/coreclr/gc/gc.cpp

@@ -26684,20 +26684,12 @@ void gc_heap::add_to_hc_history_worker (hc_history* hist, int* current_index, hc
     current_hist->bgc_t_join_joined_p = (bool)bgc_t_join.joined();
     current_hist->concurrent_p = (bool)settings.concurrent;
     current_hist->bgc_thread_running = (bool)bgc_thread_running;
-
-#if defined(TARGET_AMD64) && defined(TARGET_WINDOWS) && !defined(_DEBUG) && !defined(FEATURE_NATIVEAOT)
-    if (GCConfig::GetGCLogBGCThreadId())
+    int bgc_thread_os_id = 0;
+    if (bgc_thread)
     {
-        int bgc_thread_os_id = 0;
-
-        if (bgc_thread)
-        {
-            bgc_thread_os_id = (int)(*(size_t*)((uint8_t*)bgc_thread + 0x130));
-        }
-
-        current_hist->bgc_thread_os_id = bgc_thread_os_id;
+        bgc_thread_os_id = (int) GCToEEInterface::GetThreadOSThreadId(bgc_thread);
     }
-#endif //TARGET_AMD64 && TARGET_WINDOWS && !_DEBUG && !FEATURE_NATIVEAOT
+    current_hist->bgc_thread_os_id = bgc_thread_os_id;
 #endif //BACKGROUND_GC
 
     *current_index  = (*current_index + 1) % max_hc_history_count;

src/coreclr/gc/gcconfig.h

@@ -141,9 +141,7 @@ class GCConfigStringHolder
     STRING_CONFIG(GCPath,                    "GCPath",                    "System.GC.Path",                                        "Specifies the path of the standalone GC implementation.")                                \
     INT_CONFIG   (GCSpinCountUnit,           "GCSpinCountUnit",           NULL,                                0,                  "Specifies the spin count unit used by the GC.")                                          \
     INT_CONFIG   (GCDynamicAdaptationMode,   "GCDynamicAdaptationMode",   "System.GC.DynamicAdaptationMode",   1,                  "Enable the GC to dynamically adapt to application sizes.")                               \
-    INT_CONFIG   (GCDTargetTCP,              "GCDTargetTCP",              "System.GC.DTargetTCP",              0,                  "Specifies the target tcp for DATAS")                                                     \
-    BOOL_CONFIG  (GCLogBGCThreadId,          "GCLogBGCThreadId",          NULL,                                false,              "Specifies if BGC ThreadId should be logged")                                         
-
+    INT_CONFIG   (GCDTargetTCP,              "GCDTargetTCP",              "System.GC.DTargetTCP",              0,                  "Specifies the target tcp for DATAS")                                                     
 
 // This class is responsible for retreiving configuration information
 // for how the GC should operate.

src/coreclr/gc/gcenv.ee.standalone.inl

@@ -325,4 +325,16 @@ inline void GCToEEInterface::LogErrorToHost(const char *message)
     }
 }
 
+inline uint64_t GCToEEInterface::GetThreadOSThreadId(Thread* thread)
+{
+    if (g_runtimeSupportedVersion.MajorVersion >= 3)
+    {
+        return g_theGCToCLR->GetThreadOSThreadId(thread);
+    }
+    else
+    {
+        return 0;
+    }
+}
+
 #endif // __GCTOENV_EE_STANDALONE_INL__

src/coreclr/gc/gcinterface.ee.h

@@ -459,6 +459,9 @@ class IGCToCLR {
     // The following method is available only with EE_INTERFACE_MAJOR_VERSION >= 1
     virtual
     void LogErrorToHost(const char *message) PURE_VIRTUAL
+
+    virtual
+    uint64_t GetThreadOSThreadId(Thread* thread) PURE_VIRTUAL;
 };
 
 #endif // _GCINTERFACE_EE_H_

src/coreclr/gc/gcinterface.h

@@ -15,7 +15,7 @@
 
 // The major version of the IGCToCLR interface. Breaking changes to this interface
 // require bumps in the major version number.
-#define EE_INTERFACE_MAJOR_VERSION 2
+#define EE_INTERFACE_MAJOR_VERSION 3
 
 struct ScanContext;
 struct gc_alloc_context;

src/coreclr/gc/gcpriv.h

@@ -615,12 +615,8 @@ struct hc_history
 #ifdef BACKGROUND_GC
     short bgc_t_join_n_threads;
     // We have observed a problem on Windows in production where GC indicates a BGC thread was created successfully yet we have
-    // invalid fields on the Thread object such as m_OSThreadId. This is to help with debugging that problem so I
-    // only enable it for retail builds on Windows. We can extend this with a GCToEEInterface interface method to get the offset
-    // of that particular field on the Thread object.
-#if defined(TARGET_AMD64) && defined(TARGET_WINDOWS) && !defined(_DEBUG) && !defined(FEATURE_NATIVEAOT)
+    // invalid fields on the Thread object such as m_OSThreadId. This is to help with debugging that problem.
     int bgc_thread_os_id;
-#endif
     short bgc_t_join_join_lock;
 #endif //BACKGROUND_GC
     bool gc_t_join_joined_p;

src/coreclr/gc/sample/gcenv.ee.cpp

@@ -362,3 +362,8 @@ void GCToEEInterface::DiagAddNewRegion(int generation, uint8_t* rangeStart, uint
 void GCToEEInterface::LogErrorToHost(const char *message)
 {
 }
+
+uint64_t GCToEEInterface::GetThreadOSThreadId(Thread* thread)
+{
+    return 0;
+}

src/coreclr/nativeaot/Runtime/gcenv.ee.cpp

@@ -764,6 +764,11 @@ void GCToEEInterface::LogErrorToHost(const char *message)
 {
 }
 
+uint64_t GCToEEInterface::GetThreadOSThreadId(Thread* thread)
+{
+    return (uint64_t)thread->GetPalThreadIdForLogging();
+}
+
 bool GCToEEInterface::GetStringConfigValue(const char* privateKey, const char* publicKey, const char** value)
 {
     UNREFERENCED_PARAMETER(privateKey);