1 //===--- CodeGenModule.h - Per-Module state for LLVM CodeGen ----*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This is the internal per-translation-unit state used for llvm translation.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
15 #define LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
16 
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/DeclOpenMP.h"
25 #include "clang/AST/GlobalDecl.h"
26 #include "clang/AST/Mangle.h"
27 #include "clang/Basic/ABI.h"
28 #include "clang/Basic/LangOptions.h"
29 #include "clang/Basic/Module.h"
30 #include "clang/Basic/SanitizerBlacklist.h"
31 #include "llvm/ADT/DenseMap.h"
32 #include "llvm/ADT/SetVector.h"
33 #include "llvm/ADT/SmallPtrSet.h"
34 #include "llvm/ADT/StringMap.h"
35 #include "llvm/IR/Module.h"
36 #include "llvm/IR/ValueHandle.h"
37 #include "llvm/Transforms/Utils/SanitizerStats.h"
38 
39 namespace llvm {
40 class Module;
41 class Constant;
42 class ConstantInt;
43 class Function;
44 class GlobalValue;
45 class DataLayout;
46 class FunctionType;
47 class LLVMContext;
48 class IndexedInstrProfReader;
49 }
50 
51 namespace clang {
52 class ASTContext;
53 class AtomicType;
54 class FunctionDecl;
55 class IdentifierInfo;
56 class ObjCMethodDecl;
57 class ObjCImplementationDecl;
58 class ObjCCategoryImplDecl;
59 class ObjCProtocolDecl;
60 class ObjCEncodeExpr;
61 class BlockExpr;
62 class CharUnits;
63 class Decl;
64 class Expr;
65 class Stmt;
66 class InitListExpr;
67 class StringLiteral;
68 class NamedDecl;
69 class ValueDecl;
70 class VarDecl;
71 class LangOptions;
72 class CodeGenOptions;
73 class HeaderSearchOptions;
74 class PreprocessorOptions;
75 class DiagnosticsEngine;
76 class AnnotateAttr;
77 class CXXDestructorDecl;
78 class Module;
79 class CoverageSourceInfo;
80 
81 namespace CodeGen {
82 
83 class CallArgList;
84 class CodeGenFunction;
85 class CodeGenTBAA;
86 class CGCXXABI;
87 class CGDebugInfo;
88 class CGObjCRuntime;
89 class CGOpenCLRuntime;
90 class CGOpenMPRuntime;
91 class CGCUDARuntime;
92 class BlockFieldFlags;
93 class FunctionArgList;
94 class CoverageMappingModuleGen;
95 class TargetCodeGenInfo;
96 
97 enum ForDefinition_t : bool {
98   NotForDefinition = false,
99   ForDefinition = true
100 };
101 
102 struct OrderGlobalInits {
103   unsigned int priority;
104   unsigned int lex_order;
105   OrderGlobalInits(unsigned int p, unsigned int l)
106       : priority(p), lex_order(l) {}
107 
108   bool operator==(const OrderGlobalInits &RHS) const {
109     return priority == RHS.priority && lex_order == RHS.lex_order;
110   }
111 
112   bool operator<(const OrderGlobalInits &RHS) const {
113     return std::tie(priority, lex_order) <
114            std::tie(RHS.priority, RHS.lex_order);
115   }
116 };
117 
118 struct ObjCEntrypoints {
119   ObjCEntrypoints() { memset(this, 0, sizeof(*this)); }
120 
121     /// void objc_autoreleasePoolPop(void*);
122   llvm::Constant *objc_autoreleasePoolPop;
123 
124   /// void *objc_autoreleasePoolPush(void);
125   llvm::Constant *objc_autoreleasePoolPush;
126 
127   /// id objc_autorelease(id);
128   llvm::Constant *objc_autorelease;
129 
130   /// id objc_autoreleaseReturnValue(id);
131   llvm::Constant *objc_autoreleaseReturnValue;
132 
133   /// void objc_copyWeak(id *dest, id *src);
134   llvm::Constant *objc_copyWeak;
135 
136   /// void objc_destroyWeak(id*);
137   llvm::Constant *objc_destroyWeak;
138 
139   /// id objc_initWeak(id*, id);
140   llvm::Constant *objc_initWeak;
141 
142   /// id objc_loadWeak(id*);
143   llvm::Constant *objc_loadWeak;
144 
145   /// id objc_loadWeakRetained(id*);
146   llvm::Constant *objc_loadWeakRetained;
147 
148   /// void objc_moveWeak(id *dest, id *src);
149   llvm::Constant *objc_moveWeak;
150 
151   /// id objc_retain(id);
152   llvm::Constant *objc_retain;
153 
154   /// id objc_retainAutorelease(id);
155   llvm::Constant *objc_retainAutorelease;
156 
157   /// id objc_retainAutoreleaseReturnValue(id);
158   llvm::Constant *objc_retainAutoreleaseReturnValue;
159 
160   /// id objc_retainAutoreleasedReturnValue(id);
161   llvm::Constant *objc_retainAutoreleasedReturnValue;
162 
163   /// id objc_retainBlock(id);
164   llvm::Constant *objc_retainBlock;
165 
166   /// void objc_release(id);
167   llvm::Constant *objc_release;
168 
169   /// id objc_storeStrong(id*, id);
170   llvm::Constant *objc_storeStrong;
171 
172   /// id objc_storeWeak(id*, id);
173   llvm::Constant *objc_storeWeak;
174 
175   /// id objc_unsafeClaimAutoreleasedReturnValue(id);
176   llvm::Constant *objc_unsafeClaimAutoreleasedReturnValue;
177 
178   /// A void(void) inline asm to use to mark that the return value of
179   /// a call will be immediately retain.
180   llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
181 
182   /// void clang.arc.use(...);
183   llvm::Constant *clang_arc_use;
184 };
185 
186 /// This class records statistics on instrumentation based profiling.
187 class InstrProfStats {
188   uint32_t VisitedInMainFile;
189   uint32_t MissingInMainFile;
190   uint32_t Visited;
191   uint32_t Missing;
192   uint32_t Mismatched;
193 
194 public:
195   InstrProfStats()
196       : VisitedInMainFile(0), MissingInMainFile(0), Visited(0), Missing(0),
197         Mismatched(0) {}
198   /// Record that we've visited a function and whether or not that function was
199   /// in the main source file.
200   void addVisited(bool MainFile) {
201     if (MainFile)
202       ++VisitedInMainFile;
203     ++Visited;
204   }
205   /// Record that a function we've visited has no profile data.
206   void addMissing(bool MainFile) {
207     if (MainFile)
208       ++MissingInMainFile;
209     ++Missing;
210   }
211   /// Record that a function we've visited has mismatched profile data.
212   void addMismatched(bool MainFile) { ++Mismatched; }
213   /// Whether or not the stats we've gathered indicate any potential problems.
214   bool hasDiagnostics() { return Missing || Mismatched; }
215   /// Report potential problems we've found to \c Diags.
216   void reportDiagnostics(DiagnosticsEngine &Diags, StringRef MainFile);
217 };
218 
219 /// A pair of helper functions for a __block variable.
220 class BlockByrefHelpers : public llvm::FoldingSetNode {
221   // MSVC requires this type to be complete in order to process this
222   // header.
223 public:
224   llvm::Constant *CopyHelper;
225   llvm::Constant *DisposeHelper;
226 
227   /// The alignment of the field.  This is important because
228   /// different offsets to the field within the byref struct need to
229   /// have different helper functions.
230   CharUnits Alignment;
231 
232   BlockByrefHelpers(CharUnits alignment) : Alignment(alignment) {}
233   BlockByrefHelpers(const BlockByrefHelpers &) = default;
234   virtual ~BlockByrefHelpers();
235 
236   void Profile(llvm::FoldingSetNodeID &id) const {
237     id.AddInteger(Alignment.getQuantity());
238     profileImpl(id);
239   }
240   virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
241 
242   virtual bool needsCopy() const { return true; }
243   virtual void emitCopy(CodeGenFunction &CGF, Address dest, Address src) = 0;
244 
245   virtual bool needsDispose() const { return true; }
246   virtual void emitDispose(CodeGenFunction &CGF, Address field) = 0;
247 };
248 
249 /// This class organizes the cross-function state that is used while generating
250 /// LLVM code.
251 class CodeGenModule : public CodeGenTypeCache {
252   CodeGenModule(const CodeGenModule &) = delete;
253   void operator=(const CodeGenModule &) = delete;
254 
255 public:
256   struct Structor {
257     Structor() : Priority(0), Initializer(nullptr), AssociatedData(nullptr) {}
258     Structor(int Priority, llvm::Constant *Initializer,
259              llvm::Constant *AssociatedData)
260         : Priority(Priority), Initializer(Initializer),
261           AssociatedData(AssociatedData) {}
262     int Priority;
263     llvm::Constant *Initializer;
264     llvm::Constant *AssociatedData;
265   };
266 
267   typedef std::vector<Structor> CtorList;
268 
269 private:
270   ASTContext &Context;
271   const LangOptions &LangOpts;
272   const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info.
273   const PreprocessorOptions &PreprocessorOpts; // Only used for debug info.
274   const CodeGenOptions &CodeGenOpts;
275   llvm::Module &TheModule;
276   DiagnosticsEngine &Diags;
277   const TargetInfo &Target;
278   std::unique_ptr<CGCXXABI> ABI;
279   llvm::LLVMContext &VMContext;
280 
281   std::unique_ptr<CodeGenTBAA> TBAA;
282 
283   mutable std::unique_ptr<TargetCodeGenInfo> TheTargetCodeGenInfo;
284 
285   // This should not be moved earlier, since its initialization depends on some
286   // of the previous reference members being already initialized and also checks
287   // if TheTargetCodeGenInfo is NULL
288   CodeGenTypes Types;
289 
290   /// Holds information about C++ vtables.
291   CodeGenVTables VTables;
292 
293   std::unique_ptr<CGObjCRuntime> ObjCRuntime;
294   std::unique_ptr<CGOpenCLRuntime> OpenCLRuntime;
295   std::unique_ptr<CGOpenMPRuntime> OpenMPRuntime;
296   std::unique_ptr<CGCUDARuntime> CUDARuntime;
297   std::unique_ptr<CGDebugInfo> DebugInfo;
298   std::unique_ptr<ObjCEntrypoints> ObjCData;
299   llvm::MDNode *NoObjCARCExceptionsMetadata = nullptr;
300   std::unique_ptr<llvm::IndexedInstrProfReader> PGOReader;
301   InstrProfStats PGOStats;
302   std::unique_ptr<llvm::SanitizerStatReport> SanStats;
303 
304   // A set of references that have only been seen via a weakref so far. This is
305   // used to remove the weak of the reference if we ever see a direct reference
306   // or a definition.
307   llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
308 
309   /// This contains all the decls which have definitions but/ which are deferred
310   /// for emission and therefore should only be output if they are actually
311   /// used. If a decl is in this, then it is known to have not been referenced
312   /// yet.
313   std::map<StringRef, GlobalDecl> DeferredDecls;
314 
315   /// This is a list of deferred decls which we have seen that *are* actually
316   /// referenced. These get code generated when the module is done.
317   struct DeferredGlobal {
318     DeferredGlobal(llvm::GlobalValue *GV, GlobalDecl GD) : GV(GV), GD(GD) {}
319     llvm::TrackingVH<llvm::GlobalValue> GV;
320     GlobalDecl GD;
321   };
322   std::vector<DeferredGlobal> DeferredDeclsToEmit;
323   void addDeferredDeclToEmit(llvm::GlobalValue *GV, GlobalDecl GD) {
324     DeferredDeclsToEmit.emplace_back(GV, GD);
325   }
326 
327   /// List of alias we have emitted. Used to make sure that what they point to
328   /// is defined once we get to the end of the of the translation unit.
329   std::vector<GlobalDecl> Aliases;
330 
331   typedef llvm::StringMap<llvm::TrackingVH<llvm::Constant> > ReplacementsTy;
332   ReplacementsTy Replacements;
333 
334   /// List of global values to be replaced with something else. Used when we
335   /// want to replace a GlobalValue but can't identify it by its mangled name
336   /// anymore (because the name is already taken).
337   llvm::SmallVector<std::pair<llvm::GlobalValue *, llvm::Constant *>, 8>
338     GlobalValReplacements;
339 
340   /// Set of global decls for which we already diagnosed mangled name conflict.
341   /// Required to not issue a warning (on a mangling conflict) multiple times
342   /// for the same decl.
343   llvm::DenseSet<GlobalDecl> DiagnosedConflictingDefinitions;
344 
345   /// A queue of (optional) vtables to consider emitting.
346   std::vector<const CXXRecordDecl*> DeferredVTables;
347 
348   /// List of global values which are required to be present in the object file;
349   /// bitcast to i8*. This is used for forcing visibility of symbols which may
350   /// otherwise be optimized out.
351   std::vector<llvm::WeakVH> LLVMUsed;
352   std::vector<llvm::WeakVH> LLVMCompilerUsed;
353 
354   /// Store the list of global constructors and their respective priorities to
355   /// be emitted when the translation unit is complete.
356   CtorList GlobalCtors;
357 
358   /// Store the list of global destructors and their respective priorities to be
359   /// emitted when the translation unit is complete.
360   CtorList GlobalDtors;
361 
362   /// An ordered map of canonical GlobalDecls to their mangled names.
363   llvm::MapVector<GlobalDecl, StringRef> MangledDeclNames;
364   llvm::StringMap<GlobalDecl, llvm::BumpPtrAllocator> Manglings;
365 
366   /// Global annotations.
367   std::vector<llvm::Constant*> Annotations;
368 
369   /// Map used to get unique annotation strings.
370   llvm::StringMap<llvm::Constant*> AnnotationStrings;
371 
372   llvm::StringMap<llvm::GlobalVariable *> CFConstantStringMap;
373 
374   llvm::DenseMap<llvm::Constant *, llvm::GlobalVariable *> ConstantStringMap;
375   llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
376   llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
377   llvm::DenseMap<const Expr*, llvm::Constant *> MaterializedGlobalTemporaryMap;
378 
379   llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
380   llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
381 
382   /// Map used to get unique type descriptor constants for sanitizers.
383   llvm::DenseMap<QualType, llvm::Constant *> TypeDescriptorMap;
384 
385   /// Map used to track internal linkage functions declared within
386   /// extern "C" regions.
387   typedef llvm::MapVector<IdentifierInfo *,
388                           llvm::GlobalValue *> StaticExternCMap;
389   StaticExternCMap StaticExternCValues;
390 
391   /// \brief thread_local variables defined or used in this TU.
392   std::vector<const VarDecl *> CXXThreadLocals;
393 
394   /// \brief thread_local variables with initializers that need to run
395   /// before any thread_local variable in this TU is odr-used.
396   std::vector<llvm::Function *> CXXThreadLocalInits;
397   std::vector<const VarDecl *> CXXThreadLocalInitVars;
398 
399   /// Global variables with initializers that need to run before main.
400   std::vector<llvm::Function *> CXXGlobalInits;
401 
402   /// When a C++ decl with an initializer is deferred, null is
403   /// appended to CXXGlobalInits, and the index of that null is placed
404   /// here so that the initializer will be performed in the correct
405   /// order. Once the decl is emitted, the index is replaced with ~0U to ensure
406   /// that we don't re-emit the initializer.
407   llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
408 
409   typedef std::pair<OrderGlobalInits, llvm::Function*> GlobalInitData;
410 
411   struct GlobalInitPriorityCmp {
412     bool operator()(const GlobalInitData &LHS,
413                     const GlobalInitData &RHS) const {
414       return LHS.first.priority < RHS.first.priority;
415     }
416   };
417 
418   /// Global variables with initializers whose order of initialization is set by
419   /// init_priority attribute.
420   SmallVector<GlobalInitData, 8> PrioritizedCXXGlobalInits;
421 
422   /// Global destructor functions and arguments that need to run on termination.
423   std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors;
424 
425   /// \brief The complete set of modules that has been imported.
426   llvm::SetVector<clang::Module *> ImportedModules;
427 
428   /// \brief The set of modules for which the module initializers
429   /// have been emitted.
430   llvm::SmallPtrSet<clang::Module *, 16> EmittedModuleInitializers;
431 
432   /// \brief A vector of metadata strings.
433   SmallVector<llvm::Metadata *, 16> LinkerOptionsMetadata;
434 
435   /// @name Cache for Objective-C runtime types
436   /// @{
437 
438   /// Cached reference to the class for constant strings. This value has type
439   /// int * but is actually an Obj-C class pointer.
440   llvm::WeakVH CFConstantStringClassRef;
441 
442   /// \brief The type used to describe the state of a fast enumeration in
443   /// Objective-C's for..in loop.
444   QualType ObjCFastEnumerationStateType;
445 
446   /// @}
447 
448   /// Lazily create the Objective-C runtime
449   void createObjCRuntime();
450 
451   void createOpenCLRuntime();
452   void createOpenMPRuntime();
453   void createCUDARuntime();
454 
455   bool isTriviallyRecursive(const FunctionDecl *F);
456   bool shouldEmitFunction(GlobalDecl GD);
457 
458   /// @name Cache for Blocks Runtime Globals
459   /// @{
460 
461   llvm::Constant *NSConcreteGlobalBlock = nullptr;
462   llvm::Constant *NSConcreteStackBlock = nullptr;
463 
464   llvm::Constant *BlockObjectAssign = nullptr;
465   llvm::Constant *BlockObjectDispose = nullptr;
466 
467   llvm::Type *BlockDescriptorType = nullptr;
468   llvm::Type *GenericBlockLiteralType = nullptr;
469 
470   struct {
471     int GlobalUniqueCount;
472   } Block;
473 
474   /// void @llvm.lifetime.start(i64 %size, i8* nocapture <ptr>)
475   llvm::Constant *LifetimeStartFn = nullptr;
476 
477   /// void @llvm.lifetime.end(i64 %size, i8* nocapture <ptr>)
478   llvm::Constant *LifetimeEndFn = nullptr;
479 
480   GlobalDecl initializedGlobalDecl;
481 
482   std::unique_ptr<SanitizerMetadata> SanitizerMD;
483 
484   /// @}
485 
486   llvm::DenseMap<const Decl *, bool> DeferredEmptyCoverageMappingDecls;
487 
488   std::unique_ptr<CoverageMappingModuleGen> CoverageMapping;
489 
490   /// Mapping from canonical types to their metadata identifiers. We need to
491   /// maintain this mapping because identifiers may be formed from distinct
492   /// MDNodes.
493   llvm::DenseMap<QualType, llvm::Metadata *> MetadataIdMap;
494 
495 public:
496   CodeGenModule(ASTContext &C, const HeaderSearchOptions &headersearchopts,
497                 const PreprocessorOptions &ppopts,
498                 const CodeGenOptions &CodeGenOpts, llvm::Module &M,
499                 DiagnosticsEngine &Diags,
500                 CoverageSourceInfo *CoverageInfo = nullptr);
501 
502   ~CodeGenModule();
503 
504   void clear();
505 
506   /// Finalize LLVM code generation.
507   void Release();
508 
509   /// Return a reference to the configured Objective-C runtime.
510   CGObjCRuntime &getObjCRuntime() {
511     if (!ObjCRuntime) createObjCRuntime();
512     return *ObjCRuntime;
513   }
514 
515   /// Return true iff an Objective-C runtime has been configured.
516   bool hasObjCRuntime() { return !!ObjCRuntime; }
517 
518   /// Return a reference to the configured OpenCL runtime.
519   CGOpenCLRuntime &getOpenCLRuntime() {
520     assert(OpenCLRuntime != nullptr);
521     return *OpenCLRuntime;
522   }
523 
524   /// Return a reference to the configured OpenMP runtime.
525   CGOpenMPRuntime &getOpenMPRuntime() {
526     assert(OpenMPRuntime != nullptr);
527     return *OpenMPRuntime;
528   }
529 
530   /// Return a reference to the configured CUDA runtime.
531   CGCUDARuntime &getCUDARuntime() {
532     assert(CUDARuntime != nullptr);
533     return *CUDARuntime;
534   }
535 
536   ObjCEntrypoints &getObjCEntrypoints() const {
537     assert(ObjCData != nullptr);
538     return *ObjCData;
539   }
540 
541   InstrProfStats &getPGOStats() { return PGOStats; }
542   llvm::IndexedInstrProfReader *getPGOReader() const { return PGOReader.get(); }
543 
544   CoverageMappingModuleGen *getCoverageMapping() const {
545     return CoverageMapping.get();
546   }
547 
548   llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
549     return StaticLocalDeclMap[D];
550   }
551   void setStaticLocalDeclAddress(const VarDecl *D,
552                                  llvm::Constant *C) {
553     StaticLocalDeclMap[D] = C;
554   }
555 
556   llvm::Constant *
557   getOrCreateStaticVarDecl(const VarDecl &D,
558                            llvm::GlobalValue::LinkageTypes Linkage);
559 
560   llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
561     return StaticLocalDeclGuardMap[D];
562   }
563   void setStaticLocalDeclGuardAddress(const VarDecl *D,
564                                       llvm::GlobalVariable *C) {
565     StaticLocalDeclGuardMap[D] = C;
566   }
567 
568   bool lookupRepresentativeDecl(StringRef MangledName,
569                                 GlobalDecl &Result) const;
570 
571   llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
572     return AtomicSetterHelperFnMap[Ty];
573   }
574   void setAtomicSetterHelperFnMap(QualType Ty,
575                             llvm::Constant *Fn) {
576     AtomicSetterHelperFnMap[Ty] = Fn;
577   }
578 
579   llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
580     return AtomicGetterHelperFnMap[Ty];
581   }
582   void setAtomicGetterHelperFnMap(QualType Ty,
583                             llvm::Constant *Fn) {
584     AtomicGetterHelperFnMap[Ty] = Fn;
585   }
586 
587   llvm::Constant *getTypeDescriptorFromMap(QualType Ty) {
588     return TypeDescriptorMap[Ty];
589   }
590   void setTypeDescriptorInMap(QualType Ty, llvm::Constant *C) {
591     TypeDescriptorMap[Ty] = C;
592   }
593 
594   CGDebugInfo *getModuleDebugInfo() { return DebugInfo.get(); }
595 
596   llvm::MDNode *getNoObjCARCExceptionsMetadata() {
597     if (!NoObjCARCExceptionsMetadata)
598       NoObjCARCExceptionsMetadata = llvm::MDNode::get(getLLVMContext(), None);
599     return NoObjCARCExceptionsMetadata;
600   }
601 
602   ASTContext &getContext() const { return Context; }
603   const LangOptions &getLangOpts() const { return LangOpts; }
604   const HeaderSearchOptions &getHeaderSearchOpts()
605     const { return HeaderSearchOpts; }
606   const PreprocessorOptions &getPreprocessorOpts()
607     const { return PreprocessorOpts; }
608   const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
609   llvm::Module &getModule() const { return TheModule; }
610   DiagnosticsEngine &getDiags() const { return Diags; }
611   const llvm::DataLayout &getDataLayout() const {
612     return TheModule.getDataLayout();
613   }
614   const TargetInfo &getTarget() const { return Target; }
615   const llvm::Triple &getTriple() const { return Target.getTriple(); }
616   bool supportsCOMDAT() const;
617   void maybeSetTrivialComdat(const Decl &D, llvm::GlobalObject &GO);
618 
619   CGCXXABI &getCXXABI() const { return *ABI; }
620   llvm::LLVMContext &getLLVMContext() { return VMContext; }
621 
622   bool shouldUseTBAA() const { return TBAA != nullptr; }
623 
624   const TargetCodeGenInfo &getTargetCodeGenInfo();
625 
626   CodeGenTypes &getTypes() { return Types; }
627 
628   CodeGenVTables &getVTables() { return VTables; }
629 
630   ItaniumVTableContext &getItaniumVTableContext() {
631     return VTables.getItaniumVTableContext();
632   }
633 
634   MicrosoftVTableContext &getMicrosoftVTableContext() {
635     return VTables.getMicrosoftVTableContext();
636   }
637 
638   CtorList &getGlobalCtors() { return GlobalCtors; }
639   CtorList &getGlobalDtors() { return GlobalDtors; }
640 
641   llvm::MDNode *getTBAAInfo(QualType QTy);
642   llvm::MDNode *getTBAAInfoForVTablePtr();
643   llvm::MDNode *getTBAAStructInfo(QualType QTy);
644   /// Return the path-aware tag for given base type, access node and offset.
645   llvm::MDNode *getTBAAStructTagInfo(QualType BaseTy, llvm::MDNode *AccessN,
646                                      uint64_t O);
647 
648   bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
649 
650   bool isPaddedAtomicType(QualType type);
651   bool isPaddedAtomicType(const AtomicType *type);
652 
653   /// Decorate the instruction with a TBAA tag. For scalar TBAA, the tag
654   /// is the same as the type. For struct-path aware TBAA, the tag
655   /// is different from the type: base type, access type and offset.
656   /// When ConvertTypeToTag is true, we create a tag based on the scalar type.
657   void DecorateInstructionWithTBAA(llvm::Instruction *Inst,
658                                    llvm::MDNode *TBAAInfo,
659                                    bool ConvertTypeToTag = true);
660 
661   /// Adds !invariant.barrier !tag to instruction
662   void DecorateInstructionWithInvariantGroup(llvm::Instruction *I,
663                                              const CXXRecordDecl *RD);
664 
665   /// Emit the given number of characters as a value of type size_t.
666   llvm::ConstantInt *getSize(CharUnits numChars);
667 
668   /// Set the visibility for the given LLVM GlobalValue.
669   void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
670 
671   /// Set the TLS mode for the given LLVM GlobalValue for the thread-local
672   /// variable declaration D.
673   void setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const;
674 
675   static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
676     switch (V) {
677     case DefaultVisibility:   return llvm::GlobalValue::DefaultVisibility;
678     case HiddenVisibility:    return llvm::GlobalValue::HiddenVisibility;
679     case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
680     }
681     llvm_unreachable("unknown visibility!");
682   }
683 
684   llvm::Constant *GetAddrOfGlobal(GlobalDecl GD,
685                                   ForDefinition_t IsForDefinition
686                                     = NotForDefinition);
687 
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);
695 
696   llvm::Function *
697   CreateGlobalInitOrDestructFunction(llvm::FunctionType *ty, const Twine &name,
698                                      const CGFunctionInfo &FI,
699                                      SourceLocation Loc = SourceLocation(),
700                                      bool TLS = false);
701 
702   /// Return the address space of the underlying global variable for D, as
703   /// determined by its declaration. Normally this is the same as the address
704   /// space of D's type, but in CUDA, address spaces are associated with
705   /// declarations, not types.
706   unsigned GetGlobalVarAddressSpace(const VarDecl *D, unsigned AddrSpace);
707 
708   /// Return the llvm::Constant for the address of the given global variable.
709   /// If Ty is non-null and if the global doesn't exist, then it will be created
710   /// with the specified type instead of whatever the normal requested type
711   /// would be. If IsForDefinition is true, it is guranteed that an actual
712   /// global with type Ty will be returned, not conversion of a variable with
713   /// the same mangled name but some other type.
714   llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
715                                      llvm::Type *Ty = nullptr,
716                                      ForDefinition_t IsForDefinition
717                                        = NotForDefinition);
718 
719   /// Return the address of the given function. If Ty is non-null, then this
720   /// function will use the specified type if it has to create it.
721   llvm::Constant *GetAddrOfFunction(GlobalDecl GD, llvm::Type *Ty = nullptr,
722                                     bool ForVTable = false,
723                                     bool DontDefer = false,
724                                     ForDefinition_t IsForDefinition
725                                       = NotForDefinition);
726 
727   /// Get the address of the RTTI descriptor for the given type.
728   llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
729 
730   /// Get the address of a uuid descriptor .
731   ConstantAddress GetAddrOfUuidDescriptor(const CXXUuidofExpr* E);
732 
733   /// Get the address of the thunk for the given global decl.
734   llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk);
735 
736   /// Get a reference to the target of VD.
737   ConstantAddress GetWeakRefReference(const ValueDecl *VD);
738 
739   /// Returns the assumed alignment of an opaque pointer to the given class.
740   CharUnits getClassPointerAlignment(const CXXRecordDecl *CD);
741 
742   /// Returns the assumed alignment of a virtual base of a class.
743   CharUnits getVBaseAlignment(CharUnits DerivedAlign,
744                               const CXXRecordDecl *Derived,
745                               const CXXRecordDecl *VBase);
746 
747   /// Given a class pointer with an actual known alignment, and the
748   /// expected alignment of an object at a dynamic offset w.r.t that
749   /// pointer, return the alignment to assume at the offset.
750   CharUnits getDynamicOffsetAlignment(CharUnits ActualAlign,
751                                       const CXXRecordDecl *Class,
752                                       CharUnits ExpectedTargetAlign);
753 
754   CharUnits
755   computeNonVirtualBaseClassOffset(const CXXRecordDecl *DerivedClass,
756                                    CastExpr::path_const_iterator Start,
757                                    CastExpr::path_const_iterator End);
758 
759   /// Returns the offset from a derived class to  a class. Returns null if the
760   /// offset is 0.
761   llvm::Constant *
762   GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
763                                CastExpr::path_const_iterator PathBegin,
764                                CastExpr::path_const_iterator PathEnd);
765 
766   llvm::FoldingSet<BlockByrefHelpers> ByrefHelpersCache;
767 
768   /// Fetches the global unique block count.
769   int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
770 
771   /// Fetches the type of a generic block descriptor.
772   llvm::Type *getBlockDescriptorType();
773 
774   /// The type of a generic block literal.
775   llvm::Type *getGenericBlockLiteralType();
776 
777   /// Gets the address of a block which requires no captures.
778   llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, StringRef Name);
779 
780   /// Return a pointer to a constant CFString object for the given string.
781   ConstantAddress GetAddrOfConstantCFString(const StringLiteral *Literal);
782 
783   /// Return a pointer to a constant NSString object for the given string. Or a
784   /// user defined String object as defined via
785   /// -fconstant-string-class=class_name option.
786   ConstantAddress GetAddrOfConstantString(const StringLiteral *Literal);
787 
788   /// Return a constant array for the given string.
789   llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
790 
791   /// Return a pointer to a constant array for the given string literal.
792   ConstantAddress
793   GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
794                                      StringRef Name = ".str");
795 
796   /// Return a pointer to a constant array for the given ObjCEncodeExpr node.
797   ConstantAddress
798   GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
799 
800   /// Returns a pointer to a character array containing the literal and a
801   /// terminating '\0' character. The result has pointer to array type.
802   ///
803   /// \param GlobalName If provided, the name to use for the global (if one is
804   /// created).
805   ConstantAddress
806   GetAddrOfConstantCString(const std::string &Str,
807                            const char *GlobalName = nullptr);
808 
809   /// Returns a pointer to a constant global variable for the given file-scope
810   /// compound literal expression.
811   ConstantAddress GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
812 
813   /// \brief Returns a pointer to a global variable representing a temporary
814   /// with static or thread storage duration.
815   ConstantAddress GetAddrOfGlobalTemporary(const MaterializeTemporaryExpr *E,
816                                            const Expr *Inner);
817 
818   /// \brief Retrieve the record type that describes the state of an
819   /// Objective-C fast enumeration loop (for..in).
820   QualType getObjCFastEnumerationStateType();
821 
822   // Produce code for this constructor/destructor. This method doesn't try
823   // to apply any ABI rules about which other constructors/destructors
824   // are needed or if they are alias to each other.
825   llvm::Function *codegenCXXStructor(const CXXMethodDecl *MD,
826                                      StructorType Type);
827 
828   /// Return the address of the constructor/destructor of the given type.
829   llvm::Constant *
830   getAddrOfCXXStructor(const CXXMethodDecl *MD, StructorType Type,
831                        const CGFunctionInfo *FnInfo = nullptr,
832                        llvm::FunctionType *FnType = nullptr,
833                        bool DontDefer = false,
834                        ForDefinition_t IsForDefinition = NotForDefinition);
835 
836   /// Given a builtin id for a function like "__builtin_fabsf", return a
837   /// Function* for "fabsf".
838   llvm::Constant *getBuiltinLibFunction(const FunctionDecl *FD,
839                                         unsigned BuiltinID);
840 
841   llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = None);
842 
843   /// Emit code for a single top level declaration.
844   void EmitTopLevelDecl(Decl *D);
845 
846   /// \brief Stored a deferred empty coverage mapping for an unused
847   /// and thus uninstrumented top level declaration.
848   void AddDeferredUnusedCoverageMapping(Decl *D);
849 
850   /// \brief Remove the deferred empty coverage mapping as this
851   /// declaration is actually instrumented.
852   void ClearUnusedCoverageMapping(const Decl *D);
853 
854   /// \brief Emit all the deferred coverage mappings
855   /// for the uninstrumented functions.
856   void EmitDeferredUnusedCoverageMappings();
857 
858   /// Tell the consumer that this variable has been instantiated.
859   void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
860 
861   /// \brief If the declaration has internal linkage but is inside an
862   /// extern "C" linkage specification, prepare to emit an alias for it
863   /// to the expected name.
864   template<typename SomeDecl>
865   void MaybeHandleStaticInExternC(const SomeDecl *D, llvm::GlobalValue *GV);
866 
867   /// Add a global to a list to be added to the llvm.used metadata.
868   void addUsedGlobal(llvm::GlobalValue *GV);
869 
870   /// Add a global to a list to be added to the llvm.compiler.used metadata.
871   void addCompilerUsedGlobal(llvm::GlobalValue *GV);
872 
873   /// Add a destructor and object to add to the C++ global destructor function.
874   void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) {
875     CXXGlobalDtors.emplace_back(DtorFn, Object);
876   }
877 
878   /// Create a new runtime function with the specified type and name.
879   llvm::Constant *
880   CreateRuntimeFunction(llvm::FunctionType *Ty, StringRef Name,
881                         llvm::AttributeSet ExtraAttrs = llvm::AttributeSet(),
882                         bool Local = false);
883 
884   /// Create a new compiler builtin function with the specified type and name.
885   llvm::Constant *CreateBuiltinFunction(llvm::FunctionType *Ty,
886                                         StringRef Name,
887                                         llvm::AttributeSet ExtraAttrs =
888                                           llvm::AttributeSet());
889   /// Create a new runtime global variable with the specified type and name.
890   llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
891                                         StringRef Name);
892 
893   ///@name Custom Blocks Runtime Interfaces
894   ///@{
895 
896   llvm::Constant *getNSConcreteGlobalBlock();
897   llvm::Constant *getNSConcreteStackBlock();
898   llvm::Constant *getBlockObjectAssign();
899   llvm::Constant *getBlockObjectDispose();
900 
901   ///@}
902 
903   llvm::Constant *getLLVMLifetimeStartFn();
904   llvm::Constant *getLLVMLifetimeEndFn();
905 
906   // Make sure that this type is translated.
907   void UpdateCompletedType(const TagDecl *TD);
908 
909   llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
910 
911   /// Try to emit the initializer for the given declaration as a constant;
912   /// returns 0 if the expression cannot be emitted as a constant.
913   llvm::Constant *EmitConstantInit(const VarDecl &D,
914                                    CodeGenFunction *CGF = nullptr);
915 
916   /// Try to emit the given expression as a constant; returns 0 if the
917   /// expression cannot be emitted as a constant.
918   llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType,
919                                    CodeGenFunction *CGF = nullptr);
920 
921   /// Emit the given constant value as a constant, in the type's scalar
922   /// representation.
923   llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType,
924                                     CodeGenFunction *CGF = nullptr);
925 
926   /// Emit the given constant value as a constant, in the type's memory
927   /// representation.
928   llvm::Constant *EmitConstantValueForMemory(const APValue &Value,
929                                              QualType DestType,
930                                              CodeGenFunction *CGF = nullptr);
931 
932   /// \brief Emit type info if type of an expression is a variably modified
933   /// type. Also emit proper debug info for cast types.
934   void EmitExplicitCastExprType(const ExplicitCastExpr *E,
935                                 CodeGenFunction *CGF = nullptr);
936 
937   /// Return the result of value-initializing the given type, i.e. a null
938   /// expression of the given type.  This is usually, but not always, an LLVM
939   /// null constant.
940   llvm::Constant *EmitNullConstant(QualType T);
941 
942   /// Return a null constant appropriate for zero-initializing a base class with
943   /// the given type. This is usually, but not always, an LLVM null constant.
944   llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
945 
946   /// Emit a general error that something can't be done.
947   void Error(SourceLocation loc, StringRef error);
948 
949   /// Print out an error that codegen doesn't support the specified stmt yet.
950   void ErrorUnsupported(const Stmt *S, const char *Type);
951 
952   /// Print out an error that codegen doesn't support the specified decl yet.
953   void ErrorUnsupported(const Decl *D, const char *Type);
954 
955   /// Set the attributes on the LLVM function for the given decl and function
956   /// info. This applies attributes necessary for handling the ABI as well as
957   /// user specified attributes like section.
958   void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F,
959                                      const CGFunctionInfo &FI);
960 
961   /// Set the LLVM function attributes (sext, zext, etc).
962   void SetLLVMFunctionAttributes(const Decl *D,
963                                  const CGFunctionInfo &Info,
964                                  llvm::Function *F);
965 
966   /// Set the LLVM function attributes which only apply to a function
967   /// definition.
968   void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
969 
970   /// Return true iff the given type uses 'sret' when used as a return type.
971   bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
972 
973   /// Return true iff the given type uses an argument slot when 'sret' is used
974   /// as a return type.
975   bool ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI);
976 
977   /// Return true iff the given type uses 'fpret' when used as a return type.
978   bool ReturnTypeUsesFPRet(QualType ResultType);
979 
980   /// Return true iff the given type uses 'fp2ret' when used as a return type.
981   bool ReturnTypeUsesFP2Ret(QualType ResultType);
982 
983   /// Get the LLVM attributes and calling convention to use for a particular
984   /// function type.
985   ///
986   /// \param Name - The function name.
987   /// \param Info - The function type information.
988   /// \param CalleeInfo - The callee information these attributes are being
989   /// constructed for. If valid, the attributes applied to this decl may
990   /// contribute to the function attributes and calling convention.
991   /// \param PAL [out] - On return, the attribute list to use.
992   /// \param CallingConv [out] - On return, the LLVM calling convention to use.
993   void ConstructAttributeList(StringRef Name, const CGFunctionInfo &Info,
994                               CGCalleeInfo CalleeInfo, AttributeListType &PAL,
995                               unsigned &CallingConv, bool AttrOnCallSite);
996 
997   // Fills in the supplied string map with the set of target features for the
998   // passed in function.
999   void getFunctionFeatureMap(llvm::StringMap<bool> &FeatureMap,
1000                              const FunctionDecl *FD);
1001 
1002   StringRef getMangledName(GlobalDecl GD);
1003   StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD);
1004 
1005   void EmitTentativeDefinition(const VarDecl *D);
1006 
1007   void EmitVTable(CXXRecordDecl *Class);
1008 
1009   void RefreshTypeCacheForClass(const CXXRecordDecl *Class);
1010 
1011   /// \brief Appends Opts to the "Linker Options" metadata value.
1012   void AppendLinkerOptions(StringRef Opts);
1013 
1014   /// \brief Appends a detect mismatch command to the linker options.
1015   void AddDetectMismatch(StringRef Name, StringRef Value);
1016 
1017   /// \brief Appends a dependent lib to the "Linker Options" metadata value.
1018   void AddDependentLib(StringRef Lib);
1019 
1020   llvm::GlobalVariable::LinkageTypes getFunctionLinkage(GlobalDecl GD);
1021 
1022   void setFunctionLinkage(GlobalDecl GD, llvm::Function *F) {
1023     F->setLinkage(getFunctionLinkage(GD));
1024   }
1025 
1026   /// Set the DLL storage class on F.
1027   void setFunctionDLLStorageClass(GlobalDecl GD, llvm::Function *F);
1028 
1029   /// Return the appropriate linkage for the vtable, VTT, and type information
1030   /// of the given class.
1031   llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
1032 
1033   /// Return the store size, in character units, of the given LLVM type.
1034   CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
1035 
1036   /// Returns LLVM linkage for a declarator.
1037   llvm::GlobalValue::LinkageTypes
1038   getLLVMLinkageForDeclarator(const DeclaratorDecl *D, GVALinkage Linkage,
1039                               bool IsConstantVariable);
1040 
1041   /// Returns LLVM linkage for a declarator.
1042   llvm::GlobalValue::LinkageTypes
1043   getLLVMLinkageVarDefinition(const VarDecl *VD, bool IsConstant);
1044 
1045   /// Emit all the global annotations.
1046   void EmitGlobalAnnotations();
1047 
1048   /// Emit an annotation string.
1049   llvm::Constant *EmitAnnotationString(StringRef Str);
1050 
1051   /// Emit the annotation's translation unit.
1052   llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
1053 
1054   /// Emit the annotation line number.
1055   llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
1056 
1057   /// Generate the llvm::ConstantStruct which contains the annotation
1058   /// information for a given GlobalValue. The annotation struct is
1059   /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
1060   /// GlobalValue being annotated. The second field is the constant string
1061   /// created from the AnnotateAttr's annotation. The third field is a constant
1062   /// string containing the name of the translation unit. The fourth field is
1063   /// the line number in the file of the annotated value declaration.
1064   llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
1065                                    const AnnotateAttr *AA,
1066                                    SourceLocation L);
1067 
1068   /// Add global annotations that are set on D, for the global GV. Those
1069   /// annotations are emitted during finalization of the LLVM code.
1070   void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
1071 
1072   bool isInSanitizerBlacklist(llvm::Function *Fn, SourceLocation Loc) const;
1073 
1074   bool isInSanitizerBlacklist(llvm::GlobalVariable *GV, SourceLocation Loc,
1075                               QualType Ty,
1076                               StringRef Category = StringRef()) const;
1077 
1078   SanitizerMetadata *getSanitizerMetadata() {
1079     return SanitizerMD.get();
1080   }
1081 
1082   void addDeferredVTable(const CXXRecordDecl *RD) {
1083     DeferredVTables.push_back(RD);
1084   }
1085 
1086   /// Emit code for a singal global function or var decl. Forward declarations
1087   /// are emitted lazily.
1088   void EmitGlobal(GlobalDecl D);
1089 
1090   bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target,
1091                                 bool InEveryTU);
1092   bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
1093 
1094   /// Set attributes for a global definition.
1095   void setFunctionDefinitionAttributes(const FunctionDecl *D,
1096                                        llvm::Function *F);
1097 
1098   llvm::GlobalValue *GetGlobalValue(StringRef Ref);
1099 
1100   /// Set attributes which are common to any form of a global definition (alias,
1101   /// Objective-C method, function, global variable).
1102   ///
1103   /// NOTE: This should only be called for definitions.
1104   void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV);
1105 
1106   /// Set attributes which must be preserved by an alias. This includes common
1107   /// attributes (i.e. it includes a call to SetCommonAttributes).
1108   ///
1109   /// NOTE: This should only be called for definitions.
1110   void setAliasAttributes(const Decl *D, llvm::GlobalValue *GV);
1111 
1112   void addReplacement(StringRef Name, llvm::Constant *C);
1113 
1114   void addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C);
1115 
1116   /// \brief Emit a code for threadprivate directive.
1117   /// \param D Threadprivate declaration.
1118   void EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D);
1119 
1120   /// \brief Emit a code for declare reduction construct.
1121   void EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
1122                                CodeGenFunction *CGF = nullptr);
1123 
1124   /// Returns whether the given record has hidden LTO visibility and therefore
1125   /// may participate in (single-module) CFI and whole-program vtable
1126   /// optimization.
1127   bool HasHiddenLTOVisibility(const CXXRecordDecl *RD);
1128 
1129   /// Emit type metadata for the given vtable using the given layout.
1130   void EmitVTableTypeMetadata(llvm::GlobalVariable *VTable,
1131                               const VTableLayout &VTLayout);
1132 
1133   /// Generate a cross-DSO type identifier for MD.
1134   llvm::ConstantInt *CreateCrossDsoCfiTypeId(llvm::Metadata *MD);
1135 
1136   /// Create a metadata identifier for the given type. This may either be an
1137   /// MDString (for external identifiers) or a distinct unnamed MDNode (for
1138   /// internal identifiers).
1139   llvm::Metadata *CreateMetadataIdentifierForType(QualType T);
1140 
1141   /// Create and attach type metadata to the given function.
1142   void CreateFunctionTypeMetadata(const FunctionDecl *FD, llvm::Function *F);
1143 
1144   /// Returns whether this module needs the "all-vtables" type identifier.
1145   bool NeedAllVtablesTypeId() const;
1146 
1147   /// Create and attach type metadata for the given vtable.
1148   void AddVTableTypeMetadata(llvm::GlobalVariable *VTable, CharUnits Offset,
1149                              const CXXRecordDecl *RD);
1150 
1151   /// \breif Get the declaration of std::terminate for the platform.
1152   llvm::Constant *getTerminateFn();
1153 
1154   llvm::SanitizerStatReport &getSanStats();
1155 
1156   llvm::Value *
1157   createOpenCLIntToSamplerConversion(const Expr *E, CodeGenFunction &CGF);
1158 
1159   /// Get target specific null pointer.
1160   /// \param T is the LLVM type of the null pointer.
1161   /// \param QT is the clang QualType of the null pointer.
1162   llvm::Constant *getNullPointer(llvm::PointerType *T, QualType QT);
1163 
1164 private:
1165   llvm::Constant *
1166   GetOrCreateLLVMFunction(StringRef MangledName, llvm::Type *Ty, GlobalDecl D,
1167                           bool ForVTable, bool DontDefer = false,
1168                           bool IsThunk = false,
1169                           llvm::AttributeSet ExtraAttrs = llvm::AttributeSet(),
1170                           ForDefinition_t IsForDefinition = NotForDefinition);
1171 
1172   llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName,
1173                                         llvm::PointerType *PTy,
1174                                         const VarDecl *D,
1175                                         ForDefinition_t IsForDefinition
1176                                           = NotForDefinition);
1177 
1178   void setNonAliasAttributes(const Decl *D, llvm::GlobalObject *GO);
1179 
1180   /// Set function attributes for a function declaration.
1181   void SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
1182                              bool IsIncompleteFunction, bool IsThunk);
1183 
1184   void EmitGlobalDefinition(GlobalDecl D, llvm::GlobalValue *GV = nullptr);
1185 
1186   void EmitGlobalFunctionDefinition(GlobalDecl GD, llvm::GlobalValue *GV);
1187   void EmitGlobalVarDefinition(const VarDecl *D, bool IsTentative = false);
1188   void EmitAliasDefinition(GlobalDecl GD);
1189   void emitIFuncDefinition(GlobalDecl GD);
1190   void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
1191   void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
1192 
1193   // C++ related functions.
1194 
1195   void EmitDeclContext(const DeclContext *DC);
1196   void EmitLinkageSpec(const LinkageSpecDecl *D);
1197   void CompleteDIClassType(const CXXMethodDecl* D);
1198 
1199   /// \brief Emit the function that initializes C++ thread_local variables.
1200   void EmitCXXThreadLocalInitFunc();
1201 
1202   /// Emit the function that initializes C++ globals.
1203   void EmitCXXGlobalInitFunc();
1204 
1205   /// Emit the function that destroys C++ globals.
1206   void EmitCXXGlobalDtorFunc();
1207 
1208   /// Emit the function that initializes the specified global (if PerformInit is
1209   /// true) and registers its destructor.
1210   void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
1211                                     llvm::GlobalVariable *Addr,
1212                                     bool PerformInit);
1213 
1214   void EmitPointerToInitFunc(const VarDecl *VD, llvm::GlobalVariable *Addr,
1215                              llvm::Function *InitFunc, InitSegAttr *ISA);
1216 
1217   // FIXME: Hardcoding priority here is gross.
1218   void AddGlobalCtor(llvm::Function *Ctor, int Priority = 65535,
1219                      llvm::Constant *AssociatedData = nullptr);
1220   void AddGlobalDtor(llvm::Function *Dtor, int Priority = 65535);
1221 
1222   /// EmitCtorList - Generates a global array of functions and priorities using
1223   /// the given list and name. This array will have appending linkage and is
1224   /// suitable for use as a LLVM constructor or destructor array. Clears Fns.
1225   void EmitCtorList(CtorList &Fns, const char *GlobalName);
1226 
1227   /// Emit any needed decls for which code generation was deferred.
1228   void EmitDeferred();
1229 
1230   /// Call replaceAllUsesWith on all pairs in Replacements.
1231   void applyReplacements();
1232 
1233   /// Call replaceAllUsesWith on all pairs in GlobalValReplacements.
1234   void applyGlobalValReplacements();
1235 
1236   void checkAliases();
1237 
1238   /// Emit any vtables which we deferred and still have a use for.
1239   void EmitDeferredVTables();
1240 
1241   /// Emit the llvm.used and llvm.compiler.used metadata.
1242   void emitLLVMUsed();
1243 
1244   /// \brief Emit the link options introduced by imported modules.
1245   void EmitModuleLinkOptions();
1246 
1247   /// \brief Emit aliases for internal-linkage declarations inside "C" language
1248   /// linkage specifications, giving them the "expected" name where possible.
1249   void EmitStaticExternCAliases();
1250 
1251   void EmitDeclMetadata();
1252 
1253   /// \brief Emit the Clang version as llvm.ident metadata.
1254   void EmitVersionIdentMetadata();
1255 
1256   /// Emits target specific Metadata for global declarations.
1257   void EmitTargetMetadata();
1258 
1259   /// Emit the llvm.gcov metadata used to tell LLVM where to emit the .gcno and
1260   /// .gcda files in a way that persists in .bc files.
1261   void EmitCoverageFile();
1262 
1263   /// Emits the initializer for a uuidof string.
1264   llvm::Constant *EmitUuidofInitializer(StringRef uuidstr);
1265 
1266   /// Determine whether the definition must be emitted; if this returns \c
1267   /// false, the definition can be emitted lazily if it's used.
1268   bool MustBeEmitted(const ValueDecl *D);
1269 
1270   /// Determine whether the definition can be emitted eagerly, or should be
1271   /// delayed until the end of the translation unit. This is relevant for
1272   /// definitions whose linkage can change, e.g. implicit function instantions
1273   /// which may later be explicitly instantiated.
1274   bool MayBeEmittedEagerly(const ValueDecl *D);
1275 
1276   /// Check whether we can use a "simpler", more core exceptions personality
1277   /// function.
1278   void SimplifyPersonality();
1279 };
1280 }  // end namespace CodeGen
1281 }  // end namespace clang
1282 
1283 #endif // LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
1284