Add eaEscapeHelperSymbol

compiler/compile/OMRSymbolReferenceTable.cpp

@@ -2033,6 +2033,19 @@ OMR::SymbolReferenceTable::findOrCreateOSRFearPointHelperSymbolRef()
    return element(osrFearPointHelperSymbol);
    }
 
+TR::SymbolReference *
+OMR::SymbolReferenceTable::findOrCreateEAEscapeHelperSymbolRef()
+   {
+   if (!element(eaEscapeHelperSymbol))
+      {
+      TR::MethodSymbol* sym = TR::MethodSymbol::create(trHeapMemory(), TR_None);
+      sym->setHelper();
+      TR::SymbolReference* symRef = new (trHeapMemory()) TR::SymbolReference(self(), eaEscapeHelperSymbol, sym);
+      element(eaEscapeHelperSymbol) = symRef;
+      }
+   return element(eaEscapeHelperSymbol);
+   }
+
 TR::SymbolReference *
 OMR::SymbolReferenceTable::getOriginalUnimprovedSymRef(TR::SymbolReference *symRef)
    {

compiler/compile/OMRSymbolReferenceTable.hpp

@@ -175,6 +175,21 @@ class SymbolReferenceTable
        *   The call is not to be codegen evaluated, it should be cleaned up before codegen.
        */
       osrFearPointHelperSymbol,
+      /** \brief
+       * 
+       * A call with this symbol marks a place where we want/need escape analysis to add heapifications for any stack allocated
+       * objects. The primary use case is to force escape of all live local objects ahead of a throw to an OSR catch block
+       * but they may also be inserted to facilitate peeking of methods under HCR or other uses. Calls to this helper should
+       * only exist while escape analysis is running
+       *
+       * \code
+       *   call <eaEscapeHelperSymbol>
+       * \endcode
+       *
+       * \note
+       *   The call is not to be codegen evaluated, it should be cleaned up by postEscapeAnalysis.
+       */
+      eaEscapeHelperSymbol,
       lowTenureAddressSymbol,    // on j9vmthread
       highTenureAddressSymbol,   // on j9vmthread
       fragmentParentSymbol,
@@ -461,6 +476,7 @@ class SymbolReferenceTable
    TR::SymbolReference * findOrCreateJProfileValuePlaceHolderWithNullCHKSymbolRef();
    TR::SymbolReference * findOrCreatePotentialOSRPointHelperSymbolRef();
    TR::SymbolReference * findOrCreateOSRFearPointHelperSymbolRef();
+   TR::SymbolReference * findOrCreateEAEscapeHelperSymbolRef();
    TR::SymbolReference * findOrCreateInduceOSRSymbolRef(TR_RuntimeHelper induceOSRHelper);
 
    TR::ParameterSymbol * createParameterSymbol(TR::ResolvedMethodSymbol * owningMethodSymbol, int32_t slot, TR::DataType, TR::KnownObjectTable::Index knownObjectIndex = TR::KnownObjectTable::UNKNOWN);

compiler/il/Aliases.cpp

@@ -132,6 +132,13 @@ OMR::SymbolReference::getUseonlyAliasesBV(TR::SymbolReferenceTable * symRefTab)
             return &symRefTab->aliasBuilder.defaultMethodUseAliases();
             }
 
+         // Aliases for eaEscapeHelper
+         // Ensure EA sees the method as causing an escape for all arguments passed
+         if (symRefTab->isNonHelper(self(), TR::SymbolReferenceTable::eaEscapeHelperSymbol))
+            {
+            return &symRefTab->aliasBuilder.defaultMethodUseAliases();
+            }
+
          if (!methodSymbol->isHelper())
             {
             return &symRefTab->aliasBuilder.defaultMethodUseAliases();
@@ -312,7 +319,8 @@ OMR::SymbolReference::getUseDefAliasesBV(bool isDirectCall, bool includeGCSafePo
 
          if (symRefTab->isNonHelper(self(), TR::SymbolReferenceTable::arraySetSymbol) ||
              symRefTab->isNonHelper(self(), TR::SymbolReferenceTable::osrFearPointHelperSymbol) ||
-             symRefTab->isNonHelper(self(), TR::SymbolReferenceTable::potentialOSRPointHelperSymbol))
+             symRefTab->isNonHelper(self(), TR::SymbolReferenceTable::potentialOSRPointHelperSymbol) ||
+             symRefTab->isNonHelper(self(), TR::SymbolReferenceTable::eaEscapeHelperSymbol))
             {
             return &symRefTab->aliasBuilder.defaultMethodDefAliases();
             }

compiler/il/OMRNode.cpp

@@ -1241,6 +1241,16 @@ OMR::Node::createOSRFearPointHelperCall(TR::Node* originatingByteCodeNode)
    return callNode;
    }
 
