ldc/gen/moduleinfo.cpp
2024-03-03 19:14:00 +01:00

341 lines
9.6 KiB
C++
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

//===-- moduleinfo.cpp ----------------------------------------------------===//
//
// LDC the LLVM D compiler
//
// This file is distributed under the BSD-style LDC license. See the LICENSE
// file for details.
//
//===----------------------------------------------------------------------===//
#include "gen/moduleinfo.h"
#include "dmd/errors.h"
#include "dmd/mangle.h"
#include "dmd/module.h"
#include "gen/abi/abi.h"
#include "gen/classes.h"
#include "gen/irstate.h"
#include "gen/llvmhelpers.h"
#include "gen/logger.h"
#include "gen/mangling.h"
#include "gen/rttibuilder.h"
#include "gen/runtime.h"
#include "ir/irfunction.h"
#include "ir/irmodule.h"
#include "ir/irtype.h"
// These must match the values in druntime/src/object_.d
#define MIstandalone 0x4
#define MItlsctor 0x8
#define MItlsdtor 0x10
#define MIctor 0x20
#define MIdtor 0x40
#define MIxgetMembers 0x80
#define MIictor 0x100
#define MIunitTest 0x200
#define MIimportedModules 0x400
#define MIlocalClasses 0x800
#define MInew 0x80000000 // it's the "new" layout
using namespace dmd;
namespace {
/// Creates a function in the current llvm::Module that dispatches to the given
/// functions one after each other and then increments the gate variables, if
/// any.
llvm::Function *buildForwarderFunction(
const std::string &name, const std::vector<llvm::Function *> &funcs,
const std::list<VarDeclaration *> &gates = {}) {
// If there is no gates, we might get away without creating a function at all.
if (gates.empty()) {
if (funcs.empty()) {
return nullptr;
}
if (funcs.size() == 1) {
return funcs.front();
}
}
// Create an internal-linkage void() function.
const auto fnTy =
LLFunctionType::get(LLType::getVoidTy(gIR->context()), {}, false);
const auto irMangle = getIRMangledFuncName(name, LINK::d);
assert(gIR->module.getFunction(irMangle) == NULL);
llvm::Function *fn = llvm::Function::Create(
fnTy, llvm::GlobalValue::InternalLinkage, irMangle, &gIR->module);
fn->setCallingConv(gABI->callingConv(LINK::d));
// Emit the body, consisting of...
const auto bb = llvm::BasicBlock::Create(gIR->context(), "", fn);
IRBuilder<> builder(bb);
ldc::DISubprogram dis = gIR->DBuilder.EmitModuleCTor(fn, name.c_str());
if (global.params.symdebug) {
// Need _some_ debug info to avoid inliner bug, see GitHub issue #998.
builder.SetCurrentDebugLocation(
llvm::DILocation::get(gIR->context(), 0, 0, dis));
}
// ... calling the given functions, and...
for (auto f : funcs) {
const auto call = builder.CreateCall(f, {});
call->setCallingConv(f->getCallingConv());
}
// ... incrementing the gate variables.
for (auto gate : gates) {
const auto glob = getIrGlobal(gate);
assert(glob);
const auto val = glob->value;
const auto rval = builder.CreateLoad(glob->getType(), val, "vgate");
const auto res = builder.CreateAdd(rval, DtoConstUint(1), "vgate");
builder.CreateStore(res, val);
}
builder.CreateRetVoid();
return fn;
}
std::vector<llvm::Function *> toLLVMFuncs(const std::list<FuncDeclaration *> &funcs) {
std::vector<llvm::Function *> ret;
for (auto func : funcs)
ret.push_back(DtoCallee(func));
return ret;
}
llvm::Function *buildForwarderFunction(
const std::string &name, const std::list<FuncDeclaration *> &funcs,
const std::list<VarDeclaration *> &gates = {}) {
return buildForwarderFunction(name, toLLVMFuncs(funcs), gates);
}
std::string getMangledName(Module *m, const char *suffix) {
OutBuffer buf;
buf.writestring("_D");
mangleToBuffer(m, buf);
if (suffix)
buf.writestring(suffix);
return buf.peekChars();
}
llvm::Function *buildModuleCtor(Module *m) {
std::string name = getMangledName(m, "6__ctorZ");
IrModule *irm = getIrModule(m);
return buildForwarderFunction(name, irm->ctors, irm->gates);
}
llvm::Function *buildModuleDtor(Module *m) {
std::string name = getMangledName(m, "6__dtorZ");
return buildForwarderFunction(name, getIrModule(m)->dtors);
}
llvm::Function *buildModuleUnittest(Module *m) {
std::string name = getMangledName(m, "10__unittestZ");
return buildForwarderFunction(name, getIrModule(m)->unitTests);
}
llvm::Function *buildModuleSharedCtor(Module *m) {
std::string name = getMangledName(m, "13__shared_ctorZ");
IrModule *irm = getIrModule(m);
return buildForwarderFunction(name, irm->sharedCtors, irm->sharedGates);
}
llvm::Function *buildModuleSharedDtor(Module *m) {
std::string name = getMangledName(m, "13__shared_dtorZ");
return buildForwarderFunction(name, getIrModule(m)->sharedDtors);
}
llvm::Function *buildOrderIndependentModuleCtor(Module *m) {
std::string name = getMangledName(m, "7__ictorZ");
IrModule &irm = *getIrModule(m);
auto funcs = toLLVMFuncs(irm.standaloneSharedCtors);
if (irm.coverageCtor)
funcs.insert(funcs.begin(), irm.coverageCtor); // initialize coverage first
return buildForwarderFunction(name, funcs);
}
/// Builds the (constant) data content for the importedModules[] array.
llvm::Constant *buildImportedModules(Module *m, size_t &count) {
const auto moduleInfoPtrTy = DtoPtrToType(getModuleInfoType());
std::vector<LLConstant *> importInits;
for (auto mod : m->aimports) {
if (!mod->needModuleInfo() || mod == m) {
continue;
}
importInits.push_back(
DtoBitCast(getIrModule(mod)->moduleInfoSymbol(), moduleInfoPtrTy));
}
count = importInits.size();
if (importInits.empty())
return nullptr;
const auto type = llvm::ArrayType::get(moduleInfoPtrTy, importInits.size());
return LLConstantArray::get(type, importInits);
}
/// Builds the (constant) data content for the localClasses[] array.
llvm::Constant *buildLocalClasses(Module *m, size_t &count) {
const auto classinfoTy = DtoType(getClassInfoType());
ClassDeclarations aclasses;
getLocalClasses(m, aclasses);
std::vector<LLConstant *> classInfoRefs;
for (auto cd : aclasses) {
DtoResolveClass(cd);
if (cd->isInterfaceDeclaration()) {
IF_LOG Logger::println("skipping interface '%s' in moduleinfo",
cd->toPrettyChars());
continue;
}
if (cd->sizeok != Sizeok::done) {
IF_LOG Logger::println(
"skipping opaque class declaration '%s' in moduleinfo",
cd->toPrettyChars());
continue;
}
IF_LOG Logger::println("class: %s", cd->toPrettyChars());
classInfoRefs.push_back(
DtoBitCast(getIrAggr(cd)->getClassInfoSymbol(), classinfoTy));
}
count = classInfoRefs.size();
if (classInfoRefs.empty())
return nullptr;
const auto type = llvm::ArrayType::get(classinfoTy, classInfoRefs.size());
return LLConstantArray::get(type, classInfoRefs);
}
}
llvm::GlobalVariable *genModuleInfo(Module *m) {
// check declaration in object.d
const auto moduleInfoType = getModuleInfoType();
const auto moduleInfoDecl = Module::moduleinfo;
// The "new-style" ModuleInfo records are variable-length, with the presence
// of the various fields indicated by a certain flag bit. The base struct
// should consist only of the _flags/_index fields (the latter of which is
// unused).
if (moduleInfoDecl->structsize != 4 + 4) {
error(m->loc, "Unexpected size of struct `object.ModuleInfo`; "
"druntime version does not match compiler (see -v)");
fatal();
}
// First, figure out which fields are present and set the flags accordingly.
unsigned flags = MInew;
const auto fctor = buildModuleCtor(m);
if (fctor) {
flags |= MItlsctor;
}
const auto fdtor = buildModuleDtor(m);
if (fdtor) {
flags |= MItlsdtor;
}
const auto fsharedctor = buildModuleSharedCtor(m);
if (fsharedctor) {
flags |= MIctor;
}
const auto fshareddtor = buildModuleSharedDtor(m);
if (fshareddtor) {
flags |= MIdtor;
}
#if 0
if (fgetmembers)
flags |= MIxgetMembers;
#endif
const auto fictor = buildOrderIndependentModuleCtor(m);
if (fictor)
flags |= MIictor;
const auto funittest = buildModuleUnittest(m);
if (funittest) {
flags |= MIunitTest;
}
size_t importedModulesCount;
const auto importedModules = buildImportedModules(m, importedModulesCount);
if (importedModules) {
flags |= MIimportedModules;
}
size_t localClassesCount;
const auto localClasses = buildLocalClasses(m, localClassesCount);
if (localClasses) {
flags |= MIlocalClasses;
}
if (!m->needmoduleinfo) {
flags |= MIstandalone;
}
// Now, start building the initialiser for the ModuleInfo instance.
RTTIBuilder b(moduleInfoType);
b.push_uint(flags);
b.push_uint(0); // index
if (fctor) {
b.push(fctor);
}
if (fdtor) {
b.push(fdtor);
}
if (fsharedctor) {
b.push(fsharedctor);
}
if (fshareddtor) {
b.push(fshareddtor);
}
#if 0
if (fgetmembers)
b.push(fgetmembers);
#endif
if (fictor) {
b.push(fictor);
}
if (funittest) {
b.push(funittest);
}
if (importedModules) {
b.push_size(importedModulesCount);
b.push(importedModules);
}
if (localClasses) {
b.push_size(localClassesCount);
b.push(localClasses);
}
// Put out module name as a 0-terminated string.
const char *name = m->toPrettyChars();
const size_t len = strlen(name) + 1;
const auto it = llvm::IntegerType::getInt8Ty(gIR->context());
const auto at = llvm::ArrayType::get(it, len);
b.push(toConstantArray(it, at, name, len, false));
// Create a global symbol with the above initialiser.
LLGlobalVariable *moduleInfoSym = getIrModule(m)->moduleInfoSymbol();
b.finalize(moduleInfoSym);
setLinkage({LLGlobalValue::ExternalLinkage, needsCOMDAT()}, moduleInfoSym);
if (global.params.dllexport) {
moduleInfoSym->setDLLStorageClass(LLGlobalValue::DLLExportStorageClass);
}
return moduleInfoSym;
}