blob: 74087be3f6a1b75e6a43c2625b11d14a8033bd20 [file] [log] [blame]
Daniel Dunbar9c426522008-07-29 23:18:29 +00001//===--- CodeGenModule.h - Per-Module state for LLVM CodeGen ----*- C++ -*-===//
Chris Lattnerf97fe382007-05-24 06:29:05 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerf97fe382007-05-24 06:29:05 +00007//
8//===----------------------------------------------------------------------===//
9//
Mike Stump1676c5b2009-02-13 19:12:34 +000010// This is the internal per-translation-unit state used for llvm translation.
Chris Lattnerf97fe382007-05-24 06:29:05 +000011//
12//===----------------------------------------------------------------------===//
13
Benjamin Kramer2f5db8b2014-08-13 16:25:19 +000014#ifndef LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
15#define LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H
Chris Lattnerf97fe382007-05-24 06:29:05 +000016
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGVTables.h"
John McCall7f416cc2015-09-08 08:05:57 +000018#include "CodeGenTypeCache.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000019#include "CodeGenTypes.h"
Alexey Samsonov4b8de112014-08-01 21:35:28 +000020#include "SanitizerMetadata.h"
Dan Gohman75d69da2008-05-22 00:50:06 +000021#include "clang/AST/Attr.h"
Anders Carlssondae1abc2009-05-05 04:44:02 +000022#include "clang/AST/DeclCXX.h"
Anders Carlsson73fcc952009-09-11 00:07:24 +000023#include "clang/AST/DeclObjC.h"
Peter Collingbourneee781d52011-06-14 04:02:39 +000024#include "clang/AST/GlobalDecl.h"
Peter Collingbourne0ff0b372011-01-13 18:57:25 +000025#include "clang/AST/Mangle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#include "clang/Basic/ABI.h"
27#include "clang/Basic/LangOptions.h"
Douglas Gregor6ddfca92013-01-14 17:21:00 +000028#include "clang/Basic/Module.h"
Alexey Samsonov8d043e82014-10-15 19:57:45 +000029#include "clang/Basic/SanitizerBlacklist.h"
Chris Lattnerb6984c42007-06-20 04:44:43 +000030#include "llvm/ADT/DenseMap.h"
Douglas Gregor6ddfca92013-01-14 17:21:00 +000031#include "llvm/ADT/SetVector.h"
Rafael Espindola2e42fec2010-03-04 18:17:24 +000032#include "llvm/ADT/SmallPtrSet.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000033#include "llvm/ADT/StringMap.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000034#include "llvm/IR/Module.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000035#include "llvm/IR/ValueHandle.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000036#include "llvm/Transforms/Utils/SanitizerStats.h"
Anders Carlsson762e1622009-01-04 02:08:04 +000037
Chris Lattnerf97fe382007-05-24 06:29:05 +000038namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000039class Module;
40class Constant;
41class ConstantInt;
42class Function;
43class GlobalValue;
44class DataLayout;
45class FunctionType;
46class LLVMContext;
47class IndexedInstrProfReader;
Alexander Kornienkoab9db512015-06-22 23:07:51 +000048}
Chris Lattner23b7eb62007-06-15 23:05:46 +000049
Chris Lattnerf97fe382007-05-24 06:29:05 +000050namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000051class TargetCodeGenInfo;
52class ASTContext;
53class AtomicType;
54class FunctionDecl;
55class IdentifierInfo;
56class ObjCMethodDecl;
57class ObjCImplementationDecl;
58class ObjCCategoryImplDecl;
59class ObjCProtocolDecl;
60class ObjCEncodeExpr;
61class BlockExpr;
62class CharUnits;
63class Decl;
64class Expr;
65class Stmt;
66class InitListExpr;
67class StringLiteral;
68class NamedDecl;
69class ValueDecl;
70class VarDecl;
71class LangOptions;
72class CodeGenOptions;
Adrian Prantle74f5252015-06-30 02:26:03 +000073class HeaderSearchOptions;
74class PreprocessorOptions;
Rafael Espindola42ae7452014-05-09 00:57:59 +000075class DiagnosticsEngine;
76class AnnotateAttr;
77class CXXDestructorDecl;
Rafael Espindola42ae7452014-05-09 00:57:59 +000078class Module;
Alex Lorenzee024992014-08-04 18:41:51 +000079class CoverageSourceInfo;
Mike Stump1676c5b2009-02-13 19:12:34 +000080
Chris Lattnerf97fe382007-05-24 06:29:05 +000081namespace CodeGen {
82
Rafael Espindola42ae7452014-05-09 00:57:59 +000083class CallArgList;
84class CodeGenFunction;
85class CodeGenTBAA;
86class CGCXXABI;
87class CGDebugInfo;
88class CGObjCRuntime;
89class CGOpenCLRuntime;
90class CGOpenMPRuntime;
91class CGCUDARuntime;
92class BlockFieldFlags;
93class FunctionArgList;
Alex Lorenzee024992014-08-04 18:41:51 +000094class CoverageMappingModuleGen;
Justin Bogneref512b92014-01-06 22:27:43 +000095
Rafael Espindola42ae7452014-05-09 00:57:59 +000096struct OrderGlobalInits {
97 unsigned int priority;
98 unsigned int lex_order;
99 OrderGlobalInits(unsigned int p, unsigned int l)
Chris Lattnere0009072010-06-27 06:32:58 +0000100 : priority(p), lex_order(l) {}
Rafael Espindola42ae7452014-05-09 00:57:59 +0000101
102 bool operator==(const OrderGlobalInits &RHS) const {
103 return priority == RHS.priority && lex_order == RHS.lex_order;
104 }
105
106 bool operator<(const OrderGlobalInits &RHS) const {
107 return std::tie(priority, lex_order) <
108 std::tie(RHS.priority, RHS.lex_order);
109 }
110};
111
John McCallb04ecb72015-10-21 18:06:43 +0000112struct ObjCEntrypoints {
113 ObjCEntrypoints() { memset(this, 0, sizeof(*this)); }
114
115 /// void objc_autoreleasePoolPop(void*);
John McCall31168b02011-06-15 23:02:42 +0000116 llvm::Constant *objc_autoreleasePoolPop;
117
118 /// void *objc_autoreleasePoolPush(void);
119 llvm::Constant *objc_autoreleasePoolPush;
John McCall31168b02011-06-15 23:02:42 +0000120
121 /// id objc_autorelease(id);
122 llvm::Constant *objc_autorelease;
123
124 /// id objc_autoreleaseReturnValue(id);
125 llvm::Constant *objc_autoreleaseReturnValue;
126
127 /// void objc_copyWeak(id *dest, id *src);
128 llvm::Constant *objc_copyWeak;
129
130 /// void objc_destroyWeak(id*);
131 llvm::Constant *objc_destroyWeak;
132
133 /// id objc_initWeak(id*, id);
134 llvm::Constant *objc_initWeak;
135
136 /// id objc_loadWeak(id*);
137 llvm::Constant *objc_loadWeak;
138
139 /// id objc_loadWeakRetained(id*);
140 llvm::Constant *objc_loadWeakRetained;
141
142 /// void objc_moveWeak(id *dest, id *src);
143 llvm::Constant *objc_moveWeak;
144
145 /// id objc_retain(id);
146 llvm::Constant *objc_retain;
147
148 /// id objc_retainAutorelease(id);
149 llvm::Constant *objc_retainAutorelease;
150
151 /// id objc_retainAutoreleaseReturnValue(id);
152 llvm::Constant *objc_retainAutoreleaseReturnValue;
153
154 /// id objc_retainAutoreleasedReturnValue(id);
155 llvm::Constant *objc_retainAutoreleasedReturnValue;
156
157 /// id objc_retainBlock(id);
158 llvm::Constant *objc_retainBlock;
159
160 /// void objc_release(id);
161 llvm::Constant *objc_release;
162
163 /// id objc_storeStrong(id*, id);
164 llvm::Constant *objc_storeStrong;
165
166 /// id objc_storeWeak(id*, id);
167 llvm::Constant *objc_storeWeak;
168
169 /// A void(void) inline asm to use to mark that the return value of
170 /// a call will be immediately retain.
171 llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
John McCalleff18842013-03-23 02:35:54 +0000172
173 /// void clang.arc.use(...);
174 llvm::Constant *clang_arc_use;
John McCall31168b02011-06-15 23:02:42 +0000175};
Will Dietzf54319c2013-01-18 11:30:38 +0000176
Justin Bognere2ef2a02014-04-15 21:22:35 +0000177/// This class records statistics on instrumentation based profiling.
Justin Bogner40b8ba12014-06-26 01:45:07 +0000178class InstrProfStats {
179 uint32_t VisitedInMainFile;
180 uint32_t MissingInMainFile;
Justin Bognere2ef2a02014-04-15 21:22:35 +0000181 uint32_t Visited;
182 uint32_t Missing;
183 uint32_t Mismatched;
Justin Bogner40b8ba12014-06-26 01:45:07 +0000184
185public:
186 InstrProfStats()
187 : VisitedInMainFile(0), MissingInMainFile(0), Visited(0), Missing(0),
188 Mismatched(0) {}
189 /// Record that we've visited a function and whether or not that function was
190 /// in the main source file.
191 void addVisited(bool MainFile) {
192 if (MainFile)
193 ++VisitedInMainFile;
194 ++Visited;
195 }
196 /// Record that a function we've visited has no profile data.
197 void addMissing(bool MainFile) {
198 if (MainFile)
199 ++MissingInMainFile;
200 ++Missing;
201 }
202 /// Record that a function we've visited has mismatched profile data.
203 void addMismatched(bool MainFile) { ++Mismatched; }
204 /// Whether or not the stats we've gathered indicate any potential problems.
205 bool hasDiagnostics() { return Missing || Mismatched; }
206 /// Report potential problems we've found to \c Diags.
207 void reportDiagnostics(DiagnosticsEngine &Diags, StringRef MainFile);
Justin Bognere2ef2a02014-04-15 21:22:35 +0000208};
209
John McCallbd96e982015-09-08 08:21:11 +0000210/// A pair of helper functions for a __block variable.
211class BlockByrefHelpers : public llvm::FoldingSetNode {
212 // MSVC requires this type to be complete in order to process this
213 // header.
214public:
215 llvm::Constant *CopyHelper;
216 llvm::Constant *DisposeHelper;
217
218 /// The alignment of the field. This is important because
219 /// different offsets to the field within the byref struct need to
220 /// have different helper functions.
221 CharUnits Alignment;
222
223 BlockByrefHelpers(CharUnits alignment) : Alignment(alignment) {}
224 BlockByrefHelpers(const BlockByrefHelpers &) = default;
225 virtual ~BlockByrefHelpers();
226
227 void Profile(llvm::FoldingSetNodeID &id) const {
228 id.AddInteger(Alignment.getQuantity());
229 profileImpl(id);
230 }
231 virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
232
233 virtual bool needsCopy() const { return true; }
234 virtual void emitCopy(CodeGenFunction &CGF, Address dest, Address src) = 0;
235
236 virtual bool needsDispose() const { return true; }
237 virtual void emitDispose(CodeGenFunction &CGF, Address field) = 0;
238};
239
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000240/// This class organizes the cross-function state that is used while generating
241/// LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000242class CodeGenModule : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000243 CodeGenModule(const CodeGenModule &) = delete;
244 void operator=(const CodeGenModule &) = delete;
Anders Carlsson729a8202009-02-24 04:21:31 +0000245
Keno Fischer76f4ab02014-12-30 08:12:39 +0000246public:
Reid Kleckner563f0e82014-05-23 21:13:45 +0000247 struct Structor {
248 Structor() : Priority(0), Initializer(nullptr), AssociatedData(nullptr) {}
249 Structor(int Priority, llvm::Constant *Initializer,
250 llvm::Constant *AssociatedData)
251 : Priority(Priority), Initializer(Initializer),
252 AssociatedData(AssociatedData) {}
253 int Priority;
254 llvm::Constant *Initializer;
255 llvm::Constant *AssociatedData;
256 };
257
258 typedef std::vector<Structor> CtorList;
Daniel Dunbar74aa7e12008-08-01 00:01:51 +0000259
Keno Fischer76f4ab02014-12-30 08:12:39 +0000260private:
Chris Lattnerf97fe382007-05-24 06:29:05 +0000261 ASTContext &Context;
David Blaikiebbafb8a2012-03-11 07:00:24 +0000262 const LangOptions &LangOpts;
Adrian Prantle74f5252015-06-30 02:26:03 +0000263 const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info.
264 const PreprocessorOptions &PreprocessorOpts; // Only used for debug info.
Chandler Carruthbc55fe22009-11-12 17:24:48 +0000265 const CodeGenOptions &CodeGenOpts;
Chris Lattner23b7eb62007-06-15 23:05:46 +0000266 llvm::Module &TheModule;
David Blaikie9c902b52011-09-25 23:23:43 +0000267 DiagnosticsEngine &Diags;
John McCallc8e01702013-04-16 22:48:15 +0000268 const TargetInfo &Target;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000269 std::unique_ptr<CGCXXABI> ABI;
John McCallc8e01702013-04-16 22:48:15 +0000270 llvm::LLVMContext &VMContext;
Anders Carlssonff971e82009-10-07 01:06:45 +0000271
John McCallc8e01702013-04-16 22:48:15 +0000272 CodeGenTBAA *TBAA;
273
274 mutable const TargetCodeGenInfo *TheTargetCodeGenInfo;
275
276 // This should not be moved earlier, since its initialization depends on some
277 // of the previous reference members being already initialized and also checks
278 // if TheTargetCodeGenInfo is NULL
279 CodeGenTypes Types;
280
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000281 /// Holds information about C++ vtables.
Anders Carlssona864caf2010-03-23 04:11:45 +0000282 CodeGenVTables VTables;
Douglas Gregorbc6a4342010-04-08 16:07:47 +0000283
Peter Collingbournee1d20992011-07-27 20:29:46 +0000284 CGObjCRuntime* ObjCRuntime;
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000285 CGOpenCLRuntime* OpenCLRuntime;
Alexey Bataev9959db52014-05-06 10:08:46 +0000286 CGOpenMPRuntime* OpenMPRuntime;
Peter Collingbournefe883422011-10-06 18:29:37 +0000287 CGCUDARuntime* CUDARuntime;
Ted Kremenek2c674f62008-08-05 18:50:11 +0000288 CGDebugInfo* DebugInfo;
John McCallb04ecb72015-10-21 18:06:43 +0000289 ObjCEntrypoints *ObjCData;
Dan Gohman515a60d2012-02-16 00:57:37 +0000290 llvm::MDNode *NoObjCARCExceptionsMetadata;
Justin Bogner837a6f62014-04-18 21:52:00 +0000291 std::unique_ptr<llvm::IndexedInstrProfReader> PGOReader;
Justin Bognere2ef2a02014-04-15 21:22:35 +0000292 InstrProfStats PGOStats;
Peter Collingbournedc134532016-01-16 00:31:22 +0000293 std::unique_ptr<llvm::SanitizerStatReport> SanStats;
Daniel Dunbare49df9b52008-07-30 16:32:24 +0000294
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000295 // A set of references that have only been seen via a weakref so far. This is
296 // used to remove the weak of the reference if we ever see a direct reference
297 // or a definition.
Rafael Espindola2e42fec2010-03-04 18:17:24 +0000298 llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
299
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000300 /// This contains all the decls which have definitions but/ which are deferred
301 /// for emission and therefore should only be output if they are actually
302 /// used. If a decl is in this, then it is known to have not been referenced
303 /// yet.
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000304 std::map<StringRef, GlobalDecl> DeferredDecls;
Daniel Dunbar08b26a02009-02-13 20:29:50 +0000305
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000306 /// This is a list of deferred decls which we have seen that *are* actually
307 /// referenced. These get code generated when the module is done.
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000308 struct DeferredGlobal {
309 DeferredGlobal(llvm::GlobalValue *GV, GlobalDecl GD) : GV(GV), GD(GD) {}
Rafael Espindola6565e922015-01-23 05:26:38 +0000310 llvm::TrackingVH<llvm::GlobalValue> GV;
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000311 GlobalDecl GD;
312 };
313 std::vector<DeferredGlobal> DeferredDeclsToEmit;
314 void addDeferredDeclToEmit(llvm::GlobalValue *GV, GlobalDecl GD) {
Benjamin Kramer3204b152015-05-29 19:42:19 +0000315 DeferredDeclsToEmit.emplace_back(GV, GD);
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000316 }
Daniel Dunbar7dd749e2009-04-15 22:08:45 +0000317
Rafael Espindola208b5c02013-10-22 19:26:13 +0000318 /// List of alias we have emitted. Used to make sure that what they point to
319 /// is defined once we get to the end of the of the translation unit.
320 std::vector<GlobalDecl> Aliases;
321
Rafael Espindola2e2995b2013-11-05 21:37:29 +0000322 typedef llvm::StringMap<llvm::TrackingVH<llvm::Constant> > ReplacementsTy;
323 ReplacementsTy Replacements;
324
Andrey Bokhankocab58582015-08-31 13:20:44 +0000325 /// List of global values to be replaced with something else. Used when we
326 /// want to replace a GlobalValue but can't identify it by its mangled name
327 /// anymore (because the name is already taken).
328 llvm::SmallVector<std::pair<llvm::GlobalValue *, llvm::Constant *>, 8>
329 GlobalValReplacements;
330
331 /// Set of global decls for which we already diagnosed mangled name conflict.
332 /// Required to not issue a warning (on a mangling conflict) multiple times
333 /// for the same decl.
334 llvm::DenseSet<GlobalDecl> DiagnosedConflictingDefinitions;
335
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000336 /// A queue of (optional) vtables to consider emitting.
John McCall6bd2a892013-01-25 22:31:03 +0000337 std::vector<const CXXRecordDecl*> DeferredVTables;
338
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000339 /// List of global values which are required to be present in the object file;
340 /// bitcast to i8*. This is used for forcing visibility of symbols which may
341 /// otherwise be optimized out.
Chris Lattnerf41e87f2009-03-31 22:37:52 +0000342 std::vector<llvm::WeakVH> LLVMUsed;
Rafael Espindola060062a2014-03-06 22:15:10 +0000343 std::vector<llvm::WeakVH> LLVMCompilerUsed;
Mike Stump1676c5b2009-02-13 19:12:34 +0000344
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000345 /// Store the list of global constructors and their respective priorities to
346 /// be emitted when the translation unit is complete.
Daniel Dunbar74aa7e12008-08-01 00:01:51 +0000347 CtorList GlobalCtors;
348
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000349 /// Store the list of global destructors and their respective priorities to be
350 /// emitted when the translation unit is complete.
Daniel Dunbar74aa7e12008-08-01 00:01:51 +0000351 CtorList GlobalDtors;
352
Robert Lytton57765d52014-07-03 09:30:33 +0000353 /// An ordered map of canonical GlobalDecls to their mangled names.
354 llvm::MapVector<GlobalDecl, StringRef> MangledDeclNames;
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000355 llvm::StringMap<GlobalDecl, llvm::BumpPtrAllocator> Manglings;
356
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000357 /// Global annotations.
Nate Begeman7fab5782008-04-18 23:43:57 +0000358 std::vector<llvm::Constant*> Annotations;
Mike Stump1676c5b2009-02-13 19:12:34 +0000359
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000360 /// Map used to get unique annotation strings.
361 llvm::StringMap<llvm::Constant*> AnnotationStrings;
362
David Blaikie2e804282015-04-05 22:47:07 +0000363 llvm::StringMap<llvm::GlobalVariable *> CFConstantStringMap;
David Majnemer58e5bee2014-03-24 21:43:36 +0000364
Richard Smith00db2f12014-07-29 21:20:12 +0000365 llvm::DenseMap<llvm::Constant *, llvm::GlobalVariable *> ConstantStringMap;
Eli Friedman1c8d2ca2012-03-09 03:27:46 +0000366 llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
John McCallb88a5662012-03-30 21:00:39 +0000367 llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
Richard Smithe6c01442013-06-05 00:46:14 +0000368 llvm::DenseMap<const Expr*, llvm::Constant *> MaterializedGlobalTemporaryMap;
369
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000370 llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
371 llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
Daniel Dunbard644ad62008-08-23 18:37:06 +0000372
Will Dietz949ec542013-11-08 01:09:22 +0000373 /// Map used to get unique type descriptor constants for sanitizers.
374 llvm::DenseMap<QualType, llvm::Constant *> TypeDescriptorMap;
375
Richard Smithdf931ce2013-04-06 05:00:46 +0000376 /// Map used to track internal linkage functions declared within
377 /// extern "C" regions.
Richard Smithf21c9612013-04-13 01:28:18 +0000378 typedef llvm::MapVector<IdentifierInfo *,
379 llvm::GlobalValue *> StaticExternCMap;
Richard Smithdf931ce2013-04-06 05:00:46 +0000380 StaticExternCMap StaticExternCValues;
381
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000382 /// \brief thread_local variables defined or used in this TU.
Richard Smith5a99c492015-12-01 01:10:48 +0000383 std::vector<const VarDecl *> CXXThreadLocals;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000384
385 /// \brief thread_local variables with initializers that need to run
386 /// before any thread_local variable in this TU is odr-used.
David Majnemerb3341ea2014-10-05 05:05:40 +0000387 std::vector<llvm::Function *> CXXThreadLocalInits;
Richard Smith5a99c492015-12-01 01:10:48 +0000388 std::vector<const VarDecl *> CXXThreadLocalInitVars;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000389
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000390 /// Global variables with initializers that need to run before main.
David Majnemerb3341ea2014-10-05 05:05:40 +0000391 std::vector<llvm::Function *> CXXGlobalInits;
John McCall70013b62010-07-15 23:40:35 +0000392
393 /// When a C++ decl with an initializer is deferred, null is
394 /// appended to CXXGlobalInits, and the index of that null is placed
395 /// here so that the initializer will be performed in the correct
Reid Klecknere07140e2015-04-15 01:08:06 +0000396 /// order. Once the decl is emitted, the index is replaced with ~0U to ensure
397 /// that we don't re-emit the initializer.
John McCall70013b62010-07-15 23:40:35 +0000398 llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000399
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000400 typedef std::pair<OrderGlobalInits, llvm::Function*> GlobalInitData;
401
402 struct GlobalInitPriorityCmp {
403 bool operator()(const GlobalInitData &LHS,
404 const GlobalInitData &RHS) const {
405 return LHS.first.priority < RHS.first.priority;
406 }
407 };
408
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000409 /// Global variables with initializers whose order of initialization is set by
410 /// init_priority attribute.
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000411 SmallVector<GlobalInitData, 8> PrioritizedCXXGlobalInits;
Mike Stump11289f42009-09-09 15:08:12 +0000412
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000413 /// Global destructor functions and arguments that need to run on termination.
Chris Lattner87233f72010-06-19 05:52:45 +0000414 std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors;
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000415
Douglas Gregor6ddfca92013-01-14 17:21:00 +0000416 /// \brief The complete set of modules that has been imported.
417 llvm::SetVector<clang::Module *> ImportedModules;
418
Reid Klecknere43f0fe2013-05-08 13:44:39 +0000419 /// \brief A vector of metadata strings.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000420 SmallVector<llvm::Metadata *, 16> LinkerOptionsMetadata;
Reid Klecknere43f0fe2013-05-08 13:44:39 +0000421
Douglas Gregorabf4e0d2011-08-09 15:54:21 +0000422 /// @name Cache for Objective-C runtime types
423 /// @{
424
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000425 /// Cached reference to the class for constant strings. This value has type
426 /// int * but is actually an Obj-C class pointer.
Fariborz Jahaniand1b67782013-04-16 15:25:39 +0000427 llvm::WeakVH CFConstantStringClassRef;
Mike Stump11289f42009-09-09 15:08:12 +0000428
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000429 /// Cached reference to the class for constant strings. This value has type
430 /// int * but is actually an Obj-C class pointer.
Fariborz Jahaniand1b67782013-04-16 15:25:39 +0000431 llvm::WeakVH ConstantStringClassRef;
Fariborz Jahaniane804c282010-04-23 17:41:07 +0000432
Douglas Gregorabf4e0d2011-08-09 15:54:21 +0000433 /// \brief The LLVM type corresponding to NSConstantString.
434 llvm::StructType *NSConstantStringType;
435
Douglas Gregor636e2002011-08-09 17:23:49 +0000436 /// \brief The type used to describe the state of a fast enumeration in
437 /// Objective-C's for..in loop.
438 QualType ObjCFastEnumerationStateType;
439
Douglas Gregorabf4e0d2011-08-09 15:54:21 +0000440 /// @}
441
David Chisnall481e3a82010-01-23 02:40:42 +0000442 /// Lazily create the Objective-C runtime
443 void createObjCRuntime();
444
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000445 void createOpenCLRuntime();
Alexey Bataev9959db52014-05-06 10:08:46 +0000446 void createOpenMPRuntime();
Peter Collingbournefe883422011-10-06 18:29:37 +0000447 void createCUDARuntime();
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000448
Rafael Espindola4fdc1752011-12-19 14:41:01 +0000449 bool isTriviallyRecursive(const FunctionDecl *F);
Peter Collingbourne4d90dba2013-06-05 17:49:37 +0000450 bool shouldEmitFunction(GlobalDecl GD);
Daniel Dunbar900546d2010-07-16 00:00:15 +0000451
452 /// @name Cache for Blocks Runtime Globals
453 /// @{
454
455 llvm::Constant *NSConcreteGlobalBlock;
456 llvm::Constant *NSConcreteStackBlock;
Daniel Dunbar3348e2d2010-07-16 00:00:19 +0000457
Daniel Dunbar900546d2010-07-16 00:00:15 +0000458 llvm::Constant *BlockObjectAssign;
459 llvm::Constant *BlockObjectDispose;
460
Chris Lattnera5f58b02011-07-09 17:41:47 +0000461 llvm::Type *BlockDescriptorType;
462 llvm::Type *GenericBlockLiteralType;
John McCallad7c5c12011-02-08 08:22:06 +0000463
464 struct {
465 int GlobalUniqueCount;
466 } Block;
Will Dietzf54319c2013-01-18 11:30:38 +0000467
Nadav Rotem1da30942013-03-23 06:43:35 +0000468 /// void @llvm.lifetime.start(i64 %size, i8* nocapture <ptr>)
469 llvm::Constant *LifetimeStartFn;
470
471 /// void @llvm.lifetime.end(i64 %size, i8* nocapture <ptr>)
472 llvm::Constant *LifetimeEndFn;
473
Fariborz Jahanian63628032012-06-26 16:06:38 +0000474 GlobalDecl initializedGlobalDecl;
John McCallad7c5c12011-02-08 08:22:06 +0000475
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000476 std::unique_ptr<SanitizerMetadata> SanitizerMD;
477
Daniel Dunbar900546d2010-07-16 00:00:15 +0000478 /// @}
Alex Lorenzee024992014-08-04 18:41:51 +0000479
480 llvm::DenseMap<const Decl *, bool> DeferredEmptyCoverageMappingDecls;
481
482 std::unique_ptr<CoverageMappingModuleGen> CoverageMapping;
Peter Collingbourne25a80bf2015-09-08 23:01:30 +0000483
484 /// Mapping from canonical types to their metadata identifiers. We need to
485 /// maintain this mapping because identifiers may be formed from distinct
486 /// MDNodes.
487 llvm::DenseMap<QualType, llvm::Metadata *> MetadataIdMap;
488
Chris Lattnerf97fe382007-05-24 06:29:05 +0000489public:
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000490 CodeGenModule(ASTContext &C, const HeaderSearchOptions &headersearchopts,
Adrian Prantle74f5252015-06-30 02:26:03 +0000491 const PreprocessorOptions &ppopts,
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000492 const CodeGenOptions &CodeGenOpts, llvm::Module &M,
Alex Lorenzee024992014-08-04 18:41:51 +0000493 DiagnosticsEngine &Diags,
494 CoverageSourceInfo *CoverageInfo = nullptr);
Ted Kremenek2c674f62008-08-05 18:50:11 +0000495
Chris Lattnera087ff92008-03-01 08:45:05 +0000496 ~CodeGenModule();
Mike Stump1676c5b2009-02-13 19:12:34 +0000497
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000498 void clear();
499
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000500 /// Finalize LLVM code generation.
Ted Kremenek2c674f62008-08-05 18:50:11 +0000501 void Release();
Daniel Dunbar8d480592008-08-11 18:12:00 +0000502
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000503 /// Return a reference to the configured Objective-C runtime.
Mike Stump1676c5b2009-02-13 19:12:34 +0000504 CGObjCRuntime &getObjCRuntime() {
Peter Collingbournee1d20992011-07-27 20:29:46 +0000505 if (!ObjCRuntime) createObjCRuntime();
506 return *ObjCRuntime;
Daniel Dunbar8d480592008-08-11 18:12:00 +0000507 }
Mike Stump1676c5b2009-02-13 19:12:34 +0000508
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000509 /// Return true iff an Objective-C runtime has been configured.
Peter Collingbournee1d20992011-07-27 20:29:46 +0000510 bool hasObjCRuntime() { return !!ObjCRuntime; }
Daniel Dunbar8d480592008-08-11 18:12:00 +0000511
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000512 /// Return a reference to the configured OpenCL runtime.
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000513 CGOpenCLRuntime &getOpenCLRuntime() {
Craig Topper8a13c412014-05-21 05:09:00 +0000514 assert(OpenCLRuntime != nullptr);
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000515 return *OpenCLRuntime;
516 }
517
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000518 /// Return a reference to the configured OpenMP runtime.
Alexey Bataev9959db52014-05-06 10:08:46 +0000519 CGOpenMPRuntime &getOpenMPRuntime() {
520 assert(OpenMPRuntime != nullptr);
521 return *OpenMPRuntime;
522 }
523
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000524 /// Return a reference to the configured CUDA runtime.
Peter Collingbournefe883422011-10-06 18:29:37 +0000525 CGCUDARuntime &getCUDARuntime() {
Craig Topper8a13c412014-05-21 05:09:00 +0000526 assert(CUDARuntime != nullptr);
Peter Collingbournefe883422011-10-06 18:29:37 +0000527 return *CUDARuntime;
528 }
529
John McCallb04ecb72015-10-21 18:06:43 +0000530 ObjCEntrypoints &getObjCEntrypoints() const {
531 assert(ObjCData != nullptr);
532 return *ObjCData;
John McCall31168b02011-06-15 23:02:42 +0000533 }
534
Justin Bogner837a6f62014-04-18 21:52:00 +0000535 InstrProfStats &getPGOStats() { return PGOStats; }
536 llvm::IndexedInstrProfReader *getPGOReader() const { return PGOReader.get(); }
Justin Bogneref512b92014-01-06 22:27:43 +0000537
Alex Lorenzee024992014-08-04 18:41:51 +0000538 CoverageMappingModuleGen *getCoverageMapping() const {
539 return CoverageMapping.get();
540 }
541
Eli Friedman1c8d2ca2012-03-09 03:27:46 +0000542 llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
543 return StaticLocalDeclMap[D];
Fariborz Jahanian3fef72f2010-04-18 21:01:23 +0000544 }
Fariborz Jahanian4d55b2d2010-04-19 18:15:02 +0000545 void setStaticLocalDeclAddress(const VarDecl *D,
Eli Friedman1c8d2ca2012-03-09 03:27:46 +0000546 llvm::Constant *C) {
547 StaticLocalDeclMap[D] = C;
Fariborz Jahanian3fef72f2010-04-18 21:01:23 +0000548 }
549
Reid Kleckner453e0562014-10-08 01:07:54 +0000550 llvm::Constant *
551 getOrCreateStaticVarDecl(const VarDecl &D,
552 llvm::GlobalValue::LinkageTypes Linkage);
553
John McCallb88a5662012-03-30 21:00:39 +0000554 llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
555 return StaticLocalDeclGuardMap[D];
556 }
557 void setStaticLocalDeclGuardAddress(const VarDecl *D,
558 llvm::GlobalVariable *C) {
559 StaticLocalDeclGuardMap[D] = C;
560 }
561
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000562 bool lookupRepresentativeDecl(StringRef MangledName,
563 GlobalDecl &Result) const;
564
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000565 llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
566 return AtomicSetterHelperFnMap[Ty];
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +0000567 }
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000568 void setAtomicSetterHelperFnMap(QualType Ty,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +0000569 llvm::Constant *Fn) {
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000570 AtomicSetterHelperFnMap[Ty] = Fn;
571 }
572
573 llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
574 return AtomicGetterHelperFnMap[Ty];
575 }
576 void setAtomicGetterHelperFnMap(QualType Ty,
577 llvm::Constant *Fn) {
578 AtomicGetterHelperFnMap[Ty] = Fn;
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +0000579 }
580
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000581 llvm::Constant *getTypeDescriptorFromMap(QualType Ty) {
Will Dietz949ec542013-11-08 01:09:22 +0000582 return TypeDescriptorMap[Ty];
583 }
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000584 void setTypeDescriptorInMap(QualType Ty, llvm::Constant *C) {
Will Dietz949ec542013-11-08 01:09:22 +0000585 TypeDescriptorMap[Ty] = C;
586 }
587
Devang Pateld6ffebb2011-03-07 18:45:56 +0000588 CGDebugInfo *getModuleDebugInfo() { return DebugInfo; }
Devang Patele65982c2011-03-07 18:29:53 +0000589
Dan Gohman515a60d2012-02-16 00:57:37 +0000590 llvm::MDNode *getNoObjCARCExceptionsMetadata() {
591 if (!NoObjCARCExceptionsMetadata)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000592 NoObjCARCExceptionsMetadata = llvm::MDNode::get(getLLVMContext(), None);
Dan Gohman515a60d2012-02-16 00:57:37 +0000593 return NoObjCARCExceptionsMetadata;
594 }
595
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000596 ASTContext &getContext() const { return Context; }
David Blaikiebbafb8a2012-03-11 07:00:24 +0000597 const LangOptions &getLangOpts() const { return LangOpts; }
Adrian Prantle74f5252015-06-30 02:26:03 +0000598 const HeaderSearchOptions &getHeaderSearchOpts()
599 const { return HeaderSearchOpts; }
600 const PreprocessorOptions &getPreprocessorOpts()
601 const { return PreprocessorOpts; }
John McCallc8e01702013-04-16 22:48:15 +0000602 const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
Chris Lattner23b7eb62007-06-15 23:05:46 +0000603 llvm::Module &getModule() const { return TheModule; }
David Blaikie9c902b52011-09-25 23:23:43 +0000604 DiagnosticsEngine &getDiags() const { return Diags; }
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000605 const llvm::DataLayout &getDataLayout() const {
606 return TheModule.getDataLayout();
607 }
John McCallc8e01702013-04-16 22:48:15 +0000608 const TargetInfo &getTarget() const { return Target; }
Rafael Espindola9f834732014-09-19 01:54:22 +0000609 const llvm::Triple &getTriple() const;
610 bool supportsCOMDAT() const;
Rafael Espindoladbee8a72015-01-15 21:36:08 +0000611 void maybeSetTrivialComdat(const Decl &D, llvm::GlobalObject &GO);
Rafael Espindola9f834732014-09-19 01:54:22 +0000612
Alp Toker82862252013-12-28 21:58:40 +0000613 CGCXXABI &getCXXABI() const { return *ABI; }
Owen Anderson170229f2009-07-14 23:10:40 +0000614 llvm::LLVMContext &getLLVMContext() { return VMContext; }
Craig Topper8a13c412014-05-21 05:09:00 +0000615
616 bool shouldUseTBAA() const { return TBAA != nullptr; }
John McCall53fcbd22011-02-26 08:07:02 +0000617
John McCallc8e01702013-04-16 22:48:15 +0000618 const TargetCodeGenInfo &getTargetCodeGenInfo();
619
620 CodeGenTypes &getTypes() { return Types; }
621
622 CodeGenVTables &getVTables() { return VTables; }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000623
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000624 ItaniumVTableContext &getItaniumVTableContext() {
625 return VTables.getItaniumVTableContext();
Timur Iskhodzhanove1ebc5f2013-10-09 11:33:51 +0000626 }
John McCallc8e01702013-04-16 22:48:15 +0000627
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000628 MicrosoftVTableContext &getMicrosoftVTableContext() {
629 return VTables.getMicrosoftVTableContext();
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000630 }
631
Keno Fischer76f4ab02014-12-30 08:12:39 +0000632 CtorList &getGlobalCtors() { return GlobalCtors; }
633 CtorList &getGlobalDtors() { return GlobalDtors; }
634
Dan Gohman947c9af2010-10-14 23:06:10 +0000635 llvm::MDNode *getTBAAInfo(QualType QTy);
Kostya Serebryany141e46f2012-03-26 17:03:51 +0000636 llvm::MDNode *getTBAAInfoForVTablePtr();
Dan Gohman22695fc2012-09-28 21:58:29 +0000637 llvm::MDNode *getTBAAStructInfo(QualType QTy);
Manman Renc451e572013-04-04 21:53:22 +0000638 /// Return the path-aware tag for given base type, access node and offset.
639 llvm::MDNode *getTBAAStructTagInfo(QualType BaseTy, llvm::MDNode *AccessN,
640 uint64_t O);
Dan Gohman947c9af2010-10-14 23:06:10 +0000641
Richard Smithe070fd22012-02-17 06:48:11 +0000642 bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
643
John McCalla8ec7eb2013-03-07 21:37:17 +0000644 bool isPaddedAtomicType(QualType type);
645 bool isPaddedAtomicType(const AtomicType *type);
646
Manman Rene1ad74e2013-04-11 23:02:56 +0000647 /// Decorate the instruction with a TBAA tag. For scalar TBAA, the tag
648 /// is the same as the type. For struct-path aware TBAA, the tag
649 /// is different from the type: base type, access type and offset.
650 /// When ConvertTypeToTag is true, we create a tag based on the scalar type.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +0000651 void DecorateInstructionWithTBAA(llvm::Instruction *Inst,
652 llvm::MDNode *TBAAInfo,
653 bool ConvertTypeToTag = true);
654
655 /// Adds !invariant.barrier !tag to instruction
656 void DecorateInstructionWithInvariantGroup(llvm::Instruction *I,
657 const CXXRecordDecl *RD);
Dan Gohman947c9af2010-10-14 23:06:10 +0000658
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000659 /// Emit the given number of characters as a value of type size_t.
John McCall23c29fe2011-06-24 21:55:10 +0000660 llvm::ConstantInt *getSize(CharUnits numChars);
661
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000662 /// Set the visibility for the given LLVM GlobalValue.
Anders Carlssonc6a47892011-01-29 19:39:23 +0000663 void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
Daniel Dunbarf5f359f2009-04-14 06:00:08 +0000664
David Majnemerbb525f7c2014-10-15 22:38:23 +0000665 /// Set the TLS mode for the given LLVM GlobalValue for the thread-local
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000666 /// variable declaration D.
David Majnemerbb525f7c2014-10-15 22:38:23 +0000667 void setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const;
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000668
Anders Carlsson537fdce2011-01-29 20:59:35 +0000669 static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
670 switch (V) {
671 case DefaultVisibility: return llvm::GlobalValue::DefaultVisibility;
672 case HiddenVisibility: return llvm::GlobalValue::HiddenVisibility;
673 case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
674 }
675 llvm_unreachable("unknown visibility!");
Anders Carlsson537fdce2011-01-29 20:59:35 +0000676 }
677
Andrey Bokhankocab58582015-08-31 13:20:44 +0000678 llvm::Constant *GetAddrOfGlobal(GlobalDecl GD, bool IsForDefinition = false);
John McCalld4324142010-02-19 01:32:20 +0000679
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000680 /// Will return a global variable of the given type. If a variable with a
681 /// different type already exists then a new variable with the right type
682 /// will be created and all uses of the old variable will be replaced with a
683 /// bitcast to the new variable.
Anders Carlssonda80af32011-01-29 18:20:20 +0000684 llvm::GlobalVariable *
Chris Lattner01cf8db2011-07-20 06:58:45 +0000685 CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty,
Anders Carlssonda80af32011-01-29 18:20:20 +0000686 llvm::GlobalValue::LinkageTypes Linkage);
687
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000688 llvm::Function *
689 CreateGlobalInitOrDestructFunction(llvm::FunctionType *ty, const Twine &name,
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000690 const CGFunctionInfo &FI,
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000691 SourceLocation Loc = SourceLocation(),
692 bool TLS = false);
David Majnemerb3341ea2014-10-05 05:05:40 +0000693
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000694 /// Return the address space of the underlying global variable for D, as
695 /// determined by its declaration. Normally this is the same as the address
696 /// space of D's type, but in CUDA, address spaces are associated with
697 /// declarations, not types.
Peter Collingbournef44bdf92012-05-20 21:08:35 +0000698 unsigned GetGlobalVarAddressSpace(const VarDecl *D, unsigned AddrSpace);
699
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000700 /// Return the llvm::Constant for the address of the given global variable.
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +0000701 /// If Ty is non-null and if the global doesn't exist, then it will be created
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000702 /// with the specified type instead of whatever the normal requested type
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +0000703 /// would be. If IsForDefinition is true, it is guranteed that an actual
704 /// global with type Ty will be returned, not conversion of a variable with
705 /// the same mangled name but some other type.
Chris Lattner149927c2009-03-21 09:16:30 +0000706 llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +0000707 llvm::Type *Ty = nullptr,
708 bool IsForDefinition = false);
Daniel Dunbar9c426522008-07-29 23:18:29 +0000709
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000710 /// Return the address of the given function. If Ty is non-null, then this
711 /// function will use the specified type if it has to create it.
Hans Wennborg59dbe862015-09-29 20:56:43 +0000712 llvm::Constant *GetAddrOfFunction(GlobalDecl GD, llvm::Type *Ty = nullptr,
Rafael Espindola94abb8f2013-12-09 04:29:47 +0000713 bool ForVTable = false,
Andrey Bokhankocab58582015-08-31 13:20:44 +0000714 bool DontDefer = false,
715 bool IsForDefinition = false);
Daniel Dunbarc4baa062008-08-13 23:20:05 +0000716
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000717 /// Get the address of the RTTI descriptor for the given type.
John McCall48bf3492010-04-30 01:15:21 +0000718 llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
Anders Carlssonfd7dfeb2009-12-11 02:46:30 +0000719
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000720 /// Get the address of a uuid descriptor .
John McCall7f416cc2015-09-08 08:05:57 +0000721 ConstantAddress GetAddrOfUuidDescriptor(const CXXUuidofExpr* E);
Nico Webercf4ff5862012-10-11 10:13:44 +0000722
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000723 /// Get the address of the thunk for the given global decl.
Anders Carlssonfe8a9932011-02-06 17:15:43 +0000724 llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk);
Anders Carlssoncd836f02010-03-23 17:17:29 +0000725
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000726 /// Get a reference to the target of VD.
John McCall7f416cc2015-09-08 08:05:57 +0000727 ConstantAddress GetWeakRefReference(const ValueDecl *VD);
728
729 /// Returns the assumed alignment of an opaque pointer to the given class.
730 CharUnits getClassPointerAlignment(const CXXRecordDecl *CD);
731
732 /// Returns the assumed alignment of a virtual base of a class.
733 CharUnits getVBaseAlignment(CharUnits DerivedAlign,
734 const CXXRecordDecl *Derived,
735 const CXXRecordDecl *VBase);
736
737 /// Given a class pointer with an actual known alignment, and the
738 /// expected alignment of an object at a dynamic offset w.r.t that
739 /// pointer, return the alignment to assume at the offset.
740 CharUnits getDynamicOffsetAlignment(CharUnits ActualAlign,
741 const CXXRecordDecl *Class,
742 CharUnits ExpectedTargetAlign);
Rafael Espindola2e42fec2010-03-04 18:17:24 +0000743
David Majnemerc1709d32015-06-23 07:31:11 +0000744 CharUnits
745 computeNonVirtualBaseClassOffset(const CXXRecordDecl *DerivedClass,
746 CastExpr::path_const_iterator Start,
747 CastExpr::path_const_iterator End);
748
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000749 /// Returns the offset from a derived class to a class. Returns null if the
750 /// offset is 0.
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000751 llvm::Constant *
752 GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
John McCallcf142162010-08-07 06:22:56 +0000753 CastExpr::path_const_iterator PathBegin,
754 CastExpr::path_const_iterator PathEnd);
John McCallad7c5c12011-02-08 08:22:06 +0000755
John McCall7f416cc2015-09-08 08:05:57 +0000756 llvm::FoldingSet<BlockByrefHelpers> ByrefHelpersCache;
John McCallad7c5c12011-02-08 08:22:06 +0000757
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000758 /// Fetches the global unique block count.
John McCall147d0212011-02-22 22:38:33 +0000759 int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
Fariborz Jahanian63628032012-06-26 16:06:38 +0000760
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000761 /// Fetches the type of a generic block descriptor.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000762 llvm::Type *getBlockDescriptorType();
John McCallad7c5c12011-02-08 08:22:06 +0000763
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000764 /// The type of a generic block literal.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000765 llvm::Type *getGenericBlockLiteralType();
John McCallad7c5c12011-02-08 08:22:06 +0000766
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000767 /// Gets the address of a block which requires no captures.
John McCallad7c5c12011-02-08 08:22:06 +0000768 llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *);
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000769
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000770 /// Return a pointer to a constant CFString object for the given string.
John McCall7f416cc2015-09-08 08:05:57 +0000771 ConstantAddress GetAddrOfConstantCFString(const StringLiteral *Literal);
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000772
773 /// Return a pointer to a constant NSString object for the given string. Or a
774 /// user defined String object as defined via
Fariborz Jahanian50c925f2010-10-19 17:19:29 +0000775 /// -fconstant-string-class=class_name option.
John McCall7f416cc2015-09-08 08:05:57 +0000776 ConstantAddress GetAddrOfConstantString(const StringLiteral *Literal);
Chris Lattner36fc8792008-02-11 00:02:17 +0000777
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000778 /// Return a constant array for the given string.
Eli Friedmanfcec6302011-11-01 02:23:42 +0000779 llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
780
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000781 /// Return a pointer to a constant array for the given string literal.
John McCall7f416cc2015-09-08 08:05:57 +0000782 ConstantAddress
Alexey Bataevec474782014-10-09 08:45:04 +0000783 GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
784 StringRef Name = ".str");
Daniel Dunbar6dfdf8c2008-08-10 20:25:57 +0000785
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000786 /// Return a pointer to a constant array for the given ObjCEncodeExpr node.
John McCall7f416cc2015-09-08 08:05:57 +0000787 ConstantAddress
Alexey Samsonovb2cc23d2014-07-10 22:18:36 +0000788 GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
Mike Stump11289f42009-09-09 15:08:12 +0000789
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000790 /// Returns a pointer to a character array containing the literal and a
791 /// terminating '\0' character. The result has pointer to array type.
Daniel Dunbardfcf5992008-10-17 21:56:50 +0000792 ///
Mike Stump1676c5b2009-02-13 19:12:34 +0000793 /// \param GlobalName If provided, the name to use for the global (if one is
794 /// created).
John McCall7f416cc2015-09-08 08:05:57 +0000795 ConstantAddress
Alexey Samsonovb2cc23d2014-07-10 22:18:36 +0000796 GetAddrOfConstantCString(const std::string &Str,
John McCall7f416cc2015-09-08 08:05:57 +0000797 const char *GlobalName = nullptr);
Richard Smith2d988f02011-11-22 22:48:32 +0000798
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000799 /// Returns a pointer to a constant global variable for the given file-scope
800 /// compound literal expression.
John McCall7f416cc2015-09-08 08:05:57 +0000801 ConstantAddress GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
Richard Smithe6c01442013-06-05 00:46:14 +0000802
803 /// \brief Returns a pointer to a global variable representing a temporary
804 /// with static or thread storage duration.
John McCall7f416cc2015-09-08 08:05:57 +0000805 ConstantAddress GetAddrOfGlobalTemporary(const MaterializeTemporaryExpr *E,
Richard Smithe6c01442013-06-05 00:46:14 +0000806 const Expr *Inner);
807
Douglas Gregor636e2002011-08-09 17:23:49 +0000808 /// \brief Retrieve the record type that describes the state of an
809 /// Objective-C fast enumeration loop (for..in).
810 QualType getObjCFastEnumerationStateType();
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000811
Rafael Espindola53686182014-09-15 19:34:18 +0000812 // Produce code for this constructor/destructor. This method doesn't try
813 // to apply any ABI rules about which other constructors/destructors
814 // are needed or if they are alias to each other.
815 llvm::Function *codegenCXXStructor(const CXXMethodDecl *MD,
816 StructorType Type);
817
Rafael Espindola1ac0ec82014-09-11 15:42:06 +0000818 /// Return the address of the constructor/destructor of the given type.
Andrey Bokhankocab58582015-08-31 13:20:44 +0000819 llvm::Constant *
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000820 getAddrOfCXXStructor(const CXXMethodDecl *MD, StructorType Type,
821 const CGFunctionInfo *FnInfo = nullptr,
822 llvm::FunctionType *FnType = nullptr,
Andrey Bokhankocab58582015-08-31 13:20:44 +0000823 bool DontDefer = false, bool IsForDefinition = false);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000824
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000825 /// Given a builtin id for a function like "__builtin_fabsf", return a
826 /// Function* for "fabsf".
Daniel Dunbarff0553e2009-09-14 04:33:21 +0000827 llvm::Value *getBuiltinLibFunction(const FunctionDecl *FD,
828 unsigned BuiltinID);
Daniel Dunbarc4baa062008-08-13 23:20:05 +0000829
Dmitri Gribenko44ebbd52013-05-05 00:41:58 +0000830 llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = None);
Daniel Dunbar9c426522008-07-29 23:18:29 +0000831
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000832 /// Emit code for a single top level declaration.
Daniel Dunbarfce4be82008-08-15 23:26:23 +0000833 void EmitTopLevelDecl(Decl *D);
Daniel Dunbar9c426522008-07-29 23:18:29 +0000834
Alex Lorenzee024992014-08-04 18:41:51 +0000835 /// \brief Stored a deferred empty coverage mapping for an unused
836 /// and thus uninstrumented top level declaration.
837 void AddDeferredUnusedCoverageMapping(Decl *D);
838
839 /// \brief Remove the deferred empty coverage mapping as this
840 /// declaration is actually instrumented.
841 void ClearUnusedCoverageMapping(const Decl *D);
842
843 /// \brief Emit all the deferred coverage mappings
844 /// for the uninstrumented functions.
845 void EmitDeferredUnusedCoverageMappings();
846
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000847 /// Tell the consumer that this variable has been instantiated.
Rafael Espindoladf88f6f2012-03-08 15:51:03 +0000848 void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
Rafael Espindola189fa742012-03-05 10:54:55 +0000849
Richard Smithdf931ce2013-04-06 05:00:46 +0000850 /// \brief If the declaration has internal linkage but is inside an
851 /// extern "C" linkage specification, prepare to emit an alias for it
852 /// to the expected name.
853 template<typename SomeDecl>
854 void MaybeHandleStaticInExternC(const SomeDecl *D, llvm::GlobalValue *GV);
855
Rafael Espindola060062a2014-03-06 22:15:10 +0000856 /// Add a global to a list to be added to the llvm.used metadata.
857 void addUsedGlobal(llvm::GlobalValue *GV);
858
859 /// Add a global to a list to be added to the llvm.compiler.used metadata.
860 void addCompilerUsedGlobal(llvm::GlobalValue *GV);
Daniel Dunbar08b26a02009-02-13 20:29:50 +0000861
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000862 /// Add a destructor and object to add to the C++ global destructor function.
Chris Lattner87233f72010-06-19 05:52:45 +0000863 void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) {
Benjamin Kramer3204b152015-05-29 19:42:19 +0000864 CXXGlobalDtors.emplace_back(DtorFn, Object);
Chris Lattner87233f72010-06-19 05:52:45 +0000865 }
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000866
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000867 /// Create a new runtime function with the specified type and name.
Chris Lattner2192fe52011-07-18 04:24:23 +0000868 llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty,
Chris Lattner01cf8db2011-07-20 06:58:45 +0000869 StringRef Name,
Bill Wendling8594fcb2013-01-31 00:30:05 +0000870 llvm::AttributeSet ExtraAttrs =
871 llvm::AttributeSet());
Anton Korobeynikovd90dd792014-12-02 16:04:58 +0000872 /// Create a new compiler builtin function with the specified type and name.
873 llvm::Constant *CreateBuiltinFunction(llvm::FunctionType *Ty,
874 StringRef Name,
875 llvm::AttributeSet ExtraAttrs =
876 llvm::AttributeSet());
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000877 /// Create a new runtime global variable with the specified type and name.
Chris Lattner2192fe52011-07-18 04:24:23 +0000878 llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
Chris Lattner01cf8db2011-07-20 06:58:45 +0000879 StringRef Name);
Daniel Dunbar23fd4622008-10-01 00:49:24 +0000880
Daniel Dunbar900546d2010-07-16 00:00:15 +0000881 ///@name Custom Blocks Runtime Interfaces
882 ///@{
883
884 llvm::Constant *getNSConcreteGlobalBlock();
885 llvm::Constant *getNSConcreteStackBlock();
886 llvm::Constant *getBlockObjectAssign();
887 llvm::Constant *getBlockObjectDispose();
888
889 ///@}
890
Nadav Rotem1da30942013-03-23 06:43:35 +0000891 llvm::Constant *getLLVMLifetimeStartFn();
892 llvm::Constant *getLLVMLifetimeEndFn();
893
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000894 // Make sure that this type is translated.
Devang Patel945b8ae2011-03-23 16:29:39 +0000895 void UpdateCompletedType(const TagDecl *TD);
Daniel Dunbar38ad1e62009-02-17 18:43:32 +0000896
John McCallf3a88602011-02-03 08:15:49 +0000897 llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
898
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000899 /// Try to emit the initializer for the given declaration as a constant;
900 /// returns 0 if the expression cannot be emitted as a constant.
Craig Topper8a13c412014-05-21 05:09:00 +0000901 llvm::Constant *EmitConstantInit(const VarDecl &D,
902 CodeGenFunction *CGF = nullptr);
Richard Smithdafff942012-01-14 04:30:29 +0000903
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000904 /// Try to emit the given expression as a constant; returns 0 if the
905 /// expression cannot be emitted as a constant.
Anders Carlsson80f97ab2009-04-08 04:48:15 +0000906 llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType,
Craig Topper8a13c412014-05-21 05:09:00 +0000907 CodeGenFunction *CGF = nullptr);
Daniel Dunbar38ad1e62009-02-17 18:43:32 +0000908
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000909 /// Emit the given constant value as a constant, in the type's scalar
910 /// representation.
Richard Smithdafff942012-01-14 04:30:29 +0000911 llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType,
Craig Topper8a13c412014-05-21 05:09:00 +0000912 CodeGenFunction *CGF = nullptr);
Richard Smithdafff942012-01-14 04:30:29 +0000913
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000914 /// Emit the given constant value as a constant, in the type's memory
915 /// representation.
Richard Smithbc6387672012-03-02 23:27:11 +0000916 llvm::Constant *EmitConstantValueForMemory(const APValue &Value,
917 QualType DestType,
Craig Topper8a13c412014-05-21 05:09:00 +0000918 CodeGenFunction *CGF = nullptr);
Richard Smithbc6387672012-03-02 23:27:11 +0000919
Alexey Bataev2bf9b4c2015-10-20 04:24:12 +0000920 /// \brief Emit type info if type of an expression is a variably modified
921 /// type. Also emit proper debug info for cast types.
922 void EmitExplicitCastExprType(const ExplicitCastExpr *E,
923 CodeGenFunction *CGF = nullptr);
924
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000925 /// Return the result of value-initializing the given type, i.e. a null
926 /// expression of the given type. This is usually, but not always, an LLVM
927 /// null constant.
Eli Friedman20bb5e02009-04-13 21:47:26 +0000928 llvm::Constant *EmitNullConstant(QualType T);
929
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000930 /// Return a null constant appropriate for zero-initializing a base class with
931 /// the given type. This is usually, but not always, an LLVM null constant.
Eli Friedmanfde961d2011-10-14 02:27:24 +0000932 llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
933
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000934 /// Emit a general error that something can't be done.
Chandler Carruth84537952012-03-30 19:44:53 +0000935 void Error(SourceLocation loc, StringRef error);
John McCall7ef5cb32011-03-18 02:56:14 +0000936
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000937 /// Print out an error that codegen doesn't support the specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +0000938 void ErrorUnsupported(const Stmt *S, const char *Type);
Mike Stump1676c5b2009-02-13 19:12:34 +0000939
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000940 /// Print out an error that codegen doesn't support the specified decl yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +0000941 void ErrorUnsupported(const Decl *D, const char *Type);
Dan Gohman75d69da2008-05-22 00:50:06 +0000942
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000943 /// Set the attributes on the LLVM function for the given decl and function
944 /// info. This applies attributes necessary for handling the ABI as well as
945 /// user specified attributes like section.
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000946 void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F,
947 const CGFunctionInfo &FI);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000948
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000949 /// Set the LLVM function attributes (sext, zext, etc).
Daniel Dunbaraeddffc2009-04-14 07:08:30 +0000950 void SetLLVMFunctionAttributes(const Decl *D,
951 const CGFunctionInfo &Info,
952 llvm::Function *F);
Daniel Dunbarc68897d2008-09-10 00:41:16 +0000953
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000954 /// Set the LLVM function attributes which only apply to a function
James Dennett64fa1232014-08-15 20:04:40 +0000955 /// definition.
Daniel Dunbar38932572009-04-14 08:05:55 +0000956 void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
957
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000958 /// Return true iff the given type uses 'sret' when used as a return type.
Daniel Dunbar6f2e8392010-07-14 23:39:36 +0000959 bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
960
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000961 /// Return true iff the given type uses an argument slot when 'sret' is used
962 /// as a return type.
Tim Northovere77cc392014-03-29 13:28:05 +0000963 bool ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI);
964
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000965 /// Return true iff the given type uses 'fpret' when used as a return type.
Daniel Dunbar6f2e8392010-07-14 23:39:36 +0000966 bool ReturnTypeUsesFPRet(QualType ResultType);
Daniel Dunbarc68897d2008-09-10 00:41:16 +0000967
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000968 /// Return true iff the given type uses 'fp2ret' when used as a return type.
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000969 bool ReturnTypeUsesFP2Ret(QualType ResultType);
970
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000971 /// Get the LLVM attributes and calling convention to use for a particular
972 /// function type.
Daniel Dunbar0ef34792009-09-12 00:59:20 +0000973 ///
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000974 /// \param Name - The function name.
Daniel Dunbar0ef34792009-09-12 00:59:20 +0000975 /// \param Info - The function type information.
Samuel Antao798f11c2015-11-23 22:04:44 +0000976 /// \param CalleeInfo - The callee information these attributes are being
977 /// constructed for. If valid, the attributes applied to this decl may
978 /// contribute to the function attributes and calling convention.
Daniel Dunbar0ef34792009-09-12 00:59:20 +0000979 /// \param PAL [out] - On return, the attribute list to use.
980 /// \param CallingConv [out] - On return, the LLVM calling convention to use.
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000981 void ConstructAttributeList(StringRef Name, const CGFunctionInfo &Info,
Samuel Antao798f11c2015-11-23 22:04:44 +0000982 CGCalleeInfo CalleeInfo, AttributeListType &PAL,
983 unsigned &CallingConv, bool AttrOnCallSite);
Daniel Dunbarc68897d2008-09-10 00:41:16 +0000984
Eric Christopher2b90a642015-11-11 23:05:08 +0000985 // Fills in the supplied string map with the set of target features for the
986 // passed in function.
987 void getFunctionFeatureMap(llvm::StringMap<bool> &FeatureMap,
988 const FunctionDecl *FD);
989
Chris Lattner01cf8db2011-07-20 06:58:45 +0000990 StringRef getMangledName(GlobalDecl GD);
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000991 StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD);
Douglas Gregorbeecd582009-04-21 17:11:58 +0000992
993 void EmitTentativeDefinition(const VarDecl *D);
Mike Stumpbc78a722009-07-31 18:25:34 +0000994
Nico Weberb6a5d052015-01-15 04:07:35 +0000995 void EmitVTable(CXXRecordDecl *Class);
Douglas Gregor88d292c2010-05-13 16:44:06 +0000996
David Majnemer929025d2016-01-26 19:30:26 +0000997 void RefreshTypeCacheForClass(const CXXRecordDecl *Class);
998
Reid Klecknere43f0fe2013-05-08 13:44:39 +0000999 /// \brief Appends Opts to the "Linker Options" metadata value.
1000 void AppendLinkerOptions(StringRef Opts);
1001
Benjamin Kramer82dfc972013-06-04 09:13:21 +00001002 /// \brief Appends a detect mismatch command to the linker options.
Aaron Ballman5d041be2013-06-04 02:07:14 +00001003 void AddDetectMismatch(StringRef Name, StringRef Value);
1004
Reid Klecknere43f0fe2013-05-08 13:44:39 +00001005 /// \brief Appends a dependent lib to the "Linker Options" metadata value.
1006 void AddDependentLib(StringRef Lib);
1007
Peter Collingbourne4d90dba2013-06-05 17:49:37 +00001008 llvm::GlobalVariable::LinkageTypes getFunctionLinkage(GlobalDecl GD);
John McCalld4324142010-02-19 01:32:20 +00001009
Rafael Espindola64926362014-05-08 14:46:46 +00001010 void setFunctionLinkage(GlobalDecl GD, llvm::Function *F) {
1011 F->setLinkage(getFunctionLinkage(GD));
John McCall7cb02202010-05-25 04:30:21 +00001012 }
1013
Hans Wennborgbb4f9622015-05-28 17:44:56 +00001014 /// Set the DLL storage class on F.
1015 void setFunctionDLLStorageClass(GlobalDecl GD, llvm::Function *F);
1016
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001017 /// Return the appropriate linkage for the vtable, VTT, and type information
1018 /// of the given class.
Anders Carlsson68d34242011-01-24 02:04:33 +00001019 llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
Ken Dyck98ca7942010-01-26 13:48:07 +00001020
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001021 /// Return the store size, in character units, of the given LLVM type.
Chris Lattner2192fe52011-07-18 04:24:23 +00001022 CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
Fariborz Jahanian1518a5ec2010-10-27 16:21:54 +00001023
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001024 /// Returns LLVM linkage for a declarator.
David Majnemer27d69db2014-04-28 22:17:59 +00001025 llvm::GlobalValue::LinkageTypes
Hans Wennborg1a3a0742014-05-14 19:54:53 +00001026 getLLVMLinkageForDeclarator(const DeclaratorDecl *D, GVALinkage Linkage,
Hans Wennborg275efb92014-05-28 01:52:23 +00001027 bool IsConstantVariable);
David Majnemer27d69db2014-04-28 22:17:59 +00001028
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001029 /// Returns LLVM linkage for a declarator.
David Majnemer27d69db2014-04-28 22:17:59 +00001030 llvm::GlobalValue::LinkageTypes
1031 getLLVMLinkageVarDefinition(const VarDecl *VD, bool IsConstant);
1032
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001033 /// Emit all the global annotations.
1034 void EmitGlobalAnnotations();
1035
1036 /// Emit an annotation string.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001037 llvm::Constant *EmitAnnotationString(StringRef Str);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001038
1039 /// Emit the annotation's translation unit.
1040 llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
1041
1042 /// Emit the annotation line number.
1043 llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
1044
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001045 /// Generate the llvm::ConstantStruct which contains the annotation
1046 /// information for a given GlobalValue. The annotation struct is
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001047 /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
1048 /// GlobalValue being annotated. The second field is the constant string
1049 /// created from the AnnotateAttr's annotation. The third field is a constant
1050 /// string containing the name of the translation unit. The fourth field is
1051 /// the line number in the file of the annotated value declaration.
1052 llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
1053 const AnnotateAttr *AA,
1054 SourceLocation L);
1055
1056 /// Add global annotations that are set on D, for the global GV. Those
1057 /// annotations are emitted during finalization of the LLVM code.
1058 void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
1059
Alexey Samsonov1444bb92014-10-17 00:20:19 +00001060 bool isInSanitizerBlacklist(llvm::Function *Fn, SourceLocation Loc) const;
Will Dietzf54319c2013-01-18 11:30:38 +00001061
Alexey Samsonova0ac3c22014-10-17 22:37:33 +00001062 bool isInSanitizerBlacklist(llvm::GlobalVariable *GV, SourceLocation Loc,
1063 QualType Ty,
1064 StringRef Category = StringRef()) const;
1065
Alexey Samsonov4b8de112014-08-01 21:35:28 +00001066 SanitizerMetadata *getSanitizerMetadata() {
1067 return SanitizerMD.get();
1068 }
Alexey Samsonov4f319cc2014-07-02 16:54:41 +00001069
John McCall6bd2a892013-01-25 22:31:03 +00001070 void addDeferredVTable(const CXXRecordDecl *RD) {
1071 DeferredVTables.push_back(RD);
1072 }
1073
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001074 /// Emit code for a singal global function or var decl. Forward declarations
1075 /// are emitted lazily.
Reid Klecknere7de47e2013-07-22 13:51:44 +00001076 void EmitGlobal(GlobalDecl D);
1077
Rafael Espindola02b77f42014-09-15 18:46:13 +00001078 bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target,
1079 bool InEveryTU);
1080 bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
1081
1082 /// Set attributes for a global definition.
1083 void setFunctionDefinitionAttributes(const FunctionDecl *D,
1084 llvm::Function *F);
1085
Chris Lattner01cf8db2011-07-20 06:58:45 +00001086 llvm::GlobalValue *GetGlobalValue(StringRef Ref);
Mike Stump11289f42009-09-09 15:08:12 +00001087
Rafael Espindola1e4df922014-09-16 15:18:21 +00001088 /// Set attributes which are common to any form of a global definition (alias,
1089 /// Objective-C method, function, global variable).
1090 ///
1091 /// NOTE: This should only be called for definitions.
1092 void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV);
1093
Dario Domiziolic4fb8ca72014-09-19 22:06:24 +00001094 /// Set attributes which must be preserved by an alias. This includes common
1095 /// attributes (i.e. it includes a call to SetCommonAttributes).
1096 ///
1097 /// NOTE: This should only be called for definitions.
1098 void setAliasAttributes(const Decl *D, llvm::GlobalValue *GV);
1099
Rafael Espindola1e4df922014-09-16 15:18:21 +00001100 void addReplacement(StringRef Name, llvm::Constant *C);
Alexey Bataev97720002014-11-11 04:05:39 +00001101
Andrey Bokhankocab58582015-08-31 13:20:44 +00001102 void addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C);
1103
Alexey Bataev97720002014-11-11 04:05:39 +00001104 /// \brief Emit a code for threadprivate directive.
1105 /// \param D Threadprivate declaration.
1106 void EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D);
1107
Peter Collingbournee5706442015-07-09 19:56:14 +00001108 /// Returns whether the given record is blacklisted from control flow
1109 /// integrity checks.
1110 bool IsCFIBlacklistedRecord(const CXXRecordDecl *RD);
1111
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001112 /// Emit bit set entries for the given vtable using the given layout if
1113 /// vptr CFI is enabled.
1114 void EmitVTableBitSetEntries(llvm::GlobalVariable *VTable,
1115 const VTableLayout &VTLayout);
1116
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001117 /// Generate a cross-DSO type identifier for type.
1118 llvm::ConstantInt *CreateCfiIdForTypeMetadata(llvm::Metadata *MD);
1119
Peter Collingbourne25a80bf2015-09-08 23:01:30 +00001120 /// Create a metadata identifier for the given type. This may either be an
1121 /// MDString (for external identifiers) or a distinct unnamed MDNode (for
1122 /// internal identifiers).
1123 llvm::Metadata *CreateMetadataIdentifierForType(QualType T);
1124
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001125 /// Create a bitset entry for the given function and add it to BitsetsMD.
1126 void CreateFunctionBitSetEntry(const FunctionDecl *FD, llvm::Function *F);
1127
1128 /// Create a bitset entry for the given vtable and add it to BitsetsMD.
1129 void CreateVTableBitSetEntry(llvm::NamedMDNode *BitsetsMD,
1130 llvm::GlobalVariable *VTable, CharUnits Offset,
1131 const CXXRecordDecl *RD);
Peter Collingbourne86d34a72015-06-17 19:08:05 +00001132
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00001133 /// \breif Get the declaration of std::terminate for the platform.
1134 llvm::Constant *getTerminateFn();
1135
Peter Collingbournedc134532016-01-16 00:31:22 +00001136 llvm::SanitizerStatReport &getSanStats();
1137
Rafael Espindola1e4df922014-09-16 15:18:21 +00001138private:
Rafael Espindola94abb8f2013-12-09 04:29:47 +00001139 llvm::Constant *
1140 GetOrCreateLLVMFunction(StringRef MangledName, llvm::Type *Ty, GlobalDecl D,
1141 bool ForVTable, bool DontDefer = false,
David Majnemerb9bd6fb2014-11-01 05:42:23 +00001142 bool IsThunk = false,
Andrey Bokhankocab58582015-08-31 13:20:44 +00001143 llvm::AttributeSet ExtraAttrs = llvm::AttributeSet(),
1144 bool IsForDefinition = false);
Rafael Espindola94abb8f2013-12-09 04:29:47 +00001145
Chris Lattner01cf8db2011-07-20 06:58:45 +00001146 llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName,
Chris Lattner2192fe52011-07-18 04:24:23 +00001147 llvm::PointerType *PTy,
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +00001148 const VarDecl *D,
1149 bool IsForDefinition = false);
Mike Stump11289f42009-09-09 15:08:12 +00001150
Rafael Espindolaee076a22014-05-13 18:45:53 +00001151 void setNonAliasAttributes(const Decl *D, llvm::GlobalObject *GO);
Rafael Espindola502f65a2014-05-05 20:21:03 +00001152
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001153 /// Set function attributes for a function declaration.
David Majnemerb9bd6fb2014-11-01 05:42:23 +00001154 void SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
1155 bool IsIncompleteFunction, bool IsThunk);
Nuno Lopesb6f79532008-06-08 15:45:52 +00001156
Craig Topper8a13c412014-05-21 05:09:00 +00001157 void EmitGlobalDefinition(GlobalDecl D, llvm::GlobalValue *GV = nullptr);
Daniel Dunbarf0acf7b2009-02-19 07:15:39 +00001158
Rafael Espindolacd7743b2013-12-09 16:01:03 +00001159 void EmitGlobalFunctionDefinition(GlobalDecl GD, llvm::GlobalValue *GV);
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +00001160 void EmitGlobalVarDefinition(const VarDecl *D, bool IsTentative = false);
John McCall7ec50432010-03-19 23:29:14 +00001161 void EmitAliasDefinition(GlobalDecl GD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001162 void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001163 void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
Fariborz Jahanian1518a5ec2010-10-27 16:21:54 +00001164
Anders Carlssonf7475242009-04-15 15:55:24 +00001165 // C++ related functions.
Mike Stump11289f42009-09-09 15:08:12 +00001166
Anders Carlsson237f3492009-04-01 00:58:25 +00001167 void EmitNamespace(const NamespaceDecl *D);
Anders Carlssoncbaeb9e2009-04-02 05:55:18 +00001168 void EmitLinkageSpec(const LinkageSpecDecl *D);
Adrian Prantlffcf4ba2013-05-09 23:16:27 +00001169 void CompleteDIClassType(const CXXMethodDecl* D);
Anders Carlssonf7475242009-04-15 15:55:24 +00001170
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001171 /// \brief Emit the function that initializes C++ thread_local variables.
1172 void EmitCXXThreadLocalInitFunc();
1173
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001174 /// Emit the function that initializes C++ globals.
Anders Carlssonb8be93f2009-08-08 23:24:23 +00001175 void EmitCXXGlobalInitFunc();
Eli Friedman5866fe32010-01-08 00:50:11 +00001176
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001177 /// Emit the function that destroys C++ globals.
Daniel Dunbarfe06df42010-03-20 04:15:41 +00001178 void EmitCXXGlobalDtorFunc();
1179
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001180 /// Emit the function that initializes the specified global (if PerformInit is
1181 /// true) and registers its destructor.
John McCallcdf7ef52010-11-06 09:44:32 +00001182 void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00001183 llvm::GlobalVariable *Addr,
1184 bool PerformInit);
Eli Friedman5866fe32010-01-08 00:50:11 +00001185
Reid Kleckner1a711b12014-07-22 00:53:05 +00001186 void EmitPointerToInitFunc(const VarDecl *VD, llvm::GlobalVariable *Addr,
1187 llvm::Function *InitFunc, InitSegAttr *ISA);
1188
Daniel Dunbar74aa7e12008-08-01 00:01:51 +00001189 // FIXME: Hardcoding priority here is gross.
Reid Kleckner563f0e82014-05-23 21:13:45 +00001190 void AddGlobalCtor(llvm::Function *Ctor, int Priority = 65535,
Hans Wennborg59dbe862015-09-29 20:56:43 +00001191 llvm::Constant *AssociatedData = nullptr);
Reid Kleckner563f0e82014-05-23 21:13:45 +00001192 void AddGlobalDtor(llvm::Function *Dtor, int Priority = 65535);
Daniel Dunbar9c426522008-07-29 23:18:29 +00001193
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001194 /// Generates a global array of functions and priorities using the given list
1195 /// and name. This array will have appending linkage and is suitable for use
1196 /// as a LLVM constructor or destructor array.
Daniel Dunbar74aa7e12008-08-01 00:01:51 +00001197 void EmitCtorList(const CtorList &Fns, const char *GlobalName);
1198
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001199 /// Emit any needed decls for which code generation was deferred.
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +00001200 void EmitDeferred();
Daniel Dunbar08b26a02009-02-13 20:29:50 +00001201
Rafael Espindola2e2995b2013-11-05 21:37:29 +00001202 /// Call replaceAllUsesWith on all pairs in Replacements.
1203 void applyReplacements();
1204
Andrey Bokhankocab58582015-08-31 13:20:44 +00001205 /// Call replaceAllUsesWith on all pairs in GlobalValReplacements.
1206 void applyGlobalValReplacements();
1207
Rafael Espindola208b5c02013-10-22 19:26:13 +00001208 void checkAliases();
1209
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001210 /// Emit any vtables which we deferred and still have a use for.
John McCall6bd2a892013-01-25 22:31:03 +00001211 void EmitDeferredVTables();
1212
Rafael Espindola060062a2014-03-06 22:15:10 +00001213 /// Emit the llvm.used and llvm.compiler.used metadata.
1214 void emitLLVMUsed();
Daniel Dunbar23fd4622008-10-01 00:49:24 +00001215
Douglas Gregorbc25ff42013-01-14 20:53:57 +00001216 /// \brief Emit the link options introduced by imported modules.
1217 void EmitModuleLinkOptions();
1218
Richard Smithdf931ce2013-04-06 05:00:46 +00001219 /// \brief Emit aliases for internal-linkage declarations inside "C" language
1220 /// linkage specifications, giving them the "expected" name where possible.
1221 void EmitStaticExternCAliases();
1222
John McCall09ae0322010-07-06 23:57:41 +00001223 void EmitDeclMetadata();
1224
Rafael Espindola3bfa4682013-10-16 19:28:50 +00001225 /// \brief Emit the Clang version as llvm.ident metadata.
1226 void EmitVersionIdentMetadata();
1227
Robert Lytton57765d52014-07-03 09:30:33 +00001228 /// Emits target specific Metadata for global declarations.
1229 void EmitTargetMetadata();
1230
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001231 /// Emit the llvm.gcov metadata used to tell LLVM where to emit the .gcno and
1232 /// .gcda files in a way that persists in .bc files.
Nick Lewycky85c011d2011-05-05 00:08:20 +00001233 void EmitCoverageFile();
Nick Lewycky480cb992011-05-04 20:46:58 +00001234
Nico Webercf4ff5862012-10-11 10:13:44 +00001235 /// Emits the initializer for a uuidof string.
Nico Weber17d3a2c2014-09-08 16:26:36 +00001236 llvm::Constant *EmitUuidofInitializer(StringRef uuidstr);
Nico Webercf4ff5862012-10-11 10:13:44 +00001237
Hans Wennborg43a0f992015-01-10 01:19:48 +00001238 /// Determine whether the definition must be emitted; if this returns \c
1239 /// false, the definition can be emitted lazily if it's used.
1240 bool MustBeEmitted(const ValueDecl *D);
1241
1242 /// Determine whether the definition can be emitted eagerly, or should be
1243 /// delayed until the end of the translation unit. This is relevant for
1244 /// definitions whose linkage can change, e.g. implicit function instantions
1245 /// which may later be explicitly instantiated.
1246 bool MayBeEmittedEagerly(const ValueDecl *D);
John McCall0bdb1fd2010-09-16 06:16:50 +00001247
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001248 /// Check whether we can use a "simpler", more core exceptions personality
1249 /// function.
John McCall0bdb1fd2010-09-16 06:16:50 +00001250 void SimplifyPersonality();
Chris Lattnerf97fe382007-05-24 06:29:05 +00001251};
1252} // end namespace CodeGen
1253} // end namespace clang
Chris Lattnerf97fe382007-05-24 06:29:05 +00001254
Hans Wennborg59dbe862015-09-29 20:56:43 +00001255#endif // LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H