+TR::Node *
+OMR::Node::createEAEscapeHelperCall(TR::Node* originatingByteCodeNode, int32_t numChildren)
+   {
+   TR::Compilation* comp = TR::comp();
+
+   TR_ASSERT(!comp->isPeekingMethod(), "Can not generate the helper call during peeking");
+
+   TR::Node* callNode = TR::Node::createWithSymRef(originatingByteCodeNode, TR::call, numChildren, TR::comp()->getSymRefTab()->findOrCreateEAEscapeHelperSymbolRef());
+   return callNode;
+   }
 
 TR::Node *
 OMR::Node::createLoad(TR::SymbolReference * symRef)
@@ -8698,3 +8708,16 @@ OMR::Node::isPotentialOSRPointHelperCall()
 
    return false;
    }
+
+bool
+OMR::Node::isEAEscapeHelperCall()
+   {
+   TR::Compilation *c = TR::comp();
+
+   if (self()->getOpCode().isCall()
+       && self()->getSymbol()->isMethod()
+       && c->getSymRefTab()->isNonHelper(self()->getSymbolReference(), TR::SymbolReferenceTable::eaEscapeHelperSymbol))
+      return true;
+
+   return false;
+   }

compiler/il/OMRNode.hpp

@@ -298,6 +298,13 @@ class OMR_EXTENSIBLE Node
     *
     */
    static TR::Node *createOSRFearPointHelperCall(TR::Node* originatingByteCodeNode);
+   /**
+    * \brief
+    *    Create a call to eaEscapeHelperSymbol
+    * 
+    * \parm originatingByteCodeNode The node whose bytecode info is used to create the call
+    */
+   static TR::Node *createEAEscapeHelperCall(TR::Node *originatingByteCodeNode, int32_t numChildren);
 
    static TR::Node *createLoad(TR::SymbolReference * symRef);
    static TR::Node *createLoad(TR::Node *originatingByteCodeNode, TR::SymbolReference *);
@@ -556,6 +563,11 @@ class OMR_EXTENSIBLE Node
     *    Return true if the node is a call with potentialOSRPointHelperSymbol
     */
    bool                   isPotentialOSRPointHelperCall();
+   /**
+    * \brief
+    *    Return true if the node is a call with eaEscapeHelperSymbol
+    */
+   bool                   isEAEscapeHelperCall();
 
    // A common query used by the optimizer
    inline bool            isSingleRef();

compiler/ras/Debug.cpp

@@ -1651,10 +1651,8 @@ TR_Debug::getName(TR::SymbolReference * symRef)
              return "<potentialOSRPointHelper>";
          case TR::SymbolReferenceTable::osrFearPointHelperSymbol:
              return "<osrFearPointHelper>";
-         case TR::SymbolReferenceTable::jProfileValueSymbol:
-             return "<jProfileValuePlaceHolder>";
-         case TR::SymbolReferenceTable::jProfileValueWithNullCHKSymbol:
-             return "<jProfileValueWithNullCHKPlaceHolder>";
+         case TR::SymbolReferenceTable::eaEscapeHelperSymbol:
+             return "<eaEscapeHelper>";
          }
       }
 
@@ -2084,6 +2082,7 @@ static const char *commonNonhelperSymbolNames[] =
    "<osrReturnAddress>",
    "<potentialOSRPointHelper>",
    "<osrFearPointHelper>",
+   "<eaEscapeHelper>",
    "<lowTenureAddress>",
    "<highTenureAddress>",
    "<fragmentParent>",