blob: be45bb8ea440e6887f97f69507357a4c790df5e3 [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"
Alexey Bataev94a4f0c2016-03-03 05:21:39 +000024#include "clang/AST/DeclOpenMP.h"
Peter Collingbourneee781d52011-06-14 04:02:39 +000025#include "clang/AST/GlobalDecl.h"
Peter Collingbourne0ff0b372011-01-13 18:57:25 +000026#include "clang/AST/Mangle.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000027#include "clang/Basic/ABI.h"
28#include "clang/Basic/LangOptions.h"
Douglas Gregor6ddfca92013-01-14 17:21:00 +000029#include "clang/Basic/Module.h"
Alexey Samsonov8d043e82014-10-15 19:57:45 +000030#include "clang/Basic/SanitizerBlacklist.h"
Chris Lattnerb6984c42007-06-20 04:44:43 +000031#include "llvm/ADT/DenseMap.h"
Douglas Gregor6ddfca92013-01-14 17:21:00 +000032#include "llvm/ADT/SetVector.h"
Rafael Espindola2e42fec2010-03-04 18:17:24 +000033#include "llvm/ADT/SmallPtrSet.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000034#include "llvm/ADT/StringMap.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/Module.h"
Chandler Carruth61743af2014-03-04 11:18:19 +000036#include "llvm/IR/ValueHandle.h"
Peter Collingbournedc134532016-01-16 00:31:22 +000037#include "llvm/Transforms/Utils/SanitizerStats.h"
Anders Carlsson762e1622009-01-04 02:08:04 +000038
Chris Lattnerf97fe382007-05-24 06:29:05 +000039namespace llvm {
Rafael Espindola42ae7452014-05-09 00:57:59 +000040class Module;
41class Constant;
42class ConstantInt;
43class Function;
44class GlobalValue;
45class DataLayout;
46class FunctionType;
47class LLVMContext;
48class IndexedInstrProfReader;
Alexander Kornienkoab9db512015-06-22 23:07:51 +000049}
Chris Lattner23b7eb62007-06-15 23:05:46 +000050
Chris Lattnerf97fe382007-05-24 06:29:05 +000051namespace clang {
Rafael Espindola42ae7452014-05-09 00:57:59 +000052class 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;
John McCall12f23522016-04-04 18:33:08 +000095class TargetCodeGenInfo;
Justin Bogneref512b92014-01-06 22:27:43 +000096
John McCalld195d4c2016-11-30 23:25:13 +000097enum ForDefinition_t : bool {
98 NotForDefinition = false,
99 ForDefinition = true
100};
101
Rafael Espindola42ae7452014-05-09 00:57:59 +0000102struct OrderGlobalInits {
103 unsigned int priority;
104 unsigned int lex_order;
105 OrderGlobalInits(unsigned int p, unsigned int l)
Chris Lattnere0009072010-06-27 06:32:58 +0000106 : priority(p), lex_order(l) {}
Rafael Espindola42ae7452014-05-09 00:57:59 +0000107
108 bool operator==(const OrderGlobalInits &RHS) const {
109 return priority == RHS.priority && lex_order == RHS.lex_order;
110 }
111
112 bool operator<(const OrderGlobalInits &RHS) const {
113 return std::tie(priority, lex_order) <
114 std::tie(RHS.priority, RHS.lex_order);
115 }
116};
117
John McCallb04ecb72015-10-21 18:06:43 +0000118struct ObjCEntrypoints {
119 ObjCEntrypoints() { memset(this, 0, sizeof(*this)); }
120
Pete Cooper94867712016-03-21 20:50:03 +0000121 /// void objc_autoreleasePoolPop(void*);
John McCall31168b02011-06-15 23:02:42 +0000122 llvm::Constant *objc_autoreleasePoolPop;
123
124 /// void *objc_autoreleasePoolPush(void);
125 llvm::Constant *objc_autoreleasePoolPush;
John McCall31168b02011-06-15 23:02:42 +0000126
127 /// id objc_autorelease(id);
128 llvm::Constant *objc_autorelease;
129
130 /// id objc_autoreleaseReturnValue(id);
131 llvm::Constant *objc_autoreleaseReturnValue;
132
133 /// void objc_copyWeak(id *dest, id *src);
134 llvm::Constant *objc_copyWeak;
135
136 /// void objc_destroyWeak(id*);
137 llvm::Constant *objc_destroyWeak;
138
139 /// id objc_initWeak(id*, id);
140 llvm::Constant *objc_initWeak;
141
142 /// id objc_loadWeak(id*);
143 llvm::Constant *objc_loadWeak;
144
145 /// id objc_loadWeakRetained(id*);
146 llvm::Constant *objc_loadWeakRetained;
147
148 /// void objc_moveWeak(id *dest, id *src);
149 llvm::Constant *objc_moveWeak;
150
151 /// id objc_retain(id);
152 llvm::Constant *objc_retain;
153
154 /// id objc_retainAutorelease(id);
155 llvm::Constant *objc_retainAutorelease;
156
157 /// id objc_retainAutoreleaseReturnValue(id);
158 llvm::Constant *objc_retainAutoreleaseReturnValue;
159
160 /// id objc_retainAutoreleasedReturnValue(id);
161 llvm::Constant *objc_retainAutoreleasedReturnValue;
162
163 /// id objc_retainBlock(id);
164 llvm::Constant *objc_retainBlock;
165
166 /// void objc_release(id);
167 llvm::Constant *objc_release;
168
169 /// id objc_storeStrong(id*, id);
170 llvm::Constant *objc_storeStrong;
171
172 /// id objc_storeWeak(id*, id);
173 llvm::Constant *objc_storeWeak;
174
John McCalle399e5b2016-01-27 18:32:30 +0000175 /// id objc_unsafeClaimAutoreleasedReturnValue(id);
176 llvm::Constant *objc_unsafeClaimAutoreleasedReturnValue;
177
John McCall31168b02011-06-15 23:02:42 +0000178 /// A void(void) inline asm to use to mark that the return value of
179 /// a call will be immediately retain.
180 llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
John McCalleff18842013-03-23 02:35:54 +0000181
182 /// void clang.arc.use(...);
183 llvm::Constant *clang_arc_use;
John McCall31168b02011-06-15 23:02:42 +0000184};
Will Dietzf54319c2013-01-18 11:30:38 +0000185
Justin Bognere2ef2a02014-04-15 21:22:35 +0000186/// This class records statistics on instrumentation based profiling.
Justin Bogner40b8ba12014-06-26 01:45:07 +0000187class InstrProfStats {
188 uint32_t VisitedInMainFile;
189 uint32_t MissingInMainFile;
Justin Bognere2ef2a02014-04-15 21:22:35 +0000190 uint32_t Visited;
191 uint32_t Missing;
192 uint32_t Mismatched;
Justin Bogner40b8ba12014-06-26 01:45:07 +0000193
194public:
195 InstrProfStats()
196 : VisitedInMainFile(0), MissingInMainFile(0), Visited(0), Missing(0),
197 Mismatched(0) {}
198 /// Record that we've visited a function and whether or not that function was
199 /// in the main source file.
200 void addVisited(bool MainFile) {
201 if (MainFile)
202 ++VisitedInMainFile;
203 ++Visited;
204 }
205 /// Record that a function we've visited has no profile data.
206 void addMissing(bool MainFile) {
207 if (MainFile)
208 ++MissingInMainFile;
209 ++Missing;
210 }
211 /// Record that a function we've visited has mismatched profile data.
212 void addMismatched(bool MainFile) { ++Mismatched; }
213 /// Whether or not the stats we've gathered indicate any potential problems.
214 bool hasDiagnostics() { return Missing || Mismatched; }
215 /// Report potential problems we've found to \c Diags.
216 void reportDiagnostics(DiagnosticsEngine &Diags, StringRef MainFile);
Justin Bognere2ef2a02014-04-15 21:22:35 +0000217};
218
John McCallbd96e982015-09-08 08:21:11 +0000219/// A pair of helper functions for a __block variable.
220class BlockByrefHelpers : public llvm::FoldingSetNode {
221 // MSVC requires this type to be complete in order to process this
222 // header.
223public:
224 llvm::Constant *CopyHelper;
225 llvm::Constant *DisposeHelper;
226
227 /// The alignment of the field. This is important because
228 /// different offsets to the field within the byref struct need to
229 /// have different helper functions.
230 CharUnits Alignment;
231
232 BlockByrefHelpers(CharUnits alignment) : Alignment(alignment) {}
233 BlockByrefHelpers(const BlockByrefHelpers &) = default;
234 virtual ~BlockByrefHelpers();
235
236 void Profile(llvm::FoldingSetNodeID &id) const {
237 id.AddInteger(Alignment.getQuantity());
238 profileImpl(id);
239 }
240 virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
241
242 virtual bool needsCopy() const { return true; }
243 virtual void emitCopy(CodeGenFunction &CGF, Address dest, Address src) = 0;
244
245 virtual bool needsDispose() const { return true; }
246 virtual void emitDispose(CodeGenFunction &CGF, Address field) = 0;
247};
248
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000249/// This class organizes the cross-function state that is used while generating
250/// LLVM code.
John McCalle3dc1702011-02-15 09:22:45 +0000251class CodeGenModule : public CodeGenTypeCache {
Aaron Ballmanabc18922015-02-15 22:54:08 +0000252 CodeGenModule(const CodeGenModule &) = delete;
253 void operator=(const CodeGenModule &) = delete;
Anders Carlsson729a8202009-02-24 04:21:31 +0000254
Keno Fischer76f4ab02014-12-30 08:12:39 +0000255public:
Reid Kleckner563f0e82014-05-23 21:13:45 +0000256 struct Structor {
257 Structor() : Priority(0), Initializer(nullptr), AssociatedData(nullptr) {}
258 Structor(int Priority, llvm::Constant *Initializer,
259 llvm::Constant *AssociatedData)
260 : Priority(Priority), Initializer(Initializer),
261 AssociatedData(AssociatedData) {}
262 int Priority;
263 llvm::Constant *Initializer;
264 llvm::Constant *AssociatedData;
265 };
266
267 typedef std::vector<Structor> CtorList;
Daniel Dunbar74aa7e12008-08-01 00:01:51 +0000268
Keno Fischer76f4ab02014-12-30 08:12:39 +0000269private:
Chris Lattnerf97fe382007-05-24 06:29:05 +0000270 ASTContext &Context;
David Blaikiebbafb8a2012-03-11 07:00:24 +0000271 const LangOptions &LangOpts;
Adrian Prantle74f5252015-06-30 02:26:03 +0000272 const HeaderSearchOptions &HeaderSearchOpts; // Only used for debug info.
273 const PreprocessorOptions &PreprocessorOpts; // Only used for debug info.
Chandler Carruthbc55fe22009-11-12 17:24:48 +0000274 const CodeGenOptions &CodeGenOpts;
Chris Lattner23b7eb62007-06-15 23:05:46 +0000275 llvm::Module &TheModule;
David Blaikie9c902b52011-09-25 23:23:43 +0000276 DiagnosticsEngine &Diags;
John McCallc8e01702013-04-16 22:48:15 +0000277 const TargetInfo &Target;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000278 std::unique_ptr<CGCXXABI> ABI;
John McCallc8e01702013-04-16 22:48:15 +0000279 llvm::LLVMContext &VMContext;
Anders Carlssonff971e82009-10-07 01:06:45 +0000280
Reid Kleckner9305fd12016-04-13 23:37:17 +0000281 std::unique_ptr<CodeGenTBAA> TBAA;
John McCallc8e01702013-04-16 22:48:15 +0000282
Reid Kleckner9305fd12016-04-13 23:37:17 +0000283 mutable std::unique_ptr<TargetCodeGenInfo> TheTargetCodeGenInfo;
John McCallc8e01702013-04-16 22:48:15 +0000284
285 // This should not be moved earlier, since its initialization depends on some
286 // of the previous reference members being already initialized and also checks
287 // if TheTargetCodeGenInfo is NULL
288 CodeGenTypes Types;
289
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000290 /// Holds information about C++ vtables.
Anders Carlssona864caf2010-03-23 04:11:45 +0000291 CodeGenVTables VTables;
Douglas Gregorbc6a4342010-04-08 16:07:47 +0000292
Reid Kleckner9305fd12016-04-13 23:37:17 +0000293 std::unique_ptr<CGObjCRuntime> ObjCRuntime;
294 std::unique_ptr<CGOpenCLRuntime> OpenCLRuntime;
295 std::unique_ptr<CGOpenMPRuntime> OpenMPRuntime;
296 std::unique_ptr<CGCUDARuntime> CUDARuntime;
297 std::unique_ptr<CGDebugInfo> DebugInfo;
298 std::unique_ptr<ObjCEntrypoints> ObjCData;
299 llvm::MDNode *NoObjCARCExceptionsMetadata = nullptr;
Justin Bogner837a6f62014-04-18 21:52:00 +0000300 std::unique_ptr<llvm::IndexedInstrProfReader> PGOReader;
Justin Bognere2ef2a02014-04-15 21:22:35 +0000301 InstrProfStats PGOStats;
Peter Collingbournedc134532016-01-16 00:31:22 +0000302 std::unique_ptr<llvm::SanitizerStatReport> SanStats;
Daniel Dunbare49df9b52008-07-30 16:32:24 +0000303
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000304 // A set of references that have only been seen via a weakref so far. This is
305 // used to remove the weak of the reference if we ever see a direct reference
306 // or a definition.
Rafael Espindola2e42fec2010-03-04 18:17:24 +0000307 llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
308
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000309 /// This contains all the decls which have definitions but/ which are deferred
310 /// for emission and therefore should only be output if they are actually
311 /// used. If a decl is in this, then it is known to have not been referenced
312 /// yet.
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000313 std::map<StringRef, GlobalDecl> DeferredDecls;
Daniel Dunbar08b26a02009-02-13 20:29:50 +0000314
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000315 /// This is a list of deferred decls which we have seen that *are* actually
316 /// referenced. These get code generated when the module is done.
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000317 struct DeferredGlobal {
318 DeferredGlobal(llvm::GlobalValue *GV, GlobalDecl GD) : GV(GV), GD(GD) {}
Rafael Espindola6565e922015-01-23 05:26:38 +0000319 llvm::TrackingVH<llvm::GlobalValue> GV;
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000320 GlobalDecl GD;
321 };
322 std::vector<DeferredGlobal> DeferredDeclsToEmit;
323 void addDeferredDeclToEmit(llvm::GlobalValue *GV, GlobalDecl GD) {
Benjamin Kramer3204b152015-05-29 19:42:19 +0000324 DeferredDeclsToEmit.emplace_back(GV, GD);
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000325 }
Daniel Dunbar7dd749e2009-04-15 22:08:45 +0000326
Rafael Espindola208b5c02013-10-22 19:26:13 +0000327 /// List of alias we have emitted. Used to make sure that what they point to
328 /// is defined once we get to the end of the of the translation unit.
329 std::vector<GlobalDecl> Aliases;
330
Rafael Espindola2e2995b2013-11-05 21:37:29 +0000331 typedef llvm::StringMap<llvm::TrackingVH<llvm::Constant> > ReplacementsTy;
332 ReplacementsTy Replacements;
333
Andrey Bokhankocab58582015-08-31 13:20:44 +0000334 /// List of global values to be replaced with something else. Used when we
335 /// want to replace a GlobalValue but can't identify it by its mangled name
336 /// anymore (because the name is already taken).
337 llvm::SmallVector<std::pair<llvm::GlobalValue *, llvm::Constant *>, 8>
338 GlobalValReplacements;
339
340 /// Set of global decls for which we already diagnosed mangled name conflict.
341 /// Required to not issue a warning (on a mangling conflict) multiple times
342 /// for the same decl.
343 llvm::DenseSet<GlobalDecl> DiagnosedConflictingDefinitions;
344
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000345 /// A queue of (optional) vtables to consider emitting.
John McCall6bd2a892013-01-25 22:31:03 +0000346 std::vector<const CXXRecordDecl*> DeferredVTables;
347
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000348 /// List of global values which are required to be present in the object file;
349 /// bitcast to i8*. This is used for forcing visibility of symbols which may
350 /// otherwise be optimized out.
Chris Lattnerf41e87f2009-03-31 22:37:52 +0000351 std::vector<llvm::WeakVH> LLVMUsed;
Rafael Espindola060062a2014-03-06 22:15:10 +0000352 std::vector<llvm::WeakVH> LLVMCompilerUsed;
Mike Stump1676c5b2009-02-13 19:12:34 +0000353
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000354 /// Store the list of global constructors and their respective priorities to
355 /// be emitted when the translation unit is complete.
Daniel Dunbar74aa7e12008-08-01 00:01:51 +0000356 CtorList GlobalCtors;
357
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000358 /// Store the list of global destructors and their respective priorities to be
359 /// emitted when the translation unit is complete.
Daniel Dunbar74aa7e12008-08-01 00:01:51 +0000360 CtorList GlobalDtors;
361
Robert Lytton57765d52014-07-03 09:30:33 +0000362 /// An ordered map of canonical GlobalDecls to their mangled names.
363 llvm::MapVector<GlobalDecl, StringRef> MangledDeclNames;
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000364 llvm::StringMap<GlobalDecl, llvm::BumpPtrAllocator> Manglings;
365
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000366 /// Global annotations.
Nate Begeman7fab5782008-04-18 23:43:57 +0000367 std::vector<llvm::Constant*> Annotations;
Mike Stump1676c5b2009-02-13 19:12:34 +0000368
Julien Lerouge5a6b6982011-09-09 22:41:49 +0000369 /// Map used to get unique annotation strings.
370 llvm::StringMap<llvm::Constant*> AnnotationStrings;
371
David Blaikie2e804282015-04-05 22:47:07 +0000372 llvm::StringMap<llvm::GlobalVariable *> CFConstantStringMap;
David Majnemer58e5bee2014-03-24 21:43:36 +0000373
Richard Smith00db2f12014-07-29 21:20:12 +0000374 llvm::DenseMap<llvm::Constant *, llvm::GlobalVariable *> ConstantStringMap;
Eli Friedman1c8d2ca2012-03-09 03:27:46 +0000375 llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
John McCallb88a5662012-03-30 21:00:39 +0000376 llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
Richard Smithe6c01442013-06-05 00:46:14 +0000377 llvm::DenseMap<const Expr*, llvm::Constant *> MaterializedGlobalTemporaryMap;
378
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000379 llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
380 llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
Daniel Dunbard644ad62008-08-23 18:37:06 +0000381
Will Dietz949ec542013-11-08 01:09:22 +0000382 /// Map used to get unique type descriptor constants for sanitizers.
383 llvm::DenseMap<QualType, llvm::Constant *> TypeDescriptorMap;
384
Richard Smithdf931ce2013-04-06 05:00:46 +0000385 /// Map used to track internal linkage functions declared within
386 /// extern "C" regions.
Richard Smithf21c9612013-04-13 01:28:18 +0000387 typedef llvm::MapVector<IdentifierInfo *,
388 llvm::GlobalValue *> StaticExternCMap;
Richard Smithdf931ce2013-04-06 05:00:46 +0000389 StaticExternCMap StaticExternCValues;
390
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000391 /// \brief thread_local variables defined or used in this TU.
Richard Smith5a99c492015-12-01 01:10:48 +0000392 std::vector<const VarDecl *> CXXThreadLocals;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000393
394 /// \brief thread_local variables with initializers that need to run
395 /// before any thread_local variable in this TU is odr-used.
David Majnemerb3341ea2014-10-05 05:05:40 +0000396 std::vector<llvm::Function *> CXXThreadLocalInits;
Richard Smith5a99c492015-12-01 01:10:48 +0000397 std::vector<const VarDecl *> CXXThreadLocalInitVars;
Richard Smith2fd1d7a2013-04-19 16:42:07 +0000398
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000399 /// Global variables with initializers that need to run before main.
David Majnemerb3341ea2014-10-05 05:05:40 +0000400 std::vector<llvm::Function *> CXXGlobalInits;
John McCall70013b62010-07-15 23:40:35 +0000401
402 /// When a C++ decl with an initializer is deferred, null is
403 /// appended to CXXGlobalInits, and the index of that null is placed
404 /// here so that the initializer will be performed in the correct
Reid Klecknere07140e2015-04-15 01:08:06 +0000405 /// order. Once the decl is emitted, the index is replaced with ~0U to ensure
406 /// that we don't re-emit the initializer.
John McCall70013b62010-07-15 23:40:35 +0000407 llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
Fariborz Jahanian9f2a4ee2010-06-21 18:45:05 +0000408
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000409 typedef std::pair<OrderGlobalInits, llvm::Function*> GlobalInitData;
410
411 struct GlobalInitPriorityCmp {
412 bool operator()(const GlobalInitData &LHS,
413 const GlobalInitData &RHS) const {
414 return LHS.first.priority < RHS.first.priority;
415 }
416 };
417
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000418 /// Global variables with initializers whose order of initialization is set by
419 /// init_priority attribute.
Anton Korobeynikovabed7492012-11-06 22:44:45 +0000420 SmallVector<GlobalInitData, 8> PrioritizedCXXGlobalInits;
Mike Stump11289f42009-09-09 15:08:12 +0000421
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000422 /// Global destructor functions and arguments that need to run on termination.
Chris Lattner87233f72010-06-19 05:52:45 +0000423 std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors;
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000424
Douglas Gregor6ddfca92013-01-14 17:21:00 +0000425 /// \brief The complete set of modules that has been imported.
426 llvm::SetVector<clang::Module *> ImportedModules;
427
Manman Ren3b5dbf22016-10-14 18:55:44 +0000428 /// \brief The set of modules for which the module initializers
429 /// have been emitted.
430 llvm::SmallPtrSet<clang::Module *, 16> EmittedModuleInitializers;
431
Reid Klecknere43f0fe2013-05-08 13:44:39 +0000432 /// \brief A vector of metadata strings.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000433 SmallVector<llvm::Metadata *, 16> LinkerOptionsMetadata;
Reid Klecknere43f0fe2013-05-08 13:44:39 +0000434
Douglas Gregorabf4e0d2011-08-09 15:54:21 +0000435 /// @name Cache for Objective-C runtime types
436 /// @{
437
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000438 /// Cached reference to the class for constant strings. This value has type
439 /// int * but is actually an Obj-C class pointer.
Fariborz Jahaniand1b67782013-04-16 15:25:39 +0000440 llvm::WeakVH CFConstantStringClassRef;
Mike Stump11289f42009-09-09 15:08:12 +0000441
Douglas Gregor636e2002011-08-09 17:23:49 +0000442 /// \brief The type used to describe the state of a fast enumeration in
443 /// Objective-C's for..in loop.
444 QualType ObjCFastEnumerationStateType;
445
Douglas Gregorabf4e0d2011-08-09 15:54:21 +0000446 /// @}
447
David Chisnall481e3a82010-01-23 02:40:42 +0000448 /// Lazily create the Objective-C runtime
449 void createObjCRuntime();
450
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000451 void createOpenCLRuntime();
Alexey Bataev9959db52014-05-06 10:08:46 +0000452 void createOpenMPRuntime();
Peter Collingbournefe883422011-10-06 18:29:37 +0000453 void createCUDARuntime();
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000454
Rafael Espindola4fdc1752011-12-19 14:41:01 +0000455 bool isTriviallyRecursive(const FunctionDecl *F);
Peter Collingbourne4d90dba2013-06-05 17:49:37 +0000456 bool shouldEmitFunction(GlobalDecl GD);
Daniel Dunbar900546d2010-07-16 00:00:15 +0000457
458 /// @name Cache for Blocks Runtime Globals
459 /// @{
460
Reid Kleckner9305fd12016-04-13 23:37:17 +0000461 llvm::Constant *NSConcreteGlobalBlock = nullptr;
462 llvm::Constant *NSConcreteStackBlock = nullptr;
Daniel Dunbar3348e2d2010-07-16 00:00:19 +0000463
Reid Kleckner9305fd12016-04-13 23:37:17 +0000464 llvm::Constant *BlockObjectAssign = nullptr;
465 llvm::Constant *BlockObjectDispose = nullptr;
Daniel Dunbar900546d2010-07-16 00:00:15 +0000466
Reid Kleckner9305fd12016-04-13 23:37:17 +0000467 llvm::Type *BlockDescriptorType = nullptr;
468 llvm::Type *GenericBlockLiteralType = nullptr;
John McCallad7c5c12011-02-08 08:22:06 +0000469
470 struct {
471 int GlobalUniqueCount;
472 } Block;
Will Dietzf54319c2013-01-18 11:30:38 +0000473
Nadav Rotem1da30942013-03-23 06:43:35 +0000474 /// void @llvm.lifetime.start(i64 %size, i8* nocapture <ptr>)
Reid Kleckner9305fd12016-04-13 23:37:17 +0000475 llvm::Constant *LifetimeStartFn = nullptr;
Nadav Rotem1da30942013-03-23 06:43:35 +0000476
477 /// void @llvm.lifetime.end(i64 %size, i8* nocapture <ptr>)
Reid Kleckner9305fd12016-04-13 23:37:17 +0000478 llvm::Constant *LifetimeEndFn = nullptr;
Nadav Rotem1da30942013-03-23 06:43:35 +0000479
Fariborz Jahanian63628032012-06-26 16:06:38 +0000480 GlobalDecl initializedGlobalDecl;
John McCallad7c5c12011-02-08 08:22:06 +0000481
Alexey Samsonov4b8de112014-08-01 21:35:28 +0000482 std::unique_ptr<SanitizerMetadata> SanitizerMD;
483
Daniel Dunbar900546d2010-07-16 00:00:15 +0000484 /// @}
Alex Lorenzee024992014-08-04 18:41:51 +0000485
486 llvm::DenseMap<const Decl *, bool> DeferredEmptyCoverageMappingDecls;
487
488 std::unique_ptr<CoverageMappingModuleGen> CoverageMapping;
Peter Collingbourne25a80bf2015-09-08 23:01:30 +0000489
490 /// Mapping from canonical types to their metadata identifiers. We need to
491 /// maintain this mapping because identifiers may be formed from distinct
492 /// MDNodes.
493 llvm::DenseMap<QualType, llvm::Metadata *> MetadataIdMap;
494
Chris Lattnerf97fe382007-05-24 06:29:05 +0000495public:
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000496 CodeGenModule(ASTContext &C, const HeaderSearchOptions &headersearchopts,
Adrian Prantle74f5252015-06-30 02:26:03 +0000497 const PreprocessorOptions &ppopts,
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000498 const CodeGenOptions &CodeGenOpts, llvm::Module &M,
Alex Lorenzee024992014-08-04 18:41:51 +0000499 DiagnosticsEngine &Diags,
500 CoverageSourceInfo *CoverageInfo = nullptr);
Ted Kremenek2c674f62008-08-05 18:50:11 +0000501
Chris Lattnera087ff92008-03-01 08:45:05 +0000502 ~CodeGenModule();
Mike Stump1676c5b2009-02-13 19:12:34 +0000503
Rafael Espindolac0ff7442013-12-09 14:59:08 +0000504 void clear();
505
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000506 /// Finalize LLVM code generation.
Ted Kremenek2c674f62008-08-05 18:50:11 +0000507 void Release();
Daniel Dunbar8d480592008-08-11 18:12:00 +0000508
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000509 /// Return a reference to the configured Objective-C runtime.
Mike Stump1676c5b2009-02-13 19:12:34 +0000510 CGObjCRuntime &getObjCRuntime() {
Peter Collingbournee1d20992011-07-27 20:29:46 +0000511 if (!ObjCRuntime) createObjCRuntime();
512 return *ObjCRuntime;
Daniel Dunbar8d480592008-08-11 18:12:00 +0000513 }
Mike Stump1676c5b2009-02-13 19:12:34 +0000514
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000515 /// Return true iff an Objective-C runtime has been configured.
Peter Collingbournee1d20992011-07-27 20:29:46 +0000516 bool hasObjCRuntime() { return !!ObjCRuntime; }
Daniel Dunbar8d480592008-08-11 18:12:00 +0000517
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000518 /// Return a reference to the configured OpenCL runtime.
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000519 CGOpenCLRuntime &getOpenCLRuntime() {
Craig Topper8a13c412014-05-21 05:09:00 +0000520 assert(OpenCLRuntime != nullptr);
Peter Collingbourne2dbb7082011-09-19 21:14:35 +0000521 return *OpenCLRuntime;
522 }
523
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000524 /// Return a reference to the configured OpenMP runtime.
Alexey Bataev9959db52014-05-06 10:08:46 +0000525 CGOpenMPRuntime &getOpenMPRuntime() {
526 assert(OpenMPRuntime != nullptr);
527 return *OpenMPRuntime;
528 }
529
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000530 /// Return a reference to the configured CUDA runtime.
Peter Collingbournefe883422011-10-06 18:29:37 +0000531 CGCUDARuntime &getCUDARuntime() {
Craig Topper8a13c412014-05-21 05:09:00 +0000532 assert(CUDARuntime != nullptr);
Peter Collingbournefe883422011-10-06 18:29:37 +0000533 return *CUDARuntime;
534 }
535
John McCallb04ecb72015-10-21 18:06:43 +0000536 ObjCEntrypoints &getObjCEntrypoints() const {
537 assert(ObjCData != nullptr);
538 return *ObjCData;
John McCall31168b02011-06-15 23:02:42 +0000539 }
540
Justin Bogner837a6f62014-04-18 21:52:00 +0000541 InstrProfStats &getPGOStats() { return PGOStats; }
542 llvm::IndexedInstrProfReader *getPGOReader() const { return PGOReader.get(); }
Justin Bogneref512b92014-01-06 22:27:43 +0000543
Alex Lorenzee024992014-08-04 18:41:51 +0000544 CoverageMappingModuleGen *getCoverageMapping() const {
545 return CoverageMapping.get();
546 }
547
Eli Friedman1c8d2ca2012-03-09 03:27:46 +0000548 llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
549 return StaticLocalDeclMap[D];
Fariborz Jahanian3fef72f2010-04-18 21:01:23 +0000550 }
Fariborz Jahanian4d55b2d2010-04-19 18:15:02 +0000551 void setStaticLocalDeclAddress(const VarDecl *D,
Eli Friedman1c8d2ca2012-03-09 03:27:46 +0000552 llvm::Constant *C) {
553 StaticLocalDeclMap[D] = C;
Fariborz Jahanian3fef72f2010-04-18 21:01:23 +0000554 }
555
Reid Kleckner453e0562014-10-08 01:07:54 +0000556 llvm::Constant *
557 getOrCreateStaticVarDecl(const VarDecl &D,
558 llvm::GlobalValue::LinkageTypes Linkage);
559
John McCallb88a5662012-03-30 21:00:39 +0000560 llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
561 return StaticLocalDeclGuardMap[D];
562 }
563 void setStaticLocalDeclGuardAddress(const VarDecl *D,
564 llvm::GlobalVariable *C) {
565 StaticLocalDeclGuardMap[D] = C;
566 }
567
Alp Tokerfb8d02b2014-06-05 22:10:59 +0000568 bool lookupRepresentativeDecl(StringRef MangledName,
569 GlobalDecl &Result) const;
570
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000571 llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
572 return AtomicSetterHelperFnMap[Ty];
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +0000573 }
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000574 void setAtomicSetterHelperFnMap(QualType Ty,
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +0000575 llvm::Constant *Fn) {
Fariborz Jahanian1bed4132012-01-08 19:13:23 +0000576 AtomicSetterHelperFnMap[Ty] = Fn;
577 }
578
579 llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
580 return AtomicGetterHelperFnMap[Ty];
581 }
582 void setAtomicGetterHelperFnMap(QualType Ty,
583 llvm::Constant *Fn) {
584 AtomicGetterHelperFnMap[Ty] = Fn;
Fariborz Jahanian7ff610b2012-01-06 22:33:54 +0000585 }
586
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000587 llvm::Constant *getTypeDescriptorFromMap(QualType Ty) {
Will Dietz949ec542013-11-08 01:09:22 +0000588 return TypeDescriptorMap[Ty];
589 }
Warren Hunt5c2b4ea2014-05-23 16:07:43 +0000590 void setTypeDescriptorInMap(QualType Ty, llvm::Constant *C) {
Will Dietz949ec542013-11-08 01:09:22 +0000591 TypeDescriptorMap[Ty] = C;
592 }
593
Reid Kleckner9305fd12016-04-13 23:37:17 +0000594 CGDebugInfo *getModuleDebugInfo() { return DebugInfo.get(); }
Devang Patele65982c2011-03-07 18:29:53 +0000595
Dan Gohman515a60d2012-02-16 00:57:37 +0000596 llvm::MDNode *getNoObjCARCExceptionsMetadata() {
597 if (!NoObjCARCExceptionsMetadata)
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000598 NoObjCARCExceptionsMetadata = llvm::MDNode::get(getLLVMContext(), None);
Dan Gohman515a60d2012-02-16 00:57:37 +0000599 return NoObjCARCExceptionsMetadata;
600 }
601
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000602 ASTContext &getContext() const { return Context; }
David Blaikiebbafb8a2012-03-11 07:00:24 +0000603 const LangOptions &getLangOpts() const { return LangOpts; }
Adrian Prantle74f5252015-06-30 02:26:03 +0000604 const HeaderSearchOptions &getHeaderSearchOpts()
605 const { return HeaderSearchOpts; }
606 const PreprocessorOptions &getPreprocessorOpts()
607 const { return PreprocessorOpts; }
John McCallc8e01702013-04-16 22:48:15 +0000608 const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
Chris Lattner23b7eb62007-06-15 23:05:46 +0000609 llvm::Module &getModule() const { return TheModule; }
David Blaikie9c902b52011-09-25 23:23:43 +0000610 DiagnosticsEngine &getDiags() const { return Diags; }
Mehdi Aminica3cf9e2015-07-24 16:04:29 +0000611 const llvm::DataLayout &getDataLayout() const {
612 return TheModule.getDataLayout();
613 }
John McCallc8e01702013-04-16 22:48:15 +0000614 const TargetInfo &getTarget() const { return Target; }
Saleem Abdulrasool7246dcc2016-09-14 15:17:46 +0000615 const llvm::Triple &getTriple() const { return Target.getTriple(); }
Rafael Espindola9f834732014-09-19 01:54:22 +0000616 bool supportsCOMDAT() const;
Rafael Espindoladbee8a72015-01-15 21:36:08 +0000617 void maybeSetTrivialComdat(const Decl &D, llvm::GlobalObject &GO);
Rafael Espindola9f834732014-09-19 01:54:22 +0000618
Alp Toker82862252013-12-28 21:58:40 +0000619 CGCXXABI &getCXXABI() const { return *ABI; }
Owen Anderson170229f2009-07-14 23:10:40 +0000620 llvm::LLVMContext &getLLVMContext() { return VMContext; }
Craig Topper8a13c412014-05-21 05:09:00 +0000621
622 bool shouldUseTBAA() const { return TBAA != nullptr; }
John McCall53fcbd22011-02-26 08:07:02 +0000623
John McCallc8e01702013-04-16 22:48:15 +0000624 const TargetCodeGenInfo &getTargetCodeGenInfo();
625
626 CodeGenTypes &getTypes() { return Types; }
627
628 CodeGenVTables &getVTables() { return VTables; }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000629
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000630 ItaniumVTableContext &getItaniumVTableContext() {
631 return VTables.getItaniumVTableContext();
Timur Iskhodzhanove1ebc5f2013-10-09 11:33:51 +0000632 }
John McCallc8e01702013-04-16 22:48:15 +0000633
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000634 MicrosoftVTableContext &getMicrosoftVTableContext() {
635 return VTables.getMicrosoftVTableContext();
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000636 }
637
Keno Fischer76f4ab02014-12-30 08:12:39 +0000638 CtorList &getGlobalCtors() { return GlobalCtors; }
639 CtorList &getGlobalDtors() { return GlobalDtors; }
640
Dan Gohman947c9af2010-10-14 23:06:10 +0000641 llvm::MDNode *getTBAAInfo(QualType QTy);
Kostya Serebryany141e46f2012-03-26 17:03:51 +0000642 llvm::MDNode *getTBAAInfoForVTablePtr();
Dan Gohman22695fc2012-09-28 21:58:29 +0000643 llvm::MDNode *getTBAAStructInfo(QualType QTy);
Manman Renc451e572013-04-04 21:53:22 +0000644 /// Return the path-aware tag for given base type, access node and offset.
645 llvm::MDNode *getTBAAStructTagInfo(QualType BaseTy, llvm::MDNode *AccessN,
646 uint64_t O);
Dan Gohman947c9af2010-10-14 23:06:10 +0000647
Richard Smithe070fd22012-02-17 06:48:11 +0000648 bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
649
John McCalla8ec7eb2013-03-07 21:37:17 +0000650 bool isPaddedAtomicType(QualType type);
651 bool isPaddedAtomicType(const AtomicType *type);
652
Manman Rene1ad74e2013-04-11 23:02:56 +0000653 /// Decorate the instruction with a TBAA tag. For scalar TBAA, the tag
654 /// is the same as the type. For struct-path aware TBAA, the tag
655 /// is different from the type: base type, access type and offset.
656 /// When ConvertTypeToTag is true, we create a tag based on the scalar type.
Piotr Padlewski4b1ac722015-09-15 21:46:55 +0000657 void DecorateInstructionWithTBAA(llvm::Instruction *Inst,
658 llvm::MDNode *TBAAInfo,
659 bool ConvertTypeToTag = true);
660
661 /// Adds !invariant.barrier !tag to instruction
662 void DecorateInstructionWithInvariantGroup(llvm::Instruction *I,
663 const CXXRecordDecl *RD);
Dan Gohman947c9af2010-10-14 23:06:10 +0000664
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000665 /// Emit the given number of characters as a value of type size_t.
John McCall23c29fe2011-06-24 21:55:10 +0000666 llvm::ConstantInt *getSize(CharUnits numChars);
667
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000668 /// Set the visibility for the given LLVM GlobalValue.
Anders Carlssonc6a47892011-01-29 19:39:23 +0000669 void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
Daniel Dunbarf5f359f2009-04-14 06:00:08 +0000670
David Majnemerbb525f7c2014-10-15 22:38:23 +0000671 /// Set the TLS mode for the given LLVM GlobalValue for the thread-local
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000672 /// variable declaration D.
David Majnemerbb525f7c2014-10-15 22:38:23 +0000673 void setTLSMode(llvm::GlobalValue *GV, const VarDecl &D) const;
Hans Wennborgf60f6af2012-06-28 08:01:44 +0000674
Anders Carlsson537fdce2011-01-29 20:59:35 +0000675 static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
676 switch (V) {
677 case DefaultVisibility: return llvm::GlobalValue::DefaultVisibility;
678 case HiddenVisibility: return llvm::GlobalValue::HiddenVisibility;
679 case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
680 }
681 llvm_unreachable("unknown visibility!");
Anders Carlsson537fdce2011-01-29 20:59:35 +0000682 }
683
John McCalld195d4c2016-11-30 23:25:13 +0000684 llvm::Constant *GetAddrOfGlobal(GlobalDecl GD,
685 ForDefinition_t IsForDefinition
686 = NotForDefinition);
John McCalld4324142010-02-19 01:32:20 +0000687
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000688 /// Will return a global variable of the given type. If a variable with a
689 /// different type already exists then a new variable with the right type
690 /// will be created and all uses of the old variable will be replaced with a
691 /// bitcast to the new variable.
Anders Carlssonda80af32011-01-29 18:20:20 +0000692 llvm::GlobalVariable *
Chris Lattner01cf8db2011-07-20 06:58:45 +0000693 CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty,
Anders Carlssonda80af32011-01-29 18:20:20 +0000694 llvm::GlobalValue::LinkageTypes Linkage);
695
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000696 llvm::Function *
697 CreateGlobalInitOrDestructFunction(llvm::FunctionType *ty, const Twine &name,
Akira Hatanaka7791f1a42015-10-31 01:28:07 +0000698 const CGFunctionInfo &FI,
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000699 SourceLocation Loc = SourceLocation(),
700 bool TLS = false);
David Majnemerb3341ea2014-10-05 05:05:40 +0000701
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000702 /// Return the address space of the underlying global variable for D, as
703 /// determined by its declaration. Normally this is the same as the address
704 /// space of D's type, but in CUDA, address spaces are associated with
705 /// declarations, not types.
Peter Collingbournef44bdf92012-05-20 21:08:35 +0000706 unsigned GetGlobalVarAddressSpace(const VarDecl *D, unsigned AddrSpace);
707
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000708 /// Return the llvm::Constant for the address of the given global variable.
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +0000709 /// If Ty is non-null and if the global doesn't exist, then it will be created
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000710 /// with the specified type instead of whatever the normal requested type
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +0000711 /// would be. If IsForDefinition is true, it is guranteed that an actual
712 /// global with type Ty will be returned, not conversion of a variable with
713 /// the same mangled name but some other type.
Chris Lattner149927c2009-03-21 09:16:30 +0000714 llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +0000715 llvm::Type *Ty = nullptr,
John McCalld195d4c2016-11-30 23:25:13 +0000716 ForDefinition_t IsForDefinition
717 = NotForDefinition);
Daniel Dunbar9c426522008-07-29 23:18:29 +0000718
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000719 /// Return the address of the given function. If Ty is non-null, then this
720 /// function will use the specified type if it has to create it.
Hans Wennborg59dbe862015-09-29 20:56:43 +0000721 llvm::Constant *GetAddrOfFunction(GlobalDecl GD, llvm::Type *Ty = nullptr,
Rafael Espindola94abb8f2013-12-09 04:29:47 +0000722 bool ForVTable = false,
Andrey Bokhankocab58582015-08-31 13:20:44 +0000723 bool DontDefer = false,
John McCalld195d4c2016-11-30 23:25:13 +0000724 ForDefinition_t IsForDefinition
725 = NotForDefinition);
Daniel Dunbarc4baa062008-08-13 23:20:05 +0000726
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000727 /// Get the address of the RTTI descriptor for the given type.
John McCall48bf3492010-04-30 01:15:21 +0000728 llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
Anders Carlssonfd7dfeb2009-12-11 02:46:30 +0000729
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000730 /// Get the address of a uuid descriptor .
John McCall7f416cc2015-09-08 08:05:57 +0000731 ConstantAddress GetAddrOfUuidDescriptor(const CXXUuidofExpr* E);
Nico Webercf4ff5862012-10-11 10:13:44 +0000732
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000733 /// Get the address of the thunk for the given global decl.
Anders Carlssonfe8a9932011-02-06 17:15:43 +0000734 llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk);
Anders Carlssoncd836f02010-03-23 17:17:29 +0000735
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000736 /// Get a reference to the target of VD.
John McCall7f416cc2015-09-08 08:05:57 +0000737 ConstantAddress GetWeakRefReference(const ValueDecl *VD);
738
739 /// Returns the assumed alignment of an opaque pointer to the given class.
740 CharUnits getClassPointerAlignment(const CXXRecordDecl *CD);
741
742 /// Returns the assumed alignment of a virtual base of a class.
743 CharUnits getVBaseAlignment(CharUnits DerivedAlign,
744 const CXXRecordDecl *Derived,
745 const CXXRecordDecl *VBase);
746
747 /// Given a class pointer with an actual known alignment, and the
748 /// expected alignment of an object at a dynamic offset w.r.t that
749 /// pointer, return the alignment to assume at the offset.
750 CharUnits getDynamicOffsetAlignment(CharUnits ActualAlign,
751 const CXXRecordDecl *Class,
752 CharUnits ExpectedTargetAlign);
Rafael Espindola2e42fec2010-03-04 18:17:24 +0000753
David Majnemerc1709d32015-06-23 07:31:11 +0000754 CharUnits
755 computeNonVirtualBaseClassOffset(const CXXRecordDecl *DerivedClass,
756 CastExpr::path_const_iterator Start,
757 CastExpr::path_const_iterator End);
758
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000759 /// Returns the offset from a derived class to a class. Returns null if the
760 /// offset is 0.
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000761 llvm::Constant *
762 GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
John McCallcf142162010-08-07 06:22:56 +0000763 CastExpr::path_const_iterator PathBegin,
764 CastExpr::path_const_iterator PathEnd);
John McCallad7c5c12011-02-08 08:22:06 +0000765
John McCall7f416cc2015-09-08 08:05:57 +0000766 llvm::FoldingSet<BlockByrefHelpers> ByrefHelpersCache;
John McCallad7c5c12011-02-08 08:22:06 +0000767
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000768 /// Fetches the global unique block count.
John McCall147d0212011-02-22 22:38:33 +0000769 int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
Fariborz Jahanian63628032012-06-26 16:06:38 +0000770
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000771 /// Fetches the type of a generic block descriptor.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000772 llvm::Type *getBlockDescriptorType();
John McCallad7c5c12011-02-08 08:22:06 +0000773
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000774 /// The type of a generic block literal.
Chris Lattnera5f58b02011-07-09 17:41:47 +0000775 llvm::Type *getGenericBlockLiteralType();
John McCallad7c5c12011-02-08 08:22:06 +0000776
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000777 /// Gets the address of a block which requires no captures.
George Burgess IV70d15b32016-11-03 02:21:43 +0000778 llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, StringRef Name);
Anders Carlsson8a64c1c2010-04-24 21:23:59 +0000779
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000780 /// Return a pointer to a constant CFString object for the given string.
John McCall7f416cc2015-09-08 08:05:57 +0000781 ConstantAddress GetAddrOfConstantCFString(const StringLiteral *Literal);
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000782
783 /// Return a pointer to a constant NSString object for the given string. Or a
784 /// user defined String object as defined via
Fariborz Jahanian50c925f2010-10-19 17:19:29 +0000785 /// -fconstant-string-class=class_name option.
John McCall7f416cc2015-09-08 08:05:57 +0000786 ConstantAddress GetAddrOfConstantString(const StringLiteral *Literal);
Chris Lattner36fc8792008-02-11 00:02:17 +0000787
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000788 /// Return a constant array for the given string.
Eli Friedmanfcec6302011-11-01 02:23:42 +0000789 llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
790
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000791 /// Return a pointer to a constant array for the given string literal.
John McCall7f416cc2015-09-08 08:05:57 +0000792 ConstantAddress
Alexey Bataevec474782014-10-09 08:45:04 +0000793 GetAddrOfConstantStringFromLiteral(const StringLiteral *S,
794 StringRef Name = ".str");
Daniel Dunbar6dfdf8c2008-08-10 20:25:57 +0000795
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000796 /// Return a pointer to a constant array for the given ObjCEncodeExpr node.
John McCall7f416cc2015-09-08 08:05:57 +0000797 ConstantAddress
Alexey Samsonovb2cc23d2014-07-10 22:18:36 +0000798 GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
Mike Stump11289f42009-09-09 15:08:12 +0000799
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000800 /// Returns a pointer to a character array containing the literal and a
801 /// terminating '\0' character. The result has pointer to array type.
Daniel Dunbardfcf5992008-10-17 21:56:50 +0000802 ///
Mike Stump1676c5b2009-02-13 19:12:34 +0000803 /// \param GlobalName If provided, the name to use for the global (if one is
804 /// created).
John McCall7f416cc2015-09-08 08:05:57 +0000805 ConstantAddress
Alexey Samsonovb2cc23d2014-07-10 22:18:36 +0000806 GetAddrOfConstantCString(const std::string &Str,
John McCall7f416cc2015-09-08 08:05:57 +0000807 const char *GlobalName = nullptr);
Richard Smith2d988f02011-11-22 22:48:32 +0000808
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000809 /// Returns a pointer to a constant global variable for the given file-scope
810 /// compound literal expression.
John McCall7f416cc2015-09-08 08:05:57 +0000811 ConstantAddress GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
Richard Smithe6c01442013-06-05 00:46:14 +0000812
813 /// \brief Returns a pointer to a global variable representing a temporary
814 /// with static or thread storage duration.
John McCall7f416cc2015-09-08 08:05:57 +0000815 ConstantAddress GetAddrOfGlobalTemporary(const MaterializeTemporaryExpr *E,
Richard Smithe6c01442013-06-05 00:46:14 +0000816 const Expr *Inner);
817
Douglas Gregor636e2002011-08-09 17:23:49 +0000818 /// \brief Retrieve the record type that describes the state of an
819 /// Objective-C fast enumeration loop (for..in).
820 QualType getObjCFastEnumerationStateType();
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000821
Rafael Espindola53686182014-09-15 19:34:18 +0000822 // Produce code for this constructor/destructor. This method doesn't try
823 // to apply any ABI rules about which other constructors/destructors
824 // are needed or if they are alias to each other.
825 llvm::Function *codegenCXXStructor(const CXXMethodDecl *MD,
826 StructorType Type);
827
Rafael Espindola1ac0ec82014-09-11 15:42:06 +0000828 /// Return the address of the constructor/destructor of the given type.
Andrey Bokhankocab58582015-08-31 13:20:44 +0000829 llvm::Constant *
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000830 getAddrOfCXXStructor(const CXXMethodDecl *MD, StructorType Type,
831 const CGFunctionInfo *FnInfo = nullptr,
832 llvm::FunctionType *FnType = nullptr,
John McCalld195d4c2016-11-30 23:25:13 +0000833 bool DontDefer = false,
834 ForDefinition_t IsForDefinition = NotForDefinition);
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000835
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000836 /// Given a builtin id for a function like "__builtin_fabsf", return a
837 /// Function* for "fabsf".
John McCallb92ab1a2016-10-26 23:46:34 +0000838 llvm::Constant *getBuiltinLibFunction(const FunctionDecl *FD,
839 unsigned BuiltinID);
Daniel Dunbarc4baa062008-08-13 23:20:05 +0000840
Dmitri Gribenko44ebbd52013-05-05 00:41:58 +0000841 llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys = None);
Daniel Dunbar9c426522008-07-29 23:18:29 +0000842
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000843 /// Emit code for a single top level declaration.
Daniel Dunbarfce4be82008-08-15 23:26:23 +0000844 void EmitTopLevelDecl(Decl *D);
Daniel Dunbar9c426522008-07-29 23:18:29 +0000845
Alex Lorenzee024992014-08-04 18:41:51 +0000846 /// \brief Stored a deferred empty coverage mapping for an unused
847 /// and thus uninstrumented top level declaration.
848 void AddDeferredUnusedCoverageMapping(Decl *D);
849
850 /// \brief Remove the deferred empty coverage mapping as this
851 /// declaration is actually instrumented.
852 void ClearUnusedCoverageMapping(const Decl *D);
853
854 /// \brief Emit all the deferred coverage mappings
855 /// for the uninstrumented functions.
856 void EmitDeferredUnusedCoverageMappings();
857
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000858 /// Tell the consumer that this variable has been instantiated.
Rafael Espindoladf88f6f2012-03-08 15:51:03 +0000859 void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
Rafael Espindola189fa742012-03-05 10:54:55 +0000860
Richard Smithdf931ce2013-04-06 05:00:46 +0000861 /// \brief If the declaration has internal linkage but is inside an
862 /// extern "C" linkage specification, prepare to emit an alias for it
863 /// to the expected name.
864 template<typename SomeDecl>
865 void MaybeHandleStaticInExternC(const SomeDecl *D, llvm::GlobalValue *GV);
866
Rafael Espindola060062a2014-03-06 22:15:10 +0000867 /// Add a global to a list to be added to the llvm.used metadata.
868 void addUsedGlobal(llvm::GlobalValue *GV);
869
870 /// Add a global to a list to be added to the llvm.compiler.used metadata.
871 void addCompilerUsedGlobal(llvm::GlobalValue *GV);
Daniel Dunbar08b26a02009-02-13 20:29:50 +0000872
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000873 /// Add a destructor and object to add to the C++ global destructor function.
Chris Lattner87233f72010-06-19 05:52:45 +0000874 void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) {
Benjamin Kramer3204b152015-05-29 19:42:19 +0000875 CXXGlobalDtors.emplace_back(DtorFn, Object);
Chris Lattner87233f72010-06-19 05:52:45 +0000876 }
Daniel Dunbarfe06df42010-03-20 04:15:41 +0000877
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000878 /// Create a new runtime function with the specified type and name.
Chris Lattner2192fe52011-07-18 04:24:23 +0000879 llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty,
Chris Lattner01cf8db2011-07-20 06:58:45 +0000880 StringRef Name,
Bill Wendling8594fcb2013-01-31 00:30:05 +0000881 llvm::AttributeSet ExtraAttrs =
882 llvm::AttributeSet());
Anton Korobeynikovd90dd792014-12-02 16:04:58 +0000883 /// Create a new compiler builtin function with the specified type and name.
884 llvm::Constant *CreateBuiltinFunction(llvm::FunctionType *Ty,
885 StringRef Name,
886 llvm::AttributeSet ExtraAttrs =
887 llvm::AttributeSet());
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000888 /// Create a new runtime global variable with the specified type and name.
Chris Lattner2192fe52011-07-18 04:24:23 +0000889 llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
Chris Lattner01cf8db2011-07-20 06:58:45 +0000890 StringRef Name);
Daniel Dunbar23fd4622008-10-01 00:49:24 +0000891
Daniel Dunbar900546d2010-07-16 00:00:15 +0000892 ///@name Custom Blocks Runtime Interfaces
893 ///@{
894
895 llvm::Constant *getNSConcreteGlobalBlock();
896 llvm::Constant *getNSConcreteStackBlock();
897 llvm::Constant *getBlockObjectAssign();
898 llvm::Constant *getBlockObjectDispose();
899
900 ///@}
901
Nadav Rotem1da30942013-03-23 06:43:35 +0000902 llvm::Constant *getLLVMLifetimeStartFn();
903 llvm::Constant *getLLVMLifetimeEndFn();
904
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000905 // Make sure that this type is translated.
Devang Patel945b8ae2011-03-23 16:29:39 +0000906 void UpdateCompletedType(const TagDecl *TD);
Daniel Dunbar38ad1e62009-02-17 18:43:32 +0000907
John McCallf3a88602011-02-03 08:15:49 +0000908 llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
909
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000910 /// Try to emit the initializer for the given declaration as a constant;
911 /// returns 0 if the expression cannot be emitted as a constant.
Craig Topper8a13c412014-05-21 05:09:00 +0000912 llvm::Constant *EmitConstantInit(const VarDecl &D,
913 CodeGenFunction *CGF = nullptr);
Richard Smithdafff942012-01-14 04:30:29 +0000914
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000915 /// Try to emit the given expression as a constant; returns 0 if the
916 /// expression cannot be emitted as a constant.
Anders Carlsson80f97ab2009-04-08 04:48:15 +0000917 llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType,
Craig Topper8a13c412014-05-21 05:09:00 +0000918 CodeGenFunction *CGF = nullptr);
Daniel Dunbar38ad1e62009-02-17 18:43:32 +0000919
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000920 /// Emit the given constant value as a constant, in the type's scalar
921 /// representation.
Richard Smithdafff942012-01-14 04:30:29 +0000922 llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType,
Craig Topper8a13c412014-05-21 05:09:00 +0000923 CodeGenFunction *CGF = nullptr);
Richard Smithdafff942012-01-14 04:30:29 +0000924
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000925 /// Emit the given constant value as a constant, in the type's memory
926 /// representation.
Richard Smithbc6387672012-03-02 23:27:11 +0000927 llvm::Constant *EmitConstantValueForMemory(const APValue &Value,
928 QualType DestType,
Craig Topper8a13c412014-05-21 05:09:00 +0000929 CodeGenFunction *CGF = nullptr);
Richard Smithbc6387672012-03-02 23:27:11 +0000930
Alexey Bataev2bf9b4c2015-10-20 04:24:12 +0000931 /// \brief Emit type info if type of an expression is a variably modified
932 /// type. Also emit proper debug info for cast types.
933 void EmitExplicitCastExprType(const ExplicitCastExpr *E,
934 CodeGenFunction *CGF = nullptr);
935
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000936 /// Return the result of value-initializing the given type, i.e. a null
937 /// expression of the given type. This is usually, but not always, an LLVM
938 /// null constant.
Eli Friedman20bb5e02009-04-13 21:47:26 +0000939 llvm::Constant *EmitNullConstant(QualType T);
940
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000941 /// Return a null constant appropriate for zero-initializing a base class with
942 /// the given type. This is usually, but not always, an LLVM null constant.
Eli Friedmanfde961d2011-10-14 02:27:24 +0000943 llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
944
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000945 /// Emit a general error that something can't be done.
Chandler Carruth84537952012-03-30 19:44:53 +0000946 void Error(SourceLocation loc, StringRef error);
John McCall7ef5cb32011-03-18 02:56:14 +0000947
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000948 /// Print out an error that codegen doesn't support the specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +0000949 void ErrorUnsupported(const Stmt *S, const char *Type);
Mike Stump1676c5b2009-02-13 19:12:34 +0000950
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000951 /// Print out an error that codegen doesn't support the specified decl yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +0000952 void ErrorUnsupported(const Decl *D, const char *Type);
Dan Gohman75d69da2008-05-22 00:50:06 +0000953
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000954 /// Set the attributes on the LLVM function for the given decl and function
955 /// info. This applies attributes necessary for handling the ABI as well as
956 /// user specified attributes like section.
Daniel Dunbarc3e7cff2009-04-17 00:48:04 +0000957 void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F,
958 const CGFunctionInfo &FI);
Daniel Dunbar449a3392008-09-04 23:41:35 +0000959
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000960 /// Set the LLVM function attributes (sext, zext, etc).
Daniel Dunbaraeddffc2009-04-14 07:08:30 +0000961 void SetLLVMFunctionAttributes(const Decl *D,
962 const CGFunctionInfo &Info,
963 llvm::Function *F);
Daniel Dunbarc68897d2008-09-10 00:41:16 +0000964
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000965 /// Set the LLVM function attributes which only apply to a function
James Dennett64fa1232014-08-15 20:04:40 +0000966 /// definition.
Daniel Dunbar38932572009-04-14 08:05:55 +0000967 void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
968
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000969 /// Return true iff the given type uses 'sret' when used as a return type.
Daniel Dunbar6f2e8392010-07-14 23:39:36 +0000970 bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
971
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000972 /// Return true iff the given type uses an argument slot when 'sret' is used
973 /// as a return type.
Tim Northovere77cc392014-03-29 13:28:05 +0000974 bool ReturnSlotInterferesWithArgs(const CGFunctionInfo &FI);
975
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000976 /// Return true iff the given type uses 'fpret' when used as a return type.
Daniel Dunbar6f2e8392010-07-14 23:39:36 +0000977 bool ReturnTypeUsesFPRet(QualType ResultType);
Daniel Dunbarc68897d2008-09-10 00:41:16 +0000978
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000979 /// Return true iff the given type uses 'fp2ret' when used as a return type.
Anders Carlsson2f1a6c32011-10-31 16:27:11 +0000980 bool ReturnTypeUsesFP2Ret(QualType ResultType);
981
Rafael Espindolae98ed2f2014-05-09 01:34:38 +0000982 /// Get the LLVM attributes and calling convention to use for a particular
983 /// function type.
Daniel Dunbar0ef34792009-09-12 00:59:20 +0000984 ///
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000985 /// \param Name - The function name.
Daniel Dunbar0ef34792009-09-12 00:59:20 +0000986 /// \param Info - The function type information.
Samuel Antao798f11c2015-11-23 22:04:44 +0000987 /// \param CalleeInfo - The callee information these attributes are being
988 /// constructed for. If valid, the attributes applied to this decl may
989 /// contribute to the function attributes and calling convention.
Daniel Dunbar0ef34792009-09-12 00:59:20 +0000990 /// \param PAL [out] - On return, the attribute list to use.
991 /// \param CallingConv [out] - On return, the LLVM calling convention to use.
Chad Rosier7dbc9cf2016-01-06 14:35:46 +0000992 void ConstructAttributeList(StringRef Name, const CGFunctionInfo &Info,
Samuel Antao798f11c2015-11-23 22:04:44 +0000993 CGCalleeInfo CalleeInfo, AttributeListType &PAL,
994 unsigned &CallingConv, bool AttrOnCallSite);
Daniel Dunbarc68897d2008-09-10 00:41:16 +0000995
Eric Christopher2b90a642015-11-11 23:05:08 +0000996 // Fills in the supplied string map with the set of target features for the
997 // passed in function.
998 void getFunctionFeatureMap(llvm::StringMap<bool> &FeatureMap,
999 const FunctionDecl *FD);
1000
Chris Lattner01cf8db2011-07-20 06:58:45 +00001001 StringRef getMangledName(GlobalDecl GD);
Alp Tokerfb8d02b2014-06-05 22:10:59 +00001002 StringRef getBlockMangledName(GlobalDecl GD, const BlockDecl *BD);
Douglas Gregorbeecd582009-04-21 17:11:58 +00001003
1004 void EmitTentativeDefinition(const VarDecl *D);
Mike Stumpbc78a722009-07-31 18:25:34 +00001005
Nico Weberb6a5d052015-01-15 04:07:35 +00001006 void EmitVTable(CXXRecordDecl *Class);
Douglas Gregor88d292c2010-05-13 16:44:06 +00001007
David Majnemer929025d2016-01-26 19:30:26 +00001008 void RefreshTypeCacheForClass(const CXXRecordDecl *Class);
1009
Reid Klecknere43f0fe2013-05-08 13:44:39 +00001010 /// \brief Appends Opts to the "Linker Options" metadata value.
1011 void AppendLinkerOptions(StringRef Opts);
1012
Benjamin Kramer82dfc972013-06-04 09:13:21 +00001013 /// \brief Appends a detect mismatch command to the linker options.
Aaron Ballman5d041be2013-06-04 02:07:14 +00001014 void AddDetectMismatch(StringRef Name, StringRef Value);
1015
Reid Klecknere43f0fe2013-05-08 13:44:39 +00001016 /// \brief Appends a dependent lib to the "Linker Options" metadata value.
1017 void AddDependentLib(StringRef Lib);
1018
Peter Collingbourne4d90dba2013-06-05 17:49:37 +00001019 llvm::GlobalVariable::LinkageTypes getFunctionLinkage(GlobalDecl GD);
John McCalld4324142010-02-19 01:32:20 +00001020
Rafael Espindola64926362014-05-08 14:46:46 +00001021 void setFunctionLinkage(GlobalDecl GD, llvm::Function *F) {
1022 F->setLinkage(getFunctionLinkage(GD));
John McCall7cb02202010-05-25 04:30:21 +00001023 }
1024
Hans Wennborgbb4f9622015-05-28 17:44:56 +00001025 /// Set the DLL storage class on F.
1026 void setFunctionDLLStorageClass(GlobalDecl GD, llvm::Function *F);
1027
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001028 /// Return the appropriate linkage for the vtable, VTT, and type information
1029 /// of the given class.
Anders Carlsson68d34242011-01-24 02:04:33 +00001030 llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
Ken Dyck98ca7942010-01-26 13:48:07 +00001031
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001032 /// Return the store size, in character units, of the given LLVM type.
Chris Lattner2192fe52011-07-18 04:24:23 +00001033 CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
Fariborz Jahanian1518a5ec2010-10-27 16:21:54 +00001034
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001035 /// Returns LLVM linkage for a declarator.
David Majnemer27d69db2014-04-28 22:17:59 +00001036 llvm::GlobalValue::LinkageTypes
Hans Wennborg1a3a0742014-05-14 19:54:53 +00001037 getLLVMLinkageForDeclarator(const DeclaratorDecl *D, GVALinkage Linkage,
Hans Wennborg275efb92014-05-28 01:52:23 +00001038 bool IsConstantVariable);
David Majnemer27d69db2014-04-28 22:17:59 +00001039
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001040 /// Returns LLVM linkage for a declarator.
David Majnemer27d69db2014-04-28 22:17:59 +00001041 llvm::GlobalValue::LinkageTypes
1042 getLLVMLinkageVarDefinition(const VarDecl *VD, bool IsConstant);
1043
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001044 /// Emit all the global annotations.
1045 void EmitGlobalAnnotations();
1046
1047 /// Emit an annotation string.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001048 llvm::Constant *EmitAnnotationString(StringRef Str);
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001049
1050 /// Emit the annotation's translation unit.
1051 llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
1052
1053 /// Emit the annotation line number.
1054 llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
1055
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001056 /// Generate the llvm::ConstantStruct which contains the annotation
1057 /// information for a given GlobalValue. The annotation struct is
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001058 /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
1059 /// GlobalValue being annotated. The second field is the constant string
1060 /// created from the AnnotateAttr's annotation. The third field is a constant
1061 /// string containing the name of the translation unit. The fourth field is
1062 /// the line number in the file of the annotated value declaration.
1063 llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
1064 const AnnotateAttr *AA,
1065 SourceLocation L);
1066
1067 /// Add global annotations that are set on D, for the global GV. Those
1068 /// annotations are emitted during finalization of the LLVM code.
1069 void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
1070
Alexey Samsonov1444bb92014-10-17 00:20:19 +00001071 bool isInSanitizerBlacklist(llvm::Function *Fn, SourceLocation Loc) const;
Will Dietzf54319c2013-01-18 11:30:38 +00001072
Alexey Samsonova0ac3c22014-10-17 22:37:33 +00001073 bool isInSanitizerBlacklist(llvm::GlobalVariable *GV, SourceLocation Loc,
1074 QualType Ty,
1075 StringRef Category = StringRef()) const;
1076
Alexey Samsonov4b8de112014-08-01 21:35:28 +00001077 SanitizerMetadata *getSanitizerMetadata() {
1078 return SanitizerMD.get();
1079 }
Alexey Samsonov4f319cc2014-07-02 16:54:41 +00001080
John McCall6bd2a892013-01-25 22:31:03 +00001081 void addDeferredVTable(const CXXRecordDecl *RD) {
1082 DeferredVTables.push_back(RD);
1083 }
1084
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001085 /// Emit code for a singal global function or var decl. Forward declarations
1086 /// are emitted lazily.
Reid Klecknere7de47e2013-07-22 13:51:44 +00001087 void EmitGlobal(GlobalDecl D);
1088
Rafael Espindola02b77f42014-09-15 18:46:13 +00001089 bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target,
1090 bool InEveryTU);
1091 bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
1092
1093 /// Set attributes for a global definition.
1094 void setFunctionDefinitionAttributes(const FunctionDecl *D,
1095 llvm::Function *F);
1096
Chris Lattner01cf8db2011-07-20 06:58:45 +00001097 llvm::GlobalValue *GetGlobalValue(StringRef Ref);
Mike Stump11289f42009-09-09 15:08:12 +00001098
Rafael Espindola1e4df922014-09-16 15:18:21 +00001099 /// Set attributes which are common to any form of a global definition (alias,
1100 /// Objective-C method, function, global variable).
1101 ///
1102 /// NOTE: This should only be called for definitions.
1103 void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV);
1104
Dario Domiziolic4fb8ca72014-09-19 22:06:24 +00001105 /// Set attributes which must be preserved by an alias. This includes common
1106 /// attributes (i.e. it includes a call to SetCommonAttributes).
1107 ///
1108 /// NOTE: This should only be called for definitions.
1109 void setAliasAttributes(const Decl *D, llvm::GlobalValue *GV);
1110
Rafael Espindola1e4df922014-09-16 15:18:21 +00001111 void addReplacement(StringRef Name, llvm::Constant *C);
Alexey Bataev97720002014-11-11 04:05:39 +00001112
Andrey Bokhankocab58582015-08-31 13:20:44 +00001113 void addGlobalValReplacement(llvm::GlobalValue *GV, llvm::Constant *C);
1114
Alexey Bataev97720002014-11-11 04:05:39 +00001115 /// \brief Emit a code for threadprivate directive.
1116 /// \param D Threadprivate declaration.
1117 void EmitOMPThreadPrivateDecl(const OMPThreadPrivateDecl *D);
1118
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00001119 /// \brief Emit a code for declare reduction construct.
Alexey Bataevc5b1d322016-03-04 09:22:22 +00001120 void EmitOMPDeclareReduction(const OMPDeclareReductionDecl *D,
1121 CodeGenFunction *CGF = nullptr);
Alexey Bataev94a4f0c2016-03-03 05:21:39 +00001122
Peter Collingbourne3afb2662016-04-28 17:09:37 +00001123 /// Returns whether the given record has hidden LTO visibility and therefore
1124 /// may participate in (single-module) CFI and whole-program vtable
1125 /// optimization.
1126 bool HasHiddenLTOVisibility(const CXXRecordDecl *RD);
Peter Collingbournee5706442015-07-09 19:56:14 +00001127
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001128 /// Emit type metadata for the given vtable using the given layout.
1129 void EmitVTableTypeMetadata(llvm::GlobalVariable *VTable,
1130 const VTableLayout &VTLayout);
Peter Collingbournea4ccff32015-02-20 20:30:56 +00001131
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001132 /// Generate a cross-DSO type identifier for MD.
1133 llvm::ConstantInt *CreateCrossDsoCfiTypeId(llvm::Metadata *MD);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001134
Peter Collingbourne25a80bf2015-09-08 23:01:30 +00001135 /// Create a metadata identifier for the given type. This may either be an
1136 /// MDString (for external identifiers) or a distinct unnamed MDNode (for
1137 /// internal identifiers).
1138 llvm::Metadata *CreateMetadataIdentifierForType(QualType T);
1139
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001140 /// Create and attach type metadata to the given function.
1141 void CreateFunctionTypeMetadata(const FunctionDecl *FD, llvm::Function *F);
Evgeniy Stepanovfd6f92d2015-12-15 23:00:20 +00001142
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001143 /// Returns whether this module needs the "all-vtables" type identifier.
1144 bool NeedAllVtablesTypeId() const;
Evgeniy Stepanovf31ea302016-02-03 22:18:55 +00001145
Peter Collingbourne8dd14da2016-06-24 21:21:46 +00001146 /// Create and attach type metadata for the given vtable.
1147 void AddVTableTypeMetadata(llvm::GlobalVariable *VTable, CharUnits Offset,
1148 const CXXRecordDecl *RD);
Peter Collingbourne86d34a72015-06-17 19:08:05 +00001149
Reid Klecknerfff8e7f2015-03-03 19:21:04 +00001150 /// \breif Get the declaration of std::terminate for the platform.
1151 llvm::Constant *getTerminateFn();
1152
Peter Collingbournedc134532016-01-16 00:31:22 +00001153 llvm::SanitizerStatReport &getSanStats();
1154
Yaxun Liu0bc4b2d2016-07-28 19:26:30 +00001155 llvm::Value *
1156 createOpenCLIntToSamplerConversion(const Expr *E, CodeGenFunction &CGF);
1157
Rafael Espindola1e4df922014-09-16 15:18:21 +00001158private:
Rafael Espindola94abb8f2013-12-09 04:29:47 +00001159 llvm::Constant *
1160 GetOrCreateLLVMFunction(StringRef MangledName, llvm::Type *Ty, GlobalDecl D,
1161 bool ForVTable, bool DontDefer = false,
David Majnemerb9bd6fb2014-11-01 05:42:23 +00001162 bool IsThunk = false,
Andrey Bokhankocab58582015-08-31 13:20:44 +00001163 llvm::AttributeSet ExtraAttrs = llvm::AttributeSet(),
John McCalld195d4c2016-11-30 23:25:13 +00001164 ForDefinition_t IsForDefinition = NotForDefinition);
Rafael Espindola94abb8f2013-12-09 04:29:47 +00001165
Chris Lattner01cf8db2011-07-20 06:58:45 +00001166 llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName,
Chris Lattner2192fe52011-07-18 04:24:23 +00001167 llvm::PointerType *PTy,
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +00001168 const VarDecl *D,
John McCalld195d4c2016-11-30 23:25:13 +00001169 ForDefinition_t IsForDefinition
1170 = NotForDefinition);
Mike Stump11289f42009-09-09 15:08:12 +00001171
Rafael Espindolaee076a22014-05-13 18:45:53 +00001172 void setNonAliasAttributes(const Decl *D, llvm::GlobalObject *GO);
Rafael Espindola502f65a2014-05-05 20:21:03 +00001173
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001174 /// Set function attributes for a function declaration.
David Majnemerb9bd6fb2014-11-01 05:42:23 +00001175 void SetFunctionAttributes(GlobalDecl GD, llvm::Function *F,
1176 bool IsIncompleteFunction, bool IsThunk);
Nuno Lopesb6f79532008-06-08 15:45:52 +00001177
Craig Topper8a13c412014-05-21 05:09:00 +00001178 void EmitGlobalDefinition(GlobalDecl D, llvm::GlobalValue *GV = nullptr);
Daniel Dunbarf0acf7b2009-02-19 07:15:39 +00001179
Rafael Espindolacd7743b2013-12-09 16:01:03 +00001180 void EmitGlobalFunctionDefinition(GlobalDecl GD, llvm::GlobalValue *GV);
Andrey Bokhanko7aa88ce2016-01-14 10:41:16 +00001181 void EmitGlobalVarDefinition(const VarDecl *D, bool IsTentative = false);
John McCall7ec50432010-03-19 23:29:14 +00001182 void EmitAliasDefinition(GlobalDecl GD);
Dmitry Polukhin85eda122016-04-11 07:48:59 +00001183 void emitIFuncDefinition(GlobalDecl GD);
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001184 void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
Fariborz Jahanian0dec1e02010-04-28 21:28:56 +00001185 void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
Fariborz Jahanian1518a5ec2010-10-27 16:21:54 +00001186
Anders Carlssonf7475242009-04-15 15:55:24 +00001187 // C++ related functions.
Mike Stump11289f42009-09-09 15:08:12 +00001188
Richard Smith8df390f2016-09-08 23:14:54 +00001189 void EmitDeclContext(const DeclContext *DC);
Anders Carlssoncbaeb9e2009-04-02 05:55:18 +00001190 void EmitLinkageSpec(const LinkageSpecDecl *D);
Adrian Prantlffcf4ba2013-05-09 23:16:27 +00001191 void CompleteDIClassType(const CXXMethodDecl* D);
Anders Carlssonf7475242009-04-15 15:55:24 +00001192
Richard Smith2fd1d7a2013-04-19 16:42:07 +00001193 /// \brief Emit the function that initializes C++ thread_local variables.
1194 void EmitCXXThreadLocalInitFunc();
1195
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001196 /// Emit the function that initializes C++ globals.
Anders Carlssonb8be93f2009-08-08 23:24:23 +00001197 void EmitCXXGlobalInitFunc();
Eli Friedman5866fe32010-01-08 00:50:11 +00001198
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001199 /// Emit the function that destroys C++ globals.
Daniel Dunbarfe06df42010-03-20 04:15:41 +00001200 void EmitCXXGlobalDtorFunc();
1201
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001202 /// Emit the function that initializes the specified global (if PerformInit is
1203 /// true) and registers its destructor.
John McCallcdf7ef52010-11-06 09:44:32 +00001204 void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
Richard Smith6331c402012-02-13 22:16:19 +00001205 llvm::GlobalVariable *Addr,
1206 bool PerformInit);
Eli Friedman5866fe32010-01-08 00:50:11 +00001207
Reid Kleckner1a711b12014-07-22 00:53:05 +00001208 void EmitPointerToInitFunc(const VarDecl *VD, llvm::GlobalVariable *Addr,
1209 llvm::Function *InitFunc, InitSegAttr *ISA);
1210
Daniel Dunbar74aa7e12008-08-01 00:01:51 +00001211 // FIXME: Hardcoding priority here is gross.
Reid Kleckner563f0e82014-05-23 21:13:45 +00001212 void AddGlobalCtor(llvm::Function *Ctor, int Priority = 65535,
Hans Wennborg59dbe862015-09-29 20:56:43 +00001213 llvm::Constant *AssociatedData = nullptr);
Reid Kleckner563f0e82014-05-23 21:13:45 +00001214 void AddGlobalDtor(llvm::Function *Dtor, int Priority = 65535);
Daniel Dunbar9c426522008-07-29 23:18:29 +00001215
Vassil Vassilev188ad3a2016-10-27 09:12:20 +00001216 /// EmitCtorList - Generates a global array of functions and priorities using
1217 /// the given list and name. This array will have appending linkage and is
1218 /// suitable for use as a LLVM constructor or destructor array. Clears Fns.
1219 void EmitCtorList(CtorList &Fns, const char *GlobalName);
Daniel Dunbar74aa7e12008-08-01 00:01:51 +00001220
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001221 /// Emit any needed decls for which code generation was deferred.
Dmitri Gribenkob2aa9232012-11-15 14:28:07 +00001222 void EmitDeferred();
Daniel Dunbar08b26a02009-02-13 20:29:50 +00001223
Rafael Espindola2e2995b2013-11-05 21:37:29 +00001224 /// Call replaceAllUsesWith on all pairs in Replacements.
1225 void applyReplacements();
1226
Andrey Bokhankocab58582015-08-31 13:20:44 +00001227 /// Call replaceAllUsesWith on all pairs in GlobalValReplacements.
1228 void applyGlobalValReplacements();
1229
Rafael Espindola208b5c02013-10-22 19:26:13 +00001230 void checkAliases();
1231
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001232 /// Emit any vtables which we deferred and still have a use for.
John McCall6bd2a892013-01-25 22:31:03 +00001233 void EmitDeferredVTables();
1234
Rafael Espindola060062a2014-03-06 22:15:10 +00001235 /// Emit the llvm.used and llvm.compiler.used metadata.
1236 void emitLLVMUsed();
Daniel Dunbar23fd4622008-10-01 00:49:24 +00001237
Douglas Gregorbc25ff42013-01-14 20:53:57 +00001238 /// \brief Emit the link options introduced by imported modules.
1239 void EmitModuleLinkOptions();
1240
Richard Smithdf931ce2013-04-06 05:00:46 +00001241 /// \brief Emit aliases for internal-linkage declarations inside "C" language
1242 /// linkage specifications, giving them the "expected" name where possible.
1243 void EmitStaticExternCAliases();
1244
John McCall09ae0322010-07-06 23:57:41 +00001245 void EmitDeclMetadata();
1246
Rafael Espindola3bfa4682013-10-16 19:28:50 +00001247 /// \brief Emit the Clang version as llvm.ident metadata.
1248 void EmitVersionIdentMetadata();
1249
Robert Lytton57765d52014-07-03 09:30:33 +00001250 /// Emits target specific Metadata for global declarations.
1251 void EmitTargetMetadata();
1252
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001253 /// Emit the llvm.gcov metadata used to tell LLVM where to emit the .gcno and
1254 /// .gcda files in a way that persists in .bc files.
Nick Lewycky85c011d2011-05-05 00:08:20 +00001255 void EmitCoverageFile();
Nick Lewycky480cb992011-05-04 20:46:58 +00001256
Nico Webercf4ff5862012-10-11 10:13:44 +00001257 /// Emits the initializer for a uuidof string.
Nico Weber17d3a2c2014-09-08 16:26:36 +00001258 llvm::Constant *EmitUuidofInitializer(StringRef uuidstr);
Nico Webercf4ff5862012-10-11 10:13:44 +00001259
Hans Wennborg43a0f992015-01-10 01:19:48 +00001260 /// Determine whether the definition must be emitted; if this returns \c
1261 /// false, the definition can be emitted lazily if it's used.
1262 bool MustBeEmitted(const ValueDecl *D);
1263
1264 /// Determine whether the definition can be emitted eagerly, or should be
1265 /// delayed until the end of the translation unit. This is relevant for
1266 /// definitions whose linkage can change, e.g. implicit function instantions
1267 /// which may later be explicitly instantiated.
1268 bool MayBeEmittedEagerly(const ValueDecl *D);
John McCall0bdb1fd2010-09-16 06:16:50 +00001269
Rafael Espindolae98ed2f2014-05-09 01:34:38 +00001270 /// Check whether we can use a "simpler", more core exceptions personality
1271 /// function.
John McCall0bdb1fd2010-09-16 06:16:50 +00001272 void SimplifyPersonality();
Chris Lattnerf97fe382007-05-24 06:29:05 +00001273};
1274} // end namespace CodeGen
1275} // end namespace clang
Chris Lattnerf97fe382007-05-24 06:29:05 +00001276
Hans Wennborg59dbe862015-09-29 20:56:43 +00001277#endif // LLVM_CLANG_LIB_CODEGEN_CODEGENMODULE_H