blob: 9057d16059434ee40ca2115f778a8d531f49e16c [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);
136 BaseValue = BaseLV.getAddress();
137 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(
274 *this, Ctor, This.getPointer(), /*ImplicitParam=*/nullptr,
275 /*ImplicitParamTy=*/QualType(), CE, Args, nullptr);
276
277 EmitCXXConstructorCall(Ctor, Ctor_Complete, /*ForVirtualBase=*/false,
278 /*Delegating=*/false, This.getAddress(), Args,
279 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());
John McCall7f416cc2015-09-08 08:05:57 +0000296 return RValue::get(This.getPointer());
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 }
James Y Knightab4f7f12019-02-06 00:06:03 +0000331 EmitTypeCheck(CodeGenFunction::TCK_MemberCall, CallLoc, This.getPointer(),
332 C.getRecordType(CalleeDecl->getParent()),
333 /*Alignment=*/CharUnits::Zero(), SkippedChecks);
Ivan Krasind98f5d72016-11-17 00:39:48 +0000334
Anders Carlsson27da15b2010-01-01 20:29:01 +0000335 // C++ [class.virtual]p12:
336 // Explicit qualification with the scope operator (5.1) suppresses the
337 // virtual call mechanism.
338 //
339 // We also don't emit a virtual call if the base expression has a record type
340 // because then we know what the type is.
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000341 bool UseVirtualCall = CanUseVirtualCall && !DevirtualizedMethod;
Fangrui Song6907ce22018-07-30 19:24:48 +0000342
James Y Knightb92d2902019-02-05 16:05:50 +0000343 if (const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl)) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000344 assert(CE->arg_begin() == CE->arg_end() &&
345 "Destructor shouldn't have explicit parameters");
346 assert(ReturnValue.isNull() && "Destructor shouldn't have return value");
John McCall0d635f52010-09-03 01:26:39 +0000347 if (UseVirtualCall) {
Nico Weberaad4af62014-12-03 01:21:41 +0000348 CGM.getCXXABI().EmitVirtualDestructorCall(
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000349 *this, Dtor, Dtor_Complete, This.getAddress(),
350 cast<CXXMemberCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000351 } else {
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000352 GlobalDecl GD(Dtor, Dtor_Complete);
John McCallb92ab1a2016-10-26 23:46:34 +0000353 CGCallee Callee;
James Y Knightb92d2902019-02-05 16:05:50 +0000354 if (getLangOpts().AppleKext && Dtor->isVirtual() && HasQualifier)
355 Callee = BuildAppleKextVirtualCall(Dtor, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000356 else if (!DevirtualizedMethod)
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000357 Callee =
358 CGCallee::forDirect(CGM.getAddrOfCXXStructor(GD, FInfo, Ty), GD);
Rafael Espindola49e860b2012-06-26 17:45:31 +0000359 else {
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000360 Callee = CGCallee::forDirect(CGM.GetAddrOfFunction(GD, Ty), GD);
Rafael Espindola49e860b2012-06-26 17:45:31 +0000361 }
James Y Knightb92d2902019-02-05 16:05:50 +0000362
Marco Antognini88559632019-07-22 09:39:13 +0000363 QualType ThisTy =
364 IsArrow ? Base->getType()->getPointeeType() : Base->getType();
365 EmitCXXDestructorCall(GD, Callee, This.getPointer(), ThisTy,
James Y Knightb92d2902019-02-05 16:05:50 +0000366 /*ImplicitParam=*/nullptr,
Peter Collingbourned1c5b282019-03-22 23:05:10 +0000367 /*ImplicitParamTy=*/QualType(), nullptr);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000368 }
Craig Topper8a13c412014-05-21 05:09:00 +0000369 return RValue::get(nullptr);
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000370 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000371
James Y Knightb92d2902019-02-05 16:05:50 +0000372 // FIXME: Uses of 'MD' past this point need to be audited. We may need to use
373 // 'CalleeDecl' instead.
374
John McCallb92ab1a2016-10-26 23:46:34 +0000375 CGCallee Callee;
James Y Knightab4f7f12019-02-06 00:06:03 +0000376 if (UseVirtualCall) {
Peter Collingbourneea211002018-02-05 23:09:13 +0000377 Callee = CGCallee::forVirtual(CE, MD, This.getAddress(), Ty);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000378 } else {
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000379 if (SanOpts.has(SanitizerKind::CFINVCall) &&
380 MD->getParent()->isDynamicClass()) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000381 llvm::Value *VTable;
382 const CXXRecordDecl *RD;
383 std::tie(VTable, RD) =
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000384 CGM.getCXXABI().LoadVTablePtr(*this, This.getAddress(),
385 MD->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(
404 *this, CalleeDecl, This.getAddress(), UseVirtualCall);
405 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(
409 CalleeDecl, Callee, ReturnValue, This.getPointer(),
410 /*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
421 const MemberPointerType *MPT =
John McCall0009fcc2011-04-26 20:42:42 +0000422 MemFnExpr->getType()->castAs<MemberPointerType>();
John McCall475999d2010-08-22 00:05:51 +0000423
Fangrui Song6907ce22018-07-30 19:24:48 +0000424 const FunctionProtoType *FPT =
John McCall0009fcc2011-04-26 20:42:42 +0000425 MPT->getPointeeType()->castAs<FunctionProtoType>();
Fangrui Song6907ce22018-07-30 19:24:48 +0000426 const CXXRecordDecl *RD =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000427 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
428
Anders Carlsson27da15b2010-01-01 20:29:01 +0000429 // Emit the 'this' pointer.
John McCall7f416cc2015-09-08 08:05:57 +0000430 Address This = Address::invalid();
John McCalle3027922010-08-25 11:45:40 +0000431 if (BO->getOpcode() == BO_PtrMemI)
John McCall7f416cc2015-09-08 08:05:57 +0000432 This = EmitPointerWithAlignment(BaseExpr);
Fangrui Song6907ce22018-07-30 19:24:48 +0000433 else
Anders Carlsson27da15b2010-01-01 20:29:01 +0000434 This = EmitLValue(BaseExpr).getAddress();
Anders Carlsson27da15b2010-01-01 20:29:01 +0000435
John McCall7f416cc2015-09-08 08:05:57 +0000436 EmitTypeCheck(TCK_MemberCall, E->getExprLoc(), This.getPointer(),
Richard Smithe30752c2012-10-09 19:52:38 +0000437 QualType(MPT->getClass(), 0));
Richard Smith69d0d262012-08-24 00:54:33 +0000438
Richard Smithbde62d72016-09-26 23:56:57 +0000439 // Get the member function pointer.
440 llvm::Value *MemFnPtr = EmitScalarExpr(MemFnExpr);
441
John McCall475999d2010-08-22 00:05:51 +0000442 // Ask the ABI to load the callee. Note that This is modified.
John McCall7f416cc2015-09-08 08:05:57 +0000443 llvm::Value *ThisPtrForCall = nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +0000444 CGCallee Callee =
John McCall7f416cc2015-09-08 08:05:57 +0000445 CGM.getCXXABI().EmitLoadOfMemberFunctionPointer(*this, BO, This,
446 ThisPtrForCall, MemFnPtr, MPT);
Fangrui Song6907ce22018-07-30 19:24:48 +0000447
Anders Carlsson27da15b2010-01-01 20:29:01 +0000448 CallArgList Args;
449
Fangrui Song6907ce22018-07-30 19:24:48 +0000450 QualType ThisType =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000451 getContext().getPointerType(getContext().getTagDeclType(RD));
452
453 // Push the this ptr.
John McCall7f416cc2015-09-08 08:05:57 +0000454 Args.add(RValue::get(ThisPtrForCall), ThisType);
John McCall8dda7b22012-07-07 06:41:13 +0000455
James Y Knight916db652019-02-02 01:48:23 +0000456 RequiredArgs required = RequiredArgs::forPrototypePlus(FPT, 1);
George Burgess IV419996c2016-06-16 23:06:04 +0000457
Anders Carlsson27da15b2010-01-01 20:29:01 +0000458 // And the rest of the call args
George Burgess IV419996c2016-06-16 23:06:04 +0000459 EmitCallArgs(Args, FPT, E->arguments());
George Burgess IVd0a9e802017-02-23 22:07:35 +0000460 return EmitCall(CGM.getTypes().arrangeCXXMethodCall(Args, FPT, required,
461 /*PrefixSize=*/0),
Vedant Kumar09b5bfd2017-12-21 00:10:25 +0000462 Callee, ReturnValue, Args, nullptr, E->getExprLoc());
Anders Carlsson27da15b2010-01-01 20:29:01 +0000463}
464
465RValue
466CodeGenFunction::EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
467 const CXXMethodDecl *MD,
468 ReturnValueSlot ReturnValue) {
469 assert(MD->isInstance() &&
470 "Trying to emit a member call expr on a static method!");
Nico Weberaad4af62014-12-03 01:21:41 +0000471 return EmitCXXMemberOrOperatorMemberCallExpr(
472 E, MD, ReturnValue, /*HasQualifier=*/false, /*Qualifier=*/nullptr,
473 /*IsArrow=*/false, E->getArg(0));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000474}
475
Peter Collingbournefe883422011-10-06 18:29:37 +0000476RValue CodeGenFunction::EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
477 ReturnValueSlot ReturnValue) {
478 return CGM.getCUDARuntime().EmitCUDAKernelCallExpr(*this, E, ReturnValue);
479}
480
Eli Friedmanfde961d2011-10-14 02:27:24 +0000481static void EmitNullBaseClassInitialization(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000482 Address DestPtr,
Eli Friedmanfde961d2011-10-14 02:27:24 +0000483 const CXXRecordDecl *Base) {
484 if (Base->isEmpty())
485 return;
486
John McCall7f416cc2015-09-08 08:05:57 +0000487 DestPtr = CGF.Builder.CreateElementBitCast(DestPtr, CGF.Int8Ty);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000488
489 const ASTRecordLayout &Layout = CGF.getContext().getASTRecordLayout(Base);
David Majnemer8671c6e2015-11-02 09:01:44 +0000490 CharUnits NVSize = Layout.getNonVirtualSize();
491
492 // We cannot simply zero-initialize the entire base sub-object if vbptrs are
493 // present, they are initialized by the most derived class before calling the
494 // constructor.
495 SmallVector<std::pair<CharUnits, CharUnits>, 1> Stores;
496 Stores.emplace_back(CharUnits::Zero(), NVSize);
497
498 // Each store is split by the existence of a vbptr.
499 CharUnits VBPtrWidth = CGF.getPointerSize();
500 std::vector<CharUnits> VBPtrOffsets =
501 CGF.CGM.getCXXABI().getVBPtrOffsets(Base);
502 for (CharUnits VBPtrOffset : VBPtrOffsets) {
David Majnemer7f980d82016-05-12 03:51:52 +0000503 // Stop before we hit any virtual base pointers located in virtual bases.
504 if (VBPtrOffset >= NVSize)
505 break;
David Majnemer8671c6e2015-11-02 09:01:44 +0000506 std::pair<CharUnits, CharUnits> LastStore = Stores.pop_back_val();
507 CharUnits LastStoreOffset = LastStore.first;
508 CharUnits LastStoreSize = LastStore.second;
509
510 CharUnits SplitBeforeOffset = LastStoreOffset;
511 CharUnits SplitBeforeSize = VBPtrOffset - SplitBeforeOffset;
512 assert(!SplitBeforeSize.isNegative() && "negative store size!");
513 if (!SplitBeforeSize.isZero())
514 Stores.emplace_back(SplitBeforeOffset, SplitBeforeSize);
515
516 CharUnits SplitAfterOffset = VBPtrOffset + VBPtrWidth;
517 CharUnits SplitAfterSize = LastStoreSize - SplitAfterOffset;
518 assert(!SplitAfterSize.isNegative() && "negative store size!");
519 if (!SplitAfterSize.isZero())
520 Stores.emplace_back(SplitAfterOffset, SplitAfterSize);
521 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000522
523 // If the type contains a pointer to data member we can't memset it to zero.
524 // Instead, create a null constant and copy it to the destination.
525 // TODO: there are other patterns besides zero that we can usefully memset,
526 // like -1, which happens to be the pattern used by member-pointers.
527 // TODO: isZeroInitializable can be over-conservative in the case where a
528 // virtual base contains a member pointer.
David Majnemer8671c6e2015-11-02 09:01:44 +0000529 llvm::Constant *NullConstantForBase = CGF.CGM.EmitNullConstantForBase(Base);
530 if (!NullConstantForBase->isNullValue()) {
531 llvm::GlobalVariable *NullVariable = new llvm::GlobalVariable(
532 CGF.CGM.getModule(), NullConstantForBase->getType(),
533 /*isConstant=*/true, llvm::GlobalVariable::PrivateLinkage,
534 NullConstantForBase, Twine());
John McCall7f416cc2015-09-08 08:05:57 +0000535
536 CharUnits Align = std::max(Layout.getNonVirtualAlignment(),
537 DestPtr.getAlignment());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000538 NullVariable->setAlignment(Align.getQuantity());
John McCall7f416cc2015-09-08 08:05:57 +0000539
540 Address SrcPtr = Address(CGF.EmitCastToVoidPtr(NullVariable), Align);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000541
542 // Get and call the appropriate llvm.memcpy overload.
David Majnemer8671c6e2015-11-02 09:01:44 +0000543 for (std::pair<CharUnits, CharUnits> Store : Stores) {
544 CharUnits StoreOffset = Store.first;
545 CharUnits StoreSize = Store.second;
546 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
547 CGF.Builder.CreateMemCpy(
548 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
549 CGF.Builder.CreateConstInBoundsByteGEP(SrcPtr, StoreOffset),
550 StoreSizeVal);
551 }
552
Eli Friedmanfde961d2011-10-14 02:27:24 +0000553 // Otherwise, just memset the whole thing to zero. This is legal
554 // because in LLVM, all default initializers (other than the ones we just
555 // handled above) are guaranteed to have a bit pattern of all zeros.
David Majnemer8671c6e2015-11-02 09:01:44 +0000556 } else {
557 for (std::pair<CharUnits, CharUnits> Store : Stores) {
558 CharUnits StoreOffset = Store.first;
559 CharUnits StoreSize = Store.second;
560 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
561 CGF.Builder.CreateMemSet(
562 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
563 CGF.Builder.getInt8(0), StoreSizeVal);
564 }
565 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000566}
567
Anders Carlsson27da15b2010-01-01 20:29:01 +0000568void
John McCall7a626f62010-09-15 10:14:12 +0000569CodeGenFunction::EmitCXXConstructExpr(const CXXConstructExpr *E,
570 AggValueSlot Dest) {
571 assert(!Dest.isIgnored() && "Must have a destination!");
Anders Carlsson27da15b2010-01-01 20:29:01 +0000572 const CXXConstructorDecl *CD = E->getConstructor();
Fangrui Song6907ce22018-07-30 19:24:48 +0000573
Douglas Gregor630c76e2010-08-22 16:15:35 +0000574 // If we require zero initialization before (or instead of) calling the
575 // constructor, as can be the case with a non-user-provided default
Argyrios Kyrtzidis03535262011-04-28 22:57:55 +0000576 // constructor, emit the zero initialization now, unless destination is
577 // already zeroed.
Eli Friedmanfde961d2011-10-14 02:27:24 +0000578 if (E->requiresZeroInitialization() && !Dest.isZeroed()) {
579 switch (E->getConstructionKind()) {
580 case CXXConstructExpr::CK_Delegating:
Eli Friedmanfde961d2011-10-14 02:27:24 +0000581 case CXXConstructExpr::CK_Complete:
John McCall7f416cc2015-09-08 08:05:57 +0000582 EmitNullInitialization(Dest.getAddress(), E->getType());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000583 break;
584 case CXXConstructExpr::CK_VirtualBase:
585 case CXXConstructExpr::CK_NonVirtualBase:
John McCall7f416cc2015-09-08 08:05:57 +0000586 EmitNullBaseClassInitialization(*this, Dest.getAddress(),
587 CD->getParent());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000588 break;
589 }
590 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000591
Douglas Gregor630c76e2010-08-22 16:15:35 +0000592 // If this is a call to a trivial default constructor, do nothing.
593 if (CD->isTrivial() && CD->isDefaultConstructor())
594 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000595
John McCall8ea46b62010-09-18 00:58:34 +0000596 // Elide the constructor if we're constructing from a temporary.
597 // The temporary check is required because Sema sets this on NRVO
598 // returns.
Richard Smith9c6890a2012-11-01 22:30:59 +0000599 if (getLangOpts().ElideConstructors && E->isElidable()) {
John McCall8ea46b62010-09-18 00:58:34 +0000600 assert(getContext().hasSameUnqualifiedType(E->getType(),
601 E->getArg(0)->getType()));
John McCall7a626f62010-09-15 10:14:12 +0000602 if (E->getArg(0)->isTemporaryObject(getContext(), CD->getParent())) {
603 EmitAggExpr(E->getArg(0), Dest);
Douglas Gregor222cf0e2010-05-15 00:13:29 +0000604 return;
605 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000606 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000607
Alexey Bataeve7545b32016-04-29 09:39:50 +0000608 if (const ArrayType *arrayType
609 = getContext().getAsArrayType(E->getType())) {
Serge Pavlov37605182018-07-28 15:33:03 +0000610 EmitCXXAggrConstructorCall(CD, arrayType, Dest.getAddress(), E,
611 Dest.isSanitizerChecked());
John McCallf677a8e2011-07-13 06:10:41 +0000612 } else {
Cameron Esfahanibceca202011-05-06 21:28:42 +0000613 CXXCtorType Type = Ctor_Complete;
Alexis Hunt271c3682011-05-03 20:19:28 +0000614 bool ForVirtualBase = false;
Douglas Gregor61535002013-01-31 05:50:40 +0000615 bool Delegating = false;
Fangrui Song6907ce22018-07-30 19:24:48 +0000616
Alexis Hunt271c3682011-05-03 20:19:28 +0000617 switch (E->getConstructionKind()) {
618 case CXXConstructExpr::CK_Delegating:
Alexis Hunt61bc1732011-05-01 07:04:31 +0000619 // We should be emitting a constructor; GlobalDecl will assert this
620 Type = CurGD.getCtorType();
Douglas Gregor61535002013-01-31 05:50:40 +0000621 Delegating = true;
Alexis Hunt271c3682011-05-03 20:19:28 +0000622 break;
Alexis Hunt61bc1732011-05-01 07:04:31 +0000623
Alexis Hunt271c3682011-05-03 20:19:28 +0000624 case CXXConstructExpr::CK_Complete:
625 Type = Ctor_Complete;
626 break;
627
628 case CXXConstructExpr::CK_VirtualBase:
629 ForVirtualBase = true;
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +0000630 LLVM_FALLTHROUGH;
Alexis Hunt271c3682011-05-03 20:19:28 +0000631
632 case CXXConstructExpr::CK_NonVirtualBase:
633 Type = Ctor_Base;
Anastasia Stulova094c7262019-04-04 10:48:36 +0000634 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000635
Anastasia Stulova094c7262019-04-04 10:48:36 +0000636 // Call the constructor.
637 EmitCXXConstructorCall(CD, Type, ForVirtualBase, Delegating, Dest, E);
Anders Carlssone11f9ce2010-05-02 23:20:53 +0000638 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000639}
640
John McCall7f416cc2015-09-08 08:05:57 +0000641void CodeGenFunction::EmitSynthesizedCXXCopyCtor(Address Dest, Address Src,
642 const Expr *Exp) {
John McCall5d413782010-12-06 08:20:24 +0000643 if (const ExprWithCleanups *E = dyn_cast<ExprWithCleanups>(Exp))
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000644 Exp = E->getSubExpr();
Fangrui Song6907ce22018-07-30 19:24:48 +0000645 assert(isa<CXXConstructExpr>(Exp) &&
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000646 "EmitSynthesizedCXXCopyCtor - unknown copy ctor expr");
647 const CXXConstructExpr* E = cast<CXXConstructExpr>(Exp);
648 const CXXConstructorDecl *CD = E->getConstructor();
649 RunCleanupsScope Scope(*this);
Fangrui Song6907ce22018-07-30 19:24:48 +0000650
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000651 // If we require zero initialization before (or instead of) calling the
652 // constructor, as can be the case with a non-user-provided default
653 // constructor, emit the zero initialization now.
654 // FIXME. Do I still need this for a copy ctor synthesis?
655 if (E->requiresZeroInitialization())
656 EmitNullInitialization(Dest, E->getType());
Fangrui Song6907ce22018-07-30 19:24:48 +0000657
Chandler Carruth99da11c2010-11-15 13:54:43 +0000658 assert(!getContext().getAsConstantArrayType(E->getType())
659 && "EmitSynthesizedCXXCopyCtor - Copied-in Array");
Alexey Samsonov525bf652014-08-25 21:58:56 +0000660 EmitSynthesizedCXXCopyCtorCall(CD, Dest, Src, E);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000661}
662
John McCall8ed55a52010-09-02 09:58:18 +0000663static CharUnits CalculateCookiePadding(CodeGenFunction &CGF,
664 const CXXNewExpr *E) {
Anders Carlsson21122cf2009-12-13 20:04:38 +0000665 if (!E->isArray())
Ken Dyck3eb55cf2010-01-26 19:44:24 +0000666 return CharUnits::Zero();
Anders Carlsson21122cf2009-12-13 20:04:38 +0000667
John McCall7ec4b432011-05-16 01:05:12 +0000668 // No cookie is required if the operator new[] being used is the
669 // reserved placement operator new[].
670 if (E->getOperatorNew()->isReservedGlobalPlacementOperator())
John McCallaa4149a2010-08-23 01:17:59 +0000671 return CharUnits::Zero();
672
John McCall284c48f2011-01-27 09:37:56 +0000673 return CGF.CGM.getCXXABI().GetArrayCookieSize(E);
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000674}
675
John McCall036f2f62011-05-15 07:14:44 +0000676static llvm::Value *EmitCXXNewAllocSize(CodeGenFunction &CGF,
677 const CXXNewExpr *e,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000678 unsigned minElements,
John McCall036f2f62011-05-15 07:14:44 +0000679 llvm::Value *&numElements,
680 llvm::Value *&sizeWithoutCookie) {
681 QualType type = e->getAllocatedType();
John McCall8ed55a52010-09-02 09:58:18 +0000682
John McCall036f2f62011-05-15 07:14:44 +0000683 if (!e->isArray()) {
684 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
685 sizeWithoutCookie
686 = llvm::ConstantInt::get(CGF.SizeTy, typeSize.getQuantity());
687 return sizeWithoutCookie;
Douglas Gregor05fc5be2010-07-21 01:10:17 +0000688 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000689
John McCall036f2f62011-05-15 07:14:44 +0000690 // The width of size_t.
691 unsigned sizeWidth = CGF.SizeTy->getBitWidth();
692
John McCall8ed55a52010-09-02 09:58:18 +0000693 // Figure out the cookie size.
John McCall036f2f62011-05-15 07:14:44 +0000694 llvm::APInt cookieSize(sizeWidth,
695 CalculateCookiePadding(CGF, e).getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +0000696
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000697 // Emit the array size expression.
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000698 // We multiply the size of all dimensions for NumElements.
699 // e.g for 'int[2][3]', ElemType is 'int' and NumElements is 6.
John McCallde0fe072017-08-15 21:42:52 +0000700 numElements =
Richard Smithb9fb1212019-05-06 03:47:15 +0000701 ConstantEmitter(CGF).tryEmitAbstract(*e->getArraySize(), e->getType());
Nick Lewycky07527622017-02-13 23:49:55 +0000702 if (!numElements)
Richard Smithb9fb1212019-05-06 03:47:15 +0000703 numElements = CGF.EmitScalarExpr(*e->getArraySize());
John McCall036f2f62011-05-15 07:14:44 +0000704 assert(isa<llvm::IntegerType>(numElements->getType()));
John McCall8ed55a52010-09-02 09:58:18 +0000705
John McCall036f2f62011-05-15 07:14:44 +0000706 // The number of elements can be have an arbitrary integer type;
707 // essentially, we need to multiply it by a constant factor, add a
708 // cookie size, and verify that the result is representable as a
709 // size_t. That's just a gloss, though, and it's wrong in one
710 // important way: if the count is negative, it's an error even if
711 // the cookie size would bring the total size >= 0.
Fangrui Song6907ce22018-07-30 19:24:48 +0000712 bool isSigned
Richard Smithb9fb1212019-05-06 03:47:15 +0000713 = (*e->getArraySize())->getType()->isSignedIntegerOrEnumerationType();
Chris Lattner2192fe52011-07-18 04:24:23 +0000714 llvm::IntegerType *numElementsType
John McCall036f2f62011-05-15 07:14:44 +0000715 = cast<llvm::IntegerType>(numElements->getType());
716 unsigned numElementsWidth = numElementsType->getBitWidth();
717
718 // Compute the constant factor.
719 llvm::APInt arraySizeMultiplier(sizeWidth, 1);
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000720 while (const ConstantArrayType *CAT
John McCall036f2f62011-05-15 07:14:44 +0000721 = CGF.getContext().getAsConstantArrayType(type)) {
722 type = CAT->getElementType();
723 arraySizeMultiplier *= CAT->getSize();
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000724 }
725
John McCall036f2f62011-05-15 07:14:44 +0000726 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
727 llvm::APInt typeSizeMultiplier(sizeWidth, typeSize.getQuantity());
728 typeSizeMultiplier *= arraySizeMultiplier;
729
730 // This will be a size_t.
731 llvm::Value *size;
Fangrui Song6907ce22018-07-30 19:24:48 +0000732
Chris Lattner32ac5832010-07-20 21:55:52 +0000733 // If someone is doing 'new int[42]' there is no need to do a dynamic check.
734 // Don't bloat the -O0 code.
John McCall036f2f62011-05-15 07:14:44 +0000735 if (llvm::ConstantInt *numElementsC =
736 dyn_cast<llvm::ConstantInt>(numElements)) {
737 const llvm::APInt &count = numElementsC->getValue();
John McCall8ed55a52010-09-02 09:58:18 +0000738
John McCall036f2f62011-05-15 07:14:44 +0000739 bool hasAnyOverflow = false;
John McCall8ed55a52010-09-02 09:58:18 +0000740
John McCall036f2f62011-05-15 07:14:44 +0000741 // If 'count' was a negative number, it's an overflow.
742 if (isSigned && count.isNegative())
743 hasAnyOverflow = true;
John McCall8ed55a52010-09-02 09:58:18 +0000744
John McCall036f2f62011-05-15 07:14:44 +0000745 // We want to do all this arithmetic in size_t. If numElements is
746 // wider than that, check whether it's already too big, and if so,
747 // overflow.
748 else if (numElementsWidth > sizeWidth &&
749 numElementsWidth - sizeWidth > count.countLeadingZeros())
750 hasAnyOverflow = true;
751
752 // Okay, compute a count at the right width.
753 llvm::APInt adjustedCount = count.zextOrTrunc(sizeWidth);
754
Sebastian Redlf862eb62012-02-22 17:37:52 +0000755 // If there is a brace-initializer, we cannot allocate fewer elements than
756 // there are initializers. If we do, that's treated like an overflow.
757 if (adjustedCount.ult(minElements))
758 hasAnyOverflow = true;
759
John McCall036f2f62011-05-15 07:14:44 +0000760 // Scale numElements by that. This might overflow, but we don't
761 // care because it only overflows if allocationSize does, too, and
762 // if that overflows then we shouldn't use this.
763 numElements = llvm::ConstantInt::get(CGF.SizeTy,
764 adjustedCount * arraySizeMultiplier);
765
766 // Compute the size before cookie, and track whether it overflowed.
767 bool overflow;
768 llvm::APInt allocationSize
769 = adjustedCount.umul_ov(typeSizeMultiplier, overflow);
770 hasAnyOverflow |= overflow;
771
772 // Add in the cookie, and check whether it's overflowed.
773 if (cookieSize != 0) {
774 // Save the current size without a cookie. This shouldn't be
775 // used if there was overflow.
776 sizeWithoutCookie = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
777
778 allocationSize = allocationSize.uadd_ov(cookieSize, overflow);
779 hasAnyOverflow |= overflow;
780 }
781
782 // On overflow, produce a -1 so operator new will fail.
Aaron Ballman455f42c2014-08-28 17:24:14 +0000783 if (hasAnyOverflow) {
784 size = llvm::Constant::getAllOnesValue(CGF.SizeTy);
785 } else {
John McCall036f2f62011-05-15 07:14:44 +0000786 size = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
Aaron Ballman455f42c2014-08-28 17:24:14 +0000787 }
John McCall036f2f62011-05-15 07:14:44 +0000788
789 // Otherwise, we might need to use the overflow intrinsics.
790 } else {
Sebastian Redlf862eb62012-02-22 17:37:52 +0000791 // There are up to five conditions we need to test for:
John McCall036f2f62011-05-15 07:14:44 +0000792 // 1) if isSigned, we need to check whether numElements is negative;
793 // 2) if numElementsWidth > sizeWidth, we need to check whether
794 // numElements is larger than something representable in size_t;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000795 // 3) if minElements > 0, we need to check whether numElements is smaller
796 // than that.
797 // 4) we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000798 // sizeWithoutCookie := numElements * typeSizeMultiplier
799 // and check whether it overflows; and
Sebastian Redlf862eb62012-02-22 17:37:52 +0000800 // 5) if we need a cookie, we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000801 // size := sizeWithoutCookie + cookieSize
802 // and check whether it overflows.
803
Craig Topper8a13c412014-05-21 05:09:00 +0000804 llvm::Value *hasOverflow = nullptr;
John McCall036f2f62011-05-15 07:14:44 +0000805
806 // If numElementsWidth > sizeWidth, then one way or another, we're
807 // going to have to do a comparison for (2), and this happens to
808 // take care of (1), too.
809 if (numElementsWidth > sizeWidth) {
810 llvm::APInt threshold(numElementsWidth, 1);
811 threshold <<= sizeWidth;
812
813 llvm::Value *thresholdV
814 = llvm::ConstantInt::get(numElementsType, threshold);
815
816 hasOverflow = CGF.Builder.CreateICmpUGE(numElements, thresholdV);
817 numElements = CGF.Builder.CreateTrunc(numElements, CGF.SizeTy);
818
819 // Otherwise, if we're signed, we want to sext up to size_t.
820 } else if (isSigned) {
821 if (numElementsWidth < sizeWidth)
822 numElements = CGF.Builder.CreateSExt(numElements, CGF.SizeTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000823
John McCall036f2f62011-05-15 07:14:44 +0000824 // If there's a non-1 type size multiplier, then we can do the
825 // signedness check at the same time as we do the multiply
826 // because a negative number times anything will cause an
Sebastian Redlf862eb62012-02-22 17:37:52 +0000827 // unsigned overflow. Otherwise, we have to do it here. But at least
828 // in this case, we can subsume the >= minElements check.
John McCall036f2f62011-05-15 07:14:44 +0000829 if (typeSizeMultiplier == 1)
830 hasOverflow = CGF.Builder.CreateICmpSLT(numElements,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000831 llvm::ConstantInt::get(CGF.SizeTy, minElements));
John McCall036f2f62011-05-15 07:14:44 +0000832
833 // Otherwise, zext up to size_t if necessary.
834 } else if (numElementsWidth < sizeWidth) {
835 numElements = CGF.Builder.CreateZExt(numElements, CGF.SizeTy);
836 }
837
838 assert(numElements->getType() == CGF.SizeTy);
839
Sebastian Redlf862eb62012-02-22 17:37:52 +0000840 if (minElements) {
841 // Don't allow allocation of fewer elements than we have initializers.
842 if (!hasOverflow) {
843 hasOverflow = CGF.Builder.CreateICmpULT(numElements,
844 llvm::ConstantInt::get(CGF.SizeTy, minElements));
845 } else if (numElementsWidth > sizeWidth) {
846 // The other existing overflow subsumes this check.
847 // We do an unsigned comparison, since any signed value < -1 is
848 // taken care of either above or below.
849 hasOverflow = CGF.Builder.CreateOr(hasOverflow,
850 CGF.Builder.CreateICmpULT(numElements,
851 llvm::ConstantInt::get(CGF.SizeTy, minElements)));
852 }
853 }
854
John McCall036f2f62011-05-15 07:14:44 +0000855 size = numElements;
856
857 // Multiply by the type size if necessary. This multiplier
858 // includes all the factors for nested arrays.
859 //
860 // This step also causes numElements to be scaled up by the
861 // nested-array factor if necessary. Overflow on this computation
862 // can be ignored because the result shouldn't be used if
863 // allocation fails.
864 if (typeSizeMultiplier != 1) {
James Y Knight8799cae2019-02-03 21:53:49 +0000865 llvm::Function *umul_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000866 = CGF.CGM.getIntrinsic(llvm::Intrinsic::umul_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000867
868 llvm::Value *tsmV =
869 llvm::ConstantInt::get(CGF.SizeTy, typeSizeMultiplier);
870 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000871 CGF.Builder.CreateCall(umul_with_overflow, {size, tsmV});
John McCall036f2f62011-05-15 07:14:44 +0000872
873 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
874 if (hasOverflow)
875 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
876 else
877 hasOverflow = overflowed;
878
879 size = CGF.Builder.CreateExtractValue(result, 0);
880
881 // Also scale up numElements by the array size multiplier.
882 if (arraySizeMultiplier != 1) {
883 // If the base element type size is 1, then we can re-use the
884 // multiply we just did.
885 if (typeSize.isOne()) {
886 assert(arraySizeMultiplier == typeSizeMultiplier);
887 numElements = size;
888
889 // Otherwise we need a separate multiply.
890 } else {
891 llvm::Value *asmV =
892 llvm::ConstantInt::get(CGF.SizeTy, arraySizeMultiplier);
893 numElements = CGF.Builder.CreateMul(numElements, asmV);
894 }
895 }
896 } else {
897 // numElements doesn't need to be scaled.
898 assert(arraySizeMultiplier == 1);
Chris Lattner32ac5832010-07-20 21:55:52 +0000899 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000900
John McCall036f2f62011-05-15 07:14:44 +0000901 // Add in the cookie size if necessary.
902 if (cookieSize != 0) {
903 sizeWithoutCookie = size;
904
James Y Knight8799cae2019-02-03 21:53:49 +0000905 llvm::Function *uadd_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000906 = CGF.CGM.getIntrinsic(llvm::Intrinsic::uadd_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000907
908 llvm::Value *cookieSizeV = llvm::ConstantInt::get(CGF.SizeTy, cookieSize);
909 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000910 CGF.Builder.CreateCall(uadd_with_overflow, {size, cookieSizeV});
John McCall036f2f62011-05-15 07:14:44 +0000911
912 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
913 if (hasOverflow)
914 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
915 else
916 hasOverflow = overflowed;
917
918 size = CGF.Builder.CreateExtractValue(result, 0);
John McCall8ed55a52010-09-02 09:58:18 +0000919 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000920
John McCall036f2f62011-05-15 07:14:44 +0000921 // If we had any possibility of dynamic overflow, make a select to
922 // overwrite 'size' with an all-ones value, which should cause
923 // operator new to throw.
924 if (hasOverflow)
Aaron Ballman455f42c2014-08-28 17:24:14 +0000925 size = CGF.Builder.CreateSelect(hasOverflow,
926 llvm::Constant::getAllOnesValue(CGF.SizeTy),
927 size);
Chris Lattner32ac5832010-07-20 21:55:52 +0000928 }
John McCall8ed55a52010-09-02 09:58:18 +0000929
John McCall036f2f62011-05-15 07:14:44 +0000930 if (cookieSize == 0)
931 sizeWithoutCookie = size;
John McCall8ed55a52010-09-02 09:58:18 +0000932 else
John McCall036f2f62011-05-15 07:14:44 +0000933 assert(sizeWithoutCookie && "didn't set sizeWithoutCookie?");
John McCall8ed55a52010-09-02 09:58:18 +0000934
John McCall036f2f62011-05-15 07:14:44 +0000935 return size;
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000936}
937
Sebastian Redlf862eb62012-02-22 17:37:52 +0000938static void StoreAnyExprIntoOneUnit(CodeGenFunction &CGF, const Expr *Init,
Richard Smithe78fac52018-04-05 20:52:58 +0000939 QualType AllocType, Address NewPtr,
940 AggValueSlot::Overlap_t MayOverlap) {
Richard Smith1c96bc52013-12-11 01:40:16 +0000941 // FIXME: Refactor with EmitExprAsInit.
John McCall47fb9502013-03-07 21:37:08 +0000942 switch (CGF.getEvaluationKind(AllocType)) {
943 case TEK_Scalar:
David Blaikiea2c11242014-12-10 19:04:09 +0000944 CGF.EmitScalarInit(Init, nullptr,
John McCall7f416cc2015-09-08 08:05:57 +0000945 CGF.MakeAddrLValue(NewPtr, AllocType), false);
John McCall47fb9502013-03-07 21:37:08 +0000946 return;
947 case TEK_Complex:
John McCall7f416cc2015-09-08 08:05:57 +0000948 CGF.EmitComplexExprIntoLValue(Init, CGF.MakeAddrLValue(NewPtr, AllocType),
John McCall47fb9502013-03-07 21:37:08 +0000949 /*isInit*/ true);
950 return;
951 case TEK_Aggregate: {
John McCall7a626f62010-09-15 10:14:12 +0000952 AggValueSlot Slot
John McCall7f416cc2015-09-08 08:05:57 +0000953 = AggValueSlot::forAddr(NewPtr, AllocType.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +0000954 AggValueSlot::IsDestructed,
John McCall46759f42011-08-26 07:31:35 +0000955 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +0000956 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +0000957 MayOverlap, AggValueSlot::IsNotZeroed,
958 AggValueSlot::IsSanitizerChecked);
John McCall7a626f62010-09-15 10:14:12 +0000959 CGF.EmitAggExpr(Init, Slot);
John McCall47fb9502013-03-07 21:37:08 +0000960 return;
John McCall7a626f62010-09-15 10:14:12 +0000961 }
John McCall47fb9502013-03-07 21:37:08 +0000962 }
963 llvm_unreachable("bad evaluation kind");
Fariborz Jahaniand5202e02010-06-25 18:26:07 +0000964}
965
David Blaikiefb901c7a2015-04-04 15:12:29 +0000966void CodeGenFunction::EmitNewArrayInitializer(
967 const CXXNewExpr *E, QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +0000968 Address BeginPtr, llvm::Value *NumElements,
David Blaikiefb901c7a2015-04-04 15:12:29 +0000969 llvm::Value *AllocSizeWithoutCookie) {
Richard Smith06a67e22014-06-03 06:58:52 +0000970 // If we have a type with trivial initialization and no initializer,
971 // there's nothing to do.
Sebastian Redl6047f072012-02-16 12:22:20 +0000972 if (!E->hasInitializer())
Richard Smith06a67e22014-06-03 06:58:52 +0000973 return;
John McCall99210dc2011-09-15 06:49:18 +0000974
John McCall7f416cc2015-09-08 08:05:57 +0000975 Address CurPtr = BeginPtr;
John McCall99210dc2011-09-15 06:49:18 +0000976
Richard Smith06a67e22014-06-03 06:58:52 +0000977 unsigned InitListElements = 0;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000978
979 const Expr *Init = E->getInitializer();
John McCall7f416cc2015-09-08 08:05:57 +0000980 Address EndOfInit = Address::invalid();
Richard Smith06a67e22014-06-03 06:58:52 +0000981 QualType::DestructionKind DtorKind = ElementType.isDestructedType();
982 EHScopeStack::stable_iterator Cleanup;
983 llvm::Instruction *CleanupDominator = nullptr;
Richard Smith1c96bc52013-12-11 01:40:16 +0000984
John McCall7f416cc2015-09-08 08:05:57 +0000985 CharUnits ElementSize = getContext().getTypeSizeInChars(ElementType);
986 CharUnits ElementAlign =
987 BeginPtr.getAlignment().alignmentOfArrayElement(ElementSize);
988
Richard Smith0511d232016-10-05 22:41:02 +0000989 // Attempt to perform zero-initialization using memset.
990 auto TryMemsetInitialization = [&]() -> bool {
991 // FIXME: If the type is a pointer-to-data-member under the Itanium ABI,
992 // we can initialize with a memset to -1.
993 if (!CGM.getTypes().isZeroInitializable(ElementType))
994 return false;
995
996 // Optimization: since zero initialization will just set the memory
997 // to all zeroes, generate a single memset to do it in one shot.
998
999 // Subtract out the size of any elements we've already initialized.
1000 auto *RemainingSize = AllocSizeWithoutCookie;
1001 if (InitListElements) {
1002 // We know this can't overflow; we check this when doing the allocation.
1003 auto *InitializedSize = llvm::ConstantInt::get(
1004 RemainingSize->getType(),
1005 getContext().getTypeSizeInChars(ElementType).getQuantity() *
1006 InitListElements);
1007 RemainingSize = Builder.CreateSub(RemainingSize, InitializedSize);
1008 }
1009
1010 // Create the memset.
1011 Builder.CreateMemSet(CurPtr, Builder.getInt8(0), RemainingSize, false);
1012 return true;
1013 };
1014
Sebastian Redlf862eb62012-02-22 17:37:52 +00001015 // If the initializer is an initializer list, first do the explicit elements.
1016 if (const InitListExpr *ILE = dyn_cast<InitListExpr>(Init)) {
Richard Smith0511d232016-10-05 22:41:02 +00001017 // Initializing from a (braced) string literal is a special case; the init
1018 // list element does not initialize a (single) array element.
1019 if (ILE->isStringLiteralInit()) {
1020 // Initialize the initial portion of length equal to that of the string
1021 // literal. The allocation must be for at least this much; we emitted a
1022 // check for that earlier.
1023 AggValueSlot Slot =
1024 AggValueSlot::forAddr(CurPtr, ElementType.getQualifiers(),
1025 AggValueSlot::IsDestructed,
1026 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001027 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +00001028 AggValueSlot::DoesNotOverlap,
1029 AggValueSlot::IsNotZeroed,
1030 AggValueSlot::IsSanitizerChecked);
Richard Smith0511d232016-10-05 22:41:02 +00001031 EmitAggExpr(ILE->getInit(0), Slot);
1032
1033 // Move past these elements.
1034 InitListElements =
1035 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1036 ->getSize().getZExtValue();
1037 CurPtr =
1038 Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1039 Builder.getSize(InitListElements),
1040 "string.init.end"),
1041 CurPtr.getAlignment().alignmentAtOffset(InitListElements *
1042 ElementSize));
1043
1044 // Zero out the rest, if any remain.
1045 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1046 if (!ConstNum || !ConstNum->equalsInt(InitListElements)) {
1047 bool OK = TryMemsetInitialization();
1048 (void)OK;
1049 assert(OK && "couldn't memset character type?");
1050 }
1051 return;
1052 }
1053
Richard Smith06a67e22014-06-03 06:58:52 +00001054 InitListElements = ILE->getNumInits();
Chad Rosierf62290a2012-02-24 00:13:55 +00001055
Richard Smith1c96bc52013-12-11 01:40:16 +00001056 // If this is a multi-dimensional array new, we will initialize multiple
1057 // elements with each init list element.
1058 QualType AllocType = E->getAllocatedType();
1059 if (const ConstantArrayType *CAT = dyn_cast_or_null<ConstantArrayType>(
1060 AllocType->getAsArrayTypeUnsafe())) {
David Blaikiefb901c7a2015-04-04 15:12:29 +00001061 ElementTy = ConvertTypeForMem(AllocType);
John McCall7f416cc2015-09-08 08:05:57 +00001062 CurPtr = Builder.CreateElementBitCast(CurPtr, ElementTy);
Richard Smith06a67e22014-06-03 06:58:52 +00001063 InitListElements *= getContext().getConstantArrayElementCount(CAT);
Richard Smith1c96bc52013-12-11 01:40:16 +00001064 }
1065
Richard Smith06a67e22014-06-03 06:58:52 +00001066 // Enter a partial-destruction Cleanup if necessary.
1067 if (needsEHCleanup(DtorKind)) {
1068 // In principle we could tell the Cleanup where we are more
Chad Rosierf62290a2012-02-24 00:13:55 +00001069 // directly, but the control flow can get so varied here that it
1070 // would actually be quite complex. Therefore we go through an
1071 // alloca.
John McCall7f416cc2015-09-08 08:05:57 +00001072 EndOfInit = CreateTempAlloca(BeginPtr.getType(), getPointerAlign(),
1073 "array.init.end");
1074 CleanupDominator = Builder.CreateStore(BeginPtr.getPointer(), EndOfInit);
1075 pushIrregularPartialArrayCleanup(BeginPtr.getPointer(), EndOfInit,
1076 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001077 getDestroyer(DtorKind));
1078 Cleanup = EHStack.stable_begin();
Chad Rosierf62290a2012-02-24 00:13:55 +00001079 }
1080
John McCall7f416cc2015-09-08 08:05:57 +00001081 CharUnits StartAlign = CurPtr.getAlignment();
Sebastian Redlf862eb62012-02-22 17:37:52 +00001082 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i) {
Chad Rosierf62290a2012-02-24 00:13:55 +00001083 // Tell the cleanup that it needs to destroy up to this
1084 // element. TODO: some of these stores can be trivially
1085 // observed to be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00001086 if (EndOfInit.isValid()) {
1087 auto FinishedPtr =
1088 Builder.CreateBitCast(CurPtr.getPointer(), BeginPtr.getType());
1089 Builder.CreateStore(FinishedPtr, EndOfInit);
1090 }
Richard Smith06a67e22014-06-03 06:58:52 +00001091 // FIXME: If the last initializer is an incomplete initializer list for
1092 // an array, and we have an array filler, we can fold together the two
1093 // initialization loops.
Richard Smith1c96bc52013-12-11 01:40:16 +00001094 StoreAnyExprIntoOneUnit(*this, ILE->getInit(i),
Richard Smithe78fac52018-04-05 20:52:58 +00001095 ILE->getInit(i)->getType(), CurPtr,
1096 AggValueSlot::DoesNotOverlap);
John McCall7f416cc2015-09-08 08:05:57 +00001097 CurPtr = Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1098 Builder.getSize(1),
1099 "array.exp.next"),
1100 StartAlign.alignmentAtOffset((i + 1) * ElementSize));
Sebastian Redlf862eb62012-02-22 17:37:52 +00001101 }
1102
1103 // The remaining elements are filled with the array filler expression.
1104 Init = ILE->getArrayFiller();
Richard Smith1c96bc52013-12-11 01:40:16 +00001105
Richard Smith06a67e22014-06-03 06:58:52 +00001106 // Extract the initializer for the individual array elements by pulling
1107 // out the array filler from all the nested initializer lists. This avoids
1108 // generating a nested loop for the initialization.
1109 while (Init && Init->getType()->isConstantArrayType()) {
1110 auto *SubILE = dyn_cast<InitListExpr>(Init);
1111 if (!SubILE)
1112 break;
1113 assert(SubILE->getNumInits() == 0 && "explicit inits in array filler?");
1114 Init = SubILE->getArrayFiller();
1115 }
1116
1117 // Switch back to initializing one base element at a time.
John McCall7f416cc2015-09-08 08:05:57 +00001118 CurPtr = Builder.CreateBitCast(CurPtr, BeginPtr.getType());
Sebastian Redlf862eb62012-02-22 17:37:52 +00001119 }
1120
Richard Smith454a7cd2014-06-03 08:26:00 +00001121 // If all elements have already been initialized, skip any further
1122 // initialization.
1123 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1124 if (ConstNum && ConstNum->getZExtValue() <= InitListElements) {
1125 // If there was a Cleanup, deactivate it.
1126 if (CleanupDominator)
1127 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1128 return;
1129 }
1130
1131 assert(Init && "have trailing elements to initialize but no initializer");
1132
Richard Smith06a67e22014-06-03 06:58:52 +00001133 // If this is a constructor call, try to optimize it out, and failing that
1134 // emit a single loop to initialize all remaining elements.
Richard Smith454a7cd2014-06-03 08:26:00 +00001135 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001136 CXXConstructorDecl *Ctor = CCE->getConstructor();
1137 if (Ctor->isTrivial()) {
1138 // If new expression did not specify value-initialization, then there
1139 // is no initialization.
1140 if (!CCE->requiresZeroInitialization() || Ctor->getParent()->isEmpty())
1141 return;
1142
1143 if (TryMemsetInitialization())
1144 return;
1145 }
1146
1147 // Store the new Cleanup position for irregular Cleanups.
1148 //
1149 // FIXME: Share this cleanup with the constructor call emission rather than
1150 // having it create a cleanup of its own.
John McCall7f416cc2015-09-08 08:05:57 +00001151 if (EndOfInit.isValid())
1152 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Richard Smith06a67e22014-06-03 06:58:52 +00001153
1154 // Emit a constructor call loop to initialize the remaining elements.
1155 if (InitListElements)
1156 NumElements = Builder.CreateSub(
1157 NumElements,
1158 llvm::ConstantInt::get(NumElements->getType(), InitListElements));
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001159 EmitCXXAggrConstructorCall(Ctor, NumElements, CurPtr, CCE,
Serge Pavlov37605182018-07-28 15:33:03 +00001160 /*NewPointerIsChecked*/true,
Richard Smith06a67e22014-06-03 06:58:52 +00001161 CCE->requiresZeroInitialization());
Chandler Carruthe6c980c2014-05-03 09:16:57 +00001162 return;
1163 }
1164
Richard Smith06a67e22014-06-03 06:58:52 +00001165 // If this is value-initialization, we can usually use memset.
1166 ImplicitValueInitExpr IVIE(ElementType);
Richard Smith454a7cd2014-06-03 08:26:00 +00001167 if (isa<ImplicitValueInitExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001168 if (TryMemsetInitialization())
1169 return;
1170
1171 // Switch to an ImplicitValueInitExpr for the element type. This handles
1172 // only one case: multidimensional array new of pointers to members. In
1173 // all other cases, we already have an initializer for the array element.
1174 Init = &IVIE;
1175 }
1176
1177 // At this point we should have found an initializer for the individual
1178 // elements of the array.
1179 assert(getContext().hasSameUnqualifiedType(ElementType, Init->getType()) &&
1180 "got wrong type of element to initialize");
1181
Richard Smith454a7cd2014-06-03 08:26:00 +00001182 // If we have an empty initializer list, we can usually use memset.
1183 if (auto *ILE = dyn_cast<InitListExpr>(Init))
1184 if (ILE->getNumInits() == 0 && TryMemsetInitialization())
1185 return;
Richard Smith06a67e22014-06-03 06:58:52 +00001186
Yunzhong Gaocb779302015-06-10 00:27:52 +00001187 // If we have a struct whose every field is value-initialized, we can
1188 // usually use memset.
1189 if (auto *ILE = dyn_cast<InitListExpr>(Init)) {
1190 if (const RecordType *RType = ILE->getType()->getAs<RecordType>()) {
1191 if (RType->getDecl()->isStruct()) {
Richard Smith872307e2016-03-08 22:17:41 +00001192 unsigned NumElements = 0;
1193 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RType->getDecl()))
1194 NumElements = CXXRD->getNumBases();
Yunzhong Gaocb779302015-06-10 00:27:52 +00001195 for (auto *Field : RType->getDecl()->fields())
1196 if (!Field->isUnnamedBitfield())
Richard Smith872307e2016-03-08 22:17:41 +00001197 ++NumElements;
1198 // FIXME: Recurse into nested InitListExprs.
1199 if (ILE->getNumInits() == NumElements)
Yunzhong Gaocb779302015-06-10 00:27:52 +00001200 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i)
1201 if (!isa<ImplicitValueInitExpr>(ILE->getInit(i)))
Richard Smith872307e2016-03-08 22:17:41 +00001202 --NumElements;
1203 if (ILE->getNumInits() == NumElements && TryMemsetInitialization())
Yunzhong Gaocb779302015-06-10 00:27:52 +00001204 return;
1205 }
1206 }
1207 }
1208
Richard Smith06a67e22014-06-03 06:58:52 +00001209 // Create the loop blocks.
1210 llvm::BasicBlock *EntryBB = Builder.GetInsertBlock();
1211 llvm::BasicBlock *LoopBB = createBasicBlock("new.loop");
1212 llvm::BasicBlock *ContBB = createBasicBlock("new.loop.end");
1213
1214 // Find the end of the array, hoisted out of the loop.
1215 llvm::Value *EndPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001216 Builder.CreateInBoundsGEP(BeginPtr.getPointer(), NumElements, "array.end");
John McCall99210dc2011-09-15 06:49:18 +00001217
Sebastian Redlf862eb62012-02-22 17:37:52 +00001218 // If the number of elements isn't constant, we have to now check if there is
1219 // anything left to initialize.
Richard Smith06a67e22014-06-03 06:58:52 +00001220 if (!ConstNum) {
John McCall7f416cc2015-09-08 08:05:57 +00001221 llvm::Value *IsEmpty =
1222 Builder.CreateICmpEQ(CurPtr.getPointer(), EndPtr, "array.isempty");
Richard Smith06a67e22014-06-03 06:58:52 +00001223 Builder.CreateCondBr(IsEmpty, ContBB, LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001224 }
1225
1226 // Enter the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001227 EmitBlock(LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001228
1229 // Set up the current-element phi.
Richard Smith06a67e22014-06-03 06:58:52 +00001230 llvm::PHINode *CurPtrPhi =
John McCall7f416cc2015-09-08 08:05:57 +00001231 Builder.CreatePHI(CurPtr.getType(), 2, "array.cur");
1232 CurPtrPhi->addIncoming(CurPtr.getPointer(), EntryBB);
1233
1234 CurPtr = Address(CurPtrPhi, ElementAlign);
John McCall99210dc2011-09-15 06:49:18 +00001235
Richard Smith06a67e22014-06-03 06:58:52 +00001236 // Store the new Cleanup position for irregular Cleanups.
Fangrui Song6907ce22018-07-30 19:24:48 +00001237 if (EndOfInit.isValid())
John McCall7f416cc2015-09-08 08:05:57 +00001238 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Chad Rosierf62290a2012-02-24 00:13:55 +00001239
Richard Smith06a67e22014-06-03 06:58:52 +00001240 // Enter a partial-destruction Cleanup if necessary.
1241 if (!CleanupDominator && needsEHCleanup(DtorKind)) {
John McCall7f416cc2015-09-08 08:05:57 +00001242 pushRegularPartialArrayCleanup(BeginPtr.getPointer(), CurPtr.getPointer(),
1243 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001244 getDestroyer(DtorKind));
1245 Cleanup = EHStack.stable_begin();
1246 CleanupDominator = Builder.CreateUnreachable();
John McCall99210dc2011-09-15 06:49:18 +00001247 }
1248
1249 // Emit the initializer into this element.
Richard Smithe78fac52018-04-05 20:52:58 +00001250 StoreAnyExprIntoOneUnit(*this, Init, Init->getType(), CurPtr,
1251 AggValueSlot::DoesNotOverlap);
John McCall99210dc2011-09-15 06:49:18 +00001252
Richard Smith06a67e22014-06-03 06:58:52 +00001253 // Leave the Cleanup if we entered one.
1254 if (CleanupDominator) {
1255 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1256 CleanupDominator->eraseFromParent();
John McCallf4beacd2011-11-10 10:43:54 +00001257 }
John McCall99210dc2011-09-15 06:49:18 +00001258
Faisal Vali57ae0562013-12-14 00:40:05 +00001259 // Advance to the next element by adjusting the pointer type as necessary.
Richard Smith06a67e22014-06-03 06:58:52 +00001260 llvm::Value *NextPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001261 Builder.CreateConstInBoundsGEP1_32(ElementTy, CurPtr.getPointer(), 1,
1262 "array.next");
Richard Smith06a67e22014-06-03 06:58:52 +00001263
John McCall99210dc2011-09-15 06:49:18 +00001264 // Check whether we've gotten to the end of the array and, if so,
1265 // exit the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001266 llvm::Value *IsEnd = Builder.CreateICmpEQ(NextPtr, EndPtr, "array.atend");
1267 Builder.CreateCondBr(IsEnd, ContBB, LoopBB);
1268 CurPtrPhi->addIncoming(NextPtr, Builder.GetInsertBlock());
John McCall99210dc2011-09-15 06:49:18 +00001269
Richard Smith06a67e22014-06-03 06:58:52 +00001270 EmitBlock(ContBB);
Fariborz Jahaniand5202e02010-06-25 18:26:07 +00001271}
1272
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001273static void EmitNewInitializer(CodeGenFunction &CGF, const CXXNewExpr *E,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001274 QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +00001275 Address NewPtr, llvm::Value *NumElements,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001276 llvm::Value *AllocSizeWithoutCookie) {
David Blaikie9b479662015-01-25 01:19:10 +00001277 ApplyDebugLocation DL(CGF, E);
Richard Smith06a67e22014-06-03 06:58:52 +00001278 if (E->isArray())
David Blaikiefb901c7a2015-04-04 15:12:29 +00001279 CGF.EmitNewArrayInitializer(E, ElementType, ElementTy, NewPtr, NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001280 AllocSizeWithoutCookie);
1281 else if (const Expr *Init = E->getInitializer())
Richard Smithe78fac52018-04-05 20:52:58 +00001282 StoreAnyExprIntoOneUnit(CGF, Init, E->getAllocatedType(), NewPtr,
1283 AggValueSlot::DoesNotOverlap);
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001284}
1285
Richard Smith8d0dc312013-07-21 23:12:18 +00001286/// Emit a call to an operator new or operator delete function, as implicitly
1287/// created by new-expressions and delete-expressions.
1288static RValue EmitNewDeleteCall(CodeGenFunction &CGF,
John McCallb92ab1a2016-10-26 23:46:34 +00001289 const FunctionDecl *CalleeDecl,
Richard Smith8d0dc312013-07-21 23:12:18 +00001290 const FunctionProtoType *CalleeType,
1291 const CallArgList &Args) {
James Y Knight3933add2019-01-30 02:54:28 +00001292 llvm::CallBase *CallOrInvoke;
John McCallb92ab1a2016-10-26 23:46:34 +00001293 llvm::Constant *CalleePtr = CGF.CGM.GetAddrOfFunction(CalleeDecl);
Erich Keanede6480a32018-11-13 15:48:08 +00001294 CGCallee Callee = CGCallee::forDirect(CalleePtr, GlobalDecl(CalleeDecl));
Richard Smith8d0dc312013-07-21 23:12:18 +00001295 RValue RV =
Peter Collingbournef7706832014-12-12 23:41:25 +00001296 CGF.EmitCall(CGF.CGM.getTypes().arrangeFreeFunctionCall(
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001297 Args, CalleeType, /*ChainCall=*/false),
John McCallb92ab1a2016-10-26 23:46:34 +00001298 Callee, ReturnValueSlot(), Args, &CallOrInvoke);
Richard Smith8d0dc312013-07-21 23:12:18 +00001299
1300 /// C++1y [expr.new]p10:
1301 /// [In a new-expression,] an implementation is allowed to omit a call
1302 /// to a replaceable global allocation function.
1303 ///
1304 /// We model such elidable calls with the 'builtin' attribute.
John McCallb92ab1a2016-10-26 23:46:34 +00001305 llvm::Function *Fn = dyn_cast<llvm::Function>(CalleePtr);
1306 if (CalleeDecl->isReplaceableGlobalAllocationFunction() &&
Rafael Espindola6956d582013-10-22 14:23:09 +00001307 Fn && Fn->hasFnAttribute(llvm::Attribute::NoBuiltin)) {
James Y Knight3933add2019-01-30 02:54:28 +00001308 CallOrInvoke->addAttribute(llvm::AttributeList::FunctionIndex,
1309 llvm::Attribute::Builtin);
Richard Smith8d0dc312013-07-21 23:12:18 +00001310 }
1311
1312 return RV;
1313}
1314
Richard Smith760520b2014-06-03 23:27:44 +00001315RValue CodeGenFunction::EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00001316 const CallExpr *TheCall,
Richard Smith760520b2014-06-03 23:27:44 +00001317 bool IsDelete) {
1318 CallArgList Args;
Eric Fiselierfa752f22018-03-21 19:19:48 +00001319 EmitCallArgs(Args, Type->getParamTypes(), TheCall->arguments());
Richard Smith760520b2014-06-03 23:27:44 +00001320 // Find the allocation or deallocation function that we're calling.
1321 ASTContext &Ctx = getContext();
1322 DeclarationName Name = Ctx.DeclarationNames
1323 .getCXXOperatorName(IsDelete ? OO_Delete : OO_New);
Eric Fiselierfa752f22018-03-21 19:19:48 +00001324
Richard Smith760520b2014-06-03 23:27:44 +00001325 for (auto *Decl : Ctx.getTranslationUnitDecl()->lookup(Name))
Richard Smith599bed72014-06-05 00:43:02 +00001326 if (auto *FD = dyn_cast<FunctionDecl>(Decl))
1327 if (Ctx.hasSameType(FD->getType(), QualType(Type, 0)))
Eric Fiselierfa752f22018-03-21 19:19:48 +00001328 return EmitNewDeleteCall(*this, FD, Type, Args);
Richard Smith760520b2014-06-03 23:27:44 +00001329 llvm_unreachable("predeclared global operator new/delete is missing");
1330}
1331
Richard Smith5b349582017-10-13 01:55:36 +00001332namespace {
1333/// The parameters to pass to a usual operator delete.
1334struct UsualDeleteParams {
1335 bool DestroyingDelete = false;
1336 bool Size = false;
1337 bool Alignment = false;
1338};
1339}
1340
1341static UsualDeleteParams getUsualDeleteParams(const FunctionDecl *FD) {
1342 UsualDeleteParams Params;
1343
1344 const FunctionProtoType *FPT = FD->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001345 auto AI = FPT->param_type_begin(), AE = FPT->param_type_end();
Richard Smith189e52f2016-10-10 06:42:31 +00001346
Richard Smithb2f0f052016-10-10 18:54:32 +00001347 // The first argument is always a void*.
1348 ++AI;
1349
Richard Smith5b349582017-10-13 01:55:36 +00001350 // The next parameter may be a std::destroying_delete_t.
1351 if (FD->isDestroyingOperatorDelete()) {
1352 Params.DestroyingDelete = true;
1353 assert(AI != AE);
1354 ++AI;
1355 }
Richard Smithb2f0f052016-10-10 18:54:32 +00001356
Richard Smith5b349582017-10-13 01:55:36 +00001357 // Figure out what other parameters we should be implicitly passing.
Richard Smithb2f0f052016-10-10 18:54:32 +00001358 if (AI != AE && (*AI)->isIntegerType()) {
Richard Smith5b349582017-10-13 01:55:36 +00001359 Params.Size = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001360 ++AI;
1361 }
1362
1363 if (AI != AE && (*AI)->isAlignValT()) {
Richard Smith5b349582017-10-13 01:55:36 +00001364 Params.Alignment = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001365 ++AI;
1366 }
1367
1368 assert(AI == AE && "unexpected usual deallocation function parameter");
Richard Smith5b349582017-10-13 01:55:36 +00001369 return Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001370}
1371
1372namespace {
1373 /// A cleanup to call the given 'operator delete' function upon abnormal
1374 /// exit from a new expression. Templated on a traits type that deals with
1375 /// ensuring that the arguments dominate the cleanup if necessary.
1376 template<typename Traits>
1377 class CallDeleteDuringNew final : public EHScopeStack::Cleanup {
1378 /// Type used to hold llvm::Value*s.
1379 typedef typename Traits::ValueTy ValueTy;
1380 /// Type used to hold RValues.
1381 typedef typename Traits::RValueTy RValueTy;
1382 struct PlacementArg {
1383 RValueTy ArgValue;
1384 QualType ArgType;
1385 };
1386
1387 unsigned NumPlacementArgs : 31;
1388 unsigned PassAlignmentToPlacementDelete : 1;
1389 const FunctionDecl *OperatorDelete;
1390 ValueTy Ptr;
1391 ValueTy AllocSize;
1392 CharUnits AllocAlign;
1393
1394 PlacementArg *getPlacementArgs() {
1395 return reinterpret_cast<PlacementArg *>(this + 1);
1396 }
Daniel Jaspere9abe642016-10-10 14:13:55 +00001397
1398 public:
1399 static size_t getExtraSize(size_t NumPlacementArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001400 return NumPlacementArgs * sizeof(PlacementArg);
Daniel Jaspere9abe642016-10-10 14:13:55 +00001401 }
1402
1403 CallDeleteDuringNew(size_t NumPlacementArgs,
Richard Smithb2f0f052016-10-10 18:54:32 +00001404 const FunctionDecl *OperatorDelete, ValueTy Ptr,
1405 ValueTy AllocSize, bool PassAlignmentToPlacementDelete,
1406 CharUnits AllocAlign)
1407 : NumPlacementArgs(NumPlacementArgs),
1408 PassAlignmentToPlacementDelete(PassAlignmentToPlacementDelete),
1409 OperatorDelete(OperatorDelete), Ptr(Ptr), AllocSize(AllocSize),
1410 AllocAlign(AllocAlign) {}
Daniel Jaspere9abe642016-10-10 14:13:55 +00001411
Richard Smithb2f0f052016-10-10 18:54:32 +00001412 void setPlacementArg(unsigned I, RValueTy Arg, QualType Type) {
Daniel Jaspere9abe642016-10-10 14:13:55 +00001413 assert(I < NumPlacementArgs && "index out of range");
Richard Smithb2f0f052016-10-10 18:54:32 +00001414 getPlacementArgs()[I] = {Arg, Type};
Daniel Jaspere9abe642016-10-10 14:13:55 +00001415 }
1416
1417 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001418 const FunctionProtoType *FPT =
1419 OperatorDelete->getType()->getAs<FunctionProtoType>();
Daniel Jaspere9abe642016-10-10 14:13:55 +00001420 CallArgList DeleteArgs;
1421
Richard Smith5b349582017-10-13 01:55:36 +00001422 // The first argument is always a void* (or C* for a destroying operator
1423 // delete for class type C).
Richard Smithb2f0f052016-10-10 18:54:32 +00001424 DeleteArgs.add(Traits::get(CGF, Ptr), FPT->getParamType(0));
Daniel Jaspere9abe642016-10-10 14:13:55 +00001425
Richard Smithb2f0f052016-10-10 18:54:32 +00001426 // Figure out what other parameters we should be implicitly passing.
Richard Smith5b349582017-10-13 01:55:36 +00001427 UsualDeleteParams Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001428 if (NumPlacementArgs) {
1429 // A placement deallocation function is implicitly passed an alignment
1430 // if the placement allocation function was, but is never passed a size.
Richard Smith5b349582017-10-13 01:55:36 +00001431 Params.Alignment = PassAlignmentToPlacementDelete;
Richard Smithb2f0f052016-10-10 18:54:32 +00001432 } else {
1433 // For a non-placement new-expression, 'operator delete' can take a
1434 // size and/or an alignment if it has the right parameters.
Richard Smith5b349582017-10-13 01:55:36 +00001435 Params = getUsualDeleteParams(OperatorDelete);
John McCall7f9c92a2010-09-17 00:50:28 +00001436 }
1437
Richard Smith5b349582017-10-13 01:55:36 +00001438 assert(!Params.DestroyingDelete &&
1439 "should not call destroying delete in a new-expression");
1440
Richard Smithb2f0f052016-10-10 18:54:32 +00001441 // The second argument can be a std::size_t (for non-placement delete).
Richard Smith5b349582017-10-13 01:55:36 +00001442 if (Params.Size)
Richard Smithb2f0f052016-10-10 18:54:32 +00001443 DeleteArgs.add(Traits::get(CGF, AllocSize),
1444 CGF.getContext().getSizeType());
1445
1446 // The next (second or third) argument can be a std::align_val_t, which
1447 // is an enum whose underlying type is std::size_t.
1448 // FIXME: Use the right type as the parameter type. Note that in a call
1449 // to operator delete(size_t, ...), we may not have it available.
Richard Smith5b349582017-10-13 01:55:36 +00001450 if (Params.Alignment)
Richard Smithb2f0f052016-10-10 18:54:32 +00001451 DeleteArgs.add(RValue::get(llvm::ConstantInt::get(
1452 CGF.SizeTy, AllocAlign.getQuantity())),
1453 CGF.getContext().getSizeType());
1454
John McCall7f9c92a2010-09-17 00:50:28 +00001455 // Pass the rest of the arguments, which must match exactly.
1456 for (unsigned I = 0; I != NumPlacementArgs; ++I) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001457 auto Arg = getPlacementArgs()[I];
1458 DeleteArgs.add(Traits::get(CGF, Arg.ArgValue), Arg.ArgType);
John McCall7f9c92a2010-09-17 00:50:28 +00001459 }
1460
1461 // Call 'operator delete'.
Richard Smith8d0dc312013-07-21 23:12:18 +00001462 EmitNewDeleteCall(CGF, OperatorDelete, FPT, DeleteArgs);
John McCall7f9c92a2010-09-17 00:50:28 +00001463 }
1464 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001465}
John McCall7f9c92a2010-09-17 00:50:28 +00001466
1467/// Enter a cleanup to call 'operator delete' if the initializer in a
1468/// new-expression throws.
1469static void EnterNewDeleteCleanup(CodeGenFunction &CGF,
1470 const CXXNewExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001471 Address NewPtr,
John McCall7f9c92a2010-09-17 00:50:28 +00001472 llvm::Value *AllocSize,
Richard Smithb2f0f052016-10-10 18:54:32 +00001473 CharUnits AllocAlign,
John McCall7f9c92a2010-09-17 00:50:28 +00001474 const CallArgList &NewArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001475 unsigned NumNonPlacementArgs = E->passAlignment() ? 2 : 1;
1476
John McCall7f9c92a2010-09-17 00:50:28 +00001477 // If we're not inside a conditional branch, then the cleanup will
1478 // dominate and we can do the easier (and more efficient) thing.
1479 if (!CGF.isInConditionalBranch()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001480 struct DirectCleanupTraits {
1481 typedef llvm::Value *ValueTy;
1482 typedef RValue RValueTy;
1483 static RValue get(CodeGenFunction &, ValueTy V) { return RValue::get(V); }
1484 static RValue get(CodeGenFunction &, RValueTy V) { return V; }
1485 };
1486
1487 typedef CallDeleteDuringNew<DirectCleanupTraits> DirectCleanup;
1488
1489 DirectCleanup *Cleanup = CGF.EHStack
1490 .pushCleanupWithExtra<DirectCleanup>(EHCleanup,
1491 E->getNumPlacementArgs(),
1492 E->getOperatorDelete(),
1493 NewPtr.getPointer(),
1494 AllocSize,
1495 E->passAlignment(),
1496 AllocAlign);
1497 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1498 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001499 Cleanup->setPlacementArg(I, Arg.getRValue(CGF), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001500 }
John McCall7f9c92a2010-09-17 00:50:28 +00001501
1502 return;
1503 }
1504
1505 // Otherwise, we need to save all this stuff.
John McCallcb5f77f2011-01-28 10:53:53 +00001506 DominatingValue<RValue>::saved_type SavedNewPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001507 DominatingValue<RValue>::save(CGF, RValue::get(NewPtr.getPointer()));
John McCallcb5f77f2011-01-28 10:53:53 +00001508 DominatingValue<RValue>::saved_type SavedAllocSize =
1509 DominatingValue<RValue>::save(CGF, RValue::get(AllocSize));
John McCall7f9c92a2010-09-17 00:50:28 +00001510
Richard Smithb2f0f052016-10-10 18:54:32 +00001511 struct ConditionalCleanupTraits {
1512 typedef DominatingValue<RValue>::saved_type ValueTy;
1513 typedef DominatingValue<RValue>::saved_type RValueTy;
1514 static RValue get(CodeGenFunction &CGF, ValueTy V) {
1515 return V.restore(CGF);
1516 }
1517 };
1518 typedef CallDeleteDuringNew<ConditionalCleanupTraits> ConditionalCleanup;
1519
1520 ConditionalCleanup *Cleanup = CGF.EHStack
1521 .pushCleanupWithExtra<ConditionalCleanup>(EHCleanup,
1522 E->getNumPlacementArgs(),
1523 E->getOperatorDelete(),
1524 SavedNewPtr,
1525 SavedAllocSize,
1526 E->passAlignment(),
1527 AllocAlign);
1528 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1529 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001530 Cleanup->setPlacementArg(
1531 I, DominatingValue<RValue>::save(CGF, Arg.getRValue(CGF)), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001532 }
John McCall7f9c92a2010-09-17 00:50:28 +00001533
John McCallf4beacd2011-11-10 10:43:54 +00001534 CGF.initFullExprCleanup();
John McCall824c2f52010-09-14 07:57:04 +00001535}
1536
Anders Carlssoncc52f652009-09-22 22:53:17 +00001537llvm::Value *CodeGenFunction::EmitCXXNewExpr(const CXXNewExpr *E) {
John McCall75f94982011-03-07 03:12:35 +00001538 // The element type being allocated.
1539 QualType allocType = getContext().getBaseElementType(E->getAllocatedType());
John McCall8ed55a52010-09-02 09:58:18 +00001540
John McCall75f94982011-03-07 03:12:35 +00001541 // 1. Build a call to the allocation function.
1542 FunctionDecl *allocator = E->getOperatorNew();
Anders Carlssoncc52f652009-09-22 22:53:17 +00001543
Sebastian Redlf862eb62012-02-22 17:37:52 +00001544 // If there is a brace-initializer, cannot allocate fewer elements than inits.
1545 unsigned minElements = 0;
1546 if (E->isArray() && E->hasInitializer()) {
Richard Smith0511d232016-10-05 22:41:02 +00001547 const InitListExpr *ILE = dyn_cast<InitListExpr>(E->getInitializer());
1548 if (ILE && ILE->isStringLiteralInit())
1549 minElements =
1550 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1551 ->getSize().getZExtValue();
1552 else if (ILE)
Sebastian Redlf862eb62012-02-22 17:37:52 +00001553 minElements = ILE->getNumInits();
1554 }
1555
Craig Topper8a13c412014-05-21 05:09:00 +00001556 llvm::Value *numElements = nullptr;
1557 llvm::Value *allocSizeWithoutCookie = nullptr;
John McCall75f94982011-03-07 03:12:35 +00001558 llvm::Value *allocSize =
Sebastian Redlf862eb62012-02-22 17:37:52 +00001559 EmitCXXNewAllocSize(*this, E, minElements, numElements,
1560 allocSizeWithoutCookie);
Richard Smithb2f0f052016-10-10 18:54:32 +00001561 CharUnits allocAlign = getContext().getTypeAlignInChars(allocType);
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00001562
John McCall7ec4b432011-05-16 01:05:12 +00001563 // Emit the allocation call. If the allocator is a global placement
1564 // operator, just "inline" it directly.
John McCall7f416cc2015-09-08 08:05:57 +00001565 Address allocation = Address::invalid();
1566 CallArgList allocatorArgs;
John McCall7ec4b432011-05-16 01:05:12 +00001567 if (allocator->isReservedGlobalPlacementOperator()) {
John McCall53dcf942015-09-29 23:55:17 +00001568 assert(E->getNumPlacementArgs() == 1);
1569 const Expr *arg = *E->placement_arguments().begin();
1570
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001571 LValueBaseInfo BaseInfo;
1572 allocation = EmitPointerWithAlignment(arg, &BaseInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001573
1574 // The pointer expression will, in many cases, be an opaque void*.
1575 // In these cases, discard the computed alignment and use the
1576 // formal alignment of the allocated type.
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001577 if (BaseInfo.getAlignmentSource() != AlignmentSource::Decl)
Richard Smithb2f0f052016-10-10 18:54:32 +00001578 allocation = Address(allocation.getPointer(), allocAlign);
John McCall7f416cc2015-09-08 08:05:57 +00001579
John McCall53dcf942015-09-29 23:55:17 +00001580 // Set up allocatorArgs for the call to operator delete if it's not
1581 // the reserved global operator.
1582 if (E->getOperatorDelete() &&
1583 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
1584 allocatorArgs.add(RValue::get(allocSize), getContext().getSizeType());
1585 allocatorArgs.add(RValue::get(allocation.getPointer()), arg->getType());
1586 }
1587
John McCall7ec4b432011-05-16 01:05:12 +00001588 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001589 const FunctionProtoType *allocatorType =
1590 allocator->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001591 unsigned ParamsToSkip = 0;
John McCall7f416cc2015-09-08 08:05:57 +00001592
1593 // The allocation size is the first argument.
1594 QualType sizeType = getContext().getSizeType();
1595 allocatorArgs.add(RValue::get(allocSize), sizeType);
Richard Smithb2f0f052016-10-10 18:54:32 +00001596 ++ParamsToSkip;
John McCall7f416cc2015-09-08 08:05:57 +00001597
Richard Smithb2f0f052016-10-10 18:54:32 +00001598 if (allocSize != allocSizeWithoutCookie) {
1599 CharUnits cookieAlign = getSizeAlign(); // FIXME: Ask the ABI.
1600 allocAlign = std::max(allocAlign, cookieAlign);
1601 }
1602
1603 // The allocation alignment may be passed as the second argument.
1604 if (E->passAlignment()) {
1605 QualType AlignValT = sizeType;
1606 if (allocatorType->getNumParams() > 1) {
1607 AlignValT = allocatorType->getParamType(1);
1608 assert(getContext().hasSameUnqualifiedType(
1609 AlignValT->castAs<EnumType>()->getDecl()->getIntegerType(),
1610 sizeType) &&
1611 "wrong type for alignment parameter");
1612 ++ParamsToSkip;
1613 } else {
1614 // Corner case, passing alignment to 'operator new(size_t, ...)'.
1615 assert(allocator->isVariadic() && "can't pass alignment to allocator");
1616 }
1617 allocatorArgs.add(
1618 RValue::get(llvm::ConstantInt::get(SizeTy, allocAlign.getQuantity())),
1619 AlignValT);
1620 }
1621
1622 // FIXME: Why do we not pass a CalleeDecl here?
John McCall7f416cc2015-09-08 08:05:57 +00001623 EmitCallArgs(allocatorArgs, allocatorType, E->placement_arguments(),
Vedant Kumared00ea02017-03-06 05:28:22 +00001624 /*AC*/AbstractCallee(), /*ParamsToSkip*/ParamsToSkip);
John McCall7f416cc2015-09-08 08:05:57 +00001625
1626 RValue RV =
1627 EmitNewDeleteCall(*this, allocator, allocatorType, allocatorArgs);
1628
Richard Smithb2f0f052016-10-10 18:54:32 +00001629 // If this was a call to a global replaceable allocation function that does
1630 // not take an alignment argument, the allocator is known to produce
1631 // storage that's suitably aligned for any object that fits, up to a known
1632 // threshold. Otherwise assume it's suitably aligned for the allocated type.
1633 CharUnits allocationAlign = allocAlign;
1634 if (!E->passAlignment() &&
1635 allocator->isReplaceableGlobalAllocationFunction()) {
1636 unsigned AllocatorAlign = llvm::PowerOf2Floor(std::min<uint64_t>(
1637 Target.getNewAlign(), getContext().getTypeSize(allocType)));
1638 allocationAlign = std::max(
1639 allocationAlign, getContext().toCharUnitsFromBits(AllocatorAlign));
John McCall7f416cc2015-09-08 08:05:57 +00001640 }
1641
1642 allocation = Address(RV.getScalarVal(), allocationAlign);
John McCall7ec4b432011-05-16 01:05:12 +00001643 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00001644
John McCall75f94982011-03-07 03:12:35 +00001645 // Emit a null check on the allocation result if the allocation
1646 // function is allowed to return null (because it has a non-throwing
Richard Smith902a0232015-02-14 01:52:20 +00001647 // exception spec or is the reserved placement new) and we have an
Richard Smith2f72a752019-01-10 00:03:29 +00001648 // interesting initializer will be running sanitizers on the initialization.
Bruno Ricci9b6dfac2019-01-07 15:04:45 +00001649 bool nullCheck = E->shouldNullCheckAllocation() &&
Richard Smith2f72a752019-01-10 00:03:29 +00001650 (!allocType.isPODType(getContext()) || E->hasInitializer() ||
1651 sanitizePerformTypeCheck());
Anders Carlssoncc52f652009-09-22 22:53:17 +00001652
Craig Topper8a13c412014-05-21 05:09:00 +00001653 llvm::BasicBlock *nullCheckBB = nullptr;
1654 llvm::BasicBlock *contBB = nullptr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001655
John McCallf7dcf322011-03-07 01:52:56 +00001656 // The null-check means that the initializer is conditionally
1657 // evaluated.
1658 ConditionalEvaluation conditional(*this);
1659
John McCall75f94982011-03-07 03:12:35 +00001660 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001661 conditional.begin(*this);
John McCall75f94982011-03-07 03:12:35 +00001662
1663 nullCheckBB = Builder.GetInsertBlock();
1664 llvm::BasicBlock *notNullBB = createBasicBlock("new.notnull");
1665 contBB = createBasicBlock("new.cont");
1666
John McCall7f416cc2015-09-08 08:05:57 +00001667 llvm::Value *isNull =
1668 Builder.CreateIsNull(allocation.getPointer(), "new.isnull");
John McCall75f94982011-03-07 03:12:35 +00001669 Builder.CreateCondBr(isNull, contBB, notNullBB);
1670 EmitBlock(notNullBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001671 }
Anders Carlssonf7716812009-09-23 18:59:48 +00001672
John McCall824c2f52010-09-14 07:57:04 +00001673 // If there's an operator delete, enter a cleanup to call it if an
1674 // exception is thrown.
John McCall75f94982011-03-07 03:12:35 +00001675 EHScopeStack::stable_iterator operatorDeleteCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001676 llvm::Instruction *cleanupDominator = nullptr;
John McCall7ec4b432011-05-16 01:05:12 +00001677 if (E->getOperatorDelete() &&
1678 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001679 EnterNewDeleteCleanup(*this, E, allocation, allocSize, allocAlign,
1680 allocatorArgs);
John McCall75f94982011-03-07 03:12:35 +00001681 operatorDeleteCleanup = EHStack.stable_begin();
John McCallf4beacd2011-11-10 10:43:54 +00001682 cleanupDominator = Builder.CreateUnreachable();
John McCall824c2f52010-09-14 07:57:04 +00001683 }
1684
Eli Friedmancf9b1f62011-09-06 18:53:03 +00001685 assert((allocSize == allocSizeWithoutCookie) ==
1686 CalculateCookiePadding(*this, E).isZero());
1687 if (allocSize != allocSizeWithoutCookie) {
1688 assert(E->isArray());
1689 allocation = CGM.getCXXABI().InitializeArrayCookie(*this, allocation,
1690 numElements,
1691 E, allocType);
1692 }
1693
David Blaikiefb901c7a2015-04-04 15:12:29 +00001694 llvm::Type *elementTy = ConvertTypeForMem(allocType);
John McCall7f416cc2015-09-08 08:05:57 +00001695 Address result = Builder.CreateElementBitCast(allocation, elementTy);
John McCall824c2f52010-09-14 07:57:04 +00001696
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001697 // Passing pointer through launder.invariant.group to avoid propagation of
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001698 // vptrs information which may be included in previous type.
Piotr Padlewski31fd99c2017-05-20 08:56:18 +00001699 // To not break LTO with different optimizations levels, we do it regardless
1700 // of optimization level.
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001701 if (CGM.getCodeGenOpts().StrictVTablePointers &&
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001702 allocator->isReservedGlobalPlacementOperator())
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001703 result = Address(Builder.CreateLaunderInvariantGroup(result.getPointer()),
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001704 result.getAlignment());
1705
Serge Pavlov37605182018-07-28 15:33:03 +00001706 // Emit sanitizer checks for pointer value now, so that in the case of an
Richard Smithcfa79b22019-01-23 03:37:29 +00001707 // array it was checked only once and not at each constructor call. We may
1708 // have already checked that the pointer is non-null.
1709 // FIXME: If we have an array cookie and a potentially-throwing allocator,
1710 // we'll null check the wrong pointer here.
1711 SanitizerSet SkippedChecks;
1712 SkippedChecks.set(SanitizerKind::Null, nullCheck);
Serge Pavlov37605182018-07-28 15:33:03 +00001713 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall,
Richard Smithcfa79b22019-01-23 03:37:29 +00001714 E->getAllocatedTypeSourceInfo()->getTypeLoc().getBeginLoc(),
1715 result.getPointer(), allocType, result.getAlignment(),
1716 SkippedChecks, numElements);
Serge Pavlov37605182018-07-28 15:33:03 +00001717
David Blaikiefb901c7a2015-04-04 15:12:29 +00001718 EmitNewInitializer(*this, E, allocType, elementTy, result, numElements,
John McCall99210dc2011-09-15 06:49:18 +00001719 allocSizeWithoutCookie);
John McCall8ed55a52010-09-02 09:58:18 +00001720 if (E->isArray()) {
John McCall8ed55a52010-09-02 09:58:18 +00001721 // NewPtr is a pointer to the base element type. If we're
1722 // allocating an array of arrays, we'll need to cast back to the
1723 // array pointer type.
Chris Lattner2192fe52011-07-18 04:24:23 +00001724 llvm::Type *resultType = ConvertTypeForMem(E->getType());
John McCall7f416cc2015-09-08 08:05:57 +00001725 if (result.getType() != resultType)
John McCall75f94982011-03-07 03:12:35 +00001726 result = Builder.CreateBitCast(result, resultType);
Fariborz Jahanian47b46292010-03-24 16:57:01 +00001727 }
John McCall824c2f52010-09-14 07:57:04 +00001728
1729 // Deactivate the 'operator delete' cleanup if we finished
1730 // initialization.
John McCallf4beacd2011-11-10 10:43:54 +00001731 if (operatorDeleteCleanup.isValid()) {
1732 DeactivateCleanupBlock(operatorDeleteCleanup, cleanupDominator);
1733 cleanupDominator->eraseFromParent();
1734 }
Sebastian Redl6047f072012-02-16 12:22:20 +00001735
John McCall7f416cc2015-09-08 08:05:57 +00001736 llvm::Value *resultPtr = result.getPointer();
John McCall75f94982011-03-07 03:12:35 +00001737 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001738 conditional.end(*this);
1739
John McCall75f94982011-03-07 03:12:35 +00001740 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
1741 EmitBlock(contBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001742
John McCall7f416cc2015-09-08 08:05:57 +00001743 llvm::PHINode *PHI = Builder.CreatePHI(resultPtr->getType(), 2);
1744 PHI->addIncoming(resultPtr, notNullBB);
1745 PHI->addIncoming(llvm::Constant::getNullValue(resultPtr->getType()),
John McCall75f94982011-03-07 03:12:35 +00001746 nullCheckBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001747
John McCall7f416cc2015-09-08 08:05:57 +00001748 resultPtr = PHI;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001749 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001750
John McCall7f416cc2015-09-08 08:05:57 +00001751 return resultPtr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001752}
1753
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001754void CodeGenFunction::EmitDeleteCall(const FunctionDecl *DeleteFD,
Richard Smithb2f0f052016-10-10 18:54:32 +00001755 llvm::Value *Ptr, QualType DeleteTy,
1756 llvm::Value *NumElements,
1757 CharUnits CookieSize) {
1758 assert((!NumElements && CookieSize.isZero()) ||
1759 DeleteFD->getOverloadedOperator() == OO_Array_Delete);
John McCall8ed55a52010-09-02 09:58:18 +00001760
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001761 const FunctionProtoType *DeleteFTy =
1762 DeleteFD->getType()->getAs<FunctionProtoType>();
1763
1764 CallArgList DeleteArgs;
1765
Richard Smith5b349582017-10-13 01:55:36 +00001766 auto Params = getUsualDeleteParams(DeleteFD);
Richard Smithb2f0f052016-10-10 18:54:32 +00001767 auto ParamTypeIt = DeleteFTy->param_type_begin();
1768
1769 // Pass the pointer itself.
1770 QualType ArgTy = *ParamTypeIt++;
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001771 llvm::Value *DeletePtr = Builder.CreateBitCast(Ptr, ConvertType(ArgTy));
Eli Friedman43dca6a2011-05-02 17:57:46 +00001772 DeleteArgs.add(RValue::get(DeletePtr), ArgTy);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001773
Richard Smith5b349582017-10-13 01:55:36 +00001774 // Pass the std::destroying_delete tag if present.
1775 if (Params.DestroyingDelete) {
1776 QualType DDTag = *ParamTypeIt++;
1777 // Just pass an 'undef'. We expect the tag type to be an empty struct.
1778 auto *V = llvm::UndefValue::get(getTypes().ConvertType(DDTag));
1779 DeleteArgs.add(RValue::get(V), DDTag);
1780 }
1781
Richard Smithb2f0f052016-10-10 18:54:32 +00001782 // Pass the size if the delete function has a size_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001783 if (Params.Size) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001784 QualType SizeType = *ParamTypeIt++;
1785 CharUnits DeleteTypeSize = getContext().getTypeSizeInChars(DeleteTy);
1786 llvm::Value *Size = llvm::ConstantInt::get(ConvertType(SizeType),
1787 DeleteTypeSize.getQuantity());
1788
1789 // For array new, multiply by the number of elements.
1790 if (NumElements)
1791 Size = Builder.CreateMul(Size, NumElements);
1792
1793 // If there is a cookie, add the cookie size.
1794 if (!CookieSize.isZero())
1795 Size = Builder.CreateAdd(
1796 Size, llvm::ConstantInt::get(SizeTy, CookieSize.getQuantity()));
1797
1798 DeleteArgs.add(RValue::get(Size), SizeType);
1799 }
1800
1801 // Pass the alignment if the delete function has an align_val_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001802 if (Params.Alignment) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001803 QualType AlignValType = *ParamTypeIt++;
1804 CharUnits DeleteTypeAlign = getContext().toCharUnitsFromBits(
1805 getContext().getTypeAlignIfKnown(DeleteTy));
1806 llvm::Value *Align = llvm::ConstantInt::get(ConvertType(AlignValType),
1807 DeleteTypeAlign.getQuantity());
1808 DeleteArgs.add(RValue::get(Align), AlignValType);
1809 }
1810
1811 assert(ParamTypeIt == DeleteFTy->param_type_end() &&
1812 "unknown parameter to usual delete function");
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001813
1814 // Emit the call to delete.
Richard Smith8d0dc312013-07-21 23:12:18 +00001815 EmitNewDeleteCall(*this, DeleteFD, DeleteFTy, DeleteArgs);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001816}
1817
John McCall8ed55a52010-09-02 09:58:18 +00001818namespace {
1819 /// Calls the given 'operator delete' on a single object.
David Blaikie7e70d682015-08-18 22:40:54 +00001820 struct CallObjectDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001821 llvm::Value *Ptr;
1822 const FunctionDecl *OperatorDelete;
1823 QualType ElementType;
1824
1825 CallObjectDelete(llvm::Value *Ptr,
1826 const FunctionDecl *OperatorDelete,
1827 QualType ElementType)
1828 : Ptr(Ptr), OperatorDelete(OperatorDelete), ElementType(ElementType) {}
1829
Craig Topper4f12f102014-03-12 06:41:41 +00001830 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall8ed55a52010-09-02 09:58:18 +00001831 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType);
1832 }
1833 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001834}
John McCall8ed55a52010-09-02 09:58:18 +00001835
David Majnemer0c0b6d92014-10-31 20:09:12 +00001836void
1837CodeGenFunction::pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1838 llvm::Value *CompletePtr,
1839 QualType ElementType) {
1840 EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup, CompletePtr,
1841 OperatorDelete, ElementType);
1842}
1843
Richard Smith5b349582017-10-13 01:55:36 +00001844/// Emit the code for deleting a single object with a destroying operator
1845/// delete. If the element type has a non-virtual destructor, Ptr has already
1846/// been converted to the type of the parameter of 'operator delete'. Otherwise
1847/// Ptr points to an object of the static type.
1848static void EmitDestroyingObjectDelete(CodeGenFunction &CGF,
1849 const CXXDeleteExpr *DE, Address Ptr,
1850 QualType ElementType) {
1851 auto *Dtor = ElementType->getAsCXXRecordDecl()->getDestructor();
1852 if (Dtor && Dtor->isVirtual())
1853 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1854 Dtor);
1855 else
1856 CGF.EmitDeleteCall(DE->getOperatorDelete(), Ptr.getPointer(), ElementType);
1857}
1858
John McCall8ed55a52010-09-02 09:58:18 +00001859/// Emit the code for deleting a single object.
1860static void EmitObjectDelete(CodeGenFunction &CGF,
David Majnemer08681372014-11-01 07:37:17 +00001861 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +00001862 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +00001863 QualType ElementType) {
Ivan Krasind98f5d72016-11-17 00:39:48 +00001864 // C++11 [expr.delete]p3:
1865 // If the static type of the object to be deleted is different from its
1866 // dynamic type, the static type shall be a base class of the dynamic type
1867 // of the object to be deleted and the static type shall have a virtual
1868 // destructor or the behavior is undefined.
1869 CGF.EmitTypeCheck(CodeGenFunction::TCK_MemberCall,
1870 DE->getExprLoc(), Ptr.getPointer(),
1871 ElementType);
1872
Richard Smith5b349582017-10-13 01:55:36 +00001873 const FunctionDecl *OperatorDelete = DE->getOperatorDelete();
1874 assert(!OperatorDelete->isDestroyingOperatorDelete());
1875
John McCall8ed55a52010-09-02 09:58:18 +00001876 // Find the destructor for the type, if applicable. If the
1877 // destructor is virtual, we'll just emit the vcall and return.
Craig Topper8a13c412014-05-21 05:09:00 +00001878 const CXXDestructorDecl *Dtor = nullptr;
John McCall8ed55a52010-09-02 09:58:18 +00001879 if (const RecordType *RT = ElementType->getAs<RecordType>()) {
1880 CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Eli Friedmanb23533d2011-08-02 18:05:30 +00001881 if (RD->hasDefinition() && !RD->hasTrivialDestructor()) {
John McCall8ed55a52010-09-02 09:58:18 +00001882 Dtor = RD->getDestructor();
1883
1884 if (Dtor->isVirtual()) {
Hiroshi Yamauchicb305902019-08-08 18:00:49 +00001885 bool UseVirtualCall = true;
1886 const Expr *Base = DE->getArgument();
1887 if (auto *DevirtualizedDtor =
1888 dyn_cast_or_null<const CXXDestructorDecl>(
1889 Dtor->getDevirtualizedMethod(
1890 Base, CGF.CGM.getLangOpts().AppleKext))) {
1891 UseVirtualCall = false;
1892 const CXXRecordDecl *DevirtualizedClass =
1893 DevirtualizedDtor->getParent();
1894 if (declaresSameEntity(getCXXRecord(Base), DevirtualizedClass)) {
1895 // Devirtualized to the class of the base type (the type of the
1896 // whole expression).
1897 Dtor = DevirtualizedDtor;
1898 } else {
1899 // Devirtualized to some other type. Would need to cast the this
1900 // pointer to that type but we don't have support for that yet, so
1901 // do a virtual call. FIXME: handle the case where it is
1902 // devirtualized to the derived type (the type of the inner
1903 // expression) as in EmitCXXMemberOrOperatorMemberCallExpr.
1904 UseVirtualCall = true;
1905 }
1906 }
1907 if (UseVirtualCall) {
1908 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1909 Dtor);
1910 return;
1911 }
John McCall8ed55a52010-09-02 09:58:18 +00001912 }
1913 }
1914 }
1915
1916 // Make sure that we call delete even if the dtor throws.
John McCalle4df6c82011-01-28 08:37:24 +00001917 // This doesn't have to a conditional cleanup because we're going
1918 // to pop it off in a second.
John McCall8ed55a52010-09-02 09:58:18 +00001919 CGF.EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup,
John McCall7f416cc2015-09-08 08:05:57 +00001920 Ptr.getPointer(),
1921 OperatorDelete, ElementType);
John McCall8ed55a52010-09-02 09:58:18 +00001922
1923 if (Dtor)
1924 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +00001925 /*ForVirtualBase=*/false,
1926 /*Delegating=*/false,
Marco Antognini88559632019-07-22 09:39:13 +00001927 Ptr, ElementType);
John McCall460ce582015-10-22 18:38:17 +00001928 else if (auto Lifetime = ElementType.getObjCLifetime()) {
1929 switch (Lifetime) {
John McCall31168b02011-06-15 23:02:42 +00001930 case Qualifiers::OCL_None:
1931 case Qualifiers::OCL_ExplicitNone:
1932 case Qualifiers::OCL_Autoreleasing:
1933 break;
John McCall8ed55a52010-09-02 09:58:18 +00001934
John McCall7f416cc2015-09-08 08:05:57 +00001935 case Qualifiers::OCL_Strong:
1936 CGF.EmitARCDestroyStrong(Ptr, ARCPreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001937 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00001938
John McCall31168b02011-06-15 23:02:42 +00001939 case Qualifiers::OCL_Weak:
1940 CGF.EmitARCDestroyWeak(Ptr);
1941 break;
1942 }
1943 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001944
John McCall8ed55a52010-09-02 09:58:18 +00001945 CGF.PopCleanupBlock();
1946}
1947
1948namespace {
1949 /// Calls the given 'operator delete' on an array of objects.
David Blaikie7e70d682015-08-18 22:40:54 +00001950 struct CallArrayDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001951 llvm::Value *Ptr;
1952 const FunctionDecl *OperatorDelete;
1953 llvm::Value *NumElements;
1954 QualType ElementType;
1955 CharUnits CookieSize;
1956
1957 CallArrayDelete(llvm::Value *Ptr,
1958 const FunctionDecl *OperatorDelete,
1959 llvm::Value *NumElements,
1960 QualType ElementType,
1961 CharUnits CookieSize)
1962 : Ptr(Ptr), OperatorDelete(OperatorDelete), NumElements(NumElements),
1963 ElementType(ElementType), CookieSize(CookieSize) {}
1964
Craig Topper4f12f102014-03-12 06:41:41 +00001965 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001966 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType, NumElements,
1967 CookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001968 }
1969 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001970}
John McCall8ed55a52010-09-02 09:58:18 +00001971
1972/// Emit the code for deleting an array of objects.
1973static void EmitArrayDelete(CodeGenFunction &CGF,
John McCall284c48f2011-01-27 09:37:56 +00001974 const CXXDeleteExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001975 Address deletedPtr,
John McCallca2c56f2011-07-13 01:41:37 +00001976 QualType elementType) {
Craig Topper8a13c412014-05-21 05:09:00 +00001977 llvm::Value *numElements = nullptr;
1978 llvm::Value *allocatedPtr = nullptr;
John McCallca2c56f2011-07-13 01:41:37 +00001979 CharUnits cookieSize;
1980 CGF.CGM.getCXXABI().ReadArrayCookie(CGF, deletedPtr, E, elementType,
1981 numElements, allocatedPtr, cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001982
John McCallca2c56f2011-07-13 01:41:37 +00001983 assert(allocatedPtr && "ReadArrayCookie didn't set allocated pointer");
John McCall8ed55a52010-09-02 09:58:18 +00001984
1985 // Make sure that we call delete even if one of the dtors throws.
John McCallca2c56f2011-07-13 01:41:37 +00001986 const FunctionDecl *operatorDelete = E->getOperatorDelete();
John McCall8ed55a52010-09-02 09:58:18 +00001987 CGF.EHStack.pushCleanup<CallArrayDelete>(NormalAndEHCleanup,
John McCallca2c56f2011-07-13 01:41:37 +00001988 allocatedPtr, operatorDelete,
1989 numElements, elementType,
1990 cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001991
John McCallca2c56f2011-07-13 01:41:37 +00001992 // Destroy the elements.
1993 if (QualType::DestructionKind dtorKind = elementType.isDestructedType()) {
1994 assert(numElements && "no element count for a type with a destructor!");
1995
John McCall7f416cc2015-09-08 08:05:57 +00001996 CharUnits elementSize = CGF.getContext().getTypeSizeInChars(elementType);
1997 CharUnits elementAlign =
1998 deletedPtr.getAlignment().alignmentOfArrayElement(elementSize);
1999
2000 llvm::Value *arrayBegin = deletedPtr.getPointer();
John McCallca2c56f2011-07-13 01:41:37 +00002001 llvm::Value *arrayEnd =
John McCall7f416cc2015-09-08 08:05:57 +00002002 CGF.Builder.CreateInBoundsGEP(arrayBegin, numElements, "delete.end");
John McCall97eab0a2011-07-13 08:09:46 +00002003
2004 // Note that it is legal to allocate a zero-length array, and we
2005 // can never fold the check away because the length should always
2006 // come from a cookie.
John McCall7f416cc2015-09-08 08:05:57 +00002007 CGF.emitArrayDestroy(arrayBegin, arrayEnd, elementType, elementAlign,
John McCallca2c56f2011-07-13 01:41:37 +00002008 CGF.getDestroyer(dtorKind),
John McCall97eab0a2011-07-13 08:09:46 +00002009 /*checkZeroLength*/ true,
John McCallca2c56f2011-07-13 01:41:37 +00002010 CGF.needsEHCleanup(dtorKind));
John McCall8ed55a52010-09-02 09:58:18 +00002011 }
2012
John McCallca2c56f2011-07-13 01:41:37 +00002013 // Pop the cleanup block.
John McCall8ed55a52010-09-02 09:58:18 +00002014 CGF.PopCleanupBlock();
2015}
2016
Anders Carlssoncc52f652009-09-22 22:53:17 +00002017void CodeGenFunction::EmitCXXDeleteExpr(const CXXDeleteExpr *E) {
Douglas Gregorbb3e12f2009-09-29 18:16:17 +00002018 const Expr *Arg = E->getArgument();
John McCall7f416cc2015-09-08 08:05:57 +00002019 Address Ptr = EmitPointerWithAlignment(Arg);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002020
2021 // Null check the pointer.
2022 llvm::BasicBlock *DeleteNotNull = createBasicBlock("delete.notnull");
2023 llvm::BasicBlock *DeleteEnd = createBasicBlock("delete.end");
2024
John McCall7f416cc2015-09-08 08:05:57 +00002025 llvm::Value *IsNull = Builder.CreateIsNull(Ptr.getPointer(), "isnull");
Anders Carlssoncc52f652009-09-22 22:53:17 +00002026
2027 Builder.CreateCondBr(IsNull, DeleteEnd, DeleteNotNull);
2028 EmitBlock(DeleteNotNull);
Anders Carlssone828c362009-11-13 04:45:41 +00002029
Richard Smith5b349582017-10-13 01:55:36 +00002030 QualType DeleteTy = E->getDestroyedType();
2031
2032 // A destroying operator delete overrides the entire operation of the
2033 // delete expression.
2034 if (E->getOperatorDelete()->isDestroyingOperatorDelete()) {
2035 EmitDestroyingObjectDelete(*this, E, Ptr, DeleteTy);
2036 EmitBlock(DeleteEnd);
2037 return;
2038 }
2039
John McCall8ed55a52010-09-02 09:58:18 +00002040 // We might be deleting a pointer to array. If so, GEP down to the
2041 // first non-array element.
2042 // (this assumes that A(*)[3][7] is converted to [3 x [7 x %A]]*)
John McCall8ed55a52010-09-02 09:58:18 +00002043 if (DeleteTy->isConstantArrayType()) {
2044 llvm::Value *Zero = Builder.getInt32(0);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002045 SmallVector<llvm::Value*,8> GEP;
John McCall8ed55a52010-09-02 09:58:18 +00002046
2047 GEP.push_back(Zero); // point at the outermost array
2048
2049 // For each layer of array type we're pointing at:
2050 while (const ConstantArrayType *Arr
2051 = getContext().getAsConstantArrayType(DeleteTy)) {
2052 // 1. Unpeel the array type.
2053 DeleteTy = Arr->getElementType();
2054
2055 // 2. GEP to the first element of the array.
2056 GEP.push_back(Zero);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002057 }
John McCall8ed55a52010-09-02 09:58:18 +00002058
John McCall7f416cc2015-09-08 08:05:57 +00002059 Ptr = Address(Builder.CreateInBoundsGEP(Ptr.getPointer(), GEP, "del.first"),
2060 Ptr.getAlignment());
Anders Carlssoncc52f652009-09-22 22:53:17 +00002061 }
2062
John McCall7f416cc2015-09-08 08:05:57 +00002063 assert(ConvertTypeForMem(DeleteTy) == Ptr.getElementType());
John McCall8ed55a52010-09-02 09:58:18 +00002064
Reid Kleckner7270ef52015-03-19 17:03:58 +00002065 if (E->isArrayForm()) {
2066 EmitArrayDelete(*this, E, Ptr, DeleteTy);
2067 } else {
2068 EmitObjectDelete(*this, E, Ptr, DeleteTy);
2069 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00002070
Anders Carlssoncc52f652009-09-22 22:53:17 +00002071 EmitBlock(DeleteEnd);
2072}
Mike Stumpc9b231c2009-11-15 08:09:41 +00002073
David Majnemer1c3d95e2014-07-19 00:17:06 +00002074static bool isGLValueFromPointerDeref(const Expr *E) {
2075 E = E->IgnoreParens();
2076
2077 if (const auto *CE = dyn_cast<CastExpr>(E)) {
2078 if (!CE->getSubExpr()->isGLValue())
2079 return false;
2080 return isGLValueFromPointerDeref(CE->getSubExpr());
2081 }
2082
2083 if (const auto *OVE = dyn_cast<OpaqueValueExpr>(E))
2084 return isGLValueFromPointerDeref(OVE->getSourceExpr());
2085
2086 if (const auto *BO = dyn_cast<BinaryOperator>(E))
2087 if (BO->getOpcode() == BO_Comma)
2088 return isGLValueFromPointerDeref(BO->getRHS());
2089
2090 if (const auto *ACO = dyn_cast<AbstractConditionalOperator>(E))
2091 return isGLValueFromPointerDeref(ACO->getTrueExpr()) ||
2092 isGLValueFromPointerDeref(ACO->getFalseExpr());
2093
2094 // C++11 [expr.sub]p1:
2095 // The expression E1[E2] is identical (by definition) to *((E1)+(E2))
2096 if (isa<ArraySubscriptExpr>(E))
2097 return true;
2098
2099 if (const auto *UO = dyn_cast<UnaryOperator>(E))
2100 if (UO->getOpcode() == UO_Deref)
2101 return true;
2102
2103 return false;
2104}
2105
Warren Hunt747e3012014-06-18 21:15:55 +00002106static llvm::Value *EmitTypeidFromVTable(CodeGenFunction &CGF, const Expr *E,
Chris Lattner2192fe52011-07-18 04:24:23 +00002107 llvm::Type *StdTypeInfoPtrTy) {
Anders Carlsson940f02d2011-04-18 00:57:03 +00002108 // Get the vtable pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002109 Address ThisPtr = CGF.EmitLValue(E).getAddress();
Anders Carlsson940f02d2011-04-18 00:57:03 +00002110
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002111 QualType SrcRecordTy = E->getType();
2112
2113 // C++ [class.cdtor]p4:
2114 // If the operand of typeid refers to the object under construction or
2115 // destruction and the static type of the operand is neither the constructor
2116 // or destructor’s class nor one of its bases, the behavior is undefined.
2117 CGF.EmitTypeCheck(CodeGenFunction::TCK_DynamicOperation, E->getExprLoc(),
2118 ThisPtr.getPointer(), SrcRecordTy);
2119
Anders Carlsson940f02d2011-04-18 00:57:03 +00002120 // C++ [expr.typeid]p2:
2121 // If the glvalue expression is obtained by applying the unary * operator to
2122 // a pointer and the pointer is a null pointer value, the typeid expression
2123 // throws the std::bad_typeid exception.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002124 //
2125 // However, this paragraph's intent is not clear. We choose a very generous
2126 // interpretation which implores us to consider comma operators, conditional
2127 // operators, parentheses and other such constructs.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002128 if (CGF.CGM.getCXXABI().shouldTypeidBeNullChecked(
2129 isGLValueFromPointerDeref(E), SrcRecordTy)) {
David Majnemer1162d252014-06-22 19:05:33 +00002130 llvm::BasicBlock *BadTypeidBlock =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002131 CGF.createBasicBlock("typeid.bad_typeid");
David Majnemer1162d252014-06-22 19:05:33 +00002132 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("typeid.end");
Anders Carlsson940f02d2011-04-18 00:57:03 +00002133
John McCall7f416cc2015-09-08 08:05:57 +00002134 llvm::Value *IsNull = CGF.Builder.CreateIsNull(ThisPtr.getPointer());
David Majnemer1162d252014-06-22 19:05:33 +00002135 CGF.Builder.CreateCondBr(IsNull, BadTypeidBlock, EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002136
David Majnemer1162d252014-06-22 19:05:33 +00002137 CGF.EmitBlock(BadTypeidBlock);
2138 CGF.CGM.getCXXABI().EmitBadTypeidCall(CGF);
2139 CGF.EmitBlock(EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002140 }
2141
David Majnemer1162d252014-06-22 19:05:33 +00002142 return CGF.CGM.getCXXABI().EmitTypeid(CGF, SrcRecordTy, ThisPtr,
2143 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002144}
2145
John McCalle4df6c82011-01-28 08:37:24 +00002146llvm::Value *CodeGenFunction::EmitCXXTypeidExpr(const CXXTypeidExpr *E) {
Fangrui Song6907ce22018-07-30 19:24:48 +00002147 llvm::Type *StdTypeInfoPtrTy =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002148 ConvertType(E->getType())->getPointerTo();
Fangrui Song6907ce22018-07-30 19:24:48 +00002149
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002150 if (E->isTypeOperand()) {
David Majnemer143c55e2013-09-27 07:04:31 +00002151 llvm::Constant *TypeInfo =
2152 CGM.GetAddrOfRTTIDescriptor(E->getTypeOperand(getContext()));
Anders Carlsson940f02d2011-04-18 00:57:03 +00002153 return Builder.CreateBitCast(TypeInfo, StdTypeInfoPtrTy);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002154 }
Anders Carlsson0c633502011-04-11 14:13:40 +00002155
Anders Carlsson940f02d2011-04-18 00:57:03 +00002156 // C++ [expr.typeid]p2:
2157 // When typeid is applied to a glvalue expression whose type is a
2158 // polymorphic class type, the result refers to a std::type_info object
2159 // representing the type of the most derived object (that is, the dynamic
2160 // type) to which the glvalue refers.
Richard Smithef8bf432012-08-13 20:08:14 +00002161 if (E->isPotentiallyEvaluated())
Fangrui Song6907ce22018-07-30 19:24:48 +00002162 return EmitTypeidFromVTable(*this, E->getExprOperand(),
Richard Smithef8bf432012-08-13 20:08:14 +00002163 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002164
2165 QualType OperandTy = E->getExprOperand()->getType();
2166 return Builder.CreateBitCast(CGM.GetAddrOfRTTIDescriptor(OperandTy),
2167 StdTypeInfoPtrTy);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002168}
Mike Stump65511702009-11-16 06:50:58 +00002169
Anders Carlssonc1c99712011-04-11 01:45:29 +00002170static llvm::Value *EmitDynamicCastToNull(CodeGenFunction &CGF,
2171 QualType DestTy) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002172 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
Anders Carlssonc1c99712011-04-11 01:45:29 +00002173 if (DestTy->isPointerType())
2174 return llvm::Constant::getNullValue(DestLTy);
2175
2176 /// C++ [expr.dynamic.cast]p9:
2177 /// A failed cast to reference type throws std::bad_cast
David Majnemer1162d252014-06-22 19:05:33 +00002178 if (!CGF.CGM.getCXXABI().EmitBadCastCall(CGF))
2179 return nullptr;
Anders Carlssonc1c99712011-04-11 01:45:29 +00002180
2181 CGF.EmitBlock(CGF.createBasicBlock("dynamic_cast.end"));
2182 return llvm::UndefValue::get(DestLTy);
2183}
2184
John McCall7f416cc2015-09-08 08:05:57 +00002185llvm::Value *CodeGenFunction::EmitDynamicCast(Address ThisAddr,
Mike Stump65511702009-11-16 06:50:58 +00002186 const CXXDynamicCastExpr *DCE) {
Alexey Bataev2bf9b4c2015-10-20 04:24:12 +00002187 CGM.EmitExplicitCastExprType(DCE, this);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002188 QualType DestTy = DCE->getTypeAsWritten();
Anders Carlsson882d7902011-04-11 00:46:40 +00002189
Anders Carlssonc1c99712011-04-11 01:45:29 +00002190 QualType SrcTy = DCE->getSubExpr()->getType();
2191
David Majnemer1162d252014-06-22 19:05:33 +00002192 // C++ [expr.dynamic.cast]p7:
2193 // If T is "pointer to cv void," then the result is a pointer to the most
2194 // derived object pointed to by v.
2195 const PointerType *DestPTy = DestTy->getAs<PointerType>();
2196
2197 bool isDynamicCastToVoid;
2198 QualType SrcRecordTy;
2199 QualType DestRecordTy;
2200 if (DestPTy) {
2201 isDynamicCastToVoid = DestPTy->getPointeeType()->isVoidType();
2202 SrcRecordTy = SrcTy->castAs<PointerType>()->getPointeeType();
2203 DestRecordTy = DestPTy->getPointeeType();
2204 } else {
2205 isDynamicCastToVoid = false;
2206 SrcRecordTy = SrcTy;
2207 DestRecordTy = DestTy->castAs<ReferenceType>()->getPointeeType();
2208 }
2209
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002210 // C++ [class.cdtor]p5:
2211 // If the operand of the dynamic_cast refers to the object under
2212 // construction or destruction and the static type of the operand is not a
2213 // pointer to or object of the constructor or destructor’s own class or one
2214 // of its bases, the dynamic_cast results in undefined behavior.
2215 EmitTypeCheck(TCK_DynamicOperation, DCE->getExprLoc(), ThisAddr.getPointer(),
2216 SrcRecordTy);
2217
2218 if (DCE->isAlwaysNull())
2219 if (llvm::Value *T = EmitDynamicCastToNull(*this, DestTy))
2220 return T;
2221
David Majnemer1162d252014-06-22 19:05:33 +00002222 assert(SrcRecordTy->isRecordType() && "source type must be a record type!");
2223
Fangrui Song6907ce22018-07-30 19:24:48 +00002224 // C++ [expr.dynamic.cast]p4:
Anders Carlsson882d7902011-04-11 00:46:40 +00002225 // If the value of v is a null pointer value in the pointer case, the result
2226 // is the null pointer value of type T.
David Majnemer1162d252014-06-22 19:05:33 +00002227 bool ShouldNullCheckSrcValue =
2228 CGM.getCXXABI().shouldDynamicCastCallBeNullChecked(SrcTy->isPointerType(),
2229 SrcRecordTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002230
2231 llvm::BasicBlock *CastNull = nullptr;
2232 llvm::BasicBlock *CastNotNull = nullptr;
Anders Carlsson882d7902011-04-11 00:46:40 +00002233 llvm::BasicBlock *CastEnd = createBasicBlock("dynamic_cast.end");
Fangrui Song6907ce22018-07-30 19:24:48 +00002234
Anders Carlsson882d7902011-04-11 00:46:40 +00002235 if (ShouldNullCheckSrcValue) {
2236 CastNull = createBasicBlock("dynamic_cast.null");
2237 CastNotNull = createBasicBlock("dynamic_cast.notnull");
2238
John McCall7f416cc2015-09-08 08:05:57 +00002239 llvm::Value *IsNull = Builder.CreateIsNull(ThisAddr.getPointer());
Anders Carlsson882d7902011-04-11 00:46:40 +00002240 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
2241 EmitBlock(CastNotNull);
Mike Stump65511702009-11-16 06:50:58 +00002242 }
2243
John McCall7f416cc2015-09-08 08:05:57 +00002244 llvm::Value *Value;
David Majnemer1162d252014-06-22 19:05:33 +00002245 if (isDynamicCastToVoid) {
John McCall7f416cc2015-09-08 08:05:57 +00002246 Value = CGM.getCXXABI().EmitDynamicCastToVoid(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002247 DestTy);
2248 } else {
2249 assert(DestRecordTy->isRecordType() &&
2250 "destination type must be a record type!");
John McCall7f416cc2015-09-08 08:05:57 +00002251 Value = CGM.getCXXABI().EmitDynamicCastCall(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002252 DestTy, DestRecordTy, CastEnd);
David Majnemer67528ea2015-11-23 03:01:14 +00002253 CastNotNull = Builder.GetInsertBlock();
David Majnemer1162d252014-06-22 19:05:33 +00002254 }
Anders Carlsson882d7902011-04-11 00:46:40 +00002255
2256 if (ShouldNullCheckSrcValue) {
2257 EmitBranch(CastEnd);
2258
2259 EmitBlock(CastNull);
2260 EmitBranch(CastEnd);
2261 }
2262
2263 EmitBlock(CastEnd);
2264
2265 if (ShouldNullCheckSrcValue) {
2266 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
2267 PHI->addIncoming(Value, CastNotNull);
2268 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
2269
2270 Value = PHI;
2271 }
2272
2273 return Value;
Mike Stump65511702009-11-16 06:50:58 +00002274}