blob: a9a1a53be20b1539150a6ebce5e2fd42cda9a5e5 [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"
36#include "llvm/IR/Intrinsics.h"
37#include "llvm/IR/MDBuilder.h"
38#include "llvm/IR/Operator.h"
Chris Lattnerbed31442007-05-28 01:07:47 +000039using namespace clang;
40using namespace CodeGen;
41
Vitaly Buka1c943322016-10-26 01:59:57 +000042/// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time
43/// markers.
44static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts,
45 const LangOptions &LangOpts) {
Mehdi Amini7f873072017-01-06 23:18:09 +000046 if (CGOpts.DisableLifetimeMarkers)
47 return false;
48
Vitaly Buka1c943322016-10-26 01:59:57 +000049 // Disable lifetime markers in msan builds.
50 // FIXME: Remove this when msan works with lifetime markers.
51 if (LangOpts.Sanitize.has(SanitizerKind::Memory))
52 return false;
53
Benjamin Kramer2a7d39d2017-03-31 09:19:25 +000054 // Asan uses markers for use-after-scope checks.
55 if (CGOpts.SanitizeAddressUseAfterScope)
56 return true;
57
Vitaly Buka1c943322016-10-26 01:59:57 +000058 // For now, only in optimized builds.
59 return CGOpts.OptimizationLevel != 0;
60}
61
Fariborz Jahanian63628032012-06-26 16:06:38 +000062CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext)
David Blaikie92848de2013-08-26 20:33:21 +000063 : CodeGenTypeCache(cgm), CGM(cgm), Target(cgm.getTarget()),
John McCall7f416cc2015-09-08 08:05:57 +000064 Builder(cgm, cgm.getModule().getContext(), llvm::ConstantFolder(),
David Blaikie8e90d222014-10-14 17:09:38 +000065 CGBuilderInserterTy(this)),
John McCall7f416cc2015-09-08 08:05:57 +000066 CurFn(nullptr), ReturnValue(Address::invalid()),
Vitaly Buka1c943322016-10-26 01:59:57 +000067 CapturedStmtInfo(nullptr), SanOpts(CGM.getLangOpts().Sanitize),
68 IsSanitizerScope(false), CurFuncIsThunk(false), AutoreleaseResult(false),
69 SawAsmBlock(false), IsOutlinedSEHHelper(false), BlockInfo(nullptr),
70 BlockPointer(nullptr), LambdaThisCaptureField(nullptr),
71 NormalCleanupDest(nullptr), NextCleanupDestIndex(1),
72 FirstBlockInfo(nullptr), EHResumeBlock(nullptr), ExceptionSlot(nullptr),
73 EHSelectorSlot(nullptr), DebugInfo(CGM.getModuleDebugInfo()),
Reid Kleckner9fe7f232015-07-07 00:36:30 +000074 DisableDebugInfo(false), DidCallStackSave(false), IndirectBranch(nullptr),
75 PGO(cgm), SwitchInsn(nullptr), SwitchWeights(nullptr),
76 CaseRangeBlock(nullptr), UnreachableBlock(nullptr), NumReturnExprs(0),
77 NumSimpleReturnExprs(0), CXXABIThisDecl(nullptr),
78 CXXABIThisValue(nullptr), CXXThisValue(nullptr),
John McCall7f416cc2015-09-08 08:05:57 +000079 CXXStructorImplicitParamDecl(nullptr),
Craig Topper8a13c412014-05-21 05:09:00 +000080 CXXStructorImplicitParamValue(nullptr), OutermostConditional(nullptr),
81 CurLexicalScope(nullptr), TerminateLandingPad(nullptr),
Vitaly Buka1c943322016-10-26 01:59:57 +000082 TerminateHandler(nullptr), TrapBB(nullptr),
83 ShouldEmitLifetimeMarkers(
84 shouldEmitLifetimeMarkers(CGM.getCodeGenOpts(), CGM.getLangOpts())) {
Fariborz Jahanian63628032012-06-26 16:06:38 +000085 if (!suppressNewContext)
86 CGM.getCXXABI().getMangleContext().startNewFunction();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000087
88 llvm::FastMathFlags FMF;
89 if (CGM.getLangOpts().FastMath)
Benjamin Kramer7464efc2012-12-09 21:58:24 +000090 FMF.setUnsafeAlgebra();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000091 if (CGM.getLangOpts().FiniteMathOnly) {
Benjamin Kramer7464efc2012-12-09 21:58:24 +000092 FMF.setNoNaNs();
93 FMF.setNoInfs();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000094 }
Pekka Jaaskelainen37014502014-12-10 16:41:14 +000095 if (CGM.getCodeGenOpts().NoNaNsFPMath) {
96 FMF.setNoNaNs();
97 }
98 if (CGM.getCodeGenOpts().NoSignedZeros) {
99 FMF.setNoSignedZeros();
100 }
Sanjay Patel359b1052015-04-09 15:03:23 +0000101 if (CGM.getCodeGenOpts().ReciprocalMath) {
102 FMF.setAllowReciprocal();
103 }
Sanjay Pateld61f3c72016-01-12 18:03:41 +0000104 Builder.setFastMathFlags(FMF);
Chris Lattner5696e7b2008-06-17 18:05:57 +0000105}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000106
John McCall08ef4662011-11-10 08:15:53 +0000107CodeGenFunction::~CodeGenFunction() {
Richard Smith736a9472013-06-12 20:42:33 +0000108 assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup");
109
John McCall08ef4662011-11-10 08:15:53 +0000110 // If there are any unclaimed block infos, go ahead and destroy them
111 // now. This can happen if IR-gen gets clever and skips evaluating
112 // something.
113 if (FirstBlockInfo)
114 destroyBlockInfos(FirstBlockInfo);
Alexey Bataev9959db52014-05-06 10:08:46 +0000115
Alexey Bataev880d8602017-01-20 08:57:28 +0000116 if (getLangOpts().OpenMP && CurFn)
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000117 CGM.getOpenMPRuntime().functionFinished(*this);
John McCall08ef4662011-11-10 08:15:53 +0000118}
119
John McCall7f416cc2015-09-08 08:05:57 +0000120CharUnits CodeGenFunction::getNaturalPointeeTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000121 LValueBaseInfo *BaseInfo) {
122 return getNaturalTypeAlignment(T->getPointeeType(), BaseInfo,
John McCall7f416cc2015-09-08 08:05:57 +0000123 /*forPointee*/ true);
David Majnemer99281062014-09-18 22:05:54 +0000124}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000125
John McCall7f416cc2015-09-08 08:05:57 +0000126CharUnits CodeGenFunction::getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000127 LValueBaseInfo *BaseInfo,
John McCall7f416cc2015-09-08 08:05:57 +0000128 bool forPointeeType) {
129 // Honor alignment typedef attributes even on incomplete types.
130 // We also honor them straight for C++ class types, even as pointees;
131 // there's an expressivity gap here.
132 if (auto TT = T->getAs<TypedefType>()) {
133 if (auto Align = TT->getDecl()->getMaxAlignment()) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000134 if (BaseInfo)
135 *BaseInfo = LValueBaseInfo(AlignmentSource::AttributedType, false);
John McCall7f416cc2015-09-08 08:05:57 +0000136 return getContext().toCharUnitsFromBits(Align);
137 }
138 }
139
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000140 if (BaseInfo)
141 *BaseInfo = LValueBaseInfo(AlignmentSource::Type, false);
John McCall7f416cc2015-09-08 08:05:57 +0000142
143 CharUnits Alignment;
David Majnemer9df56372015-09-10 21:52:00 +0000144 if (T->isIncompleteType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000145 Alignment = CharUnits::One(); // Shouldn't be used, but pessimistic is best.
146 } else {
147 // For C++ class pointees, we don't know whether we're pointing at a
148 // base or a complete object, so we generally need to use the
149 // non-virtual alignment.
150 const CXXRecordDecl *RD;
151 if (forPointeeType && (RD = T->getAsCXXRecordDecl())) {
152 Alignment = CGM.getClassPointerAlignment(RD);
153 } else {
154 Alignment = getContext().getTypeAlignInChars(T);
Roger Ferrer Ibanez3fa38a12017-03-08 14:00:44 +0000155 if (T.getQualifiers().hasUnaligned())
156 Alignment = CharUnits::One();
John McCall7f416cc2015-09-08 08:05:57 +0000157 }
158
159 // Cap to the global maximum type alignment unless the alignment
160 // was somehow explicit on the type.
161 if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) {
162 if (Alignment.getQuantity() > MaxAlign &&
163 !getContext().isAlignmentRequired(T))
164 Alignment = CharUnits::fromQuantity(MaxAlign);
165 }
166 }
167 return Alignment;
168}
169
170LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000171 LValueBaseInfo BaseInfo;
172 CharUnits Alignment = getNaturalTypeAlignment(T, &BaseInfo);
173 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), BaseInfo,
John McCall7f416cc2015-09-08 08:05:57 +0000174 CGM.getTBAAInfo(T));
175}
176
177/// Given a value of type T* that may not be to a complete object,
178/// construct an l-value with the natural pointee alignment of T.
179LValue
180CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000181 LValueBaseInfo BaseInfo;
182 CharUnits Align = getNaturalTypeAlignment(T, &BaseInfo, /*pointee*/ true);
183 return MakeAddrLValue(Address(V, Align), T, BaseInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000184}
185
186
Chris Lattnera5f58b02011-07-09 17:41:47 +0000187llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) {
Daniel Dunbaree3da872009-02-03 23:03:55 +0000188 return CGM.getTypes().ConvertTypeForMem(T);
189}
190
Chris Lattnera5f58b02011-07-09 17:41:47 +0000191llvm::Type *CodeGenFunction::ConvertType(QualType T) {
Chris Lattnerf033c142007-06-22 19:05:19 +0000192 return CGM.getTypes().ConvertType(T);
Chris Lattner45bb9142007-06-09 02:28:57 +0000193}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000194
John McCall47fb9502013-03-07 21:37:08 +0000195TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) {
196 type = type.getCanonicalType();
197 while (true) {
198 switch (type->getTypeClass()) {
John McCall745ae282011-05-15 02:34:36 +0000199#define TYPE(name, parent)
200#define ABSTRACT_TYPE(name, parent)
201#define NON_CANONICAL_TYPE(name, parent) case Type::name:
202#define DEPENDENT_TYPE(name, parent) case Type::name:
203#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name:
204#include "clang/AST/TypeNodes.def"
John McCall47fb9502013-03-07 21:37:08 +0000205 llvm_unreachable("non-canonical or dependent type in IR-generation");
John McCall745ae282011-05-15 02:34:36 +0000206
Richard Smith27d807c2013-04-30 13:56:41 +0000207 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +0000208 case Type::DeducedTemplateSpecialization:
209 llvm_unreachable("undeduced type in IR-generation");
Richard Smith27d807c2013-04-30 13:56:41 +0000210
John McCall47fb9502013-03-07 21:37:08 +0000211 // Various scalar types.
212 case Type::Builtin:
213 case Type::Pointer:
214 case Type::BlockPointer:
215 case Type::LValueReference:
216 case Type::RValueReference:
217 case Type::MemberPointer:
218 case Type::Vector:
219 case Type::ExtVector:
220 case Type::FunctionProto:
221 case Type::FunctionNoProto:
222 case Type::Enum:
223 case Type::ObjCObjectPointer:
Xiuli Pan9c14e282016-01-09 12:53:17 +0000224 case Type::Pipe:
John McCall47fb9502013-03-07 21:37:08 +0000225 return TEK_Scalar;
John McCall745ae282011-05-15 02:34:36 +0000226
John McCall47fb9502013-03-07 21:37:08 +0000227 // Complexes.
228 case Type::Complex:
229 return TEK_Complex;
Eli Friedman0dfb8892011-10-06 23:00:33 +0000230
John McCall47fb9502013-03-07 21:37:08 +0000231 // Arrays, records, and Objective-C objects.
232 case Type::ConstantArray:
233 case Type::IncompleteArray:
234 case Type::VariableArray:
235 case Type::Record:
236 case Type::ObjCObject:
237 case Type::ObjCInterface:
238 return TEK_Aggregate;
239
240 // We operate on atomic values according to their underlying type.
241 case Type::Atomic:
242 type = cast<AtomicType>(type)->getValueType();
243 continue;
244 }
245 llvm_unreachable("unknown type kind!");
John McCall745ae282011-05-15 02:34:36 +0000246 }
Chris Lattner54fb19e2007-06-22 22:02:34 +0000247}
248
David Blaikie66e41972015-01-14 07:38:27 +0000249llvm::DebugLoc CodeGenFunction::EmitReturnBlock() {
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000250 // For cleanliness, we try to avoid emitting the return block for
251 // simple cases.
252 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
253
254 if (CurBB) {
255 assert(!CurBB->getTerminator() && "Unexpected terminated block.");
256
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000257 // We have a valid insert point, reuse it if it is empty or there are no
258 // explicit jumps to the return block.
John McCallad5d61e2010-07-23 21:56:41 +0000259 if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) {
260 ReturnBlock.getBlock()->replaceAllUsesWith(CurBB);
261 delete ReturnBlock.getBlock();
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000262 } else
John McCallad5d61e2010-07-23 21:56:41 +0000263 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000264 return llvm::DebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000265 }
266
267 // Otherwise, if the return block is the target of a single direct
268 // branch then we can just put the code in that block instead. This
269 // cleans up functions which started with a unified return block.
John McCallad5d61e2010-07-23 21:56:41 +0000270 if (ReturnBlock.getBlock()->hasOneUse()) {
Mike Stump11289f42009-09-09 15:08:12 +0000271 llvm::BranchInst *BI =
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000272 dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin());
John McCallbd309292010-07-06 01:34:17 +0000273 if (BI && BI->isUnconditional() &&
John McCallad5d61e2010-07-23 21:56:41 +0000274 BI->getSuccessor(0) == ReturnBlock.getBlock()) {
David Blaikie66e41972015-01-14 07:38:27 +0000275 // Record/return the DebugLoc of the simple 'return' expression to be used
276 // later by the actual 'ret' instruction.
277 llvm::DebugLoc Loc = BI->getDebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000278 Builder.SetInsertPoint(BI->getParent());
279 BI->eraseFromParent();
John McCallad5d61e2010-07-23 21:56:41 +0000280 delete ReturnBlock.getBlock();
David Blaikie66e41972015-01-14 07:38:27 +0000281 return Loc;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000282 }
283 }
284
Mike Stump18bb9282009-05-16 07:57:57 +0000285 // FIXME: We are at an unreachable point, there is no reason to emit the block
286 // unless it has uses. However, we still need a place to put the debug
287 // region.end for now.
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000288
John McCallad5d61e2010-07-23 21:56:41 +0000289 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000290 return llvm::DebugLoc();
John McCallbd309292010-07-06 01:34:17 +0000291}
292
293static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) {
294 if (!BB) return;
295 if (!BB->use_empty())
296 return CGF.CurFn->getBasicBlockList().push_back(BB);
297 delete BB;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000298}
299
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000300void CodeGenFunction::FinishFunction(SourceLocation EndLoc) {
Chris Lattnere73e4322007-07-16 21:28:45 +0000301 assert(BreakContinueStack.empty() &&
302 "mismatched push/pop in break/continue stack!");
Mike Stump11289f42009-09-09 15:08:12 +0000303
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000304 bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0
Adrian Prantl524ba1f2013-07-25 00:23:42 +0000305 && NumSimpleReturnExprs == NumReturnExprs
306 && ReturnBlock.getBlock()->use_empty();
307 // Usually the return expression is evaluated before the cleanup
308 // code. If the function contains only a simple return statement,
309 // such as a constant, the location before the cleanup code becomes
310 // the last useful breakpoint in the function, because the simple
311 // return expression will be evaluated after the cleanup code. To be
312 // safe, set the debug location for cleanup code to the location of
313 // the return statement. Otherwise the cleanup code should be at the
314 // end of the function's lexical scope.
315 //
316 // If there are multiple branches to the return block, the branch
317 // instructions will get the location of the return statements and
318 // all will be fine.
Adrian Prantl3be10542013-05-02 17:30:20 +0000319 if (CGDebugInfo *DI = getDebugInfo()) {
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000320 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000321 DI->EmitLocation(Builder, LastStopPoint);
Adrian Prantl3be10542013-05-02 17:30:20 +0000322 else
Adrian Prantle83b1302014-01-07 22:05:52 +0000323 DI->EmitLocation(Builder, EndLoc);
Adrian Prantl3be10542013-05-02 17:30:20 +0000324 }
David Blaikie357aafb2013-02-01 19:09:49 +0000325
John McCall31168b02011-06-15 23:02:42 +0000326 // Pop any cleanups that might have been associated with the
327 // parameters. Do this in whatever block we're currently in; it's
328 // important to do this before we enter the return block or return
329 // edges will be *really* confused.
David Majnemerdc012fa2015-04-22 21:38:15 +0000330 bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth;
331 bool HasOnlyLifetimeMarkers =
332 HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth);
333 bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers;
334 if (HasCleanups) {
Adrian Prantl3be10542013-05-02 17:30:20 +0000335 // Make sure the line table doesn't jump back into the body for
336 // the ret after it's been at EndLoc.
Adrian Prantl3be10542013-05-02 17:30:20 +0000337 if (CGDebugInfo *DI = getDebugInfo())
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000338 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000339 DI->EmitLocation(Builder, EndLoc);
David Blaikie4d524432015-02-04 19:47:54 +0000340
341 PopCleanupBlocks(PrologueCleanupDepth);
Adrian Prantl3be10542013-05-02 17:30:20 +0000342 }
343
Mike Stump11289f42009-09-09 15:08:12 +0000344 // Emit function epilog (to return).
David Blaikie66e41972015-01-14 07:38:27 +0000345 llvm::DebugLoc Loc = EmitReturnBlock();
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000346
Daniel Dunbar468a8f82011-02-10 17:32:22 +0000347 if (ShouldInstrumentFunction())
348 EmitFunctionInstrumentation("__cyg_profile_func_exit");
Chris Lattner3c77a352010-06-22 00:03:40 +0000349
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000350 // Emit debug descriptor for function end.
David Blaikie66e41972015-01-14 07:38:27 +0000351 if (CGDebugInfo *DI = getDebugInfo())
Keno Fischer41d4b4e2017-06-01 21:14:03 +0000352 DI->EmitFunctionEnd(Builder, CurFn);
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000353
David Blaikie66e41972015-01-14 07:38:27 +0000354 // Reset the debug location to that of the simple 'return' expression, if any
355 // rather than that of the end of the function's scope '}'.
356 ApplyDebugLocation AL(*this, Loc);
Nick Lewycky2d84e842013-10-02 02:29:49 +0000357 EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc);
Mike Stump1d849212009-12-07 23:38:24 +0000358 EmitEndEHSpec(CurCodeDecl);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000359
John McCallbd309292010-07-06 01:34:17 +0000360 assert(EHStack.empty() &&
361 "did not remove all scopes from cleanup stack!");
362
Chris Lattner6c4d2552009-10-28 23:59:40 +0000363 // If someone did an indirect goto, emit the indirect goto block at the end of
364 // the function.
365 if (IndirectBranch) {
366 EmitBlock(IndirectBranch->getParent());
367 Builder.ClearInsertionPoint();
368 }
Michael Ilseman686240a2012-12-04 00:29:55 +0000369
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000370 // If some of our locals escaped, insert a call to llvm.localescape in the
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000371 // entry block.
372 if (!EscapedLocals.empty()) {
373 // Invert the map from local to index into a simple vector. There should be
374 // no holes.
375 SmallVector<llvm::Value *, 4> EscapeArgs;
376 EscapeArgs.resize(EscapedLocals.size());
377 for (auto &Pair : EscapedLocals)
378 EscapeArgs[Pair.second] = Pair.first;
379 llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration(
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000380 &CGM.getModule(), llvm::Intrinsic::localescape);
John McCall7f416cc2015-09-08 08:05:57 +0000381 CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs);
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000382 }
383
Chris Lattnerc48023b2007-12-02 06:32:24 +0000384 // Remove the AllocaInsertPt instruction, which is just a convenience for us.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000385 llvm::Instruction *Ptr = AllocaInsertPt;
Craig Topper8a13c412014-05-21 05:09:00 +0000386 AllocaInsertPt = nullptr;
Chris Lattner2739d2b2009-03-31 22:17:44 +0000387 Ptr->eraseFromParent();
Michael Ilseman686240a2012-12-04 00:29:55 +0000388
Chris Lattner6c4d2552009-10-28 23:59:40 +0000389 // If someone took the address of a label but never did an indirect goto, we
390 // made a zero entry PHI node, which is illegal, zap it now.
391 if (IndirectBranch) {
392 llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress());
393 if (PN->getNumIncomingValues() == 0) {
394 PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType()));
395 PN->eraseFromParent();
396 }
397 }
John McCallbd309292010-07-06 01:34:17 +0000398
John McCall8e4c74b2011-08-11 02:22:43 +0000399 EmitIfUsed(*this, EHResumeBlock);
John McCallbd309292010-07-06 01:34:17 +0000400 EmitIfUsed(*this, TerminateLandingPad);
401 EmitIfUsed(*this, TerminateHandler);
402 EmitIfUsed(*this, UnreachableBlock);
John McCall09ae0322010-07-06 23:57:41 +0000403
404 if (CGM.getCodeGenOpts().EmitDeclMetadata)
405 EmitDeclMetadata();
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000406
407 for (SmallVectorImpl<std::pair<llvm::Instruction *, llvm::Value *> >::iterator
408 I = DeferredReplacements.begin(),
409 E = DeferredReplacements.end();
410 I != E; ++I) {
411 I->first->replaceAllUsesWith(I->second);
412 I->first->eraseFromParent();
413 }
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000414}
Chris Lattner308f4312007-05-29 23:50:05 +0000415
Chris Lattner3c77a352010-06-22 00:03:40 +0000416/// ShouldInstrumentFunction - Return true if the current function should be
417/// instrumented with __cyg_profile_func_* calls
418bool CodeGenFunction::ShouldInstrumentFunction() {
419 if (!CGM.getCodeGenOpts().InstrumentFunctions)
420 return false;
Ted Kremenekc249c412011-05-16 23:49:20 +0000421 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
Chris Lattner3c77a352010-06-22 00:03:40 +0000422 return false;
423 return true;
424}
425
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000426/// ShouldXRayInstrument - Return true if the current function should be
427/// instrumented with XRay nop sleds.
428bool CodeGenFunction::ShouldXRayInstrumentFunction() const {
429 return CGM.getCodeGenOpts().XRayInstrumentFunctions;
430}
431
Chris Lattner3c77a352010-06-22 00:03:40 +0000432/// EmitFunctionInstrumentation - Emit LLVM code to call the specified
433/// instrumentation function with the current function and the call site, if
434/// function instrumentation is enabled.
435void CodeGenFunction::EmitFunctionInstrumentation(const char *Fn) {
Adrian Prantl06f445d2016-04-28 17:21:56 +0000436 auto NL = ApplyDebugLocation::CreateArtificial(*this);
Chris Lattnerb48a2d52010-06-23 05:21:28 +0000437 // void __cyg_profile_func_{enter,exit} (void *this_fn, void *call_site);
Chris Lattnera5f58b02011-07-09 17:41:47 +0000438 llvm::PointerType *PointerTy = Int8PtrTy;
439 llvm::Type *ProfileFuncArgs[] = { PointerTy, PointerTy };
Chris Lattner2192fe52011-07-18 04:24:23 +0000440 llvm::FunctionType *FunctionTy =
Chris Lattnerece04092012-02-07 00:39:47 +0000441 llvm::FunctionType::get(VoidTy, ProfileFuncArgs, false);
Chris Lattner3c77a352010-06-22 00:03:40 +0000442
443 llvm::Constant *F = CGM.CreateRuntimeFunction(FunctionTy, Fn);
444 llvm::CallInst *CallSite = Builder.CreateCall(
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000445 CGM.getIntrinsic(llvm::Intrinsic::returnaddress),
Chris Lattner5e016ae2010-06-27 07:15:29 +0000446 llvm::ConstantInt::get(Int32Ty, 0),
Chris Lattner3c77a352010-06-22 00:03:40 +0000447 "callsite");
448
John McCall882987f2013-02-28 19:01:20 +0000449 llvm::Value *args[] = {
450 llvm::ConstantExpr::getBitCast(CurFn, PointerTy),
451 CallSite
452 };
453
454 EmitNounwindRuntimeCall(F, args);
Chris Lattner3c77a352010-06-22 00:03:40 +0000455}
456
Alexey Bader3e0b8172016-09-06 10:10:28 +0000457static void removeImageAccessQualifier(std::string& TyName) {
458 std::string ReadOnlyQual("__read_only");
459 std::string::size_type ReadOnlyPos = TyName.find(ReadOnlyQual);
460 if (ReadOnlyPos != std::string::npos)
461 // "+ 1" for the space after access qualifier.
462 TyName.erase(ReadOnlyPos, ReadOnlyQual.size() + 1);
463 else {
464 std::string WriteOnlyQual("__write_only");
465 std::string::size_type WriteOnlyPos = TyName.find(WriteOnlyQual);
466 if (WriteOnlyPos != std::string::npos)
467 TyName.erase(WriteOnlyPos, WriteOnlyQual.size() + 1);
468 else {
469 std::string ReadWriteQual("__read_write");
470 std::string::size_type ReadWritePos = TyName.find(ReadWriteQual);
471 if (ReadWritePos != std::string::npos)
472 TyName.erase(ReadWritePos, ReadWriteQual.size() + 1);
473 }
474 }
475}
476
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000477// Returns the address space id that should be produced to the
478// kernel_arg_addr_space metadata. This is always fixed to the ids
479// as specified in the SPIR 2.0 specification in order to differentiate
480// for example in clGetKernelArgInfo() implementation between the address
481// spaces with targets without unique mapping to the OpenCL address spaces
482// (basically all single AS CPUs).
483static unsigned ArgInfoAddressSpace(unsigned LangAS) {
484 switch (LangAS) {
485 case LangAS::opencl_global: return 1;
486 case LangAS::opencl_constant: return 2;
487 case LangAS::opencl_local: return 3;
488 case LangAS::opencl_generic: return 4; // Not in SPIR 2.0 specs.
489 default:
490 return 0; // Assume private.
491 }
492}
493
Tanya Lattner7445ada2012-07-11 23:02:10 +0000494// OpenCL v1.2 s5.6.4.6 allows the compiler to store kernel argument
495// information in the program executable. The argument information stored
496// includes the argument name, its type, the address and access qualifiers used.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000497static void GenOpenCLArgMetadata(const FunctionDecl *FD, llvm::Function *Fn,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000498 CodeGenModule &CGM, llvm::LLVMContext &Context,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000499 CGBuilderTy &Builder, ASTContext &ASTCtx) {
Guy Benyeifb36ede2013-03-24 13:58:12 +0000500 // Create MDNodes that represent the kernel arg metadata.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000501 // Each MDNode is a list in the form of "key", N number of values which is
502 // the same number of values as their are kernel arguments.
Michael Ilseman686240a2012-12-04 00:29:55 +0000503
Joey Gouly92a47442014-04-04 13:43:57 +0000504 const PrintingPolicy &Policy = ASTCtx.getPrintingPolicy();
505
Guy Benyeifb36ede2013-03-24 13:58:12 +0000506 // MDNode for the kernel argument address space qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000507 SmallVector<llvm::Metadata *, 8> addressQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000508
509 // MDNode for the kernel argument access qualifiers (images only).
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000510 SmallVector<llvm::Metadata *, 8> accessQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000511
512 // MDNode for the kernel argument type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000513 SmallVector<llvm::Metadata *, 8> argTypeNames;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000514
Fraser Cormackdadc3712014-07-30 14:39:53 +0000515 // MDNode for the kernel argument base type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000516 SmallVector<llvm::Metadata *, 8> argBaseTypeNames;
Fraser Cormackdadc3712014-07-30 14:39:53 +0000517
Guy Benyeifb36ede2013-03-24 13:58:12 +0000518 // MDNode for the kernel argument type qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000519 SmallVector<llvm::Metadata *, 8> argTypeQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000520
Tanya Lattner7445ada2012-07-11 23:02:10 +0000521 // MDNode for the kernel argument names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000522 SmallVector<llvm::Metadata *, 8> argNames;
Michael Ilseman686240a2012-12-04 00:29:55 +0000523
Tanya Lattner7445ada2012-07-11 23:02:10 +0000524 for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i) {
525 const ParmVarDecl *parm = FD->getParamDecl(i);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000526 QualType ty = parm->getType();
527 std::string typeQuals;
528
529 if (ty->isPointerType()) {
530 QualType pointeeTy = ty->getPointeeType();
531
532 // Get address qualifier.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000533 addressQuals.push_back(llvm::ConstantAsMetadata::get(Builder.getInt32(
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000534 ArgInfoAddressSpace(pointeeTy.getAddressSpace()))));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000535
536 // Get argument type name.
Joey Gouly92a47442014-04-04 13:43:57 +0000537 std::string typeName =
538 pointeeTy.getUnqualifiedType().getAsString(Policy) + "*";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000539
540 // Turn "unsigned type" to "utype"
541 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000542 if (pointeeTy.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000543 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000544
545 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
546
Fraser Cormackdadc3712014-07-30 14:39:53 +0000547 std::string baseTypeName =
548 pointeeTy.getUnqualifiedType().getCanonicalType().getAsString(
549 Policy) +
550 "*";
551
552 // Turn "unsigned type" to "utype"
553 pos = baseTypeName.find("unsigned");
554 if (pos != std::string::npos)
555 baseTypeName.erase(pos+1, 8);
556
557 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName));
558
Guy Benyeifb36ede2013-03-24 13:58:12 +0000559 // Get argument type qualifiers:
560 if (ty.isRestrictQualified())
561 typeQuals = "restrict";
562 if (pointeeTy.isConstQualified() ||
563 (pointeeTy.getAddressSpace() == LangAS::opencl_constant))
Benjamin Krameref89ae02013-03-24 16:04:55 +0000564 typeQuals += typeQuals.empty() ? "const" : " const";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000565 if (pointeeTy.isVolatileQualified())
Benjamin Krameref89ae02013-03-24 16:04:55 +0000566 typeQuals += typeQuals.empty() ? "volatile" : " volatile";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000567 } else {
Pekka Jaaskelainen3587b322014-01-09 13:37:30 +0000568 uint32_t AddrSpc = 0;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000569 bool isPipe = ty->isPipeType();
570 if (ty->isImageType() || isPipe)
Pekka Jaaskelainen2a1cc582016-11-14 13:08:30 +0000571 AddrSpc = ArgInfoAddressSpace(LangAS::opencl_global);
Bob Wilson95a27b02014-02-17 19:20:59 +0000572
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000573 addressQuals.push_back(
574 llvm::ConstantAsMetadata::get(Builder.getInt32(AddrSpc)));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000575
576 // Get argument type name.
Xiuli Pan9c14e282016-01-09 12:53:17 +0000577 std::string typeName;
578 if (isPipe)
Alexey Bader10e9e592016-07-13 10:28:13 +0000579 typeName = ty.getCanonicalType()->getAs<PipeType>()->getElementType()
580 .getAsString(Policy);
Xiuli Pan9c14e282016-01-09 12:53:17 +0000581 else
582 typeName = ty.getUnqualifiedType().getAsString(Policy);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000583
584 // Turn "unsigned type" to "utype"
585 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000586 if (ty.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000587 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000588
Xiuli Pan9c14e282016-01-09 12:53:17 +0000589 std::string baseTypeName;
590 if (isPipe)
Alexey Bader10e9e592016-07-13 10:28:13 +0000591 baseTypeName = ty.getCanonicalType()->getAs<PipeType>()
592 ->getElementType().getCanonicalType()
593 .getAsString(Policy);
Xiuli Pan9c14e282016-01-09 12:53:17 +0000594 else
595 baseTypeName =
Fraser Cormackdadc3712014-07-30 14:39:53 +0000596 ty.getUnqualifiedType().getCanonicalType().getAsString(Policy);
597
Alexey Bader3e0b8172016-09-06 10:10:28 +0000598 // Remove access qualifiers on images
599 // (as they are inseparable from type in clang implementation,
600 // but OpenCL spec provides a special query to get access qualifier
601 // via clGetKernelArgInfo with CL_KERNEL_ARG_ACCESS_QUALIFIER):
602 if (ty->isImageType()) {
603 removeImageAccessQualifier(typeName);
604 removeImageAccessQualifier(baseTypeName);
605 }
606
607 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
608
Fraser Cormackdadc3712014-07-30 14:39:53 +0000609 // 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
Xiuli Pan9c14e282016-01-09 12:53:17 +0000616 if (isPipe)
617 typeQuals = "pipe";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000618 }
Justin Bogner0f066062013-11-22 10:20:40 +0000619
Guy Benyeifb36ede2013-03-24 13:58:12 +0000620 argTypeQuals.push_back(llvm::MDString::get(Context, typeQuals));
621
Xiuli Pan9c14e282016-01-09 12:53:17 +0000622 // Get image and pipe access qualifier:
Xiuli Pan9c14e282016-01-09 12:53:17 +0000623 if (ty->isImageType()|| ty->isPipeType()) {
Alexey Sotkin7d7f0dc2017-07-26 18:49:54 +0000624 const Decl *PDecl = parm;
625 if (auto *TD = dyn_cast<TypedefType>(ty))
626 PDecl = TD->getDecl();
627 const OpenCLAccessAttr *A = PDecl->getAttr<OpenCLAccessAttr>();
Aaron Ballman26891332014-01-14 17:41:53 +0000628 if (A && A->isWriteOnly())
Guy Benyeifb36ede2013-03-24 13:58:12 +0000629 accessQuals.push_back(llvm::MDString::get(Context, "write_only"));
Xiuli Pan11e13f62016-02-26 03:13:03 +0000630 else if (A && A->isReadWrite())
631 accessQuals.push_back(llvm::MDString::get(Context, "read_write"));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000632 else
633 accessQuals.push_back(llvm::MDString::get(Context, "read_only"));
634 } else
635 accessQuals.push_back(llvm::MDString::get(Context, "none"));
Michael Ilseman686240a2012-12-04 00:29:55 +0000636
Tanya Lattner7445ada2012-07-11 23:02:10 +0000637 // Get argument name.
638 argNames.push_back(llvm::MDString::get(Context, parm->getName()));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000639 }
Guy Benyeifb36ede2013-03-24 13:58:12 +0000640
Yaxun Liuba28cba2016-06-22 14:56:35 +0000641 Fn->setMetadata("kernel_arg_addr_space",
642 llvm::MDNode::get(Context, addressQuals));
643 Fn->setMetadata("kernel_arg_access_qual",
644 llvm::MDNode::get(Context, accessQuals));
645 Fn->setMetadata("kernel_arg_type",
646 llvm::MDNode::get(Context, argTypeNames));
647 Fn->setMetadata("kernel_arg_base_type",
648 llvm::MDNode::get(Context, argBaseTypeNames));
649 Fn->setMetadata("kernel_arg_type_qual",
650 llvm::MDNode::get(Context, argTypeQuals));
Sameer Sahasrabuddhec6093fe2014-12-04 05:30:58 +0000651 if (CGM.getCodeGenOpts().EmitOpenCLArgMetadata)
Yaxun Liuba28cba2016-06-22 14:56:35 +0000652 Fn->setMetadata("kernel_arg_name",
653 llvm::MDNode::get(Context, argNames));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000654}
655
Michael Ilseman686240a2012-12-04 00:29:55 +0000656void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000657 llvm::Function *Fn)
658{
659 if (!FD->hasAttr<OpenCLKernelAttr>())
660 return;
661
662 llvm::LLVMContext &Context = getLLVMContext();
663
Yaxun Liuba28cba2016-06-22 14:56:35 +0000664 GenOpenCLArgMetadata(FD, Fn, CGM, Context, Builder, getContext());
Michael Ilseman686240a2012-12-04 00:29:55 +0000665
Aaron Ballmanc4327992013-12-19 03:09:10 +0000666 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000667 QualType HintQTy = A->getTypeHint();
668 const ExtVectorType *HintEltQTy = HintQTy->getAs<ExtVectorType>();
669 bool IsSignedInteger =
670 HintQTy->isSignedIntegerType() ||
671 (HintEltQTy && HintEltQTy->getElementType()->isSignedIntegerType());
672 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000673 llvm::ConstantAsMetadata::get(llvm::UndefValue::get(
674 CGM.getTypes().ConvertType(A->getTypeHint()))),
675 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
676 llvm::IntegerType::get(Context, 32),
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000677 llvm::APInt(32, (uint64_t)(IsSignedInteger ? 1 : 0))))};
678 Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, AttrMDArgs));
Joey Goulyaba589c2013-03-08 09:42:32 +0000679 }
680
Aaron Ballmanc4327992013-12-19 03:09:10 +0000681 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000682 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000683 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
684 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
685 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000686 Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000687 }
688
Aaron Ballmanc4327992013-12-19 03:09:10 +0000689 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000690 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000691 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
692 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
693 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000694 Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, AttrMDArgs));
695 }
696
697 if (const OpenCLIntelReqdSubGroupSizeAttr *A =
698 FD->getAttr<OpenCLIntelReqdSubGroupSizeAttr>()) {
699 llvm::Metadata *AttrMDArgs[] = {
700 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getSubGroupSize()))};
701 Fn->setMetadata("intel_reqd_sub_group_size",
702 llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000703 }
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000704}
705
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000706/// Determine whether the function F ends with a return stmt.
707static bool endsWithReturn(const Decl* F) {
708 const Stmt *Body = nullptr;
709 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F))
710 Body = FD->getBody();
711 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F))
712 Body = OMD->getBody();
713
714 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) {
715 auto LastStmt = CS->body_rbegin();
716 if (LastStmt != CS->body_rend())
717 return isa<ReturnStmt>(*LastStmt);
718 }
719 return false;
720}
721
Anna Zakse43b4fc2017-01-13 00:50:50 +0000722static void markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) {
723 Fn->addFnAttr("sanitize_thread_no_checking_at_run_time");
724 Fn->removeFnAttr(llvm::Attribute::SanitizeThread);
725}
726
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000727static bool matchesStlAllocatorFn(const Decl *D, const ASTContext &Ctx) {
728 auto *MD = dyn_cast_or_null<CXXMethodDecl>(D);
729 if (!MD || !MD->getDeclName().getAsIdentifierInfo() ||
730 !MD->getDeclName().getAsIdentifierInfo()->isStr("allocate") ||
731 (MD->getNumParams() != 1 && MD->getNumParams() != 2))
732 return false;
733
734 if (MD->parameters()[0]->getType().getCanonicalType() != Ctx.getSizeType())
735 return false;
736
737 if (MD->getNumParams() == 2) {
738 auto *PT = MD->parameters()[1]->getType()->getAs<PointerType>();
739 if (!PT || !PT->isVoidPointerType() ||
740 !PT->getPointeeType().isConstQualified())
741 return false;
742 }
743
744 return true;
745}
746
John McCalldec348f72013-05-03 07:33:41 +0000747void CodeGenFunction::StartFunction(GlobalDecl GD,
748 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000749 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +0000750 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000751 const FunctionArgList &Args,
Adrian Prantl42d71b92014-04-10 23:21:53 +0000752 SourceLocation Loc,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +0000753 SourceLocation StartLoc) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000754 assert(!CurFn &&
755 "Do not use a CodeGenFunction object for more than one function");
756
Anders Carlsson73fcc952009-09-11 00:07:24 +0000757 const Decl *D = GD.getDecl();
Michael Ilseman686240a2012-12-04 00:29:55 +0000758
Anders Carlssonf4478e92009-02-09 20:20:56 +0000759 DidCallStackSave = false;
John McCalldec348f72013-05-03 07:33:41 +0000760 CurCodeDecl = D;
David Majnemer25eb1652016-03-01 19:42:53 +0000761 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D))
762 if (FD->usesSEHTry())
763 CurSEHParent = FD;
Craig Topper8a13c412014-05-21 05:09:00 +0000764 CurFuncDecl = (D ? D->getNonClosureContext() : nullptr);
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000765 FnRetTy = RetTy;
Daniel Dunbar9c426522008-07-29 23:18:29 +0000766 CurFn = Fn;
John McCalla738c252011-03-09 04:27:21 +0000767 CurFnInfo = &FnInfo;
Chris Lattner5696e7b2008-06-17 18:05:57 +0000768 assert(CurFn->isDeclaration() && "Function already has body?");
769
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000770 if (CGM.isInSanitizerBlacklist(Fn, Loc))
Alexey Samsonov035462c2014-10-30 19:33:44 +0000771 SanOpts.clear();
Will Dietzf54319c2013-01-18 11:30:38 +0000772
Peter Collingbourne915df992015-05-15 18:33:32 +0000773 if (D) {
774 // Apply the no_sanitize* attributes to SanOpts.
775 for (auto Attr : D->specific_attrs<NoSanitizeAttr>())
776 SanOpts.Mask &= ~Attr->getMask();
777 }
778
779 // Apply sanitizer attributes to the function.
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000780 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress))
Peter Collingbourne915df992015-05-15 18:33:32 +0000781 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
782 if (SanOpts.has(SanitizerKind::Thread))
783 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
784 if (SanOpts.has(SanitizerKind::Memory))
785 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000786 if (SanOpts.has(SanitizerKind::SafeStack))
787 Fn->addFnAttr(llvm::Attribute::SafeStack);
Peter Collingbourne915df992015-05-15 18:33:32 +0000788
Anna Zaksbcd35a82016-11-11 23:22:44 +0000789 // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize,
Anna Zakse43b4fc2017-01-13 00:50:50 +0000790 // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time.
Anna Zaksbcd35a82016-11-11 23:22:44 +0000791 if (SanOpts.has(SanitizerKind::Thread)) {
792 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
793 IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0);
794 if (OMD->getMethodFamily() == OMF_dealloc ||
795 OMD->getMethodFamily() == OMF_initialize ||
796 (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) {
Anna Zakse43b4fc2017-01-13 00:50:50 +0000797 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000798 }
Anna Zakse43b4fc2017-01-13 00:50:50 +0000799 } else if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D)) {
800 IdentifierInfo *II = FD->getIdentifier();
801 if (II && II->isStr("__destroy_helper_block_"))
802 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000803 }
804 }
805
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000806 // Ignore unrelated casts in STL allocate() since the allocator must cast
807 // from void* to T* before object initialization completes. Don't match on the
808 // namespace because not all allocators are in std::
809 if (D && SanOpts.has(SanitizerKind::CFIUnrelatedCast)) {
810 if (matchesStlAllocatorFn(D, getContext()))
811 SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast;
812 }
813
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000814 // Apply xray attributes to the function (as a string, for now)
815 if (D && ShouldXRayInstrumentFunction()) {
816 if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) {
817 if (XRayAttr->alwaysXRayInstrument())
818 Fn->addFnAttr("function-instrument", "xray-always");
819 if (XRayAttr->neverXRayInstrument())
820 Fn->addFnAttr("function-instrument", "xray-never");
Dean Michael Berris418da3f2017-03-06 07:08:21 +0000821 if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>()) {
822 Fn->addFnAttr("xray-log-args",
823 llvm::utostr(LogArgs->getArgumentCount()));
824 }
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000825 } else {
Dean Michael Berris835832d2017-03-30 00:29:36 +0000826 if (!CGM.imbueXRayAttrs(Fn, Loc))
827 Fn->addFnAttr(
828 "xray-instruction-threshold",
829 llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold));
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000830 }
831 }
832
Chandler Carruthfcd33142016-12-23 01:24:49 +0000833 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
Alexey Bataevc7a82b42016-05-06 09:40:08 +0000834 if (CGM.getLangOpts().OpenMP && FD->hasAttr<OMPDeclareSimdDeclAttr>())
835 CGM.getOpenMPRuntime().emitDeclareSimdFunction(FD, Fn);
Jakob Stoklund Olesen819e54b2010-02-09 00:10:00 +0000836
Nirav Daved2f44d82016-04-05 17:50:43 +0000837 // Add no-jump-tables value.
838 Fn->addFnAttr("no-jump-tables",
839 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables));
840
Dehao Chen5e97f232017-08-24 21:37:33 +0000841 // Add profile-sample-accurate value.
842 if (CGM.getCodeGenOpts().ProfileSampleAccurate)
843 Fn->addFnAttr("profile-sample-accurate");
844
Richard Smith9c6890a2012-11-01 22:30:59 +0000845 if (getLangOpts().OpenCL) {
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000846 // Add metadata for a kernel function.
847 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000848 EmitOpenCLKernelMetadata(FD, Fn);
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000849 }
850
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000851 // If we are checking function types, emit a function type signature as
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000852 // prologue data.
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000853 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000854 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000855 if (llvm::Constant *PrologueSig =
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000856 CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM)) {
857 llvm::Constant *FTRTTIConst =
858 CGM.GetAddrOfRTTIDescriptor(FD->getType(), /*ForEH=*/true);
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000859 llvm::Constant *PrologueStructElems[] = { PrologueSig, FTRTTIConst };
860 llvm::Constant *PrologueStructConst =
861 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
862 Fn->setPrologueData(PrologueStructConst);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000863 }
864 }
865 }
866
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000867 // If we're checking nullability, we need to know whether we can check the
868 // return value. Initialize the flag to 'true' and refine it in EmitParmDecl.
869 if (SanOpts.has(SanitizerKind::NullabilityReturn)) {
870 auto Nullability = FnRetTy->getNullability(getContext());
871 if (Nullability && *Nullability == NullabilityKind::NonNull) {
872 if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
873 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>()))
874 RetValNullabilityPrecondition =
875 llvm::ConstantInt::getTrue(getLLVMContext());
876 }
877 }
878
James Molloyc16a60b62015-11-12 15:36:04 +0000879 // If we're in C++ mode and the function name is "main", it is guaranteed
880 // to be norecurse by the standard (3.6.1.3 "The function main shall not be
881 // used within a program").
882 if (getLangOpts().CPlusPlus)
883 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
884 if (FD->isMain())
885 Fn->addFnAttr(llvm::Attribute::NoRecurse);
Honggyu Kim2bbdeac2016-09-01 06:14:45 +0000886
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000887 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000888
Chris Lattner5696e7b2008-06-17 18:05:57 +0000889 // Create a marker to make it easy to insert allocas into the entryblock
890 // later. Don't create this with the builder, because we don't want it
891 // folded.
Chris Lattner5e016ae2010-06-27 07:15:29 +0000892 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
Mehdi Amini557c20a2016-03-13 21:05:23 +0000893 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000894
John McCallbd309292010-07-06 01:34:17 +0000895 ReturnBlock = getJumpDestInCurrentScope("return");
Mike Stump11289f42009-09-09 15:08:12 +0000896
Chris Lattner5696e7b2008-06-17 18:05:57 +0000897 Builder.SetInsertPoint(EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000898
Vedant Kumarc34d3432017-06-23 21:32:38 +0000899 // If we're checking the return value, allocate space for a pointer to a
900 // precise source location of the checked return statement.
901 if (requiresReturnValueCheck()) {
902 ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr");
903 InitTempAlloca(ReturnLocation, llvm::ConstantPointerNull::get(Int8PtrTy));
904 }
905
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000906 // Emit subprogram debug descriptor.
Anders Carlsson63784f42009-02-13 08:11:52 +0000907 if (CGDebugInfo *DI = getDebugInfo()) {
Reid Klecknerf00f8032016-06-08 20:41:54 +0000908 // Reconstruct the type from the argument list so that implicit parameters,
909 // such as 'this' and 'vtt', show up in the debug info. Preserve the calling
910 // convention.
911 CallingConv CC = CallingConv::CC_C;
912 if (auto *FD = dyn_cast_or_null<FunctionDecl>(D))
913 if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>())
914 CC = SrcFnTy->getCallConv();
Jordan Rose5c382722013-03-08 21:51:21 +0000915 SmallVector<QualType, 16> ArgTypes;
Reid Klecknerf00f8032016-06-08 20:41:54 +0000916 for (const VarDecl *VD : Args)
917 ArgTypes.push_back(VD->getType());
918 QualType FnType = getContext().getFunctionType(
919 RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Adrian Prantl42d71b92014-04-10 23:21:53 +0000920 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, Builder);
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000921 }
922
Daniel Dunbar468a8f82011-02-10 17:32:22 +0000923 if (ShouldInstrumentFunction())
924 EmitFunctionInstrumentation("__cyg_profile_func_enter");
Chris Lattner3c77a352010-06-22 00:03:40 +0000925
Honggyu Kim2b0e4242016-09-01 11:29:21 +0000926 // Since emitting the mcount call here impacts optimizations such as function
927 // inlining, we just add an attribute to insert a mcount call in backend.
928 // The attribute "counting-function" is set to mcount function name which is
929 // architecture dependent.
Nirav Dave0c86ccf2017-01-31 17:00:35 +0000930 if (CGM.getCodeGenOpts().InstrumentForProfiling) {
931 if (CGM.getCodeGenOpts().CallFEntry)
932 Fn->addFnAttr("fentry-call", "true");
Manoj Gupta162b40a2017-06-19 18:45:03 +0000933 else {
934 if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
935 Fn->addFnAttr("counting-function", getTarget().getMCountName());
936 }
Nirav Dave0c86ccf2017-01-31 17:00:35 +0000937 }
Roman Divacky178e01602011-02-10 16:52:03 +0000938
Eli Friedman4b1942c2009-12-04 02:43:40 +0000939 if (RetTy->isVoidType()) {
940 // Void type; nothing to return.
John McCall7f416cc2015-09-08 08:05:57 +0000941 ReturnValue = Address::invalid();
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000942
943 // Count the implicit return.
944 if (!endsWithReturn(D))
945 ++NumReturnExprs;
Eli Friedman4b1942c2009-12-04 02:43:40 +0000946 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect &&
John McCall47fb9502013-03-07 21:37:08 +0000947 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
Eli Friedman4b1942c2009-12-04 02:43:40 +0000948 // Indirect aggregate return; emit returned value directly into sret slot.
Daniel Dunbarfd09df72010-02-16 19:45:20 +0000949 // This reduces code size, and affects correctness in C++.
Reid Kleckner37abaca2014-05-09 22:46:15 +0000950 auto AI = CurFn->arg_begin();
951 if (CurFnInfo->getReturnInfo().isSRetAfterThis())
952 ++AI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +0000953 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign());
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000954 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
955 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
956 // Load the sret pointer from the argument struct and return into that.
957 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
958 llvm::Function::arg_iterator EI = CurFn->arg_end();
959 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +0000960 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx);
John McCall7f416cc2015-09-08 08:05:57 +0000961 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result");
962 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy));
Eli Friedman4b1942c2009-12-04 02:43:40 +0000963 } else {
Daniel Dunbarfd09df72010-02-16 19:45:20 +0000964 ReturnValue = CreateIRTemp(RetTy, "retval");
John McCall31168b02011-06-15 23:02:42 +0000965
966 // Tell the epilog emitter to autorelease the result. We do this
967 // now so that various specialized functions can suppress it
968 // during their IR-generation.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000969 if (getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000970 !CurFnInfo->isReturnsRetained() &&
971 RetTy->isObjCRetainableType())
972 AutoreleaseResult = true;
Eli Friedman4b1942c2009-12-04 02:43:40 +0000973 }
974
Mike Stump1d849212009-12-07 23:38:24 +0000975 EmitStartEHSpec(CurCodeDecl);
John McCall31168b02011-06-15 23:02:42 +0000976
977 PrologueCleanupDepth = EHStack.stable_begin();
Daniel Dunbard931a872009-02-02 22:03:45 +0000978 EmitFunctionProlog(*CurFnInfo, CurFn, Args);
Mike Stump11289f42009-09-09 15:08:12 +0000979
Eli Friedman9fbeba02012-02-11 02:57:39 +0000980 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
John McCall5d865c322010-08-31 07:33:07 +0000981 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
Eli Friedman9fbeba02012-02-11 02:57:39 +0000982 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
983 if (MD->getParent()->isLambda() &&
984 MD->getOverloadedOperator() == OO_Call) {
985 // We're in a lambda; figure out the captures.
986 MD->getParent()->getCaptureFields(LambdaCaptureFields,
987 LambdaThisCaptureField);
988 if (LambdaThisCaptureField) {
Faisal Validc6b5962016-03-21 09:25:37 +0000989 // If the lambda captures the object referred to by '*this' - either by
990 // value or by reference, make sure CXXThisValue points to the correct
991 // object.
992
993 // Get the lvalue for the field (which is a copy of the enclosing object
994 // or contains the address of the enclosing object).
995 LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
996 if (!LambdaThisCaptureField->getType()->isPointerType()) {
997 // If the enclosing object was captured by value, just use its address.
998 CXXThisValue = ThisFieldLValue.getAddress().getPointer();
999 } else {
1000 // Load the lvalue pointed to by the field, since '*this' was captured
1001 // by reference.
1002 CXXThisValue =
1003 EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal();
1004 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001005 }
Alexey Bataev39c81e22014-08-28 04:28:19 +00001006 for (auto *FD : MD->getParent()->fields()) {
1007 if (FD->hasCapturedVLAType()) {
1008 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
1009 SourceLocation()).getScalarVal();
1010 auto VAT = FD->getCapturedVLAType();
1011 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
1012 }
1013 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001014 } else {
1015 // Not in a lambda; just use 'this' from the method.
1016 // FIXME: Should we generate a new load for each use of 'this'? The
1017 // fast register allocator would be happier...
1018 CXXThisValue = CXXABIThisValue;
1019 }
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001020
Vedant Kumarffd7c882017-04-14 22:03:34 +00001021 // Check the 'this' pointer once per function, if it's available.
Richard Smith376c28e2017-08-24 20:10:33 +00001022 if (CXXABIThisValue) {
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001023 SanitizerSet SkippedChecks;
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001024 SkippedChecks.set(SanitizerKind::ObjectSize, true);
Vedant Kumarffd7c882017-04-14 22:03:34 +00001025 QualType ThisTy = MD->getThisType(getContext());
Richard Smith376c28e2017-08-24 20:10:33 +00001026
1027 // If this is the call operator of a lambda with no capture-default, it
1028 // may have a static invoker function, which may call this operator with
1029 // a null 'this' pointer.
1030 if (isLambdaCallOperator(MD) &&
1031 cast<CXXRecordDecl>(MD->getParent())->getLambdaCaptureDefault() ==
1032 LCD_None)
1033 SkippedChecks.set(SanitizerKind::Null, true);
1034
1035 EmitTypeCheck(isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall
1036 : TCK_MemberCall,
1037 Loc, CXXABIThisValue, ThisTy,
Vedant Kumarffd7c882017-04-14 22:03:34 +00001038 getContext().getTypeAlignInChars(ThisTy->getPointeeType()),
1039 SkippedChecks);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001040 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001041 }
John McCall347132b2010-02-16 22:04:33 +00001042
Anders Carlssonc20879a2008-12-20 21:28:43 +00001043 // If any of the arguments have a variably modified type, make sure to
1044 // emit the type size.
1045 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
1046 i != e; ++i) {
Eli Friedman1f576832012-11-14 22:09:59 +00001047 const VarDecl *VD = *i;
1048
1049 // Dig out the type as written from ParmVarDecls; it's unclear whether
1050 // the standard (C99 6.9.1p10) requires this, but we're following the
1051 // precedent set by gcc.
1052 QualType Ty;
1053 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
1054 Ty = PVD->getOriginalType();
1055 else
1056 Ty = VD->getType();
Anders Carlssonc20879a2008-12-20 21:28:43 +00001057
1058 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +00001059 EmitVariablyModifiedType(Ty);
Anders Carlssonc20879a2008-12-20 21:28:43 +00001060 }
Eric Christopher7cdf9482011-10-13 21:45:18 +00001061 // Emit a location at the end of the prologue.
1062 if (CGDebugInfo *DI = getDebugInfo())
1063 DI->EmitLocation(Builder, StartLoc);
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001064}
Eli Friedman3d421e12008-08-25 21:31:01 +00001065
Richard Smithb47c36f2013-11-05 09:12:18 +00001066void CodeGenFunction::EmitFunctionBody(FunctionArgList &Args,
1067 const Stmt *Body) {
Justin Bogner66242d62015-04-23 23:06:47 +00001068 incrementProfileCounter(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001069 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
David Blaikie0a21d0d2013-01-26 22:16:26 +00001070 EmitCompoundStmtWithoutScope(*S);
1071 else
Richard Smithb47c36f2013-11-05 09:12:18 +00001072 EmitStmt(Body);
John McCall89b12b32010-02-18 03:17:58 +00001073}
1074
Bob Wilsonbf854f02014-02-17 19:21:09 +00001075/// When instrumenting to collect profile data, the counts for some blocks
1076/// such as switch cases need to not include the fall-through counts, so
1077/// emit a branch around the instrumentation code. When not instrumenting,
1078/// this just calls EmitBlock().
1079void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
Justin Bogner66242d62015-04-23 23:06:47 +00001080 const Stmt *S) {
Craig Topper8a13c412014-05-21 05:09:00 +00001081 llvm::BasicBlock *SkipCountBB = nullptr;
Rong Xu9837ef52016-02-04 18:39:09 +00001082 if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001083 // When instrumenting for profiling, the fallthrough to certain
1084 // statements needs to skip over the instrumentation code so that we
1085 // get an accurate count.
1086 SkipCountBB = createBasicBlock("skipcount");
1087 EmitBranch(SkipCountBB);
1088 }
1089 EmitBlock(BB);
Justin Bogner66242d62015-04-23 23:06:47 +00001090 uint64_t CurrentCount = getCurrentProfileCount();
1091 incrementProfileCounter(S);
1092 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001093 if (SkipCountBB)
1094 EmitBlock(SkipCountBB);
1095}
1096
John McCall8601a752010-08-03 22:46:07 +00001097/// Tries to mark the given function nounwind based on the
1098/// non-existence of any throwing calls within it. We believe this is
1099/// lightweight enough to do at -O0.
1100static void TryMarkNoThrow(llvm::Function *F) {
John McCall59966992010-08-11 22:38:33 +00001101 // LLVM treats 'nounwind' on a function as part of the type, so we
1102 // can't do this on functions that can be overwritten.
Sanjoy Dasf60a0d72016-04-08 01:31:02 +00001103 if (F->isInterposable()) return;
John McCall59966992010-08-11 22:38:33 +00001104
David Majnemerdbf10452015-07-31 17:58:45 +00001105 for (llvm::BasicBlock &BB : *F)
1106 for (llvm::Instruction &I : BB)
1107 if (I.mayThrow())
Bill Wendlingf0724e82011-09-19 20:31:14 +00001108 return;
David Majnemerdbf10452015-07-31 17:58:45 +00001109
Bill Wendling73e465e2012-10-10 03:13:20 +00001110 F->setDoesNotThrow();
John McCall8601a752010-08-03 22:46:07 +00001111}
1112
Richard Smith5179eb72016-06-28 19:03:57 +00001113QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD,
1114 FunctionArgList &Args) {
Anders Carlsson73fcc952009-09-11 00:07:24 +00001115 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Alp Toker314cc812014-01-25 16:55:45 +00001116 QualType ResTy = FD->getReturnType();
Mike Stump11289f42009-09-09 15:08:12 +00001117
Reid Kleckner89077a12013-12-17 19:46:40 +00001118 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1119 if (MD && MD->isInstance()) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001120 if (CGM.getCXXABI().HasThisReturn(GD))
1121 ResTy = MD->getThisType(getContext());
David Majnemer0c0b6d92014-10-31 20:09:12 +00001122 else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
1123 ResTy = CGM.getContext().VoidPtrTy;
Reid Kleckner89077a12013-12-17 19:46:40 +00001124 CGM.getCXXABI().buildThisParam(*this, Args);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001125 }
Justin Bogner66242d62015-04-23 23:06:47 +00001126
Richard Smith5179eb72016-06-28 19:03:57 +00001127 // The base version of an inheriting constructor whose constructed base is a
1128 // virtual base is not passed any arguments (because it doesn't actually call
1129 // the inherited constructor).
1130 bool PassedParams = true;
1131 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
1132 if (auto Inherited = CD->getInheritedConstructor())
1133 PassedParams =
1134 getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001135
Richard Smith5179eb72016-06-28 19:03:57 +00001136 if (PassedParams) {
1137 for (auto *Param : FD->parameters()) {
1138 Args.push_back(Param);
1139 if (!Param->hasAttr<PassObjectSizeAttr>())
1140 continue;
1141
Richard Smith5179eb72016-06-28 19:03:57 +00001142 auto *Implicit = ImplicitParamDecl::Create(
Alexey Bataev56223232017-06-09 13:40:18 +00001143 getContext(), Param->getDeclContext(), Param->getLocation(),
1144 /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other);
Richard Smith5179eb72016-06-28 19:03:57 +00001145 SizeArguments[Param] = Implicit;
1146 Args.push_back(Implicit);
1147 }
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001148 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001149
Reid Kleckner89077a12013-12-17 19:46:40 +00001150 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
1151 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
1152
Richard Smith5179eb72016-06-28 19:03:57 +00001153 return ResTy;
1154}
1155
Alex Lorenzc1608f72017-01-04 13:40:34 +00001156static bool
1157shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD,
1158 const ASTContext &Context) {
1159 QualType T = FD->getReturnType();
1160 // Avoid the optimization for functions that return a record type with a
1161 // trivial destructor or another trivially copyable type.
1162 if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) {
1163 if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl()))
1164 return !ClassDecl->hasTrivialDestructor();
1165 }
1166 return !T.isTriviallyCopyableType(Context);
1167}
1168
Richard Smith5179eb72016-06-28 19:03:57 +00001169void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1170 const CGFunctionInfo &FnInfo) {
1171 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
1172 CurGD = GD;
1173
1174 FunctionArgList Args;
1175 QualType ResTy = BuildFunctionArgList(GD, Args);
1176
1177 // Check if we should generate debug info for this function.
1178 if (FD->hasAttr<NoDebugAttr>())
1179 DebugInfo = nullptr; // disable debug info indefinitely for this function
1180
Reid Klecknera8589812017-02-08 16:09:32 +00001181 // The function might not have a body if we're generating thunks for a
1182 // function declaration.
John McCall89b12b32010-02-18 03:17:58 +00001183 SourceRange BodyRange;
Reid Klecknera8589812017-02-08 16:09:32 +00001184 if (Stmt *Body = FD->getBody())
1185 BodyRange = Body->getSourceRange();
1186 else
1187 BodyRange = FD->getLocation();
Adrian Prantldc237b52013-05-16 00:41:26 +00001188 CurEHLocation = BodyRange.getEnd();
Anders Carlsson438cf922009-11-06 02:55:43 +00001189
Adrian Prantl42d71b92014-04-10 23:21:53 +00001190 // Use the location of the start of the function to determine where
1191 // the function definition is located. By default use the location
1192 // of the declaration as the location for the subprogram. A function
1193 // may lack a declaration in the source code if it is created by code
1194 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001195 SourceLocation Loc = FD->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001196
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001197 // If this is a function specialization then use the pattern body
1198 // as the location for the function.
1199 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
1200 if (SpecDecl->hasBody(SpecDecl))
1201 Loc = SpecDecl->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001202
Vitaly Buka64c80b42016-10-26 05:42:30 +00001203 Stmt *Body = FD->getBody();
1204
1205 // Initialize helper which will detect jumps which can cause invalid lifetime
1206 // markers.
1207 if (Body && ShouldEmitLifetimeMarkers)
1208 Bypasses.Init(Body);
1209
John McCall89b12b32010-02-18 03:17:58 +00001210 // Emit the standard function prologue.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001211 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
Anders Carlsson438cf922009-11-06 02:55:43 +00001212
John McCall89b12b32010-02-18 03:17:58 +00001213 // Generate the body of the function.
Serge Pavlov3a561452015-12-06 14:32:39 +00001214 PGO.assignRegionCounters(GD, CurFn);
John McCallb81884d2010-02-19 09:25:03 +00001215 if (isa<CXXDestructorDecl>(FD))
1216 EmitDestructorBody(Args);
1217 else if (isa<CXXConstructorDecl>(FD))
1218 EmitConstructorBody(Args);
Richard Smith9c6890a2012-11-01 22:30:59 +00001219 else if (getLangOpts().CUDA &&
Artem Belevichf3d3db62015-03-19 18:58:18 +00001220 !getLangOpts().CUDAIsDevice &&
Peter Collingbournefa4d6032011-10-06 18:51:56 +00001221 FD->hasAttr<CUDAGlobalAttr>())
Artem Belevich52cc4872015-05-07 19:34:16 +00001222 CGM.getCUDARuntime().emitDeviceStub(*this, Args);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001223 else if (isa<CXXMethodDecl>(FD) &&
1224 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
Faisal Vali2b391ab2013-09-26 19:54:12 +00001225 // The lambda static invoker function is special, because it forwards or
Douglas Gregor355efbb2012-02-17 03:02:34 +00001226 // clones the body of the function call operator (but is actually static).
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001227 EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD));
Lang Hamesbf122742013-02-17 07:22:09 +00001228 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
Nick Lewyckyb39be1f2013-09-10 05:14:39 +00001229 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
1230 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
Lang Hamesbf122742013-02-17 07:22:09 +00001231 // Implicit copy-assignment gets the same special treatment as implicit
1232 // copy-constructors.
1233 emitImplicitAssignmentOperatorBody(Args);
Vitaly Buka64c80b42016-10-26 05:42:30 +00001234 } else if (Body) {
Richard Smithb47c36f2013-11-05 09:12:18 +00001235 EmitFunctionBody(Args, Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001236 } else
1237 llvm_unreachable("no definition for emitted function");
Anders Carlssonff8cce42010-02-07 19:45:40 +00001238
Richard Smith9f9e5822012-10-04 23:52:29 +00001239 // C++11 [stmt.return]p2:
1240 // Flowing off the end of a function [...] results in undefined behavior in
1241 // a value-returning function.
1242 // C11 6.9.1p12:
1243 // If the '}' that terminates a function is reached, and the value of the
1244 // function call is used by the caller, the behavior is undefined.
Reid Kleckner9b3e3df2014-09-04 20:04:38 +00001245 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
Alp Toker314cc812014-01-25 16:55:45 +00001246 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
Alex Lorenzc1608f72017-01-04 13:40:34 +00001247 bool ShouldEmitUnreachable =
1248 CGM.getCodeGenOpts().StrictReturn ||
1249 shouldUseUndefinedBehaviorReturnOptimization(FD, getContext());
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001250 if (SanOpts.has(SanitizerKind::Return)) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001251 SanitizerScope SanScope(this);
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001252 llvm::Value *IsFalse = Builder.getFalse();
1253 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00001254 SanitizerHandler::MissingReturn,
1255 EmitCheckSourceLocation(FD->getLocation()), None);
Alex Lorenzc1608f72017-01-04 13:40:34 +00001256 } else if (ShouldEmitUnreachable) {
1257 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
1258 EmitTrapCall(llvm::Intrinsic::trap);
Akira Hatanaka85365cd2015-07-02 22:15:41 +00001259 }
Alex Lorenzc1608f72017-01-04 13:40:34 +00001260 if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) {
1261 Builder.CreateUnreachable();
1262 Builder.ClearInsertionPoint();
1263 }
Richard Smith9f9e5822012-10-04 23:52:29 +00001264 }
1265
John McCall89b12b32010-02-18 03:17:58 +00001266 // Emit the standard function epilogue.
1267 FinishFunction(BodyRange.getEnd());
John McCall8601a752010-08-03 22:46:07 +00001268
1269 // If we haven't marked the function nothrow through other means, do
1270 // a quick pass now to see if we can.
1271 if (!CurFn->doesNotThrow())
1272 TryMarkNoThrow(CurFn);
Chris Lattner5696e7b2008-06-17 18:05:57 +00001273}
1274
Chris Lattner5b1964b2008-11-11 07:41:27 +00001275/// ContainsLabel - Return true if the statement contains a label in it. If
1276/// this statement is not executed normally, it not containing a label means
1277/// that we can just remove the code.
1278bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
1279 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001280 if (!S) return false;
Mike Stump11289f42009-09-09 15:08:12 +00001281
Chris Lattner5b1964b2008-11-11 07:41:27 +00001282 // If this is a label, we have to emit the code, consider something like:
1283 // if (0) { ... foo: bar(); } goto foo;
Chris Lattner29911cc2011-02-28 00:18:40 +00001284 //
1285 // TODO: If anyone cared, we could track __label__'s, since we know that you
1286 // can't jump to one from outside their declared region.
Chris Lattner5b1964b2008-11-11 07:41:27 +00001287 if (isa<LabelStmt>(S))
1288 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001289
Chris Lattner5b1964b2008-11-11 07:41:27 +00001290 // If this is a case/default statement, and we haven't seen a switch, we have
1291 // to emit the code.
1292 if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
1293 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001294
Chris Lattner5b1964b2008-11-11 07:41:27 +00001295 // If this is a switch statement, we want to ignore cases below it.
1296 if (isa<SwitchStmt>(S))
1297 IgnoreCaseStmts = true;
Mike Stump11289f42009-09-09 15:08:12 +00001298
Chris Lattner5b1964b2008-11-11 07:41:27 +00001299 // Scan subexpressions for verboten labels.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001300 for (const Stmt *SubStmt : S->children())
1301 if (ContainsLabel(SubStmt, IgnoreCaseStmts))
Chris Lattner5b1964b2008-11-11 07:41:27 +00001302 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001303
Chris Lattner5b1964b2008-11-11 07:41:27 +00001304 return false;
1305}
1306
Chris Lattner29911cc2011-02-28 00:18:40 +00001307/// containsBreak - Return true if the statement contains a break out of it.
1308/// If the statement (recursively) contains a switch or loop with a break
1309/// inside of it, this is fine.
1310bool CodeGenFunction::containsBreak(const Stmt *S) {
1311 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001312 if (!S) return false;
Chris Lattner29911cc2011-02-28 00:18:40 +00001313
1314 // If this is a switch or loop that defines its own break scope, then we can
1315 // include it and anything inside of it.
1316 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
1317 isa<ForStmt>(S))
Chris Lattner30db8282011-02-28 00:42:31 +00001318 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001319
Chris Lattner30db8282011-02-28 00:42:31 +00001320 if (isa<BreakStmt>(S))
Chris Lattner29911cc2011-02-28 00:18:40 +00001321 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001322
Chris Lattner29911cc2011-02-28 00:18:40 +00001323 // Scan subexpressions for verboten breaks.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001324 for (const Stmt *SubStmt : S->children())
1325 if (containsBreak(SubStmt))
Chris Lattner29911cc2011-02-28 00:18:40 +00001326 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001327
Chris Lattner29911cc2011-02-28 00:18:40 +00001328 return false;
1329}
1330
Richard Smithd8e3ac32016-09-16 23:30:39 +00001331bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) {
1332 if (!S) return false;
1333
1334 // Some statement kinds add a scope and thus never add a decl to the current
1335 // scope. Note, this list is longer than the list of statements that might
1336 // have an unscoped decl nested within them, but this way is conservatively
1337 // correct even if more statement kinds are added.
1338 if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
1339 isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) ||
1340 isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) ||
1341 isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S))
1342 return false;
1343
1344 if (isa<DeclStmt>(S))
1345 return true;
1346
1347 for (const Stmt *SubStmt : S->children())
1348 if (mightAddDeclToScope(SubStmt))
1349 return true;
1350
1351 return false;
1352}
Chris Lattnercd439292008-11-12 08:04:58 +00001353
Chris Lattner41c6ab52011-02-27 23:02:32 +00001354/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1355/// to a constant, or if it does but contains a label, return false. If it
1356/// constant folds return true and set the boolean result in Result.
1357bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
Richard Smithb130fe72016-06-23 19:16:49 +00001358 bool &ResultBool,
1359 bool AllowLabels) {
Richard Trieuc320c742012-07-23 20:21:35 +00001360 llvm::APSInt ResultInt;
Richard Smithb130fe72016-06-23 19:16:49 +00001361 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels))
Chris Lattner29911cc2011-02-28 00:18:40 +00001362 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001363
Chris Lattner29911cc2011-02-28 00:18:40 +00001364 ResultBool = ResultInt.getBoolValue();
1365 return true;
1366}
1367
1368/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1369/// to a constant, or if it does but contains a label, return false. If it
1370/// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00001371bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1372 llvm::APSInt &ResultInt,
1373 bool AllowLabels) {
Daniel Dunbarf32443c2008-11-12 22:37:10 +00001374 // FIXME: Rename and handle conversion of other evaluatable things
1375 // to bool.
Richard Smith5fab0c92011-12-28 19:48:30 +00001376 llvm::APSInt Int;
1377 if (!Cond->EvaluateAsInt(Int, getContext()))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001378 return false; // Not foldable, not integer or not fully evaluatable.
Richard Smith5fab0c92011-12-28 19:48:30 +00001379
Richard Smithb130fe72016-06-23 19:16:49 +00001380 if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001381 return false; // Contains a label.
Richard Smith5fab0c92011-12-28 19:48:30 +00001382
1383 ResultInt = Int;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001384 return true;
Chris Lattnercd439292008-11-12 08:04:58 +00001385}
1386
1387
Chris Lattner29911cc2011-02-28 00:18:40 +00001388
Chris Lattnercd439292008-11-12 08:04:58 +00001389/// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
1390/// statement) to the specified blocks. Based on the condition, this might try
1391/// to simplify the codegen of the conditional based on the branch.
1392///
1393void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
1394 llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00001395 llvm::BasicBlock *FalseBlock,
1396 uint64_t TrueCount) {
Peter Collingbourne91147592011-04-15 00:35:48 +00001397 Cond = Cond->IgnoreParens();
Mike Stump11289f42009-09-09 15:08:12 +00001398
Chris Lattnercd439292008-11-12 08:04:58 +00001399 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
Justin Bogneref512b92014-01-06 22:27:43 +00001400
Chris Lattnercd439292008-11-12 08:04:58 +00001401 // Handle X && Y in a condition.
John McCalle3027922010-08-25 11:45:40 +00001402 if (CondBOp->getOpcode() == BO_LAnd) {
Chris Lattnercd439292008-11-12 08:04:58 +00001403 // If we have "1 && X", simplify the code. "0 && X" would have constant
1404 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001405 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001406 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1407 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001408 // br(1 && X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001409 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001410 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1411 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001412 }
Mike Stump11289f42009-09-09 15:08:12 +00001413
Chris Lattnercd439292008-11-12 08:04:58 +00001414 // If we have "X && 1", simplify the code to use an uncond branch.
1415 // "X && 0" would have been constant folded to 0.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001416 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1417 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001418 // br(X && 1) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001419 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1420 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001421 }
Mike Stump11289f42009-09-09 15:08:12 +00001422
Chris Lattnercd439292008-11-12 08:04:58 +00001423 // Emit the LHS as a conditional. If the LHS conditional is false, we
1424 // want to jump to the FalseBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001425 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
Justin Bogneref512b92014-01-06 22:27:43 +00001426 // The counter tells us how often we evaluate RHS, and all of TrueCount
1427 // can be propagated to that branch.
Justin Bogner66242d62015-04-23 23:06:47 +00001428 uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
John McCallce1de612011-01-26 04:00:11 +00001429
1430 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001431 {
1432 ApplyDebugLocation DL(*this, Cond);
1433 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount);
1434 EmitBlock(LHSTrue);
1435 }
Mike Stump11289f42009-09-09 15:08:12 +00001436
Justin Bogner66242d62015-04-23 23:06:47 +00001437 incrementProfileCounter(CondBOp);
1438 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1439
Anders Carlsson60ddba62010-01-24 00:20:05 +00001440 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001441 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001442 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount);
John McCallce1de612011-01-26 04:00:11 +00001443 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001444
Chris Lattnercd439292008-11-12 08:04:58 +00001445 return;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001446 }
Michael Ilseman686240a2012-12-04 00:29:55 +00001447
Chris Lattner41c6ab52011-02-27 23:02:32 +00001448 if (CondBOp->getOpcode() == BO_LOr) {
Chris Lattnercd439292008-11-12 08:04:58 +00001449 // If we have "0 || X", simplify the code. "1 || X" would have constant
1450 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001451 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001452 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1453 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001454 // br(0 || X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001455 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001456 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1457 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001458 }
Mike Stump11289f42009-09-09 15:08:12 +00001459
Chris Lattnercd439292008-11-12 08:04:58 +00001460 // If we have "X || 0", simplify the code to use an uncond branch.
1461 // "X || 1" would have been constant folded to 1.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001462 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1463 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001464 // br(X || 0) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001465 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1466 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001467 }
Mike Stump11289f42009-09-09 15:08:12 +00001468
Chris Lattnercd439292008-11-12 08:04:58 +00001469 // Emit the LHS as a conditional. If the LHS conditional is true, we
1470 // want to jump to the TrueBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001471 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
Justin Bogneref512b92014-01-06 22:27:43 +00001472 // We have the count for entry to the RHS and for the whole expression
1473 // being true, so we can divy up True count between the short circuit and
1474 // the RHS.
Justin Bogner66242d62015-04-23 23:06:47 +00001475 uint64_t LHSCount =
1476 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
Justin Bogneref512b92014-01-06 22:27:43 +00001477 uint64_t RHSCount = TrueCount - LHSCount;
John McCallce1de612011-01-26 04:00:11 +00001478
1479 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001480 {
1481 ApplyDebugLocation DL(*this, Cond);
1482 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount);
1483 EmitBlock(LHSFalse);
1484 }
Mike Stump11289f42009-09-09 15:08:12 +00001485
Justin Bogner66242d62015-04-23 23:06:47 +00001486 incrementProfileCounter(CondBOp);
1487 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1488
Anders Carlsson60ddba62010-01-24 00:20:05 +00001489 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001490 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001491 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount);
1492
John McCallce1de612011-01-26 04:00:11 +00001493 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001494
Chris Lattnercd439292008-11-12 08:04:58 +00001495 return;
1496 }
Chris Lattnerd9537732008-11-12 08:13:36 +00001497 }
Mike Stump11289f42009-09-09 15:08:12 +00001498
Chris Lattnerd9537732008-11-12 08:13:36 +00001499 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
1500 // br(!x, t, f) -> br(x, f, t)
Justin Bogneref512b92014-01-06 22:27:43 +00001501 if (CondUOp->getOpcode() == UO_LNot) {
1502 // Negate the count.
Justin Bogner66242d62015-04-23 23:06:47 +00001503 uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
Justin Bogneref512b92014-01-06 22:27:43 +00001504 // Negate the condition and swap the destination blocks.
1505 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1506 FalseCount);
1507 }
Chris Lattnercd439292008-11-12 08:04:58 +00001508 }
Mike Stump11289f42009-09-09 15:08:12 +00001509
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001510 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
Eli Friedman248f8982012-02-14 03:54:45 +00001511 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
1512 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
1513 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001514
Eli Friedman248f8982012-02-14 03:54:45 +00001515 ConditionalEvaluation cond(*this);
Justin Bogner66242d62015-04-23 23:06:47 +00001516 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1517 getProfileCount(CondOp));
Justin Bogneref512b92014-01-06 22:27:43 +00001518
1519 // When computing PGO branch weights, we only know the overall count for
1520 // the true block. This code is essentially doing tail duplication of the
1521 // naive code-gen, introducing new edges for which counts are not
1522 // available. Divide the counts proportionally between the LHS and RHS of
1523 // the conditional operator.
1524 uint64_t LHSScaledTrueCount = 0;
1525 if (TrueCount) {
Justin Bogner66242d62015-04-23 23:06:47 +00001526 double LHSRatio =
1527 getProfileCount(CondOp) / (double)getCurrentProfileCount();
Justin Bogneref512b92014-01-06 22:27:43 +00001528 LHSScaledTrueCount = TrueCount * LHSRatio;
1529 }
John McCallce1de612011-01-26 04:00:11 +00001530
Eli Friedman248f8982012-02-14 03:54:45 +00001531 cond.begin(*this);
1532 EmitBlock(LHSBlock);
Justin Bogner66242d62015-04-23 23:06:47 +00001533 incrementProfileCounter(CondOp);
David Blaikie298720d2015-01-28 19:50:09 +00001534 {
1535 ApplyDebugLocation DL(*this, Cond);
1536 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1537 LHSScaledTrueCount);
1538 }
Eli Friedman248f8982012-02-14 03:54:45 +00001539 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001540
Eli Friedman248f8982012-02-14 03:54:45 +00001541 cond.begin(*this);
1542 EmitBlock(RHSBlock);
Justin Bogneref512b92014-01-06 22:27:43 +00001543 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1544 TrueCount - LHSScaledTrueCount);
Eli Friedman248f8982012-02-14 03:54:45 +00001545 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001546
Eli Friedman248f8982012-02-14 03:54:45 +00001547 return;
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001548 }
1549
Richard Smithea852322013-05-07 21:53:22 +00001550 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
1551 // Conditional operator handling can give us a throw expression as a
1552 // condition for a case like:
1553 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
1554 // Fold this to:
1555 // br(c, throw x, br(y, t, f))
1556 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
1557 return;
1558 }
1559
Sanjay Patela24296b2015-09-02 20:01:30 +00001560 // If the branch has a condition wrapped by __builtin_unpredictable,
1561 // create metadata that specifies that the branch is unpredictable.
1562 // Don't bother if not optimizing because that metadata would not be used.
1563 llvm::MDNode *Unpredictable = nullptr;
Sanjay Patel3fd323f2016-04-19 18:06:33 +00001564 auto *Call = dyn_cast<CallExpr>(Cond);
1565 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1566 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1567 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1568 llvm::MDBuilder MDHelper(getLLVMContext());
1569 Unpredictable = MDHelper.createUnpredictable();
Sanjay Patela24296b2015-09-02 20:01:30 +00001570 }
1571 }
1572
Justin Bogneref512b92014-01-06 22:27:43 +00001573 // Create branch weights based on the number of times we get here and the
1574 // number of times the condition should be true.
Justin Bogner66242d62015-04-23 23:06:47 +00001575 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
Justin Bogner65512642015-05-02 05:00:55 +00001576 llvm::MDNode *Weights =
1577 createProfileWeights(TrueCount, CurrentCount - TrueCount);
Justin Bogneref512b92014-01-06 22:27:43 +00001578
Chris Lattnercd439292008-11-12 08:04:58 +00001579 // Emit the code with the fully general case.
David Blaikie303facb2015-01-31 01:10:11 +00001580 llvm::Value *CondV;
1581 {
1582 ApplyDebugLocation DL(*this, Cond);
1583 CondV = EvaluateExprAsBool(Cond);
1584 }
Sanjay Patela24296b2015-09-02 20:01:30 +00001585 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
Chris Lattnercd439292008-11-12 08:04:58 +00001586}
1587
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001588/// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001589/// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001590void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
1591 CGM.ErrorUnsupported(S, Type);
Chris Lattnerfc944342007-12-02 01:43:38 +00001592}
1593
John McCall2725aa12011-02-01 21:35:06 +00001594/// emitNonZeroVLAInit - Emit the "zero" initialization of a
1595/// variable-length array whose elements have a non-zero bit-pattern.
1596///
James Dennettbe302452012-06-15 22:10:14 +00001597/// \param baseType the inner-most element type of the array
John McCall2725aa12011-02-01 21:35:06 +00001598/// \param src - a char* pointing to the bit-pattern for a single
1599/// base element of the array
1600/// \param sizeInChars - the total size of the VLA, in chars
John McCall2725aa12011-02-01 21:35:06 +00001601static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001602 Address dest, Address src,
John McCall2725aa12011-02-01 21:35:06 +00001603 llvm::Value *sizeInChars) {
John McCall2725aa12011-02-01 21:35:06 +00001604 CGBuilderTy &Builder = CGF.Builder;
1605
John McCall7f416cc2015-09-08 08:05:57 +00001606 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
John McCall2725aa12011-02-01 21:35:06 +00001607 llvm::Value *baseSizeInChars
John McCall7f416cc2015-09-08 08:05:57 +00001608 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
John McCall2725aa12011-02-01 21:35:06 +00001609
John McCall7f416cc2015-09-08 08:05:57 +00001610 Address begin =
1611 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1612 llvm::Value *end =
1613 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end");
John McCall2725aa12011-02-01 21:35:06 +00001614
1615 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
1616 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
1617 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
1618
1619 // Make a loop over the VLA. C99 guarantees that the VLA element
1620 // count must be nonzero.
1621 CGF.EmitBlock(loopBB);
1622
John McCall7f416cc2015-09-08 08:05:57 +00001623 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
1624 cur->addIncoming(begin.getPointer(), originBB);
1625
1626 CharUnits curAlign =
1627 dest.getAlignment().alignmentOfArrayElement(baseSize);
John McCall2725aa12011-02-01 21:35:06 +00001628
1629 // memcpy the individual element bit-pattern.
John McCall7f416cc2015-09-08 08:05:57 +00001630 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
John McCall2725aa12011-02-01 21:35:06 +00001631 /*volatile*/ false);
1632
1633 // Go to the next element.
John McCall7f416cc2015-09-08 08:05:57 +00001634 llvm::Value *next =
1635 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
John McCall2725aa12011-02-01 21:35:06 +00001636
1637 // Leave if that's the end of the VLA.
1638 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
1639 Builder.CreateCondBr(done, contBB, loopBB);
1640 cur->addIncoming(next, loopBB);
1641
1642 CGF.EmitBlock(contBB);
Michael Ilseman686240a2012-12-04 00:29:55 +00001643}
John McCall2725aa12011-02-01 21:35:06 +00001644
Anders Carlssonc0964b62010-05-22 17:35:42 +00001645void
John McCall7f416cc2015-09-08 08:05:57 +00001646CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001647 // Ignore empty classes in C++.
Richard Smith9c6890a2012-11-01 22:30:59 +00001648 if (getLangOpts().CPlusPlus) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001649 if (const RecordType *RT = Ty->getAs<RecordType>()) {
1650 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
1651 return;
1652 }
1653 }
John McCall7cd1d972010-08-07 08:21:30 +00001654
1655 // Cast the dest ptr to the appropriate i8 pointer type.
John McCall7f416cc2015-09-08 08:05:57 +00001656 if (DestPtr.getElementType() != Int8Ty)
1657 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001658
1659 // Get size and alignment info for this aggregate.
John McCall7f416cc2015-09-08 08:05:57 +00001660 CharUnits size = getContext().getTypeSizeInChars(Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001661
John McCalla08ffd22011-01-14 10:37:58 +00001662 llvm::Value *SizeVal;
John McCall2725aa12011-02-01 21:35:06 +00001663 const VariableArrayType *vla;
Mike Stump11289f42009-09-09 15:08:12 +00001664
John McCalla08ffd22011-01-14 10:37:58 +00001665 // Don't bother emitting a zero-byte memset.
John McCall7f416cc2015-09-08 08:05:57 +00001666 if (size.isZero()) {
John McCalla08ffd22011-01-14 10:37:58 +00001667 // But note that getTypeInfo returns 0 for a VLA.
1668 if (const VariableArrayType *vlaType =
1669 dyn_cast_or_null<VariableArrayType>(
1670 getContext().getAsArrayType(Ty))) {
John McCall23c29fe2011-06-24 21:55:10 +00001671 QualType eltType;
1672 llvm::Value *numElts;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001673 std::tie(numElts, eltType) = getVLASize(vlaType);
John McCall23c29fe2011-06-24 21:55:10 +00001674
1675 SizeVal = numElts;
1676 CharUnits eltSize = getContext().getTypeSizeInChars(eltType);
1677 if (!eltSize.isOne())
1678 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
John McCall2725aa12011-02-01 21:35:06 +00001679 vla = vlaType;
John McCalla08ffd22011-01-14 10:37:58 +00001680 } else {
1681 return;
1682 }
1683 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001684 SizeVal = CGM.getSize(size);
Craig Topper8a13c412014-05-21 05:09:00 +00001685 vla = nullptr;
John McCalla08ffd22011-01-14 10:37:58 +00001686 }
John McCall7cd1d972010-08-07 08:21:30 +00001687
1688 // If the type contains a pointer to data member we can't memset it to zero.
1689 // Instead, create a null constant and copy it to the destination.
John McCall2725aa12011-02-01 21:35:06 +00001690 // TODO: there are other patterns besides zero that we can usefully memset,
1691 // like -1, which happens to be the pattern used by member-pointers.
John McCall614dbdc2010-08-22 21:01:12 +00001692 if (!CGM.getTypes().isZeroInitializable(Ty)) {
John McCall2725aa12011-02-01 21:35:06 +00001693 // For a VLA, emit a single element, then splat that over the VLA.
1694 if (vla) Ty = getContext().getBaseElementType(vla);
John McCalla08ffd22011-01-14 10:37:58 +00001695
John McCall7cd1d972010-08-07 08:21:30 +00001696 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
1697
Michael Ilseman686240a2012-12-04 00:29:55 +00001698 llvm::GlobalVariable *NullVariable =
John McCall7cd1d972010-08-07 08:21:30 +00001699 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
Michael Ilseman686240a2012-12-04 00:29:55 +00001700 /*isConstant=*/true,
John McCall7cd1d972010-08-07 08:21:30 +00001701 llvm::GlobalVariable::PrivateLinkage,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001702 NullConstant, Twine());
John McCall7f416cc2015-09-08 08:05:57 +00001703 CharUnits NullAlign = DestPtr.getAlignment();
1704 NullVariable->setAlignment(NullAlign.getQuantity());
1705 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
1706 NullAlign);
John McCall7cd1d972010-08-07 08:21:30 +00001707
John McCall2725aa12011-02-01 21:35:06 +00001708 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
1709
John McCall7cd1d972010-08-07 08:21:30 +00001710 // Get and call the appropriate llvm.memcpy overload.
John McCall7f416cc2015-09-08 08:05:57 +00001711 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
John McCall7cd1d972010-08-07 08:21:30 +00001712 return;
Michael Ilseman686240a2012-12-04 00:29:55 +00001713 }
1714
John McCall7cd1d972010-08-07 08:21:30 +00001715 // Otherwise, just memset the whole thing to zero. This is legal
1716 // because in LLVM, all default initializers (other than the ones we just
1717 // handled above) are guaranteed to have a bit pattern of all zeros.
John McCall7f416cc2015-09-08 08:05:57 +00001718 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001719}
1720
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001721llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001722 // Make sure that there is a block for the indirect goto.
Craig Topper8a13c412014-05-21 05:09:00 +00001723 if (!IndirectBranch)
Chris Lattner6c4d2552009-10-28 23:59:40 +00001724 GetIndirectGotoBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001725
John McCallad5d61e2010-07-23 21:56:41 +00001726 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001727
Chris Lattner6c4d2552009-10-28 23:59:40 +00001728 // Make sure the indirect branch includes all of the address-taken blocks.
1729 IndirectBranch->addDestination(BB);
1730 return llvm::BlockAddress::get(CurFn, BB);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001731}
1732
1733llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001734 // If we already made the indirect branch for indirect goto, return its block.
1735 if (IndirectBranch) return IndirectBranch->getParent();
Michael Ilseman686240a2012-12-04 00:29:55 +00001736
John McCall7f416cc2015-09-08 08:05:57 +00001737 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
Michael Ilseman686240a2012-12-04 00:29:55 +00001738
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001739 // Create the PHI node that indirect gotos will add entries to.
Jay Foad20c0f022011-03-30 11:28:58 +00001740 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
1741 "indirect.goto.dest");
Michael Ilseman686240a2012-12-04 00:29:55 +00001742
Chris Lattner6c4d2552009-10-28 23:59:40 +00001743 // Create the indirect branch instruction.
1744 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
1745 return IndirectBranch->getParent();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001746}
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001747
John McCall82fe67b2011-07-09 01:37:26 +00001748/// Computes the length of an array in elements, as well as the base
1749/// element type and a properly-typed first element pointer.
1750llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1751 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001752 Address &addr) {
John McCall82fe67b2011-07-09 01:37:26 +00001753 const ArrayType *arrayType = origArrayType;
1754
1755 // If it's a VLA, we have to load the stored size. Note that
1756 // this is the size of the VLA in bytes, not its size in elements.
Craig Topper8a13c412014-05-21 05:09:00 +00001757 llvm::Value *numVLAElements = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001758 if (isa<VariableArrayType>(arrayType)) {
1759 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).first;
1760
1761 // Walk into all VLAs. This doesn't require changes to addr,
1762 // which has type T* where T is the first non-VLA element type.
1763 do {
1764 QualType elementType = arrayType->getElementType();
1765 arrayType = getContext().getAsArrayType(elementType);
1766
1767 // If we only have VLA components, 'addr' requires no adjustment.
1768 if (!arrayType) {
1769 baseType = elementType;
1770 return numVLAElements;
1771 }
1772 } while (isa<VariableArrayType>(arrayType));
1773
1774 // We get out here only if we find a constant array type
1775 // inside the VLA.
1776 }
1777
1778 // We have some number of constant-length arrays, so addr should
1779 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks
1780 // down to the first element of addr.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001781 SmallVector<llvm::Value*, 8> gepIndices;
John McCall82fe67b2011-07-09 01:37:26 +00001782
1783 // GEP down to the array type.
1784 llvm::ConstantInt *zero = Builder.getInt32(0);
1785 gepIndices.push_back(zero);
1786
John McCall82fe67b2011-07-09 01:37:26 +00001787 uint64_t countFromCLAs = 1;
Richard Smithf3c37e82012-04-22 05:51:36 +00001788 QualType eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001789
Chris Lattner2192fe52011-07-18 04:24:23 +00001790 llvm::ArrayType *llvmArrayType =
John McCall7f416cc2015-09-08 08:05:57 +00001791 dyn_cast<llvm::ArrayType>(addr.getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001792 while (llvmArrayType) {
John McCall82fe67b2011-07-09 01:37:26 +00001793 assert(isa<ConstantArrayType>(arrayType));
1794 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1795 == llvmArrayType->getNumElements());
1796
1797 gepIndices.push_back(zero);
1798 countFromCLAs *= llvmArrayType->getNumElements();
Richard Smithf3c37e82012-04-22 05:51:36 +00001799 eltType = arrayType->getElementType();
John McCall82fe67b2011-07-09 01:37:26 +00001800
1801 llvmArrayType =
1802 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
John McCall82fe67b2011-07-09 01:37:26 +00001803 arrayType = getContext().getAsArrayType(arrayType->getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001804 assert((!llvmArrayType || arrayType) &&
1805 "LLVM and Clang types are out-of-synch");
John McCall82fe67b2011-07-09 01:37:26 +00001806 }
1807
Richard Smithf3c37e82012-04-22 05:51:36 +00001808 if (arrayType) {
1809 // From this point onwards, the Clang array type has been emitted
1810 // as some other type (probably a packed struct). Compute the array
1811 // size, and just emit the 'begin' expression as a bitcast.
1812 while (arrayType) {
1813 countFromCLAs *=
1814 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1815 eltType = arrayType->getElementType();
1816 arrayType = getContext().getAsArrayType(eltType);
1817 }
John McCall82fe67b2011-07-09 01:37:26 +00001818
John McCall7f416cc2015-09-08 08:05:57 +00001819 llvm::Type *baseType = ConvertType(eltType);
1820 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
Richard Smithf3c37e82012-04-22 05:51:36 +00001821 } else {
1822 // Create the actual GEP.
John McCall7f416cc2015-09-08 08:05:57 +00001823 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(),
1824 gepIndices, "array.begin"),
1825 addr.getAlignment());
Richard Smithf3c37e82012-04-22 05:51:36 +00001826 }
1827
1828 baseType = eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001829
1830 llvm::Value *numElements
1831 = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1832
1833 // If we had any VLA dimensions, factor them in.
1834 if (numVLAElements)
1835 numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1836
1837 return numElements;
1838}
1839
John McCall23c29fe2011-06-24 21:55:10 +00001840std::pair<llvm::Value*, QualType>
1841CodeGenFunction::getVLASize(QualType type) {
1842 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1843 assert(vla && "type was not a variable array type!");
1844 return getVLASize(vla);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001845}
Anders Carlssonccbe9202008-12-12 07:19:02 +00001846
John McCall23c29fe2011-06-24 21:55:10 +00001847std::pair<llvm::Value*, QualType>
1848CodeGenFunction::getVLASize(const VariableArrayType *type) {
1849 // The number of elements so far; always size_t.
Craig Topper8a13c412014-05-21 05:09:00 +00001850 llvm::Value *numElements = nullptr;
John McCall23c29fe2011-06-24 21:55:10 +00001851
1852 QualType elementType;
1853 do {
1854 elementType = type->getElementType();
1855 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1856 assert(vlaSize && "no size for VLA!");
1857 assert(vlaSize->getType() == SizeTy);
1858
1859 if (!numElements) {
1860 numElements = vlaSize;
1861 } else {
1862 // It's undefined behavior if this wraps around, so mark it that way.
Alexey Samsonovcb3f8122014-03-20 10:48:29 +00001863 // FIXME: Teach -fsanitize=undefined to trap this.
John McCall23c29fe2011-06-24 21:55:10 +00001864 numElements = Builder.CreateNUWMul(numElements, vlaSize);
1865 }
1866 } while ((type = getContext().getAsVariableArrayType(elementType)));
1867
1868 return std::pair<llvm::Value*,QualType>(numElements, elementType);
1869}
1870
1871void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
1872 assert(type->isVariablyModifiedType() &&
Anders Carlsson8a01b792008-12-20 20:46:34 +00001873 "Must pass variably modified type to EmitVLASizes!");
Mike Stump11289f42009-09-09 15:08:12 +00001874
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001875 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00001876
John McCall23c29fe2011-06-24 21:55:10 +00001877 // We're going to walk down into the type and look for VLA
1878 // expressions.
John McCall23c29fe2011-06-24 21:55:10 +00001879 do {
1880 assert(type->isVariablyModifiedType());
Mike Stump11289f42009-09-09 15:08:12 +00001881
John McCall23c29fe2011-06-24 21:55:10 +00001882 const Type *ty = type.getTypePtr();
1883 switch (ty->getTypeClass()) {
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001884
John McCall23c29fe2011-06-24 21:55:10 +00001885#define TYPE(Class, Base)
1886#define ABSTRACT_TYPE(Class, Base)
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001887#define NON_CANONICAL_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001888#define DEPENDENT_TYPE(Class, Base) case Type::Class:
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001889#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001890#include "clang/AST/TypeNodes.def"
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001891 llvm_unreachable("unexpected dependent type!");
Mike Stump11289f42009-09-09 15:08:12 +00001892
John McCall23c29fe2011-06-24 21:55:10 +00001893 // These types are never variably-modified.
1894 case Type::Builtin:
1895 case Type::Complex:
1896 case Type::Vector:
1897 case Type::ExtVector:
1898 case Type::Record:
1899 case Type::Enum:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001900 case Type::Elaborated:
1901 case Type::TemplateSpecialization:
Manman Rene6be26c2016-09-13 17:25:08 +00001902 case Type::ObjCTypeParam:
John McCall23c29fe2011-06-24 21:55:10 +00001903 case Type::ObjCObject:
1904 case Type::ObjCInterface:
1905 case Type::ObjCObjectPointer:
1906 llvm_unreachable("type class is never variably-modified!");
Mike Stump11289f42009-09-09 15:08:12 +00001907
Reid Kleckner0503a872013-12-05 01:23:43 +00001908 case Type::Adjusted:
1909 type = cast<AdjustedType>(ty)->getAdjustedType();
1910 break;
1911
Reid Kleckner8a365022013-06-24 17:51:48 +00001912 case Type::Decayed:
1913 type = cast<DecayedType>(ty)->getPointeeType();
1914 break;
1915
John McCall23c29fe2011-06-24 21:55:10 +00001916 case Type::Pointer:
1917 type = cast<PointerType>(ty)->getPointeeType();
1918 break;
Mike Stump11289f42009-09-09 15:08:12 +00001919
John McCall23c29fe2011-06-24 21:55:10 +00001920 case Type::BlockPointer:
1921 type = cast<BlockPointerType>(ty)->getPointeeType();
1922 break;
1923
1924 case Type::LValueReference:
1925 case Type::RValueReference:
1926 type = cast<ReferenceType>(ty)->getPointeeType();
1927 break;
1928
1929 case Type::MemberPointer:
1930 type = cast<MemberPointerType>(ty)->getPointeeType();
1931 break;
1932
1933 case Type::ConstantArray:
1934 case Type::IncompleteArray:
1935 // Losing element qualification here is fine.
1936 type = cast<ArrayType>(ty)->getElementType();
1937 break;
1938
1939 case Type::VariableArray: {
1940 // Losing element qualification here is fine.
1941 const VariableArrayType *vat = cast<VariableArrayType>(ty);
1942
1943 // Unknown size indication requires no size computation.
1944 // Otherwise, evaluate and record it.
1945 if (const Expr *size = vat->getSizeExpr()) {
1946 // It's possible that we might have emitted this already,
1947 // e.g. with a typedef and a pointer to it.
1948 llvm::Value *&entry = VLASizeMap[size];
1949 if (!entry) {
Richard Smith481652b2012-10-10 01:11:12 +00001950 llvm::Value *Size = EmitScalarExpr(size);
1951
1952 // C11 6.7.6.2p5:
1953 // If the size is an expression that is not an integer constant
1954 // expression [...] each time it is evaluated it shall have a value
1955 // greater than zero.
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001956 if (SanOpts.has(SanitizerKind::VLABound) &&
Richard Smithb1b0ab42012-11-05 22:21:05 +00001957 size->getType()->isSignedIntegerType()) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001958 SanitizerScope SanScope(this);
Richard Smith481652b2012-10-10 01:11:12 +00001959 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
1960 llvm::Constant *StaticArgs[] = {
1961 EmitCheckSourceLocation(size->getLocStart()),
1962 EmitCheckTypeDescriptor(size->getType())
1963 };
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001964 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
1965 SanitizerKind::VLABound),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00001966 SanitizerHandler::VLABoundNotPositive, StaticArgs, Size);
Richard Smith481652b2012-10-10 01:11:12 +00001967 }
1968
John McCall23c29fe2011-06-24 21:55:10 +00001969 // Always zexting here would be wrong if it weren't
1970 // undefined behavior to have a negative bound.
Richard Smith8772bd82012-10-10 01:12:11 +00001971 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
John McCall23c29fe2011-06-24 21:55:10 +00001972 }
1973 }
1974 type = vat->getElementType();
1975 break;
Anders Carlsson8a01b792008-12-20 20:46:34 +00001976 }
Mike Stump11289f42009-09-09 15:08:12 +00001977
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001978 case Type::FunctionProto:
John McCall23c29fe2011-06-24 21:55:10 +00001979 case Type::FunctionNoProto:
Alp Toker314cc812014-01-25 16:55:45 +00001980 type = cast<FunctionType>(ty)->getReturnType();
John McCall23c29fe2011-06-24 21:55:10 +00001981 break;
Eli Friedman0dfb8892011-10-06 23:00:33 +00001982
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001983 case Type::Paren:
1984 case Type::TypeOf:
1985 case Type::UnaryTransform:
1986 case Type::Attributed:
1987 case Type::SubstTemplateTypeParm:
David Blaikie66ed89d2013-07-13 21:08:08 +00001988 case Type::PackExpansion:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001989 // Keep walking after single level desugaring.
1990 type = type.getSingleStepDesugaredType(getContext());
1991 break;
1992
1993 case Type::Typedef:
1994 case Type::Decltype:
1995 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00001996 case Type::DeducedTemplateSpecialization:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001997 // Stop walking: nothing to do.
1998 return;
1999
2000 case Type::TypeOfExpr:
2001 // Stop walking: emit typeof expression.
2002 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
2003 return;
2004
Eli Friedman0dfb8892011-10-06 23:00:33 +00002005 case Type::Atomic:
2006 type = cast<AtomicType>(ty)->getValueType();
2007 break;
Xiuli Pan9c14e282016-01-09 12:53:17 +00002008
2009 case Type::Pipe:
2010 type = cast<PipeType>(ty)->getElementType();
2011 break;
John McCall23c29fe2011-06-24 21:55:10 +00002012 }
2013 } while (type->isVariablyModifiedType());
Anders Carlssonccbe9202008-12-12 07:19:02 +00002014}
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002015
John McCall7f416cc2015-09-08 08:05:57 +00002016Address CodeGenFunction::EmitVAListRef(const Expr* E) {
Dan Gohmane9e32dc2010-10-29 22:47:07 +00002017 if (getContext().getBuiltinVaListType()->isArrayType())
John McCall7f416cc2015-09-08 08:05:57 +00002018 return EmitPointerWithAlignment(E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002019 return EmitLValue(E).getAddress();
2020}
Anders Carlsson15cb75a2009-02-07 22:53:43 +00002021
Charles Davisc7d5c942015-09-17 20:55:33 +00002022Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
2023 return EmitLValue(E).getAddress();
2024}
2025
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002026void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002027 const APValue &Init) {
2028 assert(!Init.isUninit() && "Invalid DeclRefExpr initializer!");
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002029 if (CGDebugInfo *Dbg = getDebugInfo())
Benjamin Kramer8c305922016-02-02 11:06:51 +00002030 if (CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002031 Dbg->EmitGlobalVariable(E->getDecl(), Init);
Devang Patele03edfd2010-08-10 07:24:25 +00002032}
John McCallc07a0c72011-02-17 10:25:35 +00002033
2034CodeGenFunction::PeepholeProtection
2035CodeGenFunction::protectFromPeepholes(RValue rvalue) {
2036 // At the moment, the only aggressive peephole we do in IR gen
2037 // is trunc(zext) folding, but if we add more, we can easily
2038 // extend this protection.
2039
2040 if (!rvalue.isScalar()) return PeepholeProtection();
2041 llvm::Value *value = rvalue.getScalarVal();
2042 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
2043
2044 // Just make an extra bitcast.
2045 assert(HaveInsertPoint());
2046 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
2047 Builder.GetInsertBlock());
2048
2049 PeepholeProtection protection;
2050 protection.Inst = inst;
2051 return protection;
2052}
2053
2054void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
2055 if (!protection.Inst) return;
2056
2057 // In theory, we could try to duplicate the peepholes now, but whatever.
2058 protection.Inst->eraseFromParent();
2059}
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002060
2061llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Value *AnnotationFn,
2062 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002063 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002064 SourceLocation Location) {
2065 llvm::Value *Args[4] = {
2066 AnnotatedVal,
2067 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
2068 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
2069 CGM.EmitAnnotationLineNo(Location)
2070 };
2071 return Builder.CreateCall(AnnotationFn, Args);
2072}
2073
2074void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
2075 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2076 // FIXME We create a new bitcast for every annotation because that's what
2077 // llvm-gcc was doing.
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002078 for (const auto *I : D->specific_attrs<AnnotateAttr>())
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002079 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
2080 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002081 I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002082}
2083
John McCall7f416cc2015-09-08 08:05:57 +00002084Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
2085 Address Addr) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002086 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
John McCall7f416cc2015-09-08 08:05:57 +00002087 llvm::Value *V = Addr.getPointer();
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002088 llvm::Type *VTy = V->getType();
2089 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
2090 CGM.Int8PtrTy);
2091
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002092 for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002093 // FIXME Always emit the cast inst so we can differentiate between
2094 // annotation on the first field of a struct and annotation on the struct
2095 // itself.
2096 if (VTy != CGM.Int8PtrTy)
2097 V = Builder.Insert(new llvm::BitCastInst(V, CGM.Int8PtrTy));
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002098 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002099 V = Builder.CreateBitCast(V, VTy);
2100 }
2101
John McCall7f416cc2015-09-08 08:05:57 +00002102 return Address(V, Addr.getAlignment());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002103}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002104
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00002105CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
Alexander Musman515ad8c2014-05-22 08:54:05 +00002106
Alexey Samsonov24cad992014-07-17 18:46:27 +00002107CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
2108 : CGF(CGF) {
2109 assert(!CGF->IsSanitizerScope);
2110 CGF->IsSanitizerScope = true;
2111}
2112
2113CodeGenFunction::SanitizerScope::~SanitizerScope() {
2114 CGF->IsSanitizerScope = false;
2115}
2116
Alexander Musman515ad8c2014-05-22 08:54:05 +00002117void CodeGenFunction::InsertHelper(llvm::Instruction *I,
2118 const llvm::Twine &Name,
2119 llvm::BasicBlock *BB,
2120 llvm::BasicBlock::iterator InsertPt) const {
2121 LoopStack.InsertHelper(I);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00002122 if (IsSanitizerScope)
2123 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002124}
2125
Mehdi Amini557c20a2016-03-13 21:05:23 +00002126void CGBuilderInserter::InsertHelper(
Alexander Musman515ad8c2014-05-22 08:54:05 +00002127 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
2128 llvm::BasicBlock::iterator InsertPt) const {
Mehdi Amini557c20a2016-03-13 21:05:23 +00002129 llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002130 if (CGF)
2131 CGF->InsertHelper(I, Name, BB, InsertPt);
2132}
2133
David Blaikie5df253382015-11-12 01:09:58 +00002134static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures,
Eric Christopherce836772015-11-14 02:38:37 +00002135 CodeGenModule &CGM, const FunctionDecl *FD,
2136 std::string &FirstMissing) {
David Blaikie5df253382015-11-12 01:09:58 +00002137 // If there aren't any required features listed then go ahead and return.
2138 if (ReqFeatures.empty())
2139 return false;
2140
2141 // Now build up the set of caller features and verify that all the required
2142 // features are there.
2143 llvm::StringMap<bool> CallerFeatureMap;
2144 CGM.getFunctionFeatureMap(CallerFeatureMap, FD);
2145
2146 // If we have at least one of the features in the feature list return
2147 // true, otherwise return false.
2148 return std::all_of(
2149 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) {
2150 SmallVector<StringRef, 1> OrFeatures;
2151 Feature.split(OrFeatures, "|");
2152 return std::any_of(OrFeatures.begin(), OrFeatures.end(),
2153 [&](StringRef Feature) {
Eric Christopherce836772015-11-14 02:38:37 +00002154 if (!CallerFeatureMap.lookup(Feature)) {
2155 FirstMissing = Feature.str();
2156 return false;
2157 }
2158 return true;
David Blaikie5df253382015-11-12 01:09:58 +00002159 });
2160 });
2161}
2162
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002163// Emits an error if we don't have a valid set of target features for the
2164// called function.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002165void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
2166 const FunctionDecl *TargetDecl) {
2167 // Early exit if this is an indirect call.
2168 if (!TargetDecl)
2169 return;
2170
2171 // Get the current enclosing function if it exists. If it doesn't
2172 // we can't check the target features anyhow.
2173 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl);
2174 if (!FD)
2175 return;
2176
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002177 // Grab the required features for the call. For a builtin this is listed in
2178 // the td file with the default cpu, for an always_inline function this is any
2179 // listed cpu and any listed features.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002180 unsigned BuiltinID = TargetDecl->getBuiltinID();
Eric Christopherce836772015-11-14 02:38:37 +00002181 std::string MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002182 if (BuiltinID) {
2183 SmallVector<StringRef, 1> ReqFeatures;
2184 const char *FeatureList =
2185 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2186 // Return if the builtin doesn't have any required features.
2187 if (!FeatureList || StringRef(FeatureList) == "")
2188 return;
2189 StringRef(FeatureList).split(ReqFeatures, ",");
Eric Christopherce836772015-11-14 02:38:37 +00002190 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002191 CGM.getDiags().Report(E->getLocStart(), diag::err_builtin_needs_feature)
2192 << TargetDecl->getDeclName()
2193 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2194
2195 } else if (TargetDecl->hasAttr<TargetAttr>()) {
2196 // Get the required features for the callee.
2197 SmallVector<StringRef, 1> ReqFeatures;
2198 llvm::StringMap<bool> CalleeFeatureMap;
2199 CGM.getFunctionFeatureMap(CalleeFeatureMap, TargetDecl);
Eric Christopherb7bbc532015-11-16 18:29:59 +00002200 for (const auto &F : CalleeFeatureMap) {
2201 // Only positive features are "required".
2202 if (F.getValue())
2203 ReqFeatures.push_back(F.getKey());
2204 }
Eric Christopherce836772015-11-14 02:38:37 +00002205 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002206 CGM.getDiags().Report(E->getLocStart(), diag::err_function_needs_feature)
Eric Christopherce836772015-11-14 02:38:37 +00002207 << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002208 }
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002209}
Peter Collingbournedc134532016-01-16 00:31:22 +00002210
2211void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) {
2212 if (!CGM.getCodeGenOpts().SanitizeStats)
2213 return;
2214
2215 llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint());
2216 IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation());
2217 CGM.getSanStats().create(IRB, SSK);
2218}
Amara Emerson652795d2016-11-10 14:44:30 +00002219
2220llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) {
2221 if (CGDebugInfo *DI = getDebugInfo())
2222 return DI->SourceLocToDebugLoc(Location);
2223
2224 return llvm::DebugLoc();
2225}