blob: 581bbe5efafffd707a54b632fbcbd0a940203997 [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"
Saleem Abdulrasool10a49722016-04-08 16:52:00 +000015#include "CGCleanup.h"
Peter Collingbournefa4d6032011-10-06 18:51:56 +000016#include "CGCUDARuntime.h"
John McCall5d865c322010-08-31 07:33:07 +000017#include "CGCXXABI.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"
Daniel Dunbar6e8aa532008-08-11 05:35:13 +000025#include "clang/AST/Decl.h"
Anders Carlsson468fa632009-04-04 20:47:02 +000026#include "clang/AST/DeclCXX.h"
Mike Stumpbee78dd2009-12-04 23:26:17 +000027#include "clang/AST/StmtCXX.h"
Richard Smithd8e3ac32016-09-16 23:30:39 +000028#include "clang/AST/StmtObjC.h"
Sanjay Patela24296b2015-09-02 20:01:30 +000029#include "clang/Basic/Builtins.h"
Richard Trieu63688182018-12-11 03:18:39 +000030#include "clang/Basic/CodeGenOptions.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000031#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000032#include "clang/CodeGen/CGFunctionInfo.h"
Richard Trieu5337c742018-12-06 06:12:20 +000033#include "clang/Frontend/FrontendDiagnostic.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000034#include "llvm/IR/DataLayout.h"
Gor Nishanov04491bd2017-11-11 17:00:43 +000035#include "llvm/IR/Dominators.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000036#include "llvm/IR/Intrinsics.h"
37#include "llvm/IR/MDBuilder.h"
38#include "llvm/IR/Operator.h"
Gor Nishanov04491bd2017-11-11 17:00:43 +000039#include "llvm/Transforms/Utils/PromoteMemToReg.h"
Chris Lattnerbed31442007-05-28 01:07:47 +000040using namespace clang;
41using namespace CodeGen;
42
Vitaly Buka1c943322016-10-26 01:59:57 +000043/// shouldEmitLifetimeMarkers - Decide whether we need emit the life-time
44/// markers.
45static bool shouldEmitLifetimeMarkers(const CodeGenOptions &CGOpts,
46 const LangOptions &LangOpts) {
Mehdi Amini7f873072017-01-06 23:18:09 +000047 if (CGOpts.DisableLifetimeMarkers)
48 return false;
49
Vitaly Buka1c943322016-10-26 01:59:57 +000050 // Disable lifetime markers in msan builds.
51 // FIXME: Remove this when msan works with lifetime markers.
52 if (LangOpts.Sanitize.has(SanitizerKind::Memory))
53 return false;
54
Benjamin Kramer2a7d39d2017-03-31 09:19:25 +000055 // Asan uses markers for use-after-scope checks.
56 if (CGOpts.SanitizeAddressUseAfterScope)
57 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);
Chris Lattner5696e7b2008-06-17 18:05:57 +000093}
Chris Lattnerd1af2d22007-05-29 23:17:50 +000094
John McCall08ef4662011-11-10 08:15:53 +000095CodeGenFunction::~CodeGenFunction() {
Richard Smith736a9472013-06-12 20:42:33 +000096 assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup");
97
John McCall08ef4662011-11-10 08:15:53 +000098 // If there are any unclaimed block infos, go ahead and destroy them
99 // now. This can happen if IR-gen gets clever and skips evaluating
100 // something.
101 if (FirstBlockInfo)
102 destroyBlockInfos(FirstBlockInfo);
Alexey Bataev9959db52014-05-06 10:08:46 +0000103
Alexey Bataev880d8602017-01-20 08:57:28 +0000104 if (getLangOpts().OpenMP && CurFn)
Alexey Bataev3eff5f42015-02-25 08:32:46 +0000105 CGM.getOpenMPRuntime().functionFinished(*this);
John McCall08ef4662011-11-10 08:15:53 +0000106}
107
John McCall7f416cc2015-09-08 08:05:57 +0000108CharUnits CodeGenFunction::getNaturalPointeeTypeAlignment(QualType T,
Ivan A. Kosareved141ba2017-10-17 09:12:13 +0000109 LValueBaseInfo *BaseInfo,
110 TBAAAccessInfo *TBAAInfo) {
111 return getNaturalTypeAlignment(T->getPointeeType(), BaseInfo, TBAAInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000112 /* forPointeeType= */ true);
David Majnemer99281062014-09-18 22:05:54 +0000113}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000114
John McCall7f416cc2015-09-08 08:05:57 +0000115CharUnits CodeGenFunction::getNaturalTypeAlignment(QualType T,
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000116 LValueBaseInfo *BaseInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000117 TBAAAccessInfo *TBAAInfo,
John McCall7f416cc2015-09-08 08:05:57 +0000118 bool forPointeeType) {
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000119 if (TBAAInfo)
120 *TBAAInfo = CGM.getTBAAAccessInfo(T);
121
John McCall7f416cc2015-09-08 08:05:57 +0000122 // Honor alignment typedef attributes even on incomplete types.
123 // We also honor them straight for C++ class types, even as pointees;
124 // there's an expressivity gap here.
125 if (auto TT = T->getAs<TypedefType>()) {
126 if (auto Align = TT->getDecl()->getMaxAlignment()) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000127 if (BaseInfo)
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +0000128 *BaseInfo = LValueBaseInfo(AlignmentSource::AttributedType);
John McCall7f416cc2015-09-08 08:05:57 +0000129 return getContext().toCharUnitsFromBits(Align);
130 }
131 }
132
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000133 if (BaseInfo)
Ivan A. Kosarevb9c59f32017-10-31 11:05:34 +0000134 *BaseInfo = LValueBaseInfo(AlignmentSource::Type);
John McCall7f416cc2015-09-08 08:05:57 +0000135
136 CharUnits Alignment;
David Majnemer9df56372015-09-10 21:52:00 +0000137 if (T->isIncompleteType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000138 Alignment = CharUnits::One(); // Shouldn't be used, but pessimistic is best.
139 } else {
140 // For C++ class pointees, we don't know whether we're pointing at a
141 // base or a complete object, so we generally need to use the
142 // non-virtual alignment.
143 const CXXRecordDecl *RD;
144 if (forPointeeType && (RD = T->getAsCXXRecordDecl())) {
145 Alignment = CGM.getClassPointerAlignment(RD);
146 } else {
147 Alignment = getContext().getTypeAlignInChars(T);
Roger Ferrer Ibanez3fa38a12017-03-08 14:00:44 +0000148 if (T.getQualifiers().hasUnaligned())
149 Alignment = CharUnits::One();
John McCall7f416cc2015-09-08 08:05:57 +0000150 }
151
152 // Cap to the global maximum type alignment unless the alignment
153 // was somehow explicit on the type.
154 if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) {
155 if (Alignment.getQuantity() > MaxAlign &&
156 !getContext().isAlignmentRequired(T))
157 Alignment = CharUnits::fromQuantity(MaxAlign);
158 }
159 }
160 return Alignment;
161}
162
163LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000164 LValueBaseInfo BaseInfo;
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000165 TBAAAccessInfo TBAAInfo;
166 CharUnits Alignment = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo);
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000167 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), BaseInfo,
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000168 TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000169}
170
171/// Given a value of type T* that may not be to a complete object,
172/// construct an l-value with the natural pointee alignment of T.
173LValue
174CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) {
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +0000175 LValueBaseInfo BaseInfo;
Ivan A. Kosarev78f486d2017-10-13 16:58:30 +0000176 TBAAAccessInfo TBAAInfo;
177 CharUnits Align = getNaturalTypeAlignment(T, &BaseInfo, &TBAAInfo,
178 /* forPointeeType= */ true);
179 return MakeAddrLValue(Address(V, Align), T, BaseInfo, TBAAInfo);
John McCall7f416cc2015-09-08 08:05:57 +0000180}
181
182
Chris Lattnera5f58b02011-07-09 17:41:47 +0000183llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) {
Daniel Dunbaree3da872009-02-03 23:03:55 +0000184 return CGM.getTypes().ConvertTypeForMem(T);
185}
186
Chris Lattnera5f58b02011-07-09 17:41:47 +0000187llvm::Type *CodeGenFunction::ConvertType(QualType T) {
Chris Lattnerf033c142007-06-22 19:05:19 +0000188 return CGM.getTypes().ConvertType(T);
Chris Lattner45bb9142007-06-09 02:28:57 +0000189}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000190
John McCall47fb9502013-03-07 21:37:08 +0000191TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) {
192 type = type.getCanonicalType();
193 while (true) {
194 switch (type->getTypeClass()) {
John McCall745ae282011-05-15 02:34:36 +0000195#define TYPE(name, parent)
196#define ABSTRACT_TYPE(name, parent)
197#define NON_CANONICAL_TYPE(name, parent) case Type::name:
198#define DEPENDENT_TYPE(name, parent) case Type::name:
199#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name:
200#include "clang/AST/TypeNodes.def"
John McCall47fb9502013-03-07 21:37:08 +0000201 llvm_unreachable("non-canonical or dependent type in IR-generation");
John McCall745ae282011-05-15 02:34:36 +0000202
Richard Smith27d807c2013-04-30 13:56:41 +0000203 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +0000204 case Type::DeducedTemplateSpecialization:
205 llvm_unreachable("undeduced type in IR-generation");
Richard Smith27d807c2013-04-30 13:56:41 +0000206
John McCall47fb9502013-03-07 21:37:08 +0000207 // Various scalar types.
208 case Type::Builtin:
209 case Type::Pointer:
210 case Type::BlockPointer:
211 case Type::LValueReference:
212 case Type::RValueReference:
213 case Type::MemberPointer:
214 case Type::Vector:
215 case Type::ExtVector:
216 case Type::FunctionProto:
217 case Type::FunctionNoProto:
218 case Type::Enum:
219 case Type::ObjCObjectPointer:
Xiuli Pan9c14e282016-01-09 12:53:17 +0000220 case Type::Pipe:
John McCall47fb9502013-03-07 21:37:08 +0000221 return TEK_Scalar;
John McCall745ae282011-05-15 02:34:36 +0000222
John McCall47fb9502013-03-07 21:37:08 +0000223 // Complexes.
224 case Type::Complex:
225 return TEK_Complex;
Eli Friedman0dfb8892011-10-06 23:00:33 +0000226
John McCall47fb9502013-03-07 21:37:08 +0000227 // Arrays, records, and Objective-C objects.
228 case Type::ConstantArray:
229 case Type::IncompleteArray:
230 case Type::VariableArray:
231 case Type::Record:
232 case Type::ObjCObject:
233 case Type::ObjCInterface:
234 return TEK_Aggregate;
235
236 // We operate on atomic values according to their underlying type.
237 case Type::Atomic:
238 type = cast<AtomicType>(type)->getValueType();
239 continue;
240 }
241 llvm_unreachable("unknown type kind!");
John McCall745ae282011-05-15 02:34:36 +0000242 }
Chris Lattner54fb19e2007-06-22 22:02:34 +0000243}
244
David Blaikie66e41972015-01-14 07:38:27 +0000245llvm::DebugLoc CodeGenFunction::EmitReturnBlock() {
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000246 // For cleanliness, we try to avoid emitting the return block for
247 // simple cases.
248 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
249
250 if (CurBB) {
251 assert(!CurBB->getTerminator() && "Unexpected terminated block.");
252
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000253 // We have a valid insert point, reuse it if it is empty or there are no
254 // explicit jumps to the return block.
John McCallad5d61e2010-07-23 21:56:41 +0000255 if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) {
256 ReturnBlock.getBlock()->replaceAllUsesWith(CurBB);
257 delete ReturnBlock.getBlock();
John McCall8b36ac82019-04-10 17:03:09 +0000258 ReturnBlock = JumpDest();
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000259 } else
John McCallad5d61e2010-07-23 21:56:41 +0000260 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000261 return llvm::DebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000262 }
263
264 // Otherwise, if the return block is the target of a single direct
265 // branch then we can just put the code in that block instead. This
266 // cleans up functions which started with a unified return block.
John McCallad5d61e2010-07-23 21:56:41 +0000267 if (ReturnBlock.getBlock()->hasOneUse()) {
Mike Stump11289f42009-09-09 15:08:12 +0000268 llvm::BranchInst *BI =
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000269 dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin());
John McCallbd309292010-07-06 01:34:17 +0000270 if (BI && BI->isUnconditional() &&
John McCallad5d61e2010-07-23 21:56:41 +0000271 BI->getSuccessor(0) == ReturnBlock.getBlock()) {
David Blaikie66e41972015-01-14 07:38:27 +0000272 // Record/return the DebugLoc of the simple 'return' expression to be used
273 // later by the actual 'ret' instruction.
274 llvm::DebugLoc Loc = BI->getDebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000275 Builder.SetInsertPoint(BI->getParent());
276 BI->eraseFromParent();
John McCallad5d61e2010-07-23 21:56:41 +0000277 delete ReturnBlock.getBlock();
John McCall8b36ac82019-04-10 17:03:09 +0000278 ReturnBlock = JumpDest();
David Blaikie66e41972015-01-14 07:38:27 +0000279 return Loc;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000280 }
281 }
282
Mike Stump18bb9282009-05-16 07:57:57 +0000283 // FIXME: We are at an unreachable point, there is no reason to emit the block
284 // unless it has uses. However, we still need a place to put the debug
285 // region.end for now.
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000286
John McCallad5d61e2010-07-23 21:56:41 +0000287 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000288 return llvm::DebugLoc();
John McCallbd309292010-07-06 01:34:17 +0000289}
290
291static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) {
292 if (!BB) return;
293 if (!BB->use_empty())
294 return CGF.CurFn->getBasicBlockList().push_back(BB);
295 delete BB;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000296}
297
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000298void CodeGenFunction::FinishFunction(SourceLocation EndLoc) {
Chris Lattnere73e4322007-07-16 21:28:45 +0000299 assert(BreakContinueStack.empty() &&
300 "mismatched push/pop in break/continue stack!");
Mike Stump11289f42009-09-09 15:08:12 +0000301
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000302 bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0
Adrian Prantl524ba1f2013-07-25 00:23:42 +0000303 && NumSimpleReturnExprs == NumReturnExprs
304 && ReturnBlock.getBlock()->use_empty();
305 // Usually the return expression is evaluated before the cleanup
306 // code. If the function contains only a simple return statement,
307 // such as a constant, the location before the cleanup code becomes
308 // the last useful breakpoint in the function, because the simple
309 // return expression will be evaluated after the cleanup code. To be
310 // safe, set the debug location for cleanup code to the location of
311 // the return statement. Otherwise the cleanup code should be at the
312 // end of the function's lexical scope.
313 //
314 // If there are multiple branches to the return block, the branch
315 // instructions will get the location of the return statements and
316 // all will be fine.
Adrian Prantl3be10542013-05-02 17:30:20 +0000317 if (CGDebugInfo *DI = getDebugInfo()) {
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000318 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000319 DI->EmitLocation(Builder, LastStopPoint);
Adrian Prantl3be10542013-05-02 17:30:20 +0000320 else
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000321 DI->EmitLocation(Builder, EndLoc);
Adrian Prantl3be10542013-05-02 17:30:20 +0000322 }
David Blaikie357aafb2013-02-01 19:09:49 +0000323
John McCall31168b02011-06-15 23:02:42 +0000324 // Pop any cleanups that might have been associated with the
325 // parameters. Do this in whatever block we're currently in; it's
326 // important to do this before we enter the return block or return
327 // edges will be *really* confused.
David Majnemerdc012fa2015-04-22 21:38:15 +0000328 bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth;
329 bool HasOnlyLifetimeMarkers =
330 HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth);
331 bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers;
332 if (HasCleanups) {
Adrian Prantl3be10542013-05-02 17:30:20 +0000333 // Make sure the line table doesn't jump back into the body for
334 // the ret after it's been at EndLoc.
Adrian Prantl3be10542013-05-02 17:30:20 +0000335 if (CGDebugInfo *DI = getDebugInfo())
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000336 if (OnlySimpleReturnStmts)
Calixte Denizetfcd661d2018-09-24 18:24:18 +0000337 DI->EmitLocation(Builder, EndLoc);
David Blaikie4d524432015-02-04 19:47:54 +0000338
339 PopCleanupBlocks(PrologueCleanupDepth);
Adrian Prantl3be10542013-05-02 17:30:20 +0000340 }
341
Mike Stump11289f42009-09-09 15:08:12 +0000342 // Emit function epilog (to return).
David Blaikie66e41972015-01-14 07:38:27 +0000343 llvm::DebugLoc Loc = EmitReturnBlock();
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000344
Hans Wennborg76c26c12017-11-14 21:13:27 +0000345 if (ShouldInstrumentFunction()) {
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000346 if (CGM.getCodeGenOpts().InstrumentFunctions)
347 CurFn->addFnAttr("instrument-function-exit", "__cyg_profile_func_exit");
348 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
349 CurFn->addFnAttr("instrument-function-exit-inlined",
350 "__cyg_profile_func_exit");
Hans Wennborg76c26c12017-11-14 21:13:27 +0000351 }
Chris Lattner3c77a352010-06-22 00:03:40 +0000352
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000353 // Emit debug descriptor for function end.
David Blaikie66e41972015-01-14 07:38:27 +0000354 if (CGDebugInfo *DI = getDebugInfo())
Keno Fischer41d4b4e2017-06-01 21:14:03 +0000355 DI->EmitFunctionEnd(Builder, CurFn);
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000356
David Blaikie66e41972015-01-14 07:38:27 +0000357 // Reset the debug location to that of the simple 'return' expression, if any
358 // rather than that of the end of the function's scope '}'.
359 ApplyDebugLocation AL(*this, Loc);
Nick Lewycky2d84e842013-10-02 02:29:49 +0000360 EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc);
Mike Stump1d849212009-12-07 23:38:24 +0000361 EmitEndEHSpec(CurCodeDecl);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000362
John McCallbd309292010-07-06 01:34:17 +0000363 assert(EHStack.empty() &&
364 "did not remove all scopes from cleanup stack!");
365
Chris Lattner6c4d2552009-10-28 23:59:40 +0000366 // If someone did an indirect goto, emit the indirect goto block at the end of
367 // the function.
368 if (IndirectBranch) {
369 EmitBlock(IndirectBranch->getParent());
370 Builder.ClearInsertionPoint();
371 }
Michael Ilseman686240a2012-12-04 00:29:55 +0000372
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000373 // If some of our locals escaped, insert a call to llvm.localescape in the
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000374 // entry block.
375 if (!EscapedLocals.empty()) {
376 // Invert the map from local to index into a simple vector. There should be
377 // no holes.
378 SmallVector<llvm::Value *, 4> EscapeArgs;
379 EscapeArgs.resize(EscapedLocals.size());
380 for (auto &Pair : EscapedLocals)
381 EscapeArgs[Pair.second] = Pair.first;
382 llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration(
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000383 &CGM.getModule(), llvm::Intrinsic::localescape);
John McCall7f416cc2015-09-08 08:05:57 +0000384 CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs);
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000385 }
386
Chris Lattnerc48023b2007-12-02 06:32:24 +0000387 // Remove the AllocaInsertPt instruction, which is just a convenience for us.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000388 llvm::Instruction *Ptr = AllocaInsertPt;
Craig Topper8a13c412014-05-21 05:09:00 +0000389 AllocaInsertPt = nullptr;
Chris Lattner2739d2b2009-03-31 22:17:44 +0000390 Ptr->eraseFromParent();
Michael Ilseman686240a2012-12-04 00:29:55 +0000391
Chris Lattner6c4d2552009-10-28 23:59:40 +0000392 // If someone took the address of a label but never did an indirect goto, we
393 // made a zero entry PHI node, which is illegal, zap it now.
394 if (IndirectBranch) {
395 llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress());
396 if (PN->getNumIncomingValues() == 0) {
397 PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType()));
398 PN->eraseFromParent();
399 }
400 }
John McCallbd309292010-07-06 01:34:17 +0000401
John McCall8e4c74b2011-08-11 02:22:43 +0000402 EmitIfUsed(*this, EHResumeBlock);
John McCallbd309292010-07-06 01:34:17 +0000403 EmitIfUsed(*this, TerminateLandingPad);
404 EmitIfUsed(*this, TerminateHandler);
405 EmitIfUsed(*this, UnreachableBlock);
John McCall09ae0322010-07-06 23:57:41 +0000406
Reid Kleckner06f19a02018-01-02 21:34:16 +0000407 for (const auto &FuncletAndParent : TerminateFunclets)
408 EmitIfUsed(*this, FuncletAndParent.second);
409
John McCall09ae0322010-07-06 23:57:41 +0000410 if (CGM.getCodeGenOpts().EmitDeclMetadata)
411 EmitDeclMetadata();
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000412
413 for (SmallVectorImpl<std::pair<llvm::Instruction *, llvm::Value *> >::iterator
414 I = DeferredReplacements.begin(),
415 E = DeferredReplacements.end();
416 I != E; ++I) {
417 I->first->replaceAllUsesWith(I->second);
418 I->first->eraseFromParent();
419 }
Gor Nishanov04491bd2017-11-11 17:00:43 +0000420
421 // Eliminate CleanupDestSlot alloca by replacing it with SSA values and
422 // PHIs if the current function is a coroutine. We don't do it for all
423 // functions as it may result in slight increase in numbers of instructions
424 // if compiled with no optimizations. We do it for coroutine as the lifetime
425 // of CleanupDestSlot alloca make correct coroutine frame building very
426 // difficult.
John McCall5cdf0382018-01-12 22:07:01 +0000427 if (NormalCleanupDest.isValid() && isCoroutine()) {
Gor Nishanov04491bd2017-11-11 17:00:43 +0000428 llvm::DominatorTree DT(*CurFn);
John McCall5cdf0382018-01-12 22:07:01 +0000429 llvm::PromoteMemToReg(
430 cast<llvm::AllocaInst>(NormalCleanupDest.getPointer()), DT);
431 NormalCleanupDest = Address::invalid();
Gor Nishanov04491bd2017-11-11 17:00:43 +0000432 }
Craig Topper74c10e32018-07-09 19:00:16 +0000433
Craig Topper3113ec32018-10-24 17:42:17 +0000434 // Scan function arguments for vector width.
435 for (llvm::Argument &A : CurFn->args())
436 if (auto *VT = dyn_cast<llvm::VectorType>(A.getType()))
437 LargestVectorWidth = std::max(LargestVectorWidth,
438 VT->getPrimitiveSizeInBits());
439
440 // Update vector width based on return type.
441 if (auto *VT = dyn_cast<llvm::VectorType>(CurFn->getReturnType()))
442 LargestVectorWidth = std::max(LargestVectorWidth,
443 VT->getPrimitiveSizeInBits());
444
445 // Add the required-vector-width attribute. This contains the max width from:
446 // 1. min-vector-width attribute used in the source program.
447 // 2. Any builtins used that have a vector width specified.
448 // 3. Values passed in and out of inline assembly.
449 // 4. Width of vector arguments and return types for this function.
450 // 5. Width of vector aguments and return types for functions called by this
451 // function.
Craig Topper00897e92018-10-25 05:04:35 +0000452 CurFn->addFnAttr("min-legal-vector-width", llvm::utostr(LargestVectorWidth));
John McCall8b36ac82019-04-10 17:03:09 +0000453
454 // If we generated an unreachable return block, delete it now.
455 if (ReturnBlock.isValid() && ReturnBlock.getBlock()->use_empty()) {
456 Builder.ClearInsertionPoint();
457 ReturnBlock.getBlock()->eraseFromParent();
458 }
459 if (ReturnValue.isValid()) {
460 auto *RetAlloca = dyn_cast<llvm::AllocaInst>(ReturnValue.getPointer());
461 if (RetAlloca && RetAlloca->use_empty()) {
462 RetAlloca->eraseFromParent();
463 ReturnValue = Address::invalid();
464 }
465 }
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000466}
Chris Lattner308f4312007-05-29 23:50:05 +0000467
Chris Lattner3c77a352010-06-22 00:03:40 +0000468/// ShouldInstrumentFunction - Return true if the current function should be
469/// instrumented with __cyg_profile_func_* calls
470bool CodeGenFunction::ShouldInstrumentFunction() {
Hans Wennborg76c26c12017-11-14 21:13:27 +0000471 if (!CGM.getCodeGenOpts().InstrumentFunctions &&
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000472 !CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining &&
473 !CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
Chris Lattner3c77a352010-06-22 00:03:40 +0000474 return false;
Ted Kremenekc249c412011-05-16 23:49:20 +0000475 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
Chris Lattner3c77a352010-06-22 00:03:40 +0000476 return false;
477 return true;
478}
479
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000480/// ShouldXRayInstrument - Return true if the current function should be
481/// instrumented with XRay nop sleds.
482bool CodeGenFunction::ShouldXRayInstrumentFunction() const {
483 return CGM.getCodeGenOpts().XRayInstrumentFunctions;
484}
485
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000486/// AlwaysEmitXRayCustomEvents - Return true if we should emit IR for calls to
Keith Wyssf437e352018-04-17 21:32:43 +0000487/// the __xray_customevent(...) builtin calls, when doing XRay instrumentation.
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000488bool CodeGenFunction::AlwaysEmitXRayCustomEvents() const {
Dean Michael Berris488f7c22018-04-13 02:31:58 +0000489 return CGM.getCodeGenOpts().XRayInstrumentFunctions &&
490 (CGM.getCodeGenOpts().XRayAlwaysEmitCustomEvents ||
491 CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask ==
492 XRayInstrKind::Custom);
Dean Michael Berris1a5b10d2017-11-30 00:04:54 +0000493}
494
Keith Wyssf437e352018-04-17 21:32:43 +0000495bool CodeGenFunction::AlwaysEmitXRayTypedEvents() const {
496 return CGM.getCodeGenOpts().XRayInstrumentFunctions &&
497 (CGM.getCodeGenOpts().XRayAlwaysEmitTypedEvents ||
498 CGM.getCodeGenOpts().XRayInstrumentationBundle.Mask ==
499 XRayInstrKind::Typed);
500}
501
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000502llvm::Constant *
503CodeGenFunction::EncodeAddrForUseInPrologue(llvm::Function *F,
504 llvm::Constant *Addr) {
505 // Addresses stored in prologue data can't require run-time fixups and must
506 // be PC-relative. Run-time fixups are undesirable because they necessitate
507 // writable text segments, which are unsafe. And absolute addresses are
508 // undesirable because they break PIE mode.
509
510 // Add a layer of indirection through a private global. Taking its address
511 // won't result in a run-time fixup, even if Addr has linkonce_odr linkage.
512 auto *GV = new llvm::GlobalVariable(CGM.getModule(), Addr->getType(),
513 /*isConstant=*/true,
514 llvm::GlobalValue::PrivateLinkage, Addr);
515
516 // Create a PC-relative address.
517 auto *GOTAsInt = llvm::ConstantExpr::getPtrToInt(GV, IntPtrTy);
518 auto *FuncAsInt = llvm::ConstantExpr::getPtrToInt(F, IntPtrTy);
519 auto *PCRelAsInt = llvm::ConstantExpr::getSub(GOTAsInt, FuncAsInt);
520 return (IntPtrTy == Int32Ty)
521 ? PCRelAsInt
522 : llvm::ConstantExpr::getTrunc(PCRelAsInt, Int32Ty);
523}
524
525llvm::Value *
526CodeGenFunction::DecodeAddrUsedInPrologue(llvm::Value *F,
527 llvm::Value *EncodedAddr) {
528 // Reconstruct the address of the global.
529 auto *PCRelAsInt = Builder.CreateSExt(EncodedAddr, IntPtrTy);
530 auto *FuncAsInt = Builder.CreatePtrToInt(F, IntPtrTy, "func_addr.int");
531 auto *GOTAsInt = Builder.CreateAdd(PCRelAsInt, FuncAsInt, "global_addr.int");
532 auto *GOTAddr = Builder.CreateIntToPtr(GOTAsInt, Int8PtrPtrTy, "global_addr");
533
534 // Load the original pointer through the global.
535 return Builder.CreateLoad(Address(GOTAddr, getPointerAlign()),
536 "decoded_addr");
537}
538
Michael Ilseman686240a2012-12-04 00:29:55 +0000539void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000540 llvm::Function *Fn)
541{
542 if (!FD->hasAttr<OpenCLKernelAttr>())
543 return;
544
545 llvm::LLVMContext &Context = getLLVMContext();
546
Anastasia Stulovae6cf6c72019-05-09 13:55:44 +0000547 CGM.GenOpenCLArgMetadata(Fn, FD, this);
Michael Ilseman686240a2012-12-04 00:29:55 +0000548
Aaron Ballmanc4327992013-12-19 03:09:10 +0000549 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000550 QualType HintQTy = A->getTypeHint();
551 const ExtVectorType *HintEltQTy = HintQTy->getAs<ExtVectorType>();
552 bool IsSignedInteger =
553 HintQTy->isSignedIntegerType() ||
554 (HintEltQTy && HintEltQTy->getElementType()->isSignedIntegerType());
555 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000556 llvm::ConstantAsMetadata::get(llvm::UndefValue::get(
557 CGM.getTypes().ConvertType(A->getTypeHint()))),
558 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
559 llvm::IntegerType::get(Context, 32),
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000560 llvm::APInt(32, (uint64_t)(IsSignedInteger ? 1 : 0))))};
561 Fn->setMetadata("vec_type_hint", llvm::MDNode::get(Context, AttrMDArgs));
Joey Goulyaba589c2013-03-08 09:42:32 +0000562 }
563
Aaron Ballmanc4327992013-12-19 03:09:10 +0000564 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000565 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000566 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
567 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
568 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000569 Fn->setMetadata("work_group_size_hint", llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000570 }
571
Aaron Ballmanc4327992013-12-19 03:09:10 +0000572 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) {
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000573 llvm::Metadata *AttrMDArgs[] = {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000574 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
575 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
576 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Xiuli Panbe6da4b2017-05-04 07:31:20 +0000577 Fn->setMetadata("reqd_work_group_size", llvm::MDNode::get(Context, AttrMDArgs));
578 }
579
580 if (const OpenCLIntelReqdSubGroupSizeAttr *A =
581 FD->getAttr<OpenCLIntelReqdSubGroupSizeAttr>()) {
582 llvm::Metadata *AttrMDArgs[] = {
583 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getSubGroupSize()))};
584 Fn->setMetadata("intel_reqd_sub_group_size",
585 llvm::MDNode::get(Context, AttrMDArgs));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000586 }
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000587}
588
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000589/// Determine whether the function F ends with a return stmt.
590static bool endsWithReturn(const Decl* F) {
591 const Stmt *Body = nullptr;
592 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F))
593 Body = FD->getBody();
594 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F))
595 Body = OMD->getBody();
596
597 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) {
598 auto LastStmt = CS->body_rbegin();
599 if (LastStmt != CS->body_rend())
600 return isa<ReturnStmt>(*LastStmt);
601 }
602 return false;
603}
604
Akira Hatanaka9978da32018-08-10 15:09:24 +0000605void CodeGenFunction::markAsIgnoreThreadCheckingAtRuntime(llvm::Function *Fn) {
606 if (SanOpts.has(SanitizerKind::Thread)) {
607 Fn->addFnAttr("sanitize_thread_no_checking_at_run_time");
608 Fn->removeFnAttr(llvm::Attribute::SanitizeThread);
609 }
Anna Zakse43b4fc2017-01-13 00:50:50 +0000610}
611
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000612static bool matchesStlAllocatorFn(const Decl *D, const ASTContext &Ctx) {
613 auto *MD = dyn_cast_or_null<CXXMethodDecl>(D);
614 if (!MD || !MD->getDeclName().getAsIdentifierInfo() ||
615 !MD->getDeclName().getAsIdentifierInfo()->isStr("allocate") ||
616 (MD->getNumParams() != 1 && MD->getNumParams() != 2))
617 return false;
618
619 if (MD->parameters()[0]->getType().getCanonicalType() != Ctx.getSizeType())
620 return false;
621
622 if (MD->getNumParams() == 2) {
623 auto *PT = MD->parameters()[1]->getType()->getAs<PointerType>();
624 if (!PT || !PT->isVoidPointerType() ||
625 !PT->getPointeeType().isConstQualified())
626 return false;
627 }
628
629 return true;
630}
631
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000632/// Return the UBSan prologue signature for \p FD if one is available.
633static llvm::Constant *getPrologueSignature(CodeGenModule &CGM,
634 const FunctionDecl *FD) {
635 if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
636 if (!MD->isStatic())
637 return nullptr;
638 return CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM);
639}
640
John McCalldec348f72013-05-03 07:33:41 +0000641void CodeGenFunction::StartFunction(GlobalDecl GD,
642 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000643 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +0000644 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000645 const FunctionArgList &Args,
Adrian Prantl42d71b92014-04-10 23:21:53 +0000646 SourceLocation Loc,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +0000647 SourceLocation StartLoc) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000648 assert(!CurFn &&
649 "Do not use a CodeGenFunction object for more than one function");
650
Anders Carlsson73fcc952009-09-11 00:07:24 +0000651 const Decl *D = GD.getDecl();
Michael Ilseman686240a2012-12-04 00:29:55 +0000652
Anders Carlssonf4478e92009-02-09 20:20:56 +0000653 DidCallStackSave = false;
John McCalldec348f72013-05-03 07:33:41 +0000654 CurCodeDecl = D;
David Majnemer25eb1652016-03-01 19:42:53 +0000655 if (const auto *FD = dyn_cast_or_null<FunctionDecl>(D))
656 if (FD->usesSEHTry())
657 CurSEHParent = FD;
Craig Topper8a13c412014-05-21 05:09:00 +0000658 CurFuncDecl = (D ? D->getNonClosureContext() : nullptr);
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000659 FnRetTy = RetTy;
Daniel Dunbar9c426522008-07-29 23:18:29 +0000660 CurFn = Fn;
John McCalla738c252011-03-09 04:27:21 +0000661 CurFnInfo = &FnInfo;
Chris Lattner5696e7b2008-06-17 18:05:57 +0000662 assert(CurFn->isDeclaration() && "Function already has body?");
663
Vlad Tsyrklevich2eccdab2017-09-25 22:11:12 +0000664 // If this function has been blacklisted for any of the enabled sanitizers,
665 // disable the sanitizer for the function.
666 do {
667#define SANITIZER(NAME, ID) \
668 if (SanOpts.empty()) \
669 break; \
670 if (SanOpts.has(SanitizerKind::ID)) \
671 if (CGM.isInSanitizerBlacklist(SanitizerKind::ID, Fn, Loc)) \
672 SanOpts.set(SanitizerKind::ID, false);
673
674#include "clang/Basic/Sanitizers.def"
675#undef SANITIZER
676 } while (0);
Will Dietzf54319c2013-01-18 11:30:38 +0000677
Peter Collingbourne915df992015-05-15 18:33:32 +0000678 if (D) {
679 // Apply the no_sanitize* attributes to SanOpts.
Vitaly Buka69a2e182018-04-09 20:10:29 +0000680 for (auto Attr : D->specific_attrs<NoSanitizeAttr>()) {
681 SanitizerMask mask = Attr->getMask();
682 SanOpts.Mask &= ~mask;
683 if (mask & SanitizerKind::Address)
684 SanOpts.set(SanitizerKind::KernelAddress, false);
685 if (mask & SanitizerKind::KernelAddress)
686 SanOpts.set(SanitizerKind::Address, false);
Andrey Konovalov1ba9d9c2018-04-13 18:05:21 +0000687 if (mask & SanitizerKind::HWAddress)
688 SanOpts.set(SanitizerKind::KernelHWAddress, false);
689 if (mask & SanitizerKind::KernelHWAddress)
690 SanOpts.set(SanitizerKind::HWAddress, false);
Vitaly Buka69a2e182018-04-09 20:10:29 +0000691 }
Peter Collingbourne915df992015-05-15 18:33:32 +0000692 }
693
694 // Apply sanitizer attributes to the function.
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000695 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress))
Peter Collingbourne915df992015-05-15 18:33:32 +0000696 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
Andrey Konovalov1ba9d9c2018-04-13 18:05:21 +0000697 if (SanOpts.hasOneOf(SanitizerKind::HWAddress | SanitizerKind::KernelHWAddress))
Evgeniy Stepanov12817e52017-12-09 01:32:07 +0000698 Fn->addFnAttr(llvm::Attribute::SanitizeHWAddress);
Peter Collingbourne915df992015-05-15 18:33:32 +0000699 if (SanOpts.has(SanitizerKind::Thread))
700 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
Alexander Potapenkod49c32c2018-09-07 09:21:09 +0000701 if (SanOpts.hasOneOf(SanitizerKind::Memory | SanitizerKind::KernelMemory))
Peter Collingbourne915df992015-05-15 18:33:32 +0000702 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000703 if (SanOpts.has(SanitizerKind::SafeStack))
704 Fn->addFnAttr(llvm::Attribute::SafeStack);
Vlad Tsyrkleviche55aa032018-04-03 22:33:53 +0000705 if (SanOpts.has(SanitizerKind::ShadowCallStack))
706 Fn->addFnAttr(llvm::Attribute::ShadowCallStack);
Peter Collingbourne915df992015-05-15 18:33:32 +0000707
Matt Morehouse5317f2e2018-03-23 23:35:28 +0000708 // Apply fuzzing attribute to the function.
709 if (SanOpts.hasOneOf(SanitizerKind::Fuzzer | SanitizerKind::FuzzerNoLink))
710 Fn->addFnAttr(llvm::Attribute::OptForFuzzing);
711
Anna Zaksbcd35a82016-11-11 23:22:44 +0000712 // Ignore TSan memory acesses from within ObjC/ObjC++ dealloc, initialize,
Anna Zakse43b4fc2017-01-13 00:50:50 +0000713 // .cxx_destruct, __destroy_helper_block_ and all of their calees at run time.
Anna Zaksbcd35a82016-11-11 23:22:44 +0000714 if (SanOpts.has(SanitizerKind::Thread)) {
715 if (const auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(D)) {
716 IdentifierInfo *II = OMD->getSelector().getIdentifierInfoForSlot(0);
717 if (OMD->getMethodFamily() == OMF_dealloc ||
718 OMD->getMethodFamily() == OMF_initialize ||
719 (OMD->getSelector().isUnarySelector() && II->isStr(".cxx_destruct"))) {
Anna Zakse43b4fc2017-01-13 00:50:50 +0000720 markAsIgnoreThreadCheckingAtRuntime(Fn);
Anna Zaksbcd35a82016-11-11 23:22:44 +0000721 }
722 }
723 }
724
Vlad Tsyrklevich3f3aad22017-08-04 21:21:00 +0000725 // Ignore unrelated casts in STL allocate() since the allocator must cast
726 // from void* to T* before object initialization completes. Don't match on the
727 // namespace because not all allocators are in std::
728 if (D && SanOpts.has(SanitizerKind::CFIUnrelatedCast)) {
729 if (matchesStlAllocatorFn(D, getContext()))
730 SanOpts.Mask &= ~SanitizerKind::CFIUnrelatedCast;
731 }
732
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000733 // Apply xray attributes to the function (as a string, for now)
Dean Michael Berris05cf4432018-09-14 01:59:12 +0000734 if (D) {
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000735 if (const auto *XRayAttr = D->getAttr<XRayInstrumentAttr>()) {
Dean Michael Berris05cf4432018-09-14 01:59:12 +0000736 if (CGM.getCodeGenOpts().XRayInstrumentationBundle.has(
737 XRayInstrKind::Function)) {
738 if (XRayAttr->alwaysXRayInstrument() && ShouldXRayInstrumentFunction())
739 Fn->addFnAttr("function-instrument", "xray-always");
740 if (XRayAttr->neverXRayInstrument())
741 Fn->addFnAttr("function-instrument", "xray-never");
742 if (const auto *LogArgs = D->getAttr<XRayLogArgsAttr>())
743 if (ShouldXRayInstrumentFunction())
744 Fn->addFnAttr("xray-log-args",
745 llvm::utostr(LogArgs->getArgumentCount()));
Dean Michael Berris418da3f2017-03-06 07:08:21 +0000746 }
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000747 } else {
Dean Michael Berris05cf4432018-09-14 01:59:12 +0000748 if (ShouldXRayInstrumentFunction() && !CGM.imbueXRayAttrs(Fn, Loc))
Dean Michael Berris835832d2017-03-30 00:29:36 +0000749 Fn->addFnAttr(
750 "xray-instruction-threshold",
751 llvm::itostr(CGM.getCodeGenOpts().XRayInstructionThreshold));
Aaron Ballman7d2aecb2016-07-13 22:32:15 +0000752 }
753 }
754
Nirav Daved2f44d82016-04-05 17:50:43 +0000755 // Add no-jump-tables value.
756 Fn->addFnAttr("no-jump-tables",
757 llvm::toStringRef(CGM.getCodeGenOpts().NoUseJumpTables));
758
Dehao Chen5e97f232017-08-24 21:37:33 +0000759 // Add profile-sample-accurate value.
760 if (CGM.getCodeGenOpts().ProfileSampleAccurate)
761 Fn->addFnAttr("profile-sample-accurate");
762
Richard Smith9c6890a2012-11-01 22:30:59 +0000763 if (getLangOpts().OpenCL) {
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000764 // Add metadata for a kernel function.
765 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000766 EmitOpenCLKernelMetadata(FD, Fn);
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000767 }
768
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000769 // If we are checking function types, emit a function type signature as
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000770 // prologue data.
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000771 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000772 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
Vedant Kumaraa4ea5f2017-10-14 01:23:30 +0000773 if (llvm::Constant *PrologueSig = getPrologueSignature(CGM, FD)) {
Stephan Bergmann8c85bca2018-01-05 07:57:12 +0000774 // Remove any (C++17) exception specifications, to allow calling e.g. a
775 // noexcept function through a non-noexcept pointer.
776 auto ProtoTy =
777 getContext().getFunctionTypeWithExceptionSpec(FD->getType(),
778 EST_None);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000779 llvm::Constant *FTRTTIConst =
Stephan Bergmann8c85bca2018-01-05 07:57:12 +0000780 CGM.GetAddrOfRTTIDescriptor(ProtoTy, /*ForEH=*/true);
Vedant Kumarbb5d4852017-09-13 00:04:35 +0000781 llvm::Constant *FTRTTIConstEncoded =
782 EncodeAddrForUseInPrologue(Fn, FTRTTIConst);
783 llvm::Constant *PrologueStructElems[] = {PrologueSig,
784 FTRTTIConstEncoded};
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000785 llvm::Constant *PrologueStructConst =
786 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
787 Fn->setPrologueData(PrologueStructConst);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000788 }
789 }
790 }
791
Vedant Kumar42c17ec2017-03-14 01:56:34 +0000792 // If we're checking nullability, we need to know whether we can check the
793 // return value. Initialize the flag to 'true' and refine it in EmitParmDecl.
794 if (SanOpts.has(SanitizerKind::NullabilityReturn)) {
795 auto Nullability = FnRetTy->getNullability(getContext());
796 if (Nullability && *Nullability == NullabilityKind::NonNull) {
797 if (!(SanOpts.has(SanitizerKind::ReturnsNonnullAttribute) &&
798 CurCodeDecl && CurCodeDecl->getAttr<ReturnsNonNullAttr>()))
799 RetValNullabilityPrecondition =
800 llvm::ConstantInt::getTrue(getLLVMContext());
801 }
802 }
803
James Molloyc16a60b62015-11-12 15:36:04 +0000804 // If we're in C++ mode and the function name is "main", it is guaranteed
805 // to be norecurse by the standard (3.6.1.3 "The function main shall not be
806 // used within a program").
807 if (getLangOpts().CPlusPlus)
808 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
809 if (FD->isMain())
810 Fn->addFnAttr(llvm::Attribute::NoRecurse);
Honggyu Kim2bbdeac2016-09-01 06:14:45 +0000811
Martin Storsjod39d53b2018-08-21 20:41:17 +0000812 // If a custom alignment is used, force realigning to this alignment on
813 // any main function which certainly will need it.
814 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
815 if ((FD->isMain() || FD->isMSVCRTEntryPoint()) &&
816 CGM.getCodeGenOpts().StackAlignment)
817 Fn->addFnAttr("stackrealign");
818
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000819 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000820
Chris Lattner5696e7b2008-06-17 18:05:57 +0000821 // Create a marker to make it easy to insert allocas into the entryblock
822 // later. Don't create this with the builder, because we don't want it
823 // folded.
Chris Lattner5e016ae2010-06-27 07:15:29 +0000824 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
Mehdi Amini557c20a2016-03-13 21:05:23 +0000825 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "allocapt", EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000826
John McCallbd309292010-07-06 01:34:17 +0000827 ReturnBlock = getJumpDestInCurrentScope("return");
Mike Stump11289f42009-09-09 15:08:12 +0000828
Chris Lattner5696e7b2008-06-17 18:05:57 +0000829 Builder.SetInsertPoint(EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000830
Vedant Kumarc34d3432017-06-23 21:32:38 +0000831 // If we're checking the return value, allocate space for a pointer to a
832 // precise source location of the checked return statement.
833 if (requiresReturnValueCheck()) {
834 ReturnLocation = CreateDefaultAlignTempAlloca(Int8PtrTy, "return.sloc.ptr");
835 InitTempAlloca(ReturnLocation, llvm::ConstantPointerNull::get(Int8PtrTy));
836 }
837
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000838 // Emit subprogram debug descriptor.
Anders Carlsson63784f42009-02-13 08:11:52 +0000839 if (CGDebugInfo *DI = getDebugInfo()) {
Reid Klecknerf00f8032016-06-08 20:41:54 +0000840 // Reconstruct the type from the argument list so that implicit parameters,
841 // such as 'this' and 'vtt', show up in the debug info. Preserve the calling
842 // convention.
843 CallingConv CC = CallingConv::CC_C;
844 if (auto *FD = dyn_cast_or_null<FunctionDecl>(D))
845 if (const auto *SrcFnTy = FD->getType()->getAs<FunctionType>())
846 CC = SrcFnTy->getCallConv();
Jordan Rose5c382722013-03-08 21:51:21 +0000847 SmallVector<QualType, 16> ArgTypes;
Reid Klecknerf00f8032016-06-08 20:41:54 +0000848 for (const VarDecl *VD : Args)
849 ArgTypes.push_back(VD->getType());
850 QualType FnType = getContext().getFunctionType(
851 RetTy, ArgTypes, FunctionProtoType::ExtProtoInfo(CC));
Brock Wyma94ece8f2018-04-16 16:53:57 +0000852 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, CurFuncIsThunk,
853 Builder);
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000854 }
855
Hans Wennborg76c26c12017-11-14 21:13:27 +0000856 if (ShouldInstrumentFunction()) {
Hans Wennborg14e8a5a2017-11-21 17:30:34 +0000857 if (CGM.getCodeGenOpts().InstrumentFunctions)
858 CurFn->addFnAttr("instrument-function-entry", "__cyg_profile_func_enter");
859 if (CGM.getCodeGenOpts().InstrumentFunctionsAfterInlining)
860 CurFn->addFnAttr("instrument-function-entry-inlined",
861 "__cyg_profile_func_enter");
862 if (CGM.getCodeGenOpts().InstrumentFunctionEntryBare)
863 CurFn->addFnAttr("instrument-function-entry-inlined",
864 "__cyg_profile_func_enter_bare");
Hans Wennborg76c26c12017-11-14 21:13:27 +0000865 }
Chris Lattner3c77a352010-06-22 00:03:40 +0000866
Honggyu Kim2b0e4242016-09-01 11:29:21 +0000867 // Since emitting the mcount call here impacts optimizations such as function
868 // inlining, we just add an attribute to insert a mcount call in backend.
869 // The attribute "counting-function" is set to mcount function name which is
870 // architecture dependent.
Nirav Dave0c86ccf2017-01-31 17:00:35 +0000871 if (CGM.getCodeGenOpts().InstrumentForProfiling) {
Manoj Gupta886b4502018-03-02 23:52:44 +0000872 // Calls to fentry/mcount should not be generated if function has
873 // the no_instrument_function attribute.
874 if (!CurFuncDecl || !CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>()) {
875 if (CGM.getCodeGenOpts().CallFEntry)
876 Fn->addFnAttr("fentry-call", "true");
877 else {
Hans Wennborg76c26c12017-11-14 21:13:27 +0000878 Fn->addFnAttr("instrument-function-entry-inlined",
879 getTarget().getMCountName());
880 }
Manoj Gupta162b40a2017-06-19 18:45:03 +0000881 }
Nirav Dave0c86ccf2017-01-31 17:00:35 +0000882 }
Roman Divacky178e01602011-02-10 16:52:03 +0000883
Eli Friedman4b1942c2009-12-04 02:43:40 +0000884 if (RetTy->isVoidType()) {
885 // Void type; nothing to return.
John McCall7f416cc2015-09-08 08:05:57 +0000886 ReturnValue = Address::invalid();
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000887
888 // Count the implicit return.
889 if (!endsWithReturn(D))
890 ++NumReturnExprs;
Hans Wennborg86aba5e2018-12-07 08:17:26 +0000891 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect) {
892 // Indirect return; emit returned value directly into sret slot.
Daniel Dunbarfd09df72010-02-16 19:45:20 +0000893 // This reduces code size, and affects correctness in C++.
Reid Kleckner37abaca2014-05-09 22:46:15 +0000894 auto AI = CurFn->arg_begin();
895 if (CurFnInfo->getReturnInfo().isSRetAfterThis())
896 ++AI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +0000897 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign());
Amy Huang7fac5c82019-06-20 17:15:21 +0000898 if (!CurFnInfo->getReturnInfo().getIndirectByVal()) {
899 ReturnValuePointer =
900 CreateDefaultAlignTempAlloca(Int8PtrTy, "result.ptr");
901 Builder.CreateStore(Builder.CreatePointerBitCastOrAddrSpaceCast(
902 ReturnValue.getPointer(), Int8PtrTy),
903 ReturnValuePointer);
904 }
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000905 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
906 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
907 // Load the sret pointer from the argument struct and return into that.
908 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
909 llvm::Function::arg_iterator EI = CurFn->arg_end();
910 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +0000911 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx);
Amy Huang7fac5c82019-06-20 17:15:21 +0000912 ReturnValuePointer = Address(Addr, getPointerAlign());
John McCall7f416cc2015-09-08 08:05:57 +0000913 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result");
914 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy));
Eli Friedman4b1942c2009-12-04 02:43:40 +0000915 } else {
Daniel Dunbarfd09df72010-02-16 19:45:20 +0000916 ReturnValue = CreateIRTemp(RetTy, "retval");
John McCall31168b02011-06-15 23:02:42 +0000917
918 // Tell the epilog emitter to autorelease the result. We do this
919 // now so that various specialized functions can suppress it
920 // during their IR-generation.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000921 if (getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000922 !CurFnInfo->isReturnsRetained() &&
923 RetTy->isObjCRetainableType())
924 AutoreleaseResult = true;
Eli Friedman4b1942c2009-12-04 02:43:40 +0000925 }
926
Mike Stump1d849212009-12-07 23:38:24 +0000927 EmitStartEHSpec(CurCodeDecl);
John McCall31168b02011-06-15 23:02:42 +0000928
929 PrologueCleanupDepth = EHStack.stable_begin();
Gheorghe-Teodor Bercead3dcf2f2018-03-14 14:17:45 +0000930
931 // Emit OpenMP specific initialization of the device functions.
932 if (getLangOpts().OpenMP && CurCodeDecl)
933 CGM.getOpenMPRuntime().emitFunctionProlog(*this, CurCodeDecl);
934
Daniel Dunbard931a872009-02-02 22:03:45 +0000935 EmitFunctionProlog(*CurFnInfo, CurFn, Args);
Mike Stump11289f42009-09-09 15:08:12 +0000936
Eli Friedman9fbeba02012-02-11 02:57:39 +0000937 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
John McCall5d865c322010-08-31 07:33:07 +0000938 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
Eli Friedman9fbeba02012-02-11 02:57:39 +0000939 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
940 if (MD->getParent()->isLambda() &&
941 MD->getOverloadedOperator() == OO_Call) {
942 // We're in a lambda; figure out the captures.
943 MD->getParent()->getCaptureFields(LambdaCaptureFields,
944 LambdaThisCaptureField);
945 if (LambdaThisCaptureField) {
Faisal Validc6b5962016-03-21 09:25:37 +0000946 // If the lambda captures the object referred to by '*this' - either by
947 // value or by reference, make sure CXXThisValue points to the correct
948 // object.
949
950 // Get the lvalue for the field (which is a copy of the enclosing object
951 // or contains the address of the enclosing object).
952 LValue ThisFieldLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
953 if (!LambdaThisCaptureField->getType()->isPointerType()) {
954 // If the enclosing object was captured by value, just use its address.
955 CXXThisValue = ThisFieldLValue.getAddress().getPointer();
956 } else {
957 // Load the lvalue pointed to by the field, since '*this' was captured
958 // by reference.
959 CXXThisValue =
960 EmitLoadOfLValue(ThisFieldLValue, SourceLocation()).getScalarVal();
961 }
Eli Friedman9fbeba02012-02-11 02:57:39 +0000962 }
Alexey Bataev39c81e22014-08-28 04:28:19 +0000963 for (auto *FD : MD->getParent()->fields()) {
964 if (FD->hasCapturedVLAType()) {
965 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
966 SourceLocation()).getScalarVal();
967 auto VAT = FD->getCapturedVLAType();
968 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
969 }
970 }
Eli Friedman9fbeba02012-02-11 02:57:39 +0000971 } else {
972 // Not in a lambda; just use 'this' from the method.
973 // FIXME: Should we generate a new load for each use of 'this'? The
974 // fast register allocator would be happier...
975 CXXThisValue = CXXABIThisValue;
976 }
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000977
Vedant Kumarffd7c882017-04-14 22:03:34 +0000978 // Check the 'this' pointer once per function, if it's available.
Richard Smith376c28e2017-08-24 20:10:33 +0000979 if (CXXABIThisValue) {
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000980 SanitizerSet SkippedChecks;
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000981 SkippedChecks.set(SanitizerKind::ObjectSize, true);
Brian Gesiak5488ab42019-01-11 01:54:53 +0000982 QualType ThisTy = MD->getThisType();
Richard Smith376c28e2017-08-24 20:10:33 +0000983
984 // If this is the call operator of a lambda with no capture-default, it
985 // may have a static invoker function, which may call this operator with
986 // a null 'this' pointer.
987 if (isLambdaCallOperator(MD) &&
George Burgess IV00f70bd2018-03-01 05:43:23 +0000988 MD->getParent()->getLambdaCaptureDefault() == LCD_None)
Richard Smith376c28e2017-08-24 20:10:33 +0000989 SkippedChecks.set(SanitizerKind::Null, true);
990
991 EmitTypeCheck(isa<CXXConstructorDecl>(MD) ? TCK_ConstructorCall
992 : TCK_MemberCall,
993 Loc, CXXABIThisValue, ThisTy,
Vedant Kumarffd7c882017-04-14 22:03:34 +0000994 getContext().getTypeAlignInChars(ThisTy->getPointeeType()),
995 SkippedChecks);
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000996 }
Eli Friedman9fbeba02012-02-11 02:57:39 +0000997 }
John McCall347132b2010-02-16 22:04:33 +0000998
Anders Carlssonc20879a2008-12-20 21:28:43 +0000999 // If any of the arguments have a variably modified type, make sure to
1000 // emit the type size.
1001 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
1002 i != e; ++i) {
Eli Friedman1f576832012-11-14 22:09:59 +00001003 const VarDecl *VD = *i;
1004
1005 // Dig out the type as written from ParmVarDecls; it's unclear whether
1006 // the standard (C99 6.9.1p10) requires this, but we're following the
1007 // precedent set by gcc.
1008 QualType Ty;
1009 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
1010 Ty = PVD->getOriginalType();
1011 else
1012 Ty = VD->getType();
Anders Carlssonc20879a2008-12-20 21:28:43 +00001013
1014 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +00001015 EmitVariablyModifiedType(Ty);
Anders Carlssonc20879a2008-12-20 21:28:43 +00001016 }
Eric Christopher7cdf9482011-10-13 21:45:18 +00001017 // Emit a location at the end of the prologue.
1018 if (CGDebugInfo *DI = getDebugInfo())
Calixte Denizetfcd661d2018-09-24 18:24:18 +00001019 DI->EmitLocation(Builder, StartLoc);
Craig Topper74c10e32018-07-09 19:00:16 +00001020
1021 // TODO: Do we need to handle this in two places like we do with
1022 // target-features/target-cpu?
1023 if (CurFuncDecl)
1024 if (const auto *VecWidth = CurFuncDecl->getAttr<MinVectorWidthAttr>())
1025 LargestVectorWidth = VecWidth->getVectorWidth();
Daniel Dunbarbc915f42008-09-09 23:14:03 +00001026}
Eli Friedman3d421e12008-08-25 21:31:01 +00001027
Reid Kleckner43071082018-12-13 01:33:20 +00001028void CodeGenFunction::EmitFunctionBody(const Stmt *Body) {
Justin Bogner66242d62015-04-23 23:06:47 +00001029 incrementProfileCounter(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001030 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
David Blaikie0a21d0d2013-01-26 22:16:26 +00001031 EmitCompoundStmtWithoutScope(*S);
1032 else
Richard Smithb47c36f2013-11-05 09:12:18 +00001033 EmitStmt(Body);
John McCall89b12b32010-02-18 03:17:58 +00001034}
1035
Bob Wilsonbf854f02014-02-17 19:21:09 +00001036/// When instrumenting to collect profile data, the counts for some blocks
1037/// such as switch cases need to not include the fall-through counts, so
1038/// emit a branch around the instrumentation code. When not instrumenting,
1039/// this just calls EmitBlock().
1040void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
Justin Bogner66242d62015-04-23 23:06:47 +00001041 const Stmt *S) {
Craig Topper8a13c412014-05-21 05:09:00 +00001042 llvm::BasicBlock *SkipCountBB = nullptr;
Rong Xu9837ef52016-02-04 18:39:09 +00001043 if (HaveInsertPoint() && CGM.getCodeGenOpts().hasProfileClangInstr()) {
Bob Wilsonbf854f02014-02-17 19:21:09 +00001044 // When instrumenting for profiling, the fallthrough to certain
1045 // statements needs to skip over the instrumentation code so that we
1046 // get an accurate count.
1047 SkipCountBB = createBasicBlock("skipcount");
1048 EmitBranch(SkipCountBB);
1049 }
1050 EmitBlock(BB);
Justin Bogner66242d62015-04-23 23:06:47 +00001051 uint64_t CurrentCount = getCurrentProfileCount();
1052 incrementProfileCounter(S);
1053 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
Bob Wilsonbf854f02014-02-17 19:21:09 +00001054 if (SkipCountBB)
1055 EmitBlock(SkipCountBB);
1056}
1057
John McCall8601a752010-08-03 22:46:07 +00001058/// Tries to mark the given function nounwind based on the
1059/// non-existence of any throwing calls within it. We believe this is
1060/// lightweight enough to do at -O0.
1061static void TryMarkNoThrow(llvm::Function *F) {
John McCall59966992010-08-11 22:38:33 +00001062 // LLVM treats 'nounwind' on a function as part of the type, so we
1063 // can't do this on functions that can be overwritten.
Sanjoy Dasf60a0d72016-04-08 01:31:02 +00001064 if (F->isInterposable()) return;
John McCall59966992010-08-11 22:38:33 +00001065
David Majnemerdbf10452015-07-31 17:58:45 +00001066 for (llvm::BasicBlock &BB : *F)
1067 for (llvm::Instruction &I : BB)
1068 if (I.mayThrow())
Bill Wendlingf0724e82011-09-19 20:31:14 +00001069 return;
David Majnemerdbf10452015-07-31 17:58:45 +00001070
Bill Wendling73e465e2012-10-10 03:13:20 +00001071 F->setDoesNotThrow();
John McCall8601a752010-08-03 22:46:07 +00001072}
1073
Richard Smith5179eb72016-06-28 19:03:57 +00001074QualType CodeGenFunction::BuildFunctionArgList(GlobalDecl GD,
1075 FunctionArgList &Args) {
Anders Carlsson73fcc952009-09-11 00:07:24 +00001076 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Alp Toker314cc812014-01-25 16:55:45 +00001077 QualType ResTy = FD->getReturnType();
Mike Stump11289f42009-09-09 15:08:12 +00001078
Reid Kleckner89077a12013-12-17 19:46:40 +00001079 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
1080 if (MD && MD->isInstance()) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001081 if (CGM.getCXXABI().HasThisReturn(GD))
Brian Gesiak5488ab42019-01-11 01:54:53 +00001082 ResTy = MD->getThisType();
David Majnemer0c0b6d92014-10-31 20:09:12 +00001083 else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
1084 ResTy = CGM.getContext().VoidPtrTy;
Reid Kleckner89077a12013-12-17 19:46:40 +00001085 CGM.getCXXABI().buildThisParam(*this, Args);
Stephen Lin9dc6eef2013-06-30 20:40:16 +00001086 }
Justin Bogner66242d62015-04-23 23:06:47 +00001087
Richard Smith5179eb72016-06-28 19:03:57 +00001088 // The base version of an inheriting constructor whose constructed base is a
1089 // virtual base is not passed any arguments (because it doesn't actually call
1090 // the inherited constructor).
1091 bool PassedParams = true;
1092 if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(FD))
1093 if (auto Inherited = CD->getInheritedConstructor())
1094 PassedParams =
1095 getTypes().inheritingCtorHasParams(Inherited, GD.getCtorType());
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001096
Richard Smith5179eb72016-06-28 19:03:57 +00001097 if (PassedParams) {
1098 for (auto *Param : FD->parameters()) {
1099 Args.push_back(Param);
1100 if (!Param->hasAttr<PassObjectSizeAttr>())
1101 continue;
1102
Richard Smith5179eb72016-06-28 19:03:57 +00001103 auto *Implicit = ImplicitParamDecl::Create(
Alexey Bataev56223232017-06-09 13:40:18 +00001104 getContext(), Param->getDeclContext(), Param->getLocation(),
1105 /*Id=*/nullptr, getContext().getSizeType(), ImplicitParamDecl::Other);
Richard Smith5179eb72016-06-28 19:03:57 +00001106 SizeArguments[Param] = Implicit;
1107 Args.push_back(Implicit);
1108 }
George Burgess IV3e3bb95b2015-12-02 21:58:08 +00001109 }
Daniel Dunbar89654ee2008-08-26 08:29:31 +00001110
Reid Kleckner89077a12013-12-17 19:46:40 +00001111 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
1112 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
1113
Richard Smith5179eb72016-06-28 19:03:57 +00001114 return ResTy;
1115}
1116
Alex Lorenzc1608f72017-01-04 13:40:34 +00001117static bool
1118shouldUseUndefinedBehaviorReturnOptimization(const FunctionDecl *FD,
1119 const ASTContext &Context) {
1120 QualType T = FD->getReturnType();
1121 // Avoid the optimization for functions that return a record type with a
1122 // trivial destructor or another trivially copyable type.
1123 if (const RecordType *RT = T.getCanonicalType()->getAs<RecordType>()) {
1124 if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RT->getDecl()))
1125 return !ClassDecl->hasTrivialDestructor();
1126 }
1127 return !T.isTriviallyCopyableType(Context);
1128}
1129
Richard Smith5179eb72016-06-28 19:03:57 +00001130void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
1131 const CGFunctionInfo &FnInfo) {
1132 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
1133 CurGD = GD;
1134
1135 FunctionArgList Args;
1136 QualType ResTy = BuildFunctionArgList(GD, Args);
1137
1138 // Check if we should generate debug info for this function.
1139 if (FD->hasAttr<NoDebugAttr>())
1140 DebugInfo = nullptr; // disable debug info indefinitely for this function
1141
Reid Klecknera8589812017-02-08 16:09:32 +00001142 // The function might not have a body if we're generating thunks for a
1143 // function declaration.
John McCall89b12b32010-02-18 03:17:58 +00001144 SourceRange BodyRange;
Reid Klecknera8589812017-02-08 16:09:32 +00001145 if (Stmt *Body = FD->getBody())
1146 BodyRange = Body->getSourceRange();
1147 else
1148 BodyRange = FD->getLocation();
Adrian Prantldc237b52013-05-16 00:41:26 +00001149 CurEHLocation = BodyRange.getEnd();
Anders Carlsson438cf922009-11-06 02:55:43 +00001150
Adrian Prantl42d71b92014-04-10 23:21:53 +00001151 // Use the location of the start of the function to determine where
1152 // the function definition is located. By default use the location
1153 // of the declaration as the location for the subprogram. A function
1154 // may lack a declaration in the source code if it is created by code
1155 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001156 SourceLocation Loc = FD->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001157
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +00001158 // If this is a function specialization then use the pattern body
1159 // as the location for the function.
1160 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
1161 if (SpecDecl->hasBody(SpecDecl))
1162 Loc = SpecDecl->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +00001163
Vitaly Buka64c80b42016-10-26 05:42:30 +00001164 Stmt *Body = FD->getBody();
1165
1166 // Initialize helper which will detect jumps which can cause invalid lifetime
1167 // markers.
1168 if (Body && ShouldEmitLifetimeMarkers)
1169 Bypasses.Init(Body);
1170
John McCall89b12b32010-02-18 03:17:58 +00001171 // Emit the standard function prologue.
Adrian Prantl42d71b92014-04-10 23:21:53 +00001172 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
Anders Carlsson438cf922009-11-06 02:55:43 +00001173
John McCall89b12b32010-02-18 03:17:58 +00001174 // Generate the body of the function.
Serge Pavlov3a561452015-12-06 14:32:39 +00001175 PGO.assignRegionCounters(GD, CurFn);
John McCallb81884d2010-02-19 09:25:03 +00001176 if (isa<CXXDestructorDecl>(FD))
1177 EmitDestructorBody(Args);
1178 else if (isa<CXXConstructorDecl>(FD))
1179 EmitConstructorBody(Args);
Richard Smith9c6890a2012-11-01 22:30:59 +00001180 else if (getLangOpts().CUDA &&
Artem Belevichf3d3db62015-03-19 18:58:18 +00001181 !getLangOpts().CUDAIsDevice &&
Peter Collingbournefa4d6032011-10-06 18:51:56 +00001182 FD->hasAttr<CUDAGlobalAttr>())
Artem Belevich52cc4872015-05-07 19:34:16 +00001183 CGM.getCUDARuntime().emitDeviceStub(*this, Args);
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001184 else if (isa<CXXMethodDecl>(FD) &&
1185 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
Faisal Vali2b391ab2013-09-26 19:54:12 +00001186 // The lambda static invoker function is special, because it forwards or
Douglas Gregor355efbb2012-02-17 03:02:34 +00001187 // clones the body of the function call operator (but is actually static).
Reid Kleckner2d3c4212017-08-04 22:38:06 +00001188 EmitLambdaStaticInvokeBody(cast<CXXMethodDecl>(FD));
Lang Hamesbf122742013-02-17 07:22:09 +00001189 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
Nick Lewyckyb39be1f2013-09-10 05:14:39 +00001190 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
1191 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
Lang Hamesbf122742013-02-17 07:22:09 +00001192 // Implicit copy-assignment gets the same special treatment as implicit
1193 // copy-constructors.
1194 emitImplicitAssignmentOperatorBody(Args);
Vitaly Buka64c80b42016-10-26 05:42:30 +00001195 } else if (Body) {
Reid Kleckner43071082018-12-13 01:33:20 +00001196 EmitFunctionBody(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +00001197 } else
1198 llvm_unreachable("no definition for emitted function");
Anders Carlssonff8cce42010-02-07 19:45:40 +00001199
Richard Smith9f9e5822012-10-04 23:52:29 +00001200 // C++11 [stmt.return]p2:
1201 // Flowing off the end of a function [...] results in undefined behavior in
1202 // a value-returning function.
1203 // C11 6.9.1p12:
1204 // If the '}' that terminates a function is reached, and the value of the
1205 // function call is used by the caller, the behavior is undefined.
Reid Kleckner9b3e3df2014-09-04 20:04:38 +00001206 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
Alp Toker314cc812014-01-25 16:55:45 +00001207 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
Alex Lorenzc1608f72017-01-04 13:40:34 +00001208 bool ShouldEmitUnreachable =
1209 CGM.getCodeGenOpts().StrictReturn ||
1210 shouldUseUndefinedBehaviorReturnOptimization(FD, getContext());
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001211 if (SanOpts.has(SanitizerKind::Return)) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001212 SanitizerScope SanScope(this);
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001213 llvm::Value *IsFalse = Builder.getFalse();
1214 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00001215 SanitizerHandler::MissingReturn,
1216 EmitCheckSourceLocation(FD->getLocation()), None);
Alex Lorenzc1608f72017-01-04 13:40:34 +00001217 } else if (ShouldEmitUnreachable) {
1218 if (CGM.getCodeGenOpts().OptimizationLevel == 0)
1219 EmitTrapCall(llvm::Intrinsic::trap);
Akira Hatanaka85365cd2015-07-02 22:15:41 +00001220 }
Alex Lorenzc1608f72017-01-04 13:40:34 +00001221 if (SanOpts.has(SanitizerKind::Return) || ShouldEmitUnreachable) {
1222 Builder.CreateUnreachable();
1223 Builder.ClearInsertionPoint();
1224 }
Richard Smith9f9e5822012-10-04 23:52:29 +00001225 }
1226
John McCall89b12b32010-02-18 03:17:58 +00001227 // Emit the standard function epilogue.
1228 FinishFunction(BodyRange.getEnd());
John McCall8601a752010-08-03 22:46:07 +00001229
1230 // If we haven't marked the function nothrow through other means, do
1231 // a quick pass now to see if we can.
1232 if (!CurFn->doesNotThrow())
1233 TryMarkNoThrow(CurFn);
Chris Lattner5696e7b2008-06-17 18:05:57 +00001234}
1235
Chris Lattner5b1964b2008-11-11 07:41:27 +00001236/// ContainsLabel - Return true if the statement contains a label in it. If
1237/// this statement is not executed normally, it not containing a label means
1238/// that we can just remove the code.
1239bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
1240 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001241 if (!S) return false;
Mike Stump11289f42009-09-09 15:08:12 +00001242
Chris Lattner5b1964b2008-11-11 07:41:27 +00001243 // If this is a label, we have to emit the code, consider something like:
1244 // if (0) { ... foo: bar(); } goto foo;
Chris Lattner29911cc2011-02-28 00:18:40 +00001245 //
1246 // TODO: If anyone cared, we could track __label__'s, since we know that you
1247 // can't jump to one from outside their declared region.
Chris Lattner5b1964b2008-11-11 07:41:27 +00001248 if (isa<LabelStmt>(S))
1249 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001250
Chris Lattner5b1964b2008-11-11 07:41:27 +00001251 // If this is a case/default statement, and we haven't seen a switch, we have
1252 // to emit the code.
1253 if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
1254 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001255
Chris Lattner5b1964b2008-11-11 07:41:27 +00001256 // If this is a switch statement, we want to ignore cases below it.
1257 if (isa<SwitchStmt>(S))
1258 IgnoreCaseStmts = true;
Mike Stump11289f42009-09-09 15:08:12 +00001259
Chris Lattner5b1964b2008-11-11 07:41:27 +00001260 // Scan subexpressions for verboten labels.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001261 for (const Stmt *SubStmt : S->children())
1262 if (ContainsLabel(SubStmt, IgnoreCaseStmts))
Chris Lattner5b1964b2008-11-11 07:41:27 +00001263 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001264
Chris Lattner5b1964b2008-11-11 07:41:27 +00001265 return false;
1266}
1267
Chris Lattner29911cc2011-02-28 00:18:40 +00001268/// containsBreak - Return true if the statement contains a break out of it.
1269/// If the statement (recursively) contains a switch or loop with a break
1270/// inside of it, this is fine.
1271bool CodeGenFunction::containsBreak(const Stmt *S) {
1272 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001273 if (!S) return false;
Chris Lattner29911cc2011-02-28 00:18:40 +00001274
1275 // If this is a switch or loop that defines its own break scope, then we can
1276 // include it and anything inside of it.
1277 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
1278 isa<ForStmt>(S))
Chris Lattner30db8282011-02-28 00:42:31 +00001279 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001280
Chris Lattner30db8282011-02-28 00:42:31 +00001281 if (isa<BreakStmt>(S))
Chris Lattner29911cc2011-02-28 00:18:40 +00001282 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001283
Chris Lattner29911cc2011-02-28 00:18:40 +00001284 // Scan subexpressions for verboten breaks.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001285 for (const Stmt *SubStmt : S->children())
1286 if (containsBreak(SubStmt))
Chris Lattner29911cc2011-02-28 00:18:40 +00001287 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001288
Chris Lattner29911cc2011-02-28 00:18:40 +00001289 return false;
1290}
1291
Richard Smithd8e3ac32016-09-16 23:30:39 +00001292bool CodeGenFunction::mightAddDeclToScope(const Stmt *S) {
1293 if (!S) return false;
1294
1295 // Some statement kinds add a scope and thus never add a decl to the current
1296 // scope. Note, this list is longer than the list of statements that might
1297 // have an unscoped decl nested within them, but this way is conservatively
1298 // correct even if more statement kinds are added.
1299 if (isa<IfStmt>(S) || isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
1300 isa<DoStmt>(S) || isa<ForStmt>(S) || isa<CompoundStmt>(S) ||
1301 isa<CXXForRangeStmt>(S) || isa<CXXTryStmt>(S) ||
1302 isa<ObjCForCollectionStmt>(S) || isa<ObjCAtTryStmt>(S))
1303 return false;
1304
1305 if (isa<DeclStmt>(S))
1306 return true;
1307
1308 for (const Stmt *SubStmt : S->children())
1309 if (mightAddDeclToScope(SubStmt))
1310 return true;
1311
1312 return false;
1313}
Chris Lattnercd439292008-11-12 08:04:58 +00001314
Chris Lattner41c6ab52011-02-27 23:02:32 +00001315/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1316/// to a constant, or if it does but contains a label, return false. If it
1317/// constant folds return true and set the boolean result in Result.
1318bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
Richard Smithb130fe72016-06-23 19:16:49 +00001319 bool &ResultBool,
1320 bool AllowLabels) {
Richard Trieuc320c742012-07-23 20:21:35 +00001321 llvm::APSInt ResultInt;
Richard Smithb130fe72016-06-23 19:16:49 +00001322 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt, AllowLabels))
Chris Lattner29911cc2011-02-28 00:18:40 +00001323 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001324
Chris Lattner29911cc2011-02-28 00:18:40 +00001325 ResultBool = ResultInt.getBoolValue();
1326 return true;
1327}
1328
1329/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1330/// to a constant, or if it does but contains a label, return false. If it
1331/// constant folds return true and set the folded value.
Richard Smithb130fe72016-06-23 19:16:49 +00001332bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1333 llvm::APSInt &ResultInt,
1334 bool AllowLabels) {
Daniel Dunbarf32443c2008-11-12 22:37:10 +00001335 // FIXME: Rename and handle conversion of other evaluatable things
1336 // to bool.
Fangrui Song407659a2018-11-30 23:41:18 +00001337 Expr::EvalResult Result;
1338 if (!Cond->EvaluateAsInt(Result, getContext()))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001339 return false; // Not foldable, not integer or not fully evaluatable.
Richard Smith5fab0c92011-12-28 19:48:30 +00001340
Fangrui Song407659a2018-11-30 23:41:18 +00001341 llvm::APSInt Int = Result.Val.getInt();
Richard Smithb130fe72016-06-23 19:16:49 +00001342 if (!AllowLabels && CodeGenFunction::ContainsLabel(Cond))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001343 return false; // Contains a label.
Richard Smith5fab0c92011-12-28 19:48:30 +00001344
1345 ResultInt = Int;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001346 return true;
Chris Lattnercd439292008-11-12 08:04:58 +00001347}
1348
1349
Chris Lattner29911cc2011-02-28 00:18:40 +00001350
Chris Lattnercd439292008-11-12 08:04:58 +00001351/// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
1352/// statement) to the specified blocks. Based on the condition, this might try
1353/// to simplify the codegen of the conditional based on the branch.
1354///
1355void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
1356 llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00001357 llvm::BasicBlock *FalseBlock,
1358 uint64_t TrueCount) {
Peter Collingbourne91147592011-04-15 00:35:48 +00001359 Cond = Cond->IgnoreParens();
Mike Stump11289f42009-09-09 15:08:12 +00001360
Chris Lattnercd439292008-11-12 08:04:58 +00001361 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
Justin Bogneref512b92014-01-06 22:27:43 +00001362
Chris Lattnercd439292008-11-12 08:04:58 +00001363 // Handle X && Y in a condition.
John McCalle3027922010-08-25 11:45:40 +00001364 if (CondBOp->getOpcode() == BO_LAnd) {
Chris Lattnercd439292008-11-12 08:04:58 +00001365 // If we have "1 && X", simplify the code. "0 && X" would have constant
1366 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001367 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001368 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1369 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001370 // br(1 && X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001371 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001372 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1373 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001374 }
Mike Stump11289f42009-09-09 15:08:12 +00001375
Chris Lattnercd439292008-11-12 08:04:58 +00001376 // If we have "X && 1", simplify the code to use an uncond branch.
1377 // "X && 0" would have been constant folded to 0.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001378 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1379 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001380 // br(X && 1) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001381 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1382 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001383 }
Mike Stump11289f42009-09-09 15:08:12 +00001384
Chris Lattnercd439292008-11-12 08:04:58 +00001385 // Emit the LHS as a conditional. If the LHS conditional is false, we
1386 // want to jump to the FalseBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001387 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
Justin Bogneref512b92014-01-06 22:27:43 +00001388 // The counter tells us how often we evaluate RHS, and all of TrueCount
1389 // can be propagated to that branch.
Justin Bogner66242d62015-04-23 23:06:47 +00001390 uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
John McCallce1de612011-01-26 04:00:11 +00001391
1392 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001393 {
1394 ApplyDebugLocation DL(*this, Cond);
1395 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount);
1396 EmitBlock(LHSTrue);
1397 }
Mike Stump11289f42009-09-09 15:08:12 +00001398
Justin Bogner66242d62015-04-23 23:06:47 +00001399 incrementProfileCounter(CondBOp);
1400 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1401
Anders Carlsson60ddba62010-01-24 00:20:05 +00001402 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001403 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001404 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount);
John McCallce1de612011-01-26 04:00:11 +00001405 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001406
Chris Lattnercd439292008-11-12 08:04:58 +00001407 return;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001408 }
Michael Ilseman686240a2012-12-04 00:29:55 +00001409
Chris Lattner41c6ab52011-02-27 23:02:32 +00001410 if (CondBOp->getOpcode() == BO_LOr) {
Chris Lattnercd439292008-11-12 08:04:58 +00001411 // If we have "0 || X", simplify the code. "1 || X" would have constant
1412 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001413 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001414 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1415 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001416 // br(0 || X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001417 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001418 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1419 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001420 }
Mike Stump11289f42009-09-09 15:08:12 +00001421
Chris Lattnercd439292008-11-12 08:04:58 +00001422 // If we have "X || 0", simplify the code to use an uncond branch.
1423 // "X || 1" would have been constant folded to 1.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001424 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1425 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001426 // br(X || 0) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001427 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1428 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001429 }
Mike Stump11289f42009-09-09 15:08:12 +00001430
Chris Lattnercd439292008-11-12 08:04:58 +00001431 // Emit the LHS as a conditional. If the LHS conditional is true, we
1432 // want to jump to the TrueBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001433 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
Justin Bogneref512b92014-01-06 22:27:43 +00001434 // We have the count for entry to the RHS and for the whole expression
1435 // being true, so we can divy up True count between the short circuit and
1436 // the RHS.
Justin Bogner66242d62015-04-23 23:06:47 +00001437 uint64_t LHSCount =
1438 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
Justin Bogneref512b92014-01-06 22:27:43 +00001439 uint64_t RHSCount = TrueCount - LHSCount;
John McCallce1de612011-01-26 04:00:11 +00001440
1441 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001442 {
1443 ApplyDebugLocation DL(*this, Cond);
1444 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount);
1445 EmitBlock(LHSFalse);
1446 }
Mike Stump11289f42009-09-09 15:08:12 +00001447
Justin Bogner66242d62015-04-23 23:06:47 +00001448 incrementProfileCounter(CondBOp);
1449 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1450
Anders Carlsson60ddba62010-01-24 00:20:05 +00001451 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001452 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001453 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount);
1454
John McCallce1de612011-01-26 04:00:11 +00001455 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001456
Chris Lattnercd439292008-11-12 08:04:58 +00001457 return;
1458 }
Chris Lattnerd9537732008-11-12 08:13:36 +00001459 }
Mike Stump11289f42009-09-09 15:08:12 +00001460
Chris Lattnerd9537732008-11-12 08:13:36 +00001461 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
1462 // br(!x, t, f) -> br(x, f, t)
Justin Bogneref512b92014-01-06 22:27:43 +00001463 if (CondUOp->getOpcode() == UO_LNot) {
1464 // Negate the count.
Justin Bogner66242d62015-04-23 23:06:47 +00001465 uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
Justin Bogneref512b92014-01-06 22:27:43 +00001466 // Negate the condition and swap the destination blocks.
1467 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1468 FalseCount);
1469 }
Chris Lattnercd439292008-11-12 08:04:58 +00001470 }
Mike Stump11289f42009-09-09 15:08:12 +00001471
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001472 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
Eli Friedman248f8982012-02-14 03:54:45 +00001473 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
1474 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
1475 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001476
Eli Friedman248f8982012-02-14 03:54:45 +00001477 ConditionalEvaluation cond(*this);
Justin Bogner66242d62015-04-23 23:06:47 +00001478 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1479 getProfileCount(CondOp));
Justin Bogneref512b92014-01-06 22:27:43 +00001480
1481 // When computing PGO branch weights, we only know the overall count for
1482 // the true block. This code is essentially doing tail duplication of the
1483 // naive code-gen, introducing new edges for which counts are not
1484 // available. Divide the counts proportionally between the LHS and RHS of
1485 // the conditional operator.
1486 uint64_t LHSScaledTrueCount = 0;
1487 if (TrueCount) {
Justin Bogner66242d62015-04-23 23:06:47 +00001488 double LHSRatio =
1489 getProfileCount(CondOp) / (double)getCurrentProfileCount();
Justin Bogneref512b92014-01-06 22:27:43 +00001490 LHSScaledTrueCount = TrueCount * LHSRatio;
1491 }
John McCallce1de612011-01-26 04:00:11 +00001492
Eli Friedman248f8982012-02-14 03:54:45 +00001493 cond.begin(*this);
1494 EmitBlock(LHSBlock);
Justin Bogner66242d62015-04-23 23:06:47 +00001495 incrementProfileCounter(CondOp);
David Blaikie298720d2015-01-28 19:50:09 +00001496 {
1497 ApplyDebugLocation DL(*this, Cond);
1498 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1499 LHSScaledTrueCount);
1500 }
Eli Friedman248f8982012-02-14 03:54:45 +00001501 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001502
Eli Friedman248f8982012-02-14 03:54:45 +00001503 cond.begin(*this);
1504 EmitBlock(RHSBlock);
Justin Bogneref512b92014-01-06 22:27:43 +00001505 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1506 TrueCount - LHSScaledTrueCount);
Eli Friedman248f8982012-02-14 03:54:45 +00001507 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001508
Eli Friedman248f8982012-02-14 03:54:45 +00001509 return;
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001510 }
1511
Richard Smithea852322013-05-07 21:53:22 +00001512 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
1513 // Conditional operator handling can give us a throw expression as a
1514 // condition for a case like:
1515 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
1516 // Fold this to:
1517 // br(c, throw x, br(y, t, f))
1518 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
1519 return;
1520 }
1521
Sanjay Patela24296b2015-09-02 20:01:30 +00001522 // If the branch has a condition wrapped by __builtin_unpredictable,
1523 // create metadata that specifies that the branch is unpredictable.
1524 // Don't bother if not optimizing because that metadata would not be used.
1525 llvm::MDNode *Unpredictable = nullptr;
Erich Keane8c94f072018-12-12 20:30:53 +00001526 auto *Call = dyn_cast<CallExpr>(Cond->IgnoreImpCasts());
Sanjay Patel3fd323f2016-04-19 18:06:33 +00001527 if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1528 auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1529 if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1530 llvm::MDBuilder MDHelper(getLLVMContext());
1531 Unpredictable = MDHelper.createUnpredictable();
Sanjay Patela24296b2015-09-02 20:01:30 +00001532 }
1533 }
1534
Justin Bogneref512b92014-01-06 22:27:43 +00001535 // Create branch weights based on the number of times we get here and the
1536 // number of times the condition should be true.
Justin Bogner66242d62015-04-23 23:06:47 +00001537 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
Justin Bogner65512642015-05-02 05:00:55 +00001538 llvm::MDNode *Weights =
1539 createProfileWeights(TrueCount, CurrentCount - TrueCount);
Justin Bogneref512b92014-01-06 22:27:43 +00001540
Chris Lattnercd439292008-11-12 08:04:58 +00001541 // Emit the code with the fully general case.
David Blaikie303facb2015-01-31 01:10:11 +00001542 llvm::Value *CondV;
1543 {
1544 ApplyDebugLocation DL(*this, Cond);
1545 CondV = EvaluateExprAsBool(Cond);
1546 }
Sanjay Patela24296b2015-09-02 20:01:30 +00001547 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
Chris Lattnercd439292008-11-12 08:04:58 +00001548}
1549
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001550/// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001551/// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001552void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
1553 CGM.ErrorUnsupported(S, Type);
Chris Lattnerfc944342007-12-02 01:43:38 +00001554}
1555
John McCall2725aa12011-02-01 21:35:06 +00001556/// emitNonZeroVLAInit - Emit the "zero" initialization of a
1557/// variable-length array whose elements have a non-zero bit-pattern.
1558///
James Dennettbe302452012-06-15 22:10:14 +00001559/// \param baseType the inner-most element type of the array
John McCall2725aa12011-02-01 21:35:06 +00001560/// \param src - a char* pointing to the bit-pattern for a single
1561/// base element of the array
1562/// \param sizeInChars - the total size of the VLA, in chars
John McCall2725aa12011-02-01 21:35:06 +00001563static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001564 Address dest, Address src,
John McCall2725aa12011-02-01 21:35:06 +00001565 llvm::Value *sizeInChars) {
John McCall2725aa12011-02-01 21:35:06 +00001566 CGBuilderTy &Builder = CGF.Builder;
1567
John McCall7f416cc2015-09-08 08:05:57 +00001568 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
John McCall2725aa12011-02-01 21:35:06 +00001569 llvm::Value *baseSizeInChars
John McCall7f416cc2015-09-08 08:05:57 +00001570 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
John McCall2725aa12011-02-01 21:35:06 +00001571
John McCall7f416cc2015-09-08 08:05:57 +00001572 Address begin =
1573 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1574 llvm::Value *end =
1575 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end");
John McCall2725aa12011-02-01 21:35:06 +00001576
1577 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
1578 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
1579 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
1580
1581 // Make a loop over the VLA. C99 guarantees that the VLA element
1582 // count must be nonzero.
1583 CGF.EmitBlock(loopBB);
1584
John McCall7f416cc2015-09-08 08:05:57 +00001585 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
1586 cur->addIncoming(begin.getPointer(), originBB);
1587
1588 CharUnits curAlign =
1589 dest.getAlignment().alignmentOfArrayElement(baseSize);
John McCall2725aa12011-02-01 21:35:06 +00001590
1591 // memcpy the individual element bit-pattern.
John McCall7f416cc2015-09-08 08:05:57 +00001592 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
John McCall2725aa12011-02-01 21:35:06 +00001593 /*volatile*/ false);
1594
1595 // Go to the next element.
John McCall7f416cc2015-09-08 08:05:57 +00001596 llvm::Value *next =
1597 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
John McCall2725aa12011-02-01 21:35:06 +00001598
1599 // Leave if that's the end of the VLA.
1600 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
1601 Builder.CreateCondBr(done, contBB, loopBB);
1602 cur->addIncoming(next, loopBB);
1603
1604 CGF.EmitBlock(contBB);
Michael Ilseman686240a2012-12-04 00:29:55 +00001605}
John McCall2725aa12011-02-01 21:35:06 +00001606
Anders Carlssonc0964b62010-05-22 17:35:42 +00001607void
John McCall7f416cc2015-09-08 08:05:57 +00001608CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001609 // Ignore empty classes in C++.
Richard Smith9c6890a2012-11-01 22:30:59 +00001610 if (getLangOpts().CPlusPlus) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001611 if (const RecordType *RT = Ty->getAs<RecordType>()) {
1612 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
1613 return;
1614 }
1615 }
John McCall7cd1d972010-08-07 08:21:30 +00001616
1617 // Cast the dest ptr to the appropriate i8 pointer type.
John McCall7f416cc2015-09-08 08:05:57 +00001618 if (DestPtr.getElementType() != Int8Ty)
1619 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001620
1621 // Get size and alignment info for this aggregate.
John McCall7f416cc2015-09-08 08:05:57 +00001622 CharUnits size = getContext().getTypeSizeInChars(Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001623
John McCalla08ffd22011-01-14 10:37:58 +00001624 llvm::Value *SizeVal;
John McCall2725aa12011-02-01 21:35:06 +00001625 const VariableArrayType *vla;
Mike Stump11289f42009-09-09 15:08:12 +00001626
John McCalla08ffd22011-01-14 10:37:58 +00001627 // Don't bother emitting a zero-byte memset.
John McCall7f416cc2015-09-08 08:05:57 +00001628 if (size.isZero()) {
John McCalla08ffd22011-01-14 10:37:58 +00001629 // But note that getTypeInfo returns 0 for a VLA.
1630 if (const VariableArrayType *vlaType =
1631 dyn_cast_or_null<VariableArrayType>(
1632 getContext().getAsArrayType(Ty))) {
Sander de Smalen891af03a2018-02-03 13:55:59 +00001633 auto VlaSize = getVLASize(vlaType);
1634 SizeVal = VlaSize.NumElts;
1635 CharUnits eltSize = getContext().getTypeSizeInChars(VlaSize.Type);
John McCall23c29fe2011-06-24 21:55:10 +00001636 if (!eltSize.isOne())
1637 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
John McCall2725aa12011-02-01 21:35:06 +00001638 vla = vlaType;
John McCalla08ffd22011-01-14 10:37:58 +00001639 } else {
1640 return;
1641 }
1642 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001643 SizeVal = CGM.getSize(size);
Craig Topper8a13c412014-05-21 05:09:00 +00001644 vla = nullptr;
John McCalla08ffd22011-01-14 10:37:58 +00001645 }
John McCall7cd1d972010-08-07 08:21:30 +00001646
1647 // If the type contains a pointer to data member we can't memset it to zero.
1648 // Instead, create a null constant and copy it to the destination.
John McCall2725aa12011-02-01 21:35:06 +00001649 // TODO: there are other patterns besides zero that we can usefully memset,
1650 // like -1, which happens to be the pattern used by member-pointers.
John McCall614dbdc2010-08-22 21:01:12 +00001651 if (!CGM.getTypes().isZeroInitializable(Ty)) {
John McCall2725aa12011-02-01 21:35:06 +00001652 // For a VLA, emit a single element, then splat that over the VLA.
1653 if (vla) Ty = getContext().getBaseElementType(vla);
John McCalla08ffd22011-01-14 10:37:58 +00001654
John McCall7cd1d972010-08-07 08:21:30 +00001655 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
1656
Michael Ilseman686240a2012-12-04 00:29:55 +00001657 llvm::GlobalVariable *NullVariable =
John McCall7cd1d972010-08-07 08:21:30 +00001658 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
Michael Ilseman686240a2012-12-04 00:29:55 +00001659 /*isConstant=*/true,
John McCall7cd1d972010-08-07 08:21:30 +00001660 llvm::GlobalVariable::PrivateLinkage,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001661 NullConstant, Twine());
John McCall7f416cc2015-09-08 08:05:57 +00001662 CharUnits NullAlign = DestPtr.getAlignment();
1663 NullVariable->setAlignment(NullAlign.getQuantity());
1664 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
1665 NullAlign);
John McCall7cd1d972010-08-07 08:21:30 +00001666
John McCall2725aa12011-02-01 21:35:06 +00001667 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
1668
John McCall7cd1d972010-08-07 08:21:30 +00001669 // Get and call the appropriate llvm.memcpy overload.
John McCall7f416cc2015-09-08 08:05:57 +00001670 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
John McCall7cd1d972010-08-07 08:21:30 +00001671 return;
Michael Ilseman686240a2012-12-04 00:29:55 +00001672 }
1673
John McCall7cd1d972010-08-07 08:21:30 +00001674 // Otherwise, just memset the whole thing to zero. This is legal
1675 // because in LLVM, all default initializers (other than the ones we just
1676 // handled above) are guaranteed to have a bit pattern of all zeros.
John McCall7f416cc2015-09-08 08:05:57 +00001677 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001678}
1679
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001680llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001681 // Make sure that there is a block for the indirect goto.
Craig Topper8a13c412014-05-21 05:09:00 +00001682 if (!IndirectBranch)
Chris Lattner6c4d2552009-10-28 23:59:40 +00001683 GetIndirectGotoBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001684
John McCallad5d61e2010-07-23 21:56:41 +00001685 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001686
Chris Lattner6c4d2552009-10-28 23:59:40 +00001687 // Make sure the indirect branch includes all of the address-taken blocks.
1688 IndirectBranch->addDestination(BB);
1689 return llvm::BlockAddress::get(CurFn, BB);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001690}
1691
1692llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001693 // If we already made the indirect branch for indirect goto, return its block.
1694 if (IndirectBranch) return IndirectBranch->getParent();
Michael Ilseman686240a2012-12-04 00:29:55 +00001695
John McCall7f416cc2015-09-08 08:05:57 +00001696 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
Michael Ilseman686240a2012-12-04 00:29:55 +00001697
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001698 // Create the PHI node that indirect gotos will add entries to.
Jay Foad20c0f022011-03-30 11:28:58 +00001699 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
1700 "indirect.goto.dest");
Michael Ilseman686240a2012-12-04 00:29:55 +00001701
Chris Lattner6c4d2552009-10-28 23:59:40 +00001702 // Create the indirect branch instruction.
1703 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
1704 return IndirectBranch->getParent();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001705}
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001706
John McCall82fe67b2011-07-09 01:37:26 +00001707/// Computes the length of an array in elements, as well as the base
1708/// element type and a properly-typed first element pointer.
1709llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1710 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001711 Address &addr) {
John McCall82fe67b2011-07-09 01:37:26 +00001712 const ArrayType *arrayType = origArrayType;
1713
1714 // If it's a VLA, we have to load the stored size. Note that
1715 // this is the size of the VLA in bytes, not its size in elements.
Craig Topper8a13c412014-05-21 05:09:00 +00001716 llvm::Value *numVLAElements = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001717 if (isa<VariableArrayType>(arrayType)) {
Sander de Smalen891af03a2018-02-03 13:55:59 +00001718 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).NumElts;
John McCall82fe67b2011-07-09 01:37:26 +00001719
1720 // Walk into all VLAs. This doesn't require changes to addr,
1721 // which has type T* where T is the first non-VLA element type.
1722 do {
1723 QualType elementType = arrayType->getElementType();
1724 arrayType = getContext().getAsArrayType(elementType);
1725
1726 // If we only have VLA components, 'addr' requires no adjustment.
1727 if (!arrayType) {
1728 baseType = elementType;
1729 return numVLAElements;
1730 }
1731 } while (isa<VariableArrayType>(arrayType));
1732
1733 // We get out here only if we find a constant array type
1734 // inside the VLA.
1735 }
1736
1737 // We have some number of constant-length arrays, so addr should
1738 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks
1739 // down to the first element of addr.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001740 SmallVector<llvm::Value*, 8> gepIndices;
John McCall82fe67b2011-07-09 01:37:26 +00001741
1742 // GEP down to the array type.
1743 llvm::ConstantInt *zero = Builder.getInt32(0);
1744 gepIndices.push_back(zero);
1745
John McCall82fe67b2011-07-09 01:37:26 +00001746 uint64_t countFromCLAs = 1;
Richard Smithf3c37e82012-04-22 05:51:36 +00001747 QualType eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001748
Chris Lattner2192fe52011-07-18 04:24:23 +00001749 llvm::ArrayType *llvmArrayType =
John McCall7f416cc2015-09-08 08:05:57 +00001750 dyn_cast<llvm::ArrayType>(addr.getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001751 while (llvmArrayType) {
John McCall82fe67b2011-07-09 01:37:26 +00001752 assert(isa<ConstantArrayType>(arrayType));
1753 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1754 == llvmArrayType->getNumElements());
1755
1756 gepIndices.push_back(zero);
1757 countFromCLAs *= llvmArrayType->getNumElements();
Richard Smithf3c37e82012-04-22 05:51:36 +00001758 eltType = arrayType->getElementType();
John McCall82fe67b2011-07-09 01:37:26 +00001759
1760 llvmArrayType =
1761 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
John McCall82fe67b2011-07-09 01:37:26 +00001762 arrayType = getContext().getAsArrayType(arrayType->getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001763 assert((!llvmArrayType || arrayType) &&
1764 "LLVM and Clang types are out-of-synch");
John McCall82fe67b2011-07-09 01:37:26 +00001765 }
1766
Richard Smithf3c37e82012-04-22 05:51:36 +00001767 if (arrayType) {
1768 // From this point onwards, the Clang array type has been emitted
1769 // as some other type (probably a packed struct). Compute the array
1770 // size, and just emit the 'begin' expression as a bitcast.
1771 while (arrayType) {
1772 countFromCLAs *=
1773 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1774 eltType = arrayType->getElementType();
1775 arrayType = getContext().getAsArrayType(eltType);
1776 }
John McCall82fe67b2011-07-09 01:37:26 +00001777
John McCall7f416cc2015-09-08 08:05:57 +00001778 llvm::Type *baseType = ConvertType(eltType);
1779 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
Richard Smithf3c37e82012-04-22 05:51:36 +00001780 } else {
1781 // Create the actual GEP.
John McCall7f416cc2015-09-08 08:05:57 +00001782 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(),
1783 gepIndices, "array.begin"),
1784 addr.getAlignment());
Richard Smithf3c37e82012-04-22 05:51:36 +00001785 }
1786
1787 baseType = eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001788
1789 llvm::Value *numElements
1790 = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1791
1792 // If we had any VLA dimensions, factor them in.
1793 if (numVLAElements)
1794 numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1795
1796 return numElements;
1797}
1798
Sander de Smalen891af03a2018-02-03 13:55:59 +00001799CodeGenFunction::VlaSizePair CodeGenFunction::getVLASize(QualType type) {
John McCall23c29fe2011-06-24 21:55:10 +00001800 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1801 assert(vla && "type was not a variable array type!");
1802 return getVLASize(vla);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001803}
Anders Carlssonccbe9202008-12-12 07:19:02 +00001804
Sander de Smalen891af03a2018-02-03 13:55:59 +00001805CodeGenFunction::VlaSizePair
John McCall23c29fe2011-06-24 21:55:10 +00001806CodeGenFunction::getVLASize(const VariableArrayType *type) {
1807 // The number of elements so far; always size_t.
Craig Topper8a13c412014-05-21 05:09:00 +00001808 llvm::Value *numElements = nullptr;
John McCall23c29fe2011-06-24 21:55:10 +00001809
1810 QualType elementType;
1811 do {
1812 elementType = type->getElementType();
1813 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1814 assert(vlaSize && "no size for VLA!");
1815 assert(vlaSize->getType() == SizeTy);
1816
1817 if (!numElements) {
1818 numElements = vlaSize;
1819 } else {
1820 // It's undefined behavior if this wraps around, so mark it that way.
Alexey Samsonovcb3f8122014-03-20 10:48:29 +00001821 // FIXME: Teach -fsanitize=undefined to trap this.
John McCall23c29fe2011-06-24 21:55:10 +00001822 numElements = Builder.CreateNUWMul(numElements, vlaSize);
1823 }
1824 } while ((type = getContext().getAsVariableArrayType(elementType)));
1825
Sander de Smalen891af03a2018-02-03 13:55:59 +00001826 return { numElements, elementType };
1827}
1828
1829CodeGenFunction::VlaSizePair
1830CodeGenFunction::getVLAElements1D(QualType type) {
1831 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1832 assert(vla && "type was not a variable array type!");
1833 return getVLAElements1D(vla);
1834}
1835
1836CodeGenFunction::VlaSizePair
1837CodeGenFunction::getVLAElements1D(const VariableArrayType *Vla) {
1838 llvm::Value *VlaSize = VLASizeMap[Vla->getSizeExpr()];
1839 assert(VlaSize && "no size for VLA!");
1840 assert(VlaSize->getType() == SizeTy);
1841 return { VlaSize, Vla->getElementType() };
John McCall23c29fe2011-06-24 21:55:10 +00001842}
1843
1844void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
1845 assert(type->isVariablyModifiedType() &&
Anders Carlsson8a01b792008-12-20 20:46:34 +00001846 "Must pass variably modified type to EmitVLASizes!");
Mike Stump11289f42009-09-09 15:08:12 +00001847
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001848 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00001849
John McCall23c29fe2011-06-24 21:55:10 +00001850 // We're going to walk down into the type and look for VLA
1851 // expressions.
John McCall23c29fe2011-06-24 21:55:10 +00001852 do {
1853 assert(type->isVariablyModifiedType());
Mike Stump11289f42009-09-09 15:08:12 +00001854
John McCall23c29fe2011-06-24 21:55:10 +00001855 const Type *ty = type.getTypePtr();
1856 switch (ty->getTypeClass()) {
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001857
John McCall23c29fe2011-06-24 21:55:10 +00001858#define TYPE(Class, Base)
1859#define ABSTRACT_TYPE(Class, Base)
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001860#define NON_CANONICAL_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001861#define DEPENDENT_TYPE(Class, Base) case Type::Class:
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001862#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001863#include "clang/AST/TypeNodes.def"
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001864 llvm_unreachable("unexpected dependent type!");
Mike Stump11289f42009-09-09 15:08:12 +00001865
John McCall23c29fe2011-06-24 21:55:10 +00001866 // These types are never variably-modified.
1867 case Type::Builtin:
1868 case Type::Complex:
1869 case Type::Vector:
1870 case Type::ExtVector:
1871 case Type::Record:
1872 case Type::Enum:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001873 case Type::Elaborated:
1874 case Type::TemplateSpecialization:
Manman Rene6be26c2016-09-13 17:25:08 +00001875 case Type::ObjCTypeParam:
John McCall23c29fe2011-06-24 21:55:10 +00001876 case Type::ObjCObject:
1877 case Type::ObjCInterface:
1878 case Type::ObjCObjectPointer:
1879 llvm_unreachable("type class is never variably-modified!");
Mike Stump11289f42009-09-09 15:08:12 +00001880
Reid Kleckner0503a872013-12-05 01:23:43 +00001881 case Type::Adjusted:
1882 type = cast<AdjustedType>(ty)->getAdjustedType();
1883 break;
1884
Reid Kleckner8a365022013-06-24 17:51:48 +00001885 case Type::Decayed:
1886 type = cast<DecayedType>(ty)->getPointeeType();
1887 break;
1888
John McCall23c29fe2011-06-24 21:55:10 +00001889 case Type::Pointer:
1890 type = cast<PointerType>(ty)->getPointeeType();
1891 break;
Mike Stump11289f42009-09-09 15:08:12 +00001892
John McCall23c29fe2011-06-24 21:55:10 +00001893 case Type::BlockPointer:
1894 type = cast<BlockPointerType>(ty)->getPointeeType();
1895 break;
1896
1897 case Type::LValueReference:
1898 case Type::RValueReference:
1899 type = cast<ReferenceType>(ty)->getPointeeType();
1900 break;
1901
1902 case Type::MemberPointer:
1903 type = cast<MemberPointerType>(ty)->getPointeeType();
1904 break;
1905
1906 case Type::ConstantArray:
1907 case Type::IncompleteArray:
1908 // Losing element qualification here is fine.
1909 type = cast<ArrayType>(ty)->getElementType();
1910 break;
1911
1912 case Type::VariableArray: {
1913 // Losing element qualification here is fine.
1914 const VariableArrayType *vat = cast<VariableArrayType>(ty);
1915
1916 // Unknown size indication requires no size computation.
1917 // Otherwise, evaluate and record it.
1918 if (const Expr *size = vat->getSizeExpr()) {
1919 // It's possible that we might have emitted this already,
1920 // e.g. with a typedef and a pointer to it.
1921 llvm::Value *&entry = VLASizeMap[size];
1922 if (!entry) {
Richard Smith481652b2012-10-10 01:11:12 +00001923 llvm::Value *Size = EmitScalarExpr(size);
1924
1925 // C11 6.7.6.2p5:
1926 // If the size is an expression that is not an integer constant
1927 // expression [...] each time it is evaluated it shall have a value
1928 // greater than zero.
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001929 if (SanOpts.has(SanitizerKind::VLABound) &&
Richard Smithb1b0ab42012-11-05 22:21:05 +00001930 size->getType()->isSignedIntegerType()) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001931 SanitizerScope SanScope(this);
Richard Smith481652b2012-10-10 01:11:12 +00001932 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
1933 llvm::Constant *StaticArgs[] = {
Stephen Kellyf2ceec42018-08-09 21:08:08 +00001934 EmitCheckSourceLocation(size->getBeginLoc()),
1935 EmitCheckTypeDescriptor(size->getType())};
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001936 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
1937 SanitizerKind::VLABound),
Filipe Cabecinhas322ecd92016-12-12 16:18:40 +00001938 SanitizerHandler::VLABoundNotPositive, StaticArgs, Size);
Richard Smith481652b2012-10-10 01:11:12 +00001939 }
1940
John McCall23c29fe2011-06-24 21:55:10 +00001941 // Always zexting here would be wrong if it weren't
1942 // undefined behavior to have a negative bound.
Richard Smith8772bd82012-10-10 01:12:11 +00001943 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
John McCall23c29fe2011-06-24 21:55:10 +00001944 }
1945 }
1946 type = vat->getElementType();
1947 break;
Anders Carlsson8a01b792008-12-20 20:46:34 +00001948 }
Mike Stump11289f42009-09-09 15:08:12 +00001949
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001950 case Type::FunctionProto:
John McCall23c29fe2011-06-24 21:55:10 +00001951 case Type::FunctionNoProto:
Alp Toker314cc812014-01-25 16:55:45 +00001952 type = cast<FunctionType>(ty)->getReturnType();
John McCall23c29fe2011-06-24 21:55:10 +00001953 break;
Eli Friedman0dfb8892011-10-06 23:00:33 +00001954
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001955 case Type::Paren:
1956 case Type::TypeOf:
1957 case Type::UnaryTransform:
1958 case Type::Attributed:
1959 case Type::SubstTemplateTypeParm:
David Blaikie66ed89d2013-07-13 21:08:08 +00001960 case Type::PackExpansion:
Leonard Chanc72aaf62019-05-07 03:20:17 +00001961 case Type::MacroQualified:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001962 // Keep walking after single level desugaring.
1963 type = type.getSingleStepDesugaredType(getContext());
1964 break;
1965
1966 case Type::Typedef:
1967 case Type::Decltype:
1968 case Type::Auto:
Richard Smith600b5262017-01-26 20:40:47 +00001969 case Type::DeducedTemplateSpecialization:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001970 // Stop walking: nothing to do.
1971 return;
1972
1973 case Type::TypeOfExpr:
1974 // Stop walking: emit typeof expression.
1975 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
1976 return;
1977
Eli Friedman0dfb8892011-10-06 23:00:33 +00001978 case Type::Atomic:
1979 type = cast<AtomicType>(ty)->getValueType();
1980 break;
Xiuli Pan9c14e282016-01-09 12:53:17 +00001981
1982 case Type::Pipe:
1983 type = cast<PipeType>(ty)->getElementType();
1984 break;
John McCall23c29fe2011-06-24 21:55:10 +00001985 }
1986 } while (type->isVariablyModifiedType());
Anders Carlssonccbe9202008-12-12 07:19:02 +00001987}
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001988
John McCall7f416cc2015-09-08 08:05:57 +00001989Address CodeGenFunction::EmitVAListRef(const Expr* E) {
Dan Gohmane9e32dc2010-10-29 22:47:07 +00001990 if (getContext().getBuiltinVaListType()->isArrayType())
John McCall7f416cc2015-09-08 08:05:57 +00001991 return EmitPointerWithAlignment(E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001992 return EmitLValue(E).getAddress();
1993}
Anders Carlsson15cb75a2009-02-07 22:53:43 +00001994
Charles Davisc7d5c942015-09-17 20:55:33 +00001995Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
1996 return EmitLValue(E).getAddress();
1997}
1998
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00001999void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
Peter Collingbourneeeb56ab2016-09-13 01:13:19 +00002000 const APValue &Init) {
Richard Smithe637cbe2019-05-21 23:15:18 +00002001 assert(Init.hasValue() && "Invalid DeclRefExpr initializer!");
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002002 if (CGDebugInfo *Dbg = getDebugInfo())
Benjamin Kramer8c305922016-02-02 11:06:51 +00002003 if (CGM.getCodeGenOpts().getDebugInfo() >= codegenoptions::LimitedDebugInfo)
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00002004 Dbg->EmitGlobalVariable(E->getDecl(), Init);
Devang Patele03edfd2010-08-10 07:24:25 +00002005}
John McCallc07a0c72011-02-17 10:25:35 +00002006
2007CodeGenFunction::PeepholeProtection
2008CodeGenFunction::protectFromPeepholes(RValue rvalue) {
2009 // At the moment, the only aggressive peephole we do in IR gen
2010 // is trunc(zext) folding, but if we add more, we can easily
2011 // extend this protection.
2012
2013 if (!rvalue.isScalar()) return PeepholeProtection();
2014 llvm::Value *value = rvalue.getScalarVal();
2015 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
2016
2017 // Just make an extra bitcast.
2018 assert(HaveInsertPoint());
2019 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
2020 Builder.GetInsertBlock());
2021
2022 PeepholeProtection protection;
2023 protection.Inst = inst;
2024 return protection;
2025}
2026
2027void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
2028 if (!protection.Inst) return;
2029
2030 // In theory, we could try to duplicate the peepholes now, but whatever.
2031 protection.Inst->eraseFromParent();
2032}
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002033
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002034void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue,
2035 QualType Ty, SourceLocation Loc,
2036 SourceLocation AssumptionLoc,
2037 llvm::Value *Alignment,
2038 llvm::Value *OffsetValue) {
2039 llvm::Value *TheCheck;
2040 llvm::Instruction *Assumption = Builder.CreateAlignmentAssumption(
2041 CGM.getDataLayout(), PtrValue, Alignment, OffsetValue, &TheCheck);
2042 if (SanOpts.has(SanitizerKind::Alignment)) {
2043 EmitAlignmentAssumptionCheck(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
2044 OffsetValue, TheCheck, Assumption);
2045 }
2046}
2047
2048void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue,
2049 QualType Ty, SourceLocation Loc,
2050 SourceLocation AssumptionLoc,
2051 unsigned Alignment,
2052 llvm::Value *OffsetValue) {
2053 llvm::Value *TheCheck;
2054 llvm::Instruction *Assumption = Builder.CreateAlignmentAssumption(
2055 CGM.getDataLayout(), PtrValue, Alignment, OffsetValue, &TheCheck);
2056 if (SanOpts.has(SanitizerKind::Alignment)) {
2057 llvm::Value *AlignmentVal = llvm::ConstantInt::get(IntPtrTy, Alignment);
2058 EmitAlignmentAssumptionCheck(PtrValue, Ty, Loc, AssumptionLoc, AlignmentVal,
2059 OffsetValue, TheCheck, Assumption);
2060 }
2061}
2062
2063void CodeGenFunction::EmitAlignmentAssumption(llvm::Value *PtrValue,
2064 const Expr *E,
2065 SourceLocation AssumptionLoc,
2066 unsigned Alignment,
2067 llvm::Value *OffsetValue) {
2068 if (auto *CE = dyn_cast<CastExpr>(E))
2069 E = CE->getSubExprAsWritten();
2070 QualType Ty = E->getType();
2071 SourceLocation Loc = E->getExprLoc();
2072
2073 EmitAlignmentAssumption(PtrValue, Ty, Loc, AssumptionLoc, Alignment,
2074 OffsetValue);
2075}
2076
James Y Knight8799cae2019-02-03 21:53:49 +00002077llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Function *AnnotationFn,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002078 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002079 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002080 SourceLocation Location) {
2081 llvm::Value *Args[4] = {
2082 AnnotatedVal,
2083 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
2084 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
2085 CGM.EmitAnnotationLineNo(Location)
2086 };
2087 return Builder.CreateCall(AnnotationFn, Args);
2088}
2089
2090void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
2091 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
2092 // FIXME We create a new bitcast for every annotation because that's what
2093 // llvm-gcc was doing.
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002094 for (const auto *I : D->specific_attrs<AnnotateAttr>())
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002095 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
2096 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002097 I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002098}
2099
John McCall7f416cc2015-09-08 08:05:57 +00002100Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
2101 Address Addr) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002102 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
John McCall7f416cc2015-09-08 08:05:57 +00002103 llvm::Value *V = Addr.getPointer();
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002104 llvm::Type *VTy = V->getType();
James Y Knight8799cae2019-02-03 21:53:49 +00002105 llvm::Function *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002106 CGM.Int8PtrTy);
2107
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002108 for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002109 // FIXME Always emit the cast inst so we can differentiate between
2110 // annotation on the first field of a struct and annotation on the struct
2111 // itself.
2112 if (VTy != CGM.Int8PtrTy)
Erich Keane2a4eea32018-12-18 16:22:21 +00002113 V = Builder.CreateBitCast(V, CGM.Int8PtrTy);
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00002114 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002115 V = Builder.CreateBitCast(V, VTy);
2116 }
2117
John McCall7f416cc2015-09-08 08:05:57 +00002118 return Address(V, Addr.getAlignment());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00002119}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00002120
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00002121CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
Alexander Musman515ad8c2014-05-22 08:54:05 +00002122
Alexey Samsonov24cad992014-07-17 18:46:27 +00002123CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
2124 : CGF(CGF) {
2125 assert(!CGF->IsSanitizerScope);
2126 CGF->IsSanitizerScope = true;
2127}
2128
2129CodeGenFunction::SanitizerScope::~SanitizerScope() {
2130 CGF->IsSanitizerScope = false;
2131}
2132
Alexander Musman515ad8c2014-05-22 08:54:05 +00002133void CodeGenFunction::InsertHelper(llvm::Instruction *I,
2134 const llvm::Twine &Name,
2135 llvm::BasicBlock *BB,
2136 llvm::BasicBlock::iterator InsertPt) const {
2137 LoopStack.InsertHelper(I);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00002138 if (IsSanitizerScope)
2139 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002140}
2141
Mehdi Amini557c20a2016-03-13 21:05:23 +00002142void CGBuilderInserter::InsertHelper(
Alexander Musman515ad8c2014-05-22 08:54:05 +00002143 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
2144 llvm::BasicBlock::iterator InsertPt) const {
Mehdi Amini557c20a2016-03-13 21:05:23 +00002145 llvm::IRBuilderDefaultInserter::InsertHelper(I, Name, BB, InsertPt);
Alexander Musman515ad8c2014-05-22 08:54:05 +00002146 if (CGF)
2147 CGF->InsertHelper(I, Name, BB, InsertPt);
2148}
2149
David Blaikie5df253382015-11-12 01:09:58 +00002150static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures,
Eric Christopherce836772015-11-14 02:38:37 +00002151 CodeGenModule &CGM, const FunctionDecl *FD,
2152 std::string &FirstMissing) {
David Blaikie5df253382015-11-12 01:09:58 +00002153 // If there aren't any required features listed then go ahead and return.
2154 if (ReqFeatures.empty())
2155 return false;
2156
2157 // Now build up the set of caller features and verify that all the required
2158 // features are there.
2159 llvm::StringMap<bool> CallerFeatureMap;
Erich Keanede6480a32018-11-13 15:48:08 +00002160 CGM.getFunctionFeatureMap(CallerFeatureMap, GlobalDecl().getWithDecl(FD));
David Blaikie5df253382015-11-12 01:09:58 +00002161
2162 // If we have at least one of the features in the feature list return
2163 // true, otherwise return false.
2164 return std::all_of(
2165 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) {
2166 SmallVector<StringRef, 1> OrFeatures;
Craig Topper274506d2018-05-03 21:01:33 +00002167 Feature.split(OrFeatures, '|');
Fangrui Song3117b172018-10-20 17:53:42 +00002168 return llvm::any_of(OrFeatures, [&](StringRef Feature) {
2169 if (!CallerFeatureMap.lookup(Feature)) {
2170 FirstMissing = Feature.str();
2171 return false;
2172 }
2173 return true;
2174 });
David Blaikie5df253382015-11-12 01:09:58 +00002175 });
2176}
2177
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002178// Emits an error if we don't have a valid set of target features for the
2179// called function.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002180void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
2181 const FunctionDecl *TargetDecl) {
2182 // Early exit if this is an indirect call.
2183 if (!TargetDecl)
2184 return;
2185
2186 // Get the current enclosing function if it exists. If it doesn't
2187 // we can't check the target features anyhow.
2188 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl);
2189 if (!FD)
2190 return;
2191
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002192 // Grab the required features for the call. For a builtin this is listed in
2193 // the td file with the default cpu, for an always_inline function this is any
2194 // listed cpu and any listed features.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002195 unsigned BuiltinID = TargetDecl->getBuiltinID();
Eric Christopherce836772015-11-14 02:38:37 +00002196 std::string MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002197 if (BuiltinID) {
2198 SmallVector<StringRef, 1> ReqFeatures;
2199 const char *FeatureList =
2200 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2201 // Return if the builtin doesn't have any required features.
2202 if (!FeatureList || StringRef(FeatureList) == "")
2203 return;
Craig Topper274506d2018-05-03 21:01:33 +00002204 StringRef(FeatureList).split(ReqFeatures, ',');
Eric Christopherce836772015-11-14 02:38:37 +00002205 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002206 CGM.getDiags().Report(E->getBeginLoc(), diag::err_builtin_needs_feature)
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002207 << TargetDecl->getDeclName()
2208 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
2209
Erich Keane3efe0022018-07-20 14:13:28 +00002210 } else if (TargetDecl->hasAttr<TargetAttr>() ||
2211 TargetDecl->hasAttr<CPUSpecificAttr>()) {
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002212 // Get the required features for the callee.
Gabor Buella1a83d062018-06-07 08:48:36 +00002213
2214 const TargetAttr *TD = TargetDecl->getAttr<TargetAttr>();
2215 TargetAttr::ParsedTargetAttr ParsedAttr = CGM.filterFunctionTargetAttrs(TD);
2216
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002217 SmallVector<StringRef, 1> ReqFeatures;
2218 llvm::StringMap<bool> CalleeFeatureMap;
2219 CGM.getFunctionFeatureMap(CalleeFeatureMap, TargetDecl);
Gabor Buella1a83d062018-06-07 08:48:36 +00002220
2221 for (const auto &F : ParsedAttr.Features) {
2222 if (F[0] == '+' && CalleeFeatureMap.lookup(F.substr(1)))
2223 ReqFeatures.push_back(StringRef(F).substr(1));
2224 }
2225
Eric Christopherb7bbc532015-11-16 18:29:59 +00002226 for (const auto &F : CalleeFeatureMap) {
2227 // Only positive features are "required".
2228 if (F.getValue())
2229 ReqFeatures.push_back(F.getKey());
2230 }
Eric Christopherce836772015-11-14 02:38:37 +00002231 if (!hasRequiredFeatures(ReqFeatures, CGM, FD, MissingFeature))
Stephen Kellyf2ceec42018-08-09 21:08:08 +00002232 CGM.getDiags().Report(E->getBeginLoc(), diag::err_function_needs_feature)
Eric Christopherce836772015-11-14 02:38:37 +00002233 << FD->getDeclName() << TargetDecl->getDeclName() << MissingFeature;
Eric Christopher2b2d56f2015-11-12 00:44:12 +00002234 }
Eric Christopherfbfd97e2015-11-12 00:44:07 +00002235}
Peter Collingbournedc134532016-01-16 00:31:22 +00002236
2237void CodeGenFunction::EmitSanitizerStatReport(llvm::SanitizerStatKind SSK) {
2238 if (!CGM.getCodeGenOpts().SanitizeStats)
2239 return;
2240
2241 llvm::IRBuilder<> IRB(Builder.GetInsertBlock(), Builder.GetInsertPoint());
2242 IRB.SetCurrentDebugLocation(Builder.getCurrentDebugLocation());
2243 CGM.getSanStats().create(IRB, SSK);
2244}
Amara Emerson652795d2016-11-10 14:44:30 +00002245
Erich Keanef353ae12018-09-13 16:58:24 +00002246llvm::Value *
2247CodeGenFunction::FormResolverCondition(const MultiVersionResolverOption &RO) {
2248 llvm::Value *Condition = nullptr;
Erich Keane281d20b2018-01-08 21:34:17 +00002249
Erich Keanef353ae12018-09-13 16:58:24 +00002250 if (!RO.Conditions.Architecture.empty())
2251 Condition = EmitX86CpuIs(RO.Conditions.Architecture);
2252
2253 if (!RO.Conditions.Features.empty()) {
2254 llvm::Value *FeatureCond = EmitX86CpuSupports(RO.Conditions.Features);
2255 Condition =
2256 Condition ? Builder.CreateAnd(Condition, FeatureCond) : FeatureCond;
Erich Keane281d20b2018-01-08 21:34:17 +00002257 }
Erich Keanef353ae12018-09-13 16:58:24 +00002258 return Condition;
Erich Keane281d20b2018-01-08 21:34:17 +00002259}
2260
Erich Keane19a8adc2018-10-25 18:57:19 +00002261static void CreateMultiVersionResolverReturn(CodeGenModule &CGM,
2262 llvm::Function *Resolver,
2263 CGBuilderTy &Builder,
2264 llvm::Function *FuncToReturn,
2265 bool SupportsIFunc) {
2266 if (SupportsIFunc) {
2267 Builder.CreateRet(FuncToReturn);
2268 return;
2269 }
2270
2271 llvm::SmallVector<llvm::Value *, 10> Args;
2272 llvm::for_each(Resolver->args(),
2273 [&](llvm::Argument &Arg) { Args.push_back(&Arg); });
2274
2275 llvm::CallInst *Result = Builder.CreateCall(FuncToReturn, Args);
2276 Result->setTailCallKind(llvm::CallInst::TCK_MustTail);
2277
2278 if (Resolver->getReturnType()->isVoidTy())
2279 Builder.CreateRetVoid();
2280 else
2281 Builder.CreateRet(Result);
2282}
2283
Erich Keanef353ae12018-09-13 16:58:24 +00002284void CodeGenFunction::EmitMultiVersionResolver(
2285 llvm::Function *Resolver, ArrayRef<MultiVersionResolverOption> Options) {
Erich Keane281d20b2018-01-08 21:34:17 +00002286 assert((getContext().getTargetInfo().getTriple().getArch() ==
2287 llvm::Triple::x86 ||
2288 getContext().getTargetInfo().getTriple().getArch() ==
2289 llvm::Triple::x86_64) &&
2290 "Only implemented for x86 targets");
Erich Keane19a8adc2018-10-25 18:57:19 +00002291
2292 bool SupportsIFunc = getContext().getTargetInfo().supportsIFunc();
2293
Erich Keane3efe0022018-07-20 14:13:28 +00002294 // Main function's basic block.
2295 llvm::BasicBlock *CurBlock = createBasicBlock("resolver_entry", Resolver);
2296 Builder.SetInsertPoint(CurBlock);
2297 EmitX86CpuInit();
2298
Erich Keanef353ae12018-09-13 16:58:24 +00002299 for (const MultiVersionResolverOption &RO : Options) {
Erich Keane3efe0022018-07-20 14:13:28 +00002300 Builder.SetInsertPoint(CurBlock);
Erich Keanef353ae12018-09-13 16:58:24 +00002301 llvm::Value *Condition = FormResolverCondition(RO);
Erich Keane3efe0022018-07-20 14:13:28 +00002302
Erich Keanef353ae12018-09-13 16:58:24 +00002303 // The 'default' or 'generic' case.
2304 if (!Condition) {
2305 assert(&RO == Options.end() - 1 &&
2306 "Default or Generic case must be last");
Erich Keane19a8adc2018-10-25 18:57:19 +00002307 CreateMultiVersionResolverReturn(CGM, Resolver, Builder, RO.Function,
2308 SupportsIFunc);
Erich Keane3efe0022018-07-20 14:13:28 +00002309 return;
2310 }
Erich Keanef353ae12018-09-13 16:58:24 +00002311
Erich Keane3efe0022018-07-20 14:13:28 +00002312 llvm::BasicBlock *RetBlock = createBasicBlock("resolver_return", Resolver);
Erich Keane19a8adc2018-10-25 18:57:19 +00002313 CGBuilderTy RetBuilder(*this, RetBlock);
2314 CreateMultiVersionResolverReturn(CGM, Resolver, RetBuilder, RO.Function,
2315 SupportsIFunc);
Erich Keane3efe0022018-07-20 14:13:28 +00002316 CurBlock = createBasicBlock("resolver_else", Resolver);
Erich Keanef353ae12018-09-13 16:58:24 +00002317 Builder.CreateCondBr(Condition, RetBlock, CurBlock);
Erich Keane3efe0022018-07-20 14:13:28 +00002318 }
2319
Erich Keanef353ae12018-09-13 16:58:24 +00002320 // If no generic/default, emit an unreachable.
Erich Keane3efe0022018-07-20 14:13:28 +00002321 Builder.SetInsertPoint(CurBlock);
2322 llvm::CallInst *TrapCall = EmitTrapCall(llvm::Intrinsic::trap);
2323 TrapCall->setDoesNotReturn();
2324 TrapCall->setDoesNotThrow();
2325 Builder.CreateUnreachable();
2326 Builder.ClearInsertionPoint();
2327}
2328
Roman Lebedevbd1c0872019-01-15 09:44:25 +00002329// Loc - where the diagnostic will point, where in the source code this
2330// alignment has failed.
2331// SecondaryLoc - if present (will be present if sufficiently different from
2332// Loc), the diagnostic will additionally point a "Note:" to this location.
2333// It should be the location where the __attribute__((assume_aligned))
2334// was written e.g.
2335void CodeGenFunction::EmitAlignmentAssumptionCheck(
2336 llvm::Value *Ptr, QualType Ty, SourceLocation Loc,
2337 SourceLocation SecondaryLoc, llvm::Value *Alignment,
2338 llvm::Value *OffsetValue, llvm::Value *TheCheck,
2339 llvm::Instruction *Assumption) {
2340 assert(Assumption && isa<llvm::CallInst>(Assumption) &&
2341 cast<llvm::CallInst>(Assumption)->getCalledValue() ==
2342 llvm::Intrinsic::getDeclaration(
2343 Builder.GetInsertBlock()->getParent()->getParent(),
2344 llvm::Intrinsic::assume) &&
2345 "Assumption should be a call to llvm.assume().");
2346 assert(&(Builder.GetInsertBlock()->back()) == Assumption &&
2347 "Assumption should be the last instruction of the basic block, "
2348 "since the basic block is still being generated.");
2349
2350 if (!SanOpts.has(SanitizerKind::Alignment))
2351 return;
2352
2353 // Don't check pointers to volatile data. The behavior here is implementation-
2354 // defined.
2355 if (Ty->getPointeeType().isVolatileQualified())
2356 return;
2357
2358 // We need to temorairly remove the assumption so we can insert the
2359 // sanitizer check before it, else the check will be dropped by optimizations.
2360 Assumption->removeFromParent();
2361
2362 {
2363 SanitizerScope SanScope(this);
2364
2365 if (!OffsetValue)
2366 OffsetValue = Builder.getInt1(0); // no offset.
2367
2368 llvm::Constant *StaticData[] = {EmitCheckSourceLocation(Loc),
2369 EmitCheckSourceLocation(SecondaryLoc),
2370 EmitCheckTypeDescriptor(Ty)};
2371 llvm::Value *DynamicData[] = {EmitCheckValue(Ptr),
2372 EmitCheckValue(Alignment),
2373 EmitCheckValue(OffsetValue)};
2374 EmitCheck({std::make_pair(TheCheck, SanitizerKind::Alignment)},
2375 SanitizerHandler::AlignmentAssumption, StaticData, DynamicData);
2376 }
2377
2378 // We are now in the (new, empty) "cont" basic block.
2379 // Reintroduce the assumption.
2380 Builder.Insert(Assumption);
2381 // FIXME: Assumption still has it's original basic block as it's Parent.
2382}
2383
Amara Emerson652795d2016-11-10 14:44:30 +00002384llvm::DebugLoc CodeGenFunction::SourceLocToDebugLoc(SourceLocation Location) {
2385 if (CGDebugInfo *DI = getDebugInfo())
2386 return DI->SourceLocToDebugLoc(Location);
2387
2388 return llvm::DebugLoc();
2389}