Adding IsDiagnosticsILStub() method on MethodDesc and using it to skip over async thunks in a variety of diagnostics-related code in which we would like to hide these from stackwalks, profiler notifications, etc. (#120982)

Co-authored-by: Jan Kotas <jkotas@microsoft.com>

Author: rcj1

src/coreclr/debug/daccess/dacdbiimpl.cpp

@@ -5270,7 +5270,7 @@ IDacDbiInterface::DynamicMethodType DacDbiInterfaceImpl::IsILStubOrLCGMethod(VMP
 
     MethodDesc * pMD = vmMethodDesc.GetDacPtr();
 
-    if (pMD->IsILStub())
+    if (pMD->IsDiagnosticsHidden())
     {
         return kILStub;
     }

src/coreclr/debug/ee/debugger.cpp

@@ -7820,7 +7820,7 @@ void Debugger::FirstChanceManagedExceptionCatcherFound(Thread *pThread,
 
     if (pMD != NULL)
     {
-        _ASSERTE(!pMD->IsILStub());
+        _ASSERTE(!pMD->IsDiagnosticsHidden());
 
         pDebugJitInfo = GetJitInfo(pMD, (const BYTE *) pMethodAddr, &pDebugMethodInfo);
         if (pDebugMethodInfo != NULL)

src/coreclr/vm/excep.cpp

@@ -3018,7 +3018,7 @@ void StackTraceInfo::AppendElement(OBJECTHANDLE hThrowable, UINT_PTR currentIP,
 
     LOG((LF_EH, LL_INFO10000, "StackTraceInfo::AppendElement IP = %p, SP = %p, %s::%s\n", currentIP, currentSP, pFunc ? pFunc->m_pszDebugClassName : "", pFunc ? pFunc->m_pszDebugMethodName : "" ));
 
-    if (pFunc != NULL && pFunc->IsILStub())
+    if ((pFunc != NULL && pFunc->IsDiagnosticsHidden()))
         return;
 
     // Do not save stacktrace to preallocated exception.  These are shared.

src/coreclr/vm/exinfo.cpp

@@ -463,7 +463,7 @@ void ExInfo::MakeCallbacksRelatedToHandler(
         }
         m_EHClauseInfo.SetInfo(COR_PRF_CLAUSE_NONE, (UINT_PTR)dwHandlerStartPC, sfToStore);
 
-        if (pMD->IsILStub())
+        if (pMD->IsDiagnosticsHidden())
         {
             return;
         }
@@ -498,7 +498,7 @@ void ExInfo::MakeCallbacksRelatedToHandler(
     }
     else
     {
-        if (pMD->IsILStub())
+        if (pMD->IsDiagnosticsHidden())
         {
             return;
         }

src/coreclr/vm/i386/excepx86.cpp

@@ -2094,7 +2094,7 @@ StackWalkAction COMPlusThrowCallback(       // SWA value
         currentSP = 0; //Don't have an SP to get.
     }
 
-    if (!pFunc->IsILStub())
+    if (!pFunc->IsDiagnosticsHidden())
     {
         if (!pData->bSkipLastElement)
         {
@@ -2153,7 +2153,7 @@ StackWalkAction COMPlusThrowCallback(       // SWA value
     }
 
     bool fIsILStub = pFunc->IsILStub();
-    bool fGiveDebuggerAndProfilerNotification = !fIsILStub;
+    bool fGiveDebuggerAndProfilerNotification = !pFunc->IsDiagnosticsHidden();
     BOOL fMethodCanHandleException = TRUE;
 
     MethodDesc * pUserMDForILStub = NULL;
@@ -2490,7 +2490,7 @@ StackWalkAction COMPlusUnwindCallback (CrawlFrame *pCf, ThrowCallbackType *pData
 #endif
 
     bool fGiveDebuggerAndProfilerNotification;
-    fGiveDebuggerAndProfilerNotification = !pFunc->IsILStub();
+    fGiveDebuggerAndProfilerNotification = !pFunc->IsDiagnosticsHidden();
 
     // Notify the profiler of the function we're dealing with in the unwind phase
     if (fGiveDebuggerAndProfilerNotification)

src/coreclr/vm/jitinterface.cpp

@@ -7938,7 +7938,7 @@ CorInfoInline CEEInfo::canInline (CORINFO_METHOD_HANDLE hCaller,
         // chance to prevent it.
         {
             BEGIN_PROFILER_CALLBACK(CORProfilerTrackJITInfo());
-            if (pCaller->IsILStub() || pCallee->IsILStub())
+            if (pCaller->IsDiagnosticsHidden() || pCallee->IsDiagnosticsHidden())
             {
                 // do nothing
             }

src/coreclr/vm/method.hpp

@@ -732,6 +732,8 @@ class MethodDesc
     inline bool IsILStub();
     inline bool IsLCGMethod();
 
+    inline bool IsDiagnosticsHidden();
+    
     inline DWORD IsPInvoke()
     {
         LIMITED_METHOD_DAC_CONTRACT;

src/coreclr/vm/method.inl

@@ -127,6 +127,12 @@ inline bool MethodDesc::IsILStub()
     return ((mcDynamic == GetClassification()) && dac_cast<PTR_DynamicMethodDesc>(this)->IsILStub());
 }
 
+inline bool MethodDesc::IsDiagnosticsHidden()
+{
+    WRAPPER_NO_CONTRACT;
+    return IsILStub() || IsAsyncThunkMethod();
+}
+
 inline BOOL MethodDesc::IsQCall()
 {
     WRAPPER_NO_CONTRACT;

src/coreclr/vm/stackwalk.cpp

@@ -2065,14 +2065,14 @@ StackWalkAction StackFrameIterator::Filter(void)
                         // and its parent, eventually making a callback for the parent as well.
                         if (m_flags & (FUNCTIONSONLY | SKIPFUNCLETS))
                         {
-                            if (!m_sfParent.IsNull() || m_crawl.pFunc->IsILStub())
+                            if (!m_sfParent.IsNull() || m_crawl.pFunc->IsDiagnosticsHidden())
                             {
                                 STRESS_LOG4(LF_GCROOTS, LL_INFO100,
                                     "STACKWALK: %s: not making callback for this frame, SPOfParent = %p, \
-                                    isILStub = %d, m_crawl.pFunc = %pM\n",
-                                    (!m_sfParent.IsNull() ? "SKIPPING_TO_FUNCLET_PARENT" : "IS_IL_STUB"),
+                                    isDiagnosticsHidden = %d, m_crawl.pFunc = %pM\n",
+                                    (!m_sfParent.IsNull() ? "SKIPPING_TO_FUNCLET_PARENT" : "IS_DIAGNOSTICS_HIDDEN"),
                                     m_sfParent.SP,
-                                    (m_crawl.pFunc->IsILStub() ? 1 : 0),
+                                    (m_crawl.pFunc->IsDiagnosticsHidden() ? 1 : 0),
                                     m_crawl.pFunc);
 
                                 // don't stop here
@@ -2085,10 +2085,10 @@ StackWalkAction StackFrameIterator::Filter(void)
                             {
                                 STRESS_LOG4(LF_GCROOTS, LL_INFO100,
                                      "STACKWALK: %s: not making callback for this frame, SPOfParent = %p, \
-                                     isILStub = %d, m_crawl.pFunc = %pM\n",
-                                     (!m_sfParent.IsNull() ? "SKIPPING_TO_FUNCLET_PARENT" : "IS_IL_STUB"),
+                                     isDiagnosticsHidden = %d, m_crawl.pFunc = %pM\n",
+                                     (!m_sfParent.IsNull() ? "SKIPPING_TO_FUNCLET_PARENT" : "IS_DIAGNOSTICS_HIDDEN"),
                                      m_sfParent.SP,
-                                     (m_crawl.pFunc->IsILStub() ? 1 : 0),
+                                     (m_crawl.pFunc->IsDiagnosticsHidden() ? 1 : 0),
                                      m_crawl.pFunc);
 
                                 // don't stop here
@@ -2114,10 +2114,10 @@ StackWalkAction StackFrameIterator::Filter(void)
                 // Skip IL stubs
                 if (m_flags & FUNCTIONSONLY)
                 {
-                    if (m_crawl.pFunc->IsILStub())
+                    if (m_crawl.pFunc->IsDiagnosticsHidden())
                     {
                         LOG((LF_GCROOTS, LL_INFO100000,
-                             "STACKWALK: IS_IL_STUB: not making callback for this frame, m_crawl.pFunc = %s\n",
+                             "STACKWALK: IS_DIAGNOSTICS_HIDDEN: not making callback for this frame, m_crawl.pFunc = %s\n",
                              m_crawl.pFunc->m_pszDebugMethodName));
 
                         // don't stop here