blob: 664b51078424d9cd45b6deb5f5dd3cc55bd8e671 [file] [log] [blame]
Chris Lattnerbed31442007-05-28 01:07:47 +00001//===--- CodeGenFunction.cpp - Emit LLVM Code from ASTs for a Function ----===//
2//
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 Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This coordinates the per-function state used while generating code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
John McCall7f416cc2015-09-08 08:05:57 +000015#include "CGBlocks.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000016#include "CGCleanup.h"
Peter Collingbournefa4d6032011-10-06 18:51:56 +000017#include "CGCUDARuntime.h"
John McCall5d865c322010-08-31 07:33:07 +000018#include "CGCXXABI.h"
Eli Friedman17630752008-05-22 01:40:10 +000019#include "CGDebugInfo.h"
Alexey Bataev9959db52014-05-06 10:08:46 +000020#include "CGOpenMPRuntime.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Peter Collingbourneb453cd62013-10-20 21:29:19 +000023#include "TargetInfo.h"
Daniel Dunbarad319a72008-08-11 05:00:27 +000024#include "clang/AST/ASTContext.h"
Richard Smith376c28e2017-08-24 20:10:33 +000025#include "clang/AST/ASTLambda.h"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000026#include "clang/AST/Decl.h"
Anders Carlsson468fa632009-04-04 20:47:02 +000027#include "clang/AST/DeclCXX.h"
Mike Stumpbee78dd2009-12-04 23:26:17 +000028#include "clang/AST/StmtCXX.h"
Richard Smithd8e3ac32016-09-16 23:30:39 +000029#include "clang/AST/StmtObjC.h"
Sanjay Patela24296b2015-09-02 20:01:30 +000030#include "clang/Basic/Builtins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000031#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000032#include "clang/CodeGen/CGFunctionInfo.h"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000033#include "clang/Frontend/CodeGenOptions.h"
Eric Christopherfbfd97e2015-11-12 00:44:07 +000034#include "clang/Sema/SemaDiagnostic.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/DataLayout.h"
Gor Nishanov04491bd2017-11-11 17:00:43 +000036#include "llvm/IR/Dominators.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000037#include "llvm/IR/Intrinsics.h"
38#include "llvm/IR/MDBuilder.h"
39#include "llvm/IR/Operator.h"
Gor Nishanov04491bd2017-11-11 17:00:43 +000040#include "llvm/Transforms/Utils/PromoteMemToReg.h"
Chris Lattnerbed31442007-05-28 01:07:47 +000041using namespace clang;
42using namespace CodeGen;
43
Vitaly Buka1c943322016-10-26 01:59:57 +000044/// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time
45/// markers.
46static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts,
47 const LangOptions &LangOpts) {
Mehdi Amini7f873072017-01-06 23:18:09 +000048 if (CGOpts.DisableLifetimeMarkers)
49 return false;
50
Vitaly Buka1c943322016-10-26 01:59:57 +000051 // Disable lifetime markers in msan builds.
52 // FIXME: Remove this when msan works with lifetime markers.
53 if (LangOpts.Sanitize.has(SanitizerKind::Memory))
54 return false;
55
Benjamin Kramer2a7d39d2017-03-31 09:19:25 +000056 // Asan uses markers for use-after-scope checks.
57 if (CGOpts.SanitizeAddressUseAfterScope)
58 return true;
59
Vitaly Buka1c943322016-10-26 01:59:57 +000060 // For now, only in optimized builds.
61 return CGOpts.OptimizationLevel != 0;
62}
63
Fariborz Jahanian63628032012-06-26 16:06:38 +000064CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext)
David Blaikie92848de2013-08-26 20:33:21 +000065 : CodeGenTypeCache(cgm), CGM(cgm), Target(cgm.getTarget()),
John McCall7f416cc2015-09-08 08:05:57 +000066 Builder(cgm, cgm.getModule().getContext(), llvm::ConstantFolder(),
David Blaikie8e90d222014-10-14 17:09:38 +000067 CGBuilderInserterTy(this)),
John McCall7f416cc2015-09-08 08:05:57 +000068 CurFn(nullptr), ReturnValue(Address::invalid()),
Vitaly Buka1c943322016-10-26 01:59:57 +000069 CapturedStmtInfo(nullptr), SanOpts(CGM.getLangOpts().Sanitize),
70 IsSanitizerScope(false), CurFuncIsThunk(false), AutoreleaseResult(false),
71 SawAsmBlock(false), IsOutlinedSEHHelper(false), BlockInfo(nullptr),
72 BlockPointer(nullptr), LambdaThisCaptureField(nullptr),
73 NormalCleanupDest(nullptr), NextCleanupDestIndex(1),
74 FirstBlockInfo(nullptr), EHResumeBlock(nullptr), ExceptionSlot(nullptr),
75 EHSelectorSlot(nullptr), DebugInfo(CGM.getModuleDebugInfo()),
Reid Kleckner9fe7f232015-07-07 00:36:30 +000076 DisableDebugInfo(false), DidCallStackSave(false), IndirectBranch(nullptr),
77 PGO(cgm), SwitchInsn(nullptr), SwitchWeights(nullptr),
78 CaseRangeBlock(nullptr), UnreachableBlock(nullptr), NumReturnExprs(0),
79 NumSimpleReturnExprs(0), CXXABIThisDecl(nullptr),
80 CXXABIThisValue(nullptr), CXXThisValue(nullptr),
John McCall7f416cc2015-09-08 08:05:57 +000081 CXXStructorImplicitParamDecl(nullptr),
Craig Topper8a13c412014-05-21 05:09:00 +000082 CXXStructorImplicitParamValue(nullptr), OutermostConditional(nullptr),
83 CurLexicalScope(nullptr), TerminateLandingPad(nullptr),
Vitaly Buka1c943322016-10-26 01:59:57 +000084 TerminateHandler(nullptr), TrapBB(nullptr),
85 ShouldEmitLifetimeMarkers(
86 shouldEmitLifetimeMarkers(CGM.getCodeGenOpts(), CGM.getLangOpts())) {
Fariborz Jahanian63628032012-06-26 16:06:38 +000087 if (!suppressNewContext)
88 CGM.getCXXABI().getMangleContext().startNewFunction();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000089
90 llvm::FastMathFlags FMF;
91 if (CGM.getLangOpts().FastMath)
Sanjay Patel401aaee2017-11-06 16:27:36 +000092 FMF.setFast();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000093 if (CGM.getLangOpts().FiniteMathOnly) {
Benjamin Kramer7464efc2012-12-09 21:58:24 +000094 FMF.setNoNaNs();
95 FMF.setNoInfs();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000096 }
Pekka Jaaskelainen37014502014-12-10 16:41:14 +000097 if (CGM.getCodeGenOpts().NoNaNsFPMath) {
98 FMF.setNoNaNs();
99 }
100 if (CGM.getCodeGenOpts().NoSignedZeros) {
101 FMF.setNoSignedZeros();
102 }
Sanjay Patel359b1052015-04-09 15:03:23 +0000103 if (CGM.getCodeGenOpts().ReciprocalMath) {
104 FMF.setAllowReciprocal();
105 }
Sanjay Patelcb8c0092017-12-16 16:11:17 +0000106 if (CGM.getCodeGenOpts().Reassociate) {
107 FMF.setAllowReassoc();
108 }
Sanjay Pateld61f3c72016-01-12 18:03:41 +0000109 Builder.setFastMathFlags(FMF);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000110}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000111
John McCall08ef4662011-11-10 08:15:53 +0000112CodeGenFunction::~CodeGenFunction() {
Richard Smith736a9472013-06-12 20:42:33 +0000113 assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup");
114
John McCall08ef4662011-11-10 08:15:53 +0000115 // If there are any unclaimed block infos, go ahead and destroy them
116 // now. This can happen if IR-gen gets clever and skips evaluating
117 // something.
118 if (FirstBlockInfo)
119 destroyBlockInfos(FirstBlockInfo);
Alexey Bataev9959db52014-05-06 10:08:46 +0000120
Alexey Bataev880d8602017-01-20 08:57:28 +0000121 if (getLangOpts().OpenMP && CurFn)
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000122 CGM.getOpenMPRuntime().functionFinished(*this);
John McCall08ef4662011-11-10 08:15:53 +0000123}
124
John McCall7f416cc2015-09-08 08:05:57 +0000125CharUnits CodeGenFunction::getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +0000126 LValueBaseInfo *BaseInfo,
127 TBAAAccessInfo *TBAAInfo) {
128 return getNaturalTypeAlignment(T->getPointeeType(), BaseInfo, TBAAInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000129 /* forPointeeType= */ true);
David Majnemer99281062014-09-18 22:05:54 +0000130}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000131
John McCall7f416cc2015-09-08 08:05:57 +0000132CharUnits CodeGenFunction::getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000133 LValueBaseInfo *BaseInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000134 TBAAAccessInfo *TBAAInfo,
John McCall7f416cc2015-09-08 08:05:57 +0000135 bool forPointeeType) {
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000136 if (TBAAInfo)
137 *TBAAInfo = CGM.getTBAAAccessInfo(T);
138
John McCall7f416cc2015-09-08 08:05:57 +0000139 // Honor alignment typedef attributes even on incomplete types.
140 // We also honor them straight for C++ class types, even as pointees;
141 // there's an expressivity gap here.
142 if (auto TT = T->getAs<TypedefType>()) {
143 if (auto Align = TT->getDecl()->getMaxAlignment()) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000144 if (BaseInfo)
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +0000145 *BaseInfo = LValueBaseInfo(AlignmentSource::AttributedType);
John McCall7f416cc2015-09-08 08:05:57 +0000146 return getContext().toCharUnitsFromBits(Align);
147 }
148 }
149
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000150 if (BaseInfo)
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +0000151 *BaseInfo = LValueBaseInfo(AlignmentSource::Type);
John McCall7f416cc2015-09-08 08:05:57 +0000152
153 CharUnits Alignment;
David Majnemer9df56372015-09-10 21:52:00 +0000154 if (T->isIncompleteType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000155 Alignment = CharUnits::One(); // Shouldn't be used, but pessimistic is best.
156 } else {
157 // For C++ class pointees, we don't know whether we're pointing at a
158 // base or a complete object, so we generally need to use the
159 // non-virtual alignment.
160 const CXXRecordDecl *RD;
161 if (forPointeeType && (RD = T->getAsCXXRecordDecl())) {
162 Alignment = CGM.getClassPointerAlignment(RD);
163 } else {
164 Alignment = getContext().getTypeAlignInChars(T);
Roger Ferrer Ibanez3fa38a12017-03-08 14:00:44 +0000165 if (T.getQualifiers().hasUnaligned())
166 Alignment = CharUnits::One();
John McCall7f416cc2015-09-08 08:05:57 +0000167 }
168
169 // Cap to the global maximum type alignment unless the alignment
170 // was somehow explicit on the type.
171 if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) {
172 if (Alignment.getQuantity() > MaxAlign &&
173 !getContext().isAlignmentRequired(T))
174 Alignment = CharUnits::fromQuantity(MaxAlign);
175 }
176 }
177 return Alignment;
178}
179
180LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000181 LValueBaseInfo BaseInfo;
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000182 TBAAAccessInfo TBAAInfo;
183 CharUnits Alignment = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo);
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000184 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), BaseInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000185 TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000186}
187
188/// Given a value of type T* that may not be to a complete object,
189/// construct an l-value with the natural pointee alignment of T.
190LValue
191CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000192 LValueBaseInfo BaseInfo;
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000193 TBAAAccessInfo TBAAInfo;
194 CharUnits Align = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo,
195 /* forPointeeType= */ true);
196 return MakeAddrLValue(Address(V, Align), T, BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000197}
198
199
Chris Lattnera5f58b02011-07-09 17:41:47 +0000200llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) {
Daniel Dunbaree3da872009-02-03 23:03:55 +0000201 return CGM.getTypes().ConvertTypeForMem(T);
202}
203
Chris Lattnera5f58b02011-07-09 17:41:47 +0000204llvm::Type *CodeGenFunction::ConvertType(QualType T) {
Chris Lattnerf033c142007-06-22 19:05:19 +0000205 return CGM.getTypes().ConvertType(T);
Chris Lattner45bb9142007-06-09 02:28:57 +0000206}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000207
John McCall47fb9502013-03-07 21:37:08 +0000208TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) {
209 type = type.getCanonicalType();
210 while (true) {
211 switch (type->getTypeClass()) {
John McCall745ae282011-05-15 02:34:36 +0000212#define TYPE(name, parent)
213#define ABSTRACT_TYPE(name, parent)
214#define NON_CANONICAL_TYPE(name, parent) case Type::name:
215#define DEPENDENT_TYPE(name, parent) case Type::name:
216#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name:
217#include "clang/AST/TypeNodes.def"
John McCall47fb9502013-03-07 21:37:08 +0000218 llvm_unreachable("non-canonical or dependent type in IR-generation");
John McCall745ae282011-05-15 02:34:36 +0000219
Richard Smith27d807c2013-04-30 13:56:41 +0000220 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +0000221 case Type::DeducedTemplateSpecialization:
222 llvm_unreachable("undeduced type in IR-generation");
Richard Smith27d807c2013-04-30 13:56:41 +0000223
John McCall47fb9502013-03-07 21:37:08 +0000224 // Various scalar types.
225 case Type::Builtin:
226 case Type::Pointer:
227 case Type::BlockPointer:
228 case Type::LValueReference:
229 case Type::RValueReference:
230 case Type::MemberPointer:
231 case Type::Vector:
232 case Type::ExtVector:
233 case Type::FunctionProto:
234 case Type::FunctionNoProto:
235 case Type::Enum:
236 case Type::ObjCObjectPointer:
Xiuli Pan9c14e282016-01-09 12:53:17 +0000237 case Type::Pipe:
John McCall47fb9502013-03-07 21:37:08 +0000238 return TEK_Scalar;
John McCall745ae282011-05-15 02:34:36 +0000239
John McCall47fb9502013-03-07 21:37:08 +0000240 // Complexes.
241 case Type::Complex:
242 return TEK_Complex;
Eli Friedman0dfb8892011-10-06 23:00:33 +0000243
John McCall47fb9502013-03-07 21:37:08 +0000244 // Arrays, records, and Objective-C objects.
245 case Type::ConstantArray:
246 case Type::IncompleteArray:
247 case Type::VariableArray:
248 case Type::Record:
249 case Type::ObjCObject:
250 case Type::ObjCInterface:
251 return TEK_Aggregate;
252
253 // We operate on atomic values according to their underlying type.
254 case Type::Atomic:
255 type = cast<AtomicType>(type)->getValueType();
256 continue;
257 }
258 llvm_unreachable("unknown type kind!");
John McCall745ae282011-05-15 02:34:36 +0000259 }
Chris Lattner54fb19e2007-06-22 22:02:34 +0000260}
261
David Blaikie66e41972015-01-14 07:38:27 +0000262llvm::DebugLoc CodeGenFunction::EmitReturnBlock() {
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000263 // For cleanliness, we try to avoid emitting the return block for
264 // simple cases.
265 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
266
267 if (CurBB) {
268 assert(!CurBB->getTerminator() && "Unexpected terminated block.");
269
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000270 // We have a valid insert point, reuse it if it is empty or there are no
271 // explicit jumps to the return block.
John McCallad5d61e2010-07-23 21:56:41 +0000272 if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) {
273 ReturnBlock.getBlock()->replaceAllUsesWith(CurBB);
274 delete ReturnBlock.getBlock();
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000275 } else
John McCallad5d61e2010-07-23 21:56:41 +0000276 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000277 return llvm::DebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000278 }
279
280 // Otherwise, if the return block is the target of a single direct
281 // branch then we can just put the code in that block instead. This
282 // cleans up functions which started with a unified return block.
John McCallad5d61e2010-07-23 21:56:41 +0000283 if (ReturnBlock.getBlock()->hasOneUse()) {
Mike Stump11289f42009-09-09 15:08:12 +0000284 llvm::BranchInst *BI =
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000285 dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin());
John McCallbd309292010-07-06 01:34:17 +0000286 if (BI && BI->isUnconditional() &&
John McCallad5d61e2010-07-23 21:56:41 +0000287 BI->getSuccessor(0) == ReturnBlock.getBlock()) {
David Blaikie66e41972015-01-14 07:38:27 +0000288 // Record/return the DebugLoc of the simple 'return' expression to be used
289 // later by the actual 'ret' instruction.
290 llvm::DebugLoc Loc = BI->getDebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000291 Builder.SetInsertPoint(BI->getParent());
292 BI->eraseFromParent();
John McCallad5d61e2010-07-23 21:56:41 +0000293 delete ReturnBlock.getBlock();
David Blaikie66e41972015-01-14 07:38:27 +0000294 return Loc;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000295 }
296 }
297
Mike Stump18bb9282009-05-16 07:57:57 +0000298 // FIXME: We are at an unreachable point, there is no reason to emit the block
299 // unless it has uses. However, we still need a place to put the debug
300 // region.end for now.
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000301
John McCallad5d61e2010-07-23 21:56:41 +0000302 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000303 return llvm::DebugLoc();
John McCallbd309292010-07-06 01:34:17 +0000304}
305
306static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) {
307 if (!BB) return;
308 if (!BB->use_empty())
309 return CGF.CurFn->getBasicBlockList().push_back(BB);
310 delete BB;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000311}
312
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000313void CodeGenFunction::FinishFunction(SourceLocation EndLoc) {
Chris Lattnere73e4322007-07-16 21:28:45 +0000314 assert(BreakContinueStack.empty() &&
315 "mismatched push/pop in break/continue stack!");
Mike Stump11289f42009-09-09 15:08:12 +0000316
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000317 bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0
Adrian Prantl524ba1f2013-07-25 00:23:42 +0000318 && NumSimpleReturnExprs == NumReturnExprs
319 && ReturnBlock.getBlock()->use_empty();
320 // Usually the return expression is evaluated before the cleanup
321 // code. If the function contains only a simple return statement,
322 // such as a constant, the location before the cleanup code becomes
323 // the last useful breakpoint in the function, because the simple
324 // return expression will be evaluated after the cleanup code. To be
325 // safe, set the debug location for cleanup code to the location of
326 // the return statement. Otherwise the cleanup code should be at the
327 // end of the function's lexical scope.
328 //
329 // If there are multiple branches to the return block, the branch
330 // instructions will get the location of the return statements and
331 // all will be fine.
Adrian Prantl3be10542013-05-02 17:30:20 +0000332 if (CGDebugInfo *DI = getDebugInfo()) {
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000333 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000334 DI->EmitLocation(Builder, LastStopPoint);
Adrian Prantl3be10542013-05-02 17:30:20 +0000335 else
Adrian Prantle83b1302014-01-07 22:05:52 +0000336 DI->EmitLocation(Builder, EndLoc);
Adrian Prantl3be10542013-05-02 17:30:20 +0000337 }
David Blaikie357aafb2013-02-01 19:09:49 +0000338
John McCall31168b02011-06-15 23:02:42 +0000339 // Pop any cleanups that might have been associated with the
340 // parameters. Do this in whatever block we're currently in; it's
341 // important to do this before we enter the return block or return
342 // edges will be *really* confused.
David Majnemerdc012fa2015-04-22 21:38:15 +0000343 bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth;
344 bool HasOnlyLifetimeMarkers =
345 HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth);
346 bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers;
347 if (HasCleanups) {
Adrian Prantl3be10542013-05-02 17:30:20 +0000348 // Make sure the line table doesn't jump back into the body for
349 // the ret after it's been at EndLoc.
Adrian Prantl3be10542013-05-02 17:30:20 +0000350 if (CGDebugInfo *DI = getDebugInfo())
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000351 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000352 DI->EmitLocation(Builder, EndLoc);
David Blaikie4d524432015-02-04 19:47:54 +0000353
354 PopCleanupBlocks(PrologueCleanupDepth);
Adrian Prantl3be10542013-05-02 17:30:20 +0000355 }
356
Mike Stump11289f42009-09-09 15:08:12 +0000357 // Emit function epilog (to return).
David Blaikie66e41972015-01-14 07:38:27 +0000358 llvm::DebugLoc Loc = EmitReturnBlock();
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000359
Hans Wennborg76c26c12017-11-14 21:13:27 +0000360 if (ShouldInstrumentFunction()) {
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000361 if (CGM.getCodeGenOpts().InstrumentFunctions)
362 CurFn->addFnAttr("instrument-function-exit", "__cyg_profile_func_exit");
363 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
364 CurFn->addFnAttr("instrument-function-exit-inlined",
365 "__cyg_profile_func_exit");
Hans Wennborg76c26c12017-11-14 21:13:27 +0000366 }
Chris Lattner3c77a352010-06-22 00:03:40 +0000367
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000368 // Emit debug descriptor for function end.
David Blaikie66e41972015-01-14 07:38:27 +0000369 if (CGDebugInfo *DI = getDebugInfo())
Keno Fischer41d4b4e2017-06-01 21:14:03 +0000370 DI->EmitFunctionEnd(Builder, CurFn);
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000371
David Blaikie66e41972015-01-14 07:38:27 +0000372 // Reset the debug location to that of the simple 'return' expression, if any
373 // rather than that of the end of the function's scope '}'.
374 ApplyDebugLocation AL(*this, Loc);
Nick Lewycky2d84e842013-10-02 02:29:49 +0000375 EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc);
Mike Stump1d849212009-12-07 23:38:24 +0000376 EmitEndEHSpec(CurCodeDecl);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000377
John McCallbd309292010-07-06 01:34:17 +0000378 assert(EHStack.empty() &&
379 "did not remove all scopes from cleanup stack!");
380
Chris Lattner6c4d2552009-10-28 23:59:40 +0000381 // If someone did an indirect goto, emit the indirect goto block at the end of
382 // the function.
383 if (IndirectBranch) {
384 EmitBlock(IndirectBranch->getParent());
385 Builder.ClearInsertionPoint();
386 }
Michael Ilseman686240a2012-12-04 00:29:55 +0000387
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000388 // If some of our locals escaped, insert a call to llvm.localescape in the
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000389 // entry block.
390 if (!EscapedLocals.empty()) {
391 // Invert the map from local to index into a simple vector. There should be
392 // no holes.
393 SmallVector<llvm::Value *, 4> EscapeArgs;
394 EscapeArgs.resize(EscapedLocals.size());
395 for (auto &Pair : EscapedLocals)
396 EscapeArgs[Pair.second] = Pair.first;
397 llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration(
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000398 &CGM.getModule(), llvm::Intrinsic::localescape);
John McCall7f416cc2015-09-08 08:05:57 +0000399 CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs);
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000400 }
401
Chris Lattnerc48023b2007-12-02 06:32:24 +0000402 // Remove the AllocaInsertPt instruction, which is just a convenience for us.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000403 llvm::Instruction *Ptr = AllocaInsertPt;
Craig Topper8a13c412014-05-21 05:09:00 +0000404 AllocaInsertPt = nullptr;
Chris Lattner2739d2b2009-03-31 22:17:44 +0000405 Ptr->eraseFromParent();
Michael Ilseman686240a2012-12-04 00:29:55 +0000406
Chris Lattner6c4d2552009-10-28 23:59:40 +0000407 // If someone took the address of a label but never did an indirect goto, we
408 // made a zero entry PHI node, which is illegal, zap it now.
409 if (IndirectBranch) {
410 llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress());
411 if (PN->getNumIncomingValues() == 0) {
412 PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType()));
413 PN->eraseFromParent();
414 }
415 }
John McCallbd309292010-07-06 01:34:17 +0000416
John McCall8e4c74b2011-08-11 02:22:43 +0000417 EmitIfUsed(*this, EHResumeBlock);
John McCallbd309292010-07-06 01:34:17 +0000418 EmitIfUsed(*this, TerminateLandingPad);
419 EmitIfUsed(*this, TerminateHandler);
420 EmitIfUsed(*this, UnreachableBlock);
John McCall09ae0322010-07-06 23:57:41 +0000421
Reid Kleckner06f19a02018-01-02 21:34:16 +0000422 for (const auto &FuncletAndParent : TerminateFunclets)
423 EmitIfUsed(*this, FuncletAndParent.second);
424
John McCall09ae0322010-07-06 23:57:41 +0000425 if (CGM.getCodeGenOpts().EmitDeclMetadata)
426 EmitDeclMetadata();
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000427
428 for (SmallVectorImpl<std::pair<llvm::Instruction *, llvm::Value *> >::iterator
429 I = DeferredReplacements.begin(),
430 E = DeferredReplacements.end();
431 I != E; ++I) {
432 I->first->replaceAllUsesWith(I->second);
433 I->first->eraseFromParent();
434 }
Gor Nishanov04491bd2017-11-11 17:00:43 +0000435
436 // Eliminate CleanupDestSlot alloca by replacing it with SSA values and
437 // PHIs if the current function is a coroutine. We don't do it for all
438 // functions as it may result in slight increase in numbers of instructions
439 // if compiled with no optimizations. We do it for coroutine as the lifetime
440 // of CleanupDestSlot alloca make correct coroutine frame building very
441 // difficult.
442 if (NormalCleanupDest && isCoroutine()) {
443 llvm::DominatorTree DT(*CurFn);
444 llvm::PromoteMemToReg(NormalCleanupDest, DT);
445 NormalCleanupDest = nullptr;
446 }
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000447}
Chris Lattner308f4312007-05-29 23:50:05 +0000448
Chris Lattner3c77a352010-06-22 00:03:40 +0000449/// ShouldInstrumentFunction - Return true if the current function should be
450/// instrumented with __cyg_profile_func_* calls
451bool CodeGenFunction::ShouldInstrumentFunction() {
Hans Wennborg76c26c12017-11-14 21:13:27 +0000452 if (!CGM.getCodeGenOpts().InstrumentFunctions &&
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000453 !CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining &&
454 !CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
Chris Lattner3c77a352010-06-22 00:03:40 +0000455 return false;
Ted Kremenekc249c412011-05-16 23:49:20 +0000456 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
Chris Lattner3c77a352010-06-22 00:03:40 +0000457 return false;
458 return true;
459}
460
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000461/// ShouldXRayInstrument - Return true if the current function should be
462/// instrumented with XRay nop sleds.
463bool CodeGenFunction::ShouldXRayInstrumentFunction() const {
464 return CGM.getCodeGenOpts().XRayInstrumentFunctions;
465}
466
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000467/// AlwaysEmitXRayCustomEvents - Return true if we should emit IR for calls to
468/// the __xray_customevent(...) builin calls, when doing XRay instrumentation.
469bool CodeGenFunction::AlwaysEmitXRayCustomEvents() const {
470 return CGM.getCodeGenOpts().XRayAlwaysEmitCustomEvents;
471}
472
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000473llvm::Constant *
474CodeGenFunction::EncodeAddrForUseInPrologue(llvm::Function *F,
475 llvm::Constant *Addr) {
476 // Addresses stored in prologue data can't require run-time fixups and must
477 // be PC-relative. Run-time fixups are undesirable because they necessitate
478 // writable text segments, which are unsafe. And absolute addresses are
479 // undesirable because they break PIE mode.
480
481 // Add a layer of indirection through a private global. Taking its address
482 // won't result in a run-time fixup, even if Addr has linkonce_odr linkage.
483 auto *GV = new llvm::GlobalVariable(CGM.getModule(), Addr->getType(),
484 /*isConstant=*/true,
485 llvm::GlobalValue::PrivateLinkage, Addr);
486
487 // Create a PC-relative address.
488 auto *GOTAsInt = llvm::ConstantExpr::getPtrToInt(GV, IntPtrTy);
489 auto *FuncAsInt = llvm::ConstantExpr::getPtrToInt(F, IntPtrTy);
490 auto *PCRelAsInt = llvm::ConstantExpr::getSub(GOTAsInt, FuncAsInt);
491 return (IntPtrTy == Int32Ty)
492 ? PCRelAsInt
493 : llvm::ConstantExpr::getTrunc(PCRelAsInt, Int32Ty);
494}
495
496llvm::Value *
497CodeGenFunction::DecodeAddrUsedInPrologue(llvm::Value *F,
498 llvm::Value *EncodedAddr) {
499 // Reconstruct the address of the global.
500 auto *PCRelAsInt = Builder.CreateSExt(EncodedAddr, IntPtrTy);
501 auto *FuncAsInt = Builder.CreatePtrToInt(F, IntPtrTy, "func_addr.int");
502 auto *GOTAsInt = Builder.CreateAdd(PCRelAsInt, FuncAsInt, "global_addr.int");
503 auto *GOTAddr = Builder.CreateIntToPtr(GOTAsInt, Int8PtrPtrTy, "global_addr");
504
505 // Load the original pointer through the global.
506 return Builder.CreateLoad(Address(GOTAddr, getPointerAlign()),
507 "decoded_addr");
508}
509
Alexey Bader3e0b8172016-09-06 10:10:28 +0000510static void removeImageAccessQualifier(std::string& TyName) {
511 std::string ReadOnlyQual("__read_only");
512 std::string::size_type ReadOnlyPos = TyName.find(ReadOnlyQual);
513 if (ReadOnlyPos != std::string::npos)
514 // "+ 1" for the space after access qualifier.
515 TyName.erase(ReadOnlyPos, ReadOnlyQual.size() + 1);
516 else {
517 std::string WriteOnlyQual("__write_only");
518 std::string::size_type WriteOnlyPos = TyName.find(WriteOnlyQual);
519 if (WriteOnlyPos != std::string::npos)
520 TyName.erase(WriteOnlyPos, WriteOnlyQual.size() + 1);
521 else {
522 std::string ReadWriteQual("__read_write");
523 std::string::size_type ReadWritePos = TyName.find(ReadWriteQual);
524 if (ReadWritePos != std::string::npos)
525 TyName.erase(ReadWritePos, ReadWriteQual.size() + 1);
526 }
527 }
528}
529
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000530// Returns the address space id that should be produced to the
531// kernel_arg_addr_space metadata. This is always fixed to the ids
532// as specified in the SPIR 2.0 specification in order to differentiate
533// for example in clGetKernelArgInfo() implementation between the address
534// spaces with targets without unique mapping to the OpenCL address spaces
535// (basically all single AS CPUs).
Alexander Richardson6d989432017-10-15 18:48:14 +0000536static unsigned ArgInfoAddressSpace(LangAS AS) {
537 switch (AS) {
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000538 case LangAS::opencl_global: return 1;
539 case LangAS::opencl_constant: return 2;
540 case LangAS::opencl_local: return 3;
541 case LangAS::opencl_generic: return 4; // Not in SPIR 2.0 specs.
542 default:
543 return 0; // Assume private.
544 }
545}
546
Tanya Lattner7445ada2012-07-11 23:02:10 +0000547// OpenCL v1.2 s5.6.4.6 allows the compiler to store kernel argument
548// information in the program executable. The argument information stored
549// includes the argument name, its type, the address and access qualifiers used.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000550static void GenOpenCLArgMetadata(const FunctionDecl *FD, llvm::Function *Fn,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000551 CodeGenModule &CGM, llvm::LLVMContext &Context,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000552 CGBuilderTy &Builder, ASTContext &ASTCtx) {
Guy Benyeifb36ede2013-03-24 13:58:12 +0000553 // Create MDNodes that represent the kernel arg metadata.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000554 // Each MDNode is a list in the form of "key", N number of values which is
555 // the same number of values as their are kernel arguments.
Michael Ilseman686240a2012-12-04 00:29:55 +0000556
Joey Gouly92a47442014-04-04 13:43:57 +0000557 const PrintingPolicy &Policy = ASTCtx.getPrintingPolicy();
558
Guy Benyeifb36ede2013-03-24 13:58:12 +0000559 // MDNode for the kernel argument address space qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000560 SmallVector<llvm::Metadata *, 8> addressQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000561
562 // MDNode for the kernel argument access qualifiers (images only).
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000563 SmallVector<llvm::Metadata *, 8> accessQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000564
565 // MDNode for the kernel argument type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000566 SmallVector<llvm::Metadata *, 8> argTypeNames;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000567
Fraser Cormackdadc3712014-07-30 14:39:53 +0000568 // MDNode for the kernel argument base type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000569 SmallVector<llvm::Metadata *, 8> argBaseTypeNames;
Fraser Cormackdadc3712014-07-30 14:39:53 +0000570
Guy Benyeifb36ede2013-03-24 13:58:12 +0000571 // MDNode for the kernel argument type qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000572 SmallVector<llvm::Metadata *, 8> argTypeQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000573
Tanya Lattner7445ada2012-07-11 23:02:10 +0000574 // MDNode for the kernel argument names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000575 SmallVector<llvm::Metadata *, 8> argNames;
Michael Ilseman686240a2012-12-04 00:29:55 +0000576
Tanya Lattner7445ada2012-07-11 23:02:10 +0000577 for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i) {
578 const ParmVarDecl *parm = FD->getParamDecl(i);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000579 QualType ty = parm->getType();
580 std::string typeQuals;
581
582 if (ty->isPointerType()) {
583 QualType pointeeTy = ty->getPointeeType();
584
585 // Get address qualifier.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000586 addressQuals.push_back(llvm::ConstantAsMetadata::get(Builder.getInt32(
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000587 ArgInfoAddressSpace(pointeeTy.getAddressSpace()))));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000588
589 // Get argument type name.
Joey Gouly92a47442014-04-04 13:43:57 +0000590 std::string typeName =
591 pointeeTy.getUnqualifiedType().getAsString(Policy) + "*";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000592
593 // Turn "unsigned type" to "utype"
594 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000595 if (pointeeTy.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000596 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000597
598 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
599
Fraser Cormackdadc3712014-07-30 14:39:53 +0000600 std::string baseTypeName =
601 pointeeTy.getUnqualifiedType().getCanonicalType().getAsString(
602 Policy) +
603 "*";
604
605 // Turn "unsigned type" to "utype"
606 pos = baseTypeName.find("unsigned");
607 if (pos != std::string::npos)
608 baseTypeName.erase(pos+1, 8);
609
610 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName));
611
Guy Benyeifb36ede2013-03-24 13:58:12 +0000612 // Get argument type qualifiers:
613 if (ty.isRestrictQualified())
614 typeQuals = "restrict";
615 if (pointeeTy.isConstQualified() ||
616 (pointeeTy.getAddressSpace() == LangAS::opencl_constant))
Benjamin Krameref89ae02013-03-24 16:04:55 +0000617 typeQuals += typeQuals.empty() ? "const" : " const";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000618 if (pointeeTy.isVolatileQualified())
Benjamin Krameref89ae02013-03-24 16:04:55 +0000619 typeQuals += typeQuals.empty() ? "volatile" : " volatile";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000620 } else {
Pekka Jaaskelainen3587b322014-01-09 13:37:30 +0000621 uint32_t AddrSpc = 0;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000622 bool isPipe = ty->isPipeType();
623 if (ty->isImageType() || isPipe)
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000624 AddrSpc = ArgInfoAddressSpace(LangAS::opencl_global);
Bob Wilson95a27b02014-02-17 19:20:59 +0000625
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000626 addressQuals.push_back(
627 llvm::ConstantAsMetadata::get(Builder.getInt32(AddrSpc)));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000628
629 // Get argument type name.
Xiuli Pan9c14e282016-01-09 12:53:17 +0000630 std::string typeName;
631 if (isPipe)
Alexey Bader10e9e592016-07-13 10:28:13 +0000632 typeName = ty.getCanonicalType()->getAs<PipeType>()->getElementType()
633 .getAsString(Policy);
Xiuli Pan9c14e282016-01-09 12:53:17 +0000634 else
635 typeName = ty.getUnqualifiedType().getAsString(Policy);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000636
637 // Turn "unsigned type" to "utype"
638 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000639 if (ty.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000640 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000641
Xiuli Pan9c14e282016-01-09 12:53:17 +0000642 std::string baseTypeName;
643 if (isPipe)
Alexey Bader10e9e592016-07-13 10:28:13 +0000644 baseTypeName = ty.getCanonicalType()->getAs<PipeType>()
645 ->getElementType().getCanonicalType()
646 .getAsString(Policy);
Xiuli Pan9c14e282016-01-09 12:53:17 +0000647 else
648 baseTypeName =
Fraser Cormackdadc3712014-07-30 14:39:53 +0000649 ty.getUnqualifiedType().getCanonicalType().getAsString(Policy);
650
Alexey Bader3e0b8172016-09-06 10:10:28 +0000651 // Remove access qualifiers on images
652 // (as they are inseparable from type in clang implementation,
653 // but OpenCL spec provides a special query to get access qualifier
654 // via clGetKernelArgInfo with CL_KERNEL_ARG_ACCESS_QUALIFIER):
655 if (ty->isImageType()) {
656 removeImageAccessQualifier(typeName);
657 removeImageAccessQualifier(baseTypeName);
658 }
659
660 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
661
Fraser Cormackdadc3712014-07-30 14:39:53 +0000662 // Turn "unsigned type" to "utype"
663 pos = baseTypeName.find("unsigned");
664 if (pos != std::string::npos)
665 baseTypeName.erase(pos+1, 8);
666
667 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName));
668
Xiuli Pan9c14e282016-01-09 12:53:17 +0000669 if (isPipe)
670 typeQuals = "pipe";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000671 }
Justin Bogner0f066062013-11-22 10:20:40 +0000672
Guy Benyeifb36ede2013-03-24 13:58:12 +0000673 argTypeQuals.push_back(llvm::MDString::get(Context, typeQuals));
674
Xiuli Pan9c14e282016-01-09 12:53:17 +0000675 // Get image and pipe access qualifier:
Xiuli Pan9c14e282016-01-09 12:53:17 +0000676 if (ty->isImageType()|| ty->isPipeType()) {
Alexey Sotkin7d7f0dc2017-07-26 18:49:54 +0000677 const Decl *PDecl = parm;
678 if (auto *TD = dyn_cast<TypedefType>(ty))
679 PDecl = TD->getDecl();
680 const OpenCLAccessAttr *A = PDecl->getAttr<OpenCLAccessAttr>();
Aaron Ballman26891332014-01-14 17:41:53 +0000681 if (A && A->isWriteOnly())
Guy Benyeifb36ede2013-03-24 13:58:12 +0000682 accessQuals.push_back(llvm::MDString::get(Context, "write_only"));
Xiuli Pan11e13f62016-02-26 03:13:03 +0000683 else if (A && A->isReadWrite())
684 accessQuals.push_back(llvm::MDString::get(Context, "read_write"));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000685 else
686 accessQuals.push_back(llvm::MDString::get(Context, "read_only"));
687 } else
688 accessQuals.push_back(llvm::MDString::get(Context, "none"));
Michael Ilseman686240a2012-12-04 00:29:55 +0000689
Tanya Lattner7445ada2012-07-11 23:02:10 +0000690 // Get argument name.
691 argNames.push_back(llvm::MDString::get(Context, parm->getName()));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000692 }
Guy Benyeifb36ede2013-03-24 13:58:12 +0000693
Yaxun Liuba28cba2016-06-22 14:56:35 +0000694 Fn->setMetadata("kernel_arg_addr_space",
695 llvm::MDNode::get(Context, addressQuals));
696 Fn->setMetadata("kernel_arg_access_qual",
697 llvm::MDNode::get(Context, accessQuals));
698 Fn->setMetadata("kernel_arg_type",
699 llvm::MDNode::get(Context, argTypeNames));
700 Fn->setMetadata("kernel_arg_base_type",
701 llvm::MDNode::get(Context, argBaseTypeNames));
702 Fn->setMetadata("kernel_arg_type_qual",
703 llvm::MDNode::get(Context, argTypeQuals));
Sameer Sahasrabuddhec6093fe2014-12-04 05:30:58 +0000704 if (CGM.getCodeGenOpts().EmitOpenCLArgMetadata)
Yaxun Liuba28cba2016-06-22 14:56:35 +0000705 Fn->setMetadata("kernel_arg_name",
706 llvm::MDNode::get(Context, argNames));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000707}
708
Michael Ilseman686240a2012-12-04 00:29:55 +0000709void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000710 llvm::Function *Fn)
711{
712 if (!FD->hasAttr<OpenCLKernelAttr>())
713 return;
714
715 llvm::LLVMContext &Context = getLLVMContext();
716
Yaxun Liuba28cba2016-06-22 14:56:35 +0000717 GenOpenCLArgMetadata(FD, Fn, CGM, Context, Builder, getContext());
Michael Ilseman686240a2012-12-04 00:29:55 +0000718
Aaron Ballmanc4327992013-12-19 03:09:10 +0000719 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000720 QualType HintQTy = A->getTypeHint();
721 const ExtVectorType *HintEltQTy = HintQTy->getAs<ExtVectorType>();
722 bool IsSignedInteger =
723 HintQTy->isSignedIntegerType() ||
724 (HintEltQTy && HintEltQTy->getElementType()->isSignedIntegerType());
725 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000726 llvm::ConstantAsMetadata::get(llvm::UndefValue::get(
727 CGM.getTypes().ConvertType(A->getTypeHint()))),
728 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
729 llvm::IntegerType::get(Context, 32),
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000730 llvm::APInt(32, (uint64_t)(IsSignedInteger ? 1 : 0))))};
731 Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, AttrMDArgs));
Joey Goulyaba589c2013-03-08 09:42:32 +0000732 }
733
Aaron Ballmanc4327992013-12-19 03:09:10 +0000734 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000735 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000736 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
737 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
738 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000739 Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000740 }
741
Aaron Ballmanc4327992013-12-19 03:09:10 +0000742 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000743 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000744 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
745 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
746 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000747 Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, AttrMDArgs));
748 }
749
750 if (const OpenCLIntelReqdSubGroupSizeAttr *A =
751 FD->getAttr<OpenCLIntelReqdSubGroupSizeAttr>()) {
752 llvm::Metadata *AttrMDArgs[] = {
753 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getSubGroupSize()))};
754 Fn->setMetadata("intel_reqd_sub_group_size",
755 llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000756 }
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000757}
758
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000759/// Determine whether the function F ends with a return stmt.
760static bool endsWithReturn(const Decl* F) {
761 const Stmt *Body = nullptr;
762 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F))
763 Body = FD->getBody();
764 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F))
765 Body = OMD->getBody();
766
767 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) {
768 auto LastStmt = CS->body_rbegin();
769 if (LastStmt != CS->body_rend())
770 return isa<ReturnStmt>(*LastStmt);
771 }
772 return false;
773}
774
Anna Zakse43b4fc2017-01-13 00:50:50 +0000775static void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) {
776 Fn->addFnAttr("sanitize_thread_no_checking_at_run_time");
777 Fn->removeFnAttr(llvm::Attribute::SanitizeThread);
778}
779
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000780static bool matchesStlAllocatorFn(const Decl *D, const ASTContext &Ctx) {
781 auto *MD = dyn_cast_or_null<CXXMethodDecl>(D);
782 if (!MD || !MD->getDeclName().getAsIdentifierInfo() ||
783 !MD->getDeclName().getAsIdentifierInfo()->isStr("allocate") ||
784 (MD->getNumParams() != 1 && MD->getNumParams() != 2))
785 return false;
786
787 if (MD->parameters()[0]->getType().getCanonicalType() != Ctx.getSizeType())
788 return false;
789
790 if (MD->getNumParams() == 2) {
791 auto *PT = MD->parameters()[1]->getType()->getAs<PointerType>();
792 if (!PT || !PT->isVoidPointerType() ||
793 !PT->getPointeeType().isConstQualified())
794 return false;
795 }
796
797 return true;
798}
799
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000800/// Return the UBSan prologue signature for \p FD if one is available.
801static llvm::Constant *getPrologueSignature(CodeGenModule &CGM,
802 const FunctionDecl *FD) {
803 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
804 if (!MD->isStatic())
805 return nullptr;
806 return CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM);
807}
808
John McCalldec348f72013-05-03 07:33:41 +0000809void CodeGenFunction::StartFunction(GlobalDecl GD,
810 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000811 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +0000812 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000813 const FunctionArgList &Args,
Adrian Prantl42d71b92014-04-10 23:21:53 +0000814 SourceLocation Loc,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +0000815 SourceLocation StartLoc) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000816 assert(!CurFn &&
817 "Do not use a CodeGenFunction object for more than one function");
818
Anders Carlsson73fcc952009-09-11 00:07:24 +0000819 const Decl *D = GD.getDecl();
Michael Ilseman686240a2012-12-04 00:29:55 +0000820
Anders Carlssonf4478e92009-02-09 20:20:56 +0000821 DidCallStackSave = false;
John McCalldec348f72013-05-03 07:33:41 +0000822 CurCodeDecl = D;
David Majnemer25eb1652016-03-01 19:42:53 +0000823 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D))
824 if (FD->usesSEHTry())
825 CurSEHParent = FD;
Craig Topper8a13c412014-05-21 05:09:00 +0000826 CurFuncDecl = (D ? D->getNonClosureContext() : nullptr);
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000827 FnRetTy = RetTy;
Daniel Dunbar9c426522008-07-29 23:18:29 +0000828 CurFn = Fn;
John McCalla738c252011-03-09 04:27:21 +0000829 CurFnInfo = &FnInfo;
Chris Lattner5696e7b2008-06-17 18:05:57 +0000830 assert(CurFn->isDeclaration() && "Function already has body?");
831
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +0000832 // If this function has been blacklisted for any of the enabled sanitizers,
833 // disable the sanitizer for the function.
834 do {
835#define SANITIZER(NAME, ID) \
836 if (SanOpts.empty()) \
837 break; \
838 if (SanOpts.has(SanitizerKind::ID)) \
839 if (CGM.isInSanitizerBlacklist(SanitizerKind::ID, Fn, Loc)) \
840 SanOpts.set(SanitizerKind::ID, false);
841
842#include "clang/Basic/Sanitizers.def"
843#undef SANITIZER
844 } while (0);
Will Dietzf54319c2013-01-18 11:30:38 +0000845
Peter Collingbourne915df992015-05-15 18:33:32 +0000846 if (D) {
847 // Apply the no_sanitize* attributes to SanOpts.
848 for (auto Attr : D->specific_attrs<NoSanitizeAttr>())
849 SanOpts.Mask &= ~Attr->getMask();
850 }
851
852 // Apply sanitizer attributes to the function.
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000853 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress))
Peter Collingbourne915df992015-05-15 18:33:32 +0000854 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000855 if (SanOpts.hasOneOf(SanitizerKind::HWAddress))
856 Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress);
Peter Collingbourne915df992015-05-15 18:33:32 +0000857 if (SanOpts.has(SanitizerKind::Thread))
858 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
859 if (SanOpts.has(SanitizerKind::Memory))
860 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000861 if (SanOpts.has(SanitizerKind::SafeStack))
862 Fn->addFnAttr(llvm::Attribute::SafeStack);
Peter Collingbourne915df992015-05-15 18:33:32 +0000863
Anna Zaksbcd35a82016-11-11 23:22:44 +0000864 // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize,
Anna Zakse43b4fc2017-01-13 00:50:50 +0000865 // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time.
Anna Zaksbcd35a82016-11-11 23:22:44 +0000866 if (SanOpts.has(SanitizerKind::Thread)) {
867 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
868 IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0);
869 if (OMD->getMethodFamily() == OMF_dealloc ||
870 OMD->getMethodFamily() == OMF_initialize ||
871 (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) {
Anna Zakse43b4fc2017-01-13 00:50:50 +0000872 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000873 }
Anna Zakse43b4fc2017-01-13 00:50:50 +0000874 } else if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D)) {
875 IdentifierInfo *II = FD->getIdentifier();
876 if (II && II->isStr("__destroy_helper_block_"))
877 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000878 }
879 }
880
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000881 // Ignore unrelated casts in STL allocate() since the allocator must cast
882 // from void* to T* before object initialization completes. Don't match on the
883 // namespace because not all allocators are in std::
884 if (D && SanOpts.has(SanitizerKind::CFIUnrelatedCast)) {
885 if (matchesStlAllocatorFn(D, getContext()))
886 SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast;
887 }
888
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000889 // Apply xray attributes to the function (as a string, for now)
890 if (D && ShouldXRayInstrumentFunction()) {
891 if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) {
892 if (XRayAttr->alwaysXRayInstrument())
893 Fn->addFnAttr("function-instrument", "xray-always");
894 if (XRayAttr->neverXRayInstrument())
895 Fn->addFnAttr("function-instrument", "xray-never");
Dean Michael Berris418da3f2017-03-06 07:08:21 +0000896 if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>()) {
897 Fn->addFnAttr("xray-log-args",
898 llvm::utostr(LogArgs->getArgumentCount()));
899 }
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000900 } else {
Dean Michael Berris835832d2017-03-30 00:29:36 +0000901 if (!CGM.imbueXRayAttrs(Fn, Loc))
902 Fn->addFnAttr(
903 "xray-instruction-threshold",
904 llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold));
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000905 }
906 }
907
Nirav Daved2f44d82016-04-05 17:50:43 +0000908 // Add no-jump-tables value.
909 Fn->addFnAttr("no-jump-tables",
910 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables));
911
Dehao Chen5e97f232017-08-24 21:37:33 +0000912 // Add profile-sample-accurate value.
913 if (CGM.getCodeGenOpts().ProfileSampleAccurate)
914 Fn->addFnAttr("profile-sample-accurate");
915
Richard Smith9c6890a2012-11-01 22:30:59 +0000916 if (getLangOpts().OpenCL) {
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000917 // Add metadata for a kernel function.
918 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000919 EmitOpenCLKernelMetadata(FD, Fn);
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000920 }
921
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000922 // If we are checking function types, emit a function type signature as
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000923 // prologue data.
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000924 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000925 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000926 if (llvm::Constant *PrologueSig = getPrologueSignature(CGM, FD)) {
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000927 llvm::Constant *FTRTTIConst =
928 CGM.GetAddrOfRTTIDescriptor(FD->getType(), /*ForEH=*/true);
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000929 llvm::Constant *FTRTTIConstEncoded =
930 EncodeAddrForUseInPrologue(Fn, FTRTTIConst);
931 llvm::Constant *PrologueStructElems[] = {PrologueSig,
932 FTRTTIConstEncoded};
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000933 llvm::Constant *PrologueStructConst =
934 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
935 Fn->setPrologueData(PrologueStructConst);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000936 }
937 }
938 }
939
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000940 // If we're checking nullability, we need to know whether we can check the
941 // return value. Initialize the flag to 'true' and refine it in EmitParmDecl.
942 if (SanOpts.has(SanitizerKind::NullabilityReturn)) {
943 auto Nullability = FnRetTy->getNullability(getContext());
944 if (Nullability && *Nullability == NullabilityKind::NonNull) {
945 if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
946 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>()))
947 RetValNullabilityPrecondition =
948 llvm::ConstantInt::getTrue(getLLVMContext());
949 }
950 }
951
James Molloyc16a60b62015-11-12 15:36:04 +0000952 // If we're in C++ mode and the function name is "main", it is guaranteed
953 // to be norecurse by the standard (3.6.1.3 "The function main shall not be
954 // used within a program").
955 if (getLangOpts().CPlusPlus)
956 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
957 if (FD->isMain())
958 Fn->addFnAttr(llvm::Attribute::NoRecurse);
Honggyu Kim2bbdeac2016-09-01 06:14:45 +0000959
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000960 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000961
Chris Lattner5696e7b2008-06-17 18:05:57 +0000962 // Create a marker to make it easy to insert allocas into the entryblock
963 // later. Don't create this with the builder, because we don't want it
964 // folded.
Chris Lattner5e016ae2010-06-27 07:15:29 +0000965 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
Mehdi Amini557c20a2016-03-13 21:05:23 +0000966 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000967
John McCallbd309292010-07-06 01:34:17 +0000968 ReturnBlock = getJumpDestInCurrentScope("return");
Mike Stump11289f42009-09-09 15:08:12 +0000969
Chris Lattner5696e7b2008-06-17 18:05:57 +0000970 Builder.SetInsertPoint(EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000971
Vedant Kumarc34d3432017-06-23 21:32:38 +0000972 // If we're checking the return value, allocate space for a pointer to a
973 // precise source location of the checked return statement.
974 if (requiresReturnValueCheck()) {
975 ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr");
976 InitTempAlloca(ReturnLocation, llvm::ConstantPointerNull::get(Int8PtrTy));
977 }
978
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000979 // Emit subprogram debug descriptor.
Anders Carlsson63784f42009-02-13 08:11:52 +0000980 if (CGDebugInfo *DI = getDebugInfo()) {
Reid Klecknerf00f8032016-06-08 20:41:54 +0000981 // Reconstruct the type from the argument list so that implicit parameters,
982 // such as 'this' and 'vtt', show up in the debug info. Preserve the calling
983 // convention.
984 CallingConv CC = CallingConv::CC_C;
985 if (auto *FD = dyn_cast_or_null<FunctionDecl>(D))
986 if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>())
987 CC = SrcFnTy->getCallConv();
Jordan Rose5c382722013-03-08 21:51:21 +0000988 SmallVector<QualType, 16> ArgTypes;
Reid Klecknerf00f8032016-06-08 20:41:54 +0000989 for (const VarDecl *VD : Args)
990 ArgTypes.push_back(VD->getType());
991 QualType FnType = getContext().getFunctionType(
992 RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Adrian Prantl42d71b92014-04-10 23:21:53 +0000993 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, Builder);
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000994 }
995
Hans Wennborg76c26c12017-11-14 21:13:27 +0000996 if (ShouldInstrumentFunction()) {
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000997 if (CGM.getCodeGenOpts().InstrumentFunctions)
998 CurFn->addFnAttr("instrument-function-entry", "__cyg_profile_func_enter");
999 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
1000 CurFn->addFnAttr("instrument-function-entry-inlined",
1001 "__cyg_profile_func_enter");
1002 if (CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
1003 CurFn->addFnAttr("instrument-function-entry-inlined",
1004 "__cyg_profile_func_enter_bare");
Hans Wennborg76c26c12017-11-14 21:13:27 +00001005 }
Chris Lattner3c77a352010-06-22 00:03:40 +00001006
Honggyu Kim2b0e4242016-09-01 11:29:21 +00001007 // Since emitting the mcount call here impacts optimizations such as function
1008 // inlining, we just add an attribute to insert a mcount call in backend.
1009 // The attribute "counting-function" is set to mcount function name which is
1010 // architecture dependent.
Nirav Dave0c86ccf2017-01-31 17:00:35 +00001011 if (CGM.getCodeGenOpts().InstrumentForProfiling) {
1012 if (CGM.getCodeGenOpts().CallFEntry)
1013 Fn->addFnAttr("fentry-call", "true");
Manoj Gupta162b40a2017-06-19 18:45:03 +00001014 else {
Hans Wennborg76c26c12017-11-14 21:13:27 +00001015 if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) {
1016 Fn->addFnAttr("instrument-function-entry-inlined",
1017 getTarget().getMCountName());
1018 }
Manoj Gupta162b40a2017-06-19 18:45:03 +00001019 }
Nirav Dave0c86ccf2017-01-31 17:00:35 +00001020 }
Roman Divacky178e01602011-02-10 16:52:03 +00001021
Eli Friedman4b1942c2009-12-04 02:43:40 +00001022 if (RetTy->isVoidType()) {
1023 // Void type; nothing to return.
John McCall7f416cc2015-09-08 08:05:57 +00001024 ReturnValue = Address::invalid();
Adrian Prantl2cede0f2014-04-29 01:07:59 +00001025
1026 // Count the implicit return.
1027 if (!endsWithReturn(D))
1028 ++NumReturnExprs;
Eli Friedman4b1942c2009-12-04 02:43:40 +00001029 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect &&
John McCall47fb9502013-03-07 21:37:08 +00001030 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
Eli Friedman4b1942c2009-12-04 02:43:40 +00001031 // Indirect aggregate return; emit returned value directly into sret slot.
Daniel Dunbarfd09df72010-02-16 19:45:20 +00001032 // This reduces code size, and affects correctness in C++.
Reid Kleckner37abaca2014-05-09 22:46:15 +00001033 auto AI = CurFn->arg_begin();
1034 if (CurFnInfo->getReturnInfo().isSRetAfterThis())
1035 ++AI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001036 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001037 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
1038 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
1039 // Load the sret pointer from the argument struct and return into that.
1040 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
1041 llvm::Function::arg_iterator EI = CurFn->arg_end();
1042 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001043 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx);
John McCall7f416cc2015-09-08 08:05:57 +00001044 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result");
1045 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy));
Eli Friedman4b1942c2009-12-04 02:43:40 +00001046 } else {
Daniel Dunbarfd09df72010-02-16 19:45:20 +00001047 ReturnValue = CreateIRTemp(RetTy, "retval");
John McCall31168b02011-06-15 23:02:42 +00001048
1049 // Tell the epilog emitter to autorelease the result. We do this
1050 // now so that various specialized functions can suppress it
1051 // during their IR-generation.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001052 if (getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00001053 !CurFnInfo->isReturnsRetained() &&
1054 RetTy->isObjCRetainableType())
1055 AutoreleaseResult = true;
Eli Friedman4b1942c2009-12-04 02:43:40 +00001056 }
1057
Mike Stump1d849212009-12-07 23:38:24 +00001058 EmitStartEHSpec(CurCodeDecl);
John McCall31168b02011-06-15 23:02:42 +00001059
1060 PrologueCleanupDepth = EHStack.stable_begin();
Daniel Dunbard931a872009-02-02 22:03:45 +00001061 EmitFunctionProlog(*CurFnInfo, CurFn, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001062
Eli Friedman9fbeba02012-02-11 02:57:39 +00001063 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
John McCall5d865c322010-08-31 07:33:07 +00001064 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
Eli Friedman9fbeba02012-02-11 02:57:39 +00001065 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
1066 if (MD->getParent()->isLambda() &&
1067 MD->getOverloadedOperator() == OO_Call) {
1068 // We're in a lambda; figure out the captures.
1069 MD->getParent()->getCaptureFields(LambdaCaptureFields,
1070 LambdaThisCaptureField);
1071 if (LambdaThisCaptureField) {
Faisal Validc6b5962016-03-21 09:25:37 +00001072 // If the lambda captures the object referred to by '*this' - either by
1073 // value or by reference, make sure CXXThisValue points to the correct
1074 // object.
1075
1076 // Get the lvalue for the field (which is a copy of the enclosing object
1077 // or contains the address of the enclosing object).
1078 LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
1079 if (!LambdaThisCaptureField->getType()->isPointerType()) {
1080 // If the enclosing object was captured by value, just use its address.
1081 CXXThisValue = ThisFieldLValue.getAddress().getPointer();
1082 } else {
1083 // Load the lvalue pointed to by the field, since '*this' was captured
1084 // by reference.
1085 CXXThisValue =
1086 EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal();
1087 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001088 }
Alexey Bataev39c81e22014-08-28 04:28:19 +00001089 for (auto *FD : MD->getParent()->fields()) {
1090 if (FD->hasCapturedVLAType()) {
1091 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
1092 SourceLocation()).getScalarVal();
1093 auto VAT = FD->getCapturedVLAType();
1094 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
1095 }
1096 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001097 } else {
1098 // Not in a lambda; just use 'this' from the method.
1099 // FIXME: Should we generate a new load for each use of 'this'? The
1100 // fast register allocator would be happier...
1101 CXXThisValue = CXXABIThisValue;
1102 }
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001103
Vedant Kumarffd7c882017-04-14 22:03:34 +00001104 // Check the 'this' pointer once per function, if it's available.
Richard Smith376c28e2017-08-24 20:10:33 +00001105 if (CXXABIThisValue) {
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001106 SanitizerSet SkippedChecks;
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001107 SkippedChecks.set(SanitizerKind::ObjectSize, true);
Vedant Kumarffd7c882017-04-14 22:03:34 +00001108 QualType ThisTy = MD->getThisType(getContext());
Richard Smith376c28e2017-08-24 20:10:33 +00001109
1110 // If this is the call operator of a lambda with no capture-default, it
1111 // may have a static invoker function, which may call this operator with
1112 // a null 'this' pointer.
1113 if (isLambdaCallOperator(MD) &&
1114 cast<CXXRecordDecl>(MD->getParent())->getLambdaCaptureDefault() ==
1115 LCD_None)
1116 SkippedChecks.set(SanitizerKind::Null, true);
1117
1118 EmitTypeCheck(isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall
1119 : TCK_MemberCall,
1120 Loc, CXXABIThisValue, ThisTy,
Vedant Kumarffd7c882017-04-14 22:03:34 +00001121 getContext().getTypeAlignInChars(ThisTy->getPointeeType()),
1122 SkippedChecks);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001123 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001124 }
John McCall347132b2010-02-16 22:04:33 +00001125
Anders Carlssonc20879a2008-12-20 21:28:43 +00001126 // If any of the arguments have a variably modified type, make sure to
1127 // emit the type size.
1128 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
1129 i != e; ++i) {
Eli Friedman1f576832012-11-14 22:09:59 +00001130 const VarDecl *VD = *i;
1131
1132 // Dig out the type as written from ParmVarDecls; it's unclear whether
1133 // the standard (C99 6.9.1p10) requires this, but we're following the
1134 // precedent set by gcc.
1135 QualType Ty;
1136 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
1137 Ty = PVD->getOriginalType();
1138 else
1139 Ty = VD->getType();
Anders Carlssonc20879a2008-12-20 21:28:43 +00001140
1141 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +00001142 EmitVariablyModifiedType(Ty);
Anders Carlssonc20879a2008-12-20 21:28:43 +00001143 }
Eric Christopher7cdf9482011-10-13 21:45:18 +00001144 // Emit a location at the end of the prologue.
1145 if (CGDebugInfo *DI = getDebugInfo())
1146 DI->EmitLocation(Builder, StartLoc);
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001147}
Eli Friedman3d421e12008-08-25 21:31:01 +00001148
Richard Smithb47c36f2013-11-05 09:12:18 +00001149void CodeGenFunction::EmitFunctionBody(FunctionArgList &Args,
1150 const Stmt *Body) {
Justin Bogner66242d62015-04-23 23:06:47 +00001151 incrementProfileCounter(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001152 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
David Blaikie0a21d0d2013-01-26 22:16:26 +00001153 EmitCompoundStmtWithoutScope(*S);
1154 else
Richard Smithb47c36f2013-11-05 09:12:18 +00001155 EmitStmt(Body);
John McCall89b12b32010-02-18 03:17:58 +00001156}
1157
Bob Wilsonbf854f02014-02-17 19:21:09 +00001158/// When instrumenting to collect profile data, the counts for some blocks
1159/// such as switch cases need to not include the fall-through counts, so
1160/// emit a branch around the instrumentation code. When not instrumenting,
1161/// this just calls EmitBlock().
1162void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
Justin Bogner66242d62015-04-23 23:06:47 +00001163 const Stmt *S) {
Craig Topper8a13c412014-05-21 05:09:00 +00001164 llvm::BasicBlock *SkipCountBB = nullptr;
Rong Xu9837ef52016-02-04 18:39:09 +00001165 if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001166 // When instrumenting for profiling, the fallthrough to certain
1167 // statements needs to skip over the instrumentation code so that we
1168 // get an accurate count.
1169 SkipCountBB = createBasicBlock("skipcount");
1170 EmitBranch(SkipCountBB);
1171 }
1172 EmitBlock(BB);
Justin Bogner66242d62015-04-23 23:06:47 +00001173 uint64_t CurrentCount = getCurrentProfileCount();
1174 incrementProfileCounter(S);
1175 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001176 if (SkipCountBB)
1177 EmitBlock(SkipCountBB);
1178}
1179
John McCall8601a752010-08-03 22:46:07 +00001180/// Tries to mark the given function nounwind based on the
1181/// non-existence of any throwing calls within it. We believe this is
1182/// lightweight enough to do at -O0.
1183static void TryMarkNoThrow(llvm::Function *F) {
John McCall59966992010-08-11 22:38:33 +00001184 // LLVM treats 'nounwind' on a function as part of the type, so we
1185 // can't do this on functions that can be overwritten.
Sanjoy Dasf60a0d72016-04-08 01:31:02 +00001186 if (F->isInterposable()) return;
John McCall59966992010-08-11 22:38:33 +00001187
David Majnemerdbf10452015-07-31 17:58:45 +00001188 for (llvm::BasicBlock &BB : *F)
1189 for (llvm::Instruction &I : BB)
1190 if (I.mayThrow())
Bill Wendlingf0724e82011-09-19 20:31:14 +00001191 return;
David Majnemerdbf10452015-07-31 17:58:45 +00001192
Bill Wendling73e465e2012-10-10 03:13:20 +00001193 F->setDoesNotThrow();
John McCall8601a752010-08-03 22:46:07 +00001194}
1195
Richard Smith5179eb72016-06-28 19:03:57 +00001196QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD,
1197 FunctionArgList &Args) {
Anders Carlsson73fcc952009-09-11 00:07:24 +00001198 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Alp Toker314cc812014-01-25 16:55:45 +00001199 QualType ResTy = FD->getReturnType();
Mike Stump11289f42009-09-09 15:08:12 +00001200
Reid Kleckner89077a12013-12-17 19:46:40 +00001201 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1202 if (MD && MD->isInstance()) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001203 if (CGM.getCXXABI().HasThisReturn(GD))
1204 ResTy = MD->getThisType(getContext());
David Majnemer0c0b6d92014-10-31 20:09:12 +00001205 else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
1206 ResTy = CGM.getContext().VoidPtrTy;
Reid Kleckner89077a12013-12-17 19:46:40 +00001207 CGM.getCXXABI().buildThisParam(*this, Args);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001208 }
Justin Bogner66242d62015-04-23 23:06:47 +00001209
Richard Smith5179eb72016-06-28 19:03:57 +00001210 // The base version of an inheriting constructor whose constructed base is a
1211 // virtual base is not passed any arguments (because it doesn't actually call
1212 // the inherited constructor).
1213 bool PassedParams = true;
1214 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
1215 if (auto Inherited = CD->getInheritedConstructor())
1216 PassedParams =
1217 getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001218
Richard Smith5179eb72016-06-28 19:03:57 +00001219 if (PassedParams) {
1220 for (auto *Param : FD->parameters()) {
1221 Args.push_back(Param);
1222 if (!Param->hasAttr<PassObjectSizeAttr>())
1223 continue;
1224
Richard Smith5179eb72016-06-28 19:03:57 +00001225 auto *Implicit = ImplicitParamDecl::Create(
Alexey Bataev56223232017-06-09 13:40:18 +00001226 getContext(), Param->getDeclContext(), Param->getLocation(),
1227 /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other);
Richard Smith5179eb72016-06-28 19:03:57 +00001228 SizeArguments[Param] = Implicit;
1229 Args.push_back(Implicit);
1230 }
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001231 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001232
Reid Kleckner89077a12013-12-17 19:46:40 +00001233 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
1234 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
1235
Richard Smith5179eb72016-06-28 19:03:57 +00001236 return ResTy;
1237}
1238
Alex Lorenzc1608f72017-01-04 13:40:34 +00001239static bool
1240shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD,
1241 const ASTContext &Context) {
1242 QualType T = FD->getReturnType();
1243 // Avoid the optimization for functions that return a record type with a
1244 // trivial destructor or another trivially copyable type.
1245 if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) {
1246 if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl()))
1247 return !ClassDecl->hasTrivialDestructor();
1248 }
1249 return !T.isTriviallyCopyableType(Context);
1250}
1251
Richard Smith5179eb72016-06-28 19:03:57 +00001252void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1253 const CGFunctionInfo &FnInfo) {
1254 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
1255 CurGD = GD;
1256
1257 FunctionArgList Args;
1258 QualType ResTy = BuildFunctionArgList(GD, Args);
1259
1260 // Check if we should generate debug info for this function.
1261 if (FD->hasAttr<NoDebugAttr>())
1262 DebugInfo = nullptr; // disable debug info indefinitely for this function
1263
Reid Klecknera8589812017-02-08 16:09:32 +00001264 // The function might not have a body if we're generating thunks for a
1265 // function declaration.
John McCall89b12b32010-02-18 03:17:58 +00001266 SourceRange BodyRange;
Reid Klecknera8589812017-02-08 16:09:32 +00001267 if (Stmt *Body = FD->getBody())
1268 BodyRange = Body->getSourceRange();
1269 else
1270 BodyRange = FD->getLocation();
Adrian Prantldc237b52013-05-16 00:41:26 +00001271 CurEHLocation = BodyRange.getEnd();
Anders Carlsson438cf922009-11-06 02:55:43 +00001272
Adrian Prantl42d71b92014-04-10 23:21:53 +00001273 // Use the location of the start of the function to determine where
1274 // the function definition is located. By default use the location
1275 // of the declaration as the location for the subprogram. A function
1276 // may lack a declaration in the source code if it is created by code
1277 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001278 SourceLocation Loc = FD->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001279
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001280 // If this is a function specialization then use the pattern body
1281 // as the location for the function.
1282 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
1283 if (SpecDecl->hasBody(SpecDecl))
1284 Loc = SpecDecl->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001285
Vitaly Buka64c80b42016-10-26 05:42:30 +00001286 Stmt *Body = FD->getBody();
1287
1288 // Initialize helper which will detect jumps which can cause invalid lifetime
1289 // markers.
1290 if (Body && ShouldEmitLifetimeMarkers)
1291 Bypasses.Init(Body);
1292
John McCall89b12b32010-02-18 03:17:58 +00001293 // Emit the standard function prologue.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001294 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
Anders Carlsson438cf922009-11-06 02:55:43 +00001295
John McCall89b12b32010-02-18 03:17:58 +00001296 // Generate the body of the function.
Serge Pavlov3a561452015-12-06 14:32:39 +00001297 PGO.assignRegionCounters(GD, CurFn);
John McCallb81884d2010-02-19 09:25:03 +00001298 if (isa<CXXDestructorDecl>(FD))
1299 EmitDestructorBody(Args);
1300 else if (isa<CXXConstructorDecl>(FD))
1301 EmitConstructorBody(Args);
Richard Smith9c6890a2012-11-01 22:30:59 +00001302 else if (getLangOpts().CUDA &&
Artem Belevichf3d3db62015-03-19 18:58:18 +00001303 !getLangOpts().CUDAIsDevice &&
Peter Collingbournefa4d6032011-10-06 18:51:56 +00001304 FD->hasAttr<CUDAGlobalAttr>())
Artem Belevich52cc4872015-05-07 19:34:16 +00001305 CGM.getCUDARuntime().emitDeviceStub(*this, Args);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001306 else if (isa<CXXMethodDecl>(FD) &&
1307 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
Faisal Vali2b391ab2013-09-26 19:54:12 +00001308 // The lambda static invoker function is special, because it forwards or
Douglas Gregor355efbb2012-02-17 03:02:34 +00001309 // clones the body of the function call operator (but is actually static).
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001310 EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD));
Lang Hamesbf122742013-02-17 07:22:09 +00001311 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
Nick Lewyckyb39be1f2013-09-10 05:14:39 +00001312 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
1313 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
Lang Hamesbf122742013-02-17 07:22:09 +00001314 // Implicit copy-assignment gets the same special treatment as implicit
1315 // copy-constructors.
1316 emitImplicitAssignmentOperatorBody(Args);
Vitaly Buka64c80b42016-10-26 05:42:30 +00001317 } else if (Body) {
Richard Smithb47c36f2013-11-05 09:12:18 +00001318 EmitFunctionBody(Args, Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001319 } else
1320 llvm_unreachable("no definition for emitted function");
Anders Carlssonff8cce42010-02-07 19:45:40 +00001321
Richard Smith9f9e5822012-10-04 23:52:29 +00001322 // C++11 [stmt.return]p2:
1323 // Flowing off the end of a function [...] results in undefined behavior in
1324 // a value-returning function.
1325 // C11 6.9.1p12:
1326 // If the '}' that terminates a function is reached, and the value of the
1327 // function call is used by the caller, the behavior is undefined.
Reid Kleckner9b3e3df2014-09-04 20:04:38 +00001328 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
Alp Toker314cc812014-01-25 16:55:45 +00001329 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
Alex Lorenzc1608f72017-01-04 13:40:34 +00001330 bool ShouldEmitUnreachable =
1331 CGM.getCodeGenOpts().StrictReturn ||
1332 shouldUseUndefinedBehaviorReturnOptimization(FD, getContext());
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001333 if (SanOpts.has(SanitizerKind::Return)) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001334 SanitizerScope SanScope(this);
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001335 llvm::Value *IsFalse = Builder.getFalse();
1336 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00001337 SanitizerHandler::MissingReturn,
1338 EmitCheckSourceLocation(FD->getLocation()), None);
Alex Lorenzc1608f72017-01-04 13:40:34 +00001339 } else if (ShouldEmitUnreachable) {
1340 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
1341 EmitTrapCall(llvm::Intrinsic::trap);
Akira Hatanaka85365cd2015-07-02 22:15:41 +00001342 }
Alex Lorenzc1608f72017-01-04 13:40:34 +00001343 if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) {
1344 Builder.CreateUnreachable();
1345 Builder.ClearInsertionPoint();
1346 }
Richard Smith9f9e5822012-10-04 23:52:29 +00001347 }
1348
John McCall89b12b32010-02-18 03:17:58 +00001349 // Emit the standard function epilogue.
1350 FinishFunction(BodyRange.getEnd());
John McCall8601a752010-08-03 22:46:07 +00001351
1352 // If we haven't marked the function nothrow through other means, do
1353 // a quick pass now to see if we can.
1354 if (!CurFn->doesNotThrow())
1355 TryMarkNoThrow(CurFn);
Chris Lattner5696e7b2008-06-17 18:05:57 +00001356}
1357
Chris Lattner5b1964b2008-11-11 07:41:27 +00001358/// ContainsLabel - Return true if the statement contains a label in it. If
1359/// this statement is not executed normally, it not containing a label means
1360/// that we can just remove the code.
1361bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
1362 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001363 if (!S) return false;
Mike Stump11289f42009-09-09 15:08:12 +00001364
Chris Lattner5b1964b2008-11-11 07:41:27 +00001365 // If this is a label, we have to emit the code, consider something like:
1366 // if (0) { ... foo: bar(); } goto foo;
Chris Lattner29911cc2011-02-28 00:18:40 +00001367 //
1368 // TODO: If anyone cared, we could track __label__'s, since we know that you
1369 // can't jump to one from outside their declared region.
Chris Lattner5b1964b2008-11-11 07:41:27 +00001370 if (isa<LabelStmt>(S))
1371 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001372
Chris Lattner5b1964b2008-11-11 07:41:27 +00001373 // If this is a case/default statement, and we haven't seen a switch, we have
1374 // to emit the code.
1375 if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
1376 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001377
Chris Lattner5b1964b2008-11-11 07:41:27 +00001378 // If this is a switch statement, we want to ignore cases below it.
1379 if (isa<SwitchStmt>(S))
1380 IgnoreCaseStmts = true;
Mike Stump11289f42009-09-09 15:08:12 +00001381
Chris Lattner5b1964b2008-11-11 07:41:27 +00001382 // Scan subexpressions for verboten labels.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001383 for (const Stmt *SubStmt : S->children())
1384 if (ContainsLabel(SubStmt, IgnoreCaseStmts))
Chris Lattner5b1964b2008-11-11 07:41:27 +00001385 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001386
Chris Lattner5b1964b2008-11-11 07:41:27 +00001387 return false;
1388}
1389
Chris Lattner29911cc2011-02-28 00:18:40 +00001390/// containsBreak - Return true if the statement contains a break out of it.
1391/// If the statement (recursively) contains a switch or loop with a break
1392/// inside of it, this is fine.
1393bool CodeGenFunction::containsBreak(const Stmt *S) {
1394 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001395 if (!S) return false;
Chris Lattner29911cc2011-02-28 00:18:40 +00001396
1397 // If this is a switch or loop that defines its own break scope, then we can
1398 // include it and anything inside of it.
1399 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
1400 isa<ForStmt>(S))
Chris Lattner30db8282011-02-28 00:42:31 +00001401 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001402
Chris Lattner30db8282011-02-28 00:42:31 +00001403 if (isa<BreakStmt>(S))
Chris Lattner29911cc2011-02-28 00:18:40 +00001404 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001405
Chris Lattner29911cc2011-02-28 00:18:40 +00001406 // Scan subexpressions for verboten breaks.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001407 for (const Stmt *SubStmt : S->children())
1408 if (containsBreak(SubStmt))
Chris Lattner29911cc2011-02-28 00:18:40 +00001409 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001410
Chris Lattner29911cc2011-02-28 00:18:40 +00001411 return false;
1412}
1413
Richard Smithd8e3ac32016-09-16 23:30:39 +00001414bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) {
1415 if (!S) return false;
1416
1417 // Some statement kinds add a scope and thus never add a decl to the current
1418 // scope. Note, this list is longer than the list of statements that might
1419 // have an unscoped decl nested within them, but this way is conservatively
1420 // correct even if more statement kinds are added.
1421 if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
1422 isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) ||
1423 isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) ||
1424 isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S))
1425 return false;
1426
1427 if (isa<DeclStmt>(S))
1428 return true;
1429
1430 for (const Stmt *SubStmt : S->children())
1431 if (mightAddDeclToScope(SubStmt))
1432 return true;
1433
1434 return false;
1435}
Chris Lattnercd439292008-11-12 08:04:58 +00001436
Chris Lattner41c6ab52011-02-27 23:02:32 +00001437/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1438/// to a constant, or if it does but contains a label, return false. If it
1439/// constant folds return true and set the boolean result in Result.
1440bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
Richard Smithb130fe72016-06-23 19:16:49 +00001441 bool &ResultBool,
1442 bool AllowLabels) {
Richard Trieuc320c742012-07-23 20:21:35 +00001443 llvm::APSInt ResultInt;
Richard Smithb130fe72016-06-23 19:16:49 +00001444 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels))
Chris Lattner29911cc2011-02-28 00:18:40 +00001445 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001446
Chris Lattner29911cc2011-02-28 00:18:40 +00001447 ResultBool = ResultInt.getBoolValue();
1448 return true;
1449}
1450
1451/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1452/// to a constant, or if it does but contains a label, return false. If it
1453/// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00001454bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1455 llvm::APSInt &ResultInt,
1456 bool AllowLabels) {
Daniel Dunbarf32443c2008-11-12 22:37:10 +00001457 // FIXME: Rename and handle conversion of other evaluatable things
1458 // to bool.
Richard Smith5fab0c92011-12-28 19:48:30 +00001459 llvm::APSInt Int;
1460 if (!Cond->EvaluateAsInt(Int, getContext()))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001461 return false; // Not foldable, not integer or not fully evaluatable.
Richard Smith5fab0c92011-12-28 19:48:30 +00001462
Richard Smithb130fe72016-06-23 19:16:49 +00001463 if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001464 return false; // Contains a label.
Richard Smith5fab0c92011-12-28 19:48:30 +00001465
1466 ResultInt = Int;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001467 return true;
Chris Lattnercd439292008-11-12 08:04:58 +00001468}
1469
1470
Chris Lattner29911cc2011-02-28 00:18:40 +00001471
Chris Lattnercd439292008-11-12 08:04:58 +00001472/// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
1473/// statement) to the specified blocks. Based on the condition, this might try
1474/// to simplify the codegen of the conditional based on the branch.
1475///
1476void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
1477 llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00001478 llvm::BasicBlock *FalseBlock,
1479 uint64_t TrueCount) {
Peter Collingbourne91147592011-04-15 00:35:48 +00001480 Cond = Cond->IgnoreParens();
Mike Stump11289f42009-09-09 15:08:12 +00001481
Chris Lattnercd439292008-11-12 08:04:58 +00001482 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
Justin Bogneref512b92014-01-06 22:27:43 +00001483
Chris Lattnercd439292008-11-12 08:04:58 +00001484 // Handle X && Y in a condition.
John McCalle3027922010-08-25 11:45:40 +00001485 if (CondBOp->getOpcode() == BO_LAnd) {
Chris Lattnercd439292008-11-12 08:04:58 +00001486 // If we have "1 && X", simplify the code. "0 && X" would have constant
1487 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001488 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001489 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1490 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001491 // br(1 && X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001492 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001493 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1494 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001495 }
Mike Stump11289f42009-09-09 15:08:12 +00001496
Chris Lattnercd439292008-11-12 08:04:58 +00001497 // If we have "X && 1", simplify the code to use an uncond branch.
1498 // "X && 0" would have been constant folded to 0.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001499 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1500 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001501 // br(X && 1) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001502 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1503 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001504 }
Mike Stump11289f42009-09-09 15:08:12 +00001505
Chris Lattnercd439292008-11-12 08:04:58 +00001506 // Emit the LHS as a conditional. If the LHS conditional is false, we
1507 // want to jump to the FalseBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001508 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
Justin Bogneref512b92014-01-06 22:27:43 +00001509 // The counter tells us how often we evaluate RHS, and all of TrueCount
1510 // can be propagated to that branch.
Justin Bogner66242d62015-04-23 23:06:47 +00001511 uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
John McCallce1de612011-01-26 04:00:11 +00001512
1513 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001514 {
1515 ApplyDebugLocation DL(*this, Cond);
1516 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount);
1517 EmitBlock(LHSTrue);
1518 }
Mike Stump11289f42009-09-09 15:08:12 +00001519
Justin Bogner66242d62015-04-23 23:06:47 +00001520 incrementProfileCounter(CondBOp);
1521 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1522
Anders Carlsson60ddba62010-01-24 00:20:05 +00001523 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001524 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001525 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount);
John McCallce1de612011-01-26 04:00:11 +00001526 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001527
Chris Lattnercd439292008-11-12 08:04:58 +00001528 return;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001529 }
Michael Ilseman686240a2012-12-04 00:29:55 +00001530
Chris Lattner41c6ab52011-02-27 23:02:32 +00001531 if (CondBOp->getOpcode() == BO_LOr) {
Chris Lattnercd439292008-11-12 08:04:58 +00001532 // If we have "0 || X", simplify the code. "1 || X" would have constant
1533 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001534 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001535 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1536 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001537 // br(0 || X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001538 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001539 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1540 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001541 }
Mike Stump11289f42009-09-09 15:08:12 +00001542
Chris Lattnercd439292008-11-12 08:04:58 +00001543 // If we have "X || 0", simplify the code to use an uncond branch.
1544 // "X || 1" would have been constant folded to 1.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001545 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1546 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001547 // br(X || 0) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001548 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1549 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001550 }
Mike Stump11289f42009-09-09 15:08:12 +00001551
Chris Lattnercd439292008-11-12 08:04:58 +00001552 // Emit the LHS as a conditional. If the LHS conditional is true, we
1553 // want to jump to the TrueBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001554 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
Justin Bogneref512b92014-01-06 22:27:43 +00001555 // We have the count for entry to the RHS and for the whole expression
1556 // being true, so we can divy up True count between the short circuit and
1557 // the RHS.
Justin Bogner66242d62015-04-23 23:06:47 +00001558 uint64_t LHSCount =
1559 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
Justin Bogneref512b92014-01-06 22:27:43 +00001560 uint64_t RHSCount = TrueCount - LHSCount;
John McCallce1de612011-01-26 04:00:11 +00001561
1562 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001563 {
1564 ApplyDebugLocation DL(*this, Cond);
1565 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount);
1566 EmitBlock(LHSFalse);
1567 }
Mike Stump11289f42009-09-09 15:08:12 +00001568
Justin Bogner66242d62015-04-23 23:06:47 +00001569 incrementProfileCounter(CondBOp);
1570 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1571
Anders Carlsson60ddba62010-01-24 00:20:05 +00001572 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001573 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001574 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount);
1575
John McCallce1de612011-01-26 04:00:11 +00001576 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001577
Chris Lattnercd439292008-11-12 08:04:58 +00001578 return;
1579 }
Chris Lattnerd9537732008-11-12 08:13:36 +00001580 }
Mike Stump11289f42009-09-09 15:08:12 +00001581
Chris Lattnerd9537732008-11-12 08:13:36 +00001582 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
1583 // br(!x, t, f) -> br(x, f, t)
Justin Bogneref512b92014-01-06 22:27:43 +00001584 if (CondUOp->getOpcode() == UO_LNot) {
1585 // Negate the count.
Justin Bogner66242d62015-04-23 23:06:47 +00001586 uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
Justin Bogneref512b92014-01-06 22:27:43 +00001587 // Negate the condition and swap the destination blocks.
1588 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1589 FalseCount);
1590 }
Chris Lattnercd439292008-11-12 08:04:58 +00001591 }
Mike Stump11289f42009-09-09 15:08:12 +00001592
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001593 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
Eli Friedman248f8982012-02-14 03:54:45 +00001594 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
1595 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
1596 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001597
Eli Friedman248f8982012-02-14 03:54:45 +00001598 ConditionalEvaluation cond(*this);
Justin Bogner66242d62015-04-23 23:06:47 +00001599 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1600 getProfileCount(CondOp));
Justin Bogneref512b92014-01-06 22:27:43 +00001601
1602 // When computing PGO branch weights, we only know the overall count for
1603 // the true block. This code is essentially doing tail duplication of the
1604 // naive code-gen, introducing new edges for which counts are not
1605 // available. Divide the counts proportionally between the LHS and RHS of
1606 // the conditional operator.
1607 uint64_t LHSScaledTrueCount = 0;
1608 if (TrueCount) {
Justin Bogner66242d62015-04-23 23:06:47 +00001609 double LHSRatio =
1610 getProfileCount(CondOp) / (double)getCurrentProfileCount();
Justin Bogneref512b92014-01-06 22:27:43 +00001611 LHSScaledTrueCount = TrueCount * LHSRatio;
1612 }
John McCallce1de612011-01-26 04:00:11 +00001613
Eli Friedman248f8982012-02-14 03:54:45 +00001614 cond.begin(*this);
1615 EmitBlock(LHSBlock);
Justin Bogner66242d62015-04-23 23:06:47 +00001616 incrementProfileCounter(CondOp);
David Blaikie298720d2015-01-28 19:50:09 +00001617 {
1618 ApplyDebugLocation DL(*this, Cond);
1619 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1620 LHSScaledTrueCount);
1621 }
Eli Friedman248f8982012-02-14 03:54:45 +00001622 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001623
Eli Friedman248f8982012-02-14 03:54:45 +00001624 cond.begin(*this);
1625 EmitBlock(RHSBlock);
Justin Bogneref512b92014-01-06 22:27:43 +00001626 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1627 TrueCount - LHSScaledTrueCount);
Eli Friedman248f8982012-02-14 03:54:45 +00001628 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001629
Eli Friedman248f8982012-02-14 03:54:45 +00001630 return;
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001631 }
1632
Richard Smithea852322013-05-07 21:53:22 +00001633 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
1634 // Conditional operator handling can give us a throw expression as a
1635 // condition for a case like:
1636 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
1637 // Fold this to:
1638 // br(c, throw x, br(y, t, f))
1639 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
1640 return;
1641 }
1642
Sanjay Patela24296b2015-09-02 20:01:30 +00001643 // If the branch has a condition wrapped by __builtin_unpredictable,
1644 // create metadata that specifies that the branch is unpredictable.
1645 // Don't bother if not optimizing because that metadata would not be used.
1646 llvm::MDNode *Unpredictable = nullptr;
Sanjay Patel3fd323f2016-04-19 18:06:33 +00001647 auto *Call = dyn_cast<CallExpr>(Cond);
1648 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1649 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1650 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1651 llvm::MDBuilder MDHelper(getLLVMContext());
1652 Unpredictable = MDHelper.createUnpredictable();
Sanjay Patela24296b2015-09-02 20:01:30 +00001653 }
1654 }
1655
Justin Bogneref512b92014-01-06 22:27:43 +00001656 // Create branch weights based on the number of times we get here and the
1657 // number of times the condition should be true.
Justin Bogner66242d62015-04-23 23:06:47 +00001658 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
Justin Bogner65512642015-05-02 05:00:55 +00001659 llvm::MDNode *Weights =
1660 createProfileWeights(TrueCount, CurrentCount - TrueCount);
Justin Bogneref512b92014-01-06 22:27:43 +00001661
Chris Lattnercd439292008-11-12 08:04:58 +00001662 // Emit the code with the fully general case.
David Blaikie303facb2015-01-31 01:10:11 +00001663 llvm::Value *CondV;
1664 {
1665 ApplyDebugLocation DL(*this, Cond);
1666 CondV = EvaluateExprAsBool(Cond);
1667 }
Sanjay Patela24296b2015-09-02 20:01:30 +00001668 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
Chris Lattnercd439292008-11-12 08:04:58 +00001669}
1670
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001671/// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001672/// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001673void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
1674 CGM.ErrorUnsupported(S, Type);
Chris Lattnerfc944342007-12-02 01:43:38 +00001675}
1676
John McCall2725aa12011-02-01 21:35:06 +00001677/// emitNonZeroVLAInit - Emit the "zero" initialization of a
1678/// variable-length array whose elements have a non-zero bit-pattern.
1679///
James Dennettbe302452012-06-15 22:10:14 +00001680/// \param baseType the inner-most element type of the array
John McCall2725aa12011-02-01 21:35:06 +00001681/// \param src - a char* pointing to the bit-pattern for a single
1682/// base element of the array
1683/// \param sizeInChars - the total size of the VLA, in chars
John McCall2725aa12011-02-01 21:35:06 +00001684static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001685 Address dest, Address src,
John McCall2725aa12011-02-01 21:35:06 +00001686 llvm::Value *sizeInChars) {
John McCall2725aa12011-02-01 21:35:06 +00001687 CGBuilderTy &Builder = CGF.Builder;
1688
John McCall7f416cc2015-09-08 08:05:57 +00001689 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
John McCall2725aa12011-02-01 21:35:06 +00001690 llvm::Value *baseSizeInChars
John McCall7f416cc2015-09-08 08:05:57 +00001691 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
John McCall2725aa12011-02-01 21:35:06 +00001692
John McCall7f416cc2015-09-08 08:05:57 +00001693 Address begin =
1694 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1695 llvm::Value *end =
1696 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end");
John McCall2725aa12011-02-01 21:35:06 +00001697
1698 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
1699 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
1700 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
1701
1702 // Make a loop over the VLA. C99 guarantees that the VLA element
1703 // count must be nonzero.
1704 CGF.EmitBlock(loopBB);
1705
John McCall7f416cc2015-09-08 08:05:57 +00001706 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
1707 cur->addIncoming(begin.getPointer(), originBB);
1708
1709 CharUnits curAlign =
1710 dest.getAlignment().alignmentOfArrayElement(baseSize);
John McCall2725aa12011-02-01 21:35:06 +00001711
1712 // memcpy the individual element bit-pattern.
John McCall7f416cc2015-09-08 08:05:57 +00001713 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
John McCall2725aa12011-02-01 21:35:06 +00001714 /*volatile*/ false);
1715
1716 // Go to the next element.
John McCall7f416cc2015-09-08 08:05:57 +00001717 llvm::Value *next =
1718 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
John McCall2725aa12011-02-01 21:35:06 +00001719
1720 // Leave if that's the end of the VLA.
1721 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
1722 Builder.CreateCondBr(done, contBB, loopBB);
1723 cur->addIncoming(next, loopBB);
1724
1725 CGF.EmitBlock(contBB);
Michael Ilseman686240a2012-12-04 00:29:55 +00001726}
John McCall2725aa12011-02-01 21:35:06 +00001727
Anders Carlssonc0964b62010-05-22 17:35:42 +00001728void
John McCall7f416cc2015-09-08 08:05:57 +00001729CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001730 // Ignore empty classes in C++.
Richard Smith9c6890a2012-11-01 22:30:59 +00001731 if (getLangOpts().CPlusPlus) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001732 if (const RecordType *RT = Ty->getAs<RecordType>()) {
1733 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
1734 return;
1735 }
1736 }
John McCall7cd1d972010-08-07 08:21:30 +00001737
1738 // Cast the dest ptr to the appropriate i8 pointer type.
John McCall7f416cc2015-09-08 08:05:57 +00001739 if (DestPtr.getElementType() != Int8Ty)
1740 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001741
1742 // Get size and alignment info for this aggregate.
John McCall7f416cc2015-09-08 08:05:57 +00001743 CharUnits size = getContext().getTypeSizeInChars(Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001744
John McCalla08ffd22011-01-14 10:37:58 +00001745 llvm::Value *SizeVal;
John McCall2725aa12011-02-01 21:35:06 +00001746 const VariableArrayType *vla;
Mike Stump11289f42009-09-09 15:08:12 +00001747
John McCalla08ffd22011-01-14 10:37:58 +00001748 // Don't bother emitting a zero-byte memset.
John McCall7f416cc2015-09-08 08:05:57 +00001749 if (size.isZero()) {
John McCalla08ffd22011-01-14 10:37:58 +00001750 // But note that getTypeInfo returns 0 for a VLA.
1751 if (const VariableArrayType *vlaType =
1752 dyn_cast_or_null<VariableArrayType>(
1753 getContext().getAsArrayType(Ty))) {
John McCall23c29fe2011-06-24 21:55:10 +00001754 QualType eltType;
1755 llvm::Value *numElts;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001756 std::tie(numElts, eltType) = getVLASize(vlaType);
John McCall23c29fe2011-06-24 21:55:10 +00001757
1758 SizeVal = numElts;
1759 CharUnits eltSize = getContext().getTypeSizeInChars(eltType);
1760 if (!eltSize.isOne())
1761 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
John McCall2725aa12011-02-01 21:35:06 +00001762 vla = vlaType;
John McCalla08ffd22011-01-14 10:37:58 +00001763 } else {
1764 return;
1765 }
1766 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001767 SizeVal = CGM.getSize(size);
Craig Topper8a13c412014-05-21 05:09:00 +00001768 vla = nullptr;
John McCalla08ffd22011-01-14 10:37:58 +00001769 }
John McCall7cd1d972010-08-07 08:21:30 +00001770
1771 // If the type contains a pointer to data member we can't memset it to zero.
1772 // Instead, create a null constant and copy it to the destination.
John McCall2725aa12011-02-01 21:35:06 +00001773 // TODO: there are other patterns besides zero that we can usefully memset,
1774 // like -1, which happens to be the pattern used by member-pointers.
John McCall614dbdc2010-08-22 21:01:12 +00001775 if (!CGM.getTypes().isZeroInitializable(Ty)) {
John McCall2725aa12011-02-01 21:35:06 +00001776 // For a VLA, emit a single element, then splat that over the VLA.
1777 if (vla) Ty = getContext().getBaseElementType(vla);
John McCalla08ffd22011-01-14 10:37:58 +00001778
John McCall7cd1d972010-08-07 08:21:30 +00001779 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
1780
Michael Ilseman686240a2012-12-04 00:29:55 +00001781 llvm::GlobalVariable *NullVariable =
John McCall7cd1d972010-08-07 08:21:30 +00001782 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
Michael Ilseman686240a2012-12-04 00:29:55 +00001783 /*isConstant=*/true,
John McCall7cd1d972010-08-07 08:21:30 +00001784 llvm::GlobalVariable::PrivateLinkage,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001785 NullConstant, Twine());
John McCall7f416cc2015-09-08 08:05:57 +00001786 CharUnits NullAlign = DestPtr.getAlignment();
1787 NullVariable->setAlignment(NullAlign.getQuantity());
1788 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
1789 NullAlign);
John McCall7cd1d972010-08-07 08:21:30 +00001790
John McCall2725aa12011-02-01 21:35:06 +00001791 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
1792
John McCall7cd1d972010-08-07 08:21:30 +00001793 // Get and call the appropriate llvm.memcpy overload.
John McCall7f416cc2015-09-08 08:05:57 +00001794 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
John McCall7cd1d972010-08-07 08:21:30 +00001795 return;
Michael Ilseman686240a2012-12-04 00:29:55 +00001796 }
1797
John McCall7cd1d972010-08-07 08:21:30 +00001798 // Otherwise, just memset the whole thing to zero. This is legal
1799 // because in LLVM, all default initializers (other than the ones we just
1800 // handled above) are guaranteed to have a bit pattern of all zeros.
John McCall7f416cc2015-09-08 08:05:57 +00001801 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001802}
1803
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001804llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001805 // Make sure that there is a block for the indirect goto.
Craig Topper8a13c412014-05-21 05:09:00 +00001806 if (!IndirectBranch)
Chris Lattner6c4d2552009-10-28 23:59:40 +00001807 GetIndirectGotoBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001808
John McCallad5d61e2010-07-23 21:56:41 +00001809 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001810
Chris Lattner6c4d2552009-10-28 23:59:40 +00001811 // Make sure the indirect branch includes all of the address-taken blocks.
1812 IndirectBranch->addDestination(BB);
1813 return llvm::BlockAddress::get(CurFn, BB);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001814}
1815
1816llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001817 // If we already made the indirect branch for indirect goto, return its block.
1818 if (IndirectBranch) return IndirectBranch->getParent();
Michael Ilseman686240a2012-12-04 00:29:55 +00001819
John McCall7f416cc2015-09-08 08:05:57 +00001820 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
Michael Ilseman686240a2012-12-04 00:29:55 +00001821
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001822 // Create the PHI node that indirect gotos will add entries to.
Jay Foad20c0f022011-03-30 11:28:58 +00001823 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
1824 "indirect.goto.dest");
Michael Ilseman686240a2012-12-04 00:29:55 +00001825
Chris Lattner6c4d2552009-10-28 23:59:40 +00001826 // Create the indirect branch instruction.
1827 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
1828 return IndirectBranch->getParent();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001829}
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001830
John McCall82fe67b2011-07-09 01:37:26 +00001831/// Computes the length of an array in elements, as well as the base
1832/// element type and a properly-typed first element pointer.
1833llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1834 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001835 Address &addr) {
John McCall82fe67b2011-07-09 01:37:26 +00001836 const ArrayType *arrayType = origArrayType;
1837
1838 // If it's a VLA, we have to load the stored size. Note that
1839 // this is the size of the VLA in bytes, not its size in elements.
Craig Topper8a13c412014-05-21 05:09:00 +00001840 llvm::Value *numVLAElements = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001841 if (isa<VariableArrayType>(arrayType)) {
1842 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).first;
1843
1844 // Walk into all VLAs. This doesn't require changes to addr,
1845 // which has type T* where T is the first non-VLA element type.
1846 do {
1847 QualType elementType = arrayType->getElementType();
1848 arrayType = getContext().getAsArrayType(elementType);
1849
1850 // If we only have VLA components, 'addr' requires no adjustment.
1851 if (!arrayType) {
1852 baseType = elementType;
1853 return numVLAElements;
1854 }
1855 } while (isa<VariableArrayType>(arrayType));
1856
1857 // We get out here only if we find a constant array type
1858 // inside the VLA.
1859 }
1860
1861 // We have some number of constant-length arrays, so addr should
1862 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks
1863 // down to the first element of addr.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001864 SmallVector<llvm::Value*, 8> gepIndices;
John McCall82fe67b2011-07-09 01:37:26 +00001865
1866 // GEP down to the array type.
1867 llvm::ConstantInt *zero = Builder.getInt32(0);
1868 gepIndices.push_back(zero);
1869
John McCall82fe67b2011-07-09 01:37:26 +00001870 uint64_t countFromCLAs = 1;
Richard Smithf3c37e82012-04-22 05:51:36 +00001871 QualType eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001872
Chris Lattner2192fe52011-07-18 04:24:23 +00001873 llvm::ArrayType *llvmArrayType =
John McCall7f416cc2015-09-08 08:05:57 +00001874 dyn_cast<llvm::ArrayType>(addr.getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001875 while (llvmArrayType) {
John McCall82fe67b2011-07-09 01:37:26 +00001876 assert(isa<ConstantArrayType>(arrayType));
1877 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1878 == llvmArrayType->getNumElements());
1879
1880 gepIndices.push_back(zero);
1881 countFromCLAs *= llvmArrayType->getNumElements();
Richard Smithf3c37e82012-04-22 05:51:36 +00001882 eltType = arrayType->getElementType();
John McCall82fe67b2011-07-09 01:37:26 +00001883
1884 llvmArrayType =
1885 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
John McCall82fe67b2011-07-09 01:37:26 +00001886 arrayType = getContext().getAsArrayType(arrayType->getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001887 assert((!llvmArrayType || arrayType) &&
1888 "LLVM and Clang types are out-of-synch");
John McCall82fe67b2011-07-09 01:37:26 +00001889 }
1890
Richard Smithf3c37e82012-04-22 05:51:36 +00001891 if (arrayType) {
1892 // From this point onwards, the Clang array type has been emitted
1893 // as some other type (probably a packed struct). Compute the array
1894 // size, and just emit the 'begin' expression as a bitcast.
1895 while (arrayType) {
1896 countFromCLAs *=
1897 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1898 eltType = arrayType->getElementType();
1899 arrayType = getContext().getAsArrayType(eltType);
1900 }
John McCall82fe67b2011-07-09 01:37:26 +00001901
John McCall7f416cc2015-09-08 08:05:57 +00001902 llvm::Type *baseType = ConvertType(eltType);
1903 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
Richard Smithf3c37e82012-04-22 05:51:36 +00001904 } else {
1905 // Create the actual GEP.
John McCall7f416cc2015-09-08 08:05:57 +00001906 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(),
1907 gepIndices, "array.begin"),
1908 addr.getAlignment());
Richard Smithf3c37e82012-04-22 05:51:36 +00001909 }
1910
1911 baseType = eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001912
1913 llvm::Value *numElements
1914 = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1915
1916 // If we had any VLA dimensions, factor them in.
1917 if (numVLAElements)
1918 numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1919
1920 return numElements;
1921}
1922
John McCall23c29fe2011-06-24 21:55:10 +00001923std::pair<llvm::Value*, QualType>
1924CodeGenFunction::getVLASize(QualType type) {
1925 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1926 assert(vla && "type was not a variable array type!");
1927 return getVLASize(vla);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001928}
Anders Carlssonccbe9202008-12-12 07:19:02 +00001929
John McCall23c29fe2011-06-24 21:55:10 +00001930std::pair<llvm::Value*, QualType>
1931CodeGenFunction::getVLASize(const VariableArrayType *type) {
1932 // The number of elements so far; always size_t.
Craig Topper8a13c412014-05-21 05:09:00 +00001933 llvm::Value *numElements = nullptr;
John McCall23c29fe2011-06-24 21:55:10 +00001934
1935 QualType elementType;
1936 do {
1937 elementType = type->getElementType();
1938 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1939 assert(vlaSize && "no size for VLA!");
1940 assert(vlaSize->getType() == SizeTy);
1941
1942 if (!numElements) {
1943 numElements = vlaSize;
1944 } else {
1945 // It's undefined behavior if this wraps around, so mark it that way.
Alexey Samsonovcb3f8122014-03-20 10:48:29 +00001946 // FIXME: Teach -fsanitize=undefined to trap this.
John McCall23c29fe2011-06-24 21:55:10 +00001947 numElements = Builder.CreateNUWMul(numElements, vlaSize);
1948 }
1949 } while ((type = getContext().getAsVariableArrayType(elementType)));
1950
1951 return std::pair<llvm::Value*,QualType>(numElements, elementType);
1952}
1953
1954void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
1955 assert(type->isVariablyModifiedType() &&
Anders Carlsson8a01b792008-12-20 20:46:34 +00001956 "Must pass variably modified type to EmitVLASizes!");
Mike Stump11289f42009-09-09 15:08:12 +00001957
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001958 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00001959
John McCall23c29fe2011-06-24 21:55:10 +00001960 // We're going to walk down into the type and look for VLA
1961 // expressions.
John McCall23c29fe2011-06-24 21:55:10 +00001962 do {
1963 assert(type->isVariablyModifiedType());
Mike Stump11289f42009-09-09 15:08:12 +00001964
John McCall23c29fe2011-06-24 21:55:10 +00001965 const Type *ty = type.getTypePtr();
1966 switch (ty->getTypeClass()) {
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001967
John McCall23c29fe2011-06-24 21:55:10 +00001968#define TYPE(Class, Base)
1969#define ABSTRACT_TYPE(Class, Base)
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001970#define NON_CANONICAL_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001971#define DEPENDENT_TYPE(Class, Base) case Type::Class:
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001972#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001973#include "clang/AST/TypeNodes.def"
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001974 llvm_unreachable("unexpected dependent type!");
Mike Stump11289f42009-09-09 15:08:12 +00001975
John McCall23c29fe2011-06-24 21:55:10 +00001976 // These types are never variably-modified.
1977 case Type::Builtin:
1978 case Type::Complex:
1979 case Type::Vector:
1980 case Type::ExtVector:
1981 case Type::Record:
1982 case Type::Enum:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001983 case Type::Elaborated:
1984 case Type::TemplateSpecialization:
Manman Rene6be26c2016-09-13 17:25:08 +00001985 case Type::ObjCTypeParam:
John McCall23c29fe2011-06-24 21:55:10 +00001986 case Type::ObjCObject:
1987 case Type::ObjCInterface:
1988 case Type::ObjCObjectPointer:
1989 llvm_unreachable("type class is never variably-modified!");
Mike Stump11289f42009-09-09 15:08:12 +00001990
Reid Kleckner0503a872013-12-05 01:23:43 +00001991 case Type::Adjusted:
1992 type = cast<AdjustedType>(ty)->getAdjustedType();
1993 break;
1994
Reid Kleckner8a365022013-06-24 17:51:48 +00001995 case Type::Decayed:
1996 type = cast<DecayedType>(ty)->getPointeeType();
1997 break;
1998
John McCall23c29fe2011-06-24 21:55:10 +00001999 case Type::Pointer:
2000 type = cast<PointerType>(ty)->getPointeeType();
2001 break;
Mike Stump11289f42009-09-09 15:08:12 +00002002
John McCall23c29fe2011-06-24 21:55:10 +00002003 case Type::BlockPointer:
2004 type = cast<BlockPointerType>(ty)->getPointeeType();
2005 break;
2006
2007 case Type::LValueReference:
2008 case Type::RValueReference:
2009 type = cast<ReferenceType>(ty)->getPointeeType();
2010 break;
2011
2012 case Type::MemberPointer:
2013 type = cast<MemberPointerType>(ty)->getPointeeType();
2014 break;
2015
2016 case Type::ConstantArray:
2017 case Type::IncompleteArray:
2018 // Losing element qualification here is fine.
2019 type = cast<ArrayType>(ty)->getElementType();
2020 break;
2021
2022 case Type::VariableArray: {
2023 // Losing element qualification here is fine.
2024 const VariableArrayType *vat = cast<VariableArrayType>(ty);
2025
2026 // Unknown size indication requires no size computation.
2027 // Otherwise, evaluate and record it.
2028 if (const Expr *size = vat->getSizeExpr()) {
2029 // It's possible that we might have emitted this already,
2030 // e.g. with a typedef and a pointer to it.
2031 llvm::Value *&entry = VLASizeMap[size];
2032 if (!entry) {
Richard Smith481652b2012-10-10 01:11:12 +00002033 llvm::Value *Size = EmitScalarExpr(size);
2034
2035 // C11 6.7.6.2p5:
2036 // If the size is an expression that is not an integer constant
2037 // expression [...] each time it is evaluated it shall have a value
2038 // greater than zero.
Alexey Samsonovedf99a92014-11-07 22:29:38 +00002039 if (SanOpts.has(SanitizerKind::VLABound) &&
Richard Smithb1b0ab42012-11-05 22:21:05 +00002040 size->getType()->isSignedIntegerType()) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00002041 SanitizerScope SanScope(this);
Richard Smith481652b2012-10-10 01:11:12 +00002042 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
2043 llvm::Constant *StaticArgs[] = {
2044 EmitCheckSourceLocation(size->getLocStart()),
2045 EmitCheckTypeDescriptor(size->getType())
2046 };
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002047 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
2048 SanitizerKind::VLABound),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00002049 SanitizerHandler::VLABoundNotPositive, StaticArgs, Size);
Richard Smith481652b2012-10-10 01:11:12 +00002050 }
2051
John McCall23c29fe2011-06-24 21:55:10 +00002052 // Always zexting here would be wrong if it weren't
2053 // undefined behavior to have a negative bound.
Richard Smith8772bd82012-10-10 01:12:11 +00002054 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
John McCall23c29fe2011-06-24 21:55:10 +00002055 }
2056 }
2057 type = vat->getElementType();
2058 break;
Anders Carlsson8a01b792008-12-20 20:46:34 +00002059 }
Mike Stump11289f42009-09-09 15:08:12 +00002060
Abramo Bagnara1cd83682012-01-07 10:52:36 +00002061 case Type::FunctionProto:
John McCall23c29fe2011-06-24 21:55:10 +00002062 case Type::FunctionNoProto:
Alp Toker314cc812014-01-25 16:55:45 +00002063 type = cast<FunctionType>(ty)->getReturnType();
John McCall23c29fe2011-06-24 21:55:10 +00002064 break;
Eli Friedman0dfb8892011-10-06 23:00:33 +00002065
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002066 case Type::Paren:
2067 case Type::TypeOf:
2068 case Type::UnaryTransform:
2069 case Type::Attributed:
2070 case Type::SubstTemplateTypeParm:
David Blaikie66ed89d2013-07-13 21:08:08 +00002071 case Type::PackExpansion:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002072 // Keep walking after single level desugaring.
2073 type = type.getSingleStepDesugaredType(getContext());
2074 break;
2075
2076 case Type::Typedef:
2077 case Type::Decltype:
2078 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00002079 case Type::DeducedTemplateSpecialization:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002080 // Stop walking: nothing to do.
2081 return;
2082
2083 case Type::TypeOfExpr:
2084 // Stop walking: emit typeof expression.
2085 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
2086 return;
2087
Eli Friedman0dfb8892011-10-06 23:00:33 +00002088 case Type::Atomic:
2089 type = cast<AtomicType>(ty)->getValueType();
2090 break;
Xiuli Pan9c14e282016-01-09 12:53:17 +00002091
2092 case Type::Pipe:
2093 type = cast<PipeType>(ty)->getElementType();
2094 break;
John McCall23c29fe2011-06-24 21:55:10 +00002095 }
2096 } while (type->isVariablyModifiedType());
Anders Carlssonccbe9202008-12-12 07:19:02 +00002097}
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002098
John McCall7f416cc2015-09-08 08:05:57 +00002099Address CodeGenFunction::EmitVAListRef(const Expr* E) {
Dan Gohmane9e32dc2010-10-29 22:47:07 +00002100 if (getContext().getBuiltinVaListType()->isArrayType())
John McCall7f416cc2015-09-08 08:05:57 +00002101 return EmitPointerWithAlignment(E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002102 return EmitLValue(E).getAddress();
2103}
Anders Carlsson15cb75a2009-02-07 22:53:43 +00002104
Charles Davisc7d5c942015-09-17 20:55:33 +00002105Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
2106 return EmitLValue(E).getAddress();
2107}
2108
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002109void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002110 const APValue &Init) {
2111 assert(!Init.isUninit() && "Invalid DeclRefExpr initializer!");
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002112 if (CGDebugInfo *Dbg = getDebugInfo())
Benjamin Kramer8c305922016-02-02 11:06:51 +00002113 if (CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002114 Dbg->EmitGlobalVariable(E->getDecl(), Init);
Devang Patele03edfd2010-08-10 07:24:25 +00002115}
John McCallc07a0c72011-02-17 10:25:35 +00002116
2117CodeGenFunction::PeepholeProtection
2118CodeGenFunction::protectFromPeepholes(RValue rvalue) {
2119 // At the moment, the only aggressive peephole we do in IR gen
2120 // is trunc(zext) folding, but if we add more, we can easily
2121 // extend this protection.
2122
2123 if (!rvalue.isScalar()) return PeepholeProtection();
2124 llvm::Value *value = rvalue.getScalarVal();
2125 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
2126
2127 // Just make an extra bitcast.
2128 assert(HaveInsertPoint());
2129 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
2130 Builder.GetInsertBlock());
2131
2132 PeepholeProtection protection;
2133 protection.Inst = inst;
2134 return protection;
2135}
2136
2137void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
2138 if (!protection.Inst) return;
2139
2140 // In theory, we could try to duplicate the peepholes now, but whatever.
2141 protection.Inst->eraseFromParent();
2142}
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002143
2144llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Value *AnnotationFn,
2145 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002146 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002147 SourceLocation Location) {
2148 llvm::Value *Args[4] = {
2149 AnnotatedVal,
2150 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
2151 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
2152 CGM.EmitAnnotationLineNo(Location)
2153 };
2154 return Builder.CreateCall(AnnotationFn, Args);
2155}
2156
2157void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
2158 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2159 // FIXME We create a new bitcast for every annotation because that's what
2160 // llvm-gcc was doing.
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002161 for (const auto *I : D->specific_attrs<AnnotateAttr>())
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002162 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
2163 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002164 I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002165}
2166
John McCall7f416cc2015-09-08 08:05:57 +00002167Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
2168 Address Addr) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002169 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
John McCall7f416cc2015-09-08 08:05:57 +00002170 llvm::Value *V = Addr.getPointer();
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002171 llvm::Type *VTy = V->getType();
2172 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
2173 CGM.Int8PtrTy);
2174
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002175 for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002176 // FIXME Always emit the cast inst so we can differentiate between
2177 // annotation on the first field of a struct and annotation on the struct
2178 // itself.
2179 if (VTy != CGM.Int8PtrTy)
2180 V = Builder.Insert(new llvm::BitCastInst(V, CGM.Int8PtrTy));
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002181 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002182 V = Builder.CreateBitCast(V, VTy);
2183 }
2184
John McCall7f416cc2015-09-08 08:05:57 +00002185 return Address(V, Addr.getAlignment());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002186}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002187
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00002188CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
Alexander Musman515ad8c2014-05-22 08:54:05 +00002189
Alexey Samsonov24cad992014-07-17 18:46:27 +00002190CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
2191 : CGF(CGF) {
2192 assert(!CGF->IsSanitizerScope);
2193 CGF->IsSanitizerScope = true;
2194}
2195
2196CodeGenFunction::SanitizerScope::~SanitizerScope() {
2197 CGF->IsSanitizerScope = false;
2198}
2199
Alexander Musman515ad8c2014-05-22 08:54:05 +00002200void CodeGenFunction::InsertHelper(llvm::Instruction *I,
2201 const llvm::Twine &Name,
2202 llvm::BasicBlock *BB,
2203 llvm::BasicBlock::iterator InsertPt) const {
2204 LoopStack.InsertHelper(I);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00002205 if (IsSanitizerScope)
2206 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002207}
2208
Mehdi Amini557c20a2016-03-13 21:05:23 +00002209void CGBuilderInserter::InsertHelper(
Alexander Musman515ad8c2014-05-22 08:54:05 +00002210 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
2211 llvm::BasicBlock::iterator InsertPt) const {
Mehdi Amini557c20a2016-03-13 21:05:23 +00002212 llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002213 if (CGF)
2214 CGF->InsertHelper(I, Name, BB, InsertPt);
2215}
2216
David Blaikie5df253382015-11-12 01:09:58 +00002217static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures,
Eric Christopherce836772015-11-14 02:38:37 +00002218 CodeGenModule &CGM, const FunctionDecl *FD,
2219 std::string &FirstMissing) {
David Blaikie5df253382015-11-12 01:09:58 +00002220 // If there aren't any required features listed then go ahead and return.
2221 if (ReqFeatures.empty())
2222 return false;
2223
2224 // Now build up the set of caller features and verify that all the required
2225 // features are there.
2226 llvm::StringMap<bool> CallerFeatureMap;
2227 CGM.getFunctionFeatureMap(CallerFeatureMap, FD);
2228
2229 // If we have at least one of the features in the feature list return
2230 // true, otherwise return false.
2231 return std::all_of(
2232 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) {
2233 SmallVector<StringRef, 1> OrFeatures;
2234 Feature.split(OrFeatures, "|");
2235 return std::any_of(OrFeatures.begin(), OrFeatures.end(),
2236 [&](StringRef Feature) {
Eric Christopherce836772015-11-14 02:38:37 +00002237 if (!CallerFeatureMap.lookup(Feature)) {
2238 FirstMissing = Feature.str();
2239 return false;
2240 }
2241 return true;
David Blaikie5df253382015-11-12 01:09:58 +00002242 });
2243 });
2244}
2245
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002246// Emits an error if we don't have a valid set of target features for the
2247// called function.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002248void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
2249 const FunctionDecl *TargetDecl) {
2250 // Early exit if this is an indirect call.
2251 if (!TargetDecl)
2252 return;
2253
2254 // Get the current enclosing function if it exists. If it doesn't
2255 // we can't check the target features anyhow.
2256 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl);
2257 if (!FD)
2258 return;
2259
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002260 // Grab the required features for the call. For a builtin this is listed in
2261 // the td file with the default cpu, for an always_inline function this is any
2262 // listed cpu and any listed features.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002263 unsigned BuiltinID = TargetDecl->getBuiltinID();
Eric Christopherce836772015-11-14 02:38:37 +00002264 std::string MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002265 if (BuiltinID) {
2266 SmallVector<StringRef, 1> ReqFeatures;
2267 const char *FeatureList =
2268 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2269 // Return if the builtin doesn't have any required features.
2270 if (!FeatureList || StringRef(FeatureList) == "")
2271 return;
2272 StringRef(FeatureList).split(ReqFeatures, ",");
Eric Christopherce836772015-11-14 02:38:37 +00002273 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002274 CGM.getDiags().Report(E->getLocStart(), diag::err_builtin_needs_feature)
2275 << TargetDecl->getDeclName()
2276 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2277
2278 } else if (TargetDecl->hasAttr<TargetAttr>()) {
2279 // Get the required features for the callee.
2280 SmallVector<StringRef, 1> ReqFeatures;
2281 llvm::StringMap<bool> CalleeFeatureMap;
2282 CGM.getFunctionFeatureMap(CalleeFeatureMap, TargetDecl);
Eric Christopherb7bbc532015-11-16 18:29:59 +00002283 for (const auto &F : CalleeFeatureMap) {
2284 // Only positive features are "required".
2285 if (F.getValue())
2286 ReqFeatures.push_back(F.getKey());
2287 }
Eric Christopherce836772015-11-14 02:38:37 +00002288 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002289 CGM.getDiags().Report(E->getLocStart(), diag::err_function_needs_feature)
Eric Christopherce836772015-11-14 02:38:37 +00002290 << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002291 }
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002292}
Peter Collingbournedc134532016-01-16 00:31:22 +00002293
2294void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) {
2295 if (!CGM.getCodeGenOpts().SanitizeStats)
2296 return;
2297
2298 llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint());
2299 IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation());
2300 CGM.getSanStats().create(IRB, SSK);
2301}
Amara Emerson652795d2016-11-10 14:44:30 +00002302
2303llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) {
2304 if (CGDebugInfo *DI = getDebugInfo())
2305 return DI->SourceLocToDebugLoc(Location);
2306
2307 return llvm::DebugLoc();
2308}