blob: 92564043e07e7cd0810e3ae57a6329dcf3694985 [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),
John McCall5cdf0382018-01-12 22:07:01 +000073 NormalCleanupDest(Address::invalid()), NextCleanupDestIndex(1),
Vitaly Buka1c943322016-10-26 01:59:57 +000074 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.
John McCall5cdf0382018-01-12 22:07:01 +0000442 if (NormalCleanupDest.isValid() && isCoroutine()) {
Gor Nishanov04491bd2017-11-11 17:00:43 +0000443 llvm::DominatorTree DT(*CurFn);
John McCall5cdf0382018-01-12 22:07:01 +0000444 llvm::PromoteMemToReg(
445 cast<llvm::AllocaInst>(NormalCleanupDest.getPointer()), DT);
446 NormalCleanupDest = Address::invalid();
Gor Nishanov04491bd2017-11-11 17:00:43 +0000447 }
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000448}
Chris Lattner308f4312007-05-29 23:50:05 +0000449
Chris Lattner3c77a352010-06-22 00:03:40 +0000450/// ShouldInstrumentFunction - Return true if the current function should be
451/// instrumented with __cyg_profile_func_* calls
452bool CodeGenFunction::ShouldInstrumentFunction() {
Hans Wennborg76c26c12017-11-14 21:13:27 +0000453 if (!CGM.getCodeGenOpts().InstrumentFunctions &&
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000454 !CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining &&
455 !CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
Chris Lattner3c77a352010-06-22 00:03:40 +0000456 return false;
Ted Kremenekc249c412011-05-16 23:49:20 +0000457 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
Chris Lattner3c77a352010-06-22 00:03:40 +0000458 return false;
459 return true;
460}
461
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000462/// ShouldXRayInstrument - Return true if the current function should be
463/// instrumented with XRay nop sleds.
464bool CodeGenFunction::ShouldXRayInstrumentFunction() const {
465 return CGM.getCodeGenOpts().XRayInstrumentFunctions;
466}
467
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000468/// AlwaysEmitXRayCustomEvents - Return true if we should emit IR for calls to
469/// the __xray_customevent(...) builin calls, when doing XRay instrumentation.
470bool CodeGenFunction::AlwaysEmitXRayCustomEvents() const {
Dean Michael Berris488f7c22018-04-13 02:31:58 +0000471 return CGM.getCodeGenOpts().XRayInstrumentFunctions &&
472 (CGM.getCodeGenOpts().XRayAlwaysEmitCustomEvents ||
473 CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask ==
474 XRayInstrKind::Custom);
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000475}
476
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000477llvm::Constant *
478CodeGenFunction::EncodeAddrForUseInPrologue(llvm::Function *F,
479 llvm::Constant *Addr) {
480 // Addresses stored in prologue data can't require run-time fixups and must
481 // be PC-relative. Run-time fixups are undesirable because they necessitate
482 // writable text segments, which are unsafe. And absolute addresses are
483 // undesirable because they break PIE mode.
484
485 // Add a layer of indirection through a private global. Taking its address
486 // won't result in a run-time fixup, even if Addr has linkonce_odr linkage.
487 auto *GV = new llvm::GlobalVariable(CGM.getModule(), Addr->getType(),
488 /*isConstant=*/true,
489 llvm::GlobalValue::PrivateLinkage, Addr);
490
491 // Create a PC-relative address.
492 auto *GOTAsInt = llvm::ConstantExpr::getPtrToInt(GV, IntPtrTy);
493 auto *FuncAsInt = llvm::ConstantExpr::getPtrToInt(F, IntPtrTy);
494 auto *PCRelAsInt = llvm::ConstantExpr::getSub(GOTAsInt, FuncAsInt);
495 return (IntPtrTy == Int32Ty)
496 ? PCRelAsInt
497 : llvm::ConstantExpr::getTrunc(PCRelAsInt, Int32Ty);
498}
499
500llvm::Value *
501CodeGenFunction::DecodeAddrUsedInPrologue(llvm::Value *F,
502 llvm::Value *EncodedAddr) {
503 // Reconstruct the address of the global.
504 auto *PCRelAsInt = Builder.CreateSExt(EncodedAddr, IntPtrTy);
505 auto *FuncAsInt = Builder.CreatePtrToInt(F, IntPtrTy, "func_addr.int");
506 auto *GOTAsInt = Builder.CreateAdd(PCRelAsInt, FuncAsInt, "global_addr.int");
507 auto *GOTAddr = Builder.CreateIntToPtr(GOTAsInt, Int8PtrPtrTy, "global_addr");
508
509 // Load the original pointer through the global.
510 return Builder.CreateLoad(Address(GOTAddr, getPointerAlign()),
511 "decoded_addr");
512}
513
Alexey Bader3e0b8172016-09-06 10:10:28 +0000514static void removeImageAccessQualifier(std::string& TyName) {
515 std::string ReadOnlyQual("__read_only");
516 std::string::size_type ReadOnlyPos = TyName.find(ReadOnlyQual);
517 if (ReadOnlyPos != std::string::npos)
518 // "+ 1" for the space after access qualifier.
519 TyName.erase(ReadOnlyPos, ReadOnlyQual.size() + 1);
520 else {
521 std::string WriteOnlyQual("__write_only");
522 std::string::size_type WriteOnlyPos = TyName.find(WriteOnlyQual);
523 if (WriteOnlyPos != std::string::npos)
524 TyName.erase(WriteOnlyPos, WriteOnlyQual.size() + 1);
525 else {
526 std::string ReadWriteQual("__read_write");
527 std::string::size_type ReadWritePos = TyName.find(ReadWriteQual);
528 if (ReadWritePos != std::string::npos)
529 TyName.erase(ReadWritePos, ReadWriteQual.size() + 1);
530 }
531 }
532}
533
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000534// Returns the address space id that should be produced to the
535// kernel_arg_addr_space metadata. This is always fixed to the ids
536// as specified in the SPIR 2.0 specification in order to differentiate
537// for example in clGetKernelArgInfo() implementation between the address
538// spaces with targets without unique mapping to the OpenCL address spaces
539// (basically all single AS CPUs).
Alexander Richardson6d989432017-10-15 18:48:14 +0000540static unsigned ArgInfoAddressSpace(LangAS AS) {
541 switch (AS) {
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000542 case LangAS::opencl_global: return 1;
543 case LangAS::opencl_constant: return 2;
544 case LangAS::opencl_local: return 3;
545 case LangAS::opencl_generic: return 4; // Not in SPIR 2.0 specs.
546 default:
547 return 0; // Assume private.
548 }
549}
550
Tanya Lattner7445ada2012-07-11 23:02:10 +0000551// OpenCL v1.2 s5.6.4.6 allows the compiler to store kernel argument
552// information in the program executable. The argument information stored
553// includes the argument name, its type, the address and access qualifiers used.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000554static void GenOpenCLArgMetadata(const FunctionDecl *FD, llvm::Function *Fn,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000555 CodeGenModule &CGM, llvm::LLVMContext &Context,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000556 CGBuilderTy &Builder, ASTContext &ASTCtx) {
Guy Benyeifb36ede2013-03-24 13:58:12 +0000557 // Create MDNodes that represent the kernel arg metadata.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000558 // Each MDNode is a list in the form of "key", N number of values which is
559 // the same number of values as their are kernel arguments.
Michael Ilseman686240a2012-12-04 00:29:55 +0000560
Joey Gouly92a47442014-04-04 13:43:57 +0000561 const PrintingPolicy &Policy = ASTCtx.getPrintingPolicy();
562
Guy Benyeifb36ede2013-03-24 13:58:12 +0000563 // MDNode for the kernel argument address space qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000564 SmallVector<llvm::Metadata *, 8> addressQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000565
566 // MDNode for the kernel argument access qualifiers (images only).
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000567 SmallVector<llvm::Metadata *, 8> accessQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000568
569 // MDNode for the kernel argument type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000570 SmallVector<llvm::Metadata *, 8> argTypeNames;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000571
Fraser Cormackdadc3712014-07-30 14:39:53 +0000572 // MDNode for the kernel argument base type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000573 SmallVector<llvm::Metadata *, 8> argBaseTypeNames;
Fraser Cormackdadc3712014-07-30 14:39:53 +0000574
Guy Benyeifb36ede2013-03-24 13:58:12 +0000575 // MDNode for the kernel argument type qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000576 SmallVector<llvm::Metadata *, 8> argTypeQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000577
Tanya Lattner7445ada2012-07-11 23:02:10 +0000578 // MDNode for the kernel argument names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000579 SmallVector<llvm::Metadata *, 8> argNames;
Michael Ilseman686240a2012-12-04 00:29:55 +0000580
Tanya Lattner7445ada2012-07-11 23:02:10 +0000581 for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i) {
582 const ParmVarDecl *parm = FD->getParamDecl(i);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000583 QualType ty = parm->getType();
584 std::string typeQuals;
585
586 if (ty->isPointerType()) {
587 QualType pointeeTy = ty->getPointeeType();
588
589 // Get address qualifier.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000590 addressQuals.push_back(llvm::ConstantAsMetadata::get(Builder.getInt32(
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000591 ArgInfoAddressSpace(pointeeTy.getAddressSpace()))));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000592
593 // Get argument type name.
Joey Gouly92a47442014-04-04 13:43:57 +0000594 std::string typeName =
595 pointeeTy.getUnqualifiedType().getAsString(Policy) + "*";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000596
597 // Turn "unsigned type" to "utype"
598 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000599 if (pointeeTy.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000600 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000601
602 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
603
Fraser Cormackdadc3712014-07-30 14:39:53 +0000604 std::string baseTypeName =
605 pointeeTy.getUnqualifiedType().getCanonicalType().getAsString(
606 Policy) +
607 "*";
608
609 // Turn "unsigned type" to "utype"
610 pos = baseTypeName.find("unsigned");
611 if (pos != std::string::npos)
612 baseTypeName.erase(pos+1, 8);
613
614 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName));
615
Guy Benyeifb36ede2013-03-24 13:58:12 +0000616 // Get argument type qualifiers:
617 if (ty.isRestrictQualified())
618 typeQuals = "restrict";
619 if (pointeeTy.isConstQualified() ||
620 (pointeeTy.getAddressSpace() == LangAS::opencl_constant))
Benjamin Krameref89ae02013-03-24 16:04:55 +0000621 typeQuals += typeQuals.empty() ? "const" : " const";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000622 if (pointeeTy.isVolatileQualified())
Benjamin Krameref89ae02013-03-24 16:04:55 +0000623 typeQuals += typeQuals.empty() ? "volatile" : " volatile";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000624 } else {
Pekka Jaaskelainen3587b322014-01-09 13:37:30 +0000625 uint32_t AddrSpc = 0;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000626 bool isPipe = ty->isPipeType();
627 if (ty->isImageType() || isPipe)
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000628 AddrSpc = ArgInfoAddressSpace(LangAS::opencl_global);
Bob Wilson95a27b02014-02-17 19:20:59 +0000629
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000630 addressQuals.push_back(
631 llvm::ConstantAsMetadata::get(Builder.getInt32(AddrSpc)));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000632
633 // Get argument type name.
Xiuli Pan9c14e282016-01-09 12:53:17 +0000634 std::string typeName;
635 if (isPipe)
Alexey Bader10e9e592016-07-13 10:28:13 +0000636 typeName = ty.getCanonicalType()->getAs<PipeType>()->getElementType()
637 .getAsString(Policy);
Xiuli Pan9c14e282016-01-09 12:53:17 +0000638 else
639 typeName = ty.getUnqualifiedType().getAsString(Policy);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000640
641 // Turn "unsigned type" to "utype"
642 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000643 if (ty.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000644 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000645
Xiuli Pan9c14e282016-01-09 12:53:17 +0000646 std::string baseTypeName;
647 if (isPipe)
Alexey Bader10e9e592016-07-13 10:28:13 +0000648 baseTypeName = ty.getCanonicalType()->getAs<PipeType>()
649 ->getElementType().getCanonicalType()
650 .getAsString(Policy);
Xiuli Pan9c14e282016-01-09 12:53:17 +0000651 else
652 baseTypeName =
Fraser Cormackdadc3712014-07-30 14:39:53 +0000653 ty.getUnqualifiedType().getCanonicalType().getAsString(Policy);
654
Alexey Bader3e0b8172016-09-06 10:10:28 +0000655 // Remove access qualifiers on images
656 // (as they are inseparable from type in clang implementation,
657 // but OpenCL spec provides a special query to get access qualifier
658 // via clGetKernelArgInfo with CL_KERNEL_ARG_ACCESS_QUALIFIER):
659 if (ty->isImageType()) {
660 removeImageAccessQualifier(typeName);
661 removeImageAccessQualifier(baseTypeName);
662 }
663
664 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
665
Fraser Cormackdadc3712014-07-30 14:39:53 +0000666 // Turn "unsigned type" to "utype"
667 pos = baseTypeName.find("unsigned");
668 if (pos != std::string::npos)
669 baseTypeName.erase(pos+1, 8);
670
671 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName));
672
Xiuli Pan9c14e282016-01-09 12:53:17 +0000673 if (isPipe)
674 typeQuals = "pipe";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000675 }
Justin Bogner0f066062013-11-22 10:20:40 +0000676
Guy Benyeifb36ede2013-03-24 13:58:12 +0000677 argTypeQuals.push_back(llvm::MDString::get(Context, typeQuals));
678
Xiuli Pan9c14e282016-01-09 12:53:17 +0000679 // Get image and pipe access qualifier:
Xiuli Pan9c14e282016-01-09 12:53:17 +0000680 if (ty->isImageType()|| ty->isPipeType()) {
Alexey Sotkin7d7f0dc2017-07-26 18:49:54 +0000681 const Decl *PDecl = parm;
682 if (auto *TD = dyn_cast<TypedefType>(ty))
683 PDecl = TD->getDecl();
684 const OpenCLAccessAttr *A = PDecl->getAttr<OpenCLAccessAttr>();
Aaron Ballman26891332014-01-14 17:41:53 +0000685 if (A && A->isWriteOnly())
Guy Benyeifb36ede2013-03-24 13:58:12 +0000686 accessQuals.push_back(llvm::MDString::get(Context, "write_only"));
Xiuli Pan11e13f62016-02-26 03:13:03 +0000687 else if (A && A->isReadWrite())
688 accessQuals.push_back(llvm::MDString::get(Context, "read_write"));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000689 else
690 accessQuals.push_back(llvm::MDString::get(Context, "read_only"));
691 } else
692 accessQuals.push_back(llvm::MDString::get(Context, "none"));
Michael Ilseman686240a2012-12-04 00:29:55 +0000693
Tanya Lattner7445ada2012-07-11 23:02:10 +0000694 // Get argument name.
695 argNames.push_back(llvm::MDString::get(Context, parm->getName()));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000696 }
Guy Benyeifb36ede2013-03-24 13:58:12 +0000697
Yaxun Liuba28cba2016-06-22 14:56:35 +0000698 Fn->setMetadata("kernel_arg_addr_space",
699 llvm::MDNode::get(Context, addressQuals));
700 Fn->setMetadata("kernel_arg_access_qual",
701 llvm::MDNode::get(Context, accessQuals));
702 Fn->setMetadata("kernel_arg_type",
703 llvm::MDNode::get(Context, argTypeNames));
704 Fn->setMetadata("kernel_arg_base_type",
705 llvm::MDNode::get(Context, argBaseTypeNames));
706 Fn->setMetadata("kernel_arg_type_qual",
707 llvm::MDNode::get(Context, argTypeQuals));
Sameer Sahasrabuddhec6093fe2014-12-04 05:30:58 +0000708 if (CGM.getCodeGenOpts().EmitOpenCLArgMetadata)
Yaxun Liuba28cba2016-06-22 14:56:35 +0000709 Fn->setMetadata("kernel_arg_name",
710 llvm::MDNode::get(Context, argNames));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000711}
712
Michael Ilseman686240a2012-12-04 00:29:55 +0000713void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000714 llvm::Function *Fn)
715{
716 if (!FD->hasAttr<OpenCLKernelAttr>())
717 return;
718
719 llvm::LLVMContext &Context = getLLVMContext();
720
Yaxun Liuba28cba2016-06-22 14:56:35 +0000721 GenOpenCLArgMetadata(FD, Fn, CGM, Context, Builder, getContext());
Michael Ilseman686240a2012-12-04 00:29:55 +0000722
Aaron Ballmanc4327992013-12-19 03:09:10 +0000723 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000724 QualType HintQTy = A->getTypeHint();
725 const ExtVectorType *HintEltQTy = HintQTy->getAs<ExtVectorType>();
726 bool IsSignedInteger =
727 HintQTy->isSignedIntegerType() ||
728 (HintEltQTy && HintEltQTy->getElementType()->isSignedIntegerType());
729 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000730 llvm::ConstantAsMetadata::get(llvm::UndefValue::get(
731 CGM.getTypes().ConvertType(A->getTypeHint()))),
732 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
733 llvm::IntegerType::get(Context, 32),
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000734 llvm::APInt(32, (uint64_t)(IsSignedInteger ? 1 : 0))))};
735 Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, AttrMDArgs));
Joey Goulyaba589c2013-03-08 09:42:32 +0000736 }
737
Aaron Ballmanc4327992013-12-19 03:09:10 +0000738 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000739 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000740 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
741 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
742 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000743 Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000744 }
745
Aaron Ballmanc4327992013-12-19 03:09:10 +0000746 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000747 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000748 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
749 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
750 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000751 Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, AttrMDArgs));
752 }
753
754 if (const OpenCLIntelReqdSubGroupSizeAttr *A =
755 FD->getAttr<OpenCLIntelReqdSubGroupSizeAttr>()) {
756 llvm::Metadata *AttrMDArgs[] = {
757 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getSubGroupSize()))};
758 Fn->setMetadata("intel_reqd_sub_group_size",
759 llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000760 }
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000761}
762
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000763/// Determine whether the function F ends with a return stmt.
764static bool endsWithReturn(const Decl* F) {
765 const Stmt *Body = nullptr;
766 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F))
767 Body = FD->getBody();
768 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F))
769 Body = OMD->getBody();
770
771 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) {
772 auto LastStmt = CS->body_rbegin();
773 if (LastStmt != CS->body_rend())
774 return isa<ReturnStmt>(*LastStmt);
775 }
776 return false;
777}
778
Anna Zakse43b4fc2017-01-13 00:50:50 +0000779static void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) {
780 Fn->addFnAttr("sanitize_thread_no_checking_at_run_time");
781 Fn->removeFnAttr(llvm::Attribute::SanitizeThread);
782}
783
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000784static bool matchesStlAllocatorFn(const Decl *D, const ASTContext &Ctx) {
785 auto *MD = dyn_cast_or_null<CXXMethodDecl>(D);
786 if (!MD || !MD->getDeclName().getAsIdentifierInfo() ||
787 !MD->getDeclName().getAsIdentifierInfo()->isStr("allocate") ||
788 (MD->getNumParams() != 1 && MD->getNumParams() != 2))
789 return false;
790
791 if (MD->parameters()[0]->getType().getCanonicalType() != Ctx.getSizeType())
792 return false;
793
794 if (MD->getNumParams() == 2) {
795 auto *PT = MD->parameters()[1]->getType()->getAs<PointerType>();
796 if (!PT || !PT->isVoidPointerType() ||
797 !PT->getPointeeType().isConstQualified())
798 return false;
799 }
800
801 return true;
802}
803
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000804/// Return the UBSan prologue signature for \p FD if one is available.
805static llvm::Constant *getPrologueSignature(CodeGenModule &CGM,
806 const FunctionDecl *FD) {
807 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
808 if (!MD->isStatic())
809 return nullptr;
810 return CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM);
811}
812
John McCalldec348f72013-05-03 07:33:41 +0000813void CodeGenFunction::StartFunction(GlobalDecl GD,
814 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000815 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +0000816 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000817 const FunctionArgList &Args,
Adrian Prantl42d71b92014-04-10 23:21:53 +0000818 SourceLocation Loc,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +0000819 SourceLocation StartLoc) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000820 assert(!CurFn &&
821 "Do not use a CodeGenFunction object for more than one function");
822
Anders Carlsson73fcc952009-09-11 00:07:24 +0000823 const Decl *D = GD.getDecl();
Michael Ilseman686240a2012-12-04 00:29:55 +0000824
Anders Carlssonf4478e92009-02-09 20:20:56 +0000825 DidCallStackSave = false;
John McCalldec348f72013-05-03 07:33:41 +0000826 CurCodeDecl = D;
David Majnemer25eb1652016-03-01 19:42:53 +0000827 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D))
828 if (FD->usesSEHTry())
829 CurSEHParent = FD;
Craig Topper8a13c412014-05-21 05:09:00 +0000830 CurFuncDecl = (D ? D->getNonClosureContext() : nullptr);
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000831 FnRetTy = RetTy;
Daniel Dunbar9c426522008-07-29 23:18:29 +0000832 CurFn = Fn;
John McCalla738c252011-03-09 04:27:21 +0000833 CurFnInfo = &FnInfo;
Chris Lattner5696e7b2008-06-17 18:05:57 +0000834 assert(CurFn->isDeclaration() && "Function already has body?");
835
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +0000836 // If this function has been blacklisted for any of the enabled sanitizers,
837 // disable the sanitizer for the function.
838 do {
839#define SANITIZER(NAME, ID) \
840 if (SanOpts.empty()) \
841 break; \
842 if (SanOpts.has(SanitizerKind::ID)) \
843 if (CGM.isInSanitizerBlacklist(SanitizerKind::ID, Fn, Loc)) \
844 SanOpts.set(SanitizerKind::ID, false);
845
846#include "clang/Basic/Sanitizers.def"
847#undef SANITIZER
848 } while (0);
Will Dietzf54319c2013-01-18 11:30:38 +0000849
Peter Collingbourne915df992015-05-15 18:33:32 +0000850 if (D) {
851 // Apply the no_sanitize* attributes to SanOpts.
Vitaly Buka69a2e182018-04-09 20:10:29 +0000852 for (auto Attr : D->specific_attrs<NoSanitizeAttr>()) {
853 SanitizerMask mask = Attr->getMask();
854 SanOpts.Mask &= ~mask;
855 if (mask & SanitizerKind::Address)
856 SanOpts.set(SanitizerKind::KernelAddress, false);
857 if (mask & SanitizerKind::KernelAddress)
858 SanOpts.set(SanitizerKind::Address, false);
Andrey Konovalov1ba9d9c2018-04-13 18:05:21 +0000859 if (mask & SanitizerKind::HWAddress)
860 SanOpts.set(SanitizerKind::KernelHWAddress, false);
861 if (mask & SanitizerKind::KernelHWAddress)
862 SanOpts.set(SanitizerKind::HWAddress, false);
Vitaly Buka69a2e182018-04-09 20:10:29 +0000863 }
Peter Collingbourne915df992015-05-15 18:33:32 +0000864 }
865
866 // Apply sanitizer attributes to the function.
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000867 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress))
Peter Collingbourne915df992015-05-15 18:33:32 +0000868 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
Andrey Konovalov1ba9d9c2018-04-13 18:05:21 +0000869 if (SanOpts.hasOneOf(SanitizerKind::HWAddress | SanitizerKind::KernelHWAddress))
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000870 Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress);
Peter Collingbourne915df992015-05-15 18:33:32 +0000871 if (SanOpts.has(SanitizerKind::Thread))
872 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
873 if (SanOpts.has(SanitizerKind::Memory))
874 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000875 if (SanOpts.has(SanitizerKind::SafeStack))
876 Fn->addFnAttr(llvm::Attribute::SafeStack);
Vlad Tsyrkleviche55aa032018-04-03 22:33:53 +0000877 if (SanOpts.has(SanitizerKind::ShadowCallStack))
878 Fn->addFnAttr(llvm::Attribute::ShadowCallStack);
Peter Collingbourne915df992015-05-15 18:33:32 +0000879
Matt Morehouse5317f2e2018-03-23 23:35:28 +0000880 // Apply fuzzing attribute to the function.
881 if (SanOpts.hasOneOf(SanitizerKind::Fuzzer | SanitizerKind::FuzzerNoLink))
882 Fn->addFnAttr(llvm::Attribute::OptForFuzzing);
883
Anna Zaksbcd35a82016-11-11 23:22:44 +0000884 // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize,
Anna Zakse43b4fc2017-01-13 00:50:50 +0000885 // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time.
Anna Zaksbcd35a82016-11-11 23:22:44 +0000886 if (SanOpts.has(SanitizerKind::Thread)) {
887 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
888 IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0);
889 if (OMD->getMethodFamily() == OMF_dealloc ||
890 OMD->getMethodFamily() == OMF_initialize ||
891 (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) {
Anna Zakse43b4fc2017-01-13 00:50:50 +0000892 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000893 }
Anna Zakse43b4fc2017-01-13 00:50:50 +0000894 } else if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D)) {
895 IdentifierInfo *II = FD->getIdentifier();
896 if (II && II->isStr("__destroy_helper_block_"))
897 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000898 }
899 }
900
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000901 // Ignore unrelated casts in STL allocate() since the allocator must cast
902 // from void* to T* before object initialization completes. Don't match on the
903 // namespace because not all allocators are in std::
904 if (D && SanOpts.has(SanitizerKind::CFIUnrelatedCast)) {
905 if (matchesStlAllocatorFn(D, getContext()))
906 SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast;
907 }
908
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000909 // Apply xray attributes to the function (as a string, for now)
Dean Michael Berris488f7c22018-04-13 02:31:58 +0000910 bool InstrumentXray = ShouldXRayInstrumentFunction() &&
911 CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
912 XRayInstrKind::Function);
Oren Ben Simhon57cc1a52018-01-09 08:53:59 +0000913 if (D && InstrumentXray) {
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000914 if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) {
915 if (XRayAttr->alwaysXRayInstrument())
916 Fn->addFnAttr("function-instrument", "xray-always");
917 if (XRayAttr->neverXRayInstrument())
918 Fn->addFnAttr("function-instrument", "xray-never");
Dean Michael Berris418da3f2017-03-06 07:08:21 +0000919 if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>()) {
920 Fn->addFnAttr("xray-log-args",
921 llvm::utostr(LogArgs->getArgumentCount()));
922 }
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000923 } else {
Dean Michael Berris835832d2017-03-30 00:29:36 +0000924 if (!CGM.imbueXRayAttrs(Fn, Loc))
925 Fn->addFnAttr(
926 "xray-instruction-threshold",
927 llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold));
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000928 }
929 }
930
Nirav Daved2f44d82016-04-05 17:50:43 +0000931 // Add no-jump-tables value.
932 Fn->addFnAttr("no-jump-tables",
933 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables));
934
Dehao Chen5e97f232017-08-24 21:37:33 +0000935 // Add profile-sample-accurate value.
936 if (CGM.getCodeGenOpts().ProfileSampleAccurate)
937 Fn->addFnAttr("profile-sample-accurate");
938
Richard Smith9c6890a2012-11-01 22:30:59 +0000939 if (getLangOpts().OpenCL) {
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000940 // Add metadata for a kernel function.
941 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000942 EmitOpenCLKernelMetadata(FD, Fn);
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000943 }
944
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000945 // If we are checking function types, emit a function type signature as
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000946 // prologue data.
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000947 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000948 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000949 if (llvm::Constant *PrologueSig = getPrologueSignature(CGM, FD)) {
Stephan Bergmann8c85bca2018-01-05 07:57:12 +0000950 // Remove any (C++17) exception specifications, to allow calling e.g. a
951 // noexcept function through a non-noexcept pointer.
952 auto ProtoTy =
953 getContext().getFunctionTypeWithExceptionSpec(FD->getType(),
954 EST_None);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000955 llvm::Constant *FTRTTIConst =
Stephan Bergmann8c85bca2018-01-05 07:57:12 +0000956 CGM.GetAddrOfRTTIDescriptor(ProtoTy, /*ForEH=*/true);
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000957 llvm::Constant *FTRTTIConstEncoded =
958 EncodeAddrForUseInPrologue(Fn, FTRTTIConst);
959 llvm::Constant *PrologueStructElems[] = {PrologueSig,
960 FTRTTIConstEncoded};
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000961 llvm::Constant *PrologueStructConst =
962 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
963 Fn->setPrologueData(PrologueStructConst);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000964 }
965 }
966 }
967
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000968 // If we're checking nullability, we need to know whether we can check the
969 // return value. Initialize the flag to 'true' and refine it in EmitParmDecl.
970 if (SanOpts.has(SanitizerKind::NullabilityReturn)) {
971 auto Nullability = FnRetTy->getNullability(getContext());
972 if (Nullability && *Nullability == NullabilityKind::NonNull) {
973 if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
974 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>()))
975 RetValNullabilityPrecondition =
976 llvm::ConstantInt::getTrue(getLLVMContext());
977 }
978 }
979
James Molloyc16a60b62015-11-12 15:36:04 +0000980 // If we're in C++ mode and the function name is "main", it is guaranteed
981 // to be norecurse by the standard (3.6.1.3 "The function main shall not be
982 // used within a program").
983 if (getLangOpts().CPlusPlus)
984 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
985 if (FD->isMain())
986 Fn->addFnAttr(llvm::Attribute::NoRecurse);
Honggyu Kim2bbdeac2016-09-01 06:14:45 +0000987
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000988 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000989
Chris Lattner5696e7b2008-06-17 18:05:57 +0000990 // Create a marker to make it easy to insert allocas into the entryblock
991 // later. Don't create this with the builder, because we don't want it
992 // folded.
Chris Lattner5e016ae2010-06-27 07:15:29 +0000993 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
Mehdi Amini557c20a2016-03-13 21:05:23 +0000994 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000995
John McCallbd309292010-07-06 01:34:17 +0000996 ReturnBlock = getJumpDestInCurrentScope("return");
Mike Stump11289f42009-09-09 15:08:12 +0000997
Chris Lattner5696e7b2008-06-17 18:05:57 +0000998 Builder.SetInsertPoint(EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000999
Vedant Kumarc34d3432017-06-23 21:32:38 +00001000 // If we're checking the return value, allocate space for a pointer to a
1001 // precise source location of the checked return statement.
1002 if (requiresReturnValueCheck()) {
1003 ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr");
1004 InitTempAlloca(ReturnLocation, llvm::ConstantPointerNull::get(Int8PtrTy));
1005 }
1006
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +00001007 // Emit subprogram debug descriptor.
Anders Carlsson63784f42009-02-13 08:11:52 +00001008 if (CGDebugInfo *DI = getDebugInfo()) {
Reid Klecknerf00f8032016-06-08 20:41:54 +00001009 // Reconstruct the type from the argument list so that implicit parameters,
1010 // such as 'this' and 'vtt', show up in the debug info. Preserve the calling
1011 // convention.
1012 CallingConv CC = CallingConv::CC_C;
1013 if (auto *FD = dyn_cast_or_null<FunctionDecl>(D))
1014 if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>())
1015 CC = SrcFnTy->getCallConv();
Jordan Rose5c382722013-03-08 21:51:21 +00001016 SmallVector<QualType, 16> ArgTypes;
Reid Klecknerf00f8032016-06-08 20:41:54 +00001017 for (const VarDecl *VD : Args)
1018 ArgTypes.push_back(VD->getType());
1019 QualType FnType = getContext().getFunctionType(
1020 RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Brock Wyma94ece8f2018-04-16 16:53:57 +00001021 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, CurFuncIsThunk,
1022 Builder);
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +00001023 }
1024
Hans Wennborg76c26c12017-11-14 21:13:27 +00001025 if (ShouldInstrumentFunction()) {
Hans Wennborg14e8a5a2017-11-21 17:30:34 +00001026 if (CGM.getCodeGenOpts().InstrumentFunctions)
1027 CurFn->addFnAttr("instrument-function-entry", "__cyg_profile_func_enter");
1028 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
1029 CurFn->addFnAttr("instrument-function-entry-inlined",
1030 "__cyg_profile_func_enter");
1031 if (CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
1032 CurFn->addFnAttr("instrument-function-entry-inlined",
1033 "__cyg_profile_func_enter_bare");
Hans Wennborg76c26c12017-11-14 21:13:27 +00001034 }
Chris Lattner3c77a352010-06-22 00:03:40 +00001035
Honggyu Kim2b0e4242016-09-01 11:29:21 +00001036 // Since emitting the mcount call here impacts optimizations such as function
1037 // inlining, we just add an attribute to insert a mcount call in backend.
1038 // The attribute "counting-function" is set to mcount function name which is
1039 // architecture dependent.
Nirav Dave0c86ccf2017-01-31 17:00:35 +00001040 if (CGM.getCodeGenOpts().InstrumentForProfiling) {
Manoj Gupta886b4502018-03-02 23:52:44 +00001041 // Calls to fentry/mcount should not be generated if function has
1042 // the no_instrument_function attribute.
1043 if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) {
1044 if (CGM.getCodeGenOpts().CallFEntry)
1045 Fn->addFnAttr("fentry-call", "true");
1046 else {
Hans Wennborg76c26c12017-11-14 21:13:27 +00001047 Fn->addFnAttr("instrument-function-entry-inlined",
1048 getTarget().getMCountName());
1049 }
Manoj Gupta162b40a2017-06-19 18:45:03 +00001050 }
Nirav Dave0c86ccf2017-01-31 17:00:35 +00001051 }
Roman Divacky178e01602011-02-10 16:52:03 +00001052
Eli Friedman4b1942c2009-12-04 02:43:40 +00001053 if (RetTy->isVoidType()) {
1054 // Void type; nothing to return.
John McCall7f416cc2015-09-08 08:05:57 +00001055 ReturnValue = Address::invalid();
Adrian Prantl2cede0f2014-04-29 01:07:59 +00001056
1057 // Count the implicit return.
1058 if (!endsWithReturn(D))
1059 ++NumReturnExprs;
Eli Friedman4b1942c2009-12-04 02:43:40 +00001060 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect &&
John McCall47fb9502013-03-07 21:37:08 +00001061 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
Eli Friedman4b1942c2009-12-04 02:43:40 +00001062 // Indirect aggregate return; emit returned value directly into sret slot.
Daniel Dunbarfd09df72010-02-16 19:45:20 +00001063 // This reduces code size, and affects correctness in C++.
Reid Kleckner37abaca2014-05-09 22:46:15 +00001064 auto AI = CurFn->arg_begin();
1065 if (CurFnInfo->getReturnInfo().isSRetAfterThis())
1066 ++AI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001067 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign());
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001068 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
1069 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
1070 // Load the sret pointer from the argument struct and return into that.
1071 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
1072 llvm::Function::arg_iterator EI = CurFn->arg_end();
1073 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001074 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx);
John McCall7f416cc2015-09-08 08:05:57 +00001075 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result");
1076 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy));
Eli Friedman4b1942c2009-12-04 02:43:40 +00001077 } else {
Daniel Dunbarfd09df72010-02-16 19:45:20 +00001078 ReturnValue = CreateIRTemp(RetTy, "retval");
John McCall31168b02011-06-15 23:02:42 +00001079
1080 // Tell the epilog emitter to autorelease the result. We do this
1081 // now so that various specialized functions can suppress it
1082 // during their IR-generation.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001083 if (getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00001084 !CurFnInfo->isReturnsRetained() &&
1085 RetTy->isObjCRetainableType())
1086 AutoreleaseResult = true;
Eli Friedman4b1942c2009-12-04 02:43:40 +00001087 }
1088
Mike Stump1d849212009-12-07 23:38:24 +00001089 EmitStartEHSpec(CurCodeDecl);
John McCall31168b02011-06-15 23:02:42 +00001090
1091 PrologueCleanupDepth = EHStack.stable_begin();
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001092
1093 // Emit OpenMP specific initialization of the device functions.
1094 if (getLangOpts().OpenMP && CurCodeDecl)
1095 CGM.getOpenMPRuntime().emitFunctionProlog(*this, CurCodeDecl);
1096
Daniel Dunbard931a872009-02-02 22:03:45 +00001097 EmitFunctionProlog(*CurFnInfo, CurFn, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001098
Eli Friedman9fbeba02012-02-11 02:57:39 +00001099 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
John McCall5d865c322010-08-31 07:33:07 +00001100 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
Eli Friedman9fbeba02012-02-11 02:57:39 +00001101 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
1102 if (MD->getParent()->isLambda() &&
1103 MD->getOverloadedOperator() == OO_Call) {
1104 // We're in a lambda; figure out the captures.
1105 MD->getParent()->getCaptureFields(LambdaCaptureFields,
1106 LambdaThisCaptureField);
1107 if (LambdaThisCaptureField) {
Faisal Validc6b5962016-03-21 09:25:37 +00001108 // If the lambda captures the object referred to by '*this' - either by
1109 // value or by reference, make sure CXXThisValue points to the correct
1110 // object.
1111
1112 // Get the lvalue for the field (which is a copy of the enclosing object
1113 // or contains the address of the enclosing object).
1114 LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
1115 if (!LambdaThisCaptureField->getType()->isPointerType()) {
1116 // If the enclosing object was captured by value, just use its address.
1117 CXXThisValue = ThisFieldLValue.getAddress().getPointer();
1118 } else {
1119 // Load the lvalue pointed to by the field, since '*this' was captured
1120 // by reference.
1121 CXXThisValue =
1122 EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal();
1123 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001124 }
Alexey Bataev39c81e22014-08-28 04:28:19 +00001125 for (auto *FD : MD->getParent()->fields()) {
1126 if (FD->hasCapturedVLAType()) {
1127 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
1128 SourceLocation()).getScalarVal();
1129 auto VAT = FD->getCapturedVLAType();
1130 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
1131 }
1132 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001133 } else {
1134 // Not in a lambda; just use 'this' from the method.
1135 // FIXME: Should we generate a new load for each use of 'this'? The
1136 // fast register allocator would be happier...
1137 CXXThisValue = CXXABIThisValue;
1138 }
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001139
Vedant Kumarffd7c882017-04-14 22:03:34 +00001140 // Check the 'this' pointer once per function, if it's available.
Richard Smith376c28e2017-08-24 20:10:33 +00001141 if (CXXABIThisValue) {
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001142 SanitizerSet SkippedChecks;
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001143 SkippedChecks.set(SanitizerKind::ObjectSize, true);
Vedant Kumarffd7c882017-04-14 22:03:34 +00001144 QualType ThisTy = MD->getThisType(getContext());
Richard Smith376c28e2017-08-24 20:10:33 +00001145
1146 // If this is the call operator of a lambda with no capture-default, it
1147 // may have a static invoker function, which may call this operator with
1148 // a null 'this' pointer.
1149 if (isLambdaCallOperator(MD) &&
George Burgess IV00f70bd2018-03-01 05:43:23 +00001150 MD->getParent()->getLambdaCaptureDefault() == LCD_None)
Richard Smith376c28e2017-08-24 20:10:33 +00001151 SkippedChecks.set(SanitizerKind::Null, true);
1152
1153 EmitTypeCheck(isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall
1154 : TCK_MemberCall,
1155 Loc, CXXABIThisValue, ThisTy,
Vedant Kumarffd7c882017-04-14 22:03:34 +00001156 getContext().getTypeAlignInChars(ThisTy->getPointeeType()),
1157 SkippedChecks);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001158 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001159 }
John McCall347132b2010-02-16 22:04:33 +00001160
Anders Carlssonc20879a2008-12-20 21:28:43 +00001161 // If any of the arguments have a variably modified type, make sure to
1162 // emit the type size.
1163 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
1164 i != e; ++i) {
Eli Friedman1f576832012-11-14 22:09:59 +00001165 const VarDecl *VD = *i;
1166
1167 // Dig out the type as written from ParmVarDecls; it's unclear whether
1168 // the standard (C99 6.9.1p10) requires this, but we're following the
1169 // precedent set by gcc.
1170 QualType Ty;
1171 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
1172 Ty = PVD->getOriginalType();
1173 else
1174 Ty = VD->getType();
Anders Carlssonc20879a2008-12-20 21:28:43 +00001175
1176 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +00001177 EmitVariablyModifiedType(Ty);
Anders Carlssonc20879a2008-12-20 21:28:43 +00001178 }
Eric Christopher7cdf9482011-10-13 21:45:18 +00001179 // Emit a location at the end of the prologue.
1180 if (CGDebugInfo *DI = getDebugInfo())
1181 DI->EmitLocation(Builder, StartLoc);
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001182}
Eli Friedman3d421e12008-08-25 21:31:01 +00001183
Richard Smithb47c36f2013-11-05 09:12:18 +00001184void CodeGenFunction::EmitFunctionBody(FunctionArgList &Args,
1185 const Stmt *Body) {
Justin Bogner66242d62015-04-23 23:06:47 +00001186 incrementProfileCounter(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001187 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
David Blaikie0a21d0d2013-01-26 22:16:26 +00001188 EmitCompoundStmtWithoutScope(*S);
1189 else
Richard Smithb47c36f2013-11-05 09:12:18 +00001190 EmitStmt(Body);
John McCall89b12b32010-02-18 03:17:58 +00001191}
1192
Bob Wilsonbf854f02014-02-17 19:21:09 +00001193/// When instrumenting to collect profile data, the counts for some blocks
1194/// such as switch cases need to not include the fall-through counts, so
1195/// emit a branch around the instrumentation code. When not instrumenting,
1196/// this just calls EmitBlock().
1197void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
Justin Bogner66242d62015-04-23 23:06:47 +00001198 const Stmt *S) {
Craig Topper8a13c412014-05-21 05:09:00 +00001199 llvm::BasicBlock *SkipCountBB = nullptr;
Rong Xu9837ef52016-02-04 18:39:09 +00001200 if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001201 // When instrumenting for profiling, the fallthrough to certain
1202 // statements needs to skip over the instrumentation code so that we
1203 // get an accurate count.
1204 SkipCountBB = createBasicBlock("skipcount");
1205 EmitBranch(SkipCountBB);
1206 }
1207 EmitBlock(BB);
Justin Bogner66242d62015-04-23 23:06:47 +00001208 uint64_t CurrentCount = getCurrentProfileCount();
1209 incrementProfileCounter(S);
1210 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001211 if (SkipCountBB)
1212 EmitBlock(SkipCountBB);
1213}
1214
John McCall8601a752010-08-03 22:46:07 +00001215/// Tries to mark the given function nounwind based on the
1216/// non-existence of any throwing calls within it. We believe this is
1217/// lightweight enough to do at -O0.
1218static void TryMarkNoThrow(llvm::Function *F) {
John McCall59966992010-08-11 22:38:33 +00001219 // LLVM treats 'nounwind' on a function as part of the type, so we
1220 // can't do this on functions that can be overwritten.
Sanjoy Dasf60a0d72016-04-08 01:31:02 +00001221 if (F->isInterposable()) return;
John McCall59966992010-08-11 22:38:33 +00001222
David Majnemerdbf10452015-07-31 17:58:45 +00001223 for (llvm::BasicBlock &BB : *F)
1224 for (llvm::Instruction &I : BB)
1225 if (I.mayThrow())
Bill Wendlingf0724e82011-09-19 20:31:14 +00001226 return;
David Majnemerdbf10452015-07-31 17:58:45 +00001227
Bill Wendling73e465e2012-10-10 03:13:20 +00001228 F->setDoesNotThrow();
John McCall8601a752010-08-03 22:46:07 +00001229}
1230
Richard Smith5179eb72016-06-28 19:03:57 +00001231QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD,
1232 FunctionArgList &Args) {
Anders Carlsson73fcc952009-09-11 00:07:24 +00001233 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Alp Toker314cc812014-01-25 16:55:45 +00001234 QualType ResTy = FD->getReturnType();
Mike Stump11289f42009-09-09 15:08:12 +00001235
Reid Kleckner89077a12013-12-17 19:46:40 +00001236 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1237 if (MD && MD->isInstance()) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001238 if (CGM.getCXXABI().HasThisReturn(GD))
1239 ResTy = MD->getThisType(getContext());
David Majnemer0c0b6d92014-10-31 20:09:12 +00001240 else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
1241 ResTy = CGM.getContext().VoidPtrTy;
Reid Kleckner89077a12013-12-17 19:46:40 +00001242 CGM.getCXXABI().buildThisParam(*this, Args);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001243 }
Justin Bogner66242d62015-04-23 23:06:47 +00001244
Richard Smith5179eb72016-06-28 19:03:57 +00001245 // The base version of an inheriting constructor whose constructed base is a
1246 // virtual base is not passed any arguments (because it doesn't actually call
1247 // the inherited constructor).
1248 bool PassedParams = true;
1249 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
1250 if (auto Inherited = CD->getInheritedConstructor())
1251 PassedParams =
1252 getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001253
Richard Smith5179eb72016-06-28 19:03:57 +00001254 if (PassedParams) {
1255 for (auto *Param : FD->parameters()) {
1256 Args.push_back(Param);
1257 if (!Param->hasAttr<PassObjectSizeAttr>())
1258 continue;
1259
Richard Smith5179eb72016-06-28 19:03:57 +00001260 auto *Implicit = ImplicitParamDecl::Create(
Alexey Bataev56223232017-06-09 13:40:18 +00001261 getContext(), Param->getDeclContext(), Param->getLocation(),
1262 /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other);
Richard Smith5179eb72016-06-28 19:03:57 +00001263 SizeArguments[Param] = Implicit;
1264 Args.push_back(Implicit);
1265 }
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001266 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001267
Reid Kleckner89077a12013-12-17 19:46:40 +00001268 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
1269 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
1270
Richard Smith5179eb72016-06-28 19:03:57 +00001271 return ResTy;
1272}
1273
Alex Lorenzc1608f72017-01-04 13:40:34 +00001274static bool
1275shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD,
1276 const ASTContext &Context) {
1277 QualType T = FD->getReturnType();
1278 // Avoid the optimization for functions that return a record type with a
1279 // trivial destructor or another trivially copyable type.
1280 if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) {
1281 if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl()))
1282 return !ClassDecl->hasTrivialDestructor();
1283 }
1284 return !T.isTriviallyCopyableType(Context);
1285}
1286
Richard Smith5179eb72016-06-28 19:03:57 +00001287void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1288 const CGFunctionInfo &FnInfo) {
1289 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
1290 CurGD = GD;
1291
1292 FunctionArgList Args;
1293 QualType ResTy = BuildFunctionArgList(GD, Args);
1294
1295 // Check if we should generate debug info for this function.
1296 if (FD->hasAttr<NoDebugAttr>())
1297 DebugInfo = nullptr; // disable debug info indefinitely for this function
1298
Reid Klecknera8589812017-02-08 16:09:32 +00001299 // The function might not have a body if we're generating thunks for a
1300 // function declaration.
John McCall89b12b32010-02-18 03:17:58 +00001301 SourceRange BodyRange;
Reid Klecknera8589812017-02-08 16:09:32 +00001302 if (Stmt *Body = FD->getBody())
1303 BodyRange = Body->getSourceRange();
1304 else
1305 BodyRange = FD->getLocation();
Adrian Prantldc237b52013-05-16 00:41:26 +00001306 CurEHLocation = BodyRange.getEnd();
Anders Carlsson438cf922009-11-06 02:55:43 +00001307
Adrian Prantl42d71b92014-04-10 23:21:53 +00001308 // Use the location of the start of the function to determine where
1309 // the function definition is located. By default use the location
1310 // of the declaration as the location for the subprogram. A function
1311 // may lack a declaration in the source code if it is created by code
1312 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001313 SourceLocation Loc = FD->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001314
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001315 // If this is a function specialization then use the pattern body
1316 // as the location for the function.
1317 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
1318 if (SpecDecl->hasBody(SpecDecl))
1319 Loc = SpecDecl->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001320
Vitaly Buka64c80b42016-10-26 05:42:30 +00001321 Stmt *Body = FD->getBody();
1322
1323 // Initialize helper which will detect jumps which can cause invalid lifetime
1324 // markers.
1325 if (Body && ShouldEmitLifetimeMarkers)
1326 Bypasses.Init(Body);
1327
John McCall89b12b32010-02-18 03:17:58 +00001328 // Emit the standard function prologue.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001329 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
Anders Carlsson438cf922009-11-06 02:55:43 +00001330
John McCall89b12b32010-02-18 03:17:58 +00001331 // Generate the body of the function.
Serge Pavlov3a561452015-12-06 14:32:39 +00001332 PGO.assignRegionCounters(GD, CurFn);
John McCallb81884d2010-02-19 09:25:03 +00001333 if (isa<CXXDestructorDecl>(FD))
1334 EmitDestructorBody(Args);
1335 else if (isa<CXXConstructorDecl>(FD))
1336 EmitConstructorBody(Args);
Richard Smith9c6890a2012-11-01 22:30:59 +00001337 else if (getLangOpts().CUDA &&
Artem Belevichf3d3db62015-03-19 18:58:18 +00001338 !getLangOpts().CUDAIsDevice &&
Peter Collingbournefa4d6032011-10-06 18:51:56 +00001339 FD->hasAttr<CUDAGlobalAttr>())
Artem Belevich52cc4872015-05-07 19:34:16 +00001340 CGM.getCUDARuntime().emitDeviceStub(*this, Args);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001341 else if (isa<CXXMethodDecl>(FD) &&
1342 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
Faisal Vali2b391ab2013-09-26 19:54:12 +00001343 // The lambda static invoker function is special, because it forwards or
Douglas Gregor355efbb2012-02-17 03:02:34 +00001344 // clones the body of the function call operator (but is actually static).
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001345 EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD));
Lang Hamesbf122742013-02-17 07:22:09 +00001346 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
Nick Lewyckyb39be1f2013-09-10 05:14:39 +00001347 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
1348 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
Lang Hamesbf122742013-02-17 07:22:09 +00001349 // Implicit copy-assignment gets the same special treatment as implicit
1350 // copy-constructors.
1351 emitImplicitAssignmentOperatorBody(Args);
Vitaly Buka64c80b42016-10-26 05:42:30 +00001352 } else if (Body) {
Richard Smithb47c36f2013-11-05 09:12:18 +00001353 EmitFunctionBody(Args, Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001354 } else
1355 llvm_unreachable("no definition for emitted function");
Anders Carlssonff8cce42010-02-07 19:45:40 +00001356
Richard Smith9f9e5822012-10-04 23:52:29 +00001357 // C++11 [stmt.return]p2:
1358 // Flowing off the end of a function [...] results in undefined behavior in
1359 // a value-returning function.
1360 // C11 6.9.1p12:
1361 // If the '}' that terminates a function is reached, and the value of the
1362 // function call is used by the caller, the behavior is undefined.
Reid Kleckner9b3e3df2014-09-04 20:04:38 +00001363 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
Alp Toker314cc812014-01-25 16:55:45 +00001364 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
Alex Lorenzc1608f72017-01-04 13:40:34 +00001365 bool ShouldEmitUnreachable =
1366 CGM.getCodeGenOpts().StrictReturn ||
1367 shouldUseUndefinedBehaviorReturnOptimization(FD, getContext());
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001368 if (SanOpts.has(SanitizerKind::Return)) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001369 SanitizerScope SanScope(this);
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001370 llvm::Value *IsFalse = Builder.getFalse();
1371 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00001372 SanitizerHandler::MissingReturn,
1373 EmitCheckSourceLocation(FD->getLocation()), None);
Alex Lorenzc1608f72017-01-04 13:40:34 +00001374 } else if (ShouldEmitUnreachable) {
1375 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
1376 EmitTrapCall(llvm::Intrinsic::trap);
Akira Hatanaka85365cd2015-07-02 22:15:41 +00001377 }
Alex Lorenzc1608f72017-01-04 13:40:34 +00001378 if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) {
1379 Builder.CreateUnreachable();
1380 Builder.ClearInsertionPoint();
1381 }
Richard Smith9f9e5822012-10-04 23:52:29 +00001382 }
1383
John McCall89b12b32010-02-18 03:17:58 +00001384 // Emit the standard function epilogue.
1385 FinishFunction(BodyRange.getEnd());
John McCall8601a752010-08-03 22:46:07 +00001386
1387 // If we haven't marked the function nothrow through other means, do
1388 // a quick pass now to see if we can.
1389 if (!CurFn->doesNotThrow())
1390 TryMarkNoThrow(CurFn);
Chris Lattner5696e7b2008-06-17 18:05:57 +00001391}
1392
Chris Lattner5b1964b2008-11-11 07:41:27 +00001393/// ContainsLabel - Return true if the statement contains a label in it. If
1394/// this statement is not executed normally, it not containing a label means
1395/// that we can just remove the code.
1396bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
1397 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001398 if (!S) return false;
Mike Stump11289f42009-09-09 15:08:12 +00001399
Chris Lattner5b1964b2008-11-11 07:41:27 +00001400 // If this is a label, we have to emit the code, consider something like:
1401 // if (0) { ... foo: bar(); } goto foo;
Chris Lattner29911cc2011-02-28 00:18:40 +00001402 //
1403 // TODO: If anyone cared, we could track __label__'s, since we know that you
1404 // can't jump to one from outside their declared region.
Chris Lattner5b1964b2008-11-11 07:41:27 +00001405 if (isa<LabelStmt>(S))
1406 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001407
Chris Lattner5b1964b2008-11-11 07:41:27 +00001408 // If this is a case/default statement, and we haven't seen a switch, we have
1409 // to emit the code.
1410 if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
1411 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001412
Chris Lattner5b1964b2008-11-11 07:41:27 +00001413 // If this is a switch statement, we want to ignore cases below it.
1414 if (isa<SwitchStmt>(S))
1415 IgnoreCaseStmts = true;
Mike Stump11289f42009-09-09 15:08:12 +00001416
Chris Lattner5b1964b2008-11-11 07:41:27 +00001417 // Scan subexpressions for verboten labels.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001418 for (const Stmt *SubStmt : S->children())
1419 if (ContainsLabel(SubStmt, IgnoreCaseStmts))
Chris Lattner5b1964b2008-11-11 07:41:27 +00001420 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001421
Chris Lattner5b1964b2008-11-11 07:41:27 +00001422 return false;
1423}
1424
Chris Lattner29911cc2011-02-28 00:18:40 +00001425/// containsBreak - Return true if the statement contains a break out of it.
1426/// If the statement (recursively) contains a switch or loop with a break
1427/// inside of it, this is fine.
1428bool CodeGenFunction::containsBreak(const Stmt *S) {
1429 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001430 if (!S) return false;
Chris Lattner29911cc2011-02-28 00:18:40 +00001431
1432 // If this is a switch or loop that defines its own break scope, then we can
1433 // include it and anything inside of it.
1434 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
1435 isa<ForStmt>(S))
Chris Lattner30db8282011-02-28 00:42:31 +00001436 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001437
Chris Lattner30db8282011-02-28 00:42:31 +00001438 if (isa<BreakStmt>(S))
Chris Lattner29911cc2011-02-28 00:18:40 +00001439 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001440
Chris Lattner29911cc2011-02-28 00:18:40 +00001441 // Scan subexpressions for verboten breaks.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001442 for (const Stmt *SubStmt : S->children())
1443 if (containsBreak(SubStmt))
Chris Lattner29911cc2011-02-28 00:18:40 +00001444 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001445
Chris Lattner29911cc2011-02-28 00:18:40 +00001446 return false;
1447}
1448
Richard Smithd8e3ac32016-09-16 23:30:39 +00001449bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) {
1450 if (!S) return false;
1451
1452 // Some statement kinds add a scope and thus never add a decl to the current
1453 // scope. Note, this list is longer than the list of statements that might
1454 // have an unscoped decl nested within them, but this way is conservatively
1455 // correct even if more statement kinds are added.
1456 if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
1457 isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) ||
1458 isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) ||
1459 isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S))
1460 return false;
1461
1462 if (isa<DeclStmt>(S))
1463 return true;
1464
1465 for (const Stmt *SubStmt : S->children())
1466 if (mightAddDeclToScope(SubStmt))
1467 return true;
1468
1469 return false;
1470}
Chris Lattnercd439292008-11-12 08:04:58 +00001471
Chris Lattner41c6ab52011-02-27 23:02:32 +00001472/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1473/// to a constant, or if it does but contains a label, return false. If it
1474/// constant folds return true and set the boolean result in Result.
1475bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
Richard Smithb130fe72016-06-23 19:16:49 +00001476 bool &ResultBool,
1477 bool AllowLabels) {
Richard Trieuc320c742012-07-23 20:21:35 +00001478 llvm::APSInt ResultInt;
Richard Smithb130fe72016-06-23 19:16:49 +00001479 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels))
Chris Lattner29911cc2011-02-28 00:18:40 +00001480 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001481
Chris Lattner29911cc2011-02-28 00:18:40 +00001482 ResultBool = ResultInt.getBoolValue();
1483 return true;
1484}
1485
1486/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1487/// to a constant, or if it does but contains a label, return false. If it
1488/// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00001489bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1490 llvm::APSInt &ResultInt,
1491 bool AllowLabels) {
Daniel Dunbarf32443c2008-11-12 22:37:10 +00001492 // FIXME: Rename and handle conversion of other evaluatable things
1493 // to bool.
Richard Smith5fab0c92011-12-28 19:48:30 +00001494 llvm::APSInt Int;
1495 if (!Cond->EvaluateAsInt(Int, getContext()))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001496 return false; // Not foldable, not integer or not fully evaluatable.
Richard Smith5fab0c92011-12-28 19:48:30 +00001497
Richard Smithb130fe72016-06-23 19:16:49 +00001498 if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001499 return false; // Contains a label.
Richard Smith5fab0c92011-12-28 19:48:30 +00001500
1501 ResultInt = Int;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001502 return true;
Chris Lattnercd439292008-11-12 08:04:58 +00001503}
1504
1505
Chris Lattner29911cc2011-02-28 00:18:40 +00001506
Chris Lattnercd439292008-11-12 08:04:58 +00001507/// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
1508/// statement) to the specified blocks. Based on the condition, this might try
1509/// to simplify the codegen of the conditional based on the branch.
1510///
1511void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
1512 llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00001513 llvm::BasicBlock *FalseBlock,
1514 uint64_t TrueCount) {
Peter Collingbourne91147592011-04-15 00:35:48 +00001515 Cond = Cond->IgnoreParens();
Mike Stump11289f42009-09-09 15:08:12 +00001516
Chris Lattnercd439292008-11-12 08:04:58 +00001517 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
Justin Bogneref512b92014-01-06 22:27:43 +00001518
Chris Lattnercd439292008-11-12 08:04:58 +00001519 // Handle X && Y in a condition.
John McCalle3027922010-08-25 11:45:40 +00001520 if (CondBOp->getOpcode() == BO_LAnd) {
Chris Lattnercd439292008-11-12 08:04:58 +00001521 // If we have "1 && X", simplify the code. "0 && X" would have constant
1522 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001523 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001524 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1525 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001526 // br(1 && X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001527 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001528 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1529 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001530 }
Mike Stump11289f42009-09-09 15:08:12 +00001531
Chris Lattnercd439292008-11-12 08:04:58 +00001532 // If we have "X && 1", simplify the code to use an uncond branch.
1533 // "X && 0" would have been constant folded to 0.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001534 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1535 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001536 // br(X && 1) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001537 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1538 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001539 }
Mike Stump11289f42009-09-09 15:08:12 +00001540
Chris Lattnercd439292008-11-12 08:04:58 +00001541 // Emit the LHS as a conditional. If the LHS conditional is false, we
1542 // want to jump to the FalseBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001543 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
Justin Bogneref512b92014-01-06 22:27:43 +00001544 // The counter tells us how often we evaluate RHS, and all of TrueCount
1545 // can be propagated to that branch.
Justin Bogner66242d62015-04-23 23:06:47 +00001546 uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
John McCallce1de612011-01-26 04:00:11 +00001547
1548 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001549 {
1550 ApplyDebugLocation DL(*this, Cond);
1551 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount);
1552 EmitBlock(LHSTrue);
1553 }
Mike Stump11289f42009-09-09 15:08:12 +00001554
Justin Bogner66242d62015-04-23 23:06:47 +00001555 incrementProfileCounter(CondBOp);
1556 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1557
Anders Carlsson60ddba62010-01-24 00:20:05 +00001558 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001559 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001560 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount);
John McCallce1de612011-01-26 04:00:11 +00001561 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001562
Chris Lattnercd439292008-11-12 08:04:58 +00001563 return;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001564 }
Michael Ilseman686240a2012-12-04 00:29:55 +00001565
Chris Lattner41c6ab52011-02-27 23:02:32 +00001566 if (CondBOp->getOpcode() == BO_LOr) {
Chris Lattnercd439292008-11-12 08:04:58 +00001567 // If we have "0 || X", simplify the code. "1 || X" would have constant
1568 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001569 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001570 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1571 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001572 // br(0 || X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001573 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001574 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1575 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001576 }
Mike Stump11289f42009-09-09 15:08:12 +00001577
Chris Lattnercd439292008-11-12 08:04:58 +00001578 // If we have "X || 0", simplify the code to use an uncond branch.
1579 // "X || 1" would have been constant folded to 1.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001580 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1581 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001582 // br(X || 0) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001583 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1584 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001585 }
Mike Stump11289f42009-09-09 15:08:12 +00001586
Chris Lattnercd439292008-11-12 08:04:58 +00001587 // Emit the LHS as a conditional. If the LHS conditional is true, we
1588 // want to jump to the TrueBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001589 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
Justin Bogneref512b92014-01-06 22:27:43 +00001590 // We have the count for entry to the RHS and for the whole expression
1591 // being true, so we can divy up True count between the short circuit and
1592 // the RHS.
Justin Bogner66242d62015-04-23 23:06:47 +00001593 uint64_t LHSCount =
1594 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
Justin Bogneref512b92014-01-06 22:27:43 +00001595 uint64_t RHSCount = TrueCount - LHSCount;
John McCallce1de612011-01-26 04:00:11 +00001596
1597 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001598 {
1599 ApplyDebugLocation DL(*this, Cond);
1600 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount);
1601 EmitBlock(LHSFalse);
1602 }
Mike Stump11289f42009-09-09 15:08:12 +00001603
Justin Bogner66242d62015-04-23 23:06:47 +00001604 incrementProfileCounter(CondBOp);
1605 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1606
Anders Carlsson60ddba62010-01-24 00:20:05 +00001607 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001608 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001609 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount);
1610
John McCallce1de612011-01-26 04:00:11 +00001611 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001612
Chris Lattnercd439292008-11-12 08:04:58 +00001613 return;
1614 }
Chris Lattnerd9537732008-11-12 08:13:36 +00001615 }
Mike Stump11289f42009-09-09 15:08:12 +00001616
Chris Lattnerd9537732008-11-12 08:13:36 +00001617 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
1618 // br(!x, t, f) -> br(x, f, t)
Justin Bogneref512b92014-01-06 22:27:43 +00001619 if (CondUOp->getOpcode() == UO_LNot) {
1620 // Negate the count.
Justin Bogner66242d62015-04-23 23:06:47 +00001621 uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
Justin Bogneref512b92014-01-06 22:27:43 +00001622 // Negate the condition and swap the destination blocks.
1623 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1624 FalseCount);
1625 }
Chris Lattnercd439292008-11-12 08:04:58 +00001626 }
Mike Stump11289f42009-09-09 15:08:12 +00001627
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001628 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
Eli Friedman248f8982012-02-14 03:54:45 +00001629 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
1630 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
1631 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001632
Eli Friedman248f8982012-02-14 03:54:45 +00001633 ConditionalEvaluation cond(*this);
Justin Bogner66242d62015-04-23 23:06:47 +00001634 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1635 getProfileCount(CondOp));
Justin Bogneref512b92014-01-06 22:27:43 +00001636
1637 // When computing PGO branch weights, we only know the overall count for
1638 // the true block. This code is essentially doing tail duplication of the
1639 // naive code-gen, introducing new edges for which counts are not
1640 // available. Divide the counts proportionally between the LHS and RHS of
1641 // the conditional operator.
1642 uint64_t LHSScaledTrueCount = 0;
1643 if (TrueCount) {
Justin Bogner66242d62015-04-23 23:06:47 +00001644 double LHSRatio =
1645 getProfileCount(CondOp) / (double)getCurrentProfileCount();
Justin Bogneref512b92014-01-06 22:27:43 +00001646 LHSScaledTrueCount = TrueCount * LHSRatio;
1647 }
John McCallce1de612011-01-26 04:00:11 +00001648
Eli Friedman248f8982012-02-14 03:54:45 +00001649 cond.begin(*this);
1650 EmitBlock(LHSBlock);
Justin Bogner66242d62015-04-23 23:06:47 +00001651 incrementProfileCounter(CondOp);
David Blaikie298720d2015-01-28 19:50:09 +00001652 {
1653 ApplyDebugLocation DL(*this, Cond);
1654 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1655 LHSScaledTrueCount);
1656 }
Eli Friedman248f8982012-02-14 03:54:45 +00001657 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001658
Eli Friedman248f8982012-02-14 03:54:45 +00001659 cond.begin(*this);
1660 EmitBlock(RHSBlock);
Justin Bogneref512b92014-01-06 22:27:43 +00001661 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1662 TrueCount - LHSScaledTrueCount);
Eli Friedman248f8982012-02-14 03:54:45 +00001663 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001664
Eli Friedman248f8982012-02-14 03:54:45 +00001665 return;
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001666 }
1667
Richard Smithea852322013-05-07 21:53:22 +00001668 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
1669 // Conditional operator handling can give us a throw expression as a
1670 // condition for a case like:
1671 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
1672 // Fold this to:
1673 // br(c, throw x, br(y, t, f))
1674 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
1675 return;
1676 }
1677
Sanjay Patela24296b2015-09-02 20:01:30 +00001678 // If the branch has a condition wrapped by __builtin_unpredictable,
1679 // create metadata that specifies that the branch is unpredictable.
1680 // Don't bother if not optimizing because that metadata would not be used.
1681 llvm::MDNode *Unpredictable = nullptr;
Sanjay Patel3fd323f2016-04-19 18:06:33 +00001682 auto *Call = dyn_cast<CallExpr>(Cond);
1683 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1684 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1685 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1686 llvm::MDBuilder MDHelper(getLLVMContext());
1687 Unpredictable = MDHelper.createUnpredictable();
Sanjay Patela24296b2015-09-02 20:01:30 +00001688 }
1689 }
1690
Justin Bogneref512b92014-01-06 22:27:43 +00001691 // Create branch weights based on the number of times we get here and the
1692 // number of times the condition should be true.
Justin Bogner66242d62015-04-23 23:06:47 +00001693 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
Justin Bogner65512642015-05-02 05:00:55 +00001694 llvm::MDNode *Weights =
1695 createProfileWeights(TrueCount, CurrentCount - TrueCount);
Justin Bogneref512b92014-01-06 22:27:43 +00001696
Chris Lattnercd439292008-11-12 08:04:58 +00001697 // Emit the code with the fully general case.
David Blaikie303facb2015-01-31 01:10:11 +00001698 llvm::Value *CondV;
1699 {
1700 ApplyDebugLocation DL(*this, Cond);
1701 CondV = EvaluateExprAsBool(Cond);
1702 }
Sanjay Patela24296b2015-09-02 20:01:30 +00001703 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
Chris Lattnercd439292008-11-12 08:04:58 +00001704}
1705
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001706/// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001707/// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001708void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
1709 CGM.ErrorUnsupported(S, Type);
Chris Lattnerfc944342007-12-02 01:43:38 +00001710}
1711
John McCall2725aa12011-02-01 21:35:06 +00001712/// emitNonZeroVLAInit - Emit the "zero" initialization of a
1713/// variable-length array whose elements have a non-zero bit-pattern.
1714///
James Dennettbe302452012-06-15 22:10:14 +00001715/// \param baseType the inner-most element type of the array
John McCall2725aa12011-02-01 21:35:06 +00001716/// \param src - a char* pointing to the bit-pattern for a single
1717/// base element of the array
1718/// \param sizeInChars - the total size of the VLA, in chars
John McCall2725aa12011-02-01 21:35:06 +00001719static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001720 Address dest, Address src,
John McCall2725aa12011-02-01 21:35:06 +00001721 llvm::Value *sizeInChars) {
John McCall2725aa12011-02-01 21:35:06 +00001722 CGBuilderTy &Builder = CGF.Builder;
1723
John McCall7f416cc2015-09-08 08:05:57 +00001724 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
John McCall2725aa12011-02-01 21:35:06 +00001725 llvm::Value *baseSizeInChars
John McCall7f416cc2015-09-08 08:05:57 +00001726 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
John McCall2725aa12011-02-01 21:35:06 +00001727
John McCall7f416cc2015-09-08 08:05:57 +00001728 Address begin =
1729 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1730 llvm::Value *end =
1731 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end");
John McCall2725aa12011-02-01 21:35:06 +00001732
1733 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
1734 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
1735 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
1736
1737 // Make a loop over the VLA. C99 guarantees that the VLA element
1738 // count must be nonzero.
1739 CGF.EmitBlock(loopBB);
1740
John McCall7f416cc2015-09-08 08:05:57 +00001741 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
1742 cur->addIncoming(begin.getPointer(), originBB);
1743
1744 CharUnits curAlign =
1745 dest.getAlignment().alignmentOfArrayElement(baseSize);
John McCall2725aa12011-02-01 21:35:06 +00001746
1747 // memcpy the individual element bit-pattern.
John McCall7f416cc2015-09-08 08:05:57 +00001748 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
John McCall2725aa12011-02-01 21:35:06 +00001749 /*volatile*/ false);
1750
1751 // Go to the next element.
John McCall7f416cc2015-09-08 08:05:57 +00001752 llvm::Value *next =
1753 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
John McCall2725aa12011-02-01 21:35:06 +00001754
1755 // Leave if that's the end of the VLA.
1756 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
1757 Builder.CreateCondBr(done, contBB, loopBB);
1758 cur->addIncoming(next, loopBB);
1759
1760 CGF.EmitBlock(contBB);
Michael Ilseman686240a2012-12-04 00:29:55 +00001761}
John McCall2725aa12011-02-01 21:35:06 +00001762
Anders Carlssonc0964b62010-05-22 17:35:42 +00001763void
John McCall7f416cc2015-09-08 08:05:57 +00001764CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001765 // Ignore empty classes in C++.
Richard Smith9c6890a2012-11-01 22:30:59 +00001766 if (getLangOpts().CPlusPlus) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001767 if (const RecordType *RT = Ty->getAs<RecordType>()) {
1768 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
1769 return;
1770 }
1771 }
John McCall7cd1d972010-08-07 08:21:30 +00001772
1773 // Cast the dest ptr to the appropriate i8 pointer type.
John McCall7f416cc2015-09-08 08:05:57 +00001774 if (DestPtr.getElementType() != Int8Ty)
1775 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001776
1777 // Get size and alignment info for this aggregate.
John McCall7f416cc2015-09-08 08:05:57 +00001778 CharUnits size = getContext().getTypeSizeInChars(Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001779
John McCalla08ffd22011-01-14 10:37:58 +00001780 llvm::Value *SizeVal;
John McCall2725aa12011-02-01 21:35:06 +00001781 const VariableArrayType *vla;
Mike Stump11289f42009-09-09 15:08:12 +00001782
John McCalla08ffd22011-01-14 10:37:58 +00001783 // Don't bother emitting a zero-byte memset.
John McCall7f416cc2015-09-08 08:05:57 +00001784 if (size.isZero()) {
John McCalla08ffd22011-01-14 10:37:58 +00001785 // But note that getTypeInfo returns 0 for a VLA.
1786 if (const VariableArrayType *vlaType =
1787 dyn_cast_or_null<VariableArrayType>(
1788 getContext().getAsArrayType(Ty))) {
Sander de Smalen891af03a2018-02-03 13:55:59 +00001789 auto VlaSize = getVLASize(vlaType);
1790 SizeVal = VlaSize.NumElts;
1791 CharUnits eltSize = getContext().getTypeSizeInChars(VlaSize.Type);
John McCall23c29fe2011-06-24 21:55:10 +00001792 if (!eltSize.isOne())
1793 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
John McCall2725aa12011-02-01 21:35:06 +00001794 vla = vlaType;
John McCalla08ffd22011-01-14 10:37:58 +00001795 } else {
1796 return;
1797 }
1798 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001799 SizeVal = CGM.getSize(size);
Craig Topper8a13c412014-05-21 05:09:00 +00001800 vla = nullptr;
John McCalla08ffd22011-01-14 10:37:58 +00001801 }
John McCall7cd1d972010-08-07 08:21:30 +00001802
1803 // If the type contains a pointer to data member we can't memset it to zero.
1804 // Instead, create a null constant and copy it to the destination.
John McCall2725aa12011-02-01 21:35:06 +00001805 // TODO: there are other patterns besides zero that we can usefully memset,
1806 // like -1, which happens to be the pattern used by member-pointers.
John McCall614dbdc2010-08-22 21:01:12 +00001807 if (!CGM.getTypes().isZeroInitializable(Ty)) {
John McCall2725aa12011-02-01 21:35:06 +00001808 // For a VLA, emit a single element, then splat that over the VLA.
1809 if (vla) Ty = getContext().getBaseElementType(vla);
John McCalla08ffd22011-01-14 10:37:58 +00001810
John McCall7cd1d972010-08-07 08:21:30 +00001811 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
1812
Michael Ilseman686240a2012-12-04 00:29:55 +00001813 llvm::GlobalVariable *NullVariable =
John McCall7cd1d972010-08-07 08:21:30 +00001814 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
Michael Ilseman686240a2012-12-04 00:29:55 +00001815 /*isConstant=*/true,
John McCall7cd1d972010-08-07 08:21:30 +00001816 llvm::GlobalVariable::PrivateLinkage,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001817 NullConstant, Twine());
John McCall7f416cc2015-09-08 08:05:57 +00001818 CharUnits NullAlign = DestPtr.getAlignment();
1819 NullVariable->setAlignment(NullAlign.getQuantity());
1820 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
1821 NullAlign);
John McCall7cd1d972010-08-07 08:21:30 +00001822
John McCall2725aa12011-02-01 21:35:06 +00001823 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
1824
John McCall7cd1d972010-08-07 08:21:30 +00001825 // Get and call the appropriate llvm.memcpy overload.
John McCall7f416cc2015-09-08 08:05:57 +00001826 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
John McCall7cd1d972010-08-07 08:21:30 +00001827 return;
Michael Ilseman686240a2012-12-04 00:29:55 +00001828 }
1829
John McCall7cd1d972010-08-07 08:21:30 +00001830 // Otherwise, just memset the whole thing to zero. This is legal
1831 // because in LLVM, all default initializers (other than the ones we just
1832 // handled above) are guaranteed to have a bit pattern of all zeros.
John McCall7f416cc2015-09-08 08:05:57 +00001833 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001834}
1835
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001836llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001837 // Make sure that there is a block for the indirect goto.
Craig Topper8a13c412014-05-21 05:09:00 +00001838 if (!IndirectBranch)
Chris Lattner6c4d2552009-10-28 23:59:40 +00001839 GetIndirectGotoBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001840
John McCallad5d61e2010-07-23 21:56:41 +00001841 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001842
Chris Lattner6c4d2552009-10-28 23:59:40 +00001843 // Make sure the indirect branch includes all of the address-taken blocks.
1844 IndirectBranch->addDestination(BB);
1845 return llvm::BlockAddress::get(CurFn, BB);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001846}
1847
1848llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001849 // If we already made the indirect branch for indirect goto, return its block.
1850 if (IndirectBranch) return IndirectBranch->getParent();
Michael Ilseman686240a2012-12-04 00:29:55 +00001851
John McCall7f416cc2015-09-08 08:05:57 +00001852 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
Michael Ilseman686240a2012-12-04 00:29:55 +00001853
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001854 // Create the PHI node that indirect gotos will add entries to.
Jay Foad20c0f022011-03-30 11:28:58 +00001855 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
1856 "indirect.goto.dest");
Michael Ilseman686240a2012-12-04 00:29:55 +00001857
Chris Lattner6c4d2552009-10-28 23:59:40 +00001858 // Create the indirect branch instruction.
1859 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
1860 return IndirectBranch->getParent();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001861}
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001862
John McCall82fe67b2011-07-09 01:37:26 +00001863/// Computes the length of an array in elements, as well as the base
1864/// element type and a properly-typed first element pointer.
1865llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1866 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001867 Address &addr) {
John McCall82fe67b2011-07-09 01:37:26 +00001868 const ArrayType *arrayType = origArrayType;
1869
1870 // If it's a VLA, we have to load the stored size. Note that
1871 // this is the size of the VLA in bytes, not its size in elements.
Craig Topper8a13c412014-05-21 05:09:00 +00001872 llvm::Value *numVLAElements = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001873 if (isa<VariableArrayType>(arrayType)) {
Sander de Smalen891af03a2018-02-03 13:55:59 +00001874 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).NumElts;
John McCall82fe67b2011-07-09 01:37:26 +00001875
1876 // Walk into all VLAs. This doesn't require changes to addr,
1877 // which has type T* where T is the first non-VLA element type.
1878 do {
1879 QualType elementType = arrayType->getElementType();
1880 arrayType = getContext().getAsArrayType(elementType);
1881
1882 // If we only have VLA components, 'addr' requires no adjustment.
1883 if (!arrayType) {
1884 baseType = elementType;
1885 return numVLAElements;
1886 }
1887 } while (isa<VariableArrayType>(arrayType));
1888
1889 // We get out here only if we find a constant array type
1890 // inside the VLA.
1891 }
1892
1893 // We have some number of constant-length arrays, so addr should
1894 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks
1895 // down to the first element of addr.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001896 SmallVector<llvm::Value*, 8> gepIndices;
John McCall82fe67b2011-07-09 01:37:26 +00001897
1898 // GEP down to the array type.
1899 llvm::ConstantInt *zero = Builder.getInt32(0);
1900 gepIndices.push_back(zero);
1901
John McCall82fe67b2011-07-09 01:37:26 +00001902 uint64_t countFromCLAs = 1;
Richard Smithf3c37e82012-04-22 05:51:36 +00001903 QualType eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001904
Chris Lattner2192fe52011-07-18 04:24:23 +00001905 llvm::ArrayType *llvmArrayType =
John McCall7f416cc2015-09-08 08:05:57 +00001906 dyn_cast<llvm::ArrayType>(addr.getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001907 while (llvmArrayType) {
John McCall82fe67b2011-07-09 01:37:26 +00001908 assert(isa<ConstantArrayType>(arrayType));
1909 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1910 == llvmArrayType->getNumElements());
1911
1912 gepIndices.push_back(zero);
1913 countFromCLAs *= llvmArrayType->getNumElements();
Richard Smithf3c37e82012-04-22 05:51:36 +00001914 eltType = arrayType->getElementType();
John McCall82fe67b2011-07-09 01:37:26 +00001915
1916 llvmArrayType =
1917 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
John McCall82fe67b2011-07-09 01:37:26 +00001918 arrayType = getContext().getAsArrayType(arrayType->getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001919 assert((!llvmArrayType || arrayType) &&
1920 "LLVM and Clang types are out-of-synch");
John McCall82fe67b2011-07-09 01:37:26 +00001921 }
1922
Richard Smithf3c37e82012-04-22 05:51:36 +00001923 if (arrayType) {
1924 // From this point onwards, the Clang array type has been emitted
1925 // as some other type (probably a packed struct). Compute the array
1926 // size, and just emit the 'begin' expression as a bitcast.
1927 while (arrayType) {
1928 countFromCLAs *=
1929 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1930 eltType = arrayType->getElementType();
1931 arrayType = getContext().getAsArrayType(eltType);
1932 }
John McCall82fe67b2011-07-09 01:37:26 +00001933
John McCall7f416cc2015-09-08 08:05:57 +00001934 llvm::Type *baseType = ConvertType(eltType);
1935 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
Richard Smithf3c37e82012-04-22 05:51:36 +00001936 } else {
1937 // Create the actual GEP.
John McCall7f416cc2015-09-08 08:05:57 +00001938 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(),
1939 gepIndices, "array.begin"),
1940 addr.getAlignment());
Richard Smithf3c37e82012-04-22 05:51:36 +00001941 }
1942
1943 baseType = eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001944
1945 llvm::Value *numElements
1946 = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1947
1948 // If we had any VLA dimensions, factor them in.
1949 if (numVLAElements)
1950 numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1951
1952 return numElements;
1953}
1954
Sander de Smalen891af03a2018-02-03 13:55:59 +00001955CodeGenFunction::VlaSizePair CodeGenFunction::getVLASize(QualType type) {
John McCall23c29fe2011-06-24 21:55:10 +00001956 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1957 assert(vla && "type was not a variable array type!");
1958 return getVLASize(vla);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001959}
Anders Carlssonccbe9202008-12-12 07:19:02 +00001960
Sander de Smalen891af03a2018-02-03 13:55:59 +00001961CodeGenFunction::VlaSizePair
John McCall23c29fe2011-06-24 21:55:10 +00001962CodeGenFunction::getVLASize(const VariableArrayType *type) {
1963 // The number of elements so far; always size_t.
Craig Topper8a13c412014-05-21 05:09:00 +00001964 llvm::Value *numElements = nullptr;
John McCall23c29fe2011-06-24 21:55:10 +00001965
1966 QualType elementType;
1967 do {
1968 elementType = type->getElementType();
1969 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1970 assert(vlaSize && "no size for VLA!");
1971 assert(vlaSize->getType() == SizeTy);
1972
1973 if (!numElements) {
1974 numElements = vlaSize;
1975 } else {
1976 // It's undefined behavior if this wraps around, so mark it that way.
Alexey Samsonovcb3f8122014-03-20 10:48:29 +00001977 // FIXME: Teach -fsanitize=undefined to trap this.
John McCall23c29fe2011-06-24 21:55:10 +00001978 numElements = Builder.CreateNUWMul(numElements, vlaSize);
1979 }
1980 } while ((type = getContext().getAsVariableArrayType(elementType)));
1981
Sander de Smalen891af03a2018-02-03 13:55:59 +00001982 return { numElements, elementType };
1983}
1984
1985CodeGenFunction::VlaSizePair
1986CodeGenFunction::getVLAElements1D(QualType type) {
1987 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1988 assert(vla && "type was not a variable array type!");
1989 return getVLAElements1D(vla);
1990}
1991
1992CodeGenFunction::VlaSizePair
1993CodeGenFunction::getVLAElements1D(const VariableArrayType *Vla) {
1994 llvm::Value *VlaSize = VLASizeMap[Vla->getSizeExpr()];
1995 assert(VlaSize && "no size for VLA!");
1996 assert(VlaSize->getType() == SizeTy);
1997 return { VlaSize, Vla->getElementType() };
John McCall23c29fe2011-06-24 21:55:10 +00001998}
1999
2000void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
2001 assert(type->isVariablyModifiedType() &&
Anders Carlsson8a01b792008-12-20 20:46:34 +00002002 "Must pass variably modified type to EmitVLASizes!");
Mike Stump11289f42009-09-09 15:08:12 +00002003
Daniel Dunbarb6adc432009-07-19 06:58:07 +00002004 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00002005
John McCall23c29fe2011-06-24 21:55:10 +00002006 // We're going to walk down into the type and look for VLA
2007 // expressions.
John McCall23c29fe2011-06-24 21:55:10 +00002008 do {
2009 assert(type->isVariablyModifiedType());
Mike Stump11289f42009-09-09 15:08:12 +00002010
John McCall23c29fe2011-06-24 21:55:10 +00002011 const Type *ty = type.getTypePtr();
2012 switch (ty->getTypeClass()) {
Abramo Bagnara1cd83682012-01-07 10:52:36 +00002013
John McCall23c29fe2011-06-24 21:55:10 +00002014#define TYPE(Class, Base)
2015#define ABSTRACT_TYPE(Class, Base)
Abramo Bagnara1cd83682012-01-07 10:52:36 +00002016#define NON_CANONICAL_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00002017#define DEPENDENT_TYPE(Class, Base) case Type::Class:
Abramo Bagnara1cd83682012-01-07 10:52:36 +00002018#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00002019#include "clang/AST/TypeNodes.def"
Abramo Bagnara1cd83682012-01-07 10:52:36 +00002020 llvm_unreachable("unexpected dependent type!");
Mike Stump11289f42009-09-09 15:08:12 +00002021
John McCall23c29fe2011-06-24 21:55:10 +00002022 // These types are never variably-modified.
2023 case Type::Builtin:
2024 case Type::Complex:
2025 case Type::Vector:
2026 case Type::ExtVector:
2027 case Type::Record:
2028 case Type::Enum:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002029 case Type::Elaborated:
2030 case Type::TemplateSpecialization:
Manman Rene6be26c2016-09-13 17:25:08 +00002031 case Type::ObjCTypeParam:
John McCall23c29fe2011-06-24 21:55:10 +00002032 case Type::ObjCObject:
2033 case Type::ObjCInterface:
2034 case Type::ObjCObjectPointer:
2035 llvm_unreachable("type class is never variably-modified!");
Mike Stump11289f42009-09-09 15:08:12 +00002036
Reid Kleckner0503a872013-12-05 01:23:43 +00002037 case Type::Adjusted:
2038 type = cast<AdjustedType>(ty)->getAdjustedType();
2039 break;
2040
Reid Kleckner8a365022013-06-24 17:51:48 +00002041 case Type::Decayed:
2042 type = cast<DecayedType>(ty)->getPointeeType();
2043 break;
2044
John McCall23c29fe2011-06-24 21:55:10 +00002045 case Type::Pointer:
2046 type = cast<PointerType>(ty)->getPointeeType();
2047 break;
Mike Stump11289f42009-09-09 15:08:12 +00002048
John McCall23c29fe2011-06-24 21:55:10 +00002049 case Type::BlockPointer:
2050 type = cast<BlockPointerType>(ty)->getPointeeType();
2051 break;
2052
2053 case Type::LValueReference:
2054 case Type::RValueReference:
2055 type = cast<ReferenceType>(ty)->getPointeeType();
2056 break;
2057
2058 case Type::MemberPointer:
2059 type = cast<MemberPointerType>(ty)->getPointeeType();
2060 break;
2061
2062 case Type::ConstantArray:
2063 case Type::IncompleteArray:
2064 // Losing element qualification here is fine.
2065 type = cast<ArrayType>(ty)->getElementType();
2066 break;
2067
2068 case Type::VariableArray: {
2069 // Losing element qualification here is fine.
2070 const VariableArrayType *vat = cast<VariableArrayType>(ty);
2071
2072 // Unknown size indication requires no size computation.
2073 // Otherwise, evaluate and record it.
2074 if (const Expr *size = vat->getSizeExpr()) {
2075 // It's possible that we might have emitted this already,
2076 // e.g. with a typedef and a pointer to it.
2077 llvm::Value *&entry = VLASizeMap[size];
2078 if (!entry) {
Richard Smith481652b2012-10-10 01:11:12 +00002079 llvm::Value *Size = EmitScalarExpr(size);
2080
2081 // C11 6.7.6.2p5:
2082 // If the size is an expression that is not an integer constant
2083 // expression [...] each time it is evaluated it shall have a value
2084 // greater than zero.
Alexey Samsonovedf99a92014-11-07 22:29:38 +00002085 if (SanOpts.has(SanitizerKind::VLABound) &&
Richard Smithb1b0ab42012-11-05 22:21:05 +00002086 size->getType()->isSignedIntegerType()) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00002087 SanitizerScope SanScope(this);
Richard Smith481652b2012-10-10 01:11:12 +00002088 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
2089 llvm::Constant *StaticArgs[] = {
2090 EmitCheckSourceLocation(size->getLocStart()),
2091 EmitCheckTypeDescriptor(size->getType())
2092 };
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002093 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
2094 SanitizerKind::VLABound),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00002095 SanitizerHandler::VLABoundNotPositive, StaticArgs, Size);
Richard Smith481652b2012-10-10 01:11:12 +00002096 }
2097
John McCall23c29fe2011-06-24 21:55:10 +00002098 // Always zexting here would be wrong if it weren't
2099 // undefined behavior to have a negative bound.
Richard Smith8772bd82012-10-10 01:12:11 +00002100 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
John McCall23c29fe2011-06-24 21:55:10 +00002101 }
2102 }
2103 type = vat->getElementType();
2104 break;
Anders Carlsson8a01b792008-12-20 20:46:34 +00002105 }
Mike Stump11289f42009-09-09 15:08:12 +00002106
Abramo Bagnara1cd83682012-01-07 10:52:36 +00002107 case Type::FunctionProto:
John McCall23c29fe2011-06-24 21:55:10 +00002108 case Type::FunctionNoProto:
Alp Toker314cc812014-01-25 16:55:45 +00002109 type = cast<FunctionType>(ty)->getReturnType();
John McCall23c29fe2011-06-24 21:55:10 +00002110 break;
Eli Friedman0dfb8892011-10-06 23:00:33 +00002111
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002112 case Type::Paren:
2113 case Type::TypeOf:
2114 case Type::UnaryTransform:
2115 case Type::Attributed:
2116 case Type::SubstTemplateTypeParm:
David Blaikie66ed89d2013-07-13 21:08:08 +00002117 case Type::PackExpansion:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002118 // Keep walking after single level desugaring.
2119 type = type.getSingleStepDesugaredType(getContext());
2120 break;
2121
2122 case Type::Typedef:
2123 case Type::Decltype:
2124 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00002125 case Type::DeducedTemplateSpecialization:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002126 // Stop walking: nothing to do.
2127 return;
2128
2129 case Type::TypeOfExpr:
2130 // Stop walking: emit typeof expression.
2131 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
2132 return;
2133
Eli Friedman0dfb8892011-10-06 23:00:33 +00002134 case Type::Atomic:
2135 type = cast<AtomicType>(ty)->getValueType();
2136 break;
Xiuli Pan9c14e282016-01-09 12:53:17 +00002137
2138 case Type::Pipe:
2139 type = cast<PipeType>(ty)->getElementType();
2140 break;
John McCall23c29fe2011-06-24 21:55:10 +00002141 }
2142 } while (type->isVariablyModifiedType());
Anders Carlssonccbe9202008-12-12 07:19:02 +00002143}
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002144
John McCall7f416cc2015-09-08 08:05:57 +00002145Address CodeGenFunction::EmitVAListRef(const Expr* E) {
Dan Gohmane9e32dc2010-10-29 22:47:07 +00002146 if (getContext().getBuiltinVaListType()->isArrayType())
John McCall7f416cc2015-09-08 08:05:57 +00002147 return EmitPointerWithAlignment(E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002148 return EmitLValue(E).getAddress();
2149}
Anders Carlsson15cb75a2009-02-07 22:53:43 +00002150
Charles Davisc7d5c942015-09-17 20:55:33 +00002151Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
2152 return EmitLValue(E).getAddress();
2153}
2154
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002155void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002156 const APValue &Init) {
2157 assert(!Init.isUninit() && "Invalid DeclRefExpr initializer!");
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002158 if (CGDebugInfo *Dbg = getDebugInfo())
Benjamin Kramer8c305922016-02-02 11:06:51 +00002159 if (CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002160 Dbg->EmitGlobalVariable(E->getDecl(), Init);
Devang Patele03edfd2010-08-10 07:24:25 +00002161}
John McCallc07a0c72011-02-17 10:25:35 +00002162
2163CodeGenFunction::PeepholeProtection
2164CodeGenFunction::protectFromPeepholes(RValue rvalue) {
2165 // At the moment, the only aggressive peephole we do in IR gen
2166 // is trunc(zext) folding, but if we add more, we can easily
2167 // extend this protection.
2168
2169 if (!rvalue.isScalar()) return PeepholeProtection();
2170 llvm::Value *value = rvalue.getScalarVal();
2171 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
2172
2173 // Just make an extra bitcast.
2174 assert(HaveInsertPoint());
2175 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
2176 Builder.GetInsertBlock());
2177
2178 PeepholeProtection protection;
2179 protection.Inst = inst;
2180 return protection;
2181}
2182
2183void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
2184 if (!protection.Inst) return;
2185
2186 // In theory, we could try to duplicate the peepholes now, but whatever.
2187 protection.Inst->eraseFromParent();
2188}
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002189
2190llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Value *AnnotationFn,
2191 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002192 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002193 SourceLocation Location) {
2194 llvm::Value *Args[4] = {
2195 AnnotatedVal,
2196 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
2197 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
2198 CGM.EmitAnnotationLineNo(Location)
2199 };
2200 return Builder.CreateCall(AnnotationFn, Args);
2201}
2202
2203void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
2204 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2205 // FIXME We create a new bitcast for every annotation because that's what
2206 // llvm-gcc was doing.
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002207 for (const auto *I : D->specific_attrs<AnnotateAttr>())
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002208 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
2209 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002210 I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002211}
2212
John McCall7f416cc2015-09-08 08:05:57 +00002213Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
2214 Address Addr) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002215 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
John McCall7f416cc2015-09-08 08:05:57 +00002216 llvm::Value *V = Addr.getPointer();
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002217 llvm::Type *VTy = V->getType();
2218 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
2219 CGM.Int8PtrTy);
2220
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002221 for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002222 // FIXME Always emit the cast inst so we can differentiate between
2223 // annotation on the first field of a struct and annotation on the struct
2224 // itself.
2225 if (VTy != CGM.Int8PtrTy)
2226 V = Builder.Insert(new llvm::BitCastInst(V, CGM.Int8PtrTy));
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002227 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002228 V = Builder.CreateBitCast(V, VTy);
2229 }
2230
John McCall7f416cc2015-09-08 08:05:57 +00002231 return Address(V, Addr.getAlignment());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002232}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002233
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00002234CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
Alexander Musman515ad8c2014-05-22 08:54:05 +00002235
Alexey Samsonov24cad992014-07-17 18:46:27 +00002236CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
2237 : CGF(CGF) {
2238 assert(!CGF->IsSanitizerScope);
2239 CGF->IsSanitizerScope = true;
2240}
2241
2242CodeGenFunction::SanitizerScope::~SanitizerScope() {
2243 CGF->IsSanitizerScope = false;
2244}
2245
Alexander Musman515ad8c2014-05-22 08:54:05 +00002246void CodeGenFunction::InsertHelper(llvm::Instruction *I,
2247 const llvm::Twine &Name,
2248 llvm::BasicBlock *BB,
2249 llvm::BasicBlock::iterator InsertPt) const {
2250 LoopStack.InsertHelper(I);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00002251 if (IsSanitizerScope)
2252 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002253}
2254
Mehdi Amini557c20a2016-03-13 21:05:23 +00002255void CGBuilderInserter::InsertHelper(
Alexander Musman515ad8c2014-05-22 08:54:05 +00002256 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
2257 llvm::BasicBlock::iterator InsertPt) const {
Mehdi Amini557c20a2016-03-13 21:05:23 +00002258 llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002259 if (CGF)
2260 CGF->InsertHelper(I, Name, BB, InsertPt);
2261}
2262
David Blaikie5df253382015-11-12 01:09:58 +00002263static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures,
Eric Christopherce836772015-11-14 02:38:37 +00002264 CodeGenModule &CGM, const FunctionDecl *FD,
2265 std::string &FirstMissing) {
David Blaikie5df253382015-11-12 01:09:58 +00002266 // If there aren't any required features listed then go ahead and return.
2267 if (ReqFeatures.empty())
2268 return false;
2269
2270 // Now build up the set of caller features and verify that all the required
2271 // features are there.
2272 llvm::StringMap<bool> CallerFeatureMap;
2273 CGM.getFunctionFeatureMap(CallerFeatureMap, FD);
2274
2275 // If we have at least one of the features in the feature list return
2276 // true, otherwise return false.
2277 return std::all_of(
2278 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) {
2279 SmallVector<StringRef, 1> OrFeatures;
2280 Feature.split(OrFeatures, "|");
2281 return std::any_of(OrFeatures.begin(), OrFeatures.end(),
2282 [&](StringRef Feature) {
Eric Christopherce836772015-11-14 02:38:37 +00002283 if (!CallerFeatureMap.lookup(Feature)) {
2284 FirstMissing = Feature.str();
2285 return false;
2286 }
2287 return true;
David Blaikie5df253382015-11-12 01:09:58 +00002288 });
2289 });
2290}
2291
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002292// Emits an error if we don't have a valid set of target features for the
2293// called function.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002294void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
2295 const FunctionDecl *TargetDecl) {
2296 // Early exit if this is an indirect call.
2297 if (!TargetDecl)
2298 return;
2299
2300 // Get the current enclosing function if it exists. If it doesn't
2301 // we can't check the target features anyhow.
2302 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl);
2303 if (!FD)
2304 return;
2305
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002306 // Grab the required features for the call. For a builtin this is listed in
2307 // the td file with the default cpu, for an always_inline function this is any
2308 // listed cpu and any listed features.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002309 unsigned BuiltinID = TargetDecl->getBuiltinID();
Eric Christopherce836772015-11-14 02:38:37 +00002310 std::string MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002311 if (BuiltinID) {
2312 SmallVector<StringRef, 1> ReqFeatures;
2313 const char *FeatureList =
2314 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2315 // Return if the builtin doesn't have any required features.
2316 if (!FeatureList || StringRef(FeatureList) == "")
2317 return;
2318 StringRef(FeatureList).split(ReqFeatures, ",");
Eric Christopherce836772015-11-14 02:38:37 +00002319 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002320 CGM.getDiags().Report(E->getLocStart(), diag::err_builtin_needs_feature)
2321 << TargetDecl->getDeclName()
2322 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2323
2324 } else if (TargetDecl->hasAttr<TargetAttr>()) {
2325 // Get the required features for the callee.
2326 SmallVector<StringRef, 1> ReqFeatures;
2327 llvm::StringMap<bool> CalleeFeatureMap;
2328 CGM.getFunctionFeatureMap(CalleeFeatureMap, TargetDecl);
Eric Christopherb7bbc532015-11-16 18:29:59 +00002329 for (const auto &F : CalleeFeatureMap) {
2330 // Only positive features are "required".
2331 if (F.getValue())
2332 ReqFeatures.push_back(F.getKey());
2333 }
Eric Christopherce836772015-11-14 02:38:37 +00002334 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002335 CGM.getDiags().Report(E->getLocStart(), diag::err_function_needs_feature)
Eric Christopherce836772015-11-14 02:38:37 +00002336 << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002337 }
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002338}
Peter Collingbournedc134532016-01-16 00:31:22 +00002339
2340void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) {
2341 if (!CGM.getCodeGenOpts().SanitizeStats)
2342 return;
2343
2344 llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint());
2345 IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation());
2346 CGM.getSanStats().create(IRB, SSK);
2347}
Amara Emerson652795d2016-11-10 14:44:30 +00002348
Erich Keane281d20b2018-01-08 21:34:17 +00002349llvm::Value *
2350CodeGenFunction::FormResolverCondition(const MultiVersionResolverOption &RO) {
2351 llvm::Value *TrueCondition = nullptr;
2352 if (!RO.ParsedAttribute.Architecture.empty())
2353 TrueCondition = EmitX86CpuIs(RO.ParsedAttribute.Architecture);
2354
2355 if (!RO.ParsedAttribute.Features.empty()) {
2356 SmallVector<StringRef, 8> FeatureList;
2357 llvm::for_each(RO.ParsedAttribute.Features,
2358 [&FeatureList](const std::string &Feature) {
2359 FeatureList.push_back(StringRef{Feature}.substr(1));
2360 });
2361 llvm::Value *FeatureCmp = EmitX86CpuSupports(FeatureList);
2362 TrueCondition = TrueCondition ? Builder.CreateAnd(TrueCondition, FeatureCmp)
2363 : FeatureCmp;
2364 }
2365 return TrueCondition;
2366}
2367
2368void CodeGenFunction::EmitMultiVersionResolver(
2369 llvm::Function *Resolver, ArrayRef<MultiVersionResolverOption> Options) {
2370 assert((getContext().getTargetInfo().getTriple().getArch() ==
2371 llvm::Triple::x86 ||
2372 getContext().getTargetInfo().getTriple().getArch() ==
2373 llvm::Triple::x86_64) &&
2374 "Only implemented for x86 targets");
2375
2376 // Main function's basic block.
2377 llvm::BasicBlock *CurBlock = createBasicBlock("entry", Resolver);
2378 Builder.SetInsertPoint(CurBlock);
2379 EmitX86CpuInit();
2380
2381 llvm::Function *DefaultFunc = nullptr;
2382 for (const MultiVersionResolverOption &RO : Options) {
2383 Builder.SetInsertPoint(CurBlock);
2384 llvm::Value *TrueCondition = FormResolverCondition(RO);
2385
2386 if (!TrueCondition) {
2387 DefaultFunc = RO.Function;
2388 } else {
2389 llvm::BasicBlock *RetBlock = createBasicBlock("ro_ret", Resolver);
2390 llvm::IRBuilder<> RetBuilder(RetBlock);
2391 RetBuilder.CreateRet(RO.Function);
2392 CurBlock = createBasicBlock("ro_else", Resolver);
2393 Builder.CreateCondBr(TrueCondition, RetBlock, CurBlock);
2394 }
2395 }
2396
2397 assert(DefaultFunc && "No default version?");
2398 // Emit return from the 'else-ist' block.
2399 Builder.SetInsertPoint(CurBlock);
2400 Builder.CreateRet(DefaultFunc);
2401}
2402
Amara Emerson652795d2016-11-10 14:44:30 +00002403llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) {
2404 if (CGDebugInfo *DI = getDebugInfo())
2405 return DI->SourceLocToDebugLoc(Location);
2406
2407 return llvm::DebugLoc();
2408}