1 //===--- CodeGenModule.h - Per-Module state for LLVM CodeGen ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the internal per-translation-unit state used for llvm translation.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
15 #define LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
17 #include "CGVTables.h"
18 #include "CodeGenTypeCache.h"
19 #include "CodeGenTypes.h"
20 #include "SanitizerMetadata.h"
21 #include "clang/AST/Attr.h"
22 #include "clang/AST/DeclCXX.h"
23 #include "clang/AST/DeclObjC.h"
24 #include "clang/AST/GlobalDecl.h"
25 #include "clang/AST/Mangle.h"
26 #include "clang/Basic/ABI.h"
27 #include "clang/Basic/LangOptions.h"
28 #include "clang/Basic/Module.h"
29 #include "clang/Basic/SanitizerBlacklist.h"
30 #include "llvm/ADT/DenseMap.h"
31 #include "llvm/ADT/SetVector.h"
32 #include "llvm/ADT/SmallPtrSet.h"
33 #include "llvm/ADT/StringMap.h"
34 #include "llvm/IR/Module.h"
35 #include "llvm/IR/ValueHandle.h"
46 class IndexedInstrProfReader;
50 class TargetCodeGenInfo;
56 class ObjCImplementationDecl;
57 class ObjCCategoryImplDecl;
58 class ObjCProtocolDecl;
72 class HeaderSearchOptions;
73 class PreprocessorOptions;
74 class DiagnosticsEngine;
76 class CXXDestructorDecl;
78 class CoverageSourceInfo;
83 class CodeGenFunction;
88 class CGOpenCLRuntime;
89 class CGOpenMPRuntime;
91 class BlockFieldFlags;
92 class FunctionArgList;
93 class CoverageMappingModuleGen;
95 struct OrderGlobalInits {
96 unsigned int priority;
97 unsigned int lex_order;
98 OrderGlobalInits(unsigned int p, unsigned int l)
99 : priority(p), lex_order(l) {}
101 bool operator==(const OrderGlobalInits &RHS) const {
102 return priority == RHS.priority && lex_order == RHS.lex_order;
105 bool operator<(const OrderGlobalInits &RHS) const {
106 return std::tie(priority, lex_order) <
107 std::tie(RHS.priority, RHS.lex_order);
111 struct RREntrypoints {
112 RREntrypoints() { memset(this, 0, sizeof(*this)); }
113 /// void objc_autoreleasePoolPop(void*);
114 llvm::Constant *objc_autoreleasePoolPop;
116 /// void *objc_autoreleasePoolPush(void);
117 llvm::Constant *objc_autoreleasePoolPush;
120 struct ARCEntrypoints {
121 ARCEntrypoints() { memset(this, 0, sizeof(*this)); }
123 /// id objc_autorelease(id);
124 llvm::Constant *objc_autorelease;
126 /// id objc_autoreleaseReturnValue(id);
127 llvm::Constant *objc_autoreleaseReturnValue;
129 /// void objc_copyWeak(id *dest, id *src);
130 llvm::Constant *objc_copyWeak;
132 /// void objc_destroyWeak(id*);
133 llvm::Constant *objc_destroyWeak;
135 /// id objc_initWeak(id*, id);
136 llvm::Constant *objc_initWeak;
138 /// id objc_loadWeak(id*);
139 llvm::Constant *objc_loadWeak;
141 /// id objc_loadWeakRetained(id*);
142 llvm::Constant *objc_loadWeakRetained;
144 /// void objc_moveWeak(id *dest, id *src);
145 llvm::Constant *objc_moveWeak;
147 /// id objc_retain(id);
148 llvm::Constant *objc_retain;
150 /// id objc_retainAutorelease(id);
151 llvm::Constant *objc_retainAutorelease;
153 /// id objc_retainAutoreleaseReturnValue(id);
154 llvm::Constant *objc_retainAutoreleaseReturnValue;
156 /// id objc_retainAutoreleasedReturnValue(id);
157 llvm::Constant *objc_retainAutoreleasedReturnValue;
159 /// id objc_retainBlock(id);
160 llvm::Constant *objc_retainBlock;
162 /// void objc_release(id);
163 llvm::Constant *objc_release;
165 /// id objc_storeStrong(id*, id);
166 llvm::Constant *objc_storeStrong;
168 /// id objc_storeWeak(id*, id);
169 llvm::Constant *objc_storeWeak;
171 /// A void(void) inline asm to use to mark that the return value of
172 /// a call will be immediately retain.
173 llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
175 /// void clang.arc.use(...);
176 llvm::Constant *clang_arc_use;
179 /// This class records statistics on instrumentation based profiling.
180 class InstrProfStats {
181 uint32_t VisitedInMainFile;
182 uint32_t MissingInMainFile;
189 : VisitedInMainFile(0), MissingInMainFile(0), Visited(0), Missing(0),
191 /// Record that we've visited a function and whether or not that function was
192 /// in the main source file.
193 void addVisited(bool MainFile) {
198 /// Record that a function we've visited has no profile data.
199 void addMissing(bool MainFile) {
204 /// Record that a function we've visited has mismatched profile data.
205 void addMismatched(bool MainFile) { ++Mismatched; }
206 /// Whether or not the stats we've gathered indicate any potential problems.
207 bool hasDiagnostics() { return Missing || Mismatched; }
208 /// Report potential problems we've found to \c Diags.
209 void reportDiagnostics(DiagnosticsEngine &Diags, StringRef MainFile);
212 /// A pair of helper functions for a __block variable.
213 class BlockByrefHelpers : public llvm::FoldingSetNode {
214 // MSVC requires this type to be complete in order to process this
217 llvm::Constant *CopyHelper;
218 llvm::Constant *DisposeHelper;
220 /// The alignment of the field. This is important because
221 /// different offsets to the field within the byref struct need to
222 /// have different helper functions.
225 BlockByrefHelpers(CharUnits alignment) : Alignment(alignment) {}
226 BlockByrefHelpers(const BlockByrefHelpers &) = default;
227 virtual ~BlockByrefHelpers();
229 void Profile(llvm::FoldingSetNodeID &id) const {
230 id.AddInteger(Alignment.getQuantity());
233 virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
235 virtual bool needsCopy() const { return true; }
236 virtual void emitCopy(CodeGenFunction &CGF, Address dest, Address src) = 0;
238 virtual bool needsDispose() const { return true; }
239 virtual void emitDispose(CodeGenFunction &CGF, Address field) = 0;
242 /// This class organizes the cross-function state that is used while generating
244 class CodeGenModule : public CodeGenTypeCache {
245 CodeGenModule(const CodeGenModule &) = delete;
246 void operator=(const CodeGenModule &) = delete;
250 Structor() : Priority(0), Initializer(nullptr), AssociatedData(nullptr) {}
251 Structor(int Priority, llvm::Constant *Initializer,
252 llvm::Constant *AssociatedData)
253 : Priority(Priority), Initializer(Initializer),
254 AssociatedData(AssociatedData) {}
256 llvm::Constant *Initializer;
257 llvm::Constant *AssociatedData;
260 typedef std::vector<Structor> CtorList;
264 const LangOptions &LangOpts;
265 const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info.
266 const PreprocessorOptions &PreprocessorOpts; // Only used for debug info.
267 const CodeGenOptions &CodeGenOpts;
268 llvm::Module &TheModule;
269 DiagnosticsEngine &Diags;
270 const TargetInfo &Target;
271 std::unique_ptr<CGCXXABI> ABI;
272 llvm::LLVMContext &VMContext;
276 mutable const TargetCodeGenInfo *TheTargetCodeGenInfo;
278 // This should not be moved earlier, since its initialization depends on some
279 // of the previous reference members being already initialized and also checks
280 // if TheTargetCodeGenInfo is NULL
283 /// Holds information about C++ vtables.
284 CodeGenVTables VTables;
286 CGObjCRuntime* ObjCRuntime;
287 CGOpenCLRuntime* OpenCLRuntime;
288 CGOpenMPRuntime* OpenMPRuntime;
289 CGCUDARuntime* CUDARuntime;
290 CGDebugInfo* DebugInfo;
291 ARCEntrypoints *ARCData;
292 llvm::MDNode *NoObjCARCExceptionsMetadata;
293 RREntrypoints *RRData;
294 std::unique_ptr<llvm::IndexedInstrProfReader> PGOReader;
295 InstrProfStats PGOStats;
297 // A set of references that have only been seen via a weakref so far. This is
298 // used to remove the weak of the reference if we ever see a direct reference
300 llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
302 /// This contains all the decls which have definitions but/ which are deferred
303 /// for emission and therefore should only be output if they are actually
304 /// used. If a decl is in this, then it is known to have not been referenced
306 std::map<StringRef, GlobalDecl> DeferredDecls;
308 /// This is a list of deferred decls which we have seen that *are* actually
309 /// referenced. These get code generated when the module is done.
310 struct DeferredGlobal {
311 DeferredGlobal(llvm::GlobalValue *GV, GlobalDecl GD) : GV(GV), GD(GD) {}
312 llvm::TrackingVH<llvm::GlobalValue> GV;
315 std::vector<DeferredGlobal> DeferredDeclsToEmit;
316 void addDeferredDeclToEmit(llvm::GlobalValue *GV, GlobalDecl GD) {
317 DeferredDeclsToEmit.emplace_back(GV, GD);
320 /// List of alias we have emitted. Used to make sure that what they point to
321 /// is defined once we get to the end of the of the translation unit.
322 std::vector<GlobalDecl> Aliases;
324 typedef llvm::StringMap<llvm::TrackingVH<llvm::Constant> > ReplacementsTy;
325 ReplacementsTy Replacements;
327 /// List of global values to be replaced with something else. Used when we
328 /// want to replace a GlobalValue but can't identify it by its mangled name
329 /// anymore (because the name is already taken).
330 llvm::SmallVector<std::pair<llvm::GlobalValue *, llvm::Constant *>, 8>
331 GlobalValReplacements;
333 /// Set of global decls for which we already diagnosed mangled name conflict.
334 /// Required to not issue a warning (on a mangling conflict) multiple times
335 /// for the same decl.
336 llvm::DenseSet<GlobalDecl> DiagnosedConflictingDefinitions;
338 /// A queue of (optional) vtables to consider emitting.
339 std::vector<const CXXRecordDecl*> DeferredVTables;
341 /// List of global values which are required to be present in the object file;
342 /// bitcast to i8*. This is used for forcing visibility of symbols which may
343 /// otherwise be optimized out.
344 std::vector<llvm::WeakVH> LLVMUsed;
345 std::vector<llvm::WeakVH> LLVMCompilerUsed;
347 /// Store the list of global constructors and their respective priorities to
348 /// be emitted when the translation unit is complete.
349 CtorList GlobalCtors;
351 /// Store the list of global destructors and their respective priorities to be
352 /// emitted when the translation unit is complete.
353 CtorList GlobalDtors;
355 /// An ordered map of canonical GlobalDecls to their mangled names.
356 llvm::MapVector<GlobalDecl, StringRef> MangledDeclNames;
357 llvm::StringMap<GlobalDecl, llvm::BumpPtrAllocator> Manglings;
359 /// Global annotations.
360 std::vector<llvm::Constant*> Annotations;
362 /// Map used to get unique annotation strings.
363 llvm::StringMap<llvm::Constant*> AnnotationStrings;
365 llvm::StringMap<llvm::GlobalVariable *> CFConstantStringMap;
367 llvm::DenseMap<llvm::Constant *, llvm::GlobalVariable *> ConstantStringMap;
368 llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
369 llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
370 llvm::DenseMap<const Expr*, llvm::Constant *> MaterializedGlobalTemporaryMap;
372 llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
373 llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
375 /// Map used to get unique type descriptor constants for sanitizers.
376 llvm::DenseMap<QualType, llvm::Constant *> TypeDescriptorMap;
378 /// Map used to track internal linkage functions declared within
379 /// extern "C" regions.
380 typedef llvm::MapVector<IdentifierInfo *,
381 llvm::GlobalValue *> StaticExternCMap;
382 StaticExternCMap StaticExternCValues;
384 /// \brief thread_local variables defined or used in this TU.
385 std::vector<std::pair<const VarDecl *, llvm::GlobalVariable *> >
388 /// \brief thread_local variables with initializers that need to run
389 /// before any thread_local variable in this TU is odr-used.
390 std::vector<llvm::Function *> CXXThreadLocalInits;
391 std::vector<llvm::GlobalVariable *> CXXThreadLocalInitVars;
393 /// Global variables with initializers that need to run before main.
394 std::vector<llvm::Function *> CXXGlobalInits;
396 /// When a C++ decl with an initializer is deferred, null is
397 /// appended to CXXGlobalInits, and the index of that null is placed
398 /// here so that the initializer will be performed in the correct
399 /// order. Once the decl is emitted, the index is replaced with ~0U to ensure
400 /// that we don't re-emit the initializer.
401 llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
403 typedef std::pair<OrderGlobalInits, llvm::Function*> GlobalInitData;
405 struct GlobalInitPriorityCmp {
406 bool operator()(const GlobalInitData &LHS,
407 const GlobalInitData &RHS) const {
408 return LHS.first.priority < RHS.first.priority;
412 /// Global variables with initializers whose order of initialization is set by
413 /// init_priority attribute.
414 SmallVector<GlobalInitData, 8> PrioritizedCXXGlobalInits;
416 /// Global destructor functions and arguments that need to run on termination.
417 std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors;
419 /// \brief The complete set of modules that has been imported.
420 llvm::SetVector<clang::Module *> ImportedModules;
422 /// \brief A vector of metadata strings.
423 SmallVector<llvm::Metadata *, 16> LinkerOptionsMetadata;
425 /// @name Cache for Objective-C runtime types
428 /// Cached reference to the class for constant strings. This value has type
429 /// int * but is actually an Obj-C class pointer.
430 llvm::WeakVH CFConstantStringClassRef;
432 /// Cached reference to the class for constant strings. This value has type
433 /// int * but is actually an Obj-C class pointer.
434 llvm::WeakVH ConstantStringClassRef;
436 /// \brief The LLVM type corresponding to NSConstantString.
437 llvm::StructType *NSConstantStringType;
439 /// \brief The type used to describe the state of a fast enumeration in
440 /// Objective-C's for..in loop.
441 QualType ObjCFastEnumerationStateType;
445 /// Lazily create the Objective-C runtime
446 void createObjCRuntime();
448 void createOpenCLRuntime();
449 void createOpenMPRuntime();
450 void createCUDARuntime();
452 bool isTriviallyRecursive(const FunctionDecl *F);
453 bool shouldEmitFunction(GlobalDecl GD);
455 /// @name Cache for Blocks Runtime Globals
458 llvm::Constant *NSConcreteGlobalBlock;
459 llvm::Constant *NSConcreteStackBlock;
461 llvm::Constant *BlockObjectAssign;
462 llvm::Constant *BlockObjectDispose;
464 llvm::Type *BlockDescriptorType;
465 llvm::Type *GenericBlockLiteralType;
468 int GlobalUniqueCount;
471 /// void @llvm.lifetime.start(i64 %size, i8* nocapture <ptr>)
472 llvm::Constant *LifetimeStartFn;
474 /// void @llvm.lifetime.end(i64 %size, i8* nocapture <ptr>)
475 llvm::Constant *LifetimeEndFn;
477 GlobalDecl initializedGlobalDecl;
479 std::unique_ptr<SanitizerMetadata> SanitizerMD;
483 llvm::DenseMap<const Decl *, bool> DeferredEmptyCoverageMappingDecls;
485 std::unique_ptr<CoverageMappingModuleGen> CoverageMapping;
487 /// Mapping from canonical types to their metadata identifiers. We need to
488 /// maintain this mapping because identifiers may be formed from distinct
490 llvm::DenseMap<QualType, llvm::Metadata *> MetadataIdMap;
493 CodeGenModule(ASTContext &C, const HeaderSearchOptions &headersearchopts,
494 const PreprocessorOptions &ppopts,
495 const CodeGenOptions &CodeGenOpts, llvm::Module &M,
496 DiagnosticsEngine &Diags,
497 CoverageSourceInfo *CoverageInfo = nullptr);
503 /// Finalize LLVM code generation.
506 /// Return a reference to the configured Objective-C runtime.
507 CGObjCRuntime &getObjCRuntime() {
508 if (!ObjCRuntime) createObjCRuntime();
512 /// Return true iff an Objective-C runtime has been configured.
513 bool hasObjCRuntime() { return !!ObjCRuntime; }
515 /// Return a reference to the configured OpenCL runtime.
516 CGOpenCLRuntime &getOpenCLRuntime() {
517 assert(OpenCLRuntime != nullptr);
518 return *OpenCLRuntime;
521 /// Return a reference to the configured OpenMP runtime.
522 CGOpenMPRuntime &getOpenMPRuntime() {
523 assert(OpenMPRuntime != nullptr);
524 return *OpenMPRuntime;
527 /// Return a reference to the configured CUDA runtime.
528 CGCUDARuntime &getCUDARuntime() {
529 assert(CUDARuntime != nullptr);
533 ARCEntrypoints &getARCEntrypoints() const {
534 assert(getLangOpts().ObjCAutoRefCount && ARCData != nullptr);
538 RREntrypoints &getRREntrypoints() const {
539 assert(RRData != nullptr);
543 InstrProfStats &getPGOStats() { return PGOStats; }
544 llvm::IndexedInstrProfReader *getPGOReader() const { return PGOReader.get(); }
546 CoverageMappingModuleGen *getCoverageMapping() const {
547 return CoverageMapping.get();
550 llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
551 return StaticLocalDeclMap[D];
553 void setStaticLocalDeclAddress(const VarDecl *D,
555 StaticLocalDeclMap[D] = C;
559 getOrCreateStaticVarDecl(const VarDecl &D,
560 llvm::GlobalValue::LinkageTypes Linkage);
562 llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
563 return StaticLocalDeclGuardMap[D];
565 void setStaticLocalDeclGuardAddress(const VarDecl *D,
566 llvm::GlobalVariable *C) {
567 StaticLocalDeclGuardMap[D] = C;
570 bool lookupRepresentativeDecl(StringRef MangledName,
571 GlobalDecl &Result) const;
573 llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
574 return AtomicSetterHelperFnMap[Ty];
576 void setAtomicSetterHelperFnMap(QualType Ty,
577 llvm::Constant *Fn) {
578 AtomicSetterHelperFnMap[Ty] = Fn;
581 llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
582 return AtomicGetterHelperFnMap[Ty];
584 void setAtomicGetterHelperFnMap(QualType Ty,
585 llvm::Constant *Fn) {
586 AtomicGetterHelperFnMap[Ty] = Fn;
589 llvm::Constant *getTypeDescriptorFromMap(QualType Ty) {
590 return TypeDescriptorMap[Ty];
592 void setTypeDescriptorInMap(QualType Ty, llvm::Constant *C) {
593 TypeDescriptorMap[Ty] = C;
596 CGDebugInfo *getModuleDebugInfo() { return DebugInfo; }
598 llvm::MDNode *getNoObjCARCExceptionsMetadata() {
599 if (!NoObjCARCExceptionsMetadata)
600 NoObjCARCExceptionsMetadata = llvm::MDNode::get(getLLVMContext(), None);
601 return NoObjCARCExceptionsMetadata;
604 ASTContext &getContext() const { return Context; }
605 const LangOptions &getLangOpts() const { return LangOpts; }
606 const HeaderSearchOptions &getHeaderSearchOpts()
607 const { return HeaderSearchOpts; }
608 const PreprocessorOptions &getPreprocessorOpts()
609 const { return PreprocessorOpts; }
610 const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
611 llvm::Module &getModule() const { return TheModule; }
612 DiagnosticsEngine &getDiags() const { return Diags; }
613 const llvm::DataLayout &getDataLayout() const {
614 return TheModule.getDataLayout();
616 const TargetInfo &getTarget() const { return Target; }
617 const llvm::Triple &getTriple() const;
618 bool supportsCOMDAT() const;
619 void maybeSetTrivialComdat(const Decl &D, llvm::GlobalObject &GO);
621 CGCXXABI &getCXXABI() const { return *ABI; }
622 llvm::LLVMContext &getLLVMContext() { return VMContext; }
624 bool shouldUseTBAA() const { return TBAA != nullptr; }
626 const TargetCodeGenInfo &getTargetCodeGenInfo();
628 CodeGenTypes &getTypes() { return Types; }
630 CodeGenVTables &getVTables() { return VTables; }
632 ItaniumVTableContext &getItaniumVTableContext() {
633 return VTables.getItaniumVTableContext();
636 MicrosoftVTableContext &getMicrosoftVTableContext() {
637 return VTables.getMicrosoftVTableContext();
640 CtorList &getGlobalCtors() { return GlobalCtors; }
641 CtorList &getGlobalDtors() { return GlobalDtors; }
643 llvm::MDNode *getTBAAInfo(QualType QTy);
644 llvm::MDNode *getTBAAInfoForVTablePtr();
645 llvm::MDNode *getTBAAStructInfo(QualType QTy);
646 /// Return the path-aware tag for given base type, access node and offset.
647 llvm::MDNode *getTBAAStructTagInfo(QualType BaseTy, llvm::MDNode *AccessN,
650 bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
652 bool isPaddedAtomicType(QualType type);
653 bool isPaddedAtomicType(const AtomicType *type);
655 /// Decorate the instruction with a TBAA tag. For scalar TBAA, the tag
656 /// is the same as the type. For struct-path aware TBAA, the tag
657 /// is different from the type: base type, access type and offset.
658 /// When ConvertTypeToTag is true, we create a tag based on the scalar type.
659 void DecorateInstructionWithTBAA(llvm::Instruction *Inst,
660 llvm::MDNode *TBAAInfo,
661 bool ConvertTypeToTag = true);
663 /// Adds !invariant.barrier !tag to instruction
664 void DecorateInstructionWithInvariantGroup(llvm::Instruction *I,
665 const CXXRecordDecl *RD);
667 /// Emit the given number of characters as a value of type size_t.
668 llvm::ConstantInt *getSize(CharUnits numChars);
670 /// Set the visibility for the given LLVM GlobalValue.
671 void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
673 /// Set the TLS mode for the given LLVM GlobalValue for the thread-local
674 /// variable declaration D.
675 void setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const;
677 static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
679 case DefaultVisibility: return llvm::GlobalValue::DefaultVisibility;
680 case HiddenVisibility: return llvm::GlobalValue::HiddenVisibility;
681 case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
683 llvm_unreachable("unknown visibility!");
686 llvm::Constant *GetAddrOfGlobal(GlobalDecl GD, bool IsForDefinition = false);
688 /// Will return a global variable of the given type. If a variable with a
689 /// different type already exists then a new variable with the right type
690 /// will be created and all uses of the old variable will be replaced with a
691 /// bitcast to the new variable.
692 llvm::GlobalVariable *
693 CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty,
694 llvm::GlobalValue::LinkageTypes Linkage);
697 CreateGlobalInitOrDestructFunction(llvm::FunctionType *ty, const Twine &name,
698 SourceLocation Loc = SourceLocation(),
701 /// Return the address space of the underlying global variable for D, as
702 /// determined by its declaration. Normally this is the same as the address
703 /// space of D's type, but in CUDA, address spaces are associated with
704 /// declarations, not types.
705 unsigned GetGlobalVarAddressSpace(const VarDecl *D, unsigned AddrSpace);
707 /// Return the llvm::Constant for the address of the given global variable.
708 /// If Ty is non-null and if the global doesn't exist, then it will be greated
709 /// with the specified type instead of whatever the normal requested type
711 llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
712 llvm::Type *Ty = nullptr);
714 /// Return the address of the given function. If Ty is non-null, then this
715 /// function will use the specified type if it has to create it.
716 llvm::Constant *GetAddrOfFunction(GlobalDecl GD, llvm::Type *Ty = nullptr,
717 bool ForVTable = false,
718 bool DontDefer = false,
719 bool IsForDefinition = false);
721 /// Get the address of the RTTI descriptor for the given type.
722 llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
724 /// Get the address of a uuid descriptor .
725 ConstantAddress GetAddrOfUuidDescriptor(const CXXUuidofExpr* E);
727 /// Get the address of the thunk for the given global decl.
728 llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk);
730 /// Get a reference to the target of VD.
731 ConstantAddress GetWeakRefReference(const ValueDecl *VD);
733 /// Returns the assumed alignment of an opaque pointer to the given class.
734 CharUnits getClassPointerAlignment(const CXXRecordDecl *CD);
736 /// Returns the assumed alignment of a virtual base of a class.
737 CharUnits getVBaseAlignment(CharUnits DerivedAlign,
738 const CXXRecordDecl *Derived,
739 const CXXRecordDecl *VBase);
741 /// Given a class pointer with an actual known alignment, and the
742 /// expected alignment of an object at a dynamic offset w.r.t that
743 /// pointer, return the alignment to assume at the offset.
744 CharUnits getDynamicOffsetAlignment(CharUnits ActualAlign,
745 const CXXRecordDecl *Class,
746 CharUnits ExpectedTargetAlign);
749 computeNonVirtualBaseClassOffset(const CXXRecordDecl *DerivedClass,
750 CastExpr::path_const_iterator Start,
751 CastExpr::path_const_iterator End);
753 /// Returns the offset from a derived class to a class. Returns null if the
756 GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
757 CastExpr::path_const_iterator PathBegin,
758 CastExpr::path_const_iterator PathEnd);
760 llvm::FoldingSet<BlockByrefHelpers> ByrefHelpersCache;
762 /// Fetches the global unique block count.
763 int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
765 /// Fetches the type of a generic block descriptor.
766 llvm::Type *getBlockDescriptorType();
768 /// The type of a generic block literal.
769 llvm::Type *getGenericBlockLiteralType();
771 /// Gets the address of a block which requires no captures.
772 llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *);
774 /// Return a pointer to a constant CFString object for the given string.
775 ConstantAddress GetAddrOfConstantCFString(const StringLiteral *Literal);
777 /// Return a pointer to a constant NSString object for the given string. Or a
778 /// user defined String object as defined via
779 /// -fconstant-string-class=class_name option.
780 ConstantAddress GetAddrOfConstantString(const StringLiteral *Literal);
782 /// Return a constant array for the given string.
783 llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
785 /// Return a pointer to a constant array for the given string literal.
787 GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
788 StringRef Name = ".str");
790 /// Return a pointer to a constant array for the given ObjCEncodeExpr node.
792 GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
794 /// Returns a pointer to a character array containing the literal and a
795 /// terminating '\0' character. The result has pointer to array type.
797 /// \param GlobalName If provided, the name to use for the global (if one is
800 GetAddrOfConstantCString(const std::string &Str,
801 const char *GlobalName = nullptr);
803 /// Returns a pointer to a constant global variable for the given file-scope
804 /// compound literal expression.
805 ConstantAddress GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
807 /// \brief Returns a pointer to a global variable representing a temporary
808 /// with static or thread storage duration.
809 ConstantAddress GetAddrOfGlobalTemporary(const MaterializeTemporaryExpr *E,
812 /// \brief Retrieve the record type that describes the state of an
813 /// Objective-C fast enumeration loop (for..in).
814 QualType getObjCFastEnumerationStateType();
816 // Produce code for this constructor/destructor. This method doesn't try
817 // to apply any ABI rules about which other constructors/destructors
818 // are needed or if they are alias to each other.
819 llvm::Function *codegenCXXStructor(const CXXMethodDecl *MD,
822 /// Return the address of the constructor/destructor of the given type.
824 getAddrOfCXXStructor(const CXXMethodDecl *MD, StructorType Type,
825 const CGFunctionInfo *FnInfo = nullptr,
826 llvm::FunctionType *FnType = nullptr,
827 bool DontDefer = false, bool IsForDefinition = false);
829 /// Given a builtin id for a function like "__builtin_fabsf", return a
830 /// Function* for "fabsf".
831 llvm::Value *getBuiltinLibFunction(const FunctionDecl *FD,
834 llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = None);
836 /// Emit code for a single top level declaration.
837 void EmitTopLevelDecl(Decl *D);
839 /// \brief Stored a deferred empty coverage mapping for an unused
840 /// and thus uninstrumented top level declaration.
841 void AddDeferredUnusedCoverageMapping(Decl *D);
843 /// \brief Remove the deferred empty coverage mapping as this
844 /// declaration is actually instrumented.
845 void ClearUnusedCoverageMapping(const Decl *D);
847 /// \brief Emit all the deferred coverage mappings
848 /// for the uninstrumented functions.
849 void EmitDeferredUnusedCoverageMappings();
851 /// Tell the consumer that this variable has been instantiated.
852 void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
854 /// \brief If the declaration has internal linkage but is inside an
855 /// extern "C" linkage specification, prepare to emit an alias for it
856 /// to the expected name.
857 template<typename SomeDecl>
858 void MaybeHandleStaticInExternC(const SomeDecl *D, llvm::GlobalValue *GV);
860 /// Add a global to a list to be added to the llvm.used metadata.
861 void addUsedGlobal(llvm::GlobalValue *GV);
863 /// Add a global to a list to be added to the llvm.compiler.used metadata.
864 void addCompilerUsedGlobal(llvm::GlobalValue *GV);
866 /// Add a destructor and object to add to the C++ global destructor function.
867 void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) {
868 CXXGlobalDtors.emplace_back(DtorFn, Object);
871 /// Create a new runtime function with the specified type and name.
872 llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty,
874 llvm::AttributeSet ExtraAttrs =
875 llvm::AttributeSet());
876 /// Create a new compiler builtin function with the specified type and name.
877 llvm::Constant *CreateBuiltinFunction(llvm::FunctionType *Ty,
879 llvm::AttributeSet ExtraAttrs =
880 llvm::AttributeSet());
881 /// Create a new runtime global variable with the specified type and name.
882 llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
885 ///@name Custom Blocks Runtime Interfaces
888 llvm::Constant *getNSConcreteGlobalBlock();
889 llvm::Constant *getNSConcreteStackBlock();
890 llvm::Constant *getBlockObjectAssign();
891 llvm::Constant *getBlockObjectDispose();
895 llvm::Constant *getLLVMLifetimeStartFn();
896 llvm::Constant *getLLVMLifetimeEndFn();
898 // Make sure that this type is translated.
899 void UpdateCompletedType(const TagDecl *TD);
901 llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
903 /// Try to emit the initializer for the given declaration as a constant;
904 /// returns 0 if the expression cannot be emitted as a constant.
905 llvm::Constant *EmitConstantInit(const VarDecl &D,
906 CodeGenFunction *CGF = nullptr);
908 /// Try to emit the given expression as a constant; returns 0 if the
909 /// expression cannot be emitted as a constant.
910 llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType,
911 CodeGenFunction *CGF = nullptr);
913 /// Emit the given constant value as a constant, in the type's scalar
915 llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType,
916 CodeGenFunction *CGF = nullptr);
918 /// Emit the given constant value as a constant, in the type's memory
920 llvm::Constant *EmitConstantValueForMemory(const APValue &Value,
922 CodeGenFunction *CGF = nullptr);
924 /// Return the result of value-initializing the given type, i.e. a null
925 /// expression of the given type. This is usually, but not always, an LLVM
927 llvm::Constant *EmitNullConstant(QualType T);
929 /// Return a null constant appropriate for zero-initializing a base class with
930 /// the given type. This is usually, but not always, an LLVM null constant.
931 llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
933 /// Emit a general error that something can't be done.
934 void Error(SourceLocation loc, StringRef error);
936 /// Print out an error that codegen doesn't support the specified stmt yet.
937 void ErrorUnsupported(const Stmt *S, const char *Type);
939 /// Print out an error that codegen doesn't support the specified decl yet.
940 void ErrorUnsupported(const Decl *D, const char *Type);
942 /// Set the attributes on the LLVM function for the given decl and function
943 /// info. This applies attributes necessary for handling the ABI as well as
944 /// user specified attributes like section.
945 void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F,
946 const CGFunctionInfo &FI);
948 /// Set the LLVM function attributes (sext, zext, etc).
949 void SetLLVMFunctionAttributes(const Decl *D,
950 const CGFunctionInfo &Info,
953 /// Set the LLVM function attributes which only apply to a function
955 void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
957 /// Return true iff the given type uses 'sret' when used as a return type.
958 bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
960 /// Return true iff the given type uses an argument slot when 'sret' is used
961 /// as a return type.
962 bool ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI);
964 /// Return true iff the given type uses 'fpret' when used as a return type.
965 bool ReturnTypeUsesFPRet(QualType ResultType);
967 /// Return true iff the given type uses 'fp2ret' when used as a return type.
968 bool ReturnTypeUsesFP2Ret(QualType ResultType);
970 /// Get the LLVM attributes and calling convention to use for a particular
973 /// \param Info - The function type information.
974 /// \param TargetDecl - The decl these attributes are being constructed
975 /// for. If supplied the attributes applied to this decl may contribute to the
976 /// function attributes and calling convention.
977 /// \param PAL [out] - On return, the attribute list to use.
978 /// \param CallingConv [out] - On return, the LLVM calling convention to use.
979 void ConstructAttributeList(const CGFunctionInfo &Info,
980 const Decl *TargetDecl,
981 AttributeListType &PAL,
982 unsigned &CallingConv,
983 bool AttrOnCallSite);
985 StringRef getMangledName(GlobalDecl GD);
986 StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD);
988 void EmitTentativeDefinition(const VarDecl *D);
990 void EmitVTable(CXXRecordDecl *Class);
992 /// \brief Appends Opts to the "Linker Options" metadata value.
993 void AppendLinkerOptions(StringRef Opts);
995 /// \brief Appends a detect mismatch command to the linker options.
996 void AddDetectMismatch(StringRef Name, StringRef Value);
998 /// \brief Appends a dependent lib to the "Linker Options" metadata value.
999 void AddDependentLib(StringRef Lib);
1001 llvm::GlobalVariable::LinkageTypes getFunctionLinkage(GlobalDecl GD);
1003 void setFunctionLinkage(GlobalDecl GD, llvm::Function *F) {
1004 F->setLinkage(getFunctionLinkage(GD));
1007 /// Set the DLL storage class on F.
1008 void setFunctionDLLStorageClass(GlobalDecl GD, llvm::Function *F);
1010 /// Return the appropriate linkage for the vtable, VTT, and type information
1011 /// of the given class.
1012 llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
1014 /// Return the store size, in character units, of the given LLVM type.
1015 CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
1017 /// Returns LLVM linkage for a declarator.
1018 llvm::GlobalValue::LinkageTypes
1019 getLLVMLinkageForDeclarator(const DeclaratorDecl *D, GVALinkage Linkage,
1020 bool IsConstantVariable);
1022 /// Returns LLVM linkage for a declarator.
1023 llvm::GlobalValue::LinkageTypes
1024 getLLVMLinkageVarDefinition(const VarDecl *VD, bool IsConstant);
1026 /// Emit all the global annotations.
1027 void EmitGlobalAnnotations();
1029 /// Emit an annotation string.
1030 llvm::Constant *EmitAnnotationString(StringRef Str);
1032 /// Emit the annotation's translation unit.
1033 llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
1035 /// Emit the annotation line number.
1036 llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
1038 /// Generate the llvm::ConstantStruct which contains the annotation
1039 /// information for a given GlobalValue. The annotation struct is
1040 /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
1041 /// GlobalValue being annotated. The second field is the constant string
1042 /// created from the AnnotateAttr's annotation. The third field is a constant
1043 /// string containing the name of the translation unit. The fourth field is
1044 /// the line number in the file of the annotated value declaration.
1045 llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
1046 const AnnotateAttr *AA,
1049 /// Add global annotations that are set on D, for the global GV. Those
1050 /// annotations are emitted during finalization of the LLVM code.
1051 void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
1053 bool isInSanitizerBlacklist(llvm::Function *Fn, SourceLocation Loc) const;
1055 bool isInSanitizerBlacklist(llvm::GlobalVariable *GV, SourceLocation Loc,
1057 StringRef Category = StringRef()) const;
1059 SanitizerMetadata *getSanitizerMetadata() {
1060 return SanitizerMD.get();
1063 void addDeferredVTable(const CXXRecordDecl *RD) {
1064 DeferredVTables.push_back(RD);
1067 /// Emit code for a singal global function or var decl. Forward declarations
1068 /// are emitted lazily.
1069 void EmitGlobal(GlobalDecl D);
1071 bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target,
1073 bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
1075 /// Set attributes for a global definition.
1076 void setFunctionDefinitionAttributes(const FunctionDecl *D,
1079 llvm::GlobalValue *GetGlobalValue(StringRef Ref);
1081 /// Set attributes which are common to any form of a global definition (alias,
1082 /// Objective-C method, function, global variable).
1084 /// NOTE: This should only be called for definitions.
1085 void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV);
1087 /// Set attributes which must be preserved by an alias. This includes common
1088 /// attributes (i.e. it includes a call to SetCommonAttributes).
1090 /// NOTE: This should only be called for definitions.
1091 void setAliasAttributes(const Decl *D, llvm::GlobalValue *GV);
1093 void addReplacement(StringRef Name, llvm::Constant *C);
1095 void addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C);
1097 /// \brief Emit a code for threadprivate directive.
1098 /// \param D Threadprivate declaration.
1099 void EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D);
1101 /// Returns whether the given record is blacklisted from control flow
1102 /// integrity checks.
1103 bool IsCFIBlacklistedRecord(const CXXRecordDecl *RD);
1105 /// Emit bit set entries for the given vtable using the given layout if
1106 /// vptr CFI is enabled.
1107 void EmitVTableBitSetEntries(llvm::GlobalVariable *VTable,
1108 const VTableLayout &VTLayout);
1110 /// Create a metadata identifier for the given type. This may either be an
1111 /// MDString (for external identifiers) or a distinct unnamed MDNode (for
1112 /// internal identifiers).
1113 llvm::Metadata *CreateMetadataIdentifierForType(QualType T);
1115 /// Create a bitset entry for the given vtable.
1116 llvm::MDTuple *CreateVTableBitSetEntry(llvm::GlobalVariable *VTable,
1118 const CXXRecordDecl *RD);
1120 /// \breif Get the declaration of std::terminate for the platform.
1121 llvm::Constant *getTerminateFn();
1125 GetOrCreateLLVMFunction(StringRef MangledName, llvm::Type *Ty, GlobalDecl D,
1126 bool ForVTable, bool DontDefer = false,
1127 bool IsThunk = false,
1128 llvm::AttributeSet ExtraAttrs = llvm::AttributeSet(),
1129 bool IsForDefinition = false);
1131 llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName,
1132 llvm::PointerType *PTy,
1135 void setNonAliasAttributes(const Decl *D, llvm::GlobalObject *GO);
1137 /// Set function attributes for a function declaration.
1138 void SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
1139 bool IsIncompleteFunction, bool IsThunk);
1141 void EmitGlobalDefinition(GlobalDecl D, llvm::GlobalValue *GV = nullptr);
1143 void EmitGlobalFunctionDefinition(GlobalDecl GD, llvm::GlobalValue *GV);
1144 void EmitGlobalVarDefinition(const VarDecl *D);
1145 void EmitAliasDefinition(GlobalDecl GD);
1146 void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
1147 void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
1149 // C++ related functions.
1151 void EmitNamespace(const NamespaceDecl *D);
1152 void EmitLinkageSpec(const LinkageSpecDecl *D);
1153 void CompleteDIClassType(const CXXMethodDecl* D);
1155 /// \brief Emit the function that initializes C++ thread_local variables.
1156 void EmitCXXThreadLocalInitFunc();
1158 /// Emit the function that initializes C++ globals.
1159 void EmitCXXGlobalInitFunc();
1161 /// Emit the function that destroys C++ globals.
1162 void EmitCXXGlobalDtorFunc();
1164 /// Emit the function that initializes the specified global (if PerformInit is
1165 /// true) and registers its destructor.
1166 void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
1167 llvm::GlobalVariable *Addr,
1170 void EmitPointerToInitFunc(const VarDecl *VD, llvm::GlobalVariable *Addr,
1171 llvm::Function *InitFunc, InitSegAttr *ISA);
1173 // FIXME: Hardcoding priority here is gross.
1174 void AddGlobalCtor(llvm::Function *Ctor, int Priority = 65535,
1175 llvm::Constant *AssociatedData = nullptr);
1176 void AddGlobalDtor(llvm::Function *Dtor, int Priority = 65535);
1178 /// Generates a global array of functions and priorities using the given list
1179 /// and name. This array will have appending linkage and is suitable for use
1180 /// as a LLVM constructor or destructor array.
1181 void EmitCtorList(const CtorList &Fns, const char *GlobalName);
1183 /// Emit any needed decls for which code generation was deferred.
1184 void EmitDeferred();
1186 /// Call replaceAllUsesWith on all pairs in Replacements.
1187 void applyReplacements();
1189 /// Call replaceAllUsesWith on all pairs in GlobalValReplacements.
1190 void applyGlobalValReplacements();
1192 void checkAliases();
1194 /// Emit any vtables which we deferred and still have a use for.
1195 void EmitDeferredVTables();
1197 /// Emit the llvm.used and llvm.compiler.used metadata.
1198 void emitLLVMUsed();
1200 /// \brief Emit the link options introduced by imported modules.
1201 void EmitModuleLinkOptions();
1203 /// \brief Emit aliases for internal-linkage declarations inside "C" language
1204 /// linkage specifications, giving them the "expected" name where possible.
1205 void EmitStaticExternCAliases();
1207 void EmitDeclMetadata();
1209 /// \brief Emit the Clang version as llvm.ident metadata.
1210 void EmitVersionIdentMetadata();
1212 /// Emits target specific Metadata for global declarations.
1213 void EmitTargetMetadata();
1215 /// Emit the llvm.gcov metadata used to tell LLVM where to emit the .gcno and
1216 /// .gcda files in a way that persists in .bc files.
1217 void EmitCoverageFile();
1219 /// Emits the initializer for a uuidof string.
1220 llvm::Constant *EmitUuidofInitializer(StringRef uuidstr);
1222 /// Determine whether the definition must be emitted; if this returns \c
1223 /// false, the definition can be emitted lazily if it's used.
1224 bool MustBeEmitted(const ValueDecl *D);
1226 /// Determine whether the definition can be emitted eagerly, or should be
1227 /// delayed until the end of the translation unit. This is relevant for
1228 /// definitions whose linkage can change, e.g. implicit function instantions
1229 /// which may later be explicitly instantiated.
1230 bool MayBeEmittedEagerly(const ValueDecl *D);
1232 /// Check whether we can use a "simpler", more core exceptions personality
1234 void SimplifyPersonality();
1236 } // end namespace CodeGen
1237 } // end namespace clang
1239 #endif // LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H