blob: b5812c8d314279f24092eb79ebf7a452657ad8c1 [file] [log] [blame]
Chris Lattnerbed31442007-05-28 01:07:47 +00001//===--- CodeGenFunction.cpp - Emit LLVM Code from ASTs for a Function ----===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattnerbed31442007-05-28 01:07:47 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This coordinates the per-function state used while generating code.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenFunction.h"
John McCall7f416cc2015-09-08 08:05:57 +000015#include "CGBlocks.h"
David Majnemerdc012fa2015-04-22 21:38:15 +000016#include "CGCleanup.h"
Peter Collingbournefa4d6032011-10-06 18:51:56 +000017#include "CGCUDARuntime.h"
John McCall5d865c322010-08-31 07:33:07 +000018#include "CGCXXABI.h"
Eli Friedman17630752008-05-22 01:40:10 +000019#include "CGDebugInfo.h"
Alexey Bataev9959db52014-05-06 10:08:46 +000020#include "CGOpenMPRuntime.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "CodeGenModule.h"
Justin Bogneref512b92014-01-06 22:27:43 +000022#include "CodeGenPGO.h"
Peter Collingbourneb453cd62013-10-20 21:29:19 +000023#include "TargetInfo.h"
Daniel Dunbarad319a72008-08-11 05:00:27 +000024#include "clang/AST/ASTContext.h"
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"
Sanjay Patela24296b2015-09-02 20:01:30 +000028#include "clang/Basic/Builtins.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000029#include "clang/Basic/TargetInfo.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000030#include "clang/CodeGen/CGFunctionInfo.h"
Chris Lattner3c77a352010-06-22 00:03:40 +000031#include "clang/Frontend/CodeGenOptions.h"
Eric Christopherfbfd97e2015-11-12 00:44:07 +000032#include "clang/Sema/SemaDiagnostic.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000033#include "llvm/IR/DataLayout.h"
34#include "llvm/IR/Intrinsics.h"
35#include "llvm/IR/MDBuilder.h"
36#include "llvm/IR/Operator.h"
Chris Lattnerbed31442007-05-28 01:07:47 +000037using namespace clang;
38using namespace CodeGen;
39
Fariborz Jahanian63628032012-06-26 16:06:38 +000040CodeGenFunction::CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext)
David Blaikie92848de2013-08-26 20:33:21 +000041 : CodeGenTypeCache(cgm), CGM(cgm), Target(cgm.getTarget()),
John McCall7f416cc2015-09-08 08:05:57 +000042 Builder(cgm, cgm.getModule().getContext(), llvm::ConstantFolder(),
David Blaikie8e90d222014-10-14 17:09:38 +000043 CGBuilderInserterTy(this)),
John McCall7f416cc2015-09-08 08:05:57 +000044 CurFn(nullptr), ReturnValue(Address::invalid()),
45 CapturedStmtInfo(nullptr),
Alexey Samsonov035462c2014-10-30 19:33:44 +000046 SanOpts(CGM.getLangOpts().Sanitize), IsSanitizerScope(false),
David Blaikie8e90d222014-10-14 17:09:38 +000047 CurFuncIsThunk(false), AutoreleaseResult(false), SawAsmBlock(false),
John McCall7f416cc2015-09-08 08:05:57 +000048 IsOutlinedSEHHelper(false),
49 BlockInfo(nullptr), BlockPointer(nullptr),
Reid Kleckner19819442014-07-25 21:39:46 +000050 LambdaThisCaptureField(nullptr), NormalCleanupDest(nullptr),
51 NextCleanupDestIndex(1), FirstBlockInfo(nullptr), EHResumeBlock(nullptr),
Reid Kleckneraca01db2015-02-04 22:37:07 +000052 ExceptionSlot(nullptr), EHSelectorSlot(nullptr),
Reid Kleckner9fe7f232015-07-07 00:36:30 +000053 DebugInfo(CGM.getModuleDebugInfo()),
54 DisableDebugInfo(false), DidCallStackSave(false), IndirectBranch(nullptr),
55 PGO(cgm), SwitchInsn(nullptr), SwitchWeights(nullptr),
56 CaseRangeBlock(nullptr), UnreachableBlock(nullptr), NumReturnExprs(0),
57 NumSimpleReturnExprs(0), CXXABIThisDecl(nullptr),
58 CXXABIThisValue(nullptr), CXXThisValue(nullptr),
John McCall7f416cc2015-09-08 08:05:57 +000059 CXXStructorImplicitParamDecl(nullptr),
Craig Topper8a13c412014-05-21 05:09:00 +000060 CXXStructorImplicitParamValue(nullptr), OutermostConditional(nullptr),
61 CurLexicalScope(nullptr), TerminateLandingPad(nullptr),
62 TerminateHandler(nullptr), TrapBB(nullptr) {
Fariborz Jahanian63628032012-06-26 16:06:38 +000063 if (!suppressNewContext)
64 CGM.getCXXABI().getMangleContext().startNewFunction();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000065
66 llvm::FastMathFlags FMF;
67 if (CGM.getLangOpts().FastMath)
Benjamin Kramer7464efc2012-12-09 21:58:24 +000068 FMF.setUnsafeAlgebra();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000069 if (CGM.getLangOpts().FiniteMathOnly) {
Benjamin Kramer7464efc2012-12-09 21:58:24 +000070 FMF.setNoNaNs();
71 FMF.setNoInfs();
Michael Ilseman7a167ee2012-12-04 00:36:06 +000072 }
Pekka Jaaskelainen37014502014-12-10 16:41:14 +000073 if (CGM.getCodeGenOpts().NoNaNsFPMath) {
74 FMF.setNoNaNs();
75 }
76 if (CGM.getCodeGenOpts().NoSignedZeros) {
77 FMF.setNoSignedZeros();
78 }
Sanjay Patel359b1052015-04-09 15:03:23 +000079 if (CGM.getCodeGenOpts().ReciprocalMath) {
80 FMF.setAllowReciprocal();
81 }
Michael Ilseman7a167ee2012-12-04 00:36:06 +000082 Builder.SetFastMathFlags(FMF);
Chris Lattner5696e7b2008-06-17 18:05:57 +000083}
Chris Lattnerd1af2d22007-05-29 23:17:50 +000084
John McCall08ef4662011-11-10 08:15:53 +000085CodeGenFunction::~CodeGenFunction() {
Richard Smith736a9472013-06-12 20:42:33 +000086 assert(LifetimeExtendedCleanupStack.empty() && "failed to emit a cleanup");
87
John McCall08ef4662011-11-10 08:15:53 +000088 // If there are any unclaimed block infos, go ahead and destroy them
89 // now. This can happen if IR-gen gets clever and skips evaluating
90 // something.
91 if (FirstBlockInfo)
92 destroyBlockInfos(FirstBlockInfo);
Alexey Bataev9959db52014-05-06 10:08:46 +000093
94 if (getLangOpts().OpenMP) {
Alexey Bataev3eff5f42015-02-25 08:32:46 +000095 CGM.getOpenMPRuntime().functionFinished(*this);
Alexey Bataev9959db52014-05-06 10:08:46 +000096 }
John McCall08ef4662011-11-10 08:15:53 +000097}
98
John McCall7f416cc2015-09-08 08:05:57 +000099CharUnits CodeGenFunction::getNaturalPointeeTypeAlignment(QualType T,
100 AlignmentSource *Source) {
101 return getNaturalTypeAlignment(T->getPointeeType(), Source,
102 /*forPointee*/ true);
David Majnemer99281062014-09-18 22:05:54 +0000103}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000104
John McCall7f416cc2015-09-08 08:05:57 +0000105CharUnits CodeGenFunction::getNaturalTypeAlignment(QualType T,
106 AlignmentSource *Source,
107 bool forPointeeType) {
108 // Honor alignment typedef attributes even on incomplete types.
109 // We also honor them straight for C++ class types, even as pointees;
110 // there's an expressivity gap here.
111 if (auto TT = T->getAs<TypedefType>()) {
112 if (auto Align = TT->getDecl()->getMaxAlignment()) {
113 if (Source) *Source = AlignmentSource::AttributedType;
114 return getContext().toCharUnitsFromBits(Align);
115 }
116 }
117
118 if (Source) *Source = AlignmentSource::Type;
119
120 CharUnits Alignment;
David Majnemer9df56372015-09-10 21:52:00 +0000121 if (T->isIncompleteType()) {
John McCall7f416cc2015-09-08 08:05:57 +0000122 Alignment = CharUnits::One(); // Shouldn't be used, but pessimistic is best.
123 } else {
124 // For C++ class pointees, we don't know whether we're pointing at a
125 // base or a complete object, so we generally need to use the
126 // non-virtual alignment.
127 const CXXRecordDecl *RD;
128 if (forPointeeType && (RD = T->getAsCXXRecordDecl())) {
129 Alignment = CGM.getClassPointerAlignment(RD);
130 } else {
131 Alignment = getContext().getTypeAlignInChars(T);
132 }
133
134 // Cap to the global maximum type alignment unless the alignment
135 // was somehow explicit on the type.
136 if (unsigned MaxAlign = getLangOpts().MaxTypeAlign) {
137 if (Alignment.getQuantity() > MaxAlign &&
138 !getContext().isAlignmentRequired(T))
139 Alignment = CharUnits::fromQuantity(MaxAlign);
140 }
141 }
142 return Alignment;
143}
144
145LValue CodeGenFunction::MakeNaturalAlignAddrLValue(llvm::Value *V, QualType T) {
146 AlignmentSource AlignSource;
147 CharUnits Alignment = getNaturalTypeAlignment(T, &AlignSource);
148 return LValue::MakeAddr(Address(V, Alignment), T, getContext(), AlignSource,
149 CGM.getTBAAInfo(T));
150}
151
152/// Given a value of type T* that may not be to a complete object,
153/// construct an l-value with the natural pointee alignment of T.
154LValue
155CodeGenFunction::MakeNaturalAlignPointeeAddrLValue(llvm::Value *V, QualType T) {
156 AlignmentSource AlignSource;
157 CharUnits Align = getNaturalTypeAlignment(T, &AlignSource, /*pointee*/ true);
158 return MakeAddrLValue(Address(V, Align), T, AlignSource);
159}
160
161
Chris Lattnera5f58b02011-07-09 17:41:47 +0000162llvm::Type *CodeGenFunction::ConvertTypeForMem(QualType T) {
Daniel Dunbaree3da872009-02-03 23:03:55 +0000163 return CGM.getTypes().ConvertTypeForMem(T);
164}
165
Chris Lattnera5f58b02011-07-09 17:41:47 +0000166llvm::Type *CodeGenFunction::ConvertType(QualType T) {
Chris Lattnerf033c142007-06-22 19:05:19 +0000167 return CGM.getTypes().ConvertType(T);
Chris Lattner45bb9142007-06-09 02:28:57 +0000168}
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000169
John McCall47fb9502013-03-07 21:37:08 +0000170TypeEvaluationKind CodeGenFunction::getEvaluationKind(QualType type) {
171 type = type.getCanonicalType();
172 while (true) {
173 switch (type->getTypeClass()) {
John McCall745ae282011-05-15 02:34:36 +0000174#define TYPE(name, parent)
175#define ABSTRACT_TYPE(name, parent)
176#define NON_CANONICAL_TYPE(name, parent) case Type::name:
177#define DEPENDENT_TYPE(name, parent) case Type::name:
178#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(name, parent) case Type::name:
179#include "clang/AST/TypeNodes.def"
John McCall47fb9502013-03-07 21:37:08 +0000180 llvm_unreachable("non-canonical or dependent type in IR-generation");
John McCall745ae282011-05-15 02:34:36 +0000181
Richard Smith27d807c2013-04-30 13:56:41 +0000182 case Type::Auto:
183 llvm_unreachable("undeduced auto type in IR-generation");
184
John McCall47fb9502013-03-07 21:37:08 +0000185 // Various scalar types.
186 case Type::Builtin:
187 case Type::Pointer:
188 case Type::BlockPointer:
189 case Type::LValueReference:
190 case Type::RValueReference:
191 case Type::MemberPointer:
192 case Type::Vector:
193 case Type::ExtVector:
194 case Type::FunctionProto:
195 case Type::FunctionNoProto:
196 case Type::Enum:
197 case Type::ObjCObjectPointer:
198 return TEK_Scalar;
John McCall745ae282011-05-15 02:34:36 +0000199
John McCall47fb9502013-03-07 21:37:08 +0000200 // Complexes.
201 case Type::Complex:
202 return TEK_Complex;
Eli Friedman0dfb8892011-10-06 23:00:33 +0000203
John McCall47fb9502013-03-07 21:37:08 +0000204 // Arrays, records, and Objective-C objects.
205 case Type::ConstantArray:
206 case Type::IncompleteArray:
207 case Type::VariableArray:
208 case Type::Record:
209 case Type::ObjCObject:
210 case Type::ObjCInterface:
211 return TEK_Aggregate;
212
213 // We operate on atomic values according to their underlying type.
214 case Type::Atomic:
215 type = cast<AtomicType>(type)->getValueType();
216 continue;
217 }
218 llvm_unreachable("unknown type kind!");
John McCall745ae282011-05-15 02:34:36 +0000219 }
Chris Lattner54fb19e2007-06-22 22:02:34 +0000220}
221
David Blaikie66e41972015-01-14 07:38:27 +0000222llvm::DebugLoc CodeGenFunction::EmitReturnBlock() {
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000223 // For cleanliness, we try to avoid emitting the return block for
224 // simple cases.
225 llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
226
227 if (CurBB) {
228 assert(!CurBB->getTerminator() && "Unexpected terminated block.");
229
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000230 // We have a valid insert point, reuse it if it is empty or there are no
231 // explicit jumps to the return block.
John McCallad5d61e2010-07-23 21:56:41 +0000232 if (CurBB->empty() || ReturnBlock.getBlock()->use_empty()) {
233 ReturnBlock.getBlock()->replaceAllUsesWith(CurBB);
234 delete ReturnBlock.getBlock();
Daniel Dunbarea3060a2009-07-19 08:24:34 +0000235 } else
John McCallad5d61e2010-07-23 21:56:41 +0000236 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000237 return llvm::DebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000238 }
239
240 // Otherwise, if the return block is the target of a single direct
241 // branch then we can just put the code in that block instead. This
242 // cleans up functions which started with a unified return block.
John McCallad5d61e2010-07-23 21:56:41 +0000243 if (ReturnBlock.getBlock()->hasOneUse()) {
Mike Stump11289f42009-09-09 15:08:12 +0000244 llvm::BranchInst *BI =
Chandler Carruth4d01fff2014-03-09 03:16:50 +0000245 dyn_cast<llvm::BranchInst>(*ReturnBlock.getBlock()->user_begin());
John McCallbd309292010-07-06 01:34:17 +0000246 if (BI && BI->isUnconditional() &&
John McCallad5d61e2010-07-23 21:56:41 +0000247 BI->getSuccessor(0) == ReturnBlock.getBlock()) {
David Blaikie66e41972015-01-14 07:38:27 +0000248 // Record/return the DebugLoc of the simple 'return' expression to be used
249 // later by the actual 'ret' instruction.
250 llvm::DebugLoc Loc = BI->getDebugLoc();
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000251 Builder.SetInsertPoint(BI->getParent());
252 BI->eraseFromParent();
John McCallad5d61e2010-07-23 21:56:41 +0000253 delete ReturnBlock.getBlock();
David Blaikie66e41972015-01-14 07:38:27 +0000254 return Loc;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000255 }
256 }
257
Mike Stump18bb9282009-05-16 07:57:57 +0000258 // FIXME: We are at an unreachable point, there is no reason to emit the block
259 // unless it has uses. However, we still need a place to put the debug
260 // region.end for now.
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000261
John McCallad5d61e2010-07-23 21:56:41 +0000262 EmitBlock(ReturnBlock.getBlock());
David Blaikie66e41972015-01-14 07:38:27 +0000263 return llvm::DebugLoc();
John McCallbd309292010-07-06 01:34:17 +0000264}
265
266static void EmitIfUsed(CodeGenFunction &CGF, llvm::BasicBlock *BB) {
267 if (!BB) return;
268 if (!BB->use_empty())
269 return CGF.CurFn->getBasicBlockList().push_back(BB);
270 delete BB;
Daniel Dunbarfd346a32009-01-26 23:27:52 +0000271}
272
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000273void CodeGenFunction::FinishFunction(SourceLocation EndLoc) {
Chris Lattnere73e4322007-07-16 21:28:45 +0000274 assert(BreakContinueStack.empty() &&
275 "mismatched push/pop in break/continue stack!");
Mike Stump11289f42009-09-09 15:08:12 +0000276
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000277 bool OnlySimpleReturnStmts = NumSimpleReturnExprs > 0
Adrian Prantl524ba1f2013-07-25 00:23:42 +0000278 && NumSimpleReturnExprs == NumReturnExprs
279 && ReturnBlock.getBlock()->use_empty();
280 // Usually the return expression is evaluated before the cleanup
281 // code. If the function contains only a simple return statement,
282 // such as a constant, the location before the cleanup code becomes
283 // the last useful breakpoint in the function, because the simple
284 // return expression will be evaluated after the cleanup code. To be
285 // safe, set the debug location for cleanup code to the location of
286 // the return statement. Otherwise the cleanup code should be at the
287 // end of the function's lexical scope.
288 //
289 // If there are multiple branches to the return block, the branch
290 // instructions will get the location of the return statements and
291 // all will be fine.
Adrian Prantl3be10542013-05-02 17:30:20 +0000292 if (CGDebugInfo *DI = getDebugInfo()) {
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000293 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000294 DI->EmitLocation(Builder, LastStopPoint);
Adrian Prantl3be10542013-05-02 17:30:20 +0000295 else
Adrian Prantle83b1302014-01-07 22:05:52 +0000296 DI->EmitLocation(Builder, EndLoc);
Adrian Prantl3be10542013-05-02 17:30:20 +0000297 }
David Blaikie357aafb2013-02-01 19:09:49 +0000298
John McCall31168b02011-06-15 23:02:42 +0000299 // Pop any cleanups that might have been associated with the
300 // parameters. Do this in whatever block we're currently in; it's
301 // important to do this before we enter the return block or return
302 // edges will be *really* confused.
David Majnemerdc012fa2015-04-22 21:38:15 +0000303 bool HasCleanups = EHStack.stable_begin() != PrologueCleanupDepth;
304 bool HasOnlyLifetimeMarkers =
305 HasCleanups && EHStack.containsOnlyLifetimeMarkers(PrologueCleanupDepth);
306 bool EmitRetDbgLoc = !HasCleanups || HasOnlyLifetimeMarkers;
307 if (HasCleanups) {
Adrian Prantl3be10542013-05-02 17:30:20 +0000308 // Make sure the line table doesn't jump back into the body for
309 // the ret after it's been at EndLoc.
Adrian Prantl3be10542013-05-02 17:30:20 +0000310 if (CGDebugInfo *DI = getDebugInfo())
Adrian Prantl52bf3c42013-05-03 20:11:48 +0000311 if (OnlySimpleReturnStmts)
Adrian Prantle83b1302014-01-07 22:05:52 +0000312 DI->EmitLocation(Builder, EndLoc);
David Blaikie4d524432015-02-04 19:47:54 +0000313
314 PopCleanupBlocks(PrologueCleanupDepth);
Adrian Prantl3be10542013-05-02 17:30:20 +0000315 }
316
Mike Stump11289f42009-09-09 15:08:12 +0000317 // Emit function epilog (to return).
David Blaikie66e41972015-01-14 07:38:27 +0000318 llvm::DebugLoc Loc = EmitReturnBlock();
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000319
Daniel Dunbar468a8f82011-02-10 17:32:22 +0000320 if (ShouldInstrumentFunction())
321 EmitFunctionInstrumentation("__cyg_profile_func_exit");
Chris Lattner3c77a352010-06-22 00:03:40 +0000322
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000323 // Emit debug descriptor for function end.
David Blaikie66e41972015-01-14 07:38:27 +0000324 if (CGDebugInfo *DI = getDebugInfo())
Devang Patel0884a602010-07-22 22:29:16 +0000325 DI->EmitFunctionEnd(Builder);
Daniel Dunbarfab3f932008-11-11 20:59:54 +0000326
David Blaikie66e41972015-01-14 07:38:27 +0000327 // Reset the debug location to that of the simple 'return' expression, if any
328 // rather than that of the end of the function's scope '}'.
329 ApplyDebugLocation AL(*this, Loc);
Nick Lewycky2d84e842013-10-02 02:29:49 +0000330 EmitFunctionEpilog(*CurFnInfo, EmitRetDbgLoc, EndLoc);
Mike Stump1d849212009-12-07 23:38:24 +0000331 EmitEndEHSpec(CurCodeDecl);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000332
John McCallbd309292010-07-06 01:34:17 +0000333 assert(EHStack.empty() &&
334 "did not remove all scopes from cleanup stack!");
335
Chris Lattner6c4d2552009-10-28 23:59:40 +0000336 // If someone did an indirect goto, emit the indirect goto block at the end of
337 // the function.
338 if (IndirectBranch) {
339 EmitBlock(IndirectBranch->getParent());
340 Builder.ClearInsertionPoint();
341 }
Michael Ilseman686240a2012-12-04 00:29:55 +0000342
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000343 // If some of our locals escaped, insert a call to llvm.localescape in the
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000344 // entry block.
345 if (!EscapedLocals.empty()) {
346 // Invert the map from local to index into a simple vector. There should be
347 // no holes.
348 SmallVector<llvm::Value *, 4> EscapeArgs;
349 EscapeArgs.resize(EscapedLocals.size());
350 for (auto &Pair : EscapedLocals)
351 EscapeArgs[Pair.second] = Pair.first;
352 llvm::Function *FrameEscapeFn = llvm::Intrinsic::getDeclaration(
Reid Kleckner98cb8ba2015-07-07 22:26:07 +0000353 &CGM.getModule(), llvm::Intrinsic::localescape);
John McCall7f416cc2015-09-08 08:05:57 +0000354 CGBuilderTy(*this, AllocaInsertPt).CreateCall(FrameEscapeFn, EscapeArgs);
Reid Kleckner31a1bb02015-04-08 22:23:48 +0000355 }
356
Chris Lattnerc48023b2007-12-02 06:32:24 +0000357 // Remove the AllocaInsertPt instruction, which is just a convenience for us.
Chris Lattner2739d2b2009-03-31 22:17:44 +0000358 llvm::Instruction *Ptr = AllocaInsertPt;
Craig Topper8a13c412014-05-21 05:09:00 +0000359 AllocaInsertPt = nullptr;
Chris Lattner2739d2b2009-03-31 22:17:44 +0000360 Ptr->eraseFromParent();
Michael Ilseman686240a2012-12-04 00:29:55 +0000361
Chris Lattner6c4d2552009-10-28 23:59:40 +0000362 // If someone took the address of a label but never did an indirect goto, we
363 // made a zero entry PHI node, which is illegal, zap it now.
364 if (IndirectBranch) {
365 llvm::PHINode *PN = cast<llvm::PHINode>(IndirectBranch->getAddress());
366 if (PN->getNumIncomingValues() == 0) {
367 PN->replaceAllUsesWith(llvm::UndefValue::get(PN->getType()));
368 PN->eraseFromParent();
369 }
370 }
John McCallbd309292010-07-06 01:34:17 +0000371
John McCall8e4c74b2011-08-11 02:22:43 +0000372 EmitIfUsed(*this, EHResumeBlock);
John McCallbd309292010-07-06 01:34:17 +0000373 EmitIfUsed(*this, TerminateLandingPad);
374 EmitIfUsed(*this, TerminateHandler);
375 EmitIfUsed(*this, UnreachableBlock);
John McCall09ae0322010-07-06 23:57:41 +0000376
377 if (CGM.getCodeGenOpts().EmitDeclMetadata)
378 EmitDeclMetadata();
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000379
380 for (SmallVectorImpl<std::pair<llvm::Instruction *, llvm::Value *> >::iterator
381 I = DeferredReplacements.begin(),
382 E = DeferredReplacements.end();
383 I != E; ++I) {
384 I->first->replaceAllUsesWith(I->second);
385 I->first->eraseFromParent();
386 }
Chris Lattnerd1af2d22007-05-29 23:17:50 +0000387}
Chris Lattner308f4312007-05-29 23:50:05 +0000388
Chris Lattner3c77a352010-06-22 00:03:40 +0000389/// ShouldInstrumentFunction - Return true if the current function should be
390/// instrumented with __cyg_profile_func_* calls
391bool CodeGenFunction::ShouldInstrumentFunction() {
392 if (!CGM.getCodeGenOpts().InstrumentFunctions)
393 return false;
Ted Kremenekc249c412011-05-16 23:49:20 +0000394 if (!CurFuncDecl || CurFuncDecl->hasAttr<NoInstrumentFunctionAttr>())
Chris Lattner3c77a352010-06-22 00:03:40 +0000395 return false;
396 return true;
397}
398
399/// EmitFunctionInstrumentation - Emit LLVM code to call the specified
400/// instrumentation function with the current function and the call site, if
401/// function instrumentation is enabled.
402void CodeGenFunction::EmitFunctionInstrumentation(const char *Fn) {
Chris Lattnerb48a2d52010-06-23 05:21:28 +0000403 // void __cyg_profile_func_{enter,exit} (void *this_fn, void *call_site);
Chris Lattnera5f58b02011-07-09 17:41:47 +0000404 llvm::PointerType *PointerTy = Int8PtrTy;
405 llvm::Type *ProfileFuncArgs[] = { PointerTy, PointerTy };
Chris Lattner2192fe52011-07-18 04:24:23 +0000406 llvm::FunctionType *FunctionTy =
Chris Lattnerece04092012-02-07 00:39:47 +0000407 llvm::FunctionType::get(VoidTy, ProfileFuncArgs, false);
Chris Lattner3c77a352010-06-22 00:03:40 +0000408
409 llvm::Constant *F = CGM.CreateRuntimeFunction(FunctionTy, Fn);
410 llvm::CallInst *CallSite = Builder.CreateCall(
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000411 CGM.getIntrinsic(llvm::Intrinsic::returnaddress),
Chris Lattner5e016ae2010-06-27 07:15:29 +0000412 llvm::ConstantInt::get(Int32Ty, 0),
Chris Lattner3c77a352010-06-22 00:03:40 +0000413 "callsite");
414
John McCall882987f2013-02-28 19:01:20 +0000415 llvm::Value *args[] = {
416 llvm::ConstantExpr::getBitCast(CurFn, PointerTy),
417 CallSite
418 };
419
420 EmitNounwindRuntimeCall(F, args);
Chris Lattner3c77a352010-06-22 00:03:40 +0000421}
422
Roman Divacky178e01602011-02-10 16:52:03 +0000423void CodeGenFunction::EmitMCountInstrumentation() {
Chris Lattnerece04092012-02-07 00:39:47 +0000424 llvm::FunctionType *FTy = llvm::FunctionType::get(VoidTy, false);
Roman Divacky178e01602011-02-10 16:52:03 +0000425
John McCallc8e01702013-04-16 22:48:15 +0000426 llvm::Constant *MCountFn =
427 CGM.CreateRuntimeFunction(FTy, getTarget().getMCountName());
John McCall882987f2013-02-28 19:01:20 +0000428 EmitNounwindRuntimeCall(MCountFn);
Roman Divacky178e01602011-02-10 16:52:03 +0000429}
430
Tanya Lattner7445ada2012-07-11 23:02:10 +0000431// OpenCL v1.2 s5.6.4.6 allows the compiler to store kernel argument
432// information in the program executable. The argument information stored
433// includes the argument name, its type, the address and access qualifiers used.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000434static void GenOpenCLArgMetadata(const FunctionDecl *FD, llvm::Function *Fn,
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000435 CodeGenModule &CGM, llvm::LLVMContext &Context,
436 SmallVector<llvm::Metadata *, 5> &kernelMDArgs,
437 CGBuilderTy &Builder, ASTContext &ASTCtx) {
Guy Benyeifb36ede2013-03-24 13:58:12 +0000438 // Create MDNodes that represent the kernel arg metadata.
Tanya Lattner7445ada2012-07-11 23:02:10 +0000439 // Each MDNode is a list in the form of "key", N number of values which is
440 // the same number of values as their are kernel arguments.
Michael Ilseman686240a2012-12-04 00:29:55 +0000441
Joey Gouly92a47442014-04-04 13:43:57 +0000442 const PrintingPolicy &Policy = ASTCtx.getPrintingPolicy();
443
Guy Benyeifb36ede2013-03-24 13:58:12 +0000444 // MDNode for the kernel argument address space qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000445 SmallVector<llvm::Metadata *, 8> addressQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000446 addressQuals.push_back(llvm::MDString::get(Context, "kernel_arg_addr_space"));
447
448 // MDNode for the kernel argument access qualifiers (images only).
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000449 SmallVector<llvm::Metadata *, 8> accessQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000450 accessQuals.push_back(llvm::MDString::get(Context, "kernel_arg_access_qual"));
451
452 // MDNode for the kernel argument type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000453 SmallVector<llvm::Metadata *, 8> argTypeNames;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000454 argTypeNames.push_back(llvm::MDString::get(Context, "kernel_arg_type"));
455
Fraser Cormackdadc3712014-07-30 14:39:53 +0000456 // MDNode for the kernel argument base type names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000457 SmallVector<llvm::Metadata *, 8> argBaseTypeNames;
Fraser Cormackdadc3712014-07-30 14:39:53 +0000458 argBaseTypeNames.push_back(
459 llvm::MDString::get(Context, "kernel_arg_base_type"));
460
Guy Benyeifb36ede2013-03-24 13:58:12 +0000461 // MDNode for the kernel argument type qualifiers.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000462 SmallVector<llvm::Metadata *, 8> argTypeQuals;
Guy Benyeifb36ede2013-03-24 13:58:12 +0000463 argTypeQuals.push_back(llvm::MDString::get(Context, "kernel_arg_type_qual"));
464
Tanya Lattner7445ada2012-07-11 23:02:10 +0000465 // MDNode for the kernel argument names.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000466 SmallVector<llvm::Metadata *, 8> argNames;
Tanya Lattner7445ada2012-07-11 23:02:10 +0000467 argNames.push_back(llvm::MDString::get(Context, "kernel_arg_name"));
Michael Ilseman686240a2012-12-04 00:29:55 +0000468
Tanya Lattner7445ada2012-07-11 23:02:10 +0000469 for (unsigned i = 0, e = FD->getNumParams(); i != e; ++i) {
470 const ParmVarDecl *parm = FD->getParamDecl(i);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000471 QualType ty = parm->getType();
472 std::string typeQuals;
473
474 if (ty->isPointerType()) {
475 QualType pointeeTy = ty->getPointeeType();
476
477 // Get address qualifier.
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000478 addressQuals.push_back(llvm::ConstantAsMetadata::get(Builder.getInt32(
479 ASTCtx.getTargetAddressSpace(pointeeTy.getAddressSpace()))));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000480
481 // Get argument type name.
Joey Gouly92a47442014-04-04 13:43:57 +0000482 std::string typeName =
483 pointeeTy.getUnqualifiedType().getAsString(Policy) + "*";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000484
485 // Turn "unsigned type" to "utype"
486 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000487 if (pointeeTy.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000488 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000489
490 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
491
Fraser Cormackdadc3712014-07-30 14:39:53 +0000492 std::string baseTypeName =
493 pointeeTy.getUnqualifiedType().getCanonicalType().getAsString(
494 Policy) +
495 "*";
496
497 // Turn "unsigned type" to "utype"
498 pos = baseTypeName.find("unsigned");
499 if (pos != std::string::npos)
500 baseTypeName.erase(pos+1, 8);
501
502 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName));
503
Guy Benyeifb36ede2013-03-24 13:58:12 +0000504 // Get argument type qualifiers:
505 if (ty.isRestrictQualified())
506 typeQuals = "restrict";
507 if (pointeeTy.isConstQualified() ||
508 (pointeeTy.getAddressSpace() == LangAS::opencl_constant))
Benjamin Krameref89ae02013-03-24 16:04:55 +0000509 typeQuals += typeQuals.empty() ? "const" : " const";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000510 if (pointeeTy.isVolatileQualified())
Benjamin Krameref89ae02013-03-24 16:04:55 +0000511 typeQuals += typeQuals.empty() ? "volatile" : " volatile";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000512 } else {
Pekka Jaaskelainen3587b322014-01-09 13:37:30 +0000513 uint32_t AddrSpc = 0;
514 if (ty->isImageType())
515 AddrSpc =
516 CGM.getContext().getTargetAddressSpace(LangAS::opencl_global);
Bob Wilson95a27b02014-02-17 19:20:59 +0000517
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000518 addressQuals.push_back(
519 llvm::ConstantAsMetadata::get(Builder.getInt32(AddrSpc)));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000520
521 // Get argument type name.
Joey Gouly92a47442014-04-04 13:43:57 +0000522 std::string typeName = ty.getUnqualifiedType().getAsString(Policy);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000523
524 // Turn "unsigned type" to "utype"
525 std::string::size_type pos = typeName.find("unsigned");
Fraser Cormack152493b2014-07-30 13:41:12 +0000526 if (ty.isCanonical() && pos != std::string::npos)
Benjamin Krameref89ae02013-03-24 16:04:55 +0000527 typeName.erase(pos+1, 8);
Guy Benyeifb36ede2013-03-24 13:58:12 +0000528
529 argTypeNames.push_back(llvm::MDString::get(Context, typeName));
530
Fraser Cormackdadc3712014-07-30 14:39:53 +0000531 std::string baseTypeName =
532 ty.getUnqualifiedType().getCanonicalType().getAsString(Policy);
533
534 // Turn "unsigned type" to "utype"
535 pos = baseTypeName.find("unsigned");
536 if (pos != std::string::npos)
537 baseTypeName.erase(pos+1, 8);
538
539 argBaseTypeNames.push_back(llvm::MDString::get(Context, baseTypeName));
540
Guy Benyeifb36ede2013-03-24 13:58:12 +0000541 // Get argument type qualifiers:
542 if (ty.isConstQualified())
543 typeQuals = "const";
544 if (ty.isVolatileQualified())
Benjamin Krameref89ae02013-03-24 16:04:55 +0000545 typeQuals += typeQuals.empty() ? "volatile" : " volatile";
Guy Benyeifb36ede2013-03-24 13:58:12 +0000546 }
Justin Bogner0f066062013-11-22 10:20:40 +0000547
Guy Benyeifb36ede2013-03-24 13:58:12 +0000548 argTypeQuals.push_back(llvm::MDString::get(Context, typeQuals));
549
550 // Get image access qualifier:
551 if (ty->isImageType()) {
Aaron Ballmanc4327992013-12-19 03:09:10 +0000552 const OpenCLImageAccessAttr *A = parm->getAttr<OpenCLImageAccessAttr>();
Aaron Ballman26891332014-01-14 17:41:53 +0000553 if (A && A->isWriteOnly())
Guy Benyeifb36ede2013-03-24 13:58:12 +0000554 accessQuals.push_back(llvm::MDString::get(Context, "write_only"));
555 else
556 accessQuals.push_back(llvm::MDString::get(Context, "read_only"));
Aaron Ballman26891332014-01-14 17:41:53 +0000557 // FIXME: what about read_write?
Guy Benyeifb36ede2013-03-24 13:58:12 +0000558 } else
559 accessQuals.push_back(llvm::MDString::get(Context, "none"));
Michael Ilseman686240a2012-12-04 00:29:55 +0000560
Tanya Lattner7445ada2012-07-11 23:02:10 +0000561 // Get argument name.
562 argNames.push_back(llvm::MDString::get(Context, parm->getName()));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000563 }
Guy Benyeifb36ede2013-03-24 13:58:12 +0000564
565 kernelMDArgs.push_back(llvm::MDNode::get(Context, addressQuals));
566 kernelMDArgs.push_back(llvm::MDNode::get(Context, accessQuals));
567 kernelMDArgs.push_back(llvm::MDNode::get(Context, argTypeNames));
Fraser Cormackdadc3712014-07-30 14:39:53 +0000568 kernelMDArgs.push_back(llvm::MDNode::get(Context, argBaseTypeNames));
Guy Benyeifb36ede2013-03-24 13:58:12 +0000569 kernelMDArgs.push_back(llvm::MDNode::get(Context, argTypeQuals));
Sameer Sahasrabuddhec6093fe2014-12-04 05:30:58 +0000570 if (CGM.getCodeGenOpts().EmitOpenCLArgMetadata)
571 kernelMDArgs.push_back(llvm::MDNode::get(Context, argNames));
Tanya Lattner7445ada2012-07-11 23:02:10 +0000572}
573
Michael Ilseman686240a2012-12-04 00:29:55 +0000574void CodeGenFunction::EmitOpenCLKernelMetadata(const FunctionDecl *FD,
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000575 llvm::Function *Fn)
576{
577 if (!FD->hasAttr<OpenCLKernelAttr>())
578 return;
579
580 llvm::LLVMContext &Context = getLLVMContext();
581
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000582 SmallVector<llvm::Metadata *, 5> kernelMDArgs;
583 kernelMDArgs.push_back(llvm::ConstantAsMetadata::get(Fn));
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000584
Sameer Sahasrabuddhec6093fe2014-12-04 05:30:58 +0000585 GenOpenCLArgMetadata(FD, Fn, CGM, Context, kernelMDArgs, Builder,
586 getContext());
Michael Ilseman686240a2012-12-04 00:29:55 +0000587
Aaron Ballmanc4327992013-12-19 03:09:10 +0000588 if (const VecTypeHintAttr *A = FD->getAttr<VecTypeHintAttr>()) {
589 QualType hintQTy = A->getTypeHint();
Joey Goulyaba589c2013-03-08 09:42:32 +0000590 const ExtVectorType *hintEltQTy = hintQTy->getAs<ExtVectorType>();
591 bool isSignedInteger =
592 hintQTy->isSignedIntegerType() ||
593 (hintEltQTy && hintEltQTy->getElementType()->isSignedIntegerType());
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000594 llvm::Metadata *attrMDArgs[] = {
595 llvm::MDString::get(Context, "vec_type_hint"),
596 llvm::ConstantAsMetadata::get(llvm::UndefValue::get(
597 CGM.getTypes().ConvertType(A->getTypeHint()))),
598 llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
599 llvm::IntegerType::get(Context, 32),
600 llvm::APInt(32, (uint64_t)(isSignedInteger ? 1 : 0))))};
Joey Goulyaba589c2013-03-08 09:42:32 +0000601 kernelMDArgs.push_back(llvm::MDNode::get(Context, attrMDArgs));
602 }
603
Aaron Ballmanc4327992013-12-19 03:09:10 +0000604 if (const WorkGroupSizeHintAttr *A = FD->getAttr<WorkGroupSizeHintAttr>()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000605 llvm::Metadata *attrMDArgs[] = {
606 llvm::MDString::get(Context, "work_group_size_hint"),
607 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
608 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
609 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000610 kernelMDArgs.push_back(llvm::MDNode::get(Context, attrMDArgs));
611 }
612
Aaron Ballmanc4327992013-12-19 03:09:10 +0000613 if (const ReqdWorkGroupSizeAttr *A = FD->getAttr<ReqdWorkGroupSizeAttr>()) {
Duncan P. N. Exon Smithfb494912014-12-09 18:39:32 +0000614 llvm::Metadata *attrMDArgs[] = {
615 llvm::MDString::get(Context, "reqd_work_group_size"),
616 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getXDim())),
617 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getYDim())),
618 llvm::ConstantAsMetadata::get(Builder.getInt32(A->getZDim()))};
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000619 kernelMDArgs.push_back(llvm::MDNode::get(Context, attrMDArgs));
620 }
621
622 llvm::MDNode *kernelMDNode = llvm::MDNode::get(Context, kernelMDArgs);
623 llvm::NamedMDNode *OpenCLKernelMetadata =
624 CGM.getModule().getOrInsertNamedMetadata("opencl.kernels");
625 OpenCLKernelMetadata->addOperand(kernelMDNode);
626}
627
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000628/// Determine whether the function F ends with a return stmt.
629static bool endsWithReturn(const Decl* F) {
630 const Stmt *Body = nullptr;
631 if (auto *FD = dyn_cast_or_null<FunctionDecl>(F))
632 Body = FD->getBody();
633 else if (auto *OMD = dyn_cast_or_null<ObjCMethodDecl>(F))
634 Body = OMD->getBody();
635
636 if (auto *CS = dyn_cast_or_null<CompoundStmt>(Body)) {
637 auto LastStmt = CS->body_rbegin();
638 if (LastStmt != CS->body_rend())
639 return isa<ReturnStmt>(*LastStmt);
640 }
641 return false;
642}
643
John McCalldec348f72013-05-03 07:33:41 +0000644void CodeGenFunction::StartFunction(GlobalDecl GD,
645 QualType RetTy,
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000646 llvm::Function *Fn,
John McCalla738c252011-03-09 04:27:21 +0000647 const CGFunctionInfo &FnInfo,
Daniel Dunbar354d2782008-10-18 18:22:23 +0000648 const FunctionArgList &Args,
Adrian Prantl42d71b92014-04-10 23:21:53 +0000649 SourceLocation Loc,
Tilmann Scheller99cc30c2011-03-02 21:36:49 +0000650 SourceLocation StartLoc) {
David Blaikie8e6c36e2014-10-14 16:43:46 +0000651 assert(!CurFn &&
652 "Do not use a CodeGenFunction object for more than one function");
653
Anders Carlsson73fcc952009-09-11 00:07:24 +0000654 const Decl *D = GD.getDecl();
Michael Ilseman686240a2012-12-04 00:29:55 +0000655
Anders Carlssonf4478e92009-02-09 20:20:56 +0000656 DidCallStackSave = false;
John McCalldec348f72013-05-03 07:33:41 +0000657 CurCodeDecl = D;
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
Alexey Samsonov1444bb92014-10-17 00:20:19 +0000664 if (CGM.isInSanitizerBlacklist(Fn, Loc))
Alexey Samsonov035462c2014-10-30 19:33:44 +0000665 SanOpts.clear();
Will Dietzf54319c2013-01-18 11:30:38 +0000666
Peter Collingbourne915df992015-05-15 18:33:32 +0000667 if (D) {
668 // Apply the no_sanitize* attributes to SanOpts.
669 for (auto Attr : D->specific_attrs<NoSanitizeAttr>())
670 SanOpts.Mask &= ~Attr->getMask();
671 }
672
673 // Apply sanitizer attributes to the function.
Alexander Potapenkob9b73ef2015-06-19 12:19:07 +0000674 if (SanOpts.hasOneOf(SanitizerKind::Address | SanitizerKind::KernelAddress))
Peter Collingbourne915df992015-05-15 18:33:32 +0000675 Fn->addFnAttr(llvm::Attribute::SanitizeAddress);
676 if (SanOpts.has(SanitizerKind::Thread))
677 Fn->addFnAttr(llvm::Attribute::SanitizeThread);
678 if (SanOpts.has(SanitizerKind::Memory))
679 Fn->addFnAttr(llvm::Attribute::SanitizeMemory);
Peter Collingbournec4122c12015-06-15 21:08:13 +0000680 if (SanOpts.has(SanitizerKind::SafeStack))
681 Fn->addFnAttr(llvm::Attribute::SafeStack);
Peter Collingbourne915df992015-05-15 18:33:32 +0000682
Jakob Stoklund Olesen819e54b2010-02-09 00:10:00 +0000683 // Pass inline keyword to optimizer if it appears explicitly on any
Roman Divackydd9bfb22014-01-15 19:07:16 +0000684 // declaration. Also, in the case of -fno-inline attach NoInline
David Majnemer19d7d542014-02-25 10:51:14 +0000685 // attribute to all function that are not marked AlwaysInline.
Roman Divackydd9bfb22014-01-15 19:07:16 +0000686 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
687 if (!CGM.getCodeGenOpts().NoInline) {
Aaron Ballman86c93902014-03-06 23:45:36 +0000688 for (auto RI : FD->redecls())
Chad Rosier883b2572012-03-14 23:32:11 +0000689 if (RI->isInlineSpecified()) {
Bill Wendling207f0532012-12-20 19:27:06 +0000690 Fn->addFnAttr(llvm::Attribute::InlineHint);
Chad Rosier883b2572012-03-14 23:32:11 +0000691 break;
692 }
David Majnemer67e541e1c2014-02-25 09:53:29 +0000693 } else if (!FD->hasAttr<AlwaysInlineAttr>())
Roman Divackydd9bfb22014-01-15 19:07:16 +0000694 Fn->addFnAttr(llvm::Attribute::NoInline);
695 }
Jakob Stoklund Olesen819e54b2010-02-09 00:10:00 +0000696
Richard Smith9c6890a2012-11-01 22:30:59 +0000697 if (getLangOpts().OpenCL) {
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000698 // Add metadata for a kernel function.
699 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
Tanya Lattnerbcffcdf2012-07-09 22:06:01 +0000700 EmitOpenCLKernelMetadata(FD, Fn);
Peter Collingbourne7ce13fc2011-02-14 01:42:53 +0000701 }
702
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000703 // If we are checking function types, emit a function type signature as
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000704 // prologue data.
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000705 if (getLangOpts().CPlusPlus && SanOpts.has(SanitizerKind::Function)) {
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000706 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D)) {
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000707 if (llvm::Constant *PrologueSig =
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000708 CGM.getTargetCodeGenInfo().getUBSanFunctionSignature(CGM)) {
709 llvm::Constant *FTRTTIConst =
710 CGM.GetAddrOfRTTIDescriptor(FD->getType(), /*ForEH=*/true);
Peter Collingbourne1a0a9a32014-12-03 02:08:51 +0000711 llvm::Constant *PrologueStructElems[] = { PrologueSig, FTRTTIConst };
712 llvm::Constant *PrologueStructConst =
713 llvm::ConstantStruct::getAnon(PrologueStructElems, /*Packed=*/true);
714 Fn->setPrologueData(PrologueStructConst);
Peter Collingbourneb453cd62013-10-20 21:29:19 +0000715 }
716 }
717 }
718
James Molloyc16a60b62015-11-12 15:36:04 +0000719 // If we're in C++ mode and the function name is "main", it is guaranteed
720 // to be norecurse by the standard (3.6.1.3 "The function main shall not be
721 // used within a program").
722 if (getLangOpts().CPlusPlus)
723 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(D))
724 if (FD->isMain())
725 Fn->addFnAttr(llvm::Attribute::NoRecurse);
726
Daniel Dunbar75283ff2008-11-11 02:29:29 +0000727 llvm::BasicBlock *EntryBB = createBasicBlock("entry", CurFn);
Daniel Dunbar54bb1932008-09-09 21:00:17 +0000728
Chris Lattner5696e7b2008-06-17 18:05:57 +0000729 // Create a marker to make it easy to insert allocas into the entryblock
730 // later. Don't create this with the builder, because we don't want it
731 // folded.
Chris Lattner5e016ae2010-06-27 07:15:29 +0000732 llvm::Value *Undef = llvm::UndefValue::get(Int32Ty);
733 AllocaInsertPt = new llvm::BitCastInst(Undef, Int32Ty, "", EntryBB);
Chris Lattner47640222009-03-22 00:24:14 +0000734 if (Builder.isNamePreserving())
735 AllocaInsertPt->setName("allocapt");
Mike Stump11289f42009-09-09 15:08:12 +0000736
John McCallbd309292010-07-06 01:34:17 +0000737 ReturnBlock = getJumpDestInCurrentScope("return");
Mike Stump11289f42009-09-09 15:08:12 +0000738
Chris Lattner5696e7b2008-06-17 18:05:57 +0000739 Builder.SetInsertPoint(EntryBB);
Mike Stump11289f42009-09-09 15:08:12 +0000740
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000741 // Emit subprogram debug descriptor.
Anders Carlsson63784f42009-02-13 08:11:52 +0000742 if (CGDebugInfo *DI = getDebugInfo()) {
Jordan Rose5c382722013-03-08 21:51:21 +0000743 SmallVector<QualType, 16> ArgTypes;
Eric Christopher4b4beb22011-10-21 23:30:10 +0000744 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
745 i != e; ++i) {
Jordan Rose5c382722013-03-08 21:51:21 +0000746 ArgTypes.push_back((*i)->getType());
Eric Christopher4b4beb22011-10-21 23:30:10 +0000747 }
748
John McCalldb40c7f2010-12-14 08:05:40 +0000749 QualType FnType =
Jordan Rose5c382722013-03-08 21:51:21 +0000750 getContext().getFunctionType(RetTy, ArgTypes,
John McCalldb40c7f2010-12-14 08:05:40 +0000751 FunctionProtoType::ExtProtoInfo());
Adrian Prantl42d71b92014-04-10 23:21:53 +0000752 DI->EmitFunctionStart(GD, Loc, StartLoc, FnType, CurFn, Builder);
Sanjiv Gupta1e8b6082008-07-04 11:04:26 +0000753 }
754
Daniel Dunbar468a8f82011-02-10 17:32:22 +0000755 if (ShouldInstrumentFunction())
756 EmitFunctionInstrumentation("__cyg_profile_func_enter");
Chris Lattner3c77a352010-06-22 00:03:40 +0000757
Roman Divacky178e01602011-02-10 16:52:03 +0000758 if (CGM.getCodeGenOpts().InstrumentForProfiling)
759 EmitMCountInstrumentation();
760
Eli Friedman4b1942c2009-12-04 02:43:40 +0000761 if (RetTy->isVoidType()) {
762 // Void type; nothing to return.
John McCall7f416cc2015-09-08 08:05:57 +0000763 ReturnValue = Address::invalid();
Adrian Prantl2cede0f2014-04-29 01:07:59 +0000764
765 // Count the implicit return.
766 if (!endsWithReturn(D))
767 ++NumReturnExprs;
Eli Friedman4b1942c2009-12-04 02:43:40 +0000768 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect &&
John McCall47fb9502013-03-07 21:37:08 +0000769 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
Eli Friedman4b1942c2009-12-04 02:43:40 +0000770 // Indirect aggregate return; emit returned value directly into sret slot.
Daniel Dunbarfd09df72010-02-16 19:45:20 +0000771 // This reduces code size, and affects correctness in C++.
Reid Kleckner37abaca2014-05-09 22:46:15 +0000772 auto AI = CurFn->arg_begin();
773 if (CurFnInfo->getReturnInfo().isSRetAfterThis())
774 ++AI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +0000775 ReturnValue = Address(&*AI, CurFnInfo->getReturnInfo().getIndirectAlign());
Reid Kleckner314ef7b2014-02-01 00:04:45 +0000776 } else if (CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::InAlloca &&
777 !hasScalarEvaluationKind(CurFnInfo->getReturnType())) {
778 // Load the sret pointer from the argument struct and return into that.
779 unsigned Idx = CurFnInfo->getReturnInfo().getInAllocaFieldIndex();
780 llvm::Function::arg_iterator EI = CurFn->arg_end();
781 --EI;
Duncan P. N. Exon Smith9f5260a2015-11-06 23:00:41 +0000782 llvm::Value *Addr = Builder.CreateStructGEP(nullptr, &*EI, Idx);
John McCall7f416cc2015-09-08 08:05:57 +0000783 Addr = Builder.CreateAlignedLoad(Addr, getPointerAlign(), "agg.result");
784 ReturnValue = Address(Addr, getNaturalTypeAlignment(RetTy));
Eli Friedman4b1942c2009-12-04 02:43:40 +0000785 } else {
Daniel Dunbarfd09df72010-02-16 19:45:20 +0000786 ReturnValue = CreateIRTemp(RetTy, "retval");
John McCall31168b02011-06-15 23:02:42 +0000787
788 // Tell the epilog emitter to autorelease the result. We do this
789 // now so that various specialized functions can suppress it
790 // during their IR-generation.
David Blaikiebbafb8a2012-03-11 07:00:24 +0000791 if (getLangOpts().ObjCAutoRefCount &&
John McCall31168b02011-06-15 23:02:42 +0000792 !CurFnInfo->isReturnsRetained() &&
793 RetTy->isObjCRetainableType())
794 AutoreleaseResult = true;
Eli Friedman4b1942c2009-12-04 02:43:40 +0000795 }
796
Mike Stump1d849212009-12-07 23:38:24 +0000797 EmitStartEHSpec(CurCodeDecl);
John McCall31168b02011-06-15 23:02:42 +0000798
799 PrologueCleanupDepth = EHStack.stable_begin();
Daniel Dunbard931a872009-02-02 22:03:45 +0000800 EmitFunctionProlog(*CurFnInfo, CurFn, Args);
Mike Stump11289f42009-09-09 15:08:12 +0000801
Eli Friedman9fbeba02012-02-11 02:57:39 +0000802 if (D && isa<CXXMethodDecl>(D) && cast<CXXMethodDecl>(D)->isInstance()) {
John McCall5d865c322010-08-31 07:33:07 +0000803 CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
Eli Friedman9fbeba02012-02-11 02:57:39 +0000804 const CXXMethodDecl *MD = cast<CXXMethodDecl>(D);
805 if (MD->getParent()->isLambda() &&
806 MD->getOverloadedOperator() == OO_Call) {
807 // We're in a lambda; figure out the captures.
808 MD->getParent()->getCaptureFields(LambdaCaptureFields,
809 LambdaThisCaptureField);
810 if (LambdaThisCaptureField) {
811 // If this lambda captures this, load it.
John McCalldec348f72013-05-03 07:33:41 +0000812 LValue ThisLValue = EmitLValueForLambdaField(LambdaThisCaptureField);
Nick Lewycky2d84e842013-10-02 02:29:49 +0000813 CXXThisValue = EmitLoadOfLValue(ThisLValue,
814 SourceLocation()).getScalarVal();
Eli Friedman9fbeba02012-02-11 02:57:39 +0000815 }
Alexey Bataev39c81e22014-08-28 04:28:19 +0000816 for (auto *FD : MD->getParent()->fields()) {
817 if (FD->hasCapturedVLAType()) {
818 auto *ExprArg = EmitLoadOfLValue(EmitLValueForLambdaField(FD),
819 SourceLocation()).getScalarVal();
820 auto VAT = FD->getCapturedVLAType();
821 VLASizeMap[VAT->getSizeExpr()] = ExprArg;
822 }
823 }
Eli Friedman9fbeba02012-02-11 02:57:39 +0000824 } else {
825 // Not in a lambda; just use 'this' from the method.
826 // FIXME: Should we generate a new load for each use of 'this'? The
827 // fast register allocator would be happier...
828 CXXThisValue = CXXABIThisValue;
829 }
830 }
John McCall347132b2010-02-16 22:04:33 +0000831
Anders Carlssonc20879a2008-12-20 21:28:43 +0000832 // If any of the arguments have a variably modified type, make sure to
833 // emit the type size.
834 for (FunctionArgList::const_iterator i = Args.begin(), e = Args.end();
835 i != e; ++i) {
Eli Friedman1f576832012-11-14 22:09:59 +0000836 const VarDecl *VD = *i;
837
838 // Dig out the type as written from ParmVarDecls; it's unclear whether
839 // the standard (C99 6.9.1p10) requires this, but we're following the
840 // precedent set by gcc.
841 QualType Ty;
842 if (const ParmVarDecl *PVD = dyn_cast<ParmVarDecl>(VD))
843 Ty = PVD->getOriginalType();
844 else
845 Ty = VD->getType();
Anders Carlssonc20879a2008-12-20 21:28:43 +0000846
847 if (Ty->isVariablyModifiedType())
John McCall23c29fe2011-06-24 21:55:10 +0000848 EmitVariablyModifiedType(Ty);
Anders Carlssonc20879a2008-12-20 21:28:43 +0000849 }
Eric Christopher7cdf9482011-10-13 21:45:18 +0000850 // Emit a location at the end of the prologue.
851 if (CGDebugInfo *DI = getDebugInfo())
852 DI->EmitLocation(Builder, StartLoc);
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000853}
Eli Friedman3d421e12008-08-25 21:31:01 +0000854
Richard Smithb47c36f2013-11-05 09:12:18 +0000855void CodeGenFunction::EmitFunctionBody(FunctionArgList &Args,
856 const Stmt *Body) {
Justin Bogner66242d62015-04-23 23:06:47 +0000857 incrementProfileCounter(Body);
Richard Smithb47c36f2013-11-05 09:12:18 +0000858 if (const CompoundStmt *S = dyn_cast<CompoundStmt>(Body))
David Blaikie0a21d0d2013-01-26 22:16:26 +0000859 EmitCompoundStmtWithoutScope(*S);
860 else
Richard Smithb47c36f2013-11-05 09:12:18 +0000861 EmitStmt(Body);
John McCall89b12b32010-02-18 03:17:58 +0000862}
863
Bob Wilsonbf854f02014-02-17 19:21:09 +0000864/// When instrumenting to collect profile data, the counts for some blocks
865/// such as switch cases need to not include the fall-through counts, so
866/// emit a branch around the instrumentation code. When not instrumenting,
867/// this just calls EmitBlock().
868void CodeGenFunction::EmitBlockWithFallThrough(llvm::BasicBlock *BB,
Justin Bogner66242d62015-04-23 23:06:47 +0000869 const Stmt *S) {
Craig Topper8a13c412014-05-21 05:09:00 +0000870 llvm::BasicBlock *SkipCountBB = nullptr;
Bob Wilsonbf854f02014-02-17 19:21:09 +0000871 if (HaveInsertPoint() && CGM.getCodeGenOpts().ProfileInstrGenerate) {
872 // When instrumenting for profiling, the fallthrough to certain
873 // statements needs to skip over the instrumentation code so that we
874 // get an accurate count.
875 SkipCountBB = createBasicBlock("skipcount");
876 EmitBranch(SkipCountBB);
877 }
878 EmitBlock(BB);
Justin Bogner66242d62015-04-23 23:06:47 +0000879 uint64_t CurrentCount = getCurrentProfileCount();
880 incrementProfileCounter(S);
881 setCurrentProfileCount(getCurrentProfileCount() + CurrentCount);
Bob Wilsonbf854f02014-02-17 19:21:09 +0000882 if (SkipCountBB)
883 EmitBlock(SkipCountBB);
884}
885
John McCall8601a752010-08-03 22:46:07 +0000886/// Tries to mark the given function nounwind based on the
887/// non-existence of any throwing calls within it. We believe this is
888/// lightweight enough to do at -O0.
889static void TryMarkNoThrow(llvm::Function *F) {
John McCall59966992010-08-11 22:38:33 +0000890 // LLVM treats 'nounwind' on a function as part of the type, so we
891 // can't do this on functions that can be overwritten.
892 if (F->mayBeOverridden()) return;
893
David Majnemerdbf10452015-07-31 17:58:45 +0000894 for (llvm::BasicBlock &BB : *F)
895 for (llvm::Instruction &I : BB)
896 if (I.mayThrow())
Bill Wendlingf0724e82011-09-19 20:31:14 +0000897 return;
David Majnemerdbf10452015-07-31 17:58:45 +0000898
Bill Wendling73e465e2012-10-10 03:13:20 +0000899 F->setDoesNotThrow();
John McCall8601a752010-08-03 22:46:07 +0000900}
901
John McCalla738c252011-03-09 04:27:21 +0000902void CodeGenFunction::GenerateCode(GlobalDecl GD, llvm::Function *Fn,
903 const CGFunctionInfo &FnInfo) {
Anders Carlsson73fcc952009-09-11 00:07:24 +0000904 const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
Michael Ilseman686240a2012-12-04 00:29:55 +0000905
Anders Carlsson63784f42009-02-13 08:11:52 +0000906 // Check if we should generate debug info for this function.
David Blaikie92848de2013-08-26 20:33:21 +0000907 if (FD->hasAttr<NoDebugAttr>())
Craig Topper8a13c412014-05-21 05:09:00 +0000908 DebugInfo = nullptr; // disable debug info indefinitely for this function
Mike Stump11289f42009-09-09 15:08:12 +0000909
Daniel Dunbarbc915f42008-09-09 23:14:03 +0000910 FunctionArgList Args;
Alp Toker314cc812014-01-25 16:55:45 +0000911 QualType ResTy = FD->getReturnType();
Mike Stump11289f42009-09-09 15:08:12 +0000912
Mike Stumpbee78dd2009-12-04 23:26:17 +0000913 CurGD = GD;
Reid Kleckner89077a12013-12-17 19:46:40 +0000914 const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(FD);
915 if (MD && MD->isInstance()) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000916 if (CGM.getCXXABI().HasThisReturn(GD))
917 ResTy = MD->getThisType(getContext());
David Majnemer0c0b6d92014-10-31 20:09:12 +0000918 else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
919 ResTy = CGM.getContext().VoidPtrTy;
Reid Kleckner89077a12013-12-17 19:46:40 +0000920 CGM.getCXXABI().buildThisParam(*this, Args);
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000921 }
Justin Bogner66242d62015-04-23 23:06:47 +0000922
Alexey Samsonov3551e312014-08-13 20:06:24 +0000923 Args.append(FD->param_begin(), FD->param_end());
Daniel Dunbar89654ee2008-08-26 08:29:31 +0000924
Reid Kleckner89077a12013-12-17 19:46:40 +0000925 if (MD && (isa<CXXConstructorDecl>(MD) || isa<CXXDestructorDecl>(MD)))
926 CGM.getCXXABI().addImplicitStructorParams(*this, ResTy, Args);
927
John McCall89b12b32010-02-18 03:17:58 +0000928 SourceRange BodyRange;
929 if (Stmt *Body = FD->getBody()) BodyRange = Body->getSourceRange();
Adrian Prantldc237b52013-05-16 00:41:26 +0000930 CurEHLocation = BodyRange.getEnd();
Anders Carlsson438cf922009-11-06 02:55:43 +0000931
Adrian Prantl42d71b92014-04-10 23:21:53 +0000932 // Use the location of the start of the function to determine where
933 // the function definition is located. By default use the location
934 // of the declaration as the location for the subprogram. A function
935 // may lack a declaration in the source code if it is created by code
936 // gen. (examples: _GLOBAL__I_a, __cxx_global_array_dtor, thunk).
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +0000937 SourceLocation Loc = FD->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +0000938
Alexey Samsonovcb1ad6f2014-07-08 20:23:18 +0000939 // If this is a function specialization then use the pattern body
940 // as the location for the function.
941 if (const FunctionDecl *SpecDecl = FD->getTemplateInstantiationPattern())
942 if (SpecDecl->hasBody(SpecDecl))
943 Loc = SpecDecl->getLocation();
Adrian Prantl42d71b92014-04-10 23:21:53 +0000944
John McCall89b12b32010-02-18 03:17:58 +0000945 // Emit the standard function prologue.
Adrian Prantl42d71b92014-04-10 23:21:53 +0000946 StartFunction(GD, ResTy, Fn, FnInfo, Args, Loc, BodyRange.getBegin());
Anders Carlsson438cf922009-11-06 02:55:43 +0000947
John McCall89b12b32010-02-18 03:17:58 +0000948 // Generate the body of the function.
Alex Lorenzee024992014-08-04 18:41:51 +0000949 PGO.checkGlobalDecl(GD);
Bob Wilsonda1ebed2014-03-06 04:55:41 +0000950 PGO.assignRegionCounters(GD.getDecl(), CurFn);
John McCallb81884d2010-02-19 09:25:03 +0000951 if (isa<CXXDestructorDecl>(FD))
952 EmitDestructorBody(Args);
953 else if (isa<CXXConstructorDecl>(FD))
954 EmitConstructorBody(Args);
Richard Smith9c6890a2012-11-01 22:30:59 +0000955 else if (getLangOpts().CUDA &&
Artem Belevichf3d3db62015-03-19 18:58:18 +0000956 !getLangOpts().CUDAIsDevice &&
Peter Collingbournefa4d6032011-10-06 18:51:56 +0000957 FD->hasAttr<CUDAGlobalAttr>())
Artem Belevich52cc4872015-05-07 19:34:16 +0000958 CGM.getCUDARuntime().emitDeviceStub(*this, Args);
Eli Friedman5a6d5072012-02-16 01:37:33 +0000959 else if (isa<CXXConversionDecl>(FD) &&
Douglas Gregor355efbb2012-02-17 03:02:34 +0000960 cast<CXXConversionDecl>(FD)->isLambdaToBlockPointerConversion()) {
961 // The lambda conversion to block pointer is special; the semantics can't be
962 // expressed in the AST, so IRGen needs to special-case it.
963 EmitLambdaToBlockPointerBody(Args);
964 } else if (isa<CXXMethodDecl>(FD) &&
965 cast<CXXMethodDecl>(FD)->isLambdaStaticInvoker()) {
Faisal Vali2b391ab2013-09-26 19:54:12 +0000966 // The lambda static invoker function is special, because it forwards or
Douglas Gregor355efbb2012-02-17 03:02:34 +0000967 // clones the body of the function call operator (but is actually static).
968 EmitLambdaStaticInvokeFunction(cast<CXXMethodDecl>(FD));
Lang Hamesbf122742013-02-17 07:22:09 +0000969 } else if (FD->isDefaulted() && isa<CXXMethodDecl>(FD) &&
Nick Lewyckyb39be1f2013-09-10 05:14:39 +0000970 (cast<CXXMethodDecl>(FD)->isCopyAssignmentOperator() ||
971 cast<CXXMethodDecl>(FD)->isMoveAssignmentOperator())) {
Lang Hamesbf122742013-02-17 07:22:09 +0000972 // Implicit copy-assignment gets the same special treatment as implicit
973 // copy-constructors.
974 emitImplicitAssignmentOperatorBody(Args);
Richard Smithb47c36f2013-11-05 09:12:18 +0000975 } else if (Stmt *Body = FD->getBody()) {
976 EmitFunctionBody(Args, Body);
Richard Smithb47c36f2013-11-05 09:12:18 +0000977 } else
978 llvm_unreachable("no definition for emitted function");
Anders Carlssonff8cce42010-02-07 19:45:40 +0000979
Richard Smith9f9e5822012-10-04 23:52:29 +0000980 // C++11 [stmt.return]p2:
981 // Flowing off the end of a function [...] results in undefined behavior in
982 // a value-returning function.
983 // C11 6.9.1p12:
984 // If the '}' that terminates a function is reached, and the value of the
985 // function call is used by the caller, the behavior is undefined.
Reid Kleckner9b3e3df2014-09-04 20:04:38 +0000986 if (getLangOpts().CPlusPlus && !FD->hasImplicitReturnZero() && !SawAsmBlock &&
Alp Toker314cc812014-01-25 16:55:45 +0000987 !FD->getReturnType()->isVoidType() && Builder.GetInsertBlock()) {
Alexey Samsonovedf99a92014-11-07 22:29:38 +0000988 if (SanOpts.has(SanitizerKind::Return)) {
Alexey Samsonov24cad992014-07-17 18:46:27 +0000989 SanitizerScope SanScope(this);
Alexey Samsonove396bfc2014-11-11 22:03:54 +0000990 llvm::Value *IsFalse = Builder.getFalse();
991 EmitCheck(std::make_pair(IsFalse, SanitizerKind::Return),
992 "missing_return", EmitCheckSourceLocation(FD->getLocation()),
993 None);
Akira Hatanaka85365cd2015-07-02 22:15:41 +0000994 } else if (CGM.getCodeGenOpts().OptimizationLevel == 0) {
995 EmitTrapCall(llvm::Intrinsic::trap);
996 }
Richard Smith9f9e5822012-10-04 23:52:29 +0000997 Builder.CreateUnreachable();
998 Builder.ClearInsertionPoint();
999 }
1000
John McCall89b12b32010-02-18 03:17:58 +00001001 // Emit the standard function epilogue.
1002 FinishFunction(BodyRange.getEnd());
John McCall8601a752010-08-03 22:46:07 +00001003
1004 // If we haven't marked the function nothrow through other means, do
1005 // a quick pass now to see if we can.
1006 if (!CurFn->doesNotThrow())
1007 TryMarkNoThrow(CurFn);
Chris Lattner5696e7b2008-06-17 18:05:57 +00001008}
1009
Chris Lattner5b1964b2008-11-11 07:41:27 +00001010/// ContainsLabel - Return true if the statement contains a label in it. If
1011/// this statement is not executed normally, it not containing a label means
1012/// that we can just remove the code.
1013bool CodeGenFunction::ContainsLabel(const Stmt *S, bool IgnoreCaseStmts) {
1014 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001015 if (!S) return false;
Mike Stump11289f42009-09-09 15:08:12 +00001016
Chris Lattner5b1964b2008-11-11 07:41:27 +00001017 // If this is a label, we have to emit the code, consider something like:
1018 // if (0) { ... foo: bar(); } goto foo;
Chris Lattner29911cc2011-02-28 00:18:40 +00001019 //
1020 // TODO: If anyone cared, we could track __label__'s, since we know that you
1021 // can't jump to one from outside their declared region.
Chris Lattner5b1964b2008-11-11 07:41:27 +00001022 if (isa<LabelStmt>(S))
1023 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001024
Chris Lattner5b1964b2008-11-11 07:41:27 +00001025 // If this is a case/default statement, and we haven't seen a switch, we have
1026 // to emit the code.
1027 if (isa<SwitchCase>(S) && !IgnoreCaseStmts)
1028 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001029
Chris Lattner5b1964b2008-11-11 07:41:27 +00001030 // If this is a switch statement, we want to ignore cases below it.
1031 if (isa<SwitchStmt>(S))
1032 IgnoreCaseStmts = true;
Mike Stump11289f42009-09-09 15:08:12 +00001033
Chris Lattner5b1964b2008-11-11 07:41:27 +00001034 // Scan subexpressions for verboten labels.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001035 for (const Stmt *SubStmt : S->children())
1036 if (ContainsLabel(SubStmt, IgnoreCaseStmts))
Chris Lattner5b1964b2008-11-11 07:41:27 +00001037 return true;
Mike Stump11289f42009-09-09 15:08:12 +00001038
Chris Lattner5b1964b2008-11-11 07:41:27 +00001039 return false;
1040}
1041
Chris Lattner29911cc2011-02-28 00:18:40 +00001042/// containsBreak - Return true if the statement contains a break out of it.
1043/// If the statement (recursively) contains a switch or loop with a break
1044/// inside of it, this is fine.
1045bool CodeGenFunction::containsBreak(const Stmt *S) {
1046 // Null statement, not a label!
Craig Topper8a13c412014-05-21 05:09:00 +00001047 if (!S) return false;
Chris Lattner29911cc2011-02-28 00:18:40 +00001048
1049 // If this is a switch or loop that defines its own break scope, then we can
1050 // include it and anything inside of it.
1051 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || isa<DoStmt>(S) ||
1052 isa<ForStmt>(S))
Chris Lattner30db8282011-02-28 00:42:31 +00001053 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001054
Chris Lattner30db8282011-02-28 00:42:31 +00001055 if (isa<BreakStmt>(S))
Chris Lattner29911cc2011-02-28 00:18:40 +00001056 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001057
Chris Lattner29911cc2011-02-28 00:18:40 +00001058 // Scan subexpressions for verboten breaks.
Benjamin Kramer642f1732015-07-02 21:03:14 +00001059 for (const Stmt *SubStmt : S->children())
1060 if (containsBreak(SubStmt))
Chris Lattner29911cc2011-02-28 00:18:40 +00001061 return true;
Michael Ilseman686240a2012-12-04 00:29:55 +00001062
Chris Lattner29911cc2011-02-28 00:18:40 +00001063 return false;
1064}
1065
Chris Lattnercd439292008-11-12 08:04:58 +00001066
Chris Lattner41c6ab52011-02-27 23:02:32 +00001067/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1068/// to a constant, or if it does but contains a label, return false. If it
1069/// constant folds return true and set the boolean result in Result.
1070bool CodeGenFunction::ConstantFoldsToSimpleInteger(const Expr *Cond,
1071 bool &ResultBool) {
Richard Trieuc320c742012-07-23 20:21:35 +00001072 llvm::APSInt ResultInt;
Chris Lattner29911cc2011-02-28 00:18:40 +00001073 if (!ConstantFoldsToSimpleInteger(Cond, ResultInt))
1074 return false;
Michael Ilseman686240a2012-12-04 00:29:55 +00001075
Chris Lattner29911cc2011-02-28 00:18:40 +00001076 ResultBool = ResultInt.getBoolValue();
1077 return true;
1078}
1079
1080/// ConstantFoldsToSimpleInteger - If the specified expression does not fold
1081/// to a constant, or if it does but contains a label, return false. If it
1082/// constant folds return true and set the folded value.
1083bool CodeGenFunction::
Richard Trieuc320c742012-07-23 20:21:35 +00001084ConstantFoldsToSimpleInteger(const Expr *Cond, llvm::APSInt &ResultInt) {
Daniel Dunbarf32443c2008-11-12 22:37:10 +00001085 // FIXME: Rename and handle conversion of other evaluatable things
1086 // to bool.
Richard Smith5fab0c92011-12-28 19:48:30 +00001087 llvm::APSInt Int;
1088 if (!Cond->EvaluateAsInt(Int, getContext()))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001089 return false; // Not foldable, not integer or not fully evaluatable.
Richard Smith5fab0c92011-12-28 19:48:30 +00001090
Chris Lattnercd439292008-11-12 08:04:58 +00001091 if (CodeGenFunction::ContainsLabel(Cond))
Chris Lattner41c6ab52011-02-27 23:02:32 +00001092 return false; // Contains a label.
Richard Smith5fab0c92011-12-28 19:48:30 +00001093
1094 ResultInt = Int;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001095 return true;
Chris Lattnercd439292008-11-12 08:04:58 +00001096}
1097
1098
Chris Lattner29911cc2011-02-28 00:18:40 +00001099
Chris Lattnercd439292008-11-12 08:04:58 +00001100/// EmitBranchOnBoolExpr - Emit a branch on a boolean condition (e.g. for an if
1101/// statement) to the specified blocks. Based on the condition, this might try
1102/// to simplify the codegen of the conditional based on the branch.
1103///
1104void CodeGenFunction::EmitBranchOnBoolExpr(const Expr *Cond,
1105 llvm::BasicBlock *TrueBlock,
Justin Bogneref512b92014-01-06 22:27:43 +00001106 llvm::BasicBlock *FalseBlock,
1107 uint64_t TrueCount) {
Peter Collingbourne91147592011-04-15 00:35:48 +00001108 Cond = Cond->IgnoreParens();
Mike Stump11289f42009-09-09 15:08:12 +00001109
Chris Lattnercd439292008-11-12 08:04:58 +00001110 if (const BinaryOperator *CondBOp = dyn_cast<BinaryOperator>(Cond)) {
Justin Bogneref512b92014-01-06 22:27:43 +00001111
Chris Lattnercd439292008-11-12 08:04:58 +00001112 // Handle X && Y in a condition.
John McCalle3027922010-08-25 11:45:40 +00001113 if (CondBOp->getOpcode() == BO_LAnd) {
Chris Lattnercd439292008-11-12 08:04:58 +00001114 // If we have "1 && X", simplify the code. "0 && X" would have constant
1115 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001116 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001117 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1118 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001119 // br(1 && X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001120 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001121 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1122 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001123 }
Mike Stump11289f42009-09-09 15:08:12 +00001124
Chris Lattnercd439292008-11-12 08:04:58 +00001125 // If we have "X && 1", simplify the code to use an uncond branch.
1126 // "X && 0" would have been constant folded to 0.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001127 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1128 ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001129 // br(X && 1) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001130 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1131 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001132 }
Mike Stump11289f42009-09-09 15:08:12 +00001133
Chris Lattnercd439292008-11-12 08:04:58 +00001134 // Emit the LHS as a conditional. If the LHS conditional is false, we
1135 // want to jump to the FalseBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001136 llvm::BasicBlock *LHSTrue = createBasicBlock("land.lhs.true");
Justin Bogneref512b92014-01-06 22:27:43 +00001137 // The counter tells us how often we evaluate RHS, and all of TrueCount
1138 // can be propagated to that branch.
Justin Bogner66242d62015-04-23 23:06:47 +00001139 uint64_t RHSCount = getProfileCount(CondBOp->getRHS());
John McCallce1de612011-01-26 04:00:11 +00001140
1141 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001142 {
1143 ApplyDebugLocation DL(*this, Cond);
1144 EmitBranchOnBoolExpr(CondBOp->getLHS(), LHSTrue, FalseBlock, RHSCount);
1145 EmitBlock(LHSTrue);
1146 }
Mike Stump11289f42009-09-09 15:08:12 +00001147
Justin Bogner66242d62015-04-23 23:06:47 +00001148 incrementProfileCounter(CondBOp);
1149 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1150
Anders Carlsson60ddba62010-01-24 00:20:05 +00001151 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001152 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001153 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, TrueCount);
John McCallce1de612011-01-26 04:00:11 +00001154 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001155
Chris Lattnercd439292008-11-12 08:04:58 +00001156 return;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001157 }
Michael Ilseman686240a2012-12-04 00:29:55 +00001158
Chris Lattner41c6ab52011-02-27 23:02:32 +00001159 if (CondBOp->getOpcode() == BO_LOr) {
Chris Lattnercd439292008-11-12 08:04:58 +00001160 // If we have "0 || X", simplify the code. "1 || X" would have constant
1161 // folded if the case was simple enough.
Bill Wendling6c9540e2011-03-04 21:46:03 +00001162 bool ConstantBool = false;
Chris Lattner41c6ab52011-02-27 23:02:32 +00001163 if (ConstantFoldsToSimpleInteger(CondBOp->getLHS(), ConstantBool) &&
1164 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001165 // br(0 || X) -> br(X).
Justin Bogner66242d62015-04-23 23:06:47 +00001166 incrementProfileCounter(CondBOp);
Justin Bogneref512b92014-01-06 22:27:43 +00001167 return EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock,
1168 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001169 }
Mike Stump11289f42009-09-09 15:08:12 +00001170
Chris Lattnercd439292008-11-12 08:04:58 +00001171 // If we have "X || 0", simplify the code to use an uncond branch.
1172 // "X || 1" would have been constant folded to 1.
Chris Lattner41c6ab52011-02-27 23:02:32 +00001173 if (ConstantFoldsToSimpleInteger(CondBOp->getRHS(), ConstantBool) &&
1174 !ConstantBool) {
Chris Lattnercd439292008-11-12 08:04:58 +00001175 // br(X || 0) -> br(X).
Justin Bogneref512b92014-01-06 22:27:43 +00001176 return EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, FalseBlock,
1177 TrueCount);
Chris Lattnercd439292008-11-12 08:04:58 +00001178 }
Mike Stump11289f42009-09-09 15:08:12 +00001179
Chris Lattnercd439292008-11-12 08:04:58 +00001180 // Emit the LHS as a conditional. If the LHS conditional is true, we
1181 // want to jump to the TrueBlock.
Daniel Dunbara612e792008-11-13 01:38:36 +00001182 llvm::BasicBlock *LHSFalse = createBasicBlock("lor.lhs.false");
Justin Bogneref512b92014-01-06 22:27:43 +00001183 // We have the count for entry to the RHS and for the whole expression
1184 // being true, so we can divy up True count between the short circuit and
1185 // the RHS.
Justin Bogner66242d62015-04-23 23:06:47 +00001186 uint64_t LHSCount =
1187 getCurrentProfileCount() - getProfileCount(CondBOp->getRHS());
Justin Bogneref512b92014-01-06 22:27:43 +00001188 uint64_t RHSCount = TrueCount - LHSCount;
John McCallce1de612011-01-26 04:00:11 +00001189
1190 ConditionalEvaluation eval(*this);
David Blaikie298720d2015-01-28 19:50:09 +00001191 {
1192 ApplyDebugLocation DL(*this, Cond);
1193 EmitBranchOnBoolExpr(CondBOp->getLHS(), TrueBlock, LHSFalse, LHSCount);
1194 EmitBlock(LHSFalse);
1195 }
Mike Stump11289f42009-09-09 15:08:12 +00001196
Justin Bogner66242d62015-04-23 23:06:47 +00001197 incrementProfileCounter(CondBOp);
1198 setCurrentProfileCount(getProfileCount(CondBOp->getRHS()));
1199
Anders Carlsson60ddba62010-01-24 00:20:05 +00001200 // Any temporaries created here are conditional.
John McCallce1de612011-01-26 04:00:11 +00001201 eval.begin(*this);
Justin Bogneref512b92014-01-06 22:27:43 +00001202 EmitBranchOnBoolExpr(CondBOp->getRHS(), TrueBlock, FalseBlock, RHSCount);
1203
John McCallce1de612011-01-26 04:00:11 +00001204 eval.end(*this);
Anders Carlsson60ddba62010-01-24 00:20:05 +00001205
Chris Lattnercd439292008-11-12 08:04:58 +00001206 return;
1207 }
Chris Lattnerd9537732008-11-12 08:13:36 +00001208 }
Mike Stump11289f42009-09-09 15:08:12 +00001209
Chris Lattnerd9537732008-11-12 08:13:36 +00001210 if (const UnaryOperator *CondUOp = dyn_cast<UnaryOperator>(Cond)) {
1211 // br(!x, t, f) -> br(x, f, t)
Justin Bogneref512b92014-01-06 22:27:43 +00001212 if (CondUOp->getOpcode() == UO_LNot) {
1213 // Negate the count.
Justin Bogner66242d62015-04-23 23:06:47 +00001214 uint64_t FalseCount = getCurrentProfileCount() - TrueCount;
Justin Bogneref512b92014-01-06 22:27:43 +00001215 // Negate the condition and swap the destination blocks.
1216 return EmitBranchOnBoolExpr(CondUOp->getSubExpr(), FalseBlock, TrueBlock,
1217 FalseCount);
1218 }
Chris Lattnercd439292008-11-12 08:04:58 +00001219 }
Mike Stump11289f42009-09-09 15:08:12 +00001220
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001221 if (const ConditionalOperator *CondOp = dyn_cast<ConditionalOperator>(Cond)) {
Eli Friedman248f8982012-02-14 03:54:45 +00001222 // br(c ? x : y, t, f) -> br(c, br(x, t, f), br(y, t, f))
1223 llvm::BasicBlock *LHSBlock = createBasicBlock("cond.true");
1224 llvm::BasicBlock *RHSBlock = createBasicBlock("cond.false");
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001225
Eli Friedman248f8982012-02-14 03:54:45 +00001226 ConditionalEvaluation cond(*this);
Justin Bogner66242d62015-04-23 23:06:47 +00001227 EmitBranchOnBoolExpr(CondOp->getCond(), LHSBlock, RHSBlock,
1228 getProfileCount(CondOp));
Justin Bogneref512b92014-01-06 22:27:43 +00001229
1230 // When computing PGO branch weights, we only know the overall count for
1231 // the true block. This code is essentially doing tail duplication of the
1232 // naive code-gen, introducing new edges for which counts are not
1233 // available. Divide the counts proportionally between the LHS and RHS of
1234 // the conditional operator.
1235 uint64_t LHSScaledTrueCount = 0;
1236 if (TrueCount) {
Justin Bogner66242d62015-04-23 23:06:47 +00001237 double LHSRatio =
1238 getProfileCount(CondOp) / (double)getCurrentProfileCount();
Justin Bogneref512b92014-01-06 22:27:43 +00001239 LHSScaledTrueCount = TrueCount * LHSRatio;
1240 }
John McCallce1de612011-01-26 04:00:11 +00001241
Eli Friedman248f8982012-02-14 03:54:45 +00001242 cond.begin(*this);
1243 EmitBlock(LHSBlock);
Justin Bogner66242d62015-04-23 23:06:47 +00001244 incrementProfileCounter(CondOp);
David Blaikie298720d2015-01-28 19:50:09 +00001245 {
1246 ApplyDebugLocation DL(*this, Cond);
1247 EmitBranchOnBoolExpr(CondOp->getLHS(), TrueBlock, FalseBlock,
1248 LHSScaledTrueCount);
1249 }
Eli Friedman248f8982012-02-14 03:54:45 +00001250 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001251
Eli Friedman248f8982012-02-14 03:54:45 +00001252 cond.begin(*this);
1253 EmitBlock(RHSBlock);
Justin Bogneref512b92014-01-06 22:27:43 +00001254 EmitBranchOnBoolExpr(CondOp->getRHS(), TrueBlock, FalseBlock,
1255 TrueCount - LHSScaledTrueCount);
Eli Friedman248f8982012-02-14 03:54:45 +00001256 cond.end(*this);
John McCallce1de612011-01-26 04:00:11 +00001257
Eli Friedman248f8982012-02-14 03:54:45 +00001258 return;
Daniel Dunbarbf3c22e2008-11-12 10:30:32 +00001259 }
1260
Richard Smithea852322013-05-07 21:53:22 +00001261 if (const CXXThrowExpr *Throw = dyn_cast<CXXThrowExpr>(Cond)) {
1262 // Conditional operator handling can give us a throw expression as a
1263 // condition for a case like:
1264 // br(c ? throw x : y, t, f) -> br(c, br(throw x, t, f), br(y, t, f)
1265 // Fold this to:
1266 // br(c, throw x, br(y, t, f))
1267 EmitCXXThrowExpr(Throw, /*KeepInsertionPoint*/false);
1268 return;
1269 }
1270
Sanjay Patela24296b2015-09-02 20:01:30 +00001271 // If the branch has a condition wrapped by __builtin_unpredictable,
1272 // create metadata that specifies that the branch is unpredictable.
1273 // Don't bother if not optimizing because that metadata would not be used.
1274 llvm::MDNode *Unpredictable = nullptr;
1275 if (CGM.getCodeGenOpts().OptimizationLevel != 0) {
1276 if (const CallExpr *Call = dyn_cast<CallExpr>(Cond)) {
1277 const Decl *TargetDecl = Call->getCalleeDecl();
1278 if (const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(TargetDecl)) {
1279 if (FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1280 llvm::MDBuilder MDHelper(getLLVMContext());
1281 Unpredictable = MDHelper.createUnpredictable();
1282 }
1283 }
1284 }
1285 }
1286
Justin Bogneref512b92014-01-06 22:27:43 +00001287 // Create branch weights based on the number of times we get here and the
1288 // number of times the condition should be true.
Justin Bogner66242d62015-04-23 23:06:47 +00001289 uint64_t CurrentCount = std::max(getCurrentProfileCount(), TrueCount);
Justin Bogner65512642015-05-02 05:00:55 +00001290 llvm::MDNode *Weights =
1291 createProfileWeights(TrueCount, CurrentCount - TrueCount);
Justin Bogneref512b92014-01-06 22:27:43 +00001292
Chris Lattnercd439292008-11-12 08:04:58 +00001293 // Emit the code with the fully general case.
David Blaikie303facb2015-01-31 01:10:11 +00001294 llvm::Value *CondV;
1295 {
1296 ApplyDebugLocation DL(*this, Cond);
1297 CondV = EvaluateExprAsBool(Cond);
1298 }
Sanjay Patela24296b2015-09-02 20:01:30 +00001299 Builder.CreateCondBr(CondV, TrueBlock, FalseBlock, Weights, Unpredictable);
Chris Lattnercd439292008-11-12 08:04:58 +00001300}
1301
Daniel Dunbara7c8cf62008-08-16 00:56:44 +00001302/// ErrorUnsupported - Print out an error that codegen doesn't support the
Chris Lattnerfc944342007-12-02 01:43:38 +00001303/// specified stmt yet.
David Blaikie4a9ec7b2013-08-19 21:02:26 +00001304void CodeGenFunction::ErrorUnsupported(const Stmt *S, const char *Type) {
1305 CGM.ErrorUnsupported(S, Type);
Chris Lattnerfc944342007-12-02 01:43:38 +00001306}
1307
John McCall2725aa12011-02-01 21:35:06 +00001308/// emitNonZeroVLAInit - Emit the "zero" initialization of a
1309/// variable-length array whose elements have a non-zero bit-pattern.
1310///
James Dennettbe302452012-06-15 22:10:14 +00001311/// \param baseType the inner-most element type of the array
John McCall2725aa12011-02-01 21:35:06 +00001312/// \param src - a char* pointing to the bit-pattern for a single
1313/// base element of the array
1314/// \param sizeInChars - the total size of the VLA, in chars
John McCall2725aa12011-02-01 21:35:06 +00001315static void emitNonZeroVLAInit(CodeGenFunction &CGF, QualType baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001316 Address dest, Address src,
John McCall2725aa12011-02-01 21:35:06 +00001317 llvm::Value *sizeInChars) {
John McCall2725aa12011-02-01 21:35:06 +00001318 CGBuilderTy &Builder = CGF.Builder;
1319
John McCall7f416cc2015-09-08 08:05:57 +00001320 CharUnits baseSize = CGF.getContext().getTypeSizeInChars(baseType);
John McCall2725aa12011-02-01 21:35:06 +00001321 llvm::Value *baseSizeInChars
John McCall7f416cc2015-09-08 08:05:57 +00001322 = llvm::ConstantInt::get(CGF.IntPtrTy, baseSize.getQuantity());
John McCall2725aa12011-02-01 21:35:06 +00001323
John McCall7f416cc2015-09-08 08:05:57 +00001324 Address begin =
1325 Builder.CreateElementBitCast(dest, CGF.Int8Ty, "vla.begin");
1326 llvm::Value *end =
1327 Builder.CreateInBoundsGEP(begin.getPointer(), sizeInChars, "vla.end");
John McCall2725aa12011-02-01 21:35:06 +00001328
1329 llvm::BasicBlock *originBB = CGF.Builder.GetInsertBlock();
1330 llvm::BasicBlock *loopBB = CGF.createBasicBlock("vla-init.loop");
1331 llvm::BasicBlock *contBB = CGF.createBasicBlock("vla-init.cont");
1332
1333 // Make a loop over the VLA. C99 guarantees that the VLA element
1334 // count must be nonzero.
1335 CGF.EmitBlock(loopBB);
1336
John McCall7f416cc2015-09-08 08:05:57 +00001337 llvm::PHINode *cur = Builder.CreatePHI(begin.getType(), 2, "vla.cur");
1338 cur->addIncoming(begin.getPointer(), originBB);
1339
1340 CharUnits curAlign =
1341 dest.getAlignment().alignmentOfArrayElement(baseSize);
John McCall2725aa12011-02-01 21:35:06 +00001342
1343 // memcpy the individual element bit-pattern.
John McCall7f416cc2015-09-08 08:05:57 +00001344 Builder.CreateMemCpy(Address(cur, curAlign), src, baseSizeInChars,
John McCall2725aa12011-02-01 21:35:06 +00001345 /*volatile*/ false);
1346
1347 // Go to the next element.
John McCall7f416cc2015-09-08 08:05:57 +00001348 llvm::Value *next =
1349 Builder.CreateInBoundsGEP(CGF.Int8Ty, cur, baseSizeInChars, "vla.next");
John McCall2725aa12011-02-01 21:35:06 +00001350
1351 // Leave if that's the end of the VLA.
1352 llvm::Value *done = Builder.CreateICmpEQ(next, end, "vla-init.isdone");
1353 Builder.CreateCondBr(done, contBB, loopBB);
1354 cur->addIncoming(next, loopBB);
1355
1356 CGF.EmitBlock(contBB);
Michael Ilseman686240a2012-12-04 00:29:55 +00001357}
John McCall2725aa12011-02-01 21:35:06 +00001358
Anders Carlssonc0964b62010-05-22 17:35:42 +00001359void
John McCall7f416cc2015-09-08 08:05:57 +00001360CodeGenFunction::EmitNullInitialization(Address DestPtr, QualType Ty) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001361 // Ignore empty classes in C++.
Richard Smith9c6890a2012-11-01 22:30:59 +00001362 if (getLangOpts().CPlusPlus) {
Anders Carlsson16e94af2010-05-03 01:20:20 +00001363 if (const RecordType *RT = Ty->getAs<RecordType>()) {
1364 if (cast<CXXRecordDecl>(RT->getDecl())->isEmpty())
1365 return;
1366 }
1367 }
John McCall7cd1d972010-08-07 08:21:30 +00001368
1369 // Cast the dest ptr to the appropriate i8 pointer type.
John McCall7f416cc2015-09-08 08:05:57 +00001370 if (DestPtr.getElementType() != Int8Ty)
1371 DestPtr = Builder.CreateElementBitCast(DestPtr, Int8Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001372
1373 // Get size and alignment info for this aggregate.
John McCall7f416cc2015-09-08 08:05:57 +00001374 CharUnits size = getContext().getTypeSizeInChars(Ty);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001375
John McCalla08ffd22011-01-14 10:37:58 +00001376 llvm::Value *SizeVal;
John McCall2725aa12011-02-01 21:35:06 +00001377 const VariableArrayType *vla;
Mike Stump11289f42009-09-09 15:08:12 +00001378
John McCalla08ffd22011-01-14 10:37:58 +00001379 // Don't bother emitting a zero-byte memset.
John McCall7f416cc2015-09-08 08:05:57 +00001380 if (size.isZero()) {
John McCalla08ffd22011-01-14 10:37:58 +00001381 // But note that getTypeInfo returns 0 for a VLA.
1382 if (const VariableArrayType *vlaType =
1383 dyn_cast_or_null<VariableArrayType>(
1384 getContext().getAsArrayType(Ty))) {
John McCall23c29fe2011-06-24 21:55:10 +00001385 QualType eltType;
1386 llvm::Value *numElts;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001387 std::tie(numElts, eltType) = getVLASize(vlaType);
John McCall23c29fe2011-06-24 21:55:10 +00001388
1389 SizeVal = numElts;
1390 CharUnits eltSize = getContext().getTypeSizeInChars(eltType);
1391 if (!eltSize.isOne())
1392 SizeVal = Builder.CreateNUWMul(SizeVal, CGM.getSize(eltSize));
John McCall2725aa12011-02-01 21:35:06 +00001393 vla = vlaType;
John McCalla08ffd22011-01-14 10:37:58 +00001394 } else {
1395 return;
1396 }
1397 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001398 SizeVal = CGM.getSize(size);
Craig Topper8a13c412014-05-21 05:09:00 +00001399 vla = nullptr;
John McCalla08ffd22011-01-14 10:37:58 +00001400 }
John McCall7cd1d972010-08-07 08:21:30 +00001401
1402 // If the type contains a pointer to data member we can't memset it to zero.
1403 // Instead, create a null constant and copy it to the destination.
John McCall2725aa12011-02-01 21:35:06 +00001404 // TODO: there are other patterns besides zero that we can usefully memset,
1405 // like -1, which happens to be the pattern used by member-pointers.
John McCall614dbdc2010-08-22 21:01:12 +00001406 if (!CGM.getTypes().isZeroInitializable(Ty)) {
John McCall2725aa12011-02-01 21:35:06 +00001407 // For a VLA, emit a single element, then splat that over the VLA.
1408 if (vla) Ty = getContext().getBaseElementType(vla);
John McCalla08ffd22011-01-14 10:37:58 +00001409
John McCall7cd1d972010-08-07 08:21:30 +00001410 llvm::Constant *NullConstant = CGM.EmitNullConstant(Ty);
1411
Michael Ilseman686240a2012-12-04 00:29:55 +00001412 llvm::GlobalVariable *NullVariable =
John McCall7cd1d972010-08-07 08:21:30 +00001413 new llvm::GlobalVariable(CGM.getModule(), NullConstant->getType(),
Michael Ilseman686240a2012-12-04 00:29:55 +00001414 /*isConstant=*/true,
John McCall7cd1d972010-08-07 08:21:30 +00001415 llvm::GlobalVariable::PrivateLinkage,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001416 NullConstant, Twine());
John McCall7f416cc2015-09-08 08:05:57 +00001417 CharUnits NullAlign = DestPtr.getAlignment();
1418 NullVariable->setAlignment(NullAlign.getQuantity());
1419 Address SrcPtr(Builder.CreateBitCast(NullVariable, Builder.getInt8PtrTy()),
1420 NullAlign);
John McCall7cd1d972010-08-07 08:21:30 +00001421
John McCall2725aa12011-02-01 21:35:06 +00001422 if (vla) return emitNonZeroVLAInit(*this, Ty, DestPtr, SrcPtr, SizeVal);
1423
John McCall7cd1d972010-08-07 08:21:30 +00001424 // Get and call the appropriate llvm.memcpy overload.
John McCall7f416cc2015-09-08 08:05:57 +00001425 Builder.CreateMemCpy(DestPtr, SrcPtr, SizeVal, false);
John McCall7cd1d972010-08-07 08:21:30 +00001426 return;
Michael Ilseman686240a2012-12-04 00:29:55 +00001427 }
1428
John McCall7cd1d972010-08-07 08:21:30 +00001429 // Otherwise, just memset the whole thing to zero. This is legal
1430 // because in LLVM, all default initializers (other than the ones we just
1431 // handled above) are guaranteed to have a bit pattern of all zeros.
John McCall7f416cc2015-09-08 08:05:57 +00001432 Builder.CreateMemSet(DestPtr, Builder.getInt8(0), SizeVal, false);
Anders Carlsson2e744e82008-08-30 19:51:14 +00001433}
1434
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001435llvm::BlockAddress *CodeGenFunction::GetAddrOfLabel(const LabelDecl *L) {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001436 // Make sure that there is a block for the indirect goto.
Craig Topper8a13c412014-05-21 05:09:00 +00001437 if (!IndirectBranch)
Chris Lattner6c4d2552009-10-28 23:59:40 +00001438 GetIndirectGotoBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001439
John McCallad5d61e2010-07-23 21:56:41 +00001440 llvm::BasicBlock *BB = getJumpDestForLabel(L).getBlock();
Michael Ilseman686240a2012-12-04 00:29:55 +00001441
Chris Lattner6c4d2552009-10-28 23:59:40 +00001442 // Make sure the indirect branch includes all of the address-taken blocks.
1443 IndirectBranch->addDestination(BB);
1444 return llvm::BlockAddress::get(CurFn, BB);
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001445}
1446
1447llvm::BasicBlock *CodeGenFunction::GetIndirectGotoBlock() {
Chris Lattner6c4d2552009-10-28 23:59:40 +00001448 // If we already made the indirect branch for indirect goto, return its block.
1449 if (IndirectBranch) return IndirectBranch->getParent();
Michael Ilseman686240a2012-12-04 00:29:55 +00001450
John McCall7f416cc2015-09-08 08:05:57 +00001451 CGBuilderTy TmpBuilder(*this, createBasicBlock("indirectgoto"));
Michael Ilseman686240a2012-12-04 00:29:55 +00001452
Chris Lattner2bb5cb42009-10-13 06:55:33 +00001453 // Create the PHI node that indirect gotos will add entries to.
Jay Foad20c0f022011-03-30 11:28:58 +00001454 llvm::Value *DestVal = TmpBuilder.CreatePHI(Int8PtrTy, 0,
1455 "indirect.goto.dest");
Michael Ilseman686240a2012-12-04 00:29:55 +00001456
Chris Lattner6c4d2552009-10-28 23:59:40 +00001457 // Create the indirect branch instruction.
1458 IndirectBranch = TmpBuilder.CreateIndirectBr(DestVal);
1459 return IndirectBranch->getParent();
Daniel Dunbar88402ce2008-08-04 16:51:22 +00001460}
Anders Carlsson13abd7e2008-11-04 05:30:00 +00001461
John McCall82fe67b2011-07-09 01:37:26 +00001462/// Computes the length of an array in elements, as well as the base
1463/// element type and a properly-typed first element pointer.
1464llvm::Value *CodeGenFunction::emitArrayLength(const ArrayType *origArrayType,
1465 QualType &baseType,
John McCall7f416cc2015-09-08 08:05:57 +00001466 Address &addr) {
John McCall82fe67b2011-07-09 01:37:26 +00001467 const ArrayType *arrayType = origArrayType;
1468
1469 // If it's a VLA, we have to load the stored size. Note that
1470 // this is the size of the VLA in bytes, not its size in elements.
Craig Topper8a13c412014-05-21 05:09:00 +00001471 llvm::Value *numVLAElements = nullptr;
John McCall82fe67b2011-07-09 01:37:26 +00001472 if (isa<VariableArrayType>(arrayType)) {
1473 numVLAElements = getVLASize(cast<VariableArrayType>(arrayType)).first;
1474
1475 // Walk into all VLAs. This doesn't require changes to addr,
1476 // which has type T* where T is the first non-VLA element type.
1477 do {
1478 QualType elementType = arrayType->getElementType();
1479 arrayType = getContext().getAsArrayType(elementType);
1480
1481 // If we only have VLA components, 'addr' requires no adjustment.
1482 if (!arrayType) {
1483 baseType = elementType;
1484 return numVLAElements;
1485 }
1486 } while (isa<VariableArrayType>(arrayType));
1487
1488 // We get out here only if we find a constant array type
1489 // inside the VLA.
1490 }
1491
1492 // We have some number of constant-length arrays, so addr should
1493 // have LLVM type [M x [N x [...]]]*. Build a GEP that walks
1494 // down to the first element of addr.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001495 SmallVector<llvm::Value*, 8> gepIndices;
John McCall82fe67b2011-07-09 01:37:26 +00001496
1497 // GEP down to the array type.
1498 llvm::ConstantInt *zero = Builder.getInt32(0);
1499 gepIndices.push_back(zero);
1500
John McCall82fe67b2011-07-09 01:37:26 +00001501 uint64_t countFromCLAs = 1;
Richard Smithf3c37e82012-04-22 05:51:36 +00001502 QualType eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001503
Chris Lattner2192fe52011-07-18 04:24:23 +00001504 llvm::ArrayType *llvmArrayType =
John McCall7f416cc2015-09-08 08:05:57 +00001505 dyn_cast<llvm::ArrayType>(addr.getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001506 while (llvmArrayType) {
John McCall82fe67b2011-07-09 01:37:26 +00001507 assert(isa<ConstantArrayType>(arrayType));
1508 assert(cast<ConstantArrayType>(arrayType)->getSize().getZExtValue()
1509 == llvmArrayType->getNumElements());
1510
1511 gepIndices.push_back(zero);
1512 countFromCLAs *= llvmArrayType->getNumElements();
Richard Smithf3c37e82012-04-22 05:51:36 +00001513 eltType = arrayType->getElementType();
John McCall82fe67b2011-07-09 01:37:26 +00001514
1515 llvmArrayType =
1516 dyn_cast<llvm::ArrayType>(llvmArrayType->getElementType());
John McCall82fe67b2011-07-09 01:37:26 +00001517 arrayType = getContext().getAsArrayType(arrayType->getElementType());
Richard Smithf3c37e82012-04-22 05:51:36 +00001518 assert((!llvmArrayType || arrayType) &&
1519 "LLVM and Clang types are out-of-synch");
John McCall82fe67b2011-07-09 01:37:26 +00001520 }
1521
Richard Smithf3c37e82012-04-22 05:51:36 +00001522 if (arrayType) {
1523 // From this point onwards, the Clang array type has been emitted
1524 // as some other type (probably a packed struct). Compute the array
1525 // size, and just emit the 'begin' expression as a bitcast.
1526 while (arrayType) {
1527 countFromCLAs *=
1528 cast<ConstantArrayType>(arrayType)->getSize().getZExtValue();
1529 eltType = arrayType->getElementType();
1530 arrayType = getContext().getAsArrayType(eltType);
1531 }
John McCall82fe67b2011-07-09 01:37:26 +00001532
John McCall7f416cc2015-09-08 08:05:57 +00001533 llvm::Type *baseType = ConvertType(eltType);
1534 addr = Builder.CreateElementBitCast(addr, baseType, "array.begin");
Richard Smithf3c37e82012-04-22 05:51:36 +00001535 } else {
1536 // Create the actual GEP.
John McCall7f416cc2015-09-08 08:05:57 +00001537 addr = Address(Builder.CreateInBoundsGEP(addr.getPointer(),
1538 gepIndices, "array.begin"),
1539 addr.getAlignment());
Richard Smithf3c37e82012-04-22 05:51:36 +00001540 }
1541
1542 baseType = eltType;
John McCall82fe67b2011-07-09 01:37:26 +00001543
1544 llvm::Value *numElements
1545 = llvm::ConstantInt::get(SizeTy, countFromCLAs);
1546
1547 // If we had any VLA dimensions, factor them in.
1548 if (numVLAElements)
1549 numElements = Builder.CreateNUWMul(numVLAElements, numElements);
1550
1551 return numElements;
1552}
1553
John McCall23c29fe2011-06-24 21:55:10 +00001554std::pair<llvm::Value*, QualType>
1555CodeGenFunction::getVLASize(QualType type) {
1556 const VariableArrayType *vla = getContext().getAsVariableArrayType(type);
1557 assert(vla && "type was not a variable array type!");
1558 return getVLASize(vla);
Anders Carlssone388a5b2008-12-20 20:27:15 +00001559}
Anders Carlssonccbe9202008-12-12 07:19:02 +00001560
John McCall23c29fe2011-06-24 21:55:10 +00001561std::pair<llvm::Value*, QualType>
1562CodeGenFunction::getVLASize(const VariableArrayType *type) {
1563 // The number of elements so far; always size_t.
Craig Topper8a13c412014-05-21 05:09:00 +00001564 llvm::Value *numElements = nullptr;
John McCall23c29fe2011-06-24 21:55:10 +00001565
1566 QualType elementType;
1567 do {
1568 elementType = type->getElementType();
1569 llvm::Value *vlaSize = VLASizeMap[type->getSizeExpr()];
1570 assert(vlaSize && "no size for VLA!");
1571 assert(vlaSize->getType() == SizeTy);
1572
1573 if (!numElements) {
1574 numElements = vlaSize;
1575 } else {
1576 // It's undefined behavior if this wraps around, so mark it that way.
Alexey Samsonovcb3f8122014-03-20 10:48:29 +00001577 // FIXME: Teach -fsanitize=undefined to trap this.
John McCall23c29fe2011-06-24 21:55:10 +00001578 numElements = Builder.CreateNUWMul(numElements, vlaSize);
1579 }
1580 } while ((type = getContext().getAsVariableArrayType(elementType)));
1581
1582 return std::pair<llvm::Value*,QualType>(numElements, elementType);
1583}
1584
1585void CodeGenFunction::EmitVariablyModifiedType(QualType type) {
1586 assert(type->isVariablyModifiedType() &&
Anders Carlsson8a01b792008-12-20 20:46:34 +00001587 "Must pass variably modified type to EmitVLASizes!");
Mike Stump11289f42009-09-09 15:08:12 +00001588
Daniel Dunbarb6adc432009-07-19 06:58:07 +00001589 EnsureInsertPoint();
Mike Stump11289f42009-09-09 15:08:12 +00001590
John McCall23c29fe2011-06-24 21:55:10 +00001591 // We're going to walk down into the type and look for VLA
1592 // expressions.
John McCall23c29fe2011-06-24 21:55:10 +00001593 do {
1594 assert(type->isVariablyModifiedType());
Mike Stump11289f42009-09-09 15:08:12 +00001595
John McCall23c29fe2011-06-24 21:55:10 +00001596 const Type *ty = type.getTypePtr();
1597 switch (ty->getTypeClass()) {
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001598
John McCall23c29fe2011-06-24 21:55:10 +00001599#define TYPE(Class, Base)
1600#define ABSTRACT_TYPE(Class, Base)
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001601#define NON_CANONICAL_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001602#define DEPENDENT_TYPE(Class, Base) case Type::Class:
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001603#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)
John McCall23c29fe2011-06-24 21:55:10 +00001604#include "clang/AST/TypeNodes.def"
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001605 llvm_unreachable("unexpected dependent type!");
Mike Stump11289f42009-09-09 15:08:12 +00001606
John McCall23c29fe2011-06-24 21:55:10 +00001607 // These types are never variably-modified.
1608 case Type::Builtin:
1609 case Type::Complex:
1610 case Type::Vector:
1611 case Type::ExtVector:
1612 case Type::Record:
1613 case Type::Enum:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001614 case Type::Elaborated:
1615 case Type::TemplateSpecialization:
John McCall23c29fe2011-06-24 21:55:10 +00001616 case Type::ObjCObject:
1617 case Type::ObjCInterface:
1618 case Type::ObjCObjectPointer:
1619 llvm_unreachable("type class is never variably-modified!");
Mike Stump11289f42009-09-09 15:08:12 +00001620
Reid Kleckner0503a872013-12-05 01:23:43 +00001621 case Type::Adjusted:
1622 type = cast<AdjustedType>(ty)->getAdjustedType();
1623 break;
1624
Reid Kleckner8a365022013-06-24 17:51:48 +00001625 case Type::Decayed:
1626 type = cast<DecayedType>(ty)->getPointeeType();
1627 break;
1628
John McCall23c29fe2011-06-24 21:55:10 +00001629 case Type::Pointer:
1630 type = cast<PointerType>(ty)->getPointeeType();
1631 break;
Mike Stump11289f42009-09-09 15:08:12 +00001632
John McCall23c29fe2011-06-24 21:55:10 +00001633 case Type::BlockPointer:
1634 type = cast<BlockPointerType>(ty)->getPointeeType();
1635 break;
1636
1637 case Type::LValueReference:
1638 case Type::RValueReference:
1639 type = cast<ReferenceType>(ty)->getPointeeType();
1640 break;
1641
1642 case Type::MemberPointer:
1643 type = cast<MemberPointerType>(ty)->getPointeeType();
1644 break;
1645
1646 case Type::ConstantArray:
1647 case Type::IncompleteArray:
1648 // Losing element qualification here is fine.
1649 type = cast<ArrayType>(ty)->getElementType();
1650 break;
1651
1652 case Type::VariableArray: {
1653 // Losing element qualification here is fine.
1654 const VariableArrayType *vat = cast<VariableArrayType>(ty);
1655
1656 // Unknown size indication requires no size computation.
1657 // Otherwise, evaluate and record it.
1658 if (const Expr *size = vat->getSizeExpr()) {
1659 // It's possible that we might have emitted this already,
1660 // e.g. with a typedef and a pointer to it.
1661 llvm::Value *&entry = VLASizeMap[size];
1662 if (!entry) {
Richard Smith481652b2012-10-10 01:11:12 +00001663 llvm::Value *Size = EmitScalarExpr(size);
1664
1665 // C11 6.7.6.2p5:
1666 // If the size is an expression that is not an integer constant
1667 // expression [...] each time it is evaluated it shall have a value
1668 // greater than zero.
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001669 if (SanOpts.has(SanitizerKind::VLABound) &&
Richard Smithb1b0ab42012-11-05 22:21:05 +00001670 size->getType()->isSignedIntegerType()) {
Alexey Samsonov24cad992014-07-17 18:46:27 +00001671 SanitizerScope SanScope(this);
Richard Smith481652b2012-10-10 01:11:12 +00001672 llvm::Value *Zero = llvm::Constant::getNullValue(Size->getType());
1673 llvm::Constant *StaticArgs[] = {
1674 EmitCheckSourceLocation(size->getLocStart()),
1675 EmitCheckTypeDescriptor(size->getType())
1676 };
Alexey Samsonove396bfc2014-11-11 22:03:54 +00001677 EmitCheck(std::make_pair(Builder.CreateICmpSGT(Size, Zero),
1678 SanitizerKind::VLABound),
1679 "vla_bound_not_positive", StaticArgs, Size);
Richard Smith481652b2012-10-10 01:11:12 +00001680 }
1681
John McCall23c29fe2011-06-24 21:55:10 +00001682 // Always zexting here would be wrong if it weren't
1683 // undefined behavior to have a negative bound.
Richard Smith8772bd82012-10-10 01:12:11 +00001684 entry = Builder.CreateIntCast(Size, SizeTy, /*signed*/ false);
John McCall23c29fe2011-06-24 21:55:10 +00001685 }
1686 }
1687 type = vat->getElementType();
1688 break;
Anders Carlsson8a01b792008-12-20 20:46:34 +00001689 }
Mike Stump11289f42009-09-09 15:08:12 +00001690
Abramo Bagnara1cd83682012-01-07 10:52:36 +00001691 case Type::FunctionProto:
John McCall23c29fe2011-06-24 21:55:10 +00001692 case Type::FunctionNoProto:
Alp Toker314cc812014-01-25 16:55:45 +00001693 type = cast<FunctionType>(ty)->getReturnType();
John McCall23c29fe2011-06-24 21:55:10 +00001694 break;
Eli Friedman0dfb8892011-10-06 23:00:33 +00001695
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001696 case Type::Paren:
1697 case Type::TypeOf:
1698 case Type::UnaryTransform:
1699 case Type::Attributed:
1700 case Type::SubstTemplateTypeParm:
David Blaikie66ed89d2013-07-13 21:08:08 +00001701 case Type::PackExpansion:
Abramo Bagnarafa95ed42012-01-11 08:19:46 +00001702 // Keep walking after single level desugaring.
1703 type = type.getSingleStepDesugaredType(getContext());
1704 break;
1705
1706 case Type::Typedef:
1707 case Type::Decltype:
1708 case Type::Auto:
1709 // Stop walking: nothing to do.
1710 return;
1711
1712 case Type::TypeOfExpr:
1713 // Stop walking: emit typeof expression.
1714 EmitIgnoredExpr(cast<TypeOfExprType>(ty)->getUnderlyingExpr());
1715 return;
1716
Eli Friedman0dfb8892011-10-06 23:00:33 +00001717 case Type::Atomic:
1718 type = cast<AtomicType>(ty)->getValueType();
1719 break;
John McCall23c29fe2011-06-24 21:55:10 +00001720 }
1721 } while (type->isVariablyModifiedType());
Anders Carlssonccbe9202008-12-12 07:19:02 +00001722}
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001723
John McCall7f416cc2015-09-08 08:05:57 +00001724Address CodeGenFunction::EmitVAListRef(const Expr* E) {
Dan Gohmane9e32dc2010-10-29 22:47:07 +00001725 if (getContext().getBuiltinVaListType()->isArrayType())
John McCall7f416cc2015-09-08 08:05:57 +00001726 return EmitPointerWithAlignment(E);
Eli Friedmanddea0ad2009-01-20 17:46:04 +00001727 return EmitLValue(E).getAddress();
1728}
Anders Carlsson15cb75a2009-02-07 22:53:43 +00001729
Charles Davisc7d5c942015-09-17 20:55:33 +00001730Address CodeGenFunction::EmitMSVAListRef(const Expr *E) {
1731 return EmitLValue(E).getAddress();
1732}
1733
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00001734void CodeGenFunction::EmitDeclRefExprDbgValue(const DeclRefExpr *E,
1735 llvm::Constant *Init) {
Devang Pateldc866e12010-08-10 17:53:33 +00001736 assert (Init && "Invalid DeclRefExpr initializer!");
Yunzhong Gao0ebf1bb2013-08-30 08:53:09 +00001737 if (CGDebugInfo *Dbg = getDebugInfo())
1738 if (CGM.getCodeGenOpts().getDebugInfo() >= CodeGenOptions::LimitedDebugInfo)
1739 Dbg->EmitGlobalVariable(E->getDecl(), Init);
Devang Patele03edfd2010-08-10 07:24:25 +00001740}
John McCallc07a0c72011-02-17 10:25:35 +00001741
1742CodeGenFunction::PeepholeProtection
1743CodeGenFunction::protectFromPeepholes(RValue rvalue) {
1744 // At the moment, the only aggressive peephole we do in IR gen
1745 // is trunc(zext) folding, but if we add more, we can easily
1746 // extend this protection.
1747
1748 if (!rvalue.isScalar()) return PeepholeProtection();
1749 llvm::Value *value = rvalue.getScalarVal();
1750 if (!isa<llvm::ZExtInst>(value)) return PeepholeProtection();
1751
1752 // Just make an extra bitcast.
1753 assert(HaveInsertPoint());
1754 llvm::Instruction *inst = new llvm::BitCastInst(value, value->getType(), "",
1755 Builder.GetInsertBlock());
1756
1757 PeepholeProtection protection;
1758 protection.Inst = inst;
1759 return protection;
1760}
1761
1762void CodeGenFunction::unprotectFromPeepholes(PeepholeProtection protection) {
1763 if (!protection.Inst) return;
1764
1765 // In theory, we could try to duplicate the peepholes now, but whatever.
1766 protection.Inst->eraseFromParent();
1767}
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001768
1769llvm::Value *CodeGenFunction::EmitAnnotationCall(llvm::Value *AnnotationFn,
1770 llvm::Value *AnnotatedVal,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00001771 StringRef AnnotationStr,
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001772 SourceLocation Location) {
1773 llvm::Value *Args[4] = {
1774 AnnotatedVal,
1775 Builder.CreateBitCast(CGM.EmitAnnotationString(AnnotationStr), Int8PtrTy),
1776 Builder.CreateBitCast(CGM.EmitAnnotationUnit(Location), Int8PtrTy),
1777 CGM.EmitAnnotationLineNo(Location)
1778 };
1779 return Builder.CreateCall(AnnotationFn, Args);
1780}
1781
1782void CodeGenFunction::EmitVarAnnotations(const VarDecl *D, llvm::Value *V) {
1783 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
1784 // FIXME We create a new bitcast for every annotation because that's what
1785 // llvm-gcc was doing.
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00001786 for (const auto *I : D->specific_attrs<AnnotateAttr>())
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001787 EmitAnnotationCall(CGM.getIntrinsic(llvm::Intrinsic::var_annotation),
1788 Builder.CreateBitCast(V, CGM.Int8PtrTy, V->getName()),
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00001789 I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001790}
1791
John McCall7f416cc2015-09-08 08:05:57 +00001792Address CodeGenFunction::EmitFieldAnnotations(const FieldDecl *D,
1793 Address Addr) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001794 assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
John McCall7f416cc2015-09-08 08:05:57 +00001795 llvm::Value *V = Addr.getPointer();
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001796 llvm::Type *VTy = V->getType();
1797 llvm::Value *F = CGM.getIntrinsic(llvm::Intrinsic::ptr_annotation,
1798 CGM.Int8PtrTy);
1799
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00001800 for (const auto *I : D->specific_attrs<AnnotateAttr>()) {
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001801 // FIXME Always emit the cast inst so we can differentiate between
1802 // annotation on the first field of a struct and annotation on the struct
1803 // itself.
1804 if (VTy != CGM.Int8PtrTy)
1805 V = Builder.Insert(new llvm::BitCastInst(V, CGM.Int8PtrTy));
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +00001806 V = EmitAnnotationCall(F, V, I->getAnnotation(), D->getLocation());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001807 V = Builder.CreateBitCast(V, VTy);
1808 }
1809
John McCall7f416cc2015-09-08 08:05:57 +00001810 return Address(V, Addr.getAlignment());
Julien Lerouge5a6b6982011-09-09 22:41:49 +00001811}
Ben Langmuir3b4c30b2013-05-09 19:17:11 +00001812
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +00001813CodeGenFunction::CGCapturedStmtInfo::~CGCapturedStmtInfo() { }
Alexander Musman515ad8c2014-05-22 08:54:05 +00001814
Alexey Samsonov24cad992014-07-17 18:46:27 +00001815CodeGenFunction::SanitizerScope::SanitizerScope(CodeGenFunction *CGF)
1816 : CGF(CGF) {
1817 assert(!CGF->IsSanitizerScope);
1818 CGF->IsSanitizerScope = true;
1819}
1820
1821CodeGenFunction::SanitizerScope::~SanitizerScope() {
1822 CGF->IsSanitizerScope = false;
1823}
1824
Alexander Musman515ad8c2014-05-22 08:54:05 +00001825void CodeGenFunction::InsertHelper(llvm::Instruction *I,
1826 const llvm::Twine &Name,
1827 llvm::BasicBlock *BB,
1828 llvm::BasicBlock::iterator InsertPt) const {
1829 LoopStack.InsertHelper(I);
Kostya Serebryany4ee69042014-08-26 02:29:59 +00001830 if (IsSanitizerScope)
1831 CGM.getSanitizerMetadata()->disableSanitizerForInstruction(I);
Alexander Musman515ad8c2014-05-22 08:54:05 +00001832}
1833
1834template <bool PreserveNames>
1835void CGBuilderInserter<PreserveNames>::InsertHelper(
1836 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
1837 llvm::BasicBlock::iterator InsertPt) const {
1838 llvm::IRBuilderDefaultInserter<PreserveNames>::InsertHelper(I, Name, BB,
1839 InsertPt);
1840 if (CGF)
1841 CGF->InsertHelper(I, Name, BB, InsertPt);
1842}
1843
1844#ifdef NDEBUG
1845#define PreserveNames false
1846#else
1847#define PreserveNames true
1848#endif
1849template void CGBuilderInserter<PreserveNames>::InsertHelper(
1850 llvm::Instruction *I, const llvm::Twine &Name, llvm::BasicBlock *BB,
1851 llvm::BasicBlock::iterator InsertPt) const;
1852#undef PreserveNames
Eric Christopherfbfd97e2015-11-12 00:44:07 +00001853
David Blaikie5df253382015-11-12 01:09:58 +00001854static bool hasRequiredFeatures(const SmallVectorImpl<StringRef> &ReqFeatures,
1855 CodeGenModule &CGM, const FunctionDecl *FD) {
1856 // If there aren't any required features listed then go ahead and return.
1857 if (ReqFeatures.empty())
1858 return false;
1859
1860 // Now build up the set of caller features and verify that all the required
1861 // features are there.
1862 llvm::StringMap<bool> CallerFeatureMap;
1863 CGM.getFunctionFeatureMap(CallerFeatureMap, FD);
1864
1865 // If we have at least one of the features in the feature list return
1866 // true, otherwise return false.
1867 return std::all_of(
1868 ReqFeatures.begin(), ReqFeatures.end(), [&](StringRef Feature) {
1869 SmallVector<StringRef, 1> OrFeatures;
1870 Feature.split(OrFeatures, "|");
1871 return std::any_of(OrFeatures.begin(), OrFeatures.end(),
1872 [&](StringRef Feature) {
1873 return CallerFeatureMap.lookup(Feature);
1874 });
1875 });
1876}
1877
Eric Christopher2b2d56f2015-11-12 00:44:12 +00001878// Emits an error if we don't have a valid set of target features for the
1879// called function.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00001880void CodeGenFunction::checkTargetFeatures(const CallExpr *E,
1881 const FunctionDecl *TargetDecl) {
1882 // Early exit if this is an indirect call.
1883 if (!TargetDecl)
1884 return;
1885
1886 // Get the current enclosing function if it exists. If it doesn't
1887 // we can't check the target features anyhow.
1888 const FunctionDecl *FD = dyn_cast_or_null<FunctionDecl>(CurFuncDecl);
1889 if (!FD)
1890 return;
1891
Eric Christopher2b2d56f2015-11-12 00:44:12 +00001892 // Grab the required features for the call. For a builtin this is listed in
1893 // the td file with the default cpu, for an always_inline function this is any
1894 // listed cpu and any listed features.
Eric Christopherfbfd97e2015-11-12 00:44:07 +00001895 unsigned BuiltinID = TargetDecl->getBuiltinID();
Eric Christopher2b2d56f2015-11-12 00:44:12 +00001896 if (BuiltinID) {
1897 SmallVector<StringRef, 1> ReqFeatures;
1898 const char *FeatureList =
1899 CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
1900 // Return if the builtin doesn't have any required features.
1901 if (!FeatureList || StringRef(FeatureList) == "")
1902 return;
1903 StringRef(FeatureList).split(ReqFeatures, ",");
Eric Christopherfbfd97e2015-11-12 00:44:07 +00001904
David Blaikie5df253382015-11-12 01:09:58 +00001905 if (!hasRequiredFeatures(ReqFeatures, CGM, FD))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00001906 CGM.getDiags().Report(E->getLocStart(), diag::err_builtin_needs_feature)
1907 << TargetDecl->getDeclName()
1908 << CGM.getContext().BuiltinInfo.getRequiredFeatures(BuiltinID);
1909
1910 } else if (TargetDecl->hasAttr<TargetAttr>()) {
1911 // Get the required features for the callee.
1912 SmallVector<StringRef, 1> ReqFeatures;
1913 llvm::StringMap<bool> CalleeFeatureMap;
1914 CGM.getFunctionFeatureMap(CalleeFeatureMap, TargetDecl);
1915 for (const auto &F : CalleeFeatureMap)
1916 ReqFeatures.push_back(F.getKey());
David Blaikie5df253382015-11-12 01:09:58 +00001917 if (!hasRequiredFeatures(ReqFeatures, CGM, FD))
Eric Christopher2b2d56f2015-11-12 00:44:12 +00001918 CGM.getDiags().Report(E->getLocStart(), diag::err_function_needs_feature)
1919 << FD->getDeclName() << TargetDecl->getDeclName();
1920 }
Eric Christopherfbfd97e2015-11-12 00:44:07 +00001921}