Add full support for calls on z/OS and enable corresponding tests

buildenv/jenkins/jobs/builds/Build-zos_390-64

@@ -30,7 +30,7 @@ pipeline {
                 timestamps {
                     dir('build') {
                         echo 'Configure...'
-                        sh '''cmake -Wdev -C../cmake/caches/Travis.cmake -DCMAKE_C_COMPILER=/bin/c89 -DCMAKE_CXX_COMPILER=/bin/xlc -DOMR_DDR=OFF -DOMR_THR_FORK_SUPPORT=0 ..'''
+                        sh '''cmake -Wdev -C../cmake/caches/Travis.cmake -DCMAKE_C_COMPILER=/bin/c89 -DCMAKE_CXX_COMPILER=/bin/xlc -DOMR_DDR=OFF -DOMR_THR_FORK_SUPPORT=0 -DOMR_JITBUILDER_TEST_EXTENDED=1 ..'''
                         echo 'Compile...'
                         sh '''make -j4'''
                     }

buildenv/jenkins/jobs/pull-requests/PullRequest-zos_390-64

@@ -16,7 +16,7 @@ pipeline {
                 timestamps {
                     dir('build') {
                         echo 'Configure...'
-                        sh '''cmake -Wdev -C../cmake/caches/Travis.cmake -DCMAKE_C_COMPILER=/bin/c89 -DCMAKE_CXX_COMPILER=/bin/xlc -DOMR_DDR=OFF -DOMR_THR_FORK_SUPPORT=0 ..'''
+                        sh '''cmake -Wdev -C../cmake/caches/Travis.cmake -DCMAKE_C_COMPILER=/bin/c89 -DCMAKE_CXX_COMPILER=/bin/xlc -DOMR_DDR=OFF -DOMR_THR_FORK_SUPPORT=0 -DOMR_JITBUILDER_TEST_EXTENDED=1 ..'''
                         echo 'Compile...'
                         sh '''make -j4'''
                     }

compiler/codegen/OMRCodeGenPhase.cpp

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2019 IBM Corp. and others
+ * Copyright (c) 2000, 2020 IBM Corp. and others
  *
  * This program and the accompanying materials are made available under
  * the terms of the Eclipse Public License 2.0 which accompanies this
@@ -180,48 +180,44 @@ OMR::CodeGenPhase::performProcessRelocationsPhase(TR::CodeGenerator * cg, TR::Co
      }
 
    if (cg->getAheadOfTimeCompile() && (comp->getOption(TR_TraceRelocatableDataCG) || comp->getOption(TR_TraceRelocatableDataDetailsCG) || comp->getOption(TR_TraceReloCG)))
-     {
-     traceMsg(comp, "\n<relocatableDataCG>\n");
-     if (comp->getOption(TR_TraceRelocatableDataDetailsCG)) // verbose output
-        {
-        uint8_t * relocatableMethodCodeStart = (uint8_t *)comp->getRelocatableMethodCodeStart();
-        traceMsg(comp, "Code start = %8x, Method start pc = %x, Method start pc offset = 0x%x\n", relocatableMethodCodeStart, cg->getCodeStart(), cg->getCodeStart() - relocatableMethodCodeStart);
-        }
-     cg->getAheadOfTimeCompile()->dumpRelocationData();
-     traceMsg(comp, "</relocatableDataCG>\n");
-     }
+      {
+      traceMsg(comp, "\n<relocatableDataCG>\n");
+      if (comp->getOption(TR_TraceRelocatableDataDetailsCG)) // verbose output
+         {
+         uint8_t * relocatableMethodCodeStart = (uint8_t *)comp->getRelocatableMethodCodeStart();
+         traceMsg(comp, "Code start = %8x, Method start pc = %x, Method start pc offset = 0x%x\n", relocatableMethodCodeStart, cg->getCodeStart(), cg->getCodeStart() - relocatableMethodCodeStart);
+         }
+      cg->getAheadOfTimeCompile()->dumpRelocationData();
+      traceMsg(comp, "</relocatableDataCG>\n");
+      }
 
-     if (debug("dumpCodeSizes"))
-        {
-        diagnostic("%08d   %s\n", cg->getCodeLength(), comp->signature());
-        }
+   if (debug("dumpCodeSizes"))
+      {
+      diagnostic("%08d   %s\n", cg->getCodeLength(), comp->signature());
+      }
 
-     if (comp->getCurrentMethod() == NULL)
-        {
-        comp->getMethodSymbol()->setMethodAddress(cg->getBinaryBufferStart());
-        }
+   TR_ASSERT(cg->getCodeLength() <= cg->getEstimatedCodeLength(),
+      "Method length estimate must be conservatively large\n"
+      "    codeLength = %d, estimatedCodeLength = %d \n",
+      cg->getCodeLength(), cg->getEstimatedCodeLength()
+   );
 
-     TR_ASSERT(cg->getCodeLength() <= cg->getEstimatedCodeLength(),
-               "Method length estimate must be conservatively large\n"
-               "    codeLength = %d, estimatedCodeLength = %d \n",
-               cg->getCodeLength(), cg->getEstimatedCodeLength()
-               );
+   // also trace the interal stack atlas
+   cg->getStackAtlas()->close(cg);
 
-     // also trace the interal stack atlas
-     cg->getStackAtlas()->close(cg);
+   TR::SimpleRegex * regex = comp->getOptions()->getSlipTrap();
+   if (regex && TR::SimpleRegex::match(regex, comp->getCurrentMethod()))
+      {
+      if (cg->comp()->target().is64Bit())
+         {
+         setDllSlip((char*)cg->getCodeStart(), (char*)cg->getCodeStart() + cg->getCodeLength(), "SLIPDLL64", comp);
+         }
+      else
+         {
+         setDllSlip((char*)cg->getCodeStart(), (char*)cg->getCodeStart() + cg->getCodeLength(), "SLIPDLL31", comp);
+         }
+      }
 
-     TR::SimpleRegex * regex = comp->getOptions()->getSlipTrap();
-     if (regex && TR::SimpleRegex::match(regex, comp->getCurrentMethod()))
-        {
-        if (cg->comp()->target().is64Bit())
-        {
-        setDllSlip((char*)cg->getCodeStart(),(char*)cg->getCodeStart()+cg->getCodeLength(),"SLIPDLL64", comp);
-        }
-     else
-        {
-        setDllSlip((char*)cg->getCodeStart(),(char*)cg->getCodeStart()+cg->getCodeLength(),"SLIPDLL31", comp);
-        }
-     }
    if (comp->getOption(TR_TraceCG) || comp->getOptions()->getTraceCGOption(TR_TraceCGPostBinaryEncoding))
       {
       const char * title = "Post Relocation Instructions";
@@ -304,6 +300,9 @@ OMR::CodeGenPhase::performBinaryEncodingPhase(TR::CodeGenerator * cg, TR::CodeGe
 
    cg->doBinaryEncoding();
 
+   // Instructions have been emitted, and now we know what the entry point is, so update the compilation method symbol
+   comp->getMethodSymbol()->setMethodAddress(cg->getCodeStart());
+
    if (debug("verifyFinalNodeReferenceCounts"))
       {
       if (cg->getDebug())

compiler/control/CompileMethod.cpp

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2019 IBM Corp. and others
+ * Copyright (c) 2000, 2020 IBM Corp. and others
  *
  * This program and the accompanying materials are made available under
  * the terms of the Eclipse Public License 2.0 which accompanies this
@@ -379,7 +379,7 @@ compileMethodFromDetails(
          // not ready yet...
          //OMR::MethodMetaDataPOD *metaData = fe.createMethodMetaData(&compiler);
 
-         startPC = compiler.cg()->getCodeStart();
+         startPC = (uint8_t*)compiler.getMethodSymbol()->getMethodAddress();
          uint64_t translationTime = TR::Compiler->vm.getUSecClock() - translationStartTime;
 
          if (TR::Options::isAnyVerboseOptionSet(TR_VerboseCompileEnd, TR_VerbosePerformance))

compiler/z/codegen/OMRLinkage.cpp

@@ -2035,32 +2035,7 @@ OMR::Z::Linkage::buildArgs(TR::Node * callNode, TR::RegisterDependencyConditions
          argSize += gprSize;
       }
 
-   bool isXPLinkToPureOSLinkageCall = false;
-   if (!self()->isFirstParmAtFixedOffset())
-      {
-      stackOffset = argSize;
-      }
-   else
-      {
-      stackOffset = self()->getOffsetToFirstParm();
-
-      if (isXPLinkToPureOSLinkageCall)
-         {
-         // Load argument list (GPR1) pointer here in XPLink to OS linkage call
-         // The OS linkage argument list is embedded in the XPLink outbound argument area
-         // at offset 8 instead of 0 (to bypass collision with long displacement slot)
-         TR::Register *r1Reg = self()->cg()->allocateRegister();
-         if (stackOffset == self()->getOffsetToLongDispSlot())
-            {
-            stackOffset += 8; // avoid first parm at long displacement slot
-            }
-         TR::RealRegister * stackPtr = self()->getNormalStackPointerRealRegister();
-         generateRXInstruction(self()->cg(), TR::InstOpCode::LA, callNode, r1Reg,
-                   generateS390MemoryReference(stackPtr, stackOffset, self()->cg()));
-         dependencies->addPreCondition(r1Reg, TR::RealRegister::GPR1);
-         self()->cg()->stopUsingRegister(r1Reg);
-         }
-      }
+   stackOffset = self()->isFirstParmAtFixedOffset() ? self()->getOffsetToFirstParm() : argSize;
 
    //store env register
    stackOffset = self()->storeExtraEnvRegForBuildArgs(callNode, self(), dependencies, isFastJNI, stackOffset, gprSize, numIntegerArgs);
@@ -2114,28 +2089,24 @@ OMR::Z::Linkage::buildArgs(TR::Node * callNode, TR::RegisterDependencyConditions
 
                if (self()->isSkipGPRsForFloatParms())
                   {
-                  if (numIntegerArgs < self()->getNumIntegerArgumentRegisters())
-                     {
-                     numIntegerArgs++;
-                     }
+                  numIntegerArgs++;
                   }
                break;
                }
          case TR::Double:
 #ifdef J9_PROJECT_SPECIFIC
          case TR::DecimalDouble:
+#endif
             argRegister = self()->pushArg(callNode, child, numIntegerArgs, numFloatArgs, &stackOffset, dependencies);
 
             numFloatArgs++;
 
             if (self()->isSkipGPRsForFloatParms())
                {
-               if (numIntegerArgs < self()->getNumIntegerArgumentRegisters())
-                  {
-                  numIntegerArgs += (self()->cg()->comp()->target().is64Bit()) ? 1 : 2;
-                  }
+               numIntegerArgs += (self()->cg()->comp()->target().is64Bit()) ? 1 : 2;
                }
             break;
+#ifdef J9_PROJECT_SPECIFIC
          case TR::DecimalLongDouble:
             if (numFloatArgs%2 == 1)
                { // need to skip fp arg 'hole' for long double arg

compiler/z/codegen/SystemLinkagezOS.cpp

@@ -245,9 +245,11 @@ void TR::S390zOSSystemLinkage::createPrologue(TR::Instruction* cursor)
 
    TR::CodeGenerator* cg = self()->cg();
 
+   _xplinkFunctionDescriptorSnippet = new (self()->trHeapMemory()) XPLINKFunctionDescriptorSnippet(cg);
    _ppa1Snippet = new (self()->trHeapMemory()) TR::PPA1Snippet(cg, this);
    _ppa2Snippet = new (self()->trHeapMemory()) TR::PPA2Snippet(cg, this);
 
+   cg->addSnippet(_xplinkFunctionDescriptorSnippet);
    cg->addSnippet(_ppa1Snippet);
    cg->addSnippet(_ppa2Snippet);
 
@@ -527,8 +529,6 @@ TR::S390zOSSystemLinkage::generateInstructionsForCall(TR::Node * callNode, TR::R
       TR::Register * methodAddressReg, TR::Register * javaLitOffsetReg, TR::LabelSymbol * returnFromJNICallLabel,
       TR::S390JNICallDataSnippet * jniCallDataSnippet, bool isJNIGCPoint)
    {
-   TR::CodeGenerator * codeGen = cg();
-
     // WCode specific
     //
     // There are 4 cases for outgoing branch sequences
@@ -551,40 +551,61 @@ TR::S390zOSSystemLinkage::generateInstructionsForCall(TR::Node * callNode, TR::R
     //             a) disp is an offset in the environment (aka ADA) containing the
     //                function descriptor body (i.e. not pointer to function descriptor)
     TR_XPLinkCallTypes callType;
+
+    TR::Register* aeReg = deps->searchPostConditionRegister(getENVPointerRegister());
+    TR::Register* epReg = deps->searchPostConditionRegister(getEntryPointRegister());
+    TR::Register* raReg = deps->searchPostConditionRegister(getReturnAddressRegister());
 
-    // Find GPR6 (xplink) or GPR15 (os linkage) in post conditions
-    TR::Register * systemEntryPointRegister = deps->searchPostConditionRegister(getEntryPointRegister());
-    // Find GPR7 (xplik) or GPR14 (os linkage) in post conditions
-    TR::Register * systemReturnAddressRegister = deps->searchPostConditionRegister(getReturnAddressRegister());
-
-    TR::RegisterDependencyConditions * preDeps = new (trHeapMemory()) TR::RegisterDependencyConditions(deps->getPreConditions(), NULL, deps->getAddCursorForPre(), 0, cg());
+    TR::RegisterDependencyConditions* preDeps = new (trHeapMemory()) TR::RegisterDependencyConditions(deps->getPreConditions(), NULL, deps->getAddCursorForPre(), 0, cg());
+    TR::RegisterDependencyConditions* postDeps = new (trHeapMemory()) TR::RegisterDependencyConditions(NULL, deps->getPostConditions(), 0, deps->getAddCursorForPost(), cg());
 
     if (callNode->getOpCode().isIndirect())
        {
-       generateRRInstruction(cg(), InstOpCode::BASR, callNode, systemReturnAddressRegister, systemEntryPointRegister, preDeps);
+       TR::Register* targetAddress = cg()->evaluate(callNode->getFirstChild());
+
+       generateRSInstruction(cg(), TR::InstOpCode::getLoadMultipleOpCode(), callNode, aeReg, epReg, generateS390MemoryReference(targetAddress, 0, cg()));
+       generateRRInstruction(cg(), InstOpCode::BASR, callNode, raReg, epReg, preDeps);
        callType = TR_XPLinkCallType_BASR;
        }
     else
        {
+       TR::SymbolReference* callSymRef = callNode->getSymbolReference();
+       TR::Symbol* callSymbol = callSymRef->getSymbol();
+
+       if (comp()->isRecursiveMethodTarget(callSymbol))
+          {
+          // No need to load the environment or the entry point for recursive calls because these values are not used
+          // within OMR compiled methods
+          TR::Instruction* callInstr = new (cg()->trHeapMemory()) TR::S390RILInstruction(TR::InstOpCode::BRASL, callNode, raReg, callSymbol, callSymRef, cg());
+          callInstr->setDependencyConditions(preDeps);
+          }
+       else
+          {
+          struct FunctionDescriptor
+             {
+             void* environment;
+             void* func;
+             };
+
+          FunctionDescriptor* fd = reinterpret_cast<FunctionDescriptor*>(callSymbol->castToMethodSymbol()->getMethodAddress());
 
-       TR::SymbolReference *callSymRef = callNode->getSymbolReference();
-       TR::Symbol *callSymbol = callSymRef->getSymbol();
+          genLoadAddressConstant(cg(), callNode, reinterpret_cast<uintptr_t>(fd), epReg);
+          generateRSInstruction(cg(), TR::InstOpCode::getLoadMultipleOpCode(), callNode, aeReg, epReg, generateS390MemoryReference(epReg, 0, cg()));
+
+          TR::Instruction* callInstr = new (cg()->trHeapMemory()) TR::S390RILInstruction(TR::InstOpCode::BRASL, callNode, raReg, fd->func, callSymRef, cg());
+          callInstr->setDependencyConditions(preDeps);
+          }
 
-       TR::Instruction * callInstr = new (cg()->trHeapMemory()) TR::S390RILInstruction(TR::InstOpCode::BRASL, callNode, systemReturnAddressRegister, callSymbol, callSymRef, cg());
-       callInstr->setDependencyConditions(preDeps);
        callType = TR_XPLinkCallType_BRASL7;
        }
 
-    auto cursor = generateS390LabelInstruction(codeGen, InstOpCode::LABEL, callNode, returnFromJNICallLabel);
+    auto cursor = generateS390LabelInstruction(cg(), InstOpCode::LABEL, callNode, returnFromJNICallLabel);
 
     genCallNOPAndDescriptor(cursor, callNode, callNode, callType);
 
     // Append post-dependencies after NOP
-    TR::LabelSymbol * afterNOP = generateLabelSymbol(cg());
-    TR::RegisterDependencyConditions * postDeps =
-          new (trHeapMemory()) TR::RegisterDependencyConditions(NULL,
-                deps->getPostConditions(), 0, deps->getAddCursorForPost(), cg());
-    generateS390LabelInstruction(codeGen, InstOpCode::LABEL, callNode, afterNOP, postDeps);
+    TR::LabelSymbol* depsLabel = generateLabelSymbol(cg());
+    generateS390LabelInstruction(cg(), InstOpCode::LABEL, callNode, depsLabel, postDeps);
 }
 TR::LabelSymbol*
 TR::S390zOSSystemLinkage::getEntryPointMarkerLabel() const
@@ -1117,3 +1138,54 @@ TR::S390zOSSystemLinkage::XPLINKCallDescriptorRelocation::apply(TR::CodeGenerato
    uint8_t* p = getUpdateLocation();
    *reinterpret_cast<int16_t*>(p) = static_cast<int16_t>(offsetToCallDescriptor);
    }
+
+TR::S390zOSSystemLinkage::XPLINKFunctionDescriptorSnippet::XPLINKFunctionDescriptorSnippet(TR::CodeGenerator* cg)
+   :
+      TR::S390ConstantDataSnippet(cg, NULL, NULL, cg->comp()->target().is32Bit() ? 8 : 16)
+   {
+   if (cg->comp()->target().is32Bit())
+      {
+      *(reinterpret_cast<uint32_t*>(_value) + 0) = 0;
+      *(reinterpret_cast<uint32_t*>(_value) + 1) = 0;
+      }
+   else
+      {
+      *(reinterpret_cast<uint64_t*>(_value) + 0) = 0;
+      *(reinterpret_cast<uint64_t*>(_value) + 1) = 0;
+      }
+   }
+
+uint8_t*
+TR::S390zOSSystemLinkage::XPLINKFunctionDescriptorSnippet::emitSnippetBody()
+   {
+   uint8_t* cursor = cg()->getBinaryBufferCursor();
+
+   // TODO: We should not have to do this here. This should be done by the caller.
+   getSnippetLabel()->setCodeLocation(cursor);
+
+   // Update the method symbol address to point to the function descriptor
+   cg()->comp()->getMethodSymbol()->setMethodAddress(cursor);
+
+   if (cg()->comp()->target().is32Bit())
+      {
+      // Address of function's environment
+      *reinterpret_cast<uint32_t*>(cursor) = 0;
+      cursor += sizeof(uint32_t);
+
+      // Function of function
+      *reinterpret_cast<uint32_t**>(cursor) = reinterpret_cast<uint32_t*>(cg()->getCodeStart());
+      cursor += sizeof(uint32_t);
+      }
+   else
+      {
+      // Address of function's environment
+      *reinterpret_cast<uint64_t*>(cursor) = 0;
+      cursor += sizeof(uint64_t);
+
+      // Function of function
+      *reinterpret_cast<uint64_t**>(cursor) = reinterpret_cast<uint64_t*>(cg()->getCodeStart());
+      cursor += sizeof(uint64_t);
+      }
+
+   return cursor;
+   }

compiler/z/codegen/SystemLinkagezOS.hpp

@@ -31,6 +31,7 @@
 #include "codegen/SystemLinkage.hpp"
 #include "codegen/snippet/PPA1Snippet.hpp"
 #include "codegen/snippet/PPA2Snippet.hpp"
+#include "codegen/ConstantDataSnippet.hpp"
 #include "env/TRMemory.hpp"
 #include "env/jittypes.h"
 #include "il/DataTypes.hpp"
@@ -105,6 +106,23 @@ class S390zOSSystemLinkage : public TR::SystemLinkage
       TR::Instruction* _nop;
       };
 
+   /** \brief
+    *
+    *  Represents the XPLINK function descriptor which is a data structure that represents the address of a function
+    *  retrieved via the C '&' operator. The data structure holds the actual value of the execution entry point of the
+    *  function it describes.
+    *
+    *  [1] https://www-01.ibm.com/servers/resourcelink/svc00100.nsf/pages/zOSV2R3SA380688/$file/ceev100_v2r3.pdf (page 140)
+    */
+   class XPLINKFunctionDescriptorSnippet : public TR::S390ConstantDataSnippet
+      {
+      public:
+
+         XPLINKFunctionDescriptorSnippet(TR::CodeGenerator* cg);
+
+         virtual uint8_t* emitSnippetBody();
+      };
+
    public:
 
    /** \brief
@@ -174,6 +192,7 @@ class S390zOSSystemLinkage : public TR::SystemLinkage
    TR::LabelSymbol* _entryPointMarkerLabel;
    TR::LabelSymbol* _stackPointerUpdateLabel;
 
+   XPLINKFunctionDescriptorSnippet* _xplinkFunctionDescriptorSnippet;
    TR::PPA1Snippet* _ppa1Snippet;
    TR::PPA2Snippet* _ppa2Snippet;
    };