Implement simple version of On Stack Replacement (OSR)

src/coreclr/clrdefinitions.cmake

@@ -197,6 +197,9 @@ endif(FEATURE_ENABLE_NO_ADDRESS_SPACE_RANDOMIZATION)
 add_definitions(-DFEATURE_SVR_GC)
 add_definitions(-DFEATURE_SYMDIFF)
 add_compile_definitions($<$<NOT:$<BOOL:$<TARGET_PROPERTY:CROSSGEN_COMPONENT>>>:FEATURE_TIERED_COMPILATION>)
+if (CLR_CMAKE_TARGET_ARCH_AMD64)
+   add_compile_definitions($<$<NOT:$<BOOL:$<TARGET_PROPERTY:CROSSGEN_COMPONENT>>>:FEATURE_ON_STACK_REPLACEMENT>)
+endif (CLR_CMAKE_TARGET_ARCH_AMD64)
 if (CLR_CMAKE_TARGET_WIN32)
     add_definitions(-DFEATURE_TYPEEQUIVALENCE)
 endif(CLR_CMAKE_TARGET_WIN32)

src/coreclr/src/ToolBox/superpmi/superpmi-shared/compileresult.cpp

@@ -326,6 +326,38 @@ bool CompileResult::repSetVars(CORINFO_METHOD_HANDLE* ftn, ULONG32* cVars, ICorD
     return true;
 }
 
+// Note - Ownership of patchpointInfo is transfered with this call. In replay icorjitinfo we should free it.
+void CompileResult::recSetPatchpointInfo(PatchpointInfo* patchpointInfo)
+{
+    if (SetPatchpointInfo == nullptr)
+        SetPatchpointInfo = new LightWeightMap<DWORD, Agnostic_SetPatchpointInfo>();
+
+    Agnostic_SetPatchpointInfo value;
+    value.index = (DWORD)SetPatchpointInfo->AddBuffer((const unsigned char*) patchpointInfo, patchpointInfo->PatchpointInfoSize());
+    SetPatchpointInfo->Add(0, value);
+}
+void CompileResult::dmpSetPatchpointInfo(DWORD key, const Agnostic_SetPatchpointInfo& value)
+{
+    PatchpointInfo* patchpointInfo = (PatchpointInfo*)SetPatchpointInfo->GetBuffer(value.index);
+    printf("SetPatchpointInfo key %u, index %u{", key, value.index);
+    // todo -- dump contents
+    printf("}");
+    SetPatchpointInfo->Unlock();
+}
+bool CompileResult::repSetPatchpointInfo(PatchpointInfo** patchpointInfo)
+{
+    if ((SetPatchpointInfo == nullptr) || (SetPatchpointInfo->GetCount() == 0))
+    {
+        *patchpointInfo = nullptr;
+        return false;
+    }
+
+    Agnostic_SetPatchpointInfo value;
+    value = SetPatchpointInfo->Get(0);
+    *patchpointInfo = (PatchpointInfo*)SetPatchpointInfo->GetBuffer(value.index);
+    return true;
+}
+
 void CompileResult::recAllocGCInfo(size_t size, void* retval)
 {
     allocGCInfoDets.size   = size;

src/coreclr/src/ToolBox/superpmi/superpmi-shared/compileresult.h

@@ -112,6 +112,10 @@ class CompileResult
         DWORD     cVars;
         DWORD     vars_offset;
     };
