blob: 269b80b434032ce847386913e9b1d95f7d171bab [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,
115 ReturnValueSlot(), Args);
John McCallb92ab1a2016-10-26 23:46:34 +0000116}
117
118RValue CodeGenFunction::EmitCXXPseudoDestructorExpr(
119 const CXXPseudoDestructorExpr *E) {
120 QualType DestroyedType = E->getDestroyedType();
121 if (DestroyedType.hasStrongOrWeakObjCLifetime()) {
122 // Automatic Reference Counting:
123 // If the pseudo-expression names a retainable object with weak or
124 // strong lifetime, the object shall be released.
125 Expr *BaseExpr = E->getBase();
126 Address BaseValue = Address::invalid();
127 Qualifiers BaseQuals;
128
129 // If this is s.x, emit s as an lvalue. If it is s->x, emit s as a scalar.
130 if (E->isArrow()) {
131 BaseValue = EmitPointerWithAlignment(BaseExpr);
132 const PointerType *PTy = BaseExpr->getType()->getAs<PointerType>();
133 BaseQuals = PTy->getPointeeType().getQualifiers();
134 } else {
135 LValue BaseLV = EmitLValue(BaseExpr);
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800136 BaseValue = BaseLV.getAddress(*this);
John McCallb92ab1a2016-10-26 23:46:34 +0000137 QualType BaseTy = BaseExpr->getType();
138 BaseQuals = BaseTy.getQualifiers();
139 }
140
141 switch (DestroyedType.getObjCLifetime()) {
142 case Qualifiers::OCL_None:
143 case Qualifiers::OCL_ExplicitNone:
144 case Qualifiers::OCL_Autoreleasing:
145 break;
146
147 case Qualifiers::OCL_Strong:
148 EmitARCRelease(Builder.CreateLoad(BaseValue,
149 DestroyedType.isVolatileQualified()),
150 ARCPreciseLifetime);
151 break;
152
153 case Qualifiers::OCL_Weak:
154 EmitARCDestroyWeak(BaseValue);
155 break;
156 }
157 } else {
158 // C++ [expr.pseudo]p1:
159 // The result shall only be used as the operand for the function call
160 // operator (), and the result of such a call has type void. The only
161 // effect is the evaluation of the postfix-expression before the dot or
162 // arrow.
163 EmitIgnoredExpr(E->getBase());
164 }
165
166 return RValue::get(nullptr);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000167}
168
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000169static CXXRecordDecl *getCXXRecord(const Expr *E) {
170 QualType T = E->getType();
171 if (const PointerType *PTy = T->getAs<PointerType>())
172 T = PTy->getPointeeType();
173 const RecordType *Ty = T->castAs<RecordType>();
174 return cast<CXXRecordDecl>(Ty->getDecl());
175}
176
Francois Pichet64225792011-01-18 05:04:39 +0000177// Note: This function also emit constructor calls to support a MSVC
178// extensions allowing explicit constructor function call.
Anders Carlsson27da15b2010-01-01 20:29:01 +0000179RValue CodeGenFunction::EmitCXXMemberCallExpr(const CXXMemberCallExpr *CE,
180 ReturnValueSlot ReturnValue) {
John McCall2d2e8702011-04-11 07:02:50 +0000181 const Expr *callee = CE->getCallee()->IgnoreParens();
182
183 if (isa<BinaryOperator>(callee))
Anders Carlsson27da15b2010-01-01 20:29:01 +0000184 return EmitCXXMemberPointerCallExpr(CE, ReturnValue);
John McCall2d2e8702011-04-11 07:02:50 +0000185
186 const MemberExpr *ME = cast<MemberExpr>(callee);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000187 const CXXMethodDecl *MD = cast<CXXMethodDecl>(ME->getMemberDecl());
188
189 if (MD->isStatic()) {
190 // The method is static, emit it as we would a regular call.
Erich Keanede6480a32018-11-13 15:48:08 +0000191 CGCallee callee =
192 CGCallee::forDirect(CGM.GetAddrOfFunction(MD), GlobalDecl(MD));
John McCallb92ab1a2016-10-26 23:46:34 +0000193 return EmitCall(getContext().getPointerType(MD->getType()), callee, CE,
Alexey Samsonov70b9c012014-08-21 20:26:47 +0000194 ReturnValue);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000195 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000196
Nico Weberaad4af62014-12-03 01:21:41 +0000197 bool HasQualifier = ME->hasQualifier();
198 NestedNameSpecifier *Qualifier = HasQualifier ? ME->getQualifier() : nullptr;
199 bool IsArrow = ME->isArrow();
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000200 const Expr *Base = ME->getBase();
Nico Weberaad4af62014-12-03 01:21:41 +0000201
202 return EmitCXXMemberOrOperatorMemberCallExpr(
203 CE, MD, ReturnValue, HasQualifier, Qualifier, IsArrow, Base);
204}
205
206RValue CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(
207 const CallExpr *CE, const CXXMethodDecl *MD, ReturnValueSlot ReturnValue,
208 bool HasQualifier, NestedNameSpecifier *Qualifier, bool IsArrow,
209 const Expr *Base) {
210 assert(isa<CXXMemberCallExpr>(CE) || isa<CXXOperatorCallExpr>(CE));
211
212 // Compute the object pointer.
213 bool CanUseVirtualCall = MD->isVirtual() && !HasQualifier;
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000214
Craig Topper8a13c412014-05-21 05:09:00 +0000215 const CXXMethodDecl *DevirtualizedMethod = nullptr;
Akira Hatanaka22461672017-07-13 06:08:27 +0000216 if (CanUseVirtualCall &&
217 MD->getDevirtualizedMethod(Base, getLangOpts().AppleKext)) {
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000218 const CXXRecordDecl *BestDynamicDecl = Base->getBestDynamicClassType();
219 DevirtualizedMethod = MD->getCorrespondingMethodInClass(BestDynamicDecl);
220 assert(DevirtualizedMethod);
221 const CXXRecordDecl *DevirtualizedClass = DevirtualizedMethod->getParent();
222 const Expr *Inner = Base->ignoreParenBaseCasts();
Alexey Bataev5bd68792014-09-29 10:32:21 +0000223 if (DevirtualizedMethod->getReturnType().getCanonicalType() !=
224 MD->getReturnType().getCanonicalType())
225 // If the return types are not the same, this might be a case where more
226 // code needs to run to compensate for it. For example, the derived
227 // method might return a type that inherits form from the return
228 // type of MD and has a prefix.
229 // For now we just avoid devirtualizing these covariant cases.
230 DevirtualizedMethod = nullptr;
231 else if (getCXXRecord(Inner) == DevirtualizedClass)
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000232 // If the class of the Inner expression is where the dynamic method
233 // is defined, build the this pointer from it.
234 Base = Inner;
235 else if (getCXXRecord(Base) != DevirtualizedClass) {
236 // If the method is defined in a class that is not the best dynamic
237 // one or the one of the full expression, we would have to build
238 // a derived-to-base cast to compute the correct this pointer, but
239 // we don't have support for that yet, so do a virtual call.
Craig Topper8a13c412014-05-21 05:09:00 +0000240 DevirtualizedMethod = nullptr;
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000241 }
242 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000243
Richard Smith762672a2016-09-28 19:09:10 +0000244 // C++17 demands that we evaluate the RHS of a (possibly-compound) assignment
245 // operator before the LHS.
246 CallArgList RtlArgStorage;
247 CallArgList *RtlArgs = nullptr;
248 if (auto *OCE = dyn_cast<CXXOperatorCallExpr>(CE)) {
249 if (OCE->isAssignmentOp()) {
250 RtlArgs = &RtlArgStorage;
251 EmitCallArgs(*RtlArgs, MD->getType()->castAs<FunctionProtoType>(),
252 drop_begin(CE->arguments(), 1), CE->getDirectCallee(),
Richard Smitha560ccf2016-09-29 21:30:12 +0000253 /*ParamsToSkip*/0, EvaluationOrder::ForceRightToLeft);
Richard Smith762672a2016-09-28 19:09:10 +0000254 }
255 }
256
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000257 LValue This;
258 if (IsArrow) {
259 LValueBaseInfo BaseInfo;
260 TBAAAccessInfo TBAAInfo;
261 Address ThisValue = EmitPointerWithAlignment(Base, &BaseInfo, &TBAAInfo);
262 This = MakeAddrLValue(ThisValue, Base->getType(), BaseInfo, TBAAInfo);
263 } else {
264 This = EmitLValue(Base);
265 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000266
James Y Knightab4f7f12019-02-06 00:06:03 +0000267 if (const CXXConstructorDecl *Ctor = dyn_cast<CXXConstructorDecl>(MD)) {
268 // This is the MSVC p->Ctor::Ctor(...) extension. We assume that's
269 // constructing a new complete object of type Ctor.
270 assert(!RtlArgs);
271 assert(ReturnValue.isNull() && "Constructor shouldn't have return value");
272 CallArgList Args;
273 commonEmitCXXMemberOrOperatorCall(
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800274 *this, Ctor, This.getPointer(*this), /*ImplicitParam=*/nullptr,
James Y Knightab4f7f12019-02-06 00:06:03 +0000275 /*ImplicitParamTy=*/QualType(), CE, Args, nullptr);
276
277 EmitCXXConstructorCall(Ctor, Ctor_Complete, /*ForVirtualBase=*/false,
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800278 /*Delegating=*/false, This.getAddress(*this), Args,
James Y Knightab4f7f12019-02-06 00:06:03 +0000279 AggValueSlot::DoesNotOverlap, CE->getExprLoc(),
280 /*NewPointerIsChecked=*/false);
281 return RValue::get(nullptr);
282 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000283
Richard Smith419bd092015-04-29 19:26:57 +0000284 if (MD->isTrivial() || (MD->isDefaulted() && MD->getParent()->isUnion())) {
Craig Topper8a13c412014-05-21 05:09:00 +0000285 if (isa<CXXDestructorDecl>(MD)) return RValue::get(nullptr);
Nico Weberaad4af62014-12-03 01:21:41 +0000286 if (!MD->getParent()->mayInsertExtraPadding()) {
287 if (MD->isCopyAssignmentOperator() || MD->isMoveAssignmentOperator()) {
288 // We don't like to generate the trivial copy/move assignment operator
289 // when it isn't necessary; just produce the proper effect here.
Richard Smith762672a2016-09-28 19:09:10 +0000290 LValue RHS = isa<CXXOperatorCallExpr>(CE)
291 ? MakeNaturalAlignAddrLValue(
Yaxun Liu5b330e82018-03-15 15:25:19 +0000292 (*RtlArgs)[0].getRValue(*this).getScalarVal(),
Richard Smith762672a2016-09-28 19:09:10 +0000293 (*(CE->arg_begin() + 1))->getType())
294 : EmitLValue(*CE->arg_begin());
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000295 EmitAggregateAssign(This, RHS, CE->getType());
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800296 return RValue::get(This.getPointer(*this));
Nico Weberaad4af62014-12-03 01:21:41 +0000297 }
Nico Weberaad4af62014-12-03 01:21:41 +0000298 llvm_unreachable("unknown trivial member function");
Francois Pichet64225792011-01-18 05:04:39 +0000299 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000300 }
301
John McCall0d635f52010-09-03 01:26:39 +0000302 // Compute the function type we're calling.
Nico Weber3abfe952014-12-02 20:41:18 +0000303 const CXXMethodDecl *CalleeDecl =
304 DevirtualizedMethod ? DevirtualizedMethod : MD;
Craig Topper8a13c412014-05-21 05:09:00 +0000305 const CGFunctionInfo *FInfo = nullptr;
Nico Weber3abfe952014-12-02 20:41:18 +0000306 if (const auto *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000307 FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000308 GlobalDecl(Dtor, Dtor_Complete));
Francois Pichet64225792011-01-18 05:04:39 +0000309 else
Eli Friedmanade60972012-10-25 00:12:49 +0000310 FInfo = &CGM.getTypes().arrangeCXXMethodDeclaration(CalleeDecl);
John McCall0d635f52010-09-03 01:26:39 +0000311
Reid Klecknere7de47e2013-07-22 13:51:44 +0000312 llvm::FunctionType *Ty = CGM.getTypes().GetFunctionType(*FInfo);
John McCall0d635f52010-09-03 01:26:39 +0000313
Ivan Krasind98f5d72016-11-17 00:39:48 +0000314 // C++11 [class.mfct.non-static]p2:
315 // If a non-static member function of a class X is called for an object that
316 // is not of type X, or of a type derived from X, the behavior is undefined.
317 SourceLocation CallLoc;
318 ASTContext &C = getContext();
319 if (CE)
320 CallLoc = CE->getExprLoc();
321
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000322 SanitizerSet SkippedChecks;
Vedant Kumarffd7c882017-04-14 22:03:34 +0000323 if (const auto *CMCE = dyn_cast<CXXMemberCallExpr>(CE)) {
324 auto *IOA = CMCE->getImplicitObjectArgument();
325 bool IsImplicitObjectCXXThis = IsWrappedCXXThis(IOA);
326 if (IsImplicitObjectCXXThis)
327 SkippedChecks.set(SanitizerKind::Alignment, true);
328 if (IsImplicitObjectCXXThis || isa<DeclRefExpr>(IOA))
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000329 SkippedChecks.set(SanitizerKind::Null, true);
Vedant Kumarffd7c882017-04-14 22:03:34 +0000330 }
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800331 EmitTypeCheck(CodeGenFunction::TCK_MemberCall, CallLoc,
332 This.getPointer(*this),
James Y Knightab4f7f12019-02-06 00:06:03 +0000333 C.getRecordType(CalleeDecl->getParent()),
334 /*Alignment=*/CharUnits::Zero(), SkippedChecks);
Ivan Krasind98f5d72016-11-17 00:39:48 +0000335
Anders Carlsson27da15b2010-01-01 20:29:01 +0000336 // C++ [class.virtual]p12:
337 // Explicit qualification with the scope operator (5.1) suppresses the
338 // virtual call mechanism.
339 //
340 // We also don't emit a virtual call if the base expression has a record type
341 // because then we know what the type is.
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000342 bool UseVirtualCall = CanUseVirtualCall && !DevirtualizedMethod;
Fangrui Song6907ce22018-07-30 19:24:48 +0000343
James Y Knightb92d2902019-02-05 16:05:50 +0000344 if (const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl)) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000345 assert(CE->arg_begin() == CE->arg_end() &&
346 "Destructor shouldn't have explicit parameters");
347 assert(ReturnValue.isNull() && "Destructor shouldn't have return value");
John McCall0d635f52010-09-03 01:26:39 +0000348 if (UseVirtualCall) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800349 CGM.getCXXABI().EmitVirtualDestructorCall(*this, Dtor, Dtor_Complete,
350 This.getAddress(*this),
351 cast<CXXMemberCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000352 } else {
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000353 GlobalDecl GD(Dtor, Dtor_Complete);
John McCallb92ab1a2016-10-26 23:46:34 +0000354 CGCallee Callee;
James Y Knightb92d2902019-02-05 16:05:50 +0000355 if (getLangOpts().AppleKext && Dtor->isVirtual() && HasQualifier)
356 Callee = BuildAppleKextVirtualCall(Dtor, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000357 else if (!DevirtualizedMethod)
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000358 Callee =
359 CGCallee::forDirect(CGM.getAddrOfCXXStructor(GD, FInfo, Ty), GD);
Rafael Espindola49e860b2012-06-26 17:45:31 +0000360 else {
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000361 Callee = CGCallee::forDirect(CGM.GetAddrOfFunction(GD, Ty), GD);
Rafael Espindola49e860b2012-06-26 17:45:31 +0000362 }
James Y Knightb92d2902019-02-05 16:05:50 +0000363
Marco Antognini88559632019-07-22 09:39:13 +0000364 QualType ThisTy =
365 IsArrow ? Base->getType()->getPointeeType() : Base->getType();
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800366 EmitCXXDestructorCall(GD, Callee, This.getPointer(*this), ThisTy,
James Y Knightb92d2902019-02-05 16:05:50 +0000367 /*ImplicitParam=*/nullptr,
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000368 /*ImplicitParamTy=*/QualType(), nullptr);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000369 }
Craig Topper8a13c412014-05-21 05:09:00 +0000370 return RValue::get(nullptr);
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000371 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000372
James Y Knightb92d2902019-02-05 16:05:50 +0000373 // FIXME: Uses of 'MD' past this point need to be audited. We may need to use
374 // 'CalleeDecl' instead.
375
John McCallb92ab1a2016-10-26 23:46:34 +0000376 CGCallee Callee;
James Y Knightab4f7f12019-02-06 00:06:03 +0000377 if (UseVirtualCall) {
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800378 Callee = CGCallee::forVirtual(CE, MD, This.getAddress(*this), Ty);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000379 } else {
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000380 if (SanOpts.has(SanitizerKind::CFINVCall) &&
381 MD->getParent()->isDynamicClass()) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000382 llvm::Value *VTable;
383 const CXXRecordDecl *RD;
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800384 std::tie(VTable, RD) = CGM.getCXXABI().LoadVTablePtr(
385 *this, This.getAddress(*this), CalleeDecl->getParent());
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000386 EmitVTablePtrCheckForCall(RD, VTable, CFITCK_NVCall, CE->getBeginLoc());
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000387 }
388
Nico Weberaad4af62014-12-03 01:21:41 +0000389 if (getLangOpts().AppleKext && MD->isVirtual() && HasQualifier)
390 Callee = BuildAppleKextVirtualCall(MD, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000391 else if (!DevirtualizedMethod)
Erich Keanede6480a32018-11-13 15:48:08 +0000392 Callee =
393 CGCallee::forDirect(CGM.GetAddrOfFunction(MD, Ty), GlobalDecl(MD));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000394 else {
Erich Keanede6480a32018-11-13 15:48:08 +0000395 Callee =
396 CGCallee::forDirect(CGM.GetAddrOfFunction(DevirtualizedMethod, Ty),
397 GlobalDecl(DevirtualizedMethod));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000398 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000399 }
400
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000401 if (MD->isVirtual()) {
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000402 Address NewThisAddr =
403 CGM.getCXXABI().adjustThisArgumentForVirtualFunctionCall(
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800404 *this, CalleeDecl, This.getAddress(*this), UseVirtualCall);
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000405 This.setAddress(NewThisAddr);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000406 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000407
Vedant Kumar018f2662016-10-19 20:21:16 +0000408 return EmitCXXMemberOrOperatorCall(
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800409 CalleeDecl, Callee, ReturnValue, This.getPointer(*this),
Vedant Kumar018f2662016-10-19 20:21:16 +0000410 /*ImplicitParam=*/nullptr, QualType(), CE, RtlArgs);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000411}
412
413RValue
414CodeGenFunction::EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
415 ReturnValueSlot ReturnValue) {
416 const BinaryOperator *BO =
417 cast<BinaryOperator>(E->getCallee()->IgnoreParens());
418 const Expr *BaseExpr = BO->getLHS();
419 const Expr *MemFnExpr = BO->getRHS();
Fangrui Song6907ce22018-07-30 19:24:48 +0000420
Simon Pilgrim1cd399c2019-10-03 11:22:48 +0000421 const auto *MPT = MemFnExpr->getType()->castAs<MemberPointerType>();
422 const auto *FPT = MPT->getPointeeType()->castAs<FunctionProtoType>();
423 const auto *RD =
424 cast<CXXRecordDecl>(MPT->getClass()->castAs<RecordType>()->getDecl());
Anders Carlsson27da15b2010-01-01 20:29:01 +0000425
Anders Carlsson27da15b2010-01-01 20:29:01 +0000426 // Emit the 'this' pointer.
John McCall7f416cc2015-09-08 08:05:57 +0000427 Address This = Address::invalid();
John McCalle3027922010-08-25 11:45:40 +0000428 if (BO->getOpcode() == BO_PtrMemI)
John McCall7f416cc2015-09-08 08:05:57 +0000429 This = EmitPointerWithAlignment(BaseExpr);
Fangrui Song6907ce22018-07-30 19:24:48 +0000430 else
Akira Hatanakaf139ae32019-12-03 15:17:01 -0800431 This = EmitLValue(BaseExpr).getAddress(*this);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000432
John McCall7f416cc2015-09-08 08:05:57 +0000433 EmitTypeCheck(TCK_MemberCall, E->getExprLoc(), This.getPointer(),
Richard Smithe30752c2012-10-09 19:52:38 +0000434 QualType(MPT->getClass(), 0));
Richard Smith69d0d262012-08-24 00:54:33 +0000435
Richard Smithbde62d72016-09-26 23:56:57 +0000436 // Get the member function pointer.
437 llvm::Value *MemFnPtr = EmitScalarExpr(MemFnExpr);
438
John McCall475999d2010-08-22 00:05:51 +0000439 // Ask the ABI to load the callee. Note that This is modified.
John McCall7f416cc2015-09-08 08:05:57 +0000440 llvm::Value *ThisPtrForCall = nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +0000441 CGCallee Callee =
John McCall7f416cc2015-09-08 08:05:57 +0000442 CGM.getCXXABI().EmitLoadOfMemberFunctionPointer(*this, BO, This,
443 ThisPtrForCall, MemFnPtr, MPT);
Fangrui Song6907ce22018-07-30 19:24:48 +0000444
Anders Carlsson27da15b2010-01-01 20:29:01 +0000445 CallArgList Args;
446
Fangrui Song6907ce22018-07-30 19:24:48 +0000447 QualType ThisType =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000448 getContext().getPointerType(getContext().getTagDeclType(RD));
449
450 // Push the this ptr.
John McCall7f416cc2015-09-08 08:05:57 +0000451 Args.add(RValue::get(ThisPtrForCall), ThisType);
John McCall8dda7b22012-07-07 06:41:13 +0000452
James Y Knight916db652019-02-02 01:48:23 +0000453 RequiredArgs required = RequiredArgs::forPrototypePlus(FPT, 1);
George Burgess IV419996c2016-06-16 23:06:04 +0000454
Anders Carlsson27da15b2010-01-01 20:29:01 +0000455 // And the rest of the call args
George Burgess IV419996c2016-06-16 23:06:04 +0000456 EmitCallArgs(Args, FPT, E->arguments());
George Burgess IVd0a9e802017-02-23 22:07:35 +0000457 return EmitCall(CGM.getTypes().arrangeCXXMethodCall(Args, FPT, required,
458 /*PrefixSize=*/0),
Vedant Kumar09b5bfd2017-12-21 00:10:25 +0000459 Callee, ReturnValue, Args, nullptr, E->getExprLoc());
Anders Carlsson27da15b2010-01-01 20:29:01 +0000460}
461
462RValue
463CodeGenFunction::EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
464 const CXXMethodDecl *MD,
465 ReturnValueSlot ReturnValue) {
466 assert(MD->isInstance() &&
467 "Trying to emit a member call expr on a static method!");
Nico Weberaad4af62014-12-03 01:21:41 +0000468 return EmitCXXMemberOrOperatorMemberCallExpr(
469 E, MD, ReturnValue, /*HasQualifier=*/false, /*Qualifier=*/nullptr,
470 /*IsArrow=*/false, E->getArg(0));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000471}
472
Peter Collingbournefe883422011-10-06 18:29:37 +0000473RValue CodeGenFunction::EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
474 ReturnValueSlot ReturnValue) {
475 return CGM.getCUDARuntime().EmitCUDAKernelCallExpr(*this, E, ReturnValue);
476}
477
Eli Friedmanfde961d2011-10-14 02:27:24 +0000478static void EmitNullBaseClassInitialization(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000479 Address DestPtr,
Eli Friedmanfde961d2011-10-14 02:27:24 +0000480 const CXXRecordDecl *Base) {
481 if (Base->isEmpty())
482 return;
483
John McCall7f416cc2015-09-08 08:05:57 +0000484 DestPtr = CGF.Builder.CreateElementBitCast(DestPtr, CGF.Int8Ty);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000485
486 const ASTRecordLayout &Layout = CGF.getContext().getASTRecordLayout(Base);
David Majnemer8671c6e2015-11-02 09:01:44 +0000487 CharUnits NVSize = Layout.getNonVirtualSize();
488
489 // We cannot simply zero-initialize the entire base sub-object if vbptrs are
490 // present, they are initialized by the most derived class before calling the
491 // constructor.
492 SmallVector<std::pair<CharUnits, CharUnits>, 1> Stores;
493 Stores.emplace_back(CharUnits::Zero(), NVSize);
494
495 // Each store is split by the existence of a vbptr.
496 CharUnits VBPtrWidth = CGF.getPointerSize();
497 std::vector<CharUnits> VBPtrOffsets =
498 CGF.CGM.getCXXABI().getVBPtrOffsets(Base);
499 for (CharUnits VBPtrOffset : VBPtrOffsets) {
David Majnemer7f980d82016-05-12 03:51:52 +0000500 // Stop before we hit any virtual base pointers located in virtual bases.
501 if (VBPtrOffset >= NVSize)
502 break;
David Majnemer8671c6e2015-11-02 09:01:44 +0000503 std::pair<CharUnits, CharUnits> LastStore = Stores.pop_back_val();
504 CharUnits LastStoreOffset = LastStore.first;
505 CharUnits LastStoreSize = LastStore.second;
506
507 CharUnits SplitBeforeOffset = LastStoreOffset;
508 CharUnits SplitBeforeSize = VBPtrOffset - SplitBeforeOffset;
509 assert(!SplitBeforeSize.isNegative() && "negative store size!");
510 if (!SplitBeforeSize.isZero())
511 Stores.emplace_back(SplitBeforeOffset, SplitBeforeSize);
512
513 CharUnits SplitAfterOffset = VBPtrOffset + VBPtrWidth;
514 CharUnits SplitAfterSize = LastStoreSize - SplitAfterOffset;
515 assert(!SplitAfterSize.isNegative() && "negative store size!");
516 if (!SplitAfterSize.isZero())
517 Stores.emplace_back(SplitAfterOffset, SplitAfterSize);
518 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000519
520 // If the type contains a pointer to data member we can't memset it to zero.
521 // Instead, create a null constant and copy it to the destination.
522 // TODO: there are other patterns besides zero that we can usefully memset,
523 // like -1, which happens to be the pattern used by member-pointers.
524 // TODO: isZeroInitializable can be over-conservative in the case where a
525 // virtual base contains a member pointer.
David Majnemer8671c6e2015-11-02 09:01:44 +0000526 llvm::Constant *NullConstantForBase = CGF.CGM.EmitNullConstantForBase(Base);
527 if (!NullConstantForBase->isNullValue()) {
528 llvm::GlobalVariable *NullVariable = new llvm::GlobalVariable(
529 CGF.CGM.getModule(), NullConstantForBase->getType(),
530 /*isConstant=*/true, llvm::GlobalVariable::PrivateLinkage,
531 NullConstantForBase, Twine());
John McCall7f416cc2015-09-08 08:05:57 +0000532
533 CharUnits Align = std::max(Layout.getNonVirtualAlignment(),
534 DestPtr.getAlignment());
Guillaume Chateletc79099e2019-10-03 13:00:29 +0000535 NullVariable->setAlignment(Align.getAsAlign());
John McCall7f416cc2015-09-08 08:05:57 +0000536
537 Address SrcPtr = Address(CGF.EmitCastToVoidPtr(NullVariable), Align);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000538
539 // Get and call the appropriate llvm.memcpy overload.
David Majnemer8671c6e2015-11-02 09:01:44 +0000540 for (std::pair<CharUnits, CharUnits> Store : Stores) {
541 CharUnits StoreOffset = Store.first;
542 CharUnits StoreSize = Store.second;
543 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
544 CGF.Builder.CreateMemCpy(
545 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
546 CGF.Builder.CreateConstInBoundsByteGEP(SrcPtr, StoreOffset),
547 StoreSizeVal);
548 }
549
Eli Friedmanfde961d2011-10-14 02:27:24 +0000550 // Otherwise, just memset the whole thing to zero. This is legal
551 // because in LLVM, all default initializers (other than the ones we just
552 // handled above) are guaranteed to have a bit pattern of all zeros.
David Majnemer8671c6e2015-11-02 09:01:44 +0000553 } else {
554 for (std::pair<CharUnits, CharUnits> Store : Stores) {
555 CharUnits StoreOffset = Store.first;
556 CharUnits StoreSize = Store.second;
557 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
558 CGF.Builder.CreateMemSet(
559 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
560 CGF.Builder.getInt8(0), StoreSizeVal);
561 }
562 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000563}
564
Anders Carlsson27da15b2010-01-01 20:29:01 +0000565void
John McCall7a626f62010-09-15 10:14:12 +0000566CodeGenFunction::EmitCXXConstructExpr(const CXXConstructExpr *E,
567 AggValueSlot Dest) {
568 assert(!Dest.isIgnored() && "Must have a destination!");
Anders Carlsson27da15b2010-01-01 20:29:01 +0000569 const CXXConstructorDecl *CD = E->getConstructor();
Fangrui Song6907ce22018-07-30 19:24:48 +0000570
Douglas Gregor630c76e2010-08-22 16:15:35 +0000571 // If we require zero initialization before (or instead of) calling the
572 // constructor, as can be the case with a non-user-provided default
Argyrios Kyrtzidis03535262011-04-28 22:57:55 +0000573 // constructor, emit the zero initialization now, unless destination is
574 // already zeroed.
Eli Friedmanfde961d2011-10-14 02:27:24 +0000575 if (E->requiresZeroInitialization() && !Dest.isZeroed()) {
576 switch (E->getConstructionKind()) {
577 case CXXConstructExpr::CK_Delegating:
Eli Friedmanfde961d2011-10-14 02:27:24 +0000578 case CXXConstructExpr::CK_Complete:
John McCall7f416cc2015-09-08 08:05:57 +0000579 EmitNullInitialization(Dest.getAddress(), E->getType());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000580 break;
581 case CXXConstructExpr::CK_VirtualBase:
582 case CXXConstructExpr::CK_NonVirtualBase:
John McCall7f416cc2015-09-08 08:05:57 +0000583 EmitNullBaseClassInitialization(*this, Dest.getAddress(),
584 CD->getParent());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000585 break;
586 }
587 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000588
Douglas Gregor630c76e2010-08-22 16:15:35 +0000589 // If this is a call to a trivial default constructor, do nothing.
590 if (CD->isTrivial() && CD->isDefaultConstructor())
591 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000592
John McCall8ea46b62010-09-18 00:58:34 +0000593 // Elide the constructor if we're constructing from a temporary.
594 // The temporary check is required because Sema sets this on NRVO
595 // returns.
Richard Smith9c6890a2012-11-01 22:30:59 +0000596 if (getLangOpts().ElideConstructors && E->isElidable()) {
John McCall8ea46b62010-09-18 00:58:34 +0000597 assert(getContext().hasSameUnqualifiedType(E->getType(),
598 E->getArg(0)->getType()));
John McCall7a626f62010-09-15 10:14:12 +0000599 if (E->getArg(0)->isTemporaryObject(getContext(), CD->getParent())) {
600 EmitAggExpr(E->getArg(0), Dest);
Douglas Gregor222cf0e2010-05-15 00:13:29 +0000601 return;
602 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000603 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000604
Alexey Bataeve7545b32016-04-29 09:39:50 +0000605 if (const ArrayType *arrayType
606 = getContext().getAsArrayType(E->getType())) {
Serge Pavlov37605182018-07-28 15:33:03 +0000607 EmitCXXAggrConstructorCall(CD, arrayType, Dest.getAddress(), E,
608 Dest.isSanitizerChecked());
John McCallf677a8e2011-07-13 06:10:41 +0000609 } else {
Cameron Esfahanibceca202011-05-06 21:28:42 +0000610 CXXCtorType Type = Ctor_Complete;
Alexis Hunt271c3682011-05-03 20:19:28 +0000611 bool ForVirtualBase = false;
Douglas Gregor61535002013-01-31 05:50:40 +0000612 bool Delegating = false;
Fangrui Song6907ce22018-07-30 19:24:48 +0000613
Alexis Hunt271c3682011-05-03 20:19:28 +0000614 switch (E->getConstructionKind()) {
615 case CXXConstructExpr::CK_Delegating:
Alexis Hunt61bc1732011-05-01 07:04:31 +0000616 // We should be emitting a constructor; GlobalDecl will assert this
617 Type = CurGD.getCtorType();
Douglas Gregor61535002013-01-31 05:50:40 +0000618 Delegating = true;
Alexis Hunt271c3682011-05-03 20:19:28 +0000619 break;
Alexis Hunt61bc1732011-05-01 07:04:31 +0000620
Alexis Hunt271c3682011-05-03 20:19:28 +0000621 case CXXConstructExpr::CK_Complete:
622 Type = Ctor_Complete;
623 break;
624
625 case CXXConstructExpr::CK_VirtualBase:
626 ForVirtualBase = true;
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +0000627 LLVM_FALLTHROUGH;
Alexis Hunt271c3682011-05-03 20:19:28 +0000628
629 case CXXConstructExpr::CK_NonVirtualBase:
630 Type = Ctor_Base;
Anastasia Stulova094c7262019-04-04 10:48:36 +0000631 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000632
Anastasia Stulova094c7262019-04-04 10:48:36 +0000633 // Call the constructor.
634 EmitCXXConstructorCall(CD, Type, ForVirtualBase, Delegating, Dest, E);
Anders Carlssone11f9ce2010-05-02 23:20:53 +0000635 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000636}
637
John McCall7f416cc2015-09-08 08:05:57 +0000638void CodeGenFunction::EmitSynthesizedCXXCopyCtor(Address Dest, Address Src,
639 const Expr *Exp) {
John McCall5d413782010-12-06 08:20:24 +0000640 if (const ExprWithCleanups *E = dyn_cast<ExprWithCleanups>(Exp))
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000641 Exp = E->getSubExpr();
Fangrui Song6907ce22018-07-30 19:24:48 +0000642 assert(isa<CXXConstructExpr>(Exp) &&
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000643 "EmitSynthesizedCXXCopyCtor - unknown copy ctor expr");
644 const CXXConstructExpr* E = cast<CXXConstructExpr>(Exp);
645 const CXXConstructorDecl *CD = E->getConstructor();
646 RunCleanupsScope Scope(*this);
Fangrui Song6907ce22018-07-30 19:24:48 +0000647
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000648 // If we require zero initialization before (or instead of) calling the
649 // constructor, as can be the case with a non-user-provided default
650 // constructor, emit the zero initialization now.
651 // FIXME. Do I still need this for a copy ctor synthesis?
652 if (E->requiresZeroInitialization())
653 EmitNullInitialization(Dest, E->getType());
Fangrui Song6907ce22018-07-30 19:24:48 +0000654
Chandler Carruth99da11c2010-11-15 13:54:43 +0000655 assert(!getContext().getAsConstantArrayType(E->getType())
656 && "EmitSynthesizedCXXCopyCtor - Copied-in Array");
Alexey Samsonov525bf652014-08-25 21:58:56 +0000657 EmitSynthesizedCXXCopyCtorCall(CD, Dest, Src, E);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000658}
659
John McCall8ed55a52010-09-02 09:58:18 +0000660static CharUnits CalculateCookiePadding(CodeGenFunction &CGF,
661 const CXXNewExpr *E) {
Anders Carlsson21122cf2009-12-13 20:04:38 +0000662 if (!E->isArray())
Ken Dyck3eb55cf2010-01-26 19:44:24 +0000663 return CharUnits::Zero();
Anders Carlsson21122cf2009-12-13 20:04:38 +0000664
John McCall7ec4b432011-05-16 01:05:12 +0000665 // No cookie is required if the operator new[] being used is the
666 // reserved placement operator new[].
667 if (E->getOperatorNew()->isReservedGlobalPlacementOperator())
John McCallaa4149a2010-08-23 01:17:59 +0000668 return CharUnits::Zero();
669
John McCall284c48f2011-01-27 09:37:56 +0000670 return CGF.CGM.getCXXABI().GetArrayCookieSize(E);
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000671}
672
John McCall036f2f62011-05-15 07:14:44 +0000673static llvm::Value *EmitCXXNewAllocSize(CodeGenFunction &CGF,
674 const CXXNewExpr *e,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000675 unsigned minElements,
John McCall036f2f62011-05-15 07:14:44 +0000676 llvm::Value *&numElements,
677 llvm::Value *&sizeWithoutCookie) {
678 QualType type = e->getAllocatedType();
John McCall8ed55a52010-09-02 09:58:18 +0000679
John McCall036f2f62011-05-15 07:14:44 +0000680 if (!e->isArray()) {
681 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
682 sizeWithoutCookie
683 = llvm::ConstantInt::get(CGF.SizeTy, typeSize.getQuantity());
684 return sizeWithoutCookie;
Douglas Gregor05fc5be2010-07-21 01:10:17 +0000685 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000686
John McCall036f2f62011-05-15 07:14:44 +0000687 // The width of size_t.
688 unsigned sizeWidth = CGF.SizeTy->getBitWidth();
689
John McCall8ed55a52010-09-02 09:58:18 +0000690 // Figure out the cookie size.
John McCall036f2f62011-05-15 07:14:44 +0000691 llvm::APInt cookieSize(sizeWidth,
692 CalculateCookiePadding(CGF, e).getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +0000693
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000694 // Emit the array size expression.
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000695 // We multiply the size of all dimensions for NumElements.
696 // e.g for 'int[2][3]', ElemType is 'int' and NumElements is 6.
John McCallde0fe072017-08-15 21:42:52 +0000697 numElements =
Richard Smithb9fb1212019-05-06 03:47:15 +0000698 ConstantEmitter(CGF).tryEmitAbstract(*e->getArraySize(), e->getType());
Nick Lewycky07527622017-02-13 23:49:55 +0000699 if (!numElements)
Richard Smithb9fb1212019-05-06 03:47:15 +0000700 numElements = CGF.EmitScalarExpr(*e->getArraySize());
John McCall036f2f62011-05-15 07:14:44 +0000701 assert(isa<llvm::IntegerType>(numElements->getType()));
John McCall8ed55a52010-09-02 09:58:18 +0000702
John McCall036f2f62011-05-15 07:14:44 +0000703 // The number of elements can be have an arbitrary integer type;
704 // essentially, we need to multiply it by a constant factor, add a
705 // cookie size, and verify that the result is representable as a
706 // size_t. That's just a gloss, though, and it's wrong in one
707 // important way: if the count is negative, it's an error even if
708 // the cookie size would bring the total size >= 0.
Fangrui Song6907ce22018-07-30 19:24:48 +0000709 bool isSigned
Richard Smithb9fb1212019-05-06 03:47:15 +0000710 = (*e->getArraySize())->getType()->isSignedIntegerOrEnumerationType();
Chris Lattner2192fe52011-07-18 04:24:23 +0000711 llvm::IntegerType *numElementsType
John McCall036f2f62011-05-15 07:14:44 +0000712 = cast<llvm::IntegerType>(numElements->getType());
713 unsigned numElementsWidth = numElementsType->getBitWidth();
714
715 // Compute the constant factor.
716 llvm::APInt arraySizeMultiplier(sizeWidth, 1);
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000717 while (const ConstantArrayType *CAT
John McCall036f2f62011-05-15 07:14:44 +0000718 = CGF.getContext().getAsConstantArrayType(type)) {
719 type = CAT->getElementType();
720 arraySizeMultiplier *= CAT->getSize();
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000721 }
722
John McCall036f2f62011-05-15 07:14:44 +0000723 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
724 llvm::APInt typeSizeMultiplier(sizeWidth, typeSize.getQuantity());
725 typeSizeMultiplier *= arraySizeMultiplier;
726
727 // This will be a size_t.
728 llvm::Value *size;
Fangrui Song6907ce22018-07-30 19:24:48 +0000729
Chris Lattner32ac5832010-07-20 21:55:52 +0000730 // If someone is doing 'new int[42]' there is no need to do a dynamic check.
731 // Don't bloat the -O0 code.
John McCall036f2f62011-05-15 07:14:44 +0000732 if (llvm::ConstantInt *numElementsC =
733 dyn_cast<llvm::ConstantInt>(numElements)) {
734 const llvm::APInt &count = numElementsC->getValue();
John McCall8ed55a52010-09-02 09:58:18 +0000735
John McCall036f2f62011-05-15 07:14:44 +0000736 bool hasAnyOverflow = false;
John McCall8ed55a52010-09-02 09:58:18 +0000737
John McCall036f2f62011-05-15 07:14:44 +0000738 // If 'count' was a negative number, it's an overflow.
739 if (isSigned && count.isNegative())
740 hasAnyOverflow = true;
John McCall8ed55a52010-09-02 09:58:18 +0000741
John McCall036f2f62011-05-15 07:14:44 +0000742 // We want to do all this arithmetic in size_t. If numElements is
743 // wider than that, check whether it's already too big, and if so,
744 // overflow.
745 else if (numElementsWidth > sizeWidth &&
746 numElementsWidth - sizeWidth > count.countLeadingZeros())
747 hasAnyOverflow = true;
748
749 // Okay, compute a count at the right width.
750 llvm::APInt adjustedCount = count.zextOrTrunc(sizeWidth);
751
Sebastian Redlf862eb62012-02-22 17:37:52 +0000752 // If there is a brace-initializer, we cannot allocate fewer elements than
753 // there are initializers. If we do, that's treated like an overflow.
754 if (adjustedCount.ult(minElements))
755 hasAnyOverflow = true;
756
John McCall036f2f62011-05-15 07:14:44 +0000757 // Scale numElements by that. This might overflow, but we don't
758 // care because it only overflows if allocationSize does, too, and
759 // if that overflows then we shouldn't use this.
760 numElements = llvm::ConstantInt::get(CGF.SizeTy,
761 adjustedCount * arraySizeMultiplier);
762
763 // Compute the size before cookie, and track whether it overflowed.
764 bool overflow;
765 llvm::APInt allocationSize
766 = adjustedCount.umul_ov(typeSizeMultiplier, overflow);
767 hasAnyOverflow |= overflow;
768
769 // Add in the cookie, and check whether it's overflowed.
770 if (cookieSize != 0) {
771 // Save the current size without a cookie. This shouldn't be
772 // used if there was overflow.
773 sizeWithoutCookie = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
774
775 allocationSize = allocationSize.uadd_ov(cookieSize, overflow);
776 hasAnyOverflow |= overflow;
777 }
778
779 // On overflow, produce a -1 so operator new will fail.
Aaron Ballman455f42c2014-08-28 17:24:14 +0000780 if (hasAnyOverflow) {
781 size = llvm::Constant::getAllOnesValue(CGF.SizeTy);
782 } else {
John McCall036f2f62011-05-15 07:14:44 +0000783 size = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
Aaron Ballman455f42c2014-08-28 17:24:14 +0000784 }
John McCall036f2f62011-05-15 07:14:44 +0000785
786 // Otherwise, we might need to use the overflow intrinsics.
787 } else {
Sebastian Redlf862eb62012-02-22 17:37:52 +0000788 // There are up to five conditions we need to test for:
John McCall036f2f62011-05-15 07:14:44 +0000789 // 1) if isSigned, we need to check whether numElements is negative;
790 // 2) if numElementsWidth > sizeWidth, we need to check whether
791 // numElements is larger than something representable in size_t;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000792 // 3) if minElements > 0, we need to check whether numElements is smaller
793 // than that.
794 // 4) we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000795 // sizeWithoutCookie := numElements * typeSizeMultiplier
796 // and check whether it overflows; and
Sebastian Redlf862eb62012-02-22 17:37:52 +0000797 // 5) if we need a cookie, we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000798 // size := sizeWithoutCookie + cookieSize
799 // and check whether it overflows.
800
Craig Topper8a13c412014-05-21 05:09:00 +0000801 llvm::Value *hasOverflow = nullptr;
John McCall036f2f62011-05-15 07:14:44 +0000802
803 // If numElementsWidth > sizeWidth, then one way or another, we're
804 // going to have to do a comparison for (2), and this happens to
805 // take care of (1), too.
806 if (numElementsWidth > sizeWidth) {
807 llvm::APInt threshold(numElementsWidth, 1);
808 threshold <<= sizeWidth;
809
810 llvm::Value *thresholdV
811 = llvm::ConstantInt::get(numElementsType, threshold);
812
813 hasOverflow = CGF.Builder.CreateICmpUGE(numElements, thresholdV);
814 numElements = CGF.Builder.CreateTrunc(numElements, CGF.SizeTy);
815
816 // Otherwise, if we're signed, we want to sext up to size_t.
817 } else if (isSigned) {
818 if (numElementsWidth < sizeWidth)
819 numElements = CGF.Builder.CreateSExt(numElements, CGF.SizeTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000820
John McCall036f2f62011-05-15 07:14:44 +0000821 // If there's a non-1 type size multiplier, then we can do the
822 // signedness check at the same time as we do the multiply
823 // because a negative number times anything will cause an
Sebastian Redlf862eb62012-02-22 17:37:52 +0000824 // unsigned overflow. Otherwise, we have to do it here. But at least
825 // in this case, we can subsume the >= minElements check.
John McCall036f2f62011-05-15 07:14:44 +0000826 if (typeSizeMultiplier == 1)
827 hasOverflow = CGF.Builder.CreateICmpSLT(numElements,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000828 llvm::ConstantInt::get(CGF.SizeTy, minElements));
John McCall036f2f62011-05-15 07:14:44 +0000829
830 // Otherwise, zext up to size_t if necessary.
831 } else if (numElementsWidth < sizeWidth) {
832 numElements = CGF.Builder.CreateZExt(numElements, CGF.SizeTy);
833 }
834
835 assert(numElements->getType() == CGF.SizeTy);
836
Sebastian Redlf862eb62012-02-22 17:37:52 +0000837 if (minElements) {
838 // Don't allow allocation of fewer elements than we have initializers.
839 if (!hasOverflow) {
840 hasOverflow = CGF.Builder.CreateICmpULT(numElements,
841 llvm::ConstantInt::get(CGF.SizeTy, minElements));
842 } else if (numElementsWidth > sizeWidth) {
843 // The other existing overflow subsumes this check.
844 // We do an unsigned comparison, since any signed value < -1 is
845 // taken care of either above or below.
846 hasOverflow = CGF.Builder.CreateOr(hasOverflow,
847 CGF.Builder.CreateICmpULT(numElements,
848 llvm::ConstantInt::get(CGF.SizeTy, minElements)));
849 }
850 }
851
John McCall036f2f62011-05-15 07:14:44 +0000852 size = numElements;
853
854 // Multiply by the type size if necessary. This multiplier
855 // includes all the factors for nested arrays.
856 //
857 // This step also causes numElements to be scaled up by the
858 // nested-array factor if necessary. Overflow on this computation
859 // can be ignored because the result shouldn't be used if
860 // allocation fails.
861 if (typeSizeMultiplier != 1) {
James Y Knight8799cae2019-02-03 21:53:49 +0000862 llvm::Function *umul_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000863 = CGF.CGM.getIntrinsic(llvm::Intrinsic::umul_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000864
865 llvm::Value *tsmV =
866 llvm::ConstantInt::get(CGF.SizeTy, typeSizeMultiplier);
867 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000868 CGF.Builder.CreateCall(umul_with_overflow, {size, tsmV});
John McCall036f2f62011-05-15 07:14:44 +0000869
870 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
871 if (hasOverflow)
872 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
873 else
874 hasOverflow = overflowed;
875
876 size = CGF.Builder.CreateExtractValue(result, 0);
877
878 // Also scale up numElements by the array size multiplier.
879 if (arraySizeMultiplier != 1) {
880 // If the base element type size is 1, then we can re-use the
881 // multiply we just did.
882 if (typeSize.isOne()) {
883 assert(arraySizeMultiplier == typeSizeMultiplier);
884 numElements = size;
885
886 // Otherwise we need a separate multiply.
887 } else {
888 llvm::Value *asmV =
889 llvm::ConstantInt::get(CGF.SizeTy, arraySizeMultiplier);
890 numElements = CGF.Builder.CreateMul(numElements, asmV);
891 }
892 }
893 } else {
894 // numElements doesn't need to be scaled.
895 assert(arraySizeMultiplier == 1);
Chris Lattner32ac5832010-07-20 21:55:52 +0000896 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000897
John McCall036f2f62011-05-15 07:14:44 +0000898 // Add in the cookie size if necessary.
899 if (cookieSize != 0) {
900 sizeWithoutCookie = size;
901
James Y Knight8799cae2019-02-03 21:53:49 +0000902 llvm::Function *uadd_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000903 = CGF.CGM.getIntrinsic(llvm::Intrinsic::uadd_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000904
905 llvm::Value *cookieSizeV = llvm::ConstantInt::get(CGF.SizeTy, cookieSize);
906 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000907 CGF.Builder.CreateCall(uadd_with_overflow, {size, cookieSizeV});
John McCall036f2f62011-05-15 07:14:44 +0000908
909 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
910 if (hasOverflow)
911 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
912 else
913 hasOverflow = overflowed;
914
915 size = CGF.Builder.CreateExtractValue(result, 0);
John McCall8ed55a52010-09-02 09:58:18 +0000916 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000917
John McCall036f2f62011-05-15 07:14:44 +0000918 // If we had any possibility of dynamic overflow, make a select to
919 // overwrite 'size' with an all-ones value, which should cause
920 // operator new to throw.
921 if (hasOverflow)
Aaron Ballman455f42c2014-08-28 17:24:14 +0000922 size = CGF.Builder.CreateSelect(hasOverflow,
923 llvm::Constant::getAllOnesValue(CGF.SizeTy),
924 size);
Chris Lattner32ac5832010-07-20 21:55:52 +0000925 }
John McCall8ed55a52010-09-02 09:58:18 +0000926
John McCall036f2f62011-05-15 07:14:44 +0000927 if (cookieSize == 0)
928 sizeWithoutCookie = size;
John McCall8ed55a52010-09-02 09:58:18 +0000929 else
John McCall036f2f62011-05-15 07:14:44 +0000930 assert(sizeWithoutCookie && "didn't set sizeWithoutCookie?");
John McCall8ed55a52010-09-02 09:58:18 +0000931
John McCall036f2f62011-05-15 07:14:44 +0000932 return size;
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000933}
934
Sebastian Redlf862eb62012-02-22 17:37:52 +0000935static void StoreAnyExprIntoOneUnit(CodeGenFunction &CGF, const Expr *Init,
Richard Smithe78fac52018-04-05 20:52:58 +0000936 QualType AllocType, Address NewPtr,
937 AggValueSlot::Overlap_t MayOverlap) {
Richard Smith1c96bc52013-12-11 01:40:16 +0000938 // FIXME: Refactor with EmitExprAsInit.
John McCall47fb9502013-03-07 21:37:08 +0000939 switch (CGF.getEvaluationKind(AllocType)) {
940 case TEK_Scalar:
David Blaikiea2c11242014-12-10 19:04:09 +0000941 CGF.EmitScalarInit(Init, nullptr,
John McCall7f416cc2015-09-08 08:05:57 +0000942 CGF.MakeAddrLValue(NewPtr, AllocType), false);
John McCall47fb9502013-03-07 21:37:08 +0000943 return;
944 case TEK_Complex:
John McCall7f416cc2015-09-08 08:05:57 +0000945 CGF.EmitComplexExprIntoLValue(Init, CGF.MakeAddrLValue(NewPtr, AllocType),
John McCall47fb9502013-03-07 21:37:08 +0000946 /*isInit*/ true);
947 return;
948 case TEK_Aggregate: {
John McCall7a626f62010-09-15 10:14:12 +0000949 AggValueSlot Slot
John McCall7f416cc2015-09-08 08:05:57 +0000950 = AggValueSlot::forAddr(NewPtr, AllocType.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +0000951 AggValueSlot::IsDestructed,
John McCall46759f42011-08-26 07:31:35 +0000952 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +0000953 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +0000954 MayOverlap, AggValueSlot::IsNotZeroed,
955 AggValueSlot::IsSanitizerChecked);
John McCall7a626f62010-09-15 10:14:12 +0000956 CGF.EmitAggExpr(Init, Slot);
John McCall47fb9502013-03-07 21:37:08 +0000957 return;
John McCall7a626f62010-09-15 10:14:12 +0000958 }
John McCall47fb9502013-03-07 21:37:08 +0000959 }
960 llvm_unreachable("bad evaluation kind");
Fariborz Jahaniand5202e02010-06-25 18:26:07 +0000961}
962
David Blaikiefb901c7a2015-04-04 15:12:29 +0000963void CodeGenFunction::EmitNewArrayInitializer(
964 const CXXNewExpr *E, QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +0000965 Address BeginPtr, llvm::Value *NumElements,
David Blaikiefb901c7a2015-04-04 15:12:29 +0000966 llvm::Value *AllocSizeWithoutCookie) {
Richard Smith06a67e22014-06-03 06:58:52 +0000967 // If we have a type with trivial initialization and no initializer,
968 // there's nothing to do.
Sebastian Redl6047f072012-02-16 12:22:20 +0000969 if (!E->hasInitializer())
Richard Smith06a67e22014-06-03 06:58:52 +0000970 return;
John McCall99210dc2011-09-15 06:49:18 +0000971
John McCall7f416cc2015-09-08 08:05:57 +0000972 Address CurPtr = BeginPtr;
John McCall99210dc2011-09-15 06:49:18 +0000973
Richard Smith06a67e22014-06-03 06:58:52 +0000974 unsigned InitListElements = 0;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000975
976 const Expr *Init = E->getInitializer();
John McCall7f416cc2015-09-08 08:05:57 +0000977 Address EndOfInit = Address::invalid();
Richard Smith06a67e22014-06-03 06:58:52 +0000978 QualType::DestructionKind DtorKind = ElementType.isDestructedType();
979 EHScopeStack::stable_iterator Cleanup;
980 llvm::Instruction *CleanupDominator = nullptr;
Richard Smith1c96bc52013-12-11 01:40:16 +0000981
John McCall7f416cc2015-09-08 08:05:57 +0000982 CharUnits ElementSize = getContext().getTypeSizeInChars(ElementType);
983 CharUnits ElementAlign =
984 BeginPtr.getAlignment().alignmentOfArrayElement(ElementSize);
985
Richard Smith0511d232016-10-05 22:41:02 +0000986 // Attempt to perform zero-initialization using memset.
987 auto TryMemsetInitialization = [&]() -> bool {
988 // FIXME: If the type is a pointer-to-data-member under the Itanium ABI,
989 // we can initialize with a memset to -1.
990 if (!CGM.getTypes().isZeroInitializable(ElementType))
991 return false;
992
993 // Optimization: since zero initialization will just set the memory
994 // to all zeroes, generate a single memset to do it in one shot.
995
996 // Subtract out the size of any elements we've already initialized.
997 auto *RemainingSize = AllocSizeWithoutCookie;
998 if (InitListElements) {
999 // We know this can't overflow; we check this when doing the allocation.
1000 auto *InitializedSize = llvm::ConstantInt::get(
1001 RemainingSize->getType(),
1002 getContext().getTypeSizeInChars(ElementType).getQuantity() *
1003 InitListElements);
1004 RemainingSize = Builder.CreateSub(RemainingSize, InitializedSize);
1005 }
1006
1007 // Create the memset.
1008 Builder.CreateMemSet(CurPtr, Builder.getInt8(0), RemainingSize, false);
1009 return true;
1010 };
1011
Sebastian Redlf862eb62012-02-22 17:37:52 +00001012 // If the initializer is an initializer list, first do the explicit elements.
1013 if (const InitListExpr *ILE = dyn_cast<InitListExpr>(Init)) {
Richard Smith0511d232016-10-05 22:41:02 +00001014 // Initializing from a (braced) string literal is a special case; the init
1015 // list element does not initialize a (single) array element.
1016 if (ILE->isStringLiteralInit()) {
1017 // Initialize the initial portion of length equal to that of the string
1018 // literal. The allocation must be for at least this much; we emitted a
1019 // check for that earlier.
1020 AggValueSlot Slot =
1021 AggValueSlot::forAddr(CurPtr, ElementType.getQualifiers(),
1022 AggValueSlot::IsDestructed,
1023 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001024 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +00001025 AggValueSlot::DoesNotOverlap,
1026 AggValueSlot::IsNotZeroed,
1027 AggValueSlot::IsSanitizerChecked);
Richard Smith0511d232016-10-05 22:41:02 +00001028 EmitAggExpr(ILE->getInit(0), Slot);
1029
1030 // Move past these elements.
1031 InitListElements =
1032 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1033 ->getSize().getZExtValue();
1034 CurPtr =
1035 Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1036 Builder.getSize(InitListElements),
1037 "string.init.end"),
1038 CurPtr.getAlignment().alignmentAtOffset(InitListElements *
1039 ElementSize));
1040
1041 // Zero out the rest, if any remain.
1042 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1043 if (!ConstNum || !ConstNum->equalsInt(InitListElements)) {
1044 bool OK = TryMemsetInitialization();
1045 (void)OK;
1046 assert(OK && "couldn't memset character type?");
1047 }
1048 return;
1049 }
1050
Richard Smith06a67e22014-06-03 06:58:52 +00001051 InitListElements = ILE->getNumInits();
Chad Rosierf62290a2012-02-24 00:13:55 +00001052
Richard Smith1c96bc52013-12-11 01:40:16 +00001053 // If this is a multi-dimensional array new, we will initialize multiple
1054 // elements with each init list element.
1055 QualType AllocType = E->getAllocatedType();
1056 if (const ConstantArrayType *CAT = dyn_cast_or_null<ConstantArrayType>(
1057 AllocType->getAsArrayTypeUnsafe())) {
David Blaikiefb901c7a2015-04-04 15:12:29 +00001058 ElementTy = ConvertTypeForMem(AllocType);
John McCall7f416cc2015-09-08 08:05:57 +00001059 CurPtr = Builder.CreateElementBitCast(CurPtr, ElementTy);
Richard Smith06a67e22014-06-03 06:58:52 +00001060 InitListElements *= getContext().getConstantArrayElementCount(CAT);
Richard Smith1c96bc52013-12-11 01:40:16 +00001061 }
1062
Richard Smith06a67e22014-06-03 06:58:52 +00001063 // Enter a partial-destruction Cleanup if necessary.
1064 if (needsEHCleanup(DtorKind)) {
1065 // In principle we could tell the Cleanup where we are more
Chad Rosierf62290a2012-02-24 00:13:55 +00001066 // directly, but the control flow can get so varied here that it
1067 // would actually be quite complex. Therefore we go through an
1068 // alloca.
John McCall7f416cc2015-09-08 08:05:57 +00001069 EndOfInit = CreateTempAlloca(BeginPtr.getType(), getPointerAlign(),
1070 "array.init.end");
1071 CleanupDominator = Builder.CreateStore(BeginPtr.getPointer(), EndOfInit);
1072 pushIrregularPartialArrayCleanup(BeginPtr.getPointer(), EndOfInit,
1073 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001074 getDestroyer(DtorKind));
1075 Cleanup = EHStack.stable_begin();
Chad Rosierf62290a2012-02-24 00:13:55 +00001076 }
1077
John McCall7f416cc2015-09-08 08:05:57 +00001078 CharUnits StartAlign = CurPtr.getAlignment();
Sebastian Redlf862eb62012-02-22 17:37:52 +00001079 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i) {
Chad Rosierf62290a2012-02-24 00:13:55 +00001080 // Tell the cleanup that it needs to destroy up to this
1081 // element. TODO: some of these stores can be trivially
1082 // observed to be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00001083 if (EndOfInit.isValid()) {
1084 auto FinishedPtr =
1085 Builder.CreateBitCast(CurPtr.getPointer(), BeginPtr.getType());
1086 Builder.CreateStore(FinishedPtr, EndOfInit);
1087 }
Richard Smith06a67e22014-06-03 06:58:52 +00001088 // FIXME: If the last initializer is an incomplete initializer list for
1089 // an array, and we have an array filler, we can fold together the two
1090 // initialization loops.
Richard Smith1c96bc52013-12-11 01:40:16 +00001091 StoreAnyExprIntoOneUnit(*this, ILE->getInit(i),
Richard Smithe78fac52018-04-05 20:52:58 +00001092 ILE->getInit(i)->getType(), CurPtr,
1093 AggValueSlot::DoesNotOverlap);
John McCall7f416cc2015-09-08 08:05:57 +00001094 CurPtr = Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1095 Builder.getSize(1),
1096 "array.exp.next"),
1097 StartAlign.alignmentAtOffset((i + 1) * ElementSize));
Sebastian Redlf862eb62012-02-22 17:37:52 +00001098 }
1099
1100 // The remaining elements are filled with the array filler expression.
1101 Init = ILE->getArrayFiller();
Richard Smith1c96bc52013-12-11 01:40:16 +00001102
Richard Smith06a67e22014-06-03 06:58:52 +00001103 // Extract the initializer for the individual array elements by pulling
1104 // out the array filler from all the nested initializer lists. This avoids
1105 // generating a nested loop for the initialization.
1106 while (Init && Init->getType()->isConstantArrayType()) {
1107 auto *SubILE = dyn_cast<InitListExpr>(Init);
1108 if (!SubILE)
1109 break;
1110 assert(SubILE->getNumInits() == 0 && "explicit inits in array filler?");
1111 Init = SubILE->getArrayFiller();
1112 }
1113
1114 // Switch back to initializing one base element at a time.
John McCall7f416cc2015-09-08 08:05:57 +00001115 CurPtr = Builder.CreateBitCast(CurPtr, BeginPtr.getType());
Sebastian Redlf862eb62012-02-22 17:37:52 +00001116 }
1117
Richard Smith454a7cd2014-06-03 08:26:00 +00001118 // If all elements have already been initialized, skip any further
1119 // initialization.
1120 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1121 if (ConstNum && ConstNum->getZExtValue() <= InitListElements) {
1122 // If there was a Cleanup, deactivate it.
1123 if (CleanupDominator)
1124 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1125 return;
1126 }
1127
1128 assert(Init && "have trailing elements to initialize but no initializer");
1129
Richard Smith06a67e22014-06-03 06:58:52 +00001130 // If this is a constructor call, try to optimize it out, and failing that
1131 // emit a single loop to initialize all remaining elements.
Richard Smith454a7cd2014-06-03 08:26:00 +00001132 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001133 CXXConstructorDecl *Ctor = CCE->getConstructor();
1134 if (Ctor->isTrivial()) {
1135 // If new expression did not specify value-initialization, then there
1136 // is no initialization.
1137 if (!CCE->requiresZeroInitialization() || Ctor->getParent()->isEmpty())
1138 return;
1139
1140 if (TryMemsetInitialization())
1141 return;
1142 }
1143
1144 // Store the new Cleanup position for irregular Cleanups.
1145 //
1146 // FIXME: Share this cleanup with the constructor call emission rather than
1147 // having it create a cleanup of its own.
John McCall7f416cc2015-09-08 08:05:57 +00001148 if (EndOfInit.isValid())
1149 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Richard Smith06a67e22014-06-03 06:58:52 +00001150
1151 // Emit a constructor call loop to initialize the remaining elements.
1152 if (InitListElements)
1153 NumElements = Builder.CreateSub(
1154 NumElements,
1155 llvm::ConstantInt::get(NumElements->getType(), InitListElements));
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001156 EmitCXXAggrConstructorCall(Ctor, NumElements, CurPtr, CCE,
Serge Pavlov37605182018-07-28 15:33:03 +00001157 /*NewPointerIsChecked*/true,
Richard Smith06a67e22014-06-03 06:58:52 +00001158 CCE->requiresZeroInitialization());
Chandler Carruthe6c980c2014-05-03 09:16:57 +00001159 return;
1160 }
1161
Richard Smith06a67e22014-06-03 06:58:52 +00001162 // If this is value-initialization, we can usually use memset.
1163 ImplicitValueInitExpr IVIE(ElementType);
Richard Smith454a7cd2014-06-03 08:26:00 +00001164 if (isa<ImplicitValueInitExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001165 if (TryMemsetInitialization())
1166 return;
1167
1168 // Switch to an ImplicitValueInitExpr for the element type. This handles
1169 // only one case: multidimensional array new of pointers to members. In
1170 // all other cases, we already have an initializer for the array element.
1171 Init = &IVIE;
1172 }
1173
1174 // At this point we should have found an initializer for the individual
1175 // elements of the array.
1176 assert(getContext().hasSameUnqualifiedType(ElementType, Init->getType()) &&
1177 "got wrong type of element to initialize");
1178
Richard Smith454a7cd2014-06-03 08:26:00 +00001179 // If we have an empty initializer list, we can usually use memset.
1180 if (auto *ILE = dyn_cast<InitListExpr>(Init))
1181 if (ILE->getNumInits() == 0 && TryMemsetInitialization())
1182 return;
Richard Smith06a67e22014-06-03 06:58:52 +00001183
Yunzhong Gaocb779302015-06-10 00:27:52 +00001184 // If we have a struct whose every field is value-initialized, we can
1185 // usually use memset.
1186 if (auto *ILE = dyn_cast<InitListExpr>(Init)) {
1187 if (const RecordType *RType = ILE->getType()->getAs<RecordType>()) {
1188 if (RType->getDecl()->isStruct()) {
Richard Smith872307e2016-03-08 22:17:41 +00001189 unsigned NumElements = 0;
1190 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RType->getDecl()))
1191 NumElements = CXXRD->getNumBases();
Yunzhong Gaocb779302015-06-10 00:27:52 +00001192 for (auto *Field : RType->getDecl()->fields())
1193 if (!Field->isUnnamedBitfield())
Richard Smith872307e2016-03-08 22:17:41 +00001194 ++NumElements;
1195 // FIXME: Recurse into nested InitListExprs.
1196 if (ILE->getNumInits() == NumElements)
Yunzhong Gaocb779302015-06-10 00:27:52 +00001197 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i)
1198 if (!isa<ImplicitValueInitExpr>(ILE->getInit(i)))
Richard Smith872307e2016-03-08 22:17:41 +00001199 --NumElements;
1200 if (ILE->getNumInits() == NumElements && TryMemsetInitialization())
Yunzhong Gaocb779302015-06-10 00:27:52 +00001201 return;
1202 }
1203 }
1204 }
1205
Richard Smith06a67e22014-06-03 06:58:52 +00001206 // Create the loop blocks.
1207 llvm::BasicBlock *EntryBB = Builder.GetInsertBlock();
1208 llvm::BasicBlock *LoopBB = createBasicBlock("new.loop");
1209 llvm::BasicBlock *ContBB = createBasicBlock("new.loop.end");
1210
1211 // Find the end of the array, hoisted out of the loop.
1212 llvm::Value *EndPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001213 Builder.CreateInBoundsGEP(BeginPtr.getPointer(), NumElements, "array.end");
John McCall99210dc2011-09-15 06:49:18 +00001214
Sebastian Redlf862eb62012-02-22 17:37:52 +00001215 // If the number of elements isn't constant, we have to now check if there is
1216 // anything left to initialize.
Richard Smith06a67e22014-06-03 06:58:52 +00001217 if (!ConstNum) {
John McCall7f416cc2015-09-08 08:05:57 +00001218 llvm::Value *IsEmpty =
1219 Builder.CreateICmpEQ(CurPtr.getPointer(), EndPtr, "array.isempty");
Richard Smith06a67e22014-06-03 06:58:52 +00001220 Builder.CreateCondBr(IsEmpty, ContBB, LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001221 }
1222
1223 // Enter the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001224 EmitBlock(LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001225
1226 // Set up the current-element phi.
Richard Smith06a67e22014-06-03 06:58:52 +00001227 llvm::PHINode *CurPtrPhi =
John McCall7f416cc2015-09-08 08:05:57 +00001228 Builder.CreatePHI(CurPtr.getType(), 2, "array.cur");
1229 CurPtrPhi->addIncoming(CurPtr.getPointer(), EntryBB);
1230
1231 CurPtr = Address(CurPtrPhi, ElementAlign);
John McCall99210dc2011-09-15 06:49:18 +00001232
Richard Smith06a67e22014-06-03 06:58:52 +00001233 // Store the new Cleanup position for irregular Cleanups.
Fangrui Song6907ce22018-07-30 19:24:48 +00001234 if (EndOfInit.isValid())
John McCall7f416cc2015-09-08 08:05:57 +00001235 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Chad Rosierf62290a2012-02-24 00:13:55 +00001236
Richard Smith06a67e22014-06-03 06:58:52 +00001237 // Enter a partial-destruction Cleanup if necessary.
1238 if (!CleanupDominator && needsEHCleanup(DtorKind)) {
John McCall7f416cc2015-09-08 08:05:57 +00001239 pushRegularPartialArrayCleanup(BeginPtr.getPointer(), CurPtr.getPointer(),
1240 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001241 getDestroyer(DtorKind));
1242 Cleanup = EHStack.stable_begin();
1243 CleanupDominator = Builder.CreateUnreachable();
John McCall99210dc2011-09-15 06:49:18 +00001244 }
1245
1246 // Emit the initializer into this element.
Richard Smithe78fac52018-04-05 20:52:58 +00001247 StoreAnyExprIntoOneUnit(*this, Init, Init->getType(), CurPtr,
1248 AggValueSlot::DoesNotOverlap);
John McCall99210dc2011-09-15 06:49:18 +00001249
Richard Smith06a67e22014-06-03 06:58:52 +00001250 // Leave the Cleanup if we entered one.
1251 if (CleanupDominator) {
1252 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1253 CleanupDominator->eraseFromParent();
John McCallf4beacd2011-11-10 10:43:54 +00001254 }
John McCall99210dc2011-09-15 06:49:18 +00001255
Faisal Vali57ae0562013-12-14 00:40:05 +00001256 // Advance to the next element by adjusting the pointer type as necessary.
Richard Smith06a67e22014-06-03 06:58:52 +00001257 llvm::Value *NextPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001258 Builder.CreateConstInBoundsGEP1_32(ElementTy, CurPtr.getPointer(), 1,
1259 "array.next");
Richard Smith06a67e22014-06-03 06:58:52 +00001260
John McCall99210dc2011-09-15 06:49:18 +00001261 // Check whether we've gotten to the end of the array and, if so,
1262 // exit the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001263 llvm::Value *IsEnd = Builder.CreateICmpEQ(NextPtr, EndPtr, "array.atend");
1264 Builder.CreateCondBr(IsEnd, ContBB, LoopBB);
1265 CurPtrPhi->addIncoming(NextPtr, Builder.GetInsertBlock());
John McCall99210dc2011-09-15 06:49:18 +00001266
Richard Smith06a67e22014-06-03 06:58:52 +00001267 EmitBlock(ContBB);
Fariborz Jahaniand5202e02010-06-25 18:26:07 +00001268}
1269
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001270static void EmitNewInitializer(CodeGenFunction &CGF, const CXXNewExpr *E,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001271 QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +00001272 Address NewPtr, llvm::Value *NumElements,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001273 llvm::Value *AllocSizeWithoutCookie) {
David Blaikie9b479662015-01-25 01:19:10 +00001274 ApplyDebugLocation DL(CGF, E);
Richard Smith06a67e22014-06-03 06:58:52 +00001275 if (E->isArray())
David Blaikiefb901c7a2015-04-04 15:12:29 +00001276 CGF.EmitNewArrayInitializer(E, ElementType, ElementTy, NewPtr, NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001277 AllocSizeWithoutCookie);
1278 else if (const Expr *Init = E->getInitializer())
Richard Smithe78fac52018-04-05 20:52:58 +00001279 StoreAnyExprIntoOneUnit(CGF, Init, E->getAllocatedType(), NewPtr,
1280 AggValueSlot::DoesNotOverlap);
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001281}
1282
Richard Smith8d0dc312013-07-21 23:12:18 +00001283/// Emit a call to an operator new or operator delete function, as implicitly
1284/// created by new-expressions and delete-expressions.
1285static RValue EmitNewDeleteCall(CodeGenFunction &CGF,
John McCallb92ab1a2016-10-26 23:46:34 +00001286 const FunctionDecl *CalleeDecl,
Richard Smith8d0dc312013-07-21 23:12:18 +00001287 const FunctionProtoType *CalleeType,
1288 const CallArgList &Args) {
James Y Knight3933add2019-01-30 02:54:28 +00001289 llvm::CallBase *CallOrInvoke;
John McCallb92ab1a2016-10-26 23:46:34 +00001290 llvm::Constant *CalleePtr = CGF.CGM.GetAddrOfFunction(CalleeDecl);
Erich Keanede6480a32018-11-13 15:48:08 +00001291 CGCallee Callee = CGCallee::forDirect(CalleePtr, GlobalDecl(CalleeDecl));
Richard Smith8d0dc312013-07-21 23:12:18 +00001292 RValue RV =
Peter Collingbournef7706832014-12-12 23:41:25 +00001293 CGF.EmitCall(CGF.CGM.getTypes().arrangeFreeFunctionCall(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001294 Args, CalleeType, /*ChainCall=*/false),
John McCallb92ab1a2016-10-26 23:46:34 +00001295 Callee, ReturnValueSlot(), Args, &CallOrInvoke);
Richard Smith8d0dc312013-07-21 23:12:18 +00001296
1297 /// C++1y [expr.new]p10:
1298 /// [In a new-expression,] an implementation is allowed to omit a call
1299 /// to a replaceable global allocation function.
1300 ///
1301 /// We model such elidable calls with the 'builtin' attribute.
John McCallb92ab1a2016-10-26 23:46:34 +00001302 llvm::Function *Fn = dyn_cast<llvm::Function>(CalleePtr);
1303 if (CalleeDecl->isReplaceableGlobalAllocationFunction() &&
Rafael Espindola6956d582013-10-22 14:23:09 +00001304 Fn && Fn->hasFnAttribute(llvm::Attribute::NoBuiltin)) {
James Y Knight3933add2019-01-30 02:54:28 +00001305 CallOrInvoke->addAttribute(llvm::AttributeList::FunctionIndex,
1306 llvm::Attribute::Builtin);
Richard Smith8d0dc312013-07-21 23:12:18 +00001307 }
1308
1309 return RV;
1310}
1311
Richard Smith760520b2014-06-03 23:27:44 +00001312RValue CodeGenFunction::EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00001313 const CallExpr *TheCall,
Richard Smith760520b2014-06-03 23:27:44 +00001314 bool IsDelete) {
1315 CallArgList Args;
Eric Fiselierfa752f22018-03-21 19:19:48 +00001316 EmitCallArgs(Args, Type->getParamTypes(), TheCall->arguments());
Richard Smith760520b2014-06-03 23:27:44 +00001317 // Find the allocation or deallocation function that we're calling.
1318 ASTContext &Ctx = getContext();
1319 DeclarationName Name = Ctx.DeclarationNames
1320 .getCXXOperatorName(IsDelete ? OO_Delete : OO_New);
Eric Fiselierfa752f22018-03-21 19:19:48 +00001321
Richard Smith760520b2014-06-03 23:27:44 +00001322 for (auto *Decl : Ctx.getTranslationUnitDecl()->lookup(Name))
Richard Smith599bed72014-06-05 00:43:02 +00001323 if (auto *FD = dyn_cast<FunctionDecl>(Decl))
1324 if (Ctx.hasSameType(FD->getType(), QualType(Type, 0)))
Eric Fiselierfa752f22018-03-21 19:19:48 +00001325 return EmitNewDeleteCall(*this, FD, Type, Args);
Richard Smith760520b2014-06-03 23:27:44 +00001326 llvm_unreachable("predeclared global operator new/delete is missing");
1327}
1328
Richard Smith5b349582017-10-13 01:55:36 +00001329namespace {
1330/// The parameters to pass to a usual operator delete.
1331struct UsualDeleteParams {
1332 bool DestroyingDelete = false;
1333 bool Size = false;
1334 bool Alignment = false;
1335};
1336}
1337
1338static UsualDeleteParams getUsualDeleteParams(const FunctionDecl *FD) {
1339 UsualDeleteParams Params;
1340
1341 const FunctionProtoType *FPT = FD->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001342 auto AI = FPT->param_type_begin(), AE = FPT->param_type_end();
Richard Smith189e52f2016-10-10 06:42:31 +00001343
Richard Smithb2f0f052016-10-10 18:54:32 +00001344 // The first argument is always a void*.
1345 ++AI;
1346
Richard Smith5b349582017-10-13 01:55:36 +00001347 // The next parameter may be a std::destroying_delete_t.
1348 if (FD->isDestroyingOperatorDelete()) {
1349 Params.DestroyingDelete = true;
1350 assert(AI != AE);
1351 ++AI;
1352 }
Richard Smithb2f0f052016-10-10 18:54:32 +00001353
Richard Smith5b349582017-10-13 01:55:36 +00001354 // Figure out what other parameters we should be implicitly passing.
Richard Smithb2f0f052016-10-10 18:54:32 +00001355 if (AI != AE && (*AI)->isIntegerType()) {
Richard Smith5b349582017-10-13 01:55:36 +00001356 Params.Size = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001357 ++AI;
1358 }
1359
1360 if (AI != AE && (*AI)->isAlignValT()) {
Richard Smith5b349582017-10-13 01:55:36 +00001361 Params.Alignment = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001362 ++AI;
1363 }
1364
1365 assert(AI == AE && "unexpected usual deallocation function parameter");
Richard Smith5b349582017-10-13 01:55:36 +00001366 return Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001367}
1368
1369namespace {
1370 /// A cleanup to call the given 'operator delete' function upon abnormal
1371 /// exit from a new expression. Templated on a traits type that deals with
1372 /// ensuring that the arguments dominate the cleanup if necessary.
1373 template<typename Traits>
1374 class CallDeleteDuringNew final : public EHScopeStack::Cleanup {
1375 /// Type used to hold llvm::Value*s.
1376 typedef typename Traits::ValueTy ValueTy;
1377 /// Type used to hold RValues.
1378 typedef typename Traits::RValueTy RValueTy;
1379 struct PlacementArg {
1380 RValueTy ArgValue;
1381 QualType ArgType;
1382 };
1383
1384 unsigned NumPlacementArgs : 31;
1385 unsigned PassAlignmentToPlacementDelete : 1;
1386 const FunctionDecl *OperatorDelete;
1387 ValueTy Ptr;
1388 ValueTy AllocSize;
1389 CharUnits AllocAlign;
1390
1391 PlacementArg *getPlacementArgs() {
1392 return reinterpret_cast<PlacementArg *>(this + 1);
1393 }
Daniel Jaspere9abe642016-10-10 14:13:55 +00001394
1395 public:
1396 static size_t getExtraSize(size_t NumPlacementArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001397 return NumPlacementArgs * sizeof(PlacementArg);
Daniel Jaspere9abe642016-10-10 14:13:55 +00001398 }
1399
1400 CallDeleteDuringNew(size_t NumPlacementArgs,
Richard Smithb2f0f052016-10-10 18:54:32 +00001401 const FunctionDecl *OperatorDelete, ValueTy Ptr,
1402 ValueTy AllocSize, bool PassAlignmentToPlacementDelete,
1403 CharUnits AllocAlign)
1404 : NumPlacementArgs(NumPlacementArgs),
1405 PassAlignmentToPlacementDelete(PassAlignmentToPlacementDelete),
1406 OperatorDelete(OperatorDelete), Ptr(Ptr), AllocSize(AllocSize),
1407 AllocAlign(AllocAlign) {}
Daniel Jaspere9abe642016-10-10 14:13:55 +00001408
Richard Smithb2f0f052016-10-10 18:54:32 +00001409 void setPlacementArg(unsigned I, RValueTy Arg, QualType Type) {
Daniel Jaspere9abe642016-10-10 14:13:55 +00001410 assert(I < NumPlacementArgs && "index out of range");
Richard Smithb2f0f052016-10-10 18:54:32 +00001411 getPlacementArgs()[I] = {Arg, Type};
Daniel Jaspere9abe642016-10-10 14:13:55 +00001412 }
1413
1414 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001415 const FunctionProtoType *FPT =
1416 OperatorDelete->getType()->getAs<FunctionProtoType>();
Daniel Jaspere9abe642016-10-10 14:13:55 +00001417 CallArgList DeleteArgs;
1418
Richard Smith5b349582017-10-13 01:55:36 +00001419 // The first argument is always a void* (or C* for a destroying operator
1420 // delete for class type C).
Richard Smithb2f0f052016-10-10 18:54:32 +00001421 DeleteArgs.add(Traits::get(CGF, Ptr), FPT->getParamType(0));
Daniel Jaspere9abe642016-10-10 14:13:55 +00001422
Richard Smithb2f0f052016-10-10 18:54:32 +00001423 // Figure out what other parameters we should be implicitly passing.
Richard Smith5b349582017-10-13 01:55:36 +00001424 UsualDeleteParams Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001425 if (NumPlacementArgs) {
1426 // A placement deallocation function is implicitly passed an alignment
1427 // if the placement allocation function was, but is never passed a size.
Richard Smith5b349582017-10-13 01:55:36 +00001428 Params.Alignment = PassAlignmentToPlacementDelete;
Richard Smithb2f0f052016-10-10 18:54:32 +00001429 } else {
1430 // For a non-placement new-expression, 'operator delete' can take a
1431 // size and/or an alignment if it has the right parameters.
Richard Smith5b349582017-10-13 01:55:36 +00001432 Params = getUsualDeleteParams(OperatorDelete);
John McCall7f9c92a2010-09-17 00:50:28 +00001433 }
1434
Richard Smith5b349582017-10-13 01:55:36 +00001435 assert(!Params.DestroyingDelete &&
1436 "should not call destroying delete in a new-expression");
1437
Richard Smithb2f0f052016-10-10 18:54:32 +00001438 // The second argument can be a std::size_t (for non-placement delete).
Richard Smith5b349582017-10-13 01:55:36 +00001439 if (Params.Size)
Richard Smithb2f0f052016-10-10 18:54:32 +00001440 DeleteArgs.add(Traits::get(CGF, AllocSize),
1441 CGF.getContext().getSizeType());
1442
1443 // The next (second or third) argument can be a std::align_val_t, which
1444 // is an enum whose underlying type is std::size_t.
1445 // FIXME: Use the right type as the parameter type. Note that in a call
1446 // to operator delete(size_t, ...), we may not have it available.
Richard Smith5b349582017-10-13 01:55:36 +00001447 if (Params.Alignment)
Richard Smithb2f0f052016-10-10 18:54:32 +00001448 DeleteArgs.add(RValue::get(llvm::ConstantInt::get(
1449 CGF.SizeTy, AllocAlign.getQuantity())),
1450 CGF.getContext().getSizeType());
1451
John McCall7f9c92a2010-09-17 00:50:28 +00001452 // Pass the rest of the arguments, which must match exactly.
1453 for (unsigned I = 0; I != NumPlacementArgs; ++I) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001454 auto Arg = getPlacementArgs()[I];
1455 DeleteArgs.add(Traits::get(CGF, Arg.ArgValue), Arg.ArgType);
John McCall7f9c92a2010-09-17 00:50:28 +00001456 }
1457
1458 // Call 'operator delete'.
Richard Smith8d0dc312013-07-21 23:12:18 +00001459 EmitNewDeleteCall(CGF, OperatorDelete, FPT, DeleteArgs);
John McCall7f9c92a2010-09-17 00:50:28 +00001460 }
1461 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001462}
John McCall7f9c92a2010-09-17 00:50:28 +00001463
1464/// Enter a cleanup to call 'operator delete' if the initializer in a
1465/// new-expression throws.
1466static void EnterNewDeleteCleanup(CodeGenFunction &CGF,
1467 const CXXNewExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001468 Address NewPtr,
John McCall7f9c92a2010-09-17 00:50:28 +00001469 llvm::Value *AllocSize,
Richard Smithb2f0f052016-10-10 18:54:32 +00001470 CharUnits AllocAlign,
John McCall7f9c92a2010-09-17 00:50:28 +00001471 const CallArgList &NewArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001472 unsigned NumNonPlacementArgs = E->passAlignment() ? 2 : 1;
1473
John McCall7f9c92a2010-09-17 00:50:28 +00001474 // If we're not inside a conditional branch, then the cleanup will
1475 // dominate and we can do the easier (and more efficient) thing.
1476 if (!CGF.isInConditionalBranch()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001477 struct DirectCleanupTraits {
1478 typedef llvm::Value *ValueTy;
1479 typedef RValue RValueTy;
1480 static RValue get(CodeGenFunction &, ValueTy V) { return RValue::get(V); }
1481 static RValue get(CodeGenFunction &, RValueTy V) { return V; }
1482 };
1483
1484 typedef CallDeleteDuringNew<DirectCleanupTraits> DirectCleanup;
1485
1486 DirectCleanup *Cleanup = CGF.EHStack
1487 .pushCleanupWithExtra<DirectCleanup>(EHCleanup,
1488 E->getNumPlacementArgs(),
1489 E->getOperatorDelete(),
1490 NewPtr.getPointer(),
1491 AllocSize,
1492 E->passAlignment(),
1493 AllocAlign);
1494 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1495 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001496 Cleanup->setPlacementArg(I, Arg.getRValue(CGF), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001497 }
John McCall7f9c92a2010-09-17 00:50:28 +00001498
1499 return;
1500 }
1501
1502 // Otherwise, we need to save all this stuff.
John McCallcb5f77f2011-01-28 10:53:53 +00001503 DominatingValue<RValue>::saved_type SavedNewPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001504 DominatingValue<RValue>::save(CGF, RValue::get(NewPtr.getPointer()));
John McCallcb5f77f2011-01-28 10:53:53 +00001505 DominatingValue<RValue>::saved_type SavedAllocSize =
1506 DominatingValue<RValue>::save(CGF, RValue::get(AllocSize));
John McCall7f9c92a2010-09-17 00:50:28 +00001507
Richard Smithb2f0f052016-10-10 18:54:32 +00001508 struct ConditionalCleanupTraits {
1509 typedef DominatingValue<RValue>::saved_type ValueTy;
1510 typedef DominatingValue<RValue>::saved_type RValueTy;
1511 static RValue get(CodeGenFunction &CGF, ValueTy V) {
1512 return V.restore(CGF);
1513 }
1514 };
1515 typedef CallDeleteDuringNew<ConditionalCleanupTraits> ConditionalCleanup;
1516
1517 ConditionalCleanup *Cleanup = CGF.EHStack
1518 .pushCleanupWithExtra<ConditionalCleanup>(EHCleanup,
1519 E->getNumPlacementArgs(),
1520 E->getOperatorDelete(),
1521 SavedNewPtr,
1522 SavedAllocSize,
1523 E->passAlignment(),
1524 AllocAlign);
1525 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1526 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001527 Cleanup->setPlacementArg(
1528 I, DominatingValue<RValue>::save(CGF, Arg.getRValue(CGF)), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001529 }
John McCall7f9c92a2010-09-17 00:50:28 +00001530
John McCallf4beacd2011-11-10 10:43:54 +00001531 CGF.initFullExprCleanup();
John McCall824c2f52010-09-14 07:57:04 +00001532}
1533
Anders Carlssoncc52f652009-09-22 22:53:17 +00001534llvm::Value *CodeGenFunction::EmitCXXNewExpr(const CXXNewExpr *E) {
John McCall75f94982011-03-07 03:12:35 +00001535 // The element type being allocated.
1536 QualType allocType = getContext().getBaseElementType(E->getAllocatedType());
John McCall8ed55a52010-09-02 09:58:18 +00001537
John McCall75f94982011-03-07 03:12:35 +00001538 // 1. Build a call to the allocation function.
1539 FunctionDecl *allocator = E->getOperatorNew();
Anders Carlssoncc52f652009-09-22 22:53:17 +00001540
Sebastian Redlf862eb62012-02-22 17:37:52 +00001541 // If there is a brace-initializer, cannot allocate fewer elements than inits.
1542 unsigned minElements = 0;
1543 if (E->isArray() && E->hasInitializer()) {
Richard Smith0511d232016-10-05 22:41:02 +00001544 const InitListExpr *ILE = dyn_cast<InitListExpr>(E->getInitializer());
1545 if (ILE && ILE->isStringLiteralInit())
1546 minElements =
1547 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1548 ->getSize().getZExtValue();
1549 else if (ILE)
Sebastian Redlf862eb62012-02-22 17:37:52 +00001550 minElements = ILE->getNumInits();
1551 }
1552
Craig Topper8a13c412014-05-21 05:09:00 +00001553 llvm::Value *numElements = nullptr;
1554 llvm::Value *allocSizeWithoutCookie = nullptr;
John McCall75f94982011-03-07 03:12:35 +00001555 llvm::Value *allocSize =
Sebastian Redlf862eb62012-02-22 17:37:52 +00001556 EmitCXXNewAllocSize(*this, E, minElements, numElements,
1557 allocSizeWithoutCookie);
Richard Smithb2f0f052016-10-10 18:54:32 +00001558 CharUnits allocAlign = getContext().getTypeAlignInChars(allocType);
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00001559
John McCall7ec4b432011-05-16 01:05:12 +00001560 // Emit the allocation call. If the allocator is a global placement
1561 // operator, just "inline" it directly.
John McCall7f416cc2015-09-08 08:05:57 +00001562 Address allocation = Address::invalid();
1563 CallArgList allocatorArgs;
John McCall7ec4b432011-05-16 01:05:12 +00001564 if (allocator->isReservedGlobalPlacementOperator()) {
John McCall53dcf942015-09-29 23:55:17 +00001565 assert(E->getNumPlacementArgs() == 1);
1566 const Expr *arg = *E->placement_arguments().begin();
1567
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001568 LValueBaseInfo BaseInfo;
1569 allocation = EmitPointerWithAlignment(arg, &BaseInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001570
1571 // The pointer expression will, in many cases, be an opaque void*.
1572 // In these cases, discard the computed alignment and use the
1573 // formal alignment of the allocated type.
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001574 if (BaseInfo.getAlignmentSource() != AlignmentSource::Decl)
Richard Smithb2f0f052016-10-10 18:54:32 +00001575 allocation = Address(allocation.getPointer(), allocAlign);
John McCall7f416cc2015-09-08 08:05:57 +00001576
John McCall53dcf942015-09-29 23:55:17 +00001577 // Set up allocatorArgs for the call to operator delete if it's not
1578 // the reserved global operator.
1579 if (E->getOperatorDelete() &&
1580 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
1581 allocatorArgs.add(RValue::get(allocSize), getContext().getSizeType());
1582 allocatorArgs.add(RValue::get(allocation.getPointer()), arg->getType());
1583 }
1584
John McCall7ec4b432011-05-16 01:05:12 +00001585 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001586 const FunctionProtoType *allocatorType =
1587 allocator->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001588 unsigned ParamsToSkip = 0;
John McCall7f416cc2015-09-08 08:05:57 +00001589
1590 // The allocation size is the first argument.
1591 QualType sizeType = getContext().getSizeType();
1592 allocatorArgs.add(RValue::get(allocSize), sizeType);
Richard Smithb2f0f052016-10-10 18:54:32 +00001593 ++ParamsToSkip;
John McCall7f416cc2015-09-08 08:05:57 +00001594
Richard Smithb2f0f052016-10-10 18:54:32 +00001595 if (allocSize != allocSizeWithoutCookie) {
1596 CharUnits cookieAlign = getSizeAlign(); // FIXME: Ask the ABI.
1597 allocAlign = std::max(allocAlign, cookieAlign);
1598 }
1599
1600 // The allocation alignment may be passed as the second argument.
1601 if (E->passAlignment()) {
1602 QualType AlignValT = sizeType;
1603 if (allocatorType->getNumParams() > 1) {
1604 AlignValT = allocatorType->getParamType(1);
1605 assert(getContext().hasSameUnqualifiedType(
1606 AlignValT->castAs<EnumType>()->getDecl()->getIntegerType(),
1607 sizeType) &&
1608 "wrong type for alignment parameter");
1609 ++ParamsToSkip;
1610 } else {
1611 // Corner case, passing alignment to 'operator new(size_t, ...)'.
1612 assert(allocator->isVariadic() && "can't pass alignment to allocator");
1613 }
1614 allocatorArgs.add(
1615 RValue::get(llvm::ConstantInt::get(SizeTy, allocAlign.getQuantity())),
1616 AlignValT);
1617 }
1618
1619 // FIXME: Why do we not pass a CalleeDecl here?
John McCall7f416cc2015-09-08 08:05:57 +00001620 EmitCallArgs(allocatorArgs, allocatorType, E->placement_arguments(),
Vedant Kumared00ea02017-03-06 05:28:22 +00001621 /*AC*/AbstractCallee(), /*ParamsToSkip*/ParamsToSkip);
John McCall7f416cc2015-09-08 08:05:57 +00001622
1623 RValue RV =
1624 EmitNewDeleteCall(*this, allocator, allocatorType, allocatorArgs);
1625
Richard Smithb2f0f052016-10-10 18:54:32 +00001626 // If this was a call to a global replaceable allocation function that does
1627 // not take an alignment argument, the allocator is known to produce
1628 // storage that's suitably aligned for any object that fits, up to a known
1629 // threshold. Otherwise assume it's suitably aligned for the allocated type.
1630 CharUnits allocationAlign = allocAlign;
1631 if (!E->passAlignment() &&
1632 allocator->isReplaceableGlobalAllocationFunction()) {
1633 unsigned AllocatorAlign = llvm::PowerOf2Floor(std::min<uint64_t>(
1634 Target.getNewAlign(), getContext().getTypeSize(allocType)));
1635 allocationAlign = std::max(
1636 allocationAlign, getContext().toCharUnitsFromBits(AllocatorAlign));
John McCall7f416cc2015-09-08 08:05:57 +00001637 }
1638
1639 allocation = Address(RV.getScalarVal(), allocationAlign);
John McCall7ec4b432011-05-16 01:05:12 +00001640 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00001641
John McCall75f94982011-03-07 03:12:35 +00001642 // Emit a null check on the allocation result if the allocation
1643 // function is allowed to return null (because it has a non-throwing
Richard Smith902a0232015-02-14 01:52:20 +00001644 // exception spec or is the reserved placement new) and we have an
Richard Smith2f72a752019-01-10 00:03:29 +00001645 // interesting initializer will be running sanitizers on the initialization.
Bruno Ricci9b6dfac2019-01-07 15:04:45 +00001646 bool nullCheck = E->shouldNullCheckAllocation() &&
Richard Smith2f72a752019-01-10 00:03:29 +00001647 (!allocType.isPODType(getContext()) || E->hasInitializer() ||
1648 sanitizePerformTypeCheck());
Anders Carlssoncc52f652009-09-22 22:53:17 +00001649
Craig Topper8a13c412014-05-21 05:09:00 +00001650 llvm::BasicBlock *nullCheckBB = nullptr;
1651 llvm::BasicBlock *contBB = nullptr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001652
John McCallf7dcf322011-03-07 01:52:56 +00001653 // The null-check means that the initializer is conditionally
1654 // evaluated.
1655 ConditionalEvaluation conditional(*this);
1656
John McCall75f94982011-03-07 03:12:35 +00001657 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001658 conditional.begin(*this);
John McCall75f94982011-03-07 03:12:35 +00001659
1660 nullCheckBB = Builder.GetInsertBlock();
1661 llvm::BasicBlock *notNullBB = createBasicBlock("new.notnull");
1662 contBB = createBasicBlock("new.cont");
1663
John McCall7f416cc2015-09-08 08:05:57 +00001664 llvm::Value *isNull =
1665 Builder.CreateIsNull(allocation.getPointer(), "new.isnull");
John McCall75f94982011-03-07 03:12:35 +00001666 Builder.CreateCondBr(isNull, contBB, notNullBB);
1667 EmitBlock(notNullBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001668 }
Anders Carlssonf7716812009-09-23 18:59:48 +00001669
John McCall824c2f52010-09-14 07:57:04 +00001670 // If there's an operator delete, enter a cleanup to call it if an
1671 // exception is thrown.
John McCall75f94982011-03-07 03:12:35 +00001672 EHScopeStack::stable_iterator operatorDeleteCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001673 llvm::Instruction *cleanupDominator = nullptr;
John McCall7ec4b432011-05-16 01:05:12 +00001674 if (E->getOperatorDelete() &&
1675 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001676 EnterNewDeleteCleanup(*this, E, allocation, allocSize, allocAlign,
1677 allocatorArgs);
John McCall75f94982011-03-07 03:12:35 +00001678 operatorDeleteCleanup = EHStack.stable_begin();
John McCallf4beacd2011-11-10 10:43:54 +00001679 cleanupDominator = Builder.CreateUnreachable();
John McCall824c2f52010-09-14 07:57:04 +00001680 }
1681
Eli Friedmancf9b1f62011-09-06 18:53:03 +00001682 assert((allocSize == allocSizeWithoutCookie) ==
1683 CalculateCookiePadding(*this, E).isZero());
1684 if (allocSize != allocSizeWithoutCookie) {
1685 assert(E->isArray());
1686 allocation = CGM.getCXXABI().InitializeArrayCookie(*this, allocation,
1687 numElements,
1688 E, allocType);
1689 }
1690
David Blaikiefb901c7a2015-04-04 15:12:29 +00001691 llvm::Type *elementTy = ConvertTypeForMem(allocType);
John McCall7f416cc2015-09-08 08:05:57 +00001692 Address result = Builder.CreateElementBitCast(allocation, elementTy);
John McCall824c2f52010-09-14 07:57:04 +00001693
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001694 // Passing pointer through launder.invariant.group to avoid propagation of
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001695 // vptrs information which may be included in previous type.
Piotr Padlewski31fd99c2017-05-20 08:56:18 +00001696 // To not break LTO with different optimizations levels, we do it regardless
1697 // of optimization level.
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001698 if (CGM.getCodeGenOpts().StrictVTablePointers &&
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001699 allocator->isReservedGlobalPlacementOperator())
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001700 result = Address(Builder.CreateLaunderInvariantGroup(result.getPointer()),
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001701 result.getAlignment());
1702
Serge Pavlov37605182018-07-28 15:33:03 +00001703 // Emit sanitizer checks for pointer value now, so that in the case of an
Richard Smithcfa79b22019-01-23 03:37:29 +00001704 // array it was checked only once and not at each constructor call. We may
1705 // have already checked that the pointer is non-null.
1706 // FIXME: If we have an array cookie and a potentially-throwing allocator,
1707 // we'll null check the wrong pointer here.
1708 SanitizerSet SkippedChecks;
1709 SkippedChecks.set(SanitizerKind::Null, nullCheck);
Serge Pavlov37605182018-07-28 15:33:03 +00001710 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall,
Richard Smithcfa79b22019-01-23 03:37:29 +00001711 E->getAllocatedTypeSourceInfo()->getTypeLoc().getBeginLoc(),
1712 result.getPointer(), allocType, result.getAlignment(),
1713 SkippedChecks, numElements);
Serge Pavlov37605182018-07-28 15:33:03 +00001714
David Blaikiefb901c7a2015-04-04 15:12:29 +00001715 EmitNewInitializer(*this, E, allocType, elementTy, result, numElements,
John McCall99210dc2011-09-15 06:49:18 +00001716 allocSizeWithoutCookie);
John McCall8ed55a52010-09-02 09:58:18 +00001717 if (E->isArray()) {
John McCall8ed55a52010-09-02 09:58:18 +00001718 // NewPtr is a pointer to the base element type. If we're
1719 // allocating an array of arrays, we'll need to cast back to the
1720 // array pointer type.
Chris Lattner2192fe52011-07-18 04:24:23 +00001721 llvm::Type *resultType = ConvertTypeForMem(E->getType());
John McCall7f416cc2015-09-08 08:05:57 +00001722 if (result.getType() != resultType)
John McCall75f94982011-03-07 03:12:35 +00001723 result = Builder.CreateBitCast(result, resultType);
Fariborz Jahanian47b46292010-03-24 16:57:01 +00001724 }
John McCall824c2f52010-09-14 07:57:04 +00001725
1726 // Deactivate the 'operator delete' cleanup if we finished
1727 // initialization.
John McCallf4beacd2011-11-10 10:43:54 +00001728 if (operatorDeleteCleanup.isValid()) {
1729 DeactivateCleanupBlock(operatorDeleteCleanup, cleanupDominator);
1730 cleanupDominator->eraseFromParent();
1731 }
Sebastian Redl6047f072012-02-16 12:22:20 +00001732
John McCall7f416cc2015-09-08 08:05:57 +00001733 llvm::Value *resultPtr = result.getPointer();
John McCall75f94982011-03-07 03:12:35 +00001734 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001735 conditional.end(*this);
1736
John McCall75f94982011-03-07 03:12:35 +00001737 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
1738 EmitBlock(contBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001739
John McCall7f416cc2015-09-08 08:05:57 +00001740 llvm::PHINode *PHI = Builder.CreatePHI(resultPtr->getType(), 2);
1741 PHI->addIncoming(resultPtr, notNullBB);
1742 PHI->addIncoming(llvm::Constant::getNullValue(resultPtr->getType()),
John McCall75f94982011-03-07 03:12:35 +00001743 nullCheckBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001744
John McCall7f416cc2015-09-08 08:05:57 +00001745 resultPtr = PHI;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001746 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001747
John McCall7f416cc2015-09-08 08:05:57 +00001748 return resultPtr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001749}
1750
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001751void CodeGenFunction::EmitDeleteCall(const FunctionDecl *DeleteFD,
Richard Smithb2f0f052016-10-10 18:54:32 +00001752 llvm::Value *Ptr, QualType DeleteTy,
1753 llvm::Value *NumElements,
1754 CharUnits CookieSize) {
1755 assert((!NumElements && CookieSize.isZero()) ||
1756 DeleteFD->getOverloadedOperator() == OO_Array_Delete);
John McCall8ed55a52010-09-02 09:58:18 +00001757
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001758 const FunctionProtoType *DeleteFTy =
1759 DeleteFD->getType()->getAs<FunctionProtoType>();
1760
1761 CallArgList DeleteArgs;
1762
Richard Smith5b349582017-10-13 01:55:36 +00001763 auto Params = getUsualDeleteParams(DeleteFD);
Richard Smithb2f0f052016-10-10 18:54:32 +00001764 auto ParamTypeIt = DeleteFTy->param_type_begin();
1765
1766 // Pass the pointer itself.
1767 QualType ArgTy = *ParamTypeIt++;
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001768 llvm::Value *DeletePtr = Builder.CreateBitCast(Ptr, ConvertType(ArgTy));
Eli Friedman43dca6a2011-05-02 17:57:46 +00001769 DeleteArgs.add(RValue::get(DeletePtr), ArgTy);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001770
Richard Smith5b349582017-10-13 01:55:36 +00001771 // Pass the std::destroying_delete tag if present.
1772 if (Params.DestroyingDelete) {
1773 QualType DDTag = *ParamTypeIt++;
1774 // Just pass an 'undef'. We expect the tag type to be an empty struct.
1775 auto *V = llvm::UndefValue::get(getTypes().ConvertType(DDTag));
1776 DeleteArgs.add(RValue::get(V), DDTag);
1777 }
1778
Richard Smithb2f0f052016-10-10 18:54:32 +00001779 // Pass the size if the delete function has a size_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001780 if (Params.Size) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001781 QualType SizeType = *ParamTypeIt++;
1782 CharUnits DeleteTypeSize = getContext().getTypeSizeInChars(DeleteTy);
1783 llvm::Value *Size = llvm::ConstantInt::get(ConvertType(SizeType),
1784 DeleteTypeSize.getQuantity());
1785
1786 // For array new, multiply by the number of elements.
1787 if (NumElements)
1788 Size = Builder.CreateMul(Size, NumElements);
1789
1790 // If there is a cookie, add the cookie size.
1791 if (!CookieSize.isZero())
1792 Size = Builder.CreateAdd(
1793 Size, llvm::ConstantInt::get(SizeTy, CookieSize.getQuantity()));
1794
1795 DeleteArgs.add(RValue::get(Size), SizeType);
1796 }
1797
1798 // Pass the alignment if the delete function has an align_val_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001799 if (Params.Alignment) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001800 QualType AlignValType = *ParamTypeIt++;
1801 CharUnits DeleteTypeAlign = getContext().toCharUnitsFromBits(
1802 getContext().getTypeAlignIfKnown(DeleteTy));
1803 llvm::Value *Align = llvm::ConstantInt::get(ConvertType(AlignValType),
1804 DeleteTypeAlign.getQuantity());
1805 DeleteArgs.add(RValue::get(Align), AlignValType);
1806 }
1807
1808 assert(ParamTypeIt == DeleteFTy->param_type_end() &&
1809 "unknown parameter to usual delete function");
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001810
1811 // Emit the call to delete.
Richard Smith8d0dc312013-07-21 23:12:18 +00001812 EmitNewDeleteCall(*this, DeleteFD, DeleteFTy, DeleteArgs);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001813}
1814
John McCall8ed55a52010-09-02 09:58:18 +00001815namespace {
1816 /// Calls the given 'operator delete' on a single object.
David Blaikie7e70d682015-08-18 22:40:54 +00001817 struct CallObjectDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001818 llvm::Value *Ptr;
1819 const FunctionDecl *OperatorDelete;
1820 QualType ElementType;
1821
1822 CallObjectDelete(llvm::Value *Ptr,
1823 const FunctionDecl *OperatorDelete,
1824 QualType ElementType)
1825 : Ptr(Ptr), OperatorDelete(OperatorDelete), ElementType(ElementType) {}
1826
Craig Topper4f12f102014-03-12 06:41:41 +00001827 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall8ed55a52010-09-02 09:58:18 +00001828 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType);
1829 }
1830 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001831}
John McCall8ed55a52010-09-02 09:58:18 +00001832
David Majnemer0c0b6d92014-10-31 20:09:12 +00001833void
1834CodeGenFunction::pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1835 llvm::Value *CompletePtr,
1836 QualType ElementType) {
1837 EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup, CompletePtr,
1838 OperatorDelete, ElementType);
1839}
1840
Richard Smith5b349582017-10-13 01:55:36 +00001841/// Emit the code for deleting a single object with a destroying operator
1842/// delete. If the element type has a non-virtual destructor, Ptr has already
1843/// been converted to the type of the parameter of 'operator delete'. Otherwise
1844/// Ptr points to an object of the static type.
1845static void EmitDestroyingObjectDelete(CodeGenFunction &CGF,
1846 const CXXDeleteExpr *DE, Address Ptr,
1847 QualType ElementType) {
1848 auto *Dtor = ElementType->getAsCXXRecordDecl()->getDestructor();
1849 if (Dtor && Dtor->isVirtual())
1850 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1851 Dtor);
1852 else
1853 CGF.EmitDeleteCall(DE->getOperatorDelete(), Ptr.getPointer(), ElementType);
1854}
1855
John McCall8ed55a52010-09-02 09:58:18 +00001856/// Emit the code for deleting a single object.
1857static void EmitObjectDelete(CodeGenFunction &CGF,
David Majnemer08681372014-11-01 07:37:17 +00001858 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +00001859 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +00001860 QualType ElementType) {
Ivan Krasind98f5d72016-11-17 00:39:48 +00001861 // C++11 [expr.delete]p3:
1862 // If the static type of the object to be deleted is different from its
1863 // dynamic type, the static type shall be a base class of the dynamic type
1864 // of the object to be deleted and the static type shall have a virtual
1865 // destructor or the behavior is undefined.
1866 CGF.EmitTypeCheck(CodeGenFunction::TCK_MemberCall,
1867 DE->getExprLoc(), Ptr.getPointer(),
1868 ElementType);
1869
Richard Smith5b349582017-10-13 01:55:36 +00001870 const FunctionDecl *OperatorDelete = DE->getOperatorDelete();
1871 assert(!OperatorDelete->isDestroyingOperatorDelete());
1872
John McCall8ed55a52010-09-02 09:58:18 +00001873 // Find the destructor for the type, if applicable. If the
1874 // destructor is virtual, we'll just emit the vcall and return.
Craig Topper8a13c412014-05-21 05:09:00 +00001875 const CXXDestructorDecl *Dtor = nullptr;
John McCall8ed55a52010-09-02 09:58:18 +00001876 if (const RecordType *RT = ElementType->getAs<RecordType>()) {
1877 CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Eli Friedmanb23533d2011-08-02 18:05:30 +00001878 if (RD->hasDefinition() && !RD->hasTrivialDestructor()) {
John McCall8ed55a52010-09-02 09:58:18 +00001879 Dtor = RD->getDestructor();
1880
1881 if (Dtor->isVirtual()) {
Hiroshi Yamauchicb305902019-08-08 18:00:49 +00001882 bool UseVirtualCall = true;
1883 const Expr *Base = DE->getArgument();
1884 if (auto *DevirtualizedDtor =
1885 dyn_cast_or_null<const CXXDestructorDecl>(
1886 Dtor->getDevirtualizedMethod(
1887 Base, CGF.CGM.getLangOpts().AppleKext))) {
1888 UseVirtualCall = false;
1889 const CXXRecordDecl *DevirtualizedClass =
1890 DevirtualizedDtor->getParent();
1891 if (declaresSameEntity(getCXXRecord(Base), DevirtualizedClass)) {
1892 // Devirtualized to the class of the base type (the type of the
1893 // whole expression).
1894 Dtor = DevirtualizedDtor;
1895 } else {
1896 // Devirtualized to some other type. Would need to cast the this
1897 // pointer to that type but we don't have support for that yet, so
1898 // do a virtual call. FIXME: handle the case where it is
1899 // devirtualized to the derived type (the type of the inner
1900 // expression) as in EmitCXXMemberOrOperatorMemberCallExpr.
1901 UseVirtualCall = true;
1902 }
1903 }
1904 if (UseVirtualCall) {
1905 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1906 Dtor);
1907 return;
1908 }
John McCall8ed55a52010-09-02 09:58:18 +00001909 }
1910 }
1911 }
1912
1913 // Make sure that we call delete even if the dtor throws.
John McCalle4df6c82011-01-28 08:37:24 +00001914 // This doesn't have to a conditional cleanup because we're going
1915 // to pop it off in a second.
John McCall8ed55a52010-09-02 09:58:18 +00001916 CGF.EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup,
John McCall7f416cc2015-09-08 08:05:57 +00001917 Ptr.getPointer(),
1918 OperatorDelete, ElementType);
John McCall8ed55a52010-09-02 09:58:18 +00001919
1920 if (Dtor)
1921 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +00001922 /*ForVirtualBase=*/false,
1923 /*Delegating=*/false,
Marco Antognini88559632019-07-22 09:39:13 +00001924 Ptr, ElementType);
John McCall460ce582015-10-22 18:38:17 +00001925 else if (auto Lifetime = ElementType.getObjCLifetime()) {
1926 switch (Lifetime) {
John McCall31168b02011-06-15 23:02:42 +00001927 case Qualifiers::OCL_None:
1928 case Qualifiers::OCL_ExplicitNone:
1929 case Qualifiers::OCL_Autoreleasing:
1930 break;
John McCall8ed55a52010-09-02 09:58:18 +00001931
John McCall7f416cc2015-09-08 08:05:57 +00001932 case Qualifiers::OCL_Strong:
1933 CGF.EmitARCDestroyStrong(Ptr, ARCPreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001934 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00001935
John McCall31168b02011-06-15 23:02:42 +00001936 case Qualifiers::OCL_Weak:
1937 CGF.EmitARCDestroyWeak(Ptr);
1938 break;
1939 }
1940 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001941
John McCall8ed55a52010-09-02 09:58:18 +00001942 CGF.PopCleanupBlock();
1943}
1944
1945namespace {
1946 /// Calls the given 'operator delete' on an array of objects.
David Blaikie7e70d682015-08-18 22:40:54 +00001947 struct CallArrayDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001948 llvm::Value *Ptr;
1949 const FunctionDecl *OperatorDelete;
1950 llvm::Value *NumElements;
1951 QualType ElementType;
1952 CharUnits CookieSize;
1953
1954 CallArrayDelete(llvm::Value *Ptr,
1955 const FunctionDecl *OperatorDelete,
1956 llvm::Value *NumElements,
1957 QualType ElementType,
1958 CharUnits CookieSize)
1959 : Ptr(Ptr), OperatorDelete(OperatorDelete), NumElements(NumElements),
1960 ElementType(ElementType), CookieSize(CookieSize) {}
1961
Craig Topper4f12f102014-03-12 06:41:41 +00001962 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001963 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType, NumElements,
1964 CookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001965 }
1966 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001967}
John McCall8ed55a52010-09-02 09:58:18 +00001968
1969/// Emit the code for deleting an array of objects.
1970static void EmitArrayDelete(CodeGenFunction &CGF,
John McCall284c48f2011-01-27 09:37:56 +00001971 const CXXDeleteExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001972 Address deletedPtr,
John McCallca2c56f2011-07-13 01:41:37 +00001973 QualType elementType) {
Craig Topper8a13c412014-05-21 05:09:00 +00001974 llvm::Value *numElements = nullptr;
1975 llvm::Value *allocatedPtr = nullptr;
John McCallca2c56f2011-07-13 01:41:37 +00001976 CharUnits cookieSize;
1977 CGF.CGM.getCXXABI().ReadArrayCookie(CGF, deletedPtr, E, elementType,
1978 numElements, allocatedPtr, cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001979
John McCallca2c56f2011-07-13 01:41:37 +00001980 assert(allocatedPtr && "ReadArrayCookie didn't set allocated pointer");
John McCall8ed55a52010-09-02 09:58:18 +00001981
1982 // Make sure that we call delete even if one of the dtors throws.
John McCallca2c56f2011-07-13 01:41:37 +00001983 const FunctionDecl *operatorDelete = E->getOperatorDelete();
John McCall8ed55a52010-09-02 09:58:18 +00001984 CGF.EHStack.pushCleanup<CallArrayDelete>(NormalAndEHCleanup,
John McCallca2c56f2011-07-13 01:41:37 +00001985 allocatedPtr, operatorDelete,
1986 numElements, elementType,
1987 cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001988
John McCallca2c56f2011-07-13 01:41:37 +00001989 // Destroy the elements.
1990 if (QualType::DestructionKind dtorKind = elementType.isDestructedType()) {
1991 assert(numElements && "no element count for a type with a destructor!");
1992
John McCall7f416cc2015-09-08 08:05:57 +00001993 CharUnits elementSize = CGF.getContext().getTypeSizeInChars(elementType);
1994 CharUnits elementAlign =
1995 deletedPtr.getAlignment().alignmentOfArrayElement(elementSize);
1996
1997 llvm::Value *arrayBegin = deletedPtr.getPointer();
John McCallca2c56f2011-07-13 01:41:37 +00001998 llvm::Value *arrayEnd =
John McCall7f416cc2015-09-08 08:05:57 +00001999 CGF.Builder.CreateInBoundsGEP(arrayBegin, numElements, "delete.end");
John McCall97eab0a2011-07-13 08:09:46 +00002000
2001 // Note that it is legal to allocate a zero-length array, and we
2002 // can never fold the check away because the length should always
2003 // come from a cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002004 CGF.emitArrayDestroy(arrayBegin, arrayEnd, elementType, elementAlign,
John McCallca2c56f2011-07-13 01:41:37 +00002005 CGF.getDestroyer(dtorKind),
John McCall97eab0a2011-07-13 08:09:46 +00002006 /*checkZeroLength*/ true,
John McCallca2c56f2011-07-13 01:41:37 +00002007 CGF.needsEHCleanup(dtorKind));
John McCall8ed55a52010-09-02 09:58:18 +00002008 }
2009
John McCallca2c56f2011-07-13 01:41:37 +00002010 // Pop the cleanup block.
John McCall8ed55a52010-09-02 09:58:18 +00002011 CGF.PopCleanupBlock();
2012}
2013
Anders Carlssoncc52f652009-09-22 22:53:17 +00002014void CodeGenFunction::EmitCXXDeleteExpr(const CXXDeleteExpr *E) {
Douglas Gregorbb3e12f2009-09-29 18:16:17 +00002015 const Expr *Arg = E->getArgument();
John McCall7f416cc2015-09-08 08:05:57 +00002016 Address Ptr = EmitPointerWithAlignment(Arg);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002017
2018 // Null check the pointer.
2019 llvm::BasicBlock *DeleteNotNull = createBasicBlock("delete.notnull");
2020 llvm::BasicBlock *DeleteEnd = createBasicBlock("delete.end");
2021
John McCall7f416cc2015-09-08 08:05:57 +00002022 llvm::Value *IsNull = Builder.CreateIsNull(Ptr.getPointer(), "isnull");
Anders Carlssoncc52f652009-09-22 22:53:17 +00002023
2024 Builder.CreateCondBr(IsNull, DeleteEnd, DeleteNotNull);
2025 EmitBlock(DeleteNotNull);
Anders Carlssone828c362009-11-13 04:45:41 +00002026
Richard Smith5b349582017-10-13 01:55:36 +00002027 QualType DeleteTy = E->getDestroyedType();
2028
2029 // A destroying operator delete overrides the entire operation of the
2030 // delete expression.
2031 if (E->getOperatorDelete()->isDestroyingOperatorDelete()) {
2032 EmitDestroyingObjectDelete(*this, E, Ptr, DeleteTy);
2033 EmitBlock(DeleteEnd);
2034 return;
2035 }
2036
John McCall8ed55a52010-09-02 09:58:18 +00002037 // We might be deleting a pointer to array. If so, GEP down to the
2038 // first non-array element.
2039 // (this assumes that A(*)[3][7] is converted to [3 x [7 x %A]]*)
John McCall8ed55a52010-09-02 09:58:18 +00002040 if (DeleteTy->isConstantArrayType()) {
2041 llvm::Value *Zero = Builder.getInt32(0);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002042 SmallVector<llvm::Value*,8> GEP;
John McCall8ed55a52010-09-02 09:58:18 +00002043
2044 GEP.push_back(Zero); // point at the outermost array
2045
2046 // For each layer of array type we're pointing at:
2047 while (const ConstantArrayType *Arr
2048 = getContext().getAsConstantArrayType(DeleteTy)) {
2049 // 1. Unpeel the array type.
2050 DeleteTy = Arr->getElementType();
2051
2052 // 2. GEP to the first element of the array.
2053 GEP.push_back(Zero);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002054 }
John McCall8ed55a52010-09-02 09:58:18 +00002055
John McCall7f416cc2015-09-08 08:05:57 +00002056 Ptr = Address(Builder.CreateInBoundsGEP(Ptr.getPointer(), GEP, "del.first"),
2057 Ptr.getAlignment());
Anders Carlssoncc52f652009-09-22 22:53:17 +00002058 }
2059
John McCall7f416cc2015-09-08 08:05:57 +00002060 assert(ConvertTypeForMem(DeleteTy) == Ptr.getElementType());
John McCall8ed55a52010-09-02 09:58:18 +00002061
Reid Kleckner7270ef52015-03-19 17:03:58 +00002062 if (E->isArrayForm()) {
2063 EmitArrayDelete(*this, E, Ptr, DeleteTy);
2064 } else {
2065 EmitObjectDelete(*this, E, Ptr, DeleteTy);
2066 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00002067
Anders Carlssoncc52f652009-09-22 22:53:17 +00002068 EmitBlock(DeleteEnd);
2069}
Mike Stumpc9b231c2009-11-15 08:09:41 +00002070
David Majnemer1c3d95e2014-07-19 00:17:06 +00002071static bool isGLValueFromPointerDeref(const Expr *E) {
2072 E = E->IgnoreParens();
2073
2074 if (const auto *CE = dyn_cast<CastExpr>(E)) {
2075 if (!CE->getSubExpr()->isGLValue())
2076 return false;
2077 return isGLValueFromPointerDeref(CE->getSubExpr());
2078 }
2079
2080 if (const auto *OVE = dyn_cast<OpaqueValueExpr>(E))
2081 return isGLValueFromPointerDeref(OVE->getSourceExpr());
2082
2083 if (const auto *BO = dyn_cast<BinaryOperator>(E))
2084 if (BO->getOpcode() == BO_Comma)
2085 return isGLValueFromPointerDeref(BO->getRHS());
2086
2087 if (const auto *ACO = dyn_cast<AbstractConditionalOperator>(E))
2088 return isGLValueFromPointerDeref(ACO->getTrueExpr()) ||
2089 isGLValueFromPointerDeref(ACO->getFalseExpr());
2090
2091 // C++11 [expr.sub]p1:
2092 // The expression E1[E2] is identical (by definition) to *((E1)+(E2))
2093 if (isa<ArraySubscriptExpr>(E))
2094 return true;
2095
2096 if (const auto *UO = dyn_cast<UnaryOperator>(E))
2097 if (UO->getOpcode() == UO_Deref)
2098 return true;
2099
2100 return false;
2101}
2102
Warren Hunt747e3012014-06-18 21:15:55 +00002103static llvm::Value *EmitTypeidFromVTable(CodeGenFunction &CGF, const Expr *E,
Chris Lattner2192fe52011-07-18 04:24:23 +00002104 llvm::Type *StdTypeInfoPtrTy) {
Anders Carlsson940f02d2011-04-18 00:57:03 +00002105 // Get the vtable pointer.
Akira Hatanakaf139ae32019-12-03 15:17:01 -08002106 Address ThisPtr = CGF.EmitLValue(E).getAddress(CGF);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002107
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002108 QualType SrcRecordTy = E->getType();
2109
2110 // C++ [class.cdtor]p4:
2111 // If the operand of typeid refers to the object under construction or
2112 // destruction and the static type of the operand is neither the constructor
2113 // or destructor’s class nor one of its bases, the behavior is undefined.
2114 CGF.EmitTypeCheck(CodeGenFunction::TCK_DynamicOperation, E->getExprLoc(),
2115 ThisPtr.getPointer(), SrcRecordTy);
2116
Anders Carlsson940f02d2011-04-18 00:57:03 +00002117 // C++ [expr.typeid]p2:
2118 // If the glvalue expression is obtained by applying the unary * operator to
2119 // a pointer and the pointer is a null pointer value, the typeid expression
2120 // throws the std::bad_typeid exception.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002121 //
2122 // However, this paragraph's intent is not clear. We choose a very generous
2123 // interpretation which implores us to consider comma operators, conditional
2124 // operators, parentheses and other such constructs.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002125 if (CGF.CGM.getCXXABI().shouldTypeidBeNullChecked(
2126 isGLValueFromPointerDeref(E), SrcRecordTy)) {
David Majnemer1162d252014-06-22 19:05:33 +00002127 llvm::BasicBlock *BadTypeidBlock =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002128 CGF.createBasicBlock("typeid.bad_typeid");
David Majnemer1162d252014-06-22 19:05:33 +00002129 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("typeid.end");
Anders Carlsson940f02d2011-04-18 00:57:03 +00002130
John McCall7f416cc2015-09-08 08:05:57 +00002131 llvm::Value *IsNull = CGF.Builder.CreateIsNull(ThisPtr.getPointer());
David Majnemer1162d252014-06-22 19:05:33 +00002132 CGF.Builder.CreateCondBr(IsNull, BadTypeidBlock, EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002133
David Majnemer1162d252014-06-22 19:05:33 +00002134 CGF.EmitBlock(BadTypeidBlock);
2135 CGF.CGM.getCXXABI().EmitBadTypeidCall(CGF);
2136 CGF.EmitBlock(EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002137 }
2138
David Majnemer1162d252014-06-22 19:05:33 +00002139 return CGF.CGM.getCXXABI().EmitTypeid(CGF, SrcRecordTy, ThisPtr,
2140 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002141}
2142
John McCalle4df6c82011-01-28 08:37:24 +00002143llvm::Value *CodeGenFunction::EmitCXXTypeidExpr(const CXXTypeidExpr *E) {
Fangrui Song6907ce22018-07-30 19:24:48 +00002144 llvm::Type *StdTypeInfoPtrTy =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002145 ConvertType(E->getType())->getPointerTo();
Fangrui Song6907ce22018-07-30 19:24:48 +00002146
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002147 if (E->isTypeOperand()) {
David Majnemer143c55e2013-09-27 07:04:31 +00002148 llvm::Constant *TypeInfo =
2149 CGM.GetAddrOfRTTIDescriptor(E->getTypeOperand(getContext()));
Anders Carlsson940f02d2011-04-18 00:57:03 +00002150 return Builder.CreateBitCast(TypeInfo, StdTypeInfoPtrTy);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002151 }
Anders Carlsson0c633502011-04-11 14:13:40 +00002152
Anders Carlsson940f02d2011-04-18 00:57:03 +00002153 // C++ [expr.typeid]p2:
2154 // When typeid is applied to a glvalue expression whose type is a
2155 // polymorphic class type, the result refers to a std::type_info object
2156 // representing the type of the most derived object (that is, the dynamic
2157 // type) to which the glvalue refers.
Richard Smithef8bf432012-08-13 20:08:14 +00002158 if (E->isPotentiallyEvaluated())
Fangrui Song6907ce22018-07-30 19:24:48 +00002159 return EmitTypeidFromVTable(*this, E->getExprOperand(),
Richard Smithef8bf432012-08-13 20:08:14 +00002160 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002161
2162 QualType OperandTy = E->getExprOperand()->getType();
2163 return Builder.CreateBitCast(CGM.GetAddrOfRTTIDescriptor(OperandTy),
2164 StdTypeInfoPtrTy);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002165}
Mike Stump65511702009-11-16 06:50:58 +00002166
Anders Carlssonc1c99712011-04-11 01:45:29 +00002167static llvm::Value *EmitDynamicCastToNull(CodeGenFunction &CGF,
2168 QualType DestTy) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002169 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
Anders Carlssonc1c99712011-04-11 01:45:29 +00002170 if (DestTy->isPointerType())
2171 return llvm::Constant::getNullValue(DestLTy);
2172
2173 /// C++ [expr.dynamic.cast]p9:
2174 /// A failed cast to reference type throws std::bad_cast
David Majnemer1162d252014-06-22 19:05:33 +00002175 if (!CGF.CGM.getCXXABI().EmitBadCastCall(CGF))
2176 return nullptr;
Anders Carlssonc1c99712011-04-11 01:45:29 +00002177
2178 CGF.EmitBlock(CGF.createBasicBlock("dynamic_cast.end"));
2179 return llvm::UndefValue::get(DestLTy);
2180}
2181
John McCall7f416cc2015-09-08 08:05:57 +00002182llvm::Value *CodeGenFunction::EmitDynamicCast(Address ThisAddr,
Mike Stump65511702009-11-16 06:50:58 +00002183 const CXXDynamicCastExpr *DCE) {
Alexey Bataev2bf9b4c2015-10-20 04:24:12 +00002184 CGM.EmitExplicitCastExprType(DCE, this);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002185 QualType DestTy = DCE->getTypeAsWritten();
Anders Carlsson882d7902011-04-11 00:46:40 +00002186
Anders Carlssonc1c99712011-04-11 01:45:29 +00002187 QualType SrcTy = DCE->getSubExpr()->getType();
2188
David Majnemer1162d252014-06-22 19:05:33 +00002189 // C++ [expr.dynamic.cast]p7:
2190 // If T is "pointer to cv void," then the result is a pointer to the most
2191 // derived object pointed to by v.
2192 const PointerType *DestPTy = DestTy->getAs<PointerType>();
2193
2194 bool isDynamicCastToVoid;
2195 QualType SrcRecordTy;
2196 QualType DestRecordTy;
2197 if (DestPTy) {
2198 isDynamicCastToVoid = DestPTy->getPointeeType()->isVoidType();
2199 SrcRecordTy = SrcTy->castAs<PointerType>()->getPointeeType();
2200 DestRecordTy = DestPTy->getPointeeType();
2201 } else {
2202 isDynamicCastToVoid = false;
2203 SrcRecordTy = SrcTy;
2204 DestRecordTy = DestTy->castAs<ReferenceType>()->getPointeeType();
2205 }
2206
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002207 // C++ [class.cdtor]p5:
2208 // If the operand of the dynamic_cast refers to the object under
2209 // construction or destruction and the static type of the operand is not a
2210 // pointer to or object of the constructor or destructor’s own class or one
2211 // of its bases, the dynamic_cast results in undefined behavior.
2212 EmitTypeCheck(TCK_DynamicOperation, DCE->getExprLoc(), ThisAddr.getPointer(),
2213 SrcRecordTy);
2214
2215 if (DCE->isAlwaysNull())
2216 if (llvm::Value *T = EmitDynamicCastToNull(*this, DestTy))
2217 return T;
2218
David Majnemer1162d252014-06-22 19:05:33 +00002219 assert(SrcRecordTy->isRecordType() && "source type must be a record type!");
2220
Fangrui Song6907ce22018-07-30 19:24:48 +00002221 // C++ [expr.dynamic.cast]p4:
Anders Carlsson882d7902011-04-11 00:46:40 +00002222 // If the value of v is a null pointer value in the pointer case, the result
2223 // is the null pointer value of type T.
David Majnemer1162d252014-06-22 19:05:33 +00002224 bool ShouldNullCheckSrcValue =
2225 CGM.getCXXABI().shouldDynamicCastCallBeNullChecked(SrcTy->isPointerType(),
2226 SrcRecordTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002227
2228 llvm::BasicBlock *CastNull = nullptr;
2229 llvm::BasicBlock *CastNotNull = nullptr;
Anders Carlsson882d7902011-04-11 00:46:40 +00002230 llvm::BasicBlock *CastEnd = createBasicBlock("dynamic_cast.end");
Fangrui Song6907ce22018-07-30 19:24:48 +00002231
Anders Carlsson882d7902011-04-11 00:46:40 +00002232 if (ShouldNullCheckSrcValue) {
2233 CastNull = createBasicBlock("dynamic_cast.null");
2234 CastNotNull = createBasicBlock("dynamic_cast.notnull");
2235
John McCall7f416cc2015-09-08 08:05:57 +00002236 llvm::Value *IsNull = Builder.CreateIsNull(ThisAddr.getPointer());
Anders Carlsson882d7902011-04-11 00:46:40 +00002237 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
2238 EmitBlock(CastNotNull);
Mike Stump65511702009-11-16 06:50:58 +00002239 }
2240
John McCall7f416cc2015-09-08 08:05:57 +00002241 llvm::Value *Value;
David Majnemer1162d252014-06-22 19:05:33 +00002242 if (isDynamicCastToVoid) {
John McCall7f416cc2015-09-08 08:05:57 +00002243 Value = CGM.getCXXABI().EmitDynamicCastToVoid(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002244 DestTy);
2245 } else {
2246 assert(DestRecordTy->isRecordType() &&
2247 "destination type must be a record type!");
John McCall7f416cc2015-09-08 08:05:57 +00002248 Value = CGM.getCXXABI().EmitDynamicCastCall(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002249 DestTy, DestRecordTy, CastEnd);
David Majnemer67528ea2015-11-23 03:01:14 +00002250 CastNotNull = Builder.GetInsertBlock();
David Majnemer1162d252014-06-22 19:05:33 +00002251 }
Anders Carlsson882d7902011-04-11 00:46:40 +00002252
2253 if (ShouldNullCheckSrcValue) {
2254 EmitBranch(CastEnd);
2255
2256 EmitBlock(CastNull);
2257 EmitBranch(CastEnd);
2258 }
2259
2260 EmitBlock(CastEnd);
2261
2262 if (ShouldNullCheckSrcValue) {
2263 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
2264 PHI->addIncoming(Value, CastNotNull);
2265 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
2266
2267 Value = PHI;
2268 }
2269
2270 return Value;
Mike Stump65511702009-11-16 06:50:58 +00002271}