LTOCodeGenerator.cpp [plain text]
#include "llvm/LTO/LTOCodeGenerator.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Analysis/Passes.h"
#include "llvm/Analysis/TargetLibraryInfo.h"
#include "llvm/Analysis/TargetTransformInfo.h"
#include "llvm/Bitcode/ReaderWriter.h"
#include "llvm/CodeGen/RuntimeLibcalls.h"
#include "llvm/Config/config.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/DiagnosticInfo.h"
#include "llvm/IR/DiagnosticPrinter.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Mangler.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Verifier.h"
#include "llvm/InitializePasses.h"
#include "llvm/LTO/LTOModule.h"
#include "llvm/Linker/Linker.h"
#include "llvm/MC/MCAsmInfo.h"
#include "llvm/MC/MCContext.h"
#include "llvm/MC/SubtargetFeature.h"
#include "llvm/PassManager.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/FormattedStream.h"
#include "llvm/Support/Host.h"
#include "llvm/Support/ManagedStatic.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/Signals.h"
#include "llvm/Support/TargetRegistry.h"
#include "llvm/Support/TargetSelect.h"
#include "llvm/Support/ToolOutputFile.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/Target/TargetLowering.h"
#include "llvm/Target/TargetOptions.h"
#include "llvm/Target/TargetRegisterInfo.h"
#include "llvm/Target/TargetSubtargetInfo.h"
#include "llvm/Transforms/IPO.h"
#include "llvm/Transforms/IPO/PassManagerBuilder.h"
#include "llvm/Transforms/ObjCARC.h"
#include <system_error>
using namespace llvm;
const char* LTOCodeGenerator::getVersionString() {
#ifdef LLVM_VERSION_INFO
#ifdef CLANG_VENDOR
return LLVM_VERSION_INFO;
#else
return PACKAGE_NAME " version " PACKAGE_VERSION ", " LLVM_VERSION_INFO;
#endif // CLANG_VENDOR
#else
return PACKAGE_NAME " version " PACKAGE_VERSION;
#endif
}
LTOCodeGenerator::LTOCodeGenerator()
: Context(&getGlobalContext()),
IRLinker(new Module("ld-temp.o", *Context)) {
initializeLTOPasses();
}
LTOCodeGenerator::LTOCodeGenerator(std::unique_ptr<LLVMContext> Context)
: OwnedContext(std::move(Context)), Context(OwnedContext.get()),
IRLinker(new Module("ld-temp.o", *OwnedContext)) {
initializeLTOPasses();
}
void LTOCodeGenerator::destroyMergedModule() {
if (OwnedModule) {
assert(IRLinker.getModule() == &OwnedModule->getModule() &&
"The linker's module should be the same as the owned module");
delete OwnedModule;
OwnedModule = nullptr;
} else if (IRLinker.getModule())
IRLinker.deleteModule();
}
LTOCodeGenerator::~LTOCodeGenerator() {
destroyMergedModule();
delete TargetMach;
TargetMach = nullptr;
for (std::vector<char *>::iterator I = CodegenOptions.begin(),
E = CodegenOptions.end();
I != E; ++I)
free(*I);
}
void LTOCodeGenerator::initializeLTOPasses() {
PassRegistry &R = *PassRegistry::getPassRegistry();
initializeInternalizePassPass(R);
initializeIPSCCPPass(R);
initializeGlobalOptPass(R);
initializeConstantMergePass(R);
initializeDAHPass(R);
initializeInstructionCombiningPassPass(R);
initializeSimpleInlinerPass(R);
initializePruneEHPass(R);
initializeGlobalDCEPass(R);
initializeArgPromotionPass(R);
initializeJumpThreadingPass(R);
initializeSROAPass(R);
initializeSROA_DTPass(R);
initializeSROA_SSAUpPass(R);
initializeFunctionAttrsPass(R);
initializeGlobalsModRefPass(R);
initializeLICMPass(R);
initializeMergedLoadStoreMotionPass(R);
initializeGVNPass(R);
initializeMemCpyOptPass(R);
initializeDCEPass(R);
initializeCFGSimplifyPassPass(R);
}
bool LTOCodeGenerator::addModule(LTOModule *mod) {
assert(&mod->getModule().getContext() == Context &&
"Expected module in same context");
bool ret = IRLinker.linkInModule(&mod->getModule());
const std::vector<const char*> &undefs = mod->getAsmUndefinedRefs();
for (int i = 0, e = undefs.size(); i != e; ++i)
AsmUndefinedRefs[undefs[i]] = 1;
return !ret;
}
void LTOCodeGenerator::setModule(LTOModule *Mod) {
assert(&Mod->getModule().getContext() == Context &&
"Expected module in same context");
destroyMergedModule();
AsmUndefinedRefs.clear();
OwnedModule = Mod;
IRLinker.setModule(&Mod->getModule());
const std::vector<const char*> &Undefs = Mod->getAsmUndefinedRefs();
for (int I = 0, E = Undefs.size(); I != E; ++I)
AsmUndefinedRefs[Undefs[I]] = 1;
}
void LTOCodeGenerator::setTargetOptions(TargetOptions options) {
Options = options;
}
void LTOCodeGenerator::setDebugInfo(lto_debug_model debug) {
switch (debug) {
case LTO_DEBUG_MODEL_NONE:
EmitDwarfDebugInfo = false;
return;
case LTO_DEBUG_MODEL_DWARF:
EmitDwarfDebugInfo = true;
return;
}
llvm_unreachable("Unknown debug format!");
}
void LTOCodeGenerator::setCodePICModel(lto_codegen_model model) {
switch (model) {
case LTO_CODEGEN_PIC_MODEL_STATIC:
case LTO_CODEGEN_PIC_MODEL_DYNAMIC:
case LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC:
case LTO_CODEGEN_PIC_MODEL_DEFAULT:
CodeModel = model;
return;
}
llvm_unreachable("Unknown PIC model!");
}
bool LTOCodeGenerator::writeMergedModules(const char *path,
std::string &errMsg) {
if (!determineTarget(errMsg))
return false;
applyScopeRestrictions();
std::error_code EC;
tool_output_file Out(path, EC, sys::fs::F_None);
if (EC) {
errMsg = "could not open bitcode file for writing: ";
errMsg += path;
return false;
}
WriteBitcodeToFile(IRLinker.getModule(), Out.os(), ShouldEmbedUselists);
Out.os().close();
if (Out.os().has_error()) {
errMsg = "could not write bitcode file: ";
errMsg += path;
Out.os().clear_error();
return false;
}
Out.keep();
return true;
}
bool LTOCodeGenerator::compileOptimizedToFile(const char **name,
std::string &errMsg) {
SmallString<128> Filename;
int FD;
std::error_code EC =
sys::fs::createTemporaryFile("lto-llvm", "o", FD, Filename);
if (EC) {
errMsg = EC.message();
return false;
}
tool_output_file objFile(Filename.c_str(), FD);
bool genResult = compileOptimized(objFile.os(), errMsg);
objFile.os().close();
if (objFile.os().has_error()) {
objFile.os().clear_error();
sys::fs::remove(Twine(Filename));
return false;
}
objFile.keep();
if (!genResult) {
sys::fs::remove(Twine(Filename));
return false;
}
NativeObjectPath = Filename.c_str();
*name = NativeObjectPath.c_str();
return true;
}
const void *LTOCodeGenerator::compileOptimized(size_t *length,
std::string &errMsg) {
const char *name;
if (!compileOptimizedToFile(&name, errMsg))
return nullptr;
ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
MemoryBuffer::getFile(name, -1, false);
if (std::error_code EC = BufferOrErr.getError()) {
errMsg = EC.message();
sys::fs::remove(NativeObjectPath);
return nullptr;
}
NativeObjectFile = std::move(*BufferOrErr);
sys::fs::remove(NativeObjectPath);
if (!NativeObjectFile)
return nullptr;
*length = NativeObjectFile->getBufferSize();
return NativeObjectFile->getBufferStart();
}
bool LTOCodeGenerator::compile_to_file(const char **name,
bool disableOpt,
bool disableInline,
bool disableGVNLoadPRE,
bool disableVectorization,
std::string &errMsg) {
if (!optimize(disableOpt, disableInline, disableGVNLoadPRE,
disableVectorization, errMsg))
return false;
return compileOptimizedToFile(name, errMsg);
}
const void* LTOCodeGenerator::compile(size_t *length,
bool disableOpt,
bool disableInline,
bool disableGVNLoadPRE,
bool disableVectorization,
std::string &errMsg) {
if (!optimize(disableOpt, disableInline, disableGVNLoadPRE,
disableVectorization, errMsg))
return nullptr;
return compileOptimized(length, errMsg);
}
bool LTOCodeGenerator::determineTarget(std::string &errMsg) {
if (TargetMach)
return true;
std::string TripleStr = IRLinker.getModule()->getTargetTriple();
if (TripleStr.empty())
TripleStr = sys::getDefaultTargetTriple();
llvm::Triple Triple(TripleStr);
const Target *march = TargetRegistry::lookupTarget(TripleStr, errMsg);
if (!march)
return false;
Reloc::Model RelocModel = Reloc::Default;
switch (CodeModel) {
case LTO_CODEGEN_PIC_MODEL_STATIC:
RelocModel = Reloc::Static;
break;
case LTO_CODEGEN_PIC_MODEL_DYNAMIC:
RelocModel = Reloc::PIC_;
break;
case LTO_CODEGEN_PIC_MODEL_DYNAMIC_NO_PIC:
RelocModel = Reloc::DynamicNoPIC;
break;
case LTO_CODEGEN_PIC_MODEL_DEFAULT:
break;
}
SubtargetFeatures Features(MAttr);
Features.getDefaultSubtargetFeatures(Triple);
std::string FeatureStr = Features.getString();
if (MCpu.empty() && Triple.isOSDarwin()) {
if (Triple.getArch() == llvm::Triple::x86_64)
MCpu = "core2";
else if (Triple.getArch() == llvm::Triple::x86)
MCpu = "yonah";
else if (Triple.getArch() == llvm::Triple::aarch64)
MCpu = "cyclone";
}
TargetMach = march->createTargetMachine(TripleStr, MCpu, FeatureStr, Options,
RelocModel, CodeModel::Default,
CodeGenOpt::Aggressive);
return true;
}
void LTOCodeGenerator::
applyRestriction(GlobalValue &GV,
ArrayRef<StringRef> Libcalls,
std::vector<const char*> &MustPreserveList,
SmallPtrSetImpl<GlobalValue*> &AsmUsed,
Mangler &Mangler) {
if (GV.isDeclaration())
return;
if (GV.hasPrivateLinkage())
return;
SmallString<64> Buffer;
TargetMach->getNameWithPrefix(Buffer, &GV, Mangler);
if (MustPreserveSymbols.count(Buffer))
MustPreserveList.push_back(GV.getName().data());
if (AsmUndefinedRefs.count(Buffer))
AsmUsed.insert(&GV);
if (isa<Function>(GV) &&
std::binary_search(Libcalls.begin(), Libcalls.end(), GV.getName()))
AsmUsed.insert(&GV);
}
static void findUsedValues(GlobalVariable *LLVMUsed,
SmallPtrSetImpl<GlobalValue*> &UsedValues) {
if (!LLVMUsed) return;
ConstantArray *Inits = cast<ConstantArray>(LLVMUsed->getInitializer());
for (unsigned i = 0, e = Inits->getNumOperands(); i != e; ++i)
if (GlobalValue *GV =
dyn_cast<GlobalValue>(Inits->getOperand(i)->stripPointerCasts()))
UsedValues.insert(GV);
}
static void accumulateAndSortLibcalls(std::vector<StringRef> &Libcalls,
const TargetLibraryInfo& TLI,
const Module &Mod,
const TargetMachine &TM) {
for (unsigned I = 0, E = static_cast<unsigned>(LibFunc::NumLibFuncs);
I != E; ++I) {
LibFunc::Func F = static_cast<LibFunc::Func>(I);
if (TLI.has(F))
Libcalls.push_back(TLI.getName(F));
}
SmallPtrSet<const TargetLowering *, 1> TLSet;
for (const Function &F : Mod) {
const TargetLowering *Lowering =
TM.getSubtargetImpl(F)->getTargetLowering();
if (Lowering && TLSet.insert(Lowering).second)
for (unsigned I = 0, E = static_cast<unsigned>(RTLIB::UNKNOWN_LIBCALL);
I != E; ++I)
if (const char *Name =
Lowering->getLibcallName(static_cast<RTLIB::Libcall>(I)))
Libcalls.push_back(Name);
}
array_pod_sort(Libcalls.begin(), Libcalls.end());
Libcalls.erase(std::unique(Libcalls.begin(), Libcalls.end()),
Libcalls.end());
}
void LTOCodeGenerator::applyScopeRestrictions() {
if (ScopeRestrictionsDone || !ShouldInternalize)
return;
Module *mergedModule = IRLinker.getModule();
PassManager passes;
passes.add(createVerifierPass());
Mangler Mangler(TargetMach->getDataLayout());
std::vector<const char*> MustPreserveList;
SmallPtrSet<GlobalValue*, 8> AsmUsed;
std::vector<StringRef> Libcalls;
TargetLibraryInfoImpl TLII(Triple(TargetMach->getTargetTriple()));
TargetLibraryInfo TLI(TLII);
accumulateAndSortLibcalls(Libcalls, TLI, *mergedModule, *TargetMach);
for (Module::iterator f = mergedModule->begin(),
e = mergedModule->end(); f != e; ++f)
applyRestriction(*f, Libcalls, MustPreserveList, AsmUsed, Mangler);
for (Module::global_iterator v = mergedModule->global_begin(),
e = mergedModule->global_end(); v != e; ++v)
applyRestriction(*v, Libcalls, MustPreserveList, AsmUsed, Mangler);
for (Module::alias_iterator a = mergedModule->alias_begin(),
e = mergedModule->alias_end(); a != e; ++a)
applyRestriction(*a, Libcalls, MustPreserveList, AsmUsed, Mangler);
GlobalVariable *LLVMCompilerUsed =
mergedModule->getGlobalVariable("llvm.compiler.used");
findUsedValues(LLVMCompilerUsed, AsmUsed);
if (LLVMCompilerUsed)
LLVMCompilerUsed->eraseFromParent();
if (!AsmUsed.empty()) {
llvm::Type *i8PTy = llvm::Type::getInt8PtrTy(*Context);
std::vector<Constant*> asmUsed2;
for (auto *GV : AsmUsed) {
Constant *c = ConstantExpr::getBitCast(GV, i8PTy);
asmUsed2.push_back(c);
}
llvm::ArrayType *ATy = llvm::ArrayType::get(i8PTy, asmUsed2.size());
LLVMCompilerUsed =
new llvm::GlobalVariable(*mergedModule, ATy, false,
llvm::GlobalValue::AppendingLinkage,
llvm::ConstantArray::get(ATy, asmUsed2),
"llvm.compiler.used");
LLVMCompilerUsed->setSection("llvm.metadata");
}
passes.add(createInternalizePass(MustPreserveList));
passes.run(*mergedModule);
ScopeRestrictionsDone = true;
}
bool LTOCodeGenerator::optimize(bool DisableOpt,
bool DisableInline,
bool DisableGVNLoadPRE,
bool DisableVectorization,
std::string &errMsg) {
if (!this->determineTarget(errMsg))
return false;
Module *mergedModule = IRLinker.getModule();
this->applyScopeRestrictions();
PassManager passes;
mergedModule->setDataLayout(*TargetMach->getDataLayout());
passes.add(
createTargetTransformInfoWrapperPass(TargetMach->getTargetIRAnalysis()));
Triple TargetTriple(TargetMach->getTargetTriple());
PassManagerBuilder PMB;
PMB.DisableGVNLoadPRE = DisableGVNLoadPRE;
PMB.LoopVectorize = !DisableVectorization;
PMB.SLPVectorize = !DisableVectorization;
if (!DisableInline)
PMB.Inliner = createFunctionInliningPass();
PMB.LibraryInfo = new TargetLibraryInfoImpl(TargetTriple);
if (DisableOpt)
PMB.OptLevel = 0;
PMB.VerifyInput = true;
PMB.VerifyOutput = true;
PMB.populateLTOPassManager(passes);
passes.run(*mergedModule);
return true;
}
bool LTOCodeGenerator::compileOptimized(raw_ostream &out, std::string &errMsg) {
if (!this->determineTarget(errMsg))
return false;
Module *mergedModule = IRLinker.getModule();
PassManager codeGenPasses;
formatted_raw_ostream Out(out);
codeGenPasses.add(createObjCARCContractPass());
if (TargetMach->addPassesToEmitFile(codeGenPasses, Out,
TargetMachine::CGFT_ObjectFile)) {
errMsg = "target file type not supported";
return false;
}
codeGenPasses.run(*mergedModule);
return true;
}
void LTOCodeGenerator::resetContext() {
assert(OwnedContext.get() != NULL && "Context must be owned by codegen");
destroyMergedModule();
std::unique_ptr<LLVMContext> newContext(new LLVMContext());
Context = newContext.get();
IRLinker = Linker(new Module("ld-temp.o", *Context));
std::swap(OwnedContext, newContext);
}
static ManagedStatic<llvm::StringSet<>> SpecialSymbolSet;
bool LTOCodeGenerator::hideSymbols() {
std::string Err;
determineTarget(Err);
assert(TargetMach && "unable to determine target");
assert(IRLinker.getModule() && OwnedModule && "not set up correctly");
StringMap<detail::DenseSetEmpty, BumpPtrAllocator &> Preserves(
IncrObfuscate.getAllocator());
StringMap<GlobalValue*, BumpPtrAllocator &> MangledValues(
IncrObfuscate.getAllocator());
Mangler Mangler(TargetMach->getDataLayout());
auto tryAddPreserve = [&](GlobalValue &GV) {
if (GV.hasPrivateLinkage())
return;
SmallString<64> Buffer;
TargetMach->getNameWithPrefix(Buffer, &GV, Mangler);
if (MustPreserveSymbols.count(Buffer))
Preserves.insert({GV.getName(), {}});
else
MangledValues.insert({IncrObfuscate.copyString(Buffer), &GV});
};
Module *MergedModule = IRLinker.getModule();
convertDebugInfoToLineTables(OwnedModule->getModule());
for (auto &I : *MergedModule)
tryAddPreserve(I);
for (auto &I : MergedModule->globals())
tryAddPreserve(I);
for (auto &I : MergedModule->aliases())
tryAddPreserve(I);
TargetLibraryInfoImpl TLII(Triple(TargetMach->getTargetTriple()));
TargetLibraryInfo TLI(TLII);
auto isLibName = [&TLI](StringRef S) {
LibFunc::Func F;
return TLI.getLibFunc(S, F);
};
static const char* const SpecialSymbols[] = {
#define COMPILER_SYMBOL(Name) #Name,
#include "llvm/Transforms/Utils/CompilerRTSymbols.def"
#undef COMPILER_SYMBOL
"objc_retain",
"objc_release",
"objc_autorelease",
"objc_retainAutoreleasedReturnValue",
"objc_retainBlock",
"objc_autoreleaseReturnValue",
"objc_autoreleasePoolPush",
"objc_loadWeakRetained",
"objc_loadWeak",
"objc_destroyWeak",
"objc_storeWeak",
"objc_initWeak",
"objc_moveWeak",
"objc_copyWeak",
"objc_retainedObject",
"objc_unretainedObject",
"objc_unretainedPointer"
};
static const unsigned NumSpecialSymbols = sizeof(SpecialSymbols) /
sizeof(const char *);
if (!SpecialSymbolSet.isConstructed()) {
for (unsigned i = 0; i < NumSpecialSymbols; ++i)
SpecialSymbolSet->insert(StringRef(SpecialSymbols[i]));
}
auto SymbolSet = &*SpecialSymbolSet;
auto isSpecialSymbolName = [SymbolSet](StringRef Name) {
if (Name.startswith("llvm.") || Name.startswith("__stack_chk") ||
Name.startswith("clang.arc"))
return true;
if (Name.startswith("__dtrace") ||
Name.startswith("\01section$start$") ||
Name.startswith("\01section$end$") ||
Name.startswith("\01segment$start$") ||
Name.startswith("\01segment$end$"))
return true;
if (SymbolSet->count(Name))
return true;
return false;
};
auto mustPreserve = [&Preserves, isLibName, isSpecialSymbolName](Value &V) {
auto Name = V.getName();
return Preserves.count(Name) || isLibName(Name) ||
isSpecialSymbolName(Name);
};
IncrObfuscate.obfuscateModule(OwnedModule->getModule(), mustPreserve);
if (!MangledNames) {
MangledNames.reset(new MangleNameMap(IncrObfuscate.getAllocator()));
}
for (auto &E : MangledValues) {
SmallString<64> Buffer;
TargetMach->getNameWithPrefix(Buffer, E.getValue(), Mangler);
MangledNames->insert({E.getKey(), IncrObfuscate.copyString(Buffer)});
}
return true;
}
const char* LTOCodeGenerator::lookupHiddenName(const char* SymbolName){
if (SymbolName == nullptr)
return nullptr;
if (MangledNames->count(SymbolName)) {
return MangledNames->lookup(SymbolName).data();
}
return nullptr;
}
bool LTOCodeGenerator::writeReverseMap(const char *Path) {
std::error_code EC;
tool_output_file Out(Path, EC, sys::fs::F_None);
if (EC) {
return false;
}
IncrObfuscate.writeReverseMap(Out.os());
Out.os().close();
if (Out.os().has_error()) {
Out.os().clear_error();
return false;
}
Out.keep();
return true;
}
void LTOCodeGenerator::setCodeGenDebugOptions(const char *options) {
for (std::pair<StringRef, StringRef> o = getToken(options);
!o.first.empty(); o = getToken(o.second)) {
if (CodegenOptions.empty())
CodegenOptions.push_back(strdup("libLLVMLTO"));
CodegenOptions.push_back(strdup(o.first.str().c_str()));
}
}
void LTOCodeGenerator::parseCodeGenDebugOptions() {
if (!CodegenOptions.empty())
cl::ParseCommandLineOptions(CodegenOptions.size(),
const_cast<char **>(&CodegenOptions[0]));
}
void LTOCodeGenerator::DiagnosticHandler(const DiagnosticInfo &DI,
void *Context) {
((LTOCodeGenerator *)Context)->DiagnosticHandler2(DI);
}
void LTOCodeGenerator::DiagnosticHandler2(const DiagnosticInfo &DI) {
lto_codegen_diagnostic_severity_t Severity;
switch (DI.getSeverity()) {
case DS_Error:
Severity = LTO_DS_ERROR;
break;
case DS_Warning:
Severity = LTO_DS_WARNING;
break;
case DS_Remark:
Severity = LTO_DS_REMARK;
break;
case DS_Note:
Severity = LTO_DS_NOTE;
break;
}
std::string MsgStorage;
raw_string_ostream Stream(MsgStorage);
DiagnosticPrinterRawOStream DP(Stream);
DI.print(DP);
Stream.flush();
assert(DiagHandler && "Invalid diagnostic handler");
(*DiagHandler)(Severity, MsgStorage.c_str(), DiagContext);
}
void
LTOCodeGenerator::setDiagnosticHandler(lto_diagnostic_handler_t DiagHandler,
void *Ctxt) {
this->DiagHandler = DiagHandler;
this->DiagContext = Ctxt;
if (!DiagHandler)
return Context->setDiagnosticHandler(nullptr, nullptr);
Context->setDiagnosticHandler(LTOCodeGenerator::DiagnosticHandler, this,
true);
}