Skip to content

Commit

Permalink
RISC-V: implement helper call snippet
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Vrany <jan.vrany@fit.cvut.cz>
  • Loading branch information
janvrany committed Jan 29, 2021
1 parent 9ed05d5 commit 3dab8a0
Show file tree
Hide file tree
Showing 5 changed files with 239 additions and 3 deletions.
4 changes: 3 additions & 1 deletion compiler/ras/Debug.hpp
@@ -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
Expand Down Expand Up @@ -390,6 +390,7 @@ namespace TR { class UtypeInstruction; }
namespace TR { class JtypeInstruction; }
namespace TR { class LoadInstruction; }
namespace TR { class StoreInstruction; }
namespace TR { class RVHelperCallSnippet; }

TR_Debug *createDebugObject(TR::Compilation *);

Expand Down Expand Up @@ -1188,6 +1189,7 @@ class TR_Debug
void print(TR::FILE *, TR::JtypeInstruction *);
void print(TR::FILE *, TR::LoadInstruction * );
void print(TR::FILE *, TR::StoreInstruction *);
void print(TR::FILE *, TR::RVHelperCallSnippet *);

void print(TR::FILE *, TR::RealRegister *, TR_RegisterSizes size = TR_WordReg);
void print(TR::FILE *, TR::RegisterDependency *);
Expand Down
3 changes: 2 additions & 1 deletion compiler/riscv/CMakeLists.txt
@@ -1,5 +1,5 @@
#################################################################################
# Copyright (c) 2019, 2019 IBM Corp. and others
# Copyright (c) 2019, 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
Expand Down Expand Up @@ -40,6 +40,7 @@ compiler_library(riscv
${CMAKE_CURRENT_LIST_DIR}/codegen/OMRTreeEvaluator.cpp
${CMAKE_CURRENT_LIST_DIR}/codegen/OpBinary.cpp
${CMAKE_CURRENT_LIST_DIR}/codegen/UnaryEvaluator.cpp
${CMAKE_CURRENT_LIST_DIR}/codegen/RVHelperCallSnippet.cpp
${CMAKE_CURRENT_LIST_DIR}/env/OMRDebugEnv.cpp
${CMAKE_CURRENT_LIST_DIR}/runtime/CodeSync.cpp
)
21 changes: 20 additions & 1 deletion compiler/riscv/codegen/RVDebug.cpp
@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2019, 2020 IBM Corp. and others
* Copyright (c) 2019, 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
Expand Down Expand Up @@ -35,6 +35,7 @@
#include "codegen/RegisterDependencyStruct.hpp"
#include "env/IO.hpp"
#include "il/Block.hpp"
#include "runtime/CodeCacheManager.hpp"

