a34c753fe7
Summary: Moves source files into separate components, and make explicit component dependency on each other, so LLVM build system knows how to build BOLT in BUILD_SHARED_LIBS=ON. Please use the -c merge.renamelimit=230 git option when rebasing your work on top of this change. To achieve this, we create a new library to hold core IR files (most classes beginning with Binary in their names), a new library to hold Utils, some command line options shared across both RewriteInstance and core IR files, a new library called Rewrite to hold most classes concerned with running top-level functions coordinating the binary rewriting process, and a new library called Profile to hold classes dealing with profile reading and writing. To remove the dependency from BinaryContext into X86-specific classes, we do some refactoring on the BinaryContext constructor to receive a reference to the specific backend directly from RewriteInstance. Then, the dependency on X86 or AArch64-specific classes is transfered to the Rewrite library. We can't have the Core library depend on targets because targets depend on Core (which would create a cycle). Files implementing the entry point of a tool are transferred to the tools/ folder. All header files are transferred to the include/ folder. The src/ folder was renamed to lib/. (cherry picked from FBD32746834)
110 lines
3.9 KiB
C++
110 lines
3.9 KiB
C++
//===------HugifyRuntimeLibrary.cpp - The Hugify Runtime Library ----------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "bolt/RuntimeLibs/HugifyRuntimeLibrary.h"
|
|
#include "bolt/Core/BinaryFunction.h"
|
|
#include "llvm/ExecutionEngine/RuntimeDyld.h"
|
|
#include "llvm/MC/MCStreamer.h"
|
|
#include "llvm/Support/Alignment.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
|
|
using namespace llvm;
|
|
using namespace bolt;
|
|
|
|
namespace opts {
|
|
|
|
extern cl::OptionCategory BoltOptCategory;
|
|
|
|
extern cl::opt<bool> HotText;
|
|
|
|
cl::opt<bool>
|
|
Hugify("hugify",
|
|
cl::desc("Automatically put hot code on 2MB page(s) (hugify) at "
|
|
"runtime. No manual call to hugify is needed in the binary "
|
|
"(which is what --hot-text relies on)."),
|
|
cl::ZeroOrMore, cl::cat(BoltOptCategory));
|
|
|
|
static cl::opt<std::string> RuntimeHugifyLib(
|
|
"runtime-hugify-lib",
|
|
cl::desc("specify file name of the runtime hugify library"), cl::ZeroOrMore,
|
|
cl::init("libbolt_rt_hugify.a"), cl::cat(BoltOptCategory));
|
|
|
|
} // namespace opts
|
|
|
|
void HugifyRuntimeLibrary::adjustCommandLineOptions(
|
|
const BinaryContext &BC) const {
|
|
if (opts::HotText) {
|
|
errs()
|
|
<< "BOLT-ERROR: -hot-text should be applied to binaries with "
|
|
"pre-compiled manual hugify support, while -hugify will add hugify "
|
|
"support automatcally. These two options cannot both be present.\n";
|
|
exit(1);
|
|
}
|
|
// After the check, we set HotText to be true because automated hugify support
|
|
// relies on it.
|
|
opts::HotText = true;
|
|
if (!BC.StartFunctionAddress) {
|
|
errs() << "BOLT-ERROR: hugify runtime libraries require a known entry "
|
|
"point of "
|
|
"the input binary\n";
|
|
exit(1);
|
|
}
|
|
}
|
|
|
|
void HugifyRuntimeLibrary::emitBinary(BinaryContext &BC, MCStreamer &Streamer) {
|
|
const BinaryFunction *StartFunction =
|
|
BC.getBinaryFunctionAtAddress(*(BC.StartFunctionAddress));
|
|
assert(!StartFunction->isFragment() && "expected main function fragment");
|
|
if (!StartFunction) {
|
|
errs() << "BOLT-ERROR: failed to locate function at binary start address\n";
|
|
exit(1);
|
|
}
|
|
|
|
const auto Flags = BinarySection::getFlags(/*IsReadOnly=*/false,
|
|
/*IsText=*/false,
|
|
/*IsAllocatable=*/true);
|
|
MCSectionELF *Section =
|
|
BC.Ctx->getELFSection(".bolt.hugify.entries", ELF::SHT_PROGBITS, Flags);
|
|
|
|
// __bolt_hugify_init_ptr stores the poiter the hugify library needs to
|
|
// jump to after finishing the init code.
|
|
MCSymbol *InitPtr = BC.Ctx->getOrCreateSymbol("__bolt_hugify_init_ptr");
|
|
|
|
Section->setAlignment(llvm::Align(BC.RegularPageSize));
|
|
Streamer.SwitchSection(Section);
|
|
|
|
Streamer.emitLabel(InitPtr);
|
|
Streamer.emitSymbolAttribute(InitPtr, MCSymbolAttr::MCSA_Global);
|
|
Streamer.emitValue(
|
|
MCSymbolRefExpr::create(StartFunction->getSymbol(), *(BC.Ctx)),
|
|
/*Size=*/8);
|
|
}
|
|
|
|
void HugifyRuntimeLibrary::link(BinaryContext &BC, StringRef ToolPath,
|
|
RuntimeDyld &RTDyld,
|
|
std::function<void(RuntimeDyld &)> OnLoad) {
|
|
std::string LibPath = getLibPath(ToolPath, opts::RuntimeHugifyLib);
|
|
loadLibrary(LibPath, RTDyld);
|
|
OnLoad(RTDyld);
|
|
RTDyld.finalizeWithMemoryManagerLocking();
|
|
if (RTDyld.hasError()) {
|
|
outs() << "BOLT-ERROR: RTDyld failed: " << RTDyld.getErrorString() << "\n";
|
|
exit(1);
|
|
}
|
|
|
|
assert(!RuntimeStartAddress &&
|
|
"We don't currently support linking multiple runtime libraries");
|
|
RuntimeStartAddress = RTDyld.getSymbol("__bolt_hugify_self").getAddress();
|
|
if (!RuntimeStartAddress) {
|
|
errs() << "BOLT-ERROR: instrumentation library does not define "
|
|
"__bolt_hugify_self: "
|
|
<< LibPath << "\n";
|
|
exit(1);
|
|
}
|
|
}
|