Object format changes on Z

Signed-off-by: Rahil Shah <rahil@ca.ibm.com>
eclipse · Feb 1, 2021 · b89ff51 · b89ff51
1 parent 2ccca9b
commit b89ff51
Show file tree

Hide file tree

Showing 8 changed files with 684 additions and 2 deletions.
diff --git a/compiler/objectfmt/OMRObjectFormat.hpp b/compiler/objectfmt/OMRObjectFormat.hpp
@@ -124,7 +124,7 @@ class OMR_EXTENSIBLE ObjectFormat
     * @param[in] data : a populated \c TR::FunctionCallData structure with valid parameters
     *          for an encoded function call.
     */
-   virtual void printEncodedFunctionCall(TR::FILE *file, TR::FunctionCallData &data) = 0;
+   virtual uint8_t* printEncodedFunctionCall(TR::FILE *file, TR::FunctionCallData &data) = 0;
 
    };
 

diff --git a/compiler/z/codegen/OMRCodeGenerator.cpp b/compiler/z/codegen/OMRCodeGenerator.cpp
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2000, 2020 IBM Corp. and others
+ * Copyright (c) 2000, 2021 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
@@ -5794,3 +5794,4 @@ OMR::Z::CodeGenerator::directCallRequiresTrampoline(intptr_t targetAddress, intp
       !self()->comp()->target().cpu.isTargetWithinBranchRelativeRILRange(targetAddress, sourceAddress) ||
       self()->comp()->getOption(TR_StressTrampolines);
    }