+    struct Agnostic_SetPatchpointInfo
+    {
+        DWORD     index;
+    };
     struct Agnostic_CORINFO_EH_CLAUSE2
     {
         DWORD Flags;
@@ -200,6 +204,10 @@ class CompileResult
     void dmpSetVars(DWORD key, const Agnostic_SetVars& value);
     bool repSetVars(CORINFO_METHOD_HANDLE* ftn, ULONG32* cVars, ICorDebugInfo::NativeVarInfo** vars);
 
+    void recSetPatchpointInfo(PatchpointInfo* patchpointInfo);
+    void dmpSetPatchpointInfo(DWORD key, const Agnostic_SetPatchpointInfo& value);
+    bool repSetPatchpointInfo(PatchpointInfo** patchpointInfo);
+
     void recAllocGCInfo(size_t size, void* retval);
     void recAllocGCInfoCapture();
     void dmpAllocGCInfo(DWORD key, const Agnostic_AllocGCInfo& value);

src/coreclr/src/ToolBox/superpmi/superpmi-shared/crlwmlist.h

@@ -41,6 +41,7 @@ LWM(SetEHcount, DWORD, DWORD)
 LWM(SetEHinfo, DWORD, CompileResult::Agnostic_CORINFO_EH_CLAUSE2)
 LWM(SetMethodAttribs, DWORDLONG, DWORD)
 LWM(SetVars, DWORD, CompileResult::Agnostic_SetVars)
+LWM(SetPatchpointInfo, DWORD, CompileResult::Agnostic_SetPatchpointInfo)
 
 #undef LWM
 #undef DENSELWM

src/coreclr/src/ToolBox/superpmi/superpmi-shared/icorjitinfoimpl.h

@@ -180,6 +180,15 @@ void getGSCookie(GSCookie*  pCookieVal, // OUT
                  GSCookie** ppCookieVal // OUT
                  );
 
+// Provide patchpoint info for the method currently being jitted.
+void setPatchpointInfo(
+            PatchpointInfo* patchpointInfo
+            );
+
+PatchpointInfo* getOSRInfo(
+           unsigned * ilOffset   // OUT
+           );
+
 /**********************************************************************************/
 //
 // ICorModuleInfo

src/coreclr/src/ToolBox/superpmi/superpmi-shared/lwmlist.h

@@ -112,6 +112,7 @@ LWM(GetMethodSync, DWORDLONG, DLDL)
 LWM(GetMethodVTableOffset, DWORDLONG, DDD)
 LWM(GetNewArrHelper, DWORDLONG, DWORD)
 LWM(GetNewHelper, Agnostic_GetNewHelper, DD)
+LWM(GetOSRInfo, DWORD, Agnostic_GetOSRInfo)
 LWM(GetParentType, DWORDLONG, DWORDLONG)
 LWM(GetProfilingHandle, DWORD, Agnostic_GetProfilingHandle)
 LWM(GetReadyToRunHelper, GetReadyToRunHelper_TOKENin, GetReadyToRunHelper_TOKENout)
@@ -152,5 +153,6 @@ LWM(TryResolveToken, Agnostic_CORINFO_RESOLVED_TOKENin, TryResolveTokenValue)
 LWM(SatisfiesClassConstraints, DWORDLONG, DWORD)
 LWM(SatisfiesMethodConstraints, DLDL, DWORD)
 
+
 #undef LWM
 #undef DENSELWM

src/coreclr/src/ToolBox/superpmi/superpmi-shared/methodcontext.cpp

@@ -727,6 +727,7 @@ void MethodContext::repCompileMethod(CORINFO_METHOD_INFO* info, unsigned* flags)
     info->locals.pSig  = (PCCOR_SIGNATURE)CompileMethod->GetBuffer(value.info.locals.pSig_Index);
     info->locals.scope = (CORINFO_MODULE_HANDLE)value.info.locals.scope;
     info->locals.token = (mdToken)value.info.locals.token;
+
     *flags             = (unsigned)value.flags;
     DEBUG_REP(dmpCompileMethod(0, value));
 }
@@ -3965,6 +3966,39 @@ void MethodContext::repGetGSCookie(GSCookie* pCookieVal, GSCookie** ppCookieVal)
         *ppCookieVal = (GSCookie*)value.B;
 }
 
