J9CodeGenerator.hpp

/*******************************************************************************
 * Copyright (c) 2000, 2022 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 https://www.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 J9_POWER_CODEGENERATOR_INCL
#define J9_POWER_CODEGENERATOR_INCL

/*
 * The following #define and typedef must appear before any #includes in this file
 */
#ifndef J9_CODEGENERATOR_CONNECTOR
#define J9_CODEGENERATOR_CONNECTOR
namespace J9 { namespace Power { class CodeGenerator; } }
namespace J9 { typedef J9::Power::CodeGenerator CodeGeneratorConnector; }
#else
#error J9::Power::CodeGenerator expected to be a primary connector, but a J9 connector is already defined
#endif

#include "j9cfg.h"
#include "compiler/codegen/J9CodeGenerator.hpp"

#include <stdint.h>
#include "codegen/LinkageConventionsEnum.hpp"
#include "env/jittypes.h"

namespace TR { class Recompilation; }

extern TR::Instruction *loadAddressRAM32(TR::CodeGenerator *cg,
                                    TR::Node * node,
                                    int32_t value,
                                    TR::Register *trgReg);

extern TR::Instruction *loadAddressRAM(TR::CodeGenerator *cg,
                                    TR::Node        *node,
                                    intptr_t         value,
                                    TR::Register    *targetRegister);

extern TR::Instruction *loadAddressJNI32(TR::CodeGenerator *cg,
                                    TR::Node * node,
                                    int32_t value,
                                    TR::Register *trgReg);

extern TR::Instruction *loadAddressJNI(TR::CodeGenerator *cg,
                                    TR::Node        *node,
                                    intptr_t         value,
                                    TR::Register    *targetRegister);

namespace J9
{

namespace Power
{

class OMR_EXTENSIBLE CodeGenerator : public J9::CodeGenerator
   {

protected:

   CodeGenerator(TR::Compilation *comp);

public:

   void initialize();

   TR::Recompilation *allocateRecompilationInfo();

   TR::Linkage *createLinkage(TR_LinkageConventions lc);

   void generateBinaryEncodingPrologue(TR_PPCBinaryEncodingData *data);

   void lowerTreeIfNeeded(TR::Node *node, int32_t childNumber, TR::Node *parent, TR::TreeTop *tt);

   bool inlineDirectCall(TR::Node *node, TR::Register *&resultReg);

   TR::Linkage *deriveCallingLinkage(TR::Node *node, bool isIndirect);

   bool suppressInliningOfRecognizedMethod(TR::RecognizedMethod method);

   bool enableAESInHardwareTransformations();

   void insertPrefetchIfNecessary(TR::Node *node, TR::Register *targetRegister);

   int32_t getInternalPtrMapBit() { return 18;}

   bool canEmitDataForExternallyRelocatableInstructions();

#ifdef J9VM_OPT_JAVA_CRYPTO_ACCELERATION
   bool suppressInliningOfCryptoMethod(TR::RecognizedMethod method);
   bool inlineCryptoMethod(TR::Node *node, TR::Register *&resultReg);
#endif

   /**
    * \brief Determines whether the code generator supports stack allocations
    */
   bool supportsStackAllocations() { return true; }

   // See J9::CodeGenerator::guaranteesResolvedDirectDispatchForSVM
   bool guaranteesResolvedDirectDispatchForSVM() { return true; }
   };

}

}

#endif