360 lines
14 KiB
C++
360 lines
14 KiB
C++
//===--- CodeGenModule.h - Per-Module state for LLVM CodeGen ----*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This is the internal per-translation-unit state used for llvm translation.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef CLANG_CODEGEN_CODEGENMODULE_H
|
|
#define CLANG_CODEGEN_CODEGENMODULE_H
|
|
|
|
#include "clang/AST/Attr.h"
|
|
#include "CGBlocks.h"
|
|
#include "CGCall.h"
|
|
#include "CodeGenTypes.h"
|
|
#include "llvm/ADT/DenseMap.h"
|
|
#include "llvm/ADT/StringMap.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
#include "llvm/Support/ValueHandle.h"
|
|
#include <list>
|
|
|
|
namespace llvm {
|
|
class Module;
|
|
class Constant;
|
|
class Function;
|
|
class GlobalValue;
|
|
class TargetData;
|
|
class FunctionType;
|
|
}
|
|
|
|
namespace clang {
|
|
class ASTContext;
|
|
class FunctionDecl;
|
|
class IdentifierInfo;
|
|
class ObjCMethodDecl;
|
|
class ObjCImplementationDecl;
|
|
class ObjCCategoryImplDecl;
|
|
class ObjCProtocolDecl;
|
|
class ObjCEncodeExpr;
|
|
class BlockExpr;
|
|
class Decl;
|
|
class Expr;
|
|
class Stmt;
|
|
class StringLiteral;
|
|
class NamedDecl;
|
|
class ValueDecl;
|
|
class VarDecl;
|
|
class LangOptions;
|
|
class CompileOptions;
|
|
class Diagnostic;
|
|
class AnnotateAttr;
|
|
|
|
namespace CodeGen {
|
|
|
|
class CodeGenFunction;
|
|
class CGDebugInfo;
|
|
class CGObjCRuntime;
|
|
|
|
/// CodeGenModule - This class organizes the cross-function state that is used
|
|
/// while generating LLVM code.
|
|
class CodeGenModule : public BlockModule {
|
|
CodeGenModule(const CodeGenModule&); // DO NOT IMPLEMENT
|
|
void operator=(const CodeGenModule&); // DO NOT IMPLEMENT
|
|
|
|
typedef std::vector< std::pair<llvm::Constant*, int> > CtorList;
|
|
|
|
ASTContext &Context;
|
|
const LangOptions &Features;
|
|
const CompileOptions &CompileOpts;
|
|
llvm::Module &TheModule;
|
|
const llvm::TargetData &TheTargetData;
|
|
Diagnostic &Diags;
|
|
CodeGenTypes Types;
|
|
CGObjCRuntime* Runtime;
|
|
CGDebugInfo* DebugInfo;
|
|
|
|
llvm::Function *MemCpyFn;
|
|
llvm::Function *MemMoveFn;
|
|
llvm::Function *MemSetFn;
|
|
|
|
/// GlobalDeclMap - Mapping of decl names (represented as unique
|
|
/// character pointers from either the identifier table or the set
|
|
/// of mangled names) to global variables we have already
|
|
/// emitted. Note that the entries in this map are the actual
|
|
/// globals and therefore may not be of the same type as the decl,
|
|
/// they should be bitcasted on retrieval. Also note that the
|
|
/// globals are keyed on their source mangled name, not the global name
|
|
/// (which may change with attributes such as asm-labels). The key
|
|
/// to this map should be generated using getMangledName().
|
|
///
|
|
/// Note that this map always lines up exactly with the contents of the LLVM
|
|
/// IR symbol table, but this is quicker to query since it is doing uniqued
|
|
/// pointer lookups instead of full string lookups.
|
|
llvm::DenseMap<const char*, llvm::GlobalValue*> GlobalDeclMap;
|
|
|
|
/// \brief Contains the strings used for mangled names.
|
|
///
|
|
/// FIXME: Eventually, this should map from the semantic/canonical
|
|
/// declaration for each global entity to its mangled name (if it
|
|
/// has one).
|
|
llvm::StringSet<> MangledNames;
|
|
|
|
/// DeferredDecls - This contains all the decls which have definitions but
|
|
/// which are deferred for emission and therefore should only be output if
|
|
/// they are actually used. If a decl is in this, then it is known to have
|
|
/// not been referenced yet. The key to this map is a uniqued mangled name.
|
|
llvm::DenseMap<const char*, const ValueDecl*> DeferredDecls;
|
|
|
|
/// DeferredDeclsToEmit - This is a list of deferred decls which we have seen
|
|
/// that *are* actually referenced. These get code generated when the module
|
|
/// is done.
|
|
std::vector<const ValueDecl*> DeferredDeclsToEmit;
|
|
|
|
/// LLVMUsed - List of global values which are required to be
|
|
/// present in the object file; bitcast to i8*. This is used for
|
|
/// forcing visibility of symbols which may otherwise be optimized
|
|
/// out.
|
|
std::vector<llvm::WeakVH> LLVMUsed;
|
|
|
|
/// GlobalCtors - Store the list of global constructors and their respective
|
|
/// priorities to be emitted when the translation unit is complete.
|
|
CtorList GlobalCtors;
|
|
|
|
/// GlobalDtors - Store the list of global destructors and their respective
|
|
/// priorities to be emitted when the translation unit is complete.
|
|
CtorList GlobalDtors;
|
|
|
|
std::vector<llvm::Constant*> Annotations;
|
|
|
|
llvm::StringMap<llvm::Constant*> CFConstantStringMap;
|
|
llvm::StringMap<llvm::Constant*> ConstantStringMap;
|
|
|
|
/// CFConstantStringClassRef - Cached reference to the class for constant
|
|
/// strings. This value has type int * but is actually an Obj-C class pointer.
|
|
llvm::Constant *CFConstantStringClassRef;
|
|
public:
|
|
CodeGenModule(ASTContext &C, const CompileOptions &CompileOpts,
|
|
llvm::Module &M, const llvm::TargetData &TD, Diagnostic &Diags);
|
|
|
|
~CodeGenModule();
|
|
|
|
/// Release - Finalize LLVM code generation.
|
|
void Release();
|
|
|
|
/// getObjCRuntime() - Return a reference to the configured
|
|
/// Objective-C runtime.
|
|
CGObjCRuntime &getObjCRuntime() {
|
|
assert(Runtime && "No Objective-C runtime has been configured.");
|
|
return *Runtime;
|
|
}
|
|
|
|
/// hasObjCRuntime() - Return true iff an Objective-C runtime has
|
|
/// been configured.
|
|
bool hasObjCRuntime() { return !!Runtime; }
|
|
|
|
CGDebugInfo *getDebugInfo() { return DebugInfo; }
|
|
ASTContext &getContext() const { return Context; }
|
|
const CompileOptions &getCompileOpts() const { return CompileOpts; }
|
|
const LangOptions &getLangOptions() const { return Features; }
|
|
llvm::Module &getModule() const { return TheModule; }
|
|
CodeGenTypes &getTypes() { return Types; }
|
|
Diagnostic &getDiags() const { return Diags; }
|
|
const llvm::TargetData &getTargetData() const { return TheTargetData; }
|
|
|
|
/// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the
|
|
/// given global variable. If Ty is non-null and if the global doesn't exist,
|
|
/// then it will be greated with the specified type instead of whatever the
|
|
/// normal requested type would be.
|
|
llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
|
|
const llvm::Type *Ty = 0);
|
|
|
|
/// GetAddrOfFunction - Return the address of the given function. If Ty is
|
|
/// non-null, then this function will use the specified type if it has to
|
|
/// create it.
|
|
llvm::Constant *GetAddrOfFunction(const FunctionDecl *D,
|
|
const llvm::Type *Ty = 0);
|
|
|
|
/// GetStringForStringLiteral - Return the appropriate bytes for a string
|
|
/// literal, properly padded to match the literal type. If only the address of
|
|
/// a constant is needed consider using GetAddrOfConstantStringLiteral.
|
|
std::string GetStringForStringLiteral(const StringLiteral *E);
|
|
|
|
/// GetAddrOfConstantCFString - Return a pointer to a constant CFString object
|
|
/// for the given string.
|
|
llvm::Constant *GetAddrOfConstantCFString(const StringLiteral *Literal);
|
|
|
|
/// GetAddrOfConstantStringFromLiteral - Return a pointer to a constant array
|
|
/// for the given string literal.
|
|
llvm::Constant *GetAddrOfConstantStringFromLiteral(const StringLiteral *S);
|
|
|
|
/// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
|
|
/// array for the given ObjCEncodeExpr node.
|
|
llvm::Constant *GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
|
|
|
|
/// GetAddrOfConstantString - Returns a pointer to a character array
|
|
/// containing the literal. This contents are exactly that of the given
|
|
/// string, i.e. it will not be null terminated automatically; see
|
|
/// GetAddrOfConstantCString. Note that whether the result is actually a
|
|
/// pointer to an LLVM constant depends on Feature.WriteableStrings.
|
|
///
|
|
/// The result has pointer to array type.
|
|
///
|
|
/// \param GlobalName If provided, the name to use for the global
|
|
/// (if one is created).
|
|
llvm::Constant *GetAddrOfConstantString(const std::string& str,
|
|
const char *GlobalName=0);
|
|
|
|
/// GetAddrOfConstantCString - Returns a pointer to a character array
|
|
/// containing the literal and a terminating '\0' character. The result has
|
|
/// pointer to array type.
|
|
///
|
|
/// \param GlobalName If provided, the name to use for the global (if one is
|
|
/// created).
|
|
llvm::Constant *GetAddrOfConstantCString(const std::string &str,
|
|
const char *GlobalName=0);
|
|
|
|
/// getBuiltinLibFunction - Given a builtin id for a function like
|
|
/// "__builtin_fabsf", return a Function* for "fabsf".
|
|
llvm::Value *getBuiltinLibFunction(unsigned BuiltinID);
|
|
|
|
llvm::Function *getMemCpyFn();
|
|
llvm::Function *getMemMoveFn();
|
|
llvm::Function *getMemSetFn();
|
|
llvm::Function *getIntrinsic(unsigned IID, const llvm::Type **Tys = 0,
|
|
unsigned NumTys = 0);
|
|
|
|
/// EmitTopLevelDecl - Emit code for a single top level declaration.
|
|
void EmitTopLevelDecl(Decl *D);
|
|
|
|
/// AddUsedGlobal - Add a global which should be forced to be
|
|
/// present in the object file; these are emitted to the llvm.used
|
|
/// metadata global.
|
|
void AddUsedGlobal(llvm::GlobalValue *GV);
|
|
|
|
void AddAnnotation(llvm::Constant *C) { Annotations.push_back(C); }
|
|
|
|
/// CreateRuntimeFunction - Create a new runtime function with the specified
|
|
/// type and name.
|
|
llvm::Constant *CreateRuntimeFunction(const llvm::FunctionType *Ty,
|
|
const char *Name);
|
|
/// CreateRuntimeVariable - Create a new runtime global variable with the
|
|
/// specified type and name.
|
|
llvm::Constant *CreateRuntimeVariable(const llvm::Type *Ty,
|
|
const char *Name);
|
|
|
|
void UpdateCompletedType(const TagDecl *TD) {
|
|
// Make sure that this type is translated.
|
|
Types.UpdateCompletedType(TD);
|
|
}
|
|
|
|
/// EmitConstantExpr - Try to emit the given expression as a
|
|
/// constant; returns 0 if the expression cannot be emitted as a
|
|
/// constant.
|
|
llvm::Constant *EmitConstantExpr(const Expr *E, CodeGenFunction *CGF = 0);
|
|
|
|
llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
|
|
const AnnotateAttr *AA, unsigned LineNo);
|
|
|
|
/// ErrorUnsupported - Print out an error that codegen doesn't support the
|
|
/// specified stmt yet.
|
|
/// \param OmitOnError - If true, then this error should only be emitted if no
|
|
/// other errors have been reported.
|
|
void ErrorUnsupported(const Stmt *S, const char *Type,
|
|
bool OmitOnError=false);
|
|
|
|
/// ErrorUnsupported - Print out an error that codegen doesn't support the
|
|
/// specified decl yet.
|
|
/// \param OmitOnError - If true, then this error should only be emitted if no
|
|
/// other errors have been reported.
|
|
void ErrorUnsupported(const Decl *D, const char *Type,
|
|
bool OmitOnError=false);
|
|
|
|
void SetMethodAttributes(const ObjCMethodDecl *MD,
|
|
llvm::Function *F);
|
|
|
|
void SetFunctionAttributes(const Decl *D,
|
|
const CGFunctionInfo &Info,
|
|
llvm::Function *F);
|
|
|
|
/// ReturnTypeUsesSret - Return true iff the given type uses 'sret' when used
|
|
/// as a return type.
|
|
bool ReturnTypeUsesSret(const CGFunctionInfo &FI);
|
|
|
|
void ConstructAttributeList(const CGFunctionInfo &Info,
|
|
const Decl *TargetDecl,
|
|
AttributeListType &PAL);
|
|
|
|
const char *getMangledName(const NamedDecl *ND);
|
|
|
|
|
|
private:
|
|
llvm::Constant *GetOrCreateLLVMFunction(const char *MangledName,
|
|
const llvm::Type *Ty,
|
|
const FunctionDecl *D);
|
|
llvm::Constant *GetOrCreateLLVMGlobal(const char *MangledName,
|
|
const llvm::PointerType *PTy,
|
|
const VarDecl *D);
|
|
|
|
/// SetGlobalValueAttributes - Set attributes for a global decl.
|
|
void SetGlobalValueAttributes(const Decl *D,
|
|
bool IsInternal,
|
|
bool IsInline,
|
|
llvm::GlobalValue *GV,
|
|
bool ForDefinition);
|
|
|
|
/// SetFunctionAttributesForDefinition - Set function attributes specific to a
|
|
/// function definition.
|
|
/// \param D - The ObjCMethodDecl or FunctionDecl defining \arg F.
|
|
void SetFunctionAttributesForDefinition(const Decl *D,
|
|
llvm::Function *F);
|
|
|
|
void SetFunctionAttributes(const FunctionDecl *FD,
|
|
llvm::Function *F);
|
|
|
|
/// EmitGlobal - Emit code for a singal global function or var decl. Forward
|
|
/// declarations are emitted lazily.
|
|
void EmitGlobal(const ValueDecl *D);
|
|
|
|
void EmitGlobalDefinition(const ValueDecl *D);
|
|
|
|
void EmitGlobalFunctionDefinition(const FunctionDecl *D);
|
|
void EmitGlobalVarDefinition(const VarDecl *D);
|
|
void EmitAliasDefinition(const ValueDecl *D);
|
|
void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
|
|
void EmitNamespace(const NamespaceDecl *D);
|
|
|
|
// FIXME: Hardcoding priority here is gross.
|
|
void AddGlobalCtor(llvm::Function * Ctor, int Priority=65535);
|
|
void AddGlobalDtor(llvm::Function * Dtor, int Priority=65535);
|
|
|
|
/// EmitCtorList - Generates a global array of functions and priorities using
|
|
/// the given list and name. This array will have appending linkage and is
|
|
/// suitable for use as a LLVM constructor or destructor array.
|
|
void EmitCtorList(const CtorList &Fns, const char *GlobalName);
|
|
|
|
void EmitAnnotations(void);
|
|
|
|
/// EmitDeferred - Emit any needed decls for which code generation
|
|
/// was deferred.
|
|
void EmitDeferred(void);
|
|
|
|
/// EmitLLVMUsed - Emit the llvm.used metadata used to force
|
|
/// references to global which may otherwise be optimized out.
|
|
void EmitLLVMUsed(void);
|
|
|
|
/// MayDeferGeneration - Determine if the given decl can be emitted
|
|
/// lazily; this is only relevant for definitions. The given decl
|
|
/// must be either a function or var decl.
|
|
bool MayDeferGeneration(const ValueDecl *D);
|
|
};
|
|
} // end namespace CodeGen
|
|
} // end namespace clang
|
|
|
|
#endif
|