blob: a68d5109baf81e33f6e0f3c8a0ef41a494498bde [file] [log] [blame]
Anders Carlsson59486a22009-11-24 05:51:11 +00001//===--- CGExprCXX.cpp - Emit LLVM Code for C++ expressions ---------------===//
Anders Carlssoncc52f652009-09-22 22:53:17 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Anders Carlssoncc52f652009-09-22 22:53:17 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This contains code dealing with code generation of C++ expressions
10//
11//===----------------------------------------------------------------------===//
12
Peter Collingbournefe883422011-10-06 18:29:37 +000013#include "CGCUDARuntime.h"
John McCall5d865c322010-08-31 07:33:07 +000014#include "CGCXXABI.h"
Devang Patel91bbb552010-09-30 19:05:55 +000015#include "CGDebugInfo.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000016#include "CGObjCRuntime.h"
Marco Antognini88559632019-07-22 09:39:13 +000017#include "CodeGenFunction.h"
John McCallde0fe072017-08-15 21:42:52 +000018#include "ConstantEmitter.h"
Marco Antognini88559632019-07-22 09:39:13 +000019#include "TargetInfo.h"
Richard Trieu63688182018-12-11 03:18:39 +000020#include "clang/Basic/CodeGenOptions.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000021#include "clang/CodeGen/CGFunctionInfo.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000022#include "llvm/IR/Intrinsics.h"
Anders Carlssonbbe277c2011-04-13 02:35:36 +000023
Anders Carlssoncc52f652009-09-22 22:53:17 +000024using namespace clang;
25using namespace CodeGen;
26
George Burgess IVd0a9e802017-02-23 22:07:35 +000027namespace {
28struct MemberCallInfo {
29 RequiredArgs ReqArgs;
30 // Number of prefix arguments for the call. Ignores the `this` pointer.
31 unsigned PrefixSize;
32};
33}
34
35static MemberCallInfo
Alexey Samsonovefa956c2016-03-10 00:20:33 +000036commonEmitCXXMemberOrOperatorCall(CodeGenFunction &CGF, const CXXMethodDecl *MD,
37 llvm::Value *This, llvm::Value *ImplicitParam,
38 QualType ImplicitParamTy, const CallExpr *CE,
Richard Smith762672a2016-09-28 19:09:10 +000039 CallArgList &Args, CallArgList *RtlArgs) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000040 assert(CE == nullptr || isa<CXXMemberCallExpr>(CE) ||
41 isa<CXXOperatorCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +000042 assert(MD->isInstance() &&
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000043 "Trying to emit a member or operator call expr on a static method!");
Anders Carlsson27da15b2010-01-01 20:29:01 +000044
Anders Carlsson27da15b2010-01-01 20:29:01 +000045 // Push the this ptr.
Reid Kleckner034e7272016-09-07 15:15:51 +000046 const CXXRecordDecl *RD =
47 CGF.CGM.getCXXABI().getThisArgumentTypeForMethod(MD);
James Y Knightb92d2902019-02-05 16:05:50 +000048 Args.add(RValue::get(This), CGF.getTypes().DeriveThisType(RD, MD));
Anders Carlsson27da15b2010-01-01 20:29:01 +000049
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +000050 // If there is an implicit parameter (e.g. VTT), emit it.
51 if (ImplicitParam) {
52 Args.add(RValue::get(ImplicitParam), ImplicitParamTy);
Anders Carlssone36a6b32010-01-02 01:01:18 +000053 }
John McCalla729c622012-02-17 03:33:10 +000054
55 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
James Y Knight916db652019-02-02 01:48:23 +000056 RequiredArgs required = RequiredArgs::forPrototypePlus(FPT, Args.size());
George Burgess IVd0a9e802017-02-23 22:07:35 +000057 unsigned PrefixSize = Args.size() - 1;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000058
John McCalla729c622012-02-17 03:33:10 +000059 // And the rest of the call args.
Richard Smith762672a2016-09-28 19:09:10 +000060 if (RtlArgs) {
61 // Special case: if the caller emitted the arguments right-to-left already
62 // (prior to emitting the *this argument), we're done. This happens for
63 // assignment operators.
64 Args.addFrom(*RtlArgs);
65 } else if (CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000066 // Special case: skip first argument of CXXOperatorCall (it is "this").
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000067 unsigned ArgsToSkip = isa<CXXOperatorCallExpr>(CE) ? 1 : 0;
David Blaikief05779e2015-07-21 18:37:18 +000068 CGF.EmitCallArgs(Args, FPT, drop_begin(CE->arguments(), ArgsToSkip),
David Majnemer0c0b6d92014-10-31 20:09:12 +000069 CE->getDirectCallee());
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000070 } else {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000071 assert(
72 FPT->getNumParams() == 0 &&
73 "No CallExpr specified for function with non-zero number of arguments");
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000074 }
George Burgess IVd0a9e802017-02-23 22:07:35 +000075 return {required, PrefixSize};
David Majnemer0c0b6d92014-10-31 20:09:12 +000076}
Anders Carlsson27da15b2010-01-01 20:29:01 +000077
David Majnemer0c0b6d92014-10-31 20:09:12 +000078RValue CodeGenFunction::EmitCXXMemberOrOperatorCall(
John McCallb92ab1a2016-10-26 23:46:34 +000079 const CXXMethodDecl *MD, const CGCallee &Callee,
80 ReturnValueSlot ReturnValue,
David Majnemer0c0b6d92014-10-31 20:09:12 +000081 llvm::Value *This, llvm::Value *ImplicitParam, QualType ImplicitParamTy,
Richard Smith762672a2016-09-28 19:09:10 +000082 const CallExpr *CE, CallArgList *RtlArgs) {
David Majnemer0c0b6d92014-10-31 20:09:12 +000083 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
84 CallArgList Args;
George Burgess IVd0a9e802017-02-23 22:07:35 +000085 MemberCallInfo CallInfo = commonEmitCXXMemberOrOperatorCall(
Richard Smith762672a2016-09-28 19:09:10 +000086 *this, MD, This, ImplicitParam, ImplicitParamTy, CE, Args, RtlArgs);
George Burgess IVd0a9e802017-02-23 22:07:35 +000087 auto &FnInfo = CGM.getTypes().arrangeCXXMethodCall(
88 Args, FPT, CallInfo.ReqArgs, CallInfo.PrefixSize);
Vedant Kumar09b5bfd2017-12-21 00:10:25 +000089 return EmitCall(FnInfo, Callee, ReturnValue, Args, nullptr,
90 CE ? CE->getExprLoc() : SourceLocation());
Anders Carlsson27da15b2010-01-01 20:29:01 +000091}
92
Alexey Samsonovae81bbb2016-03-10 00:20:37 +000093RValue CodeGenFunction::EmitCXXDestructorCall(
Marco Antognini88559632019-07-22 09:39:13 +000094 GlobalDecl Dtor, const CGCallee &Callee, llvm::Value *This, QualType ThisTy,
Peter Collingbourned1c5b282019-03-22 23:05:10 +000095 llvm::Value *ImplicitParam, QualType ImplicitParamTy, const CallExpr *CE) {
Marco Antognini88559632019-07-22 09:39:13 +000096 const CXXMethodDecl *DtorDecl = cast<CXXMethodDecl>(Dtor.getDecl());
97
98 assert(!ThisTy.isNull());
99 assert(ThisTy->getAsCXXRecordDecl() == DtorDecl->getParent() &&
100 "Pointer/Object mixup");
101
102 LangAS SrcAS = ThisTy.getAddressSpace();
103 LangAS DstAS = DtorDecl->getMethodQualifiers().getAddressSpace();
104 if (SrcAS != DstAS) {
105 QualType DstTy = DtorDecl->getThisType();
106 llvm::Type *NewType = CGM.getTypes().ConvertType(DstTy);
107 This = getTargetHooks().performAddrSpaceCast(*this, This, SrcAS, DstAS,
108 NewType);
109 }
110
David Majnemer0c0b6d92014-10-31 20:09:12 +0000111 CallArgList Args;
Marco Antognini88559632019-07-22 09:39:13 +0000112 commonEmitCXXMemberOrOperatorCall(*this, DtorDecl, This, ImplicitParam,
113 ImplicitParamTy, CE, Args, nullptr);
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000114 return EmitCall(CGM.getTypes().arrangeCXXStructorDeclaration(Dtor), Callee,
Erich Keane30588a72020-04-08 13:14:33 -0700115 ReturnValueSlot(), Args, nullptr,
116 CE ? CE->getExprLoc() : SourceLocation{});
John McCallb92ab1a2016-10-26 23:46:34 +0000117}
118
119RValue CodeGenFunction::EmitCXXPseudoDestructorExpr(
120 const CXXPseudoDestructorExpr *E) {
121 QualType DestroyedType = E->getDestroyedType();
122 if (DestroyedType.hasStrongOrWeakObjCLifetime()) {
123 // Automatic Reference Counting:
124 // If the pseudo-expression names a retainable object with weak or
125 // strong lifetime, the object shall be released.
126 Expr *BaseExpr = E->getBase();
127 Address BaseValue = Address::invalid();
128 Qualifiers BaseQuals;
129
130 // If this is s.x, emit s as an lvalue. If it is s->x, emit s as a scalar.
131 if (E->isArrow()) {
132 BaseValue = EmitPointerWithAlignment(BaseExpr);
Simon Pilgrim16c53ff2020-01-11 15:33:25 +0000133 const auto *PTy = BaseExpr->getType()->castAs<PointerType>();
John McCallb92ab1a2016-10-26 23:46:34 +0000134 BaseQuals = PTy->getPointeeType().getQualifiers();
135 } else {
136 LValue BaseLV = EmitLValue(BaseExpr);
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800137 BaseValue = BaseLV.getAddress(*this);
John McCallb92ab1a2016-10-26 23:46:34 +0000138 QualType BaseTy = BaseExpr->getType();
139 BaseQuals = BaseTy.getQualifiers();
140 }
141
142 switch (DestroyedType.getObjCLifetime()) {
143 case Qualifiers::OCL_None:
144 case Qualifiers::OCL_ExplicitNone:
145 case Qualifiers::OCL_Autoreleasing:
146 break;
147
148 case Qualifiers::OCL_Strong:
149 EmitARCRelease(Builder.CreateLoad(BaseValue,
150 DestroyedType.isVolatileQualified()),
151 ARCPreciseLifetime);
152 break;
153
154 case Qualifiers::OCL_Weak:
155 EmitARCDestroyWeak(BaseValue);
156 break;
157 }
158 } else {
159 // C++ [expr.pseudo]p1:
160 // The result shall only be used as the operand for the function call
161 // operator (), and the result of such a call has type void. The only
162 // effect is the evaluation of the postfix-expression before the dot or
163 // arrow.
164 EmitIgnoredExpr(E->getBase());
165 }
166
167 return RValue::get(nullptr);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000168}
169
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000170static CXXRecordDecl *getCXXRecord(const Expr *E) {
171 QualType T = E->getType();
172 if (const PointerType *PTy = T->getAs<PointerType>())
173 T = PTy->getPointeeType();
174 const RecordType *Ty = T->castAs<RecordType>();
175 return cast<CXXRecordDecl>(Ty->getDecl());
176}
177
Francois Pichet64225792011-01-18 05:04:39 +0000178// Note: This function also emit constructor calls to support a MSVC
179// extensions allowing explicit constructor function call.
Anders Carlsson27da15b2010-01-01 20:29:01 +0000180RValue CodeGenFunction::EmitCXXMemberCallExpr(const CXXMemberCallExpr *CE,
181 ReturnValueSlot ReturnValue) {
John McCall2d2e8702011-04-11 07:02:50 +0000182 const Expr *callee = CE->getCallee()->IgnoreParens();
183
184 if (isa<BinaryOperator>(callee))
Anders Carlsson27da15b2010-01-01 20:29:01 +0000185 return EmitCXXMemberPointerCallExpr(CE, ReturnValue);
John McCall2d2e8702011-04-11 07:02:50 +0000186
187 const MemberExpr *ME = cast<MemberExpr>(callee);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000188 const CXXMethodDecl *MD = cast<CXXMethodDecl>(ME->getMemberDecl());
189
190 if (MD->isStatic()) {
191 // The method is static, emit it as we would a regular call.
Erich Keanede6480a32018-11-13 15:48:08 +0000192 CGCallee callee =
193 CGCallee::forDirect(CGM.GetAddrOfFunction(MD), GlobalDecl(MD));
John McCallb92ab1a2016-10-26 23:46:34 +0000194 return EmitCall(getContext().getPointerType(MD->getType()), callee, CE,
Alexey Samsonov70b9c012014-08-21 20:26:47 +0000195 ReturnValue);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000196 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000197
Nico Weberaad4af62014-12-03 01:21:41 +0000198 bool HasQualifier = ME->hasQualifier();
199 NestedNameSpecifier *Qualifier = HasQualifier ? ME->getQualifier() : nullptr;
200 bool IsArrow = ME->isArrow();
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000201 const Expr *Base = ME->getBase();
Nico Weberaad4af62014-12-03 01:21:41 +0000202
203 return EmitCXXMemberOrOperatorMemberCallExpr(
204 CE, MD, ReturnValue, HasQualifier, Qualifier, IsArrow, Base);
205}
206
207RValue CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(
208 const CallExpr *CE, const CXXMethodDecl *MD, ReturnValueSlot ReturnValue,
209 bool HasQualifier, NestedNameSpecifier *Qualifier, bool IsArrow,
210 const Expr *Base) {
211 assert(isa<CXXMemberCallExpr>(CE) || isa<CXXOperatorCallExpr>(CE));
212
213 // Compute the object pointer.
214 bool CanUseVirtualCall = MD->isVirtual() && !HasQualifier;
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000215
Craig Topper8a13c412014-05-21 05:09:00 +0000216 const CXXMethodDecl *DevirtualizedMethod = nullptr;
Akira Hatanaka22461672017-07-13 06:08:27 +0000217 if (CanUseVirtualCall &&
218 MD->getDevirtualizedMethod(Base, getLangOpts().AppleKext)) {
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000219 const CXXRecordDecl *BestDynamicDecl = Base->getBestDynamicClassType();
220 DevirtualizedMethod = MD->getCorrespondingMethodInClass(BestDynamicDecl);
221 assert(DevirtualizedMethod);
222 const CXXRecordDecl *DevirtualizedClass = DevirtualizedMethod->getParent();
223 const Expr *Inner = Base->ignoreParenBaseCasts();
Alexey Bataev5bd68792014-09-29 10:32:21 +0000224 if (DevirtualizedMethod->getReturnType().getCanonicalType() !=
225 MD->getReturnType().getCanonicalType())
226 // If the return types are not the same, this might be a case where more
227 // code needs to run to compensate for it. For example, the derived
228 // method might return a type that inherits form from the return
229 // type of MD and has a prefix.
230 // For now we just avoid devirtualizing these covariant cases.
231 DevirtualizedMethod = nullptr;
232 else if (getCXXRecord(Inner) == DevirtualizedClass)
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000233 // If the class of the Inner expression is where the dynamic method
234 // is defined, build the this pointer from it.
235 Base = Inner;
236 else if (getCXXRecord(Base) != DevirtualizedClass) {
237 // If the method is defined in a class that is not the best dynamic
238 // one or the one of the full expression, we would have to build
239 // a derived-to-base cast to compute the correct this pointer, but
240 // we don't have support for that yet, so do a virtual call.
Craig Topper8a13c412014-05-21 05:09:00 +0000241 DevirtualizedMethod = nullptr;
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000242 }
243 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000244
Richard Smith3ced2392019-12-18 14:01:40 -0800245 bool TrivialForCodegen =
246 MD->isTrivial() || (MD->isDefaulted() && MD->getParent()->isUnion());
247 bool TrivialAssignment =
248 TrivialForCodegen &&
249 (MD->isCopyAssignmentOperator() || MD->isMoveAssignmentOperator()) &&
250 !MD->getParent()->mayInsertExtraPadding();
251
Richard Smith762672a2016-09-28 19:09:10 +0000252 // C++17 demands that we evaluate the RHS of a (possibly-compound) assignment
253 // operator before the LHS.
254 CallArgList RtlArgStorage;
255 CallArgList *RtlArgs = nullptr;
Richard Smith3ced2392019-12-18 14:01:40 -0800256 LValue TrivialAssignmentRHS;
Richard Smith762672a2016-09-28 19:09:10 +0000257 if (auto *OCE = dyn_cast<CXXOperatorCallExpr>(CE)) {
258 if (OCE->isAssignmentOp()) {
Richard Smith3ced2392019-12-18 14:01:40 -0800259 if (TrivialAssignment) {
260 TrivialAssignmentRHS = EmitLValue(CE->getArg(1));
261 } else {
262 RtlArgs = &RtlArgStorage;
263 EmitCallArgs(*RtlArgs, MD->getType()->castAs<FunctionProtoType>(),
264 drop_begin(CE->arguments(), 1), CE->getDirectCallee(),
265 /*ParamsToSkip*/0, EvaluationOrder::ForceRightToLeft);
266 }
Richard Smith762672a2016-09-28 19:09:10 +0000267 }
268 }
269
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000270 LValue This;
271 if (IsArrow) {
272 LValueBaseInfo BaseInfo;
273 TBAAAccessInfo TBAAInfo;
274 Address ThisValue = EmitPointerWithAlignment(Base, &BaseInfo, &TBAAInfo);
275 This = MakeAddrLValue(ThisValue, Base->getType(), BaseInfo, TBAAInfo);
276 } else {
277 This = EmitLValue(Base);
278 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000279
James Y Knightab4f7f12019-02-06 00:06:03 +0000280 if (const CXXConstructorDecl *Ctor = dyn_cast<CXXConstructorDecl>(MD)) {
281 // This is the MSVC p->Ctor::Ctor(...) extension. We assume that's
282 // constructing a new complete object of type Ctor.
283 assert(!RtlArgs);
284 assert(ReturnValue.isNull() && "Constructor shouldn't have return value");
285 CallArgList Args;
286 commonEmitCXXMemberOrOperatorCall(
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800287 *this, Ctor, This.getPointer(*this), /*ImplicitParam=*/nullptr,
James Y Knightab4f7f12019-02-06 00:06:03 +0000288 /*ImplicitParamTy=*/QualType(), CE, Args, nullptr);
289
290 EmitCXXConstructorCall(Ctor, Ctor_Complete, /*ForVirtualBase=*/false,
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800291 /*Delegating=*/false, This.getAddress(*this), Args,
James Y Knightab4f7f12019-02-06 00:06:03 +0000292 AggValueSlot::DoesNotOverlap, CE->getExprLoc(),
293 /*NewPointerIsChecked=*/false);
294 return RValue::get(nullptr);
295 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000296
Richard Smith3ced2392019-12-18 14:01:40 -0800297 if (TrivialForCodegen) {
298 if (isa<CXXDestructorDecl>(MD))
299 return RValue::get(nullptr);
300
301 if (TrivialAssignment) {
302 // We don't like to generate the trivial copy/move assignment operator
303 // when it isn't necessary; just produce the proper effect here.
304 // It's important that we use the result of EmitLValue here rather than
305 // emitting call arguments, in order to preserve TBAA information from
306 // the RHS.
307 LValue RHS = isa<CXXOperatorCallExpr>(CE)
308 ? TrivialAssignmentRHS
309 : EmitLValue(*CE->arg_begin());
310 EmitAggregateAssign(This, RHS, CE->getType());
311 return RValue::get(This.getPointer(*this));
Francois Pichet64225792011-01-18 05:04:39 +0000312 }
Richard Smith3ced2392019-12-18 14:01:40 -0800313
314 assert(MD->getParent()->mayInsertExtraPadding() &&
315 "unknown trivial member function");
Anders Carlsson27da15b2010-01-01 20:29:01 +0000316 }
317
John McCall0d635f52010-09-03 01:26:39 +0000318 // Compute the function type we're calling.
Nico Weber3abfe952014-12-02 20:41:18 +0000319 const CXXMethodDecl *CalleeDecl =
320 DevirtualizedMethod ? DevirtualizedMethod : MD;
Craig Topper8a13c412014-05-21 05:09:00 +0000321 const CGFunctionInfo *FInfo = nullptr;
Nico Weber3abfe952014-12-02 20:41:18 +0000322 if (const auto *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000323 FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000324 GlobalDecl(Dtor, Dtor_Complete));
Francois Pichet64225792011-01-18 05:04:39 +0000325 else
Eli Friedmanade60972012-10-25 00:12:49 +0000326 FInfo = &CGM.getTypes().arrangeCXXMethodDeclaration(CalleeDecl);
John McCall0d635f52010-09-03 01:26:39 +0000327
Reid Klecknere7de47e2013-07-22 13:51:44 +0000328 llvm::FunctionType *Ty = CGM.getTypes().GetFunctionType(*FInfo);
John McCall0d635f52010-09-03 01:26:39 +0000329
Ivan Krasind98f5d72016-11-17 00:39:48 +0000330 // C++11 [class.mfct.non-static]p2:
331 // If a non-static member function of a class X is called for an object that
332 // is not of type X, or of a type derived from X, the behavior is undefined.
333 SourceLocation CallLoc;
334 ASTContext &C = getContext();
335 if (CE)
336 CallLoc = CE->getExprLoc();
337
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000338 SanitizerSet SkippedChecks;
Vedant Kumarffd7c882017-04-14 22:03:34 +0000339 if (const auto *CMCE = dyn_cast<CXXMemberCallExpr>(CE)) {
340 auto *IOA = CMCE->getImplicitObjectArgument();
341 bool IsImplicitObjectCXXThis = IsWrappedCXXThis(IOA);
342 if (IsImplicitObjectCXXThis)
343 SkippedChecks.set(SanitizerKind::Alignment, true);
344 if (IsImplicitObjectCXXThis || isa<DeclRefExpr>(IOA))
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000345 SkippedChecks.set(SanitizerKind::Null, true);
Vedant Kumarffd7c882017-04-14 22:03:34 +0000346 }
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800347 EmitTypeCheck(CodeGenFunction::TCK_MemberCall, CallLoc,
348 This.getPointer(*this),
James Y Knightab4f7f12019-02-06 00:06:03 +0000349 C.getRecordType(CalleeDecl->getParent()),
350 /*Alignment=*/CharUnits::Zero(), SkippedChecks);
Ivan Krasind98f5d72016-11-17 00:39:48 +0000351
Anders Carlsson27da15b2010-01-01 20:29:01 +0000352 // C++ [class.virtual]p12:
353 // Explicit qualification with the scope operator (5.1) suppresses the
354 // virtual call mechanism.
355 //
356 // We also don't emit a virtual call if the base expression has a record type
357 // because then we know what the type is.
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000358 bool UseVirtualCall = CanUseVirtualCall && !DevirtualizedMethod;
Fangrui Song6907ce22018-07-30 19:24:48 +0000359
James Y Knightb92d2902019-02-05 16:05:50 +0000360 if (const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl)) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000361 assert(CE->arg_begin() == CE->arg_end() &&
362 "Destructor shouldn't have explicit parameters");
363 assert(ReturnValue.isNull() && "Destructor shouldn't have return value");
John McCall0d635f52010-09-03 01:26:39 +0000364 if (UseVirtualCall) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800365 CGM.getCXXABI().EmitVirtualDestructorCall(*this, Dtor, Dtor_Complete,
366 This.getAddress(*this),
367 cast<CXXMemberCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000368 } else {
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000369 GlobalDecl GD(Dtor, Dtor_Complete);
John McCallb92ab1a2016-10-26 23:46:34 +0000370 CGCallee Callee;
James Y Knightb92d2902019-02-05 16:05:50 +0000371 if (getLangOpts().AppleKext && Dtor->isVirtual() && HasQualifier)
372 Callee = BuildAppleKextVirtualCall(Dtor, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000373 else if (!DevirtualizedMethod)
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000374 Callee =
375 CGCallee::forDirect(CGM.getAddrOfCXXStructor(GD, FInfo, Ty), GD);
Rafael Espindola49e860b2012-06-26 17:45:31 +0000376 else {
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000377 Callee = CGCallee::forDirect(CGM.GetAddrOfFunction(GD, Ty), GD);
Rafael Espindola49e860b2012-06-26 17:45:31 +0000378 }
James Y Knightb92d2902019-02-05 16:05:50 +0000379
Marco Antognini88559632019-07-22 09:39:13 +0000380 QualType ThisTy =
381 IsArrow ? Base->getType()->getPointeeType() : Base->getType();
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800382 EmitCXXDestructorCall(GD, Callee, This.getPointer(*this), ThisTy,
James Y Knightb92d2902019-02-05 16:05:50 +0000383 /*ImplicitParam=*/nullptr,
Erich Keane30588a72020-04-08 13:14:33 -0700384 /*ImplicitParamTy=*/QualType(), CE);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000385 }
Craig Topper8a13c412014-05-21 05:09:00 +0000386 return RValue::get(nullptr);
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000387 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000388
James Y Knightb92d2902019-02-05 16:05:50 +0000389 // FIXME: Uses of 'MD' past this point need to be audited. We may need to use
390 // 'CalleeDecl' instead.
391
John McCallb92ab1a2016-10-26 23:46:34 +0000392 CGCallee Callee;
James Y Knightab4f7f12019-02-06 00:06:03 +0000393 if (UseVirtualCall) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800394 Callee = CGCallee::forVirtual(CE, MD, This.getAddress(*this), Ty);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000395 } else {
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000396 if (SanOpts.has(SanitizerKind::CFINVCall) &&
397 MD->getParent()->isDynamicClass()) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000398 llvm::Value *VTable;
399 const CXXRecordDecl *RD;
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800400 std::tie(VTable, RD) = CGM.getCXXABI().LoadVTablePtr(
401 *this, This.getAddress(*this), CalleeDecl->getParent());
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000402 EmitVTablePtrCheckForCall(RD, VTable, CFITCK_NVCall, CE->getBeginLoc());
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000403 }
404
Nico Weberaad4af62014-12-03 01:21:41 +0000405 if (getLangOpts().AppleKext && MD->isVirtual() && HasQualifier)
406 Callee = BuildAppleKextVirtualCall(MD, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000407 else if (!DevirtualizedMethod)
Erich Keanede6480a32018-11-13 15:48:08 +0000408 Callee =
409 CGCallee::forDirect(CGM.GetAddrOfFunction(MD, Ty), GlobalDecl(MD));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000410 else {
Erich Keanede6480a32018-11-13 15:48:08 +0000411 Callee =
412 CGCallee::forDirect(CGM.GetAddrOfFunction(DevirtualizedMethod, Ty),
413 GlobalDecl(DevirtualizedMethod));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000414 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000415 }
416
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000417 if (MD->isVirtual()) {
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000418 Address NewThisAddr =
419 CGM.getCXXABI().adjustThisArgumentForVirtualFunctionCall(
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800420 *this, CalleeDecl, This.getAddress(*this), UseVirtualCall);
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000421 This.setAddress(NewThisAddr);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000422 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000423
Vedant Kumar018f2662016-10-19 20:21:16 +0000424 return EmitCXXMemberOrOperatorCall(
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800425 CalleeDecl, Callee, ReturnValue, This.getPointer(*this),
Vedant Kumar018f2662016-10-19 20:21:16 +0000426 /*ImplicitParam=*/nullptr, QualType(), CE, RtlArgs);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000427}
428
429RValue
430CodeGenFunction::EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
431 ReturnValueSlot ReturnValue) {
432 const BinaryOperator *BO =
433 cast<BinaryOperator>(E->getCallee()->IgnoreParens());
434 const Expr *BaseExpr = BO->getLHS();
435 const Expr *MemFnExpr = BO->getRHS();
Fangrui Song6907ce22018-07-30 19:24:48 +0000436
Simon Pilgrim1cd399c2019-10-03 11:22:48 +0000437 const auto *MPT = MemFnExpr->getType()->castAs<MemberPointerType>();
438 const auto *FPT = MPT->getPointeeType()->castAs<FunctionProtoType>();
439 const auto *RD =
440 cast<CXXRecordDecl>(MPT->getClass()->castAs<RecordType>()->getDecl());
Anders Carlsson27da15b2010-01-01 20:29:01 +0000441
Anders Carlsson27da15b2010-01-01 20:29:01 +0000442 // Emit the 'this' pointer.
John McCall7f416cc2015-09-08 08:05:57 +0000443 Address This = Address::invalid();
John McCalle3027922010-08-25 11:45:40 +0000444 if (BO->getOpcode() == BO_PtrMemI)
John McCall7f416cc2015-09-08 08:05:57 +0000445 This = EmitPointerWithAlignment(BaseExpr);
Fangrui Song6907ce22018-07-30 19:24:48 +0000446 else
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800447 This = EmitLValue(BaseExpr).getAddress(*this);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000448
John McCall7f416cc2015-09-08 08:05:57 +0000449 EmitTypeCheck(TCK_MemberCall, E->getExprLoc(), This.getPointer(),
Richard Smithe30752c2012-10-09 19:52:38 +0000450 QualType(MPT->getClass(), 0));
Richard Smith69d0d262012-08-24 00:54:33 +0000451
Richard Smithbde62d72016-09-26 23:56:57 +0000452 // Get the member function pointer.
453 llvm::Value *MemFnPtr = EmitScalarExpr(MemFnExpr);
454
John McCall475999d2010-08-22 00:05:51 +0000455 // Ask the ABI to load the callee. Note that This is modified.
John McCall7f416cc2015-09-08 08:05:57 +0000456 llvm::Value *ThisPtrForCall = nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +0000457 CGCallee Callee =
John McCall7f416cc2015-09-08 08:05:57 +0000458 CGM.getCXXABI().EmitLoadOfMemberFunctionPointer(*this, BO, This,
459 ThisPtrForCall, MemFnPtr, MPT);
Fangrui Song6907ce22018-07-30 19:24:48 +0000460
Anders Carlsson27da15b2010-01-01 20:29:01 +0000461 CallArgList Args;
462
Fangrui Song6907ce22018-07-30 19:24:48 +0000463 QualType ThisType =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000464 getContext().getPointerType(getContext().getTagDeclType(RD));
465
466 // Push the this ptr.
John McCall7f416cc2015-09-08 08:05:57 +0000467 Args.add(RValue::get(ThisPtrForCall), ThisType);
John McCall8dda7b22012-07-07 06:41:13 +0000468
James Y Knight916db652019-02-02 01:48:23 +0000469 RequiredArgs required = RequiredArgs::forPrototypePlus(FPT, 1);
George Burgess IV419996c2016-06-16 23:06:04 +0000470
Anders Carlsson27da15b2010-01-01 20:29:01 +0000471 // And the rest of the call args
George Burgess IV419996c2016-06-16 23:06:04 +0000472 EmitCallArgs(Args, FPT, E->arguments());
George Burgess IVd0a9e802017-02-23 22:07:35 +0000473 return EmitCall(CGM.getTypes().arrangeCXXMethodCall(Args, FPT, required,
474 /*PrefixSize=*/0),
Vedant Kumar09b5bfd2017-12-21 00:10:25 +0000475 Callee, ReturnValue, Args, nullptr, E->getExprLoc());
Anders Carlsson27da15b2010-01-01 20:29:01 +0000476}
477
478RValue
479CodeGenFunction::EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
480 const CXXMethodDecl *MD,
481 ReturnValueSlot ReturnValue) {
482 assert(MD->isInstance() &&
483 "Trying to emit a member call expr on a static method!");
Nico Weberaad4af62014-12-03 01:21:41 +0000484 return EmitCXXMemberOrOperatorMemberCallExpr(
485 E, MD, ReturnValue, /*HasQualifier=*/false, /*Qualifier=*/nullptr,
486 /*IsArrow=*/false, E->getArg(0));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000487}
488
Peter Collingbournefe883422011-10-06 18:29:37 +0000489RValue CodeGenFunction::EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
490 ReturnValueSlot ReturnValue) {
491 return CGM.getCUDARuntime().EmitCUDAKernelCallExpr(*this, E, ReturnValue);
492}
493
Eli Friedmanfde961d2011-10-14 02:27:24 +0000494static void EmitNullBaseClassInitialization(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000495 Address DestPtr,
Eli Friedmanfde961d2011-10-14 02:27:24 +0000496 const CXXRecordDecl *Base) {
497 if (Base->isEmpty())
498 return;
499
John McCall7f416cc2015-09-08 08:05:57 +0000500 DestPtr = CGF.Builder.CreateElementBitCast(DestPtr, CGF.Int8Ty);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000501
502 const ASTRecordLayout &Layout = CGF.getContext().getASTRecordLayout(Base);
David Majnemer8671c6e2015-11-02 09:01:44 +0000503 CharUnits NVSize = Layout.getNonVirtualSize();
504
505 // We cannot simply zero-initialize the entire base sub-object if vbptrs are
506 // present, they are initialized by the most derived class before calling the
507 // constructor.
508 SmallVector<std::pair<CharUnits, CharUnits>, 1> Stores;
509 Stores.emplace_back(CharUnits::Zero(), NVSize);
510
511 // Each store is split by the existence of a vbptr.
512 CharUnits VBPtrWidth = CGF.getPointerSize();
513 std::vector<CharUnits> VBPtrOffsets =
514 CGF.CGM.getCXXABI().getVBPtrOffsets(Base);
515 for (CharUnits VBPtrOffset : VBPtrOffsets) {
David Majnemer7f980d82016-05-12 03:51:52 +0000516 // Stop before we hit any virtual base pointers located in virtual bases.
517 if (VBPtrOffset >= NVSize)
518 break;
David Majnemer8671c6e2015-11-02 09:01:44 +0000519 std::pair<CharUnits, CharUnits> LastStore = Stores.pop_back_val();
520 CharUnits LastStoreOffset = LastStore.first;
521 CharUnits LastStoreSize = LastStore.second;
522
523 CharUnits SplitBeforeOffset = LastStoreOffset;
524 CharUnits SplitBeforeSize = VBPtrOffset - SplitBeforeOffset;
525 assert(!SplitBeforeSize.isNegative() && "negative store size!");
526 if (!SplitBeforeSize.isZero())
527 Stores.emplace_back(SplitBeforeOffset, SplitBeforeSize);
528
529 CharUnits SplitAfterOffset = VBPtrOffset + VBPtrWidth;
530 CharUnits SplitAfterSize = LastStoreSize - SplitAfterOffset;
531 assert(!SplitAfterSize.isNegative() && "negative store size!");
532 if (!SplitAfterSize.isZero())
533 Stores.emplace_back(SplitAfterOffset, SplitAfterSize);
534 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000535
536 // If the type contains a pointer to data member we can't memset it to zero.
537 // Instead, create a null constant and copy it to the destination.
538 // TODO: there are other patterns besides zero that we can usefully memset,
539 // like -1, which happens to be the pattern used by member-pointers.
540 // TODO: isZeroInitializable can be over-conservative in the case where a
541 // virtual base contains a member pointer.
David Majnemer8671c6e2015-11-02 09:01:44 +0000542 llvm::Constant *NullConstantForBase = CGF.CGM.EmitNullConstantForBase(Base);
543 if (!NullConstantForBase->isNullValue()) {
544 llvm::GlobalVariable *NullVariable = new llvm::GlobalVariable(
545 CGF.CGM.getModule(), NullConstantForBase->getType(),
546 /*isConstant=*/true, llvm::GlobalVariable::PrivateLinkage,
547 NullConstantForBase, Twine());
John McCall7f416cc2015-09-08 08:05:57 +0000548
549 CharUnits Align = std::max(Layout.getNonVirtualAlignment(),
550 DestPtr.getAlignment());
Guillaume Chateletc79099e2019-10-03 13:00:29 +0000551 NullVariable->setAlignment(Align.getAsAlign());
John McCall7f416cc2015-09-08 08:05:57 +0000552
553 Address SrcPtr = Address(CGF.EmitCastToVoidPtr(NullVariable), Align);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000554
555 // Get and call the appropriate llvm.memcpy overload.
David Majnemer8671c6e2015-11-02 09:01:44 +0000556 for (std::pair<CharUnits, CharUnits> Store : Stores) {
557 CharUnits StoreOffset = Store.first;
558 CharUnits StoreSize = Store.second;
559 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
560 CGF.Builder.CreateMemCpy(
561 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
562 CGF.Builder.CreateConstInBoundsByteGEP(SrcPtr, StoreOffset),
563 StoreSizeVal);
564 }
565
Eli Friedmanfde961d2011-10-14 02:27:24 +0000566 // Otherwise, just memset the whole thing to zero. This is legal
567 // because in LLVM, all default initializers (other than the ones we just
568 // handled above) are guaranteed to have a bit pattern of all zeros.
David Majnemer8671c6e2015-11-02 09:01:44 +0000569 } else {
570 for (std::pair<CharUnits, CharUnits> Store : Stores) {
571 CharUnits StoreOffset = Store.first;
572 CharUnits StoreSize = Store.second;
573 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
574 CGF.Builder.CreateMemSet(
575 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
576 CGF.Builder.getInt8(0), StoreSizeVal);
577 }
578 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000579}
580
Anders Carlsson27da15b2010-01-01 20:29:01 +0000581void
John McCall7a626f62010-09-15 10:14:12 +0000582CodeGenFunction::EmitCXXConstructExpr(const CXXConstructExpr *E,
583 AggValueSlot Dest) {
584 assert(!Dest.isIgnored() && "Must have a destination!");
Anders Carlsson27da15b2010-01-01 20:29:01 +0000585 const CXXConstructorDecl *CD = E->getConstructor();
Fangrui Song6907ce22018-07-30 19:24:48 +0000586
Douglas Gregor630c76e2010-08-22 16:15:35 +0000587 // If we require zero initialization before (or instead of) calling the
588 // constructor, as can be the case with a non-user-provided default
Argyrios Kyrtzidis03535262011-04-28 22:57:55 +0000589 // constructor, emit the zero initialization now, unless destination is
590 // already zeroed.
Eli Friedmanfde961d2011-10-14 02:27:24 +0000591 if (E->requiresZeroInitialization() && !Dest.isZeroed()) {
592 switch (E->getConstructionKind()) {
593 case CXXConstructExpr::CK_Delegating:
Eli Friedmanfde961d2011-10-14 02:27:24 +0000594 case CXXConstructExpr::CK_Complete:
John McCall7f416cc2015-09-08 08:05:57 +0000595 EmitNullInitialization(Dest.getAddress(), E->getType());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000596 break;
597 case CXXConstructExpr::CK_VirtualBase:
598 case CXXConstructExpr::CK_NonVirtualBase:
John McCall7f416cc2015-09-08 08:05:57 +0000599 EmitNullBaseClassInitialization(*this, Dest.getAddress(),
600 CD->getParent());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000601 break;
602 }
603 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000604
Douglas Gregor630c76e2010-08-22 16:15:35 +0000605 // If this is a call to a trivial default constructor, do nothing.
606 if (CD->isTrivial() && CD->isDefaultConstructor())
607 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000608
John McCall8ea46b62010-09-18 00:58:34 +0000609 // Elide the constructor if we're constructing from a temporary.
610 // The temporary check is required because Sema sets this on NRVO
611 // returns.
Richard Smith9c6890a2012-11-01 22:30:59 +0000612 if (getLangOpts().ElideConstructors && E->isElidable()) {
John McCall8ea46b62010-09-18 00:58:34 +0000613 assert(getContext().hasSameUnqualifiedType(E->getType(),
614 E->getArg(0)->getType()));
John McCall7a626f62010-09-15 10:14:12 +0000615 if (E->getArg(0)->isTemporaryObject(getContext(), CD->getParent())) {
616 EmitAggExpr(E->getArg(0), Dest);
Douglas Gregor222cf0e2010-05-15 00:13:29 +0000617 return;
618 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000619 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000620
Alexey Bataeve7545b32016-04-29 09:39:50 +0000621 if (const ArrayType *arrayType
622 = getContext().getAsArrayType(E->getType())) {
Serge Pavlov37605182018-07-28 15:33:03 +0000623 EmitCXXAggrConstructorCall(CD, arrayType, Dest.getAddress(), E,
624 Dest.isSanitizerChecked());
John McCallf677a8e2011-07-13 06:10:41 +0000625 } else {
Cameron Esfahanibceca202011-05-06 21:28:42 +0000626 CXXCtorType Type = Ctor_Complete;
Alexis Hunt271c3682011-05-03 20:19:28 +0000627 bool ForVirtualBase = false;
Douglas Gregor61535002013-01-31 05:50:40 +0000628 bool Delegating = false;
Fangrui Song6907ce22018-07-30 19:24:48 +0000629
Alexis Hunt271c3682011-05-03 20:19:28 +0000630 switch (E->getConstructionKind()) {
631 case CXXConstructExpr::CK_Delegating:
Alexis Hunt61bc1732011-05-01 07:04:31 +0000632 // We should be emitting a constructor; GlobalDecl will assert this
633 Type = CurGD.getCtorType();
Douglas Gregor61535002013-01-31 05:50:40 +0000634 Delegating = true;
Alexis Hunt271c3682011-05-03 20:19:28 +0000635 break;
Alexis Hunt61bc1732011-05-01 07:04:31 +0000636
Alexis Hunt271c3682011-05-03 20:19:28 +0000637 case CXXConstructExpr::CK_Complete:
638 Type = Ctor_Complete;
639 break;
640
641 case CXXConstructExpr::CK_VirtualBase:
642 ForVirtualBase = true;
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +0000643 LLVM_FALLTHROUGH;
Alexis Hunt271c3682011-05-03 20:19:28 +0000644
645 case CXXConstructExpr::CK_NonVirtualBase:
646 Type = Ctor_Base;
Anastasia Stulova094c7262019-04-04 10:48:36 +0000647 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000648
Anastasia Stulova094c7262019-04-04 10:48:36 +0000649 // Call the constructor.
650 EmitCXXConstructorCall(CD, Type, ForVirtualBase, Delegating, Dest, E);
Anders Carlssone11f9ce2010-05-02 23:20:53 +0000651 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000652}
653
John McCall7f416cc2015-09-08 08:05:57 +0000654void CodeGenFunction::EmitSynthesizedCXXCopyCtor(Address Dest, Address Src,
655 const Expr *Exp) {
John McCall5d413782010-12-06 08:20:24 +0000656 if (const ExprWithCleanups *E = dyn_cast<ExprWithCleanups>(Exp))
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000657 Exp = E->getSubExpr();
Fangrui Song6907ce22018-07-30 19:24:48 +0000658 assert(isa<CXXConstructExpr>(Exp) &&
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000659 "EmitSynthesizedCXXCopyCtor - unknown copy ctor expr");
660 const CXXConstructExpr* E = cast<CXXConstructExpr>(Exp);
661 const CXXConstructorDecl *CD = E->getConstructor();
662 RunCleanupsScope Scope(*this);
Fangrui Song6907ce22018-07-30 19:24:48 +0000663
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000664 // If we require zero initialization before (or instead of) calling the
665 // constructor, as can be the case with a non-user-provided default
666 // constructor, emit the zero initialization now.
667 // FIXME. Do I still need this for a copy ctor synthesis?
668 if (E->requiresZeroInitialization())
669 EmitNullInitialization(Dest, E->getType());
Fangrui Song6907ce22018-07-30 19:24:48 +0000670
Chandler Carruth99da11c2010-11-15 13:54:43 +0000671 assert(!getContext().getAsConstantArrayType(E->getType())
672 && "EmitSynthesizedCXXCopyCtor - Copied-in Array");
Alexey Samsonov525bf652014-08-25 21:58:56 +0000673 EmitSynthesizedCXXCopyCtorCall(CD, Dest, Src, E);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000674}
675
John McCall8ed55a52010-09-02 09:58:18 +0000676static CharUnits CalculateCookiePadding(CodeGenFunction &CGF,
677 const CXXNewExpr *E) {
Anders Carlsson21122cf2009-12-13 20:04:38 +0000678 if (!E->isArray())
Ken Dyck3eb55cf2010-01-26 19:44:24 +0000679 return CharUnits::Zero();
Anders Carlsson21122cf2009-12-13 20:04:38 +0000680
John McCall7ec4b432011-05-16 01:05:12 +0000681 // No cookie is required if the operator new[] being used is the
682 // reserved placement operator new[].
683 if (E->getOperatorNew()->isReservedGlobalPlacementOperator())
John McCallaa4149a2010-08-23 01:17:59 +0000684 return CharUnits::Zero();
685
John McCall284c48f2011-01-27 09:37:56 +0000686 return CGF.CGM.getCXXABI().GetArrayCookieSize(E);
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000687}
688
John McCall036f2f62011-05-15 07:14:44 +0000689static llvm::Value *EmitCXXNewAllocSize(CodeGenFunction &CGF,
690 const CXXNewExpr *e,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000691 unsigned minElements,
John McCall036f2f62011-05-15 07:14:44 +0000692 llvm::Value *&numElements,
693 llvm::Value *&sizeWithoutCookie) {
694 QualType type = e->getAllocatedType();
John McCall8ed55a52010-09-02 09:58:18 +0000695
John McCall036f2f62011-05-15 07:14:44 +0000696 if (!e->isArray()) {
697 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
698 sizeWithoutCookie
699 = llvm::ConstantInt::get(CGF.SizeTy, typeSize.getQuantity());
700 return sizeWithoutCookie;
Douglas Gregor05fc5be2010-07-21 01:10:17 +0000701 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000702
John McCall036f2f62011-05-15 07:14:44 +0000703 // The width of size_t.
704 unsigned sizeWidth = CGF.SizeTy->getBitWidth();
705
John McCall8ed55a52010-09-02 09:58:18 +0000706 // Figure out the cookie size.
John McCall036f2f62011-05-15 07:14:44 +0000707 llvm::APInt cookieSize(sizeWidth,
708 CalculateCookiePadding(CGF, e).getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +0000709
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000710 // Emit the array size expression.
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000711 // We multiply the size of all dimensions for NumElements.
712 // e.g for 'int[2][3]', ElemType is 'int' and NumElements is 6.
John McCallde0fe072017-08-15 21:42:52 +0000713 numElements =
Richard Smithb9fb1212019-05-06 03:47:15 +0000714 ConstantEmitter(CGF).tryEmitAbstract(*e->getArraySize(), e->getType());
Nick Lewycky07527622017-02-13 23:49:55 +0000715 if (!numElements)
Richard Smithb9fb1212019-05-06 03:47:15 +0000716 numElements = CGF.EmitScalarExpr(*e->getArraySize());
John McCall036f2f62011-05-15 07:14:44 +0000717 assert(isa<llvm::IntegerType>(numElements->getType()));
John McCall8ed55a52010-09-02 09:58:18 +0000718
John McCall036f2f62011-05-15 07:14:44 +0000719 // The number of elements can be have an arbitrary integer type;
720 // essentially, we need to multiply it by a constant factor, add a
721 // cookie size, and verify that the result is representable as a
722 // size_t. That's just a gloss, though, and it's wrong in one
723 // important way: if the count is negative, it's an error even if
724 // the cookie size would bring the total size >= 0.
Fangrui Song6907ce22018-07-30 19:24:48 +0000725 bool isSigned
Richard Smithb9fb1212019-05-06 03:47:15 +0000726 = (*e->getArraySize())->getType()->isSignedIntegerOrEnumerationType();
Chris Lattner2192fe52011-07-18 04:24:23 +0000727 llvm::IntegerType *numElementsType
John McCall036f2f62011-05-15 07:14:44 +0000728 = cast<llvm::IntegerType>(numElements->getType());
729 unsigned numElementsWidth = numElementsType->getBitWidth();
730
731 // Compute the constant factor.
732 llvm::APInt arraySizeMultiplier(sizeWidth, 1);
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000733 while (const ConstantArrayType *CAT
John McCall036f2f62011-05-15 07:14:44 +0000734 = CGF.getContext().getAsConstantArrayType(type)) {
735 type = CAT->getElementType();
736 arraySizeMultiplier *= CAT->getSize();
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000737 }
738
John McCall036f2f62011-05-15 07:14:44 +0000739 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
740 llvm::APInt typeSizeMultiplier(sizeWidth, typeSize.getQuantity());
741 typeSizeMultiplier *= arraySizeMultiplier;
742
743 // This will be a size_t.
744 llvm::Value *size;
Fangrui Song6907ce22018-07-30 19:24:48 +0000745
Chris Lattner32ac5832010-07-20 21:55:52 +0000746 // If someone is doing 'new int[42]' there is no need to do a dynamic check.
747 // Don't bloat the -O0 code.
John McCall036f2f62011-05-15 07:14:44 +0000748 if (llvm::ConstantInt *numElementsC =
749 dyn_cast<llvm::ConstantInt>(numElements)) {
750 const llvm::APInt &count = numElementsC->getValue();
John McCall8ed55a52010-09-02 09:58:18 +0000751
John McCall036f2f62011-05-15 07:14:44 +0000752 bool hasAnyOverflow = false;
John McCall8ed55a52010-09-02 09:58:18 +0000753
John McCall036f2f62011-05-15 07:14:44 +0000754 // If 'count' was a negative number, it's an overflow.
755 if (isSigned && count.isNegative())
756 hasAnyOverflow = true;
John McCall8ed55a52010-09-02 09:58:18 +0000757
John McCall036f2f62011-05-15 07:14:44 +0000758 // We want to do all this arithmetic in size_t. If numElements is
759 // wider than that, check whether it's already too big, and if so,
760 // overflow.
761 else if (numElementsWidth > sizeWidth &&
762 numElementsWidth - sizeWidth > count.countLeadingZeros())
763 hasAnyOverflow = true;
764
765 // Okay, compute a count at the right width.
766 llvm::APInt adjustedCount = count.zextOrTrunc(sizeWidth);
767
Sebastian Redlf862eb62012-02-22 17:37:52 +0000768 // If there is a brace-initializer, we cannot allocate fewer elements than
769 // there are initializers. If we do, that's treated like an overflow.
770 if (adjustedCount.ult(minElements))
771 hasAnyOverflow = true;
772
John McCall036f2f62011-05-15 07:14:44 +0000773 // Scale numElements by that. This might overflow, but we don't
774 // care because it only overflows if allocationSize does, too, and
775 // if that overflows then we shouldn't use this.
776 numElements = llvm::ConstantInt::get(CGF.SizeTy,
777 adjustedCount * arraySizeMultiplier);
778
779 // Compute the size before cookie, and track whether it overflowed.
780 bool overflow;
781 llvm::APInt allocationSize
782 = adjustedCount.umul_ov(typeSizeMultiplier, overflow);
783 hasAnyOverflow |= overflow;
784
785 // Add in the cookie, and check whether it's overflowed.
786 if (cookieSize != 0) {
787 // Save the current size without a cookie. This shouldn't be
788 // used if there was overflow.
789 sizeWithoutCookie = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
790
791 allocationSize = allocationSize.uadd_ov(cookieSize, overflow);
792 hasAnyOverflow |= overflow;
793 }
794
795 // On overflow, produce a -1 so operator new will fail.
Aaron Ballman455f42c2014-08-28 17:24:14 +0000796 if (hasAnyOverflow) {
797 size = llvm::Constant::getAllOnesValue(CGF.SizeTy);
798 } else {
John McCall036f2f62011-05-15 07:14:44 +0000799 size = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
Aaron Ballman455f42c2014-08-28 17:24:14 +0000800 }
John McCall036f2f62011-05-15 07:14:44 +0000801
802 // Otherwise, we might need to use the overflow intrinsics.
803 } else {
Sebastian Redlf862eb62012-02-22 17:37:52 +0000804 // There are up to five conditions we need to test for:
John McCall036f2f62011-05-15 07:14:44 +0000805 // 1) if isSigned, we need to check whether numElements is negative;
806 // 2) if numElementsWidth > sizeWidth, we need to check whether
807 // numElements is larger than something representable in size_t;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000808 // 3) if minElements > 0, we need to check whether numElements is smaller
809 // than that.
810 // 4) we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000811 // sizeWithoutCookie := numElements * typeSizeMultiplier
812 // and check whether it overflows; and
Sebastian Redlf862eb62012-02-22 17:37:52 +0000813 // 5) if we need a cookie, we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000814 // size := sizeWithoutCookie + cookieSize
815 // and check whether it overflows.
816
Craig Topper8a13c412014-05-21 05:09:00 +0000817 llvm::Value *hasOverflow = nullptr;
John McCall036f2f62011-05-15 07:14:44 +0000818
819 // If numElementsWidth > sizeWidth, then one way or another, we're
820 // going to have to do a comparison for (2), and this happens to
821 // take care of (1), too.
822 if (numElementsWidth > sizeWidth) {
823 llvm::APInt threshold(numElementsWidth, 1);
824 threshold <<= sizeWidth;
825
826 llvm::Value *thresholdV
827 = llvm::ConstantInt::get(numElementsType, threshold);
828
829 hasOverflow = CGF.Builder.CreateICmpUGE(numElements, thresholdV);
830 numElements = CGF.Builder.CreateTrunc(numElements, CGF.SizeTy);
831
832 // Otherwise, if we're signed, we want to sext up to size_t.
833 } else if (isSigned) {
834 if (numElementsWidth < sizeWidth)
835 numElements = CGF.Builder.CreateSExt(numElements, CGF.SizeTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000836
John McCall036f2f62011-05-15 07:14:44 +0000837 // If there's a non-1 type size multiplier, then we can do the
838 // signedness check at the same time as we do the multiply
839 // because a negative number times anything will cause an
Sebastian Redlf862eb62012-02-22 17:37:52 +0000840 // unsigned overflow. Otherwise, we have to do it here. But at least
841 // in this case, we can subsume the >= minElements check.
John McCall036f2f62011-05-15 07:14:44 +0000842 if (typeSizeMultiplier == 1)
843 hasOverflow = CGF.Builder.CreateICmpSLT(numElements,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000844 llvm::ConstantInt::get(CGF.SizeTy, minElements));
John McCall036f2f62011-05-15 07:14:44 +0000845
846 // Otherwise, zext up to size_t if necessary.
847 } else if (numElementsWidth < sizeWidth) {
848 numElements = CGF.Builder.CreateZExt(numElements, CGF.SizeTy);
849 }
850
851 assert(numElements->getType() == CGF.SizeTy);
852
Sebastian Redlf862eb62012-02-22 17:37:52 +0000853 if (minElements) {
854 // Don't allow allocation of fewer elements than we have initializers.
855 if (!hasOverflow) {
856 hasOverflow = CGF.Builder.CreateICmpULT(numElements,
857 llvm::ConstantInt::get(CGF.SizeTy, minElements));
858 } else if (numElementsWidth > sizeWidth) {
859 // The other existing overflow subsumes this check.
860 // We do an unsigned comparison, since any signed value < -1 is
861 // taken care of either above or below.
862 hasOverflow = CGF.Builder.CreateOr(hasOverflow,
863 CGF.Builder.CreateICmpULT(numElements,
864 llvm::ConstantInt::get(CGF.SizeTy, minElements)));
865 }
866 }
867
John McCall036f2f62011-05-15 07:14:44 +0000868 size = numElements;
869
870 // Multiply by the type size if necessary. This multiplier
871 // includes all the factors for nested arrays.
872 //
873 // This step also causes numElements to be scaled up by the
874 // nested-array factor if necessary. Overflow on this computation
875 // can be ignored because the result shouldn't be used if
876 // allocation fails.
877 if (typeSizeMultiplier != 1) {
James Y Knight8799cae2019-02-03 21:53:49 +0000878 llvm::Function *umul_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000879 = CGF.CGM.getIntrinsic(llvm::Intrinsic::umul_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000880
881 llvm::Value *tsmV =
882 llvm::ConstantInt::get(CGF.SizeTy, typeSizeMultiplier);
883 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000884 CGF.Builder.CreateCall(umul_with_overflow, {size, tsmV});
John McCall036f2f62011-05-15 07:14:44 +0000885
886 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
887 if (hasOverflow)
888 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
889 else
890 hasOverflow = overflowed;
891
892 size = CGF.Builder.CreateExtractValue(result, 0);
893
894 // Also scale up numElements by the array size multiplier.
895 if (arraySizeMultiplier != 1) {
896 // If the base element type size is 1, then we can re-use the
897 // multiply we just did.
898 if (typeSize.isOne()) {
899 assert(arraySizeMultiplier == typeSizeMultiplier);
900 numElements = size;
901
902 // Otherwise we need a separate multiply.
903 } else {
904 llvm::Value *asmV =
905 llvm::ConstantInt::get(CGF.SizeTy, arraySizeMultiplier);
906 numElements = CGF.Builder.CreateMul(numElements, asmV);
907 }
908 }
909 } else {
910 // numElements doesn't need to be scaled.
911 assert(arraySizeMultiplier == 1);
Chris Lattner32ac5832010-07-20 21:55:52 +0000912 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000913
John McCall036f2f62011-05-15 07:14:44 +0000914 // Add in the cookie size if necessary.
915 if (cookieSize != 0) {
916 sizeWithoutCookie = size;
917
James Y Knight8799cae2019-02-03 21:53:49 +0000918 llvm::Function *uadd_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000919 = CGF.CGM.getIntrinsic(llvm::Intrinsic::uadd_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000920
921 llvm::Value *cookieSizeV = llvm::ConstantInt::get(CGF.SizeTy, cookieSize);
922 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000923 CGF.Builder.CreateCall(uadd_with_overflow, {size, cookieSizeV});
John McCall036f2f62011-05-15 07:14:44 +0000924
925 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
926 if (hasOverflow)
927 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
928 else
929 hasOverflow = overflowed;
930
931 size = CGF.Builder.CreateExtractValue(result, 0);
John McCall8ed55a52010-09-02 09:58:18 +0000932 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000933
John McCall036f2f62011-05-15 07:14:44 +0000934 // If we had any possibility of dynamic overflow, make a select to
935 // overwrite 'size' with an all-ones value, which should cause
936 // operator new to throw.
937 if (hasOverflow)
Aaron Ballman455f42c2014-08-28 17:24:14 +0000938 size = CGF.Builder.CreateSelect(hasOverflow,
939 llvm::Constant::getAllOnesValue(CGF.SizeTy),
940 size);
Chris Lattner32ac5832010-07-20 21:55:52 +0000941 }
John McCall8ed55a52010-09-02 09:58:18 +0000942
John McCall036f2f62011-05-15 07:14:44 +0000943 if (cookieSize == 0)
944 sizeWithoutCookie = size;
John McCall8ed55a52010-09-02 09:58:18 +0000945 else
John McCall036f2f62011-05-15 07:14:44 +0000946 assert(sizeWithoutCookie && "didn't set sizeWithoutCookie?");
John McCall8ed55a52010-09-02 09:58:18 +0000947
John McCall036f2f62011-05-15 07:14:44 +0000948 return size;
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000949}
950
Sebastian Redlf862eb62012-02-22 17:37:52 +0000951static void StoreAnyExprIntoOneUnit(CodeGenFunction &CGF, const Expr *Init,
Richard Smithe78fac52018-04-05 20:52:58 +0000952 QualType AllocType, Address NewPtr,
953 AggValueSlot::Overlap_t MayOverlap) {
Richard Smith1c96bc52013-12-11 01:40:16 +0000954 // FIXME: Refactor with EmitExprAsInit.
John McCall47fb9502013-03-07 21:37:08 +0000955 switch (CGF.getEvaluationKind(AllocType)) {
956 case TEK_Scalar:
David Blaikiea2c11242014-12-10 19:04:09 +0000957 CGF.EmitScalarInit(Init, nullptr,
John McCall7f416cc2015-09-08 08:05:57 +0000958 CGF.MakeAddrLValue(NewPtr, AllocType), false);
John McCall47fb9502013-03-07 21:37:08 +0000959 return;
960 case TEK_Complex:
John McCall7f416cc2015-09-08 08:05:57 +0000961 CGF.EmitComplexExprIntoLValue(Init, CGF.MakeAddrLValue(NewPtr, AllocType),
John McCall47fb9502013-03-07 21:37:08 +0000962 /*isInit*/ true);
963 return;
964 case TEK_Aggregate: {
John McCall7a626f62010-09-15 10:14:12 +0000965 AggValueSlot Slot
John McCall7f416cc2015-09-08 08:05:57 +0000966 = AggValueSlot::forAddr(NewPtr, AllocType.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +0000967 AggValueSlot::IsDestructed,
John McCall46759f42011-08-26 07:31:35 +0000968 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +0000969 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +0000970 MayOverlap, AggValueSlot::IsNotZeroed,
971 AggValueSlot::IsSanitizerChecked);
John McCall7a626f62010-09-15 10:14:12 +0000972 CGF.EmitAggExpr(Init, Slot);
John McCall47fb9502013-03-07 21:37:08 +0000973 return;
John McCall7a626f62010-09-15 10:14:12 +0000974 }
John McCall47fb9502013-03-07 21:37:08 +0000975 }
976 llvm_unreachable("bad evaluation kind");
Fariborz Jahaniand5202e02010-06-25 18:26:07 +0000977}
978
David Blaikiefb901c7a2015-04-04 15:12:29 +0000979void CodeGenFunction::EmitNewArrayInitializer(
980 const CXXNewExpr *E, QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +0000981 Address BeginPtr, llvm::Value *NumElements,
David Blaikiefb901c7a2015-04-04 15:12:29 +0000982 llvm::Value *AllocSizeWithoutCookie) {
Richard Smith06a67e22014-06-03 06:58:52 +0000983 // If we have a type with trivial initialization and no initializer,
984 // there's nothing to do.
Sebastian Redl6047f072012-02-16 12:22:20 +0000985 if (!E->hasInitializer())
Richard Smith06a67e22014-06-03 06:58:52 +0000986 return;
John McCall99210dc2011-09-15 06:49:18 +0000987
John McCall7f416cc2015-09-08 08:05:57 +0000988 Address CurPtr = BeginPtr;
John McCall99210dc2011-09-15 06:49:18 +0000989
Richard Smith06a67e22014-06-03 06:58:52 +0000990 unsigned InitListElements = 0;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000991
992 const Expr *Init = E->getInitializer();
John McCall7f416cc2015-09-08 08:05:57 +0000993 Address EndOfInit = Address::invalid();
Richard Smith06a67e22014-06-03 06:58:52 +0000994 QualType::DestructionKind DtorKind = ElementType.isDestructedType();
995 EHScopeStack::stable_iterator Cleanup;
996 llvm::Instruction *CleanupDominator = nullptr;
Richard Smith1c96bc52013-12-11 01:40:16 +0000997
John McCall7f416cc2015-09-08 08:05:57 +0000998 CharUnits ElementSize = getContext().getTypeSizeInChars(ElementType);
999 CharUnits ElementAlign =
1000 BeginPtr.getAlignment().alignmentOfArrayElement(ElementSize);
1001
Richard Smith0511d232016-10-05 22:41:02 +00001002 // Attempt to perform zero-initialization using memset.
1003 auto TryMemsetInitialization = [&]() -> bool {
1004 // FIXME: If the type is a pointer-to-data-member under the Itanium ABI,
1005 // we can initialize with a memset to -1.
1006 if (!CGM.getTypes().isZeroInitializable(ElementType))
1007 return false;
1008
1009 // Optimization: since zero initialization will just set the memory
1010 // to all zeroes, generate a single memset to do it in one shot.
1011
1012 // Subtract out the size of any elements we've already initialized.
1013 auto *RemainingSize = AllocSizeWithoutCookie;
1014 if (InitListElements) {
1015 // We know this can't overflow; we check this when doing the allocation.
1016 auto *InitializedSize = llvm::ConstantInt::get(
1017 RemainingSize->getType(),
1018 getContext().getTypeSizeInChars(ElementType).getQuantity() *
1019 InitListElements);
1020 RemainingSize = Builder.CreateSub(RemainingSize, InitializedSize);
1021 }
1022
1023 // Create the memset.
1024 Builder.CreateMemSet(CurPtr, Builder.getInt8(0), RemainingSize, false);
1025 return true;
1026 };
1027
Sebastian Redlf862eb62012-02-22 17:37:52 +00001028 // If the initializer is an initializer list, first do the explicit elements.
1029 if (const InitListExpr *ILE = dyn_cast<InitListExpr>(Init)) {
Richard Smith0511d232016-10-05 22:41:02 +00001030 // Initializing from a (braced) string literal is a special case; the init
1031 // list element does not initialize a (single) array element.
1032 if (ILE->isStringLiteralInit()) {
1033 // Initialize the initial portion of length equal to that of the string
1034 // literal. The allocation must be for at least this much; we emitted a
1035 // check for that earlier.
1036 AggValueSlot Slot =
1037 AggValueSlot::forAddr(CurPtr, ElementType.getQualifiers(),
1038 AggValueSlot::IsDestructed,
1039 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001040 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +00001041 AggValueSlot::DoesNotOverlap,
1042 AggValueSlot::IsNotZeroed,
1043 AggValueSlot::IsSanitizerChecked);
Richard Smith0511d232016-10-05 22:41:02 +00001044 EmitAggExpr(ILE->getInit(0), Slot);
1045
1046 // Move past these elements.
1047 InitListElements =
1048 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1049 ->getSize().getZExtValue();
1050 CurPtr =
1051 Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1052 Builder.getSize(InitListElements),
1053 "string.init.end"),
1054 CurPtr.getAlignment().alignmentAtOffset(InitListElements *
1055 ElementSize));
1056
1057 // Zero out the rest, if any remain.
1058 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1059 if (!ConstNum || !ConstNum->equalsInt(InitListElements)) {
1060 bool OK = TryMemsetInitialization();
1061 (void)OK;
1062 assert(OK && "couldn't memset character type?");
1063 }
1064 return;
1065 }
1066
Richard Smith06a67e22014-06-03 06:58:52 +00001067 InitListElements = ILE->getNumInits();
Chad Rosierf62290a2012-02-24 00:13:55 +00001068
Richard Smith1c96bc52013-12-11 01:40:16 +00001069 // If this is a multi-dimensional array new, we will initialize multiple
1070 // elements with each init list element.
1071 QualType AllocType = E->getAllocatedType();
1072 if (const ConstantArrayType *CAT = dyn_cast_or_null<ConstantArrayType>(
1073 AllocType->getAsArrayTypeUnsafe())) {
David Blaikiefb901c7a2015-04-04 15:12:29 +00001074 ElementTy = ConvertTypeForMem(AllocType);
John McCall7f416cc2015-09-08 08:05:57 +00001075 CurPtr = Builder.CreateElementBitCast(CurPtr, ElementTy);
Richard Smith06a67e22014-06-03 06:58:52 +00001076 InitListElements *= getContext().getConstantArrayElementCount(CAT);
Richard Smith1c96bc52013-12-11 01:40:16 +00001077 }
1078
Richard Smith06a67e22014-06-03 06:58:52 +00001079 // Enter a partial-destruction Cleanup if necessary.
1080 if (needsEHCleanup(DtorKind)) {
1081 // In principle we could tell the Cleanup where we are more
Chad Rosierf62290a2012-02-24 00:13:55 +00001082 // directly, but the control flow can get so varied here that it
1083 // would actually be quite complex. Therefore we go through an
1084 // alloca.
John McCall7f416cc2015-09-08 08:05:57 +00001085 EndOfInit = CreateTempAlloca(BeginPtr.getType(), getPointerAlign(),
1086 "array.init.end");
1087 CleanupDominator = Builder.CreateStore(BeginPtr.getPointer(), EndOfInit);
1088 pushIrregularPartialArrayCleanup(BeginPtr.getPointer(), EndOfInit,
1089 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001090 getDestroyer(DtorKind));
1091 Cleanup = EHStack.stable_begin();
Chad Rosierf62290a2012-02-24 00:13:55 +00001092 }
1093
John McCall7f416cc2015-09-08 08:05:57 +00001094 CharUnits StartAlign = CurPtr.getAlignment();
Sebastian Redlf862eb62012-02-22 17:37:52 +00001095 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i) {
Chad Rosierf62290a2012-02-24 00:13:55 +00001096 // Tell the cleanup that it needs to destroy up to this
1097 // element. TODO: some of these stores can be trivially
1098 // observed to be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00001099 if (EndOfInit.isValid()) {
1100 auto FinishedPtr =
1101 Builder.CreateBitCast(CurPtr.getPointer(), BeginPtr.getType());
1102 Builder.CreateStore(FinishedPtr, EndOfInit);
1103 }
Richard Smith06a67e22014-06-03 06:58:52 +00001104 // FIXME: If the last initializer is an incomplete initializer list for
1105 // an array, and we have an array filler, we can fold together the two
1106 // initialization loops.
Richard Smith1c96bc52013-12-11 01:40:16 +00001107 StoreAnyExprIntoOneUnit(*this, ILE->getInit(i),
Richard Smithe78fac52018-04-05 20:52:58 +00001108 ILE->getInit(i)->getType(), CurPtr,
1109 AggValueSlot::DoesNotOverlap);
John McCall7f416cc2015-09-08 08:05:57 +00001110 CurPtr = Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1111 Builder.getSize(1),
1112 "array.exp.next"),
1113 StartAlign.alignmentAtOffset((i + 1) * ElementSize));
Sebastian Redlf862eb62012-02-22 17:37:52 +00001114 }
1115
1116 // The remaining elements are filled with the array filler expression.
1117 Init = ILE->getArrayFiller();
Richard Smith1c96bc52013-12-11 01:40:16 +00001118
Richard Smith06a67e22014-06-03 06:58:52 +00001119 // Extract the initializer for the individual array elements by pulling
1120 // out the array filler from all the nested initializer lists. This avoids
1121 // generating a nested loop for the initialization.
1122 while (Init && Init->getType()->isConstantArrayType()) {
1123 auto *SubILE = dyn_cast<InitListExpr>(Init);
1124 if (!SubILE)
1125 break;
1126 assert(SubILE->getNumInits() == 0 && "explicit inits in array filler?");
1127 Init = SubILE->getArrayFiller();
1128 }
1129
1130 // Switch back to initializing one base element at a time.
John McCall7f416cc2015-09-08 08:05:57 +00001131 CurPtr = Builder.CreateBitCast(CurPtr, BeginPtr.getType());
Sebastian Redlf862eb62012-02-22 17:37:52 +00001132 }
1133
Richard Smith454a7cd2014-06-03 08:26:00 +00001134 // If all elements have already been initialized, skip any further
1135 // initialization.
1136 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1137 if (ConstNum && ConstNum->getZExtValue() <= InitListElements) {
1138 // If there was a Cleanup, deactivate it.
1139 if (CleanupDominator)
1140 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1141 return;
1142 }
1143
1144 assert(Init && "have trailing elements to initialize but no initializer");
1145
Richard Smith06a67e22014-06-03 06:58:52 +00001146 // If this is a constructor call, try to optimize it out, and failing that
1147 // emit a single loop to initialize all remaining elements.
Richard Smith454a7cd2014-06-03 08:26:00 +00001148 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001149 CXXConstructorDecl *Ctor = CCE->getConstructor();
1150 if (Ctor->isTrivial()) {
1151 // If new expression did not specify value-initialization, then there
1152 // is no initialization.
1153 if (!CCE->requiresZeroInitialization() || Ctor->getParent()->isEmpty())
1154 return;
1155
1156 if (TryMemsetInitialization())
1157 return;
1158 }
1159
1160 // Store the new Cleanup position for irregular Cleanups.
1161 //
1162 // FIXME: Share this cleanup with the constructor call emission rather than
1163 // having it create a cleanup of its own.
John McCall7f416cc2015-09-08 08:05:57 +00001164 if (EndOfInit.isValid())
1165 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Richard Smith06a67e22014-06-03 06:58:52 +00001166
1167 // Emit a constructor call loop to initialize the remaining elements.
1168 if (InitListElements)
1169 NumElements = Builder.CreateSub(
1170 NumElements,
1171 llvm::ConstantInt::get(NumElements->getType(), InitListElements));
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001172 EmitCXXAggrConstructorCall(Ctor, NumElements, CurPtr, CCE,
Serge Pavlov37605182018-07-28 15:33:03 +00001173 /*NewPointerIsChecked*/true,
Richard Smith06a67e22014-06-03 06:58:52 +00001174 CCE->requiresZeroInitialization());
Chandler Carruthe6c980c2014-05-03 09:16:57 +00001175 return;
1176 }
1177
Richard Smith06a67e22014-06-03 06:58:52 +00001178 // If this is value-initialization, we can usually use memset.
1179 ImplicitValueInitExpr IVIE(ElementType);
Richard Smith454a7cd2014-06-03 08:26:00 +00001180 if (isa<ImplicitValueInitExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001181 if (TryMemsetInitialization())
1182 return;
1183
1184 // Switch to an ImplicitValueInitExpr for the element type. This handles
1185 // only one case: multidimensional array new of pointers to members. In
1186 // all other cases, we already have an initializer for the array element.
1187 Init = &IVIE;
1188 }
1189
1190 // At this point we should have found an initializer for the individual
1191 // elements of the array.
1192 assert(getContext().hasSameUnqualifiedType(ElementType, Init->getType()) &&
1193 "got wrong type of element to initialize");
1194
Richard Smith454a7cd2014-06-03 08:26:00 +00001195 // If we have an empty initializer list, we can usually use memset.
1196 if (auto *ILE = dyn_cast<InitListExpr>(Init))
1197 if (ILE->getNumInits() == 0 && TryMemsetInitialization())
1198 return;
Richard Smith06a67e22014-06-03 06:58:52 +00001199
Yunzhong Gaocb779302015-06-10 00:27:52 +00001200 // If we have a struct whose every field is value-initialized, we can
1201 // usually use memset.
1202 if (auto *ILE = dyn_cast<InitListExpr>(Init)) {
1203 if (const RecordType *RType = ILE->getType()->getAs<RecordType>()) {
1204 if (RType->getDecl()->isStruct()) {
Richard Smith872307e2016-03-08 22:17:41 +00001205 unsigned NumElements = 0;
1206 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RType->getDecl()))
1207 NumElements = CXXRD->getNumBases();
Yunzhong Gaocb779302015-06-10 00:27:52 +00001208 for (auto *Field : RType->getDecl()->fields())
1209 if (!Field->isUnnamedBitfield())
Richard Smith872307e2016-03-08 22:17:41 +00001210 ++NumElements;
1211 // FIXME: Recurse into nested InitListExprs.
1212 if (ILE->getNumInits() == NumElements)
Yunzhong Gaocb779302015-06-10 00:27:52 +00001213 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i)
1214 if (!isa<ImplicitValueInitExpr>(ILE->getInit(i)))
Richard Smith872307e2016-03-08 22:17:41 +00001215 --NumElements;
1216 if (ILE->getNumInits() == NumElements && TryMemsetInitialization())
Yunzhong Gaocb779302015-06-10 00:27:52 +00001217 return;
1218 }
1219 }
1220 }
1221
Richard Smith06a67e22014-06-03 06:58:52 +00001222 // Create the loop blocks.
1223 llvm::BasicBlock *EntryBB = Builder.GetInsertBlock();
1224 llvm::BasicBlock *LoopBB = createBasicBlock("new.loop");
1225 llvm::BasicBlock *ContBB = createBasicBlock("new.loop.end");
1226
1227 // Find the end of the array, hoisted out of the loop.
1228 llvm::Value *EndPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001229 Builder.CreateInBoundsGEP(BeginPtr.getPointer(), NumElements, "array.end");
John McCall99210dc2011-09-15 06:49:18 +00001230
Sebastian Redlf862eb62012-02-22 17:37:52 +00001231 // If the number of elements isn't constant, we have to now check if there is
1232 // anything left to initialize.
Richard Smith06a67e22014-06-03 06:58:52 +00001233 if (!ConstNum) {
John McCall7f416cc2015-09-08 08:05:57 +00001234 llvm::Value *IsEmpty =
1235 Builder.CreateICmpEQ(CurPtr.getPointer(), EndPtr, "array.isempty");
Richard Smith06a67e22014-06-03 06:58:52 +00001236 Builder.CreateCondBr(IsEmpty, ContBB, LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001237 }
1238
1239 // Enter the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001240 EmitBlock(LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001241
1242 // Set up the current-element phi.
Richard Smith06a67e22014-06-03 06:58:52 +00001243 llvm::PHINode *CurPtrPhi =
John McCall7f416cc2015-09-08 08:05:57 +00001244 Builder.CreatePHI(CurPtr.getType(), 2, "array.cur");
1245 CurPtrPhi->addIncoming(CurPtr.getPointer(), EntryBB);
1246
1247 CurPtr = Address(CurPtrPhi, ElementAlign);
John McCall99210dc2011-09-15 06:49:18 +00001248
Richard Smith06a67e22014-06-03 06:58:52 +00001249 // Store the new Cleanup position for irregular Cleanups.
Fangrui Song6907ce22018-07-30 19:24:48 +00001250 if (EndOfInit.isValid())
John McCall7f416cc2015-09-08 08:05:57 +00001251 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Chad Rosierf62290a2012-02-24 00:13:55 +00001252
Richard Smith06a67e22014-06-03 06:58:52 +00001253 // Enter a partial-destruction Cleanup if necessary.
1254 if (!CleanupDominator && needsEHCleanup(DtorKind)) {
John McCall7f416cc2015-09-08 08:05:57 +00001255 pushRegularPartialArrayCleanup(BeginPtr.getPointer(), CurPtr.getPointer(),
1256 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001257 getDestroyer(DtorKind));
1258 Cleanup = EHStack.stable_begin();
1259 CleanupDominator = Builder.CreateUnreachable();
John McCall99210dc2011-09-15 06:49:18 +00001260 }
1261
1262 // Emit the initializer into this element.
Richard Smithe78fac52018-04-05 20:52:58 +00001263 StoreAnyExprIntoOneUnit(*this, Init, Init->getType(), CurPtr,
1264 AggValueSlot::DoesNotOverlap);
John McCall99210dc2011-09-15 06:49:18 +00001265
Richard Smith06a67e22014-06-03 06:58:52 +00001266 // Leave the Cleanup if we entered one.
1267 if (CleanupDominator) {
1268 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1269 CleanupDominator->eraseFromParent();
John McCallf4beacd2011-11-10 10:43:54 +00001270 }
John McCall99210dc2011-09-15 06:49:18 +00001271
Faisal Vali57ae0562013-12-14 00:40:05 +00001272 // Advance to the next element by adjusting the pointer type as necessary.
Richard Smith06a67e22014-06-03 06:58:52 +00001273 llvm::Value *NextPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001274 Builder.CreateConstInBoundsGEP1_32(ElementTy, CurPtr.getPointer(), 1,
1275 "array.next");
Richard Smith06a67e22014-06-03 06:58:52 +00001276
John McCall99210dc2011-09-15 06:49:18 +00001277 // Check whether we've gotten to the end of the array and, if so,
1278 // exit the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001279 llvm::Value *IsEnd = Builder.CreateICmpEQ(NextPtr, EndPtr, "array.atend");
1280 Builder.CreateCondBr(IsEnd, ContBB, LoopBB);
1281 CurPtrPhi->addIncoming(NextPtr, Builder.GetInsertBlock());
John McCall99210dc2011-09-15 06:49:18 +00001282
Richard Smith06a67e22014-06-03 06:58:52 +00001283 EmitBlock(ContBB);
Fariborz Jahaniand5202e02010-06-25 18:26:07 +00001284}
1285
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001286static void EmitNewInitializer(CodeGenFunction &CGF, const CXXNewExpr *E,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001287 QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +00001288 Address NewPtr, llvm::Value *NumElements,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001289 llvm::Value *AllocSizeWithoutCookie) {
David Blaikie9b479662015-01-25 01:19:10 +00001290 ApplyDebugLocation DL(CGF, E);
Richard Smith06a67e22014-06-03 06:58:52 +00001291 if (E->isArray())
David Blaikiefb901c7a2015-04-04 15:12:29 +00001292 CGF.EmitNewArrayInitializer(E, ElementType, ElementTy, NewPtr, NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001293 AllocSizeWithoutCookie);
1294 else if (const Expr *Init = E->getInitializer())
Richard Smithe78fac52018-04-05 20:52:58 +00001295 StoreAnyExprIntoOneUnit(CGF, Init, E->getAllocatedType(), NewPtr,
1296 AggValueSlot::DoesNotOverlap);
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001297}
1298
Richard Smith8d0dc312013-07-21 23:12:18 +00001299/// Emit a call to an operator new or operator delete function, as implicitly
1300/// created by new-expressions and delete-expressions.
1301static RValue EmitNewDeleteCall(CodeGenFunction &CGF,
John McCallb92ab1a2016-10-26 23:46:34 +00001302 const FunctionDecl *CalleeDecl,
Richard Smith8d0dc312013-07-21 23:12:18 +00001303 const FunctionProtoType *CalleeType,
1304 const CallArgList &Args) {
James Y Knight3933add2019-01-30 02:54:28 +00001305 llvm::CallBase *CallOrInvoke;
John McCallb92ab1a2016-10-26 23:46:34 +00001306 llvm::Constant *CalleePtr = CGF.CGM.GetAddrOfFunction(CalleeDecl);
Erich Keanede6480a32018-11-13 15:48:08 +00001307 CGCallee Callee = CGCallee::forDirect(CalleePtr, GlobalDecl(CalleeDecl));
Richard Smith8d0dc312013-07-21 23:12:18 +00001308 RValue RV =
Peter Collingbournef7706832014-12-12 23:41:25 +00001309 CGF.EmitCall(CGF.CGM.getTypes().arrangeFreeFunctionCall(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001310 Args, CalleeType, /*ChainCall=*/false),
John McCallb92ab1a2016-10-26 23:46:34 +00001311 Callee, ReturnValueSlot(), Args, &CallOrInvoke);
Richard Smith8d0dc312013-07-21 23:12:18 +00001312
1313 /// C++1y [expr.new]p10:
1314 /// [In a new-expression,] an implementation is allowed to omit a call
1315 /// to a replaceable global allocation function.
1316 ///
1317 /// We model such elidable calls with the 'builtin' attribute.
John McCallb92ab1a2016-10-26 23:46:34 +00001318 llvm::Function *Fn = dyn_cast<llvm::Function>(CalleePtr);
1319 if (CalleeDecl->isReplaceableGlobalAllocationFunction() &&
Rafael Espindola6956d582013-10-22 14:23:09 +00001320 Fn && Fn->hasFnAttribute(llvm::Attribute::NoBuiltin)) {
James Y Knight3933add2019-01-30 02:54:28 +00001321 CallOrInvoke->addAttribute(llvm::AttributeList::FunctionIndex,
1322 llvm::Attribute::Builtin);
Richard Smith8d0dc312013-07-21 23:12:18 +00001323 }
1324
1325 return RV;
1326}
1327
Richard Smith760520b2014-06-03 23:27:44 +00001328RValue CodeGenFunction::EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00001329 const CallExpr *TheCall,
Richard Smith760520b2014-06-03 23:27:44 +00001330 bool IsDelete) {
1331 CallArgList Args;
Eric Fiselierfa752f22018-03-21 19:19:48 +00001332 EmitCallArgs(Args, Type->getParamTypes(), TheCall->arguments());
Richard Smith760520b2014-06-03 23:27:44 +00001333 // Find the allocation or deallocation function that we're calling.
1334 ASTContext &Ctx = getContext();
1335 DeclarationName Name = Ctx.DeclarationNames
1336 .getCXXOperatorName(IsDelete ? OO_Delete : OO_New);
Eric Fiselierfa752f22018-03-21 19:19:48 +00001337
Richard Smith760520b2014-06-03 23:27:44 +00001338 for (auto *Decl : Ctx.getTranslationUnitDecl()->lookup(Name))
Richard Smith599bed72014-06-05 00:43:02 +00001339 if (auto *FD = dyn_cast<FunctionDecl>(Decl))
1340 if (Ctx.hasSameType(FD->getType(), QualType(Type, 0)))
Eric Fiselierfa752f22018-03-21 19:19:48 +00001341 return EmitNewDeleteCall(*this, FD, Type, Args);
Richard Smith760520b2014-06-03 23:27:44 +00001342 llvm_unreachable("predeclared global operator new/delete is missing");
1343}
1344
Richard Smith5b349582017-10-13 01:55:36 +00001345namespace {
1346/// The parameters to pass to a usual operator delete.
1347struct UsualDeleteParams {
1348 bool DestroyingDelete = false;
1349 bool Size = false;
1350 bool Alignment = false;
1351};
1352}
1353
1354static UsualDeleteParams getUsualDeleteParams(const FunctionDecl *FD) {
1355 UsualDeleteParams Params;
1356
1357 const FunctionProtoType *FPT = FD->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001358 auto AI = FPT->param_type_begin(), AE = FPT->param_type_end();
Richard Smith189e52f2016-10-10 06:42:31 +00001359
Richard Smithb2f0f052016-10-10 18:54:32 +00001360 // The first argument is always a void*.
1361 ++AI;
1362
Richard Smith5b349582017-10-13 01:55:36 +00001363 // The next parameter may be a std::destroying_delete_t.
1364 if (FD->isDestroyingOperatorDelete()) {
1365 Params.DestroyingDelete = true;
1366 assert(AI != AE);
1367 ++AI;
1368 }
Richard Smithb2f0f052016-10-10 18:54:32 +00001369
Richard Smith5b349582017-10-13 01:55:36 +00001370 // Figure out what other parameters we should be implicitly passing.
Richard Smithb2f0f052016-10-10 18:54:32 +00001371 if (AI != AE && (*AI)->isIntegerType()) {
Richard Smith5b349582017-10-13 01:55:36 +00001372 Params.Size = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001373 ++AI;
1374 }
1375
1376 if (AI != AE && (*AI)->isAlignValT()) {
Richard Smith5b349582017-10-13 01:55:36 +00001377 Params.Alignment = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001378 ++AI;
1379 }
1380
1381 assert(AI == AE && "unexpected usual deallocation function parameter");
Richard Smith5b349582017-10-13 01:55:36 +00001382 return Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001383}
1384
1385namespace {
1386 /// A cleanup to call the given 'operator delete' function upon abnormal
1387 /// exit from a new expression. Templated on a traits type that deals with
1388 /// ensuring that the arguments dominate the cleanup if necessary.
1389 template<typename Traits>
1390 class CallDeleteDuringNew final : public EHScopeStack::Cleanup {
1391 /// Type used to hold llvm::Value*s.
1392 typedef typename Traits::ValueTy ValueTy;
1393 /// Type used to hold RValues.
1394 typedef typename Traits::RValueTy RValueTy;
1395 struct PlacementArg {
1396 RValueTy ArgValue;
1397 QualType ArgType;
1398 };
1399
1400 unsigned NumPlacementArgs : 31;
1401 unsigned PassAlignmentToPlacementDelete : 1;
1402 const FunctionDecl *OperatorDelete;
1403 ValueTy Ptr;
1404 ValueTy AllocSize;
1405 CharUnits AllocAlign;
1406
1407 PlacementArg *getPlacementArgs() {
1408 return reinterpret_cast<PlacementArg *>(this + 1);
1409 }
Daniel Jaspere9abe642016-10-10 14:13:55 +00001410
1411 public:
1412 static size_t getExtraSize(size_t NumPlacementArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001413 return NumPlacementArgs * sizeof(PlacementArg);
Daniel Jaspere9abe642016-10-10 14:13:55 +00001414 }
1415
1416 CallDeleteDuringNew(size_t NumPlacementArgs,
Richard Smithb2f0f052016-10-10 18:54:32 +00001417 const FunctionDecl *OperatorDelete, ValueTy Ptr,
1418 ValueTy AllocSize, bool PassAlignmentToPlacementDelete,
1419 CharUnits AllocAlign)
1420 : NumPlacementArgs(NumPlacementArgs),
1421 PassAlignmentToPlacementDelete(PassAlignmentToPlacementDelete),
1422 OperatorDelete(OperatorDelete), Ptr(Ptr), AllocSize(AllocSize),
1423 AllocAlign(AllocAlign) {}
Daniel Jaspere9abe642016-10-10 14:13:55 +00001424
Richard Smithb2f0f052016-10-10 18:54:32 +00001425 void setPlacementArg(unsigned I, RValueTy Arg, QualType Type) {
Daniel Jaspere9abe642016-10-10 14:13:55 +00001426 assert(I < NumPlacementArgs && "index out of range");
Richard Smithb2f0f052016-10-10 18:54:32 +00001427 getPlacementArgs()[I] = {Arg, Type};
Daniel Jaspere9abe642016-10-10 14:13:55 +00001428 }
1429
1430 void Emit(CodeGenFunction &CGF, Flags flags) override {
Simon Pilgrim16c53ff2020-01-11 15:33:25 +00001431 const auto *FPT = OperatorDelete->getType()->castAs<FunctionProtoType>();
Daniel Jaspere9abe642016-10-10 14:13:55 +00001432 CallArgList DeleteArgs;
1433
Richard Smith5b349582017-10-13 01:55:36 +00001434 // The first argument is always a void* (or C* for a destroying operator
1435 // delete for class type C).
Richard Smithb2f0f052016-10-10 18:54:32 +00001436 DeleteArgs.add(Traits::get(CGF, Ptr), FPT->getParamType(0));
Daniel Jaspere9abe642016-10-10 14:13:55 +00001437
Richard Smithb2f0f052016-10-10 18:54:32 +00001438 // Figure out what other parameters we should be implicitly passing.
Richard Smith5b349582017-10-13 01:55:36 +00001439 UsualDeleteParams Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001440 if (NumPlacementArgs) {
1441 // A placement deallocation function is implicitly passed an alignment
1442 // if the placement allocation function was, but is never passed a size.
Richard Smith5b349582017-10-13 01:55:36 +00001443 Params.Alignment = PassAlignmentToPlacementDelete;
Richard Smithb2f0f052016-10-10 18:54:32 +00001444 } else {
1445 // For a non-placement new-expression, 'operator delete' can take a
1446 // size and/or an alignment if it has the right parameters.
Richard Smith5b349582017-10-13 01:55:36 +00001447 Params = getUsualDeleteParams(OperatorDelete);
John McCall7f9c92a2010-09-17 00:50:28 +00001448 }
1449
Richard Smith5b349582017-10-13 01:55:36 +00001450 assert(!Params.DestroyingDelete &&
1451 "should not call destroying delete in a new-expression");
1452
Richard Smithb2f0f052016-10-10 18:54:32 +00001453 // The second argument can be a std::size_t (for non-placement delete).
Richard Smith5b349582017-10-13 01:55:36 +00001454 if (Params.Size)
Richard Smithb2f0f052016-10-10 18:54:32 +00001455 DeleteArgs.add(Traits::get(CGF, AllocSize),
1456 CGF.getContext().getSizeType());
1457
1458 // The next (second or third) argument can be a std::align_val_t, which
1459 // is an enum whose underlying type is std::size_t.
1460 // FIXME: Use the right type as the parameter type. Note that in a call
1461 // to operator delete(size_t, ...), we may not have it available.
Richard Smith5b349582017-10-13 01:55:36 +00001462 if (Params.Alignment)
Richard Smithb2f0f052016-10-10 18:54:32 +00001463 DeleteArgs.add(RValue::get(llvm::ConstantInt::get(
1464 CGF.SizeTy, AllocAlign.getQuantity())),
1465 CGF.getContext().getSizeType());
1466
John McCall7f9c92a2010-09-17 00:50:28 +00001467 // Pass the rest of the arguments, which must match exactly.
1468 for (unsigned I = 0; I != NumPlacementArgs; ++I) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001469 auto Arg = getPlacementArgs()[I];
1470 DeleteArgs.add(Traits::get(CGF, Arg.ArgValue), Arg.ArgType);
John McCall7f9c92a2010-09-17 00:50:28 +00001471 }
1472
1473 // Call 'operator delete'.
Richard Smith8d0dc312013-07-21 23:12:18 +00001474 EmitNewDeleteCall(CGF, OperatorDelete, FPT, DeleteArgs);
John McCall7f9c92a2010-09-17 00:50:28 +00001475 }
1476 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001477}
John McCall7f9c92a2010-09-17 00:50:28 +00001478
1479/// Enter a cleanup to call 'operator delete' if the initializer in a
1480/// new-expression throws.
1481static void EnterNewDeleteCleanup(CodeGenFunction &CGF,
1482 const CXXNewExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001483 Address NewPtr,
John McCall7f9c92a2010-09-17 00:50:28 +00001484 llvm::Value *AllocSize,
Richard Smithb2f0f052016-10-10 18:54:32 +00001485 CharUnits AllocAlign,
John McCall7f9c92a2010-09-17 00:50:28 +00001486 const CallArgList &NewArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001487 unsigned NumNonPlacementArgs = E->passAlignment() ? 2 : 1;
1488
John McCall7f9c92a2010-09-17 00:50:28 +00001489 // If we're not inside a conditional branch, then the cleanup will
1490 // dominate and we can do the easier (and more efficient) thing.
1491 if (!CGF.isInConditionalBranch()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001492 struct DirectCleanupTraits {
1493 typedef llvm::Value *ValueTy;
1494 typedef RValue RValueTy;
1495 static RValue get(CodeGenFunction &, ValueTy V) { return RValue::get(V); }
1496 static RValue get(CodeGenFunction &, RValueTy V) { return V; }
1497 };
1498
1499 typedef CallDeleteDuringNew<DirectCleanupTraits> DirectCleanup;
1500
1501 DirectCleanup *Cleanup = CGF.EHStack
1502 .pushCleanupWithExtra<DirectCleanup>(EHCleanup,
1503 E->getNumPlacementArgs(),
1504 E->getOperatorDelete(),
1505 NewPtr.getPointer(),
1506 AllocSize,
1507 E->passAlignment(),
1508 AllocAlign);
1509 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1510 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001511 Cleanup->setPlacementArg(I, Arg.getRValue(CGF), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001512 }
John McCall7f9c92a2010-09-17 00:50:28 +00001513
1514 return;
1515 }
1516
1517 // Otherwise, we need to save all this stuff.
John McCallcb5f77f2011-01-28 10:53:53 +00001518 DominatingValue<RValue>::saved_type SavedNewPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001519 DominatingValue<RValue>::save(CGF, RValue::get(NewPtr.getPointer()));
John McCallcb5f77f2011-01-28 10:53:53 +00001520 DominatingValue<RValue>::saved_type SavedAllocSize =
1521 DominatingValue<RValue>::save(CGF, RValue::get(AllocSize));
John McCall7f9c92a2010-09-17 00:50:28 +00001522
Richard Smithb2f0f052016-10-10 18:54:32 +00001523 struct ConditionalCleanupTraits {
1524 typedef DominatingValue<RValue>::saved_type ValueTy;
1525 typedef DominatingValue<RValue>::saved_type RValueTy;
1526 static RValue get(CodeGenFunction &CGF, ValueTy V) {
1527 return V.restore(CGF);
1528 }
1529 };
1530 typedef CallDeleteDuringNew<ConditionalCleanupTraits> ConditionalCleanup;
1531
1532 ConditionalCleanup *Cleanup = CGF.EHStack
1533 .pushCleanupWithExtra<ConditionalCleanup>(EHCleanup,
1534 E->getNumPlacementArgs(),
1535 E->getOperatorDelete(),
1536 SavedNewPtr,
1537 SavedAllocSize,
1538 E->passAlignment(),
1539 AllocAlign);
1540 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1541 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001542 Cleanup->setPlacementArg(
1543 I, DominatingValue<RValue>::save(CGF, Arg.getRValue(CGF)), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001544 }
John McCall7f9c92a2010-09-17 00:50:28 +00001545
John McCallf4beacd2011-11-10 10:43:54 +00001546 CGF.initFullExprCleanup();
John McCall824c2f52010-09-14 07:57:04 +00001547}
1548
Anders Carlssoncc52f652009-09-22 22:53:17 +00001549llvm::Value *CodeGenFunction::EmitCXXNewExpr(const CXXNewExpr *E) {
John McCall75f94982011-03-07 03:12:35 +00001550 // The element type being allocated.
1551 QualType allocType = getContext().getBaseElementType(E->getAllocatedType());
John McCall8ed55a52010-09-02 09:58:18 +00001552
John McCall75f94982011-03-07 03:12:35 +00001553 // 1. Build a call to the allocation function.
1554 FunctionDecl *allocator = E->getOperatorNew();
Anders Carlssoncc52f652009-09-22 22:53:17 +00001555
Sebastian Redlf862eb62012-02-22 17:37:52 +00001556 // If there is a brace-initializer, cannot allocate fewer elements than inits.
1557 unsigned minElements = 0;
1558 if (E->isArray() && E->hasInitializer()) {
Richard Smith0511d232016-10-05 22:41:02 +00001559 const InitListExpr *ILE = dyn_cast<InitListExpr>(E->getInitializer());
1560 if (ILE && ILE->isStringLiteralInit())
1561 minElements =
1562 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1563 ->getSize().getZExtValue();
1564 else if (ILE)
Sebastian Redlf862eb62012-02-22 17:37:52 +00001565 minElements = ILE->getNumInits();
1566 }
1567
Craig Topper8a13c412014-05-21 05:09:00 +00001568 llvm::Value *numElements = nullptr;
1569 llvm::Value *allocSizeWithoutCookie = nullptr;
John McCall75f94982011-03-07 03:12:35 +00001570 llvm::Value *allocSize =
Sebastian Redlf862eb62012-02-22 17:37:52 +00001571 EmitCXXNewAllocSize(*this, E, minElements, numElements,
1572 allocSizeWithoutCookie);
Richard Smithb2f0f052016-10-10 18:54:32 +00001573 CharUnits allocAlign = getContext().getTypeAlignInChars(allocType);
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00001574
John McCall7ec4b432011-05-16 01:05:12 +00001575 // Emit the allocation call. If the allocator is a global placement
1576 // operator, just "inline" it directly.
John McCall7f416cc2015-09-08 08:05:57 +00001577 Address allocation = Address::invalid();
1578 CallArgList allocatorArgs;
John McCall7ec4b432011-05-16 01:05:12 +00001579 if (allocator->isReservedGlobalPlacementOperator()) {
John McCall53dcf942015-09-29 23:55:17 +00001580 assert(E->getNumPlacementArgs() == 1);
1581 const Expr *arg = *E->placement_arguments().begin();
1582
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001583 LValueBaseInfo BaseInfo;
1584 allocation = EmitPointerWithAlignment(arg, &BaseInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001585
1586 // The pointer expression will, in many cases, be an opaque void*.
1587 // In these cases, discard the computed alignment and use the
1588 // formal alignment of the allocated type.
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001589 if (BaseInfo.getAlignmentSource() != AlignmentSource::Decl)
Richard Smithb2f0f052016-10-10 18:54:32 +00001590 allocation = Address(allocation.getPointer(), allocAlign);
John McCall7f416cc2015-09-08 08:05:57 +00001591
John McCall53dcf942015-09-29 23:55:17 +00001592 // Set up allocatorArgs for the call to operator delete if it's not
1593 // the reserved global operator.
1594 if (E->getOperatorDelete() &&
1595 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
1596 allocatorArgs.add(RValue::get(allocSize), getContext().getSizeType());
1597 allocatorArgs.add(RValue::get(allocation.getPointer()), arg->getType());
1598 }
1599
John McCall7ec4b432011-05-16 01:05:12 +00001600 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001601 const FunctionProtoType *allocatorType =
1602 allocator->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001603 unsigned ParamsToSkip = 0;
John McCall7f416cc2015-09-08 08:05:57 +00001604
1605 // The allocation size is the first argument.
1606 QualType sizeType = getContext().getSizeType();
1607 allocatorArgs.add(RValue::get(allocSize), sizeType);
Richard Smithb2f0f052016-10-10 18:54:32 +00001608 ++ParamsToSkip;
John McCall7f416cc2015-09-08 08:05:57 +00001609
Richard Smithb2f0f052016-10-10 18:54:32 +00001610 if (allocSize != allocSizeWithoutCookie) {
1611 CharUnits cookieAlign = getSizeAlign(); // FIXME: Ask the ABI.
1612 allocAlign = std::max(allocAlign, cookieAlign);
1613 }
1614
1615 // The allocation alignment may be passed as the second argument.
1616 if (E->passAlignment()) {
1617 QualType AlignValT = sizeType;
1618 if (allocatorType->getNumParams() > 1) {
1619 AlignValT = allocatorType->getParamType(1);
1620 assert(getContext().hasSameUnqualifiedType(
1621 AlignValT->castAs<EnumType>()->getDecl()->getIntegerType(),
1622 sizeType) &&
1623 "wrong type for alignment parameter");
1624 ++ParamsToSkip;
1625 } else {
1626 // Corner case, passing alignment to 'operator new(size_t, ...)'.
1627 assert(allocator->isVariadic() && "can't pass alignment to allocator");
1628 }
1629 allocatorArgs.add(
1630 RValue::get(llvm::ConstantInt::get(SizeTy, allocAlign.getQuantity())),
1631 AlignValT);
1632 }
1633
1634 // FIXME: Why do we not pass a CalleeDecl here?
John McCall7f416cc2015-09-08 08:05:57 +00001635 EmitCallArgs(allocatorArgs, allocatorType, E->placement_arguments(),
Vedant Kumared00ea02017-03-06 05:28:22 +00001636 /*AC*/AbstractCallee(), /*ParamsToSkip*/ParamsToSkip);
John McCall7f416cc2015-09-08 08:05:57 +00001637
1638 RValue RV =
1639 EmitNewDeleteCall(*this, allocator, allocatorType, allocatorArgs);
1640
Richard Smithb2f0f052016-10-10 18:54:32 +00001641 // If this was a call to a global replaceable allocation function that does
1642 // not take an alignment argument, the allocator is known to produce
1643 // storage that's suitably aligned for any object that fits, up to a known
1644 // threshold. Otherwise assume it's suitably aligned for the allocated type.
1645 CharUnits allocationAlign = allocAlign;
1646 if (!E->passAlignment() &&
1647 allocator->isReplaceableGlobalAllocationFunction()) {
1648 unsigned AllocatorAlign = llvm::PowerOf2Floor(std::min<uint64_t>(
1649 Target.getNewAlign(), getContext().getTypeSize(allocType)));
1650 allocationAlign = std::max(
1651 allocationAlign, getContext().toCharUnitsFromBits(AllocatorAlign));
John McCall7f416cc2015-09-08 08:05:57 +00001652 }
1653
1654 allocation = Address(RV.getScalarVal(), allocationAlign);
John McCall7ec4b432011-05-16 01:05:12 +00001655 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00001656
John McCall75f94982011-03-07 03:12:35 +00001657 // Emit a null check on the allocation result if the allocation
1658 // function is allowed to return null (because it has a non-throwing
Richard Smith902a0232015-02-14 01:52:20 +00001659 // exception spec or is the reserved placement new) and we have an
Richard Smith2f72a752019-01-10 00:03:29 +00001660 // interesting initializer will be running sanitizers on the initialization.
Bruno Ricci9b6dfac2019-01-07 15:04:45 +00001661 bool nullCheck = E->shouldNullCheckAllocation() &&
Richard Smith2f72a752019-01-10 00:03:29 +00001662 (!allocType.isPODType(getContext()) || E->hasInitializer() ||
1663 sanitizePerformTypeCheck());
Anders Carlssoncc52f652009-09-22 22:53:17 +00001664
Craig Topper8a13c412014-05-21 05:09:00 +00001665 llvm::BasicBlock *nullCheckBB = nullptr;
1666 llvm::BasicBlock *contBB = nullptr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001667
John McCallf7dcf322011-03-07 01:52:56 +00001668 // The null-check means that the initializer is conditionally
1669 // evaluated.
1670 ConditionalEvaluation conditional(*this);
1671
John McCall75f94982011-03-07 03:12:35 +00001672 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001673 conditional.begin(*this);
John McCall75f94982011-03-07 03:12:35 +00001674
1675 nullCheckBB = Builder.GetInsertBlock();
1676 llvm::BasicBlock *notNullBB = createBasicBlock("new.notnull");
1677 contBB = createBasicBlock("new.cont");
1678
John McCall7f416cc2015-09-08 08:05:57 +00001679 llvm::Value *isNull =
1680 Builder.CreateIsNull(allocation.getPointer(), "new.isnull");
John McCall75f94982011-03-07 03:12:35 +00001681 Builder.CreateCondBr(isNull, contBB, notNullBB);
1682 EmitBlock(notNullBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001683 }
Anders Carlssonf7716812009-09-23 18:59:48 +00001684
John McCall824c2f52010-09-14 07:57:04 +00001685 // If there's an operator delete, enter a cleanup to call it if an
1686 // exception is thrown.
John McCall75f94982011-03-07 03:12:35 +00001687 EHScopeStack::stable_iterator operatorDeleteCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001688 llvm::Instruction *cleanupDominator = nullptr;
John McCall7ec4b432011-05-16 01:05:12 +00001689 if (E->getOperatorDelete() &&
1690 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001691 EnterNewDeleteCleanup(*this, E, allocation, allocSize, allocAlign,
1692 allocatorArgs);
John McCall75f94982011-03-07 03:12:35 +00001693 operatorDeleteCleanup = EHStack.stable_begin();
John McCallf4beacd2011-11-10 10:43:54 +00001694 cleanupDominator = Builder.CreateUnreachable();
John McCall824c2f52010-09-14 07:57:04 +00001695 }
1696
Eli Friedmancf9b1f62011-09-06 18:53:03 +00001697 assert((allocSize == allocSizeWithoutCookie) ==
1698 CalculateCookiePadding(*this, E).isZero());
1699 if (allocSize != allocSizeWithoutCookie) {
1700 assert(E->isArray());
1701 allocation = CGM.getCXXABI().InitializeArrayCookie(*this, allocation,
1702 numElements,
1703 E, allocType);
1704 }
1705
David Blaikiefb901c7a2015-04-04 15:12:29 +00001706 llvm::Type *elementTy = ConvertTypeForMem(allocType);
John McCall7f416cc2015-09-08 08:05:57 +00001707 Address result = Builder.CreateElementBitCast(allocation, elementTy);
John McCall824c2f52010-09-14 07:57:04 +00001708
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001709 // Passing pointer through launder.invariant.group to avoid propagation of
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001710 // vptrs information which may be included in previous type.
Piotr Padlewski31fd99c2017-05-20 08:56:18 +00001711 // To not break LTO with different optimizations levels, we do it regardless
1712 // of optimization level.
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001713 if (CGM.getCodeGenOpts().StrictVTablePointers &&
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001714 allocator->isReservedGlobalPlacementOperator())
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001715 result = Address(Builder.CreateLaunderInvariantGroup(result.getPointer()),
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001716 result.getAlignment());
1717
Serge Pavlov37605182018-07-28 15:33:03 +00001718 // Emit sanitizer checks for pointer value now, so that in the case of an
Richard Smithcfa79b22019-01-23 03:37:29 +00001719 // array it was checked only once and not at each constructor call. We may
1720 // have already checked that the pointer is non-null.
1721 // FIXME: If we have an array cookie and a potentially-throwing allocator,
1722 // we'll null check the wrong pointer here.
1723 SanitizerSet SkippedChecks;
1724 SkippedChecks.set(SanitizerKind::Null, nullCheck);
Serge Pavlov37605182018-07-28 15:33:03 +00001725 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall,
Richard Smithcfa79b22019-01-23 03:37:29 +00001726 E->getAllocatedTypeSourceInfo()->getTypeLoc().getBeginLoc(),
1727 result.getPointer(), allocType, result.getAlignment(),
1728 SkippedChecks, numElements);
Serge Pavlov37605182018-07-28 15:33:03 +00001729
David Blaikiefb901c7a2015-04-04 15:12:29 +00001730 EmitNewInitializer(*this, E, allocType, elementTy, result, numElements,
John McCall99210dc2011-09-15 06:49:18 +00001731 allocSizeWithoutCookie);
John McCall8ed55a52010-09-02 09:58:18 +00001732 if (E->isArray()) {
John McCall8ed55a52010-09-02 09:58:18 +00001733 // NewPtr is a pointer to the base element type. If we're
1734 // allocating an array of arrays, we'll need to cast back to the
1735 // array pointer type.
Chris Lattner2192fe52011-07-18 04:24:23 +00001736 llvm::Type *resultType = ConvertTypeForMem(E->getType());
John McCall7f416cc2015-09-08 08:05:57 +00001737 if (result.getType() != resultType)
John McCall75f94982011-03-07 03:12:35 +00001738 result = Builder.CreateBitCast(result, resultType);
Fariborz Jahanian47b46292010-03-24 16:57:01 +00001739 }
John McCall824c2f52010-09-14 07:57:04 +00001740
1741 // Deactivate the 'operator delete' cleanup if we finished
1742 // initialization.
John McCallf4beacd2011-11-10 10:43:54 +00001743 if (operatorDeleteCleanup.isValid()) {
1744 DeactivateCleanupBlock(operatorDeleteCleanup, cleanupDominator);
1745 cleanupDominator->eraseFromParent();
1746 }
Sebastian Redl6047f072012-02-16 12:22:20 +00001747
John McCall7f416cc2015-09-08 08:05:57 +00001748 llvm::Value *resultPtr = result.getPointer();
John McCall75f94982011-03-07 03:12:35 +00001749 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001750 conditional.end(*this);
1751
John McCall75f94982011-03-07 03:12:35 +00001752 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
1753 EmitBlock(contBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001754
John McCall7f416cc2015-09-08 08:05:57 +00001755 llvm::PHINode *PHI = Builder.CreatePHI(resultPtr->getType(), 2);
1756 PHI->addIncoming(resultPtr, notNullBB);
1757 PHI->addIncoming(llvm::Constant::getNullValue(resultPtr->getType()),
John McCall75f94982011-03-07 03:12:35 +00001758 nullCheckBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001759
John McCall7f416cc2015-09-08 08:05:57 +00001760 resultPtr = PHI;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001761 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001762
John McCall7f416cc2015-09-08 08:05:57 +00001763 return resultPtr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001764}
1765
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001766void CodeGenFunction::EmitDeleteCall(const FunctionDecl *DeleteFD,
Richard Smithb2f0f052016-10-10 18:54:32 +00001767 llvm::Value *Ptr, QualType DeleteTy,
1768 llvm::Value *NumElements,
1769 CharUnits CookieSize) {
1770 assert((!NumElements && CookieSize.isZero()) ||
1771 DeleteFD->getOverloadedOperator() == OO_Array_Delete);
John McCall8ed55a52010-09-02 09:58:18 +00001772
Simon Pilgrim16c53ff2020-01-11 15:33:25 +00001773 const auto *DeleteFTy = DeleteFD->getType()->castAs<FunctionProtoType>();
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001774 CallArgList DeleteArgs;
1775
Richard Smith5b349582017-10-13 01:55:36 +00001776 auto Params = getUsualDeleteParams(DeleteFD);
Richard Smithb2f0f052016-10-10 18:54:32 +00001777 auto ParamTypeIt = DeleteFTy->param_type_begin();
1778
1779 // Pass the pointer itself.
1780 QualType ArgTy = *ParamTypeIt++;
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001781 llvm::Value *DeletePtr = Builder.CreateBitCast(Ptr, ConvertType(ArgTy));
Eli Friedman43dca6a2011-05-02 17:57:46 +00001782 DeleteArgs.add(RValue::get(DeletePtr), ArgTy);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001783
Richard Smith5b349582017-10-13 01:55:36 +00001784 // Pass the std::destroying_delete tag if present.
1785 if (Params.DestroyingDelete) {
1786 QualType DDTag = *ParamTypeIt++;
1787 // Just pass an 'undef'. We expect the tag type to be an empty struct.
1788 auto *V = llvm::UndefValue::get(getTypes().ConvertType(DDTag));
1789 DeleteArgs.add(RValue::get(V), DDTag);
1790 }
1791
Richard Smithb2f0f052016-10-10 18:54:32 +00001792 // Pass the size if the delete function has a size_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001793 if (Params.Size) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001794 QualType SizeType = *ParamTypeIt++;
1795 CharUnits DeleteTypeSize = getContext().getTypeSizeInChars(DeleteTy);
1796 llvm::Value *Size = llvm::ConstantInt::get(ConvertType(SizeType),
1797 DeleteTypeSize.getQuantity());
1798
1799 // For array new, multiply by the number of elements.
1800 if (NumElements)
1801 Size = Builder.CreateMul(Size, NumElements);
1802
1803 // If there is a cookie, add the cookie size.
1804 if (!CookieSize.isZero())
1805 Size = Builder.CreateAdd(
1806 Size, llvm::ConstantInt::get(SizeTy, CookieSize.getQuantity()));
1807
1808 DeleteArgs.add(RValue::get(Size), SizeType);
1809 }
1810
1811 // Pass the alignment if the delete function has an align_val_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001812 if (Params.Alignment) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001813 QualType AlignValType = *ParamTypeIt++;
1814 CharUnits DeleteTypeAlign = getContext().toCharUnitsFromBits(
1815 getContext().getTypeAlignIfKnown(DeleteTy));
1816 llvm::Value *Align = llvm::ConstantInt::get(ConvertType(AlignValType),
1817 DeleteTypeAlign.getQuantity());
1818 DeleteArgs.add(RValue::get(Align), AlignValType);
1819 }
1820
1821 assert(ParamTypeIt == DeleteFTy->param_type_end() &&
1822 "unknown parameter to usual delete function");
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001823
1824 // Emit the call to delete.
Richard Smith8d0dc312013-07-21 23:12:18 +00001825 EmitNewDeleteCall(*this, DeleteFD, DeleteFTy, DeleteArgs);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001826}
1827
John McCall8ed55a52010-09-02 09:58:18 +00001828namespace {
1829 /// Calls the given 'operator delete' on a single object.
David Blaikie7e70d682015-08-18 22:40:54 +00001830 struct CallObjectDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001831 llvm::Value *Ptr;
1832 const FunctionDecl *OperatorDelete;
1833 QualType ElementType;
1834
1835 CallObjectDelete(llvm::Value *Ptr,
1836 const FunctionDecl *OperatorDelete,
1837 QualType ElementType)
1838 : Ptr(Ptr), OperatorDelete(OperatorDelete), ElementType(ElementType) {}
1839
Craig Topper4f12f102014-03-12 06:41:41 +00001840 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall8ed55a52010-09-02 09:58:18 +00001841 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType);
1842 }
1843 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001844}
John McCall8ed55a52010-09-02 09:58:18 +00001845
David Majnemer0c0b6d92014-10-31 20:09:12 +00001846void
1847CodeGenFunction::pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1848 llvm::Value *CompletePtr,
1849 QualType ElementType) {
1850 EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup, CompletePtr,
1851 OperatorDelete, ElementType);
1852}
1853
Richard Smith5b349582017-10-13 01:55:36 +00001854/// Emit the code for deleting a single object with a destroying operator
1855/// delete. If the element type has a non-virtual destructor, Ptr has already
1856/// been converted to the type of the parameter of 'operator delete'. Otherwise
1857/// Ptr points to an object of the static type.
1858static void EmitDestroyingObjectDelete(CodeGenFunction &CGF,
1859 const CXXDeleteExpr *DE, Address Ptr,
1860 QualType ElementType) {
1861 auto *Dtor = ElementType->getAsCXXRecordDecl()->getDestructor();
1862 if (Dtor && Dtor->isVirtual())
1863 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1864 Dtor);
1865 else
1866 CGF.EmitDeleteCall(DE->getOperatorDelete(), Ptr.getPointer(), ElementType);
1867}
1868
John McCall8ed55a52010-09-02 09:58:18 +00001869/// Emit the code for deleting a single object.
1870static void EmitObjectDelete(CodeGenFunction &CGF,
David Majnemer08681372014-11-01 07:37:17 +00001871 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +00001872 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +00001873 QualType ElementType) {
Ivan Krasind98f5d72016-11-17 00:39:48 +00001874 // C++11 [expr.delete]p3:
1875 // If the static type of the object to be deleted is different from its
1876 // dynamic type, the static type shall be a base class of the dynamic type
1877 // of the object to be deleted and the static type shall have a virtual
1878 // destructor or the behavior is undefined.
1879 CGF.EmitTypeCheck(CodeGenFunction::TCK_MemberCall,
1880 DE->getExprLoc(), Ptr.getPointer(),
1881 ElementType);
1882
Richard Smith5b349582017-10-13 01:55:36 +00001883 const FunctionDecl *OperatorDelete = DE->getOperatorDelete();
1884 assert(!OperatorDelete->isDestroyingOperatorDelete());
1885
John McCall8ed55a52010-09-02 09:58:18 +00001886 // Find the destructor for the type, if applicable. If the
1887 // destructor is virtual, we'll just emit the vcall and return.
Craig Topper8a13c412014-05-21 05:09:00 +00001888 const CXXDestructorDecl *Dtor = nullptr;
John McCall8ed55a52010-09-02 09:58:18 +00001889 if (const RecordType *RT = ElementType->getAs<RecordType>()) {
1890 CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Eli Friedmanb23533d2011-08-02 18:05:30 +00001891 if (RD->hasDefinition() && !RD->hasTrivialDestructor()) {
John McCall8ed55a52010-09-02 09:58:18 +00001892 Dtor = RD->getDestructor();
1893
1894 if (Dtor->isVirtual()) {
Hiroshi Yamauchicb305902019-08-08 18:00:49 +00001895 bool UseVirtualCall = true;
1896 const Expr *Base = DE->getArgument();
1897 if (auto *DevirtualizedDtor =
1898 dyn_cast_or_null<const CXXDestructorDecl>(
1899 Dtor->getDevirtualizedMethod(
1900 Base, CGF.CGM.getLangOpts().AppleKext))) {
1901 UseVirtualCall = false;
1902 const CXXRecordDecl *DevirtualizedClass =
1903 DevirtualizedDtor->getParent();
1904 if (declaresSameEntity(getCXXRecord(Base), DevirtualizedClass)) {
1905 // Devirtualized to the class of the base type (the type of the
1906 // whole expression).
1907 Dtor = DevirtualizedDtor;
1908 } else {
1909 // Devirtualized to some other type. Would need to cast the this
1910 // pointer to that type but we don't have support for that yet, so
1911 // do a virtual call. FIXME: handle the case where it is
1912 // devirtualized to the derived type (the type of the inner
1913 // expression) as in EmitCXXMemberOrOperatorMemberCallExpr.
1914 UseVirtualCall = true;
1915 }
1916 }
1917 if (UseVirtualCall) {
1918 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1919 Dtor);
1920 return;
1921 }
John McCall8ed55a52010-09-02 09:58:18 +00001922 }
1923 }
1924 }
1925
1926 // Make sure that we call delete even if the dtor throws.
John McCalle4df6c82011-01-28 08:37:24 +00001927 // This doesn't have to a conditional cleanup because we're going
1928 // to pop it off in a second.
John McCall8ed55a52010-09-02 09:58:18 +00001929 CGF.EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup,
John McCall7f416cc2015-09-08 08:05:57 +00001930 Ptr.getPointer(),
1931 OperatorDelete, ElementType);
John McCall8ed55a52010-09-02 09:58:18 +00001932
1933 if (Dtor)
1934 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +00001935 /*ForVirtualBase=*/false,
1936 /*Delegating=*/false,
Marco Antognini88559632019-07-22 09:39:13 +00001937 Ptr, ElementType);
John McCall460ce582015-10-22 18:38:17 +00001938 else if (auto Lifetime = ElementType.getObjCLifetime()) {
1939 switch (Lifetime) {
John McCall31168b02011-06-15 23:02:42 +00001940 case Qualifiers::OCL_None:
1941 case Qualifiers::OCL_ExplicitNone:
1942 case Qualifiers::OCL_Autoreleasing:
1943 break;
John McCall8ed55a52010-09-02 09:58:18 +00001944
John McCall7f416cc2015-09-08 08:05:57 +00001945 case Qualifiers::OCL_Strong:
1946 CGF.EmitARCDestroyStrong(Ptr, ARCPreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001947 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00001948
John McCall31168b02011-06-15 23:02:42 +00001949 case Qualifiers::OCL_Weak:
1950 CGF.EmitARCDestroyWeak(Ptr);
1951 break;
1952 }
1953 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001954
John McCall8ed55a52010-09-02 09:58:18 +00001955 CGF.PopCleanupBlock();
1956}
1957
1958namespace {
1959 /// Calls the given 'operator delete' on an array of objects.
David Blaikie7e70d682015-08-18 22:40:54 +00001960 struct CallArrayDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001961 llvm::Value *Ptr;
1962 const FunctionDecl *OperatorDelete;
1963 llvm::Value *NumElements;
1964 QualType ElementType;
1965 CharUnits CookieSize;
1966
1967 CallArrayDelete(llvm::Value *Ptr,
1968 const FunctionDecl *OperatorDelete,
1969 llvm::Value *NumElements,
1970 QualType ElementType,
1971 CharUnits CookieSize)
1972 : Ptr(Ptr), OperatorDelete(OperatorDelete), NumElements(NumElements),
1973 ElementType(ElementType), CookieSize(CookieSize) {}
1974
Craig Topper4f12f102014-03-12 06:41:41 +00001975 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001976 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType, NumElements,
1977 CookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001978 }
1979 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001980}
John McCall8ed55a52010-09-02 09:58:18 +00001981
1982/// Emit the code for deleting an array of objects.
1983static void EmitArrayDelete(CodeGenFunction &CGF,
John McCall284c48f2011-01-27 09:37:56 +00001984 const CXXDeleteExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001985 Address deletedPtr,
John McCallca2c56f2011-07-13 01:41:37 +00001986 QualType elementType) {
Craig Topper8a13c412014-05-21 05:09:00 +00001987 llvm::Value *numElements = nullptr;
1988 llvm::Value *allocatedPtr = nullptr;
John McCallca2c56f2011-07-13 01:41:37 +00001989 CharUnits cookieSize;
1990 CGF.CGM.getCXXABI().ReadArrayCookie(CGF, deletedPtr, E, elementType,
1991 numElements, allocatedPtr, cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001992
John McCallca2c56f2011-07-13 01:41:37 +00001993 assert(allocatedPtr && "ReadArrayCookie didn't set allocated pointer");
John McCall8ed55a52010-09-02 09:58:18 +00001994
1995 // Make sure that we call delete even if one of the dtors throws.
John McCallca2c56f2011-07-13 01:41:37 +00001996 const FunctionDecl *operatorDelete = E->getOperatorDelete();
John McCall8ed55a52010-09-02 09:58:18 +00001997 CGF.EHStack.pushCleanup<CallArrayDelete>(NormalAndEHCleanup,
John McCallca2c56f2011-07-13 01:41:37 +00001998 allocatedPtr, operatorDelete,
1999 numElements, elementType,
2000 cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00002001
John McCallca2c56f2011-07-13 01:41:37 +00002002 // Destroy the elements.
2003 if (QualType::DestructionKind dtorKind = elementType.isDestructedType()) {
2004 assert(numElements && "no element count for a type with a destructor!");
2005
John McCall7f416cc2015-09-08 08:05:57 +00002006 CharUnits elementSize = CGF.getContext().getTypeSizeInChars(elementType);
2007 CharUnits elementAlign =
2008 deletedPtr.getAlignment().alignmentOfArrayElement(elementSize);
2009
2010 llvm::Value *arrayBegin = deletedPtr.getPointer();
John McCallca2c56f2011-07-13 01:41:37 +00002011 llvm::Value *arrayEnd =
John McCall7f416cc2015-09-08 08:05:57 +00002012 CGF.Builder.CreateInBoundsGEP(arrayBegin, numElements, "delete.end");
John McCall97eab0a2011-07-13 08:09:46 +00002013
2014 // Note that it is legal to allocate a zero-length array, and we
2015 // can never fold the check away because the length should always
2016 // come from a cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002017 CGF.emitArrayDestroy(arrayBegin, arrayEnd, elementType, elementAlign,
John McCallca2c56f2011-07-13 01:41:37 +00002018 CGF.getDestroyer(dtorKind),
John McCall97eab0a2011-07-13 08:09:46 +00002019 /*checkZeroLength*/ true,
John McCallca2c56f2011-07-13 01:41:37 +00002020 CGF.needsEHCleanup(dtorKind));
John McCall8ed55a52010-09-02 09:58:18 +00002021 }
2022
John McCallca2c56f2011-07-13 01:41:37 +00002023 // Pop the cleanup block.
John McCall8ed55a52010-09-02 09:58:18 +00002024 CGF.PopCleanupBlock();
2025}
2026
Anders Carlssoncc52f652009-09-22 22:53:17 +00002027void CodeGenFunction::EmitCXXDeleteExpr(const CXXDeleteExpr *E) {
Douglas Gregorbb3e12f2009-09-29 18:16:17 +00002028 const Expr *Arg = E->getArgument();
John McCall7f416cc2015-09-08 08:05:57 +00002029 Address Ptr = EmitPointerWithAlignment(Arg);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002030
2031 // Null check the pointer.
2032 llvm::BasicBlock *DeleteNotNull = createBasicBlock("delete.notnull");
2033 llvm::BasicBlock *DeleteEnd = createBasicBlock("delete.end");
2034
John McCall7f416cc2015-09-08 08:05:57 +00002035 llvm::Value *IsNull = Builder.CreateIsNull(Ptr.getPointer(), "isnull");
Anders Carlssoncc52f652009-09-22 22:53:17 +00002036
2037 Builder.CreateCondBr(IsNull, DeleteEnd, DeleteNotNull);
2038 EmitBlock(DeleteNotNull);
Anders Carlssone828c362009-11-13 04:45:41 +00002039
Richard Smith5b349582017-10-13 01:55:36 +00002040 QualType DeleteTy = E->getDestroyedType();
2041
2042 // A destroying operator delete overrides the entire operation of the
2043 // delete expression.
2044 if (E->getOperatorDelete()->isDestroyingOperatorDelete()) {
2045 EmitDestroyingObjectDelete(*this, E, Ptr, DeleteTy);
2046 EmitBlock(DeleteEnd);
2047 return;
2048 }
2049
John McCall8ed55a52010-09-02 09:58:18 +00002050 // We might be deleting a pointer to array. If so, GEP down to the
2051 // first non-array element.
2052 // (this assumes that A(*)[3][7] is converted to [3 x [7 x %A]]*)
John McCall8ed55a52010-09-02 09:58:18 +00002053 if (DeleteTy->isConstantArrayType()) {
2054 llvm::Value *Zero = Builder.getInt32(0);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002055 SmallVector<llvm::Value*,8> GEP;
John McCall8ed55a52010-09-02 09:58:18 +00002056
2057 GEP.push_back(Zero); // point at the outermost array
2058
2059 // For each layer of array type we're pointing at:
2060 while (const ConstantArrayType *Arr
2061 = getContext().getAsConstantArrayType(DeleteTy)) {
2062 // 1. Unpeel the array type.
2063 DeleteTy = Arr->getElementType();
2064
2065 // 2. GEP to the first element of the array.
2066 GEP.push_back(Zero);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002067 }
John McCall8ed55a52010-09-02 09:58:18 +00002068
John McCall7f416cc2015-09-08 08:05:57 +00002069 Ptr = Address(Builder.CreateInBoundsGEP(Ptr.getPointer(), GEP, "del.first"),
2070 Ptr.getAlignment());
Anders Carlssoncc52f652009-09-22 22:53:17 +00002071 }
2072
John McCall7f416cc2015-09-08 08:05:57 +00002073 assert(ConvertTypeForMem(DeleteTy) == Ptr.getElementType());
John McCall8ed55a52010-09-02 09:58:18 +00002074
Reid Kleckner7270ef52015-03-19 17:03:58 +00002075 if (E->isArrayForm()) {
2076 EmitArrayDelete(*this, E, Ptr, DeleteTy);
2077 } else {
2078 EmitObjectDelete(*this, E, Ptr, DeleteTy);
2079 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00002080
Anders Carlssoncc52f652009-09-22 22:53:17 +00002081 EmitBlock(DeleteEnd);
2082}
Mike Stumpc9b231c2009-11-15 08:09:41 +00002083
David Majnemer1c3d95e2014-07-19 00:17:06 +00002084static bool isGLValueFromPointerDeref(const Expr *E) {
2085 E = E->IgnoreParens();
2086
2087 if (const auto *CE = dyn_cast<CastExpr>(E)) {
2088 if (!CE->getSubExpr()->isGLValue())
2089 return false;
2090 return isGLValueFromPointerDeref(CE->getSubExpr());
2091 }
2092
2093 if (const auto *OVE = dyn_cast<OpaqueValueExpr>(E))
2094 return isGLValueFromPointerDeref(OVE->getSourceExpr());
2095
2096 if (const auto *BO = dyn_cast<BinaryOperator>(E))
2097 if (BO->getOpcode() == BO_Comma)
2098 return isGLValueFromPointerDeref(BO->getRHS());
2099
2100 if (const auto *ACO = dyn_cast<AbstractConditionalOperator>(E))
2101 return isGLValueFromPointerDeref(ACO->getTrueExpr()) ||
2102 isGLValueFromPointerDeref(ACO->getFalseExpr());
2103
2104 // C++11 [expr.sub]p1:
2105 // The expression E1[E2] is identical (by definition) to *((E1)+(E2))
2106 if (isa<ArraySubscriptExpr>(E))
2107 return true;
2108
2109 if (const auto *UO = dyn_cast<UnaryOperator>(E))
2110 if (UO->getOpcode() == UO_Deref)
2111 return true;
2112
2113 return false;
2114}
2115
Warren Hunt747e3012014-06-18 21:15:55 +00002116static llvm::Value *EmitTypeidFromVTable(CodeGenFunction &CGF, const Expr *E,
Chris Lattner2192fe52011-07-18 04:24:23 +00002117 llvm::Type *StdTypeInfoPtrTy) {
Anders Carlsson940f02d2011-04-18 00:57:03 +00002118 // Get the vtable pointer.
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002119 Address ThisPtr = CGF.EmitLValue(E).getAddress(CGF);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002120
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002121 QualType SrcRecordTy = E->getType();
2122
2123 // C++ [class.cdtor]p4:
2124 // If the operand of typeid refers to the object under construction or
2125 // destruction and the static type of the operand is neither the constructor
2126 // or destructor’s class nor one of its bases, the behavior is undefined.
2127 CGF.EmitTypeCheck(CodeGenFunction::TCK_DynamicOperation, E->getExprLoc(),
2128 ThisPtr.getPointer(), SrcRecordTy);
2129
Anders Carlsson940f02d2011-04-18 00:57:03 +00002130 // C++ [expr.typeid]p2:
2131 // If the glvalue expression is obtained by applying the unary * operator to
2132 // a pointer and the pointer is a null pointer value, the typeid expression
2133 // throws the std::bad_typeid exception.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002134 //
2135 // However, this paragraph's intent is not clear. We choose a very generous
2136 // interpretation which implores us to consider comma operators, conditional
2137 // operators, parentheses and other such constructs.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002138 if (CGF.CGM.getCXXABI().shouldTypeidBeNullChecked(
2139 isGLValueFromPointerDeref(E), SrcRecordTy)) {
David Majnemer1162d252014-06-22 19:05:33 +00002140 llvm::BasicBlock *BadTypeidBlock =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002141 CGF.createBasicBlock("typeid.bad_typeid");
David Majnemer1162d252014-06-22 19:05:33 +00002142 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("typeid.end");
Anders Carlsson940f02d2011-04-18 00:57:03 +00002143
John McCall7f416cc2015-09-08 08:05:57 +00002144 llvm::Value *IsNull = CGF.Builder.CreateIsNull(ThisPtr.getPointer());
David Majnemer1162d252014-06-22 19:05:33 +00002145 CGF.Builder.CreateCondBr(IsNull, BadTypeidBlock, EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002146
David Majnemer1162d252014-06-22 19:05:33 +00002147 CGF.EmitBlock(BadTypeidBlock);
2148 CGF.CGM.getCXXABI().EmitBadTypeidCall(CGF);
2149 CGF.EmitBlock(EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002150 }
2151
David Majnemer1162d252014-06-22 19:05:33 +00002152 return CGF.CGM.getCXXABI().EmitTypeid(CGF, SrcRecordTy, ThisPtr,
2153 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002154}
2155
John McCalle4df6c82011-01-28 08:37:24 +00002156llvm::Value *CodeGenFunction::EmitCXXTypeidExpr(const CXXTypeidExpr *E) {
Fangrui Song6907ce22018-07-30 19:24:48 +00002157 llvm::Type *StdTypeInfoPtrTy =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002158 ConvertType(E->getType())->getPointerTo();
Fangrui Song6907ce22018-07-30 19:24:48 +00002159
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002160 if (E->isTypeOperand()) {
David Majnemer143c55e2013-09-27 07:04:31 +00002161 llvm::Constant *TypeInfo =
2162 CGM.GetAddrOfRTTIDescriptor(E->getTypeOperand(getContext()));
Anders Carlsson940f02d2011-04-18 00:57:03 +00002163 return Builder.CreateBitCast(TypeInfo, StdTypeInfoPtrTy);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002164 }
Anders Carlsson0c633502011-04-11 14:13:40 +00002165
Anders Carlsson940f02d2011-04-18 00:57:03 +00002166 // C++ [expr.typeid]p2:
2167 // When typeid is applied to a glvalue expression whose type is a
2168 // polymorphic class type, the result refers to a std::type_info object
2169 // representing the type of the most derived object (that is, the dynamic
2170 // type) to which the glvalue refers.
Richard Smithef8bf432012-08-13 20:08:14 +00002171 if (E->isPotentiallyEvaluated())
Fangrui Song6907ce22018-07-30 19:24:48 +00002172 return EmitTypeidFromVTable(*this, E->getExprOperand(),
Richard Smithef8bf432012-08-13 20:08:14 +00002173 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002174
2175 QualType OperandTy = E->getExprOperand()->getType();
2176 return Builder.CreateBitCast(CGM.GetAddrOfRTTIDescriptor(OperandTy),
2177 StdTypeInfoPtrTy);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002178}
Mike Stump65511702009-11-16 06:50:58 +00002179
Anders Carlssonc1c99712011-04-11 01:45:29 +00002180static llvm::Value *EmitDynamicCastToNull(CodeGenFunction &CGF,
2181 QualType DestTy) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002182 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
Anders Carlssonc1c99712011-04-11 01:45:29 +00002183 if (DestTy->isPointerType())
2184 return llvm::Constant::getNullValue(DestLTy);
2185
2186 /// C++ [expr.dynamic.cast]p9:
2187 /// A failed cast to reference type throws std::bad_cast
David Majnemer1162d252014-06-22 19:05:33 +00002188 if (!CGF.CGM.getCXXABI().EmitBadCastCall(CGF))
2189 return nullptr;
Anders Carlssonc1c99712011-04-11 01:45:29 +00002190
2191 CGF.EmitBlock(CGF.createBasicBlock("dynamic_cast.end"));
2192 return llvm::UndefValue::get(DestLTy);
2193}
2194
John McCall7f416cc2015-09-08 08:05:57 +00002195llvm::Value *CodeGenFunction::EmitDynamicCast(Address ThisAddr,
Mike Stump65511702009-11-16 06:50:58 +00002196 const CXXDynamicCastExpr *DCE) {
Alexey Bataev2bf9b4c2015-10-20 04:24:12 +00002197 CGM.EmitExplicitCastExprType(DCE, this);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002198 QualType DestTy = DCE->getTypeAsWritten();
Anders Carlsson882d7902011-04-11 00:46:40 +00002199
Anders Carlssonc1c99712011-04-11 01:45:29 +00002200 QualType SrcTy = DCE->getSubExpr()->getType();
2201
David Majnemer1162d252014-06-22 19:05:33 +00002202 // C++ [expr.dynamic.cast]p7:
2203 // If T is "pointer to cv void," then the result is a pointer to the most
2204 // derived object pointed to by v.
2205 const PointerType *DestPTy = DestTy->getAs<PointerType>();
2206
2207 bool isDynamicCastToVoid;
2208 QualType SrcRecordTy;
2209 QualType DestRecordTy;
2210 if (DestPTy) {
2211 isDynamicCastToVoid = DestPTy->getPointeeType()->isVoidType();
2212 SrcRecordTy = SrcTy->castAs<PointerType>()->getPointeeType();
2213 DestRecordTy = DestPTy->getPointeeType();
2214 } else {
2215 isDynamicCastToVoid = false;
2216 SrcRecordTy = SrcTy;
2217 DestRecordTy = DestTy->castAs<ReferenceType>()->getPointeeType();
2218 }
2219
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002220 // C++ [class.cdtor]p5:
2221 // If the operand of the dynamic_cast refers to the object under
2222 // construction or destruction and the static type of the operand is not a
2223 // pointer to or object of the constructor or destructor’s own class or one
2224 // of its bases, the dynamic_cast results in undefined behavior.
2225 EmitTypeCheck(TCK_DynamicOperation, DCE->getExprLoc(), ThisAddr.getPointer(),
2226 SrcRecordTy);
2227
2228 if (DCE->isAlwaysNull())
2229 if (llvm::Value *T = EmitDynamicCastToNull(*this, DestTy))
2230 return T;
2231
David Majnemer1162d252014-06-22 19:05:33 +00002232 assert(SrcRecordTy->isRecordType() && "source type must be a record type!");
2233
Fangrui Song6907ce22018-07-30 19:24:48 +00002234 // C++ [expr.dynamic.cast]p4:
Anders Carlsson882d7902011-04-11 00:46:40 +00002235 // If the value of v is a null pointer value in the pointer case, the result
2236 // is the null pointer value of type T.
David Majnemer1162d252014-06-22 19:05:33 +00002237 bool ShouldNullCheckSrcValue =
2238 CGM.getCXXABI().shouldDynamicCastCallBeNullChecked(SrcTy->isPointerType(),
2239 SrcRecordTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002240
2241 llvm::BasicBlock *CastNull = nullptr;
2242 llvm::BasicBlock *CastNotNull = nullptr;
Anders Carlsson882d7902011-04-11 00:46:40 +00002243 llvm::BasicBlock *CastEnd = createBasicBlock("dynamic_cast.end");
Fangrui Song6907ce22018-07-30 19:24:48 +00002244
Anders Carlsson882d7902011-04-11 00:46:40 +00002245 if (ShouldNullCheckSrcValue) {
2246 CastNull = createBasicBlock("dynamic_cast.null");
2247 CastNotNull = createBasicBlock("dynamic_cast.notnull");
2248
John McCall7f416cc2015-09-08 08:05:57 +00002249 llvm::Value *IsNull = Builder.CreateIsNull(ThisAddr.getPointer());
Anders Carlsson882d7902011-04-11 00:46:40 +00002250 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
2251 EmitBlock(CastNotNull);
Mike Stump65511702009-11-16 06:50:58 +00002252 }
2253
John McCall7f416cc2015-09-08 08:05:57 +00002254 llvm::Value *Value;
David Majnemer1162d252014-06-22 19:05:33 +00002255 if (isDynamicCastToVoid) {
John McCall7f416cc2015-09-08 08:05:57 +00002256 Value = CGM.getCXXABI().EmitDynamicCastToVoid(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002257 DestTy);
2258 } else {
2259 assert(DestRecordTy->isRecordType() &&
2260 "destination type must be a record type!");
John McCall7f416cc2015-09-08 08:05:57 +00002261 Value = CGM.getCXXABI().EmitDynamicCastCall(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002262 DestTy, DestRecordTy, CastEnd);
David Majnemer67528ea2015-11-23 03:01:14 +00002263 CastNotNull = Builder.GetInsertBlock();
David Majnemer1162d252014-06-22 19:05:33 +00002264 }
Anders Carlsson882d7902011-04-11 00:46:40 +00002265
2266 if (ShouldNullCheckSrcValue) {
2267 EmitBranch(CastEnd);
2268
2269 EmitBlock(CastNull);
2270 EmitBranch(CastEnd);
2271 }
2272
2273 EmitBlock(CastEnd);
2274
2275 if (ShouldNullCheckSrcValue) {
2276 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
2277 PHI->addIncoming(Value, CastNotNull);
2278 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
2279
2280 Value = PHI;
2281 }
2282
2283 return Value;
Mike Stump65511702009-11-16 06:50:58 +00002284}