+
diff --git a/compiler/z/objectfmt/FunctionCallData.hpp b/compiler/z/objectfmt/FunctionCallData.hpp
@@ -0,0 +1,94 @@
+/*******************************************************************************
+ * Copyright (c) 2021, 2021 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
+ * distribution and is available at http://eclipse.org/legal/epl-2.0
+ * or the Apache License, Version 2.0 which accompanies this distribution
+ * and is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License, v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception [1] and GNU General Public
+ * License, version 2 with the OpenJDK Assembly Exception [2].
+ *
+ * [1] https://www.gnu.org/software/classpath/license.html
+ * [2] http://openjdk.java.net/legal/assembly-exception.html
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
+ *******************************************************************************/
+
+#ifndef TR_FUNCTIONCALLDATA_INCL
+#define TR_FUNCTIONCALLDATA_INCL
+
+#include "infra/Annotations.hpp"
+#include "objectfmt/OMRFunctionCallData.hpp"
+#include "runtime/Runtime.hpp"
+
+namespace TR { class Instruction; }
+namespace TR { class SymbolReference; }
+namespace TR { class Node; }
+namespace TR { class Register; }
+namespace TR { class RegisterDependencyConditions; }
+namespace TR { class CodeGenerator; }
+
+namespace TR
+{
+
+class OMR_EXTENSIBLE FunctionCallData : public OMR::FunctionCallDataConnector
+   {
+public:
+
+   /**
+    * @brief Constructor for FunctionCallData used to generate instruction for
+    *     helper calls
+    *
+    * @param methodSymRef : \c TR::SymbolReference of the function to call.
+    * @param callNode : \c TR::Node node associated with this function call
+    * @param cg : \c TR::CodeGenerator object.
+    * @param returnAddressReg : \c TR::Register used to hold the return address
+    *           for the call instruction.
+    * @param entryPointReg : \c TR::Register used as entry point register where
+    *           target address can not be addressible using Long relative instruction.
+    * @param regDeps : \c TR::RegisterDependencyConditions to be attached to the
+    *           call instruction.
+    * @param prevInstr : \c TR::Instruction preceding to function call.
+    */
+   FunctionCallData(
+         TR::CodeGenerator *cg,
+         TR::SymbolReference *methodSymRef,
+         TR::Node *callNode,
+         TR::Register *returnAddressReg,
+         TR::Register *entryPointReg = NULL,
+         TR::RegisterDependencyConditions *regDeps = NULL,
+         TR::Instruction *prevInstr = NULL) :
+      OMR::FunctionCallDataConnector(cg, methodSymRef, callNode, NULL,
+         static_cast<intptr_t>(0), returnAddressReg, entryPointReg, regDeps, prevInstr,
+         (TR_RuntimeHelper)0, TR_NoRelocation, NULL) {}
+
+   /**
+    * @brief Constructor for FunctionCallData used to encode a function call
+    *
+    * @param methodSymRef : \c TR::SymbolReference of the function to call
+    * @param callNode : \c TR::Node node associated with this function call
+    * @param bufferAddress : \c Buffer address where this function call will be
+    *          encoded from.
+    * @param cg : \c TR::CodeGenerator object
+    * @param snippet : \c TR::Snippet where this function call is encoded
+    * @param reloKind : \c External relocation kind
+    */
+   FunctionCallData(
+         TR::CodeGenerator *cg,
+         TR::SymbolReference *methodSymRef,
+         TR::Node *callNode,
+         uint8_t *bufferAddress,
+         TR::Snippet *snippet,
+         TR_ExternalRelocationTargetKind reloKind = TR_NoRelocation) : 
+      OMR::FunctionCallDataConnector(cg, methodSymRef, callNode, bufferAddress,
+         static_cast<intptr_t>(0), NULL, NULL, NULL, NULL,
+         (TR_RuntimeHelper)0, reloKind, snippet) {}
+   };
+
+}
+#endif
diff --git a/compiler/z/objectfmt/OMRFunctionCallData.hpp b/compiler/z/objectfmt/OMRFunctionCallData.hpp
@@ -0,0 +1,141 @@
+/*******************************************************************************
+ * Copyright (c) 2021, 2021 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
+ * distribution and is available at http://eclipse.org/legal/epl-2.0
+ * or the Apache License, Version 2.0 which accompanies this distribution
+ * and is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License, v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception [1] and GNU General Public
+ * License, version 2 with the OpenJDK Assembly Exception [2].
+ *
+ * [1] https://www.gnu.org/software/classpath/license.html
+ * [2] http://openjdk.java.net/legal/assembly-exception.html
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
+ *******************************************************************************/
+
+#ifndef OMR_Z_FUNCTIONCALLDATA_INCL
+#define OMR_Z_FUNCTIONCALLDATA_INCL
+
+/*
+ * The following #define and typedef must appear before any #includes in this file
+ */
+#ifndef OMR_FUNCTIONCALLDATA_CONNECTOR
+#define OMR_FUNCTIONCALLDATA_CONNECTOR
+namespace OMR { namespace Z { class FunctionCallData; } }
+namespace OMR { typedef OMR::Z::FunctionCallData FunctionCallDataConnector; }
+#endif
+
+#include "compiler/objectfmt/OMRFunctionCallData.hpp"
+#include "runtime/Runtime.hpp"
+
+namespace TR { class Instruction; }
+namespace TR { class SymbolReference; }
+namespace TR { class Node; }
+namespace TR { class Register; }
+namespace TR { class RegisterDependencyConditions; }
+namespace TR { class CodeGenerator; }
+namespace TR { class Snippet; }
+
+namespace OMR
+{
+
+namespace Z
+{
+
+class OMR_EXTENSIBLE FunctionCallData : public OMR::FunctionCallData
+   {
+public:
+
+   /**
+    * @brief Z specific implementation of FunctionCallData
+    *
+    * @param methodSymRef : \c TR::SymbolReference of the function to call
+    * @param callNode : \c TR::Node associcated with the function call
+    * @param bufferAddress : \c In case encoding a function call, instruction
+    *          for call will be encoded from this address. 
+    * @param targetAddress : \c a specific function address to call that
+    *          overrides the address in the symbol reference; or 0 if none
+    * @param returnAddressReg : \c A register to be used to hold the return
+    *          address for the call instruction
+    * @param entryPointReg : \c A register to use as Entry Point Register where
+    *          target address is out of the relative addresssible range of BRASL
+    * @param regDeps : \c TR::RegisterDependencyConditions to be attach to the
+    *          call
+    * @param prevInstr : \c TR::Instruction of the previous instruction, if any
+    * @param runtimeHelperInder : \c the runtime helper index if calling a helper
+    * @param reloKind : \c the external relocation kind associated with this
+    *          function call
+    * @param snippet : \c TR::Snippet in which call is encoded if function is
+    *          called from the snippet.
+    * @param cg : \c TR::CodeGenerator object
+    */
+   FunctionCallData(
+         TR::CodeGenerator *cg,
+         TR::SymbolReference *methodSymRef,
+         TR::Node *callNode,
+         uint8_t *bufferAddress,
+         intptr_t targetAddress,
+         TR::Register *returnAddressReg,
+         TR::Register *entryPointReg,
+         TR::RegisterDependencyConditions *regDeps,
+         TR::Instruction *prevInstr,
+         TR_RuntimeHelper runtimeHelperIndex,
+         TR_ExternalRelocationTargetKind reloKind,
+         TR::Snippet *snippet) :
+      OMR::FunctionCallData(cg, methodSymRef, callNode, bufferAddress),
+         targetAddress(targetAddress),
+         returnAddressReg(returnAddressReg),
+         entryPointReg(entryPointReg),
+         regDeps(regDeps),
+         prevInstr(prevInstr),
+         runtimeHelperIndex(runtimeHelperIndex),
+         reloKind(reloKind),
+         snippet(snippet),
+         out_loadInstr(NULL),
+         out_callInstr(NULL) {}
+
+
+
+   /**
+    * If a non-zero targetAddress is provided, use that as the address of the function to call
+    */
+   uintptr_t targetAddress;
+
+   TR::Register *returnAddressReg;
+
+   TR::Register *entryPointReg;
+
+   TR::RegisterDependencyConditions *regDeps;
+
+   TR::Instruction *prevInstr;
+
+   /**
+    * If an intermediate load instruction was used to materialize the function to
+    * call then it may be set in this field.
+    */
+   TR::Instruction *out_loadInstr;
+
+   /**
+    * The call instruction that was generated to dispatch to the function.
+    */
+   TR::Instruction *out_callInstr;
+
+   TR_RuntimeHelper runtimeHelperIndex;
+
+   TR::Snippet *snippet;
+
+   TR_ExternalRelocationTargetKind reloKind;
+
+   };
+
+}
+
+}
+
+#endif