Files
ark_js_runtime/ecmascript/compiler/llvm_codegen.cpp
T
songzhengchao ede3113e23 Implement CallingConv to compatible with Fast-Stub/ASM-INT/AOT
1 Current ASM-INT(GHCC)/Fast-Stub(WebKit_jscc) set different FrameType to distinguish with CallingConv.It's more friendly to add callingConv flag in CallSignature class.
2 Fast-Stub/Aot CallingConv is WebKit_jscc while LLVM Backend don't support it on arm32. we'll add padding paramets to JS-Relative paramter is placed on stack.

issue: https://gitee.com/openharmony/ark_js_runtime/issues/I4ZYPN?from=project-issue

Signed-off-by: songzhengchao <songzhengchao@huawei.com>
Change-Id: I93df6c1d605692941b1aa362ad4e07a202d76241
2022-03-29 11:51:39 +08:00

312 lines
12 KiB
C++

/*
* Copyright (c) 2021 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "llvm_codegen.h"
#include <string>
#include <vector>
#include "ecmascript/compiler/call_signature.h"
#include "ecmascript/compiler/compiler_macros.h"
#include "ecmascript/compiler/stub-inl.h"
#include "ecmascript/ecma_macros.h"
#include "ecmascript/object_factory.h"
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wshadow"
#pragma clang diagnostic ignored "-Wunused-parameter"
#elif defined(__GNUC__)
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wshadow"
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
#include "ecmascript/compiler/call_signature.h"
#include "llvm-c/Analysis.h"
#include "llvm-c/Core.h"
#include "llvm-c/Disassembler.h"
#include "llvm-c/DisassemblerTypes.h"
#include "llvm-c/Target.h"
#include "llvm-c/Transforms/PassManagerBuilder.h"
#include "llvm-c/Transforms/Scalar.h"
#include "llvm/ADT/APInt.h"
#include "llvm/CodeGen/BuiltinGCs.h"
#include "llvm/ExecutionEngine/ExecutionEngine.h"
#include "llvm/ExecutionEngine/GenericValue.h"
#include "llvm/IR/Argument.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/InstrTypes.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/LegacyPassManager.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Verifier.h"
#include "llvm/IRReader/IRReader.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Host.h"
#include "llvm/Support/TargetSelect.h"
#include "llvm/Transforms/Scalar.h"
#include "llvm/llvm_stackmap_parser.h"
#if defined(__clang__)
#pragma clang diagnostic pop
#elif defined(__GNUC__)
#pragma GCC diagnostic pop
#endif
using namespace panda::ecmascript;
namespace panda::ecmascript::kungfu {
void LLVMIRGeneratorImpl::GenerateCodeForStub(Circuit *circuit, const ControlFlowGraph &graph, size_t index,
const CompilationConfig *cfg)
{
LLVMValueRef function = module_->GetFunction(index);
const CallSignature* cs = module_->GetCSign(index);
LLVMIRBuilder builder(&graph, circuit, module_, function, cfg, cs->GetCallConv());
builder.Build();
}
void LLVMIRGeneratorImpl::GenerateCode(Circuit *circuit, const ControlFlowGraph &graph, const CompilationConfig *cfg,
const panda::ecmascript::JSMethod *method)
{
auto function = module_->AddFunc(method);
LLVMIRBuilder builder(&graph, circuit, module_, function, cfg, CallSignature::CallConv::WebKitJSCallConv);
builder.Build();
}
static uint8_t *RoundTripAllocateCodeSection(void *object, uintptr_t size, [[maybe_unused]] unsigned alignment,
[[maybe_unused]] unsigned sectionID, const char *sectionName)
{
COMPILER_LOG(DEBUG) << "RoundTripAllocateCodeSection object " << object << " - ";
struct CodeInfo& state = *static_cast<struct CodeInfo*>(object);
uint8_t *addr = state.AllocaCodeSection(size, sectionName);
COMPILER_LOG(DEBUG) << "RoundTripAllocateCodeSection addr:" << std::hex <<
reinterpret_cast<std::uintptr_t>(addr) << addr << " size:0x" << size << " + ";
return addr;
}
static uint8_t *RoundTripAllocateDataSection(void *object, uintptr_t size, [[maybe_unused]] unsigned alignment,
[[maybe_unused]] unsigned sectionID, const char *sectionName,
[[maybe_unused]] LLVMBool isReadOnly)
{
struct CodeInfo& state = *static_cast<struct CodeInfo*>(object);
return state.AllocaDataSection(size, sectionName);
}
static LLVMBool RoundTripFinalizeMemory(void *object, [[maybe_unused]] char **errMsg)
{
COMPILER_LOG(DEBUG) << "RoundTripFinalizeMemory object " << object << " - ";
return 0;
}
static void RoundTripDestroy(void *object)
{
COMPILER_LOG(DEBUG) << "RoundTripDestroy object " << object << " - ";
}
void LLVMAssembler::UseRoundTripSectionMemoryManager()
{
auto sectionMemoryManager = std::make_unique<llvm::SectionMemoryManager>();
options_.MCJMM =
LLVMCreateSimpleMCJITMemoryManager(&codeInfo_, RoundTripAllocateCodeSection,
RoundTripAllocateDataSection, RoundTripFinalizeMemory, RoundTripDestroy);
}
bool LLVMAssembler::BuildMCJITEngine()
{
COMPILER_LOG(DEBUG) << " BuildMCJITEngine - ";
LLVMBool ret = LLVMCreateMCJITCompilerForModule(&engine_, module_, &options_, sizeof(options_), &error_);
if (ret) {
LOG_ECMA(FATAL) << "error_ : " << error_;
return false;
}
COMPILER_LOG(DEBUG) << " BuildMCJITEngine + ";
return true;
}
void LLVMAssembler::BuildAndRunPasses()
{
COMPILER_LOG(DEBUG) << "BuildAndRunPasses - ";
LLVMPassManagerBuilderRef pmBuilder = LLVMPassManagerBuilderCreate();
LLVMPassManagerBuilderSetOptLevel(pmBuilder, options_.OptLevel); // using O3 optimization level
LLVMPassManagerBuilderSetSizeLevel(pmBuilder, 0);
// pass manager creation:rs4gc pass is the only pass in modPass, other opt module-based pass are in modPass1
LLVMPassManagerRef funcPass = LLVMCreateFunctionPassManagerForModule(module_);
LLVMPassManagerRef modPass = LLVMCreatePassManager();
LLVMPassManagerRef modPass1 = LLVMCreatePassManager();
// add pass into pass managers
LLVMPassManagerBuilderPopulateFunctionPassManager(pmBuilder, funcPass);
llvm::unwrap(modPass)->add(llvm::createRewriteStatepointsForGCLegacyPass()); // rs4gc pass added
LLVMPassManagerBuilderPopulateModulePassManager(pmBuilder, modPass1);
LLVMRunPassManager(modPass, module_); // make sure rs4gc pass run first
LLVMInitializeFunctionPassManager(funcPass);
for (LLVMValueRef fn = LLVMGetFirstFunction(module_); fn; fn = LLVMGetNextFunction(fn)) {
LLVMRunFunctionPassManager(funcPass, fn);
}
LLVMFinalizeFunctionPassManager(funcPass);
LLVMRunPassManager(modPass1, module_);
LLVMPassManagerBuilderDispose(pmBuilder);
LLVMDisposePassManager(funcPass);
LLVMDisposePassManager(modPass);
LLVMDisposePassManager(modPass1);
COMPILER_LOG(DEBUG) << "BuildAndRunPasses + ";
}
LLVMAssembler::LLVMAssembler(LLVMModuleRef module, bool isFpElim) : module_(module)
{
Initialize(isFpElim);
}
LLVMAssembler::~LLVMAssembler()
{
if (engine_ != nullptr) {
if (module_ != nullptr) {
char *error = nullptr;
LLVMRemoveModule(engine_, module_, &module_, &error);
if (error != nullptr) {
LLVMDisposeMessage(error);
}
}
LLVMDisposeExecutionEngine(engine_);
engine_ = nullptr;
}
module_ = nullptr;
error_ = nullptr;
}
void LLVMAssembler::Run()
{
char *error = nullptr;
#if ECMASCRIPT_ENABLE_COMPILER_LOG
char *info = LLVMPrintModuleToString(module_);
COMPILER_LOG(INFO) << "Current Module: " << info;
LLVMDisposeMessage(info);
#endif
std::string originName = llvm::unwrap(module_)->getModuleIdentifier() + ".ll";
std::string optName = llvm::unwrap(module_)->getModuleIdentifier() + "_opt" + ".ll";
LLVMPrintModuleToFile(module_, originName.c_str(), &error);
LLVMVerifyModule(module_, LLVMAbortProcessAction, &error);
LLVMDisposeMessage(error);
UseRoundTripSectionMemoryManager();
if (!BuildMCJITEngine()) {
return;
}
BuildAndRunPasses();
LLVMPrintModuleToFile(module_, optName.c_str(), &error);
}
void LLVMAssembler::Initialize(bool isFpElim)
{
std::string triple(LLVMGetTarget(module_));
if (triple.compare("x86_64-unknown-linux-gnu") == 0) {
LLVMInitializeX86TargetInfo();
LLVMInitializeX86TargetMC();
LLVMInitializeX86Disassembler();
/* this method must be called, ohterwise "Target does not support MC emission" */
LLVMInitializeX86AsmPrinter();
LLVMInitializeX86AsmParser();
LLVMInitializeX86Target();
} else if (triple.compare("aarch64-unknown-linux-gnu") == 0) {
LLVMInitializeAArch64TargetInfo();
LLVMInitializeAArch64TargetMC();
LLVMInitializeAArch64Disassembler();
LLVMInitializeAArch64AsmPrinter();
LLVMInitializeAArch64AsmParser();
LLVMInitializeAArch64Target();
} else if (triple.compare("arm-unknown-linux-gnu") == 0) {
LLVMInitializeARMTargetInfo();
LLVMInitializeARMTargetMC();
LLVMInitializeARMDisassembler();
LLVMInitializeARMAsmPrinter();
LLVMInitializeARMAsmParser();
LLVMInitializeARMTarget();
} else {
UNREACHABLE();
}
llvm::linkAllBuiltinGCs();
LLVMInitializeMCJITCompilerOptions(&options_, sizeof(options_));
options_.OptLevel = 3; // opt level 3
// NOTE: Just ensure that this field still exists for PIC option
options_.NoFramePointerElim = isFpElim ? false : true;
options_.CodeModel = LLVMCodeModelSmall;
}
#if ECMASCRIPT_ENABLE_COMPILER_LOG
static const char *SymbolLookupCallback([[maybe_unused]] void *disInfo, [[maybe_unused]] uint64_t referenceValue,
uint64_t *referenceType, [[maybe_unused]]uint64_t referencePC,
[[maybe_unused]] const char **referenceName)
{
*referenceType = LLVMDisassembler_ReferenceType_InOut_None;
return nullptr;
}
#endif
void LLVMAssembler::Disassemble([[maybe_unused]] const std::map<uint64_t, std::string> &addr2name) const
{
#if ECMASCRIPT_ENABLE_COMPILER_LOG
LLVMDisasmContextRef dcr = LLVMCreateDisasm(LLVMGetTarget(module_), nullptr, 0, nullptr, SymbolLookupCallback);
std::cout << "========================================================================" << std::endl;
for (auto it : codeInfo_.GetCodeInfo()) {
uint8_t *byteSp;
uintptr_t numBytes;
byteSp = it.first;
numBytes = it.second;
std::cout << " byteSp:" << std::hex << reinterpret_cast<std::uintptr_t>(byteSp) << " numBytes:0x" << numBytes
<< std::endl;
unsigned pc = 0;
const char outStringSize = 100;
char outString[outStringSize];
while (numBytes != 0) {
size_t InstSize = LLVMDisasmInstruction(dcr, byteSp, numBytes, pc, outString, outStringSize);
if (InstSize == 0) {
std::cerr.fill('0');
std::cerr.width(8); // 8:fixed hex print width
std::cerr << std::hex << pc << ":";
std::cerr.width(8); // 8:fixed hex print width
std::cerr << std::hex << *reinterpret_cast<uint32_t *>(byteSp) << "maybe constant" << std::endl;
pc += 4; // 4 pc length
byteSp += 4; // 4 sp offset
numBytes -= 4; // 4 num bytes
}
uint64_t addr = reinterpret_cast<uint64_t>(byteSp);
if (addr2name.find(addr) != addr2name.end()) {
std::cout << addr2name[addr].c_str() << ":" << std::endl;
}
std::cerr.fill('0');
std::cerr.width(8); // 8:fixed hex print width
std::cerr << std::hex << pc << ":";
std::cerr.width(8); // 8:fixed hex print width
std::cerr << std::hex << *reinterpret_cast<uint32_t *>(byteSp) << " " << outString << std::endl;
pc += InstSize;
byteSp += InstSize;
numBytes -= InstSize;
}
}
std::cout << "========================================================================" << std::endl;
LLVMDisasmDispose(dcr);
#endif
}
} // namespace panda::ecmascript::kungfu