blob: 6f7e06b773dc216ed6c34c5b21046b3bac0a8d6e [file] [log] [blame]
Chris Lattnerbed31442007-05-28 01:07:47 +00001//===--- CodeGenFunction.cpp - Emit LLVM Code from ASTs for a Function ----===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Chris Lattnerbed31442007-05-28 01:07:47 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This coordinates the per-function state used while generating code.
10//
11//===----------------------------------------------------------------------===//
12
13#include "CodeGenFunction.h"
John McCall7f416cc2015-09-08 08:05:57 +000014#include "CGBlocks.h"
Peter Collingbournefa4d6032011-10-06 18:51:56 +000015#include "CGCUDARuntime.h"
John McCall5d865c322010-08-31 07:33:07 +000016#include "CGCXXABI.h"
Reid Kleckner98031782019-12-09 16:11:56 -080017#include "CGCleanup.h"
Eli Friedman17630752008-05-22 01:40:10 +000018#include "CGDebugInfo.h"
Alexey Bataev9959db52014-05-06 10:08:46 +000019#include "CGOpenMPRuntime.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000021#include "CodeGenPGO.h"
Peter Collingbourneb453cd62013-10-20 21:29:19 +000022#include "TargetInfo.h"
Daniel Dunbarad319a72008-08-11 05:00:27 +000023#include "clang/AST/ASTContext.h"
Richard Smith376c28e2017-08-24 20:10:33 +000024#include "clang/AST/ASTLambda.h"
Reid Kleckner98031782019-12-09 16:11:56 -080025#include "clang/AST/Attr.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"
Richard Trieu63688182018-12-11 03:18:39 +000031#include "clang/Basic/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000032#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000033#include "clang/CodeGen/CGFunctionInfo.h"
Richard Trieu5337c742018-12-06 06:12:20 +000034#include "clang/Frontend/FrontendDiagnostic.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000035#include "llvm/IR/DataLayout.h"
Gor Nishanov04491bd2017-11-11 17:00:43 +000036#include "llvm/IR/Dominators.h"
Melanie Blower7f9b5132019-12-04 12:23:46 -080037#include "llvm/IR/FPEnv.h"
38#include "llvm/IR/IntrinsicInst.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000039#include "llvm/IR/Intrinsics.h"
40#include "llvm/IR/MDBuilder.h"
41#include "llvm/IR/Operator.h"
Gor Nishanov04491bd2017-11-11 17:00:43 +000042#include "llvm/Transforms/Utils/PromoteMemToReg.h"
Chris Lattnerbed31442007-05-28 01:07:47 +000043using namespace clang;
44using namespace CodeGen;
45
Vitaly Buka1c943322016-10-26 01:59:57 +000046/// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time
47/// markers.
48static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts,
49 const LangOptions &LangOpts) {
Mehdi Amini7f873072017-01-06 23:18:09 +000050 if (CGOpts.DisableLifetimeMarkers)
51 return false;
52
Vitaly Bukaaeca5692019-08-26 22:15:50 +000053 // Sanitizers may use markers.
54 if (CGOpts.SanitizeAddressUseAfterScope ||
Vitaly Buka669d1112019-08-26 22:16:05 +000055 LangOpts.Sanitize.has(SanitizerKind::HWAddress) ||
Vitaly Bukaaeca5692019-08-26 22:15:50 +000056 LangOpts.Sanitize.has(SanitizerKind::Memory))
Benjamin Kramer2a7d39d2017-03-31 09:19:25 +000057 return true;
58
Vitaly Buka1c943322016-10-26 01:59:57 +000059 // For now, only in optimized builds.
60 return CGOpts.OptimizationLevel != 0;
61}
62
Fariborz Jahanian63628032012-06-26 16:06:38 +000063CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext)
David Blaikie92848de2013-08-26 20:33:21 +000064 : CodeGenTypeCache(cgm), CGM(cgm), Target(cgm.getTarget()),
John McCall7f416cc2015-09-08 08:05:57 +000065 Builder(cgm, cgm.getModule().getContext(), llvm::ConstantFolder(),
David Blaikie8e90d222014-10-14 17:09:38 +000066 CGBuilderInserterTy(this)),
Erich Keanebe65e872018-07-10 21:07:50 +000067 SanOpts(CGM.getLangOpts().Sanitize), DebugInfo(CGM.getModuleDebugInfo()),
68 PGO(cgm), ShouldEmitLifetimeMarkers(shouldEmitLifetimeMarkers(
69 CGM.getCodeGenOpts(), CGM.getLangOpts())) {
Fariborz Jahanian63628032012-06-26 16:06:38 +000070 if (!suppressNewContext)
71 CGM.getCXXABI().getMangleContext().startNewFunction();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000072
73 llvm::FastMathFlags FMF;
74 if (CGM.getLangOpts().FastMath)
Sanjay Patel401aaee2017-11-06 16:27:36 +000075 FMF.setFast();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000076 if (CGM.getLangOpts().FiniteMathOnly) {
Benjamin Kramer7464efc2012-12-09 21:58:24 +000077 FMF.setNoNaNs();
78 FMF.setNoInfs();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000079 }
Pekka Jaaskelainen37014502014-12-10 16:41:14 +000080 if (CGM.getCodeGenOpts().NoNaNsFPMath) {
81 FMF.setNoNaNs();
82 }
83 if (CGM.getCodeGenOpts().NoSignedZeros) {
84 FMF.setNoSignedZeros();
85 }
Sanjay Patel359b1052015-04-09 15:03:23 +000086 if (CGM.getCodeGenOpts().ReciprocalMath) {
87 FMF.setAllowReciprocal();
88 }
Sanjay Patelcb8c0092017-12-16 16:11:17 +000089 if (CGM.getCodeGenOpts().Reassociate) {
90 FMF.setAllowReassoc();
91 }
Sanjay Pateld61f3c72016-01-12 18:03:41 +000092 Builder.setFastMathFlags(FMF);
Melanie Blower7f9b5132019-12-04 12:23:46 -080093 SetFPModel();
Chris Lattner5696e7b2008-06-17 18:05:57 +000094}
Chris Lattnerd1af2d22007-05-29 23:17:50 +000095
John McCall08ef4662011-11-10 08:15:53 +000096CodeGenFunction::~CodeGenFunction() {
Richard Smith736a9472013-06-12 20:42:33 +000097 assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup");
98
John McCall08ef4662011-11-10 08:15:53 +000099 // If there are any unclaimed block infos, go ahead and destroy them
100 // now. This can happen if IR-gen gets clever and skips evaluating
101 // something.
102 if (FirstBlockInfo)
103 destroyBlockInfos(FirstBlockInfo);
Alexey Bataev9959db52014-05-06 10:08:46 +0000104
Alexey Bataev880d8602017-01-20 08:57:28 +0000105 if (getLangOpts().OpenMP && CurFn)
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000106 CGM.getOpenMPRuntime().functionFinished(*this);
John McCall08ef4662011-11-10 08:15:53 +0000107}
108
Melanie Blower7f9b5132019-12-04 12:23:46 -0800109// Map the LangOption for rounding mode into
110// the corresponding enum in the IR.
111static llvm::fp::RoundingMode ToConstrainedRoundingMD(
112 LangOptions::FPRoundingModeKind Kind) {
113
114 switch (Kind) {
115 case LangOptions::FPR_ToNearest: return llvm::fp::rmToNearest;
116 case LangOptions::FPR_Downward: return llvm::fp::rmDownward;
117 case LangOptions::FPR_Upward: return llvm::fp::rmUpward;
118 case LangOptions::FPR_TowardZero: return llvm::fp::rmTowardZero;
119 case LangOptions::FPR_Dynamic: return llvm::fp::rmDynamic;
120 }
121 llvm_unreachable("Unsupported FP RoundingMode");
122}
123
124// Map the LangOption for exception behavior into
125// the corresponding enum in the IR.
126static llvm::fp::ExceptionBehavior ToConstrainedExceptMD(
127 LangOptions::FPExceptionModeKind Kind) {
128
129 switch (Kind) {
130 case LangOptions::FPE_Ignore: return llvm::fp::ebIgnore;
131 case LangOptions::FPE_MayTrap: return llvm::fp::ebMayTrap;
132 case LangOptions::FPE_Strict: return llvm::fp::ebStrict;
133 }
134 llvm_unreachable("Unsupported FP Exception Behavior");
135}
136
137void CodeGenFunction::SetFPModel() {
138 auto fpRoundingMode = ToConstrainedRoundingMD(
139 getLangOpts().getFPRoundingMode());
140 auto fpExceptionBehavior = ToConstrainedExceptMD(
141 getLangOpts().getFPExceptionMode());
142
143 if (fpExceptionBehavior == llvm::fp::ebIgnore &&
144 fpRoundingMode == llvm::fp::rmToNearest)
145 // Constrained intrinsics are not used.
146 ;
147 else {
148 Builder.setIsFPConstrained(true);
149 Builder.setDefaultConstrainedRounding(fpRoundingMode);
150 Builder.setDefaultConstrainedExcept(fpExceptionBehavior);
151 }
152}
153
John McCall7f416cc2015-09-08 08:05:57 +0000154CharUnits CodeGenFunction::getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +0000155 LValueBaseInfo *BaseInfo,
156 TBAAAccessInfo *TBAAInfo) {
157 return getNaturalTypeAlignment(T->getPointeeType(), BaseInfo, TBAAInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000158 /* forPointeeType= */ true);
David Majnemer99281062014-09-18 22:05:54 +0000159}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000160
John McCall7f416cc2015-09-08 08:05:57 +0000161CharUnits CodeGenFunction::getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000162 LValueBaseInfo *BaseInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000163 TBAAAccessInfo *TBAAInfo,
John McCall7f416cc2015-09-08 08:05:57 +0000164 bool forPointeeType) {
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000165 if (TBAAInfo)
166 *TBAAInfo = CGM.getTBAAAccessInfo(T);
167
John McCall7f416cc2015-09-08 08:05:57 +0000168 // Honor alignment typedef attributes even on incomplete types.
169 // We also honor them straight for C++ class types, even as pointees;
170 // there's an expressivity gap here.
171 if (auto TT = T->getAs<TypedefType>()) {
172 if (auto Align = TT->getDecl()->getMaxAlignment()) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000173 if (BaseInfo)
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +0000174 *BaseInfo = LValueBaseInfo(AlignmentSource::AttributedType);
John McCall7f416cc2015-09-08 08:05:57 +0000175 return getContext().toCharUnitsFromBits(Align);
176 }
177 }
178
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000179 if (BaseInfo)
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +0000180 *BaseInfo = LValueBaseInfo(AlignmentSource::Type);
John McCall7f416cc2015-09-08 08:05:57 +0000181
182 CharUnits Alignment;
David Majnemer9df56372015-09-10 21:52:00 +0000183 if (T->isIncompleteType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000184 Alignment = CharUnits::One(); // Shouldn't be used, but pessimistic is best.
185 } else {
186 // For C++ class pointees, we don't know whether we're pointing at a
187 // base or a complete object, so we generally need to use the
188 // non-virtual alignment.
189 const CXXRecordDecl *RD;
190 if (forPointeeType && (RD = T->getAsCXXRecordDecl())) {
191 Alignment = CGM.getClassPointerAlignment(RD);
192 } else {
193 Alignment = getContext().getTypeAlignInChars(T);
Roger Ferrer Ibanez3fa38a12017-03-08 14:00:44 +0000194 if (T.getQualifiers().hasUnaligned())
195 Alignment = CharUnits::One();
John McCall7f416cc2015-09-08 08:05:57 +0000196 }
197
198 // Cap to the global maximum type alignment unless the alignment
199 // was somehow explicit on the type.
200 if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) {
201 if (Alignment.getQuantity() > MaxAlign &&
202 !getContext().isAlignmentRequired(T))
203 Alignment = CharUnits::fromQuantity(MaxAlign);
204 }
205 }
206 return Alignment;
207}
208
209LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000210 LValueBaseInfo BaseInfo;
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000211 TBAAAccessInfo TBAAInfo;
212 CharUnits Alignment = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo);
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000213 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), BaseInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000214 TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000215}
216
217/// Given a value of type T* that may not be to a complete object,
218/// construct an l-value with the natural pointee alignment of T.
219LValue
220CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000221 LValueBaseInfo BaseInfo;
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000222 TBAAAccessInfo TBAAInfo;
223 CharUnits Align = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo,
224 /* forPointeeType= */ true);
225 return MakeAddrLValue(Address(V, Align), T, BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000226}
227
228
Chris Lattnera5f58b02011-07-09 17:41:47 +0000229llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) {
Daniel Dunbaree3da872009-02-03 23:03:55 +0000230 return CGM.getTypes().ConvertTypeForMem(T);
231}
232
Chris Lattnera5f58b02011-07-09 17:41:47 +0000233llvm::Type *CodeGenFunction::ConvertType(QualType T) {
Chris Lattnerf033c142007-06-22 19:05:19 +0000234 return CGM.getTypes().ConvertType(T);
Chris Lattner45bb9142007-06-09 02:28:57 +0000235}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000236
John McCall47fb9502013-03-07 21:37:08 +0000237TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) {
238 type = type.getCanonicalType();
239 while (true) {
240 switch (type->getTypeClass()) {
John McCall745ae282011-05-15 02:34:36 +0000241#define TYPE(name, parent)
242#define ABSTRACT_TYPE(name, parent)
243#define NON_CANONICAL_TYPE(name, parent) case Type::name:
244#define DEPENDENT_TYPE(name, parent) case Type::name:
245#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name:
John McCall36b12a82019-10-02 06:35:23 +0000246#include "clang/AST/TypeNodes.inc"
John McCall47fb9502013-03-07 21:37:08 +0000247 llvm_unreachable("non-canonical or dependent type in IR-generation");
John McCall745ae282011-05-15 02:34:36 +0000248
Richard Smith27d807c2013-04-30 13:56:41 +0000249 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +0000250 case Type::DeducedTemplateSpecialization:
251 llvm_unreachable("undeduced type in IR-generation");
Richard Smith27d807c2013-04-30 13:56:41 +0000252
John McCall47fb9502013-03-07 21:37:08 +0000253 // Various scalar types.
254 case Type::Builtin:
255 case Type::Pointer:
256 case Type::BlockPointer:
257 case Type::LValueReference:
258 case Type::RValueReference:
259 case Type::MemberPointer:
260 case Type::Vector:
261 case Type::ExtVector:
262 case Type::FunctionProto:
263 case Type::FunctionNoProto:
264 case Type::Enum:
265 case Type::ObjCObjectPointer:
Xiuli Pan9c14e282016-01-09 12:53:17 +0000266 case Type::Pipe:
John McCall47fb9502013-03-07 21:37:08 +0000267 return TEK_Scalar;
John McCall745ae282011-05-15 02:34:36 +0000268
John McCall47fb9502013-03-07 21:37:08 +0000269 // Complexes.
270 case Type::Complex:
271 return TEK_Complex;
Eli Friedman0dfb8892011-10-06 23:00:33 +0000272
John McCall47fb9502013-03-07 21:37:08 +0000273 // Arrays, records, and Objective-C objects.
274 case Type::ConstantArray:
275 case Type::IncompleteArray:
276 case Type::VariableArray:
277 case Type::Record:
278 case Type::ObjCObject:
279 case Type::ObjCInterface:
280 return TEK_Aggregate;
281
282 // We operate on atomic values according to their underlying type.
283 case Type::Atomic:
284 type = cast<AtomicType>(type)->getValueType();
285 continue;
286 }
287 llvm_unreachable("unknown type kind!");
John McCall745ae282011-05-15 02:34:36 +0000288 }
Chris Lattner54fb19e2007-06-22 22:02:34 +0000289}
290
David Blaikie66e41972015-01-14 07:38:27 +0000291llvm::DebugLoc CodeGenFunction::EmitReturnBlock() {
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000292 // For cleanliness, we try to avoid emitting the return block for
293 // simple cases.
294 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
295
296 if (CurBB) {
297 assert(!CurBB->getTerminator() && "Unexpected terminated block.");
298
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000299 // We have a valid insert point, reuse it if it is empty or there are no
300 // explicit jumps to the return block.
John McCallad5d61e2010-07-23 21:56:41 +0000301 if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) {
302 ReturnBlock.getBlock()->replaceAllUsesWith(CurBB);
303 delete ReturnBlock.getBlock();
John McCall8b36ac82019-04-10 17:03:09 +0000304 ReturnBlock = JumpDest();
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000305 } else
John McCallad5d61e2010-07-23 21:56:41 +0000306 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000307 return llvm::DebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000308 }
309
310 // Otherwise, if the return block is the target of a single direct
311 // branch then we can just put the code in that block instead. This
312 // cleans up functions which started with a unified return block.
John McCallad5d61e2010-07-23 21:56:41 +0000313 if (ReturnBlock.getBlock()->hasOneUse()) {
Mike Stump11289f42009-09-09 15:08:12 +0000314 llvm::BranchInst *BI =
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000315 dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin());
John McCallbd309292010-07-06 01:34:17 +0000316 if (BI && BI->isUnconditional() &&
John McCallad5d61e2010-07-23 21:56:41 +0000317 BI->getSuccessor(0) == ReturnBlock.getBlock()) {
David Blaikie66e41972015-01-14 07:38:27 +0000318 // Record/return the DebugLoc of the simple 'return' expression to be used
319 // later by the actual 'ret' instruction.
320 llvm::DebugLoc Loc = BI->getDebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000321 Builder.SetInsertPoint(BI->getParent());
322 BI->eraseFromParent();
John McCallad5d61e2010-07-23 21:56:41 +0000323 delete ReturnBlock.getBlock();
John McCall8b36ac82019-04-10 17:03:09 +0000324 ReturnBlock = JumpDest();
David Blaikie66e41972015-01-14 07:38:27 +0000325 return Loc;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000326 }
327 }
328
Mike Stump18bb9282009-05-16 07:57:57 +0000329 // FIXME: We are at an unreachable point, there is no reason to emit the block
330 // unless it has uses. However, we still need a place to put the debug
331 // region.end for now.
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000332
John McCallad5d61e2010-07-23 21:56:41 +0000333 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000334 return llvm::DebugLoc();
John McCallbd309292010-07-06 01:34:17 +0000335}
336
337static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) {
338 if (!BB) return;
339 if (!BB->use_empty())
340 return CGF.CurFn->getBasicBlockList().push_back(BB);
341 delete BB;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000342}
343
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000344void CodeGenFunction::FinishFunction(SourceLocation EndLoc) {
Chris Lattnere73e4322007-07-16 21:28:45 +0000345 assert(BreakContinueStack.empty() &&
346 "mismatched push/pop in break/continue stack!");
Mike Stump11289f42009-09-09 15:08:12 +0000347
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000348 bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0
Adrian Prantl524ba1f2013-07-25 00:23:42 +0000349 && NumSimpleReturnExprs == NumReturnExprs
350 && ReturnBlock.getBlock()->use_empty();
351 // Usually the return expression is evaluated before the cleanup
352 // code. If the function contains only a simple return statement,
353 // such as a constant, the location before the cleanup code becomes
354 // the last useful breakpoint in the function, because the simple
355 // return expression will be evaluated after the cleanup code. To be
356 // safe, set the debug location for cleanup code to the location of
357 // the return statement. Otherwise the cleanup code should be at the
358 // end of the function's lexical scope.
359 //
360 // If there are multiple branches to the return block, the branch
361 // instructions will get the location of the return statements and
362 // all will be fine.
Adrian Prantl3be10542013-05-02 17:30:20 +0000363 if (CGDebugInfo *DI = getDebugInfo()) {
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000364 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000365 DI->EmitLocation(Builder, LastStopPoint);
Adrian Prantl3be10542013-05-02 17:30:20 +0000366 else
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000367 DI->EmitLocation(Builder, EndLoc);
Adrian Prantl3be10542013-05-02 17:30:20 +0000368 }
David Blaikie357aafb2013-02-01 19:09:49 +0000369
John McCall31168b02011-06-15 23:02:42 +0000370 // Pop any cleanups that might have been associated with the
371 // parameters. Do this in whatever block we're currently in; it's
372 // important to do this before we enter the return block or return
373 // edges will be *really* confused.
David Majnemerdc012fa2015-04-22 21:38:15 +0000374 bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth;
375 bool HasOnlyLifetimeMarkers =
376 HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth);
377 bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers;
378 if (HasCleanups) {
Adrian Prantl3be10542013-05-02 17:30:20 +0000379 // Make sure the line table doesn't jump back into the body for
380 // the ret after it's been at EndLoc.
Adrian Prantl338588d2019-12-05 13:19:37 -0800381 Optional<ApplyDebugLocation> AL;
Adrian Prantlce7d3592019-12-05 12:26:16 -0800382 if (CGDebugInfo *DI = getDebugInfo()) {
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000383 if (OnlySimpleReturnStmts)
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000384 DI->EmitLocation(Builder, EndLoc);
Adrian Prantlce7d3592019-12-05 12:26:16 -0800385 else
Adrian Prantl338588d2019-12-05 13:19:37 -0800386 // We may not have a valid end location. Try to apply it anyway, and
387 // fall back to an artificial location if needed.
388 AL = ApplyDebugLocation::CreateDefaultArtificial(*this, EndLoc);
Adrian Prantlce7d3592019-12-05 12:26:16 -0800389 }
David Blaikie4d524432015-02-04 19:47:54 +0000390
391 PopCleanupBlocks(PrologueCleanupDepth);
Adrian Prantl3be10542013-05-02 17:30:20 +0000392 }
393
Mike Stump11289f42009-09-09 15:08:12 +0000394 // Emit function epilog (to return).
David Blaikie66e41972015-01-14 07:38:27 +0000395 llvm::DebugLoc Loc = EmitReturnBlock();
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000396
Hans Wennborg76c26c12017-11-14 21:13:27 +0000397 if (ShouldInstrumentFunction()) {
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000398 if (CGM.getCodeGenOpts().InstrumentFunctions)
399 CurFn->addFnAttr("instrument-function-exit", "__cyg_profile_func_exit");
400 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
401 CurFn->addFnAttr("instrument-function-exit-inlined",
402 "__cyg_profile_func_exit");
Hans Wennborg76c26c12017-11-14 21:13:27 +0000403 }
Chris Lattner3c77a352010-06-22 00:03:40 +0000404
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000405 // Emit debug descriptor for function end.
David Blaikie66e41972015-01-14 07:38:27 +0000406 if (CGDebugInfo *DI = getDebugInfo())
Keno Fischer41d4b4e2017-06-01 21:14:03 +0000407 DI->EmitFunctionEnd(Builder, CurFn);
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000408
David Blaikie66e41972015-01-14 07:38:27 +0000409 // Reset the debug location to that of the simple 'return' expression, if any
410 // rather than that of the end of the function's scope '}'.
411 ApplyDebugLocation AL(*this, Loc);
Nick Lewycky2d84e842013-10-02 02:29:49 +0000412 EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc);
Mike Stump1d849212009-12-07 23:38:24 +0000413 EmitEndEHSpec(CurCodeDecl);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000414
John McCallbd309292010-07-06 01:34:17 +0000415 assert(EHStack.empty() &&
416 "did not remove all scopes from cleanup stack!");
417
Chris Lattner6c4d2552009-10-28 23:59:40 +0000418 // If someone did an indirect goto, emit the indirect goto block at the end of
419 // the function.
420 if (IndirectBranch) {
421 EmitBlock(IndirectBranch->getParent());
422 Builder.ClearInsertionPoint();
423 }
Michael Ilseman686240a2012-12-04 00:29:55 +0000424
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000425 // If some of our locals escaped, insert a call to llvm.localescape in the
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000426 // entry block.
427 if (!EscapedLocals.empty()) {
428 // Invert the map from local to index into a simple vector. There should be
429 // no holes.
430 SmallVector<llvm::Value *, 4> EscapeArgs;
431 EscapeArgs.resize(EscapedLocals.size());
432 for (auto &Pair : EscapedLocals)
433 EscapeArgs[Pair.second] = Pair.first;
434 llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration(
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000435 &CGM.getModule(), llvm::Intrinsic::localescape);
John McCall7f416cc2015-09-08 08:05:57 +0000436 CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs);
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000437 }
438
Chris Lattnerc48023b2007-12-02 06:32:24 +0000439 // Remove the AllocaInsertPt instruction, which is just a convenience for us.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000440 llvm::Instruction *Ptr = AllocaInsertPt;
Craig Topper8a13c412014-05-21 05:09:00 +0000441 AllocaInsertPt = nullptr;
Chris Lattner2739d2b2009-03-31 22:17:44 +0000442 Ptr->eraseFromParent();
Michael Ilseman686240a2012-12-04 00:29:55 +0000443
Chris Lattner6c4d2552009-10-28 23:59:40 +0000444 // If someone took the address of a label but never did an indirect goto, we
445 // made a zero entry PHI node, which is illegal, zap it now.
446 if (IndirectBranch) {
447 llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress());
448 if (PN->getNumIncomingValues() == 0) {
449 PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType()));
450 PN->eraseFromParent();
451 }
452 }
John McCallbd309292010-07-06 01:34:17 +0000453
John McCall8e4c74b2011-08-11 02:22:43 +0000454 EmitIfUsed(*this, EHResumeBlock);
John McCallbd309292010-07-06 01:34:17 +0000455 EmitIfUsed(*this, TerminateLandingPad);
456 EmitIfUsed(*this, TerminateHandler);
457 EmitIfUsed(*this, UnreachableBlock);
John McCall09ae0322010-07-06 23:57:41 +0000458
Reid Kleckner06f19a02018-01-02 21:34:16 +0000459 for (const auto &FuncletAndParent : TerminateFunclets)
460 EmitIfUsed(*this, FuncletAndParent.second);
461
John McCall09ae0322010-07-06 23:57:41 +0000462 if (CGM.getCodeGenOpts().EmitDeclMetadata)
463 EmitDeclMetadata();
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000464
465 for (SmallVectorImpl<std::pair<llvm::Instruction *, llvm::Value *> >::iterator
466 I = DeferredReplacements.begin(),
467 E = DeferredReplacements.end();
468 I != E; ++I) {
469 I->first->replaceAllUsesWith(I->second);
470 I->first->eraseFromParent();
471 }
Gor Nishanov04491bd2017-11-11 17:00:43 +0000472
473 // Eliminate CleanupDestSlot alloca by replacing it with SSA values and
474 // PHIs if the current function is a coroutine. We don't do it for all
475 // functions as it may result in slight increase in numbers of instructions
476 // if compiled with no optimizations. We do it for coroutine as the lifetime
477 // of CleanupDestSlot alloca make correct coroutine frame building very
478 // difficult.
John McCall5cdf0382018-01-12 22:07:01 +0000479 if (NormalCleanupDest.isValid() && isCoroutine()) {
Gor Nishanov04491bd2017-11-11 17:00:43 +0000480 llvm::DominatorTree DT(*CurFn);
John McCall5cdf0382018-01-12 22:07:01 +0000481 llvm::PromoteMemToReg(
482 cast<llvm::AllocaInst>(NormalCleanupDest.getPointer()), DT);
483 NormalCleanupDest = Address::invalid();
Gor Nishanov04491bd2017-11-11 17:00:43 +0000484 }
Craig Topper74c10e32018-07-09 19:00:16 +0000485
Craig Topper3113ec32018-10-24 17:42:17 +0000486 // Scan function arguments for vector width.
487 for (llvm::Argument &A : CurFn->args())
488 if (auto *VT = dyn_cast<llvm::VectorType>(A.getType()))
Graham Hunterb3025612019-10-08 12:53:54 +0000489 LargestVectorWidth = std::max((uint64_t)LargestVectorWidth,
490 VT->getPrimitiveSizeInBits().getFixedSize());
Craig Topper3113ec32018-10-24 17:42:17 +0000491
492 // Update vector width based on return type.
493 if (auto *VT = dyn_cast<llvm::VectorType>(CurFn->getReturnType()))
Graham Hunterb3025612019-10-08 12:53:54 +0000494 LargestVectorWidth = std::max((uint64_t)LargestVectorWidth,
495 VT->getPrimitiveSizeInBits().getFixedSize());
Craig Topper3113ec32018-10-24 17:42:17 +0000496
497 // Add the required-vector-width attribute. This contains the max width from:
498 // 1. min-vector-width attribute used in the source program.
499 // 2. Any builtins used that have a vector width specified.
500 // 3. Values passed in and out of inline assembly.
501 // 4. Width of vector arguments and return types for this function.
502 // 5. Width of vector aguments and return types for functions called by this
503 // function.
Craig Topper00897e92018-10-25 05:04:35 +0000504 CurFn->addFnAttr("min-legal-vector-width", llvm::utostr(LargestVectorWidth));
John McCall8b36ac82019-04-10 17:03:09 +0000505
506 // If we generated an unreachable return block, delete it now.
507 if (ReturnBlock.isValid() && ReturnBlock.getBlock()->use_empty()) {
508 Builder.ClearInsertionPoint();
509 ReturnBlock.getBlock()->eraseFromParent();
510 }
511 if (ReturnValue.isValid()) {
512 auto *RetAlloca = dyn_cast<llvm::AllocaInst>(ReturnValue.getPointer());
513 if (RetAlloca && RetAlloca->use_empty()) {
514 RetAlloca->eraseFromParent();
515 ReturnValue = Address::invalid();
516 }
517 }
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000518}
Chris Lattner308f4312007-05-29 23:50:05 +0000519
Chris Lattner3c77a352010-06-22 00:03:40 +0000520/// ShouldInstrumentFunction - Return true if the current function should be
521/// instrumented with __cyg_profile_func_* calls
522bool CodeGenFunction::ShouldInstrumentFunction() {
Hans Wennborg76c26c12017-11-14 21:13:27 +0000523 if (!CGM.getCodeGenOpts().InstrumentFunctions &&
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000524 !CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining &&
525 !CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
Chris Lattner3c77a352010-06-22 00:03:40 +0000526 return false;
Ted Kremenekc249c412011-05-16 23:49:20 +0000527 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
Chris Lattner3c77a352010-06-22 00:03:40 +0000528 return false;
529 return true;
530}
531
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000532/// ShouldXRayInstrument - Return true if the current function should be
533/// instrumented with XRay nop sleds.
534bool CodeGenFunction::ShouldXRayInstrumentFunction() const {
535 return CGM.getCodeGenOpts().XRayInstrumentFunctions;
536}
537
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000538/// AlwaysEmitXRayCustomEvents - Return true if we should emit IR for calls to
Keith Wyssf437e352018-04-17 21:32:43 +0000539/// the __xray_customevent(...) builtin calls, when doing XRay instrumentation.
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000540bool CodeGenFunction::AlwaysEmitXRayCustomEvents() const {
Dean Michael Berris488f7c22018-04-13 02:31:58 +0000541 return CGM.getCodeGenOpts().XRayInstrumentFunctions &&
542 (CGM.getCodeGenOpts().XRayAlwaysEmitCustomEvents ||
543 CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask ==
544 XRayInstrKind::Custom);
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000545}
546
Keith Wyssf437e352018-04-17 21:32:43 +0000547bool CodeGenFunction::AlwaysEmitXRayTypedEvents() const {
548 return CGM.getCodeGenOpts().XRayInstrumentFunctions &&
549 (CGM.getCodeGenOpts().XRayAlwaysEmitTypedEvents ||
550 CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask ==
551 XRayInstrKind::Typed);
552}
553
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000554llvm::Constant *
555CodeGenFunction::EncodeAddrForUseInPrologue(llvm::Function *F,
556 llvm::Constant *Addr) {
557 // Addresses stored in prologue data can't require run-time fixups and must
558 // be PC-relative. Run-time fixups are undesirable because they necessitate
559 // writable text segments, which are unsafe. And absolute addresses are
560 // undesirable because they break PIE mode.
561
562 // Add a layer of indirection through a private global. Taking its address
563 // won't result in a run-time fixup, even if Addr has linkonce_odr linkage.
564 auto *GV = new llvm::GlobalVariable(CGM.getModule(), Addr->getType(),
565 /*isConstant=*/true,
566 llvm::GlobalValue::PrivateLinkage, Addr);
567
568 // Create a PC-relative address.
569 auto *GOTAsInt = llvm::ConstantExpr::getPtrToInt(GV, IntPtrTy);
570 auto *FuncAsInt = llvm::ConstantExpr::getPtrToInt(F, IntPtrTy);
571 auto *PCRelAsInt = llvm::ConstantExpr::getSub(GOTAsInt, FuncAsInt);
572 return (IntPtrTy == Int32Ty)
573 ? PCRelAsInt
574 : llvm::ConstantExpr::getTrunc(PCRelAsInt, Int32Ty);
575}
576
577llvm::Value *
578CodeGenFunction::DecodeAddrUsedInPrologue(llvm::Value *F,
579 llvm::Value *EncodedAddr) {
580 // Reconstruct the address of the global.
581 auto *PCRelAsInt = Builder.CreateSExt(EncodedAddr, IntPtrTy);
582 auto *FuncAsInt = Builder.CreatePtrToInt(F, IntPtrTy, "func_addr.int");
583 auto *GOTAsInt = Builder.CreateAdd(PCRelAsInt, FuncAsInt, "global_addr.int");
584 auto *GOTAddr = Builder.CreateIntToPtr(GOTAsInt, Int8PtrPtrTy, "global_addr");
585
586 // Load the original pointer through the global.
587 return Builder.CreateLoad(Address(GOTAddr, getPointerAlign()),
588 "decoded_addr");
589}
590
Michael Ilseman686240a2012-12-04 00:29:55 +0000591void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000592 llvm::Function *Fn)
593{
594 if (!FD->hasAttr<OpenCLKernelAttr>())
595 return;
596
597 llvm::LLVMContext &Context = getLLVMContext();
598
Anastasia Stulovae6cf6c72019-05-09 13:55:44 +0000599 CGM.GenOpenCLArgMetadata(Fn, FD, this);
Michael Ilseman686240a2012-12-04 00:29:55 +0000600
Aaron Ballmanc4327992013-12-19 03:09:10 +0000601 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000602 QualType HintQTy = A->getTypeHint();
603 const ExtVectorType *HintEltQTy = HintQTy->getAs<ExtVectorType>();
604 bool IsSignedInteger =
605 HintQTy->isSignedIntegerType() ||
606 (HintEltQTy && HintEltQTy->getElementType()->isSignedIntegerType());
607 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000608 llvm::ConstantAsMetadata::get(llvm::UndefValue::get(
609 CGM.getTypes().ConvertType(A->getTypeHint()))),
610 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
611 llvm::IntegerType::get(Context, 32),
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000612 llvm::APInt(32, (uint64_t)(IsSignedInteger ? 1 : 0))))};
613 Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, AttrMDArgs));
Joey Goulyaba589c2013-03-08 09:42:32 +0000614 }
615
Aaron Ballmanc4327992013-12-19 03:09:10 +0000616 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000617 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000618 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
619 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
620 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000621 Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000622 }
623
Aaron Ballmanc4327992013-12-19 03:09:10 +0000624 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000625 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000626 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
627 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
628 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000629 Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, AttrMDArgs));
630 }
631
632 if (const OpenCLIntelReqdSubGroupSizeAttr *A =
633 FD->getAttr<OpenCLIntelReqdSubGroupSizeAttr>()) {
634 llvm::Metadata *AttrMDArgs[] = {
635 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getSubGroupSize()))};
636 Fn->setMetadata("intel_reqd_sub_group_size",
637 llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000638 }
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000639}
640
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000641/// Determine whether the function F ends with a return stmt.
642static bool endsWithReturn(const Decl* F) {
643 const Stmt *Body = nullptr;
644 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F))
645 Body = FD->getBody();
646 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F))
647 Body = OMD->getBody();
648
649 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) {
650 auto LastStmt = CS->body_rbegin();
651 if (LastStmt != CS->body_rend())
652 return isa<ReturnStmt>(*LastStmt);
653 }
654 return false;
655}
656
Akira Hatanaka9978da32018-08-10 15:09:24 +0000657void CodeGenFunction::markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) {
658 if (SanOpts.has(SanitizerKind::Thread)) {
659 Fn->addFnAttr("sanitize_thread_no_checking_at_run_time");
660 Fn->removeFnAttr(llvm::Attribute::SanitizeThread);
661 }
Anna Zakse43b4fc2017-01-13 00:50:50 +0000662}
663
Reid Kleckner98031782019-12-09 16:11:56 -0800664/// Check if the return value of this function requires sanitization.
665bool CodeGenFunction::requiresReturnValueCheck() const {
666 return requiresReturnValueNullabilityCheck() ||
667 (SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) && CurCodeDecl &&
668 CurCodeDecl->getAttr<ReturnsNonNullAttr>());
669}
670
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000671static bool matchesStlAllocatorFn(const Decl *D, const ASTContext &Ctx) {
672 auto *MD = dyn_cast_or_null<CXXMethodDecl>(D);
673 if (!MD || !MD->getDeclName().getAsIdentifierInfo() ||
674 !MD->getDeclName().getAsIdentifierInfo()->isStr("allocate") ||
675 (MD->getNumParams() != 1 && MD->getNumParams() != 2))
676 return false;
677
678 if (MD->parameters()[0]->getType().getCanonicalType() != Ctx.getSizeType())
679 return false;
680
681 if (MD->getNumParams() == 2) {
682 auto *PT = MD->parameters()[1]->getType()->getAs<PointerType>();
683 if (!PT || !PT->isVoidPointerType() ||
684 !PT->getPointeeType().isConstQualified())
685 return false;
686 }
687
688 return true;
689}
690
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000691/// Return the UBSan prologue signature for \p FD if one is available.
692static llvm::Constant *getPrologueSignature(CodeGenModule &CGM,
693 const FunctionDecl *FD) {
694 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
695 if (!MD->isStatic())
696 return nullptr;
697 return CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM);
698}
699
Adrian Prantl2073dd22019-11-04 14:28:14 -0800700void CodeGenFunction::StartFunction(GlobalDecl GD, QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000701 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +0000702 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000703 const FunctionArgList &Args,
Adrian Prantl42d71b92014-04-10 23:21:53 +0000704 SourceLocation Loc,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +0000705 SourceLocation StartLoc) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000706 assert(!CurFn &&
707 "Do not use a CodeGenFunction object for more than one function");
708
Anders Carlsson73fcc952009-09-11 00:07:24 +0000709 const Decl *D = GD.getDecl();
Michael Ilseman686240a2012-12-04 00:29:55 +0000710
Anders Carlssonf4478e92009-02-09 20:20:56 +0000711 DidCallStackSave = false;
John McCalldec348f72013-05-03 07:33:41 +0000712 CurCodeDecl = D;
David Majnemer25eb1652016-03-01 19:42:53 +0000713 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D))
714 if (FD->usesSEHTry())
715 CurSEHParent = FD;
Craig Topper8a13c412014-05-21 05:09:00 +0000716 CurFuncDecl = (D ? D->getNonClosureContext() : nullptr);
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000717 FnRetTy = RetTy;
Daniel Dunbar9c426522008-07-29 23:18:29 +0000718 CurFn = Fn;
John McCalla738c252011-03-09 04:27:21 +0000719 CurFnInfo = &FnInfo;
Chris Lattner5696e7b2008-06-17 18:05:57 +0000720 assert(CurFn->isDeclaration() && "Function already has body?");
721
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +0000722 // If this function has been blacklisted for any of the enabled sanitizers,
723 // disable the sanitizer for the function.
724 do {
725#define SANITIZER(NAME, ID) \
726 if (SanOpts.empty()) \
727 break; \
728 if (SanOpts.has(SanitizerKind::ID)) \
729 if (CGM.isInSanitizerBlacklist(SanitizerKind::ID, Fn, Loc)) \
730 SanOpts.set(SanitizerKind::ID, false);
731
732#include "clang/Basic/Sanitizers.def"
733#undef SANITIZER
734 } while (0);
Will Dietzf54319c2013-01-18 11:30:38 +0000735
Peter Collingbourne915df992015-05-15 18:33:32 +0000736 if (D) {
737 // Apply the no_sanitize* attributes to SanOpts.
Vitaly Buka69a2e182018-04-09 20:10:29 +0000738 for (auto Attr : D->specific_attrs<NoSanitizeAttr>()) {
739 SanitizerMask mask = Attr->getMask();
740 SanOpts.Mask &= ~mask;
741 if (mask & SanitizerKind::Address)
742 SanOpts.set(SanitizerKind::KernelAddress, false);
743 if (mask & SanitizerKind::KernelAddress)
744 SanOpts.set(SanitizerKind::Address, false);
Andrey Konovalov1ba9d9c2018-04-13 18:05:21 +0000745 if (mask & SanitizerKind::HWAddress)
746 SanOpts.set(SanitizerKind::KernelHWAddress, false);
747 if (mask & SanitizerKind::KernelHWAddress)
748 SanOpts.set(SanitizerKind::HWAddress, false);
Vitaly Buka69a2e182018-04-09 20:10:29 +0000749 }
Peter Collingbourne915df992015-05-15 18:33:32 +0000750 }
751
752 // Apply sanitizer attributes to the function.
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000753 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress))
Peter Collingbourne915df992015-05-15 18:33:32 +0000754 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
Andrey Konovalov1ba9d9c2018-04-13 18:05:21 +0000755 if (SanOpts.hasOneOf(SanitizerKind::HWAddress | SanitizerKind::KernelHWAddress))
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000756 Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress);
Evgeniy Stepanovc5e7f562019-07-15 20:02:23 +0000757 if (SanOpts.has(SanitizerKind::MemTag))
758 Fn->addFnAttr(llvm::Attribute::SanitizeMemTag);
Peter Collingbourne915df992015-05-15 18:33:32 +0000759 if (SanOpts.has(SanitizerKind::Thread))
760 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
Alexander Potapenkod49c32c2018-09-07 09:21:09 +0000761 if (SanOpts.hasOneOf(SanitizerKind::Memory | SanitizerKind::KernelMemory))
Peter Collingbourne915df992015-05-15 18:33:32 +0000762 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000763 if (SanOpts.has(SanitizerKind::SafeStack))
764 Fn->addFnAttr(llvm::Attribute::SafeStack);
Vlad Tsyrkleviche55aa032018-04-03 22:33:53 +0000765 if (SanOpts.has(SanitizerKind::ShadowCallStack))
766 Fn->addFnAttr(llvm::Attribute::ShadowCallStack);
Peter Collingbourne915df992015-05-15 18:33:32 +0000767
Matt Morehouse5317f2e2018-03-23 23:35:28 +0000768 // Apply fuzzing attribute to the function.
769 if (SanOpts.hasOneOf(SanitizerKind::Fuzzer | SanitizerKind::FuzzerNoLink))
770 Fn->addFnAttr(llvm::Attribute::OptForFuzzing);
771
Anna Zaksbcd35a82016-11-11 23:22:44 +0000772 // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize,
Anna Zakse43b4fc2017-01-13 00:50:50 +0000773 // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time.
Anna Zaksbcd35a82016-11-11 23:22:44 +0000774 if (SanOpts.has(SanitizerKind::Thread)) {
775 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
776 IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0);
777 if (OMD->getMethodFamily() == OMF_dealloc ||
778 OMD->getMethodFamily() == OMF_initialize ||
779 (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) {
Anna Zakse43b4fc2017-01-13 00:50:50 +0000780 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000781 }
782 }
783 }
784
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000785 // Ignore unrelated casts in STL allocate() since the allocator must cast
786 // from void* to T* before object initialization completes. Don't match on the
787 // namespace because not all allocators are in std::
788 if (D && SanOpts.has(SanitizerKind::CFIUnrelatedCast)) {
789 if (matchesStlAllocatorFn(D, getContext()))
790 SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast;
791 }
792
Brian Gesiakf8d68362019-08-13 12:02:25 +0000793 // Ignore null checks in coroutine functions since the coroutines passes
794 // are not aware of how to move the extra UBSan instructions across the split
795 // coroutine boundaries.
796 if (D && SanOpts.has(SanitizerKind::Null))
797 if (const auto *FD = dyn_cast<FunctionDecl>(D))
798 if (FD->getBody() &&
799 FD->getBody()->getStmtClass() == Stmt::CoroutineBodyStmtClass)
800 SanOpts.Mask &= ~SanitizerKind::Null;
801
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000802 // Apply xray attributes to the function (as a string, for now)
Dean Michael Berris05cf4432018-09-14 01:59:12 +0000803 if (D) {
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000804 if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) {
Dean Michael Berris05cf4432018-09-14 01:59:12 +0000805 if (CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
806 XRayInstrKind::Function)) {
807 if (XRayAttr->alwaysXRayInstrument() && ShouldXRayInstrumentFunction())
808 Fn->addFnAttr("function-instrument", "xray-always");
809 if (XRayAttr->neverXRayInstrument())
810 Fn->addFnAttr("function-instrument", "xray-never");
811 if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>())
812 if (ShouldXRayInstrumentFunction())
813 Fn->addFnAttr("xray-log-args",
814 llvm::utostr(LogArgs->getArgumentCount()));
Dean Michael Berris418da3f2017-03-06 07:08:21 +0000815 }
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000816 } else {
Dean Michael Berris05cf4432018-09-14 01:59:12 +0000817 if (ShouldXRayInstrumentFunction() && !CGM.imbueXRayAttrs(Fn, Loc))
Dean Michael Berris835832d2017-03-30 00:29:36 +0000818 Fn->addFnAttr(
819 "xray-instruction-threshold",
820 llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold));
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000821 }
822 }
823
Nirav Daved2f44d82016-04-05 17:50:43 +0000824 // Add no-jump-tables value.
825 Fn->addFnAttr("no-jump-tables",
826 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables));
827
Amy Huangab76cfd2019-10-31 09:15:53 -0700828 // Add no-inline-line-tables value.
829 if (CGM.getCodeGenOpts().NoInlineLineTables)
830 Fn->addFnAttr("no-inline-line-tables");
831
Dehao Chen5e97f232017-08-24 21:37:33 +0000832 // Add profile-sample-accurate value.
833 if (CGM.getCodeGenOpts().ProfileSampleAccurate)
834 Fn->addFnAttr("profile-sample-accurate");
835
Peter Collingbourne0e497d12019-08-09 22:31:59 +0000836 if (D && D->hasAttr<CFICanonicalJumpTableAttr>())
837 Fn->addFnAttr("cfi-canonical-jump-table");
838
Richard Smith9c6890a2012-11-01 22:30:59 +0000839 if (getLangOpts().OpenCL) {
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000840 // Add metadata for a kernel function.
841 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000842 EmitOpenCLKernelMetadata(FD, Fn);
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000843 }
844
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000845 // If we are checking function types, emit a function type signature as
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000846 // prologue data.
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000847 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000848 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000849 if (llvm::Constant *PrologueSig = getPrologueSignature(CGM, FD)) {
Stephan Bergmann8c85bca2018-01-05 07:57:12 +0000850 // Remove any (C++17) exception specifications, to allow calling e.g. a
851 // noexcept function through a non-noexcept pointer.
852 auto ProtoTy =
853 getContext().getFunctionTypeWithExceptionSpec(FD->getType(),
854 EST_None);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000855 llvm::Constant *FTRTTIConst =
Stephan Bergmann8c85bca2018-01-05 07:57:12 +0000856 CGM.GetAddrOfRTTIDescriptor(ProtoTy, /*ForEH=*/true);
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000857 llvm::Constant *FTRTTIConstEncoded =
858 EncodeAddrForUseInPrologue(Fn, FTRTTIConst);
859 llvm::Constant *PrologueStructElems[] = {PrologueSig,
860 FTRTTIConstEncoded};
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000861 llvm::Constant *PrologueStructConst =
862 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
863 Fn->setPrologueData(PrologueStructConst);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000864 }
865 }
866 }
867
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000868 // If we're checking nullability, we need to know whether we can check the
869 // return value. Initialize the flag to 'true' and refine it in EmitParmDecl.
870 if (SanOpts.has(SanitizerKind::NullabilityReturn)) {
871 auto Nullability = FnRetTy->getNullability(getContext());
872 if (Nullability && *Nullability == NullabilityKind::NonNull) {
873 if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
874 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>()))
875 RetValNullabilityPrecondition =
876 llvm::ConstantInt::getTrue(getLLVMContext());
877 }
878 }
879
James Molloyc16a60b62015-11-12 15:36:04 +0000880 // If we're in C++ mode and the function name is "main", it is guaranteed
881 // to be norecurse by the standard (3.6.1.3 "The function main shall not be
882 // used within a program").
883 if (getLangOpts().CPlusPlus)
884 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
885 if (FD->isMain())
886 Fn->addFnAttr(llvm::Attribute::NoRecurse);
Honggyu Kim2bbdeac2016-09-01 06:14:45 +0000887
Melanie Blower7f9b5132019-12-04 12:23:46 -0800888 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
889 if (FD->usesFPIntrin())
890 Fn->addFnAttr(llvm::Attribute::StrictFP);
891
Martin Storsjod39d53b2018-08-21 20:41:17 +0000892 // If a custom alignment is used, force realigning to this alignment on
893 // any main function which certainly will need it.
894 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
895 if ((FD->isMain() || FD->isMSVCRTEntryPoint()) &&
896 CGM.getCodeGenOpts().StackAlignment)
897 Fn->addFnAttr("stackrealign");
898
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000899 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000900
Chris Lattner5696e7b2008-06-17 18:05:57 +0000901 // Create a marker to make it easy to insert allocas into the entryblock
902 // later. Don't create this with the builder, because we don't want it
903 // folded.
Chris Lattner5e016ae2010-06-27 07:15:29 +0000904 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
Mehdi Amini557c20a2016-03-13 21:05:23 +0000905 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000906
John McCallbd309292010-07-06 01:34:17 +0000907 ReturnBlock = getJumpDestInCurrentScope("return");
Mike Stump11289f42009-09-09 15:08:12 +0000908
Chris Lattner5696e7b2008-06-17 18:05:57 +0000909 Builder.SetInsertPoint(EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000910
Vedant Kumarc34d3432017-06-23 21:32:38 +0000911 // If we're checking the return value, allocate space for a pointer to a
912 // precise source location of the checked return statement.
913 if (requiresReturnValueCheck()) {
914 ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr");
915 InitTempAlloca(ReturnLocation, llvm::ConstantPointerNull::get(Int8PtrTy));
916 }
917
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000918 // Emit subprogram debug descriptor.
Anders Carlsson63784f42009-02-13 08:11:52 +0000919 if (CGDebugInfo *DI = getDebugInfo()) {
Reid Klecknerf00f8032016-06-08 20:41:54 +0000920 // Reconstruct the type from the argument list so that implicit parameters,
921 // such as 'this' and 'vtt', show up in the debug info. Preserve the calling
922 // convention.
923 CallingConv CC = CallingConv::CC_C;
924 if (auto *FD = dyn_cast_or_null<FunctionDecl>(D))
925 if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>())
926 CC = SrcFnTy->getCallConv();
Jordan Rose5c382722013-03-08 21:51:21 +0000927 SmallVector<QualType, 16> ArgTypes;
Reid Klecknerf00f8032016-06-08 20:41:54 +0000928 for (const VarDecl *VD : Args)
929 ArgTypes.push_back(VD->getType());
930 QualType FnType = getContext().getFunctionType(
931 RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Brock Wyma94ece8f2018-04-16 16:53:57 +0000932 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, CurFuncIsThunk,
933 Builder);
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000934 }
935
Hans Wennborg76c26c12017-11-14 21:13:27 +0000936 if (ShouldInstrumentFunction()) {
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000937 if (CGM.getCodeGenOpts().InstrumentFunctions)
938 CurFn->addFnAttr("instrument-function-entry", "__cyg_profile_func_enter");
939 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
940 CurFn->addFnAttr("instrument-function-entry-inlined",
941 "__cyg_profile_func_enter");
942 if (CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
943 CurFn->addFnAttr("instrument-function-entry-inlined",
944 "__cyg_profile_func_enter_bare");
Hans Wennborg76c26c12017-11-14 21:13:27 +0000945 }
Chris Lattner3c77a352010-06-22 00:03:40 +0000946
Honggyu Kim2b0e4242016-09-01 11:29:21 +0000947 // Since emitting the mcount call here impacts optimizations such as function
948 // inlining, we just add an attribute to insert a mcount call in backend.
949 // The attribute "counting-function" is set to mcount function name which is
950 // architecture dependent.
Nirav Dave0c86ccf2017-01-31 17:00:35 +0000951 if (CGM.getCodeGenOpts().InstrumentForProfiling) {
Manoj Gupta886b4502018-03-02 23:52:44 +0000952 // Calls to fentry/mcount should not be generated if function has
953 // the no_instrument_function attribute.
954 if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) {
955 if (CGM.getCodeGenOpts().CallFEntry)
956 Fn->addFnAttr("fentry-call", "true");
957 else {
Hans Wennborg76c26c12017-11-14 21:13:27 +0000958 Fn->addFnAttr("instrument-function-entry-inlined",
959 getTarget().getMCountName());
960 }
Jonas Paulsson93767142019-11-05 11:44:04 +0100961 if (CGM.getCodeGenOpts().MNopMCount) {
962 if (getContext().getTargetInfo().getTriple().getArch() !=
963 llvm::Triple::systemz)
964 CGM.getDiags().Report(diag::err_opt_not_valid_on_target)
965 << "-mnop-mcount";
966 if (!CGM.getCodeGenOpts().CallFEntry)
967 CGM.getDiags().Report(diag::err_opt_not_valid_without_opt)
968 << "-mnop-mcount" << "-mfentry";
Jonas Paulssonca520592019-12-18 10:12:41 -0800969 Fn->addFnAttr("mnop-mcount");
Jonas Paulsson93767142019-11-05 11:44:04 +0100970 }
Jonas Paulsson2520bef2019-12-17 12:00:43 -0800971
972 if (CGM.getCodeGenOpts().RecordMCount) {
973 if (getContext().getTargetInfo().getTriple().getArch() !=
974 llvm::Triple::systemz)
975 CGM.getDiags().Report(diag::err_opt_not_valid_on_target)
976 << "-mrecord-mcount";
977 if (!CGM.getCodeGenOpts().CallFEntry)
978 CGM.getDiags().Report(diag::err_opt_not_valid_without_opt)
979 << "-mrecord-mcount" << "-mfentry";
980 Fn->addFnAttr("mrecord-mcount");
981 }
Manoj Gupta162b40a2017-06-19 18:45:03 +0000982 }
Nirav Dave0c86ccf2017-01-31 17:00:35 +0000983 }
Roman Divacky178e01602011-02-10 16:52:03 +0000984
Jonas Paulsson599d1cc2019-12-12 21:40:26 +0100985 if (CGM.getCodeGenOpts().PackedStack) {
986 if (getContext().getTargetInfo().getTriple().getArch() !=
987 llvm::Triple::systemz)
988 CGM.getDiags().Report(diag::err_opt_not_valid_on_target)
989 << "-mpacked-stack";
990 Fn->addFnAttr("packed-stack");
991 }
992
Eli Friedman4b1942c2009-12-04 02:43:40 +0000993 if (RetTy->isVoidType()) {
994 // Void type; nothing to return.
John McCall7f416cc2015-09-08 08:05:57 +0000995 ReturnValue = Address::invalid();
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000996
997 // Count the implicit return.
998 if (!endsWithReturn(D))
999 ++NumReturnExprs;
Hans Wennborg86aba5e2018-12-07 08:17:26 +00001000 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect) {
1001 // Indirect return; emit returned value directly into sret slot.
Daniel Dunbarfd09df72010-02-16 19:45:20 +00001002 // This reduces code size, and affects correctness in C++.
Reid Kleckner37abaca2014-05-09 22:46:15 +00001003 auto AI = CurFn->arg_begin();
1004 if (CurFnInfo->getReturnInfo().isSRetAfterThis())
1005 ++AI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001006 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign());
Amy Huang7fac5c82019-06-20 17:15:21 +00001007 if (!CurFnInfo->getReturnInfo().getIndirectByVal()) {
1008 ReturnValuePointer =
1009 CreateDefaultAlignTempAlloca(Int8PtrTy, "result.ptr");
1010 Builder.CreateStore(Builder.CreatePointerBitCastOrAddrSpaceCast(
1011 ReturnValue.getPointer(), Int8PtrTy),
1012 ReturnValuePointer);
1013 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +00001014 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
1015 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
1016 // Load the sret pointer from the argument struct and return into that.
1017 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
1018 llvm::Function::arg_iterator EI = CurFn->arg_end();
1019 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +00001020 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx);
Amy Huang7fac5c82019-06-20 17:15:21 +00001021 ReturnValuePointer = Address(Addr, getPointerAlign());
John McCall7f416cc2015-09-08 08:05:57 +00001022 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result");
1023 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy));
Eli Friedman4b1942c2009-12-04 02:43:40 +00001024 } else {
Daniel Dunbarfd09df72010-02-16 19:45:20 +00001025 ReturnValue = CreateIRTemp(RetTy, "retval");
John McCall31168b02011-06-15 23:02:42 +00001026
1027 // Tell the epilog emitter to autorelease the result. We do this
1028 // now so that various specialized functions can suppress it
1029 // during their IR-generation.
David Blaikiebbafb8a2012-03-11 07:00:24 +00001030 if (getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +00001031 !CurFnInfo->isReturnsRetained() &&
1032 RetTy->isObjCRetainableType())
1033 AutoreleaseResult = true;
Eli Friedman4b1942c2009-12-04 02:43:40 +00001034 }
1035
Mike Stump1d849212009-12-07 23:38:24 +00001036 EmitStartEHSpec(CurCodeDecl);
John McCall31168b02011-06-15 23:02:42 +00001037
1038 PrologueCleanupDepth = EHStack.stable_begin();
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +00001039
1040 // Emit OpenMP specific initialization of the device functions.
1041 if (getLangOpts().OpenMP && CurCodeDecl)
1042 CGM.getOpenMPRuntime().emitFunctionProlog(*this, CurCodeDecl);
1043
Daniel Dunbard931a872009-02-02 22:03:45 +00001044 EmitFunctionProlog(*CurFnInfo, CurFn, Args);
Mike Stump11289f42009-09-09 15:08:12 +00001045
Eli Friedman9fbeba02012-02-11 02:57:39 +00001046 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
John McCall5d865c322010-08-31 07:33:07 +00001047 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
Eli Friedman9fbeba02012-02-11 02:57:39 +00001048 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
1049 if (MD->getParent()->isLambda() &&
1050 MD->getOverloadedOperator() == OO_Call) {
1051 // We're in a lambda; figure out the captures.
1052 MD->getParent()->getCaptureFields(LambdaCaptureFields,
1053 LambdaThisCaptureField);
1054 if (LambdaThisCaptureField) {
Faisal Validc6b5962016-03-21 09:25:37 +00001055 // If the lambda captures the object referred to by '*this' - either by
1056 // value or by reference, make sure CXXThisValue points to the correct
1057 // object.
1058
1059 // Get the lvalue for the field (which is a copy of the enclosing object
1060 // or contains the address of the enclosing object).
1061 LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
1062 if (!LambdaThisCaptureField->getType()->isPointerType()) {
1063 // If the enclosing object was captured by value, just use its address.
Akira Hatanakaf139ae32019-12-03 15:17:01 -08001064 CXXThisValue = ThisFieldLValue.getAddress(*this).getPointer();
Faisal Validc6b5962016-03-21 09:25:37 +00001065 } else {
1066 // Load the lvalue pointed to by the field, since '*this' was captured
1067 // by reference.
1068 CXXThisValue =
1069 EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal();
1070 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001071 }
Alexey Bataev39c81e22014-08-28 04:28:19 +00001072 for (auto *FD : MD->getParent()->fields()) {
1073 if (FD->hasCapturedVLAType()) {
1074 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
1075 SourceLocation()).getScalarVal();
1076 auto VAT = FD->getCapturedVLAType();
1077 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
1078 }
1079 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001080 } else {
1081 // Not in a lambda; just use 'this' from the method.
1082 // FIXME: Should we generate a new load for each use of 'this'? The
1083 // fast register allocator would be happier...
1084 CXXThisValue = CXXABIThisValue;
1085 }
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001086
Vedant Kumarffd7c882017-04-14 22:03:34 +00001087 // Check the 'this' pointer once per function, if it's available.
Richard Smith376c28e2017-08-24 20:10:33 +00001088 if (CXXABIThisValue) {
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001089 SanitizerSet SkippedChecks;
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001090 SkippedChecks.set(SanitizerKind::ObjectSize, true);
Brian Gesiak5488ab42019-01-11 01:54:53 +00001091 QualType ThisTy = MD->getThisType();
Richard Smith376c28e2017-08-24 20:10:33 +00001092
1093 // If this is the call operator of a lambda with no capture-default, it
1094 // may have a static invoker function, which may call this operator with
1095 // a null 'this' pointer.
1096 if (isLambdaCallOperator(MD) &&
George Burgess IV00f70bd2018-03-01 05:43:23 +00001097 MD->getParent()->getLambdaCaptureDefault() == LCD_None)
Richard Smith376c28e2017-08-24 20:10:33 +00001098 SkippedChecks.set(SanitizerKind::Null, true);
1099
1100 EmitTypeCheck(isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall
1101 : TCK_MemberCall,
1102 Loc, CXXABIThisValue, ThisTy,
Vedant Kumarffd7c882017-04-14 22:03:34 +00001103 getContext().getTypeAlignInChars(ThisTy->getPointeeType()),
1104 SkippedChecks);
Vedant Kumar34b1fd62017-02-17 23:22:59 +00001105 }
Eli Friedman9fbeba02012-02-11 02:57:39 +00001106 }
John McCall347132b2010-02-16 22:04:33 +00001107
Anders Carlssonc20879a2008-12-20 21:28:43 +00001108 // If any of the arguments have a variably modified type, make sure to
1109 // emit the type size.
1110 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
1111 i != e; ++i) {
Eli Friedman1f576832012-11-14 22:09:59 +00001112 const VarDecl *VD = *i;
1113
1114 // Dig out the type as written from ParmVarDecls; it's unclear whether
1115 // the standard (C99 6.9.1p10) requires this, but we're following the
1116 // precedent set by gcc.
1117 QualType Ty;
1118 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
1119 Ty = PVD->getOriginalType();
1120 else
1121 Ty = VD->getType();
Anders Carlssonc20879a2008-12-20 21:28:43 +00001122
1123 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +00001124 EmitVariablyModifiedType(Ty);
Anders Carlssonc20879a2008-12-20 21:28:43 +00001125 }
Eric Christopher7cdf9482011-10-13 21:45:18 +00001126 // Emit a location at the end of the prologue.
1127 if (CGDebugInfo *DI = getDebugInfo())
Calixte Denizetfcd661d2018-09-24 18:24:18 +00001128 DI->EmitLocation(Builder, StartLoc);
Craig Topper74c10e32018-07-09 19:00:16 +00001129
1130 // TODO: Do we need to handle this in two places like we do with
1131 // target-features/target-cpu?
1132 if (CurFuncDecl)
1133 if (const auto *VecWidth = CurFuncDecl->getAttr<MinVectorWidthAttr>())
1134 LargestVectorWidth = VecWidth->getVectorWidth();
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001135}
Eli Friedman3d421e12008-08-25 21:31:01 +00001136
Reid Kleckner43071082018-12-13 01:33:20 +00001137void CodeGenFunction::EmitFunctionBody(const Stmt *Body) {
Justin Bogner66242d62015-04-23 23:06:47 +00001138 incrementProfileCounter(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001139 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
David Blaikie0a21d0d2013-01-26 22:16:26 +00001140 EmitCompoundStmtWithoutScope(*S);
1141 else
Richard Smithb47c36f2013-11-05 09:12:18 +00001142 EmitStmt(Body);
John McCall89b12b32010-02-18 03:17:58 +00001143}
1144
Bob Wilsonbf854f02014-02-17 19:21:09 +00001145/// When instrumenting to collect profile data, the counts for some blocks
1146/// such as switch cases need to not include the fall-through counts, so
1147/// emit a branch around the instrumentation code. When not instrumenting,
1148/// this just calls EmitBlock().
1149void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
Justin Bogner66242d62015-04-23 23:06:47 +00001150 const Stmt *S) {
Craig Topper8a13c412014-05-21 05:09:00 +00001151 llvm::BasicBlock *SkipCountBB = nullptr;
Rong Xu9837ef52016-02-04 18:39:09 +00001152 if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001153 // When instrumenting for profiling, the fallthrough to certain
1154 // statements needs to skip over the instrumentation code so that we
1155 // get an accurate count.
1156 SkipCountBB = createBasicBlock("skipcount");
1157 EmitBranch(SkipCountBB);
1158 }
1159 EmitBlock(BB);
Justin Bogner66242d62015-04-23 23:06:47 +00001160 uint64_t CurrentCount = getCurrentProfileCount();
1161 incrementProfileCounter(S);
1162 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001163 if (SkipCountBB)
1164 EmitBlock(SkipCountBB);
1165}
1166
John McCall8601a752010-08-03 22:46:07 +00001167/// Tries to mark the given function nounwind based on the
1168/// non-existence of any throwing calls within it. We believe this is
1169/// lightweight enough to do at -O0.
1170static void TryMarkNoThrow(llvm::Function *F) {
John McCall59966992010-08-11 22:38:33 +00001171 // LLVM treats 'nounwind' on a function as part of the type, so we
1172 // can't do this on functions that can be overwritten.
Sanjoy Dasf60a0d72016-04-08 01:31:02 +00001173 if (F->isInterposable()) return;
John McCall59966992010-08-11 22:38:33 +00001174
David Majnemerdbf10452015-07-31 17:58:45 +00001175 for (llvm::BasicBlock &BB : *F)
1176 for (llvm::Instruction &I : BB)
1177 if (I.mayThrow())
Bill Wendlingf0724e82011-09-19 20:31:14 +00001178 return;
David Majnemerdbf10452015-07-31 17:58:45 +00001179
Bill Wendling73e465e2012-10-10 03:13:20 +00001180 F->setDoesNotThrow();
John McCall8601a752010-08-03 22:46:07 +00001181}
1182
Richard Smith5179eb72016-06-28 19:03:57 +00001183QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD,
1184 FunctionArgList &Args) {
Anders Carlsson73fcc952009-09-11 00:07:24 +00001185 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Alp Toker314cc812014-01-25 16:55:45 +00001186 QualType ResTy = FD->getReturnType();
Mike Stump11289f42009-09-09 15:08:12 +00001187
Reid Kleckner89077a12013-12-17 19:46:40 +00001188 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1189 if (MD && MD->isInstance()) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001190 if (CGM.getCXXABI().HasThisReturn(GD))
Brian Gesiak5488ab42019-01-11 01:54:53 +00001191 ResTy = MD->getThisType();
David Majnemer0c0b6d92014-10-31 20:09:12 +00001192 else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
1193 ResTy = CGM.getContext().VoidPtrTy;
Reid Kleckner89077a12013-12-17 19:46:40 +00001194 CGM.getCXXABI().buildThisParam(*this, Args);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001195 }
Justin Bogner66242d62015-04-23 23:06:47 +00001196
Richard Smith5179eb72016-06-28 19:03:57 +00001197 // The base version of an inheriting constructor whose constructed base is a
1198 // virtual base is not passed any arguments (because it doesn't actually call
1199 // the inherited constructor).
1200 bool PassedParams = true;
1201 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
1202 if (auto Inherited = CD->getInheritedConstructor())
1203 PassedParams =
1204 getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001205
Richard Smith5179eb72016-06-28 19:03:57 +00001206 if (PassedParams) {
1207 for (auto *Param : FD->parameters()) {
1208 Args.push_back(Param);
1209 if (!Param->hasAttr<PassObjectSizeAttr>())
1210 continue;
1211
Richard Smith5179eb72016-06-28 19:03:57 +00001212 auto *Implicit = ImplicitParamDecl::Create(
Alexey Bataev56223232017-06-09 13:40:18 +00001213 getContext(), Param->getDeclContext(), Param->getLocation(),
1214 /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other);
Richard Smith5179eb72016-06-28 19:03:57 +00001215 SizeArguments[Param] = Implicit;
1216 Args.push_back(Implicit);
1217 }
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001218 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001219
Reid Kleckner89077a12013-12-17 19:46:40 +00001220 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
1221 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
1222
Richard Smith5179eb72016-06-28 19:03:57 +00001223 return ResTy;
1224}
1225
Alex Lorenzc1608f72017-01-04 13:40:34 +00001226static bool
1227shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD,
1228 const ASTContext &Context) {
1229 QualType T = FD->getReturnType();
1230 // Avoid the optimization for functions that return a record type with a
1231 // trivial destructor or another trivially copyable type.
1232 if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) {
1233 if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl()))
1234 return !ClassDecl->hasTrivialDestructor();
1235 }
1236 return !T.isTriviallyCopyableType(Context);
1237}
1238
Richard Smith5179eb72016-06-28 19:03:57 +00001239void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1240 const CGFunctionInfo &FnInfo) {
1241 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
1242 CurGD = GD;
1243
1244 FunctionArgList Args;
1245 QualType ResTy = BuildFunctionArgList(GD, Args);
1246
1247 // Check if we should generate debug info for this function.
1248 if (FD->hasAttr<NoDebugAttr>())
1249 DebugInfo = nullptr; // disable debug info indefinitely for this function
1250
Reid Klecknera8589812017-02-08 16:09:32 +00001251 // The function might not have a body if we're generating thunks for a
1252 // function declaration.
John McCall89b12b32010-02-18 03:17:58 +00001253 SourceRange BodyRange;
Reid Klecknera8589812017-02-08 16:09:32 +00001254 if (Stmt *Body = FD->getBody())
1255 BodyRange = Body->getSourceRange();
1256 else
1257 BodyRange = FD->getLocation();
Adrian Prantldc237b52013-05-16 00:41:26 +00001258 CurEHLocation = BodyRange.getEnd();
Anders Carlsson438cf922009-11-06 02:55:43 +00001259
Adrian Prantl42d71b92014-04-10 23:21:53 +00001260 // Use the location of the start of the function to determine where
1261 // the function definition is located. By default use the location
1262 // of the declaration as the location for the subprogram. A function
1263 // may lack a declaration in the source code if it is created by code
1264 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001265 SourceLocation Loc = FD->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001266
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001267 // If this is a function specialization then use the pattern body
1268 // as the location for the function.
1269 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
1270 if (SpecDecl->hasBody(SpecDecl))
1271 Loc = SpecDecl->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001272
Vitaly Buka64c80b42016-10-26 05:42:30 +00001273 Stmt *Body = FD->getBody();
1274
1275 // Initialize helper which will detect jumps which can cause invalid lifetime
1276 // markers.
1277 if (Body && ShouldEmitLifetimeMarkers)
1278 Bypasses.Init(Body);
1279
John McCall89b12b32010-02-18 03:17:58 +00001280 // Emit the standard function prologue.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001281 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
Anders Carlsson438cf922009-11-06 02:55:43 +00001282
John McCall89b12b32010-02-18 03:17:58 +00001283 // Generate the body of the function.
Serge Pavlov3a561452015-12-06 14:32:39 +00001284 PGO.assignRegionCounters(GD, CurFn);
John McCallb81884d2010-02-19 09:25:03 +00001285 if (isa<CXXDestructorDecl>(FD))
1286 EmitDestructorBody(Args);
1287 else if (isa<CXXConstructorDecl>(FD))
1288 EmitConstructorBody(Args);
Richard Smith9c6890a2012-11-01 22:30:59 +00001289 else if (getLangOpts().CUDA &&
Artem Belevichf3d3db62015-03-19 18:58:18 +00001290 !getLangOpts().CUDAIsDevice &&
Peter Collingbournefa4d6032011-10-06 18:51:56 +00001291 FD->hasAttr<CUDAGlobalAttr>())
Artem Belevich52cc4872015-05-07 19:34:16 +00001292 CGM.getCUDARuntime().emitDeviceStub(*this, Args);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001293 else if (isa<CXXMethodDecl>(FD) &&
1294 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
Faisal Vali2b391ab2013-09-26 19:54:12 +00001295 // The lambda static invoker function is special, because it forwards or
Douglas Gregor355efbb2012-02-17 03:02:34 +00001296 // clones the body of the function call operator (but is actually static).
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001297 EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD));
Lang Hamesbf122742013-02-17 07:22:09 +00001298 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
Nick Lewyckyb39be1f2013-09-10 05:14:39 +00001299 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
1300 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
Lang Hamesbf122742013-02-17 07:22:09 +00001301 // Implicit copy-assignment gets the same special treatment as implicit
1302 // copy-constructors.
1303 emitImplicitAssignmentOperatorBody(Args);
Vitaly Buka64c80b42016-10-26 05:42:30 +00001304 } else if (Body) {
Reid Kleckner43071082018-12-13 01:33:20 +00001305 EmitFunctionBody(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001306 } else
1307 llvm_unreachable("no definition for emitted function");
Anders Carlssonff8cce42010-02-07 19:45:40 +00001308
Richard Smith9f9e5822012-10-04 23:52:29 +00001309 // C++11 [stmt.return]p2:
1310 // Flowing off the end of a function [...] results in undefined behavior in
1311 // a value-returning function.
1312 // C11 6.9.1p12:
1313 // If the '}' that terminates a function is reached, and the value of the
1314 // function call is used by the caller, the behavior is undefined.
Reid Kleckner9b3e3df2014-09-04 20:04:38 +00001315 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
Alp Toker314cc812014-01-25 16:55:45 +00001316 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
Alex Lorenzc1608f72017-01-04 13:40:34 +00001317 bool ShouldEmitUnreachable =
1318 CGM.getCodeGenOpts().StrictReturn ||
1319 shouldUseUndefinedBehaviorReturnOptimization(FD, getContext());
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001320 if (SanOpts.has(SanitizerKind::Return)) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001321 SanitizerScope SanScope(this);
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001322 llvm::Value *IsFalse = Builder.getFalse();
1323 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00001324 SanitizerHandler::MissingReturn,
1325 EmitCheckSourceLocation(FD->getLocation()), None);
Alex Lorenzc1608f72017-01-04 13:40:34 +00001326 } else if (ShouldEmitUnreachable) {
1327 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
1328 EmitTrapCall(llvm::Intrinsic::trap);
Akira Hatanaka85365cd2015-07-02 22:15:41 +00001329 }
Alex Lorenzc1608f72017-01-04 13:40:34 +00001330 if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) {
1331 Builder.CreateUnreachable();
1332 Builder.ClearInsertionPoint();
1333 }
Richard Smith9f9e5822012-10-04 23:52:29 +00001334 }
1335
John McCall89b12b32010-02-18 03:17:58 +00001336 // Emit the standard function epilogue.
1337 FinishFunction(BodyRange.getEnd());
John McCall8601a752010-08-03 22:46:07 +00001338
1339 // If we haven't marked the function nothrow through other means, do
1340 // a quick pass now to see if we can.
1341 if (!CurFn->doesNotThrow())
1342 TryMarkNoThrow(CurFn);
Chris Lattner5696e7b2008-06-17 18:05:57 +00001343}
1344
Chris Lattner5b1964b2008-11-11 07:41:27 +00001345/// ContainsLabel - Return true if the statement contains a label in it. If
1346/// this statement is not executed normally, it not containing a label means
1347/// that we can just remove the code.
1348bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
1349 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001350 if (!S) return false;
Mike Stump11289f42009-09-09 15:08:12 +00001351
Chris Lattner5b1964b2008-11-11 07:41:27 +00001352 // If this is a label, we have to emit the code, consider something like:
1353 // if (0) { ... foo: bar(); } goto foo;
Chris Lattner29911cc2011-02-28 00:18:40 +00001354 //
1355 // TODO: If anyone cared, we could track __label__'s, since we know that you
1356 // can't jump to one from outside their declared region.
Chris Lattner5b1964b2008-11-11 07:41:27 +00001357 if (isa<LabelStmt>(S))
1358 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001359
Chris Lattner5b1964b2008-11-11 07:41:27 +00001360 // If this is a case/default statement, and we haven't seen a switch, we have
1361 // to emit the code.
1362 if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
1363 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001364
Chris Lattner5b1964b2008-11-11 07:41:27 +00001365 // If this is a switch statement, we want to ignore cases below it.
1366 if (isa<SwitchStmt>(S))
1367 IgnoreCaseStmts = true;
Mike Stump11289f42009-09-09 15:08:12 +00001368
Chris Lattner5b1964b2008-11-11 07:41:27 +00001369 // Scan subexpressions for verboten labels.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001370 for (const Stmt *SubStmt : S->children())
1371 if (ContainsLabel(SubStmt, IgnoreCaseStmts))
Chris Lattner5b1964b2008-11-11 07:41:27 +00001372 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001373
Chris Lattner5b1964b2008-11-11 07:41:27 +00001374 return false;
1375}
1376
Chris Lattner29911cc2011-02-28 00:18:40 +00001377/// containsBreak - Return true if the statement contains a break out of it.
1378/// If the statement (recursively) contains a switch or loop with a break
1379/// inside of it, this is fine.
1380bool CodeGenFunction::containsBreak(const Stmt *S) {
1381 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001382 if (!S) return false;
Chris Lattner29911cc2011-02-28 00:18:40 +00001383
1384 // If this is a switch or loop that defines its own break scope, then we can
1385 // include it and anything inside of it.
1386 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
1387 isa<ForStmt>(S))
Chris Lattner30db8282011-02-28 00:42:31 +00001388 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001389
Chris Lattner30db8282011-02-28 00:42:31 +00001390 if (isa<BreakStmt>(S))
Chris Lattner29911cc2011-02-28 00:18:40 +00001391 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001392
Chris Lattner29911cc2011-02-28 00:18:40 +00001393 // Scan subexpressions for verboten breaks.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001394 for (const Stmt *SubStmt : S->children())
1395 if (containsBreak(SubStmt))
Chris Lattner29911cc2011-02-28 00:18:40 +00001396 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001397
Chris Lattner29911cc2011-02-28 00:18:40 +00001398 return false;
1399}
1400
Richard Smithd8e3ac32016-09-16 23:30:39 +00001401bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) {
1402 if (!S) return false;
1403
1404 // Some statement kinds add a scope and thus never add a decl to the current
1405 // scope. Note, this list is longer than the list of statements that might
1406 // have an unscoped decl nested within them, but this way is conservatively
1407 // correct even if more statement kinds are added.
1408 if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
1409 isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) ||
1410 isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) ||
1411 isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S))
1412 return false;
1413
1414 if (isa<DeclStmt>(S))
1415 return true;
1416
1417 for (const Stmt *SubStmt : S->children())
1418 if (mightAddDeclToScope(SubStmt))
1419 return true;
1420
1421 return false;
1422}
Chris Lattnercd439292008-11-12 08:04:58 +00001423
Chris Lattner41c6ab52011-02-27 23:02:32 +00001424/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1425/// to a constant, or if it does but contains a label, return false. If it
1426/// constant folds return true and set the boolean result in Result.
1427bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
Richard Smithb130fe72016-06-23 19:16:49 +00001428 bool &ResultBool,
1429 bool AllowLabels) {
Richard Trieuc320c742012-07-23 20:21:35 +00001430 llvm::APSInt ResultInt;
Richard Smithb130fe72016-06-23 19:16:49 +00001431 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels))
Chris Lattner29911cc2011-02-28 00:18:40 +00001432 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001433
Chris Lattner29911cc2011-02-28 00:18:40 +00001434 ResultBool = ResultInt.getBoolValue();
1435 return true;
1436}
1437
1438/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1439/// to a constant, or if it does but contains a label, return false. If it
1440/// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00001441bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1442 llvm::APSInt &ResultInt,
1443 bool AllowLabels) {
Daniel Dunbarf32443c2008-11-12 22:37:10 +00001444 // FIXME: Rename and handle conversion of other evaluatable things
1445 // to bool.
Fangrui Song407659a2018-11-30 23:41:18 +00001446 Expr::EvalResult Result;
1447 if (!Cond->EvaluateAsInt(Result, getContext()))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001448 return false; // Not foldable, not integer or not fully evaluatable.
Richard Smith5fab0c92011-12-28 19:48:30 +00001449
Fangrui Song407659a2018-11-30 23:41:18 +00001450 llvm::APSInt Int = Result.Val.getInt();
Richard Smithb130fe72016-06-23 19:16:49 +00001451 if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001452 return false; // Contains a label.
Richard Smith5fab0c92011-12-28 19:48:30 +00001453
1454 ResultInt = Int;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001455 return true;
Chris Lattnercd439292008-11-12 08:04:58 +00001456}
1457
1458
Chris Lattner29911cc2011-02-28 00:18:40 +00001459
Chris Lattnercd439292008-11-12 08:04:58 +00001460/// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
1461/// statement) to the specified blocks. Based on the condition, this might try
1462/// to simplify the codegen of the conditional based on the branch.
1463///
1464void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
1465 llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00001466 llvm::BasicBlock *FalseBlock,
1467 uint64_t TrueCount) {
Peter Collingbourne91147592011-04-15 00:35:48 +00001468 Cond = Cond->IgnoreParens();
Mike Stump11289f42009-09-09 15:08:12 +00001469
Chris Lattnercd439292008-11-12 08:04:58 +00001470 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
Justin Bogneref512b92014-01-06 22:27:43 +00001471
Chris Lattnercd439292008-11-12 08:04:58 +00001472 // Handle X && Y in a condition.
John McCalle3027922010-08-25 11:45:40 +00001473 if (CondBOp->getOpcode() == BO_LAnd) {
Chris Lattnercd439292008-11-12 08:04:58 +00001474 // If we have "1 && X", simplify the code. "0 && X" would have constant
1475 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001476 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001477 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1478 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001479 // br(1 && X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001480 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001481 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1482 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001483 }
Mike Stump11289f42009-09-09 15:08:12 +00001484
Chris Lattnercd439292008-11-12 08:04:58 +00001485 // If we have "X && 1", simplify the code to use an uncond branch.
1486 // "X && 0" would have been constant folded to 0.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001487 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1488 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001489 // br(X && 1) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001490 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1491 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001492 }
Mike Stump11289f42009-09-09 15:08:12 +00001493
Chris Lattnercd439292008-11-12 08:04:58 +00001494 // Emit the LHS as a conditional. If the LHS conditional is false, we
1495 // want to jump to the FalseBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001496 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
Justin Bogneref512b92014-01-06 22:27:43 +00001497 // The counter tells us how often we evaluate RHS, and all of TrueCount
1498 // can be propagated to that branch.
Justin Bogner66242d62015-04-23 23:06:47 +00001499 uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
John McCallce1de612011-01-26 04:00:11 +00001500
1501 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001502 {
1503 ApplyDebugLocation DL(*this, Cond);
1504 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount);
1505 EmitBlock(LHSTrue);
1506 }
Mike Stump11289f42009-09-09 15:08:12 +00001507
Justin Bogner66242d62015-04-23 23:06:47 +00001508 incrementProfileCounter(CondBOp);
1509 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1510
Anders Carlsson60ddba62010-01-24 00:20:05 +00001511 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001512 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001513 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount);
John McCallce1de612011-01-26 04:00:11 +00001514 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001515
Chris Lattnercd439292008-11-12 08:04:58 +00001516 return;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001517 }
Michael Ilseman686240a2012-12-04 00:29:55 +00001518
Chris Lattner41c6ab52011-02-27 23:02:32 +00001519 if (CondBOp->getOpcode() == BO_LOr) {
Chris Lattnercd439292008-11-12 08:04:58 +00001520 // If we have "0 || X", simplify the code. "1 || X" would have constant
1521 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001522 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001523 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1524 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001525 // br(0 || X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001526 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001527 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1528 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001529 }
Mike Stump11289f42009-09-09 15:08:12 +00001530
Chris Lattnercd439292008-11-12 08:04:58 +00001531 // If we have "X || 0", simplify the code to use an uncond branch.
1532 // "X || 1" would have been constant folded to 1.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001533 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1534 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001535 // br(X || 0) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001536 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1537 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001538 }
Mike Stump11289f42009-09-09 15:08:12 +00001539
Chris Lattnercd439292008-11-12 08:04:58 +00001540 // Emit the LHS as a conditional. If the LHS conditional is true, we
1541 // want to jump to the TrueBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001542 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
Justin Bogneref512b92014-01-06 22:27:43 +00001543 // We have the count for entry to the RHS and for the whole expression
1544 // being true, so we can divy up True count between the short circuit and
1545 // the RHS.
Justin Bogner66242d62015-04-23 23:06:47 +00001546 uint64_t LHSCount =
1547 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
Justin Bogneref512b92014-01-06 22:27:43 +00001548 uint64_t RHSCount = TrueCount - LHSCount;
John McCallce1de612011-01-26 04:00:11 +00001549
1550 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001551 {
1552 ApplyDebugLocation DL(*this, Cond);
1553 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount);
1554 EmitBlock(LHSFalse);
1555 }
Mike Stump11289f42009-09-09 15:08:12 +00001556
Justin Bogner66242d62015-04-23 23:06:47 +00001557 incrementProfileCounter(CondBOp);
1558 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1559
Anders Carlsson60ddba62010-01-24 00:20:05 +00001560 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001561 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001562 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount);
1563
John McCallce1de612011-01-26 04:00:11 +00001564 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001565
Chris Lattnercd439292008-11-12 08:04:58 +00001566 return;
1567 }
Chris Lattnerd9537732008-11-12 08:13:36 +00001568 }
Mike Stump11289f42009-09-09 15:08:12 +00001569
Chris Lattnerd9537732008-11-12 08:13:36 +00001570 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
1571 // br(!x, t, f) -> br(x, f, t)
Justin Bogneref512b92014-01-06 22:27:43 +00001572 if (CondUOp->getOpcode() == UO_LNot) {
1573 // Negate the count.
Justin Bogner66242d62015-04-23 23:06:47 +00001574 uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
Justin Bogneref512b92014-01-06 22:27:43 +00001575 // Negate the condition and swap the destination blocks.
1576 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1577 FalseCount);
1578 }
Chris Lattnercd439292008-11-12 08:04:58 +00001579 }
Mike Stump11289f42009-09-09 15:08:12 +00001580
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001581 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
Eli Friedman248f8982012-02-14 03:54:45 +00001582 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
1583 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
1584 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001585
Eli Friedman248f8982012-02-14 03:54:45 +00001586 ConditionalEvaluation cond(*this);
Justin Bogner66242d62015-04-23 23:06:47 +00001587 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1588 getProfileCount(CondOp));
Justin Bogneref512b92014-01-06 22:27:43 +00001589
1590 // When computing PGO branch weights, we only know the overall count for
1591 // the true block. This code is essentially doing tail duplication of the
1592 // naive code-gen, introducing new edges for which counts are not
1593 // available. Divide the counts proportionally between the LHS and RHS of
1594 // the conditional operator.
1595 uint64_t LHSScaledTrueCount = 0;
1596 if (TrueCount) {
Justin Bogner66242d62015-04-23 23:06:47 +00001597 double LHSRatio =
1598 getProfileCount(CondOp) / (double)getCurrentProfileCount();
Justin Bogneref512b92014-01-06 22:27:43 +00001599 LHSScaledTrueCount = TrueCount * LHSRatio;
1600 }
John McCallce1de612011-01-26 04:00:11 +00001601
Eli Friedman248f8982012-02-14 03:54:45 +00001602 cond.begin(*this);
1603 EmitBlock(LHSBlock);
Justin Bogner66242d62015-04-23 23:06:47 +00001604 incrementProfileCounter(CondOp);
David Blaikie298720d2015-01-28 19:50:09 +00001605 {
1606 ApplyDebugLocation DL(*this, Cond);
1607 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1608 LHSScaledTrueCount);
1609 }
Eli Friedman248f8982012-02-14 03:54:45 +00001610 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001611
Eli Friedman248f8982012-02-14 03:54:45 +00001612 cond.begin(*this);
1613 EmitBlock(RHSBlock);
Justin Bogneref512b92014-01-06 22:27:43 +00001614 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1615 TrueCount - LHSScaledTrueCount);
Eli Friedman248f8982012-02-14 03:54:45 +00001616 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001617
Eli Friedman248f8982012-02-14 03:54:45 +00001618 return;
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001619 }
1620
Richard Smithea852322013-05-07 21:53:22 +00001621 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
1622 // Conditional operator handling can give us a throw expression as a
1623 // condition for a case like:
1624 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
1625 // Fold this to:
1626 // br(c, throw x, br(y, t, f))
1627 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
1628 return;
1629 }
1630
Sanjay Patela24296b2015-09-02 20:01:30 +00001631 // If the branch has a condition wrapped by __builtin_unpredictable,
1632 // create metadata that specifies that the branch is unpredictable.
1633 // Don't bother if not optimizing because that metadata would not be used.
1634 llvm::MDNode *Unpredictable = nullptr;
Erich Keane8c94f072018-12-12 20:30:53 +00001635 auto *Call = dyn_cast<CallExpr>(Cond->IgnoreImpCasts());
Sanjay Patel3fd323f2016-04-19 18:06:33 +00001636 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1637 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1638 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1639 llvm::MDBuilder MDHelper(getLLVMContext());
1640 Unpredictable = MDHelper.createUnpredictable();
Sanjay Patela24296b2015-09-02 20:01:30 +00001641 }
1642 }
1643
Justin Bogneref512b92014-01-06 22:27:43 +00001644 // Create branch weights based on the number of times we get here and the
1645 // number of times the condition should be true.
Justin Bogner66242d62015-04-23 23:06:47 +00001646 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
Justin Bogner65512642015-05-02 05:00:55 +00001647 llvm::MDNode *Weights =
1648 createProfileWeights(TrueCount, CurrentCount - TrueCount);
Justin Bogneref512b92014-01-06 22:27:43 +00001649
Chris Lattnercd439292008-11-12 08:04:58 +00001650 // Emit the code with the fully general case.
David Blaikie303facb2015-01-31 01:10:11 +00001651 llvm::Value *CondV;
1652 {
1653 ApplyDebugLocation DL(*this, Cond);
1654 CondV = EvaluateExprAsBool(Cond);
1655 }
Sanjay Patela24296b2015-09-02 20:01:30 +00001656 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
Chris Lattnercd439292008-11-12 08:04:58 +00001657}
1658
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001659/// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001660/// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001661void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
1662 CGM.ErrorUnsupported(S, Type);
Chris Lattnerfc944342007-12-02 01:43:38 +00001663}
1664
John McCall2725aa12011-02-01 21:35:06 +00001665/// emitNonZeroVLAInit - Emit the "zero" initialization of a
1666/// variable-length array whose elements have a non-zero bit-pattern.
1667///
James Dennettbe302452012-06-15 22:10:14 +00001668/// \param baseType the inner-most element type of the array
John McCall2725aa12011-02-01 21:35:06 +00001669/// \param src - a char* pointing to the bit-pattern for a single
1670/// base element of the array
1671/// \param sizeInChars - the total size of the VLA, in chars
John McCall2725aa12011-02-01 21:35:06 +00001672static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001673 Address dest, Address src,
John McCall2725aa12011-02-01 21:35:06 +00001674 llvm::Value *sizeInChars) {
John McCall2725aa12011-02-01 21:35:06 +00001675 CGBuilderTy &Builder = CGF.Builder;
1676
John McCall7f416cc2015-09-08 08:05:57 +00001677 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
John McCall2725aa12011-02-01 21:35:06 +00001678 llvm::Value *baseSizeInChars
John McCall7f416cc2015-09-08 08:05:57 +00001679 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
John McCall2725aa12011-02-01 21:35:06 +00001680
John McCall7f416cc2015-09-08 08:05:57 +00001681 Address begin =
1682 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1683 llvm::Value *end =
1684 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end");
John McCall2725aa12011-02-01 21:35:06 +00001685
1686 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
1687 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
1688 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
1689
1690 // Make a loop over the VLA. C99 guarantees that the VLA element
1691 // count must be nonzero.
1692 CGF.EmitBlock(loopBB);
1693
John McCall7f416cc2015-09-08 08:05:57 +00001694 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
1695 cur->addIncoming(begin.getPointer(), originBB);
1696
1697 CharUnits curAlign =
1698 dest.getAlignment().alignmentOfArrayElement(baseSize);
John McCall2725aa12011-02-01 21:35:06 +00001699
1700 // memcpy the individual element bit-pattern.
John McCall7f416cc2015-09-08 08:05:57 +00001701 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
John McCall2725aa12011-02-01 21:35:06 +00001702 /*volatile*/ false);
1703
1704 // Go to the next element.
John McCall7f416cc2015-09-08 08:05:57 +00001705 llvm::Value *next =
1706 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
John McCall2725aa12011-02-01 21:35:06 +00001707
1708 // Leave if that's the end of the VLA.
1709 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
1710 Builder.CreateCondBr(done, contBB, loopBB);
1711 cur->addIncoming(next, loopBB);
1712
1713 CGF.EmitBlock(contBB);
Michael Ilseman686240a2012-12-04 00:29:55 +00001714}
John McCall2725aa12011-02-01 21:35:06 +00001715
Anders Carlssonc0964b62010-05-22 17:35:42 +00001716void
John McCall7f416cc2015-09-08 08:05:57 +00001717CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001718 // Ignore empty classes in C++.
Richard Smith9c6890a2012-11-01 22:30:59 +00001719 if (getLangOpts().CPlusPlus) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001720 if (const RecordType *RT = Ty->getAs<RecordType>()) {
1721 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
1722 return;
1723 }
1724 }
John McCall7cd1d972010-08-07 08:21:30 +00001725
1726 // Cast the dest ptr to the appropriate i8 pointer type.
John McCall7f416cc2015-09-08 08:05:57 +00001727 if (DestPtr.getElementType() != Int8Ty)
1728 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001729
1730 // Get size and alignment info for this aggregate.
John McCall7f416cc2015-09-08 08:05:57 +00001731 CharUnits size = getContext().getTypeSizeInChars(Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001732
John McCalla08ffd22011-01-14 10:37:58 +00001733 llvm::Value *SizeVal;
John McCall2725aa12011-02-01 21:35:06 +00001734 const VariableArrayType *vla;
Mike Stump11289f42009-09-09 15:08:12 +00001735
John McCalla08ffd22011-01-14 10:37:58 +00001736 // Don't bother emitting a zero-byte memset.
John McCall7f416cc2015-09-08 08:05:57 +00001737 if (size.isZero()) {
John McCalla08ffd22011-01-14 10:37:58 +00001738 // But note that getTypeInfo returns 0 for a VLA.
1739 if (const VariableArrayType *vlaType =
1740 dyn_cast_or_null<VariableArrayType>(
1741 getContext().getAsArrayType(Ty))) {
Sander de Smalen891af03a2018-02-03 13:55:59 +00001742 auto VlaSize = getVLASize(vlaType);
1743 SizeVal = VlaSize.NumElts;
1744 CharUnits eltSize = getContext().getTypeSizeInChars(VlaSize.Type);
John McCall23c29fe2011-06-24 21:55:10 +00001745 if (!eltSize.isOne())
1746 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
John McCall2725aa12011-02-01 21:35:06 +00001747 vla = vlaType;
John McCalla08ffd22011-01-14 10:37:58 +00001748 } else {
1749 return;
1750 }
1751 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001752 SizeVal = CGM.getSize(size);
Craig Topper8a13c412014-05-21 05:09:00 +00001753 vla = nullptr;
John McCalla08ffd22011-01-14 10:37:58 +00001754 }
John McCall7cd1d972010-08-07 08:21:30 +00001755
1756 // If the type contains a pointer to data member we can't memset it to zero.
1757 // Instead, create a null constant and copy it to the destination.
John McCall2725aa12011-02-01 21:35:06 +00001758 // TODO: there are other patterns besides zero that we can usefully memset,
1759 // like -1, which happens to be the pattern used by member-pointers.
John McCall614dbdc2010-08-22 21:01:12 +00001760 if (!CGM.getTypes().isZeroInitializable(Ty)) {
John McCall2725aa12011-02-01 21:35:06 +00001761 // For a VLA, emit a single element, then splat that over the VLA.
1762 if (vla) Ty = getContext().getBaseElementType(vla);
John McCalla08ffd22011-01-14 10:37:58 +00001763
John McCall7cd1d972010-08-07 08:21:30 +00001764 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
1765
Michael Ilseman686240a2012-12-04 00:29:55 +00001766 llvm::GlobalVariable *NullVariable =
John McCall7cd1d972010-08-07 08:21:30 +00001767 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
Michael Ilseman686240a2012-12-04 00:29:55 +00001768 /*isConstant=*/true,
John McCall7cd1d972010-08-07 08:21:30 +00001769 llvm::GlobalVariable::PrivateLinkage,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001770 NullConstant, Twine());
John McCall7f416cc2015-09-08 08:05:57 +00001771 CharUnits NullAlign = DestPtr.getAlignment();
Guillaume Chateletc79099e2019-10-03 13:00:29 +00001772 NullVariable->setAlignment(NullAlign.getAsAlign());
John McCall7f416cc2015-09-08 08:05:57 +00001773 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
1774 NullAlign);
John McCall7cd1d972010-08-07 08:21:30 +00001775
John McCall2725aa12011-02-01 21:35:06 +00001776 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
1777
John McCall7cd1d972010-08-07 08:21:30 +00001778 // Get and call the appropriate llvm.memcpy overload.
John McCall7f416cc2015-09-08 08:05:57 +00001779 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
John McCall7cd1d972010-08-07 08:21:30 +00001780 return;
Michael Ilseman686240a2012-12-04 00:29:55 +00001781 }
1782
John McCall7cd1d972010-08-07 08:21:30 +00001783 // Otherwise, just memset the whole thing to zero. This is legal
1784 // because in LLVM, all default initializers (other than the ones we just
1785 // handled above) are guaranteed to have a bit pattern of all zeros.
John McCall7f416cc2015-09-08 08:05:57 +00001786 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001787}
1788
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001789llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001790 // Make sure that there is a block for the indirect goto.
Craig Topper8a13c412014-05-21 05:09:00 +00001791 if (!IndirectBranch)
Chris Lattner6c4d2552009-10-28 23:59:40 +00001792 GetIndirectGotoBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001793
John McCallad5d61e2010-07-23 21:56:41 +00001794 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001795
Chris Lattner6c4d2552009-10-28 23:59:40 +00001796 // Make sure the indirect branch includes all of the address-taken blocks.
1797 IndirectBranch->addDestination(BB);
1798 return llvm::BlockAddress::get(CurFn, BB);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001799}
1800
1801llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001802 // If we already made the indirect branch for indirect goto, return its block.
1803 if (IndirectBranch) return IndirectBranch->getParent();
Michael Ilseman686240a2012-12-04 00:29:55 +00001804
John McCall7f416cc2015-09-08 08:05:57 +00001805 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
Michael Ilseman686240a2012-12-04 00:29:55 +00001806
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001807 // Create the PHI node that indirect gotos will add entries to.
Jay Foad20c0f022011-03-30 11:28:58 +00001808 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
1809 "indirect.goto.dest");
Michael Ilseman686240a2012-12-04 00:29:55 +00001810
Chris Lattner6c4d2552009-10-28 23:59:40 +00001811 // Create the indirect branch instruction.
1812 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
1813 return IndirectBranch->getParent();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001814}
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001815
John McCall82fe67b2011-07-09 01:37:26 +00001816/// Computes the length of an array in elements, as well as the base
1817/// element type and a properly-typed first element pointer.
1818llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1819 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001820 Address &addr) {
John McCall82fe67b2011-07-09 01:37:26 +00001821 const ArrayType *arrayType = origArrayType;
1822
1823 // If it's a VLA, we have to load the stored size. Note that
1824 // this is the size of the VLA in bytes, not its size in elements.
Craig Topper8a13c412014-05-21 05:09:00 +00001825 llvm::Value *numVLAElements = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001826 if (isa<VariableArrayType>(arrayType)) {
Sander de Smalen891af03a2018-02-03 13:55:59 +00001827 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).NumElts;
John McCall82fe67b2011-07-09 01:37:26 +00001828
1829 // Walk into all VLAs. This doesn't require changes to addr,
1830 // which has type T* where T is the first non-VLA element type.
1831 do {
1832 QualType elementType = arrayType->getElementType();
1833 arrayType = getContext().getAsArrayType(elementType);
1834
1835 // If we only have VLA components, 'addr' requires no adjustment.
1836 if (!arrayType) {
1837 baseType = elementType;
1838 return numVLAElements;
1839 }
1840 } while (isa<VariableArrayType>(arrayType));
1841
1842 // We get out here only if we find a constant array type
1843 // inside the VLA.
1844 }
1845
1846 // We have some number of constant-length arrays, so addr should
1847 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks
1848 // down to the first element of addr.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001849 SmallVector<llvm::Value*, 8> gepIndices;
John McCall82fe67b2011-07-09 01:37:26 +00001850
1851 // GEP down to the array type.
1852 llvm::ConstantInt *zero = Builder.getInt32(0);
1853 gepIndices.push_back(zero);
1854
John McCall82fe67b2011-07-09 01:37:26 +00001855 uint64_t countFromCLAs = 1;
Richard Smithf3c37e82012-04-22 05:51:36 +00001856 QualType eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001857
Chris Lattner2192fe52011-07-18 04:24:23 +00001858 llvm::ArrayType *llvmArrayType =
John McCall7f416cc2015-09-08 08:05:57 +00001859 dyn_cast<llvm::ArrayType>(addr.getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001860 while (llvmArrayType) {
John McCall82fe67b2011-07-09 01:37:26 +00001861 assert(isa<ConstantArrayType>(arrayType));
1862 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1863 == llvmArrayType->getNumElements());
1864
1865 gepIndices.push_back(zero);
1866 countFromCLAs *= llvmArrayType->getNumElements();
Richard Smithf3c37e82012-04-22 05:51:36 +00001867 eltType = arrayType->getElementType();
John McCall82fe67b2011-07-09 01:37:26 +00001868
1869 llvmArrayType =
1870 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
John McCall82fe67b2011-07-09 01:37:26 +00001871 arrayType = getContext().getAsArrayType(arrayType->getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001872 assert((!llvmArrayType || arrayType) &&
1873 "LLVM and Clang types are out-of-synch");
John McCall82fe67b2011-07-09 01:37:26 +00001874 }
1875
Richard Smithf3c37e82012-04-22 05:51:36 +00001876 if (arrayType) {
1877 // From this point onwards, the Clang array type has been emitted
1878 // as some other type (probably a packed struct). Compute the array
1879 // size, and just emit the 'begin' expression as a bitcast.
1880 while (arrayType) {
1881 countFromCLAs *=
1882 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1883 eltType = arrayType->getElementType();
1884 arrayType = getContext().getAsArrayType(eltType);
1885 }
John McCall82fe67b2011-07-09 01:37:26 +00001886
John McCall7f416cc2015-09-08 08:05:57 +00001887 llvm::Type *baseType = ConvertType(eltType);
1888 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
Richard Smithf3c37e82012-04-22 05:51:36 +00001889 } else {
1890 // Create the actual GEP.
John McCall7f416cc2015-09-08 08:05:57 +00001891 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(),
1892 gepIndices, "array.begin"),
1893 addr.getAlignment());
Richard Smithf3c37e82012-04-22 05:51:36 +00001894 }
1895
1896 baseType = eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001897
1898 llvm::Value *numElements
1899 = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1900
1901 // If we had any VLA dimensions, factor them in.
1902 if (numVLAElements)
1903 numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1904
1905 return numElements;
1906}
1907
Sander de Smalen891af03a2018-02-03 13:55:59 +00001908CodeGenFunction::VlaSizePair CodeGenFunction::getVLASize(QualType type) {
John McCall23c29fe2011-06-24 21:55:10 +00001909 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1910 assert(vla && "type was not a variable array type!");
1911 return getVLASize(vla);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001912}
Anders Carlssonccbe9202008-12-12 07:19:02 +00001913
Sander de Smalen891af03a2018-02-03 13:55:59 +00001914CodeGenFunction::VlaSizePair
John McCall23c29fe2011-06-24 21:55:10 +00001915CodeGenFunction::getVLASize(const VariableArrayType *type) {
1916 // The number of elements so far; always size_t.
Craig Topper8a13c412014-05-21 05:09:00 +00001917 llvm::Value *numElements = nullptr;
John McCall23c29fe2011-06-24 21:55:10 +00001918
1919 QualType elementType;
1920 do {
1921 elementType = type->getElementType();
1922 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1923 assert(vlaSize && "no size for VLA!");
1924 assert(vlaSize->getType() == SizeTy);
1925
1926 if (!numElements) {
1927 numElements = vlaSize;
1928 } else {
1929 // It's undefined behavior if this wraps around, so mark it that way.
Alexey Samsonovcb3f8122014-03-20 10:48:29 +00001930 // FIXME: Teach -fsanitize=undefined to trap this.
John McCall23c29fe2011-06-24 21:55:10 +00001931 numElements = Builder.CreateNUWMul(numElements, vlaSize);
1932 }
1933 } while ((type = getContext().getAsVariableArrayType(elementType)));
1934
Sander de Smalen891af03a2018-02-03 13:55:59 +00001935 return { numElements, elementType };
1936}
1937
1938CodeGenFunction::VlaSizePair
1939CodeGenFunction::getVLAElements1D(QualType type) {
1940 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1941 assert(vla && "type was not a variable array type!");
1942 return getVLAElements1D(vla);
1943}
1944
1945CodeGenFunction::VlaSizePair
1946CodeGenFunction::getVLAElements1D(const VariableArrayType *Vla) {
1947 llvm::Value *VlaSize = VLASizeMap[Vla->getSizeExpr()];
1948 assert(VlaSize && "no size for VLA!");
1949 assert(VlaSize->getType() == SizeTy);
1950 return { VlaSize, Vla->getElementType() };
John McCall23c29fe2011-06-24 21:55:10 +00001951}
1952
1953void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
1954 assert(type->isVariablyModifiedType() &&
Anders Carlsson8a01b792008-12-20 20:46:34 +00001955 "Must pass variably modified type to EmitVLASizes!");
Mike Stump11289f42009-09-09 15:08:12 +00001956
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001957 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00001958
John McCall23c29fe2011-06-24 21:55:10 +00001959 // We're going to walk down into the type and look for VLA
1960 // expressions.
John McCall23c29fe2011-06-24 21:55:10 +00001961 do {
1962 assert(type->isVariablyModifiedType());
Mike Stump11289f42009-09-09 15:08:12 +00001963
John McCall23c29fe2011-06-24 21:55:10 +00001964 const Type *ty = type.getTypePtr();
1965 switch (ty->getTypeClass()) {
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001966
John McCall23c29fe2011-06-24 21:55:10 +00001967#define TYPE(Class, Base)
1968#define ABSTRACT_TYPE(Class, Base)
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001969#define NON_CANONICAL_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001970#define DEPENDENT_TYPE(Class, Base) case Type::Class:
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001971#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
John McCall36b12a82019-10-02 06:35:23 +00001972#include "clang/AST/TypeNodes.inc"
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001973 llvm_unreachable("unexpected dependent type!");
Mike Stump11289f42009-09-09 15:08:12 +00001974
John McCall23c29fe2011-06-24 21:55:10 +00001975 // These types are never variably-modified.
1976 case Type::Builtin:
1977 case Type::Complex:
1978 case Type::Vector:
1979 case Type::ExtVector:
1980 case Type::Record:
1981 case Type::Enum:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001982 case Type::Elaborated:
1983 case Type::TemplateSpecialization:
Manman Rene6be26c2016-09-13 17:25:08 +00001984 case Type::ObjCTypeParam:
John McCall23c29fe2011-06-24 21:55:10 +00001985 case Type::ObjCObject:
1986 case Type::ObjCInterface:
1987 case Type::ObjCObjectPointer:
1988 llvm_unreachable("type class is never variably-modified!");
Mike Stump11289f42009-09-09 15:08:12 +00001989
Reid Kleckner0503a872013-12-05 01:23:43 +00001990 case Type::Adjusted:
1991 type = cast<AdjustedType>(ty)->getAdjustedType();
1992 break;
1993
Reid Kleckner8a365022013-06-24 17:51:48 +00001994 case Type::Decayed:
1995 type = cast<DecayedType>(ty)->getPointeeType();
1996 break;
1997
John McCall23c29fe2011-06-24 21:55:10 +00001998 case Type::Pointer:
1999 type = cast<PointerType>(ty)->getPointeeType();
2000 break;
Mike Stump11289f42009-09-09 15:08:12 +00002001
John McCall23c29fe2011-06-24 21:55:10 +00002002 case Type::BlockPointer:
2003 type = cast<BlockPointerType>(ty)->getPointeeType();
2004 break;
2005
2006 case Type::LValueReference:
2007 case Type::RValueReference:
2008 type = cast<ReferenceType>(ty)->getPointeeType();
2009 break;
2010
2011 case Type::MemberPointer:
2012 type = cast<MemberPointerType>(ty)->getPointeeType();
2013 break;
2014
2015 case Type::ConstantArray:
2016 case Type::IncompleteArray:
2017 // Losing element qualification here is fine.
2018 type = cast<ArrayType>(ty)->getElementType();
2019 break;
2020
2021 case Type::VariableArray: {
2022 // Losing element qualification here is fine.
2023 const VariableArrayType *vat = cast<VariableArrayType>(ty);
2024
2025 // Unknown size indication requires no size computation.
2026 // Otherwise, evaluate and record it.
2027 if (const Expr *size = vat->getSizeExpr()) {
2028 // It's possible that we might have emitted this already,
2029 // e.g. with a typedef and a pointer to it.
2030 llvm::Value *&entry = VLASizeMap[size];
2031 if (!entry) {
Richard Smith481652b2012-10-10 01:11:12 +00002032 llvm::Value *Size = EmitScalarExpr(size);
2033
2034 // C11 6.7.6.2p5:
2035 // If the size is an expression that is not an integer constant
2036 // expression [...] each time it is evaluated it shall have a value
2037 // greater than zero.
Alexey Samsonovedf99a92014-11-07 22:29:38 +00002038 if (SanOpts.has(SanitizerKind::VLABound) &&
Richard Smithb1b0ab42012-11-05 22:21:05 +00002039 size->getType()->isSignedIntegerType()) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00002040 SanitizerScope SanScope(this);
Richard Smith481652b2012-10-10 01:11:12 +00002041 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
2042 llvm::Constant *StaticArgs[] = {
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002043 EmitCheckSourceLocation(size->getBeginLoc()),
2044 EmitCheckTypeDescriptor(size->getType())};
Alexey Samsonove396bfc2014-11-11 22:03:54 +00002045 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
2046 SanitizerKind::VLABound),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00002047 SanitizerHandler::VLABoundNotPositive, StaticArgs, Size);
Richard Smith481652b2012-10-10 01:11:12 +00002048 }
2049
John McCall23c29fe2011-06-24 21:55:10 +00002050 // Always zexting here would be wrong if it weren't
2051 // undefined behavior to have a negative bound.
Richard Smith8772bd82012-10-10 01:12:11 +00002052 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
John McCall23c29fe2011-06-24 21:55:10 +00002053 }
2054 }
2055 type = vat->getElementType();
2056 break;
Anders Carlsson8a01b792008-12-20 20:46:34 +00002057 }
Mike Stump11289f42009-09-09 15:08:12 +00002058
Abramo Bagnara1cd83682012-01-07 10:52:36 +00002059 case Type::FunctionProto:
John McCall23c29fe2011-06-24 21:55:10 +00002060 case Type::FunctionNoProto:
Alp Toker314cc812014-01-25 16:55:45 +00002061 type = cast<FunctionType>(ty)->getReturnType();
John McCall23c29fe2011-06-24 21:55:10 +00002062 break;
Eli Friedman0dfb8892011-10-06 23:00:33 +00002063
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002064 case Type::Paren:
2065 case Type::TypeOf:
2066 case Type::UnaryTransform:
2067 case Type::Attributed:
2068 case Type::SubstTemplateTypeParm:
David Blaikie66ed89d2013-07-13 21:08:08 +00002069 case Type::PackExpansion:
Leonard Chanc72aaf62019-05-07 03:20:17 +00002070 case Type::MacroQualified:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002071 // Keep walking after single level desugaring.
2072 type = type.getSingleStepDesugaredType(getContext());
2073 break;
2074
2075 case Type::Typedef:
2076 case Type::Decltype:
2077 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00002078 case Type::DeducedTemplateSpecialization:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00002079 // Stop walking: nothing to do.
2080 return;
2081
2082 case Type::TypeOfExpr:
2083 // Stop walking: emit typeof expression.
2084 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
2085 return;
2086
Eli Friedman0dfb8892011-10-06 23:00:33 +00002087 case Type::Atomic:
2088 type = cast<AtomicType>(ty)->getValueType();
2089 break;
Xiuli Pan9c14e282016-01-09 12:53:17 +00002090
2091 case Type::Pipe:
2092 type = cast<PipeType>(ty)->getElementType();
2093 break;
John McCall23c29fe2011-06-24 21:55:10 +00002094 }
2095 } while (type->isVariablyModifiedType());
Anders Carlssonccbe9202008-12-12 07:19:02 +00002096}
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002097
John McCall7f416cc2015-09-08 08:05:57 +00002098Address CodeGenFunction::EmitVAListRef(const Expr* E) {
Dan Gohmane9e32dc2010-10-29 22:47:07 +00002099 if (getContext().getBuiltinVaListType()->isArrayType())
John McCall7f416cc2015-09-08 08:05:57 +00002100 return EmitPointerWithAlignment(E);
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002101 return EmitLValue(E).getAddress(*this);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00002102}
Anders Carlsson15cb75a2009-02-07 22:53:43 +00002103
Charles Davisc7d5c942015-09-17 20:55:33 +00002104Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002105 return EmitLValue(E).getAddress(*this);
Charles Davisc7d5c942015-09-17 20:55:33 +00002106}
2107
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002108void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002109 const APValue &Init) {
Richard Smithe637cbe2019-05-21 23:15:18 +00002110 assert(Init.hasValue() && "Invalid DeclRefExpr initializer!");
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002111 if (CGDebugInfo *Dbg = getDebugInfo())
Benjamin Kramer8c305922016-02-02 11:06:51 +00002112 if (CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002113 Dbg->EmitGlobalVariable(E->getDecl(), Init);
Devang Patele03edfd2010-08-10 07:24:25 +00002114}
John McCallc07a0c72011-02-17 10:25:35 +00002115
2116CodeGenFunction::PeepholeProtection
2117CodeGenFunction::protectFromPeepholes(RValue rvalue) {
2118 // At the moment, the only aggressive peephole we do in IR gen
2119 // is trunc(zext) folding, but if we add more, we can easily
2120 // extend this protection.
2121
2122 if (!rvalue.isScalar()) return PeepholeProtection();
2123 llvm::Value *value = rvalue.getScalarVal();
2124 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
2125
2126 // Just make an extra bitcast.
2127 assert(HaveInsertPoint());
2128 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
2129 Builder.GetInsertBlock());
2130
2131 PeepholeProtection protection;
2132 protection.Inst = inst;
2133 return protection;
2134}
2135
2136void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
2137 if (!protection.Inst) return;
2138
2139 // In theory, we could try to duplicate the peepholes now, but whatever.
2140 protection.Inst->eraseFromParent();
2141}
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002142
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002143void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue,
2144 QualType Ty, SourceLocation Loc,
2145 SourceLocation AssumptionLoc,
2146 llvm::Value *Alignment,
2147 llvm::Value *OffsetValue) {
2148 llvm::Value *TheCheck;
2149 llvm::Instruction *Assumption = Builder.CreateAlignmentAssumption(
2150 CGM.getDataLayout(), PtrValue, Alignment, OffsetValue, &TheCheck);
2151 if (SanOpts.has(SanitizerKind::Alignment)) {
2152 EmitAlignmentAssumptionCheck(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
2153 OffsetValue, TheCheck, Assumption);
2154 }
2155}
2156
2157void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue,
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002158 const Expr *E,
2159 SourceLocation AssumptionLoc,
Erich Keanef7593952019-10-11 14:59:44 +00002160 llvm::Value *Alignment,
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002161 llvm::Value *OffsetValue) {
2162 if (auto *CE = dyn_cast<CastExpr>(E))
2163 E = CE->getSubExprAsWritten();
2164 QualType Ty = E->getType();
2165 SourceLocation Loc = E->getExprLoc();
2166
2167 EmitAlignmentAssumption(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
2168 OffsetValue);
2169}
2170
James Y Knight8799cae2019-02-03 21:53:49 +00002171llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Function *AnnotationFn,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002172 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002173 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002174 SourceLocation Location) {
2175 llvm::Value *Args[4] = {
2176 AnnotatedVal,
2177 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
2178 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
2179 CGM.EmitAnnotationLineNo(Location)
2180 };
2181 return Builder.CreateCall(AnnotationFn, Args);
2182}
2183
2184void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
2185 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2186 // FIXME We create a new bitcast for every annotation because that's what
2187 // llvm-gcc was doing.
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002188 for (const auto *I : D->specific_attrs<AnnotateAttr>())
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002189 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
2190 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002191 I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002192}
2193
John McCall7f416cc2015-09-08 08:05:57 +00002194Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
2195 Address Addr) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002196 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
John McCall7f416cc2015-09-08 08:05:57 +00002197 llvm::Value *V = Addr.getPointer();
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002198 llvm::Type *VTy = V->getType();
James Y Knight8799cae2019-02-03 21:53:49 +00002199 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002200 CGM.Int8PtrTy);
2201
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002202 for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002203 // FIXME Always emit the cast inst so we can differentiate between
2204 // annotation on the first field of a struct and annotation on the struct
2205 // itself.
2206 if (VTy != CGM.Int8PtrTy)
Erich Keane2a4eea32018-12-18 16:22:21 +00002207 V = Builder.CreateBitCast(V, CGM.Int8PtrTy);
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002208 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002209 V = Builder.CreateBitCast(V, VTy);
2210 }
2211
John McCall7f416cc2015-09-08 08:05:57 +00002212 return Address(V, Addr.getAlignment());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002213}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002214
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00002215CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
Alexander Musman515ad8c2014-05-22 08:54:05 +00002216
Alexey Samsonov24cad992014-07-17 18:46:27 +00002217CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
2218 : CGF(CGF) {
2219 assert(!CGF->IsSanitizerScope);
2220 CGF->IsSanitizerScope = true;
2221}
2222
2223CodeGenFunction::SanitizerScope::~SanitizerScope() {
2224 CGF->IsSanitizerScope = false;
2225}
2226
Alexander Musman515ad8c2014-05-22 08:54:05 +00002227void CodeGenFunction::InsertHelper(llvm::Instruction *I,
2228 const llvm::Twine &Name,
2229 llvm::BasicBlock *BB,
2230 llvm::BasicBlock::iterator InsertPt) const {
2231 LoopStack.InsertHelper(I);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00002232 if (IsSanitizerScope)
2233 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002234}
2235
Mehdi Amini557c20a2016-03-13 21:05:23 +00002236void CGBuilderInserter::InsertHelper(
Alexander Musman515ad8c2014-05-22 08:54:05 +00002237 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
2238 llvm::BasicBlock::iterator InsertPt) const {
Mehdi Amini557c20a2016-03-13 21:05:23 +00002239 llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002240 if (CGF)
2241 CGF->InsertHelper(I, Name, BB, InsertPt);
2242}
2243
David Blaikie5df253382015-11-12 01:09:58 +00002244static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures,
Eric Christopherce836772015-11-14 02:38:37 +00002245 CodeGenModule &CGM, const FunctionDecl *FD,
2246 std::string &FirstMissing) {
David Blaikie5df253382015-11-12 01:09:58 +00002247 // If there aren't any required features listed then go ahead and return.
2248 if (ReqFeatures.empty())
2249 return false;
2250
2251 // Now build up the set of caller features and verify that all the required
2252 // features are there.
2253 llvm::StringMap<bool> CallerFeatureMap;
Reid Klecknereff08f42019-12-06 15:42:14 -08002254 CGM.getFunctionFeatureMap(CallerFeatureMap, GlobalDecl().getWithDecl(FD));
David Blaikie5df253382015-11-12 01:09:58 +00002255
2256 // If we have at least one of the features in the feature list return
2257 // true, otherwise return false.
2258 return std::all_of(
2259 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) {
2260 SmallVector<StringRef, 1> OrFeatures;
Craig Topper274506d2018-05-03 21:01:33 +00002261 Feature.split(OrFeatures, '|');
Fangrui Song3117b172018-10-20 17:53:42 +00002262 return llvm::any_of(OrFeatures, [&](StringRef Feature) {
2263 if (!CallerFeatureMap.lookup(Feature)) {
2264 FirstMissing = Feature.str();
2265 return false;
2266 }
2267 return true;
2268 });
David Blaikie5df253382015-11-12 01:09:58 +00002269 });
2270}
2271
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002272// Emits an error if we don't have a valid set of target features for the
2273// called function.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002274void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
2275 const FunctionDecl *TargetDecl) {
Erich Keane36176242019-06-21 22:29:32 +00002276 return checkTargetFeatures(E->getBeginLoc(), TargetDecl);
2277}
2278
2279// Emits an error if we don't have a valid set of target features for the
2280// called function.
2281void CodeGenFunction::checkTargetFeatures(SourceLocation Loc,
2282 const FunctionDecl *TargetDecl) {
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002283 // Early exit if this is an indirect call.
2284 if (!TargetDecl)
2285 return;
2286
2287 // Get the current enclosing function if it exists. If it doesn't
2288 // we can't check the target features anyhow.
Erich Keane856f3fe2019-08-28 20:59:25 +00002289 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurCodeDecl);
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002290 if (!FD)
2291 return;
2292
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002293 // Grab the required features for the call. For a builtin this is listed in
2294 // the td file with the default cpu, for an always_inline function this is any
2295 // listed cpu and any listed features.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002296 unsigned BuiltinID = TargetDecl->getBuiltinID();
Eric Christopherce836772015-11-14 02:38:37 +00002297 std::string MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002298 if (BuiltinID) {
2299 SmallVector<StringRef, 1> ReqFeatures;
2300 const char *FeatureList =
2301 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2302 // Return if the builtin doesn't have any required features.
2303 if (!FeatureList || StringRef(FeatureList) == "")
2304 return;
Craig Topper274506d2018-05-03 21:01:33 +00002305 StringRef(FeatureList).split(ReqFeatures, ',');
Eric Christopherce836772015-11-14 02:38:37 +00002306 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Erich Keane36176242019-06-21 22:29:32 +00002307 CGM.getDiags().Report(Loc, diag::err_builtin_needs_feature)
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002308 << TargetDecl->getDeclName()
2309 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2310
Erich Keane0213add2019-11-18 13:38:56 -08002311 } else if (!TargetDecl->isMultiVersion() &&
2312 TargetDecl->hasAttr<TargetAttr>()) {
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002313 // Get the required features for the callee.
Gabor Buella1a83d062018-06-07 08:48:36 +00002314
2315 const TargetAttr *TD = TargetDecl->getAttr<TargetAttr>();
Craig Topper505aa242019-12-09 10:34:24 -08002316 ParsedTargetAttr ParsedAttr = CGM.filterFunctionTargetAttrs(TD);
Gabor Buella1a83d062018-06-07 08:48:36 +00002317
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002318 SmallVector<StringRef, 1> ReqFeatures;
2319 llvm::StringMap<bool> CalleeFeatureMap;
Reid Klecknereff08f42019-12-06 15:42:14 -08002320 CGM.getFunctionFeatureMap(CalleeFeatureMap, TargetDecl);
Gabor Buella1a83d062018-06-07 08:48:36 +00002321
2322 for (const auto &F : ParsedAttr.Features) {
2323 if (F[0] == '+' && CalleeFeatureMap.lookup(F.substr(1)))
2324 ReqFeatures.push_back(StringRef(F).substr(1));
2325 }
2326
Eric Christopherb7bbc532015-11-16 18:29:59 +00002327 for (const auto &F : CalleeFeatureMap) {
2328 // Only positive features are "required".
2329 if (F.getValue())
2330 ReqFeatures.push_back(F.getKey());
2331 }
Eric Christopherce836772015-11-14 02:38:37 +00002332 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Erich Keane36176242019-06-21 22:29:32 +00002333 CGM.getDiags().Report(Loc, diag::err_function_needs_feature)
Eric Christopherce836772015-11-14 02:38:37 +00002334 << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002335 }
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002336}
Peter Collingbournedc134532016-01-16 00:31:22 +00002337
2338void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) {
2339 if (!CGM.getCodeGenOpts().SanitizeStats)
2340 return;
2341
2342 llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint());
2343 IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation());
2344 CGM.getSanStats().create(IRB, SSK);
2345}
Amara Emerson652795d2016-11-10 14:44:30 +00002346
Erich Keanef353ae12018-09-13 16:58:24 +00002347llvm::Value *
2348CodeGenFunction::FormResolverCondition(const MultiVersionResolverOption &RO) {
2349 llvm::Value *Condition = nullptr;
Erich Keane281d20b2018-01-08 21:34:17 +00002350
Erich Keanef353ae12018-09-13 16:58:24 +00002351 if (!RO.Conditions.Architecture.empty())
2352 Condition = EmitX86CpuIs(RO.Conditions.Architecture);
2353
2354 if (!RO.Conditions.Features.empty()) {
2355 llvm::Value *FeatureCond = EmitX86CpuSupports(RO.Conditions.Features);
2356 Condition =
2357 Condition ? Builder.CreateAnd(Condition, FeatureCond) : FeatureCond;
Erich Keane281d20b2018-01-08 21:34:17 +00002358 }
Erich Keanef353ae12018-09-13 16:58:24 +00002359 return Condition;
Erich Keane281d20b2018-01-08 21:34:17 +00002360}
2361
Erich Keane19a8adc2018-10-25 18:57:19 +00002362static void CreateMultiVersionResolverReturn(CodeGenModule &CGM,
2363 llvm::Function *Resolver,
2364 CGBuilderTy &Builder,
2365 llvm::Function *FuncToReturn,
2366 bool SupportsIFunc) {
2367 if (SupportsIFunc) {
2368 Builder.CreateRet(FuncToReturn);
2369 return;
2370 }
2371
2372 llvm::SmallVector<llvm::Value *, 10> Args;
2373 llvm::for_each(Resolver->args(),
2374 [&](llvm::Argument &Arg) { Args.push_back(&Arg); });
2375
2376 llvm::CallInst *Result = Builder.CreateCall(FuncToReturn, Args);
2377 Result->setTailCallKind(llvm::CallInst::TCK_MustTail);
2378
2379 if (Resolver->getReturnType()->isVoidTy())
2380 Builder.CreateRetVoid();
2381 else
2382 Builder.CreateRet(Result);
2383}
2384
Erich Keanef353ae12018-09-13 16:58:24 +00002385void CodeGenFunction::EmitMultiVersionResolver(
2386 llvm::Function *Resolver, ArrayRef<MultiVersionResolverOption> Options) {
Erich Keane281d20b2018-01-08 21:34:17 +00002387 assert((getContext().getTargetInfo().getTriple().getArch() ==
2388 llvm::Triple::x86 ||
2389 getContext().getTargetInfo().getTriple().getArch() ==
2390 llvm::Triple::x86_64) &&
2391 "Only implemented for x86 targets");
Erich Keane19a8adc2018-10-25 18:57:19 +00002392
2393 bool SupportsIFunc = getContext().getTargetInfo().supportsIFunc();
2394
Erich Keane3efe0022018-07-20 14:13:28 +00002395 // Main function's basic block.
2396 llvm::BasicBlock *CurBlock = createBasicBlock("resolver_entry", Resolver);
2397 Builder.SetInsertPoint(CurBlock);
2398 EmitX86CpuInit();
2399
Erich Keanef353ae12018-09-13 16:58:24 +00002400 for (const MultiVersionResolverOption &RO : Options) {
Erich Keane3efe0022018-07-20 14:13:28 +00002401 Builder.SetInsertPoint(CurBlock);
Erich Keanef353ae12018-09-13 16:58:24 +00002402 llvm::Value *Condition = FormResolverCondition(RO);
Erich Keane3efe0022018-07-20 14:13:28 +00002403
Erich Keanef353ae12018-09-13 16:58:24 +00002404 // The 'default' or 'generic' case.
2405 if (!Condition) {
2406 assert(&RO == Options.end() - 1 &&
2407 "Default or Generic case must be last");
Erich Keane19a8adc2018-10-25 18:57:19 +00002408 CreateMultiVersionResolverReturn(CGM, Resolver, Builder, RO.Function,
2409 SupportsIFunc);
Erich Keane3efe0022018-07-20 14:13:28 +00002410 return;
2411 }
Erich Keanef353ae12018-09-13 16:58:24 +00002412
Erich Keane3efe0022018-07-20 14:13:28 +00002413 llvm::BasicBlock *RetBlock = createBasicBlock("resolver_return", Resolver);
Erich Keane19a8adc2018-10-25 18:57:19 +00002414 CGBuilderTy RetBuilder(*this, RetBlock);
2415 CreateMultiVersionResolverReturn(CGM, Resolver, RetBuilder, RO.Function,
2416 SupportsIFunc);
Erich Keane3efe0022018-07-20 14:13:28 +00002417 CurBlock = createBasicBlock("resolver_else", Resolver);
Erich Keanef353ae12018-09-13 16:58:24 +00002418 Builder.CreateCondBr(Condition, RetBlock, CurBlock);
Erich Keane3efe0022018-07-20 14:13:28 +00002419 }
2420
Erich Keanef353ae12018-09-13 16:58:24 +00002421 // If no generic/default, emit an unreachable.
Erich Keane3efe0022018-07-20 14:13:28 +00002422 Builder.SetInsertPoint(CurBlock);
2423 llvm::CallInst *TrapCall = EmitTrapCall(llvm::Intrinsic::trap);
2424 TrapCall->setDoesNotReturn();
2425 TrapCall->setDoesNotThrow();
2426 Builder.CreateUnreachable();
2427 Builder.ClearInsertionPoint();
2428}
2429
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002430// Loc - where the diagnostic will point, where in the source code this
2431// alignment has failed.
2432// SecondaryLoc - if present (will be present if sufficiently different from
2433// Loc), the diagnostic will additionally point a "Note:" to this location.
2434// It should be the location where the __attribute__((assume_aligned))
2435// was written e.g.
2436void CodeGenFunction::EmitAlignmentAssumptionCheck(
2437 llvm::Value *Ptr, QualType Ty, SourceLocation Loc,
2438 SourceLocation SecondaryLoc, llvm::Value *Alignment,
2439 llvm::Value *OffsetValue, llvm::Value *TheCheck,
2440 llvm::Instruction *Assumption) {
2441 assert(Assumption && isa<llvm::CallInst>(Assumption) &&
2442 cast<llvm::CallInst>(Assumption)->getCalledValue() ==
2443 llvm::Intrinsic::getDeclaration(
2444 Builder.GetInsertBlock()->getParent()->getParent(),
2445 llvm::Intrinsic::assume) &&
2446 "Assumption should be a call to llvm.assume().");
2447 assert(&(Builder.GetInsertBlock()->back()) == Assumption &&
2448 "Assumption should be the last instruction of the basic block, "
2449 "since the basic block is still being generated.");
2450
2451 if (!SanOpts.has(SanitizerKind::Alignment))
2452 return;
2453
2454 // Don't check pointers to volatile data. The behavior here is implementation-
2455 // defined.
2456 if (Ty->getPointeeType().isVolatileQualified())
2457 return;
2458
2459 // We need to temorairly remove the assumption so we can insert the
2460 // sanitizer check before it, else the check will be dropped by optimizations.
2461 Assumption->removeFromParent();
2462
2463 {
2464 SanitizerScope SanScope(this);
2465
2466 if (!OffsetValue)
2467 OffsetValue = Builder.getInt1(0); // no offset.
2468
2469 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(Loc),
2470 EmitCheckSourceLocation(SecondaryLoc),
2471 EmitCheckTypeDescriptor(Ty)};
2472 llvm::Value *DynamicData[] = {EmitCheckValue(Ptr),
2473 EmitCheckValue(Alignment),
2474 EmitCheckValue(OffsetValue)};
2475 EmitCheck({std::make_pair(TheCheck, SanitizerKind::Alignment)},
2476 SanitizerHandler::AlignmentAssumption, StaticData, DynamicData);
2477 }
2478
2479 // We are now in the (new, empty) "cont" basic block.
2480 // Reintroduce the assumption.
2481 Builder.Insert(Assumption);
2482 // FIXME: Assumption still has it's original basic block as it's Parent.
2483}
2484
Amara Emerson652795d2016-11-10 14:44:30 +00002485llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) {
2486 if (CGDebugInfo *DI = getDebugInfo())
2487 return DI->SourceLocToDebugLoc(Location);
2488
2489 return llvm::DebugLoc();
2490}