+void MethodContext::recGetOSRInfo(PatchpointInfo* patchpointInfo, unsigned* ilOffset)
+{
+    if (GetOSRInfo == nullptr)
+    {
+        GetOSRInfo = new LightWeightMap<DWORD, Agnostic_GetOSRInfo>();
+    }
+
+    Agnostic_GetOSRInfo value;
+
+    value.index = (DWORD)GetOSRInfo->AddBuffer((const unsigned char*) patchpointInfo, patchpointInfo->PatchpointInfoSize());
+    value.ilOffset = *ilOffset;
+
+    // use 0 for key
+    DWORD key = 0;
+    GetOSRInfo->Add(key, value);
+    DEBUG_REC(dmpGetOSRInfo(key, value));
+}
+
+void MethodContext::dmpGetOSRInfo(DWORD key, const Agnostic_GetOSRInfo& value)
+{
+    // todo - dump patchpoint info?
+    printf("GetOSRInfo key %u, value patchpointInfo-%u {...} iloffset-%u\n",
+        key, value.index, value.ilOffset);
+}
+
+PatchpointInfo* MethodContext::repGetOSRInfo(unsigned* ilOffset)
+{
+    DWORD key = 0;
+    Agnostic_GetOSRInfo value = GetOSRInfo->Get(key);
+    *ilOffset = value.ilOffset;
+    return (PatchpointInfo*)GetOSRInfo->GetBuffer(value.index);
+}
+
 void MethodContext::recGetClassModuleIdForStatics(CORINFO_CLASS_HANDLE   cls,
                                                   CORINFO_MODULE_HANDLE* pModule,
                                                   void**                 ppIndirection,

src/coreclr/src/ToolBox/superpmi/superpmi-shared/methodcontext.h

@@ -176,6 +176,11 @@ class MethodContext
         DWORD targetAbi;
         DWORD osType;
     };