static const char *opCodeToNameMap[] =
{
Expand Down Expand Up @@ -412,3 +413,21 @@ void TR_Debug::printRVOOLSequences(TR::FILE *pOutFile)
{
TR_UNIMPLEMENTED();
}

// This function assumes that if a trampoline is required then it must be to a helper function.
// Use this API only for inquiring about branches to helpers.
bool
TR_Debug::isBranchToTrampoline(TR::SymbolReference *symRef, uint8_t *cursor, int32_t &distance)
{
uintptr_t target = (uintptr_t)symRef->getMethodAddress();
bool requiresTrampoline = false;

if (_cg->directCallRequiresTrampoline(target, (intptr_t)cursor))
{
target = TR::CodeCacheManager::instance()->findHelperTrampoline(symRef->getReferenceNumber(), (void *)cursor);
requiresTrampoline = true;
}

distance = (int32_t)(target - (intptr_t)cursor);
return requiresTrampoline;
}
114 changes: 114 additions & 0 deletions compiler/riscv/codegen/RVHelperCallSnippet.cpp
@@ -0,0 +1,114 @@
/*******************************************************************************
* 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
*******************************************************************************/

#include "codegen/RVHelperCallSnippet.hpp"
#include "codegen/RVInstruction.hpp"
#include "codegen/CodeGenerator.hpp"
#include "codegen/Relocation.hpp"
#include "codegen/SnippetGCMap.hpp"
#include "runtime/CodeCacheManager.hpp"

uint8_t *
TR::RVHelperCallSnippet::emitSnippetBody()
{
uint8_t *cursor = cg()->getBinaryBufferCursor();
intptr_t distance = (intptr_t)(getDestination()->getSymbol()->castToMethodSymbol()->getMethodAddress()) - (intptr_t)cursor;

getSnippetLabel()->setCodeLocation(cursor);

if (!VALID_UJTYPE_IMM(distance))
{
distance = TR::CodeCacheManager::instance()->findHelperTrampoline(getDestination()->getReferenceNumber(), (void *)cursor) - (intptr_t)cursor;
TR_ASSERT_FATAL(VALID_UJTYPE_IMM(distance), "Trampoline too far away.");
}

*(int32_t *)cursor = TR_RISCV_UJTYPE(TR::InstOpCode::_jal, cg()->machine()->getRealRegister(OMR::RealRegister::ra) , distance);

cg()->addExternalRelocation(new (cg()->trHeapMemory()) TR::ExternalRelocation(
cursor,
(uint8_t *)getDestination(),
TR_HelperAddress, cg()), __FILE__, __LINE__, getNode());
cursor += RISCV_INSTRUCTION_LENGTH;

gcMap().registerStackMap(cursor, cg());

if (_restartLabel != NULL)
{
distance = (intptr_t)(_restartLabel->getCodeLocation()) - (intptr_t)cursor;
if (VALID_UJTYPE_IMM(distance))
{
// b distance
*(int32_t *)cursor = TR_RISCV_UJTYPE(TR::InstOpCode::_jal, cg()->machine()->getRealRegister(OMR::RealRegister::zero), distance >> 2);
cursor += RISCV_INSTRUCTION_LENGTH;
}
else
{
TR_ASSERT_FATAL(false, "Target too far away. Not supported yet");
}
}

return cursor;
}

void
TR_Debug::print(TR::FILE *pOutFile, TR::RVHelperCallSnippet * snippet)
{
uint8_t *bufferPos = snippet->getSnippetLabel()->getCodeLocation();
auto restartLabel = snippet->getRestartLabel();

printSnippetLabel(pOutFile, snippet->getSnippetLabel(), bufferPos, getName(snippet));

char *info = "";
intptr_t target = (intptr_t)(snippet->getDestination()->getSymbol()->castToMethodSymbol()->getMethodAddress()) ;
int32_t distance;
if (isBranchToTrampoline(snippet->getDestination(), bufferPos, distance))
{
target = (intptr_t)distance + (intptr_t)bufferPos;
info = " Through trampoline";
TR_ASSERT_FATAL(VALID_UJTYPE_IMM(distance), "Trampoline too far away.");
}

printPrefix(pOutFile, NULL, bufferPos, 4);
trfprintf(pOutFile, "jal \tra, " POINTER_PRINTF_FORMAT "\t\t; %s%s",
target, getName(snippet->getDestination()), info);

if (restartLabel != NULL)
{
bufferPos += RISCV_INSTRUCTION_LENGTH;
intptr_t restartLocation = (intptr_t)restartLabel->getCodeLocation();
if (VALID_UJTYPE_IMM((intptr_t)restartLocation - (intptr_t)bufferPos))
{
printPrefix(pOutFile, NULL, bufferPos, 4);
trfprintf(pOutFile, "jal \tzero, " POINTER_PRINTF_FORMAT "\t\t; Back to ", restartLocation);
print(pOutFile, restartLabel);
}
else
{
TR_ASSERT_FATAL(false, "Target too far away. Not supported yet");
}
}
}

uint32_t
TR::RVHelperCallSnippet::getLength(int32_t estimatedSnippetStart)
{
return ((_restartLabel == NULL) ? 1 : 2) * RISCV_INSTRUCTION_LENGTH;
}
100 changes: 100 additions & 0 deletions compiler/riscv/codegen/RVHelperCallSnippet.hpp
@@ -0,0 +1,100 @@
/*******************************************************************************
* 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 RVHELPERCALLSNIPPET_INCL
#define RVHELPERCALLSNIPPET_INCL

#include "codegen/Snippet.hpp"

#include <stdint.h>
#include "il/SymbolReference.hpp"

namespace TR { class CodeGenerator; }
namespace TR { class LabelSymbol; }
namespace TR { class Node; }

namespace TR {

class RVHelperCallSnippet : public TR::Snippet
{
TR::SymbolReference *_destination;
TR::LabelSymbol *_restartLabel;

public:

/**
* @brief Constructor
*/
RVHelperCallSnippet(TR::CodeGenerator *cg,
TR::Node *node,
TR::LabelSymbol *snippetlab,
TR::SymbolReference *helper,
TR::LabelSymbol *restartLabel=NULL)
: TR::Snippet(cg, node, snippetlab, helper->canCauseGC()),
_destination(helper),
_restartLabel(restartLabel)
{
}

/**
* @brief Answers the Snippet kind
* @return Snippet kind
*/
virtual Kind getKind() { return IsHelperCall; }

/**
* @brief Answers the destination
* @return destination
*/
TR::SymbolReference *getDestination() { return _destination; }
/**
* @brief Sets the destination
* @return destination
*/
TR::SymbolReference *setDestination(TR::SymbolReference *s) { return (_destination = s); }

/**
* @brief Answers the restart label
* @return restart label
*/
TR::LabelSymbol *getRestartLabel() { return _restartLabel; }
/**
* @brief Sets the restart label
* @return restart label
*/
TR::LabelSymbol *setRestartLabel(TR::LabelSymbol *l) { return (_restartLabel=l); }

/**
* @brief Emits the Snippet body
* @return instruction cursor
*/
virtual uint8_t *emitSnippetBody();

/**
* @brief Answers the Snippet length
* @return Snippet length
*/
virtual uint32_t getLength(int32_t estimatedSnippetStart);
};

}

#endif

0 comments on commit 3dab8a0

Please sign in to comment.