blob: e5cc22a119637610e26b8725aa196d4e508b77c7 [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
13#include "CodeGenFunction.h"
Peter Collingbournefe883422011-10-06 18:29:37 +000014#include "CGCUDARuntime.h"
John McCall5d865c322010-08-31 07:33:07 +000015#include "CGCXXABI.h"
Devang Patel91bbb552010-09-30 19:05:55 +000016#include "CGDebugInfo.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "CGObjCRuntime.h"
John McCallde0fe072017-08-15 21:42:52 +000018#include "ConstantEmitter.h"
Richard Trieu63688182018-12-11 03:18:39 +000019#include "clang/Basic/CodeGenOptions.h"
Mark Laceya8e7df32013-10-30 21:53:58 +000020#include "clang/CodeGen/CGFunctionInfo.h"
Chandler Carruthffd55512013-01-02 11:45:17 +000021#include "llvm/IR/Intrinsics.h"
Anders Carlssonbbe277c2011-04-13 02:35:36 +000022
Anders Carlssoncc52f652009-09-22 22:53:17 +000023using namespace clang;
24using namespace CodeGen;
25
George Burgess IVd0a9e802017-02-23 22:07:35 +000026namespace {
27struct MemberCallInfo {
28 RequiredArgs ReqArgs;
29 // Number of prefix arguments for the call. Ignores the `this` pointer.
30 unsigned PrefixSize;
31};
32}
33
34static MemberCallInfo
Alexey Samsonovefa956c2016-03-10 00:20:33 +000035commonEmitCXXMemberOrOperatorCall(CodeGenFunction &CGF, const CXXMethodDecl *MD,
36 llvm::Value *This, llvm::Value *ImplicitParam,
37 QualType ImplicitParamTy, const CallExpr *CE,
Richard Smith762672a2016-09-28 19:09:10 +000038 CallArgList &Args, CallArgList *RtlArgs) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000039 assert(CE == nullptr || isa<CXXMemberCallExpr>(CE) ||
40 isa<CXXOperatorCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +000041 assert(MD->isInstance() &&
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000042 "Trying to emit a member or operator call expr on a static method!");
Anders Carlsson27da15b2010-01-01 20:29:01 +000043
Anders Carlsson27da15b2010-01-01 20:29:01 +000044 // Push the this ptr.
Reid Kleckner034e7272016-09-07 15:15:51 +000045 const CXXRecordDecl *RD =
46 CGF.CGM.getCXXABI().getThisArgumentTypeForMethod(MD);
James Y Knightb92d2902019-02-05 16:05:50 +000047 Args.add(RValue::get(This), CGF.getTypes().DeriveThisType(RD, MD));
Anders Carlsson27da15b2010-01-01 20:29:01 +000048
Timur Iskhodzhanovee6bc532013-02-13 08:37:51 +000049 // If there is an implicit parameter (e.g. VTT), emit it.
50 if (ImplicitParam) {
51 Args.add(RValue::get(ImplicitParam), ImplicitParamTy);
Anders Carlssone36a6b32010-01-02 01:01:18 +000052 }
John McCalla729c622012-02-17 03:33:10 +000053
54 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
James Y Knight916db652019-02-02 01:48:23 +000055 RequiredArgs required = RequiredArgs::forPrototypePlus(FPT, Args.size());
George Burgess IVd0a9e802017-02-23 22:07:35 +000056 unsigned PrefixSize = Args.size() - 1;
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000057
John McCalla729c622012-02-17 03:33:10 +000058 // And the rest of the call args.
Richard Smith762672a2016-09-28 19:09:10 +000059 if (RtlArgs) {
60 // Special case: if the caller emitted the arguments right-to-left already
61 // (prior to emitting the *this argument), we're done. This happens for
62 // assignment operators.
63 Args.addFrom(*RtlArgs);
64 } else if (CE) {
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000065 // Special case: skip first argument of CXXOperatorCall (it is "this").
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000066 unsigned ArgsToSkip = isa<CXXOperatorCallExpr>(CE) ? 1 : 0;
David Blaikief05779e2015-07-21 18:37:18 +000067 CGF.EmitCallArgs(Args, FPT, drop_begin(CE->arguments(), ArgsToSkip),
David Majnemer0c0b6d92014-10-31 20:09:12 +000068 CE->getDirectCallee());
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000069 } else {
Alexey Samsonov8e1162c2014-09-08 17:22:45 +000070 assert(
71 FPT->getNumParams() == 0 &&
72 "No CallExpr specified for function with non-zero number of arguments");
Alexey Samsonova5bf76b2014-08-25 20:17:35 +000073 }
George Burgess IVd0a9e802017-02-23 22:07:35 +000074 return {required, PrefixSize};
David Majnemer0c0b6d92014-10-31 20:09:12 +000075}
Anders Carlsson27da15b2010-01-01 20:29:01 +000076
David Majnemer0c0b6d92014-10-31 20:09:12 +000077RValue CodeGenFunction::EmitCXXMemberOrOperatorCall(
John McCallb92ab1a2016-10-26 23:46:34 +000078 const CXXMethodDecl *MD, const CGCallee &Callee,
79 ReturnValueSlot ReturnValue,
David Majnemer0c0b6d92014-10-31 20:09:12 +000080 llvm::Value *This, llvm::Value *ImplicitParam, QualType ImplicitParamTy,
Richard Smith762672a2016-09-28 19:09:10 +000081 const CallExpr *CE, CallArgList *RtlArgs) {
David Majnemer0c0b6d92014-10-31 20:09:12 +000082 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
83 CallArgList Args;
George Burgess IVd0a9e802017-02-23 22:07:35 +000084 MemberCallInfo CallInfo = commonEmitCXXMemberOrOperatorCall(
Richard Smith762672a2016-09-28 19:09:10 +000085 *this, MD, This, ImplicitParam, ImplicitParamTy, CE, Args, RtlArgs);
George Burgess IVd0a9e802017-02-23 22:07:35 +000086 auto &FnInfo = CGM.getTypes().arrangeCXXMethodCall(
87 Args, FPT, CallInfo.ReqArgs, CallInfo.PrefixSize);
Vedant Kumar09b5bfd2017-12-21 00:10:25 +000088 return EmitCall(FnInfo, Callee, ReturnValue, Args, nullptr,
89 CE ? CE->getExprLoc() : SourceLocation());
Anders Carlsson27da15b2010-01-01 20:29:01 +000090}
91
Alexey Samsonovae81bbb2016-03-10 00:20:37 +000092RValue CodeGenFunction::EmitCXXDestructorCall(
John McCallb92ab1a2016-10-26 23:46:34 +000093 const CXXDestructorDecl *DD, const CGCallee &Callee, llvm::Value *This,
Alexey Samsonovae81bbb2016-03-10 00:20:37 +000094 llvm::Value *ImplicitParam, QualType ImplicitParamTy, const CallExpr *CE,
95 StructorType Type) {
David Majnemer0c0b6d92014-10-31 20:09:12 +000096 CallArgList Args;
Alexey Samsonovae81bbb2016-03-10 00:20:37 +000097 commonEmitCXXMemberOrOperatorCall(*this, DD, This, ImplicitParam,
Richard Smith762672a2016-09-28 19:09:10 +000098 ImplicitParamTy, CE, Args, nullptr);
Alexey Samsonovae81bbb2016-03-10 00:20:37 +000099 return EmitCall(CGM.getTypes().arrangeCXXStructorDeclaration(DD, Type),
John McCallb92ab1a2016-10-26 23:46:34 +0000100 Callee, ReturnValueSlot(), Args);
101}
102
103RValue CodeGenFunction::EmitCXXPseudoDestructorExpr(
104 const CXXPseudoDestructorExpr *E) {
105 QualType DestroyedType = E->getDestroyedType();
106 if (DestroyedType.hasStrongOrWeakObjCLifetime()) {
107 // Automatic Reference Counting:
108 // If the pseudo-expression names a retainable object with weak or
109 // strong lifetime, the object shall be released.
110 Expr *BaseExpr = E->getBase();
111 Address BaseValue = Address::invalid();
112 Qualifiers BaseQuals;
113
114 // If this is s.x, emit s as an lvalue. If it is s->x, emit s as a scalar.
115 if (E->isArrow()) {
116 BaseValue = EmitPointerWithAlignment(BaseExpr);
117 const PointerType *PTy = BaseExpr->getType()->getAs<PointerType>();
118 BaseQuals = PTy->getPointeeType().getQualifiers();
119 } else {
120 LValue BaseLV = EmitLValue(BaseExpr);
121 BaseValue = BaseLV.getAddress();
122 QualType BaseTy = BaseExpr->getType();
123 BaseQuals = BaseTy.getQualifiers();
124 }
125
126 switch (DestroyedType.getObjCLifetime()) {
127 case Qualifiers::OCL_None:
128 case Qualifiers::OCL_ExplicitNone:
129 case Qualifiers::OCL_Autoreleasing:
130 break;
131
132 case Qualifiers::OCL_Strong:
133 EmitARCRelease(Builder.CreateLoad(BaseValue,
134 DestroyedType.isVolatileQualified()),
135 ARCPreciseLifetime);
136 break;
137
138 case Qualifiers::OCL_Weak:
139 EmitARCDestroyWeak(BaseValue);
140 break;
141 }
142 } else {
143 // C++ [expr.pseudo]p1:
144 // The result shall only be used as the operand for the function call
145 // operator (), and the result of such a call has type void. The only
146 // effect is the evaluation of the postfix-expression before the dot or
147 // arrow.
148 EmitIgnoredExpr(E->getBase());
149 }
150
151 return RValue::get(nullptr);
David Majnemer0c0b6d92014-10-31 20:09:12 +0000152}
153
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000154static CXXRecordDecl *getCXXRecord(const Expr *E) {
155 QualType T = E->getType();
156 if (const PointerType *PTy = T->getAs<PointerType>())
157 T = PTy->getPointeeType();
158 const RecordType *Ty = T->castAs<RecordType>();
159 return cast<CXXRecordDecl>(Ty->getDecl());
160}
161
Francois Pichet64225792011-01-18 05:04:39 +0000162// Note: This function also emit constructor calls to support a MSVC
163// extensions allowing explicit constructor function call.
Anders Carlsson27da15b2010-01-01 20:29:01 +0000164RValue CodeGenFunction::EmitCXXMemberCallExpr(const CXXMemberCallExpr *CE,
165 ReturnValueSlot ReturnValue) {
John McCall2d2e8702011-04-11 07:02:50 +0000166 const Expr *callee = CE->getCallee()->IgnoreParens();
167
168 if (isa<BinaryOperator>(callee))
Anders Carlsson27da15b2010-01-01 20:29:01 +0000169 return EmitCXXMemberPointerCallExpr(CE, ReturnValue);
John McCall2d2e8702011-04-11 07:02:50 +0000170
171 const MemberExpr *ME = cast<MemberExpr>(callee);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000172 const CXXMethodDecl *MD = cast<CXXMethodDecl>(ME->getMemberDecl());
173
174 if (MD->isStatic()) {
175 // The method is static, emit it as we would a regular call.
Erich Keanede6480a32018-11-13 15:48:08 +0000176 CGCallee callee =
177 CGCallee::forDirect(CGM.GetAddrOfFunction(MD), GlobalDecl(MD));
John McCallb92ab1a2016-10-26 23:46:34 +0000178 return EmitCall(getContext().getPointerType(MD->getType()), callee, CE,
Alexey Samsonov70b9c012014-08-21 20:26:47 +0000179 ReturnValue);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000180 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000181
Nico Weberaad4af62014-12-03 01:21:41 +0000182 bool HasQualifier = ME->hasQualifier();
183 NestedNameSpecifier *Qualifier = HasQualifier ? ME->getQualifier() : nullptr;
184 bool IsArrow = ME->isArrow();
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000185 const Expr *Base = ME->getBase();
Nico Weberaad4af62014-12-03 01:21:41 +0000186
187 return EmitCXXMemberOrOperatorMemberCallExpr(
188 CE, MD, ReturnValue, HasQualifier, Qualifier, IsArrow, Base);
189}
190
191RValue CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(
192 const CallExpr *CE, const CXXMethodDecl *MD, ReturnValueSlot ReturnValue,
193 bool HasQualifier, NestedNameSpecifier *Qualifier, bool IsArrow,
194 const Expr *Base) {
195 assert(isa<CXXMemberCallExpr>(CE) || isa<CXXOperatorCallExpr>(CE));
196
197 // Compute the object pointer.
198 bool CanUseVirtualCall = MD->isVirtual() && !HasQualifier;
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000199
Craig Topper8a13c412014-05-21 05:09:00 +0000200 const CXXMethodDecl *DevirtualizedMethod = nullptr;
Akira Hatanaka22461672017-07-13 06:08:27 +0000201 if (CanUseVirtualCall &&
202 MD->getDevirtualizedMethod(Base, getLangOpts().AppleKext)) {
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000203 const CXXRecordDecl *BestDynamicDecl = Base->getBestDynamicClassType();
204 DevirtualizedMethod = MD->getCorrespondingMethodInClass(BestDynamicDecl);
205 assert(DevirtualizedMethod);
206 const CXXRecordDecl *DevirtualizedClass = DevirtualizedMethod->getParent();
207 const Expr *Inner = Base->ignoreParenBaseCasts();
Alexey Bataev5bd68792014-09-29 10:32:21 +0000208 if (DevirtualizedMethod->getReturnType().getCanonicalType() !=
209 MD->getReturnType().getCanonicalType())
210 // If the return types are not the same, this might be a case where more
211 // code needs to run to compensate for it. For example, the derived
212 // method might return a type that inherits form from the return
213 // type of MD and has a prefix.
214 // For now we just avoid devirtualizing these covariant cases.
215 DevirtualizedMethod = nullptr;
216 else if (getCXXRecord(Inner) == DevirtualizedClass)
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000217 // If the class of the Inner expression is where the dynamic method
218 // is defined, build the this pointer from it.
219 Base = Inner;
220 else if (getCXXRecord(Base) != DevirtualizedClass) {
221 // If the method is defined in a class that is not the best dynamic
222 // one or the one of the full expression, we would have to build
223 // a derived-to-base cast to compute the correct this pointer, but
224 // we don't have support for that yet, so do a virtual call.
Craig Topper8a13c412014-05-21 05:09:00 +0000225 DevirtualizedMethod = nullptr;
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000226 }
227 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000228
Richard Smith762672a2016-09-28 19:09:10 +0000229 // C++17 demands that we evaluate the RHS of a (possibly-compound) assignment
230 // operator before the LHS.
231 CallArgList RtlArgStorage;
232 CallArgList *RtlArgs = nullptr;
233 if (auto *OCE = dyn_cast<CXXOperatorCallExpr>(CE)) {
234 if (OCE->isAssignmentOp()) {
235 RtlArgs = &RtlArgStorage;
236 EmitCallArgs(*RtlArgs, MD->getType()->castAs<FunctionProtoType>(),
237 drop_begin(CE->arguments(), 1), CE->getDirectCallee(),
Richard Smitha560ccf2016-09-29 21:30:12 +0000238 /*ParamsToSkip*/0, EvaluationOrder::ForceRightToLeft);
Richard Smith762672a2016-09-28 19:09:10 +0000239 }
240 }
241
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000242 LValue This;
243 if (IsArrow) {
244 LValueBaseInfo BaseInfo;
245 TBAAAccessInfo TBAAInfo;
246 Address ThisValue = EmitPointerWithAlignment(Base, &BaseInfo, &TBAAInfo);
247 This = MakeAddrLValue(ThisValue, Base->getType(), BaseInfo, TBAAInfo);
248 } else {
249 This = EmitLValue(Base);
250 }
Rafael Espindolaecbe2e92012-06-28 01:56:38 +0000251
James Y Knightab4f7f12019-02-06 00:06:03 +0000252 if (const CXXConstructorDecl *Ctor = dyn_cast<CXXConstructorDecl>(MD)) {
253 // This is the MSVC p->Ctor::Ctor(...) extension. We assume that's
254 // constructing a new complete object of type Ctor.
255 assert(!RtlArgs);
256 assert(ReturnValue.isNull() && "Constructor shouldn't have return value");
257 CallArgList Args;
258 commonEmitCXXMemberOrOperatorCall(
259 *this, Ctor, This.getPointer(), /*ImplicitParam=*/nullptr,
260 /*ImplicitParamTy=*/QualType(), CE, Args, nullptr);
261
262 EmitCXXConstructorCall(Ctor, Ctor_Complete, /*ForVirtualBase=*/false,
263 /*Delegating=*/false, This.getAddress(), Args,
264 AggValueSlot::DoesNotOverlap, CE->getExprLoc(),
265 /*NewPointerIsChecked=*/false);
266 return RValue::get(nullptr);
267 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000268
Richard Smith419bd092015-04-29 19:26:57 +0000269 if (MD->isTrivial() || (MD->isDefaulted() && MD->getParent()->isUnion())) {
Craig Topper8a13c412014-05-21 05:09:00 +0000270 if (isa<CXXDestructorDecl>(MD)) return RValue::get(nullptr);
Nico Weberaad4af62014-12-03 01:21:41 +0000271 if (!MD->getParent()->mayInsertExtraPadding()) {
272 if (MD->isCopyAssignmentOperator() || MD->isMoveAssignmentOperator()) {
273 // We don't like to generate the trivial copy/move assignment operator
274 // when it isn't necessary; just produce the proper effect here.
Richard Smith762672a2016-09-28 19:09:10 +0000275 LValue RHS = isa<CXXOperatorCallExpr>(CE)
276 ? MakeNaturalAlignAddrLValue(
Yaxun Liu5b330e82018-03-15 15:25:19 +0000277 (*RtlArgs)[0].getRValue(*this).getScalarVal(),
Richard Smith762672a2016-09-28 19:09:10 +0000278 (*(CE->arg_begin() + 1))->getType())
279 : EmitLValue(*CE->arg_begin());
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000280 EmitAggregateAssign(This, RHS, CE->getType());
John McCall7f416cc2015-09-08 08:05:57 +0000281 return RValue::get(This.getPointer());
Nico Weberaad4af62014-12-03 01:21:41 +0000282 }
Nico Weberaad4af62014-12-03 01:21:41 +0000283 llvm_unreachable("unknown trivial member function");
Francois Pichet64225792011-01-18 05:04:39 +0000284 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000285 }
286
John McCall0d635f52010-09-03 01:26:39 +0000287 // Compute the function type we're calling.
Nico Weber3abfe952014-12-02 20:41:18 +0000288 const CXXMethodDecl *CalleeDecl =
289 DevirtualizedMethod ? DevirtualizedMethod : MD;
Craig Topper8a13c412014-05-21 05:09:00 +0000290 const CGFunctionInfo *FInfo = nullptr;
Nico Weber3abfe952014-12-02 20:41:18 +0000291 if (const auto *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl))
Rafael Espindola8d2a19b2014-09-08 16:01:27 +0000292 FInfo = &CGM.getTypes().arrangeCXXStructorDeclaration(
293 Dtor, StructorType::Complete);
Francois Pichet64225792011-01-18 05:04:39 +0000294 else
Eli Friedmanade60972012-10-25 00:12:49 +0000295 FInfo = &CGM.getTypes().arrangeCXXMethodDeclaration(CalleeDecl);
John McCall0d635f52010-09-03 01:26:39 +0000296
Reid Klecknere7de47e2013-07-22 13:51:44 +0000297 llvm::FunctionType *Ty = CGM.getTypes().GetFunctionType(*FInfo);
John McCall0d635f52010-09-03 01:26:39 +0000298
Ivan Krasind98f5d72016-11-17 00:39:48 +0000299 // C++11 [class.mfct.non-static]p2:
300 // If a non-static member function of a class X is called for an object that
301 // is not of type X, or of a type derived from X, the behavior is undefined.
302 SourceLocation CallLoc;
303 ASTContext &C = getContext();
304 if (CE)
305 CallLoc = CE->getExprLoc();
306
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000307 SanitizerSet SkippedChecks;
Vedant Kumarffd7c882017-04-14 22:03:34 +0000308 if (const auto *CMCE = dyn_cast<CXXMemberCallExpr>(CE)) {
309 auto *IOA = CMCE->getImplicitObjectArgument();
310 bool IsImplicitObjectCXXThis = IsWrappedCXXThis(IOA);
311 if (IsImplicitObjectCXXThis)
312 SkippedChecks.set(SanitizerKind::Alignment, true);
313 if (IsImplicitObjectCXXThis || isa<DeclRefExpr>(IOA))
Vedant Kumar34b1fd62017-02-17 23:22:59 +0000314 SkippedChecks.set(SanitizerKind::Null, true);
Vedant Kumarffd7c882017-04-14 22:03:34 +0000315 }
James Y Knightab4f7f12019-02-06 00:06:03 +0000316 EmitTypeCheck(CodeGenFunction::TCK_MemberCall, CallLoc, This.getPointer(),
317 C.getRecordType(CalleeDecl->getParent()),
318 /*Alignment=*/CharUnits::Zero(), SkippedChecks);
Ivan Krasind98f5d72016-11-17 00:39:48 +0000319
Anders Carlsson27da15b2010-01-01 20:29:01 +0000320 // C++ [class.virtual]p12:
321 // Explicit qualification with the scope operator (5.1) suppresses the
322 // virtual call mechanism.
323 //
324 // We also don't emit a virtual call if the base expression has a record type
325 // because then we know what the type is.
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000326 bool UseVirtualCall = CanUseVirtualCall && !DevirtualizedMethod;
Fangrui Song6907ce22018-07-30 19:24:48 +0000327
James Y Knightb92d2902019-02-05 16:05:50 +0000328 if (const CXXDestructorDecl *Dtor = dyn_cast<CXXDestructorDecl>(CalleeDecl)) {
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000329 assert(CE->arg_begin() == CE->arg_end() &&
330 "Destructor shouldn't have explicit parameters");
331 assert(ReturnValue.isNull() && "Destructor shouldn't have return value");
John McCall0d635f52010-09-03 01:26:39 +0000332 if (UseVirtualCall) {
Nico Weberaad4af62014-12-03 01:21:41 +0000333 CGM.getCXXABI().EmitVirtualDestructorCall(
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000334 *this, Dtor, Dtor_Complete, This.getAddress(),
335 cast<CXXMemberCallExpr>(CE));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000336 } else {
John McCallb92ab1a2016-10-26 23:46:34 +0000337 CGCallee Callee;
James Y Knightb92d2902019-02-05 16:05:50 +0000338 if (getLangOpts().AppleKext && Dtor->isVirtual() && HasQualifier)
339 Callee = BuildAppleKextVirtualCall(Dtor, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000340 else if (!DevirtualizedMethod)
John McCallb92ab1a2016-10-26 23:46:34 +0000341 Callee = CGCallee::forDirect(
342 CGM.getAddrOfCXXStructor(Dtor, StructorType::Complete, FInfo, Ty),
Erich Keanede6480a32018-11-13 15:48:08 +0000343 GlobalDecl(Dtor, Dtor_Complete));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000344 else {
John McCallb92ab1a2016-10-26 23:46:34 +0000345 Callee = CGCallee::forDirect(
James Y Knightb92d2902019-02-05 16:05:50 +0000346 CGM.GetAddrOfFunction(GlobalDecl(Dtor, Dtor_Complete), Ty),
347 GlobalDecl(Dtor, Dtor_Complete));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000348 }
James Y Knightb92d2902019-02-05 16:05:50 +0000349
350 EmitCXXDestructorCall(Dtor, Callee, This.getPointer(),
351 /*ImplicitParam=*/nullptr,
352 /*ImplicitParamTy=*/QualType(), nullptr,
353 getFromDtorType(Dtor_Complete));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000354 }
Craig Topper8a13c412014-05-21 05:09:00 +0000355 return RValue::get(nullptr);
Stephen Lin9dc6eef2013-06-30 20:40:16 +0000356 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000357
James Y Knightb92d2902019-02-05 16:05:50 +0000358 // FIXME: Uses of 'MD' past this point need to be audited. We may need to use
359 // 'CalleeDecl' instead.
360
John McCallb92ab1a2016-10-26 23:46:34 +0000361 CGCallee Callee;
James Y Knightab4f7f12019-02-06 00:06:03 +0000362 if (UseVirtualCall) {
Peter Collingbourneea211002018-02-05 23:09:13 +0000363 Callee = CGCallee::forVirtual(CE, MD, This.getAddress(), Ty);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000364 } else {
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000365 if (SanOpts.has(SanitizerKind::CFINVCall) &&
366 MD->getParent()->isDynamicClass()) {
Peter Collingbourne60108802017-12-13 21:53:04 +0000367 llvm::Value *VTable;
368 const CXXRecordDecl *RD;
369 std::tie(VTable, RD) =
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000370 CGM.getCXXABI().LoadVTablePtr(*this, This.getAddress(),
371 MD->getParent());
Stephen Kellyf2ceec42018-08-09 21:08:08 +0000372 EmitVTablePtrCheckForCall(RD, VTable, CFITCK_NVCall, CE->getBeginLoc());
Peter Collingbourne1a7488a2015-04-02 00:23:30 +0000373 }
374
Nico Weberaad4af62014-12-03 01:21:41 +0000375 if (getLangOpts().AppleKext && MD->isVirtual() && HasQualifier)
376 Callee = BuildAppleKextVirtualCall(MD, Qualifier, Ty);
Rafael Espindola3b33c4e2012-06-28 14:28:57 +0000377 else if (!DevirtualizedMethod)
Erich Keanede6480a32018-11-13 15:48:08 +0000378 Callee =
379 CGCallee::forDirect(CGM.GetAddrOfFunction(MD, Ty), GlobalDecl(MD));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000380 else {
Erich Keanede6480a32018-11-13 15:48:08 +0000381 Callee =
382 CGCallee::forDirect(CGM.GetAddrOfFunction(DevirtualizedMethod, Ty),
383 GlobalDecl(DevirtualizedMethod));
Rafael Espindola49e860b2012-06-26 17:45:31 +0000384 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000385 }
386
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000387 if (MD->isVirtual()) {
Ivan A. Kosarev1860b522018-01-25 14:21:55 +0000388 Address NewThisAddr =
389 CGM.getCXXABI().adjustThisArgumentForVirtualFunctionCall(
390 *this, CalleeDecl, This.getAddress(), UseVirtualCall);
391 This.setAddress(NewThisAddr);
Timur Iskhodzhanovf1749422014-03-14 17:43:37 +0000392 }
Timur Iskhodzhanov88fd4392013-08-21 06:25:03 +0000393
Vedant Kumar018f2662016-10-19 20:21:16 +0000394 return EmitCXXMemberOrOperatorCall(
395 CalleeDecl, Callee, ReturnValue, This.getPointer(),
396 /*ImplicitParam=*/nullptr, QualType(), CE, RtlArgs);
Anders Carlsson27da15b2010-01-01 20:29:01 +0000397}
398
399RValue
400CodeGenFunction::EmitCXXMemberPointerCallExpr(const CXXMemberCallExpr *E,
401 ReturnValueSlot ReturnValue) {
402 const BinaryOperator *BO =
403 cast<BinaryOperator>(E->getCallee()->IgnoreParens());
404 const Expr *BaseExpr = BO->getLHS();
405 const Expr *MemFnExpr = BO->getRHS();
Fangrui Song6907ce22018-07-30 19:24:48 +0000406
407 const MemberPointerType *MPT =
John McCall0009fcc2011-04-26 20:42:42 +0000408 MemFnExpr->getType()->castAs<MemberPointerType>();
John McCall475999d2010-08-22 00:05:51 +0000409
Fangrui Song6907ce22018-07-30 19:24:48 +0000410 const FunctionProtoType *FPT =
John McCall0009fcc2011-04-26 20:42:42 +0000411 MPT->getPointeeType()->castAs<FunctionProtoType>();
Fangrui Song6907ce22018-07-30 19:24:48 +0000412 const CXXRecordDecl *RD =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000413 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
414
Anders Carlsson27da15b2010-01-01 20:29:01 +0000415 // Emit the 'this' pointer.
John McCall7f416cc2015-09-08 08:05:57 +0000416 Address This = Address::invalid();
John McCalle3027922010-08-25 11:45:40 +0000417 if (BO->getOpcode() == BO_PtrMemI)
John McCall7f416cc2015-09-08 08:05:57 +0000418 This = EmitPointerWithAlignment(BaseExpr);
Fangrui Song6907ce22018-07-30 19:24:48 +0000419 else
Anders Carlsson27da15b2010-01-01 20:29:01 +0000420 This = EmitLValue(BaseExpr).getAddress();
Anders Carlsson27da15b2010-01-01 20:29:01 +0000421
John McCall7f416cc2015-09-08 08:05:57 +0000422 EmitTypeCheck(TCK_MemberCall, E->getExprLoc(), This.getPointer(),
Richard Smithe30752c2012-10-09 19:52:38 +0000423 QualType(MPT->getClass(), 0));
Richard Smith69d0d262012-08-24 00:54:33 +0000424
Richard Smithbde62d72016-09-26 23:56:57 +0000425 // Get the member function pointer.
426 llvm::Value *MemFnPtr = EmitScalarExpr(MemFnExpr);
427
John McCall475999d2010-08-22 00:05:51 +0000428 // Ask the ABI to load the callee. Note that This is modified.
John McCall7f416cc2015-09-08 08:05:57 +0000429 llvm::Value *ThisPtrForCall = nullptr;
John McCallb92ab1a2016-10-26 23:46:34 +0000430 CGCallee Callee =
John McCall7f416cc2015-09-08 08:05:57 +0000431 CGM.getCXXABI().EmitLoadOfMemberFunctionPointer(*this, BO, This,
432 ThisPtrForCall, MemFnPtr, MPT);
Fangrui Song6907ce22018-07-30 19:24:48 +0000433
Anders Carlsson27da15b2010-01-01 20:29:01 +0000434 CallArgList Args;
435
Fangrui Song6907ce22018-07-30 19:24:48 +0000436 QualType ThisType =
Anders Carlsson27da15b2010-01-01 20:29:01 +0000437 getContext().getPointerType(getContext().getTagDeclType(RD));
438
439 // Push the this ptr.
John McCall7f416cc2015-09-08 08:05:57 +0000440 Args.add(RValue::get(ThisPtrForCall), ThisType);
John McCall8dda7b22012-07-07 06:41:13 +0000441
James Y Knight916db652019-02-02 01:48:23 +0000442 RequiredArgs required = RequiredArgs::forPrototypePlus(FPT, 1);
George Burgess IV419996c2016-06-16 23:06:04 +0000443
Anders Carlsson27da15b2010-01-01 20:29:01 +0000444 // And the rest of the call args
George Burgess IV419996c2016-06-16 23:06:04 +0000445 EmitCallArgs(Args, FPT, E->arguments());
George Burgess IVd0a9e802017-02-23 22:07:35 +0000446 return EmitCall(CGM.getTypes().arrangeCXXMethodCall(Args, FPT, required,
447 /*PrefixSize=*/0),
Vedant Kumar09b5bfd2017-12-21 00:10:25 +0000448 Callee, ReturnValue, Args, nullptr, E->getExprLoc());
Anders Carlsson27da15b2010-01-01 20:29:01 +0000449}
450
451RValue
452CodeGenFunction::EmitCXXOperatorMemberCallExpr(const CXXOperatorCallExpr *E,
453 const CXXMethodDecl *MD,
454 ReturnValueSlot ReturnValue) {
455 assert(MD->isInstance() &&
456 "Trying to emit a member call expr on a static method!");
Nico Weberaad4af62014-12-03 01:21:41 +0000457 return EmitCXXMemberOrOperatorMemberCallExpr(
458 E, MD, ReturnValue, /*HasQualifier=*/false, /*Qualifier=*/nullptr,
459 /*IsArrow=*/false, E->getArg(0));
Anders Carlsson27da15b2010-01-01 20:29:01 +0000460}
461
Peter Collingbournefe883422011-10-06 18:29:37 +0000462RValue CodeGenFunction::EmitCUDAKernelCallExpr(const CUDAKernelCallExpr *E,
463 ReturnValueSlot ReturnValue) {
464 return CGM.getCUDARuntime().EmitCUDAKernelCallExpr(*this, E, ReturnValue);
465}
466
Eli Friedmanfde961d2011-10-14 02:27:24 +0000467static void EmitNullBaseClassInitialization(CodeGenFunction &CGF,
John McCall7f416cc2015-09-08 08:05:57 +0000468 Address DestPtr,
Eli Friedmanfde961d2011-10-14 02:27:24 +0000469 const CXXRecordDecl *Base) {
470 if (Base->isEmpty())
471 return;
472
John McCall7f416cc2015-09-08 08:05:57 +0000473 DestPtr = CGF.Builder.CreateElementBitCast(DestPtr, CGF.Int8Ty);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000474
475 const ASTRecordLayout &Layout = CGF.getContext().getASTRecordLayout(Base);
David Majnemer8671c6e2015-11-02 09:01:44 +0000476 CharUnits NVSize = Layout.getNonVirtualSize();
477
478 // We cannot simply zero-initialize the entire base sub-object if vbptrs are
479 // present, they are initialized by the most derived class before calling the
480 // constructor.
481 SmallVector<std::pair<CharUnits, CharUnits>, 1> Stores;
482 Stores.emplace_back(CharUnits::Zero(), NVSize);
483
484 // Each store is split by the existence of a vbptr.
485 CharUnits VBPtrWidth = CGF.getPointerSize();
486 std::vector<CharUnits> VBPtrOffsets =
487 CGF.CGM.getCXXABI().getVBPtrOffsets(Base);
488 for (CharUnits VBPtrOffset : VBPtrOffsets) {
David Majnemer7f980d82016-05-12 03:51:52 +0000489 // Stop before we hit any virtual base pointers located in virtual bases.
490 if (VBPtrOffset >= NVSize)
491 break;
David Majnemer8671c6e2015-11-02 09:01:44 +0000492 std::pair<CharUnits, CharUnits> LastStore = Stores.pop_back_val();
493 CharUnits LastStoreOffset = LastStore.first;
494 CharUnits LastStoreSize = LastStore.second;
495
496 CharUnits SplitBeforeOffset = LastStoreOffset;
497 CharUnits SplitBeforeSize = VBPtrOffset - SplitBeforeOffset;
498 assert(!SplitBeforeSize.isNegative() && "negative store size!");
499 if (!SplitBeforeSize.isZero())
500 Stores.emplace_back(SplitBeforeOffset, SplitBeforeSize);
501
502 CharUnits SplitAfterOffset = VBPtrOffset + VBPtrWidth;
503 CharUnits SplitAfterSize = LastStoreSize - SplitAfterOffset;
504 assert(!SplitAfterSize.isNegative() && "negative store size!");
505 if (!SplitAfterSize.isZero())
506 Stores.emplace_back(SplitAfterOffset, SplitAfterSize);
507 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000508
509 // If the type contains a pointer to data member we can't memset it to zero.
510 // Instead, create a null constant and copy it to the destination.
511 // TODO: there are other patterns besides zero that we can usefully memset,
512 // like -1, which happens to be the pattern used by member-pointers.
513 // TODO: isZeroInitializable can be over-conservative in the case where a
514 // virtual base contains a member pointer.
David Majnemer8671c6e2015-11-02 09:01:44 +0000515 llvm::Constant *NullConstantForBase = CGF.CGM.EmitNullConstantForBase(Base);
516 if (!NullConstantForBase->isNullValue()) {
517 llvm::GlobalVariable *NullVariable = new llvm::GlobalVariable(
518 CGF.CGM.getModule(), NullConstantForBase->getType(),
519 /*isConstant=*/true, llvm::GlobalVariable::PrivateLinkage,
520 NullConstantForBase, Twine());
John McCall7f416cc2015-09-08 08:05:57 +0000521
522 CharUnits Align = std::max(Layout.getNonVirtualAlignment(),
523 DestPtr.getAlignment());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000524 NullVariable->setAlignment(Align.getQuantity());
John McCall7f416cc2015-09-08 08:05:57 +0000525
526 Address SrcPtr = Address(CGF.EmitCastToVoidPtr(NullVariable), Align);
Eli Friedmanfde961d2011-10-14 02:27:24 +0000527
528 // Get and call the appropriate llvm.memcpy overload.
David Majnemer8671c6e2015-11-02 09:01:44 +0000529 for (std::pair<CharUnits, CharUnits> Store : Stores) {
530 CharUnits StoreOffset = Store.first;
531 CharUnits StoreSize = Store.second;
532 llvm::Value *StoreSizeVal = CGF.CGM.getSize(StoreSize);
533 CGF.Builder.CreateMemCpy(
534 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
535 CGF.Builder.CreateConstInBoundsByteGEP(SrcPtr, StoreOffset),
536 StoreSizeVal);
537 }
538
Eli Friedmanfde961d2011-10-14 02:27:24 +0000539 // Otherwise, just memset the whole thing to zero. This is legal
540 // because in LLVM, all default initializers (other than the ones we just
541 // handled above) are guaranteed to have a bit pattern of all zeros.
David Majnemer8671c6e2015-11-02 09:01:44 +0000542 } else {
543 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.CreateMemSet(
548 CGF.Builder.CreateConstInBoundsByteGEP(DestPtr, StoreOffset),
549 CGF.Builder.getInt8(0), StoreSizeVal);
550 }
551 }
Eli Friedmanfde961d2011-10-14 02:27:24 +0000552}
553
Anders Carlsson27da15b2010-01-01 20:29:01 +0000554void
John McCall7a626f62010-09-15 10:14:12 +0000555CodeGenFunction::EmitCXXConstructExpr(const CXXConstructExpr *E,
556 AggValueSlot Dest) {
557 assert(!Dest.isIgnored() && "Must have a destination!");
Anders Carlsson27da15b2010-01-01 20:29:01 +0000558 const CXXConstructorDecl *CD = E->getConstructor();
Fangrui Song6907ce22018-07-30 19:24:48 +0000559
Douglas Gregor630c76e2010-08-22 16:15:35 +0000560 // If we require zero initialization before (or instead of) calling the
561 // constructor, as can be the case with a non-user-provided default
Argyrios Kyrtzidis03535262011-04-28 22:57:55 +0000562 // constructor, emit the zero initialization now, unless destination is
563 // already zeroed.
Eli Friedmanfde961d2011-10-14 02:27:24 +0000564 if (E->requiresZeroInitialization() && !Dest.isZeroed()) {
565 switch (E->getConstructionKind()) {
566 case CXXConstructExpr::CK_Delegating:
Eli Friedmanfde961d2011-10-14 02:27:24 +0000567 case CXXConstructExpr::CK_Complete:
John McCall7f416cc2015-09-08 08:05:57 +0000568 EmitNullInitialization(Dest.getAddress(), E->getType());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000569 break;
570 case CXXConstructExpr::CK_VirtualBase:
571 case CXXConstructExpr::CK_NonVirtualBase:
John McCall7f416cc2015-09-08 08:05:57 +0000572 EmitNullBaseClassInitialization(*this, Dest.getAddress(),
573 CD->getParent());
Eli Friedmanfde961d2011-10-14 02:27:24 +0000574 break;
575 }
576 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000577
Douglas Gregor630c76e2010-08-22 16:15:35 +0000578 // If this is a call to a trivial default constructor, do nothing.
579 if (CD->isTrivial() && CD->isDefaultConstructor())
580 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000581
John McCall8ea46b62010-09-18 00:58:34 +0000582 // Elide the constructor if we're constructing from a temporary.
583 // The temporary check is required because Sema sets this on NRVO
584 // returns.
Richard Smith9c6890a2012-11-01 22:30:59 +0000585 if (getLangOpts().ElideConstructors && E->isElidable()) {
John McCall8ea46b62010-09-18 00:58:34 +0000586 assert(getContext().hasSameUnqualifiedType(E->getType(),
587 E->getArg(0)->getType()));
John McCall7a626f62010-09-15 10:14:12 +0000588 if (E->getArg(0)->isTemporaryObject(getContext(), CD->getParent())) {
589 EmitAggExpr(E->getArg(0), Dest);
Douglas Gregor222cf0e2010-05-15 00:13:29 +0000590 return;
591 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000592 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000593
Alexey Bataeve7545b32016-04-29 09:39:50 +0000594 if (const ArrayType *arrayType
595 = getContext().getAsArrayType(E->getType())) {
Serge Pavlov37605182018-07-28 15:33:03 +0000596 EmitCXXAggrConstructorCall(CD, arrayType, Dest.getAddress(), E,
597 Dest.isSanitizerChecked());
John McCallf677a8e2011-07-13 06:10:41 +0000598 } else {
Cameron Esfahanibceca202011-05-06 21:28:42 +0000599 CXXCtorType Type = Ctor_Complete;
Alexis Hunt271c3682011-05-03 20:19:28 +0000600 bool ForVirtualBase = false;
Douglas Gregor61535002013-01-31 05:50:40 +0000601 bool Delegating = false;
Fangrui Song6907ce22018-07-30 19:24:48 +0000602
Alexis Hunt271c3682011-05-03 20:19:28 +0000603 switch (E->getConstructionKind()) {
604 case CXXConstructExpr::CK_Delegating:
Alexis Hunt61bc1732011-05-01 07:04:31 +0000605 // We should be emitting a constructor; GlobalDecl will assert this
606 Type = CurGD.getCtorType();
Douglas Gregor61535002013-01-31 05:50:40 +0000607 Delegating = true;
Alexis Hunt271c3682011-05-03 20:19:28 +0000608 break;
Alexis Hunt61bc1732011-05-01 07:04:31 +0000609
Alexis Hunt271c3682011-05-03 20:19:28 +0000610 case CXXConstructExpr::CK_Complete:
611 Type = Ctor_Complete;
612 break;
613
614 case CXXConstructExpr::CK_VirtualBase:
615 ForVirtualBase = true;
Adrian Prantlf3b3ccd2017-12-19 22:06:11 +0000616 LLVM_FALLTHROUGH;
Alexis Hunt271c3682011-05-03 20:19:28 +0000617
618 case CXXConstructExpr::CK_NonVirtualBase:
619 Type = Ctor_Base;
620 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000621
Anders Carlsson27da15b2010-01-01 20:29:01 +0000622 // Call the constructor.
John McCall7f416cc2015-09-08 08:05:57 +0000623 EmitCXXConstructorCall(CD, Type, ForVirtualBase, Delegating,
Serge Pavlov37605182018-07-28 15:33:03 +0000624 Dest.getAddress(), E, Dest.mayOverlap(),
625 Dest.isSanitizerChecked());
Anders Carlssone11f9ce2010-05-02 23:20:53 +0000626 }
Anders Carlsson27da15b2010-01-01 20:29:01 +0000627}
628
John McCall7f416cc2015-09-08 08:05:57 +0000629void CodeGenFunction::EmitSynthesizedCXXCopyCtor(Address Dest, Address Src,
630 const Expr *Exp) {
John McCall5d413782010-12-06 08:20:24 +0000631 if (const ExprWithCleanups *E = dyn_cast<ExprWithCleanups>(Exp))
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000632 Exp = E->getSubExpr();
Fangrui Song6907ce22018-07-30 19:24:48 +0000633 assert(isa<CXXConstructExpr>(Exp) &&
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000634 "EmitSynthesizedCXXCopyCtor - unknown copy ctor expr");
635 const CXXConstructExpr* E = cast<CXXConstructExpr>(Exp);
636 const CXXConstructorDecl *CD = E->getConstructor();
637 RunCleanupsScope Scope(*this);
Fangrui Song6907ce22018-07-30 19:24:48 +0000638
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000639 // If we require zero initialization before (or instead of) calling the
640 // constructor, as can be the case with a non-user-provided default
641 // constructor, emit the zero initialization now.
642 // FIXME. Do I still need this for a copy ctor synthesis?
643 if (E->requiresZeroInitialization())
644 EmitNullInitialization(Dest, E->getType());
Fangrui Song6907ce22018-07-30 19:24:48 +0000645
Chandler Carruth99da11c2010-11-15 13:54:43 +0000646 assert(!getContext().getAsConstantArrayType(E->getType())
647 && "EmitSynthesizedCXXCopyCtor - Copied-in Array");
Alexey Samsonov525bf652014-08-25 21:58:56 +0000648 EmitSynthesizedCXXCopyCtorCall(CD, Dest, Src, E);
Fariborz Jahaniane988bda2010-11-13 21:53:34 +0000649}
650
John McCall8ed55a52010-09-02 09:58:18 +0000651static CharUnits CalculateCookiePadding(CodeGenFunction &CGF,
652 const CXXNewExpr *E) {
Anders Carlsson21122cf2009-12-13 20:04:38 +0000653 if (!E->isArray())
Ken Dyck3eb55cf2010-01-26 19:44:24 +0000654 return CharUnits::Zero();
Anders Carlsson21122cf2009-12-13 20:04:38 +0000655
John McCall7ec4b432011-05-16 01:05:12 +0000656 // No cookie is required if the operator new[] being used is the
657 // reserved placement operator new[].
658 if (E->getOperatorNew()->isReservedGlobalPlacementOperator())
John McCallaa4149a2010-08-23 01:17:59 +0000659 return CharUnits::Zero();
660
John McCall284c48f2011-01-27 09:37:56 +0000661 return CGF.CGM.getCXXABI().GetArrayCookieSize(E);
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000662}
663
John McCall036f2f62011-05-15 07:14:44 +0000664static llvm::Value *EmitCXXNewAllocSize(CodeGenFunction &CGF,
665 const CXXNewExpr *e,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000666 unsigned minElements,
John McCall036f2f62011-05-15 07:14:44 +0000667 llvm::Value *&numElements,
668 llvm::Value *&sizeWithoutCookie) {
669 QualType type = e->getAllocatedType();
John McCall8ed55a52010-09-02 09:58:18 +0000670
John McCall036f2f62011-05-15 07:14:44 +0000671 if (!e->isArray()) {
672 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
673 sizeWithoutCookie
674 = llvm::ConstantInt::get(CGF.SizeTy, typeSize.getQuantity());
675 return sizeWithoutCookie;
Douglas Gregor05fc5be2010-07-21 01:10:17 +0000676 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000677
John McCall036f2f62011-05-15 07:14:44 +0000678 // The width of size_t.
679 unsigned sizeWidth = CGF.SizeTy->getBitWidth();
680
John McCall8ed55a52010-09-02 09:58:18 +0000681 // Figure out the cookie size.
John McCall036f2f62011-05-15 07:14:44 +0000682 llvm::APInt cookieSize(sizeWidth,
683 CalculateCookiePadding(CGF, e).getQuantity());
John McCall8ed55a52010-09-02 09:58:18 +0000684
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000685 // Emit the array size expression.
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000686 // We multiply the size of all dimensions for NumElements.
687 // e.g for 'int[2][3]', ElemType is 'int' and NumElements is 6.
John McCallde0fe072017-08-15 21:42:52 +0000688 numElements =
689 ConstantEmitter(CGF).tryEmitAbstract(e->getArraySize(), e->getType());
Nick Lewycky07527622017-02-13 23:49:55 +0000690 if (!numElements)
691 numElements = CGF.EmitScalarExpr(e->getArraySize());
John McCall036f2f62011-05-15 07:14:44 +0000692 assert(isa<llvm::IntegerType>(numElements->getType()));
John McCall8ed55a52010-09-02 09:58:18 +0000693
John McCall036f2f62011-05-15 07:14:44 +0000694 // The number of elements can be have an arbitrary integer type;
695 // essentially, we need to multiply it by a constant factor, add a
696 // cookie size, and verify that the result is representable as a
697 // size_t. That's just a gloss, though, and it's wrong in one
698 // important way: if the count is negative, it's an error even if
699 // the cookie size would bring the total size >= 0.
Fangrui Song6907ce22018-07-30 19:24:48 +0000700 bool isSigned
Douglas Gregor6ab2fa82011-05-20 16:38:50 +0000701 = e->getArraySize()->getType()->isSignedIntegerOrEnumerationType();
Chris Lattner2192fe52011-07-18 04:24:23 +0000702 llvm::IntegerType *numElementsType
John McCall036f2f62011-05-15 07:14:44 +0000703 = cast<llvm::IntegerType>(numElements->getType());
704 unsigned numElementsWidth = numElementsType->getBitWidth();
705
706 // Compute the constant factor.
707 llvm::APInt arraySizeMultiplier(sizeWidth, 1);
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000708 while (const ConstantArrayType *CAT
John McCall036f2f62011-05-15 07:14:44 +0000709 = CGF.getContext().getAsConstantArrayType(type)) {
710 type = CAT->getElementType();
711 arraySizeMultiplier *= CAT->getSize();
Argyrios Kyrtzidis7648fb42010-08-26 15:23:38 +0000712 }
713
John McCall036f2f62011-05-15 07:14:44 +0000714 CharUnits typeSize = CGF.getContext().getTypeSizeInChars(type);
715 llvm::APInt typeSizeMultiplier(sizeWidth, typeSize.getQuantity());
716 typeSizeMultiplier *= arraySizeMultiplier;
717
718 // This will be a size_t.
719 llvm::Value *size;
Fangrui Song6907ce22018-07-30 19:24:48 +0000720
Chris Lattner32ac5832010-07-20 21:55:52 +0000721 // If someone is doing 'new int[42]' there is no need to do a dynamic check.
722 // Don't bloat the -O0 code.
John McCall036f2f62011-05-15 07:14:44 +0000723 if (llvm::ConstantInt *numElementsC =
724 dyn_cast<llvm::ConstantInt>(numElements)) {
725 const llvm::APInt &count = numElementsC->getValue();
John McCall8ed55a52010-09-02 09:58:18 +0000726
John McCall036f2f62011-05-15 07:14:44 +0000727 bool hasAnyOverflow = false;
John McCall8ed55a52010-09-02 09:58:18 +0000728
John McCall036f2f62011-05-15 07:14:44 +0000729 // If 'count' was a negative number, it's an overflow.
730 if (isSigned && count.isNegative())
731 hasAnyOverflow = true;
John McCall8ed55a52010-09-02 09:58:18 +0000732
John McCall036f2f62011-05-15 07:14:44 +0000733 // We want to do all this arithmetic in size_t. If numElements is
734 // wider than that, check whether it's already too big, and if so,
735 // overflow.
736 else if (numElementsWidth > sizeWidth &&
737 numElementsWidth - sizeWidth > count.countLeadingZeros())
738 hasAnyOverflow = true;
739
740 // Okay, compute a count at the right width.
741 llvm::APInt adjustedCount = count.zextOrTrunc(sizeWidth);
742
Sebastian Redlf862eb62012-02-22 17:37:52 +0000743 // If there is a brace-initializer, we cannot allocate fewer elements than
744 // there are initializers. If we do, that's treated like an overflow.
745 if (adjustedCount.ult(minElements))
746 hasAnyOverflow = true;
747
John McCall036f2f62011-05-15 07:14:44 +0000748 // Scale numElements by that. This might overflow, but we don't
749 // care because it only overflows if allocationSize does, too, and
750 // if that overflows then we shouldn't use this.
751 numElements = llvm::ConstantInt::get(CGF.SizeTy,
752 adjustedCount * arraySizeMultiplier);
753
754 // Compute the size before cookie, and track whether it overflowed.
755 bool overflow;
756 llvm::APInt allocationSize
757 = adjustedCount.umul_ov(typeSizeMultiplier, overflow);
758 hasAnyOverflow |= overflow;
759
760 // Add in the cookie, and check whether it's overflowed.
761 if (cookieSize != 0) {
762 // Save the current size without a cookie. This shouldn't be
763 // used if there was overflow.
764 sizeWithoutCookie = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
765
766 allocationSize = allocationSize.uadd_ov(cookieSize, overflow);
767 hasAnyOverflow |= overflow;
768 }
769
770 // On overflow, produce a -1 so operator new will fail.
Aaron Ballman455f42c2014-08-28 17:24:14 +0000771 if (hasAnyOverflow) {
772 size = llvm::Constant::getAllOnesValue(CGF.SizeTy);
773 } else {
John McCall036f2f62011-05-15 07:14:44 +0000774 size = llvm::ConstantInt::get(CGF.SizeTy, allocationSize);
Aaron Ballman455f42c2014-08-28 17:24:14 +0000775 }
John McCall036f2f62011-05-15 07:14:44 +0000776
777 // Otherwise, we might need to use the overflow intrinsics.
778 } else {
Sebastian Redlf862eb62012-02-22 17:37:52 +0000779 // There are up to five conditions we need to test for:
John McCall036f2f62011-05-15 07:14:44 +0000780 // 1) if isSigned, we need to check whether numElements is negative;
781 // 2) if numElementsWidth > sizeWidth, we need to check whether
782 // numElements is larger than something representable in size_t;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000783 // 3) if minElements > 0, we need to check whether numElements is smaller
784 // than that.
785 // 4) we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000786 // sizeWithoutCookie := numElements * typeSizeMultiplier
787 // and check whether it overflows; and
Sebastian Redlf862eb62012-02-22 17:37:52 +0000788 // 5) if we need a cookie, we need to compute
John McCall036f2f62011-05-15 07:14:44 +0000789 // size := sizeWithoutCookie + cookieSize
790 // and check whether it overflows.
791
Craig Topper8a13c412014-05-21 05:09:00 +0000792 llvm::Value *hasOverflow = nullptr;
John McCall036f2f62011-05-15 07:14:44 +0000793
794 // If numElementsWidth > sizeWidth, then one way or another, we're
795 // going to have to do a comparison for (2), and this happens to
796 // take care of (1), too.
797 if (numElementsWidth > sizeWidth) {
798 llvm::APInt threshold(numElementsWidth, 1);
799 threshold <<= sizeWidth;
800
801 llvm::Value *thresholdV
802 = llvm::ConstantInt::get(numElementsType, threshold);
803
804 hasOverflow = CGF.Builder.CreateICmpUGE(numElements, thresholdV);
805 numElements = CGF.Builder.CreateTrunc(numElements, CGF.SizeTy);
806
807 // Otherwise, if we're signed, we want to sext up to size_t.
808 } else if (isSigned) {
809 if (numElementsWidth < sizeWidth)
810 numElements = CGF.Builder.CreateSExt(numElements, CGF.SizeTy);
Fangrui Song6907ce22018-07-30 19:24:48 +0000811
John McCall036f2f62011-05-15 07:14:44 +0000812 // If there's a non-1 type size multiplier, then we can do the
813 // signedness check at the same time as we do the multiply
814 // because a negative number times anything will cause an
Sebastian Redlf862eb62012-02-22 17:37:52 +0000815 // unsigned overflow. Otherwise, we have to do it here. But at least
816 // in this case, we can subsume the >= minElements check.
John McCall036f2f62011-05-15 07:14:44 +0000817 if (typeSizeMultiplier == 1)
818 hasOverflow = CGF.Builder.CreateICmpSLT(numElements,
Sebastian Redlf862eb62012-02-22 17:37:52 +0000819 llvm::ConstantInt::get(CGF.SizeTy, minElements));
John McCall036f2f62011-05-15 07:14:44 +0000820
821 // Otherwise, zext up to size_t if necessary.
822 } else if (numElementsWidth < sizeWidth) {
823 numElements = CGF.Builder.CreateZExt(numElements, CGF.SizeTy);
824 }
825
826 assert(numElements->getType() == CGF.SizeTy);
827
Sebastian Redlf862eb62012-02-22 17:37:52 +0000828 if (minElements) {
829 // Don't allow allocation of fewer elements than we have initializers.
830 if (!hasOverflow) {
831 hasOverflow = CGF.Builder.CreateICmpULT(numElements,
832 llvm::ConstantInt::get(CGF.SizeTy, minElements));
833 } else if (numElementsWidth > sizeWidth) {
834 // The other existing overflow subsumes this check.
835 // We do an unsigned comparison, since any signed value < -1 is
836 // taken care of either above or below.
837 hasOverflow = CGF.Builder.CreateOr(hasOverflow,
838 CGF.Builder.CreateICmpULT(numElements,
839 llvm::ConstantInt::get(CGF.SizeTy, minElements)));
840 }
841 }
842
John McCall036f2f62011-05-15 07:14:44 +0000843 size = numElements;
844
845 // Multiply by the type size if necessary. This multiplier
846 // includes all the factors for nested arrays.
847 //
848 // This step also causes numElements to be scaled up by the
849 // nested-array factor if necessary. Overflow on this computation
850 // can be ignored because the result shouldn't be used if
851 // allocation fails.
852 if (typeSizeMultiplier != 1) {
James Y Knight8799cae2019-02-03 21:53:49 +0000853 llvm::Function *umul_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000854 = CGF.CGM.getIntrinsic(llvm::Intrinsic::umul_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000855
856 llvm::Value *tsmV =
857 llvm::ConstantInt::get(CGF.SizeTy, typeSizeMultiplier);
858 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000859 CGF.Builder.CreateCall(umul_with_overflow, {size, tsmV});
John McCall036f2f62011-05-15 07:14:44 +0000860
861 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
862 if (hasOverflow)
863 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
864 else
865 hasOverflow = overflowed;
866
867 size = CGF.Builder.CreateExtractValue(result, 0);
868
869 // Also scale up numElements by the array size multiplier.
870 if (arraySizeMultiplier != 1) {
871 // If the base element type size is 1, then we can re-use the
872 // multiply we just did.
873 if (typeSize.isOne()) {
874 assert(arraySizeMultiplier == typeSizeMultiplier);
875 numElements = size;
876
877 // Otherwise we need a separate multiply.
878 } else {
879 llvm::Value *asmV =
880 llvm::ConstantInt::get(CGF.SizeTy, arraySizeMultiplier);
881 numElements = CGF.Builder.CreateMul(numElements, asmV);
882 }
883 }
884 } else {
885 // numElements doesn't need to be scaled.
886 assert(arraySizeMultiplier == 1);
Chris Lattner32ac5832010-07-20 21:55:52 +0000887 }
Fangrui Song6907ce22018-07-30 19:24:48 +0000888
John McCall036f2f62011-05-15 07:14:44 +0000889 // Add in the cookie size if necessary.
890 if (cookieSize != 0) {
891 sizeWithoutCookie = size;
892
James Y Knight8799cae2019-02-03 21:53:49 +0000893 llvm::Function *uadd_with_overflow
Benjamin Kramer8d375ce2011-07-14 17:45:50 +0000894 = CGF.CGM.getIntrinsic(llvm::Intrinsic::uadd_with_overflow, CGF.SizeTy);
John McCall036f2f62011-05-15 07:14:44 +0000895
896 llvm::Value *cookieSizeV = llvm::ConstantInt::get(CGF.SizeTy, cookieSize);
897 llvm::Value *result =
David Blaikie43f9bb72015-05-18 22:14:03 +0000898 CGF.Builder.CreateCall(uadd_with_overflow, {size, cookieSizeV});
John McCall036f2f62011-05-15 07:14:44 +0000899
900 llvm::Value *overflowed = CGF.Builder.CreateExtractValue(result, 1);
901 if (hasOverflow)
902 hasOverflow = CGF.Builder.CreateOr(hasOverflow, overflowed);
903 else
904 hasOverflow = overflowed;
905
906 size = CGF.Builder.CreateExtractValue(result, 0);
John McCall8ed55a52010-09-02 09:58:18 +0000907 }
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000908
John McCall036f2f62011-05-15 07:14:44 +0000909 // If we had any possibility of dynamic overflow, make a select to
910 // overwrite 'size' with an all-ones value, which should cause
911 // operator new to throw.
912 if (hasOverflow)
Aaron Ballman455f42c2014-08-28 17:24:14 +0000913 size = CGF.Builder.CreateSelect(hasOverflow,
914 llvm::Constant::getAllOnesValue(CGF.SizeTy),
915 size);
Chris Lattner32ac5832010-07-20 21:55:52 +0000916 }
John McCall8ed55a52010-09-02 09:58:18 +0000917
John McCall036f2f62011-05-15 07:14:44 +0000918 if (cookieSize == 0)
919 sizeWithoutCookie = size;
John McCall8ed55a52010-09-02 09:58:18 +0000920 else
John McCall036f2f62011-05-15 07:14:44 +0000921 assert(sizeWithoutCookie && "didn't set sizeWithoutCookie?");
John McCall8ed55a52010-09-02 09:58:18 +0000922
John McCall036f2f62011-05-15 07:14:44 +0000923 return size;
Anders Carlssonb4bd0662009-09-23 16:07:23 +0000924}
925
Sebastian Redlf862eb62012-02-22 17:37:52 +0000926static void StoreAnyExprIntoOneUnit(CodeGenFunction &CGF, const Expr *Init,
Richard Smithe78fac52018-04-05 20:52:58 +0000927 QualType AllocType, Address NewPtr,
928 AggValueSlot::Overlap_t MayOverlap) {
Richard Smith1c96bc52013-12-11 01:40:16 +0000929 // FIXME: Refactor with EmitExprAsInit.
John McCall47fb9502013-03-07 21:37:08 +0000930 switch (CGF.getEvaluationKind(AllocType)) {
931 case TEK_Scalar:
David Blaikiea2c11242014-12-10 19:04:09 +0000932 CGF.EmitScalarInit(Init, nullptr,
John McCall7f416cc2015-09-08 08:05:57 +0000933 CGF.MakeAddrLValue(NewPtr, AllocType), false);
John McCall47fb9502013-03-07 21:37:08 +0000934 return;
935 case TEK_Complex:
John McCall7f416cc2015-09-08 08:05:57 +0000936 CGF.EmitComplexExprIntoLValue(Init, CGF.MakeAddrLValue(NewPtr, AllocType),
John McCall47fb9502013-03-07 21:37:08 +0000937 /*isInit*/ true);
938 return;
939 case TEK_Aggregate: {
John McCall7a626f62010-09-15 10:14:12 +0000940 AggValueSlot Slot
John McCall7f416cc2015-09-08 08:05:57 +0000941 = AggValueSlot::forAddr(NewPtr, AllocType.getQualifiers(),
John McCall8d6fc952011-08-25 20:40:09 +0000942 AggValueSlot::IsDestructed,
John McCall46759f42011-08-26 07:31:35 +0000943 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +0000944 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +0000945 MayOverlap, AggValueSlot::IsNotZeroed,
946 AggValueSlot::IsSanitizerChecked);
John McCall7a626f62010-09-15 10:14:12 +0000947 CGF.EmitAggExpr(Init, Slot);
John McCall47fb9502013-03-07 21:37:08 +0000948 return;
John McCall7a626f62010-09-15 10:14:12 +0000949 }
John McCall47fb9502013-03-07 21:37:08 +0000950 }
951 llvm_unreachable("bad evaluation kind");
Fariborz Jahaniand5202e02010-06-25 18:26:07 +0000952}
953
David Blaikiefb901c7a2015-04-04 15:12:29 +0000954void CodeGenFunction::EmitNewArrayInitializer(
955 const CXXNewExpr *E, QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +0000956 Address BeginPtr, llvm::Value *NumElements,
David Blaikiefb901c7a2015-04-04 15:12:29 +0000957 llvm::Value *AllocSizeWithoutCookie) {
Richard Smith06a67e22014-06-03 06:58:52 +0000958 // If we have a type with trivial initialization and no initializer,
959 // there's nothing to do.
Sebastian Redl6047f072012-02-16 12:22:20 +0000960 if (!E->hasInitializer())
Richard Smith06a67e22014-06-03 06:58:52 +0000961 return;
John McCall99210dc2011-09-15 06:49:18 +0000962
John McCall7f416cc2015-09-08 08:05:57 +0000963 Address CurPtr = BeginPtr;
John McCall99210dc2011-09-15 06:49:18 +0000964
Richard Smith06a67e22014-06-03 06:58:52 +0000965 unsigned InitListElements = 0;
Sebastian Redlf862eb62012-02-22 17:37:52 +0000966
967 const Expr *Init = E->getInitializer();
John McCall7f416cc2015-09-08 08:05:57 +0000968 Address EndOfInit = Address::invalid();
Richard Smith06a67e22014-06-03 06:58:52 +0000969 QualType::DestructionKind DtorKind = ElementType.isDestructedType();
970 EHScopeStack::stable_iterator Cleanup;
971 llvm::Instruction *CleanupDominator = nullptr;
Richard Smith1c96bc52013-12-11 01:40:16 +0000972
John McCall7f416cc2015-09-08 08:05:57 +0000973 CharUnits ElementSize = getContext().getTypeSizeInChars(ElementType);
974 CharUnits ElementAlign =
975 BeginPtr.getAlignment().alignmentOfArrayElement(ElementSize);
976
Richard Smith0511d232016-10-05 22:41:02 +0000977 // Attempt to perform zero-initialization using memset.
978 auto TryMemsetInitialization = [&]() -> bool {
979 // FIXME: If the type is a pointer-to-data-member under the Itanium ABI,
980 // we can initialize with a memset to -1.
981 if (!CGM.getTypes().isZeroInitializable(ElementType))
982 return false;
983
984 // Optimization: since zero initialization will just set the memory
985 // to all zeroes, generate a single memset to do it in one shot.
986
987 // Subtract out the size of any elements we've already initialized.
988 auto *RemainingSize = AllocSizeWithoutCookie;
989 if (InitListElements) {
990 // We know this can't overflow; we check this when doing the allocation.
991 auto *InitializedSize = llvm::ConstantInt::get(
992 RemainingSize->getType(),
993 getContext().getTypeSizeInChars(ElementType).getQuantity() *
994 InitListElements);
995 RemainingSize = Builder.CreateSub(RemainingSize, InitializedSize);
996 }
997
998 // Create the memset.
999 Builder.CreateMemSet(CurPtr, Builder.getInt8(0), RemainingSize, false);
1000 return true;
1001 };
1002
Sebastian Redlf862eb62012-02-22 17:37:52 +00001003 // If the initializer is an initializer list, first do the explicit elements.
1004 if (const InitListExpr *ILE = dyn_cast<InitListExpr>(Init)) {
Richard Smith0511d232016-10-05 22:41:02 +00001005 // Initializing from a (braced) string literal is a special case; the init
1006 // list element does not initialize a (single) array element.
1007 if (ILE->isStringLiteralInit()) {
1008 // Initialize the initial portion of length equal to that of the string
1009 // literal. The allocation must be for at least this much; we emitted a
1010 // check for that earlier.
1011 AggValueSlot Slot =
1012 AggValueSlot::forAddr(CurPtr, ElementType.getQualifiers(),
1013 AggValueSlot::IsDestructed,
1014 AggValueSlot::DoesNotNeedGCBarriers,
Richard Smithe78fac52018-04-05 20:52:58 +00001015 AggValueSlot::IsNotAliased,
Serge Pavlov37605182018-07-28 15:33:03 +00001016 AggValueSlot::DoesNotOverlap,
1017 AggValueSlot::IsNotZeroed,
1018 AggValueSlot::IsSanitizerChecked);
Richard Smith0511d232016-10-05 22:41:02 +00001019 EmitAggExpr(ILE->getInit(0), Slot);
1020
1021 // Move past these elements.
1022 InitListElements =
1023 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1024 ->getSize().getZExtValue();
1025 CurPtr =
1026 Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1027 Builder.getSize(InitListElements),
1028 "string.init.end"),
1029 CurPtr.getAlignment().alignmentAtOffset(InitListElements *
1030 ElementSize));
1031
1032 // Zero out the rest, if any remain.
1033 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1034 if (!ConstNum || !ConstNum->equalsInt(InitListElements)) {
1035 bool OK = TryMemsetInitialization();
1036 (void)OK;
1037 assert(OK && "couldn't memset character type?");
1038 }
1039 return;
1040 }
1041
Richard Smith06a67e22014-06-03 06:58:52 +00001042 InitListElements = ILE->getNumInits();
Chad Rosierf62290a2012-02-24 00:13:55 +00001043
Richard Smith1c96bc52013-12-11 01:40:16 +00001044 // If this is a multi-dimensional array new, we will initialize multiple
1045 // elements with each init list element.
1046 QualType AllocType = E->getAllocatedType();
1047 if (const ConstantArrayType *CAT = dyn_cast_or_null<ConstantArrayType>(
1048 AllocType->getAsArrayTypeUnsafe())) {
David Blaikiefb901c7a2015-04-04 15:12:29 +00001049 ElementTy = ConvertTypeForMem(AllocType);
John McCall7f416cc2015-09-08 08:05:57 +00001050 CurPtr = Builder.CreateElementBitCast(CurPtr, ElementTy);
Richard Smith06a67e22014-06-03 06:58:52 +00001051 InitListElements *= getContext().getConstantArrayElementCount(CAT);
Richard Smith1c96bc52013-12-11 01:40:16 +00001052 }
1053
Richard Smith06a67e22014-06-03 06:58:52 +00001054 // Enter a partial-destruction Cleanup if necessary.
1055 if (needsEHCleanup(DtorKind)) {
1056 // In principle we could tell the Cleanup where we are more
Chad Rosierf62290a2012-02-24 00:13:55 +00001057 // directly, but the control flow can get so varied here that it
1058 // would actually be quite complex. Therefore we go through an
1059 // alloca.
John McCall7f416cc2015-09-08 08:05:57 +00001060 EndOfInit = CreateTempAlloca(BeginPtr.getType(), getPointerAlign(),
1061 "array.init.end");
1062 CleanupDominator = Builder.CreateStore(BeginPtr.getPointer(), EndOfInit);
1063 pushIrregularPartialArrayCleanup(BeginPtr.getPointer(), EndOfInit,
1064 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001065 getDestroyer(DtorKind));
1066 Cleanup = EHStack.stable_begin();
Chad Rosierf62290a2012-02-24 00:13:55 +00001067 }
1068
John McCall7f416cc2015-09-08 08:05:57 +00001069 CharUnits StartAlign = CurPtr.getAlignment();
Sebastian Redlf862eb62012-02-22 17:37:52 +00001070 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i) {
Chad Rosierf62290a2012-02-24 00:13:55 +00001071 // Tell the cleanup that it needs to destroy up to this
1072 // element. TODO: some of these stores can be trivially
1073 // observed to be unnecessary.
John McCall7f416cc2015-09-08 08:05:57 +00001074 if (EndOfInit.isValid()) {
1075 auto FinishedPtr =
1076 Builder.CreateBitCast(CurPtr.getPointer(), BeginPtr.getType());
1077 Builder.CreateStore(FinishedPtr, EndOfInit);
1078 }
Richard Smith06a67e22014-06-03 06:58:52 +00001079 // FIXME: If the last initializer is an incomplete initializer list for
1080 // an array, and we have an array filler, we can fold together the two
1081 // initialization loops.
Richard Smith1c96bc52013-12-11 01:40:16 +00001082 StoreAnyExprIntoOneUnit(*this, ILE->getInit(i),
Richard Smithe78fac52018-04-05 20:52:58 +00001083 ILE->getInit(i)->getType(), CurPtr,
1084 AggValueSlot::DoesNotOverlap);
John McCall7f416cc2015-09-08 08:05:57 +00001085 CurPtr = Address(Builder.CreateInBoundsGEP(CurPtr.getPointer(),
1086 Builder.getSize(1),
1087 "array.exp.next"),
1088 StartAlign.alignmentAtOffset((i + 1) * ElementSize));
Sebastian Redlf862eb62012-02-22 17:37:52 +00001089 }
1090
1091 // The remaining elements are filled with the array filler expression.
1092 Init = ILE->getArrayFiller();
Richard Smith1c96bc52013-12-11 01:40:16 +00001093
Richard Smith06a67e22014-06-03 06:58:52 +00001094 // Extract the initializer for the individual array elements by pulling
1095 // out the array filler from all the nested initializer lists. This avoids
1096 // generating a nested loop for the initialization.
1097 while (Init && Init->getType()->isConstantArrayType()) {
1098 auto *SubILE = dyn_cast<InitListExpr>(Init);
1099 if (!SubILE)
1100 break;
1101 assert(SubILE->getNumInits() == 0 && "explicit inits in array filler?");
1102 Init = SubILE->getArrayFiller();
1103 }
1104
1105 // Switch back to initializing one base element at a time.
John McCall7f416cc2015-09-08 08:05:57 +00001106 CurPtr = Builder.CreateBitCast(CurPtr, BeginPtr.getType());
Sebastian Redlf862eb62012-02-22 17:37:52 +00001107 }
1108
Richard Smith454a7cd2014-06-03 08:26:00 +00001109 // If all elements have already been initialized, skip any further
1110 // initialization.
1111 llvm::ConstantInt *ConstNum = dyn_cast<llvm::ConstantInt>(NumElements);
1112 if (ConstNum && ConstNum->getZExtValue() <= InitListElements) {
1113 // If there was a Cleanup, deactivate it.
1114 if (CleanupDominator)
1115 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1116 return;
1117 }
1118
1119 assert(Init && "have trailing elements to initialize but no initializer");
1120
Richard Smith06a67e22014-06-03 06:58:52 +00001121 // If this is a constructor call, try to optimize it out, and failing that
1122 // emit a single loop to initialize all remaining elements.
Richard Smith454a7cd2014-06-03 08:26:00 +00001123 if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001124 CXXConstructorDecl *Ctor = CCE->getConstructor();
1125 if (Ctor->isTrivial()) {
1126 // If new expression did not specify value-initialization, then there
1127 // is no initialization.
1128 if (!CCE->requiresZeroInitialization() || Ctor->getParent()->isEmpty())
1129 return;
1130
1131 if (TryMemsetInitialization())
1132 return;
1133 }
1134
1135 // Store the new Cleanup position for irregular Cleanups.
1136 //
1137 // FIXME: Share this cleanup with the constructor call emission rather than
1138 // having it create a cleanup of its own.
John McCall7f416cc2015-09-08 08:05:57 +00001139 if (EndOfInit.isValid())
1140 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Richard Smith06a67e22014-06-03 06:58:52 +00001141
1142 // Emit a constructor call loop to initialize the remaining elements.
1143 if (InitListElements)
1144 NumElements = Builder.CreateSub(
1145 NumElements,
1146 llvm::ConstantInt::get(NumElements->getType(), InitListElements));
Alexey Samsonov70b9c012014-08-21 20:26:47 +00001147 EmitCXXAggrConstructorCall(Ctor, NumElements, CurPtr, CCE,
Serge Pavlov37605182018-07-28 15:33:03 +00001148 /*NewPointerIsChecked*/true,
Richard Smith06a67e22014-06-03 06:58:52 +00001149 CCE->requiresZeroInitialization());
Chandler Carruthe6c980c2014-05-03 09:16:57 +00001150 return;
1151 }
1152
Richard Smith06a67e22014-06-03 06:58:52 +00001153 // If this is value-initialization, we can usually use memset.
1154 ImplicitValueInitExpr IVIE(ElementType);
Richard Smith454a7cd2014-06-03 08:26:00 +00001155 if (isa<ImplicitValueInitExpr>(Init)) {
Richard Smith06a67e22014-06-03 06:58:52 +00001156 if (TryMemsetInitialization())
1157 return;
1158
1159 // Switch to an ImplicitValueInitExpr for the element type. This handles
1160 // only one case: multidimensional array new of pointers to members. In
1161 // all other cases, we already have an initializer for the array element.
1162 Init = &IVIE;
1163 }
1164
1165 // At this point we should have found an initializer for the individual
1166 // elements of the array.
1167 assert(getContext().hasSameUnqualifiedType(ElementType, Init->getType()) &&
1168 "got wrong type of element to initialize");
1169
Richard Smith454a7cd2014-06-03 08:26:00 +00001170 // If we have an empty initializer list, we can usually use memset.
1171 if (auto *ILE = dyn_cast<InitListExpr>(Init))
1172 if (ILE->getNumInits() == 0 && TryMemsetInitialization())
1173 return;
Richard Smith06a67e22014-06-03 06:58:52 +00001174
Yunzhong Gaocb779302015-06-10 00:27:52 +00001175 // If we have a struct whose every field is value-initialized, we can
1176 // usually use memset.
1177 if (auto *ILE = dyn_cast<InitListExpr>(Init)) {
1178 if (const RecordType *RType = ILE->getType()->getAs<RecordType>()) {
1179 if (RType->getDecl()->isStruct()) {
Richard Smith872307e2016-03-08 22:17:41 +00001180 unsigned NumElements = 0;
1181 if (auto *CXXRD = dyn_cast<CXXRecordDecl>(RType->getDecl()))
1182 NumElements = CXXRD->getNumBases();
Yunzhong Gaocb779302015-06-10 00:27:52 +00001183 for (auto *Field : RType->getDecl()->fields())
1184 if (!Field->isUnnamedBitfield())
Richard Smith872307e2016-03-08 22:17:41 +00001185 ++NumElements;
1186 // FIXME: Recurse into nested InitListExprs.
1187 if (ILE->getNumInits() == NumElements)
Yunzhong Gaocb779302015-06-10 00:27:52 +00001188 for (unsigned i = 0, e = ILE->getNumInits(); i != e; ++i)
1189 if (!isa<ImplicitValueInitExpr>(ILE->getInit(i)))
Richard Smith872307e2016-03-08 22:17:41 +00001190 --NumElements;
1191 if (ILE->getNumInits() == NumElements && TryMemsetInitialization())
Yunzhong Gaocb779302015-06-10 00:27:52 +00001192 return;
1193 }
1194 }
1195 }
1196
Richard Smith06a67e22014-06-03 06:58:52 +00001197 // Create the loop blocks.
1198 llvm::BasicBlock *EntryBB = Builder.GetInsertBlock();
1199 llvm::BasicBlock *LoopBB = createBasicBlock("new.loop");
1200 llvm::BasicBlock *ContBB = createBasicBlock("new.loop.end");
1201
1202 // Find the end of the array, hoisted out of the loop.
1203 llvm::Value *EndPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001204 Builder.CreateInBoundsGEP(BeginPtr.getPointer(), NumElements, "array.end");
John McCall99210dc2011-09-15 06:49:18 +00001205
Sebastian Redlf862eb62012-02-22 17:37:52 +00001206 // If the number of elements isn't constant, we have to now check if there is
1207 // anything left to initialize.
Richard Smith06a67e22014-06-03 06:58:52 +00001208 if (!ConstNum) {
John McCall7f416cc2015-09-08 08:05:57 +00001209 llvm::Value *IsEmpty =
1210 Builder.CreateICmpEQ(CurPtr.getPointer(), EndPtr, "array.isempty");
Richard Smith06a67e22014-06-03 06:58:52 +00001211 Builder.CreateCondBr(IsEmpty, ContBB, LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001212 }
1213
1214 // Enter the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001215 EmitBlock(LoopBB);
John McCall99210dc2011-09-15 06:49:18 +00001216
1217 // Set up the current-element phi.
Richard Smith06a67e22014-06-03 06:58:52 +00001218 llvm::PHINode *CurPtrPhi =
John McCall7f416cc2015-09-08 08:05:57 +00001219 Builder.CreatePHI(CurPtr.getType(), 2, "array.cur");
1220 CurPtrPhi->addIncoming(CurPtr.getPointer(), EntryBB);
1221
1222 CurPtr = Address(CurPtrPhi, ElementAlign);
John McCall99210dc2011-09-15 06:49:18 +00001223
Richard Smith06a67e22014-06-03 06:58:52 +00001224 // Store the new Cleanup position for irregular Cleanups.
Fangrui Song6907ce22018-07-30 19:24:48 +00001225 if (EndOfInit.isValid())
John McCall7f416cc2015-09-08 08:05:57 +00001226 Builder.CreateStore(CurPtr.getPointer(), EndOfInit);
Chad Rosierf62290a2012-02-24 00:13:55 +00001227
Richard Smith06a67e22014-06-03 06:58:52 +00001228 // Enter a partial-destruction Cleanup if necessary.
1229 if (!CleanupDominator && needsEHCleanup(DtorKind)) {
John McCall7f416cc2015-09-08 08:05:57 +00001230 pushRegularPartialArrayCleanup(BeginPtr.getPointer(), CurPtr.getPointer(),
1231 ElementType, ElementAlign,
Richard Smith06a67e22014-06-03 06:58:52 +00001232 getDestroyer(DtorKind));
1233 Cleanup = EHStack.stable_begin();
1234 CleanupDominator = Builder.CreateUnreachable();
John McCall99210dc2011-09-15 06:49:18 +00001235 }
1236
1237 // Emit the initializer into this element.
Richard Smithe78fac52018-04-05 20:52:58 +00001238 StoreAnyExprIntoOneUnit(*this, Init, Init->getType(), CurPtr,
1239 AggValueSlot::DoesNotOverlap);
John McCall99210dc2011-09-15 06:49:18 +00001240
Richard Smith06a67e22014-06-03 06:58:52 +00001241 // Leave the Cleanup if we entered one.
1242 if (CleanupDominator) {
1243 DeactivateCleanupBlock(Cleanup, CleanupDominator);
1244 CleanupDominator->eraseFromParent();
John McCallf4beacd2011-11-10 10:43:54 +00001245 }
John McCall99210dc2011-09-15 06:49:18 +00001246
Faisal Vali57ae0562013-12-14 00:40:05 +00001247 // Advance to the next element by adjusting the pointer type as necessary.
Richard Smith06a67e22014-06-03 06:58:52 +00001248 llvm::Value *NextPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001249 Builder.CreateConstInBoundsGEP1_32(ElementTy, CurPtr.getPointer(), 1,
1250 "array.next");
Richard Smith06a67e22014-06-03 06:58:52 +00001251
John McCall99210dc2011-09-15 06:49:18 +00001252 // Check whether we've gotten to the end of the array and, if so,
1253 // exit the loop.
Richard Smith06a67e22014-06-03 06:58:52 +00001254 llvm::Value *IsEnd = Builder.CreateICmpEQ(NextPtr, EndPtr, "array.atend");
1255 Builder.CreateCondBr(IsEnd, ContBB, LoopBB);
1256 CurPtrPhi->addIncoming(NextPtr, Builder.GetInsertBlock());
John McCall99210dc2011-09-15 06:49:18 +00001257
Richard Smith06a67e22014-06-03 06:58:52 +00001258 EmitBlock(ContBB);
Fariborz Jahaniand5202e02010-06-25 18:26:07 +00001259}
1260
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001261static void EmitNewInitializer(CodeGenFunction &CGF, const CXXNewExpr *E,
David Blaikiefb901c7a2015-04-04 15:12:29 +00001262 QualType ElementType, llvm::Type *ElementTy,
John McCall7f416cc2015-09-08 08:05:57 +00001263 Address NewPtr, llvm::Value *NumElements,
Douglas Gregor05fc5be2010-07-21 01:10:17 +00001264 llvm::Value *AllocSizeWithoutCookie) {
David Blaikie9b479662015-01-25 01:19:10 +00001265 ApplyDebugLocation DL(CGF, E);
Richard Smith06a67e22014-06-03 06:58:52 +00001266 if (E->isArray())
David Blaikiefb901c7a2015-04-04 15:12:29 +00001267 CGF.EmitNewArrayInitializer(E, ElementType, ElementTy, NewPtr, NumElements,
Richard Smith06a67e22014-06-03 06:58:52 +00001268 AllocSizeWithoutCookie);
1269 else if (const Expr *Init = E->getInitializer())
Richard Smithe78fac52018-04-05 20:52:58 +00001270 StoreAnyExprIntoOneUnit(CGF, Init, E->getAllocatedType(), NewPtr,
1271 AggValueSlot::DoesNotOverlap);
Anders Carlssonb4bd0662009-09-23 16:07:23 +00001272}
1273
Richard Smith8d0dc312013-07-21 23:12:18 +00001274/// Emit a call to an operator new or operator delete function, as implicitly
1275/// created by new-expressions and delete-expressions.
1276static RValue EmitNewDeleteCall(CodeGenFunction &CGF,
John McCallb92ab1a2016-10-26 23:46:34 +00001277 const FunctionDecl *CalleeDecl,
Richard Smith8d0dc312013-07-21 23:12:18 +00001278 const FunctionProtoType *CalleeType,
1279 const CallArgList &Args) {
James Y Knight3933add2019-01-30 02:54:28 +00001280 llvm::CallBase *CallOrInvoke;
John McCallb92ab1a2016-10-26 23:46:34 +00001281 llvm::Constant *CalleePtr = CGF.CGM.GetAddrOfFunction(CalleeDecl);
Erich Keanede6480a32018-11-13 15:48:08 +00001282 CGCallee Callee = CGCallee::forDirect(CalleePtr, GlobalDecl(CalleeDecl));
Richard Smith8d0dc312013-07-21 23:12:18 +00001283 RValue RV =
Peter Collingbournef7706832014-12-12 23:41:25 +00001284 CGF.EmitCall(CGF.CGM.getTypes().arrangeFreeFunctionCall(
1285 Args, CalleeType, /*chainCall=*/false),
John McCallb92ab1a2016-10-26 23:46:34 +00001286 Callee, ReturnValueSlot(), Args, &CallOrInvoke);
Richard Smith8d0dc312013-07-21 23:12:18 +00001287
1288 /// C++1y [expr.new]p10:
1289 /// [In a new-expression,] an implementation is allowed to omit a call
1290 /// to a replaceable global allocation function.
1291 ///
1292 /// We model such elidable calls with the 'builtin' attribute.
John McCallb92ab1a2016-10-26 23:46:34 +00001293 llvm::Function *Fn = dyn_cast<llvm::Function>(CalleePtr);
1294 if (CalleeDecl->isReplaceableGlobalAllocationFunction() &&
Rafael Espindola6956d582013-10-22 14:23:09 +00001295 Fn && Fn->hasFnAttribute(llvm::Attribute::NoBuiltin)) {
James Y Knight3933add2019-01-30 02:54:28 +00001296 CallOrInvoke->addAttribute(llvm::AttributeList::FunctionIndex,
1297 llvm::Attribute::Builtin);
Richard Smith8d0dc312013-07-21 23:12:18 +00001298 }
1299
1300 return RV;
1301}
1302
Richard Smith760520b2014-06-03 23:27:44 +00001303RValue CodeGenFunction::EmitBuiltinNewDeleteCall(const FunctionProtoType *Type,
Eric Fiselierfa752f22018-03-21 19:19:48 +00001304 const CallExpr *TheCall,
Richard Smith760520b2014-06-03 23:27:44 +00001305 bool IsDelete) {
1306 CallArgList Args;
Eric Fiselierfa752f22018-03-21 19:19:48 +00001307 EmitCallArgs(Args, Type->getParamTypes(), TheCall->arguments());
Richard Smith760520b2014-06-03 23:27:44 +00001308 // Find the allocation or deallocation function that we're calling.
1309 ASTContext &Ctx = getContext();
1310 DeclarationName Name = Ctx.DeclarationNames
1311 .getCXXOperatorName(IsDelete ? OO_Delete : OO_New);
Eric Fiselierfa752f22018-03-21 19:19:48 +00001312
Richard Smith760520b2014-06-03 23:27:44 +00001313 for (auto *Decl : Ctx.getTranslationUnitDecl()->lookup(Name))
Richard Smith599bed72014-06-05 00:43:02 +00001314 if (auto *FD = dyn_cast<FunctionDecl>(Decl))
1315 if (Ctx.hasSameType(FD->getType(), QualType(Type, 0)))
Eric Fiselierfa752f22018-03-21 19:19:48 +00001316 return EmitNewDeleteCall(*this, FD, Type, Args);
Richard Smith760520b2014-06-03 23:27:44 +00001317 llvm_unreachable("predeclared global operator new/delete is missing");
1318}
1319
Richard Smith5b349582017-10-13 01:55:36 +00001320namespace {
1321/// The parameters to pass to a usual operator delete.
1322struct UsualDeleteParams {
1323 bool DestroyingDelete = false;
1324 bool Size = false;
1325 bool Alignment = false;
1326};
1327}
1328
1329static UsualDeleteParams getUsualDeleteParams(const FunctionDecl *FD) {
1330 UsualDeleteParams Params;
1331
1332 const FunctionProtoType *FPT = FD->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001333 auto AI = FPT->param_type_begin(), AE = FPT->param_type_end();
Richard Smith189e52f2016-10-10 06:42:31 +00001334
Richard Smithb2f0f052016-10-10 18:54:32 +00001335 // The first argument is always a void*.
1336 ++AI;
1337
Richard Smith5b349582017-10-13 01:55:36 +00001338 // The next parameter may be a std::destroying_delete_t.
1339 if (FD->isDestroyingOperatorDelete()) {
1340 Params.DestroyingDelete = true;
1341 assert(AI != AE);
1342 ++AI;
1343 }
Richard Smithb2f0f052016-10-10 18:54:32 +00001344
Richard Smith5b349582017-10-13 01:55:36 +00001345 // Figure out what other parameters we should be implicitly passing.
Richard Smithb2f0f052016-10-10 18:54:32 +00001346 if (AI != AE && (*AI)->isIntegerType()) {
Richard Smith5b349582017-10-13 01:55:36 +00001347 Params.Size = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001348 ++AI;
1349 }
1350
1351 if (AI != AE && (*AI)->isAlignValT()) {
Richard Smith5b349582017-10-13 01:55:36 +00001352 Params.Alignment = true;
Richard Smithb2f0f052016-10-10 18:54:32 +00001353 ++AI;
1354 }
1355
1356 assert(AI == AE && "unexpected usual deallocation function parameter");
Richard Smith5b349582017-10-13 01:55:36 +00001357 return Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001358}
1359
1360namespace {
1361 /// A cleanup to call the given 'operator delete' function upon abnormal
1362 /// exit from a new expression. Templated on a traits type that deals with
1363 /// ensuring that the arguments dominate the cleanup if necessary.
1364 template<typename Traits>
1365 class CallDeleteDuringNew final : public EHScopeStack::Cleanup {
1366 /// Type used to hold llvm::Value*s.
1367 typedef typename Traits::ValueTy ValueTy;
1368 /// Type used to hold RValues.
1369 typedef typename Traits::RValueTy RValueTy;
1370 struct PlacementArg {
1371 RValueTy ArgValue;
1372 QualType ArgType;
1373 };
1374
1375 unsigned NumPlacementArgs : 31;
1376 unsigned PassAlignmentToPlacementDelete : 1;
1377 const FunctionDecl *OperatorDelete;
1378 ValueTy Ptr;
1379 ValueTy AllocSize;
1380 CharUnits AllocAlign;
1381
1382 PlacementArg *getPlacementArgs() {
1383 return reinterpret_cast<PlacementArg *>(this + 1);
1384 }
Daniel Jaspere9abe642016-10-10 14:13:55 +00001385
1386 public:
1387 static size_t getExtraSize(size_t NumPlacementArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001388 return NumPlacementArgs * sizeof(PlacementArg);
Daniel Jaspere9abe642016-10-10 14:13:55 +00001389 }
1390
1391 CallDeleteDuringNew(size_t NumPlacementArgs,
Richard Smithb2f0f052016-10-10 18:54:32 +00001392 const FunctionDecl *OperatorDelete, ValueTy Ptr,
1393 ValueTy AllocSize, bool PassAlignmentToPlacementDelete,
1394 CharUnits AllocAlign)
1395 : NumPlacementArgs(NumPlacementArgs),
1396 PassAlignmentToPlacementDelete(PassAlignmentToPlacementDelete),
1397 OperatorDelete(OperatorDelete), Ptr(Ptr), AllocSize(AllocSize),
1398 AllocAlign(AllocAlign) {}
Daniel Jaspere9abe642016-10-10 14:13:55 +00001399
Richard Smithb2f0f052016-10-10 18:54:32 +00001400 void setPlacementArg(unsigned I, RValueTy Arg, QualType Type) {
Daniel Jaspere9abe642016-10-10 14:13:55 +00001401 assert(I < NumPlacementArgs && "index out of range");
Richard Smithb2f0f052016-10-10 18:54:32 +00001402 getPlacementArgs()[I] = {Arg, Type};
Daniel Jaspere9abe642016-10-10 14:13:55 +00001403 }
1404
1405 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001406 const FunctionProtoType *FPT =
1407 OperatorDelete->getType()->getAs<FunctionProtoType>();
Daniel Jaspere9abe642016-10-10 14:13:55 +00001408 CallArgList DeleteArgs;
1409
Richard Smith5b349582017-10-13 01:55:36 +00001410 // The first argument is always a void* (or C* for a destroying operator
1411 // delete for class type C).
Richard Smithb2f0f052016-10-10 18:54:32 +00001412 DeleteArgs.add(Traits::get(CGF, Ptr), FPT->getParamType(0));
Daniel Jaspere9abe642016-10-10 14:13:55 +00001413
Richard Smithb2f0f052016-10-10 18:54:32 +00001414 // Figure out what other parameters we should be implicitly passing.
Richard Smith5b349582017-10-13 01:55:36 +00001415 UsualDeleteParams Params;
Richard Smithb2f0f052016-10-10 18:54:32 +00001416 if (NumPlacementArgs) {
1417 // A placement deallocation function is implicitly passed an alignment
1418 // if the placement allocation function was, but is never passed a size.
Richard Smith5b349582017-10-13 01:55:36 +00001419 Params.Alignment = PassAlignmentToPlacementDelete;
Richard Smithb2f0f052016-10-10 18:54:32 +00001420 } else {
1421 // For a non-placement new-expression, 'operator delete' can take a
1422 // size and/or an alignment if it has the right parameters.
Richard Smith5b349582017-10-13 01:55:36 +00001423 Params = getUsualDeleteParams(OperatorDelete);
John McCall7f9c92a2010-09-17 00:50:28 +00001424 }
1425
Richard Smith5b349582017-10-13 01:55:36 +00001426 assert(!Params.DestroyingDelete &&
1427 "should not call destroying delete in a new-expression");
1428
Richard Smithb2f0f052016-10-10 18:54:32 +00001429 // The second argument can be a std::size_t (for non-placement delete).
Richard Smith5b349582017-10-13 01:55:36 +00001430 if (Params.Size)
Richard Smithb2f0f052016-10-10 18:54:32 +00001431 DeleteArgs.add(Traits::get(CGF, AllocSize),
1432 CGF.getContext().getSizeType());
1433
1434 // The next (second or third) argument can be a std::align_val_t, which
1435 // is an enum whose underlying type is std::size_t.
1436 // FIXME: Use the right type as the parameter type. Note that in a call
1437 // to operator delete(size_t, ...), we may not have it available.
Richard Smith5b349582017-10-13 01:55:36 +00001438 if (Params.Alignment)
Richard Smithb2f0f052016-10-10 18:54:32 +00001439 DeleteArgs.add(RValue::get(llvm::ConstantInt::get(
1440 CGF.SizeTy, AllocAlign.getQuantity())),
1441 CGF.getContext().getSizeType());
1442
John McCall7f9c92a2010-09-17 00:50:28 +00001443 // Pass the rest of the arguments, which must match exactly.
1444 for (unsigned I = 0; I != NumPlacementArgs; ++I) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001445 auto Arg = getPlacementArgs()[I];
1446 DeleteArgs.add(Traits::get(CGF, Arg.ArgValue), Arg.ArgType);
John McCall7f9c92a2010-09-17 00:50:28 +00001447 }
1448
1449 // Call 'operator delete'.
Richard Smith8d0dc312013-07-21 23:12:18 +00001450 EmitNewDeleteCall(CGF, OperatorDelete, FPT, DeleteArgs);
John McCall7f9c92a2010-09-17 00:50:28 +00001451 }
1452 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001453}
John McCall7f9c92a2010-09-17 00:50:28 +00001454
1455/// Enter a cleanup to call 'operator delete' if the initializer in a
1456/// new-expression throws.
1457static void EnterNewDeleteCleanup(CodeGenFunction &CGF,
1458 const CXXNewExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001459 Address NewPtr,
John McCall7f9c92a2010-09-17 00:50:28 +00001460 llvm::Value *AllocSize,
Richard Smithb2f0f052016-10-10 18:54:32 +00001461 CharUnits AllocAlign,
John McCall7f9c92a2010-09-17 00:50:28 +00001462 const CallArgList &NewArgs) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001463 unsigned NumNonPlacementArgs = E->passAlignment() ? 2 : 1;
1464
John McCall7f9c92a2010-09-17 00:50:28 +00001465 // If we're not inside a conditional branch, then the cleanup will
1466 // dominate and we can do the easier (and more efficient) thing.
1467 if (!CGF.isInConditionalBranch()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001468 struct DirectCleanupTraits {
1469 typedef llvm::Value *ValueTy;
1470 typedef RValue RValueTy;
1471 static RValue get(CodeGenFunction &, ValueTy V) { return RValue::get(V); }
1472 static RValue get(CodeGenFunction &, RValueTy V) { return V; }
1473 };
1474
1475 typedef CallDeleteDuringNew<DirectCleanupTraits> DirectCleanup;
1476
1477 DirectCleanup *Cleanup = CGF.EHStack
1478 .pushCleanupWithExtra<DirectCleanup>(EHCleanup,
1479 E->getNumPlacementArgs(),
1480 E->getOperatorDelete(),
1481 NewPtr.getPointer(),
1482 AllocSize,
1483 E->passAlignment(),
1484 AllocAlign);
1485 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1486 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001487 Cleanup->setPlacementArg(I, Arg.getRValue(CGF), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001488 }
John McCall7f9c92a2010-09-17 00:50:28 +00001489
1490 return;
1491 }
1492
1493 // Otherwise, we need to save all this stuff.
John McCallcb5f77f2011-01-28 10:53:53 +00001494 DominatingValue<RValue>::saved_type SavedNewPtr =
John McCall7f416cc2015-09-08 08:05:57 +00001495 DominatingValue<RValue>::save(CGF, RValue::get(NewPtr.getPointer()));
John McCallcb5f77f2011-01-28 10:53:53 +00001496 DominatingValue<RValue>::saved_type SavedAllocSize =
1497 DominatingValue<RValue>::save(CGF, RValue::get(AllocSize));
John McCall7f9c92a2010-09-17 00:50:28 +00001498
Richard Smithb2f0f052016-10-10 18:54:32 +00001499 struct ConditionalCleanupTraits {
1500 typedef DominatingValue<RValue>::saved_type ValueTy;
1501 typedef DominatingValue<RValue>::saved_type RValueTy;
1502 static RValue get(CodeGenFunction &CGF, ValueTy V) {
1503 return V.restore(CGF);
1504 }
1505 };
1506 typedef CallDeleteDuringNew<ConditionalCleanupTraits> ConditionalCleanup;
1507
1508 ConditionalCleanup *Cleanup = CGF.EHStack
1509 .pushCleanupWithExtra<ConditionalCleanup>(EHCleanup,
1510 E->getNumPlacementArgs(),
1511 E->getOperatorDelete(),
1512 SavedNewPtr,
1513 SavedAllocSize,
1514 E->passAlignment(),
1515 AllocAlign);
1516 for (unsigned I = 0, N = E->getNumPlacementArgs(); I != N; ++I) {
1517 auto &Arg = NewArgs[I + NumNonPlacementArgs];
Yaxun Liu5b330e82018-03-15 15:25:19 +00001518 Cleanup->setPlacementArg(
1519 I, DominatingValue<RValue>::save(CGF, Arg.getRValue(CGF)), Arg.Ty);
Richard Smithb2f0f052016-10-10 18:54:32 +00001520 }
John McCall7f9c92a2010-09-17 00:50:28 +00001521
John McCallf4beacd2011-11-10 10:43:54 +00001522 CGF.initFullExprCleanup();
John McCall824c2f52010-09-14 07:57:04 +00001523}
1524
Anders Carlssoncc52f652009-09-22 22:53:17 +00001525llvm::Value *CodeGenFunction::EmitCXXNewExpr(const CXXNewExpr *E) {
John McCall75f94982011-03-07 03:12:35 +00001526 // The element type being allocated.
1527 QualType allocType = getContext().getBaseElementType(E->getAllocatedType());
John McCall8ed55a52010-09-02 09:58:18 +00001528
John McCall75f94982011-03-07 03:12:35 +00001529 // 1. Build a call to the allocation function.
1530 FunctionDecl *allocator = E->getOperatorNew();
Anders Carlssoncc52f652009-09-22 22:53:17 +00001531
Sebastian Redlf862eb62012-02-22 17:37:52 +00001532 // If there is a brace-initializer, cannot allocate fewer elements than inits.
1533 unsigned minElements = 0;
1534 if (E->isArray() && E->hasInitializer()) {
Richard Smith0511d232016-10-05 22:41:02 +00001535 const InitListExpr *ILE = dyn_cast<InitListExpr>(E->getInitializer());
1536 if (ILE && ILE->isStringLiteralInit())
1537 minElements =
1538 cast<ConstantArrayType>(ILE->getType()->getAsArrayTypeUnsafe())
1539 ->getSize().getZExtValue();
1540 else if (ILE)
Sebastian Redlf862eb62012-02-22 17:37:52 +00001541 minElements = ILE->getNumInits();
1542 }
1543
Craig Topper8a13c412014-05-21 05:09:00 +00001544 llvm::Value *numElements = nullptr;
1545 llvm::Value *allocSizeWithoutCookie = nullptr;
John McCall75f94982011-03-07 03:12:35 +00001546 llvm::Value *allocSize =
Sebastian Redlf862eb62012-02-22 17:37:52 +00001547 EmitCXXNewAllocSize(*this, E, minElements, numElements,
1548 allocSizeWithoutCookie);
Richard Smithb2f0f052016-10-10 18:54:32 +00001549 CharUnits allocAlign = getContext().getTypeAlignInChars(allocType);
Alexey Samsonovcbe875a2014-08-28 00:22:11 +00001550
John McCall7ec4b432011-05-16 01:05:12 +00001551 // Emit the allocation call. If the allocator is a global placement
1552 // operator, just "inline" it directly.
John McCall7f416cc2015-09-08 08:05:57 +00001553 Address allocation = Address::invalid();
1554 CallArgList allocatorArgs;
John McCall7ec4b432011-05-16 01:05:12 +00001555 if (allocator->isReservedGlobalPlacementOperator()) {
John McCall53dcf942015-09-29 23:55:17 +00001556 assert(E->getNumPlacementArgs() == 1);
1557 const Expr *arg = *E->placement_arguments().begin();
1558
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001559 LValueBaseInfo BaseInfo;
1560 allocation = EmitPointerWithAlignment(arg, &BaseInfo);
John McCall7f416cc2015-09-08 08:05:57 +00001561
1562 // The pointer expression will, in many cases, be an opaque void*.
1563 // In these cases, discard the computed alignment and use the
1564 // formal alignment of the allocated type.
Krzysztof Parzyszek8f248232017-05-18 17:07:11 +00001565 if (BaseInfo.getAlignmentSource() != AlignmentSource::Decl)
Richard Smithb2f0f052016-10-10 18:54:32 +00001566 allocation = Address(allocation.getPointer(), allocAlign);
John McCall7f416cc2015-09-08 08:05:57 +00001567
John McCall53dcf942015-09-29 23:55:17 +00001568 // Set up allocatorArgs for the call to operator delete if it's not
1569 // the reserved global operator.
1570 if (E->getOperatorDelete() &&
1571 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
1572 allocatorArgs.add(RValue::get(allocSize), getContext().getSizeType());
1573 allocatorArgs.add(RValue::get(allocation.getPointer()), arg->getType());
1574 }
1575
John McCall7ec4b432011-05-16 01:05:12 +00001576 } else {
John McCall7f416cc2015-09-08 08:05:57 +00001577 const FunctionProtoType *allocatorType =
1578 allocator->getType()->castAs<FunctionProtoType>();
Richard Smithb2f0f052016-10-10 18:54:32 +00001579 unsigned ParamsToSkip = 0;
John McCall7f416cc2015-09-08 08:05:57 +00001580
1581 // The allocation size is the first argument.
1582 QualType sizeType = getContext().getSizeType();
1583 allocatorArgs.add(RValue::get(allocSize), sizeType);
Richard Smithb2f0f052016-10-10 18:54:32 +00001584 ++ParamsToSkip;
John McCall7f416cc2015-09-08 08:05:57 +00001585
Richard Smithb2f0f052016-10-10 18:54:32 +00001586 if (allocSize != allocSizeWithoutCookie) {
1587 CharUnits cookieAlign = getSizeAlign(); // FIXME: Ask the ABI.
1588 allocAlign = std::max(allocAlign, cookieAlign);
1589 }
1590
1591 // The allocation alignment may be passed as the second argument.
1592 if (E->passAlignment()) {
1593 QualType AlignValT = sizeType;
1594 if (allocatorType->getNumParams() > 1) {
1595 AlignValT = allocatorType->getParamType(1);
1596 assert(getContext().hasSameUnqualifiedType(
1597 AlignValT->castAs<EnumType>()->getDecl()->getIntegerType(),
1598 sizeType) &&
1599 "wrong type for alignment parameter");
1600 ++ParamsToSkip;
1601 } else {
1602 // Corner case, passing alignment to 'operator new(size_t, ...)'.
1603 assert(allocator->isVariadic() && "can't pass alignment to allocator");
1604 }
1605 allocatorArgs.add(
1606 RValue::get(llvm::ConstantInt::get(SizeTy, allocAlign.getQuantity())),
1607 AlignValT);
1608 }
1609
1610 // FIXME: Why do we not pass a CalleeDecl here?
John McCall7f416cc2015-09-08 08:05:57 +00001611 EmitCallArgs(allocatorArgs, allocatorType, E->placement_arguments(),
Vedant Kumared00ea02017-03-06 05:28:22 +00001612 /*AC*/AbstractCallee(), /*ParamsToSkip*/ParamsToSkip);
John McCall7f416cc2015-09-08 08:05:57 +00001613
1614 RValue RV =
1615 EmitNewDeleteCall(*this, allocator, allocatorType, allocatorArgs);
1616
Richard Smithb2f0f052016-10-10 18:54:32 +00001617 // If this was a call to a global replaceable allocation function that does
1618 // not take an alignment argument, the allocator is known to produce
1619 // storage that's suitably aligned for any object that fits, up to a known
1620 // threshold. Otherwise assume it's suitably aligned for the allocated type.
1621 CharUnits allocationAlign = allocAlign;
1622 if (!E->passAlignment() &&
1623 allocator->isReplaceableGlobalAllocationFunction()) {
1624 unsigned AllocatorAlign = llvm::PowerOf2Floor(std::min<uint64_t>(
1625 Target.getNewAlign(), getContext().getTypeSize(allocType)));
1626 allocationAlign = std::max(
1627 allocationAlign, getContext().toCharUnitsFromBits(AllocatorAlign));
John McCall7f416cc2015-09-08 08:05:57 +00001628 }
1629
1630 allocation = Address(RV.getScalarVal(), allocationAlign);
John McCall7ec4b432011-05-16 01:05:12 +00001631 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00001632
John McCall75f94982011-03-07 03:12:35 +00001633 // Emit a null check on the allocation result if the allocation
1634 // function is allowed to return null (because it has a non-throwing
Richard Smith902a0232015-02-14 01:52:20 +00001635 // exception spec or is the reserved placement new) and we have an
Richard Smith2f72a752019-01-10 00:03:29 +00001636 // interesting initializer will be running sanitizers on the initialization.
Bruno Ricci9b6dfac2019-01-07 15:04:45 +00001637 bool nullCheck = E->shouldNullCheckAllocation() &&
Richard Smith2f72a752019-01-10 00:03:29 +00001638 (!allocType.isPODType(getContext()) || E->hasInitializer() ||
1639 sanitizePerformTypeCheck());
Anders Carlssoncc52f652009-09-22 22:53:17 +00001640
Craig Topper8a13c412014-05-21 05:09:00 +00001641 llvm::BasicBlock *nullCheckBB = nullptr;
1642 llvm::BasicBlock *contBB = nullptr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001643
John McCallf7dcf322011-03-07 01:52:56 +00001644 // The null-check means that the initializer is conditionally
1645 // evaluated.
1646 ConditionalEvaluation conditional(*this);
1647
John McCall75f94982011-03-07 03:12:35 +00001648 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001649 conditional.begin(*this);
John McCall75f94982011-03-07 03:12:35 +00001650
1651 nullCheckBB = Builder.GetInsertBlock();
1652 llvm::BasicBlock *notNullBB = createBasicBlock("new.notnull");
1653 contBB = createBasicBlock("new.cont");
1654
John McCall7f416cc2015-09-08 08:05:57 +00001655 llvm::Value *isNull =
1656 Builder.CreateIsNull(allocation.getPointer(), "new.isnull");
John McCall75f94982011-03-07 03:12:35 +00001657 Builder.CreateCondBr(isNull, contBB, notNullBB);
1658 EmitBlock(notNullBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001659 }
Anders Carlssonf7716812009-09-23 18:59:48 +00001660
John McCall824c2f52010-09-14 07:57:04 +00001661 // If there's an operator delete, enter a cleanup to call it if an
1662 // exception is thrown.
John McCall75f94982011-03-07 03:12:35 +00001663 EHScopeStack::stable_iterator operatorDeleteCleanup;
Craig Topper8a13c412014-05-21 05:09:00 +00001664 llvm::Instruction *cleanupDominator = nullptr;
John McCall7ec4b432011-05-16 01:05:12 +00001665 if (E->getOperatorDelete() &&
1666 !E->getOperatorDelete()->isReservedGlobalPlacementOperator()) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001667 EnterNewDeleteCleanup(*this, E, allocation, allocSize, allocAlign,
1668 allocatorArgs);
John McCall75f94982011-03-07 03:12:35 +00001669 operatorDeleteCleanup = EHStack.stable_begin();
John McCallf4beacd2011-11-10 10:43:54 +00001670 cleanupDominator = Builder.CreateUnreachable();
John McCall824c2f52010-09-14 07:57:04 +00001671 }
1672
Eli Friedmancf9b1f62011-09-06 18:53:03 +00001673 assert((allocSize == allocSizeWithoutCookie) ==
1674 CalculateCookiePadding(*this, E).isZero());
1675 if (allocSize != allocSizeWithoutCookie) {
1676 assert(E->isArray());
1677 allocation = CGM.getCXXABI().InitializeArrayCookie(*this, allocation,
1678 numElements,
1679 E, allocType);
1680 }
1681
David Blaikiefb901c7a2015-04-04 15:12:29 +00001682 llvm::Type *elementTy = ConvertTypeForMem(allocType);
John McCall7f416cc2015-09-08 08:05:57 +00001683 Address result = Builder.CreateElementBitCast(allocation, elementTy);
John McCall824c2f52010-09-14 07:57:04 +00001684
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001685 // Passing pointer through launder.invariant.group to avoid propagation of
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001686 // vptrs information which may be included in previous type.
Piotr Padlewski31fd99c2017-05-20 08:56:18 +00001687 // To not break LTO with different optimizations levels, we do it regardless
1688 // of optimization level.
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001689 if (CGM.getCodeGenOpts().StrictVTablePointers &&
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001690 allocator->isReservedGlobalPlacementOperator())
Piotr Padlewski5dde8092018-05-03 11:03:01 +00001691 result = Address(Builder.CreateLaunderInvariantGroup(result.getPointer()),
Piotr Padlewski338c9d02015-09-15 21:46:47 +00001692 result.getAlignment());
1693
Serge Pavlov37605182018-07-28 15:33:03 +00001694 // Emit sanitizer checks for pointer value now, so that in the case of an
Richard Smithcfa79b22019-01-23 03:37:29 +00001695 // array it was checked only once and not at each constructor call. We may
1696 // have already checked that the pointer is non-null.
1697 // FIXME: If we have an array cookie and a potentially-throwing allocator,
1698 // we'll null check the wrong pointer here.
1699 SanitizerSet SkippedChecks;
1700 SkippedChecks.set(SanitizerKind::Null, nullCheck);
Serge Pavlov37605182018-07-28 15:33:03 +00001701 EmitTypeCheck(CodeGenFunction::TCK_ConstructorCall,
Richard Smithcfa79b22019-01-23 03:37:29 +00001702 E->getAllocatedTypeSourceInfo()->getTypeLoc().getBeginLoc(),
1703 result.getPointer(), allocType, result.getAlignment(),
1704 SkippedChecks, numElements);
Serge Pavlov37605182018-07-28 15:33:03 +00001705
David Blaikiefb901c7a2015-04-04 15:12:29 +00001706 EmitNewInitializer(*this, E, allocType, elementTy, result, numElements,
John McCall99210dc2011-09-15 06:49:18 +00001707 allocSizeWithoutCookie);
John McCall8ed55a52010-09-02 09:58:18 +00001708 if (E->isArray()) {
John McCall8ed55a52010-09-02 09:58:18 +00001709 // NewPtr is a pointer to the base element type. If we're
1710 // allocating an array of arrays, we'll need to cast back to the
1711 // array pointer type.
Chris Lattner2192fe52011-07-18 04:24:23 +00001712 llvm::Type *resultType = ConvertTypeForMem(E->getType());
John McCall7f416cc2015-09-08 08:05:57 +00001713 if (result.getType() != resultType)
John McCall75f94982011-03-07 03:12:35 +00001714 result = Builder.CreateBitCast(result, resultType);
Fariborz Jahanian47b46292010-03-24 16:57:01 +00001715 }
John McCall824c2f52010-09-14 07:57:04 +00001716
1717 // Deactivate the 'operator delete' cleanup if we finished
1718 // initialization.
John McCallf4beacd2011-11-10 10:43:54 +00001719 if (operatorDeleteCleanup.isValid()) {
1720 DeactivateCleanupBlock(operatorDeleteCleanup, cleanupDominator);
1721 cleanupDominator->eraseFromParent();
1722 }
Sebastian Redl6047f072012-02-16 12:22:20 +00001723
John McCall7f416cc2015-09-08 08:05:57 +00001724 llvm::Value *resultPtr = result.getPointer();
John McCall75f94982011-03-07 03:12:35 +00001725 if (nullCheck) {
John McCallf7dcf322011-03-07 01:52:56 +00001726 conditional.end(*this);
1727
John McCall75f94982011-03-07 03:12:35 +00001728 llvm::BasicBlock *notNullBB = Builder.GetInsertBlock();
1729 EmitBlock(contBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001730
John McCall7f416cc2015-09-08 08:05:57 +00001731 llvm::PHINode *PHI = Builder.CreatePHI(resultPtr->getType(), 2);
1732 PHI->addIncoming(resultPtr, notNullBB);
1733 PHI->addIncoming(llvm::Constant::getNullValue(resultPtr->getType()),
John McCall75f94982011-03-07 03:12:35 +00001734 nullCheckBB);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001735
John McCall7f416cc2015-09-08 08:05:57 +00001736 resultPtr = PHI;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001737 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001738
John McCall7f416cc2015-09-08 08:05:57 +00001739 return resultPtr;
Anders Carlssoncc52f652009-09-22 22:53:17 +00001740}
1741
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001742void CodeGenFunction::EmitDeleteCall(const FunctionDecl *DeleteFD,
Richard Smithb2f0f052016-10-10 18:54:32 +00001743 llvm::Value *Ptr, QualType DeleteTy,
1744 llvm::Value *NumElements,
1745 CharUnits CookieSize) {
1746 assert((!NumElements && CookieSize.isZero()) ||
1747 DeleteFD->getOverloadedOperator() == OO_Array_Delete);
John McCall8ed55a52010-09-02 09:58:18 +00001748
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001749 const FunctionProtoType *DeleteFTy =
1750 DeleteFD->getType()->getAs<FunctionProtoType>();
1751
1752 CallArgList DeleteArgs;
1753
Richard Smith5b349582017-10-13 01:55:36 +00001754 auto Params = getUsualDeleteParams(DeleteFD);
Richard Smithb2f0f052016-10-10 18:54:32 +00001755 auto ParamTypeIt = DeleteFTy->param_type_begin();
1756
1757 // Pass the pointer itself.
1758 QualType ArgTy = *ParamTypeIt++;
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001759 llvm::Value *DeletePtr = Builder.CreateBitCast(Ptr, ConvertType(ArgTy));
Eli Friedman43dca6a2011-05-02 17:57:46 +00001760 DeleteArgs.add(RValue::get(DeletePtr), ArgTy);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001761
Richard Smith5b349582017-10-13 01:55:36 +00001762 // Pass the std::destroying_delete tag if present.
1763 if (Params.DestroyingDelete) {
1764 QualType DDTag = *ParamTypeIt++;
1765 // Just pass an 'undef'. We expect the tag type to be an empty struct.
1766 auto *V = llvm::UndefValue::get(getTypes().ConvertType(DDTag));
1767 DeleteArgs.add(RValue::get(V), DDTag);
1768 }
1769
Richard Smithb2f0f052016-10-10 18:54:32 +00001770 // Pass the size if the delete function has a size_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001771 if (Params.Size) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001772 QualType SizeType = *ParamTypeIt++;
1773 CharUnits DeleteTypeSize = getContext().getTypeSizeInChars(DeleteTy);
1774 llvm::Value *Size = llvm::ConstantInt::get(ConvertType(SizeType),
1775 DeleteTypeSize.getQuantity());
1776
1777 // For array new, multiply by the number of elements.
1778 if (NumElements)
1779 Size = Builder.CreateMul(Size, NumElements);
1780
1781 // If there is a cookie, add the cookie size.
1782 if (!CookieSize.isZero())
1783 Size = Builder.CreateAdd(
1784 Size, llvm::ConstantInt::get(SizeTy, CookieSize.getQuantity()));
1785
1786 DeleteArgs.add(RValue::get(Size), SizeType);
1787 }
1788
1789 // Pass the alignment if the delete function has an align_val_t parameter.
Richard Smith5b349582017-10-13 01:55:36 +00001790 if (Params.Alignment) {
Richard Smithb2f0f052016-10-10 18:54:32 +00001791 QualType AlignValType = *ParamTypeIt++;
1792 CharUnits DeleteTypeAlign = getContext().toCharUnitsFromBits(
1793 getContext().getTypeAlignIfKnown(DeleteTy));
1794 llvm::Value *Align = llvm::ConstantInt::get(ConvertType(AlignValType),
1795 DeleteTypeAlign.getQuantity());
1796 DeleteArgs.add(RValue::get(Align), AlignValType);
1797 }
1798
1799 assert(ParamTypeIt == DeleteFTy->param_type_end() &&
1800 "unknown parameter to usual delete function");
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001801
1802 // Emit the call to delete.
Richard Smith8d0dc312013-07-21 23:12:18 +00001803 EmitNewDeleteCall(*this, DeleteFD, DeleteFTy, DeleteArgs);
Eli Friedmanfe81e3f2009-11-18 00:50:08 +00001804}
1805
John McCall8ed55a52010-09-02 09:58:18 +00001806namespace {
1807 /// Calls the given 'operator delete' on a single object.
David Blaikie7e70d682015-08-18 22:40:54 +00001808 struct CallObjectDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001809 llvm::Value *Ptr;
1810 const FunctionDecl *OperatorDelete;
1811 QualType ElementType;
1812
1813 CallObjectDelete(llvm::Value *Ptr,
1814 const FunctionDecl *OperatorDelete,
1815 QualType ElementType)
1816 : Ptr(Ptr), OperatorDelete(OperatorDelete), ElementType(ElementType) {}
1817
Craig Topper4f12f102014-03-12 06:41:41 +00001818 void Emit(CodeGenFunction &CGF, Flags flags) override {
John McCall8ed55a52010-09-02 09:58:18 +00001819 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType);
1820 }
1821 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001822}
John McCall8ed55a52010-09-02 09:58:18 +00001823
David Majnemer0c0b6d92014-10-31 20:09:12 +00001824void
1825CodeGenFunction::pushCallObjectDeleteCleanup(const FunctionDecl *OperatorDelete,
1826 llvm::Value *CompletePtr,
1827 QualType ElementType) {
1828 EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup, CompletePtr,
1829 OperatorDelete, ElementType);
1830}
1831
Richard Smith5b349582017-10-13 01:55:36 +00001832/// Emit the code for deleting a single object with a destroying operator
1833/// delete. If the element type has a non-virtual destructor, Ptr has already
1834/// been converted to the type of the parameter of 'operator delete'. Otherwise
1835/// Ptr points to an object of the static type.
1836static void EmitDestroyingObjectDelete(CodeGenFunction &CGF,
1837 const CXXDeleteExpr *DE, Address Ptr,
1838 QualType ElementType) {
1839 auto *Dtor = ElementType->getAsCXXRecordDecl()->getDestructor();
1840 if (Dtor && Dtor->isVirtual())
1841 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1842 Dtor);
1843 else
1844 CGF.EmitDeleteCall(DE->getOperatorDelete(), Ptr.getPointer(), ElementType);
1845}
1846
John McCall8ed55a52010-09-02 09:58:18 +00001847/// Emit the code for deleting a single object.
1848static void EmitObjectDelete(CodeGenFunction &CGF,
David Majnemer08681372014-11-01 07:37:17 +00001849 const CXXDeleteExpr *DE,
John McCall7f416cc2015-09-08 08:05:57 +00001850 Address Ptr,
David Majnemer08681372014-11-01 07:37:17 +00001851 QualType ElementType) {
Ivan Krasind98f5d72016-11-17 00:39:48 +00001852 // C++11 [expr.delete]p3:
1853 // If the static type of the object to be deleted is different from its
1854 // dynamic type, the static type shall be a base class of the dynamic type
1855 // of the object to be deleted and the static type shall have a virtual
1856 // destructor or the behavior is undefined.
1857 CGF.EmitTypeCheck(CodeGenFunction::TCK_MemberCall,
1858 DE->getExprLoc(), Ptr.getPointer(),
1859 ElementType);
1860
Richard Smith5b349582017-10-13 01:55:36 +00001861 const FunctionDecl *OperatorDelete = DE->getOperatorDelete();
1862 assert(!OperatorDelete->isDestroyingOperatorDelete());
1863
John McCall8ed55a52010-09-02 09:58:18 +00001864 // Find the destructor for the type, if applicable. If the
1865 // destructor is virtual, we'll just emit the vcall and return.
Craig Topper8a13c412014-05-21 05:09:00 +00001866 const CXXDestructorDecl *Dtor = nullptr;
John McCall8ed55a52010-09-02 09:58:18 +00001867 if (const RecordType *RT = ElementType->getAs<RecordType>()) {
1868 CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
Eli Friedmanb23533d2011-08-02 18:05:30 +00001869 if (RD->hasDefinition() && !RD->hasTrivialDestructor()) {
John McCall8ed55a52010-09-02 09:58:18 +00001870 Dtor = RD->getDestructor();
1871
1872 if (Dtor->isVirtual()) {
David Majnemer08681372014-11-01 07:37:17 +00001873 CGF.CGM.getCXXABI().emitVirtualObjectDelete(CGF, DE, Ptr, ElementType,
1874 Dtor);
John McCall8ed55a52010-09-02 09:58:18 +00001875 return;
1876 }
1877 }
1878 }
1879
1880 // Make sure that we call delete even if the dtor throws.
John McCalle4df6c82011-01-28 08:37:24 +00001881 // This doesn't have to a conditional cleanup because we're going
1882 // to pop it off in a second.
John McCall8ed55a52010-09-02 09:58:18 +00001883 CGF.EHStack.pushCleanup<CallObjectDelete>(NormalAndEHCleanup,
John McCall7f416cc2015-09-08 08:05:57 +00001884 Ptr.getPointer(),
1885 OperatorDelete, ElementType);
John McCall8ed55a52010-09-02 09:58:18 +00001886
1887 if (Dtor)
1888 CGF.EmitCXXDestructorCall(Dtor, Dtor_Complete,
Douglas Gregor61535002013-01-31 05:50:40 +00001889 /*ForVirtualBase=*/false,
1890 /*Delegating=*/false,
1891 Ptr);
John McCall460ce582015-10-22 18:38:17 +00001892 else if (auto Lifetime = ElementType.getObjCLifetime()) {
1893 switch (Lifetime) {
John McCall31168b02011-06-15 23:02:42 +00001894 case Qualifiers::OCL_None:
1895 case Qualifiers::OCL_ExplicitNone:
1896 case Qualifiers::OCL_Autoreleasing:
1897 break;
John McCall8ed55a52010-09-02 09:58:18 +00001898
John McCall7f416cc2015-09-08 08:05:57 +00001899 case Qualifiers::OCL_Strong:
1900 CGF.EmitARCDestroyStrong(Ptr, ARCPreciseLifetime);
John McCall31168b02011-06-15 23:02:42 +00001901 break;
Fangrui Song6907ce22018-07-30 19:24:48 +00001902
John McCall31168b02011-06-15 23:02:42 +00001903 case Qualifiers::OCL_Weak:
1904 CGF.EmitARCDestroyWeak(Ptr);
1905 break;
1906 }
1907 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001908
John McCall8ed55a52010-09-02 09:58:18 +00001909 CGF.PopCleanupBlock();
1910}
1911
1912namespace {
1913 /// Calls the given 'operator delete' on an array of objects.
David Blaikie7e70d682015-08-18 22:40:54 +00001914 struct CallArrayDelete final : EHScopeStack::Cleanup {
John McCall8ed55a52010-09-02 09:58:18 +00001915 llvm::Value *Ptr;
1916 const FunctionDecl *OperatorDelete;
1917 llvm::Value *NumElements;
1918 QualType ElementType;
1919 CharUnits CookieSize;
1920
1921 CallArrayDelete(llvm::Value *Ptr,
1922 const FunctionDecl *OperatorDelete,
1923 llvm::Value *NumElements,
1924 QualType ElementType,
1925 CharUnits CookieSize)
1926 : Ptr(Ptr), OperatorDelete(OperatorDelete), NumElements(NumElements),
1927 ElementType(ElementType), CookieSize(CookieSize) {}
1928
Craig Topper4f12f102014-03-12 06:41:41 +00001929 void Emit(CodeGenFunction &CGF, Flags flags) override {
Richard Smithb2f0f052016-10-10 18:54:32 +00001930 CGF.EmitDeleteCall(OperatorDelete, Ptr, ElementType, NumElements,
1931 CookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001932 }
1933 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001934}
John McCall8ed55a52010-09-02 09:58:18 +00001935
1936/// Emit the code for deleting an array of objects.
1937static void EmitArrayDelete(CodeGenFunction &CGF,
John McCall284c48f2011-01-27 09:37:56 +00001938 const CXXDeleteExpr *E,
John McCall7f416cc2015-09-08 08:05:57 +00001939 Address deletedPtr,
John McCallca2c56f2011-07-13 01:41:37 +00001940 QualType elementType) {
Craig Topper8a13c412014-05-21 05:09:00 +00001941 llvm::Value *numElements = nullptr;
1942 llvm::Value *allocatedPtr = nullptr;
John McCallca2c56f2011-07-13 01:41:37 +00001943 CharUnits cookieSize;
1944 CGF.CGM.getCXXABI().ReadArrayCookie(CGF, deletedPtr, E, elementType,
1945 numElements, allocatedPtr, cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001946
John McCallca2c56f2011-07-13 01:41:37 +00001947 assert(allocatedPtr && "ReadArrayCookie didn't set allocated pointer");
John McCall8ed55a52010-09-02 09:58:18 +00001948
1949 // Make sure that we call delete even if one of the dtors throws.
John McCallca2c56f2011-07-13 01:41:37 +00001950 const FunctionDecl *operatorDelete = E->getOperatorDelete();
John McCall8ed55a52010-09-02 09:58:18 +00001951 CGF.EHStack.pushCleanup<CallArrayDelete>(NormalAndEHCleanup,
John McCallca2c56f2011-07-13 01:41:37 +00001952 allocatedPtr, operatorDelete,
1953 numElements, elementType,
1954 cookieSize);
John McCall8ed55a52010-09-02 09:58:18 +00001955
John McCallca2c56f2011-07-13 01:41:37 +00001956 // Destroy the elements.
1957 if (QualType::DestructionKind dtorKind = elementType.isDestructedType()) {
1958 assert(numElements && "no element count for a type with a destructor!");
1959
John McCall7f416cc2015-09-08 08:05:57 +00001960 CharUnits elementSize = CGF.getContext().getTypeSizeInChars(elementType);
1961 CharUnits elementAlign =
1962 deletedPtr.getAlignment().alignmentOfArrayElement(elementSize);
1963
1964 llvm::Value *arrayBegin = deletedPtr.getPointer();
John McCallca2c56f2011-07-13 01:41:37 +00001965 llvm::Value *arrayEnd =
John McCall7f416cc2015-09-08 08:05:57 +00001966 CGF.Builder.CreateInBoundsGEP(arrayBegin, numElements, "delete.end");
John McCall97eab0a2011-07-13 08:09:46 +00001967
1968 // Note that it is legal to allocate a zero-length array, and we
1969 // can never fold the check away because the length should always
1970 // come from a cookie.
John McCall7f416cc2015-09-08 08:05:57 +00001971 CGF.emitArrayDestroy(arrayBegin, arrayEnd, elementType, elementAlign,
John McCallca2c56f2011-07-13 01:41:37 +00001972 CGF.getDestroyer(dtorKind),
John McCall97eab0a2011-07-13 08:09:46 +00001973 /*checkZeroLength*/ true,
John McCallca2c56f2011-07-13 01:41:37 +00001974 CGF.needsEHCleanup(dtorKind));
John McCall8ed55a52010-09-02 09:58:18 +00001975 }
1976
John McCallca2c56f2011-07-13 01:41:37 +00001977 // Pop the cleanup block.
John McCall8ed55a52010-09-02 09:58:18 +00001978 CGF.PopCleanupBlock();
1979}
1980
Anders Carlssoncc52f652009-09-22 22:53:17 +00001981void CodeGenFunction::EmitCXXDeleteExpr(const CXXDeleteExpr *E) {
Douglas Gregorbb3e12f2009-09-29 18:16:17 +00001982 const Expr *Arg = E->getArgument();
John McCall7f416cc2015-09-08 08:05:57 +00001983 Address Ptr = EmitPointerWithAlignment(Arg);
Anders Carlssoncc52f652009-09-22 22:53:17 +00001984
1985 // Null check the pointer.
1986 llvm::BasicBlock *DeleteNotNull = createBasicBlock("delete.notnull");
1987 llvm::BasicBlock *DeleteEnd = createBasicBlock("delete.end");
1988
John McCall7f416cc2015-09-08 08:05:57 +00001989 llvm::Value *IsNull = Builder.CreateIsNull(Ptr.getPointer(), "isnull");
Anders Carlssoncc52f652009-09-22 22:53:17 +00001990
1991 Builder.CreateCondBr(IsNull, DeleteEnd, DeleteNotNull);
1992 EmitBlock(DeleteNotNull);
Anders Carlssone828c362009-11-13 04:45:41 +00001993
Richard Smith5b349582017-10-13 01:55:36 +00001994 QualType DeleteTy = E->getDestroyedType();
1995
1996 // A destroying operator delete overrides the entire operation of the
1997 // delete expression.
1998 if (E->getOperatorDelete()->isDestroyingOperatorDelete()) {
1999 EmitDestroyingObjectDelete(*this, E, Ptr, DeleteTy);
2000 EmitBlock(DeleteEnd);
2001 return;
2002 }
2003
John McCall8ed55a52010-09-02 09:58:18 +00002004 // We might be deleting a pointer to array. If so, GEP down to the
2005 // first non-array element.
2006 // (this assumes that A(*)[3][7] is converted to [3 x [7 x %A]]*)
John McCall8ed55a52010-09-02 09:58:18 +00002007 if (DeleteTy->isConstantArrayType()) {
2008 llvm::Value *Zero = Builder.getInt32(0);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002009 SmallVector<llvm::Value*,8> GEP;
John McCall8ed55a52010-09-02 09:58:18 +00002010
2011 GEP.push_back(Zero); // point at the outermost array
2012
2013 // For each layer of array type we're pointing at:
2014 while (const ConstantArrayType *Arr
2015 = getContext().getAsConstantArrayType(DeleteTy)) {
2016 // 1. Unpeel the array type.
2017 DeleteTy = Arr->getElementType();
2018
2019 // 2. GEP to the first element of the array.
2020 GEP.push_back(Zero);
Anders Carlssoncc52f652009-09-22 22:53:17 +00002021 }
John McCall8ed55a52010-09-02 09:58:18 +00002022
John McCall7f416cc2015-09-08 08:05:57 +00002023 Ptr = Address(Builder.CreateInBoundsGEP(Ptr.getPointer(), GEP, "del.first"),
2024 Ptr.getAlignment());
Anders Carlssoncc52f652009-09-22 22:53:17 +00002025 }
2026
John McCall7f416cc2015-09-08 08:05:57 +00002027 assert(ConvertTypeForMem(DeleteTy) == Ptr.getElementType());
John McCall8ed55a52010-09-02 09:58:18 +00002028
Reid Kleckner7270ef52015-03-19 17:03:58 +00002029 if (E->isArrayForm()) {
2030 EmitArrayDelete(*this, E, Ptr, DeleteTy);
2031 } else {
2032 EmitObjectDelete(*this, E, Ptr, DeleteTy);
2033 }
Anders Carlssoncc52f652009-09-22 22:53:17 +00002034
Anders Carlssoncc52f652009-09-22 22:53:17 +00002035 EmitBlock(DeleteEnd);
2036}
Mike Stumpc9b231c2009-11-15 08:09:41 +00002037
David Majnemer1c3d95e2014-07-19 00:17:06 +00002038static bool isGLValueFromPointerDeref(const Expr *E) {
2039 E = E->IgnoreParens();
2040
2041 if (const auto *CE = dyn_cast<CastExpr>(E)) {
2042 if (!CE->getSubExpr()->isGLValue())
2043 return false;
2044 return isGLValueFromPointerDeref(CE->getSubExpr());
2045 }
2046
2047 if (const auto *OVE = dyn_cast<OpaqueValueExpr>(E))
2048 return isGLValueFromPointerDeref(OVE->getSourceExpr());
2049
2050 if (const auto *BO = dyn_cast<BinaryOperator>(E))
2051 if (BO->getOpcode() == BO_Comma)
2052 return isGLValueFromPointerDeref(BO->getRHS());
2053
2054 if (const auto *ACO = dyn_cast<AbstractConditionalOperator>(E))
2055 return isGLValueFromPointerDeref(ACO->getTrueExpr()) ||
2056 isGLValueFromPointerDeref(ACO->getFalseExpr());
2057
2058 // C++11 [expr.sub]p1:
2059 // The expression E1[E2] is identical (by definition) to *((E1)+(E2))
2060 if (isa<ArraySubscriptExpr>(E))
2061 return true;
2062
2063 if (const auto *UO = dyn_cast<UnaryOperator>(E))
2064 if (UO->getOpcode() == UO_Deref)
2065 return true;
2066
2067 return false;
2068}
2069
Warren Hunt747e3012014-06-18 21:15:55 +00002070static llvm::Value *EmitTypeidFromVTable(CodeGenFunction &CGF, const Expr *E,
Chris Lattner2192fe52011-07-18 04:24:23 +00002071 llvm::Type *StdTypeInfoPtrTy) {
Anders Carlsson940f02d2011-04-18 00:57:03 +00002072 // Get the vtable pointer.
John McCall7f416cc2015-09-08 08:05:57 +00002073 Address ThisPtr = CGF.EmitLValue(E).getAddress();
Anders Carlsson940f02d2011-04-18 00:57:03 +00002074
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002075 QualType SrcRecordTy = E->getType();
2076
2077 // C++ [class.cdtor]p4:
2078 // If the operand of typeid refers to the object under construction or
2079 // destruction and the static type of the operand is neither the constructor
2080 // or destructor’s class nor one of its bases, the behavior is undefined.
2081 CGF.EmitTypeCheck(CodeGenFunction::TCK_DynamicOperation, E->getExprLoc(),
2082 ThisPtr.getPointer(), SrcRecordTy);
2083
Anders Carlsson940f02d2011-04-18 00:57:03 +00002084 // C++ [expr.typeid]p2:
2085 // If the glvalue expression is obtained by applying the unary * operator to
2086 // a pointer and the pointer is a null pointer value, the typeid expression
2087 // throws the std::bad_typeid exception.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002088 //
2089 // However, this paragraph's intent is not clear. We choose a very generous
2090 // interpretation which implores us to consider comma operators, conditional
2091 // operators, parentheses and other such constructs.
David Majnemer1c3d95e2014-07-19 00:17:06 +00002092 if (CGF.CGM.getCXXABI().shouldTypeidBeNullChecked(
2093 isGLValueFromPointerDeref(E), SrcRecordTy)) {
David Majnemer1162d252014-06-22 19:05:33 +00002094 llvm::BasicBlock *BadTypeidBlock =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002095 CGF.createBasicBlock("typeid.bad_typeid");
David Majnemer1162d252014-06-22 19:05:33 +00002096 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("typeid.end");
Anders Carlsson940f02d2011-04-18 00:57:03 +00002097
John McCall7f416cc2015-09-08 08:05:57 +00002098 llvm::Value *IsNull = CGF.Builder.CreateIsNull(ThisPtr.getPointer());
David Majnemer1162d252014-06-22 19:05:33 +00002099 CGF.Builder.CreateCondBr(IsNull, BadTypeidBlock, EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002100
David Majnemer1162d252014-06-22 19:05:33 +00002101 CGF.EmitBlock(BadTypeidBlock);
2102 CGF.CGM.getCXXABI().EmitBadTypeidCall(CGF);
2103 CGF.EmitBlock(EndBlock);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002104 }
2105
David Majnemer1162d252014-06-22 19:05:33 +00002106 return CGF.CGM.getCXXABI().EmitTypeid(CGF, SrcRecordTy, ThisPtr,
2107 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002108}
2109
John McCalle4df6c82011-01-28 08:37:24 +00002110llvm::Value *CodeGenFunction::EmitCXXTypeidExpr(const CXXTypeidExpr *E) {
Fangrui Song6907ce22018-07-30 19:24:48 +00002111 llvm::Type *StdTypeInfoPtrTy =
Anders Carlsson940f02d2011-04-18 00:57:03 +00002112 ConvertType(E->getType())->getPointerTo();
Fangrui Song6907ce22018-07-30 19:24:48 +00002113
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002114 if (E->isTypeOperand()) {
David Majnemer143c55e2013-09-27 07:04:31 +00002115 llvm::Constant *TypeInfo =
2116 CGM.GetAddrOfRTTIDescriptor(E->getTypeOperand(getContext()));
Anders Carlsson940f02d2011-04-18 00:57:03 +00002117 return Builder.CreateBitCast(TypeInfo, StdTypeInfoPtrTy);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002118 }
Anders Carlsson0c633502011-04-11 14:13:40 +00002119
Anders Carlsson940f02d2011-04-18 00:57:03 +00002120 // C++ [expr.typeid]p2:
2121 // When typeid is applied to a glvalue expression whose type is a
2122 // polymorphic class type, the result refers to a std::type_info object
2123 // representing the type of the most derived object (that is, the dynamic
2124 // type) to which the glvalue refers.
Richard Smithef8bf432012-08-13 20:08:14 +00002125 if (E->isPotentiallyEvaluated())
Fangrui Song6907ce22018-07-30 19:24:48 +00002126 return EmitTypeidFromVTable(*this, E->getExprOperand(),
Richard Smithef8bf432012-08-13 20:08:14 +00002127 StdTypeInfoPtrTy);
Anders Carlsson940f02d2011-04-18 00:57:03 +00002128
2129 QualType OperandTy = E->getExprOperand()->getType();
2130 return Builder.CreateBitCast(CGM.GetAddrOfRTTIDescriptor(OperandTy),
2131 StdTypeInfoPtrTy);
Mike Stumpc9b231c2009-11-15 08:09:41 +00002132}
Mike Stump65511702009-11-16 06:50:58 +00002133
Anders Carlssonc1c99712011-04-11 01:45:29 +00002134static llvm::Value *EmitDynamicCastToNull(CodeGenFunction &CGF,
2135 QualType DestTy) {
Chris Lattner2192fe52011-07-18 04:24:23 +00002136 llvm::Type *DestLTy = CGF.ConvertType(DestTy);
Anders Carlssonc1c99712011-04-11 01:45:29 +00002137 if (DestTy->isPointerType())
2138 return llvm::Constant::getNullValue(DestLTy);
2139
2140 /// C++ [expr.dynamic.cast]p9:
2141 /// A failed cast to reference type throws std::bad_cast
David Majnemer1162d252014-06-22 19:05:33 +00002142 if (!CGF.CGM.getCXXABI().EmitBadCastCall(CGF))
2143 return nullptr;
Anders Carlssonc1c99712011-04-11 01:45:29 +00002144
2145 CGF.EmitBlock(CGF.createBasicBlock("dynamic_cast.end"));
2146 return llvm::UndefValue::get(DestLTy);
2147}
2148
John McCall7f416cc2015-09-08 08:05:57 +00002149llvm::Value *CodeGenFunction::EmitDynamicCast(Address ThisAddr,
Mike Stump65511702009-11-16 06:50:58 +00002150 const CXXDynamicCastExpr *DCE) {
Alexey Bataev2bf9b4c2015-10-20 04:24:12 +00002151 CGM.EmitExplicitCastExprType(DCE, this);
Anders Carlsson3f4336c2009-12-17 07:09:17 +00002152 QualType DestTy = DCE->getTypeAsWritten();
Anders Carlsson882d7902011-04-11 00:46:40 +00002153
Anders Carlssonc1c99712011-04-11 01:45:29 +00002154 QualType SrcTy = DCE->getSubExpr()->getType();
2155
David Majnemer1162d252014-06-22 19:05:33 +00002156 // C++ [expr.dynamic.cast]p7:
2157 // If T is "pointer to cv void," then the result is a pointer to the most
2158 // derived object pointed to by v.
2159 const PointerType *DestPTy = DestTy->getAs<PointerType>();
2160
2161 bool isDynamicCastToVoid;
2162 QualType SrcRecordTy;
2163 QualType DestRecordTy;
2164 if (DestPTy) {
2165 isDynamicCastToVoid = DestPTy->getPointeeType()->isVoidType();
2166 SrcRecordTy = SrcTy->castAs<PointerType>()->getPointeeType();
2167 DestRecordTy = DestPTy->getPointeeType();
2168 } else {
2169 isDynamicCastToVoid = false;
2170 SrcRecordTy = SrcTy;
2171 DestRecordTy = DestTy->castAs<ReferenceType>()->getPointeeType();
2172 }
2173
Stephan Bergmannd71ad172017-12-28 12:45:41 +00002174 // C++ [class.cdtor]p5:
2175 // If the operand of the dynamic_cast refers to the object under
2176 // construction or destruction and the static type of the operand is not a
2177 // pointer to or object of the constructor or destructor’s own class or one
2178 // of its bases, the dynamic_cast results in undefined behavior.
2179 EmitTypeCheck(TCK_DynamicOperation, DCE->getExprLoc(), ThisAddr.getPointer(),
2180 SrcRecordTy);
2181
2182 if (DCE->isAlwaysNull())
2183 if (llvm::Value *T = EmitDynamicCastToNull(*this, DestTy))
2184 return T;
2185
David Majnemer1162d252014-06-22 19:05:33 +00002186 assert(SrcRecordTy->isRecordType() && "source type must be a record type!");
2187
Fangrui Song6907ce22018-07-30 19:24:48 +00002188 // C++ [expr.dynamic.cast]p4:
Anders Carlsson882d7902011-04-11 00:46:40 +00002189 // If the value of v is a null pointer value in the pointer case, the result
2190 // is the null pointer value of type T.
David Majnemer1162d252014-06-22 19:05:33 +00002191 bool ShouldNullCheckSrcValue =
2192 CGM.getCXXABI().shouldDynamicCastCallBeNullChecked(SrcTy->isPointerType(),
2193 SrcRecordTy);
Craig Topper8a13c412014-05-21 05:09:00 +00002194
2195 llvm::BasicBlock *CastNull = nullptr;
2196 llvm::BasicBlock *CastNotNull = nullptr;
Anders Carlsson882d7902011-04-11 00:46:40 +00002197 llvm::BasicBlock *CastEnd = createBasicBlock("dynamic_cast.end");
Fangrui Song6907ce22018-07-30 19:24:48 +00002198
Anders Carlsson882d7902011-04-11 00:46:40 +00002199 if (ShouldNullCheckSrcValue) {
2200 CastNull = createBasicBlock("dynamic_cast.null");
2201 CastNotNull = createBasicBlock("dynamic_cast.notnull");
2202
John McCall7f416cc2015-09-08 08:05:57 +00002203 llvm::Value *IsNull = Builder.CreateIsNull(ThisAddr.getPointer());
Anders Carlsson882d7902011-04-11 00:46:40 +00002204 Builder.CreateCondBr(IsNull, CastNull, CastNotNull);
2205 EmitBlock(CastNotNull);
Mike Stump65511702009-11-16 06:50:58 +00002206 }
2207
John McCall7f416cc2015-09-08 08:05:57 +00002208 llvm::Value *Value;
David Majnemer1162d252014-06-22 19:05:33 +00002209 if (isDynamicCastToVoid) {
John McCall7f416cc2015-09-08 08:05:57 +00002210 Value = CGM.getCXXABI().EmitDynamicCastToVoid(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002211 DestTy);
2212 } else {
2213 assert(DestRecordTy->isRecordType() &&
2214 "destination type must be a record type!");
John McCall7f416cc2015-09-08 08:05:57 +00002215 Value = CGM.getCXXABI().EmitDynamicCastCall(*this, ThisAddr, SrcRecordTy,
David Majnemer1162d252014-06-22 19:05:33 +00002216 DestTy, DestRecordTy, CastEnd);
David Majnemer67528ea2015-11-23 03:01:14 +00002217 CastNotNull = Builder.GetInsertBlock();
David Majnemer1162d252014-06-22 19:05:33 +00002218 }
Anders Carlsson882d7902011-04-11 00:46:40 +00002219
2220 if (ShouldNullCheckSrcValue) {
2221 EmitBranch(CastEnd);
2222
2223 EmitBlock(CastNull);
2224 EmitBranch(CastEnd);
2225 }
2226
2227 EmitBlock(CastEnd);
2228
2229 if (ShouldNullCheckSrcValue) {
2230 llvm::PHINode *PHI = Builder.CreatePHI(Value->getType(), 2);
2231 PHI->addIncoming(Value, CastNotNull);
2232 PHI->addIncoming(llvm::Constant::getNullValue(Value->getType()), CastNull);
2233
2234 Value = PHI;
2235 }
2236
2237 return Value;
Mike Stump65511702009-11-16 06:50:58 +00002238}