+    struct Agnostic_GetOSRInfo
+    {
+        DWORD index;
+        unsigned ilOffset;
+    };
     struct Agnostic_GetFieldAddress
     {
         DWORDLONG ppIndirection;
@@ -986,6 +991,10 @@ class MethodContext
     void dmpGetGSCookie(DWORD key, DLDL value);
     void repGetGSCookie(GSCookie* pCookieVal, GSCookie** ppCookieVal);
 
+    void recGetOSRInfo(PatchpointInfo* patchpointInfo, unsigned* ilOffset);
+    void dmpGetOSRInfo(DWORD key, const Agnostic_GetOSRInfo& value);
+    PatchpointInfo* repGetOSRInfo(unsigned* ilOffset);
+
     void recGetClassModuleIdForStatics(CORINFO_CLASS_HANDLE   cls,
                                        CORINFO_MODULE_HANDLE* pModule,
                                        void**                 ppIndirection,
@@ -1309,7 +1318,7 @@ class MethodContext
 };
 
 // ********************* Please keep this up-to-date to ease adding more ***************
-// Highest packet number: 175
+// Highest packet number: 177
 // *************************************************************************************
 enum mcPackets
 {
@@ -1420,6 +1429,7 @@ enum mcPackets
     Packet_GetMethodVTableOffset                         = 78,
     Packet_GetNewArrHelper                               = 79,
     Packet_GetNewHelper                                  = 80,
+    Packet_GetOSRInfo                                    = 177, // Added 3/5/2020
     Packet_GetParentType                                 = 81,
     Packet_GetPInvokeUnmanagedTarget                     = 82, // Retired 2/18/2020
     Packet_GetProfilingHandle                            = 83,
@@ -1487,6 +1497,7 @@ enum mcPackets
     PacketCR_SetEHinfo                         = 128,
     PacketCR_SetMethodAttribs                  = 129,
     PacketCR_SetVars                           = 130,
+    PacketCR_SetPatchpointInfo                 = 176, // added 8/5/2019
     PacketCR_RecordCallSite                    = 146, // Added 10/28/2013 - to support indirect calls
 };
 

src/coreclr/src/ToolBox/superpmi/superpmi-shared/runtimedetails.h

@@ -25,6 +25,7 @@
 #include <mscoree.h>
 #include <corjit.h>
 #include <utilcode.h>
+#include <patchpointinfo.h>
 
 /// Turn back on direct access to a few OS level things...
 #undef HeapCreate

src/coreclr/src/ToolBox/superpmi/superpmi-shim-collector/icorjitinfo.cpp

@@ -365,6 +365,23 @@ void interceptor_ICJI::getGSCookie(GSCookie*  pCookieVal, // OUT
     mc->recGetGSCookie(pCookieVal, ppCookieVal);
 }
 
+// Provide patchpoint info for the method currently being jitted.
+void interceptor_ICJI::setPatchpointInfo(PatchpointInfo* patchpointInfo)
+{
+    mc->cr->AddCall("setPatchpointInfo");
+    mc->cr->recSetPatchpointInfo(patchpointInfo); // Since the EE frees, we've gotta record before its sent to the EE.
+    original_ICorJitInfo->setPatchpointInfo(patchpointInfo);
+}
+
+// Get OSR info for the method currently being jitted
+PatchpointInfo* interceptor_ICJI::getOSRInfo(unsigned* ilOffset)
+{
+    mc->cr->AddCall("getOSRInfo");
+    PatchpointInfo* patchpointInfo = original_ICorJitInfo->getOSRInfo(ilOffset);
+    mc->recGetOSRInfo(patchpointInfo, ilOffset);
+    return patchpointInfo;
+}
+
 /**********************************************************************************/
 //
 // ICorModuleInfo

src/coreclr/src/ToolBox/superpmi/superpmi-shim-counter/icorjitinfo.cpp

@@ -262,6 +262,20 @@ void interceptor_ICJI::getGSCookie(GSCookie*  pCookieVal, // OUT
     original_ICorJitInfo->getGSCookie(pCookieVal, ppCookieVal);
 }
 
+// Provide patchpoint info for the method currently being jitted.
+void interceptor_ICJI::setPatchpointInfo(PatchpointInfo* patchpointInfo)
+{
+    mcs->AddCall("setPatchpointInfo");
+    original_ICorJitInfo->setPatchpointInfo(patchpointInfo);
+}
+
+// Get OSR info for the method currently being jitted
+PatchpointInfo* interceptor_ICJI::getOSRInfo(unsigned* ilOffset)
+{
+    mcs->AddCall("getOSRInfo");
+    return original_ICorJitInfo->getOSRInfo(ilOffset);
+}
+
 /**********************************************************************************/
 //
 // ICorModuleInfo

src/coreclr/src/ToolBox/superpmi/superpmi-shim-simple/icorjitinfo.cpp

@@ -237,6 +237,19 @@ void interceptor_ICJI::getGSCookie(GSCookie*  pCookieVal, // OUT
     original_ICorJitInfo->getGSCookie(pCookieVal, ppCookieVal);
 }
 
+
+// Provide patchpoint info for the method currently being jitted.
+void interceptor_ICJI::setPatchpointInfo(PatchpointInfo* patchpointInfo)
+{
+    original_ICorJitInfo->setPatchpointInfo(patchpointInfo);
+}
+
+// Get OSR info for the method currently being jitted
+PatchpointInfo* interceptor_ICJI::getOSRInfo(unsigned* ilOffset)
+{
+    return original_ICorJitInfo->getOSRInfo(ilOffset);
+}
+
 /**********************************************************************************/
 //
 // ICorModuleInfo

src/coreclr/src/ToolBox/superpmi/superpmi/icorjitinfo.cpp

@@ -288,6 +288,21 @@ void MyICJI::getGSCookie(GSCookie*  pCookieVal, // OUT
     jitInstance->mc->repGetGSCookie(pCookieVal, ppCookieVal);
 }
 
+// Provide patchpoint info for the method currently being jitted.
+void MyICJI::setPatchpointInfo(PatchpointInfo* patchpointInfo)
+{
+    jitInstance->mc->cr->AddCall("setPatchpointInfo");
+    jitInstance->mc->cr->recSetPatchpointInfo(patchpointInfo);
+    freeArray(patchpointInfo); // See note in recSetPatchpointInfo... we own destroying this array
+}
+
+// Get OSR info for the method currently being jitted
+PatchpointInfo* MyICJI::getOSRInfo(unsigned* ilOffset)
+{
+    jitInstance->mc->cr->AddCall("getOSRInfo");
+    return jitInstance->mc->repGetOSRInfo(ilOffset);
+}
+
 /**********************************************************************************/
 //
 // ICorModuleInfo

src/coreclr/src/inc/CrstTypes.def

@@ -351,6 +351,10 @@ End
 Crst JitGenericHandleCache
 End
 
+Crst JitPatchpoint
+    AcquiredBefore LoaderHeap
+End
+
 Crst JitPerf
     Unordered
 End

src/coreclr/src/inc/clrconfigvalues.h

@@ -644,6 +644,16 @@ RETAIL_CONFIG_DWORD_INFO(INTERNAL_TC_DeleteCallCountingStubsAfter, W("TC_DeleteC
 #endif
 #endif
 
+///
+/// On-Stack Replacement
+///
+#ifdef FEATURE_ON_STACK_REPLACEMENT
+RETAIL_CONFIG_DWORD_INFO(INTERNAL_OSR_CounterBump, W("OSR_CounterBump"), 1000, "Counter reload value when a patchpoint is hit")
+RETAIL_CONFIG_DWORD_INFO(INTERNAL_OSR_HitLimit, W("OSR_HitLimit"), 10, "Number of times a patchpoint must call back to trigger an OSR transition")
+CONFIG_DWORD_INFO(INTERNAL_OSR_LowId, W("OSR_LowId"), (DWORD)-1, "Low end of enabled patchpoint range (inclusive)");
+CONFIG_DWORD_INFO(INTERNAL_OSR_HighId, W("OSR_HighId"), 10000000, "High end of enabled patchpoint range (inclusive)");
+#endif
+
 ///
 /// Entry point slot backpatch
 ///

src/coreclr/src/inc/corinfo.h

@@ -217,11 +217,11 @@ TODO: Talk about initializing strutures before use
 #endif
 #endif
 
-SELECTANY const GUID JITEEVersionIdentifier = { /* b2e40020-6125-41e4-a0fc-821127ec192a */
-    0xb2e40020,
-    0x6125,
-    0x41e4,
-    {0xa0, 0xfc, 0x82, 0x11, 0x27, 0xec, 0x19, 0x2a}
+SELECTANY const GUID JITEEVersionIdentifier = { /* c231d2d7-4764-4097-a9ef-5961041540df */
+    0xc231d2d7,
+    0x4764,
+    0x4097,
+    {0xa9, 0xef, 0x59, 0x61, 0x04, 0x15, 0x40, 0xdf}
 };
 
 //////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -631,6 +631,8 @@ enum CorInfoHelpFunc
 
     CORINFO_HELP_STACK_PROBE,               // Probes each page of the allocated stack frame
 
+    CORINFO_HELP_PATCHPOINT,                // Notify runtime that code has reached a patchpoint
+
     CORINFO_HELP_COUNT,
 };
 
@@ -1083,6 +1085,11 @@ inline bool dontInline(CorInfoInline val) {
     return(val < 0);
 }
 
+// Patchpoint info is passed back and forth across the interface
+// but is opaque.
+
+struct PatchpointInfo;
+
 // Cookie types consumed by the code generator (these are opaque values
 // not inspected by the code generator):
 
@@ -2145,6 +2152,16 @@ class ICorStaticInfo
             GSCookie ** ppCookieVal                    // OUT
             ) = 0;
 
+    // Provide patchpoint info for the method currently being jitted.
+    virtual void setPatchpointInfo(
+            PatchpointInfo* patchpointInfo
+            ) = 0;
+
+    // Get patchpoint info and il offset for the method currently being jitted.
+    virtual PatchpointInfo* getOSRInfo(
+            unsigned                       *ilOffset        // [OUT] il offset of OSR entry point
+            ) = 0;
+
     /**********************************************************************************/
     //
     // ICorModuleInfo

src/coreclr/src/inc/corjitflags.h

@@ -52,7 +52,7 @@ class CORJIT_FLAGS
 
     #endif // !defined(TARGET_X86)
 
-        CORJIT_FLAG_UNUSED6                 = 13,
+        CORJIT_FLAG_OSR                     = 13, // Generate alternate method for On Stack Replacement
 
     #if defined(TARGET_X86) || defined(TARGET_AMD64)