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